1 /* $NetBSD: hypervisor.h,v 1.57 2023/02/25 00:34:48 riastradh Exp $ */
2
3 /*
4 * Copyright (c) 2006 Manuel Bouyer.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 *
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25 *
26 */
27
28 /*
29 *
30 * Communication to/from hypervisor.
31 *
32 * Copyright (c) 2002-2004, K A Fraser
33 *
34 * Permission is hereby granted, free of charge, to any person obtaining a copy
35 * of this source file (the "Software"), to deal in the Software without
36 * restriction, including without limitation the rights to use, copy, modify,
37 * merge, publish, distribute, sublicense, and/or sell copies of the Software,
38 * and to permit persons to whom the Software is furnished to do so, subject to
39 * the following conditions:
40 *
41 * The above copyright notice and this permission notice shall be included in
42 * all copies or substantial portions of the Software.
43 *
44 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
45 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
46 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
47 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
48 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
49 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
50 * IN THE SOFTWARE.
51 */
52
53
54 #ifndef _XEN_HYPERVISOR_H_
55 #define _XEN_HYPERVISOR_H_
56
57 #include "opt_xen.h"
58 #include "isa.h"
59 #include "pci.h"
60
61 struct cpu_info;
62
63 int xen_hvm_init(void);
64 int xen_hvm_init_cpu(struct cpu_info *);
65 void xen_mainbus_attach(device_t, device_t, void *);
66
67 struct hypervisor_attach_args {
68 const char *haa_busname;
69 };
70
71 struct xencons_attach_args {
72 const char *xa_device;
73 };
74
75 struct xen_npx_attach_args {
76 const char *xa_device;
77 };
78
79
80 #define u8 uint8_t
81 #define u16 uint16_t
82 #define u32 uint32_t
83 #define u64 uint64_t
84 #define s8 int8_t
85 #define s16 int16_t
86 #define s32 int32_t
87 #define s64 int64_t
88
89 #include <sys/atomic.h>
90
91 #include <xen/include/public/xen.h>
92 #include <xen/include/public/sched.h>
93 #include <xen/include/public/platform.h>
94 #if __XEN_INTERFACE_VERSION__ < 0x00030204
95 #include <xen/include/public/dom0_ops.h>
96 #endif
97 #include <xen/include/public/event_channel.h>
98 #include <xen/include/public/physdev.h>
99 #include <xen/include/public/memory.h>
100 #include <xen/include/public/io/netif.h>
101 #include <xen/include/public/io/blkif.h>
102 #include <xen/include/public/arch-x86/hvm/start_info.h>
103
104 #if __XEN_INTERFACE_VERSION < 0x00030208
105 /* Undo namespace damage from xen/include/public/io/ring.h
106 * The proper fix is to get upstream to stop assuming that all OSs use
107 * mb(), rmb(), wmb().
108 */
109 #undef xen_mb
110 #undef xen_rmb
111 #undef xen_wmb
112
113 #define xen_mb() membar_sync()
114 #define xen_rmb() membar_acquire()
115 #define xen_wmb() membar_release()
116 #endif /* __XEN_INTERFACE_VERSION */
117
118 #include <machine/xen/hypercalls.h>
119
120 #undef u8
121 #undef u16
122 #undef u32
123 #undef u64
124 #undef s8
125 #undef s16
126 #undef s32
127 #undef s64
128
129
130
131 /*
132 * a placeholder for the start of day information passed up from the hypervisor
133 */
134 union start_info_union
135 {
136 start_info_t start_info;
137 char padding[512];
138 };
139 extern union start_info_union start_info_union;
140 #define xen_start_info (start_info_union.start_info)
141
142 extern struct hvm_start_info *hvm_start_info;
143
144 /* For use in guest OSes. */
145 extern volatile shared_info_t *HYPERVISOR_shared_info;
146
147 /* console */
148 extern volatile struct xencons_interface *xencons_interface;
149
150
151 /* Structural guest handles introduced in 0x00030201. */
152 #if __XEN_INTERFACE_VERSION__ >= 0x00030201
153 #define xenguest_handle(hnd) (hnd).p
154 #else
155 #define xenguest_handle(hnd) hnd
156 #endif
157
158 /* hypervisor.c */
159 struct intrframe;
160 struct cpu_info;
161 void do_hypervisor_callback(struct intrframe *regs);
162 #if defined(XENPV) && (NPCI > 0 || NISA > 0)
163 void hypervisor_prime_pirq_event(int, unsigned int);
164 void hypervisor_ack_pirq_event(unsigned int);
165 #endif /* XENPV && ( NPCI > 0 || NISA > 0 ) */
166
167 extern int xen_version;
168 #define XEN_MAJOR(x) (((x) & 0xffff0000) >> 16)
169 #define XEN_MINOR(x) ((x) & 0x0000ffff)
170
171 /*
172 * Does the hypervisor we're running on support an api
173 * call at the requested version number ?
174 */
175 #define XEN_VERSION_SUPPORTED(major, minor) \
176 (XEN_MAJOR(xen_version) > (major) || \
177 (XEN_MAJOR(xen_version) == (major) && \
178 XEN_MINOR(xen_version) >= (minor)))
179
180 /* hypervisor_machdep.c */
181 void hypervisor_send_event(struct cpu_info *, unsigned int);
182 void hypervisor_unmask_event(unsigned int);
183 void hypervisor_mask_event(unsigned int);
184 void hypervisor_clear_event(unsigned int);
185 void hypervisor_enable_sir(unsigned int);
186 void hypervisor_set_ipending(uint64_t, int, int);
187 void hypervisor_machdep_attach(void);
188 void hypervisor_machdep_resume(void);
189
190 /*
191 * Force a proper event-channel callback from Xen after clearing the
192 * callback mask. We do this in a very simple manner, by making a call
193 * down into Xen. The pending flag will be checked by Xen on return.
194 */
hypervisor_force_callback(void)195 static __inline void hypervisor_force_callback(void)
196 {
197 (void)HYPERVISOR_xen_version(0, (void*)0);
198 } __attribute__((no_instrument_function)) /* used by mcount */
199
200 static __inline void
hypervisor_notify_via_evtchn(unsigned int port)201 hypervisor_notify_via_evtchn(unsigned int port)
202 {
203 evtchn_op_t op;
204
205 op.cmd = EVTCHNOP_send;
206 op.u.send.port = port;
207 (void)HYPERVISOR_event_channel_op(&op);
208 }
209
210 void xen_init_ksyms(void);
211 void xen_map_vcpu(struct cpu_info *);
212
213 #endif /* _XEN_HYPERVISOR_H_ */
214