[mirror_frr.git] / lib / zclient.h

/* Zebra's client header.
 * Copyright (C) 1999 Kunihiro Ishiguro
 *
 * This file is part of GNU Zebra.
 *
 * GNU Zebra is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2, or (at your option)
 * any later version.
 *
 * GNU Zebra is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; see the file COPYING; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 */

#ifndef _ZEBRA_ZCLIENT_H
#define _ZEBRA_ZCLIENT_H

/* For struct zapi_route. */
#include "prefix.h"

/* For struct interface and struct connected. */
#include "if.h"

/* For vrf_bitmap_t. */
#include "vrf.h"

/* For union g_addr */
#include "nexthop.h"

/* For union pw_protocol_fields */
#include "pw.h"

/* For input/output buffer to zebra. */
#define ZEBRA_MAX_PACKET_SIZ          4096

/* Zebra header size. */
#define ZEBRA_HEADER_SIZE             10

/* special socket path name to use TCP
 * @ is used as first character because that's abstract socket names on Linux
 */
#define ZAPI_TCP_PATHNAME             "@tcp"

extern struct sockaddr_storage zclient_addr;
extern socklen_t zclient_addr_len;

/* Zebra message types. */
typedef enum {
	ZEBRA_INTERFACE_ADD,
	ZEBRA_INTERFACE_DELETE,
	ZEBRA_INTERFACE_ADDRESS_ADD,
	ZEBRA_INTERFACE_ADDRESS_DELETE,
	ZEBRA_INTERFACE_UP,
	ZEBRA_INTERFACE_DOWN,
	ZEBRA_INTERFACE_SET_MASTER,
	ZEBRA_ROUTE_ADD,
	ZEBRA_ROUTE_DELETE,
	ZEBRA_ROUTE_NOTIFY_OWNER,
	ZEBRA_IPV4_ROUTE_ADD,
	ZEBRA_IPV4_ROUTE_DELETE,
	ZEBRA_IPV6_ROUTE_ADD,
	ZEBRA_IPV6_ROUTE_DELETE,
	ZEBRA_REDISTRIBUTE_ADD,
	ZEBRA_REDISTRIBUTE_DELETE,
	ZEBRA_REDISTRIBUTE_DEFAULT_ADD,
	ZEBRA_REDISTRIBUTE_DEFAULT_DELETE,
	ZEBRA_ROUTER_ID_ADD,
	ZEBRA_ROUTER_ID_DELETE,
	ZEBRA_ROUTER_ID_UPDATE,
	ZEBRA_HELLO,
	ZEBRA_NEXTHOP_REGISTER,
	ZEBRA_NEXTHOP_UNREGISTER,
	ZEBRA_NEXTHOP_UPDATE,
	ZEBRA_INTERFACE_NBR_ADDRESS_ADD,
	ZEBRA_INTERFACE_NBR_ADDRESS_DELETE,
	ZEBRA_INTERFACE_BFD_DEST_UPDATE,
	ZEBRA_IMPORT_ROUTE_REGISTER,
	ZEBRA_IMPORT_ROUTE_UNREGISTER,
	ZEBRA_IMPORT_CHECK_UPDATE,
	ZEBRA_IPV4_ROUTE_IPV6_NEXTHOP_ADD,
	ZEBRA_BFD_DEST_REGISTER,
	ZEBRA_BFD_DEST_DEREGISTER,
	ZEBRA_BFD_DEST_UPDATE,
	ZEBRA_BFD_DEST_REPLAY,
	ZEBRA_REDISTRIBUTE_ROUTE_ADD,
	ZEBRA_REDISTRIBUTE_ROUTE_DEL,
	ZEBRA_VRF_UNREGISTER,
	ZEBRA_VRF_ADD,
	ZEBRA_VRF_DELETE,
	ZEBRA_INTERFACE_VRF_UPDATE,
	ZEBRA_BFD_CLIENT_REGISTER,
	ZEBRA_INTERFACE_ENABLE_RADV,
	ZEBRA_INTERFACE_DISABLE_RADV,
	ZEBRA_IPV4_NEXTHOP_LOOKUP_MRIB,
	ZEBRA_INTERFACE_LINK_PARAMS,
	ZEBRA_MPLS_LABELS_ADD,
	ZEBRA_MPLS_LABELS_DELETE,
	ZEBRA_IPMR_ROUTE_STATS,
	ZEBRA_LABEL_MANAGER_CONNECT,
	ZEBRA_GET_LABEL_CHUNK,
	ZEBRA_RELEASE_LABEL_CHUNK,
	ZEBRA_FEC_REGISTER,
	ZEBRA_FEC_UNREGISTER,
	ZEBRA_FEC_UPDATE,
	ZEBRA_ADVERTISE_DEFAULT_GW,
	ZEBRA_ADVERTISE_SUBNET,
	ZEBRA_ADVERTISE_ALL_VNI,
	ZEBRA_VNI_ADD,
	ZEBRA_VNI_DEL,
	ZEBRA_L3VNI_ADD,
	ZEBRA_L3VNI_DEL,
	ZEBRA_REMOTE_VTEP_ADD,
	ZEBRA_REMOTE_VTEP_DEL,
	ZEBRA_MACIP_ADD,
	ZEBRA_MACIP_DEL,
	ZEBRA_IP_PREFIX_ROUTE_ADD,
	ZEBRA_IP_PREFIX_ROUTE_DEL,
	ZEBRA_REMOTE_MACIP_ADD,
	ZEBRA_REMOTE_MACIP_DEL,
	ZEBRA_PW_ADD,
	ZEBRA_PW_DELETE,
	ZEBRA_PW_SET,
	ZEBRA_PW_UNSET,
	ZEBRA_PW_STATUS_UPDATE,
} zebra_message_types_t;

struct redist_proto {
	u_char enabled;
	struct list *instances;
};

/* Structure for the zebra client. */
struct zclient {
	/* The thread master we schedule ourselves on */
	struct thread_master *master;

	/* Priviledges to change socket values */
	struct zebra_privs_t *privs;

	/* Do we care about failure events for route install? */
	bool receive_notify;

	/* Socket to zebra daemon. */
	int sock;

	/* Connection failure count. */
	int fail;

	/* Input buffer for zebra message. */
	struct stream *ibuf;

	/* Output buffer for zebra message. */
	struct stream *obuf;

	/* Buffer of data waiting to be written to zebra. */
	struct buffer *wb;

	/* Read and connect thread. */
	struct thread *t_read;
	struct thread *t_connect;

	/* Thread to write buffered data to zebra. */
	struct thread *t_write;

	/* Redistribute information. */
	u_char redist_default; /* clients protocol */
	u_short instance;
	struct redist_proto mi_redist[AFI_MAX][ZEBRA_ROUTE_MAX];
	vrf_bitmap_t redist[AFI_MAX][ZEBRA_ROUTE_MAX];

	/* Redistribute defauilt. */
	vrf_bitmap_t default_information;

	/* Pointer to the callback functions. */
	void (*zebra_connected)(struct zclient *);
	int (*router_id_update)(int, struct zclient *, uint16_t, vrf_id_t);
	int (*interface_add)(int, struct zclient *, uint16_t, vrf_id_t);
	int (*interface_delete)(int, struct zclient *, uint16_t, vrf_id_t);
	int (*interface_up)(int, struct zclient *, uint16_t, vrf_id_t);
	int (*interface_down)(int, struct zclient *, uint16_t, vrf_id_t);
	int (*interface_address_add)(int, struct zclient *, uint16_t, vrf_id_t);
	int (*interface_address_delete)(int, struct zclient *, uint16_t,
					vrf_id_t);
	int (*interface_link_params)(int, struct zclient *, uint16_t);
	int (*interface_bfd_dest_update)(int, struct zclient *, uint16_t,
					 vrf_id_t);
	int (*interface_nbr_address_add)(int, struct zclient *, uint16_t,
					 vrf_id_t);
	int (*interface_nbr_address_delete)(int, struct zclient *, uint16_t,
					    vrf_id_t);
	int (*interface_vrf_update)(int, struct zclient *, uint16_t, vrf_id_t);
	int (*nexthop_update)(int, struct zclient *, uint16_t, vrf_id_t);
	int (*import_check_update)(int, struct zclient *, uint16_t, vrf_id_t);
	int (*bfd_dest_replay)(int, struct zclient *, uint16_t, vrf_id_t);
	int (*redistribute_route_add)(int, struct zclient *, uint16_t,
				      vrf_id_t);
	int (*redistribute_route_del)(int, struct zclient *, uint16_t,
				      vrf_id_t);
	int (*fec_update)(int, struct zclient *, uint16_t);
	int (*local_vni_add)(int, struct zclient *, uint16_t, vrf_id_t);
	int (*local_vni_del)(int, struct zclient *, uint16_t, vrf_id_t);
	int (*local_l3vni_add)(int, struct zclient *, uint16_t, vrf_id_t);
	int (*local_l3vni_del)(int, struct zclient *, uint16_t, vrf_id_t);
	void (*local_ip_prefix_add)(int, struct zclient *, uint16_t, vrf_id_t);
	void (*local_ip_prefix_del)(int, struct zclient *, uint16_t, vrf_id_t);
	int (*local_macip_add)(int, struct zclient *, uint16_t, vrf_id_t);
	int (*local_macip_del)(int, struct zclient *, uint16_t, vrf_id_t);
	int (*pw_status_update)(int, struct zclient *, uint16_t, vrf_id_t);
	int (*notify_owner)(int command, struct zclient *zclient,
			    uint16_t length, vrf_id_t vrf_id);
};

/* Zebra API message flag. */
#define ZAPI_MESSAGE_NEXTHOP  0x01
#define ZAPI_MESSAGE_DISTANCE 0x02
#define ZAPI_MESSAGE_METRIC   0x04
#define ZAPI_MESSAGE_TAG      0x08
#define ZAPI_MESSAGE_MTU      0x10
#define ZAPI_MESSAGE_SRCPFX   0x20
#define ZAPI_MESSAGE_LABEL    0x40

/* Zserv protocol message header */
struct zserv_header {
	uint16_t length;
	uint8_t marker; /* corresponds to command field in old zserv
			 * always set to 255 in new zserv.
			 */
	uint8_t version;
#define ZSERV_VERSION	5
	vrf_id_t vrf_id;
	uint16_t command;
};

struct zapi_nexthop {
	enum nexthop_types_t type;
	ifindex_t ifindex;
	union {
		union g_addr gate;
		enum blackhole_type bh_type;
	};

	/* MPLS labels for BGP-LU or Segment Routing */
	uint8_t label_num;
	mpls_label_t labels[MPLS_MAX_LABELS];
};

/*
 * Some of these data structures do not map easily to
 * a actual data structure size giving different compilers
 * and systems.  For those data structures we need
 * to use the smallest available stream_getX/putX functions
 * to encode/decode.
 */
struct zapi_route {
	u_char type;
	u_short instance;

	u_int32_t flags;

	u_char message;

	/*
	 * This is an enum but we are going to treat it as a uint8_t
	 * for purpose of encoding/decoding
	 */
	safi_t safi;

	struct prefix prefix;
	struct prefix_ipv6 src_prefix;

	u_int16_t nexthop_num;
	struct zapi_nexthop nexthops[MULTIPATH_NUM];

	u_char distance;

	u_int32_t metric;

	route_tag_t tag;

	u_int32_t mtu;

	vrf_id_t vrf_id;
	vrf_id_t nh_vrf_id;

	struct ethaddr rmac;
};

/* Zebra IPv4 route message API. */
struct zapi_ipv4 {
	u_char type;
	u_short instance;

	u_int32_t flags;

	u_char message;

	safi_t safi;

	u_char nexthop_num;
	struct in_addr **nexthop;

	u_char ifindex_num;
	ifindex_t *ifindex;

	u_char label_num;
	unsigned int *label;

	u_char distance;

	u_int32_t metric;

	route_tag_t tag;

	u_int32_t mtu;

	vrf_id_t vrf_id;
};

struct zapi_pw {
	char ifname[IF_NAMESIZE];
	ifindex_t ifindex;
	int type;
	int af;
	union g_addr nexthop;
	uint32_t local_label;
	uint32_t remote_label;
	uint8_t flags;
	union pw_protocol_fields data;
	uint8_t protocol;
};

struct zapi_pw_status {
	char ifname[IF_NAMESIZE];
	ifindex_t ifindex;
	uint32_t status;
};

enum zapi_route_notify_owner {
	ZAPI_ROUTE_FAIL_INSTALL,
	ZAPI_ROUTE_BETTER_ADMIN_WON,
	ZAPI_ROUTE_INSTALLED,
};

/* Zebra MAC types */
#define ZEBRA_MACIP_TYPE_STICKY                0x01 /* Sticky MAC*/
#define ZEBRA_MACIP_TYPE_GW                    0x02 /* gateway (SVI) mac*/

struct zclient_options {
	bool receive_notify;
};

/* Prototypes of zebra client service functions. */
extern struct zclient *zclient_new(struct thread_master *);

#if CONFDATE > 20181101
CPP_NOTICE("zclient_new_notify can take over or zclient_new now");
#endif

extern struct zclient_options zclient_options_default;

extern struct zclient *zclient_new_notify(struct thread_master *m,
					  struct zclient_options *opt);

#define zclient_new(A) zclient_new_notify((A), &zclient_options_default); \
	CPP_WARN("Please transition to using zclient_new_notify");

extern void zclient_init(struct zclient *, int, u_short, struct zebra_privs_t *privs);
extern int zclient_start(struct zclient *);
extern void zclient_stop(struct zclient *);
extern void zclient_reset(struct zclient *);
extern void zclient_free(struct zclient *);

extern int zclient_socket_connect(struct zclient *);

extern u_short *redist_check_instance(struct redist_proto *, u_short);
extern void redist_add_instance(struct redist_proto *, u_short);
extern void redist_del_instance(struct redist_proto *, u_short);

extern void zclient_send_reg_requests(struct zclient *, vrf_id_t);
extern void zclient_send_dereg_requests(struct zclient *, vrf_id_t);

extern void zclient_send_interface_radv_req(struct zclient *zclient,
					    vrf_id_t vrf_id,
					    struct interface *ifp, int enable,
					    int ra_interval);

/* Send redistribute command to zebra daemon. Do not update zclient state. */
extern int zebra_redistribute_send(int command, struct zclient *, afi_t,
				   int type, u_short instance, vrf_id_t vrf_id);

/* If state has changed, update state and call zebra_redistribute_send. */
extern void zclient_redistribute(int command, struct zclient *, afi_t, int type,
				 u_short instance, vrf_id_t vrf_id);

/* If state has changed, update state and send the command to zebra. */
extern void zclient_redistribute_default(int command, struct zclient *,
					 vrf_id_t vrf_id);

/* Send the message in zclient->obuf to the zebra daemon (or enqueue it).
   Returns 0 for success or -1 on an I/O error. */
extern int zclient_send_message(struct zclient *);

/* create header for command, length to be filled in by user later */
extern void zclient_create_header(struct stream *, uint16_t, vrf_id_t);
extern int zclient_read_header(struct stream *s, int sock, u_int16_t *size,
			       u_char *marker, u_char *version,
			       vrf_id_t *vrf_id, u_int16_t *cmd);

extern void zclient_interface_set_master(struct zclient *client,
					 struct interface *master,
					 struct interface *slave);
extern struct interface *zebra_interface_add_read(struct stream *, vrf_id_t);
extern struct interface *zebra_interface_state_read(struct stream *s, vrf_id_t);
extern struct connected *zebra_interface_address_read(int, struct stream *,
						      vrf_id_t);
extern struct nbr_connected *
zebra_interface_nbr_address_read(int, struct stream *, vrf_id_t);
extern struct interface *zebra_interface_vrf_update_read(struct stream *s,
							 vrf_id_t vrf_id,
							 vrf_id_t *new_vrf_id);
extern void zebra_interface_if_set_value(struct stream *, struct interface *);
extern void zebra_router_id_update_read(struct stream *s, struct prefix *rid);

#if CONFDATE > 20180823
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");
#endif

extern int zapi_ipv4_route(u_char, struct zclient *, struct prefix_ipv4 *,
			   struct zapi_ipv4 *) __attribute__((deprecated));

extern struct interface *zebra_interface_link_params_read(struct stream *);
extern size_t zebra_interface_link_params_write(struct stream *,
						struct interface *);
extern int lm_label_manager_connect(struct zclient *zclient);
extern int lm_get_label_chunk(struct zclient *zclient, u_char keep,
			      uint32_t chunk_size, uint32_t *start,
			      uint32_t *end);
extern int lm_release_label_chunk(struct zclient *zclient, uint32_t start,
				  uint32_t end);
extern int zebra_send_pw(struct zclient *zclient, int command,
			 struct zapi_pw *pw);
extern void zebra_read_pw_status_update(int command, struct zclient *zclient,
					zebra_size_t length, vrf_id_t vrf_id,
					struct zapi_pw_status *pw);

/* IPv6 prefix add and delete function prototype. */

struct zapi_ipv6 {
	u_char type;
	u_short instance;

	u_int32_t flags;

	u_char message;

	safi_t safi;

	u_char nexthop_num;
	struct in6_addr **nexthop;

	u_char ifindex_num;
	ifindex_t *ifindex;

	u_char label_num;
	unsigned int *label;

	u_char distance;

	u_int32_t metric;

	route_tag_t tag;

	u_int32_t mtu;

	vrf_id_t vrf_id;
};

extern int zapi_ipv6_route(u_char cmd, struct zclient *zclient,
			   struct prefix_ipv6 *p, struct prefix_ipv6 *src_p,
			   struct zapi_ipv6 *api) __attribute__((deprecated));
extern int zapi_ipv4_route_ipv6_nexthop(u_char, struct zclient *,
					struct prefix_ipv4 *,
					struct zapi_ipv6 *)
	__attribute__((deprecated));
extern int zclient_route_send(u_char, struct zclient *, struct zapi_route *);
extern int zapi_route_encode(u_char, struct stream *, struct zapi_route *);
extern int zapi_route_decode(struct stream *, struct zapi_route *);
bool zapi_route_notify_decode(struct stream *s, struct prefix *p,
			      enum zapi_route_notify_owner *note);

static inline void zapi_route_set_blackhole(struct zapi_route *api,
					    enum blackhole_type bh_type)
{
	api->nexthop_num = 1;
	api->nexthops[0].type = NEXTHOP_TYPE_BLACKHOLE;
	api->nexthops[0].bh_type = bh_type;
	SET_FLAG(api->message, ZAPI_MESSAGE_NEXTHOP);
};


#endif /* _ZEBRA_ZCLIENT_H */
Commit	Line	Data
718e3744	1	/* Zebra's client header.
	2	* Copyright (C) 1999 Kunihiro Ishiguro
	3	*
	4	* This file is part of GNU Zebra.
	5	*
	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)
	9	* any later version.
896014f4	10	*
718e3744	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.
896014f4 DL	15	*
	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
718e3744	19	*/
	20
	21	#ifndef _ZEBRA_ZCLIENT_H
	22	#define _ZEBRA_ZCLIENT_H
	23
74489921	24	/* For struct zapi_route. */
5734509c PJ	25	#include "prefix.h"
5734509c PJ	26
718e3744	27	/* For struct interface and struct connected. */
	28	#include "if.h"
	29
7076bb2f FL	30	/* For vrf_bitmap_t. */
	31	#include "vrf.h"
	32
6833ae01	33	/* For union g_addr */
	34	#include "nexthop.h"
	35
	36	/* For union pw_protocol_fields */
	37	#include "pw.h"
	38
718e3744	39	/* For input/output buffer to zebra. */
	40	#define ZEBRA_MAX_PACKET_SIZ 4096
	41
	42	/* Zebra header size. */
a9ff90c4	43	#define ZEBRA_HEADER_SIZE 10
718e3744	44
689f5a8c DL	45	/* special socket path name to use TCP
	46	* @ is used as first character because that's abstract socket names on Linux
	47	*/
	48	#define ZAPI_TCP_PATHNAME "@tcp"
	49
	50	extern struct sockaddr_storage zclient_addr;
	51	extern socklen_t zclient_addr_len;
	52
8613585e DS	53	/* Zebra message types. */
8613585e DS	54	typedef enum {
d62a17ae	55	ZEBRA_INTERFACE_ADD,
	56	ZEBRA_INTERFACE_DELETE,
	57	ZEBRA_INTERFACE_ADDRESS_ADD,
	58	ZEBRA_INTERFACE_ADDRESS_DELETE,
	59	ZEBRA_INTERFACE_UP,
	60	ZEBRA_INTERFACE_DOWN,
e0ae31b8	61	ZEBRA_INTERFACE_SET_MASTER,
0e51b4a3 RW	62	ZEBRA_ROUTE_ADD,
0e51b4a3 RW	63	ZEBRA_ROUTE_DELETE,
7ea7b86e	64	ZEBRA_ROUTE_NOTIFY_OWNER,
d62a17ae	65	ZEBRA_IPV4_ROUTE_ADD,
	66	ZEBRA_IPV4_ROUTE_DELETE,
	67	ZEBRA_IPV6_ROUTE_ADD,
	68	ZEBRA_IPV6_ROUTE_DELETE,
	69	ZEBRA_REDISTRIBUTE_ADD,
	70	ZEBRA_REDISTRIBUTE_DELETE,
	71	ZEBRA_REDISTRIBUTE_DEFAULT_ADD,
	72	ZEBRA_REDISTRIBUTE_DEFAULT_DELETE,
	73	ZEBRA_ROUTER_ID_ADD,
	74	ZEBRA_ROUTER_ID_DELETE,
	75	ZEBRA_ROUTER_ID_UPDATE,
	76	ZEBRA_HELLO,
	77	ZEBRA_NEXTHOP_REGISTER,
	78	ZEBRA_NEXTHOP_UNREGISTER,
	79	ZEBRA_NEXTHOP_UPDATE,
	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,
74489921 RW	91	ZEBRA_REDISTRIBUTE_ROUTE_ADD,
74489921 RW	92	ZEBRA_REDISTRIBUTE_ROUTE_DEL,
d62a17ae	93	ZEBRA_VRF_UNREGISTER,
	94	ZEBRA_VRF_ADD,
	95	ZEBRA_VRF_DELETE,
	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,
d62a17ae	104	ZEBRA_IPMR_ROUTE_STATS,
	105	ZEBRA_LABEL_MANAGER_CONNECT,
	106	ZEBRA_GET_LABEL_CHUNK,
	107	ZEBRA_RELEASE_LABEL_CHUNK,
	108	ZEBRA_FEC_REGISTER,
	109	ZEBRA_FEC_UNREGISTER,
	110	ZEBRA_FEC_UPDATE,
1a98c087	111	ZEBRA_ADVERTISE_DEFAULT_GW,
31310b25	112	ZEBRA_ADVERTISE_SUBNET,
d62a17ae	113	ZEBRA_ADVERTISE_ALL_VNI,
	114	ZEBRA_VNI_ADD,
	115	ZEBRA_VNI_DEL,
b7cfce93 MK	116	ZEBRA_L3VNI_ADD,
b7cfce93 MK	117	ZEBRA_L3VNI_DEL,
d62a17ae	118	ZEBRA_REMOTE_VTEP_ADD,
	119	ZEBRA_REMOTE_VTEP_DEL,
	120	ZEBRA_MACIP_ADD,
	121	ZEBRA_MACIP_DEL,
31310b25 MK	122	ZEBRA_IP_PREFIX_ROUTE_ADD,
31310b25 MK	123	ZEBRA_IP_PREFIX_ROUTE_DEL,
d62a17ae	124	ZEBRA_REMOTE_MACIP_ADD,
d62a17ae	125	ZEBRA_REMOTE_MACIP_DEL,
6833ae01	126	ZEBRA_PW_ADD,
	127	ZEBRA_PW_DELETE,
	128	ZEBRA_PW_SET,
	129	ZEBRA_PW_UNSET,
	130	ZEBRA_PW_STATUS_UPDATE,
8613585e DS	131	} zebra_message_types_t;
8613585e DS	132
d62a17ae	133	struct redist_proto {
	134	u_char enabled;
	135	struct list *instances;
7c8ff89e DS	136	};
7c8ff89e DS	137
718e3744	138	/* Structure for the zebra client. */
d62a17ae	139	struct zclient {
	140	/* The thread master we schedule ourselves on */
	141	struct thread_master *master;
	142
342213ea DS	143	/* Priviledges to change socket values */
	144	struct zebra_privs_t *privs;
	145
e1a1880d DS	146	/* Do we care about failure events for route install? */
	147	bool receive_notify;
	148
d62a17ae	149	/* Socket to zebra daemon. */
	150	int sock;
	151
d62a17ae	152	/* Connection failure count. */
	153	int fail;
	154
	155	/* Input buffer for zebra message. */
	156	struct stream *ibuf;
	157
	158	/* Output buffer for zebra message. */
	159	struct stream *obuf;
	160
	161	/* Buffer of data waiting to be written to zebra. */
	162	struct buffer *wb;
	163
	164	/* Read and connect thread. */
	165	struct thread *t_read;
	166	struct thread *t_connect;
	167
	168	/* Thread to write buffered data to zebra. */
	169	struct thread *t_write;
	170
	171	/* Redistribute information. */
	172	u_char redist_default; /* clients protocol */
	173	u_short instance;
	174	struct redist_proto mi_redist[AFI_MAX][ZEBRA_ROUTE_MAX];
	175	vrf_bitmap_t redist[AFI_MAX][ZEBRA_ROUTE_MAX];
	176
	177	/* Redistribute defauilt. */
	178	vrf_bitmap_t default_information;
	179
	180	/* Pointer to the callback functions. */
	181	void (zebra_connected)(struct zclient );
	182	int (router_id_update)(int, struct zclient , uint16_t, vrf_id_t);
	183	int (interface_add)(int, struct zclient , uint16_t, vrf_id_t);
	184	int (interface_delete)(int, struct zclient , uint16_t, vrf_id_t);
	185	int (interface_up)(int, struct zclient , uint16_t, vrf_id_t);
	186	int (interface_down)(int, struct zclient , uint16_t, vrf_id_t);
	187	int (interface_address_add)(int, struct zclient , uint16_t, vrf_id_t);
	188	int (interface_address_delete)(int, struct zclient , uint16_t,
	189	vrf_id_t);
	190	int (interface_link_params)(int, struct zclient , uint16_t);
	191	int (interface_bfd_dest_update)(int, struct zclient , uint16_t,
	192	vrf_id_t);
	193	int (interface_nbr_address_add)(int, struct zclient , uint16_t,
	194	vrf_id_t);
	195	int (interface_nbr_address_delete)(int, struct zclient , uint16_t,
	196	vrf_id_t);
	197	int (interface_vrf_update)(int, struct zclient , uint16_t, vrf_id_t);
	198	int (nexthop_update)(int, struct zclient , uint16_t, vrf_id_t);
	199	int (import_check_update)(int, struct zclient , uint16_t, vrf_id_t);
	200	int (bfd_dest_replay)(int, struct zclient , uint16_t, vrf_id_t);
74489921 RW	201	int (redistribute_route_add)(int, struct zclient , uint16_t,
	202	vrf_id_t);
	203	int (redistribute_route_del)(int, struct zclient , uint16_t,
	204	vrf_id_t);
d62a17ae	205	int (fec_update)(int, struct zclient , uint16_t);
	206	int (local_vni_add)(int, struct zclient , uint16_t, vrf_id_t);
	207	int (local_vni_del)(int, struct zclient , uint16_t, vrf_id_t);
b7cfce93 MK	208	int (local_l3vni_add)(int, struct zclient , uint16_t, vrf_id_t);
b7cfce93 MK	209	int (local_l3vni_del)(int, struct zclient , uint16_t, vrf_id_t);
31310b25 MK	210	void (local_ip_prefix_add)(int, struct zclient , uint16_t, vrf_id_t);
31310b25 MK	211	void (local_ip_prefix_del)(int, struct zclient , uint16_t, vrf_id_t);
d62a17ae	212	int (local_macip_add)(int, struct zclient , uint16_t, vrf_id_t);
d62a17ae	213	int (local_macip_del)(int, struct zclient , uint16_t, vrf_id_t);
6833ae01	214	int (pw_status_update)(int, struct zclient , uint16_t, vrf_id_t);
7ea7b86e DS	215	int (notify_owner)(int command, struct zclient zclient,
7ea7b86e DS	216	uint16_t length, vrf_id_t vrf_id);
718e3744	217	};
	218
	219	/* Zebra API message flag. */
	220	#define ZAPI_MESSAGE_NEXTHOP 0x01
74489921 RW	221	#define ZAPI_MESSAGE_DISTANCE 0x02
	222	#define ZAPI_MESSAGE_METRIC 0x04
	223	#define ZAPI_MESSAGE_TAG 0x08
	224	#define ZAPI_MESSAGE_MTU 0x10
	225	#define ZAPI_MESSAGE_SRCPFX 0x20
	226	#define ZAPI_MESSAGE_LABEL 0x40
718e3744	227
c1b9800a	228	/* Zserv protocol message header */
d62a17ae	229	struct zserv_header {
	230	uint16_t length;
	231	uint8_t marker; /* corresponds to command field in old zserv
	232	* always set to 255 in new zserv.
	233	*/
	234	uint8_t version;
a9ff90c4	235	#define ZSERV_VERSION 5
d62a17ae	236	vrf_id_t vrf_id;
d62a17ae	237	uint16_t command;
c1b9800a	238	};
c1b9800a	239
bb1b9c47 RW	240	struct zapi_nexthop {
	241	enum nexthop_types_t type;
	242	ifindex_t ifindex;
09a484dd DL	243	union {
	244	union g_addr gate;
	245	enum blackhole_type bh_type;
	246	};
52dd3aa4 RW	247
	248	/* MPLS labels for BGP-LU or Segment Routing */
	249	uint8_t label_num;
	250	mpls_label_t labels[MPLS_MAX_LABELS];
bb1b9c47 RW	251	};
bb1b9c47 RW	252
832d0f56 DS	253	/*
	254	* Some of these data structures do not map easily to
	255	* a actual data structure size giving different compilers
	256	* and systems. For those data structures we need
	257	* to use the smallest available stream_getX/putX functions
	258	* to encode/decode.
	259	*/
d62a17ae	260	struct zapi_route {
	261	u_char type;
	262	u_short instance;
657cde12	263
d62a17ae	264	u_int32_t flags;
657cde12	265
d62a17ae	266	u_char message;
657cde12	267
832d0f56 DS	268	/*
	269	* This is an enum but we are going to treat it as a uint8_t
	270	* for purpose of encoding/decoding
	271	*/
d62a17ae	272	safi_t safi;
657cde12	273
bb1b9c47 RW	274	struct prefix prefix;
	275	struct prefix_ipv6 src_prefix;
	276
b5f79651	277	u_int16_t nexthop_num;
bb1b9c47	278	struct zapi_nexthop nexthops[MULTIPATH_NUM];
657cde12	279
d62a17ae	280	u_char distance;
657cde12	281
d62a17ae	282	u_int32_t metric;
657cde12	283
d62a17ae	284	route_tag_t tag;
657cde12	285
d62a17ae	286	u_int32_t mtu;
657cde12	287
d62a17ae	288	vrf_id_t vrf_id;
d5b2119c	289	vrf_id_t nh_vrf_id;
2dbad57f	290
2dbad57f	291	struct ethaddr rmac;
657cde12 DS	292	};
657cde12 DS	293
718e3744	294	/* Zebra IPv4 route message API. */
d62a17ae	295	struct zapi_ipv4 {
	296	u_char type;
	297	u_short instance;
718e3744	298
d62a17ae	299	u_int32_t flags;
718e3744	300
d62a17ae	301	u_char message;
718e3744	302
d62a17ae	303	safi_t safi;
5a616c08	304
d62a17ae	305	u_char nexthop_num;
d62a17ae	306	struct in_addr **nexthop;
718e3744	307
d62a17ae	308	u_char ifindex_num;
d62a17ae	309	ifindex_t *ifindex;
718e3744	310
d62a17ae	311	u_char label_num;
d62a17ae	312	unsigned int *label;
a64448ba	313
d62a17ae	314	u_char distance;
718e3744	315
d62a17ae	316	u_int32_t metric;
0d9551dc	317
d62a17ae	318	route_tag_t tag;
7076bb2f	319
d62a17ae	320	u_int32_t mtu;
c50ca33a	321
d62a17ae	322	vrf_id_t vrf_id;
718e3744	323	};
718e3744	324
6833ae01	325	struct zapi_pw {
	326	char ifname[IF_NAMESIZE];
	327	ifindex_t ifindex;
	328	int type;
	329	int af;
	330	union g_addr nexthop;
	331	uint32_t local_label;
	332	uint32_t remote_label;
	333	uint8_t flags;
	334	union pw_protocol_fields data;
	335	uint8_t protocol;
	336	};
	337
	338	struct zapi_pw_status {
	339	char ifname[IF_NAMESIZE];
	340	ifindex_t ifindex;
	341	uint32_t status;
	342	};
	343
7ea7b86e DS	344	enum zapi_route_notify_owner {
	345	ZAPI_ROUTE_FAIL_INSTALL,
	346	ZAPI_ROUTE_BETTER_ADMIN_WON,
	347	ZAPI_ROUTE_INSTALLED,
	348	};
	349
1a98c087	350	/* Zebra MAC types */
ead40654 MK	351	#define ZEBRA_MACIP_TYPE_STICKY 0x01 /* Sticky MAC*/
ead40654 MK	352	#define ZEBRA_MACIP_TYPE_GW 0x02 /* gateway (SVI) mac*/
1a98c087	353
e1a1880d DS	354	struct zclient_options {
	355	bool receive_notify;
	356	};
	357
718e3744	358	/* Prototypes of zebra client service functions. */
d62a17ae	359	extern struct zclient zclient_new(struct thread_master );
e1a1880d DS	360
	361	#if CONFDATE > 20181101
	362	CPP_NOTICE("zclient_new_notify can take over or zclient_new now");
	363	#endif
	364
	365	extern struct zclient_options zclient_options_default;
	366
	367	extern struct zclient zclient_new_notify(struct thread_master m,
	368	struct zclient_options *opt);
	369
	370	#define zclient_new(A) zclient_new_notify((A), &zclient_options_default); \
	371	CPP_WARN("Please transition to using zclient_new_notify");
	372
342213ea	373	extern void zclient_init(struct zclient , int, u_short, struct zebra_privs_t privs);
d62a17ae	374	extern int zclient_start(struct zclient *);
	375	extern void zclient_stop(struct zclient *);
	376	extern void zclient_reset(struct zclient *);
	377	extern void zclient_free(struct zclient *);
634f9ea2	378
d62a17ae	379	extern int zclient_socket_connect(struct zclient *);
718e3744	380
d62a17ae	381	extern u_short redist_check_instance(struct redist_proto , u_short);
	382	extern void redist_add_instance(struct redist_proto *, u_short);
	383	extern void redist_del_instance(struct redist_proto *, u_short);
7c8ff89e	384
d62a17ae	385	extern void zclient_send_reg_requests(struct zclient *, vrf_id_t);
d62a17ae	386	extern void zclient_send_dereg_requests(struct zclient *, vrf_id_t);
7076bb2f	387
d62a17ae	388	extern void zclient_send_interface_radv_req(struct zclient *zclient,
	389	vrf_id_t vrf_id,
	390	struct interface *ifp, int enable,
	391	int ra_interval);
4a04e5f7	392
634f9ea2	393	/* Send redistribute command to zebra daemon. Do not update zclient state. */
d62a17ae	394	extern int zebra_redistribute_send(int command, struct zclient *, afi_t,
d62a17ae	395	int type, u_short instance, vrf_id_t vrf_id);
634f9ea2	396
634f9ea2	397	/* If state has changed, update state and call zebra_redistribute_send. */
d62a17ae	398	extern void zclient_redistribute(int command, struct zclient *, afi_t, int type,
d62a17ae	399	u_short instance, vrf_id_t vrf_id);
634f9ea2	400
634f9ea2	401	/* If state has changed, update state and send the command to zebra. */
d62a17ae	402	extern void zclient_redistribute_default(int command, struct zclient *,
d62a17ae	403	vrf_id_t vrf_id);
718e3744	404
634f9ea2	405	/* Send the message in zclient->obuf to the zebra daemon (or enqueue it).
	406	Returns 0 for success or -1 on an I/O error. */
	407	extern int zclient_send_message(struct zclient *);
718e3744	408
d211086a	409	/* create header for command, length to be filled in by user later */
d62a17ae	410	extern void zclient_create_header(struct stream *, uint16_t, vrf_id_t);
	411	extern int zclient_read_header(struct stream s, int sock, u_int16_t size,
	412	u_char marker, u_char version,
	413	vrf_id_t vrf_id, u_int16_t cmd);
	414
e0ae31b8 DS	415	extern void zclient_interface_set_master(struct zclient *client,
	416	struct interface *master,
	417	struct interface *slave);
d62a17ae	418	extern struct interface zebra_interface_add_read(struct stream , vrf_id_t);
	419	extern struct interface zebra_interface_state_read(struct stream s, vrf_id_t);
	420	extern struct connected zebra_interface_address_read(int, struct stream ,
	421	vrf_id_t);
	422	extern struct nbr_connected *
	423	zebra_interface_nbr_address_read(int, struct stream *, vrf_id_t);
	424	extern struct interface zebra_interface_vrf_update_read(struct stream s,
	425	vrf_id_t vrf_id,
	426	vrf_id_t *new_vrf_id);
	427	extern void zebra_interface_if_set_value(struct stream , struct interface );
	428	extern void zebra_router_id_update_read(struct stream s, struct prefix rid);
0cb76b9d DS	429
	430	#if CONFDATE > 20180823
	431	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");
	432	#endif
	433
d62a17ae	434	extern int zapi_ipv4_route(u_char, struct zclient , struct prefix_ipv4 ,
f474e08b	435	struct zapi_ipv4 *) __attribute__((deprecated));
d62a17ae	436
	437	extern struct interface zebra_interface_link_params_read(struct stream );
	438	extern size_t zebra_interface_link_params_write(struct stream *,
	439	struct interface *);
	440	extern int lm_label_manager_connect(struct zclient *zclient);
	441	extern int lm_get_label_chunk(struct zclient *zclient, u_char keep,
	442	uint32_t chunk_size, uint32_t *start,
	443	uint32_t *end);
	444	extern int lm_release_label_chunk(struct zclient *zclient, uint32_t start,
	445	uint32_t end);
6833ae01	446	extern int zebra_send_pw(struct zclient *zclient, int command,
	447	struct zapi_pw *pw);
	448	extern void zebra_read_pw_status_update(int command, struct zclient *zclient,
	449	zebra_size_t length, vrf_id_t vrf_id,
	450	struct zapi_pw_status *pw);
	451
718e3744	452	/* IPv6 prefix add and delete function prototype. */
718e3744	453
d62a17ae	454	struct zapi_ipv6 {
	455	u_char type;
	456	u_short instance;
718e3744	457
d62a17ae	458	u_int32_t flags;
718e3744	459
d62a17ae	460	u_char message;
718e3744	461
d62a17ae	462	safi_t safi;
c7ec179a	463
d62a17ae	464	u_char nexthop_num;
d62a17ae	465	struct in6_addr **nexthop;
718e3744	466
d62a17ae	467	u_char ifindex_num;
d62a17ae	468	ifindex_t *ifindex;
718e3744	469
d62a17ae	470	u_char label_num;
d62a17ae	471	unsigned int *label;
a64448ba	472
d62a17ae	473	u_char distance;
718e3744	474
d62a17ae	475	u_int32_t metric;
0d9551dc	476
d62a17ae	477	route_tag_t tag;
7076bb2f	478
d62a17ae	479	u_int32_t mtu;
c50ca33a	480
d62a17ae	481	vrf_id_t vrf_id;
718e3744	482	};
718e3744	483
d62a17ae	484	extern int zapi_ipv6_route(u_char cmd, struct zclient *zclient,
d62a17ae	485	struct prefix_ipv6 p, struct prefix_ipv6 src_p,
f474e08b	486	struct zapi_ipv6 *api) __attribute__((deprecated));
d62a17ae	487	extern int zapi_ipv4_route_ipv6_nexthop(u_char, struct zclient *,
d62a17ae	488	struct prefix_ipv4 *,
f474e08b RW	489	struct zapi_ipv6 *)
f474e08b RW	490	__attribute__((deprecated));
0e51b4a3 RW	491	extern int zclient_route_send(u_char, struct zclient , struct zapi_route );
	492	extern int zapi_route_encode(u_char, struct stream , struct zapi_route );
	493	extern int zapi_route_decode(struct stream , struct zapi_route );
7ea7b86e DS	494	bool zapi_route_notify_decode(struct stream s, struct prefix p,
7ea7b86e DS	495	enum zapi_route_notify_owner *note);
718e3744	496
09a484dd	497	static inline void zapi_route_set_blackhole(struct zapi_route *api,
60466a63	498	enum blackhole_type bh_type)
09a484dd DL	499	{
	500	api->nexthop_num = 1;
	501	api->nexthops[0].type = NEXTHOP_TYPE_BLACKHOLE;
	502	api->nexthops[0].bh_type = bh_type;
	503	SET_FLAG(api->message, ZAPI_MESSAGE_NEXTHOP);
	504	};
	505
	506
718e3744	507	#endif /* _ZEBRA_ZCLIENT_H */