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