]> git.saurik.com Git - apple/xnu.git/blame - osfmk/mach/host_info.h
xnu-4570.41.2.tar.gz
[apple/xnu.git] / osfmk / mach / host_info.h
CommitLineData
1c79356b 1/*
3e170ce0 2 * Copyright (c) 2000-2015 Apple Inc. All rights reserved.
1c79356b 3 *
2d21ac55 4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
3e170ce0 5 *
2d21ac55
A
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.
3e170ce0 14 *
2d21ac55
A
15 * Please obtain a copy of the License at
16 * http://www.opensource.apple.com/apsl/ and read it before using this file.
3e170ce0 17 *
2d21ac55
A
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
8f6c56a5
A
20 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
2d21ac55
A
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.
3e170ce0 25 *
2d21ac55 26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
1c79356b
A
27 */
28/*
29 * @OSF_COPYRIGHT@
30 */
3e170ce0 31/*
1c79356b
A
32 * Mach Operating System
33 * Copyright (c) 1991,1990,1989,1988 Carnegie Mellon University
34 * All Rights Reserved.
3e170ce0 35 *
1c79356b
A
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.
3e170ce0 41 *
1c79356b
A
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.
3e170ce0 45 *
1c79356b 46 * Carnegie Mellon requests users of this software to return to
3e170ce0 47 *
1c79356b
A
48 * Software Distribution Coordinator or Software.Distribution@CS.CMU.EDU
49 * School of Computer Science
50 * Carnegie Mellon University
51 * Pittsburgh PA 15213-3890
3e170ce0 52 *
1c79356b
A
53 * any improvements or extensions that they make and grant Carnegie Mellon
54 * the rights to redistribute these changes.
55 */
1c79356b
A
56
57/*
58 * File: mach/host_info.h
59 *
60 * Definitions for host_info call.
61 */
62
63#ifndef _MACH_HOST_INFO_H_
64#define _MACH_HOST_INFO_H_
65
91447636 66#include <mach/message.h>
1c79356b
A
67#include <mach/vm_statistics.h>
68#include <mach/machine.h>
69#include <mach/machine/vm_types.h>
70#include <mach/time_value.h>
71
91447636
A
72#include <sys/cdefs.h>
73
1c79356b
A
74/*
75 * Generic information structure to allow for expansion.
76 */
77typedef integer_t *host_info_t; /* varying array of int. */
b0d623f7 78typedef integer_t *host_info64_t; /* varying array of int. */
1c79356b
A
79
80#define HOST_INFO_MAX (1024) /* max array size */
81typedef integer_t host_info_data_t[HOST_INFO_MAX];
82
83#define KERNEL_VERSION_MAX (512)
84typedef char kernel_version_t[KERNEL_VERSION_MAX];
85
86#define KERNEL_BOOT_INFO_MAX (4096)
87typedef char kernel_boot_info_t[KERNEL_BOOT_INFO_MAX];
88
1c79356b
A
89/*
90 * Currently defined information.
91 */
92/* host_info() */
93typedef integer_t host_flavor_t;
94#define HOST_BASIC_INFO 1 /* basic info */
95#define HOST_SCHED_INFO 3 /* scheduling info */
96#define HOST_RESOURCE_SIZES 4 /* kernel struct sizes */
97#define HOST_PRIORITY_INFO 5 /* priority information */
9bccf70c
A
98#define HOST_SEMAPHORE_TRAPS 7 /* Has semaphore traps */
99#define HOST_MACH_MSG_TRAP 8 /* Has mach_msg_trap */
39236c6e 100#define HOST_VM_PURGABLE 9 /* purg'e'able memory info */
3e170ce0 101#define HOST_DEBUG_INFO_INTERNAL 10 /* Used for kernel internal development tests only */
39037602 102#define HOST_CAN_HAS_DEBUGGER 11
1c79356b 103
91447636
A
104#ifdef MACH_KERNEL_PRIVATE
105struct host_basic_info_old {
1c79356b 106 integer_t max_cpus; /* max number of cpus possible */
2d21ac55 107 uint32_t avail_cpus; /* number of cpus now available */
91447636 108 natural_t memory_size; /* size of memory in bytes */
1c79356b
A
109 cpu_type_t cpu_type; /* cpu type */
110 cpu_subtype_t cpu_subtype; /* cpu subtype */
111};
112
91447636
A
113typedef struct host_basic_info_old host_basic_info_data_old_t;
114typedef struct host_basic_info_old *host_basic_info_old_t;
115#define HOST_BASIC_INFO_OLD_COUNT ((mach_msg_type_number_t) \
116 (sizeof(host_basic_info_data_old_t)/sizeof(integer_t)))
3e170ce0 117#endif /* MACH_KERNEL_PRIVATE */
91447636 118
39037602
A
119struct host_can_has_debugger_info {
120 boolean_t can_has_debugger;
121};
122typedef struct host_can_has_debugger_info host_can_has_debugger_info_data_t;
123typedef struct host_can_has_debugger_info *host_can_has_debugger_info_t;
124#define HOST_CAN_HAS_DEBUGGER_COUNT ((mach_msg_type_number_t) \
125 (sizeof(host_can_has_debugger_info_data_t)/sizeof(integer_t)))
126
0c530ab8 127#pragma pack(4)
91447636
A
128
129struct host_basic_info {
130 integer_t max_cpus; /* max number of CPUs possible */
131 integer_t avail_cpus; /* number of CPUs now available */
132 natural_t memory_size; /* size of memory in bytes, capped at 2 GB */
133 cpu_type_t cpu_type; /* cpu type */
134 cpu_subtype_t cpu_subtype; /* cpu subtype */
135 cpu_threadtype_t cpu_threadtype; /* cpu threadtype */
136 integer_t physical_cpu; /* number of physical CPUs now available */
137 integer_t physical_cpu_max; /* max number of physical CPUs possible */
138 integer_t logical_cpu; /* number of logical cpu now available */
139 integer_t logical_cpu_max; /* max number of physical CPUs possible */
140 uint64_t max_mem; /* actual size of physical memory */
141};
142
0c530ab8 143#pragma pack()
91447636 144
1c79356b
A
145typedef struct host_basic_info host_basic_info_data_t;
146typedef struct host_basic_info *host_basic_info_t;
91447636
A
147#define HOST_BASIC_INFO_COUNT ((mach_msg_type_number_t) \
148 (sizeof(host_basic_info_data_t)/sizeof(integer_t)))
1c79356b
A
149
150struct host_sched_info {
151 integer_t min_timeout; /* minimum timeout in milliseconds */
152 integer_t min_quantum; /* minimum quantum in milliseconds */
153};
154
155typedef struct host_sched_info host_sched_info_data_t;
156typedef struct host_sched_info *host_sched_info_t;
91447636
A
157#define HOST_SCHED_INFO_COUNT ((mach_msg_type_number_t) \
158 (sizeof(host_sched_info_data_t)/sizeof(integer_t)))
1c79356b
A
159
160struct kernel_resource_sizes {
91447636
A
161 natural_t task;
162 natural_t thread;
163 natural_t port;
164 natural_t memory_region;
165 natural_t memory_object;
1c79356b
A
166};
167
168typedef struct kernel_resource_sizes kernel_resource_sizes_data_t;
169typedef struct kernel_resource_sizes *kernel_resource_sizes_t;
91447636
A
170#define HOST_RESOURCE_SIZES_COUNT ((mach_msg_type_number_t) \
171 (sizeof(kernel_resource_sizes_data_t)/sizeof(integer_t)))
1c79356b
A
172
173struct host_priority_info {
174 integer_t kernel_priority;
175 integer_t system_priority;
176 integer_t server_priority;
177 integer_t user_priority;
178 integer_t depress_priority;
179 integer_t idle_priority;
180 integer_t minimum_priority;
181 integer_t maximum_priority;
182};
183
184typedef struct host_priority_info host_priority_info_data_t;
185typedef struct host_priority_info *host_priority_info_t;
91447636
A
186#define HOST_PRIORITY_INFO_COUNT ((mach_msg_type_number_t) \
187 (sizeof(host_priority_info_data_t)/sizeof(integer_t)))
1c79356b
A
188
189/* host_statistics() */
190#define HOST_LOAD_INFO 1 /* System loading stats */
191#define HOST_VM_INFO 2 /* Virtual memory stats */
192#define HOST_CPU_LOAD_INFO 3 /* CPU load stats */
193
b0d623f7
A
194/* host_statistics64() */
195#define HOST_VM_INFO64 4 /* 64-bit virtual memory stats */
6d2010ae 196#define HOST_EXTMOD_INFO64 5 /* External modification stats */
39236c6e
A
197#define HOST_EXPIRED_TASK_INFO 6 /* Statistics for expired tasks */
198
cc8bc92a
A
199#ifdef XNU_KERNEL_PRIVATE
200void host_statistics_init(void);
201#endif
b0d623f7 202
1c79356b
A
203struct host_load_info {
204 integer_t avenrun[3]; /* scaled by LOAD_SCALE */
205 integer_t mach_factor[3]; /* scaled by LOAD_SCALE */
206};
207
208typedef struct host_load_info host_load_info_data_t;
209typedef struct host_load_info *host_load_info_t;
91447636
A
210#define HOST_LOAD_INFO_COUNT ((mach_msg_type_number_t) \
211 (sizeof(host_load_info_data_t)/sizeof(integer_t)))
1c79356b 212
39236c6e
A
213typedef struct vm_purgeable_info host_purgable_info_data_t;
214typedef struct vm_purgeable_info *host_purgable_info_t;
215#define HOST_VM_PURGABLE_COUNT ((mach_msg_type_number_t) \
216 (sizeof(host_purgable_info_data_t)/sizeof(integer_t)))
217
1c79356b 218/* in <mach/vm_statistics.h> */
b0d623f7
A
219/* vm_statistics64 */
220#define HOST_VM_INFO64_COUNT ((mach_msg_type_number_t) \
221 (sizeof(vm_statistics64_data_t)/sizeof(integer_t)))
222
223/* size of the latest version of the structure */
224#define HOST_VM_INFO64_LATEST_COUNT HOST_VM_INFO64_COUNT
39236c6e
A
225#define HOST_VM_INFO64_REV1_COUNT HOST_VM_INFO64_LATEST_COUNT
226/* previous versions: adjust the size according to what was added each time */
227#define HOST_VM_INFO64_REV0_COUNT /* added compression and swapper info (14 ints) */\
228 ((mach_msg_type_number_t) \
229 (HOST_VM_INFO64_REV1_COUNT - 14))
b0d623f7 230
6d2010ae
A
231/* in <mach/vm_statistics.h> */
232/* vm_extmod_statistics */
233#define HOST_EXTMOD_INFO64_COUNT ((mach_msg_type_number_t) \
234 (sizeof(vm_extmod_statistics_data_t)/sizeof(integer_t)))
235
236/* size of the latest version of the structure */
237#define HOST_EXTMOD_INFO64_LATEST_COUNT HOST_EXTMOD_INFO64_COUNT
b0d623f7
A
238
239/* vm_statistics */
91447636
A
240#define HOST_VM_INFO_COUNT ((mach_msg_type_number_t) \
241 (sizeof(vm_statistics_data_t)/sizeof(integer_t)))
2d21ac55
A
242
243/* size of the latest version of the structure */
244#define HOST_VM_INFO_LATEST_COUNT HOST_VM_INFO_COUNT
b0d623f7 245#define HOST_VM_INFO_REV2_COUNT HOST_VM_INFO_LATEST_COUNT
2d21ac55
A
246/* previous versions: adjust the size according to what was added each time */
247#define HOST_VM_INFO_REV1_COUNT /* added "speculative_count" (1 int) */ \
248 ((mach_msg_type_number_t) \
249 (HOST_VM_INFO_REV2_COUNT - 1))
3e170ce0 250#define HOST_VM_INFO_REV0_COUNT /* added "purgable" info (2 ints) */ \
2d21ac55
A
251 ((mach_msg_type_number_t) \
252 (HOST_VM_INFO_REV1_COUNT - 2))
1c79356b
A
253
254struct host_cpu_load_info { /* number of ticks while running... */
91447636 255 natural_t cpu_ticks[CPU_STATE_MAX]; /* ... in the given mode */
1c79356b 256};
91447636 257
1c79356b
A
258typedef struct host_cpu_load_info host_cpu_load_info_data_t;
259typedef struct host_cpu_load_info *host_cpu_load_info_t;
91447636
A
260#define HOST_CPU_LOAD_INFO_COUNT ((mach_msg_type_number_t) \
261 (sizeof (host_cpu_load_info_data_t) / sizeof (integer_t)))
1c79356b 262
6d2010ae
A
263#ifdef PRIVATE
264/*
265 * CPU Statistics information
266 */
267struct _processor_statistics_np {
268 int32_t ps_cpuid;
269
270 uint32_t ps_csw_count;
271 uint32_t ps_preempt_count;
272 uint32_t ps_preempted_rt_count;
273 uint32_t ps_preempted_by_rt_count;
274
275 uint32_t ps_rt_sched_count;
276
277 uint32_t ps_interrupt_count;
278 uint32_t ps_ipi_count;
279 uint32_t ps_timer_pop_count;
3e170ce0 280
6d2010ae
A
281 uint64_t ps_runq_count_sum __attribute((aligned(8)));
282
283 uint32_t ps_idle_transitions;
ebb1b9f4 284 uint32_t ps_quantum_timer_expirations;
6d2010ae
A
285};
286
3e170ce0
A
287struct host_debug_info_internal {
288 uint64_t config_bank:1, /* built configurations */
289 config_atm:1,
290 config_csr:1,
291 config_coalitions:1,
292 config_unused:60;
293};
294
295typedef struct host_debug_info_internal *host_debug_info_internal_t;
296typedef struct host_debug_info_internal host_debug_info_internal_data_t;
297#define HOST_DEBUG_INFO_INTERNAL_COUNT ((mach_msg_type_number_t)\
298 (sizeof (host_debug_info_internal_data_t) / sizeof(integer_t)))
299
6d2010ae
A
300#endif /* PRIVATE */
301
302#ifdef KERNEL_PRIVATE
303
304extern kern_return_t set_sched_stats_active(
305 boolean_t active);
306
3e170ce0
A
307extern kern_return_t get_sched_statistics(
308 struct _processor_statistics_np *out,
6d2010ae
A
309 uint32_t *count);
310#endif /* KERNEL_PRIVATE */
311
312
1c79356b 313#endif /* _MACH_HOST_INFO_H_ */