Formerly ../posix/fnmatch.c.~18~
[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 #include <stddef.h>
100
101
102 /* Values for the second argument to access.
103    These may be OR'd together.  */
104 #define R_OK    4               /* Test for read permission.  */
105 #define W_OK    2               /* Test for write permission.  */
106 #define X_OK    1               /* Test for execute permission.  */
107 #define F_OK    0               /* Test for existence.  */
108
109 /* Test for access to NAME.  */
110 extern int __access __P ((__const char *__name, int __type));
111 extern int access __P ((__const char *__name, int __type));
112
113
114 /* Values for the WHENCE argument to lseek.  */
115 #ifndef _STDIO_H                /* <stdio.h> has the same definitions.  */
116 #define SEEK_SET        0       /* Seek from beginning of file.  */
117 #define SEEK_CUR        1       /* Seek from current position.  */
118 #define SEEK_END        2       /* Seek from end of file.  */
119 #endif
120
121 /* Move FD's file position to OFFSET bytes from the
122    beginning of the file (if WHENCE is SEEK_SET),
123    the current position (if WHENCE is SEEK_CUR),
124    or the end of the file (if WHENCE is SEEK_END).
125    Return the new file position.  */
126 extern __off_t __lseek __P ((int __fd, __off_t __offset, int __whence));
127 extern __off_t lseek __P ((int __fd, __off_t __offset, int __whence));
128
129 /* Close the file descriptor FD.  */
130 extern int __close __P ((int __fd));
131 extern int close __P ((int __fd));
132
133 /* Read NBYTES into BUF from FD.  Return the
134    number read, -1 for errors or 0 for EOF.  */
135 extern ssize_t __read __P ((int __fd, __ptr_t __buf, size_t __nbytes));
136 extern ssize_t read __P ((int __fd, __ptr_t __buf, size_t __nbytes));
137
138 /* Write N bytes of BUF to FD.  Return the number written, or -1.  */
139 extern ssize_t __write __P ((int __fd, __const __ptr_t __buf, size_t __n));
140 extern ssize_t write __P ((int __fd, __const __ptr_t __buf, size_t __n));
141
142
143 /* Create a one-way communication channel (pipe).
144    If successul, two file descriptors are stored in PIPEDES;
145    bytes written on PIPEDES[1] can be read from PIPEDES[0].
146    Returns 0 if successful, -1 if not.  */
147 extern int __pipe __P ((int __pipedes[2]));
148 extern int pipe __P ((int __pipedes[2]));
149
150 /* Schedule an alarm.  In SECONDS seconds, the process will get a SIGALRM.
151    If SECONDS is zero, any currently scheduled alarm will be cancelled.
152    The function returns the number of seconds remaining until the last
153    alarm scheduled would have signaled, or zero if there wasn't one.
154    There is no return value to indicate an error, but you can set `errno'
155    to 0 and check its value after calling `alarm', and this might tell you.
156    The signal may come late due to processor scheduling.  */
157 extern unsigned int alarm __P ((unsigned int __seconds));
158
159 /* Make the process sleep for SECONDS seconds, or until a signal arrives
160    and is not ignored.  The function returns the number of seconds less
161    than SECONDS which it actually slept (thus zero if it slept the full time).
162    If a signal handler does a `longjmp' or modifies the handling of the
163    SIGALRM signal while inside `sleep' call, the handling of the SIGALRM
164    signal afterwards is undefined.  There is no return value to indicate
165    error, but if `sleep' returns SECONDS, it probably didn't work.  */
166 extern unsigned int sleep __P ((unsigned int __seconds));
167
168
169 /* Suspend the process until a signal arrives.
170    This always returns -1 and sets `errno' to EINTR.  */
171 extern int pause __P ((void));
172
173
174 /* Change the owner and group of FILE.  */
175 extern int __chown __P ((__const char *__file,
176                          __uid_t __owner, __gid_t __group));
177 extern int chown __P ((__const char *__file,
178                        __uid_t __owner, __gid_t __group));
179
180 #ifdef  __USE_BSD
181 /* Change the owner and group of the file that FD is open on.  */
182 extern int __fchown __P ((int __fd,
183                           __uid_t __owner, __gid_t __group));
184 extern int fchown __P ((int __fd,
185                         __uid_t __owner, __gid_t __group));
186 #endif /* Use BSD.  */
187
188 /* Change the process's working directory to PATH.  */
189 extern int __chdir __P ((__const char *__path));
190 extern int chdir __P ((__const char *__path));
191
192 /* Get the pathname of the current working directory,
193    and put it in SIZE bytes of BUF.  Returns NULL if the
194    directory couldn't be determined or SIZE was too small.
195    If successful, returns BUF.  In GNU, if BUF is NULL,
196    an array is allocated with `malloc'; the array is SIZE
197    bytes long, unless SIZE <= 0, in which case it is as
198    big as necessary.  */
199 extern char *getcwd __P ((char *__buf, size_t __size));
200
201 #ifdef  __USE_GNU
202 /* Return a malloc'd string containing the current directory name.
203    If the environment variable `PWD' is set, and its value is correct,
204    that value is used.  */
205 extern char *get_current_dir_name __P ((void));
206 #endif
207
208 #ifdef  __USE_BSD
209 /* Put the absolute pathname of the current working directory in BUF.
210    If successful, return BUF.  If not, put an error message in
211    BUF and return NULL.  BUF should be at least PATH_MAX bytes long.  */
212 extern char *getwd __P ((char *__buf));
213 #endif
214
215
216 /* Duplicate FD, returning a new file descriptor on the same file.  */
217 extern int __dup __P ((int __fd));
218 extern int dup __P ((int __fd));
219
220 /* Duplicate FD to FD2, closing FD2 and making it open on the same file.  */
221 extern int __dup2 __P ((int __fd, int __fd2));
222 extern int dup2 __P ((int __fd, int __fd2));
223
224 /* NULL-terminated array of "NAME=VALUE" environment variables.  */
225 extern char **__environ;
226 extern char **environ;
227
228
229 /* Replace the current process, executing PATH with arguments ARGV and
230    environment ENVP.  ARGV and ENVP are terminated by NULL pointers.  */
231 extern int __execve __P ((__const char *__path, char *__const __argv[],
232                           char *__const __envp[]));
233 extern int execve __P ((__const char *__path, char *__const __argv[],
234                         char *__const __envp[]));
235
236
237 /* Execute PATH with arguments ARGV and environment from `environ'.  */
238 extern int execv __P ((__const char *__path, char *__const __argv[]));
239
240 /* Execute PATH with all arguments after PATH until a NULL pointer,
241    and the argument after that for environment.  */
242 extern int execle __P ((__const char *__path, __const char *__arg,...));
243
244 /* Execute PATH with all arguments after PATH until
245    a NULL pointer and environment from `environ'.  */
246 extern int execl __P ((__const char *__path, __const char *__arg,...));
247
248 /* Execute FILE, searching in the `PATH' environment variable if it contains
249    no slashes, with arguments ARGV and environment from `environ'.  */
250 extern int execvp __P ((__const char *__file, char *__const __argv[]));
251
252 /* Execute FILE, searching in the `PATH' environment variable if
253    it contains no slashes, with all arguments after FILE until a
254    NULL pointer and environment from `environ'.  */
255 extern int execlp __P ((__const char *__file, ...));
256
257
258 #ifndef __NORETURN
259 #ifdef  __GNUC__
260 /* The `volatile' keyword tells GCC that a function never returns.  */
261 #define __NORETURN      __volatile
262 #else /* Not GCC.  */
263 #define __NORETURN
264 #endif /* GCC.  */
265 #endif /* __NORETURN not defined.  */
266
267 /* Terminate program execution with the low-order 8 bits of STATUS.  */
268 extern __NORETURN void _exit __P ((int __status));
269
270
271 /* Values for the NAME argument to `pathconf' and `fpathconf'.
272    These correspond to the _POSIX_* symbols above, but for
273    specific files or file descriptors.  */
274 #define _PC_LINK_MAX            0
275 #define _PC_MAX_CANON           1
276 #define _PC_MAX_INPUT           2
277 #define _PC_NAME_MAX            3
278 #define _PC_PATH_MAX            4
279 #define _PC_PIPE_BUF            5
280 #define _PC_CHOWN_RESTRICTED    6
281 #define _PC_NO_TRUNC            7
282 #define _PC_VDISABLE            8
283
284 /* Get file-specific configuration information about PATH.  */
285 extern long int __pathconf __P ((__const char *__path, int __name));
286 extern long int pathconf __P ((__const char *__path, int __name));
287
288 /* Get file-specific configuration about descriptor FD.  */
289 extern long int __fpathconf __P ((int __fd, int __name));
290 extern long int fpathconf __P ((int __fd, int __name));
291
292
293 /* Values for the argument to `sysconf'.
294    These correspond to the _POSIX_* symbols in <posix_limits.h> and above,
295    but may vary at run time.  */
296 enum
297 {
298   _SC_ARG_MAX,
299   _SC_CHILD_MAX,
300   _SC_CLK_TCK,
301   _SC_NGROUPS_MAX,
302   _SC_OPEN_MAX,
303   _SC_STREAM_MAX,
304   _SC_TZNAME_MAX,
305   _SC_JOB_CONTROL,
306   _SC_SAVED_IDS,
307   _SC_VERSION,
308
309   /* Values for the argument to `sysconf'
310      corresponding to _POSIX2_* symbols.  */
311   _SC_BC_BASE_MAX,
312   _SC_BC_DIM_MAX,
313   _SC_BC_SCALE_MAX,
314   _SC_BC_STRING_MAX,
315   _SC_COLL_WEIGHTS_MAX,
316   _SC_EQUIV_CLASS_MAX,
317   _SC_EXPR_NEST_MAX,
318   _SC_LINE_MAX,
319   _SC_RE_DUP_MAX,
320
321   _SC_2_VERSION,
322   _SC_2_C_BIND,
323   _SC_2_C_DEV,
324   _SC_2_FORT_DEV,
325   _SC_2_FORT_RUN,
326   _SC_2_SW_DEV,
327   _SC_2_LOCALEDEF
328 };
329
330
331 /* Get the value of the system variable NAME.  */
332 extern long int __sysconf __P ((int __name));
333 extern long int sysconf __P ((int __name));
334
335
336 #ifdef  __USE_POSIX2
337 /* Values for the argument to `confstr'.  */
338 #define _CS_PATH        0       /* The default search path.  */
339
340 /* Get the value of the string-valued system variable NAME.  */
341 extern size_t confstr __P ((int __name, char *__buf, size_t __len));
342 #endif
343
344
345 /* Get the process ID of the calling process.  */
346 extern __pid_t __getpid __P ((void));
347 extern __pid_t getpid __P ((void));
348
349 /* Get the process ID of the calling process's parent.  */
350 extern __pid_t __getppid __P ((void));
351 extern __pid_t getppid __P ((void));
352
353 /* Get the process group ID of process PID.  */
354 extern __pid_t __getpgrp __P ((__pid_t __pid));
355
356 #ifndef __FAVOR_BSD
357 /* Get the process group ID of the calling process.  */
358 extern __pid_t getpgrp __P ((void));
359 #else /* Favor BSD.  */
360 #define getpgrp(pid)    __getpgrp(pid)
361 #endif
362
363 /* Set the process group ID of the process matching PID to PGID.
364    If PID is zero, the current process's process group ID is set.
365    If PGID is zero, the process ID of the process is used.  */
366 extern int __setpgrp __P ((__pid_t __pid, __pid_t __pgid));
367 extern int setpgid __P ((__pid_t __pid, __pid_t __pgid));
368
369 #ifdef  __USE_BSD
370 /* Set the process group of PID to PGRP.  */
371 extern int setpgrp __P ((__pid_t __pid, __pid_t __pgrp));
372 #endif /* Use BSD.  */
373
374 /* Create a new session with the calling process as its leader.
375    The process group IDs of the session and the calling process
376    are set to the process ID of the calling process, which is returned.  */
377 extern __pid_t __setsid __P ((void));
378 extern __pid_t setsid __P ((void));
379
380 /* Get the real user ID of the calling process.  */
381 extern __uid_t __getuid __P ((void));
382 extern __uid_t getuid __P ((void));
383
384 /* Get the effective user ID of the calling process.  */
385 extern __uid_t __geteuid __P ((void));
386 extern __uid_t geteuid __P ((void));
387
388 /* Get the real group ID of the calling process.  */
389 extern __gid_t __getgid __P ((void));
390 extern __gid_t getgid __P ((void));
391
392 /* Get the effective group ID of the calling process.  */
393 extern __gid_t __getegid __P ((void));
394 extern __gid_t getegid __P ((void));
395
396 /* If SIZE is zero, return the number of supplementary groups
397    the calling process is in.  Otherwise, fill in the group IDs
398    of its supplementary groups in LIST and return the number written.  */
399 extern int __getgroups __P ((int __size, __gid_t __list[]));
400 extern int getgroups __P ((int __size, __gid_t __list[]));
401
402 /* Set the user ID of the calling process to UID.
403    If the calling process is the super-user, set the real
404    and effective user IDs, and the saved set-user-ID to UID;
405    if not, the effective user ID is set to UID.  */
406 extern int __setuid __P ((__uid_t __uid));
407 extern int setuid __P ((__uid_t __uid));
408
409 #ifdef  __USE_BSD
410 /* Set the real user ID of the calling process to RUID,
411    and the effective user ID of the calling process to EUID.  */
412 extern int __setreuid __P ((__uid_t __ruid, __uid_t __euid));
413 extern int setreuid __P ((__uid_t __ruid, __uid_t __euid));
414
415 /* Set the effective user ID of the calling process to UID.  */
416 extern int seteuid __P ((__uid_t __uid));
417 #endif /* Use BSD.  */
418
419 /* Set the group ID of the calling process to GID.
420    If the calling process is the super-user, set the real
421    and effective group IDs, and the saved set-group-ID to GID;
422    if not, the effective group ID is set to GID.  */
423 extern int __setgid __P ((__gid_t __gid));
424 extern int setgid __P ((__gid_t __gid));
425
426 #ifdef  __USE_BSD
427 /* Set the real group ID of the calling process to RGID,
428    and the effective group ID of the calling process to EGID.  */
429 extern int __setregid __P ((__gid_t __rgid, __gid_t __egid));
430 extern int setregid __P ((__gid_t __rgid, __gid_t __egid));
431
432 /* Set the effective user ID of the calling process to UID.  */
433 extern int seteuid __P ((__uid_t __uid));
434 #endif /* Use BSD.  */
435
436
437 /* Clone the calling process, creating an exact copy.
438    Return -1 for errors, 0 to the new process,
439    and the process ID of the new process to the old process.  */
440 extern __pid_t __fork __P ((void));
441 extern __pid_t fork __P ((void));
442
443 #ifdef  __USE_BSD
444 /* Clone the calling process, but without copying the whole address space.
445    The the calling process is suspended until the the new process exits or is
446    replaced by a call to `execve'.  Return -1 for errors, 0 to the new process,
447    and the process ID of the new process to the old process.  */
448 extern __pid_t __vfork __P ((void));
449 extern __pid_t vfork __P ((void));
450 #endif /* Use BSD. */
451
452
453 /* Return the pathname of the terminal FD is open on, or NULL on errors.
454    The returned storage is good only until the next call to this function.  */
455 extern char *ttyname __P ((int __fd));
456
457 /* Return 1 if FD is a valid descriptor associated
458    with a terminal, zero if not.  */
459 extern int __isatty __P ((int __fd));
460 extern int isatty __P ((int __fd));
461
462
463 /* Make a link to FROM named TO.  */
464 extern int __link __P ((__const char *__from, __const char *__to));
465 extern int link __P ((__const char *__from, __const char *__to));
466
467 #ifdef  __USE_BSD
468 /* Make a symbolic link to FROM named TO.  */
469 extern int __symlink __P ((__const char *__from, __const char *__to));
470 extern int symlink __P ((__const char *__from, __const char *__to));
471
472 /* Read the contents of the symbolic link PATH into no more than
473    LEN bytes of BUF.  The contents are not null-terminated.
474    Returns the number of characters read, or -1 for errors.  */
475 extern int __readlink __P ((__const char *__path, char *__buf, size_t __len));
476 extern int readlink __P ((__const char *__path, char *__buf, size_t __len));
477 #endif /* Use BSD.  */
478
479 /* Remove the link NAME.  */
480 extern int __unlink __P ((__const char *__name));
481 extern int unlink __P ((__const char *__name));
482
483 /* Remove the directory PATH.  */
484 extern int __rmdir __P ((__const char *__path));
485 extern int rmdir __P ((__const char *__path));
486
487
488 /* Return the foreground process group ID of FD.  */
489 extern __pid_t tcgetpgrp __P ((int __fd));
490
491 /* Set the foreground process group ID of FD set PGRP_ID.  */
492 extern int tcsetpgrp __P ((int __fd, __pid_t __pgrp_id));
493
494
495 /* Return the login name of the user.  */
496 extern char *getlogin __P ((void));
497
498 #ifdef  __USE_BSD
499 /* Set the login name returned by `getlogin'.  */
500 extern int setlogin __P ((__const char *__name));
501 #endif
502
503
504 #ifdef  __USE_POSIX2
505 /* Process the arguments in ARGV (ARGC of them, minus
506    the program name) for options given in OPTS.
507
508    If `opterr' is zero, no messages are generated
509    for invalid options; it defaults to 1.
510    `optind' is the current index into ARGV.
511    `optarg' is the argument corresponding to the current option.
512    Return the option character from OPTS just read.
513    Return -1 when there are no more options.
514    For unrecognized options, or options missing arguments,
515    `optopt' is set to the option letter, and '?' is returned.
516
517    The OPTS string is a list of characters which are recognized option
518    letters, optionally followed by colons, specifying that that letter
519    takes an argument, to be placed in `optarg'.
520
521    If a letter in OPTS is followed by two colons, its argument is optional.
522    This behavior is specific to the GNU `getopt'.
523
524    The argument `--' causes premature termination of argument scanning,
525    explicitly telling `getopt' that there are no more options.
526
527    If OPTS begins with `--', then non-option arguments
528    are treated as arguments to the option '\0'.
529    This behavior is specific to the GNU `getopt'.  */
530 extern int getopt __P ((int __argc, char *__const * __argv,
531                         __const char *__opts));
532 extern int opterr;
533 extern int optind;
534 extern int optopt;
535 extern char *optarg;
536 #endif
537
538
539 #ifdef  __USE_BSD
540
541 /* Put the name of the current host in no more than LEN bytes of NAME.
542    The result is null-terminated if LEN is large enough for the full
543    name and the terminator.  */
544 extern int __gethostname __P ((char *__name, size_t __len));
545 extern int gethostname __P ((char *__name, size_t __len));
546
547 /* Set the name of the current host to NAME, which is LEN bytes long.
548    This call is restricted to the super-user.  */
549 extern int sethostname __P ((__const char *__name, size_t __len));
550
551 /* Return the current machine's Internet number.  */
552 extern long int gethostid __P ((void));
553
554 /* Set the current machine's Internet number to ID.
555    This call is restricted to the super-user.  */
556 extern int sethostid __P ((long int __id));
557
558
559 /* Return the number of bytes in a page.  This is the system's page size,
560    which is not necessarily the same as the hardware page size.  */
561 extern size_t __getpagesize __P ((void));
562 extern size_t getpagesize __P ((void));
563
564
565 /* Return the maximum number of file descriptors
566    the current process could possibly have.  */
567 extern int __getdtablesize __P ((void));
568 extern int getdtablesize __P ((void));
569
570
571 /* Make all changes done to FD actually appear on disk.  */
572 extern int fsync __P ((int __fd));
573
574 /* Make all changes done to all files actually appear on disk.  */
575 extern int sync __P ((void));
576
577
578 /* Revoke access permissions to all processes currently communicating
579    with the control terminal, and then send a SIGHUP signal to the process
580    group of the control terminal.  */
581 extern int vhangup __P ((void));
582
583
584 /* Turn accounting on if NAME is an existing file.  The system will then write
585    a record for each process as it terminates, to this file.  If NAME is NULL,
586    turn accounting off.  This call is restricted to the super-user.  */
587 extern int acct __P ((__const char *__name));
588
589 /* Make PATH be the root directory (the starting point for absolute paths).
590    This call is restricted to the super-user.  */
591 extern int chroot __P ((__const char *__path));
592
593 /* Make the block special device PATH available to the system for swapping.
594    This call is restricted to the super-user.  */
595 extern int swapon __P ((__const char *__path));
596
597 /* Reboot or halt the system.  */
598 extern int reboot __P ((int __howto));
599
600
601 /* Successive calls return the shells listed in `/etc/shells'.  */
602 extern char *getusershell __P ((void));
603 extern void endusershell __P ((void)); /* Discard cached info.  */
604 extern void setusershell __P ((void)); /* Rewind and re-read the file.  */
605
606 /* Prompt with PROMPT and read a string from the terminal without echoing.
607    Uses /dev/tty if possible; otherwise stderr and stdin.  */
608 extern char *getpass __P ((const char *__prompt));
609
610 #endif /* Use BSD.  */
611
612
613 __END_DECLS
614
615 #endif /* unistd.h  */