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