include/qom/cpu.h

   1 /*
   2  * QEMU CPU model
   3  *
   4  * Copyright (c) 2012 SUSE LINUX Products GmbH
   5  *
   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.
  10  *
  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.
  15  *
  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>
  19  */
  20 #ifndef QEMU_CPU_H
  21 #define QEMU_CPU_H
  22
  23 #include "hw/qdev-core.h"
  24 #include "disas/bfd.h"
  25 #include "exec/hwaddr.h"
  26 #include "exec/memattrs.h"
  27 #include "qemu/bitmap.h"
  28 #include "qemu/queue.h"
  29 #include "qemu/thread.h"
  30
  31 typedef int (*WriteCoreDumpFunction)(const void *buf, size_t size,
  32                                      void *opaque);
  33
  34 /**
  35  * vaddr:
  36  * Type wide enough to contain any #target_ulong virtual address.
  37  */
  38 typedef uint64_t vaddr;
  39 #define VADDR_PRId PRId64
  40 #define VADDR_PRIu PRIu64
  41 #define VADDR_PRIo PRIo64
  42 #define VADDR_PRIx PRIx64
  43 #define VADDR_PRIX PRIX64
  44 #define VADDR_MAX UINT64_MAX
  45
  46 /**
  47  * SECTION:cpu
  48  * @section_id: QEMU-cpu
  49  * @title: CPU Class
  50  * @short_description: Base class for all CPUs
  51  */
  52
  53 #define TYPE_CPU "cpu"
  54
  55 /* Since this macro is used a lot in hot code paths and in conjunction with
  56  * FooCPU *foo_env_get_cpu(), we deviate from usual QOM practice by using
  57  * an unchecked cast.
  58  */
  59 #define CPU(obj) ((CPUState *)(obj))
  60
  61 #define CPU_CLASS(class) OBJECT_CLASS_CHECK(CPUClass, (class), TYPE_CPU)
  62 #define CPU_GET_CLASS(obj) OBJECT_GET_CLASS(CPUClass, (obj), TYPE_CPU)
  63
  64 typedef enum MMUAccessType {
  65     MMU_DATA_LOAD  = 0,
  66     MMU_DATA_STORE = 1,
  67     MMU_INST_FETCH = 2
  68 } MMUAccessType;
  69
  70 typedef struct CPUWatchpoint CPUWatchpoint;
  71
  72 typedef void (*CPUUnassignedAccess)(CPUState *cpu, hwaddr addr,
  73                                     bool is_write, bool is_exec, int opaque,
  74                                     unsigned size);
  75
  76 struct TranslationBlock;
  77
  78 /**
  79  * CPUClass:
  80  * @class_by_name: Callback to map -cpu command line model name to an
  81  * instantiatable CPU type.
  82  * @parse_features: Callback to parse command line arguments.
  83  * @reset: Callback to reset the #CPUState to its initial state.
  84  * @reset_dump_flags: #CPUDumpFlags to use for reset logging.
  85  * @has_work: Callback for checking if there is work to do.
  86  * @do_interrupt: Callback for interrupt handling.
  87  * @do_unassigned_access: Callback for unassigned access handling.
  88  * @do_unaligned_access: Callback for unaligned access handling, if
  89  * the target defines #ALIGNED_ONLY.
  90  * @virtio_is_big_endian: Callback to return %true if a CPU which supports
  91  * runtime configurable endianness is currently big-endian. Non-configurable
  92  * CPUs can use the default implementation of this method. This method should
  93  * not be used by any callers other than the pre-1.0 virtio devices.
  94  * @memory_rw_debug: Callback for GDB memory access.
  95  * @dump_state: Callback for dumping state.
  96  * @dump_statistics: Callback for dumping statistics.
  97  * @get_arch_id: Callback for getting architecture-dependent CPU ID.
  98  * @get_paging_enabled: Callback for inquiring whether paging is enabled.
  99  * @get_memory_mapping: Callback for obtaining the memory mappings.
 100  * @set_pc: Callback for setting the Program Counter register.
 101  * @synchronize_from_tb: Callback for synchronizing state from a TCG
 102  * #TranslationBlock.
 103  * @handle_mmu_fault: Callback for handling an MMU fault.
 104  * @get_phys_page_debug: Callback for obtaining a physical address.
 105  * @get_phys_page_attrs_debug: Callback for obtaining a physical address and the
 106  *       associated memory transaction attributes to use for the access.
 107  *       CPUs which use memory transaction attributes should implement this
 108  *       instead of get_phys_page_debug.
 109  * @asidx_from_attrs: Callback to return the CPU AddressSpace to use for
 110  *       a memory access with the specified memory transaction attributes.
 111  * @gdb_read_register: Callback for letting GDB read a register.
 112  * @gdb_write_register: Callback for letting GDB write a register.
 113  * @debug_check_watchpoint: Callback: return true if the architectural
 114  *       watchpoint whose address has matched should really fire.
 115  * @debug_excp_handler: Callback for handling debug exceptions.
 116  * @write_elf64_note: Callback for writing a CPU-specific ELF note to a
 117  * 64-bit VM coredump.
 118  * @write_elf32_qemunote: Callback for writing a CPU- and QEMU-specific ELF
 119  * note to a 32-bit VM coredump.
 120  * @write_elf32_note: Callback for writing a CPU-specific ELF note to a
 121  * 32-bit VM coredump.
 122  * @write_elf32_qemunote: Callback for writing a CPU- and QEMU-specific ELF
 123  * note to a 32-bit VM coredump.
 124  * @vmsd: State description for migration.
 125  * @gdb_num_core_regs: Number of core registers accessible to GDB.
 126  * @gdb_core_xml_file: File name for core registers GDB XML description.
 127  * @gdb_stop_before_watchpoint: Indicates whether GDB expects the CPU to stop
 128  *           before the insn which triggers a watchpoint rather than after it.
 129  * @gdb_arch_name: Optional callback that returns the architecture name known
 130  * to GDB. The caller must free the returned string with g_free.
 131  * @cpu_exec_enter: Callback for cpu_exec preparation.
 132  * @cpu_exec_exit: Callback for cpu_exec cleanup.
 133  * @cpu_exec_interrupt: Callback for processing interrupts in cpu_exec.
 134  * @disas_set_info: Setup architecture specific components of disassembly info
 135  * @adjust_watchpoint_address: Perform a target-specific adjustment to an
 136  * address before attempting to match it against watchpoints.
 137  *
 138  * Represents a CPU family or model.
 139  */
 140 typedef struct CPUClass {
 141     /*< private >*/
 142     DeviceClass parent_class;
 143     /*< public >*/
 144
 145     ObjectClass *(*class_by_name)(const char *cpu_model);
 146     void (*parse_features)(const char *typename, char *str, Error **errp);
 147
 148     void (*reset)(CPUState *cpu);
 149     int reset_dump_flags;
 150     bool (*has_work)(CPUState *cpu);
 151     void (*do_interrupt)(CPUState *cpu);
 152     CPUUnassignedAccess do_unassigned_access;
 153     void (*do_unaligned_access)(CPUState *cpu, vaddr addr,
 154                                 MMUAccessType access_type,
 155                                 int mmu_idx, uintptr_t retaddr);
 156     bool (*virtio_is_big_endian)(CPUState *cpu);
 157     int (*memory_rw_debug)(CPUState *cpu, vaddr addr,
 158                            uint8_t *buf, int len, bool is_write);
 159     void (*dump_state)(CPUState *cpu, FILE *f, fprintf_function cpu_fprintf,
 160                        int flags);
 161     GuestPanicInformation* (*get_crash_info)(CPUState *cpu);
 162     void (*dump_statistics)(CPUState *cpu, FILE *f,
 163                             fprintf_function cpu_fprintf, int flags);
 164     int64_t (*get_arch_id)(CPUState *cpu);
 165     bool (*get_paging_enabled)(const CPUState *cpu);
 166     void (*get_memory_mapping)(CPUState *cpu, MemoryMappingList *list,
 167                                Error **errp);
 168     void (*set_pc)(CPUState *cpu, vaddr value);
 169     void (*synchronize_from_tb)(CPUState *cpu, struct TranslationBlock *tb);
 170     int (*handle_mmu_fault)(CPUState *cpu, vaddr address, int rw,
 171                             int mmu_index);
 172     hwaddr (*get_phys_page_debug)(CPUState *cpu, vaddr addr);
 173     hwaddr (*get_phys_page_attrs_debug)(CPUState *cpu, vaddr addr,
 174                                         MemTxAttrs *attrs);
 175     int (*asidx_from_attrs)(CPUState *cpu, MemTxAttrs attrs);
 176     int (*gdb_read_register)(CPUState *cpu, uint8_t *buf, int reg);
 177     int (*gdb_write_register)(CPUState *cpu, uint8_t *buf, int reg);
 178     bool (*debug_check_watchpoint)(CPUState *cpu, CPUWatchpoint *wp);
 179     void (*debug_excp_handler)(CPUState *cpu);
 180
 181     int (*write_elf64_note)(WriteCoreDumpFunction f, CPUState *cpu,
 182                             int cpuid, void *opaque);
 183     int (*write_elf64_qemunote)(WriteCoreDumpFunction f, CPUState *cpu,
 184                                 void *opaque);
 185     int (*write_elf32_note)(WriteCoreDumpFunction f, CPUState *cpu,
 186                             int cpuid, void *opaque);
 187     int (*write_elf32_qemunote)(WriteCoreDumpFunction f, CPUState *cpu,
 188                                 void *opaque);
 189
 190     const struct VMStateDescription *vmsd;
 191     int gdb_num_core_regs;
 192     const char *gdb_core_xml_file;
 193     gchar * (*gdb_arch_name)(CPUState *cpu);
 194     bool gdb_stop_before_watchpoint;
 195
 196     void (*cpu_exec_enter)(CPUState *cpu);
 197     void (*cpu_exec_exit)(CPUState *cpu);
 198     bool (*cpu_exec_interrupt)(CPUState *cpu, int interrupt_request);
 199
 200     void (*disas_set_info)(CPUState *cpu, disassemble_info *info);
 201     vaddr (*adjust_watchpoint_address)(CPUState *cpu, vaddr addr, int len);
 202 } CPUClass;
 203
 204 #ifdef HOST_WORDS_BIGENDIAN
 205 typedef struct icount_decr_u16 {
 206     uint16_t high;
 207     uint16_t low;
 208 } icount_decr_u16;
 209 #else
 210 typedef struct icount_decr_u16 {
 211     uint16_t low;
 212     uint16_t high;
 213 } icount_decr_u16;
 214 #endif
 215
 216 typedef struct CPUBreakpoint {
 217     vaddr pc;
 218     int flags; /* BP_* */
 219     QTAILQ_ENTRY(CPUBreakpoint) entry;
 220 } CPUBreakpoint;
 221
 222 struct CPUWatchpoint {
 223     vaddr vaddr;
 224     vaddr len;
 225     vaddr hitaddr;
 226     MemTxAttrs hitattrs;
 227     int flags; /* BP_* */
 228     QTAILQ_ENTRY(CPUWatchpoint) entry;
 229 };
 230
 231 struct KVMState;
 232 struct kvm_run;
 233
 234 struct hax_vcpu_state;
 235
 236 #define TB_JMP_CACHE_BITS 12
 237 #define TB_JMP_CACHE_SIZE (1 << TB_JMP_CACHE_BITS)
 238
 239 /* work queue */
 240
 241 /* The union type allows passing of 64 bit target pointers on 32 bit
 242  * hosts in a single parameter
 243  */
 244 typedef union {
 245     int           host_int;
 246     unsigned long host_ulong;
 247     void         *host_ptr;
 248     vaddr         target_ptr;
 249 } run_on_cpu_data;
 250
 251 #define RUN_ON_CPU_HOST_PTR(p)    ((run_on_cpu_data){.host_ptr = (p)})
 252 #define RUN_ON_CPU_HOST_INT(i)    ((run_on_cpu_data){.host_int = (i)})
 253 #define RUN_ON_CPU_HOST_ULONG(ul) ((run_on_cpu_data){.host_ulong = (ul)})
 254 #define RUN_ON_CPU_TARGET_PTR(v)  ((run_on_cpu_data){.target_ptr = (v)})
 255 #define RUN_ON_CPU_NULL           RUN_ON_CPU_HOST_PTR(NULL)
 256
 257 typedef void (*run_on_cpu_func)(CPUState *cpu, run_on_cpu_data data);
 258
 259 struct qemu_work_item;
 260
 261 #define CPU_UNSET_NUMA_NODE_ID -1
 262
 263 /**
 264  * CPUState:
 265  * @cpu_index: CPU index (informative).
 266  * @nr_cores: Number of cores within this CPU package.
 267  * @nr_threads: Number of threads within this CPU.
 268  * @host_tid: Host thread ID.
 269  * @running: #true if CPU is currently running (lockless).
 270  * @has_waiter: #true if a CPU is currently waiting for the cpu_exec_end;
 271  * valid under cpu_list_lock.
 272  * @created: Indicates whether the CPU thread has been successfully created.
 273  * @interrupt_request: Indicates a pending interrupt request.
 274  * @halted: Nonzero if the CPU is in suspended state.
 275  * @stop: Indicates a pending stop request.
 276  * @stopped: Indicates the CPU has been artificially stopped.
 277  * @unplug: Indicates a pending CPU unplug request.
 278  * @crash_occurred: Indicates the OS reported a crash (panic) for this CPU
 279  * @singlestep_enabled: Flags for single-stepping.
 280  * @icount_extra: Instructions until next timer event.
 281  * @icount_decr: Low 16 bits: number of cycles left, only used in icount mode.
 282  * High 16 bits: Set to -1 to force TCG to stop executing linked TBs for this
 283  * CPU and return to its top level loop (even in non-icount mode).
 284  * This allows a single read-compare-cbranch-write sequence to test
 285  * for both decrementer underflow and exceptions.
 286  * @can_do_io: Nonzero if memory-mapped IO is safe. Deterministic execution
 287  * requires that IO only be performed on the last instruction of a TB
 288  * so that interrupts take effect immediately.
 289  * @cpu_ases: Pointer to array of CPUAddressSpaces (which define the
 290  *            AddressSpaces this CPU has)
 291  * @num_ases: number of CPUAddressSpaces in @cpu_ases
 292  * @as: Pointer to the first AddressSpace, for the convenience of targets which
 293  *      only have a single AddressSpace
 294  * @env_ptr: Pointer to subclass-specific CPUArchState field.
 295  * @gdb_regs: Additional GDB registers.
 296  * @gdb_num_regs: Number of total registers accessible to GDB.
 297  * @gdb_num_g_regs: Number of registers in GDB 'g' packets.
 298  * @next_cpu: Next CPU sharing TB cache.
 299  * @opaque: User data.
 300  * @mem_io_pc: Host Program Counter at which the memory was accessed.
 301  * @mem_io_vaddr: Target virtual address at which the memory was accessed.
 302  * @kvm_fd: vCPU file descriptor for KVM.
 303  * @work_mutex: Lock to prevent multiple access to queued_work_*.
 304  * @queued_work_first: First asynchronous work pending.
 305  * @trace_dstate: Dynamic tracing state of events for this vCPU (bitmask).
 306  *
 307  * State of one CPU core or thread.
 308  */
 309 struct CPUState {
 310     /*< private >*/
 311     DeviceState parent_obj;
 312     /*< public >*/
 313
 314     int nr_cores;
 315     int nr_threads;
 316
 317     struct QemuThread *thread;
 318 #ifdef _WIN32
 319     HANDLE hThread;
 320 #endif
 321     int thread_id;
 322     uint32_t host_tid;
 323     bool running, has_waiter;
 324     struct QemuCond *halt_cond;
 325     bool thread_kicked;
 326     bool created;
 327     bool stop;
 328     bool stopped;
 329     bool unplug;
 330     bool crash_occurred;
 331     bool exit_request;
 332     /* updates protected by BQL */
 333     uint32_t interrupt_request;
 334     int singlestep_enabled;
 335     int64_t icount_budget;
 336     int64_t icount_extra;
 337     sigjmp_buf jmp_env;
 338
 339     QemuMutex work_mutex;
 340     struct qemu_work_item *queued_work_first, *queued_work_last;
 341
 342     CPUAddressSpace *cpu_ases;
 343     int num_ases;
 344     AddressSpace *as;
 345     MemoryRegion *memory;
 346
 347     void *env_ptr; /* CPUArchState */
 348
 349     /* Writes protected by tb_lock, reads not thread-safe  */
 350     struct TranslationBlock *tb_jmp_cache[TB_JMP_CACHE_SIZE];
 351
 352     struct GDBRegisterState *gdb_regs;
 353     int gdb_num_regs;
 354     int gdb_num_g_regs;
 355     QTAILQ_ENTRY(CPUState) node;
 356
 357     /* ice debug support */
 358     QTAILQ_HEAD(breakpoints_head, CPUBreakpoint) breakpoints;
 359
 360     QTAILQ_HEAD(watchpoints_head, CPUWatchpoint) watchpoints;
 361     CPUWatchpoint *watchpoint_hit;
 362
 363     void *opaque;
 364
 365     /* In order to avoid passing too many arguments to the MMIO helpers,
 366      * we store some rarely used information in the CPU context.
 367      */
 368     uintptr_t mem_io_pc;
 369     vaddr mem_io_vaddr;
 370
 371     int kvm_fd;
 372     bool kvm_vcpu_dirty;
 373     struct KVMState *kvm_state;
 374     struct kvm_run *kvm_run;
 375
 376     /*
 377      * Used for events with 'vcpu' and *without* the 'disabled' properties.
 378      * Dynamically allocated based on bitmap requried to hold up to
 379      * trace_get_vcpu_event_count() entries.
 380      */
 381     unsigned long *trace_dstate;
 382
 383     /* TODO Move common fields from CPUArchState here. */
 384     int cpu_index; /* used by alpha TCG */
 385     uint32_t halted; /* used by alpha, cris, ppc TCG */
 386     uint32_t can_do_io;
 387     int32_t exception_index; /* used by m68k TCG */
 388
 389     /* Used to keep track of an outstanding cpu throttle thread for migration
 390      * autoconverge
 391      */
 392     bool throttle_thread_scheduled;
 393
 394     /* Note that this is accessed at the start of every TB via a negative
 395        offset from AREG0.  Leave this field at the end so as to make the
 396        (absolute value) offset as small as possible.  This reduces code
 397        size, especially for hosts without large memory offsets.  */
 398     union {
 399         uint32_t u32;
 400         icount_decr_u16 u16;
 401     } icount_decr;
 402
 403     bool hax_vcpu_dirty;
 404     struct hax_vcpu_state *hax_vcpu;
 405
 406     /* The pending_tlb_flush flag is set and cleared atomically to
 407      * avoid potential races. The aim of the flag is to avoid
 408      * unnecessary flushes.
 409      */
 410     uint16_t pending_tlb_flush;
 411 };
 412
 413 QTAILQ_HEAD(CPUTailQ, CPUState);
 414 extern struct CPUTailQ cpus;
 415 #define CPU_NEXT(cpu) QTAILQ_NEXT(cpu, node)
 416 #define CPU_FOREACH(cpu) QTAILQ_FOREACH(cpu, &cpus, node)
 417 #define CPU_FOREACH_SAFE(cpu, next_cpu) \
 418     QTAILQ_FOREACH_SAFE(cpu, &cpus, node, next_cpu)
 419 #define CPU_FOREACH_REVERSE(cpu) \
 420     QTAILQ_FOREACH_REVERSE(cpu, &cpus, CPUTailQ, node)
 421 #define first_cpu QTAILQ_FIRST(&cpus)
 422
 423 extern __thread CPUState *current_cpu;
 424
 425 /**
 426  * qemu_tcg_mttcg_enabled:
 427  * Check whether we are running MultiThread TCG or not.
 428  *
 429  * Returns: %true if we are in MTTCG mode %false otherwise.
 430  */
 431 extern bool mttcg_enabled;
 432 #define qemu_tcg_mttcg_enabled() (mttcg_enabled)
 433
 434 /**
 435  * cpu_paging_enabled:
 436  * @cpu: The CPU whose state is to be inspected.
 437  *
 438  * Returns: %true if paging is enabled, %false otherwise.
 439  */
 440 bool cpu_paging_enabled(const CPUState *cpu);
 441
 442 /**
 443  * cpu_get_memory_mapping:
 444  * @cpu: The CPU whose memory mappings are to be obtained.
 445  * @list: Where to write the memory mappings to.
 446  * @errp: Pointer for reporting an #Error.
 447  */
 448 void cpu_get_memory_mapping(CPUState *cpu, MemoryMappingList *list,
 449                             Error **errp);
 450
 451 /**
 452  * cpu_write_elf64_note:
 453  * @f: pointer to a function that writes memory to a file
 454  * @cpu: The CPU whose memory is to be dumped
 455  * @cpuid: ID number of the CPU
 456  * @opaque: pointer to the CPUState struct
 457  */
 458 int cpu_write_elf64_note(WriteCoreDumpFunction f, CPUState *cpu,
 459                          int cpuid, void *opaque);
 460
 461 /**
 462  * cpu_write_elf64_qemunote:
 463  * @f: pointer to a function that writes memory to a file
 464  * @cpu: The CPU whose memory is to be dumped
 465  * @cpuid: ID number of the CPU
 466  * @opaque: pointer to the CPUState struct
 467  */
 468 int cpu_write_elf64_qemunote(WriteCoreDumpFunction f, CPUState *cpu,
 469                              void *opaque);
 470
 471 /**
 472  * cpu_write_elf32_note:
 473  * @f: pointer to a function that writes memory to a file
 474  * @cpu: The CPU whose memory is to be dumped
 475  * @cpuid: ID number of the CPU
 476  * @opaque: pointer to the CPUState struct
 477  */
 478 int cpu_write_elf32_note(WriteCoreDumpFunction f, CPUState *cpu,
 479                          int cpuid, void *opaque);
 480
 481 /**
 482  * cpu_write_elf32_qemunote:
 483  * @f: pointer to a function that writes memory to a file
 484  * @cpu: The CPU whose memory is to be dumped
 485  * @cpuid: ID number of the CPU
 486  * @opaque: pointer to the CPUState struct
 487  */
 488 int cpu_write_elf32_qemunote(WriteCoreDumpFunction f, CPUState *cpu,
 489                              void *opaque);
 490
 491 /**
 492  * cpu_get_crash_info:
 493  * @cpu: The CPU to get crash information for
 494  *
 495  * Gets the previously saved crash information.
 496  * Caller is responsible for freeing the data.
 497  */
 498 GuestPanicInformation *cpu_get_crash_info(CPUState *cpu);
 499
 500 /**
 501  * CPUDumpFlags:
 502  * @CPU_DUMP_CODE:
 503  * @CPU_DUMP_FPU: dump FPU register state, not just integer
 504  * @CPU_DUMP_CCOP: dump info about TCG QEMU's condition code optimization state
 505  */
 506 enum CPUDumpFlags {
 507     CPU_DUMP_CODE = 0x00010000,
 508     CPU_DUMP_FPU  = 0x00020000,
 509     CPU_DUMP_CCOP = 0x00040000,
 510 };
 511
 512 /**
 513  * cpu_dump_state:
 514  * @cpu: The CPU whose state is to be dumped.
 515  * @f: File to dump to.
 516  * @cpu_fprintf: Function to dump with.
 517  * @flags: Flags what to dump.
 518  *
 519  * Dumps CPU state.
 520  */
 521 void cpu_dump_state(CPUState *cpu, FILE *f, fprintf_function cpu_fprintf,
 522                     int flags);
 523
 524 /**
 525  * cpu_dump_statistics:
 526  * @cpu: The CPU whose state is to be dumped.
 527  * @f: File to dump to.
 528  * @cpu_fprintf: Function to dump with.
 529  * @flags: Flags what to dump.
 530  *
 531  * Dumps CPU statistics.
 532  */
 533 void cpu_dump_statistics(CPUState *cpu, FILE *f, fprintf_function cpu_fprintf,
 534                          int flags);
 535
 536 #ifndef CONFIG_USER_ONLY
 537 /**
 538  * cpu_get_phys_page_attrs_debug:
 539  * @cpu: The CPU to obtain the physical page address for.
 540  * @addr: The virtual address.
 541  * @attrs: Updated on return with the memory transaction attributes to use
 542  *         for this access.
 543  *
 544  * Obtains the physical page corresponding to a virtual one, together
 545  * with the corresponding memory transaction attributes to use for the access.
 546  * Use it only for debugging because no protection checks are done.
 547  *
 548  * Returns: Corresponding physical page address or -1 if no page found.
 549  */
 550 static inline hwaddr cpu_get_phys_page_attrs_debug(CPUState *cpu, vaddr addr,
 551                                                    MemTxAttrs *attrs)
 552 {
 553     CPUClass *cc = CPU_GET_CLASS(cpu);
 554
 555     if (cc->get_phys_page_attrs_debug) {
 556         return cc->get_phys_page_attrs_debug(cpu, addr, attrs);
 557     }
 558     /* Fallback for CPUs which don't implement the _attrs_ hook */
 559     *attrs = MEMTXATTRS_UNSPECIFIED;
 560     return cc->get_phys_page_debug(cpu, addr);
 561 }
 562
 563 /**
 564  * cpu_get_phys_page_debug:
 565  * @cpu: The CPU to obtain the physical page address for.
 566  * @addr: The virtual address.
 567  *
 568  * Obtains the physical page corresponding to a virtual one.
 569  * Use it only for debugging because no protection checks are done.
 570  *
 571  * Returns: Corresponding physical page address or -1 if no page found.
 572  */
 573 static inline hwaddr cpu_get_phys_page_debug(CPUState *cpu, vaddr addr)
 574 {
 575     MemTxAttrs attrs = {};
 576
 577     return cpu_get_phys_page_attrs_debug(cpu, addr, &attrs);
 578 }
 579
 580 /** cpu_asidx_from_attrs:
 581  * @cpu: CPU
 582  * @attrs: memory transaction attributes
 583  *
 584  * Returns the address space index specifying the CPU AddressSpace
 585  * to use for a memory access with the given transaction attributes.
 586  */
 587 static inline int cpu_asidx_from_attrs(CPUState *cpu, MemTxAttrs attrs)
 588 {
 589     CPUClass *cc = CPU_GET_CLASS(cpu);
 590
 591     if (cc->asidx_from_attrs) {
 592         return cc->asidx_from_attrs(cpu, attrs);
 593     }
 594     return 0;
 595 }
 596 #endif
 597
 598 /**
 599  * cpu_list_add:
 600  * @cpu: The CPU to be added to the list of CPUs.
 601  */
 602 void cpu_list_add(CPUState *cpu);
 603
 604 /**
 605  * cpu_list_remove:
 606  * @cpu: The CPU to be removed from the list of CPUs.
 607  */
 608 void cpu_list_remove(CPUState *cpu);
 609
 610 /**
 611  * cpu_reset:
 612  * @cpu: The CPU whose state is to be reset.
 613  */
 614 void cpu_reset(CPUState *cpu);
 615
 616 /**
 617  * cpu_class_by_name:
 618  * @typename: The CPU base type.
 619  * @cpu_model: The model string without any parameters.
 620  *
 621  * Looks up a CPU #ObjectClass matching name @cpu_model.
 622  *
 623  * Returns: A #CPUClass or %NULL if not matching class is found.
 624  */
 625 ObjectClass *cpu_class_by_name(const char *typename, const char *cpu_model);
 626
 627 /**
 628  * cpu_generic_init:
 629  * @typename: The CPU base type.
 630  * @cpu_model: The model string including optional parameters.
 631  *
 632  * Instantiates a CPU, processes optional parameters and realizes the CPU.
 633  *
 634  * Returns: A #CPUState or %NULL if an error occurred.
 635  */
 636 CPUState *cpu_generic_init(const char *typename, const char *cpu_model);
 637
 638 /**
 639  * cpu_has_work:
 640  * @cpu: The vCPU to check.
 641  *
 642  * Checks whether the CPU has work to do.
 643  *
 644  * Returns: %true if the CPU has work, %false otherwise.
 645  */
 646 static inline bool cpu_has_work(CPUState *cpu)
 647 {
 648     CPUClass *cc = CPU_GET_CLASS(cpu);
 649
 650     g_assert(cc->has_work);
 651     return cc->has_work(cpu);
 652 }
 653
 654 /**
 655  * qemu_cpu_is_self:
 656  * @cpu: The vCPU to check against.
 657  *
 658  * Checks whether the caller is executing on the vCPU thread.
 659  *
 660  * Returns: %true if called from @cpu's thread, %false otherwise.
 661  */
 662 bool qemu_cpu_is_self(CPUState *cpu);
 663
 664 /**
 665  * qemu_cpu_kick:
 666  * @cpu: The vCPU to kick.
 667  *
 668  * Kicks @cpu's thread.
 669  */
 670 void qemu_cpu_kick(CPUState *cpu);
 671
 672 /**
 673  * cpu_is_stopped:
 674  * @cpu: The CPU to check.
 675  *
 676  * Checks whether the CPU is stopped.
 677  *
 678  * Returns: %true if run state is not running or if artificially stopped;
 679  * %false otherwise.
 680  */
 681 bool cpu_is_stopped(CPUState *cpu);
 682
 683 /**
 684  * do_run_on_cpu:
 685  * @cpu: The vCPU to run on.
 686  * @func: The function to be executed.
 687  * @data: Data to pass to the function.
 688  * @mutex: Mutex to release while waiting for @func to run.
 689  *
 690  * Used internally in the implementation of run_on_cpu.
 691  */
 692 void do_run_on_cpu(CPUState *cpu, run_on_cpu_func func, run_on_cpu_data data,
 693                    QemuMutex *mutex);
 694
 695 /**
 696  * run_on_cpu:
 697  * @cpu: The vCPU to run on.
 698  * @func: The function to be executed.
 699  * @data: Data to pass to the function.
 700  *
 701  * Schedules the function @func for execution on the vCPU @cpu.
 702  */
 703 void run_on_cpu(CPUState *cpu, run_on_cpu_func func, run_on_cpu_data data);
 704
 705 /**
 706  * async_run_on_cpu:
 707  * @cpu: The vCPU to run on.
 708  * @func: The function to be executed.
 709  * @data: Data to pass to the function.
 710  *
 711  * Schedules the function @func for execution on the vCPU @cpu asynchronously.
 712  */
 713 void async_run_on_cpu(CPUState *cpu, run_on_cpu_func func, run_on_cpu_data data);
 714
 715 /**
 716  * async_safe_run_on_cpu:
 717  * @cpu: The vCPU to run on.
 718  * @func: The function to be executed.
 719  * @data: Data to pass to the function.
 720  *
 721  * Schedules the function @func for execution on the vCPU @cpu asynchronously,
 722  * while all other vCPUs are sleeping.
 723  *
 724  * Unlike run_on_cpu and async_run_on_cpu, the function is run outside the
 725  * BQL.
 726  */
 727 void async_safe_run_on_cpu(CPUState *cpu, run_on_cpu_func func, run_on_cpu_data data);
 728
 729 /**
 730  * qemu_get_cpu:
 731  * @index: The CPUState@cpu_index value of the CPU to obtain.
 732  *
 733  * Gets a CPU matching @index.
 734  *
 735  * Returns: The CPU or %NULL if there is no matching CPU.
 736  */
 737 CPUState *qemu_get_cpu(int index);
 738
 739 /**
 740  * cpu_exists:
 741  * @id: Guest-exposed CPU ID to lookup.
 742  *
 743  * Search for CPU with specified ID.
 744  *
 745  * Returns: %true - CPU is found, %false - CPU isn't found.
 746  */
 747 bool cpu_exists(int64_t id);
 748
 749 /**
 750  * cpu_throttle_set:
 751  * @new_throttle_pct: Percent of sleep time. Valid range is 1 to 99.
 752  *
 753  * Throttles all vcpus by forcing them to sleep for the given percentage of
 754  * time. A throttle_percentage of 25 corresponds to a 75% duty cycle roughly.
 755  * (example: 10ms sleep for every 30ms awake).
 756  *
 757  * cpu_throttle_set can be called as needed to adjust new_throttle_pct.
 758  * Once the throttling starts, it will remain in effect until cpu_throttle_stop
 759  * is called.
 760  */
 761 void cpu_throttle_set(int new_throttle_pct);
 762
 763 /**
 764  * cpu_throttle_stop:
 765  *
 766  * Stops the vcpu throttling started by cpu_throttle_set.
 767  */
 768 void cpu_throttle_stop(void);
 769
 770 /**
 771  * cpu_throttle_active:
 772  *
 773  * Returns: %true if the vcpus are currently being throttled, %false otherwise.
 774  */
 775 bool cpu_throttle_active(void);
 776
 777 /**
 778  * cpu_throttle_get_percentage:
 779  *
 780  * Returns the vcpu throttle percentage. See cpu_throttle_set for details.
 781  *
 782  * Returns: The throttle percentage in range 1 to 99.
 783  */
 784 int cpu_throttle_get_percentage(void);
 785
 786 #ifndef CONFIG_USER_ONLY
 787
 788 typedef void (*CPUInterruptHandler)(CPUState *, int);
 789
 790 extern CPUInterruptHandler cpu_interrupt_handler;
 791
 792 /**
 793  * cpu_interrupt:
 794  * @cpu: The CPU to set an interrupt on.
 795  * @mask: The interupts to set.
 796  *
 797  * Invokes the interrupt handler.
 798  */
 799 static inline void cpu_interrupt(CPUState *cpu, int mask)
 800 {
 801     cpu_interrupt_handler(cpu, mask);
 802 }
 803
 804 #else /* USER_ONLY */
 805
 806 void cpu_interrupt(CPUState *cpu, int mask);
 807
 808 #endif /* USER_ONLY */
 809
 810 #ifdef CONFIG_SOFTMMU
 811 static inline void cpu_unassigned_access(CPUState *cpu, hwaddr addr,
 812                                          bool is_write, bool is_exec,
 813                                          int opaque, unsigned size)
 814 {
 815     CPUClass *cc = CPU_GET_CLASS(cpu);
 816
 817     if (cc->do_unassigned_access) {
 818         cc->do_unassigned_access(cpu, addr, is_write, is_exec, opaque, size);
 819     }
 820 }
 821
 822 static inline void cpu_unaligned_access(CPUState *cpu, vaddr addr,
 823                                         MMUAccessType access_type,
 824                                         int mmu_idx, uintptr_t retaddr)
 825 {
 826     CPUClass *cc = CPU_GET_CLASS(cpu);
 827
 828     cc->do_unaligned_access(cpu, addr, access_type, mmu_idx, retaddr);
 829 }
 830 #endif
 831
 832 /**
 833  * cpu_set_pc:
 834  * @cpu: The CPU to set the program counter for.
 835  * @addr: Program counter value.
 836  *
 837  * Sets the program counter for a CPU.
 838  */
 839 static inline void cpu_set_pc(CPUState *cpu, vaddr addr)
 840 {
 841     CPUClass *cc = CPU_GET_CLASS(cpu);
 842
 843     cc->set_pc(cpu, addr);
 844 }
 845
 846 /**
 847  * cpu_reset_interrupt:
 848  * @cpu: The CPU to clear the interrupt on.
 849  * @mask: The interrupt mask to clear.
 850  *
 851  * Resets interrupts on the vCPU @cpu.
 852  */
 853 void cpu_reset_interrupt(CPUState *cpu, int mask);
 854
 855 /**
 856  * cpu_exit:
 857  * @cpu: The CPU to exit.
 858  *
 859  * Requests the CPU @cpu to exit execution.
 860  */
 861 void cpu_exit(CPUState *cpu);
 862
 863 /**
 864  * cpu_resume:
 865  * @cpu: The CPU to resume.
 866  *
 867  * Resumes CPU, i.e. puts CPU into runnable state.
 868  */
 869 void cpu_resume(CPUState *cpu);
 870
 871 /**
 872  * cpu_remove:
 873  * @cpu: The CPU to remove.
 874  *
 875  * Requests the CPU to be removed.
 876  */
 877 void cpu_remove(CPUState *cpu);
 878
 879  /**
 880  * cpu_remove_sync:
 881  * @cpu: The CPU to remove.
 882  *
 883  * Requests the CPU to be removed and waits till it is removed.
 884  */
 885 void cpu_remove_sync(CPUState *cpu);
 886
 887 /**
 888  * process_queued_cpu_work() - process all items on CPU work queue
 889  * @cpu: The CPU which work queue to process.
 890  */
 891 void process_queued_cpu_work(CPUState *cpu);
 892
 893 /**
 894  * cpu_exec_start:
 895  * @cpu: The CPU for the current thread.
 896  *
 897  * Record that a CPU has started execution and can be interrupted with
 898  * cpu_exit.
 899  */
 900 void cpu_exec_start(CPUState *cpu);
 901
 902 /**
 903  * cpu_exec_end:
 904  * @cpu: The CPU for the current thread.
 905  *
 906  * Record that a CPU has stopped execution and exclusive sections
 907  * can be executed without interrupting it.
 908  */
 909 void cpu_exec_end(CPUState *cpu);
 910
 911 /**
 912  * start_exclusive:
 913  *
 914  * Wait for a concurrent exclusive section to end, and then start
 915  * a section of work that is run while other CPUs are not running
 916  * between cpu_exec_start and cpu_exec_end.  CPUs that are running
 917  * cpu_exec are exited immediately.  CPUs that call cpu_exec_start
 918  * during the exclusive section go to sleep until this CPU calls
 919  * end_exclusive.
 920  */
 921 void start_exclusive(void);
 922
 923 /**
 924  * end_exclusive:
 925  *
 926  * Concludes an exclusive execution section started by start_exclusive.
 927  */
 928 void end_exclusive(void);
 929
 930 /**
 931  * qemu_init_vcpu:
 932  * @cpu: The vCPU to initialize.
 933  *
 934  * Initializes a vCPU.
 935  */
 936 void qemu_init_vcpu(CPUState *cpu);
 937
 938 #define SSTEP_ENABLE  0x1  /* Enable simulated HW single stepping */
 939 #define SSTEP_NOIRQ   0x2  /* Do not use IRQ while single stepping */
 940 #define SSTEP_NOTIMER 0x4  /* Do not Timers while single stepping */
 941
 942 /**
 943  * cpu_single_step:
 944  * @cpu: CPU to the flags for.
 945  * @enabled: Flags to enable.
 946  *
 947  * Enables or disables single-stepping for @cpu.
 948  */
 949 void cpu_single_step(CPUState *cpu, int enabled);
 950
 951 /* Breakpoint/watchpoint flags */
 952 #define BP_MEM_READ           0x01
 953 #define BP_MEM_WRITE          0x02
 954 #define BP_MEM_ACCESS         (BP_MEM_READ | BP_MEM_WRITE)
 955 #define BP_STOP_BEFORE_ACCESS 0x04
 956 /* 0x08 currently unused */
 957 #define BP_GDB                0x10
 958 #define BP_CPU                0x20
 959 #define BP_ANY                (BP_GDB | BP_CPU)
 960 #define BP_WATCHPOINT_HIT_READ 0x40
 961 #define BP_WATCHPOINT_HIT_WRITE 0x80
 962 #define BP_WATCHPOINT_HIT (BP_WATCHPOINT_HIT_READ | BP_WATCHPOINT_HIT_WRITE)
 963
 964 int cpu_breakpoint_insert(CPUState *cpu, vaddr pc, int flags,
 965                           CPUBreakpoint **breakpoint);
 966 int cpu_breakpoint_remove(CPUState *cpu, vaddr pc, int flags);
 967 void cpu_breakpoint_remove_by_ref(CPUState *cpu, CPUBreakpoint *breakpoint);
 968 void cpu_breakpoint_remove_all(CPUState *cpu, int mask);
 969
 970 /* Return true if PC matches an installed breakpoint.  */
 971 static inline bool cpu_breakpoint_test(CPUState *cpu, vaddr pc, int mask)
 972 {
 973     CPUBreakpoint *bp;
 974
 975     if (unlikely(!QTAILQ_EMPTY(&cpu->breakpoints))) {
 976         QTAILQ_FOREACH(bp, &cpu->breakpoints, entry) {
 977             if (bp->pc == pc && (bp->flags & mask)) {
 978                 return true;
 979             }
 980         }
 981     }
 982     return false;
 983 }
 984
 985 int cpu_watchpoint_insert(CPUState *cpu, vaddr addr, vaddr len,
 986                           int flags, CPUWatchpoint **watchpoint);
 987 int cpu_watchpoint_remove(CPUState *cpu, vaddr addr,
 988                           vaddr len, int flags);
 989 void cpu_watchpoint_remove_by_ref(CPUState *cpu, CPUWatchpoint *watchpoint);
 990 void cpu_watchpoint_remove_all(CPUState *cpu, int mask);
 991
 992 /**
 993  * cpu_get_address_space:
 994  * @cpu: CPU to get address space from
 995  * @asidx: index identifying which address space to get
 996  *
 997  * Return the requested address space of this CPU. @asidx
 998  * specifies which address space to read.
 999  */
1000 AddressSpace *cpu_get_address_space(CPUState *cpu, int asidx);
1001
1002 void QEMU_NORETURN cpu_abort(CPUState *cpu, const char *fmt, ...)
1003     GCC_FMT_ATTR(2, 3);
1004 void cpu_exec_initfn(CPUState *cpu);
1005 void cpu_exec_realizefn(CPUState *cpu, Error **errp);
1006 void cpu_exec_unrealizefn(CPUState *cpu);
1007
1008 #ifdef CONFIG_SOFTMMU
1009 extern const struct VMStateDescription vmstate_cpu_common;
1010 #else
1011 #define vmstate_cpu_common vmstate_dummy
1012 #endif
1013
1014 #define VMSTATE_CPU() {                                                     \
1015     .name = "parent_obj",                                                   \
1016     .size = sizeof(CPUState),                                               \
1017     .vmsd = &vmstate_cpu_common,                                            \
1018     .flags = VMS_STRUCT,                                                    \
1019     .offset = 0,                                                            \
1020 }
1021
1022 #define UNASSIGNED_CPU_INDEX -1
1023
1024 #endif