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