]> git.saurik.com Git - apple/xnu.git/blobdiff - osfmk/kern/kern_types.h
xnu-4903.270.47.tar.gz
[apple/xnu.git] / osfmk / kern / kern_types.h
index 8308df68d90a51fa86e3e1e90beb4ea9407e2779..556f67273695b7a51efc084f2ad88237a06d7dfd 100644 (file)
@@ -2,7 +2,7 @@
  * Copyright (c) 2000-2007 Apple 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
  * 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
  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  * Please see the License for the specific language governing rights and
  * limitations under the License.
- * 
+ *
  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  */
 /*
  * @OSF_COPYRIGHT@
  */
 
-#ifndef        _KERN_KERN_TYPES_H_
-#define        _KERN_KERN_TYPES_H_
+#ifndef _KERN_KERN_TYPES_H_
+#define _KERN_KERN_TYPES_H_
 
 #include <stdint.h>
 #include <mach/mach_types.h>
 #include <mach/machine/vm_types.h>
 
-#ifdef KERNEL_PRIVATE
+#ifdef  KERNEL_PRIVATE
 
-#ifndef        MACH_KERNEL_PRIVATE
+#ifndef MACH_KERNEL_PRIVATE
 
-struct zone ;
+struct zone;
 
 #ifndef __LP64__
-struct wait_queue { unsigned int opaque[2]; uintptr_t opaquep[2]; } ;
+struct wait_queue { unsigned int opaque[2]; uintptr_t opaquep[2]; };
 #else
 struct wait_queue { unsigned char opaque[32]; };
 #endif
 
-#endif /* MACH_KERNEL_PRIVATE */
+#endif  /* MACH_KERNEL_PRIVATE */
 
-typedef struct zone                    *zone_t;
-#define                ZONE_NULL                       ((zone_t) 0)
+typedef struct zone                     *zone_t;
+#define         ZONE_NULL                       ((zone_t) 0)
 
-typedef struct wait_queue              *wait_queue_t;
-#define                WAIT_QUEUE_NULL         ((wait_queue_t) 0)
-#define                SIZEOF_WAITQUEUE        sizeof(struct wait_queue)
+typedef struct wait_queue               *wait_queue_t;
+#define         WAIT_QUEUE_NULL         ((wait_queue_t) 0)
+#define                 SIZEOF_WAITQUEUE        sizeof(struct wait_queue)
 
-typedef vm_offset_t                    ipc_kobject_t;
-#define                IKO_NULL                        ((ipc_kobject_t) 0)
+typedef vm_offset_t                     ipc_kobject_t;
+#define         IKO_NULL                        ((ipc_kobject_t) 0)
 
-#endif /* KERNEL_PRIVATE */
+#endif  /* KERNEL_PRIVATE */
 
-typedef        void *event_t;          /* wait event */
-#define                NO_EVENT                        ((event_t) 0)
+typedef void *event_t;          /* wait event */
+#define         NO_EVENT                        ((event_t) 0)
 
-typedef uint64_t event64_t;            /* 64 bit wait event */
-#define                NO_EVENT64              ((event64_t) 0)
-#define                CAST_EVENT64_T(a_ptr)   ((event64_t)((uintptr_t)(a_ptr)))
+typedef uint64_t event64_t;             /* 64 bit wait event */
+#define         NO_EVENT64              ((event64_t) 0)
+#define         CAST_EVENT64_T(a_ptr)   ((event64_t)((uintptr_t)(a_ptr)))
 
 /*
  *     Possible wait_result_t values.
  */
 typedef int wait_result_t;
-#define THREAD_WAITING         -1              /* thread is waiting */
-#define THREAD_AWAKENED                0               /* normal wakeup */
-#define THREAD_TIMED_OUT       1               /* timeout expired */
-#define THREAD_INTERRUPTED     2               /* aborted/interrupted */
-#define THREAD_RESTART         3               /* restart operation entirely */
+#define THREAD_WAITING          -1              /* thread is waiting */
+#define THREAD_AWAKENED         0               /* normal wakeup */
+#define THREAD_TIMED_OUT        1               /* timeout expired */
+#define THREAD_INTERRUPTED      2               /* aborted/interrupted */
+#define THREAD_RESTART          3               /* restart operation entirely */
 #define THREAD_NOT_WAITING      10              /* thread didn't need to wait */
 
-typedef        void (*thread_continue_t)(void *, wait_result_t);
-#define        THREAD_CONTINUE_NULL    ((thread_continue_t) 0)
+typedef void (*thread_continue_t)(void *, wait_result_t);
+#define THREAD_CONTINUE_NULL    ((thread_continue_t) 0)
 
 /*
  * Interruptible flag for waits.
@@ -173,52 +173,52 @@ typedef int wait_interrupt_t;
 #define THREAD_WAIT_NOREPORT            (THREAD_WAIT_NOREPORT_KERNEL | THREAD_WAIT_NOREPORT_USER)
 
 typedef int wait_timeout_urgency_t;
-#define TIMEOUT_URGENCY_SYS_NORMAL     0x00            /* use default leeway thresholds for system */
-#define TIMEOUT_URGENCY_SYS_CRITICAL   0x01            /* use critical leeway thresholds for system */
-#define TIMEOUT_URGENCY_SYS_BACKGROUND 0x02            /* use background leeway thresholds for system */
+#define TIMEOUT_URGENCY_SYS_NORMAL      0x00            /* use default leeway thresholds for system */
+#define TIMEOUT_URGENCY_SYS_CRITICAL    0x01            /* use critical leeway thresholds for system */
+#define TIMEOUT_URGENCY_SYS_BACKGROUND  0x02            /* use background leeway thresholds for system */
 
-#define TIMEOUT_URGENCY_USER_MASK      0x10            /* mask to identify user timeout urgency classes */
-#define TIMEOUT_URGENCY_USER_NORMAL    0x10            /* use default leeway thresholds for user */
-#define TIMEOUT_URGENCY_USER_CRITICAL  0x11            /* use critical leeway thresholds for user */
-#define TIMEOUT_URGENCY_USER_BACKGROUND        0x12            /* use background leeway thresholds for user */
+#define TIMEOUT_URGENCY_USER_MASK       0x10            /* mask to identify user timeout urgency classes */
+#define TIMEOUT_URGENCY_USER_NORMAL     0x10            /* use default leeway thresholds for user */
+#define TIMEOUT_URGENCY_USER_CRITICAL   0x11            /* use critical leeway thresholds for user */
+#define TIMEOUT_URGENCY_USER_BACKGROUND 0x12            /* use background leeway thresholds for user */
 
-#define TIMEOUT_URGENCY_MASK           0x13            /* mask to identify timeout urgency */
+#define TIMEOUT_URGENCY_MASK            0x13            /* mask to identify timeout urgency */
 
-#define TIMEOUT_URGENCY_LEEWAY         0x20            /* don't ignore provided leeway value */
+#define TIMEOUT_URGENCY_LEEWAY          0x20            /* don't ignore provided leeway value */
 
-#define TIMEOUT_URGENCY_FIRST_AVAIL    0x40            /* first available bit outside of urgency mask/leeway */
-#define        TIMEOUT_URGENCY_RATELIMITED     0x80
+#define TIMEOUT_URGENCY_FIRST_AVAIL     0x40            /* first available bit outside of urgency mask/leeway */
+#define TIMEOUT_URGENCY_RATELIMITED     0x80
 
 /*
  * Timeout and deadline tokens for waits.
  * The following tokens define common values for leeway and deadline parameters.
  */
-#define TIMEOUT_NO_LEEWAY              (0ULL)
-#define TIMEOUT_WAIT_FOREVER           (0ULL)
+#define TIMEOUT_NO_LEEWAY               (0ULL)
+#define TIMEOUT_WAIT_FOREVER            (0ULL)
 
-#ifdef KERNEL_PRIVATE
+#ifdef  KERNEL_PRIVATE
 
 /*
  * n.b. this is defined in thread_call.h, but in the TIMEOUT_URGENCY flags space:
  * #define THREAD_CALL_CONTINUOUS      0x100
  */
 
-#ifdef MACH_KERNEL_PRIVATE
+#ifdef  MACH_KERNEL_PRIVATE
 
 #include <kern/misc_protos.h>
-typedef  struct clock                  *clock_t;
+typedef  struct clock                   *clock_t;
 
-typedef struct mig_object              *mig_object_t;
-#define MIG_OBJECT_NULL                        ((mig_object_t) 0)
+typedef struct mig_object               *mig_object_t;
+#define MIG_OBJECT_NULL                 ((mig_object_t) 0)
 
-typedef struct mig_notify              *mig_notify_t;
-#define MIG_NOTIFY_NULL                ((mig_notify_t) 0)
+typedef struct mig_notify               *mig_notify_t;
+#define MIG_NOTIFY_NULL                 ((mig_notify_t) 0)
 
-typedef struct pset_node               *pset_node_t;
-#define PSET_NODE_NULL                 ((pset_node_t) 0)
+typedef struct pset_node                *pset_node_t;
+#define PSET_NODE_NULL                  ((pset_node_t) 0)
 
-typedef struct affinity_set            *affinity_set_t;
-#define AFFINITY_SET_NULL              ((affinity_set_t) 0)
+typedef struct affinity_set             *affinity_set_t;
+#define AFFINITY_SET_NULL               ((affinity_set_t) 0)
 
 typedef struct run_queue               *run_queue_t;
 #define RUN_QUEUE_NULL                 ((run_queue_t) 0)
@@ -226,61 +226,61 @@ typedef struct run_queue               *run_queue_t;
 typedef struct grrr_run_queue               *grrr_run_queue_t;
 #define GRRR_RUN_QUEUE_NULL                 ((grrr_run_queue_t) 0)
 
-typedef struct grrr_group                                      *grrr_group_t;
-#define GRRR_GROUP_NULL                                                ((grrr_group_t) 0)
+typedef struct grrr_group                                       *grrr_group_t;
+#define GRRR_GROUP_NULL                                         ((grrr_group_t) 0)
 
 #if defined(CONFIG_SCHED_MULTIQ)
 typedef struct sched_group              *sched_group_t;
 #define SCHED_GROUP_NULL                ((sched_group_t) 0)
 #endif /* defined(CONFIG_SCHED_MULTIQ) */
 
-#else  /* MACH_KERNEL_PRIVATE */
+#else   /* MACH_KERNEL_PRIVATE */
 
-struct wait_queue_set ;
-struct _wait_queue_link ;
+struct wait_queue_set;
+struct _wait_queue_link;
 
-#endif /* MACH_KERNEL_PRIVATE */
+#endif  /* MACH_KERNEL_PRIVATE */
 
-typedef struct wait_queue_set  *wait_queue_set_t;
-#define WAIT_QUEUE_SET_NULL    ((wait_queue_set_t)0)
-#define SIZEOF_WAITQUEUE_SET   wait_queue_set_size()
+typedef struct wait_queue_set   *wait_queue_set_t;
+#define WAIT_QUEUE_SET_NULL     ((wait_queue_set_t)0)
+#define SIZEOF_WAITQUEUE_SET    wait_queue_set_size()
 
-typedef struct _wait_queue_link        *wait_queue_link_t;
-#define WAIT_QUEUE_LINK_NULL   ((wait_queue_link_t)0)
-#define SIZEOF_WAITQUEUE_LINK  wait_queue_link_size()
+typedef struct _wait_queue_link *wait_queue_link_t;
+#define WAIT_QUEUE_LINK_NULL    ((wait_queue_link_t)0)
+#define SIZEOF_WAITQUEUE_LINK   wait_queue_link_size()
 
-typedef struct perfcontrol_state       *perfcontrol_state_t;
-#define PERFCONTROL_STATE_NULL         ((perfcontrol_state_t)0)
+typedef struct perfcontrol_state        *perfcontrol_state_t;
+#define PERFCONTROL_STATE_NULL          ((perfcontrol_state_t)0)
 
 /*
  * Enum to define the event which caused the CLPC callout
  */
 typedef enum perfcontrol_event {
-    /*
-     * Thread State Update Events
-     * Used to indicate events that update properties for 
-     * a given thread. These events are passed as part of the 
-     * sched_perfcontrol_state_update_t callout
-     */
-    QUANTUM_EXPIRY          = 1,
-    THREAD_GROUP_UPDATE     = 2,
-    PERFCONTROL_ATTR_UPDATE = 3,
-    /*
-     * Context Switch Events
-     * Used to indicate events that switch from one thread
-     * to the other. These events are passed as part of the 
-     * sched_perfcontrol_csw_t callout.
-     */
-    CONTEXT_SWITCH          = 10,
-    IDLE                    = 11
+       /*
+        * Thread State Update Events
+        * Used to indicate events that update properties for
+        * a given thread. These events are passed as part of the
+        * sched_perfcontrol_state_update_t callout
+        */
+       QUANTUM_EXPIRY          = 1,
+       THREAD_GROUP_UPDATE     = 2,
+       PERFCONTROL_ATTR_UPDATE = 3,
+       /*
+        * Context Switch Events
+        * Used to indicate events that switch from one thread
+        * to the other. These events are passed as part of the
+        * sched_perfcontrol_csw_t callout.
+        */
+       CONTEXT_SWITCH          = 10,
+       IDLE                    = 11
 } perfcontrol_event;
 
-/* 
+/*
  * Flags for the sched_perfcontrol_csw_t & sched_perfcontrol_state_update_t
  * callouts.
  * Currently defined flags are:
- * PERFCONTROL_CALLOUT_WAKE_UNSAFE - Flag to indicate its unsafe to 
- *      do a wakeup as part of this callout. If this is set, it 
+ * PERFCONTROL_CALLOUT_WAKE_UNSAFE - Flag to indicate its unsafe to
+ *      do a wakeup as part of this callout. If this is set, it
  *      indicates that the scheduler holds a spinlock which might be needed
  *      in the wakeup path. In that case CLPC should do a thread_call
  *      instead of a direct wakeup to run their workloop thread.
@@ -289,29 +289,29 @@ typedef enum perfcontrol_event {
 
 /*
  * Enum to define the perfcontrol class for thread.
- * thread_get_perfcontrol_class() takes the thread's 
- * priority, QoS, urgency etc. into consideration and 
+ * thread_get_perfcontrol_class() takes the thread's
+ * priority, QoS, urgency etc. into consideration and
  * produces a value in this enum.
  */
 typedef enum perfcontrol_class {
-    /* Idle thread */
-    PERFCONTROL_CLASS_IDLE           = 1,
-    /* Kernel thread */
-    PERFCONTROL_CLASS_KERNEL         = 2,
-    /* Realtime Thread */
-    PERFCONTROL_CLASS_REALTIME       = 3,
-    /* Background Thread */
-    PERFCONTROL_CLASS_BACKGROUND     = 4,
-    /* Utility Thread */
-    PERFCONTROL_CLASS_UTILITY        = 5,
-    /* Non-UI Thread (Default/Legacy) */
-    PERFCONTROL_CLASS_NONUI          = 6,
-    /* UI Thread (UI/IN) */
-    PERFCONTROL_CLASS_UI             = 7,
-    /* Above UI Thread */
-    PERFCONTROL_CLASS_ABOVEUI        = 8,
+       /* Idle thread */
+       PERFCONTROL_CLASS_IDLE           = 1,
+       /* Kernel thread */
+       PERFCONTROL_CLASS_KERNEL         = 2,
+       /* Realtime Thread */
+       PERFCONTROL_CLASS_REALTIME       = 3,
+       /* Background Thread */
+       PERFCONTROL_CLASS_BACKGROUND     = 4,
+       /* Utility Thread */
+       PERFCONTROL_CLASS_UTILITY        = 5,
+       /* Non-UI Thread (Default/Legacy) */
+       PERFCONTROL_CLASS_NONUI          = 6,
+       /* UI Thread (UI/IN) */
+       PERFCONTROL_CLASS_UI             = 7,
+       /* Above UI Thread */
+       PERFCONTROL_CLASS_ABOVEUI        = 8,
 } perfcontrol_class_t;
 
-#endif /* KERNEL_PRIVATE */
+#endif  /* KERNEL_PRIVATE */
 
-#endif /* _KERN_KERN_TYPES_H_ */
+#endif  /* _KERN_KERN_TYPES_H_ */