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