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