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