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