osfmk/kern/processor.h

   1 /*
   2  * Copyright (c) 2000-2009 Apple Inc. All rights reserved.
   3  *
   4  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
   5  *
   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.
  14  *
  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
  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.
  25  *
  26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  27  */
  28 /*
  29  * @OSF_COPYRIGHT@
  30  */
  31 /*
  32  * Mach Operating System
  33  * Copyright (c) 1991,1990,1989 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  *      processor.h:    Processor and processor-related definitions.
  61  */
  62
  63 #ifndef _KERN_PROCESSOR_H_
  64 #define _KERN_PROCESSOR_H_
  65
  66 #include <mach/boolean.h>
  67 #include <mach/kern_return.h>
  68 #include <kern/kern_types.h>
  69
  70 #include <sys/cdefs.h>
  71
  72 #ifdef  MACH_KERNEL_PRIVATE
  73
  74 #include <mach/mach_types.h>
  75 #include <kern/ast.h>
  76 #include <kern/cpu_number.h>
  77 #include <kern/lock.h>
  78 #include <kern/queue.h>
  79 #include <kern/sched.h>
  80 #include <kern/processor_data.h>
  81
  82 #include <machine/ast_types.h>
  83
  84 struct processor_set {
  85         queue_head_t            active_queue;   /* active processors */
  86         queue_head_t            idle_queue;             /* idle processors */
  87
  88         processor_t                     low_pri, low_count;
  89
  90         int                                     processor_count;
  91
  92         int                                     cpu_set_low, cpu_set_hi;
  93         int                                     cpu_set_count;
  94
  95         decl_simple_lock_data(,sched_lock)      /* lock for above */
  96
  97         struct ipc_port *       pset_self;              /* port for operations */
  98         struct ipc_port *       pset_name_self; /* port for information */
  99
 100         processor_set_t         pset_list;              /* chain of associated psets */
 101         pset_node_t                     node;
 102 };
 103
 104 extern struct processor_set     pset0;
 105
 106 struct pset_node {
 107         processor_set_t         psets;                  /* list of associated psets */
 108
 109         pset_node_t                     nodes;                  /* list of associated subnodes */
 110         pset_node_t                     node_list;              /* chain of associated nodes */
 111
 112         pset_node_t                     parent;
 113 };
 114
 115 extern struct pset_node pset_node0;
 116
 117 extern queue_head_t             tasks, threads;
 118 extern int                              tasks_count, threads_count;
 119 decl_lck_mtx_data(extern,tasks_threads_lock)
 120
 121 struct processor_meta {
 122         queue_head_t            idle_queue;
 123         processor_t                     primary;
 124 };
 125
 126 typedef struct processor_meta   *processor_meta_t;
 127 #define PROCESSOR_META_NULL             ((processor_meta_t) 0)
 128
 129 struct processor {
 130         queue_chain_t           processor_queue;/* idle/active queue link,
 131                                                                                  * MUST remain the first element */
 132         int                                     state;                  /* See below */
 133         struct thread
 134                                                 *active_thread, /* thread running on processor */
 135                                                 *next_thread,   /* next thread when dispatched */
 136                                                 *idle_thread;   /* this processor's idle thread. */
 137
 138         processor_set_t         processor_set;  /* assigned set */
 139
 140         int                                     current_pri;    /* priority of current thread */
 141         int                                     cpu_id;                 /* platform numeric id */
 142
 143         timer_call_data_t       quantum_timer;  /* timer for quantum expiration */
 144         uint64_t                        quantum_end;    /* time when current quantum ends */
 145         uint64_t                        last_dispatch;  /* time of last dispatch */
 146
 147         uint64_t                        deadline;               /* current deadline */
 148         int                                     timeslice;              /* quanta before timeslice ends */
 149
 150         struct run_queue        runq;                   /* runq for this processor */
 151         processor_meta_t        processor_meta;
 152
 153         struct ipc_port *       processor_self; /* port for operations */
 154
 155         processor_t                     processor_list; /* all existing processors */
 156         processor_data_t        processor_data; /* per-processor data */
 157 };
 158
 159 extern processor_t              processor_list;
 160 extern unsigned int             processor_count;
 161 decl_simple_lock_data(extern,processor_list_lock)
 162
 163 extern uint32_t                 processor_avail_count;
 164
 165 extern processor_t              master_processor;
 166
 167 /*
 168  *      Processor state is accessed by locking the scheduling lock
 169  *      for the assigned processor set.
 170  */
 171 #define PROCESSOR_OFF_LINE              0       /* Not available */
 172 #define PROCESSOR_SHUTDOWN              1       /* Going off-line */
 173 #define PROCESSOR_START                 2       /* Being started */
 174 #define PROCESSOR_INACTIVE              3       /* Inactive (unavailable) */
 175 #define PROCESSOR_IDLE                  4       /* Idle (available) */
 176 #define PROCESSOR_DISPATCHING   5       /* Dispatching (idle -> active) */
 177 #define PROCESSOR_RUNNING               6       /* Normal execution */
 178
 179 extern processor_t      current_processor(void);
 180
 181 extern processor_t      cpu_to_processor(
 182                                                 int                     cpu);
 183
 184 /* Lock macros */
 185
 186 #define pset_lock(p)                    simple_lock(&(p)->sched_lock)
 187 #define pset_unlock(p)                  simple_unlock(&(p)->sched_lock)
 188 #define pset_lock_init(p)               simple_lock_init(&(p)->sched_lock, 0)
 189
 190 /* Update hints */
 191
 192 #define pset_pri_hint(ps, p, pri)               \
 193 MACRO_BEGIN                                                                                             \
 194         if ((p) != (ps)->low_pri) {                                                     \
 195                 if ((pri) < (ps)->low_pri->current_pri)                 \
 196                         (ps)->low_pri = (p);                                            \
 197                 else                                                                                    \
 198                 if ((ps)->low_pri->state < PROCESSOR_IDLE)              \
 199                         (ps)->low_pri = (p);                                            \
 200         }                                                                                                       \
 201 MACRO_END
 202
 203 #define pset_count_hint(ps, p, cnt)             \
 204 MACRO_BEGIN                                                                                             \
 205         if ((p) != (ps)->low_count) {                                           \
 206                 if ((cnt) < (ps)->low_count->runq.count)                \
 207                         (ps)->low_count = (p);                                          \
 208                 else                                                                                    \
 209                 if ((ps)->low_count->state < PROCESSOR_IDLE)    \
 210                         (ps)->low_count = (p);                                          \
 211         }                                                                                                       \
 212 MACRO_END
 213
 214 extern void             processor_bootstrap(void) __attribute__((section("__TEXT, initcode")));
 215
 216 extern void             processor_init(
 217                                         processor_t             processor,
 218                                         int                             cpu_id,
 219                                         processor_set_t processor_set) __attribute__((section("__TEXT, initcode")));
 220
 221 extern void             processor_meta_init(
 222                                         processor_t             processor,
 223                                         processor_t             primary);
 224
 225 extern kern_return_t    processor_shutdown(
 226                                                         processor_t             processor);
 227
 228 extern void             processor_queue_shutdown(
 229                                         processor_t             processor);
 230
 231 extern processor_set_t  processor_pset(
 232                                                         processor_t             processor);
 233
 234 extern pset_node_t              pset_node_root(void);
 235
 236 extern processor_set_t  pset_create(
 237                                                         pset_node_t             node);
 238
 239 extern void             pset_init(
 240                                         processor_set_t         pset,
 241                                         pset_node_t                     node) __attribute__((section("__TEXT, initcode")));
 242
 243 extern kern_return_t    processor_info_count(
 244                                                         processor_flavor_t              flavor,
 245                                                         mach_msg_type_number_t  *count);
 246
 247 #define pset_deallocate(x)
 248 #define pset_reference(x)
 249
 250 extern void                             machine_run_count(
 251                                                         uint32_t        count);
 252
 253 extern boolean_t                machine_processor_is_inactive(
 254                                                         processor_t                     processor);
 255
 256 extern processor_t              machine_choose_processor(
 257                                                         processor_set_t         pset,
 258                                                         processor_t                     processor);
 259
 260 #else   /* MACH_KERNEL_PRIVATE */
 261
 262 __BEGIN_DECLS
 263
 264 extern void             pset_deallocate(
 265                                         processor_set_t pset);
 266
 267 extern void             pset_reference(
 268                                         processor_set_t pset);
 269
 270 __END_DECLS
 271
 272 #endif  /* MACH_KERNEL_PRIVATE */
 273
 274 #endif  /* _KERN_PROCESSOR_H_ */