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