FD.io VPP  v20.01-48-g3e0dafb74
Vector Packet Processing
unix.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2015 Cisco and/or its affiliates.
3  * Licensed under the Apache License, Version 2.0 (the "License");
4  * you may not use this file except in compliance with the License.
5  * You may obtain a copy of the License at:
6  *
7  * http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an "AS IS" BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  * See the License for the specific language governing permissions and
13  * limitations under the License.
14  */
15 /*
16  * unix.h: Unix specific main state
17  *
18  * Copyright (c) 2008 Eliot Dresselhaus
19  *
20  * Permission is hereby granted, free of charge, to any person obtaining
21  * a copy of this software and associated documentation files (the
22  * "Software"), to deal in the Software without restriction, including
23  * without limitation the rights to use, copy, modify, merge, publish,
24  * distribute, sublicense, and/or sell copies of the Software, and to
25  * permit persons to whom the Software is furnished to do so, subject to
26  * the following conditions:
27  *
28  * The above copyright notice and this permission notice shall be
29  * included in all copies or substantial portions of the Software.
30  *
31  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
32  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
33  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
34  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
35  * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
36  * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
37  * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
38  */
39 
40 #ifndef included_unix_unix_h
41 #define included_unix_unix_h
42 
43 #include <vppinfra/file.h>
44 #include <vppinfra/socket.h>
45 #include <termios.h>
46 
47 typedef struct
48 {
52 
53 typedef struct
54 {
55  /* Back pointer to main structure. */
57 
59  /* Run interactively or as daemon (background process). */
60 #define UNIX_FLAG_INTERACTIVE (1 << 0)
61 #define UNIX_FLAG_NODAEMON (1 << 1)
62 
63  /* CLI listen socket. */
65 
66  /* Circular buffer of last unix errors. */
67  unix_error_history_t error_history[128];
70 
71  /* startup-config filename */
73 
74  /* runtime directory path */
76 
77  /* pidfile filename */
79 
80  /* unix config complete */
81  volatile int unix_config_complete;
82 
83  /* CLI log file. GIGO. */
85  int log_fd;
86 
87  /* Don't put CLI connections into character mode */
89 
90  /* Maximum amount of command line history to keep per session */
92 
93  /* Suppress the welcome banner at CLI session start */
95 
96  /* Maximum pager buffer size */
98 
99  /* Suppress the pager */
101 
102  /* Store the original state of stdin when it's a tty */
103  struct termios tio_stdin;
105 
107 
108 } unix_main_t;
109 
110 /* Global main structure. */
111 extern unix_main_t unix_main;
113 
114 always_inline void
116 {
119  eh->error = error;
120  eh->time = vlib_time_now (um->vlib_main);
121  um->n_total_errors += 1;
122  if (++um->error_history_index >= ARRAY_LEN (um->error_history))
123  um->error_history_index = 0;
124 }
125 
126 /* Main function for Unix VLIB. */
127 int vlib_unix_main (int argc, char *argv[]);
128 
129 /* Set prompt for CLI. */
130 void vlib_unix_cli_set_prompt (char *prompt);
131 
132 static inline unix_main_t *
134 {
135  return &unix_main;
136 }
137 
138 static inline char *
140 {
141  return (char *) unix_main.runtime_dir;
142 }
143 
144 /* thread stack array; vec_len = max number of threads */
145 extern u8 **vlib_thread_stacks;
146 
147 /* utils */
148 
149 clib_error_t *foreach_directory_file (char *dir_name,
150  clib_error_t * (*f) (void *arg,
151  u8 * path_name,
152  u8 * file_name),
153  void *arg, int scan_dirs);
154 
156 
158  const char *path,
159  u8 ** full_path);
160 
161 #endif /* included_unix_unix_h */
162 
163 /*
164  * fd.io coding-style-patch-verification: ON
165  *
166  * Local Variables:
167  * eval: (c-set-style "gnu")
168  * End:
169  */
u32 error_history_index
Definition: unix.h:68
unix_main_t unix_main
Definition: main.c:62
int vlib_unix_main(int argc, char *argv[])
Definition: main.c:674
u8 ** vlib_thread_stacks
Definition: main.c:640
u32 flags
Definition: unix.h:58
volatile int unix_config_complete
Definition: unix.h:81
unsigned long u64
Definition: types.h:89
u32 poll_sleep_usec
Definition: unix.h:106
u32 cli_pager_buffer_limit
Definition: unix.h:97
static f64 vlib_time_now(vlib_main_t *vm)
Definition: main.h:279
clib_file_main_t file_main
Definition: main.c:63
vl_api_fib_path_t path
Definition: mfib_types.api:34
clib_socket_t cli_listen_socket
Definition: unix.h:64
unsigned char u8
Definition: types.h:56
int log_fd
Definition: unix.h:85
double f64
Definition: types.h:142
u8 * pidfile
Definition: unix.h:78
static char * vlib_unix_get_runtime_dir(void)
Definition: unix.h:139
static unix_main_t * vlib_unix_get_main(void)
Definition: unix.h:133
unsigned int u32
Definition: types.h:88
vlib_main_t * vlib_main
Definition: unix.h:56
void * clib_error_free_vector(clib_error_t *errors)
Definition: error.c:182
int cli_line_mode
Definition: unix.h:88
int cli_no_banner
Definition: unix.h:94
u8 * startup_config_filename
Definition: unix.h:72
#define always_inline
Definition: ipsec.h:28
u32 cli_history_limit
Definition: unix.h:91
unix_error_history_t error_history[128]
Definition: unix.h:67
int cli_no_pager
Definition: unix.h:100
#define ARRAY_LEN(x)
Definition: clib.h:62
int tio_isset
Definition: unix.h:104
struct _socket_t clib_socket_t
clib_error_t * vlib_unix_recursive_mkdir(char *path)
Definition: util.c:103
clib_error_t * error
Definition: unix.h:50
clib_error_t * foreach_directory_file(char *dir_name, clib_error_t *(*f)(void *arg, u8 *path_name, u8 *file_name), void *arg, int scan_dirs)
Definition: util.c:49
clib_error_t * vlib_unix_validate_runtime_file(unix_main_t *um, const char *path, u8 **full_path)
Definition: util.c:138
static void unix_save_error(unix_main_t *um, clib_error_t *error)
Definition: unix.h:115
u8 * runtime_dir
Definition: unix.h:75
void vlib_unix_cli_set_prompt(char *prompt)
Set the CLI prompt.
Definition: cli.c:3226
u8 * log_filename
Definition: unix.h:84
u64 n_total_errors
Definition: unix.h:69