LXR busybox/coreutils/df.c

   1/* vi: set sw=4 ts=4: */
   2/*
   3 * Mini df implementation for busybox
   4 *
   5 * Copyright (C) 1999-2004 by Erik Andersen <andersen@codepoet.org>
   6 * based on original code by (I think) Bruce Perens <bruce@pixar.com>.
   7 *
   8 * Licensed under GPLv2 or later, see file LICENSE in this source tree.
   9 */
  10/* Mar 16, 2003      Manuel Novoa III   (mjn3@codepoet.org)
  11 *
  12 * Size reduction.  Removed floating point dependency.  Added error checking
  13 * on output.  Output stats on 0-sized filesystems if specifically listed on
  14 * the command line.  Properly round *-blocks, Used, and Available quantities.
  15 *
  16 * Aug 28, 2008      Bernhard Reutner-Fischer
  17 *
  18 * Implement -P and -B; better coreutils compat; cleanup
  19 */
  20//config:config DF
  21//config:       bool "df (7.5 kb)"
  22//config:       default y
  23//config:       help
  24//config:       df reports the amount of disk space used and available
  25//config:       on filesystems.
  26//config:
  27//config:config FEATURE_DF_FANCY
  28//config:       bool "Enable -a, -i, -B"
  29//config:       default y
  30//config:       depends on DF
  31//config:       help
  32//config:       -a Show all filesystems
  33//config:       -i Inodes
  34//config:       -B <SIZE> Blocksize
  35
  36//applet:IF_DF(APPLET_NOEXEC(df, df, BB_DIR_BIN, BB_SUID_DROP, df))
  37
  38//kbuild:lib-$(CONFIG_DF) += df.o
  39
  40/* BB_AUDIT SUSv3 _NOT_ compliant -- option -t missing. */
  41/* http://www.opengroup.org/onlinepubs/007904975/utilities/df.html */
  42
  43//usage:#define df_trivial_usage
  44//usage:        "[-Pk"
  45//usage:        IF_FEATURE_HUMAN_READABLE("mh")
  46//usage:        "T"
  47//usage:        IF_FEATURE_DF_FANCY("ai] [-B SIZE")
  48//usage:        "] [FILESYSTEM]..."
  49//usage:#define df_full_usage "\n\n"
  50//usage:       "Print filesystem usage statistics\n"
  51//usage:     "\n        -P      POSIX output format"
  52//usage:     "\n        -k      1024-byte blocks (default)"
  53//usage:        IF_FEATURE_HUMAN_READABLE(
  54//usage:     "\n        -m      1M-byte blocks"
  55//usage:     "\n        -h      Human readable (e.g. 1K 243M 2G)"
  56//usage:        )
  57//usage:     "\n        -T      Print filesystem type"
  58//usage:        IF_FEATURE_DF_FANCY(
  59//usage:     "\n        -a      Show all filesystems"
  60//usage:     "\n        -i      Inodes"
  61//usage:     "\n        -B SIZE Blocksize"
  62//usage:        )
  63//usage:
  64//usage:#define df_example_usage
  65//usage:       "$ df\n"
  66//usage:       "Filesystem           1K-blocks      Used Available Use% Mounted on\n"
  67//usage:       "/dev/sda3              8690864   8553540    137324  98% /\n"
  68//usage:       "/dev/sda1                64216     36364     27852  57% /boot\n"
  69//usage:       "$ df /dev/sda3\n"
  70//usage:       "Filesystem           1K-blocks      Used Available Use% Mounted on\n"
  71//usage:       "/dev/sda3              8690864   8553540    137324  98% /\n"
  72//usage:       "$ POSIXLY_CORRECT=sure df /dev/sda3\n"
  73//usage:       "Filesystem         512B-blocks      Used Available Use% Mounted on\n"
  74//usage:       "/dev/sda3             17381728  17107080    274648  98% /\n"
  75//usage:       "$ POSIXLY_CORRECT=yep df -P /dev/sda3\n"
  76//usage:       "Filesystem          512-blocks      Used Available Capacity Mounted on\n"
  77//usage:       "/dev/sda3             17381728  17107080    274648      98% /\n"
  78
  79#include <mntent.h>
  80#include <sys/statvfs.h>
  81#include "libbb.h"
  82#include "unicode.h"
  83
  84#if !ENABLE_FEATURE_HUMAN_READABLE
  85static unsigned long kscale(unsigned long b, unsigned long bs)
  86{
  87        return (b * (unsigned long long) bs + 1024/2) / 1024;
  88}
  89#endif
  90
  91int df_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
  92int df_main(int argc UNUSED_PARAM, char **argv)
  93{
  94        unsigned long df_disp_hr = 1024;
  95        int status = EXIT_SUCCESS;
  96        unsigned opt;
  97        FILE *mount_table;
  98        struct mntent *mount_entry;
  99        struct statvfs s;
 100
 101        enum {
 102                OPT_KILO  = (1 << 0),
 103                OPT_POSIX = (1 << 1),
 104                OPT_FSTYPE  = (1 << 2),
 105                OPT_ALL   = (1 << 3) * ENABLE_FEATURE_DF_FANCY,
 106                OPT_INODE = (1 << 4) * ENABLE_FEATURE_DF_FANCY,
 107                OPT_BSIZE = (1 << 5) * ENABLE_FEATURE_DF_FANCY,
 108                OPT_HUMAN = (1 << (3 + 3*ENABLE_FEATURE_DF_FANCY)) * ENABLE_FEATURE_HUMAN_READABLE,
 109                OPT_MEGA  = (1 << (4 + 3*ENABLE_FEATURE_DF_FANCY)) * ENABLE_FEATURE_HUMAN_READABLE,
 110        };
 111        const char *disp_units_hdr = NULL;
 112        char *chp;
 113
 114        init_unicode();
 115
 116        opt = getopt32(argv, "^"
 117                        "kPT"
 118                        IF_FEATURE_DF_FANCY("aiB:")
 119                        IF_FEATURE_HUMAN_READABLE("hm")
 120                        "\0"
 121#if ENABLE_FEATURE_HUMAN_READABLE && ENABLE_FEATURE_DF_FANCY
 122                        "k-mB:m-Bk:B-km"
 123#elif ENABLE_FEATURE_HUMAN_READABLE
 124                        "k-m:m-k"
 125#endif
 126                        IF_FEATURE_DF_FANCY(, &chp)
 127        );
 128        if (opt & OPT_MEGA)
 129                df_disp_hr = 1024*1024;
 130
 131        if (opt & OPT_BSIZE) {
 132                /* GNU coreutils 8.25 accepts "-BMiB" form too */
 133                int i;
 134                for (i = 0; kmg_i_suffixes[i].suffix[0]; i++) {
 135                        if (strcmp(kmg_i_suffixes[i].suffix, chp) == 0) {
 136                                df_disp_hr = kmg_i_suffixes[i].mult;
 137                                goto got_it;
 138                        }
 139                }
 140                /* Range used to disallow 0 */
 141                df_disp_hr = xatoul_range_sfx(chp, 1, ULONG_MAX, kmg_i_suffixes);
 142 got_it: ;
 143        }
 144
 145        /* From the manpage of df from coreutils-6.10:
 146         * Disk space is shown in 1K blocks by default, unless the environment
 147         * variable POSIXLY_CORRECT is set, in which case 512-byte blocks are used.
 148         */
 149        if (getenv("POSIXLY_CORRECT")) /* TODO - a new libbb function? */
 150                df_disp_hr = 512;
 151
 152        if (opt & OPT_HUMAN) {
 153                df_disp_hr = 0;
 154                disp_units_hdr = "     Size";
 155        }
 156        if (opt & OPT_INODE)
 157                disp_units_hdr = "   Inodes";
 158
 159        if (disp_units_hdr == NULL) {
 160#if ENABLE_FEATURE_HUMAN_READABLE
 161                disp_units_hdr = xasprintf("%s-blocks",
 162                        /* print df_disp_hr, show no fractionals,
 163                         * use suffixes if OPT_POSIX is set in opt */
 164                        make_human_readable_str(df_disp_hr, 0, !!(opt & OPT_POSIX))
 165                );
 166#else
 167                disp_units_hdr = xasprintf("%lu-blocks", df_disp_hr);
 168#endif
 169        }
 170
 171        printf("Filesystem           %s%-15sUsed Available %s Mounted on\n",
 172                        (opt & OPT_FSTYPE) ? "Type       " : "",
 173                        disp_units_hdr,
 174                        (opt & OPT_POSIX) ? "Capacity" : "Use%");
 175
 176        mount_table = NULL;
 177        argv += optind;
 178        if (!argv[0]) {
 179                mount_table = setmntent(bb_path_mtab_file, "r");
 180                if (!mount_table)
 181                        bb_perror_msg_and_die(bb_path_mtab_file);
 182        }
 183
 184        while (1) {
 185                const char *device;
 186                const char *mount_point;
 187                const char *fs_type;
 188
 189                if (mount_table) {
 190                        mount_entry = getmntent(mount_table);
 191                        if (!mount_entry) {
 192                                endmntent(mount_table);
 193                                break;
 194                        }
 195                } else {
 196                        mount_point = *argv++;
 197                        if (!mount_point)
 198                                break;
 199                        mount_entry = find_mount_point(mount_point, 1);
 200                        if (!mount_entry) {
 201                                bb_error_msg("%s: can't find mount point", mount_point);
 202 set_error:
 203                                status = EXIT_FAILURE;
 204                                continue;
 205                        }
 206                }
 207
 208                device = mount_entry->mnt_fsname;
 209
 210                /* GNU coreutils 6.10 skips certain mounts, try to be compatible */
 211                if (ENABLE_FEATURE_SKIP_ROOTFS && strcmp(device, "rootfs") == 0)
 212                        continue;
 213
 214                mount_point = mount_entry->mnt_dir;
 215                fs_type = mount_entry->mnt_type;
 216
 217                if (statvfs(mount_point, &s) != 0) {
 218                        bb_simple_perror_msg(mount_point);
 219                        goto set_error;
 220                }
 221                /* Some uclibc versions were seen to lose f_frsize
 222                 * (kernel does return it, but then uclibc does not copy it)
 223                 */
 224                if (s.f_frsize == 0)
 225                        s.f_frsize = s.f_bsize;
 226
 227                if ((s.f_blocks > 0) || !mount_table || (opt & OPT_ALL)) {
 228                        unsigned long long blocks_used;
 229                        unsigned long long blocks_total;
 230                        unsigned blocks_percent_used;
 231
 232                        if (opt & OPT_INODE) {
 233                                s.f_blocks = s.f_files;
 234                                s.f_bavail = s.f_bfree = s.f_ffree;
 235                                s.f_frsize = 1;
 236                                if (df_disp_hr)
 237                                        df_disp_hr = 1;
 238                        }
 239                        blocks_used = s.f_blocks - s.f_bfree;
 240                        blocks_total = blocks_used + s.f_bavail;
 241                        blocks_percent_used = blocks_total; /* 0% if blocks_total == 0, else... */
 242                        if (blocks_total != 0) {
 243                                /* Downscale sizes for narrower division */
 244                                unsigned u;
 245                                while (blocks_total >= INT_MAX / 101) {
 246                                        blocks_total >>= 1;
 247                                        blocks_used >>= 1;
 248                                }
 249                                u = (unsigned)blocks_used * 100u + (unsigned)blocks_total / 2;
 250                                blocks_percent_used = u / (unsigned)blocks_total;
 251                        }
 252
 253#ifdef WHY_WE_DO_IT_FOR_DEV_ROOT_ONLY
 254                        if (strcmp(device, "/dev/root") == 0) {
 255                                /* Adjusts device to be the real root device,
 256                                 * or leaves device alone if it can't find it */
 257                                device = find_block_device("/");
 258                                if (!device) {
 259                                        goto set_error;
 260                                }
 261                        }
 262#endif
 263
 264#if ENABLE_UNICODE_SUPPORT
 265                        {
 266                                uni_stat_t uni_stat;
 267                                char *uni_dev = unicode_conv_to_printable(&uni_stat, device);
 268                                if (uni_stat.unicode_width > 20 && !(opt & OPT_POSIX)) {
 269                                        printf("%s\n%20s", uni_dev, "");
 270                                } else {
 271                                        printf("%s%*s", uni_dev, 20 - (int)uni_stat.unicode_width, "");
 272                                }
 273                                free(uni_dev);
 274                                if (opt & OPT_FSTYPE) {
 275                                        char *uni_type = unicode_conv_to_printable(&uni_stat, fs_type);
 276                                        if (uni_stat.unicode_width > 10 && !(opt & OPT_POSIX))
 277                                                printf(" %s\n%31s", uni_type, "");
 278                                        else
 279                                                printf(" %s%*s", uni_type, 10 - (int)uni_stat.unicode_width, "");
 280                                        free(uni_type);
 281                                }
 282                        }
 283#else
 284                        if (printf("\n%-20s" + 1, device) > 20 && !(opt & OPT_POSIX))
 285                                printf("\n%-20s", "");
 286                        if (opt & OPT_FSTYPE) {
 287                                if (printf(" %-10s", fs_type) > 11 && !(opt & OPT_POSIX))
 288                                        printf("\n%-30s", "");
 289                        }
 290#endif
 291
 292#if ENABLE_FEATURE_HUMAN_READABLE
 293                        printf(" %9s ",
 294                                /* f_blocks x f_frsize / df_disp_hr, show one fractional,
 295                                 * use suffixes if df_disp_hr == 0 */
 296                                make_human_readable_str(s.f_blocks, s.f_frsize, df_disp_hr));
 297
 298                        printf(" %9s " + 1,
 299                                /* EXPR x f_frsize / df_disp_hr, show one fractional,
 300                                 * use suffixes if df_disp_hr == 0 */
 301                                make_human_readable_str((s.f_blocks - s.f_bfree),
 302                                                s.f_frsize, df_disp_hr));
 303
 304                        printf("%9s %3u%% %s\n",
 305                                /* f_bavail x f_frsize / df_disp_hr, show one fractional,
 306                                 * use suffixes if df_disp_hr == 0 */
 307                                make_human_readable_str(s.f_bavail, s.f_frsize, df_disp_hr),
 308                                blocks_percent_used, mount_point);
 309#else
 310                        printf(" %9lu %9lu %9lu %3u%% %s\n",
 311                                kscale(s.f_blocks, s.f_frsize),
 312                                kscale(s.f_blocks - s.f_bfree, s.f_frsize),
 313                                kscale(s.f_bavail, s.f_frsize),
 314                                blocks_percent_used, mount_point);
 315#endif
 316                }
 317        }
 318
 319        return status;
 320}
 321