osfmk/chud/chud_xnu.h

   1 /*
   2  * Copyright (c) 2003-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 #ifndef _CHUD_XNU_H_
  30 #define _CHUD_XNU_H_
  31
  32 #include <stdint.h>
  33 #include <mach/boolean.h>
  34 #include <mach/mach_types.h>
  35 #include <kern/thread_call.h>
  36
  37 #if 0
  38 #pragma mark **** version ****
  39 #endif
  40 extern uint32_t chudxnu_version(void);
  41
  42 #if 0
  43 #pragma mark **** task ****
  44 #endif
  45 // ********************************************************************************
  46 // task
  47 // ********************************************************************************
  48 extern task_t chudxnu_task_for_pid(int pid);
  49 extern int chudxnu_pid_for_task(task_t task);
  50 extern int chudxnu_current_pid(void);
  51 extern task_t chudxnu_current_task(void);
  52
  53 extern kern_return_t chudxnu_task_read(task_t task, void *kernaddr, uint64_t usraddr, vm_size_t size);
  54 extern kern_return_t chudxnu_task_write(task_t task, uint64_t useraddr, void *kernaddr, vm_size_t size);
  55 extern kern_return_t chudxnu_kern_read(void *destaddr, vm_offset_t srcaddr, vm_size_t size);
  56 extern kern_return_t chudxnu_kern_write(vm_offset_t destaddr, void *srcaddr, vm_size_t size);
  57
  58 extern boolean_t chudxnu_is_64bit_task(task_t task);
  59
  60 #if 0
  61 #pragma mark **** thread ****
  62 #endif
  63 // ********************************************************************************
  64 // thread
  65 // ********************************************************************************
  66 extern thread_t chudxnu_current_thread(void);
  67 extern task_t chudxnu_task_for_thread(thread_t thread);
  68
  69 extern kern_return_t chudxnu_bind_thread(thread_t thread, int cpu, int options);
  70 extern kern_return_t chudxnu_unbind_thread(thread_t thread, int options);
  71
  72 extern kern_return_t chudxnu_thread_get_state(thread_t thread, thread_flavor_t flavor, thread_state_t tstate, mach_msg_type_number_t *count, boolean_t user_only);
  73 extern kern_return_t chudxnu_thread_set_state(thread_t thread, thread_flavor_t flavor, thread_state_t tstate, mach_msg_type_number_t count, boolean_t user_only);
  74
  75 extern kern_return_t chudxnu_thread_get_callstack64(thread_t thread, uint64_t *callStack, mach_msg_type_number_t *count, boolean_t user_only);
  76
  77 extern kern_return_t chudxnu_all_tasks(task_array_t *task_list, mach_msg_type_number_t *count);
  78 extern kern_return_t chudxnu_free_task_list(task_array_t *task_list, mach_msg_type_number_t     *count);
  79
  80 extern kern_return_t chudxnu_all_threads(thread_array_t *thread_list, mach_msg_type_number_t *count);
  81 extern kern_return_t chudxnu_task_threads(task_t task, thread_array_t *thread_list, mach_msg_type_number_t *count);
  82 extern kern_return_t chudxnu_free_thread_list(thread_array_t *thread_list, mach_msg_type_number_t *count);
  83
  84 extern kern_return_t chudxnu_thread_info(  thread_t thread, thread_flavor_t flavor, thread_info_t thread_info_out, mach_msg_type_number_t *thread_info_count);
  85
  86 extern boolean_t chudxnu_thread_set_marked(thread_t thread, boolean_t marked);
  87 extern boolean_t chudxnu_thread_get_marked(thread_t thread);
  88 extern boolean_t chudxnu_thread_get_idle(thread_t thread);
  89
  90 enum {
  91         CHUDXNU_TS_RUNNING = 0x1,
  92         CHUDXNU_TS_RUNNABLE = 0x2,
  93         CHUDXNU_TS_WAIT = 0x4,
  94         CHUDXNU_TS_UNINT = 0x8,
  95         CHUDXNU_TS_SUSP = 0x10,
  96         CHUDXNU_TS_TERMINATE = 0x20,
  97         CHUDXNU_TS_IDLE = 0x40
  98 };
  99
 100 extern int chudxnu_thread_get_scheduler_state(thread_t thread);
 101
 102 #if 0
 103 #pragma mark **** memory ****
 104 #endif
 105 // ********************************************************************************
 106 // memory
 107 // ********************************************************************************
 108
 109 extern uint64_t chudxnu_avail_memory_size(void);
 110 extern uint64_t chudxnu_phys_memory_size(void);
 111 extern uint64_t chudxnu_free_memory_size(void);
 112 extern uint64_t chudxnu_inactive_memory_size(void);
 113
 114 #if 0
 115 #pragma mark **** cpu ****
 116 #endif
 117 // ********************************************************************************
 118 // cpu
 119 // ********************************************************************************
 120 extern int chudxnu_logical_cpu_count(void);
 121 extern int chudxnu_phys_cpu_count(void);
 122 extern int chudxnu_cpu_number(void);
 123
 124 extern kern_return_t chudxnu_enable_cpu(int cpu, boolean_t enable);
 125
 126 extern boolean_t chudxnu_set_interrupts_enabled(boolean_t enable);
 127 extern void chudxnu_cause_interrupt(void);
 128
 129 extern void chudxnu_enable_preemption(void);
 130 extern void chudxnu_disable_preemption(void);
 131 extern int chudxnu_get_preemption_level(void);
 132
 133 extern kern_return_t chudxnu_perfmon_acquire_facility(task_t);
 134 extern kern_return_t chudxnu_perfmon_release_facility(task_t);
 135
 136 typedef struct {
 137     uint32_t hwResets;
 138     uint32_t hwMachineChecks;
 139     uint32_t hwDSIs;
 140     uint32_t hwISIs;
 141     uint32_t hwExternals;
 142     uint32_t hwAlignments;
 143     uint32_t hwPrograms;
 144     uint32_t hwFloatPointUnavailable;
 145     uint32_t hwDecrementers;
 146     uint32_t hwIOErrors;
 147     uint32_t hwSystemCalls;
 148     uint32_t hwTraces;
 149     uint32_t hwFloatingPointAssists;
 150     uint32_t hwPerformanceMonitors;
 151     uint32_t hwAltivecs;
 152     uint32_t hwInstBreakpoints;
 153     uint32_t hwSystemManagements;
 154     uint32_t hwAltivecAssists;
 155     uint32_t hwThermal;
 156     uint32_t hwSoftPatches;
 157     uint32_t hwMaintenances;
 158     uint32_t hwInstrumentations;
 159 } interrupt_counters_t;
 160
 161 extern kern_return_t chudxnu_get_cpu_interrupt_counters(int cpu, interrupt_counters_t *rupts);
 162 extern kern_return_t chudxnu_clear_cpu_interrupt_counters(int cpu);
 163
 164 #if 0
 165 #pragma mark **** callbacks ****
 166 #endif
 167 // ********************************************************************************
 168 // callbacks
 169 // ********************************************************************************
 170
 171 extern void chudxnu_cancel_all_callbacks(void);
 172
 173 // cpu timer - each cpu has its own callback
 174 typedef kern_return_t (*chudxnu_cpu_timer_callback_func_t)(thread_flavor_t flavor, thread_state_t tstate,  mach_msg_type_number_t count);
 175 extern kern_return_t chudxnu_cpu_timer_callback_enter(chudxnu_cpu_timer_callback_func_t func, uint32_t time, uint32_t units); // callback is entered on current cpu
 176 extern kern_return_t chudxnu_cpu_timer_callback_cancel(void); // callback is cleared on current cpu
 177 extern kern_return_t chudxnu_cpu_timer_callback_cancel_all(void); // callback is cleared on all cpus
 178
 179 enum {
 180     PPC_TRAP_PROGRAM            = 0x700,
 181     PPC_TRAP_TRACE              = 0xD00,
 182     PPC_TRAP_PERFMON            = 0xF00,
 183 };
 184
 185 enum {
 186         X86_TRAP_DEBUG                  = 0x1,
 187 };
 188
 189 // trap callback - one callback for system
 190 typedef kern_return_t (*chudxnu_trap_callback_func_t)(uint32_t trapentry, thread_flavor_t flavor, thread_state_t tstate,  mach_msg_type_number_t count);
 191 extern kern_return_t chudxnu_trap_callback_enter(chudxnu_trap_callback_func_t func);
 192 extern kern_return_t chudxnu_trap_callback_cancel(void);
 193
 194 enum {
 195     PPC_INTERRUPT_DECREMENTER   = 0x900,
 196     PPC_INTERRUPT_INTERRUPT     = 0x500,
 197     PPC_INTERRUPT_CPU_SIGNAL    = 0x2200,
 198 };
 199
 200 enum {
 201     X86_INTERRUPT_PERFMON       = 0xB,
 202 };
 203
 204 // interrupt callback - one callback for system
 205 typedef kern_return_t (*chudxnu_interrupt_callback_func_t)(uint32_t trapentry, thread_flavor_t flavor, thread_state_t tstate,  mach_msg_type_number_t count);
 206 extern kern_return_t chudxnu_interrupt_callback_enter(chudxnu_interrupt_callback_func_t func);
 207 extern kern_return_t chudxnu_interrupt_callback_cancel(void);
 208
 209 // ast callback - one callback for system
 210 typedef kern_return_t (*chudxnu_perfmon_ast_callback_func_t)(thread_flavor_t flavor, thread_state_t tstate,  mach_msg_type_number_t count);
 211 extern kern_return_t chudxnu_perfmon_ast_callback_enter(chudxnu_perfmon_ast_callback_func_t func);
 212 extern kern_return_t chudxnu_perfmon_ast_callback_cancel(void);
 213 extern kern_return_t chudxnu_perfmon_ast_send_urgent(boolean_t urgent);
 214
 215 // cpusig callback - one callback for system
 216 typedef kern_return_t (*chudxnu_cpusig_callback_func_t)(int request, thread_flavor_t flavor, thread_state_t tstate, mach_msg_type_number_t count);
 217 extern kern_return_t chudxnu_cpusig_callback_enter(chudxnu_cpusig_callback_func_t func);
 218 extern kern_return_t chudxnu_cpusig_callback_cancel(void);
 219 extern kern_return_t chudxnu_cpusig_send(int otherCPU, uint32_t request);
 220
 221 // kdebug callback - one callback for system
 222 typedef kern_return_t (*chudxnu_kdebug_callback_func_t)(uint32_t debugid, uintptr_t arg0, uintptr_t arg1, uintptr_t arg2, uintptr_t arg3, uintptr_t arg4);
 223 extern kern_return_t chudxnu_kdebug_callback_enter(chudxnu_kdebug_callback_func_t func);
 224 extern kern_return_t chudxnu_kdebug_callback_cancel(void);
 225
 226 // timer callback - multiple callbacks
 227 typedef kern_return_t (*chudxnu_timer_callback_func_t)(thread_call_param_t param0, thread_call_param_t param1);
 228 typedef void *  chud_timer_t;
 229 extern chud_timer_t chudxnu_timer_alloc(chudxnu_timer_callback_func_t func, thread_call_param_t param0);
 230 extern kern_return_t chudxnu_timer_callback_enter(chud_timer_t timer, thread_call_param_t param1, uint32_t time, uint32_t units);
 231 extern kern_return_t chudxnu_timer_callback_cancel(chud_timer_t timer);
 232 extern kern_return_t chudxnu_timer_free(chud_timer_t timer);
 233
 234 // CHUD systemcall callback - one callback for system
 235 typedef kern_return_t (*chudxnu_syscall_callback_func_t)(uint64_t code, uint64_t arg1, uint64_t arg2, uint64_t arg3, uint64_t arg4, uint64_t arg5);
 236 extern kern_return_t chudxnu_syscall_callback_enter(chudxnu_syscall_callback_func_t func);
 237 extern kern_return_t chudxnu_syscall_callback_cancel(void);
 238
 239 // DTrace Triggering
 240 typedef kern_return_t (*chudxnu_dtrace_callback_t)(uint64_t selector, uint64_t *args, uint32_t count);
 241 extern int chudxnu_dtrace_callback(uint64_t selector, uint64_t *args, uint32_t count);
 242 extern kern_return_t chudxnu_dtrace_callback_enter(chudxnu_dtrace_callback_t fn);
 243 extern void chudxnu_dtrace_callback_cancel(void);
 244
 245 // ********************************************************************************
 246 // DEPRECATED
 247 // ********************************************************************************
 248 extern kern_return_t chudxnu_thread_get_callstack(thread_t thread, uint32_t *callStack, mach_msg_type_number_t *count, boolean_t user_only);
 249
 250 extern kern_return_t chudxnu_set_shadowed_spr(int cpu, int spr, uint32_t val);
 251 extern kern_return_t chudxnu_set_shadowed_spr64(int cpu, int spr, uint64_t val);
 252
 253 extern kern_return_t chudxnu_enable_cpu_nap(int cpu, boolean_t enable);
 254 extern boolean_t chudxnu_cpu_nap_enabled(int cpu);
 255
 256 extern kern_return_t chudxnu_read_spr(int cpu, int spr, uint32_t *val_p);
 257 extern kern_return_t chudxnu_read_spr64(int cpu, int spr, uint64_t *val_p);
 258 extern kern_return_t chudxnu_write_spr(int cpu, int spr, uint32_t val);
 259 extern kern_return_t chudxnu_write_spr64(int cpu, int spr, uint64_t val);
 260
 261 #endif /* _CHUD_XNU_H_ */