xref: /xnu-10002.81.5/osfmk/kern/host.h (revision 5e3eaea39dcf651e66cb99ba7d70e32cc4a99587)
1 /*
2  * Copyright (c) 2000-2019 Apple Inc. All rights reserved.
3  *
4  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5  *
6  * This file contains Original Code and/or Modifications of Original Code
7  * as defined in and that are subject to the Apple Public Source License
8  * Version 2.0 (the 'License'). You may not use this file except in
9  * compliance with the License. The rights granted to you under the License
10  * may not be used to create, or enable the creation or redistribution of,
11  * unlawful or unlicensed copies of an Apple operating system, or to
12  * circumvent, violate, or enable the circumvention or violation of, any
13  * terms of an Apple operating system software license agreement.
14  *
15  * Please obtain a copy of the License at
16  * http://www.opensource.apple.com/apsl/ and read it before using this file.
17  *
18  * The Original Code and all software distributed under the License are
19  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23  * Please see the License for the specific language governing rights and
24  * limitations under the License.
25  *
26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27  */
28 /*
29  * @OSF_COPYRIGHT@
30  */
31 /*
32  * Mach Operating System
33  * Copyright (c) 1991,1990,1989,1988 Carnegie Mellon University
34  * All Rights Reserved.
35  *
36  * Permission to use, copy, modify and distribute this software and its
37  * documentation is hereby granted, provided that both the copyright
38  * notice and this permission notice appear in all copies of the
39  * software, derivative works or modified versions, and any portions
40  * thereof, and that both notices appear in supporting documentation.
41  *
42  * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
43  * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
44  * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
45  *
46  * Carnegie Mellon requests users of this software to return to
47  *
48  *  Software Distribution Coordinator  or  [email protected]
49  *  School of Computer Science
50  *  Carnegie Mellon University
51  *  Pittsburgh PA 15213-3890
52  *
53  * any improvements or extensions that they make and grant Carnegie Mellon
54  * the rights to redistribute these changes.
55  */
56 
57 /*
58  *	kern/host.h
59  *
60  *	Definitions for host data structures.
61  *
62  */
63 
64 #ifndef _KERN_HOST_H_
65 #define _KERN_HOST_H_
66 
67 #include <mach/mach_types.h>
68 #include <sys/cdefs.h>
69 
70 #ifdef  MACH_KERNEL_PRIVATE
71 
72 #include <kern/locks.h>
73 #include <kern/exception.h>
74 #include <mach/exception_types.h>
75 #include <mach/host_special_ports.h>
76 #include <kern/kern_types.h>
77 #include <mach/vm_statistics.h>
78 
79 struct  host {
80 	decl_lck_mtx_data(, lock);               /* lock to protect exceptions */
81 	ipc_port_t XNU_PTRAUTH_SIGNED_PTR("host.special") special[HOST_MAX_SPECIAL_PORT + 1];
82 	struct exception_action exc_actions[EXC_TYPES_COUNT];
83 };
84 
85 typedef struct host     host_data_t;
86 
87 extern host_data_t      realhost;
88 
89 #define host_lock(host)         lck_mtx_lock(&(host)->lock)
90 #define host_unlock(host)       lck_mtx_unlock(&(host)->lock)
91 
92 extern vm_extmod_statistics_data_t host_extmod_statistics;
93 
94 typedef struct {
95 	uint64_t total_user_time;
96 	uint64_t total_system_time;
97 	uint64_t task_interrupt_wakeups;
98 	uint64_t task_platform_idle_wakeups;
99 	uint64_t task_timer_wakeups_bin_1;
100 	uint64_t task_timer_wakeups_bin_2;
101 	uint64_t total_ptime;
102 	uint64_t total_pset_switches;
103 	uint64_t task_gpu_ns;
104 	uint64_t task_energy;
105 } expired_task_statistics_t;
106 
107 extern expired_task_statistics_t dead_task_statistics;
108 
109 extern kern_return_t host_set_special_port(host_priv_t host_priv, int id, ipc_port_t port);
110 extern kern_return_t host_get_special_port(host_priv_t host_priv,
111     __unused int node, int id, ipc_port_t * portp);
112 
113 #endif  /* MACH_KERNEL_PRIVATE */
114 
115 /*
116  * Access routines for inside the kernel.
117  */
118 
119 __BEGIN_DECLS
120 
121 extern host_t                   host_self(void);
122 extern host_priv_t              host_priv_self(void);
123 
124 __END_DECLS
125 
126 #endif  /* _KERN_HOST_H_ */
127