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