[mirror_frr.git] / zebra / zserv.h

/*
 * Zebra API server.
 * Portions:
 *   Copyright (C) 1997-1999  Kunihiro Ishiguro
 *   Copyright (C) 2015-2018  Cumulus Networks, Inc.
 *   et al.
 *
 * This program 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 of the License, or (at your option)
 * any later version.
 *
 * This program 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_ZSERV_H
#define _ZEBRA_ZSERV_H

/* clang-format off */
#include <stdint.h>           /* for uint32_t, uint8_t */
#include <time.h>             /* for time_t */

#include "lib/route_types.h"  /* for ZEBRA_ROUTE_MAX */
#include "lib/zebra.h"        /* for AFI_MAX */
#include "lib/vrf.h"          /* for vrf_bitmap_t */
#include "lib/zclient.h"      /* for redist_proto */
#include "lib/stream.h"       /* for stream, stream_fifo */
#include "lib/thread.h"       /* for thread, thread_master */
#include "lib/linklist.h"     /* for list */
#include "lib/workqueue.h"    /* for work_queue */
#include "lib/hook.h"         /* for DECLARE_HOOK, DECLARE_KOOH */

#include "zebra/zebra_vrf.h"  /* for zebra_vrf */
/* clang-format on */

/* Default port information. */
#define ZEBRA_VTY_PORT                2601

/* Default configuration filename. */
#define DEFAULT_CONFIG_FILE "zebra.conf"

#define ZEBRA_RMAP_DEFAULT_UPDATE_TIMER 5 /* disabled by default */

/* Client structure. */
struct zserv {
	/* Client pthread */
	struct frr_pthread *pthread;

	/* Whether the thread is waiting to be killed */
	_Atomic bool dead;

	/* Client file descriptor. */
	int sock;

	/* Input/output buffer to the client. */
	pthread_mutex_t ibuf_mtx;
	struct stream_fifo *ibuf_fifo;
	pthread_mutex_t obuf_mtx;
	struct stream_fifo *obuf_fifo;

	/* Private I/O buffers */
	struct stream *ibuf_work;
	struct stream *obuf_work;

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

	/* Threads for read/write. */
	struct thread *t_read;
	struct thread *t_write;

	/* default routing table this client munges */
	int rtm_table;

	/* This client's redistribute flag. */
	struct redist_proto mi_redist[AFI_MAX][ZEBRA_ROUTE_MAX];
	vrf_bitmap_t redist[AFI_MAX][ZEBRA_ROUTE_MAX];

	/* Redistribute default route flag. */
	vrf_bitmap_t redist_default;

	/* Interface information. */
	vrf_bitmap_t ifinfo;

	/* Router-id information. */
	vrf_bitmap_t ridinfo;

	bool notify_owner;

	/* client's protocol */
	uint8_t proto;
	uint16_t instance;
	uint8_t is_synchronous;

	/* Statistics */
	uint32_t redist_v4_add_cnt;
	uint32_t redist_v4_del_cnt;
	uint32_t redist_v6_add_cnt;
	uint32_t redist_v6_del_cnt;
	uint32_t v4_route_add_cnt;
	uint32_t v4_route_upd8_cnt;
	uint32_t v4_route_del_cnt;
	uint32_t v6_route_add_cnt;
	uint32_t v6_route_del_cnt;
	uint32_t v6_route_upd8_cnt;
	uint32_t connected_rt_add_cnt;
	uint32_t connected_rt_del_cnt;
	uint32_t ifup_cnt;
	uint32_t ifdown_cnt;
	uint32_t ifadd_cnt;
	uint32_t ifdel_cnt;
	uint32_t if_bfd_cnt;
	uint32_t bfd_peer_add_cnt;
	uint32_t bfd_peer_upd8_cnt;
	uint32_t bfd_peer_del_cnt;
	uint32_t bfd_peer_replay_cnt;
	uint32_t vrfadd_cnt;
	uint32_t vrfdel_cnt;
	uint32_t if_vrfchg_cnt;
	uint32_t bfd_client_reg_cnt;
	uint32_t vniadd_cnt;
	uint32_t vnidel_cnt;
	uint32_t l3vniadd_cnt;
	uint32_t l3vnidel_cnt;
	uint32_t macipadd_cnt;
	uint32_t macipdel_cnt;
	uint32_t prefixadd_cnt;
	uint32_t prefixdel_cnt;

	time_t nh_reg_time;
	time_t nh_dereg_time;
	time_t nh_last_upd_time;

	/*
	 * Session information.
	 *
	 * These are not synchronous with respect to each other. For instance,
	 * last_read_cmd may contain a value that has been read in the future
	 * relative to last_read_time.
	 */

	/* monotime of client creation */
	_Atomic uint32_t connect_time;
	/* monotime of last message received */
	_Atomic uint32_t last_read_time;
	/* monotime of last message sent */
	_Atomic uint32_t last_write_time;
	/* command code of last message read */
	_Atomic uint16_t last_read_cmd;
	/* command code of last message written */
	_Atomic uint16_t last_write_cmd;
};

#define ZAPI_HANDLER_ARGS                                                      \
	struct zserv *client, struct zmsghdr *hdr, struct stream *msg,         \
		struct zebra_vrf *zvrf

/* Hooks for client connect / disconnect */
DECLARE_HOOK(zserv_client_connect, (struct zserv *client), (client));
DECLARE_KOOH(zserv_client_close, (struct zserv *client), (client));

/* Zebra instance */
struct zebra_t {
	/* Thread master */
	struct thread_master *master;
	struct list *client_list;

	/* Socket */
	int sock;

	/* default table */
	uint32_t rtm_table_default;

/* rib work queue */
#define ZEBRA_RIB_PROCESS_HOLD_TIME 10
	struct work_queue *ribq;
	struct meta_queue *mq;

	/* LSP work queue */
	struct work_queue *lsp_process_q;

#define ZEBRA_ZAPI_PACKETS_TO_PROCESS 100000
	_Atomic uint32_t packets_to_process;
};
extern struct zebra_t zebrad;
extern unsigned int multipath_num;

/*
 * Initialize Zebra API server.
 *
 * Installs CLI commands and creates the client list.
 */
extern void zserv_init(void);

/*
 * Start Zebra API server.
 *
 * Allocates resources, creates the server socket and begins listening on the
 * socket.
 *
 * path
 *    where to place the Unix domain socket
 */
extern void zserv_start(char *path);

/*
 * Send a message to a connected Zebra API client.
 *
 * client
 *    the client to send to
 *
 * msg
 *    the message to send
 */
extern int zserv_send_message(struct zserv *client, struct stream *msg);

/*
 * Retrieve a client by its protocol and instance number.
 *
 * proto
 *    protocol number
 *
 * instance
 *    instance number
 *
 * Returns:
 *    The Zebra API client.
 */
extern struct zserv *zserv_find_client(uint8_t proto, unsigned short instance);

#if defined(HANDLE_ZAPI_FUZZING)
extern void zserv_read_file(char *input);
#endif

#endif /* _ZEBRA_ZEBRA_H */
Commit	Line	Data
	1	/*
	2	* Zebra API server.
	3	* Portions:
	4	* Copyright (C) 1997-1999 Kunihiro Ishiguro
	5	* Copyright (C) 2015-2018 Cumulus Networks, Inc.
	6	* et al.
	7	*
	8	* This program is free software; you can redistribute it and/or modify it
	9	* under the terms of the GNU General Public License as published by the Free
	10	* Software Foundation; either version 2 of the License, or (at your option)
	11	* any later version.
	12	*
	13	* This program is distributed in the hope that it will be useful, but WITHOUT
	14	* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
	15	* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
	16	* more details.
	17	*
	18	* You should have received a copy of the GNU General Public License along
	19	* with this program; see the file COPYING; if not, write to the Free Software
	20	* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
	21	*/
	22
	23	#ifndef _ZEBRA_ZSERV_H
	24	#define _ZEBRA_ZSERV_H
	25
	26	/* clang-format off */
	27	#include <stdint.h> /* for uint32_t, uint8_t */
	28	#include <time.h> /* for time_t */
	29
	30	#include "lib/route_types.h" /* for ZEBRA_ROUTE_MAX */
	31	#include "lib/zebra.h" /* for AFI_MAX */
	32	#include "lib/vrf.h" /* for vrf_bitmap_t */
	33	#include "lib/zclient.h" /* for redist_proto */
	34	#include "lib/stream.h" /* for stream, stream_fifo */
	35	#include "lib/thread.h" /* for thread, thread_master */
	36	#include "lib/linklist.h" /* for list */
	37	#include "lib/workqueue.h" /* for work_queue */
	38	#include "lib/hook.h" /* for DECLARE_HOOK, DECLARE_KOOH */
	39
	40	#include "zebra/zebra_vrf.h" /* for zebra_vrf */
	41	/* clang-format on */
	42
	43	/* Default port information. */
	44	#define ZEBRA_VTY_PORT 2601
	45
	46	/* Default configuration filename. */
	47	#define DEFAULT_CONFIG_FILE "zebra.conf"
	48
	49	#define ZEBRA_RMAP_DEFAULT_UPDATE_TIMER 5 /* disabled by default */
	50
	51	/* Client structure. */
	52	struct zserv {
	53	/* Client pthread */
	54	struct frr_pthread *pthread;
	55
	56	/* Whether the thread is waiting to be killed */
	57	_Atomic bool dead;
	58
	59	/* Client file descriptor. */
	60	int sock;
	61
	62	/* Input/output buffer to the client. */
	63	pthread_mutex_t ibuf_mtx;
	64	struct stream_fifo *ibuf_fifo;
	65	pthread_mutex_t obuf_mtx;
	66	struct stream_fifo *obuf_fifo;
	67
	68	/* Private I/O buffers */
	69	struct stream *ibuf_work;
	70	struct stream *obuf_work;
	71
	72	/* Buffer of data waiting to be written to client. */
	73	struct buffer *wb;
	74
	75	/* Threads for read/write. */
	76	struct thread *t_read;
	77	struct thread *t_write;
	78
	79	/* default routing table this client munges */
	80	int rtm_table;
	81
	82	/* This client's redistribute flag. */
	83	struct redist_proto mi_redist[AFI_MAX][ZEBRA_ROUTE_MAX];
	84	vrf_bitmap_t redist[AFI_MAX][ZEBRA_ROUTE_MAX];
	85
	86	/* Redistribute default route flag. */
	87	vrf_bitmap_t redist_default;
	88
	89	/* Interface information. */
	90	vrf_bitmap_t ifinfo;
	91
	92	/* Router-id information. */
	93	vrf_bitmap_t ridinfo;
	94
	95	bool notify_owner;
	96
	97	/* client's protocol */
	98	uint8_t proto;
	99	uint16_t instance;
	100	uint8_t is_synchronous;
	101
	102	/* Statistics */
	103	uint32_t redist_v4_add_cnt;
	104	uint32_t redist_v4_del_cnt;
	105	uint32_t redist_v6_add_cnt;
	106	uint32_t redist_v6_del_cnt;
	107	uint32_t v4_route_add_cnt;
	108	uint32_t v4_route_upd8_cnt;
	109	uint32_t v4_route_del_cnt;
	110	uint32_t v6_route_add_cnt;
	111	uint32_t v6_route_del_cnt;
	112	uint32_t v6_route_upd8_cnt;
	113	uint32_t connected_rt_add_cnt;
	114	uint32_t connected_rt_del_cnt;
	115	uint32_t ifup_cnt;
	116	uint32_t ifdown_cnt;
	117	uint32_t ifadd_cnt;
	118	uint32_t ifdel_cnt;
	119	uint32_t if_bfd_cnt;
	120	uint32_t bfd_peer_add_cnt;
	121	uint32_t bfd_peer_upd8_cnt;
	122	uint32_t bfd_peer_del_cnt;
	123	uint32_t bfd_peer_replay_cnt;
	124	uint32_t vrfadd_cnt;
	125	uint32_t vrfdel_cnt;
	126	uint32_t if_vrfchg_cnt;
	127	uint32_t bfd_client_reg_cnt;
	128	uint32_t vniadd_cnt;
	129	uint32_t vnidel_cnt;
	130	uint32_t l3vniadd_cnt;
	131	uint32_t l3vnidel_cnt;
	132	uint32_t macipadd_cnt;
	133	uint32_t macipdel_cnt;
	134	uint32_t prefixadd_cnt;
	135	uint32_t prefixdel_cnt;
	136
	137	time_t nh_reg_time;
	138	time_t nh_dereg_time;
	139	time_t nh_last_upd_time;
	140
	141	/*
	142	* Session information.
	143	*
	144	* These are not synchronous with respect to each other. For instance,
	145	* last_read_cmd may contain a value that has been read in the future
	146	* relative to last_read_time.
	147	*/
	148
	149	/* monotime of client creation */
	150	_Atomic uint32_t connect_time;
	151	/* monotime of last message received */
	152	_Atomic uint32_t last_read_time;
	153	/* monotime of last message sent */
	154	_Atomic uint32_t last_write_time;
	155	/* command code of last message read */
	156	_Atomic uint16_t last_read_cmd;
	157	/* command code of last message written */
	158	_Atomic uint16_t last_write_cmd;
	159	};
	160
	161	#define ZAPI_HANDLER_ARGS \
	162	struct zserv client, struct zmsghdr hdr, struct stream *msg, \
	163	struct zebra_vrf *zvrf
	164
	165	/* Hooks for client connect / disconnect */
	166	DECLARE_HOOK(zserv_client_connect, (struct zserv *client), (client));
	167	DECLARE_KOOH(zserv_client_close, (struct zserv *client), (client));
	168
	169	/* Zebra instance */
	170	struct zebra_t {
	171	/* Thread master */
	172	struct thread_master *master;
	173	struct list *client_list;
	174
	175	/* Socket */
	176	int sock;
	177
	178	/* default table */
	179	uint32_t rtm_table_default;
	180
	181	/* rib work queue */
	182	#define ZEBRA_RIB_PROCESS_HOLD_TIME 10
	183	struct work_queue *ribq;
	184	struct meta_queue *mq;
	185
	186	/* LSP work queue */
	187	struct work_queue *lsp_process_q;
	188
	189	#define ZEBRA_ZAPI_PACKETS_TO_PROCESS 100000
	190	_Atomic uint32_t packets_to_process;
	191	};
	192	extern struct zebra_t zebrad;
	193	extern unsigned int multipath_num;
	194
	195	/*
	196	* Initialize Zebra API server.
	197	*
	198	* Installs CLI commands and creates the client list.
	199	*/
	200	extern void zserv_init(void);
	201
	202	/*
	203	* Start Zebra API server.
	204	*
	205	* Allocates resources, creates the server socket and begins listening on the
	206	* socket.
	207	*
	208	* path
	209	* where to place the Unix domain socket
	210	*/
	211	extern void zserv_start(char *path);
	212
	213	/*
	214	* Send a message to a connected Zebra API client.
	215	*
	216	* client
	217	* the client to send to
	218	*
	219	* msg
	220	* the message to send
	221	*/
	222	extern int zserv_send_message(struct zserv client, struct stream msg);
	223
	224	/*
	225	* Retrieve a client by its protocol and instance number.
	226	*
	227	* proto
	228	* protocol number
	229	*
	230	* instance
	231	* instance number
	232	*
	233	* Returns:
	234	* The Zebra API client.
	235	*/
	236	extern struct zserv *zserv_find_client(uint8_t proto, unsigned short instance);
	237
	238	#if defined(HANDLE_ZAPI_FUZZING)
	239	extern void zserv_read_file(char *input);
	240	#endif
	241
	242	#endif /* _ZEBRA_ZEBRA_H */