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:
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.
16 #ifndef PLUGINS_IOAM_PLUGIN_IOAM_ANALYSE_IOAM_ANALYSE_H_
17 #define PLUGINS_IOAM_PLUGIN_IOAM_ANALYSE_IOAM_ANALYSE_H_
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>
25 #define IOAM_FLOW_TEMPLATE_ID 260
26 #define IOAM_TRACE_MAX_NODES 10
27 #define IOAM_MAX_PATHS_PER_FLOW 10
36 /** @brief Analysed iOAM trace data.
41 /** No of nodes in path. */
44 /** Data contained in trace - NodeId, TTL, Ingress & Egress Link, Timestamp. */
47 /** Flag to indicate whether node is allocated. */
52 /** Actual PATH flow has taken. */
53 ioam_path_map_t path[IOAM_TRACE_MAX_NODES];
55 /** Num of pkts in the flow going over path. */
58 /** Num of bytes in the flow going over path. */
61 /** Minumum Dealay for the flow. */
64 /** Maximum Dealay for the flow. */
67 /** Average Dealay for the flow. */
71 } ioam_analyse_trace_record;
75 ioam_analyse_trace_record path_data[IOAM_MAX_PATHS_PER_FLOW];
76 } ioam_analyse_trace_data;
78 /** @brief Analysed iOAM pot data.
83 /** Number of packets validated (passes through the service chain)
84 within the timestamps. */
85 u32 sfc_validated_count;
87 /** Number of packets invalidated (failed through the service chain)
88 within the timestamps. */
89 u32 sfc_invalidated_count;
90 } ioam_analyse_pot_data;
92 /** @brief Analysed iOAM data.
95 typedef struct ioam_analyser_data_t_
100 /** Num of pkts sent for this flow. */
103 /** Num of pkts matching this flow. */
106 /** Num of bytes matching this flow. */
109 /** Analysed iOAM trace data. */
110 ioam_analyse_trace_data trace_data;
112 /** Analysed iOAM pot data. */
113 ioam_analyse_pot_data pot_data;
115 /** Analysed iOAM seqno data. */
116 seqno_rx_info seqno_data;
118 /** Cache of previously analysed data, useful for export. */
119 struct ioam_analyser_data_t_ *chached_data_list;
121 /** Lock to since we use this to export the data in other thread. */
122 volatile u32 *writer_lock;
123 } ioam_analyser_data_t;
126 ip6_ioam_analyse_calc_delay (ioam_trace_hdr_t * trace, u16 trace_len,
129 u16 size_of_traceopt_per_node, size_of_all_traceopts;
131 u32 *start_elt, *end_elt, *uturn_elt;;
132 u32 start_time, end_time;
135 size_of_traceopt_per_node = fetch_trace_data_size (trace->ioam_trace_type);
136 // Unknown trace type
137 if (size_of_traceopt_per_node == 0)
139 size_of_all_traceopts = trace_len; /*ioam_trace_type,data_list_elts_left */
141 num_nodes = (u8) (size_of_all_traceopts / size_of_traceopt_per_node);
143 num_nodes -= trace->data_list_elts_left;
145 start_elt = trace->elts;
148 (u32) (size_of_traceopt_per_node * (num_nodes - 1) / sizeof (u32));
150 if (oneway && (trace->ioam_trace_type & BIT_TTL_NODEID))
155 uturn_elt = start_elt - size_of_traceopt_per_node / sizeof (u32);
157 if ((clib_net_to_host_u32 (*start_elt) >> 24) <=
158 (clib_net_to_host_u32 (*uturn_elt) >> 24))
161 while (!done && (start_elt = uturn_elt) != end_elt);
163 if (trace->ioam_trace_type & BIT_TTL_NODEID)
168 if (trace->ioam_trace_type & BIT_ING_INTERFACE)
173 start_time = clib_net_to_host_u32 (*start_elt);
174 end_time = clib_net_to_host_u32 (*end_elt);
176 return (f64) (end_time - start_time);
180 ip6_ioam_analyse_hbh_trace (ioam_analyser_data_t * data,
181 ioam_trace_hdr_t * trace, u16 pak_len,
184 ioam_analyse_trace_data *trace_data;
185 u16 size_of_traceopt_per_node;
186 u16 size_of_all_traceopts;
187 u8 i, j, k, num_nodes, max_nodes;
190 u16 ingress_if, egress_if;
191 ioam_path_map_t *path = NULL;
192 ioam_analyse_trace_record *trace_record;
194 while (__sync_lock_test_and_set (data->writer_lock, 1))
197 trace_data = &data->trace_data;
199 size_of_traceopt_per_node = fetch_trace_data_size (trace->ioam_trace_type);
200 // Unknown trace type
201 if (size_of_traceopt_per_node == 0)
203 size_of_all_traceopts = trace_len;
205 ptr = (u8 *) trace->elts;
206 max_nodes = (u8) (size_of_all_traceopts / size_of_traceopt_per_node);
207 num_nodes = max_nodes - trace->data_list_elts_left;
209 for (i = 0; i < IOAM_MAX_PATHS_PER_FLOW; i++)
211 trace_record = trace_data->path_data + i;
213 if (trace_record->is_free ||
214 (num_nodes != trace_record->num_nodes) ||
215 (trace->ioam_trace_type != trace_record->trace_type))
218 path = trace_record->path;
220 for (j = max_nodes, k = 0; k < num_nodes; j--, k++)
223 (u8 *) ((u8 *) trace->elts +
224 (size_of_traceopt_per_node * (j - 1)));
226 nodeid = clib_net_to_host_u32 (*((u32 *) ptr)) & 0x00ffffff;
229 if (nodeid != path[k].node_id)
232 if ((trace->ioam_trace_type == TRACE_TYPE_IF_TS_APP) ||
233 (trace->ioam_trace_type == TRACE_TYPE_IF))
235 ingress_if = clib_net_to_host_u16 (*((u16 *) ptr));
237 egress_if = clib_net_to_host_u16 (*((u16 *) ptr));
238 if ((ingress_if != path[k].ingress_if) ||
239 (egress_if != path[k].egress_if))
252 for (i = 0; i < IOAM_MAX_PATHS_PER_FLOW; i++)
254 trace_record = trace_data->path_data + i;
255 if (trace_record->is_free)
257 trace_record->is_free = 0;
258 trace_record->num_nodes = num_nodes;
259 trace_record->trace_type = trace->ioam_trace_type;
260 path = trace_data->path_data[i].path;
261 trace_record->pkt_counter = 0;
262 trace_record->bytes_counter = 0;
263 trace_record->min_delay = 0xFFFFFFFF;
264 trace_record->max_delay = 0;
265 trace_record->mean_delay = 0;
270 for (j = max_nodes, k = 0; k < num_nodes; j--, k++)
273 (u8 *) ((u8 *) trace->elts + (size_of_traceopt_per_node * (j - 1)));
275 path[k].node_id = clib_net_to_host_u32 (*((u32 *) ptr)) & 0x00ffffff;
278 if ((trace->ioam_trace_type == TRACE_TYPE_IF_TS_APP) ||
279 (trace->ioam_trace_type == TRACE_TYPE_IF))
281 path[k].ingress_if = clib_net_to_host_u16 (*((u16 *) ptr));
283 path[k].egress_if = clib_net_to_host_u16 (*((u16 *) ptr));
288 trace_record->pkt_counter++;
289 trace_record->bytes_counter += pak_len;
290 if (trace->ioam_trace_type & BIT_TIMESTAMP)
292 /* Calculate time delay */
293 u32 delay = (u32) ip6_ioam_analyse_calc_delay (trace, trace_len, 0);
294 if (delay < trace_record->min_delay)
295 trace_record->min_delay = delay;
296 else if (delay > trace_record->max_delay)
297 trace_record->max_delay = delay;
299 u64 sum = (trace_record->mean_delay * data->seqno_data.rx_packets);
300 trace_record->mean_delay =
301 (u32) ((sum + delay) / (data->seqno_data.rx_packets + 1));
304 *(data->writer_lock) = 0;
309 ip6_ioam_analyse_hbh_e2e (ioam_analyser_data_t * data,
310 ioam_e2e_packet_t * e2e, u16 len)
312 while (__sync_lock_test_and_set (data->writer_lock, 1))
315 ioam_analyze_seqno (&data->seqno_data,
316 (u64) clib_net_to_host_u32 (e2e->e2e_data));
318 *(data->writer_lock) = 0;
323 format_path_map (u8 * s, va_list * args)
325 ioam_path_map_t *pm = va_arg (*args, ioam_path_map_t *);
326 u32 num_of_elts = va_arg (*args, u32);
329 for (i = 0; i < num_of_elts; i++)
331 s = format (s, "node_id: 0x%x, ingress_if: 0x%x, egress_if:0x%x\n",
332 pm->node_id, pm->ingress_if, pm->egress_if);
340 print_analyse_flow (u8 * s, ioam_analyser_data_t * record)
343 ioam_analyse_trace_record *trace_record;
345 s = format (s, "pkt_sent : %u\n", record->pkt_sent);
346 s = format (s, "pkt_counter : %u\n", record->pkt_counter);
347 s = format (s, "bytes_counter : %u\n", record->bytes_counter);
349 s = format (s, "Trace data: \n");
351 for (j = 0; j < IOAM_MAX_PATHS_PER_FLOW; j++)
353 trace_record = record->trace_data.path_data + j;
354 if (trace_record->is_free)
357 s = format (s, "path_map:\n%U", format_path_map,
358 trace_record->path, trace_record->num_nodes);
359 s = format (s, "pkt_counter: %u\n", trace_record->pkt_counter);
360 s = format (s, "bytes_counter: %u\n", trace_record->bytes_counter);
362 s = format (s, "min_delay: %u\n", trace_record->min_delay);
363 s = format (s, "max_delay: %u\n", trace_record->max_delay);
364 s = format (s, "mean_delay: %u\n", trace_record->mean_delay);
367 s = format (s, "\nPOT data: \n");
368 s = format (s, "sfc_validated_count : %u\n",
369 record->pot_data.sfc_validated_count);
370 s = format (s, "sfc_invalidated_count : %u\n",
371 record->pot_data.sfc_invalidated_count);
373 s = format (s, "\nSeqno Data:\n");
376 "Lost Packets : %lu\n"
377 "Duplicate Packets : %lu\n"
378 "Reordered Packets : %lu\n",
379 record->seqno_data.rx_packets,
380 record->seqno_data.lost_packets,
381 record->seqno_data.dup_packets,
382 record->seqno_data.reordered_packets);
384 s = format (s, "\n");
389 ioam_analyse_init_data (ioam_analyser_data_t * data)
392 ioam_analyse_trace_data *trace_data;
396 /* We maintain data corresponding to last IP-Fix export, this may
397 * get extended in future to maintain history of data */
398 vec_validate_aligned (data->chached_data_list, 0, CLIB_CACHE_LINE_BYTES);
400 data->writer_lock = clib_mem_alloc_aligned (CLIB_CACHE_LINE_BYTES,
401 CLIB_CACHE_LINE_BYTES);
402 *(data->writer_lock) = 0;
404 trace_data = &(data->trace_data);
405 for (j = 0; j < IOAM_MAX_PATHS_PER_FLOW; j++)
406 trace_data->path_data[j].is_free = 1;
409 #endif /* PLUGINS_IOAM_PLUGIN_IOAM_ANALYSE_IOAM_ANALYSE_H_ */
412 * fd.io coding-style-patch-verification: ON
415 * eval: (c-set-style "gnu")