src/vlibapi/api.h

   1 /*
   2  *------------------------------------------------------------------
   3  * api.h
   4  *
   5  * Copyright (c) 2009-2015 Cisco and/or its affiliates.
   6  * Licensed under the Apache License, Version 2.0 (the "License");
   7  * you may not use this file except in compliance with the License.
   8  * You may obtain a copy of the License at:
   9  *
  10  *     http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  * Unless required by applicable law or agreed to in writing, software
  13  * distributed under the License is distributed on an "AS IS" BASIS,
  14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  * See the License for the specific language governing permissions and
  16  * limitations under the License.
  17  *------------------------------------------------------------------
  18  */
  19
  20 #ifndef included_api_h
  21 #define included_api_h
  22
  23 #include <vppinfra/error.h>
  24 #include <svm/svm.h>
  25 #include <vlib/vlib.h>
  26 #include <vlibmemory/unix_shared_memory_queue.h>
  27 #include <vlib/unix/unix.h>
  28
  29 typedef enum
  30 {
  31   REGISTRATION_TYPE_FREE = 0,
  32   REGISTRATION_TYPE_SHMEM,
  33   REGISTRATION_TYPE_SOCKET_LISTEN,
  34   REGISTRATION_TYPE_SOCKET_SERVER,
  35   REGISTRATION_TYPE_SOCKET_CLIENT,
  36 } vl_registration_type_t;
  37
  38 typedef struct vl_api_registration_
  39 {
  40   vl_registration_type_t registration_type;
  41
  42   /* Index in VLIB's brain (not shared memory). */
  43   u32 vl_api_registration_pool_index;
  44
  45   u8 *name;
  46
  47   /*
  48    * The following groups of data could be unioned, but my fingers are
  49    * going to be sore enough.
  50    */
  51
  52   /* shared memory only */
  53   unix_shared_memory_queue_t *vl_input_queue;
  54
  55   /* socket server and client */
  56   u32 unix_file_index;
  57   i8 *unprocessed_input;
  58   u32 unprocessed_msg_length;
  59   u8 *output_vector;
  60
  61   /* socket client only */
  62   u32 server_handle;
  63   u32 server_index;
  64
  65 } vl_api_registration_t;
  66
  67
  68 /* Trace configuration for a single message */
  69 typedef struct
  70 {
  71   int size;
  72   int trace_enable;
  73   int replay_enable;
  74 } trace_cfg_t;
  75
  76 /*
  77  * API recording
  78  */
  79 typedef struct
  80 {
  81   u8 endian;
  82   u8 enabled;
  83   u8 wrapped;
  84   u8 pad;
  85   u32 nitems;
  86   u32 curindex;
  87   u8 **traces;
  88 } vl_api_trace_t;
  89
  90 /* *INDENT-OFF* */
  91 typedef CLIB_PACKED
  92 (struct
  93  {
  94    u8 endian; u8 wrapped;
  95    u32 nitems;
  96 }) vl_api_trace_file_header_t;
  97 /* *INDENT-ON* */
  98
  99 typedef enum
 100 {
 101   VL_API_TRACE_TX,
 102   VL_API_TRACE_RX,
 103 } vl_api_trace_which_t;
 104
 105 #define VL_API_LITTLE_ENDIAN 0x00
 106 #define VL_API_BIG_ENDIAN 0x01
 107
 108 typedef struct
 109 {
 110   u8 *name;
 111   u16 first_msg_id;
 112   u16 last_msg_id;
 113 } vl_api_msg_range_t;
 114
 115 typedef struct
 116 {
 117   void (**msg_handlers) (void *);
 118   int (**pd_msg_handlers) (void *, int);
 119   void (**msg_cleanup_handlers) (void *);
 120   void (**msg_endian_handlers) (void *);
 121   void (**msg_print_handlers) (void *, void *);
 122   char **msg_names;
 123   u8 *message_bounce;
 124   u8 *is_mp_safe;
 125   struct ring_alloc_ *arings;
 126   u32 ring_misses;
 127   u32 garbage_collects;
 128   u32 missing_clients;
 129   vl_api_trace_t *rx_trace;
 130   vl_api_trace_t *tx_trace;
 131   int msg_print_flag;
 132   trace_cfg_t *api_trace_cfg;
 133   int our_pid;
 134   svm_region_t *vlib_rp;
 135   svm_region_t **mapped_shmem_regions;
 136   struct vl_shmem_hdr_ *shmem_hdr;
 137   vl_api_registration_t **vl_clients;
 138
 139   u8 *serialized_message_table_in_shmem;
 140
 141   /* For plugin msg allocator */
 142   u16 first_available_msg_id;
 143
 144   /* message range by name hash */
 145   uword *msg_range_by_name;
 146
 147   /* vector of message ranges */
 148   vl_api_msg_range_t *msg_ranges;
 149
 150   /* uid for the api shared memory region */
 151   int api_uid;
 152   /* gid for the api shared memory region */
 153   int api_gid;
 154
 155   /* base virtual address for global VM region */
 156   u64 global_baseva;
 157
 158   /* size of the global VM region */
 159   u64 global_size;
 160
 161   /* size of the API region */
 162   u64 api_size;
 163
 164   /* size of the global VM private mheap */
 165   u64 global_pvt_heap_size;
 166
 167   /* size of the api private mheap */
 168   u64 api_pvt_heap_size;
 169
 170   /* Client-only data structures */
 171   unix_shared_memory_queue_t *vl_input_queue;
 172
 173   /*
 174    * All VLIB-side message handlers use my_client_index to identify
 175    * the queue / client. This works in sim replay.
 176    */
 177   int my_client_index;
 178   /*
 179    * This is the (shared VM) address of the registration,
 180    * don't use it to id the connection since it can't possibly
 181    * work in simulator replay.
 182    */
 183   vl_api_registration_t *my_registration;
 184
 185   i32 vlib_signal;
 186
 187   /* client side message index hash table */
 188   uword *msg_index_by_name_and_crc;
 189
 190   char *region_name;
 191   char *root_path;
 192
 193   /* Replay in progress? */
 194   int replay_in_progress;
 195 } api_main_t;
 196
 197 extern api_main_t api_main;
 198
 199 typedef struct
 200 {
 201   int id;
 202   char *name;
 203   u32 crc;
 204   void *handler;
 205   void *cleanup;
 206   void *endian;
 207   void *print;
 208   int size;
 209   int traced;
 210   int replay;
 211   int message_bounce;
 212   int is_mp_safe;
 213 } vl_msg_api_msg_config_t;
 214
 215 typedef struct msgbuf_
 216 {
 217   unix_shared_memory_queue_t *q;
 218   u32 data_len;
 219   u32 gc_mark_timestamp;
 220   u8 data[0];
 221 } msgbuf_t;
 222
 223 /* api_shared.c prototypes */
 224 int vl_msg_api_rx_trace_enabled (api_main_t * am);
 225 int vl_msg_api_tx_trace_enabled (api_main_t * am);
 226 void vl_msg_api_trace (api_main_t * am, vl_api_trace_t * tp, void *msg);
 227 int vl_msg_api_trace_onoff (api_main_t * am, vl_api_trace_which_t which,
 228                             int onoff);
 229 int vl_msg_api_trace_free (api_main_t * am, vl_api_trace_which_t which);
 230 int vl_msg_api_trace_save (api_main_t * am,
 231                            vl_api_trace_which_t which, FILE * fp);
 232 int vl_msg_api_trace_configure (api_main_t * am, vl_api_trace_which_t which,
 233                                 u32 nitems);
 234 void vl_msg_api_handler_with_vm_node (api_main_t * am,
 235                                       void *the_msg, vlib_main_t * vm,
 236                                       vlib_node_runtime_t * node);
 237 void vl_msg_api_handler (void *the_msg);
 238 void vl_msg_api_handler_no_free (void *the_msg);
 239 void vl_msg_api_handler_no_trace_no_free (void *the_msg);
 240 void vl_msg_api_trace_only (void *the_msg);
 241 void vl_msg_api_cleanup_handler (void *the_msg);
 242 void vl_msg_api_replay_handler (void *the_msg);
 243 void vl_msg_api_socket_handler (void *the_msg);
 244 void vl_msg_api_set_handlers (int msg_id, char *msg_name,
 245                               void *handler,
 246                               void *cleanup,
 247                               void *endian,
 248                               void *print, int msg_size, int traced);
 249 void vl_msg_api_config (vl_msg_api_msg_config_t *);
 250 void vl_msg_api_set_cleanup_handler (int msg_id, void *fp);
 251 void vl_msg_api_queue_handler (unix_shared_memory_queue_t * q);
 252 vl_api_trace_t *vl_msg_api_trace_get (api_main_t * am,
 253                                       vl_api_trace_which_t which);
 254
 255 void vl_msg_api_free (void *);
 256 void vl_noop_handler (void *mp);
 257 clib_error_t *vl_api_init (vlib_main_t * vm);
 258 void vl_msg_api_increment_missing_client_counter (void);
 259 void vl_msg_api_post_mortem_dump (void);
 260 void vl_msg_api_register_pd_handler (void *handler,
 261                                      u16 msg_id_host_byte_order);
 262 int vl_msg_api_pd_handler (void *mp, int rv);
 263
 264 void vl_msg_api_set_first_available_msg_id (u16 first_avail);
 265 u16 vl_msg_api_get_msg_ids (char *name, int n);
 266 void vl_msg_api_add_msg_name_crc (api_main_t * am, char *string, u32 id);
 267 u32 vl_api_get_msg_index (u8 * name_and_crc);
 268
 269 /* node_serialize.c prototypes */
 270 u8 *vlib_node_serialize (vlib_node_main_t * nm, u8 * vector,
 271                          u32 max_threads, int include_nexts,
 272                          int include_stats);
 273 vlib_node_t **vlib_node_unserialize (u8 * vector);
 274
 275 #define VLIB_API_INIT_FUNCTION(x) VLIB_DECLARE_INIT_FUNCTION(x,api_init)
 276
 277 /* Call given init function: used for init function dependencies. */
 278 #define vlib_call_api_init_function(vm, x)                              \
 279   ({                                                                    \
 280     extern vlib_init_function_t * _VLIB_INIT_FUNCTION_SYMBOL (x,api_init); \
 281     vlib_init_function_t * _f = _VLIB_INIT_FUNCTION_SYMBOL (x,api_init); \
 282     clib_error_t * _error = 0;                                          \
 283     if (! hash_get (vm->init_functions_called, _f))                     \
 284       {                                                                 \
 285         hash_set1 (vm->init_functions_called, _f);                      \
 286         _error = _f (vm);                                               \
 287       }                                                                 \
 288     _error;                                                             \
 289   })
 290
 291
 292 #endif /* included_api_h */
 293
 294 /*
 295  * fd.io coding-style-patch-verification: ON
 296  *
 297  * Local Variables:
 298  * eval: (c-set-style "gnu")
 299  * End:
 300  */