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 /* Zebra FEC register command flags. */
62 #define ZEBRA_FEC_REGISTER_LABEL 0x1
63 #define ZEBRA_FEC_REGISTER_LABEL_INDEX 0x2
65 extern struct sockaddr_storage zclient_addr
;
66 extern socklen_t zclient_addr_len
;
68 /* Zebra message types. */
71 ZEBRA_INTERFACE_DELETE
,
72 ZEBRA_INTERFACE_ADDRESS_ADD
,
73 ZEBRA_INTERFACE_ADDRESS_DELETE
,
76 ZEBRA_INTERFACE_SET_MASTER
,
79 ZEBRA_ROUTE_NOTIFY_OWNER
,
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_BFD_DEST_REGISTER
,
99 ZEBRA_BFD_DEST_DEREGISTER
,
100 ZEBRA_BFD_DEST_UPDATE
,
101 ZEBRA_BFD_DEST_REPLAY
,
102 ZEBRA_REDISTRIBUTE_ROUTE_ADD
,
103 ZEBRA_REDISTRIBUTE_ROUTE_DEL
,
104 ZEBRA_VRF_UNREGISTER
,
108 ZEBRA_INTERFACE_VRF_UPDATE
,
109 ZEBRA_BFD_CLIENT_REGISTER
,
110 ZEBRA_BFD_CLIENT_DEREGISTER
,
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_LABEL_MANAGER_CONNECT_ASYNC
,
120 ZEBRA_GET_LABEL_CHUNK
,
121 ZEBRA_RELEASE_LABEL_CHUNK
,
123 ZEBRA_FEC_UNREGISTER
,
125 ZEBRA_ADVERTISE_DEFAULT_GW
,
126 ZEBRA_ADVERTISE_SUBNET
,
127 ZEBRA_ADVERTISE_ALL_VNI
,
134 ZEBRA_REMOTE_VTEP_ADD
,
135 ZEBRA_REMOTE_VTEP_DEL
,
138 ZEBRA_IP_PREFIX_ROUTE_ADD
,
139 ZEBRA_IP_PREFIX_ROUTE_DEL
,
140 ZEBRA_REMOTE_MACIP_ADD
,
141 ZEBRA_REMOTE_MACIP_DEL
,
142 ZEBRA_DUPLICATE_ADDR_DETECTION
,
147 ZEBRA_PW_STATUS_UPDATE
,
150 ZEBRA_RULE_NOTIFY_OWNER
,
151 ZEBRA_TABLE_MANAGER_CONNECT
,
152 ZEBRA_GET_TABLE_CHUNK
,
153 ZEBRA_RELEASE_TABLE_CHUNK
,
156 ZEBRA_IPSET_ENTRY_ADD
,
157 ZEBRA_IPSET_ENTRY_DELETE
,
158 ZEBRA_IPSET_NOTIFY_OWNER
,
159 ZEBRA_IPSET_ENTRY_NOTIFY_OWNER
,
161 ZEBRA_IPTABLE_DELETE
,
162 ZEBRA_IPTABLE_NOTIFY_OWNER
,
163 ZEBRA_VXLAN_FLOOD_CONTROL
,
164 } zebra_message_types_t
;
166 struct redist_proto
{
168 struct list
*instances
;
171 struct zclient_capabilities
{
176 /* Structure for the zebra client. */
178 /* The thread master we schedule ourselves on */
179 struct thread_master
*master
;
181 /* Priviledges to change socket values */
182 struct zebra_privs_t
*privs
;
184 /* Do we care about failure events for route install? */
187 /* Socket to zebra daemon. */
190 /* Connection failure count. */
193 /* Input buffer for zebra message. */
196 /* Output buffer for zebra message. */
199 /* Buffer of data waiting to be written to zebra. */
202 /* Read and connect thread. */
203 struct thread
*t_read
;
204 struct thread
*t_connect
;
206 /* Thread to write buffered data to zebra. */
207 struct thread
*t_write
;
209 /* Redistribute information. */
210 uint8_t redist_default
; /* clients protocol */
211 unsigned short instance
;
212 struct redist_proto mi_redist
[AFI_MAX
][ZEBRA_ROUTE_MAX
];
213 vrf_bitmap_t redist
[AFI_MAX
][ZEBRA_ROUTE_MAX
];
215 /* Redistribute defauilt. */
216 vrf_bitmap_t default_information
;
218 /* Pointer to the callback functions. */
219 void (*zebra_connected
)(struct zclient
*);
220 void (*zebra_capabilities
)(struct zclient_capabilities
*cap
);
221 int (*router_id_update
)(int, struct zclient
*, uint16_t, vrf_id_t
);
222 int (*interface_add
)(int, struct zclient
*, uint16_t, vrf_id_t
);
223 int (*interface_delete
)(int, struct zclient
*, uint16_t, vrf_id_t
);
224 int (*interface_up
)(int, struct zclient
*, uint16_t, vrf_id_t
);
225 int (*interface_down
)(int, struct zclient
*, uint16_t, vrf_id_t
);
226 int (*interface_address_add
)(int, struct zclient
*, uint16_t, vrf_id_t
);
227 int (*interface_address_delete
)(int, struct zclient
*, uint16_t,
229 int (*interface_link_params
)(int, struct zclient
*, uint16_t);
230 int (*interface_bfd_dest_update
)(int, struct zclient
*, uint16_t,
232 int (*interface_nbr_address_add
)(int, struct zclient
*, uint16_t,
234 int (*interface_nbr_address_delete
)(int, struct zclient
*, uint16_t,
236 int (*interface_vrf_update
)(int, struct zclient
*, uint16_t, vrf_id_t
);
237 int (*nexthop_update
)(int, struct zclient
*, uint16_t, vrf_id_t
);
238 int (*import_check_update
)(int, struct zclient
*, uint16_t, vrf_id_t
);
239 int (*bfd_dest_replay
)(int, struct zclient
*, uint16_t, vrf_id_t
);
240 int (*redistribute_route_add
)(int, struct zclient
*, uint16_t,
242 int (*redistribute_route_del
)(int, struct zclient
*, uint16_t,
244 int (*fec_update
)(int, struct zclient
*, uint16_t);
245 int (*local_es_add
)(int command
, struct zclient
*zclient
,
246 uint16_t length
, vrf_id_t vrf_id
);
247 int (*local_es_del
)(int command
, struct zclient
*zclient
,
248 uint16_t length
, vrf_id_t vrf_id
);
249 int (*local_vni_add
)(int, struct zclient
*, uint16_t, vrf_id_t
);
250 int (*local_vni_del
)(int, struct zclient
*, uint16_t, vrf_id_t
);
251 int (*local_l3vni_add
)(int, struct zclient
*, uint16_t, vrf_id_t
);
252 int (*local_l3vni_del
)(int, struct zclient
*, uint16_t, vrf_id_t
);
253 void (*local_ip_prefix_add
)(int, struct zclient
*, uint16_t, vrf_id_t
);
254 void (*local_ip_prefix_del
)(int, struct zclient
*, uint16_t, vrf_id_t
);
255 int (*local_macip_add
)(int, struct zclient
*, uint16_t, vrf_id_t
);
256 int (*local_macip_del
)(int, struct zclient
*, uint16_t, vrf_id_t
);
257 int (*pw_status_update
)(int, struct zclient
*, uint16_t, vrf_id_t
);
258 int (*route_notify_owner
)(int command
, struct zclient
*zclient
,
259 uint16_t length
, vrf_id_t vrf_id
);
260 int (*rule_notify_owner
)(int command
, struct zclient
*zclient
,
261 uint16_t length
, vrf_id_t vrf_id
);
262 void (*label_chunk
)(int command
, struct zclient
*zclient
,
263 uint16_t length
, vrf_id_t vrf_id
);
264 int (*ipset_notify_owner
)(int command
, struct zclient
*zclient
,
265 uint16_t length
, vrf_id_t vrf_id
);
266 int (*ipset_entry_notify_owner
)(int command
,
267 struct zclient
*zclient
,
270 int (*iptable_notify_owner
)(int command
,
271 struct zclient
*zclient
,
276 /* Zebra API message flag. */
277 #define ZAPI_MESSAGE_NEXTHOP 0x01
278 #define ZAPI_MESSAGE_DISTANCE 0x02
279 #define ZAPI_MESSAGE_METRIC 0x04
280 #define ZAPI_MESSAGE_TAG 0x08
281 #define ZAPI_MESSAGE_MTU 0x10
282 #define ZAPI_MESSAGE_SRCPFX 0x20
283 #define ZAPI_MESSAGE_LABEL 0x40
285 * This should only be used by a DAEMON that needs to communicate
286 * the table being used is not in the VRF. You must pass the
287 * default vrf, else this will be ignored.
289 #define ZAPI_MESSAGE_TABLEID 0x80
291 #define ZSERV_VERSION 6
292 /* Zserv protocol message header */
295 /* Always set to 255 in new zserv */
302 struct zapi_nexthop
{
303 enum nexthop_types_t type
;
308 enum blackhole_type bh_type
;
311 /* MPLS labels for BGP-LU or Segment Routing */
313 mpls_label_t labels
[MPLS_MAX_LABELS
];
319 * Some of these data structures do not map easily to
320 * a actual data structure size giving different compilers
321 * and systems. For those data structures we need
322 * to use the smallest available stream_getX/putX functions
327 unsigned short instance
;
334 * This is an enum but we are going to treat it as a uint8_t
335 * for purpose of encoding/decoding
339 struct prefix prefix
;
340 struct prefix_ipv6 src_prefix
;
342 uint16_t nexthop_num
;
343 struct zapi_nexthop nexthops
[MULTIPATH_NUM
];
359 char ifname
[IF_NAMESIZE
];
363 union g_addr nexthop
;
364 uint32_t local_label
;
365 uint32_t remote_label
;
367 union pw_protocol_fields data
;
371 struct zapi_pw_status
{
372 char ifname
[IF_NAMESIZE
];
377 enum zapi_route_notify_owner
{
378 ZAPI_ROUTE_FAIL_INSTALL
,
379 ZAPI_ROUTE_BETTER_ADMIN_WON
,
380 ZAPI_ROUTE_INSTALLED
,
382 ZAPI_ROUTE_REMOVE_FAIL
,
385 enum zapi_rule_notify_owner
{
386 ZAPI_RULE_FAIL_INSTALL
,
389 ZAPI_RULE_FAIL_REMOVE
,
399 enum zapi_ipset_notify_owner
{
400 ZAPI_IPSET_FAIL_INSTALL
,
401 ZAPI_IPSET_INSTALLED
,
403 ZAPI_IPSET_FAIL_REMOVE
,
406 enum zapi_ipset_entry_notify_owner
{
407 ZAPI_IPSET_ENTRY_FAIL_INSTALL
,
408 ZAPI_IPSET_ENTRY_INSTALLED
,
409 ZAPI_IPSET_ENTRY_REMOVED
,
410 ZAPI_IPSET_ENTRY_FAIL_REMOVE
,
413 enum zapi_iptable_notify_owner
{
414 ZAPI_IPTABLE_FAIL_INSTALL
,
415 ZAPI_IPTABLE_INSTALLED
,
416 ZAPI_IPTABLE_REMOVED
,
417 ZAPI_IPTABLE_FAIL_REMOVE
,
420 /* Zebra MAC types */
421 #define ZEBRA_MACIP_TYPE_STICKY 0x01 /* Sticky MAC*/
422 #define ZEBRA_MACIP_TYPE_GW 0x02 /* gateway (SVI) mac*/
423 #define ZEBRA_MACIP_TYPE_ROUTER_FLAG 0x04 /* Router Flag - proxy NA */
424 #define ZEBRA_MACIP_TYPE_OVERRIDE_FLAG 0x08 /* Override Flag */
426 struct zclient_options
{
430 extern struct zclient_options zclient_options_default
;
432 extern struct zclient
*zclient_new(struct thread_master
*m
,
433 struct zclient_options
*opt
);
435 extern void zclient_init(struct zclient
*, int, unsigned short,
436 struct zebra_privs_t
*privs
);
437 extern int zclient_start(struct zclient
*);
438 extern void zclient_stop(struct zclient
*);
439 extern void zclient_reset(struct zclient
*);
440 extern void zclient_free(struct zclient
*);
442 extern int zclient_socket_connect(struct zclient
*);
444 extern unsigned short *redist_check_instance(struct redist_proto
*,
446 extern void redist_add_instance(struct redist_proto
*, unsigned short);
447 extern void redist_del_instance(struct redist_proto
*, unsigned short);
450 * Send to zebra that the specified vrf is using label to resolve
451 * itself for L3VPN's. Repeated calls of this function with
452 * different labels will cause an effective update of the
453 * label for lookup. If you pass in MPLS_LABEL_NONE
454 * we will cause a delete action and remove this label pop
457 * The underlying AF_MPLS doesn't care about afi's
458 * but we can make the zebra_vrf keep track of what
459 * we have installed and play some special games
460 * to get them both installed.
462 extern void zclient_send_vrf_label(struct zclient
*zclient
, vrf_id_t vrf_id
,
463 afi_t afi
, mpls_label_t label
,
464 enum lsp_types_t ltype
);
466 extern void zclient_send_reg_requests(struct zclient
*, vrf_id_t
);
467 extern void zclient_send_dereg_requests(struct zclient
*, vrf_id_t
);
469 extern void zclient_send_interface_radv_req(struct zclient
*zclient
,
471 struct interface
*ifp
, int enable
,
474 /* Send redistribute command to zebra daemon. Do not update zclient state. */
475 extern int zebra_redistribute_send(int command
, struct zclient
*, afi_t
,
476 int type
, unsigned short instance
,
479 /* If state has changed, update state and call zebra_redistribute_send. */
480 extern void zclient_redistribute(int command
, struct zclient
*, afi_t
, int type
,
481 unsigned short instance
, vrf_id_t vrf_id
);
483 /* If state has changed, update state and send the command to zebra. */
484 extern void zclient_redistribute_default(int command
, struct zclient
*,
487 /* Send the message in zclient->obuf to the zebra daemon (or enqueue it).
488 Returns 0 for success or -1 on an I/O error. */
489 extern int zclient_send_message(struct zclient
*);
491 /* create header for command, length to be filled in by user later */
492 extern void zclient_create_header(struct stream
*, uint16_t, vrf_id_t
);
494 * Read sizeof(struct zmsghdr) bytes from the provided socket and parse the
495 * received data into the specified fields. If this is successful, read the
496 * rest of the packet into the provided stream.
499 * The stream to read into
502 * The socket to read from
505 * Parsed message size will be placed in the pointed-at integer
508 * Parsed marker will be placed in the pointed-at byte
511 * Parsed version will be placed in the pointed-at byte
514 * Parsed VRF ID will be placed in the pointed-at vrf_id_t
517 * Parsed command number will be placed in the pointed-at integer
521 * - insufficient data for header was read
522 * - a version mismatch was detected
523 * - a marker mismatch was detected
524 * - header size field specified more data than could be read
526 extern int zclient_read_header(struct stream
*s
, int sock
, uint16_t *size
,
527 uint8_t *marker
, uint8_t *version
,
528 vrf_id_t
*vrf_id
, uint16_t *cmd
);
530 * Parse header from ZAPI message stream into struct zmsghdr.
531 * This function assumes the stream getp points at the first byte of the header.
532 * If the function is successful then the stream getp will point to the byte
533 * immediately after the last byte of the header.
536 * The stream containing the header
539 * The header struct to parse into.
542 * true if parsing succeeded, false otherwise
544 extern bool zapi_parse_header(struct stream
*zmsg
, struct zmsghdr
*hdr
);
546 extern void zclient_interface_set_master(struct zclient
*client
,
547 struct interface
*master
,
548 struct interface
*slave
);
549 extern struct interface
*zebra_interface_add_read(struct stream
*, vrf_id_t
);
550 extern struct interface
*zebra_interface_state_read(struct stream
*s
, vrf_id_t
);
551 extern struct connected
*zebra_interface_address_read(int, struct stream
*,
553 extern struct nbr_connected
*
554 zebra_interface_nbr_address_read(int, struct stream
*, vrf_id_t
);
555 extern struct interface
*zebra_interface_vrf_update_read(struct stream
*s
,
557 vrf_id_t
*new_vrf_id
);
558 extern void zebra_interface_if_set_value(struct stream
*, struct interface
*);
559 extern void zebra_router_id_update_read(struct stream
*s
, struct prefix
*rid
);
561 extern struct interface
*zebra_interface_link_params_read(struct stream
*);
562 extern size_t zebra_interface_link_params_write(struct stream
*,
564 extern int zclient_send_get_label_chunk(
565 struct zclient
*zclient
,
567 uint32_t chunk_size
);
569 extern int lm_label_manager_connect(struct zclient
*zclient
, int async
);
570 extern int lm_get_label_chunk(struct zclient
*zclient
, uint8_t keep
,
571 uint32_t chunk_size
, uint32_t *start
,
573 extern int lm_release_label_chunk(struct zclient
*zclient
, uint32_t start
,
575 extern int tm_table_manager_connect(struct zclient
*zclient
);
576 extern int tm_get_table_chunk(struct zclient
*zclient
, uint32_t chunk_size
,
577 uint32_t *start
, uint32_t *end
);
578 extern int tm_release_table_chunk(struct zclient
*zclient
, uint32_t start
,
581 extern int zebra_send_pw(struct zclient
*zclient
, int command
,
583 extern void zebra_read_pw_status_update(int command
, struct zclient
*zclient
,
584 zebra_size_t length
, vrf_id_t vrf_id
,
585 struct zapi_pw_status
*pw
);
587 extern int zclient_route_send(uint8_t, struct zclient
*, struct zapi_route
*);
588 extern int zclient_send_rnh(struct zclient
*zclient
, int command
,
589 struct prefix
*p
, bool exact_match
,
591 extern int zapi_route_encode(uint8_t, struct stream
*, struct zapi_route
*);
592 extern int zapi_route_decode(struct stream
*, struct zapi_route
*);
593 bool zapi_route_notify_decode(struct stream
*s
, struct prefix
*p
,
595 enum zapi_route_notify_owner
*note
);
596 bool zapi_rule_notify_decode(struct stream
*s
, uint32_t *seqno
,
597 uint32_t *priority
, uint32_t *unique
,
599 enum zapi_rule_notify_owner
*note
);
600 bool zapi_ipset_notify_decode(struct stream
*s
,
602 enum zapi_ipset_notify_owner
*note
);
604 #define ZEBRA_IPSET_NAME_SIZE 32
606 bool zapi_ipset_entry_notify_decode(struct stream
*s
,
609 enum zapi_ipset_entry_notify_owner
*note
);
610 bool zapi_iptable_notify_decode(struct stream
*s
,
612 enum zapi_iptable_notify_owner
*note
);
614 extern struct nexthop
*nexthop_from_zapi_nexthop(struct zapi_nexthop
*znh
);
615 extern bool zapi_nexthop_update_decode(struct stream
*s
,
616 struct zapi_route
*nhr
);
618 static inline void zapi_route_set_blackhole(struct zapi_route
*api
,
619 enum blackhole_type bh_type
)
621 api
->nexthop_num
= 1;
622 api
->nexthops
[0].type
= NEXTHOP_TYPE_BLACKHOLE
;
623 api
->nexthops
[0].vrf_id
= VRF_DEFAULT
;
624 api
->nexthops
[0].bh_type
= bh_type
;
625 SET_FLAG(api
->message
, ZAPI_MESSAGE_NEXTHOP
);
629 #endif /* _ZEBRA_ZCLIENT_H */