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