]> git.proxmox.com Git - mirror_frr.git/blame - lib/zclient.h
zebra: Fix compiler warnings
[mirror_frr.git] / lib / zclient.h
CommitLineData
718e3744 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.
896014f4 10 *
718e3744 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.
896014f4
DL
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
718e3744 19 */
20
21#ifndef _ZEBRA_ZCLIENT_H
22#define _ZEBRA_ZCLIENT_H
23
74489921 24/* For struct zapi_route. */
5734509c
PJ
25#include "prefix.h"
26
718e3744 27/* For struct interface and struct connected. */
28#include "if.h"
29
7076bb2f
FL
30/* For vrf_bitmap_t. */
31#include "vrf.h"
32
6833ae01 33/* For union g_addr */
34#include "nexthop.h"
35
36/* For union pw_protocol_fields */
37#include "pw.h"
38
718e3744 39/* For input/output buffer to zebra. */
40#define ZEBRA_MAX_PACKET_SIZ 4096
41
42/* Zebra header size. */
7076bb2f 43#define ZEBRA_HEADER_SIZE 8
718e3744 44
689f5a8c
DL
45/* special socket path name to use TCP
46 * @ is used as first character because that's abstract socket names on Linux
47 */
48#define ZAPI_TCP_PATHNAME "@tcp"
49
50extern struct sockaddr_storage zclient_addr;
51extern socklen_t zclient_addr_len;
52
8613585e
DS
53/* Zebra message types. */
54typedef enum {
d62a17ae 55 ZEBRA_INTERFACE_ADD,
56 ZEBRA_INTERFACE_DELETE,
57 ZEBRA_INTERFACE_ADDRESS_ADD,
58 ZEBRA_INTERFACE_ADDRESS_DELETE,
59 ZEBRA_INTERFACE_UP,
60 ZEBRA_INTERFACE_DOWN,
e0ae31b8 61 ZEBRA_INTERFACE_SET_MASTER,
0e51b4a3
RW
62 ZEBRA_ROUTE_ADD,
63 ZEBRA_ROUTE_DELETE,
d62a17ae 64 ZEBRA_IPV4_ROUTE_ADD,
65 ZEBRA_IPV4_ROUTE_DELETE,
66 ZEBRA_IPV6_ROUTE_ADD,
67 ZEBRA_IPV6_ROUTE_DELETE,
68 ZEBRA_REDISTRIBUTE_ADD,
69 ZEBRA_REDISTRIBUTE_DELETE,
70 ZEBRA_REDISTRIBUTE_DEFAULT_ADD,
71 ZEBRA_REDISTRIBUTE_DEFAULT_DELETE,
72 ZEBRA_ROUTER_ID_ADD,
73 ZEBRA_ROUTER_ID_DELETE,
74 ZEBRA_ROUTER_ID_UPDATE,
75 ZEBRA_HELLO,
76 ZEBRA_NEXTHOP_REGISTER,
77 ZEBRA_NEXTHOP_UNREGISTER,
78 ZEBRA_NEXTHOP_UPDATE,
79 ZEBRA_INTERFACE_NBR_ADDRESS_ADD,
80 ZEBRA_INTERFACE_NBR_ADDRESS_DELETE,
81 ZEBRA_INTERFACE_BFD_DEST_UPDATE,
82 ZEBRA_IMPORT_ROUTE_REGISTER,
83 ZEBRA_IMPORT_ROUTE_UNREGISTER,
84 ZEBRA_IMPORT_CHECK_UPDATE,
85 ZEBRA_IPV4_ROUTE_IPV6_NEXTHOP_ADD,
86 ZEBRA_BFD_DEST_REGISTER,
87 ZEBRA_BFD_DEST_DEREGISTER,
88 ZEBRA_BFD_DEST_UPDATE,
89 ZEBRA_BFD_DEST_REPLAY,
74489921
RW
90 ZEBRA_REDISTRIBUTE_ROUTE_ADD,
91 ZEBRA_REDISTRIBUTE_ROUTE_DEL,
d62a17ae 92 ZEBRA_VRF_UNREGISTER,
93 ZEBRA_VRF_ADD,
94 ZEBRA_VRF_DELETE,
95 ZEBRA_INTERFACE_VRF_UPDATE,
96 ZEBRA_BFD_CLIENT_REGISTER,
97 ZEBRA_INTERFACE_ENABLE_RADV,
98 ZEBRA_INTERFACE_DISABLE_RADV,
99 ZEBRA_IPV4_NEXTHOP_LOOKUP_MRIB,
100 ZEBRA_INTERFACE_LINK_PARAMS,
101 ZEBRA_MPLS_LABELS_ADD,
102 ZEBRA_MPLS_LABELS_DELETE,
d62a17ae 103 ZEBRA_IPMR_ROUTE_STATS,
104 ZEBRA_LABEL_MANAGER_CONNECT,
105 ZEBRA_GET_LABEL_CHUNK,
106 ZEBRA_RELEASE_LABEL_CHUNK,
107 ZEBRA_FEC_REGISTER,
108 ZEBRA_FEC_UNREGISTER,
109 ZEBRA_FEC_UPDATE,
1a98c087 110 ZEBRA_ADVERTISE_DEFAULT_GW,
d62a17ae 111 ZEBRA_ADVERTISE_ALL_VNI,
112 ZEBRA_VNI_ADD,
113 ZEBRA_VNI_DEL,
114 ZEBRA_REMOTE_VTEP_ADD,
115 ZEBRA_REMOTE_VTEP_DEL,
116 ZEBRA_MACIP_ADD,
117 ZEBRA_MACIP_DEL,
118 ZEBRA_REMOTE_MACIP_ADD,
119 ZEBRA_REMOTE_MACIP_DEL,
6833ae01 120 ZEBRA_PW_ADD,
121 ZEBRA_PW_DELETE,
122 ZEBRA_PW_SET,
123 ZEBRA_PW_UNSET,
124 ZEBRA_PW_STATUS_UPDATE,
8613585e
DS
125} zebra_message_types_t;
126
d62a17ae 127struct redist_proto {
128 u_char enabled;
129 struct list *instances;
7c8ff89e
DS
130};
131
718e3744 132/* Structure for the zebra client. */
d62a17ae 133struct zclient {
134 /* The thread master we schedule ourselves on */
135 struct thread_master *master;
136
137 /* Socket to zebra daemon. */
138 int sock;
139
d62a17ae 140 /* Connection failure count. */
141 int fail;
142
143 /* Input buffer for zebra message. */
144 struct stream *ibuf;
145
146 /* Output buffer for zebra message. */
147 struct stream *obuf;
148
149 /* Buffer of data waiting to be written to zebra. */
150 struct buffer *wb;
151
152 /* Read and connect thread. */
153 struct thread *t_read;
154 struct thread *t_connect;
155
156 /* Thread to write buffered data to zebra. */
157 struct thread *t_write;
158
159 /* Redistribute information. */
160 u_char redist_default; /* clients protocol */
161 u_short instance;
162 struct redist_proto mi_redist[AFI_MAX][ZEBRA_ROUTE_MAX];
163 vrf_bitmap_t redist[AFI_MAX][ZEBRA_ROUTE_MAX];
164
165 /* Redistribute defauilt. */
166 vrf_bitmap_t default_information;
167
168 /* Pointer to the callback functions. */
169 void (*zebra_connected)(struct zclient *);
170 int (*router_id_update)(int, struct zclient *, uint16_t, vrf_id_t);
171 int (*interface_add)(int, struct zclient *, uint16_t, vrf_id_t);
172 int (*interface_delete)(int, struct zclient *, uint16_t, vrf_id_t);
173 int (*interface_up)(int, struct zclient *, uint16_t, vrf_id_t);
174 int (*interface_down)(int, struct zclient *, uint16_t, vrf_id_t);
175 int (*interface_address_add)(int, struct zclient *, uint16_t, vrf_id_t);
176 int (*interface_address_delete)(int, struct zclient *, uint16_t,
177 vrf_id_t);
178 int (*interface_link_params)(int, struct zclient *, uint16_t);
179 int (*interface_bfd_dest_update)(int, struct zclient *, uint16_t,
180 vrf_id_t);
181 int (*interface_nbr_address_add)(int, struct zclient *, uint16_t,
182 vrf_id_t);
183 int (*interface_nbr_address_delete)(int, struct zclient *, uint16_t,
184 vrf_id_t);
185 int (*interface_vrf_update)(int, struct zclient *, uint16_t, vrf_id_t);
186 int (*nexthop_update)(int, struct zclient *, uint16_t, vrf_id_t);
187 int (*import_check_update)(int, struct zclient *, uint16_t, vrf_id_t);
188 int (*bfd_dest_replay)(int, struct zclient *, uint16_t, vrf_id_t);
74489921
RW
189 int (*redistribute_route_add)(int, struct zclient *, uint16_t,
190 vrf_id_t);
191 int (*redistribute_route_del)(int, struct zclient *, uint16_t,
192 vrf_id_t);
d62a17ae 193 int (*fec_update)(int, struct zclient *, uint16_t);
194 int (*local_vni_add)(int, struct zclient *, uint16_t, vrf_id_t);
195 int (*local_vni_del)(int, struct zclient *, uint16_t, vrf_id_t);
196 int (*local_macip_add)(int, struct zclient *, uint16_t, vrf_id_t);
197 int (*local_macip_del)(int, struct zclient *, uint16_t, vrf_id_t);
6833ae01 198 int (*pw_status_update)(int, struct zclient *, uint16_t, vrf_id_t);
718e3744 199};
200
201/* Zebra API message flag. */
202#define ZAPI_MESSAGE_NEXTHOP 0x01
74489921
RW
203#define ZAPI_MESSAGE_DISTANCE 0x02
204#define ZAPI_MESSAGE_METRIC 0x04
205#define ZAPI_MESSAGE_TAG 0x08
206#define ZAPI_MESSAGE_MTU 0x10
207#define ZAPI_MESSAGE_SRCPFX 0x20
208#define ZAPI_MESSAGE_LABEL 0x40
718e3744 209
c1b9800a 210/* Zserv protocol message header */
d62a17ae 211struct zserv_header {
212 uint16_t length;
213 uint8_t marker; /* corresponds to command field in old zserv
214 * always set to 255 in new zserv.
215 */
216 uint8_t version;
80e71dcd 217#define ZSERV_VERSION 4
d62a17ae 218 vrf_id_t vrf_id;
219 uint16_t command;
c1b9800a 220};
221
bb1b9c47
RW
222struct zapi_nexthop {
223 enum nexthop_types_t type;
224 ifindex_t ifindex;
225 union g_addr gate;
52dd3aa4
RW
226
227 /* MPLS labels for BGP-LU or Segment Routing */
228 uint8_t label_num;
229 mpls_label_t labels[MPLS_MAX_LABELS];
bb1b9c47
RW
230};
231
d62a17ae 232struct zapi_route {
233 u_char type;
234 u_short instance;
657cde12 235
d62a17ae 236 u_int32_t flags;
657cde12 237
d62a17ae 238 u_char message;
657cde12 239
d62a17ae 240 safi_t safi;
657cde12 241
bb1b9c47
RW
242 struct prefix prefix;
243 struct prefix_ipv6 src_prefix;
244
d62a17ae 245 u_char nexthop_num;
bb1b9c47 246 struct zapi_nexthop nexthops[MULTIPATH_NUM];
657cde12 247
d62a17ae 248 u_char distance;
657cde12 249
d62a17ae 250 u_int32_t metric;
657cde12 251
d62a17ae 252 route_tag_t tag;
657cde12 253
d62a17ae 254 u_int32_t mtu;
657cde12 255
d62a17ae 256 vrf_id_t vrf_id;
657cde12
DS
257};
258
718e3744 259/* Zebra IPv4 route message API. */
d62a17ae 260struct zapi_ipv4 {
261 u_char type;
262 u_short instance;
718e3744 263
d62a17ae 264 u_int32_t flags;
718e3744 265
d62a17ae 266 u_char message;
718e3744 267
d62a17ae 268 safi_t safi;
5a616c08 269
d62a17ae 270 u_char nexthop_num;
271 struct in_addr **nexthop;
718e3744 272
d62a17ae 273 u_char ifindex_num;
274 ifindex_t *ifindex;
718e3744 275
d62a17ae 276 u_char label_num;
277 unsigned int *label;
a64448ba 278
d62a17ae 279 u_char distance;
718e3744 280
d62a17ae 281 u_int32_t metric;
0d9551dc 282
d62a17ae 283 route_tag_t tag;
7076bb2f 284
d62a17ae 285 u_int32_t mtu;
c50ca33a 286
d62a17ae 287 vrf_id_t vrf_id;
718e3744 288};
289
6833ae01 290struct zapi_pw {
291 char ifname[IF_NAMESIZE];
292 ifindex_t ifindex;
293 int type;
294 int af;
295 union g_addr nexthop;
296 uint32_t local_label;
297 uint32_t remote_label;
298 uint8_t flags;
299 union pw_protocol_fields data;
300 uint8_t protocol;
301};
302
303struct zapi_pw_status {
304 char ifname[IF_NAMESIZE];
305 ifindex_t ifindex;
306 uint32_t status;
307};
308
1a98c087
MK
309/* Zebra MAC types */
310#define ZEBRA_MAC_TYPE_STICKY 0x01 /* Sticky MAC*/
311#define ZEBRA_MAC_TYPE_GW 0x02 /* gateway (SVI) mac*/
312
718e3744 313/* Prototypes of zebra client service functions. */
d62a17ae 314extern struct zclient *zclient_new(struct thread_master *);
315extern void zclient_init(struct zclient *, int, u_short);
316extern int zclient_start(struct zclient *);
317extern void zclient_stop(struct zclient *);
318extern void zclient_reset(struct zclient *);
319extern void zclient_free(struct zclient *);
634f9ea2 320
d62a17ae 321extern int zclient_socket_connect(struct zclient *);
718e3744 322
d62a17ae 323extern u_short *redist_check_instance(struct redist_proto *, u_short);
324extern void redist_add_instance(struct redist_proto *, u_short);
325extern void redist_del_instance(struct redist_proto *, u_short);
7c8ff89e 326
d62a17ae 327extern void zclient_send_reg_requests(struct zclient *, vrf_id_t);
328extern void zclient_send_dereg_requests(struct zclient *, vrf_id_t);
7076bb2f 329
d62a17ae 330extern void zclient_send_interface_radv_req(struct zclient *zclient,
331 vrf_id_t vrf_id,
332 struct interface *ifp, int enable,
333 int ra_interval);
4a04e5f7 334
634f9ea2 335/* Send redistribute command to zebra daemon. Do not update zclient state. */
d62a17ae 336extern int zebra_redistribute_send(int command, struct zclient *, afi_t,
337 int type, u_short instance, vrf_id_t vrf_id);
634f9ea2 338
339/* If state has changed, update state and call zebra_redistribute_send. */
d62a17ae 340extern void zclient_redistribute(int command, struct zclient *, afi_t, int type,
341 u_short instance, vrf_id_t vrf_id);
634f9ea2 342
343/* If state has changed, update state and send the command to zebra. */
d62a17ae 344extern void zclient_redistribute_default(int command, struct zclient *,
345 vrf_id_t vrf_id);
718e3744 346
634f9ea2 347/* Send the message in zclient->obuf to the zebra daemon (or enqueue it).
348 Returns 0 for success or -1 on an I/O error. */
349extern int zclient_send_message(struct zclient *);
718e3744 350
d211086a 351/* create header for command, length to be filled in by user later */
d62a17ae 352extern void zclient_create_header(struct stream *, uint16_t, vrf_id_t);
353extern int zclient_read_header(struct stream *s, int sock, u_int16_t *size,
354 u_char *marker, u_char *version,
355 vrf_id_t *vrf_id, u_int16_t *cmd);
356
e0ae31b8
DS
357extern void zclient_interface_set_master(struct zclient *client,
358 struct interface *master,
359 struct interface *slave);
d62a17ae 360extern struct interface *zebra_interface_add_read(struct stream *, vrf_id_t);
361extern struct interface *zebra_interface_state_read(struct stream *s, vrf_id_t);
362extern struct connected *zebra_interface_address_read(int, struct stream *,
363 vrf_id_t);
364extern struct nbr_connected *
365zebra_interface_nbr_address_read(int, struct stream *, vrf_id_t);
366extern struct interface *zebra_interface_vrf_update_read(struct stream *s,
367 vrf_id_t vrf_id,
368 vrf_id_t *new_vrf_id);
369extern void zebra_interface_if_set_value(struct stream *, struct interface *);
370extern void zebra_router_id_update_read(struct stream *s, struct prefix *rid);
371extern int zapi_ipv4_route(u_char, struct zclient *, struct prefix_ipv4 *,
f474e08b 372 struct zapi_ipv4 *) __attribute__((deprecated));
d62a17ae 373
374extern struct interface *zebra_interface_link_params_read(struct stream *);
375extern size_t zebra_interface_link_params_write(struct stream *,
376 struct interface *);
377extern int lm_label_manager_connect(struct zclient *zclient);
378extern int lm_get_label_chunk(struct zclient *zclient, u_char keep,
379 uint32_t chunk_size, uint32_t *start,
380 uint32_t *end);
381extern int lm_release_label_chunk(struct zclient *zclient, uint32_t start,
382 uint32_t end);
6833ae01 383extern int zebra_send_pw(struct zclient *zclient, int command,
384 struct zapi_pw *pw);
385extern void zebra_read_pw_status_update(int command, struct zclient *zclient,
386 zebra_size_t length, vrf_id_t vrf_id,
387 struct zapi_pw_status *pw);
388
718e3744 389/* IPv6 prefix add and delete function prototype. */
390
d62a17ae 391struct zapi_ipv6 {
392 u_char type;
393 u_short instance;
718e3744 394
d62a17ae 395 u_int32_t flags;
718e3744 396
d62a17ae 397 u_char message;
718e3744 398
d62a17ae 399 safi_t safi;
c7ec179a 400
d62a17ae 401 u_char nexthop_num;
402 struct in6_addr **nexthop;
718e3744 403
d62a17ae 404 u_char ifindex_num;
405 ifindex_t *ifindex;
718e3744 406
d62a17ae 407 u_char label_num;
408 unsigned int *label;
a64448ba 409
d62a17ae 410 u_char distance;
718e3744 411
d62a17ae 412 u_int32_t metric;
0d9551dc 413
d62a17ae 414 route_tag_t tag;
7076bb2f 415
d62a17ae 416 u_int32_t mtu;
c50ca33a 417
d62a17ae 418 vrf_id_t vrf_id;
718e3744 419};
420
d62a17ae 421extern int zapi_ipv6_route(u_char cmd, struct zclient *zclient,
422 struct prefix_ipv6 *p, struct prefix_ipv6 *src_p,
f474e08b 423 struct zapi_ipv6 *api) __attribute__((deprecated));
d62a17ae 424extern int zapi_ipv4_route_ipv6_nexthop(u_char, struct zclient *,
425 struct prefix_ipv4 *,
f474e08b
RW
426 struct zapi_ipv6 *)
427 __attribute__((deprecated));
0e51b4a3
RW
428extern int zclient_route_send(u_char, struct zclient *, struct zapi_route *);
429extern int zapi_route_encode(u_char, struct stream *, struct zapi_route *);
430extern int zapi_route_decode(struct stream *, struct zapi_route *);
718e3744 431
432#endif /* _ZEBRA_ZCLIENT_H */