FD.io VPP  v19.08-24-ge6a5712
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
56 {
58  int rv;
59  vl_api_bond_delete_reply_t *rmp;
60  u32 sw_if_index = ntohl (mp->sw_if_index);
61 
62  rv = bond_delete_if (vm, sw_if_index);
63 
64  REPLY_MACRO (VL_API_BOND_DELETE_REPLY);
65 }
66 
67 static void
69 {
72  bond_create_if_args_t _a, *ap = &_a;
73 
74  clib_memset (ap, 0, sizeof (*ap));
75 
76  ap->id = ntohl (mp->id);
77 
78  if (mp->use_custom_mac)
79  {
80  clib_memcpy (ap->hw_addr, mp->mac_address, 6);
81  ap->hw_addr_set = 1;
82  }
83 
84  ap->mode = mp->mode;
85  ap->lb = mp->lb;
86  ap->numa_only = mp->numa_only;
87  bond_create_if (vm, ap);
88 
89  int rv = ap->rv;
90 
91  /* *INDENT-OFF* */
92  REPLY_MACRO2(VL_API_BOND_CREATE_REPLY,
93  ({
94  rmp->sw_if_index = ntohl (ap->sw_if_index);
95  }));
96  /* *INDENT-ON* */
97 }
98 
99 static void
101 {
104  bond_enslave_args_t _a, *ap = &_a;
105  int rv = 0;
106 
107  clib_memset (ap, 0, sizeof (*ap));
108 
109  ap->group = ntohl (mp->bond_sw_if_index);
110  ap->slave = ntohl (mp->sw_if_index);
111  ap->is_passive = mp->is_passive;
113 
114  bond_enslave (vm, ap);
115 
116  REPLY_MACRO (VL_API_BOND_ENSLAVE_REPLY);
117 }
118 
119 static void
121 {
123  vl_api_bond_detach_slave_reply_t *rmp;
124  bond_detach_slave_args_t _a, *ap = &_a;
125  int rv = 0;
126 
127  clib_memset (ap, 0, sizeof (*ap));
128 
129  ap->slave = ntohl (mp->sw_if_index);
130  bond_detach_slave (vm, ap);
131 
132  REPLY_MACRO (VL_API_BOND_DETACH_SLAVE_REPLY);
133 }
134 
135 static void
137  vl_api_registration_t * reg,
138  bond_interface_details_t * bond_if,
139  u32 context)
140 {
142 
143  mp = vl_msg_api_alloc (sizeof (*mp));
144  clib_memset (mp, 0, sizeof (*mp));
145  mp->_vl_msg_id = htons (VL_API_SW_INTERFACE_BOND_DETAILS);
146  mp->sw_if_index = htonl (bond_if->sw_if_index);
147  mp->id = htonl (bond_if->id);
149  MIN (ARRAY_LEN (mp->interface_name) - 1,
150  strlen ((const char *) bond_if->interface_name)));
151  mp->mode = bond_if->mode;
152  mp->lb = bond_if->lb;
153  mp->numa_only = bond_if->numa_only;
154  mp->active_slaves = htonl (bond_if->active_slaves);
155  mp->slaves = htonl (bond_if->slaves);
156 
157  mp->context = context;
158  vl_api_send_msg (reg, (u8 *) mp);
159 }
160 
161 static void
163 {
164  int rv;
167  bond_interface_details_t *bondifs = NULL;
168  bond_interface_details_t *bond_if = NULL;
169 
171  if (!reg)
172  return;
173 
174  rv = bond_dump_ifs (&bondifs);
175  if (rv)
176  return;
177 
178  vec_foreach (bond_if, bondifs)
179  {
180  bond_send_sw_interface_details (am, reg, bond_if, mp->context);
181  }
182 
183  vec_free (bondifs);
184 }
185 
186 static void
188  vl_api_registration_t * reg,
189  slave_interface_details_t * slave_if,
190  u32 context)
191 {
193 
194  mp = vl_msg_api_alloc (sizeof (*mp));
195  clib_memset (mp, 0, sizeof (*mp));
196  mp->_vl_msg_id = htons (VL_API_SW_INTERFACE_SLAVE_DETAILS);
197  mp->sw_if_index = htonl (slave_if->sw_if_index);
198  clib_memcpy (mp->interface_name, slave_if->interface_name,
199  MIN (ARRAY_LEN (mp->interface_name) - 1,
200  strlen ((const char *) slave_if->interface_name)));
201  mp->is_passive = slave_if->is_passive;
202  mp->is_long_timeout = slave_if->is_long_timeout;
203 
204  mp->context = context;
205  vl_api_send_msg (reg, (u8 *) mp);
206 }
207 
208 static void
210  mp)
211 {
212  int rv;
215  slave_interface_details_t *slaveifs = NULL;
216  slave_interface_details_t *slave_if = NULL;
217 
219  if (!reg)
220  return;
221 
222  rv = bond_dump_slave_ifs (&slaveifs, ntohl (mp->sw_if_index));
223  if (rv)
224  return;
225 
226  vec_foreach (slave_if, slaveifs)
227  {
228  bond_send_sw_interface_slave_details (am, reg, slave_if, mp->context);
229  }
230 
231  vec_free (slaveifs);
232 }
233 
234 #define vl_msg_name_crc_list
235 #include <vnet/vnet_all_api_h.h>
236 #undef vl_msg_name_crc_list
237 
238 static void
240 {
241 #define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id);
242  foreach_vl_msg_name_crc_bond;
243 #undef _
244 }
245 
246 static clib_error_t *
248 {
249  api_main_t *am = &api_main;
250 
251 #define _(N,n) \
252  vl_msg_api_set_handlers(VL_API_##N, #n, \
253  vl_api_##n##_t_handler, \
254  vl_noop_handler, \
255  vl_api_##n##_t_endian, \
256  vl_api_##n##_t_print, \
257  sizeof(vl_api_##n##_t), 1);
259 #undef _
260 
261  /*
262  * Set up the (msg_name, crc, message-id) table
263  */
265 
266  return 0;
267 }
268 
270 
271 /*
272  * fd.io coding-style-patch-verification: ON
273  *
274  * Local Variables:
275  * eval: (c-set-style "gnu")
276  * End:
277  */
static clib_error_t * bond_api_hookup(vlib_main_t *vm)
Definition: bond_api.c:247
int bond_delete_if(vlib_main_t *vm, u32 sw_if_index)
Definition: cli.c:285
static void vl_api_bond_detach_slave_t_handler(vl_api_bond_detach_slave_t *mp)
Definition: bond_api.c:120
#define foreach_bond_api_msg
Definition: bond_api.c:46
Reply for bond create reply.
Definition: bond.api:51
int bond_dump_ifs(bond_interface_details_t **out_bondifs)
Definition: cli.c:172
#define REPLY_MACRO2(t, body)
#define NULL
Definition: clib.h:58
u8 is_long_timeout
Definition: node.h:99
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:68
static void vl_api_bond_delete_t_handler(vl_api_bond_delete_t *mp)
Definition: bond_api.c:55
clib_memset(h->entries, 0, sizeof(h->entries[0])*entries)
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:209
vl_api_interface_index_t sw_if_index
Definition: gre.api:50
static void vl_api_sw_interface_bond_dump_t_handler(vl_api_sw_interface_bond_dump_t *mp)
Definition: bond_api.c:162
void bond_enslave(vlib_main_t *vm, bond_enslave_args_t *args)
Definition: cli.c:542
Reply for bond enslave reply.
Definition: bond.api:92
unsigned int u32
Definition: types.h:88
#define MIN(x, y)
Definition: node.h:31
#define REPLY_MACRO(t)
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:136
Dump bond interfaces request.
Definition: bond.api:111
API main structure, used by both vpp and binary API clients.
Definition: api_common.h:203
void bond_detach_slave(vlib_main_t *vm, bond_detach_slave_args_t *args)
Definition: cli.c:731
Initialize a new bond interface with the given paramters.
Definition: bond.api:78
An API client registration, only in vpp/vlib.
Definition: api_common.h:46
vlib_main_t * vm
Definition: buffer.c:312
#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:187
Initialize a new bond interface with the given paramters.
Definition: bond.api:34
#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:114
bond detach slave
Definition: bond.api:103
void bond_create_if(vlib_main_t *vm, bond_create_if_args_t *args)
Definition: cli.c:334
Reply for bond dump request.
Definition: bond.api:127
static void bond_setup_message_id_table(api_main_t *am)
Definition: bond_api.c:239
Delete bond interface.
Definition: bond.api:63
static void vl_api_bond_enslave_t_handler(vl_api_bond_enslave_t *mp)
Definition: bond_api.c:100
static vlib_main_t * vlib_get_main(void)
Definition: global_funcs.h:23
int bond_dump_slave_ifs(slave_interface_details_t **out_slaveifs, u32 bond_sw_if_index)
Definition: cli.c:205
slave interface details struct
Definition: node.h:127
Reply for slave dump request.
Definition: bond.api:158
#define vec_foreach(var, vec)
Vector iterator.
vpe_api_main_t vpe_api_main
Definition: interface_api.c:49
u32 context
Definition: gre.api:45
api_main_t api_main
Definition: api_shared.c:35