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