block-migration: improve "Unknown flags" error message
[qemu/cris-port.git] / include / qom / cpu.h
blob46f2247274a82eaed90cfaf90d40c0d91b927eff
1 /*
2 * QEMU CPU model
4 * Copyright (c) 2012 SUSE LINUX Products GmbH
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.
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.
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>
20 #ifndef QEMU_CPU_H
21 #define QEMU_CPU_H
23 #include "hw/qdev-core.h"
24 #include "qemu/thread.h"
26 /**
27 * SECTION:cpu
28 * @section_id: QEMU-cpu
29 * @title: CPU Class
30 * @short_description: Base class for all CPUs
33 #define TYPE_CPU "cpu"
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)
39 typedef struct CPUState CPUState;
41 /**
42 * CPUClass:
43 * @class_by_name: Callback to map -cpu command line model name to an
44 * instantiatable CPU type.
45 * @reset: Callback to reset the #CPUState to its initial state.
47 * Represents a CPU family or model.
49 typedef struct CPUClass {
50 /*< private >*/
51 DeviceClass parent_class;
52 /*< public >*/
54 ObjectClass *(*class_by_name)(const char *cpu_model);
56 void (*reset)(CPUState *cpu);
57 } CPUClass;
59 struct KVMState;
60 struct kvm_run;
62 /**
63 * CPUState:
64 * @cpu_index: CPU index (informative).
65 * @nr_cores: Number of cores within this CPU package.
66 * @nr_threads: Number of threads within this CPU.
67 * @numa_node: NUMA node this CPU is belonging to.
68 * @created: Indicates whether the CPU thread has been successfully created.
69 * @stop: Indicates a pending stop request.
70 * @stopped: Indicates the CPU has been artificially stopped.
71 * @kvm_fd: vCPU file descriptor for KVM.
73 * State of one CPU core or thread.
75 struct CPUState {
76 /*< private >*/
77 DeviceState parent_obj;
78 /*< public >*/
80 int nr_cores;
81 int nr_threads;
82 int numa_node;
84 struct QemuThread *thread;
85 #ifdef _WIN32
86 HANDLE hThread;
87 #endif
88 int thread_id;
89 struct QemuCond *halt_cond;
90 struct qemu_work_item *queued_work_first, *queued_work_last;
91 bool thread_kicked;
92 bool created;
93 bool stop;
94 bool stopped;
96 int kvm_fd;
97 bool kvm_vcpu_dirty;
98 struct KVMState *kvm_state;
99 struct kvm_run *kvm_run;
101 /* TODO Move common fields from CPUArchState here. */
102 int cpu_index; /* used by alpha TCG */
107 * cpu_reset:
108 * @cpu: The CPU whose state is to be reset.
110 void cpu_reset(CPUState *cpu);
113 * cpu_class_by_name:
114 * @typename: The CPU base type.
115 * @cpu_model: The model string without any parameters.
117 * Looks up a CPU #ObjectClass matching name @cpu_model.
119 * Returns: A #CPUClass or %NULL if not matching class is found.
121 ObjectClass *cpu_class_by_name(const char *typename, const char *cpu_model);
124 * qemu_cpu_has_work:
125 * @cpu: The vCPU to check.
127 * Checks whether the CPU has work to do.
129 * Returns: %true if the CPU has work, %false otherwise.
131 bool qemu_cpu_has_work(CPUState *cpu);
134 * qemu_cpu_is_self:
135 * @cpu: The vCPU to check against.
137 * Checks whether the caller is executing on the vCPU thread.
139 * Returns: %true if called from @cpu's thread, %false otherwise.
141 bool qemu_cpu_is_self(CPUState *cpu);
144 * qemu_cpu_kick:
145 * @cpu: The vCPU to kick.
147 * Kicks @cpu's thread.
149 void qemu_cpu_kick(CPUState *cpu);
152 * cpu_is_stopped:
153 * @cpu: The CPU to check.
155 * Checks whether the CPU is stopped.
157 * Returns: %true if run state is not running or if artificially stopped;
158 * %false otherwise.
160 bool cpu_is_stopped(CPUState *cpu);
163 * run_on_cpu:
164 * @cpu: The vCPU to run on.
165 * @func: The function to be executed.
166 * @data: Data to pass to the function.
168 * Schedules the function @func for execution on the vCPU @cpu.
170 void run_on_cpu(CPUState *cpu, void (*func)(void *data), void *data);
173 * qemu_get_cpu:
174 * @index: The CPUState@cpu_index value of the CPU to obtain.
176 * Gets a CPU matching @index.
178 * Returns: The CPU or %NULL if there is no matching CPU.
180 CPUState *qemu_get_cpu(int index);
183 #endif