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