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