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 <vppinfra/cJSON.h>
  31 #include <vlibapi/api_types.h>
  32 #include <svm/svm_common.h>
  33 #include <svm/queue.h>
  34
  35 /** API registration types
  36  */
  37 typedef enum
  38 {
  39   REGISTRATION_TYPE_FREE = 0,
  40   REGISTRATION_TYPE_SHMEM,      /**< Shared memory connection */
  41   REGISTRATION_TYPE_SOCKET_LISTEN, /**< Socket listener  */
  42   REGISTRATION_TYPE_SOCKET_SERVER, /**< Socket server */
  43   REGISTRATION_TYPE_SOCKET_CLIENT, /**< Socket client */
  44 } vl_registration_type_t;
  45
  46 /** An API client registration, only in vpp/vlib */
  47
  48 typedef struct vl_api_registration_
  49 {
  50   vl_registration_type_t registration_type; /**< type */
  51
  52   /** Index in VLIB's brain (not shared memory). */
  53   u32 vl_api_registration_pool_index;
  54
  55   u8 *name;                     /**< Client name */
  56
  57   /* Zombie apocalypse checking */
  58   f64 last_heard;
  59   int last_queue_head;
  60   int unanswered_pings;
  61   int is_being_removed;
  62
  63   /** shared memory only: pointer to client input queue */
  64   svm_queue_t *vl_input_queue;
  65   svm_region_t *vlib_rp;
  66   void *shmem_hdr;
  67
  68   /* socket server and client */
  69   u32 clib_file_index;          /**< Socket only: file index */
  70   i8 *unprocessed_input;        /**< Socket only: pending input */
  71   u32 unprocessed_msg_length;   /**< Socket only: unprocssed length */
  72   u8 *output_vector;            /**< Socket only: output vector */
  73   int *additional_fds_to_close;
  74
  75   /* socket client only */
  76   u32 server_handle;            /**< Socket client only: server handle */
  77   u32 server_index;             /**< Socket client only: server index */
  78
  79   bool keepalive; /**< Dead client scan */
  80 } vl_api_registration_t;
  81
  82 #define VL_API_INVALID_FI ((u32)~0)
  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 *format_fn;              /**< message format function  */
 126   void *tojson;                 /**< binary to JSON convert function */
 127   void *fromjson;               /**< JSON to binary convert function */
 128   void *calc_size;              /**< message size calculation */
 129   int size;                     /**< message size  */
 130   int traced : 1;               /**< is this message to be traced?  */
 131   int replay : 1;               /**< is this message to be replayed?  */
 132   int message_bounce : 1;       /**< do not free message after processing */
 133   int is_mp_safe : 1;           /**< worker thread barrier required?  */
 134   int is_autoendian : 1;        /**< endian conversion required?  */
 135 } vl_msg_api_msg_config_t;
 136
 137 /** Message header structure */
 138 typedef struct msgbuf_
 139 {
 140   svm_queue_t *q; /**< message allocated in this shmem ring  */
 141   u32 data_len;                  /**< message length not including header  */
 142   u32 gc_mark_timestamp;         /**< message garbage collector mark TS  */
 143   u8 data[0];                    /**< actual message begins here  */
 144 } msgbuf_t;
 145
 146 __clib_nosanitize_addr static inline void
 147 VL_MSG_API_UNPOISON (const void *a)
 148 {
 149   const msgbuf_t *m = &((const msgbuf_t *) a)[-1];
 150   clib_mem_unpoison (m, sizeof (*m) + ntohl (m->data_len));
 151 }
 152
 153 __clib_nosanitize_addr static inline void
 154 VL_MSG_API_SVM_QUEUE_UNPOISON (const svm_queue_t *q)
 155 {
 156   clib_mem_unpoison (q, sizeof (*q) + q->elsize * q->maxsize);
 157 }
 158
 159 static inline void
 160 VL_MSG_API_POISON (const void *a)
 161 {
 162   const msgbuf_t *m = &((const msgbuf_t *) a)[-1];
 163   clib_mem_poison (m, sizeof (*m) + ntohl (m->data_len));
 164 }
 165
 166 /* api_shared.c prototypes */
 167 void vl_msg_api_handler (void *the_msg, uword msg_len);
 168 void vl_msg_api_handler_no_free (void *the_msg, uword msg_len);
 169 void vl_msg_api_handler_no_trace_no_free (void *the_msg, uword msg_len);
 170 void vl_msg_api_trace_only (void *the_msg, uword msg_len);
 171 void vl_msg_api_cleanup_handler (void *the_msg);
 172 void vl_msg_api_replay_handler (void *the_msg);
 173 void vl_msg_api_socket_handler (void *the_msg, uword msg_len);
 174 void vl_msg_api_set_handlers (int msg_id, char *msg_name, void *handler,
 175                               void *endian, format_function_t *format,
 176                               int msg_size, int traced, void *tojson,
 177                               void *fromjson, void *validate_size);
 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_msg_api_increment_missing_client_counter (void);
 193 void vl_msg_api_post_mortem_dump (void);
 194 void vl_msg_api_post_mortem_dump_enable_disable (int enable);
 195 void vl_msg_api_register_pd_handler (void *handler,
 196                                      u16 msg_id_host_byte_order);
 197 int vl_msg_api_pd_handler (void *mp, int rv);
 198
 199 void vl_msg_api_set_first_available_msg_id (u16 first_avail);
 200 u16 vl_msg_api_get_msg_ids (const char *name, int n);
 201 u32 vl_msg_api_get_msg_index (u8 * name_and_crc);
 202 void *vl_msg_push_heap (void);
 203 void *vl_msg_push_heap_w_region (svm_region_t * vlib_rp);
 204 void vl_msg_pop_heap (void *oldheap);
 205 void vl_msg_pop_heap_w_region (svm_region_t * vlib_rp, void *oldheap);
 206
 207 typedef clib_error_t *(vl_msg_api_init_function_t) (u32 client_index);
 208
 209 typedef struct _vl_msg_api_init_function_list_elt
 210 {
 211   struct _vl_msg_api_init_function_list_elt *next_init_function;
 212   vl_msg_api_init_function_t *f;
 213 } _vl_msg_api_function_list_elt_t;
 214
 215 typedef struct
 216 {
 217   u32 major;
 218   u32 minor;
 219   u32 patch;
 220   char name[64];
 221 } api_version_t;
 222
 223 typedef struct
 224 {
 225   /** Message handler vector  */
 226   void (*handler) (void *);
 227
 228   /** non-default message cleanup handler vector */
 229   void (*cleanup_handler) (void *);
 230
 231   /** Message name vector */
 232   const char *name;
 233
 234   /** Message format function */
 235   format_function_t *format_fn;
 236
 237   /** Message convert function vector */
 238   cJSON *(*tojson_handler) (void *);
 239
 240   /** Message convert function vector */
 241   void *(*fromjson_handler) (cJSON *, int *);
 242
 243   /** Message endian handler vector */
 244   void (*endian_handler) (void *);
 245
 246   /** Message calc size function vector */
 247   uword (*calc_size_func) (void *);
 248
 249   /** trace size for sanity checking */
 250   int trace_size;
 251
 252   /** Flags */
 253   u8 bounce : 1;         /**> Don't automatically free message buffer vetor */
 254   u8 is_mp_safe : 1;     /**< Message is mp safe vector */
 255   u8 is_autoendian : 1;  /**< Message requires us to do endian conversion */
 256   u8 trace_enable : 1;   /**< trace this message  */
 257   u8 replay_allowed : 1; /**< This message can be replayed  */
 258
 259 } vl_api_msg_data_t;
 260
 261 /** API main structure, used by both vpp and binary API clients */
 262 typedef struct api_main_t
 263 {
 264   vl_api_msg_data_t *msg_data;
 265
 266   /** API message ID by name hash table */
 267   uword *msg_id_by_name;
 268
 269   /** Allocator ring vectors (in shared memory) */
 270   struct ring_alloc_ *arings;
 271
 272   /** Number of times that the ring allocator failed */
 273   u32 ring_misses;
 274
 275   /** Number of garbage-collected message buffers */
 276   u32 garbage_collects;
 277
 278   /** Number of missing clients / failed message sends */
 279   u32 missing_clients;
 280
 281   /** Received message trace configuration */
 282   vl_api_trace_t *rx_trace;
 283
 284   /** Sent message trace configuration */
 285   vl_api_trace_t *tx_trace;
 286
 287   /** Print every received message */
 288   int msg_print_flag;
 289
 290   /** Current process PID */
 291   int our_pid;
 292
 293   /** Current binary api segment descriptor */
 294   svm_region_t *vlib_rp;
 295
 296   /** Primary api segment descriptor */
 297   svm_region_t *vlib_primary_rp;
 298
 299   /** Vector of all mapped shared-VM segments */
 300   svm_region_t **vlib_private_rps;
 301   svm_region_t **mapped_shmem_regions;
 302
 303   /** Binary API shared-memory segment header pointer */
 304   struct vl_shmem_hdr_ *shmem_hdr;
 305
 306   /** vlib/vpp only: vector of client registrations */
 307   vl_api_registration_t **vl_clients;
 308
 309   /** vlib/vpp only: serialized (message, name, crc) table */
 310   u8 *serialized_message_table_in_shmem;
 311
 312   /** First available message ID, for theplugin msg allocator */
 313   u16 first_available_msg_id;
 314
 315   /** Message range by name hash */
 316   uword *msg_range_by_name;
 317
 318   /** vector of message ranges */
 319   vl_api_msg_range_t *msg_ranges;
 320
 321   /** uid for the api shared memory region */
 322   int api_uid;
 323
 324   /** gid for the api shared memory region */
 325   int api_gid;
 326
 327   /** base virtual address for global VM region */
 328   u64 global_baseva;
 329
 330   /** size of the global VM region */
 331   u64 global_size;
 332
 333   /** size of the API region */
 334   u64 api_size;
 335
 336   /** size of the global VM private mheap */
 337   u64 global_pvt_heap_size;
 338
 339   /** size of the api private mheap */
 340   u64 api_pvt_heap_size;
 341
 342   /** Peer input queue pointer */
 343   svm_queue_t *vl_input_queue;
 344
 345   /**
 346    * All VLIB-side message handlers use my_client_index to identify
 347    * the queue / client. This works in sim replay.
 348    */
 349   int my_client_index;
 350   /**
 351    * This is the (shared VM) address of the registration,
 352    * don't use it to id the connection since it can't possibly
 353    * work in simulator replay.
 354    */
 355   vl_api_registration_t *my_registration;
 356
 357   /** vpp/vlib input queue length */
 358   u32 vlib_input_queue_length;
 359
 360   /** client message index hash table */
 361   uword *msg_index_by_name_and_crc;
 362
 363   /** api version list */
 364   api_version_t *api_version_list;
 365
 366   /** Shared VM binary API region name */
 367   const char *region_name;
 368
 369   /** Chroot path to the shared memory API files */
 370   const char *root_path;
 371
 372   /** Replay in progress? */
 373   int replay_in_progress;
 374
 375   /** Dump (msg-name, crc) snapshot here at startup */
 376   u8 *save_msg_table_filename;
 377
 378   /** List of API client reaper functions */
 379   _vl_msg_api_function_list_elt_t *reaper_function_registrations;
 380
 381   /** Bin API thread handle */
 382   pthread_t rx_thread_handle;
 383
 384   /** event log */
 385   elog_main_t *elog_main;
 386   int elog_trace_api_messages;
 387
 388   /** performance counter callback **/
 389   void (**perf_counter_cbs)
 390     (struct api_main_t *, u32 id, int before_or_after);
 391   void (**perf_counter_cbs_tmp)
 392     (struct api_main_t *, u32 id, int before_or_after);
 393
 394 } api_main_t;
 395
 396 extern __thread api_main_t *my_api_main;
 397
 398 always_inline api_main_t *
 399 vlibapi_get_main (void)
 400 {
 401   return my_api_main;
 402 }
 403
 404 always_inline vl_api_msg_data_t *
 405 vl_api_get_msg_data (api_main_t *am, u32 msg_id)
 406 {
 407   if (msg_id >= vec_len (am->msg_data))
 408     return 0;
 409   return am->msg_data + msg_id;
 410 }
 411
 412 always_inline void
 413 vlibapi_set_main (api_main_t * am)
 414 {
 415   my_api_main = am;
 416 }
 417
 418 #endif /* included_api_common_h */
 419
 420 /*
 421  * fd.io coding-style-patch-verification: ON
 422  *
 423  * Local Variables:
 424  * eval: (c-set-style "gnu")
 425  * End:
 426  */