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