xref: /dragonfly/sys/cpu/x86_64/include/param.h (revision 65867155)
1 /*-
2  * Copyright (c) 1990 The Regents of the University of California.
3  * Copyright (c) 2008 The DragonFly Project.
4  * All rights reserved.
5  *
6  * This code is derived from software contributed to Berkeley by
7  * William Jolitz.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following 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  * 3. Neither the name of the University nor the names of its contributors
18  *    may be used to endorse or promote products derived from this software
19  *    without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31  * SUCH DAMAGE.
32  *
33  *	from: @(#)param.h	5.8 (Berkeley) 6/28/91
34  * $FreeBSD: src/sys/i386/include/param.h,v 1.54.2.8 2002/08/31 21:15:55 dillon Exp $
35  */
36 
37 #ifndef _CPU_PARAM_H_
38 
39 /*
40  * Do not prevent re-includes of <machine/param.h> if the file was included
41  * with NO_NAMESPACE_POLLUTION, or expected macros will not exist.
42  */
43 #ifndef _NO_NAMESPACE_POLLUTION
44 #define _CPU_PARAM_H_
45 #endif
46 
47 /*
48  * Machine dependent constants for x86_64.
49  */
50 #ifndef _CPU_PARAM_H1_
51 #define _CPU_PARAM_H1_
52 
53 /*
54  * Round p (pointer or byte index) up to a correctly-aligned value
55  * for all data types (int, long, ...).   The result is unsigned int
56  * and must be cast to any desired pointer type.
57  */
58 #ifndef _ALIGNBYTES
59 #define _ALIGNBYTES	(sizeof(long) - 1)
60 #endif
61 #ifndef _ALIGN
62 #define _ALIGN(p)	(((unsigned long)(p) + _ALIGNBYTES) & ~_ALIGNBYTES)
63 #endif
64 
65 #ifndef _MACHINE
66 #define	_MACHINE	x86_64
67 #endif
68 #ifndef _MACHINE_ARCH
69 #define	_MACHINE_ARCH	x86_64
70 #endif
71 
72 #endif	/* _CPU_PARAM_H1_ */
73 
74 #ifndef _NO_NAMESPACE_POLLUTION
75 
76 #ifndef MACHINE
77 #define MACHINE		"x86_64"
78 #endif
79 #ifndef MACHINE_ARCH
80 #define	MACHINE_ARCH	"x86_64"
81 #endif
82 
83 /*
84  * Use SMP_MAXCPU instead of MAXCPU for structures that are intended to
85  * remain compatible between UP and SMP builds.
86  *
87  * WARNING!  CPUMASK macros in include/types.h must also be adjusted,
88  *	     as well as any assembly.  Be sure that CPUMASK_ELEMENTS
89  *	     is always correct so incompatible assembly #error's out
90  *	     during the kernel compile.
91  *
92  * WARNING!  To raise SMP_MAXCPU further we probably need to reserve
93  *	     more KVM space via MPPTDI (platform/pc64/include/pmap.h),
94  *	     depends on SMP_MAXCPU * sizeof(struct privatedata).
95  */
96 #define SMP_MAXCPU	256
97 #define MAXCPU		SMP_MAXCPU
98 
99 #define ALIGNBYTES	_ALIGNBYTES
100 #define ALIGN(p)	_ALIGN(p)
101 
102 /* JG license? from fbsd/src/sys/amd64/include/param.h */
103 /* level 1 == page table */
104 #define	NPTEPGSHIFT	9		/* LOG2(NPTEPG) */
105 #define PAGE_SHIFT	12		/* LOG2(PAGE_SIZE) */
106 #define PAGE_SIZE	(1<<PAGE_SHIFT)	/* bytes/page */
107 #define PAGE_MASK	(PAGE_SIZE-1)
108 #define NPTEPG		(PAGE_SIZE/(sizeof (pt_entry_t)))
109 
110 /* level 2 == page directory */
111 #define	NPDEPGSHIFT	9		/* LOG2(NPDEPG) */
112 #define PDRSHIFT	21		/* LOG2(NBPDR) */
113 #define NBPDR		(1<<PDRSHIFT)	/* bytes/page dir */
114 #define PDRMASK		(NBPDR-1)
115 #define NPDEPG		(PAGE_SIZE/(sizeof (pd_entry_t)))
116 
117 /* level 3 == page directory pointer table */
118 #define	NPDPEPGSHIFT	9		/* LOG2(NPDPEPG) */
119 #define PDPSHIFT	30		/* LOG2(NBPDP) */
120 #define NBPDP		(1<<PDPSHIFT)	/* bytes/page dir ptr table */
121 #define PDPMASK		(NBPDP-1)
122 #define NPDPEPG		(PAGE_SIZE/(sizeof (pdp_entry_t)))
123 
124 /* level 4 */
125 #define	NPML4EPGSHIFT	9		/* LOG2(NPML4EPG) */
126 #define PML4SHIFT	39		/* LOG2(NPML4) */
127 #define NPML4		(1UL<<PML4SHIFT)/* bytes/page map level4 table */
128 #define	NBPML4		(1ul<<PML4SHIFT)/* bytes/page map lev4 table */
129 #define PML4MASK	(NPML4-1)
130 #define NPML4EPG	(PAGE_SIZE/(sizeof (pml4_entry_t)))
131 
132 /*
133  * Virtual address sign-extension and mask.  If bit 47 is set then
134  * set all higher bits.
135  */
136 #define PML4_SIGNMASK  0xFFFF800000000000LU
137 
138 /* for vkernel */
139 #define SEG_SHIFT	21
140 #define SEG_SIZE	(1<<SEG_SHIFT)	/* bytes per mmu segment (level 1) */
141 #define SEG_MASK	(SEG_SIZE-1)
142 
143 #define DEV_BSHIFT	9		/* log2(DEV_BSIZE) */
144 #define DEV_BSIZE	(1<<DEV_BSHIFT)
145 #define DEV_BMASK	(DEV_BSIZE - 1)
146 
147 #ifndef BLKDEV_IOSIZE
148 #define BLKDEV_IOSIZE	PAGE_SIZE	/* default block device I/O size */
149 #endif
150 #define DFLTPHYS	(64 * 1024)	/* default max raw I/O transfer size */
151 #define MAXPHYS		(128 * 1024)	/* max raw I/O transfer size */
152 #define MAXDUMPPGS	(MAXPHYS/PAGE_SIZE)
153 
154 #define IOPAGES		2		/* pages of i/o permission bitmap */
155 #define UPAGES		4		/* pages of u-area */
156 
157 /*
158  * Ceiling on amount of swblock kva space, can be changed via
159  * kern.maxswzone /boot/loader.conf variable.  On 64 bit machines
160  * the kernel has a 512G address space so reserving 512M of KVM
161  * is not a big deal.
162  *
163  * Approximately (size / 160 x 32 x PAGE_SIZE) bytes of swap.  This
164  * comes to approximately 1GB of swap space per 1MB of kernel memory.
165  * Actually using 512G of swap will tie up a big chunk (512M) of physical
166  * memory.
167  */
168 #ifndef VM_SWZONE_SIZE_MAX
169 #define VM_SWZONE_SIZE_MAX	(512L * 1024 * 1024)
170 #endif
171 
172 /*
173  * Ceiling on size of buffer cache (really only effects write queueing,
174  * the VM page cache is not effected), can be changed via
175  * kern.maxbcache /boot/loader.conf variable.
176  *
177  * This value is unbounded on 64-bit boxes, boot code will limit the
178  * buffer cache size to a portion of available physical memory.
179  */
180 #ifndef VM_BCACHE_SIZE_MAX
181 #define VM_BCACHE_SIZE_MAX	0
182 #endif
183 
184 /*
185  * Some macros for units conversion
186  */
187 
188 /* clicks to bytes */
189 #define ctob(x)	((x)<<PAGE_SHIFT)
190 
191 /* bytes to clicks */
192 #define btoc(x)	(((unsigned)(x)+PAGE_MASK)>>PAGE_SHIFT)
193 
194 /*
195  * btodb() is messy and perhaps slow because `bytes' may be an off_t.  We
196  * want to shift an unsigned type to avoid sign extension and we don't
197  * want to widen `bytes' unnecessarily.  Assume that the result fits in
198  * a daddr_t.
199  */
200 #define btodb(bytes)	 		/* calculates (bytes / DEV_BSIZE) */ \
201 	(sizeof (bytes) > sizeof(long) \
202 	 ? (daddr_t)((unsigned long long)(bytes) >> DEV_BSHIFT) \
203 	 : (daddr_t)((unsigned long)(bytes) >> DEV_BSHIFT))
204 
205 #define dbtob(db)			/* calculates (db * DEV_BSIZE) */ \
206 	((off_t)(db) << DEV_BSHIFT)
207 
208 /*
209  * Mach derived conversion macros
210  */
211 #define	round_page(x)	((((unsigned long)(x)) + PAGE_MASK) & ~(unsigned long)(PAGE_MASK))
212 #define	trunc_page(x)	((unsigned long)(x) & ~(unsigned long)(PAGE_MASK))
213 #define trunc_2mpage(x)	((unsigned long)(x) & ~(unsigned long)PDRMASK)
214 #define round_2mpage(x)	((((unsigned long)(x)) + PDRMASK) & ~(unsigned long)PDRMASK)
215 
216 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
217 #define	atop(x)		((vm_pindex_t)((x) >> PAGE_SHIFT))
218 #endif
219 #define	ptoa(x)		((vm_paddr_t)(x) << PAGE_SHIFT)
220 
221 #define	x86_64_btop(x)	((vm_pindex_t)((x) >> PAGE_SHIFT))
222 #define	x86_64_ptob(x)	((vm_paddr_t)(x) << PAGE_SHIFT)
223 
224 #define	pgtok(x)		((x) * (PAGE_SIZE / 1024))
225 
226 #ifdef _KERNEL
227 
228 /*
229  * We put here the definition of two debugging macros/function which
230  * are very convenient to have available.
231  * The macro is called TSTMP() and is used to timestamp events in the
232  * kernel using the TSC register, and export them to userland through
233  * the sysctl variable debug.timestamp, which is a circular buffer
234  * holding pairs of u_int32_t variables <timestamp, argument> .
235  * They can be retrieved with something like
236  *
237  *	sysctl -b debug.timestamp | hexdump -e '"%15u %15u\n"'
238  *
239  * The function _TSTMP() is defined in i386/isa/clock.c. It does not
240  * try to grab any locks or block interrupts or identify which CPU it
241  * is running on. You are supposed to know what to do if you use it.
242  *
243  * The macros must be enabled with "options KERN_TIMESTAMP" in the kernel
244  * config file, otherwise they default to an empty block.
245  */
246 
247 #ifdef KERN_TIMESTAMP
248 extern void _TSTMP(u_int32_t argument);
249 #define TSTMP(class, unit, event, par)	_TSTMP(	\
250 	(((class) &   0x0f) << 28 ) |		\
251 	(((unit)  &   0x0f) << 24 ) |		\
252 	(((event) &   0xff) << 16 ) |		\
253 	(((par)   & 0xffff)       )   )
254 
255 #else /* !KERN_TIMESTAMP */
256 #define        _TSTMP(x)                       {}
257 #define        TSTMP(class, unit, event, par)  _TSTMP(0)
258 #endif /* !KERN_TIMESTAMP */
259 #endif /* _KERNEL */
260 
261 #endif /* !_NO_NAMESPACE_POLLUTION */
262 #endif /* !_CPU_PARAM_H_ */
263