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>
24 #include "hw/qdev-core.h"
25 #include "exec/hwaddr.h"
26 #include "qemu/thread.h"
28 #include "qemu/typedefs.h"
30 typedef int (*WriteCoreDumpFunction
)(void *buf
, size_t size
, void *opaque
);
34 * Type wide enough to contain any #target_ulong virtual address.
36 typedef uint64_t vaddr
;
37 #define VADDR_PRId PRId64
38 #define VADDR_PRIu PRIu64
39 #define VADDR_PRIo PRIo64
40 #define VADDR_PRIx PRIx64
41 #define VADDR_PRIX PRIX64
42 #define VADDR_MAX UINT64_MAX
46 * @section_id: QEMU-cpu
48 * @short_description: Base class for all CPUs
51 #define TYPE_CPU "cpu"
53 #define CPU(obj) OBJECT_CHECK(CPUState, (obj), TYPE_CPU)
54 #define CPU_CLASS(class) OBJECT_CLASS_CHECK(CPUClass, (class), TYPE_CPU)
55 #define CPU_GET_CLASS(obj) OBJECT_GET_CLASS(CPUClass, (obj), TYPE_CPU)
57 typedef struct CPUState CPUState
;
59 typedef void (*CPUUnassignedAccess
)(CPUState
*cpu
, hwaddr addr
,
60 bool is_write
, bool is_exec
, int opaque
,
63 struct TranslationBlock
;
67 * @class_by_name: Callback to map -cpu command line model name to an
68 * instantiatable CPU type.
69 * @reset: Callback to reset the #CPUState to its initial state.
70 * @reset_dump_flags: #CPUDumpFlags to use for reset logging.
71 * @do_interrupt: Callback for interrupt handling.
72 * @do_unassigned_access: Callback for unassigned access handling.
73 * @dump_state: Callback for dumping state.
74 * @dump_statistics: Callback for dumping statistics.
75 * @get_arch_id: Callback for getting architecture-dependent CPU ID.
76 * @get_paging_enabled: Callback for inquiring whether paging is enabled.
77 * @get_memory_mapping: Callback for obtaining the memory mappings.
78 * @set_pc: Callback for setting the Program Counter register.
79 * @synchronize_from_tb: Callback for synchronizing state from a TCG
81 * @vmsd: State description for migration.
83 * Represents a CPU family or model.
85 typedef struct CPUClass
{
87 DeviceClass parent_class
;
90 ObjectClass
*(*class_by_name
)(const char *cpu_model
);
92 void (*reset
)(CPUState
*cpu
);
94 void (*do_interrupt
)(CPUState
*cpu
);
95 CPUUnassignedAccess do_unassigned_access
;
96 void (*dump_state
)(CPUState
*cpu
, FILE *f
, fprintf_function cpu_fprintf
,
98 void (*dump_statistics
)(CPUState
*cpu
, FILE *f
,
99 fprintf_function cpu_fprintf
, int flags
);
100 int64_t (*get_arch_id
)(CPUState
*cpu
);
101 bool (*get_paging_enabled
)(const CPUState
*cpu
);
102 void (*get_memory_mapping
)(CPUState
*cpu
, MemoryMappingList
*list
,
104 void (*set_pc
)(CPUState
*cpu
, vaddr value
);
105 void (*synchronize_from_tb
)(CPUState
*cpu
, struct TranslationBlock
*tb
);
107 const struct VMStateDescription
*vmsd
;
108 int (*write_elf64_note
)(WriteCoreDumpFunction f
, CPUState
*cpu
,
109 int cpuid
, void *opaque
);
110 int (*write_elf64_qemunote
)(WriteCoreDumpFunction f
, CPUState
*cpu
,
112 int (*write_elf32_note
)(WriteCoreDumpFunction f
, CPUState
*cpu
,
113 int cpuid
, void *opaque
);
114 int (*write_elf32_qemunote
)(WriteCoreDumpFunction f
, CPUState
*cpu
,
123 * @cpu_index: CPU index (informative).
124 * @nr_cores: Number of cores within this CPU package.
125 * @nr_threads: Number of threads within this CPU.
126 * @numa_node: NUMA node this CPU is belonging to.
127 * @host_tid: Host thread ID.
128 * @running: #true if CPU is currently running (usermode).
129 * @created: Indicates whether the CPU thread has been successfully created.
130 * @interrupt_request: Indicates a pending interrupt request.
131 * @halted: Nonzero if the CPU is in suspended state.
132 * @stop: Indicates a pending stop request.
133 * @stopped: Indicates the CPU has been artificially stopped.
134 * @tcg_exit_req: Set to force TCG to stop executing linked TBs for this
135 * CPU and return to its top level loop.
136 * @env_ptr: Pointer to subclass-specific CPUArchState field.
137 * @current_tb: Currently executing TB.
138 * @next_cpu: Next CPU sharing TB cache.
139 * @kvm_fd: vCPU file descriptor for KVM.
141 * State of one CPU core or thread.
145 DeviceState parent_obj
;
152 struct QemuThread
*thread
;
159 struct QemuCond
*halt_cond
;
160 struct qemu_work_item
*queued_work_first
, *queued_work_last
;
165 volatile sig_atomic_t exit_request
;
166 volatile sig_atomic_t tcg_exit_req
;
167 uint32_t interrupt_request
;
169 void *env_ptr
; /* CPUArchState */
170 struct TranslationBlock
*current_tb
;
175 struct KVMState
*kvm_state
;
176 struct kvm_run
*kvm_run
;
178 /* TODO Move common fields from CPUArchState here. */
179 int cpu_index
; /* used by alpha TCG */
180 uint32_t halted
; /* used by alpha, cris, ppc TCG */
183 extern CPUState
*first_cpu
;
185 DECLARE_TLS(CPUState
*, current_cpu
);
186 #define current_cpu tls_var(current_cpu)
189 * cpu_paging_enabled:
190 * @cpu: The CPU whose state is to be inspected.
192 * Returns: %true if paging is enabled, %false otherwise.
194 bool cpu_paging_enabled(const CPUState
*cpu
);
197 * cpu_get_memory_mapping:
198 * @cpu: The CPU whose memory mappings are to be obtained.
199 * @list: Where to write the memory mappings to.
200 * @errp: Pointer for reporting an #Error.
202 void cpu_get_memory_mapping(CPUState
*cpu
, MemoryMappingList
*list
,
206 * cpu_write_elf64_note:
207 * @f: pointer to a function that writes memory to a file
208 * @cpu: The CPU whose memory is to be dumped
209 * @cpuid: ID number of the CPU
210 * @opaque: pointer to the CPUState struct
212 int cpu_write_elf64_note(WriteCoreDumpFunction f
, CPUState
*cpu
,
213 int cpuid
, void *opaque
);
216 * cpu_write_elf64_qemunote:
217 * @f: pointer to a function that writes memory to a file
218 * @cpu: The CPU whose memory is to be dumped
219 * @cpuid: ID number of the CPU
220 * @opaque: pointer to the CPUState struct
222 int cpu_write_elf64_qemunote(WriteCoreDumpFunction f
, CPUState
*cpu
,
226 * cpu_write_elf32_note:
227 * @f: pointer to a function that writes memory to a file
228 * @cpu: The CPU whose memory is to be dumped
229 * @cpuid: ID number of the CPU
230 * @opaque: pointer to the CPUState struct
232 int cpu_write_elf32_note(WriteCoreDumpFunction f
, CPUState
*cpu
,
233 int cpuid
, void *opaque
);
236 * cpu_write_elf32_qemunote:
237 * @f: pointer to a function that writes memory to a file
238 * @cpu: The CPU whose memory is to be dumped
239 * @cpuid: ID number of the CPU
240 * @opaque: pointer to the CPUState struct
242 int cpu_write_elf32_qemunote(WriteCoreDumpFunction f
, CPUState
*cpu
,
248 * @CPU_DUMP_FPU: dump FPU register state, not just integer
249 * @CPU_DUMP_CCOP: dump info about TCG QEMU's condition code optimization state
252 CPU_DUMP_CODE
= 0x00010000,
253 CPU_DUMP_FPU
= 0x00020000,
254 CPU_DUMP_CCOP
= 0x00040000,
259 * @cpu: The CPU whose state is to be dumped.
260 * @f: File to dump to.
261 * @cpu_fprintf: Function to dump with.
262 * @flags: Flags what to dump.
266 void cpu_dump_state(CPUState
*cpu
, FILE *f
, fprintf_function cpu_fprintf
,
270 * cpu_dump_statistics:
271 * @cpu: The CPU whose state is to be dumped.
272 * @f: File to dump to.
273 * @cpu_fprintf: Function to dump with.
274 * @flags: Flags what to dump.
276 * Dumps CPU statistics.
278 void cpu_dump_statistics(CPUState
*cpu
, FILE *f
, fprintf_function cpu_fprintf
,
283 * @cpu: The CPU whose state is to be reset.
285 void cpu_reset(CPUState
*cpu
);
289 * @typename: The CPU base type.
290 * @cpu_model: The model string without any parameters.
292 * Looks up a CPU #ObjectClass matching name @cpu_model.
294 * Returns: A #CPUClass or %NULL if not matching class is found.
296 ObjectClass
*cpu_class_by_name(const char *typename
, const char *cpu_model
);
299 * cpu_class_set_vmsd:
301 * @value: Value to set. Unused for %CONFIG_USER_ONLY.
303 * Sets #VMStateDescription for @cc.
305 * The @value argument is intentionally discarded for the non-softmmu targets
306 * to avoid linker errors or excessive preprocessor usage. If this behavior
307 * is undesired, you should assign #CPUClass.vmsd directly instead.
309 #ifndef CONFIG_USER_ONLY
310 static inline void cpu_class_set_vmsd(CPUClass
*cc
,
311 const struct VMStateDescription
*value
)
316 #define cpu_class_set_vmsd(cc, value) ((cc)->vmsd = NULL)
319 #ifndef CONFIG_USER_ONLY
320 static inline void cpu_class_set_do_unassigned_access(CPUClass
*cc
,
321 CPUUnassignedAccess value
)
323 cc
->do_unassigned_access
= value
;
326 #define cpu_class_set_do_unassigned_access(cc, value) \
327 ((cc)->do_unassigned_access = NULL)
331 * device_class_set_vmsd:
333 * @value: Value to set. Unused for %CONFIG_USER_ONLY.
335 * Sets #VMStateDescription for @dc.
337 * The @value argument is intentionally discarded for the non-softmmu targets
338 * to avoid linker errors or excessive preprocessor usage. If this behavior
339 * is undesired, you should assign #DeviceClass.vmsd directly instead.
341 #ifndef CONFIG_USER_ONLY
342 static inline void device_class_set_vmsd(DeviceClass
*dc
,
343 const struct VMStateDescription
*value
)
348 #define device_class_set_vmsd(dc, value) ((dc)->vmsd = NULL)
353 * @cpu: The vCPU to check.
355 * Checks whether the CPU has work to do.
357 * Returns: %true if the CPU has work, %false otherwise.
359 bool qemu_cpu_has_work(CPUState
*cpu
);
363 * @cpu: The vCPU to check against.
365 * Checks whether the caller is executing on the vCPU thread.
367 * Returns: %true if called from @cpu's thread, %false otherwise.
369 bool qemu_cpu_is_self(CPUState
*cpu
);
373 * @cpu: The vCPU to kick.
375 * Kicks @cpu's thread.
377 void qemu_cpu_kick(CPUState
*cpu
);
381 * @cpu: The CPU to check.
383 * Checks whether the CPU is stopped.
385 * Returns: %true if run state is not running or if artificially stopped;
388 bool cpu_is_stopped(CPUState
*cpu
);
392 * @cpu: The vCPU to run on.
393 * @func: The function to be executed.
394 * @data: Data to pass to the function.
396 * Schedules the function @func for execution on the vCPU @cpu.
398 void run_on_cpu(CPUState
*cpu
, void (*func
)(void *data
), void *data
);
402 * @cpu: The vCPU to run on.
403 * @func: The function to be executed.
404 * @data: Data to pass to the function.
406 * Schedules the function @func for execution on the vCPU @cpu asynchronously.
408 void async_run_on_cpu(CPUState
*cpu
, void (*func
)(void *data
), void *data
);
412 * @func: The function to be executed.
413 * @data: Data to pass to the function.
415 * Executes @func for each CPU.
417 void qemu_for_each_cpu(void (*func
)(CPUState
*cpu
, void *data
), void *data
);
421 * @index: The CPUState@cpu_index value of the CPU to obtain.
423 * Gets a CPU matching @index.
425 * Returns: The CPU or %NULL if there is no matching CPU.
427 CPUState
*qemu_get_cpu(int index
);
431 * @id: Guest-exposed CPU ID to lookup.
433 * Search for CPU with specified ID.
435 * Returns: %true - CPU is found, %false - CPU isn't found.
437 bool cpu_exists(int64_t id
);
439 #ifndef CONFIG_USER_ONLY
441 typedef void (*CPUInterruptHandler
)(CPUState
*, int);
443 extern CPUInterruptHandler cpu_interrupt_handler
;
447 * @cpu: The CPU to set an interrupt on.
448 * @mask: The interupts to set.
450 * Invokes the interrupt handler.
452 static inline void cpu_interrupt(CPUState
*cpu
, int mask
)
454 cpu_interrupt_handler(cpu
, mask
);
457 #else /* USER_ONLY */
459 void cpu_interrupt(CPUState
*cpu
, int mask
);
461 #endif /* USER_ONLY */
463 #ifndef CONFIG_USER_ONLY
465 static inline void cpu_unassigned_access(CPUState
*cpu
, hwaddr addr
,
466 bool is_write
, bool is_exec
,
467 int opaque
, unsigned size
)
469 CPUClass
*cc
= CPU_GET_CLASS(cpu
);
471 if (cc
->do_unassigned_access
) {
472 cc
->do_unassigned_access(cpu
, addr
, is_write
, is_exec
, opaque
, size
);
479 * cpu_reset_interrupt:
480 * @cpu: The CPU to clear the interrupt on.
481 * @mask: The interrupt mask to clear.
483 * Resets interrupts on the vCPU @cpu.
485 void cpu_reset_interrupt(CPUState
*cpu
, int mask
);
489 * @cpu: The CPU to exit.
491 * Requests the CPU @cpu to exit execution.
493 void cpu_exit(CPUState
*cpu
);
497 * @cpu: The CPU to resume.
499 * Resumes CPU, i.e. puts CPU into runnable state.
501 void cpu_resume(CPUState
*cpu
);
505 * @cpu: The vCPU to initialize.
507 * Initializes a vCPU.
509 void qemu_init_vcpu(CPUState
*cpu
);
511 #ifdef CONFIG_SOFTMMU
512 extern const struct VMStateDescription vmstate_cpu_common
;
514 #define vmstate_cpu_common vmstate_dummy
517 #define VMSTATE_CPU() { \
518 .name = "parent_obj", \
519 .size = sizeof(CPUState), \
520 .vmsd = &vmstate_cpu_common, \
521 .flags = VMS_STRUCT, \