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
,
76 ZEBRA_REDISTRIBUTE_ADD
,
77 ZEBRA_REDISTRIBUTE_DELETE
,
78 ZEBRA_REDISTRIBUTE_DEFAULT_ADD
,
79 ZEBRA_REDISTRIBUTE_DEFAULT_DELETE
,
81 ZEBRA_ROUTER_ID_DELETE
,
82 ZEBRA_ROUTER_ID_UPDATE
,
85 ZEBRA_NEXTHOP_REGISTER
,
86 ZEBRA_NEXTHOP_UNREGISTER
,
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
,
99 ZEBRA_REDISTRIBUTE_ROUTE_ADD
,
100 ZEBRA_REDISTRIBUTE_ROUTE_DEL
,
101 ZEBRA_VRF_UNREGISTER
,
105 ZEBRA_INTERFACE_VRF_UPDATE
,
106 ZEBRA_BFD_CLIENT_REGISTER
,
107 ZEBRA_BFD_CLIENT_DEREGISTER
,
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
,
114 ZEBRA_IPMR_ROUTE_STATS
,
115 ZEBRA_LABEL_MANAGER_CONNECT
,
116 ZEBRA_GET_LABEL_CHUNK
,
117 ZEBRA_RELEASE_LABEL_CHUNK
,
119 ZEBRA_FEC_UNREGISTER
,
121 ZEBRA_ADVERTISE_DEFAULT_GW
,
122 ZEBRA_ADVERTISE_SUBNET
,
123 ZEBRA_ADVERTISE_ALL_VNI
,
130 ZEBRA_REMOTE_VTEP_ADD
,
131 ZEBRA_REMOTE_VTEP_DEL
,
134 ZEBRA_IP_PREFIX_ROUTE_ADD
,
135 ZEBRA_IP_PREFIX_ROUTE_DEL
,
136 ZEBRA_REMOTE_MACIP_ADD
,
137 ZEBRA_REMOTE_MACIP_DEL
,
142 ZEBRA_PW_STATUS_UPDATE
,
145 ZEBRA_RULE_NOTIFY_OWNER
,
146 ZEBRA_TABLE_MANAGER_CONNECT
,
147 ZEBRA_GET_TABLE_CHUNK
,
148 ZEBRA_RELEASE_TABLE_CHUNK
,
151 ZEBRA_IPSET_ENTRY_ADD
,
152 ZEBRA_IPSET_ENTRY_DELETE
,
153 ZEBRA_IPSET_NOTIFY_OWNER
,
154 ZEBRA_IPSET_ENTRY_NOTIFY_OWNER
,
156 ZEBRA_IPTABLE_DELETE
,
157 ZEBRA_IPTABLE_NOTIFY_OWNER
,
158 } zebra_message_types_t
;
160 struct redist_proto
{
162 struct list
*instances
;
165 struct zclient_capabilities
{
170 /* Structure for the zebra client. */
172 /* The thread master we schedule ourselves on */
173 struct thread_master
*master
;
175 /* Priviledges to change socket values */
176 struct zebra_privs_t
*privs
;
178 /* Do we care about failure events for route install? */
181 /* Socket to zebra daemon. */
184 /* Connection failure count. */
187 /* Input buffer for zebra message. */
190 /* Output buffer for zebra message. */
193 /* Buffer of data waiting to be written to zebra. */
196 /* Read and connect thread. */
197 struct thread
*t_read
;
198 struct thread
*t_connect
;
200 /* Thread to write buffered data to zebra. */
201 struct thread
*t_write
;
203 /* Redistribute information. */
204 uint8_t redist_default
; /* clients protocol */
205 unsigned short instance
;
206 struct redist_proto mi_redist
[AFI_MAX
][ZEBRA_ROUTE_MAX
];
207 vrf_bitmap_t redist
[AFI_MAX
][ZEBRA_ROUTE_MAX
];
209 /* Redistribute defauilt. */
210 vrf_bitmap_t default_information
;
212 /* Pointer to the callback functions. */
213 void (*zebra_connected
)(struct zclient
*);
214 void (*zebra_capabilities
)(struct zclient_capabilities
*cap
);
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,
223 int (*interface_link_params
)(int, struct zclient
*, uint16_t);
224 int (*interface_bfd_dest_update
)(int, struct zclient
*, uint16_t,
226 int (*interface_nbr_address_add
)(int, struct zclient
*, uint16_t,
228 int (*interface_nbr_address_delete
)(int, struct zclient
*, uint16_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
);
234 int (*redistribute_route_add
)(int, struct zclient
*, uint16_t,
236 int (*redistribute_route_del
)(int, struct zclient
*, uint16_t,
238 int (*fec_update
)(int, struct zclient
*, uint16_t);
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
);
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
);
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
);
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
);
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
);
251 int (*pw_status_update
)(int, struct zclient
*, uint16_t, vrf_id_t
);
252 int (*route_notify_owner
)(int command
, struct zclient
*zclient
,
253 uint16_t length
, vrf_id_t vrf_id
);
254 int (*rule_notify_owner
)(int command
, struct zclient
*zclient
,
255 uint16_t length
, vrf_id_t vrf_id
);
256 void (*label_chunk
)(int command
, struct zclient
*zclient
,
257 uint16_t length
, vrf_id_t vrf_id
);
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
,
264 int (*iptable_notify_owner
)(int command
,
265 struct zclient
*zclient
,
270 /* Zebra API message flag. */
271 #define ZAPI_MESSAGE_NEXTHOP 0x01
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
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.
283 #define ZAPI_MESSAGE_TABLEID 0x80
285 #define ZSERV_VERSION 6
286 /* Zserv protocol message header */
289 /* Always set to 255 in new zserv */
296 struct zapi_nexthop
{
297 enum nexthop_types_t type
;
302 enum blackhole_type bh_type
;
305 /* MPLS labels for BGP-LU or Segment Routing */
307 mpls_label_t labels
[MPLS_MAX_LABELS
];
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
321 unsigned short instance
;
328 * This is an enum but we are going to treat it as a uint8_t
329 * for purpose of encoding/decoding
333 struct prefix prefix
;
334 struct prefix_ipv6 src_prefix
;
336 uint16_t nexthop_num
;
337 struct zapi_nexthop nexthops
[MULTIPATH_NUM
];
353 char ifname
[IF_NAMESIZE
];
357 union g_addr nexthop
;
358 uint32_t local_label
;
359 uint32_t remote_label
;
361 union pw_protocol_fields data
;
365 struct zapi_pw_status
{
366 char ifname
[IF_NAMESIZE
];
371 enum zapi_route_notify_owner
{
372 ZAPI_ROUTE_FAIL_INSTALL
,
373 ZAPI_ROUTE_BETTER_ADMIN_WON
,
374 ZAPI_ROUTE_INSTALLED
,
376 ZAPI_ROUTE_REMOVE_FAIL
,
379 enum zapi_rule_notify_owner
{
380 ZAPI_RULE_FAIL_INSTALL
,
383 ZAPI_RULE_FAIL_REMOVE
,
393 enum zapi_ipset_notify_owner
{
394 ZAPI_IPSET_FAIL_INSTALL
,
395 ZAPI_IPSET_INSTALLED
,
397 ZAPI_IPSET_FAIL_REMOVE
,
400 enum zapi_ipset_entry_notify_owner
{
401 ZAPI_IPSET_ENTRY_FAIL_INSTALL
,
402 ZAPI_IPSET_ENTRY_INSTALLED
,
403 ZAPI_IPSET_ENTRY_REMOVED
,
404 ZAPI_IPSET_ENTRY_FAIL_REMOVE
,
407 enum zapi_iptable_notify_owner
{
408 ZAPI_IPTABLE_FAIL_INSTALL
,
409 ZAPI_IPTABLE_INSTALLED
,
410 ZAPI_IPTABLE_REMOVED
,
411 ZAPI_IPTABLE_FAIL_REMOVE
,
414 /* Zebra MAC types */
415 #define ZEBRA_MACIP_TYPE_STICKY 0x01 /* Sticky MAC*/
416 #define ZEBRA_MACIP_TYPE_GW 0x02 /* gateway (SVI) mac*/
417 #define ZEBRA_MACIP_TYPE_ROUTER_FLAG 0x04 /* Router Flag - proxy NA */
418 #define ZEBRA_MACIP_TYPE_OVERRIDE_FLAG 0x08 /* Override Flag */
420 struct zclient_options
{
424 /* Prototypes of zebra client service functions. */
425 extern struct zclient
*zclient_new(struct thread_master
*);
427 /* clang-format off */
428 #if CONFDATE > 20181101
429 CPP_NOTICE("zclient_new_notify can take over or zclient_new now");
431 /* clang-format on */
433 extern struct zclient_options zclient_options_default
;
435 extern struct zclient
*zclient_new_notify(struct thread_master
*m
,
436 struct zclient_options
*opt
);
438 #define zclient_new(A) \
439 zclient_new_notify((A), &zclient_options_default); \
440 CPP_WARN("Please transition to using zclient_new_notify");
442 extern void zclient_init(struct zclient
*, int, unsigned short,
443 struct zebra_privs_t
*privs
);
444 extern int zclient_start(struct zclient
*);
445 extern void zclient_stop(struct zclient
*);
446 extern void zclient_reset(struct zclient
*);
447 extern void zclient_free(struct zclient
*);
449 extern int zclient_socket_connect(struct zclient
*);
451 extern unsigned short *redist_check_instance(struct redist_proto
*,
453 extern void redist_add_instance(struct redist_proto
*, unsigned short);
454 extern void redist_del_instance(struct redist_proto
*, unsigned short);
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
460 * label for lookup. If you pass in MPLS_LABEL_NONE
461 * we will cause a delete action and remove this label pop
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.
469 extern void zclient_send_vrf_label(struct zclient
*zclient
, vrf_id_t vrf_id
,
470 afi_t afi
, mpls_label_t label
,
471 enum lsp_types_t ltype
);
473 extern void zclient_send_reg_requests(struct zclient
*, vrf_id_t
);
474 extern void zclient_send_dereg_requests(struct zclient
*, vrf_id_t
);
476 extern void zclient_send_interface_radv_req(struct zclient
*zclient
,
478 struct interface
*ifp
, int enable
,
481 /* Send redistribute command to zebra daemon. Do not update zclient state. */
482 extern int zebra_redistribute_send(int command
, struct zclient
*, afi_t
,
483 int type
, unsigned short instance
,
486 /* If state has changed, update state and call zebra_redistribute_send. */
487 extern void zclient_redistribute(int command
, struct zclient
*, afi_t
, int type
,
488 unsigned short instance
, vrf_id_t vrf_id
);
490 /* If state has changed, update state and send the command to zebra. */
491 extern void zclient_redistribute_default(int command
, struct zclient
*,
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. */
496 extern int zclient_send_message(struct zclient
*);
498 /* create header for command, length to be filled in by user later */
499 extern void zclient_create_header(struct stream
*, uint16_t, vrf_id_t
);
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.
506 * The stream to read into
509 * The socket to read from
512 * Parsed message size will be placed in the pointed-at integer
515 * Parsed marker will be placed in the pointed-at byte
518 * Parsed version will be placed in the pointed-at byte
521 * Parsed VRF ID will be placed in the pointed-at vrf_id_t
524 * Parsed command number will be placed in the pointed-at integer
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
533 extern 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
);
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.
543 * The stream containing the header
546 * The header struct to parse into.
549 * true if parsing succeeded, false otherwise
551 extern bool zapi_parse_header(struct stream
*zmsg
, struct zmsghdr
*hdr
);
553 extern void zclient_interface_set_master(struct zclient
*client
,
554 struct interface
*master
,
555 struct interface
*slave
);
556 extern struct interface
*zebra_interface_add_read(struct stream
*, vrf_id_t
);
557 extern struct interface
*zebra_interface_state_read(struct stream
*s
, vrf_id_t
);
558 extern struct connected
*zebra_interface_address_read(int, struct stream
*,
560 extern struct nbr_connected
*
561 zebra_interface_nbr_address_read(int, struct stream
*, vrf_id_t
);
562 extern struct interface
*zebra_interface_vrf_update_read(struct stream
*s
,
564 vrf_id_t
*new_vrf_id
);
565 extern void zebra_interface_if_set_value(struct stream
*, struct interface
*);
566 extern void zebra_router_id_update_read(struct stream
*s
, struct prefix
*rid
);
568 extern struct interface
*zebra_interface_link_params_read(struct stream
*);
569 extern size_t zebra_interface_link_params_write(struct stream
*,
571 extern int zclient_send_get_label_chunk(
572 struct zclient
*zclient
,
574 uint32_t chunk_size
);
576 extern int lm_label_manager_connect(struct zclient
*zclient
);
577 extern int lm_get_label_chunk(struct zclient
*zclient
, uint8_t keep
,
578 uint32_t chunk_size
, uint32_t *start
,
580 extern int lm_release_label_chunk(struct zclient
*zclient
, uint32_t start
,
582 extern int tm_table_manager_connect(struct zclient
*zclient
);
583 extern int tm_get_table_chunk(struct zclient
*zclient
, uint32_t chunk_size
,
584 uint32_t *start
, uint32_t *end
);
585 extern int tm_release_table_chunk(struct zclient
*zclient
, uint32_t start
,
588 extern int zebra_send_pw(struct zclient
*zclient
, int command
,
590 extern 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
);
594 extern int zclient_route_send(uint8_t, struct zclient
*, struct zapi_route
*);
595 extern int zclient_send_rnh(struct zclient
*zclient
, int command
,
596 struct prefix
*p
, bool exact_match
,
598 extern int zapi_route_encode(uint8_t, struct stream
*, struct zapi_route
*);
599 extern int zapi_route_decode(struct stream
*, struct zapi_route
*);
600 bool zapi_route_notify_decode(struct stream
*s
, struct prefix
*p
,
602 enum zapi_route_notify_owner
*note
);
603 bool zapi_rule_notify_decode(struct stream
*s
, uint32_t *seqno
,
604 uint32_t *priority
, uint32_t *unique
,
606 enum zapi_rule_notify_owner
*note
);
607 bool zapi_ipset_notify_decode(struct stream
*s
,
609 enum zapi_ipset_notify_owner
*note
);
611 #define ZEBRA_IPSET_NAME_SIZE 32
613 bool zapi_ipset_entry_notify_decode(struct stream
*s
,
616 enum zapi_ipset_entry_notify_owner
*note
);
617 bool zapi_iptable_notify_decode(struct stream
*s
,
619 enum zapi_iptable_notify_owner
*note
);
621 extern struct nexthop
*nexthop_from_zapi_nexthop(struct zapi_nexthop
*znh
);
622 extern bool zapi_nexthop_update_decode(struct stream
*s
,
623 struct zapi_route
*nhr
);
625 static inline void zapi_route_set_blackhole(struct zapi_route
*api
,
626 enum blackhole_type bh_type
)
628 api
->nexthop_num
= 1;
629 api
->nexthops
[0].type
= NEXTHOP_TYPE_BLACKHOLE
;
630 api
->nexthops
[0].vrf_id
= VRF_DEFAULT
;
631 api
->nexthops
[0].bh_type
= bh_type
;
632 SET_FLAG(api
->message
, ZAPI_MESSAGE_NEXTHOP
);
636 #endif /* _ZEBRA_ZCLIENT_H */