]> git.saurik.com Git - apple/xnu.git/blame - osfmk/chud/chud_xnu.h
xnu-792.13.8.tar.gz
[apple/xnu.git] / osfmk / chud / chud_xnu.h
CommitLineData
5d5c5d0d
A
1/*
2 * Copyright (c) 2003 Apple Computer, Inc. All rights reserved.
3 *
4 * @APPLE_LICENSE_OSREFERENCE_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
10 * License may not be used to create, or enable the creation or
11 * redistribution of, unlawful or unlicensed copies of an Apple operating
12 * system, or to circumvent, violate, or enable the circumvention or
13 * violation of, any terms of an Apple operating system software license
14 * agreement.
15 *
16 * Please obtain a copy of the License at
17 * http://www.opensource.apple.com/apsl/ and read it before using this
18 * file.
19 *
20 * The Original Code and all software distributed under the License are
21 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
22 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
23 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
24 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
25 * Please see the License for the specific language governing rights and
26 * limitations under the License.
27 *
28 * @APPLE_LICENSE_OSREFERENCE_HEADER_END@
29 */
30
31#ifndef _CHUD_XNU_H_
32#define _CHUD_XNU_H_
33
34
35#include <stdint.h>
36#include <mach/boolean.h>
37#include <mach/mach_types.h>
38
39#pragma mark **** version ****
40extern uint32_t chudxnu_version(void);
41
42#pragma mark **** task ****
43// ********************************************************************************
44// task
45// ********************************************************************************
46extern int chudxnu_pid_for_task(task_t task);
47extern task_t chudxnu_task_for_pid(int pid);
48extern int chudxnu_current_pid(void);
49
50extern kern_return_t chudxnu_task_read(task_t task, void *kernaddr, uint64_t usraddr, vm_size_t size);
51extern kern_return_t chudxnu_task_write(task_t task, uint64_t useraddr, void *kernaddr, vm_size_t size);
52extern kern_return_t chudxnu_kern_read(void *destaddr, vm_offset_t srcaddr, vm_size_t size);
53extern kern_return_t chudxnu_kern_write(vm_offset_t destaddr, void *srcaddr, vm_size_t size);
54
55extern boolean_t chudxnu_is_64bit_task(task_t task);
56
57#pragma mark **** thread ****
58// ********************************************************************************
59// thread
60// ********************************************************************************
61extern kern_return_t chudxnu_bind_thread(thread_t thread, int cpu);
62extern kern_return_t chudxnu_unbind_thread(thread_t thread);
63
64extern 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);
65extern 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);
66extern kern_return_t chudxnu_thread_user_state_available(thread_t thread);
67
68extern kern_return_t chudxnu_thread_get_callstack(thread_t thread, uint32_t *callStack, mach_msg_type_number_t *count, boolean_t user_only);
69extern kern_return_t chudxnu_thread_get_callstack64(thread_t thread, uint64_t *callStack, mach_msg_type_number_t *count, boolean_t user_only);
70
71extern task_t chudxnu_current_task(void);
72extern thread_t chudxnu_current_thread(void);
73
74extern task_t chudxnu_task_for_thread(thread_t thread);
75
76extern kern_return_t chudxnu_all_tasks(task_array_t *task_list, mach_msg_type_number_t *count);
77extern kern_return_t chudxnu_free_task_list(task_array_t *task_list, mach_msg_type_number_t *count);
78
79extern kern_return_t chudxnu_all_threads(thread_array_t *thread_list, mach_msg_type_number_t *count);
80extern kern_return_t chudxnu_task_threads(task_t task, thread_array_t *thread_list, mach_msg_type_number_t *count);
81extern kern_return_t chudxnu_free_thread_list(thread_array_t *thread_list, mach_msg_type_number_t *count);
82
83extern 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);
84
85extern kern_return_t chudxnu_thread_last_context_switch(thread_t thread, uint64_t *timestamp);
86
87#pragma mark **** memory ****
88// ********************************************************************************
89// memory
90// ********************************************************************************
91
92extern uint64_t chudxnu_avail_memory_size(void);
93extern uint64_t chudxnu_phys_memory_size(void);
94extern uint64_t chudxnu_free_memory_size(void);
95
96extern vm_offset_t chudxnu_io_map(uint64_t phys_addr, vm_size_t size);
97
98extern uint32_t chudxnu_phys_addr_wimg(uint64_t phys_addr);
99
100#pragma mark **** cpu ****
101// ********************************************************************************
102// cpu
103// ********************************************************************************
104extern int chudxnu_avail_cpu_count(void);
105extern int chudxnu_phys_cpu_count(void);
106extern int chudxnu_cpu_number(void);
107
108extern kern_return_t chudxnu_enable_cpu(int cpu, boolean_t enable);
109
110extern kern_return_t chudxnu_enable_cpu_nap(int cpu, boolean_t enable);
111extern boolean_t chudxnu_cpu_nap_enabled(int cpu);
112
113extern boolean_t chudxnu_get_interrupts_enabled(void);
114extern boolean_t chudxnu_set_interrupts_enabled(boolean_t enable);
115extern boolean_t chudxnu_at_interrupt_context(void);
116extern void chudxnu_cause_interrupt(void);
117
118extern void chudxnu_enable_preemption(void);
119extern void chudxnu_disable_preemption(void);
120extern int chudxnu_get_preemption_level(void);
121
122extern kern_return_t chudxnu_set_shadowed_spr(int cpu, int spr, uint32_t val);
123extern kern_return_t chudxnu_set_shadowed_spr64(int cpu, int spr, uint64_t val);
124
125extern uint32_t chudxnu_get_orig_cpu_l2cr(int cpu);
126extern uint32_t chudxnu_get_orig_cpu_l3cr(int cpu);
127
128extern kern_return_t chudxnu_read_spr(int cpu, int spr, uint32_t *val_p);
129extern kern_return_t chudxnu_read_spr64(int cpu, int spr, uint64_t *val_p);
130extern kern_return_t chudxnu_write_spr(int cpu, int spr, uint32_t val);
131extern kern_return_t chudxnu_write_spr64(int cpu, int spr, uint64_t val);
132
133extern void chudxnu_flush_caches(void);
134extern void chudxnu_enable_caches(boolean_t enable);
135
136extern kern_return_t chudxnu_perfmon_acquire_facility(task_t);
137extern kern_return_t chudxnu_perfmon_release_facility(task_t);
138
139extern uint32_t * chudxnu_get_branch_trace_buffer(uint32_t *entries);
140
141typedef struct {
142 uint32_t hwResets;
143 uint32_t hwMachineChecks;
144 uint32_t hwDSIs;
145 uint32_t hwISIs;
146 uint32_t hwExternals;
147 uint32_t hwAlignments;
148 uint32_t hwPrograms;
149 uint32_t hwFloatPointUnavailable;
150 uint32_t hwDecrementers;
151 uint32_t hwIOErrors;
152 uint32_t hwSystemCalls;
153 uint32_t hwTraces;
154 uint32_t hwFloatingPointAssists;
155 uint32_t hwPerformanceMonitors;
156 uint32_t hwAltivecs;
157 uint32_t hwInstBreakpoints;
158 uint32_t hwSystemManagements;
159 uint32_t hwAltivecAssists;
160 uint32_t hwThermal;
161 uint32_t hwSoftPatches;
162 uint32_t hwMaintenances;
163 uint32_t hwInstrumentations;
164} rupt_counters_t;
165
166extern kern_return_t chudxnu_get_cpu_rupt_counters(int cpu, rupt_counters_t *rupts);
167extern kern_return_t chudxnu_clear_cpu_rupt_counters(int cpu);
168
169extern kern_return_t chudxnu_passup_alignment_exceptions(boolean_t enable);
170
171extern kern_return_t chudxnu_scom_read(uint32_t reg, uint64_t *data);
172extern kern_return_t chudxnu_scom_write(uint32_t reg, uint64_t data);
173
174#pragma mark **** callbacks ****
175// ********************************************************************************
176// callbacks
177// ********************************************************************************
178
179extern void chudxnu_cancel_all_callbacks(void);
180
181// cpu timer - each cpu has its own callback
182typedef kern_return_t (*chudxnu_cpu_timer_callback_func_t)(thread_flavor_t flavor, thread_state_t tstate, mach_msg_type_number_t count);
183extern 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
184extern kern_return_t chudxnu_cpu_timer_callback_cancel(void); // callback is cleared on current cpu
185extern kern_return_t chudxnu_cpu_timer_callback_cancel_all(void); // callback is cleared on all cpus
186
187enum {
188 PPC_TRAP_PROGRAM = 0x700,
189 PPC_TRAP_TRACE = 0xD00,
190 PPC_TRAP_PERFMON = 0xF00,
191};
192
193enum {
194 X86_TRAP_DEBUG = 0x1,
195};
196
197// trap callback - one callback for system
198typedef 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);
199extern kern_return_t chudxnu_trap_callback_enter(chudxnu_trap_callback_func_t func);
200extern kern_return_t chudxnu_trap_callback_cancel(void);
201
202enum {
203 PPC_INTERRUPT_DECREMENTER = 0x900,
204 PPC_INTERRUPT_INTERRUPT = 0x500,
205 PPC_INTERRUPT_CPU_SIGNAL = 0x2200,
206};
207
208enum {
209 X86_INTERRUPT_PERFMON = 0xB,
210};
211
212// interrupt callback - one callback for system
213typedef 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);
214extern kern_return_t chudxnu_interrupt_callback_enter(chudxnu_interrupt_callback_func_t func);
215extern kern_return_t chudxnu_interrupt_callback_cancel(void);
216
217// ast callback - one callback for system
218typedef kern_return_t (*chudxnu_perfmon_ast_callback_func_t)(thread_flavor_t flavor, thread_state_t tstate, mach_msg_type_number_t count);
219extern kern_return_t chudxnu_perfmon_ast_callback_enter(chudxnu_perfmon_ast_callback_func_t func);
220extern kern_return_t chudxnu_perfmon_ast_callback_cancel(void);
221extern kern_return_t chudxnu_perfmon_ast_send(void);
222extern kern_return_t chudxnu_perfmon_ast_send_urgent(boolean_t urgent);
223
224// cpusig callback - one callback for system
225typedef kern_return_t (*chudxnu_cpusig_callback_func_t)(int request, thread_flavor_t flavor, thread_state_t tstate, mach_msg_type_number_t count);
226extern kern_return_t chudxnu_cpusig_callback_enter(chudxnu_cpusig_callback_func_t func);
227extern kern_return_t chudxnu_cpusig_callback_cancel(void);
228extern kern_return_t chudxnu_cpusig_send(int otherCPU, uint32_t request);
229
230// kdebug callback - one callback for system
231typedef 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);
232extern kern_return_t chudxnu_kdebug_callback_enter(chudxnu_kdebug_callback_func_t func);
233extern kern_return_t chudxnu_kdebug_callback_cancel(void);
234
235// timer callback - multiple callbacks
236typedef kern_return_t (*chudxnu_timer_callback_func_t)(uint32_t param0, uint32_t param1);
237typedef void * chud_timer_t;
238extern chud_timer_t chudxnu_timer_alloc(chudxnu_timer_callback_func_t func, uint32_t param0);
239extern kern_return_t chudxnu_timer_callback_enter(chud_timer_t timer, uint32_t param1, uint32_t time, uint32_t units);
240extern kern_return_t chudxnu_timer_callback_cancel(chud_timer_t timer);
241extern kern_return_t chudxnu_timer_free(chud_timer_t timer);
242
243// CHUD systemcall callback - one callback for system
244//typedef kern_return_t (*chudxnu_syscall_callback_func_t)(thread_flavor_t flavor, thread_state_t tstate, mach_msg_type_number_t count); // v2
245typedef 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);
246extern kern_return_t chudxnu_syscall_callback_enter(chudxnu_syscall_callback_func_t func);
247extern kern_return_t chudxnu_syscall_callback_cancel(void);
248
249// ********************************************************************************
250// DEPRECATED
251// ********************************************************************************
252extern kern_return_t chudxnu_bind_current_thread(int cpu);
253
254extern kern_return_t chudxnu_unbind_current_thread(void);
255
256extern kern_return_t chudxnu_current_thread_get_callstack(uint32_t *callStack, mach_msg_type_number_t *count, boolean_t user_only);
257
258extern thread_t chudxnu_current_act(void);
259
260// thread timer callback - one callback for system
261typedef kern_return_t (*chudxnu_thread_timer_callback_func_t)(uint32_t param);
262extern kern_return_t chudxnu_thread_timer_callback_enter(chudxnu_thread_timer_callback_func_t func, uint32_t param, uint32_t time, uint32_t units);
263extern kern_return_t chudxnu_thread_timer_callback_cancel(void);
264
265#endif /* _CHUD_XNU_H_ */