FD.io VPP  v19.08.3-2-gbabecb413
Vector Packet Processing
vxlan_gpe_ioam_trace.c
Go to the documentation of this file.
1 /*
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:
6  *
7  * http://www.apache.org/licenses/LICENSE-2.0
8  *
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.
14  */
15 #include <vlib/vlib.h>
16 #include <vnet/vnet.h>
17 #include <vnet/pg/pg.h>
18 #include <vppinfra/error.h>
19 
22 
23 #include <vppinfra/hash.h>
24 #include <vppinfra/error.h>
25 #include <vppinfra/elog.h>
26 
30 
31 /* Timestamp precision multipliers for seconds, milliseconds, microseconds
32  * and nanoseconds respectively.
33  */
34 static f64 trace_tsp_mul[4] = { 1, 1e3, 1e6, 1e9 };
35 
36 typedef union
37 {
38  u64 as_u64;
39  u32 as_u32[2];
40 } time_u64_t;
41 
42 
43 /* *INDENT-OFF* */
44 typedef CLIB_PACKED(struct {
46  u8 ioam_trace_type;
47  u8 data_list_elts_left;
48  u32 elts[0]; /* Variable type. So keep it generic */
49 }) vxlan_gpe_ioam_trace_option_t;
50 /* *INDENT-ON* */
51 
52 
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")
56 
57 static char *vxlan_gpe_ioam_trace_stats_strings[] = {
58 #define _(sym,string) string,
60 #undef _
61 };
62 
63 typedef enum
64 {
65 #define _(sym,str) VXLAN_GPE_IOAM_TRACE_##sym,
67 #undef _
70 
71 
72 typedef struct
73 {
74  /* stats */
75  u64 counters[ARRAY_LEN (vxlan_gpe_ioam_trace_stats_strings)];
76 
77  /* convenience */
81 
83 
84 int
86  u8 size,
87  int rewrite_options (u8 * rewrite_string,
88  u8 * rewrite_size))
89 {
91 
92  ASSERT ((u32) option < ARRAY_LEN (hm->add_options));
93 
94  /* Already registered */
95  if (hm->add_options[option])
96  return (-1);
97 
98  hm->add_options[option] = rewrite_options;
99  hm->options_size[option] = size;
100 
101  return (0);
102 }
103 
104 int
106 {
108 
109  ASSERT ((u32) option < ARRAY_LEN (hm->add_options));
110 
111  /* Not registered */
112  if (!hm->add_options[option])
113  return (-1);
114 
115  hm->add_options[option] = NULL;
116  hm->options_size[option] = 0;
117  return (0);
118 }
119 
120 
121 int
123  int options (vlib_buffer_t * b,
125  u8 is_ipv4, u8 use_adj),
126  u8 * trace (u8 * s,
128 {
130 
131  ASSERT ((u32) option < ARRAY_LEN (im->options));
132 
133  /* Already registered */
134  if (im->options[option])
135  return (-1);
136 
137  im->options[option] = options;
138  im->trace[option] = trace;
139 
140  return (0);
141 }
142 
143 int
145 {
147 
148  ASSERT ((u32) option < ARRAY_LEN (hm->options));
149 
150  /* Not registered */
151  if (!hm->options[option])
152  return (-1);
153 
154  hm->options[option] = NULL;
155  hm->trace[option] = NULL;
156 
157  return (0);
158 }
159 
160 
161 always_inline void
163  u64 increment)
164 {
166 
167  hm->counters[counter_index] += increment;
168 }
169 
170 
171 static u8 *
172 format_ioam_data_list_element (u8 * s, va_list * args)
173 {
174  u32 *elt = va_arg (*args, u32 *);
175  u8 *trace_type_p = va_arg (*args, u8 *);
176  u8 trace_type = *trace_type_p;
177 
178 
179  if (trace_type & BIT_TTL_NODEID)
180  {
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);
185 
186  elt++;
187  }
188 
189  if (trace_type & BIT_ING_INTERFACE && trace_type & BIT_ING_INTERFACE)
190  {
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);
195  elt++;
196  }
197 
198  if (trace_type & BIT_TIMESTAMP)
199  {
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);
202  elt++;
203  }
204 
205  if (trace_type & BIT_APPDATA)
206  {
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);
209  elt++;
210  }
211 
212  return s;
213 }
214 
215 
216 
217 int
218 vxlan_gpe_ioam_trace_rewrite_handler (u8 * rewrite_string, u8 * rewrite_size)
219 {
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;
224 
225 
226  profile = trace_profile_find ();
227 
228  if (PREDICT_FALSE (!profile))
229  {
230  return (-1);
231  }
232 
233  if (PREDICT_FALSE (!rewrite_string))
234  return -1;
235 
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;
244  *rewrite_size =
245  sizeof (vxlan_gpe_ioam_trace_option_t) +
246  (trace_option_elts * trace_data_size);
247 
248  return 0;
249 }
250 
251 
252 int
255  u8 is_ipv4, u8 use_adj)
256 {
257  u8 elt_index = 0;
258  vxlan_gpe_ioam_trace_option_t *trace =
259  (vxlan_gpe_ioam_trace_option_t *) opt;
260  time_u64_t time_u64;
261  u32 *elt;
262  int rv = 0;
263  trace_profile *profile = NULL;
265 
266 
267  profile = trace_profile_find ();
268 
269  if (PREDICT_FALSE (!profile))
270  {
271  return (-1);
272  }
273 
274 
275  time_u64.as_u64 = 0;
276 
277  if (PREDICT_TRUE (trace->data_list_elts_left))
278  {
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.
282  */
283  elt_index =
284  trace->data_list_elts_left *
285  fetch_trace_data_size (trace->ioam_trace_type) / 4;
286  elt = &trace->elts[elt_index];
287  if (is_ipv4)
288  {
289  if (trace->ioam_trace_type & BIT_TTL_NODEID)
290  {
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.
295  */
296  *elt = clib_host_to_net_u32 (((ip0->ttl - 1 + use_adj) << 24) |
297  profile->node_id);
298  elt++;
299  }
300 
301  if (trace->ioam_trace_type & BIT_ING_INTERFACE)
302  {
303  u16 tx_if = 0;
304  u32 adj_index = vnet_buffer (b)->ip.adj_index[VLIB_TX];
305 
306  if (use_adj)
307  {
308  ip_adjacency_t *adj = adj_get (adj_index);
309  tx_if = adj->rewrite_header.sw_if_index & 0xFFFF;
310  }
311 
312  *elt =
313  (vnet_buffer (b)->sw_if_index[VLIB_RX] & 0xFFFF) << 16 |
314  tx_if;
315  *elt = clib_host_to_net_u32 (*elt);
316  elt++;
317  }
318  }
319  else
320  {
321  if (trace->ioam_trace_type & BIT_TTL_NODEID)
322  {
324  *elt = clib_host_to_net_u32 ((ip0->hop_limit << 24) |
325  profile->node_id);
326  elt++;
327  }
328  if (trace->ioam_trace_type & BIT_ING_INTERFACE)
329  {
330  u16 tx_if = 0;
331  u32 adj_index = vnet_buffer (b)->ip.adj_index[VLIB_TX];
332 
333  if (use_adj)
334  {
335  ip_adjacency_t *adj = adj_get (adj_index);
336  tx_if = adj->rewrite_header.sw_if_index & 0xFFFF;
337  }
338 
339  *elt =
340  (vnet_buffer (b)->sw_if_index[VLIB_RX] & 0xFFFF) << 16 |
341  tx_if;
342  *elt = clib_host_to_net_u32 (*elt);
343  elt++;
344  }
345  }
346 
347  if (trace->ioam_trace_type & BIT_TIMESTAMP)
348  {
349  /* Send least significant 32 bits */
350  f64 time_f64 =
351  (f64) (((f64) hm->unix_time_0) +
352  (vlib_time_now (hm->vlib_main) - hm->vlib_time_0));
353 
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]);
356  elt++;
357  }
358 
359  if (trace->ioam_trace_type & BIT_APPDATA)
360  {
361  /* $$$ set elt0->app_data */
362  *elt = clib_host_to_net_u32 (profile->app_data);
363  elt++;
364  }
366  (VXLAN_GPE_IOAM_TRACE_SUCCESS, 1);
367  }
368  else
369  {
371  (VXLAN_GPE_IOAM_TRACE_FAILED, 1);
372  }
373  return (rv);
374 }
375 
376 u8 *
379 {
380  vxlan_gpe_ioam_trace_option_t *trace;
381  u8 trace_data_size_in_words = 0;
382  u32 *elt;
383  int elt_index = 0;
384 
385  trace = (vxlan_gpe_ioam_trace_option_t *) opt;
386  s =
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 */ ))
394  {
395  s = format (s, " [%d] %U\n", elt_index,
397  elt, &trace->ioam_trace_type);
398  elt_index++;
399  elt += trace_data_size_in_words;
400  }
401  return (s);
402 }
403 
404 
405 static clib_error_t *
407  unformat_input_t * input,
408  vlib_cli_command_t * cmd)
409 {
411  u8 *s = 0;
412  int i = 0;
413 
414  for (i = 0; i < VXLAN_GPE_IOAM_TRACE_N_STATS; i++)
415  {
416  s = format (s, " %s - %lu\n", vxlan_gpe_ioam_trace_stats_strings[i],
417  hm->counters[i]);
418  }
419 
420  vlib_cli_output (vm, "%v", s);
421  vec_free (s);
422  return 0;
423 }
424 
425 
426 /* *INDENT-OFF* */
427 VLIB_CLI_COMMAND (vxlan_gpe_show_ioam_trace_cmd, static) = {
428  .path = "show ioam vxlan-gpe trace",
429  .short_help = "iOAM trace statistics",
431 };
432 /* *INDENT-ON* */
433 
434 
435 static clib_error_t *
437 {
439 
440  hm->vlib_main = vm;
441  hm->vnet_main = vnet_get_main ();
442  clib_memset (hm->counters, 0, sizeof (hm->counters));
443 
448  return (clib_error_create
449  ("registration of VXLAN_GPE_OPTION_TYPE_IOAM_TRACE failed"));
450 
451 
454  sizeof (vxlan_gpe_ioam_trace_option_t),
456  return (clib_error_create
457  ("registration of VXLAN_GPE_OPTION_TYPE_IOAM_TRACE for rewrite failed"));
458 
459 
460  return (0);
461 }
462 
463 /* *INDENT-OFF* */
465 {
466  .runs_after = VLIB_INITS("ip_main_init", "ip6_lookup_init",
467  "vxlan_gpe_init"),
468 };
469 /* *INDENT-ON* */
470 
471 
472 int
474 {
476 
478 
479  return 0;
480 
481 }
482 
483 static int
485 {
486  u16 size = 0;
487  u8 trace_data_size = 0;
488  trace_profile *profile = NULL;
489 
490  *result = 0;
491 
492  profile = trace_profile_find ();
493 
494  if (PREDICT_FALSE (!profile))
495  {
496  return (-1);
497  }
498 
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;
502 
503  if (PREDICT_FALSE (profile->num_elts * trace_data_size > 254))
504  return VNET_API_ERROR_INVALID_VALUE;
505 
506  size +=
507  sizeof (vxlan_gpe_ioam_trace_option_t) +
508  profile->num_elts * trace_data_size;
509  *result = size;
510 
511  return 0;
512 }
513 
514 
515 int
517 {
518  u32 trace_size = 0;
520 
521  trace_profile *profile = NULL;
522 
523 
524  profile = trace_profile_find ();
525 
526  if (PREDICT_FALSE (!profile))
527  {
528  return (-1);
529  }
530 
531 
532  if (vxlan_gpe_ioam_trace_get_sizeof_handler (&trace_size) < 0)
533  return (-1);
534 
536 
537  return (0);
538 }
539 
540 
541 
542 /*
543  * fd.io coding-style-patch-verification: ON
544  *
545  * Local Variables:
546  * eval: (c-set-style "gnu")
547  * End:
548  */
u32 as_u32[2]
static void vxlan_gpe_ioam_trace_stats_increment_counter(u32 counter_index, u64 increment)
static vlib_cli_command_t trace
(constructor) VLIB_CLI_COMMAND (trace)
Definition: vlib_api_cli.c:889
vnet_main_t * vnet_get_main(void)
Definition: misc.c:46
vlib_main_t * vlib_main
State convenience vlib_main_t.
u64 as_u64
Definition: bihash_doc.h:63
#define PREDICT_TRUE(x)
Definition: clib.h:113
unsigned long u64
Definition: types.h:89
static int vxlan_gpe_ioam_trace_get_sizeof_handler(u32 *result)
clib_memset(h->entries, 0, sizeof(h->entries[0]) *entries)
static f64 vlib_time_now(vlib_main_t *vm)
Definition: main.h:279
IP unicast adjacency.
Definition: adj.h:221
VXLAN GPE definitions.
static u8 fetch_trace_data_size(u16 trace_type)
Definition: trace_util.h:209
static trace_profile * trace_profile_find(void)
Definition: trace_config.h:24
int i
u8 * format(u8 *s, const char *fmt,...)
Definition: format.c:424
unsigned char u8
Definition: types.h:56
double f64
Definition: types.h:142
static ip_adjacency_t * adj_get(adj_index_t adj_index)
Get a pointer to an adjacency object from its index.
Definition: adj.h:433
static clib_error_t * vxlan_gpe_ioam_trace_init(vlib_main_t *vm)
#define VLIB_INIT_FUNCTION(x)
Definition: init.h:173
#define always_inline
Definition: clib.h:99
vxlan_gpe_ioam_main_t vxlan_gpe_ioam_main
int vxlan_gpe_ioam_trace_rewrite_handler(u8 *rewrite_string, u8 *rewrite_size)
unsigned int u32
Definition: types.h:88
#define clib_error_create(args...)
Definition: error.h:96
int vxlan_gpe_trace_profile_setup(void)
int vxlan_gpe_ioam_register_option(u8 option, int options(vlib_buffer_t *b, vxlan_gpe_ioam_option_t *opt, u8 is_ipv4, u8 use_adj), u8 *trace(u8 *s, vxlan_gpe_ioam_option_t *opt))
int vxlan_gpe_ioam_add_register_option(u8 option, u8 size, int rewrite_options(u8 *rewrite_string, u8 *rewrite_size))
VXLAN GPE packet header structure.
uword size
struct _unformat_input_t unformat_input_t
unsigned short u16
Definition: types.h:57
u64 counters[ARRAY_LEN(vxlan_gpe_ioam_trace_stats_strings)]
static void * vlib_buffer_get_current(vlib_buffer_t *b)
Get pointer to current data to process.
Definition: buffer.h:229
#define PREDICT_FALSE(x)
Definition: clib.h:112
typedef CLIB_PACKED(struct { vxlan_gpe_ioam_option_t hdr;u8 ioam_trace_type;u8 data_list_elts_left;u32 elts[0];})
static u32 counter_index(vlib_main_t *vm, vlib_error_t e)
Definition: drop.c:67
#define VXLAN_GPE_OPTION_TYPE_IOAM_TRACE
#define foreach_vxlan_gpe_ioam_trace_stats
The fine-grained event logger allows lightweight, thread-safe event logging at minimum cost...
static clib_error_t * vxlan_gpe_show_ioam_trace_cmd_fn(vlib_main_t *vm, unformat_input_t *input, vlib_cli_command_t *cmd)
vlib_main_t * vm
Definition: buffer.c:323
vxlan_gpe_ioam_trace_main_t vxlan_gpe_ioam_trace_main
#define vec_free(V)
Free vector&#39;s memory (no header).
Definition: vec.h:341
#define ARRAY_LEN(x)
Definition: clib.h:63
#define BIT_ING_INTERFACE
Definition: trace_util.h:90
#define BIT_TTL_NODEID
Definition: trace_util.h:89
#define TRACE_TYPE_MASK
Definition: trace_util.h:96
#define VLIB_CLI_COMMAND(x,...)
Definition: cli.h:161
#define BIT_APPDATA
Definition: trace_util.h:93
int(* add_options[256])(u8 *rewrite_string, u8 *rewrite_size)
#define ASSERT(truth)
int vxlan_gpe_ioam_unregister_option(u8 option)
int vxlan_gpe_trace_profile_cleanup(void)
int(* options[256])(vlib_buffer_t *b, vxlan_gpe_ioam_option_t *opt, u8 is_ipv4, u8 use_adj)
vxlan_gpe_ioam_trace_stats_t
Definition: defs.h:47
u8 * vxlan_gpe_ioam_trace_data_list_trace_handler(u8 *s, vxlan_gpe_ioam_option_t *opt)
VLIB buffer representation.
Definition: buffer.h:102
int vxlan_gpe_ioam_trace_data_list_handler(vlib_buffer_t *b, vxlan_gpe_ioam_option_t *opt, u8 is_ipv4, u8 use_adj)
#define vnet_buffer(b)
Definition: buffer.h:365
static struct option options[]
Definition: main.c:52
static f64 trace_tsp_mul[4]
int vxlan_gpe_add_unregister_option(u8 option)
void vlib_cli_output(vlib_main_t *vm, char *fmt,...)
Definition: cli.c:772
#define VLIB_INITS(...)
Definition: init.h:344
Definition: defs.h:46
#define BIT_TIMESTAMP
Definition: trace_util.h:92
u8 *(* trace[256])(u8 *s, vxlan_gpe_ioam_option_t *opt)
static u8 * format_ioam_data_list_element(u8 *s, va_list *args)