vty.h
Go to the documentation of this file.
#pragma once
#include <stdio.h>
#include <stdarg.h>
#include <stdbool.h>
#include <osmocom/core/linuxlist.h>
#include <osmocom/core/defs.h>
/* GCC have printf type attribute check. */
#ifdef __GNUC__
#define VTY_PRINTF_ATTRIBUTE(a,b) __attribute__ ((__format__ (__printf__, a, b)))
#else
#define VTY_PRINTF_ATTRIBUTE(a,b)
#endif /* __GNUC__ */
/* Does the I/O error indicate that the operation should be retried later? */
#define ERRNO_IO_RETRY(EN) \
(((EN) == EAGAIN) || ((EN) == EWOULDBLOCK) || ((EN) == EINTR))
/* Vty read buffer size. */
#define VTY_READ_BUFSIZ 512
#define VTY_BUFSIZ 512
#define VTY_MAXHIST 20
enum event {
VTY_SERV,
VTY_READ,
VTY_WRITE,
VTY_CLOSED,
VTY_TIMEOUT_RESET,
#ifdef VTYSH
VTYSH_SERV,
VTYSH_READ,
VTYSH_WRITE
#endif /* VTYSH */
};
enum vty_type {
VTY_TERM,
VTY_FILE,
VTY_SHELL,
VTY_SHELL_SERV
};
struct vty_parent_node {
struct llist_head entry;
void *priv;
int node;
char *indent;
};
struct vty {
FILE *file;
void *priv;
int fd;
enum vty_type type;
int node;
int fail;
struct buffer *obuf;
char *buf;
int cp;
int length;
int max;
char *hist[VTY_MAXHIST];
int hp;
int hindex;
void *index;
void *index_sub;
unsigned char escape;
enum { VTY_NORMAL, VTY_CLOSE, VTY_MORE, VTY_MORELINE } status;
unsigned char iac;
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];
size_t sb_len;
int width;
int height;
int lines;
int monitor;
int config;
struct llist_head parent_nodes;
char *indent;
};
/* Small macro to determine newline is newline only or linefeed needed. */
#define VTY_NEWLINE ((vty->type == VTY_TERM) ? "\r\n" : "\n")
static inline const char *vty_newline(struct vty *vty)
{
return VTY_NEWLINE;
}
struct vty_app_info {
const char *name;
const char *version;
const char *copyright;
void *tall_ctx;
int (*go_parent_cb)(struct vty *vty);
int (*is_config_node)(struct vty *vty, int node)
OSMO_DEPRECATED("Implicit parent node tracking has replaced the use of this callback. This callback is"
" no longer called, ever, and can be left NULL.");
int (*config_is_consistent)(struct vty *vty);
};
/* Prototypes. */
void vty_init(struct vty_app_info *app_info);
int vty_read_config_file(const char *file_name, void *priv);
void vty_init_vtysh (void);
void vty_reset (void);
struct vty *vty_new (void);
struct vty *vty_create (int vty_sock, void *priv);
bool vty_is_active(struct vty *vty);
int vty_out (struct vty *, const char *, ...) VTY_PRINTF_ATTRIBUTE(2, 3);
int vty_out_va(struct vty *vty, const char *format, va_list ap);
int vty_out_newline(struct vty *);
int vty_read(struct vty *vty);
//void vty_time_print (struct vty *, int);
void vty_close (struct vty *);
char *vty_get_cwd (void);
void vty_log (const char *level, const char *proto, const char *fmt, va_list);
int vty_config_lock (struct vty *);
int vty_config_unlock (struct vty *);
int vty_shell (struct vty *);
int vty_shell_serv (struct vty *);
void vty_hello (struct vty *);
void *vty_current_index(struct vty *);
int vty_current_node(struct vty *vty);
int vty_go_parent(struct vty *vty);
/* Return IP address passed to the 'line vty'/'bind' command, or "127.0.0.1" */
const char *vty_get_bind_addr(void);
int vty_get_bind_port(int default_port);
extern void *tall_vty_ctx;
extern struct cmd_element cfg_description_cmd;
extern struct cmd_element cfg_no_description_cmd;
enum signal_vty {
S_VTY_EVENT,
};
struct vty_signal_data {
enum event event;
int sock;
struct vty *vty;
};
defs.h
vty
vty
Definition: tdef_vty.c:299
node
uint16_t node
OSMO_DEPRECATED
#define OSMO_DEPRECATED(text)
vty_go_parent
int vty_go_parent(struct vty *vty)
Definition: command.c:2222
vty_config_lock
int vty_config_lock(struct vty *)
Lock the configuration to a given VTY.
Definition: vty.c:357
vty_type
vty_type
Definition: vty.h:45
vty_create
struct vty * vty_create(int vty_sock, void *priv)
Create new vty structure.
Definition: vty.c:1515
vty_reset
void vty_reset(void)
Reset all VTY status.
Definition: vty.c:1741
VTY_MAXHIST
#define VTY_MAXHIST
Definition: vty.h:29
vty_get_cwd
char * vty_get_cwd(void)
Definition: vty.c:1781
vty_shell_serv
int vty_shell_serv(struct vty *)
Definition: vty.c:1786
VTY_NEWLINE
#define VTY_NEWLINE
Definition: vty.h:165
vty_get_bind_addr
const char * vty_get_bind_addr(void)
Definition: vty.c:1634
VTY_PRINTF_ATTRIBUTE
#define VTY_PRINTF_ATTRIBUTE(a, b)
Definition: vty.h:18
vty_new
struct vty * vty_new(void)
Allocate a new vty interface structure.
Definition: vty.c:119
cfg_description_cmd
struct cmd_element cfg_description_cmd
vty_init_vtysh
void vty_init_vtysh(void)
Definition: vty.c:1791
vty_read
int vty_read(struct vty *vty)
Read data via vty socket.
Definition: vty.c:1282
vty_read_config_file
int vty_read_config_file(const char *file_name, void *priv)
Read the configuration file using the VTY code.
Definition: vty.c:1836
vty_log
void vty_log(const char *level, const char *proto, const char *fmt, va_list)
vty_current_node
int vty_current_node(struct vty *vty)
return the current node of a given VTY
Definition: vty.c:346
vty_shell
int vty_shell(struct vty *)
Return if this VTY is a shell or not.
Definition: vty.c:258
vty_is_active
bool vty_is_active(struct vty *vty)
Definition: telnet_interface.c:212
vty_close
void vty_close(struct vty *)
Close a given vty interface.
Definition: vty.c:215
vty_hello
void vty_hello(struct vty *)
Definition: vty.c:380
vty_get_bind_port
int vty_get_bind_port(int default_port)
Returns configured port passed to the 'line vty'/'bind' command or default_port.
Definition: vty.c:1641
vty_config_unlock
int vty_config_unlock(struct vty *)
Unlock the configuration from a given VTY.
Definition: vty.c:370
vty_out_newline
int vty_out_newline(struct vty *)
print a newline on the given VTY
Definition: vty.c:332
cfg_no_description_cmd
struct cmd_element cfg_no_description_cmd
vty_out_va
int int vty_out_va(struct vty *vty, const char *format, va_list ap)
Definition: vty.c:263
vty_newline
static const char * vty_newline(struct vty *vty)
Definition: vty.h:167
vty_current_index
void * vty_current_index(struct vty *)
return the current index of a given VTY
Definition: vty.c:340
vty_out
int vty_out(struct vty *, const char *,...) VTY_PRINTF_ATTRIBUTE(2
vty_init
void vty_init(struct vty_app_info *app_info)
Initialize VTY layer.
Definition: vty.c:1800
signal_vty
signal_vty
signal handling
Definition: vty.h:236
tall_vty_ctx
void * tall_vty_ctx
Definition: vty.c:111
VTY_FILE
@ VTY_FILE
Definition: vty.h:47
VTY_SHELL
@ VTY_SHELL
Definition: vty.h:48
VTY_SHELL_SERV
@ VTY_SHELL_SERV
Definition: vty.h:49
VTY_TERM
@ VTY_TERM
Definition: vty.h:46
VTY_WRITE
@ VTY_WRITE
Definition: vty.h:35
VTY_SERV
@ VTY_SERV
Definition: vty.h:33
VTY_READ
@ VTY_READ
Definition: vty.h:34
VTY_CLOSED
@ VTY_CLOSED
Definition: vty.h:36
VTY_TIMEOUT_RESET
@ VTY_TIMEOUT_RESET
Definition: vty.h:37
S_VTY_EVENT
@ S_VTY_EVENT
Definition: vty.h:237
linuxlist.h
buffer
Definition: buffer.c:39
cmd_element
Structure of a command element.
Definition: command.h:143
llist_head
vty_app_info
Information an application registers with the VTY.
Definition: vty.h:173
vty_app_info::config_is_consistent
int(* config_is_consistent)(struct vty *vty)
Check if the config is consistent before write.
Definition: vty.h:194
vty_app_info::version
const char * version
version string of the application
Definition: vty.h:177
vty_app_info::name
const char * name
name of the application
Definition: vty.h:175
vty_app_info::copyright
const char * copyright
copyright string of the application
Definition: vty.h:179
vty_app_info::go_parent_cb
int(* go_parent_cb)(struct vty *vty)
Call-back for taking actions upon exiting a node.
Definition: vty.h:187
vty_app_info::tall_ctx
void * tall_ctx
talloc context
Definition: vty.h:181
vty_app_info::is_config_node
int(* is_config_node)(struct vty *vty, int node) OSMO_DEPRECATED("Implicit parent node tracking has replaced the use of this callback. This callback is" " no longer called
OBSOLETED: Implicit parent node tracking has replaced the use of this callback.
Definition: vty.h:190
vty_parent_node
Definition: vty.h:52
vty_parent_node::indent
char * indent
When reading from a config file, these are the indenting characters expected for children of this VTY...
Definition: vty.h:63
vty_parent_node::entry
struct llist_head entry
Definition: vty.h:53
vty_parent_node::node
int node
Node status of this vty.
Definition: vty.h:59
vty_parent_node::priv
void * priv
private data, specified by creator
Definition: vty.h:56
vty_signal_data
Definition: vty.h:240
vty_signal_data::event
enum event event
Definition: vty.h:241
vty_signal_data::vty
struct vty * vty
Definition: vty.h:243
vty_signal_data::sock
int sock
Definition: vty.h:242
vty
Internal representation of a single VTY.
Definition: vty.h:67
vty::obuf
struct buffer * obuf
Output buffer.
Definition: vty.h:87
vty::fail
int fail
Failure count.
Definition: vty.h:84
vty::config
int config
In configure mode.
Definition: vty.h:154
vty::priv
void * priv
private data, specified by creator
Definition: vty.h:72
vty::length
int length
Command length.
Definition: vty.h:96
vty::index_sub
void * index_sub
For multiple level index treatment such as key chain and key.
Definition: vty.h:115
vty::hist
char * hist[VTY_MAXHIST]
Histry of command.
Definition: vty.h:102
vty::width
int width
Window width.
Definition: vty.h:144
vty::escape
unsigned char escape
For escape character.
Definition: vty.h:118
vty::VTY_MORELINE
@ VTY_MORELINE
Definition: vty.h:121
vty::VTY_NORMAL
@ VTY_NORMAL
Definition: vty.h:121
vty::VTY_MORE
@ VTY_MORE
Definition: vty.h:121
vty::VTY_CLOSE
@ VTY_CLOSE
Definition: vty.h:121
vty::parent_nodes
struct llist_head parent_nodes
List of parent nodes, last item is the outermost parent.
Definition: vty.h:157
vty::indent
char * indent
When reading from a config file, these are the indenting characters expected for children of the curr...
Definition: vty.h:161
vty::hp
int hp
History lookup current point.
Definition: vty.h:105
vty::file
FILE * file
underlying file (if any)
Definition: vty.h:69
vty::iac
unsigned char iac
IAC handling.
Definition: vty.h:128
vty::height
int height
Widnow height.
Definition: vty.h:146
vty::sb_len
size_t sb_len
How many subnegotiation characters have we received?
Definition: vty.h:141
vty::index
void * index
For current referencing point of interface, route-map, access-list etc...
Definition: vty.h:112
vty::sb_buf
unsigned char sb_buf[TELNET_NAWS_SB_LEN]
sub-negotiation buffer
Definition: vty.h:137
vty::node
int node
Node status of this vty.
Definition: vty.h:81
vty::buf
char * buf
Command input buffer.
Definition: vty.h:90
vty::cp
int cp
Command cursor point.
Definition: vty.h:93
vty::status
enum vty::@1 status
Current vty status.
vty::monitor
int monitor
Definition: vty.h:151
vty::max
int max
Command max length.
Definition: vty.h:99
vty::type
enum vty_type type
Is this vty connect to file or not.
Definition: vty.h:78
vty::fd
int fd
File descripter of this vty.
Definition: vty.h:75
vty::hindex
int hindex
History insert end point.
Definition: vty.h:108
vty::lines
int lines
Configure lines.
Definition: vty.h:149
vty::iac_sb_in_progress
unsigned char iac_sb_in_progress
IAC SB (option subnegotiation) handling.
Definition: vty.h:131
TELNET_NAWS_SB_LEN
#define TELNET_NAWS_SB_LEN
Definition: vty.h:135