FD.io VPP  v19.01.3-6-g70449b9b9
Vector Packet Processing
bond_api.c
Go to the documentation of this file.
1 /*
2  *------------------------------------------------------------------
3  * bond_api.c - vnet bonding device driver API support
4  *
5  * Copyright (c) 2017 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 
20 #include <vnet/vnet.h>
21 #include <vlibmemory/api.h>
22 
23 #include <vnet/interface.h>
24 #include <vnet/api_errno.h>
25 #include <vnet/ethernet/ethernet.h>
26 
27 #include <vnet/vnet_msg_enum.h>
28 
29 #define vl_typedefs /* define message structures */
30 #include <vnet/vnet_all_api_h.h>
31 #undef vl_typedefs
32 
33 #define vl_endianfun /* define message structures */
34 #include <vnet/vnet_all_api_h.h>
35 #undef vl_endianfun
36 
37 /* instantiate all the print functions we know about */
38 #define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__)
39 #define vl_printfun
40 #include <vnet/vnet_all_api_h.h>
41 #undef vl_printfun
42 
44 #include <vnet/bonding/node.h>
45 
46 #define foreach_bond_api_msg \
47 _(BOND_CREATE, bond_create) \
48 _(BOND_DELETE, bond_delete) \
49 _(BOND_ENSLAVE, bond_enslave) \
50 _(BOND_DETACH_SLAVE, bond_detach_slave) \
51 _(SW_INTERFACE_BOND_DUMP, sw_interface_bond_dump)\
52 _(SW_INTERFACE_SLAVE_DUMP, sw_interface_slave_dump)
53 
54 static void
58 {
60 
61  mp = vl_msg_api_alloc (sizeof (*mp));
62  clib_memset (mp, 0, sizeof (*mp));
63  mp->_vl_msg_id = ntohs (VL_API_SW_INTERFACE_EVENT);
64  mp->sw_if_index = ntohl (sw_if_index);
65 
66  mp->admin_up_down = 0;
67  mp->link_up_down = 0;
68  mp->deleted = 1;
69  vl_msg_api_send_shmem (q, (u8 *) & mp);
70 }
71 
72 static void
74 {
76  int rv;
78  vl_api_bond_delete_reply_t *rmp;
80  u32 sw_if_index = ntohl (mp->sw_if_index);
81 
82  rv = bond_delete_if (vm, sw_if_index);
83 
85  if (!q)
86  return;
87 
88  rmp = vl_msg_api_alloc (sizeof (*rmp));
89  rmp->_vl_msg_id = ntohs (VL_API_BOND_DELETE_REPLY);
90  rmp->context = mp->context;
91  rmp->retval = ntohl (rv);
92 
93  vl_msg_api_send_shmem (q, (u8 *) & rmp);
94 
95  if (!rv)
96  bond_send_sw_interface_event_deleted (vam, q, sw_if_index);
97 }
98 
99 static void
101 {
105  bond_create_if_args_t _a, *ap = &_a;
106 
107  clib_memset (ap, 0, sizeof (*ap));
108 
109  ap->id = ntohl (mp->id);
110 
111  if (mp->use_custom_mac)
112  {
113  clib_memcpy (ap->hw_addr, mp->mac_address, 6);
114  ap->hw_addr_set = 1;
115  }
116 
117  ap->mode = mp->mode;
118  ap->lb = mp->lb;
119  bond_create_if (vm, ap);
120 
122  if (!q)
123  return;
124 
125  if (ap->rv != 0)
126  return;
127  rmp = vl_msg_api_alloc (sizeof (*rmp));
128  rmp->_vl_msg_id = ntohs (VL_API_BOND_CREATE_REPLY);
129  rmp->context = mp->context;
130  rmp->retval = ntohl (ap->rv);
131  rmp->sw_if_index = ntohl (ap->sw_if_index);
132 
133  vl_msg_api_send_shmem (q, (u8 *) & rmp);
134 }
135 
136 static void
138 {
142  bond_enslave_args_t _a, *ap = &_a;
143 
144  clib_memset (ap, 0, sizeof (*ap));
145 
146  ap->group = ntohl (mp->bond_sw_if_index);
147  ap->slave = ntohl (mp->sw_if_index);
148  ap->is_passive = mp->is_passive;
150 
151  bond_enslave (vm, ap);
152 
154  if (!q)
155  return;
156 
157  rmp = vl_msg_api_alloc (sizeof (*rmp));
158  rmp->_vl_msg_id = ntohs (VL_API_BOND_ENSLAVE_REPLY);
159  rmp->context = mp->context;
160  rmp->retval = ntohl (ap->rv);
161 
162  vl_msg_api_send_shmem (q, (u8 *) & rmp);
163 }
164 
165 static void
167 {
169  vl_api_bond_detach_slave_reply_t *rmp;
171  bond_detach_slave_args_t _a, *ap = &_a;
172 
173  clib_memset (ap, 0, sizeof (*ap));
174 
175  ap->slave = ntohl (mp->sw_if_index);
176  bond_detach_slave (vm, ap);
177 
179  if (!q)
180  return;
181 
182  rmp = vl_msg_api_alloc (sizeof (*rmp));
183  rmp->_vl_msg_id = ntohs (VL_API_BOND_DETACH_SLAVE_REPLY);
184  rmp->context = mp->context;
185  rmp->retval = htonl (ap->rv);
186 
187  vl_msg_api_send_shmem (q, (u8 *) & rmp);
188 }
189 
190 static void
192  vl_api_registration_t * reg,
193  bond_interface_details_t * bond_if,
194  u32 context)
195 {
197 
198  mp = vl_msg_api_alloc (sizeof (*mp));
199  clib_memset (mp, 0, sizeof (*mp));
200  mp->_vl_msg_id = htons (VL_API_SW_INTERFACE_BOND_DETAILS);
201  mp->sw_if_index = htonl (bond_if->sw_if_index);
202  mp->id = htonl (bond_if->id);
204  MIN (ARRAY_LEN (mp->interface_name) - 1,
205  strlen ((const char *) bond_if->interface_name)));
206  mp->mode = bond_if->mode;
207  mp->lb = bond_if->lb;
208  mp->active_slaves = htonl (bond_if->active_slaves);
209  mp->slaves = htonl (bond_if->slaves);
210 
211  mp->context = context;
212  vl_api_send_msg (reg, (u8 *) mp);
213 }
214 
215 static void
217 {
218  int rv;
221  bond_interface_details_t *bondifs = NULL;
222  bond_interface_details_t *bond_if = NULL;
223 
225  if (!reg)
226  return;
227 
228  rv = bond_dump_ifs (&bondifs);
229  if (rv)
230  return;
231 
232  vec_foreach (bond_if, bondifs)
233  {
234  bond_send_sw_interface_details (am, reg, bond_if, mp->context);
235  }
236 
237  vec_free (bondifs);
238 }
239 
240 static void
242  vl_api_registration_t * reg,
243  slave_interface_details_t * slave_if,
244  u32 context)
245 {
247 
248  mp = vl_msg_api_alloc (sizeof (*mp));
249  clib_memset (mp, 0, sizeof (*mp));
250  mp->_vl_msg_id = htons (VL_API_SW_INTERFACE_SLAVE_DETAILS);
251  mp->sw_if_index = htonl (slave_if->sw_if_index);
252  clib_memcpy (mp->interface_name, slave_if->interface_name,
253  MIN (ARRAY_LEN (mp->interface_name) - 1,
254  strlen ((const char *) slave_if->interface_name)));
255  mp->is_passive = slave_if->is_passive;
256  mp->is_long_timeout = slave_if->is_long_timeout;
257 
258  mp->context = context;
259  vl_api_send_msg (reg, (u8 *) mp);
260 }
261 
262 static void
264  mp)
265 {
266  int rv;
269  slave_interface_details_t *slaveifs = NULL;
270  slave_interface_details_t *slave_if = NULL;
271 
273  if (!reg)
274  return;
275 
276  rv = bond_dump_slave_ifs (&slaveifs, ntohl (mp->sw_if_index));
277  if (rv)
278  return;
279 
280  vec_foreach (slave_if, slaveifs)
281  {
282  bond_send_sw_interface_slave_details (am, reg, slave_if, mp->context);
283  }
284 
285  vec_free (slaveifs);
286 }
287 
288 #define vl_msg_name_crc_list
289 #include <vnet/vnet_all_api_h.h>
290 #undef vl_msg_name_crc_list
291 
292 static void
294 {
295 #define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id);
296  foreach_vl_msg_name_crc_bond;
297 #undef _
298 }
299 
300 static clib_error_t *
302 {
303  api_main_t *am = &api_main;
304 
305 #define _(N,n) \
306  vl_msg_api_set_handlers(VL_API_##N, #n, \
307  vl_api_##n##_t_handler, \
308  vl_noop_handler, \
309  vl_api_##n##_t_endian, \
310  vl_api_##n##_t_print, \
311  sizeof(vl_api_##n##_t), 1);
313 #undef _
314 
315  /*
316  * Set up the (msg_name, crc, message-id) table
317  */
319 
320  return 0;
321 }
322 
324 
325 /*
326  * fd.io coding-style-patch-verification: ON
327  *
328  * Local Variables:
329  * eval: (c-set-style "gnu")
330  * End:
331  */
static clib_error_t * bond_api_hookup(vlib_main_t *vm)
Definition: bond_api.c:301
int bond_delete_if(vlib_main_t *vm, u32 sw_if_index)
Definition: cli.c:194
static void vl_api_bond_detach_slave_t_handler(vl_api_bond_detach_slave_t *mp)
Definition: bond_api.c:166
#define foreach_bond_api_msg
Definition: bond_api.c:46
Reply for bond create reply.
Definition: bond.api:49
int bond_dump_ifs(bond_interface_details_t **out_bondifs)
Definition: cli.c:82
#define NULL
Definition: clib.h:58
clib_memset(h->entries, 0, sizeof(h->entries[0]) *entries)
u8 is_long_timeout
Definition: node.h:98
static void vl_api_send_msg(vl_api_registration_t *rp, u8 *elem)
Definition: api.h:34
static void vl_api_bond_create_t_handler(vl_api_bond_create_t *mp)
Definition: bond_api.c:100
static void vl_api_bond_delete_t_handler(vl_api_bond_delete_t *mp)
Definition: bond_api.c:73
void * vl_msg_api_alloc(int nbytes)
unsigned char u8
Definition: types.h:56
#define clib_memcpy(d, s, n)
Definition: string.h:180
static void vl_api_sw_interface_slave_dump_t_handler(vl_api_sw_interface_slave_dump_t *mp)
Definition: bond_api.c:263
static void vl_api_sw_interface_bond_dump_t_handler(vl_api_sw_interface_bond_dump_t *mp)
Definition: bond_api.c:216
u32 sw_if_index
Definition: vxlan_gbp.api:37
svm_queue_t unix_shared_memory_queue_t
Definition: queue.h:132
void bond_enslave(vlib_main_t *vm, bond_enslave_args_t *args)
Definition: cli.c:436
Reply for bond enslave reply.
Definition: bond.api:90
unsigned int u32
Definition: types.h:88
#define MIN(x, y)
Definition: node.h:31
VLIB_API_INIT_FUNCTION(bond_api_hookup)
static void bond_send_sw_interface_details(vpe_api_main_t *am, vl_api_registration_t *reg, bond_interface_details_t *bond_if, u32 context)
Definition: bond_api.c:191
Dump bond interfaces request.
Definition: bond.api:109
API main structure, used by both vpp and binary API clients.
Definition: api_common.h:202
void bond_detach_slave(vlib_main_t *vm, bond_detach_slave_args_t *args)
Definition: cli.c:625
Initialize a new bond interface with the given paramters.
Definition: bond.api:76
An API client registration, only in vpp/vlib.
Definition: api_common.h:45
void vl_msg_api_send_shmem(svm_queue_t *q, u8 *elem)
vlib_main_t * vm
Definition: buffer.c:301
svm_queue_t * vl_api_client_index_to_input_queue(u32 index)
Definition: memory_api.c:799
#define vec_free(V)
Free vector&#39;s memory (no header).
Definition: vec.h:341
static void bond_send_sw_interface_slave_details(vpe_api_main_t *am, vl_api_registration_t *reg, slave_interface_details_t *slave_if, u32 context)
Definition: bond_api.c:241
Initialize a new bond interface with the given paramters.
Definition: bond.api:33
#define ARRAY_LEN(x)
Definition: clib.h:62
static vl_api_registration_t * vl_api_client_index_to_registration(u32 index)
Definition: api.h:56
BOND interface details struct.
Definition: node.h:113
bond detach slave
Definition: bond.api:101
void bond_create_if(vlib_main_t *vm, bond_create_if_args_t *args)
Definition: cli.c:243
Reply for bond dump request.
Definition: bond.api:124
static void bond_setup_message_id_table(api_main_t *am)
Definition: bond_api.c:293
Delete bond interface.
Definition: bond.api:61
static void vl_api_bond_enslave_t_handler(vl_api_bond_enslave_t *mp)
Definition: bond_api.c:137
static vlib_main_t * vlib_get_main(void)
Definition: global_funcs.h:23
Interface Event generated by want_interface_events.
Definition: interface.api:89
int bond_dump_slave_ifs(slave_interface_details_t **out_slaveifs, u32 bond_sw_if_index)
Definition: cli.c:114
static void bond_send_sw_interface_event_deleted(vpe_api_main_t *am, unix_shared_memory_queue_t *q, u32 sw_if_index)
Definition: bond_api.c:55
slave interface details struct
Definition: node.h:125
Reply for slave dump request.
Definition: bond.api:154
#define vec_foreach(var, vec)
Vector iterator.
vpe_api_main_t vpe_api_main
Definition: pipe_api.c:39
api_main_t api_main
Definition: api_shared.c:35