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