osfmk/kern/machine.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 #ifndef _KERN_MACHINE_H_
  33 #define _KERN_MACHINE_H_
  34
  35 #include <mach/kern_return.h>
  36 #include <mach/processor_info.h>
  37 #include <kern/kern_types.h>
  38
  39 /*
  40  * Machine support declarations.
  41  */
  42
  43 extern void             processor_up(
  44                                         processor_t             processor);
  45
  46 extern void             processor_offline(
  47                                         processor_t             processor);
  48
  49 extern void             processor_start_thread(void *machine_param);
  50
  51 /*
  52  * Must be implemented in machine dependent code.
  53  */
  54
  55 /* Initialize machine dependent ast code */
  56 extern void init_ast_check(
  57                                         processor_t         processor);
  58
  59 /* Cause check for ast */
  60 extern void cause_ast_check(
  61                                         processor_t         processor);
  62
  63 extern kern_return_t cpu_control(
  64                                         int                 slot_num,
  65                                         processor_info_t    info,
  66                                         unsigned int        count);
  67
  68 extern void     cpu_sleep(void);
  69
  70 extern kern_return_t cpu_start(
  71                                         int                 slot_num);
  72
  73 extern void cpu_exit_wait(
  74                                         int                 slot_num);
  75
  76 extern kern_return_t cpu_info(
  77                                         processor_flavor_t  flavor,
  78                                         int                 slot_num,
  79                                         processor_info_t    info,
  80                                         unsigned int        *count);
  81
  82 extern kern_return_t cpu_info_count(
  83                                         processor_flavor_t  flavor,
  84                                         unsigned int        *count);
  85
  86 extern thread_t         machine_processor_shutdown(
  87                                                 thread_t            thread,
  88                                                 void                (*doshutdown)(processor_t),
  89                                                 processor_t         processor);
  90
  91 extern void machine_idle(void);
  92
  93 extern void machine_track_platform_idle(boolean_t);
  94
  95 /* Signals a processor to bring it out of idle */
  96 extern void machine_signal_idle(
  97                                         processor_t         processor);
  98
  99 /* Signals a processor to bring it out of idle unless canceled */
 100 extern void machine_signal_idle_deferred(
 101                                         processor_t         processor);
 102
 103 /* Cancels an outstanding machine_signal_idle_deferred, if this is supported */
 104 extern void machine_signal_idle_cancel(
 105                                         processor_t         processor);
 106
 107 extern void halt_cpu(void);
 108
 109 extern void halt_all_cpus(
 110                                         boolean_t           reboot);
 111
 112 extern char *machine_boot_info(
 113                                         char                *buf,
 114                                         vm_size_t           buf_len);
 115
 116 /*
 117  * Machine-dependent routine to fill in an array with up to callstack_max
 118  * levels of return pc information.
 119  */
 120 extern void machine_callstack(
 121                                         uintptr_t           *buf,
 122                                         vm_size_t           callstack_max);
 123
 124 extern void consider_machine_collect(void);
 125
 126 /*
 127  * Machine-dependent routine to inform platform layer and external
 128  * CPU power management about context switches
 129  */
 130
 131 extern void     machine_thread_going_on_core(thread_t   new_thread,
 132                                         int             urgency,
 133                                         uint64_t        sched_latency,
 134                                         uint64_t        dispatch_time);
 135
 136 extern void machine_thread_going_off_core(thread_t old_thread, boolean_t thread_terminating, uint64_t last_dispatch);
 137
 138 extern void machine_max_runnable_latency(uint64_t bg_max_latency,
 139                                                                                  uint64_t default_max_latency,
 140                                                                                  uint64_t realtime_max_latency);
 141
 142 extern void machine_work_interval_notify(thread_t thread,
 143                                                                                  uint64_t work_id,
 144                                                                                  uint64_t start_abstime,
 145                                                                                  uint64_t finish_abstime,
 146                                                                                  uint64_t deadline_abstime,
 147                                                                                  uint64_t next_start_abstime,
 148                                                                                  uint16_t urgency,
 149                                                                                  uint32_t flags);
 150
 151 #endif  /* _KERN_MACHINE_H_ */