]> git.proxmox.com Git - mirror_frr.git/blame - lib/zclient.h
bgpd: update debugs enance
[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.
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
5734509c
PJ
25/* For struct zapi_ipv{4,6}. */
26#include "prefix.h"
27
718e3744 28/* For struct interface and struct connected. */
29#include "if.h"
30
7076bb2f
FL
31/* For vrf_bitmap_t. */
32#include "vrf.h"
33
718e3744 34/* For input/output buffer to zebra. */
35#define ZEBRA_MAX_PACKET_SIZ 4096
36
37/* Zebra header size. */
7076bb2f 38#define ZEBRA_HEADER_SIZE 8
718e3744 39
8613585e
DS
40/* Zebra message types. */
41typedef 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,
fea12efb 94 ZEBRA_LABEL_MANAGER_CONNECT,
95 ZEBRA_GET_LABEL_CHUNK,
96 ZEBRA_RELEASE_LABEL_CHUNK,
5aba114a
DS
97 ZEBRA_FEC_REGISTER,
98 ZEBRA_FEC_UNREGISTER,
99 ZEBRA_FEC_UPDATE,
8613585e
DS
100} zebra_message_types_t;
101
7c8ff89e
DS
102struct redist_proto
103{
104 u_char enabled;
105 struct list *instances;
106};
107
718e3744 108/* Structure for the zebra client. */
109struct zclient
110{
4140ca4d
DS
111 /* The thread master we schedule ourselves on */
112 struct thread_master *master;
113
718e3744 114 /* Socket to zebra daemon. */
115 int sock;
116
117 /* Flag of communication to zebra is enabled or not. Default is on.
118 This flag is disabled by `no router zebra' statement. */
119 int enable;
120
121 /* Connection failure count. */
122 int fail;
123
124 /* Input buffer for zebra message. */
125 struct stream *ibuf;
126
127 /* Output buffer for zebra message. */
128 struct stream *obuf;
129
634f9ea2 130 /* Buffer of data waiting to be written to zebra. */
131 struct buffer *wb;
132
718e3744 133 /* Read and connect thread. */
134 struct thread *t_read;
135 struct thread *t_connect;
136
634f9ea2 137 /* Thread to write buffered data to zebra. */
138 struct thread *t_write;
139
718e3744 140 /* Redistribute information. */
7c8ff89e
DS
141 u_char redist_default; /* clients protocol */
142 u_short instance;
7076bb2f
FL
143 struct redist_proto mi_redist[AFI_MAX][ZEBRA_ROUTE_MAX];
144 vrf_bitmap_t redist[AFI_MAX][ZEBRA_ROUTE_MAX];
718e3744 145
146 /* Redistribute defauilt. */
7076bb2f 147 vrf_bitmap_t default_information;
718e3744 148
149 /* Pointer to the callback functions. */
7076bb2f
FL
150 void (*zebra_connected) (struct zclient *);
151 int (*router_id_update) (int, struct zclient *, uint16_t, vrf_id_t);
152 int (*interface_add) (int, struct zclient *, uint16_t, vrf_id_t);
153 int (*interface_delete) (int, struct zclient *, uint16_t, vrf_id_t);
154 int (*interface_up) (int, struct zclient *, uint16_t, vrf_id_t);
155 int (*interface_down) (int, struct zclient *, uint16_t, vrf_id_t);
156 int (*interface_address_add) (int, struct zclient *, uint16_t, vrf_id_t);
157 int (*interface_address_delete) (int, struct zclient *, uint16_t, vrf_id_t);
16f1b9ee 158 int (*interface_link_params) (int, struct zclient *, uint16_t);
7076bb2f
FL
159 int (*interface_bfd_dest_update) (int, struct zclient *, uint16_t, vrf_id_t);
160 int (*interface_nbr_address_add) (int, struct zclient *, uint16_t, vrf_id_t);
161 int (*interface_nbr_address_delete) (int, struct zclient *, uint16_t, vrf_id_t);
c8e264b6 162 int (*interface_vrf_update) (int, struct zclient *, uint16_t, vrf_id_t);
7076bb2f
FL
163 int (*nexthop_update) (int, struct zclient *, uint16_t, vrf_id_t);
164 int (*import_check_update) (int, struct zclient *, uint16_t, vrf_id_t);
165 int (*bfd_dest_replay) (int, struct zclient *, uint16_t, vrf_id_t);
166 int (*redistribute_route_ipv4_add) (int, struct zclient *, uint16_t, vrf_id_t);
167 int (*redistribute_route_ipv4_del) (int, struct zclient *, uint16_t, vrf_id_t);
168 int (*redistribute_route_ipv6_add) (int, struct zclient *, uint16_t, vrf_id_t);
169 int (*redistribute_route_ipv6_del) (int, struct zclient *, uint16_t, vrf_id_t);
5aba114a 170 int (*fec_update) (int, struct zclient *, uint16_t);
718e3744 171};
172
173/* Zebra API message flag. */
174#define ZAPI_MESSAGE_NEXTHOP 0x01
175#define ZAPI_MESSAGE_IFINDEX 0x02
176#define ZAPI_MESSAGE_DISTANCE 0x04
177#define ZAPI_MESSAGE_METRIC 0x08
c8a1cb5c 178#define ZAPI_MESSAGE_TAG 0x10
c50ca33a 179#define ZAPI_MESSAGE_MTU 0x20
3c7c91d0 180#define ZAPI_MESSAGE_SRCPFX 0x40
718e3744 181
c1b9800a 182/* Zserv protocol message header */
183struct 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;
80e71dcd 190#define ZSERV_VERSION 4
7076bb2f 191 vrf_id_t vrf_id;
c1b9800a 192 uint16_t command;
193};
194
718e3744 195/* Zebra IPv4 route message API. */
196struct zapi_ipv4
197{
198 u_char type;
7c8ff89e 199 u_short instance;
718e3744 200
0fc452dc 201 u_int32_t flags;
718e3744 202
203 u_char message;
204
5a616c08
B
205 safi_t safi;
206
718e3744 207 u_char nexthop_num;
208 struct in_addr **nexthop;
209
210 u_char ifindex_num;
b892f1dd 211 ifindex_t *ifindex;
718e3744 212
213 u_char distance;
214
215 u_int32_t metric;
0d9551dc 216
dc9ffce8 217 route_tag_t tag;
7076bb2f 218
c50ca33a
TT
219 u_int32_t mtu;
220
7076bb2f 221 vrf_id_t vrf_id;
718e3744 222};
223
718e3744 224/* Prototypes of zebra client service functions. */
4140ca4d 225extern struct zclient *zclient_new (struct thread_master *);
7c8ff89e 226extern void zclient_init (struct zclient *, int, u_short);
8cc4198f 227extern int zclient_start (struct zclient *);
228extern void zclient_stop (struct zclient *);
229extern void zclient_reset (struct zclient *);
228da428 230extern void zclient_free (struct zclient *);
634f9ea2 231
b5114685
VT
232extern int zclient_socket_connect (struct zclient *);
233extern void zclient_serv_path_set (char *path);
744f4685 234extern const char *zclient_serv_path_get (void);
718e3744 235
43e7c3b4 236extern u_short *redist_check_instance (struct redist_proto *, u_short);
7c8ff89e
DS
237extern void redist_add_instance (struct redist_proto *, u_short);
238extern void redist_del_instance (struct redist_proto *, u_short);
239
0e5223e7 240extern void zclient_send_reg_requests (struct zclient *, vrf_id_t);
241extern void zclient_send_dereg_requests (struct zclient *, vrf_id_t);
7076bb2f 242
4a04e5f7 243extern void zclient_send_interface_radv_req (struct zclient *zclient, vrf_id_t vrf_id,
5c81b96a 244 struct interface *ifp, int enable, int ra_interval);
4a04e5f7 245
634f9ea2 246/* Send redistribute command to zebra daemon. Do not update zclient state. */
7076bb2f 247extern int zebra_redistribute_send (int command, struct zclient *, afi_t, int type, u_short instance, vrf_id_t vrf_id);
634f9ea2 248
249/* If state has changed, update state and call zebra_redistribute_send. */
8bb0831e 250extern void zclient_redistribute (int command, struct zclient *, afi_t, int type,
7076bb2f 251 u_short instance, vrf_id_t vrf_id);
634f9ea2 252
253/* If state has changed, update state and send the command to zebra. */
7076bb2f
FL
254extern void zclient_redistribute_default (int command, struct zclient *,
255 vrf_id_t vrf_id);
718e3744 256
634f9ea2 257/* Send the message in zclient->obuf to the zebra daemon (or enqueue it).
258 Returns 0 for success or -1 on an I/O error. */
259extern int zclient_send_message(struct zclient *);
718e3744 260
d211086a 261/* create header for command, length to be filled in by user later */
7076bb2f 262extern void zclient_create_header (struct stream *, uint16_t, vrf_id_t);
55119089
ND
263extern int zclient_read_header (struct stream *s, int sock, u_int16_t *size,
264 u_char *marker, u_char *version,
e7a2870b 265 vrf_id_t *vrf_id, u_int16_t *cmd);
d211086a 266
7076bb2f
FL
267extern struct interface *zebra_interface_add_read (struct stream *, vrf_id_t);
268extern struct interface *zebra_interface_state_read (struct stream *s, vrf_id_t);
269extern struct connected *zebra_interface_address_read (int, struct stream *, vrf_id_t);
270extern struct nbr_connected *zebra_interface_nbr_address_read (int, struct stream *, vrf_id_t);
c8e264b6 271extern struct interface * zebra_interface_vrf_update_read (struct stream *s, vrf_id_t vrf_id,
272 vrf_id_t *new_vrf_id);
8cc4198f 273extern void zebra_interface_if_set_value (struct stream *, struct interface *);
274extern void zebra_router_id_update_read (struct stream *s, struct prefix *rid);
275extern int zapi_ipv4_route (u_char, struct zclient *, struct prefix_ipv4 *,
276 struct zapi_ipv4 *);
718e3744 277
16f1b9ee
OD
278extern struct interface *zebra_interface_link_params_read (struct stream *);
279extern size_t zebra_interface_link_params_write (struct stream *,
280 struct interface *);
fea12efb 281extern int lm_label_manager_connect (struct zclient *zclient);
282extern int lm_get_label_chunk (struct zclient *zclient, u_char keep,
283 uint32_t chunk_size, uint32_t *start, uint32_t *end);
284extern int lm_release_label_chunk (struct zclient *zclient, uint32_t start, uint32_t end);
718e3744 285/* IPv6 prefix add and delete function prototype. */
286
287struct zapi_ipv6
288{
289 u_char type;
7c8ff89e 290 u_short instance;
718e3744 291
0fc452dc 292 u_int32_t flags;
718e3744 293
294 u_char message;
295
c7ec179a
B
296 safi_t safi;
297
718e3744 298 u_char nexthop_num;
299 struct in6_addr **nexthop;
300
301 u_char ifindex_num;
b892f1dd 302 ifindex_t *ifindex;
718e3744 303
304 u_char distance;
305
306 u_int32_t metric;
0d9551dc 307
dc9ffce8 308 route_tag_t tag;
7076bb2f 309
c50ca33a
TT
310 u_int32_t mtu;
311
7076bb2f 312 vrf_id_t vrf_id;
718e3744 313};
314
8cc4198f 315extern int zapi_ipv6_route (u_char cmd, struct zclient *zclient,
d75f3b00
DL
316 struct prefix_ipv6 *p, struct prefix_ipv6 *src_p,
317 struct zapi_ipv6 *api);
8a92a8a0
DS
318extern int zapi_ipv4_route_ipv6_nexthop (u_char, struct zclient *,
319 struct prefix_ipv4 *, struct zapi_ipv6 *);
718e3744 320
321#endif /* _ZEBRA_ZCLIENT_H */