osfmk/kern/processor.h

   1 /*
   2  * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * The contents of this file constitute Original Code as defined in and
   7  * are subject to the Apple Public Source License Version 1.1 (the
   8  * "License").  You may not use this file except in compliance with the
   9  * License.  Please obtain a copy of the License at
  10  * http://www.apple.com/publicsource and read it before using this file.
  11  *
  12  * This Original Code and all software distributed under the License are
  13  * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  14  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  15  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  16  * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
  17  * License for the specific language governing rights and limitations
  18  * under the License.
  19  *
  20  * @APPLE_LICENSE_HEADER_END@
  21  */
  22 /*
  23  * @OSF_COPYRIGHT@
  24  */
  25 /*
  26  * Mach Operating System
  27  * Copyright (c) 1991,1990,1989 Carnegie Mellon University
  28  * All Rights Reserved.
  29  *
  30  * Permission to use, copy, modify and distribute this software and its
  31  * documentation is hereby granted, provided that both the copyright
  32  * notice and this permission notice appear in all copies of the
  33  * software, derivative works or modified versions, and any portions
  34  * thereof, and that both notices appear in supporting documentation.
  35  *
  36  * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
  37  * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
  38  * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
  39  *
  40  * Carnegie Mellon requests users of this software to return to
  41  *
  42  *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
  43  *  School of Computer Science
  44  *  Carnegie Mellon University
  45  *  Pittsburgh PA 15213-3890
  46  *
  47  * any improvements or extensions that they make and grant Carnegie Mellon
  48  * the rights to redistribute these changes.
  49  */
  50 /*
  51  */
  52
  53 /*
  54  *      processor.h:    Processor and processor-set definitions.
  55  */
  56
  57 #ifndef _KERN_PROCESSOR_H_
  58 #define _KERN_PROCESSOR_H_
  59
  60 /*
  61  *      Data structures for managing processors and sets of processors.
  62  */
  63 #include <mach/boolean.h>
  64 #include <mach/kern_return.h>
  65 #include <kern/kern_types.h>
  66
  67 #include <sys/appleapiopts.h>
  68
  69 #ifdef  __APPLE_API_PRIVATE
  70
  71 #ifdef  MACH_KERNEL_PRIVATE
  72
  73 #include <cpus.h>
  74
  75 #include <mach/mach_types.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/cpu_data.h>
  81
  82 #include <machine/ast_types.h>
  83
  84 struct processor_set {
  85         queue_head_t            idle_queue;             /* idle processors */
  86         int                                     idle_count;             /* how many ? */
  87         queue_head_t            active_queue;   /* active processors */
  88         decl_simple_lock_data(,sched_lock)      /* lock for above */
  89
  90         queue_head_t            processors;             /* all processors here */
  91         int                                     processor_count;/* how many ? */
  92         decl_simple_lock_data(,processors_lock) /* lock for above */
  93
  94         struct  run_queue       runq;                   /* runq for this set */
  95
  96         queue_head_t            tasks;                  /* tasks assigned */
  97         int                                     task_count;             /* how many */
  98         queue_head_t            threads;                /* threads in this set */
  99         int                                     thread_count;   /* how many */
 100         int                                     ref_count;              /* structure ref count */
 101         boolean_t                       active;                 /* is pset in use */
 102         decl_mutex_data(,       lock)                   /* lock for above */
 103
 104         int                                     set_quanta;             /* timeslice quanta for timesharing */
 105         int                                     machine_quanta[NCPUS+1];
 106
 107         struct ipc_port *       pset_self;              /* port for operations */
 108         struct ipc_port *       pset_name_self; /* port for information */
 109
 110         uint32_t                        run_count;              /* number of threads running in set */
 111
 112         integer_t                       mach_factor;    /* mach_factor */
 113         integer_t                       load_average;   /* load_average */
 114         uint32_t                        sched_load;             /* load avg for scheduler */
 115 };
 116
 117 struct processor {
 118         queue_chain_t           processor_queue;/* idle/active/action queue link,
 119                                                                                  * MUST remain the first element */
 120         int                                     state;                  /* See below */
 121         int                                     current_pri;    /* priority of current thread */
 122         struct thread_shuttle
 123                                                 *next_thread,   /* next thread to run if dispatched */
 124                                                 *idle_thread;   /* this processor's idle thread. */
 125         timer_call_data_t       quantum_timer;  /* timer for quantum expiration */
 126         int                                     slice_quanta;   /* quanta before timeslice ends */
 127         uint64_t                        quantum_end;    /* time when current quantum ends */
 128         uint64_t                        last_dispatch;  /* time of last dispatch */
 129
 130         struct run_queue        runq;                   /* local runq for this processor */
 131
 132         processor_set_t         processor_set;          /* current membership */
 133         processor_set_t         processor_set_next;     /* set to join in progress */
 134         queue_chain_t           processors;                     /* all processors in set */
 135         decl_simple_lock_data(,lock)
 136         struct ipc_port         *processor_self;/* port for operations */
 137         cpu_data_t                      *cpu_data;              /* machine-dep per-cpu data */
 138         int                                     slot_num;               /* machine-indep slot number */
 139 };
 140
 141 extern struct processor_set     default_pset;
 142 extern processor_t      master_processor;
 143
 144 extern struct processor processor_array[NCPUS];
 145
 146 /*
 147  *      NOTE: The processor->processor_set link is needed in one of the
 148  *      scheduler's critical paths.  [Figure out where to look for another
 149  *      thread to run on this processor.]  It is accessed without locking.
 150  *      The following access protocol controls this field.
 151  *
 152  *      Read from own processor - just read.
 153  *      Read from another processor - lock processor structure during read.
 154  *      Write from own processor - lock processor structure during write.
 155  *      Write from another processor - NOT PERMITTED.
 156  *
 157  */
 158
 159 /*
 160  *      Processor state locking:
 161  *
 162  *      Values for the processor state are defined below.  If the processor
 163  *      is off-line or being shutdown, then it is only necessary to lock
 164  *      the processor to change its state.  Otherwise it is only necessary
 165  *      to lock its processor set's sched_lock.  Scheduler code will
 166  *      typically lock only the sched_lock, but processor manipulation code
 167  *      will often lock both.
 168  */
 169
 170 #define PROCESSOR_OFF_LINE              0       /* Not in system */
 171 #define PROCESSOR_RUNNING               1       /* Running a normal thread */
 172 #define PROCESSOR_IDLE                  2       /* idle */
 173 #define PROCESSOR_DISPATCHING   3       /* dispatching (idle -> running) */
 174 #define PROCESSOR_ASSIGN                4       /* Assignment is changing */
 175 #define PROCESSOR_SHUTDOWN              5       /* Being shutdown */
 176 #define PROCESSOR_START                 6       /* Being start */
 177
 178 /*
 179  *      Use processor ptr array to find current processor's data structure.
 180  *      This replaces a multiplication (index into processor_array) with
 181  *      an array lookup and a memory reference.  It also allows us to save
 182  *      space if processor numbering gets too sparse.
 183  */
 184
 185 extern processor_t      processor_ptr[NCPUS];
 186
 187 #define cpu_to_processor(i)     (processor_ptr[i])
 188
 189 #define current_processor()     (processor_ptr[cpu_number()])
 190 #define current_processor_set() (current_processor()->processor_set)
 191
 192 /* Compatibility -- will go away */
 193
 194 #define cpu_state(slot_num)     (processor_ptr[slot_num]->state)
 195 #define cpu_idle(slot_num)      (cpu_state(slot_num) == PROCESSOR_IDLE)
 196
 197 /* Useful lock macros */
 198
 199 #define pset_lock(pset)         mutex_lock(&(pset)->lock)
 200 #define pset_lock_try(pset)     mutex_try(&(pset)->lock)
 201 #define pset_unlock(pset)       mutex_unlock(&(pset)->lock)
 202
 203 #define processor_lock(pr)      simple_lock(&(pr)->lock)
 204 #define processor_unlock(pr)    simple_unlock(&(pr)->lock)
 205
 206 extern void             pset_sys_bootstrap(void);
 207
 208 #define pset_quanta_update(pset)                                                \
 209 MACRO_BEGIN                                                                                             \
 210         int             proc_count = (pset)->processor_count;           \
 211         int             runq_count = (pset)->runq.count;                        \
 212                                                                                                                 \
 213         (pset)->set_quanta = (pset)->machine_quanta[            \
 214                                         (runq_count > proc_count)?                      \
 215                                                         proc_count: runq_count];        \
 216 MACRO_END
 217
 218 /* Implemented by MD layer */
 219
 220 extern void             cpu_up(
 221                                 int             cpu);
 222
 223 extern kern_return_t    processor_shutdown(
 224                                 processor_t     processor);
 225
 226 extern void             pset_remove_processor(
 227                                 processor_set_t pset,
 228                                 processor_t     processor);
 229
 230 extern void             pset_add_processor(
 231                                 processor_set_t pset,
 232                                 processor_t     processor);
 233
 234 extern void             pset_remove_task(
 235                                 processor_set_t pset,
 236                                 task_t          task);
 237
 238 extern void             pset_add_task(
 239                                 processor_set_t pset,
 240                                 task_t          task);
 241
 242 extern void             pset_remove_thread(
 243                                 processor_set_t pset,
 244                                 thread_t        thread);
 245
 246 extern void             pset_add_thread(
 247                                 processor_set_t pset,
 248                                 thread_t        thread);
 249
 250 extern void             thread_change_psets(
 251                                 thread_t        thread,
 252                                 processor_set_t old_pset,
 253                                 processor_set_t new_pset);
 254
 255 extern kern_return_t    processor_assign(
 256                                 processor_t     processor,
 257                                 processor_set_t new_pset,
 258                                 boolean_t       wait);
 259
 260 extern kern_return_t    processor_info_count(
 261                                 processor_flavor_t flavor,
 262                                 mach_msg_type_number_t *count);
 263
 264 #endif  /* MACH_KERNEL_PRIVATE */
 265
 266 extern kern_return_t    processor_start(
 267                                 processor_t     processor);
 268
 269 extern kern_return_t    processor_exit(
 270                                 processor_t     processor);
 271
 272 #endif  /* __APPLE_API_PRIVATE */
 273
 274 extern void             pset_deallocate(
 275                                 processor_set_t pset);
 276
 277 extern void             pset_reference(
 278                                 processor_set_t pset);
 279
 280 #endif  /* _KERN_PROCESSOR_H_ */