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