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