libexfat/mount.c

   1 /*
   2         mount.c (22.10.09)
   3         exFAT file system implementation library.
   4
   5         Free exFAT implementation.
   6         Copyright (C) 2010-2017  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 <string.h>
  25 #include <stdlib.h>
  26 #include <errno.h>
  27 #include <inttypes.h>
  28 #include <unistd.h>
  29 #include <sys/types.h>
  30
  31 static uint64_t rootdir_size(const struct exfat* ef)
  32 {
  33         uint32_t clusters = 0;
  34         uint32_t clusters_max = le32_to_cpu(ef->sb->cluster_count);
  35         cluster_t rootdir_cluster = le32_to_cpu(ef->sb->rootdir_cluster);
  36
  37         /* Iterate all clusters of the root directory to calculate its size.
  38            It can't be contiguous because there is no flag to indicate this. */
  39         do
  40         {
  41                 if (clusters == clusters_max) /* infinite loop detected */
  42                 {
  43                         exfat_error("root directory cannot occupy all %d clusters",
  44                                         clusters);
  45                         return 0;
  46                 }
  47                 if (CLUSTER_INVALID(*ef->sb, rootdir_cluster))
  48                 {
  49                         exfat_error("bad cluster %#x while reading root directory",
  50                                         rootdir_cluster);
  51                         return 0;
  52                 }
  53                 rootdir_cluster = exfat_next_cluster(ef, ef->root, rootdir_cluster);
  54                 clusters++;
  55         }
  56         while (rootdir_cluster != EXFAT_CLUSTER_END);
  57
  58         return (uint64_t) clusters * CLUSTER_SIZE(*ef->sb);
  59 }
  60
  61 static const char* get_option(const char* options, const char* option_name)
  62 {
  63         const char* p;
  64         size_t length = strlen(option_name);
  65
  66         for (p = strstr(options, option_name); p; p = strstr(p + 1, option_name))
  67                 if ((p == options || p[-1] == ',') && p[length] == '=')
  68                         return p + length + 1;
  69         return NULL;
  70 }
  71
  72 static int get_int_option(const char* options, const char* option_name,
  73                 int base, int default_value)
  74 {
  75         const char* p = get_option(options, option_name);
  76
  77         if (p == NULL)
  78                 return default_value;
  79         return strtol(p, NULL, base);
  80 }
  81
  82 static bool match_option(const char* options, const char* option_name)
  83 {
  84         const char* p;
  85         size_t length = strlen(option_name);
  86
  87         for (p = strstr(options, option_name); p; p = strstr(p + 1, option_name))
  88                 if ((p == options || p[-1] == ',') &&
  89                                 (p[length] == ',' || p[length] == '\0'))
  90                         return true;
  91         return false;
  92 }
  93
  94 static void parse_options(struct exfat* ef, const char* options)
  95 {
  96         int opt_umask;
  97
  98         opt_umask = get_int_option(options, "umask", 8, 0);
  99         ef->dmask = get_int_option(options, "dmask", 8, opt_umask);
 100         ef->fmask = get_int_option(options, "fmask", 8, opt_umask);
 101
 102         ef->uid = get_int_option(options, "uid", 10, geteuid());
 103         ef->gid = get_int_option(options, "gid", 10, getegid());
 104
 105         ef->noatime = match_option(options, "noatime");
 106 }
 107
 108 static bool verify_vbr_checksum(struct exfat_dev* dev, void* sector,
 109                 off_t sector_size)
 110 {
 111         uint32_t vbr_checksum;
 112         int i;
 113
 114         if (exfat_pread(dev, sector, sector_size, 0) < 0)
 115         {
 116                 exfat_error("failed to read boot sector");
 117                 return false;
 118         }
 119         vbr_checksum = exfat_vbr_start_checksum(sector, sector_size);
 120         for (i = 1; i < 11; i++)
 121         {
 122                 if (exfat_pread(dev, sector, sector_size, i * sector_size) < 0)
 123                 {
 124                         exfat_error("failed to read VBR sector");
 125                         return false;
 126                 }
 127                 vbr_checksum = exfat_vbr_add_checksum(sector, sector_size,
 128                                 vbr_checksum);
 129         }
 130         if (exfat_pread(dev, sector, sector_size, i * sector_size) < 0)
 131         {
 132                 exfat_error("failed to read VBR checksum sector");
 133                 return false;
 134         }
 135         for (i = 0; i < sector_size / sizeof(vbr_checksum); i++)
 136                 if (le32_to_cpu(((const le32_t*) sector)[i]) != vbr_checksum)
 137                 {
 138                         exfat_error("invalid VBR checksum 0x%x (expected 0x%x)",
 139                                         le32_to_cpu(((const le32_t*) sector)[i]), vbr_checksum);
 140                         return false;
 141                 }
 142         return true;
 143 }
 144
 145 static int commit_super_block(const struct exfat* ef)
 146 {
 147         if (exfat_pwrite(ef->dev, ef->sb, sizeof(struct exfat_super_block), 0) < 0)
 148         {
 149                 exfat_error("failed to write super block");
 150                 return 1;
 151         }
 152         return exfat_fsync(ef->dev);
 153 }
 154
 155 static int prepare_super_block(const struct exfat* ef)
 156 {
 157         if (le16_to_cpu(ef->sb->volume_state) & EXFAT_STATE_MOUNTED)
 158                 exfat_warn("volume was not unmounted cleanly");
 159
 160         if (ef->ro)
 161                 return 0;
 162
 163         ef->sb->volume_state = cpu_to_le16(
 164                         le16_to_cpu(ef->sb->volume_state) | EXFAT_STATE_MOUNTED);
 165         return commit_super_block(ef);
 166 }
 167
 168 static void exfat_free(struct exfat* ef)
 169 {
 170         exfat_close(ef->dev);   /* first of all, close the descriptor */
 171         ef->dev = NULL;                 /* struct exfat_dev is freed by exfat_close() */
 172         free(ef->root);
 173         ef->root = NULL;
 174         free(ef->zero_cluster);
 175         ef->zero_cluster = NULL;
 176         free(ef->cmap.chunk);
 177         ef->cmap.chunk = NULL;
 178         free(ef->upcase);
 179         ef->upcase = NULL;
 180         free(ef->sb);
 181         ef->sb = NULL;
 182 }
 183
 184 int exfat_mount(struct exfat* ef, const char* spec, const char* options)
 185 {
 186         int rc;
 187         enum exfat_mode mode;
 188
 189         exfat_tzset();
 190         memset(ef, 0, sizeof(struct exfat));
 191
 192         parse_options(ef, options);
 193
 194         if (match_option(options, "ro"))
 195                 mode = EXFAT_MODE_RO;
 196         else if (match_option(options, "ro_fallback"))
 197                 mode = EXFAT_MODE_ANY;
 198         else
 199                 mode = EXFAT_MODE_RW;
 200         ef->dev = exfat_open(spec, mode);
 201         if (ef->dev == NULL)
 202                 return -EIO;
 203         if (exfat_get_mode(ef->dev) == EXFAT_MODE_RO)
 204         {
 205                 if (mode == EXFAT_MODE_ANY)
 206                         ef->ro = -1;
 207                 else
 208                         ef->ro = 1;
 209         }
 210
 211         ef->sb = malloc(sizeof(struct exfat_super_block));
 212         if (ef->sb == NULL)
 213         {
 214                 exfat_error("failed to allocate memory for the super block");
 215                 exfat_free(ef);
 216                 return -ENOMEM;
 217         }
 218         memset(ef->sb, 0, sizeof(struct exfat_super_block));
 219
 220         if (exfat_pread(ef->dev, ef->sb, sizeof(struct exfat_super_block), 0) < 0)
 221         {
 222                 exfat_error("failed to read boot sector");
 223                 exfat_free(ef);
 224                 return -EIO;
 225         }
 226         if (memcmp(ef->sb->oem_name, "EXFAT   ", 8) != 0)
 227         {
 228                 exfat_error("exFAT file system is not found");
 229                 exfat_free(ef);
 230                 return -EIO;
 231         }
 232         /* sector cannot be smaller than 512 bytes */
 233         if (ef->sb->sector_bits < 9)
 234         {
 235                 exfat_error("too small sector size: 2^%hhd", ef->sb->sector_bits);
 236                 exfat_free(ef);
 237                 return -EIO;
 238         }
 239         /* officially exFAT supports cluster size up to 32 MB */
 240         if ((int) ef->sb->sector_bits + (int) ef->sb->spc_bits > 25)
 241         {
 242                 exfat_error("too big cluster size: 2^(%hhd+%hhd)",
 243                                 ef->sb->sector_bits, ef->sb->spc_bits);
 244                 exfat_free(ef);
 245                 return -EIO;
 246         }
 247         ef->zero_cluster = malloc(CLUSTER_SIZE(*ef->sb));
 248         if (ef->zero_cluster == NULL)
 249         {
 250                 exfat_error("failed to allocate zero sector");
 251                 exfat_free(ef);
 252                 return -ENOMEM;
 253         }
 254         /* use zero_cluster as a temporary buffer for VBR checksum verification */
 255         if (!verify_vbr_checksum(ef->dev, ef->zero_cluster, SECTOR_SIZE(*ef->sb)))
 256         {
 257                 exfat_free(ef);
 258                 return -EIO;
 259         }
 260         memset(ef->zero_cluster, 0, CLUSTER_SIZE(*ef->sb));
 261         if (ef->sb->version.major != 1 || ef->sb->version.minor != 0)
 262         {
 263                 exfat_error("unsupported exFAT version: %hhu.%hhu",
 264                                 ef->sb->version.major, ef->sb->version.minor);
 265                 exfat_free(ef);
 266                 return -EIO;
 267         }
 268         if (ef->sb->fat_count != 1)
 269         {
 270                 exfat_error("unsupported FAT count: %hhu", ef->sb->fat_count);
 271                 exfat_free(ef);
 272                 return -EIO;
 273         }
 274         if (le64_to_cpu(ef->sb->sector_count) * SECTOR_SIZE(*ef->sb) >
 275                         exfat_get_size(ef->dev))
 276         {
 277                 /* this can cause I/O errors later but we don't fail mounting to let
 278                    user rescue data */
 279                 exfat_warn("file system in sectors is larger than device: "
 280                                 "%"PRIu64" * %d > %"PRIu64,
 281                                 le64_to_cpu(ef->sb->sector_count), SECTOR_SIZE(*ef->sb),
 282                                 exfat_get_size(ef->dev));
 283         }
 284         if ((off_t) le32_to_cpu(ef->sb->cluster_count) * CLUSTER_SIZE(*ef->sb) >
 285                         exfat_get_size(ef->dev))
 286         {
 287                 exfat_error("file system in clusters is larger than device: "
 288                                 "%u * %d > %"PRIu64,
 289                                 le32_to_cpu(ef->sb->cluster_count), CLUSTER_SIZE(*ef->sb),
 290                                 exfat_get_size(ef->dev));
 291                 exfat_free(ef);
 292                 return -EIO;
 293         }
 294
 295         ef->root = malloc(sizeof(struct exfat_node));
 296         if (ef->root == NULL)
 297         {
 298                 exfat_error("failed to allocate root node");
 299                 exfat_free(ef);
 300                 return -ENOMEM;
 301         }
 302         memset(ef->root, 0, sizeof(struct exfat_node));
 303         ef->root->attrib = EXFAT_ATTRIB_DIR;
 304         ef->root->start_cluster = le32_to_cpu(ef->sb->rootdir_cluster);
 305         ef->root->fptr_cluster = ef->root->start_cluster;
 306         ef->root->name[0] = cpu_to_le16('\0');
 307         ef->root->size = rootdir_size(ef);
 308         if (ef->root->size == 0)
 309         {
 310                 exfat_free(ef);
 311                 return -EIO;
 312         }
 313         /* exFAT does not have time attributes for the root directory */
 314         ef->root->mtime = 0;
 315         ef->root->atime = 0;
 316         /* always keep at least 1 reference to the root node */
 317         exfat_get_node(ef->root);
 318
 319         rc = exfat_cache_directory(ef, ef->root);
 320         if (rc != 0)
 321                 goto error;
 322         if (ef->upcase == NULL)
 323         {
 324                 exfat_error("upcase table is not found");
 325                 goto error;
 326         }
 327         if (ef->cmap.chunk == NULL)
 328         {
 329                 exfat_error("clusters bitmap is not found");
 330                 goto error;
 331         }
 332
 333         if (prepare_super_block(ef) != 0)
 334                 goto error;
 335
 336         return 0;
 337
 338 error:
 339         exfat_put_node(ef, ef->root);
 340         exfat_reset_cache(ef);
 341         exfat_free(ef);
 342         return -EIO;
 343 }
 344
 345 static void finalize_super_block(struct exfat* ef)
 346 {
 347         if (ef->ro)
 348                 return;
 349
 350         ef->sb->volume_state = cpu_to_le16(
 351                         le16_to_cpu(ef->sb->volume_state) & ~EXFAT_STATE_MOUNTED);
 352
 353         /* Some implementations set the percentage of allocated space to 0xff
 354            on FS creation and never update it. In this case leave it as is. */
 355         if (ef->sb->allocated_percent != 0xff)
 356         {
 357                 uint32_t free, total;
 358
 359                 free = exfat_count_free_clusters(ef);
 360                 total = le32_to_cpu(ef->sb->cluster_count);
 361                 ef->sb->allocated_percent = ((total - free) * 100 + total / 2) / total;
 362         }
 363
 364         commit_super_block(ef); /* ignore return code */
 365 }
 366
 367 void exfat_unmount(struct exfat* ef)
 368 {
 369         exfat_flush_nodes(ef);  /* ignore return code */
 370         exfat_flush(ef);                /* ignore return code */
 371         exfat_put_node(ef, ef->root);
 372         exfat_reset_cache(ef);
 373         finalize_super_block(ef);
 374         exfat_free(ef);                 /* will close the descriptor */
 375 }