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