1 /*
2  *  linux/fs/hfs/hfs_fs.h
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 
9 #ifndef _LINUX_HFS_FS_H
10 #define _LINUX_HFS_FS_H
11 
12 #ifdef pr_fmt
13 #undef pr_fmt
14 #endif
15 
16 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
17 
18 #include <linux/slab.h>
19 #include <linux/types.h>
20 #include <linux/mutex.h>
21 #include <linux/buffer_head.h>
22 #include <linux/fs.h>
23 #include <linux/workqueue.h>
24 
25 #include <asm/byteorder.h>
26 #include <linux/uaccess.h>
27 
28 #include "hfs.h"
29 
30 #define DBG_BNODE_REFS	0x00000001
31 #define DBG_BNODE_MOD	0x00000002
32 #define DBG_CAT_MOD	0x00000004
33 #define DBG_INODE	0x00000008
34 #define DBG_SUPER	0x00000010
35 #define DBG_EXTENT	0x00000020
36 #define DBG_BITMAP	0x00000040
37 
38 //#define DBG_MASK	(DBG_EXTENT|DBG_INODE|DBG_BNODE_MOD|DBG_CAT_MOD|DBG_BITMAP)
39 //#define DBG_MASK	(DBG_BNODE_MOD|DBG_CAT_MOD|DBG_INODE)
40 //#define DBG_MASK	(DBG_CAT_MOD|DBG_BNODE_REFS|DBG_INODE|DBG_EXTENT)
41 #define DBG_MASK	(0)
42 
43 #define hfs_dbg(flg, fmt, ...)					\
44 do {								\
45 	if (DBG_##flg & DBG_MASK)				\
46 		printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__);	\
47 } while (0)
48 
49 #define hfs_dbg_cont(flg, fmt, ...)				\
50 do {								\
51 	if (DBG_##flg & DBG_MASK)				\
52 		pr_cont(fmt, ##__VA_ARGS__);			\
53 } while (0)
54 
55 
56 /*
57  * struct hfs_inode_info
58  *
59  * The HFS-specific part of a Linux (struct inode)
60  */
61 struct hfs_inode_info {
62 	atomic_t opencnt;
63 
64 	unsigned int flags;
65 
66 	/* to deal with localtime ugliness */
67 	int tz_secondswest;
68 
69 	struct hfs_cat_key cat_key;
70 
71 	struct list_head open_dir_list;
72 	spinlock_t open_dir_lock;
73 	struct inode *rsrc_inode;
74 
75 	struct mutex extents_lock;
76 
77 	u16 alloc_blocks, clump_blocks;
78 	sector_t fs_blocks;
79 	/* Allocation extents from catlog record or volume header */
80 	hfs_extent_rec first_extents;
81 	u16 first_blocks;
82 	hfs_extent_rec cached_extents;
83 	u16 cached_start, cached_blocks;
84 
85 	loff_t phys_size;
86 	struct inode vfs_inode;
87 };
88 
89 #define HFS_FLG_RSRC		0x0001
90 #define HFS_FLG_EXT_DIRTY	0x0002
91 #define HFS_FLG_EXT_NEW		0x0004
92 
93 #define HFS_IS_RSRC(inode)	(HFS_I(inode)->flags & HFS_FLG_RSRC)
94 
95 /*
96  * struct hfs_sb_info
97  *
98  * The HFS-specific part of a Linux (struct super_block)
99  */
100 struct hfs_sb_info {
101 	struct buffer_head *mdb_bh;		/* The hfs_buffer
102 						   holding the real
103 						   superblock (aka VIB
104 						   or MDB) */
105 	struct hfs_mdb *mdb;
106 	struct buffer_head *alt_mdb_bh;		/* The hfs_buffer holding
107 						   the alternate superblock */
108 	struct hfs_mdb *alt_mdb;
109 	__be32 *bitmap;				/* The page holding the
110 						   allocation bitmap */
111 	struct hfs_btree *ext_tree;			/* Information about
112 						   the extents b-tree */
113 	struct hfs_btree *cat_tree;			/* Information about
114 						   the catalog b-tree */
115 	u32 file_count;				/* The number of
116 						   regular files in
117 						   the filesystem */
118 	u32 folder_count;			/* The number of
119 						   directories in the
120 						   filesystem */
121 	u32 next_id;				/* The next available
122 						   file id number */
123 	u32 clumpablks;				/* The number of allocation
124 						   blocks to try to add when
125 						   extending a file */
126 	u32 fs_start;				/* The first 512-byte
127 						   block represented
128 						   in the bitmap */
129 	u32 part_start;
130 	u16 root_files;				/* The number of
131 						   regular
132 						   (non-directory)
133 						   files in the root
134 						   directory */
135 	u16 root_dirs;				/* The number of
136 						   directories in the
137 						   root directory */
138 	u16 fs_ablocks;				/* The number of
139 						   allocation blocks
140 						   in the filesystem */
141 	u16 free_ablocks;			/* the number of unused
142 						   allocation blocks
143 						   in the filesystem */
144 	u32 alloc_blksz;			/* The size of an
145 						   "allocation block" */
146 	int s_quiet;				/* Silent failure when
147 						   changing owner or mode? */
148 	__be32 s_type;				/* Type for new files */
149 	__be32 s_creator;			/* Creator for new files */
150 	umode_t s_file_umask;			/* The umask applied to the
151 						   permissions on all files */
152 	umode_t s_dir_umask;			/* The umask applied to the
153 						   permissions on all dirs */
154 	kuid_t s_uid;				/* The uid of all files */
155 	kgid_t s_gid;				/* The gid of all files */
156 
157 	int session, part;
158 	struct nls_table *nls_io, *nls_disk;
159 	struct mutex bitmap_lock;
160 	unsigned long flags;
161 	u16 blockoffset;
162 	int fs_div;
163 	struct super_block *sb;
164 	int work_queued;		/* non-zero delayed work is queued */
165 	struct delayed_work mdb_work;	/* MDB flush delayed work */
166 	spinlock_t work_lock;		/* protects mdb_work and work_queued */
167 };
168 
169 #define HFS_FLG_BITMAP_DIRTY	0
170 #define HFS_FLG_MDB_DIRTY	1
171 #define HFS_FLG_ALT_MDB_DIRTY	2
172 
173 /* bitmap.c */
174 extern u32 hfs_vbm_search_free(struct super_block *, u32, u32 *);
175 extern int hfs_clear_vbm_bits(struct super_block *, u16, u16);
176 
177 /* catalog.c */
178 extern int hfs_cat_keycmp(const btree_key *, const btree_key *);
179 struct hfs_find_data;
180 extern int hfs_cat_find_brec(struct super_block *, u32, struct hfs_find_data *);
181 extern int hfs_cat_create(u32, struct inode *, const struct qstr *, struct inode *);
182 extern int hfs_cat_delete(u32, struct inode *, const struct qstr *);
183 extern int hfs_cat_move(u32, struct inode *, const struct qstr *,
184 			struct inode *, const struct qstr *);
185 extern void hfs_cat_build_key(struct super_block *, btree_key *, u32, const struct qstr *);
186 
187 /* dir.c */
188 extern const struct file_operations hfs_dir_operations;
189 extern const struct inode_operations hfs_dir_inode_operations;
190 
191 /* extent.c */
192 extern int hfs_ext_keycmp(const btree_key *, const btree_key *);
193 extern int hfs_free_fork(struct super_block *, struct hfs_cat_file *, int);
194 extern int hfs_ext_write_extent(struct inode *);
195 extern int hfs_extend_file(struct inode *);
196 extern void hfs_file_truncate(struct inode *);
197 
198 extern int hfs_get_block(struct inode *, sector_t, struct buffer_head *, int);
199 
200 /* inode.c */
201 extern const struct address_space_operations hfs_aops;
202 extern const struct address_space_operations hfs_btree_aops;
203 
204 int hfs_write_begin(struct file *file, struct address_space *mapping,
205 		loff_t pos, unsigned len, struct page **pagep, void **fsdata);
206 extern struct inode *hfs_new_inode(struct inode *, const struct qstr *, umode_t);
207 extern void hfs_inode_write_fork(struct inode *, struct hfs_extent *, __be32 *, __be32 *);
208 extern int hfs_write_inode(struct inode *, struct writeback_control *);
209 extern int hfs_inode_setattr(struct mnt_idmap *, struct dentry *,
210 			     struct iattr *);
211 extern void hfs_inode_read_fork(struct inode *inode, struct hfs_extent *ext,
212 			__be32 log_size, __be32 phys_size, u32 clump_size);
213 extern struct inode *hfs_iget(struct super_block *, struct hfs_cat_key *, hfs_cat_rec *);
214 extern void hfs_evict_inode(struct inode *);
215 extern void hfs_delete_inode(struct inode *);
216 
217 /* attr.c */
218 extern const struct xattr_handler *hfs_xattr_handlers[];
219 
220 /* mdb.c */
221 extern int hfs_mdb_get(struct super_block *);
222 extern void hfs_mdb_commit(struct super_block *);
223 extern void hfs_mdb_close(struct super_block *);
224 extern void hfs_mdb_put(struct super_block *);
225 
226 /* part_tbl.c */
227 extern int hfs_part_find(struct super_block *, sector_t *, sector_t *);
228 
229 /* string.c */
230 extern const struct dentry_operations hfs_dentry_operations;
231 
232 extern int hfs_hash_dentry(const struct dentry *, struct qstr *);
233 extern int hfs_strcmp(const unsigned char *, unsigned int,
234 		      const unsigned char *, unsigned int);
235 extern int hfs_compare_dentry(const struct dentry *dentry,
236 		unsigned int len, const char *str, const struct qstr *name);
237 
238 /* trans.c */
239 extern void hfs_asc2mac(struct super_block *, struct hfs_name *, const struct qstr *);
240 extern int hfs_mac2asc(struct super_block *, char *, const struct hfs_name *);
241 
242 /* super.c */
243 extern void hfs_mark_mdb_dirty(struct super_block *sb);
244 
245 /*
246  * There are two time systems.  Both are based on seconds since
247  * a particular time/date.
248  *	Unix:	signed little-endian since 00:00 GMT, Jan. 1, 1970
249  *	mac:	unsigned big-endian since 00:00 GMT, Jan. 1, 1904
250  *
251  * HFS implementations are highly inconsistent, this one matches the
252  * traditional behavior of 64-bit Linux, giving the most useful
253  * time range between 1970 and 2106, by treating any on-disk timestamp
254  * under HFS_UTC_OFFSET (Jan 1 1970) as a time between 2040 and 2106.
255  */
256 #define HFS_UTC_OFFSET 2082844800U
257 
__hfs_m_to_utime(__be32 mt)258 static inline time64_t __hfs_m_to_utime(__be32 mt)
259 {
260 	time64_t ut = (u32)(be32_to_cpu(mt) - HFS_UTC_OFFSET);
261 
262 	return ut + sys_tz.tz_minuteswest * 60;
263 }
264 
__hfs_u_to_mtime(time64_t ut)265 static inline __be32 __hfs_u_to_mtime(time64_t ut)
266 {
267 	ut -= sys_tz.tz_minuteswest * 60;
268 
269 	return cpu_to_be32(lower_32_bits(ut) + HFS_UTC_OFFSET);
270 }
271 #define HFS_I(inode)	(container_of(inode, struct hfs_inode_info, vfs_inode))
272 #define HFS_SB(sb)	((struct hfs_sb_info *)(sb)->s_fs_info)
273 
274 #define hfs_m_to_utime(time)   (struct timespec64){ .tv_sec = __hfs_m_to_utime(time) }
275 #define hfs_u_to_mtime(time)   __hfs_u_to_mtime((time).tv_sec)
276 #define hfs_mtime()		__hfs_u_to_mtime(ktime_get_real_seconds())
277 
hfs_mdb_name(struct super_block * sb)278 static inline const char *hfs_mdb_name(struct super_block *sb)
279 {
280 	return sb->s_id;
281 }
282 
hfs_bitmap_dirty(struct super_block * sb)283 static inline void hfs_bitmap_dirty(struct super_block *sb)
284 {
285 	set_bit(HFS_FLG_BITMAP_DIRTY, &HFS_SB(sb)->flags);
286 	hfs_mark_mdb_dirty(sb);
287 }
288 
289 #define sb_bread512(sb, sec, data) ({			\
290 	struct buffer_head *__bh;			\
291 	sector_t __block;				\
292 	loff_t __start;					\
293 	int __offset;					\
294 							\
295 	__start = (loff_t)(sec) << HFS_SECTOR_SIZE_BITS;\
296 	__block = __start >> (sb)->s_blocksize_bits;	\
297 	__offset = __start & ((sb)->s_blocksize - 1);	\
298 	__bh = sb_bread((sb), __block);			\
299 	if (likely(__bh != NULL))			\
300 		data = (void *)(__bh->b_data + __offset);\
301 	else						\
302 		data = NULL;				\
303 	__bh;						\
304 })
305 
306 #endif
307