]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - sys/sys/unistd.h
sysctl(9): Fix a few mandoc related issues
[FreeBSD/FreeBSD.git] / sys / sys / unistd.h
1 /*-
2  * SPDX-License-Identifier: BSD-3-Clause
3  *
4  * Copyright (c) 1989, 1993
5  *      The Regents of the University of California.  All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  * 3. Neither the name of the University nor the names of its contributors
16  *    may be used to endorse or promote products derived from this software
17  *    without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29  * SUCH DAMAGE.
30  *
31  *      @(#)unistd.h    8.2 (Berkeley) 1/7/94
32  * $FreeBSD$
33  */
34
35 #ifndef _SYS_UNISTD_H_
36 #define _SYS_UNISTD_H_
37
38 #include <sys/cdefs.h>
39
40 /*
41  * POSIX options and option groups we unconditionally do or don't
42  * implement.  Those options which are implemented (or not) entirely
43  * in user mode are defined in <unistd.h>.  Please keep this list in
44  * alphabetical order.
45  *
46  * Anything which is defined as zero below **must** have an
47  * implementation for the corresponding sysconf() which is able to
48  * determine conclusively whether or not the feature is supported.
49  * Anything which is defined as other than -1 below **must** have
50  * complete headers, types, and function declarations as specified by
51  * the POSIX standard; however, if the relevant sysconf() function
52  * returns -1, the functions may be stubbed out.
53  */
54 #define _POSIX_ADVISORY_INFO            200112L
55 #define _POSIX_ASYNCHRONOUS_IO          200112L
56 #define _POSIX_CHOWN_RESTRICTED         1
57 #define _POSIX_CLOCK_SELECTION          (-1)
58 #define _POSIX_CPUTIME                  200112L
59 #define _POSIX_FSYNC                    200112L
60 #define _POSIX_IPV6                     0
61 #define _POSIX_JOB_CONTROL              1
62 #define _POSIX_MAPPED_FILES             200112L
63 #define _POSIX_MEMLOCK                  (-1)
64 #define _POSIX_MEMLOCK_RANGE            200112L
65 #define _POSIX_MEMORY_PROTECTION        200112L
66 #define _POSIX_MESSAGE_PASSING          200112L
67 #define _POSIX_MONOTONIC_CLOCK          200112L
68 #define _POSIX_NO_TRUNC                 1
69 #define _POSIX_PRIORITIZED_IO           (-1)
70 #define _POSIX_PRIORITY_SCHEDULING      0
71 #define _POSIX_RAW_SOCKETS              200112L
72 #define _POSIX_REALTIME_SIGNALS         200112L
73 #define _POSIX_SEMAPHORES               200112L
74 #define _POSIX_SHARED_MEMORY_OBJECTS    200112L
75 #define _POSIX_SPORADIC_SERVER          (-1)
76 #define _POSIX_SYNCHRONIZED_IO          (-1)
77 #define _POSIX_TIMEOUTS                 200112L
78 #define _POSIX_TIMERS                   200112L
79 #define _POSIX_TYPED_MEMORY_OBJECTS     (-1)
80 #define _POSIX_VDISABLE                 0xff
81
82 #if __XSI_VISIBLE
83 #define _XOPEN_SHM                      1
84 #define _XOPEN_STREAMS                  (-1)
85 #endif
86
87 /*
88  * Although we have saved user/group IDs, we do not use them in setuid
89  * as described in POSIX 1003.1, because the feature does not work for
90  * root.  We use the saved IDs in seteuid/setegid, which are not currently
91  * part of the POSIX 1003.1 specification.  XXX revisit for 1003.1-2001
92  * as this is now mandatory.
93  */
94 #ifdef  _NOT_AVAILABLE
95 #define _POSIX_SAVED_IDS        1 /* saved set-user-ID and set-group-ID */
96 #endif
97
98 /* Define the POSIX.1 version we target for compliance. */
99 #define _POSIX_VERSION          200112L
100
101 /* access function */
102 #define F_OK            0       /* test for existence of file */
103 #define X_OK            0x01    /* test for execute or search permission */
104 #define W_OK            0x02    /* test for write permission */
105 #define R_OK            0x04    /* test for read permission */
106
107 /* whence values for lseek(2) */
108 #ifndef SEEK_SET
109 #define SEEK_SET        0       /* set file offset to offset */
110 #define SEEK_CUR        1       /* set file offset to current plus offset */
111 #define SEEK_END        2       /* set file offset to EOF plus offset */
112 #endif
113 #if __BSD_VISIBLE
114 #define SEEK_DATA       3       /* set file offset to next data past offset */
115 #define SEEK_HOLE       4       /* set file offset to next hole past offset */
116 #endif
117
118 #ifndef _POSIX_SOURCE
119 /* whence values for lseek(2); renamed by POSIX 1003.1 */
120 #define L_SET           SEEK_SET
121 #define L_INCR          SEEK_CUR
122 #define L_XTND          SEEK_END
123 #endif
124
125 /* configurable pathname variables */
126 #define _PC_LINK_MAX             1
127 #define _PC_MAX_CANON            2
128 #define _PC_MAX_INPUT            3
129 #define _PC_NAME_MAX             4
130 #define _PC_PATH_MAX             5
131 #define _PC_PIPE_BUF             6
132 #define _PC_CHOWN_RESTRICTED     7
133 #define _PC_NO_TRUNC             8
134 #define _PC_VDISABLE             9
135
136 #if __POSIX_VISIBLE >= 199309
137 #define _PC_ASYNC_IO            53
138 #define _PC_PRIO_IO             54
139 #define _PC_SYNC_IO             55
140 #endif
141
142 #if __POSIX_VISIBLE >= 200112
143 #define _PC_ALLOC_SIZE_MIN      10
144 #define _PC_FILESIZEBITS        12
145 #define _PC_REC_INCR_XFER_SIZE  14
146 #define _PC_REC_MAX_XFER_SIZE   15
147 #define _PC_REC_MIN_XFER_SIZE   16
148 #define _PC_REC_XFER_ALIGN      17
149 #define _PC_SYMLINK_MAX         18
150 #endif
151
152 #if __BSD_VISIBLE
153 #define _PC_ACL_EXTENDED        59
154 #define _PC_ACL_PATH_MAX        60
155 #define _PC_CAP_PRESENT         61
156 #define _PC_INF_PRESENT         62
157 #define _PC_MAC_PRESENT         63
158 #define _PC_ACL_NFS4            64
159 #endif
160
161 /* From OpenSolaris, used by SEEK_DATA/SEEK_HOLE. */
162 #define _PC_MIN_HOLE_SIZE       21
163
164 #if __BSD_VISIBLE
165 /*
166  * rfork() options.
167  *
168  * XXX currently, some operations without RFPROC set are not supported.
169  */
170 #define RFNAMEG         (1<<0)  /* UNIMPL new plan9 `name space' */
171 #define RFENVG          (1<<1)  /* UNIMPL copy plan9 `env space' */
172 #define RFFDG           (1<<2)  /* copy fd table */
173 #define RFNOTEG         (1<<3)  /* UNIMPL create new plan9 `note group' */
174 #define RFPROC          (1<<4)  /* change child (else changes curproc) */
175 #define RFMEM           (1<<5)  /* share `address space' */
176 #define RFNOWAIT        (1<<6)  /* give child to init */
177 #define RFCNAMEG        (1<<10) /* UNIMPL zero plan9 `name space' */
178 #define RFCENVG         (1<<11) /* UNIMPL zero plan9 `env space' */
179 #define RFCFDG          (1<<12) /* close all fds, zero fd table */
180 #define RFTHREAD        (1<<13) /* enable kernel thread support */
181 #define RFSIGSHARE      (1<<14) /* share signal handlers */
182 #define RFLINUXTHPN     (1<<16) /* do linux clone exit parent notification */
183 #define RFSTOPPED       (1<<17) /* leave child in a stopped state */
184 #define RFHIGHPID       (1<<18) /* use a pid higher than 10 (idleproc) */
185 #define RFTSIGZMB       (1<<19) /* select signal for exit parent notification */
186 #define RFTSIGSHIFT     20      /* selected signal number is in bits 20-27  */
187 #define RFTSIGMASK      0xFF
188 #define RFTSIGNUM(flags)        (((flags) >> RFTSIGSHIFT) & RFTSIGMASK)
189 #define RFTSIGFLAGS(signum)     ((signum) << RFTSIGSHIFT)
190 #define RFPROCDESC      (1<<28) /* return a process descriptor */
191 /* kernel: parent sleeps until child exits (vfork) */
192 #define RFPPWAIT        (1<<31)
193 /* user: vfork(2) semantics, clear signals */
194 #define RFSPAWN         (1U<<31)
195 #define RFFLAGS         (RFFDG | RFPROC | RFMEM | RFNOWAIT | RFCFDG | \
196     RFTHREAD | RFSIGSHARE | RFLINUXTHPN | RFSTOPPED | RFHIGHPID | RFTSIGZMB | \
197     RFPROCDESC | RFSPAWN | RFPPWAIT)
198 #define RFKERNELONLY    (RFSTOPPED | RFHIGHPID | RFPROCDESC)
199
200 #endif /* __BSD_VISIBLE */
201
202 #endif /* !_SYS_UNISTD_H_ */