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 #include "mlag.h"
  40
  41 /* Zebra types. Used in Zserv message header. */
  42 typedef uint16_t zebra_size_t;
  43
  44 /* Marker value used in new Zserv, in the byte location corresponding
  45  * the command value in the old zserv header. To allow old and new
  46  * Zserv headers to be distinguished from each other.
  47  */
  48 #define ZEBRA_HEADER_MARKER              254
  49
  50 /* For input/output buffer to zebra. */
  51 #define ZEBRA_MAX_PACKET_SIZ          16384U
  52
  53 /* Zebra header size. */
  54 #define ZEBRA_HEADER_SIZE             10
  55
  56 /* special socket path name to use TCP
  57  * @ is used as first character because that's abstract socket names on Linux
  58  */
  59 #define ZAPI_TCP_PATHNAME             "@tcp"
  60
  61 /* IPset size name stands for the name of the ipset entry
  62  * that can be created by using some zapi interfaces
  63  */
  64 #define ZEBRA_IPSET_NAME_SIZE   32
  65
  66 /* IPTable action is defined by two values: either
  67  * forward or drop
  68  */
  69 #define ZEBRA_IPTABLES_FORWARD 0
  70 #define ZEBRA_IPTABLES_DROP    1
  71
  72 /* Zebra FEC register command flags. */
  73 #define ZEBRA_FEC_REGISTER_LABEL          0x1
  74 #define ZEBRA_FEC_REGISTER_LABEL_INDEX    0x2
  75
  76 extern struct sockaddr_storage zclient_addr;
  77 extern socklen_t zclient_addr_len;
  78
  79 /* Zebra message types. */
  80 typedef enum {
  81         ZEBRA_INTERFACE_ADD,
  82         ZEBRA_INTERFACE_DELETE,
  83         ZEBRA_INTERFACE_ADDRESS_ADD,
  84         ZEBRA_INTERFACE_ADDRESS_DELETE,
  85         ZEBRA_INTERFACE_UP,
  86         ZEBRA_INTERFACE_DOWN,
  87         ZEBRA_INTERFACE_SET_MASTER,
  88         ZEBRA_INTERFACE_SET_PROTODOWN,
  89         ZEBRA_ROUTE_ADD,
  90         ZEBRA_ROUTE_DELETE,
  91         ZEBRA_ROUTE_NOTIFY_OWNER,
  92         ZEBRA_REDISTRIBUTE_ADD,
  93         ZEBRA_REDISTRIBUTE_DELETE,
  94         ZEBRA_REDISTRIBUTE_DEFAULT_ADD,
  95         ZEBRA_REDISTRIBUTE_DEFAULT_DELETE,
  96         ZEBRA_ROUTER_ID_ADD,
  97         ZEBRA_ROUTER_ID_DELETE,
  98         ZEBRA_ROUTER_ID_UPDATE,
  99         ZEBRA_HELLO,
 100         ZEBRA_CAPABILITIES,
 101         ZEBRA_NEXTHOP_REGISTER,
 102         ZEBRA_NEXTHOP_UNREGISTER,
 103         ZEBRA_NEXTHOP_UPDATE,
 104         ZEBRA_INTERFACE_NBR_ADDRESS_ADD,
 105         ZEBRA_INTERFACE_NBR_ADDRESS_DELETE,
 106         ZEBRA_INTERFACE_BFD_DEST_UPDATE,
 107         ZEBRA_IMPORT_ROUTE_REGISTER,
 108         ZEBRA_IMPORT_ROUTE_UNREGISTER,
 109         ZEBRA_IMPORT_CHECK_UPDATE,
 110         ZEBRA_BFD_DEST_REGISTER,
 111         ZEBRA_BFD_DEST_DEREGISTER,
 112         ZEBRA_BFD_DEST_UPDATE,
 113         ZEBRA_BFD_DEST_REPLAY,
 114         ZEBRA_REDISTRIBUTE_ROUTE_ADD,
 115         ZEBRA_REDISTRIBUTE_ROUTE_DEL,
 116         ZEBRA_VRF_UNREGISTER,
 117         ZEBRA_VRF_ADD,
 118         ZEBRA_VRF_DELETE,
 119         ZEBRA_VRF_LABEL,
 120         ZEBRA_INTERFACE_VRF_UPDATE,
 121         ZEBRA_BFD_CLIENT_REGISTER,
 122         ZEBRA_BFD_CLIENT_DEREGISTER,
 123         ZEBRA_INTERFACE_ENABLE_RADV,
 124         ZEBRA_INTERFACE_DISABLE_RADV,
 125         ZEBRA_IPV4_NEXTHOP_LOOKUP_MRIB,
 126         ZEBRA_INTERFACE_LINK_PARAMS,
 127         ZEBRA_MPLS_LABELS_ADD,
 128         ZEBRA_MPLS_LABELS_DELETE,
 129         ZEBRA_IPMR_ROUTE_STATS,
 130         ZEBRA_LABEL_MANAGER_CONNECT,
 131         ZEBRA_LABEL_MANAGER_CONNECT_ASYNC,
 132         ZEBRA_GET_LABEL_CHUNK,
 133         ZEBRA_RELEASE_LABEL_CHUNK,
 134         ZEBRA_FEC_REGISTER,
 135         ZEBRA_FEC_UNREGISTER,
 136         ZEBRA_FEC_UPDATE,
 137         ZEBRA_ADVERTISE_DEFAULT_GW,
 138         ZEBRA_ADVERTISE_SVI_MACIP,
 139         ZEBRA_ADVERTISE_SUBNET,
 140         ZEBRA_ADVERTISE_ALL_VNI,
 141         ZEBRA_LOCAL_ES_ADD,
 142         ZEBRA_LOCAL_ES_DEL,
 143         ZEBRA_VNI_ADD,
 144         ZEBRA_VNI_DEL,
 145         ZEBRA_L3VNI_ADD,
 146         ZEBRA_L3VNI_DEL,
 147         ZEBRA_REMOTE_VTEP_ADD,
 148         ZEBRA_REMOTE_VTEP_DEL,
 149         ZEBRA_MACIP_ADD,
 150         ZEBRA_MACIP_DEL,
 151         ZEBRA_IP_PREFIX_ROUTE_ADD,
 152         ZEBRA_IP_PREFIX_ROUTE_DEL,
 153         ZEBRA_REMOTE_MACIP_ADD,
 154         ZEBRA_REMOTE_MACIP_DEL,
 155         ZEBRA_DUPLICATE_ADDR_DETECTION,
 156         ZEBRA_PW_ADD,
 157         ZEBRA_PW_DELETE,
 158         ZEBRA_PW_SET,
 159         ZEBRA_PW_UNSET,
 160         ZEBRA_PW_STATUS_UPDATE,
 161         ZEBRA_RULE_ADD,
 162         ZEBRA_RULE_DELETE,
 163         ZEBRA_RULE_NOTIFY_OWNER,
 164         ZEBRA_TABLE_MANAGER_CONNECT,
 165         ZEBRA_GET_TABLE_CHUNK,
 166         ZEBRA_RELEASE_TABLE_CHUNK,
 167         ZEBRA_IPSET_CREATE,
 168         ZEBRA_IPSET_DESTROY,
 169         ZEBRA_IPSET_ENTRY_ADD,
 170         ZEBRA_IPSET_ENTRY_DELETE,
 171         ZEBRA_IPSET_NOTIFY_OWNER,
 172         ZEBRA_IPSET_ENTRY_NOTIFY_OWNER,
 173         ZEBRA_IPTABLE_ADD,
 174         ZEBRA_IPTABLE_DELETE,
 175         ZEBRA_IPTABLE_NOTIFY_OWNER,
 176         ZEBRA_VXLAN_FLOOD_CONTROL,
 177         ZEBRA_VXLAN_SG_ADD,
 178         ZEBRA_VXLAN_SG_DEL,
 179         ZEBRA_VXLAN_SG_REPLAY,
 180 } zebra_message_types_t;
 181
 182 struct redist_proto {
 183         uint8_t enabled;
 184         struct list *instances;
 185 };
 186
 187 struct zclient_capabilities {
 188         uint32_t ecmp;
 189         bool mpls_enabled;
 190         enum mlag_role role;
 191 };
 192
 193 /* Structure for the zebra client. */
 194 struct zclient {
 195         /* The thread master we schedule ourselves on */
 196         struct thread_master *master;
 197
 198         /* Priviledges to change socket values */
 199         struct zebra_privs_t *privs;
 200
 201         /* Do we care about failure events for route install? */
 202         bool receive_notify;
 203
 204         /* Socket to zebra daemon. */
 205         int sock;
 206
 207         /* Connection failure count. */
 208         int fail;
 209
 210         /* Input buffer for zebra message. */
 211         struct stream *ibuf;
 212
 213         /* Output buffer for zebra message. */
 214         struct stream *obuf;
 215
 216         /* Buffer of data waiting to be written to zebra. */
 217         struct buffer *wb;
 218
 219         /* Read and connect thread. */
 220         struct thread *t_read;
 221         struct thread *t_connect;
 222
 223         /* Thread to write buffered data to zebra. */
 224         struct thread *t_write;
 225
 226         /* Redistribute information. */
 227         uint8_t redist_default; /* clients protocol */
 228         unsigned short instance;
 229         struct redist_proto mi_redist[AFI_MAX][ZEBRA_ROUTE_MAX];
 230         vrf_bitmap_t redist[AFI_MAX][ZEBRA_ROUTE_MAX];
 231
 232         /* Redistribute defauilt. */
 233         vrf_bitmap_t default_information[AFI_MAX];
 234
 235 #define ZAPI_CALLBACK_ARGS                                                     \
 236         int cmd, struct zclient *zclient, uint16_t length, vrf_id_t vrf_id
 237
 238         /* Pointer to the callback functions. */
 239         void (*zebra_connected)(struct zclient *);
 240         void (*zebra_capabilities)(struct zclient_capabilities *cap);
 241         int (*router_id_update)(ZAPI_CALLBACK_ARGS);
 242         int (*interface_add)(ZAPI_CALLBACK_ARGS);
 243         int (*interface_delete)(ZAPI_CALLBACK_ARGS);
 244         int (*interface_up)(ZAPI_CALLBACK_ARGS);
 245         int (*interface_down)(ZAPI_CALLBACK_ARGS);
 246         int (*interface_address_add)(ZAPI_CALLBACK_ARGS);
 247         int (*interface_address_delete)(ZAPI_CALLBACK_ARGS);
 248         int (*interface_link_params)(ZAPI_CALLBACK_ARGS);
 249         int (*interface_bfd_dest_update)(ZAPI_CALLBACK_ARGS);
 250         int (*interface_nbr_address_add)(ZAPI_CALLBACK_ARGS);
 251         int (*interface_nbr_address_delete)(ZAPI_CALLBACK_ARGS);
 252         int (*interface_vrf_update)(ZAPI_CALLBACK_ARGS);
 253         int (*nexthop_update)(ZAPI_CALLBACK_ARGS);
 254         int (*import_check_update)(ZAPI_CALLBACK_ARGS);
 255         int (*bfd_dest_replay)(ZAPI_CALLBACK_ARGS);
 256         int (*redistribute_route_add)(ZAPI_CALLBACK_ARGS);
 257         int (*redistribute_route_del)(ZAPI_CALLBACK_ARGS);
 258         int (*fec_update)(int, struct zclient *, uint16_t);
 259         int (*local_es_add)(ZAPI_CALLBACK_ARGS);
 260         int (*local_es_del)(ZAPI_CALLBACK_ARGS);
 261         int (*local_vni_add)(ZAPI_CALLBACK_ARGS);
 262         int (*local_vni_del)(ZAPI_CALLBACK_ARGS);
 263         int (*local_l3vni_add)(ZAPI_CALLBACK_ARGS);
 264         int (*local_l3vni_del)(ZAPI_CALLBACK_ARGS);
 265         void (*local_ip_prefix_add)(ZAPI_CALLBACK_ARGS);
 266         void (*local_ip_prefix_del)(ZAPI_CALLBACK_ARGS);
 267         int (*local_macip_add)(ZAPI_CALLBACK_ARGS);
 268         int (*local_macip_del)(ZAPI_CALLBACK_ARGS);
 269         int (*pw_status_update)(ZAPI_CALLBACK_ARGS);
 270         int (*route_notify_owner)(ZAPI_CALLBACK_ARGS);
 271         int (*rule_notify_owner)(ZAPI_CALLBACK_ARGS);
 272         void (*label_chunk)(ZAPI_CALLBACK_ARGS);
 273         int (*ipset_notify_owner)(ZAPI_CALLBACK_ARGS);
 274         int (*ipset_entry_notify_owner)(ZAPI_CALLBACK_ARGS);
 275         int (*iptable_notify_owner)(ZAPI_CALLBACK_ARGS);
 276         int (*vxlan_sg_add)(ZAPI_CALLBACK_ARGS);
 277         int (*vxlan_sg_del)(ZAPI_CALLBACK_ARGS);
 278 };
 279
 280 /* Zebra API message flag. */
 281 #define ZAPI_MESSAGE_NEXTHOP  0x01
 282 #define ZAPI_MESSAGE_DISTANCE 0x02
 283 #define ZAPI_MESSAGE_METRIC   0x04
 284 #define ZAPI_MESSAGE_TAG      0x08
 285 #define ZAPI_MESSAGE_MTU      0x10
 286 #define ZAPI_MESSAGE_SRCPFX   0x20
 287 #define ZAPI_MESSAGE_LABEL    0x40
 288 /*
 289  * This should only be used by a DAEMON that needs to communicate
 290  * the table being used is not in the VRF.  You must pass the
 291  * default vrf, else this will be ignored.
 292  */
 293 #define ZAPI_MESSAGE_TABLEID  0x80
 294
 295 #define ZSERV_VERSION 6
 296 /* Zserv protocol message header */
 297 struct zmsghdr {
 298         uint16_t length;
 299         /* Always set to 255 in new zserv */
 300         uint8_t marker;
 301         uint8_t version;
 302         vrf_id_t vrf_id;
 303         uint16_t command;
 304 };
 305
 306 struct zapi_nexthop {
 307         enum nexthop_types_t type;
 308         vrf_id_t vrf_id;
 309         ifindex_t ifindex;
 310         bool onlink;
 311         union {
 312                 union g_addr gate;
 313                 enum blackhole_type bh_type;
 314         };
 315
 316         /* MPLS labels for BGP-LU or Segment Routing */
 317         uint8_t label_num;
 318         mpls_label_t labels[MPLS_MAX_LABELS];
 319
 320         struct ethaddr rmac;
 321 };
 322
 323 /*
 324  * Some of these data structures do not map easily to
 325  * a actual data structure size giving different compilers
 326  * and systems.  For those data structures we need
 327  * to use the smallest available stream_getX/putX functions
 328  * to encode/decode.
 329  */
 330 struct zapi_route {
 331         uint8_t type;
 332         unsigned short instance;
 333
 334         uint32_t flags;
 335 /*
 336  * Cause Zebra to consider this routes nexthops recursively
 337  */
 338 #define ZEBRA_FLAG_ALLOW_RECURSION    0x01
 339 /*
 340  * This is a route that is read in on startup that was left around
 341  * from a previous run of FRR
 342  */
 343 #define ZEBRA_FLAG_SELFROUTE          0x02
 344 /*
 345  * This flag is used to tell Zebra that the BGP route being passed
 346  * down is a IBGP route
 347  */
 348 #define ZEBRA_FLAG_IBGP               0x04
 349 /*
 350  * This is a route that has been selected for FIB installation.
 351  * This flag is set in zebra and can be passed up to routing daemons
 352  */
 353 #define ZEBRA_FLAG_SELECTED           0x08
 354 /*
 355  * This is a route that we are telling Zebra that this route *must*
 356  * win and will be installed even over ZEBRA_FLAG_SELECTED
 357  */
 358 #define ZEBRA_FLAG_FIB_OVERRIDE       0x10
 359 /*
 360  * This flag tells Zebra that the route is a EVPN route and should
 361  * be treated specially
 362  */
 363 #define ZEBRA_FLAG_EVPN_ROUTE         0x20
 364 /*
 365  * This flag tells Zebra that it should treat the distance passed
 366  * down as an additional discriminator for route selection of the
 367  * route entry.  This mainly is used for backup static routes.
 368  */
 369 #define ZEBRA_FLAG_RR_USE_DISTANCE    0x40
 370
 371         uint8_t message;
 372
 373         /*
 374          * This is an enum but we are going to treat it as a uint8_t
 375          * for purpose of encoding/decoding
 376          */
 377         safi_t safi;
 378
 379         struct prefix prefix;
 380         struct prefix_ipv6 src_prefix;
 381
 382         uint16_t nexthop_num;
 383         struct zapi_nexthop nexthops[MULTIPATH_NUM];
 384
 385         uint8_t distance;
 386
 387         uint32_t metric;
 388
 389         route_tag_t tag;
 390
 391         uint32_t mtu;
 392
 393         vrf_id_t vrf_id;
 394
 395         uint32_t tableid;
 396 };
 397
 398 struct zapi_pw {
 399         char ifname[IF_NAMESIZE];
 400         ifindex_t ifindex;
 401         int type;
 402         int af;
 403         union g_addr nexthop;
 404         uint32_t local_label;
 405         uint32_t remote_label;
 406         uint8_t flags;
 407         union pw_protocol_fields data;
 408         uint8_t protocol;
 409 };
 410
 411 struct zapi_pw_status {
 412         char ifname[IF_NAMESIZE];
 413         ifindex_t ifindex;
 414         uint32_t status;
 415 };
 416
 417 enum zapi_route_notify_owner {
 418         ZAPI_ROUTE_FAIL_INSTALL,
 419         ZAPI_ROUTE_BETTER_ADMIN_WON,
 420         ZAPI_ROUTE_INSTALLED,
 421         ZAPI_ROUTE_REMOVED,
 422         ZAPI_ROUTE_REMOVE_FAIL,
 423 };
 424
 425 enum zapi_rule_notify_owner {
 426         ZAPI_RULE_FAIL_INSTALL,
 427         ZAPI_RULE_INSTALLED,
 428         ZAPI_RULE_REMOVED,
 429         ZAPI_RULE_FAIL_REMOVE,
 430 };
 431
 432 enum ipset_type {
 433         IPSET_NET_NET = 1,
 434         IPSET_NET_PORT_NET,
 435         IPSET_NET_PORT,
 436         IPSET_NET
 437 };
 438
 439 enum zapi_ipset_notify_owner {
 440         ZAPI_IPSET_FAIL_INSTALL,
 441         ZAPI_IPSET_INSTALLED,
 442         ZAPI_IPSET_REMOVED,
 443         ZAPI_IPSET_FAIL_REMOVE,
 444 };
 445
 446 enum zapi_ipset_entry_notify_owner {
 447         ZAPI_IPSET_ENTRY_FAIL_INSTALL,
 448         ZAPI_IPSET_ENTRY_INSTALLED,
 449         ZAPI_IPSET_ENTRY_REMOVED,
 450         ZAPI_IPSET_ENTRY_FAIL_REMOVE,
 451 };
 452
 453 enum zapi_iptable_notify_owner {
 454         ZAPI_IPTABLE_FAIL_INSTALL,
 455         ZAPI_IPTABLE_INSTALLED,
 456         ZAPI_IPTABLE_REMOVED,
 457         ZAPI_IPTABLE_FAIL_REMOVE,
 458 };
 459
 460 /* Zebra MAC types */
 461 #define ZEBRA_MACIP_TYPE_STICKY                0x01 /* Sticky MAC*/
 462 #define ZEBRA_MACIP_TYPE_GW                    0x02 /* gateway (SVI) mac*/
 463 #define ZEBRA_MACIP_TYPE_ROUTER_FLAG           0x04 /* Router Flag - proxy NA */
 464 #define ZEBRA_MACIP_TYPE_OVERRIDE_FLAG         0x08 /* Override Flag */
 465
 466 enum zebra_neigh_state { ZEBRA_NEIGH_INACTIVE = 0, ZEBRA_NEIGH_ACTIVE = 1 };
 467
 468 struct zclient_options {
 469         bool receive_notify;
 470 };
 471
 472 extern struct zclient_options zclient_options_default;
 473
 474 extern struct zclient *zclient_new(struct thread_master *m,
 475                                    struct zclient_options *opt);
 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 extern int zclient_send_interface_protodown(struct zclient *zclient,
 516                                             vrf_id_t vrf_id,
 517                                             struct interface *ifp, bool down);
 518
 519 /* Send redistribute command to zebra daemon. Do not update zclient state. */
 520 extern int zebra_redistribute_send(int command, struct zclient *, afi_t,
 521                                    int type, unsigned short instance,
 522                                    vrf_id_t vrf_id);
 523
 524 extern int zebra_redistribute_default_send(int command, struct zclient *zclient,
 525                                            afi_t afi, vrf_id_t vrf_id);
 526
 527 /* If state has changed, update state and call zebra_redistribute_send. */
 528 extern void zclient_redistribute(int command, struct zclient *, afi_t, int type,
 529                                  unsigned short instance, vrf_id_t vrf_id);
 530
 531 /* If state has changed, update state and send the command to zebra. */
 532 extern void zclient_redistribute_default(int command, struct zclient *,
 533                                          afi_t, vrf_id_t vrf_id);
 534
 535 /* Send the message in zclient->obuf to the zebra daemon (or enqueue it).
 536    Returns 0 for success or -1 on an I/O error. */
 537 extern int zclient_send_message(struct zclient *);
 538
 539 /* create header for command, length to be filled in by user later */
 540 extern void zclient_create_header(struct stream *, uint16_t, vrf_id_t);
 541 /*
 542  * Read sizeof(struct zmsghdr) bytes from the provided socket and parse the
 543  * received data into the specified fields. If this is successful, read the
 544  * rest of the packet into the provided stream.
 545  *
 546  * s
 547  *    The stream to read into
 548  *
 549  * sock
 550  *    The socket to read from
 551  *
 552  * size
 553  *    Parsed message size will be placed in the pointed-at integer
 554  *
 555  * marker
 556  *    Parsed marker will be placed in the pointed-at byte
 557  *
 558  * version
 559  *    Parsed version will be placed in the pointed-at byte
 560  *
 561  * vrf_id
 562  *    Parsed VRF ID will be placed in the pointed-at vrf_id_t
 563  *
 564  * cmd
 565  *    Parsed command number will be placed in the pointed-at integer
 566  *
 567  * Returns:
 568  *    -1 if:
 569  *    - insufficient data for header was read
 570  *    - a version mismatch was detected
 571  *    - a marker mismatch was detected
 572  *    - header size field specified more data than could be read
 573  */
 574 extern int zclient_read_header(struct stream *s, int sock, uint16_t *size,
 575                                uint8_t *marker, uint8_t *version,
 576                                vrf_id_t *vrf_id, uint16_t *cmd);
 577 /*
 578  * Parse header from ZAPI message stream into struct zmsghdr.
 579  * This function assumes the stream getp points at the first byte of the header.
 580  * If the function is successful then the stream getp will point to the byte
 581  * immediately after the last byte of the header.
 582  *
 583  * zmsg
 584  *    The stream containing the header
 585  *
 586  * hdr
 587  *    The header struct to parse into.
 588  *
 589  * Returns:
 590  *    true if parsing succeeded, false otherwise
 591  */
 592 extern bool zapi_parse_header(struct stream *zmsg, struct zmsghdr *hdr);
 593
 594 extern void zclient_interface_set_master(struct zclient *client,
 595                                          struct interface *master,
 596                                          struct interface *slave);
 597 extern struct interface *zebra_interface_add_read(struct stream *, vrf_id_t);
 598 extern struct interface *zebra_interface_state_read(struct stream *s, vrf_id_t);
 599 extern struct connected *zebra_interface_address_read(int, struct stream *,
 600                                                       vrf_id_t);
 601 extern struct nbr_connected *
 602 zebra_interface_nbr_address_read(int, struct stream *, vrf_id_t);
 603 extern struct interface *zebra_interface_vrf_update_read(struct stream *s,
 604                                                          vrf_id_t vrf_id,
 605                                                          vrf_id_t *new_vrf_id);
 606 extern void zebra_interface_if_set_value(struct stream *, struct interface *);
 607 extern void zebra_router_id_update_read(struct stream *s, struct prefix *rid);
 608
 609 extern struct interface *zebra_interface_link_params_read(struct stream *s,
 610                                                           vrf_id_t vrf_id);
 611 extern size_t zebra_interface_link_params_write(struct stream *,
 612                                                 struct interface *);
 613 extern int zclient_send_get_label_chunk(struct zclient *zclient, uint8_t keep,
 614                                         uint32_t chunk_size, uint32_t base);
 615
 616 extern int lm_label_manager_connect(struct zclient *zclient, int async);
 617 extern int lm_get_label_chunk(struct zclient *zclient, uint8_t keep,
 618                               uint32_t base, uint32_t chunk_size,
 619                               uint32_t *start, uint32_t *end);
 620 extern int lm_release_label_chunk(struct zclient *zclient, uint32_t start,
 621                                   uint32_t end);
 622 extern int tm_table_manager_connect(struct zclient *zclient);
 623 extern int tm_get_table_chunk(struct zclient *zclient, uint32_t chunk_size,
 624                               uint32_t *start, uint32_t *end);
 625 extern int tm_release_table_chunk(struct zclient *zclient, uint32_t start,
 626                                   uint32_t end);
 627
 628 extern int zebra_send_pw(struct zclient *zclient, int command,
 629                          struct zapi_pw *pw);
 630 extern void zebra_read_pw_status_update(ZAPI_CALLBACK_ARGS, struct zapi_pw_status *pw);
 631
 632 extern int zclient_route_send(uint8_t, struct zclient *, struct zapi_route *);
 633 extern int zclient_send_rnh(struct zclient *zclient, int command,
 634                             struct prefix *p, bool exact_match,
 635                             vrf_id_t vrf_id);
 636 extern int zapi_route_encode(uint8_t, struct stream *, struct zapi_route *);
 637 extern int zapi_route_decode(struct stream *, struct zapi_route *);
 638 bool zapi_route_notify_decode(struct stream *s, struct prefix *p,
 639                               uint32_t *tableid,
 640                               enum zapi_route_notify_owner *note);
 641 bool zapi_rule_notify_decode(struct stream *s, uint32_t *seqno,
 642                              uint32_t *priority, uint32_t *unique,
 643                              ifindex_t *ifindex,
 644                              enum zapi_rule_notify_owner *note);
 645 bool zapi_ipset_notify_decode(struct stream *s,
 646                               uint32_t *unique,
 647                              enum zapi_ipset_notify_owner *note);
 648
 649 #define ZEBRA_IPSET_NAME_SIZE   32
 650
 651 bool zapi_ipset_entry_notify_decode(struct stream *s,
 652             uint32_t *unique,
 653             char *ipset_name,
 654             enum zapi_ipset_entry_notify_owner *note);
 655 bool zapi_iptable_notify_decode(struct stream *s,
 656                 uint32_t *unique,
 657                 enum zapi_iptable_notify_owner *note);
 658
 659 extern struct nexthop *nexthop_from_zapi_nexthop(struct zapi_nexthop *znh);
 660 extern bool zapi_nexthop_update_decode(struct stream *s,
 661                                        struct zapi_route *nhr);
 662
 663 static inline void zapi_route_set_blackhole(struct zapi_route *api,
 664                                             enum blackhole_type bh_type)
 665 {
 666         api->nexthop_num = 1;
 667         api->nexthops[0].type = NEXTHOP_TYPE_BLACKHOLE;
 668         api->nexthops[0].vrf_id = VRF_DEFAULT;
 669         api->nexthops[0].bh_type = bh_type;
 670         SET_FLAG(api->message, ZAPI_MESSAGE_NEXTHOP);
 671 };
 672
 673
 674 #endif /* _ZEBRA_ZCLIENT_H */