2 *------------------------------------------------------------------
3 * vat_helper_macros.h - collect api client helper macros in one place
5 * Copyright (c) 2016 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:
10 * http://www.apache.org/licenses/LICENSE-2.0
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 *------------------------------------------------------------------
19 #ifndef __vat_helper_macros_h__
20 #define __vat_helper_macros_h__
22 /* M: construct, but don't yet send a message */
25 socket_client_main_t *scm = vam->socket_client_main; \
26 vam->result_ready = 0; \
27 if (scm && scm->socket_enable) \
28 mp = vl_socket_client_msg_alloc (sizeof(*mp)); \
30 mp = vl_msg_api_alloc_as_if_client(sizeof(*mp)); \
31 clib_memset (mp, 0, sizeof (*mp)); \
32 mp->_vl_msg_id = ntohs (VL_API_##T+__plugin_msg_base); \
33 mp->client_index = vam->my_client_index; \
36 /* MPING: construct a control-ping message, don't send it yet */
37 #define MPING(T, mp) \
39 socket_client_main_t *scm = vam->socket_client_main; \
40 vam->result_ready = 0; \
41 if (scm && scm->socket_enable) \
42 mp = vl_socket_client_msg_alloc (sizeof(*mp)); \
44 mp = vl_msg_api_alloc_as_if_client(sizeof(*mp)); \
45 clib_memset (mp, 0, sizeof (*mp)); \
46 mp->_vl_msg_id = ntohs (VL_API_##T+__plugin_msg_base); \
47 mp->client_index = vam->my_client_index; \
49 scm->control_pings_outstanding++; \
52 #define M2(T, mp, n) \
54 socket_client_main_t *scm = vam->socket_client_main; \
55 vam->result_ready = 0; \
56 if (scm && scm->socket_enable) \
57 mp = vl_socket_client_msg_alloc (sizeof(*mp) + n); \
59 mp = vl_msg_api_alloc_as_if_client(sizeof(*mp) + n); \
60 clib_memset (mp, 0, sizeof (*mp)); \
61 mp->_vl_msg_id = ntohs (VL_API_##T+__plugin_msg_base); \
62 mp->client_index = vam->my_client_index; \
65 #define PING(_tm, mp_ping) \
68 if (!(_tm)->ping_id) \
70 vl_msg_api_get_msg_index ((u8 *) (VL_API_CONTROL_PING_CRC)); \
71 mp_ping = vl_msg_api_alloc_as_if_client (sizeof (*mp_ping)); \
72 mp_ping->_vl_msg_id = htons ((_tm)->ping_id); \
73 mp_ping->client_index = vam->my_client_index; \
74 vam->result_ready = 0; \
78 /* S: send a message */
81 socket_client_main_t *scm = vam->socket_client_main; \
82 if (scm && scm->socket_enable) \
83 vl_socket_client_write (); \
85 vl_msg_api_send_shmem (vam->vl_input_queue, (u8 *)&mp); \
88 /* W: wait for results, with timeout */
91 f64 timeout = vat_time_now (vam) + 1.0; \
92 socket_client_main_t *scm = vam->socket_client_main; \
95 if (scm && scm->socket_enable) \
96 vl_socket_client_read (5); \
97 while (vat_time_now (vam) < timeout) { \
98 if (vam->result_ready == 1) { \
102 vat_suspend (vam->vlib_main, 1e-5); \
106 /* W2: wait for results, with timeout */ \
107 #define W2(ret, body) \
109 f64 timeout = vat_time_now (vam) + 1.0; \
110 socket_client_main_t *scm = vam->socket_client_main; \
113 if (scm && scm->socket_enable) \
114 vl_socket_client_read (5); \
115 while (vat_time_now (vam) < timeout) { \
116 if (vam->result_ready == 1) { \
121 vat_suspend (vam->vlib_main, 1e-5); \
125 #define VAT_PLUGIN_REGISTER(plug) \
126 clib_error_t * vat_plugin_register (vat_main_t *vam) \
128 plug##_test_main_t * mp = &plug##_test_main; \
131 mp->vat_main = vam; \
133 /* Ask the vpp engine for the first assigned message-id */ \
134 name = format (0, #plug "_%08x%c", api_version, 0); \
136 vl_client_get_first_plugin_msg_id ((char *) name); \
139 if (mp->msg_id_base != (u16) ~0) \
140 plug##_api_hookup (vam); \
142 return clib_error_return (0, #plug " plugin not loaded...");\
147 #endif /* __vat_helper_macros_h__ */