src/vlibapi/api_common.h

   1 /*
   2  *------------------------------------------------------------------
   3  * api_common.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_common_h
  21 #define included_api_common_h
  22
  23 /** \file API common definitions
  24  * See api_doc.md for more info
  25  */
  26
  27 #include <vppinfra/clib_error.h>
  28 #include <svm/svm_common.h>
  29 #include <vlibmemory/unix_shared_memory_queue.h>
  30
  31 /** API registration types
  32  */
  33 typedef enum
  34 {
  35   REGISTRATION_TYPE_FREE = 0,
  36   REGISTRATION_TYPE_SHMEM,      /**< Shared memory connection */
  37   REGISTRATION_TYPE_SOCKET_LISTEN, /**< Socket listener  */
  38   REGISTRATION_TYPE_SOCKET_SERVER, /**< Socket server */
  39   REGISTRATION_TYPE_SOCKET_CLIENT, /**< Socket client */
  40 } vl_registration_type_t;
  41
  42 /** An API client registration, only in vpp/vlib */
  43
  44 typedef struct vl_api_registration_
  45 {
  46   vl_registration_type_t registration_type; /**< type */
  47
  48   /** Index in VLIB's brain (not shared memory). */
  49   u32 vl_api_registration_pool_index;
  50
  51   u8 *name;                     /**< Client name */
  52
  53   /** shared memory only: pointer to client input queue */
  54   unix_shared_memory_queue_t *vl_input_queue;
  55
  56   /* socket server and client */
  57   u32 clib_file_index;          /**< Socket only: file index */
  58   i8 *unprocessed_input;        /**< Socket only: pending input */
  59   u32 unprocessed_msg_length;   /**< Socket only: unprocssed length */
  60   u8 *output_vector;            /**< Socket only: output vecto  */
  61
  62   /* socket client only */
  63   u32 server_handle;            /**< Socket client only: server handle */
  64   u32 server_index;             /**< Socket client only: server index */
  65 } vl_api_registration_t;
  66
  67
  68 /** Trace configuration for a single message */
  69 typedef struct
  70 {
  71   int size;                     /**< for sanity checking */
  72   int trace_enable;             /**< trace this message  */
  73   int replay_enable;            /**< This message can be replayed  */
  74 } trace_cfg_t;
  75
  76 /**
  77  * API trace state
  78  */
  79 typedef struct
  80 {
  81   u8 endian;                    /**< trace endianness */
  82   u8 enabled;                   /**< trace is enabled  */
  83   u8 wrapped;                   /**< trace has wrapped */
  84   u8 pad;
  85   u32 nitems;                   /**< Number of trace records */
  86   u32 curindex;                 /**< Current index in circular buffer  */
  87   u8 **traces;                  /**< Trace ring */
  88 } vl_api_trace_t;
  89
  90 /** Trace RX / TX enum */
  91 typedef enum
  92 {
  93   VL_API_TRACE_TX,
  94   VL_API_TRACE_RX,
  95 } vl_api_trace_which_t;
  96
  97 #define VL_API_LITTLE_ENDIAN 0x00
  98 #define VL_API_BIG_ENDIAN 0x01
  99
 100 /** Message range (belonging to a plugin) */
 101 typedef struct
 102 {
 103   u8 *name;                     /**< name of the plugin  */
 104   u16 first_msg_id;             /**< first assigned message ID */
 105   u16 last_msg_id;              /**< last assigned message ID */
 106 } vl_api_msg_range_t;
 107
 108 /** Message configuration definition */
 109 typedef struct
 110 {
 111   int id;                       /**< the message ID */
 112   char *name;                   /**< the message name */
 113   u32 crc;                      /**< message definition CRC  */
 114   void *handler;                /**< the message handler  */
 115   void *cleanup;                /**< non-default message cleanup handler */
 116   void *endian;                 /**< message endian function  */
 117   void *print;                  /**< message print function  */
 118   int size;                     /**< message size  */
 119   int traced;                   /**< is this message to be traced?  */
 120   int replay;                   /**< is this message to be replayed?  */
 121   int message_bounce;           /**< do not free message after processing */
 122   int is_mp_safe;               /**< worker thread barrier required?  */
 123 } vl_msg_api_msg_config_t;
 124
 125 /** Message header structure */
 126 typedef struct msgbuf_
 127 {
 128   unix_shared_memory_queue_t *q; /**< message allocated in this shmem ring  */
 129   u32 data_len;                  /**< message length not including header  */
 130   u32 gc_mark_timestamp;         /**< message garbage collector mark TS  */
 131   u8 data[0];                    /**< actual message begins here  */
 132 } msgbuf_t;
 133
 134 /* api_shared.c prototypes */
 135 void vl_msg_api_handler (void *the_msg);
 136 void vl_msg_api_handler_no_free (void *the_msg);
 137 void vl_msg_api_handler_no_trace_no_free (void *the_msg);
 138 void vl_msg_api_trace_only (void *the_msg);
 139 void vl_msg_api_cleanup_handler (void *the_msg);
 140 void vl_msg_api_replay_handler (void *the_msg);
 141 void vl_msg_api_socket_handler (void *the_msg);
 142 void vl_msg_api_set_handlers (int msg_id, char *msg_name,
 143                               void *handler,
 144                               void *cleanup,
 145                               void *endian,
 146                               void *print, int msg_size, int traced);
 147 void vl_msg_api_config (vl_msg_api_msg_config_t *);
 148 void vl_msg_api_set_cleanup_handler (int msg_id, void *fp);
 149 void vl_msg_api_queue_handler (unix_shared_memory_queue_t * q);
 150
 151 void vl_msg_api_barrier_sync (void) __attribute__ ((weak));
 152 void vl_msg_api_barrier_release (void) __attribute__ ((weak));
 153 #ifdef BARRIER_TRACING
 154 void vl_msg_api_barrier_trace_context (const char *context)
 155   __attribute__ ((weak));
 156 #else
 157 #define vl_msg_api_barrier_trace_context(X)
 158 #endif
 159 void vl_msg_api_free (void *);
 160 void vl_noop_handler (void *mp);
 161 void vl_msg_api_increment_missing_client_counter (void);
 162 void vl_msg_api_post_mortem_dump (void);
 163 void vl_msg_api_post_mortem_dump_enable_disable (int enable);
 164 void vl_msg_api_register_pd_handler (void *handler,
 165                                      u16 msg_id_host_byte_order);
 166 int vl_msg_api_pd_handler (void *mp, int rv);
 167
 168 void vl_msg_api_set_first_available_msg_id (u16 first_avail);
 169 u16 vl_msg_api_get_msg_ids (const char *name, int n);
 170 u32 vl_api_get_msg_index (u8 * name_and_crc);
 171
 172 typedef clib_error_t *(vl_msg_api_init_function_t) (u32 client_index);
 173
 174 typedef struct _vl_msg_api_init_function_list_elt
 175 {
 176   struct _vl_msg_api_init_function_list_elt *next_init_function;
 177   vl_msg_api_init_function_t *f;
 178 } _vl_msg_api_function_list_elt_t;
 179
 180 /** API main structure, used by both vpp and binary API clients */
 181 typedef struct
 182 {
 183   /** Message handler vector  */
 184   void (**msg_handlers) (void *);
 185   /** Plaform-dependent (aka hardware) message handler vector */
 186   int (**pd_msg_handlers) (void *, int);
 187
 188   /** non-default message cleanup handler vector */
 189   void (**msg_cleanup_handlers) (void *);
 190
 191   /** Message endian handler vector */
 192   void (**msg_endian_handlers) (void *);
 193
 194   /** Message print function vector */
 195   void (**msg_print_handlers) (void *, void *);
 196
 197   /** Message name vector */
 198   const char **msg_names;
 199
 200   /** Don't automatically free message buffer vetor */
 201   u8 *message_bounce;
 202
 203   /** Message is mp safe vector */
 204   u8 *is_mp_safe;
 205
 206   /** Allocator ring vectors (in shared memory) */
 207   struct ring_alloc_ *arings;
 208
 209   /** Number of times that the ring allocator failed */
 210   u32 ring_misses;
 211
 212   /** Number of garbage-collected message buffers */
 213   u32 garbage_collects;
 214
 215   /** Number of missing clients / failed message sends */
 216   u32 missing_clients;
 217
 218   /** Received message trace configuration */
 219   vl_api_trace_t *rx_trace;
 220
 221   /** Sent message trace configuration */
 222   vl_api_trace_t *tx_trace;
 223
 224   /** Print every received message */
 225   int msg_print_flag;
 226
 227   /** Current trace configuration */
 228   trace_cfg_t *api_trace_cfg;
 229
 230   /** Current process PID */
 231   int our_pid;
 232
 233   /** Binary api segment descriptor */
 234   svm_region_t *vlib_rp;
 235
 236   /** Vector of all mapped shared-VM segments */
 237   svm_region_t **mapped_shmem_regions;
 238
 239   /** Binary API shared-memory segment header pointer */
 240   struct vl_shmem_hdr_ *shmem_hdr;
 241
 242   /** vlib/vpp only: vector of client registrations */
 243   vl_api_registration_t **vl_clients;
 244
 245   /** vlib/vpp only: serialized (message, name, crc) table */
 246   u8 *serialized_message_table_in_shmem;
 247
 248   /** First available message ID, for theplugin msg allocator */
 249   u16 first_available_msg_id;
 250
 251   /** Message range by name hash */
 252   uword *msg_range_by_name;
 253
 254   /** vector of message ranges */
 255   vl_api_msg_range_t *msg_ranges;
 256
 257   /** uid for the api shared memory region */
 258   int api_uid;
 259
 260   /** gid for the api shared memory region */
 261   int api_gid;
 262
 263   /** base virtual address for global VM region */
 264   u64 global_baseva;
 265
 266   /** size of the global VM region */
 267   u64 global_size;
 268
 269   /** size of the API region */
 270   u64 api_size;
 271
 272   /** size of the global VM private mheap */
 273   u64 global_pvt_heap_size;
 274
 275   /** size of the api private mheap */
 276   u64 api_pvt_heap_size;
 277
 278   /** Peer input queue pointer */
 279   unix_shared_memory_queue_t *vl_input_queue;
 280
 281   /**
 282    * All VLIB-side message handlers use my_client_index to identify
 283    * the queue / client. This works in sim replay.
 284    */
 285   int my_client_index;
 286   /**
 287    * This is the (shared VM) address of the registration,
 288    * don't use it to id the connection since it can't possibly
 289    * work in simulator replay.
 290    */
 291   vl_api_registration_t *my_registration;
 292
 293   /** (Historical) signal-based queue non-empty signal, to be removed */
 294   i32 vlib_signal;
 295
 296   /** vpp/vlib input queue length */
 297   u32 vlib_input_queue_length;
 298
 299   /** client message index hash table */
 300   uword *msg_index_by_name_and_crc;
 301
 302   /** Shared VM binary API region name */
 303   const char *region_name;
 304
 305   /** Chroot path to the shared memory API files */
 306   const char *root_path;
 307
 308   /** Replay in progress? */
 309   int replay_in_progress;
 310
 311   /** Dump (msg-name, crc) snapshot here at startup */
 312   u8 *save_msg_table_filename;
 313
 314   /** List of API client reaper functions */
 315   _vl_msg_api_function_list_elt_t *reaper_function_registrations;
 316
 317 } api_main_t;
 318
 319 extern api_main_t api_main;
 320
 321 #endif /* included_api_common_h */
 322
 323 /*
 324  * fd.io coding-style-patch-verification: ON
 325  *
 326  * Local Variables:
 327  * eval: (c-set-style "gnu")
 328  * End:
 329  */