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 "qemu/thread.h"
  26
  27 /**
  28  * SECTION:cpu
  29  * @section_id: QEMU-cpu
  30  * @title: CPU Class
  31  * @short_description: Base class for all CPUs
  32  */
  33
  34 #define TYPE_CPU "cpu"
  35
  36 #define CPU(obj) OBJECT_CHECK(CPUState, (obj), TYPE_CPU)
  37 #define CPU_CLASS(class) OBJECT_CLASS_CHECK(CPUClass, (class), TYPE_CPU)
  38 #define CPU_GET_CLASS(obj) OBJECT_GET_CLASS(CPUClass, (obj), TYPE_CPU)
  39
  40 typedef struct CPUState CPUState;
  41
  42 /**
  43  * CPUClass:
  44  * @class_by_name: Callback to map -cpu command line model name to an
  45  * instantiatable CPU type.
  46  * @reset: Callback to reset the #CPUState to its initial state.
  47  *
  48  * Represents a CPU family or model.
  49  */
  50 typedef struct CPUClass {
  51     /*< private >*/
  52     DeviceClass parent_class;
  53     /*< public >*/
  54
  55     ObjectClass *(*class_by_name)(const char *cpu_model);
  56
  57     void (*reset)(CPUState *cpu);
  58 } CPUClass;
  59
  60 struct KVMState;
  61 struct kvm_run;
  62
  63 /**
  64  * CPUState:
  65  * @cpu_index: CPU index (informative).
  66  * @nr_cores: Number of cores within this CPU package.
  67  * @nr_threads: Number of threads within this CPU.
  68  * @numa_node: NUMA node this CPU is belonging to.
  69  * @host_tid: Host thread ID.
  70  * @running: #true if CPU is currently running (usermode).
  71  * @created: Indicates whether the CPU thread has been successfully created.
  72  * @stop: Indicates a pending stop request.
  73  * @stopped: Indicates the CPU has been artificially stopped.
  74  * @env_ptr: Pointer to subclass-specific CPUArchState field.
  75  * @current_tb: Currently executing TB.
  76  * @kvm_fd: vCPU file descriptor for KVM.
  77  *
  78  * State of one CPU core or thread.
  79  */
  80 struct CPUState {
  81     /*< private >*/
  82     DeviceState parent_obj;
  83     /*< public >*/
  84
  85     int nr_cores;
  86     int nr_threads;
  87     int numa_node;
  88
  89     struct QemuThread *thread;
  90 #ifdef _WIN32
  91     HANDLE hThread;
  92 #endif
  93     int thread_id;
  94     uint32_t host_tid;
  95     bool running;
  96     struct QemuCond *halt_cond;
  97     struct qemu_work_item *queued_work_first, *queued_work_last;
  98     bool thread_kicked;
  99     bool created;
 100     bool stop;
 101     bool stopped;
 102     volatile sig_atomic_t exit_request;
 103
 104     void *env_ptr; /* CPUArchState */
 105     struct TranslationBlock *current_tb;
 106
 107     int kvm_fd;
 108     bool kvm_vcpu_dirty;
 109     struct KVMState *kvm_state;
 110     struct kvm_run *kvm_run;
 111
 112     /* TODO Move common fields from CPUArchState here. */
 113     int cpu_index; /* used by alpha TCG */
 114 };
 115
 116
 117 /**
 118  * cpu_reset:
 119  * @cpu: The CPU whose state is to be reset.
 120  */
 121 void cpu_reset(CPUState *cpu);
 122
 123 /**
 124  * cpu_class_by_name:
 125  * @typename: The CPU base type.
 126  * @cpu_model: The model string without any parameters.
 127  *
 128  * Looks up a CPU #ObjectClass matching name @cpu_model.
 129  *
 130  * Returns: A #CPUClass or %NULL if not matching class is found.
 131  */
 132 ObjectClass *cpu_class_by_name(const char *typename, const char *cpu_model);
 133
 134 /**
 135  * qemu_cpu_has_work:
 136  * @cpu: The vCPU to check.
 137  *
 138  * Checks whether the CPU has work to do.
 139  *
 140  * Returns: %true if the CPU has work, %false otherwise.
 141  */
 142 bool qemu_cpu_has_work(CPUState *cpu);
 143
 144 /**
 145  * qemu_cpu_is_self:
 146  * @cpu: The vCPU to check against.
 147  *
 148  * Checks whether the caller is executing on the vCPU thread.
 149  *
 150  * Returns: %true if called from @cpu's thread, %false otherwise.
 151  */
 152 bool qemu_cpu_is_self(CPUState *cpu);
 153
 154 /**
 155  * qemu_cpu_kick:
 156  * @cpu: The vCPU to kick.
 157  *
 158  * Kicks @cpu's thread.
 159  */
 160 void qemu_cpu_kick(CPUState *cpu);
 161
 162 /**
 163  * cpu_is_stopped:
 164  * @cpu: The CPU to check.
 165  *
 166  * Checks whether the CPU is stopped.
 167  *
 168  * Returns: %true if run state is not running or if artificially stopped;
 169  * %false otherwise.
 170  */
 171 bool cpu_is_stopped(CPUState *cpu);
 172
 173 /**
 174  * run_on_cpu:
 175  * @cpu: The vCPU to run on.
 176  * @func: The function to be executed.
 177  * @data: Data to pass to the function.
 178  *
 179  * Schedules the function @func for execution on the vCPU @cpu.
 180  */
 181 void run_on_cpu(CPUState *cpu, void (*func)(void *data), void *data);
 182
 183 /**
 184  * qemu_get_cpu:
 185  * @index: The CPUState@cpu_index value of the CPU to obtain.
 186  *
 187  * Gets a CPU matching @index.
 188  *
 189  * Returns: The CPU or %NULL if there is no matching CPU.
 190  */
 191 CPUState *qemu_get_cpu(int index);
 192
 193
 194 #endif