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