xref: /freebsd/sys/compat/linuxkpi/common/include/linux/page.h (revision 80aa295a5272d01b7f21eff6719dcd45e14e8e09)
1 /*-
2  * Copyright (c) 2010 Isilon Systems, Inc.
3  * Copyright (c) 2010 iX Systems, Inc.
4  * Copyright (c) 2010 Panasas, Inc.
5  * Copyright (c) 2013-2016 Mellanox Technologies, Ltd.
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice unmodified, this list of conditions, and the following
13  *    disclaimer.
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in the
16  *    documentation and/or other materials provided with the distribution.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
19  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
22  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
23  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28  */
29 #ifndef	_LINUXKPI_LINUX_PAGE_H_
30 #define _LINUXKPI_LINUX_PAGE_H_
31 
32 #include <linux/types.h>
33 
34 #include <sys/param.h>
35 #include <sys/vmmeter.h>
36 
37 #include <machine/atomic.h>
38 #include <vm/vm.h>
39 #include <vm/vm_page.h>
40 #include <vm/pmap.h>
41 
42 #if defined(__i386__) || defined(__amd64__)
43 #include <machine/md_var.h>
44 #endif
45 
46 typedef unsigned long linux_pte_t;
47 typedef unsigned long linux_pmd_t;
48 typedef unsigned long linux_pgd_t;
49 typedef unsigned long pgprot_t;
50 
51 #define page	vm_page
52 
53 #define	LINUXKPI_PROT_VALID (1 << 3)
54 #define	LINUXKPI_CACHE_MODE_SHIFT 4
55 
56 CTASSERT((VM_PROT_ALL & -LINUXKPI_PROT_VALID) == 0);
57 
58 #define	PAGE_KERNEL_IO	0x0000
59 
60 static inline pgprot_t
cachemode2protval(vm_memattr_t attr)61 cachemode2protval(vm_memattr_t attr)
62 {
63 	return ((attr << LINUXKPI_CACHE_MODE_SHIFT) | LINUXKPI_PROT_VALID);
64 }
65 
66 static inline vm_memattr_t
pgprot2cachemode(pgprot_t prot)67 pgprot2cachemode(pgprot_t prot)
68 {
69 	if (prot & LINUXKPI_PROT_VALID)
70 		return (prot >> LINUXKPI_CACHE_MODE_SHIFT);
71 	else
72 		return (VM_MEMATTR_DEFAULT);
73 }
74 
75 #define	page_to_virt(page)	linux_page_address(page)
76 #define	virt_to_page(x)		PHYS_TO_VM_PAGE(vtophys(x))
77 #define	page_to_pfn(pp)		(VM_PAGE_TO_PHYS(pp) >> PAGE_SHIFT)
78 #define	pfn_to_page(pfn)	(PHYS_TO_VM_PAGE((pfn) << PAGE_SHIFT))
79 #define	nth_page(page,n)	pfn_to_page(page_to_pfn(page) + (n))
80 #define	page_to_phys(page)	VM_PAGE_TO_PHYS(page)
81 
82 #define	clear_page(page)		memset(page, 0, PAGE_SIZE)
83 #define	pgprot_noncached(prot)		\
84 	(((prot) & VM_PROT_ALL) | cachemode2protval(VM_MEMATTR_UNCACHEABLE))
85 #ifdef VM_MEMATTR_WRITE_COMBINING
86 #define	pgprot_writecombine(prot)	\
87 	(((prot) & VM_PROT_ALL) | cachemode2protval(VM_MEMATTR_WRITE_COMBINING))
88 #else
89 #define	pgprot_writecombine(prot)	pgprot_noncached(prot)
90 #endif
91 
92 #undef	PAGE_MASK
93 #define	PAGE_MASK	(~(PAGE_SIZE-1))
94 /*
95  * Modifying PAGE_MASK in the above way breaks trunc_page, round_page,
96  * and btoc macros. Therefore, redefine them in a way that makes sense
97  * so the LinuxKPI consumers don't get totally broken behavior.
98  */
99 #undef	btoc
100 #define	btoc(x)	(((vm_offset_t)(x) + PAGE_SIZE - 1) >> PAGE_SHIFT)
101 #undef	round_page
102 #define	round_page(x)	((((uintptr_t)(x)) + PAGE_SIZE - 1) & ~(PAGE_SIZE - 1))
103 #undef	trunc_page
104 #define	trunc_page(x)	((uintptr_t)(x) & ~(PAGE_SIZE - 1))
105 
106 #if defined(__i386__) || defined(__amd64__)
107 #undef clflush
108 #undef clflushopt
109 static inline void
lkpi_clflushopt(unsigned long addr)110 lkpi_clflushopt(unsigned long addr)
111 {
112 	if (cpu_stdext_feature & CPUID_STDEXT_CLFLUSHOPT)
113 		clflushopt(addr);
114 	else if (cpu_feature & CPUID_CLFSH)
115 		clflush(addr);
116 	else
117 		pmap_invalidate_cache();
118 }
119 #define	clflush(x)	clflush((unsigned long)(x))
120 #define	clflushopt(x)	lkpi_clflushopt((unsigned long)(x))
121 
122 static inline void
clflush_cache_range(void * addr,unsigned int size)123 clflush_cache_range(void *addr, unsigned int size)
124 {
125 	pmap_force_invalidate_cache_range((vm_offset_t)addr,
126 	    (vm_offset_t)addr + size);
127 }
128 #endif
129 
130 #endif	/* _LINUXKPI_LINUX_PAGE_H_ */
131