Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.4.4.5
openapi_stats.h
Go to the documentation of this file.
1 
9 /*********************************************************************
10 *
11 * Copyright 2016-2018 Broadcom.
12 *
13 * Licensed under the Apache License, Version 2.0 (the "License");
14 * you may not use this file except in compliance with the License.
15 * You may obtain a copy of the License at
16 *
17 * http://www.apache.org/licenses/LICENSE-2.0
18 *
19 * Unless required by applicable law or agreed to in writing, software
20 * distributed under the License is distributed on an "AS IS" BASIS,
21 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
22 * See the License for the specific language governing permissions and
23 * limitations under the License.
24 *
25 **********************************************************************
26 *
27 * @filename openapi_stats.h
28 *
29 * @purpose Switch Statistics
30 *
31 * @component OPEN
32 *
33 * @create 08/27/2012
34 *
35 * @end
36 *
37 **********************************************************************/
38 #ifndef OPENAPI_STATS_H_INCLUDED
39 #define OPENAPI_STATS_H_INCLUDED
40 
41 #include <stdio.h>
42 #include <stddef.h>
43 #include <sys/un.h>
44 
45 #include "openapi_common.h"
46 
49 typedef enum
50 {
52  OPEN_CTR_RESERVED = 0,
54  OPEN_CTR_RX_TOTAL_BYTES = 1,
56  OPEN_CTR_RX_64 = 2,
58  OPEN_CTR_RX_65_127 = 3,
60  OPEN_CTR_RX_128_255 = 4,
62  OPEN_CTR_RX_256_511 = 5,
64  OPEN_CTR_RX_512_1023 = 6,
66  OPEN_CTR_RX_1024_1518 = 7,
68  OPEN_CTR_RX_1519_1530 = 8,
70  OPEN_CTR_RX_GOOD_OVERSIZE = 9,
72  OPEN_CTR_RX_ERROR_OVERSIZE = 10,
74  OPEN_CTR_RX_GOOD_UNDERSIZE = 11,
76  OPEN_CTR_RX_ERROR_UNDERSIZE = 12,
78  OPEN_CTR_RX_UCAST_FRAMES = 13,
80  OPEN_CTR_RX_MCAST_FRAMES = 14,
82  OPEN_CTR_RX_BCAST_FRAMES = 15,
84  OPEN_CTR_RX_ALIGN_ERRORS = 16,
86  OPEN_CTR_RX_FCS_ERRORS = 17,
88  OPEN_CTR_RX_OVERRUNS = 18,
90  OPEN_CTR_RX_FRAME_TOO_LONG = 19,
91 
93  OPEN_CTR_TX_TOTAL_BYTES = 20,
95  OPEN_CTR_TX_64 = 21,
97  OPEN_CTR_TX_65_127 = 22,
99  OPEN_CTR_TX_128_255 = 23,
101  OPEN_CTR_TX_256_511 = 24,
103  OPEN_CTR_TX_512_1023 = 25,
105  OPEN_CTR_TX_1024_1518 = 26,
107  OPEN_CTR_TX_1519_1530 = 27,
109  OPEN_CTR_TX_UCAST_FRAMES = 28,
111  OPEN_CTR_TX_MCAST_FRAMES = 29,
113  OPEN_CTR_TX_BCAST_FRAMES = 30,
115  OPEN_CTR_TX_FCS_ERRORS = 31,
117  OPEN_CTR_TX_OVERSIZED = 32,
119  OPEN_CTR_TX_UNDERRUN_ERRORS = 33,
121  OPEN_CTR_TX_ONE_COLLISION = 34,
123  OPEN_CTR_TX_MULTIPLE_COLLISION = 35,
125  OPEN_CTR_TX_EXCESSIVE_COLLISION = 36,
127  OPEN_CTR_TX_LATE_COLLISION = 37,
128 
130  OPEN_CTR_TX_RX_64 = 38,
132  OPEN_CTR_TX_RX_65_127 = 39,
134  OPEN_CTR_TX_RX_128_255 = 40,
136  OPEN_CTR_TX_RX_256_511 = 41,
138  OPEN_CTR_TX_RX_512_1023 = 42,
140  OPEN_CTR_TX_RX_1024_1518 = 43,
142  OPEN_CTR_TX_RX_1519_1522 = 44,
144  OPEN_CTR_TX_RX_1523_2047 = 45,
146  OPEN_CTR_TX_RX_2048_4095 = 46,
148  OPEN_CTR_TX_RX_4096_9216 = 47,
150  OPEN_CTR_ETHER_STATS_DROP_EVENTS = 48,
152  OPEN_CTR_SNMPIFOUTDISCARD_FRAMES = 49,
154  OPEN_CTR_SNMPIFINDISCARD_FRAMES = 50,
156  OPEN_CTR_RX_TOTAL_FRAMES = 51,
158  OPEN_CTR_RX_TOTAL_ERROR_FRAMES = 52,
160  OPEN_CTR_TX_TOTAL_FRAMES = 53,
162  OPEN_CTR_TX_TOTAL_ERROR_FRAMES = 54,
164  OPEN_CTR_TX_TOTAL_COLLISION_FRAMES = 55,
166  OPEN_CTR_RX_CRC_ERRORS = 56,
168  OPEN_CTR_RX_TOTAL_MAC_ERROR_FRAMES = 57,
170  OPEN_CTR_RX_RATE_BITS = 58,
172  OPEN_CTR_TX_RATE_BITS = 59,
174  OPEN_CTR_RX_RATE_FRAMES = 60,
176  OPEN_CTR_TX_RATE_FRAMES = 61,
178  OPEN_CTR_ETHER_STATS_HOLD = 62,
180  OPEN_CTR_RX_JABBER_FRAMES = 63,
182  OPEN_CTR_PORT_LINK_DOWN_COUNTER = 64
183 
184 } OPEN_COUNTER_ID_t;
185 
186 /*****************************************************************/
203 open_error_t openapiStatGet(openapiClientHandle_t *client_handle,
204  OPEN_COUNTER_ID_t counterId,
205  uint32_t ifNum,
206  uint64_t *counterValue);
207 
208 /*****************************************************************/
226 open_error_t openapiStatStringGet(openapiClientHandle_t *client_handle,
227  OPEN_COUNTER_ID_t counterId,
228  uint32_t ifNum,
229  open_buffdesc *counterValueStr);
230 
231 /*****************************************************************/
247 open_error_t openapiStatReset(openapiClientHandle_t *client_handle,
248  OPEN_COUNTER_ID_t counterId,
249  uint32_t ifNum);
250 
251 /*****************************************************************/
267 open_error_t openapiInterfaceStatsBufSizeGet(openapiClientHandle_t *client_handle,
268  uint32_t *bufSize);
269 
270 /*****************************************************************/
302 open_error_t openapiInterfaceStatsGet(openapiClientHandle_t *client_handle,
303  uint32_t ifNum,
304  open_buffdesc *counterArray);
305 
306 /*****************************************************************/
319 open_error_t openapiInterfaceStatsReset(openapiClientHandle_t *client_handle,
320  uint32_t ifNum);
321 
322 /*****************************************************************/
338 open_error_t openapiInterfaceStatsResetTimeGet(openapiClientHandle_t *client_handle,
339  uint32_t ifNum,
340  uint32_t *lastResetSecs);
341 
342 #endif /* OPENAPI_STATS_H_INCLUDED */
343