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