net/bnxt: fix a pointer deref before null check
[dpdk.git] / lib / librte_bitratestats / rte_bitrate.h
1 /*-
2  *   BSD LICENSE
3  *
4  *   Copyright(c) 2017 Intel Corporation. All rights reserved.
5  *   All rights reserved.
6  *
7  *   Redistribution and use in source and binary forms, with or without
8  *   modification, are permitted provided that the following conditions
9  *   are met:
10  *
11  *     * Redistributions of source code must retain the above copyright
12  *       notice, this list of conditions and the following disclaimer.
13  *     * Redistributions in binary form must reproduce the above copyright
14  *       notice, this list of conditions and the following disclaimer in
15  *       the documentation and/or other materials provided with the
16  *       distribution.
17  *     * Neither the name of Intel Corporation nor the names of its
18  *       contributors may be used to endorse or promote products derived
19  *       from this software without specific prior written permission.
20  *
21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32  */
33
34 #ifndef _RTE_BITRATE_H_
35 #define _RTE_BITRATE_H_
36
37 #include <stdint.h>
38
39 #ifdef __cplusplus
40 extern "C" {
41 #endif
42
43 /**
44  *  Bitrate statistics data structure.
45  *  This data structure is intentionally opaque.
46  */
47 struct rte_stats_bitrates;
48
49
50 /**
51  * Allocate a bitrate statistics structure
52  *
53  * @return
54  *   - Pointer to structure on success
55  *   - NULL on error (zmalloc failure)
56  */
57 struct rte_stats_bitrates *rte_stats_bitrate_create(void);
58
59
60 /**
61  * Register bitrate statistics with the metric library.
62  *
63  * @param bitrate_data
64  *   Pointer allocated by rte_stats_create()
65  *
66  * @return
67  *   Zero on success
68  *   Negative on error
69  */
70 int rte_stats_bitrate_reg(struct rte_stats_bitrates *bitrate_data);
71
72
73 /**
74  * Calculate statistics for current time window. The period with which
75  * this function is called should be the intended sampling window width.
76  *
77  * @param bitrate_data
78  *   Bitrate statistics data pointer
79  *
80  * @param port_id
81  *   Port id to calculate statistics for
82  *
83  * @return
84  *  - Zero on success
85  *  - Negative value on error
86  */
87 int rte_stats_bitrate_calc(struct rte_stats_bitrates *bitrate_data,
88                            uint16_t port_id);
89
90 #ifdef __cplusplus
91 }
92 #endif
93
94 #endif /* _RTE_BITRATE_H_ */