[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>
#ifdef HAVE_LIBPCRE2_POSIX
#ifndef _FRR_PCRE2_POSIX
#define _FRR_PCRE2_POSIX
#include <pcre2posix.h>
#endif /* _FRR_PCRE2_POSIX */
#elif defined(HAVE_LIBPCREPOSIX)
#include <pcreposix.h>
#else
#include <regex.h>
#endif /* HAVE_LIBPCRE2_POSIX */

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

#ifdef __cplusplus
extern "C" {
#endif

struct json_object;

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

#define VTY_MAXCFGCHANGES 16

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;
};

PREDECL_DLIST(vtys);

/* VTY struct. */
struct vty {
	struct vtys_item itm;

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

	/* Dynamic transaction information. */
	bool pending_allowed;
	bool pending_commit;
	char *pending_cmds_buf;
	size_t pending_cmds_buflen;
	size_t pending_cmds_bufpos;

	/* 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,
		VTY_PASSFD,
	} status;

	/* vtysh socket/fd passing (for terminal monitor) */
	int pass_fd;

	/* CLI command return value (likely CMD_SUCCESS) when pass_fd != -1 */
	uint8_t pass_fd_status[4];

	/* live logging target / terminal monitor */
	struct zlog_live_cfg live_log;

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

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

#define VTY_DECLVAR_CONTEXT_VRF(vrfptr)                                        \
	struct vrf *vrfptr;                                                    \
	if (vty->node == CONFIG_NODE)                                          \
		vrfptr = vrf_lookup_by_id(VRF_DEFAULT);                        \
	else                                                                   \
		vrfptr = VTY_GET_CONTEXT(vrf);                                 \
	VTY_CHECK_CONTEXT(vrfptr);                                             \
	MACRO_REQUIRE_SEMICOLON() /* end */

/* 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->type != VTY_FILE && !vty->private_config              \
		    && 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

/* Prototypes. */
extern void vty_init(struct thread_master *, bool do_command_logging);
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 *, ...) PRINTFRR(2, 3);
extern void vty_frame(struct vty *, const char *, ...) PRINTFRR(2, 3);
extern void vty_endframe(struct vty *, const char *);
extern bool vty_set_include(struct vty *vty, const char *regexp);
/* returns CMD_SUCCESS so you can do a one-line "return vty_json(...)"
 * NULL check and json_object_free() is included.
 *
 * _no_pretty means do not add a bunch of newlines and dump the output
 * as densely as possible.
 */
extern int vty_json(struct vty *vty, struct json_object *json);
extern int vty_json_no_pretty(struct vty *vty, struct json_object *json);

/* post fd to be passed to the vtysh client
 * fd is owned by the VTY code after this and will be closed when done
 */
extern void vty_pass_fd(struct vty *vty, int fd);

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_update_xpath(const char *oldpath, const char *newpath);
extern int vty_config_enter(struct vty *vty, bool private_config,
			    bool exclusive);
extern void vty_config_exit(struct vty *);
extern int vty_config_node_exit(struct 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);

#ifdef __cplusplus
}
#endif

#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	24	#include <sys/types.h>
061f5d1c DA	25	#ifdef HAVE_LIBPCRE2_POSIX
	26	#ifndef _FRR_PCRE2_POSIX
	27	#define _FRR_PCRE2_POSIX
	28	#include <pcre2posix.h>
	29	#endif /* _FRR_PCRE2_POSIX */
	30	#elif defined(HAVE_LIBPCREPOSIX)
beee9b4a DS	31	#include <pcreposix.h>
beee9b4a DS	32	#else
fe6b47b9	33	#include <regex.h>
061f5d1c	34	#endif /* HAVE_LIBPCRE2_POSIX */
fe6b47b9	35
b21b19c5	36	#include "thread.h"
1ed72e0b	37	#include "log.h"
d227617a	38	#include "sockunion.h"
0878c8d4	39	#include "qobj.h"
de1a880c	40	#include "compiler.h"
1c2facd1	41	#include "northbound.h"
0798d276	42	#include "zlog_live.h"
b21b19c5	43
5e244469 RW	44	#ifdef __cplusplus
	45	extern "C" {
	46	#endif
	47
a8dfd147 DL	48	struct json_object;
a8dfd147 DL	49
2af38873	50	#define VTY_BUFSIZ 4096
718e3744	51	#define VTY_MAXHIST 20
1c2facd1	52	#define VTY_MAXDEPTH 8
718e3744	53
0b3eed38	54	#define VTY_MAXCFGCHANGES 16
a6233bfc	55
7ab57d19 DS	56	struct vty_error {
	57	char error_buf[VTY_BUFSIZ];
	58	uint32_t line_num;
	59	};
	60
a6233bfc	61	struct vty_cfg_change {
8427e0e6	62	char xpath[XPATH_MAXLEN];
a6233bfc RW	63	enum nb_operation operation;
	64	const char *value;
	65	};
	66
43dd8caf DL	67	PREDECL_DLIST(vtys);
43dd8caf DL	68
718e3744	69	/* VTY struct. */
d62a17ae	70	struct vty {
43dd8caf DL	71	struct vtys_item itm;
43dd8caf DL	72
d62a17ae	73	/* File descripter of this vty. */
d62a17ae	74	int fd;
718e3744	75
d62a17ae	76	/* output FD, to support stdin/stdout combination */
d62a17ae	77	int wfd;
c5e69a02	78
2cddf2ff QY	79	/* File output, used for VTYSH only */
	80	FILE *of;
	81	FILE *of_saved;
	82
	83	/* whether we are using pager or not */
	84	bool is_paged;
	85
d62a17ae	86	/* Is this vty connect to file or not */
d62a17ae	87	enum { VTY_TERM, VTY_FILE, VTY_SHELL, VTY_SHELL_SERV } type;
718e3744	88
d62a17ae	89	/* Node status of this vty */
d62a17ae	90	int node;
718e3744	91
d62a17ae	92	/* Failure count */
d62a17ae	93	int fail;
718e3744	94
fe6b47b9 QY	95	/* Output filer regex */
	96	bool filter;
	97	regex_t include;
	98
0b42d81a QY	99	/* Line buffer */
	100	struct buffer *lbuf;
	101
d62a17ae	102	/* Output buffer. */
d62a17ae	103	struct buffer *obuf;
718e3744	104
d62a17ae	105	/* Command input buffer */
d62a17ae	106	char *buf;
718e3744	107
d62a17ae	108	/* Command input error buffer */
7ab57d19	109	struct list *error;
5689fe5f	110
d62a17ae	111	/* Command cursor point */
d62a17ae	112	int cp;
718e3744	113
d62a17ae	114	/* Command length */
d62a17ae	115	int length;
718e3744	116
d62a17ae	117	/* Command max length. */
d62a17ae	118	int max;
718e3744	119
d62a17ae	120	/* Histry of command */
d62a17ae	121	char *hist[VTY_MAXHIST];
718e3744	122
d62a17ae	123	/* History lookup current point */
d62a17ae	124	int hp;
718e3744	125
d62a17ae	126	/* History insert end point */
d62a17ae	127	int hindex;
718e3744	128
a6233bfc RW	129	/* Changes enqueued to be applied in the candidate configuration. */
	130	size_t num_cfg_changes;
	131	struct vty_cfg_change cfg_changes[VTY_MAXCFGCHANGES];
	132
1c2facd1 RW	133	/* XPath of the current node */
	134	int xpath_index;
	135	char xpath[VTY_MAXDEPTH][XPATH_MAXLEN];
	136
f344c66e RW	137	/* In configure mode. */
	138	bool config;
	139
1c2facd1 RW	140	/* Private candidate configuration mode. */
	141	bool private_config;
	142
	143	/* Candidate configuration. */
	144	struct nb_config *candidate_config;
	145
	146	/* Base candidate configuration. */
	147	struct nb_config *candidate_config_base;
	148
b855e95f	149	/* Dynamic transaction information. */
fd396924 CH	150	bool pending_allowed;
fd396924 CH	151	bool pending_commit;
b855e95f RW	152	char *pending_cmds_buf;
	153	size_t pending_cmds_buflen;
	154	size_t pending_cmds_bufpos;
	155
fbdc1c0a RW	156	/* Confirmed-commit timeout and rollback configuration. */
	157	struct thread *t_confirmed_commit_timeout;
	158	struct nb_config *confirmed_commit_rollback;
	159
d62a17ae	160	/* qobj object ID (replacement for "index") */
d62a17ae	161	uint64_t qobj_index;
718e3744	162
d62a17ae	163	/* qobj second-level object ID (replacement for "index_sub") */
d62a17ae	164	uint64_t qobj_index_sub;
718e3744	165
d62a17ae	166	/* For escape character. */
d62a17ae	167	unsigned char escape;
718e3744	168
d62a17ae	169	/* Current vty status. */
b2dde56b DL	170	enum {
	171	VTY_NORMAL,
	172	VTY_CLOSE,
	173	VTY_MORE,
	174	VTY_MORELINE,
	175	VTY_PASSFD,
	176	} status;
	177
	178	/* vtysh socket/fd passing (for terminal monitor) */
	179	int pass_fd;
	180
	181	/* CLI command return value (likely CMD_SUCCESS) when pass_fd != -1 */
	182	uint8_t pass_fd_status[4];
718e3744	183
0798d276 DL	184	/* live logging target / terminal monitor */
	185	struct zlog_live_cfg live_log;
	186
d62a17ae	187	/* IAC handling: was the last character received the
	188	IAC (interpret-as-command) escape character (and therefore the next
	189	character will be the command code)? Refer to Telnet RFC 854. */
	190	unsigned char iac;
718e3744	191
d62a17ae	192	/* IAC SB (option subnegotiation) handling */
	193	unsigned char iac_sb_in_progress;
	194	/* At the moment, we care only about the NAWS (window size) negotiation,
	195	and that requires just a 5-character buffer (RFC 1073):
	196	<NAWS char> <16-bit width> <16-bit height> */
9fc7ebf1	197	#define TELNET_NAWS_SB_LEN 5
d62a17ae	198	unsigned char sb_buf[TELNET_NAWS_SB_LEN];
	199	/* How many subnegotiation characters have we received? We just drop
	200	those that do not fit in the buffer. */
	201	size_t sb_len;
718e3744	202
d62a17ae	203	/* Window width/height. */
	204	int width;
	205	int height;
718e3744	206
d62a17ae	207	/* Configure lines. */
d62a17ae	208	int lines;
718e3744	209
d62a17ae	210	/* Read and write thread. */
	211	struct thread *t_read;
	212	struct thread *t_write;
718e3744	213
d62a17ae	214	/* Timeout seconds and thread. */
	215	unsigned long v_timeout;
	216	struct thread *t_timeout;
d227617a	217
d62a17ae	218	/* What address is this vty comming from. */
d62a17ae	219	char address[SU_ADDRSTRLEN];
2071aa0e DL	220
	221	/* "frame" output. This is buffered and will be printed if some
	222	* actual output follows, or will be discarded if the frame ends
	223	* without any output. */
	224	size_t frame_pos;
	225	char frame[1024];
718e3744	226	};
718e3744	227
d62a17ae	228	static inline void vty_push_context(struct vty *vty, int node, uint64_t id)
0878c8d4	229	{
d62a17ae	230	vty->node = node;
d62a17ae	231	vty->qobj_index = id;
0878c8d4 DL	232	}
0878c8d4 DL	233
3c5070be DL	234	/* note: VTY_PUSH_CONTEXT(..., NULL) doesn't work, since it will try to
3c5070be DL	235	* dereference "NULL->qobj_node.nid" */
d62a17ae	236	#define VTY_PUSH_CONTEXT(nodeval, ptr) \
a50b7ceb	237	vty_push_context(vty, nodeval, QOBJ_ID_0SAFE(ptr))
d62a17ae	238	#define VTY_PUSH_CONTEXT_NULL(nodeval) vty_push_context(vty, nodeval, 0ULL)
	239	#define VTY_PUSH_CONTEXT_SUB(nodeval, ptr) \
	240	do { \
	241	vty->node = nodeval; \
	242	/* qobj_index stays untouched */ \
	243	vty->qobj_index_sub = QOBJ_ID_0SAFE(ptr); \
6a098b3a	244	} while (0)
0878c8d4 DL	245
0878c8d4 DL	246	/* can return NULL if context is invalid! */
d62a17ae	247	#define VTY_GET_CONTEXT(structname) \
0878c8d4	248	QOBJ_GET_TYPESAFE(vty->qobj_index, structname)
d62a17ae	249	#define VTY_GET_CONTEXT_SUB(structname) \
6a098b3a	250	QOBJ_GET_TYPESAFE(vty->qobj_index_sub, structname)
0878c8d4 DL	251
0878c8d4 DL	252	/* will return if ptr is NULL. */
d62a17ae	253	#define VTY_CHECK_CONTEXT(ptr) \
	254	if (!ptr) { \
	255	vty_out(vty, \
	256	"Current configuration object was deleted " \
	257	"by another process.\n"); \
	258	return CMD_WARNING; \
0878c8d4 DL	259	}
	260
	261	/* struct structname ptr = <context>; ptr will never be NULL. /
d62a17ae	262	#define VTY_DECLVAR_CONTEXT(structname, ptr) \
d62a17ae	263	struct structname *ptr = VTY_GET_CONTEXT(structname); \
0878c8d4	264	VTY_CHECK_CONTEXT(ptr);
d62a17ae	265	#define VTY_DECLVAR_CONTEXT_SUB(structname, ptr) \
d62a17ae	266	struct structname *ptr = VTY_GET_CONTEXT_SUB(structname); \
6a098b3a	267	VTY_CHECK_CONTEXT(ptr);
a3d826f0	268	#define VTY_DECLVAR_INSTANCE_CONTEXT(structname, ptr) \
996c9314 LB	269	if (vty->qobj_index == 0) \
996c9314 LB	270	return CMD_NOT_MY_INSTANCE; \
a3d826f0 CS	271	struct structname *ptr = VTY_GET_CONTEXT(structname); \
a3d826f0 CS	272	VTY_CHECK_CONTEXT(ptr);
0878c8d4	273
0cbed951 DL	274	#define VTY_DECLVAR_CONTEXT_VRF(vrfptr) \
	275	struct vrf *vrfptr; \
	276	if (vty->node == CONFIG_NODE) \
	277	vrfptr = vrf_lookup_by_id(VRF_DEFAULT); \
	278	else \
	279	vrfptr = VTY_GET_CONTEXT(vrf); \
	280	VTY_CHECK_CONTEXT(vrfptr); \
	281	MACRO_REQUIRE_SEMICOLON() /* end */
	282
1c2facd1 RW	283	/* XPath macros. */
	284	#define VTY_PUSH_XPATH(nodeval, value) \
	285	do { \
	286	if (vty->xpath_index >= VTY_MAXDEPTH) { \
	287	vty_out(vty, "%% Reached maximum CLI depth (%u)\n", \
	288	VTY_MAXDEPTH); \
	289	return CMD_WARNING; \
	290	} \
	291	vty->node = nodeval; \
	292	strlcpy(vty->xpath[vty->xpath_index], value, \
	293	sizeof(vty->xpath[0])); \
	294	vty->xpath_index++; \
	295	} while (0)
	296
	297	#define VTY_CURR_XPATH vty->xpath[vty->xpath_index - 1]
	298
	299	#define VTY_CHECK_XPATH \
	300	do { \
caaa8b9c RW	301	if (vty->type != VTY_FILE && !vty->private_config \
caaa8b9c RW	302	&& vty->xpath_index > 0 \
1c2facd1 RW	303	&& !yang_dnode_exists(vty->candidate_config->dnode, \
	304	VTY_CURR_XPATH)) { \
	305	vty_out(vty, \
	306	"Current configuration object was deleted " \
	307	"by another process.\n\n"); \
	308	return CMD_WARNING; \
	309	} \
	310	} while (0)
	311
d62a17ae	312	struct vty_arg {
	313	const char *name;
	314	const char *value;
	315	const char **argv;
	316	int argc;
eac6e3f0 RW	317	};
eac6e3f0 RW	318
718e3744	319	/* Integrated configuration file. */
e20dc2ba	320	#define INTEGRATE_DEFAULT_CONFIG "frr.conf"
718e3744	321
718e3744	322	/* Default time out value */
	323	#define VTY_TIMEOUT_DEFAULT 600
	324
	325	/* Vty read buffer size. */
	326	#define VTY_READ_BUFSIZ 512
	327
	328	/* Directory separator. */
	329	#ifndef DIRECTORY_SEP
	330	#define DIRECTORY_SEP '/'
	331	#endif /* DIRECTORY_SEP */
	332
	333	#ifndef IS_DIRECTORY_SEP
	334	#define IS_DIRECTORY_SEP(c) ((c) == DIRECTORY_SEP)
	335	#endif
	336
718e3744	337	/* Prototypes. */
2950f5da	338	extern void vty_init(struct thread_master *, bool do_command_logging);
d62a17ae	339	extern void vty_init_vtysh(void);
	340	extern void vty_terminate(void);
	341	extern void vty_reset(void);
	342	extern struct vty *vty_new(void);
154b9e8f	343	extern struct vty vty_stdio(void (atclose)(int isexit));
2071aa0e DL	344
	345	/* - vty_frame() output goes to a buffer (for context-begin markers)
	346	* - vty_out() will first print this buffer, and clear it
	347	* - vty_endframe() clears the buffer without printing it, and prints an
	348	* extra string if the buffer was empty before (for context-end markers)
	349	*/
afb35622 DL	350	extern int vty_out(struct vty , const char , ...) PRINTFRR(2, 3);
afb35622 DL	351	extern void vty_frame(struct vty , const char , ...) PRINTFRR(2, 3);
2071aa0e	352	extern void vty_endframe(struct vty , const char );
30f0195d	353	extern bool vty_set_include(struct vty vty, const char regexp);
a8dfd147 DL	354	/* returns CMD_SUCCESS so you can do a one-line "return vty_json(...)"
a8dfd147 DL	355	* NULL check and json_object_free() is included.
d7c6467b DS	356	*
	357	* _no_pretty means do not add a bunch of newlines and dump the output
	358	* as densely as possible.
a8dfd147 DL	359	*/
a8dfd147 DL	360	extern int vty_json(struct vty vty, struct json_object json);
d7c6467b	361	extern int vty_json_no_pretty(struct vty vty, struct json_object json);
2071aa0e	362
b2dde56b DL	363	/* post fd to be passed to the vtysh client
	364	* fd is owned by the VTY code after this and will be closed when done
	365	*/
	366	extern void vty_pass_fd(struct vty *vty, int fd);
	367
1c2facd1 RW	368	extern bool vty_read_config(struct nb_config config, const char config_file,
1c2facd1 RW	369	char *config_default_dir);
d62a17ae	370	extern void vty_time_print(struct vty *, int);
	371	extern void vty_serv_sock(const char , unsigned short, const char );
	372	extern void vty_close(struct vty *);
	373	extern char *vty_get_cwd(void);
763725cd	374	extern void vty_update_xpath(const char oldpath, const char newpath);
f344c66e RW	375	extern int vty_config_enter(struct vty *vty, bool private_config,
	376	bool exclusive);
	377	extern void vty_config_exit(struct vty *);
791ded4a	378	extern int vty_config_node_exit(struct vty *);
d62a17ae	379	extern int vty_shell(struct vty *);
	380	extern int vty_shell_serv(struct vty *);
	381	extern void vty_hello(struct vty *);
718e3744	382
154b9e8f DL	383	/* ^Z / SIGTSTP handling */
	384	extern void vty_stdio_suspend(void);
	385	extern void vty_stdio_resume(void);
	386	extern void vty_stdio_close(void);
	387
5e244469 RW	388	#ifdef __cplusplus
	389	}
	390	#endif
	391
718e3744	392	#endif /* _ZEBRA_VTY_H */