FD.io VPP  v17.07-30-g839fa73
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/socket.h>
44 #include <termios.h>
45 
46 struct unix_file;
48 
49 typedef struct unix_file
50 {
51  /* Unix file descriptor from open/socket. */
53 
55 #define UNIX_FILE_DATA_AVAILABLE_TO_WRITE (1 << 0)
56 #define UNIX_FILE_EVENT_EDGE_TRIGGERED (1 << 1)
57 
58  /* Data available for function's use. */
60 
61  /* Functions to be called when read/write data becomes ready. */
63 } unix_file_t;
64 
65 typedef struct
66 {
70 
71 typedef enum
72 {
77 
78 typedef struct
79 {
80  /* Back pointer to main structure. */
82 
84  /* Run interactively or as daemon (background process). */
85 #define UNIX_FLAG_INTERACTIVE (1 << 0)
86 #define UNIX_FLAG_NODAEMON (1 << 1)
87 
88  /* Pool of files to poll for input/output. */
90 
91  /* CLI listen socket. */
93 
94  void (*file_update) (unix_file_t * file,
95  unix_file_update_type_t update_type);
96 
97  /* Circular buffer of last unix errors. */
98  unix_error_history_t error_history[128];
101 
102  /* startup-config filename */
104 
105  /* unix config complete */
106  volatile int unix_config_complete;
107 
108  /* CLI log file. GIGO. */
110  int log_fd;
111 
112  /* Don't put CLI connections into character mode */
114 
115  /* Maximum amount of command line history to keep per session */
117 
118  /* Suppress the welcome banner at CLI session start */
120 
121  /* Maximum pager buffer size */
123 
124  /* Suppress the pager */
126 
127  /* Store the original state of stdin when it's a tty */
128  struct termios tio_stdin;
130 } unix_main_t;
131 
132 /* Global main structure. */
133 extern unix_main_t unix_main;
134 
137 {
138  unix_file_t *f;
139  pool_get (um->file_pool, f);
140  f[0] = template[0];
142  return f - um->file_pool;
143 }
144 
145 always_inline void
147 {
149  close (f->file_descriptor);
150  f->file_descriptor = ~0;
151  pool_put (um->file_pool, f);
152 }
153 
154 always_inline void
156 {
157  unix_file_t *uf;
158  uf = pool_elt_at_index (um->file_pool, index);
159  unix_file_del (um, uf);
160 }
161 
164  uword is_available)
165 {
166  unix_file_t *uf = pool_elt_at_index (unix_main.file_pool, unix_file_index);
167  uword was_available = (uf->flags & UNIX_FILE_DATA_AVAILABLE_TO_WRITE);
168  if ((was_available != 0) != (is_available != 0))
169  {
171  unix_main.file_update (uf, UNIX_FILE_UPDATE_MODIFY);
172  }
173  return was_available != 0;
174 }
175 
176 always_inline void
178 {
181  eh->error = error;
182  eh->time = vlib_time_now (um->vlib_main);
183  um->n_total_errors += 1;
184  if (++um->error_history_index >= ARRAY_LEN (um->error_history))
185  um->error_history_index = 0;
186 }
187 
188 /* Main function for Unix VLIB. */
189 int vlib_unix_main (int argc, char *argv[]);
190 
191 /* Call to allocate/initialize physical DMA memory subsystem.
192  This is not an init function so that users can explicitly enable/disable
193  physmem when its not needed. */
195  int fail_if_physical_memory_not_present);
196 
197 static inline int
199 {
200  vlib_physmem_main_t *vpm = &vm->physmem_main;
201  return vpm->is_fake;
202 }
203 
204 /* Set prompt for CLI. */
205 void vlib_unix_cli_set_prompt (char *prompt);
206 
207 static inline unix_main_t *
209 {
210  return &unix_main;
211 }
212 
213 /* thread stack array; vec_len = max number of threads */
214 extern u8 **vlib_thread_stacks;
215 
216 /* utils */
217 
218 clib_error_t *vlib_sysfs_write (char *file_name, char *fmt, ...);
219 
220 clib_error_t *vlib_sysfs_read (char *file_name, char *fmt, ...);
221 
222 u8 *vlib_sysfs_link_to_name (char *link);
223 
224 int vlib_sysfs_get_free_hugepages (unsigned int numa_node, int page_size);
225 
226 clib_error_t *foreach_directory_file (char *dir_name,
227  clib_error_t * (*f) (void *arg,
228  u8 * path_name,
229  u8 * file_name),
230  void *arg, int scan_dirs);
231 
232 #endif /* included_unix_unix_h */
233 
234 /*
235  * fd.io coding-style-patch-verification: ON
236  *
237  * Local Variables:
238  * eval: (c-set-style "gnu")
239  * End:
240  */
unix_file_t * file_pool
Definition: unix.h:89
u32 error_history_index
Definition: unix.h:99
unix_main_t unix_main
Definition: main.c:60
int vlib_unix_main(int argc, char *argv[])
Definition: main.c:538
u32 flags
Definition: unix.h:54
unix_file_function_t * read_function
Definition: unix.h:62
u8 ** vlib_thread_stacks
Definition: main.c:504
u32 flags
Definition: unix.h:83
vlib_physmem_main_t physmem_main
Definition: main.h:106
volatile int unix_config_complete
Definition: unix.h:106
u32 cli_pager_buffer_limit
Definition: unix.h:122
int vlib_sysfs_get_free_hugepages(unsigned int numa_node, int page_size)
Definition: util.c:193
static f64 vlib_time_now(vlib_main_t *vm)
Definition: main.h:192
clib_socket_t cli_listen_socket
Definition: unix.h:92
u8 * vlib_sysfs_link_to_name(char *link)
Definition: util.c:166
#define pool_get(P, E)
Allocate an object E from a pool P (unspecified alignment).
Definition: pool.h:200
int log_fd
Definition: unix.h:110
static int unix_physmem_is_fake(vlib_main_t *vm)
Definition: unix.h:198
struct _socket_t clib_socket_t
#define always_inline
Definition: clib.h:84
static unix_main_t * vlib_unix_get_main(void)
Definition: unix.h:208
unsigned long u64
Definition: types.h:89
vlib_main_t * vlib_main
Definition: unix.h:81
static uword unix_file_set_data_available_to_write(u32 unix_file_index, uword is_available)
Definition: unix.h:163
void * clib_error_free_vector(clib_error_t *errors)
Definition: error.c:182
static uword unix_file_add(unix_main_t *um, unix_file_t *template)
Definition: unix.h:136
#define pool_elt_at_index(p, i)
Returns pointer to element at given index.
Definition: pool.h:397
int cli_line_mode
Definition: unix.h:113
static void unix_file_del_by_index(unix_main_t *um, uword index)
Definition: unix.h:155
u32 file_descriptor
Definition: unix.h:52
uword private_data
Definition: unix.h:59
clib_error_t * vlib_sysfs_read(char *file_name, char *fmt,...)
Definition: util.c:126
unix_file_function_t * error_function
Definition: unix.h:62
int cli_no_banner
Definition: unix.h:119
#define pool_put(P, E)
Free an object E in pool P.
Definition: pool.h:241
u8 * startup_config_filename
Definition: unix.h:103
u32 cli_history_limit
Definition: unix.h:116
unix_error_history_t error_history[128]
Definition: unix.h:98
int cli_no_pager
Definition: unix.h:125
#define ARRAY_LEN(x)
Definition: clib.h:59
#define UNIX_FILE_DATA_AVAILABLE_TO_WRITE
Definition: unix.h:55
int tio_isset
Definition: unix.h:129
unsigned int u32
Definition: types.h:88
unix_file_update_type_t
Definition: unix.h:71
clib_error_t * unix_physmem_init(vlib_main_t *vm, int fail_if_physical_memory_not_present)
Definition: physmem.c:209
u64 uword
Definition: types.h:112
void(* file_update)(unix_file_t *file, unix_file_update_type_t update_type)
Definition: unix.h:94
unix_file_function_t * write_function
Definition: unix.h:62
clib_error_t * error
Definition: unix.h:68
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
double f64
Definition: types.h:142
unsigned char u8
Definition: types.h:56
Definition: unix.h:49
clib_error_t * vlib_sysfs_write(char *file_name, char *fmt,...)
Definition: util.c:102
static void unix_save_error(unix_main_t *um, clib_error_t *error)
Definition: unix.h:177
void vlib_unix_cli_set_prompt(char *prompt)
Set the CLI prompt.
Definition: cli.c:2693
struct unix_file unix_file_t
u8 * log_filename
Definition: unix.h:109
clib_error_t *( unix_file_function_t)(struct unix_file *f)
Definition: unix.h:47
u64 n_total_errors
Definition: unix.h:100
static void unix_file_del(unix_main_t *um, unix_file_t *f)
Definition: unix.h:146