vty.h

Go to the documentation of this file.

#pragma once
 
#include <stdio.h>
#include <stdarg.h>
#include <stdbool.h>
#include <time.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
 
/* Number of application / library specific VTY attributes */
#define VTY_CMD_USR_ATTR_NUM 32
/* Flag characters reserved for global VTY attributes */
#define VTY_CMD_ATTR_FLAGS_RESERVED \
        { '.', '!', '@', '^' }
 
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 {
        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;
 
        bool expert_mode;
};
 
/* 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);
        const char * usr_attr_desc[VTY_CMD_USR_ATTR_NUM];
        char usr_attr_letters[VTY_CMD_USR_ATTR_NUM];
};
 
/* Prototypes. */
void vty_init(struct vty_app_info *app_info);
int vty_read_config_file(const char *file_name, void *priv);
int vty_read_config_filep(FILE *confp, 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_out_uptime(struct vty *vty, const struct timespec *starttime);
int vty_read(struct vty *vty);
//void vty_time_print (struct vty *, int);
void vty_close (struct vty *);
void vty_flush(struct vty *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;
};