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