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:
8 * http://www.apache.org/licenses/LICENSE-2.0
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 *------------------------------------------------------------------
18 #ifndef included_vlibmemory_api_common_h
19 #define included_vlibmemory_api_common_h
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>
28 void vl_api_rpc_call_main_thread (void *fp, u8 * data, u32 data_length);
29 void vl_api_force_rpc_call_main_thread (void *fp, u8 * data, u32 data_length);
30 u16 vl_client_get_first_plugin_msg_id (const char *plugin_name);
31 u8 *vl_api_serialize_message_table (api_main_t * am, u8 * vector);
34 vl_api_send_msg (vl_api_registration_t * rp, u8 * elem)
36 if (PREDICT_FALSE (rp->registration_type > REGISTRATION_TYPE_SHMEM))
38 vl_socket_api_send (rp, elem);
42 vl_msg_api_send_shmem (rp->vl_input_queue, (u8 *) & elem);
47 vl_api_can_send_msg (vl_api_registration_t * rp)
49 if (PREDICT_FALSE (rp->registration_type > REGISTRATION_TYPE_SHMEM))
52 return vl_mem_api_can_send (rp->vl_input_queue);
56 * Suggests to an API handler to relinguish control. Currently limits
57 * an handler to a maximum of 1ms or it earlier if the client queue is
60 * May be enhanced in the future based on other performance
61 * characteristics of the main thread.
63 #define VL_API_MAX_TIME_IN_HANDLER 0.001 /* 1 ms */
65 vl_api_process_may_suspend (vlib_main_t * vm, vl_api_registration_t * rp,
68 /* Is client queue full (leave space for reply message) */
69 if (rp->registration_type <= REGISTRATION_TYPE_SHMEM &&
70 rp->vl_input_queue->cursize + 1 >= rp->vl_input_queue->maxsize)
72 if (vlib_time_now (vm) > start + VL_API_MAX_TIME_IN_HANDLER)
77 always_inline vl_api_registration_t *
78 vl_api_client_index_to_registration (u32 index)
80 if (vl_socket_api_registration_handle_is_valid (ntohl (index)))
81 return vl_socket_api_client_handle_to_registration (ntohl (index));
82 return vl_mem_api_client_index_to_registration (index);
86 vl_api_registration_file_index (vl_api_registration_t * reg)
88 return reg->clib_file_index;
91 always_inline clib_file_t *
92 vl_api_registration_file (vl_api_registration_t * reg)
94 return clib_file_get (&file_main, vl_api_registration_file_index (reg));
98 vl_api_registration_del_file (vl_api_registration_t * reg)
100 clib_file_t *cf = vl_api_registration_file (reg);
102 clib_file_del (&file_main, cf);
105 always_inline clib_error_t *
106 vl_api_send_fd_msg (vl_api_registration_t * reg, int fds[], int n_fds)
108 clib_file_t *cf = vl_api_registration_file (reg);
110 return vl_sock_api_send_fd_msg (cf->file_descriptor, fds, n_fds);
114 always_inline clib_error_t *
115 vl_api_recv_fd_msg (vl_api_registration_t * reg, int fds[], int n_fds,
118 clib_file_t *cf = vl_api_registration_file (reg);
120 return vl_sock_api_recv_fd_msg (cf->file_descriptor, fds, n_fds, wait);
125 * vl_api_clnt process data used by transports (socket api in particular)
127 extern vlib_node_registration_t vl_api_clnt_node;
128 extern volatile int **vl_api_queue_cursizes;
130 typedef enum vl_api_clnt_process_events
132 QUEUE_SIGNAL_EVENT = 1,
134 } vl_api_clnt_process_events_t;
136 #define foreach_histogram_bucket \
144 #define _(n) SLEEP_##n##_US,
145 foreach_histogram_bucket
150 extern u64 vector_rate_histogram[];
153 * sockclnt APIs XXX are these actually used anywhere?
155 vl_api_registration_t *sockclnt_get_registration (u32 index);
156 void socksvr_add_pending_output (struct clib_file *uf,
157 struct vl_api_registration_ *cf,
158 u8 * buffer, uword buffer_bytes);
159 void vl_socket_process_msg (struct clib_file *uf,
160 struct vl_api_registration_ *rp, i8 * input_v);
161 u32 sockclnt_open_index (char *client_name, char *hostname, int port);
162 void sockclnt_close_index (u32 index);
163 void vl_client_msg_api_send (vl_api_registration_t * cm, u8 * elem);
165 #endif /* included_vlibmemory_api_common_h */
168 * fd.io coding-style-patch-verification: ON
171 * eval: (c-set-style "gnu")