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 vl_api_registration_t *
  47 vl_api_client_index_to_registration (u32 index)
  48 {
  49   if (PREDICT_FALSE (socket_main.current_rp != 0))
  50     return socket_main.current_rp;
  51
  52   return (vl_mem_api_client_index_to_registration (index));
  53 }
  54
  55 /*
  56  * vl_api_clnt process data used by transports (socket api in particular)
  57  */
  58 extern vlib_node_registration_t vl_api_clnt_node;
  59 extern volatile int **vl_api_queue_cursizes;
  60
  61 typedef enum vl_api_clnt_process_events
  62 {
  63   QUEUE_SIGNAL_EVENT = 1,
  64   SOCKET_READ_EVENT
  65 } vl_api_clnt_process_events_t;
  66
  67 #define foreach_histogram_bucket                \
  68 _(400)                                          \
  69 _(200)                                          \
  70 _(100)                                          \
  71 _(10)
  72
  73 typedef enum
  74 {
  75 #define _(n) SLEEP_##n##_US,
  76   foreach_histogram_bucket
  77 #undef _
  78     SLEEP_N_BUCKETS,
  79 } histogram_index_t;
  80
  81 extern u64 vector_rate_histogram[];
  82
  83 /*
  84  * sockclnt APIs XXX are these actually used anywhere?
  85  */
  86 vl_api_registration_t *sockclnt_get_registration (u32 index);
  87 void socksvr_add_pending_output (struct clib_file *uf,
  88                                  struct vl_api_registration_ *cf,
  89                                  u8 * buffer, uword buffer_bytes);
  90 void vl_socket_process_msg (struct clib_file *uf,
  91                             struct vl_api_registration_ *rp, i8 * input_v);
  92 u32 sockclnt_open_index (char *client_name, char *hostname, int port);
  93 void sockclnt_close_index (u32 index);
  94 void vl_client_msg_api_send (vl_api_registration_t * cm, u8 * elem);
  95
  96 #endif /* included_vlibmemory_api_common_h */
  97
  98 /*
  99  * fd.io coding-style-patch-verification: ON
 100  *
 101  * Local Variables:
 102  * eval: (c-set-style "gnu")
 103  * End:
 104  */