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