[mirror_frr.git] / lib / vty.h

/* Virtual terminal [aka TeletYpe] interface routine
 * Copyright (C) 1997 Kunihiro Ishiguro
 *
 * This file is part of GNU Zebra.
 *
 * GNU Zebra is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the
 * Free Software Foundation; either version 2, or (at your option) any
 * later version.
 *
 * GNU Zebra is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; see the file COPYING; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 */

#ifndef _ZEBRA_VTY_H
#define _ZEBRA_VTY_H

#include <sys/types.h>
#include <regex.h>

#include "thread.h"
#include "log.h"
#include "sockunion.h"
#include "qobj.h"
#include "compiler.h"

#define VTY_BUFSIZ 4096
#define VTY_MAXHIST 20

struct vty_error {
	char error_buf[VTY_BUFSIZ];
	uint32_t line_num;
};

/* VTY struct. */
struct vty {
	/* File descripter of this vty. */
	int fd;

	/* output FD, to support stdin/stdout combination */
	int wfd;

	/* File output, used for VTYSH only */
	FILE *of;
	FILE *of_saved;

	/* whether we are using pager or not */
	bool is_paged;

	/* Is this vty connect to file or not */
	enum { VTY_TERM, VTY_FILE, VTY_SHELL, VTY_SHELL_SERV } type;

	/* Node status of this vty */
	int node;

	/* Failure count */
	int fail;

	/* Output filer regex */
	bool filter;
	regex_t include;

	/* Line buffer */
	struct buffer *lbuf;

	/* Output buffer. */
	struct buffer *obuf;

	/* Command input buffer */
	char *buf;

	/* Command input error buffer */
	struct list *error;

	/* Command cursor point */
	int cp;

	/* Command length */
	int length;

	/* Command max length. */
	int max;

	/* Histry of command */
	char *hist[VTY_MAXHIST];

	/* History lookup current point */
	int hp;

	/* History insert end point */
	int hindex;

	/* qobj object ID (replacement for "index") */
	uint64_t qobj_index;

	/* qobj second-level object ID (replacement for "index_sub") */
	uint64_t qobj_index_sub;

	/* For escape character. */
	unsigned char escape;

	/* Current vty status. */
	enum { VTY_NORMAL, VTY_CLOSE, VTY_MORE, VTY_MORELINE } status;

	/* IAC handling: was the last character received the
	   IAC (interpret-as-command) escape character (and therefore the next
	   character will be the command code)?  Refer to Telnet RFC 854. */
	unsigned char iac;

	/* IAC SB (option subnegotiation) handling */
	unsigned char iac_sb_in_progress;
/* At the moment, we care only about the NAWS (window size) negotiation,
   and that requires just a 5-character buffer (RFC 1073):
     <NAWS char> <16-bit width> <16-bit height> */
#define TELNET_NAWS_SB_LEN 5
	unsigned char sb_buf[TELNET_NAWS_SB_LEN];
	/* How many subnegotiation characters have we received?  We just drop
	   those that do not fit in the buffer. */
	size_t sb_len;

	/* Window width/height. */
	int width;
	int height;

	/* Configure lines. */
	int lines;

	/* Terminal monitor. */
	int monitor;

	/* In configure mode. */
	int config;

	/* Read and write thread. */
	struct thread *t_read;
	struct thread *t_write;

	/* Timeout seconds and thread. */
	unsigned long v_timeout;
	struct thread *t_timeout;

	/* What address is this vty comming from. */
	char address[SU_ADDRSTRLEN];

	/* "frame" output.  This is buffered and will be printed if some
	 * actual output follows, or will be discarded if the frame ends
	 * without any output. */
	size_t frame_pos;
	char frame[1024];
};

static inline void vty_push_context(struct vty *vty, int node, uint64_t id)
{
	vty->node = node;
	vty->qobj_index = id;
}

/* note: VTY_PUSH_CONTEXT(..., NULL) doesn't work, since it will try to
 * dereference "NULL->qobj_node.nid" */
#define VTY_PUSH_CONTEXT(nodeval, ptr)                                         \
	vty_push_context(vty, nodeval, QOBJ_ID_0SAFE(ptr))
#define VTY_PUSH_CONTEXT_NULL(nodeval) vty_push_context(vty, nodeval, 0ULL)
#define VTY_PUSH_CONTEXT_SUB(nodeval, ptr)                                     \
	do {                                                                   \
		vty->node = nodeval;                                           \
		/* qobj_index stays untouched */                               \
		vty->qobj_index_sub = QOBJ_ID_0SAFE(ptr);                      \
	} while (0)

/* can return NULL if context is invalid! */
#define VTY_GET_CONTEXT(structname)                                            \
	QOBJ_GET_TYPESAFE(vty->qobj_index, structname)
#define VTY_GET_CONTEXT_SUB(structname)                                        \
	QOBJ_GET_TYPESAFE(vty->qobj_index_sub, structname)

/* will return if ptr is NULL. */
#define VTY_CHECK_CONTEXT(ptr)                                                 \
	if (!ptr) {                                                            \
		vty_out(vty,                                                   \
			"Current configuration object was deleted "            \
			"by another process.\n");                              \
		return CMD_WARNING;                                            \
	}

/* struct structname *ptr = <context>;   ptr will never be NULL. */
#define VTY_DECLVAR_CONTEXT(structname, ptr)                                   \
	struct structname *ptr = VTY_GET_CONTEXT(structname);                  \
	VTY_CHECK_CONTEXT(ptr);
#define VTY_DECLVAR_CONTEXT_SUB(structname, ptr)                               \
	struct structname *ptr = VTY_GET_CONTEXT_SUB(structname);              \
	VTY_CHECK_CONTEXT(ptr);
#define VTY_DECLVAR_INSTANCE_CONTEXT(structname, ptr)                          \
	if (vty->qobj_index == 0)                                              \
		return CMD_NOT_MY_INSTANCE;                                    \
	struct structname *ptr = VTY_GET_CONTEXT(structname);                  \
	VTY_CHECK_CONTEXT(ptr);

struct vty_arg {
	const char *name;
	const char *value;
	const char **argv;
	int argc;
};

/* Integrated configuration file. */
#define INTEGRATE_DEFAULT_CONFIG "frr.conf"

/* Default time out value */
#define VTY_TIMEOUT_DEFAULT 600

/* Vty read buffer size. */
#define VTY_READ_BUFSIZ 512

/* Directory separator. */
#ifndef DIRECTORY_SEP
#define DIRECTORY_SEP '/'
#endif /* DIRECTORY_SEP */

#ifndef IS_DIRECTORY_SEP
#define IS_DIRECTORY_SEP(c) ((c) == DIRECTORY_SEP)
#endif

/* Exported variables */
extern char integrate_default[];

/* Prototypes. */
extern void vty_init(struct thread_master *);
extern void vty_init_vtysh(void);
extern void vty_terminate(void);
extern void vty_reset(void);
extern struct vty *vty_new(void);
extern struct vty *vty_stdio(void (*atclose)(int isexit));

/* - vty_frame() output goes to a buffer (for context-begin markers)
 * - vty_out() will first print this buffer, and clear it
 * - vty_endframe() clears the buffer without printing it, and prints an
 *   extra string if the buffer was empty before (for context-end markers)
 */
extern int vty_out(struct vty *, const char *, ...) PRINTF_ATTRIBUTE(2, 3);
extern void vty_frame(struct vty *, const char *, ...) PRINTF_ATTRIBUTE(2, 3);
extern void vty_endframe(struct vty *, const char *);
bool vty_set_include(struct vty *vty, const char *regexp);

extern bool vty_read_config(const char *, char *);
extern void vty_time_print(struct vty *, int);
extern void vty_serv_sock(const char *, unsigned short, const char *);
extern void vty_close(struct vty *);
extern char *vty_get_cwd(void);
extern void vty_log(const char *level, const char *proto, const char *fmt,
		    struct timestamp_control *, va_list);
extern int vty_config_lock(struct vty *);
extern int vty_config_unlock(struct vty *);
extern void vty_config_lockless(void);
extern int vty_shell(struct vty *);
extern int vty_shell_serv(struct vty *);
extern void vty_hello(struct vty *);

/* ^Z / SIGTSTP handling */
extern void vty_stdio_suspend(void);
extern void vty_stdio_resume(void);
extern void vty_stdio_close(void);

/* Send a fixed-size message to all vty terminal monitors; this should be
   an async-signal-safe function. */
extern void vty_log_fixed(char *buf, size_t len);

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