[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 "thread.h"
#include "log.h"
#include "sockunion.h"
#include "qobj.h"
#include "compiler.h"

#define VTY_BUFSIZ 4096
#define VTY_MAXHIST 20

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

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

	/* 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 buffer. */
	struct buffer *obuf;

	/* Command input buffer */
	char *buf;

	/* Command input error buffer */
	char *error_buf;

	/* 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"

#if CONFDATE > 20180401
CPP_NOTICE("It's probably time to remove VTY_NEWLINE compatibility foo.")
#endif

/* for compatibility */
#define VNL "\n" CPP_WARN("VNL has been replaced with \\n.")
#define VTYNL "\n" CPP_WARN("VTYNL has been replaced with \\n.")
#define VTY_NEWLINE "\n" CPP_WARN("VTY_NEWLINE has been replaced with \\n.")
#define VTY_GET_INTEGER(desc, v, str)                                          \
	{                                                                      \
		(v) = strtoul((str), NULL, 10);                                \
	}                                                                      \
	CPP_WARN("VTY_GET_INTEGER is no longer useful, use strtoul() or DEFPY.")
#define VTY_GET_INTEGER_RANGE(desc, v, str, min, max)                          \
	{                                                                      \
		(v) = strtoul((str), NULL, 10);                                \
	}                                                                      \
	CPP_WARN(                                                              \
		"VTY_GET_INTEGER_RANGE is no longer useful, use strtoul() or DEFPY.")
#define VTY_GET_ULONG(desc, v, str)                                            \
	{                                                                      \
		(v) = strtoul((str), NULL, 10);                                \
	}                                                                      \
	CPP_WARN("VTY_GET_ULONG is no longer useful, use strtoul() or DEFPY.")
#define VTY_GET_ULL(desc, v, str)                                              \
	{                                                                      \
		(v) = strtoull((str), NULL, 10);                               \
	}                                                                      \
	CPP_WARN("VTY_GET_ULL is no longer useful, use strtoull() or DEFPY.")
#define VTY_GET_IPV4_ADDRESS(desc, v, str)                                     \
	inet_aton((str), &(v)) CPP_WARN(                                       \
		"VTY_GET_IPV4_ADDRESS is no longer useful, use inet_aton() or DEFPY.")
#define VTY_GET_IPV4_PREFIX(desc, v, str)                                      \
	str2prefix_ipv4((str), &(v)) CPP_WARN(                                 \
		"VTY_GET_IPV4_PREFIX is no longer useful, use str2prefix_ipv4() or DEFPY.")
#define vty_outln(vty, str, ...)                                               \
	vty_out(vty, str "\n", ##__VA_ARGS__) CPP_WARN(                        \
		"vty_outln is no longer useful, use vty_out(...\\n...)")

/* 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 *);

extern void 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
b21b19c5	24	#include "thread.h"
1ed72e0b	25	#include "log.h"
d227617a	26	#include "sockunion.h"
0878c8d4	27	#include "qobj.h"
de1a880c	28	#include "compiler.h"
b21b19c5	29
2af38873	30	#define VTY_BUFSIZ 4096
718e3744	31	#define VTY_MAXHIST 20
	32
	33	/* VTY struct. */
d62a17ae	34	struct vty {
	35	/* File descripter of this vty. */
	36	int fd;
718e3744	37
d62a17ae	38	/* output FD, to support stdin/stdout combination */
d62a17ae	39	int wfd;
c5e69a02	40
d62a17ae	41	/* Is this vty connect to file or not */
d62a17ae	42	enum { VTY_TERM, VTY_FILE, VTY_SHELL, VTY_SHELL_SERV } type;
718e3744	43
d62a17ae	44	/* Node status of this vty */
d62a17ae	45	int node;
718e3744	46
d62a17ae	47	/* Failure count */
d62a17ae	48	int fail;
718e3744	49
d62a17ae	50	/* Output buffer. */
d62a17ae	51	struct buffer *obuf;
718e3744	52
d62a17ae	53	/* Command input buffer */
d62a17ae	54	char *buf;
718e3744	55
d62a17ae	56	/* Command input error buffer */
d62a17ae	57	char *error_buf;
5689fe5f	58
d62a17ae	59	/* Command cursor point */
d62a17ae	60	int cp;
718e3744	61
d62a17ae	62	/* Command length */
d62a17ae	63	int length;
718e3744	64
d62a17ae	65	/* Command max length. */
d62a17ae	66	int max;
718e3744	67
d62a17ae	68	/* Histry of command */
d62a17ae	69	char *hist[VTY_MAXHIST];
718e3744	70
d62a17ae	71	/* History lookup current point */
d62a17ae	72	int hp;
718e3744	73
d62a17ae	74	/* History insert end point */
d62a17ae	75	int hindex;
718e3744	76
d62a17ae	77	/* qobj object ID (replacement for "index") */
d62a17ae	78	uint64_t qobj_index;
718e3744	79
d62a17ae	80	/* qobj second-level object ID (replacement for "index_sub") */
d62a17ae	81	uint64_t qobj_index_sub;
718e3744	82
d62a17ae	83	/* For escape character. */
d62a17ae	84	unsigned char escape;
718e3744	85
d62a17ae	86	/* Current vty status. */
d62a17ae	87	enum { VTY_NORMAL, VTY_CLOSE, VTY_MORE, VTY_MORELINE } status;
718e3744	88
d62a17ae	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. */
	92	unsigned char iac;
718e3744	93
d62a17ae	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> */
9fc7ebf1	99	#define TELNET_NAWS_SB_LEN 5
d62a17ae	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. */
	103	size_t sb_len;
718e3744	104
d62a17ae	105	/* Window width/height. */
	106	int width;
	107	int height;
718e3744	108
d62a17ae	109	/* Configure lines. */
d62a17ae	110	int lines;
718e3744	111
d62a17ae	112	/* Terminal monitor. */
d62a17ae	113	int monitor;
718e3744	114
d62a17ae	115	/* In configure mode. */
d62a17ae	116	int config;
718e3744	117
d62a17ae	118	/* Read and write thread. */
	119	struct thread *t_read;
	120	struct thread *t_write;
718e3744	121
d62a17ae	122	/* Timeout seconds and thread. */
	123	unsigned long v_timeout;
	124	struct thread *t_timeout;
d227617a	125
d62a17ae	126	/* What address is this vty comming from. */
d62a17ae	127	char address[SU_ADDRSTRLEN];
2071aa0e DL	128
	129	/* "frame" output. This is buffered and will be printed if some
	130	* actual output follows, or will be discarded if the frame ends
	131	* without any output. */
	132	size_t frame_pos;
	133	char frame[1024];
718e3744	134	};
718e3744	135
d62a17ae	136	static inline void vty_push_context(struct vty *vty, int node, uint64_t id)
0878c8d4	137	{
d62a17ae	138	vty->node = node;
d62a17ae	139	vty->qobj_index = id;
0878c8d4 DL	140	}
0878c8d4 DL	141
3c5070be DL	142	/* note: VTY_PUSH_CONTEXT(..., NULL) doesn't work, since it will try to
3c5070be DL	143	* dereference "NULL->qobj_node.nid" */
d62a17ae	144	#define VTY_PUSH_CONTEXT(nodeval, ptr) \
a50b7ceb	145	vty_push_context(vty, nodeval, QOBJ_ID_0SAFE(ptr))
d62a17ae	146	#define VTY_PUSH_CONTEXT_NULL(nodeval) vty_push_context(vty, nodeval, 0ULL)
	147	#define VTY_PUSH_CONTEXT_SUB(nodeval, ptr) \
	148	do { \
	149	vty->node = nodeval; \
	150	/* qobj_index stays untouched */ \
	151	vty->qobj_index_sub = QOBJ_ID_0SAFE(ptr); \
6a098b3a	152	} while (0)
0878c8d4 DL	153
0878c8d4 DL	154	/* can return NULL if context is invalid! */
d62a17ae	155	#define VTY_GET_CONTEXT(structname) \
0878c8d4	156	QOBJ_GET_TYPESAFE(vty->qobj_index, structname)
d62a17ae	157	#define VTY_GET_CONTEXT_SUB(structname) \
6a098b3a	158	QOBJ_GET_TYPESAFE(vty->qobj_index_sub, structname)
0878c8d4 DL	159
0878c8d4 DL	160	/* will return if ptr is NULL. */
d62a17ae	161	#define VTY_CHECK_CONTEXT(ptr) \
	162	if (!ptr) { \
	163	vty_out(vty, \
	164	"Current configuration object was deleted " \
	165	"by another process.\n"); \
	166	return CMD_WARNING; \
0878c8d4 DL	167	}
	168
	169	/* struct structname ptr = <context>; ptr will never be NULL. /
d62a17ae	170	#define VTY_DECLVAR_CONTEXT(structname, ptr) \
d62a17ae	171	struct structname *ptr = VTY_GET_CONTEXT(structname); \
0878c8d4	172	VTY_CHECK_CONTEXT(ptr);
d62a17ae	173	#define VTY_DECLVAR_CONTEXT_SUB(structname, ptr) \
d62a17ae	174	struct structname *ptr = VTY_GET_CONTEXT_SUB(structname); \
6a098b3a	175	VTY_CHECK_CONTEXT(ptr);
a3d826f0 CS	176	#define VTY_DECLVAR_INSTANCE_CONTEXT(structname, ptr) \
	177	if (vty->qobj_index == 0) \
	178	return CMD_NOT_MY_INSTANCE; \
	179	struct structname *ptr = VTY_GET_CONTEXT(structname); \
	180	VTY_CHECK_CONTEXT(ptr);
0878c8d4	181
d62a17ae	182	struct vty_arg {
	183	const char *name;
	184	const char *value;
	185	const char **argv;
	186	int argc;
eac6e3f0 RW	187	};
eac6e3f0 RW	188
718e3744	189	/* Integrated configuration file. */
e20dc2ba	190	#define INTEGRATE_DEFAULT_CONFIG "frr.conf"
718e3744	191
de1a880c DL	192	#if CONFDATE > 20180401
de1a880c DL	193	CPP_NOTICE("It's probably time to remove VTY_NEWLINE compatibility foo.")
8867927f DL	194	#endif
8867927f DL	195
de1a880c	196	/* for compatibility */
d62a17ae	197	#define VNL "\n" CPP_WARN("VNL has been replaced with \\n.")
	198	#define VTYNL "\n" CPP_WARN("VTYNL has been replaced with \\n.")
	199	#define VTY_NEWLINE "\n" CPP_WARN("VTY_NEWLINE has been replaced with \\n.")
	200	#define VTY_GET_INTEGER(desc, v, str) \
	201	{ \
	202	(v) = strtoul((str), NULL, 10); \
	203	} \
8867927f	204	CPP_WARN("VTY_GET_INTEGER is no longer useful, use strtoul() or DEFPY.")
d62a17ae	205	#define VTY_GET_INTEGER_RANGE(desc, v, str, min, max) \
	206	{ \
	207	(v) = strtoul((str), NULL, 10); \
	208	} \
	209	CPP_WARN( \
	210	"VTY_GET_INTEGER_RANGE is no longer useful, use strtoul() or DEFPY.")
	211	#define VTY_GET_ULONG(desc, v, str) \
	212	{ \
	213	(v) = strtoul((str), NULL, 10); \
	214	} \
8867927f	215	CPP_WARN("VTY_GET_ULONG is no longer useful, use strtoul() or DEFPY.")
d62a17ae	216	#define VTY_GET_ULL(desc, v, str) \
	217	{ \
	218	(v) = strtoull((str), NULL, 10); \
	219	} \
8867927f	220	CPP_WARN("VTY_GET_ULL is no longer useful, use strtoull() or DEFPY.")
d62a17ae	221	#define VTY_GET_IPV4_ADDRESS(desc, v, str) \
	222	inet_aton((str), &(v)) CPP_WARN( \
	223	"VTY_GET_IPV4_ADDRESS is no longer useful, use inet_aton() or DEFPY.")
	224	#define VTY_GET_IPV4_PREFIX(desc, v, str) \
	225	str2prefix_ipv4((str), &(v)) CPP_WARN( \
	226	"VTY_GET_IPV4_PREFIX is no longer useful, use str2prefix_ipv4() or DEFPY.")
	227	#define vty_outln(vty, str, ...) \
	228	vty_out(vty, str "\n", ##__VA_ARGS__) CPP_WARN( \
	229	"vty_outln is no longer useful, use vty_out(...\\n...)")
dcc0a0d1	230
718e3744	231	/* Default time out value */
	232	#define VTY_TIMEOUT_DEFAULT 600
	233
	234	/* Vty read buffer size. */
	235	#define VTY_READ_BUFSIZ 512
	236
	237	/* Directory separator. */
	238	#ifndef DIRECTORY_SEP
	239	#define DIRECTORY_SEP '/'
	240	#endif /* DIRECTORY_SEP */
	241
	242	#ifndef IS_DIRECTORY_SEP
	243	#define IS_DIRECTORY_SEP(c) ((c) == DIRECTORY_SEP)
	244	#endif
	245
718e3744	246	/* Exported variables */
	247	extern char integrate_default[];
	248
	249	/* Prototypes. */
d62a17ae	250	extern void vty_init(struct thread_master *);
	251	extern void vty_init_vtysh(void);
	252	extern void vty_terminate(void);
	253	extern void vty_reset(void);
	254	extern struct vty *vty_new(void);
154b9e8f	255	extern struct vty vty_stdio(void (atclose)(int isexit));
2071aa0e DL	256
	257	/* - vty_frame() output goes to a buffer (for context-begin markers)
	258	* - vty_out() will first print this buffer, and clear it
	259	* - vty_endframe() clears the buffer without printing it, and prints an
	260	* extra string if the buffer was empty before (for context-end markers)
	261	*/
d62a17ae	262	extern int vty_out(struct vty , const char , ...) PRINTF_ATTRIBUTE(2, 3);
2071aa0e DL	263	extern void vty_frame(struct vty , const char , ...) PRINTF_ATTRIBUTE(2, 3);
	264	extern void vty_endframe(struct vty , const char );
	265
d62a17ae	266	extern void vty_read_config(const char , char );
	267	extern void vty_time_print(struct vty *, int);
	268	extern void vty_serv_sock(const char , unsigned short, const char );
	269	extern void vty_close(struct vty *);
	270	extern char *vty_get_cwd(void);
	271	extern void vty_log(const char level, const char proto, const char *fmt,
	272	struct timestamp_control *, va_list);
	273	extern int vty_config_lock(struct vty *);
	274	extern int vty_config_unlock(struct vty *);
	275	extern void vty_config_lockless(void);
	276	extern int vty_shell(struct vty *);
	277	extern int vty_shell_serv(struct vty *);
	278	extern void vty_hello(struct vty *);
718e3744	279
154b9e8f DL	280	/* ^Z / SIGTSTP handling */
	281	extern void vty_stdio_suspend(void);
	282	extern void vty_stdio_resume(void);
	283	extern void vty_stdio_close(void);
	284
274a4a44	285	/* Send a fixed-size message to all vty terminal monitors; this should be
274a4a44	286	an async-signal-safe function. */
d62a17ae	287	extern void vty_log_fixed(char *buf, size_t len);
274a4a44	288
718e3744	289	#endif /* _ZEBRA_VTY_H */