]>
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 | ||
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. */ |
db4a24dd | 40 | #define ZEBRA_MAX_PACKET_SIZ 16384 |
718e3744 | 41 | |
42 | /* Zebra header size. */ | |
a9ff90c4 | 43 | #define ZEBRA_HEADER_SIZE 10 |
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, | |
7ea7b86e | 64 | ZEBRA_ROUTE_NOTIFY_OWNER, |
d62a17ae | 65 | ZEBRA_IPV4_ROUTE_ADD, |
66 | ZEBRA_IPV4_ROUTE_DELETE, | |
67 | ZEBRA_IPV6_ROUTE_ADD, | |
68 | ZEBRA_IPV6_ROUTE_DELETE, | |
69 | ZEBRA_REDISTRIBUTE_ADD, | |
70 | ZEBRA_REDISTRIBUTE_DELETE, | |
71 | ZEBRA_REDISTRIBUTE_DEFAULT_ADD, | |
72 | ZEBRA_REDISTRIBUTE_DEFAULT_DELETE, | |
73 | ZEBRA_ROUTER_ID_ADD, | |
74 | ZEBRA_ROUTER_ID_DELETE, | |
75 | ZEBRA_ROUTER_ID_UPDATE, | |
76 | ZEBRA_HELLO, | |
77 | ZEBRA_NEXTHOP_REGISTER, | |
78 | ZEBRA_NEXTHOP_UNREGISTER, | |
79 | ZEBRA_NEXTHOP_UPDATE, | |
80 | ZEBRA_INTERFACE_NBR_ADDRESS_ADD, | |
81 | ZEBRA_INTERFACE_NBR_ADDRESS_DELETE, | |
82 | ZEBRA_INTERFACE_BFD_DEST_UPDATE, | |
83 | ZEBRA_IMPORT_ROUTE_REGISTER, | |
84 | ZEBRA_IMPORT_ROUTE_UNREGISTER, | |
85 | ZEBRA_IMPORT_CHECK_UPDATE, | |
86 | ZEBRA_IPV4_ROUTE_IPV6_NEXTHOP_ADD, | |
87 | ZEBRA_BFD_DEST_REGISTER, | |
88 | ZEBRA_BFD_DEST_DEREGISTER, | |
89 | ZEBRA_BFD_DEST_UPDATE, | |
90 | ZEBRA_BFD_DEST_REPLAY, | |
74489921 RW |
91 | ZEBRA_REDISTRIBUTE_ROUTE_ADD, |
92 | ZEBRA_REDISTRIBUTE_ROUTE_DEL, | |
d62a17ae | 93 | ZEBRA_VRF_UNREGISTER, |
94 | ZEBRA_VRF_ADD, | |
95 | ZEBRA_VRF_DELETE, | |
c83c5e44 | 96 | ZEBRA_VRF_LABEL, |
d62a17ae | 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, |
31310b25 | 113 | ZEBRA_ADVERTISE_SUBNET, |
d62a17ae | 114 | ZEBRA_ADVERTISE_ALL_VNI, |
115 | ZEBRA_VNI_ADD, | |
116 | ZEBRA_VNI_DEL, | |
b7cfce93 MK |
117 | ZEBRA_L3VNI_ADD, |
118 | ZEBRA_L3VNI_DEL, | |
d62a17ae | 119 | ZEBRA_REMOTE_VTEP_ADD, |
120 | ZEBRA_REMOTE_VTEP_DEL, | |
121 | ZEBRA_MACIP_ADD, | |
122 | ZEBRA_MACIP_DEL, | |
31310b25 MK |
123 | ZEBRA_IP_PREFIX_ROUTE_ADD, |
124 | ZEBRA_IP_PREFIX_ROUTE_DEL, | |
d62a17ae | 125 | ZEBRA_REMOTE_MACIP_ADD, |
126 | ZEBRA_REMOTE_MACIP_DEL, | |
6833ae01 | 127 | ZEBRA_PW_ADD, |
128 | ZEBRA_PW_DELETE, | |
129 | ZEBRA_PW_SET, | |
130 | ZEBRA_PW_UNSET, | |
131 | ZEBRA_PW_STATUS_UPDATE, | |
e16abbb3 DS |
132 | ZEBRA_RULE_ADD, |
133 | ZEBRA_RULE_DELETE, | |
134 | ZEBRA_RULE_NOTIFY_OWNER, | |
8613585e DS |
135 | } zebra_message_types_t; |
136 | ||
d62a17ae | 137 | struct redist_proto { |
138 | u_char enabled; | |
139 | struct list *instances; | |
7c8ff89e DS |
140 | }; |
141 | ||
718e3744 | 142 | /* Structure for the zebra client. */ |
d62a17ae | 143 | struct zclient { |
144 | /* The thread master we schedule ourselves on */ | |
145 | struct thread_master *master; | |
146 | ||
342213ea DS |
147 | /* Priviledges to change socket values */ |
148 | struct zebra_privs_t *privs; | |
149 | ||
e1a1880d DS |
150 | /* Do we care about failure events for route install? */ |
151 | bool receive_notify; | |
152 | ||
d62a17ae | 153 | /* Socket to zebra daemon. */ |
154 | int sock; | |
155 | ||
d62a17ae | 156 | /* Connection failure count. */ |
157 | int fail; | |
158 | ||
159 | /* Input buffer for zebra message. */ | |
160 | struct stream *ibuf; | |
161 | ||
162 | /* Output buffer for zebra message. */ | |
163 | struct stream *obuf; | |
164 | ||
165 | /* Buffer of data waiting to be written to zebra. */ | |
166 | struct buffer *wb; | |
167 | ||
168 | /* Read and connect thread. */ | |
169 | struct thread *t_read; | |
170 | struct thread *t_connect; | |
171 | ||
172 | /* Thread to write buffered data to zebra. */ | |
173 | struct thread *t_write; | |
174 | ||
175 | /* Redistribute information. */ | |
176 | u_char redist_default; /* clients protocol */ | |
177 | u_short instance; | |
178 | struct redist_proto mi_redist[AFI_MAX][ZEBRA_ROUTE_MAX]; | |
179 | vrf_bitmap_t redist[AFI_MAX][ZEBRA_ROUTE_MAX]; | |
180 | ||
181 | /* Redistribute defauilt. */ | |
182 | vrf_bitmap_t default_information; | |
183 | ||
184 | /* Pointer to the callback functions. */ | |
185 | void (*zebra_connected)(struct zclient *); | |
186 | int (*router_id_update)(int, struct zclient *, uint16_t, vrf_id_t); | |
187 | int (*interface_add)(int, struct zclient *, uint16_t, vrf_id_t); | |
188 | int (*interface_delete)(int, struct zclient *, uint16_t, vrf_id_t); | |
189 | int (*interface_up)(int, struct zclient *, uint16_t, vrf_id_t); | |
190 | int (*interface_down)(int, struct zclient *, uint16_t, vrf_id_t); | |
191 | int (*interface_address_add)(int, struct zclient *, uint16_t, vrf_id_t); | |
192 | int (*interface_address_delete)(int, struct zclient *, uint16_t, | |
193 | vrf_id_t); | |
194 | int (*interface_link_params)(int, struct zclient *, uint16_t); | |
195 | int (*interface_bfd_dest_update)(int, struct zclient *, uint16_t, | |
196 | vrf_id_t); | |
197 | int (*interface_nbr_address_add)(int, struct zclient *, uint16_t, | |
198 | vrf_id_t); | |
199 | int (*interface_nbr_address_delete)(int, struct zclient *, uint16_t, | |
200 | vrf_id_t); | |
201 | int (*interface_vrf_update)(int, struct zclient *, uint16_t, vrf_id_t); | |
202 | int (*nexthop_update)(int, struct zclient *, uint16_t, vrf_id_t); | |
203 | int (*import_check_update)(int, struct zclient *, uint16_t, vrf_id_t); | |
204 | int (*bfd_dest_replay)(int, struct zclient *, uint16_t, vrf_id_t); | |
74489921 RW |
205 | int (*redistribute_route_add)(int, struct zclient *, uint16_t, |
206 | vrf_id_t); | |
207 | int (*redistribute_route_del)(int, struct zclient *, uint16_t, | |
208 | vrf_id_t); | |
d62a17ae | 209 | int (*fec_update)(int, struct zclient *, uint16_t); |
210 | int (*local_vni_add)(int, struct zclient *, uint16_t, vrf_id_t); | |
211 | int (*local_vni_del)(int, struct zclient *, uint16_t, vrf_id_t); | |
b7cfce93 MK |
212 | int (*local_l3vni_add)(int, struct zclient *, uint16_t, vrf_id_t); |
213 | int (*local_l3vni_del)(int, struct zclient *, uint16_t, vrf_id_t); | |
31310b25 MK |
214 | void (*local_ip_prefix_add)(int, struct zclient *, uint16_t, vrf_id_t); |
215 | void (*local_ip_prefix_del)(int, struct zclient *, uint16_t, vrf_id_t); | |
d62a17ae | 216 | int (*local_macip_add)(int, struct zclient *, uint16_t, vrf_id_t); |
217 | int (*local_macip_del)(int, struct zclient *, uint16_t, vrf_id_t); | |
6833ae01 | 218 | int (*pw_status_update)(int, struct zclient *, uint16_t, vrf_id_t); |
28b11f81 DS |
219 | int (*route_notify_owner)(int command, struct zclient *zclient, |
220 | uint16_t length, vrf_id_t vrf_id); | |
b6c5d343 DS |
221 | int (*rule_notify_owner)(int command, struct zclient *zclient, |
222 | uint16_t length, vrf_id_t vrf_id); | |
718e3744 | 223 | }; |
224 | ||
225 | /* Zebra API message flag. */ | |
226 | #define ZAPI_MESSAGE_NEXTHOP 0x01 | |
74489921 RW |
227 | #define ZAPI_MESSAGE_DISTANCE 0x02 |
228 | #define ZAPI_MESSAGE_METRIC 0x04 | |
229 | #define ZAPI_MESSAGE_TAG 0x08 | |
230 | #define ZAPI_MESSAGE_MTU 0x10 | |
231 | #define ZAPI_MESSAGE_SRCPFX 0x20 | |
232 | #define ZAPI_MESSAGE_LABEL 0x40 | |
ba1849ef DS |
233 | /* |
234 | * This should only be used by a DAEMON that needs to communicate | |
235 | * the table being used is not in the VRF. You must pass the | |
236 | * default vrf, else this will be ignored. | |
237 | */ | |
238 | #define ZAPI_MESSAGE_TABLEID 0x80 | |
718e3744 | 239 | |
124ead27 | 240 | #define ZSERV_VERSION 5 |
c1b9800a | 241 | /* Zserv protocol message header */ |
124ead27 | 242 | struct zmsghdr { |
d62a17ae | 243 | uint16_t length; |
124ead27 QY |
244 | /* corresponds to command field in old zserv |
245 | * always set to 255 in new zserv. */ | |
246 | uint8_t marker; | |
d62a17ae | 247 | uint8_t version; |
d62a17ae | 248 | vrf_id_t vrf_id; |
249 | uint16_t command; | |
c1b9800a | 250 | }; |
251 | ||
bb1b9c47 RW |
252 | struct zapi_nexthop { |
253 | enum nexthop_types_t type; | |
4a7371e9 | 254 | vrf_id_t vrf_id; |
bb1b9c47 | 255 | ifindex_t ifindex; |
09a484dd DL |
256 | union { |
257 | union g_addr gate; | |
258 | enum blackhole_type bh_type; | |
259 | }; | |
52dd3aa4 RW |
260 | |
261 | /* MPLS labels for BGP-LU or Segment Routing */ | |
262 | uint8_t label_num; | |
263 | mpls_label_t labels[MPLS_MAX_LABELS]; | |
bb1b9c47 RW |
264 | }; |
265 | ||
832d0f56 DS |
266 | /* |
267 | * Some of these data structures do not map easily to | |
268 | * a actual data structure size giving different compilers | |
269 | * and systems. For those data structures we need | |
270 | * to use the smallest available stream_getX/putX functions | |
271 | * to encode/decode. | |
272 | */ | |
d62a17ae | 273 | struct zapi_route { |
274 | u_char type; | |
275 | u_short instance; | |
657cde12 | 276 | |
d62a17ae | 277 | u_int32_t flags; |
657cde12 | 278 | |
d62a17ae | 279 | u_char message; |
657cde12 | 280 | |
832d0f56 DS |
281 | /* |
282 | * This is an enum but we are going to treat it as a uint8_t | |
283 | * for purpose of encoding/decoding | |
284 | */ | |
d62a17ae | 285 | safi_t safi; |
657cde12 | 286 | |
bb1b9c47 RW |
287 | struct prefix prefix; |
288 | struct prefix_ipv6 src_prefix; | |
289 | ||
b5f79651 | 290 | u_int16_t nexthop_num; |
bb1b9c47 | 291 | struct zapi_nexthop nexthops[MULTIPATH_NUM]; |
657cde12 | 292 | |
d62a17ae | 293 | u_char distance; |
657cde12 | 294 | |
d62a17ae | 295 | u_int32_t metric; |
657cde12 | 296 | |
d62a17ae | 297 | route_tag_t tag; |
657cde12 | 298 | |
d62a17ae | 299 | u_int32_t mtu; |
657cde12 | 300 | |
d62a17ae | 301 | vrf_id_t vrf_id; |
2dbad57f | 302 | |
ba1849ef DS |
303 | uint32_t tableid; |
304 | ||
2dbad57f | 305 | struct ethaddr rmac; |
657cde12 DS |
306 | }; |
307 | ||
718e3744 | 308 | /* Zebra IPv4 route message API. */ |
d62a17ae | 309 | struct zapi_ipv4 { |
310 | u_char type; | |
311 | u_short instance; | |
718e3744 | 312 | |
d62a17ae | 313 | u_int32_t flags; |
718e3744 | 314 | |
d62a17ae | 315 | u_char message; |
718e3744 | 316 | |
d62a17ae | 317 | safi_t safi; |
5a616c08 | 318 | |
d62a17ae | 319 | u_char nexthop_num; |
320 | struct in_addr **nexthop; | |
718e3744 | 321 | |
d62a17ae | 322 | u_char ifindex_num; |
323 | ifindex_t *ifindex; | |
718e3744 | 324 | |
d62a17ae | 325 | u_char label_num; |
326 | unsigned int *label; | |
a64448ba | 327 | |
d62a17ae | 328 | u_char distance; |
718e3744 | 329 | |
d62a17ae | 330 | u_int32_t metric; |
0d9551dc | 331 | |
d62a17ae | 332 | route_tag_t tag; |
7076bb2f | 333 | |
d62a17ae | 334 | u_int32_t mtu; |
c50ca33a | 335 | |
d62a17ae | 336 | vrf_id_t vrf_id; |
718e3744 | 337 | }; |
338 | ||
6833ae01 | 339 | struct zapi_pw { |
340 | char ifname[IF_NAMESIZE]; | |
341 | ifindex_t ifindex; | |
342 | int type; | |
343 | int af; | |
344 | union g_addr nexthop; | |
345 | uint32_t local_label; | |
346 | uint32_t remote_label; | |
347 | uint8_t flags; | |
348 | union pw_protocol_fields data; | |
349 | uint8_t protocol; | |
350 | }; | |
351 | ||
352 | struct zapi_pw_status { | |
353 | char ifname[IF_NAMESIZE]; | |
354 | ifindex_t ifindex; | |
355 | uint32_t status; | |
356 | }; | |
357 | ||
7ea7b86e DS |
358 | enum zapi_route_notify_owner { |
359 | ZAPI_ROUTE_FAIL_INSTALL, | |
360 | ZAPI_ROUTE_BETTER_ADMIN_WON, | |
361 | ZAPI_ROUTE_INSTALLED, | |
5e54c602 DS |
362 | ZAPI_ROUTE_REMOVED, |
363 | ZAPI_ROUTE_REMOVE_FAIL, | |
7ea7b86e DS |
364 | }; |
365 | ||
b6c5d343 DS |
366 | enum zapi_rule_notify_owner { |
367 | ZAPI_RULE_FAIL_INSTALL, | |
368 | ZAPI_RULE_INSTALLED, | |
369 | ZAPI_RULE_REMOVED, | |
370 | }; | |
371 | ||
1a98c087 | 372 | /* Zebra MAC types */ |
ead40654 MK |
373 | #define ZEBRA_MACIP_TYPE_STICKY 0x01 /* Sticky MAC*/ |
374 | #define ZEBRA_MACIP_TYPE_GW 0x02 /* gateway (SVI) mac*/ | |
1a98c087 | 375 | |
e1a1880d DS |
376 | struct zclient_options { |
377 | bool receive_notify; | |
378 | }; | |
379 | ||
718e3744 | 380 | /* Prototypes of zebra client service functions. */ |
d62a17ae | 381 | extern struct zclient *zclient_new(struct thread_master *); |
e1a1880d DS |
382 | |
383 | #if CONFDATE > 20181101 | |
384 | CPP_NOTICE("zclient_new_notify can take over or zclient_new now"); | |
385 | #endif | |
386 | ||
387 | extern struct zclient_options zclient_options_default; | |
388 | ||
389 | extern struct zclient *zclient_new_notify(struct thread_master *m, | |
390 | struct zclient_options *opt); | |
391 | ||
996c9314 LB |
392 | #define zclient_new(A) \ |
393 | zclient_new_notify((A), &zclient_options_default); \ | |
e1a1880d DS |
394 | CPP_WARN("Please transition to using zclient_new_notify"); |
395 | ||
996c9314 LB |
396 | extern void zclient_init(struct zclient *, int, u_short, |
397 | struct zebra_privs_t *privs); | |
d62a17ae | 398 | extern int zclient_start(struct zclient *); |
399 | extern void zclient_stop(struct zclient *); | |
400 | extern void zclient_reset(struct zclient *); | |
401 | extern void zclient_free(struct zclient *); | |
634f9ea2 | 402 | |
d62a17ae | 403 | extern int zclient_socket_connect(struct zclient *); |
718e3744 | 404 | |
d62a17ae | 405 | extern u_short *redist_check_instance(struct redist_proto *, u_short); |
406 | extern void redist_add_instance(struct redist_proto *, u_short); | |
407 | extern void redist_del_instance(struct redist_proto *, u_short); | |
7c8ff89e | 408 | |
c83c5e44 DS |
409 | /* |
410 | * Send to zebra that the specified vrf is using label to resolve | |
411 | * itself for L3VPN's. Repeated calls of this function with | |
412 | * different labels will cause an effective update of the | |
42567e00 | 413 | * label for lookup. If you pass in MPLS_LABEL_NONE |
c83c5e44 DS |
414 | * we will cause a delete action and remove this label pop |
415 | * operation. | |
7d061b3c DS |
416 | * |
417 | * The underlying AF_MPLS doesn't care about afi's | |
418 | * but we can make the zebra_vrf keep track of what | |
419 | * we have installed and play some special games | |
420 | * to get them both installed. | |
c83c5e44 DS |
421 | */ |
422 | extern void zclient_send_vrf_label(struct zclient *zclient, vrf_id_t vrf_id, | |
7d061b3c DS |
423 | afi_t afi, mpls_label_t label, |
424 | enum lsp_types_t ltype); | |
c83c5e44 | 425 | |
d62a17ae | 426 | extern void zclient_send_reg_requests(struct zclient *, vrf_id_t); |
427 | extern void zclient_send_dereg_requests(struct zclient *, vrf_id_t); | |
7076bb2f | 428 | |
d62a17ae | 429 | extern void zclient_send_interface_radv_req(struct zclient *zclient, |
430 | vrf_id_t vrf_id, | |
431 | struct interface *ifp, int enable, | |
432 | int ra_interval); | |
4a04e5f7 | 433 | |
634f9ea2 | 434 | /* Send redistribute command to zebra daemon. Do not update zclient state. */ |
d62a17ae | 435 | extern int zebra_redistribute_send(int command, struct zclient *, afi_t, |
436 | int type, u_short instance, vrf_id_t vrf_id); | |
634f9ea2 | 437 | |
438 | /* If state has changed, update state and call zebra_redistribute_send. */ | |
d62a17ae | 439 | extern void zclient_redistribute(int command, struct zclient *, afi_t, int type, |
440 | u_short instance, vrf_id_t vrf_id); | |
634f9ea2 | 441 | |
442 | /* If state has changed, update state and send the command to zebra. */ | |
d62a17ae | 443 | extern void zclient_redistribute_default(int command, struct zclient *, |
444 | vrf_id_t vrf_id); | |
718e3744 | 445 | |
634f9ea2 | 446 | /* Send the message in zclient->obuf to the zebra daemon (or enqueue it). |
447 | Returns 0 for success or -1 on an I/O error. */ | |
448 | extern int zclient_send_message(struct zclient *); | |
718e3744 | 449 | |
d211086a | 450 | /* create header for command, length to be filled in by user later */ |
d62a17ae | 451 | extern void zclient_create_header(struct stream *, uint16_t, vrf_id_t); |
124ead27 QY |
452 | /* |
453 | * Read sizeof(struct zmsghdr) bytes from the provided socket and parse the | |
454 | * received data into the specified fields. If this is successful, read the | |
455 | * rest of the packet into the provided stream. | |
456 | * | |
457 | * s | |
458 | * The stream to read into | |
459 | * | |
460 | * sock | |
461 | * The socket to read from | |
462 | * | |
463 | * size | |
464 | * Parsed message size will be placed in the pointed-at integer | |
465 | * | |
466 | * marker | |
467 | * Parsed marker will be placed in the pointed-at byte | |
468 | * | |
469 | * version | |
470 | * Parsed version will be placed in the pointed-at byte | |
471 | * | |
472 | * vrf_id | |
473 | * Parsed VRF ID will be placed in the pointed-at vrf_id_t | |
474 | * | |
475 | * cmd | |
476 | * Parsed command number will be placed in the pointed-at integer | |
477 | * | |
478 | * Returns: | |
479 | * -1 if: | |
480 | * - insufficient data for header was read | |
481 | * - a version mismatch was detected | |
482 | * - a marker mismatch was detected | |
483 | * - header size field specified more data than could be read | |
484 | */ | |
d62a17ae | 485 | extern int zclient_read_header(struct stream *s, int sock, u_int16_t *size, |
486 | u_char *marker, u_char *version, | |
487 | vrf_id_t *vrf_id, u_int16_t *cmd); | |
124ead27 QY |
488 | /* |
489 | * Parse header from ZAPI message stream into struct zmsghdr. | |
490 | * This function assumes the stream getp points at the first byte of the header. | |
491 | * If the function is successful then the stream getp will point to the byte | |
492 | * immediately after the last byte of the header. | |
493 | * | |
494 | * zmsg | |
495 | * The stream containing the header | |
496 | * | |
497 | * hdr | |
498 | * The header struct to parse into. | |
499 | * | |
500 | * Returns: | |
501 | * true if parsing succeeded, false otherwise | |
502 | */ | |
503 | extern bool zapi_parse_header(struct stream *zmsg, struct zmsghdr *hdr); | |
d62a17ae | 504 | |
e0ae31b8 DS |
505 | extern void zclient_interface_set_master(struct zclient *client, |
506 | struct interface *master, | |
507 | struct interface *slave); | |
d62a17ae | 508 | extern struct interface *zebra_interface_add_read(struct stream *, vrf_id_t); |
509 | extern struct interface *zebra_interface_state_read(struct stream *s, vrf_id_t); | |
510 | extern struct connected *zebra_interface_address_read(int, struct stream *, | |
511 | vrf_id_t); | |
512 | extern struct nbr_connected * | |
513 | zebra_interface_nbr_address_read(int, struct stream *, vrf_id_t); | |
514 | extern struct interface *zebra_interface_vrf_update_read(struct stream *s, | |
515 | vrf_id_t vrf_id, | |
516 | vrf_id_t *new_vrf_id); | |
517 | extern void zebra_interface_if_set_value(struct stream *, struct interface *); | |
518 | extern void zebra_router_id_update_read(struct stream *s, struct prefix *rid); | |
0cb76b9d DS |
519 | |
520 | #if CONFDATE > 20180823 | |
124ead27 | 521 | CPP_NOTICE("zapi_ipv4_route, zapi_ipv6_route, zapi_ipv4_route_ipv6_nexthop as well as the zapi_ipv4 and zapi_ipv6 data structures should be removed now"); |
0cb76b9d DS |
522 | #endif |
523 | ||
d62a17ae | 524 | extern int zapi_ipv4_route(u_char, struct zclient *, struct prefix_ipv4 *, |
f474e08b | 525 | struct zapi_ipv4 *) __attribute__((deprecated)); |
d62a17ae | 526 | |
527 | extern struct interface *zebra_interface_link_params_read(struct stream *); | |
528 | extern size_t zebra_interface_link_params_write(struct stream *, | |
529 | struct interface *); | |
530 | extern int lm_label_manager_connect(struct zclient *zclient); | |
531 | extern int lm_get_label_chunk(struct zclient *zclient, u_char keep, | |
532 | uint32_t chunk_size, uint32_t *start, | |
533 | uint32_t *end); | |
534 | extern int lm_release_label_chunk(struct zclient *zclient, uint32_t start, | |
535 | uint32_t end); | |
6833ae01 | 536 | extern int zebra_send_pw(struct zclient *zclient, int command, |
537 | struct zapi_pw *pw); | |
538 | extern void zebra_read_pw_status_update(int command, struct zclient *zclient, | |
539 | zebra_size_t length, vrf_id_t vrf_id, | |
540 | struct zapi_pw_status *pw); | |
541 | ||
718e3744 | 542 | /* IPv6 prefix add and delete function prototype. */ |
543 | ||
d62a17ae | 544 | struct zapi_ipv6 { |
545 | u_char type; | |
546 | u_short instance; | |
718e3744 | 547 | |
d62a17ae | 548 | u_int32_t flags; |
718e3744 | 549 | |
d62a17ae | 550 | u_char message; |
718e3744 | 551 | |
d62a17ae | 552 | safi_t safi; |
c7ec179a | 553 | |
d62a17ae | 554 | u_char nexthop_num; |
555 | struct in6_addr **nexthop; | |
718e3744 | 556 | |
d62a17ae | 557 | u_char ifindex_num; |
558 | ifindex_t *ifindex; | |
718e3744 | 559 | |
d62a17ae | 560 | u_char label_num; |
561 | unsigned int *label; | |
a64448ba | 562 | |
d62a17ae | 563 | u_char distance; |
718e3744 | 564 | |
d62a17ae | 565 | u_int32_t metric; |
0d9551dc | 566 | |
d62a17ae | 567 | route_tag_t tag; |
7076bb2f | 568 | |
d62a17ae | 569 | u_int32_t mtu; |
c50ca33a | 570 | |
d62a17ae | 571 | vrf_id_t vrf_id; |
718e3744 | 572 | }; |
573 | ||
d62a17ae | 574 | extern int zapi_ipv6_route(u_char cmd, struct zclient *zclient, |
575 | struct prefix_ipv6 *p, struct prefix_ipv6 *src_p, | |
f474e08b | 576 | struct zapi_ipv6 *api) __attribute__((deprecated)); |
d62a17ae | 577 | extern int zapi_ipv4_route_ipv6_nexthop(u_char, struct zclient *, |
578 | struct prefix_ipv4 *, | |
f474e08b RW |
579 | struct zapi_ipv6 *) |
580 | __attribute__((deprecated)); | |
0e51b4a3 | 581 | extern int zclient_route_send(u_char, struct zclient *, struct zapi_route *); |
3c192540 DS |
582 | extern int zclient_send_rnh(struct zclient *zclient, int command, |
583 | struct prefix *p, bool exact_match, | |
584 | vrf_id_t vrf_id); | |
0e51b4a3 RW |
585 | extern int zapi_route_encode(u_char, struct stream *, struct zapi_route *); |
586 | extern int zapi_route_decode(struct stream *, struct zapi_route *); | |
7ea7b86e | 587 | bool zapi_route_notify_decode(struct stream *s, struct prefix *p, |
28610f7e | 588 | uint32_t *tableid, |
7ea7b86e | 589 | enum zapi_route_notify_owner *note); |
b6c5d343 DS |
590 | bool zapi_rule_notify_decode(struct stream *s, uint32_t *seqno, |
591 | uint32_t *priority, uint32_t *unique, | |
592 | ifindex_t *ifindex, | |
593 | enum zapi_rule_notify_owner *note); | |
4a749e2c DS |
594 | extern struct nexthop *nexthop_from_zapi_nexthop(struct zapi_nexthop *znh); |
595 | extern bool zapi_nexthop_update_decode(struct stream *s, | |
596 | struct zapi_route *nhr); | |
718e3744 | 597 | |
09a484dd | 598 | static inline void zapi_route_set_blackhole(struct zapi_route *api, |
60466a63 | 599 | enum blackhole_type bh_type) |
09a484dd DL |
600 | { |
601 | api->nexthop_num = 1; | |
602 | api->nexthops[0].type = NEXTHOP_TYPE_BLACKHOLE; | |
4a7371e9 | 603 | api->nexthops[0].vrf_id = VRF_DEFAULT; |
09a484dd DL |
604 | api->nexthops[0].bh_type = bh_type; |
605 | SET_FLAG(api->message, ZAPI_MESSAGE_NEXTHOP); | |
606 | }; | |
607 | ||
608 | ||
718e3744 | 609 | #endif /* _ZEBRA_ZCLIENT_H */ |