2 *------------------------------------------------------------------
3 * flow_api.c - flow api
5 * Copyright (c) 2020 Intel 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:
10 * http://www.apache.org/licenses/LICENSE-2.0
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 *------------------------------------------------------------------
22 #include <vnet/vnet.h>
23 #include <vlibmemory/api.h>
24 #include <vnet/interface.h>
25 #include <vnet/api_errno.h>
26 #include <vnet/flow/flow.h>
27 #include <vnet/fib/fib_table.h>
28 #include <vnet/tunnel/tunnel_types_api.h>
29 #include <vnet/ip/ip_types_api.h>
30 #include <vnet/vnet_msg_enum.h>
32 #define vl_typedefs /* define message structures */
33 #include <vnet/vnet_all_api_h.h>
36 #define vl_endianfun /* define message structures */
37 #include <vnet/vnet_all_api_h.h>
40 /* instantiate all the print functions we know about */
41 #define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__)
43 #include <vnet/vnet_all_api_h.h>
46 #include <vlibapi/api_helper_macros.h>
48 #define foreach_vpe_api_msg \
49 _(FLOW_ADD, flow_add) \
50 _(FLOW_DEL, flow_del) \
51 _(FLOW_ENABLE, flow_enable) \
52 _(FLOW_DISABLE, flow_disable)
55 ipv4_addr_and_mask_convert (vl_api_ip4_address_and_mask_t * vl_api_addr,
56 ip4_address_and_mask_t * vnet_addr)
58 clib_memcpy (vnet_addr, vl_api_addr, sizeof (*vnet_addr));
62 ipv6_addr_and_mask_convert (vl_api_ip6_address_and_mask_t * vl_api_addr,
63 ip6_address_and_mask_t * vnet_addr)
65 clib_memcpy (vnet_addr, vl_api_addr, sizeof (*vnet_addr));
69 port_and_mask_convert (vl_api_ip_port_and_mask_t * vl_api_port,
70 ip_port_and_mask_t * vnet_port)
72 vnet_port->port = ntohs (vl_api_port->port);
73 vnet_port->mask = ntohs (vl_api_port->mask);
77 ipv4_n_tuple_flow_convert (vl_api_flow_ip4_n_tuple_t * vl_api_flow,
78 vnet_flow_ip4_n_tuple_t * f)
80 ipv4_addr_and_mask_convert (&vl_api_flow->src_addr, &f->src_addr);
81 ipv4_addr_and_mask_convert (&vl_api_flow->dst_addr, &f->dst_addr);
83 port_and_mask_convert (&vl_api_flow->src_port, &f->src_port);
84 port_and_mask_convert (&vl_api_flow->dst_port, &f->dst_port);
86 f->protocol = (ip_protocol_t) vl_api_flow->protocol;
90 ipv6_n_tuple_flow_convert (vl_api_flow_ip6_n_tuple_t * vl_api_flow,
91 vnet_flow_ip6_n_tuple_t * f)
93 ipv6_addr_and_mask_convert (&vl_api_flow->src_addr, &f->src_addr);
94 ipv6_addr_and_mask_convert (&vl_api_flow->dst_addr, &f->dst_addr);
96 port_and_mask_convert (&vl_api_flow->src_port, &f->src_port);
97 port_and_mask_convert (&vl_api_flow->dst_port, &f->dst_port);
99 f->protocol = (ip_protocol_t) vl_api_flow->protocol;
103 ipv4_n_tuple_tagged_flow_convert (vl_api_flow_ip4_n_tuple_tagged_t *
105 vnet_flow_ip4_n_tuple_tagged_t * f)
107 return ipv4_n_tuple_flow_convert ((vl_api_flow_ip4_n_tuple_t *) vl_api_flow,
108 (vnet_flow_ip4_n_tuple_t *) f);
112 ipv6_n_tuple_tagged_flow_convert (vl_api_flow_ip6_n_tuple_tagged_t *
114 vnet_flow_ip6_n_tuple_tagged_t * f)
116 return ipv6_n_tuple_flow_convert ((vl_api_flow_ip6_n_tuple_t *) vl_api_flow,
117 (vnet_flow_ip6_n_tuple_t *) f);
121 ipv4_l2tpv3oip_flow_convert (vl_api_flow_ip4_l2tpv3oip_t * vl_api_flow,
122 vnet_flow_ip4_l2tpv3oip_t * f)
124 ipv4_addr_and_mask_convert (&vl_api_flow->src_addr, &f->src_addr);
125 ipv4_addr_and_mask_convert (&vl_api_flow->dst_addr, &f->dst_addr);
127 f->protocol = (ip_protocol_t) vl_api_flow->protocol;
128 f->session_id = ntohl (vl_api_flow->session_id);
132 ipv4_ipsec_esp_flow_convert (vl_api_flow_ip4_ipsec_esp_t * vl_api_flow,
133 vnet_flow_ip4_ipsec_esp_t * f)
135 ipv4_addr_and_mask_convert (&vl_api_flow->src_addr, &f->src_addr);
136 ipv4_addr_and_mask_convert (&vl_api_flow->dst_addr, &f->dst_addr);
138 f->protocol = (ip_protocol_t) vl_api_flow->protocol;
139 f->spi = ntohl (vl_api_flow->spi);
143 ipv4_ipsec_ah_flow_convert (vl_api_flow_ip4_ipsec_ah_t * vl_api_flow,
144 vnet_flow_ip4_ipsec_ah_t * f)
146 ipv4_addr_and_mask_convert (&vl_api_flow->src_addr, &f->src_addr);
147 ipv4_addr_and_mask_convert (&vl_api_flow->dst_addr, &f->dst_addr);
149 f->protocol = (ip_protocol_t) vl_api_flow->protocol;
150 f->spi = ntohl (vl_api_flow->spi);
154 ipv4_gtpu_flow_convert (vl_api_flow_ip4_gtpu_t * vl_api_flow,
155 vnet_flow_ip4_gtpu_t * f)
157 ipv4_addr_and_mask_convert (&vl_api_flow->src_addr, &f->src_addr);
158 ipv4_addr_and_mask_convert (&vl_api_flow->dst_addr, &f->dst_addr);
160 port_and_mask_convert (&vl_api_flow->src_port, &f->src_port);
161 port_and_mask_convert (&vl_api_flow->dst_port, &f->dst_port);
163 f->protocol = (ip_protocol_t) vl_api_flow->protocol;
164 f->teid = ntohl (vl_api_flow->teid);
168 ipv4_gtpc_flow_convert (vl_api_flow_ip4_gtpc_t * vl_api_flow,
169 vnet_flow_ip4_gtpc_t * f)
171 ipv4_addr_and_mask_convert (&vl_api_flow->src_addr, &f->src_addr);
172 ipv4_addr_and_mask_convert (&vl_api_flow->dst_addr, &f->dst_addr);
174 port_and_mask_convert (&vl_api_flow->src_port, &f->src_port);
175 port_and_mask_convert (&vl_api_flow->dst_port, &f->dst_port);
177 f->protocol = (ip_protocol_t) vl_api_flow->protocol;
178 f->teid = ntohl (vl_api_flow->teid);
182 vl_api_flow_add_t_handler (vl_api_flow_add_t * mp)
184 vl_api_flow_add_reply_t *rmp;
188 vl_api_flow_rule_t *f = &mp->flow;
190 vnet_main_t *vnm = vnet_get_main ();
192 flow.type = ntohl (f->type);
193 flow.actions = ntohl (f->actions);
194 flow.mark_flow_id = ntohl (f->mark_flow_id);
195 flow.redirect_node_index = ntohl (f->redirect_node_index);
196 flow.redirect_device_input_next_index =
197 ntohl (f->redirect_device_input_next_index);
198 flow.redirect_queue = ntohl (f->redirect_queue);
199 flow.buffer_advance = ntohl (f->buffer_advance);
203 case VNET_FLOW_TYPE_IP4_N_TUPLE:
204 ipv4_n_tuple_flow_convert (&f->flow.ip4_n_tuple, &flow.ip4_n_tuple);
206 case VNET_FLOW_TYPE_IP6_N_TUPLE:
207 ipv6_n_tuple_flow_convert (&f->flow.ip6_n_tuple, &flow.ip6_n_tuple);
209 case VNET_FLOW_TYPE_IP4_N_TUPLE_TAGGED:
210 ipv4_n_tuple_tagged_flow_convert (&f->flow.ip4_n_tuple_tagged,
211 &flow.ip4_n_tuple_tagged);
213 case VNET_FLOW_TYPE_IP6_N_TUPLE_TAGGED:
214 ipv6_n_tuple_tagged_flow_convert (&f->flow.ip6_n_tuple_tagged,
215 &flow.ip6_n_tuple_tagged);
217 case VNET_FLOW_TYPE_IP4_L2TPV3OIP:
218 ipv4_l2tpv3oip_flow_convert (&f->flow.ip4_l2tpv3oip,
219 &flow.ip4_l2tpv3oip);
221 case VNET_FLOW_TYPE_IP4_IPSEC_ESP:
222 ipv4_ipsec_esp_flow_convert (&f->flow.ip4_ipsec_esp,
223 &flow.ip4_ipsec_esp);
225 case VNET_FLOW_TYPE_IP4_IPSEC_AH:
226 ipv4_ipsec_ah_flow_convert (&f->flow.ip4_ipsec_ah, &flow.ip4_ipsec_ah);
228 case VNET_FLOW_TYPE_IP4_GTPU:
229 ipv4_gtpu_flow_convert (&f->flow.ip4_gtpu, &flow.ip4_gtpu);
231 case VNET_FLOW_TYPE_IP4_GTPC:
232 ipv4_gtpc_flow_convert (&f->flow.ip4_gtpc, &flow.ip4_gtpc);
235 rv = VNET_FLOW_ERROR_NOT_SUPPORTED;
241 rv = vnet_flow_add (vnm, &flow, &flow_index);
246 REPLY_MACRO2(VL_API_FLOW_ADD_REPLY,
248 rmp->flow_index = ntohl (flow_index);
253 vl_api_flow_del_t_handler (vl_api_flow_del_t * mp)
255 vl_api_flow_add_reply_t *rmp;
258 vnet_main_t *vnm = vnet_get_main();
259 rv = vnet_flow_del(vnm, ntohl(mp->flow_index));
261 REPLY_MACRO (VL_API_FLOW_DEL_REPLY);
265 vl_api_flow_enable_t_handler (vl_api_flow_enable_t * mp)
267 vl_api_flow_add_reply_t *rmp;
270 vnet_main_t *vnm = vnet_get_main();
271 rv = vnet_flow_enable(vnm, ntohl(mp->flow_index), ntohl(mp->hw_if_index));
273 REPLY_MACRO (VL_API_FLOW_ENABLE_REPLY);
277 vl_api_flow_disable_t_handler (vl_api_flow_disable_t * mp)
279 vl_api_flow_add_reply_t *rmp;
282 vnet_main_t *vnm = vnet_get_main();
283 rv = vnet_flow_disable(vnm, ntohl(mp->flow_index), ntohl(mp->hw_if_index));
285 REPLY_MACRO (VL_API_FLOW_DISABLE_REPLY);
288 #define vl_msg_name_crc_list
289 #include <vnet/flow/flow.api.h>
290 #undef vl_msg_name_crc_list
294 * Add vpe's API message handlers to the table.
295 * vlib has already mapped shared memory and
296 * added the client registration handlers.
297 * See .../vlib-api/vlibmemory/memclnt_vlib.c:memclnt_process()
302 setup_message_id_table (api_main_t * am)
304 #define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id);
305 foreach_vl_msg_name_crc_flow;
309 static clib_error_t *
310 hw_flow_api_hookup (vlib_main_t * vm)
312 api_main_t *am = vlibapi_get_main ();
315 vl_msg_api_set_handlers(VL_API_##N, #n, \
316 vl_api_##n##_t_handler, \
318 vl_api_##n##_t_endian, \
319 vl_api_##n##_t_print, \
320 sizeof(vl_api_##n##_t), 1);
325 * Set up the (msg_name, crc, message-id) table
327 setup_message_id_table (am);
332 VLIB_API_INIT_FUNCTION (hw_flow_api_hookup);
335 * fd.io coding-style-patch-verification: ON
338 * eval: (c-set-style "gnu")