Line data    Source code

       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             :   u32 traced : 1;               /**< is this message to be traced?  */
     131             :   u32 replay : 1;               /**< is this message to be replayed?  */
     132             :   u32 message_bounce : 1;       /**< do not free message after processing */
     133             :   u32 is_mp_safe : 1;           /**< worker thread barrier required?  */
     134             :   u32 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      827831 : VL_MSG_API_UNPOISON (const void *a)
     148             : {
     149      827831 :   const msgbuf_t *m = &((const msgbuf_t *) a)[-1];
     150      827831 :   clib_mem_unpoison (m, sizeof (*m) + ntohl (m->data_len));
     151      827831 : }
     152             : 
     153             : __clib_nosanitize_addr static inline void
     154         108 : VL_MSG_API_SVM_QUEUE_UNPOISON (const svm_queue_t *q)
     155             : {
     156         108 :   clib_mem_unpoison (q, sizeof (*q) + q->elsize * q->maxsize);
     157         108 : }
     158             : 
     159             : static inline void
     160      799899 : VL_MSG_API_POISON (const void *a)
     161             : {
     162      799899 :   const msgbuf_t *m = &((const msgbuf_t *) a)[-1];
     163      799899 :   clib_mem_poison (m, sizeof (*m) + ntohl (m->data_len));
     164      799899 : }
     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_clean_handlers (int msg_id);
     175             : void vl_msg_api_config (vl_msg_api_msg_config_t *);
     176             : void vl_msg_api_set_cleanup_handler (int msg_id, void *fp);
     177             : void vl_msg_api_queue_handler (svm_queue_t * q);
     178             : 
     179             : void vl_msg_api_barrier_sync (void) __attribute__ ((weak));
     180             : void vl_msg_api_barrier_release (void) __attribute__ ((weak));
     181             : #ifdef BARRIER_TRACING
     182             : void vl_msg_api_barrier_trace_context (const char *context)
     183             :   __attribute__ ((weak));
     184             : #else
     185             : #define vl_msg_api_barrier_trace_context(X)
     186             : #endif
     187             : void vl_msg_api_free (void *);
     188             : void vl_msg_api_increment_missing_client_counter (void);
     189             : void vl_msg_api_post_mortem_dump (void);
     190             : void vl_msg_api_post_mortem_dump_enable_disable (int enable);
     191             : void vl_msg_api_register_pd_handler (void *handler,
     192             :                                      u16 msg_id_host_byte_order);
     193             : 
     194             : void vl_msg_api_set_first_available_msg_id (u16 first_avail);
     195             : u16 vl_msg_api_get_msg_ids (const char *name, int n);
     196             : u32 vl_msg_api_get_msg_index (u8 * name_and_crc);
     197             : void *vl_msg_push_heap (void);
     198             : void *vl_msg_push_heap_w_region (svm_region_t * vlib_rp);
     199             : void vl_msg_pop_heap (void *oldheap);
     200             : void vl_msg_pop_heap_w_region (svm_region_t * vlib_rp, void *oldheap);
     201             : 
     202             : typedef clib_error_t *(vl_msg_api_init_function_t) (u32 client_index);
     203             : 
     204             : typedef struct _vl_msg_api_init_function_list_elt
     205             : {
     206             :   struct _vl_msg_api_init_function_list_elt *next_init_function;
     207             :   vl_msg_api_init_function_t *f;
     208             : } _vl_msg_api_function_list_elt_t;
     209             : 
     210             : typedef struct
     211             : {
     212             :   u32 major;
     213             :   u32 minor;
     214             :   u32 patch;
     215             :   char name[64];
     216             : } api_version_t;
     217             : 
     218             : typedef struct
     219             : {
     220             :   /** Message handler vector  */
     221             :   void (*handler) (void *);
     222             : 
     223             :   /** non-default message cleanup handler vector */
     224             :   void (*cleanup_handler) (void *);
     225             : 
     226             :   /** Message name vector */
     227             :   const char *name;
     228             : 
     229             :   /** Message format function */
     230             :   format_function_t *format_fn;
     231             : 
     232             :   /** Message convert function vector */
     233             :   cJSON *(*tojson_handler) (void *);
     234             : 
     235             :   /** Message convert function vector */
     236             :   void *(*fromjson_handler) (cJSON *, int *);
     237             : 
     238             :   /** Message endian handler vector */
     239             :   void (*endian_handler) (void *);
     240             : 
     241             :   /** Message calc size function vector */
     242             :   uword (*calc_size_func) (void *);
     243             : 
     244             :   /** trace size for sanity checking */
     245             :   int trace_size;
     246             : 
     247             :   /** Flags */
     248             :   u8 bounce : 1;         /**> Don't automatically free message buffer vetor */
     249             :   u8 is_mp_safe : 1;     /**< Message is mp safe vector */
     250             :   u8 is_autoendian : 1;  /**< Message requires us to do endian conversion */
     251             :   u8 trace_enable : 1;   /**< trace this message  */
     252             :   u8 replay_allowed : 1; /**< This message can be replayed  */
     253             : 
     254             : } vl_api_msg_data_t;
     255             : 
     256             : /** API main structure, used by both vpp and binary API clients */
     257             : typedef struct api_main_t
     258             : {
     259             :   vl_api_msg_data_t *msg_data;
     260             : 
     261             :   /** API message ID by name hash table */
     262             :   uword *msg_id_by_name;
     263             : 
     264             :   /** Allocator ring vectors (in shared memory) */
     265             :   struct ring_alloc_ *arings;
     266             : 
     267             :   /** Number of times that the ring allocator failed */
     268             :   u32 ring_misses;
     269             : 
     270             :   /** Number of garbage-collected message buffers */
     271             :   u32 garbage_collects;
     272             : 
     273             :   /** Number of missing clients / failed message sends */
     274             :   u32 missing_clients;
     275             : 
     276             :   /** Received message trace configuration */
     277             :   vl_api_trace_t *rx_trace;
     278             : 
     279             :   /** Sent message trace configuration */
     280             :   vl_api_trace_t *tx_trace;
     281             : 
     282             :   /** Print every received message */
     283             :   int msg_print_flag;
     284             : 
     285             :   /** Current process PID */
     286             :   int our_pid;
     287             : 
     288             :   /** Current binary api segment descriptor */
     289             :   svm_region_t *vlib_rp;
     290             : 
     291             :   /** Primary api segment descriptor */
     292             :   svm_region_t *vlib_primary_rp;
     293             : 
     294             :   /** Vector of all mapped shared-VM segments */
     295             :   svm_region_t **vlib_private_rps;
     296             :   svm_region_t **mapped_shmem_regions;
     297             : 
     298             :   /** Binary API shared-memory segment header pointer */
     299             :   struct vl_shmem_hdr_ *shmem_hdr;
     300             : 
     301             :   /** vlib/vpp only: vector of client registrations */
     302             :   vl_api_registration_t **vl_clients;
     303             : 
     304             :   /** vlib/vpp only: serialized (message, name, crc) table */
     305             :   u8 *serialized_message_table_in_shmem;
     306             : 
     307             :   /** First available message ID, for theplugin msg allocator */
     308             :   u16 first_available_msg_id;
     309             : 
     310             :   /** Message range by name hash */
     311             :   uword *msg_range_by_name;
     312             : 
     313             :   /** vector of message ranges */
     314             :   vl_api_msg_range_t *msg_ranges;
     315             : 
     316             :   /** uid for the api shared memory region */
     317             :   int api_uid;
     318             : 
     319             :   /** gid for the api shared memory region */
     320             :   int api_gid;
     321             : 
     322             :   /** base virtual address for global VM region */
     323             :   u64 global_baseva;
     324             : 
     325             :   /** size of the global VM region */
     326             :   u64 global_size;
     327             : 
     328             :   /** size of the API region */
     329             :   u64 api_size;
     330             : 
     331             :   /** size of the global VM private mheap */
     332             :   u64 global_pvt_heap_size;
     333             : 
     334             :   /** size of the api private mheap */
     335             :   u64 api_pvt_heap_size;
     336             : 
     337             :   /** Peer input queue pointer */
     338             :   svm_queue_t *vl_input_queue;
     339             : 
     340             :   /**
     341             :    * All VLIB-side message handlers use my_client_index to identify
     342             :    * the queue / client. This works in sim replay.
     343             :    */
     344             :   int my_client_index;
     345             :   /**
     346             :    * This is the (shared VM) address of the registration,
     347             :    * don't use it to id the connection since it can't possibly
     348             :    * work in simulator replay.
     349             :    */
     350             :   vl_api_registration_t *my_registration;
     351             : 
     352             :   /** vpp/vlib input queue length */
     353             :   u32 vlib_input_queue_length;
     354             : 
     355             :   /** client message index hash table */
     356             :   uword *msg_index_by_name_and_crc;
     357             : 
     358             :   /** api version list */
     359             :   api_version_t *api_version_list;
     360             : 
     361             :   /** Shared VM binary API region name */
     362             :   const char *region_name;
     363             : 
     364             :   /** Chroot path to the shared memory API files */
     365             :   const char *root_path;
     366             : 
     367             :   /** Replay in progress? */
     368             :   int replay_in_progress;
     369             : 
     370             :   /** Dump (msg-name, crc) snapshot here at startup */
     371             :   u8 *save_msg_table_filename;
     372             : 
     373             :   /** List of API client reaper functions */
     374             :   _vl_msg_api_function_list_elt_t *reaper_function_registrations;
     375             : 
     376             :   /** Bin API thread handle */
     377             :   pthread_t rx_thread_handle;
     378             : 
     379             :   /** event log */
     380             :   elog_main_t *elog_main;
     381             :   int elog_trace_api_messages;
     382             : 
     383             :   /** performance counter callback **/
     384             :   void (**perf_counter_cbs)
     385             :     (struct api_main_t *, u32 id, int before_or_after);
     386             :   void (**perf_counter_cbs_tmp)
     387             :     (struct api_main_t *, u32 id, int before_or_after);
     388             : 
     389             : } api_main_t;
     390             : 
     391             : extern __thread api_main_t *my_api_main;
     392             : 
     393             : always_inline api_main_t *
     394   644310862 : vlibapi_get_main (void)
     395             : {
     396   644310862 :   return my_api_main;
     397             : }
     398             : 
     399             : always_inline vl_api_msg_data_t *
     400     2272108 : vl_api_get_msg_data (api_main_t *am, u32 msg_id)
     401             : {
     402     2272108 :   if (msg_id >= vec_len (am->msg_data))
     403           2 :     return 0;
     404     2272106 :   return am->msg_data + msg_id;
     405             : }
     406             : 
     407             : always_inline void
     408          58 : vlibapi_set_main (api_main_t * am)
     409             : {
     410          58 :   my_api_main = am;
     411          58 : }
     412             : 
     413             : #endif /* included_api_common_h */
     414             : 
     415             : /*
     416             :  * fd.io coding-style-patch-verification: ON
     417             :  *
     418             :  * Local Variables:
     419             :  * eval: (c-set-style "gnu")
     420             :  * End:
     421             :  */