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 (*interface_add) (int, struct zclient *, uint16_t, vrf_id_t);
  91   int (*interface_delete) (int, struct zclient *, uint16_t, vrf_id_t);
  92   int (*interface_up) (int, struct zclient *, uint16_t, vrf_id_t);
  93   int (*interface_down) (int, struct zclient *, uint16_t, vrf_id_t);
  94   int (*interface_address_add) (int, struct zclient *, uint16_t, vrf_id_t);
  95   int (*interface_address_delete) (int, struct zclient *, uint16_t, vrf_id_t);
  96   int (*interface_link_params) (int, struct zclient *, uint16_t);
  97   int (*interface_bfd_dest_update) (int, struct zclient *, uint16_t, vrf_id_t);
  98   int (*interface_nbr_address_add) (int, struct zclient *, uint16_t, vrf_id_t);
  99   int (*interface_nbr_address_delete) (int, struct zclient *, uint16_t, vrf_id_t);
 100   int (*interface_vrf_update) (int, struct zclient *, uint16_t, vrf_id_t);
 101   int (*nexthop_update) (int, struct zclient *, uint16_t, vrf_id_t);
 102   int (*import_check_update) (int, struct zclient *, uint16_t, vrf_id_t);
 103   int (*bfd_dest_replay) (int, struct zclient *, uint16_t, vrf_id_t);
 104   int (*redistribute_route_ipv4_add) (int, struct zclient *, uint16_t, vrf_id_t);
 105   int (*redistribute_route_ipv4_del) (int, struct zclient *, uint16_t, vrf_id_t);
 106   int (*redistribute_route_ipv6_add) (int, struct zclient *, uint16_t, vrf_id_t);
 107   int (*redistribute_route_ipv6_del) (int, struct zclient *, uint16_t, vrf_id_t);
 108 };
 109
 110 /* Zebra API message flag. */
 111 #define ZAPI_MESSAGE_NEXTHOP  0x01
 112 #define ZAPI_MESSAGE_IFINDEX  0x02
 113 #define ZAPI_MESSAGE_DISTANCE 0x04
 114 #define ZAPI_MESSAGE_METRIC   0x08
 115 #define ZAPI_MESSAGE_TAG      0x10
 116 #define ZAPI_MESSAGE_MTU      0x20
 117
 118 /* Zserv protocol message header */
 119 struct zserv_header
 120 {
 121   uint16_t length;
 122   uint8_t marker;       /* corresponds to command field in old zserv
 123                          * always set to 255 in new zserv.
 124                          */
 125   uint8_t version;
 126 #define ZSERV_VERSION   3
 127   vrf_id_t vrf_id;
 128   uint16_t command;
 129 };
 130
 131 /* Zebra IPv4 route message API. */
 132 struct zapi_ipv4
 133 {
 134   u_char type;
 135   u_short instance;
 136
 137   u_int32_t flags;
 138
 139   u_char message;
 140
 141   safi_t safi;
 142
 143   u_char nexthop_num;
 144   struct in_addr **nexthop;
 145
 146   u_char ifindex_num;
 147   ifindex_t *ifindex;
 148
 149   u_char distance;
 150
 151   u_int32_t metric;
 152
 153   route_tag_t tag;
 154
 155   u_int32_t mtu;
 156
 157   vrf_id_t vrf_id;
 158 };
 159
 160 /* Prototypes of zebra client service functions. */
 161 extern struct zclient *zclient_new (struct thread_master *);
 162 extern void zclient_init (struct zclient *, int, u_short);
 163 extern int zclient_start (struct zclient *);
 164 extern void zclient_stop (struct zclient *);
 165 extern void zclient_reset (struct zclient *);
 166 extern void zclient_free (struct zclient *);
 167
 168 extern int  zclient_socket_connect (struct zclient *);
 169 extern void zclient_serv_path_set  (char *path);
 170 extern const char *zclient_serv_path_get (void);
 171
 172 extern u_short *redist_check_instance (struct redist_proto *, u_short);
 173 extern void redist_add_instance (struct redist_proto *, u_short);
 174 extern void redist_del_instance (struct redist_proto *, u_short);
 175
 176 extern void zclient_send_reg_requests (struct zclient *, vrf_id_t);
 177 extern void zclient_send_dereg_requests (struct zclient *, vrf_id_t);
 178
 179 extern void zclient_send_interface_radv_req (struct zclient *zclient, vrf_id_t vrf_id,
 180                                  struct interface *ifp, int enable, int ra_interval);
 181
 182 /* Send redistribute command to zebra daemon. Do not update zclient state. */
 183 extern int zebra_redistribute_send (int command, struct zclient *, afi_t, int type, u_short instance, vrf_id_t vrf_id);
 184
 185 /* If state has changed, update state and call zebra_redistribute_send. */
 186 extern void zclient_redistribute (int command, struct zclient *, afi_t, int type,
 187                                   u_short instance, vrf_id_t vrf_id);
 188
 189 /* If state has changed, update state and send the command to zebra. */
 190 extern void zclient_redistribute_default (int command, struct zclient *,
 191     vrf_id_t vrf_id);
 192
 193 /* Send the message in zclient->obuf to the zebra daemon (or enqueue it).
 194    Returns 0 for success or -1 on an I/O error. */
 195 extern int zclient_send_message(struct zclient *);
 196
 197 /* create header for command, length to be filled in by user later */
 198 extern void zclient_create_header (struct stream *, uint16_t, vrf_id_t);
 199 extern int zclient_read_header (struct stream *s, int sock, u_int16_t *size,
 200                                 u_char *marker, u_char *version,
 201                                 vrf_id_t *vrf_id, u_int16_t *cmd);
 202
 203 extern struct interface *zebra_interface_add_read (struct stream *, vrf_id_t);
 204 extern struct interface *zebra_interface_state_read (struct stream *s, vrf_id_t);
 205 extern struct connected *zebra_interface_address_read (int, struct stream *, vrf_id_t);
 206 extern struct nbr_connected *zebra_interface_nbr_address_read (int, struct stream *, vrf_id_t);
 207 extern struct interface * zebra_interface_vrf_update_read (struct stream *s, vrf_id_t vrf_id,
 208                             vrf_id_t *new_vrf_id);
 209 extern void zebra_interface_if_set_value (struct stream *, struct interface *);
 210 extern void zebra_router_id_update_read (struct stream *s, struct prefix *rid);
 211 extern int zapi_ipv4_route (u_char, struct zclient *, struct prefix_ipv4 *,
 212                             struct zapi_ipv4 *);
 213
 214 extern struct interface *zebra_interface_link_params_read (struct stream *);
 215 extern size_t zebra_interface_link_params_write (struct stream *,
 216                                                  struct interface *);
 217 #ifdef HAVE_IPV6
 218 /* IPv6 prefix add and delete function prototype. */
 219
 220 struct zapi_ipv6
 221 {
 222   u_char type;
 223   u_short instance;
 224
 225   u_int32_t flags;
 226
 227   u_char message;
 228
 229   safi_t safi;
 230
 231   u_char nexthop_num;
 232   struct in6_addr **nexthop;
 233
 234   u_char ifindex_num;
 235   ifindex_t *ifindex;
 236
 237   u_char distance;
 238
 239   u_int32_t metric;
 240
 241   route_tag_t tag;
 242
 243   u_int32_t mtu;
 244
 245   vrf_id_t vrf_id;
 246 };
 247
 248 extern int zapi_ipv6_route (u_char cmd, struct zclient *zclient,
 249                      struct prefix_ipv6 *p, struct zapi_ipv6 *api);
 250 extern int zapi_ipv4_route_ipv6_nexthop (u_char, struct zclient *,
 251                                          struct prefix_ipv4 *, struct zapi_ipv6 *);
 252 #endif /* HAVE_IPV6 */
 253
 254 #endif /* _ZEBRA_ZCLIENT_H */