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