xref: /freebsd/sys/compat/linuxkpi/common/include/linux/page.h (revision ebacd8013fe5f7fdf9f6a5b286f6680dd2891036)
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  * $FreeBSD$
30  */
31 #ifndef	_LINUXKPI_LINUX_PAGE_H_
32 #define _LINUXKPI_LINUX_PAGE_H_
33 
34 #include <linux/types.h>
35 
36 #include <sys/param.h>
37 #include <sys/vmmeter.h>
38 
39 #include <machine/atomic.h>
40 #include <vm/vm.h>
41 #include <vm/vm_page.h>
42 #include <vm/pmap.h>
43 
44 #if defined(__i386__) || defined(__amd64__)
45 #include <machine/md_var.h>
46 #endif
47 
48 typedef unsigned long linux_pte_t;
49 typedef unsigned long linux_pmd_t;
50 typedef unsigned long linux_pgd_t;
51 typedef unsigned long pgprot_t;
52 
53 #define page	vm_page
54 
55 #define	LINUXKPI_PROT_VALID (1 << 3)
56 #define	LINUXKPI_CACHE_MODE_SHIFT 4
57 
58 CTASSERT((VM_PROT_ALL & -LINUXKPI_PROT_VALID) == 0);
59 
60 #define	PAGE_KERNEL_IO	0x0000
61 
62 static inline pgprot_t
63 cachemode2protval(vm_memattr_t attr)
64 {
65 	return ((attr << LINUXKPI_CACHE_MODE_SHIFT) | LINUXKPI_PROT_VALID);
66 }
67 
68 static inline vm_memattr_t
69 pgprot2cachemode(pgprot_t prot)
70 {
71 	if (prot & LINUXKPI_PROT_VALID)
72 		return (prot >> LINUXKPI_CACHE_MODE_SHIFT);
73 	else
74 		return (VM_MEMATTR_DEFAULT);
75 }
76 
77 #define	virt_to_page(x)		PHYS_TO_VM_PAGE(vtophys(x))
78 #define	page_to_pfn(pp)		(VM_PAGE_TO_PHYS(pp) >> PAGE_SHIFT)
79 #define	pfn_to_page(pfn)	(PHYS_TO_VM_PAGE((pfn) << PAGE_SHIFT))
80 #define	nth_page(page,n)	pfn_to_page(page_to_pfn(page) + (n))
81 #define	page_to_phys(page)	VM_PAGE_TO_PHYS(page)
82 
83 #define	clear_page(page)		memset(page, 0, PAGE_SIZE)
84 #define	pgprot_noncached(prot)		\
85 	(((prot) & VM_PROT_ALL) | cachemode2protval(VM_MEMATTR_UNCACHEABLE))
86 #ifdef VM_MEMATTR_WRITE_COMBINING
87 #define	pgprot_writecombine(prot)	\
88 	(((prot) & VM_PROT_ALL) | cachemode2protval(VM_MEMATTR_WRITE_COMBINING))
89 #else
90 #define	pgprot_writecombine(prot)	pgprot_noncached(prot)
91 #endif
92 
93 #undef	PAGE_MASK
94 #define	PAGE_MASK	(~(PAGE_SIZE-1))
95 /*
96  * Modifying PAGE_MASK in the above way breaks trunc_page, round_page,
97  * and btoc macros. Therefore, redefine them in a way that makes sense
98  * so the LinuxKPI consumers don't get totally broken behavior.
99  */
100 #undef	btoc
101 #define	btoc(x)	(((vm_offset_t)(x) + PAGE_SIZE - 1) >> PAGE_SHIFT)
102 #undef	round_page
103 #define	round_page(x)	((((uintptr_t)(x)) + PAGE_SIZE - 1) & ~(PAGE_SIZE - 1))
104 #undef	trunc_page
105 #define	trunc_page(x)	((uintptr_t)(x) & ~(PAGE_SIZE - 1))
106 
107 #if defined(__i386__) || defined(__amd64__)
108 #undef clflush
109 #undef clflushopt
110 static inline void
111 lkpi_clflushopt(unsigned long addr)
112 {
113 	if (cpu_stdext_feature & CPUID_STDEXT_CLFLUSHOPT)
114 		clflushopt(addr);
115 	else if (cpu_feature & CPUID_CLFSH)
116 		clflush(addr);
117 	else
118 		pmap_invalidate_cache();
119 }
120 #define	clflush(x)	clflush((unsigned long)(x))
121 #define	clflushopt(x)	lkpi_clflushopt((unsigned long)(x))
122 
123 static inline void
124 clflush_cache_range(void *addr, unsigned int size)
125 {
126 	pmap_force_invalidate_cache_range((vm_offset_t)addr,
127 	    (vm_offset_t)addr + size);
128 }
129 #endif
130 
131 #endif	/* _LINUXKPI_LINUX_PAGE_H_ */
132