fuse/main.c

   1 /*
   2         main.c (01.09.09)
   3         FUSE-based exFAT implementation. Requires FUSE 2.6 or later.
   4
   5         Free exFAT implementation.
   6         Copyright (C) 2010-2013  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 #define FUSE_USE_VERSION 26
  24 #include <fuse.h>
  25 #include <errno.h>
  26 #include <fcntl.h>
  27 #include <stdio.h>
  28 #include <stdlib.h>
  29 #include <string.h>
  30 #include <exfat.h>
  31 #include <inttypes.h>
  32 #include <limits.h>
  33 #include <sys/types.h>
  34 #include <pwd.h>
  35 #include <unistd.h>
  36
  37 #define exfat_debug(format, ...)
  38
  39 #if !defined(FUSE_VERSION) || (FUSE_VERSION < 26)
  40         #error FUSE 2.6 or later is required
  41 #endif
  42
  43 const char* default_options = "ro_fallback,allow_other,blkdev,big_writes,"
  44                 "defer_permissions";
  45
  46 struct exfat ef;
  47
  48 static struct exfat_node* get_node(const struct fuse_file_info* fi)
  49 {
  50         return (struct exfat_node*) (size_t) fi->fh;
  51 }
  52
  53 static void set_node(struct fuse_file_info* fi, struct exfat_node* node)
  54 {
  55         fi->fh = (uint64_t) (size_t) node;
  56 }
  57
  58 static int fuse_exfat_getattr(const char* path, struct stat* stbuf)
  59 {
  60         struct exfat_node* node;
  61         int rc;
  62
  63         exfat_debug("[%s] %s", __func__, path);
  64
  65         rc = exfat_lookup(&ef, &node, path);
  66         if (rc != 0)
  67                 return rc;
  68
  69         exfat_stat(&ef, node, stbuf);
  70         exfat_put_node(&ef, node);
  71         return 0;
  72 }
  73
  74 static int fuse_exfat_truncate(const char* path, off_t size)
  75 {
  76         struct exfat_node* node;
  77         int rc;
  78
  79         exfat_debug("[%s] %s, %"PRId64, __func__, path, size);
  80
  81         rc = exfat_lookup(&ef, &node, path);
  82         if (rc != 0)
  83                 return rc;
  84
  85         rc = exfat_truncate(&ef, node, size, true);
  86         exfat_put_node(&ef, node);
  87         return rc;
  88 }
  89
  90 static int fuse_exfat_readdir(const char* path, void* buffer,
  91                 fuse_fill_dir_t filler, off_t offset, struct fuse_file_info* fi)
  92 {
  93         struct exfat_node* parent;
  94         struct exfat_node* node;
  95         struct exfat_iterator it;
  96         int rc;
  97         char name[UTF8_BYTES(EXFAT_NAME_MAX) + 1];
  98
  99         exfat_debug("[%s] %s", __func__, path);
 100
 101         rc = exfat_lookup(&ef, &parent, path);
 102         if (rc != 0)
 103                 return rc;
 104         if (!(parent->flags & EXFAT_ATTRIB_DIR))
 105         {
 106                 exfat_put_node(&ef, parent);
 107                 exfat_error("`%s' is not a directory (0x%x)", path, parent->flags);
 108                 return -ENOTDIR;
 109         }
 110
 111         filler(buffer, ".", NULL, 0);
 112         filler(buffer, "..", NULL, 0);
 113
 114         rc = exfat_opendir(&ef, parent, &it);
 115         if (rc != 0)
 116         {
 117                 exfat_put_node(&ef, parent);
 118                 exfat_error("failed to open directory `%s'", path);
 119                 return rc;
 120         }
 121         while ((node = exfat_readdir(&ef, &it)))
 122         {
 123                 exfat_get_name(node, name, sizeof(name) - 1);
 124                 exfat_debug("[%s] %s: %s, %"PRId64" bytes, cluster 0x%x", __func__,
 125                                 name, IS_CONTIGUOUS(*node) ? "contiguous" : "fragmented",
 126                                 node->size, node->start_cluster);
 127                 filler(buffer, name, NULL, 0);
 128                 exfat_put_node(&ef, node);
 129         }
 130         exfat_closedir(&ef, &it);
 131         exfat_put_node(&ef, parent);
 132         return 0;
 133 }
 134
 135 static int fuse_exfat_open(const char* path, struct fuse_file_info* fi)
 136 {
 137         struct exfat_node* node;
 138         int rc;
 139
 140         exfat_debug("[%s] %s", __func__, path);
 141
 142         rc = exfat_lookup(&ef, &node, path);
 143         if (rc != 0)
 144                 return rc;
 145         set_node(fi, node);
 146         fi->keep_cache = 1;
 147         return 0;
 148 }
 149
 150 static int fuse_exfat_release(const char* path, struct fuse_file_info* fi)
 151 {
 152         exfat_debug("[%s] %s", __func__, path);
 153         exfat_put_node(&ef, get_node(fi));
 154         return 0;
 155 }
 156
 157 static int fuse_exfat_read(const char* path, char* buffer, size_t size,
 158                 off_t offset, struct fuse_file_info* fi)
 159 {
 160         ssize_t ret;
 161
 162         exfat_debug("[%s] %s (%zu bytes)", __func__, path, size);
 163         ret = exfat_generic_pread(&ef, get_node(fi), buffer, size, offset);
 164         if (ret < 0)
 165                 return -EIO;
 166         return ret;
 167 }
 168
 169 static int fuse_exfat_write(const char* path, const char* buffer, size_t size,
 170                 off_t offset, struct fuse_file_info* fi)
 171 {
 172         ssize_t ret;
 173
 174         exfat_debug("[%s] %s (%zu bytes)", __func__, path, size);
 175         ret = exfat_generic_pwrite(&ef, get_node(fi), buffer, size, offset);
 176         if (ret < 0)
 177                 return -EIO;
 178         return ret;
 179 }
 180
 181 static int fuse_exfat_unlink(const char* path)
 182 {
 183         struct exfat_node* node;
 184         int rc;
 185
 186         exfat_debug("[%s] %s", __func__, path);
 187
 188         rc = exfat_lookup(&ef, &node, path);
 189         if (rc != 0)
 190                 return rc;
 191
 192         rc = exfat_unlink(&ef, node);
 193         exfat_put_node(&ef, node);
 194         return rc;
 195 }
 196
 197 static int fuse_exfat_rmdir(const char* path)
 198 {
 199         struct exfat_node* node;
 200         int rc;
 201
 202         exfat_debug("[%s] %s", __func__, path);
 203
 204         rc = exfat_lookup(&ef, &node, path);
 205         if (rc != 0)
 206                 return rc;
 207
 208         rc = exfat_rmdir(&ef, node);
 209         exfat_put_node(&ef, node);
 210         return rc;
 211 }
 212
 213 static int fuse_exfat_mknod(const char* path, mode_t mode, dev_t dev)
 214 {
 215         exfat_debug("[%s] %s 0%ho", __func__, path, mode);
 216         return exfat_mknod(&ef, path);
 217 }
 218
 219 static int fuse_exfat_mkdir(const char* path, mode_t mode)
 220 {
 221         exfat_debug("[%s] %s 0%ho", __func__, path, mode);
 222         return exfat_mkdir(&ef, path);
 223 }
 224
 225 static int fuse_exfat_rename(const char* old_path, const char* new_path)
 226 {
 227         exfat_debug("[%s] %s => %s", __func__, old_path, new_path);
 228         return exfat_rename(&ef, old_path, new_path);
 229 }
 230
 231 static int fuse_exfat_utimens(const char* path, const struct timespec tv[2])
 232 {
 233         struct exfat_node* node;
 234         int rc;
 235
 236         exfat_debug("[%s] %s", __func__, path);
 237
 238         rc = exfat_lookup(&ef, &node, path);
 239         if (rc != 0)
 240                 return rc;
 241
 242         exfat_utimes(node, tv);
 243         exfat_put_node(&ef, node);
 244         return 0;
 245 }
 246
 247 static int fuse_exfat_chmod(const char* path, mode_t mode)
 248 {
 249         const mode_t VALID_MODE_MASK = S_IFREG | S_IFDIR |
 250                         S_IRWXU | S_IRWXG | S_IRWXO;
 251
 252         exfat_debug("[%s] %s 0%ho", __func__, path, mode);
 253         if (mode & ~VALID_MODE_MASK)
 254                 return -EPERM;
 255         return 0;
 256 }
 257
 258 static int fuse_exfat_chown(const char* path, uid_t uid, gid_t gid)
 259 {
 260         exfat_debug("[%s] %s %u:%u", __func__, path, uid, gid);
 261         if (uid != ef.uid || gid != ef.gid)
 262                 return -EPERM;
 263         return 0;
 264 }
 265
 266 static int fuse_exfat_statfs(const char* path, struct statvfs* sfs)
 267 {
 268         exfat_debug("[%s]", __func__);
 269
 270         sfs->f_bsize = CLUSTER_SIZE(*ef.sb);
 271         sfs->f_frsize = CLUSTER_SIZE(*ef.sb);
 272         sfs->f_blocks = le64_to_cpu(ef.sb->sector_count) >> ef.sb->spc_bits;
 273         sfs->f_bavail = exfat_count_free_clusters(&ef);
 274         sfs->f_bfree = sfs->f_bavail;
 275         sfs->f_namemax = EXFAT_NAME_MAX;
 276
 277         /*
 278            Below are fake values because in exFAT there is
 279            a) no simple way to count files;
 280            b) no such thing as inode;
 281            So here we assume that inode = cluster.
 282         */
 283         sfs->f_files = (sfs->f_blocks - sfs->f_bfree) >> ef.sb->spc_bits;
 284         sfs->f_favail = sfs->f_bfree >> ef.sb->spc_bits;
 285         sfs->f_ffree = sfs->f_bavail;
 286
 287         return 0;
 288 }
 289
 290 static void* fuse_exfat_init(struct fuse_conn_info* fci)
 291 {
 292         exfat_debug("[%s]", __func__);
 293 #ifdef FUSE_CAP_BIG_WRITES
 294         fci->want |= FUSE_CAP_BIG_WRITES;
 295 #endif
 296         return NULL;
 297 }
 298
 299 static void fuse_exfat_destroy(void* unused)
 300 {
 301         exfat_debug("[%s]", __func__);
 302         exfat_unmount(&ef);
 303 }
 304
 305 static void usage(const char* prog)
 306 {
 307         fprintf(stderr, "Usage: %s [-d] [-o options] [-V] <device> <dir>\n", prog);
 308         exit(1);
 309 }
 310
 311 static struct fuse_operations fuse_exfat_ops =
 312 {
 313         .getattr        = fuse_exfat_getattr,
 314         .truncate       = fuse_exfat_truncate,
 315         .readdir        = fuse_exfat_readdir,
 316         .open           = fuse_exfat_open,
 317         .release        = fuse_exfat_release,
 318         .read           = fuse_exfat_read,
 319         .write          = fuse_exfat_write,
 320         .unlink         = fuse_exfat_unlink,
 321         .rmdir          = fuse_exfat_rmdir,
 322         .mknod          = fuse_exfat_mknod,
 323         .mkdir          = fuse_exfat_mkdir,
 324         .rename         = fuse_exfat_rename,
 325         .utimens        = fuse_exfat_utimens,
 326         .chmod          = fuse_exfat_chmod,
 327         .chown          = fuse_exfat_chown,
 328         .statfs         = fuse_exfat_statfs,
 329         .init           = fuse_exfat_init,
 330         .destroy        = fuse_exfat_destroy,
 331 };
 332
 333 static char* add_option(char* options, const char* name, const char* value)
 334 {
 335         size_t size;
 336
 337         if (value)
 338                 size = strlen(options) + strlen(name) + strlen(value) + 3;
 339         else
 340                 size = strlen(options) + strlen(name) + 2;
 341
 342         options = realloc(options, size);
 343         if (options == NULL)
 344         {
 345                 exfat_error("failed to reallocate options string");
 346                 return NULL;
 347         }
 348         strcat(options, ",");
 349         strcat(options, name);
 350         if (value)
 351         {
 352                 strcat(options, "=");
 353                 strcat(options, value);
 354         }
 355         return options;
 356 }
 357
 358 static char* add_user_option(char* options)
 359 {
 360         struct passwd* pw;
 361
 362         if (getuid() == 0)
 363                 return options;
 364
 365         pw = getpwuid(getuid());
 366         if (pw == NULL || pw->pw_name == NULL)
 367         {
 368                 free(options);
 369                 exfat_error("failed to determine username");
 370                 return NULL;
 371         }
 372         return add_option(options, "user", pw->pw_name);
 373 }
 374
 375 static char* add_blksize_option(char* options, long cluster_size)
 376 {
 377         long page_size = sysconf(_SC_PAGESIZE);
 378         char blksize[20];
 379
 380         if (page_size < 1)
 381                 page_size = 0x1000;
 382
 383         snprintf(blksize, sizeof(blksize), "%ld", MIN(page_size, cluster_size));
 384         return add_option(options, "blksize", blksize);
 385 }
 386
 387 static char* add_fuse_options(char* options, const char* spec)
 388 {
 389         options = add_option(options, "fsname", spec);
 390         if (options == NULL)
 391                 return NULL;
 392         options = add_user_option(options);
 393         if (options == NULL)
 394                 return NULL;
 395         options = add_blksize_option(options, CLUSTER_SIZE(*ef.sb));
 396         if (options == NULL)
 397                 return NULL;
 398
 399         return options;
 400 }
 401
 402 int main(int argc, char* argv[])
 403 {
 404         struct fuse_args mount_args = FUSE_ARGS_INIT(0, NULL);
 405         struct fuse_args newfs_args = FUSE_ARGS_INIT(0, NULL);
 406         const char* spec = NULL;
 407         const char* mount_point = NULL;
 408         char* mount_options;
 409         int debug = 0;
 410         struct fuse_chan* fc = NULL;
 411         struct fuse* fh = NULL;
 412         int opt;
 413
 414         printf("FUSE exfat %u.%u.%u\n",
 415                         EXFAT_VERSION_MAJOR, EXFAT_VERSION_MINOR, EXFAT_VERSION_PATCH);
 416
 417         mount_options = strdup(default_options);
 418         if (mount_options == NULL)
 419         {
 420                 exfat_error("failed to allocate options string");
 421                 return 1;
 422         }
 423
 424         while ((opt = getopt(argc, argv, "dno:Vv")) != -1)
 425         {
 426                 switch (opt)
 427                 {
 428                 case 'd':
 429                         debug = 1;
 430                         break;
 431                 case 'n':
 432                         break;
 433                 case 'o':
 434                         mount_options = add_option(mount_options, optarg, NULL);
 435                         if (mount_options == NULL)
 436                                 return 1;
 437                         break;
 438                 case 'V':
 439                         free(mount_options);
 440                         puts("Copyright (C) 2010-2013  Andrew Nayenko");
 441                         return 0;
 442                 case 'v':
 443                         break;
 444                 default:
 445                         free(mount_options);
 446                         usage(argv[0]);
 447                         break;
 448                 }
 449         }
 450         if (argc - optind != 2)
 451         {
 452                 free(mount_options);
 453                 usage(argv[0]);
 454         }
 455         spec = argv[optind];
 456         mount_point = argv[optind + 1];
 457
 458         if (exfat_mount(&ef, spec, mount_options) != 0)
 459         {
 460                 free(mount_options);
 461                 return 1;
 462         }
 463
 464         if (ef.ro == -1) /* read-only fallback was used */
 465         {
 466                 mount_options = add_option(mount_options, "ro", NULL);
 467                 if (mount_options == NULL)
 468                 {
 469                         exfat_unmount(&ef);
 470                         return 1;
 471                 }
 472         }
 473
 474         mount_options = add_fuse_options(mount_options, spec);
 475         if (mount_options == NULL)
 476         {
 477                 exfat_unmount(&ef);
 478                 return 1;
 479         }
 480
 481         /* create arguments for fuse_mount() */
 482         if (fuse_opt_add_arg(&mount_args, "exfat") != 0 ||
 483                 fuse_opt_add_arg(&mount_args, "-o") != 0 ||
 484                 fuse_opt_add_arg(&mount_args, mount_options) != 0)
 485         {
 486                 exfat_unmount(&ef);
 487                 free(mount_options);
 488                 return 1;
 489         }
 490
 491         free(mount_options);
 492
 493         /* create FUSE mount point */
 494         fc = fuse_mount(mount_point, &mount_args);
 495         fuse_opt_free_args(&mount_args);
 496         if (fc == NULL)
 497         {
 498                 exfat_unmount(&ef);
 499                 return 1;
 500         }
 501
 502         /* create arguments for fuse_new() */
 503         if (fuse_opt_add_arg(&newfs_args, "") != 0 ||
 504                 (debug && fuse_opt_add_arg(&newfs_args, "-d") != 0))
 505         {
 506                 fuse_unmount(mount_point, fc);
 507                 exfat_unmount(&ef);
 508                 return 1;
 509         }
 510
 511         /* create new FUSE file system */
 512         fh = fuse_new(fc, &newfs_args, &fuse_exfat_ops,
 513                         sizeof(struct fuse_operations), NULL);
 514         fuse_opt_free_args(&newfs_args);
 515         if (fh == NULL)
 516         {
 517                 fuse_unmount(mount_point, fc);
 518                 exfat_unmount(&ef);
 519                 return 1;
 520         }
 521
 522         /* exit session on HUP, TERM and INT signals and ignore PIPE signal */
 523         if (fuse_set_signal_handlers(fuse_get_session(fh)) != 0)
 524         {
 525                 fuse_unmount(mount_point, fc);
 526                 fuse_destroy(fh);
 527                 exfat_unmount(&ef);
 528                 exfat_error("failed to set signal handlers");
 529                 return 1;
 530         }
 531
 532         /* go to background (unless "-d" option is passed) and run FUSE
 533            main loop */
 534         if (fuse_daemonize(debug) == 0)
 535         {
 536                 if (fuse_loop(fh) != 0)
 537                         exfat_error("FUSE loop failure");
 538         }
 539         else
 540                 exfat_error("failed to daemonize");
 541
 542         fuse_remove_signal_handlers(fuse_get_session(fh));
 543         /* note that fuse_unmount() must be called BEFORE fuse_destroy() */
 544         fuse_unmount(mount_point, fc);
 545         fuse_destroy(fh);
 546         return 0;
 547 }