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