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