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