xref: /dragonfly/sys/cpu/x86_64/include/param.h (revision 1046074b)
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 #define _CPU_PARAM_H_
39 
40 /*
41  * Machine dependent constants for x86_64.
42  */
43 
44 #ifndef _MACHINE
45 #define	_MACHINE	x86_64
46 #endif
47 #ifndef _MACHINE_ARCH
48 #define	_MACHINE_ARCH	x86_64
49 #endif
50 
51 #ifndef MACHINE
52 #define MACHINE		"x86_64"
53 #endif
54 #ifndef MACHINE_ARCH
55 #define	MACHINE_ARCH	"x86_64"
56 #endif
57 
58 /*
59  * Use SMP_MAXCPU instead of MAXCPU for structures that are intended to
60  * remain compatible between UP and SMP builds.
61  *
62  * WARNING!  CPUMASK macros in include/cpumask.h must also be adjusted,
63  *	     as well as any assembly.  Be sure that _CPUMASK_ELEMENTS
64  *	     is always correct so incompatible assembly #error's out
65  *	     during the kernel compile.
66  *
67  * WARNING!  To raise SMP_MAXCPU further we probably need to reserve
68  *	     more KVM space via MPPTDI (platform/pc64/include/pmap.h),
69  *	     depends on SMP_MAXCPU * sizeof(struct privatedata).
70  */
71 #define SMP_MAXCPU	256
72 #define MAXCPU		SMP_MAXCPU
73 
74 /* Constants derived from sizeof() that need recalculation. */
75 /* level 1 == page table */
76 #define NPTEPGSHIFT	9		/* LOG2(NPTEPG) */
77 #define PAGE_SHIFT	12		/* LOG2(PAGE_SIZE) */
78 #define PAGE_SIZE	(1<<PAGE_SHIFT)	/* bytes/page */
79 #define PAGE_MASK	(PAGE_SIZE-1)
80 #define NPTEPG		(PAGE_SIZE/8LU)	/* PAGE_SIZE/sizeof(pt_entry_t) */
81 
82 /* level 2 == page directory */
83 #define NPDEPGSHIFT	9		/* LOG2(NPDEPG) */
84 #define PDRSHIFT	21		/* LOG2(NBPDR) */
85 #define NBPDR		(1<<PDRSHIFT)	/* bytes/page dir */
86 #define PDRMASK		(NBPDR-1)
87 #define NPDEPG		(PAGE_SIZE/8LU)	/* PAGE_SIZE/sizeof(pd_entry_t) */
88 
89 /* level 3 == page directory pointer table */
90 #define NPDPEPGSHIFT	9		/* LOG2(NPDPEPG) */
91 #define PDPSHIFT	30		/* LOG2(NBPDP) */
92 #define NBPDP		(1<<PDPSHIFT)	/* bytes/page dir ptr table */
93 #define PDPMASK		(NBPDP-1)
94 #define NPDPEPG		(PAGE_SIZE/8LU)	/* PAGE_SIZE/sizeof(pdp_entry_t) */
95 
96 /* level 4 */
97 #define NPML4EPGSHIFT	9		/* LOG2(NPML4EPG) */
98 #define PML4SHIFT	39		/* LOG2(NBPML4) */
99 #define NBPML4		(1UL<<PML4SHIFT)/* bytes/page map level4 table */
100 #define PML4MASK	(NBPML4-1)
101 #define NPML4EPG	(PAGE_SIZE/8LU)	/* PAGE_SIZE/sizeof(pml4_entry_t) */
102 
103 /*
104  * Virtual address sign-extension and mask.  If bit 47 is set then
105  * set all higher bits.
106  */
107 #define PML4_SIGNMASK  0xFFFF800000000000LU
108 
109 /* for vkernel */
110 #define SEG_SHIFT	21
111 #define SEG_SIZE	(1<<SEG_SHIFT)	/* bytes per mmu segment (level 1) */
112 #define SEG_MASK	(SEG_SIZE-1)
113 
114 #define DEV_BSHIFT	9		/* log2(DEV_BSIZE) */
115 #define DEV_BSIZE	(1<<DEV_BSHIFT)
116 #define DEV_BMASK	(DEV_BSIZE - 1)
117 
118 #ifndef BLKDEV_IOSIZE
119 #define BLKDEV_IOSIZE	PAGE_SIZE	/* default block device I/O size */
120 #endif
121 #define DFLTPHYS	(64 * 1024)	/* default max raw I/O transfer size */
122 #define MAXPHYS		(128 * 1024)	/* max raw I/O transfer size */
123 #define MAXDUMPPGS	(MAXPHYS/PAGE_SIZE)
124 
125 #define IOPAGES		2		/* pages of i/o permission bitmap */
126 #define UPAGES		4		/* pages of u-area */
127 
128 /*
129  * Ceiling on amount of swblock kva space, can be changed via
130  * kern.maxswzone /boot/loader.conf variable.  On 64 bit machines
131  * the kernel has a 512G address space, and we do not want to allow
132  * more than half of that to be used for this purpose.
133  *
134  * Approximately (size / 192 x 16 x PAGE_SIZE) bytes of swap.  This
135  * comes to approximately 1GB of swap space per 1MB of kernel memory.
136  * Actually using 512G of swap will tie up a big chunk (512M) of physical
137  * memory.
138  */
139 #ifndef VM_SWZONE_SIZE_MAX
140 #define VM_SWZONE_SIZE_MAX	(256L * 1024L * 1024 * 1024)
141 #endif
142 
143 /*
144  * Ceiling on size of buffer cache (really only effects write queueing,
145  * the VM page cache is not effected), can be changed via
146  * kern.maxbcache /boot/loader.conf variable.
147  *
148  * This value is unbounded on 64-bit boxes, boot code will limit the
149  * buffer cache size to a portion of available physical memory.
150  */
151 #ifndef VM_BCACHE_SIZE_MAX
152 #define VM_BCACHE_SIZE_MAX	0
153 #endif
154 
155 /*
156  * Some macros for units conversion
157  */
158 
159 /* clicks to bytes */
160 #define ctob(x)	((x)<<PAGE_SHIFT)
161 
162 /* bytes to clicks */
163 #define btoc(x)	(((unsigned)(x)+PAGE_MASK)>>PAGE_SHIFT)
164 
165 /*
166  * btodb() is messy and perhaps slow because `bytes' may be an off_t.  We
167  * want to shift an unsigned type to avoid sign extension and we don't
168  * want to widen `bytes' unnecessarily.  Assume that the result fits in
169  * a daddr_t.
170  */
171 #define btodb(bytes)	 		/* calculates (bytes / DEV_BSIZE) */ \
172 	(sizeof (bytes) > sizeof(long) \
173 	 ? (daddr_t)((unsigned long long)(bytes) >> DEV_BSHIFT) \
174 	 : (daddr_t)((unsigned long)(bytes) >> DEV_BSHIFT))
175 
176 #define dbtob(db)			/* calculates (db * DEV_BSIZE) */ \
177 	((off_t)(db) << DEV_BSHIFT)
178 
179 /*
180  * Mach derived conversion macros
181  */
182 #define	round_page(x)	((((unsigned long)(x)) + PAGE_MASK) & ~(unsigned long)(PAGE_MASK))
183 #define	trunc_page(x)	((unsigned long)(x) & ~(unsigned long)(PAGE_MASK))
184 
185 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
186 #define	atop(x)		((vm_pindex_t)((x) >> PAGE_SHIFT))
187 #define	ptoa(x)		((vm_paddr_t)(x) << PAGE_SHIFT)
188 
189 #define	x86_64_btop(x)	((vm_pindex_t)((x) >> PAGE_SHIFT))
190 #define	x86_64_ptob(x)	((vm_paddr_t)(x) << PAGE_SHIFT)
191 
192 #define	pgtok(x)		((x) * (PAGE_SIZE / 1024))
193 #endif	/* _KERNEL || _KERNEL_STRUCTURES */
194 
195 #ifdef _KERNEL
196 
197 /*
198  * We put here the definition of two debugging macros/function which
199  * are very convenient to have available.
200  * The macro is called TSTMP() and is used to timestamp events in the
201  * kernel using the TSC register, and export them to userland through
202  * the sysctl variable debug.timestamp, which is a circular buffer
203  * holding pairs of u_int32_t variables <timestamp, argument> .
204  * They can be retrieved with something like
205  *
206  *	sysctl -b debug.timestamp | hexdump -e '"%15u %15u\n"'
207  *
208  * The function _TSTMP() is defined in i386/isa/clock.c. It does not
209  * try to grab any locks or block interrupts or identify which CPU it
210  * is running on. You are supposed to know what to do if you use it.
211  *
212  * The macros must be enabled with "options KERN_TIMESTAMP" in the kernel
213  * config file, otherwise they default to an empty block.
214  */
215 
216 #ifdef KERN_TIMESTAMP
217 void _TSTMP(u_int32_t);
218 #define TSTMP(class, unit, event, par)	_TSTMP(	\
219 	(((class) &   0x0f) << 28 ) |		\
220 	(((unit)  &   0x0f) << 24 ) |		\
221 	(((event) &   0xff) << 16 ) |		\
222 	(((par)   & 0xffff)       )   )
223 
224 #else /* !KERN_TIMESTAMP */
225 #define        _TSTMP(x)                       {}
226 #define        TSTMP(class, unit, event, par)  _TSTMP(0)
227 #endif /* !KERN_TIMESTAMP */
228 #endif /* _KERNEL */
229 
230 #endif /* !_CPU_PARAM_H_ */
231