extras/volume_id/volume_id/fat.c

   1 /*
   2  * volume_id - reads filesystem label and uuid
   3  *
   4  * Copyright (C) 2004 Kay Sievers <kay.sievers@vrfy.org>
   5  *
   6  *      This program is free software; you can redistribute it and/or modify it
   7  *      under the terms of the GNU General Public License as published by the
   8  *      Free Software Foundation version 2 of the License.
   9  */
  10
  11 #ifndef _GNU_SOURCE
  12 #define _GNU_SOURCE 1
  13 #endif
  14
  15 #ifdef HAVE_CONFIG_H
  16 #  include <config.h>
  17 #endif
  18
  19 #include <stdio.h>
  20 #include <stdlib.h>
  21 #include <unistd.h>
  22 #include <string.h>
  23 #include <errno.h>
  24 #include <ctype.h>
  25
  26 #include "volume_id.h"
  27 #include "logging.h"
  28 #include "util.h"
  29 #include "fat.h"
  30
  31 #define FAT12_MAX                       0xff5
  32 #define FAT16_MAX                       0xfff5
  33 #define FAT_ATTR_VOLUME_ID              0x08
  34 #define FAT_ATTR_DIR                    0x10
  35 #define FAT_ATTR_LONG_NAME              0x0f
  36 #define FAT_ATTR_MASK                   0x3f
  37 #define FAT_ENTRY_FREE                  0xe5
  38
  39 struct vfat_super_block {
  40         uint8_t         boot_jump[3];
  41         uint8_t         sysid[8];
  42         uint16_t        sector_size;
  43         uint8_t         sectors_per_cluster;
  44         uint16_t        reserved;
  45         uint8_t         fats;
  46         uint16_t        dir_entries;
  47         uint16_t        sectors;
  48         uint8_t         media;
  49         uint16_t        fat_length;
  50         uint16_t        secs_track;
  51         uint16_t        heads;
  52         uint32_t        hidden;
  53         uint32_t        total_sect;
  54         union {
  55                 struct fat_super_block {
  56                         uint8_t         unknown[3];
  57                         uint8_t         serno[4];
  58                         uint8_t         label[11];
  59                         uint8_t         magic[8];
  60                         uint8_t         dummy2[192];
  61                         uint8_t         pmagic[2];
  62                 } __attribute__((__packed__)) fat;
  63                 struct fat32_super_block {
  64                         uint32_t        fat32_length;
  65                         uint16_t        flags;
  66                         uint8_t         version[2];
  67                         uint32_t        root_cluster;
  68                         uint16_t        insfo_sector;
  69                         uint16_t        backup_boot;
  70                         uint16_t        reserved2[6];
  71                         uint8_t         unknown[3];
  72                         uint8_t         serno[4];
  73                         uint8_t         label[11];
  74                         uint8_t         magic[8];
  75                         uint8_t         dummy2[164];
  76                         uint8_t         pmagic[2];
  77                 } __attribute__((__packed__)) fat32;
  78         } __attribute__((__packed__)) type;
  79 } __attribute__((__packed__));
  80
  81 struct vfat_dir_entry {
  82         uint8_t         name[11];
  83         uint8_t         attr;
  84         uint16_t        time_creat;
  85         uint16_t        date_creat;
  86         uint16_t        time_acc;
  87         uint16_t        date_acc;
  88         uint16_t        cluster_high;
  89         uint16_t        time_write;
  90         uint16_t        date_write;
  91         uint16_t        cluster_low;
  92         uint32_t        size;
  93 } __attribute__((__packed__));
  94
  95 static uint8_t *get_attr_volume_id(struct vfat_dir_entry *dir, unsigned int count)
  96 {
  97         unsigned int i;
  98
  99         for (i = 0; i < count; i++) {
 100                 /* end marker */
 101                 if (dir[i].name[0] == 0x00) {
 102                         dbg("end of dir");
 103                         break;
 104                 }
 105
 106                 /* empty entry */
 107                 if (dir[i].name[0] == FAT_ENTRY_FREE)
 108                         continue;
 109
 110                 /* long name */
 111                 if ((dir[i].attr & FAT_ATTR_MASK) == FAT_ATTR_LONG_NAME)
 112                         continue;
 113
 114                 if ((dir[i].attr & (FAT_ATTR_VOLUME_ID | FAT_ATTR_DIR)) == FAT_ATTR_VOLUME_ID) {
 115                         /* labels do not have file data */
 116                         if (dir[i].cluster_high != 0 || dir[i].cluster_low != 0)
 117                                 continue;
 118
 119                         dbg("found ATTR_VOLUME_ID id in root dir");
 120                         return dir[i].name;
 121                 }
 122
 123                 dbg("skip dir entry");
 124         }
 125
 126         return NULL;
 127 }
 128
 129 int volume_id_probe_vfat(struct volume_id *id, uint64_t off)
 130 {
 131         struct vfat_super_block *vs;
 132         struct vfat_dir_entry *dir;
 133         uint16_t sector_size;
 134         uint16_t dir_entries;
 135         uint32_t sect_count;
 136         uint16_t reserved;
 137         uint32_t fat_size;
 138         uint32_t root_cluster;
 139         uint32_t dir_size;
 140         uint32_t cluster_count;
 141         uint32_t fat_length;
 142         uint64_t root_start;
 143         uint32_t start_data_sect;
 144         uint16_t root_dir_entries;
 145         uint8_t *buf;
 146         uint32_t buf_size;
 147         uint8_t *label = NULL;
 148         uint32_t next;
 149         int maxloop;
 150
 151         dbg("probing at offset 0x%llx", (unsigned long long) off);
 152
 153         vs = (struct vfat_super_block *) volume_id_get_buffer(id, off, 0x200);
 154         if (vs == NULL)
 155                 return -1;
 156
 157         /* believe only that's fat, don't trust the version
 158          * the cluster_count will tell us
 159          */
 160         if (memcmp(vs->sysid, "NTFS", 4) == 0)
 161                 return -1;
 162
 163         if (memcmp(vs->type.fat32.magic, "MSWIN", 5) == 0)
 164                 goto valid;
 165
 166         if (memcmp(vs->type.fat32.magic, "FAT32   ", 8) == 0)
 167                 goto valid;
 168
 169         if (memcmp(vs->type.fat.magic, "FAT16   ", 8) == 0)
 170                 goto valid;
 171
 172         if (memcmp(vs->type.fat.magic, "MSDOS", 5) == 0)
 173                 goto valid;
 174
 175         if (memcmp(vs->type.fat.magic, "FAT12   ", 8) == 0)
 176                 goto valid;
 177
 178         /*
 179          * There are old floppies out there without a magic, so we check
 180          * for well known values and guess if it's a fat volume
 181          */
 182
 183         /* boot jump address check */
 184         if ((vs->boot_jump[0] != 0xeb || vs->boot_jump[2] != 0x90) &&
 185              vs->boot_jump[0] != 0xe9)
 186                 return -1;
 187
 188         /* heads check */
 189         if (vs->heads == 0)
 190                 return -1;
 191
 192         /* cluster size check*/
 193         if (vs->sectors_per_cluster == 0 ||
 194             (vs->sectors_per_cluster & (vs->sectors_per_cluster-1)))
 195                 return -1;
 196
 197         /* media check */
 198         if (vs->media < 0xf8 && vs->media != 0xf0)
 199                 return -1;
 200
 201         /* fat count*/
 202         if (vs->fats != 2)
 203                 return -1;
 204
 205 valid:
 206         /* sector size check */
 207         sector_size = le16_to_cpu(vs->sector_size);
 208         if (sector_size != 0x200 && sector_size != 0x400 &&
 209             sector_size != 0x800 && sector_size != 0x1000)
 210                 return -1;
 211
 212         dbg("sector_size 0x%x", sector_size);
 213         dbg("sectors_per_cluster 0x%x", vs->sectors_per_cluster);
 214
 215         dir_entries = le16_to_cpu(vs->dir_entries);
 216         reserved = le16_to_cpu(vs->reserved);
 217         dbg("reserved 0x%x", reserved);
 218
 219         sect_count = le16_to_cpu(vs->sectors);
 220         if (sect_count == 0)
 221                 sect_count = le32_to_cpu(vs->total_sect);
 222         dbg("sect_count 0x%x", sect_count);
 223
 224         fat_length = le16_to_cpu(vs->fat_length);
 225         if (fat_length == 0)
 226                 fat_length = le32_to_cpu(vs->type.fat32.fat32_length);
 227         dbg("fat_length 0x%x", fat_length);
 228
 229         fat_size = fat_length * vs->fats;
 230         dir_size = ((dir_entries * sizeof(struct vfat_dir_entry)) +
 231                         (sector_size-1)) / sector_size;
 232         dbg("dir_size 0x%x", dir_size);
 233
 234         cluster_count = sect_count - (reserved + fat_size + dir_size);
 235         cluster_count /= vs->sectors_per_cluster;
 236         dbg("cluster_count 0x%x", cluster_count);
 237
 238         if (cluster_count < FAT12_MAX) {
 239                 strcpy(id->type_version, "FAT12");
 240         } else if (cluster_count < FAT16_MAX) {
 241                 strcpy(id->type_version, "FAT16");
 242         } else {
 243                 strcpy(id->type_version, "FAT32");
 244                 goto fat32;
 245         }
 246
 247         /* the label may be an attribute in the root directory */
 248         root_start = (reserved + fat_size) * sector_size;
 249         dbg("root dir start 0x%llx", (unsigned long long) root_start);
 250         root_dir_entries = le16_to_cpu(vs->dir_entries);
 251         dbg("expected entries 0x%x", root_dir_entries);
 252
 253         buf_size = root_dir_entries * sizeof(struct vfat_dir_entry);
 254         buf = volume_id_get_buffer(id, off + root_start, buf_size);
 255         if (buf == NULL)
 256                 goto found;
 257
 258         dir = (struct vfat_dir_entry*) buf;
 259
 260         label = get_attr_volume_id(dir, root_dir_entries);
 261
 262         vs = (struct vfat_super_block *) volume_id_get_buffer(id, off, 0x200);
 263         if (vs == NULL)
 264                 return -1;
 265
 266         if (label != NULL && memcmp(label, "NO NAME    ", 11) != 0) {
 267                 volume_id_set_label_raw(id, label, 11);
 268                 volume_id_set_label_string(id, label, 11);
 269         } else if (memcmp(vs->type.fat.label, "NO NAME    ", 11) != 0) {
 270                 volume_id_set_label_raw(id, vs->type.fat.label, 11);
 271                 volume_id_set_label_string(id, vs->type.fat.label, 11);
 272         }
 273         volume_id_set_uuid(id, vs->type.fat.serno, UUID_DOS);
 274         goto found;
 275
 276 fat32:
 277         /* FAT32 root dir is a cluster chain like any other directory */
 278         buf_size = vs->sectors_per_cluster * sector_size;
 279         root_cluster = le32_to_cpu(vs->type.fat32.root_cluster);
 280         dbg("root dir cluster %u", root_cluster);
 281         start_data_sect = reserved + fat_size;
 282
 283         next = root_cluster;
 284         maxloop = 100;
 285         while (--maxloop) {
 286                 uint32_t next_sect_off;
 287                 uint64_t next_off;
 288                 uint64_t fat_entry_off;
 289                 int count;
 290
 291                 dbg("next cluster %u", next);
 292                 next_sect_off = (next - 2) * vs->sectors_per_cluster;
 293                 next_off = (start_data_sect + next_sect_off) * sector_size;
 294                 dbg("cluster offset 0x%llx", (unsigned long long) next_off);
 295
 296                 /* get cluster */
 297                 buf = volume_id_get_buffer(id, off + next_off, buf_size);
 298                 if (buf == NULL)
 299                         goto found;
 300
 301                 dir = (struct vfat_dir_entry*) buf;
 302                 count = buf_size / sizeof(struct vfat_dir_entry);
 303                 dbg("expected entries 0x%x", count);
 304
 305                 label = get_attr_volume_id(dir, count);
 306                 if (label)
 307                         break;
 308
 309                 /* get FAT entry */
 310                 fat_entry_off = (reserved * sector_size) + (next * sizeof(uint32_t));
 311                 buf = volume_id_get_buffer(id, off + fat_entry_off, buf_size);
 312                 if (buf == NULL)
 313                         goto found;
 314
 315                 /* set next cluster */
 316                 next = le32_to_cpu(*((uint32_t *) buf) & 0x0fffffff);
 317                 if (next == 0)
 318                         break;
 319         }
 320         if (maxloop == 0)
 321                 dbg("reached maximum follow count of root cluster chain, give up");
 322
 323         vs = (struct vfat_super_block *) volume_id_get_buffer(id, off, 0x200);
 324         if (vs == NULL)
 325                 return -1;
 326
 327         if (label != NULL && memcmp(label, "NO NAME    ", 11) != 0) {
 328                 volume_id_set_label_raw(id, label, 11);
 329                 volume_id_set_label_string(id, label, 11);
 330         } else if (memcmp(vs->type.fat32.label, "NO NAME    ", 11) != 0) {
 331                 volume_id_set_label_raw(id, vs->type.fat32.label, 11);
 332                 volume_id_set_label_string(id, vs->type.fat32.label, 11);
 333         }
 334         volume_id_set_uuid(id, vs->type.fat32.serno, UUID_DOS);
 335
 336 found:
 337         volume_id_set_usage(id, VOLUME_ID_FILESYSTEM);
 338         id->type = "vfat";
 339
 340         return 0;
 341 }