diff options
Diffstat (limited to 'lib/vty.h')
| -rw-r--r-- | lib/vty.h | 289 |
1 files changed, 150 insertions, 139 deletions
@@ -30,150 +30,148 @@ #define VTY_MAXHIST 20 /* VTY struct. */ -struct vty -{ - /* File descripter of this vty. */ - int fd; +struct vty { + /* File descripter of this vty. */ + int fd; - /* output FD, to support stdin/stdout combination */ - int wfd; + /* output FD, to support stdin/stdout combination */ + int wfd; - /* Is this vty connect to file or not */ - enum {VTY_TERM, VTY_FILE, VTY_SHELL, VTY_SHELL_SERV} type; + /* Is this vty connect to file or not */ + enum { VTY_TERM, VTY_FILE, VTY_SHELL, VTY_SHELL_SERV } type; - /* Node status of this vty */ - int node; + /* Node status of this vty */ + int node; - /* Failure count */ - int fail; + /* Failure count */ + int fail; - /* Output buffer. */ - struct buffer *obuf; + /* Output buffer. */ + struct buffer *obuf; - /* Command input buffer */ - char *buf; + /* Command input buffer */ + char *buf; - /* Command input error buffer */ - char *error_buf; + /* Command input error buffer */ + char *error_buf; - /* Command cursor point */ - int cp; + /* Command cursor point */ + int cp; - /* Command length */ - int length; + /* Command length */ + int length; - /* Command max length. */ - int max; + /* Command max length. */ + int max; - /* Histry of command */ - char *hist[VTY_MAXHIST]; + /* Histry of command */ + char *hist[VTY_MAXHIST]; - /* History lookup current point */ - int hp; + /* History lookup current point */ + int hp; - /* History insert end point */ - int hindex; + /* History insert end point */ + int hindex; - /* qobj object ID (replacement for "index") */ - uint64_t qobj_index; + /* qobj object ID (replacement for "index") */ + uint64_t qobj_index; - /* qobj second-level object ID (replacement for "index_sub") */ - uint64_t qobj_index_sub; + /* qobj second-level object ID (replacement for "index_sub") */ + uint64_t qobj_index_sub; - /* For escape character. */ - unsigned char escape; + /* For escape character. */ + unsigned char escape; - /* Current vty status. */ - enum {VTY_NORMAL, VTY_CLOSE, VTY_MORE, VTY_MORELINE} status; + /* Current vty status. */ + enum { VTY_NORMAL, VTY_CLOSE, VTY_MORE, VTY_MORELINE } status; - /* IAC handling: was the last character received the - IAC (interpret-as-command) escape character (and therefore the next - character will be the command code)? Refer to Telnet RFC 854. */ - unsigned char iac; + /* IAC handling: was the last character received the + IAC (interpret-as-command) escape character (and therefore the next + character will be the command code)? Refer to Telnet RFC 854. */ + unsigned char iac; - /* IAC SB (option subnegotiation) handling */ - 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> */ + /* IAC SB (option subnegotiation) handling */ + 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]; - /* How many subnegotiation characters have we received? We just drop - those that do not fit in the buffer. */ - size_t sb_len; + unsigned char sb_buf[TELNET_NAWS_SB_LEN]; + /* How many subnegotiation characters have we received? We just drop + those that do not fit in the buffer. */ + size_t sb_len; - /* Window width/height. */ - int width; - int height; + /* Window width/height. */ + int width; + int height; - /* Configure lines. */ - int lines; + /* Configure lines. */ + int lines; - /* Terminal monitor. */ - int monitor; + /* Terminal monitor. */ + int monitor; - /* In configure mode. */ - int config; + /* In configure mode. */ + int config; - /* Read and write thread. */ - struct thread *t_read; - struct thread *t_write; + /* Read and write thread. */ + struct thread *t_read; + struct thread *t_write; - /* Timeout seconds and thread. */ - unsigned long v_timeout; - struct thread *t_timeout; + /* Timeout seconds and thread. */ + unsigned long v_timeout; + struct thread *t_timeout; - /* What address is this vty comming from. */ - char address[SU_ADDRSTRLEN]; + /* What address is this vty comming from. */ + char address[SU_ADDRSTRLEN]; }; -static inline void vty_push_context(struct vty *vty, - int node, uint64_t id) +static inline void vty_push_context(struct vty *vty, int node, uint64_t id) { - vty->node = node; - vty->qobj_index = id; + vty->node = node; + vty->qobj_index = id; } /* note: VTY_PUSH_CONTEXT(..., NULL) doesn't work, since it will try to * dereference "NULL->qobj_node.nid" */ -#define VTY_PUSH_CONTEXT(nodeval, ptr) \ +#define VTY_PUSH_CONTEXT(nodeval, ptr) \ vty_push_context(vty, nodeval, QOBJ_ID_0SAFE(ptr)) -#define VTY_PUSH_CONTEXT_NULL(nodeval) \ - vty_push_context(vty, nodeval, 0ULL) -#define VTY_PUSH_CONTEXT_SUB(nodeval, ptr) do { \ - vty->node = nodeval; \ - /* qobj_index stays untouched */ \ - vty->qobj_index_sub = QOBJ_ID_0SAFE(ptr); \ +#define VTY_PUSH_CONTEXT_NULL(nodeval) vty_push_context(vty, nodeval, 0ULL) +#define VTY_PUSH_CONTEXT_SUB(nodeval, ptr) \ + do { \ + vty->node = nodeval; \ + /* qobj_index stays untouched */ \ + vty->qobj_index_sub = QOBJ_ID_0SAFE(ptr); \ } while (0) /* can return NULL if context is invalid! */ -#define VTY_GET_CONTEXT(structname) \ +#define VTY_GET_CONTEXT(structname) \ QOBJ_GET_TYPESAFE(vty->qobj_index, structname) -#define VTY_GET_CONTEXT_SUB(structname) \ +#define VTY_GET_CONTEXT_SUB(structname) \ QOBJ_GET_TYPESAFE(vty->qobj_index_sub, structname) /* will return if ptr is NULL. */ -#define VTY_CHECK_CONTEXT(ptr) \ - if (!ptr) { \ - vty_out (vty, "Current configuration object was deleted " \ - "by another process.\n"); \ - return CMD_WARNING; \ +#define VTY_CHECK_CONTEXT(ptr) \ + if (!ptr) { \ + vty_out(vty, \ + "Current configuration object was deleted " \ + "by another process.\n"); \ + return CMD_WARNING; \ } /* struct structname *ptr = <context>; ptr will never be NULL. */ -#define VTY_DECLVAR_CONTEXT(structname, ptr) \ - struct structname *ptr = VTY_GET_CONTEXT(structname); \ +#define VTY_DECLVAR_CONTEXT(structname, ptr) \ + struct structname *ptr = VTY_GET_CONTEXT(structname); \ VTY_CHECK_CONTEXT(ptr); -#define VTY_DECLVAR_CONTEXT_SUB(structname, ptr) \ - struct structname *ptr = VTY_GET_CONTEXT_SUB(structname); \ +#define VTY_DECLVAR_CONTEXT_SUB(structname, ptr) \ + struct structname *ptr = VTY_GET_CONTEXT_SUB(structname); \ VTY_CHECK_CONTEXT(ptr); -struct vty_arg -{ - const char *name; - const char *value; - const char **argv; - int argc; +struct vty_arg { + const char *name; + const char *value; + const char **argv; + int argc; }; /* Integrated configuration file. */ @@ -184,10 +182,11 @@ struct vty_arg #define CPP_WARN_STR(X) #X #define CPP_WARN(text) _Pragma(CPP_WARN_STR(message __FILE__ ": " text)) -#elif (defined(__GNUC__) && \ - (__GNUC__ >= 5 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 8))) || \ - (defined(__clang__) && \ - (__clang_major__ >= 4 || (__clang_major__ == 3 && __clang_minor__ >= 5))) +#elif (defined(__GNUC__) \ + && (__GNUC__ >= 5 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 8))) \ + || (defined(__clang__) \ + && (__clang_major__ >= 4 \ + || (__clang_major__ == 3 && __clang_minor__ >= 5))) #define CPP_WARN_STR(X) #X #define CPP_WARN(text) _Pragma(CPP_WARN_STR(GCC warning text)) @@ -195,27 +194,39 @@ struct vty_arg #define CPP_WARN(text) #endif -#define VNL "\n" \ - CPP_WARN("VNL has been replaced with \\n.") -#define VTYNL "\n" \ - CPP_WARN("VTYNL has been replaced with \\n.") -#define VTY_NEWLINE "\n" \ - CPP_WARN("VTY_NEWLINE has been replaced with \\n.") -#define VTY_GET_INTEGER(desc,v,str) {(v)=strtoul ((str), NULL, 10);} \ +#define VNL "\n" CPP_WARN("VNL has been replaced with \\n.") +#define VTYNL "\n" CPP_WARN("VTYNL has been replaced with \\n.") +#define VTY_NEWLINE "\n" CPP_WARN("VTY_NEWLINE has been replaced with \\n.") +#define VTY_GET_INTEGER(desc, v, str) \ + { \ + (v) = strtoul((str), NULL, 10); \ + } \ CPP_WARN("VTY_GET_INTEGER is no longer useful, use strtoul() or DEFPY.") -#define VTY_GET_INTEGER_RANGE(desc,v,str,min,max) {(v)=strtoul ((str), NULL, 10);} \ - CPP_WARN("VTY_GET_INTEGER_RANGE is no longer useful, use strtoul() or DEFPY.") -#define VTY_GET_ULONG(desc,v,str) {(v)=strtoul ((str), NULL, 10);} \ +#define VTY_GET_INTEGER_RANGE(desc, v, str, min, max) \ + { \ + (v) = strtoul((str), NULL, 10); \ + } \ + CPP_WARN( \ + "VTY_GET_INTEGER_RANGE is no longer useful, use strtoul() or DEFPY.") +#define VTY_GET_ULONG(desc, v, str) \ + { \ + (v) = strtoul((str), NULL, 10); \ + } \ CPP_WARN("VTY_GET_ULONG is no longer useful, use strtoul() or DEFPY.") -#define VTY_GET_ULL(desc,v,str) {(v)=strtoull ((str), NULL, 10);} \ +#define VTY_GET_ULL(desc, v, str) \ + { \ + (v) = strtoull((str), NULL, 10); \ + } \ CPP_WARN("VTY_GET_ULL is no longer useful, use strtoull() or DEFPY.") -#define VTY_GET_IPV4_ADDRESS(desc,v,str) inet_aton ((str), &(v)) \ - CPP_WARN("VTY_GET_IPV4_ADDRESS is no longer useful, use inet_aton() or DEFPY.") -#define VTY_GET_IPV4_PREFIX(desc,v,str) str2prefix_ipv4 ((str), &(v)) \ - CPP_WARN("VTY_GET_IPV4_PREFIX is no longer useful, use str2prefix_ipv4() or DEFPY.") -#define vty_outln(vty, str, ...) \ - vty_out(vty, str "\n", ## __VA_ARGS__) \ - CPP_WARN("vty_outln is no longer useful, use vty_out(...\\n...)") +#define VTY_GET_IPV4_ADDRESS(desc, v, str) \ + inet_aton((str), &(v)) CPP_WARN( \ + "VTY_GET_IPV4_ADDRESS is no longer useful, use inet_aton() or DEFPY.") +#define VTY_GET_IPV4_PREFIX(desc, v, str) \ + str2prefix_ipv4((str), &(v)) CPP_WARN( \ + "VTY_GET_IPV4_PREFIX is no longer useful, use str2prefix_ipv4() or DEFPY.") +#define vty_outln(vty, str, ...) \ + vty_out(vty, str "\n", ##__VA_ARGS__) CPP_WARN( \ + "vty_outln is no longer useful, use vty_out(...\\n...)") /* Default time out value */ #define VTY_TIMEOUT_DEFAULT 600 @@ -236,29 +247,29 @@ struct vty_arg extern char integrate_default[]; /* Prototypes. */ -extern void vty_init (struct thread_master *); -extern void vty_init_vtysh (void); -extern void vty_terminate (void); -extern void vty_reset (void); -extern struct vty *vty_new (void); -extern struct vty *vty_stdio (void (*atclose)(void)); -extern int vty_out (struct vty *, const char *, ...) PRINTF_ATTRIBUTE(2, 3); -extern void vty_read_config (const char *, char *); -extern void vty_time_print (struct vty *, int); -extern void vty_serv_sock (const char *, unsigned short, const char *); -extern void vty_close (struct vty *); -extern char *vty_get_cwd (void); -extern void vty_log (const char *level, const char *proto, - const char *fmt, struct timestamp_control *, va_list); -extern int vty_config_lock (struct vty *); -extern int vty_config_unlock (struct vty *); -extern void vty_config_lockless (void); -extern int vty_shell (struct vty *); -extern int vty_shell_serv (struct vty *); -extern void vty_hello (struct vty *); +extern void vty_init(struct thread_master *); +extern void vty_init_vtysh(void); +extern void vty_terminate(void); +extern void vty_reset(void); +extern struct vty *vty_new(void); +extern struct vty *vty_stdio(void (*atclose)(void)); +extern int vty_out(struct vty *, const char *, ...) PRINTF_ATTRIBUTE(2, 3); +extern void vty_read_config(const char *, char *); +extern void vty_time_print(struct vty *, int); +extern void vty_serv_sock(const char *, unsigned short, const char *); +extern void vty_close(struct vty *); +extern char *vty_get_cwd(void); +extern void vty_log(const char *level, const char *proto, const char *fmt, + struct timestamp_control *, va_list); +extern int vty_config_lock(struct vty *); +extern int vty_config_unlock(struct vty *); +extern void vty_config_lockless(void); +extern int vty_shell(struct vty *); +extern int vty_shell_serv(struct vty *); +extern void vty_hello(struct vty *); /* Send a fixed-size message to all vty terminal monitors; this should be an async-signal-safe function. */ -extern void vty_log_fixed (char *buf, size_t len); +extern void vty_log_fixed(char *buf, size_t len); #endif /* _ZEBRA_VTY_H */ |