]>
git.proxmox.com Git - mirror_frr.git/blob - lib/vty.h
1 /* Virtual terminal [aka TeletYpe] interface routine
2 Copyright (C) 1997 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
17 along with GNU Zebra; see the file COPYING. If not, write to the Free
18 Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
26 #include "sockunion.h"
29 #define VTY_BUFSIZ 4096
30 #define VTY_MAXHIST 20
35 /* File descripter of this vty. */
38 /* output FD, to support stdin/stdout combination */
41 /* Is this vty connect to file or not */
42 enum {VTY_TERM
, VTY_FILE
, VTY_SHELL
, VTY_SHELL_SERV
} type
;
44 /* Node status of this vty */
53 /* Command input buffer */
56 /* Command input error buffer */
59 /* Command cursor point */
65 /* Command max length. */
68 /* Histry of command */
69 char *hist
[VTY_MAXHIST
];
71 /* History lookup current point */
74 /* History insert end point */
77 /* qobj object ID (replacement for "index") */
80 /* qobj second-level object ID (replacement for "index_sub") */
81 uint64_t qobj_index_sub
;
83 /* For escape character. */
86 /* Current vty status. */
87 enum {VTY_NORMAL
, VTY_CLOSE
, VTY_MORE
, VTY_MORELINE
} status
;
89 /* IAC handling: was the last character received the
90 IAC (interpret-as-command) escape character (and therefore the next
91 character will be the command code)? Refer to Telnet RFC 854. */
94 /* IAC SB (option subnegotiation) handling */
95 unsigned char iac_sb_in_progress
;
96 /* At the moment, we care only about the NAWS (window size) negotiation,
97 and that requires just a 5-character buffer (RFC 1073):
98 <NAWS char> <16-bit width> <16-bit height> */
99 #define TELNET_NAWS_SB_LEN 5
100 unsigned char sb_buf
[TELNET_NAWS_SB_LEN
];
101 /* How many subnegotiation characters have we received? We just drop
102 those that do not fit in the buffer. */
105 /* Window width/height. */
109 /* Configure lines. */
112 /* Terminal monitor. */
115 /* In configure mode. */
118 /* Read and write thread. */
119 struct thread
*t_read
;
120 struct thread
*t_write
;
122 /* Timeout seconds and thread. */
123 unsigned long v_timeout
;
124 struct thread
*t_timeout
;
126 /* What address is this vty comming from. */
127 char address
[SU_ADDRSTRLEN
];
130 static inline void vty_push_context(struct vty
*vty
,
131 int node
, uint64_t id
)
134 vty
->qobj_index
= id
;
137 /* note: VTY_PUSH_CONTEXT(..., NULL) doesn't work, since it will try to
138 * dereference "NULL->qobj_node.nid" */
139 #define VTY_PUSH_CONTEXT(nodeval, ptr) \
140 vty_push_context(vty, nodeval, QOBJ_ID_0SAFE(ptr))
141 #define VTY_PUSH_CONTEXT_NULL(nodeval) \
142 vty_push_context(vty, nodeval, 0ULL)
143 #define VTY_PUSH_CONTEXT_SUB(nodeval, ptr) do { \
144 vty->node = nodeval; \
145 /* qobj_index stays untouched */ \
146 vty->qobj_index_sub = QOBJ_ID_0SAFE(ptr); \
149 /* can return NULL if context is invalid! */
150 #define VTY_GET_CONTEXT(structname) \
151 QOBJ_GET_TYPESAFE(vty->qobj_index, structname)
152 #define VTY_GET_CONTEXT_SUB(structname) \
153 QOBJ_GET_TYPESAFE(vty->qobj_index_sub, structname)
155 /* will return if ptr is NULL. */
156 #define VTY_CHECK_CONTEXT(ptr) \
158 vty_out (vty, "Current configuration object was deleted " \
159 "by another process.%s", VTY_NEWLINE); \
160 return CMD_WARNING; \
163 /* struct structname *ptr = <context>; ptr will never be NULL. */
164 #define VTY_DECLVAR_CONTEXT(structname, ptr) \
165 struct structname *ptr = VTY_GET_CONTEXT(structname); \
166 VTY_CHECK_CONTEXT(ptr);
167 #define VTY_DECLVAR_CONTEXT_SUB(structname, ptr) \
168 struct structname *ptr = VTY_GET_CONTEXT_SUB(structname); \
169 VTY_CHECK_CONTEXT(ptr);
179 /* Integrated configuration file. */
180 #define INTEGRATE_DEFAULT_CONFIG "frr.conf"
182 /* Small macro to determine newline is newline only or linefeed needed. */
183 #define VTY_NEWLINE ((vty->type == VTY_TERM) ? "\r\n" : "\n")
185 /* Default time out value */
186 #define VTY_TIMEOUT_DEFAULT 600
188 /* Vty read buffer size. */
189 #define VTY_READ_BUFSIZ 512
191 /* Directory separator. */
192 #ifndef DIRECTORY_SEP
193 #define DIRECTORY_SEP '/'
194 #endif /* DIRECTORY_SEP */
196 #ifndef IS_DIRECTORY_SEP
197 #define IS_DIRECTORY_SEP(c) ((c) == DIRECTORY_SEP)
200 /* GCC have printf type attribute check. */
202 #define PRINTF_ATTRIBUTE(a,b) __attribute__ ((__format__ (__printf__, a, b)))
204 #define PRINTF_ATTRIBUTE(a,b)
205 #endif /* __GNUC__ */
207 /* Utility macros to convert VTY argument to unsigned long */
208 #define VTY_GET_ULONG(NAME,V,STR) \
210 char *endptr = NULL; \
212 (V) = strtoul ((STR), &endptr, 10); \
215 vty_out (vty, "%% Invalid %s value (dash)%s", NAME, VTY_NEWLINE); \
216 return CMD_WARNING; \
218 if (*endptr != '\0') \
220 vty_out (vty, "%% Invalid %s value (%s)%s", NAME, endptr, VTY_NEWLINE); \
221 return CMD_WARNING; \
225 vty_out (vty, "%% Invalid %s value (error %d)%s", NAME, errno, VTY_NEWLINE); \
226 return CMD_WARNING; \
230 /* Utility macros to convert VTY argument to unsigned long long */
231 #define VTY_GET_ULL(NAME,V,STR) \
233 char *endptr = NULL; \
235 (V) = strtoull ((STR), &endptr, 10); \
238 vty_out (vty, "%% Invalid %s value (dash)%s", NAME, VTY_NEWLINE); \
239 return CMD_WARNING; \
241 if (*endptr != '\0') \
243 vty_out (vty, "%% Invalid %s value (%s)%s", NAME, endptr, VTY_NEWLINE); \
244 return CMD_WARNING; \
248 vty_out (vty, "%% Invalid %s value (error %d)%s", NAME, errno, VTY_NEWLINE); \
249 return CMD_WARNING; \
254 * The logic below ((TMPL) <= ((MIN) && (TMPL) != (MIN)) is
255 * done to circumvent the compiler complaining about
256 * comparing unsigned numbers against zero, if MIN is zero.
257 * NB: The compiler isn't smart enough to supress the warning
258 * if you write (MIN) != 0 && tmpl < (MIN).
260 #define VTY_GET_INTEGER_RANGE_HEART(NAME,TMPL,STR,MIN,MAX) \
262 VTY_GET_ULONG(NAME, (TMPL), STR); \
263 if ( ((TMPL) <= (MIN) && (TMPL) != (MIN)) || (TMPL) > (MAX) ) \
265 vty_out (vty, "%% Invalid %s value%s", NAME, VTY_NEWLINE);\
266 return CMD_WARNING; \
270 #define VTY_GET_INTEGER_RANGE(NAME,V,STR,MIN,MAX) \
272 unsigned long long tmpl; \
273 VTY_GET_INTEGER_RANGE_HEART(NAME,tmpl,STR,MIN,MAX); \
277 #define VTY_CHECK_INTEGER_RANGE(NAME,STR,MIN,MAX) \
279 unsigned long tmpl; \
280 VTY_GET_INTEGER_RANGE_HEART(NAME,tmpl,STR,MIN,MAX); \
283 #define VTY_GET_INTEGER(NAME,V,STR) \
284 VTY_GET_INTEGER_RANGE(NAME,V,STR,0U,UINT32_MAX)
286 #define VTY_GET_IPV4_ADDRESS(NAME,V,STR) \
289 retv = inet_aton ((STR), &(V)); \
292 vty_out (vty, "%% Invalid %s value%s", NAME, VTY_NEWLINE); \
293 return CMD_WARNING; \
297 #define VTY_GET_IPV4_PREFIX(NAME,V,STR) \
300 retv = str2prefix_ipv4 ((STR), &(V)); \
303 vty_out (vty, "%% Invalid %s value%s", NAME, VTY_NEWLINE); \
304 return CMD_WARNING; \
308 #define VTY_WARN_EXPERIMENTAL() \
310 vty_out (vty, "%% WARNING: this command is experimental. Both its name and" \
311 " parameters may%s%% change in a future version of Quagga," \
312 " possibly breaking your configuration!%s", \
313 VTY_NEWLINE, VTY_NEWLINE); \
316 /* Exported variables */
317 extern char integrate_default
[];
320 extern void vty_init (struct thread_master
*);
321 extern void vty_init_vtysh (void);
322 extern void vty_terminate (void);
323 extern void vty_reset (void);
324 extern struct vty
*vty_new (void);
325 extern struct vty
*vty_stdio (void (*atclose
)(void));
326 extern int vty_out (struct vty
*, const char *, ...) PRINTF_ATTRIBUTE(2, 3);
327 extern void vty_read_config (const char *, char *);
328 extern void vty_time_print (struct vty
*, int);
329 extern void vty_serv_sock (const char *, unsigned short, const char *);
330 extern void vty_close (struct vty
*);
331 extern char *vty_get_cwd (void);
332 extern void vty_log (const char *level
, const char *proto
,
333 const char *fmt
, struct timestamp_control
*, va_list);
334 extern int vty_config_lock (struct vty
*);
335 extern int vty_config_unlock (struct vty
*);
336 extern void vty_config_lockless (void);
337 extern int vty_shell (struct vty
*);
338 extern int vty_shell_serv (struct vty
*);
339 extern void vty_hello (struct vty
*);
341 /* Send a fixed-size message to all vty terminal monitors; this should be
342 an async-signal-safe function. */
343 extern void vty_log_fixed (char *buf
, size_t len
);
345 extern const char *vty_get_arg_value (struct vty_arg
**, const char *);
346 extern struct vty_arg
*vty_get_arg (struct vty_arg
**, const char *);
348 #endif /* _ZEBRA_VTY_H */