src/plugins/nsh/nsh-md2-ioam/nsh_md2_ioam_trace.c

   1 /*
   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:
   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
  20 #include <vppinfra/hash.h>
  21 #include <vppinfra/error.h>
  22 #include <vppinfra/elog.h>
  23
  24 #include <ioam/lib-trace/trace_util.h>
  25 #include <nsh/nsh-md2-ioam/nsh_md2_ioam.h>
  26 #include <nsh/nsh_packet.h>
  27
  28 /* Timestamp precision multipliers for seconds, milliseconds, microseconds
  29  * and nanoseconds respectively.
  30  */
  31 static f64 trace_tsp_mul[4] = { 1, 1e3, 1e6, 1e9 };
  32
  33 #define NSH_MD2_IOAM_TRACE_SIZE_DUMMY 20
  34
  35 typedef union
  36 {
  37   u64 as_u64;
  38   u32 as_u32[2];
  39 } time_u64_t;
  40
  41
  42 /* *INDENT-OFF* */
  43 typedef CLIB_PACKED(struct {
  44   u16 class;
  45   u8 type;
  46   u8 length;
  47   u8 data_list_elts_left;
  48   u16 ioam_trace_type;
  49   u8 reserve;
  50   u32 elts[0]; /* Variable type. So keep it generic */
  51 }) nsh_md2_ioam_trace_option_t;
  52 /* *INDENT-ON* */
  53
  54
  55 #define foreach_nsh_md2_ioam_trace_stats                                \
  56   _(SUCCESS, "Pkts updated with TRACE records")                                 \
  57   _(FAILED, "Errors in TRACE due to lack of TRACE records")
  58
  59 static char *nsh_md2_ioam_trace_stats_strings[] = {
  60 #define _(sym,string) string,
  61   foreach_nsh_md2_ioam_trace_stats
  62 #undef _
  63 };
  64
  65 typedef enum
  66 {
  67 #define _(sym,str) NSH_MD2_IOAM_TRACE_##sym,
  68   foreach_nsh_md2_ioam_trace_stats
  69 #undef _
  70     NSH_MD2_IOAM_TRACE_N_STATS,
  71 } nsh_md2_ioam_trace_stats_t;
  72
  73
  74 typedef struct
  75 {
  76   /* stats */
  77   u64 counters[ARRAY_LEN (nsh_md2_ioam_trace_stats_strings)];
  78
  79   /* convenience */
  80   vlib_main_t *vlib_main;
  81   vnet_main_t *vnet_main;
  82 } nsh_md2_ioam_trace_main_t;
  83
  84 nsh_md2_ioam_trace_main_t nsh_md2_ioam_trace_main;
  85
  86 /*
  87  * Find a trace profile
  88  */
  89
  90 extern u8 *nsh_trace_main;
  91 always_inline trace_profile *
  92 nsh_trace_profile_find (void)
  93 {
  94   trace_main_t *sm = (trace_main_t *) nsh_trace_main;
  95
  96   return (&(sm->profile));
  97 }
  98
  99
 100 always_inline void
 101 nsh_md2_ioam_trace_stats_increment_counter (u32 counter_index, u64 increment)
 102 {
 103   nsh_md2_ioam_trace_main_t *hm = &nsh_md2_ioam_trace_main;
 104
 105   hm->counters[counter_index] += increment;
 106 }
 107
 108
 109 static u8 *
 110 format_ioam_data_list_element (u8 * s, va_list * args)
 111 {
 112   u32 *elt = va_arg (*args, u32 *);
 113   u8 *trace_type_p = va_arg (*args, u8 *);
 114   u8 trace_type = *trace_type_p;
 115
 116
 117   if (trace_type & BIT_TTL_NODEID)
 118     {
 119       u32 ttl_node_id_host_byte_order = clib_net_to_host_u32 (*elt);
 120       s = format (s, "ttl 0x%x node id 0x%x ",
 121                   ttl_node_id_host_byte_order >> 24,
 122                   ttl_node_id_host_byte_order & 0x00FFFFFF);
 123
 124       elt++;
 125     }
 126
 127   if (trace_type & BIT_ING_INTERFACE && trace_type & BIT_ING_INTERFACE)
 128     {
 129       u32 ingress_host_byte_order = clib_net_to_host_u32 (*elt);
 130       s = format (s, "ingress 0x%x egress 0x%x ",
 131                   ingress_host_byte_order >> 16,
 132                   ingress_host_byte_order & 0xFFFF);
 133       elt++;
 134     }
 135
 136   if (trace_type & BIT_TIMESTAMP)
 137     {
 138       u32 ts_in_host_byte_order = clib_net_to_host_u32 (*elt);
 139       s = format (s, "ts 0x%x \n", ts_in_host_byte_order);
 140       elt++;
 141     }
 142
 143   if (trace_type & BIT_APPDATA)
 144     {
 145       u32 appdata_in_host_byte_order = clib_net_to_host_u32 (*elt);
 146       s = format (s, "app 0x%x ", appdata_in_host_byte_order);
 147       elt++;
 148     }
 149
 150   return s;
 151 }
 152
 153
 154
 155 int
 156 nsh_md2_ioam_trace_rewrite_handler (u8 * rewrite_string, u8 * rewrite_size)
 157 {
 158   nsh_md2_ioam_trace_option_t *trace_option = NULL;
 159   u8 trace_data_size = 0;
 160   u8 trace_option_elts = 0;
 161   trace_profile *profile = NULL;
 162
 163   profile = nsh_trace_profile_find ();
 164
 165   if (PREDICT_FALSE (!profile))
 166     {
 167       return (-1);
 168     }
 169
 170   if (PREDICT_FALSE (!rewrite_string))
 171     return -1;
 172
 173   trace_option_elts = profile->num_elts;
 174   trace_data_size = fetch_trace_data_size (profile->trace_type);
 175
 176   trace_option = (nsh_md2_ioam_trace_option_t *) rewrite_string;
 177   trace_option->class = clib_host_to_net_u16 (0x9);
 178   trace_option->type = NSH_MD2_IOAM_OPTION_TYPE_TRACE;
 179   trace_option->length = (trace_option_elts * trace_data_size) + 4;
 180   trace_option->data_list_elts_left = trace_option_elts;
 181   trace_option->ioam_trace_type =
 182     clib_host_to_net_u16 (profile->trace_type & TRACE_TYPE_MASK);
 183
 184   *rewrite_size =
 185     sizeof (nsh_md2_ioam_trace_option_t) +
 186     (trace_option_elts * trace_data_size);
 187
 188   return 0;
 189 }
 190
 191
 192 int
 193 nsh_md2_ioam_trace_data_list_handler (vlib_buffer_t * b,
 194                                       nsh_tlv_header_t * opt)
 195 {
 196   u8 elt_index = 0;
 197   nsh_md2_ioam_trace_option_t *trace =
 198     (nsh_md2_ioam_trace_option_t *) ((u8 *) opt);
 199   time_u64_t time_u64;
 200   u32 *elt;
 201   int rv = 0;
 202   trace_profile *profile = NULL;
 203   nsh_md2_ioam_main_t *hm = &nsh_md2_ioam_main;
 204   nsh_main_t *gm = &nsh_main;
 205   u16 ioam_trace_type = 0;
 206
 207   profile = nsh_trace_profile_find ();
 208
 209   if (PREDICT_FALSE (!profile))
 210     {
 211       return (-1);
 212     }
 213
 214
 215   ioam_trace_type = profile->trace_type & TRACE_TYPE_MASK;
 216   time_u64.as_u64 = 0;
 217
 218   if (PREDICT_TRUE (trace->data_list_elts_left))
 219     {
 220       trace->data_list_elts_left--;
 221       /* fetch_trace_data_size returns in bytes. Convert it to 4-bytes
 222        * to skip to this node's location.
 223        */
 224       elt_index =
 225         trace->data_list_elts_left *
 226         fetch_trace_data_size (ioam_trace_type) / 4;
 227       elt = &trace->elts[elt_index];
 228       if (ioam_trace_type & BIT_TTL_NODEID)
 229         {
 230           ip4_header_t *ip0 = vlib_buffer_get_current (b);
 231           *elt = clib_host_to_net_u32 (((ip0->ttl - 1) << 24) |
 232                                        profile->node_id);
 233           elt++;
 234         }
 235
 236       if (ioam_trace_type & BIT_ING_INTERFACE)
 237         {
 238           u16 tx_if = vnet_buffer (b)->sw_if_index[VLIB_TX];
 239
 240           *elt =
 241             (vnet_buffer (b)->sw_if_index[VLIB_RX] & 0xFFFF) << 16 | tx_if;
 242           *elt = clib_host_to_net_u32 (*elt);
 243           elt++;
 244         }
 245
 246
 247       if (ioam_trace_type & BIT_TIMESTAMP)
 248         {
 249           /* Send least significant 32 bits */
 250           f64 time_f64 =
 251             (f64) (((f64) hm->unix_time_0) +
 252                    (vlib_time_now (gm->vlib_main) - hm->vlib_time_0));
 253
 254           time_u64.as_u64 = time_f64 * trace_tsp_mul[profile->trace_tsp];
 255           *elt = clib_host_to_net_u32 (time_u64.as_u32[0]);
 256           elt++;
 257         }
 258
 259       if (ioam_trace_type & BIT_APPDATA)
 260         {
 261           /* $$$ set elt0->app_data */
 262           *elt = clib_host_to_net_u32 (profile->app_data);
 263           elt++;
 264         }
 265       nsh_md2_ioam_trace_stats_increment_counter
 266         (NSH_MD2_IOAM_TRACE_SUCCESS, 1);
 267     }
 268   else
 269     {
 270       nsh_md2_ioam_trace_stats_increment_counter
 271         (NSH_MD2_IOAM_TRACE_FAILED, 1);
 272     }
 273   return (rv);
 274 }
 275
 276
 277
 278 u8 *
 279 nsh_md2_ioam_trace_data_list_trace_handler (u8 * s, nsh_tlv_header_t * opt)
 280 {
 281   nsh_md2_ioam_trace_option_t *trace;
 282   u8 trace_data_size_in_words = 0;
 283   u32 *elt;
 284   int elt_index = 0;
 285   u16 ioam_trace_type = 0;
 286
 287   trace = (nsh_md2_ioam_trace_option_t *) ((u8 *) opt);
 288   ioam_trace_type = clib_net_to_host_u16 (trace->ioam_trace_type);
 289   trace_data_size_in_words = fetch_trace_data_size (ioam_trace_type) / 4;
 290   elt = &trace->elts[0];
 291   s =
 292     format (s, "  Trace Type 0x%x , %d elts left\n", ioam_trace_type,
 293             trace->data_list_elts_left);
 294   while ((u8 *) elt < ((u8 *) (&trace->elts[0]) + trace->length - 4
 295                        /* -2 accounts for ioam_trace_type,elts_left */ ))
 296     {
 297       s = format (s, "    [%d] %U\n", elt_index,
 298                   format_ioam_data_list_element, elt, &ioam_trace_type);
 299       elt_index++;
 300       elt += trace_data_size_in_words;
 301     }
 302   return (s);
 303 }
 304
 305 int
 306 nsh_md2_ioam_trace_swap_handler (vlib_buffer_t * b,
 307                                  nsh_tlv_header_t * old_opt,
 308                                  nsh_tlv_header_t * new_opt)
 309 {
 310
 311   clib_memcpy (new_opt, old_opt, new_opt->length + sizeof (nsh_tlv_header_t));
 312   return nsh_md2_ioam_trace_data_list_handler (b, new_opt);
 313 }
 314
 315 static clib_error_t *
 316 nsh_md2_ioam_show_ioam_trace_cmd_fn (vlib_main_t * vm,
 317                                      unformat_input_t * input,
 318                                      vlib_cli_command_t * cmd)
 319 {
 320   nsh_md2_ioam_trace_main_t *hm = &nsh_md2_ioam_trace_main;
 321   u8 *s = 0;
 322   int i = 0;
 323
 324   for (i = 0; i < NSH_MD2_IOAM_TRACE_N_STATS; i++)
 325     {
 326       s = format (s, " %s - %lu\n", nsh_md2_ioam_trace_stats_strings[i],
 327                   hm->counters[i]);
 328     }
 329
 330   vlib_cli_output (vm, "%v", s);
 331   vec_free (s);
 332   return 0;
 333 }
 334
 335
 336 /* *INDENT-OFF* */
 337 VLIB_CLI_COMMAND (nsh_md2_ioam_show_ioam_trace_cmd, static) = {
 338   .path = "show ioam nsh-lisp-gpe trace",
 339   .short_help = "iOAM trace statistics",
 340   .function = nsh_md2_ioam_show_ioam_trace_cmd_fn,
 341 };
 342 /* *INDENT-ON* */
 343
 344
 345 int
 346 nsh_md2_ioam_trace_pop_handler (vlib_buffer_t * b, nsh_tlv_header_t * opt)
 347 {
 348   return nsh_md2_ioam_trace_data_list_handler (b, opt);
 349 }
 350
 351 static clib_error_t *
 352 nsh_md2_ioam_trace_init (vlib_main_t * vm)
 353 {
 354   nsh_md2_ioam_trace_main_t *hm = &nsh_md2_ioam_trace_main;
 355   nsh_md2_ioam_main_t *gm = &nsh_md2_ioam_main;
 356   clib_error_t *error;
 357
 358   if ((error = vlib_call_init_function (vm, nsh_init)))
 359     return (error);
 360
 361   if ((error = vlib_call_init_function (vm, nsh_md2_ioam_init)))
 362     return (error);
 363
 364   hm->vlib_main = vm;
 365   hm->vnet_main = vnet_get_main ();
 366   gm->unix_time_0 = (u32) time (0);     /* Store starting time */
 367   gm->vlib_time_0 = vlib_time_now (vm);
 368
 369   memset (hm->counters, 0, sizeof (hm->counters));
 370
 371   if (nsh_md2_register_option
 372       (clib_host_to_net_u16 (0x9),
 373        NSH_MD2_IOAM_OPTION_TYPE_TRACE,
 374        NSH_MD2_IOAM_TRACE_SIZE_DUMMY,
 375        nsh_md2_ioam_trace_rewrite_handler,
 376        nsh_md2_ioam_trace_data_list_handler,
 377        nsh_md2_ioam_trace_swap_handler,
 378        nsh_md2_ioam_trace_pop_handler,
 379        nsh_md2_ioam_trace_data_list_trace_handler) < 0)
 380     return (clib_error_create
 381             ("registration of NSH_MD2_IOAM_OPTION_TYPE_TRACE failed"));
 382
 383   return (0);
 384 }
 385
 386 VLIB_INIT_FUNCTION (nsh_md2_ioam_trace_init);
 387
 388 int
 389 nsh_md2_ioam_trace_profile_cleanup (void)
 390 {
 391   nsh_main_t *hm = &nsh_main;
 392
 393   hm->options_size[NSH_MD2_IOAM_OPTION_TYPE_TRACE] = 0;
 394
 395   return 0;
 396
 397 }
 398
 399 static int
 400 nsh_md2_ioam_trace_get_sizeof_handler (u32 * result)
 401 {
 402   u16 size = 0;
 403   u8 trace_data_size = 0;
 404   trace_profile *profile = NULL;
 405
 406   *result = 0;
 407
 408   profile = nsh_trace_profile_find ();
 409
 410   if (PREDICT_FALSE (!profile))
 411     {
 412       return (-1);
 413     }
 414
 415   trace_data_size = fetch_trace_data_size (profile->trace_type);
 416   if (PREDICT_FALSE (trace_data_size == 0))
 417     return VNET_API_ERROR_INVALID_VALUE;
 418
 419   if (PREDICT_FALSE (profile->num_elts * trace_data_size > 254))
 420     return VNET_API_ERROR_INVALID_VALUE;
 421
 422   size +=
 423     sizeof (nsh_md2_ioam_trace_option_t) +
 424     profile->num_elts * trace_data_size;
 425   *result = size;
 426
 427   return 0;
 428 }
 429
 430
 431 int
 432 nsh_md2_ioam_trace_profile_setup (void)
 433 {
 434   u32 trace_size = 0;
 435   nsh_main_t *hm = &nsh_main;
 436
 437   trace_profile *profile = NULL;
 438
 439
 440   profile = nsh_trace_profile_find ();
 441
 442   if (PREDICT_FALSE (!profile))
 443     {
 444       return (-1);
 445     }
 446
 447
 448   if (nsh_md2_ioam_trace_get_sizeof_handler (&trace_size) < 0)
 449     return (-1);
 450
 451   hm->options_size[NSH_MD2_IOAM_OPTION_TYPE_TRACE] = trace_size;
 452
 453   return (0);
 454 }
 455
 456
 457
 458 /*
 459  * fd.io coding-style-patch-verification: ON
 460  *
 461  * Local Variables:
 462  * eval: (c-set-style "gnu")
 463  * End:
 464  */