2 * Copyright (C) 1996, 97, 98, 99, 2000 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 the
8 * Free Software Foundation; either version 2, or (at your option) any
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 _QUAGGA_BGP_VTY_H
22 #define _QUAGGA_BGP_VTY_H
24 #include "bgpd/bgpd.h"
28 #define BGP_INSTANCE_HELP_STR "BGP view\nBGP VRF\nView/VRF name\n"
29 #define BGP_INSTANCE_ALL_HELP_STR "BGP view\nBGP VRF\nAll Views/VRFs\n"
31 #define BGP_AF_STR "Address Family\n"
32 #define BGP_AF_MODIFIER_STR "Address Family modifier\n"
33 #define BGP_AFI_CMD_STR "<ipv4|ipv6>"
34 #define BGP_AFI_HELP_STR BGP_AF_STR BGP_AF_STR
35 #define BGP_SAFI_CMD_STR "<unicast|multicast|vpn>"
36 #define BGP_SAFI_HELP_STR \
37 BGP_AF_MODIFIER_STR BGP_AF_MODIFIER_STR BGP_AF_MODIFIER_STR
38 #define BGP_AFI_SAFI_CMD_STR BGP_AFI_CMD_STR" "BGP_SAFI_CMD_STR
39 #define BGP_AFI_SAFI_HELP_STR BGP_AFI_HELP_STR BGP_SAFI_HELP_STR
41 #define BGP_SAFI_WITH_LABEL_CMD_STR "<unicast|multicast|vpn|labeled-unicast|flowspec>"
42 #define BGP_SAFI_WITH_LABEL_HELP_STR \
43 BGP_AF_MODIFIER_STR BGP_AF_MODIFIER_STR BGP_AF_MODIFIER_STR \
44 BGP_AF_MODIFIER_STR BGP_AF_MODIFIER_STR
46 #define SHOW_GR_HEADER \
47 "Codes: GR - Graceful Restart," \
48 " * - Inheriting Global GR Config,\n" \
49 " Restart - GR Mode-Restarting," \
50 " Helper - GR Mode-Helper,\n" \
51 " Disable - GR Mode-Disable.\n\n"
53 #define BGP_SHOW_SUMMARY_HEADER_ALL \
54 "V AS MsgRcvd MsgSent TblVer InQ OutQ Up/Down State/PfxRcd PfxSnt Desc\n"
55 #define BGP_SHOW_SUMMARY_HEADER_ALL_WIDE \
56 "V AS LocalAS MsgRcvd MsgSent TblVer InQ OutQ Up/Down State/PfxRcd PfxSnt Desc\n"
57 #define BGP_SHOW_SUMMARY_HEADER_FAILED "EstdCnt DropCnt ResetTime Reason\n"
59 #define BGP_SHOW_PEER_GR_CAPABILITY(vty, p, json) \
61 bgp_show_neighbor_graceful_restart_local_mode(vty, p, json); \
62 bgp_show_neighbor_graceful_restart_remote_mode(vty, p, json); \
63 bgp_show_neighnor_graceful_restart_flags(vty, p, json); \
64 bgp_show_neighbor_graceful_restart_time(vty, p, json); \
65 bgp_show_neighbor_graceful_restart_capability_per_afi_safi( \
69 #define VTY_BGP_GR_DEFINE_LOOP_VARIABLE \
70 struct peer *peer_loop = NULL; \
71 struct listnode *node = NULL; \
72 struct listnode *nnode = NULL; \
73 bool gr_router_detected = false
75 #define VTY_BGP_GR_ROUTER_DETECT(_bgp, _peer, _peer_list) \
77 if (_peer->bgp->t_startup) \
78 bgp_peer_gr_flags_update(_peer); \
79 for (ALL_LIST_ELEMENTS(_peer_list, node, nnode, peer_loop)) { \
80 if (CHECK_FLAG(peer_loop->flags, \
81 PEER_FLAG_GRACEFUL_RESTART)) \
82 gr_router_detected = true; \
87 #define VTY_SEND_BGP_GR_CAPABILITY_TO_ZEBRA(_bgp, _ret) \
89 if (gr_router_detected \
90 && _bgp->present_zebra_gr_state == ZEBRA_GR_DISABLE) { \
91 if (bgp_zebra_send_capabilities(_bgp, false)) \
92 _ret = BGP_ERR_INVALID_VALUE; \
93 } else if (!gr_router_detected \
94 && _bgp->present_zebra_gr_state \
95 == ZEBRA_GR_ENABLE) { \
96 if (bgp_zebra_send_capabilities(_bgp, true)) \
97 _ret = BGP_ERR_INVALID_VALUE; \
101 #define VTY_BGP_GR_ROUTER_DETECT_AND_SEND_CAPABILITY_TO_ZEBRA( \
102 _bgp, _peer_list, _ret) \
104 struct peer *peer_loop; \
105 bool gr_router_detected = false; \
106 struct listnode *node = {0}; \
107 struct listnode *nnode = {0}; \
108 for (ALL_LIST_ELEMENTS(_peer_list, node, nnode, peer_loop)) { \
109 if (peer_loop->bgp->t_startup) \
110 bgp_peer_gr_flags_update(peer_loop); \
111 if (CHECK_FLAG(peer_loop->flags, \
112 PEER_FLAG_GRACEFUL_RESTART)) \
113 gr_router_detected = true; \
115 if (gr_router_detected \
116 && _bgp->present_zebra_gr_state == ZEBRA_GR_DISABLE) { \
117 if (bgp_zebra_send_capabilities(_bgp, false)) \
118 _ret = BGP_ERR_INVALID_VALUE; \
119 } else if (!gr_router_detected \
120 && _bgp->present_zebra_gr_state \
121 == ZEBRA_GR_ENABLE) { \
122 if (bgp_zebra_send_capabilities(_bgp, true)) \
123 _ret = BGP_ERR_INVALID_VALUE; \
128 #define PRINT_EOR(_eor_flag) \
131 vty_out(vty, "Yes\n"); \
133 vty_out(vty, "No\n"); \
136 #define PRINT_EOR_JSON(_eor_flag) \
139 json_object_boolean_true_add( \
140 json_endofrib_status, \
141 "endOfRibSentAfterUpdate"); \
143 json_object_boolean_false_add( \
144 json_endofrib_status, \
145 "endOfRibSentAfterUpdate"); \
148 extern void bgp_clear_soft_in(struct bgp
*bgp
, afi_t afi
, safi_t safi
);
149 extern void bgp_vty_init(void);
150 extern void community_alias_vty(void);
151 extern const char *get_afi_safi_str(afi_t afi
, safi_t safi
, bool for_json
);
152 extern int bgp_get_vty(struct bgp
**bgp
, as_t
*as
, const char *name
,
153 enum bgp_instance_type inst_type
);
154 extern void bgp_config_write_update_delay(struct vty
*vty
, struct bgp
*bgp
);
155 extern void bgp_config_write_wpkt_quanta(struct vty
*vty
, struct bgp
*bgp
);
156 extern void bgp_config_write_rpkt_quanta(struct vty
*vty
, struct bgp
*bgp
);
157 extern void bgp_config_write_listen(struct vty
*vty
, struct bgp
*bgp
);
158 extern void bgp_config_write_coalesce_time(struct vty
*vty
, struct bgp
*bgp
);
159 extern int bgp_vty_return(struct vty
*vty
, int ret
);
160 extern bool bgp_config_inprocess(void);
161 extern struct peer
*peer_and_group_lookup_vty(struct vty
*vty
,
162 const char *peer_str
);
164 extern afi_t
bgp_vty_afi_from_str(const char *afi_str
);
166 extern safi_t
bgp_vty_safi_from_str(const char *safi_str
);
168 extern int argv_find_and_parse_afi(struct cmd_token
**argv
, int argc
,
169 int *index
, afi_t
*afi
);
171 extern int argv_find_and_parse_safi(struct cmd_token
**argv
, int argc
,
172 int *index
, safi_t
*safi
);
174 extern int bgp_vty_find_and_parse_afi_safi_bgp(struct vty
*vty
,
175 struct cmd_token
**argv
,
176 int argc
, int *idx
, afi_t
*afi
,
177 safi_t
*safi
, struct bgp
**bgp
,
179 int bgp_vty_find_and_parse_bgp(struct vty
*vty
, struct cmd_token
**argv
,
180 int argc
, struct bgp
**bgp
, bool use_json
);
181 extern int bgp_show_summary_vty(struct vty
*vty
, const char *name
, afi_t afi
,
182 safi_t safi
, const char *neighbor
, int as_type
,
183 as_t as
, uint16_t show_flags
);
184 extern bool peergroup_flag_check(struct peer
*peer
, uint64_t flag
);
186 #endif /* _QUAGGA_BGP_VTY_H */