1 // SPDX-License-Identifier: GPL-2.0-only
3 * linux/fs/hfsplus/super.c
6 * Brad Boyer (flar@allandria.com)
7 * (C) 2003 Ardis Technologies <roman@ardistech.com>
11 #include <linux/module.h>
12 #include <linux/init.h>
13 #include <linux/pagemap.h>
14 #include <linux/blkdev.h>
15 #include <linux/backing-dev.h>
17 #include <linux/slab.h>
18 #include <linux/vfs.h>
19 #include <linux/nls.h>
21 static struct inode *hfsplus_alloc_inode(struct super_block *sb);
22 static void hfsplus_free_inode(struct inode *inode);
24 #include "hfsplus_fs.h"
27 static int hfsplus_system_read_inode(struct inode *inode)
29 struct hfsplus_vh *vhdr = HFSPLUS_SB(inode->i_sb)->s_vhdr;
31 switch (inode->i_ino) {
32 case HFSPLUS_EXT_CNID:
33 hfsplus_inode_read_fork(inode, &vhdr->ext_file);
34 inode->i_mapping->a_ops = &hfsplus_btree_aops;
36 case HFSPLUS_CAT_CNID:
37 hfsplus_inode_read_fork(inode, &vhdr->cat_file);
38 inode->i_mapping->a_ops = &hfsplus_btree_aops;
40 case HFSPLUS_ALLOC_CNID:
41 hfsplus_inode_read_fork(inode, &vhdr->alloc_file);
42 inode->i_mapping->a_ops = &hfsplus_aops;
44 case HFSPLUS_START_CNID:
45 hfsplus_inode_read_fork(inode, &vhdr->start_file);
47 case HFSPLUS_ATTR_CNID:
48 hfsplus_inode_read_fork(inode, &vhdr->attr_file);
49 inode->i_mapping->a_ops = &hfsplus_btree_aops;
58 struct inode *hfsplus_iget(struct super_block *sb, unsigned long ino)
60 struct hfs_find_data fd;
64 inode = iget_locked(sb, ino);
66 return ERR_PTR(-ENOMEM);
67 if (!(inode->i_state & I_NEW))
70 INIT_LIST_HEAD(&HFSPLUS_I(inode)->open_dir_list);
71 spin_lock_init(&HFSPLUS_I(inode)->open_dir_lock);
72 mutex_init(&HFSPLUS_I(inode)->extents_lock);
73 HFSPLUS_I(inode)->flags = 0;
74 HFSPLUS_I(inode)->extent_state = 0;
75 HFSPLUS_I(inode)->rsrc_inode = NULL;
76 atomic_set(&HFSPLUS_I(inode)->opencnt, 0);
78 if (inode->i_ino >= HFSPLUS_FIRSTUSER_CNID ||
79 inode->i_ino == HFSPLUS_ROOT_CNID) {
80 err = hfs_find_init(HFSPLUS_SB(inode->i_sb)->cat_tree, &fd);
82 err = hfsplus_find_cat(inode->i_sb, inode->i_ino, &fd);
84 err = hfsplus_cat_read_inode(inode, &fd);
88 err = hfsplus_system_read_inode(inode);
96 unlock_new_inode(inode);
100 static int hfsplus_system_write_inode(struct inode *inode)
102 struct hfsplus_sb_info *sbi = HFSPLUS_SB(inode->i_sb);
103 struct hfsplus_vh *vhdr = sbi->s_vhdr;
104 struct hfsplus_fork_raw *fork;
105 struct hfs_btree *tree = NULL;
107 switch (inode->i_ino) {
108 case HFSPLUS_EXT_CNID:
109 fork = &vhdr->ext_file;
110 tree = sbi->ext_tree;
112 case HFSPLUS_CAT_CNID:
113 fork = &vhdr->cat_file;
114 tree = sbi->cat_tree;
116 case HFSPLUS_ALLOC_CNID:
117 fork = &vhdr->alloc_file;
119 case HFSPLUS_START_CNID:
120 fork = &vhdr->start_file;
122 case HFSPLUS_ATTR_CNID:
123 fork = &vhdr->attr_file;
124 tree = sbi->attr_tree;
130 if (fork->total_size != cpu_to_be64(inode->i_size)) {
131 set_bit(HFSPLUS_SB_WRITEBACKUP, &sbi->flags);
132 hfsplus_mark_mdb_dirty(inode->i_sb);
134 hfsplus_inode_write_fork(inode, fork);
136 int err = hfs_btree_write(tree);
139 pr_err("b-tree write err: %d, ino %lu\n",
147 static int hfsplus_write_inode(struct inode *inode,
148 struct writeback_control *wbc)
152 hfs_dbg(INODE, "hfsplus_write_inode: %lu\n", inode->i_ino);
154 err = hfsplus_ext_write_extent(inode);
158 if (inode->i_ino >= HFSPLUS_FIRSTUSER_CNID ||
159 inode->i_ino == HFSPLUS_ROOT_CNID)
160 return hfsplus_cat_write_inode(inode);
162 return hfsplus_system_write_inode(inode);
165 static void hfsplus_evict_inode(struct inode *inode)
167 hfs_dbg(INODE, "hfsplus_evict_inode: %lu\n", inode->i_ino);
168 truncate_inode_pages_final(&inode->i_data);
170 if (HFSPLUS_IS_RSRC(inode)) {
171 HFSPLUS_I(HFSPLUS_I(inode)->rsrc_inode)->rsrc_inode = NULL;
172 iput(HFSPLUS_I(inode)->rsrc_inode);
176 static int hfsplus_sync_fs(struct super_block *sb, int wait)
178 struct hfsplus_sb_info *sbi = HFSPLUS_SB(sb);
179 struct hfsplus_vh *vhdr = sbi->s_vhdr;
180 int write_backup = 0;
186 hfs_dbg(SUPER, "hfsplus_sync_fs\n");
189 * Explicitly write out the special metadata inodes.
191 * While these special inodes are marked as hashed and written
192 * out peridocically by the flusher threads we redirty them
193 * during writeout of normal inodes, and thus the life lock
194 * prevents us from getting the latest state to disk.
196 error = filemap_write_and_wait(sbi->cat_tree->inode->i_mapping);
197 error2 = filemap_write_and_wait(sbi->ext_tree->inode->i_mapping);
200 if (sbi->attr_tree) {
202 filemap_write_and_wait(sbi->attr_tree->inode->i_mapping);
206 error2 = filemap_write_and_wait(sbi->alloc_file->i_mapping);
210 mutex_lock(&sbi->vh_mutex);
211 mutex_lock(&sbi->alloc_mutex);
212 vhdr->free_blocks = cpu_to_be32(sbi->free_blocks);
213 vhdr->next_cnid = cpu_to_be32(sbi->next_cnid);
214 vhdr->folder_count = cpu_to_be32(sbi->folder_count);
215 vhdr->file_count = cpu_to_be32(sbi->file_count);
217 if (test_and_clear_bit(HFSPLUS_SB_WRITEBACKUP, &sbi->flags)) {
218 memcpy(sbi->s_backup_vhdr, sbi->s_vhdr, sizeof(*sbi->s_vhdr));
222 error2 = hfsplus_submit_bio(sb,
223 sbi->part_start + HFSPLUS_VOLHEAD_SECTOR,
224 sbi->s_vhdr_buf, NULL, REQ_OP_WRITE,
231 error2 = hfsplus_submit_bio(sb,
232 sbi->part_start + sbi->sect_count - 2,
233 sbi->s_backup_vhdr_buf, NULL, REQ_OP_WRITE,
238 mutex_unlock(&sbi->alloc_mutex);
239 mutex_unlock(&sbi->vh_mutex);
241 if (!test_bit(HFSPLUS_SB_NOBARRIER, &sbi->flags))
242 blkdev_issue_flush(sb->s_bdev);
247 static void delayed_sync_fs(struct work_struct *work)
250 struct hfsplus_sb_info *sbi;
252 sbi = container_of(work, struct hfsplus_sb_info, sync_work.work);
254 spin_lock(&sbi->work_lock);
255 sbi->work_queued = 0;
256 spin_unlock(&sbi->work_lock);
258 err = hfsplus_sync_fs(sbi->alloc_file->i_sb, 1);
260 pr_err("delayed sync fs err %d\n", err);
263 void hfsplus_mark_mdb_dirty(struct super_block *sb)
265 struct hfsplus_sb_info *sbi = HFSPLUS_SB(sb);
271 spin_lock(&sbi->work_lock);
272 if (!sbi->work_queued) {
273 delay = msecs_to_jiffies(dirty_writeback_interval * 10);
274 queue_delayed_work(system_long_wq, &sbi->sync_work, delay);
275 sbi->work_queued = 1;
277 spin_unlock(&sbi->work_lock);
280 static void hfsplus_put_super(struct super_block *sb)
282 struct hfsplus_sb_info *sbi = HFSPLUS_SB(sb);
284 hfs_dbg(SUPER, "hfsplus_put_super\n");
286 cancel_delayed_work_sync(&sbi->sync_work);
288 if (!sb_rdonly(sb) && sbi->s_vhdr) {
289 struct hfsplus_vh *vhdr = sbi->s_vhdr;
291 vhdr->modify_date = hfsp_now2mt();
292 vhdr->attributes |= cpu_to_be32(HFSPLUS_VOL_UNMNT);
293 vhdr->attributes &= cpu_to_be32(~HFSPLUS_VOL_INCNSTNT);
295 hfsplus_sync_fs(sb, 1);
298 hfs_btree_close(sbi->attr_tree);
299 hfs_btree_close(sbi->cat_tree);
300 hfs_btree_close(sbi->ext_tree);
301 iput(sbi->alloc_file);
302 iput(sbi->hidden_dir);
303 kfree(sbi->s_vhdr_buf);
304 kfree(sbi->s_backup_vhdr_buf);
305 unload_nls(sbi->nls);
306 kfree(sb->s_fs_info);
307 sb->s_fs_info = NULL;
310 static int hfsplus_statfs(struct dentry *dentry, struct kstatfs *buf)
312 struct super_block *sb = dentry->d_sb;
313 struct hfsplus_sb_info *sbi = HFSPLUS_SB(sb);
314 u64 id = huge_encode_dev(sb->s_bdev->bd_dev);
316 buf->f_type = HFSPLUS_SUPER_MAGIC;
317 buf->f_bsize = sb->s_blocksize;
318 buf->f_blocks = sbi->total_blocks << sbi->fs_shift;
319 buf->f_bfree = sbi->free_blocks << sbi->fs_shift;
320 buf->f_bavail = buf->f_bfree;
321 buf->f_files = 0xFFFFFFFF;
322 buf->f_ffree = 0xFFFFFFFF - sbi->next_cnid;
323 buf->f_fsid = u64_to_fsid(id);
324 buf->f_namelen = HFSPLUS_MAX_STRLEN;
329 static int hfsplus_remount(struct super_block *sb, int *flags, char *data)
332 if ((bool)(*flags & SB_RDONLY) == sb_rdonly(sb))
334 if (!(*flags & SB_RDONLY)) {
335 struct hfsplus_vh *vhdr = HFSPLUS_SB(sb)->s_vhdr;
338 if (!hfsplus_parse_options_remount(data, &force))
341 if (!(vhdr->attributes & cpu_to_be32(HFSPLUS_VOL_UNMNT))) {
342 pr_warn("filesystem was not cleanly unmounted, running fsck.hfsplus is recommended. leaving read-only.\n");
343 sb->s_flags |= SB_RDONLY;
347 } else if (vhdr->attributes &
348 cpu_to_be32(HFSPLUS_VOL_SOFTLOCK)) {
349 pr_warn("filesystem is marked locked, leaving read-only.\n");
350 sb->s_flags |= SB_RDONLY;
352 } else if (vhdr->attributes &
353 cpu_to_be32(HFSPLUS_VOL_JOURNALED)) {
354 pr_warn("filesystem is marked journaled, leaving read-only.\n");
355 sb->s_flags |= SB_RDONLY;
362 static const struct super_operations hfsplus_sops = {
363 .alloc_inode = hfsplus_alloc_inode,
364 .free_inode = hfsplus_free_inode,
365 .write_inode = hfsplus_write_inode,
366 .evict_inode = hfsplus_evict_inode,
367 .put_super = hfsplus_put_super,
368 .sync_fs = hfsplus_sync_fs,
369 .statfs = hfsplus_statfs,
370 .remount_fs = hfsplus_remount,
371 .show_options = hfsplus_show_options,
374 static int hfsplus_fill_super(struct super_block *sb, void *data, int silent)
376 struct hfsplus_vh *vhdr;
377 struct hfsplus_sb_info *sbi;
378 hfsplus_cat_entry entry;
379 struct hfs_find_data fd;
380 struct inode *root, *inode;
382 struct nls_table *nls = NULL;
383 u64 last_fs_block, last_fs_page;
387 sbi = kzalloc(sizeof(*sbi), GFP_KERNEL);
392 mutex_init(&sbi->alloc_mutex);
393 mutex_init(&sbi->vh_mutex);
394 spin_lock_init(&sbi->work_lock);
395 INIT_DELAYED_WORK(&sbi->sync_work, delayed_sync_fs);
396 hfsplus_fill_defaults(sbi);
399 if (!hfsplus_parse_options(data, sbi)) {
400 pr_err("unable to parse mount options\n");
404 /* temporarily use utf8 to correctly find the hidden dir below */
406 sbi->nls = load_nls("utf8");
408 pr_err("unable to load nls for utf8\n");
412 /* Grab the volume header */
413 if (hfsplus_read_wrapper(sb)) {
415 pr_warn("unable to find HFS+ superblock\n");
420 /* Copy parts of the volume header into the superblock */
421 sb->s_magic = HFSPLUS_VOLHEAD_SIG;
422 if (be16_to_cpu(vhdr->version) < HFSPLUS_MIN_VERSION ||
423 be16_to_cpu(vhdr->version) > HFSPLUS_CURRENT_VERSION) {
424 pr_err("wrong filesystem version\n");
427 sbi->total_blocks = be32_to_cpu(vhdr->total_blocks);
428 sbi->free_blocks = be32_to_cpu(vhdr->free_blocks);
429 sbi->next_cnid = be32_to_cpu(vhdr->next_cnid);
430 sbi->file_count = be32_to_cpu(vhdr->file_count);
431 sbi->folder_count = be32_to_cpu(vhdr->folder_count);
432 sbi->data_clump_blocks =
433 be32_to_cpu(vhdr->data_clump_sz) >> sbi->alloc_blksz_shift;
434 if (!sbi->data_clump_blocks)
435 sbi->data_clump_blocks = 1;
436 sbi->rsrc_clump_blocks =
437 be32_to_cpu(vhdr->rsrc_clump_sz) >> sbi->alloc_blksz_shift;
438 if (!sbi->rsrc_clump_blocks)
439 sbi->rsrc_clump_blocks = 1;
442 last_fs_block = sbi->total_blocks - 1;
443 last_fs_page = (last_fs_block << sbi->alloc_blksz_shift) >>
446 if ((last_fs_block > (sector_t)(~0ULL) >> (sbi->alloc_blksz_shift - 9)) ||
447 (last_fs_page > (pgoff_t)(~0ULL))) {
448 pr_err("filesystem size too large\n");
452 /* Set up operations so we can load metadata */
453 sb->s_op = &hfsplus_sops;
454 sb->s_maxbytes = MAX_LFS_FILESIZE;
456 if (!(vhdr->attributes & cpu_to_be32(HFSPLUS_VOL_UNMNT))) {
457 pr_warn("Filesystem was not cleanly unmounted, running fsck.hfsplus is recommended. mounting read-only.\n");
458 sb->s_flags |= SB_RDONLY;
459 } else if (test_and_clear_bit(HFSPLUS_SB_FORCE, &sbi->flags)) {
461 } else if (vhdr->attributes & cpu_to_be32(HFSPLUS_VOL_SOFTLOCK)) {
462 pr_warn("Filesystem is marked locked, mounting read-only.\n");
463 sb->s_flags |= SB_RDONLY;
464 } else if ((vhdr->attributes & cpu_to_be32(HFSPLUS_VOL_JOURNALED)) &&
466 pr_warn("write access to a journaled filesystem is not supported, use the force option at your own risk, mounting read-only.\n");
467 sb->s_flags |= SB_RDONLY;
472 /* Load metadata objects (B*Trees) */
473 sbi->ext_tree = hfs_btree_open(sb, HFSPLUS_EXT_CNID);
474 if (!sbi->ext_tree) {
475 pr_err("failed to load extents file\n");
478 sbi->cat_tree = hfs_btree_open(sb, HFSPLUS_CAT_CNID);
479 if (!sbi->cat_tree) {
480 pr_err("failed to load catalog file\n");
481 goto out_close_ext_tree;
483 atomic_set(&sbi->attr_tree_state, HFSPLUS_EMPTY_ATTR_TREE);
484 if (vhdr->attr_file.total_blocks != 0) {
485 sbi->attr_tree = hfs_btree_open(sb, HFSPLUS_ATTR_CNID);
486 if (!sbi->attr_tree) {
487 pr_err("failed to load attributes file\n");
488 goto out_close_cat_tree;
490 atomic_set(&sbi->attr_tree_state, HFSPLUS_VALID_ATTR_TREE);
492 sb->s_xattr = hfsplus_xattr_handlers;
494 inode = hfsplus_iget(sb, HFSPLUS_ALLOC_CNID);
496 pr_err("failed to load allocation file\n");
497 err = PTR_ERR(inode);
498 goto out_close_attr_tree;
500 sbi->alloc_file = inode;
502 /* Load the root directory */
503 root = hfsplus_iget(sb, HFSPLUS_ROOT_CNID);
505 pr_err("failed to load root directory\n");
507 goto out_put_alloc_file;
510 sb->s_d_op = &hfsplus_dentry_operations;
511 sb->s_root = d_make_root(root);
514 goto out_put_alloc_file;
517 str.len = sizeof(HFSP_HIDDENDIR_NAME) - 1;
518 str.name = HFSP_HIDDENDIR_NAME;
519 err = hfs_find_init(sbi->cat_tree, &fd);
522 err = hfsplus_cat_build_key(sb, fd.search_key, HFSPLUS_ROOT_CNID, &str);
523 if (unlikely(err < 0))
525 if (!hfs_brec_read(&fd, &entry, sizeof(entry))) {
527 if (entry.type != cpu_to_be16(HFSPLUS_FOLDER)) {
531 inode = hfsplus_iget(sb, be32_to_cpu(entry.folder.id));
533 err = PTR_ERR(inode);
536 sbi->hidden_dir = inode;
540 if (!sb_rdonly(sb)) {
542 * H+LX == hfsplusutils, H+Lx == this driver, H+lx is unused
543 * all three are registered with Apple for our use
545 vhdr->last_mount_vers = cpu_to_be32(HFSP_MOUNT_VERSION);
546 vhdr->modify_date = hfsp_now2mt();
547 be32_add_cpu(&vhdr->write_count, 1);
548 vhdr->attributes &= cpu_to_be32(~HFSPLUS_VOL_UNMNT);
549 vhdr->attributes |= cpu_to_be32(HFSPLUS_VOL_INCNSTNT);
550 hfsplus_sync_fs(sb, 1);
552 if (!sbi->hidden_dir) {
553 mutex_lock(&sbi->vh_mutex);
554 sbi->hidden_dir = hfsplus_new_inode(sb, root, S_IFDIR);
555 if (!sbi->hidden_dir) {
556 mutex_unlock(&sbi->vh_mutex);
560 err = hfsplus_create_cat(sbi->hidden_dir->i_ino, root,
561 &str, sbi->hidden_dir);
563 mutex_unlock(&sbi->vh_mutex);
564 goto out_put_hidden_dir;
567 err = hfsplus_init_security(sbi->hidden_dir,
569 if (err == -EOPNOTSUPP)
570 err = 0; /* Operation is not supported. */
573 * Try to delete anyway without
576 hfsplus_delete_cat(sbi->hidden_dir->i_ino,
578 mutex_unlock(&sbi->vh_mutex);
579 goto out_put_hidden_dir;
582 mutex_unlock(&sbi->vh_mutex);
583 hfsplus_mark_inode_dirty(sbi->hidden_dir,
584 HFSPLUS_I_CAT_DIRTY);
588 unload_nls(sbi->nls);
593 cancel_delayed_work_sync(&sbi->sync_work);
594 iput(sbi->hidden_dir);
599 iput(sbi->alloc_file);
601 hfs_btree_close(sbi->attr_tree);
603 hfs_btree_close(sbi->cat_tree);
605 hfs_btree_close(sbi->ext_tree);
607 kfree(sbi->s_vhdr_buf);
608 kfree(sbi->s_backup_vhdr_buf);
610 unload_nls(sbi->nls);
617 MODULE_AUTHOR("Brad Boyer");
618 MODULE_DESCRIPTION("Extended Macintosh Filesystem");
619 MODULE_LICENSE("GPL");
621 static struct kmem_cache *hfsplus_inode_cachep;
623 static struct inode *hfsplus_alloc_inode(struct super_block *sb)
625 struct hfsplus_inode_info *i;
627 i = kmem_cache_alloc(hfsplus_inode_cachep, GFP_KERNEL);
628 return i ? &i->vfs_inode : NULL;
631 static void hfsplus_free_inode(struct inode *inode)
633 kmem_cache_free(hfsplus_inode_cachep, HFSPLUS_I(inode));
636 #define HFSPLUS_INODE_SIZE sizeof(struct hfsplus_inode_info)
638 static struct dentry *hfsplus_mount(struct file_system_type *fs_type,
639 int flags, const char *dev_name, void *data)
641 return mount_bdev(fs_type, flags, dev_name, data, hfsplus_fill_super);
644 static struct file_system_type hfsplus_fs_type = {
645 .owner = THIS_MODULE,
647 .mount = hfsplus_mount,
648 .kill_sb = kill_block_super,
649 .fs_flags = FS_REQUIRES_DEV,
651 MODULE_ALIAS_FS("hfsplus");
653 static void hfsplus_init_once(void *p)
655 struct hfsplus_inode_info *i = p;
657 inode_init_once(&i->vfs_inode);
660 static int __init init_hfsplus_fs(void)
664 hfsplus_inode_cachep = kmem_cache_create("hfsplus_icache",
665 HFSPLUS_INODE_SIZE, 0, SLAB_HWCACHE_ALIGN|SLAB_ACCOUNT,
667 if (!hfsplus_inode_cachep)
669 err = hfsplus_create_attr_tree_cache();
671 goto destroy_inode_cache;
672 err = register_filesystem(&hfsplus_fs_type);
674 goto destroy_attr_tree_cache;
677 destroy_attr_tree_cache:
678 hfsplus_destroy_attr_tree_cache();
681 kmem_cache_destroy(hfsplus_inode_cachep);
686 static void __exit exit_hfsplus_fs(void)
688 unregister_filesystem(&hfsplus_fs_type);
691 * Make sure all delayed rcu free inodes are flushed before we
695 hfsplus_destroy_attr_tree_cache();
696 kmem_cache_destroy(hfsplus_inode_cachep);
699 module_init(init_hfsplus_fs)
700 module_exit(exit_hfsplus_fs)