annotate lib/stat-size.h @ 17249:e542fd46ad6f

maint: update all copyright year number ranges Run "make update-copyright". Compare to commit 1602f0a from last year. Signed-off-by: Eric Blake <eblake@redhat.com>
author Eric Blake <eblake@redhat.com>
date Tue, 01 Jan 2013 00:50:58 +0000
parents 82db61e229ef
children 344018b6e5d7
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
14902
16c748720b01 New module 'stat-size'.
James Youngman <jay@gnu.org>
parents:
diff changeset
1 /* macros useful in interpreting size-related values in struct stat.
17249
e542fd46ad6f maint: update all copyright year number ranges
Eric Blake <eblake@redhat.com>
parents: 16832
diff changeset
2 Copyright (C) 1989, 1991-2013 Free Software Foundation, Inc.
14902
16c748720b01 New module 'stat-size'.
James Youngman <jay@gnu.org>
parents:
diff changeset
3
16c748720b01 New module 'stat-size'.
James Youngman <jay@gnu.org>
parents:
diff changeset
4 This program is free software: you can redistribute it and/or modify
16c748720b01 New module 'stat-size'.
James Youngman <jay@gnu.org>
parents:
diff changeset
5 it under the terms of the GNU General Public License as published by
16c748720b01 New module 'stat-size'.
James Youngman <jay@gnu.org>
parents:
diff changeset
6 the Free Software Foundation, either version 3 of the License, or
16c748720b01 New module 'stat-size'.
James Youngman <jay@gnu.org>
parents:
diff changeset
7 (at your option) any later version.
16c748720b01 New module 'stat-size'.
James Youngman <jay@gnu.org>
parents:
diff changeset
8
16c748720b01 New module 'stat-size'.
James Youngman <jay@gnu.org>
parents:
diff changeset
9 This program is distributed in the hope that it will be useful,
16c748720b01 New module 'stat-size'.
James Youngman <jay@gnu.org>
parents:
diff changeset
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
16c748720b01 New module 'stat-size'.
James Youngman <jay@gnu.org>
parents:
diff changeset
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16c748720b01 New module 'stat-size'.
James Youngman <jay@gnu.org>
parents:
diff changeset
12 GNU General Public License for more details.
16c748720b01 New module 'stat-size'.
James Youngman <jay@gnu.org>
parents:
diff changeset
13
16c748720b01 New module 'stat-size'.
James Youngman <jay@gnu.org>
parents:
diff changeset
14 You should have received a copy of the GNU General Public License
16c748720b01 New module 'stat-size'.
James Youngman <jay@gnu.org>
parents:
diff changeset
15 along with this program. If not, see <http://www.gnu.org/licenses/>. */
16c748720b01 New module 'stat-size'.
James Youngman <jay@gnu.org>
parents:
diff changeset
16 /*
16c748720b01 New module 'stat-size'.
James Youngman <jay@gnu.org>
parents:
diff changeset
17 Macros defined by this file (s is an rvalue of type struct stat):
16c748720b01 New module 'stat-size'.
James Youngman <jay@gnu.org>
parents:
diff changeset
18
16c748720b01 New module 'stat-size'.
James Youngman <jay@gnu.org>
parents:
diff changeset
19 DEV_BSIZE: The device blocksize. But use ST_NBLOCKSIZE instead.
16c748720b01 New module 'stat-size'.
James Youngman <jay@gnu.org>
parents:
diff changeset
20 ST_BLKSIZE(s): Preferred (in the sense of best performance) I/O blocksize
16c748720b01 New module 'stat-size'.
James Youngman <jay@gnu.org>
parents:
diff changeset
21 for the file, in bytes.
16c748720b01 New module 'stat-size'.
James Youngman <jay@gnu.org>
parents:
diff changeset
22 ST_NBLOCKS(s): Number of blocks in the file, including indirect blocks.
16c748720b01 New module 'stat-size'.
James Youngman <jay@gnu.org>
parents:
diff changeset
23 ST_NBLOCKSIZE: Size of blocks used when calculating ST_NBLOCKS.
16c748720b01 New module 'stat-size'.
James Youngman <jay@gnu.org>
parents:
diff changeset
24 */
16c748720b01 New module 'stat-size'.
James Youngman <jay@gnu.org>
parents:
diff changeset
25 #ifndef STAT_SIZE_H
16c748720b01 New module 'stat-size'.
James Youngman <jay@gnu.org>
parents:
diff changeset
26 #define STAT_SIZE_H
16c748720b01 New module 'stat-size'.
James Youngman <jay@gnu.org>
parents:
diff changeset
27
16c748720b01 New module 'stat-size'.
James Youngman <jay@gnu.org>
parents:
diff changeset
28 /* sys/param.h may define DEV_BSIZE */
16c748720b01 New module 'stat-size'.
James Youngman <jay@gnu.org>
parents:
diff changeset
29 #if HAVE_SYS_PARAM_H
16c748720b01 New module 'stat-size'.
James Youngman <jay@gnu.org>
parents:
diff changeset
30 # include <sys/param.h>
16c748720b01 New module 'stat-size'.
James Youngman <jay@gnu.org>
parents:
diff changeset
31 #endif
16c748720b01 New module 'stat-size'.
James Youngman <jay@gnu.org>
parents:
diff changeset
32
16c748720b01 New module 'stat-size'.
James Youngman <jay@gnu.org>
parents:
diff changeset
33
16c748720b01 New module 'stat-size'.
James Youngman <jay@gnu.org>
parents:
diff changeset
34 /* Get or fake the disk device blocksize.
16c748720b01 New module 'stat-size'.
James Youngman <jay@gnu.org>
parents:
diff changeset
35 Usually defined by sys/param.h (if at all). */
16c748720b01 New module 'stat-size'.
James Youngman <jay@gnu.org>
parents:
diff changeset
36 #if !defined DEV_BSIZE && defined BSIZE
16c748720b01 New module 'stat-size'.
James Youngman <jay@gnu.org>
parents:
diff changeset
37 # define DEV_BSIZE BSIZE
16c748720b01 New module 'stat-size'.
James Youngman <jay@gnu.org>
parents:
diff changeset
38 #endif
16c748720b01 New module 'stat-size'.
James Youngman <jay@gnu.org>
parents:
diff changeset
39 #if !defined DEV_BSIZE && defined BBSIZE /* SGI sys/param.h */
16c748720b01 New module 'stat-size'.
James Youngman <jay@gnu.org>
parents:
diff changeset
40 # define DEV_BSIZE BBSIZE
16c748720b01 New module 'stat-size'.
James Youngman <jay@gnu.org>
parents:
diff changeset
41 #endif
16c748720b01 New module 'stat-size'.
James Youngman <jay@gnu.org>
parents:
diff changeset
42 #ifndef DEV_BSIZE
16c748720b01 New module 'stat-size'.
James Youngman <jay@gnu.org>
parents:
diff changeset
43 # define DEV_BSIZE 4096
16c748720b01 New module 'stat-size'.
James Youngman <jay@gnu.org>
parents:
diff changeset
44 #endif
16c748720b01 New module 'stat-size'.
James Youngman <jay@gnu.org>
parents:
diff changeset
45
16c748720b01 New module 'stat-size'.
James Youngman <jay@gnu.org>
parents:
diff changeset
46
16c748720b01 New module 'stat-size'.
James Youngman <jay@gnu.org>
parents:
diff changeset
47
16235
18a38c9615f0 In commentary, do not use ` to quote.
Paul Eggert <eggert@cs.ucla.edu>
parents: 16201
diff changeset
48 /* Extract or fake data from a 'struct stat'.
14902
16c748720b01 New module 'stat-size'.
James Youngman <jay@gnu.org>
parents:
diff changeset
49 ST_BLKSIZE: Preferred I/O blocksize for the file, in bytes.
16c748720b01 New module 'stat-size'.
James Youngman <jay@gnu.org>
parents:
diff changeset
50 ST_NBLOCKS: Number of blocks in the file, including indirect blocks.
16c748720b01 New module 'stat-size'.
James Youngman <jay@gnu.org>
parents:
diff changeset
51 ST_NBLOCKSIZE: Size of blocks used when calculating ST_NBLOCKS. */
16c748720b01 New module 'stat-size'.
James Youngman <jay@gnu.org>
parents:
diff changeset
52 #ifndef HAVE_STRUCT_STAT_ST_BLOCKS
16c748720b01 New module 'stat-size'.
James Youngman <jay@gnu.org>
parents:
diff changeset
53 # define ST_BLKSIZE(statbuf) DEV_BSIZE
16c748720b01 New module 'stat-size'.
James Youngman <jay@gnu.org>
parents:
diff changeset
54 /* coreutils' fileblocks.c also uses BSIZE. */
16c748720b01 New module 'stat-size'.
James Youngman <jay@gnu.org>
parents:
diff changeset
55 # if defined _POSIX_SOURCE || !defined BSIZE
16c748720b01 New module 'stat-size'.
James Youngman <jay@gnu.org>
parents:
diff changeset
56 # define ST_NBLOCKS(statbuf) \
16c748720b01 New module 'stat-size'.
James Youngman <jay@gnu.org>
parents:
diff changeset
57 ((statbuf).st_size / ST_NBLOCKSIZE + ((statbuf).st_size % ST_NBLOCKSIZE != 0))
16c748720b01 New module 'stat-size'.
James Youngman <jay@gnu.org>
parents:
diff changeset
58 # else
16c748720b01 New module 'stat-size'.
James Youngman <jay@gnu.org>
parents:
diff changeset
59 /* This definition calls st_blocks, which is in the fileblocks module. */
16c748720b01 New module 'stat-size'.
James Youngman <jay@gnu.org>
parents:
diff changeset
60 # define ST_NBLOCKS(statbuf) \
16c748720b01 New module 'stat-size'.
James Youngman <jay@gnu.org>
parents:
diff changeset
61 (S_ISREG ((statbuf).st_mode) || S_ISDIR ((statbuf).st_mode) ? \
16c748720b01 New module 'stat-size'.
James Youngman <jay@gnu.org>
parents:
diff changeset
62 st_blocks ((statbuf).st_size) : 0)
16c748720b01 New module 'stat-size'.
James Youngman <jay@gnu.org>
parents:
diff changeset
63 # endif
16c748720b01 New module 'stat-size'.
James Youngman <jay@gnu.org>
parents:
diff changeset
64 #else
16c748720b01 New module 'stat-size'.
James Youngman <jay@gnu.org>
parents:
diff changeset
65 /* Some systems, like Sequents, return st_blksize of 0 on pipes.
16235
18a38c9615f0 In commentary, do not use ` to quote.
Paul Eggert <eggert@cs.ucla.edu>
parents: 16201
diff changeset
66 Also, when running 'rsh hpux11-system cat any-file', cat would
14902
16c748720b01 New module 'stat-size'.
James Youngman <jay@gnu.org>
parents:
diff changeset
67 determine that the output stream had an st_blksize of 2147421096.
16c748720b01 New module 'stat-size'.
James Youngman <jay@gnu.org>
parents:
diff changeset
68 Conversely st_blksize can be 2 GiB (or maybe even larger) with XFS
16235
18a38c9615f0 In commentary, do not use ` to quote.
Paul Eggert <eggert@cs.ucla.edu>
parents: 16201
diff changeset
69 on 64-bit hosts. Somewhat arbitrarily, limit the "optimal" block
14902
16c748720b01 New module 'stat-size'.
James Youngman <jay@gnu.org>
parents:
diff changeset
70 size to SIZE_MAX / 8 + 1. (Dividing SIZE_MAX by only 4 wouldn't
16c748720b01 New module 'stat-size'.
James Youngman <jay@gnu.org>
parents:
diff changeset
71 suffice, since "cat" sometimes multiplies the result by 4.) If
16c748720b01 New module 'stat-size'.
James Youngman <jay@gnu.org>
parents:
diff changeset
72 anyone knows of a system for which this limit is too small, please
16c748720b01 New module 'stat-size'.
James Youngman <jay@gnu.org>
parents:
diff changeset
73 report it as a bug in this code. */
16c748720b01 New module 'stat-size'.
James Youngman <jay@gnu.org>
parents:
diff changeset
74 # define ST_BLKSIZE(statbuf) ((0 < (statbuf).st_blksize \
16c748720b01 New module 'stat-size'.
James Youngman <jay@gnu.org>
parents:
diff changeset
75 && (statbuf).st_blksize <= ((size_t)-1) / 8 + 1) \
16c748720b01 New module 'stat-size'.
James Youngman <jay@gnu.org>
parents:
diff changeset
76 ? (statbuf).st_blksize : DEV_BSIZE)
16c748720b01 New module 'stat-size'.
James Youngman <jay@gnu.org>
parents:
diff changeset
77 # if defined hpux || defined __hpux__ || defined __hpux
16c748720b01 New module 'stat-size'.
James Youngman <jay@gnu.org>
parents:
diff changeset
78 /* HP-UX counts st_blocks in 1024-byte units.
16c748720b01 New module 'stat-size'.
James Youngman <jay@gnu.org>
parents:
diff changeset
79 This loses when mixing HP-UX and BSD file systems with NFS. */
16c748720b01 New module 'stat-size'.
James Youngman <jay@gnu.org>
parents:
diff changeset
80 # define ST_NBLOCKSIZE 1024
16c748720b01 New module 'stat-size'.
James Youngman <jay@gnu.org>
parents:
diff changeset
81 # else /* !hpux */
16c748720b01 New module 'stat-size'.
James Youngman <jay@gnu.org>
parents:
diff changeset
82 # if defined _AIX && defined _I386
16c748720b01 New module 'stat-size'.
James Youngman <jay@gnu.org>
parents:
diff changeset
83 /* AIX PS/2 counts st_blocks in 4K units. */
16c748720b01 New module 'stat-size'.
James Youngman <jay@gnu.org>
parents:
diff changeset
84 # define ST_NBLOCKSIZE (4 * 1024)
16c748720b01 New module 'stat-size'.
James Youngman <jay@gnu.org>
parents:
diff changeset
85 # else
16c748720b01 New module 'stat-size'.
James Youngman <jay@gnu.org>
parents:
diff changeset
86 # if defined _CRAY
16c748720b01 New module 'stat-size'.
James Youngman <jay@gnu.org>
parents:
diff changeset
87 # define ST_NBLOCKS(statbuf) \
16c748720b01 New module 'stat-size'.
James Youngman <jay@gnu.org>
parents:
diff changeset
88 (S_ISREG ((statbuf).st_mode) || S_ISDIR ((statbuf).st_mode) \
16c748720b01 New module 'stat-size'.
James Youngman <jay@gnu.org>
parents:
diff changeset
89 ? (statbuf).st_blocks * ST_BLKSIZE (statbuf) / ST_NBLOCKSIZE : 0)
16c748720b01 New module 'stat-size'.
James Youngman <jay@gnu.org>
parents:
diff changeset
90 # endif
16c748720b01 New module 'stat-size'.
James Youngman <jay@gnu.org>
parents:
diff changeset
91 # endif
16c748720b01 New module 'stat-size'.
James Youngman <jay@gnu.org>
parents:
diff changeset
92 # endif
16c748720b01 New module 'stat-size'.
James Youngman <jay@gnu.org>
parents:
diff changeset
93 #endif
16c748720b01 New module 'stat-size'.
James Youngman <jay@gnu.org>
parents:
diff changeset
94
16c748720b01 New module 'stat-size'.
James Youngman <jay@gnu.org>
parents:
diff changeset
95 #ifndef ST_NBLOCKS
16c748720b01 New module 'stat-size'.
James Youngman <jay@gnu.org>
parents:
diff changeset
96 # define ST_NBLOCKS(statbuf) ((statbuf).st_blocks)
16c748720b01 New module 'stat-size'.
James Youngman <jay@gnu.org>
parents:
diff changeset
97 #endif
16c748720b01 New module 'stat-size'.
James Youngman <jay@gnu.org>
parents:
diff changeset
98
16c748720b01 New module 'stat-size'.
James Youngman <jay@gnu.org>
parents:
diff changeset
99 #ifndef ST_NBLOCKSIZE
16c748720b01 New module 'stat-size'.
James Youngman <jay@gnu.org>
parents:
diff changeset
100 # ifdef S_BLKSIZE
16c748720b01 New module 'stat-size'.
James Youngman <jay@gnu.org>
parents:
diff changeset
101 # define ST_NBLOCKSIZE S_BLKSIZE
16c748720b01 New module 'stat-size'.
James Youngman <jay@gnu.org>
parents:
diff changeset
102 # else
16c748720b01 New module 'stat-size'.
James Youngman <jay@gnu.org>
parents:
diff changeset
103 # define ST_NBLOCKSIZE 512
16c748720b01 New module 'stat-size'.
James Youngman <jay@gnu.org>
parents:
diff changeset
104 # endif
16c748720b01 New module 'stat-size'.
James Youngman <jay@gnu.org>
parents:
diff changeset
105 #endif
16c748720b01 New module 'stat-size'.
James Youngman <jay@gnu.org>
parents:
diff changeset
106
16c748720b01 New module 'stat-size'.
James Youngman <jay@gnu.org>
parents:
diff changeset
107 #endif /* STAT_SIZE_H */