libosmovty 0.9.6-23.20170220git32ee5af8.fc42
Osmocom VTY library
Loading...
Searching...
No Matches
vty.h
Go to the documentation of this file.
1#pragma once
2
3#include <stdio.h>
4#include <stdarg.h>
5
11/* GCC have printf type attribute check. */
12#ifdef __GNUC__
13#define VTY_PRINTF_ATTRIBUTE(a,b) __attribute__ ((__format__ (__printf__, a, b)))
14#else
15#define VTY_PRINTF_ATTRIBUTE(a,b)
16#endif /* __GNUC__ */
17
18/* Does the I/O error indicate that the operation should be retried later? */
19#define ERRNO_IO_RETRY(EN) \
20 (((EN) == EAGAIN) || ((EN) == EWOULDBLOCK) || ((EN) == EINTR))
21
22/* Vty read buffer size. */
23#define VTY_READ_BUFSIZ 512
24
25#define VTY_BUFSIZ 512
26#define VTY_MAXHIST 20
27
29enum event {
30 VTY_SERV,
31 VTY_READ,
32 VTY_WRITE,
33 VTY_CLOSED,
34 VTY_TIMEOUT_RESET,
35#ifdef VTYSH
36 VTYSH_SERV,
37 VTYSH_READ,
38 VTYSH_WRITE
39#endif /* VTYSH */
40};
41
42enum vty_type {
43 VTY_TERM,
44 VTY_FILE,
45 VTY_SHELL,
46 VTY_SHELL_SERV
47};
48
50struct vty {
52 FILE *file;
53
55 void *priv;
56
58 int fd;
59
61 enum vty_type type;
62
64 int node;
65
67 int fail;
68
70 struct buffer *obuf;
71
73 char *buf;
74
76 int cp;
77
79 int length;
80
82 int max;
83
85 char *hist[VTY_MAXHIST];
86
88 int hp;
89
91 int hindex;
92
95 void *index;
96
98 void *index_sub;
99
101 unsigned char escape;
102
104 enum { VTY_NORMAL, VTY_CLOSE, VTY_MORE, VTY_MORELINE } status;
105
111 unsigned char iac;
112
114 unsigned char iac_sb_in_progress;
115 /* At the moment, we care only about the NAWS (window size) negotiation,
116 * and that requires just a 5-character buffer (RFC 1073):
117 * <NAWS char> <16-bit width> <16-bit height> */
118#define TELNET_NAWS_SB_LEN 5
120 unsigned char sb_buf[TELNET_NAWS_SB_LEN];
124 size_t sb_len;
125
127 int width;
130
132 int lines;
133
134 int monitor;
135
138};
139
140/* Small macro to determine newline is newline only or linefeed needed. */
141#define VTY_NEWLINE ((vty->type == VTY_TERM) ? "\r\n" : "\n")
142
143static inline const char *vty_newline(struct vty *vty)
144{
145 return VTY_NEWLINE;
146}
147
151 const char *name;
153 const char *version;
155 const char *copyright;
157 void *tall_ctx;
159 int (*go_parent_cb)(struct vty *vty);
161 int (*is_config_node)(struct vty *vty, int node);
163 int (*config_is_consistent)(struct vty *vty);
164};
165
166/* Prototypes. */
167void vty_init(struct vty_app_info *app_info);
168int vty_read_config_file(const char *file_name, void *priv);
169void vty_init_vtysh (void);
170void vty_reset (void);
171struct vty *vty_new (void);
172struct vty *vty_create (int vty_sock, void *priv);
173int vty_out (struct vty *, const char *, ...) VTY_PRINTF_ATTRIBUTE(2, 3);
174int vty_out_newline(struct vty *);
175int vty_read(struct vty *vty);
176//void vty_time_print (struct vty *, int);
177void vty_close (struct vty *);
178char *vty_get_cwd (void);
179void vty_log (const char *level, const char *proto, const char *fmt, va_list);
180int vty_config_lock (struct vty *);
181int vty_config_unlock (struct vty *);
182int vty_shell (struct vty *);
183int vty_shell_serv (struct vty *);
184void vty_hello (struct vty *);
185void *vty_current_index(struct vty *);
186int vty_current_node(struct vty *vty);
187int vty_go_parent(struct vty *vty);
188
189/* Return IP address passed to the 'line vty'/'bind' command, or "127.0.0.1" */
190const char *vty_get_bind_addr(void);
191
192extern void *tall_vty_ctx;
193
194extern struct cmd_element cfg_description_cmd;
195extern struct cmd_element cfg_no_description_cmd;
196
197
202 S_VTY_EVENT,
203};
204
206 enum event event;
207 int sock;
208 struct vty *vty;
209};
210
int vty_config_lock(struct vty *)
Lock the configuration to a given VTY.
Definition vty.c:323
struct vty * vty_new(void)
Allocate a new vty interface structure.
Definition vty.c:97
void vty_reset(void)
Reset all VTY status.
Definition vty.c:1696
event
VTY events.
Definition vty.h:29
int vty_read(struct vty *vty)
Read data via vty socket.
Definition vty.c:1266
int vty_read_config_file(const char *file_name, void *priv)
Read the configuration file using the VTY code.
Definition vty.c:1794
int vty_current_node(struct vty *vty)
return the current node of a given VTY
Definition vty.c:312
int vty_shell(struct vty *)
Return if this VTY is a shell or not.
Definition vty.c:231
void vty_close(struct vty *)
Close a given vty interface.
Definition vty.c:190
int vty_config_unlock(struct vty *)
Unlock the configuration from a given VTY.
Definition vty.c:336
struct vty * vty_create(int vty_sock, void *priv)
Create new vty structure.
Definition vty.c:1487
int int vty_out_newline(struct vty *)
print a newline on the given VTY
Definition vty.c:298
void * vty_current_index(struct vty *)
return the current index of a given VTY
Definition vty.c:306
void vty_init(struct vty_app_info *app_info)
Initialize VTY layer.
Definition vty.c:1757
signal_vty
Definition vty.h:201
Definition buffer.c:36
Structure of a command element.
Definition command.h:126
Definition vty.h:149
int(* config_is_consistent)(struct vty *vty)
Check if the config is consistent before write.
Definition vty.h:163
const char * version
version string of the application
Definition vty.h:153
const char * name
name of the application
Definition vty.h:151
const char * copyright
copyright string of the application
Definition vty.h:155
int(* is_config_node)(struct vty *vty, int node)
call-back to determine if node is config node
Definition vty.h:161
int(* go_parent_cb)(struct vty *vty)
call-back for returning to parent n ode
Definition vty.h:159
void * tall_ctx
talloc context
Definition vty.h:157
Definition vty.h:205
Definition vty.h:50
struct buffer * obuf
Output buffer.
Definition vty.h:70
int fail
Failure count.
Definition vty.h:67
int config
In configure mode.
Definition vty.h:137
void * priv
private data, specified by creator
Definition vty.h:55
int length
Command length.
Definition vty.h:79
void * index_sub
For multiple level index treatment such as key chain and key.
Definition vty.h:98
char * hist[VTY_MAXHIST]
Histry of command.
Definition vty.h:85
int width
Window width.
Definition vty.h:127
unsigned char escape
For escape character.
Definition vty.h:101
int hp
History lookup current point.
Definition vty.h:88
FILE * file
underlying file (if any)
Definition vty.h:52
unsigned char iac
IAC handling.
Definition vty.h:111
int height
Widnow height.
Definition vty.h:129
size_t sb_len
How many subnegotiation characters have we received?
Definition vty.h:124
void * index
For current referencing point of interface, route-map, access-list etc...
Definition vty.h:95
unsigned char sb_buf[TELNET_NAWS_SB_LEN]
sub-negotiation buffer
Definition vty.h:120
int node
Node status of this vty.
Definition vty.h:64
enum vty::@062211330140260002077015174337205375043010140101 status
Current vty status.
char * buf
Command input buffer.
Definition vty.h:73
int cp
Command cursor point.
Definition vty.h:76
int max
Command max length.
Definition vty.h:82
enum vty_type type
Is this vty connect to file or not.
Definition vty.h:61
int fd
File descripter of this vty.
Definition vty.h:58
int hindex
History insert end point.
Definition vty.h:91
int lines
Configure lines.
Definition vty.h:132
unsigned char iac_sb_in_progress
IAC SB (option subnegotiation) handling.
Definition vty.h:114