src/vlibapi/vat_helper_macros.h


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135

/*
 *------------------------------------------------------------------
 * vat_helper_macros.h - collect api client helper macros in one place
 *
 * Copyright (c) 2016 Cisco and/or its affiliates.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at:
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *------------------------------------------------------------------
 */
#ifndef __vat_helper_macros_h__
#define __vat_helper_macros_h__

/* M: construct, but don't yet send a message */
#define M(T, mp)                                                \
do {                                                            \
    socket_client_main_t *scm = &vam->socket_client_main;	\
    vam->result_ready = 0;                                      \
    if (scm->socket_enable)                                     \
      {                                                         \
        mp = (void *)scm->socket_tx_buffer;                     \
        scm->socket_tx_nbytes = sizeof (*mp);                   \
      }                                                         \
    else                                                        \
      mp = vl_msg_api_alloc_as_if_client(sizeof(*mp));          \
    memset (mp, 0, sizeof (*mp));                               \
    mp->_vl_msg_id = ntohs (VL_API_##T+__plugin_msg_base);      \
    mp->client_index = vam->my_client_index;                    \
} while(0);

/* MPING: construct a control-ping message, don't send it yet */
#define MPING(T, mp)                                            \
do {                                                            \
    socket_client_main_t *scm = &vam->socket_client_main;	\
    vam->result_ready = 0;                                      \
    if (scm->socket_enable)                                     \
      {                                                         \
        mp = (void *)scm->socket_tx_buffer;                     \
        scm->socket_tx_nbytes = sizeof (*mp);                   \
      }                                                         \
    else                                                        \
      mp = vl_msg_api_alloc_as_if_client(sizeof(*mp));          \
    memset (mp, 0, sizeof (*mp));                               \
    mp->_vl_msg_id = ntohs (VL_API_##T+__plugin_msg_base);      \
    mp->client_index = vam->my_client_index;                    \
    scm->control_pings_outstanding++;                           \
} while(0);

#define M2(T, mp, n)                                            \
do {                                                            \
    socket_client_main_t *scm = &vam->socket_client_main;	\
    vam->result_ready = 0;                                      \
    if (scm->socket_enable)                                     \
      {                                                         \
        mp = (void *)scm->socket_tx_buffer;                     \
        scm->socket_tx_nbytes = sizeof (*mp) + n;               \
      }                                                         \
    else                                                        \
      mp = vl_msg_api_alloc_as_if_client(sizeof(*mp) + n);      \
    memset (mp, 0, sizeof (*mp));                               \
    mp->_vl_msg_id = ntohs (VL_API_##T+__plugin_msg_base);      \
    mp->client_index = vam->my_client_index;                    \
} while(0);

/* S: send a message */
#define S(mp)                                                   \
do {                                                            \
  int n;                                                        \
  socket_client_main_t *scm = &vam->socket_client_main;         \
  if (scm->socket_enable)                                       \
    {                                                           \
      msgbuf_t msgbuf;                                          \
                                                                \
      msgbuf.q = 0;                                             \
      msgbuf.gc_mark_timestamp = 0;                             \
      msgbuf.data_len = ntohl(scm->socket_tx_nbytes);           \
                                                                \
      n = write (scm->socket_fd, &msgbuf, sizeof (msgbuf));     \
      if (n < sizeof (msgbuf))                                  \
        clib_unix_warning ("socket write (msgbuf)");            \
                                                                \
      n = write (scm->socket_fd, scm->socket_tx_buffer,         \
                   scm->socket_tx_nbytes);                      \
      if (n < scm->socket_tx_nbytes)                            \
        clib_unix_warning ("socket write (msg)");               \
    }                                                           \
  else                                                          \
    vl_msg_api_send_shmem (vam->vl_input_queue, (u8 *)&mp);     \
 } while (0);

/* W: wait for results, with timeout */
#define W(ret)                                                  \
do {                                                            \
    f64 timeout = vat_time_now (vam) + 1.0;                     \
    socket_client_main_t *scm = &vam->socket_client_main;	\
    ret = -99;                                                  \
                                                                \
    vl_socket_client_read_reply (scm);                          \
    while (vat_time_now (vam) < timeout) {                      \
        if (vam->result_ready == 1) {                           \
            ret = vam->retval;                                  \
            break;                                              \
        }                                                       \
        vat_suspend (vam->vlib_main, 1e-5);                     \
    }                                                           \
} while(0);

/* W2: wait for results, with timeout */
#define W2(ret, body)                                           \
do {                                                            \
    f64 timeout = vat_time_now (vam) + 1.0;                     \
    socket_client_main_t *scm = &vam->socket_client_main;	\
    ret = -99;                                                  \
                                                                \
    vl_socket_client_read_reply (scm);                          \
    while (vat_time_now (vam) < timeout) {                      \
        if (vam->result_ready == 1) {                           \
	  (body);                                               \
	  ret = vam->retval;                                    \
          break;                                                \
        }                                                       \
        vat_suspend (vam->vlib_main, 1e-5);                     \
    }                                                           \
} while(0);


#endif /* __vat_helper_macros_h__ */