227105fc30c53f8b5d703cbbddbf7ca2beff66ee
[debian/tar] / gnu / safe-read.h
1 /* -*- buffer-read-only: t -*- vi: set ro: */
2 /* DO NOT EDIT! GENERATED AUTOMATICALLY! */
3 /* An interface to read() that retries after interrupts.
4    Copyright (C) 2002, 2006, 2009-2013 Free Software Foundation, Inc.
5
6    This program is free software: you can redistribute it and/or modify
7    it under the terms of the GNU General Public License as published by
8    the Free Software Foundation; either version 3 of the License, or
9    (at your option) any later version.
10
11    This program is distributed in the hope that it will be useful,
12    but WITHOUT ANY WARRANTY; without even the implied warranty of
13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14    GNU General Public License for more details.
15
16    You should have received a copy of the GNU General Public License
17    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
18
19 /* Some system calls may be interrupted and fail with errno = EINTR in the
20    following situations:
21      - The process is stopped and restarted (signal SIGSTOP and SIGCONT, user
22        types Ctrl-Z) on some platforms: Mac OS X.
23      - The process receives a signal for which a signal handler was installed
24        with sigaction() with an sa_flags field that does not contain
25        SA_RESTART.
26      - The process receives a signal for which a signal handler was installed
27        with signal() and for which no call to siginterrupt(sig,0) was done,
28        on some platforms: AIX, HP-UX, IRIX, OSF/1, Solaris.
29
30    This module provides a wrapper around read() that handles EINTR.  */
31
32 #include <stddef.h>
33
34 #ifdef __cplusplus
35 extern "C" {
36 #endif
37
38
39 #define SAFE_READ_ERROR ((size_t) -1)
40
41 /* Read up to COUNT bytes at BUF from descriptor FD, retrying if interrupted.
42    Return the actual number of bytes read, zero for EOF, or SAFE_READ_ERROR
43    upon error.  */
44 extern size_t safe_read (int fd, void *buf, size_t count);
45
46
47 #ifdef __cplusplus
48 }
49 #endif