New module 'pipe2'.
[pspp] / lib / unistd.in.h
1 /* Substitute for and wrapper around <unistd.h>.
2    Copyright (C) 2003-2009 Free Software Foundation, Inc.
3
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)
7    any later version.
8
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.
13
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.  */
17
18 #ifndef _GL_UNISTD_H
19
20 #if __GNUC__ >= 3
21 @PRAGMA_SYSTEM_HEADER@
22 #endif
23
24 /* The include_next requires a split double-inclusion guard.  */
25 #if @HAVE_UNISTD_H@
26 # @INCLUDE_NEXT@ @NEXT_UNISTD_H@
27 #endif
28
29 #ifndef _GL_UNISTD_H
30 #define _GL_UNISTD_H
31
32 /* NetBSD 5.0 mis-defines NULL.  Also get size_t.  */
33 #include <stddef.h>
34
35 /* mingw doesn't define the SEEK_* or *_FILENO macros in <unistd.h>.  */
36 #if !(defined SEEK_CUR && defined SEEK_END && defined SEEK_SET)
37 # include <stdio.h>
38 #endif
39
40 /* mingw fails to declare _exit in <unistd.h>.  */
41 /* mingw, BeOS, Haiku declare environ in <stdlib.h>, not in <unistd.h>.  */
42 #include <stdlib.h>
43
44 #if @GNULIB_WRITE@ && @REPLACE_WRITE@ && @GNULIB_UNISTD_H_SIGPIPE@
45 /* Get ssize_t.  */
46 # include <sys/types.h>
47 #endif
48
49 /* Get getopt(), optarg, optind, opterr, optopt.  */
50 #if @GNULIB_UNISTD_H_GETOPT@
51 # include <getopt.h>
52 #endif
53
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
59 #   undef socket
60 #   define socket               socket_used_without_including_sys_socket_h
61 #   undef connect
62 #   define connect              connect_used_without_including_sys_socket_h
63 #   undef accept
64 #   define accept               accept_used_without_including_sys_socket_h
65 #   undef bind
66 #   define bind                 bind_used_without_including_sys_socket_h
67 #   undef getpeername
68 #   define getpeername          getpeername_used_without_including_sys_socket_h
69 #   undef getsockname
70 #   define getsockname          getsockname_used_without_including_sys_socket_h
71 #   undef getsockopt
72 #   define getsockopt           getsockopt_used_without_including_sys_socket_h
73 #   undef listen
74 #   define listen               listen_used_without_including_sys_socket_h
75 #   undef recv
76 #   define recv                 recv_used_without_including_sys_socket_h
77 #   undef send
78 #   define send                 send_used_without_including_sys_socket_h
79 #   undef recvfrom
80 #   define recvfrom             recvfrom_used_without_including_sys_socket_h
81 #   undef sendto
82 #   define sendto               sendto_used_without_including_sys_socket_h
83 #   undef setsockopt
84 #   define setsockopt           setsockopt_used_without_including_sys_socket_h
85 #   undef shutdown
86 #   define shutdown             shutdown_used_without_including_sys_socket_h
87 #  endif
88 #  if !defined _GL_SYS_SELECT_H
89 #   undef select
90 #   define select               select_used_without_including_sys_select_h
91 #  endif
92 # endif
93 #endif
94
95 /* The definition of GL_LINK_WARNING is copied here.  */
96
97
98 /* OS/2 EMX lacks these macros.  */
99 #ifndef STDIN_FILENO
100 # define STDIN_FILENO 0
101 #endif
102 #ifndef STDOUT_FILENO
103 # define STDOUT_FILENO 1
104 #endif
105 #ifndef STDERR_FILENO
106 # define STDERR_FILENO 2
107 #endif
108
109 /* Declare overridden functions.  */
110
111 #ifdef __cplusplus
112 extern "C" {
113 #endif
114
115
116 #if @GNULIB_CHOWN@
117 # if @REPLACE_CHOWN@
118 #  ifndef REPLACE_CHOWN
119 #   define REPLACE_CHOWN 1
120 #  endif
121 #  if REPLACE_CHOWN
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);
129 #  endif
130 # endif
131 #elif defined GNULIB_POSIXCHECK
132 # undef chown
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"), \
137      chown (f, u, g))
138 #endif
139
140
141 #if @GNULIB_CLOSE@
142 # if @REPLACE_CLOSE@
143 /* Automatically included by modules that need a replacement for close.  */
144 #  undef close
145 #  define close rpl_close
146 extern int close (int);
147 # endif
148 #elif @UNISTD_H_HAVE_WINSOCK2_H_AND_USE_SOCKETS@
149 # undef close
150 # define close close_used_without_requesting_gnulib_module_close
151 #elif defined GNULIB_POSIXCHECK
152 # undef close
153 # define close(f) \
154     (GL_LINK_WARNING ("close does not portably work on sockets - " \
155                       "use gnulib module close for portability"), \
156      close (f))
157 #endif
158
159
160 #if @GNULIB_DUP2@
161 # if @REPLACE_DUP2@
162 #  define dup2 rpl_dup2
163 # endif
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);
171 # endif
172 #elif defined GNULIB_POSIXCHECK
173 # undef dup2
174 # define dup2(o,n) \
175     (GL_LINK_WARNING ("dup2 is unportable - " \
176                       "use gnulib module dup2 for portability"), \
177      dup2 (o, n))
178 #endif
179
180
181 #if @GNULIB_ENVIRON@
182 # if !@HAVE_DECL_ENVIRON@
183 /* Set of environment variables and values.  An array of strings of the form
184    "VARIABLE=VALUE", terminated with a NULL.  */
185 #  if defined __APPLE__ && defined __MACH__
186 #   include <crt_externs.h>
187 #   define environ (*_NSGetEnviron ())
188 #  else
189 extern char **environ;
190 #  endif
191 # endif
192 #elif defined GNULIB_POSIXCHECK
193 # undef environ
194 # define environ \
195     (GL_LINK_WARNING ("environ is unportable - " \
196                       "use gnulib module environ for portability"), \
197      environ)
198 #endif
199
200
201 #if @GNULIB_EUIDACCESS@
202 # if !@HAVE_EUIDACCESS@
203 /* Like access(), except that is uses the effective user id and group id of
204    the current process.  */
205 extern int euidaccess (const char *filename, int mode);
206 # endif
207 #elif defined GNULIB_POSIXCHECK
208 # undef euidaccess
209 # define euidaccess(f,m) \
210     (GL_LINK_WARNING ("euidaccess is unportable - " \
211                       "use gnulib module euidaccess for portability"), \
212      euidaccess (f, m))
213 #endif
214
215
216 #if @GNULIB_FCHDIR@
217 # if @REPLACE_FCHDIR@
218
219 /* Change the process' current working directory to the directory on which
220    the given file descriptor is open.
221    Return 0 if successful, otherwise -1 and errno set.
222    See the POSIX:2001 specification
223    <http://www.opengroup.org/susv3xsh/fchdir.html>.  */
224 extern int fchdir (int /*fd*/);
225
226 #  define dup rpl_dup
227 extern int dup (int);
228
229 #  if @REPLACE_DUP2@
230 #   undef dup2
231 #  endif
232 #  define dup2 rpl_dup2_fchdir
233 extern int dup2 (int, int);
234
235 # endif
236 #elif defined GNULIB_POSIXCHECK
237 # undef fchdir
238 # define fchdir(f) \
239     (GL_LINK_WARNING ("fchdir is unportable - " \
240                       "use gnulib module fchdir for portability"), \
241      fchdir (f))
242 #endif
243
244
245 #if @GNULIB_FSYNC@
246 /* Synchronize changes to a file.
247    Return 0 if successful, otherwise -1 and errno set.
248    See POSIX:2001 specification
249    <http://www.opengroup.org/susv3xsh/fsync.html>.  */
250 # if !@HAVE_FSYNC@
251 extern int fsync (int fd);
252 # endif
253 #elif defined GNULIB_POSIXCHECK
254 # undef fsync
255 # define fsync(fd) \
256     (GL_LINK_WARNING ("fsync is unportable - " \
257                       "use gnulib module fsync for portability"), \
258      fsync (fd))
259 #endif
260
261
262 #if @GNULIB_FTRUNCATE@
263 # if !@HAVE_FTRUNCATE@
264 /* Change the size of the file to which FD is opened to become equal to LENGTH.
265    Return 0 if successful, otherwise -1 and errno set.
266    See the POSIX:2001 specification
267    <http://www.opengroup.org/susv3xsh/ftruncate.html>.  */
268 extern int ftruncate (int fd, off_t length);
269 # endif
270 #elif defined GNULIB_POSIXCHECK
271 # undef ftruncate
272 # define ftruncate(f,l) \
273     (GL_LINK_WARNING ("ftruncate is unportable - " \
274                       "use gnulib module ftruncate for portability"), \
275      ftruncate (f, l))
276 #endif
277
278
279 #if @GNULIB_GETCWD@
280 /* Include the headers that might declare getcwd so that they will not
281    cause confusion if included after this file.  */
282 # include <stdlib.h>
283 # if @REPLACE_GETCWD@
284 /* Get the name of the current working directory, and put it in SIZE bytes
285    of BUF.
286    Return BUF if successful, or NULL if the directory couldn't be determined
287    or SIZE was too small.
288    See the POSIX:2001 specification
289    <http://www.opengroup.org/susv3xsh/getcwd.html>.
290    Additionally, the gnulib module 'getcwd' guarantees the following GNU
291    extension: If BUF is NULL, an array is allocated with 'malloc'; the array
292    is SIZE bytes long, unless SIZE == 0, in which case it is as big as
293    necessary.  */
294 #  define getcwd rpl_getcwd
295 extern char * getcwd (char *buf, size_t size);
296 # endif
297 #elif defined GNULIB_POSIXCHECK
298 # undef getcwd
299 # define getcwd(b,s) \
300     (GL_LINK_WARNING ("getcwd is unportable - " \
301                       "use gnulib module getcwd for portability"), \
302      getcwd (b, s))
303 #endif
304
305
306 #if @GNULIB_GETDOMAINNAME@
307 /* Return the NIS domain name of the machine.
308    WARNING! The NIS domain name is unrelated to the fully qualified host name
309             of the machine.  It is also unrelated to email addresses.
310    WARNING! The NIS domain name is usually the empty string or "(none)" when
311             not using NIS.
312
313    Put up to LEN bytes of the NIS domain name into NAME.
314    Null terminate it if the name is shorter than LEN.
315    If the NIS domain name is longer than LEN, set errno = EINVAL and return -1.
316    Return 0 if successful, otherwise set errno and return -1.  */
317 # if !@HAVE_GETDOMAINNAME@
318 extern int getdomainname(char *name, size_t len);
319 # endif
320 #elif defined GNULIB_POSIXCHECK
321 # undef getdomainname
322 # define getdomainname(n,l) \
323     (GL_LINK_WARNING ("getdomainname is unportable - " \
324                       "use gnulib module getdomainname for portability"), \
325      getdomainname (n, l))
326 #endif
327
328
329 #if @GNULIB_GETDTABLESIZE@
330 # if !@HAVE_GETDTABLESIZE@
331 /* Return the maximum number of file descriptors in the current process.  */
332 extern int getdtablesize (void);
333 # endif
334 #elif defined GNULIB_POSIXCHECK
335 # undef getdtablesize
336 # define getdtablesize() \
337     (GL_LINK_WARNING ("getdtablesize is unportable - " \
338                       "use gnulib module getdtablesize for portability"), \
339      getdtablesize ())
340 #endif
341
342
343 #if @GNULIB_GETHOSTNAME@
344 /* Return the standard host name of the machine.
345    WARNING! The host name may or may not be fully qualified.
346
347    Put up to LEN bytes of the host name into NAME.
348    Null terminate it if the name is shorter than LEN.
349    If the host name is longer than LEN, set errno = EINVAL and return -1.
350    Return 0 if successful, otherwise set errno and return -1.  */
351 # if @UNISTD_H_HAVE_WINSOCK2_H@
352 #  undef gethostname
353 #  define gethostname rpl_gethostname
354 # endif
355 # if @UNISTD_H_HAVE_WINSOCK2_H@ || !@HAVE_GETHOSTNAME@
356 extern int gethostname(char *name, size_t len);
357 # endif
358 #elif @UNISTD_H_HAVE_WINSOCK2_H@
359 # undef gethostname
360 # define gethostname gethostname_used_without_requesting_gnulib_module_gethostname
361 #elif defined GNULIB_POSIXCHECK
362 # undef gethostname
363 # define gethostname(n,l) \
364     (GL_LINK_WARNING ("gethostname is unportable - " \
365                       "use gnulib module gethostname for portability"), \
366      gethostname (n, l))
367 #endif
368
369
370 #if @GNULIB_GETLOGIN_R@
371 /* Copies the user's login name to NAME.
372    The array pointed to by NAME has room for SIZE bytes.
373
374    Returns 0 if successful.  Upon error, an error number is returned, or -1 in
375    the case that the login name cannot be found but no specific error is
376    provided (this case is hopefully rare but is left open by the POSIX spec).
377
378    See <http://www.opengroup.org/susv3xsh/getlogin.html>.
379  */
380 # if !@HAVE_DECL_GETLOGIN_R@
381 extern int getlogin_r (char *name, size_t size);
382 # endif
383 #elif defined GNULIB_POSIXCHECK
384 # undef getlogin_r
385 # define getlogin_r(n,s) \
386     (GL_LINK_WARNING ("getlogin_r is unportable - " \
387                       "use gnulib module getlogin_r for portability"), \
388      getlogin_r (n, s))
389 #endif
390
391
392 #if @GNULIB_GETPAGESIZE@
393 # if @REPLACE_GETPAGESIZE@
394 #  define getpagesize rpl_getpagesize
395 extern int getpagesize (void);
396 # elif !@HAVE_GETPAGESIZE@
397 /* This is for POSIX systems.  */
398 #  if !defined getpagesize && defined _SC_PAGESIZE
399 #   if ! (defined __VMS && __VMS_VER < 70000000)
400 #    define getpagesize() sysconf (_SC_PAGESIZE)
401 #   endif
402 #  endif
403 /* This is for older VMS.  */
404 #  if !defined getpagesize && defined __VMS
405 #   ifdef __ALPHA
406 #    define getpagesize() 8192
407 #   else
408 #    define getpagesize() 512
409 #   endif
410 #  endif
411 /* This is for BeOS.  */
412 #  if !defined getpagesize && @HAVE_OS_H@
413 #   include <OS.h>
414 #   if defined B_PAGE_SIZE
415 #    define getpagesize() B_PAGE_SIZE
416 #   endif
417 #  endif
418 /* This is for AmigaOS4.0.  */
419 #  if !defined getpagesize && defined __amigaos4__
420 #   define getpagesize() 2048
421 #  endif
422 /* This is for older Unix systems.  */
423 #  if !defined getpagesize && @HAVE_SYS_PARAM_H@
424 #   include <sys/param.h>
425 #   ifdef EXEC_PAGESIZE
426 #    define getpagesize() EXEC_PAGESIZE
427 #   else
428 #    ifdef NBPG
429 #     ifndef CLSIZE
430 #      define CLSIZE 1
431 #     endif
432 #     define getpagesize() (NBPG * CLSIZE)
433 #    else
434 #     ifdef NBPC
435 #      define getpagesize() NBPC
436 #     endif
437 #    endif
438 #   endif
439 #  endif
440 # endif
441 #elif defined GNULIB_POSIXCHECK
442 # undef getpagesize
443 # define getpagesize() \
444     (GL_LINK_WARNING ("getpagesize is unportable - " \
445                       "use gnulib module getpagesize for portability"), \
446      getpagesize ())
447 #endif
448
449
450 #if @GNULIB_GETUSERSHELL@
451 # if !@HAVE_GETUSERSHELL@
452 /* Return the next valid login shell on the system, or NULL when the end of
453    the list has been reached.  */
454 extern char *getusershell (void);
455 /* Rewind to pointer that is advanced at each getusershell() call.  */
456 extern void setusershell (void);
457 /* Free the pointer that is advanced at each getusershell() call and
458    associated resources.  */
459 extern void endusershell (void);
460 # endif
461 #elif defined GNULIB_POSIXCHECK
462 # undef getusershell
463 # define getusershell() \
464     (GL_LINK_WARNING ("getusershell is unportable - " \
465                       "use gnulib module getusershell for portability"), \
466      getusershell ())
467 # undef setusershell
468 # define setusershell() \
469     (GL_LINK_WARNING ("setusershell is unportable - " \
470                       "use gnulib module getusershell for portability"), \
471      setusershell ())
472 # undef endusershell
473 # define endusershell() \
474     (GL_LINK_WARNING ("endusershell is unportable - " \
475                       "use gnulib module getusershell for portability"), \
476      endusershell ())
477 #endif
478
479
480 #if @GNULIB_LCHOWN@
481 # if @REPLACE_LCHOWN@
482 /* Change the owner of FILE to UID (if UID is not -1) and the group of FILE
483    to GID (if GID is not -1).  Do not follow symbolic links.
484    Return 0 if successful, otherwise -1 and errno set.
485    See the POSIX:2001 specification
486    <http://www.opengroup.org/susv3xsh/lchown.html>.  */
487 #  define lchown rpl_lchown
488 extern int lchown (char const *file, uid_t owner, gid_t group);
489 # endif
490 #elif defined GNULIB_POSIXCHECK
491 # undef lchown
492 # define lchown(f,u,g) \
493     (GL_LINK_WARNING ("lchown is unportable to pre-POSIX.1-2001 " \
494                       "systems - use gnulib module lchown for portability"), \
495      lchown (f, u, g))
496 #endif
497
498
499 #if @GNULIB_LINK@
500 /* Create a new hard link for an existing file.
501    Return 0 if successful, otherwise -1 and errno set.
502    See POSIX:2001 specification
503    <http://www.opengroup.org/susv3xsh/link.html>.  */
504 # if !@HAVE_LINK@
505 extern int link (const char *path1, const char *path2);
506 # endif
507 #elif defined GNULIB_POSIXCHECK
508 # undef link
509 # define link(path1,path2) \
510     (GL_LINK_WARNING ("link is unportable - " \
511                       "use gnulib module link for portability"), \
512      link (path1, path2))
513 #endif
514
515
516 #if @GNULIB_LSEEK@
517 # if @REPLACE_LSEEK@
518 /* Set the offset of FD relative to SEEK_SET, SEEK_CUR, or SEEK_END.
519    Return the new offset if successful, otherwise -1 and errno set.
520    See the POSIX:2001 specification
521    <http://www.opengroup.org/susv3xsh/lseek.html>.  */
522 #  define lseek rpl_lseek
523    extern off_t lseek (int fd, off_t offset, int whence);
524 # endif
525 #elif defined GNULIB_POSIXCHECK
526 # undef lseek
527 # define lseek(f,o,w) \
528     (GL_LINK_WARNING ("lseek does not fail with ESPIPE on pipes on some " \
529                       "systems - use gnulib module lseek for portability"), \
530      lseek (f, o, w))
531 #endif
532
533
534 #if @GNULIB_PIPE2@
535 /* Create a pipe, applying the given flags when opening the read-end of the
536    pipe and the write-end of the pipe.
537    The flags are a bitmask, possibly including O_CLOEXEC (defined in <fcntl.h>)
538    and O_TEXT, O_BINARY (defined in "binary-io.h").
539    Store the read-end as fd[0] and the write-end as fd[1].
540    Return 0 upon success, or -1 with errno set upon failure.  */
541 # if !@HAVE_PIPE2@
542 extern int pipe2 (int fd[2], int flags);
543 # endif
544 #elif defined GNULIB_POSIXCHECK
545 # undef pipe2
546 # define pipe2(f,o) \
547     (GL_LINK_WARNING ("pipe2 is unportable - " \
548                       "use gnulib module pipe2 for portability"), \
549      pipe2 (f, o))
550 #endif
551
552
553 #if @GNULIB_READLINK@
554 /* Read the contents of the symbolic link FILE and place the first BUFSIZE
555    bytes of it into BUF.  Return the number of bytes placed into BUF if
556    successful, otherwise -1 and errno set.
557    See the POSIX:2001 specification
558    <http://www.opengroup.org/susv3xsh/readlink.html>.  */
559 # if !@HAVE_READLINK@
560 extern int readlink (const char *file, char *buf, size_t bufsize);
561 # endif
562 #elif defined GNULIB_POSIXCHECK
563 # undef readlink
564 # define readlink(f,b,s) \
565     (GL_LINK_WARNING ("readlink is unportable - " \
566                       "use gnulib module readlink for portability"), \
567      readlink (f, b, s))
568 #endif
569
570
571 #if @GNULIB_SLEEP@
572 /* Pause the execution of the current thread for N seconds.
573    Returns the number of seconds left to sleep.
574    See the POSIX:2001 specification
575    <http://www.opengroup.org/susv3xsh/sleep.html>.  */
576 # if !@HAVE_SLEEP@
577 extern unsigned int sleep (unsigned int n);
578 # endif
579 #elif defined GNULIB_POSIXCHECK
580 # undef sleep
581 # define sleep(n) \
582     (GL_LINK_WARNING ("sleep is unportable - " \
583                       "use gnulib module sleep for portability"), \
584      sleep (n))
585 #endif
586
587
588 #if @GNULIB_WRITE@ && @REPLACE_WRITE@ && @GNULIB_UNISTD_H_SIGPIPE@
589 /* Write up to COUNT bytes starting at BUF to file descriptor FD.
590    See the POSIX:2001 specification
591    <http://www.opengroup.org/susv3xsh/write.html>.  */
592 # undef write
593 # define write rpl_write
594 extern ssize_t write (int fd, const void *buf, size_t count);
595 #endif
596
597
598 #ifdef FCHDIR_REPLACEMENT
599 /* gnulib internal function.  */
600 extern void _gl_unregister_fd (int fd);
601 #endif
602
603
604 #ifdef __cplusplus
605 }
606 #endif
607
608
609 #endif /* _GL_UNISTD_H */
610 #endif /* _GL_UNISTD_H */