xref: /netbsd-src/include/unistd.h (revision 53b02e147d4ed531c0d2a5ca9b3e8026ba3e99b5)
1 /*	$NetBSD: unistd.h,v 1.162 2021/10/15 22:32:28 andvar Exp $	*/
2 
3 /*-
4  * Copyright (c) 1998, 1999, 2008 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to The NetBSD Foundation
8  * by Klaus Klein.
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  *
19  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29  * POSSIBILITY OF SUCH DAMAGE.
30  */
31 
32 /*
33  * Copyright (c) 1991, 1993, 1994
34  *	The Regents of the University of California.  All rights reserved.
35  *
36  * Redistribution and use in source and binary forms, with or without
37  * modification, are permitted provided that the following conditions
38  * are met:
39  * 1. Redistributions of source code must retain the above copyright
40  *    notice, this list of conditions and the following disclaimer.
41  * 2. Redistributions in binary form must reproduce the above copyright
42  *    notice, this list of conditions and the following disclaimer in the
43  *    documentation and/or other materials provided with the distribution.
44  * 3. Neither the name of the University nor the names of its contributors
45  *    may be used to endorse or promote products derived from this software
46  *    without specific prior written permission.
47  *
48  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
49  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
50  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
51  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
52  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
53  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
54  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
55  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
56  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
57  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
58  * SUCH DAMAGE.
59  *
60  *	@(#)unistd.h	8.12 (Berkeley) 4/27/95
61  */
62 
63 #ifndef _UNISTD_H_
64 #define	_UNISTD_H_
65 
66 #include <machine/ansi.h>
67 #include <machine/int_types.h>
68 #include <sys/cdefs.h>
69 #include <sys/featuretest.h>
70 #include <sys/types.h>
71 #include <sys/unistd.h>
72 
73 #if _FORTIFY_SOURCE > 0
74 #include <ssp/unistd.h>
75 #endif
76 
77 /*
78  * IEEE Std 1003.1-90
79  */
80 #define	STDIN_FILENO	0	/* standard input file descriptor */
81 #define	STDOUT_FILENO	1	/* standard output file descriptor */
82 #define	STDERR_FILENO	2	/* standard error file descriptor */
83 
84 #include <sys/null.h>
85 
86 __BEGIN_DECLS
87 __dead	 void _exit(int);
88 int	 access(const char *, int);
89 unsigned int alarm(unsigned int);
90 int	 chdir(const char *);
91 #if defined(_POSIX_C_SOURCE) || defined(_XOPEN_SOURCE)
92 int	chown(const char *, uid_t, gid_t) __RENAME(__posix_chown);
93 #else
94 int	chown(const char *, uid_t, gid_t);
95 #endif /* defined(_POSIX_C_SOURCE) || defined(_XOPEN_SOURCE) */
96 int	 close(int);
97 size_t	 confstr(int, char *, size_t);
98 #ifndef __CUSERID_DECLARED
99 #define __CUSERID_DECLARED
100 /* also declared in stdio.h */
101 char	*cuserid(char *);	/* obsolete */
102 #endif /* __CUSERID_DECLARED */
103 int	 dup(int);
104 int	 dup2(int, int);
105 int	 execl(const char *, const char *, ...) __null_sentinel;
106 int	 execle(const char *, const char *, ...);
107 int	 execlp(const char *, const char *, ...) __null_sentinel;
108 int	 execv(const char *, char * const *);
109 int	 execve(const char *, char * const *, char * const *);
110 int	 execvp(const char *, char * const *);
111 pid_t	 fork(void);
112 long	 fpathconf(int, int);
113 #if __SSP_FORTIFY_LEVEL == 0
114 char	*getcwd(char *, size_t);
115 #endif
116 gid_t	 getegid(void);
117 uid_t	 geteuid(void);
118 gid_t	 getgid(void);
119 int	 getgroups(int, gid_t []);
120 __aconst char *getlogin(void);
121 int	 getlogin_r(char *, size_t);
122 pid_t	 getpgrp(void);
123 pid_t	 getpid(void);
124 pid_t	 getppid(void);
125 uid_t	 getuid(void);
126 int	 isatty(int);
127 int	 link(const char *, const char *);
128 long	 pathconf(const char *, int);
129 int	 pause(void);
130 int	 pipe(int *);
131 #if __SSP_FORTIFY_LEVEL == 0
132 ssize_t	 read(int, void *, size_t);
133 #endif
134 int	 rmdir(const char *);
135 int	 setgid(gid_t);
136 int	 setpgid(pid_t, pid_t);
137 pid_t	 setsid(void);
138 int	 setuid(uid_t);
139 unsigned int	 sleep(unsigned int);
140 long	 sysconf(int);
141 pid_t	 tcgetpgrp(int);
142 int	 tcsetpgrp(int, pid_t);
143 __aconst char *ttyname(int);
144 int	 unlink(const char *);
145 ssize_t	 write(int, const void *, size_t);
146 
147 
148 /*
149  * IEEE Std 1003.2-92, adopted in X/Open Portability Guide Issue 4 and later
150  */
151 #if (_POSIX_C_SOURCE - 0) >= 2 || defined(_XOPEN_SOURCE) || \
152     defined(_NETBSD_SOURCE)
153 int	 getopt(int, char * const [], const char *);
154 
155 extern	 char *optarg;			/* getopt(3) external variables */
156 extern	 int opterr;
157 extern	 int optind;
158 extern	 int optopt;
159 #endif
160 
161 /*
162  * The Open Group Base Specifications, Issue 5; IEEE Std 1003.1-2001 (POSIX)
163  */
164 #if (_POSIX_C_SOURCE - 0) >= 200112L || (_XOPEN_SOURCE - 0) >= 500 || \
165     defined(_NETBSD_SOURCE)
166 #if __SSP_FORTIFY_LEVEL == 0
167 ssize_t	 readlink(const char * __restrict, char * __restrict, size_t);
168 #endif
169 #endif
170 
171 /*
172  * The Open Group Base Specifications, Issue 6; IEEE Std 1003.1-2001 (POSIX)
173  */
174 #if (_POSIX_C_SOURCE - 0) >= 200112L || (_XOPEN_SOURCE - 0) >= 600 || \
175     defined(_NETBSD_SOURCE)
176 int	 setegid(gid_t);
177 int	 seteuid(uid_t);
178 #endif
179 
180 /*
181  * The following three syscalls are also defined in <sys/types.h>
182  * We protect them against double declarations.
183  */
184 #ifndef __OFF_T_SYSCALLS_DECLARED
185 #define __OFF_T_SYSCALLS_DECLARED
186 off_t	 lseek(int, off_t, int);
187 int	 truncate(const char *, off_t);
188 /*
189  * IEEE Std 1003.1b-93,
190  * also found in X/Open Portability Guide >= Issue 4 Version 2
191  */
192 #if (_POSIX_C_SOURCE - 0) >= 199309L || \
193     (defined(_XOPEN_SOURCE) && defined(_XOPEN_SOURCE_EXTENDED)) || \
194     (_XOPEN_SOURCE - 0) >= 500 || defined(_NETBSD_SOURCE)
195 int	 ftruncate(int, off_t);
196 #endif
197 #endif /* __OFF_T_SYSCALLS_DECLARED */
198 
199 
200 /*
201  * IEEE Std 1003.1b-93, adopted in X/Open CAE Specification Issue 5 Version 2
202  */
203 #if (_POSIX_C_SOURCE - 0) >= 199309L || (_XOPEN_SOURCE - 0) >= 500 || \
204     defined(_NETBSD_SOURCE)
205 int	 fdatasync(int);
206 int	 fsync(int);
207 #endif
208 
209 
210 /*
211  * IEEE Std 1003.1c-95, also adopted by X/Open CAE Spec Issue 5 Version 2
212  */
213 #if (_POSIX_C_SOURCE - 0) >= 199506L || (_XOPEN_SOURCE - 0) >= 500 || \
214     defined(_REENTRANT) || defined(_NETBSD_SOURCE)
215 int	 ttyname_r(int, char *, size_t);
216 #ifndef __PTHREAD_ATFORK_DECLARED
217 #define __PTHREAD_ATFORK_DECLARED
218 int	 pthread_atfork(void (*)(void), void (*)(void), void (*)(void));
219 #endif
220 #endif
221 
222 /*
223  * X/Open Portability Guide, all issues
224  */
225 #if defined(_XOPEN_SOURCE) || defined(_NETBSD_SOURCE)
226 int	 chroot(const char *);
227 int	 nice(int);
228 #endif
229 
230 
231 /*
232  * X/Open Portability Guide >= Issue 4
233  */
234 #if defined(_XOPEN_SOURCE) || defined(_NETBSD_SOURCE)
235 __aconst char *crypt(const char *, const char *);
236 int	 encrypt(char *, int);
237 char	*getpass(const char *);
238 #endif
239 #if defined(_XOPEN_SOURCE) || (_POSIX_C_SOURCE - 0) >= 200809L || \
240     defined(_NETBSD_SOURCE)
241 pid_t	 getsid(pid_t);
242 #endif
243 
244 
245 /*
246  * X/Open Portability Guide >= Issue 4 Version 2
247  */
248 #if (defined(_XOPEN_SOURCE) && defined(_XOPEN_SOURCE_EXTENDED)) || \
249     (_XOPEN_SOURCE - 0) >= 500 || defined(_NETBSD_SOURCE)
250 #ifndef _BSD_INTPTR_T_
251 typedef __intptr_t      intptr_t;
252 #define _BSD_INTPTR_T_
253 #endif
254 
255 #define F_ULOCK		0
256 #define F_LOCK		1
257 #define F_TLOCK		2
258 #define F_TEST		3
259 
260 int	 brk(void *);
261 int	 fchdir(int);
262 #if defined(_XOPEN_SOURCE)
263 int	 fchown(int, uid_t, gid_t) __RENAME(__posix_fchown);
264 #else
265 int	 fchown(int, uid_t, gid_t);
266 #endif
267 int	 getdtablesize(void);
268 long	 gethostid(void);
269 int	 gethostname(char *, size_t);
270 __pure int
271 	 getpagesize(void);		/* legacy */
272 pid_t	 getpgid(pid_t);
273 #if defined(_XOPEN_SOURCE)
274 int	 lchown(const char *, uid_t, gid_t) __RENAME(__posix_lchown);
275 #else
276 int	 lchown(const char *, uid_t, gid_t);
277 #endif
278 int	 lockf(int, int, off_t);
279 void	*sbrk(intptr_t);
280 /* XXX prototype wrong! */
281 int	 setpgrp(pid_t, pid_t);			/* obsoleted by setpgid() */
282 int	 setregid(gid_t, gid_t);
283 int	 setreuid(uid_t, uid_t);
284 void	 swab(const void * __restrict, void * __restrict, ssize_t);
285 int	 symlink(const char *, const char *);
286 void	 sync(void);
287 useconds_t ualarm(useconds_t, useconds_t);
288 int	 usleep(useconds_t);
289 #ifndef __LIBC12_SOURCE__
290 pid_t	 vfork(void) __RENAME(__vfork14) __returns_twice;
291 #endif
292 
293 #ifndef __AUDIT__
294 char	*getwd(char *);				/* obsoleted by getcwd() */
295 #endif
296 #endif /* _XOPEN_SOURCE_EXTENDED || _XOPEN_SOURCE >= 500 || _NETBSD_SOURCE */
297 
298 
299 /*
300  * X/Open CAE Specification Issue 5 Version 2
301  */
302 #if (_POSIX_C_SOURCE - 0) >= 200112L || (_XOPEN_SOURCE - 0) >= 500 || \
303     defined(_NETBSD_SOURCE)
304 ssize_t	 pread(int, void *, size_t, off_t);
305 ssize_t	 pwrite(int, const void *, size_t, off_t);
306 #endif /* (_POSIX_C_SOURCE - 0) >= 200112L || ... */
307 
308 /*
309  * X/Open Extended API set 2 (a.k.a. C063)
310  */
311 #if (_POSIX_C_SOURCE - 0) >= 200809L || (_XOPEN_SOURCE - 0 >= 700) || \
312     defined(_NETBSD_SOURCE)
313 int	linkat(int, const char *, int, const char *, int);
314 int	renameat(int, const char *, int, const char *);
315 int	faccessat(int, const char *, int, int);
316 int	fchownat(int, const char *, uid_t, gid_t, int);
317 ssize_t	readlinkat(int, const char *, char *, size_t);
318 int	symlinkat(const char *, int, const char *);
319 int	unlinkat(int, const char *, int);
320 int	fexecve(int, char * const *, char * const *);
321 #endif
322 
323 
324 /*
325  * Implementation-defined extensions
326  */
327 #if defined(_NETBSD_SOURCE)
328 int	 acct(const char *);
329 int	 closefrom(int);
330 int	 des_cipher(const char *, char *, long, int);
331 int	 des_setkey(const char *);
332 int	 dup3(int, int, int);
333 void	 endusershell(void);
334 int	 exect(const char *, char * const *, char * const *);
335 int	 execvpe(const char *, char * const *, char * const *);
336 int	 execlpe(const char *, const char *, ...);
337 int	 fchroot(int);
338 int	 fdiscard(int, off_t, off_t);
339 int	 fsync_range(int, int, off_t, off_t);
340 int	 getdomainname(char *, size_t);
341 int	 getgrouplist(const char *, gid_t, gid_t *, int *);
342 int	 getgroupmembership(const char *, gid_t, gid_t *, int, int *);
343 mode_t	 getmode(const void *, mode_t);
344 char	*getpassfd(const char *, char *, size_t, int *, int, int);
345 #define	GETPASS_NEED_TTY	0x001	/* Fail if we cannot set tty */
346 #define	GETPASS_FAIL_EOF	0x002	/* Fail on EOF */
347 #define	GETPASS_BUF_LIMIT	0x004	/* beep on buffer limit */
348 #define	GETPASS_NO_SIGNAL	0x008	/* don't make ttychars send signals */
349 #define	GETPASS_NO_BEEP		0x010	/* don't beep */
350 #define	GETPASS_ECHO		0x020	/* echo characters as they are typed */
351 #define	GETPASS_ECHO_STAR	0x040	/* echo '*' for each character */
352 #define	GETPASS_7BIT		0x080	/* mask the high bit each char */
353 #define	GETPASS_FORCE_LOWER	0x100	/* lowercase each char */
354 #define	GETPASS_FORCE_UPPER	0x200	/* uppercase each char */
355 #define	GETPASS_ECHO_NL		0x400	/* echo a newline if successful */
356 
357 char	*getpass_r(const char *, char *, size_t);
358 int	 getpeereid(int, uid_t *, gid_t *);
359 __aconst char *getusershell(void);
360 int	 initgroups(const char *, gid_t);
361 int	 iruserok(uint32_t, int, const char *, const char *);
362 int      issetugid(void);
363 long	 lpathconf(const char *, int);
364 int	 mkstemps(char *, int);
365 int	 nfssvc(int, void *);
366 int	 pipe2(int *, int);
367 int	 profil(char *, size_t, unsigned long, unsigned int);
368 #ifndef __PSIGNAL_DECLARED
369 #define __PSIGNAL_DECLARED
370 /* also in signal.h */
371 void	 psignal(int, const char *);
372 #endif /* __PSIGNAL_DECLARED */
373 int	 rcmd(char **, int, const char *, const char *, const char *, int *);
374 int	 reboot(int, char *);
375 int	 revoke(const char *);
376 int	 rresvport(int *);
377 int	 ruserok(const char *, int, const char *, const char *);
378 int	 setdomainname(const char *, size_t);
379 int	 setgroups(int, const gid_t *);
380 int	 sethostid(long);
381 int	 sethostname(const char *, size_t);
382 int	 setlogin(const char *);
383 void	*setmode(const char *);
384 int	 setrgid(gid_t);
385 int	 setruid(uid_t);
386 void	 setusershell(void);
387 void	 strmode(mode_t, char *);
388 #ifndef __STRSIGNAL_DECLARED
389 #define __STRSIGNAL_DECLARED
390 /* backwards-compatibility; also in string.h */
391 __aconst char *strsignal(int);
392 #endif /* __STRSIGNAL_DECLARED */
393 int	 swapctl(int, void *, int);
394 int	 swapon(const char *);			/* obsoleted by swapctl() */
395 int	 syscall(int, ...);
396 quad_t	 __syscall(quad_t, ...);
397 int	 undelete(const char *);
398 
399 #if 1 /*INET6*/
400 int	 rcmd_af(char **, int, const char *,
401 	    const char *, const char *, int *, int);
402 int	 rresvport_af(int *, int);
403 int	 rresvport_af_addr(int *, int, void *);
404 int	 iruserok_sa(const void *, int, int, const char *, const char *);
405 #endif
406 
407 #ifndef __SYS_SIGLIST_DECLARED
408 #define __SYS_SIGLIST_DECLARED
409 /* also in signal.h */
410 extern const char *const *sys_siglist __RENAME(__sys_siglist14);
411 #endif /* __SYS_SIGLIST_DECLARED */
412 extern	 int optreset;		/* getopt(3) external variable */
413 extern	 char *suboptarg;	/* getsubopt(3) external variable */
414 #endif
415 
416 __END_DECLS
417 #endif /* !_UNISTD_H_ */
418