fs/hfs/super.c

   1 /*
   2  *  linux/fs/hfs/super.c
   3  *
   4  * Copyright (C) 1995-1997  Paul H. Hargrove
   5  * (C) 2003 Ardis Technologies <roman@ardistech.com>
   6  * This file may be distributed under the terms of the GNU General Public License.
   7  *
   8  * This file contains hfs_read_super(), some of the super_ops and
   9  * init_hfs_fs() and exit_hfs_fs().  The remaining super_ops are in
  10  * inode.c since they deal with inodes.
  11  *
  12  * Based on the minix file system code, (C) 1991, 1992 by Linus Torvalds
  13  */
  14
  15 #include <linux/module.h>
  16 #include <linux/blkdev.h>
  17 #include <linux/mount.h>
  18 #include <linux/init.h>
  19 #include <linux/nls.h>
  20 #include <linux/parser.h>
  21 #include <linux/seq_file.h>
  22 #include <linux/vfs.h>
  23
  24 #include "hfs_fs.h"
  25 #include "btree.h"
  26
  27 static struct kmem_cache *hfs_inode_cachep;
  28
  29 MODULE_LICENSE("GPL");
  30
  31 /*
  32  * hfs_write_super()
  33  *
  34  * Description:
  35  *   This function is called by the VFS only. When the filesystem
  36  *   is mounted r/w it updates the MDB on disk.
  37  * Input Variable(s):
  38  *   struct super_block *sb: Pointer to the hfs superblock
  39  * Output Variable(s):
  40  *   NONE
  41  * Returns:
  42  *   void
  43  * Preconditions:
  44  *   'sb' points to a "valid" (struct super_block).
  45  * Postconditions:
  46  *   The MDB is marked 'unsuccessfully unmounted' by clearing bit 8 of drAtrb
  47  *   (hfs_put_super() must set this flag!). Some MDB fields are updated
  48  *   and the MDB buffer is written to disk by calling hfs_mdb_commit().
  49  */
  50 static void hfs_write_super(struct super_block *sb)
  51 {
  52         sb->s_dirt = 0;
  53         if (sb->s_flags & MS_RDONLY)
  54                 return;
  55         /* sync everything to the buffers */
  56         hfs_mdb_commit(sb);
  57 }
  58
  59 /*
  60  * hfs_put_super()
  61  *
  62  * This is the put_super() entry in the super_operations structure for
  63  * HFS filesystems.  The purpose is to release the resources
  64  * associated with the superblock sb.
  65  */
  66 static void hfs_put_super(struct super_block *sb)
  67 {
  68         lock_kernel();
  69
  70         if (sb->s_dirt)
  71                 hfs_write_super(sb);
  72         hfs_mdb_close(sb);
  73         /* release the MDB's resources */
  74         hfs_mdb_put(sb);
  75
  76         unlock_kernel();
  77 }
  78
  79 /*
  80  * hfs_statfs()
  81  *
  82  * This is the statfs() entry in the super_operations structure for
  83  * HFS filesystems.  The purpose is to return various data about the
  84  * filesystem.
  85  *
  86  * changed f_files/f_ffree to reflect the fs_ablock/free_ablocks.
  87  */
  88 static int hfs_statfs(struct dentry *dentry, struct kstatfs *buf)
  89 {
  90         struct super_block *sb = dentry->d_sb;
  91         u64 id = huge_encode_dev(sb->s_bdev->bd_dev);
  92
  93         buf->f_type = HFS_SUPER_MAGIC;
  94         buf->f_bsize = sb->s_blocksize;
  95         buf->f_blocks = (u32)HFS_SB(sb)->fs_ablocks * HFS_SB(sb)->fs_div;
  96         buf->f_bfree = (u32)HFS_SB(sb)->free_ablocks * HFS_SB(sb)->fs_div;
  97         buf->f_bavail = buf->f_bfree;
  98         buf->f_files = HFS_SB(sb)->fs_ablocks;
  99         buf->f_ffree = HFS_SB(sb)->free_ablocks;
 100         buf->f_fsid.val[0] = (u32)id;
 101         buf->f_fsid.val[1] = (u32)(id >> 32);
 102         buf->f_namelen = HFS_NAMELEN;
 103
 104         return 0;
 105 }
 106
 107 static int hfs_remount(struct super_block *sb, int *flags, char *data)
 108 {
 109         *flags |= MS_NODIRATIME;
 110         if ((*flags & MS_RDONLY) == (sb->s_flags & MS_RDONLY))
 111                 return 0;
 112         if (!(*flags & MS_RDONLY)) {
 113                 if (!(HFS_SB(sb)->mdb->drAtrb & cpu_to_be16(HFS_SB_ATTRIB_UNMNT))) {
 114                         printk(KERN_WARNING "hfs: filesystem was not cleanly unmounted, "
 115                                "running fsck.hfs is recommended.  leaving read-only.\n");
 116                         sb->s_flags |= MS_RDONLY;
 117                         *flags |= MS_RDONLY;
 118                 } else if (HFS_SB(sb)->mdb->drAtrb & cpu_to_be16(HFS_SB_ATTRIB_SLOCK)) {
 119                         printk(KERN_WARNING "hfs: filesystem is marked locked, leaving read-only.\n");
 120                         sb->s_flags |= MS_RDONLY;
 121                         *flags |= MS_RDONLY;
 122                 }
 123         }
 124         return 0;
 125 }
 126
 127 static int hfs_show_options(struct seq_file *seq, struct vfsmount *mnt)
 128 {
 129         struct hfs_sb_info *sbi = HFS_SB(mnt->mnt_sb);
 130
 131         if (sbi->s_creator != cpu_to_be32(0x3f3f3f3f))
 132                 seq_printf(seq, ",creator=%.4s", (char *)&sbi->s_creator);
 133         if (sbi->s_type != cpu_to_be32(0x3f3f3f3f))
 134                 seq_printf(seq, ",type=%.4s", (char *)&sbi->s_type);
 135         seq_printf(seq, ",uid=%u,gid=%u", sbi->s_uid, sbi->s_gid);
 136         if (sbi->s_file_umask != 0133)
 137                 seq_printf(seq, ",file_umask=%o", sbi->s_file_umask);
 138         if (sbi->s_dir_umask != 0022)
 139                 seq_printf(seq, ",dir_umask=%o", sbi->s_dir_umask);
 140         if (sbi->part >= 0)
 141                 seq_printf(seq, ",part=%u", sbi->part);
 142         if (sbi->session >= 0)
 143                 seq_printf(seq, ",session=%u", sbi->session);
 144         if (sbi->nls_disk)
 145                 seq_printf(seq, ",codepage=%s", sbi->nls_disk->charset);
 146         if (sbi->nls_io)
 147                 seq_printf(seq, ",iocharset=%s", sbi->nls_io->charset);
 148         if (sbi->s_quiet)
 149                 seq_printf(seq, ",quiet");
 150         return 0;
 151 }
 152
 153 static struct inode *hfs_alloc_inode(struct super_block *sb)
 154 {
 155         struct hfs_inode_info *i;
 156
 157         i = kmem_cache_alloc(hfs_inode_cachep, GFP_KERNEL);
 158         return i ? &i->vfs_inode : NULL;
 159 }
 160
 161 static void hfs_destroy_inode(struct inode *inode)
 162 {
 163         kmem_cache_free(hfs_inode_cachep, HFS_I(inode));
 164 }
 165
 166 static const struct super_operations hfs_super_operations = {
 167         .alloc_inode    = hfs_alloc_inode,
 168         .destroy_inode  = hfs_destroy_inode,
 169         .write_inode    = hfs_write_inode,
 170         .clear_inode    = hfs_clear_inode,
 171         .put_super      = hfs_put_super,
 172         .write_super    = hfs_write_super,
 173         .statfs         = hfs_statfs,
 174         .remount_fs     = hfs_remount,
 175         .show_options   = hfs_show_options,
 176 };
 177
 178 enum {
 179         opt_uid, opt_gid, opt_umask, opt_file_umask, opt_dir_umask,
 180         opt_part, opt_session, opt_type, opt_creator, opt_quiet,
 181         opt_codepage, opt_iocharset,
 182         opt_err
 183 };
 184
 185 static const match_table_t tokens = {
 186         { opt_uid, "uid=%u" },
 187         { opt_gid, "gid=%u" },
 188         { opt_umask, "umask=%o" },
 189         { opt_file_umask, "file_umask=%o" },
 190         { opt_dir_umask, "dir_umask=%o" },
 191         { opt_part, "part=%u" },
 192         { opt_session, "session=%u" },
 193         { opt_type, "type=%s" },
 194         { opt_creator, "creator=%s" },
 195         { opt_quiet, "quiet" },
 196         { opt_codepage, "codepage=%s" },
 197         { opt_iocharset, "iocharset=%s" },
 198         { opt_err, NULL }
 199 };
 200
 201 static inline int match_fourchar(substring_t *arg, u32 *result)
 202 {
 203         if (arg->to - arg->from != 4)
 204                 return -EINVAL;
 205         memcpy(result, arg->from, 4);
 206         return 0;
 207 }
 208
 209 /*
 210  * parse_options()
 211  *
 212  * adapted from linux/fs/msdos/inode.c written 1992,93 by Werner Almesberger
 213  * This function is called by hfs_read_super() to parse the mount options.
 214  */
 215 static int parse_options(char *options, struct hfs_sb_info *hsb)
 216 {
 217         char *p;
 218         substring_t args[MAX_OPT_ARGS];
 219         int tmp, token;
 220
 221         /* initialize the sb with defaults */
 222         hsb->s_uid = current_uid();
 223         hsb->s_gid = current_gid();
 224         hsb->s_file_umask = 0133;
 225         hsb->s_dir_umask = 0022;
 226         hsb->s_type = hsb->s_creator = cpu_to_be32(0x3f3f3f3f); /* == '????' */
 227         hsb->s_quiet = 0;
 228         hsb->part = -1;
 229         hsb->session = -1;
 230
 231         if (!options)
 232                 return 1;
 233
 234         while ((p = strsep(&options, ",")) != NULL) {
 235                 if (!*p)
 236                         continue;
 237
 238                 token = match_token(p, tokens, args);
 239                 switch (token) {
 240                 case opt_uid:
 241                         if (match_int(&args[0], &tmp)) {
 242                                 printk(KERN_ERR "hfs: uid requires an argument\n");
 243                                 return 0;
 244                         }
 245                         hsb->s_uid = (uid_t)tmp;
 246                         break;
 247                 case opt_gid:
 248                         if (match_int(&args[0], &tmp)) {
 249                                 printk(KERN_ERR "hfs: gid requires an argument\n");
 250                                 return 0;
 251                         }
 252                         hsb->s_gid = (gid_t)tmp;
 253                         break;
 254                 case opt_umask:
 255                         if (match_octal(&args[0], &tmp)) {
 256                                 printk(KERN_ERR "hfs: umask requires a value\n");
 257                                 return 0;
 258                         }
 259                         hsb->s_file_umask = (umode_t)tmp;
 260                         hsb->s_dir_umask = (umode_t)tmp;
 261                         break;
 262                 case opt_file_umask:
 263                         if (match_octal(&args[0], &tmp)) {
 264                                 printk(KERN_ERR "hfs: file_umask requires a value\n");
 265                                 return 0;
 266                         }
 267                         hsb->s_file_umask = (umode_t)tmp;
 268                         break;
 269                 case opt_dir_umask:
 270                         if (match_octal(&args[0], &tmp)) {
 271                                 printk(KERN_ERR "hfs: dir_umask requires a value\n");
 272                                 return 0;
 273                         }
 274                         hsb->s_dir_umask = (umode_t)tmp;
 275                         break;
 276                 case opt_part:
 277                         if (match_int(&args[0], &hsb->part)) {
 278                                 printk(KERN_ERR "hfs: part requires an argument\n");
 279                                 return 0;
 280                         }
 281                         break;
 282                 case opt_session:
 283                         if (match_int(&args[0], &hsb->session)) {
 284                                 printk(KERN_ERR "hfs: session requires an argument\n");
 285                                 return 0;
 286                         }
 287                         break;
 288                 case opt_type:
 289                         if (match_fourchar(&args[0], &hsb->s_type)) {
 290                                 printk(KERN_ERR "hfs: type requires a 4 character value\n");
 291                                 return 0;
 292                         }
 293                         break;
 294                 case opt_creator:
 295                         if (match_fourchar(&args[0], &hsb->s_creator)) {
 296                                 printk(KERN_ERR "hfs: creator requires a 4 character value\n");
 297                                 return 0;
 298                         }
 299                         break;
 300                 case opt_quiet:
 301                         hsb->s_quiet = 1;
 302                         break;
 303                 case opt_codepage:
 304                         if (hsb->nls_disk) {
 305                                 printk(KERN_ERR "hfs: unable to change codepage\n");
 306                                 return 0;
 307                         }
 308                         p = match_strdup(&args[0]);
 309                         if (p)
 310                                 hsb->nls_disk = load_nls(p);
 311                         if (!hsb->nls_disk) {
 312                                 printk(KERN_ERR "hfs: unable to load codepage \"%s\"\n", p);
 313                                 kfree(p);
 314                                 return 0;
 315                         }
 316                         kfree(p);
 317                         break;
 318                 case opt_iocharset:
 319                         if (hsb->nls_io) {
 320                                 printk(KERN_ERR "hfs: unable to change iocharset\n");
 321                                 return 0;
 322                         }
 323                         p = match_strdup(&args[0]);
 324                         if (p)
 325                                 hsb->nls_io = load_nls(p);
 326                         if (!hsb->nls_io) {
 327                                 printk(KERN_ERR "hfs: unable to load iocharset \"%s\"\n", p);
 328                                 kfree(p);
 329                                 return 0;
 330                         }
 331                         kfree(p);
 332                         break;
 333                 default:
 334                         return 0;
 335                 }
 336         }
 337
 338         if (hsb->nls_disk && !hsb->nls_io) {
 339                 hsb->nls_io = load_nls_default();
 340                 if (!hsb->nls_io) {
 341                         printk(KERN_ERR "hfs: unable to load default iocharset\n");
 342                         return 0;
 343                 }
 344         }
 345         hsb->s_dir_umask &= 0777;
 346         hsb->s_file_umask &= 0577;
 347
 348         return 1;
 349 }
 350
 351 /*
 352  * hfs_read_super()
 353  *
 354  * This is the function that is responsible for mounting an HFS
 355  * filesystem.  It performs all the tasks necessary to get enough data
 356  * from the disk to read the root inode.  This includes parsing the
 357  * mount options, dealing with Macintosh partitions, reading the
 358  * superblock and the allocation bitmap blocks, calling
 359  * hfs_btree_init() to get the necessary data about the extents and
 360  * catalog B-trees and, finally, reading the root inode into memory.
 361  */
 362 static int hfs_fill_super(struct super_block *sb, void *data, int silent)
 363 {
 364         struct hfs_sb_info *sbi;
 365         struct hfs_find_data fd;
 366         hfs_cat_rec rec;
 367         struct inode *root_inode;
 368         int res;
 369
 370         sbi = kzalloc(sizeof(struct hfs_sb_info), GFP_KERNEL);
 371         if (!sbi)
 372                 return -ENOMEM;
 373         sb->s_fs_info = sbi;
 374         INIT_HLIST_HEAD(&sbi->rsrc_inodes);
 375
 376         res = -EINVAL;
 377         if (!parse_options((char *)data, sbi)) {
 378                 printk(KERN_ERR "hfs: unable to parse mount options.\n");
 379                 goto bail;
 380         }
 381
 382         sb->s_op = &hfs_super_operations;
 383         sb->s_flags |= MS_NODIRATIME;
 384         mutex_init(&sbi->bitmap_lock);
 385
 386         res = hfs_mdb_get(sb);
 387         if (res) {
 388                 if (!silent)
 389                         printk(KERN_WARNING "hfs: can't find a HFS filesystem on dev %s.\n",
 390                                 hfs_mdb_name(sb));
 391                 res = -EINVAL;
 392                 goto bail;
 393         }
 394
 395         /* try to get the root inode */
 396         hfs_find_init(HFS_SB(sb)->cat_tree, &fd);
 397         res = hfs_cat_find_brec(sb, HFS_ROOT_CNID, &fd);
 398         if (!res)
 399                 hfs_bnode_read(fd.bnode, &rec, fd.entryoffset, fd.entrylength);
 400         if (res) {
 401                 hfs_find_exit(&fd);
 402                 goto bail_no_root;
 403         }
 404         res = -EINVAL;
 405         root_inode = hfs_iget(sb, &fd.search_key->cat, &rec);
 406         hfs_find_exit(&fd);
 407         if (!root_inode)
 408                 goto bail_no_root;
 409
 410         res = -ENOMEM;
 411         sb->s_root = d_alloc_root(root_inode);
 412         if (!sb->s_root)
 413                 goto bail_iput;
 414
 415         sb->s_root->d_op = &hfs_dentry_operations;
 416
 417         /* everything's okay */
 418         return 0;
 419
 420 bail_iput:
 421         iput(root_inode);
 422 bail_no_root:
 423         printk(KERN_ERR "hfs: get root inode failed.\n");
 424 bail:
 425         hfs_mdb_put(sb);
 426         return res;
 427 }
 428
 429 static int hfs_get_sb(struct file_system_type *fs_type,
 430                       int flags, const char *dev_name, void *data,
 431                       struct vfsmount *mnt)
 432 {
 433         return get_sb_bdev(fs_type, flags, dev_name, data, hfs_fill_super, mnt);
 434 }
 435
 436 static struct file_system_type hfs_fs_type = {
 437         .owner          = THIS_MODULE,
 438         .name           = "hfs",
 439         .get_sb         = hfs_get_sb,
 440         .kill_sb        = kill_block_super,
 441         .fs_flags       = FS_REQUIRES_DEV,
 442 };
 443
 444 static void hfs_init_once(void *p)
 445 {
 446         struct hfs_inode_info *i = p;
 447
 448         inode_init_once(&i->vfs_inode);
 449 }
 450
 451 static int __init init_hfs_fs(void)
 452 {
 453         int err;
 454
 455         hfs_inode_cachep = kmem_cache_create("hfs_inode_cache",
 456                 sizeof(struct hfs_inode_info), 0, SLAB_HWCACHE_ALIGN,
 457                 hfs_init_once);
 458         if (!hfs_inode_cachep)
 459                 return -ENOMEM;
 460         err = register_filesystem(&hfs_fs_type);
 461         if (err)
 462                 kmem_cache_destroy(hfs_inode_cachep);
 463         return err;
 464 }
 465
 466 static void __exit exit_hfs_fs(void)
 467 {
 468         unregister_filesystem(&hfs_fs_type);
 469         kmem_cache_destroy(hfs_inode_cachep);
 470 }
 471
 472 module_init(init_hfs_fs)
 473 module_exit(exit_hfs_fs)