xnu-4570.20.62.tar.gz

[apple/xnu.git] / osfmk / kern / processor.h

diff --git a/osfmk/kern/processor.h b/osfmk/kern/processor.h
index fcf61d0444612d7e04fa4dbfc64d74bbd1c461f5..09caf6a7fbe0b3c1a980656720073ef39803dd82 100644 (file)
--- a/osfmk/kern/processor.h
+++ b/osfmk/kern/processor.h
@@ -74,28 +74,72 @@
 #include <mach/mach_types.h>
 #include <kern/ast.h>
 #include <kern/cpu_number.h>
 #include <mach/mach_types.h>
 #include <kern/ast.h>
 #include <kern/cpu_number.h>

-#include <kern/lock.h>
+#include <kern/smp.h>
+#include <kern/simple_lock.h>
+#include <kern/locks.h>

 #include <kern/queue.h>
 #include <kern/sched.h>
 #include <kern/queue.h>
 #include <kern/sched.h>

+#include <mach/sfi_class.h>

 #include <kern/processor_data.h>
 
 #include <kern/processor_data.h>
 

-#include <machine/ast_types.h>
+typedef enum {
+       PSET_SMP,
+} pset_cluster_type_t;

 
 struct processor_set {
        queue_head_t            active_queue;   /* active processors */
        queue_head_t            idle_queue;             /* idle processors */
 
 struct processor_set {
        queue_head_t            active_queue;   /* active processors */
        queue_head_t            idle_queue;             /* idle processors */

+       queue_head_t            idle_secondary_queue;   /* idle secondary processors */
+       queue_head_t            unused_queue;           /* processors not recommended by CLPC */

 
 

-       processor_t                     low_pri, low_count;
+       int                                     online_processor_count;
+       int                                     active_processor_count;
+       int                                     load_average;

 
 

-       int                                     processor_count;
+       int                                     cpu_set_low, cpu_set_hi;
+       int                                     cpu_set_count;
+       uint64_t                                cpu_bitmask;
+       uint64_t                                recommended_bitmask;

 
 

+#if __SMP__

        decl_simple_lock_data(,sched_lock)      /* lock for above */
        decl_simple_lock_data(,sched_lock)      /* lock for above */

+#endif
+
+#if defined(CONFIG_SCHED_TRADITIONAL) || defined(CONFIG_SCHED_MULTIQ)
+       struct run_queue        pset_runq;      /* runq for this processor set */
+#endif
+       struct rt_queue         rt_runq;        /* realtime runq for this processor set */
+
+#if defined(CONFIG_SCHED_TRADITIONAL)
+       int                                     pset_runq_bound_count;
+               /* # of threads in runq bound to any processor in pset */
+#endif
+
+       /* CPUs that have been sent an unacknowledged remote AST for scheduling purposes */
+       uint64_t                        pending_AST_cpu_mask;
+#if defined(CONFIG_SCHED_DEFERRED_AST)
+       /*
+        * A separate mask, for ASTs that we may be able to cancel.  This is dependent on
+        * some level of support for requesting an AST on a processor, and then quashing
+        * that request later.
+        *
+        * The purpose of this field (and the associated codepaths) is to infer when we
+        * no longer need a processor that is DISPATCHING to come up, and to prevent it
+        * from coming out of IDLE if possible.  This should serve to decrease the number
+        * of spurious ASTs in the system, and let processors spend longer periods in
+        * IDLE.
+        */
+       uint64_t                        pending_deferred_AST_cpu_mask;
+#endif
+       uint64_t                        pending_spill_cpu_mask;

 
        struct ipc_port *       pset_self;              /* port for operations */
        struct ipc_port *       pset_name_self; /* port for information */
 
        processor_set_t         pset_list;              /* chain of associated psets */
 
        struct ipc_port *       pset_self;              /* port for operations */
        struct ipc_port *       pset_name_self; /* port for information */
 
        processor_set_t         pset_list;              /* chain of associated psets */

-       pset_node_t                     node;
+       pset_node_t             node;
+       uint32_t                pset_cluster_id;
+       pset_cluster_type_t     pset_cluster_type;

 };
 
 extern struct processor_set    pset0;
 };
 
 extern struct processor_set    pset0;


@@ -111,22 +155,17 @@ struct pset_node {
 
 extern struct pset_node        pset_node0;
 
 
 extern struct pset_node        pset_node0;
 

-extern queue_head_t            tasks, threads;
-extern int                             tasks_count, threads_count;
+extern queue_head_t            tasks, terminated_tasks, threads, corpse_tasks; /* Terminated tasks are ONLY for stackshot */
+extern int                             tasks_count, terminated_tasks_count, threads_count;

 decl_lck_mtx_data(extern,tasks_threads_lock)
 decl_lck_mtx_data(extern,tasks_threads_lock)

-
-struct processor_meta {
-       queue_head_t            idle_queue;
-       processor_t                     primary;
-};
-
-typedef struct processor_meta  *processor_meta_t;
-#define PROCESSOR_META_NULL            ((processor_meta_t) 0)
+decl_lck_mtx_data(extern,tasks_corpse_lock)

 
 struct processor {
        queue_chain_t           processor_queue;/* idle/active queue link,
                                                                                 * MUST remain the first element */
        int                                     state;                  /* See below */
 
 struct processor {
        queue_chain_t           processor_queue;/* idle/active queue link,
                                                                                 * MUST remain the first element */
        int                                     state;                  /* See below */

+       boolean_t               is_SMT;
+       boolean_t               is_recommended;

        struct thread
                                                *active_thread, /* thread running on processor */
                                                *next_thread,   /* next thread when dispatched */
        struct thread
                                                *active_thread, /* thread running on processor */
                                                *next_thread,   /* next thread when dispatched */


@@ -134,19 +173,35 @@ struct processor {
 
        processor_set_t         processor_set;  /* assigned set */
 
 
        processor_set_t         processor_set;  /* assigned set */
 

-       int                                     current_pri;    /* priority of current thread */
-       int                                     cpu_id;                 /* platform numeric id */
+       int                     current_pri;    /* priority of current thread */
+       sfi_class_id_t          current_sfi_class;      /* SFI class of current thread */
+       perfcontrol_class_t     current_perfctl_class;  /* Perfcontrol class for current thread */
+       int                     starting_pri;       /* priority of current thread as it was when scheduled */
+       pset_cluster_type_t     current_recommended_pset_type;  /* Cluster type recommended for current thread */
+       int                     cpu_id;                 /* platform numeric id */

 
        timer_call_data_t       quantum_timer;  /* timer for quantum expiration */
        uint64_t                        quantum_end;    /* time when current quantum ends */
        uint64_t                        last_dispatch;  /* time of last dispatch */
 
        uint64_t                        deadline;               /* current deadline */
 
        timer_call_data_t       quantum_timer;  /* timer for quantum expiration */
        uint64_t                        quantum_end;    /* time when current quantum ends */
        uint64_t                        last_dispatch;  /* time of last dispatch */
 
        uint64_t                        deadline;               /* current deadline */

-       int                                     timeslice;              /* quanta before timeslice ends */
+       boolean_t               first_timeslice;                /* has the quantum expired since context switch */

 
 

+#if defined(CONFIG_SCHED_TRADITIONAL) || defined(CONFIG_SCHED_MULTIQ)

        struct run_queue        runq;                   /* runq for this processor */
        struct run_queue        runq;                   /* runq for this processor */

-       processor_meta_t        processor_meta;
-
+#endif
+
+#if defined(CONFIG_SCHED_TRADITIONAL)
+       int                                     runq_bound_count; /* # of threads bound to this processor */
+#endif
+#if defined(CONFIG_SCHED_GRRR)
+       struct grrr_run_queue   grrr_runq;      /* Group Ratio Round-Robin runq */
+#endif
+
+       processor_t                     processor_primary;      /* pointer to primary processor for
+                                                                                        * secondary SMT processors, or a pointer
+                                                                                        * to ourselves for primaries or non-SMT */
+       processor_t             processor_secondary;

        struct ipc_port *       processor_self; /* port for operations */
 
        processor_t                     processor_list; /* all existing processors */
        struct ipc_port *       processor_self; /* port for operations */
 
        processor_t                     processor_list; /* all existing processors */


@@ -154,68 +209,102 @@ struct processor {
 };
 
 extern processor_t             processor_list;
 };
 
 extern processor_t             processor_list;

-extern unsigned int            processor_count;

 decl_simple_lock_data(extern,processor_list_lock)
 
 decl_simple_lock_data(extern,processor_list_lock)
 

+#define MAX_SCHED_CPUS          64 /* Maximum number of CPUs supported by the scheduler.  bits.h:bitmap_*() macros need to be used to support greater than 64 */
+extern processor_t              processor_array[MAX_SCHED_CPUS]; /* array indexed by cpuid */
+

 extern uint32_t                        processor_avail_count;
 
 extern processor_t             master_processor;
 
 extern uint32_t                        processor_avail_count;
 
 extern processor_t             master_processor;
 

+extern boolean_t               sched_stats_active;
+

 /*
  *     Processor state is accessed by locking the scheduling lock
  *     for the assigned processor set.
 /*
  *     Processor state is accessed by locking the scheduling lock
  *     for the assigned processor set.

+ *
+ *           -------------------- SHUTDOWN
+ *          /                     ^     ^
+ *        _/                      |      \
+ *  OFF_LINE ---> START ---> RUNNING ---> IDLE ---> DISPATCHING
+ *         \_________________^   ^ ^______/           /
+ *                                \__________________/
+ *
+ *  Most of these state transitions are externally driven as a
+ *  a directive (for instance telling an IDLE processor to start
+ *  coming out of the idle state to run a thread). However these
+ *  are typically paired with a handshake by the processor itself
+ *  to indicate that it has completed a transition of indeterminate
+ *  length (for example, the DISPATCHING->RUNNING or START->RUNNING
+ *  transitions must occur on the processor itself).
+ *
+ *  The boot processor has some special cases, and skips the START state,
+ *  since it has already bootstrapped and is ready to context switch threads.
+ *
+ *  When a processor is in DISPATCHING or RUNNING state, the current_pri,
+ *  current_thmode, and deadline fields should be set, so that other
+ *  processors can evaluate if it is an appropriate candidate for preemption.
+ */
+#if defined(CONFIG_SCHED_DEFERRED_AST)
+/*
+ *           -------------------- SHUTDOWN
+ *          /                     ^     ^
+ *        _/                      |      \
+ *  OFF_LINE ---> START ---> RUNNING ---> IDLE ---> DISPATCHING
+ *         \_________________^   ^ ^______/ ^_____ /  /
+ *                                \__________________/
+ *
+ *  A DISPATCHING processor may be put back into IDLE, if another
+ *  processor determines that the target processor will have nothing to do
+ *  upon reaching the RUNNING state.  This is racy, but if the target
+ *  responds and becomes RUNNING, it will not break the processor state
+ *  machine.
+ *
+ *  This change allows us to cancel an outstanding signal/AST on a processor
+ *  (if such an operation is supported through hardware or software), and
+ *  push the processor back into the IDLE state as a power optimization.

  */
  */

+#endif
+

 #define PROCESSOR_OFF_LINE             0       /* Not available */
 #define PROCESSOR_SHUTDOWN             1       /* Going off-line */
 #define PROCESSOR_START                        2       /* Being started */
 #define PROCESSOR_OFF_LINE             0       /* Not available */
 #define PROCESSOR_SHUTDOWN             1       /* Going off-line */
 #define PROCESSOR_START                        2       /* Being started */

-#define PROCESSOR_INACTIVE             3       /* Inactive (unavailable) */
+/*                                             3          Formerly Inactive (unavailable) */

 #define        PROCESSOR_IDLE                  4       /* Idle (available) */
 #define PROCESSOR_DISPATCHING  5       /* Dispatching (idle -> active) */
 #define        PROCESSOR_RUNNING               6       /* Normal execution */
 
 extern processor_t     current_processor(void);
 
 #define        PROCESSOR_IDLE                  4       /* Idle (available) */
 #define PROCESSOR_DISPATCHING  5       /* Dispatching (idle -> active) */
 #define        PROCESSOR_RUNNING               6       /* Normal execution */
 
 extern processor_t     current_processor(void);
 

-extern processor_t     cpu_to_processor(
-                                               int                     cpu);
-
-/* Lock macros */
+/* Lock macros, always acquired and released with interrupts disabled (splsched()) */

 
 

+#if __SMP__

 #define pset_lock(p)                   simple_lock(&(p)->sched_lock)
 #define pset_unlock(p)                 simple_unlock(&(p)->sched_lock)
 #define pset_lock_init(p)              simple_lock_init(&(p)->sched_lock, 0)
 
 #define pset_lock(p)                   simple_lock(&(p)->sched_lock)
 #define pset_unlock(p)                 simple_unlock(&(p)->sched_lock)
 #define pset_lock_init(p)              simple_lock_init(&(p)->sched_lock, 0)
 

-/* Update hints */
-
-#define pset_pri_hint(ps, p, pri)              \
-MACRO_BEGIN                                                                                            \
-       if ((p) != (ps)->low_pri) {                                                     \
-               if ((pri) < (ps)->low_pri->current_pri)                 \
-                       (ps)->low_pri = (p);                                            \
-               else                                                                                    \
-               if ((ps)->low_pri->state < PROCESSOR_IDLE)              \
-                       (ps)->low_pri = (p);                                            \
-       }                                                                                                       \
-MACRO_END
-
-#define pset_count_hint(ps, p, cnt)            \
-MACRO_BEGIN                                                                                            \
-       if ((p) != (ps)->low_count) {                                           \
-               if ((cnt) < (ps)->low_count->runq.count)                \
-                       (ps)->low_count = (p);                                          \
-               else                                                                                    \
-               if ((ps)->low_count->state < PROCESSOR_IDLE)    \
-                       (ps)->low_count = (p);                                          \
-       }                                                                                                       \
-MACRO_END
-
-extern void            processor_bootstrap(void) __attribute__((section("__TEXT, initcode")));
+#define rt_lock_lock(p)                        simple_lock(&SCHED(rt_runq)(p)->rt_lock)
+#define rt_lock_unlock(p)              simple_unlock(&SCHED(rt_runq)(p)->rt_lock)
+#define rt_lock_init(p)                        simple_lock_init(&SCHED(rt_runq)(p)->rt_lock, 0)
+#else
+#define pset_lock(p)                   do { (void)p; } while(0)
+#define pset_unlock(p)                 do { (void)p; } while(0)
+#define pset_lock_init(p)              do { (void)p; } while(0)
+
+#define rt_lock_lock(p)                        do { (void)p; } while(0)
+#define rt_lock_unlock(p)              do { (void)p; } while(0)
+#define rt_lock_init(p)                        do { (void)p; } while(0)
+#endif
+
+extern void            processor_bootstrap(void);

 
 extern void            processor_init(
                                        processor_t             processor,
                                        int                             cpu_id,
 
 extern void            processor_init(
                                        processor_t             processor,
                                        int                             cpu_id,

-                                       processor_set_t processor_set) __attribute__((section("__TEXT, initcode")));
+                                       processor_set_t processor_set);

 
 

-extern void            processor_meta_init(
+extern void            processor_set_primary(

                                        processor_t             processor,
                                        processor_t             primary);
 
                                        processor_t             processor,
                                        processor_t             primary);
 


@@ -235,7 +324,11 @@ extern processor_set_t     pset_create(
 
 extern void            pset_init(
                                        processor_set_t         pset,
 
 extern void            pset_init(
                                        processor_set_t         pset,

-                                       pset_node_t                     node) __attribute__((section("__TEXT, initcode")));
+                                       pset_node_t                     node);
+
+extern processor_set_t pset_find(
+                                       uint32_t cluster_id,
+                                       processor_set_t default_pset);

 
 extern kern_return_t   processor_info_count(
                                                        processor_flavor_t              flavor,
 
 extern kern_return_t   processor_info_count(
                                                        processor_flavor_t              flavor,


@@ -244,11 +337,37 @@ extern kern_return_t      processor_info_count(
 #define pset_deallocate(x)
 #define pset_reference(x)
 
 #define pset_deallocate(x)
 #define pset_reference(x)
 

-extern void                    machine_run_count(
-                                               uint32_t        count);
+extern void                            machine_run_count(
+                                                       uint32_t        count);
+
+extern processor_t             machine_choose_processor(
+                                                       processor_set_t         pset,
+                                                       processor_t                     processor);
+
+#define next_pset(p)   (((p)->pset_list != PROCESSOR_SET_NULL)? (p)->pset_list: (p)->node->psets)
+
+#define PSET_THING_TASK                0
+#define PSET_THING_THREAD      1
+
+extern kern_return_t   processor_set_things(
+                       processor_set_t pset,
+                       void **thing_list,
+                       mach_msg_type_number_t *count,
+                       int type);

 
 

-extern boolean_t       machine_cpu_is_inactive(
-                                               int                     cpu_id);
+extern pset_cluster_type_t recommended_pset_type(thread_t thread);
+
+inline static bool
+pset_is_recommended(processor_set_t pset)
+{
+       return ((pset->recommended_bitmask & pset->cpu_bitmask) != 0);
+}
+
+extern void processor_state_update_idle(processor_t processor);
+extern void processor_state_update_from_thread(processor_t processor, thread_t thread);
+extern void processor_state_update_explicit(processor_t processor, int pri,
+       sfi_class_id_t sfi_class, pset_cluster_type_t pset_type, 
+       perfcontrol_class_t perfctl_class);

 
 #else  /* MACH_KERNEL_PRIVATE */
 
 
 #else  /* MACH_KERNEL_PRIVATE */
 


@@ -264,4 +383,12 @@ __END_DECLS
 
 #endif /* MACH_KERNEL_PRIVATE */
 
 
 #endif /* MACH_KERNEL_PRIVATE */
 

+#ifdef KERNEL_PRIVATE
+__BEGIN_DECLS
+extern unsigned int            processor_count;
+extern processor_t     cpu_to_processor(int cpu);
+__END_DECLS
+
+#endif /* KERNEL_PRIVATE */
+

 #endif /* _KERN_PROCESSOR_H_ */
 #endif /* _KERN_PROCESSOR_H_ */