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