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 <signal.h>
  24 #include "hw/qdev-core.h"
  25 #include "exec/hwaddr.h"
  26 #include "qemu/thread.h"
  27 #include "qemu/tls.h"
  28 #include "qemu/typedefs.h"
  29
  30 typedef int (*WriteCoreDumpFunction)(void *buf, size_t size, void *opaque);
  31
  32 /**
  33  * vaddr:
  34  * Type wide enough to contain any #target_ulong virtual address.
  35  */
  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
  43
  44 /**
  45  * SECTION:cpu
  46  * @section_id: QEMU-cpu
  47  * @title: CPU Class
  48  * @short_description: Base class for all CPUs
  49  */
  50
  51 #define TYPE_CPU "cpu"
  52
  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)
  56
  57 typedef struct CPUState CPUState;
  58
  59 typedef void (*CPUUnassignedAccess)(CPUState *cpu, hwaddr addr,
  60                                     bool is_write, bool is_exec, int opaque,
  61                                     unsigned size);
  62
  63 struct TranslationBlock;
  64
  65 /**
  66  * CPUClass:
  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  * @memory_rw_debug: Callback for GDB memory access.
  74  * @dump_state: Callback for dumping state.
  75  * @dump_statistics: Callback for dumping statistics.
  76  * @get_arch_id: Callback for getting architecture-dependent CPU ID.
  77  * @get_paging_enabled: Callback for inquiring whether paging is enabled.
  78  * @get_memory_mapping: Callback for obtaining the memory mappings.
  79  * @set_pc: Callback for setting the Program Counter register.
  80  * @synchronize_from_tb: Callback for synchronizing state from a TCG
  81  * #TranslationBlock.
  82  * @get_phys_page_debug: Callback for obtaining a physical address.
  83  * @vmsd: State description for migration.
  84  *
  85  * Represents a CPU family or model.
  86  */
  87 typedef struct CPUClass {
  88     /*< private >*/
  89     DeviceClass parent_class;
  90     /*< public >*/
  91
  92     ObjectClass *(*class_by_name)(const char *cpu_model);
  93
  94     void (*reset)(CPUState *cpu);
  95     int reset_dump_flags;
  96     void (*do_interrupt)(CPUState *cpu);
  97     CPUUnassignedAccess do_unassigned_access;
  98     int (*memory_rw_debug)(CPUState *cpu, vaddr addr,
  99                            uint8_t *buf, int len, bool is_write);
 100     void (*dump_state)(CPUState *cpu, FILE *f, fprintf_function cpu_fprintf,
 101                        int flags);
 102     void (*dump_statistics)(CPUState *cpu, FILE *f,
 103                             fprintf_function cpu_fprintf, int flags);
 104     int64_t (*get_arch_id)(CPUState *cpu);
 105     bool (*get_paging_enabled)(const CPUState *cpu);
 106     void (*get_memory_mapping)(CPUState *cpu, MemoryMappingList *list,
 107                                Error **errp);
 108     void (*set_pc)(CPUState *cpu, vaddr value);
 109     void (*synchronize_from_tb)(CPUState *cpu, struct TranslationBlock *tb);
 110     hwaddr (*get_phys_page_debug)(CPUState *cpu, vaddr addr);
 111
 112     const struct VMStateDescription *vmsd;
 113     int (*write_elf64_note)(WriteCoreDumpFunction f, CPUState *cpu,
 114                             int cpuid, void *opaque);
 115     int (*write_elf64_qemunote)(WriteCoreDumpFunction f, CPUState *cpu,
 116                                 void *opaque);
 117     int (*write_elf32_note)(WriteCoreDumpFunction f, CPUState *cpu,
 118                             int cpuid, void *opaque);
 119     int (*write_elf32_qemunote)(WriteCoreDumpFunction f, CPUState *cpu,
 120                                 void *opaque);
 121 } CPUClass;
 122
 123 struct KVMState;
 124 struct kvm_run;
 125
 126 /**
 127  * CPUState:
 128  * @cpu_index: CPU index (informative).
 129  * @nr_cores: Number of cores within this CPU package.
 130  * @nr_threads: Number of threads within this CPU.
 131  * @numa_node: NUMA node this CPU is belonging to.
 132  * @host_tid: Host thread ID.
 133  * @running: #true if CPU is currently running (usermode).
 134  * @created: Indicates whether the CPU thread has been successfully created.
 135  * @interrupt_request: Indicates a pending interrupt request.
 136  * @halted: Nonzero if the CPU is in suspended state.
 137  * @stop: Indicates a pending stop request.
 138  * @stopped: Indicates the CPU has been artificially stopped.
 139  * @tcg_exit_req: Set to force TCG to stop executing linked TBs for this
 140  *           CPU and return to its top level loop.
 141  * @singlestep_enabled: Flags for single-stepping.
 142  * @env_ptr: Pointer to subclass-specific CPUArchState field.
 143  * @current_tb: Currently executing TB.
 144  * @next_cpu: Next CPU sharing TB cache.
 145  * @kvm_fd: vCPU file descriptor for KVM.
 146  *
 147  * State of one CPU core or thread.
 148  */
 149 struct CPUState {
 150     /*< private >*/
 151     DeviceState parent_obj;
 152     /*< public >*/
 153
 154     int nr_cores;
 155     int nr_threads;
 156     int numa_node;
 157
 158     struct QemuThread *thread;
 159 #ifdef _WIN32
 160     HANDLE hThread;
 161 #endif
 162     int thread_id;
 163     uint32_t host_tid;
 164     bool running;
 165     struct QemuCond *halt_cond;
 166     struct qemu_work_item *queued_work_first, *queued_work_last;
 167     bool thread_kicked;
 168     bool created;
 169     bool stop;
 170     bool stopped;
 171     volatile sig_atomic_t exit_request;
 172     volatile sig_atomic_t tcg_exit_req;
 173     uint32_t interrupt_request;
 174     int singlestep_enabled;
 175
 176     void *env_ptr; /* CPUArchState */
 177     struct TranslationBlock *current_tb;
 178     CPUState *next_cpu;
 179
 180     int kvm_fd;
 181     bool kvm_vcpu_dirty;
 182     struct KVMState *kvm_state;
 183     struct kvm_run *kvm_run;
 184
 185     /* TODO Move common fields from CPUArchState here. */
 186     int cpu_index; /* used by alpha TCG */
 187     uint32_t halted; /* used by alpha, cris, ppc TCG */
 188 };
 189
 190 extern CPUState *first_cpu;
 191
 192 DECLARE_TLS(CPUState *, current_cpu);
 193 #define current_cpu tls_var(current_cpu)
 194
 195 /**
 196  * cpu_paging_enabled:
 197  * @cpu: The CPU whose state is to be inspected.
 198  *
 199  * Returns: %true if paging is enabled, %false otherwise.
 200  */
 201 bool cpu_paging_enabled(const CPUState *cpu);
 202
 203 /**
 204  * cpu_get_memory_mapping:
 205  * @cpu: The CPU whose memory mappings are to be obtained.
 206  * @list: Where to write the memory mappings to.
 207  * @errp: Pointer for reporting an #Error.
 208  */
 209 void cpu_get_memory_mapping(CPUState *cpu, MemoryMappingList *list,
 210                             Error **errp);
 211
 212 /**
 213  * cpu_write_elf64_note:
 214  * @f: pointer to a function that writes memory to a file
 215  * @cpu: The CPU whose memory is to be dumped
 216  * @cpuid: ID number of the CPU
 217  * @opaque: pointer to the CPUState struct
 218  */
 219 int cpu_write_elf64_note(WriteCoreDumpFunction f, CPUState *cpu,
 220                          int cpuid, void *opaque);
 221
 222 /**
 223  * cpu_write_elf64_qemunote:
 224  * @f: pointer to a function that writes memory to a file
 225  * @cpu: The CPU whose memory is to be dumped
 226  * @cpuid: ID number of the CPU
 227  * @opaque: pointer to the CPUState struct
 228  */
 229 int cpu_write_elf64_qemunote(WriteCoreDumpFunction f, CPUState *cpu,
 230                              void *opaque);
 231
 232 /**
 233  * cpu_write_elf32_note:
 234  * @f: pointer to a function that writes memory to a file
 235  * @cpu: The CPU whose memory is to be dumped
 236  * @cpuid: ID number of the CPU
 237  * @opaque: pointer to the CPUState struct
 238  */
 239 int cpu_write_elf32_note(WriteCoreDumpFunction f, CPUState *cpu,
 240                          int cpuid, void *opaque);
 241
 242 /**
 243  * cpu_write_elf32_qemunote:
 244  * @f: pointer to a function that writes memory to a file
 245  * @cpu: The CPU whose memory is to be dumped
 246  * @cpuid: ID number of the CPU
 247  * @opaque: pointer to the CPUState struct
 248  */
 249 int cpu_write_elf32_qemunote(WriteCoreDumpFunction f, CPUState *cpu,
 250                              void *opaque);
 251
 252 /**
 253  * CPUDumpFlags:
 254  * @CPU_DUMP_CODE:
 255  * @CPU_DUMP_FPU: dump FPU register state, not just integer
 256  * @CPU_DUMP_CCOP: dump info about TCG QEMU's condition code optimization state
 257  */
 258 enum CPUDumpFlags {
 259     CPU_DUMP_CODE = 0x00010000,
 260     CPU_DUMP_FPU  = 0x00020000,
 261     CPU_DUMP_CCOP = 0x00040000,
 262 };
 263
 264 /**
 265  * cpu_dump_state:
 266  * @cpu: The CPU whose state is to be dumped.
 267  * @f: File to dump to.
 268  * @cpu_fprintf: Function to dump with.
 269  * @flags: Flags what to dump.
 270  *
 271  * Dumps CPU state.
 272  */
 273 void cpu_dump_state(CPUState *cpu, FILE *f, fprintf_function cpu_fprintf,
 274                     int flags);
 275
 276 /**
 277  * cpu_dump_statistics:
 278  * @cpu: The CPU whose state is to be dumped.
 279  * @f: File to dump to.
 280  * @cpu_fprintf: Function to dump with.
 281  * @flags: Flags what to dump.
 282  *
 283  * Dumps CPU statistics.
 284  */
 285 void cpu_dump_statistics(CPUState *cpu, FILE *f, fprintf_function cpu_fprintf,
 286                          int flags);
 287
 288 #ifndef CONFIG_USER_ONLY
 289 /**
 290  * cpu_get_phys_page_debug:
 291  * @cpu: The CPU to obtain the physical page address for.
 292  * @addr: The virtual address.
 293  *
 294  * Obtains the physical page corresponding to a virtual one.
 295  * Use it only for debugging because no protection checks are done.
 296  *
 297  * Returns: Corresponding physical page address or -1 if no page found.
 298  */
 299 static inline hwaddr cpu_get_phys_page_debug(CPUState *cpu, vaddr addr)
 300 {
 301     CPUClass *cc = CPU_GET_CLASS(cpu);
 302
 303     return cc->get_phys_page_debug(cpu, addr);
 304 }
 305 #endif
 306
 307 /**
 308  * cpu_reset:
 309  * @cpu: The CPU whose state is to be reset.
 310  */
 311 void cpu_reset(CPUState *cpu);
 312
 313 /**
 314  * cpu_class_by_name:
 315  * @typename: The CPU base type.
 316  * @cpu_model: The model string without any parameters.
 317  *
 318  * Looks up a CPU #ObjectClass matching name @cpu_model.
 319  *
 320  * Returns: A #CPUClass or %NULL if not matching class is found.
 321  */
 322 ObjectClass *cpu_class_by_name(const char *typename, const char *cpu_model);
 323
 324 /**
 325  * qemu_cpu_has_work:
 326  * @cpu: The vCPU to check.
 327  *
 328  * Checks whether the CPU has work to do.
 329  *
 330  * Returns: %true if the CPU has work, %false otherwise.
 331  */
 332 bool qemu_cpu_has_work(CPUState *cpu);
 333
 334 /**
 335  * qemu_cpu_is_self:
 336  * @cpu: The vCPU to check against.
 337  *
 338  * Checks whether the caller is executing on the vCPU thread.
 339  *
 340  * Returns: %true if called from @cpu's thread, %false otherwise.
 341  */
 342 bool qemu_cpu_is_self(CPUState *cpu);
 343
 344 /**
 345  * qemu_cpu_kick:
 346  * @cpu: The vCPU to kick.
 347  *
 348  * Kicks @cpu's thread.
 349  */
 350 void qemu_cpu_kick(CPUState *cpu);
 351
 352 /**
 353  * cpu_is_stopped:
 354  * @cpu: The CPU to check.
 355  *
 356  * Checks whether the CPU is stopped.
 357  *
 358  * Returns: %true if run state is not running or if artificially stopped;
 359  * %false otherwise.
 360  */
 361 bool cpu_is_stopped(CPUState *cpu);
 362
 363 /**
 364  * run_on_cpu:
 365  * @cpu: The vCPU to run on.
 366  * @func: The function to be executed.
 367  * @data: Data to pass to the function.
 368  *
 369  * Schedules the function @func for execution on the vCPU @cpu.
 370  */
 371 void run_on_cpu(CPUState *cpu, void (*func)(void *data), void *data);
 372
 373 /**
 374  * async_run_on_cpu:
 375  * @cpu: The vCPU to run on.
 376  * @func: The function to be executed.
 377  * @data: Data to pass to the function.
 378  *
 379  * Schedules the function @func for execution on the vCPU @cpu asynchronously.
 380  */
 381 void async_run_on_cpu(CPUState *cpu, void (*func)(void *data), void *data);
 382
 383 /**
 384  * qemu_for_each_cpu:
 385  * @func: The function to be executed.
 386  * @data: Data to pass to the function.
 387  *
 388  * Executes @func for each CPU.
 389  */
 390 void qemu_for_each_cpu(void (*func)(CPUState *cpu, void *data), void *data);
 391
 392 /**
 393  * qemu_get_cpu:
 394  * @index: The CPUState@cpu_index value of the CPU to obtain.
 395  *
 396  * Gets a CPU matching @index.
 397  *
 398  * Returns: The CPU or %NULL if there is no matching CPU.
 399  */
 400 CPUState *qemu_get_cpu(int index);
 401
 402 /**
 403  * cpu_exists:
 404  * @id: Guest-exposed CPU ID to lookup.
 405  *
 406  * Search for CPU with specified ID.
 407  *
 408  * Returns: %true - CPU is found, %false - CPU isn't found.
 409  */
 410 bool cpu_exists(int64_t id);
 411
 412 #ifndef CONFIG_USER_ONLY
 413
 414 typedef void (*CPUInterruptHandler)(CPUState *, int);
 415
 416 extern CPUInterruptHandler cpu_interrupt_handler;
 417
 418 /**
 419  * cpu_interrupt:
 420  * @cpu: The CPU to set an interrupt on.
 421  * @mask: The interupts to set.
 422  *
 423  * Invokes the interrupt handler.
 424  */
 425 static inline void cpu_interrupt(CPUState *cpu, int mask)
 426 {
 427     cpu_interrupt_handler(cpu, mask);
 428 }
 429
 430 #else /* USER_ONLY */
 431
 432 void cpu_interrupt(CPUState *cpu, int mask);
 433
 434 #endif /* USER_ONLY */
 435
 436 #ifndef CONFIG_USER_ONLY
 437
 438 static inline void cpu_unassigned_access(CPUState *cpu, hwaddr addr,
 439                                          bool is_write, bool is_exec,
 440                                          int opaque, unsigned size)
 441 {
 442     CPUClass *cc = CPU_GET_CLASS(cpu);
 443
 444     if (cc->do_unassigned_access) {
 445         cc->do_unassigned_access(cpu, addr, is_write, is_exec, opaque, size);
 446     }
 447 }
 448
 449 #endif
 450
 451 /**
 452  * cpu_reset_interrupt:
 453  * @cpu: The CPU to clear the interrupt on.
 454  * @mask: The interrupt mask to clear.
 455  *
 456  * Resets interrupts on the vCPU @cpu.
 457  */
 458 void cpu_reset_interrupt(CPUState *cpu, int mask);
 459
 460 /**
 461  * cpu_exit:
 462  * @cpu: The CPU to exit.
 463  *
 464  * Requests the CPU @cpu to exit execution.
 465  */
 466 void cpu_exit(CPUState *cpu);
 467
 468 /**
 469  * cpu_resume:
 470  * @cpu: The CPU to resume.
 471  *
 472  * Resumes CPU, i.e. puts CPU into runnable state.
 473  */
 474 void cpu_resume(CPUState *cpu);
 475
 476 /**
 477  * qemu_init_vcpu:
 478  * @cpu: The vCPU to initialize.
 479  *
 480  * Initializes a vCPU.
 481  */
 482 void qemu_init_vcpu(CPUState *cpu);
 483
 484 #define SSTEP_ENABLE  0x1  /* Enable simulated HW single stepping */
 485 #define SSTEP_NOIRQ   0x2  /* Do not use IRQ while single stepping */
 486 #define SSTEP_NOTIMER 0x4  /* Do not Timers while single stepping */
 487
 488 /**
 489  * cpu_single_step:
 490  * @cpu: CPU to the flags for.
 491  * @enabled: Flags to enable.
 492  *
 493  * Enables or disables single-stepping for @cpu.
 494  */
 495 void cpu_single_step(CPUState *cpu, int enabled);
 496
 497 #ifdef CONFIG_SOFTMMU
 498 extern const struct VMStateDescription vmstate_cpu_common;
 499 #else
 500 #define vmstate_cpu_common vmstate_dummy
 501 #endif
 502
 503 #define VMSTATE_CPU() {                                                     \
 504     .name = "parent_obj",                                                   \
 505     .size = sizeof(CPUState),                                               \
 506     .vmsd = &vmstate_cpu_common,                                            \
 507     .flags = VMS_STRUCT,                                                    \
 508     .offset = 0,                                                            \
 509 }
 510
 511 #endif