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