]> git.proxmox.com Git - mirror_frr.git/blame - lib/command.h
OK. Here it is - PtP patch from Andrew J. Schorr. No problems with ospfd,
[mirror_frr.git] / lib / command.h
CommitLineData
718e3744 1/*
2 * Zebra configuration command interface routine
3 * Copyright (C) 1997, 98 Kunihiro Ishiguro
4 *
5 * This file is part of GNU Zebra.
6 *
7 * GNU Zebra is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published
9 * by the Free Software Foundation; either version 2, or (at your
10 * option) any later version.
11 *
12 * GNU Zebra is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with GNU Zebra; see the file COPYING. If not, write to the
19 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 * Boston, MA 02111-1307, USA.
21 */
22
23#ifndef _ZEBRA_COMMAND_H
24#define _ZEBRA_COMMAND_H
25
26#include "vector.h"
27#include "vty.h"
28
29/* Host configuration variable */
30struct host
31{
32 /* Host name of this router. */
33 char *name;
34
35 /* Password for vty interface. */
36 char *password;
37 char *password_encrypt;
38
39 /* Enable password */
40 char *enable;
41 char *enable_encrypt;
42
43 /* System wide terminal lines. */
44 int lines;
45
46 /* Log filename. */
47 char *logfile;
48
49 /* Log stdout. */
50 u_char log_stdout;
51
52 /* Log syslog. */
53 u_char log_syslog;
54
55 /* config file name of this host */
56 char *config;
57
58 /* Flags for services */
59 int advanced;
60 int encrypt;
61
62 /* Banner configuration. */
8c328f11 63 const char *motd;
718e3744 64};
65
66/* There are some command levels which called from command node. */
67enum node_type
68{
69 AUTH_NODE, /* Authentication mode of vty interface. */
70 VIEW_NODE, /* View node. Default mode of vty interface. */
71 AUTH_ENABLE_NODE, /* Authentication mode for change enable. */
72 ENABLE_NODE, /* Enable node. */
73 CONFIG_NODE, /* Config node. Default mode of config file. */
e7168df4 74 SERVICE_NODE, /* Service node. */
718e3744 75 DEBUG_NODE, /* Debug node. */
76 AAA_NODE, /* AAA node. */
77 KEYCHAIN_NODE, /* Key-chain node. */
78 KEYCHAIN_KEY_NODE, /* Key-chain key node. */
79 INTERFACE_NODE, /* Interface mode node. */
80 ZEBRA_NODE, /* zebra connection node. */
81 TABLE_NODE, /* rtm_table selection node. */
82 RIP_NODE, /* RIP protocol mode node. */
83 RIPNG_NODE, /* RIPng protocol mode node. */
84 BGP_NODE, /* BGP protocol mode which includes BGP4+ */
85 BGP_VPNV4_NODE, /* BGP MPLS-VPN PE exchange. */
86 BGP_IPV4_NODE, /* BGP IPv4 unicast address family. */
87 BGP_IPV4M_NODE, /* BGP IPv4 multicast address family. */
88 BGP_IPV6_NODE, /* BGP IPv6 address family */
89 OSPF_NODE, /* OSPF protocol mode */
90 OSPF6_NODE, /* OSPF protocol for IPv6 mode */
9e867fe6 91 ISIS_NODE, /* ISIS protocol mode */
718e3744 92 MASC_NODE, /* MASC for multicast. */
93 IRDP_NODE, /* ICMP Router Discovery Protocol mode. */
94 IP_NODE, /* Static ip route node. */
95 ACCESS_NODE, /* Access list node. */
96 PREFIX_NODE, /* Prefix list node. */
97 ACCESS_IPV6_NODE, /* Access list node. */
98 PREFIX_IPV6_NODE, /* Prefix list node. */
99 AS_LIST_NODE, /* AS list node. */
100 COMMUNITY_LIST_NODE, /* Community list node. */
101 RMAP_NODE, /* Route map node. */
102 SMUX_NODE, /* SNMP configuration node. */
103 DUMP_NODE, /* Packet dump node. */
104 FORWARDING_NODE, /* IP forwarding node. */
105 VTY_NODE /* Vty node. */
106};
107
108/* Node which has some commands and prompt string and configuration
109 function pointer . */
110struct cmd_node
111{
112 /* Node index. */
113 enum node_type node;
114
115 /* Prompt character at vty interface. */
8c328f11 116 const char *prompt;
718e3744 117
118 /* Is this node's configuration goes to vtysh ? */
119 int vtysh;
120
121 /* Node's configuration write function */
122 int (*func) (struct vty *);
123
124 /* Vector of this node's command list. */
125 vector cmd_vector;
126};
127
128/* Structure of command element. */
129struct cmd_element
130{
8c328f11 131 const char *string; /* Command specification by string. */
9035efaa 132 int (*func) (struct cmd_element *, struct vty *, int, const char *[]);
8c328f11 133 const char *doc; /* Documentation of this command. */
718e3744 134 int daemon; /* Daemon to which this command belong. */
135 vector strvec; /* Pointing out each description vector. */
8c328f11 136 unsigned int cmdsize; /* Command index count. */
718e3744 137 char *config; /* Configuration string */
138 vector subconfig; /* Sub configuration string */
139};
140
141/* Command description structure. */
142struct desc
143{
8c328f11 144 const char *cmd; /* Command string. */
145 const char *str; /* Command's description. */
718e3744 146};
147
148/* Return value of the commands. */
149#define CMD_SUCCESS 0
150#define CMD_WARNING 1
151#define CMD_ERR_NO_MATCH 2
152#define CMD_ERR_AMBIGUOUS 3
153#define CMD_ERR_INCOMPLETE 4
154#define CMD_ERR_EXEED_ARGC_MAX 5
155#define CMD_ERR_NOTHING_TODO 6
156#define CMD_COMPLETE_FULL_MATCH 7
157#define CMD_COMPLETE_MATCH 8
158#define CMD_COMPLETE_LIST_MATCH 9
159#define CMD_SUCCESS_DAEMON 10
160
161/* Argc max counts. */
162#define CMD_ARGC_MAX 25
163
164/* Turn off these macros when uisng cpp with extract.pl */
165#ifndef VTYSH_EXTRACT_PL
166
167/* DEFUN for vty command interafce. Little bit hacky ;-). */
168#define DEFUN(funcname, cmdname, cmdstr, helpstr) \
9035efaa 169 int funcname (struct cmd_element *, struct vty *, int, const char *[]); \
718e3744 170 struct cmd_element cmdname = \
171 { \
9035efaa 172 .string = cmdstr, \
173 .func = funcname, \
174 .doc = helpstr \
718e3744 175 }; \
176 int funcname \
9035efaa 177 (struct cmd_element *self, struct vty *vty, int argc, const char *argv[])
718e3744 178
179/* DEFUN_NOSH for commands that vtysh should ignore */
180#define DEFUN_NOSH(funcname, cmdname, cmdstr, helpstr) \
181 DEFUN(funcname, cmdname, cmdstr, helpstr)
182
183/* DEFSH for vtysh. */
184#define DEFSH(daemon, cmdname, cmdstr, helpstr) \
185 struct cmd_element cmdname = \
186 { \
187 cmdstr, \
188 NULL, \
189 helpstr, \
190 daemon \
191 }; \
192
193/* DEFUN + DEFSH */
194#define DEFUNSH(daemon, funcname, cmdname, cmdstr, helpstr) \
a149411b 195 int funcname (struct cmd_element *, struct vty *, int, const char *[]); \
718e3744 196 struct cmd_element cmdname = \
197 { \
198 cmdstr, \
199 funcname, \
200 helpstr, \
201 daemon \
202 }; \
203 int funcname \
a149411b 204 (struct cmd_element *self, struct vty *vty, int argc, const char *argv[])
718e3744 205
206/* ALIAS macro which define existing command's alias. */
207#define ALIAS(funcname, cmdname, cmdstr, helpstr) \
208 struct cmd_element cmdname = \
209 { \
210 cmdstr, \
211 funcname, \
212 helpstr \
213 };
214
215#endif /* VTYSH_EXTRACT_PL */
216
217/* Some macroes */
218#define CMD_OPTION(S) ((S[0]) == '[')
219#define CMD_VARIABLE(S) (((S[0]) >= 'A' && (S[0]) <= 'Z') || ((S[0]) == '<'))
220#define CMD_VARARG(S) ((S[0]) == '.')
221#define CMD_RANGE(S) ((S[0] == '<'))
222
223#define CMD_IPV4(S) ((strcmp ((S), "A.B.C.D") == 0))
224#define CMD_IPV4_PREFIX(S) ((strcmp ((S), "A.B.C.D/M") == 0))
225#define CMD_IPV6(S) ((strcmp ((S), "X:X::X:X") == 0))
226#define CMD_IPV6_PREFIX(S) ((strcmp ((S), "X:X::X:X/M") == 0))
227
228/* Common descriptions. */
229#define SHOW_STR "Show running system information\n"
230#define IP_STR "IP information\n"
231#define IPV6_STR "IPv6 information\n"
232#define NO_STR "Negate a command or set its defaults\n"
233#define CLEAR_STR "Reset functions\n"
234#define RIP_STR "RIP information\n"
235#define BGP_STR "BGP information\n"
236#define OSPF_STR "OSPF information\n"
237#define NEIGHBOR_STR "Specify neighbor router\n"
238#define DEBUG_STR "Debugging functions (see also 'undebug')\n"
239#define UNDEBUG_STR "Disable debugging functions (see also 'debug')\n"
240#define ROUTER_STR "Enable a routing process\n"
241#define AS_STR "AS number\n"
242#define MBGP_STR "MBGP information\n"
243#define MATCH_STR "Match values from routing table\n"
244#define SET_STR "Set values in destination routing protocol\n"
245#define OUT_STR "Filter outgoing routing updates\n"
246#define IN_STR "Filter incoming routing updates\n"
247#define V4NOTATION_STR "specify by IPv4 address notation(e.g. 0.0.0.0)\n"
248#define OSPF6_NUMBER_STR "Specify by number\n"
249#define INTERFACE_STR "Interface infomation\n"
250#define IFNAME_STR "Interface name(e.g. ep0)\n"
251#define IP6_STR "IPv6 Information\n"
252#define OSPF6_STR "Open Shortest Path First (OSPF) for IPv6\n"
253#define OSPF6_ROUTER_STR "Enable a routing process\n"
254#define OSPF6_INSTANCE_STR "<1-65535> Instance ID\n"
255#define SECONDS_STR "<1-65535> Seconds\n"
256#define ROUTE_STR "Routing Table\n"
257#define PREFIX_LIST_STR "Build a prefix list\n"
258#define OSPF6_DUMP_TYPE_LIST \
259"(neighbor|interface|area|lsa|zebra|config|dbex|spf|route|lsdb|redistribute|hook|asbr|prefix|abr)"
9e867fe6 260#define ISIS_STR "IS-IS information\n"
261#define AREA_TAG_STR "[area tag]\n"
718e3744 262
263#define CONF_BACKUP_EXT ".sav"
264
265/* IPv4 only machine should not accept IPv6 address for peer's IP
266 address. So we replace VTY command string like below. */
267#ifdef HAVE_IPV6
268#define NEIGHBOR_CMD "neighbor (A.B.C.D|X:X::X:X) "
269#define NO_NEIGHBOR_CMD "no neighbor (A.B.C.D|X:X::X:X) "
270#define NEIGHBOR_ADDR_STR "Neighbor address\nIPv6 address\n"
271#define NEIGHBOR_CMD2 "neighbor (A.B.C.D|X:X::X:X|WORD) "
272#define NO_NEIGHBOR_CMD2 "no neighbor (A.B.C.D|X:X::X:X|WORD) "
273#define NEIGHBOR_ADDR_STR2 "Neighbor address\nNeighbor IPv6 address\nNeighbor tag\n"
274#else
275#define NEIGHBOR_CMD "neighbor A.B.C.D "
276#define NO_NEIGHBOR_CMD "no neighbor A.B.C.D "
277#define NEIGHBOR_ADDR_STR "Neighbor address\n"
278#define NEIGHBOR_CMD2 "neighbor (A.B.C.D|WORD) "
279#define NO_NEIGHBOR_CMD2 "no neighbor (A.B.C.D|WORD) "
280#define NEIGHBOR_ADDR_STR2 "Neighbor address\nNeighbor tag\n"
281#endif /* HAVE_IPV6 */
282
283/* Prototypes. */
284void install_node (struct cmd_node *, int (*) (struct vty *));
285void install_default (enum node_type);
286void install_element (enum node_type, struct cmd_element *);
287void sort_node ();
288
42d49865 289char *argv_concat (const char **, int, int);
ea8e9d97 290vector cmd_make_strvec (const char *);
718e3744 291void cmd_free_strvec (vector);
292vector cmd_describe_command ();
293char **cmd_complete_command ();
8c328f11 294const char *cmd_prompt (enum node_type);
718e3744 295int config_from_file (struct vty *, FILE *);
296int cmd_execute_command (vector, struct vty *, struct cmd_element **);
297int cmd_execute_command_strict (vector, struct vty *, struct cmd_element **);
298void config_replace_string (struct cmd_element *, char *, ...);
299void cmd_init (int);
300
301/* Export typical functions. */
302extern struct cmd_element config_end_cmd;
303extern struct cmd_element config_exit_cmd;
304extern struct cmd_element config_quit_cmd;
305extern struct cmd_element config_help_cmd;
306extern struct cmd_element config_list_cmd;
9035efaa 307int config_exit (struct cmd_element *, struct vty *, int, const char *[]);
308int config_help (struct cmd_element *, struct vty *, int, const char *[]);
718e3744 309char *host_config_file ();
310void host_config_set (char *);
311
312#endif /* _ZEBRA_COMMAND_H */