xref: /xnu-10002.1.13/osfmk/kern/sfi.h (revision 1031c584a5e37aff177559b9f69dbd3c8c3fd30a)
1*1031c584SApple OSS Distributions /*
2*1031c584SApple OSS Distributions  * Copyright (c) 2013 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 
29*1031c584SApple OSS Distributions #ifndef _KERN_SFI_H_
30*1031c584SApple OSS Distributions #define _KERN_SFI_H_
31*1031c584SApple OSS Distributions 
32*1031c584SApple OSS Distributions #include <stdint.h>
33*1031c584SApple OSS Distributions #include <mach/mach_types.h>
34*1031c584SApple OSS Distributions #include <mach/kern_return.h>
35*1031c584SApple OSS Distributions #include <mach/sfi_class.h>
36*1031c584SApple OSS Distributions #include <kern/ast.h>
37*1031c584SApple OSS Distributions #include <kern/kern_types.h>
38*1031c584SApple OSS Distributions #include <kern/ledger.h>
39*1031c584SApple OSS Distributions 
40*1031c584SApple OSS Distributions extern void sfi_init(void);
41*1031c584SApple OSS Distributions extern sfi_class_id_t sfi_get_ledger_alias_for_class(sfi_class_id_t class_id);
42*1031c584SApple OSS Distributions extern int sfi_ledger_entry_add(ledger_template_t template, sfi_class_id_t class_id);
43*1031c584SApple OSS Distributions 
44*1031c584SApple OSS Distributions kern_return_t sfi_set_window(uint64_t window_usecs);
45*1031c584SApple OSS Distributions kern_return_t sfi_window_cancel(void);
46*1031c584SApple OSS Distributions kern_return_t sfi_get_window(uint64_t *window_usecs);
47*1031c584SApple OSS Distributions 
48*1031c584SApple OSS Distributions kern_return_t sfi_set_class_offtime(sfi_class_id_t class_id, uint64_t offtime_usecs);
49*1031c584SApple OSS Distributions kern_return_t sfi_class_offtime_cancel(sfi_class_id_t class_id);
50*1031c584SApple OSS Distributions kern_return_t sfi_get_class_offtime(sfi_class_id_t class_id, uint64_t *offtime_usecs);
51*1031c584SApple OSS Distributions 
52*1031c584SApple OSS Distributions #ifdef MACH_KERNEL_PRIVATE
53*1031c584SApple OSS Distributions /*
54*1031c584SApple OSS Distributions  * Classifying a thread requires no special locks to be held (although attribute
55*1031c584SApple OSS Distributions  * changes that cause an inconsistent snapshot may cause a spurious AST). Final
56*1031c584SApple OSS Distributions  * evaluation will happen at the AST boundary with the thread locked. If possible,
57*1031c584SApple OSS Distributions  *
58*1031c584SApple OSS Distributions  */
59*1031c584SApple OSS Distributions sfi_class_id_t sfi_thread_classify(thread_t thread);
60*1031c584SApple OSS Distributions sfi_class_id_t sfi_processor_active_thread_classify(processor_t processor);
61*1031c584SApple OSS Distributions ast_t sfi_thread_needs_ast(thread_t thread, sfi_class_id_t *out_class /* optional */);
62*1031c584SApple OSS Distributions ast_t sfi_processor_needs_ast(processor_t processor);
63*1031c584SApple OSS Distributions 
64*1031c584SApple OSS Distributions void sfi_ast(thread_t thread);
65*1031c584SApple OSS Distributions void sfi_reevaluate(thread_t thread);
66*1031c584SApple OSS Distributions kern_return_t sfi_defer(uint64_t);
67*1031c584SApple OSS Distributions #endif /* MACH_KERNEL_PRIVATE */
68*1031c584SApple OSS Distributions 
69*1031c584SApple OSS Distributions #endif /* _KERN_SFI_H_ */
70