]> git.saurik.com Git - apple/xnu.git/blame - osfmk/mach/host_info.h
xnu-2782.20.48.tar.gz
[apple/xnu.git] / osfmk / mach / host_info.h
CommitLineData
1c79356b 1/*
b0d623f7 2 * Copyright (c) 2000-2009 Apple Inc. All rights reserved.
1c79356b 3 *
2d21ac55 4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
1c79356b 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.
8f6c56a5 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.
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
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.
8f6c56a5 25 *
2d21ac55 26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
1c79356b
A
27 */
28/*
29 * @OSF_COPYRIGHT@
30 */
1c79356b
A
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 Software.Distribution@CS.CMU.EDU
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
59/*
60 * File: mach/host_info.h
61 *
62 * Definitions for host_info call.
63 */
64
65#ifndef _MACH_HOST_INFO_H_
66#define _MACH_HOST_INFO_H_
67
91447636 68#include <mach/message.h>
1c79356b
A
69#include <mach/vm_statistics.h>
70#include <mach/machine.h>
71#include <mach/machine/vm_types.h>
72#include <mach/time_value.h>
73
91447636
A
74#include <sys/cdefs.h>
75
1c79356b
A
76/*
77 * Generic information structure to allow for expansion.
78 */
79typedef integer_t *host_info_t; /* varying array of int. */
b0d623f7 80typedef integer_t *host_info64_t; /* varying array of int. */
1c79356b
A
81
82#define HOST_INFO_MAX (1024) /* max array size */
83typedef integer_t host_info_data_t[HOST_INFO_MAX];
84
85#define KERNEL_VERSION_MAX (512)
86typedef char kernel_version_t[KERNEL_VERSION_MAX];
87
88#define KERNEL_BOOT_INFO_MAX (4096)
89typedef char kernel_boot_info_t[KERNEL_BOOT_INFO_MAX];
90
1c79356b
A
91/*
92 * Currently defined information.
93 */
94/* host_info() */
95typedef integer_t host_flavor_t;
96#define HOST_BASIC_INFO 1 /* basic info */
97#define HOST_SCHED_INFO 3 /* scheduling info */
98#define HOST_RESOURCE_SIZES 4 /* kernel struct sizes */
99#define HOST_PRIORITY_INFO 5 /* priority information */
9bccf70c
A
100#define HOST_SEMAPHORE_TRAPS 7 /* Has semaphore traps */
101#define HOST_MACH_MSG_TRAP 8 /* Has mach_msg_trap */
39236c6e 102#define HOST_VM_PURGABLE 9 /* purg'e'able memory info */
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)))
117#endif
118
0c530ab8 119#pragma pack(4)
91447636
A
120
121struct host_basic_info {
122 integer_t max_cpus; /* max number of CPUs possible */
123 integer_t avail_cpus; /* number of CPUs now available */
124 natural_t memory_size; /* size of memory in bytes, capped at 2 GB */
125 cpu_type_t cpu_type; /* cpu type */
126 cpu_subtype_t cpu_subtype; /* cpu subtype */
127 cpu_threadtype_t cpu_threadtype; /* cpu threadtype */
128 integer_t physical_cpu; /* number of physical CPUs now available */
129 integer_t physical_cpu_max; /* max number of physical CPUs possible */
130 integer_t logical_cpu; /* number of logical cpu now available */
131 integer_t logical_cpu_max; /* max number of physical CPUs possible */
132 uint64_t max_mem; /* actual size of physical memory */
133};
134
0c530ab8 135#pragma pack()
91447636 136
1c79356b
A
137typedef struct host_basic_info host_basic_info_data_t;
138typedef struct host_basic_info *host_basic_info_t;
91447636
A
139#define HOST_BASIC_INFO_COUNT ((mach_msg_type_number_t) \
140 (sizeof(host_basic_info_data_t)/sizeof(integer_t)))
1c79356b
A
141
142struct host_sched_info {
143 integer_t min_timeout; /* minimum timeout in milliseconds */
144 integer_t min_quantum; /* minimum quantum in milliseconds */
145};
146
147typedef struct host_sched_info host_sched_info_data_t;
148typedef struct host_sched_info *host_sched_info_t;
91447636
A
149#define HOST_SCHED_INFO_COUNT ((mach_msg_type_number_t) \
150 (sizeof(host_sched_info_data_t)/sizeof(integer_t)))
1c79356b
A
151
152struct kernel_resource_sizes {
91447636
A
153 natural_t task;
154 natural_t thread;
155 natural_t port;
156 natural_t memory_region;
157 natural_t memory_object;
1c79356b
A
158};
159
160typedef struct kernel_resource_sizes kernel_resource_sizes_data_t;
161typedef struct kernel_resource_sizes *kernel_resource_sizes_t;
91447636
A
162#define HOST_RESOURCE_SIZES_COUNT ((mach_msg_type_number_t) \
163 (sizeof(kernel_resource_sizes_data_t)/sizeof(integer_t)))
1c79356b
A
164
165struct host_priority_info {
166 integer_t kernel_priority;
167 integer_t system_priority;
168 integer_t server_priority;
169 integer_t user_priority;
170 integer_t depress_priority;
171 integer_t idle_priority;
172 integer_t minimum_priority;
173 integer_t maximum_priority;
174};
175
176typedef struct host_priority_info host_priority_info_data_t;
177typedef struct host_priority_info *host_priority_info_t;
91447636
A
178#define HOST_PRIORITY_INFO_COUNT ((mach_msg_type_number_t) \
179 (sizeof(host_priority_info_data_t)/sizeof(integer_t)))
1c79356b
A
180
181/* host_statistics() */
182#define HOST_LOAD_INFO 1 /* System loading stats */
183#define HOST_VM_INFO 2 /* Virtual memory stats */
184#define HOST_CPU_LOAD_INFO 3 /* CPU load stats */
185
b0d623f7
A
186/* host_statistics64() */
187#define HOST_VM_INFO64 4 /* 64-bit virtual memory stats */
6d2010ae 188#define HOST_EXTMOD_INFO64 5 /* External modification stats */
39236c6e
A
189#define HOST_EXPIRED_TASK_INFO 6 /* Statistics for expired tasks */
190
b0d623f7 191
1c79356b
A
192struct host_load_info {
193 integer_t avenrun[3]; /* scaled by LOAD_SCALE */
194 integer_t mach_factor[3]; /* scaled by LOAD_SCALE */
195};
196
197typedef struct host_load_info host_load_info_data_t;
198typedef struct host_load_info *host_load_info_t;
91447636
A
199#define HOST_LOAD_INFO_COUNT ((mach_msg_type_number_t) \
200 (sizeof(host_load_info_data_t)/sizeof(integer_t)))
1c79356b 201
39236c6e
A
202typedef struct vm_purgeable_info host_purgable_info_data_t;
203typedef struct vm_purgeable_info *host_purgable_info_t;
204#define HOST_VM_PURGABLE_COUNT ((mach_msg_type_number_t) \
205 (sizeof(host_purgable_info_data_t)/sizeof(integer_t)))
206
1c79356b 207/* in <mach/vm_statistics.h> */
b0d623f7
A
208/* vm_statistics64 */
209#define HOST_VM_INFO64_COUNT ((mach_msg_type_number_t) \
210 (sizeof(vm_statistics64_data_t)/sizeof(integer_t)))
211
212/* size of the latest version of the structure */
213#define HOST_VM_INFO64_LATEST_COUNT HOST_VM_INFO64_COUNT
39236c6e
A
214#define HOST_VM_INFO64_REV1_COUNT HOST_VM_INFO64_LATEST_COUNT
215/* previous versions: adjust the size according to what was added each time */
216#define HOST_VM_INFO64_REV0_COUNT /* added compression and swapper info (14 ints) */\
217 ((mach_msg_type_number_t) \
218 (HOST_VM_INFO64_REV1_COUNT - 14))
b0d623f7 219
6d2010ae
A
220/* in <mach/vm_statistics.h> */
221/* vm_extmod_statistics */
222#define HOST_EXTMOD_INFO64_COUNT ((mach_msg_type_number_t) \
223 (sizeof(vm_extmod_statistics_data_t)/sizeof(integer_t)))
224
225/* size of the latest version of the structure */
226#define HOST_EXTMOD_INFO64_LATEST_COUNT HOST_EXTMOD_INFO64_COUNT
b0d623f7
A
227
228/* vm_statistics */
91447636
A
229#define HOST_VM_INFO_COUNT ((mach_msg_type_number_t) \
230 (sizeof(vm_statistics_data_t)/sizeof(integer_t)))
2d21ac55
A
231
232/* size of the latest version of the structure */
233#define HOST_VM_INFO_LATEST_COUNT HOST_VM_INFO_COUNT
b0d623f7 234#define HOST_VM_INFO_REV2_COUNT HOST_VM_INFO_LATEST_COUNT
2d21ac55
A
235/* previous versions: adjust the size according to what was added each time */
236#define HOST_VM_INFO_REV1_COUNT /* added "speculative_count" (1 int) */ \
237 ((mach_msg_type_number_t) \
238 (HOST_VM_INFO_REV2_COUNT - 1))
239#define HOST_VM_INFO_REV0_COUNT /* added "purgable" info (2 ints) */ \
240 ((mach_msg_type_number_t) \
241 (HOST_VM_INFO_REV1_COUNT - 2))
1c79356b
A
242
243struct host_cpu_load_info { /* number of ticks while running... */
91447636 244 natural_t cpu_ticks[CPU_STATE_MAX]; /* ... in the given mode */
1c79356b 245};
91447636 246
1c79356b
A
247typedef struct host_cpu_load_info host_cpu_load_info_data_t;
248typedef struct host_cpu_load_info *host_cpu_load_info_t;
91447636
A
249#define HOST_CPU_LOAD_INFO_COUNT ((mach_msg_type_number_t) \
250 (sizeof (host_cpu_load_info_data_t) / sizeof (integer_t)))
1c79356b 251
6d2010ae
A
252#ifdef PRIVATE
253/*
254 * CPU Statistics information
255 */
256struct _processor_statistics_np {
257 int32_t ps_cpuid;
258
259 uint32_t ps_csw_count;
260 uint32_t ps_preempt_count;
261 uint32_t ps_preempted_rt_count;
262 uint32_t ps_preempted_by_rt_count;
263
264 uint32_t ps_rt_sched_count;
265
266 uint32_t ps_interrupt_count;
267 uint32_t ps_ipi_count;
268 uint32_t ps_timer_pop_count;
269
270 uint64_t ps_runq_count_sum __attribute((aligned(8)));
271
272 uint32_t ps_idle_transitions;
ebb1b9f4 273 uint32_t ps_quantum_timer_expirations;
6d2010ae
A
274};
275
276#endif /* PRIVATE */
277
278#ifdef KERNEL_PRIVATE
279
280extern kern_return_t set_sched_stats_active(
281 boolean_t active);
282
283extern kern_return_t get_sched_statistics(
284 struct _processor_statistics_np *out,
285 uint32_t *count);
286#endif /* KERNEL_PRIVATE */
287
288
1c79356b 289#endif /* _MACH_HOST_INFO_H_ */