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>
31 #include <vnet/vnet_msg_enum.h>
33 #define vl_typedefs /* define message structures */
34 #include <vnet/vnet_all_api_h.h>
37 #define vl_endianfun /* define message structures */
38 #include <vnet/vnet_all_api_h.h>
41 /* instantiate all the print functions we know about */
42 #define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__)
44 #include <vnet/vnet_all_api_h.h>
47 #include <vlibapi/api_helper_macros.h>
49 #define foreach_vpe_api_msg \
50 _(FLOW_ADD, flow_add) \
51 _(FLOW_DEL, flow_del) \
52 _(FLOW_ENABLE, flow_enable) \
53 _(FLOW_DISABLE, flow_disable)
56 ipv4_addr_and_mask_convert (vl_api_ip4_address_and_mask_t * vl_api_addr,
57 ip4_address_and_mask_t * vnet_addr)
59 clib_memcpy (vnet_addr, vl_api_addr, sizeof (*vnet_addr));
63 ipv6_addr_and_mask_convert (vl_api_ip6_address_and_mask_t * vl_api_addr,
64 ip6_address_and_mask_t * vnet_addr)
66 clib_memcpy (vnet_addr, vl_api_addr, sizeof (*vnet_addr));
70 protocol_and_mask_convert (vl_api_ip_prot_and_mask_t * vl_api_protocol,
71 ip_prot_and_mask_t * vnet_protocol)
73 vnet_protocol->prot = (ip_protocol_t) vl_api_protocol->prot;
74 vnet_protocol->mask = vl_api_protocol->mask;
78 port_and_mask_convert (vl_api_ip_port_and_mask_t * vl_api_port,
79 ip_port_and_mask_t * vnet_port)
81 vnet_port->port = ntohs (vl_api_port->port);
82 vnet_port->mask = ntohs (vl_api_port->mask);
86 ipv4_n_tuple_flow_convert (vl_api_flow_ip4_n_tuple_t * vl_api_flow,
87 vnet_flow_ip4_n_tuple_t * f)
89 ipv4_addr_and_mask_convert (&vl_api_flow->src_addr, &f->src_addr);
90 ipv4_addr_and_mask_convert (&vl_api_flow->dst_addr, &f->dst_addr);
91 protocol_and_mask_convert (&vl_api_flow->protocol, &f->protocol);
93 port_and_mask_convert (&vl_api_flow->src_port, &f->src_port);
94 port_and_mask_convert (&vl_api_flow->dst_port, &f->dst_port);
98 ipv6_n_tuple_flow_convert (vl_api_flow_ip6_n_tuple_t * vl_api_flow,
99 vnet_flow_ip6_n_tuple_t * f)
101 ipv6_addr_and_mask_convert (&vl_api_flow->src_addr, &f->src_addr);
102 ipv6_addr_and_mask_convert (&vl_api_flow->dst_addr, &f->dst_addr);
103 protocol_and_mask_convert (&vl_api_flow->protocol, &f->protocol);
105 port_and_mask_convert (&vl_api_flow->src_port, &f->src_port);
106 port_and_mask_convert (&vl_api_flow->dst_port, &f->dst_port);
110 ipv4_n_tuple_tagged_flow_convert (vl_api_flow_ip4_n_tuple_tagged_t *
112 vnet_flow_ip4_n_tuple_tagged_t * f)
114 return ipv4_n_tuple_flow_convert ((vl_api_flow_ip4_n_tuple_t *) vl_api_flow,
115 (vnet_flow_ip4_n_tuple_t *) f);
119 ipv6_n_tuple_tagged_flow_convert (vl_api_flow_ip6_n_tuple_tagged_t *
121 vnet_flow_ip6_n_tuple_tagged_t * f)
123 return ipv6_n_tuple_flow_convert ((vl_api_flow_ip6_n_tuple_t *) vl_api_flow,
124 (vnet_flow_ip6_n_tuple_t *) f);
128 ipv4_l2tpv3oip_flow_convert (vl_api_flow_ip4_l2tpv3oip_t * vl_api_flow,
129 vnet_flow_ip4_l2tpv3oip_t * f)
131 ipv4_addr_and_mask_convert (&vl_api_flow->src_addr, &f->src_addr);
132 ipv4_addr_and_mask_convert (&vl_api_flow->dst_addr, &f->dst_addr);
134 protocol_and_mask_convert (&vl_api_flow->protocol, &f->protocol);
135 f->session_id = ntohl (vl_api_flow->session_id);
139 ipv4_ipsec_esp_flow_convert (vl_api_flow_ip4_ipsec_esp_t * vl_api_flow,
140 vnet_flow_ip4_ipsec_esp_t * f)
142 ipv4_addr_and_mask_convert (&vl_api_flow->src_addr, &f->src_addr);
143 ipv4_addr_and_mask_convert (&vl_api_flow->dst_addr, &f->dst_addr);
145 protocol_and_mask_convert (&vl_api_flow->protocol, &f->protocol);
146 f->spi = ntohl (vl_api_flow->spi);
150 ipv4_ipsec_ah_flow_convert (vl_api_flow_ip4_ipsec_ah_t * vl_api_flow,
151 vnet_flow_ip4_ipsec_ah_t * f)
153 ipv4_addr_and_mask_convert (&vl_api_flow->src_addr, &f->src_addr);
154 ipv4_addr_and_mask_convert (&vl_api_flow->dst_addr, &f->dst_addr);
156 protocol_and_mask_convert (&vl_api_flow->protocol, &f->protocol);
157 f->spi = ntohl (vl_api_flow->spi);
161 ipv4_gtpu_flow_convert (vl_api_flow_ip4_gtpu_t * vl_api_flow,
162 vnet_flow_ip4_gtpu_t * f)
164 ipv4_addr_and_mask_convert (&vl_api_flow->src_addr, &f->src_addr);
165 ipv4_addr_and_mask_convert (&vl_api_flow->dst_addr, &f->dst_addr);
167 port_and_mask_convert (&vl_api_flow->src_port, &f->src_port);
168 port_and_mask_convert (&vl_api_flow->dst_port, &f->dst_port);
170 protocol_and_mask_convert (&vl_api_flow->protocol, &f->protocol);
171 f->teid = ntohl (vl_api_flow->teid);
175 ipv4_gtpc_flow_convert (vl_api_flow_ip4_gtpc_t * vl_api_flow,
176 vnet_flow_ip4_gtpc_t * f)
178 ipv4_addr_and_mask_convert (&vl_api_flow->src_addr, &f->src_addr);
179 ipv4_addr_and_mask_convert (&vl_api_flow->dst_addr, &f->dst_addr);
181 port_and_mask_convert (&vl_api_flow->src_port, &f->src_port);
182 port_and_mask_convert (&vl_api_flow->dst_port, &f->dst_port);
184 protocol_and_mask_convert (&vl_api_flow->protocol, &f->protocol);
185 f->teid = ntohl (vl_api_flow->teid);
189 vl_api_flow_add_t_handler (vl_api_flow_add_t * mp)
191 vl_api_flow_add_reply_t *rmp;
195 vl_api_flow_rule_t *f = &mp->flow;
197 vnet_main_t *vnm = vnet_get_main ();
199 flow.type = ntohl (f->type);
200 flow.actions = ntohl (f->actions);
201 flow.mark_flow_id = ntohl (f->mark_flow_id);
202 flow.redirect_node_index = ntohl (f->redirect_node_index);
203 flow.redirect_device_input_next_index =
204 ntohl (f->redirect_device_input_next_index);
205 flow.redirect_queue = ntohl (f->redirect_queue);
206 flow.buffer_advance = ntohl (f->buffer_advance);
210 case VNET_FLOW_TYPE_IP4_N_TUPLE:
211 ipv4_n_tuple_flow_convert (&f->flow.ip4_n_tuple, &flow.ip4_n_tuple);
213 case VNET_FLOW_TYPE_IP6_N_TUPLE:
214 ipv6_n_tuple_flow_convert (&f->flow.ip6_n_tuple, &flow.ip6_n_tuple);
216 case VNET_FLOW_TYPE_IP4_N_TUPLE_TAGGED:
217 ipv4_n_tuple_tagged_flow_convert (&f->flow.ip4_n_tuple_tagged,
218 &flow.ip4_n_tuple_tagged);
220 case VNET_FLOW_TYPE_IP6_N_TUPLE_TAGGED:
221 ipv6_n_tuple_tagged_flow_convert (&f->flow.ip6_n_tuple_tagged,
222 &flow.ip6_n_tuple_tagged);
224 case VNET_FLOW_TYPE_IP4_L2TPV3OIP:
225 ipv4_l2tpv3oip_flow_convert (&f->flow.ip4_l2tpv3oip,
226 &flow.ip4_l2tpv3oip);
228 case VNET_FLOW_TYPE_IP4_IPSEC_ESP:
229 ipv4_ipsec_esp_flow_convert (&f->flow.ip4_ipsec_esp,
230 &flow.ip4_ipsec_esp);
232 case VNET_FLOW_TYPE_IP4_IPSEC_AH:
233 ipv4_ipsec_ah_flow_convert (&f->flow.ip4_ipsec_ah, &flow.ip4_ipsec_ah);
235 case VNET_FLOW_TYPE_IP4_GTPU:
236 ipv4_gtpu_flow_convert (&f->flow.ip4_gtpu, &flow.ip4_gtpu);
238 case VNET_FLOW_TYPE_IP4_GTPC:
239 ipv4_gtpc_flow_convert (&f->flow.ip4_gtpc, &flow.ip4_gtpc);
242 rv = VNET_FLOW_ERROR_NOT_SUPPORTED;
247 rv = vnet_flow_add (vnm, &flow, &flow_index);
251 REPLY_MACRO2(VL_API_FLOW_ADD_REPLY,
253 rmp->flow_index = ntohl (flow_index);
259 vl_api_flow_del_t_handler (vl_api_flow_del_t * mp)
261 vl_api_flow_add_reply_t *rmp;
264 vnet_main_t *vnm = vnet_get_main ();
265 rv = vnet_flow_del (vnm, ntohl (mp->flow_index));
267 REPLY_MACRO (VL_API_FLOW_DEL_REPLY);
271 vl_api_flow_enable_t_handler (vl_api_flow_enable_t * mp)
273 vl_api_flow_add_reply_t *rmp;
276 vnet_main_t *vnm = vnet_get_main ();
278 vnet_flow_enable (vnm, ntohl (mp->flow_index), ntohl (mp->hw_if_index));
280 REPLY_MACRO (VL_API_FLOW_ENABLE_REPLY);
284 vl_api_flow_disable_t_handler (vl_api_flow_disable_t * mp)
286 vl_api_flow_add_reply_t *rmp;
289 vnet_main_t *vnm = vnet_get_main ();
291 vnet_flow_disable (vnm, ntohl (mp->flow_index), ntohl (mp->hw_if_index));
293 REPLY_MACRO (VL_API_FLOW_DISABLE_REPLY);
296 #define vl_msg_name_crc_list
297 #include <vnet/flow/flow.api.h>
298 #undef vl_msg_name_crc_list
302 * Add vpe's API message handlers to the table.
303 * vlib has already mapped shared memory and
304 * added the client registration handlers.
305 * See .../vlib-api/vlibmemory/memclnt_vlib.c:memclnt_process()
310 setup_message_id_table (api_main_t * am)
312 #define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id);
313 foreach_vl_msg_name_crc_flow;
317 static clib_error_t *
318 hw_flow_api_hookup (vlib_main_t * vm)
320 api_main_t *am = vlibapi_get_main ();
323 vl_msg_api_set_handlers(VL_API_##N, #n, \
324 vl_api_##n##_t_handler, \
326 vl_api_##n##_t_endian, \
327 vl_api_##n##_t_print, \
328 sizeof(vl_api_##n##_t), 1);
333 * Set up the (msg_name, crc, message-id) table
335 setup_message_id_table (am);
340 VLIB_API_INIT_FUNCTION (hw_flow_api_hookup);
343 * fd.io coding-style-patch-verification: ON
346 * eval: (c-set-style "gnu")