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