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