xref: /linux/fs/affs/affs.h (revision 7255fcc80d4b525cc10cfaaf7f485830d4ed2000)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifdef pr_fmt
3 #undef pr_fmt
4 #endif
5 
6 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
7 
8 #include <linux/types.h>
9 #include <linux/fs.h>
10 #include <linux/buffer_head.h>
11 #include "amigaffs.h"
12 #include <linux/mutex.h>
13 #include <linux/workqueue.h>
14 
15 /* Ugly macros make the code more pretty. */
16 
17 #define GET_END_PTR(st,p,sz)		 ((st *)((char *)(p)+((sz)-sizeof(st))))
18 #define AFFS_GET_HASHENTRY(data,hashkey) be32_to_cpu(((struct dir_front *)data)->hashtable[hashkey])
19 #define AFFS_BLOCK(sb, bh, blk)		(AFFS_HEAD(bh)->table[AFFS_SB(sb)->s_hashsize-1-(blk)])
20 
21 #define AFFS_HEAD(bh)		((struct affs_head *)(bh)->b_data)
22 #define AFFS_TAIL(sb, bh)	((struct affs_tail *)((bh)->b_data+(sb)->s_blocksize-sizeof(struct affs_tail)))
23 #define AFFS_ROOT_HEAD(bh)	((struct affs_root_head *)(bh)->b_data)
24 #define AFFS_ROOT_TAIL(sb, bh)	((struct affs_root_tail *)((bh)->b_data+(sb)->s_blocksize-sizeof(struct affs_root_tail)))
25 #define AFFS_DATA_HEAD(bh)	((struct affs_data_head *)(bh)->b_data)
26 #define AFFS_DATA(bh)		(((struct affs_data_head *)(bh)->b_data)->data)
27 
28 #define AFFS_CACHE_SIZE		PAGE_SIZE
29 
30 #define AFFS_LC_SIZE		(AFFS_CACHE_SIZE/sizeof(u32)/2)
31 #define AFFS_AC_SIZE		(AFFS_CACHE_SIZE/sizeof(struct affs_ext_key)/2)
32 #define AFFS_AC_MASK		(AFFS_AC_SIZE-1)
33 
34 #define AFFSNAMEMAX 30U
35 
36 struct affs_ext_key {
37 	u32	ext;				/* idx of the extended block */
38 	u32	key;				/* block number */
39 };
40 
41 /*
42  * affs fs inode data in memory
43  */
44 struct affs_inode_info {
45 	atomic_t i_opencnt;
46 	struct mutex i_link_lock;		/* Protects internal inode access. */
47 	struct mutex i_ext_lock;		/* Protects internal inode access. */
48 #define i_hash_lock i_ext_lock
49 	u32	 i_blkcnt;			/* block count */
50 	u32	 i_extcnt;			/* extended block count */
51 	u32	*i_lc;				/* linear cache of extended blocks */
52 	u32	 i_lc_size;
53 	u32	 i_lc_shift;
54 	u32	 i_lc_mask;
55 	struct affs_ext_key *i_ac;		/* associative cache of extended blocks */
56 	u32	 i_ext_last;			/* last accessed extended block */
57 	struct buffer_head *i_ext_bh;		/* bh of last extended block */
58 	loff_t	 mmu_private;
59 	u32	 i_protect;			/* unused attribute bits */
60 	u32	 i_lastalloc;			/* last allocated block */
61 	int	 i_pa_cnt;			/* number of preallocated blocks */
62 	struct inode vfs_inode;
63 };
64 
65 /* short cut to get to the affs specific inode data */
66 static inline struct affs_inode_info *AFFS_I(struct inode *inode)
67 {
68 	return container_of(inode, struct affs_inode_info, vfs_inode);
69 }
70 
71 /*
72  * super-block data in memory
73  *
74  * Block numbers are adjusted for their actual size
75  *
76  */
77 
78 struct affs_bm_info {
79 	u32 bm_key;			/* Disk block number */
80 	u32 bm_free;			/* Free blocks in here */
81 };
82 
83 struct affs_sb_info {
84 	int s_partition_size;		/* Partition size in blocks. */
85 	int s_reserved;			/* Number of reserved blocks. */
86 	//u32 s_blksize;			/* Initial device blksize */
87 	u32 s_data_blksize;		/* size of the data block w/o header */
88 	u32 s_root_block;		/* FFS root block number. */
89 	int s_hashsize;			/* Size of hash table. */
90 	unsigned long s_flags;		/* See below. */
91 	kuid_t s_uid;			/* uid to override */
92 	kgid_t s_gid;			/* gid to override */
93 	umode_t s_mode;			/* mode to override */
94 	struct buffer_head *s_root_bh;	/* Cached root block. */
95 	struct mutex s_bmlock;		/* Protects bitmap access. */
96 	struct affs_bm_info *s_bitmap;	/* Bitmap infos. */
97 	u32 s_bmap_count;		/* # of bitmap blocks. */
98 	u32 s_bmap_bits;		/* # of bits in one bitmap blocks */
99 	u32 s_last_bmap;
100 	struct buffer_head *s_bmap_bh;
101 	char *s_prefix;			/* Prefix for volumes and assigns. */
102 	char s_volume[32];		/* Volume prefix for absolute symlinks. */
103 	spinlock_t symlink_lock;	/* protects the previous two */
104 	struct super_block *sb;		/* the VFS superblock object */
105 	int work_queued;		/* non-zero delayed work is queued */
106 	struct delayed_work sb_work;	/* superblock flush delayed work */
107 	spinlock_t work_lock;		/* protects sb_work and work_queued */
108 	struct rcu_head rcu;
109 };
110 
111 #define AFFS_MOUNT_SF_INTL		0x0001 /* International filesystem. */
112 #define AFFS_MOUNT_SF_BM_VALID		0x0002 /* Bitmap is valid. */
113 #define AFFS_MOUNT_SF_IMMUTABLE		0x0004 /* Protection bits cannot be changed */
114 #define AFFS_MOUNT_SF_QUIET		0x0008 /* chmod errors will be not reported */
115 #define AFFS_MOUNT_SF_SETUID		0x0010 /* Ignore Amiga uid */
116 #define AFFS_MOUNT_SF_SETGID		0x0020 /* Ignore Amiga gid */
117 #define AFFS_MOUNT_SF_SETMODE		0x0040 /* Ignore Amiga protection bits */
118 #define AFFS_MOUNT_SF_MUFS		0x0100 /* Use MUFS uid/gid mapping */
119 #define AFFS_MOUNT_SF_OFS		0x0200 /* Old filesystem */
120 #define AFFS_MOUNT_SF_PREFIX		0x0400 /* Buffer for prefix is allocated */
121 #define AFFS_MOUNT_SF_VERBOSE		0x0800 /* Talk about fs when mounting */
122 #define AFFS_MOUNT_SF_NO_TRUNCATE	0x1000 /* Don't truncate filenames */
123 
124 #define affs_clear_opt(o, opt)    (o &= ~AFFS_MOUNT_##opt)
125 #define affs_set_opt(o, opt)      (o |= AFFS_MOUNT_##opt)
126 #define affs_test_opt(o, opt)     ((o) & AFFS_MOUNT_##opt)
127 
128 /* short cut to get to the affs specific sb data */
129 static inline struct affs_sb_info *AFFS_SB(struct super_block *sb)
130 {
131 	return sb->s_fs_info;
132 }
133 
134 void affs_mark_sb_dirty(struct super_block *sb);
135 
136 /* amigaffs.c */
137 
138 extern int	affs_insert_hash(struct inode *inode, struct buffer_head *bh);
139 extern int	affs_remove_hash(struct inode *dir, struct buffer_head *rem_bh);
140 extern int	affs_remove_header(struct dentry *dentry);
141 extern u32	affs_checksum_block(struct super_block *sb, struct buffer_head *bh);
142 extern void	affs_fix_checksum(struct super_block *sb, struct buffer_head *bh);
143 extern void	affs_secs_to_datestamp(time64_t secs, struct affs_date *ds);
144 extern umode_t	affs_prot_to_mode(u32 prot);
145 extern void	affs_mode_to_prot(struct inode *inode);
146 __printf(3, 4)
147 extern void	affs_error(struct super_block *sb, const char *function,
148 			   const char *fmt, ...);
149 __printf(3, 4)
150 extern void	affs_warning(struct super_block *sb, const char *function,
151 			     const char *fmt, ...);
152 extern bool	affs_nofilenametruncate(const struct dentry *dentry);
153 extern int	affs_check_name(const unsigned char *name, int len,
154 				bool notruncate);
155 extern int	affs_copy_name(unsigned char *bstr, struct dentry *dentry);
156 
157 /* bitmap. c */
158 
159 extern u32	affs_count_free_blocks(struct super_block *s);
160 extern void	affs_free_block(struct super_block *sb, u32 block);
161 extern u32	affs_alloc_block(struct inode *inode, u32 goal);
162 extern int	affs_init_bitmap(struct super_block *sb, int *flags);
163 extern void	affs_free_bitmap(struct super_block *sb);
164 
165 /* namei.c */
166 
167 extern const struct export_operations affs_export_ops;
168 extern int	affs_hash_name(struct super_block *sb, const u8 *name, unsigned int len);
169 extern struct dentry *affs_lookup(struct inode *dir, struct dentry *dentry, unsigned int);
170 extern int	affs_unlink(struct inode *dir, struct dentry *dentry);
171 extern int	affs_create(struct mnt_idmap *idmap, struct inode *dir,
172 			struct dentry *dentry, umode_t mode, bool);
173 extern int	affs_mkdir(struct mnt_idmap *idmap, struct inode *dir,
174 			struct dentry *dentry, umode_t mode);
175 extern int	affs_rmdir(struct inode *dir, struct dentry *dentry);
176 extern int	affs_link(struct dentry *olddentry, struct inode *dir,
177 			  struct dentry *dentry);
178 extern int	affs_symlink(struct mnt_idmap *idmap,
179 			struct inode *dir, struct dentry *dentry,
180 			const char *symname);
181 extern int	affs_rename2(struct mnt_idmap *idmap,
182 			struct inode *old_dir, struct dentry *old_dentry,
183 			struct inode *new_dir, struct dentry *new_dentry,
184 			unsigned int flags);
185 
186 /* inode.c */
187 
188 extern struct inode		*affs_new_inode(struct inode *dir);
189 extern int			 affs_notify_change(struct mnt_idmap *idmap,
190 					struct dentry *dentry, struct iattr *attr);
191 extern void			 affs_evict_inode(struct inode *inode);
192 extern struct inode		*affs_iget(struct super_block *sb,
193 					unsigned long ino);
194 extern int			 affs_write_inode(struct inode *inode,
195 					struct writeback_control *wbc);
196 extern int			 affs_add_entry(struct inode *dir, struct inode *inode,
197 					struct dentry *dentry, s32 type);
198 
199 /* file.c */
200 
201 void		affs_free_prealloc(struct inode *inode);
202 extern void	affs_truncate(struct inode *);
203 int		affs_file_fsync(struct file *, loff_t, loff_t, int);
204 
205 /* dir.c */
206 
207 extern void   affs_dir_truncate(struct inode *);
208 
209 /* jump tables */
210 
211 extern const struct inode_operations	 affs_file_inode_operations;
212 extern const struct inode_operations	 affs_dir_inode_operations;
213 extern const struct inode_operations   affs_symlink_inode_operations;
214 extern const struct file_operations	 affs_file_operations;
215 extern const struct file_operations	 affs_file_operations_ofs;
216 extern const struct file_operations	 affs_dir_operations;
217 extern const struct address_space_operations	 affs_symlink_aops;
218 extern const struct address_space_operations	 affs_aops;
219 extern const struct address_space_operations	 affs_aops_ofs;
220 
221 extern const struct dentry_operations	 affs_dentry_operations;
222 extern const struct dentry_operations	 affs_intl_dentry_operations;
223 
224 static inline bool affs_validblock(struct super_block *sb, int block)
225 {
226 	return(block >= AFFS_SB(sb)->s_reserved &&
227 	       block < AFFS_SB(sb)->s_partition_size);
228 }
229 
230 static inline void
231 affs_set_blocksize(struct super_block *sb, int size)
232 {
233 	sb_set_blocksize(sb, size);
234 }
235 static inline struct buffer_head *
236 affs_bread(struct super_block *sb, int block)
237 {
238 	pr_debug("%s: %d\n", __func__, block);
239 	if (affs_validblock(sb, block))
240 		return sb_bread(sb, block);
241 	return NULL;
242 }
243 static inline struct buffer_head *
244 affs_getblk(struct super_block *sb, int block)
245 {
246 	pr_debug("%s: %d\n", __func__, block);
247 	if (affs_validblock(sb, block))
248 		return sb_getblk(sb, block);
249 	return NULL;
250 }
251 static inline struct buffer_head *
252 affs_getzeroblk(struct super_block *sb, int block)
253 {
254 	struct buffer_head *bh;
255 	pr_debug("%s: %d\n", __func__, block);
256 	if (affs_validblock(sb, block)) {
257 		bh = sb_getblk(sb, block);
258 		lock_buffer(bh);
259 		memset(bh->b_data, 0 , sb->s_blocksize);
260 		set_buffer_uptodate(bh);
261 		unlock_buffer(bh);
262 		return bh;
263 	}
264 	return NULL;
265 }
266 static inline struct buffer_head *
267 affs_getemptyblk(struct super_block *sb, int block)
268 {
269 	struct buffer_head *bh;
270 	pr_debug("%s: %d\n", __func__, block);
271 	if (affs_validblock(sb, block)) {
272 		bh = sb_getblk(sb, block);
273 		wait_on_buffer(bh);
274 		set_buffer_uptodate(bh);
275 		return bh;
276 	}
277 	return NULL;
278 }
279 static inline void
280 affs_brelse(struct buffer_head *bh)
281 {
282 	if (bh)
283 		pr_debug("%s: %lld\n", __func__, (long long) bh->b_blocknr);
284 	brelse(bh);
285 }
286 
287 static inline void
288 affs_adjust_checksum(struct buffer_head *bh, u32 val)
289 {
290 	u32 tmp = be32_to_cpu(((__be32 *)bh->b_data)[5]);
291 	((__be32 *)bh->b_data)[5] = cpu_to_be32(tmp - val);
292 }
293 static inline void
294 affs_adjust_bitmapchecksum(struct buffer_head *bh, u32 val)
295 {
296 	u32 tmp = be32_to_cpu(((__be32 *)bh->b_data)[0]);
297 	((__be32 *)bh->b_data)[0] = cpu_to_be32(tmp - val);
298 }
299 
300 static inline void
301 affs_lock_link(struct inode *inode)
302 {
303 	mutex_lock(&AFFS_I(inode)->i_link_lock);
304 }
305 static inline void
306 affs_unlock_link(struct inode *inode)
307 {
308 	mutex_unlock(&AFFS_I(inode)->i_link_lock);
309 }
310 static inline void
311 affs_lock_dir(struct inode *inode)
312 {
313 	mutex_lock_nested(&AFFS_I(inode)->i_hash_lock, SINGLE_DEPTH_NESTING);
314 }
315 static inline void
316 affs_unlock_dir(struct inode *inode)
317 {
318 	mutex_unlock(&AFFS_I(inode)->i_hash_lock);
319 }
320 static inline void
321 affs_lock_ext(struct inode *inode)
322 {
323 	mutex_lock(&AFFS_I(inode)->i_ext_lock);
324 }
325 static inline void
326 affs_unlock_ext(struct inode *inode)
327 {
328 	mutex_unlock(&AFFS_I(inode)->i_ext_lock);
329 }
330