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/udp/udp_local.h>
29 #include <vnet/tunnel/tunnel_types_api.h>
30 #include <vnet/ip/ip_types_api.h>
32 #include <vnet/format_fns.h>
33 #include <vnet/flow/flow.api_enum.h>
34 #include <vnet/flow/flow.api_types.h>
36 #define REPLY_MSG_ID_BASE flow_main.msg_id_base
37 #include <vlibapi/api_helper_macros.h>
40 ipv4_addr_and_mask_convert (vl_api_ip4_address_and_mask_t * vl_api_addr,
41 ip4_address_and_mask_t * vnet_addr)
43 clib_memcpy (vnet_addr, vl_api_addr, sizeof (*vnet_addr));
47 ipv6_addr_and_mask_convert (vl_api_ip6_address_and_mask_t * vl_api_addr,
48 ip6_address_and_mask_t * vnet_addr)
50 clib_memcpy (vnet_addr, vl_api_addr, sizeof (*vnet_addr));
54 protocol_and_mask_convert (vl_api_ip_prot_and_mask_t * vl_api_protocol,
55 ip_prot_and_mask_t * vnet_protocol)
57 vnet_protocol->prot = (ip_protocol_t) vl_api_protocol->prot;
58 vnet_protocol->mask = vl_api_protocol->mask;
62 port_and_mask_convert (vl_api_ip_port_and_mask_t * vl_api_port,
63 ip_port_and_mask_t * vnet_port)
65 vnet_port->port = ntohs (vl_api_port->port);
66 vnet_port->mask = ntohs (vl_api_port->mask);
70 ipv4_flow_convert (vl_api_flow_ip4_t *vl_api_flow, vnet_flow_ip4_t *f)
72 ipv4_addr_and_mask_convert (&vl_api_flow->src_addr, &f->src_addr);
73 ipv4_addr_and_mask_convert (&vl_api_flow->dst_addr, &f->dst_addr);
75 protocol_and_mask_convert (&vl_api_flow->protocol, &f->protocol);
79 ipv6_flow_convert (vl_api_flow_ip6_t *vl_api_flow, vnet_flow_ip6_t *f)
81 ipv6_addr_and_mask_convert (&vl_api_flow->src_addr, &f->src_addr);
82 ipv6_addr_and_mask_convert (&vl_api_flow->dst_addr, &f->dst_addr);
84 protocol_and_mask_convert (&vl_api_flow->protocol, &f->protocol);
88 ipv4_n_tuple_flow_convert (vl_api_flow_ip4_n_tuple_t * vl_api_flow,
89 vnet_flow_ip4_n_tuple_t * f)
91 ipv4_addr_and_mask_convert (&vl_api_flow->src_addr, &f->src_addr);
92 ipv4_addr_and_mask_convert (&vl_api_flow->dst_addr, &f->dst_addr);
93 protocol_and_mask_convert (&vl_api_flow->protocol, &f->protocol);
95 port_and_mask_convert (&vl_api_flow->src_port, &f->src_port);
96 port_and_mask_convert (&vl_api_flow->dst_port, &f->dst_port);
100 ipv6_n_tuple_flow_convert (vl_api_flow_ip6_n_tuple_t * vl_api_flow,
101 vnet_flow_ip6_n_tuple_t * f)
103 ipv6_addr_and_mask_convert (&vl_api_flow->src_addr, &f->src_addr);
104 ipv6_addr_and_mask_convert (&vl_api_flow->dst_addr, &f->dst_addr);
105 protocol_and_mask_convert (&vl_api_flow->protocol, &f->protocol);
107 port_and_mask_convert (&vl_api_flow->src_port, &f->src_port);
108 port_and_mask_convert (&vl_api_flow->dst_port, &f->dst_port);
112 ipv4_n_tuple_tagged_flow_convert (vl_api_flow_ip4_n_tuple_tagged_t *
114 vnet_flow_ip4_n_tuple_tagged_t * f)
116 return ipv4_n_tuple_flow_convert ((vl_api_flow_ip4_n_tuple_t *) vl_api_flow,
117 (vnet_flow_ip4_n_tuple_t *) f);
121 ipv6_n_tuple_tagged_flow_convert (vl_api_flow_ip6_n_tuple_tagged_t *
123 vnet_flow_ip6_n_tuple_tagged_t * f)
125 return ipv6_n_tuple_flow_convert ((vl_api_flow_ip6_n_tuple_t *) vl_api_flow,
126 (vnet_flow_ip6_n_tuple_t *) f);
130 ipv4_l2tpv3oip_flow_convert (vl_api_flow_ip4_l2tpv3oip_t * vl_api_flow,
131 vnet_flow_ip4_l2tpv3oip_t * f)
133 ipv4_addr_and_mask_convert (&vl_api_flow->src_addr, &f->src_addr);
134 ipv4_addr_and_mask_convert (&vl_api_flow->dst_addr, &f->dst_addr);
136 protocol_and_mask_convert (&vl_api_flow->protocol, &f->protocol);
137 f->session_id = ntohl (vl_api_flow->session_id);
141 ipv4_ipsec_esp_flow_convert (vl_api_flow_ip4_ipsec_esp_t * vl_api_flow,
142 vnet_flow_ip4_ipsec_esp_t * f)
144 ipv4_addr_and_mask_convert (&vl_api_flow->src_addr, &f->src_addr);
145 ipv4_addr_and_mask_convert (&vl_api_flow->dst_addr, &f->dst_addr);
147 protocol_and_mask_convert (&vl_api_flow->protocol, &f->protocol);
148 f->spi = ntohl (vl_api_flow->spi);
152 ipv4_ipsec_ah_flow_convert (vl_api_flow_ip4_ipsec_ah_t * vl_api_flow,
153 vnet_flow_ip4_ipsec_ah_t * f)
155 ipv4_addr_and_mask_convert (&vl_api_flow->src_addr, &f->src_addr);
156 ipv4_addr_and_mask_convert (&vl_api_flow->dst_addr, &f->dst_addr);
158 protocol_and_mask_convert (&vl_api_flow->protocol, &f->protocol);
159 f->spi = ntohl (vl_api_flow->spi);
163 ipv4_vxlan_flow_convert (vl_api_flow_ip4_vxlan_t *vl_api_flow,
164 vnet_flow_ip4_vxlan_t *f)
166 ipv4_addr_and_mask_convert (&vl_api_flow->src_addr, &f->src_addr);
167 ipv4_addr_and_mask_convert (&vl_api_flow->dst_addr, &f->dst_addr);
168 protocol_and_mask_convert (&vl_api_flow->protocol, &f->protocol);
170 port_and_mask_convert (&vl_api_flow->src_port, &f->src_port);
171 port_and_mask_convert (&vl_api_flow->dst_port, &f->dst_port);
173 f->vni = ntohl (vl_api_flow->vni);
177 ipv6_vxlan_flow_convert (vl_api_flow_ip6_vxlan_t *vl_api_flow,
178 vnet_flow_ip6_vxlan_t *f)
180 ipv6_addr_and_mask_convert (&vl_api_flow->src_addr, &f->src_addr);
181 ipv6_addr_and_mask_convert (&vl_api_flow->dst_addr, &f->dst_addr);
182 protocol_and_mask_convert (&vl_api_flow->protocol, &f->protocol);
184 port_and_mask_convert (&vl_api_flow->src_port, &f->src_port);
185 port_and_mask_convert (&vl_api_flow->dst_port, &f->dst_port);
187 f->vni = ntohl (vl_api_flow->vni);
191 ipv4_gtpu_flow_convert (vl_api_flow_ip4_gtpu_t * vl_api_flow,
192 vnet_flow_ip4_gtpu_t * f)
194 ipv4_addr_and_mask_convert (&vl_api_flow->src_addr, &f->src_addr);
195 ipv4_addr_and_mask_convert (&vl_api_flow->dst_addr, &f->dst_addr);
197 port_and_mask_convert (&vl_api_flow->src_port, &f->src_port);
198 port_and_mask_convert (&vl_api_flow->dst_port, &f->dst_port);
200 protocol_and_mask_convert (&vl_api_flow->protocol, &f->protocol);
201 f->teid = ntohl (vl_api_flow->teid);
205 ipv4_gtpc_flow_convert (vl_api_flow_ip4_gtpc_t * vl_api_flow,
206 vnet_flow_ip4_gtpc_t * f)
208 ipv4_addr_and_mask_convert (&vl_api_flow->src_addr, &f->src_addr);
209 ipv4_addr_and_mask_convert (&vl_api_flow->dst_addr, &f->dst_addr);
211 port_and_mask_convert (&vl_api_flow->src_port, &f->src_port);
212 port_and_mask_convert (&vl_api_flow->dst_port, &f->dst_port);
214 protocol_and_mask_convert (&vl_api_flow->protocol, &f->protocol);
215 f->teid = ntohl (vl_api_flow->teid);
219 generic_flow_convert (vl_api_flow_generic_t *vl_api_flow,
220 vnet_flow_generic_t *f)
222 clib_memcpy (f->pattern.spec, vl_api_flow->pattern.spec,
223 sizeof (vl_api_flow->pattern.spec));
224 clib_memcpy (f->pattern.mask, vl_api_flow->pattern.mask,
225 sizeof (vl_api_flow->pattern.mask));
229 vl_api_flow_add_t_handler (vl_api_flow_add_t * mp)
231 vl_api_flow_add_reply_t *rmp;
235 vl_api_flow_rule_t *f = &mp->flow;
237 vnet_main_t *vnm = vnet_get_main ();
239 flow.type = ntohl (f->type);
240 flow.actions = ntohl (f->actions);
241 flow.mark_flow_id = ntohl (f->mark_flow_id);
242 flow.redirect_node_index = ntohl (f->redirect_node_index);
243 flow.redirect_device_input_next_index =
244 ntohl (f->redirect_device_input_next_index);
245 flow.redirect_queue = ntohl (f->redirect_queue);
246 flow.buffer_advance = ntohl (f->buffer_advance);
250 case VNET_FLOW_TYPE_IP4:
251 ipv4_flow_convert (&f->flow.ip4, &flow.ip4);
253 case VNET_FLOW_TYPE_IP6:
254 ipv6_flow_convert (&f->flow.ip6, &flow.ip6);
256 case VNET_FLOW_TYPE_IP4_N_TUPLE:
257 ipv4_n_tuple_flow_convert (&f->flow.ip4_n_tuple, &flow.ip4_n_tuple);
259 case VNET_FLOW_TYPE_IP6_N_TUPLE:
260 ipv6_n_tuple_flow_convert (&f->flow.ip6_n_tuple, &flow.ip6_n_tuple);
262 case VNET_FLOW_TYPE_IP4_N_TUPLE_TAGGED:
263 ipv4_n_tuple_tagged_flow_convert (&f->flow.ip4_n_tuple_tagged,
264 &flow.ip4_n_tuple_tagged);
266 case VNET_FLOW_TYPE_IP6_N_TUPLE_TAGGED:
267 ipv6_n_tuple_tagged_flow_convert (&f->flow.ip6_n_tuple_tagged,
268 &flow.ip6_n_tuple_tagged);
270 case VNET_FLOW_TYPE_IP4_L2TPV3OIP:
271 ipv4_l2tpv3oip_flow_convert (&f->flow.ip4_l2tpv3oip,
272 &flow.ip4_l2tpv3oip);
274 case VNET_FLOW_TYPE_IP4_IPSEC_ESP:
275 ipv4_ipsec_esp_flow_convert (&f->flow.ip4_ipsec_esp,
276 &flow.ip4_ipsec_esp);
278 case VNET_FLOW_TYPE_IP4_IPSEC_AH:
279 ipv4_ipsec_ah_flow_convert (&f->flow.ip4_ipsec_ah, &flow.ip4_ipsec_ah);
281 case VNET_FLOW_TYPE_IP4_VXLAN:
282 ipv4_vxlan_flow_convert (&f->flow.ip4_vxlan, &flow.ip4_vxlan);
284 case VNET_FLOW_TYPE_IP6_VXLAN:
285 ipv6_vxlan_flow_convert (&f->flow.ip6_vxlan, &flow.ip6_vxlan);
287 case VNET_FLOW_TYPE_IP4_GTPU:
288 ipv4_gtpu_flow_convert (&f->flow.ip4_gtpu, &flow.ip4_gtpu);
290 case VNET_FLOW_TYPE_IP4_GTPC:
291 ipv4_gtpc_flow_convert (&f->flow.ip4_gtpc, &flow.ip4_gtpc);
294 rv = VNET_FLOW_ERROR_NOT_SUPPORTED;
299 rv = vnet_flow_add (vnm, &flow, &flow_index);
303 REPLY_MACRO2(VL_API_FLOW_ADD_REPLY,
305 rmp->flow_index = ntohl (flow_index);
311 vl_api_flow_add_v2_t_handler (vl_api_flow_add_v2_t *mp)
313 vl_api_flow_add_v2_reply_t *rmp;
317 vl_api_flow_rule_v2_t *f = &mp->flow;
319 vnet_main_t *vnm = vnet_get_main ();
321 flow.type = ntohl (f->type);
322 flow.actions = ntohl (f->actions);
323 flow.mark_flow_id = ntohl (f->mark_flow_id);
324 flow.redirect_node_index = ntohl (f->redirect_node_index);
325 flow.redirect_device_input_next_index =
326 ntohl (f->redirect_device_input_next_index);
327 flow.redirect_queue = ntohl (f->redirect_queue);
328 flow.buffer_advance = ntohl (f->buffer_advance);
329 flow.queue_index = ntohl (f->queue_index);
330 flow.queue_num = ntohl (f->queue_num);
331 flow.rss_types = ntohl (f->rss_types);
332 flow.rss_fun = ntohl (f->rss_fun);
336 case VNET_FLOW_TYPE_IP4:
337 ipv4_flow_convert (&f->flow.ip4, &flow.ip4);
339 case VNET_FLOW_TYPE_IP6:
340 ipv6_flow_convert (&f->flow.ip6, &flow.ip6);
342 case VNET_FLOW_TYPE_IP4_N_TUPLE:
343 ipv4_n_tuple_flow_convert (&f->flow.ip4_n_tuple, &flow.ip4_n_tuple);
345 case VNET_FLOW_TYPE_IP6_N_TUPLE:
346 ipv6_n_tuple_flow_convert (&f->flow.ip6_n_tuple, &flow.ip6_n_tuple);
348 case VNET_FLOW_TYPE_IP4_N_TUPLE_TAGGED:
349 ipv4_n_tuple_tagged_flow_convert (&f->flow.ip4_n_tuple_tagged,
350 &flow.ip4_n_tuple_tagged);
352 case VNET_FLOW_TYPE_IP6_N_TUPLE_TAGGED:
353 ipv6_n_tuple_tagged_flow_convert (&f->flow.ip6_n_tuple_tagged,
354 &flow.ip6_n_tuple_tagged);
356 case VNET_FLOW_TYPE_IP4_L2TPV3OIP:
357 ipv4_l2tpv3oip_flow_convert (&f->flow.ip4_l2tpv3oip,
358 &flow.ip4_l2tpv3oip);
360 case VNET_FLOW_TYPE_IP4_IPSEC_ESP:
361 ipv4_ipsec_esp_flow_convert (&f->flow.ip4_ipsec_esp,
362 &flow.ip4_ipsec_esp);
364 case VNET_FLOW_TYPE_IP4_IPSEC_AH:
365 ipv4_ipsec_ah_flow_convert (&f->flow.ip4_ipsec_ah, &flow.ip4_ipsec_ah);
367 case VNET_FLOW_TYPE_IP4_VXLAN:
368 ipv4_vxlan_flow_convert (&f->flow.ip4_vxlan, &flow.ip4_vxlan);
370 case VNET_FLOW_TYPE_IP6_VXLAN:
371 ipv6_vxlan_flow_convert (&f->flow.ip6_vxlan, &flow.ip6_vxlan);
373 case VNET_FLOW_TYPE_IP4_GTPU:
374 ipv4_gtpu_flow_convert (&f->flow.ip4_gtpu, &flow.ip4_gtpu);
376 case VNET_FLOW_TYPE_IP4_GTPC:
377 ipv4_gtpc_flow_convert (&f->flow.ip4_gtpc, &flow.ip4_gtpc);
379 case VNET_FLOW_TYPE_GENERIC:
380 generic_flow_convert (&f->flow.generic, &flow.generic);
383 rv = VNET_FLOW_ERROR_NOT_SUPPORTED;
388 rv = vnet_flow_add (vnm, &flow, &flow_index);
391 REPLY_MACRO2 (VL_API_FLOW_ADD_V2_REPLY,
392 ({ rmp->flow_index = ntohl (flow_index); }));
396 vl_api_flow_del_t_handler (vl_api_flow_del_t * mp)
398 vl_api_flow_add_reply_t *rmp;
401 vnet_main_t *vnm = vnet_get_main ();
402 rv = vnet_flow_del (vnm, ntohl (mp->flow_index));
404 REPLY_MACRO (VL_API_FLOW_DEL_REPLY);
408 vl_api_flow_enable_t_handler (vl_api_flow_enable_t * mp)
410 vl_api_flow_add_reply_t *rmp;
413 vnet_main_t *vnm = vnet_get_main ();
415 vnet_flow_enable (vnm, ntohl (mp->flow_index), ntohl (mp->hw_if_index));
417 REPLY_MACRO (VL_API_FLOW_ENABLE_REPLY);
421 vl_api_flow_disable_t_handler (vl_api_flow_disable_t * mp)
423 vl_api_flow_add_reply_t *rmp;
426 vnet_main_t *vnm = vnet_get_main ();
428 vnet_flow_disable (vnm, ntohl (mp->flow_index), ntohl (mp->hw_if_index));
430 REPLY_MACRO (VL_API_FLOW_DISABLE_REPLY);
433 #include <vnet/flow/flow.api.c>
434 static clib_error_t *
435 hw_flow_api_hookup (vlib_main_t * vm)
437 flow_main.msg_id_base = setup_message_id_table ();
442 VLIB_API_INIT_FUNCTION (hw_flow_api_hookup);
445 * fd.io coding-style-patch-verification: ON
448 * eval: (c-set-style "gnu")