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