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_IPV4_ROUTE_ADD,
  65         ZEBRA_IPV4_ROUTE_DELETE,
  66         ZEBRA_IPV6_ROUTE_ADD,
  67         ZEBRA_IPV6_ROUTE_DELETE,
  68         ZEBRA_REDISTRIBUTE_ADD,
  69         ZEBRA_REDISTRIBUTE_DELETE,
  70         ZEBRA_REDISTRIBUTE_DEFAULT_ADD,
  71         ZEBRA_REDISTRIBUTE_DEFAULT_DELETE,
  72         ZEBRA_ROUTER_ID_ADD,
  73         ZEBRA_ROUTER_ID_DELETE,
  74         ZEBRA_ROUTER_ID_UPDATE,
  75         ZEBRA_HELLO,
  76         ZEBRA_NEXTHOP_REGISTER,
  77         ZEBRA_NEXTHOP_UNREGISTER,
  78         ZEBRA_NEXTHOP_UPDATE,
  79         ZEBRA_INTERFACE_NBR_ADDRESS_ADD,
  80         ZEBRA_INTERFACE_NBR_ADDRESS_DELETE,
  81         ZEBRA_INTERFACE_BFD_DEST_UPDATE,
  82         ZEBRA_IMPORT_ROUTE_REGISTER,
  83         ZEBRA_IMPORT_ROUTE_UNREGISTER,
  84         ZEBRA_IMPORT_CHECK_UPDATE,
  85         ZEBRA_IPV4_ROUTE_IPV6_NEXTHOP_ADD,
  86         ZEBRA_BFD_DEST_REGISTER,
  87         ZEBRA_BFD_DEST_DEREGISTER,
  88         ZEBRA_BFD_DEST_UPDATE,
  89         ZEBRA_BFD_DEST_REPLAY,
  90         ZEBRA_REDISTRIBUTE_ROUTE_ADD,
  91         ZEBRA_REDISTRIBUTE_ROUTE_DEL,
  92         ZEBRA_VRF_UNREGISTER,
  93         ZEBRA_VRF_ADD,
  94         ZEBRA_VRF_DELETE,
  95         ZEBRA_INTERFACE_VRF_UPDATE,
  96         ZEBRA_BFD_CLIENT_REGISTER,
  97         ZEBRA_INTERFACE_ENABLE_RADV,
  98         ZEBRA_INTERFACE_DISABLE_RADV,
  99         ZEBRA_IPV4_NEXTHOP_LOOKUP_MRIB,
 100         ZEBRA_INTERFACE_LINK_PARAMS,
 101         ZEBRA_MPLS_LABELS_ADD,
 102         ZEBRA_MPLS_LABELS_DELETE,
 103         ZEBRA_IPMR_ROUTE_STATS,
 104         ZEBRA_LABEL_MANAGER_CONNECT,
 105         ZEBRA_GET_LABEL_CHUNK,
 106         ZEBRA_RELEASE_LABEL_CHUNK,
 107         ZEBRA_FEC_REGISTER,
 108         ZEBRA_FEC_UNREGISTER,
 109         ZEBRA_FEC_UPDATE,
 110         ZEBRA_ADVERTISE_DEFAULT_GW,
 111         ZEBRA_ADVERTISE_ALL_VNI,
 112         ZEBRA_VNI_ADD,
 113         ZEBRA_VNI_DEL,
 114         ZEBRA_REMOTE_VTEP_ADD,
 115         ZEBRA_REMOTE_VTEP_DEL,
 116         ZEBRA_MACIP_ADD,
 117         ZEBRA_MACIP_DEL,
 118         ZEBRA_REMOTE_MACIP_ADD,
 119         ZEBRA_REMOTE_MACIP_DEL,
 120         ZEBRA_PW_ADD,
 121         ZEBRA_PW_DELETE,
 122         ZEBRA_PW_SET,
 123         ZEBRA_PW_UNSET,
 124         ZEBRA_PW_STATUS_UPDATE,
 125 } zebra_message_types_t;
 126
 127 struct redist_proto {
 128         u_char enabled;
 129         struct list *instances;
 130 };
 131
 132 /* Structure for the zebra client. */
 133 struct zclient {
 134         /* The thread master we schedule ourselves on */
 135         struct thread_master *master;
 136
 137         /* Socket to zebra daemon. */
 138         int sock;
 139
 140         /* Connection failure count. */
 141         int fail;
 142
 143         /* Input buffer for zebra message. */
 144         struct stream *ibuf;
 145
 146         /* Output buffer for zebra message. */
 147         struct stream *obuf;
 148
 149         /* Buffer of data waiting to be written to zebra. */
 150         struct buffer *wb;
 151
 152         /* Read and connect thread. */
 153         struct thread *t_read;
 154         struct thread *t_connect;
 155
 156         /* Thread to write buffered data to zebra. */
 157         struct thread *t_write;
 158
 159         /* Redistribute information. */
 160         u_char redist_default; /* clients protocol */
 161         u_short instance;
 162         struct redist_proto mi_redist[AFI_MAX][ZEBRA_ROUTE_MAX];
 163         vrf_bitmap_t redist[AFI_MAX][ZEBRA_ROUTE_MAX];
 164
 165         /* Redistribute defauilt. */
 166         vrf_bitmap_t default_information;
 167
 168         /* Pointer to the callback functions. */
 169         void (*zebra_connected)(struct zclient *);
 170         int (*router_id_update)(int, struct zclient *, uint16_t, vrf_id_t);
 171         int (*interface_add)(int, struct zclient *, uint16_t, vrf_id_t);
 172         int (*interface_delete)(int, struct zclient *, uint16_t, vrf_id_t);
 173         int (*interface_up)(int, struct zclient *, uint16_t, vrf_id_t);
 174         int (*interface_down)(int, struct zclient *, uint16_t, vrf_id_t);
 175         int (*interface_address_add)(int, struct zclient *, uint16_t, vrf_id_t);
 176         int (*interface_address_delete)(int, struct zclient *, uint16_t,
 177                                         vrf_id_t);
 178         int (*interface_link_params)(int, struct zclient *, uint16_t);
 179         int (*interface_bfd_dest_update)(int, struct zclient *, uint16_t,
 180                                          vrf_id_t);
 181         int (*interface_nbr_address_add)(int, struct zclient *, uint16_t,
 182                                          vrf_id_t);
 183         int (*interface_nbr_address_delete)(int, struct zclient *, uint16_t,
 184                                             vrf_id_t);
 185         int (*interface_vrf_update)(int, struct zclient *, uint16_t, vrf_id_t);
 186         int (*nexthop_update)(int, struct zclient *, uint16_t, vrf_id_t);
 187         int (*import_check_update)(int, struct zclient *, uint16_t, vrf_id_t);
 188         int (*bfd_dest_replay)(int, struct zclient *, uint16_t, vrf_id_t);
 189         int (*redistribute_route_add)(int, struct zclient *, uint16_t,
 190                                       vrf_id_t);
 191         int (*redistribute_route_del)(int, struct zclient *, uint16_t,
 192                                       vrf_id_t);
 193         int (*fec_update)(int, struct zclient *, uint16_t);
 194         int (*local_vni_add)(int, struct zclient *, uint16_t, vrf_id_t);
 195         int (*local_vni_del)(int, struct zclient *, uint16_t, vrf_id_t);
 196         int (*local_macip_add)(int, struct zclient *, uint16_t, vrf_id_t);
 197         int (*local_macip_del)(int, struct zclient *, uint16_t, vrf_id_t);
 198         int (*pw_status_update)(int, struct zclient *, uint16_t, vrf_id_t);
 199 };
 200
 201 /* Zebra API message flag. */
 202 #define ZAPI_MESSAGE_NEXTHOP  0x01
 203 #define ZAPI_MESSAGE_DISTANCE 0x02
 204 #define ZAPI_MESSAGE_METRIC   0x04
 205 #define ZAPI_MESSAGE_TAG      0x08
 206 #define ZAPI_MESSAGE_MTU      0x10
 207 #define ZAPI_MESSAGE_SRCPFX   0x20
 208 #define ZAPI_MESSAGE_LABEL    0x40
 209
 210 /* Zserv protocol message header */
 211 struct zserv_header {
 212         uint16_t length;
 213         uint8_t marker; /* corresponds to command field in old zserv
 214                          * always set to 255 in new zserv.
 215                          */
 216         uint8_t version;
 217 #define ZSERV_VERSION   4
 218         vrf_id_t vrf_id;
 219         uint16_t command;
 220 };
 221
 222 struct zapi_nexthop {
 223         enum nexthop_types_t type;
 224         ifindex_t ifindex;
 225         union {
 226                 union g_addr gate;
 227                 enum blackhole_type bh_type;
 228         };
 229
 230         /* MPLS labels for BGP-LU or Segment Routing */
 231         uint8_t label_num;
 232         mpls_label_t labels[MPLS_MAX_LABELS];
 233 };
 234
 235 struct zapi_route {
 236         u_char type;
 237         u_short instance;
 238
 239         u_int32_t flags;
 240
 241         u_char message;
 242
 243         safi_t safi;
 244
 245         struct prefix prefix;
 246         struct prefix_ipv6 src_prefix;
 247
 248         u_int16_t nexthop_num;
 249         struct zapi_nexthop nexthops[MULTIPATH_NUM];
 250
 251         u_char distance;
 252
 253         u_int32_t metric;
 254
 255         route_tag_t tag;
 256
 257         u_int32_t mtu;
 258
 259         vrf_id_t vrf_id;
 260 };
 261
 262 /* Zebra IPv4 route message API. */
 263 struct zapi_ipv4 {
 264         u_char type;
 265         u_short instance;
 266
 267         u_int32_t flags;
 268
 269         u_char message;
 270
 271         safi_t safi;
 272
 273         u_char nexthop_num;
 274         struct in_addr **nexthop;
 275
 276         u_char ifindex_num;
 277         ifindex_t *ifindex;
 278
 279         u_char label_num;
 280         unsigned int *label;
 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
 293 struct zapi_pw {
 294         char ifname[IF_NAMESIZE];
 295         ifindex_t ifindex;
 296         int type;
 297         int af;
 298         union g_addr nexthop;
 299         uint32_t local_label;
 300         uint32_t remote_label;
 301         uint8_t flags;
 302         union pw_protocol_fields data;
 303         uint8_t protocol;
 304 };
 305
 306 struct zapi_pw_status {
 307         char ifname[IF_NAMESIZE];
 308         ifindex_t ifindex;
 309         uint32_t status;
 310 };
 311
 312 /* Zebra MAC types */
 313 #define ZEBRA_MAC_TYPE_STICKY                0x01 /* Sticky MAC*/
 314 #define ZEBRA_MAC_TYPE_GW                    0x02 /* gateway (SVI) mac*/
 315
 316 /* Prototypes of zebra client service functions. */
 317 extern struct zclient *zclient_new(struct thread_master *);
 318 extern void zclient_init(struct zclient *, int, u_short);
 319 extern int zclient_start(struct zclient *);
 320 extern void zclient_stop(struct zclient *);
 321 extern void zclient_reset(struct zclient *);
 322 extern void zclient_free(struct zclient *);
 323
 324 extern int zclient_socket_connect(struct zclient *);
 325
 326 extern u_short *redist_check_instance(struct redist_proto *, u_short);
 327 extern void redist_add_instance(struct redist_proto *, u_short);
 328 extern void redist_del_instance(struct redist_proto *, u_short);
 329
 330 extern void zclient_send_reg_requests(struct zclient *, vrf_id_t);
 331 extern void zclient_send_dereg_requests(struct zclient *, vrf_id_t);
 332
 333 extern void zclient_send_interface_radv_req(struct zclient *zclient,
 334                                             vrf_id_t vrf_id,
 335                                             struct interface *ifp, int enable,
 336                                             int ra_interval);
 337
 338 /* Send redistribute command to zebra daemon. Do not update zclient state. */
 339 extern int zebra_redistribute_send(int command, struct zclient *, afi_t,
 340                                    int type, u_short instance, vrf_id_t vrf_id);
 341
 342 /* If state has changed, update state and call zebra_redistribute_send. */
 343 extern void zclient_redistribute(int command, struct zclient *, afi_t, int type,
 344                                  u_short instance, vrf_id_t vrf_id);
 345
 346 /* If state has changed, update state and send the command to zebra. */
 347 extern void zclient_redistribute_default(int command, struct zclient *,
 348                                          vrf_id_t vrf_id);
 349
 350 /* Send the message in zclient->obuf to the zebra daemon (or enqueue it).
 351    Returns 0 for success or -1 on an I/O error. */
 352 extern int zclient_send_message(struct zclient *);
 353
 354 /* create header for command, length to be filled in by user later */
 355 extern void zclient_create_header(struct stream *, uint16_t, vrf_id_t);
 356 extern int zclient_read_header(struct stream *s, int sock, u_int16_t *size,
 357                                u_char *marker, u_char *version,
 358                                vrf_id_t *vrf_id, u_int16_t *cmd);
 359
 360 extern void zclient_interface_set_master(struct zclient *client,
 361                                          struct interface *master,
 362                                          struct interface *slave);
 363 extern struct interface *zebra_interface_add_read(struct stream *, vrf_id_t);
 364 extern struct interface *zebra_interface_state_read(struct stream *s, vrf_id_t);
 365 extern struct connected *zebra_interface_address_read(int, struct stream *,
 366                                                       vrf_id_t);
 367 extern struct nbr_connected *
 368 zebra_interface_nbr_address_read(int, struct stream *, vrf_id_t);
 369 extern struct interface *zebra_interface_vrf_update_read(struct stream *s,
 370                                                          vrf_id_t vrf_id,
 371                                                          vrf_id_t *new_vrf_id);
 372 extern void zebra_interface_if_set_value(struct stream *, struct interface *);
 373 extern void zebra_router_id_update_read(struct stream *s, struct prefix *rid);
 374 extern int zapi_ipv4_route(u_char, struct zclient *, struct prefix_ipv4 *,
 375                            struct zapi_ipv4 *) __attribute__((deprecated));
 376
 377 extern struct interface *zebra_interface_link_params_read(struct stream *);
 378 extern size_t zebra_interface_link_params_write(struct stream *,
 379                                                 struct interface *);
 380 extern int lm_label_manager_connect(struct zclient *zclient);
 381 extern int lm_get_label_chunk(struct zclient *zclient, u_char keep,
 382                               uint32_t chunk_size, uint32_t *start,
 383                               uint32_t *end);
 384 extern int lm_release_label_chunk(struct zclient *zclient, uint32_t start,
 385                                   uint32_t end);
 386 extern int zebra_send_pw(struct zclient *zclient, int command,
 387                          struct zapi_pw *pw);
 388 extern void zebra_read_pw_status_update(int command, struct zclient *zclient,
 389                                         zebra_size_t length, vrf_id_t vrf_id,
 390                                         struct zapi_pw_status *pw);
 391
 392 /* IPv6 prefix add and delete function prototype. */
 393
 394 struct zapi_ipv6 {
 395         u_char type;
 396         u_short instance;
 397
 398         u_int32_t flags;
 399
 400         u_char message;
 401
 402         safi_t safi;
 403
 404         u_char nexthop_num;
 405         struct in6_addr **nexthop;
 406
 407         u_char ifindex_num;
 408         ifindex_t *ifindex;
 409
 410         u_char label_num;
 411         unsigned int *label;
 412
 413         u_char distance;
 414
 415         u_int32_t metric;
 416
 417         route_tag_t tag;
 418
 419         u_int32_t mtu;
 420
 421         vrf_id_t vrf_id;
 422 };
 423
 424 extern int zapi_ipv6_route(u_char cmd, struct zclient *zclient,
 425                            struct prefix_ipv6 *p, struct prefix_ipv6 *src_p,
 426                            struct zapi_ipv6 *api) __attribute__((deprecated));
 427 extern int zapi_ipv4_route_ipv6_nexthop(u_char, struct zclient *,
 428                                         struct prefix_ipv4 *,
 429                                         struct zapi_ipv6 *)
 430         __attribute__((deprecated));
 431 extern int zclient_route_send(u_char, struct zclient *, struct zapi_route *);
 432 extern int zapi_route_encode(u_char, struct stream *, struct zapi_route *);
 433 extern int zapi_route_decode(struct stream *, struct zapi_route *);
 434
 435 static inline void zapi_route_set_blackhole(struct zapi_route *api,
 436                                      enum blackhole_type bh_type)
 437 {
 438         api->nexthop_num = 1;
 439         api->nexthops[0].type = NEXTHOP_TYPE_BLACKHOLE;
 440         api->nexthops[0].bh_type = bh_type;
 441         SET_FLAG(api->message, ZAPI_MESSAGE_NEXTHOP);
 442 };
 443
 444
 445 #endif /* _ZEBRA_ZCLIENT_H */