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