xref: /xnu-8796.121.2/bsd/net/net_perf.h (revision c54f35ca767986246321eb901baf8f5ff7923f6a)
1 /*
2  * Copyright (c) 2015 Apple Inc. All rights reserved.
3  *
4  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5  *
6  * This file contains Original Code and/or Modifications of Original Code
7  * as defined in and that are subject to the Apple Public Source License
8  * Version 2.0 (the 'License'). You may not use this file except in
9  * compliance with the License. The rights granted to you under the License
10  * may not be used to create, or enable the creation or redistribution of,
11  * unlawful or unlicensed copies of an Apple operating system, or to
12  * circumvent, violate, or enable the circumvention or violation of, any
13  * terms of an Apple operating system software license agreement.
14  *
15  * Please obtain a copy of the License at
16  * http://www.opensource.apple.com/apsl/ and read it before using this file.
17  *
18  * The Original Code and all software distributed under the License are
19  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23  * Please see the License for the specific language governing rights and
24  * limitations under the License.
25  *
26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27  */
28 #ifndef _NET_NET_PERF_H_
29 #define _NET_NET_PERF_H_
30 
31 #include <stdint.h>
32 
33 #ifdef KERNEL_PRIVATE
34 #include <sys/time.h>
35 #include <mach/boolean.h>
36 #endif /* KERNEL_PRIVATE */
37 
38 /* five histogram bins are separated by four dividing "bars" */
39 #define NET_PERF_BARS 4
40 
41 typedef struct net_perf {
42 	uint64_t np_total_pkts; /* total packets input or output during measurement */
43 	uint64_t np_total_usecs;        /* microseconds elapsed during measurement */
44 	uint64_t np_hist1;              /* histogram bin 1 */
45 	uint64_t np_hist2;              /* histogram bin 2 */
46 	uint64_t np_hist3;              /* histogram bin 3 */
47 	uint64_t np_hist4;              /* histogram bin 4 */
48 	uint64_t np_hist5;              /* histogram bin 5 */
49 	uint8_t np_hist_bars[NET_PERF_BARS];
50 } net_perf_t;
51 
52 #ifdef KERNEL_PRIVATE
53 void net_perf_initialize(net_perf_t *npp, uint64_t bins);
54 void net_perf_start_time(net_perf_t *npp, struct timeval *tv);
55 void net_perf_measure_time(net_perf_t *npp, struct timeval *start, uint64_t num_pkts);
56 void net_perf_histogram(net_perf_t *npp, uint64_t num_pkts);
57 boolean_t net_perf_validate_bins(uint64_t bins);
58 
59 #endif /* KERNEL_PRIVATE */
60 
61 #endif /* _NET_NET_PERF_H_ */
62