Move the IOCTLTRIM ioctl to a better header and rename it to DAIOCTRIM.
[dragonfly.git] / sys / sys / param.h
1 /*-
2  * Copyright (c) 1982, 1986, 1989, 1993
3  *      The Regents of the University of California.  All rights reserved.
4  * (c) UNIX System Laboratories, Inc.
5  * All or some portions of this file are derived from material licensed
6  * to the University of California by American Telephone and Telegraph
7  * Co. or Unix System Laboratories, Inc. and are reproduced herein with
8  * the permission of UNIX System Laboratories, Inc.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  * 3. Neither the name of the University nor the names of its contributors
19  *    may be used to endorse or promote products derived from this software
20  *    without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32  * SUCH DAMAGE.
33  *
34  *      @(#)param.h     8.3 (Berkeley) 4/4/95
35  * $FreeBSD: src/sys/sys/param.h,v 1.61.2.38 2003/05/22 17:12:01 fjoe Exp $
36  */
37
38 #ifndef _SYS_PARAM_H_
39 #define _SYS_PARAM_H_
40
41 #define BSD     200708          /* XXX kern.osrevision */
42 #define BSD4_3  1               /* XXX obsolete */
43 #define BSD4_4  1               /* XXX obsolete */
44
45 /*
46  * __DragonFly_version number.  The number doesn't really meaningfully
47  * translate to a version number.
48  *
49  * 170000 - base development version after 1.6 branch
50  * 170001 - base development version before 1.8 branch
51  * 190000 - base development version after 1.8 branch
52  * 195000 - base development version after 1.10 branch
53  * 197500 - base development version before 1.12 branch
54  * 197600 - 1.12 branch
55  * 197700 - base development version after 1.12 branch
56  * 199900 - base development version before 2.0 branch
57  * 200000 - 2.0 branch
58  * 200100 - base development version after 2.0 branch
59  * 200101 - lchflags syscall
60  * 200200 - 2.2 branch
61  * 200201 - base development version after 2.2 branch
62  * 200202 - major changes to libc
63  * 200203 - introduce PCI domain
64  * 200204 - suser() & suser_cred() removal
65  * 200205 - devfs import
66  * 200206 - *sleep() renames
67  * 200400 - 2.4 release
68  * 200500 - 2.5 master
69  * 200600 - 2.6 release
70  * 200700 - 2.7 master
71  * 200800 - 2.8 release                 October 2010
72  * 200900 - 2.9 master
73  * 200901 - prototype changes for alphasort(3) and scandir(3)
74  * 200902 - Xerox NS protocol removal
75  * 201000 - 2.10 release
76  * 201100 - 2.11 master
77  * 201200 - 2.12 release
78  * 201300 - 2.13 master
79  * 201301 - header rename: <vfs/gnu/ext2fs/...> -> <gnu/vfs/ext2fs/...>
80  * 201302 - header <crypt.h> is gone
81  * 201303 - <netatalk/...> and <netproto/atalk/...> are gone
82  * 201304 - Added wcscasecmp, wcsncasecmp to libc
83  * 201305 - Sync libm with NetBSD-current libm (new functions added)
84  * 201306 - Sync libm with FreeBSD-current libm (~50 new functions)
85  * 300000 - 3.0 release
86  * 300100 - 3.1 master
87  * 300101 - i4b (ISDN) removal
88  * 300102 - <sys/ata.h> is now just a link of <sys/nata.h>
89  * 300103 - if SIG_IGN is set on SIGCHLD, do not keep zombie children
90  * 300200 - 3.2 release
91  * 300300 - 3.3 master
92  * 300301 - Add eaccess syscall
93  * 300302 - fpsave changes - ucontext_t, mcontext_t, sigcontext, sigframe
94  * 300303 - Demarcation of old m4/flex with new m4/flex
95  * 300304 - Update to dialog-1.2-20121230
96  * 300400 - 3.4 release
97  * 300500 - 3.5 master
98  * 300501 - Convert libm to FreeBSD's version
99  * 300502 - GEM and i915 KMS support in kernel
100  * 300503 - Upgrade libiconv, locales, and associated libc functions
101  * 300600 - 3.6 release
102  * 300700 - 3.7 master
103  * 300701 - Relocate bus/smbus/smb.h to dev/smbus/smb/smb.h
104  * 300702 - drm/i915 update
105  * 300703 - Make usb4bsd default
106  * 300704 - Removal of IPX, NCP and NWFS support
107  * 300705 - Removal of ATM support.
108  * 300800 - 3.8 release
109  * 300900 - 3.9 master
110  * 300901 - drm/i915 hardware context support added
111  * 400000 - 4.0 release
112  * 400100 - 4.1 development
113  * 400101 - Removal of SCTP support.
114  * 400102 - Sound system update from FreeBSD
115  * 400103 - Milestone - availability of gcc50 in base
116  * 400104 - struct lwp_params (a public struct) members renaming
117  * 400105 - Switch to gcc50 as the primary compiler
118  * 400106 - Added pipe2() system call
119  * 400107 - Add futimens() and utimensat() syscalls
120  * 400200 - 4.2 release
121  * 400300 - 4.3 development
122  * 400301 - posix compliant iconv (no const qualifier)
123  * 400302 - Replacement of libm with OpenBSD's libm
124  * 400303 - environ and __progname are no longer linkable symbols
125  * 400304 - Activate symbol versioning for libc.so (still on version 8)
126  * 400305 - Add accept4() system call
127  * 400306 - Add libexecinfo to base
128  * 400307 - drm/i915 kernel module renamed to i915.ko
129  * 400308 - <malloc.h> removal
130  * 400309 - Add lwp_setname() system call
131  * 400400 - 4.4 release
132  * 400500 - 4.5 development
133  * 400501 - unionfs removal
134  * 400502 - private libraries: ssh ldns edit ncurses
135  * 400503 - libarchive-3.0.2 import (add bsdcat)
136  * 400600 - 4.6 release
137  * 400700 - 4.7 development
138  * 400701 - getline() visibility changes
139  * 400702 - private library: libressl
140  * 400703 - resolved conflicts of md, crypt and ressl libraries
141  * 400704 - binutils update to 2.27
142  * 400705 - lwp_{set,get}affinity()
143  * 400706 - sched_{set,get}affinity()
144  * 400707 - pthread_{set,get}affinity_np()
145  * 400708 - lwp_create2()
146  * 400709 - pthread_attr_{set,get}affinity_np()
147  * 400710 - sched_getcpu();
148  * 400711 - move lwp syscalls to sys/lwp.h
149  * 400712 - restore lwp syscalls (except lwp_create*) declaration
150  * 400713 - add sysctl kern.cp_times
151  * 400800 - 4.8 release
152  * 400900 - 4.9 development
153  * 400901 - moved sigtramp, NX protection, sigtramp sysctl
154  * 400902 - change CPU_SETSIZE to signed; allow proc to change self affinity
155  * 400903 - malloc_type cleanup
156  * 400904 - pad rtstatistics
157  * 400905 - PTHREAD_STACK_MIN increase: 1024 => 16384
158  * 400906 - lwpid_t >=1, instead of >=0
159  * 400907 - pthread_getthreadid_np()
160  * 400908 - {clock,pthread}_getcpuclockid()
161  * 400909 - deleted ortentry, SIOC{ADD,DEL}RT, RTM_OLD{ADD,DEL}
162  * 400910 - routing table is only available on netisr_ncpus
163  * 500000 - 5.0 release
164  * 500100 - 5.1 development
165  * 500101 - kernel ppp removal
166  * 500102 - <sys/sysref{,2}.h> inclusions removed from some public headers
167  * 500103 - faith removal
168  * 500104 - cfmakesane()
169  * 500105 - _SC_LEVEL1_DCACHE_LINESIZE sysconf()
170  * 500106 - %b and %r formats removal
171  * 500107 - <machine/apm_bios.h> removal
172  * 500200 - 5.2 release
173  * 500300 - 5.3 development
174  * 500301 - rename some public UFS constants
175  * 500302 - move IOCTLTRIM to a better header and rename it to DAIOCTRIM
176  */
177 #undef __DragonFly_version
178 #define __DragonFly_version 500302      /* propagated to newvers */
179
180 #include <sys/_null.h>
181
182 #ifndef LOCORE
183 #include <sys/types.h>
184 #endif
185
186 /*
187  * Machine-independent constants (some used in following include files).
188  * Redefined constants are from POSIX 1003.1 limits file.
189  *
190  * MAXCOMLEN should be >= sizeof(ac_comm) (see <acct.h>)
191  * MAXLOGNAME should be == UT_NAMESIZE+1 (see <utmp.h>)
192  */
193 #include <sys/syslimits.h>
194
195 #define MAXCOMLEN       16              /* max command name remembered */
196 #define MAXINTERP       32              /* max interpreter file name length */
197 #define MAXLOGNAME      17              /* max login name length (incl. NUL) */
198 #define MAXUPRC         CHILD_MAX       /* max simultaneous processes */
199 #define NCARGS          ARG_MAX         /* max bytes for an exec function */
200 #define NGROUPS         NGROUPS_MAX     /* max number groups */
201 #define NOFILE          OPEN_MAX        /* max open files per process */
202 #define NOGROUP         65535           /* marker for empty group set member */
203 #define MAXHOSTNAMELEN  256             /* max hostname size */
204
205 /* More types and definitions used throughout the kernel. */
206 #ifdef _KERNEL
207 #include <sys/cdefs.h>
208 #include <sys/errno.h>
209 #include <sys/time.h>
210
211 #define FALSE   0
212 #define TRUE    1
213 #endif
214
215 #ifndef _KERNEL
216 /* Signals. */
217 #include <sys/select.h>
218 #include <sys/signal.h>
219 #endif
220
221 /* Machine type dependent parameters. */
222 #include <machine/param.h>
223 #ifndef _KERNEL
224 #include <machine/limits.h>
225 #endif
226
227 /*
228  * WARNING! Max supported cpu's due to PWAKEUP_CPUMASK is 16384.
229  */
230 #define PCATCH          0x00000100      /* tsleep checks signals */
231 #define PUSRFLAG1       0x00000200      /* Subsystem specific flag */
232 #define PINTERLOCKED    0x00000400      /* Interlocked tsleep */
233 #define PWAKEUP_CPUMASK 0x00003FFF      /* start cpu for chained wakeups */
234 #define PWAKEUP_MYCPU   0x00004000      /* wakeup on current cpu only */
235 #define PWAKEUP_ONE     0x00008000      /* argument to wakeup: only one */
236 #define PDOMAIN_MASK    0xFFFF0000      /* address domains for wakeup */
237 #define PDOMAIN_UMTX    0x00010000      /* independant domain for UMTX */
238 #define PDOMAIN_XLOCK   0x00020000      /* independant domain for fifo_lock */
239 #define PWAKEUP_ENCODE(domain, cpu)     ((domain) | (cpu))
240 #define PWAKEUP_DECODE(domain)          ((domain) & PWAKEUP_CPUMASK)
241
242 #define NZERO   0               /* default "nice" */
243
244 #define NBPW    sizeof(int)     /* number of bytes per word (integer) */
245
246 #define CMASK   022             /* default file mask: S_IWGRP|S_IWOTH */
247 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
248 #define NOUDEV  (udev_t)(-1)    /* non-existent device */
249 #define NOMAJ   256             /* non-existent device */
250 #endif
251
252 #ifndef _KERNEL
253 #define NODEV   (dev_t)(-1)     /* non-existent device */
254 #endif
255
256 /*
257  * cpu_mi_feature bits
258  */
259 #define CPU_MI_BZERONT  0x00000001
260 #define CPU_MI_MONITOR  0x00000010
261
262 /*
263  * File system parameters and macros.
264  *
265  * MAXBSIZE -   Filesystems are made out of blocks of at most MAXBSIZE bytes
266  *              per block.  MAXBSIZE may be made larger without effecting
267  *              any existing filesystems as long as it does not exceed MAXPHYS,
268  *              and may be made smaller at the risk of not being able to use
269  *              filesystems which require a block size exceeding MAXBSIZE.
270  *
271  * NBUFCALCSIZE - Calculate sufficient buffer cache buffers for the memory
272  *              desired as if each buffer were sized to this value (actual
273  *              real memory use).  Hysteresis works both ways.
274  */
275 #define MAXBSIZE        65536           /* must be power of 2 */
276 #define NBUFCALCSIZE    16384           /* for nbuf calculation only */
277
278 #define MAXFRAG         8
279
280 /*
281  * MAXPATHLEN defines the longest permissible path length after expanding
282  * symbolic links. It is used to allocate a temporary buffer from the buffer
283  * pool in which to do the name expansion, hence should be a power of two,
284  * and must be less than or equal to MAXBSIZE.  MAXSYMLINKS defines the
285  * maximum number of symbolic links that may be expanded in a path name.
286  * It should be set high enough to allow all legitimate uses, but halt
287  * infinite loops reasonably quickly.
288  */
289 #define MAXPATHLEN      PATH_MAX
290 #define MAXSYMLINKS     32
291
292 /* Bit map related macros. */
293 #define setbit(a,i)     ((a)[(i)/NBBY] |= 1<<((i)%NBBY))
294 #define clrbit(a,i)     ((a)[(i)/NBBY] &= ~(1<<((i)%NBBY)))
295 #define isset(a,i)      ((a)[(i)/NBBY] & (1<<((i)%NBBY)))
296 #define isclr(a,i)      (((a)[(i)/NBBY] & (1<<((i)%NBBY))) == 0)
297
298 /* Macros for counting and rounding. */
299 #ifndef howmany
300 #define howmany(x, y)   (((x)+((y)-1))/(y))
301 #endif
302 #define nitems(x)       NELEM(x)
303 #define rounddown(x, y) (((x)/(y))*(y))
304 #define rounddown2(x, y) ((x) & ~((y) - 1))        /* y power of two */
305 #define roundup(x, y)   ((((x)+((y)-1))/(y))*(y))  /* to any y */
306 #define roundup2(x, y)  (((x)+((y)-1))&(~((y)-1))) /* if y is powers of two */
307 #define powerof2(x)     ((((x)-1)&(x))==0)
308
309 /*
310  * VM objects can be larger than the virtual address space, make sure
311  * we don't cut-off the mask.
312  */
313 #define trunc_page64(x)           ((x) & ~(int64_t)PAGE_MASK)
314 #define round_page64(x)           (((x) + PAGE_MASK) & ~(int64_t)PAGE_MASK)
315
316 /* Macros for min/max. */
317 #define MIN(a,b) (((a)<(b))?(a):(b))
318 #define MAX(a,b) (((a)>(b))?(a):(b))
319
320 /* Macro for array size */
321 #define NELEM(ary)      (sizeof(ary) / sizeof((ary)[0]))
322
323 /*
324  * Constants for setting the parameters of the kernel memory allocator.
325  *
326  * 2 ** MINBUCKET is the smallest unit of memory that will be
327  * allocated. It must be at least large enough to hold a pointer.
328  *
329  * Units of memory less or equal to MAXALLOCSAVE will permanently
330  * allocate physical memory; requests for these size pieces of
331  * memory are quite fast. Allocations greater than MAXALLOCSAVE must
332  * always allocate and free physical memory; requests for these
333  * size allocations should be done infrequently as they will be slow.
334  *
335  * Constraints: PAGE_SIZE <= MAXALLOCSAVE <= 2 ** (MINBUCKET + 14), and
336  * MAXALLOCSIZE must be a power of two.
337  */
338 #define MINBUCKET       4               /* 4 => min allocation of 16 bytes */
339 #define MAXALLOCSAVE    (2 * PAGE_SIZE)
340
341 /*
342  * Scale factor for scaled integers used to count %cpu time and load avgs.
343  *
344  * The number of CPU `tick's that map to a unique `%age' can be expressed
345  * by the formula (1 / (2 ^ (FSHIFT - 11))).  The maximum load average that
346  * can be calculated (assuming 32 bits) can be closely approximated using
347  * the formula (2 ^ (2 * (16 - FSHIFT))) for (FSHIFT < 15).
348  *
349  * For the scheduler to maintain a 1:1 mapping of CPU `tick' to `%age',
350  * FSHIFT must be at least 11; this gives us a maximum load avg of ~1024.
351  */
352 #define FSHIFT  11              /* bits to right of fixed binary point */
353 #define FSCALE  (1<<FSHIFT)
354
355 #define dbtoc(db)                       /* calculates devblks to pages */ \
356         ((db + (ctodb(1) - 1)) >> (PAGE_SHIFT - DEV_BSHIFT))
357  
358 #define ctodb(db)                       /* calculates pages to devblks */ \
359         ((db) << (PAGE_SHIFT - DEV_BSHIFT))
360
361 #define MJUMPAGESIZE    PAGE_SIZE       /* jumbo cluster 4k */
362 #define MJUM9BYTES      (9 * 1024)      /* jumbo cluster 9k */
363 #define MJUM16BYTES     (16 * 1024)     /* jumbo cluster 16k */
364
365 /*
366  * MBUF Management.
367  *
368  * Because many drivers can't deal with multiple DMA segments all mbufs
369  * must avoid crossing a page boundary.  While we can accomodate mbufs
370  * which are not a power-of-2 sized kmalloc() will only guarantee
371  * non-crossing alignment if we use a power-of-2.  256 is no longer large
372  * enough due to m_hdr and m_pkthdr bloat.
373  *
374  * MCLBYTES must be a power of 2 and is typically significantly larger
375  * than MSIZE, sufficient to hold a standard-mtu packet.  2K is considered
376  * reasonable.
377  */
378 #ifndef MSIZE
379 #define MSIZE           512             /* size of an mbuf */
380 #endif
381
382 #ifndef MCLSHIFT
383 #define MCLSHIFT        11              /* convert bytes to m_buf clusters */
384 #endif
385 #define MCLBYTES        (1 << MCLSHIFT) /* size of an m_buf cluster */
386 #define MCLOFSET        (MCLBYTES - 1)  /* offset within an m_buf cluster */
387
388 /*
389  * Make this available for most of the kernel.  There were too many
390  * things that included sys/systm.h just for panic().
391  */
392 #ifdef _KERNEL
393 void    panic (const char *, ...) __dead2 __printflike(1, 2);
394 #endif
395
396 #ifndef htonl
397 #define htonl(x)        __htonl(x)
398 #endif
399 #ifndef htons
400 #define htons(x)        __htons(x)
401 #endif
402 #ifndef ntohl
403 #define ntohl(x)        __ntohl(x)
404 #endif
405 #ifndef ntohs
406 #define ntohs(x)        __ntohs(x)
407 #endif
408
409 /*
410  * Access a variable length array that has been declared as a fixed
411  * length array.
412  */
413 #define __PAST_END(array, offset) (((__typeof__(*(array)) *)(array))[offset])
414
415 #endif  /* _SYS_PARAM_H_ */