xref: /xnu-8020.121.3/bsd/sys/resource_private.h (revision fdd8201d7b966f0c3ea610489d29bd841d358941)
1*fdd8201dSApple OSS Distributions /*
2*fdd8201dSApple OSS Distributions  * Copyright (c) 2000-2021 Apple Inc. All rights reserved.
3*fdd8201dSApple OSS Distributions  *
4*fdd8201dSApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5*fdd8201dSApple OSS Distributions  *
6*fdd8201dSApple OSS Distributions  * This file contains Original Code and/or Modifications of Original Code
7*fdd8201dSApple OSS Distributions  * as defined in and that are subject to the Apple Public Source License
8*fdd8201dSApple OSS Distributions  * Version 2.0 (the 'License'). You may not use this file except in
9*fdd8201dSApple OSS Distributions  * compliance with the License. The rights granted to you under the License
10*fdd8201dSApple OSS Distributions  * may not be used to create, or enable the creation or redistribution of,
11*fdd8201dSApple OSS Distributions  * unlawful or unlicensed copies of an Apple operating system, or to
12*fdd8201dSApple OSS Distributions  * circumvent, violate, or enable the circumvention or violation of, any
13*fdd8201dSApple OSS Distributions  * terms of an Apple operating system software license agreement.
14*fdd8201dSApple OSS Distributions  *
15*fdd8201dSApple OSS Distributions  * Please obtain a copy of the License at
16*fdd8201dSApple OSS Distributions  * http://www.opensource.apple.com/apsl/ and read it before using this file.
17*fdd8201dSApple OSS Distributions  *
18*fdd8201dSApple OSS Distributions  * The Original Code and all software distributed under the License are
19*fdd8201dSApple OSS Distributions  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20*fdd8201dSApple OSS Distributions  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21*fdd8201dSApple OSS Distributions  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22*fdd8201dSApple OSS Distributions  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23*fdd8201dSApple OSS Distributions  * Please see the License for the specific language governing rights and
24*fdd8201dSApple OSS Distributions  * limitations under the License.
25*fdd8201dSApple OSS Distributions  *
26*fdd8201dSApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27*fdd8201dSApple OSS Distributions  */
28*fdd8201dSApple OSS Distributions 
29*fdd8201dSApple OSS Distributions #ifndef _SYS_RESOURCE_PRIVATE_H_
30*fdd8201dSApple OSS Distributions #define _SYS_RESOURCE_PRIVATE_H_
31*fdd8201dSApple OSS Distributions 
32*fdd8201dSApple OSS Distributions #include <os/base.h>
33*fdd8201dSApple OSS Distributions #include <stdint.h>
34*fdd8201dSApple OSS Distributions #include <sys/cdefs.h>
35*fdd8201dSApple OSS Distributions 
36*fdd8201dSApple OSS Distributions /*
37*fdd8201dSApple OSS Distributions  * The kind of counters to copy into the destination buffer with
38*fdd8201dSApple OSS Distributions  * `thread_selfcounts`.
39*fdd8201dSApple OSS Distributions  */
40*fdd8201dSApple OSS Distributions __enum_decl(thread_selfcounts_kind_t, uint32_t, {
41*fdd8201dSApple OSS Distributions 	THSC_CPI = 0x01,
42*fdd8201dSApple OSS Distributions });
43*fdd8201dSApple OSS Distributions 
44*fdd8201dSApple OSS Distributions /*
45*fdd8201dSApple OSS Distributions  * The data structure expected by `thread_selfcounts(THSC_CPI, ...)`.
46*fdd8201dSApple OSS Distributions  */
47*fdd8201dSApple OSS Distributions struct thsc_cpi {
48*fdd8201dSApple OSS Distributions 	uint64_t tcpi_instructions;
49*fdd8201dSApple OSS Distributions 	uint64_t tcpi_cycles;
50*fdd8201dSApple OSS Distributions };
51*fdd8201dSApple OSS Distributions 
52*fdd8201dSApple OSS Distributions #ifndef KERNEL
53*fdd8201dSApple OSS Distributions 
54*fdd8201dSApple OSS Distributions #include <stddef.h>
55*fdd8201dSApple OSS Distributions #include <AvailabilityInternalPrivate.h>
56*fdd8201dSApple OSS Distributions 
57*fdd8201dSApple OSS Distributions __BEGIN_DECLS
58*fdd8201dSApple OSS Distributions 
59*fdd8201dSApple OSS Distributions /*
60*fdd8201dSApple OSS Distributions  * Get the current thread's counters according to a `kind` and store them into
61*fdd8201dSApple OSS Distributions  * `dst`.
62*fdd8201dSApple OSS Distributions  */
63*fdd8201dSApple OSS Distributions     __SPI_AVAILABLE(macos(12.4), ios(15.4), watchos(8.5), tvos(15.4))
64*fdd8201dSApple OSS Distributions int thread_selfcounts(thread_selfcounts_kind_t kind, void *dst, size_t size);
65*fdd8201dSApple OSS Distributions 
66*fdd8201dSApple OSS Distributions /*
67*fdd8201dSApple OSS Distributions  * Get the current thread's cycles and instructions.  May return ENOTSUP on
68*fdd8201dSApple OSS Distributions  * certain hardware.
69*fdd8201dSApple OSS Distributions  */
70*fdd8201dSApple OSS Distributions #define thread_selfcounts_cpi(DST) thread_selfcounts(THSC_CPI, (DST), sizeof(struct thsc_cpi))
71*fdd8201dSApple OSS Distributions 
72*fdd8201dSApple OSS Distributions __END_DECLS
73*fdd8201dSApple OSS Distributions 
74*fdd8201dSApple OSS Distributions #endif /* !defined(KERNEL) */
75*fdd8201dSApple OSS Distributions 
76*fdd8201dSApple OSS Distributions #endif  /* !defined(_SYS_RESOURCE_PRIVATE_H_) */
77