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 struct redist_proto
  41 {
  42   u_char enabled;
  43   struct list *instances;
  44 };
  45
  46 /* Structure for the zebra client. */
  47 struct zclient
  48 {
  49   /* The thread master we schedule ourselves on */
  50   struct thread_master *master;
  51
  52   /* Socket to zebra daemon. */
  53   int sock;
  54
  55   /* Flag of communication to zebra is enabled or not.  Default is on.
  56      This flag is disabled by `no router zebra' statement. */
  57   int enable;
  58
  59   /* Connection failure count. */
  60   int fail;
  61
  62   /* Input buffer for zebra message. */
  63   struct stream *ibuf;
  64
  65   /* Output buffer for zebra message. */
  66   struct stream *obuf;
  67
  68   /* Buffer of data waiting to be written to zebra. */
  69   struct buffer *wb;
  70
  71   /* Read and connect thread. */
  72   struct thread *t_read;
  73   struct thread *t_connect;
  74
  75   /* Thread to write buffered data to zebra. */
  76   struct thread *t_write;
  77
  78   /* Redistribute information. */
  79   u_char redist_default; /* clients protocol */
  80   u_short instance;
  81   struct redist_proto mi_redist[AFI_MAX][ZEBRA_ROUTE_MAX];
  82   vrf_bitmap_t redist[AFI_MAX][ZEBRA_ROUTE_MAX];
  83
  84   /* Redistribute defauilt. */
  85   vrf_bitmap_t default_information;
  86
  87   /* Pointer to the callback functions. */
  88   void (*zebra_connected) (struct zclient *);
  89   int (*router_id_update) (int, struct zclient *, uint16_t, vrf_id_t);
  90   int (*vrf_add) (int, struct zclient *, uint16_t, vrf_id_t);
  91   int (*vrf_delete) (int, struct zclient *, uint16_t, vrf_id_t);
  92   int (*interface_add) (int, struct zclient *, uint16_t, vrf_id_t);
  93   int (*interface_delete) (int, struct zclient *, uint16_t, vrf_id_t);
  94   int (*interface_up) (int, struct zclient *, uint16_t, vrf_id_t);
  95   int (*interface_down) (int, struct zclient *, uint16_t, vrf_id_t);
  96   int (*interface_address_add) (int, struct zclient *, uint16_t, vrf_id_t);
  97   int (*interface_address_delete) (int, struct zclient *, uint16_t, vrf_id_t);
  98   int (*interface_bfd_dest_update) (int, struct zclient *, uint16_t, vrf_id_t);
  99   int (*interface_nbr_address_add) (int, struct zclient *, uint16_t, vrf_id_t);
 100   int (*interface_nbr_address_delete) (int, struct zclient *, uint16_t, vrf_id_t);
 101   int (*interface_vrf_update) (int, struct zclient *, uint16_t, vrf_id_t);
 102   int (*ipv4_route_add) (int, struct zclient *, uint16_t, vrf_id_t);
 103   int (*ipv4_route_delete) (int, struct zclient *, uint16_t, vrf_id_t);
 104   int (*ipv6_route_add) (int, struct zclient *, uint16_t, vrf_id_t);
 105   int (*ipv6_route_delete) (int, struct zclient *, uint16_t, vrf_id_t);
 106   int (*nexthop_update) (int, struct zclient *, uint16_t, vrf_id_t);
 107   int (*import_check_update) (int, struct zclient *, uint16_t, vrf_id_t);
 108   int (*bfd_dest_replay) (int, struct zclient *, uint16_t, vrf_id_t);
 109   int (*redistribute_route_ipv4_add) (int, struct zclient *, uint16_t, vrf_id_t);
 110   int (*redistribute_route_ipv4_del) (int, struct zclient *, uint16_t, vrf_id_t);
 111   int (*redistribute_route_ipv6_add) (int, struct zclient *, uint16_t, vrf_id_t);
 112   int (*redistribute_route_ipv6_del) (int, struct zclient *, uint16_t, vrf_id_t);
 113 };
 114
 115 /* Zebra API message flag. */
 116 #define ZAPI_MESSAGE_NEXTHOP  0x01
 117 #define ZAPI_MESSAGE_IFINDEX  0x02
 118 #define ZAPI_MESSAGE_DISTANCE 0x04
 119 #define ZAPI_MESSAGE_METRIC   0x08
 120 #define ZAPI_MESSAGE_TAG      0x10
 121
 122 /* Zserv protocol message header */
 123 struct zserv_header
 124 {
 125   uint16_t length;
 126   uint8_t marker;       /* corresponds to command field in old zserv
 127                          * always set to 255 in new zserv.
 128                          */
 129   uint8_t version;
 130 #define ZSERV_VERSION   3
 131   vrf_id_t vrf_id;
 132   uint16_t command;
 133 };
 134
 135 /* Zebra IPv4 route message API. */
 136 struct zapi_ipv4
 137 {
 138   u_char type;
 139   u_short instance;
 140
 141   u_char flags;
 142
 143   u_char message;
 144
 145   safi_t safi;
 146
 147   u_char nexthop_num;
 148   struct in_addr **nexthop;
 149
 150   u_char ifindex_num;
 151   unsigned int *ifindex;
 152
 153   u_char distance;
 154
 155   u_int32_t metric;
 156
 157   u_short tag;
 158
 159   vrf_id_t vrf_id;
 160 };
 161
 162 /* Prototypes of zebra client service functions. */
 163 extern struct zclient *zclient_new (struct thread_master *);
 164 extern void zclient_init (struct zclient *, int, u_short);
 165 extern int zclient_start (struct zclient *);
 166 extern void zclient_stop (struct zclient *);
 167 extern void zclient_reset (struct zclient *);
 168 extern void zclient_free (struct zclient *);
 169
 170 extern int  zclient_socket_connect (struct zclient *);
 171 extern void zclient_serv_path_set  (char *path);
 172
 173 extern int redist_check_instance (struct redist_proto *, u_short);
 174 extern void redist_add_instance (struct redist_proto *, u_short);
 175 extern void redist_del_instance (struct redist_proto *, u_short);
 176
 177 extern void zclient_send_reg_requests (struct zclient *, vrf_id_t);
 178 extern void zclient_send_dereg_requests (struct zclient *, vrf_id_t);
 179
 180 /* Send redistribute command to zebra daemon. Do not update zclient state. */
 181 extern int zebra_redistribute_send (int command, struct zclient *, afi_t, int type, u_short instance, vrf_id_t vrf_id);
 182
 183 /* If state has changed, update state and call zebra_redistribute_send. */
 184 extern void zclient_redistribute (int command, struct zclient *, afi_t, int type,
 185                                   u_short instance, vrf_id_t vrf_id);
 186
 187 /* If state has changed, update state and send the command to zebra. */
 188 extern void zclient_redistribute_default (int command, struct zclient *,
 189     vrf_id_t vrf_id);
 190
 191 /* Send the message in zclient->obuf to the zebra daemon (or enqueue it).
 192    Returns 0 for success or -1 on an I/O error. */
 193 extern int zclient_send_message(struct zclient *);
 194
 195 /* create header for command, length to be filled in by user later */
 196 extern void zclient_create_header (struct stream *, uint16_t, vrf_id_t);
 197
 198 extern struct vrf *zebra_vrf_add_read (struct stream *, vrf_id_t);
 199 extern struct vrf *zebra_vrf_state_read (struct stream *s, vrf_id_t);
 200 extern struct interface *zebra_interface_add_read (struct stream *, vrf_id_t);
 201 extern struct interface *zebra_interface_state_read (struct stream *s, vrf_id_t);
 202 extern struct connected *zebra_interface_address_read (int, struct stream *, vrf_id_t);
 203 extern struct nbr_connected *zebra_interface_nbr_address_read (int, struct stream *, vrf_id_t);
 204 extern struct interface * zebra_interface_vrf_update_read (struct stream *s, vrf_id_t vrf_id,
 205                             vrf_id_t *new_vrf_id);
 206 extern void zebra_interface_if_set_value (struct stream *, struct interface *);
 207 extern void zebra_router_id_update_read (struct stream *s, struct prefix *rid);
 208 extern int zapi_ipv4_route (u_char, struct zclient *, struct prefix_ipv4 *,
 209                             struct zapi_ipv4 *);
 210
 211 #ifdef HAVE_IPV6
 212 /* IPv6 prefix add and delete function prototype. */
 213
 214 struct zapi_ipv6
 215 {
 216   u_char type;
 217   u_short instance;
 218
 219   u_char flags;
 220
 221   u_char message;
 222
 223   safi_t safi;
 224
 225   u_char nexthop_num;
 226   struct in6_addr **nexthop;
 227
 228   u_char ifindex_num;
 229   unsigned int *ifindex;
 230
 231   u_char distance;
 232
 233   u_int32_t metric;
 234
 235   u_short tag;
 236
 237   vrf_id_t vrf_id;
 238 };
 239
 240 extern int zapi_ipv6_route (u_char cmd, struct zclient *zclient,
 241                      struct prefix_ipv6 *p, struct zapi_ipv6 *api);
 242 extern int zapi_ipv4_route_ipv6_nexthop (u_char, struct zclient *,
 243                                          struct prefix_ipv4 *, struct zapi_ipv6 *);
 244 #endif /* HAVE_IPV6 */
 245
 246 #endif /* _ZEBRA_ZCLIENT_H */