xref: /xnu-12377.81.4/osfmk/kern/affinity.h (revision 043036a2b3718f7f0be807e2870f8f47d3fa0796)
1*043036a2SApple OSS Distributions /*
2*043036a2SApple OSS Distributions  * Copyright (c) 2007-2008 Apple Inc. All rights reserved.
3*043036a2SApple OSS Distributions  *
4*043036a2SApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5*043036a2SApple OSS Distributions  *
6*043036a2SApple OSS Distributions  * This file contains Original Code and/or Modifications of Original Code
7*043036a2SApple OSS Distributions  * as defined in and that are subject to the Apple Public Source License
8*043036a2SApple OSS Distributions  * Version 2.0 (the 'License'). You may not use this file except in
9*043036a2SApple OSS Distributions  * compliance with the License. The rights granted to you under the License
10*043036a2SApple OSS Distributions  * may not be used to create, or enable the creation or redistribution of,
11*043036a2SApple OSS Distributions  * unlawful or unlicensed copies of an Apple operating system, or to
12*043036a2SApple OSS Distributions  * circumvent, violate, or enable the circumvention or violation of, any
13*043036a2SApple OSS Distributions  * terms of an Apple operating system software license agreement.
14*043036a2SApple OSS Distributions  *
15*043036a2SApple OSS Distributions  * Please obtain a copy of the License at
16*043036a2SApple OSS Distributions  * http://www.opensource.apple.com/apsl/ and read it before using this file.
17*043036a2SApple OSS Distributions  *
18*043036a2SApple OSS Distributions  * The Original Code and all software distributed under the License are
19*043036a2SApple OSS Distributions  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20*043036a2SApple OSS Distributions  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21*043036a2SApple OSS Distributions  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22*043036a2SApple OSS Distributions  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23*043036a2SApple OSS Distributions  * Please see the License for the specific language governing rights and
24*043036a2SApple OSS Distributions  * limitations under the License.
25*043036a2SApple OSS Distributions  *
26*043036a2SApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27*043036a2SApple OSS Distributions  */
28*043036a2SApple OSS Distributions 
29*043036a2SApple OSS Distributions #ifdef  XNU_KERNEL_PRIVATE
30*043036a2SApple OSS Distributions 
31*043036a2SApple OSS Distributions #ifndef _KERN_AFFINITY_H_
32*043036a2SApple OSS Distributions #define _KERN_AFFINITY_H_
33*043036a2SApple OSS Distributions 
34*043036a2SApple OSS Distributions #ifdef  MACH_KERNEL_PRIVATE
35*043036a2SApple OSS Distributions 
36*043036a2SApple OSS Distributions #include <kern/queue.h>
37*043036a2SApple OSS Distributions #include <kern/processor.h>
38*043036a2SApple OSS Distributions 
39*043036a2SApple OSS Distributions /*
40*043036a2SApple OSS Distributions  * An affinity set object represents a set of threads identified by the user
41*043036a2SApple OSS Distributions  * to be sharing (cache) affinity. A task may have multiple affinity sets
42*043036a2SApple OSS Distributions  * defined. Each set has dis-affinity other sets. Tasks related by inheritance
43*043036a2SApple OSS Distributions  * may share the same affinity set namespace.
44*043036a2SApple OSS Distributions  * Affinity sets are used to advise (hint) thread placement.
45*043036a2SApple OSS Distributions  */
46*043036a2SApple OSS Distributions struct affinity_set {
47*043036a2SApple OSS Distributions 	struct affinity_space *aset_space;      /* namespace */
48*043036a2SApple OSS Distributions 	queue_chain_t   aset_affinities;        /* links affinities in group */
49*043036a2SApple OSS Distributions 	queue_head_t    aset_threads;           /* threads in affinity set */
50*043036a2SApple OSS Distributions 	uint32_t        aset_thread_count;      /* num threads in set */
51*043036a2SApple OSS Distributions 	uint32_t        aset_tag;               /* user-assigned tag */
52*043036a2SApple OSS Distributions 	uint32_t        aset_num;               /* kernel-assigned affinity */
53*043036a2SApple OSS Distributions 	processor_set_t aset_pset;              /* processor set */
54*043036a2SApple OSS Distributions };
55*043036a2SApple OSS Distributions 
56*043036a2SApple OSS Distributions extern boolean_t        thread_affinity_is_supported(void);
57*043036a2SApple OSS Distributions extern void             thread_affinity_dup(thread_t parent, thread_t child);
58*043036a2SApple OSS Distributions extern void             thread_affinity_terminate(thread_t thread);
59*043036a2SApple OSS Distributions extern void             task_affinity_create(
60*043036a2SApple OSS Distributions 	task_t,
61*043036a2SApple OSS Distributions 	task_t);
62*043036a2SApple OSS Distributions extern void             task_affinity_deallocate(
63*043036a2SApple OSS Distributions 	task_t);
64*043036a2SApple OSS Distributions extern kern_return_t    task_affinity_info(
65*043036a2SApple OSS Distributions 	task_t,
66*043036a2SApple OSS Distributions 	task_info_t,
67*043036a2SApple OSS Distributions 	mach_msg_type_number_t  *);
68*043036a2SApple OSS Distributions 
69*043036a2SApple OSS Distributions #endif  /* MACH_KERNEL_PRIVATE */
70*043036a2SApple OSS Distributions 
71*043036a2SApple OSS Distributions extern kern_return_t    thread_affinity_set(thread_t thread, uint32_t tag);
72*043036a2SApple OSS Distributions extern uint32_t         thread_affinity_get(thread_t thread);
73*043036a2SApple OSS Distributions extern void             thread_affinity_exec(thread_t thread);
74*043036a2SApple OSS Distributions 
75*043036a2SApple OSS Distributions #endif  /* _KERN_AFFINITY_H_ */
76*043036a2SApple OSS Distributions 
77*043036a2SApple OSS Distributions #endif  /* XNU_KERNEL_PRIVATE */
78