Document copyright year range notation in README.
[glibc.git] / posix / unistd.h
blob9b416979c4ffeb6e86012c80da843dbdb5727f7a
1 /* Copyright (C) 1991-2009, 2010, 2011 Free Software Foundation, Inc.
2 This file is part of the GNU C Library.
4 The GNU C Library is free software; you can redistribute it and/or
5 modify it under the terms of the GNU Lesser General Public
6 License as published by the Free Software Foundation; either
7 version 2.1 of the License, or (at your option) any later version.
9 The GNU C Library is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 Lesser General Public License for more details.
14 You should have received a copy of the GNU Lesser General Public
15 License along with the GNU C Library; if not, write to the Free
16 Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
17 02111-1307 USA. */
20 * POSIX Standard: 2.10 Symbolic Constants <unistd.h>
23 #ifndef _UNISTD_H
24 #define _UNISTD_H 1
26 #include <features.h>
28 __BEGIN_DECLS
30 /* These may be used to determine what facilities are present at compile time.
31 Their values can be obtained at run time from `sysconf'. */
33 #ifdef __USE_XOPEN2K8
34 /* POSIX Standard approved as ISO/IEC 9945-1 as of September 2008. */
35 # define _POSIX_VERSION 200809L
36 #elif defined __USE_XOPEN2K
37 /* POSIX Standard approved as ISO/IEC 9945-1 as of December 2001. */
38 # define _POSIX_VERSION 200112L
39 #elif defined __USE_POSIX199506
40 /* POSIX Standard approved as ISO/IEC 9945-1 as of June 1995. */
41 # define _POSIX_VERSION 199506L
42 #elif defined __USE_POSIX199309
43 /* POSIX Standard approved as ISO/IEC 9945-1 as of September 1993. */
44 # define _POSIX_VERSION 199309L
45 #else
46 /* POSIX Standard approved as ISO/IEC 9945-1 as of September 1990. */
47 # define _POSIX_VERSION 199009L
48 #endif
50 /* These are not #ifdef __USE_POSIX2 because they are
51 in the theoretically application-owned namespace. */
53 #ifdef __USE_XOPEN2K8
54 # define __POSIX2_THIS_VERSION 200809L
55 /* The utilities on GNU systems also correspond to this version. */
56 #elif defined __USE_XOPEN2K
57 /* The utilities on GNU systems also correspond to this version. */
58 # define __POSIX2_THIS_VERSION 200112L
59 #elif defined __USE_POSIX199506
60 /* The utilities on GNU systems also correspond to this version. */
61 # define __POSIX2_THIS_VERSION 199506L
62 #else
63 /* The utilities on GNU systems also correspond to this version. */
64 # define __POSIX2_THIS_VERSION 199209L
65 #endif
67 /* The utilities on GNU systems also correspond to this version. */
68 #define _POSIX2_VERSION __POSIX2_THIS_VERSION
70 /* If defined, the implementation supports the
71 C Language Bindings Option. */
72 #define _POSIX2_C_BIND __POSIX2_THIS_VERSION
74 /* If defined, the implementation supports the
75 C Language Development Utilities Option. */
76 #define _POSIX2_C_DEV __POSIX2_THIS_VERSION
78 /* If defined, the implementation supports the
79 Software Development Utilities Option. */
80 #define _POSIX2_SW_DEV __POSIX2_THIS_VERSION
82 /* If defined, the implementation supports the
83 creation of locales with the localedef utility. */
84 #define _POSIX2_LOCALEDEF __POSIX2_THIS_VERSION
86 /* X/Open version number to which the library conforms. It is selectable. */
87 #ifdef __USE_XOPEN2K8
88 # define _XOPEN_VERSION 700
89 #elif defined __USE_XOPEN2K
90 # define _XOPEN_VERSION 600
91 #elif defined __USE_UNIX98
92 # define _XOPEN_VERSION 500
93 #else
94 # define _XOPEN_VERSION 4
95 #endif
97 /* Commands and utilities from XPG4 are available. */
98 #define _XOPEN_XCU_VERSION 4
100 /* We are compatible with the old published standards as well. */
101 #define _XOPEN_XPG2 1
102 #define _XOPEN_XPG3 1
103 #define _XOPEN_XPG4 1
105 /* The X/Open Unix extensions are available. */
106 #define _XOPEN_UNIX 1
108 /* Encryption is present. */
109 #define _XOPEN_CRYPT 1
111 /* The enhanced internationalization capabilities according to XPG4.2
112 are present. */
113 #define _XOPEN_ENH_I18N 1
115 /* The legacy interfaces are also available. */
116 #define _XOPEN_LEGACY 1
119 /* Get values of POSIX options:
121 If these symbols are defined, the corresponding features are
122 always available. If not, they may be available sometimes.
123 The current values can be obtained with `sysconf'.
125 _POSIX_JOB_CONTROL Job control is supported.
126 _POSIX_SAVED_IDS Processes have a saved set-user-ID
127 and a saved set-group-ID.
128 _POSIX_REALTIME_SIGNALS Real-time, queued signals are supported.
129 _POSIX_PRIORITY_SCHEDULING Priority scheduling is supported.
130 _POSIX_TIMERS POSIX.4 clocks and timers are supported.
131 _POSIX_ASYNCHRONOUS_IO Asynchronous I/O is supported.
132 _POSIX_PRIORITIZED_IO Prioritized asynchronous I/O is supported.
133 _POSIX_SYNCHRONIZED_IO Synchronizing file data is supported.
134 _POSIX_FSYNC The fsync function is present.
135 _POSIX_MAPPED_FILES Mapping of files to memory is supported.
136 _POSIX_MEMLOCK Locking of all memory is supported.
137 _POSIX_MEMLOCK_RANGE Locking of ranges of memory is supported.
138 _POSIX_MEMORY_PROTECTION Setting of memory protections is supported.
139 _POSIX_MESSAGE_PASSING POSIX.4 message queues are supported.
140 _POSIX_SEMAPHORES POSIX.4 counting semaphores are supported.
141 _POSIX_SHARED_MEMORY_OBJECTS POSIX.4 shared memory objects are supported.
142 _POSIX_THREADS POSIX.1c pthreads are supported.
143 _POSIX_THREAD_ATTR_STACKADDR Thread stack address attribute option supported.
144 _POSIX_THREAD_ATTR_STACKSIZE Thread stack size attribute option supported.
145 _POSIX_THREAD_SAFE_FUNCTIONS Thread-safe functions are supported.
146 _POSIX_THREAD_PRIORITY_SCHEDULING
147 POSIX.1c thread execution scheduling supported.
148 _POSIX_THREAD_PRIO_INHERIT Thread priority inheritance option supported.
149 _POSIX_THREAD_PRIO_PROTECT Thread priority protection option supported.
150 _POSIX_THREAD_PROCESS_SHARED Process-shared synchronization supported.
151 _POSIX_PII Protocol-independent interfaces are supported.
152 _POSIX_PII_XTI XTI protocol-indep. interfaces are supported.
153 _POSIX_PII_SOCKET Socket protocol-indep. interfaces are supported.
154 _POSIX_PII_INTERNET Internet family of protocols supported.
155 _POSIX_PII_INTERNET_STREAM Connection-mode Internet protocol supported.
156 _POSIX_PII_INTERNET_DGRAM Connectionless Internet protocol supported.
157 _POSIX_PII_OSI ISO/OSI family of protocols supported.
158 _POSIX_PII_OSI_COTS Connection-mode ISO/OSI service supported.
159 _POSIX_PII_OSI_CLTS Connectionless ISO/OSI service supported.
160 _POSIX_POLL Implementation supports `poll' function.
161 _POSIX_SELECT Implementation supports `select' and `pselect'.
163 _XOPEN_REALTIME X/Open realtime support is available.
164 _XOPEN_REALTIME_THREADS X/Open realtime thread support is available.
165 _XOPEN_SHM Shared memory interface according to XPG4.2.
167 _XBS5_ILP32_OFF32 Implementation provides environment with 32-bit
168 int, long, pointer, and off_t types.
169 _XBS5_ILP32_OFFBIG Implementation provides environment with 32-bit
170 int, long, and pointer and off_t with at least
171 64 bits.
172 _XBS5_LP64_OFF64 Implementation provides environment with 32-bit
173 int, and 64-bit long, pointer, and off_t types.
174 _XBS5_LPBIG_OFFBIG Implementation provides environment with at
175 least 32 bits int and long, pointer, and off_t
176 with at least 64 bits.
178 If any of these symbols is defined as -1, the corresponding option is not
179 true for any file. If any is defined as other than -1, the corresponding
180 option is true for all files. If a symbol is not defined at all, the value
181 for a specific file can be obtained from `pathconf' and `fpathconf'.
183 _POSIX_CHOWN_RESTRICTED Only the super user can use `chown' to change
184 the owner of a file. `chown' can only be used
185 to change the group ID of a file to a group of
186 which the calling process is a member.
187 _POSIX_NO_TRUNC Pathname components longer than
188 NAME_MAX generate an error.
189 _POSIX_VDISABLE If defined, if the value of an element of the
190 `c_cc' member of `struct termios' is
191 _POSIX_VDISABLE, no character will have the
192 effect associated with that element.
193 _POSIX_SYNC_IO Synchronous I/O may be performed.
194 _POSIX_ASYNC_IO Asynchronous I/O may be performed.
195 _POSIX_PRIO_IO Prioritized Asynchronous I/O may be performed.
197 Support for the Large File Support interface is not generally available.
198 If it is available the following constants are defined to one.
199 _LFS64_LARGEFILE Low-level I/O supports large files.
200 _LFS64_STDIO Standard I/O supports large files.
203 #include <bits/posix_opt.h>
205 /* Get the environment definitions from Unix98. */
206 #if defined __USE_UNIX98 || defined __USE_XOPEN2K
207 # include <bits/environments.h>
208 #endif
210 /* Standard file descriptors. */
211 #define STDIN_FILENO 0 /* Standard input. */
212 #define STDOUT_FILENO 1 /* Standard output. */
213 #define STDERR_FILENO 2 /* Standard error output. */
216 /* All functions that are not declared anywhere else. */
218 #include <bits/types.h>
220 #ifndef __ssize_t_defined
221 typedef __ssize_t ssize_t;
222 # define __ssize_t_defined
223 #endif
225 #define __need_size_t
226 #define __need_NULL
227 #include <stddef.h>
229 #if defined __USE_XOPEN || defined __USE_XOPEN2K
230 /* The Single Unix specification says that some more types are
231 available here. */
232 # ifndef __gid_t_defined
233 typedef __gid_t gid_t;
234 # define __gid_t_defined
235 # endif
237 # ifndef __uid_t_defined
238 typedef __uid_t uid_t;
239 # define __uid_t_defined
240 # endif
242 # ifndef __off_t_defined
243 # ifndef __USE_FILE_OFFSET64
244 typedef __off_t off_t;
245 # else
246 typedef __off64_t off_t;
247 # endif
248 # define __off_t_defined
249 # endif
250 # if defined __USE_LARGEFILE64 && !defined __off64_t_defined
251 typedef __off64_t off64_t;
252 # define __off64_t_defined
253 # endif
255 # ifndef __useconds_t_defined
256 typedef __useconds_t useconds_t;
257 # define __useconds_t_defined
258 # endif
260 # ifndef __pid_t_defined
261 typedef __pid_t pid_t;
262 # define __pid_t_defined
263 # endif
264 #endif /* X/Open */
266 #if defined __USE_MISC || defined __USE_XOPEN_EXTENDED || defined __USE_XOPEN2K
267 # ifndef __intptr_t_defined
268 typedef __intptr_t intptr_t;
269 # define __intptr_t_defined
270 # endif
271 #endif
273 #if defined __USE_BSD || defined __USE_XOPEN
274 # ifndef __socklen_t_defined
275 typedef __socklen_t socklen_t;
276 # define __socklen_t_defined
277 # endif
278 #endif
280 /* Values for the second argument to access.
281 These may be OR'd together. */
282 #define R_OK 4 /* Test for read permission. */
283 #define W_OK 2 /* Test for write permission. */
284 #define X_OK 1 /* Test for execute permission. */
285 #define F_OK 0 /* Test for existence. */
287 /* Test for access to NAME using the real UID and real GID. */
288 extern int access (__const char *__name, int __type) __THROW __nonnull ((1));
290 #ifdef __USE_GNU
291 /* Test for access to NAME using the effective UID and GID
292 (as normal file operations use). */
293 extern int euidaccess (__const char *__name, int __type)
294 __THROW __nonnull ((1));
296 /* An alias for `euidaccess', used by some other systems. */
297 extern int eaccess (__const char *__name, int __type)
298 __THROW __nonnull ((1));
299 #endif
301 #ifdef __USE_ATFILE
302 /* Test for access to FILE relative to the directory FD is open on.
303 If AT_EACCESS is set in FLAG, then use effective IDs like `eaccess',
304 otherwise use real IDs like `access'. */
305 extern int faccessat (int __fd, __const char *__file, int __type, int __flag)
306 __THROW __nonnull ((2)) __wur;
307 #endif /* Use GNU. */
310 /* Values for the WHENCE argument to lseek. */
311 #ifndef _STDIO_H /* <stdio.h> has the same definitions. */
312 # define SEEK_SET 0 /* Seek from beginning of file. */
313 # define SEEK_CUR 1 /* Seek from current position. */
314 # define SEEK_END 2 /* Seek from end of file. */
315 # ifdef __USE_GNU
316 # define SEEK_DATA 3 /* Seek to next data. */
317 # define SEEK_HOLE 4 /* Seek to next hole. */
318 # endif
319 #endif
321 #if defined __USE_BSD && !defined L_SET
322 /* Old BSD names for the same constants; just for compatibility. */
323 # define L_SET SEEK_SET
324 # define L_INCR SEEK_CUR
325 # define L_XTND SEEK_END
326 #endif
329 /* Move FD's file position to OFFSET bytes from the
330 beginning of the file (if WHENCE is SEEK_SET),
331 the current position (if WHENCE is SEEK_CUR),
332 or the end of the file (if WHENCE is SEEK_END).
333 Return the new file position. */
334 #ifndef __USE_FILE_OFFSET64
335 extern __off_t lseek (int __fd, __off_t __offset, int __whence) __THROW;
336 #else
337 # ifdef __REDIRECT_NTH
338 extern __off64_t __REDIRECT_NTH (lseek,
339 (int __fd, __off64_t __offset, int __whence),
340 lseek64);
341 # else
342 # define lseek lseek64
343 # endif
344 #endif
345 #ifdef __USE_LARGEFILE64
346 extern __off64_t lseek64 (int __fd, __off64_t __offset, int __whence)
347 __THROW;
348 #endif
350 /* Close the file descriptor FD.
352 This function is a cancellation point and therefore not marked with
353 __THROW. */
354 extern int close (int __fd);
356 /* Read NBYTES into BUF from FD. Return the
357 number read, -1 for errors or 0 for EOF.
359 This function is a cancellation point and therefore not marked with
360 __THROW. */
361 extern ssize_t read (int __fd, void *__buf, size_t __nbytes) __wur;
363 /* Write N bytes of BUF to FD. Return the number written, or -1.
365 This function is a cancellation point and therefore not marked with
366 __THROW. */
367 extern ssize_t write (int __fd, __const void *__buf, size_t __n) __wur;
369 #if defined __USE_UNIX98 || defined __USE_XOPEN2K8
370 # ifndef __USE_FILE_OFFSET64
371 /* Read NBYTES into BUF from FD at the given position OFFSET without
372 changing the file pointer. Return the number read, -1 for errors
373 or 0 for EOF.
375 This function is a cancellation point and therefore not marked with
376 __THROW. */
377 extern ssize_t pread (int __fd, void *__buf, size_t __nbytes,
378 __off_t __offset) __wur;
380 /* Write N bytes of BUF to FD at the given position OFFSET without
381 changing the file pointer. Return the number written, or -1.
383 This function is a cancellation point and therefore not marked with
384 __THROW. */
385 extern ssize_t pwrite (int __fd, __const void *__buf, size_t __n,
386 __off_t __offset) __wur;
387 # else
388 # ifdef __REDIRECT
389 extern ssize_t __REDIRECT (pread, (int __fd, void *__buf, size_t __nbytes,
390 __off64_t __offset),
391 pread64) __wur;
392 extern ssize_t __REDIRECT (pwrite, (int __fd, __const void *__buf,
393 size_t __nbytes, __off64_t __offset),
394 pwrite64) __wur;
395 # else
396 # define pread pread64
397 # define pwrite pwrite64
398 # endif
399 # endif
401 # ifdef __USE_LARGEFILE64
402 /* Read NBYTES into BUF from FD at the given position OFFSET without
403 changing the file pointer. Return the number read, -1 for errors
404 or 0 for EOF. */
405 extern ssize_t pread64 (int __fd, void *__buf, size_t __nbytes,
406 __off64_t __offset) __wur;
407 /* Write N bytes of BUF to FD at the given position OFFSET without
408 changing the file pointer. Return the number written, or -1. */
409 extern ssize_t pwrite64 (int __fd, __const void *__buf, size_t __n,
410 __off64_t __offset) __wur;
411 # endif
412 #endif
414 /* Create a one-way communication channel (pipe).
415 If successful, two file descriptors are stored in PIPEDES;
416 bytes written on PIPEDES[1] can be read from PIPEDES[0].
417 Returns 0 if successful, -1 if not. */
418 extern int pipe (int __pipedes[2]) __THROW __wur;
420 #ifdef __USE_GNU
421 /* Same as pipe but apply flags passed in FLAGS to the new file
422 descriptors. */
423 extern int pipe2 (int __pipedes[2], int __flags) __THROW __wur;
424 #endif
426 /* Schedule an alarm. In SECONDS seconds, the process will get a SIGALRM.
427 If SECONDS is zero, any currently scheduled alarm will be cancelled.
428 The function returns the number of seconds remaining until the last
429 alarm scheduled would have signaled, or zero if there wasn't one.
430 There is no return value to indicate an error, but you can set `errno'
431 to 0 and check its value after calling `alarm', and this might tell you.
432 The signal may come late due to processor scheduling. */
433 extern unsigned int alarm (unsigned int __seconds) __THROW;
435 /* Make the process sleep for SECONDS seconds, or until a signal arrives
436 and is not ignored. The function returns the number of seconds less
437 than SECONDS which it actually slept (thus zero if it slept the full time).
438 If a signal handler does a `longjmp' or modifies the handling of the
439 SIGALRM signal while inside `sleep' call, the handling of the SIGALRM
440 signal afterwards is undefined. There is no return value to indicate
441 error, but if `sleep' returns SECONDS, it probably didn't work.
443 This function is a cancellation point and therefore not marked with
444 __THROW. */
445 extern unsigned int sleep (unsigned int __seconds);
447 #if (defined __USE_XOPEN_EXTENDED && !defined __USE_XOPEN2K8) \
448 || defined __USE_BSD
449 /* Set an alarm to go off (generating a SIGALRM signal) in VALUE
450 microseconds. If INTERVAL is nonzero, when the alarm goes off, the
451 timer is reset to go off every INTERVAL microseconds thereafter.
452 Returns the number of microseconds remaining before the alarm. */
453 extern __useconds_t ualarm (__useconds_t __value, __useconds_t __interval)
454 __THROW;
456 /* Sleep USECONDS microseconds, or until a signal arrives that is not blocked
457 or ignored.
459 This function is a cancellation point and therefore not marked with
460 __THROW. */
461 extern int usleep (__useconds_t __useconds);
462 #endif
465 /* Suspend the process until a signal arrives.
466 This always returns -1 and sets `errno' to EINTR.
468 This function is a cancellation point and therefore not marked with
469 __THROW. */
470 extern int pause (void);
473 /* Change the owner and group of FILE. */
474 extern int chown (__const char *__file, __uid_t __owner, __gid_t __group)
475 __THROW __nonnull ((1)) __wur;
477 #if defined __USE_BSD || defined __USE_XOPEN_EXTENDED || defined __USE_XOPEN2K8
478 /* Change the owner and group of the file that FD is open on. */
479 extern int fchown (int __fd, __uid_t __owner, __gid_t __group) __THROW __wur;
482 /* Change owner and group of FILE, if it is a symbolic
483 link the ownership of the symbolic link is changed. */
484 extern int lchown (__const char *__file, __uid_t __owner, __gid_t __group)
485 __THROW __nonnull ((1)) __wur;
487 #endif /* Use BSD || X/Open Unix. */
489 #ifdef __USE_ATFILE
490 /* Change the owner and group of FILE relative to the directory FD is open
491 on. */
492 extern int fchownat (int __fd, __const char *__file, __uid_t __owner,
493 __gid_t __group, int __flag)
494 __THROW __nonnull ((2)) __wur;
495 #endif /* Use GNU. */
497 /* Change the process's working directory to PATH. */
498 extern int chdir (__const char *__path) __THROW __nonnull ((1)) __wur;
500 #if defined __USE_BSD || defined __USE_XOPEN_EXTENDED || defined __USE_XOPEN2K8
501 /* Change the process's working directory to the one FD is open on. */
502 extern int fchdir (int __fd) __THROW __wur;
503 #endif
505 /* Get the pathname of the current working directory,
506 and put it in SIZE bytes of BUF. Returns NULL if the
507 directory couldn't be determined or SIZE was too small.
508 If successful, returns BUF. In GNU, if BUF is NULL,
509 an array is allocated with `malloc'; the array is SIZE
510 bytes long, unless SIZE == 0, in which case it is as
511 big as necessary. */
512 extern char *getcwd (char *__buf, size_t __size) __THROW __wur;
514 #ifdef __USE_GNU
515 /* Return a malloc'd string containing the current directory name.
516 If the environment variable `PWD' is set, and its value is correct,
517 that value is used. */
518 extern char *get_current_dir_name (void) __THROW;
519 #endif
521 #if (defined __USE_XOPEN_EXTENDED && !defined __USE_XOPEN2K8) \
522 || defined __USE_BSD
523 /* Put the absolute pathname of the current working directory in BUF.
524 If successful, return BUF. If not, put an error message in
525 BUF and return NULL. BUF should be at least PATH_MAX bytes long. */
526 extern char *getwd (char *__buf)
527 __THROW __nonnull ((1)) __attribute_deprecated__ __wur;
528 #endif
531 /* Duplicate FD, returning a new file descriptor on the same file. */
532 extern int dup (int __fd) __THROW __wur;
534 /* Duplicate FD to FD2, closing FD2 and making it open on the same file. */
535 extern int dup2 (int __fd, int __fd2) __THROW;
537 #ifdef __USE_GNU
538 /* Duplicate FD to FD2, closing FD2 and making it open on the same
539 file while setting flags according to FLAGS. */
540 extern int dup3 (int __fd, int __fd2, int __flags) __THROW;
541 #endif
543 /* NULL-terminated array of "NAME=VALUE" environment variables. */
544 extern char **__environ;
545 #ifdef __USE_GNU
546 extern char **environ;
547 #endif
550 /* Replace the current process, executing PATH with arguments ARGV and
551 environment ENVP. ARGV and ENVP are terminated by NULL pointers. */
552 extern int execve (__const char *__path, char *__const __argv[],
553 char *__const __envp[]) __THROW __nonnull ((1, 2));
555 #ifdef __USE_XOPEN2K8
556 /* Execute the file FD refers to, overlaying the running program image.
557 ARGV and ENVP are passed to the new program, as for `execve'. */
558 extern int fexecve (int __fd, char *__const __argv[], char *__const __envp[])
559 __THROW __nonnull ((2));
560 #endif
563 /* Execute PATH with arguments ARGV and environment from `environ'. */
564 extern int execv (__const char *__path, char *__const __argv[])
565 __THROW __nonnull ((1, 2));
567 /* Execute PATH with all arguments after PATH until a NULL pointer,
568 and the argument after that for environment. */
569 extern int execle (__const char *__path, __const char *__arg, ...)
570 __THROW __nonnull ((1, 2));
572 /* Execute PATH with all arguments after PATH until
573 a NULL pointer and environment from `environ'. */
574 extern int execl (__const char *__path, __const char *__arg, ...)
575 __THROW __nonnull ((1, 2));
577 /* Execute FILE, searching in the `PATH' environment variable if it contains
578 no slashes, with arguments ARGV and environment from `environ'. */
579 extern int execvp (__const char *__file, char *__const __argv[])
580 __THROW __nonnull ((1, 2));
582 /* Execute FILE, searching in the `PATH' environment variable if
583 it contains no slashes, with all arguments after FILE until a
584 NULL pointer and environment from `environ'. */
585 extern int execlp (__const char *__file, __const char *__arg, ...)
586 __THROW __nonnull ((1, 2));
588 #ifdef __USE_GNU
589 /* Execute FILE, searching in the `PATH' environment variable if it contains
590 no slashes, with arguments ARGV and environment from `environ'. */
591 extern int execvpe (__const char *__file, char *__const __argv[],
592 char *__const __envp[])
593 __THROW __nonnull ((1, 2));
594 #endif
597 #if defined __USE_MISC || defined __USE_XOPEN
598 /* Add INC to priority of the current process. */
599 extern int nice (int __inc) __THROW __wur;
600 #endif
603 /* Terminate program execution with the low-order 8 bits of STATUS. */
604 extern void _exit (int __status) __attribute__ ((__noreturn__));
607 /* Get the `_PC_*' symbols for the NAME argument to `pathconf' and `fpathconf';
608 the `_SC_*' symbols for the NAME argument to `sysconf';
609 and the `_CS_*' symbols for the NAME argument to `confstr'. */
610 #include <bits/confname.h>
612 /* Get file-specific configuration information about PATH. */
613 extern long int pathconf (__const char *__path, int __name)
614 __THROW __nonnull ((1));
616 /* Get file-specific configuration about descriptor FD. */
617 extern long int fpathconf (int __fd, int __name) __THROW;
619 /* Get the value of the system variable NAME. */
620 extern long int sysconf (int __name) __THROW;
622 #ifdef __USE_POSIX2
623 /* Get the value of the string-valued system variable NAME. */
624 extern size_t confstr (int __name, char *__buf, size_t __len) __THROW;
625 #endif
628 /* Get the process ID of the calling process. */
629 extern __pid_t getpid (void) __THROW;
631 /* Get the process ID of the calling process's parent. */
632 extern __pid_t getppid (void) __THROW;
634 /* Get the process group ID of the calling process.
635 This function is different on old BSD. */
636 #ifndef __FAVOR_BSD
637 extern __pid_t getpgrp (void) __THROW;
638 #else
639 # ifdef __REDIRECT_NTH
640 extern __pid_t __REDIRECT_NTH (getpgrp, (__pid_t __pid), __getpgid);
641 # else
642 # define getpgrp __getpgid
643 # endif
644 #endif
646 /* Get the process group ID of process PID. */
647 extern __pid_t __getpgid (__pid_t __pid) __THROW;
648 #if defined __USE_XOPEN_EXTENDED || defined __USE_XOPEN2K8
649 extern __pid_t getpgid (__pid_t __pid) __THROW;
650 #endif
653 /* Set the process group ID of the process matching PID to PGID.
654 If PID is zero, the current process's process group ID is set.
655 If PGID is zero, the process ID of the process is used. */
656 extern int setpgid (__pid_t __pid, __pid_t __pgid) __THROW;
658 #if defined __USE_SVID || defined __USE_BSD || defined __USE_XOPEN_EXTENDED
659 /* Both System V and BSD have `setpgrp' functions, but with different
660 calling conventions. The BSD function is the same as POSIX.1 `setpgid'
661 (above). The System V function takes no arguments and puts the calling
662 process in its on group like `setpgid (0, 0)'.
664 New programs should always use `setpgid' instead.
666 The default in GNU is to provide the System V function. The BSD
667 function is available under -D_BSD_SOURCE. */
669 # ifndef __FAVOR_BSD
671 /* Set the process group ID of the calling process to its own PID.
672 This is exactly the same as `setpgid (0, 0)'. */
673 extern int setpgrp (void) __THROW;
675 # else
677 /* Another name for `setpgid' (above). */
678 # ifdef __REDIRECT_NTH
679 extern int __REDIRECT_NTH (setpgrp, (__pid_t __pid, __pid_t __pgrp), setpgid);
680 # else
681 # define setpgrp setpgid
682 # endif
684 # endif /* Favor BSD. */
685 #endif /* Use SVID or BSD. */
687 /* Create a new session with the calling process as its leader.
688 The process group IDs of the session and the calling process
689 are set to the process ID of the calling process, which is returned. */
690 extern __pid_t setsid (void) __THROW;
692 #if defined __USE_XOPEN_EXTENDED || defined __USE_XOPEN2K8
693 /* Return the session ID of the given process. */
694 extern __pid_t getsid (__pid_t __pid) __THROW;
695 #endif
697 /* Get the real user ID of the calling process. */
698 extern __uid_t getuid (void) __THROW;
700 /* Get the effective user ID of the calling process. */
701 extern __uid_t geteuid (void) __THROW;
703 /* Get the real group ID of the calling process. */
704 extern __gid_t getgid (void) __THROW;
706 /* Get the effective group ID of the calling process. */
707 extern __gid_t getegid (void) __THROW;
709 /* If SIZE is zero, return the number of supplementary groups
710 the calling process is in. Otherwise, fill in the group IDs
711 of its supplementary groups in LIST and return the number written. */
712 extern int getgroups (int __size, __gid_t __list[]) __THROW __wur;
714 #ifdef __USE_GNU
715 /* Return nonzero iff the calling process is in group GID. */
716 extern int group_member (__gid_t __gid) __THROW;
717 #endif
719 /* Set the user ID of the calling process to UID.
720 If the calling process is the super-user, set the real
721 and effective user IDs, and the saved set-user-ID to UID;
722 if not, the effective user ID is set to UID. */
723 extern int setuid (__uid_t __uid) __THROW;
725 #if defined __USE_BSD || defined __USE_XOPEN_EXTENDED
726 /* Set the real user ID of the calling process to RUID,
727 and the effective user ID of the calling process to EUID. */
728 extern int setreuid (__uid_t __ruid, __uid_t __euid) __THROW;
729 #endif
731 #if defined __USE_BSD || defined __USE_XOPEN2K
732 /* Set the effective user ID of the calling process to UID. */
733 extern int seteuid (__uid_t __uid) __THROW;
734 #endif /* Use BSD. */
736 /* Set the group ID of the calling process to GID.
737 If the calling process is the super-user, set the real
738 and effective group IDs, and the saved set-group-ID to GID;
739 if not, the effective group ID is set to GID. */
740 extern int setgid (__gid_t __gid) __THROW;
742 #if defined __USE_BSD || defined __USE_XOPEN_EXTENDED
743 /* Set the real group ID of the calling process to RGID,
744 and the effective group ID of the calling process to EGID. */
745 extern int setregid (__gid_t __rgid, __gid_t __egid) __THROW;
746 #endif
748 #if defined __USE_BSD || defined __USE_XOPEN2K
749 /* Set the effective group ID of the calling process to GID. */
750 extern int setegid (__gid_t __gid) __THROW;
751 #endif /* Use BSD. */
753 #ifdef __USE_GNU
754 /* Fetch the real user ID, effective user ID, and saved-set user ID,
755 of the calling process. */
756 extern int getresuid (__uid_t *__ruid, __uid_t *__euid, __uid_t *__suid)
757 __THROW;
759 /* Fetch the real group ID, effective group ID, and saved-set group ID,
760 of the calling process. */
761 extern int getresgid (__gid_t *__rgid, __gid_t *__egid, __gid_t *__sgid)
762 __THROW;
764 /* Set the real user ID, effective user ID, and saved-set user ID,
765 of the calling process to RUID, EUID, and SUID, respectively. */
766 extern int setresuid (__uid_t __ruid, __uid_t __euid, __uid_t __suid)
767 __THROW;
769 /* Set the real group ID, effective group ID, and saved-set group ID,
770 of the calling process to RGID, EGID, and SGID, respectively. */
771 extern int setresgid (__gid_t __rgid, __gid_t __egid, __gid_t __sgid)
772 __THROW;
773 #endif
776 /* Clone the calling process, creating an exact copy.
777 Return -1 for errors, 0 to the new process,
778 and the process ID of the new process to the old process. */
779 extern __pid_t fork (void) __THROW;
781 #if (defined __USE_XOPEN_EXTENDED && !defined __USE_XOPEN2K8) \
782 || defined __USE_BSD
783 /* Clone the calling process, but without copying the whole address space.
784 The calling process is suspended until the new process exits or is
785 replaced by a call to `execve'. Return -1 for errors, 0 to the new process,
786 and the process ID of the new process to the old process. */
787 extern __pid_t vfork (void) __THROW;
788 #endif /* Use BSD or XPG < 7. */
791 /* Return the pathname of the terminal FD is open on, or NULL on errors.
792 The returned storage is good only until the next call to this function. */
793 extern char *ttyname (int __fd) __THROW;
795 /* Store at most BUFLEN characters of the pathname of the terminal FD is
796 open on in BUF. Return 0 on success, otherwise an error number. */
797 extern int ttyname_r (int __fd, char *__buf, size_t __buflen)
798 __THROW __nonnull ((2)) __wur;
800 /* Return 1 if FD is a valid descriptor associated
801 with a terminal, zero if not. */
802 extern int isatty (int __fd) __THROW;
804 #if defined __USE_BSD \
805 || (defined __USE_XOPEN_EXTENDED && !defined __USE_UNIX98)
806 /* Return the index into the active-logins file (utmp) for
807 the controlling terminal. */
808 extern int ttyslot (void) __THROW;
809 #endif
812 /* Make a link to FROM named TO. */
813 extern int link (__const char *__from, __const char *__to)
814 __THROW __nonnull ((1, 2)) __wur;
816 #ifdef __USE_ATFILE
817 /* Like link but relative paths in TO and FROM are interpreted relative
818 to FROMFD and TOFD respectively. */
819 extern int linkat (int __fromfd, __const char *__from, int __tofd,
820 __const char *__to, int __flags)
821 __THROW __nonnull ((2, 4)) __wur;
822 #endif
824 #if defined __USE_BSD || defined __USE_XOPEN_EXTENDED || defined __USE_XOPEN2K
825 /* Make a symbolic link to FROM named TO. */
826 extern int symlink (__const char *__from, __const char *__to)
827 __THROW __nonnull ((1, 2)) __wur;
829 /* Read the contents of the symbolic link PATH into no more than
830 LEN bytes of BUF. The contents are not null-terminated.
831 Returns the number of characters read, or -1 for errors. */
832 extern ssize_t readlink (__const char *__restrict __path,
833 char *__restrict __buf, size_t __len)
834 __THROW __nonnull ((1, 2)) __wur;
835 #endif /* Use BSD. */
837 #ifdef __USE_ATFILE
838 /* Like symlink but a relative path in TO is interpreted relative to TOFD. */
839 extern int symlinkat (__const char *__from, int __tofd,
840 __const char *__to) __THROW __nonnull ((1, 3)) __wur;
842 /* Like readlink but a relative PATH is interpreted relative to FD. */
843 extern ssize_t readlinkat (int __fd, __const char *__restrict __path,
844 char *__restrict __buf, size_t __len)
845 __THROW __nonnull ((2, 3)) __wur;
846 #endif
848 /* Remove the link NAME. */
849 extern int unlink (__const char *__name) __THROW __nonnull ((1));
851 #ifdef __USE_ATFILE
852 /* Remove the link NAME relative to FD. */
853 extern int unlinkat (int __fd, __const char *__name, int __flag)
854 __THROW __nonnull ((2));
855 #endif
857 /* Remove the directory PATH. */
858 extern int rmdir (__const char *__path) __THROW __nonnull ((1));
861 /* Return the foreground process group ID of FD. */
862 extern __pid_t tcgetpgrp (int __fd) __THROW;
864 /* Set the foreground process group ID of FD set PGRP_ID. */
865 extern int tcsetpgrp (int __fd, __pid_t __pgrp_id) __THROW;
868 /* Return the login name of the user.
870 This function is a possible cancellation point and therefore not
871 marked with __THROW. */
872 extern char *getlogin (void);
873 #if defined __USE_REENTRANT || defined __USE_POSIX199506
874 /* Return at most NAME_LEN characters of the login name of the user in NAME.
875 If it cannot be determined or some other error occurred, return the error
876 code. Otherwise return 0.
878 This function is a possible cancellation point and therefore not
879 marked with __THROW. */
880 extern int getlogin_r (char *__name, size_t __name_len) __nonnull ((1));
881 #endif
883 #ifdef __USE_BSD
884 /* Set the login name returned by `getlogin'. */
885 extern int setlogin (__const char *__name) __THROW __nonnull ((1));
886 #endif
889 #ifdef __USE_POSIX2
890 /* Get definitions and prototypes for functions to process the
891 arguments in ARGV (ARGC of them, minus the program name) for
892 options given in OPTS. */
893 # define __need_getopt
894 # include <getopt.h>
895 #endif
898 #if defined __USE_BSD || defined __USE_UNIX98 || defined __USE_XOPEN2K
899 /* Put the name of the current host in no more than LEN bytes of NAME.
900 The result is null-terminated if LEN is large enough for the full
901 name and the terminator. */
902 extern int gethostname (char *__name, size_t __len) __THROW __nonnull ((1));
903 #endif
906 #if defined __USE_BSD || (defined __USE_XOPEN && !defined __USE_UNIX98)
907 /* Set the name of the current host to NAME, which is LEN bytes long.
908 This call is restricted to the super-user. */
909 extern int sethostname (__const char *__name, size_t __len)
910 __THROW __nonnull ((1)) __wur;
912 /* Set the current machine's Internet number to ID.
913 This call is restricted to the super-user. */
914 extern int sethostid (long int __id) __THROW __wur;
917 /* Get and set the NIS (aka YP) domain name, if any.
918 Called just like `gethostname' and `sethostname'.
919 The NIS domain name is usually the empty string when not using NIS. */
920 extern int getdomainname (char *__name, size_t __len)
921 __THROW __nonnull ((1)) __wur;
922 extern int setdomainname (__const char *__name, size_t __len)
923 __THROW __nonnull ((1)) __wur;
926 /* Revoke access permissions to all processes currently communicating
927 with the control terminal, and then send a SIGHUP signal to the process
928 group of the control terminal. */
929 extern int vhangup (void) __THROW;
931 /* Revoke the access of all descriptors currently open on FILE. */
932 extern int revoke (__const char *__file) __THROW __nonnull ((1)) __wur;
935 /* Enable statistical profiling, writing samples of the PC into at most
936 SIZE bytes of SAMPLE_BUFFER; every processor clock tick while profiling
937 is enabled, the system examines the user PC and increments
938 SAMPLE_BUFFER[((PC - OFFSET) / 2) * SCALE / 65536]. If SCALE is zero,
939 disable profiling. Returns zero on success, -1 on error. */
940 extern int profil (unsigned short int *__sample_buffer, size_t __size,
941 size_t __offset, unsigned int __scale)
942 __THROW __nonnull ((1));
945 /* Turn accounting on if NAME is an existing file. The system will then write
946 a record for each process as it terminates, to this file. If NAME is NULL,
947 turn accounting off. This call is restricted to the super-user. */
948 extern int acct (__const char *__name) __THROW;
951 /* Successive calls return the shells listed in `/etc/shells'. */
952 extern char *getusershell (void) __THROW;
953 extern void endusershell (void) __THROW; /* Discard cached info. */
954 extern void setusershell (void) __THROW; /* Rewind and re-read the file. */
957 /* Put the program in the background, and dissociate from the controlling
958 terminal. If NOCHDIR is zero, do `chdir ("/")'. If NOCLOSE is zero,
959 redirects stdin, stdout, and stderr to /dev/null. */
960 extern int daemon (int __nochdir, int __noclose) __THROW __wur;
961 #endif /* Use BSD || X/Open. */
964 #if defined __USE_BSD || (defined __USE_XOPEN && !defined __USE_XOPEN2K)
965 /* Make PATH be the root directory (the starting point for absolute paths).
966 This call is restricted to the super-user. */
967 extern int chroot (__const char *__path) __THROW __nonnull ((1)) __wur;
969 /* Prompt with PROMPT and read a string from the terminal without echoing.
970 Uses /dev/tty if possible; otherwise stderr and stdin. */
971 extern char *getpass (__const char *__prompt) __nonnull ((1));
972 #endif /* Use BSD || X/Open. */
975 #if defined __USE_BSD || defined __USE_XOPEN || defined __USE_XOPEN2K
976 /* Make all changes done to FD actually appear on disk.
978 This function is a cancellation point and therefore not marked with
979 __THROW. */
980 extern int fsync (int __fd);
981 #endif /* Use BSD || X/Open || Unix98. */
984 #ifdef __USE_GNU
985 /* Make all changes done to all files on the file system associated
986 with FD actually appear on disk. */
987 extern int syncfs (int __fd) __THROW;
988 #endif
991 #if defined __USE_BSD || defined __USE_XOPEN_EXTENDED
993 /* Return identifier for the current host. */
994 extern long int gethostid (void);
996 /* Make all changes done to all files actually appear on disk. */
997 extern void sync (void) __THROW;
1000 # if defined __USE_BSD || !defined __USE_XOPEN2K
1001 /* Return the number of bytes in a page. This is the system's page size,
1002 which is not necessarily the same as the hardware page size. */
1003 extern int getpagesize (void) __THROW __attribute__ ((__const__));
1006 /* Return the maximum number of file descriptors
1007 the current process could possibly have. */
1008 extern int getdtablesize (void) __THROW;
1009 # endif
1011 #endif /* Use BSD || X/Open Unix. */
1014 #if defined __USE_BSD || defined __USE_XOPEN_EXTENDED || defined __USE_XOPEN2K8
1016 /* Truncate FILE to LENGTH bytes. */
1017 # ifndef __USE_FILE_OFFSET64
1018 extern int truncate (__const char *__file, __off_t __length)
1019 __THROW __nonnull ((1)) __wur;
1020 # else
1021 # ifdef __REDIRECT_NTH
1022 extern int __REDIRECT_NTH (truncate,
1023 (__const char *__file, __off64_t __length),
1024 truncate64) __nonnull ((1)) __wur;
1025 # else
1026 # define truncate truncate64
1027 # endif
1028 # endif
1029 # ifdef __USE_LARGEFILE64
1030 extern int truncate64 (__const char *__file, __off64_t __length)
1031 __THROW __nonnull ((1)) __wur;
1032 # endif
1034 #endif /* Use BSD || X/Open Unix || POSIX 2008. */
1036 #if defined __USE_BSD || defined __USE_XOPEN_EXTENDED || defined __USE_XOPEN2K
1038 /* Truncate the file FD is open on to LENGTH bytes. */
1039 # ifndef __USE_FILE_OFFSET64
1040 extern int ftruncate (int __fd, __off_t __length) __THROW __wur;
1041 # else
1042 # ifdef __REDIRECT_NTH
1043 extern int __REDIRECT_NTH (ftruncate, (int __fd, __off64_t __length),
1044 ftruncate64) __wur;
1045 # else
1046 # define ftruncate ftruncate64
1047 # endif
1048 # endif
1049 # ifdef __USE_LARGEFILE64
1050 extern int ftruncate64 (int __fd, __off64_t __length) __THROW __wur;
1051 # endif
1053 #endif /* Use BSD || X/Open Unix || POSIX 2003. */
1056 #if (defined __USE_XOPEN_EXTENDED && !defined __USE_XOPEN2K) \
1057 || defined __USE_MISC
1059 /* Set the end of accessible data space (aka "the break") to ADDR.
1060 Returns zero on success and -1 for errors (with errno set). */
1061 extern int brk (void *__addr) __THROW __wur;
1063 /* Increase or decrease the end of accessible data space by DELTA bytes.
1064 If successful, returns the address the previous end of data space
1065 (i.e. the beginning of the new space, if DELTA > 0);
1066 returns (void *) -1 for errors (with errno set). */
1067 extern void *sbrk (intptr_t __delta) __THROW;
1068 #endif
1071 #ifdef __USE_MISC
1072 /* Invoke `system call' number SYSNO, passing it the remaining arguments.
1073 This is completely system-dependent, and not often useful.
1075 In Unix, `syscall' sets `errno' for all errors and most calls return -1
1076 for errors; in many systems you cannot pass arguments or get return
1077 values for all system calls (`pipe', `fork', and `getppid' typically
1078 among them).
1080 In Mach, all system calls take normal arguments and always return an
1081 error code (zero for success). */
1082 extern long int syscall (long int __sysno, ...) __THROW;
1084 #endif /* Use misc. */
1087 #if (defined __USE_MISC || defined __USE_XOPEN_EXTENDED) && !defined F_LOCK
1088 /* NOTE: These declarations also appear in <fcntl.h>; be sure to keep both
1089 files consistent. Some systems have them there and some here, and some
1090 software depends on the macros being defined without including both. */
1092 /* `lockf' is a simpler interface to the locking facilities of `fcntl'.
1093 LEN is always relative to the current file position.
1094 The CMD argument is one of the following.
1096 This function is a cancellation point and therefore not marked with
1097 __THROW. */
1099 # define F_ULOCK 0 /* Unlock a previously locked region. */
1100 # define F_LOCK 1 /* Lock a region for exclusive use. */
1101 # define F_TLOCK 2 /* Test and lock a region for exclusive use. */
1102 # define F_TEST 3 /* Test a region for other processes locks. */
1104 # ifndef __USE_FILE_OFFSET64
1105 extern int lockf (int __fd, int __cmd, __off_t __len) __wur;
1106 # else
1107 # ifdef __REDIRECT
1108 extern int __REDIRECT (lockf, (int __fd, int __cmd, __off64_t __len),
1109 lockf64) __wur;
1110 # else
1111 # define lockf lockf64
1112 # endif
1113 # endif
1114 # ifdef __USE_LARGEFILE64
1115 extern int lockf64 (int __fd, int __cmd, __off64_t __len) __wur;
1116 # endif
1117 #endif /* Use misc and F_LOCK not already defined. */
1120 #ifdef __USE_GNU
1122 /* Evaluate EXPRESSION, and repeat as long as it returns -1 with `errno'
1123 set to EINTR. */
1125 # define TEMP_FAILURE_RETRY(expression) \
1126 (__extension__ \
1127 ({ long int __result; \
1128 do __result = (long int) (expression); \
1129 while (__result == -1L && errno == EINTR); \
1130 __result; }))
1131 #endif
1133 #if defined __USE_POSIX199309 || defined __USE_UNIX98
1134 /* Synchronize at least the data part of a file with the underlying
1135 media. */
1136 extern int fdatasync (int __fildes);
1137 #endif /* Use POSIX199309 */
1140 /* XPG4.2 specifies that prototypes for the encryption functions must
1141 be defined here. */
1142 #ifdef __USE_XOPEN
1143 /* Encrypt at most 8 characters from KEY using salt to perturb DES. */
1144 extern char *crypt (__const char *__key, __const char *__salt)
1145 __THROW __nonnull ((1, 2));
1147 /* Encrypt data in BLOCK in place if EDFLAG is zero; otherwise decrypt
1148 block in place. */
1149 extern void encrypt (char *__block, int __edflag) __THROW __nonnull ((1));
1152 /* Swab pairs bytes in the first N bytes of the area pointed to by
1153 FROM and copy the result to TO. The value of TO must not be in the
1154 range [FROM - N + 1, FROM - 1]. If N is odd the first byte in FROM
1155 is without partner. */
1156 extern void swab (__const void *__restrict __from, void *__restrict __to,
1157 ssize_t __n) __THROW __nonnull ((1, 2));
1158 #endif
1161 /* The Single Unix specification demands this prototype to be here.
1162 It is also found in <stdio.h>. */
1163 #if defined __USE_XOPEN || defined __USE_XOPEN2K8
1164 /* Return the name of the controlling terminal. */
1165 extern char *ctermid (char *__s) __THROW;
1166 #endif
1169 /* Define some macros helping to catch buffer overflows. */
1170 #if __USE_FORTIFY_LEVEL > 0 && defined __extern_always_inline
1171 # include <bits/unistd.h>
1172 #endif
1174 __END_DECLS
1176 #endif /* unistd.h */