1 /* Substitute for and wrapper around <unistd.h>.
2 Copyright (C) 2003-2009 Free Software Foundation, Inc.
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2, or (at your option)
9 This program 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
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software Foundation,
16 Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */
21 @PRAGMA_SYSTEM_HEADER@
24 /* The include_next requires a split double-inclusion guard. */
26 # @INCLUDE_NEXT@ @NEXT_UNISTD_H@
32 /* NetBSD 5.0 mis-defines NULL. Also get size_t. */
35 /* mingw doesn't define the SEEK_* or *_FILENO macros in <unistd.h>. */
36 #if !(defined SEEK_CUR && defined SEEK_END && defined SEEK_SET)
40 /* mingw fails to declare _exit in <unistd.h>. */
41 /* mingw, BeOS, Haiku declare environ in <stdlib.h>, not in <unistd.h>. */
44 #if ((@GNULIB_WRITE@ && @REPLACE_WRITE@ && @GNULIB_UNISTD_H_SIGPIPE@) \
45 || (@GNULIB_READLINK@ && (!@HAVE_READLINK@ || @REPLACE_READLINK@)) \
46 || (@GNULIB_READLINKAT@ && !@HAVE_READLINKAT@))
48 # include <sys/types.h>
51 /* Get getopt(), optarg, optind, opterr, optopt. */
52 #if @GNULIB_UNISTD_H_GETOPT@ && !defined _GL_SYSTEM_GETOPT
56 #if @GNULIB_GETHOSTNAME@
57 /* Get all possible declarations of gethostname(). */
58 # if @UNISTD_H_HAVE_WINSOCK2_H@
59 # include <winsock2.h>
60 # if !defined _GL_SYS_SOCKET_H
62 # define socket socket_used_without_including_sys_socket_h
64 # define connect connect_used_without_including_sys_socket_h
66 # define accept accept_used_without_including_sys_socket_h
68 # define bind bind_used_without_including_sys_socket_h
70 # define getpeername getpeername_used_without_including_sys_socket_h
72 # define getsockname getsockname_used_without_including_sys_socket_h
74 # define getsockopt getsockopt_used_without_including_sys_socket_h
76 # define listen listen_used_without_including_sys_socket_h
78 # define recv recv_used_without_including_sys_socket_h
80 # define send send_used_without_including_sys_socket_h
82 # define recvfrom recvfrom_used_without_including_sys_socket_h
84 # define sendto sendto_used_without_including_sys_socket_h
86 # define setsockopt setsockopt_used_without_including_sys_socket_h
88 # define shutdown shutdown_used_without_including_sys_socket_h
90 # if !defined _GL_SYS_SELECT_H
92 # define select select_used_without_including_sys_select_h
97 /* The definition of GL_LINK_WARNING is copied here. */
100 /* OS/2 EMX lacks these macros. */
102 # define STDIN_FILENO 0
104 #ifndef STDOUT_FILENO
105 # define STDOUT_FILENO 1
107 #ifndef STDERR_FILENO
108 # define STDERR_FILENO 2
111 /* Ensure *_OK macros exist. */
120 /* Declare overridden functions. */
130 # define chown rpl_chown
132 # if !@HAVE_CHOWN@ || @REPLACE_CHOWN@
133 /* Change the owner of FILE to UID (if UID is not -1) and the group of FILE
134 to GID (if GID is not -1). Follow symbolic links.
135 Return 0 if successful, otherwise -1 and errno set.
136 See the POSIX:2001 specification
137 <http://www.opengroup.org/susv3xsh/chown.html>. */
138 extern int chown (const char *file, uid_t uid, gid_t gid);
140 #elif defined GNULIB_POSIXCHECK
142 # define chown(f,u,g) \
143 (GL_LINK_WARNING ("chown fails to follow symlinks on some systems and " \
144 "doesn't treat a uid or gid of -1 on some systems - " \
145 "use gnulib module chown for portability"), \
152 /* Automatically included by modules that need a replacement for close. */
154 # define close rpl_close
155 extern int close (int);
157 #elif @UNISTD_H_HAVE_WINSOCK2_H_AND_USE_SOCKETS@
159 # define close close_used_without_requesting_gnulib_module_close
160 #elif defined GNULIB_POSIXCHECK
163 (GL_LINK_WARNING ("close does not portably work on sockets - " \
164 "use gnulib module close for portability"), \
171 extern int dup (int);
177 # define dup2 rpl_dup2
179 # if !@HAVE_DUP2@ || @REPLACE_DUP2@
180 /* Copy the file descriptor OLDFD into file descriptor NEWFD. Do nothing if
181 NEWFD = OLDFD, otherwise close NEWFD first if it is open.
182 Return newfd if successful, otherwise -1 and errno set.
183 See the POSIX:2001 specification
184 <http://www.opengroup.org/susv3xsh/dup2.html>. */
185 extern int dup2 (int oldfd, int newfd);
187 #elif defined GNULIB_POSIXCHECK
190 (GL_LINK_WARNING ("dup2 is unportable - " \
191 "use gnulib module dup2 for portability"), \
197 /* Copy the file descriptor OLDFD into file descriptor NEWFD, with the
199 The flags are a bitmask, possibly including O_CLOEXEC (defined in <fcntl.h>)
200 and O_TEXT, O_BINARY (defined in "binary-io.h").
201 Close NEWFD first if it is open.
202 Return newfd if successful, otherwise -1 and errno set.
203 See the Linux man page at
204 <http://www.kernel.org/doc/man-pages/online/pages/man2/dup3.2.html>. */
206 # define dup3 rpl_dup3
208 extern int dup3 (int oldfd, int newfd, int flags);
209 #elif defined GNULIB_POSIXCHECK
211 # define dup3(o,n,f) \
212 (GL_LINK_WARNING ("dup3 is unportable - " \
213 "use gnulib module dup3 for portability"), \
219 # if !@HAVE_DECL_ENVIRON@
220 /* Set of environment variables and values. An array of strings of the form
221 "VARIABLE=VALUE", terminated with a NULL. */
222 # if defined __APPLE__ && defined __MACH__
223 # include <crt_externs.h>
224 # define environ (*_NSGetEnviron ())
226 extern char **environ;
229 #elif defined GNULIB_POSIXCHECK
232 (GL_LINK_WARNING ("environ is unportable - " \
233 "use gnulib module environ for portability"), \
238 #if @GNULIB_EUIDACCESS@
239 # if !@HAVE_EUIDACCESS@
240 /* Like access(), except that it uses the effective user id and group id of
241 the current process. */
242 extern int euidaccess (const char *filename, int mode);
244 #elif defined GNULIB_POSIXCHECK
246 # define euidaccess(f,m) \
247 (GL_LINK_WARNING ("euidaccess is unportable - " \
248 "use gnulib module euidaccess for portability"), \
253 #if @GNULIB_FACCESSAT@
254 # if !@HAVE_FACCESSAT@
255 int faccessat (int fd, char const *file, int mode, int flag);
257 #elif defined GNULIB_POSIXCHECK
259 # define faccessat(d,n,m,f) \
260 (GL_LINK_WARNING ("faccessat is not portable - " \
261 "use gnulib module faccessat for portability"), \
262 faccessat (d, n, m, f))
267 # if @REPLACE_FCHDIR@
268 /* Change the process' current working directory to the directory on which
269 the given file descriptor is open.
270 Return 0 if successful, otherwise -1 and errno set.
271 See the POSIX:2001 specification
272 <http://www.opengroup.org/susv3xsh/fchdir.html>. */
273 extern int fchdir (int /*fd*/);
275 /* Gnulib internal hooks needed to maintain the fchdir metadata. */
276 extern int _gl_register_fd (int fd, const char *filename);
277 extern void _gl_unregister_fd (int fd);
278 extern int _gl_register_dup (int oldfd, int newfd);
279 extern const char *_gl_directory_name (int fd);
282 #elif defined GNULIB_POSIXCHECK
285 (GL_LINK_WARNING ("fchdir is unportable - " \
286 "use gnulib module fchdir for portability"), \
291 #if @GNULIB_FCHOWNAT@
292 # if @REPLACE_FCHOWNAT@
294 # define fchownat rpl_fchownat
296 # if !@HAVE_FCHOWNAT@ || @REPLACE_FCHOWNAT@
297 extern int fchownat (int fd, char const *file, uid_t owner, gid_t group, int flag);
299 #elif defined GNULIB_POSIXCHECK
301 # define fchownat(d,n,o,g,f) \
302 (GL_LINK_WARNING ("fchownat is not portable - " \
303 "use gnulib module openat for portability"), \
304 fchownat (d, n, o, g, f))
309 /* Synchronize changes to a file.
310 Return 0 if successful, otherwise -1 and errno set.
311 See POSIX:2001 specification
312 <http://www.opengroup.org/susv3xsh/fsync.html>. */
314 extern int fsync (int fd);
316 #elif defined GNULIB_POSIXCHECK
319 (GL_LINK_WARNING ("fsync is unportable - " \
320 "use gnulib module fsync for portability"), \
325 #if @GNULIB_FTRUNCATE@
326 # if !@HAVE_FTRUNCATE@
327 /* Change the size of the file to which FD is opened to become equal to LENGTH.
328 Return 0 if successful, otherwise -1 and errno set.
329 See the POSIX:2001 specification
330 <http://www.opengroup.org/susv3xsh/ftruncate.html>. */
331 extern int ftruncate (int fd, off_t length);
333 #elif defined GNULIB_POSIXCHECK
335 # define ftruncate(f,l) \
336 (GL_LINK_WARNING ("ftruncate is unportable - " \
337 "use gnulib module ftruncate for portability"), \
343 /* Include the headers that might declare getcwd so that they will not
344 cause confusion if included after this file. */
346 # if @REPLACE_GETCWD@
347 /* Get the name of the current working directory, and put it in SIZE bytes
349 Return BUF if successful, or NULL if the directory couldn't be determined
350 or SIZE was too small.
351 See the POSIX:2001 specification
352 <http://www.opengroup.org/susv3xsh/getcwd.html>.
353 Additionally, the gnulib module 'getcwd' guarantees the following GNU
354 extension: If BUF is NULL, an array is allocated with 'malloc'; the array
355 is SIZE bytes long, unless SIZE == 0, in which case it is as big as
357 # define getcwd rpl_getcwd
358 extern char * getcwd (char *buf, size_t size);
360 #elif defined GNULIB_POSIXCHECK
362 # define getcwd(b,s) \
363 (GL_LINK_WARNING ("getcwd is unportable - " \
364 "use gnulib module getcwd for portability"), \
369 #if @GNULIB_GETDOMAINNAME@
370 /* Return the NIS domain name of the machine.
371 WARNING! The NIS domain name is unrelated to the fully qualified host name
372 of the machine. It is also unrelated to email addresses.
373 WARNING! The NIS domain name is usually the empty string or "(none)" when
376 Put up to LEN bytes of the NIS domain name into NAME.
377 Null terminate it if the name is shorter than LEN.
378 If the NIS domain name is longer than LEN, set errno = EINVAL and return -1.
379 Return 0 if successful, otherwise set errno and return -1. */
380 # if !@HAVE_GETDOMAINNAME@
381 extern int getdomainname(char *name, size_t len);
383 #elif defined GNULIB_POSIXCHECK
384 # undef getdomainname
385 # define getdomainname(n,l) \
386 (GL_LINK_WARNING ("getdomainname is unportable - " \
387 "use gnulib module getdomainname for portability"), \
388 getdomainname (n, l))
392 #if @GNULIB_GETDTABLESIZE@
393 # if !@HAVE_GETDTABLESIZE@
394 /* Return the maximum number of file descriptors in the current process.
395 In POSIX, this is same as sysconf (_SC_OPEN_MAX). */
396 extern int getdtablesize (void);
398 #elif defined GNULIB_POSIXCHECK
399 # undef getdtablesize
400 # define getdtablesize() \
401 (GL_LINK_WARNING ("getdtablesize is unportable - " \
402 "use gnulib module getdtablesize for portability"), \
407 #if @GNULIB_GETGROUPS@
408 # if @REPLACE_GETGROUPS@
410 # define getgroups rpl_getgroups
412 # if !@HAVE_GETGROUPS@ || @REPLACE_GETGROUPS@
413 /* Return the supplemental groups that the current process belongs to.
414 It is unspecified whether the effective group id is in the list.
415 If N is 0, return the group count; otherwise, N describes how many
416 entries are available in GROUPS. Return -1 and set errno if N is
417 not 0 and not large enough. Fails with ENOSYS on some systems. */
418 int getgroups (int n, gid_t *groups);
420 #elif defined GNULIB_POSIXCHECK
422 # define getgroups(n,g) \
423 (GL_LINK_WARNING ("getgroups is unportable - " \
424 "use gnulib module getgroups for portability"), \
429 #if @GNULIB_GETHOSTNAME@
430 /* Return the standard host name of the machine.
431 WARNING! The host name may or may not be fully qualified.
433 Put up to LEN bytes of the host name into NAME.
434 Null terminate it if the name is shorter than LEN.
435 If the host name is longer than LEN, set errno = EINVAL and return -1.
436 Return 0 if successful, otherwise set errno and return -1. */
437 # if @UNISTD_H_HAVE_WINSOCK2_H@
439 # define gethostname rpl_gethostname
441 # if @UNISTD_H_HAVE_WINSOCK2_H@ || !@HAVE_GETHOSTNAME@
442 extern int gethostname(char *name, size_t len);
444 #elif @UNISTD_H_HAVE_WINSOCK2_H@
446 # define gethostname gethostname_used_without_requesting_gnulib_module_gethostname
447 #elif defined GNULIB_POSIXCHECK
449 # define gethostname(n,l) \
450 (GL_LINK_WARNING ("gethostname is unportable - " \
451 "use gnulib module gethostname for portability"), \
456 #if @GNULIB_GETLOGIN_R@
457 /* Copies the user's login name to NAME.
458 The array pointed to by NAME has room for SIZE bytes.
460 Returns 0 if successful. Upon error, an error number is returned, or -1 in
461 the case that the login name cannot be found but no specific error is
462 provided (this case is hopefully rare but is left open by the POSIX spec).
464 See <http://www.opengroup.org/susv3xsh/getlogin.html>.
466 # if !@HAVE_DECL_GETLOGIN_R@
467 extern int getlogin_r (char *name, size_t size);
469 #elif defined GNULIB_POSIXCHECK
471 # define getlogin_r(n,s) \
472 (GL_LINK_WARNING ("getlogin_r is unportable - " \
473 "use gnulib module getlogin_r for portability"), \
478 #if @GNULIB_GETPAGESIZE@
479 # if @REPLACE_GETPAGESIZE@
480 # define getpagesize rpl_getpagesize
481 extern int getpagesize (void);
482 # elif !@HAVE_GETPAGESIZE@
483 /* This is for POSIX systems. */
484 # if !defined getpagesize && defined _SC_PAGESIZE
485 # if ! (defined __VMS && __VMS_VER < 70000000)
486 # define getpagesize() sysconf (_SC_PAGESIZE)
489 /* This is for older VMS. */
490 # if !defined getpagesize && defined __VMS
492 # define getpagesize() 8192
494 # define getpagesize() 512
497 /* This is for BeOS. */
498 # if !defined getpagesize && @HAVE_OS_H@
500 # if defined B_PAGE_SIZE
501 # define getpagesize() B_PAGE_SIZE
504 /* This is for AmigaOS4.0. */
505 # if !defined getpagesize && defined __amigaos4__
506 # define getpagesize() 2048
508 /* This is for older Unix systems. */
509 # if !defined getpagesize && @HAVE_SYS_PARAM_H@
510 # include <sys/param.h>
511 # ifdef EXEC_PAGESIZE
512 # define getpagesize() EXEC_PAGESIZE
518 # define getpagesize() (NBPG * CLSIZE)
521 # define getpagesize() NBPC
527 #elif defined GNULIB_POSIXCHECK
529 # define getpagesize() \
530 (GL_LINK_WARNING ("getpagesize is unportable - " \
531 "use gnulib module getpagesize for portability"), \
536 #if @GNULIB_GETUSERSHELL@
537 # if !@HAVE_GETUSERSHELL@
538 /* Return the next valid login shell on the system, or NULL when the end of
539 the list has been reached. */
540 extern char *getusershell (void);
541 /* Rewind to pointer that is advanced at each getusershell() call. */
542 extern void setusershell (void);
543 /* Free the pointer that is advanced at each getusershell() call and
544 associated resources. */
545 extern void endusershell (void);
547 #elif defined GNULIB_POSIXCHECK
549 # define getusershell() \
550 (GL_LINK_WARNING ("getusershell is unportable - " \
551 "use gnulib module getusershell for portability"), \
554 # define setusershell() \
555 (GL_LINK_WARNING ("setusershell is unportable - " \
556 "use gnulib module getusershell for portability"), \
559 # define endusershell() \
560 (GL_LINK_WARNING ("endusershell is unportable - " \
561 "use gnulib module getusershell for portability"), \
567 # if @REPLACE_LCHOWN@
568 /* Change the owner of FILE to UID (if UID is not -1) and the group of FILE
569 to GID (if GID is not -1). Do not follow symbolic links.
570 Return 0 if successful, otherwise -1 and errno set.
571 See the POSIX:2001 specification
572 <http://www.opengroup.org/susv3xsh/lchown.html>. */
573 # define lchown rpl_lchown
574 extern int lchown (char const *file, uid_t owner, gid_t group);
576 #elif defined GNULIB_POSIXCHECK
578 # define lchown(f,u,g) \
579 (GL_LINK_WARNING ("lchown is unportable to pre-POSIX.1-2001 " \
580 "systems - use gnulib module lchown for portability"), \
587 # define link rpl_link
589 /* Create a new hard link for an existing file.
590 Return 0 if successful, otherwise -1 and errno set.
591 See POSIX:2001 specification
592 <http://www.opengroup.org/susv3xsh/link.html>. */
593 # if !@HAVE_LINK@ || @REPLACE_LINK@
594 extern int link (const char *path1, const char *path2);
596 #elif defined GNULIB_POSIXCHECK
598 # define link(path1,path2) \
599 (GL_LINK_WARNING ("link is unportable - " \
600 "use gnulib module link for portability"), \
605 # if @REPLACE_LINKAT@
607 # define linkat rpl_linkat
609 /* Create a new hard link for an existing file, relative to two
610 directories. FLAG controls whether symlinks are followed.
611 Return 0 if successful, otherwise -1 and errno set. */
612 # if !@HAVE_LINKAT@ || @REPLACE_LINKAT@
613 extern int linkat (int fd1, const char *path1, int fd2, const char *path2,
616 #elif defined GNULIB_POSIXCHECK
618 # define link(f1,path1,f2,path2,f) \
619 (GL_LINK_WARNING ("linkat is unportable - " \
620 "use gnulib module linkat for portability"), \
621 linkat (f1, path1, f2, path2,f))
626 /* Set the offset of FD relative to SEEK_SET, SEEK_CUR, or SEEK_END.
627 Return the new offset if successful, otherwise -1 and errno set.
628 See the POSIX:2001 specification
629 <http://www.opengroup.org/susv3xsh/lseek.html>. */
630 # define lseek rpl_lseek
631 extern off_t lseek (int fd, off_t offset, int whence);
633 #elif defined GNULIB_POSIXCHECK
635 # define lseek(f,o,w) \
636 (GL_LINK_WARNING ("lseek does not fail with ESPIPE on pipes on some " \
637 "systems - use gnulib module lseek for portability"), \
643 /* Create a pipe, applying the given flags when opening the read-end of the
644 pipe and the write-end of the pipe.
645 The flags are a bitmask, possibly including O_CLOEXEC (defined in <fcntl.h>)
646 and O_TEXT, O_BINARY (defined in "binary-io.h").
647 Store the read-end as fd[0] and the write-end as fd[1].
648 Return 0 upon success, or -1 with errno set upon failure.
649 See also the Linux man page at
650 <http://www.kernel.org/doc/man-pages/online/pages/man2/pipe2.2.html>. */
652 # define pipe2 rpl_pipe2
654 extern int pipe2 (int fd[2], int flags);
655 #elif defined GNULIB_POSIXCHECK
657 # define pipe2(f,o) \
658 (GL_LINK_WARNING ("pipe2 is unportable - " \
659 "use gnulib module pipe2 for portability"), \
664 #if @GNULIB_READLINK@
665 # if @REPLACE_READLINK@
666 # define readlink rpl_readlink
668 /* Read the contents of the symbolic link FILE and place the first BUFSIZE
669 bytes of it into BUF. Return the number of bytes placed into BUF if
670 successful, otherwise -1 and errno set.
671 See the POSIX:2001 specification
672 <http://www.opengroup.org/susv3xsh/readlink.html>. */
673 # if !@HAVE_READLINK@ || @REPLACE_READLINK@
674 extern ssize_t readlink (const char *file, char *buf, size_t bufsize);
676 #elif defined GNULIB_POSIXCHECK
678 # define readlink(f,b,s) \
679 (GL_LINK_WARNING ("readlink is unportable - " \
680 "use gnulib module readlink for portability"), \
685 #if @GNULIB_READLINKAT@
686 # if !@HAVE_READLINKAT@
687 ssize_t readlinkat (int fd, char const *file, char *buf, size_t len);
689 #elif defined GNULIB_POSIXCHECK
691 # define readlinkat(d,n,b,l) \
692 (GL_LINK_WARNING ("readlinkat is not portable - " \
693 "use gnulib module symlinkat for portability"), \
694 readlinkat (d, n, b, l))
700 # define rmdir rpl_rmdir
701 /* Remove the directory DIR. */
702 extern int rmdir (char const *name);
704 #elif defined GNULIB_POSIXCHECK
707 (GL_LINK_WARNING ("rmdir is unportable - " \
708 "use gnulib module rmdir for portability"), \
714 /* Pause the execution of the current thread for N seconds.
715 Returns the number of seconds left to sleep.
716 See the POSIX:2001 specification
717 <http://www.opengroup.org/susv3xsh/sleep.html>. */
719 extern unsigned int sleep (unsigned int n);
721 #elif defined GNULIB_POSIXCHECK
724 (GL_LINK_WARNING ("sleep is unportable - " \
725 "use gnulib module sleep for portability"), \
731 # if @REPLACE_SYMLINK@
733 # define symlink rpl_symlink
735 # if !@HAVE_SYMLINK@ || @REPLACE_SYMLINK@
736 int symlink (char const *contents, char const *file);
738 #elif defined GNULIB_POSIXCHECK
740 # define symlink(c,n) \
741 (GL_LINK_WARNING ("symlink is not portable - " \
742 "use gnulib module symlink for portability"), \
747 #if @GNULIB_SYMLINKAT@
748 # if !@HAVE_SYMLINKAT@
749 int symlinkat (char const *contents, int fd, char const *file);
751 #elif defined GNULIB_POSIXCHECK
753 # define symlinkat(c,d,n) \
754 (GL_LINK_WARNING ("symlinkat is not portable - " \
755 "use gnulib module symlinkat for portability"), \
761 # if @REPLACE_UNLINK@
763 # define unlink rpl_unlink
764 extern int unlink (char const *file);
766 #elif defined GNULIB_POSIXCHECK
769 (GL_LINK_WARNING ("unlink is not portable - " \
770 "use gnulib module unlink for portability"), \
775 #if @GNULIB_UNLINKAT@
776 # if @REPLACE_UNLINKAT@
778 # define unlinkat rpl_unlinkat
780 # if !@HAVE_UNLINKAT@ || @REPLACE_UNLINKAT@
781 extern int unlinkat (int fd, char const *file, int flag);
783 #elif defined GNULIB_POSIXCHECK
785 # define unlinkat(d,n,f) \
786 (GL_LINK_WARNING ("unlinkat is not portable - " \
787 "use gnulib module openat for portability"), \
792 #if @GNULIB_WRITE@ && @REPLACE_WRITE@ && @GNULIB_UNISTD_H_SIGPIPE@
793 /* Write up to COUNT bytes starting at BUF to file descriptor FD.
794 See the POSIX:2001 specification
795 <http://www.opengroup.org/susv3xsh/write.html>. */
797 # define write rpl_write
798 extern ssize_t write (int fd, const void *buf, size_t count);
807 #endif /* _GL_UNISTD_H */
808 #endif /* _GL_UNISTD_H */