lib/stat-size.h

   1 /* macros useful in interpreting size-related values in struct stat.
   2    Copyright (C) 1989, 1991-2016 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 3 of the License, or
   7    (at your option) 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, see <http://www.gnu.org/licenses/>.  */
  16
  17 /* *INDENT-OFF* */
  18 /*
  19    Macros defined by this file (s is an rvalue of type struct stat):
  20
  21    DEV_BSIZE:       The device blocksize.  But use ST_NBLOCKSIZE instead.
  22    ST_BLKSIZE(s):   Preferred (in the sense of best performance) I/O blocksize
  23                     for the file, in bytes.
  24    ST_NBLOCKS(s):   Number of blocks in the file, including indirect blocks.
  25    ST_NBLOCKSIZE:   Size of blocks used when calculating ST_NBLOCKS.
  26  */
  27 /* *INDENT-ON* */
  28
  29 #ifndef STAT_SIZE_H
  30 #define STAT_SIZE_H
  31
  32 /* sys/param.h may define DEV_BSIZE */
  33 #if HAVE_SYS_PARAM_H
  34 #include <sys/param.h>
  35 #endif
  36
  37
  38 /* Get or fake the disk device blocksize.
  39    Usually defined by sys/param.h (if at all).  */
  40 #if !defined DEV_BSIZE && defined BSIZE
  41 #define DEV_BSIZE BSIZE
  42 #endif
  43 #if !defined DEV_BSIZE && defined BBSIZE        /* SGI sys/param.h */
  44 #define DEV_BSIZE BBSIZE
  45 #endif
  46 #ifndef DEV_BSIZE
  47 #define DEV_BSIZE 4096
  48 #endif
  49
  50
  51
  52 /* Extract or fake data from a 'struct stat'.
  53    ST_BLKSIZE: Preferred I/O blocksize for the file, in bytes.
  54    ST_NBLOCKS: Number of blocks in the file, including indirect blocks.
  55    ST_NBLOCKSIZE: Size of blocks used when calculating ST_NBLOCKS.  */
  56 #ifndef HAVE_STRUCT_STAT_ST_BLOCKS
  57 #define ST_BLKSIZE(statbuf) DEV_BSIZE
  58   /* coreutils' fileblocks.c also uses BSIZE.  */
  59 #if defined _POSIX_SOURCE || !defined BSIZE
  60 #define ST_NBLOCKS(statbuf) \
  61   ((statbuf).st_size / ST_NBLOCKSIZE + ((statbuf).st_size % ST_NBLOCKSIZE != 0))
  62 #else
  63    /* This definition calls st_blocks, which is in the fileblocks module. */
  64 #define ST_NBLOCKS(statbuf) \
  65   (S_ISREG ((statbuf).st_mode) || S_ISDIR ((statbuf).st_mode) ? \
  66    st_blocks ((statbuf).st_size) : 0)
  67 #endif
  68 #else
  69 /* When running 'rsh hpux11-system cat any-file', cat would
  70    determine that the output stream had an st_blksize of 2147421096.
  71    Conversely st_blksize can be 2 GiB (or maybe even larger) with XFS
  72    on 64-bit hosts.  Somewhat arbitrarily, limit the "optimal" block
  73    size to SIZE_MAX / 8 + 1.  (Dividing SIZE_MAX by only 4 wouldn't
  74    suffice, since "cat" sometimes multiplies the result by 4.)  If
  75    anyone knows of a system for which this limit is too small, please
  76    report it as a bug in this code.  */
  77 #define ST_BLKSIZE(statbuf) ((0 < (statbuf).st_blksize \
  78                                && (size_t) ((statbuf).st_blksize) <= ((size_t)-1) / 8 + 1) \
  79                               ? (size_t) ((statbuf).st_blksize) : DEV_BSIZE)
  80 #if defined hpux || defined __hpux__ || defined __hpux
  81   /* HP-UX counts st_blocks in 1024-byte units.
  82      This loses when mixing HP-UX and BSD file systems with NFS.  */
  83 #define ST_NBLOCKSIZE 1024
  84 #endif
  85 #endif
  86
  87 #ifndef ST_NBLOCKS
  88 #define ST_NBLOCKS(statbuf) ((statbuf).st_blocks)
  89 #endif
  90
  91 #ifndef ST_NBLOCKSIZE
  92 #ifdef S_BLKSIZE
  93 #define ST_NBLOCKSIZE S_BLKSIZE
  94 #else
  95 #define ST_NBLOCKSIZE 512
  96 #endif
  97 #endif
  98
  99 #endif /* STAT_SIZE_H */