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  * @kvm_fd: vCPU file descriptor for KVM.
  75  *
  76  * State of one CPU core or thread.
  77  */
  78 struct CPUState {
  79     /*< private >*/
  80     DeviceState parent_obj;
  81     /*< public >*/
  82
  83     int nr_cores;
  84     int nr_threads;
  85     int numa_node;
  86
  87     struct QemuThread *thread;
  88 #ifdef _WIN32
  89     HANDLE hThread;
  90 #endif
  91     int thread_id;
  92     uint32_t host_tid;
  93     bool running;
  94     struct QemuCond *halt_cond;
  95     struct qemu_work_item *queued_work_first, *queued_work_last;
  96     bool thread_kicked;
  97     bool created;
  98     bool stop;
  99     bool stopped;
 100     volatile sig_atomic_t exit_request;
 101
 102     int kvm_fd;
 103     bool kvm_vcpu_dirty;
 104     struct KVMState *kvm_state;
 105     struct kvm_run *kvm_run;
 106
 107     /* TODO Move common fields from CPUArchState here. */
 108     int cpu_index; /* used by alpha TCG */
 109 };
 110
 111
 112 /**
 113  * cpu_reset:
 114  * @cpu: The CPU whose state is to be reset.
 115  */
 116 void cpu_reset(CPUState *cpu);
 117
 118 /**
 119  * cpu_class_by_name:
 120  * @typename: The CPU base type.
 121  * @cpu_model: The model string without any parameters.
 122  *
 123  * Looks up a CPU #ObjectClass matching name @cpu_model.
 124  *
 125  * Returns: A #CPUClass or %NULL if not matching class is found.
 126  */
 127 ObjectClass *cpu_class_by_name(const char *typename, const char *cpu_model);
 128
 129 /**
 130  * qemu_cpu_has_work:
 131  * @cpu: The vCPU to check.
 132  *
 133  * Checks whether the CPU has work to do.
 134  *
 135  * Returns: %true if the CPU has work, %false otherwise.
 136  */
 137 bool qemu_cpu_has_work(CPUState *cpu);
 138
 139 /**
 140  * qemu_cpu_is_self:
 141  * @cpu: The vCPU to check against.
 142  *
 143  * Checks whether the caller is executing on the vCPU thread.
 144  *
 145  * Returns: %true if called from @cpu's thread, %false otherwise.
 146  */
 147 bool qemu_cpu_is_self(CPUState *cpu);
 148
 149 /**
 150  * qemu_cpu_kick:
 151  * @cpu: The vCPU to kick.
 152  *
 153  * Kicks @cpu's thread.
 154  */
 155 void qemu_cpu_kick(CPUState *cpu);
 156
 157 /**
 158  * cpu_is_stopped:
 159  * @cpu: The CPU to check.
 160  *
 161  * Checks whether the CPU is stopped.
 162  *
 163  * Returns: %true if run state is not running or if artificially stopped;
 164  * %false otherwise.
 165  */
 166 bool cpu_is_stopped(CPUState *cpu);
 167
 168 /**
 169  * run_on_cpu:
 170  * @cpu: The vCPU to run on.
 171  * @func: The function to be executed.
 172  * @data: Data to pass to the function.
 173  *
 174  * Schedules the function @func for execution on the vCPU @cpu.
 175  */
 176 void run_on_cpu(CPUState *cpu, void (*func)(void *data), void *data);
 177
 178 /**
 179  * qemu_get_cpu:
 180  * @index: The CPUState@cpu_index value of the CPU to obtain.
 181  *
 182  * Gets a CPU matching @index.
 183  *
 184  * Returns: The CPU or %NULL if there is no matching CPU.
 185  */
 186 CPUState *qemu_get_cpu(int index);
 187
 188
 189 #endif