4 * Copyright (c) 2012 SUSE LINUX Products GmbH
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version 2
9 * of the License, or (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, see
18 * <http://www.gnu.org/licenses/gpl-2.0.html>
23 #include "hw/qdev-core.h"
24 #include "disas/dis-asm.h"
25 #include "exec/hwaddr.h"
26 #include "exec/memattrs.h"
27 #include "qapi/qapi-types-run-state.h"
28 #include "qemu/bitmap.h"
29 #include "qemu/rcu_queue.h"
30 #include "qemu/queue.h"
31 #include "qemu/thread.h"
33 typedef int (*WriteCoreDumpFunction
)(const void *buf
, size_t size
,
38 * Type wide enough to contain any #target_ulong virtual address.
40 typedef uint64_t vaddr
;
41 #define VADDR_PRId PRId64
42 #define VADDR_PRIu PRIu64
43 #define VADDR_PRIo PRIo64
44 #define VADDR_PRIx PRIx64
45 #define VADDR_PRIX PRIX64
46 #define VADDR_MAX UINT64_MAX
50 * @section_id: QEMU-cpu
52 * @short_description: Base class for all CPUs
55 #define TYPE_CPU "cpu"
57 /* Since this macro is used a lot in hot code paths and in conjunction with
58 * FooCPU *foo_env_get_cpu(), we deviate from usual QOM practice by using
61 #define CPU(obj) ((CPUState *)(obj))
63 #define CPU_CLASS(class) OBJECT_CLASS_CHECK(CPUClass, (class), TYPE_CPU)
64 #define CPU_GET_CLASS(obj) OBJECT_GET_CLASS(CPUClass, (obj), TYPE_CPU)
66 typedef enum MMUAccessType
{
72 typedef struct CPUWatchpoint CPUWatchpoint
;
74 typedef void (*CPUUnassignedAccess
)(CPUState
*cpu
, hwaddr addr
,
75 bool is_write
, bool is_exec
, int opaque
,
78 struct TranslationBlock
;
82 * @class_by_name: Callback to map -cpu command line model name to an
83 * instantiatable CPU type.
84 * @parse_features: Callback to parse command line arguments.
85 * @reset: Callback to reset the #CPUState to its initial state.
86 * @reset_dump_flags: #CPUDumpFlags to use for reset logging.
87 * @has_work: Callback for checking if there is work to do.
88 * @do_interrupt: Callback for interrupt handling.
89 * @do_unassigned_access: Callback for unassigned access handling.
90 * (this is deprecated: new targets should use do_transaction_failed instead)
91 * @do_unaligned_access: Callback for unaligned access handling, if
92 * the target defines #ALIGNED_ONLY.
93 * @do_transaction_failed: Callback for handling failed memory transactions
94 * (ie bus faults or external aborts; not MMU faults)
95 * @virtio_is_big_endian: Callback to return %true if a CPU which supports
96 * runtime configurable endianness is currently big-endian. Non-configurable
97 * CPUs can use the default implementation of this method. This method should
98 * not be used by any callers other than the pre-1.0 virtio devices.
99 * @memory_rw_debug: Callback for GDB memory access.
100 * @dump_state: Callback for dumping state.
101 * @dump_statistics: Callback for dumping statistics.
102 * @get_arch_id: Callback for getting architecture-dependent CPU ID.
103 * @get_paging_enabled: Callback for inquiring whether paging is enabled.
104 * @get_memory_mapping: Callback for obtaining the memory mappings.
105 * @set_pc: Callback for setting the Program Counter register. This
106 * should have the semantics used by the target architecture when
107 * setting the PC from a source such as an ELF file entry point;
108 * for example on Arm it will also set the Thumb mode bit based
109 * on the least significant bit of the new PC value.
110 * If the target behaviour here is anything other than "set
111 * the PC register to the value passed in" then the target must
112 * also implement the synchronize_from_tb hook.
113 * @synchronize_from_tb: Callback for synchronizing state from a TCG
114 * #TranslationBlock. This is called when we abandon execution
115 * of a TB before starting it, and must set all parts of the CPU
116 * state which the previous TB in the chain may not have updated.
117 * This always includes at least the program counter; some targets
118 * will need to do more. If this hook is not implemented then the
119 * default is to call @set_pc(tb->pc).
120 * @tlb_fill: Callback for handling a softmmu tlb miss or user-only
121 * address fault. For system mode, if the access is valid, call
122 * tlb_set_page and return true; if the access is invalid, and
123 * probe is true, return false; otherwise raise an exception and
124 * do not return. For user-only mode, always raise an exception
126 * @get_phys_page_debug: Callback for obtaining a physical address.
127 * @get_phys_page_attrs_debug: Callback for obtaining a physical address and the
128 * associated memory transaction attributes to use for the access.
129 * CPUs which use memory transaction attributes should implement this
130 * instead of get_phys_page_debug.
131 * @asidx_from_attrs: Callback to return the CPU AddressSpace to use for
132 * a memory access with the specified memory transaction attributes.
133 * @gdb_read_register: Callback for letting GDB read a register.
134 * @gdb_write_register: Callback for letting GDB write a register.
135 * @debug_check_watchpoint: Callback: return true if the architectural
136 * watchpoint whose address has matched should really fire.
137 * @debug_excp_handler: Callback for handling debug exceptions.
138 * @write_elf64_note: Callback for writing a CPU-specific ELF note to a
139 * 64-bit VM coredump.
140 * @write_elf32_qemunote: Callback for writing a CPU- and QEMU-specific ELF
141 * note to a 32-bit VM coredump.
142 * @write_elf32_note: Callback for writing a CPU-specific ELF note to a
143 * 32-bit VM coredump.
144 * @write_elf32_qemunote: Callback for writing a CPU- and QEMU-specific ELF
145 * note to a 32-bit VM coredump.
146 * @vmsd: State description for migration.
147 * @gdb_num_core_regs: Number of core registers accessible to GDB.
148 * @gdb_core_xml_file: File name for core registers GDB XML description.
149 * @gdb_stop_before_watchpoint: Indicates whether GDB expects the CPU to stop
150 * before the insn which triggers a watchpoint rather than after it.
151 * @gdb_arch_name: Optional callback that returns the architecture name known
152 * to GDB. The caller must free the returned string with g_free.
153 * @gdb_get_dynamic_xml: Callback to return dynamically generated XML for the
154 * gdb stub. Returns a pointer to the XML contents for the specified XML file
155 * or NULL if the CPU doesn't have a dynamically generated content for it.
156 * @cpu_exec_enter: Callback for cpu_exec preparation.
157 * @cpu_exec_exit: Callback for cpu_exec cleanup.
158 * @cpu_exec_interrupt: Callback for processing interrupts in cpu_exec.
159 * @disas_set_info: Setup architecture specific components of disassembly info
160 * @adjust_watchpoint_address: Perform a target-specific adjustment to an
161 * address before attempting to match it against watchpoints.
163 * Represents a CPU family or model.
165 typedef struct CPUClass
{
167 DeviceClass parent_class
;
170 ObjectClass
*(*class_by_name
)(const char *cpu_model
);
171 void (*parse_features
)(const char *typename
, char *str
, Error
**errp
);
173 void (*reset
)(CPUState
*cpu
);
174 int reset_dump_flags
;
175 bool (*has_work
)(CPUState
*cpu
);
176 void (*do_interrupt
)(CPUState
*cpu
);
177 CPUUnassignedAccess do_unassigned_access
;
178 void (*do_unaligned_access
)(CPUState
*cpu
, vaddr addr
,
179 MMUAccessType access_type
,
180 int mmu_idx
, uintptr_t retaddr
);
181 void (*do_transaction_failed
)(CPUState
*cpu
, hwaddr physaddr
, vaddr addr
,
182 unsigned size
, MMUAccessType access_type
,
183 int mmu_idx
, MemTxAttrs attrs
,
184 MemTxResult response
, uintptr_t retaddr
);
185 bool (*virtio_is_big_endian
)(CPUState
*cpu
);
186 int (*memory_rw_debug
)(CPUState
*cpu
, vaddr addr
,
187 uint8_t *buf
, int len
, bool is_write
);
188 void (*dump_state
)(CPUState
*cpu
, FILE *, int flags
);
189 GuestPanicInformation
* (*get_crash_info
)(CPUState
*cpu
);
190 void (*dump_statistics
)(CPUState
*cpu
, int flags
);
191 int64_t (*get_arch_id
)(CPUState
*cpu
);
192 bool (*get_paging_enabled
)(const CPUState
*cpu
);
193 void (*get_memory_mapping
)(CPUState
*cpu
, MemoryMappingList
*list
,
195 void (*set_pc
)(CPUState
*cpu
, vaddr value
);
196 void (*synchronize_from_tb
)(CPUState
*cpu
, struct TranslationBlock
*tb
);
197 bool (*tlb_fill
)(CPUState
*cpu
, vaddr address
, int size
,
198 MMUAccessType access_type
, int mmu_idx
,
199 bool probe
, uintptr_t retaddr
);
200 hwaddr (*get_phys_page_debug
)(CPUState
*cpu
, vaddr addr
);
201 hwaddr (*get_phys_page_attrs_debug
)(CPUState
*cpu
, vaddr addr
,
203 int (*asidx_from_attrs
)(CPUState
*cpu
, MemTxAttrs attrs
);
204 int (*gdb_read_register
)(CPUState
*cpu
, uint8_t *buf
, int reg
);
205 int (*gdb_write_register
)(CPUState
*cpu
, uint8_t *buf
, int reg
);
206 bool (*debug_check_watchpoint
)(CPUState
*cpu
, CPUWatchpoint
*wp
);
207 void (*debug_excp_handler
)(CPUState
*cpu
);
209 int (*write_elf64_note
)(WriteCoreDumpFunction f
, CPUState
*cpu
,
210 int cpuid
, void *opaque
);
211 int (*write_elf64_qemunote
)(WriteCoreDumpFunction f
, CPUState
*cpu
,
213 int (*write_elf32_note
)(WriteCoreDumpFunction f
, CPUState
*cpu
,
214 int cpuid
, void *opaque
);
215 int (*write_elf32_qemunote
)(WriteCoreDumpFunction f
, CPUState
*cpu
,
218 const VMStateDescription
*vmsd
;
219 const char *gdb_core_xml_file
;
220 gchar
* (*gdb_arch_name
)(CPUState
*cpu
);
221 const char * (*gdb_get_dynamic_xml
)(CPUState
*cpu
, const char *xmlname
);
222 void (*cpu_exec_enter
)(CPUState
*cpu
);
223 void (*cpu_exec_exit
)(CPUState
*cpu
);
224 bool (*cpu_exec_interrupt
)(CPUState
*cpu
, int interrupt_request
);
226 void (*disas_set_info
)(CPUState
*cpu
, disassemble_info
*info
);
227 vaddr (*adjust_watchpoint_address
)(CPUState
*cpu
, vaddr addr
, int len
);
228 void (*tcg_initialize
)(void);
230 /* Keep non-pointer data at the end to minimize holes. */
231 int gdb_num_core_regs
;
232 bool gdb_stop_before_watchpoint
;
236 * Low 16 bits: number of cycles left, used only in icount mode.
237 * High 16 bits: Set to -1 to force TCG to stop executing linked TBs
238 * for this CPU and return to its top level loop (even in non-icount mode).
239 * This allows a single read-compare-cbranch-write sequence to test
240 * for both decrementer underflow and exceptions.
242 typedef union IcountDecr
{
245 #ifdef HOST_WORDS_BIGENDIAN
255 typedef struct CPUBreakpoint
{
257 int flags
; /* BP_* */
258 QTAILQ_ENTRY(CPUBreakpoint
) entry
;
261 struct CPUWatchpoint
{
266 int flags
; /* BP_* */
267 QTAILQ_ENTRY(CPUWatchpoint
) entry
;
273 struct hax_vcpu_state
;
275 #define TB_JMP_CACHE_BITS 12
276 #define TB_JMP_CACHE_SIZE (1 << TB_JMP_CACHE_BITS)
280 /* The union type allows passing of 64 bit target pointers on 32 bit
281 * hosts in a single parameter
285 unsigned long host_ulong
;
290 #define RUN_ON_CPU_HOST_PTR(p) ((run_on_cpu_data){.host_ptr = (p)})
291 #define RUN_ON_CPU_HOST_INT(i) ((run_on_cpu_data){.host_int = (i)})
292 #define RUN_ON_CPU_HOST_ULONG(ul) ((run_on_cpu_data){.host_ulong = (ul)})
293 #define RUN_ON_CPU_TARGET_PTR(v) ((run_on_cpu_data){.target_ptr = (v)})
294 #define RUN_ON_CPU_NULL RUN_ON_CPU_HOST_PTR(NULL)
296 typedef void (*run_on_cpu_func
)(CPUState
*cpu
, run_on_cpu_data data
);
298 struct qemu_work_item
;
300 #define CPU_UNSET_NUMA_NODE_ID -1
301 #define CPU_TRACE_DSTATE_MAX_EVENTS 32
305 * @cpu_index: CPU index (informative).
306 * @cluster_index: Identifies which cluster this CPU is in.
307 * For boards which don't define clusters or for "loose" CPUs not assigned
308 * to a cluster this will be UNASSIGNED_CLUSTER_INDEX; otherwise it will
309 * be the same as the cluster-id property of the CPU object's TYPE_CPU_CLUSTER
311 * @nr_cores: Number of cores within this CPU package.
312 * @nr_threads: Number of threads within this CPU.
313 * @running: #true if CPU is currently running (lockless).
314 * @has_waiter: #true if a CPU is currently waiting for the cpu_exec_end;
315 * valid under cpu_list_lock.
316 * @created: Indicates whether the CPU thread has been successfully created.
317 * @interrupt_request: Indicates a pending interrupt request.
318 * @halted: Nonzero if the CPU is in suspended state.
319 * @stop: Indicates a pending stop request.
320 * @stopped: Indicates the CPU has been artificially stopped.
321 * @unplug: Indicates a pending CPU unplug request.
322 * @crash_occurred: Indicates the OS reported a crash (panic) for this CPU
323 * @singlestep_enabled: Flags for single-stepping.
324 * @icount_extra: Instructions until next timer event.
325 * @can_do_io: Nonzero if memory-mapped IO is safe. Deterministic execution
326 * requires that IO only be performed on the last instruction of a TB
327 * so that interrupts take effect immediately.
328 * @cpu_ases: Pointer to array of CPUAddressSpaces (which define the
329 * AddressSpaces this CPU has)
330 * @num_ases: number of CPUAddressSpaces in @cpu_ases
331 * @as: Pointer to the first AddressSpace, for the convenience of targets which
332 * only have a single AddressSpace
333 * @env_ptr: Pointer to subclass-specific CPUArchState field.
334 * @icount_decr_ptr: Pointer to IcountDecr field within subclass.
335 * @gdb_regs: Additional GDB registers.
336 * @gdb_num_regs: Number of total registers accessible to GDB.
337 * @gdb_num_g_regs: Number of registers in GDB 'g' packets.
338 * @next_cpu: Next CPU sharing TB cache.
339 * @opaque: User data.
340 * @mem_io_pc: Host Program Counter at which the memory was accessed.
341 * @mem_io_vaddr: Target virtual address at which the memory was accessed.
342 * @kvm_fd: vCPU file descriptor for KVM.
343 * @work_mutex: Lock to prevent multiple access to queued_work_*.
344 * @queued_work_first: First asynchronous work pending.
345 * @trace_dstate_delayed: Delayed changes to trace_dstate (includes all changes
347 * @trace_dstate: Dynamic tracing state of events for this vCPU (bitmask).
348 * @ignore_memory_transaction_failures: Cached copy of the MachineState
349 * flag of the same name: allows the board to suppress calling of the
350 * CPU do_transaction_failed hook function.
352 * State of one CPU core or thread.
356 DeviceState parent_obj
;
362 struct QemuThread
*thread
;
367 bool running
, has_waiter
;
368 struct QemuCond
*halt_cond
;
376 uint32_t cflags_next_tb
;
377 /* updates protected by BQL */
378 uint32_t interrupt_request
;
379 int singlestep_enabled
;
380 int64_t icount_budget
;
381 int64_t icount_extra
;
382 uint64_t random_seed
;
385 QemuMutex work_mutex
;
386 struct qemu_work_item
*queued_work_first
, *queued_work_last
;
388 CPUAddressSpace
*cpu_ases
;
391 MemoryRegion
*memory
;
393 void *env_ptr
; /* CPUArchState */
394 IcountDecr
*icount_decr_ptr
;
396 /* Accessed in parallel; all accesses must be atomic */
397 struct TranslationBlock
*tb_jmp_cache
[TB_JMP_CACHE_SIZE
];
399 struct GDBRegisterState
*gdb_regs
;
402 QTAILQ_ENTRY(CPUState
) node
;
404 /* ice debug support */
405 QTAILQ_HEAD(, CPUBreakpoint
) breakpoints
;
407 QTAILQ_HEAD(, CPUWatchpoint
) watchpoints
;
408 CPUWatchpoint
*watchpoint_hit
;
412 /* In order to avoid passing too many arguments to the MMIO helpers,
413 * we store some rarely used information in the CPU context.
418 * This is only needed for the legacy cpu_unassigned_access() hook;
419 * when all targets using it have been converted to use
420 * cpu_transaction_failed() instead it can be removed.
422 MMUAccessType mem_io_access_type
;
425 struct KVMState
*kvm_state
;
426 struct kvm_run
*kvm_run
;
428 /* Used for events with 'vcpu' and *without* the 'disabled' properties */
429 DECLARE_BITMAP(trace_dstate_delayed
, CPU_TRACE_DSTATE_MAX_EVENTS
);
430 DECLARE_BITMAP(trace_dstate
, CPU_TRACE_DSTATE_MAX_EVENTS
);
432 /* TODO Move common fields from CPUArchState here. */
437 int32_t exception_index
;
439 /* shared by kvm, hax and hvf */
442 /* Used to keep track of an outstanding cpu throttle thread for migration
445 bool throttle_thread_scheduled
;
447 bool ignore_memory_transaction_failures
;
449 struct hax_vcpu_state
*hax_vcpu
;
453 /* track IOMMUs whose translations we've cached in the TCG TLB */
454 GArray
*iommu_notifiers
;
457 typedef QTAILQ_HEAD(CPUTailQ
, CPUState
) CPUTailQ
;
458 extern CPUTailQ cpus
;
460 #define first_cpu QTAILQ_FIRST_RCU(&cpus)
461 #define CPU_NEXT(cpu) QTAILQ_NEXT_RCU(cpu, node)
462 #define CPU_FOREACH(cpu) QTAILQ_FOREACH_RCU(cpu, &cpus, node)
463 #define CPU_FOREACH_SAFE(cpu, next_cpu) \
464 QTAILQ_FOREACH_SAFE_RCU(cpu, &cpus, node, next_cpu)
466 extern __thread CPUState
*current_cpu
;
468 static inline void cpu_tb_jmp_cache_clear(CPUState
*cpu
)
472 for (i
= 0; i
< TB_JMP_CACHE_SIZE
; i
++) {
473 atomic_set(&cpu
->tb_jmp_cache
[i
], NULL
);
478 * qemu_tcg_mttcg_enabled:
479 * Check whether we are running MultiThread TCG or not.
481 * Returns: %true if we are in MTTCG mode %false otherwise.
483 extern bool mttcg_enabled
;
484 #define qemu_tcg_mttcg_enabled() (mttcg_enabled)
487 * cpu_paging_enabled:
488 * @cpu: The CPU whose state is to be inspected.
490 * Returns: %true if paging is enabled, %false otherwise.
492 bool cpu_paging_enabled(const CPUState
*cpu
);
495 * cpu_get_memory_mapping:
496 * @cpu: The CPU whose memory mappings are to be obtained.
497 * @list: Where to write the memory mappings to.
498 * @errp: Pointer for reporting an #Error.
500 void cpu_get_memory_mapping(CPUState
*cpu
, MemoryMappingList
*list
,
504 * cpu_write_elf64_note:
505 * @f: pointer to a function that writes memory to a file
506 * @cpu: The CPU whose memory is to be dumped
507 * @cpuid: ID number of the CPU
508 * @opaque: pointer to the CPUState struct
510 int cpu_write_elf64_note(WriteCoreDumpFunction f
, CPUState
*cpu
,
511 int cpuid
, void *opaque
);
514 * cpu_write_elf64_qemunote:
515 * @f: pointer to a function that writes memory to a file
516 * @cpu: The CPU whose memory is to be dumped
517 * @cpuid: ID number of the CPU
518 * @opaque: pointer to the CPUState struct
520 int cpu_write_elf64_qemunote(WriteCoreDumpFunction f
, CPUState
*cpu
,
524 * cpu_write_elf32_note:
525 * @f: pointer to a function that writes memory to a file
526 * @cpu: The CPU whose memory is to be dumped
527 * @cpuid: ID number of the CPU
528 * @opaque: pointer to the CPUState struct
530 int cpu_write_elf32_note(WriteCoreDumpFunction f
, CPUState
*cpu
,
531 int cpuid
, void *opaque
);
534 * cpu_write_elf32_qemunote:
535 * @f: pointer to a function that writes memory to a file
536 * @cpu: The CPU whose memory is to be dumped
537 * @cpuid: ID number of the CPU
538 * @opaque: pointer to the CPUState struct
540 int cpu_write_elf32_qemunote(WriteCoreDumpFunction f
, CPUState
*cpu
,
544 * cpu_get_crash_info:
545 * @cpu: The CPU to get crash information for
547 * Gets the previously saved crash information.
548 * Caller is responsible for freeing the data.
550 GuestPanicInformation
*cpu_get_crash_info(CPUState
*cpu
);
555 * @CPU_DUMP_FPU: dump FPU register state, not just integer
556 * @CPU_DUMP_CCOP: dump info about TCG QEMU's condition code optimization state
559 CPU_DUMP_CODE
= 0x00010000,
560 CPU_DUMP_FPU
= 0x00020000,
561 CPU_DUMP_CCOP
= 0x00040000,
566 * @cpu: The CPU whose state is to be dumped.
567 * @f: If non-null, dump to this stream, else to current print sink.
571 void cpu_dump_state(CPUState
*cpu
, FILE *f
, int flags
);
574 * cpu_dump_statistics:
575 * @cpu: The CPU whose state is to be dumped.
576 * @flags: Flags what to dump.
578 * Dump CPU statistics to the current monitor if we have one, else to
581 void cpu_dump_statistics(CPUState
*cpu
, int flags
);
583 #ifndef CONFIG_USER_ONLY
585 * cpu_get_phys_page_attrs_debug:
586 * @cpu: The CPU to obtain the physical page address for.
587 * @addr: The virtual address.
588 * @attrs: Updated on return with the memory transaction attributes to use
591 * Obtains the physical page corresponding to a virtual one, together
592 * with the corresponding memory transaction attributes to use for the access.
593 * Use it only for debugging because no protection checks are done.
595 * Returns: Corresponding physical page address or -1 if no page found.
597 static inline hwaddr
cpu_get_phys_page_attrs_debug(CPUState
*cpu
, vaddr addr
,
600 CPUClass
*cc
= CPU_GET_CLASS(cpu
);
602 if (cc
->get_phys_page_attrs_debug
) {
603 return cc
->get_phys_page_attrs_debug(cpu
, addr
, attrs
);
605 /* Fallback for CPUs which don't implement the _attrs_ hook */
606 *attrs
= MEMTXATTRS_UNSPECIFIED
;
607 return cc
->get_phys_page_debug(cpu
, addr
);
611 * cpu_get_phys_page_debug:
612 * @cpu: The CPU to obtain the physical page address for.
613 * @addr: The virtual address.
615 * Obtains the physical page corresponding to a virtual one.
616 * Use it only for debugging because no protection checks are done.
618 * Returns: Corresponding physical page address or -1 if no page found.
620 static inline hwaddr
cpu_get_phys_page_debug(CPUState
*cpu
, vaddr addr
)
622 MemTxAttrs attrs
= {};
624 return cpu_get_phys_page_attrs_debug(cpu
, addr
, &attrs
);
627 /** cpu_asidx_from_attrs:
629 * @attrs: memory transaction attributes
631 * Returns the address space index specifying the CPU AddressSpace
632 * to use for a memory access with the given transaction attributes.
634 static inline int cpu_asidx_from_attrs(CPUState
*cpu
, MemTxAttrs attrs
)
636 CPUClass
*cc
= CPU_GET_CLASS(cpu
);
639 if (cc
->asidx_from_attrs
) {
640 ret
= cc
->asidx_from_attrs(cpu
, attrs
);
641 assert(ret
< cpu
->num_ases
&& ret
>= 0);
649 * @cpu: The CPU to be added to the list of CPUs.
651 void cpu_list_add(CPUState
*cpu
);
655 * @cpu: The CPU to be removed from the list of CPUs.
657 void cpu_list_remove(CPUState
*cpu
);
661 * @cpu: The CPU whose state is to be reset.
663 void cpu_reset(CPUState
*cpu
);
667 * @typename: The CPU base type.
668 * @cpu_model: The model string without any parameters.
670 * Looks up a CPU #ObjectClass matching name @cpu_model.
672 * Returns: A #CPUClass or %NULL if not matching class is found.
674 ObjectClass
*cpu_class_by_name(const char *typename
, const char *cpu_model
);
678 * @typename: The CPU type.
680 * Instantiates a CPU and realizes the CPU.
682 * Returns: A #CPUState or %NULL if an error occurred.
684 CPUState
*cpu_create(const char *typename
);
688 * @cpu_option: The -cpu option including optional parameters.
690 * processes optional parameters and registers them as global properties
692 * Returns: type of CPU to create or prints error and terminates process
693 * if an error occurred.
695 const char *parse_cpu_option(const char *cpu_option
);
699 * @cpu: The vCPU to check.
701 * Checks whether the CPU has work to do.
703 * Returns: %true if the CPU has work, %false otherwise.
705 static inline bool cpu_has_work(CPUState
*cpu
)
707 CPUClass
*cc
= CPU_GET_CLASS(cpu
);
709 g_assert(cc
->has_work
);
710 return cc
->has_work(cpu
);
715 * @cpu: The vCPU to check against.
717 * Checks whether the caller is executing on the vCPU thread.
719 * Returns: %true if called from @cpu's thread, %false otherwise.
721 bool qemu_cpu_is_self(CPUState
*cpu
);
725 * @cpu: The vCPU to kick.
727 * Kicks @cpu's thread.
729 void qemu_cpu_kick(CPUState
*cpu
);
733 * @cpu: The CPU to check.
735 * Checks whether the CPU is stopped.
737 * Returns: %true if run state is not running or if artificially stopped;
740 bool cpu_is_stopped(CPUState
*cpu
);
744 * @cpu: The vCPU to run on.
745 * @func: The function to be executed.
746 * @data: Data to pass to the function.
747 * @mutex: Mutex to release while waiting for @func to run.
749 * Used internally in the implementation of run_on_cpu.
751 void do_run_on_cpu(CPUState
*cpu
, run_on_cpu_func func
, run_on_cpu_data data
,
756 * @cpu: The vCPU to run on.
757 * @func: The function to be executed.
758 * @data: Data to pass to the function.
760 * Schedules the function @func for execution on the vCPU @cpu.
762 void run_on_cpu(CPUState
*cpu
, run_on_cpu_func func
, run_on_cpu_data data
);
766 * @cpu: The vCPU to run on.
767 * @func: The function to be executed.
768 * @data: Data to pass to the function.
770 * Schedules the function @func for execution on the vCPU @cpu asynchronously.
772 void async_run_on_cpu(CPUState
*cpu
, run_on_cpu_func func
, run_on_cpu_data data
);
775 * async_safe_run_on_cpu:
776 * @cpu: The vCPU to run on.
777 * @func: The function to be executed.
778 * @data: Data to pass to the function.
780 * Schedules the function @func for execution on the vCPU @cpu asynchronously,
781 * while all other vCPUs are sleeping.
783 * Unlike run_on_cpu and async_run_on_cpu, the function is run outside the
786 void async_safe_run_on_cpu(CPUState
*cpu
, run_on_cpu_func func
, run_on_cpu_data data
);
790 * @index: The CPUState@cpu_index value of the CPU to obtain.
792 * Gets a CPU matching @index.
794 * Returns: The CPU or %NULL if there is no matching CPU.
796 CPUState
*qemu_get_cpu(int index
);
800 * @id: Guest-exposed CPU ID to lookup.
802 * Search for CPU with specified ID.
804 * Returns: %true - CPU is found, %false - CPU isn't found.
806 bool cpu_exists(int64_t id
);
810 * @id: Guest-exposed CPU ID of the CPU to obtain.
812 * Get a CPU with matching @id.
814 * Returns: The CPU or %NULL if there is no matching CPU.
816 CPUState
*cpu_by_arch_id(int64_t id
);
820 * @new_throttle_pct: Percent of sleep time. Valid range is 1 to 99.
822 * Throttles all vcpus by forcing them to sleep for the given percentage of
823 * time. A throttle_percentage of 25 corresponds to a 75% duty cycle roughly.
824 * (example: 10ms sleep for every 30ms awake).
826 * cpu_throttle_set can be called as needed to adjust new_throttle_pct.
827 * Once the throttling starts, it will remain in effect until cpu_throttle_stop
830 void cpu_throttle_set(int new_throttle_pct
);
835 * Stops the vcpu throttling started by cpu_throttle_set.
837 void cpu_throttle_stop(void);
840 * cpu_throttle_active:
842 * Returns: %true if the vcpus are currently being throttled, %false otherwise.
844 bool cpu_throttle_active(void);
847 * cpu_throttle_get_percentage:
849 * Returns the vcpu throttle percentage. See cpu_throttle_set for details.
851 * Returns: The throttle percentage in range 1 to 99.
853 int cpu_throttle_get_percentage(void);
855 #ifndef CONFIG_USER_ONLY
857 typedef void (*CPUInterruptHandler
)(CPUState
*, int);
859 extern CPUInterruptHandler cpu_interrupt_handler
;
863 * @cpu: The CPU to set an interrupt on.
864 * @mask: The interrupts to set.
866 * Invokes the interrupt handler.
868 static inline void cpu_interrupt(CPUState
*cpu
, int mask
)
870 cpu_interrupt_handler(cpu
, mask
);
873 #else /* USER_ONLY */
875 void cpu_interrupt(CPUState
*cpu
, int mask
);
877 #endif /* USER_ONLY */
881 #ifdef CONFIG_SOFTMMU
882 static inline void cpu_unassigned_access(CPUState
*cpu
, hwaddr addr
,
883 bool is_write
, bool is_exec
,
884 int opaque
, unsigned size
)
886 CPUClass
*cc
= CPU_GET_CLASS(cpu
);
888 if (cc
->do_unassigned_access
) {
889 cc
->do_unassigned_access(cpu
, addr
, is_write
, is_exec
, opaque
, size
);
893 static inline void cpu_unaligned_access(CPUState
*cpu
, vaddr addr
,
894 MMUAccessType access_type
,
895 int mmu_idx
, uintptr_t retaddr
)
897 CPUClass
*cc
= CPU_GET_CLASS(cpu
);
899 cc
->do_unaligned_access(cpu
, addr
, access_type
, mmu_idx
, retaddr
);
902 static inline void cpu_transaction_failed(CPUState
*cpu
, hwaddr physaddr
,
903 vaddr addr
, unsigned size
,
904 MMUAccessType access_type
,
905 int mmu_idx
, MemTxAttrs attrs
,
906 MemTxResult response
,
909 CPUClass
*cc
= CPU_GET_CLASS(cpu
);
911 if (!cpu
->ignore_memory_transaction_failures
&& cc
->do_transaction_failed
) {
912 cc
->do_transaction_failed(cpu
, physaddr
, addr
, size
, access_type
,
913 mmu_idx
, attrs
, response
, retaddr
);
918 #endif /* NEED_CPU_H */
922 * @cpu: The CPU to set the program counter for.
923 * @addr: Program counter value.
925 * Sets the program counter for a CPU.
927 static inline void cpu_set_pc(CPUState
*cpu
, vaddr addr
)
929 CPUClass
*cc
= CPU_GET_CLASS(cpu
);
931 cc
->set_pc(cpu
, addr
);
935 * cpu_reset_interrupt:
936 * @cpu: The CPU to clear the interrupt on.
937 * @mask: The interrupt mask to clear.
939 * Resets interrupts on the vCPU @cpu.
941 void cpu_reset_interrupt(CPUState
*cpu
, int mask
);
945 * @cpu: The CPU to exit.
947 * Requests the CPU @cpu to exit execution.
949 void cpu_exit(CPUState
*cpu
);
953 * @cpu: The CPU to resume.
955 * Resumes CPU, i.e. puts CPU into runnable state.
957 void cpu_resume(CPUState
*cpu
);
961 * @cpu: The CPU to remove.
963 * Requests the CPU to be removed.
965 void cpu_remove(CPUState
*cpu
);
969 * @cpu: The CPU to remove.
971 * Requests the CPU to be removed and waits till it is removed.
973 void cpu_remove_sync(CPUState
*cpu
);
976 * process_queued_cpu_work() - process all items on CPU work queue
977 * @cpu: The CPU which work queue to process.
979 void process_queued_cpu_work(CPUState
*cpu
);
983 * @cpu: The CPU for the current thread.
985 * Record that a CPU has started execution and can be interrupted with
988 void cpu_exec_start(CPUState
*cpu
);
992 * @cpu: The CPU for the current thread.
994 * Record that a CPU has stopped execution and exclusive sections
995 * can be executed without interrupting it.
997 void cpu_exec_end(CPUState
*cpu
);
1002 * Wait for a concurrent exclusive section to end, and then start
1003 * a section of work that is run while other CPUs are not running
1004 * between cpu_exec_start and cpu_exec_end. CPUs that are running
1005 * cpu_exec are exited immediately. CPUs that call cpu_exec_start
1006 * during the exclusive section go to sleep until this CPU calls
1009 void start_exclusive(void);
1014 * Concludes an exclusive execution section started by start_exclusive.
1016 void end_exclusive(void);
1020 * @cpu: The vCPU to initialize.
1022 * Initializes a vCPU.
1024 void qemu_init_vcpu(CPUState
*cpu
);
1026 #define SSTEP_ENABLE 0x1 /* Enable simulated HW single stepping */
1027 #define SSTEP_NOIRQ 0x2 /* Do not use IRQ while single stepping */
1028 #define SSTEP_NOTIMER 0x4 /* Do not Timers while single stepping */
1032 * @cpu: CPU to the flags for.
1033 * @enabled: Flags to enable.
1035 * Enables or disables single-stepping for @cpu.
1037 void cpu_single_step(CPUState
*cpu
, int enabled
);
1039 /* Breakpoint/watchpoint flags */
1040 #define BP_MEM_READ 0x01
1041 #define BP_MEM_WRITE 0x02
1042 #define BP_MEM_ACCESS (BP_MEM_READ | BP_MEM_WRITE)
1043 #define BP_STOP_BEFORE_ACCESS 0x04
1044 /* 0x08 currently unused */
1047 #define BP_ANY (BP_GDB | BP_CPU)
1048 #define BP_WATCHPOINT_HIT_READ 0x40
1049 #define BP_WATCHPOINT_HIT_WRITE 0x80
1050 #define BP_WATCHPOINT_HIT (BP_WATCHPOINT_HIT_READ | BP_WATCHPOINT_HIT_WRITE)
1052 int cpu_breakpoint_insert(CPUState
*cpu
, vaddr pc
, int flags
,
1053 CPUBreakpoint
**breakpoint
);
1054 int cpu_breakpoint_remove(CPUState
*cpu
, vaddr pc
, int flags
);
1055 void cpu_breakpoint_remove_by_ref(CPUState
*cpu
, CPUBreakpoint
*breakpoint
);
1056 void cpu_breakpoint_remove_all(CPUState
*cpu
, int mask
);
1058 /* Return true if PC matches an installed breakpoint. */
1059 static inline bool cpu_breakpoint_test(CPUState
*cpu
, vaddr pc
, int mask
)
1063 if (unlikely(!QTAILQ_EMPTY(&cpu
->breakpoints
))) {
1064 QTAILQ_FOREACH(bp
, &cpu
->breakpoints
, entry
) {
1065 if (bp
->pc
== pc
&& (bp
->flags
& mask
)) {
1073 int cpu_watchpoint_insert(CPUState
*cpu
, vaddr addr
, vaddr len
,
1074 int flags
, CPUWatchpoint
**watchpoint
);
1075 int cpu_watchpoint_remove(CPUState
*cpu
, vaddr addr
,
1076 vaddr len
, int flags
);
1077 void cpu_watchpoint_remove_by_ref(CPUState
*cpu
, CPUWatchpoint
*watchpoint
);
1078 void cpu_watchpoint_remove_all(CPUState
*cpu
, int mask
);
1081 * cpu_get_address_space:
1082 * @cpu: CPU to get address space from
1083 * @asidx: index identifying which address space to get
1085 * Return the requested address space of this CPU. @asidx
1086 * specifies which address space to read.
1088 AddressSpace
*cpu_get_address_space(CPUState
*cpu
, int asidx
);
1090 void QEMU_NORETURN
cpu_abort(CPUState
*cpu
, const char *fmt
, ...)
1092 extern Property cpu_common_props
[];
1093 void cpu_exec_initfn(CPUState
*cpu
);
1094 void cpu_exec_realizefn(CPUState
*cpu
, Error
**errp
);
1095 void cpu_exec_unrealizefn(CPUState
*cpu
);
1098 * target_words_bigendian:
1099 * Returns true if the (default) endianness of the target is big endian,
1100 * false otherwise. Note that in target-specific code, you can use
1101 * TARGET_WORDS_BIGENDIAN directly instead. On the other hand, common
1102 * code should normally never need to know about the endianness of the
1103 * target, so please do *not* use this function unless you know very well
1104 * what you are doing!
1106 bool target_words_bigendian(void);
1110 #ifdef CONFIG_SOFTMMU
1111 extern const VMStateDescription vmstate_cpu_common
;
1113 #define vmstate_cpu_common vmstate_dummy
1116 #define VMSTATE_CPU() { \
1117 .name = "parent_obj", \
1118 .size = sizeof(CPUState), \
1119 .vmsd = &vmstate_cpu_common, \
1120 .flags = VMS_STRUCT, \
1124 #endif /* NEED_CPU_H */
1126 #define UNASSIGNED_CPU_INDEX -1
1127 #define UNASSIGNED_CLUSTER_INDEX -1