include/qemu/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 "qemu/object.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     ObjectClass parent_class;
  50     /*< public >*/
  51
  52     void (*reset)(CPUState *cpu);
  53 } CPUClass;
  54
  55 struct KVMState;
  56
  57 /**
  58  * CPUState:
  59  * @created: Indicates whether the CPU thread has been successfully created.
  60  * @stop: Indicates a pending stop request.
  61  * @stopped: Indicates the CPU has been artificially stopped.
  62  * @kvm_fd: vCPU file descriptor for KVM.
  63  *
  64  * State of one CPU core or thread.
  65  */
  66 struct CPUState {
  67     /*< private >*/
  68     Object parent_obj;
  69     /*< public >*/
  70
  71     struct QemuThread *thread;
  72 #ifdef _WIN32
  73     HANDLE hThread;
  74 #endif
  75     int thread_id;
  76     struct QemuCond *halt_cond;
  77     struct qemu_work_item *queued_work_first, *queued_work_last;
  78     bool thread_kicked;
  79     bool created;
  80     bool stop;
  81     bool stopped;
  82
  83 #if !defined(CONFIG_USER_ONLY)
  84     int kvm_fd;
  85     bool kvm_vcpu_dirty;
  86 #endif
  87     struct KVMState *kvm_state;
  88
  89     /* TODO Move common fields from CPUArchState here. */
  90 };
  91
  92
  93 /**
  94  * cpu_reset:
  95  * @cpu: The CPU whose state is to be reset.
  96  */
  97 void cpu_reset(CPUState *cpu);
  98
  99 /**
 100  * qemu_cpu_has_work:
 101  * @cpu: The vCPU to check.
 102  *
 103  * Checks whether the CPU has work to do.
 104  *
 105  * Returns: %true if the CPU has work, %false otherwise.
 106  */
 107 bool qemu_cpu_has_work(CPUState *cpu);
 108
 109 /**
 110  * qemu_cpu_is_self:
 111  * @cpu: The vCPU to check against.
 112  *
 113  * Checks whether the caller is executing on the vCPU thread.
 114  *
 115  * Returns: %true if called from @cpu's thread, %false otherwise.
 116  */
 117 bool qemu_cpu_is_self(CPUState *cpu);
 118
 119 /**
 120  * qemu_cpu_kick:
 121  * @cpu: The vCPU to kick.
 122  *
 123  * Kicks @cpu's thread.
 124  */
 125 void qemu_cpu_kick(CPUState *cpu);
 126
 127 /**
 128  * cpu_is_stopped:
 129  * @cpu: The CPU to check.
 130  *
 131  * Checks whether the CPU is stopped.
 132  *
 133  * Returns: %true if run state is not running or if artificially stopped;
 134  * %false otherwise.
 135  */
 136 bool cpu_is_stopped(CPUState *cpu);
 137
 138 /**
 139  * run_on_cpu:
 140  * @cpu: The vCPU to run on.
 141  * @func: The function to be executed.
 142  * @data: Data to pass to the function.
 143  *
 144  * Schedules the function @func for execution on the vCPU @cpu.
 145  */
 146 void run_on_cpu(CPUState *cpu, void (*func)(void *data), void *data);
 147
 148
 149 #endif