blob: 7dd57ac0fd275bc9dacfbda1c4797f97183f532c (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
|
/* SPDX-License-Identifier: BSD-3-Clause
* Copyright (c) 2021 Marvell
*/
/**
* @file
*
* ODP Proto Stats
*/
#ifndef ODP_API_SPEC_PROTO_STATS_H_
#define ODP_API_SPEC_PROTO_STATS_H_
#include <odp/visibility_begin.h>
#ifdef __cplusplus
extern "C" {
#endif
#include <odp/api/proto_stats_types.h>
/** @addtogroup odp_proto_stats
* Flow specific packet statistics.
* @{
*/
/**
* Initialize proto stats parameters
*
* Initialize an odp_proto_stats_param_t to its default values.
* By default all the statistics are disabled.
*
* @param param Proto stats parameter pointer.
*/
void odp_proto_stats_param_init(odp_proto_stats_param_t *param);
/**
* Get proto stats capability
*
* Get supported protocol statistics and metadata for a PKTIO.
*
* @param pktio Packet IO handle
* @param[out] capa Pointer where capabilities are updated
*
* @retval 0 on success
* @retval <0 on failure
*/
int odp_proto_stats_capability(odp_pktio_t pktio, odp_proto_stats_capability_t *capa);
/**
* Create a proto stats object
*
* Create a proto stats object with given name and parameters.
* A proto stats object can be created with any set of statistics but only the
* statistics that are supported by a PKTIO are updated in a proto stats object
* for that PKTIO associated packets. Same proto stats object can be used with
* any PKTIO.
*
* @param name Object name
* @param param Proto stats parameters
*
* @return Proto stats object handle
* @retval ODP_PROTO_STATS_INVALID on failure
*/
odp_proto_stats_t odp_proto_stats_create(const char *name, const odp_proto_stats_param_t *param);
/**
* Lookup a proto stats object by name
*
* Lookup an already created proto stats object by name.
*
* @param name Proto stats object name
*
* @return Proto stats object handle
* @retval ODP_PROTO_STATS_INVALID on failure
*/
odp_proto_stats_t odp_proto_stats_lookup(const char *name);
/**
* Destroy a proto stats object
*
* Destroy a proto stats object already created.
*
* Before destroying proto stats object having tx statistics enabled,
* for all PKTIO devices to which packets were Tx'ed earlier with
* this proto stats object, odp_pktio_stop() must be called. Additionally,
* existing packets that refer to the proto stats object being destroyed
* must not be sent at the same time as or after the proto stats object
* destruction.
*
* @param stat Proto stats handle
*
* @retval 0 on success
* @retval <0 on failure
*/
int odp_proto_stats_destroy(odp_proto_stats_t stat);
/**
* Get all proto stats counters
*
* Get current values of all counters of the proto stats object.
* The values of counters that are not enabled in the proto stats object are undefined.
*
* @param stat Proto stats object handle
* @param[out] data Pointer to a caller allocated structure where the statistics will
* be written to.
*
* @retval =0 on success
* @retval <0 on failure
*/
int odp_proto_stats(odp_proto_stats_t stat, odp_proto_stats_data_t *data);
/**
* Print proto stats object info to ODP log.
*
* Print implementation-defined proto stats debug information to ODP log.
*
* @param stat Proto stats object handle
*/
void odp_proto_stats_print(odp_proto_stats_t stat);
/**
* @}
*/
#ifdef __cplusplus
}
#endif
#include <odp/visibility_end.h>
#endif
|
