[mirror_frr.git] / bgpd / bgp_vty.h

/* BGP VTY interface.
 * Copyright (C) 1996, 97, 98, 99, 2000 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 _QUAGGA_BGP_VTY_H
#define _QUAGGA_BGP_VTY_H

#include "bgpd/bgpd.h"
#include "stream.h"
struct bgp;

#define BGP_INSTANCE_HELP_STR "BGP view\nBGP VRF\nView/VRF name\n"
#define BGP_INSTANCE_ALL_HELP_STR "BGP view\nBGP VRF\nAll Views/VRFs\n"

#define BGP_AFI_CMD_STR         "<ipv4|ipv6>"
#define BGP_AFI_HELP_STR        "Address Family\nAddress Family\n"
#define BGP_SAFI_CMD_STR        "<unicast|multicast|vpn>"
#define BGP_SAFI_HELP_STR                                                      \
	"Address Family modifier\n"                                            \
	"Address Family modifier\n"                                            \
	"Address Family modifier\n"
#define BGP_AFI_SAFI_CMD_STR    BGP_AFI_CMD_STR" "BGP_SAFI_CMD_STR
#define BGP_AFI_SAFI_HELP_STR   BGP_AFI_HELP_STR BGP_SAFI_HELP_STR

#define BGP_SAFI_WITH_LABEL_CMD_STR  "<unicast|multicast|vpn|labeled-unicast|flowspec>"
#define BGP_SAFI_WITH_LABEL_HELP_STR                                           \
	"Address Family modifier\n"                                            \
	"Address Family modifier\n"                                            \
	"Address Family modifier\n"                                            \
	"Address Family modifier\n"                                            \
	"Address Family modifier\n"

#define SHOW_GR_HEADER \
	"Codes: GR - Graceful Restart," \
	" * -  Inheriting Global GR Config,\n" \
	"       Restart - GR Mode-Restarting," \
	" Helper - GR Mode-Helper,\n" \
	"       Disable - GR Mode-Disable.\n\n"

#define BGP_SHOW_PEER_GR_CAPABILITY( \
			vty, p, use_json, json) \
	do {			\
		bgp_show_neighbor_graceful_restart_local_mode( \
				vty, p, use_json, json);		\
		bgp_show_neighbor_graceful_restart_remote_mode( \
				vty, p, use_json, json); \
		bgp_show_neighnor_graceful_restart_rbit( \
				vty, p, use_json, json);	\
		bgp_show_neighbor_graceful_restart_time( \
				vty, p, use_json, json);	\
		bgp_show_neighbor_graceful_restart_capability_per_afi_safi(\
						vty, p, use_json, json); \
	} while (0)

#define VTY_BGP_GR_DEFINE_LOOP_VARIABLE                                        \
	struct peer *peer_loop = NULL;                                         \
	struct listnode *node = NULL;                                          \
	struct listnode *nnode = NULL;                                         \
	bool gr_router_detected = false

#define VTY_BGP_GR_ROUTER_DETECT(_bgp, _peer, _peer_list)                      \
	do {                                                                   \
		if (_peer->bgp->t_startup)                                     \
			bgp_peer_gr_flags_update(_peer);                       \
		for (ALL_LIST_ELEMENTS(_peer_list, node, nnode, peer_loop)) {  \
			if (CHECK_FLAG(peer_loop->flags,                       \
				       PEER_FLAG_GRACEFUL_RESTART))            \
				gr_router_detected = true;                     \
		}                                                              \
	} while (0)


#define VTY_SEND_BGP_GR_CAPABILITY_TO_ZEBRA(_bgp, _ret)                        \
	do {                                                                   \
		if (gr_router_detected                                         \
		    && _bgp->present_zebra_gr_state == ZEBRA_GR_DISABLE) {     \
			if (bgp_zebra_send_capabilities(_bgp, false))          \
				_ret = BGP_ERR_INVALID_VALUE;                  \
		} else if (!gr_router_detected                                 \
			   && _bgp->present_zebra_gr_state                     \
				      == ZEBRA_GR_ENABLE) {                    \
			if (bgp_zebra_send_capabilities(_bgp, true))           \
				_ret = BGP_ERR_INVALID_VALUE;                  \
		}                                                              \
	} while (0)

#define VTY_BGP_GR_ROUTER_DETECT_AND_SEND_CAPABILITY_TO_ZEBRA(                 \
	_bgp, _peer_list, _ret)                                                \
	do {                                                                   \
		struct peer *peer_loop;                                        \
		bool gr_router_detected = false;                               \
		struct listnode *node = {0};                                   \
		struct listnode *nnode = {0};                                  \
		for (ALL_LIST_ELEMENTS(_peer_list, node, nnode, peer_loop)) {  \
			if (peer_loop->bgp->t_startup)                         \
				bgp_peer_gr_flags_update(peer_loop);           \
			if (CHECK_FLAG(peer_loop->flags,                       \
				       PEER_FLAG_GRACEFUL_RESTART))            \
				gr_router_detected = true;                     \
		}                                                              \
		if (gr_router_detected                                         \
		    && _bgp->present_zebra_gr_state == ZEBRA_GR_DISABLE) {     \
			if (bgp_zebra_send_capabilities(_bgp, false))          \
				_ret = BGP_ERR_INVALID_VALUE;                  \
		} else if (!gr_router_detected                                 \
			   && _bgp->present_zebra_gr_state                     \
				      == ZEBRA_GR_ENABLE) {                    \
			if (bgp_zebra_send_capabilities(_bgp, true))           \
				_ret = BGP_ERR_INVALID_VALUE;                  \
		}                                                              \
	} while (0)


#define PRINT_EOR(_eor_flag)                                                   \
	do {                                                                   \
		if (eor_flag)                                                  \
			vty_out(vty, "Yes\n");                                 \
		else                                                           \
			vty_out(vty, "No\n");                                  \
	} while (0)

#define PRINT_EOR_JSON(_eor_flag)                                              \
	do {                                                                   \
		if (eor_flag)                                                  \
			json_object_boolean_true_add(                          \
				json_endofrib_status,                          \
				"endOfRibSentAfterUpdate");                    \
		else                                                           \
			json_object_boolean_false_add(                         \
				json_endofrib_status,                          \
				"endOfRibSentAfterUpdate");                    \
	} while (0)

extern void bgp_vty_init(void);
extern const char *get_afi_safi_str(afi_t afi, safi_t safi, bool for_json);
extern int bgp_get_vty(struct bgp **bgp, as_t *as, const char *name,
		       enum bgp_instance_type inst_type);
extern void bgp_config_write_update_delay(struct vty *vty, struct bgp *bgp);
extern void bgp_config_write_wpkt_quanta(struct vty *vty, struct bgp *bgp);
extern void bgp_config_write_rpkt_quanta(struct vty *vty, struct bgp *bgp);
extern void bgp_config_write_listen(struct vty *vty, struct bgp *bgp);
extern void bgp_config_write_coalesce_time(struct vty *vty, struct bgp *bgp);
extern int bgp_vty_return(struct vty *vty, int ret);
extern struct peer *peer_and_group_lookup_vty(struct vty *vty,
					      const char *peer_str);

extern afi_t bgp_vty_afi_from_str(const char *afi_str);

extern safi_t bgp_vty_safi_from_str(const char *safi_str);

extern int argv_find_and_parse_afi(struct cmd_token **argv, int argc,
				   int *index, afi_t *afi);

extern int argv_find_and_parse_safi(struct cmd_token **argv, int argc,
				    int *index, safi_t *safi);

extern int bgp_vty_find_and_parse_afi_safi_bgp(struct vty *vty,
					       struct cmd_token **argv,
					       int argc, int *idx, afi_t *afi,
					       safi_t *safi, struct bgp **bgp,
					       bool use_json);
extern int bgp_show_summary_vty(struct vty *vty, const char *name, afi_t afi,
				safi_t safi, bool show_failed, bool use_json);

#endif /* _QUAGGA_BGP_VTY_H */
Commit	Line	Data
718e3744	1	/* BGP VTY interface.
896014f4 DL	2	* Copyright (C) 1996, 97, 98, 99, 2000 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 the
	8	* Free Software Foundation; either version 2, or (at your option) any
	9	* later version.
	10	*
	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.
	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
	19	*/
718e3744	20
00d252cb	21	#ifndef _QUAGGA_BGP_VTY_H
	22	#define _QUAGGA_BGP_VTY_H
	23
5d5393b9	24	#include "bgpd/bgpd.h"
b0965c44	25	#include "stream.h"
896af92e	26	struct bgp;
ffd0c037	27
8386ac43	28	#define BGP_INSTANCE_HELP_STR "BGP view\nBGP VRF\nView/VRF name\n"
f186de26	29	#define BGP_INSTANCE_ALL_HELP_STR "BGP view\nBGP VRF\nAll Views/VRFs\n"
0b2aa3a0	30
46f296b4 LB	31	#define BGP_AFI_CMD_STR "<ipv4\|ipv6>"
46f296b4 LB	32	#define BGP_AFI_HELP_STR "Address Family\nAddress Family\n"
9bedbb1e	33	#define BGP_SAFI_CMD_STR "<unicast\|multicast\|vpn>"
d62a17ae	34	#define BGP_SAFI_HELP_STR \
	35	"Address Family modifier\n" \
	36	"Address Family modifier\n" \
	37	"Address Family modifier\n"
46f296b4 LB	38	#define BGP_AFI_SAFI_CMD_STR BGP_AFI_CMD_STR" "BGP_SAFI_CMD_STR
46f296b4 LB	39	#define BGP_AFI_SAFI_HELP_STR BGP_AFI_HELP_STR BGP_SAFI_HELP_STR
ccbb332a	40
7c40bf39	41	#define BGP_SAFI_WITH_LABEL_CMD_STR "<unicast\|multicast\|vpn\|labeled-unicast\|flowspec>"
d62a17ae	42	#define BGP_SAFI_WITH_LABEL_HELP_STR \
	43	"Address Family modifier\n" \
	44	"Address Family modifier\n" \
	45	"Address Family modifier\n" \
7c40bf39	46	"Address Family modifier\n" \
d62a17ae	47	"Address Family modifier\n"
9bedbb1e	48
b0965c44	49	#define SHOW_GR_HEADER \
	50	"Codes: GR - Graceful Restart," \
	51	" * - Inheriting Global GR Config,\n" \
	52	" Restart - GR Mode-Restarting," \
	53	" Helper - GR Mode-Helper,\n" \
	54	" Disable - GR Mode-Disable.\n\n"
	55
	56	#define BGP_SHOW_PEER_GR_CAPABILITY( \
	57	vty, p, use_json, json) \
	58	do { \
	59	bgp_show_neighbor_graceful_restart_local_mode( \
	60	vty, p, use_json, json); \
	61	bgp_show_neighbor_graceful_restart_remote_mode( \
	62	vty, p, use_json, json); \
	63	bgp_show_neighnor_graceful_restart_rbit( \
	64	vty, p, use_json, json); \
	65	bgp_show_neighbor_graceful_restart_time( \
	66	vty, p, use_json, json); \
	67	bgp_show_neighbor_graceful_restart_capability_per_afi_safi(\
	68	vty, p, use_json, json); \
	69	} while (0)
	70
36235319 QY	71	#define VTY_BGP_GR_DEFINE_LOOP_VARIABLE \
	72	struct peer *peer_loop = NULL; \
	73	struct listnode *node = NULL; \
	74	struct listnode *nnode = NULL; \
	75	bool gr_router_detected = false
	76
	77	#define VTY_BGP_GR_ROUTER_DETECT(_bgp, _peer, _peer_list) \
	78	do { \
	79	if (_peer->bgp->t_startup) \
	80	bgp_peer_gr_flags_update(_peer); \
	81	for (ALL_LIST_ELEMENTS(_peer_list, node, nnode, peer_loop)) { \
	82	if (CHECK_FLAG(peer_loop->flags, \
	83	PEER_FLAG_GRACEFUL_RESTART)) \
	84	gr_router_detected = true; \
	85	} \
2d3dd828	86	} while (0)
	87
	88
36235319 QY	89	#define VTY_SEND_BGP_GR_CAPABILITY_TO_ZEBRA(_bgp, _ret) \
	90	do { \
	91	if (gr_router_detected \
	92	&& _bgp->present_zebra_gr_state == ZEBRA_GR_DISABLE) { \
	93	if (bgp_zebra_send_capabilities(_bgp, false)) \
	94	_ret = BGP_ERR_INVALID_VALUE; \
	95	} else if (!gr_router_detected \
	96	&& _bgp->present_zebra_gr_state \
	97	== ZEBRA_GR_ENABLE) { \
	98	if (bgp_zebra_send_capabilities(_bgp, true)) \
	99	_ret = BGP_ERR_INVALID_VALUE; \
	100	} \
2d3dd828	101	} while (0)
2d3dd828	102
36235319 QY	103	#define VTY_BGP_GR_ROUTER_DETECT_AND_SEND_CAPABILITY_TO_ZEBRA( \
	104	_bgp, _peer_list, _ret) \
	105	do { \
	106	struct peer *peer_loop; \
	107	bool gr_router_detected = false; \
	108	struct listnode *node = {0}; \
	109	struct listnode *nnode = {0}; \
	110	for (ALL_LIST_ELEMENTS(_peer_list, node, nnode, peer_loop)) { \
	111	if (peer_loop->bgp->t_startup) \
	112	bgp_peer_gr_flags_update(peer_loop); \
	113	if (CHECK_FLAG(peer_loop->flags, \
	114	PEER_FLAG_GRACEFUL_RESTART)) \
	115	gr_router_detected = true; \
	116	} \
	117	if (gr_router_detected \
	118	&& _bgp->present_zebra_gr_state == ZEBRA_GR_DISABLE) { \
	119	if (bgp_zebra_send_capabilities(_bgp, false)) \
	120	_ret = BGP_ERR_INVALID_VALUE; \
	121	} else if (!gr_router_detected \
	122	&& _bgp->present_zebra_gr_state \
	123	== ZEBRA_GR_ENABLE) { \
	124	if (bgp_zebra_send_capabilities(_bgp, true)) \
	125	_ret = BGP_ERR_INVALID_VALUE; \
	126	} \
2d3dd828	127	} while (0)
2d3dd828	128
9e3b51a7	129
36235319 QY	130	#define PRINT_EOR(_eor_flag) \
	131	do { \
	132	if (eor_flag) \
	133	vty_out(vty, "Yes\n"); \
	134	else \
	135	vty_out(vty, "No\n"); \
9e3b51a7	136	} while (0)
9e3b51a7	137
36235319 QY	138	#define PRINT_EOR_JSON(_eor_flag) \
	139	do { \
	140	if (eor_flag) \
	141	json_object_boolean_true_add( \
	142	json_endofrib_status, \
	143	"endOfRibSentAfterUpdate"); \
	144	else \
	145	json_object_boolean_false_add( \
	146	json_endofrib_status, \
	147	"endOfRibSentAfterUpdate"); \
9e3b51a7	148	} while (0)
9e3b51a7	149
d62a17ae	150	extern void bgp_vty_init(void);
5cb5f4d0	151	extern const char *get_afi_safi_str(afi_t afi, safi_t safi, bool for_json);
5d5393b9 DL	152	extern int bgp_get_vty(struct bgp *bgp, as_t as, const char *name,
5d5393b9 DL	153	enum bgp_instance_type inst_type);
8ef6371e	154	extern void bgp_config_write_update_delay(struct vty vty, struct bgp bgp);
2b791107	155	extern void bgp_config_write_wpkt_quanta(struct vty vty, struct bgp bgp);
555e09d4	156	extern void bgp_config_write_rpkt_quanta(struct vty vty, struct bgp bgp);
2b791107 DL	157	extern void bgp_config_write_listen(struct vty vty, struct bgp bgp);
2b791107 DL	158	extern void bgp_config_write_coalesce_time(struct vty vty, struct bgp bgp);
d62a17ae	159	extern int bgp_vty_return(struct vty *vty, int ret);
	160	extern struct peer peer_and_group_lookup_vty(struct vty vty,
	161	const char *peer_str);
00d252cb	162
d62a17ae	163	extern afi_t bgp_vty_afi_from_str(const char *afi_str);
46f296b4	164
d62a17ae	165	extern safi_t bgp_vty_safi_from_str(const char *safi_str);
ccbb332a	166
d62a17ae	167	extern int argv_find_and_parse_afi(struct cmd_token **argv, int argc,
d62a17ae	168	int index, afi_t afi);
46f296b4	169
d62a17ae	170	extern int argv_find_and_parse_safi(struct cmd_token **argv, int argc,
d62a17ae	171	int index, safi_t safi);
46f296b4	172
d62a17ae	173	extern int bgp_vty_find_and_parse_afi_safi_bgp(struct vty *vty,
	174	struct cmd_token **argv,
	175	int argc, int idx, afi_t afi,
9f049418 DS	176	safi_t safi, struct bgp *bgp,
9f049418 DS	177	bool use_json);
d62a17ae	178	extern int bgp_show_summary_vty(struct vty vty, const char name, afi_t afi,
3577f1c5	179	safi_t safi, bool show_failed, bool use_json);
dd65f45e	180
00d252cb	181	#endif /* _QUAGGA_BGP_VTY_H */