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