src/vlibmemory/api.h

   1 /*
   2  *------------------------------------------------------------------
   3  * Copyright (c) 2009 Cisco and/or its affiliates.
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  *------------------------------------------------------------------
  16  */
  17
  18 #ifndef included_vlibmemory_api_common_h
  19 #define included_vlibmemory_api_common_h
  20
  21 #include <svm/svm_common.h>
  22 #include <vlibapi/api.h>
  23 #include <vlibmemory/memory_api.h>
  24 #include <vlibmemory/memory_client.h>
  25 #include <vlibmemory/socket_api.h>
  26 #include <vlibmemory/socket_client.h>
  27
  28 void vl_api_rpc_call_main_thread (void *fp, u8 * data, u32 data_length);
  29 u16 vl_client_get_first_plugin_msg_id (const char *plugin_name);
  30 void vl_api_send_pending_rpc_requests (vlib_main_t * vm);
  31 u8 *vl_api_serialize_message_table (api_main_t * am, u8 * vector);
  32
  33 always_inline void
  34 vl_api_send_msg (vl_api_registration_t * rp, u8 * elem)
  35 {
  36   if (PREDICT_FALSE (rp->registration_type > REGISTRATION_TYPE_SHMEM))
  37     {
  38       vl_socket_api_send (rp, elem);
  39     }
  40   else
  41     {
  42       vl_msg_api_send_shmem (rp->vl_input_queue, (u8 *) & elem);
  43     }
  44 }
  45
  46 always_inline int
  47 vl_api_can_send_msg (vl_api_registration_t * rp)
  48 {
  49   if (PREDICT_FALSE (rp->registration_type > REGISTRATION_TYPE_SHMEM))
  50     return 1;
  51   else
  52     return vl_mem_api_can_send (rp->vl_input_queue);
  53 }
  54
  55 always_inline vl_api_registration_t *
  56 vl_api_client_index_to_registration (u32 index)
  57 {
  58   vl_api_registration_t *reg =
  59     vl_socket_api_client_index_to_registration (index);
  60   if (reg && reg->registration_type != REGISTRATION_TYPE_FREE)
  61     return reg;
  62   return vl_mem_api_client_index_to_registration (index);
  63 }
  64
  65 always_inline u32
  66 vl_api_registration_file_index (vl_api_registration_t * reg)
  67 {
  68   return reg->clib_file_index;
  69 }
  70
  71 always_inline clib_file_t *
  72 vl_api_registration_file (vl_api_registration_t * reg)
  73 {
  74   return clib_file_get (&file_main, vl_api_registration_file_index (reg));
  75 }
  76
  77 always_inline void
  78 vl_api_registration_del_file (vl_api_registration_t * reg)
  79 {
  80   clib_file_t *cf = vl_api_registration_file (reg);
  81   if (cf)
  82     clib_file_del (&file_main, cf);
  83 }
  84
  85 always_inline clib_error_t *
  86 vl_api_send_fd_msg (vl_api_registration_t * reg, int fds[], int n_fds)
  87 {
  88   clib_file_t *cf = vl_api_registration_file (reg);
  89   if (cf)
  90     return vl_sock_api_send_fd_msg (cf->file_descriptor, fds, n_fds);
  91   return 0;
  92 }
  93
  94 always_inline clib_error_t *
  95 vl_api_recv_fd_msg (vl_api_registration_t * reg, int fds[], int n_fds,
  96                     u32 wait)
  97 {
  98   clib_file_t *cf = vl_api_registration_file (reg);
  99   if (cf)
 100     return vl_sock_api_recv_fd_msg (cf->file_descriptor, fds, n_fds, wait);
 101   return 0;
 102 }
 103
 104 /*
 105  * vl_api_clnt process data used by transports (socket api in particular)
 106  */
 107 extern vlib_node_registration_t vl_api_clnt_node;
 108 extern volatile int **vl_api_queue_cursizes;
 109
 110 typedef enum vl_api_clnt_process_events
 111 {
 112   QUEUE_SIGNAL_EVENT = 1,
 113   SOCKET_READ_EVENT
 114 } vl_api_clnt_process_events_t;
 115
 116 #define foreach_histogram_bucket                \
 117 _(400)                                          \
 118 _(200)                                          \
 119 _(100)                                          \
 120 _(10)
 121
 122 typedef enum
 123 {
 124 #define _(n) SLEEP_##n##_US,
 125   foreach_histogram_bucket
 126 #undef _
 127     SLEEP_N_BUCKETS,
 128 } histogram_index_t;
 129
 130 extern u64 vector_rate_histogram[];
 131
 132 /*
 133  * sockclnt APIs XXX are these actually used anywhere?
 134  */
 135 vl_api_registration_t *sockclnt_get_registration (u32 index);
 136 void socksvr_add_pending_output (struct clib_file *uf,
 137                                  struct vl_api_registration_ *cf,
 138                                  u8 * buffer, uword buffer_bytes);
 139 void vl_socket_process_msg (struct clib_file *uf,
 140                             struct vl_api_registration_ *rp, i8 * input_v);
 141 u32 sockclnt_open_index (char *client_name, char *hostname, int port);
 142 void sockclnt_close_index (u32 index);
 143 void vl_client_msg_api_send (vl_api_registration_t * cm, u8 * elem);
 144
 145 #endif /* included_vlibmemory_api_common_h */
 146
 147 /*
 148  * fd.io coding-style-patch-verification: ON
 149  *
 150  * Local Variables:
 151  * eval: (c-set-style "gnu")
 152  * End:
 153  */