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