src/vlib/unix/unix.h

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