FD.io VPP  v19.04.4-rc0-5-ge88582fac
Vector Packet Processing
lacp_api.c
Go to the documentation of this file.
1 /*
2  *------------------------------------------------------------------
3  * lacp_api.c - lacp api
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 <vlib/vlib.h>
21 #include <vnet/ethernet/ethernet.h>
22 #include <vlib/unix/unix.h>
23 #include <lacp/node.h>
24 
25 #include <vlibapi/api.h>
26 #include <vlibmemory/api.h>
27 
28 
29 /* define message IDs */
30 #include <lacp/lacp_msg_enum.h>
31 
32 /* define message structures */
33 #define vl_typedefs
34 #include <lacp/lacp_all_api_h.h>
35 #undef vl_typedefs
36 
37 /* define generated endian-swappers */
38 #define vl_endianfun
39 #include <lacp/lacp_all_api_h.h>
40 #undef vl_endianfun
41 
42 /* instantiate all the print functions we know about */
43 #define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__)
44 #define vl_printfun
45 #include <lacp/lacp_all_api_h.h>
46 #undef vl_printfun
47 
48 /* Get the API version number */
49 #define vl_api_version(n,v) static u32 api_version=(v);
50 #include <lacp/lacp_all_api_h.h>
51 #undef vl_api_version
52 
53 #define REPLY_MSG_ID_BASE lm->msg_id_base
55 
56 #define foreach_lacp_plugin_api_msg \
57 _(SW_INTERFACE_LACP_DUMP, sw_interface_lacp_dump)
58 
59 static void
61  lacp_interface_details_t * lacp_if,
62  u32 context)
63 {
64  lacp_main_t *lm = &lacp_main;
66 
67  mp = vl_msg_api_alloc (sizeof (*mp));
68  clib_memset (mp, 0, sizeof (*mp));
69  mp->_vl_msg_id = htons (VL_API_SW_INTERFACE_LACP_DETAILS + lm->msg_id_base);
70  mp->sw_if_index = htonl (lacp_if->sw_if_index);
71 
72  /* These fields in network order already */
74  mp->actor_key = lacp_if->actor_key;
76  mp->actor_port_number = lacp_if->actor_port_number;
77  mp->actor_state = lacp_if->actor_state;
78  clib_memcpy (mp->actor_system, lacp_if->actor_system, 6);
80  mp->partner_key = lacp_if->partner_key;
83  mp->partner_state = lacp_if->partner_state;
84 
85  clib_memcpy (mp->partner_system, lacp_if->partner_system, 6);
87  MIN (ARRAY_LEN (mp->interface_name) - 1,
88  strlen ((const char *) lacp_if->interface_name)));
91  strlen ((const char *) lacp_if->bond_interface_name)));
92  mp->rx_state = htonl (lacp_if->rx_state);
93  mp->tx_state = htonl (lacp_if->tx_state);
94  mp->mux_state = htonl (lacp_if->mux_state);
95  mp->ptx_state = htonl (lacp_if->ptx_state);
96 
97  mp->context = context;
98  vl_api_send_msg (reg, (u8 *) mp);
99 }
100 
101 /**
102  * @brief Message handler for lacp_dump API.
103  * @param mp vl_api_lacp_dump_t * mp the api message
104  */
105 void
107 {
108  int rv;
110  lacp_interface_details_t *lacpifs = NULL;
111  lacp_interface_details_t *lacp_if = NULL;
112 
114  if (!reg)
115  return;
116 
117  rv = lacp_dump_ifs (&lacpifs);
118  if (rv)
119  return;
120 
121  vec_foreach (lacp_if, lacpifs)
122  {
123  lacp_send_sw_interface_details (reg, lacp_if, mp->context);
124  }
125 
126  vec_free (lacpifs);
127 }
128 
129 #define vl_msg_name_crc_list
130 #include <lacp/lacp_all_api_h.h>
131 #undef vl_msg_name_crc_list
132 
133 static void
135 {
136 #define _(id,n,crc) \
137  vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id + lm->msg_id_base);
138  foreach_vl_msg_name_crc_lacp;
139 #undef _
140 }
141 
142 /* Set up the API message handling tables */
143 clib_error_t *
145 {
146  lacp_main_t *lm = &lacp_main;
147  api_main_t *am = &api_main;
148  u8 *name;
149 
150  /* Construct the API name */
151  name = format (0, "lacp_%08x%c", api_version, 0);
152 
153  /* Ask for a correctly-sized block of API message decode slots */
155  ((char *) name, VL_MSG_FIRST_AVAILABLE);
156 
157 #define _(N,n) \
158  vl_msg_api_set_handlers((VL_API_##N + lm->msg_id_base), \
159  #n, \
160  vl_api_##n##_t_handler, \
161  vl_noop_handler, \
162  vl_api_##n##_t_endian, \
163  vl_api_##n##_t_print, \
164  sizeof(vl_api_##n##_t), 1);
166 #undef _
167 
168  /*
169  * Set up the (msg_name, crc, message-id) table
170  */
171  setup_message_id_table (lm, am);
172 
173  vec_free (name);
174  return 0;
175 }
176 
177 /*
178  * fd.io coding-style-patch-verification: ON
179  *
180  * Local Variables:
181  * eval: (c-set-style "gnu")
182  * End:
183  */
u8 interface_name[64]
Definition: node.h:93
#define NULL
Definition: clib.h:58
clib_memset(h->entries, 0, sizeof(h->entries[0]) *entries)
static void vl_api_send_msg(vl_api_registration_t *rp, u8 *elem)
Definition: api.h:34
static void lacp_send_sw_interface_details(vl_api_registration_t *reg, lacp_interface_details_t *lacp_if, u32 context)
Definition: lacp_api.c:60
int lacp_dump_ifs(lacp_interface_details_t **out_lacpifs)
Definition: cli.c:21
void vl_api_sw_interface_lacp_dump_t_handler(vl_api_sw_interface_lacp_dump_t *mp)
Message handler for lacp_dump API.
Definition: lacp_api.c:106
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
#define clib_memcpy(d, s, n)
Definition: string.h:180
unsigned int u32
Definition: types.h:88
#define MIN(x, y)
Definition: node.h:31
LACP interface details struct.
Definition: node.h:90
Reply for lacp dump request.
Definition: lacp.api:52
static void setup_message_id_table(lacp_main_t *lm, api_main_t *am)
Definition: lacp_api.c:134
#define foreach_lacp_plugin_api_msg
Definition: lacp_api.c:56
u8 name[64]
Definition: memclnt.api:152
API main structure, used by both vpp and binary API clients.
Definition: api_common.h:202
An API client registration, only in vpp/vlib.
Definition: api_common.h:45
Dump lacp interfaces request.
Definition: lacp.api:25
u8 bond_interface_name[64]
Definition: node.h:98
vlib_main_t * vm
Definition: buffer.c:312
#define vec_free(V)
Free vector&#39;s memory (no header).
Definition: vec.h:341
u32 context
Definition: ipsec_gre.api:33
#define ARRAY_LEN(x)
Definition: clib.h:62
lacp_main_t lacp_main
Definition: lacp.c:25
clib_error_t * lacp_plugin_api_hookup(vlib_main_t *vm)
Definition: lacp_api.c:144
static vl_api_registration_t * vl_api_client_index_to_registration(u32 index)
Definition: api.h:56
#define vec_foreach(var, vec)
Vector iterator.
u16 msg_id_base
API message ID base.
Definition: node.h:116
api_main_t api_main
Definition: api_shared.c:35
u16 vl_msg_api_get_msg_ids(const char *name, int n)
Definition: api_shared.c:880