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