Move internal interfaces to include/unistd.h.
[kopensolaris-gnu/glibc.git] / posix / unistd.h
1 /* Copyright (C) 1991,92,93,94,95,96,97,98 Free Software Foundation, Inc.
2    This file is part of the GNU C Library.
3
4    The GNU C Library is free software; you can redistribute it and/or
5    modify it under the terms of the GNU Library General Public License as
6    published by the Free Software Foundation; either version 2 of the
7    License, or (at your option) any later version.
8
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    Library General Public License for more details.
13
14    You should have received a copy of the GNU Library General Public
15    License along with the GNU C Library; see the file COPYING.LIB.  If not,
16    write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17    Boston, MA 02111-1307, USA.  */
18
19 /*
20  *      POSIX Standard: 2.10 Symbolic Constants         <unistd.h>
21  */
22
23 #ifndef _UNISTD_H
24 #define _UNISTD_H       1
25
26 #include <features.h>
27
28 __BEGIN_DECLS
29
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'.  */
32
33 /* POSIX Standard approved as ISO/IEC 9945-1 as of August, 1988 and
34    extended by POSIX-1b (aka POSIX-4) and POSIX-1c (aka POSIX threads).  */
35 #define _POSIX_VERSION  199506L
36
37 /* These are not #ifdef __USE_POSIX2 because they are
38    in the theoretically application-owned namespace.  */
39
40 /* POSIX Standard approved as ISO/IEC 9945-2 as of December, 1993.  */
41 #define _POSIX2_C_VERSION       199209L
42
43 /* The utilities on GNU systems also correspond to this version.  */
44 #define _POSIX2_VERSION 199209L
45
46 /* If defined, the implementation supports the
47    C Language Bindings Option.  */
48 #define _POSIX2_C_BIND  1
49
50 /* If defined, the implementation supports the
51    C Language Development Utilities Option.  */
52 #define _POSIX2_C_DEV   1
53
54 /* If defined, the implementation supports the
55    Software Development Utilities Option.  */
56 #define _POSIX2_SW_DEV  1
57
58 /* If defined, the implementation supports the
59    creation of locales with the localedef utility.  */
60 #define _POSIX2_LOCALEDEF       1
61
62 /* X/Open version number to which the library conforms.  It is selectable.  */
63 #ifdef __USE_UNIX98
64 # define _XOPEN_VERSION 500
65 #else
66 # define _XOPEN_VERSION 4
67 #endif
68
69 /* Commands and utilities from XPG4 are available.  */
70 #define _XOPEN_XCU_VERSION      4
71
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
76
77 /* The X/Open Unix extensions are available.  */
78 #define _XOPEN_UNIX     1
79
80 /* Encryption is present.  */
81 #define _XOPEN_CRYPT    1
82
83 /* The enhanced internationalization capabilities according to XPG4.2
84    are present.  */
85 #define _XOPEN_ENH_I18N 1
86
87 /* The legacy interfaces are also available.  */
88 #define _XOPEN_LEGACY   1
89
90
91 /* Get values of POSIX options:
92
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'.
96
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'.
134
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.
138
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.
149
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'.
154
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.
168
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.
173    */
174
175 #include <bits/posix_opt.h>
176
177 /* Get the environment definitions from Unix98.  */
178 #ifdef __USE_UNIX98
179 # include <bits/environments.h>
180 #endif
181
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.  */
186
187
188 /* All functions that are not declared anywhere else.  */
189
190 #include <bits/types.h>
191
192 #ifndef ssize_t
193 typedef __ssize_t ssize_t;
194 # define ssize_t ssize_t
195 #endif
196
197 #define __need_size_t
198 #define __need_NULL
199 #include <stddef.h>
200
201 #ifdef __USE_XOPEN
202 /* The Single Unix specification says that some more types are
203    available here.  */
204 # ifndef gid_t
205 typedef __gid_t gid_t;
206 #  define gid_t gid_t
207 # endif
208
209 # ifndef uid_t
210 typedef __uid_t uid_t;
211 #  define uid_t uid_t
212 # endif
213
214 # ifndef off_t
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 off_t
221 # endif
222 # if defined __USE_LARGEFILE64 && !defined off64_t
223 typedef __off64_t off64_t;
224 #  define off64_t off64_t
225 # endif
226
227 # ifndef pid_t
228 typedef __pid_t pid_t;
229 #  define pid_t pid_t
230 # endif
231 #endif  /* X/Open */
232
233 #ifdef __USE_UNIX98
234 # ifndef intptr_t
235 typedef __intptr_t intptr_t;
236 #  define intptr_t intptr_t
237 # endif
238 #endif  /* Unix98 */
239
240 /* Values for the second argument to access.
241    These may be OR'd together.  */
242 #define R_OK    4               /* Test for read permission.  */
243 #define W_OK    2               /* Test for write permission.  */
244 #define X_OK    1               /* Test for execute permission.  */
245 #define F_OK    0               /* Test for existence.  */
246
247 /* Test for access to NAME using the real UID and real GID.  */
248 extern int access __P ((__const char *__name, int __type));
249
250 #ifdef __USE_GNU
251 /* Test for access to NAME using the effective UID and GID
252    (as normal file operations use).  */
253 extern int euidaccess __P ((__const char *__name, int __type));
254 #endif
255
256
257 /* Values for the WHENCE argument to lseek.  */
258 #ifndef _STDIO_H                /* <stdio.h> has the same definitions.  */
259 # define SEEK_SET       0       /* Seek from beginning of file.  */
260 # define SEEK_CUR       1       /* Seek from current position.  */
261 # define SEEK_END       2       /* Seek from end of file.  */
262 #endif
263
264 #if defined __USE_BSD && !defined L_SET
265 /* Old BSD names for the same constants; just for compatibility.  */
266 # define L_SET          SEEK_SET
267 # define L_INCR         SEEK_CUR
268 # define L_XTND         SEEK_END
269 #endif
270
271
272 /* Move FD's file position to OFFSET bytes from the
273    beginning of the file (if WHENCE is SEEK_SET),
274    the current position (if WHENCE is SEEK_CUR),
275    or the end of the file (if WHENCE is SEEK_END).
276    Return the new file position.  */
277 extern __off_t __lseek __P ((int __fd, __off_t __offset, int __whence));
278 #ifndef __USE_FILE_OFFSET64
279 extern __off_t lseek __P ((int __fd, __off_t __offset, int __whence));
280 #else
281 # ifdef __REDIRECT
282 extern __off64_t __REDIRECT (lseek,
283                              __P ((int __fd, __off64_t __offset,
284                                    int __whence)),
285                              lseek64);
286 # else
287 #  define lseek lseek64
288 # endif
289 #endif
290 #ifdef __USE_LARGEFILE64
291 extern __off64_t lseek64 __P ((int __fd, __off64_t __offset, int __whence));
292 #endif
293
294 /* Close the file descriptor FD.  */
295 extern int __close __P ((int __fd));
296 extern int close __P ((int __fd));
297
298 /* Read NBYTES into BUF from FD.  Return the
299    number read, -1 for errors or 0 for EOF.  */
300 extern ssize_t __read __P ((int __fd, __ptr_t __buf, size_t __nbytes));
301 extern ssize_t read __P ((int __fd, __ptr_t __buf, size_t __nbytes));
302
303 /* Write N bytes of BUF to FD.  Return the number written, or -1.  */
304 extern ssize_t __write __P ((int __fd, __const __ptr_t __buf, size_t __n));
305 extern ssize_t write __P ((int __fd, __const __ptr_t __buf, size_t __n));
306
307 #ifdef __USE_UNIX98
308 /* Read NBYTES into BUF from FD at the given position OFFSET without
309    changing the file pointer.  Return the number read, -1 for errors
310    or 0 for EOF.  */
311 extern ssize_t __pread64 __P ((int __fd, __ptr_t __buf, size_t __nbytes,
312                                __off64_t __offset));
313 /* Write N bytes of BUF to FD at the given position OFFSET without
314    changing the file pointer.  Return the number written, or -1.  */
315 extern ssize_t __pwrite64 __P ((int __fd, __const __ptr_t __buf, size_t __n,
316                                 __off64_t __offset));
317
318 # ifndef __USE_FILE_OFFSET64
319 extern ssize_t pread __P ((int __fd, __ptr_t __buf, size_t __nbytes,
320                            __off_t __offset));
321 extern ssize_t pwrite __P ((int __fd, __const __ptr_t __buf, size_t __n,
322                             __off_t __offset));
323 # else
324 #  ifdef __REDIRECT
325 extern ssize_t __REDIRECT (pread, __P ((int __fd, __ptr_t __buf,
326                                         size_t __nbytes,__off64_t __offset)),
327                            pread64);
328 extern ssize_t __REDIRECT (pwrite, __P ((int __fd, __const __ptr_t __buf,
329                                          size_t __nbytes, __off64_t __offset)),
330                         pwrite64);
331 #  else
332 #   define pread pread64
333 #   define pwrite pwrite64
334 #  endif
335 # endif
336
337 # ifdef __USE_LARGEFILE64
338 extern ssize_t pread64 __P ((int __fd, __ptr_t __buf, size_t __nbytes,
339                              __off64_t __offset));
340 extern ssize_t pwrite64 __P ((int __fd, __const __ptr_t __buf, size_t __n,
341                               __off64_t __offset));
342 # endif
343 #endif
344
345 /* Create a one-way communication channel (pipe).
346    If successful, two file descriptors are stored in PIPEDES;
347    bytes written on PIPEDES[1] can be read from PIPEDES[0].
348    Returns 0 if successful, -1 if not.  */
349 extern int pipe __P ((int __pipedes[2]));
350
351 /* Schedule an alarm.  In SECONDS seconds, the process will get a SIGALRM.
352    If SECONDS is zero, any currently scheduled alarm will be cancelled.
353    The function returns the number of seconds remaining until the last
354    alarm scheduled would have signaled, or zero if there wasn't one.
355    There is no return value to indicate an error, but you can set `errno'
356    to 0 and check its value after calling `alarm', and this might tell you.
357    The signal may come late due to processor scheduling.  */
358 extern unsigned int alarm __P ((unsigned int __seconds));
359
360 /* Make the process sleep for SECONDS seconds, or until a signal arrives
361    and is not ignored.  The function returns the number of seconds less
362    than SECONDS which it actually slept (thus zero if it slept the full time).
363    If a signal handler does a `longjmp' or modifies the handling of the
364    SIGALRM signal while inside `sleep' call, the handling of the SIGALRM
365    signal afterwards is undefined.  There is no return value to indicate
366    error, but if `sleep' returns SECONDS, it probably didn't work.  */
367 extern unsigned int sleep __P ((unsigned int __seconds));
368
369 #if defined __USE_BSD || defined __USE_XOPEN_EXTENDED
370 /* Set an alarm to go off (generating a SIGALRM signal) in VALUE
371    microseconds.  If INTERVAL is nonzero, when the alarm goes off, the
372    timer is reset to go off every INTERVAL microseconds thereafter.
373    Returns the number of microseconds remaining before the alarm.  */
374 extern unsigned int ualarm __P ((unsigned int __value,
375                                  unsigned int __interval));
376
377 /* Sleep USECONDS microseconds, or until a signal arrives that is not blocked
378    or ignored.  */
379 extern void usleep __P ((unsigned int __useconds));
380 #endif
381
382
383 /* Suspend the process until a signal arrives.
384    This always returns -1 and sets `errno' to EINTR.  */
385 extern int pause __P ((void));
386
387
388 /* Change the owner and group of FILE.  */
389 extern int chown __P ((__const char *__file, __uid_t __owner,
390                        __gid_t __group));
391
392 #if defined __USE_BSD || defined __USE_XOPEN_EXTENDED
393 /* Change the owner and group of the file that FD is open on.  */
394 extern int fchown __P ((int __fd, __uid_t __owner, __gid_t __group));
395
396
397 /* Change owner and group of FILE, if it is a symbolic
398    link the ownership of the symbolic link is changed.  */
399 extern int lchown __P ((__const char *__file, __uid_t __owner,
400                         __gid_t __group));
401
402 #endif /* Use BSD || X/Open Unix.  */
403
404 /* Change the process's working directory to PATH.  */
405 extern int chdir __P ((__const char *__path));
406
407 #if defined __USE_BSD || defined __USE_XOPEN_EXTENDED
408 /* Change the process's working directory to the one FD is open on.  */
409 extern int fchdir __P ((int __fd));
410 #endif
411
412 /* Get the pathname of the current working directory,
413    and put it in SIZE bytes of BUF.  Returns NULL if the
414    directory couldn't be determined or SIZE was too small.
415    If successful, returns BUF.  In GNU, if BUF is NULL,
416    an array is allocated with `malloc'; the array is SIZE
417    bytes long, unless SIZE == 0, in which case it is as
418    big as necessary.  */
419 extern char *getcwd __P ((char *__buf, size_t __size));
420
421 #ifdef  __USE_GNU
422 /* Return a malloc'd string containing the current directory name.
423    If the environment variable `PWD' is set, and its value is correct,
424    that value is used.  */
425 extern char *get_current_dir_name __P ((void));
426 #endif
427
428 #if defined __USE_BSD || defined __USE_XOPEN_EXTENDED
429 /* Put the absolute pathname of the current working directory in BUF.
430    If successful, return BUF.  If not, put an error message in
431    BUF and return NULL.  BUF should be at least PATH_MAX bytes long.  */
432 extern char *getwd __P ((char *__buf));
433 #endif
434
435
436 /* Duplicate FD, returning a new file descriptor on the same file.  */
437 extern int dup __P ((int __fd));
438
439 /* Duplicate FD to FD2, closing FD2 and making it open on the same file.  */
440 extern int dup2 __P ((int __fd, int __fd2));
441
442 /* NULL-terminated array of "NAME=VALUE" environment variables.  */
443 extern char **__environ;
444 #ifdef __USE_GNU
445 extern char **environ;
446 #endif
447
448
449 /* Replace the current process, executing PATH with arguments ARGV and
450    environment ENVP.  ARGV and ENVP are terminated by NULL pointers.  */
451 extern int execve __P ((__const char *__path, char *__const __argv[],
452                         char *__const __envp[]));
453
454 #ifdef __USE_GNU
455 /* Execute the file FD refers to, overlaying the running program image.
456    ARGV and ENVP are passed to the new program, as for `execve'.  */
457 extern int fexecve __P ((int __fd,
458                          char *__const __argv[], char *__const __envp[]));
459
460 #endif
461
462
463 /* Execute PATH with arguments ARGV and environment from `environ'.  */
464 extern int execv __P ((__const char *__path, char *__const __argv[]));
465
466 /* Execute PATH with all arguments after PATH until a NULL pointer,
467    and the argument after that for environment.  */
468 extern int execle __P ((__const char *__path, __const char *__arg, ...));
469
470 /* Execute PATH with all arguments after PATH until
471    a NULL pointer and environment from `environ'.  */
472 extern int execl __P ((__const char *__path, __const char *__arg, ...));
473
474 /* Execute FILE, searching in the `PATH' environment variable if it contains
475    no slashes, with arguments ARGV and environment from `environ'.  */
476 extern int execvp __P ((__const char *__file, char *__const __argv[]));
477
478 /* Execute FILE, searching in the `PATH' environment variable if
479    it contains no slashes, with all arguments after FILE until a
480    NULL pointer and environment from `environ'.  */
481 extern int execlp __P ((__const char *__file, __const char *__arg, ...));
482
483
484 #if defined __USE_MISC || defined __USE_XOPEN
485 /* Add INC to priority of the current process.  */
486 extern int nice __P ((int __inc));
487 #endif
488
489
490 /* Terminate program execution with the low-order 8 bits of STATUS.  */
491 extern void _exit __P ((int __status)) __attribute__ ((__noreturn__));
492
493
494 /* Get the `_PC_*' symbols for the NAME argument to `pathconf' and `fpathconf';
495    the `_SC_*' symbols for the NAME argument to `sysconf';
496    and the `_CS_*' symbols for the NAME argument to `confstr'.  */
497 #include <bits/confname.h>
498
499 /* Get file-specific configuration information about PATH.  */
500 extern long int pathconf __P ((__const char *__path, int __name));
501
502 /* Get file-specific configuration about descriptor FD.  */
503 extern long int fpathconf __P ((int __fd, int __name));
504
505 /* Get the value of the system variable NAME.  */
506 extern long int sysconf __P ((int __name));
507
508 #ifdef  __USE_POSIX2
509 /* Get the value of the string-valued system variable NAME.  */
510 extern size_t confstr __P ((int __name, char *__buf, size_t __len));
511 #endif
512
513
514 /* Get the process ID of the calling process.  */
515 extern __pid_t __getpid __P ((void));
516 extern __pid_t getpid __P ((void));
517
518 /* Get the process ID of the calling process's parent.  */
519 extern __pid_t getppid __P ((void));
520
521 /* Get the process group ID of the calling process.
522    This function is different on old BSD. */
523 #ifndef __FAVOR_BSD
524 extern __pid_t getpgrp __P ((void));
525 #else
526 # ifdef __REDIRECT
527 extern __pid_t __REDIRECT (getpgrp, __P ((__pid_t __pid)), __getpgid);
528 # else
529 #  define getpgrp __getpgid
530 # endif
531 #endif
532
533 /* Get the process group ID of process PID.  */
534 extern __pid_t __getpgid __P ((__pid_t __pid));
535 #ifdef __USE_XOPEN_EXTENDED
536 extern __pid_t getpgid __P ((__pid_t __pid));
537 #endif
538
539
540 /* Set the process group ID of the process matching PID to PGID.
541    If PID is zero, the current process's process group ID is set.
542    If PGID is zero, the process ID of the process is used.  */
543 extern int __setpgid __P ((__pid_t __pid, __pid_t __pgid));
544 extern int setpgid __P ((__pid_t __pid, __pid_t __pgid));
545
546 #if defined __USE_SVID || defined __USE_BSD || defined __USE_XOPEN_EXTENDED
547 /* Both System V and BSD have `setpgrp' functions, but with different
548    calling conventions.  The BSD function is the same as POSIX.1 `setpgid'
549    (above).  The System V function takes no arguments and puts the calling
550    process in its on group like `setpgid (0, 0)'.
551
552    New programs should always use `setpgid' instead.
553
554    The default in GNU is to provide the System V function.  The BSD
555    function is available under -D_BSD_SOURCE.  */
556
557 # ifndef __FAVOR_BSD
558
559 /* Set the process group ID of the calling process to its own PID.
560    This is exactly the same as `setpgid (0, 0)'.  */
561 extern int setpgrp __P ((void));
562
563 # else
564
565 /* Another name for `setpgid' (above).  */
566 #  ifdef __REDIRECT
567 extern int __REDIRECT (setpgrp, __P ((__pid_t __pid, __pid_t __pgrp)),
568                        setpgid);
569 #  else
570 #   define setpgrp setpgid
571 #  endif
572
573 # endif /* Favor BSD.  */
574 #endif  /* Use SVID or BSD.  */
575
576 /* Create a new session with the calling process as its leader.
577    The process group IDs of the session and the calling process
578    are set to the process ID of the calling process, which is returned.  */
579 extern __pid_t setsid __P ((void));
580
581 #ifdef __USE_XOPEN_EXTENDED
582 /* Return the session ID of the given process.  */
583 extern __pid_t getsid __P ((__pid_t __pid));
584 #endif
585
586 /* Get the real user ID of the calling process.  */
587 extern __uid_t getuid __P ((void));
588
589 /* Get the effective user ID of the calling process.  */
590 extern __uid_t geteuid __P ((void));
591
592 /* Get the real group ID of the calling process.  */
593 extern __gid_t getgid __P ((void));
594
595 /* Get the effective group ID of the calling process.  */
596 extern __gid_t getegid __P ((void));
597
598 /* If SIZE is zero, return the number of supplementary groups
599    the calling process is in.  Otherwise, fill in the group IDs
600    of its supplementary groups in LIST and return the number written.  */
601 extern int getgroups __P ((int __size, __gid_t __list[]));
602
603 #ifdef  __USE_GNU
604 /* Return nonzero iff the calling process is in group GID.  */
605 extern int group_member __P ((__gid_t __gid));
606 #endif
607
608 /* Set the user ID of the calling process to UID.
609    If the calling process is the super-user, set the real
610    and effective user IDs, and the saved set-user-ID to UID;
611    if not, the effective user ID is set to UID.  */
612 extern int setuid __P ((__uid_t __uid));
613
614 #if defined __USE_BSD || defined __USE_XOPEN_EXTENDED
615 /* Set the real user ID of the calling process to RUID,
616    and the effective user ID of the calling process to EUID.  */
617 extern int setreuid __P ((__uid_t __ruid, __uid_t __euid));
618 #endif
619
620 #ifdef  __USE_BSD
621 /* Set the effective user ID of the calling process to UID.  */
622 extern int seteuid __P ((__uid_t __uid));
623 #endif /* Use BSD.  */
624
625 /* Set the group ID of the calling process to GID.
626    If the calling process is the super-user, set the real
627    and effective group IDs, and the saved set-group-ID to GID;
628    if not, the effective group ID is set to GID.  */
629 extern int setgid __P ((__gid_t __gid));
630
631 #if defined __USE_BSD || defined __USE_XOPEN_EXTENDED
632 /* Set the real group ID of the calling process to RGID,
633    and the effective group ID of the calling process to EGID.  */
634 extern int setregid __P ((__gid_t __rgid, __gid_t __egid));
635 #endif
636
637 #ifdef __USE_BSD
638 /* Set the effective group ID of the calling process to GID.  */
639 extern int setegid __P ((__gid_t __gid));
640 #endif /* Use BSD.  */
641
642
643 /* Clone the calling process, creating an exact copy.
644    Return -1 for errors, 0 to the new process,
645    and the process ID of the new process to the old process.  */
646 extern __pid_t __fork __P ((void));
647 extern __pid_t fork __P ((void));
648
649 #if defined __USE_BSD || defined __USE_XOPEN_EXTENDED
650 /* Clone the calling process, but without copying the whole address space.
651    The calling process is suspended until the new process exits or is
652    replaced by a call to `execve'.  Return -1 for errors, 0 to the new process,
653    and the process ID of the new process to the old process.  */
654 extern __pid_t vfork __P ((void));
655 #endif /* Use BSD. */
656
657
658 /* Return the pathname of the terminal FD is open on, or NULL on errors.
659    The returned storage is good only until the next call to this function.  */
660 extern char *ttyname __P ((int __fd));
661
662 /* Store at most BUFLEN characters of the pathname of the terminal FD is
663    open on in BUF.  Return 0 on success, otherwise an error number.  */
664 extern int ttyname_r __P ((int __fd, char *__buf, size_t __buflen));
665
666 /* Return 1 if FD is a valid descriptor associated
667    with a terminal, zero if not.  */
668 extern int isatty __P ((int __fd));
669
670 #if defined __USE_BSD || defined __USE_XOPEN_EXTENDED
671 /* Return the index into the active-logins file (utmp) for
672    the controlling terminal.  */
673 extern int ttyslot __P ((void));
674 #endif
675
676
677 /* Make a link to FROM named TO.  */
678 extern int link __P ((__const char *__from, __const char *__to));
679
680 #if defined __USE_BSD || defined __USE_XOPEN_EXTENDED
681 /* Make a symbolic link to FROM named TO.  */
682 extern int symlink __P ((__const char *__from, __const char *__to));
683
684 /* Read the contents of the symbolic link PATH into no more than
685    LEN bytes of BUF.  The contents are not null-terminated.
686    Returns the number of characters read, or -1 for errors.  */
687 extern int readlink __P ((__const char *__path, char *__buf, size_t __len));
688 #endif /* Use BSD.  */
689
690 /* Remove the link NAME.  */
691 extern int unlink __P ((__const char *__name));
692
693 /* Remove the directory PATH.  */
694 extern int rmdir __P ((__const char *__path));
695
696
697 /* Return the foreground process group ID of FD.  */
698 extern __pid_t tcgetpgrp __P ((int __fd));
699
700 /* Set the foreground process group ID of FD set PGRP_ID.  */
701 extern int tcsetpgrp __P ((int __fd, __pid_t __pgrp_id));
702
703
704 /* Return the login name of the user.  */
705 extern char *getlogin __P ((void));
706 #ifdef __USE_REENTRANT
707 /* Return at most NAME_LEN characters of the login name of the user in NAME.
708    If it cannot be determined or some other error occurred, return the error
709    code.  Otherwise return 0.  */
710 extern int getlogin_r __P ((char *__name, size_t __name_len));
711 #endif
712
713 #ifdef  __USE_BSD
714 /* Set the login name returned by `getlogin'.  */
715 extern int setlogin __P ((__const char *__name));
716 #endif
717
718
719 #ifdef  __USE_POSIX2
720 /* Get definitions and prototypes for functions to process the
721    arguments in ARGV (ARGC of them, minus the program name) for
722    options given in OPTS.  */
723 # define __need_getopt
724 # include <getopt.h>
725 #endif
726
727
728 #if defined __USE_BSD || defined __USE_XOPEN
729
730 /* Put the name of the current host in no more than LEN bytes of NAME.
731    The result is null-terminated if LEN is large enough for the full
732    name and the terminator.  */
733 extern int gethostname __P ((char *__name, size_t __len));
734
735 /* Set the name of the current host to NAME, which is LEN bytes long.
736    This call is restricted to the super-user.  */
737 extern int sethostname __P ((__const char *__name, size_t __len));
738
739 /* Set the current machine's Internet number to ID.
740    This call is restricted to the super-user.  */
741 extern int sethostid __P ((long int __id));
742
743
744 /* Get and set the NIS (aka YP) domain name, if any.
745    Called just like `gethostname' and `sethostname'.
746    The NIS domain name is usually the empty string when not using NIS.  */
747 extern int getdomainname __P ((char *__name, size_t __len));
748 extern int setdomainname __P ((__const char *__name, size_t __len));
749
750
751 /* Make all changes done to FD actually appear on disk.  */
752 extern int fsync __P ((int __fd));
753
754
755 /* Revoke access permissions to all processes currently communicating
756    with the control terminal, and then send a SIGHUP signal to the process
757    group of the control terminal.  */
758 extern int vhangup __P ((void));
759
760 /* Revoke the access of all descriptors currently open on FILE.  */
761 extern int revoke __P ((__const char *__file));
762
763
764 /* Enable statistical profiling, writing samples of the PC into at most
765    SIZE bytes of SAMPLE_BUFFER; every processor clock tick while profiling
766    is enabled, the system examines the user PC and increments
767    SAMPLE_BUFFER[((PC - OFFSET) / 2) * SCALE / 65536].  If SCALE is zero,
768    disable profiling.  Returns zero on success, -1 on error.  */
769 extern int profil __P ((unsigned short int *__sample_buffer, size_t __size,
770                         size_t __offset, unsigned int __scale));
771
772
773 /* Turn accounting on if NAME is an existing file.  The system will then write
774    a record for each process as it terminates, to this file.  If NAME is NULL,
775    turn accounting off.  This call is restricted to the super-user.  */
776 extern int acct __P ((__const char *__name));
777
778 /* Make PATH be the root directory (the starting point for absolute paths).
779    This call is restricted to the super-user.  */
780 extern int chroot __P ((__const char *__path));
781
782
783 /* Successive calls return the shells listed in `/etc/shells'.  */
784 extern char *getusershell __P ((void));
785 extern void endusershell __P ((void)); /* Discard cached info.  */
786 extern void setusershell __P ((void)); /* Rewind and re-read the file.  */
787
788
789 /* Prompt with PROMPT and read a string from the terminal without echoing.
790    Uses /dev/tty if possible; otherwise stderr and stdin.  */
791 extern char *getpass __P ((__const char *__prompt));
792
793 /* Put the program in the background, and dissociate from the controlling
794    terminal.  If NOCHDIR is zero, do `chdir ("/")'.  If NOCLOSE is zero,
795    redirects stdin, stdout, and stderr to /dev/null.  */
796 extern int daemon __P ((int __nochdir, int __noclose));
797
798 #endif /* Use BSD || X/Open.  */
799
800
801 #if defined __USE_BSD || defined __USE_XOPEN_EXTENDED
802
803 /* Return the current machine's Internet number.  */
804 extern long int gethostid __P ((void));
805
806 /* Make all changes done to all files actually appear on disk.  */
807 extern int sync __P ((void));
808
809
810 /* Return the number of bytes in a page.  This is the system's page size,
811    which is not necessarily the same as the hardware page size.  */
812 extern int __getpagesize __P ((void));
813 extern int getpagesize __P ((void));
814
815
816 /* Truncate FILE to LENGTH bytes.  */
817 #ifndef __USE_FILE_OFFSET64
818 extern int truncate __P ((__const char *__file, __off_t __length));
819 #else
820 # ifdef __REDIRECT
821 extern int __REDIRECT (truncate,
822                        __P ((__const char *__file, __off64_t __length)),
823                        truncate64);
824 # else
825 #  define truncate truncate64
826 # endif
827 #endif
828 #ifdef __USE_LARGEFILE64
829 extern int truncate64 __P ((__const char *__file, __off64_t __length));
830 #endif
831
832 /* Truncate the file FD is open on to LENGTH bytes.  */
833 extern int __ftruncate __P ((int __fd, __off_t __length));
834 #ifndef __USE_FILE_OFFSET64
835 extern int ftruncate __P ((int __fd, __off_t __length));
836 #else
837 # ifdef __REDIRECT
838 extern int __REDIRECT (ftruncate, __P ((int __fd, __off64_t __length)),
839                        ftruncate64);
840 # else
841 #  define ftruncate ftruncate64
842 # endif
843 #endif
844 #ifdef __USE_LARGEFILE64
845 extern int ftruncate64 __P ((int __fd, __off64_t __length));
846 #endif
847
848
849 /* Return the maximum number of file descriptors
850    the current process could possibly have.  */
851 extern int getdtablesize __P ((void));
852
853 #endif /* Use BSD || X/Open Unix.  */
854
855
856 #if defined __USE_MISC || defined __USE_XOPEN_EXTENDED
857
858 /* Set the end of accessible data space (aka "the break") to ADDR.
859    Returns zero on success and -1 for errors (with errno set).  */
860 extern int brk __P ((__ptr_t __addr));
861
862 # define __need_ptrdiff_t
863 # include <stddef.h>
864
865 /* Increase or decrease the end of accessible data space by DELTA bytes.
866    If successful, returns the address the previous end of data space
867    (i.e. the beginning of the new space, if DELTA > 0);
868    returns (void *) -1 for errors (with errno set).  */
869 extern __ptr_t __sbrk __P ((ptrdiff_t __delta));
870 extern __ptr_t sbrk __P ((ptrdiff_t __delta));
871 #endif
872
873
874 #ifdef __USE_MISC
875 /* Invoke `system call' number SYSNO, passing it the remaining arguments.
876    This is completely system-dependent, and not often useful.
877
878    In Unix, `syscall' sets `errno' for all errors and most calls return -1
879    for errors; in many systems you cannot pass arguments or get return
880    values for all system calls (`pipe', `fork', and `getppid' typically
881    among them).
882
883    In Mach, all system calls take normal arguments and always return an
884    error code (zero for success).  */
885 extern long int syscall __P ((long int __sysno, ...));
886
887 #endif  /* Use misc.  */
888
889
890 #if (defined __USE_MISC || defined __USE_XOPEN_EXTENDED) && !defined F_LOCK
891 /* NOTE: These declarations also appear in <fcntl.h>; be sure to keep both
892    files consistent.  Some systems have them there and some here, and some
893    software depends on the macros being defined without including both.  */
894
895 /* `lockf' is a simpler interface to the locking facilities of `fcntl'.
896    LEN is always relative to the current file position.
897    The CMD argument is one of the following.  */
898
899 # define F_ULOCK 0      /* Unlock a previously locked region.  */
900 # define F_LOCK  1      /* Lock a region for exclusive use.  */
901 # define F_TLOCK 2      /* Test and lock a region for exclusive use.  */
902 # define F_TEST  3      /* Test a region for other processes locks.  */
903
904 # ifndef __USE_FILE_OFFSET64
905 extern int lockf __P ((int __fd, int __cmd, __off_t __len));
906 # else
907 #  ifdef __REDIRECT
908 extern int __REDIRECT (lockf, __P ((int __fd, int __cmd, __off64_t __len)),
909                        lockf64);
910 #  else
911 #   define lockf lockf64
912 #  endif
913 # endif
914 # ifdef __USE_LARGEFILE64
915 extern int lockf64 __P ((int __fd, int __cmd, __off64_t __len));
916 # endif
917 #endif /* Use misc and F_LOCK not already defined.  */
918
919
920 #ifdef __USE_GNU
921
922 /* Evaluate EXPRESSION, and repeat as long as it returns -1 with `errno'
923    set to EINTR.  */
924
925 # define TEMP_FAILURE_RETRY(expression) \
926   (__extension__                                                              \
927     ({ long int __result;                                                     \
928        do __result = (long int) (expression);                                 \
929        while (__result == -1L && errno == EINTR);                             \
930        __result; }))                                                          \
931
932
933 /* This variable is set nonzero at startup if the process's effective
934    IDs differ from its real IDs, or it is otherwise indicated that
935    extra security should be used.  When this is set the dynamic linker
936    and some functions contained in the C library ignore various
937    environment variables that normally affect them.  */
938 extern int __libc_enable_secure;
939
940 #endif
941
942 #if defined __USE_POSIX199309 || defined __USE_UNIX98
943 /* Synchronize at least the data part of a file with the underlying
944    media.  */
945 extern int fdatasync __P ((int __fildes));
946 #endif /* Use POSIX199309 */
947
948
949 /* XPG4.2 specifies that prototypes for the encryption functions must
950    be defined here.  */
951 #ifdef  __USE_XOPEN
952 /* Encrypt at most 8 characters from KEY using salt to perturb DES.  */
953 extern char *crypt __P ((__const char *__key, __const char *__salt));
954
955 /* Setup DES tables according KEY.  */
956 extern void setkey __P ((__const char *__key));
957
958 /* Encrypt data in BLOCK in place if EDFLAG is zero; otherwise decrypt
959    block in place.  */
960 extern void encrypt __P ((char *__block, int __edflag));
961
962
963 /* Swab pairs bytes in the first N bytes of the area pointed to by
964    FROM and copy the result to TO.  The value of TO must not be in the
965    range [FROM - N + 1, FROM - 1].  If N is odd the first byte in FROM
966    is without partner.  */
967 extern void swab __P ((__const __ptr_t __from, __ptr_t __to, ssize_t __n));
968 #endif
969
970
971 /* The Single Unix specification, version 2, demands these prototypes
972    to be here.  They are also found in <stdio.h>.  */
973 #ifdef __USE_XOPEN
974 /* Return the name of the controlling terminal.  */
975 extern char *ctermid __P ((char *__s));
976
977 /* Return the name of the current user.  This function should not be
978    used and might go away some time.  */
979 extern char *cuserid __P ((char *__s));
980
981 /* Rename file OLD to NEW.  */
982 extern int rename __P ((__const char *__old, __const char *__new));
983 #endif
984
985
986 #ifdef __USE_POSIX199309
987 /* This function is only available if the system has POSIX threads.  */
988
989 /* Install handlers to be called when a new process is created with FORK.
990    The PREPARE handler is called in the parent process just before performing
991    FORK. The PARENT handler is called in the parent process just after FORK.
992    The CHILD handler is called in the child process.  Each of the three
993    handlers can be NULL, meaning that no handler needs to be called at that
994    point.
995    PTHREAD_ATFORK can be called several times, in which case the PREPARE
996    handlers are called in LIFO order (last added with PTHREAD_ATFORK,
997    first called before FORK), and the PARENT and CHILD handlers are called
998    in FIFO (first added, first called). */
999 extern int pthread_atfork __P ((void (*__prepare) (void),
1000                                 void (*__parent) (void),
1001                                 void (*__child) (void)));
1002 #endif
1003
1004 __END_DECLS
1005
1006 #endif /* unistd.h  */