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