2 * Copyright (c) 2016 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.
15 #include <vlib/vlib.h>
16 #include <vnet/vnet.h>
17 #include <vnet/pg/pg.h>
18 #include <vppinfra/error.h>
20 #include <vnet/vxlan-gpe/vxlan_gpe.h>
21 #include <vnet/vxlan-gpe/vxlan_gpe_packet.h>
23 #include <vppinfra/hash.h>
24 #include <vppinfra/error.h>
25 #include <vppinfra/elog.h>
27 #include <ioam/lib-trace/trace_util.h>
28 #include <ioam/lib-trace/trace_config.h>
29 #include <ioam/lib-vxlan-gpe/vxlan_gpe_ioam.h>
31 /* Timestamp precision multipliers for seconds, milliseconds, microseconds
32 * and nanoseconds respectively.
34 static f64 trace_tsp_mul[4] = { 1, 1e3, 1e6, 1e9 };
44 typedef CLIB_PACKED(struct {
45 vxlan_gpe_ioam_option_t hdr;
47 u8 data_list_elts_left;
48 u32 elts[0]; /* Variable type. So keep it generic */
49 }) vxlan_gpe_ioam_trace_option_t;
53 #define foreach_vxlan_gpe_ioam_trace_stats \
54 _(SUCCESS, "Pkts updated with TRACE records") \
55 _(FAILED, "Errors in TRACE due to lack of TRACE records")
57 static char *vxlan_gpe_ioam_trace_stats_strings[] = {
58 #define _(sym,string) string,
59 foreach_vxlan_gpe_ioam_trace_stats
65 #define _(sym,str) VXLAN_GPE_IOAM_TRACE_##sym,
66 foreach_vxlan_gpe_ioam_trace_stats
68 VXLAN_GPE_IOAM_TRACE_N_STATS,
69 } vxlan_gpe_ioam_trace_stats_t;
75 u64 counters[ARRAY_LEN (vxlan_gpe_ioam_trace_stats_strings)];
78 vlib_main_t *vlib_main;
79 vnet_main_t *vnet_main;
80 } vxlan_gpe_ioam_trace_main_t;
82 vxlan_gpe_ioam_trace_main_t vxlan_gpe_ioam_trace_main;
85 vxlan_gpe_ioam_add_register_option (u8 option,
87 int rewrite_options (u8 * rewrite_string,
90 vxlan_gpe_ioam_main_t *hm = &vxlan_gpe_ioam_main;
92 ASSERT ((u32) option < ARRAY_LEN (hm->add_options));
94 /* Already registered */
95 if (hm->add_options[option])
98 hm->add_options[option] = rewrite_options;
99 hm->options_size[option] = size;
105 vxlan_gpe_add_unregister_option (u8 option)
107 vxlan_gpe_ioam_main_t *hm = &vxlan_gpe_ioam_main;
109 ASSERT ((u32) option < ARRAY_LEN (hm->add_options));
112 if (!hm->add_options[option])
115 hm->add_options[option] = NULL;
116 hm->options_size[option] = 0;
122 vxlan_gpe_ioam_register_option (u8 option,
123 int options (vlib_buffer_t * b,
124 vxlan_gpe_ioam_option_t * opt,
125 u8 is_ipv4, u8 use_adj),
127 vxlan_gpe_ioam_option_t * opt))
129 vxlan_gpe_ioam_main_t *im = &vxlan_gpe_ioam_main;
131 ASSERT ((u32) option < ARRAY_LEN (im->options));
133 /* Already registered */
134 if (im->options[option])
137 im->options[option] = options;
138 im->trace[option] = trace;
144 vxlan_gpe_ioam_unregister_option (u8 option)
146 vxlan_gpe_ioam_main_t *hm = &vxlan_gpe_ioam_main;
148 ASSERT ((u32) option < ARRAY_LEN (hm->options));
151 if (!hm->options[option])
154 hm->options[option] = NULL;
155 hm->trace[option] = NULL;
162 vxlan_gpe_ioam_trace_stats_increment_counter (u32 counter_index,
165 vxlan_gpe_ioam_trace_main_t *hm = &vxlan_gpe_ioam_trace_main;
167 hm->counters[counter_index] += increment;
172 format_ioam_data_list_element (u8 * s, va_list * args)
174 u32 *elt = va_arg (*args, u32 *);
175 u8 *trace_type_p = va_arg (*args, u8 *);
176 u8 trace_type = *trace_type_p;
179 if (trace_type & BIT_TTL_NODEID)
181 u32 ttl_node_id_host_byte_order = clib_net_to_host_u32 (*elt);
182 s = format (s, "ttl 0x%x node id 0x%x ",
183 ttl_node_id_host_byte_order >> 24,
184 ttl_node_id_host_byte_order & 0x00FFFFFF);
189 if (trace_type & BIT_ING_INTERFACE && trace_type & BIT_ING_INTERFACE)
191 u32 ingress_host_byte_order = clib_net_to_host_u32 (*elt);
192 s = format (s, "ingress 0x%x egress 0x%x ",
193 ingress_host_byte_order >> 16,
194 ingress_host_byte_order & 0xFFFF);
198 if (trace_type & BIT_TIMESTAMP)
200 u32 ts_in_host_byte_order = clib_net_to_host_u32 (*elt);
201 s = format (s, "ts 0x%x \n", ts_in_host_byte_order);
205 if (trace_type & BIT_APPDATA)
207 u32 appdata_in_host_byte_order = clib_net_to_host_u32 (*elt);
208 s = format (s, "app 0x%x ", appdata_in_host_byte_order);
218 vxlan_gpe_ioam_trace_rewrite_handler (u8 * rewrite_string, u8 * rewrite_size)
220 vxlan_gpe_ioam_trace_option_t *trace_option = NULL;
221 u8 trace_data_size = 0;
222 u8 trace_option_elts = 0;
223 trace_profile *profile = NULL;
226 profile = trace_profile_find ();
228 if (PREDICT_FALSE (!profile))
233 if (PREDICT_FALSE (!rewrite_string))
236 trace_option_elts = profile->num_elts;
237 trace_data_size = fetch_trace_data_size (profile->trace_type);
238 trace_option = (vxlan_gpe_ioam_trace_option_t *) rewrite_string;
239 trace_option->hdr.type = VXLAN_GPE_OPTION_TYPE_IOAM_TRACE;
240 trace_option->hdr.length = 2 /*ioam_trace_type,data_list_elts_left */ +
241 trace_option_elts * trace_data_size;
242 trace_option->ioam_trace_type = profile->trace_type & TRACE_TYPE_MASK;
243 trace_option->data_list_elts_left = trace_option_elts;
245 sizeof (vxlan_gpe_ioam_trace_option_t) +
246 (trace_option_elts * trace_data_size);
253 vxlan_gpe_ioam_trace_data_list_handler (vlib_buffer_t * b,
254 vxlan_gpe_ioam_option_t * opt,
255 u8 is_ipv4, u8 use_adj)
258 vxlan_gpe_ioam_trace_option_t *trace =
259 (vxlan_gpe_ioam_trace_option_t *) opt;
263 trace_profile *profile = NULL;
264 vxlan_gpe_ioam_main_t *hm = &vxlan_gpe_ioam_main;
267 profile = trace_profile_find ();
269 if (PREDICT_FALSE (!profile))
277 if (PREDICT_TRUE (trace->data_list_elts_left))
279 trace->data_list_elts_left--;
280 /* fetch_trace_data_size returns in bytes. Convert it to 4-bytes
281 * to skip to this node's location.
284 trace->data_list_elts_left *
285 fetch_trace_data_size (trace->ioam_trace_type) / 4;
286 elt = &trace->elts[elt_index];
289 if (trace->ioam_trace_type & BIT_TTL_NODEID)
291 ip4_header_t *ip0 = vlib_buffer_get_current (b);
292 /* The transit case is the only case where the TTL decrement happens
293 * before iOAM processing. For now, use the use_adj flag as an overload.
294 * We can probably use a separate flag instead of overloading the use_adj flag.
296 *elt = clib_host_to_net_u32 (((ip0->ttl - 1 + use_adj) << 24) |
301 if (trace->ioam_trace_type & BIT_ING_INTERFACE)
304 u32 adj_index = vnet_buffer (b)->ip.adj_index[VLIB_TX];
308 ip_adjacency_t *adj = adj_get (adj_index);
309 tx_if = adj->rewrite_header.sw_if_index & 0xFFFF;
313 (vnet_buffer (b)->sw_if_index[VLIB_RX] & 0xFFFF) << 16 |
315 *elt = clib_host_to_net_u32 (*elt);
321 if (trace->ioam_trace_type & BIT_TTL_NODEID)
323 ip6_header_t *ip0 = vlib_buffer_get_current (b);
324 *elt = clib_host_to_net_u32 ((ip0->hop_limit << 24) |
328 if (trace->ioam_trace_type & BIT_ING_INTERFACE)
331 u32 adj_index = vnet_buffer (b)->ip.adj_index[VLIB_TX];
335 ip_adjacency_t *adj = adj_get (adj_index);
336 tx_if = adj->rewrite_header.sw_if_index & 0xFFFF;
340 (vnet_buffer (b)->sw_if_index[VLIB_RX] & 0xFFFF) << 16 |
342 *elt = clib_host_to_net_u32 (*elt);
347 if (trace->ioam_trace_type & BIT_TIMESTAMP)
349 /* Send least significant 32 bits */
351 (f64) (((f64) hm->unix_time_0) +
352 (vlib_time_now (hm->vlib_main) - hm->vlib_time_0));
354 time_u64.as_u64 = time_f64 * trace_tsp_mul[profile->trace_tsp];
355 *elt = clib_host_to_net_u32 (time_u64.as_u32[0]);
359 if (trace->ioam_trace_type & BIT_APPDATA)
361 /* $$$ set elt0->app_data */
362 *elt = clib_host_to_net_u32 (profile->app_data);
365 vxlan_gpe_ioam_trace_stats_increment_counter
366 (VXLAN_GPE_IOAM_TRACE_SUCCESS, 1);
370 vxlan_gpe_ioam_trace_stats_increment_counter
371 (VXLAN_GPE_IOAM_TRACE_FAILED, 1);
377 vxlan_gpe_ioam_trace_data_list_trace_handler (u8 * s,
378 vxlan_gpe_ioam_option_t * opt)
380 vxlan_gpe_ioam_trace_option_t *trace;
381 u8 trace_data_size_in_words = 0;
385 trace = (vxlan_gpe_ioam_trace_option_t *) opt;
387 format (s, " Trace Type 0x%x , %d elts left\n", trace->ioam_trace_type,
388 trace->data_list_elts_left);
389 trace_data_size_in_words =
390 fetch_trace_data_size (trace->ioam_trace_type) / 4;
391 elt = &trace->elts[0];
392 while ((u8 *) elt < ((u8 *) (&trace->elts[0]) + trace->hdr.length - 2
393 /* -2 accounts for ioam_trace_type,elts_left */ ))
395 s = format (s, " [%d] %U\n", elt_index,
396 format_ioam_data_list_element,
397 elt, &trace->ioam_trace_type);
399 elt += trace_data_size_in_words;
405 static clib_error_t *
406 vxlan_gpe_show_ioam_trace_cmd_fn (vlib_main_t * vm,
407 unformat_input_t * input,
408 vlib_cli_command_t * cmd)
410 vxlan_gpe_ioam_trace_main_t *hm = &vxlan_gpe_ioam_trace_main;
414 for (i = 0; i < VXLAN_GPE_IOAM_TRACE_N_STATS; i++)
416 s = format (s, " %s - %lu\n", vxlan_gpe_ioam_trace_stats_strings[i],
420 vlib_cli_output (vm, "%v", s);
427 VLIB_CLI_COMMAND (vxlan_gpe_show_ioam_trace_cmd, static) = {
428 .path = "show ioam vxlan-gpe trace",
429 .short_help = "iOAM trace statistics",
430 .function = vxlan_gpe_show_ioam_trace_cmd_fn,
435 static clib_error_t *
436 vxlan_gpe_ioam_trace_init (vlib_main_t * vm)
438 vxlan_gpe_ioam_trace_main_t *hm = &vxlan_gpe_ioam_trace_main;
441 hm->vnet_main = vnet_get_main ();
442 clib_memset (hm->counters, 0, sizeof (hm->counters));
444 if (vxlan_gpe_ioam_register_option
445 (VXLAN_GPE_OPTION_TYPE_IOAM_TRACE,
446 vxlan_gpe_ioam_trace_data_list_handler,
447 vxlan_gpe_ioam_trace_data_list_trace_handler) < 0)
448 return (clib_error_create
449 ("registration of VXLAN_GPE_OPTION_TYPE_IOAM_TRACE failed"));
452 if (vxlan_gpe_ioam_add_register_option
453 (VXLAN_GPE_OPTION_TYPE_IOAM_TRACE,
454 sizeof (vxlan_gpe_ioam_trace_option_t),
455 vxlan_gpe_ioam_trace_rewrite_handler) < 0)
456 return (clib_error_create
457 ("registration of VXLAN_GPE_OPTION_TYPE_IOAM_TRACE for rewrite failed"));
464 VLIB_INIT_FUNCTION (vxlan_gpe_ioam_trace_init) =
466 .runs_after = VLIB_INITS("ip_main_init", "ip6_lookup_init",
473 vxlan_gpe_trace_profile_cleanup (void)
475 vxlan_gpe_ioam_main_t *hm = &vxlan_gpe_ioam_main;
477 hm->options_size[VXLAN_GPE_OPTION_TYPE_IOAM_TRACE] = 0;
484 vxlan_gpe_ioam_trace_get_sizeof_handler (u32 * result)
487 u8 trace_data_size = 0;
488 trace_profile *profile = NULL;
492 profile = trace_profile_find ();
494 if (PREDICT_FALSE (!profile))
499 trace_data_size = fetch_trace_data_size (profile->trace_type);
500 if (PREDICT_FALSE (trace_data_size == 0))
501 return VNET_API_ERROR_INVALID_VALUE;
503 if (PREDICT_FALSE (profile->num_elts * trace_data_size > 254))
504 return VNET_API_ERROR_INVALID_VALUE;
507 sizeof (vxlan_gpe_ioam_trace_option_t) +
508 profile->num_elts * trace_data_size;
516 vxlan_gpe_trace_profile_setup (void)
519 vxlan_gpe_ioam_main_t *hm = &vxlan_gpe_ioam_main;
521 trace_profile *profile = NULL;
524 profile = trace_profile_find ();
526 if (PREDICT_FALSE (!profile))
532 if (vxlan_gpe_ioam_trace_get_sizeof_handler (&trace_size) < 0)
535 hm->options_size[VXLAN_GPE_OPTION_TYPE_IOAM_TRACE] = trace_size;
543 * fd.io coding-style-patch-verification: ON
546 * eval: (c-set-style "gnu")