]>
Commit | Line | Data |
---|---|---|
718e3744 | 1 | /* Virtual terminal [aka TeletYpe] interface routine |
896014f4 DL |
2 | * Copyright (C) 1997 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 | |
21 | #ifndef _ZEBRA_VTY_H | |
22 | #define _ZEBRA_VTY_H | |
23 | ||
fe6b47b9 QY |
24 | #include <sys/types.h> |
25 | #include <regex.h> | |
26 | ||
b21b19c5 | 27 | #include "thread.h" |
1ed72e0b | 28 | #include "log.h" |
d227617a | 29 | #include "sockunion.h" |
0878c8d4 | 30 | #include "qobj.h" |
de1a880c | 31 | #include "compiler.h" |
b21b19c5 | 32 | |
2af38873 | 33 | #define VTY_BUFSIZ 4096 |
718e3744 | 34 | #define VTY_MAXHIST 20 |
35 | ||
36 | /* VTY struct. */ | |
d62a17ae | 37 | struct vty { |
38 | /* File descripter of this vty. */ | |
39 | int fd; | |
718e3744 | 40 | |
d62a17ae | 41 | /* output FD, to support stdin/stdout combination */ |
42 | int wfd; | |
c5e69a02 | 43 | |
2cddf2ff QY |
44 | /* File output, used for VTYSH only */ |
45 | FILE *of; | |
46 | FILE *of_saved; | |
47 | ||
48 | /* whether we are using pager or not */ | |
49 | bool is_paged; | |
50 | ||
d62a17ae | 51 | /* Is this vty connect to file or not */ |
52 | enum { VTY_TERM, VTY_FILE, VTY_SHELL, VTY_SHELL_SERV } type; | |
718e3744 | 53 | |
d62a17ae | 54 | /* Node status of this vty */ |
55 | int node; | |
718e3744 | 56 | |
d62a17ae | 57 | /* Failure count */ |
58 | int fail; | |
718e3744 | 59 | |
fe6b47b9 QY |
60 | /* Output filer regex */ |
61 | bool filter; | |
62 | regex_t include; | |
63 | ||
0b42d81a QY |
64 | /* Line buffer */ |
65 | struct buffer *lbuf; | |
66 | ||
d62a17ae | 67 | /* Output buffer. */ |
68 | struct buffer *obuf; | |
718e3744 | 69 | |
d62a17ae | 70 | /* Command input buffer */ |
71 | char *buf; | |
718e3744 | 72 | |
d62a17ae | 73 | /* Command input error buffer */ |
74 | char *error_buf; | |
5689fe5f | 75 | |
d62a17ae | 76 | /* Command cursor point */ |
77 | int cp; | |
718e3744 | 78 | |
d62a17ae | 79 | /* Command length */ |
80 | int length; | |
718e3744 | 81 | |
d62a17ae | 82 | /* Command max length. */ |
83 | int max; | |
718e3744 | 84 | |
d62a17ae | 85 | /* Histry of command */ |
86 | char *hist[VTY_MAXHIST]; | |
718e3744 | 87 | |
d62a17ae | 88 | /* History lookup current point */ |
89 | int hp; | |
718e3744 | 90 | |
d62a17ae | 91 | /* History insert end point */ |
92 | int hindex; | |
718e3744 | 93 | |
d62a17ae | 94 | /* qobj object ID (replacement for "index") */ |
95 | uint64_t qobj_index; | |
718e3744 | 96 | |
d62a17ae | 97 | /* qobj second-level object ID (replacement for "index_sub") */ |
98 | uint64_t qobj_index_sub; | |
718e3744 | 99 | |
d62a17ae | 100 | /* For escape character. */ |
101 | unsigned char escape; | |
718e3744 | 102 | |
d62a17ae | 103 | /* Current vty status. */ |
104 | enum { VTY_NORMAL, VTY_CLOSE, VTY_MORE, VTY_MORELINE } status; | |
718e3744 | 105 | |
d62a17ae | 106 | /* IAC handling: was the last character received the |
107 | IAC (interpret-as-command) escape character (and therefore the next | |
108 | character will be the command code)? Refer to Telnet RFC 854. */ | |
109 | unsigned char iac; | |
718e3744 | 110 | |
d62a17ae | 111 | /* IAC SB (option subnegotiation) handling */ |
112 | unsigned char iac_sb_in_progress; | |
113 | /* At the moment, we care only about the NAWS (window size) negotiation, | |
114 | and that requires just a 5-character buffer (RFC 1073): | |
115 | <NAWS char> <16-bit width> <16-bit height> */ | |
9fc7ebf1 | 116 | #define TELNET_NAWS_SB_LEN 5 |
d62a17ae | 117 | unsigned char sb_buf[TELNET_NAWS_SB_LEN]; |
118 | /* How many subnegotiation characters have we received? We just drop | |
119 | those that do not fit in the buffer. */ | |
120 | size_t sb_len; | |
718e3744 | 121 | |
d62a17ae | 122 | /* Window width/height. */ |
123 | int width; | |
124 | int height; | |
718e3744 | 125 | |
d62a17ae | 126 | /* Configure lines. */ |
127 | int lines; | |
718e3744 | 128 | |
d62a17ae | 129 | /* Terminal monitor. */ |
130 | int monitor; | |
718e3744 | 131 | |
d62a17ae | 132 | /* In configure mode. */ |
133 | int config; | |
718e3744 | 134 | |
d62a17ae | 135 | /* Read and write thread. */ |
136 | struct thread *t_read; | |
137 | struct thread *t_write; | |
718e3744 | 138 | |
d62a17ae | 139 | /* Timeout seconds and thread. */ |
140 | unsigned long v_timeout; | |
141 | struct thread *t_timeout; | |
d227617a | 142 | |
d62a17ae | 143 | /* What address is this vty comming from. */ |
144 | char address[SU_ADDRSTRLEN]; | |
2071aa0e DL |
145 | |
146 | /* "frame" output. This is buffered and will be printed if some | |
147 | * actual output follows, or will be discarded if the frame ends | |
148 | * without any output. */ | |
149 | size_t frame_pos; | |
150 | char frame[1024]; | |
718e3744 | 151 | }; |
152 | ||
d62a17ae | 153 | static inline void vty_push_context(struct vty *vty, int node, uint64_t id) |
0878c8d4 | 154 | { |
d62a17ae | 155 | vty->node = node; |
156 | vty->qobj_index = id; | |
0878c8d4 DL |
157 | } |
158 | ||
3c5070be DL |
159 | /* note: VTY_PUSH_CONTEXT(..., NULL) doesn't work, since it will try to |
160 | * dereference "NULL->qobj_node.nid" */ | |
d62a17ae | 161 | #define VTY_PUSH_CONTEXT(nodeval, ptr) \ |
a50b7ceb | 162 | vty_push_context(vty, nodeval, QOBJ_ID_0SAFE(ptr)) |
d62a17ae | 163 | #define VTY_PUSH_CONTEXT_NULL(nodeval) vty_push_context(vty, nodeval, 0ULL) |
164 | #define VTY_PUSH_CONTEXT_SUB(nodeval, ptr) \ | |
165 | do { \ | |
166 | vty->node = nodeval; \ | |
167 | /* qobj_index stays untouched */ \ | |
168 | vty->qobj_index_sub = QOBJ_ID_0SAFE(ptr); \ | |
6a098b3a | 169 | } while (0) |
0878c8d4 DL |
170 | |
171 | /* can return NULL if context is invalid! */ | |
d62a17ae | 172 | #define VTY_GET_CONTEXT(structname) \ |
0878c8d4 | 173 | QOBJ_GET_TYPESAFE(vty->qobj_index, structname) |
d62a17ae | 174 | #define VTY_GET_CONTEXT_SUB(structname) \ |
6a098b3a | 175 | QOBJ_GET_TYPESAFE(vty->qobj_index_sub, structname) |
0878c8d4 DL |
176 | |
177 | /* will return if ptr is NULL. */ | |
d62a17ae | 178 | #define VTY_CHECK_CONTEXT(ptr) \ |
179 | if (!ptr) { \ | |
180 | vty_out(vty, \ | |
181 | "Current configuration object was deleted " \ | |
182 | "by another process.\n"); \ | |
183 | return CMD_WARNING; \ | |
0878c8d4 DL |
184 | } |
185 | ||
186 | /* struct structname *ptr = <context>; ptr will never be NULL. */ | |
d62a17ae | 187 | #define VTY_DECLVAR_CONTEXT(structname, ptr) \ |
188 | struct structname *ptr = VTY_GET_CONTEXT(structname); \ | |
0878c8d4 | 189 | VTY_CHECK_CONTEXT(ptr); |
d62a17ae | 190 | #define VTY_DECLVAR_CONTEXT_SUB(structname, ptr) \ |
191 | struct structname *ptr = VTY_GET_CONTEXT_SUB(structname); \ | |
6a098b3a | 192 | VTY_CHECK_CONTEXT(ptr); |
a3d826f0 | 193 | #define VTY_DECLVAR_INSTANCE_CONTEXT(structname, ptr) \ |
996c9314 LB |
194 | if (vty->qobj_index == 0) \ |
195 | return CMD_NOT_MY_INSTANCE; \ | |
a3d826f0 CS |
196 | struct structname *ptr = VTY_GET_CONTEXT(structname); \ |
197 | VTY_CHECK_CONTEXT(ptr); | |
0878c8d4 | 198 | |
d62a17ae | 199 | struct vty_arg { |
200 | const char *name; | |
201 | const char *value; | |
202 | const char **argv; | |
203 | int argc; | |
eac6e3f0 RW |
204 | }; |
205 | ||
718e3744 | 206 | /* Integrated configuration file. */ |
e20dc2ba | 207 | #define INTEGRATE_DEFAULT_CONFIG "frr.conf" |
718e3744 | 208 | |
718e3744 | 209 | /* Default time out value */ |
210 | #define VTY_TIMEOUT_DEFAULT 600 | |
211 | ||
212 | /* Vty read buffer size. */ | |
213 | #define VTY_READ_BUFSIZ 512 | |
214 | ||
215 | /* Directory separator. */ | |
216 | #ifndef DIRECTORY_SEP | |
217 | #define DIRECTORY_SEP '/' | |
218 | #endif /* DIRECTORY_SEP */ | |
219 | ||
220 | #ifndef IS_DIRECTORY_SEP | |
221 | #define IS_DIRECTORY_SEP(c) ((c) == DIRECTORY_SEP) | |
222 | #endif | |
223 | ||
718e3744 | 224 | /* Exported variables */ |
225 | extern char integrate_default[]; | |
226 | ||
227 | /* Prototypes. */ | |
d62a17ae | 228 | extern void vty_init(struct thread_master *); |
229 | extern void vty_init_vtysh(void); | |
230 | extern void vty_terminate(void); | |
231 | extern void vty_reset(void); | |
232 | extern struct vty *vty_new(void); | |
154b9e8f | 233 | extern struct vty *vty_stdio(void (*atclose)(int isexit)); |
2071aa0e DL |
234 | |
235 | /* - vty_frame() output goes to a buffer (for context-begin markers) | |
236 | * - vty_out() will first print this buffer, and clear it | |
237 | * - vty_endframe() clears the buffer without printing it, and prints an | |
238 | * extra string if the buffer was empty before (for context-end markers) | |
239 | */ | |
d62a17ae | 240 | extern int vty_out(struct vty *, const char *, ...) PRINTF_ATTRIBUTE(2, 3); |
2071aa0e DL |
241 | extern void vty_frame(struct vty *, const char *, ...) PRINTF_ATTRIBUTE(2, 3); |
242 | extern void vty_endframe(struct vty *, const char *); | |
fe6b47b9 | 243 | bool vty_set_include(struct vty *vty, const char *regexp); |
2071aa0e | 244 | |
5ede5e4e | 245 | extern bool vty_read_config(const char *, char *); |
d62a17ae | 246 | extern void vty_time_print(struct vty *, int); |
247 | extern void vty_serv_sock(const char *, unsigned short, const char *); | |
248 | extern void vty_close(struct vty *); | |
249 | extern char *vty_get_cwd(void); | |
250 | extern void vty_log(const char *level, const char *proto, const char *fmt, | |
251 | struct timestamp_control *, va_list); | |
252 | extern int vty_config_lock(struct vty *); | |
253 | extern int vty_config_unlock(struct vty *); | |
254 | extern void vty_config_lockless(void); | |
255 | extern int vty_shell(struct vty *); | |
256 | extern int vty_shell_serv(struct vty *); | |
257 | extern void vty_hello(struct vty *); | |
718e3744 | 258 | |
154b9e8f DL |
259 | /* ^Z / SIGTSTP handling */ |
260 | extern void vty_stdio_suspend(void); | |
261 | extern void vty_stdio_resume(void); | |
262 | extern void vty_stdio_close(void); | |
263 | ||
274a4a44 | 264 | /* Send a fixed-size message to all vty terminal monitors; this should be |
265 | an async-signal-safe function. */ | |
d62a17ae | 266 | extern void vty_log_fixed(char *buf, size_t len); |
274a4a44 | 267 | |
718e3744 | 268 | #endif /* _ZEBRA_VTY_H */ |