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