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 4096
42 /* Zebra header size. */
43 #define ZEBRA_HEADER_SIZE 8
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
,
96 ZEBRA_INTERFACE_VRF_UPDATE
,
97 ZEBRA_BFD_CLIENT_REGISTER
,
98 ZEBRA_INTERFACE_ENABLE_RADV
,
99 ZEBRA_INTERFACE_DISABLE_RADV
,
100 ZEBRA_IPV4_NEXTHOP_LOOKUP_MRIB
,
101 ZEBRA_INTERFACE_LINK_PARAMS
,
102 ZEBRA_MPLS_LABELS_ADD
,
103 ZEBRA_MPLS_LABELS_DELETE
,
104 ZEBRA_IPMR_ROUTE_STATS
,
105 ZEBRA_LABEL_MANAGER_CONNECT
,
106 ZEBRA_GET_LABEL_CHUNK
,
107 ZEBRA_RELEASE_LABEL_CHUNK
,
109 ZEBRA_FEC_UNREGISTER
,
111 ZEBRA_ADVERTISE_DEFAULT_GW
,
112 ZEBRA_ADVERTISE_ALL_VNI
,
117 ZEBRA_REMOTE_VTEP_ADD
,
118 ZEBRA_REMOTE_VTEP_DEL
,
121 ZEBRA_REMOTE_MACIP_ADD
,
122 ZEBRA_REMOTE_MACIP_DEL
,
127 ZEBRA_PW_STATUS_UPDATE
,
128 } zebra_message_types_t
;
130 struct redist_proto
{
132 struct list
*instances
;
135 /* Structure for the zebra client. */
137 /* The thread master we schedule ourselves on */
138 struct thread_master
*master
;
140 /* Priviledges to change socket values */
141 struct zebra_privs_t
*privs
;
143 /* Do we care about failure events for route install? */
146 /* Socket to zebra daemon. */
149 /* Connection failure count. */
152 /* Input buffer for zebra message. */
155 /* Output buffer for zebra message. */
158 /* Buffer of data waiting to be written to zebra. */
161 /* Read and connect thread. */
162 struct thread
*t_read
;
163 struct thread
*t_connect
;
165 /* Thread to write buffered data to zebra. */
166 struct thread
*t_write
;
168 /* Redistribute information. */
169 u_char redist_default
; /* clients protocol */
171 struct redist_proto mi_redist
[AFI_MAX
][ZEBRA_ROUTE_MAX
];
172 vrf_bitmap_t redist
[AFI_MAX
][ZEBRA_ROUTE_MAX
];
174 /* Redistribute defauilt. */
175 vrf_bitmap_t default_information
;
177 /* Pointer to the callback functions. */
178 void (*zebra_connected
)(struct zclient
*);
179 int (*router_id_update
)(int, struct zclient
*, uint16_t, vrf_id_t
);
180 int (*interface_add
)(int, struct zclient
*, uint16_t, vrf_id_t
);
181 int (*interface_delete
)(int, struct zclient
*, uint16_t, vrf_id_t
);
182 int (*interface_up
)(int, struct zclient
*, uint16_t, vrf_id_t
);
183 int (*interface_down
)(int, struct zclient
*, uint16_t, vrf_id_t
);
184 int (*interface_address_add
)(int, struct zclient
*, uint16_t, vrf_id_t
);
185 int (*interface_address_delete
)(int, struct zclient
*, uint16_t,
187 int (*interface_link_params
)(int, struct zclient
*, uint16_t);
188 int (*interface_bfd_dest_update
)(int, struct zclient
*, uint16_t,
190 int (*interface_nbr_address_add
)(int, struct zclient
*, uint16_t,
192 int (*interface_nbr_address_delete
)(int, struct zclient
*, uint16_t,
194 int (*interface_vrf_update
)(int, struct zclient
*, uint16_t, vrf_id_t
);
195 int (*nexthop_update
)(int, struct zclient
*, uint16_t, vrf_id_t
);
196 int (*import_check_update
)(int, struct zclient
*, uint16_t, vrf_id_t
);
197 int (*bfd_dest_replay
)(int, struct zclient
*, uint16_t, vrf_id_t
);
198 int (*redistribute_route_add
)(int, struct zclient
*, uint16_t,
200 int (*redistribute_route_del
)(int, struct zclient
*, uint16_t,
202 int (*fec_update
)(int, struct zclient
*, uint16_t);
203 int (*local_vni_add
)(int, struct zclient
*, uint16_t, vrf_id_t
);
204 int (*local_vni_del
)(int, struct zclient
*, uint16_t, vrf_id_t
);
205 int (*local_l3vni_add
)(int, struct zclient
*, uint16_t, vrf_id_t
);
206 int (*local_l3vni_del
)(int, struct zclient
*, uint16_t, vrf_id_t
);
207 int (*local_macip_add
)(int, struct zclient
*, uint16_t, vrf_id_t
);
208 int (*local_macip_del
)(int, struct zclient
*, uint16_t, vrf_id_t
);
209 int (*pw_status_update
)(int, struct zclient
*, uint16_t, vrf_id_t
);
210 int (*notify_owner
)(int command
, struct zclient
*zclient
,
211 uint16_t length
, vrf_id_t vrf_id
);
214 /* Zebra API message flag. */
215 #define ZAPI_MESSAGE_NEXTHOP 0x01
216 #define ZAPI_MESSAGE_DISTANCE 0x02
217 #define ZAPI_MESSAGE_METRIC 0x04
218 #define ZAPI_MESSAGE_TAG 0x08
219 #define ZAPI_MESSAGE_MTU 0x10
220 #define ZAPI_MESSAGE_SRCPFX 0x20
221 #define ZAPI_MESSAGE_LABEL 0x40
223 /* Zserv protocol message header */
224 struct zserv_header
{
226 uint8_t marker
; /* corresponds to command field in old zserv
227 * always set to 255 in new zserv.
230 #define ZSERV_VERSION 4
235 struct zapi_nexthop
{
236 enum nexthop_types_t type
;
240 enum blackhole_type bh_type
;
243 /* MPLS labels for BGP-LU or Segment Routing */
245 mpls_label_t labels
[MPLS_MAX_LABELS
];
249 * Some of these data structures do not map easily to
250 * a actual data structure size giving different compilers
251 * and systems. For those data structures we need
252 * to use the smallest available stream_getX/putX functions
264 * This is an enum but we are going to treat it as a uint8_t
265 * for purpose of encoding/decoding
269 struct prefix prefix
;
270 struct prefix_ipv6 src_prefix
;
272 u_int16_t nexthop_num
;
273 struct zapi_nexthop nexthops
[MULTIPATH_NUM
];
288 /* Zebra IPv4 route message API. */
300 struct in_addr
**nexthop
;
320 char ifname
[IF_NAMESIZE
];
324 union g_addr nexthop
;
325 uint32_t local_label
;
326 uint32_t remote_label
;
328 union pw_protocol_fields data
;
332 struct zapi_pw_status
{
333 char ifname
[IF_NAMESIZE
];
338 enum zapi_route_notify_owner
{
339 ZAPI_ROUTE_FAIL_INSTALL
,
340 ZAPI_ROUTE_BETTER_ADMIN_WON
,
341 ZAPI_ROUTE_INSTALLED
,
344 /* Zebra MAC types */
345 #define ZEBRA_MAC_TYPE_STICKY 0x01 /* Sticky MAC*/
346 #define ZEBRA_MAC_TYPE_GW 0x02 /* gateway (SVI) mac*/
348 struct zclient_options
{
352 /* Prototypes of zebra client service functions. */
353 extern struct zclient
*zclient_new(struct thread_master
*);
355 #if CONFDATE > 20181101
356 CPP_NOTICE("zclient_new_notify can take over or zclient_new now");
359 extern struct zclient_options zclient_options_default
;
361 extern struct zclient
*zclient_new_notify(struct thread_master
*m
,
362 struct zclient_options
*opt
);
364 #define zclient_new(A) zclient_new_notify((A), &zclient_options_default); \
365 CPP_WARN("Please transition to using zclient_new_notify");
367 extern void zclient_init(struct zclient
*, int, u_short
, struct zebra_privs_t
*privs
);
368 extern int zclient_start(struct zclient
*);
369 extern void zclient_stop(struct zclient
*);
370 extern void zclient_reset(struct zclient
*);
371 extern void zclient_free(struct zclient
*);
373 extern int zclient_socket_connect(struct zclient
*);
375 extern u_short
*redist_check_instance(struct redist_proto
*, u_short
);
376 extern void redist_add_instance(struct redist_proto
*, u_short
);
377 extern void redist_del_instance(struct redist_proto
*, u_short
);
379 extern void zclient_send_reg_requests(struct zclient
*, vrf_id_t
);
380 extern void zclient_send_dereg_requests(struct zclient
*, vrf_id_t
);
382 extern void zclient_send_interface_radv_req(struct zclient
*zclient
,
384 struct interface
*ifp
, int enable
,
387 /* Send redistribute command to zebra daemon. Do not update zclient state. */
388 extern int zebra_redistribute_send(int command
, struct zclient
*, afi_t
,
389 int type
, u_short instance
, vrf_id_t vrf_id
);
391 /* If state has changed, update state and call zebra_redistribute_send. */
392 extern void zclient_redistribute(int command
, struct zclient
*, afi_t
, int type
,
393 u_short instance
, vrf_id_t vrf_id
);
395 /* If state has changed, update state and send the command to zebra. */
396 extern void zclient_redistribute_default(int command
, struct zclient
*,
399 /* Send the message in zclient->obuf to the zebra daemon (or enqueue it).
400 Returns 0 for success or -1 on an I/O error. */
401 extern int zclient_send_message(struct zclient
*);
403 /* create header for command, length to be filled in by user later */
404 extern void zclient_create_header(struct stream
*, uint16_t, vrf_id_t
);
405 extern int zclient_read_header(struct stream
*s
, int sock
, u_int16_t
*size
,
406 u_char
*marker
, u_char
*version
,
407 vrf_id_t
*vrf_id
, u_int16_t
*cmd
);
409 extern void zclient_interface_set_master(struct zclient
*client
,
410 struct interface
*master
,
411 struct interface
*slave
);
412 extern struct interface
*zebra_interface_add_read(struct stream
*, vrf_id_t
);
413 extern struct interface
*zebra_interface_state_read(struct stream
*s
, vrf_id_t
);
414 extern struct connected
*zebra_interface_address_read(int, struct stream
*,
416 extern struct nbr_connected
*
417 zebra_interface_nbr_address_read(int, struct stream
*, vrf_id_t
);
418 extern struct interface
*zebra_interface_vrf_update_read(struct stream
*s
,
420 vrf_id_t
*new_vrf_id
);
421 extern void zebra_interface_if_set_value(struct stream
*, struct interface
*);
422 extern void zebra_router_id_update_read(struct stream
*s
, struct prefix
*rid
);
424 #if CONFDATE > 20180823
425 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");
428 extern int zapi_ipv4_route(u_char
, struct zclient
*, struct prefix_ipv4
*,
429 struct zapi_ipv4
*) __attribute__((deprecated
));
431 extern struct interface
*zebra_interface_link_params_read(struct stream
*);
432 extern size_t zebra_interface_link_params_write(struct stream
*,
434 extern int lm_label_manager_connect(struct zclient
*zclient
);
435 extern int lm_get_label_chunk(struct zclient
*zclient
, u_char keep
,
436 uint32_t chunk_size
, uint32_t *start
,
438 extern int lm_release_label_chunk(struct zclient
*zclient
, uint32_t start
,
440 extern int zebra_send_pw(struct zclient
*zclient
, int command
,
442 extern void zebra_read_pw_status_update(int command
, struct zclient
*zclient
,
443 zebra_size_t length
, vrf_id_t vrf_id
,
444 struct zapi_pw_status
*pw
);
446 /* IPv6 prefix add and delete function prototype. */
459 struct in6_addr
**nexthop
;
478 extern int zapi_ipv6_route(u_char cmd
, struct zclient
*zclient
,
479 struct prefix_ipv6
*p
, struct prefix_ipv6
*src_p
,
480 struct zapi_ipv6
*api
) __attribute__((deprecated
));
481 extern int zapi_ipv4_route_ipv6_nexthop(u_char
, struct zclient
*,
482 struct prefix_ipv4
*,
484 __attribute__((deprecated
));
485 extern int zclient_route_send(u_char
, struct zclient
*, struct zapi_route
*);
486 extern int zapi_route_encode(u_char
, struct stream
*, struct zapi_route
*);
487 extern int zapi_route_decode(struct stream
*, struct zapi_route
*);
488 bool zapi_route_notify_decode(struct stream
*s
, struct prefix
*p
,
489 enum zapi_route_notify_owner
*note
);
491 static inline void zapi_route_set_blackhole(struct zapi_route
*api
,
492 enum blackhole_type bh_type
)
494 api
->nexthop_num
= 1;
495 api
->nexthops
[0].type
= NEXTHOP_TYPE_BLACKHOLE
;
496 api
->nexthops
[0].bh_type
= bh_type
;
497 SET_FLAG(api
->message
, ZAPI_MESSAGE_NEXTHOP
);
501 #endif /* _ZEBRA_ZCLIENT_H */