Formerly ../posix/unistd.h.~35~
[kopensolaris-gnu/glibc.git] / posix / unistd.h
1 /* Copyright (C) 1991, 1992, 1993 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
16 not, write to the Free Software Foundation, Inc., 675 Mass Ave,
17 Cambridge, MA 02139, USA.  */
18
19 /*
20  *      POSIX Standard: 2.10 Symbolic Constants         <unistd.h>
21  */
22
23 #ifndef _UNISTD_H
24
25 #define _UNISTD_H       1
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 IEEE Std 1003.1 as of August, 1988.  */
34 #define _POSIX_VERSION  199009L
35
36 /* These are not #ifdef __USE_POSIX2 because they are
37    in the theoretically application-owned namespace.  */
38
39 #define _POSIX2_C_VERSION       199912L /* Invalid until 1003.2 is done.  */
40
41 /* If defined, the implementation supports the
42    C Language Bindings Option.  */
43 #define _POSIX2_C_BIND  1
44
45 /* If defined, the implementation supports the
46    C Language Development Utilities Option.  */
47 #define _POSIX2_C_DEV   1
48
49 /* If defined, the implementation supports the
50    Software Development Utilities Option.  */
51 #define _POSIX2_SW_DEV  1
52
53
54 /* Get values of POSIX options:
55
56    If these symbols are defined, the corresponding features are
57    always available.  If not, they may be available sometimes.
58    The current values can be obtained with `sysconf'.
59
60    _POSIX_JOB_CONTROL   Job control is supported.
61    _POSIX_SAVED_IDS     Processes have a saved set-user-ID
62                         and a saved set-group-ID.
63
64    If any of these symbols is defined as -1, the corresponding option is not
65    true for any file.  If any is defined as other than -1, the corresponding
66    option is true for all files.  If a symbol is not defined at all, the value
67    for a specific file can be obtained from `pathconf' and `fpathconf'.
68
69    _POSIX_CHOWN_RESTRICTED      Only the super user can use `chown' to change
70                                 the owner of a file.  `chown' can only be used
71                                 to change the group ID of a file to a group of
72                                 which the calling process is a member.
73    _POSIX_NO_TRUNC              Pathname components longer than
74                                 NAME_MAX generate an error.
75    _POSIX_VDISABLE              If defined, if the value of an element of the
76                                 `c_cc' member of `struct termios' is
77                                 _POSIX_VDISABLE, no character will have the
78                                 effect associated with that element.
79    */
80
81 #include <posix_opt.h>
82
83
84 /* Standard file descriptors.  */
85 #define STDIN_FILENO    0       /* Standard input.  */
86 #define STDOUT_FILENO   1       /* Standard output.  */
87 #define STDERR_FILENO   2       /* Standard error output.  */
88
89
90 /* All functions that are not declared anywhere else.  */
91
92 #include <gnu/types.h>
93
94 #ifndef ssize_t
95 #define ssize_t __ssize_t
96 #endif
97
98 #define __need_size_t
99 #define __need_NULL
100 #include <stddef.h>
101
102
103 /* Values for the second argument to access.
104    These may be OR'd together.  */
105 #define R_OK    4               /* Test for read permission.  */
106 #define W_OK    2               /* Test for write permission.  */
107 #define X_OK    1               /* Test for execute permission.  */
108 #define F_OK    0               /* Test for existence.  */
109
110 /* Test for access to NAME.  */
111 extern int __access __P ((__const char *__name, int __type));
112 extern int access __P ((__const char *__name, int __type));
113
114
115 /* Values for the WHENCE argument to lseek.  */
116 #ifndef _STDIO_H                /* <stdio.h> has the same definitions.  */
117 #define SEEK_SET        0       /* Seek from beginning of file.  */
118 #define SEEK_CUR        1       /* Seek from current position.  */
119 #define SEEK_END        2       /* Seek from end of file.  */
120 #endif
121
122 /* Move FD's file position to OFFSET bytes from the
123    beginning of the file (if WHENCE is SEEK_SET),
124    the current position (if WHENCE is SEEK_CUR),
125    or the end of the file (if WHENCE is SEEK_END).
126    Return the new file position.  */
127 extern __off_t __lseek __P ((int __fd, __off_t __offset, int __whence));
128 extern __off_t lseek __P ((int __fd, __off_t __offset, int __whence));
129
130 /* Close the file descriptor FD.  */
131 extern int __close __P ((int __fd));
132 extern int close __P ((int __fd));
133
134 /* Read NBYTES into BUF from FD.  Return the
135    number read, -1 for errors or 0 for EOF.  */
136 extern ssize_t __read __P ((int __fd, __ptr_t __buf, size_t __nbytes));
137 extern ssize_t read __P ((int __fd, __ptr_t __buf, size_t __nbytes));
138
139 /* Write N bytes of BUF to FD.  Return the number written, or -1.  */
140 extern ssize_t __write __P ((int __fd, __const __ptr_t __buf, size_t __n));
141 extern ssize_t write __P ((int __fd, __const __ptr_t __buf, size_t __n));
142
143
144 /* Create a one-way communication channel (pipe).
145    If successul, two file descriptors are stored in PIPEDES;
146    bytes written on PIPEDES[1] can be read from PIPEDES[0].
147    Returns 0 if successful, -1 if not.  */
148 extern int __pipe __P ((int __pipedes[2]));
149 extern int pipe __P ((int __pipedes[2]));
150
151 /* Schedule an alarm.  In SECONDS seconds, the process will get a SIGALRM.
152    If SECONDS is zero, any currently scheduled alarm will be cancelled.
153    The function returns the number of seconds remaining until the last
154    alarm scheduled would have signaled, or zero if there wasn't one.
155    There is no return value to indicate an error, but you can set `errno'
156    to 0 and check its value after calling `alarm', and this might tell you.
157    The signal may come late due to processor scheduling.  */
158 extern unsigned int alarm __P ((unsigned int __seconds));
159
160 /* Make the process sleep for SECONDS seconds, or until a signal arrives
161    and is not ignored.  The function returns the number of seconds less
162    than SECONDS which it actually slept (thus zero if it slept the full time).
163    If a signal handler does a `longjmp' or modifies the handling of the
164    SIGALRM signal while inside `sleep' call, the handling of the SIGALRM
165    signal afterwards is undefined.  There is no return value to indicate
166    error, but if `sleep' returns SECONDS, it probably didn't work.  */
167 extern unsigned int sleep __P ((unsigned int __seconds));
168
169
170 /* Suspend the process until a signal arrives.
171    This always returns -1 and sets `errno' to EINTR.  */
172 extern int pause __P ((void));
173
174
175 /* Change the owner and group of FILE.  */
176 extern int __chown __P ((__const char *__file,
177                          __uid_t __owner, __gid_t __group));
178 extern int chown __P ((__const char *__file,
179                        __uid_t __owner, __gid_t __group));
180
181 #ifdef  __USE_BSD
182 /* Change the owner and group of the file that FD is open on.  */
183 extern int __fchown __P ((int __fd,
184                           __uid_t __owner, __gid_t __group));
185 extern int fchown __P ((int __fd,
186                         __uid_t __owner, __gid_t __group));
187 #endif /* Use BSD.  */
188
189 /* Change the process's working directory to PATH.  */
190 extern int __chdir __P ((__const char *__path));
191 extern int chdir __P ((__const char *__path));
192
193 /* Get the pathname of the current working directory,
194    and put it in SIZE bytes of BUF.  Returns NULL if the
195    directory couldn't be determined or SIZE was too small.
196    If successful, returns BUF.  In GNU, if BUF is NULL,
197    an array is allocated with `malloc'; the array is SIZE
198    bytes long, unless SIZE <= 0, in which case it is as
199    big as necessary.  */
200 extern char *getcwd __P ((char *__buf, size_t __size));
201
202 #ifdef  __USE_GNU
203 /* Return a malloc'd string containing the current directory name.
204    If the environment variable `PWD' is set, and its value is correct,
205    that value is used.  */
206 extern char *get_current_dir_name __P ((void));
207 #endif
208
209 #ifdef  __USE_BSD
210 /* Put the absolute pathname of the current working directory in BUF.
211    If successful, return BUF.  If not, put an error message in
212    BUF and return NULL.  BUF should be at least PATH_MAX bytes long.  */
213 extern char *getwd __P ((char *__buf));
214 #endif
215
216
217 /* Duplicate FD, returning a new file descriptor on the same file.  */
218 extern int __dup __P ((int __fd));
219 extern int dup __P ((int __fd));
220
221 /* Duplicate FD to FD2, closing FD2 and making it open on the same file.  */
222 extern int __dup2 __P ((int __fd, int __fd2));
223 extern int dup2 __P ((int __fd, int __fd2));
224
225 /* NULL-terminated array of "NAME=VALUE" environment variables.  */
226 extern char **__environ;
227 extern char **environ;
228
229
230 /* Replace the current process, executing PATH with arguments ARGV and
231    environment ENVP.  ARGV and ENVP are terminated by NULL pointers.  */
232 extern int __execve __P ((__const char *__path, char *__const __argv[],
233                           char *__const __envp[]));
234 extern int execve __P ((__const char *__path, char *__const __argv[],
235                         char *__const __envp[]));
236
237
238 /* Execute PATH with arguments ARGV and environment from `environ'.  */
239 extern int execv __P ((__const char *__path, char *__const __argv[]));
240
241 /* Execute PATH with all arguments after PATH until a NULL pointer,
242    and the argument after that for environment.  */
243 extern int execle __P ((__const char *__path, __const char *__arg,...));
244
245 /* Execute PATH with all arguments after PATH until
246    a NULL pointer and environment from `environ'.  */
247 extern int execl __P ((__const char *__path, __const char *__arg,...));
248
249 /* Execute FILE, searching in the `PATH' environment variable if it contains
250    no slashes, with arguments ARGV and environment from `environ'.  */
251 extern int execvp __P ((__const char *__file, char *__const __argv[]));
252
253 /* Execute FILE, searching in the `PATH' environment variable if
254    it contains no slashes, with all arguments after FILE until a
255    NULL pointer and environment from `environ'.  */
256 extern int execlp __P ((__const char *__file, ...));
257
258
259 #ifndef __NORETURN
260 #ifdef  __GNUC__
261 /* The `volatile' keyword tells GCC that a function never returns.  */
262 #define __NORETURN      __volatile
263 #else /* Not GCC.  */
264 #define __NORETURN
265 #endif /* GCC.  */
266 #endif /* __NORETURN not defined.  */
267
268 /* Terminate program execution with the low-order 8 bits of STATUS.  */
269 extern __NORETURN void _exit __P ((int __status));
270
271
272 /* Get the `_PC_*' symbols for the NAME argument to `pathconf' and `fpathconf';
273    the `_SC_*' symbols for the NAME argument to `sysconf';
274    and the `_CS_*' symbols for the NAME argument to `confstr'.  */
275 #include <confname.h>
276
277 /* Get file-specific configuration information about PATH.  */
278 extern long int __pathconf __P ((__const char *__path, int __name));
279 extern long int pathconf __P ((__const char *__path, int __name));
280
281 /* Get file-specific configuration about descriptor FD.  */
282 extern long int __fpathconf __P ((int __fd, int __name));
283 extern long int fpathconf __P ((int __fd, int __name));
284
285 /* Get the value of the system variable NAME.  */
286 extern long int __sysconf __P ((int __name));
287 extern long int sysconf __P ((int __name));
288
289 #ifdef  __USE_POSIX2
290 /* Get the value of the string-valued system variable NAME.  */
291 extern size_t confstr __P ((int __name, char *__buf, size_t __len));
292 #endif
293
294
295 /* Get the process ID of the calling process.  */
296 extern __pid_t __getpid __P ((void));
297 extern __pid_t getpid __P ((void));
298
299 /* Get the process ID of the calling process's parent.  */
300 extern __pid_t __getppid __P ((void));
301 extern __pid_t getppid __P ((void));
302
303 /* Get the process group ID of process PID.  */
304 extern __pid_t __getpgrp __P ((__pid_t __pid));
305
306 #ifndef __FAVOR_BSD
307 /* Get the process group ID of the calling process.  */
308 extern __pid_t getpgrp __P ((void));
309 #else /* Favor BSD.  */
310 #define getpgrp(pid)    __getpgrp(pid)
311 #endif
312
313 /* Set the process group ID of the process matching PID to PGID.
314    If PID is zero, the current process's process group ID is set.
315    If PGID is zero, the process ID of the process is used.  */
316 extern int __setpgrp __P ((__pid_t __pid, __pid_t __pgid));
317 extern int setpgid __P ((__pid_t __pid, __pid_t __pgid));
318
319 #ifdef  __USE_BSD
320 /* Set the process group of PID to PGRP.  */
321 extern int setpgrp __P ((__pid_t __pid, __pid_t __pgrp));
322 #endif /* Use BSD.  */
323
324 /* Create a new session with the calling process as its leader.
325    The process group IDs of the session and the calling process
326    are set to the process ID of the calling process, which is returned.  */
327 extern __pid_t __setsid __P ((void));
328 extern __pid_t setsid __P ((void));
329
330 /* Get the real user ID of the calling process.  */
331 extern __uid_t __getuid __P ((void));
332 extern __uid_t getuid __P ((void));
333
334 /* Get the effective user ID of the calling process.  */
335 extern __uid_t __geteuid __P ((void));
336 extern __uid_t geteuid __P ((void));
337
338 /* Get the real group ID of the calling process.  */
339 extern __gid_t __getgid __P ((void));
340 extern __gid_t getgid __P ((void));
341
342 /* Get the effective group ID of the calling process.  */
343 extern __gid_t __getegid __P ((void));
344 extern __gid_t getegid __P ((void));
345
346 /* If SIZE is zero, return the number of supplementary groups
347    the calling process is in.  Otherwise, fill in the group IDs
348    of its supplementary groups in LIST and return the number written.  */
349 extern int __getgroups __P ((int __size, __gid_t __list[]));
350 extern int getgroups __P ((int __size, __gid_t __list[]));
351
352 /* Set the user ID of the calling process to UID.
353    If the calling process is the super-user, set the real
354    and effective user IDs, and the saved set-user-ID to UID;
355    if not, the effective user ID is set to UID.  */
356 extern int __setuid __P ((__uid_t __uid));
357 extern int setuid __P ((__uid_t __uid));
358
359 #ifdef  __USE_BSD
360 /* Set the real user ID of the calling process to RUID,
361    and the effective user ID of the calling process to EUID.  */
362 extern int __setreuid __P ((__uid_t __ruid, __uid_t __euid));
363 extern int setreuid __P ((__uid_t __ruid, __uid_t __euid));
364
365 /* Set the effective user ID of the calling process to UID.  */
366 extern int seteuid __P ((__uid_t __uid));
367 #endif /* Use BSD.  */
368
369 /* Set the group ID of the calling process to GID.
370    If the calling process is the super-user, set the real
371    and effective group IDs, and the saved set-group-ID to GID;
372    if not, the effective group ID is set to GID.  */
373 extern int __setgid __P ((__gid_t __gid));
374 extern int setgid __P ((__gid_t __gid));
375
376 #ifdef  __USE_BSD
377 /* Set the real group ID of the calling process to RGID,
378    and the effective group ID of the calling process to EGID.  */
379 extern int __setregid __P ((__gid_t __rgid, __gid_t __egid));
380 extern int setregid __P ((__gid_t __rgid, __gid_t __egid));
381
382 /* Set the effective user ID of the calling process to UID.  */
383 extern int seteuid __P ((__uid_t __uid));
384 #endif /* Use BSD.  */
385
386
387 /* Clone the calling process, creating an exact copy.
388    Return -1 for errors, 0 to the new process,
389    and the process ID of the new process to the old process.  */
390 extern __pid_t __fork __P ((void));
391 extern __pid_t fork __P ((void));
392
393 #ifdef  __USE_BSD
394 /* Clone the calling process, but without copying the whole address space.
395    The the calling process is suspended until the the new process exits or is
396    replaced by a call to `execve'.  Return -1 for errors, 0 to the new process,
397    and the process ID of the new process to the old process.  */
398 extern __pid_t __vfork __P ((void));
399 extern __pid_t vfork __P ((void));
400 #endif /* Use BSD. */
401
402
403 /* Return the pathname of the terminal FD is open on, or NULL on errors.
404    The returned storage is good only until the next call to this function.  */
405 extern char *ttyname __P ((int __fd));
406
407 /* Return 1 if FD is a valid descriptor associated
408    with a terminal, zero if not.  */
409 extern int __isatty __P ((int __fd));
410 extern int isatty __P ((int __fd));
411
412
413 /* Make a link to FROM named TO.  */
414 extern int __link __P ((__const char *__from, __const char *__to));
415 extern int link __P ((__const char *__from, __const char *__to));
416
417 #ifdef  __USE_BSD
418 /* Make a symbolic link to FROM named TO.  */
419 extern int __symlink __P ((__const char *__from, __const char *__to));
420 extern int symlink __P ((__const char *__from, __const char *__to));
421
422 /* Read the contents of the symbolic link PATH into no more than
423    LEN bytes of BUF.  The contents are not null-terminated.
424    Returns the number of characters read, or -1 for errors.  */
425 extern int __readlink __P ((__const char *__path, char *__buf, size_t __len));
426 extern int readlink __P ((__const char *__path, char *__buf, size_t __len));
427 #endif /* Use BSD.  */
428
429 /* Remove the link NAME.  */
430 extern int __unlink __P ((__const char *__name));
431 extern int unlink __P ((__const char *__name));
432
433 /* Remove the directory PATH.  */
434 extern int __rmdir __P ((__const char *__path));
435 extern int rmdir __P ((__const char *__path));
436
437
438 /* Return the foreground process group ID of FD.  */
439 extern __pid_t tcgetpgrp __P ((int __fd));
440
441 /* Set the foreground process group ID of FD set PGRP_ID.  */
442 extern int tcsetpgrp __P ((int __fd, __pid_t __pgrp_id));
443
444
445 /* Return the login name of the user.  */
446 extern char *getlogin __P ((void));
447
448 #ifdef  __USE_BSD
449 /* Set the login name returned by `getlogin'.  */
450 extern int setlogin __P ((__const char *__name));
451 #endif
452
453
454 #ifdef  __USE_POSIX2
455 /* Process the arguments in ARGV (ARGC of them, minus
456    the program name) for options given in OPTS.
457
458    If `opterr' is zero, no messages are generated
459    for invalid options; it defaults to 1.
460    `optind' is the current index into ARGV.
461    `optarg' is the argument corresponding to the current option.
462    Return the option character from OPTS just read.
463    Return -1 when there are no more options.
464    For unrecognized options, or options missing arguments,
465    `optopt' is set to the option letter, and '?' is returned.
466
467    The OPTS string is a list of characters which are recognized option
468    letters, optionally followed by colons, specifying that that letter
469    takes an argument, to be placed in `optarg'.
470
471    If a letter in OPTS is followed by two colons, its argument is optional.
472    This behavior is specific to the GNU `getopt'.
473
474    The argument `--' causes premature termination of argument scanning,
475    explicitly telling `getopt' that there are no more options.
476
477    If OPTS begins with `--', then non-option arguments
478    are treated as arguments to the option '\0'.
479    This behavior is specific to the GNU `getopt'.  */
480 extern int getopt __P ((int __argc, char *__const * __argv,
481                         __const char *__opts));
482 extern int opterr;
483 extern int optind;
484 extern int optopt;
485 extern char *optarg;
486 #endif
487
488
489 #ifdef  __USE_BSD
490
491 /* Put the name of the current host in no more than LEN bytes of NAME.
492    The result is null-terminated if LEN is large enough for the full
493    name and the terminator.  */
494 extern int __gethostname __P ((char *__name, size_t __len));
495 extern int gethostname __P ((char *__name, size_t __len));
496
497 /* Set the name of the current host to NAME, which is LEN bytes long.
498    This call is restricted to the super-user.  */
499 extern int sethostname __P ((__const char *__name, size_t __len));
500
501 /* Return the current machine's Internet number.  */
502 extern long int gethostid __P ((void));
503
504 /* Set the current machine's Internet number to ID.
505    This call is restricted to the super-user.  */
506 extern int sethostid __P ((long int __id));
507
508
509 /* Return the number of bytes in a page.  This is the system's page size,
510    which is not necessarily the same as the hardware page size.  */
511 extern size_t __getpagesize __P ((void));
512 extern size_t getpagesize __P ((void));
513
514
515 /* Return the maximum number of file descriptors
516    the current process could possibly have.  */
517 extern int __getdtablesize __P ((void));
518 extern int getdtablesize __P ((void));
519
520
521 /* Make all changes done to FD actually appear on disk.  */
522 extern int fsync __P ((int __fd));
523
524 /* Make all changes done to all files actually appear on disk.  */
525 extern int sync __P ((void));
526
527
528 /* Revoke access permissions to all processes currently communicating
529    with the control terminal, and then send a SIGHUP signal to the process
530    group of the control terminal.  */
531 extern int vhangup __P ((void));
532
533
534 /* Turn accounting on if NAME is an existing file.  The system will then write
535    a record for each process as it terminates, to this file.  If NAME is NULL,
536    turn accounting off.  This call is restricted to the super-user.  */
537 extern int acct __P ((__const char *__name));
538
539 /* Make PATH be the root directory (the starting point for absolute paths).
540    This call is restricted to the super-user.  */
541 extern int chroot __P ((__const char *__path));
542
543 /* Make the block special device PATH available to the system for swapping.
544    This call is restricted to the super-user.  */
545 extern int swapon __P ((__const char *__path));
546
547 /* Reboot or halt the system.  */
548 extern int reboot __P ((int __howto));
549
550
551 /* Successive calls return the shells listed in `/etc/shells'.  */
552 extern char *getusershell __P ((void));
553 extern void endusershell __P ((void)); /* Discard cached info.  */
554 extern void setusershell __P ((void)); /* Rewind and re-read the file.  */
555
556 /* Prompt with PROMPT and read a string from the terminal without echoing.
557    Uses /dev/tty if possible; otherwise stderr and stdin.  */
558 extern char *getpass __P ((const char *__prompt));
559
560 #endif /* Use BSD.  */
561
562
563 __END_DECLS
564
565 #endif /* unistd.h  */