osfmk/chud/chud_xnu.h

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