FD.io VPP  v19.08.3-2-gbabecb413
Vector Packet Processing
vmxnet3_api.c
Go to the documentation of this file.
1 /*
2  *------------------------------------------------------------------
3  * Copyright (c) 2018 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:
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
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  *------------------------------------------------------------------
16  */
17 
18 #include <vlib/vlib.h>
19 #include <vlib/unix/unix.h>
20 #include <vlib/pci/pci.h>
21 #include <vnet/ethernet/ethernet.h>
22 
23 #include <vmxnet3/vmxnet3.h>
24 
25 #include <vlibapi/api.h>
26 #include <vlibmemory/api.h>
27 
28 /* define message IDs */
30 
31 /* define message structures */
32 #define vl_typedefs
34 #undef vl_typedefs
35 
36 /* define generated endian-swappers */
37 #define vl_endianfun
39 #undef vl_endianfun
40 
41 /* instantiate all the print functions we know about */
42 #define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__)
43 
44 /* get the API version number */
45 #define vl_api_version(n,v) static u32 api_version=(v);
47 #undef vl_api_version
48 
49 /* Macro to finish up custom dump fns */
50 #define FINISH \
51  vec_add1 (s, 0); \
52  vl_print (handle, (char *)s); \
53  vec_free (s); \
54  return handle;
55 
57 
58 #define foreach_vmxnet3_plugin_api_msg \
59 _(VMXNET3_CREATE, vmxnet3_create) \
60 _(VMXNET3_DELETE, vmxnet3_delete) \
61 _(VMXNET3_DUMP, vmxnet3_dump)
62 
63 static void
65 {
70  int rv;
71 
72  clib_memset (&args, 0, sizeof (vmxnet3_create_if_args_t));
73 
74  args.enable_elog = ntohl (mp->enable_elog);
75  args.addr.as_u32 = ntohl (mp->pci_addr);
76  args.rxq_size = ntohs (mp->rxq_size);
77  args.txq_size = ntohs (mp->txq_size);
78  args.txq_num = ntohs (mp->txq_num);
79  args.rxq_num = ntohs (mp->rxq_num);
80  args.bind = mp->bind;
81 
82  vmxnet3_create_if (vm, &args);
83  rv = args.rv;
84 
85  /* *INDENT-OFF* */
86  REPLY_MACRO2 (VL_API_VMXNET3_CREATE_REPLY + vmxm->msg_id_base,
87  ({
88  rmp->sw_if_index = ntohl (args.sw_if_index);
89  }));
90  /* *INDENT-ON* */
91 }
92 
93 static void *
95 {
96  u8 *s;
97  u32 pci_addr = ntohl (mp->pci_addr);
98 
99  s = format (0, "SCRIPT: vmxnet3_create ");
100  s = format (s, "%U ", format_vlib_pci_addr, &pci_addr);
101  if (mp->enable_elog)
102  s = format (s, "elog ");
103  if (mp->bind)
104  s = format (s, "bind ");
105  if (mp->rxq_size)
106  s = format (s, "rx-queue-size %u ", ntohs (mp->rxq_size));
107  if (mp->txq_size)
108  s = format (s, "tx-queue-size %u ", ntohs (mp->txq_size));
109  if (mp->rxq_num)
110  s = format (s, "num-rx-queues %u ", ntohs (mp->rxq_num));
111  if (mp->txq_num)
112  s = format (s, "num-tx-queues %u ", ntohs (mp->txq_num));
113 
114  FINISH;
115 }
116 
117 static void
119 {
121  vnet_main_t *vnm = vnet_get_main ();
122  vmxnet3_main_t *vmxm = &vmxnet3_main;
123  vl_api_vmxnet3_delete_reply_t *rmp;
124  vmxnet3_device_t *vd;
126  int rv = 0;
127 
128  hw =
130  htonl (mp->sw_if_index));
131  if (hw == NULL || vmxnet3_device_class.index != hw->dev_class_index)
132  {
133  rv = VNET_API_ERROR_INVALID_SW_IF_INDEX;
134  goto reply;
135  }
136 
137  vd = pool_elt_at_index (vmxm->devices, hw->dev_instance);
138 
139  vmxnet3_delete_if (vm, vd);
140 
141 reply:
142  REPLY_MACRO (VL_API_VMXNET3_DELETE_REPLY + vmxm->msg_id_base);
143 }
144 
145 static void *
147 {
148  u8 *s;
149 
150  s = format (0, "SCRIPT: vmxnet3_delete ");
151  s = format (s, "sw_if_index %d ", ntohl (mp->sw_if_index));
152 
153  FINISH;
154 }
155 
156 static void
158  vnet_sw_interface_t * swif, u8 * interface_name,
159  u32 context)
160 {
162  vnet_main_t *vnm = vnet_get_main ();
163  vmxnet3_main_t *vmxm = &vmxnet3_main;
164  vnet_hw_interface_t *hwif;
165  vmxnet3_rx_ring *ring;
166  u16 rid, qid;
167 
168  hwif = vnet_get_sup_hw_interface (vnm, swif->sw_if_index);
169 
170  mp = vl_msg_api_alloc (sizeof (*mp));
171  clib_memset (mp, 0, sizeof (*mp));
172 
173  mp->_vl_msg_id = htons (VL_API_VMXNET3_DETAILS + vmxm->msg_id_base);
174  mp->context = context;
175 
176  mp->sw_if_index = htonl (swif->sw_if_index);
177  strncpy ((char *) mp->if_name,
178  (char *) interface_name, ARRAY_LEN (mp->if_name) - 1);
179 
180  if (hwif->hw_address)
181  memcpy (mp->hw_addr, hwif->hw_address, ARRAY_LEN (mp->hw_addr));
182 
183  mp->version = vd->version;
184  mp->pci_addr = ntohl (vd->pci_addr.as_u32);
185  mp->admin_up_down = (swif->flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) ? 1 : 0;
186 
188  vec_foreach_index (qid, vd->rxqs)
189  {
190  vmxnet3_rxq_t *rxq = vec_elt_at_index (vd->rxqs, qid);
191  vl_api_vmxnet3_rx_list_t *rx_list = &mp->rx_list[qid];
192 
193  ASSERT (qid < VMXNET3_RXQ_MAX);
194  rx_list->rx_qsize = htons (rxq->size);
195  rx_list->rx_next = htons (rxq->rx_comp_ring.next);
196  for (rid = 0; rid < VMXNET3_RX_RING_SIZE; rid++)
197  {
198  ring = &rxq->rx_ring[rid];
199  rx_list->rx_fill[rid] = htons (ring->fill);
200  rx_list->rx_produce[rid] = htons (ring->produce);
201  rx_list->rx_consume[rid] = htons (ring->consume);
202  }
203  }
204 
206  vec_foreach_index (qid, vd->txqs)
207  {
208  vmxnet3_txq_t *txq = vec_elt_at_index (vd->txqs, qid);
209  vl_api_vmxnet3_tx_list_t *tx_list = &mp->tx_list[qid];
210 
211  ASSERT (qid < VMXNET3_TXQ_MAX);
212  tx_list->tx_qsize = htons (txq->size);
213  tx_list->tx_next = htons (txq->tx_comp_ring.next);
214  tx_list->tx_produce = htons (txq->tx_ring.produce);
215  tx_list->tx_consume = htons (txq->tx_ring.consume);
216  }
217 
218  vl_api_send_msg (reg, (u8 *) mp);
219 }
220 
221 /**
222  * @brief Message handler for vmxnet3_dump API.
223  * @param mp vl_api_vmxnet3_dump_t * mp the api message
224  */
225 static void
227 {
228  vmxnet3_main_t *vmxm = &vmxnet3_main;
229  vnet_main_t *vnm = vnet_get_main ();
230  vnet_sw_interface_t *swif;
231  vmxnet3_device_t *vd;
232  u8 *if_name = 0;
234 
236  if (!reg)
237  return;
238 
239  /* *INDENT-OFF* */
240  pool_foreach (vd, vmxm->devices,
241  ({
242  swif = vnet_get_sw_interface (vnm, vd->sw_if_index);
243  if_name = format (if_name, "%U%c", format_vnet_sw_interface_name, vnm,
244  swif, 0);
245  send_vmxnet3_details (reg, vd, swif, if_name, mp->context);
246  _vec_len (if_name) = 0;
247  }));
248  /* *INDENT-ON* */
249 
250  vec_free (if_name);
251 }
252 
253 static void *
255 {
256  u8 *s;
257 
258  s = format (0, "SCRIPT: vmxnet3_dump ");
259 
260  FINISH;
261 }
262 
263 #define vl_msg_name_crc_list
265 #undef vl_msg_name_crc_list
266 
267 static void
269 {
270 #define _(id,n,crc) \
271  vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id + vmxm->msg_id_base);
272  foreach_vl_msg_name_crc_vmxnet3;
273 #undef _
274 }
275 
276 static void
278 {
279 #define _(n,f) api_main.msg_print_handlers \
280  [VL_API_##n + vmxm->msg_id_base] \
281  = (void *) vl_api_##f##_t_print;
283 #undef _
284 }
285 
286 /* set tup the API message handling tables */
287 clib_error_t *
289 {
290  vmxnet3_main_t *vmxm = &vmxnet3_main;
291  api_main_t *am = &api_main;
292  u8 *name;
293 
294  /* construct the API name */
295  name = format (0, "vmxnet3_%08x%c", api_version, 0);
296 
297  /* ask for a correctly-sized block of API message decode slots */
299  ((char *) name, VL_MSG_FIRST_AVAILABLE);
300 
301 #define _(N,n) \
302  vl_msg_api_set_handlers((VL_API_##N + vmxm->msg_id_base), \
303  #n, \
304  vl_api_##n##_t_handler, \
305  vl_noop_handler, \
306  vl_api_##n##_t_endian, \
307  vl_api_##n##_t_print, \
308  sizeof(vl_api_##n##_t), 1);
310 #undef _
311 
312  /* set up the (msg_name, crc, message-id) table */
313  setup_message_id_table (vmxm, am);
314 
316 
317  vec_free (name);
318  return 0;
319 }
320 
321 /*
322  * fd.io coding-style-patch-verification: ON
323  *
324  * Local Variables:
325  * eval: (c-set-style "gnu")
326  * End:
327  */
void vmxnet3_delete_if(vlib_main_t *vm, vmxnet3_device_t *vd)
Definition: vmxnet3.c:842
static void * vl_api_vmxnet3_dump_t_print(vl_api_vmxnet3_dump_t *mp, void *handle)
Definition: vmxnet3_api.c:254
#define vec_foreach_index(var, v)
Iterate over vector indices.
#define clib_min(x, y)
Definition: clib.h:302
Dump all vmxnet3 interfaces.
Definition: vmxnet3.api:143
vnet_main_t * vnet_get_main(void)
Definition: misc.c:46
static vnet_hw_interface_t * vnet_get_sup_hw_interface(vnet_main_t *vnm, u32 sw_if_index)
#define REPLY_MACRO2(t, body)
clib_memset(h->entries, 0, sizeof(h->entries[0]) *entries)
#define VMXNET3_RXQ_MAX
Definition: vmxnet3.h:91
static void vl_api_send_msg(vl_api_registration_t *rp, u8 *elem)
Definition: api.h:35
vlib_pci_addr_t pci_addr
Definition: vmxnet3.h:565
static void send_vmxnet3_details(vl_api_registration_t *reg, vmxnet3_device_t *vd, vnet_sw_interface_t *swif, u8 *interface_name, u32 context)
Definition: vmxnet3_api.c:157
#define FINISH
Definition: vmxnet3_api.c:50
vmxnet3_main_t vmxnet3_main
Definition: vmxnet3.c:28
void vmxnet3_create_if(vlib_main_t *vm, vmxnet3_create_if_args_t *args)
Definition: vmxnet3.c:599
u8 * format(u8 *s, const char *fmt,...)
Definition: format.c:424
void * vl_msg_api_alloc(int nbytes)
unsigned char u8
Definition: types.h:56
static void setup_message_id_table(vmxnet3_main_t *vmxm, api_main_t *am)
Definition: vmxnet3_api.c:268
vmxnet3_rxq_t * rxqs
Definition: vmxnet3.h:569
static void vl_api_vmxnet3_create_t_handler(vl_api_vmxnet3_create_t *mp)
Definition: vmxnet3_api.c:64
#define VMXNET3_TXQ_MAX
Definition: vmxnet3.h:90
#define pool_foreach(VAR, POOL, BODY)
Iterate through pool.
Definition: pool.h:493
static void * vl_api_vmxnet3_delete_t_print(vl_api_vmxnet3_delete_t *mp, void *handle)
Definition: vmxnet3_api.c:146
#define vec_elt_at_index(v, i)
Get vector value at index i checking that i is in bounds.
unsigned int u32
Definition: types.h:88
vlib_pci_addr_t addr
Definition: vmxnet3.h:602
#define pool_elt_at_index(p, i)
Returns pointer to element at given index.
Definition: pool.h:514
Memory interface details structure.
Definition: vmxnet3.api:121
u16 msg_id_base
Definition: vmxnet3.h:593
unsigned short u16
Definition: types.h:57
vmxnet3_rx_comp_ring rx_comp_ring
Definition: vmxnet3.h:522
vmxnet3_tx_comp_ring tx_comp_ring
Definition: vmxnet3.h:551
vl_api_vmxnet3_rx_list_t rx_list[16]
Definition: vmxnet3.api:133
#define VMXNET3_RX_RING_SIZE
Definition: vmxnet3.h:158
#define REPLY_MACRO(t)
vnet_sw_interface_flags_t flags
Definition: interface.h:703
u8 name[64]
Definition: memclnt.api:152
API main structure, used by both vpp and binary API clients.
Definition: api_common.h:203
An API client registration, only in vpp/vlib.
Definition: api_common.h:46
vl_api_vmxnet3_tx_list_t tx_list[8]
Definition: vmxnet3.api:136
vlib_main_t * vm
Definition: buffer.c:323
#define vec_free(V)
Free vector&#39;s memory (no header).
Definition: vec.h:341
static vnet_hw_interface_t * vnet_get_sup_hw_interface_api_visible_or_null(vnet_main_t *vnm, u32 sw_if_index)
#define foreach_vmxnet3_plugin_api_msg
Definition: vmxnet3_api.c:58
#define ARRAY_LEN(x)
Definition: clib.h:63
static vl_api_registration_t * vl_api_client_index_to_registration(u32 index)
Definition: api.h:57
vmxnet3_txq_t * txqs
Definition: vmxnet3.h:570
static void vl_api_vmxnet3_delete_t_handler(vl_api_vmxnet3_delete_t *mp)
Definition: vmxnet3_api.c:118
#define ASSERT(truth)
vmxnet3_rx_list structure
Definition: vmxnet3.api:99
static void plugin_custom_dump_configure(vmxnet3_main_t *vmxm)
Definition: vmxnet3_api.c:277
clib_error_t * vmxnet3_plugin_api_hookup(vlib_main_t *vm)
Definition: vmxnet3_api.c:288
static vlib_main_t * vlib_get_main(void)
Definition: global_funcs.h:23
#define vec_len(v)
Number of elements in vector (rvalue-only, NULL tolerant)
vnet_device_class_t vmxnet3_device_class
vmxnet3_rx_ring rx_ring[VMXNET3_RX_RING_SIZE]
Definition: vmxnet3.h:519
vmxnet3_tx_list structure
Definition: vmxnet3.api:83
vmxnet3_device_t * devices
Definition: vmxnet3.h:592
static void * vl_api_vmxnet3_create_t_print(vl_api_vmxnet3_create_t *mp, void *handle)
Definition: vmxnet3_api.c:94
static void vl_api_vmxnet3_dump_t_handler(vl_api_vmxnet3_dump_t *mp)
Message handler for vmxnet3_dump API.
Definition: vmxnet3_api.c:226
vmxnet3_tx_ring tx_ring
Definition: vmxnet3.h:550
u32 context
Definition: gre.api:45
api_main_t api_main
Definition: api_shared.c:35
format_function_t format_vlib_pci_addr
Definition: pci.h:324
u16 vl_msg_api_get_msg_ids(const char *name, int n)
Definition: api_shared.c:957