include/osmocom/vty/vty.h

   1 #ifndef _VTY_H
   2 #define _VTY_H
   3
   4 #include <stdio.h>
   5 #include <stdarg.h>
   6
   7 /* GCC have printf type attribute check.  */
   8 #ifdef __GNUC__
   9 #define VTY_PRINTF_ATTRIBUTE(a,b) __attribute__ ((__format__ (__printf__, a, b)))
  10 #else
  11 #define VTY_PRINTF_ATTRIBUTE(a,b)
  12 #endif                          /* __GNUC__ */
  13
  14 /* Does the I/O error indicate that the operation should be retried later? */
  15 #define ERRNO_IO_RETRY(EN) \
  16         (((EN) == EAGAIN) || ((EN) == EWOULDBLOCK) || ((EN) == EINTR))
  17
  18 /* Vty read buffer size. */
  19 #define VTY_READ_BUFSIZ 512
  20
  21 #define VTY_BUFSIZ 512
  22 #define VTY_MAXHIST 20
  23
  24 /* Vty events */
  25 enum event {
  26         VTY_SERV,
  27         VTY_READ,
  28         VTY_WRITE,
  29         VTY_CLOSED,
  30         VTY_TIMEOUT_RESET,
  31 #ifdef VTYSH
  32         VTYSH_SERV,
  33         VTYSH_READ,
  34         VTYSH_WRITE
  35 #endif                          /* VTYSH */
  36 };
  37
  38 struct vty {
  39         FILE *file;
  40
  41         /* private data, specified by creator */
  42         void *priv;
  43
  44         /* File descripter of this vty. */
  45         int fd;
  46
  47         /* Is this vty connect to file or not */
  48         enum { VTY_TERM, VTY_FILE, VTY_SHELL, VTY_SHELL_SERV } type;
  49
  50         /* Node status of this vty */
  51         int node;
  52
  53         /* Failure count */
  54         int fail;
  55
  56         /* Output buffer. */
  57         struct buffer *obuf;
  58
  59         /* Command input buffer */
  60         char *buf;
  61
  62         /* Command cursor point */
  63         int cp;
  64
  65         /* Command length */
  66         int length;
  67
  68         /* Command max length. */
  69         int max;
  70
  71         /* Histry of command */
  72         char *hist[VTY_MAXHIST];
  73
  74         /* History lookup current point */
  75         int hp;
  76
  77         /* History insert end point */
  78         int hindex;
  79
  80         /* For current referencing point of interface, route-map,
  81            access-list etc... */
  82         void *index;
  83
  84         /* For multiple level index treatment such as key chain and key. */
  85         void *index_sub;
  86
  87         /* For escape character. */
  88         unsigned char escape;
  89
  90         /* Current vty status. */
  91         enum { VTY_NORMAL, VTY_CLOSE, VTY_MORE, VTY_MORELINE } status;
  92
  93         /* IAC handling: was the last character received the IAC
  94          * (interpret-as-command) escape character (and therefore the next
  95          * character will be the command code)?  Refer to Telnet RFC 854. */
  96         unsigned char iac;
  97
  98         /* IAC SB (option subnegotiation) handling */
  99         unsigned char iac_sb_in_progress;
 100         /* At the moment, we care only about the NAWS (window size) negotiation,
 101          * and that requires just a 5-character buffer (RFC 1073):
 102          * <NAWS char> <16-bit width> <16-bit height> */
 103 #define TELNET_NAWS_SB_LEN 5
 104         unsigned char sb_buf[TELNET_NAWS_SB_LEN];
 105         /* How many subnegotiation characters have we received?  We just drop
 106          * those that do not fit in the buffer. */
 107         size_t sb_len;
 108
 109         /* Window width/height. */
 110         int width;
 111         int height;
 112
 113         /* Configure lines. */
 114         int lines;
 115
 116         int monitor;
 117
 118         /* In configure mode. */
 119         int config;
 120 };
 121
 122 /* Small macro to determine newline is newline only or linefeed needed. */
 123 #define VTY_NEWLINE  ((vty->type == VTY_TERM) ? "\r\n" : "\n")
 124
 125 static inline char *vty_newline(struct vty *vty)
 126 {
 127         return VTY_NEWLINE;
 128 }
 129
 130 struct vty_app_info {
 131         const char *name;
 132         const char *version;
 133         const char *copyright;
 134         void *tall_ctx;
 135         enum node_type (*go_parent_cb)(struct vty *vty);
 136         int (*is_config_node)(struct vty *vty, int node);
 137 };
 138
 139 /* Prototypes. */
 140 void vty_init(struct vty_app_info *app_info);
 141 int vty_read_config_file(const char *file_name, void *priv);
 142 void vty_init_vtysh (void);
 143 void vty_reset (void);
 144 struct vty *vty_new (void);
 145 struct vty *vty_create (int vty_sock, void *priv);
 146 int vty_out (struct vty *, const char *, ...) VTY_PRINTF_ATTRIBUTE(2, 3);
 147 int vty_out_newline(struct vty *);
 148 int vty_read(struct vty *vty);
 149 //void vty_time_print (struct vty *, int);
 150 void vty_close (struct vty *);
 151 char *vty_get_cwd (void);
 152 void vty_log (const char *level, const char *proto, const char *fmt, va_list);
 153 int vty_config_lock (struct vty *);
 154 int vty_config_unlock (struct vty *);
 155 int vty_shell (struct vty *);
 156 int vty_shell_serv (struct vty *);
 157 void vty_hello (struct vty *);
 158 void *vty_current_index(struct vty *);
 159 int vty_current_node(struct vty *vty);
 160
 161 extern void *tall_vty_ctx;
 162 #endif