2 * TCG CPU-specific operations
4 * Copyright 2021 SUSE LLC
6 * This work is licensed under the terms of the GNU GPL, version 2 or later.
7 * See the COPYING file in the top-level directory.
13 #include "hw/core/cpu.h"
17 * @initialize: Initialize TCG state
19 * Called when the first CPU is realized.
21 void (*initialize
)(void);
23 * @synchronize_from_tb: Synchronize state from a TCG #TranslationBlock
25 * This is called when we abandon execution of a TB before starting it,
26 * and must set all parts of the CPU state which the previous TB in the
27 * chain may not have updated.
28 * By default, when this is NULL, a call is made to @set_pc(tb->pc).
30 * If more state needs to be restored, the target must implement a
31 * function to restore all the state, and register it here.
33 void (*synchronize_from_tb
)(CPUState
*cpu
, const TranslationBlock
*tb
);
35 * @restore_state_to_opc: Synchronize state from INDEX_op_start_insn
37 * This is called when we unwind state in the middle of a TB,
38 * usually before raising an exception. Set all part of the CPU
39 * state which are tracked insn-by-insn in the target-specific
40 * arguments to start_insn, passed as @data.
42 void (*restore_state_to_opc
)(CPUState
*cpu
, const TranslationBlock
*tb
,
43 const uint64_t *data
);
45 /** @cpu_exec_enter: Callback for cpu_exec preparation */
46 void (*cpu_exec_enter
)(CPUState
*cpu
);
47 /** @cpu_exec_exit: Callback for cpu_exec cleanup */
48 void (*cpu_exec_exit
)(CPUState
*cpu
);
49 /** @debug_excp_handler: Callback for handling debug exceptions */
50 void (*debug_excp_handler
)(CPUState
*cpu
);
53 #ifdef CONFIG_USER_ONLY
55 * @fake_user_interrupt: Callback for 'fake exception' handling.
57 * Simulate 'fake exception' which will be handled outside the
58 * cpu execution loop (hack for x86 user mode).
60 void (*fake_user_interrupt
)(CPUState
*cpu
);
65 * @addr: faulting guest address
66 * @access_type: access was read/write/execute
67 * @maperr: true for invalid page, false for permission fault
68 * @ra: host pc for unwinding
70 * We are about to raise SIGSEGV with si_code set for @maperr,
71 * and si_addr set for @addr. Record anything further needed
72 * for the signal ucontext_t.
74 * If the emulated kernel does not provide anything to the signal
75 * handler with anything besides the user context registers, and
76 * the siginfo_t, then this hook need do nothing and may be omitted.
77 * Otherwise, record the data and return; the caller will raise
78 * the signal, unwind the cpu state, and return to the main loop.
80 * If it is simpler to re-use the sysemu tlb_fill code, @ra is provided
81 * so that a "normal" cpu exception can be raised. In this case,
82 * the signal must be raised by the architecture cpu_loop.
84 void (*record_sigsegv
)(CPUState
*cpu
, vaddr addr
,
85 MMUAccessType access_type
,
86 bool maperr
, uintptr_t ra
);
90 * @addr: misaligned guest address
91 * @access_type: access was read/write/execute
92 * @ra: host pc for unwinding
94 * We are about to raise SIGBUS with si_code BUS_ADRALN,
95 * and si_addr set for @addr. Record anything further needed
96 * for the signal ucontext_t.
98 * If the emulated kernel does not provide the signal handler with
99 * anything besides the user context registers, and the siginfo_t,
100 * then this hook need do nothing and may be omitted.
101 * Otherwise, record the data and return; the caller will raise
102 * the signal, unwind the cpu state, and return to the main loop.
104 * If it is simpler to re-use the sysemu do_unaligned_access code,
105 * @ra is provided so that a "normal" cpu exception can be raised.
106 * In this case, the signal must be raised by the architecture cpu_loop.
108 void (*record_sigbus
)(CPUState
*cpu
, vaddr addr
,
109 MMUAccessType access_type
, uintptr_t ra
);
111 /** @do_interrupt: Callback for interrupt handling. */
112 void (*do_interrupt
)(CPUState
*cpu
);
113 /** @cpu_exec_interrupt: Callback for processing interrupts in cpu_exec */
114 bool (*cpu_exec_interrupt
)(CPUState
*cpu
, int interrupt_request
);
116 * @tlb_fill: Handle a softmmu tlb miss
118 * If the access is valid, call tlb_set_page and return true;
119 * if the access is invalid and probe is true, return false;
120 * otherwise raise an exception and do not return.
122 bool (*tlb_fill
)(CPUState
*cpu
, vaddr address
, int size
,
123 MMUAccessType access_type
, int mmu_idx
,
124 bool probe
, uintptr_t retaddr
);
126 * @do_transaction_failed: Callback for handling failed memory transactions
127 * (ie bus faults or external aborts; not MMU faults)
129 void (*do_transaction_failed
)(CPUState
*cpu
, hwaddr physaddr
, vaddr addr
,
130 unsigned size
, MMUAccessType access_type
,
131 int mmu_idx
, MemTxAttrs attrs
,
132 MemTxResult response
, uintptr_t retaddr
);
134 * @do_unaligned_access: Callback for unaligned access handling
135 * The callback must exit via raising an exception.
137 G_NORETURN
void (*do_unaligned_access
)(CPUState
*cpu
, vaddr addr
,
138 MMUAccessType access_type
,
139 int mmu_idx
, uintptr_t retaddr
);
142 * @adjust_watchpoint_address: hack for cpu_check_watchpoint used by ARM
144 vaddr (*adjust_watchpoint_address
)(CPUState
*cpu
, vaddr addr
, int len
);
147 * @debug_check_watchpoint: return true if the architectural
148 * watchpoint whose address has matched should really fire, used by ARM
151 bool (*debug_check_watchpoint
)(CPUState
*cpu
, CPUWatchpoint
*wp
);
154 * @debug_check_breakpoint: return true if the architectural
155 * breakpoint whose PC has matched should really fire.
157 bool (*debug_check_breakpoint
)(CPUState
*cpu
);
160 * @io_recompile_replay_branch: Callback for cpu_io_recompile.
162 * The cpu has been stopped, and cpu_restore_state_from_tb has been
163 * called. If the faulting instruction is in a delay slot, and the
164 * target architecture requires re-execution of the branch, then
165 * adjust the cpu state as required and return true.
167 bool (*io_recompile_replay_branch
)(CPUState
*cpu
,
168 const TranslationBlock
*tb
);
169 #endif /* !CONFIG_USER_ONLY */
170 #endif /* NEED_CPU_H */
174 #if defined(CONFIG_USER_ONLY)
176 static inline void cpu_check_watchpoint(CPUState
*cpu
, vaddr addr
, vaddr len
,
177 MemTxAttrs atr
, int fl
, uintptr_t ra
)
181 static inline int cpu_watchpoint_address_matches(CPUState
*cpu
,
182 vaddr addr
, vaddr len
)
190 * cpu_check_watchpoint:
192 * @addr: guest virtual address
193 * @len: access length
194 * @attrs: memory access attributes
195 * @flags: watchpoint access type
196 * @ra: unwind return address
198 * Check for a watchpoint hit in [addr, addr+len) of the type
199 * specified by @flags. Exit via exception with a hit.
201 void cpu_check_watchpoint(CPUState
*cpu
, vaddr addr
, vaddr len
,
202 MemTxAttrs attrs
, int flags
, uintptr_t ra
);
205 * cpu_watchpoint_address_matches:
207 * @addr: guest virtual address
208 * @len: access length
210 * Return the watchpoint flags that apply to [addr, addr+len).
211 * If no watchpoint is registered for the range, the result is 0.
213 int cpu_watchpoint_address_matches(CPUState
*cpu
, vaddr addr
, vaddr len
);
217 #endif /* TCG_CPU_OPS_H */