blob: dc91c9f5023757871a22ac8e85d42d03f952d107 [file] [log] [blame]
Dave Barachfe6bdfd2017-01-20 19:50:09 -05001/*
2 *------------------------------------------------------------------
3 * vat_helper_macros.h - collect api client helper macros in one place
4 *
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:
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#ifndef __vat_helper_macros_h__
20#define __vat_helper_macros_h__
21
22/* M: construct, but don't yet send a message */
Dave Barach2d6b2d62017-01-25 16:32:08 -050023#define M(T,t) \
24do { \
25 vam->result_ready = 0; \
26 mp = vl_msg_api_alloc_as_if_client(sizeof(*mp)); \
27 memset (mp, 0, sizeof (*mp)); \
28 mp->_vl_msg_id = ntohs (VL_API_##T+__plugin_msg_base); \
29 mp->client_index = vam->my_client_index; \
Dave Barachfe6bdfd2017-01-20 19:50:09 -050030} while(0);
31
32#define M2(T,t,n) \
33do { \
34 vam->result_ready = 0; \
35 mp = vl_msg_api_alloc_as_if_client(sizeof(*mp)+(n)); \
36 memset (mp, 0, sizeof (*mp)); \
Dave Barach2d6b2d62017-01-25 16:32:08 -050037 mp->_vl_msg_id = ntohs (VL_API_##T+__plugin_msg_base); \
Dave Barachfe6bdfd2017-01-20 19:50:09 -050038 mp->client_index = vam->my_client_index; \
39} while(0);
40
Dave Barachfe6bdfd2017-01-20 19:50:09 -050041/* S: send a message */
42#define S (vl_msg_api_send_shmem (vam->vl_input_queue, (u8 *)&mp))
43
44/* W: wait for results, with timeout */
45#define W \
46do { \
47 timeout = vat_time_now (vam) + 1.0; \
48 \
49 while (vat_time_now (vam) < timeout) { \
50 if (vam->result_ready == 1) { \
51 return (vam->retval); \
52 } \
53 vat_suspend (vam->vlib_main, 1e-5); \
54 } \
55 return -99; \
56} while(0);
57
58/* W2: wait for results, with timeout */
59#define W2(body) \
60do { \
61 timeout = vat_time_now (vam) + 1.0; \
62 \
63 while (vat_time_now (vam) < timeout) { \
64 if (vam->result_ready == 1) { \
65 (body); \
66 return (vam->retval); \
67 } \
68 vat_suspend (vam->vlib_main, 1e-5); \
69 } \
70 return -99; \
71} while(0);
72
73
74#endif /* __vat_helper_macros_h__ */