osfmk/i386/mp.h

   1 /*
   2  * Copyright (c) 2000-2008 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 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 #ifdef  KERNEL_PRIVATE
  60
  61 #ifndef _I386_MP_H_
  62 #define _I386_MP_H_
  63
  64 //#define       MP_DEBUG 1
  65
  66 #include <i386/apic.h>
  67 #include <i386/mp_events.h>
  68
  69 #define MAX_CPUS        32              /* (8*sizeof(long)) */
  70
  71 #ifndef ASSEMBLER
  72 #include <stdint.h>
  73 #include <sys/cdefs.h>
  74 #include <mach/boolean.h>
  75 #include <mach/kern_return.h>
  76 #include <mach/i386/thread_status.h>
  77 #include <mach/vm_types.h>
  78 #include <kern/lock.h>
  79
  80 __BEGIN_DECLS
  81
  82 extern kern_return_t intel_startCPU(int slot_num);
  83 extern kern_return_t intel_startCPU_fast(int slot_num);
  84 extern void i386_init_slave(void);
  85 extern void i386_init_slave_fast(void);
  86 extern void smp_init(void);
  87
  88 extern void cpu_interrupt(int cpu);
  89 __END_DECLS
  90
  91 extern  unsigned int    real_ncpus;             /* real number of cpus */
  92 extern  unsigned int    max_ncpus;              /* max number of cpus */
  93 decl_simple_lock_data(extern,kdb_lock)  /* kdb lock             */
  94
  95 __BEGIN_DECLS
  96
  97 extern  void    console_init(void);
  98 extern  void    *console_cpu_alloc(boolean_t boot_cpu);
  99 extern  void    console_cpu_free(void *console_buf);
 100
 101 extern  int     kdb_cpu;                /* current cpu running kdb      */
 102 extern  int     kdb_debug;
 103 extern  int     kdb_active[];
 104
 105 extern  volatile boolean_t mp_kdp_trap;
 106 extern  volatile boolean_t force_immediate_debugger_NMI;
 107 extern  volatile boolean_t pmap_tlb_flush_timeout;
 108 extern  volatile usimple_lock_t spinlock_timed_out;
 109 extern  volatile uint32_t spinlock_owner_cpu;
 110
 111 extern  uint64_t        LastDebuggerEntryAllowance;
 112
 113 extern  void    mp_kdp_enter(void);
 114 extern  void    mp_kdp_exit(void);
 115
 116 extern  boolean_t       mp_recent_debugger_activity(void);
 117 #if MACH_KDB
 118 extern void mp_kdb_exit(void);
 119 #endif
 120
 121 /*
 122  * All cpu rendezvous:
 123  */
 124 extern void mp_rendezvous(
 125                 void (*setup_func)(void *),
 126                 void (*action_func)(void *),
 127                 void (*teardown_func)(void *),
 128                 void *arg);
 129 extern void mp_rendezvous_no_intrs(
 130                 void (*action_func)(void *),
 131                 void *arg);
 132 extern void mp_rendezvous_break_lock(void);
 133
 134 /*
 135  * All cpu broadcast.
 136  * Called from thread context, this blocks until all active cpus have
 137  * run action_func:
 138  */
 139 extern void mp_broadcast(
 140                 void (*action_func)(void *),
 141                 void *arg);
 142 #if MACH_KDP
 143 typedef long (*kdp_x86_xcpu_func_t) (void *arg0, void *arg1, uint16_t lcpu);
 144
 145 extern  long kdp_x86_xcpu_invoke(const uint16_t lcpu,
 146                                  kdp_x86_xcpu_func_t func,
 147                                  void *arg0, void *arg1);
 148 typedef enum    {KDP_XCPU_NONE = 0xffff, KDP_CURRENT_LCPU = 0xfffe} kdp_cpu_t;
 149 #endif
 150
 151 typedef uint32_t cpu_t;
 152 typedef uint32_t cpumask_t;
 153 static inline cpumask_t
 154 cpu_to_cpumask(cpu_t cpu)
 155 {
 156         return (cpu < 32) ? (1 << cpu) : 0;
 157 }
 158 #define CPUMASK_ALL     0xffffffff
 159 #define CPUMASK_SELF    cpu_to_cpumask(cpu_number())
 160 #define CPUMASK_OTHERS  (CPUMASK_ALL & ~CPUMASK_SELF)
 161
 162 /*
 163  * Invoke a function (possibly NULL) on a set of cpus specified by a mask.
 164  * The mask may include the local cpu.
 165  * If the mode is:
 166  *      - ASYNC:  other cpus make their calls in parallel
 167  *      - SYNC:   the calls are performed serially in logical cpu order
 168  *      - NOSYNC: the calls are queued
 169  * Unless the mode is NOSYNC, mp_cpus_call() returns when the function has been
 170  * called on all specified cpus.
 171  * The return value is the number of cpus where the call was made or queued.
 172  * The action function is called with interrupts disabled.
 173  */
 174 extern cpu_t mp_cpus_call(
 175                 cpumask_t       cpus,
 176                 mp_sync_t       mode,
 177                 void            (*action_func)(void *),
 178                 void            *arg);
 179 extern cpu_t mp_cpus_call1(
 180                 cpumask_t       cpus,
 181                 mp_sync_t       mode,
 182                 void            (*action_func)(void *, void*),
 183                 void            *arg0,
 184                 void            *arg1,
 185                 cpumask_t       *cpus_calledp,
 186                 cpumask_t       *cpus_notcalledp);
 187
 188 /*
 189  * Power-management-specific SPI to:
 190  *  - register a callout function, and
 191  *  - request the callout (if registered) on a given cpu.
 192  */
 193 extern void PM_interrupt_register(void (*fn)(void));
 194 extern void cpu_PM_interrupt(int cpu);
 195
 196 __END_DECLS
 197
 198 #if MP_DEBUG
 199 typedef struct {
 200         uint64_t        time;
 201         int             cpu;
 202         mp_event_t      event;
 203 } cpu_signal_event_t;
 204
 205 #define LOG_NENTRIES    100
 206 typedef struct {
 207         uint64_t                count[MP_LAST];
 208         int                     next_entry;
 209         cpu_signal_event_t      entry[LOG_NENTRIES];
 210 } cpu_signal_event_log_t;
 211
 212 extern cpu_signal_event_log_t   *cpu_signal[];
 213 extern cpu_signal_event_log_t   *cpu_handle[];
 214
 215 #define DBGLOG(log,_cpu,_event) {                                       \
 216         boolean_t               spl = ml_set_interrupts_enabled(FALSE); \
 217         cpu_signal_event_log_t  *logp = log[cpu_number()];              \
 218         int                     next = logp->next_entry;                \
 219         cpu_signal_event_t      *eventp = &logp->entry[next];           \
 220                                                                         \
 221         logp->count[_event]++;                                          \
 222                                                                         \
 223         eventp->time = rdtsc64();                                       \
 224         eventp->cpu = _cpu;                                             \
 225         eventp->event = _event;                                         \
 226         if (next == (LOG_NENTRIES - 1))                                 \
 227                 logp->next_entry = 0;                                   \
 228         else                                                            \
 229                 logp->next_entry++;                                     \
 230                                                                         \
 231         (void) ml_set_interrupts_enabled(spl);                          \
 232 }
 233
 234 #define DBGLOG_CPU_INIT(cpu)    {                                       \
 235         cpu_signal_event_log_t  **sig_logpp = &cpu_signal[cpu];         \
 236         cpu_signal_event_log_t  **hdl_logpp = &cpu_handle[cpu];         \
 237                                                                         \
 238         if (*sig_logpp == NULL &&                                       \
 239                 kmem_alloc(kernel_map,                                  \
 240                         (vm_offset_t *) sig_logpp,                      \
 241                         sizeof(cpu_signal_event_log_t)) != KERN_SUCCESS)\
 242                 panic("DBGLOG_CPU_INIT cpu_signal allocation failed\n");\
 243         bzero(*sig_logpp, sizeof(cpu_signal_event_log_t));              \
 244         if (*hdl_logpp == NULL &&                                       \
 245                 kmem_alloc(kernel_map,                                  \
 246                         (vm_offset_t *) hdl_logpp,                      \
 247                         sizeof(cpu_signal_event_log_t)) != KERN_SUCCESS)\
 248                 panic("DBGLOG_CPU_INIT cpu_handle allocation failed\n");\
 249         bzero(*hdl_logpp, sizeof(cpu_signal_event_log_t));              \
 250 }
 251 #else   /* MP_DEBUG */
 252 #define DBGLOG(log,_cpu,_event)
 253 #define DBGLOG_CPU_INIT(cpu)
 254 #endif  /* MP_DEBUG */
 255
 256 #endif  /* ASSEMBLER */
 257
 258 #ifdef ASSEMBLER
 259 #define i_bit(bit, word)        ((long)(*(word)) & (1L << (bit)))
 260 #else
 261 __attribute__((always_inline)) static inline long
 262 i_bit_impl(long word, long bit) {
 263         long bitmask = 1L << bit;
 264         return word & bitmask;
 265 }
 266 #define i_bit(bit, word)        i_bit_impl((long)(*(word)), bit)
 267 #endif
 268
 269 #if     MACH_RT
 270
 271 #if defined(__i386__)
 272
 273 #define _DISABLE_PREEMPTION                                     \
 274         incl    %gs:CPU_PREEMPTION_LEVEL
 275
 276 #define _ENABLE_PREEMPTION                                      \
 277         decl    %gs:CPU_PREEMPTION_LEVEL                ;       \
 278         jne     9f                                      ;       \
 279         pushl   %eax                                    ;       \
 280         pushl   %ecx                                    ;       \
 281         pushl   %edx                                    ;       \
 282         call    EXT(kernel_preempt_check)               ;       \
 283         popl    %edx                                    ;       \
 284         popl    %ecx                                    ;       \
 285         popl    %eax                                    ;       \
 286 9:
 287
 288 #define _ENABLE_PREEMPTION_NO_CHECK                             \
 289         decl    %gs:CPU_PREEMPTION_LEVEL
 290
 291 #elif defined(__x86_64__)
 292
 293 #define _DISABLE_PREEMPTION                                     \
 294         incl    %gs:CPU_PREEMPTION_LEVEL
 295
 296 #define _ENABLE_PREEMPTION                                      \
 297         decl    %gs:CPU_PREEMPTION_LEVEL                ;       \
 298         jne     9f                                      ;       \
 299         call    EXT(kernel_preempt_check)               ;       \
 300 9:
 301
 302 #define _ENABLE_PREEMPTION_NO_CHECK                             \
 303         decl    %gs:CPU_PREEMPTION_LEVEL
 304
 305 #else
 306 #error Unsupported architecture
 307 #endif
 308
 309 /* x86_64 just calls through to the other macro directly */
 310 #if     MACH_ASSERT && defined(__i386__)
 311 #define DISABLE_PREEMPTION                                      \
 312         pushl   %eax;                                           \
 313         pushl   %ecx;                                           \
 314         pushl   %edx;                                           \
 315         call    EXT(_disable_preemption);                       \
 316         popl    %edx;                                           \
 317         popl    %ecx;                                           \
 318         popl    %eax
 319 #define ENABLE_PREEMPTION                                       \
 320         pushl   %eax;                                           \
 321         pushl   %ecx;                                           \
 322         pushl   %edx;                                           \
 323         call    EXT(_enable_preemption);                        \
 324         popl    %edx;                                           \
 325         popl    %ecx;                                           \
 326         popl    %eax
 327 #define ENABLE_PREEMPTION_NO_CHECK                              \
 328         pushl   %eax;                                           \
 329         pushl   %ecx;                                           \
 330         pushl   %edx;                                           \
 331         call    EXT(_enable_preemption_no_check);               \
 332         popl    %edx;                                           \
 333         popl    %ecx;                                           \
 334         popl    %eax
 335 #define MP_DISABLE_PREEMPTION                                   \
 336         pushl   %eax;                                           \
 337         pushl   %ecx;                                           \
 338         pushl   %edx;                                           \
 339         call    EXT(_mp_disable_preemption);                    \
 340         popl    %edx;                                           \
 341         popl    %ecx;                                           \
 342         popl    %eax
 343 #define MP_ENABLE_PREEMPTION                                    \
 344         pushl   %eax;                                           \
 345         pushl   %ecx;                                           \
 346         pushl   %edx;                                           \
 347         call    EXT(_mp_enable_preemption);                     \
 348         popl    %edx;                                           \
 349         popl    %ecx;                                           \
 350         popl    %eax
 351 #define MP_ENABLE_PREEMPTION_NO_CHECK                           \
 352         pushl   %eax;                                           \
 353         pushl   %ecx;                                           \
 354         pushl   %edx;                                           \
 355         call    EXT(_mp_enable_preemption_no_check);            \
 356         popl    %edx;                                           \
 357         popl    %ecx;                                           \
 358         popl    %eax
 359 #else   /* MACH_ASSERT */
 360 #define DISABLE_PREEMPTION              _DISABLE_PREEMPTION
 361 #define ENABLE_PREEMPTION               _ENABLE_PREEMPTION
 362 #define ENABLE_PREEMPTION_NO_CHECK      _ENABLE_PREEMPTION_NO_CHECK
 363 #define MP_DISABLE_PREEMPTION           _DISABLE_PREEMPTION
 364 #define MP_ENABLE_PREEMPTION            _ENABLE_PREEMPTION
 365 #define MP_ENABLE_PREEMPTION_NO_CHECK   _ENABLE_PREEMPTION_NO_CHECK
 366 #endif  /* MACH_ASSERT */
 367
 368 #else   /* MACH_RT */
 369 #define DISABLE_PREEMPTION
 370 #define ENABLE_PREEMPTION
 371 #define ENABLE_PREEMPTION_NO_CHECK
 372 #define MP_DISABLE_PREEMPTION
 373 #define MP_ENABLE_PREEMPTION
 374 #define MP_ENABLE_PREEMPTION_NO_CHECK
 375 #endif  /* MACH_RT */
 376
 377 #endif /* _I386_MP_H_ */
 378
 379 #endif /* KERNEL_PRIVATE */