dump/main.c

   1 /*
   2         main.c (08.11.10)
   3         Prints detailed information about exFAT volume.
   4
   5         Free exFAT implementation.
   6         Copyright (C) 2011-2018  Andrew Nayenko
   7
   8         This program is free software; you can redistribute it and/or modify
   9         it under the terms of the GNU General Public License as published by
  10         the Free Software Foundation, either version 2 of the License, or
  11         (at your option) any later version.
  12
  13         This program is distributed in the hope that it will be useful,
  14         but WITHOUT ANY WARRANTY; without even the implied warranty of
  15         MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16         GNU General Public License for more details.
  17
  18         You should have received a copy of the GNU General Public License along
  19         with this program; if not, write to the Free Software Foundation, Inc.,
  20         51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  21 */
  22
  23 #include <exfat.h>
  24 #include <fcntl.h>
  25 #include <unistd.h>
  26 #include <inttypes.h>
  27 #include <stdio.h>
  28 #include <string.h>
  29
  30 static void print_generic_info(const struct exfat_super_block* sb)
  31 {
  32         printf("Volume serial number      0x%08x\n",
  33                         le32_to_cpu(sb->volume_serial));
  34         printf("FS version                       %hhu.%hhu\n",
  35                         sb->version.major, sb->version.minor);
  36         printf("Sector size               %10u\n",
  37                         SECTOR_SIZE(*sb));
  38         printf("Cluster size              %10u\n",
  39                         CLUSTER_SIZE(*sb));
  40 }
  41
  42 static void print_sector_info(const struct exfat_super_block* sb)
  43 {
  44         printf("Sectors count             %10"PRIu64"\n",
  45                         le64_to_cpu(sb->sector_count));
  46 }
  47
  48 static void print_cluster_info(const struct exfat_super_block* sb)
  49 {
  50         printf("Clusters count            %10u\n",
  51                         le32_to_cpu(sb->cluster_count));
  52 }
  53
  54 static void print_other_info(const struct exfat_super_block* sb)
  55 {
  56         printf("First sector              %10"PRIu64"\n",
  57                         le64_to_cpu(sb->sector_start));
  58         printf("FAT first sector          %10u\n",
  59                         le32_to_cpu(sb->fat_sector_start));
  60         printf("FAT sectors count         %10u\n",
  61                         le32_to_cpu(sb->fat_sector_count));
  62         printf("First cluster sector      %10u\n",
  63                         le32_to_cpu(sb->cluster_sector_start));
  64         printf("Root directory cluster    %10u\n",
  65                         le32_to_cpu(sb->rootdir_cluster));
  66         printf("Volume state                  0x%04hx\n",
  67                         le16_to_cpu(sb->volume_state));
  68         printf("FATs count                %10hhu\n",
  69                         sb->fat_count);
  70         printf("Drive number                    0x%02hhx\n",
  71                         sb->drive_no);
  72         printf("Allocated space           %9hhu%%\n",
  73                         sb->allocated_percent);
  74 }
  75
  76 static int dump_sb(const char* spec)
  77 {
  78         struct exfat_dev* dev;
  79         struct exfat_super_block sb;
  80
  81         dev = exfat_open(spec, EXFAT_MODE_RO);
  82         if (dev == NULL)
  83                 return 1;
  84
  85         if (exfat_read(dev, &sb, sizeof(struct exfat_super_block)) < 0)
  86         {
  87                 exfat_close(dev);
  88                 exfat_error("failed to read from '%s'", spec);
  89                 return 1;
  90         }
  91         if (memcmp(sb.oem_name, "EXFAT   ", sizeof(sb.oem_name)) != 0)
  92         {
  93                 exfat_close(dev);
  94                 exfat_error("exFAT file system is not found on '%s'", spec);
  95                 return 1;
  96         }
  97
  98         print_generic_info(&sb);
  99         print_sector_info(&sb);
 100         print_cluster_info(&sb);
 101         print_other_info(&sb);
 102
 103         exfat_close(dev);
 104         return 0;
 105 }
 106
 107 static void dump_sectors(struct exfat* ef)
 108 {
 109         off_t a = 0, b = 0;
 110
 111         printf("Used sectors ");
 112         while (exfat_find_used_sectors(ef, &a, &b) == 0)
 113                 printf(" %"PRIu64"-%"PRIu64, a, b);
 114         puts("");
 115 }
 116
 117 static int dump_full(const char* spec, bool used_sectors)
 118 {
 119         struct exfat ef;
 120         uint32_t free_clusters;
 121         uint64_t free_sectors;
 122
 123         if (exfat_mount(&ef, spec, "ro") != 0)
 124                 return 1;
 125
 126         free_clusters = exfat_count_free_clusters(&ef);
 127         free_sectors = (uint64_t) free_clusters << ef.sb->spc_bits;
 128
 129         printf("Volume label         %15s\n", exfat_get_label(&ef));
 130         print_generic_info(ef.sb);
 131         print_sector_info(ef.sb);
 132         printf("Free sectors              %10"PRIu64"\n", free_sectors);
 133         print_cluster_info(ef.sb);
 134         printf("Free clusters             %10u\n", free_clusters);
 135         print_other_info(ef.sb);
 136         if (used_sectors)
 137                 dump_sectors(&ef);
 138
 139         exfat_unmount(&ef);
 140         return 0;
 141 }
 142
 143 static int dump_file_fragments(const char* spec, const char* path)
 144 {
 145         struct exfat ef;
 146         struct exfat_node* node;
 147         cluster_t cluster;
 148         cluster_t next_cluster;
 149         cluster_t fragment_start_cluster;
 150         off_t remainder;
 151         off_t fragment_size = 0;
 152         int rc = 0;
 153
 154         if (exfat_mount(&ef, spec, "ro") != 0)
 155                 return 1;
 156
 157         rc = exfat_lookup(&ef, &node, path);
 158         if (rc != 0)
 159         {
 160                 exfat_unmount(&ef);
 161                 exfat_error("'%s': %s", path, strerror(-rc));
 162                 return 1;
 163         }
 164
 165         cluster = fragment_start_cluster = node->start_cluster;
 166         remainder = node->size;
 167         while (remainder > 0)
 168         {
 169                 off_t lsize;
 170
 171                 if (CLUSTER_INVALID(*ef.sb, cluster))
 172                 {
 173                         exfat_error("'%s' has invalid cluster %#x", path, cluster);
 174                         rc = 1;
 175                         break;
 176                 }
 177
 178                 lsize = MIN(CLUSTER_SIZE(*ef.sb), remainder);
 179                 fragment_size += lsize;
 180                 remainder -= lsize;
 181
 182                 next_cluster = exfat_next_cluster(&ef, node, cluster);
 183                 if (next_cluster != cluster + 1 || remainder == 0)
 184                 {
 185                         /* next cluster is not contiguous or this is EOF */
 186                         printf("%"PRIu64" %"PRIu64"\n",
 187                                         exfat_c2o(&ef, fragment_start_cluster), fragment_size);
 188                         /* start a new fragment */
 189                         fragment_start_cluster = next_cluster;
 190                         fragment_size = 0;
 191                 }
 192                 cluster = next_cluster;
 193         }
 194
 195         exfat_put_node(&ef, node);
 196         exfat_unmount(&ef);
 197         return rc;
 198 }
 199
 200 static void usage(const char* prog)
 201 {
 202         fprintf(stderr, "Usage: %s [-s] [-u] [-f file] [-V] <device>\n", prog);
 203         exit(1);
 204 }
 205
 206 int main(int argc, char* argv[])
 207 {
 208         int opt;
 209         const char* spec = NULL;
 210         bool sb_only = false;
 211         bool used_sectors = false;
 212         const char* file_path = NULL;
 213
 214         while ((opt = getopt(argc, argv, "suf:V")) != -1)
 215         {
 216                 switch (opt)
 217                 {
 218                 case 's':
 219                         sb_only = true;
 220                         break;
 221                 case 'u':
 222                         used_sectors = true;
 223                         break;
 224                 case 'f':
 225                         file_path = optarg;
 226                         break;
 227                 case 'V':
 228                         printf("dumpexfat %s\n", VERSION);
 229                         puts("Copyright (C) 2011-2018  Andrew Nayenko");
 230                         return 0;
 231                 default:
 232                         usage(argv[0]);
 233                 }
 234         }
 235         if (argc - optind != 1)
 236                 usage(argv[0]);
 237         spec = argv[optind];
 238
 239         if (file_path)
 240                 return dump_file_fragments(spec, file_path);
 241
 242         if (sb_only)
 243                 return dump_sb(spec);
 244
 245         return dump_full(spec, used_sectors);
 246 }