4 * Copyright (C) 1995-1997 Paul H. Hargrove
6 * This file may be distributed under the terms of the GNU General Public License.
8 * This file contains inode-related functions which do not depend on
9 * which scheme is being used to represent forks.
11 * Based on the minix file system code, (C) 1991, 1992 by Linus Torvalds
14 #include <linux/pagemap.h>
15 #include <linux/mpage.h>
16 #include <linux/sched.h>
17 #include <linux/cred.h>
18 #include <linux/uio.h>
19 #include <linux/xattr.h>
20 #include <linux/blkdev.h>
25 static const struct file_operations hfs_file_operations;
26 static const struct inode_operations hfs_file_inode_operations;
28 /*================ Variable-like macros ================*/
30 #define HFS_VALID_MODE_BITS (S_IFREG | S_IFDIR | S_IRWXUGO)
32 static int hfs_read_folio(struct file *file, struct folio *folio)
34 return block_read_full_folio(folio, hfs_get_block);
37 static void hfs_write_failed(struct address_space *mapping, loff_t to)
39 struct inode *inode = mapping->host;
41 if (to > inode->i_size) {
42 truncate_pagecache(inode, inode->i_size);
43 hfs_file_truncate(inode);
47 int hfs_write_begin(struct file *file, struct address_space *mapping,
48 loff_t pos, unsigned len, struct page **pagep, void **fsdata)
53 ret = cont_write_begin(file, mapping, pos, len, pagep, fsdata,
55 &HFS_I(mapping->host)->phys_size);
57 hfs_write_failed(mapping, pos + len);
62 static sector_t hfs_bmap(struct address_space *mapping, sector_t block)
64 return generic_block_bmap(mapping, block, hfs_get_block);
67 static bool hfs_release_folio(struct folio *folio, gfp_t mask)
69 struct inode *inode = folio->mapping->host;
70 struct super_block *sb = inode->i_sb;
71 struct hfs_btree *tree;
72 struct hfs_bnode *node;
77 switch (inode->i_ino) {
79 tree = HFS_SB(sb)->ext_tree;
82 tree = HFS_SB(sb)->cat_tree;
92 if (tree->node_size >= PAGE_SIZE) {
93 nidx = folio->index >> (tree->node_size_shift - PAGE_SHIFT);
94 spin_lock(&tree->hash_lock);
95 node = hfs_bnode_findhash(tree, nidx);
98 else if (atomic_read(&node->refcnt))
101 hfs_bnode_unhash(node);
102 hfs_bnode_free(node);
104 spin_unlock(&tree->hash_lock);
106 nidx = folio->index << (PAGE_SHIFT - tree->node_size_shift);
107 i = 1 << (PAGE_SHIFT - tree->node_size_shift);
108 spin_lock(&tree->hash_lock);
110 node = hfs_bnode_findhash(tree, nidx++);
113 if (atomic_read(&node->refcnt)) {
117 hfs_bnode_unhash(node);
118 hfs_bnode_free(node);
119 } while (--i && nidx < tree->node_count);
120 spin_unlock(&tree->hash_lock);
122 return res ? try_to_free_buffers(folio) : false;
125 static ssize_t hfs_direct_IO(struct kiocb *iocb, struct iov_iter *iter)
127 struct file *file = iocb->ki_filp;
128 struct address_space *mapping = file->f_mapping;
129 struct inode *inode = mapping->host;
130 size_t count = iov_iter_count(iter);
133 ret = blockdev_direct_IO(iocb, inode, iter, hfs_get_block);
136 * In case of error extending write may have instantiated a few
137 * blocks outside i_size. Trim these off again.
139 if (unlikely(iov_iter_rw(iter) == WRITE && ret < 0)) {
140 loff_t isize = i_size_read(inode);
141 loff_t end = iocb->ki_pos + count;
144 hfs_write_failed(mapping, end);
150 static int hfs_writepages(struct address_space *mapping,
151 struct writeback_control *wbc)
153 return mpage_writepages(mapping, wbc, hfs_get_block);
156 const struct address_space_operations hfs_btree_aops = {
157 .dirty_folio = block_dirty_folio,
158 .invalidate_folio = block_invalidate_folio,
159 .read_folio = hfs_read_folio,
160 .writepages = hfs_writepages,
161 .write_begin = hfs_write_begin,
162 .write_end = generic_write_end,
163 .migrate_folio = buffer_migrate_folio,
165 .release_folio = hfs_release_folio,
168 const struct address_space_operations hfs_aops = {
169 .dirty_folio = block_dirty_folio,
170 .invalidate_folio = block_invalidate_folio,
171 .read_folio = hfs_read_folio,
172 .write_begin = hfs_write_begin,
173 .write_end = generic_write_end,
175 .direct_IO = hfs_direct_IO,
176 .writepages = hfs_writepages,
177 .migrate_folio = buffer_migrate_folio,
183 struct inode *hfs_new_inode(struct inode *dir, const struct qstr *name, umode_t mode)
185 struct super_block *sb = dir->i_sb;
186 struct inode *inode = new_inode(sb);
190 mutex_init(&HFS_I(inode)->extents_lock);
191 INIT_LIST_HEAD(&HFS_I(inode)->open_dir_list);
192 spin_lock_init(&HFS_I(inode)->open_dir_lock);
193 hfs_cat_build_key(sb, (btree_key *)&HFS_I(inode)->cat_key, dir->i_ino, name);
194 inode->i_ino = HFS_SB(sb)->next_id++;
195 inode->i_mode = mode;
196 inode->i_uid = current_fsuid();
197 inode->i_gid = current_fsgid();
199 simple_inode_init_ts(inode);
200 HFS_I(inode)->flags = 0;
201 HFS_I(inode)->rsrc_inode = NULL;
202 HFS_I(inode)->fs_blocks = 0;
203 HFS_I(inode)->tz_secondswest = sys_tz.tz_minuteswest * 60;
206 HFS_SB(sb)->folder_count++;
207 if (dir->i_ino == HFS_ROOT_CNID)
208 HFS_SB(sb)->root_dirs++;
209 inode->i_op = &hfs_dir_inode_operations;
210 inode->i_fop = &hfs_dir_operations;
211 inode->i_mode |= S_IRWXUGO;
212 inode->i_mode &= ~HFS_SB(inode->i_sb)->s_dir_umask;
213 } else if (S_ISREG(mode)) {
214 HFS_I(inode)->clump_blocks = HFS_SB(sb)->clumpablks;
215 HFS_SB(sb)->file_count++;
216 if (dir->i_ino == HFS_ROOT_CNID)
217 HFS_SB(sb)->root_files++;
218 inode->i_op = &hfs_file_inode_operations;
219 inode->i_fop = &hfs_file_operations;
220 inode->i_mapping->a_ops = &hfs_aops;
221 inode->i_mode |= S_IRUGO|S_IXUGO;
223 inode->i_mode |= S_IWUGO;
224 inode->i_mode &= ~HFS_SB(inode->i_sb)->s_file_umask;
225 HFS_I(inode)->phys_size = 0;
226 HFS_I(inode)->alloc_blocks = 0;
227 HFS_I(inode)->first_blocks = 0;
228 HFS_I(inode)->cached_start = 0;
229 HFS_I(inode)->cached_blocks = 0;
230 memset(HFS_I(inode)->first_extents, 0, sizeof(hfs_extent_rec));
231 memset(HFS_I(inode)->cached_extents, 0, sizeof(hfs_extent_rec));
233 insert_inode_hash(inode);
234 mark_inode_dirty(inode);
235 set_bit(HFS_FLG_MDB_DIRTY, &HFS_SB(sb)->flags);
236 hfs_mark_mdb_dirty(sb);
241 void hfs_delete_inode(struct inode *inode)
243 struct super_block *sb = inode->i_sb;
245 hfs_dbg(INODE, "delete_inode: %lu\n", inode->i_ino);
246 if (S_ISDIR(inode->i_mode)) {
247 HFS_SB(sb)->folder_count--;
248 if (HFS_I(inode)->cat_key.ParID == cpu_to_be32(HFS_ROOT_CNID))
249 HFS_SB(sb)->root_dirs--;
250 set_bit(HFS_FLG_MDB_DIRTY, &HFS_SB(sb)->flags);
251 hfs_mark_mdb_dirty(sb);
254 HFS_SB(sb)->file_count--;
255 if (HFS_I(inode)->cat_key.ParID == cpu_to_be32(HFS_ROOT_CNID))
256 HFS_SB(sb)->root_files--;
257 if (S_ISREG(inode->i_mode)) {
258 if (!inode->i_nlink) {
260 hfs_file_truncate(inode);
263 set_bit(HFS_FLG_MDB_DIRTY, &HFS_SB(sb)->flags);
264 hfs_mark_mdb_dirty(sb);
267 void hfs_inode_read_fork(struct inode *inode, struct hfs_extent *ext,
268 __be32 __log_size, __be32 phys_size, u32 clump_size)
270 struct super_block *sb = inode->i_sb;
271 u32 log_size = be32_to_cpu(__log_size);
275 memcpy(HFS_I(inode)->first_extents, ext, sizeof(hfs_extent_rec));
276 for (count = 0, i = 0; i < 3; i++)
277 count += be16_to_cpu(ext[i].count);
278 HFS_I(inode)->first_blocks = count;
279 HFS_I(inode)->cached_start = 0;
280 HFS_I(inode)->cached_blocks = 0;
282 inode->i_size = HFS_I(inode)->phys_size = log_size;
283 HFS_I(inode)->fs_blocks = (log_size + sb->s_blocksize - 1) >> sb->s_blocksize_bits;
284 inode_set_bytes(inode, HFS_I(inode)->fs_blocks << sb->s_blocksize_bits);
285 HFS_I(inode)->alloc_blocks = be32_to_cpu(phys_size) /
286 HFS_SB(sb)->alloc_blksz;
287 HFS_I(inode)->clump_blocks = clump_size / HFS_SB(sb)->alloc_blksz;
288 if (!HFS_I(inode)->clump_blocks)
289 HFS_I(inode)->clump_blocks = HFS_SB(sb)->clumpablks;
292 struct hfs_iget_data {
293 struct hfs_cat_key *key;
297 static int hfs_test_inode(struct inode *inode, void *data)
299 struct hfs_iget_data *idata = data;
305 return inode->i_ino == be32_to_cpu(rec->dir.DirID);
307 return inode->i_ino == be32_to_cpu(rec->file.FlNum);
317 static int hfs_read_inode(struct inode *inode, void *data)
319 struct hfs_iget_data *idata = data;
320 struct hfs_sb_info *hsb = HFS_SB(inode->i_sb);
323 HFS_I(inode)->flags = 0;
324 HFS_I(inode)->rsrc_inode = NULL;
325 mutex_init(&HFS_I(inode)->extents_lock);
326 INIT_LIST_HEAD(&HFS_I(inode)->open_dir_list);
327 spin_lock_init(&HFS_I(inode)->open_dir_lock);
329 /* Initialize the inode */
330 inode->i_uid = hsb->s_uid;
331 inode->i_gid = hsb->s_gid;
335 HFS_I(inode)->cat_key = *idata->key;
337 HFS_I(inode)->flags |= HFS_FLG_RSRC;
338 HFS_I(inode)->tz_secondswest = sys_tz.tz_minuteswest * 60;
343 if (!HFS_IS_RSRC(inode)) {
344 hfs_inode_read_fork(inode, rec->file.ExtRec, rec->file.LgLen,
345 rec->file.PyLen, be16_to_cpu(rec->file.ClpSize));
347 hfs_inode_read_fork(inode, rec->file.RExtRec, rec->file.RLgLen,
348 rec->file.RPyLen, be16_to_cpu(rec->file.ClpSize));
351 inode->i_ino = be32_to_cpu(rec->file.FlNum);
352 inode->i_mode = S_IRUGO | S_IXUGO;
353 if (!(rec->file.Flags & HFS_FIL_LOCK))
354 inode->i_mode |= S_IWUGO;
355 inode->i_mode &= ~hsb->s_file_umask;
356 inode->i_mode |= S_IFREG;
357 inode_set_mtime_to_ts(inode,
358 inode_set_atime_to_ts(inode, inode_set_ctime_to_ts(inode, hfs_m_to_utime(rec->file.MdDat))));
359 inode->i_op = &hfs_file_inode_operations;
360 inode->i_fop = &hfs_file_operations;
361 inode->i_mapping->a_ops = &hfs_aops;
364 inode->i_ino = be32_to_cpu(rec->dir.DirID);
365 inode->i_size = be16_to_cpu(rec->dir.Val) + 2;
366 HFS_I(inode)->fs_blocks = 0;
367 inode->i_mode = S_IFDIR | (S_IRWXUGO & ~hsb->s_dir_umask);
368 inode_set_mtime_to_ts(inode,
369 inode_set_atime_to_ts(inode, inode_set_ctime_to_ts(inode, hfs_m_to_utime(rec->dir.MdDat))));
370 inode->i_op = &hfs_dir_inode_operations;
371 inode->i_fop = &hfs_dir_operations;
374 make_bad_inode(inode);
382 * Given the MDB for a HFS filesystem, a 'key' and an 'entry' in
383 * the catalog B-tree and the 'type' of the desired file return the
384 * inode for that file/directory or NULL. Note that 'type' indicates
385 * whether we want the actual file or directory, or the corresponding
386 * metadata (AppleDouble header file or CAP metadata file).
388 struct inode *hfs_iget(struct super_block *sb, struct hfs_cat_key *key, hfs_cat_rec *rec)
390 struct hfs_iget_data data = { key, rec };
396 cnid = be32_to_cpu(rec->dir.DirID);
399 cnid = be32_to_cpu(rec->file.FlNum);
404 inode = iget5_locked(sb, cnid, hfs_test_inode, hfs_read_inode, &data);
405 if (inode && (inode->i_state & I_NEW))
406 unlock_new_inode(inode);
410 void hfs_inode_write_fork(struct inode *inode, struct hfs_extent *ext,
411 __be32 *log_size, __be32 *phys_size)
413 memcpy(ext, HFS_I(inode)->first_extents, sizeof(hfs_extent_rec));
416 *log_size = cpu_to_be32(inode->i_size);
418 *phys_size = cpu_to_be32(HFS_I(inode)->alloc_blocks *
419 HFS_SB(inode->i_sb)->alloc_blksz);
422 int hfs_write_inode(struct inode *inode, struct writeback_control *wbc)
424 struct inode *main_inode = inode;
425 struct hfs_find_data fd;
429 hfs_dbg(INODE, "hfs_write_inode: %lu\n", inode->i_ino);
430 res = hfs_ext_write_extent(inode);
434 if (inode->i_ino < HFS_FIRSTUSER_CNID) {
435 switch (inode->i_ino) {
439 hfs_btree_write(HFS_SB(inode->i_sb)->ext_tree);
442 hfs_btree_write(HFS_SB(inode->i_sb)->cat_tree);
450 if (HFS_IS_RSRC(inode))
451 main_inode = HFS_I(inode)->rsrc_inode;
453 if (!main_inode->i_nlink)
456 if (hfs_find_init(HFS_SB(main_inode->i_sb)->cat_tree, &fd))
461 if (HFS_I(main_inode)->cat_key.CName.len > HFS_NAMELEN)
463 fd.search_key->cat = HFS_I(main_inode)->cat_key;
464 if (hfs_brec_find(&fd))
467 if (S_ISDIR(main_inode->i_mode)) {
468 if (fd.entrylength < sizeof(struct hfs_cat_dir))
470 hfs_bnode_read(fd.bnode, &rec, fd.entryoffset,
471 sizeof(struct hfs_cat_dir));
472 if (rec.type != HFS_CDR_DIR ||
473 be32_to_cpu(rec.dir.DirID) != inode->i_ino) {
476 rec.dir.MdDat = hfs_u_to_mtime(inode_get_mtime(inode));
477 rec.dir.Val = cpu_to_be16(inode->i_size - 2);
479 hfs_bnode_write(fd.bnode, &rec, fd.entryoffset,
480 sizeof(struct hfs_cat_dir));
481 } else if (HFS_IS_RSRC(inode)) {
482 if (fd.entrylength < sizeof(struct hfs_cat_file))
484 hfs_bnode_read(fd.bnode, &rec, fd.entryoffset,
485 sizeof(struct hfs_cat_file));
486 hfs_inode_write_fork(inode, rec.file.RExtRec,
487 &rec.file.RLgLen, &rec.file.RPyLen);
488 hfs_bnode_write(fd.bnode, &rec, fd.entryoffset,
489 sizeof(struct hfs_cat_file));
491 if (fd.entrylength < sizeof(struct hfs_cat_file))
493 hfs_bnode_read(fd.bnode, &rec, fd.entryoffset,
494 sizeof(struct hfs_cat_file));
495 if (rec.type != HFS_CDR_FIL ||
496 be32_to_cpu(rec.file.FlNum) != inode->i_ino) {
499 if (inode->i_mode & S_IWUSR)
500 rec.file.Flags &= ~HFS_FIL_LOCK;
502 rec.file.Flags |= HFS_FIL_LOCK;
503 hfs_inode_write_fork(inode, rec.file.ExtRec, &rec.file.LgLen, &rec.file.PyLen);
504 rec.file.MdDat = hfs_u_to_mtime(inode_get_mtime(inode));
506 hfs_bnode_write(fd.bnode, &rec, fd.entryoffset,
507 sizeof(struct hfs_cat_file));
515 static struct dentry *hfs_file_lookup(struct inode *dir, struct dentry *dentry,
518 struct inode *inode = NULL;
520 struct hfs_find_data fd;
523 if (HFS_IS_RSRC(dir) || strcmp(dentry->d_name.name, "rsrc"))
526 inode = HFS_I(dir)->rsrc_inode;
530 inode = new_inode(dir->i_sb);
532 return ERR_PTR(-ENOMEM);
534 res = hfs_find_init(HFS_SB(dir->i_sb)->cat_tree, &fd);
539 fd.search_key->cat = HFS_I(dir)->cat_key;
540 res = hfs_brec_read(&fd, &rec, sizeof(rec));
542 struct hfs_iget_data idata = { NULL, &rec };
543 hfs_read_inode(inode, &idata);
550 HFS_I(inode)->rsrc_inode = dir;
551 HFS_I(dir)->rsrc_inode = inode;
553 inode_fake_hash(inode);
554 mark_inode_dirty(inode);
557 return d_splice_alias(inode, dentry);
560 void hfs_evict_inode(struct inode *inode)
562 truncate_inode_pages_final(&inode->i_data);
564 if (HFS_IS_RSRC(inode) && HFS_I(inode)->rsrc_inode) {
565 HFS_I(HFS_I(inode)->rsrc_inode)->rsrc_inode = NULL;
566 iput(HFS_I(inode)->rsrc_inode);
570 static int hfs_file_open(struct inode *inode, struct file *file)
572 if (HFS_IS_RSRC(inode))
573 inode = HFS_I(inode)->rsrc_inode;
574 atomic_inc(&HFS_I(inode)->opencnt);
578 static int hfs_file_release(struct inode *inode, struct file *file)
580 //struct super_block *sb = inode->i_sb;
582 if (HFS_IS_RSRC(inode))
583 inode = HFS_I(inode)->rsrc_inode;
584 if (atomic_dec_and_test(&HFS_I(inode)->opencnt)) {
586 hfs_file_truncate(inode);
587 //if (inode->i_flags & S_DEAD) {
588 // hfs_delete_cat(inode->i_ino, HFSPLUS_SB(sb).hidden_dir, NULL);
589 // hfs_delete_inode(inode);
597 * hfs_notify_change()
599 * Based very closely on fs/msdos/inode.c by Werner Almesberger
601 * This is the notify_change() field in the super_operations structure
602 * for HFS file systems. The purpose is to take that changes made to
603 * an inode and apply then in a filesystem-dependent manner. In this
604 * case the process has a few of tasks to do:
605 * 1) prevent changes to the i_uid and i_gid fields.
606 * 2) map file permissions to the closest allowable permissions
607 * 3) Since multiple Linux files can share the same on-disk inode under
608 * HFS (for instance the data and resource forks of a file) a change
609 * to permissions must be applied to all other in-core inodes which
610 * correspond to the same HFS file.
613 int hfs_inode_setattr(struct mnt_idmap *idmap, struct dentry *dentry,
616 struct inode *inode = d_inode(dentry);
617 struct hfs_sb_info *hsb = HFS_SB(inode->i_sb);
620 error = setattr_prepare(&nop_mnt_idmap, dentry,
621 attr); /* basic permission checks */
625 /* no uig/gid changes and limit which mode bits can be set */
626 if (((attr->ia_valid & ATTR_UID) &&
627 (!uid_eq(attr->ia_uid, hsb->s_uid))) ||
628 ((attr->ia_valid & ATTR_GID) &&
629 (!gid_eq(attr->ia_gid, hsb->s_gid))) ||
630 ((attr->ia_valid & ATTR_MODE) &&
631 ((S_ISDIR(inode->i_mode) &&
632 (attr->ia_mode != inode->i_mode)) ||
633 (attr->ia_mode & ~HFS_VALID_MODE_BITS)))) {
634 return hsb->s_quiet ? 0 : error;
637 if (attr->ia_valid & ATTR_MODE) {
638 /* Only the 'w' bits can ever change and only all together. */
639 if (attr->ia_mode & S_IWUSR)
640 attr->ia_mode = inode->i_mode | S_IWUGO;
642 attr->ia_mode = inode->i_mode & ~S_IWUGO;
643 attr->ia_mode &= S_ISDIR(inode->i_mode) ? ~hsb->s_dir_umask: ~hsb->s_file_umask;
646 if ((attr->ia_valid & ATTR_SIZE) &&
647 attr->ia_size != i_size_read(inode)) {
648 inode_dio_wait(inode);
650 error = inode_newsize_ok(inode, attr->ia_size);
654 truncate_setsize(inode, attr->ia_size);
655 hfs_file_truncate(inode);
656 simple_inode_init_ts(inode);
659 setattr_copy(&nop_mnt_idmap, inode, attr);
660 mark_inode_dirty(inode);
664 static int hfs_file_fsync(struct file *filp, loff_t start, loff_t end,
667 struct inode *inode = filp->f_mapping->host;
668 struct super_block * sb;
671 ret = file_write_and_wait_range(filp, start, end);
676 /* sync the inode to buffers */
677 ret = write_inode_now(inode, 0);
679 /* sync the superblock to buffers */
681 flush_delayed_work(&HFS_SB(sb)->mdb_work);
682 /* .. finally sync the buffers to disk */
683 err = sync_blockdev(sb->s_bdev);
690 static const struct file_operations hfs_file_operations = {
691 .llseek = generic_file_llseek,
692 .read_iter = generic_file_read_iter,
693 .write_iter = generic_file_write_iter,
694 .mmap = generic_file_mmap,
695 .splice_read = filemap_splice_read,
696 .fsync = hfs_file_fsync,
697 .open = hfs_file_open,
698 .release = hfs_file_release,
701 static const struct inode_operations hfs_file_inode_operations = {
702 .lookup = hfs_file_lookup,
703 .setattr = hfs_inode_setattr,
704 .listxattr = generic_listxattr,