osfmk/kern/machine.c

   1 /*
   2  * Copyright (c) 2000-2007 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,1988,1987 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  *      File:   kern/machine.c
  60  *      Author: Avadis Tevanian, Jr.
  61  *      Date:   1987
  62  *
  63  *      Support for machine independent machine abstraction.
  64  */
  65
  66 #include <string.h>
  67
  68 #include <mach/mach_types.h>
  69 #include <mach/boolean.h>
  70 #include <mach/kern_return.h>
  71 #include <mach/machine.h>
  72 #include <mach/host_info.h>
  73 #include <mach/host_reboot.h>
  74 #include <mach/host_priv_server.h>
  75 #include <mach/processor_server.h>
  76
  77 #include <kern/kern_types.h>
  78 #include <kern/counters.h>
  79 #include <kern/cpu_data.h>
  80 #include <kern/ipc_host.h>
  81 #include <kern/host.h>
  82 #include <kern/lock.h>
  83 #include <kern/machine.h>
  84 #include <kern/misc_protos.h>
  85 #include <kern/processor.h>
  86 #include <kern/queue.h>
  87 #include <kern/sched.h>
  88 #include <kern/task.h>
  89 #include <kern/thread.h>
  90
  91 #if HIBERNATION
  92 #include <IOKit/IOHibernatePrivate.h>
  93 #endif
  94 #include <IOKit/IOPlatformExpert.h>
  95
  96 /*
  97  *      Exported variables:
  98  */
  99
 100 struct machine_info     machine_info;
 101
 102 /* Forwards */
 103 void                    processor_doshutdown(
 104                                         processor_t                     processor);
 105
 106 /*
 107  *      processor_up:
 108  *
 109  *      Flag processor as up and running, and available
 110  *      for scheduling.
 111  */
 112 void
 113 processor_up(
 114         processor_t                     processor)
 115 {
 116         processor_set_t         pset;
 117         spl_t                           s;
 118
 119         s = splsched();
 120         init_ast_check(processor);
 121         pset = processor->processor_set;
 122         pset_lock(pset);
 123         pset->processor_count++;
 124         enqueue_head(&pset->active_queue, (queue_entry_t)processor);
 125         processor->state = PROCESSOR_RUNNING;
 126         (void)hw_atomic_add(&processor_avail_count, 1);
 127         pset_unlock(pset);
 128         ml_cpu_up();
 129         splx(s);
 130 }
 131
 132 kern_return_t
 133 host_reboot(
 134         host_priv_t             host_priv,
 135         int                             options)
 136 {
 137         if (host_priv == HOST_PRIV_NULL)
 138                 return (KERN_INVALID_HOST);
 139
 140         assert(host_priv == &realhost);
 141
 142         if (options & HOST_REBOOT_DEBUGGER) {
 143                 Debugger("Debugger");
 144                 return (KERN_SUCCESS);
 145         }
 146
 147     if (options & HOST_REBOOT_UPSDELAY) {
 148         // UPS power cutoff path
 149         PEHaltRestart( kPEUPSDelayHaltCPU );
 150     } else {
 151        halt_all_cpus(!(options & HOST_REBOOT_HALT));
 152     }
 153
 154         return (KERN_SUCCESS);
 155 }
 156
 157 kern_return_t
 158 processor_assign(
 159         __unused processor_t            processor,
 160         __unused processor_set_t        new_pset,
 161         __unused boolean_t              wait)
 162 {
 163         return (KERN_FAILURE);
 164 }
 165
 166 kern_return_t
 167 processor_shutdown(
 168         processor_t                     processor)
 169 {
 170         processor_set_t         pset;
 171         spl_t                           s;
 172
 173         s = splsched();
 174         pset = processor->processor_set;
 175         pset_lock(pset);
 176         if (processor->state == PROCESSOR_OFF_LINE) {
 177                 /*
 178                  * Success if already shutdown.
 179                  */
 180                 pset_unlock(pset);
 181                 splx(s);
 182
 183                 return (KERN_SUCCESS);
 184         }
 185
 186         if (processor->state == PROCESSOR_START) {
 187                 /*
 188                  * Failure if currently being started.
 189                  */
 190                 pset_unlock(pset);
 191                 splx(s);
 192
 193                 return (KERN_FAILURE);
 194         }
 195
 196         /*
 197          * If the processor is dispatching, let it finish.
 198          */
 199         while (processor->state == PROCESSOR_DISPATCHING) {
 200                 pset_unlock(pset);
 201                 delay(1);
 202                 pset_lock(pset);
 203         }
 204
 205         /*
 206          * Success if already being shutdown.
 207          */
 208         if (processor->state == PROCESSOR_SHUTDOWN) {
 209                 pset_unlock(pset);
 210                 splx(s);
 211
 212                 return (KERN_SUCCESS);
 213         }
 214
 215         if (processor->state == PROCESSOR_IDLE) {
 216                 remqueue(&pset->idle_queue, (queue_entry_t)processor);
 217                 pset->idle_count--;
 218         }
 219         else
 220         if (processor->state == PROCESSOR_RUNNING)
 221                 remqueue(&pset->active_queue, (queue_entry_t)processor);
 222         else
 223                 panic("processor_shutdown");
 224
 225         processor->state = PROCESSOR_SHUTDOWN;
 226
 227         pset_unlock(pset);
 228
 229         processor_doshutdown(processor);
 230         splx(s);
 231
 232         cpu_exit_wait(PROCESSOR_DATA(processor, slot_num));
 233
 234         return (KERN_SUCCESS);
 235 }
 236
 237 /*
 238  * Called at splsched.
 239  */
 240 void
 241 processor_doshutdown(
 242         processor_t                     processor)
 243 {
 244         thread_t                        old_thread, self = current_thread();
 245         processor_t                     prev;
 246
 247         /*
 248          *      Get onto the processor to shutdown
 249          */
 250         prev = thread_bind(processor);
 251         thread_block(THREAD_CONTINUE_NULL);
 252
 253 #if HIBERNATION
 254         if (processor_avail_count < 2)
 255                 hibernate_vm_lock();
 256 #endif
 257
 258         assert(processor->state == PROCESSOR_SHUTDOWN);
 259
 260 #if HIBERNATION
 261         if (processor_avail_count < 2)
 262                 hibernate_vm_unlock();
 263 #endif
 264
 265         /*
 266          *      Continue processor shutdown in shutdown context.
 267          */
 268         thread_bind(prev);
 269         old_thread = machine_processor_shutdown(self, processor_offline, processor);
 270
 271         thread_dispatch(old_thread, self);
 272
 273         /*
 274          * If we just shutdown another processor, move any
 275          * threads and timer call outs to the current processor.
 276          */
 277         if (processor != current_processor()) {
 278                 processor_set_t         pset = processor->processor_set;
 279
 280                 pset_lock(pset);
 281
 282                 if (processor->state == PROCESSOR_OFF_LINE || processor->state == PROCESSOR_SHUTDOWN) {
 283                         timer_call_shutdown(processor);
 284                         processor_queue_shutdown(processor);
 285                         return;
 286                 }
 287
 288                 pset_unlock(pset);
 289         }
 290 }
 291
 292 /*
 293  *      Complete the shutdown and place the processor offline.
 294  *
 295  *      Called at splsched in the shutdown context.
 296  */
 297 void
 298 processor_offline(
 299         processor_t                     processor)
 300 {
 301         thread_t                        new_thread, old_thread = processor->active_thread;
 302         processor_set_t         pset;
 303
 304         new_thread = processor->idle_thread;
 305         processor->active_thread = new_thread;
 306         processor->current_pri = IDLEPRI;
 307         processor->deadline = UINT64_MAX;
 308         new_thread->last_processor = processor;
 309
 310         processor->last_dispatch = mach_absolute_time();
 311         timer_stop(PROCESSOR_DATA(processor, thread_timer), processor->last_dispatch);
 312
 313         machine_set_current_thread(new_thread);
 314
 315         thread_dispatch(old_thread, new_thread);
 316
 317         PMAP_DEACTIVATE_KERNEL(PROCESSOR_DATA(processor, slot_num));
 318
 319         pset = processor->processor_set;
 320         pset_lock(pset);
 321         pset->processor_count--;
 322         processor->state = PROCESSOR_OFF_LINE;
 323         if (processor == pset->low_hint)
 324                 pset->low_hint = PROCESSOR_NULL;
 325         (void)hw_atomic_sub(&processor_avail_count, 1);
 326         pset_unlock(pset);
 327         ml_cpu_down();
 328
 329         cpu_sleep();
 330         panic("zombie processor");
 331         /*NOTREACHED*/
 332 }
 333
 334 kern_return_t
 335 host_get_boot_info(
 336         host_priv_t         host_priv,
 337         kernel_boot_info_t  boot_info)
 338 {
 339         const char *src = "";
 340         if (host_priv == HOST_PRIV_NULL)
 341                 return (KERN_INVALID_HOST);
 342
 343         assert(host_priv == &realhost);
 344
 345         /*
 346          * Copy first operator string terminated by '\0' followed by
 347          *      standardized strings generated from boot string.
 348          */
 349         src = machine_boot_info(boot_info, KERNEL_BOOT_INFO_MAX);
 350         if (src != boot_info)
 351                 (void) strncpy(boot_info, src, KERNEL_BOOT_INFO_MAX);
 352
 353         return (KERN_SUCCESS);
 354 }