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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
16 * unix.h: Unix specific main state
18 * Copyright (c) 2008 Eliot Dresselhaus
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:
28 * The above copyright notice and this permission notice shall be
29 * included in all copies or substantial portions of the Software.
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.
40 #ifndef included_unix_unix_h
41 #define included_unix_unix_h
43 #include <vppinfra/socket.h>
48 typedef clib_error_t *(unix_file_function_t) (struct unix_file * f);
50 typedef struct unix_file
52 /* Unix file descriptor from open/socket. */
56 #define UNIX_FILE_DATA_AVAILABLE_TO_WRITE (1 << 0)
57 #define UNIX_FILE_EVENT_EDGE_TRIGGERED (1 << 1)
59 /* Data available for function's use. */
62 /* Functions to be called when read/write data becomes ready. */
63 unix_file_function_t *read_function, *write_function, *error_function;
70 } unix_error_history_t;
75 UNIX_FILE_UPDATE_MODIFY,
76 UNIX_FILE_UPDATE_DELETE,
77 } unix_file_update_type_t;
81 /* Back pointer to main structure. */
82 vlib_main_t *vlib_main;
85 /* Run interactively or as daemon (background process). */
86 #define UNIX_FLAG_INTERACTIVE (1 << 0)
87 #define UNIX_FLAG_NODAEMON (1 << 1)
89 /* Pool of files to poll for input/output. */
90 unix_file_t *file_pool;
92 /* CLI listen socket. */
93 clib_socket_t cli_listen_socket;
95 void (*file_update) (unix_file_t * file,
96 unix_file_update_type_t update_type);
98 /* Circular buffer of last unix errors. */
99 unix_error_history_t error_history[128];
100 u32 error_history_index;
103 /* startup-config filename */
104 u8 *startup_config_filename;
106 /* runtime directory path */
109 /* pidfile filename */
112 /* unix config complete */
113 volatile int unix_config_complete;
115 /* CLI log file. GIGO. */
119 /* Don't put CLI connections into character mode */
122 /* Maximum amount of command line history to keep per session */
123 u32 cli_history_limit;
125 /* Suppress the welcome banner at CLI session start */
128 /* Maximum pager buffer size */
129 u32 cli_pager_buffer_limit;
131 /* Suppress the pager */
134 /* Store the original state of stdin when it's a tty */
135 struct termios tio_stdin;
139 /* Global main structure. */
140 extern unix_main_t unix_main;
143 unix_file_add (unix_main_t * um, unix_file_t * template)
146 pool_get (um->file_pool, f);
148 um->file_update (f, UNIX_FILE_UPDATE_ADD);
149 return f - um->file_pool;
153 unix_file_del (unix_main_t * um, unix_file_t * f)
155 um->file_update (f, UNIX_FILE_UPDATE_DELETE);
156 close (f->file_descriptor);
157 f->file_descriptor = ~0;
158 pool_put (um->file_pool, f);
162 unix_file_del_by_index (unix_main_t * um, uword index)
165 uf = pool_elt_at_index (um->file_pool, index);
166 unix_file_del (um, uf);
170 unix_file_set_data_available_to_write (u32 unix_file_index,
173 unix_file_t *uf = pool_elt_at_index (unix_main.file_pool, unix_file_index);
174 uword was_available = (uf->flags & UNIX_FILE_DATA_AVAILABLE_TO_WRITE);
175 if ((was_available != 0) != (is_available != 0))
177 uf->flags ^= UNIX_FILE_DATA_AVAILABLE_TO_WRITE;
178 unix_main.file_update (uf, UNIX_FILE_UPDATE_MODIFY);
180 return was_available != 0;
184 unix_save_error (unix_main_t * um, clib_error_t * error)
186 unix_error_history_t *eh = um->error_history + um->error_history_index;
187 clib_error_free_vector (eh->error);
189 eh->time = vlib_time_now (um->vlib_main);
190 um->n_total_errors += 1;
191 if (++um->error_history_index >= ARRAY_LEN (um->error_history))
192 um->error_history_index = 0;
195 /* Main function for Unix VLIB. */
196 int vlib_unix_main (int argc, char *argv[]);
198 /* Call to allocate/initialize physical DMA memory subsystem.
199 This is not an init function so that users can explicitly enable/disable
200 physmem when its not needed. */
201 clib_error_t *unix_physmem_init (vlib_main_t * vm,
202 int fail_if_physical_memory_not_present);
205 unix_physmem_is_fake (vlib_main_t * vm)
207 vlib_physmem_main_t *vpm = &vm->physmem_main;
211 /* Set prompt for CLI. */
212 void vlib_unix_cli_set_prompt (char *prompt);
214 static inline unix_main_t *
215 vlib_unix_get_main (void)
221 vlib_unix_get_runtime_dir (void)
223 return (char *) unix_main.runtime_dir;
226 /* thread stack array; vec_len = max number of threads */
227 extern u8 **vlib_thread_stacks;
231 clib_error_t *vlib_sysfs_write (char *file_name, char *fmt, ...);
233 clib_error_t *vlib_sysfs_read (char *file_name, char *fmt, ...);
235 u8 *vlib_sysfs_link_to_name (char *link);
237 int vlib_sysfs_get_free_hugepages (unsigned int numa_node, int page_size);
239 clib_error_t *foreach_directory_file (char *dir_name,
240 clib_error_t * (*f) (void *arg,
243 void *arg, int scan_dirs);
245 clib_error_t *vlib_unix_recursive_mkdir (char *path);
247 clib_error_t *vlib_unix_validate_runtime_file (unix_main_t * um,
251 #endif /* included_unix_unix_h */
254 * fd.io coding-style-patch-verification: ON
257 * eval: (c-set-style "gnu")