libexfat/mount.c

   1 /*
   2         mount.c (22.10.09)
   3         exFAT file system implementation library.
   4
   5         Copyright (C) 2009, 2010  Andrew Nayenko
   6
   7         This program is free software: you can redistribute it and/or modify
   8         it under the terms of the GNU General Public License as published by
   9         the Free Software Foundation, either version 3 of the License, or
  10         (at your option) any later version.
  11
  12         This program is distributed in the hope that it will be useful,
  13         but WITHOUT ANY WARRANTY; without even the implied warranty of
  14         MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15         GNU General Public License for more details.
  16
  17         You should have received a copy of the GNU General Public License
  18         along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19 */
  20
  21 #include "exfat.h"
  22 #include <string.h>
  23 #include <stdlib.h>
  24 #include <errno.h>
  25 #include <unistd.h>
  26 #include <sys/types.h>
  27
  28 static uint64_t rootdir_size(const struct exfat* ef)
  29 {
  30         uint64_t clusters = 0;
  31         cluster_t rootdir_cluster = le32_to_cpu(ef->sb->rootdir_cluster);
  32
  33         while (!CLUSTER_INVALID(rootdir_cluster))
  34         {
  35                 clusters++;
  36                 /* root directory cannot be contiguous because there is no flag
  37                    to indicate this */
  38                 rootdir_cluster = exfat_next_cluster(ef, ef->root, rootdir_cluster);
  39         }
  40         return clusters * CLUSTER_SIZE(*ef->sb);
  41 }
  42
  43 static const char* get_option(const char* options, const char* option_name)
  44 {
  45         const char* p;
  46         size_t length = strlen(option_name);
  47
  48         for (p = strstr(options, option_name); p; p = strstr(p + 1, option_name))
  49                 if ((p == options || p[-1] == ',') && p[length] == '=')
  50                         return p + length + 1;
  51         return NULL;
  52 }
  53
  54 static int get_int_option(const char* options, const char* option_name,
  55                 int base, int default_value)
  56 {
  57         const char* p = get_option(options, option_name);
  58
  59         if (p == NULL)
  60                 return default_value;
  61         return strtol(p, NULL, base);
  62 }
  63
  64 static int match_option(const char* options, const char* option_name)
  65 {
  66         const char* p;
  67         size_t length = strlen(option_name);
  68
  69         for (p = strstr(options, option_name); p; p = strstr(p + 1, option_name))
  70                 if ((p == options || p[-1] == ',') &&
  71                                 (p[length] == ',' || p[length] == '\0'))
  72                         return 1;
  73         return 0;
  74 }
  75
  76 static void parse_options(struct exfat* ef, const char* options)
  77 {
  78         int sys_umask = umask(0);
  79         int opt_umask;
  80
  81         umask(sys_umask); /* restore umask */
  82         opt_umask = get_int_option(options, "umask", 8, sys_umask);
  83         ef->dmask = get_int_option(options, "dmask", 8, opt_umask) & 0777;
  84         ef->fmask = get_int_option(options, "fmask", 8, opt_umask) & 0777;
  85
  86         ef->uid = get_int_option(options, "uid", 10, geteuid());
  87         ef->gid = get_int_option(options, "gid", 10, getegid());
  88
  89         ef->ro = match_option(options, "ro");
  90         ef->noatime = match_option(options, "noatime");
  91 }
  92
  93 static int verify_vbr_checksum(void* sector, off_t sector_size, int fd)
  94 {
  95         uint32_t vbr_checksum;
  96         int i;
  97
  98         exfat_pread(fd, sector, sector_size, 0);
  99         vbr_checksum = exfat_vbr_start_checksum(sector, sector_size);
 100         for (i = 1; i < 11; i++)
 101         {
 102                 exfat_pread(fd, sector, sector_size, i * sector_size);
 103                 vbr_checksum = exfat_vbr_add_checksum(sector, sector_size,
 104                                 vbr_checksum);
 105         }
 106         exfat_pread(fd, sector, sector_size, i * sector_size);
 107         for (i = 0; i < sector_size / sizeof(vbr_checksum); i++)
 108                 if (le32_to_cpu(((const le32_t*) sector)[i]) != vbr_checksum)
 109                 {
 110                         exfat_error("invalid VBR checksum 0x%x (expected 0x%x)",
 111                                         le32_to_cpu(((const le32_t*) sector)[i]), vbr_checksum);
 112                         return 1;
 113                 }
 114         return 0;
 115 }
 116
 117 static int commit_super_block(const struct exfat* ef)
 118 {
 119         exfat_pwrite(ef->fd, ef->sb, sizeof(struct exfat_super_block), 0);
 120         return exfat_fsync(ef->fd);
 121 }
 122
 123 static int prepare_super_block(const struct exfat* ef)
 124 {
 125         if (le16_to_cpu(ef->sb->volume_state) & EXFAT_STATE_MOUNTED)
 126                 exfat_warn("volume was not unmounted cleanly");
 127
 128         if (ef->ro)
 129                 return 0;
 130
 131         ef->sb->volume_state = cpu_to_le16(
 132                         le16_to_cpu(ef->sb->volume_state) | EXFAT_STATE_MOUNTED);
 133         return commit_super_block(ef);
 134 }
 135
 136 int exfat_mount(struct exfat* ef, const char* spec, const char* options)
 137 {
 138         int rc;
 139
 140         exfat_tzset();
 141         memset(ef, 0, sizeof(struct exfat));
 142
 143         parse_options(ef, options);
 144
 145         ef->fd = exfat_open(spec, ef->ro);
 146         if (ef->fd < 0)
 147         {
 148                 if (ef->ro || !match_option(options, "ro_fallback"))
 149                         return -EIO;
 150                 ef->fd = exfat_open(spec, 1);
 151                 if (ef->fd < 0)
 152                         return -EIO;
 153                 exfat_warn("device is write-protected, mounting read-only");
 154                 ef->ro_fallback = ef->ro = 1;
 155         }
 156
 157         ef->sb = malloc(sizeof(struct exfat_super_block));
 158         if (ef->sb == NULL)
 159         {
 160                 exfat_close(ef->fd);
 161                 exfat_error("failed to allocate memory for the super block");
 162                 return -ENOMEM;
 163         }
 164         memset(ef->sb, 0, sizeof(struct exfat_super_block));
 165
 166         exfat_pread(ef->fd, ef->sb, sizeof(struct exfat_super_block), 0);
 167         if (memcmp(ef->sb->oem_name, "EXFAT   ", 8) != 0)
 168         {
 169                 exfat_close(ef->fd);
 170                 free(ef->sb);
 171                 exfat_error("exFAT file system is not found");
 172                 return -EIO;
 173         }
 174         if (ef->sb->version.major != 1 || ef->sb->version.minor != 0)
 175         {
 176                 exfat_close(ef->fd);
 177                 exfat_error("unsupported exFAT version: %hhu.%hhu",
 178                                 ef->sb->version.major, ef->sb->version.minor);
 179                 free(ef->sb);
 180                 return -EIO;
 181         }
 182         if (ef->sb->fat_count != 1)
 183         {
 184                 exfat_close(ef->fd);
 185                 free(ef->sb);
 186                 exfat_error("unsupported FAT count: %hhu", ef->sb->fat_count);
 187                 return -EIO;
 188         }
 189         /* officially exFAT supports cluster size up to 32 MB */
 190         if ((int) ef->sb->sector_bits + (int) ef->sb->spc_bits > 25)
 191         {
 192                 exfat_close(ef->fd);
 193                 free(ef->sb);
 194                 exfat_error("too big cluster size: 2^%d",
 195                                 (int) ef->sb->sector_bits + (int) ef->sb->spc_bits);
 196                 return -EIO;
 197         }
 198
 199         ef->zero_cluster = malloc(CLUSTER_SIZE(*ef->sb));
 200         if (ef->zero_cluster == NULL)
 201         {
 202                 exfat_close(ef->fd);
 203                 free(ef->sb);
 204                 exfat_error("failed to allocate zero sector");
 205                 return -ENOMEM;
 206         }
 207         /* use zero_cluster as a temporary buffer for VBR checksum verification */
 208         if (verify_vbr_checksum(ef->zero_cluster, SECTOR_SIZE(*ef->sb),
 209                         ef->fd) != 0)
 210         {
 211                 free(ef->zero_cluster);
 212                 exfat_close(ef->fd);
 213                 free(ef->sb);
 214                 return -EIO;
 215         }
 216         memset(ef->zero_cluster, 0, CLUSTER_SIZE(*ef->sb));
 217
 218         ef->root = malloc(sizeof(struct exfat_node));
 219         if (ef->root == NULL)
 220         {
 221                 free(ef->zero_cluster);
 222                 exfat_close(ef->fd);
 223                 free(ef->sb);
 224                 exfat_error("failed to allocate root node");
 225                 return -ENOMEM;
 226         }
 227         memset(ef->root, 0, sizeof(struct exfat_node));
 228         ef->root->flags = EXFAT_ATTRIB_DIR;
 229         ef->root->start_cluster = le32_to_cpu(ef->sb->rootdir_cluster);
 230         ef->root->fptr_cluster = ef->root->start_cluster;
 231         ef->root->name[0] = cpu_to_le16('\0');
 232         ef->root->size = rootdir_size(ef);
 233         /* exFAT does not have time attributes for the root directory */
 234         ef->root->mtime = 0;
 235         ef->root->atime = 0;
 236         /* always keep at least 1 reference to the root node */
 237         exfat_get_node(ef->root);
 238
 239         rc = exfat_cache_directory(ef, ef->root);
 240         if (rc != 0)
 241                 goto error;
 242         if (ef->upcase == NULL)
 243         {
 244                 exfat_error("upcase table is not found");
 245                 goto error;
 246         }
 247         if (ef->cmap.chunk == NULL)
 248         {
 249                 exfat_error("clusters bitmap is not found");
 250                 goto error;
 251         }
 252
 253         if (prepare_super_block(ef) != 0)
 254                 goto error;
 255
 256         return 0;
 257
 258 error:
 259         exfat_put_node(ef, ef->root);
 260         exfat_reset_cache(ef);
 261         free(ef->root);
 262         free(ef->zero_cluster);
 263         exfat_close(ef->fd);
 264         free(ef->sb);
 265         return -EIO;
 266 }
 267
 268 static void finalize_super_block(struct exfat* ef)
 269 {
 270         if (ef->ro)
 271                 return;
 272
 273         ef->sb->volume_state = cpu_to_le16(
 274                         le16_to_cpu(ef->sb->volume_state) & ~EXFAT_STATE_MOUNTED);
 275
 276         /* Some implementations set the percentage of allocated space to 0xff
 277            on FS creation and never update it. In this case leave it as is. */
 278         if (ef->sb->allocated_percent != 0xff)
 279         {
 280                 uint32_t free, total;
 281
 282                 free = exfat_count_free_clusters(ef);
 283                 total = le32_to_cpu(ef->sb->cluster_count);
 284                 ef->sb->allocated_percent = ((total - free) * 100 + total / 2) / total;
 285         }
 286
 287         commit_super_block(ef);
 288 }
 289
 290 void exfat_unmount(struct exfat* ef)
 291 {
 292         exfat_put_node(ef, ef->root);
 293         exfat_reset_cache(ef);
 294         free(ef->root);
 295         ef->root = NULL;
 296         finalize_super_block(ef);
 297         exfat_close(ef->fd);    /* close descriptor immediately after fsync */
 298         ef->fd = 0;
 299         free(ef->zero_cluster);
 300         ef->zero_cluster = NULL;
 301         free(ef->cmap.chunk);
 302         ef->cmap.chunk = NULL;
 303         free(ef->sb);
 304         ef->sb = NULL;
 305         free(ef->upcase);
 306         ef->upcase = NULL;
 307         ef->upcase_chars = 0;
 308 }