]> git.saurik.com Git - apple/xnu.git/blobdiff - osfmk/mach/task_info.h
xnu-2050.48.11.tar.gz
[apple/xnu.git] / osfmk / mach / task_info.h
index df7da10a39f9ab1f4ed51157184cfd0eeb17ae53..8a24624c011d5a33edcf79302214e70199ebebe3 100644 (file)
@@ -1,16 +1,19 @@
 /*
- * Copyright (c) 2000-2003 Apple Computer, Inc. All rights reserved.
+ * Copyright (c) 2000-2007 Apple Inc. All rights reserved.
  *
- * @APPLE_LICENSE_HEADER_START@
- * 
- * Copyright (c) 1999-2003 Apple Computer, Inc.  All Rights Reserved.
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
  * 
  * This file contains Original Code and/or Modifications of Original Code
  * as defined in and that are subject to the Apple Public Source License
  * Version 2.0 (the 'License'). You may not use this file except in
- * compliance with the License. Please obtain a copy of the License at
- * http://www.opensource.apple.com/apsl/ and read it before using this
- * file.
+ * compliance with the License. The rights granted to you under the License
+ * may not be used to create, or enable the creation or redistribution of,
+ * unlawful or unlicensed copies of an Apple operating system, or to
+ * circumvent, violate, or enable the circumvention or violation of, any
+ * terms of an Apple operating system software license agreement.
+ * 
+ * Please obtain a copy of the License at
+ * http://www.opensource.apple.com/apsl/ and read it before using this file.
  * 
  * The Original Code and all software distributed under the License are
  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
@@ -20,7 +23,7 @@
  * Please see the License for the specific language governing rights and
  * limitations under the License.
  * 
- * @APPLE_LICENSE_HEADER_END@
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  */
 /*
  * @OSF_COPYRIGHT@
@@ -50,8 +53,6 @@
  * any improvements or extensions that they make and grant Carnegie Mellon
  * the rights to redistribute these changes.
  */
-/*
- */
 /*
  *     Machine-independent task information structures and definitions.
  *
  *
  */
 
-#ifndef        TASK_INFO_H_
-#define        TASK_INFO_H_
+#ifndef        _MACH_TASK_INFO_H_
+#define        _MACH_TASK_INFO_H_
 
+#include <mach/message.h>
 #include <mach/machine/vm_types.h>
 #include <mach/time_value.h>
 #include <mach/policy.h>
+#include <mach/vm_statistics.h> /* for vm_extmod_statistics_data_t */
+#include <Availability.h>
 
-#include <sys/appleapiopts.h>
+#include <sys/cdefs.h>
 
 /*
  *     Generic information structure to allow for expansion.
@@ -76,6 +80,7 @@
 typedef        natural_t       task_flavor_t;
 typedef        integer_t       *task_info_t;           /* varying array of int */
 
+/* Deprecated, use per structure _data_t's instead */
 #define        TASK_INFO_MAX   (1024)          /* maximum array size */
 typedef        integer_t       task_info_data_t[TASK_INFO_MAX];
 
@@ -83,12 +88,52 @@ typedef     integer_t       task_info_data_t[TASK_INFO_MAX];
  *     Currently defined information structures.
  */
 
-#define TASK_BASIC_INFO         4       /* basic information */
+#pragma pack(4)
 
+/* Don't use this, use MACH_TASK_BASIC_INFO instead */
+#define TASK_BASIC_INFO_32      4       /* basic information */
+#define TASK_BASIC2_INFO_32      6
+
+struct task_basic_info_32 {
+        integer_t       suspend_count;  /* suspend count for task */
+        natural_t       virtual_size;   /* virtual memory size (bytes) */
+        natural_t       resident_size;  /* resident memory size (bytes) */
+        time_value_t    user_time;      /* total user run time for
+                                           terminated threads */
+        time_value_t    system_time;    /* total system run time for
+                                           terminated threads */
+       policy_t        policy;         /* default policy for new threads */
+};
+typedef struct task_basic_info_32       task_basic_info_32_data_t;
+typedef struct task_basic_info_32       *task_basic_info_32_t;
+#define TASK_BASIC_INFO_32_COUNT   \
+                (sizeof(task_basic_info_32_data_t) / sizeof(natural_t))
+
+/* Don't use this, use MACH_TASK_BASIC_INFO instead */
+struct task_basic_info_64 {
+        integer_t       suspend_count;  /* suspend count for task */
+        mach_vm_size_t  virtual_size;   /* virtual memory size (bytes) */
+        mach_vm_size_t  resident_size;  /* resident memory size (bytes) */
+        time_value_t    user_time;      /* total user run time for
+                                           terminated threads */
+        time_value_t    system_time;    /* total system run time for
+                                           terminated threads */
+       policy_t        policy;         /* default policy for new threads */
+};
+typedef struct task_basic_info_64       task_basic_info_64_data_t;
+typedef struct task_basic_info_64       *task_basic_info_64_t;
+
+#define TASK_BASIC_INFO_64      5       /* 64-bit capable basic info */
+#define TASK_BASIC_INFO_64_COUNT   \
+                (sizeof(task_basic_info_64_data_t) / sizeof(natural_t))
+
+
+/* localized structure - cannot be safely passed between tasks of differing sizes */
+/* Don't use this, use MACH_TASK_BASIC_INFO instead */
 struct task_basic_info {
         integer_t       suspend_count;  /* suspend count for task */
-        vm_size_t       virtual_size;   /* number of virtual pages */
-        vm_size_t       resident_size;  /* number of resident pages */
+        vm_size_t       virtual_size;   /* virtual memory size (bytes) */
+        vm_size_t       resident_size;  /* resident memory size (bytes) */
         time_value_t    user_time;      /* total user run time for
                                            terminated threads */
         time_value_t    system_time;    /* total system run time for
@@ -100,6 +145,12 @@ typedef struct task_basic_info          task_basic_info_data_t;
 typedef struct task_basic_info          *task_basic_info_t;
 #define TASK_BASIC_INFO_COUNT   \
                 (sizeof(task_basic_info_data_t) / sizeof(natural_t))
+#if !defined(__LP64__)
+#define TASK_BASIC_INFO TASK_BASIC_INFO_32
+#else
+#define TASK_BASIC_INFO TASK_BASIC_INFO_64
+#endif
+
 
 
 #define        TASK_EVENTS_INFO        2       /* various event counts */
@@ -116,8 +167,8 @@ struct task_events_info {
 };
 typedef struct task_events_info                task_events_info_data_t;
 typedef struct task_events_info                *task_events_info_t;
-#define        TASK_EVENTS_INFO_COUNT  \
-               (sizeof(task_events_info_data_t) / sizeof(natural_t))
+#define        TASK_EVENTS_INFO_COUNT          ((mach_msg_type_number_t) \
+               (sizeof(task_events_info_data_t) / sizeof(natural_t)))
 
 #define        TASK_THREAD_TIMES_INFO  3       /* total times for live threads -
                                           only accurate if suspended */
@@ -131,25 +182,128 @@ struct task_thread_times_info {
 
 typedef struct task_thread_times_info  task_thread_times_info_data_t;
 typedef struct task_thread_times_info  *task_thread_times_info_t;
-#define        TASK_THREAD_TIMES_INFO_COUNT    \
-               (sizeof(task_thread_times_info_data_t) / sizeof(natural_t))
+#define        TASK_THREAD_TIMES_INFO_COUNT    ((mach_msg_type_number_t) \
+               (sizeof(task_thread_times_info_data_t) / sizeof(natural_t)))
 
-#ifdef __APPLE_API_UNSTABLE
+#define TASK_ABSOLUTETIME_INFO 1
 
-#define TASK_SCHED_TIMESHARE_INFO      10
-#define TASK_SCHED_RR_INFO             11
-#define TASK_SCHED_FIFO_INFO           12
+struct task_absolutetime_info {
+       uint64_t                total_user;
+       uint64_t                total_system;
+       uint64_t                threads_user;   /* existing threads only */
+       uint64_t                threads_system;
+};
 
-#define TASK_SCHED_INFO                        14
+typedef struct task_absolutetime_info  task_absolutetime_info_data_t;
+typedef struct task_absolutetime_info  *task_absolutetime_info_t;
+#define TASK_ABSOLUTETIME_INFO_COUNT   ((mach_msg_type_number_t) \
+               (sizeof (task_absolutetime_info_data_t) / sizeof (natural_t)))
 
-#endif /* __APPLE_API_UNSTABLE */
+#define TASK_KERNELMEMORY_INFO 7
+
+struct task_kernelmemory_info {
+       uint64_t                total_palloc;   /* private kernel mem alloc'ed */
+       uint64_t                total_pfree;    /* private kernel mem freed */
+       uint64_t                total_salloc;   /* shared kernel mem alloc'ed */
+       uint64_t                total_sfree;    /* shared kernel mem freed */
+};
+
+typedef struct task_kernelmemory_info  task_kernelmemory_info_data_t;
+typedef struct task_kernelmemory_info  *task_kernelmemory_info_t;
+#define TASK_KERNELMEMORY_INFO_COUNT   ((mach_msg_type_number_t) \
+               (sizeof (task_kernelmemory_info_data_t) / sizeof (natural_t)))
 
 #define TASK_SECURITY_TOKEN            13
-#define TASK_SECURITY_TOKEN_COUNT      \
-               (sizeof(security_token_t) / sizeof(natural_t))
+#define TASK_SECURITY_TOKEN_COUNT      ((mach_msg_type_number_t) \
+               (sizeof(security_token_t) / sizeof(natural_t)))
 
 #define TASK_AUDIT_TOKEN               15
 #define TASK_AUDIT_TOKEN_COUNT \
                (sizeof(audit_token_t) / sizeof(natural_t))
 
-#endif /* TASK_INFO_H_ */
+
+#define TASK_AFFINITY_TAG_INFO         16      /* This is experimental. */
+
+struct task_affinity_tag_info {
+       integer_t               set_count;
+       integer_t               min;
+       integer_t               max;
+       integer_t               task_count;
+};
+typedef struct task_affinity_tag_info  task_affinity_tag_info_data_t;
+typedef struct task_affinity_tag_info  *task_affinity_tag_info_t;
+#define TASK_AFFINITY_TAG_INFO_COUNT   \
+               (sizeof(task_affinity_tag_info_data_t) / sizeof(natural_t))
+
+#define TASK_DYLD_INFO                 17
+
+struct task_dyld_info {
+       mach_vm_address_t       all_image_info_addr;
+       mach_vm_size_t          all_image_info_size;
+       integer_t               all_image_info_format;          
+};
+typedef struct task_dyld_info  task_dyld_info_data_t;
+typedef struct task_dyld_info  *task_dyld_info_t;
+#define TASK_DYLD_INFO_COUNT   \
+               (sizeof(task_dyld_info_data_t) / sizeof(natural_t))
+#define TASK_DYLD_ALL_IMAGE_INFO_32    0       /* format value */
+#define TASK_DYLD_ALL_IMAGE_INFO_64    1       /* format value */
+
+
+#define TASK_EXTMOD_INFO                       19
+
+struct task_extmod_info {
+       unsigned char   task_uuid[16];
+       vm_extmod_statistics_data_t             extmod_statistics;
+};
+typedef struct task_extmod_info        task_extmod_info_data_t;
+typedef struct task_extmod_info        *task_extmod_info_t;
+#define TASK_EXTMOD_INFO_COUNT \
+               (sizeof(task_extmod_info_data_t) / sizeof(natural_t))
+
+/* Always 64-bit in user and kernel */
+#define MACH_TASK_BASIC_INFO     20         /* always 64-bit basic info */
+
+#define TASK_POWER_INFO        21
+struct task_power_info {
+        uint64_t                total_user;
+        uint64_t                total_system;
+        uint64_t                task_interrupt_wakeups;
+        uint64_t                task_platform_idle_wakeups;
+        uint64_t                task_timer_wakeups_bin_1;
+        uint64_t                task_timer_wakeups_bin_2;
+};
+typedef struct task_power_info        task_power_info_data_t;
+typedef struct task_power_info        *task_power_info_t;
+#define TASK_POWER_INFO_COUNT        ((mach_msg_type_number_t) \
+                (sizeof (task_power_info_data_t) / sizeof (natural_t)))
+
+struct mach_task_basic_info {
+        mach_vm_size_t  virtual_size;       /* virtual memory size (bytes) */
+        mach_vm_size_t  resident_size;      /* resident memory size (bytes) */
+        mach_vm_size_t  resident_size_max;  /* maximum resident memory size (bytes) */
+        time_value_t    user_time;          /* total user run time for
+                                               terminated threads */
+        time_value_t    system_time;        /* total system run time for
+                                               terminated threads */
+        policy_t        policy;             /* default policy for new threads */
+        integer_t       suspend_count;      /* suspend count for task */
+};
+typedef struct mach_task_basic_info       mach_task_basic_info_data_t;
+typedef struct mach_task_basic_info       *mach_task_basic_info_t;
+#define MACH_TASK_BASIC_INFO_COUNT   \
+                (sizeof(mach_task_basic_info_data_t) / sizeof(natural_t))
+
+/*
+ * Obsolete interfaces.
+ */
+
+#define TASK_SCHED_TIMESHARE_INFO      10
+#define TASK_SCHED_RR_INFO             11
+#define TASK_SCHED_FIFO_INFO           12
+
+#define TASK_SCHED_INFO                        14
+
+#pragma pack()
+
+#endif /* _MACH_TASK_INFO_H_ */