annotate lib/full-write.c @ 5159:a535859efd14

Merge from coreutils.
author Paul Eggert <eggert@cs.ucla.edu>
date Sat, 07 Aug 2004 00:09:38 +0000
parents 96e52fc820a5
children a48fb0e98c8c
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4140
40c9aa461079 Rework so that it may serve to define full_read, too.
Jim Meyering <jim@meyering.net>
parents: 4002
diff changeset
1 /* An interface to read and write that retries (if necessary) until complete.
3403
9ab12ba48e48 Correct credits, as cccp.c no longer
Jim Meyering <jim@meyering.net>
parents: 2460
diff changeset
2
5159
a535859efd14 Merge from coreutils.
Paul Eggert <eggert@cs.ucla.edu>
parents: 4144
diff changeset
3 Copyright (C) 1993, 1994, 1997, 1998, 1999, 2000, 2001, 2002, 2003,
a535859efd14 Merge from coreutils.
Paul Eggert <eggert@cs.ucla.edu>
parents: 4144
diff changeset
4 2004 Free Software Foundation, Inc.
179
Jim Meyering <jim@meyering.net>
parents:
diff changeset
5
Jim Meyering <jim@meyering.net>
parents:
diff changeset
6 This program is free software; you can redistribute it and/or modify
Jim Meyering <jim@meyering.net>
parents:
diff changeset
7 it under the terms of the GNU General Public License as published by
Jim Meyering <jim@meyering.net>
parents:
diff changeset
8 the Free Software Foundation; either version 2, or (at your option)
Jim Meyering <jim@meyering.net>
parents:
diff changeset
9 any later version.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
10
Jim Meyering <jim@meyering.net>
parents:
diff changeset
11 This program is distributed in the hope that it will be useful,
Jim Meyering <jim@meyering.net>
parents:
diff changeset
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
Jim Meyering <jim@meyering.net>
parents:
diff changeset
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
Jim Meyering <jim@meyering.net>
parents:
diff changeset
14 GNU General Public License for more details.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
15
Jim Meyering <jim@meyering.net>
parents:
diff changeset
16 You should have received a copy of the GNU General Public License
640
d60db0e1c0d9 Libit tweaks.
Jim Meyering <jim@meyering.net>
parents: 557
diff changeset
17 along with this program; if not, write to the Free Software Foundation,
4002
9fcf64c770ed Orthogonal approach to read()/write() that handles EINTR and counts > 2^31
Bruno Haible <bruno@clisp.org>
parents: 3403
diff changeset
18 Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */
179
Jim Meyering <jim@meyering.net>
parents:
diff changeset
19
720
Jim Meyering <jim@meyering.net>
parents: 640
diff changeset
20 #if HAVE_CONFIG_H
640
d60db0e1c0d9 Libit tweaks.
Jim Meyering <jim@meyering.net>
parents: 557
diff changeset
21 # include <config.h>
179
Jim Meyering <jim@meyering.net>
parents:
diff changeset
22 #endif
Jim Meyering <jim@meyering.net>
parents:
diff changeset
23
4144
96e52fc820a5 Include specification first.
Bruno Haible <bruno@clisp.org>
parents: 4142
diff changeset
24 /* Specification. */
96e52fc820a5 Include specification first.
Bruno Haible <bruno@clisp.org>
parents: 4142
diff changeset
25 #ifdef FULL_READ
96e52fc820a5 Include specification first.
Bruno Haible <bruno@clisp.org>
parents: 4142
diff changeset
26 # include "full-read.h"
96e52fc820a5 Include specification first.
Bruno Haible <bruno@clisp.org>
parents: 4142
diff changeset
27 #else
96e52fc820a5 Include specification first.
Bruno Haible <bruno@clisp.org>
parents: 4142
diff changeset
28 # include "full-write.h"
96e52fc820a5 Include specification first.
Bruno Haible <bruno@clisp.org>
parents: 4142
diff changeset
29 #endif
96e52fc820a5 Include specification first.
Bruno Haible <bruno@clisp.org>
parents: 4142
diff changeset
30
4142
1e52316e571b Undefine and define-away `const' after inclusion
Jim Meyering <jim@meyering.net>
parents: 4140
diff changeset
31 #include <errno.h>
1e52316e571b Undefine and define-away `const' after inclusion
Jim Meyering <jim@meyering.net>
parents: 4140
diff changeset
32
4140
40c9aa461079 Rework so that it may serve to define full_read, too.
Jim Meyering <jim@meyering.net>
parents: 4002
diff changeset
33 #ifdef FULL_READ
40c9aa461079 Rework so that it may serve to define full_read, too.
Jim Meyering <jim@meyering.net>
parents: 4002
diff changeset
34 # include "safe-read.h"
40c9aa461079 Rework so that it may serve to define full_read, too.
Jim Meyering <jim@meyering.net>
parents: 4002
diff changeset
35 # define safe_rw safe_read
40c9aa461079 Rework so that it may serve to define full_read, too.
Jim Meyering <jim@meyering.net>
parents: 4002
diff changeset
36 # define full_rw full_read
40c9aa461079 Rework so that it may serve to define full_read, too.
Jim Meyering <jim@meyering.net>
parents: 4002
diff changeset
37 # undef const
40c9aa461079 Rework so that it may serve to define full_read, too.
Jim Meyering <jim@meyering.net>
parents: 4002
diff changeset
38 # define const /* empty */
40c9aa461079 Rework so that it may serve to define full_read, too.
Jim Meyering <jim@meyering.net>
parents: 4002
diff changeset
39 #else
40c9aa461079 Rework so that it may serve to define full_read, too.
Jim Meyering <jim@meyering.net>
parents: 4002
diff changeset
40 # include "safe-write.h"
40c9aa461079 Rework so that it may serve to define full_read, too.
Jim Meyering <jim@meyering.net>
parents: 4002
diff changeset
41 # define safe_rw safe_write
40c9aa461079 Rework so that it may serve to define full_read, too.
Jim Meyering <jim@meyering.net>
parents: 4002
diff changeset
42 # define full_rw full_write
40c9aa461079 Rework so that it may serve to define full_read, too.
Jim Meyering <jim@meyering.net>
parents: 4002
diff changeset
43 #endif
3403
9ab12ba48e48 Correct credits, as cccp.c no longer
Jim Meyering <jim@meyering.net>
parents: 2460
diff changeset
44
4140
40c9aa461079 Rework so that it may serve to define full_read, too.
Jim Meyering <jim@meyering.net>
parents: 4002
diff changeset
45 #ifdef FULL_READ
40c9aa461079 Rework so that it may serve to define full_read, too.
Jim Meyering <jim@meyering.net>
parents: 4002
diff changeset
46 /* Set errno to zero upon EOF. */
40c9aa461079 Rework so that it may serve to define full_read, too.
Jim Meyering <jim@meyering.net>
parents: 4002
diff changeset
47 # define ZERO_BYTE_TRANSFER_ERRNO 0
40c9aa461079 Rework so that it may serve to define full_read, too.
Jim Meyering <jim@meyering.net>
parents: 4002
diff changeset
48 #else
40c9aa461079 Rework so that it may serve to define full_read, too.
Jim Meyering <jim@meyering.net>
parents: 4002
diff changeset
49 /* Some buggy drivers return 0 when one tries to write beyond
40c9aa461079 Rework so that it may serve to define full_read, too.
Jim Meyering <jim@meyering.net>
parents: 4002
diff changeset
50 a device's end. (Example: Linux 1.2.13 on /dev/fd0.)
40c9aa461079 Rework so that it may serve to define full_read, too.
Jim Meyering <jim@meyering.net>
parents: 4002
diff changeset
51 Set errno to ENOSPC so they get a sensible diagnostic. */
40c9aa461079 Rework so that it may serve to define full_read, too.
Jim Meyering <jim@meyering.net>
parents: 4002
diff changeset
52 # define ZERO_BYTE_TRANSFER_ERRNO ENOSPC
40c9aa461079 Rework so that it may serve to define full_read, too.
Jim Meyering <jim@meyering.net>
parents: 4002
diff changeset
53 #endif
4002
9fcf64c770ed Orthogonal approach to read()/write() that handles EINTR and counts > 2^31
Bruno Haible <bruno@clisp.org>
parents: 3403
diff changeset
54
4140
40c9aa461079 Rework so that it may serve to define full_read, too.
Jim Meyering <jim@meyering.net>
parents: 4002
diff changeset
55 /* Write(read) COUNT bytes at BUF to(from) descriptor FD, retrying if
40c9aa461079 Rework so that it may serve to define full_read, too.
Jim Meyering <jim@meyering.net>
parents: 4002
diff changeset
56 interrupted or if a partial write(read) occurs. Return the number
40c9aa461079 Rework so that it may serve to define full_read, too.
Jim Meyering <jim@meyering.net>
parents: 4002
diff changeset
57 of bytes transferred.
40c9aa461079 Rework so that it may serve to define full_read, too.
Jim Meyering <jim@meyering.net>
parents: 4002
diff changeset
58 When writing, set errno if fewer than COUNT bytes are written.
40c9aa461079 Rework so that it may serve to define full_read, too.
Jim Meyering <jim@meyering.net>
parents: 4002
diff changeset
59 When reading, if fewer than COUNT bytes are read, you must examine
40c9aa461079 Rework so that it may serve to define full_read, too.
Jim Meyering <jim@meyering.net>
parents: 4002
diff changeset
60 errno to distinguish failure from EOF (errno == 0). */
3403
9ab12ba48e48 Correct credits, as cccp.c no longer
Jim Meyering <jim@meyering.net>
parents: 2460
diff changeset
61 size_t
4140
40c9aa461079 Rework so that it may serve to define full_read, too.
Jim Meyering <jim@meyering.net>
parents: 4002
diff changeset
62 full_rw (int fd, const void *buf, size_t count)
179
Jim Meyering <jim@meyering.net>
parents:
diff changeset
63 {
4140
40c9aa461079 Rework so that it may serve to define full_read, too.
Jim Meyering <jim@meyering.net>
parents: 4002
diff changeset
64 size_t total = 0;
40c9aa461079 Rework so that it may serve to define full_read, too.
Jim Meyering <jim@meyering.net>
parents: 4002
diff changeset
65 const char *ptr = buf;
181
Jim Meyering <jim@meyering.net>
parents: 180
diff changeset
66
4140
40c9aa461079 Rework so that it may serve to define full_read, too.
Jim Meyering <jim@meyering.net>
parents: 4002
diff changeset
67 while (count > 0)
179
Jim Meyering <jim@meyering.net>
parents:
diff changeset
68 {
4140
40c9aa461079 Rework so that it may serve to define full_read, too.
Jim Meyering <jim@meyering.net>
parents: 4002
diff changeset
69 size_t n_rw = safe_rw (fd, ptr, count);
40c9aa461079 Rework so that it may serve to define full_read, too.
Jim Meyering <jim@meyering.net>
parents: 4002
diff changeset
70 if (n_rw == (size_t) -1)
40c9aa461079 Rework so that it may serve to define full_read, too.
Jim Meyering <jim@meyering.net>
parents: 4002
diff changeset
71 break;
40c9aa461079 Rework so that it may serve to define full_read, too.
Jim Meyering <jim@meyering.net>
parents: 4002
diff changeset
72 if (n_rw == 0)
179
Jim Meyering <jim@meyering.net>
parents:
diff changeset
73 {
4140
40c9aa461079 Rework so that it may serve to define full_read, too.
Jim Meyering <jim@meyering.net>
parents: 4002
diff changeset
74 errno = ZERO_BYTE_TRANSFER_ERRNO;
40c9aa461079 Rework so that it may serve to define full_read, too.
Jim Meyering <jim@meyering.net>
parents: 4002
diff changeset
75 break;
179
Jim Meyering <jim@meyering.net>
parents:
diff changeset
76 }
4140
40c9aa461079 Rework so that it may serve to define full_read, too.
Jim Meyering <jim@meyering.net>
parents: 4002
diff changeset
77 total += n_rw;
40c9aa461079 Rework so that it may serve to define full_read, too.
Jim Meyering <jim@meyering.net>
parents: 4002
diff changeset
78 ptr += n_rw;
40c9aa461079 Rework so that it may serve to define full_read, too.
Jim Meyering <jim@meyering.net>
parents: 4002
diff changeset
79 count -= n_rw;
179
Jim Meyering <jim@meyering.net>
parents:
diff changeset
80 }
4002
9fcf64c770ed Orthogonal approach to read()/write() that handles EINTR and counts > 2^31
Bruno Haible <bruno@clisp.org>
parents: 3403
diff changeset
81
4140
40c9aa461079 Rework so that it may serve to define full_read, too.
Jim Meyering <jim@meyering.net>
parents: 4002
diff changeset
82 return total;
179
Jim Meyering <jim@meyering.net>
parents:
diff changeset
83 }