xref: /openbmc/qemu/include/qemu/accel.h (revision 59851868)
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 struct AccelState {
30     /*< private >*/
31     Object parent_obj;
32 };
33 
34 typedef struct AccelClass {
35     /*< private >*/
36     ObjectClass parent_class;
37     /*< public >*/
38 
39     const char *name;
40     int (*init_machine)(MachineState *ms);
41 #ifndef CONFIG_USER_ONLY
42     void (*setup_post)(MachineState *ms, AccelState *accel);
43     bool (*has_memory)(MachineState *ms, AddressSpace *as,
44                        hwaddr start_addr, hwaddr size);
45 #endif
46     bool (*cpu_common_realize)(CPUState *cpu, Error **errp);
47     void (*cpu_common_unrealize)(CPUState *cpu);
48 
49     /* gdbstub related hooks */
50     int (*gdbstub_supported_sstep_flags)(void);
51 
52     bool *allowed;
53     /*
54      * Array of global properties that would be applied when specific
55      * accelerator is chosen. It works like MachineClass.compat_props
56      * but it's for accelerators not machines. Accelerator-provided
57      * global properties may be overridden by machine-type
58      * compat_props or user-provided global properties.
59      */
60     GPtrArray *compat_props;
61 } AccelClass;
62 
63 #define TYPE_ACCEL "accel"
64 
65 #define ACCEL_CLASS_SUFFIX  "-" TYPE_ACCEL
66 #define ACCEL_CLASS_NAME(a) (a ACCEL_CLASS_SUFFIX)
67 
68 #define ACCEL_CLASS(klass) \
69     OBJECT_CLASS_CHECK(AccelClass, (klass), TYPE_ACCEL)
70 #define ACCEL(obj) \
71     OBJECT_CHECK(AccelState, (obj), TYPE_ACCEL)
72 #define ACCEL_GET_CLASS(obj) \
73     OBJECT_GET_CLASS(AccelClass, (obj), TYPE_ACCEL)
74 
75 AccelClass *accel_find(const char *opt_name);
76 AccelState *current_accel(void);
77 const char *current_accel_name(void);
78 
79 void accel_init_interfaces(AccelClass *ac);
80 
81 #ifndef CONFIG_USER_ONLY
82 int accel_init_machine(AccelState *accel, MachineState *ms);
83 
84 /* Called just before os_setup_post (ie just before drop OS privs) */
85 void accel_setup_post(MachineState *ms);
86 #endif /* !CONFIG_USER_ONLY */
87 
88 /**
89  * accel_cpu_instance_init:
90  * @cpu: The CPU that needs to do accel-specific object initializations.
91  */
92 void accel_cpu_instance_init(CPUState *cpu);
93 
94 /**
95  * accel_cpu_common_realize:
96  * @cpu: The CPU that needs to call accel-specific cpu realization.
97  * @errp: currently unused.
98  */
99 bool accel_cpu_common_realize(CPUState *cpu, Error **errp);
100 
101 /**
102  * accel_cpu_common_unrealize:
103  * @cpu: The CPU that needs to call accel-specific cpu unrealization.
104  */
105 void accel_cpu_common_unrealize(CPUState *cpu);
106 
107 /**
108  * accel_supported_gdbstub_sstep_flags:
109  *
110  * Returns the supported single step modes for the configured
111  * accelerator.
112  */
113 int accel_supported_gdbstub_sstep_flags(void);
114 
115 #endif /* QEMU_ACCEL_H */
116