lib/vty.h

   1 /* Virtual terminal [aka TeletYpe] interface routine
   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  */
  20
  21 #ifndef _ZEBRA_VTY_H
  22 #define _ZEBRA_VTY_H
  23
  24 #include "thread.h"
  25 #include "log.h"
  26 #include "sockunion.h"
  27 #include "qobj.h"
  28
  29 #define VTY_BUFSIZ 4096
  30 #define VTY_MAXHIST 20
  31
  32 /* VTY struct. */
  33 struct vty
  34 {
  35   /* File descripter of this vty. */
  36   int fd;
  37
  38   /* output FD, to support stdin/stdout combination */
  39   int wfd;
  40
  41   /* Is this vty connect to file or not */
  42   enum {VTY_TERM, VTY_FILE, VTY_SHELL, VTY_SHELL_SERV} type;
  43
  44   /* Node status of this vty */
  45   int node;
  46
  47   /* Failure count */
  48   int fail;
  49
  50   /* Output buffer. */
  51   struct buffer *obuf;
  52
  53   /* Command input buffer */
  54   char *buf;
  55
  56   /* Command input error buffer */
  57   char *error_buf;
  58
  59   /* Command cursor point */
  60   int cp;
  61
  62   /* Command length */
  63   int length;
  64
  65   /* Command max length. */
  66   int max;
  67
  68   /* Histry of command */
  69   char *hist[VTY_MAXHIST];
  70
  71   /* History lookup current point */
  72   int hp;
  73
  74   /* History insert end point */
  75   int hindex;
  76
  77   /* qobj object ID (replacement for "index") */
  78   uint64_t qobj_index;
  79
  80   /* qobj second-level object ID (replacement for "index_sub") */
  81   uint64_t qobj_index_sub;
  82
  83   /* For escape character. */
  84   unsigned char escape;
  85
  86   /* Current vty status. */
  87   enum {VTY_NORMAL, VTY_CLOSE, VTY_MORE, VTY_MORELINE} status;
  88
  89   /* IAC handling: was the last character received the
  90      IAC (interpret-as-command) escape character (and therefore the next
  91      character will be the command code)?  Refer to Telnet RFC 854. */
  92   unsigned char iac;
  93
  94   /* IAC SB (option subnegotiation) handling */
  95   unsigned char iac_sb_in_progress;
  96   /* At the moment, we care only about the NAWS (window size) negotiation,
  97      and that requires just a 5-character buffer (RFC 1073):
  98        <NAWS char> <16-bit width> <16-bit height> */
  99 #define TELNET_NAWS_SB_LEN 5
 100   unsigned char sb_buf[TELNET_NAWS_SB_LEN];
 101   /* How many subnegotiation characters have we received?  We just drop
 102      those that do not fit in the buffer. */
 103   size_t sb_len;
 104
 105   /* Window width/height. */
 106   int width;
 107   int height;
 108
 109   /* Configure lines. */
 110   int lines;
 111
 112   /* Terminal monitor. */
 113   int monitor;
 114
 115   /* In configure mode. */
 116   int config;
 117
 118   /* Read and write thread. */
 119   struct thread *t_read;
 120   struct thread *t_write;
 121
 122   /* Timeout seconds and thread. */
 123   unsigned long v_timeout;
 124   struct thread *t_timeout;
 125
 126   /* What address is this vty comming from. */
 127   char address[SU_ADDRSTRLEN];
 128 };
 129
 130 static inline void vty_push_context(struct vty *vty,
 131                                     int node, uint64_t id)
 132 {
 133   vty->node = node;
 134   vty->qobj_index = id;
 135 }
 136
 137 /* note: VTY_PUSH_CONTEXT(..., NULL) doesn't work, since it will try to
 138  * dereference "NULL->qobj_node.nid" */
 139 #define VTY_PUSH_CONTEXT(nodeval, ptr) \
 140         vty_push_context(vty, nodeval, QOBJ_ID_0SAFE(ptr))
 141 #define VTY_PUSH_CONTEXT_NULL(nodeval) \
 142         vty_push_context(vty, nodeval, 0ULL)
 143 #define VTY_PUSH_CONTEXT_SUB(nodeval, ptr) do { \
 144                 vty->node = nodeval; \
 145                 /* qobj_index stays untouched */ \
 146                 vty->qobj_index_sub = QOBJ_ID_0SAFE(ptr); \
 147         } while (0)
 148
 149 /* can return NULL if context is invalid! */
 150 #define VTY_GET_CONTEXT(structname) \
 151         QOBJ_GET_TYPESAFE(vty->qobj_index, structname)
 152 #define VTY_GET_CONTEXT_SUB(structname) \
 153         QOBJ_GET_TYPESAFE(vty->qobj_index_sub, structname)
 154
 155 /* will return if ptr is NULL. */
 156 #define VTY_CHECK_CONTEXT(ptr) \
 157         if (!ptr) { \
 158                 vty_out (vty, "Current configuration object was deleted " \
 159                                 "by another process.%s", VTY_NEWLINE); \
 160                 return CMD_WARNING; \
 161         }
 162
 163 /* struct structname *ptr = <context>;   ptr will never be NULL. */
 164 #define VTY_DECLVAR_CONTEXT(structname, ptr) \
 165         struct structname *ptr = VTY_GET_CONTEXT(structname); \
 166         VTY_CHECK_CONTEXT(ptr);
 167 #define VTY_DECLVAR_CONTEXT_SUB(structname, ptr) \
 168         struct structname *ptr = VTY_GET_CONTEXT_SUB(structname); \
 169         VTY_CHECK_CONTEXT(ptr);
 170
 171 struct vty_arg
 172 {
 173   const char *name;
 174   const char *value;
 175   const char **argv;
 176   int argc;
 177 };
 178
 179 /* Integrated configuration file. */
 180 #define INTEGRATE_DEFAULT_CONFIG "frr.conf"
 181
 182 /* Small macro to determine newline is newline only or linefeed needed. */
 183 #define VTY_NEWLINE  ((vty->type == VTY_TERM) ? "\r\n" : "\n")
 184
 185 /* Default time out value */
 186 #define VTY_TIMEOUT_DEFAULT 600
 187
 188 /* Vty read buffer size. */
 189 #define VTY_READ_BUFSIZ 512
 190
 191 /* Directory separator. */
 192 #ifndef DIRECTORY_SEP
 193 #define DIRECTORY_SEP '/'
 194 #endif /* DIRECTORY_SEP */
 195
 196 #ifndef IS_DIRECTORY_SEP
 197 #define IS_DIRECTORY_SEP(c) ((c) == DIRECTORY_SEP)
 198 #endif
 199
 200 /* GCC have printf type attribute check.  */
 201 #ifdef __GNUC__
 202 #define PRINTF_ATTRIBUTE(a,b) __attribute__ ((__format__ (__printf__, a, b)))
 203 #else
 204 #define PRINTF_ATTRIBUTE(a,b)
 205 #endif /* __GNUC__ */
 206
 207 /* Exported variables */
 208 extern char integrate_default[];
 209
 210 /* Prototypes. */
 211 extern void vty_init (struct thread_master *);
 212 extern void vty_init_vtysh (void);
 213 extern void vty_terminate (void);
 214 extern void vty_reset (void);
 215 extern struct vty *vty_new (void);
 216 extern struct vty *vty_stdio (void (*atclose)(void));
 217 extern int vty_out (struct vty *, const char *, ...) PRINTF_ATTRIBUTE(2, 3);
 218 extern void vty_read_config (const char *, char *);
 219 extern void vty_time_print (struct vty *, int);
 220 extern void vty_serv_sock (const char *, unsigned short, const char *);
 221 extern void vty_close (struct vty *);
 222 extern char *vty_get_cwd (void);
 223 extern void vty_log (const char *level, const char *proto,
 224                      const char *fmt, struct timestamp_control *, va_list);
 225 extern int vty_config_lock (struct vty *);
 226 extern int vty_config_unlock (struct vty *);
 227 extern void vty_config_lockless (void);
 228 extern int vty_shell (struct vty *);
 229 extern int vty_shell_serv (struct vty *);
 230 extern void vty_hello (struct vty *);
 231
 232 /* Send a fixed-size message to all vty terminal monitors; this should be
 233    an async-signal-safe function. */
 234 extern void vty_log_fixed (char *buf, size_t len);
 235
 236 #endif /* _ZEBRA_VTY_H */