1 /* Zebra's client header.
2 * Copyright (C) 1999 Kunihiro Ishiguro
4 * This file is part of GNU Zebra.
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)
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.
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
21 #ifndef _ZEBRA_ZCLIENT_H
22 #define _ZEBRA_ZCLIENT_H
24 /* For struct zapi_route. */
27 /* For struct interface and struct connected. */
30 /* For vrf_bitmap_t. */
33 /* For union g_addr */
36 /* For union pw_protocol_fields */
39 /* For input/output buffer to zebra. */
40 #define ZEBRA_MAX_PACKET_SIZ 16384
42 /* Zebra header size. */
43 #define ZEBRA_HEADER_SIZE 10
45 /* special socket path name to use TCP
46 * @ is used as first character because that's abstract socket names on Linux
48 #define ZAPI_TCP_PATHNAME "@tcp"
50 extern struct sockaddr_storage zclient_addr
;
51 extern socklen_t zclient_addr_len
;
53 /* Zebra message types. */
56 ZEBRA_INTERFACE_DELETE
,
57 ZEBRA_INTERFACE_ADDRESS_ADD
,
58 ZEBRA_INTERFACE_ADDRESS_DELETE
,
61 ZEBRA_INTERFACE_SET_MASTER
,
64 ZEBRA_ROUTE_NOTIFY_OWNER
,
66 ZEBRA_IPV4_ROUTE_DELETE
,
68 ZEBRA_IPV6_ROUTE_DELETE
,
69 ZEBRA_REDISTRIBUTE_ADD
,
70 ZEBRA_REDISTRIBUTE_DELETE
,
71 ZEBRA_REDISTRIBUTE_DEFAULT_ADD
,
72 ZEBRA_REDISTRIBUTE_DEFAULT_DELETE
,
74 ZEBRA_ROUTER_ID_DELETE
,
75 ZEBRA_ROUTER_ID_UPDATE
,
77 ZEBRA_NEXTHOP_REGISTER
,
78 ZEBRA_NEXTHOP_UNREGISTER
,
80 ZEBRA_INTERFACE_NBR_ADDRESS_ADD
,
81 ZEBRA_INTERFACE_NBR_ADDRESS_DELETE
,
82 ZEBRA_INTERFACE_BFD_DEST_UPDATE
,
83 ZEBRA_IMPORT_ROUTE_REGISTER
,
84 ZEBRA_IMPORT_ROUTE_UNREGISTER
,
85 ZEBRA_IMPORT_CHECK_UPDATE
,
86 ZEBRA_IPV4_ROUTE_IPV6_NEXTHOP_ADD
,
87 ZEBRA_BFD_DEST_REGISTER
,
88 ZEBRA_BFD_DEST_DEREGISTER
,
89 ZEBRA_BFD_DEST_UPDATE
,
90 ZEBRA_BFD_DEST_REPLAY
,
91 ZEBRA_REDISTRIBUTE_ROUTE_ADD
,
92 ZEBRA_REDISTRIBUTE_ROUTE_DEL
,
97 ZEBRA_INTERFACE_VRF_UPDATE
,
98 ZEBRA_BFD_CLIENT_REGISTER
,
99 ZEBRA_INTERFACE_ENABLE_RADV
,
100 ZEBRA_INTERFACE_DISABLE_RADV
,
101 ZEBRA_IPV4_NEXTHOP_LOOKUP_MRIB
,
102 ZEBRA_INTERFACE_LINK_PARAMS
,
103 ZEBRA_MPLS_LABELS_ADD
,
104 ZEBRA_MPLS_LABELS_DELETE
,
105 ZEBRA_IPMR_ROUTE_STATS
,
106 ZEBRA_LABEL_MANAGER_CONNECT
,
107 ZEBRA_GET_LABEL_CHUNK
,
108 ZEBRA_RELEASE_LABEL_CHUNK
,
110 ZEBRA_FEC_UNREGISTER
,
112 ZEBRA_ADVERTISE_DEFAULT_GW
,
113 ZEBRA_ADVERTISE_SUBNET
,
114 ZEBRA_ADVERTISE_ALL_VNI
,
119 ZEBRA_REMOTE_VTEP_ADD
,
120 ZEBRA_REMOTE_VTEP_DEL
,
123 ZEBRA_IP_PREFIX_ROUTE_ADD
,
124 ZEBRA_IP_PREFIX_ROUTE_DEL
,
125 ZEBRA_REMOTE_MACIP_ADD
,
126 ZEBRA_REMOTE_MACIP_DEL
,
131 ZEBRA_PW_STATUS_UPDATE
,
134 ZEBRA_RULE_NOTIFY_OWNER
,
135 } zebra_message_types_t
;
137 struct redist_proto
{
139 struct list
*instances
;
142 /* Structure for the zebra client. */
144 /* The thread master we schedule ourselves on */
145 struct thread_master
*master
;
147 /* Priviledges to change socket values */
148 struct zebra_privs_t
*privs
;
150 /* Do we care about failure events for route install? */
153 /* Socket to zebra daemon. */
156 /* Connection failure count. */
159 /* Input buffer for zebra message. */
162 /* Output buffer for zebra message. */
165 /* Buffer of data waiting to be written to zebra. */
168 /* Read and connect thread. */
169 struct thread
*t_read
;
170 struct thread
*t_connect
;
172 /* Thread to write buffered data to zebra. */
173 struct thread
*t_write
;
175 /* Redistribute information. */
176 u_char redist_default
; /* clients protocol */
178 struct redist_proto mi_redist
[AFI_MAX
][ZEBRA_ROUTE_MAX
];
179 vrf_bitmap_t redist
[AFI_MAX
][ZEBRA_ROUTE_MAX
];
181 /* Redistribute defauilt. */
182 vrf_bitmap_t default_information
;
184 /* Pointer to the callback functions. */
185 void (*zebra_connected
)(struct zclient
*);
186 int (*router_id_update
)(int, struct zclient
*, uint16_t, vrf_id_t
);
187 int (*interface_add
)(int, struct zclient
*, uint16_t, vrf_id_t
);
188 int (*interface_delete
)(int, struct zclient
*, uint16_t, vrf_id_t
);
189 int (*interface_up
)(int, struct zclient
*, uint16_t, vrf_id_t
);
190 int (*interface_down
)(int, struct zclient
*, uint16_t, vrf_id_t
);
191 int (*interface_address_add
)(int, struct zclient
*, uint16_t, vrf_id_t
);
192 int (*interface_address_delete
)(int, struct zclient
*, uint16_t,
194 int (*interface_link_params
)(int, struct zclient
*, uint16_t);
195 int (*interface_bfd_dest_update
)(int, struct zclient
*, uint16_t,
197 int (*interface_nbr_address_add
)(int, struct zclient
*, uint16_t,
199 int (*interface_nbr_address_delete
)(int, struct zclient
*, uint16_t,
201 int (*interface_vrf_update
)(int, struct zclient
*, uint16_t, vrf_id_t
);
202 int (*nexthop_update
)(int, struct zclient
*, uint16_t, vrf_id_t
);
203 int (*import_check_update
)(int, struct zclient
*, uint16_t, vrf_id_t
);
204 int (*bfd_dest_replay
)(int, struct zclient
*, uint16_t, vrf_id_t
);
205 int (*redistribute_route_add
)(int, struct zclient
*, uint16_t,
207 int (*redistribute_route_del
)(int, struct zclient
*, uint16_t,
209 int (*fec_update
)(int, struct zclient
*, uint16_t);
210 int (*local_vni_add
)(int, struct zclient
*, uint16_t, vrf_id_t
);
211 int (*local_vni_del
)(int, struct zclient
*, uint16_t, vrf_id_t
);
212 int (*local_l3vni_add
)(int, struct zclient
*, uint16_t, vrf_id_t
);
213 int (*local_l3vni_del
)(int, struct zclient
*, uint16_t, vrf_id_t
);
214 void (*local_ip_prefix_add
)(int, struct zclient
*, uint16_t, vrf_id_t
);
215 void (*local_ip_prefix_del
)(int, struct zclient
*, uint16_t, vrf_id_t
);
216 int (*local_macip_add
)(int, struct zclient
*, uint16_t, vrf_id_t
);
217 int (*local_macip_del
)(int, struct zclient
*, uint16_t, vrf_id_t
);
218 int (*pw_status_update
)(int, struct zclient
*, uint16_t, vrf_id_t
);
219 int (*route_notify_owner
)(int command
, struct zclient
*zclient
,
220 uint16_t length
, vrf_id_t vrf_id
);
221 int (*rule_notify_owner
)(int command
, struct zclient
*zclient
,
222 uint16_t length
, vrf_id_t vrf_id
);
225 /* Zebra API message flag. */
226 #define ZAPI_MESSAGE_NEXTHOP 0x01
227 #define ZAPI_MESSAGE_DISTANCE 0x02
228 #define ZAPI_MESSAGE_METRIC 0x04
229 #define ZAPI_MESSAGE_TAG 0x08
230 #define ZAPI_MESSAGE_MTU 0x10
231 #define ZAPI_MESSAGE_SRCPFX 0x20
232 #define ZAPI_MESSAGE_LABEL 0x40
234 * This should only be used by a DAEMON that needs to communicate
235 * the table being used is not in the VRF. You must pass the
236 * default vrf, else this will be ignored.
238 #define ZAPI_MESSAGE_TABLEID 0x80
240 #define ZSERV_VERSION 5
241 /* Zserv protocol message header */
244 /* Always set to 255 in new zserv */
251 struct zapi_nexthop
{
252 enum nexthop_types_t type
;
257 enum blackhole_type bh_type
;
260 /* MPLS labels for BGP-LU or Segment Routing */
262 mpls_label_t labels
[MPLS_MAX_LABELS
];
266 * Some of these data structures do not map easily to
267 * a actual data structure size giving different compilers
268 * and systems. For those data structures we need
269 * to use the smallest available stream_getX/putX functions
281 * This is an enum but we are going to treat it as a uint8_t
282 * for purpose of encoding/decoding
286 struct prefix prefix
;
287 struct prefix_ipv6 src_prefix
;
289 u_int16_t nexthop_num
;
290 struct zapi_nexthop nexthops
[MULTIPATH_NUM
];
307 /* Zebra IPv4 route message API. */
319 struct in_addr
**nexthop
;
339 char ifname
[IF_NAMESIZE
];
343 union g_addr nexthop
;
344 uint32_t local_label
;
345 uint32_t remote_label
;
347 union pw_protocol_fields data
;
351 struct zapi_pw_status
{
352 char ifname
[IF_NAMESIZE
];
357 enum zapi_route_notify_owner
{
358 ZAPI_ROUTE_FAIL_INSTALL
,
359 ZAPI_ROUTE_BETTER_ADMIN_WON
,
360 ZAPI_ROUTE_INSTALLED
,
362 ZAPI_ROUTE_REMOVE_FAIL
,
365 enum zapi_rule_notify_owner
{
366 ZAPI_RULE_FAIL_INSTALL
,
371 /* Zebra MAC types */
372 #define ZEBRA_MACIP_TYPE_STICKY 0x01 /* Sticky MAC*/
373 #define ZEBRA_MACIP_TYPE_GW 0x02 /* gateway (SVI) mac*/
375 struct zclient_options
{
379 /* Prototypes of zebra client service functions. */
380 extern struct zclient
*zclient_new(struct thread_master
*);
382 /* clang-format off */
383 #if CONFDATE > 20181101
384 CPP_NOTICE("zclient_new_notify can take over or zclient_new now");
386 /* clang-format on */
388 extern struct zclient_options zclient_options_default
;
390 extern struct zclient
*zclient_new_notify(struct thread_master
*m
,
391 struct zclient_options
*opt
);
393 #define zclient_new(A) \
394 zclient_new_notify((A), &zclient_options_default); \
395 CPP_WARN("Please transition to using zclient_new_notify");
397 extern void zclient_init(struct zclient
*, int, u_short
,
398 struct zebra_privs_t
*privs
);
399 extern int zclient_start(struct zclient
*);
400 extern void zclient_stop(struct zclient
*);
401 extern void zclient_reset(struct zclient
*);
402 extern void zclient_free(struct zclient
*);
404 extern int zclient_socket_connect(struct zclient
*);
406 extern u_short
*redist_check_instance(struct redist_proto
*, u_short
);
407 extern void redist_add_instance(struct redist_proto
*, u_short
);
408 extern void redist_del_instance(struct redist_proto
*, u_short
);
411 * Send to zebra that the specified vrf is using label to resolve
412 * itself for L3VPN's. Repeated calls of this function with
413 * different labels will cause an effective update of the
414 * label for lookup. If you pass in MPLS_LABEL_NONE
415 * we will cause a delete action and remove this label pop
418 * The underlying AF_MPLS doesn't care about afi's
419 * but we can make the zebra_vrf keep track of what
420 * we have installed and play some special games
421 * to get them both installed.
423 extern void zclient_send_vrf_label(struct zclient
*zclient
, vrf_id_t vrf_id
,
424 afi_t afi
, mpls_label_t label
,
425 enum lsp_types_t ltype
);
427 extern void zclient_send_reg_requests(struct zclient
*, vrf_id_t
);
428 extern void zclient_send_dereg_requests(struct zclient
*, vrf_id_t
);
430 extern void zclient_send_interface_radv_req(struct zclient
*zclient
,
432 struct interface
*ifp
, int enable
,
435 /* Send redistribute command to zebra daemon. Do not update zclient state. */
436 extern int zebra_redistribute_send(int command
, struct zclient
*, afi_t
,
437 int type
, u_short instance
, vrf_id_t vrf_id
);
439 /* If state has changed, update state and call zebra_redistribute_send. */
440 extern void zclient_redistribute(int command
, struct zclient
*, afi_t
, int type
,
441 u_short instance
, vrf_id_t vrf_id
);
443 /* If state has changed, update state and send the command to zebra. */
444 extern void zclient_redistribute_default(int command
, struct zclient
*,
447 /* Send the message in zclient->obuf to the zebra daemon (or enqueue it).
448 Returns 0 for success or -1 on an I/O error. */
449 extern int zclient_send_message(struct zclient
*);
451 /* create header for command, length to be filled in by user later */
452 extern void zclient_create_header(struct stream
*, uint16_t, vrf_id_t
);
454 * Read sizeof(struct zmsghdr) bytes from the provided socket and parse the
455 * received data into the specified fields. If this is successful, read the
456 * rest of the packet into the provided stream.
459 * The stream to read into
462 * The socket to read from
465 * Parsed message size will be placed in the pointed-at integer
468 * Parsed marker will be placed in the pointed-at byte
471 * Parsed version will be placed in the pointed-at byte
474 * Parsed VRF ID will be placed in the pointed-at vrf_id_t
477 * Parsed command number will be placed in the pointed-at integer
481 * - insufficient data for header was read
482 * - a version mismatch was detected
483 * - a marker mismatch was detected
484 * - header size field specified more data than could be read
486 extern int zclient_read_header(struct stream
*s
, int sock
, u_int16_t
*size
,
487 u_char
*marker
, u_char
*version
,
488 vrf_id_t
*vrf_id
, u_int16_t
*cmd
);
490 * Parse header from ZAPI message stream into struct zmsghdr.
491 * This function assumes the stream getp points at the first byte of the header.
492 * If the function is successful then the stream getp will point to the byte
493 * immediately after the last byte of the header.
496 * The stream containing the header
499 * The header struct to parse into.
502 * true if parsing succeeded, false otherwise
504 extern bool zapi_parse_header(struct stream
*zmsg
, struct zmsghdr
*hdr
);
506 extern void zclient_interface_set_master(struct zclient
*client
,
507 struct interface
*master
,
508 struct interface
*slave
);
509 extern struct interface
*zebra_interface_add_read(struct stream
*, vrf_id_t
);
510 extern struct interface
*zebra_interface_state_read(struct stream
*s
, vrf_id_t
);
511 extern struct connected
*zebra_interface_address_read(int, struct stream
*,
513 extern struct nbr_connected
*
514 zebra_interface_nbr_address_read(int, struct stream
*, vrf_id_t
);
515 extern struct interface
*zebra_interface_vrf_update_read(struct stream
*s
,
517 vrf_id_t
*new_vrf_id
);
518 extern void zebra_interface_if_set_value(struct stream
*, struct interface
*);
519 extern void zebra_router_id_update_read(struct stream
*s
, struct prefix
*rid
);
521 /* clang-format off */
522 #if CONFDATE > 20180823
523 CPP_NOTICE("zapi_ipv4_route, zapi_ipv6_route, zapi_ipv4_route_ipv6_nexthop as well as the zapi_ipv4 and zapi_ipv6 data structures should be removed now");
525 /* clang-format on */
527 extern int zapi_ipv4_route(u_char
, struct zclient
*, struct prefix_ipv4
*,
528 struct zapi_ipv4
*) __attribute__((deprecated
));
530 extern struct interface
*zebra_interface_link_params_read(struct stream
*);
531 extern size_t zebra_interface_link_params_write(struct stream
*,
533 extern int lm_label_manager_connect(struct zclient
*zclient
);
534 extern int lm_get_label_chunk(struct zclient
*zclient
, u_char keep
,
535 uint32_t chunk_size
, uint32_t *start
,
537 extern int lm_release_label_chunk(struct zclient
*zclient
, uint32_t start
,
539 extern int zebra_send_pw(struct zclient
*zclient
, int command
,
541 extern void zebra_read_pw_status_update(int command
, struct zclient
*zclient
,
542 zebra_size_t length
, vrf_id_t vrf_id
,
543 struct zapi_pw_status
*pw
);
545 /* IPv6 prefix add and delete function prototype. */
558 struct in6_addr
**nexthop
;
577 extern int zapi_ipv6_route(u_char cmd
, struct zclient
*zclient
,
578 struct prefix_ipv6
*p
, struct prefix_ipv6
*src_p
,
579 struct zapi_ipv6
*api
) __attribute__((deprecated
));
580 extern int zapi_ipv4_route_ipv6_nexthop(u_char
, struct zclient
*,
581 struct prefix_ipv4
*,
583 __attribute__((deprecated
));
584 extern int zclient_route_send(u_char
, struct zclient
*, struct zapi_route
*);
585 extern int zclient_send_rnh(struct zclient
*zclient
, int command
,
586 struct prefix
*p
, bool exact_match
,
588 extern int zapi_route_encode(u_char
, struct stream
*, struct zapi_route
*);
589 extern int zapi_route_decode(struct stream
*, struct zapi_route
*);
590 bool zapi_route_notify_decode(struct stream
*s
, struct prefix
*p
,
592 enum zapi_route_notify_owner
*note
);
593 bool zapi_rule_notify_decode(struct stream
*s
, uint32_t *seqno
,
594 uint32_t *priority
, uint32_t *unique
,
596 enum zapi_rule_notify_owner
*note
);
597 extern struct nexthop
*nexthop_from_zapi_nexthop(struct zapi_nexthop
*znh
);
598 extern bool zapi_nexthop_update_decode(struct stream
*s
,
599 struct zapi_route
*nhr
);
601 static inline void zapi_route_set_blackhole(struct zapi_route
*api
,
602 enum blackhole_type bh_type
)
604 api
->nexthop_num
= 1;
605 api
->nexthops
[0].type
= NEXTHOP_TYPE_BLACKHOLE
;
606 api
->nexthops
[0].vrf_id
= VRF_DEFAULT
;
607 api
->nexthops
[0].bh_type
= bh_type
;
608 SET_FLAG(api
->message
, ZAPI_MESSAGE_NEXTHOP
);
612 #endif /* _ZEBRA_ZCLIENT_H */