xref: /xnu-11417.121.6/osfmk/mach/thread_switch.h (revision a1e26a70f38d1d7daa7b49b258e2f8538ad81650)
1*a1e26a70SApple OSS Distributions /*
2*a1e26a70SApple OSS Distributions  * Copyright (c) 2000-2004 Apple Computer, Inc. All rights reserved.
3*a1e26a70SApple OSS Distributions  *
4*a1e26a70SApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5*a1e26a70SApple OSS Distributions  *
6*a1e26a70SApple OSS Distributions  * This file contains Original Code and/or Modifications of Original Code
7*a1e26a70SApple OSS Distributions  * as defined in and that are subject to the Apple Public Source License
8*a1e26a70SApple OSS Distributions  * Version 2.0 (the 'License'). You may not use this file except in
9*a1e26a70SApple OSS Distributions  * compliance with the License. The rights granted to you under the License
10*a1e26a70SApple OSS Distributions  * may not be used to create, or enable the creation or redistribution of,
11*a1e26a70SApple OSS Distributions  * unlawful or unlicensed copies of an Apple operating system, or to
12*a1e26a70SApple OSS Distributions  * circumvent, violate, or enable the circumvention or violation of, any
13*a1e26a70SApple OSS Distributions  * terms of an Apple operating system software license agreement.
14*a1e26a70SApple OSS Distributions  *
15*a1e26a70SApple OSS Distributions  * Please obtain a copy of the License at
16*a1e26a70SApple OSS Distributions  * http://www.opensource.apple.com/apsl/ and read it before using this file.
17*a1e26a70SApple OSS Distributions  *
18*a1e26a70SApple OSS Distributions  * The Original Code and all software distributed under the License are
19*a1e26a70SApple OSS Distributions  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20*a1e26a70SApple OSS Distributions  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21*a1e26a70SApple OSS Distributions  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22*a1e26a70SApple OSS Distributions  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23*a1e26a70SApple OSS Distributions  * Please see the License for the specific language governing rights and
24*a1e26a70SApple OSS Distributions  * limitations under the License.
25*a1e26a70SApple OSS Distributions  *
26*a1e26a70SApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27*a1e26a70SApple OSS Distributions  */
28*a1e26a70SApple OSS Distributions /*
29*a1e26a70SApple OSS Distributions  * @OSF_COPYRIGHT@
30*a1e26a70SApple OSS Distributions  */
31*a1e26a70SApple OSS Distributions /*
32*a1e26a70SApple OSS Distributions  * Mach Operating System
33*a1e26a70SApple OSS Distributions  * Copyright (c) 1991,1990,1989 Carnegie Mellon University
34*a1e26a70SApple OSS Distributions  * All Rights Reserved.
35*a1e26a70SApple OSS Distributions  *
36*a1e26a70SApple OSS Distributions  * Permission to use, copy, modify and distribute this software and its
37*a1e26a70SApple OSS Distributions  * documentation is hereby granted, provided that both the copyright
38*a1e26a70SApple OSS Distributions  * notice and this permission notice appear in all copies of the
39*a1e26a70SApple OSS Distributions  * software, derivative works or modified versions, and any portions
40*a1e26a70SApple OSS Distributions  * thereof, and that both notices appear in supporting documentation.
41*a1e26a70SApple OSS Distributions  *
42*a1e26a70SApple OSS Distributions  * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
43*a1e26a70SApple OSS Distributions  * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
44*a1e26a70SApple OSS Distributions  * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
45*a1e26a70SApple OSS Distributions  *
46*a1e26a70SApple OSS Distributions  * Carnegie Mellon requests users of this software to return to
47*a1e26a70SApple OSS Distributions  *
48*a1e26a70SApple OSS Distributions  *  Software Distribution Coordinator  or  [email protected]
49*a1e26a70SApple OSS Distributions  *  School of Computer Science
50*a1e26a70SApple OSS Distributions  *  Carnegie Mellon University
51*a1e26a70SApple OSS Distributions  *  Pittsburgh PA 15213-3890
52*a1e26a70SApple OSS Distributions  *
53*a1e26a70SApple OSS Distributions  * any improvements or extensions that they make and grant Carnegie Mellon
54*a1e26a70SApple OSS Distributions  * the rights to redistribute these changes.
55*a1e26a70SApple OSS Distributions  */
56*a1e26a70SApple OSS Distributions /*
57*a1e26a70SApple OSS Distributions  */
58*a1e26a70SApple OSS Distributions 
59*a1e26a70SApple OSS Distributions #ifndef _MACH_THREAD_SWITCH_H_
60*a1e26a70SApple OSS Distributions #define _MACH_THREAD_SWITCH_H_
61*a1e26a70SApple OSS Distributions 
62*a1e26a70SApple OSS Distributions #include <mach/mach_types.h>
63*a1e26a70SApple OSS Distributions #include <mach/kern_return.h>
64*a1e26a70SApple OSS Distributions #include <mach/message.h>
65*a1e26a70SApple OSS Distributions #include <mach/mach_traps.h>
66*a1e26a70SApple OSS Distributions 
67*a1e26a70SApple OSS Distributions /*
68*a1e26a70SApple OSS Distributions  *	Constant definitions for thread_switch trap.
69*a1e26a70SApple OSS Distributions  */
70*a1e26a70SApple OSS Distributions 
71*a1e26a70SApple OSS Distributions #define SWITCH_OPTION_NONE                      0
72*a1e26a70SApple OSS Distributions #define SWITCH_OPTION_DEPRESS           1
73*a1e26a70SApple OSS Distributions #define SWITCH_OPTION_WAIT                      2
74*a1e26a70SApple OSS Distributions #ifdef PRIVATE
75*a1e26a70SApple OSS Distributions /* Workqueue should not consider thread blocked, and option_time is in us */
76*a1e26a70SApple OSS Distributions #define SWITCH_OPTION_DISPATCH_CONTENTION       3
77*a1e26a70SApple OSS Distributions /* Handoff to lock owner and temporarily grant matching IO throttling policy */
78*a1e26a70SApple OSS Distributions #define SWITCH_OPTION_OSLOCK_DEPRESS    4
79*a1e26a70SApple OSS Distributions #define SWITCH_OPTION_OSLOCK_WAIT       5
80*a1e26a70SApple OSS Distributions #endif /* PRIVATE */
81*a1e26a70SApple OSS Distributions 
82*a1e26a70SApple OSS Distributions #define valid_switch_option(opt)        (0 <= (opt) && (opt) <= 5)
83*a1e26a70SApple OSS Distributions 
84*a1e26a70SApple OSS Distributions #endif  /* _MACH_THREAD_SWITCH_H_ */
85