2 * Copyright (c) 2017 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
18 #include <vnet/plugin/plugin.h>
19 #include <vpp/app/version.h>
20 #include <vnet/ip/format.h>
21 #include <vnet/ethernet/packet.h>
22 #include <vnet/udp/udp.h>
23 #include <vnet/tcp/tcp.h>
26 static vlib_node_registration_t stn_ip4_punt;
27 static vlib_node_registration_t stn_ip6_punt;
29 static u8 stn_hw_addr_local[6] = {0x00, 0x00, 0x00, 0x00, 0x00, 0x01};
30 static u8 stn_hw_addr_dst[6] = {0x00, 0x00, 0x00, 0x00, 0x00, 0x02};
32 static ethernet_header_t stn_ip4_ethernet_header = {};
33 static ethernet_header_t stn_ip6_ethernet_header = {};
36 clib_bihash_kv_16_8_t kv;
37 } stn_ip46_punt_trace_t;
40 format_stn_rule (u8 * s, va_list * args)
42 stn_rule_t *r = va_arg (*args, stn_rule_t *);
43 stn_main_t *stn = &stn_main;
44 u32 indent = format_get_indent (s);
45 u32 node_index = ip46_address_is_ip4(&r->address)?stn_ip4_punt.index:stn_ip6_punt.index;
46 vlib_node_t *next_node = vlib_get_next_node(vlib_get_main(), node_index, r->next_node_index);
47 s = format (s, "rule_index: %d\n", r - stn->rules);
48 s = format (s, "%Uaddress: %U\n", format_white_space, indent,
49 format_ip46_address, &r->address, IP46_TYPE_ANY);
50 s = format (s, "%Uiface: %U (%d)\n", format_white_space, indent,
51 format_vnet_sw_if_index_name, vnet_get_main(), r->sw_if_index,
53 s = format (s, "%Unext_node: %s (%d)", format_white_space, indent,
54 next_node->name, next_node->index);
58 static_always_inline u8 *
59 format_stn_ip46_punt_trace (u8 * s, va_list * args, u8 is_ipv4)
61 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
62 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
63 stn_ip46_punt_trace_t *t = va_arg (*args, stn_ip46_punt_trace_t *);
64 u32 indent = format_get_indent (s);
66 s = format (s, "dst_address: %U\n", format_ip46_address,
67 (ip46_address_t *)t->kv.key, IP46_TYPE_ANY);
69 if (t->kv.value == ~(0L))
71 s = format (s, "%Urule: none", format_white_space, indent);
75 s = format (s, "%Urule:\n%U%U", format_white_space, indent,
76 format_white_space, indent + 2,
77 format_stn_rule, &stn_main.rules[t->kv.value]);
88 static_always_inline uword
89 stn_ip46_punt_fn (vlib_main_t * vm,
90 vlib_node_runtime_t * node,
94 u32 n_left_from, *from, next_index, *to_next, n_left_to_next;
95 stn_main_t *stn = &stn_main;
97 from = vlib_frame_vector_args (frame);
98 n_left_from = frame->n_vectors;
99 next_index = node->cached_next_index;
101 while (n_left_from > 0)
103 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
106 while (n_left_from > 0 && n_left_to_next > 0)
110 clib_bihash_kv_16_8_t kv;
111 u32 next0 = STN_IP_PUNT_DROP;
113 pi0 = to_next[0] = from[0];
119 p0 = vlib_get_buffer (vm, pi0);
123 ip4_header_t *hdr = (ip4_header_t *) vlib_buffer_get_current(p0);
124 ip46_address_set_ip4((ip46_address_t *)kv.key, &hdr->dst_address);
128 ip6_header_t *hdr = (ip6_header_t *) vlib_buffer_get_current(p0);
129 kv.key[0] = hdr->dst_address.as_u64[0];
130 kv.key[1] = hdr->dst_address.as_u64[1];
134 clib_bihash_search_inline_16_8 (&stn->rule_by_address_table, &kv);
135 if (kv.value != ~(0L))
137 ethernet_header_t *eth;
138 stn_rule_t *r = &stn->rules[kv.value];
139 vnet_buffer(p0)->sw_if_index[VLIB_TX] = r->sw_if_index;
140 next0 = r->next_node_index;
141 vlib_buffer_advance(p0, -sizeof(*eth));
142 eth = (ethernet_header_t *) vlib_buffer_get_current(p0);
144 clib_memcpy_fast(eth, &stn_ip4_ethernet_header, sizeof(*eth));
146 clib_memcpy_fast(eth, &stn_ip6_ethernet_header, sizeof(*eth));
150 vnet_feature_next (&next0, p0);
153 if (PREDICT_FALSE (p0->flags & VLIB_BUFFER_IS_TRACED))
155 stn_ip46_punt_trace_t *tr =
156 vlib_add_trace (vm, node, p0, sizeof (*tr));
160 vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
161 n_left_to_next, pi0, next0);
163 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
166 return frame->n_vectors;
170 #define foreach_stn_ip_punt_error \
174 #define _(sym,str) STN_IP_punt_ERROR_##sym,
175 foreach_stn_ip_punt_error
180 static char *stn_ip_punt_error_strings[] = {
181 #define _(sym,string) string,
182 foreach_stn_ip_punt_error
187 format_stn_ip6_punt_trace (u8 * s, va_list * args)
189 return format_stn_ip46_punt_trace (s, args, 0);
193 stn_ip6_punt_fn (vlib_main_t * vm,
194 vlib_node_runtime_t * node, vlib_frame_t * frame)
196 return stn_ip46_punt_fn(vm, node, frame, 0);
200 VLIB_REGISTER_NODE (stn_ip6_punt, static) =
202 .function = stn_ip6_punt_fn,
203 .name = "stn-ip6-punt",
204 .vector_size = sizeof (u32),
205 .format_trace = format_stn_ip6_punt_trace,
206 .n_errors = STN_IP_PUNT_N_ERROR,
207 .error_strings = stn_ip_punt_error_strings,
208 .n_next_nodes = STN_IP_PUNT_N_NEXT,
211 [STN_IP_PUNT_DROP] = "error-drop"
214 VNET_FEATURE_INIT (stn_ip6_punt_feat_node, static) = {
215 .arc_name = "ip6-punt",
216 .node_name = "stn-ip6-punt",
217 .runs_before = VNET_FEATURES("ip6-punt-redirect"),
222 format_stn_ip4_punt_trace (u8 * s, va_list * args)
224 return format_stn_ip46_punt_trace (s, args, 1);
228 stn_ip4_punt_fn (vlib_main_t * vm,
229 vlib_node_runtime_t * node, vlib_frame_t * frame)
231 return stn_ip46_punt_fn(vm, node, frame, 1);
235 VLIB_REGISTER_NODE (stn_ip4_punt, static) =
237 .function = stn_ip4_punt_fn,
238 .name = "stn-ip4-punt",
239 .vector_size = sizeof (u32),
240 .format_trace = format_stn_ip4_punt_trace,
241 .n_errors = STN_IP_PUNT_N_ERROR,
242 .error_strings = stn_ip_punt_error_strings,
243 .n_next_nodes = STN_IP_PUNT_N_NEXT,
246 [STN_IP_PUNT_DROP] = "error-drop",
249 VNET_FEATURE_INIT (stn_ip4_punt_feat_node, static) = {
250 .arc_name = "ip4-punt",
251 .node_name = "stn-ip4-punt",
252 .runs_before = VNET_FEATURES("ip4-punt-redirect"),
257 stn_init (vlib_main_t * vm)
259 stn_main_t *stn = &stn_main;
261 clib_bihash_init_16_8(&stn->rule_by_address_table, "stn addresses",
264 clib_memcpy_fast(stn_ip4_ethernet_header.dst_address, stn_hw_addr_dst, 6);
265 clib_memcpy_fast(stn_ip4_ethernet_header.src_address, stn_hw_addr_local, 6);
266 stn_ip4_ethernet_header.type = clib_host_to_net_u16(ETHERNET_TYPE_IP4);
268 clib_memcpy_fast(stn_ip6_ethernet_header.dst_address, stn_hw_addr_dst, 6);
269 clib_memcpy_fast(stn_ip6_ethernet_header.src_address, stn_hw_addr_local, 6);
270 stn_ip6_ethernet_header.type = clib_host_to_net_u16(ETHERNET_TYPE_IP6);
272 return stn_api_init (vm, stn);
277 VLIB_INIT_FUNCTION (stn_init);
280 VLIB_PLUGIN_REGISTER () = {
281 .version = VPP_BUILD_VER,
282 .description = "VPP Steals the NIC (STN) for Container Integration",
286 int stn_rule_add_del (stn_rule_add_del_args_t *args)
288 vnet_main_t *vnm = vnet_get_main();
289 vlib_main_t *vm = vlib_get_main();
290 stn_main_t *stn = &stn_main;
292 stn_rule_t *r = NULL;
293 clib_bihash_kv_16_8_t kv;
294 kv.key[0] = args->address.as_u64[0];
295 kv.key[1] = args->address.as_u64[1];
297 if (clib_bihash_search_inline_16_8 (&stn->rule_by_address_table, &kv) == 0)
299 r = &stn->rules[kv.value];
303 pool_get(stn->rules, r);
304 kv.value = r - stn->rules;
305 clib_bihash_add_del_16_8(&stn->rule_by_address_table, &kv, 1);
306 r->address = args->address;
309 if (stn->n_rules == 1)
311 vnet_feature_enable_disable("ip6-punt", "stn-ip6-punt",
313 vnet_feature_enable_disable("ip4-punt", "stn-ip4-punt",
316 udp_punt_unknown(vm, 0, 1);
317 udp_punt_unknown(vm, 1, 1);
318 tcp_punt_unknown(vm, 0, 1);
319 tcp_punt_unknown(vm, 1, 1);
325 /* Getting output node and adding it as next */
326 u32 output_node_index =
327 vnet_tx_node_index_for_sw_interface(vnm, args->sw_if_index);
328 u32 node_index = ip46_address_is_ip4(&args->address)?
329 stn_ip4_punt.index : stn_ip6_punt.index;
331 r->sw_if_index = args->sw_if_index;
333 vlib_node_add_next(vm, node_index, output_node_index);
335 /* enabling forwarding on the output node (might not be done since
336 * it is unnumbered) */
337 ip4_sw_interface_enable_disable(args->sw_if_index, 1);
338 ip6_sw_interface_enable_disable(args->sw_if_index, 1);
342 clib_bihash_add_del_16_8(&stn->rule_by_address_table, &kv, 0);
343 pool_put(stn->rules, r);
346 if (stn->n_rules == 0)
348 vnet_feature_enable_disable("ip6-punt", "stn-ip6-punt",
350 vnet_feature_enable_disable("ip4-punt", "stn-ip4-punt",
356 return VNET_API_ERROR_NO_SUCH_ENTRY;
362 static clib_error_t *
363 show_stn_rules_fn (vlib_main_t * vm,
364 unformat_input_t * input, vlib_cli_command_t * cmd)
366 stn_main_t *stn = &stn_main;
369 pool_foreach(rule, stn->rules, {
370 s = format (s, "- %U\n", format_stn_rule, rule);
373 vlib_cli_output(vm, "%v", s);
379 VLIB_CLI_COMMAND (show_stn_rules_command, static) =
381 .path = "show stn rules",
383 .function = show_stn_rules_fn,
386 static clib_error_t *
387 stn_rule_fn (vlib_main_t * vm,
388 unformat_input_t * input, vlib_cli_command_t * cmd)
390 unformat_input_t _line_input, *line_input = &_line_input;
391 clib_error_t *error = 0;
392 stn_rule_add_del_args_t args = {};
397 if (!unformat_user (input, unformat_line_input, line_input))
400 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
402 if (unformat (line_input, "address %U", unformat_ip46_address,
403 &args.address, IP46_TYPE_ANY))
406 (line_input, "interface %U", unformat_vnet_sw_interface,
407 vnet_get_main(), &args.sw_if_index))
409 else if (unformat (line_input, "del"))
413 error = clib_error_return (0, "parse error: '%U'",
414 format_unformat_error, line_input);
421 error = clib_error_return (0, "Missing address");
427 error = clib_error_return (0, "Missing interface");
431 if ((ret = stn_rule_add_del (&args)))
433 error = clib_error_return (0, "stn_rule_add_del returned error %d", ret);
438 unformat_free (line_input);
442 VLIB_CLI_COMMAND (stn_rule_command, static) =
445 .short_help = "address <addr> interface <iface> [del]",
446 .function = stn_rule_fn,