2 * ct6.c - skeleton vpp engine plug-in
4 * Copyright (c) <current-year> <your-organization>
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at:
9 * http://www.apache.org/licenses/LICENSE-2.0
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
18 #include <vnet/vnet.h>
19 #include <vnet/plugin/plugin.h>
22 #include <vlibapi/api.h>
23 #include <vlibmemory/api.h>
24 #include <vpp/app/version.h>
26 /* define message IDs */
27 #include <ct6/ct6.api_enum.h>
28 #include <ct6/ct6.api_types.h>
30 #define REPLY_MSG_ID_BASE cmp->msg_id_base
31 #include <vlibapi/api_helper_macros.h>
35 /* Action function shared between message handler and debug CLI */
38 ct6_feature_init (ct6_main_t * cmp)
40 u32 nworkers = vlib_num_workers ();
42 if (cmp->feature_initialized)
45 clib_bihash_init_48_8 (&cmp->session_hash, "ct6 session table",
46 cmp->session_hash_buckets, cmp->session_hash_memory);
47 cmp->feature_initialized = 1;
48 vec_validate (cmp->sessions, nworkers);
49 vec_validate_init_empty (cmp->first_index, nworkers, ~0);
50 vec_validate_init_empty (cmp->last_index, nworkers, ~0);
54 ct6_in2out_enable_disable (ct6_main_t * cmp, u32 sw_if_index,
57 vnet_sw_interface_t *sw;
60 ct6_feature_init (cmp);
63 if (pool_is_free_index (cmp->vnet_main->interface_main.sw_interfaces,
65 return VNET_API_ERROR_INVALID_SW_IF_INDEX;
67 /* Not a physical port? */
68 sw = vnet_get_sw_interface (cmp->vnet_main, sw_if_index);
69 if (sw->type != VNET_SW_INTERFACE_TYPE_HARDWARE)
70 return VNET_API_ERROR_INVALID_SW_IF_INDEX;
72 vnet_feature_enable_disable ("interface-output", "ct6-in2out",
73 sw_if_index, enable_disable, 0, 0);
79 ct6_out2in_enable_disable (ct6_main_t * cmp, u32 sw_if_index,
82 vnet_sw_interface_t *sw;
85 ct6_feature_init (cmp);
88 if (pool_is_free_index (cmp->vnet_main->interface_main.sw_interfaces,
90 return VNET_API_ERROR_INVALID_SW_IF_INDEX;
92 /* Not a physical port? */
93 sw = vnet_get_sw_interface (cmp->vnet_main, sw_if_index);
94 if (sw->type != VNET_SW_INTERFACE_TYPE_HARDWARE)
95 return VNET_API_ERROR_INVALID_SW_IF_INDEX;
97 vnet_feature_enable_disable ("ip6-unicast", "ct6-out2in",
98 sw_if_index, enable_disable, 0, 0);
103 static clib_error_t *
104 set_ct6_enable_disable_command_fn (vlib_main_t * vm,
105 unformat_input_t * input,
106 vlib_cli_command_t * cmd)
108 ct6_main_t *cmp = &ct6_main;
109 u32 sw_if_index = ~0;
110 int enable_disable = 1;
114 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
116 if (unformat (input, "disable"))
118 else if (unformat (input, "%U", unformat_vnet_sw_interface,
119 cmp->vnet_main, &sw_if_index))
121 else if (unformat (input, "inside") || unformat (input, "in"))
123 else if (unformat (input, "outside") || unformat (input, "out"))
130 return clib_error_return (0, "Please specify inside or outside");
132 if (sw_if_index == ~0)
133 return clib_error_return (0, "Please specify an interface...");
136 rv = ct6_in2out_enable_disable (cmp, sw_if_index, enable_disable);
138 rv = ct6_out2in_enable_disable (cmp, sw_if_index, enable_disable);
145 case VNET_API_ERROR_INVALID_SW_IF_INDEX:
146 return clib_error_return
147 (0, "Invalid interface, only works on physical ports");
151 return clib_error_return (0, "ct6_enable_disable returned %d", rv);
157 VLIB_CLI_COMMAND (set_ct6_command, static) =
161 "set ct6 [inside|outside] <interface-name> [disable]",
162 .function = set_ct6_enable_disable_command_fn,
166 /* API message handler */
167 static void vl_api_ct6_enable_disable_t_handler
168 (vl_api_ct6_enable_disable_t * mp)
170 vl_api_ct6_enable_disable_reply_t *rmp;
171 ct6_main_t *cmp = &ct6_main;
174 VALIDATE_SW_IF_INDEX (mp);
177 rv = ct6_in2out_enable_disable (cmp, ntohl (mp->sw_if_index),
178 (int) (mp->enable_disable));
180 rv = ct6_out2in_enable_disable (cmp, ntohl (mp->sw_if_index),
181 (int) (mp->enable_disable));
183 BAD_SW_IF_INDEX_LABEL;
184 REPLY_MACRO (VL_API_CT6_ENABLE_DISABLE_REPLY);
187 #include <ct6/ct6.api.c>
188 static clib_error_t *
189 ct6_init (vlib_main_t * vm)
191 ct6_main_t *cmp = &ct6_main;
192 clib_error_t *error = 0;
195 cmp->vnet_main = vnet_get_main ();
197 /* Ask for a correctly-sized block of API message decode slots */
198 cmp->msg_id_base = setup_message_id_table ();
201 * Set default parameters...
204 * 2 minute inactivity timer
205 * 10000 concurrent sessions
207 cmp->session_hash_memory = 16ULL << 20;
208 cmp->session_hash_buckets = 64 << 10;
209 cmp->session_timeout_interval = 120.0;
210 cmp->max_sessions_per_worker = 10000;
212 /* ... so the packet generator can feed the in2out node ... */
213 ethernet_setup_node (vm, ct6_in2out_node.index);
217 VLIB_INIT_FUNCTION (ct6_init);
220 VNET_FEATURE_INIT (ct6out2in, static) =
222 .arc_name = "ip6-unicast",
223 .node_name = "ct6-out2in",
224 .runs_before = VNET_FEATURES ("ip6-lookup"),
229 VNET_FEATURE_INIT (ct6in2out, static) = {
230 .arc_name = "interface-output",
231 .node_name = "ct6-in2out",
232 .runs_before = VNET_FEATURES ("interface-output-arc-end"),
237 VLIB_PLUGIN_REGISTER () =
239 .version = VPP_BUILD_VER,
240 .description = "IPv6 Connection Tracker",
245 format_ct6_session (u8 * s, va_list * args)
247 ct6_main_t *cmp = va_arg (*args, ct6_main_t *);
248 int i = va_arg (*args, int);
249 ct6_session_t *s0 = va_arg (*args, ct6_session_t *);
250 int verbose = va_arg (*args, int);
251 clib_bihash_kv_48_8_t kvp0;
255 s = format (s, "\n%6s%6s%40s%6s%40s%6s",
256 "Sess", "Prot", "Src", "Sport", "Dst", "Dport");
260 s = format (s, "\n%6d%6d%40U%6u%40U%6u",
261 s0 - cmp->sessions[i], s0->key.proto,
262 format_ip6_address, &s0->key.src,
263 clib_net_to_host_u16 (s0->key.sport),
264 format_ip6_address, &s0->key.dst,
265 clib_net_to_host_u16 (s0->key.dport));
267 clib_memcpy_fast (&kvp0, s0, sizeof (ct6_session_key_t));
269 if (clib_bihash_search_48_8 (&cmp->session_hash, &kvp0, &kvp0) < 0)
271 s = format (s, " LOOKUP FAIL!");
275 if (kvp0.value == s0 - cmp->sessions[s0->thread_index])
277 s = format (s, " OK");
280 s = format (s, " next %d prev %d", s0->next_index,
282 s = format (s, " hits %d expires %.2f", s0->hits, s0->expires);
286 s = format (s, " BOGUS LOOKUP RESULT!");
292 static clib_error_t *
293 show_ct6_command_fn_command_fn (vlib_main_t * vm,
294 unformat_input_t * input,
295 vlib_cli_command_t * cmd)
297 ct6_main_t *cmp = &ct6_main;
303 if (!cmp->feature_initialized)
304 return clib_error_return (0, "ip6 connection tracking not enabled...");
306 if (unformat (input, "verbose %d", &verbose))
308 else if (unformat (input, "verbose"))
311 for (i = 0; i < vec_len (cmp->sessions); i++)
313 s = format (s, "Thread %d: %d sessions\n", i,
314 pool_elts (cmp->sessions[i]));
320 format (s, "%U", format_ct6_session, cmp,
321 0 /* pool */ , 0 /* header */ , verbose);
324 pool_foreach (s0, cmp->sessions[i])
326 s = format (s, "%U", format_ct6_session, cmp, i, s0, verbose);
330 vlib_cli_output (cmp->vlib_main, "%v", s);
336 VLIB_CLI_COMMAND (show_ct6_command_fn_command, static) =
338 .path = "show ip6 connection-tracker",
339 .short_help = "show ip6 connection-tracker",
340 .function = show_ct6_command_fn_command_fn,
345 increment_v6_address (ip6_address_t * a)
349 v0 = clib_net_to_host_u64 (a->as_u64[0]);
350 v1 = clib_net_to_host_u64 (a->as_u64[1]);
355 a->as_u64[0] = clib_net_to_host_u64 (v0);
356 a->as_u64[1] = clib_net_to_host_u64 (v1);
360 static clib_error_t *
361 test_ct6_command_fn_command_fn (vlib_main_t * vm,
362 unformat_input_t * input,
363 vlib_cli_command_t * cmd)
365 ct6_main_t *cmp = &ct6_main;
366 clib_bihash_kv_48_8_t kvp0;
367 ct6_session_key_t *key0;
370 u32 recycled = 0, created = 0;
371 int i, num_sessions = 5;
375 cmp->max_sessions_per_worker = 4;
377 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
379 if (unformat (input, "num-sessions %d", &num_sessions))
383 (input, "max-sessions %d", &cmp->max_sessions_per_worker))
389 ct6_feature_init (cmp);
391 /* Set up starting src/dst addresses */
392 memset (src, 0, sizeof (src));
393 memset (dst, 0, sizeof (dst));
402 * See if we know about this flow.
403 * Key set up for the out2in path, the performant case
405 key0 = (ct6_session_key_t *) & kvp0;
406 memset (&kvp0, 0, sizeof (kvp0));
408 for (i = 0; i < num_sessions; i++)
410 clib_memcpy_fast (&key0->src, src, sizeof (src));
411 clib_memcpy_fast (&key0->dst, dst, sizeof (dst));
414 key0->sport = clib_host_to_net_u16 (1234);
415 key0->dport = clib_host_to_net_u16 (4321);
416 key0->proto = 17; /* udp, fwiw */
418 s0 = ct6_create_or_recycle_session
419 (cmp, &kvp0, 3.0 /* now */ , 0 /* thread index */ ,
420 &recycled, &created);
422 s = format (s, "%U (%d, %d)", format_ct6_session, cmp,
423 0 /* thread index */ , s0, 1 /* verbose */ ,
425 vlib_cli_output (vm, "%v", s);
427 increment_v6_address ((ip6_address_t *) src);
433 pool_foreach (s0, cmp->sessions[0])
435 s = format (s, "%U", format_ct6_session, cmp, 0, s0, 1 /* verbose */);
439 vlib_cli_output (vm, "\nEnd state: first index %d last index %d\n%v",
440 cmp->first_index[0], cmp->last_index[0], s);
444 midpt_index = cmp->max_sessions_per_worker / 3;
446 s0 = pool_elt_at_index (cmp->sessions[0], midpt_index);
447 vlib_cli_output (vm, "\nSimulate LRU hit on session %d",
448 s0 - cmp->sessions[0]);
450 ct6_update_session_hit (cmp, s0, 234.0);
453 pool_foreach (s0, cmp->sessions[0])
455 s = format (s, "%U", format_ct6_session, cmp, 0, s0, 1 /* verbose */);
459 vlib_cli_output (vm, "\nEnd state: first index %d last index %d\n%v",
460 cmp->first_index[0], cmp->last_index[0], s);
468 VLIB_CLI_COMMAND (test_ct6_command_fn_command, static) =
470 .path = "test ip6 connection-tracker",
471 .short_help = "test ip6 connection-tracker",
472 .function = test_ct6_command_fn_command_fn,
476 static clib_error_t *
477 ct6_config (vlib_main_t * vm, unformat_input_t * input)
479 ct6_main_t *cmp = &ct6_main;
481 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
483 if (unformat (input, "session-hash-buckets %u",
484 &cmp->session_hash_buckets))
486 else if (unformat (input, "session-hash-memory %U",
487 unformat_memory_size, &cmp->session_hash_memory))
489 else if (unformat (input, "session-timeout %f",
490 &cmp->session_timeout_interval))
494 return clib_error_return (0, "unknown input '%U'",
495 format_unformat_error, input);
501 VLIB_CONFIG_FUNCTION (ct6_config, "ct6");
504 * fd.io coding-style-patch-verification: ON
507 * eval: (c-set-style "gnu")