xref: /openbmc/linux/include/xen/xen-ops.h (revision ee8ec048)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef INCLUDE_XEN_OPS_H
3 #define INCLUDE_XEN_OPS_H
4 
5 #include <linux/percpu.h>
6 #include <linux/notifier.h>
7 #include <linux/efi.h>
8 #include <xen/features.h>
9 #include <asm/xen/interface.h>
10 #include <xen/interface/vcpu.h>
11 
12 DECLARE_PER_CPU(struct vcpu_info *, xen_vcpu);
13 
14 DECLARE_PER_CPU(uint32_t, xen_vcpu_id);
15 static inline uint32_t xen_vcpu_nr(int cpu)
16 {
17 	return per_cpu(xen_vcpu_id, cpu);
18 }
19 
20 #define XEN_VCPU_ID_INVALID U32_MAX
21 
22 void xen_arch_pre_suspend(void);
23 void xen_arch_post_suspend(int suspend_cancelled);
24 
25 void xen_timer_resume(void);
26 void xen_arch_resume(void);
27 void xen_arch_suspend(void);
28 
29 void xen_reboot(int reason);
30 
31 void xen_resume_notifier_register(struct notifier_block *nb);
32 void xen_resume_notifier_unregister(struct notifier_block *nb);
33 
34 bool xen_vcpu_stolen(int vcpu);
35 void xen_setup_runstate_info(int cpu);
36 void xen_time_setup_guest(void);
37 void xen_manage_runstate_time(int action);
38 void xen_get_runstate_snapshot(struct vcpu_runstate_info *res);
39 u64 xen_steal_clock(int cpu);
40 
41 int xen_setup_shutdown_event(void);
42 
43 extern unsigned long *xen_contiguous_bitmap;
44 
45 #if defined(CONFIG_XEN_PV) || defined(CONFIG_ARM) || defined(CONFIG_ARM64)
46 int xen_create_contiguous_region(phys_addr_t pstart, unsigned int order,
47 				unsigned int address_bits,
48 				dma_addr_t *dma_handle);
49 void xen_destroy_contiguous_region(phys_addr_t pstart, unsigned int order);
50 #endif
51 
52 #if defined(CONFIG_XEN_PV)
53 int xen_remap_pfn(struct vm_area_struct *vma, unsigned long addr,
54 		  xen_pfn_t *pfn, int nr, int *err_ptr, pgprot_t prot,
55 		  unsigned int domid, bool no_translate);
56 #else
57 static inline int xen_remap_pfn(struct vm_area_struct *vma, unsigned long addr,
58 				xen_pfn_t *pfn, int nr, int *err_ptr,
59 				pgprot_t prot,  unsigned int domid,
60 				bool no_translate)
61 {
62 	BUG();
63 	return 0;
64 }
65 #endif
66 
67 struct vm_area_struct;
68 
69 #ifdef CONFIG_XEN_AUTO_XLATE
70 int xen_xlate_remap_gfn_array(struct vm_area_struct *vma,
71 			      unsigned long addr,
72 			      xen_pfn_t *gfn, int nr,
73 			      int *err_ptr, pgprot_t prot,
74 			      unsigned int domid,
75 			      struct page **pages);
76 int xen_xlate_unmap_gfn_range(struct vm_area_struct *vma,
77 			      int nr, struct page **pages);
78 #else
79 /*
80  * These two functions are called from arch/x86/xen/mmu.c and so stubs
81  * are needed for a configuration not specifying CONFIG_XEN_AUTO_XLATE.
82  */
83 static inline int xen_xlate_remap_gfn_array(struct vm_area_struct *vma,
84 					    unsigned long addr,
85 					    xen_pfn_t *gfn, int nr,
86 					    int *err_ptr, pgprot_t prot,
87 					    unsigned int domid,
88 					    struct page **pages)
89 {
90 	return -EOPNOTSUPP;
91 }
92 
93 static inline int xen_xlate_unmap_gfn_range(struct vm_area_struct *vma,
94 					    int nr, struct page **pages)
95 {
96 	return -EOPNOTSUPP;
97 }
98 #endif
99 
100 int xen_remap_vma_range(struct vm_area_struct *vma, unsigned long addr,
101 			unsigned long len);
102 
103 /*
104  * xen_remap_domain_gfn_array() - map an array of foreign frames by gfn
105  * @vma:     VMA to map the pages into
106  * @addr:    Address at which to map the pages
107  * @gfn:     Array of GFNs to map
108  * @nr:      Number entries in the GFN array
109  * @err_ptr: Returns per-GFN error status.
110  * @prot:    page protection mask
111  * @domid:   Domain owning the pages
112  * @pages:   Array of pages if this domain has an auto-translated physmap
113  *
114  * @gfn and @err_ptr may point to the same buffer, the GFNs will be
115  * overwritten by the error codes after they are mapped.
116  *
117  * Returns the number of successfully mapped frames, or a -ve error
118  * code.
119  */
120 static inline int xen_remap_domain_gfn_array(struct vm_area_struct *vma,
121 					     unsigned long addr,
122 					     xen_pfn_t *gfn, int nr,
123 					     int *err_ptr, pgprot_t prot,
124 					     unsigned int domid,
125 					     struct page **pages)
126 {
127 	if (xen_feature(XENFEAT_auto_translated_physmap))
128 		return xen_xlate_remap_gfn_array(vma, addr, gfn, nr, err_ptr,
129 						 prot, domid, pages);
130 
131 	/* We BUG_ON because it's a programmer error to pass a NULL err_ptr,
132 	 * and the consequences later is quite hard to detect what the actual
133 	 * cause of "wrong memory was mapped in".
134 	 */
135 	BUG_ON(err_ptr == NULL);
136 	return xen_remap_pfn(vma, addr, gfn, nr, err_ptr, prot, domid,
137 			     false);
138 }
139 
140 /*
141  * xen_remap_domain_mfn_array() - map an array of foreign frames by mfn
142  * @vma:     VMA to map the pages into
143  * @addr:    Address at which to map the pages
144  * @mfn:     Array of MFNs to map
145  * @nr:      Number entries in the MFN array
146  * @err_ptr: Returns per-MFN error status.
147  * @prot:    page protection mask
148  * @domid:   Domain owning the pages
149  *
150  * @mfn and @err_ptr may point to the same buffer, the MFNs will be
151  * overwritten by the error codes after they are mapped.
152  *
153  * Returns the number of successfully mapped frames, or a -ve error
154  * code.
155  */
156 static inline int xen_remap_domain_mfn_array(struct vm_area_struct *vma,
157 					     unsigned long addr, xen_pfn_t *mfn,
158 					     int nr, int *err_ptr,
159 					     pgprot_t prot, unsigned int domid)
160 {
161 	if (xen_feature(XENFEAT_auto_translated_physmap))
162 		return -EOPNOTSUPP;
163 
164 	return xen_remap_pfn(vma, addr, mfn, nr, err_ptr, prot, domid,
165 			     true);
166 }
167 
168 /* xen_remap_domain_gfn_range() - map a range of foreign frames
169  * @vma:     VMA to map the pages into
170  * @addr:    Address at which to map the pages
171  * @gfn:     First GFN to map.
172  * @nr:      Number frames to map
173  * @prot:    page protection mask
174  * @domid:   Domain owning the pages
175  * @pages:   Array of pages if this domain has an auto-translated physmap
176  *
177  * Returns the number of successfully mapped frames, or a -ve error
178  * code.
179  */
180 static inline int xen_remap_domain_gfn_range(struct vm_area_struct *vma,
181 					     unsigned long addr,
182 					     xen_pfn_t gfn, int nr,
183 					     pgprot_t prot, unsigned int domid,
184 					     struct page **pages)
185 {
186 	if (xen_feature(XENFEAT_auto_translated_physmap))
187 		return -EOPNOTSUPP;
188 
189 	return xen_remap_pfn(vma, addr, &gfn, nr, NULL, prot, domid, false);
190 }
191 
192 int xen_unmap_domain_gfn_range(struct vm_area_struct *vma,
193 			       int numpgs, struct page **pages);
194 
195 int xen_xlate_map_ballooned_pages(xen_pfn_t **pfns, void **vaddr,
196 				  unsigned long nr_grant_frames);
197 
198 bool xen_running_on_version_or_later(unsigned int major, unsigned int minor);
199 
200 void xen_efi_runtime_setup(void);
201 
202 
203 #if defined(CONFIG_XEN_PV) && !defined(CONFIG_PREEMPTION)
204 
205 DECLARE_PER_CPU(bool, xen_in_preemptible_hcall);
206 
207 static inline void xen_preemptible_hcall_begin(void)
208 {
209 	__this_cpu_write(xen_in_preemptible_hcall, true);
210 }
211 
212 static inline void xen_preemptible_hcall_end(void)
213 {
214 	__this_cpu_write(xen_in_preemptible_hcall, false);
215 }
216 
217 #else
218 
219 static inline void xen_preemptible_hcall_begin(void) { }
220 static inline void xen_preemptible_hcall_end(void) { }
221 
222 #endif /* CONFIG_XEN_PV && !CONFIG_PREEMPTION */
223 
224 #endif /* INCLUDE_XEN_OPS_H */
225