lib/zclient.h

   1 /* Zebra's client header.
   2  * Copyright (C) 1999 Kunihiro Ishiguro
   3  *
   4  * This file is part of GNU Zebra.
   5  *
   6  * GNU Zebra is free software; you can redistribute it and/or modify it
   7  * under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2, or (at your option)
   9  * any later version.
  10  *
  11  * GNU Zebra is distributed in the hope that it will be useful, but
  12  * WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along
  17  * with this program; see the file COPYING; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  19  */
  20
  21 #ifndef _ZEBRA_ZCLIENT_H
  22 #define _ZEBRA_ZCLIENT_H
  23
  24 /* For struct zapi_route. */
  25 #include "prefix.h"
  26
  27 /* For struct interface and struct connected. */
  28 #include "if.h"
  29
  30 /* For vrf_bitmap_t. */
  31 #include "vrf.h"
  32
  33 /* For union g_addr */
  34 #include "nexthop.h"
  35
  36 /* For union pw_protocol_fields */
  37 #include "pw.h"
  38
  39 /* For input/output buffer to zebra. */
  40 #define ZEBRA_MAX_PACKET_SIZ          16384
  41
  42 /* Zebra header size. */
  43 #define ZEBRA_HEADER_SIZE             10
  44
  45 /* special socket path name to use TCP
  46  * @ is used as first character because that's abstract socket names on Linux
  47  */
  48 #define ZAPI_TCP_PATHNAME             "@tcp"
  49
  50 /* IPset size name stands for the name of the ipset entry
  51  * that can be created by using some zapi interfaces
  52  */
  53 #define ZEBRA_IPSET_NAME_SIZE   32
  54
  55 /* IPTable action is defined by two values: either
  56  * forward or drop
  57  */
  58 #define ZEBRA_IPTABLES_FORWARD 0
  59 #define ZEBRA_IPTABLES_DROP    1
  60
  61 extern struct sockaddr_storage zclient_addr;
  62 extern socklen_t zclient_addr_len;
  63
  64 /* Zebra message types. */
  65 typedef enum {
  66         ZEBRA_INTERFACE_ADD,
  67         ZEBRA_INTERFACE_DELETE,
  68         ZEBRA_INTERFACE_ADDRESS_ADD,
  69         ZEBRA_INTERFACE_ADDRESS_DELETE,
  70         ZEBRA_INTERFACE_UP,
  71         ZEBRA_INTERFACE_DOWN,
  72         ZEBRA_INTERFACE_SET_MASTER,
  73         ZEBRA_ROUTE_ADD,
  74         ZEBRA_ROUTE_DELETE,
  75         ZEBRA_ROUTE_NOTIFY_OWNER,
  76         ZEBRA_IPV4_ROUTE_ADD,
  77         ZEBRA_IPV4_ROUTE_DELETE,
  78         ZEBRA_IPV6_ROUTE_ADD,
  79         ZEBRA_IPV6_ROUTE_DELETE,
  80         ZEBRA_REDISTRIBUTE_ADD,
  81         ZEBRA_REDISTRIBUTE_DELETE,
  82         ZEBRA_REDISTRIBUTE_DEFAULT_ADD,
  83         ZEBRA_REDISTRIBUTE_DEFAULT_DELETE,
  84         ZEBRA_ROUTER_ID_ADD,
  85         ZEBRA_ROUTER_ID_DELETE,
  86         ZEBRA_ROUTER_ID_UPDATE,
  87         ZEBRA_HELLO,
  88         ZEBRA_NEXTHOP_REGISTER,
  89         ZEBRA_NEXTHOP_UNREGISTER,
  90         ZEBRA_NEXTHOP_UPDATE,
  91         ZEBRA_INTERFACE_NBR_ADDRESS_ADD,
  92         ZEBRA_INTERFACE_NBR_ADDRESS_DELETE,
  93         ZEBRA_INTERFACE_BFD_DEST_UPDATE,
  94         ZEBRA_IMPORT_ROUTE_REGISTER,
  95         ZEBRA_IMPORT_ROUTE_UNREGISTER,
  96         ZEBRA_IMPORT_CHECK_UPDATE,
  97         ZEBRA_IPV4_ROUTE_IPV6_NEXTHOP_ADD,
  98         ZEBRA_BFD_DEST_REGISTER,
  99         ZEBRA_BFD_DEST_DEREGISTER,
 100         ZEBRA_BFD_DEST_UPDATE,
 101         ZEBRA_BFD_DEST_REPLAY,
 102         ZEBRA_REDISTRIBUTE_ROUTE_ADD,
 103         ZEBRA_REDISTRIBUTE_ROUTE_DEL,
 104         ZEBRA_VRF_UNREGISTER,
 105         ZEBRA_VRF_ADD,
 106         ZEBRA_VRF_DELETE,
 107         ZEBRA_VRF_LABEL,
 108         ZEBRA_INTERFACE_VRF_UPDATE,
 109         ZEBRA_BFD_CLIENT_REGISTER,
 110         ZEBRA_INTERFACE_ENABLE_RADV,
 111         ZEBRA_INTERFACE_DISABLE_RADV,
 112         ZEBRA_IPV4_NEXTHOP_LOOKUP_MRIB,
 113         ZEBRA_INTERFACE_LINK_PARAMS,
 114         ZEBRA_MPLS_LABELS_ADD,
 115         ZEBRA_MPLS_LABELS_DELETE,
 116         ZEBRA_IPMR_ROUTE_STATS,
 117         ZEBRA_LABEL_MANAGER_CONNECT,
 118         ZEBRA_GET_LABEL_CHUNK,
 119         ZEBRA_RELEASE_LABEL_CHUNK,
 120         ZEBRA_FEC_REGISTER,
 121         ZEBRA_FEC_UNREGISTER,
 122         ZEBRA_FEC_UPDATE,
 123         ZEBRA_ADVERTISE_DEFAULT_GW,
 124         ZEBRA_ADVERTISE_SUBNET,
 125         ZEBRA_ADVERTISE_ALL_VNI,
 126         ZEBRA_VNI_ADD,
 127         ZEBRA_VNI_DEL,
 128         ZEBRA_L3VNI_ADD,
 129         ZEBRA_L3VNI_DEL,
 130         ZEBRA_REMOTE_VTEP_ADD,
 131         ZEBRA_REMOTE_VTEP_DEL,
 132         ZEBRA_MACIP_ADD,
 133         ZEBRA_MACIP_DEL,
 134         ZEBRA_IP_PREFIX_ROUTE_ADD,
 135         ZEBRA_IP_PREFIX_ROUTE_DEL,
 136         ZEBRA_REMOTE_MACIP_ADD,
 137         ZEBRA_REMOTE_MACIP_DEL,
 138         ZEBRA_PW_ADD,
 139         ZEBRA_PW_DELETE,
 140         ZEBRA_PW_SET,
 141         ZEBRA_PW_UNSET,
 142         ZEBRA_PW_STATUS_UPDATE,
 143         ZEBRA_RULE_ADD,
 144         ZEBRA_RULE_DELETE,
 145         ZEBRA_RULE_NOTIFY_OWNER,
 146         ZEBRA_TABLE_MANAGER_CONNECT,
 147         ZEBRA_GET_TABLE_CHUNK,
 148         ZEBRA_RELEASE_TABLE_CHUNK,
 149         ZEBRA_IPSET_CREATE,
 150         ZEBRA_IPSET_DESTROY,
 151         ZEBRA_IPSET_ENTRY_ADD,
 152         ZEBRA_IPSET_ENTRY_DELETE,
 153         ZEBRA_IPSET_NOTIFY_OWNER,
 154         ZEBRA_IPSET_ENTRY_NOTIFY_OWNER,
 155         ZEBRA_IPTABLE_ADD,
 156         ZEBRA_IPTABLE_DELETE,
 157         ZEBRA_IPTABLE_NOTIFY_OWNER,
 158 } zebra_message_types_t;
 159
 160 struct redist_proto {
 161         uint8_t enabled;
 162         struct list *instances;
 163 };
 164
 165 /* Structure for the zebra client. */
 166 struct zclient {
 167         /* The thread master we schedule ourselves on */
 168         struct thread_master *master;
 169
 170         /* Priviledges to change socket values */
 171         struct zebra_privs_t *privs;
 172
 173         /* Do we care about failure events for route install? */
 174         bool receive_notify;
 175
 176         /* Socket to zebra daemon. */
 177         int sock;
 178
 179         /* Connection failure count. */
 180         int fail;
 181
 182         /* Input buffer for zebra message. */
 183         struct stream *ibuf;
 184
 185         /* Output buffer for zebra message. */
 186         struct stream *obuf;
 187
 188         /* Buffer of data waiting to be written to zebra. */
 189         struct buffer *wb;
 190
 191         /* Read and connect thread. */
 192         struct thread *t_read;
 193         struct thread *t_connect;
 194
 195         /* Thread to write buffered data to zebra. */
 196         struct thread *t_write;
 197
 198         /* Redistribute information. */
 199         uint8_t redist_default; /* clients protocol */
 200         unsigned short instance;
 201         struct redist_proto mi_redist[AFI_MAX][ZEBRA_ROUTE_MAX];
 202         vrf_bitmap_t redist[AFI_MAX][ZEBRA_ROUTE_MAX];
 203
 204         /* Redistribute defauilt. */
 205         vrf_bitmap_t default_information;
 206
 207         /* Pointer to the callback functions. */
 208         void (*zebra_connected)(struct zclient *);
 209         int (*router_id_update)(int, struct zclient *, uint16_t, vrf_id_t);
 210         int (*interface_add)(int, struct zclient *, uint16_t, vrf_id_t);
 211         int (*interface_delete)(int, struct zclient *, uint16_t, vrf_id_t);
 212         int (*interface_up)(int, struct zclient *, uint16_t, vrf_id_t);
 213         int (*interface_down)(int, struct zclient *, uint16_t, vrf_id_t);
 214         int (*interface_address_add)(int, struct zclient *, uint16_t, vrf_id_t);
 215         int (*interface_address_delete)(int, struct zclient *, uint16_t,
 216                                         vrf_id_t);
 217         int (*interface_link_params)(int, struct zclient *, uint16_t);
 218         int (*interface_bfd_dest_update)(int, struct zclient *, uint16_t,
 219                                          vrf_id_t);
 220         int (*interface_nbr_address_add)(int, struct zclient *, uint16_t,
 221                                          vrf_id_t);
 222         int (*interface_nbr_address_delete)(int, struct zclient *, uint16_t,
 223                                             vrf_id_t);
 224         int (*interface_vrf_update)(int, struct zclient *, uint16_t, vrf_id_t);
 225         int (*nexthop_update)(int, struct zclient *, uint16_t, vrf_id_t);
 226         int (*import_check_update)(int, struct zclient *, uint16_t, vrf_id_t);
 227         int (*bfd_dest_replay)(int, struct zclient *, uint16_t, vrf_id_t);
 228         int (*redistribute_route_add)(int, struct zclient *, uint16_t,
 229                                       vrf_id_t);
 230         int (*redistribute_route_del)(int, struct zclient *, uint16_t,
 231                                       vrf_id_t);
 232         int (*fec_update)(int, struct zclient *, uint16_t);
 233         int (*local_vni_add)(int, struct zclient *, uint16_t, vrf_id_t);
 234         int (*local_vni_del)(int, struct zclient *, uint16_t, vrf_id_t);
 235         int (*local_l3vni_add)(int, struct zclient *, uint16_t, vrf_id_t);
 236         int (*local_l3vni_del)(int, struct zclient *, uint16_t, vrf_id_t);
 237         void (*local_ip_prefix_add)(int, struct zclient *, uint16_t, vrf_id_t);
 238         void (*local_ip_prefix_del)(int, struct zclient *, uint16_t, vrf_id_t);
 239         int (*local_macip_add)(int, struct zclient *, uint16_t, vrf_id_t);
 240         int (*local_macip_del)(int, struct zclient *, uint16_t, vrf_id_t);
 241         int (*pw_status_update)(int, struct zclient *, uint16_t, vrf_id_t);
 242         int (*route_notify_owner)(int command, struct zclient *zclient,
 243                                   uint16_t length, vrf_id_t vrf_id);
 244         int (*rule_notify_owner)(int command, struct zclient *zclient,
 245                                  uint16_t length, vrf_id_t vrf_id);
 246         void (*label_chunk)(int command, struct zclient *zclient,
 247                                 uint16_t length, vrf_id_t vrf_id);
 248         int (*ipset_notify_owner)(int command, struct zclient *zclient,
 249                                  uint16_t length, vrf_id_t vrf_id);
 250         int (*ipset_entry_notify_owner)(int command,
 251                                        struct zclient *zclient,
 252                                        uint16_t length,
 253                                        vrf_id_t vrf_id);
 254 };
 255
 256 /* Zebra API message flag. */
 257 #define ZAPI_MESSAGE_NEXTHOP  0x01
 258 #define ZAPI_MESSAGE_DISTANCE 0x02
 259 #define ZAPI_MESSAGE_METRIC   0x04
 260 #define ZAPI_MESSAGE_TAG      0x08
 261 #define ZAPI_MESSAGE_MTU      0x10
 262 #define ZAPI_MESSAGE_SRCPFX   0x20
 263 #define ZAPI_MESSAGE_LABEL    0x40
 264 /*
 265  * This should only be used by a DAEMON that needs to communicate
 266  * the table being used is not in the VRF.  You must pass the
 267  * default vrf, else this will be ignored.
 268  */
 269 #define ZAPI_MESSAGE_TABLEID  0x80
 270
 271 #define ZSERV_VERSION 5
 272 /* Zserv protocol message header */
 273 struct zmsghdr {
 274         uint16_t length;
 275         /* Always set to 255 in new zserv */
 276         uint8_t marker;
 277         uint8_t version;
 278         vrf_id_t vrf_id;
 279         uint16_t command;
 280 };
 281
 282 struct zapi_nexthop {
 283         enum nexthop_types_t type;
 284         vrf_id_t vrf_id;
 285         ifindex_t ifindex;
 286         union {
 287                 union g_addr gate;
 288                 enum blackhole_type bh_type;
 289         };
 290
 291         /* MPLS labels for BGP-LU or Segment Routing */
 292         uint8_t label_num;
 293         mpls_label_t labels[MPLS_MAX_LABELS];
 294 };
 295
 296 /*
 297  * Some of these data structures do not map easily to
 298  * a actual data structure size giving different compilers
 299  * and systems.  For those data structures we need
 300  * to use the smallest available stream_getX/putX functions
 301  * to encode/decode.
 302  */
 303 struct zapi_route {
 304         uint8_t type;
 305         unsigned short instance;
 306
 307         uint32_t flags;
 308
 309         uint8_t message;
 310
 311         /*
 312          * This is an enum but we are going to treat it as a uint8_t
 313          * for purpose of encoding/decoding
 314          */
 315         safi_t safi;
 316
 317         struct prefix prefix;
 318         struct prefix_ipv6 src_prefix;
 319
 320         uint16_t nexthop_num;
 321         struct zapi_nexthop nexthops[MULTIPATH_NUM];
 322
 323         uint8_t distance;
 324
 325         uint32_t metric;
 326
 327         route_tag_t tag;
 328
 329         uint32_t mtu;
 330
 331         vrf_id_t vrf_id;
 332
 333         uint32_t tableid;
 334
 335         struct ethaddr rmac;
 336 };
 337
 338 /* Zebra IPv4 route message API. */
 339 struct zapi_ipv4 {
 340         uint8_t type;
 341         unsigned short instance;
 342
 343         uint32_t flags;
 344
 345         uint8_t message;
 346
 347         safi_t safi;
 348
 349         uint8_t nexthop_num;
 350         struct in_addr **nexthop;
 351
 352         uint8_t ifindex_num;
 353         ifindex_t *ifindex;
 354
 355         uint8_t label_num;
 356         unsigned int *label;
 357
 358         uint8_t distance;
 359
 360         uint32_t metric;
 361
 362         route_tag_t tag;
 363
 364         uint32_t mtu;
 365
 366         vrf_id_t vrf_id;
 367 };
 368
 369 struct zapi_pw {
 370         char ifname[IF_NAMESIZE];
 371         ifindex_t ifindex;
 372         int type;
 373         int af;
 374         union g_addr nexthop;
 375         uint32_t local_label;
 376         uint32_t remote_label;
 377         uint8_t flags;
 378         union pw_protocol_fields data;
 379         uint8_t protocol;
 380 };
 381
 382 struct zapi_pw_status {
 383         char ifname[IF_NAMESIZE];
 384         ifindex_t ifindex;
 385         uint32_t status;
 386 };
 387
 388 enum zapi_route_notify_owner {
 389         ZAPI_ROUTE_FAIL_INSTALL,
 390         ZAPI_ROUTE_BETTER_ADMIN_WON,
 391         ZAPI_ROUTE_INSTALLED,
 392         ZAPI_ROUTE_REMOVED,
 393         ZAPI_ROUTE_REMOVE_FAIL,
 394 };
 395
 396 enum zapi_rule_notify_owner {
 397         ZAPI_RULE_FAIL_INSTALL,
 398         ZAPI_RULE_INSTALLED,
 399         ZAPI_RULE_REMOVED,
 400 };
 401
 402 enum ipset_type {
 403         IPSET_NET_NET = 1,
 404         IPSET_NET_PORT_NET,
 405         IPSET_NET_PORT,
 406         IPSET_NET
 407 };
 408
 409 enum zapi_ipset_notify_owner {
 410         ZAPI_IPSET_FAIL_INSTALL,
 411         ZAPI_IPSET_INSTALLED,
 412         ZAPI_IPSET_REMOVED,
 413 };
 414
 415 enum zapi_ipset_entry_notify_owner {
 416         ZAPI_IPSET_ENTRY_FAIL_INSTALL,
 417         ZAPI_IPSET_ENTRY_INSTALLED,
 418         ZAPI_IPSET_ENTRY_REMOVED,
 419 };
 420
 421 enum zapi_iptable_notify_owner {
 422         ZAPI_IPTABLE_FAIL_INSTALL,
 423         ZAPI_IPTABLE_INSTALLED,
 424         ZAPI_IPTABLE_REMOVED,
 425 };
 426
 427 /* Zebra MAC types */
 428 #define ZEBRA_MACIP_TYPE_STICKY                0x01 /* Sticky MAC*/
 429 #define ZEBRA_MACIP_TYPE_GW                    0x02 /* gateway (SVI) mac*/
 430
 431 struct zclient_options {
 432         bool receive_notify;
 433 };
 434
 435 /* Prototypes of zebra client service functions. */
 436 extern struct zclient *zclient_new(struct thread_master *);
 437
 438 /* clang-format off */
 439 #if defined(VERSION_TYPE_DEV) && CONFDATE > 20181101
 440 CPP_NOTICE("zclient_new_notify can take over or zclient_new now");
 441 #endif
 442 /* clang-format on */
 443
 444 extern struct zclient_options zclient_options_default;
 445
 446 extern struct zclient *zclient_new_notify(struct thread_master *m,
 447                                           struct zclient_options *opt);
 448
 449 #define zclient_new(A)                                                         \
 450         zclient_new_notify((A), &zclient_options_default);                     \
 451         CPP_WARN("Please transition to using zclient_new_notify");
 452
 453 extern void zclient_init(struct zclient *, int, unsigned short,
 454                          struct zebra_privs_t *privs);
 455 extern int zclient_start(struct zclient *);
 456 extern void zclient_stop(struct zclient *);
 457 extern void zclient_reset(struct zclient *);
 458 extern void zclient_free(struct zclient *);
 459
 460 extern int zclient_socket_connect(struct zclient *);
 461
 462 extern unsigned short *redist_check_instance(struct redist_proto *,
 463                                              unsigned short);
 464 extern void redist_add_instance(struct redist_proto *, unsigned short);
 465 extern void redist_del_instance(struct redist_proto *, unsigned short);
 466
 467 /*
 468  * Send to zebra that the specified vrf is using label to resolve
 469  * itself for L3VPN's.  Repeated calls of this function with
 470  * different labels will cause an effective update of the
 471  * label for lookup.  If you pass in MPLS_LABEL_NONE
 472  * we will cause a delete action and remove this label pop
 473  * operation.
 474  *
 475  * The underlying AF_MPLS doesn't care about afi's
 476  * but we can make the zebra_vrf keep track of what
 477  * we have installed and play some special games
 478  * to get them both installed.
 479  */
 480 extern void zclient_send_vrf_label(struct zclient *zclient, vrf_id_t vrf_id,
 481                                    afi_t afi, mpls_label_t label,
 482                                    enum lsp_types_t ltype);
 483
 484 extern void zclient_send_reg_requests(struct zclient *, vrf_id_t);
 485 extern void zclient_send_dereg_requests(struct zclient *, vrf_id_t);
 486
 487 extern void zclient_send_interface_radv_req(struct zclient *zclient,
 488                                             vrf_id_t vrf_id,
 489                                             struct interface *ifp, int enable,
 490                                             int ra_interval);
 491
 492 /* Send redistribute command to zebra daemon. Do not update zclient state. */
 493 extern int zebra_redistribute_send(int command, struct zclient *, afi_t,
 494                                    int type, unsigned short instance,
 495                                    vrf_id_t vrf_id);
 496
 497 /* If state has changed, update state and call zebra_redistribute_send. */
 498 extern void zclient_redistribute(int command, struct zclient *, afi_t, int type,
 499                                  unsigned short instance, vrf_id_t vrf_id);
 500
 501 /* If state has changed, update state and send the command to zebra. */
 502 extern void zclient_redistribute_default(int command, struct zclient *,
 503                                          vrf_id_t vrf_id);
 504
 505 /* Send the message in zclient->obuf to the zebra daemon (or enqueue it).
 506    Returns 0 for success or -1 on an I/O error. */
 507 extern int zclient_send_message(struct zclient *);
 508
 509 /* create header for command, length to be filled in by user later */
 510 extern void zclient_create_header(struct stream *, uint16_t, vrf_id_t);
 511 /*
 512  * Read sizeof(struct zmsghdr) bytes from the provided socket and parse the
 513  * received data into the specified fields. If this is successful, read the
 514  * rest of the packet into the provided stream.
 515  *
 516  * s
 517  *    The stream to read into
 518  *
 519  * sock
 520  *    The socket to read from
 521  *
 522  * size
 523  *    Parsed message size will be placed in the pointed-at integer
 524  *
 525  * marker
 526  *    Parsed marker will be placed in the pointed-at byte
 527  *
 528  * version
 529  *    Parsed version will be placed in the pointed-at byte
 530  *
 531  * vrf_id
 532  *    Parsed VRF ID will be placed in the pointed-at vrf_id_t
 533  *
 534  * cmd
 535  *    Parsed command number will be placed in the pointed-at integer
 536  *
 537  * Returns:
 538  *    -1 if:
 539  *    - insufficient data for header was read
 540  *    - a version mismatch was detected
 541  *    - a marker mismatch was detected
 542  *    - header size field specified more data than could be read
 543  */
 544 extern int zclient_read_header(struct stream *s, int sock, uint16_t *size,
 545                                uint8_t *marker, uint8_t *version,
 546                                vrf_id_t *vrf_id, uint16_t *cmd);
 547 /*
 548  * Parse header from ZAPI message stream into struct zmsghdr.
 549  * This function assumes the stream getp points at the first byte of the header.
 550  * If the function is successful then the stream getp will point to the byte
 551  * immediately after the last byte of the header.
 552  *
 553  * zmsg
 554  *    The stream containing the header
 555  *
 556  * hdr
 557  *    The header struct to parse into.
 558  *
 559  * Returns:
 560  *    true if parsing succeeded, false otherwise
 561  */
 562 extern bool zapi_parse_header(struct stream *zmsg, struct zmsghdr *hdr);
 563
 564 extern void zclient_interface_set_master(struct zclient *client,
 565                                          struct interface *master,
 566                                          struct interface *slave);
 567 extern struct interface *zebra_interface_add_read(struct stream *, vrf_id_t);
 568 extern struct interface *zebra_interface_state_read(struct stream *s, vrf_id_t);
 569 extern struct connected *zebra_interface_address_read(int, struct stream *,
 570                                                       vrf_id_t);
 571 extern struct nbr_connected *
 572 zebra_interface_nbr_address_read(int, struct stream *, vrf_id_t);
 573 extern struct interface *zebra_interface_vrf_update_read(struct stream *s,
 574                                                          vrf_id_t vrf_id,
 575                                                          vrf_id_t *new_vrf_id);
 576 extern void zebra_interface_if_set_value(struct stream *, struct interface *);
 577 extern void zebra_router_id_update_read(struct stream *s, struct prefix *rid);
 578
 579 /* clang-format off */
 580 #if defined(VERSION_TYPE_DEV) && CONFDATE > 20180823
 581 CPP_NOTICE("zapi_ipv4_route, zapi_ipv6_route, zapi_ipv4_route_ipv6_nexthop as well as the zapi_ipv4 and zapi_ipv6 data structures should be removed now");
 582 #endif
 583 /* clang-format on */
 584
 585 extern int zapi_ipv4_route(uint8_t, struct zclient *, struct prefix_ipv4 *,
 586                            struct zapi_ipv4 *) __attribute__((deprecated));
 587
 588 extern struct interface *zebra_interface_link_params_read(struct stream *);
 589 extern size_t zebra_interface_link_params_write(struct stream *,
 590                                                 struct interface *);
 591 extern int zclient_send_get_label_chunk(
 592         struct zclient  *zclient,
 593         uint8_t         keep,
 594         uint32_t        chunk_size);
 595
 596 extern int lm_label_manager_connect(struct zclient *zclient);
 597 extern int lm_get_label_chunk(struct zclient *zclient, uint8_t keep,
 598                               uint32_t chunk_size, uint32_t *start,
 599                               uint32_t *end);
 600 extern int lm_release_label_chunk(struct zclient *zclient, uint32_t start,
 601                                   uint32_t end);
 602 extern int tm_table_manager_connect(struct zclient *zclient);
 603 extern int tm_get_table_chunk(struct zclient *zclient, uint32_t chunk_size,
 604                               uint32_t *start, uint32_t *end);
 605 extern int tm_release_table_chunk(struct zclient *zclient, uint32_t start,
 606                                   uint32_t end);
 607
 608 extern int zebra_send_pw(struct zclient *zclient, int command,
 609                          struct zapi_pw *pw);
 610 extern void zebra_read_pw_status_update(int command, struct zclient *zclient,
 611                                         zebra_size_t length, vrf_id_t vrf_id,
 612                                         struct zapi_pw_status *pw);
 613
 614 /* IPv6 prefix add and delete function prototype. */
 615
 616 struct zapi_ipv6 {
 617         uint8_t type;
 618         unsigned short instance;
 619
 620         uint32_t flags;
 621
 622         uint8_t message;
 623
 624         safi_t safi;
 625
 626         uint8_t nexthop_num;
 627         struct in6_addr **nexthop;
 628
 629         uint8_t ifindex_num;
 630         ifindex_t *ifindex;
 631
 632         uint8_t label_num;
 633         unsigned int *label;
 634
 635         uint8_t distance;
 636
 637         uint32_t metric;
 638
 639         route_tag_t tag;
 640
 641         uint32_t mtu;
 642
 643         vrf_id_t vrf_id;
 644 };
 645
 646 extern int zapi_ipv6_route(uint8_t cmd, struct zclient *zclient,
 647                            struct prefix_ipv6 *p, struct prefix_ipv6 *src_p,
 648                            struct zapi_ipv6 *api) __attribute__((deprecated));
 649 extern int zapi_ipv4_route_ipv6_nexthop(uint8_t, struct zclient *,
 650                                         struct prefix_ipv4 *,
 651                                         struct zapi_ipv6 *)
 652         __attribute__((deprecated));
 653 extern int zclient_route_send(uint8_t, struct zclient *, struct zapi_route *);
 654 extern int zclient_send_rnh(struct zclient *zclient, int command,
 655                             struct prefix *p, bool exact_match,
 656                             vrf_id_t vrf_id);
 657 extern int zapi_route_encode(uint8_t, struct stream *, struct zapi_route *);
 658 extern int zapi_route_decode(struct stream *, struct zapi_route *);
 659 bool zapi_route_notify_decode(struct stream *s, struct prefix *p,
 660                               uint32_t *tableid,
 661                               enum zapi_route_notify_owner *note);
 662 bool zapi_rule_notify_decode(struct stream *s, uint32_t *seqno,
 663                              uint32_t *priority, uint32_t *unique,
 664                              ifindex_t *ifindex,
 665                              enum zapi_rule_notify_owner *note);
 666 bool zapi_ipset_notify_decode(struct stream *s,
 667                               uint32_t *unique,
 668                              enum zapi_ipset_notify_owner *note);
 669
 670 #define ZEBRA_IPSET_NAME_SIZE   32
 671
 672 bool zapi_ipset_entry_notify_decode(struct stream *s,
 673             uint32_t *unique,
 674             char *ipset_name,
 675             enum zapi_ipset_entry_notify_owner *note);
 676
 677 extern struct nexthop *nexthop_from_zapi_nexthop(struct zapi_nexthop *znh);
 678 extern bool zapi_nexthop_update_decode(struct stream *s,
 679                                        struct zapi_route *nhr);
 680
 681 static inline void zapi_route_set_blackhole(struct zapi_route *api,
 682                                             enum blackhole_type bh_type)
 683 {
 684         api->nexthop_num = 1;
 685         api->nexthops[0].type = NEXTHOP_TYPE_BLACKHOLE;
 686         api->nexthops[0].vrf_id = VRF_DEFAULT;
 687         api->nexthops[0].bh_type = bh_type;
 688         SET_FLAG(api->message, ZAPI_MESSAGE_NEXTHOP);
 689 };
 690
 691
 692 #endif /* _ZEBRA_ZCLIENT_H */