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