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