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