1 /* Substitute for and wrapper around <unistd.h>.
2 Copyright (C) 2003-2010 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. */
19 @PRAGMA_SYSTEM_HEADER@
22 /* Special invocation convention:
23 - On mingw, several headers, including <winsock2.h>, include <unistd.h>,
24 but we need to ensure that both the system <unistd.h> and <winsock2.h>
25 are completely included before we replace gethostname. */
26 #if @GNULIB_GETHOSTNAME@ && @UNISTD_H_HAVE_WINSOCK2_H@ \
27 && !defined _GL_WINSOCK2_H_WITNESS && defined _WINSOCK2_H
28 /* <unistd.h> is being indirectly included for the first time from
29 <winsock2.h>; avoid declaring any overrides. */
31 # @INCLUDE_NEXT@ @NEXT_UNISTD_H@
33 # error unexpected; report this to bug-gnulib@gnu.org
35 # define _GL_WINSOCK2_H_WITNESS
37 /* Normal invocation. */
38 #elif !defined _GL_UNISTD_H
40 /* The include_next requires a split double-inclusion guard. */
42 # @INCLUDE_NEXT@ @NEXT_UNISTD_H@
45 /* Get all possible declarations of gethostname(). */
46 #if @GNULIB_GETHOSTNAME@ && @UNISTD_H_HAVE_WINSOCK2_H@ \
47 && !defined _GL_INCLUDING_WINSOCK2_H
48 # define _GL_INCLUDING_WINSOCK2_H
49 # include <winsock2.h>
50 # undef _GL_INCLUDING_WINSOCK2_H
53 #if !defined _GL_UNISTD_H && !defined _GL_INCLUDING_WINSOCK2_H
56 /* NetBSD 5.0 mis-defines NULL. Also get size_t. */
59 /* mingw doesn't define the SEEK_* or *_FILENO macros in <unistd.h>. */
60 /* Cygwin 1.7.1 declares symlinkat in <stdio.h>, not in <unistd.h>. */
61 /* But avoid namespace pollution on glibc systems. */
62 #if (!(defined SEEK_CUR && defined SEEK_END && defined SEEK_SET) \
63 || (@GNULIB_SYMLINKAT@ || defined GNULIB_POSIXCHECK)) \
64 && ! defined __GLIBC__
68 /* Cygwin 1.7.1 declares unlinkat in <fcntl.h>, not in <unistd.h>. */
69 /* But avoid namespace pollution on glibc systems. */
70 #if (@GNULIB_UNLINKAT@ || defined GNULIB_POSIXCHECK) && ! defined __GLIBC__
74 /* mingw fails to declare _exit in <unistd.h>. */
75 /* mingw, BeOS, Haiku declare environ in <stdlib.h>, not in <unistd.h>. */
76 /* Solaris declares getcwd not only in <unistd.h> but also in <stdlib.h>. */
77 /* But avoid namespace pollution on glibc systems. */
82 /* mingw declares getcwd in <io.h>, not in <unistd.h>. */
83 #if ((@GNULIB_GETCWD@ || defined GNULIB_POSIXCHECK) \
84 && ((defined _WIN32 || defined __WIN32__) && ! defined __CYGWIN__))
88 #if (@GNULIB_WRITE@ || @GNULIB_READLINK@ || @GNULIB_READLINKAT@ \
89 || @GNULIB_PREAD@ || defined GNULIB_POSIXCHECK)
91 # include <sys/types.h>
94 /* Get getopt(), optarg, optind, opterr, optopt.
95 But avoid namespace pollution on glibc systems. */
96 #if @GNULIB_UNISTD_H_GETOPT@ && !defined __GLIBC__ && !defined _GL_SYSTEM_GETOPT
100 /* The definitions of _GL_FUNCDECL_RPL etc. are copied here. */
102 /* The definition of _GL_ARG_NONNULL is copied here. */
104 /* The definition of _GL_WARN_ON_USE is copied here. */
107 #if @GNULIB_GETHOSTNAME@
108 /* Get all possible declarations of gethostname(). */
109 # if @UNISTD_H_HAVE_WINSOCK2_H@
110 # if !defined _GL_SYS_SOCKET_H
111 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
113 # define socket socket_used_without_including_sys_socket_h
115 # define connect connect_used_without_including_sys_socket_h
117 # define accept accept_used_without_including_sys_socket_h
119 # define bind bind_used_without_including_sys_socket_h
121 # define getpeername getpeername_used_without_including_sys_socket_h
123 # define getsockname getsockname_used_without_including_sys_socket_h
125 # define getsockopt getsockopt_used_without_including_sys_socket_h
127 # define listen listen_used_without_including_sys_socket_h
129 # define recv recv_used_without_including_sys_socket_h
131 # define send send_used_without_including_sys_socket_h
133 # define recvfrom recvfrom_used_without_including_sys_socket_h
135 # define sendto sendto_used_without_including_sys_socket_h
137 # define setsockopt setsockopt_used_without_including_sys_socket_h
139 # define shutdown shutdown_used_without_including_sys_socket_h
141 _GL_WARN_ON_USE (socket,
142 "socket() used without including <sys/socket.h>");
143 _GL_WARN_ON_USE (connect,
144 "connect() used without including <sys/socket.h>");
145 _GL_WARN_ON_USE (accept,
146 "accept() used without including <sys/socket.h>");
147 _GL_WARN_ON_USE (bind,
148 "bind() used without including <sys/socket.h>");
149 _GL_WARN_ON_USE (getpeername,
150 "getpeername() used without including <sys/socket.h>");
151 _GL_WARN_ON_USE (getsockname,
152 "getsockname() used without including <sys/socket.h>");
153 _GL_WARN_ON_USE (getsockopt,
154 "getsockopt() used without including <sys/socket.h>");
155 _GL_WARN_ON_USE (listen,
156 "listen() used without including <sys/socket.h>");
157 _GL_WARN_ON_USE (recv,
158 "recv() used without including <sys/socket.h>");
159 _GL_WARN_ON_USE (send,
160 "send() used without including <sys/socket.h>");
161 _GL_WARN_ON_USE (recvfrom,
162 "recvfrom() used without including <sys/socket.h>");
163 _GL_WARN_ON_USE (sendto,
164 "sendto() used without including <sys/socket.h>");
165 _GL_WARN_ON_USE (setsockopt,
166 "setsockopt() used without including <sys/socket.h>");
167 _GL_WARN_ON_USE (shutdown,
168 "shutdown() used without including <sys/socket.h>");
171 # if !defined _GL_SYS_SELECT_H
172 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
174 # define select select_used_without_including_sys_select_h
176 _GL_WARN_ON_USE (select,
177 "select() used without including <sys/select.h>");
184 /* OS/2 EMX lacks these macros. */
186 # define STDIN_FILENO 0
188 #ifndef STDOUT_FILENO
189 # define STDOUT_FILENO 1
191 #ifndef STDERR_FILENO
192 # define STDERR_FILENO 2
195 /* Ensure *_OK macros exist. */
204 /* Declare overridden functions. */
207 #if defined GNULIB_POSIXCHECK
208 /* The access() function is a security risk. */
209 _GL_WARN_ON_USE (access, "the access function is a security risk - "
210 "use the gnulib module faccessat instead");
215 /* Change the owner of FILE to UID (if UID is not -1) and the group of FILE
216 to GID (if GID is not -1). Follow symbolic links.
217 Return 0 if successful, otherwise -1 and errno set.
218 See the POSIX:2001 specification
219 <http://www.opengroup.org/susv3xsh/chown.html>. */
221 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
223 # define chown rpl_chown
225 _GL_FUNCDECL_RPL (chown, int, (const char *file, uid_t uid, gid_t gid)
226 _GL_ARG_NONNULL ((1)));
227 _GL_CXXALIAS_RPL (chown, int, (const char *file, uid_t uid, gid_t gid));
230 _GL_FUNCDECL_SYS (chown, int, (const char *file, uid_t uid, gid_t gid)
231 _GL_ARG_NONNULL ((1)));
233 _GL_CXXALIAS_SYS (chown, int, (const char *file, uid_t uid, gid_t gid));
235 _GL_CXXALIASWARN (chown);
236 #elif defined GNULIB_POSIXCHECK
238 # if HAVE_RAW_DECL_CHOWN
239 _GL_WARN_ON_USE (chown, "chown fails to follow symlinks on some systems and "
240 "doesn't treat a uid or gid of -1 on some systems - "
241 "use gnulib module chown for portability");
248 /* Automatically included by modules that need a replacement for close. */
249 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
251 # define close rpl_close
253 _GL_FUNCDECL_RPL (close, int, (int fd));
254 _GL_CXXALIAS_RPL (close, int, (int fd));
256 _GL_CXXALIAS_SYS (close, int, (int fd));
258 _GL_CXXALIASWARN (close);
259 #elif @UNISTD_H_HAVE_WINSOCK2_H_AND_USE_SOCKETS@
261 # define close close_used_without_requesting_gnulib_module_close
262 #elif defined GNULIB_POSIXCHECK
264 /* Assume close is always declared. */
265 _GL_WARN_ON_USE (close, "close does not portably work on sockets - "
266 "use gnulib module close for portability");
271 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
274 _GL_FUNCDECL_RPL (dup, int, (int oldfd));
275 _GL_CXXALIAS_RPL (dup, int, (int oldfd));
277 _GL_CXXALIAS_SYS (dup, int, (int oldfd));
279 _GL_CXXALIASWARN (dup);
283 /* Copy the file descriptor OLDFD into file descriptor NEWFD. Do nothing if
284 NEWFD = OLDFD, otherwise close NEWFD first if it is open.
285 Return newfd if successful, otherwise -1 and errno set.
286 See the POSIX:2001 specification
287 <http://www.opengroup.org/susv3xsh/dup2.html>. */
289 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
290 # define dup2 rpl_dup2
292 _GL_FUNCDECL_RPL (dup2, int, (int oldfd, int newfd));
293 _GL_CXXALIAS_RPL (dup2, int, (int oldfd, int newfd));
296 _GL_FUNCDECL_SYS (dup2, int, (int oldfd, int newfd));
298 _GL_CXXALIAS_SYS (dup2, int, (int oldfd, int newfd));
300 _GL_CXXALIASWARN (dup2);
301 #elif defined GNULIB_POSIXCHECK
303 # if HAVE_RAW_DECL_DUP2
304 _GL_WARN_ON_USE (dup2, "dup2 is unportable - "
305 "use gnulib module dup2 for portability");
311 /* Copy the file descriptor OLDFD into file descriptor NEWFD, with the
313 The flags are a bitmask, possibly including O_CLOEXEC (defined in <fcntl.h>)
314 and O_TEXT, O_BINARY (defined in "binary-io.h").
315 Close NEWFD first if it is open.
316 Return newfd if successful, otherwise -1 and errno set.
317 See the Linux man page at
318 <http://www.kernel.org/doc/man-pages/online/pages/man2/dup3.2.html>. */
320 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
321 # define dup3 rpl_dup3
323 _GL_FUNCDECL_RPL (dup3, int, (int oldfd, int newfd, int flags));
324 _GL_CXXALIAS_RPL (dup3, int, (int oldfd, int newfd, int flags));
326 _GL_FUNCDECL_SYS (dup3, int, (int oldfd, int newfd, int flags));
327 _GL_CXXALIAS_SYS (dup3, int, (int oldfd, int newfd, int flags));
329 _GL_CXXALIASWARN (dup3);
330 #elif defined GNULIB_POSIXCHECK
332 # if HAVE_RAW_DECL_DUP3
333 _GL_WARN_ON_USE (dup3, "dup3 is unportable - "
334 "use gnulib module dup3 for portability");
340 # if !@HAVE_DECL_ENVIRON@
341 /* Set of environment variables and values. An array of strings of the form
342 "VARIABLE=VALUE", terminated with a NULL. */
343 # if defined __APPLE__ && defined __MACH__
344 # include <crt_externs.h>
345 # define environ (*_NSGetEnviron ())
350 extern char **environ;
356 #elif defined GNULIB_POSIXCHECK
357 # if HAVE_RAW_DECL_ENVIRON
358 static inline char ***
363 _GL_WARN_ON_USE (rpl_environ, "environ is unportable - "
364 "use gnulib module environ for portability");
366 # define environ (*rpl_environ ())
371 #if @GNULIB_EUIDACCESS@
372 /* Like access(), except that it uses the effective user id and group id of
373 the current process. */
374 # if !@HAVE_EUIDACCESS@
375 _GL_FUNCDECL_SYS (euidaccess, int, (const char *filename, int mode)
376 _GL_ARG_NONNULL ((1)));
378 _GL_CXXALIAS_SYS (euidaccess, int, (const char *filename, int mode));
379 _GL_CXXALIASWARN (euidaccess);
380 # if defined GNULIB_POSIXCHECK
381 /* Like access(), this function is a security risk. */
382 _GL_WARN_ON_USE (euidaccess, "the euidaccess function is a security risk - "
383 "use the gnulib module faccessat instead");
385 #elif defined GNULIB_POSIXCHECK
387 # if HAVE_RAW_DECL_EUIDACCESS
388 _GL_WARN_ON_USE (euidaccess, "euidaccess is unportable - "
389 "use gnulib module euidaccess for portability");
394 #if @GNULIB_FACCESSAT@
395 # if !@HAVE_FACCESSAT@
396 _GL_FUNCDECL_SYS (faccessat, int,
397 (int fd, char const *file, int mode, int flag)
398 _GL_ARG_NONNULL ((2)));
400 _GL_CXXALIAS_SYS (faccessat, int,
401 (int fd, char const *file, int mode, int flag));
402 _GL_CXXALIASWARN (faccessat);
403 #elif defined GNULIB_POSIXCHECK
405 # if HAVE_RAW_DECL_FACCESSAT
406 _GL_WARN_ON_USE (faccessat, "faccessat is not portable - "
407 "use gnulib module faccessat for portability");
413 /* Change the process' current working directory to the directory on which
414 the given file descriptor is open.
415 Return 0 if successful, otherwise -1 and errno set.
416 See the POSIX:2001 specification
417 <http://www.opengroup.org/susv3xsh/fchdir.html>. */
418 # if @REPLACE_FCHDIR@
419 _GL_FUNCDECL_RPL (fchdir, int, (int /*fd*/));
420 _GL_CXXALIAS_RPL (fchdir, int, (int /*fd*/));
422 /* Gnulib internal hooks needed to maintain the fchdir metadata. */
423 _GL_EXTERN_C int _gl_register_fd (int fd, const char *filename)
424 _GL_ARG_NONNULL ((2));
425 _GL_EXTERN_C void _gl_unregister_fd (int fd);
426 _GL_EXTERN_C int _gl_register_dup (int oldfd, int newfd);
427 _GL_EXTERN_C const char *_gl_directory_name (int fd);
430 _GL_CXXALIAS_SYS (fchdir, int, (int /*fd*/));
432 _GL_CXXALIASWARN (fchdir);
433 #elif defined GNULIB_POSIXCHECK
435 # if HAVE_RAW_DECL_FCHDIR
436 _GL_WARN_ON_USE (fchdir, "fchdir is unportable - "
437 "use gnulib module fchdir for portability");
442 #if @GNULIB_FCHOWNAT@
443 # if @REPLACE_FCHOWNAT@
444 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
446 # define fchownat rpl_fchownat
448 _GL_FUNCDECL_RPL (fchownat, int, (int fd, char const *file,
449 uid_t owner, gid_t group, int flag)
450 _GL_ARG_NONNULL ((2)));
451 _GL_CXXALIAS_RPL (fchownat, int, (int fd, char const *file,
452 uid_t owner, gid_t group, int flag));
454 # if !@HAVE_FCHOWNAT@
455 _GL_FUNCDECL_SYS (fchownat, int, (int fd, char const *file,
456 uid_t owner, gid_t group, int flag)
457 _GL_ARG_NONNULL ((2)));
459 _GL_CXXALIAS_SYS (fchownat, int, (int fd, char const *file,
460 uid_t owner, gid_t group, int flag));
462 _GL_CXXALIASWARN (fchownat);
463 #elif defined GNULIB_POSIXCHECK
465 # if HAVE_RAW_DECL_FCHOWNAT
466 _GL_WARN_ON_USE (fchownat, "fchownat is not portable - "
467 "use gnulib module openat for portability");
473 /* Synchronize changes to a file.
474 Return 0 if successful, otherwise -1 and errno set.
475 See POSIX:2001 specification
476 <http://www.opengroup.org/susv3xsh/fsync.html>. */
478 _GL_FUNCDECL_SYS (fsync, int, (int fd));
480 _GL_CXXALIAS_SYS (fsync, int, (int fd));
481 _GL_CXXALIASWARN (fsync);
482 #elif defined GNULIB_POSIXCHECK
484 # if HAVE_RAW_DECL_FSYNC
485 _GL_WARN_ON_USE (fsync, "fsync is unportable - "
486 "use gnulib module fsync for portability");
491 #if @GNULIB_FTRUNCATE@
492 /* Change the size of the file to which FD is opened to become equal to LENGTH.
493 Return 0 if successful, otherwise -1 and errno set.
494 See the POSIX:2001 specification
495 <http://www.opengroup.org/susv3xsh/ftruncate.html>. */
496 # if !@HAVE_FTRUNCATE@
497 _GL_FUNCDECL_SYS (ftruncate, int, (int fd, off_t length));
499 _GL_CXXALIAS_SYS (ftruncate, int, (int fd, off_t length));
500 _GL_CXXALIASWARN (ftruncate);
501 #elif defined GNULIB_POSIXCHECK
503 # if HAVE_RAW_DECL_FTRUNCATE
504 _GL_WARN_ON_USE (ftruncate, "ftruncate is unportable - "
505 "use gnulib module ftruncate for portability");
511 /* Get the name of the current working directory, and put it in SIZE bytes
513 Return BUF if successful, or NULL if the directory couldn't be determined
514 or SIZE was too small.
515 See the POSIX:2001 specification
516 <http://www.opengroup.org/susv3xsh/getcwd.html>.
517 Additionally, the gnulib module 'getcwd' guarantees the following GNU
518 extension: If BUF is NULL, an array is allocated with 'malloc'; the array
519 is SIZE bytes long, unless SIZE == 0, in which case it is as big as
521 # if @REPLACE_GETCWD@
522 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
523 # define getcwd rpl_getcwd
525 _GL_FUNCDECL_RPL (getcwd, char *, (char *buf, size_t size));
526 _GL_CXXALIAS_RPL (getcwd, char *, (char *buf, size_t size));
528 /* Need to cast, because on mingw, the second parameter is
530 _GL_CXXALIAS_SYS_CAST (getcwd, char *, (char *buf, size_t size));
532 _GL_CXXALIASWARN (getcwd);
533 #elif defined GNULIB_POSIXCHECK
535 # if HAVE_RAW_DECL_GETCWD
536 _GL_WARN_ON_USE (getcwd, "getcwd is unportable - "
537 "use gnulib module getcwd for portability");
542 #if @GNULIB_GETDOMAINNAME@
543 /* Return the NIS domain name of the machine.
544 WARNING! The NIS domain name is unrelated to the fully qualified host name
545 of the machine. It is also unrelated to email addresses.
546 WARNING! The NIS domain name is usually the empty string or "(none)" when
549 Put up to LEN bytes of the NIS domain name into NAME.
550 Null terminate it if the name is shorter than LEN.
551 If the NIS domain name is longer than LEN, set errno = EINVAL and return -1.
552 Return 0 if successful, otherwise set errno and return -1. */
553 # if !@HAVE_GETDOMAINNAME@
554 _GL_FUNCDECL_SYS (getdomainname, int, (char *name, size_t len)
555 _GL_ARG_NONNULL ((1)));
557 /* Need to cast, because on MacOS X 10.5 systems, the second parameter is
559 _GL_CXXALIAS_SYS_CAST (getdomainname, int, (char *name, size_t len));
560 _GL_CXXALIASWARN (getdomainname);
561 #elif defined GNULIB_POSIXCHECK
562 # undef getdomainname
563 # if HAVE_RAW_DECL_GETDOMAINNAME
564 _GL_WARN_ON_USE (getdomainname, "getdomainname is unportable - "
565 "use gnulib module getdomainname for portability");
570 #if @GNULIB_GETDTABLESIZE@
571 /* Return the maximum number of file descriptors in the current process.
572 In POSIX, this is same as sysconf (_SC_OPEN_MAX). */
573 # if !@HAVE_GETDTABLESIZE@
574 _GL_FUNCDECL_SYS (getdtablesize, int, (void));
576 _GL_CXXALIAS_SYS (getdtablesize, int, (void));
577 _GL_CXXALIASWARN (getdtablesize);
578 #elif defined GNULIB_POSIXCHECK
579 # undef getdtablesize
580 # if HAVE_RAW_DECL_GETDTABLESIZE
581 _GL_WARN_ON_USE (getdtablesize, "getdtablesize is unportable - "
582 "use gnulib module getdtablesize for portability");
587 #if @GNULIB_GETGROUPS@
588 /* Return the supplemental groups that the current process belongs to.
589 It is unspecified whether the effective group id is in the list.
590 If N is 0, return the group count; otherwise, N describes how many
591 entries are available in GROUPS. Return -1 and set errno if N is
592 not 0 and not large enough. Fails with ENOSYS on some systems. */
593 # if @REPLACE_GETGROUPS@
594 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
596 # define getgroups rpl_getgroups
598 _GL_FUNCDECL_RPL (getgroups, int, (int n, gid_t *groups));
599 _GL_CXXALIAS_RPL (getgroups, int, (int n, gid_t *groups));
601 # if !@HAVE_GETGROUPS@
602 _GL_FUNCDECL_SYS (getgroups, int, (int n, gid_t *groups));
604 _GL_CXXALIAS_SYS (getgroups, int, (int n, gid_t *groups));
606 _GL_CXXALIASWARN (getgroups);
607 #elif defined GNULIB_POSIXCHECK
609 # if HAVE_RAW_DECL_GETGROUPS
610 _GL_WARN_ON_USE (getgroups, "getgroups is unportable - "
611 "use gnulib module getgroups for portability");
616 #if @GNULIB_GETHOSTNAME@
617 /* Return the standard host name of the machine.
618 WARNING! The host name may or may not be fully qualified.
620 Put up to LEN bytes of the host name into NAME.
621 Null terminate it if the name is shorter than LEN.
622 If the host name is longer than LEN, set errno = EINVAL and return -1.
623 Return 0 if successful, otherwise set errno and return -1. */
624 # if @UNISTD_H_HAVE_WINSOCK2_H@
625 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
627 # define gethostname rpl_gethostname
629 _GL_FUNCDECL_RPL (gethostname, int, (char *name, size_t len)
630 _GL_ARG_NONNULL ((1)));
631 _GL_CXXALIAS_RPL (gethostname, int, (char *name, size_t len));
633 # if !@HAVE_GETHOSTNAME@
634 _GL_FUNCDECL_SYS (gethostname, int, (char *name, size_t len)
635 _GL_ARG_NONNULL ((1)));
637 /* Need to cast, because on Solaris 10 systems, the second parameter is
639 _GL_CXXALIAS_SYS_CAST (gethostname, int, (char *name, size_t len));
641 _GL_CXXALIASWARN (gethostname);
642 #elif @UNISTD_H_HAVE_WINSOCK2_H@
644 # define gethostname gethostname_used_without_requesting_gnulib_module_gethostname
645 #elif defined GNULIB_POSIXCHECK
647 # if HAVE_RAW_DECL_GETHOSTNAME
648 _GL_WARN_ON_USE (gethostname, "gethostname is unportable - "
649 "use gnulib module gethostname for portability");
654 #if @GNULIB_GETLOGIN@
655 /* Returns the user's login name, or NULL if it cannot be found. Upon error,
656 returns NULL with errno set.
658 See <http://www.opengroup.org/susv3xsh/getlogin.html>.
660 Most programs don't need to use this function, because the information is
661 available through environment variables:
662 ${LOGNAME-$USER} on Unix platforms,
663 $USERNAME on native Windows platforms.
665 # if !@HAVE_GETLOGIN@
666 _GL_FUNCDECL_SYS (getlogin, char *, (void));
668 _GL_CXXALIAS_SYS (getlogin, char *, (void));
669 _GL_CXXALIASWARN (getlogin);
670 #elif defined GNULIB_POSIXCHECK
672 # if HAVE_RAW_DECL_GETLOGIN
673 _GL_WARN_ON_USE (getlogin, "getlogin is unportable - "
674 "use gnulib module getlogin for portability");
679 #if @GNULIB_GETLOGIN_R@
680 /* Copies the user's login name to NAME.
681 The array pointed to by NAME has room for SIZE bytes.
683 Returns 0 if successful. Upon error, an error number is returned, or -1 in
684 the case that the login name cannot be found but no specific error is
685 provided (this case is hopefully rare but is left open by the POSIX spec).
687 See <http://www.opengroup.org/susv3xsh/getlogin.html>.
689 Most programs don't need to use this function, because the information is
690 available through environment variables:
691 ${LOGNAME-$USER} on Unix platforms,
692 $USERNAME on native Windows platforms.
694 # if !@HAVE_DECL_GETLOGIN_R@
695 _GL_FUNCDECL_SYS (getlogin_r, int, (char *name, size_t size)
696 _GL_ARG_NONNULL ((1)));
698 /* Need to cast, because on Solaris 10 systems, the second argument is
700 _GL_CXXALIAS_SYS_CAST (getlogin_r, int, (char *name, size_t size));
701 _GL_CXXALIASWARN (getlogin_r);
702 #elif defined GNULIB_POSIXCHECK
704 # if HAVE_RAW_DECL_GETLOGIN_R
705 _GL_WARN_ON_USE (getlogin_r, "getlogin_r is unportable - "
706 "use gnulib module getlogin_r for portability");
711 #if @GNULIB_GETPAGESIZE@
712 # if @REPLACE_GETPAGESIZE@
713 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
714 # define getpagesize rpl_getpagesize
716 _GL_FUNCDECL_RPL (getpagesize, int, (void));
717 _GL_CXXALIAS_RPL (getpagesize, int, (void));
719 # if !@HAVE_GETPAGESIZE@
720 # if !defined getpagesize
721 /* This is for POSIX systems. */
722 # if !defined _gl_getpagesize && defined _SC_PAGESIZE
723 # if ! (defined __VMS && __VMS_VER < 70000000)
724 # define _gl_getpagesize() sysconf (_SC_PAGESIZE)
727 /* This is for older VMS. */
728 # if !defined _gl_getpagesize && defined __VMS
730 # define _gl_getpagesize() 8192
732 # define _gl_getpagesize() 512
735 /* This is for BeOS. */
736 # if !defined _gl_getpagesize && @HAVE_OS_H@
738 # if defined B_PAGE_SIZE
739 # define _gl_getpagesize() B_PAGE_SIZE
742 /* This is for AmigaOS4.0. */
743 # if !defined _gl_getpagesize && defined __amigaos4__
744 # define _gl_getpagesize() 2048
746 /* This is for older Unix systems. */
747 # if !defined _gl_getpagesize && @HAVE_SYS_PARAM_H@
748 # include <sys/param.h>
749 # ifdef EXEC_PAGESIZE
750 # define _gl_getpagesize() EXEC_PAGESIZE
756 # define _gl_getpagesize() (NBPG * CLSIZE)
759 # define _gl_getpagesize() NBPC
764 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
765 # define getpagesize() _gl_getpagesize ()
770 return _gl_getpagesize ();
775 /* Need to cast, because on Cygwin 1.5.x systems, the return type is size_t. */
776 _GL_CXXALIAS_SYS_CAST (getpagesize, int, (void));
778 _GL_CXXALIASWARN (getpagesize);
779 #elif defined GNULIB_POSIXCHECK
781 # if HAVE_RAW_DECL_GETPAGESIZE
782 _GL_WARN_ON_USE (getpagesize, "getpagesize is unportable - "
783 "use gnulib module getpagesize for portability");
788 #if @GNULIB_GETUSERSHELL@
789 /* Return the next valid login shell on the system, or NULL when the end of
790 the list has been reached. */
791 # if !@HAVE_DECL_GETUSERSHELL@
792 _GL_FUNCDECL_SYS (getusershell, char *, (void));
794 _GL_CXXALIAS_SYS (getusershell, char *, (void));
795 _GL_CXXALIASWARN (getusershell);
796 #elif defined GNULIB_POSIXCHECK
798 # if HAVE_RAW_DECL_GETUSERSHELL
799 _GL_WARN_ON_USE (getusershell, "getusershell is unportable - "
800 "use gnulib module getusershell for portability");
804 #if @GNULIB_GETUSERSHELL@
805 /* Rewind to pointer that is advanced at each getusershell() call. */
806 # if !@HAVE_DECL_GETUSERSHELL@
807 _GL_FUNCDECL_SYS (setusershell, void, (void));
809 _GL_CXXALIAS_SYS (setusershell, void, (void));
810 _GL_CXXALIASWARN (setusershell);
811 #elif defined GNULIB_POSIXCHECK
813 # if HAVE_RAW_DECL_SETUSERSHELL
814 _GL_WARN_ON_USE (setusershell, "setusershell is unportable - "
815 "use gnulib module getusershell for portability");
819 #if @GNULIB_GETUSERSHELL@
820 /* Free the pointer that is advanced at each getusershell() call and
821 associated resources. */
822 # if !@HAVE_DECL_GETUSERSHELL@
823 _GL_FUNCDECL_SYS (endusershell, void, (void));
825 _GL_CXXALIAS_SYS (endusershell, void, (void));
826 _GL_CXXALIASWARN (endusershell);
827 #elif defined GNULIB_POSIXCHECK
829 # if HAVE_RAW_DECL_ENDUSERSHELL
830 _GL_WARN_ON_USE (endusershell, "endusershell is unportable - "
831 "use gnulib module getusershell for portability");
837 /* Change the owner of FILE to UID (if UID is not -1) and the group of FILE
838 to GID (if GID is not -1). Do not follow symbolic links.
839 Return 0 if successful, otherwise -1 and errno set.
840 See the POSIX:2001 specification
841 <http://www.opengroup.org/susv3xsh/lchown.html>. */
842 # if @REPLACE_LCHOWN@
843 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
845 # define lchown rpl_lchown
847 _GL_FUNCDECL_RPL (lchown, int, (char const *file, uid_t owner, gid_t group)
848 _GL_ARG_NONNULL ((1)));
849 _GL_CXXALIAS_RPL (lchown, int, (char const *file, uid_t owner, gid_t group));
852 _GL_FUNCDECL_SYS (lchown, int, (char const *file, uid_t owner, gid_t group)
853 _GL_ARG_NONNULL ((1)));
855 _GL_CXXALIAS_SYS (lchown, int, (char const *file, uid_t owner, gid_t group));
857 _GL_CXXALIASWARN (lchown);
858 #elif defined GNULIB_POSIXCHECK
860 # if HAVE_RAW_DECL_LCHOWN
861 _GL_WARN_ON_USE (lchown, "lchown is unportable to pre-POSIX.1-2001 systems - "
862 "use gnulib module lchown for portability");
868 /* Create a new hard link for an existing file.
869 Return 0 if successful, otherwise -1 and errno set.
870 See POSIX:2001 specification
871 <http://www.opengroup.org/susv3xsh/link.html>. */
873 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
874 # define link rpl_link
876 _GL_FUNCDECL_RPL (link, int, (const char *path1, const char *path2)
877 _GL_ARG_NONNULL ((1, 2)));
878 _GL_CXXALIAS_RPL (link, int, (const char *path1, const char *path2));
881 _GL_FUNCDECL_SYS (link, int, (const char *path1, const char *path2)
882 _GL_ARG_NONNULL ((1, 2)));
884 _GL_CXXALIAS_SYS (link, int, (const char *path1, const char *path2));
886 _GL_CXXALIASWARN (link);
887 #elif defined GNULIB_POSIXCHECK
889 # if HAVE_RAW_DECL_LINK
890 _GL_WARN_ON_USE (link, "link is unportable - "
891 "use gnulib module link for portability");
897 /* Create a new hard link for an existing file, relative to two
898 directories. FLAG controls whether symlinks are followed.
899 Return 0 if successful, otherwise -1 and errno set. */
900 # if @REPLACE_LINKAT@
901 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
903 # define linkat rpl_linkat
905 _GL_FUNCDECL_RPL (linkat, int,
906 (int fd1, const char *path1, int fd2, const char *path2,
908 _GL_ARG_NONNULL ((2, 4)));
909 _GL_CXXALIAS_RPL (linkat, int,
910 (int fd1, const char *path1, int fd2, const char *path2,
914 _GL_FUNCDECL_SYS (linkat, int,
915 (int fd1, const char *path1, int fd2, const char *path2,
917 _GL_ARG_NONNULL ((2, 4)));
919 _GL_CXXALIAS_SYS (linkat, int,
920 (int fd1, const char *path1, int fd2, const char *path2,
923 _GL_CXXALIASWARN (linkat);
924 #elif defined GNULIB_POSIXCHECK
926 # if HAVE_RAW_DECL_LINKAT
927 _GL_WARN_ON_USE (linkat, "linkat is unportable - "
928 "use gnulib module linkat for portability");
934 /* Set the offset of FD relative to SEEK_SET, SEEK_CUR, or SEEK_END.
935 Return the new offset if successful, otherwise -1 and errno set.
936 See the POSIX:2001 specification
937 <http://www.opengroup.org/susv3xsh/lseek.html>. */
939 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
940 # define lseek rpl_lseek
942 _GL_FUNCDECL_RPL (lseek, off_t, (int fd, off_t offset, int whence));
943 _GL_CXXALIAS_RPL (lseek, off_t, (int fd, off_t offset, int whence));
945 _GL_CXXALIAS_SYS (lseek, off_t, (int fd, off_t offset, int whence));
947 _GL_CXXALIASWARN (lseek);
948 #elif defined GNULIB_POSIXCHECK
950 # if HAVE_RAW_DECL_LSEEK
951 _GL_WARN_ON_USE (lseek, "lseek does not fail with ESPIPE on pipes on some "
952 "systems - use gnulib module lseek for portability");
958 /* Create a pipe, applying the given flags when opening the read-end of the
959 pipe and the write-end of the pipe.
960 The flags are a bitmask, possibly including O_CLOEXEC (defined in <fcntl.h>)
961 and O_TEXT, O_BINARY (defined in "binary-io.h").
962 Store the read-end as fd[0] and the write-end as fd[1].
963 Return 0 upon success, or -1 with errno set upon failure.
964 See also the Linux man page at
965 <http://www.kernel.org/doc/man-pages/online/pages/man2/pipe2.2.html>. */
967 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
968 # define pipe2 rpl_pipe2
970 _GL_FUNCDECL_RPL (pipe2, int, (int fd[2], int flags) _GL_ARG_NONNULL ((1)));
971 _GL_CXXALIAS_RPL (pipe2, int, (int fd[2], int flags));
973 _GL_FUNCDECL_SYS (pipe2, int, (int fd[2], int flags) _GL_ARG_NONNULL ((1)));
974 _GL_CXXALIAS_SYS (pipe2, int, (int fd[2], int flags));
976 _GL_CXXALIASWARN (pipe2);
977 #elif defined GNULIB_POSIXCHECK
979 # if HAVE_RAW_DECL_PIPE2
980 _GL_WARN_ON_USE (pipe2, "pipe2 is unportable - "
981 "use gnulib module pipe2 for portability");
987 /* Read at most BUFSIZE bytes from FD into BUF, starting at OFFSET.
988 Return the number of bytes placed into BUF if successful, otherwise
989 set errno and return -1. 0 indicates EOF. See the POSIX:2001
990 specification <http://www.opengroup.org/susv3xsh/pread.html>. */
992 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
993 # define pread rpl_pread
995 _GL_FUNCDECL_RPL (pread, ssize_t,
996 (int fd, void *buf, size_t bufsize, off_t offset)
997 _GL_ARG_NONNULL ((2)));
998 _GL_CXXALIAS_RPL (pread, ssize_t,
999 (int fd, void *buf, size_t bufsize, off_t offset));
1002 _GL_FUNCDECL_SYS (pread, ssize_t,
1003 (int fd, void *buf, size_t bufsize, off_t offset)
1004 _GL_ARG_NONNULL ((2)));
1006 _GL_CXXALIAS_SYS (pread, ssize_t,
1007 (int fd, void *buf, size_t bufsize, off_t offset));
1009 _GL_CXXALIASWARN (pread);
1010 #elif defined GNULIB_POSIXCHECK
1012 # if HAVE_RAW_DECL_PREAD
1013 _GL_WARN_ON_USE (pread, "pread is unportable - "
1014 "use gnulib module pread for portability");
1019 #if @GNULIB_READLINK@
1020 /* Read the contents of the symbolic link FILE and place the first BUFSIZE
1021 bytes of it into BUF. Return the number of bytes placed into BUF if
1022 successful, otherwise -1 and errno set.
1023 See the POSIX:2001 specification
1024 <http://www.opengroup.org/susv3xsh/readlink.html>. */
1025 # if @REPLACE_READLINK@
1026 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
1027 # define readlink rpl_readlink
1029 _GL_FUNCDECL_RPL (readlink, ssize_t,
1030 (const char *file, char *buf, size_t bufsize)
1031 _GL_ARG_NONNULL ((1, 2)));
1032 _GL_CXXALIAS_RPL (readlink, ssize_t,
1033 (const char *file, char *buf, size_t bufsize));
1035 # if !@HAVE_READLINK@
1036 _GL_FUNCDECL_SYS (readlink, ssize_t,
1037 (const char *file, char *buf, size_t bufsize)
1038 _GL_ARG_NONNULL ((1, 2)));
1040 _GL_CXXALIAS_SYS (readlink, ssize_t,
1041 (const char *file, char *buf, size_t bufsize));
1043 _GL_CXXALIASWARN (readlink);
1044 #elif defined GNULIB_POSIXCHECK
1046 # if HAVE_RAW_DECL_READLINK
1047 _GL_WARN_ON_USE (readlink, "readlink is unportable - "
1048 "use gnulib module readlink for portability");
1053 #if @GNULIB_READLINKAT@
1054 # if !@HAVE_READLINKAT@
1055 _GL_FUNCDECL_SYS (readlinkat, ssize_t,
1056 (int fd, char const *file, char *buf, size_t len)
1057 _GL_ARG_NONNULL ((2, 3)));
1059 _GL_CXXALIAS_SYS (readlinkat, ssize_t,
1060 (int fd, char const *file, char *buf, size_t len));
1061 _GL_CXXALIASWARN (readlinkat);
1062 #elif defined GNULIB_POSIXCHECK
1064 # if HAVE_RAW_DECL_READLINKAT
1065 _GL_WARN_ON_USE (readlinkat, "readlinkat is not portable - "
1066 "use gnulib module symlinkat for portability");
1072 /* Remove the directory DIR. */
1073 # if @REPLACE_RMDIR@
1074 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
1075 # define rmdir rpl_rmdir
1077 _GL_FUNCDECL_RPL (rmdir, int, (char const *name) _GL_ARG_NONNULL ((1)));
1078 _GL_CXXALIAS_RPL (rmdir, int, (char const *name));
1080 _GL_CXXALIAS_SYS (rmdir, int, (char const *name));
1082 _GL_CXXALIASWARN (rmdir);
1083 #elif defined GNULIB_POSIXCHECK
1085 # if HAVE_RAW_DECL_RMDIR
1086 _GL_WARN_ON_USE (rmdir, "rmdir is unportable - "
1087 "use gnulib module rmdir for portability");
1093 /* Pause the execution of the current thread for N seconds.
1094 Returns the number of seconds left to sleep.
1095 See the POSIX:2001 specification
1096 <http://www.opengroup.org/susv3xsh/sleep.html>. */
1097 # if @REPLACE_SLEEP@
1098 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
1100 # define sleep rpl_sleep
1102 _GL_FUNCDECL_RPL (sleep, unsigned int, (unsigned int n));
1103 _GL_CXXALIAS_RPL (sleep, unsigned int, (unsigned int n));
1106 _GL_FUNCDECL_SYS (sleep, unsigned int, (unsigned int n));
1108 _GL_CXXALIAS_SYS (sleep, unsigned int, (unsigned int n));
1110 _GL_CXXALIASWARN (sleep);
1111 #elif defined GNULIB_POSIXCHECK
1113 # if HAVE_RAW_DECL_SLEEP
1114 _GL_WARN_ON_USE (sleep, "sleep is unportable - "
1115 "use gnulib module sleep for portability");
1120 #if @GNULIB_SYMLINK@
1121 # if @REPLACE_SYMLINK@
1122 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
1124 # define symlink rpl_symlink
1126 _GL_FUNCDECL_RPL (symlink, int, (char const *contents, char const *file)
1127 _GL_ARG_NONNULL ((1, 2)));
1128 _GL_CXXALIAS_RPL (symlink, int, (char const *contents, char const *file));
1130 # if !@HAVE_SYMLINK@
1131 _GL_FUNCDECL_SYS (symlink, int, (char const *contents, char const *file)
1132 _GL_ARG_NONNULL ((1, 2)));
1134 _GL_CXXALIAS_SYS (symlink, int, (char const *contents, char const *file));
1136 _GL_CXXALIASWARN (symlink);
1137 #elif defined GNULIB_POSIXCHECK
1139 # if HAVE_RAW_DECL_SYMLINK
1140 _GL_WARN_ON_USE (symlink, "symlink is not portable - "
1141 "use gnulib module symlink for portability");
1146 #if @GNULIB_SYMLINKAT@
1147 # if !@HAVE_SYMLINKAT@
1148 _GL_FUNCDECL_SYS (symlinkat, int,
1149 (char const *contents, int fd, char const *file)
1150 _GL_ARG_NONNULL ((1, 3)));
1152 _GL_CXXALIAS_SYS (symlinkat, int,
1153 (char const *contents, int fd, char const *file));
1154 _GL_CXXALIASWARN (symlinkat);
1155 #elif defined GNULIB_POSIXCHECK
1157 # if HAVE_RAW_DECL_SYMLINKAT
1158 _GL_WARN_ON_USE (symlinkat, "symlinkat is not portable - "
1159 "use gnulib module symlinkat for portability");
1164 #if @GNULIB_TTYNAME_R@
1165 /* Store at most BUFLEN characters of the pathname of the terminal FD is
1166 open on in BUF. Return 0 on success, otherwise an error number. */
1167 # if !@HAVE_TTYNAME_R@
1168 _GL_FUNCDECL_SYS (ttyname_r, int,
1169 (int fd, char *buf, size_t buflen) _GL_ARG_NONNULL ((2)));
1171 _GL_CXXALIAS_SYS (ttyname_r, int,
1172 (int fd, char *buf, size_t buflen));
1173 _GL_CXXALIASWARN (ttyname_r);
1174 #elif defined GNULIB_POSIXCHECK
1176 # if HAVE_RAW_DECL_TTYNAME_R
1177 _GL_WARN_ON_USE (ttyname_r, "ttyname_r is not portable - "
1178 "use gnulib module ttyname_r for portability");
1184 # if @REPLACE_UNLINK@
1185 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
1187 # define unlink rpl_unlink
1189 _GL_FUNCDECL_RPL (unlink, int, (char const *file) _GL_ARG_NONNULL ((1)));
1190 _GL_CXXALIAS_RPL (unlink, int, (char const *file));
1192 _GL_CXXALIAS_SYS (unlink, int, (char const *file));
1194 _GL_CXXALIASWARN (unlink);
1195 #elif defined GNULIB_POSIXCHECK
1197 # if HAVE_RAW_DECL_UNLINK
1198 _GL_WARN_ON_USE (unlink, "unlink is not portable - "
1199 "use gnulib module unlink for portability");
1204 #if @GNULIB_UNLINKAT@
1205 # if @REPLACE_UNLINKAT@
1206 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
1208 # define unlinkat rpl_unlinkat
1210 _GL_FUNCDECL_RPL (unlinkat, int, (int fd, char const *file, int flag)
1211 _GL_ARG_NONNULL ((2)));
1212 _GL_CXXALIAS_RPL (unlinkat, int, (int fd, char const *file, int flag));
1214 # if !@HAVE_UNLINKAT@
1215 _GL_FUNCDECL_SYS (unlinkat, int, (int fd, char const *file, int flag)
1216 _GL_ARG_NONNULL ((2)));
1218 _GL_CXXALIAS_SYS (unlinkat, int, (int fd, char const *file, int flag));
1220 _GL_CXXALIASWARN (unlinkat);
1221 #elif defined GNULIB_POSIXCHECK
1223 # if HAVE_RAW_DECL_UNLINKAT
1224 _GL_WARN_ON_USE (unlinkat, "unlinkat is not portable - "
1225 "use gnulib module openat for portability");
1231 /* Pause the execution of the current thread for N microseconds.
1232 Returns 0 on completion, or -1 on range error.
1233 See the POSIX:2001 specification
1234 <http://www.opengroup.org/susv3xsh/sleep.html>. */
1235 # if @REPLACE_USLEEP@
1236 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
1238 # define usleep rpl_usleep
1240 _GL_FUNCDECL_RPL (usleep, int, (useconds_t n));
1241 _GL_CXXALIAS_RPL (usleep, int, (useconds_t n));
1244 _GL_FUNCDECL_SYS (usleep, int, (useconds_t n));
1246 _GL_CXXALIAS_SYS (usleep, int, (useconds_t n));
1248 _GL_CXXALIASWARN (usleep);
1249 #elif defined GNULIB_POSIXCHECK
1251 # if HAVE_RAW_DECL_USLEEP
1252 _GL_WARN_ON_USE (usleep, "usleep is unportable - "
1253 "use gnulib module usleep for portability");
1259 /* Write up to COUNT bytes starting at BUF to file descriptor FD.
1260 See the POSIX:2001 specification
1261 <http://www.opengroup.org/susv3xsh/write.html>. */
1262 # if @REPLACE_WRITE@ && @GNULIB_UNISTD_H_SIGPIPE@
1263 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
1265 # define write rpl_write
1267 _GL_FUNCDECL_RPL (write, ssize_t, (int fd, const void *buf, size_t count)
1268 _GL_ARG_NONNULL ((2)));
1269 _GL_CXXALIAS_RPL (write, ssize_t, (int fd, const void *buf, size_t count));
1271 _GL_CXXALIAS_SYS (write, ssize_t, (int fd, const void *buf, size_t count));
1273 _GL_CXXALIASWARN (write);
1277 #endif /* _GL_UNISTD_H */
1278 #endif /* _GL_UNISTD_H */