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