src/vlibapi/vat_helper_macros.h

   1 /*
   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 */
  23 #define M(T, mp)                                                \
  24 do {                                                            \
  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;                    \
  30 } while(0);
  31
  32 #define M2(T, mp, n)                                            \
  33 do {                                                            \
  34     vam->result_ready = 0;                                      \
  35     mp = vl_msg_api_alloc_as_if_client(sizeof(*mp)+(n));        \
  36     memset (mp, 0, sizeof (*mp));                               \
  37     mp->_vl_msg_id = ntohs (VL_API_##T+__plugin_msg_base);      \
  38     mp->client_index = vam->my_client_index;                    \
  39 } while(0);
  40
  41 /* S: send a message */
  42 #define S(mp) (vl_msg_api_send_shmem (vam->vl_input_queue, (u8 *)&mp))
  43
  44 /* W: wait for results, with timeout */
  45 #define W(ret)                                  \
  46 do {                                            \
  47     f64 timeout = vat_time_now (vam) + 1.0;     \
  48     ret = -99;                                  \
  49                                                 \
  50     while (vat_time_now (vam) < timeout) {      \
  51         if (vam->result_ready == 1) {           \
  52             ret = vam->retval;                  \
  53             break;                              \
  54         }                                       \
  55         vat_suspend (vam->vlib_main, 1e-5);     \
  56     }                                           \
  57 } while(0);
  58
  59 /* W2: wait for results, with timeout */
  60 #define W2(ret, body)                           \
  61 do {                                            \
  62     f64 timeout = vat_time_now (vam) + 1.0;     \
  63     ret = -99;                                  \
  64                                                 \
  65     while (vat_time_now (vam) < timeout) {      \
  66         if (vam->result_ready == 1) {           \
  67           (body);                               \
  68           ret = vam->retval;                    \
  69           break;                                \
  70         }                                       \
  71         vat_suspend (vam->vlib_main, 1e-5);     \
  72     }                                           \
  73 } while(0);
  74
  75
  76 #endif /* __vat_helper_macros_h__ */