kernel - Expand GDT table to maximum size
[dragonfly.git] / sys / dev / virtual / nvmm / nvmm_os.h
1 /*
2  * Copyright (c) 2021 Maxime Villard, m00nbsd.net
3  * Copyright (c) 2021 The DragonFly Project.
4  * All rights reserved.
5  *
6  * This code is part of the NVMM hypervisor.
7  *
8  * This code is derived from software contributed to The DragonFly Project
9  * by Aaron LI <aly@aaronly.me>
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  * 1. Redistributions of source code must retain the above copyright
15  *    notice, this list of conditions and the following disclaimer.
16  * 2. Redistributions in binary form must reproduce the above copyright
17  *    notice, this list of conditions and the following disclaimer in the
18  *    documentation and/or other materials provided with the distribution.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
21  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
22  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
23  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
24  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
25  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
26  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
27  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
28  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30  * SUCH DAMAGE.
31  */
32
33 #ifndef _NVMM_OS_H_
34 #define _NVMM_OS_H_
35
36 #ifndef _KERNEL
37 #error "This file should not be included by userland programs."
38 #endif
39
40 #if defined(__NetBSD__)
41 #include <sys/cpu.h>
42 #include <uvm/uvm_object.h>
43 #include <uvm/uvm_extern.h>
44 #include <uvm/uvm_page.h>
45 #elif defined(__DragonFly__)
46 #include <sys/lock.h>
47 #include <sys/malloc.h> /* contigmalloc, contigfree */
48 #include <sys/proc.h> /* LWP_MP_URETMASK */
49 #include <vm/vm.h>
50 #include <vm/vm_extern.h>
51 #include <vm/vm_map.h>
52 #include <vm/vm_object.h>
53 #include <vm/vm_page.h>
54 #include <vm/vm_pager.h>
55 #include <vm/vm_param.h> /* KERN_SUCCESS, etc. */
56 #include <vm/pmap.h> /* pmap_ept_transform, pmap_npt_transform */
57 #include <machine/cpu.h> /* nvmm_break_wanted */
58 #include <machine/cpufunc.h> /* ffsl, ffs, etc. */
59 #endif
60
61 /* -------------------------------------------------------------------------- */
62 /* Types. */
63 #if defined(__NetBSD__)
64 typedef struct vmspace          os_vmspace_t;
65 typedef struct uvm_object       os_vmobj_t;
66 typedef krwlock_t               os_rwl_t;
67 typedef kmutex_t                os_mtx_t;
68 #elif defined(__DragonFly__)
69 typedef struct vmspace          os_vmspace_t;
70 typedef struct vm_object        os_vmobj_t;
71 typedef struct lock             os_rwl_t;
72 typedef struct lock             os_mtx_t;
73 /* A few standard types. */
74 typedef vm_offset_t             vaddr_t;
75 typedef vm_offset_t             voff_t;
76 typedef vm_size_t               vsize_t;
77 typedef vm_paddr_t              paddr_t;
78 #endif
79
80 /* -------------------------------------------------------------------------- */
81 /* Attributes. */
82 #if defined(__DragonFly__)
83 #define DIAGNOSTIC              INVARIANTS
84 #define __cacheline_aligned     __cachealign
85 #define __diagused              __debugvar
86 #endif
87
88 /* -------------------------------------------------------------------------- */
89 /* Macros. */
90 #if defined(__DragonFly__)
91 #define __arraycount(__x)       (sizeof(__x) / sizeof(__x[0]))
92 #define __insn_barrier()        __asm __volatile("":::"memory")
93 #endif
94
95 /* -------------------------------------------------------------------------- */
96 /* Bitops. */
97 #if defined(__NetBSD__)
98 #include <sys/bitops.h>
99 #elif defined(__DragonFly__)
100 #include <sys/bitops.h>
101 #ifdef __x86_64__
102 #undef  __BIT
103 #define __BIT(__n)              __BIT64(__n)
104 #undef  __BITS
105 #define __BITS(__m, __n)        __BITS64(__m, __n)
106 #endif /* __x86_64__ */
107 #endif
108
109 /* -------------------------------------------------------------------------- */
110 /* Maps. */
111 #if defined(__NetBSD__) || defined(__DragonFly__)
112 #define os_kernel_map           kernel_map
113 #define os_curproc_map          &curproc->p_vmspace->vm_map
114 #endif
115
116 /* -------------------------------------------------------------------------- */
117 /* R/W locks. */
118 #if defined(__NetBSD__)
119 #define os_rwl_init(lock)       rw_init(lock)
120 #define os_rwl_destroy(lock)    rw_destroy(lock)
121 #define os_rwl_rlock(lock)      rw_enter(lock, RW_READER);
122 #define os_rwl_wlock(lock)      rw_enter(lock, RW_WRITER);
123 #define os_rwl_unlock(lock)     rw_exit(lock)
124 #define os_rwl_wheld(lock)      rw_write_held(lock)
125 #elif defined(__DragonFly__)
126 #define os_rwl_init(lock)       lockinit(lock, "nvmmrw", 0, 0)
127 #define os_rwl_destroy(lock)    lockuninit(lock)
128 #define os_rwl_rlock(lock)      lockmgr(lock, LK_SHARED);
129 #define os_rwl_wlock(lock)      lockmgr(lock, LK_EXCLUSIVE);
130 #define os_rwl_unlock(lock)     lockmgr(lock, LK_RELEASE)
131 #define os_rwl_wheld(lock)      (lockstatus(lock, curthread) == LK_EXCLUSIVE)
132 #endif
133
134 /* -------------------------------------------------------------------------- */
135 /* Mutexes. */
136 #if defined(__NetBSD__)
137 #define os_mtx_init(lock)       mutex_init(lock, MUTEX_DEFAULT, IPL_NONE)
138 #define os_mtx_destroy(lock)    mutex_destroy(lock)
139 #define os_mtx_lock(lock)       mutex_enter(lock)
140 #define os_mtx_unlock(lock)     mutex_exit(lock)
141 #define os_mtx_owned(lock)      mutex_owned(lock)
142 #elif defined(__DragonFly__)
143 #define os_mtx_init(lock)       lockinit(lock, "nvmmmtx", 0, 0)
144 #define os_mtx_destroy(lock)    lockuninit(lock)
145 #define os_mtx_lock(lock)       lockmgr(lock, LK_EXCLUSIVE)
146 #define os_mtx_unlock(lock)     lockmgr(lock, LK_RELEASE)
147 #define os_mtx_owned(lock)      (lockstatus(lock, curthread) == LK_EXCLUSIVE)
148 #endif
149
150 /* -------------------------------------------------------------------------- */
151 /* Malloc. */
152 #if defined(__NetBSD__)
153 #include <sys/kmem.h>
154 #define os_mem_alloc(size)      kmem_alloc(size, KM_SLEEP)
155 #define os_mem_zalloc(size)     kmem_zalloc(size, KM_SLEEP)
156 #define os_mem_free(ptr, size)  kmem_free(ptr, size)
157 #elif defined(__DragonFly__)
158 #include <sys/malloc.h>
159 MALLOC_DECLARE(M_NVMM);
160 #define os_mem_alloc(size)      kmalloc(size, M_NVMM, M_WAITOK)
161 #define os_mem_zalloc(size)     kmalloc(size, M_NVMM, M_WAITOK | M_ZERO)
162 #define os_mem_free(ptr, size)  kfree(ptr, M_NVMM)
163 #endif
164
165 /* -------------------------------------------------------------------------- */
166 /* Printf. */
167 #if defined(__NetBSD__)
168 #define os_printf               printf
169 #elif defined(__DragonFly__)
170 #define os_printf               kprintf
171 #endif
172
173 /* -------------------------------------------------------------------------- */
174 /* Atomics. */
175 #if defined(__NetBSD__)
176 #include <sys/atomic.h>
177 #define os_atomic_inc_uint(x)   atomic_inc_uint(x)
178 #define os_atomic_dec_uint(x)   atomic_dec_uint(x)
179 #define os_atomic_load_uint(x)  atomic_load_relaxed(x)
180 #define os_atomic_inc_64(x)     atomic_inc_64(x)
181 #elif defined(__DragonFly__)
182 #include <machine/atomic.h>
183 #define os_atomic_inc_uint(x)   atomic_add_int(x, 1)
184 #define os_atomic_dec_uint(x)   atomic_subtract_int(x, 1)
185 #define os_atomic_load_uint(x)  atomic_load_acq_int(x)
186 #define os_atomic_inc_64(x)     atomic_add_64(x, 1)
187 #endif
188
189 /* -------------------------------------------------------------------------- */
190 /* Pmap. */
191 #if defined(__NetBSD__)
192 #define os_vmspace_pdirpa(vm)   ((vm)->vm_map.pmap->pm_pdirpa[0])
193 #define os_pmap_mach(pm)        ((pm)->pm_data)
194 #elif defined(__DragonFly__)
195 #define os_vmspace_pdirpa(vm)   (vtophys(vmspace_pmap(vm)->pm_pml4))
196 #endif
197
198 /* -------------------------------------------------------------------------- */
199 /* CPU. */
200 #if defined(__NetBSD__)
201 #include <sys/cpu.h>
202 typedef struct cpu_info         os_cpu_t;
203 #define OS_MAXCPUS              MAXCPUS
204 #define OS_CPU_FOREACH(cpu)     for (CPU_INFO_FOREACH(, cpu))
205 #define os_cpu_number(cpu)      cpu_index(cpu)
206 #define os_cpu_lookup(idx)      cpu_lookup(idx)
207 #define os_curcpu()             curcpu()
208 #define os_curcpu_number()      cpu_number()
209 #define os_curcpu_tss_sel()     curcpu()->ci_tss_sel
210 #define os_curcpu_tss()         curcpu()->ci_tss
211 #define os_curcpu_gdt()         curcpu()->ci_gdt
212 #define os_curcpu_idt()         curcpu()->ci_idtvec.iv_idt
213 #elif defined(__DragonFly__)
214 #include <sys/globaldata.h>
215 #include <machine/segments.h>
216 typedef struct globaldata       os_cpu_t;
217 #define OS_MAXCPUS              SMP_MAXCPU
218 #define OS_CPU_FOREACH(cpu)     \
219         for (int idx = 0; idx < ncpus && (cpu = globaldata_find(idx)); idx++)
220 #define os_cpu_number(cpu)      (cpu)->gd_cpuid
221 #define os_cpu_lookup(idx)      globaldata_find(idx)
222 #define os_curcpu()             mycpu
223 #define os_curcpu_number()      mycpuid
224 #define os_curcpu_tss_sel()     GSEL(GPROC0_SEL, SEL_KPL)
225 #define os_curcpu_tss()         &mycpu->gd_prvspace->common_tss
226 #define os_curcpu_gdt()         mdcpu->gd_gdt
227 #define os_curcpu_idt()         r_idt_arr[mycpuid].rd_base
228 #endif
229
230 /* -------------------------------------------------------------------------- */
231 /* Cpusets. */
232 #if defined(__NetBSD__)
233 #include <sys/kcpuset.h>
234 typedef kcpuset_t               os_cpuset_t;
235 #define os_cpuset_init(s)       kcpuset_create(s, true)
236 #define os_cpuset_destroy(s)    kcpuset_destroy(s)
237 #define os_cpuset_isset(s, c)   kcpuset_isset(s, c)
238 #define os_cpuset_clear(s, c)   kcpuset_clear(s, c)
239 #define os_cpuset_setrunning(s) kcpuset_copy(s, kcpuset_running)
240 #elif defined(__DragonFly__)
241 #include <sys/cpumask.h>
242 #include <machine/smp.h> /* smp_active_mask */
243 typedef cpumask_t               os_cpuset_t;
244 #define os_cpuset_init(s)       \
245         ({ *(s) = kmalloc(sizeof(cpumask_t), M_NVMM, M_WAITOK | M_ZERO); })
246 #define os_cpuset_destroy(s)    kfree((s), M_NVMM)
247 #define os_cpuset_isset(s, c)   CPUMASK_TESTBIT(*(s), c)
248 #define os_cpuset_clear(s, c)   ATOMIC_CPUMASK_NANDBIT(*(s), c)
249 #define os_cpuset_setrunning(s) ATOMIC_CPUMASK_ORMASK(*(s), smp_active_mask)
250 #endif
251
252 /* -------------------------------------------------------------------------- */
253 /* Preemption. */
254 #if defined(__NetBSD__)
255 #define os_preempt_disable()    kpreempt_disable()
256 #define os_preempt_enable()     kpreempt_enable()
257 #define os_preempt_disabled()   kpreempt_disabled()
258 #elif defined(__DragonFly__)
259 /*
260  * In DragonFly, a normal kernel thread will not migrate to another CPU or be
261  * preempted (except by an interrupt thread), so kpreempt_{disable,enable}()
262  * are not needed.  However, we can't use critical section as an instead,
263  * because that would also prevent interrupt/reschedule flags from being
264  * set, which would be a problem for nvmm_return_needed() that's called from
265  * vcpu_run() loop.
266  */
267 #define os_preempt_disable()    /* nothing */
268 #define os_preempt_enable()     /* nothing */
269 #define os_preempt_disabled()   true
270 #endif
271
272 /* -------------------------------------------------------------------------- */
273 /* Asserts. */
274 #if defined(__NetBSD__)
275 #define OS_ASSERT               KASSERT
276 #elif defined(__DragonFly__)
277 #define OS_ASSERT               KKASSERT
278 #endif
279
280 /* -------------------------------------------------------------------------- */
281 /* Misc. */
282 #if defined(__DragonFly__)
283 #define ilog2(n)                ((sizeof(n) > 4 ? ffsl(n) : ffs(n)) - 1)
284 #define uimin(a, b)             ((u_int)a < (u_int)b ? (u_int)a : (u_int)b)
285 #endif
286
287 /* -------------------------------------------------------------------------- */
288 os_vmspace_t *  os_vmspace_create(vaddr_t, vaddr_t);
289 void            os_vmspace_destroy(os_vmspace_t *);
290 int             os_vmspace_fault(os_vmspace_t *, vaddr_t, vm_prot_t);
291
292 os_vmobj_t *    os_vmobj_create(voff_t);
293 void            os_vmobj_ref(os_vmobj_t *);
294 void            os_vmobj_rel(os_vmobj_t *);
295
296 int             os_vmobj_map(struct vm_map *, vaddr_t *, vsize_t, os_vmobj_t *,
297                     voff_t, bool, bool, bool, int, int);
298 void            os_vmobj_unmap(struct vm_map *map, vaddr_t, vaddr_t, bool);
299
300 void *          os_pagemem_zalloc(size_t);
301 void            os_pagemem_free(void *, size_t);
302
303 paddr_t         os_pa_zalloc(void);
304 void            os_pa_free(paddr_t);
305
306 int             os_contigpa_zalloc(paddr_t *, vaddr_t *, size_t);
307 void            os_contigpa_free(paddr_t, vaddr_t, size_t);
308
309 static inline bool
310 os_return_needed(void)
311 {
312 #if defined(__NetBSD__)
313         if (preempt_needed()) {
314                 return true;
315         }
316         if (curlwp->l_flag & LW_USERRET) {
317                 return true;
318         }
319         return false;
320 #elif defined(__DragonFly__)
321         if (__predict_false(nvmm_break_wanted())) {
322                 return true;
323         }
324         if (__predict_false(curthread->td_lwp->lwp_mpflags & LWP_MP_URETMASK)) {
325                 return true;
326         }
327         return false;
328 #endif
329 }
330
331 /* -------------------------------------------------------------------------- */
332 /* IPIs. */
333
334 #if defined(__NetBSD__)
335
336 #include <sys/xcall.h>
337 #define OS_IPI_FUNC(func)       void func(void *arg, void *unused)
338
339 static inline void
340 os_ipi_unicast(os_cpu_t *cpu, void (*func)(void *, void *), void *arg)
341 {
342         xc_wait(xc_unicast(XC_HIGHPRI, func, arg, NULL, cpu));
343 }
344
345 static inline void
346 os_ipi_broadcast(void (*func)(void *, void *), void *arg)
347 {
348         xc_wait(xc_broadcast(0, func, arg, NULL));
349 }
350
351 static inline void
352 os_ipi_kickall(void)
353 {
354         /*
355          * XXX: this is probably too expensive. NetBSD should have a dummy
356          * interrupt handler that just IRETs without doing anything.
357          */
358         pmap_tlb_shootdown(pmap_kernel(), -1, PTE_G, TLBSHOOT_NVMM);
359 }
360
361 #elif defined(__DragonFly__)
362
363 #include <sys/thread2.h>
364 #define OS_IPI_FUNC(func)       void func(void *arg)
365
366 static inline void
367 os_ipi_unicast(os_cpu_t *cpu, void (*func)(void *), void *arg)
368 {
369         int seq;
370
371         seq = lwkt_send_ipiq(cpu, func, arg);
372         lwkt_wait_ipiq(cpu, seq);
373 }
374
375 /* TODO: implement os_ipi_broadcast. */
376
377 /*
378  * On DragonFly, no need to bind the thread, because any normal kernel
379  * thread will not migrate to another CPU or be preempted (except by an
380  * interrupt thread).
381  */
382 #define curlwp_bind()           ((int)0)
383 #define curlwp_bindx(bound)     /* nothing */
384
385 #endif /* __NetBSD__ */
386
387 #endif /* _NVMM_OS_H_ */