2 * Copyright (c) 2000-2007, 2015 Apple Inc. All rights reserved.
4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
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.
15 * Please obtain a copy of the License at
16 * http://www.opensource.apple.com/apsl/ and read it before using this file.
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.
26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
32 * Mach Operating System
33 * Copyright (c) 1991,1990,1989,1988,1987 Carnegie Mellon University
34 * All Rights Reserved.
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.
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.
46 * Carnegie Mellon requests users of this software to return to
48 * Software Distribution Coordinator or Software.Distribution@CS.CMU.EDU
49 * School of Computer Science
50 * Carnegie Mellon University
51 * Pittsburgh PA 15213-3890
53 * any improvements or extensions that they make and grant Carnegie Mellon
54 * the rights to redistribute these changes.
57 * Machine-independent task information structures and definitions.
59 * The definitions in this file are exported to the user. The kernel
60 * will translate its internal data structures to these structures
65 #ifndef _MACH_TASK_INFO_H_
66 #define _MACH_TASK_INFO_H_
68 #include <mach/message.h>
69 #include <mach/machine/vm_types.h>
70 #include <mach/time_value.h>
71 #include <mach/policy.h>
72 #include <mach/vm_statistics.h> /* for vm_extmod_statistics_data_t */
73 #include <Availability.h>
75 #include <sys/cdefs.h>
78 * Generic information structure to allow for expansion.
80 typedef natural_t task_flavor_t
;
81 typedef integer_t
*task_info_t
; /* varying array of int */
83 /* Deprecated, use per structure _data_t's instead */
84 #define TASK_INFO_MAX (1024) /* maximum array size */
85 typedef integer_t task_info_data_t
[TASK_INFO_MAX
];
88 * Currently defined information structures.
93 /* Don't use this, use MACH_TASK_BASIC_INFO instead */
94 #define TASK_BASIC_INFO_32 4 /* basic information */
95 #define TASK_BASIC2_INFO_32 6
97 struct task_basic_info_32
{
98 integer_t suspend_count
; /* suspend count for task */
99 natural_t virtual_size
; /* virtual memory size (bytes) */
100 natural_t resident_size
; /* resident memory size (bytes) */
101 time_value_t user_time
; /* total user run time for
102 terminated threads */
103 time_value_t system_time
; /* total system run time for
104 terminated threads */
105 policy_t policy
; /* default policy for new threads */
107 typedef struct task_basic_info_32 task_basic_info_32_data_t
;
108 typedef struct task_basic_info_32
*task_basic_info_32_t
;
109 #define TASK_BASIC_INFO_32_COUNT \
110 (sizeof(task_basic_info_32_data_t) / sizeof(natural_t))
112 /* Don't use this, use MACH_TASK_BASIC_INFO instead */
113 struct task_basic_info_64
{
114 integer_t suspend_count
; /* suspend count for task */
115 #if defined(__arm__) || defined(__arm64__)
117 /* Compatibility with old 32-bit mach_vm_size_t */
118 natural_t virtual_size
; /* virtual memory size (bytes) */
119 natural_t resident_size
; /* resident memory size (bytes) */
121 mach_vm_size_t virtual_size
; /* virtual memory size (bytes) */
122 mach_vm_size_t resident_size
; /* resident memory size (bytes) */
124 #else /* defined(__arm__) || defined(__arm64__) */
125 mach_vm_size_t virtual_size
; /* virtual memory size (bytes) */
126 mach_vm_size_t resident_size
; /* resident memory size (bytes) */
127 #endif /* defined(__arm__) || defined(__arm64__) */
128 time_value_t user_time
; /* total user run time for
129 terminated threads */
130 time_value_t system_time
; /* total system run time for
131 terminated threads */
132 policy_t policy
; /* default policy for new threads */
134 typedef struct task_basic_info_64 task_basic_info_64_data_t
;
135 typedef struct task_basic_info_64
*task_basic_info_64_t
;
137 #if defined(__arm__) || defined(__arm64__)
140 * Backwards-compatibility for old mach_vm*_t types.
141 * The kernel knows about old and new, and if you are compiled
142 * to run on an earlier iOS version, you interact with the old
143 * (narrow) version. If you are compiled for a newer OS
144 * version, however, you are mapped to the wide version.
147 #define TASK_BASIC_INFO_64 5
148 #define TASK_BASIC_INFO_64_COUNT \
149 (sizeof(task_basic_info_64_data_t) / sizeof(natural_t))
151 #elif defined(__arm__) && defined(__IPHONE_OS_VERSION_MIN_REQUIRED) && (__IPHONE_OS_VERSION_MIN_REQUIRED < __IPHONE_5_0)
153 * Note: arm64 can't use the old flavor. If you somehow manage to,
154 * you can cope with the nonsense data yourself.
156 #define TASK_BASIC_INFO_64 5
157 #define TASK_BASIC_INFO_64_COUNT \
158 (sizeof(task_basic_info_64_data_t) / sizeof(natural_t))
162 #define TASK_BASIC_INFO_64 TASK_BASIC_INFO_64_2
163 #define TASK_BASIC_INFO_64_COUNT TASK_BASIC_INFO_64_2_COUNT
165 #else /* defined(__arm__) || defined(__arm64__) */
166 #define TASK_BASIC_INFO_64 5 /* 64-bit capable basic info */
167 #define TASK_BASIC_INFO_64_COUNT \
168 (sizeof(task_basic_info_64_data_t) / sizeof(natural_t))
172 /* localized structure - cannot be safely passed between tasks of differing sizes */
173 /* Don't use this, use MACH_TASK_BASIC_INFO instead */
174 struct task_basic_info
{
175 integer_t suspend_count
; /* suspend count for task */
176 vm_size_t virtual_size
; /* virtual memory size (bytes) */
177 vm_size_t resident_size
; /* resident memory size (bytes) */
178 time_value_t user_time
; /* total user run time for
179 terminated threads */
180 time_value_t system_time
; /* total system run time for
181 terminated threads */
182 policy_t policy
; /* default policy for new threads */
185 typedef struct task_basic_info task_basic_info_data_t
;
186 typedef struct task_basic_info
*task_basic_info_t
;
187 #define TASK_BASIC_INFO_COUNT \
188 (sizeof(task_basic_info_data_t) / sizeof(natural_t))
189 #if !defined(__LP64__)
190 #define TASK_BASIC_INFO TASK_BASIC_INFO_32
192 #define TASK_BASIC_INFO TASK_BASIC_INFO_64
197 #define TASK_EVENTS_INFO 2 /* various event counts */
199 struct task_events_info
{
200 integer_t faults
; /* number of page faults */
201 integer_t pageins
; /* number of actual pageins */
202 integer_t cow_faults
; /* number of copy-on-write faults */
203 integer_t messages_sent
; /* number of messages sent */
204 integer_t messages_received
; /* number of messages received */
205 integer_t syscalls_mach
; /* number of mach system calls */
206 integer_t syscalls_unix
; /* number of unix system calls */
207 integer_t csw
; /* number of context switches */
209 typedef struct task_events_info task_events_info_data_t
;
210 typedef struct task_events_info
*task_events_info_t
;
211 #define TASK_EVENTS_INFO_COUNT ((mach_msg_type_number_t) \
212 (sizeof(task_events_info_data_t) / sizeof(natural_t)))
214 #define TASK_THREAD_TIMES_INFO 3 /* total times for live threads -
215 only accurate if suspended */
217 struct task_thread_times_info
{
218 time_value_t user_time
; /* total user run time for
220 time_value_t system_time
; /* total system run time for
224 typedef struct task_thread_times_info task_thread_times_info_data_t
;
225 typedef struct task_thread_times_info
*task_thread_times_info_t
;
226 #define TASK_THREAD_TIMES_INFO_COUNT ((mach_msg_type_number_t) \
227 (sizeof(task_thread_times_info_data_t) / sizeof(natural_t)))
229 #define TASK_ABSOLUTETIME_INFO 1
231 struct task_absolutetime_info
{
233 uint64_t total_system
;
234 uint64_t threads_user
; /* existing threads only */
235 uint64_t threads_system
;
238 typedef struct task_absolutetime_info task_absolutetime_info_data_t
;
239 typedef struct task_absolutetime_info
*task_absolutetime_info_t
;
240 #define TASK_ABSOLUTETIME_INFO_COUNT ((mach_msg_type_number_t) \
241 (sizeof (task_absolutetime_info_data_t) / sizeof (natural_t)))
243 #define TASK_KERNELMEMORY_INFO 7
245 struct task_kernelmemory_info
{
246 uint64_t total_palloc
; /* private kernel mem alloc'ed */
247 uint64_t total_pfree
; /* private kernel mem freed */
248 uint64_t total_salloc
; /* shared kernel mem alloc'ed */
249 uint64_t total_sfree
; /* shared kernel mem freed */
252 typedef struct task_kernelmemory_info task_kernelmemory_info_data_t
;
253 typedef struct task_kernelmemory_info
*task_kernelmemory_info_t
;
254 #define TASK_KERNELMEMORY_INFO_COUNT ((mach_msg_type_number_t) \
255 (sizeof (task_kernelmemory_info_data_t) / sizeof (natural_t)))
257 #define TASK_SECURITY_TOKEN 13
258 #define TASK_SECURITY_TOKEN_COUNT ((mach_msg_type_number_t) \
259 (sizeof(security_token_t) / sizeof(natural_t)))
261 #define TASK_AUDIT_TOKEN 15
262 #define TASK_AUDIT_TOKEN_COUNT \
263 (sizeof(audit_token_t) / sizeof(natural_t))
266 #define TASK_AFFINITY_TAG_INFO 16 /* This is experimental. */
268 struct task_affinity_tag_info
{
272 integer_t task_count
;
274 typedef struct task_affinity_tag_info task_affinity_tag_info_data_t
;
275 typedef struct task_affinity_tag_info
*task_affinity_tag_info_t
;
276 #define TASK_AFFINITY_TAG_INFO_COUNT \
277 (sizeof(task_affinity_tag_info_data_t) / sizeof(natural_t))
279 #define TASK_DYLD_INFO 17
281 struct task_dyld_info
{
282 mach_vm_address_t all_image_info_addr
;
283 mach_vm_size_t all_image_info_size
;
284 integer_t all_image_info_format
;
286 typedef struct task_dyld_info task_dyld_info_data_t
;
287 typedef struct task_dyld_info
*task_dyld_info_t
;
288 #define TASK_DYLD_INFO_COUNT \
289 (sizeof(task_dyld_info_data_t) / sizeof(natural_t))
290 #define TASK_DYLD_ALL_IMAGE_INFO_32 0 /* format value */
291 #define TASK_DYLD_ALL_IMAGE_INFO_64 1 /* format value */
293 #if defined(__arm__) || defined(__arm64__)
295 /* Don't use this, use MACH_TASK_BASIC_INFO instead */
296 /* Compatibility for old 32-bit mach_vm_*_t */
297 #define TASK_BASIC_INFO_64_2 18 /* 64-bit capable basic info */
299 struct task_basic_info_64_2
{
300 integer_t suspend_count
; /* suspend count for task */
301 mach_vm_size_t virtual_size
; /* virtual memory size (bytes) */
302 mach_vm_size_t resident_size
; /* resident memory size (bytes) */
303 time_value_t user_time
; /* total user run time for
304 terminated threads */
305 time_value_t system_time
; /* total system run time for
306 terminated threads */
307 policy_t policy
; /* default policy for new threads */
309 typedef struct task_basic_info_64_2 task_basic_info_64_2_data_t
;
310 typedef struct task_basic_info_64_2
*task_basic_info_64_2_t
;
311 #define TASK_BASIC_INFO_64_2_COUNT \
312 (sizeof(task_basic_info_64_2_data_t) / sizeof(natural_t))
315 #define TASK_EXTMOD_INFO 19
317 struct task_extmod_info
{
318 unsigned char task_uuid
[16];
319 vm_extmod_statistics_data_t extmod_statistics
;
321 typedef struct task_extmod_info task_extmod_info_data_t
;
322 typedef struct task_extmod_info
*task_extmod_info_t
;
323 #define TASK_EXTMOD_INFO_COUNT \
324 (sizeof(task_extmod_info_data_t) / sizeof(natural_t))
327 #define MACH_TASK_BASIC_INFO 20 /* always 64-bit basic info */
328 struct mach_task_basic_info
{
329 mach_vm_size_t virtual_size
; /* virtual memory size (bytes) */
330 mach_vm_size_t resident_size
; /* resident memory size (bytes) */
331 mach_vm_size_t resident_size_max
; /* maximum resident memory size (bytes) */
332 time_value_t user_time
; /* total user run time for
333 terminated threads */
334 time_value_t system_time
; /* total system run time for
335 terminated threads */
336 policy_t policy
; /* default policy for new threads */
337 integer_t suspend_count
; /* suspend count for task */
339 typedef struct mach_task_basic_info mach_task_basic_info_data_t
;
340 typedef struct mach_task_basic_info
*mach_task_basic_info_t
;
341 #define MACH_TASK_BASIC_INFO_COUNT \
342 (sizeof(mach_task_basic_info_data_t) / sizeof(natural_t))
345 #define TASK_POWER_INFO 21
347 struct task_power_info
{
349 uint64_t total_system
;
350 uint64_t task_interrupt_wakeups
;
351 uint64_t task_platform_idle_wakeups
;
352 uint64_t task_timer_wakeups_bin_1
;
353 uint64_t task_timer_wakeups_bin_2
;
356 typedef struct task_power_info task_power_info_data_t
;
357 typedef struct task_power_info
*task_power_info_t
;
358 #define TASK_POWER_INFO_COUNT ((mach_msg_type_number_t) \
359 (sizeof (task_power_info_data_t) / sizeof (natural_t)))
363 #define TASK_VM_INFO 22
364 #define TASK_VM_INFO_PURGEABLE 23
365 struct task_vm_info
{
366 mach_vm_size_t virtual_size
; /* virtual memory size (bytes) */
367 integer_t region_count
; /* number of memory regions */
369 mach_vm_size_t resident_size
; /* resident memory size (bytes) */
370 mach_vm_size_t resident_size_peak
; /* peak resident size (bytes) */
372 mach_vm_size_t device
;
373 mach_vm_size_t device_peak
;
374 mach_vm_size_t internal
;
375 mach_vm_size_t internal_peak
;
376 mach_vm_size_t external
;
377 mach_vm_size_t external_peak
;
378 mach_vm_size_t reusable
;
379 mach_vm_size_t reusable_peak
;
380 mach_vm_size_t purgeable_volatile_pmap
;
381 mach_vm_size_t purgeable_volatile_resident
;
382 mach_vm_size_t purgeable_volatile_virtual
;
383 mach_vm_size_t compressed
;
384 mach_vm_size_t compressed_peak
;
385 mach_vm_size_t compressed_lifetime
;
388 mach_vm_size_t phys_footprint
;
391 mach_vm_address_t min_address
;
392 mach_vm_address_t max_address
;
394 typedef struct task_vm_info task_vm_info_data_t
;
395 typedef struct task_vm_info
*task_vm_info_t
;
396 #define TASK_VM_INFO_COUNT ((mach_msg_type_number_t) \
397 (sizeof (task_vm_info_data_t) / sizeof (natural_t)))
398 #define TASK_VM_INFO_REV2_COUNT TASK_VM_INFO_COUNT
399 #define TASK_VM_INFO_REV1_COUNT /* doesn't include min and max address */ \
400 ((mach_msg_type_number_t) (TASK_VM_INFO_REV2_COUNT - 4))
401 #define TASK_VM_INFO_REV0_COUNT /* doesn't include phys_footprint */ \
402 ((mach_msg_type_number_t) (TASK_VM_INFO_REV1_COUNT - 2))
404 typedef struct vm_purgeable_info task_purgable_info_t
;
407 #define TASK_TRACE_MEMORY_INFO 24
408 struct task_trace_memory_info
{
409 uint64_t user_memory_address
; /* address of start of trace memory buffer */
410 uint64_t buffer_size
; /* size of buffer in bytes */
411 uint64_t mailbox_array_size
; /* size of mailbox area in bytes */
413 typedef struct task_trace_memory_info task_trace_memory_info_data_t
;
414 typedef struct task_trace_memory_info
* task_trace_memory_info_t
;
415 #define TASK_TRACE_MEMORY_INFO_COUNT ((mach_msg_type_number_t) \
416 (sizeof(task_trace_memory_info_data_t) / sizeof(natural_t)))
418 #define TASK_WAIT_STATE_INFO 25 /* deprecated. */
419 struct task_wait_state_info
{
420 uint64_t total_wait_state_time
; /* Time that all threads past and present have been in a wait state */
421 uint64_t total_wait_sfi_state_time
; /* Time that threads have been in SFI wait (should be a subset of total wait state time */
422 uint32_t _reserved
[4];
424 typedef struct task_wait_state_info task_wait_state_info_data_t
;
425 typedef struct task_wait_state_info
* task_wait_state_info_t
;
426 #define TASK_WAIT_STATE_INFO_COUNT ((mach_msg_type_number_t) \
427 (sizeof(task_wait_state_info_data_t) / sizeof(natural_t)))
429 #define TASK_POWER_INFO_V2 26
432 uint64_t task_gpu_utilisation
;
433 uint64_t task_gpu_stat_reserved0
;
434 uint64_t task_gpu_stat_reserved1
;
435 uint64_t task_gpu_stat_reserved2
;
438 typedef gpu_energy_data
*gpu_energy_data_t
;
439 struct task_power_info_v2
{
440 task_power_info_data_t cpu_energy
;
441 gpu_energy_data gpu_energy
;
442 #if defined(__arm__) || defined(__arm64__)
443 uint64_t task_energy
;
446 uint64_t task_pset_switches
;
449 typedef struct task_power_info_v2 task_power_info_v2_data_t
;
450 typedef struct task_power_info_v2
*task_power_info_v2_t
;
451 #define TASK_POWER_INFO_V2_COUNT_OLD \
452 ((mach_msg_type_number_t) (sizeof (task_power_info_v2_data_t) - sizeof(uint64_t)*2) / sizeof (natural_t))
453 #define TASK_POWER_INFO_V2_COUNT \
454 ((mach_msg_type_number_t) (sizeof (task_power_info_v2_data_t) / sizeof (natural_t)))
456 #define TASK_VM_INFO_PURGEABLE_ACCOUNT 27 /* Used for xnu purgeable vm unit tests */
459 struct pvm_account_info
{
460 uint64_t pvm_volatile_count
; /* Number of volatile bytes associated with a task */
461 uint64_t pvm_volatile_compressed_count
; /* Number of volatile compressed bytes associated with a task */
462 uint64_t pvm_nonvolatile_count
; /* Number of nonvolatile bytes associated with a task */
463 uint64_t pvm_nonvolatile_compressed_count
; /* Number of nonvolatile compressed bytes associated with a task */
466 typedef struct pvm_account_info
*pvm_account_info_t
;
467 typedef struct pvm_account_info pvm_account_info_data_t
;
469 #define PVM_ACCOUNT_INFO_COUNT ((mach_msg_type_number_t) \
470 (sizeof (pvm_account_info_data_t) / sizeof (natural_t)))
473 #define TASK_FLAGS_INFO 28 /* return t_flags field */
474 struct task_flags_info
{
475 uint32_t flags
; /* task flags */
477 typedef struct task_flags_info task_flags_info_data_t
;
478 typedef struct task_flags_info
* task_flags_info_t
;
479 #define TASK_FLAGS_INFO_COUNT ((mach_msg_type_number_t) \
480 (sizeof(task_flags_info_data_t) / sizeof (natural_t)))
482 #define TF_LP64 0x00000001 /* task has 64-bit addressing */
484 #define TASK_DEBUG_INFO_INTERNAL 29 /* Used for kernel internal development tests. */
487 struct task_debug_info_internal
{
488 integer_t suspend_count
;
489 uint64_t ipc_space_size
;
491 typedef struct task_debug_info_internal
*task_debug_info_internal_t
;
492 typedef struct task_debug_info_internal task_debug_info_internal_data_t
;
493 #define TASK_DEBUG_INFO_INTERNAL_COUNT ((mach_msg_type_number_t) \
494 (sizeof (task_debug_info_internal_data_t) / sizeof(natural_t)))
499 * Obsolete interfaces.
502 #define TASK_SCHED_TIMESHARE_INFO 10
503 #define TASK_SCHED_RR_INFO 11
504 #define TASK_SCHED_FIFO_INFO 12
506 #define TASK_SCHED_INFO 14
510 #endif /* _MACH_TASK_INFO_H_ */