Add more IFUNC tests.
[glibc.git] / posix / unistd.h
blobcbab9f939e115490e15ee0f16353ef7842d970ae
1 /* Copyright (C) 1991-2006, 2007, 2008, 2009 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 /* POSIX Standard approved as ISO/IEC 9945-1 as of September 2008. */
34 #define _POSIX_VERSION 200809L
36 /* These are not #ifdef __USE_POSIX2 because they are
37 in the theoretically application-owned namespace. */
39 /* The utilities on GNU systems also correspond to this version. */
40 #define _POSIX2_VERSION 200809L
42 /* If defined, the implementation supports the
43 C Language Bindings Option. */
44 #define _POSIX2_C_BIND 200809L
46 /* If defined, the implementation supports the
47 C Language Development Utilities Option. */
48 #define _POSIX2_C_DEV 200809L
50 /* If defined, the implementation supports the
51 Software Development Utilities Option. */
52 #define _POSIX2_SW_DEV 200809L
54 /* If defined, the implementation supports the
55 creation of locales with the localedef utility. */
56 #define _POSIX2_LOCALEDEF 200809L
58 /* X/Open version number to which the library conforms. It is selectable. */
59 #ifdef __USE_XOPEN2K8
60 # define _XOPEN_VERSION 700
61 #elif defined __USE_XOPEN2K
62 # define _XOPEN_VERSION 600
63 #elif defined __USE_UNIX98
64 # define _XOPEN_VERSION 500
65 #else
66 # define _XOPEN_VERSION 4
67 #endif
69 /* Commands and utilities from XPG4 are available. */
70 #define _XOPEN_XCU_VERSION 4
72 /* We are compatible with the old published standards as well. */
73 #define _XOPEN_XPG2 1
74 #define _XOPEN_XPG3 1
75 #define _XOPEN_XPG4 1
77 /* The X/Open Unix extensions are available. */
78 #define _XOPEN_UNIX 1
80 /* Encryption is present. */
81 #define _XOPEN_CRYPT 1
83 /* The enhanced internationalization capabilities according to XPG4.2
84 are present. */
85 #define _XOPEN_ENH_I18N 1
87 /* The legacy interfaces are also available. */
88 #define _XOPEN_LEGACY 1
91 /* Get values of POSIX options:
93 If these symbols are defined, the corresponding features are
94 always available. If not, they may be available sometimes.
95 The current values can be obtained with `sysconf'.
97 _POSIX_JOB_CONTROL Job control is supported.
98 _POSIX_SAVED_IDS Processes have a saved set-user-ID
99 and a saved set-group-ID.
100 _POSIX_REALTIME_SIGNALS Real-time, queued signals are supported.
101 _POSIX_PRIORITY_SCHEDULING Priority scheduling is supported.
102 _POSIX_TIMERS POSIX.4 clocks and timers are supported.
103 _POSIX_ASYNCHRONOUS_IO Asynchronous I/O is supported.
104 _POSIX_PRIORITIZED_IO Prioritized asynchronous I/O is supported.
105 _POSIX_SYNCHRONIZED_IO Synchronizing file data is supported.
106 _POSIX_FSYNC The fsync function is present.
107 _POSIX_MAPPED_FILES Mapping of files to memory is supported.
108 _POSIX_MEMLOCK Locking of all memory is supported.
109 _POSIX_MEMLOCK_RANGE Locking of ranges of memory is supported.
110 _POSIX_MEMORY_PROTECTION Setting of memory protections is supported.
111 _POSIX_MESSAGE_PASSING POSIX.4 message queues are supported.
112 _POSIX_SEMAPHORES POSIX.4 counting semaphores are supported.
113 _POSIX_SHARED_MEMORY_OBJECTS POSIX.4 shared memory objects are supported.
114 _POSIX_THREADS POSIX.1c pthreads are supported.
115 _POSIX_THREAD_ATTR_STACKADDR Thread stack address attribute option supported.
116 _POSIX_THREAD_ATTR_STACKSIZE Thread stack size attribute option supported.
117 _POSIX_THREAD_SAFE_FUNCTIONS Thread-safe functions are supported.
118 _POSIX_THREAD_PRIORITY_SCHEDULING
119 POSIX.1c thread execution scheduling supported.
120 _POSIX_THREAD_PRIO_INHERIT Thread priority inheritance option supported.
121 _POSIX_THREAD_PRIO_PROTECT Thread priority protection option supported.
122 _POSIX_THREAD_PROCESS_SHARED Process-shared synchronization supported.
123 _POSIX_PII Protocol-independent interfaces are supported.
124 _POSIX_PII_XTI XTI protocol-indep. interfaces are supported.
125 _POSIX_PII_SOCKET Socket protocol-indep. interfaces are supported.
126 _POSIX_PII_INTERNET Internet family of protocols supported.
127 _POSIX_PII_INTERNET_STREAM Connection-mode Internet protocol supported.
128 _POSIX_PII_INTERNET_DGRAM Connectionless Internet protocol supported.
129 _POSIX_PII_OSI ISO/OSI family of protocols supported.
130 _POSIX_PII_OSI_COTS Connection-mode ISO/OSI service supported.
131 _POSIX_PII_OSI_CLTS Connectionless ISO/OSI service supported.
132 _POSIX_POLL Implementation supports `poll' function.
133 _POSIX_SELECT Implementation supports `select' and `pselect'.
135 _XOPEN_REALTIME X/Open realtime support is available.
136 _XOPEN_REALTIME_THREADS X/Open realtime thread support is available.
137 _XOPEN_SHM Shared memory interface according to XPG4.2.
139 _XBS5_ILP32_OFF32 Implementation provides environment with 32-bit
140 int, long, pointer, and off_t types.
141 _XBS5_ILP32_OFFBIG Implementation provides environment with 32-bit
142 int, long, and pointer and off_t with at least
143 64 bits.
144 _XBS5_LP64_OFF64 Implementation provides environment with 32-bit
145 int, and 64-bit long, pointer, and off_t types.
146 _XBS5_LPBIG_OFFBIG Implementation provides environment with at
147 least 32 bits int and long, pointer, and off_t
148 with at least 64 bits.
150 If any of these symbols is defined as -1, the corresponding option is not
151 true for any file. If any is defined as other than -1, the corresponding
152 option is true for all files. If a symbol is not defined at all, the value
153 for a specific file can be obtained from `pathconf' and `fpathconf'.
155 _POSIX_CHOWN_RESTRICTED Only the super user can use `chown' to change
156 the owner of a file. `chown' can only be used
157 to change the group ID of a file to a group of
158 which the calling process is a member.
159 _POSIX_NO_TRUNC Pathname components longer than
160 NAME_MAX generate an error.
161 _POSIX_VDISABLE If defined, if the value of an element of the
162 `c_cc' member of `struct termios' is
163 _POSIX_VDISABLE, no character will have the
164 effect associated with that element.
165 _POSIX_SYNC_IO Synchronous I/O may be performed.
166 _POSIX_ASYNC_IO Asynchronous I/O may be performed.
167 _POSIX_PRIO_IO Prioritized Asynchronous I/O may be performed.
169 Support for the Large File Support interface is not generally available.
170 If it is available the following constants are defined to one.
171 _LFS64_LARGEFILE Low-level I/O supports large files.
172 _LFS64_STDIO Standard I/O supports large files.
175 #include <bits/posix_opt.h>
177 /* Get the environment definitions from Unix98. */
178 #ifdef __USE_UNIX98
179 # include <bits/environments.h>
180 #endif
182 /* Standard file descriptors. */
183 #define STDIN_FILENO 0 /* Standard input. */
184 #define STDOUT_FILENO 1 /* Standard output. */
185 #define STDERR_FILENO 2 /* Standard error output. */
188 /* All functions that are not declared anywhere else. */
190 #include <bits/types.h>
192 #ifndef __ssize_t_defined
193 typedef __ssize_t ssize_t;
194 # define __ssize_t_defined
195 #endif
197 #define __need_size_t
198 #define __need_NULL
199 #include <stddef.h>
201 #if defined __USE_XOPEN || defined __USE_XOPEN2K
202 /* The Single Unix specification says that some more types are
203 available here. */
204 # ifndef __gid_t_defined
205 typedef __gid_t gid_t;
206 # define __gid_t_defined
207 # endif
209 # ifndef __uid_t_defined
210 typedef __uid_t uid_t;
211 # define __uid_t_defined
212 # endif
214 # ifndef __off_t_defined
215 # ifndef __USE_FILE_OFFSET64
216 typedef __off_t off_t;
217 # else
218 typedef __off64_t off_t;
219 # endif
220 # define __off_t_defined
221 # endif
222 # if defined __USE_LARGEFILE64 && !defined __off64_t_defined
223 typedef __off64_t off64_t;
224 # define __off64_t_defined
225 # endif
227 # ifndef __useconds_t_defined
228 typedef __useconds_t useconds_t;
229 # define __useconds_t_defined
230 # endif
232 # ifndef __pid_t_defined
233 typedef __pid_t pid_t;
234 # define __pid_t_defined
235 # endif
236 #endif /* X/Open */
238 #if defined __USE_MISC || defined __USE_XOPEN_EXTENDED
239 # ifndef __intptr_t_defined
240 typedef __intptr_t intptr_t;
241 # define __intptr_t_defined
242 # endif
243 #endif
245 #if defined __USE_BSD || defined __USE_XOPEN
246 # ifndef __socklen_t_defined
247 typedef __socklen_t socklen_t;
248 # define __socklen_t_defined
249 # endif
250 #endif
252 /* Values for the second argument to access.
253 These may be OR'd together. */
254 #define R_OK 4 /* Test for read permission. */
255 #define W_OK 2 /* Test for write permission. */
256 #define X_OK 1 /* Test for execute permission. */
257 #define F_OK 0 /* Test for existence. */
259 /* Test for access to NAME using the real UID and real GID. */
260 extern int access (__const char *__name, int __type) __THROW __nonnull ((1));
262 #ifdef __USE_GNU
263 /* Test for access to NAME using the effective UID and GID
264 (as normal file operations use). */
265 extern int euidaccess (__const char *__name, int __type)
266 __THROW __nonnull ((1));
268 /* An alias for `euidaccess', used by some other systems. */
269 extern int eaccess (__const char *__name, int __type)
270 __THROW __nonnull ((1));
271 #endif
273 #ifdef __USE_ATFILE
274 /* Test for access to FILE relative to the directory FD is open on.
275 If AT_EACCESS is set in FLAG, then use effective IDs like `eaccess',
276 otherwise use real IDs like `access'. */
277 extern int faccessat (int __fd, __const char *__file, int __type, int __flag)
278 __THROW __nonnull ((2)) __wur;
279 #endif /* Use GNU. */
282 /* Values for the WHENCE argument to lseek. */
283 #ifndef _STDIO_H /* <stdio.h> has the same definitions. */
284 # define SEEK_SET 0 /* Seek from beginning of file. */
285 # define SEEK_CUR 1 /* Seek from current position. */
286 # define SEEK_END 2 /* Seek from end of file. */
287 #endif
289 #if defined __USE_BSD && !defined L_SET
290 /* Old BSD names for the same constants; just for compatibility. */
291 # define L_SET SEEK_SET
292 # define L_INCR SEEK_CUR
293 # define L_XTND SEEK_END
294 #endif
297 /* Move FD's file position to OFFSET bytes from the
298 beginning of the file (if WHENCE is SEEK_SET),
299 the current position (if WHENCE is SEEK_CUR),
300 or the end of the file (if WHENCE is SEEK_END).
301 Return the new file position. */
302 #ifndef __USE_FILE_OFFSET64
303 extern __off_t lseek (int __fd, __off_t __offset, int __whence) __THROW;
304 #else
305 # ifdef __REDIRECT_NTH
306 extern __off64_t __REDIRECT_NTH (lseek,
307 (int __fd, __off64_t __offset, int __whence),
308 lseek64);
309 # else
310 # define lseek lseek64
311 # endif
312 #endif
313 #ifdef __USE_LARGEFILE64
314 extern __off64_t lseek64 (int __fd, __off64_t __offset, int __whence)
315 __THROW;
316 #endif
318 /* Close the file descriptor FD.
320 This function is a cancellation point and therefore not marked with
321 __THROW. */
322 extern int close (int __fd);
324 /* Read NBYTES into BUF from FD. Return the
325 number read, -1 for errors or 0 for EOF.
327 This function is a cancellation point and therefore not marked with
328 __THROW. */
329 extern ssize_t read (int __fd, void *__buf, size_t __nbytes) __wur;
331 /* Write N bytes of BUF to FD. Return the number written, or -1.
333 This function is a cancellation point and therefore not marked with
334 __THROW. */
335 extern ssize_t write (int __fd, __const void *__buf, size_t __n) __wur;
337 #ifdef __USE_UNIX98
338 # ifndef __USE_FILE_OFFSET64
339 /* Read NBYTES into BUF from FD at the given position OFFSET without
340 changing the file pointer. Return the number read, -1 for errors
341 or 0 for EOF.
343 This function is a cancellation point and therefore not marked with
344 __THROW. */
345 extern ssize_t pread (int __fd, void *__buf, size_t __nbytes,
346 __off_t __offset) __wur;
348 /* Write N bytes of BUF to FD at the given position OFFSET without
349 changing the file pointer. Return the number written, or -1.
351 This function is a cancellation point and therefore not marked with
352 __THROW. */
353 extern ssize_t pwrite (int __fd, __const void *__buf, size_t __n,
354 __off_t __offset) __wur;
355 # else
356 # ifdef __REDIRECT
357 extern ssize_t __REDIRECT (pread, (int __fd, void *__buf, size_t __nbytes,
358 __off64_t __offset),
359 pread64) __wur;
360 extern ssize_t __REDIRECT (pwrite, (int __fd, __const void *__buf,
361 size_t __nbytes, __off64_t __offset),
362 pwrite64) __wur;
363 # else
364 # define pread pread64
365 # define pwrite pwrite64
366 # endif
367 # endif
369 # ifdef __USE_LARGEFILE64
370 /* Read NBYTES into BUF from FD at the given position OFFSET without
371 changing the file pointer. Return the number read, -1 for errors
372 or 0 for EOF. */
373 extern ssize_t pread64 (int __fd, void *__buf, size_t __nbytes,
374 __off64_t __offset) __wur;
375 /* Write N bytes of BUF to FD at the given position OFFSET without
376 changing the file pointer. Return the number written, or -1. */
377 extern ssize_t pwrite64 (int __fd, __const void *__buf, size_t __n,
378 __off64_t __offset) __wur;
379 # endif
380 #endif
382 /* Create a one-way communication channel (pipe).
383 If successful, two file descriptors are stored in PIPEDES;
384 bytes written on PIPEDES[1] can be read from PIPEDES[0].
385 Returns 0 if successful, -1 if not. */
386 extern int pipe (int __pipedes[2]) __THROW __wur;
388 #ifdef __USE_GNU
389 /* Same as pipe but apply flags passed in FLAGS to the new file
390 descriptors. */
391 extern int pipe2 (int __pipedes[2], int __flags) __THROW __wur;
392 #endif
394 /* Schedule an alarm. In SECONDS seconds, the process will get a SIGALRM.
395 If SECONDS is zero, any currently scheduled alarm will be cancelled.
396 The function returns the number of seconds remaining until the last
397 alarm scheduled would have signaled, or zero if there wasn't one.
398 There is no return value to indicate an error, but you can set `errno'
399 to 0 and check its value after calling `alarm', and this might tell you.
400 The signal may come late due to processor scheduling. */
401 extern unsigned int alarm (unsigned int __seconds) __THROW;
403 /* Make the process sleep for SECONDS seconds, or until a signal arrives
404 and is not ignored. The function returns the number of seconds less
405 than SECONDS which it actually slept (thus zero if it slept the full time).
406 If a signal handler does a `longjmp' or modifies the handling of the
407 SIGALRM signal while inside `sleep' call, the handling of the SIGALRM
408 signal afterwards is undefined. There is no return value to indicate
409 error, but if `sleep' returns SECONDS, it probably didn't work.
411 This function is a cancellation point and therefore not marked with
412 __THROW. */
413 extern unsigned int sleep (unsigned int __seconds);
415 #if defined __USE_BSD || defined __USE_XOPEN_EXTENDED
416 /* Set an alarm to go off (generating a SIGALRM signal) in VALUE
417 microseconds. If INTERVAL is nonzero, when the alarm goes off, the
418 timer is reset to go off every INTERVAL microseconds thereafter.
419 Returns the number of microseconds remaining before the alarm. */
420 extern __useconds_t ualarm (__useconds_t __value, __useconds_t __interval)
421 __THROW;
423 /* Sleep USECONDS microseconds, or until a signal arrives that is not blocked
424 or ignored.
426 This function is a cancellation point and therefore not marked with
427 __THROW. */
428 extern int usleep (__useconds_t __useconds);
429 #endif
432 /* Suspend the process until a signal arrives.
433 This always returns -1 and sets `errno' to EINTR.
435 This function is a cancellation point and therefore not marked with
436 __THROW. */
437 extern int pause (void);
440 /* Change the owner and group of FILE. */
441 extern int chown (__const char *__file, __uid_t __owner, __gid_t __group)
442 __THROW __nonnull ((1)) __wur;
444 #if defined __USE_BSD || defined __USE_XOPEN_EXTENDED
445 /* Change the owner and group of the file that FD is open on. */
446 extern int fchown (int __fd, __uid_t __owner, __gid_t __group) __THROW __wur;
449 /* Change owner and group of FILE, if it is a symbolic
450 link the ownership of the symbolic link is changed. */
451 extern int lchown (__const char *__file, __uid_t __owner, __gid_t __group)
452 __THROW __nonnull ((1)) __wur;
454 #endif /* Use BSD || X/Open Unix. */
456 #ifdef __USE_ATFILE
457 /* Change the owner and group of FILE relative to the directory FD is open
458 on. */
459 extern int fchownat (int __fd, __const char *__file, __uid_t __owner,
460 __gid_t __group, int __flag)
461 __THROW __nonnull ((2)) __wur;
462 #endif /* Use GNU. */
464 /* Change the process's working directory to PATH. */
465 extern int chdir (__const char *__path) __THROW __nonnull ((1)) __wur;
467 #if defined __USE_BSD || defined __USE_XOPEN_EXTENDED
468 /* Change the process's working directory to the one FD is open on. */
469 extern int fchdir (int __fd) __THROW __wur;
470 #endif
472 /* Get the pathname of the current working directory,
473 and put it in SIZE bytes of BUF. Returns NULL if the
474 directory couldn't be determined or SIZE was too small.
475 If successful, returns BUF. In GNU, if BUF is NULL,
476 an array is allocated with `malloc'; the array is SIZE
477 bytes long, unless SIZE == 0, in which case it is as
478 big as necessary. */
479 extern char *getcwd (char *__buf, size_t __size) __THROW __wur;
481 #ifdef __USE_GNU
482 /* Return a malloc'd string containing the current directory name.
483 If the environment variable `PWD' is set, and its value is correct,
484 that value is used. */
485 extern char *get_current_dir_name (void) __THROW;
486 #endif
488 #if defined __USE_BSD || defined __USE_XOPEN_EXTENDED
489 /* Put the absolute pathname of the current working directory in BUF.
490 If successful, return BUF. If not, put an error message in
491 BUF and return NULL. BUF should be at least PATH_MAX bytes long. */
492 extern char *getwd (char *__buf)
493 __THROW __nonnull ((1)) __attribute_deprecated__ __wur;
494 #endif
497 /* Duplicate FD, returning a new file descriptor on the same file. */
498 extern int dup (int __fd) __THROW __wur;
500 /* Duplicate FD to FD2, closing FD2 and making it open on the same file. */
501 extern int dup2 (int __fd, int __fd2) __THROW;
503 #ifdef __USE_GNU
504 /* Duplicate FD to FD2, closing FD2 and making it open on the same
505 file while setting flags according to FLAGS. */
506 extern int dup3 (int __fd, int __fd2, int __flags) __THROW;
507 #endif
509 /* NULL-terminated array of "NAME=VALUE" environment variables. */
510 extern char **__environ;
511 #ifdef __USE_GNU
512 extern char **environ;
513 #endif
516 /* Replace the current process, executing PATH with arguments ARGV and
517 environment ENVP. ARGV and ENVP are terminated by NULL pointers. */
518 extern int execve (__const char *__path, char *__const __argv[],
519 char *__const __envp[]) __THROW __nonnull ((1));
521 #ifdef __USE_XOPEN2K8
522 /* Execute the file FD refers to, overlaying the running program image.
523 ARGV and ENVP are passed to the new program, as for `execve'. */
524 extern int fexecve (int __fd, char *__const __argv[], char *__const __envp[])
525 __THROW;
526 #endif
529 /* Execute PATH with arguments ARGV and environment from `environ'. */
530 extern int execv (__const char *__path, char *__const __argv[])
531 __THROW __nonnull ((1));
533 /* Execute PATH with all arguments after PATH until a NULL pointer,
534 and the argument after that for environment. */
535 extern int execle (__const char *__path, __const char *__arg, ...)
536 __THROW __nonnull ((1));
538 /* Execute PATH with all arguments after PATH until
539 a NULL pointer and environment from `environ'. */
540 extern int execl (__const char *__path, __const char *__arg, ...)
541 __THROW __nonnull ((1));
543 /* Execute FILE, searching in the `PATH' environment variable if it contains
544 no slashes, with arguments ARGV and environment from `environ'. */
545 extern int execvp (__const char *__file, char *__const __argv[])
546 __THROW __nonnull ((1));
548 /* Execute FILE, searching in the `PATH' environment variable if
549 it contains no slashes, with all arguments after FILE until a
550 NULL pointer and environment from `environ'. */
551 extern int execlp (__const char *__file, __const char *__arg, ...)
552 __THROW __nonnull ((1));
554 #ifdef __USE_GNU
555 /* Execute FILE, searching in the `PATH' environment variable if it contains
556 no slashes, with arguments ARGV and environment from `environ'. */
557 extern int execvpe (__const char *__file, char *__const __argv[],
558 char *__const __envp[])
559 __THROW __nonnull ((1));
560 #endif
563 #if defined __USE_MISC || defined __USE_XOPEN
564 /* Add INC to priority of the current process. */
565 extern int nice (int __inc) __THROW __wur;
566 #endif
569 /* Terminate program execution with the low-order 8 bits of STATUS. */
570 extern void _exit (int __status) __attribute__ ((__noreturn__));
573 /* Get the `_PC_*' symbols for the NAME argument to `pathconf' and `fpathconf';
574 the `_SC_*' symbols for the NAME argument to `sysconf';
575 and the `_CS_*' symbols for the NAME argument to `confstr'. */
576 #include <bits/confname.h>
578 /* Get file-specific configuration information about PATH. */
579 extern long int pathconf (__const char *__path, int __name)
580 __THROW __nonnull ((1));
582 /* Get file-specific configuration about descriptor FD. */
583 extern long int fpathconf (int __fd, int __name) __THROW;
585 /* Get the value of the system variable NAME. */
586 extern long int sysconf (int __name) __THROW;
588 #ifdef __USE_POSIX2
589 /* Get the value of the string-valued system variable NAME. */
590 extern size_t confstr (int __name, char *__buf, size_t __len) __THROW;
591 #endif
594 /* Get the process ID of the calling process. */
595 extern __pid_t getpid (void) __THROW;
597 /* Get the process ID of the calling process's parent. */
598 extern __pid_t getppid (void) __THROW;
600 /* Get the process group ID of the calling process.
601 This function is different on old BSD. */
602 #ifndef __FAVOR_BSD
603 extern __pid_t getpgrp (void) __THROW;
604 #else
605 # ifdef __REDIRECT_NTH
606 extern __pid_t __REDIRECT_NTH (getpgrp, (__pid_t __pid), __getpgid);
607 # else
608 # define getpgrp __getpgid
609 # endif
610 #endif
612 /* Get the process group ID of process PID. */
613 extern __pid_t __getpgid (__pid_t __pid) __THROW;
614 #ifdef __USE_XOPEN_EXTENDED
615 extern __pid_t getpgid (__pid_t __pid) __THROW;
616 #endif
619 /* Set the process group ID of the process matching PID to PGID.
620 If PID is zero, the current process's process group ID is set.
621 If PGID is zero, the process ID of the process is used. */
622 extern int setpgid (__pid_t __pid, __pid_t __pgid) __THROW;
624 #if defined __USE_SVID || defined __USE_BSD || defined __USE_XOPEN_EXTENDED
625 /* Both System V and BSD have `setpgrp' functions, but with different
626 calling conventions. The BSD function is the same as POSIX.1 `setpgid'
627 (above). The System V function takes no arguments and puts the calling
628 process in its on group like `setpgid (0, 0)'.
630 New programs should always use `setpgid' instead.
632 The default in GNU is to provide the System V function. The BSD
633 function is available under -D_BSD_SOURCE. */
635 # ifndef __FAVOR_BSD
637 /* Set the process group ID of the calling process to its own PID.
638 This is exactly the same as `setpgid (0, 0)'. */
639 extern int setpgrp (void) __THROW;
641 # else
643 /* Another name for `setpgid' (above). */
644 # ifdef __REDIRECT_NTH
645 extern int __REDIRECT_NTH (setpgrp, (__pid_t __pid, __pid_t __pgrp), setpgid);
646 # else
647 # define setpgrp setpgid
648 # endif
650 # endif /* Favor BSD. */
651 #endif /* Use SVID or BSD. */
653 /* Create a new session with the calling process as its leader.
654 The process group IDs of the session and the calling process
655 are set to the process ID of the calling process, which is returned. */
656 extern __pid_t setsid (void) __THROW;
658 #ifdef __USE_XOPEN_EXTENDED
659 /* Return the session ID of the given process. */
660 extern __pid_t getsid (__pid_t __pid) __THROW;
661 #endif
663 /* Get the real user ID of the calling process. */
664 extern __uid_t getuid (void) __THROW;
666 /* Get the effective user ID of the calling process. */
667 extern __uid_t geteuid (void) __THROW;
669 /* Get the real group ID of the calling process. */
670 extern __gid_t getgid (void) __THROW;
672 /* Get the effective group ID of the calling process. */
673 extern __gid_t getegid (void) __THROW;
675 /* If SIZE is zero, return the number of supplementary groups
676 the calling process is in. Otherwise, fill in the group IDs
677 of its supplementary groups in LIST and return the number written. */
678 extern int getgroups (int __size, __gid_t __list[]) __THROW __wur;
680 #ifdef __USE_GNU
681 /* Return nonzero iff the calling process is in group GID. */
682 extern int group_member (__gid_t __gid) __THROW;
683 #endif
685 /* Set the user ID of the calling process to UID.
686 If the calling process is the super-user, set the real
687 and effective user IDs, and the saved set-user-ID to UID;
688 if not, the effective user ID is set to UID. */
689 extern int setuid (__uid_t __uid) __THROW;
691 #if defined __USE_BSD || defined __USE_XOPEN_EXTENDED
692 /* Set the real user ID of the calling process to RUID,
693 and the effective user ID of the calling process to EUID. */
694 extern int setreuid (__uid_t __ruid, __uid_t __euid) __THROW;
695 #endif
697 #if defined __USE_BSD || defined __USE_XOPEN2K
698 /* Set the effective user ID of the calling process to UID. */
699 extern int seteuid (__uid_t __uid) __THROW;
700 #endif /* Use BSD. */
702 /* Set the group ID of the calling process to GID.
703 If the calling process is the super-user, set the real
704 and effective group IDs, and the saved set-group-ID to GID;
705 if not, the effective group ID is set to GID. */
706 extern int setgid (__gid_t __gid) __THROW;
708 #if defined __USE_BSD || defined __USE_XOPEN_EXTENDED
709 /* Set the real group ID of the calling process to RGID,
710 and the effective group ID of the calling process to EGID. */
711 extern int setregid (__gid_t __rgid, __gid_t __egid) __THROW;
712 #endif
714 #if defined __USE_BSD || defined __USE_XOPEN2K
715 /* Set the effective group ID of the calling process to GID. */
716 extern int setegid (__gid_t __gid) __THROW;
717 #endif /* Use BSD. */
719 #ifdef __USE_GNU
720 /* Fetch the real user ID, effective user ID, and saved-set user ID,
721 of the calling process. */
722 extern int getresuid (__uid_t *__ruid, __uid_t *__euid, __uid_t *__suid)
723 __THROW;
725 /* Fetch the real group ID, effective group ID, and saved-set group ID,
726 of the calling process. */
727 extern int getresgid (__gid_t *__rgid, __gid_t *__egid, __gid_t *__sgid)
728 __THROW;
730 /* Set the real user ID, effective user ID, and saved-set user ID,
731 of the calling process to RUID, EUID, and SUID, respectively. */
732 extern int setresuid (__uid_t __ruid, __uid_t __euid, __uid_t __suid)
733 __THROW;
735 /* Set the real group ID, effective group ID, and saved-set group ID,
736 of the calling process to RGID, EGID, and SGID, respectively. */
737 extern int setresgid (__gid_t __rgid, __gid_t __egid, __gid_t __sgid)
738 __THROW;
739 #endif
742 /* Clone the calling process, creating an exact copy.
743 Return -1 for errors, 0 to the new process,
744 and the process ID of the new process to the old process. */
745 extern __pid_t fork (void) __THROW;
747 #if defined __USE_BSD || defined __USE_XOPEN_EXTENDED
748 /* Clone the calling process, but without copying the whole address space.
749 The calling process is suspended until the new process exits or is
750 replaced by a call to `execve'. Return -1 for errors, 0 to the new process,
751 and the process ID of the new process to the old process. */
752 extern __pid_t vfork (void) __THROW;
753 #endif /* Use BSD. */
756 /* Return the pathname of the terminal FD is open on, or NULL on errors.
757 The returned storage is good only until the next call to this function. */
758 extern char *ttyname (int __fd) __THROW;
760 /* Store at most BUFLEN characters of the pathname of the terminal FD is
761 open on in BUF. Return 0 on success, otherwise an error number. */
762 extern int ttyname_r (int __fd, char *__buf, size_t __buflen)
763 __THROW __nonnull ((2)) __wur;
765 /* Return 1 if FD is a valid descriptor associated
766 with a terminal, zero if not. */
767 extern int isatty (int __fd) __THROW;
769 #if defined __USE_BSD \
770 || (defined __USE_XOPEN_EXTENDED && !defined __USE_UNIX98)
771 /* Return the index into the active-logins file (utmp) for
772 the controlling terminal. */
773 extern int ttyslot (void) __THROW;
774 #endif
777 /* Make a link to FROM named TO. */
778 extern int link (__const char *__from, __const char *__to)
779 __THROW __nonnull ((1, 2)) __wur;
781 #ifdef __USE_ATFILE
782 /* Like link but relative paths in TO and FROM are interpreted relative
783 to FROMFD and TOFD respectively. */
784 extern int linkat (int __fromfd, __const char *__from, int __tofd,
785 __const char *__to, int __flags)
786 __THROW __nonnull ((2, 4)) __wur;
787 #endif
789 #if defined __USE_BSD || defined __USE_XOPEN_EXTENDED || defined __USE_XOPEN2K
790 /* Make a symbolic link to FROM named TO. */
791 extern int symlink (__const char *__from, __const char *__to)
792 __THROW __nonnull ((1, 2)) __wur;
794 /* Read the contents of the symbolic link PATH into no more than
795 LEN bytes of BUF. The contents are not null-terminated.
796 Returns the number of characters read, or -1 for errors. */
797 extern ssize_t readlink (__const char *__restrict __path,
798 char *__restrict __buf, size_t __len)
799 __THROW __nonnull ((1, 2)) __wur;
800 #endif /* Use BSD. */
802 #ifdef __USE_ATFILE
803 /* Like symlink but a relative path in TO is interpreted relative to TOFD. */
804 extern int symlinkat (__const char *__from, int __tofd,
805 __const char *__to) __THROW __nonnull ((1, 3)) __wur;
807 /* Like readlink but a relative PATH is interpreted relative to FD. */
808 extern ssize_t readlinkat (int __fd, __const char *__restrict __path,
809 char *__restrict __buf, size_t __len)
810 __THROW __nonnull ((2, 3)) __wur;
811 #endif
813 /* Remove the link NAME. */
814 extern int unlink (__const char *__name) __THROW __nonnull ((1));
816 #ifdef __USE_ATFILE
817 /* Remove the link NAME relative to FD. */
818 extern int unlinkat (int __fd, __const char *__name, int __flag)
819 __THROW __nonnull ((2));
820 #endif
822 /* Remove the directory PATH. */
823 extern int rmdir (__const char *__path) __THROW __nonnull ((1));
826 /* Return the foreground process group ID of FD. */
827 extern __pid_t tcgetpgrp (int __fd) __THROW;
829 /* Set the foreground process group ID of FD set PGRP_ID. */
830 extern int tcsetpgrp (int __fd, __pid_t __pgrp_id) __THROW;
833 /* Return the login name of the user.
835 This function is a possible cancellation points and therefore not
836 marked with __THROW. */
837 extern char *getlogin (void);
838 #if defined __USE_REENTRANT || defined __USE_POSIX199506
839 /* Return at most NAME_LEN characters of the login name of the user in NAME.
840 If it cannot be determined or some other error occurred, return the error
841 code. Otherwise return 0.
843 This function is a possible cancellation points and therefore not
844 marked with __THROW. */
845 extern int getlogin_r (char *__name, size_t __name_len) __nonnull ((1));
846 #endif
848 #ifdef __USE_BSD
849 /* Set the login name returned by `getlogin'. */
850 extern int setlogin (__const char *__name) __THROW __nonnull ((1));
851 #endif
854 #ifdef __USE_POSIX2
855 /* Get definitions and prototypes for functions to process the
856 arguments in ARGV (ARGC of them, minus the program name) for
857 options given in OPTS. */
858 # define __need_getopt
859 # include <getopt.h>
860 #endif
863 #if defined __USE_BSD || defined __USE_UNIX98
864 /* Put the name of the current host in no more than LEN bytes of NAME.
865 The result is null-terminated if LEN is large enough for the full
866 name and the terminator. */
867 extern int gethostname (char *__name, size_t __len) __THROW __nonnull ((1));
868 #endif
871 #if defined __USE_BSD || (defined __USE_XOPEN && !defined __USE_UNIX98)
872 /* Set the name of the current host to NAME, which is LEN bytes long.
873 This call is restricted to the super-user. */
874 extern int sethostname (__const char *__name, size_t __len)
875 __THROW __nonnull ((1)) __wur;
877 /* Set the current machine's Internet number to ID.
878 This call is restricted to the super-user. */
879 extern int sethostid (long int __id) __THROW __wur;
882 /* Get and set the NIS (aka YP) domain name, if any.
883 Called just like `gethostname' and `sethostname'.
884 The NIS domain name is usually the empty string when not using NIS. */
885 extern int getdomainname (char *__name, size_t __len)
886 __THROW __nonnull ((1)) __wur;
887 extern int setdomainname (__const char *__name, size_t __len)
888 __THROW __nonnull ((1)) __wur;
891 /* Revoke access permissions to all processes currently communicating
892 with the control terminal, and then send a SIGHUP signal to the process
893 group of the control terminal. */
894 extern int vhangup (void) __THROW;
896 /* Revoke the access of all descriptors currently open on FILE. */
897 extern int revoke (__const char *__file) __THROW __nonnull ((1)) __wur;
900 /* Enable statistical profiling, writing samples of the PC into at most
901 SIZE bytes of SAMPLE_BUFFER; every processor clock tick while profiling
902 is enabled, the system examines the user PC and increments
903 SAMPLE_BUFFER[((PC - OFFSET) / 2) * SCALE / 65536]. If SCALE is zero,
904 disable profiling. Returns zero on success, -1 on error. */
905 extern int profil (unsigned short int *__sample_buffer, size_t __size,
906 size_t __offset, unsigned int __scale)
907 __THROW __nonnull ((1));
910 /* Turn accounting on if NAME is an existing file. The system will then write
911 a record for each process as it terminates, to this file. If NAME is NULL,
912 turn accounting off. This call is restricted to the super-user. */
913 extern int acct (__const char *__name) __THROW;
916 /* Successive calls return the shells listed in `/etc/shells'. */
917 extern char *getusershell (void) __THROW;
918 extern void endusershell (void) __THROW; /* Discard cached info. */
919 extern void setusershell (void) __THROW; /* Rewind and re-read the file. */
922 /* Put the program in the background, and dissociate from the controlling
923 terminal. If NOCHDIR is zero, do `chdir ("/")'. If NOCLOSE is zero,
924 redirects stdin, stdout, and stderr to /dev/null. */
925 extern int daemon (int __nochdir, int __noclose) __THROW __wur;
926 #endif /* Use BSD || X/Open. */
929 #if defined __USE_BSD || (defined __USE_XOPEN && !defined __USE_XOPEN2K)
930 /* Make PATH be the root directory (the starting point for absolute paths).
931 This call is restricted to the super-user. */
932 extern int chroot (__const char *__path) __THROW __nonnull ((1)) __wur;
934 /* Prompt with PROMPT and read a string from the terminal without echoing.
935 Uses /dev/tty if possible; otherwise stderr and stdin. */
936 extern char *getpass (__const char *__prompt) __nonnull ((1));
937 #endif /* Use BSD || X/Open. */
940 #if defined __USE_BSD || defined __USE_XOPEN || defined __USE_XOPEN2K
941 /* Make all changes done to FD actually appear on disk.
943 This function is a cancellation point and therefore not marked with
944 __THROW. */
945 extern int fsync (int __fd);
946 #endif /* Use BSD || X/Open || Unix98. */
949 #if defined __USE_BSD || defined __USE_XOPEN_EXTENDED
951 /* Return identifier for the current host. */
952 extern long int gethostid (void);
954 /* Make all changes done to all files actually appear on disk. */
955 extern void sync (void) __THROW;
958 /* Return the number of bytes in a page. This is the system's page size,
959 which is not necessarily the same as the hardware page size. */
960 extern int getpagesize (void) __THROW __attribute__ ((__const__));
963 /* Return the maximum number of file descriptors
964 the current process could possibly have. */
965 extern int getdtablesize (void) __THROW;
968 /* Truncate FILE to LENGTH bytes. */
969 # ifndef __USE_FILE_OFFSET64
970 extern int truncate (__const char *__file, __off_t __length)
971 __THROW __nonnull ((1)) __wur;
972 # else
973 # ifdef __REDIRECT_NTH
974 extern int __REDIRECT_NTH (truncate,
975 (__const char *__file, __off64_t __length),
976 truncate64) __nonnull ((1)) __wur;
977 # else
978 # define truncate truncate64
979 # endif
980 # endif
981 # ifdef __USE_LARGEFILE64
982 extern int truncate64 (__const char *__file, __off64_t __length)
983 __THROW __nonnull ((1)) __wur;
984 # endif
986 #endif /* Use BSD || X/Open Unix. */
988 #if defined __USE_BSD || defined __USE_XOPEN_EXTENDED || defined __USE_XOPEN2K
990 /* Truncate the file FD is open on to LENGTH bytes. */
991 # ifndef __USE_FILE_OFFSET64
992 extern int ftruncate (int __fd, __off_t __length) __THROW __wur;
993 # else
994 # ifdef __REDIRECT_NTH
995 extern int __REDIRECT_NTH (ftruncate, (int __fd, __off64_t __length),
996 ftruncate64) __wur;
997 # else
998 # define ftruncate ftruncate64
999 # endif
1000 # endif
1001 # ifdef __USE_LARGEFILE64
1002 extern int ftruncate64 (int __fd, __off64_t __length) __THROW __wur;
1003 # endif
1005 #endif /* Use BSD || X/Open Unix || POSIX 2003. */
1008 #if defined __USE_MISC || defined __USE_XOPEN_EXTENDED
1010 /* Set the end of accessible data space (aka "the break") to ADDR.
1011 Returns zero on success and -1 for errors (with errno set). */
1012 extern int brk (void *__addr) __THROW __wur;
1014 /* Increase or decrease the end of accessible data space by DELTA bytes.
1015 If successful, returns the address the previous end of data space
1016 (i.e. the beginning of the new space, if DELTA > 0);
1017 returns (void *) -1 for errors (with errno set). */
1018 extern void *sbrk (intptr_t __delta) __THROW;
1019 #endif
1022 #ifdef __USE_MISC
1023 /* Invoke `system call' number SYSNO, passing it the remaining arguments.
1024 This is completely system-dependent, and not often useful.
1026 In Unix, `syscall' sets `errno' for all errors and most calls return -1
1027 for errors; in many systems you cannot pass arguments or get return
1028 values for all system calls (`pipe', `fork', and `getppid' typically
1029 among them).
1031 In Mach, all system calls take normal arguments and always return an
1032 error code (zero for success). */
1033 extern long int syscall (long int __sysno, ...) __THROW;
1035 #endif /* Use misc. */
1038 #if (defined __USE_MISC || defined __USE_XOPEN_EXTENDED) && !defined F_LOCK
1039 /* NOTE: These declarations also appear in <fcntl.h>; be sure to keep both
1040 files consistent. Some systems have them there and some here, and some
1041 software depends on the macros being defined without including both. */
1043 /* `lockf' is a simpler interface to the locking facilities of `fcntl'.
1044 LEN is always relative to the current file position.
1045 The CMD argument is one of the following.
1047 This function is a cancellation point and therefore not marked with
1048 __THROW. */
1050 # define F_ULOCK 0 /* Unlock a previously locked region. */
1051 # define F_LOCK 1 /* Lock a region for exclusive use. */
1052 # define F_TLOCK 2 /* Test and lock a region for exclusive use. */
1053 # define F_TEST 3 /* Test a region for other processes locks. */
1055 # ifndef __USE_FILE_OFFSET64
1056 extern int lockf (int __fd, int __cmd, __off_t __len) __wur;
1057 # else
1058 # ifdef __REDIRECT
1059 extern int __REDIRECT (lockf, (int __fd, int __cmd, __off64_t __len),
1060 lockf64) __wur;
1061 # else
1062 # define lockf lockf64
1063 # endif
1064 # endif
1065 # ifdef __USE_LARGEFILE64
1066 extern int lockf64 (int __fd, int __cmd, __off64_t __len) __wur;
1067 # endif
1068 #endif /* Use misc and F_LOCK not already defined. */
1071 #ifdef __USE_GNU
1073 /* Evaluate EXPRESSION, and repeat as long as it returns -1 with `errno'
1074 set to EINTR. */
1076 # define TEMP_FAILURE_RETRY(expression) \
1077 (__extension__ \
1078 ({ long int __result; \
1079 do __result = (long int) (expression); \
1080 while (__result == -1L && errno == EINTR); \
1081 __result; }))
1082 #endif
1084 #if defined __USE_POSIX199309 || defined __USE_UNIX98
1085 /* Synchronize at least the data part of a file with the underlying
1086 media. */
1087 extern int fdatasync (int __fildes);
1088 #endif /* Use POSIX199309 */
1091 /* XPG4.2 specifies that prototypes for the encryption functions must
1092 be defined here. */
1093 #ifdef __USE_XOPEN
1094 /* Encrypt at most 8 characters from KEY using salt to perturb DES. */
1095 extern char *crypt (__const char *__key, __const char *__salt)
1096 __THROW __nonnull ((1, 2));
1098 /* Encrypt data in BLOCK in place if EDFLAG is zero; otherwise decrypt
1099 block in place. */
1100 extern void encrypt (char *__block, int __edflag) __THROW __nonnull ((1));
1103 /* Swab pairs bytes in the first N bytes of the area pointed to by
1104 FROM and copy the result to TO. The value of TO must not be in the
1105 range [FROM - N + 1, FROM - 1]. If N is odd the first byte in FROM
1106 is without partner. */
1107 extern void swab (__const void *__restrict __from, void *__restrict __to,
1108 ssize_t __n) __THROW __nonnull ((1, 2));
1109 #endif
1112 /* The Single Unix specification demands this prototype to be here.
1113 It is also found in <stdio.h>. */
1114 #ifdef __USE_XOPEN
1115 /* Return the name of the controlling terminal. */
1116 extern char *ctermid (char *__s) __THROW;
1117 #endif
1120 /* Define some macros helping to catch buffer overflows. */
1121 #if __USE_FORTIFY_LEVEL > 0 && defined __extern_always_inline
1122 # include <bits/unistd.h>
1123 #endif
1125 __END_DECLS
1127 #endif /* unistd.h */