4 * Copyright(c) 2017 Intel Corporation. All rights reserved.
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
10 * * Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * * Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in
14 * the documentation and/or other materials provided with the
16 * * Neither the name of Intel Corporation nor the names of its
17 * contributors may be used to endorse or promote products derived
18 * from this software without specific prior written permission.
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 #ifndef _RTE_LATENCYSTATS_H_
34 #define _RTE_LATENCYSTATS_H_
40 * library to provide application and flow based latency stats.
43 #include <rte_metrics.h>
50 * Note: This function pointer is for future flow based latency stats
53 * Function type used for identifting flow types of a Rx packet.
55 * The callback function is called on Rx for each packet.
56 * This function is used for flow based latency calculations.
59 * Packet that has to be identified with its flow types.
61 * The arbitrary user parameter passed in by the application when
62 * the callback was originally configured.
64 * The flow_mask, representing the multiple flow types of a packet.
66 typedef uint16_t (*rte_latency_stats_flow_type_fn)(struct rte_mbuf *pkt,
70 * Registers Rx/Tx callbacks for each active port, queue.
73 * Sampling time period in nano seconds, at which packet
74 * should be marked with time stamp.
76 * Note: This param is for future flow based latency stats
78 * User callback to be called to get flow types of a packet.
79 * Used for flow based latency calculation.
80 * If the value is NULL, global stats will be calculated,
81 * else flow based latency stats will be calculated.
82 * For now just pass on the NULL value to this param.
88 int rte_latencystats_init(uint64_t samp_intvl,
89 rte_latency_stats_flow_type_fn user_cb);
92 * Calculates the latency and jitter values internally, exposing the updated
93 * values via *rte_latencystats_get* or the rte_metrics API.
96 * < 0 : Error in updating values.
98 int32_t rte_latencystats_update(void);
101 * Removes registered Rx/Tx callbacks for each active port, queue.
107 int rte_latencystats_uninit(void);
110 * Retrieve names of latency statistics
113 * Block of memory to insert names into. Must be at least size in capacity.
114 * If set to NULL, function returns required capacity.
116 * Capacity of latency stats names (number of names).
118 * - positive value lower or equal to size: success. The return value
119 * is the number of entries filled in the stats table.
120 * - positive value higher than size: error, the given statistics table
121 * is too small. The return value corresponds to the size that should
122 * be given to succeed. The entries in the table are not valid and
123 * shall not be used by the caller.
125 int rte_latencystats_get_names(struct rte_metric_name *names,
129 * Retrieve latency statistics.
132 * A pointer to a table of structure of type *rte_metric_value*
133 * to be filled with latency statistics ids and values.
134 * This parameter can be set to NULL if size is 0.
136 * The size of the stats table, which should be large enough to store
137 * all the latency stats.
139 * - positive value lower or equal to size: success. The return value
140 * is the number of entries filled in the stats table.
141 * - positive value higher than size: error, the given statistics table
142 * is too small. The return value corresponds to the size that should
143 * be given to succeed. The entries in the table are not valid and
144 * shall not be used by the caller.
145 * -ENOMEM: On failure.
147 int rte_latencystats_get(struct rte_metric_value *values,
154 #endif /* _RTE_LATENCYSTATS_H_ */