xref: /openbmc/qemu/include/qemu/accel.h (revision f96b157ebb93f94cd56ebbc99bc20982b8fd86ef)
1 /* QEMU accelerator interfaces
2  *
3  * Copyright (c) 2014 Red Hat Inc
4  *
5  * Permission is hereby granted, free of charge, to any person obtaining a copy
6  * of this software and associated documentation files (the "Software"), to deal
7  * in the Software without restriction, including without limitation the rights
8  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9  * copies of the Software, and to permit persons to whom the Software is
10  * furnished to do so, subject to the following conditions:
11  *
12  * The above copyright notice and this permission notice shall be included in
13  * all copies or substantial portions of the Software.
14  *
15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
18  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21  * THE SOFTWARE.
22  */
23 #ifndef QEMU_ACCEL_H
24 #define QEMU_ACCEL_H
25 
26 #include "qom/object.h"
27 #include "exec/hwaddr.h"
28 
29 typedef struct AccelState AccelState;
30 typedef struct AccelClass AccelClass;
31 
32 #define TYPE_ACCEL "accel"
33 
34 #define ACCEL_CLASS_SUFFIX  "-" TYPE_ACCEL
35 #define ACCEL_CLASS_NAME(a) (a ACCEL_CLASS_SUFFIX)
36 
37 #define ACCEL_CLASS(klass) \
38     OBJECT_CLASS_CHECK(AccelClass, (klass), TYPE_ACCEL)
39 #define ACCEL(obj) \
40     OBJECT_CHECK(AccelState, (obj), TYPE_ACCEL)
41 #define ACCEL_GET_CLASS(obj) \
42     OBJECT_GET_CLASS(AccelClass, (obj), TYPE_ACCEL)
43 
44 AccelClass *accel_find(const char *opt_name);
45 AccelState *current_accel(void);
46 const char *current_accel_name(void);
47 
48 void accel_init_interfaces(AccelClass *ac);
49 
50 int accel_init_machine(AccelState *accel, MachineState *ms);
51 
52 /* Called just before os_setup_post (ie just before drop OS privs) */
53 void accel_setup_post(MachineState *ms);
54 
55 void accel_pre_resume(MachineState *ms, bool step_pending);
56 
57 /**
58  * accel_cpu_instance_init:
59  * @cpu: The CPU that needs to do accel-specific object initializations.
60  */
61 void accel_cpu_instance_init(CPUState *cpu);
62 
63 /**
64  * accel_cpu_common_realize:
65  * @cpu: The CPU that needs to call accel-specific cpu realization.
66  * @errp: currently unused.
67  */
68 bool accel_cpu_common_realize(CPUState *cpu, Error **errp);
69 
70 /**
71  * accel_cpu_common_unrealize:
72  * @cpu: The CPU that needs to call accel-specific cpu unrealization.
73  */
74 void accel_cpu_common_unrealize(CPUState *cpu);
75 
76 /**
77  * accel_supported_gdbstub_sstep_flags:
78  *
79  * Returns the supported single step modes for the configured
80  * accelerator.
81  */
82 int accel_supported_gdbstub_sstep_flags(void);
83 
84 #endif /* QEMU_ACCEL_H */
85