[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"
#include "northbound.h"

#define VTY_BUFSIZ 4096
#define VTY_MAXHIST 20
#define VTY_MAXDEPTH 8

#define VTY_MAXCFGCHANGES 8

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

struct vty_cfg_change {
	char xpath[XPATH_MAXLEN];
	enum nb_operation operation;
	const char *value;
};

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

	/* Changes enqueued to be applied in the candidate configuration. */
	size_t num_cfg_changes;
	struct vty_cfg_change cfg_changes[VTY_MAXCFGCHANGES];

	/* XPath of the current node */
	int xpath_index;
	char xpath[VTY_MAXDEPTH][XPATH_MAXLEN];

	/* In configure mode. */
	bool config;

	/* Private candidate configuration mode. */
	bool private_config;

	/* Candidate configuration. */
	struct nb_config *candidate_config;

	/* Base candidate configuration. */
	struct nb_config *candidate_config_base;

	/* Confirmed-commit timeout and rollback configuration. */
	struct thread *t_confirmed_commit_timeout;
	struct nb_config *confirmed_commit_rollback;

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

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

/* XPath macros. */
#define VTY_PUSH_XPATH(nodeval, value)                                         \
	do {                                                                   \
		if (vty->xpath_index >= VTY_MAXDEPTH) {                        \
			vty_out(vty, "%% Reached maximum CLI depth (%u)\n",    \
				VTY_MAXDEPTH);                                 \
			return CMD_WARNING;                                    \
		}                                                              \
		vty->node = nodeval;                                           \
		strlcpy(vty->xpath[vty->xpath_index], value,                   \
			sizeof(vty->xpath[0]));                                \
		vty->xpath_index++;                                            \
	} while (0)

#define VTY_CURR_XPATH vty->xpath[vty->xpath_index - 1]

#define VTY_CHECK_XPATH                                                        \
	do {                                                                   \
		if (vty->xpath_index > 0                                       \
		    && !yang_dnode_exists(vty->candidate_config->dnode,        \
					  VTY_CURR_XPATH)) {                   \
			vty_out(vty,                                           \
				"Current configuration object was deleted "    \
				"by another process.\n\n");                    \
			return CMD_WARNING;                                    \
		}                                                              \
	} while (0)

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[];
extern struct vty *vty_exclusive_lock;

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