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@
46 # include <sys/types.h>
49 /* Get getopt(), optarg, optind, opterr, optopt. */
50 #if @GNULIB_UNISTD_H_GETOPT@
54 #if @GNULIB_GETHOSTNAME@
55 /* Get all possible declarations of gethostname(). */
56 # if @UNISTD_H_HAVE_WINSOCK2_H@
57 # include <winsock2.h>
58 # if !defined _GL_SYS_SOCKET_H
60 # define socket socket_used_without_including_sys_socket_h
62 # define connect connect_used_without_including_sys_socket_h
64 # define accept accept_used_without_including_sys_socket_h
66 # define bind bind_used_without_including_sys_socket_h
68 # define getpeername getpeername_used_without_including_sys_socket_h
70 # define getsockname getsockname_used_without_including_sys_socket_h
72 # define getsockopt getsockopt_used_without_including_sys_socket_h
74 # define listen listen_used_without_including_sys_socket_h
76 # define recv recv_used_without_including_sys_socket_h
78 # define send send_used_without_including_sys_socket_h
80 # define recvfrom recvfrom_used_without_including_sys_socket_h
82 # define sendto sendto_used_without_including_sys_socket_h
84 # define setsockopt setsockopt_used_without_including_sys_socket_h
86 # define shutdown shutdown_used_without_including_sys_socket_h
88 # if !defined _GL_SYS_SELECT_H
90 # define select select_used_without_including_sys_select_h
95 /* The definition of GL_LINK_WARNING is copied here. */
98 /* OS/2 EMX lacks these macros. */
100 # define STDIN_FILENO 0
102 #ifndef STDOUT_FILENO
103 # define STDOUT_FILENO 1
105 #ifndef STDERR_FILENO
106 # define STDERR_FILENO 2
109 /* Declare overridden functions. */
118 # ifndef REPLACE_CHOWN
119 # define REPLACE_CHOWN 1
122 /* Change the owner of FILE to UID (if UID is not -1) and the group of FILE
123 to GID (if GID is not -1). Follow symbolic links.
124 Return 0 if successful, otherwise -1 and errno set.
125 See the POSIX:2001 specification
126 <http://www.opengroup.org/susv3xsh/chown.html>. */
127 # define chown rpl_chown
128 extern int chown (const char *file, uid_t uid, gid_t gid);
131 #elif defined GNULIB_POSIXCHECK
133 # define chown(f,u,g) \
134 (GL_LINK_WARNING ("chown fails to follow symlinks on some systems and " \
135 "doesn't treat a uid or gid of -1 on some systems - " \
136 "use gnulib module chown for portability"), \
143 /* Automatically included by modules that need a replacement for close. */
145 # define close rpl_close
146 extern int close (int);
148 #elif @UNISTD_H_HAVE_WINSOCK2_H_AND_USE_SOCKETS@
150 # define close close_used_without_requesting_gnulib_module_close
151 #elif defined GNULIB_POSIXCHECK
154 (GL_LINK_WARNING ("close does not portably work on sockets - " \
155 "use gnulib module close for portability"), \
162 # define dup2 rpl_dup2
164 # if !@HAVE_DUP2@ || @REPLACE_DUP2@
165 /* Copy the file descriptor OLDFD into file descriptor NEWFD. Do nothing if
166 NEWFD = OLDFD, otherwise close NEWFD first if it is open.
167 Return newfd if successful, otherwise -1 and errno set.
168 See the POSIX:2001 specification
169 <http://www.opengroup.org/susv3xsh/dup2.html>. */
170 extern int dup2 (int oldfd, int newfd);
172 #elif defined GNULIB_POSIXCHECK
175 (GL_LINK_WARNING ("dup2 is unportable - " \
176 "use gnulib module dup2 for portability"), \
182 /* Copy the file descriptor OLDFD into file descriptor NEWFD, with the
184 The flags are a bitmask, possibly including O_CLOEXEC (defined in <fcntl.h>)
185 and O_TEXT, O_BINARY (defined in "binary-io.h").
186 Close NEWFD first if it is open.
187 Return newfd if successful, otherwise -1 and errno set.
188 See the Linux man page at
189 <http://www.kernel.org/doc/man-pages/online/pages/man2/dup3.2.html>. */
191 # define dup3 rpl_dup3
193 extern int dup3 (int oldfd, int newfd, int flags);
194 #elif defined GNULIB_POSIXCHECK
196 # define dup3(o,n,f) \
197 (GL_LINK_WARNING ("dup3 is unportable - " \
198 "use gnulib module dup3 for portability"), \
204 # if !@HAVE_DECL_ENVIRON@
205 /* Set of environment variables and values. An array of strings of the form
206 "VARIABLE=VALUE", terminated with a NULL. */
207 # if defined __APPLE__ && defined __MACH__
208 # include <crt_externs.h>
209 # define environ (*_NSGetEnviron ())
211 extern char **environ;
214 #elif defined GNULIB_POSIXCHECK
217 (GL_LINK_WARNING ("environ is unportable - " \
218 "use gnulib module environ for portability"), \
223 #if @GNULIB_EUIDACCESS@
224 # if !@HAVE_EUIDACCESS@
225 /* Like access(), except that is uses the effective user id and group id of
226 the current process. */
227 extern int euidaccess (const char *filename, int mode);
229 #elif defined GNULIB_POSIXCHECK
231 # define euidaccess(f,m) \
232 (GL_LINK_WARNING ("euidaccess is unportable - " \
233 "use gnulib module euidaccess for portability"), \
239 # if @REPLACE_FCHDIR@
241 /* Change the process' current working directory to the directory on which
242 the given file descriptor is open.
243 Return 0 if successful, otherwise -1 and errno set.
244 See the POSIX:2001 specification
245 <http://www.opengroup.org/susv3xsh/fchdir.html>. */
246 extern int fchdir (int /*fd*/);
249 extern int dup (int);
252 #elif defined GNULIB_POSIXCHECK
255 (GL_LINK_WARNING ("fchdir is unportable - " \
256 "use gnulib module fchdir for portability"), \
262 /* Synchronize changes to a file.
263 Return 0 if successful, otherwise -1 and errno set.
264 See POSIX:2001 specification
265 <http://www.opengroup.org/susv3xsh/fsync.html>. */
267 extern int fsync (int fd);
269 #elif defined GNULIB_POSIXCHECK
272 (GL_LINK_WARNING ("fsync is unportable - " \
273 "use gnulib module fsync for portability"), \
278 #if @GNULIB_FTRUNCATE@
279 # if !@HAVE_FTRUNCATE@
280 /* Change the size of the file to which FD is opened to become equal to LENGTH.
281 Return 0 if successful, otherwise -1 and errno set.
282 See the POSIX:2001 specification
283 <http://www.opengroup.org/susv3xsh/ftruncate.html>. */
284 extern int ftruncate (int fd, off_t length);
286 #elif defined GNULIB_POSIXCHECK
288 # define ftruncate(f,l) \
289 (GL_LINK_WARNING ("ftruncate is unportable - " \
290 "use gnulib module ftruncate for portability"), \
296 /* Include the headers that might declare getcwd so that they will not
297 cause confusion if included after this file. */
299 # if @REPLACE_GETCWD@
300 /* Get the name of the current working directory, and put it in SIZE bytes
302 Return BUF if successful, or NULL if the directory couldn't be determined
303 or SIZE was too small.
304 See the POSIX:2001 specification
305 <http://www.opengroup.org/susv3xsh/getcwd.html>.
306 Additionally, the gnulib module 'getcwd' guarantees the following GNU
307 extension: If BUF is NULL, an array is allocated with 'malloc'; the array
308 is SIZE bytes long, unless SIZE == 0, in which case it is as big as
310 # define getcwd rpl_getcwd
311 extern char * getcwd (char *buf, size_t size);
313 #elif defined GNULIB_POSIXCHECK
315 # define getcwd(b,s) \
316 (GL_LINK_WARNING ("getcwd is unportable - " \
317 "use gnulib module getcwd for portability"), \
322 #if @GNULIB_GETDOMAINNAME@
323 /* Return the NIS domain name of the machine.
324 WARNING! The NIS domain name is unrelated to the fully qualified host name
325 of the machine. It is also unrelated to email addresses.
326 WARNING! The NIS domain name is usually the empty string or "(none)" when
329 Put up to LEN bytes of the NIS domain name into NAME.
330 Null terminate it if the name is shorter than LEN.
331 If the NIS domain name is longer than LEN, set errno = EINVAL and return -1.
332 Return 0 if successful, otherwise set errno and return -1. */
333 # if !@HAVE_GETDOMAINNAME@
334 extern int getdomainname(char *name, size_t len);
336 #elif defined GNULIB_POSIXCHECK
337 # undef getdomainname
338 # define getdomainname(n,l) \
339 (GL_LINK_WARNING ("getdomainname is unportable - " \
340 "use gnulib module getdomainname for portability"), \
341 getdomainname (n, l))
345 #if @GNULIB_GETDTABLESIZE@
346 # if !@HAVE_GETDTABLESIZE@
347 /* Return the maximum number of file descriptors in the current process.
348 In POSIX, this is same as sysconf (_SC_OPEN_MAX). */
349 extern int getdtablesize (void);
351 #elif defined GNULIB_POSIXCHECK
352 # undef getdtablesize
353 # define getdtablesize() \
354 (GL_LINK_WARNING ("getdtablesize is unportable - " \
355 "use gnulib module getdtablesize for portability"), \
360 #if @GNULIB_GETHOSTNAME@
361 /* Return the standard host name of the machine.
362 WARNING! The host name may or may not be fully qualified.
364 Put up to LEN bytes of the host name into NAME.
365 Null terminate it if the name is shorter than LEN.
366 If the host name is longer than LEN, set errno = EINVAL and return -1.
367 Return 0 if successful, otherwise set errno and return -1. */
368 # if @UNISTD_H_HAVE_WINSOCK2_H@
370 # define gethostname rpl_gethostname
372 # if @UNISTD_H_HAVE_WINSOCK2_H@ || !@HAVE_GETHOSTNAME@
373 extern int gethostname(char *name, size_t len);
375 #elif @UNISTD_H_HAVE_WINSOCK2_H@
377 # define gethostname gethostname_used_without_requesting_gnulib_module_gethostname
378 #elif defined GNULIB_POSIXCHECK
380 # define gethostname(n,l) \
381 (GL_LINK_WARNING ("gethostname is unportable - " \
382 "use gnulib module gethostname for portability"), \
387 #if @GNULIB_GETLOGIN_R@
388 /* Copies the user's login name to NAME.
389 The array pointed to by NAME has room for SIZE bytes.
391 Returns 0 if successful. Upon error, an error number is returned, or -1 in
392 the case that the login name cannot be found but no specific error is
393 provided (this case is hopefully rare but is left open by the POSIX spec).
395 See <http://www.opengroup.org/susv3xsh/getlogin.html>.
397 # if !@HAVE_DECL_GETLOGIN_R@
398 extern int getlogin_r (char *name, size_t size);
400 #elif defined GNULIB_POSIXCHECK
402 # define getlogin_r(n,s) \
403 (GL_LINK_WARNING ("getlogin_r is unportable - " \
404 "use gnulib module getlogin_r for portability"), \
409 #if @GNULIB_GETPAGESIZE@
410 # if @REPLACE_GETPAGESIZE@
411 # define getpagesize rpl_getpagesize
412 extern int getpagesize (void);
413 # elif !@HAVE_GETPAGESIZE@
414 /* This is for POSIX systems. */
415 # if !defined getpagesize && defined _SC_PAGESIZE
416 # if ! (defined __VMS && __VMS_VER < 70000000)
417 # define getpagesize() sysconf (_SC_PAGESIZE)
420 /* This is for older VMS. */
421 # if !defined getpagesize && defined __VMS
423 # define getpagesize() 8192
425 # define getpagesize() 512
428 /* This is for BeOS. */
429 # if !defined getpagesize && @HAVE_OS_H@
431 # if defined B_PAGE_SIZE
432 # define getpagesize() B_PAGE_SIZE
435 /* This is for AmigaOS4.0. */
436 # if !defined getpagesize && defined __amigaos4__
437 # define getpagesize() 2048
439 /* This is for older Unix systems. */
440 # if !defined getpagesize && @HAVE_SYS_PARAM_H@
441 # include <sys/param.h>
442 # ifdef EXEC_PAGESIZE
443 # define getpagesize() EXEC_PAGESIZE
449 # define getpagesize() (NBPG * CLSIZE)
452 # define getpagesize() NBPC
458 #elif defined GNULIB_POSIXCHECK
460 # define getpagesize() \
461 (GL_LINK_WARNING ("getpagesize is unportable - " \
462 "use gnulib module getpagesize for portability"), \
467 #if @GNULIB_GETUSERSHELL@
468 # if !@HAVE_GETUSERSHELL@
469 /* Return the next valid login shell on the system, or NULL when the end of
470 the list has been reached. */
471 extern char *getusershell (void);
472 /* Rewind to pointer that is advanced at each getusershell() call. */
473 extern void setusershell (void);
474 /* Free the pointer that is advanced at each getusershell() call and
475 associated resources. */
476 extern void endusershell (void);
478 #elif defined GNULIB_POSIXCHECK
480 # define getusershell() \
481 (GL_LINK_WARNING ("getusershell is unportable - " \
482 "use gnulib module getusershell for portability"), \
485 # define setusershell() \
486 (GL_LINK_WARNING ("setusershell is unportable - " \
487 "use gnulib module getusershell for portability"), \
490 # define endusershell() \
491 (GL_LINK_WARNING ("endusershell is unportable - " \
492 "use gnulib module getusershell for portability"), \
498 # if @REPLACE_LCHOWN@
499 /* Change the owner of FILE to UID (if UID is not -1) and the group of FILE
500 to GID (if GID is not -1). Do not follow symbolic links.
501 Return 0 if successful, otherwise -1 and errno set.
502 See the POSIX:2001 specification
503 <http://www.opengroup.org/susv3xsh/lchown.html>. */
504 # define lchown rpl_lchown
505 extern int lchown (char const *file, uid_t owner, gid_t group);
507 #elif defined GNULIB_POSIXCHECK
509 # define lchown(f,u,g) \
510 (GL_LINK_WARNING ("lchown is unportable to pre-POSIX.1-2001 " \
511 "systems - use gnulib module lchown for portability"), \
517 /* Create a new hard link for an existing file.
518 Return 0 if successful, otherwise -1 and errno set.
519 See POSIX:2001 specification
520 <http://www.opengroup.org/susv3xsh/link.html>. */
522 extern int link (const char *path1, const char *path2);
524 #elif defined GNULIB_POSIXCHECK
526 # define link(path1,path2) \
527 (GL_LINK_WARNING ("link is unportable - " \
528 "use gnulib module link for portability"), \
535 /* Set the offset of FD relative to SEEK_SET, SEEK_CUR, or SEEK_END.
536 Return the new offset if successful, otherwise -1 and errno set.
537 See the POSIX:2001 specification
538 <http://www.opengroup.org/susv3xsh/lseek.html>. */
539 # define lseek rpl_lseek
540 extern off_t lseek (int fd, off_t offset, int whence);
542 #elif defined GNULIB_POSIXCHECK
544 # define lseek(f,o,w) \
545 (GL_LINK_WARNING ("lseek does not fail with ESPIPE on pipes on some " \
546 "systems - use gnulib module lseek for portability"), \
552 /* Create a pipe, applying the given flags when opening the read-end of the
553 pipe and the write-end of the pipe.
554 The flags are a bitmask, possibly including O_CLOEXEC (defined in <fcntl.h>)
555 and O_TEXT, O_BINARY (defined in "binary-io.h").
556 Store the read-end as fd[0] and the write-end as fd[1].
557 Return 0 upon success, or -1 with errno set upon failure.
558 See also the Linux man page at
559 <http://www.kernel.org/doc/man-pages/online/pages/man2/pipe2.2.html>. */
561 # define pipe2 rpl_pipe2
563 extern int pipe2 (int fd[2], int flags);
564 #elif defined GNULIB_POSIXCHECK
566 # define pipe2(f,o) \
567 (GL_LINK_WARNING ("pipe2 is unportable - " \
568 "use gnulib module pipe2 for portability"), \
573 #if @GNULIB_READLINK@
574 /* Read the contents of the symbolic link FILE and place the first BUFSIZE
575 bytes of it into BUF. Return the number of bytes placed into BUF if
576 successful, otherwise -1 and errno set.
577 See the POSIX:2001 specification
578 <http://www.opengroup.org/susv3xsh/readlink.html>. */
579 # if !@HAVE_READLINK@
580 extern int readlink (const char *file, char *buf, size_t bufsize);
582 #elif defined GNULIB_POSIXCHECK
584 # define readlink(f,b,s) \
585 (GL_LINK_WARNING ("readlink is unportable - " \
586 "use gnulib module readlink for portability"), \
592 /* Pause the execution of the current thread for N seconds.
593 Returns the number of seconds left to sleep.
594 See the POSIX:2001 specification
595 <http://www.opengroup.org/susv3xsh/sleep.html>. */
597 extern unsigned int sleep (unsigned int n);
599 #elif defined GNULIB_POSIXCHECK
602 (GL_LINK_WARNING ("sleep is unportable - " \
603 "use gnulib module sleep for portability"), \
608 #if @GNULIB_WRITE@ && @REPLACE_WRITE@ && @GNULIB_UNISTD_H_SIGPIPE@
609 /* Write up to COUNT bytes starting at BUF to file descriptor FD.
610 See the POSIX:2001 specification
611 <http://www.opengroup.org/susv3xsh/write.html>. */
613 # define write rpl_write
614 extern ssize_t write (int fd, const void *buf, size_t count);
618 #ifdef FCHDIR_REPLACEMENT
619 /* gnulib internal function. */
620 extern void _gl_unregister_fd (int fd);
621 /* gnulib internal function. */
622 extern int _gl_register_dup (int oldfd, int newfd);
631 #endif /* _GL_UNISTD_H */
632 #endif /* _GL_UNISTD_H */