src/plugins/ioam/analyse/ioam_analyse.h

   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
  16 #ifndef PLUGINS_IOAM_PLUGIN_IOAM_ANALYSE_IOAM_ANALYSE_H_
  17 #define PLUGINS_IOAM_PLUGIN_IOAM_ANALYSE_IOAM_ANALYSE_H_
  18
  19 #include <vlib/vlib.h>
  20 #include <vnet/vnet.h>
  21 #include <vppinfra/types.h>
  22 #include <ioam/lib-e2e/e2e_util.h>
  23 #include <ioam/lib-trace/trace_util.h>
  24
  25 #define IOAM_FLOW_TEMPLATE_ID    260
  26 #define IOAM_TRACE_MAX_NODES      10
  27 #define IOAM_MAX_PATHS_PER_FLOW   10
  28
  29 typedef struct
  30 {
  31   u16 ingress_if;
  32   u16 egress_if;
  33   u32 node_id;
  34 } ioam_path_map_t;
  35
  36 /** @brief Analysed iOAM trace data.
  37     @note cache aligned.
  38 */
  39 typedef struct
  40 {
  41   /** No of nodes in path. */
  42   u8 num_nodes;
  43
  44   /** Data contained in trace - NodeId, TTL, Ingress & Egress Link, Timestamp. */
  45   u8 trace_type;
  46
  47   /** Flag to indicate whether node is allocated. */
  48   u8 is_free;
  49
  50   u8 pad[5];
  51
  52   /** Actual PATH flow has taken. */
  53   ioam_path_map_t path[IOAM_TRACE_MAX_NODES];
  54
  55   /** Num of pkts in the flow going over path. */
  56   u32 pkt_counter;
  57
  58   /** Num of bytes in the flow going over path. */
  59   u32 bytes_counter;
  60
  61   /** Minumum Dealay for the flow. */
  62   u32 min_delay;
  63
  64   /** Maximum Dealay for the flow. */
  65   u32 max_delay;
  66
  67   /** Average Dealay for the flow. */
  68   u32 mean_delay;
  69
  70   u32 reserve;
  71 } ioam_analyse_trace_record;
  72
  73 typedef struct
  74 {
  75   ioam_analyse_trace_record path_data[IOAM_MAX_PATHS_PER_FLOW];
  76 } ioam_analyse_trace_data;
  77
  78 /** @brief Analysed iOAM pot data.
  79     @note cache aligned.
  80 */
  81 typedef struct
  82 {
  83   /** Number of packets validated (passes through the service chain)
  84       within the timestamps. */
  85   u32 sfc_validated_count;
  86
  87   /** Number of packets invalidated (failed through the service chain)
  88       within the timestamps. */
  89   u32 sfc_invalidated_count;
  90 } ioam_analyse_pot_data;
  91
  92 /** @brief Analysed iOAM data.
  93     @note cache aligned.
  94 */
  95 typedef struct ioam_analyser_data_t_
  96 {
  97   u8 is_free;
  98   u8 pad[3];
  99
 100   /** Num of pkts sent for this flow. */
 101   u32 pkt_sent;
 102
 103   /** Num of pkts matching this flow. */
 104   u32 pkt_counter;
 105
 106   /** Num of bytes matching this flow. */
 107   u32 bytes_counter;
 108
 109   /** Analysed iOAM trace data. */
 110   ioam_analyse_trace_data trace_data;
 111
 112   /** Analysed iOAM pot data. */
 113   ioam_analyse_pot_data pot_data;
 114
 115   /** Analysed iOAM seqno data. */
 116   seqno_rx_info seqno_data;
 117
 118   /** Cache of previously analysed data, useful for export. */
 119   struct ioam_analyser_data_t_ *chached_data_list;
 120
 121   /** Lock to since we use this to export the data in other thread. */
 122   volatile u32 *writer_lock;
 123 } ioam_analyser_data_t;
 124
 125 always_inline f64
 126 ip6_ioam_analyse_calc_delay (ioam_trace_hdr_t * trace, u16 trace_len)
 127 {
 128   u16 size_of_traceopt_per_node, size_of_all_traceopts;
 129   u8 num_nodes;
 130   u32 *start_elt, *end_elt;
 131   u32 start_time, end_time;
 132
 133   size_of_traceopt_per_node = fetch_trace_data_size (trace->ioam_trace_type);
 134   // Unknown trace type
 135   if (size_of_traceopt_per_node == 0)
 136     return 0;
 137   size_of_all_traceopts = trace_len;    /*ioam_trace_type,data_list_elts_left */
 138
 139   num_nodes = (u8) (size_of_all_traceopts / size_of_traceopt_per_node);
 140
 141   num_nodes -= trace->data_list_elts_left;
 142
 143   start_elt = trace->elts;
 144   end_elt =
 145     trace->elts +
 146     (u32) (size_of_traceopt_per_node * (num_nodes - 1) / sizeof (u32));
 147
 148   if (trace->ioam_trace_type & BIT_TTL_NODEID)
 149     {
 150       start_elt++;
 151       end_elt++;
 152     }
 153   if (trace->ioam_trace_type & BIT_ING_INTERFACE)
 154     {
 155       start_elt++;
 156       end_elt++;
 157     }
 158
 159   start_time = clib_net_to_host_u32 (*start_elt);
 160   end_time = clib_net_to_host_u32 (*end_elt);
 161
 162   return (f64) (end_time - start_time);
 163 }
 164
 165 always_inline int
 166 ip6_ioam_analyse_hbh_trace (ioam_analyser_data_t * data,
 167                             ioam_trace_hdr_t * trace, u16 pak_len,
 168                             u16 trace_len)
 169 {
 170   ioam_analyse_trace_data *trace_data;
 171   u16 size_of_traceopt_per_node;
 172   u16 size_of_all_traceopts;
 173   u8 i, j, k, num_nodes, max_nodes;
 174   u8 *ptr;
 175   u32 nodeid;
 176   u16 ingress_if, egress_if;
 177   ioam_path_map_t *path = NULL;
 178   ioam_analyse_trace_record *trace_record;
 179
 180   while (__sync_lock_test_and_set (data->writer_lock, 1))
 181     ;
 182
 183   trace_data = &data->trace_data;
 184
 185   size_of_traceopt_per_node = fetch_trace_data_size (trace->ioam_trace_type);
 186   // Unknown trace type
 187   if (size_of_traceopt_per_node == 0)
 188     goto DONE;
 189   size_of_all_traceopts = trace_len;
 190
 191   ptr = (u8 *) trace->elts;
 192   max_nodes = (u8) (size_of_all_traceopts / size_of_traceopt_per_node);
 193   num_nodes = max_nodes - trace->data_list_elts_left;
 194
 195   for (i = 0; i < IOAM_MAX_PATHS_PER_FLOW; i++)
 196     {
 197       trace_record = trace_data->path_data + i;
 198
 199       if (trace_record->is_free ||
 200           (num_nodes != trace_record->num_nodes) ||
 201           (trace->ioam_trace_type != trace_record->trace_type))
 202         continue;
 203
 204       path = trace_record->path;
 205
 206       for (j = max_nodes, k = 0; k < num_nodes; j--, k++)
 207         {
 208           ptr =
 209             (u8 *) ((u8 *) trace->elts +
 210                     (size_of_traceopt_per_node * (j - 1)));
 211
 212           nodeid = clib_net_to_host_u32 (*((u32 *) ptr)) & 0x00ffffff;
 213           ptr += 4;
 214
 215           if (nodeid != path[k].node_id)
 216             break;
 217
 218           if ((trace->ioam_trace_type == TRACE_TYPE_IF_TS_APP) ||
 219               (trace->ioam_trace_type == TRACE_TYPE_IF))
 220             {
 221               ingress_if = clib_net_to_host_u16 (*((u16 *) ptr));
 222               ptr += 2;
 223               egress_if = clib_net_to_host_u16 (*((u16 *) ptr));
 224               if ((ingress_if != path[k].ingress_if) ||
 225                   (egress_if != path[k].egress_if))
 226                 {
 227                   break;
 228                 }
 229             }
 230         }
 231
 232       if (k == num_nodes)
 233         {
 234           goto found_match;
 235         }
 236     }
 237
 238   for (i = 0; i < IOAM_MAX_PATHS_PER_FLOW; i++)
 239     {
 240       trace_record = trace_data->path_data + i;
 241       if (trace_record->is_free)
 242         {
 243           trace_record->is_free = 0;
 244           trace_record->num_nodes = num_nodes;
 245           trace_record->trace_type = trace->ioam_trace_type;
 246           path = trace_data->path_data[i].path;
 247           trace_record->pkt_counter = 0;
 248           trace_record->bytes_counter = 0;
 249           trace_record->min_delay = 0xFFFFFFFF;
 250           trace_record->max_delay = 0;
 251           trace_record->mean_delay = 0;
 252           break;
 253         }
 254     }
 255
 256   for (j = max_nodes, k = 0; k < num_nodes; j--, k++)
 257     {
 258       ptr =
 259         (u8 *) ((u8 *) trace->elts + (size_of_traceopt_per_node * (j - 1)));
 260
 261       path[k].node_id = clib_net_to_host_u32 (*((u32 *) ptr)) & 0x00ffffff;
 262       ptr += 4;
 263
 264       if ((trace->ioam_trace_type == TRACE_TYPE_IF_TS_APP) ||
 265           (trace->ioam_trace_type == TRACE_TYPE_IF))
 266         {
 267           path[k].ingress_if = clib_net_to_host_u16 (*((u16 *) ptr));
 268           ptr += 2;
 269           path[k].egress_if = clib_net_to_host_u16 (*((u16 *) ptr));
 270         }
 271     }
 272
 273 found_match:
 274   trace_record->pkt_counter++;
 275   trace_record->bytes_counter += pak_len;
 276
 277   if (trace->ioam_trace_type & BIT_TIMESTAMP)
 278     {
 279       /* Calculate time delay */
 280       u32 delay = (u32) ip6_ioam_analyse_calc_delay (trace, trace_len);
 281       if (delay < trace_record->min_delay)
 282         trace_record->min_delay = delay;
 283       else if (delay > trace_record->max_delay)
 284         trace_record->max_delay = delay;
 285
 286       u64 sum = (trace_record->mean_delay * data->seqno_data.rx_packets);
 287       trace_record->mean_delay =
 288         (u32) ((sum + delay) / (data->seqno_data.rx_packets + 1));
 289     }
 290 DONE:
 291   *(data->writer_lock) = 0;
 292   return 0;
 293 }
 294
 295 always_inline int
 296 ip6_ioam_analyse_hbh_e2e (ioam_analyser_data_t * data,
 297                           ioam_e2e_packet_t * e2e, u16 len)
 298 {
 299   while (__sync_lock_test_and_set (data->writer_lock, 1))
 300     ;
 301
 302   ioam_analyze_seqno (&data->seqno_data,
 303                       (u64) clib_net_to_host_u32 (e2e->e2e_data));
 304
 305   *(data->writer_lock) = 0;
 306   return 0;
 307 }
 308
 309 always_inline u8 *
 310 format_path_map (u8 * s, va_list * args)
 311 {
 312   ioam_path_map_t *pm = va_arg (*args, ioam_path_map_t *);
 313   u32 num_of_elts = va_arg (*args, u32);
 314   u32 i;
 315
 316   for (i = 0; i < num_of_elts; i++)
 317     {
 318       s = format (s, "node_id: 0x%x, ingress_if: 0x%x, egress_if:0x%x\n",
 319                   pm->node_id, pm->ingress_if, pm->egress_if);
 320       pm++;
 321     }
 322
 323   return (s);
 324 }
 325
 326 always_inline u8 *
 327 print_analyse_flow (u8 * s, ioam_analyser_data_t * record)
 328 {
 329   int j;
 330   ioam_analyse_trace_record *trace_record;
 331
 332   s = format (s, "pkt_sent : %u\n", record->pkt_sent);
 333   s = format (s, "pkt_counter : %u\n", record->pkt_counter);
 334   s = format (s, "bytes_counter : %u\n", record->bytes_counter);
 335
 336   s = format (s, "Trace data: \n");
 337
 338   for (j = 0; j < IOAM_MAX_PATHS_PER_FLOW; j++)
 339     {
 340       trace_record = record->trace_data.path_data + j;
 341       if (trace_record->is_free)
 342         continue;
 343
 344       s = format (s, "path_map:\n%U", format_path_map,
 345                   trace_record->path, trace_record->num_nodes);
 346       s = format (s, "pkt_counter: %u\n", trace_record->pkt_counter);
 347       s = format (s, "bytes_counter: %u\n", trace_record->bytes_counter);
 348
 349       s = format (s, "min_delay: %u\n", trace_record->min_delay);
 350       s = format (s, "max_delay: %u\n", trace_record->max_delay);
 351       s = format (s, "mean_delay: %u\n", trace_record->mean_delay);
 352     }
 353
 354   s = format (s, "\nPOT data: \n");
 355   s = format (s, "sfc_validated_count : %u\n",
 356               record->pot_data.sfc_validated_count);
 357   s = format (s, "sfc_invalidated_count : %u\n",
 358               record->pot_data.sfc_invalidated_count);
 359
 360   s = format (s, "\nSeqno Data:\n");
 361   s = format (s,
 362               "RX Packets        : %lu\n"
 363               "Lost Packets      : %lu\n"
 364               "Duplicate Packets : %lu\n"
 365               "Reordered Packets : %lu\n",
 366               record->seqno_data.rx_packets,
 367               record->seqno_data.lost_packets,
 368               record->seqno_data.dup_packets,
 369               record->seqno_data.reordered_packets);
 370
 371   s = format (s, "\n");
 372   return s;
 373 }
 374
 375 always_inline void
 376 ioam_analyse_init_data (ioam_analyser_data_t * data)
 377 {
 378   u16 j;
 379   ioam_analyse_trace_data *trace_data;
 380
 381   data->is_free = 1;
 382
 383   /* We maintain data corresponding to last IP-Fix export, this may
 384    * get extended in future to maintain history of data */
 385   vec_validate_aligned (data->chached_data_list, 0, CLIB_CACHE_LINE_BYTES);
 386
 387   data->writer_lock = clib_mem_alloc_aligned (CLIB_CACHE_LINE_BYTES,
 388                                               CLIB_CACHE_LINE_BYTES);
 389   *(data->writer_lock) = 0;
 390
 391   trace_data = &(data->trace_data);
 392   for (j = 0; j < IOAM_MAX_PATHS_PER_FLOW; j++)
 393     trace_data->path_data[j].is_free = 1;
 394 }
 395
 396 #endif /* PLUGINS_IOAM_PLUGIN_IOAM_ANALYSE_IOAM_ANALYSE_H_ */
 397
 398 /*
 399  * fd.io coding-style-patch-verification: ON
 400  *
 401  * Local Variables:
 402  * eval: (c-set-style "gnu")
 403  * End:
 404  */