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 /* IPset size name stands for the name of the ipset entry
51 * that can be created by using some zapi interfaces
53 #define ZEBRA_IPSET_NAME_SIZE 32
55 /* IPTable action is defined by two values: either
58 #define ZEBRA_IPTABLES_FORWARD 0
59 #define ZEBRA_IPTABLES_DROP 1
61 extern struct sockaddr_storage zclient_addr
;
62 extern socklen_t zclient_addr_len
;
64 /* Zebra message types. */
67 ZEBRA_INTERFACE_DELETE
,
68 ZEBRA_INTERFACE_ADDRESS_ADD
,
69 ZEBRA_INTERFACE_ADDRESS_DELETE
,
72 ZEBRA_INTERFACE_SET_MASTER
,
75 ZEBRA_ROUTE_NOTIFY_OWNER
,
77 ZEBRA_IPV4_ROUTE_DELETE
,
79 ZEBRA_IPV6_ROUTE_DELETE
,
80 ZEBRA_REDISTRIBUTE_ADD
,
81 ZEBRA_REDISTRIBUTE_DELETE
,
82 ZEBRA_REDISTRIBUTE_DEFAULT_ADD
,
83 ZEBRA_REDISTRIBUTE_DEFAULT_DELETE
,
85 ZEBRA_ROUTER_ID_DELETE
,
86 ZEBRA_ROUTER_ID_UPDATE
,
89 ZEBRA_NEXTHOP_REGISTER
,
90 ZEBRA_NEXTHOP_UNREGISTER
,
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
,
98 ZEBRA_IPV4_ROUTE_IPV6_NEXTHOP_ADD
,
99 ZEBRA_BFD_DEST_REGISTER
,
100 ZEBRA_BFD_DEST_DEREGISTER
,
101 ZEBRA_BFD_DEST_UPDATE
,
102 ZEBRA_BFD_DEST_REPLAY
,
103 ZEBRA_REDISTRIBUTE_ROUTE_ADD
,
104 ZEBRA_REDISTRIBUTE_ROUTE_DEL
,
105 ZEBRA_VRF_UNREGISTER
,
109 ZEBRA_INTERFACE_VRF_UPDATE
,
110 ZEBRA_BFD_CLIENT_REGISTER
,
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
,
117 ZEBRA_IPMR_ROUTE_STATS
,
118 ZEBRA_LABEL_MANAGER_CONNECT
,
119 ZEBRA_GET_LABEL_CHUNK
,
120 ZEBRA_RELEASE_LABEL_CHUNK
,
122 ZEBRA_FEC_UNREGISTER
,
124 ZEBRA_ADVERTISE_DEFAULT_GW
,
125 ZEBRA_ADVERTISE_SUBNET
,
126 ZEBRA_ADVERTISE_ALL_VNI
,
133 ZEBRA_REMOTE_VTEP_ADD
,
134 ZEBRA_REMOTE_VTEP_DEL
,
137 ZEBRA_IP_PREFIX_ROUTE_ADD
,
138 ZEBRA_IP_PREFIX_ROUTE_DEL
,
139 ZEBRA_REMOTE_MACIP_ADD
,
140 ZEBRA_REMOTE_MACIP_DEL
,
145 ZEBRA_PW_STATUS_UPDATE
,
148 ZEBRA_RULE_NOTIFY_OWNER
,
149 ZEBRA_TABLE_MANAGER_CONNECT
,
150 ZEBRA_GET_TABLE_CHUNK
,
151 ZEBRA_RELEASE_TABLE_CHUNK
,
154 ZEBRA_IPSET_ENTRY_ADD
,
155 ZEBRA_IPSET_ENTRY_DELETE
,
156 ZEBRA_IPSET_NOTIFY_OWNER
,
157 ZEBRA_IPSET_ENTRY_NOTIFY_OWNER
,
159 ZEBRA_IPTABLE_DELETE
,
160 ZEBRA_IPTABLE_NOTIFY_OWNER
,
161 } zebra_message_types_t
;
163 struct redist_proto
{
165 struct list
*instances
;
168 struct zclient_capabilities
{
173 /* Structure for the zebra client. */
175 /* The thread master we schedule ourselves on */
176 struct thread_master
*master
;
178 /* Priviledges to change socket values */
179 struct zebra_privs_t
*privs
;
181 /* Do we care about failure events for route install? */
184 /* Socket to zebra daemon. */
187 /* Connection failure count. */
190 /* Input buffer for zebra message. */
193 /* Output buffer for zebra message. */
196 /* Buffer of data waiting to be written to zebra. */
199 /* Read and connect thread. */
200 struct thread
*t_read
;
201 struct thread
*t_connect
;
203 /* Thread to write buffered data to zebra. */
204 struct thread
*t_write
;
206 /* Redistribute information. */
207 uint8_t redist_default
; /* clients protocol */
208 unsigned short instance
;
209 struct redist_proto mi_redist
[AFI_MAX
][ZEBRA_ROUTE_MAX
];
210 vrf_bitmap_t redist
[AFI_MAX
][ZEBRA_ROUTE_MAX
];
212 /* Redistribute defauilt. */
213 vrf_bitmap_t default_information
;
215 /* Pointer to the callback functions. */
216 void (*zebra_connected
)(struct zclient
*);
217 void (*zebra_capabilities
)(struct zclient_capabilities
*cap
);
218 int (*router_id_update
)(int, struct zclient
*, uint16_t, vrf_id_t
);
219 int (*interface_add
)(int, struct zclient
*, uint16_t, vrf_id_t
);
220 int (*interface_delete
)(int, struct zclient
*, uint16_t, vrf_id_t
);
221 int (*interface_up
)(int, struct zclient
*, uint16_t, vrf_id_t
);
222 int (*interface_down
)(int, struct zclient
*, uint16_t, vrf_id_t
);
223 int (*interface_address_add
)(int, struct zclient
*, uint16_t, vrf_id_t
);
224 int (*interface_address_delete
)(int, struct zclient
*, uint16_t,
226 int (*interface_link_params
)(int, struct zclient
*, uint16_t);
227 int (*interface_bfd_dest_update
)(int, struct zclient
*, uint16_t,
229 int (*interface_nbr_address_add
)(int, struct zclient
*, uint16_t,
231 int (*interface_nbr_address_delete
)(int, struct zclient
*, uint16_t,
233 int (*interface_vrf_update
)(int, struct zclient
*, uint16_t, vrf_id_t
);
234 int (*nexthop_update
)(int, struct zclient
*, uint16_t, vrf_id_t
);
235 int (*import_check_update
)(int, struct zclient
*, uint16_t, vrf_id_t
);
236 int (*bfd_dest_replay
)(int, struct zclient
*, uint16_t, vrf_id_t
);
237 int (*redistribute_route_add
)(int, struct zclient
*, uint16_t,
239 int (*redistribute_route_del
)(int, struct zclient
*, uint16_t,
241 int (*fec_update
)(int, struct zclient
*, uint16_t);
242 int (*local_es_add
)(int command
, struct zclient
*zclient
,
243 uint16_t length
, vrf_id_t vrf_id
);
244 int (*local_es_del
)(int command
, struct zclient
*zclient
,
245 uint16_t length
, vrf_id_t vrf_id
);
246 int (*local_vni_add
)(int, struct zclient
*, uint16_t, vrf_id_t
);
247 int (*local_vni_del
)(int, struct zclient
*, uint16_t, vrf_id_t
);
248 int (*local_l3vni_add
)(int, struct zclient
*, uint16_t, vrf_id_t
);
249 int (*local_l3vni_del
)(int, struct zclient
*, uint16_t, vrf_id_t
);
250 void (*local_ip_prefix_add
)(int, struct zclient
*, uint16_t, vrf_id_t
);
251 void (*local_ip_prefix_del
)(int, struct zclient
*, uint16_t, vrf_id_t
);
252 int (*local_macip_add
)(int, struct zclient
*, uint16_t, vrf_id_t
);
253 int (*local_macip_del
)(int, struct zclient
*, uint16_t, vrf_id_t
);
254 int (*pw_status_update
)(int, struct zclient
*, uint16_t, vrf_id_t
);
255 int (*route_notify_owner
)(int command
, struct zclient
*zclient
,
256 uint16_t length
, vrf_id_t vrf_id
);
257 int (*rule_notify_owner
)(int command
, struct zclient
*zclient
,
258 uint16_t length
, vrf_id_t vrf_id
);
259 void (*label_chunk
)(int command
, struct zclient
*zclient
,
260 uint16_t length
, vrf_id_t vrf_id
);
261 int (*ipset_notify_owner
)(int command
, struct zclient
*zclient
,
262 uint16_t length
, vrf_id_t vrf_id
);
263 int (*ipset_entry_notify_owner
)(int command
,
264 struct zclient
*zclient
,
267 int (*iptable_notify_owner
)(int command
,
268 struct zclient
*zclient
,
273 /* Zebra API message flag. */
274 #define ZAPI_MESSAGE_NEXTHOP 0x01
275 #define ZAPI_MESSAGE_DISTANCE 0x02
276 #define ZAPI_MESSAGE_METRIC 0x04
277 #define ZAPI_MESSAGE_TAG 0x08
278 #define ZAPI_MESSAGE_MTU 0x10
279 #define ZAPI_MESSAGE_SRCPFX 0x20
280 #define ZAPI_MESSAGE_LABEL 0x40
282 * This should only be used by a DAEMON that needs to communicate
283 * the table being used is not in the VRF. You must pass the
284 * default vrf, else this will be ignored.
286 #define ZAPI_MESSAGE_TABLEID 0x80
288 #define ZSERV_VERSION 5
289 /* Zserv protocol message header */
292 /* Always set to 255 in new zserv */
299 struct zapi_nexthop
{
300 enum nexthop_types_t type
;
305 enum blackhole_type bh_type
;
308 /* MPLS labels for BGP-LU or Segment Routing */
310 mpls_label_t labels
[MPLS_MAX_LABELS
];
316 * Some of these data structures do not map easily to
317 * a actual data structure size giving different compilers
318 * and systems. For those data structures we need
319 * to use the smallest available stream_getX/putX functions
324 unsigned short instance
;
331 * This is an enum but we are going to treat it as a uint8_t
332 * for purpose of encoding/decoding
336 struct prefix prefix
;
337 struct prefix_ipv6 src_prefix
;
339 uint16_t nexthop_num
;
340 struct zapi_nexthop nexthops
[MULTIPATH_NUM
];
355 /* Zebra IPv4 route message API. */
358 unsigned short instance
;
367 struct in_addr
**nexthop
;
387 char ifname
[IF_NAMESIZE
];
391 union g_addr nexthop
;
392 uint32_t local_label
;
393 uint32_t remote_label
;
395 union pw_protocol_fields data
;
399 struct zapi_pw_status
{
400 char ifname
[IF_NAMESIZE
];
405 enum zapi_route_notify_owner
{
406 ZAPI_ROUTE_FAIL_INSTALL
,
407 ZAPI_ROUTE_BETTER_ADMIN_WON
,
408 ZAPI_ROUTE_INSTALLED
,
410 ZAPI_ROUTE_REMOVE_FAIL
,
413 enum zapi_rule_notify_owner
{
414 ZAPI_RULE_FAIL_INSTALL
,
417 ZAPI_RULE_FAIL_REMOVE
,
427 enum zapi_ipset_notify_owner
{
428 ZAPI_IPSET_FAIL_INSTALL
,
429 ZAPI_IPSET_INSTALLED
,
431 ZAPI_IPSET_FAIL_REMOVE
,
434 enum zapi_ipset_entry_notify_owner
{
435 ZAPI_IPSET_ENTRY_FAIL_INSTALL
,
436 ZAPI_IPSET_ENTRY_INSTALLED
,
437 ZAPI_IPSET_ENTRY_REMOVED
,
438 ZAPI_IPSET_ENTRY_FAIL_REMOVE
,
441 enum zapi_iptable_notify_owner
{
442 ZAPI_IPTABLE_FAIL_INSTALL
,
443 ZAPI_IPTABLE_INSTALLED
,
444 ZAPI_IPTABLE_REMOVED
,
445 ZAPI_IPTABLE_FAIL_REMOVE
,
448 /* Zebra MAC types */
449 #define ZEBRA_MACIP_TYPE_STICKY 0x01 /* Sticky MAC*/
450 #define ZEBRA_MACIP_TYPE_GW 0x02 /* gateway (SVI) mac*/
452 struct zclient_options
{
456 /* Prototypes of zebra client service functions. */
457 extern struct zclient
*zclient_new(struct thread_master
*);
459 /* clang-format off */
460 #if defined(VERSION_TYPE_DEV) && CONFDATE > 20181101
461 CPP_NOTICE("zclient_new_notify can take over or zclient_new now");
463 /* clang-format on */
465 extern struct zclient_options zclient_options_default
;
467 extern struct zclient
*zclient_new_notify(struct thread_master
*m
,
468 struct zclient_options
*opt
);
470 #define zclient_new(A) \
471 zclient_new_notify((A), &zclient_options_default); \
472 CPP_WARN("Please transition to using zclient_new_notify");
474 extern void zclient_init(struct zclient
*, int, unsigned short,
475 struct zebra_privs_t
*privs
);
476 extern int zclient_start(struct zclient
*);
477 extern void zclient_stop(struct zclient
*);
478 extern void zclient_reset(struct zclient
*);
479 extern void zclient_free(struct zclient
*);
481 extern int zclient_socket_connect(struct zclient
*);
483 extern unsigned short *redist_check_instance(struct redist_proto
*,
485 extern void redist_add_instance(struct redist_proto
*, unsigned short);
486 extern void redist_del_instance(struct redist_proto
*, unsigned short);
489 * Send to zebra that the specified vrf is using label to resolve
490 * itself for L3VPN's. Repeated calls of this function with
491 * different labels will cause an effective update of the
492 * label for lookup. If you pass in MPLS_LABEL_NONE
493 * we will cause a delete action and remove this label pop
496 * The underlying AF_MPLS doesn't care about afi's
497 * but we can make the zebra_vrf keep track of what
498 * we have installed and play some special games
499 * to get them both installed.
501 extern void zclient_send_vrf_label(struct zclient
*zclient
, vrf_id_t vrf_id
,
502 afi_t afi
, mpls_label_t label
,
503 enum lsp_types_t ltype
);
505 extern void zclient_send_reg_requests(struct zclient
*, vrf_id_t
);
506 extern void zclient_send_dereg_requests(struct zclient
*, vrf_id_t
);
508 extern void zclient_send_interface_radv_req(struct zclient
*zclient
,
510 struct interface
*ifp
, int enable
,
513 /* Send redistribute command to zebra daemon. Do not update zclient state. */
514 extern int zebra_redistribute_send(int command
, struct zclient
*, afi_t
,
515 int type
, unsigned short instance
,
518 /* If state has changed, update state and call zebra_redistribute_send. */
519 extern void zclient_redistribute(int command
, struct zclient
*, afi_t
, int type
,
520 unsigned short instance
, vrf_id_t vrf_id
);
522 /* If state has changed, update state and send the command to zebra. */
523 extern void zclient_redistribute_default(int command
, struct zclient
*,
526 /* Send the message in zclient->obuf to the zebra daemon (or enqueue it).
527 Returns 0 for success or -1 on an I/O error. */
528 extern int zclient_send_message(struct zclient
*);
530 /* create header for command, length to be filled in by user later */
531 extern void zclient_create_header(struct stream
*, uint16_t, vrf_id_t
);
533 * Read sizeof(struct zmsghdr) bytes from the provided socket and parse the
534 * received data into the specified fields. If this is successful, read the
535 * rest of the packet into the provided stream.
538 * The stream to read into
541 * The socket to read from
544 * Parsed message size will be placed in the pointed-at integer
547 * Parsed marker will be placed in the pointed-at byte
550 * Parsed version will be placed in the pointed-at byte
553 * Parsed VRF ID will be placed in the pointed-at vrf_id_t
556 * Parsed command number will be placed in the pointed-at integer
560 * - insufficient data for header was read
561 * - a version mismatch was detected
562 * - a marker mismatch was detected
563 * - header size field specified more data than could be read
565 extern int zclient_read_header(struct stream
*s
, int sock
, uint16_t *size
,
566 uint8_t *marker
, uint8_t *version
,
567 vrf_id_t
*vrf_id
, uint16_t *cmd
);
569 * Parse header from ZAPI message stream into struct zmsghdr.
570 * This function assumes the stream getp points at the first byte of the header.
571 * If the function is successful then the stream getp will point to the byte
572 * immediately after the last byte of the header.
575 * The stream containing the header
578 * The header struct to parse into.
581 * true if parsing succeeded, false otherwise
583 extern bool zapi_parse_header(struct stream
*zmsg
, struct zmsghdr
*hdr
);
585 extern void zclient_interface_set_master(struct zclient
*client
,
586 struct interface
*master
,
587 struct interface
*slave
);
588 extern struct interface
*zebra_interface_add_read(struct stream
*, vrf_id_t
);
589 extern struct interface
*zebra_interface_state_read(struct stream
*s
, vrf_id_t
);
590 extern struct connected
*zebra_interface_address_read(int, struct stream
*,
592 extern struct nbr_connected
*
593 zebra_interface_nbr_address_read(int, struct stream
*, vrf_id_t
);
594 extern struct interface
*zebra_interface_vrf_update_read(struct stream
*s
,
596 vrf_id_t
*new_vrf_id
);
597 extern void zebra_interface_if_set_value(struct stream
*, struct interface
*);
598 extern void zebra_router_id_update_read(struct stream
*s
, struct prefix
*rid
);
600 /* clang-format off */
601 #if defined(VERSION_TYPE_DEV) && CONFDATE > 20180823
602 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");
604 /* clang-format on */
606 extern int zapi_ipv4_route(uint8_t, struct zclient
*, struct prefix_ipv4
*,
607 struct zapi_ipv4
*) __attribute__((deprecated
));
609 extern struct interface
*zebra_interface_link_params_read(struct stream
*);
610 extern size_t zebra_interface_link_params_write(struct stream
*,
612 extern int zclient_send_get_label_chunk(
613 struct zclient
*zclient
,
615 uint32_t chunk_size
);
617 extern int lm_label_manager_connect(struct zclient
*zclient
);
618 extern int lm_get_label_chunk(struct zclient
*zclient
, uint8_t keep
,
619 uint32_t chunk_size
, uint32_t *start
,
621 extern int lm_release_label_chunk(struct zclient
*zclient
, uint32_t start
,
623 extern int tm_table_manager_connect(struct zclient
*zclient
);
624 extern int tm_get_table_chunk(struct zclient
*zclient
, uint32_t chunk_size
,
625 uint32_t *start
, uint32_t *end
);
626 extern int tm_release_table_chunk(struct zclient
*zclient
, uint32_t start
,
629 extern int zebra_send_pw(struct zclient
*zclient
, int command
,
631 extern void zebra_read_pw_status_update(int command
, struct zclient
*zclient
,
632 zebra_size_t length
, vrf_id_t vrf_id
,
633 struct zapi_pw_status
*pw
);
635 /* IPv6 prefix add and delete function prototype. */
639 unsigned short instance
;
648 struct in6_addr
**nexthop
;
667 extern int zapi_ipv6_route(uint8_t cmd
, struct zclient
*zclient
,
668 struct prefix_ipv6
*p
, struct prefix_ipv6
*src_p
,
669 struct zapi_ipv6
*api
) __attribute__((deprecated
));
670 extern int zapi_ipv4_route_ipv6_nexthop(uint8_t, struct zclient
*,
671 struct prefix_ipv4
*,
673 __attribute__((deprecated
));
674 extern int zclient_route_send(uint8_t, struct zclient
*, struct zapi_route
*);
675 extern int zclient_send_rnh(struct zclient
*zclient
, int command
,
676 struct prefix
*p
, bool exact_match
,
678 extern int zapi_route_encode(uint8_t, struct stream
*, struct zapi_route
*);
679 extern int zapi_route_decode(struct stream
*, struct zapi_route
*);
680 bool zapi_route_notify_decode(struct stream
*s
, struct prefix
*p
,
682 enum zapi_route_notify_owner
*note
);
683 bool zapi_rule_notify_decode(struct stream
*s
, uint32_t *seqno
,
684 uint32_t *priority
, uint32_t *unique
,
686 enum zapi_rule_notify_owner
*note
);
687 bool zapi_ipset_notify_decode(struct stream
*s
,
689 enum zapi_ipset_notify_owner
*note
);
691 #define ZEBRA_IPSET_NAME_SIZE 32
693 bool zapi_ipset_entry_notify_decode(struct stream
*s
,
696 enum zapi_ipset_entry_notify_owner
*note
);
697 bool zapi_iptable_notify_decode(struct stream
*s
,
699 enum zapi_iptable_notify_owner
*note
);
701 extern struct nexthop
*nexthop_from_zapi_nexthop(struct zapi_nexthop
*znh
);
702 extern bool zapi_nexthop_update_decode(struct stream
*s
,
703 struct zapi_route
*nhr
);
705 static inline void zapi_route_set_blackhole(struct zapi_route
*api
,
706 enum blackhole_type bh_type
)
708 api
->nexthop_num
= 1;
709 api
->nexthops
[0].type
= NEXTHOP_TYPE_BLACKHOLE
;
710 api
->nexthops
[0].vrf_id
= VRF_DEFAULT
;
711 api
->nexthops
[0].bh_type
= bh_type
;
712 SET_FLAG(api
->message
, ZAPI_MESSAGE_NEXTHOP
);
716 #endif /* _ZEBRA_ZCLIENT_H */