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