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_message_types_t;
 133
 134 struct redist_proto {
 135         u_char enabled;
 136         struct list *instances;
 137 };
 138
 139 /* Structure for the zebra client. */
 140 struct zclient {
 141         /* The thread master we schedule ourselves on */
 142         struct thread_master *master;
 143
 144         /* Priviledges to change socket values */
 145         struct zebra_privs_t *privs;
 146
 147         /* Do we care about failure events for route install? */
 148         bool receive_notify;
 149
 150         /* Socket to zebra daemon. */
 151         int sock;
 152
 153         /* Connection failure count. */
 154         int fail;
 155
 156         /* Input buffer for zebra message. */
 157         struct stream *ibuf;
 158
 159         /* Output buffer for zebra message. */
 160         struct stream *obuf;
 161
 162         /* Buffer of data waiting to be written to zebra. */
 163         struct buffer *wb;
 164
 165         /* Read and connect thread. */
 166         struct thread *t_read;
 167         struct thread *t_connect;
 168
 169         /* Thread to write buffered data to zebra. */
 170         struct thread *t_write;
 171
 172         /* Redistribute information. */
 173         u_char redist_default; /* clients protocol */
 174         u_short instance;
 175         struct redist_proto mi_redist[AFI_MAX][ZEBRA_ROUTE_MAX];
 176         vrf_bitmap_t redist[AFI_MAX][ZEBRA_ROUTE_MAX];
 177
 178         /* Redistribute defauilt. */
 179         vrf_bitmap_t default_information;
 180
 181         /* Pointer to the callback functions. */
 182         void (*zebra_connected)(struct zclient *);
 183         int (*router_id_update)(int, struct zclient *, uint16_t, vrf_id_t);
 184         int (*interface_add)(int, struct zclient *, uint16_t, vrf_id_t);
 185         int (*interface_delete)(int, struct zclient *, uint16_t, vrf_id_t);
 186         int (*interface_up)(int, struct zclient *, uint16_t, vrf_id_t);
 187         int (*interface_down)(int, struct zclient *, uint16_t, vrf_id_t);
 188         int (*interface_address_add)(int, struct zclient *, uint16_t, vrf_id_t);
 189         int (*interface_address_delete)(int, struct zclient *, uint16_t,
 190                                         vrf_id_t);
 191         int (*interface_link_params)(int, struct zclient *, uint16_t);
 192         int (*interface_bfd_dest_update)(int, struct zclient *, uint16_t,
 193                                          vrf_id_t);
 194         int (*interface_nbr_address_add)(int, struct zclient *, uint16_t,
 195                                          vrf_id_t);
 196         int (*interface_nbr_address_delete)(int, struct zclient *, uint16_t,
 197                                             vrf_id_t);
 198         int (*interface_vrf_update)(int, struct zclient *, uint16_t, vrf_id_t);
 199         int (*nexthop_update)(int, struct zclient *, uint16_t, vrf_id_t);
 200         int (*import_check_update)(int, struct zclient *, uint16_t, vrf_id_t);
 201         int (*bfd_dest_replay)(int, struct zclient *, uint16_t, vrf_id_t);
 202         int (*redistribute_route_add)(int, struct zclient *, uint16_t,
 203                                       vrf_id_t);
 204         int (*redistribute_route_del)(int, struct zclient *, uint16_t,
 205                                       vrf_id_t);
 206         int (*fec_update)(int, struct zclient *, uint16_t);
 207         int (*local_vni_add)(int, struct zclient *, uint16_t, vrf_id_t);
 208         int (*local_vni_del)(int, struct zclient *, uint16_t, vrf_id_t);
 209         int (*local_l3vni_add)(int, struct zclient *, uint16_t, vrf_id_t);
 210         int (*local_l3vni_del)(int, struct zclient *, uint16_t, vrf_id_t);
 211         void (*local_ip_prefix_add)(int, struct zclient *, uint16_t, vrf_id_t);
 212         void (*local_ip_prefix_del)(int, struct zclient *, uint16_t, vrf_id_t);
 213         int (*local_macip_add)(int, struct zclient *, uint16_t, vrf_id_t);
 214         int (*local_macip_del)(int, struct zclient *, uint16_t, vrf_id_t);
 215         int (*pw_status_update)(int, struct zclient *, uint16_t, vrf_id_t);
 216         int (*route_notify_owner)(int command, struct zclient *zclient,
 217                                   uint16_t length, vrf_id_t vrf_id);
 218 };
 219
 220 /* Zebra API message flag. */
 221 #define ZAPI_MESSAGE_NEXTHOP  0x01
 222 #define ZAPI_MESSAGE_DISTANCE 0x02
 223 #define ZAPI_MESSAGE_METRIC   0x04
 224 #define ZAPI_MESSAGE_TAG      0x08
 225 #define ZAPI_MESSAGE_MTU      0x10
 226 #define ZAPI_MESSAGE_SRCPFX   0x20
 227 #define ZAPI_MESSAGE_LABEL    0x40
 228
 229 /* Zserv protocol message header */
 230 struct zserv_header {
 231         uint16_t length;
 232         uint8_t marker; /* corresponds to command field in old zserv
 233                          * always set to 255 in new zserv.
 234                          */
 235         uint8_t version;
 236 #define ZSERV_VERSION   5
 237         vrf_id_t vrf_id;
 238         uint16_t command;
 239 };
 240
 241 struct zapi_nexthop {
 242         enum nexthop_types_t type;
 243         vrf_id_t vrf_id;
 244         ifindex_t ifindex;
 245         union {
 246                 union g_addr gate;
 247                 enum blackhole_type bh_type;
 248         };
 249
 250         /* MPLS labels for BGP-LU or Segment Routing */
 251         uint8_t label_num;
 252         mpls_label_t labels[MPLS_MAX_LABELS];
 253 };
 254
 255 /*
 256  * Some of these data structures do not map easily to
 257  * a actual data structure size giving different compilers
 258  * and systems.  For those data structures we need
 259  * to use the smallest available stream_getX/putX functions
 260  * to encode/decode.
 261  */
 262 struct zapi_route {
 263         u_char type;
 264         u_short instance;
 265
 266         u_int32_t flags;
 267
 268         u_char message;
 269
 270         /*
 271          * This is an enum but we are going to treat it as a uint8_t
 272          * for purpose of encoding/decoding
 273          */
 274         safi_t safi;
 275
 276         struct prefix prefix;
 277         struct prefix_ipv6 src_prefix;
 278
 279         u_int16_t nexthop_num;
 280         struct zapi_nexthop nexthops[MULTIPATH_NUM];
 281
 282         u_char distance;
 283
 284         u_int32_t metric;
 285
 286         route_tag_t tag;
 287
 288         u_int32_t mtu;
 289
 290         vrf_id_t vrf_id;
 291
 292         struct ethaddr rmac;
 293 };
 294
 295 /* Zebra IPv4 route message API. */
 296 struct zapi_ipv4 {
 297         u_char type;
 298         u_short instance;
 299
 300         u_int32_t flags;
 301
 302         u_char message;
 303
 304         safi_t safi;
 305
 306         u_char nexthop_num;
 307         struct in_addr **nexthop;
 308
 309         u_char ifindex_num;
 310         ifindex_t *ifindex;
 311
 312         u_char label_num;
 313         unsigned int *label;
 314
 315         u_char distance;
 316
 317         u_int32_t metric;
 318
 319         route_tag_t tag;
 320
 321         u_int32_t mtu;
 322
 323         vrf_id_t vrf_id;
 324 };
 325
 326 struct zapi_pw {
 327         char ifname[IF_NAMESIZE];
 328         ifindex_t ifindex;
 329         int type;
 330         int af;
 331         union g_addr nexthop;
 332         uint32_t local_label;
 333         uint32_t remote_label;
 334         uint8_t flags;
 335         union pw_protocol_fields data;
 336         uint8_t protocol;
 337 };
 338
 339 struct zapi_pw_status {
 340         char ifname[IF_NAMESIZE];
 341         ifindex_t ifindex;
 342         uint32_t status;
 343 };
 344
 345 enum zapi_route_notify_owner {
 346         ZAPI_ROUTE_FAIL_INSTALL,
 347         ZAPI_ROUTE_BETTER_ADMIN_WON,
 348         ZAPI_ROUTE_INSTALLED,
 349 };
 350
 351 /* Zebra MAC types */
 352 #define ZEBRA_MACIP_TYPE_STICKY                0x01 /* Sticky MAC*/
 353 #define ZEBRA_MACIP_TYPE_GW                    0x02 /* gateway (SVI) mac*/
 354
 355 struct zclient_options {
 356         bool receive_notify;
 357 };
 358
 359 /* Prototypes of zebra client service functions. */
 360 extern struct zclient *zclient_new(struct thread_master *);
 361
 362 #if CONFDATE > 20181101
 363 CPP_NOTICE("zclient_new_notify can take over or zclient_new now");
 364 #endif
 365
 366 extern struct zclient_options zclient_options_default;
 367
 368 extern struct zclient *zclient_new_notify(struct thread_master *m,
 369                                           struct zclient_options *opt);
 370
 371 #define zclient_new(A)                                                         \
 372         zclient_new_notify((A), &zclient_options_default);                     \
 373         CPP_WARN("Please transition to using zclient_new_notify");
 374
 375 extern void zclient_init(struct zclient *, int, u_short,
 376                          struct zebra_privs_t *privs);
 377 extern int zclient_start(struct zclient *);
 378 extern void zclient_stop(struct zclient *);
 379 extern void zclient_reset(struct zclient *);
 380 extern void zclient_free(struct zclient *);
 381
 382 extern int zclient_socket_connect(struct zclient *);
 383
 384 extern u_short *redist_check_instance(struct redist_proto *, u_short);
 385 extern void redist_add_instance(struct redist_proto *, u_short);
 386 extern void redist_del_instance(struct redist_proto *, u_short);
 387
 388 /*
 389  * Send to zebra that the specified vrf is using label to resolve
 390  * itself for L3VPN's.  Repeated calls of this function with
 391  * different labels will cause an effective update of the
 392  * label for lookup.  If you pass in MPLS_LABEL_NONE
 393  * we will cause a delete action and remove this label pop
 394  * operation.
 395  *
 396  * The underlying AF_MPLS doesn't care about afi's
 397  * but we can make the zebra_vrf keep track of what
 398  * we have installed and play some special games
 399  * to get them both installed.
 400  */
 401 extern void zclient_send_vrf_label(struct zclient *zclient, vrf_id_t vrf_id,
 402                                    afi_t afi, mpls_label_t label,
 403                                    enum lsp_types_t ltype);
 404
 405 extern void zclient_send_reg_requests(struct zclient *, vrf_id_t);
 406 extern void zclient_send_dereg_requests(struct zclient *, vrf_id_t);
 407
 408 extern void zclient_send_interface_radv_req(struct zclient *zclient,
 409                                             vrf_id_t vrf_id,
 410                                             struct interface *ifp, int enable,
 411                                             int ra_interval);
 412
 413 /* Send redistribute command to zebra daemon. Do not update zclient state. */
 414 extern int zebra_redistribute_send(int command, struct zclient *, afi_t,
 415                                    int type, u_short instance, vrf_id_t vrf_id);
 416
 417 /* If state has changed, update state and call zebra_redistribute_send. */
 418 extern void zclient_redistribute(int command, struct zclient *, afi_t, int type,
 419                                  u_short instance, vrf_id_t vrf_id);
 420
 421 /* If state has changed, update state and send the command to zebra. */
 422 extern void zclient_redistribute_default(int command, struct zclient *,
 423                                          vrf_id_t vrf_id);
 424
 425 /* Send the message in zclient->obuf to the zebra daemon (or enqueue it).
 426    Returns 0 for success or -1 on an I/O error. */
 427 extern int zclient_send_message(struct zclient *);
 428
 429 /* create header for command, length to be filled in by user later */
 430 extern void zclient_create_header(struct stream *, uint16_t, vrf_id_t);
 431 extern int zclient_read_header(struct stream *s, int sock, u_int16_t *size,
 432                                u_char *marker, u_char *version,
 433                                vrf_id_t *vrf_id, u_int16_t *cmd);
 434
 435 extern void zclient_interface_set_master(struct zclient *client,
 436                                          struct interface *master,
 437                                          struct interface *slave);
 438 extern struct interface *zebra_interface_add_read(struct stream *, vrf_id_t);
 439 extern struct interface *zebra_interface_state_read(struct stream *s, vrf_id_t);
 440 extern struct connected *zebra_interface_address_read(int, struct stream *,
 441                                                       vrf_id_t);
 442 extern struct nbr_connected *
 443 zebra_interface_nbr_address_read(int, struct stream *, vrf_id_t);
 444 extern struct interface *zebra_interface_vrf_update_read(struct stream *s,
 445                                                          vrf_id_t vrf_id,
 446                                                          vrf_id_t *new_vrf_id);
 447 extern void zebra_interface_if_set_value(struct stream *, struct interface *);
 448 extern void zebra_router_id_update_read(struct stream *s, struct prefix *rid);
 449
 450 #if CONFDATE > 20180823
 451 CPP_NOTICE(
 452         "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");
 453 #endif
 454
 455 extern int zapi_ipv4_route(u_char, struct zclient *, struct prefix_ipv4 *,
 456                            struct zapi_ipv4 *) __attribute__((deprecated));
 457
 458 extern struct interface *zebra_interface_link_params_read(struct stream *);
 459 extern size_t zebra_interface_link_params_write(struct stream *,
 460                                                 struct interface *);
 461 extern int lm_label_manager_connect(struct zclient *zclient);
 462 extern int lm_get_label_chunk(struct zclient *zclient, u_char keep,
 463                               uint32_t chunk_size, uint32_t *start,
 464                               uint32_t *end);
 465 extern int lm_release_label_chunk(struct zclient *zclient, uint32_t start,
 466                                   uint32_t end);
 467 extern int zebra_send_pw(struct zclient *zclient, int command,
 468                          struct zapi_pw *pw);
 469 extern void zebra_read_pw_status_update(int command, struct zclient *zclient,
 470                                         zebra_size_t length, vrf_id_t vrf_id,
 471                                         struct zapi_pw_status *pw);
 472
 473 /* IPv6 prefix add and delete function prototype. */
 474
 475 struct zapi_ipv6 {
 476         u_char type;
 477         u_short instance;
 478
 479         u_int32_t flags;
 480
 481         u_char message;
 482
 483         safi_t safi;
 484
 485         u_char nexthop_num;
 486         struct in6_addr **nexthop;
 487
 488         u_char ifindex_num;
 489         ifindex_t *ifindex;
 490
 491         u_char label_num;
 492         unsigned int *label;
 493
 494         u_char distance;
 495
 496         u_int32_t metric;
 497
 498         route_tag_t tag;
 499
 500         u_int32_t mtu;
 501
 502         vrf_id_t vrf_id;
 503 };
 504
 505 extern int zapi_ipv6_route(u_char cmd, struct zclient *zclient,
 506                            struct prefix_ipv6 *p, struct prefix_ipv6 *src_p,
 507                            struct zapi_ipv6 *api) __attribute__((deprecated));
 508 extern int zapi_ipv4_route_ipv6_nexthop(u_char, struct zclient *,
 509                                         struct prefix_ipv4 *,
 510                                         struct zapi_ipv6 *)
 511         __attribute__((deprecated));
 512 extern int zclient_route_send(u_char, struct zclient *, struct zapi_route *);
 513 extern int zclient_send_rnh(struct zclient *zclient, int command,
 514                             struct prefix *p, bool exact_match,
 515                             vrf_id_t vrf_id);
 516 extern int zapi_route_encode(u_char, struct stream *, struct zapi_route *);
 517 extern int zapi_route_decode(struct stream *, struct zapi_route *);
 518 bool zapi_route_notify_decode(struct stream *s, struct prefix *p,
 519                               uint32_t *tableid,
 520                               enum zapi_route_notify_owner *note);
 521 extern struct nexthop *nexthop_from_zapi_nexthop(struct zapi_nexthop *znh);
 522 extern bool zapi_nexthop_update_decode(struct stream *s,
 523                                        struct zapi_route *nhr);
 524
 525 static inline void zapi_route_set_blackhole(struct zapi_route *api,
 526                                             enum blackhole_type bh_type)
 527 {
 528         api->nexthop_num = 1;
 529         api->nexthops[0].type = NEXTHOP_TYPE_BLACKHOLE;
 530         api->nexthops[0].vrf_id = VRF_DEFAULT;
 531         api->nexthops[0].bh_type = bh_type;
 532         SET_FLAG(api->message, ZAPI_MESSAGE_NEXTHOP);
 533 };
 534
 535
 536 #endif /* _ZEBRA_ZCLIENT_H */