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_AFI_CMD_STR "<ipv4|ipv6>"
32 #define BGP_AFI_HELP_STR "Address Family\nAddress Family\n"
33 #define BGP_SAFI_CMD_STR "<unicast|multicast|vpn>"
34 #define BGP_SAFI_HELP_STR \
35 "Address Family modifier\n" \
36 "Address Family modifier\n" \
37 "Address Family modifier\n"
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 "Address Family modifier\n" \
44 "Address Family modifier\n" \
45 "Address Family modifier\n" \
46 "Address Family modifier\n" \
47 "Address Family modifier\n"
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"
56 #define BGP_SHOW_PEER_GR_CAPABILITY( \
57 vty, p, use_json, json) \
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); \
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
77 #define VTY_BGP_GR_ROUTER_DETECT(_bgp, _peer, _peer_list) \
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; \
89 #define VTY_SEND_BGP_GR_CAPABILITY_TO_ZEBRA(_bgp, _ret) \
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; \
103 #define VTY_BGP_GR_ROUTER_DETECT_AND_SEND_CAPABILITY_TO_ZEBRA( \
104 _bgp, _peer_list, _ret) \
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; \
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; \
130 #define PRINT_EOR(_eor_flag) \
133 vty_out(vty, "Yes\n"); \
135 vty_out(vty, "No\n"); \
138 #define PRINT_EOR_JSON(_eor_flag) \
141 json_object_boolean_true_add( \
142 json_endofrib_status, \
143 "endOfRibSentAfterUpdate"); \
145 json_object_boolean_false_add( \
146 json_endofrib_status, \
147 "endOfRibSentAfterUpdate"); \
150 extern void bgp_vty_init(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 struct peer
*peer_and_group_lookup_vty(struct vty
*vty
,
161 const char *peer_str
);
163 extern afi_t
bgp_vty_afi_from_str(const char *afi_str
);
165 extern safi_t
bgp_vty_safi_from_str(const char *safi_str
);
167 extern int argv_find_and_parse_afi(struct cmd_token
**argv
, int argc
,
168 int *index
, afi_t
*afi
);
170 extern int argv_find_and_parse_safi(struct cmd_token
**argv
, int argc
,
171 int *index
, safi_t
*safi
);
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
,
176 safi_t
*safi
, struct bgp
**bgp
,
178 int bgp_vty_find_and_parse_bgp(struct vty
*vty
, struct cmd_token
**argv
,
179 int argc
, struct bgp
**bgp
, bool use_json
);
180 extern int bgp_show_summary_vty(struct vty
*vty
, const char *name
, afi_t afi
,
181 safi_t safi
, bool show_failed
, bool use_json
);
183 #endif /* _QUAGGA_BGP_VTY_H */