xref: /openbmc/linux/fs/befs/linuxvfs.c (revision e23feb16)
1 /*
2  * linux/fs/befs/linuxvfs.c
3  *
4  * Copyright (C) 2001 Will Dyson <will_dyson@pobox.com
5  *
6  */
7 
8 #include <linux/module.h>
9 #include <linux/slab.h>
10 #include <linux/fs.h>
11 #include <linux/errno.h>
12 #include <linux/stat.h>
13 #include <linux/nls.h>
14 #include <linux/buffer_head.h>
15 #include <linux/vfs.h>
16 #include <linux/parser.h>
17 #include <linux/namei.h>
18 #include <linux/sched.h>
19 
20 #include "befs.h"
21 #include "btree.h"
22 #include "inode.h"
23 #include "datastream.h"
24 #include "super.h"
25 #include "io.h"
26 
27 MODULE_DESCRIPTION("BeOS File System (BeFS) driver");
28 MODULE_AUTHOR("Will Dyson");
29 MODULE_LICENSE("GPL");
30 
31 /* The units the vfs expects inode->i_blocks to be in */
32 #define VFS_BLOCK_SIZE 512
33 
34 static int befs_readdir(struct file *, struct dir_context *);
35 static int befs_get_block(struct inode *, sector_t, struct buffer_head *, int);
36 static int befs_readpage(struct file *file, struct page *page);
37 static sector_t befs_bmap(struct address_space *mapping, sector_t block);
38 static struct dentry *befs_lookup(struct inode *, struct dentry *, unsigned int);
39 static struct inode *befs_iget(struct super_block *, unsigned long);
40 static struct inode *befs_alloc_inode(struct super_block *sb);
41 static void befs_destroy_inode(struct inode *inode);
42 static int befs_init_inodecache(void);
43 static void befs_destroy_inodecache(void);
44 static void *befs_follow_link(struct dentry *, struct nameidata *);
45 static void befs_put_link(struct dentry *, struct nameidata *, void *);
46 static int befs_utf2nls(struct super_block *sb, const char *in, int in_len,
47 			char **out, int *out_len);
48 static int befs_nls2utf(struct super_block *sb, const char *in, int in_len,
49 			char **out, int *out_len);
50 static void befs_put_super(struct super_block *);
51 static int befs_remount(struct super_block *, int *, char *);
52 static int befs_statfs(struct dentry *, struct kstatfs *);
53 static int parse_options(char *, befs_mount_options *);
54 
55 static const struct super_operations befs_sops = {
56 	.alloc_inode	= befs_alloc_inode,	/* allocate a new inode */
57 	.destroy_inode	= befs_destroy_inode, /* deallocate an inode */
58 	.put_super	= befs_put_super,	/* uninit super */
59 	.statfs		= befs_statfs,	/* statfs */
60 	.remount_fs	= befs_remount,
61 	.show_options	= generic_show_options,
62 };
63 
64 /* slab cache for befs_inode_info objects */
65 static struct kmem_cache *befs_inode_cachep;
66 
67 static const struct file_operations befs_dir_operations = {
68 	.read		= generic_read_dir,
69 	.iterate	= befs_readdir,
70 	.llseek		= generic_file_llseek,
71 };
72 
73 static const struct inode_operations befs_dir_inode_operations = {
74 	.lookup		= befs_lookup,
75 };
76 
77 static const struct address_space_operations befs_aops = {
78 	.readpage	= befs_readpage,
79 	.bmap		= befs_bmap,
80 };
81 
82 static const struct inode_operations befs_symlink_inode_operations = {
83 	.readlink	= generic_readlink,
84 	.follow_link	= befs_follow_link,
85 	.put_link	= befs_put_link,
86 };
87 
88 /*
89  * Called by generic_file_read() to read a page of data
90  *
91  * In turn, simply calls a generic block read function and
92  * passes it the address of befs_get_block, for mapping file
93  * positions to disk blocks.
94  */
95 static int
96 befs_readpage(struct file *file, struct page *page)
97 {
98 	return block_read_full_page(page, befs_get_block);
99 }
100 
101 static sector_t
102 befs_bmap(struct address_space *mapping, sector_t block)
103 {
104 	return generic_block_bmap(mapping, block, befs_get_block);
105 }
106 
107 /*
108  * Generic function to map a file position (block) to a
109  * disk offset (passed back in bh_result).
110  *
111  * Used by many higher level functions.
112  *
113  * Calls befs_fblock2brun() in datastream.c to do the real work.
114  *
115  * -WD 10-26-01
116  */
117 
118 static int
119 befs_get_block(struct inode *inode, sector_t block,
120 	       struct buffer_head *bh_result, int create)
121 {
122 	struct super_block *sb = inode->i_sb;
123 	befs_data_stream *ds = &BEFS_I(inode)->i_data.ds;
124 	befs_block_run run = BAD_IADDR;
125 	int res = 0;
126 	ulong disk_off;
127 
128 	befs_debug(sb, "---> befs_get_block() for inode %lu, block %ld",
129 		   inode->i_ino, block);
130 
131 	if (block < 0) {
132 		befs_error(sb, "befs_get_block() was asked for a block "
133 			   "number less than zero: block %ld in inode %lu",
134 			   block, inode->i_ino);
135 		return -EIO;
136 	}
137 
138 	if (create) {
139 		befs_error(sb, "befs_get_block() was asked to write to "
140 			   "block %ld in inode %lu", block, inode->i_ino);
141 		return -EPERM;
142 	}
143 
144 	res = befs_fblock2brun(sb, ds, block, &run);
145 	if (res != BEFS_OK) {
146 		befs_error(sb,
147 			   "<--- befs_get_block() for inode %lu, block "
148 			   "%ld ERROR", inode->i_ino, block);
149 		return -EFBIG;
150 	}
151 
152 	disk_off = (ulong) iaddr2blockno(sb, &run);
153 
154 	map_bh(bh_result, inode->i_sb, disk_off);
155 
156 	befs_debug(sb, "<--- befs_get_block() for inode %lu, block %ld, "
157 		   "disk address %lu", inode->i_ino, block, disk_off);
158 
159 	return 0;
160 }
161 
162 static struct dentry *
163 befs_lookup(struct inode *dir, struct dentry *dentry, unsigned int flags)
164 {
165 	struct inode *inode = NULL;
166 	struct super_block *sb = dir->i_sb;
167 	befs_data_stream *ds = &BEFS_I(dir)->i_data.ds;
168 	befs_off_t offset;
169 	int ret;
170 	int utfnamelen;
171 	char *utfname;
172 	const char *name = dentry->d_name.name;
173 
174 	befs_debug(sb, "---> befs_lookup() "
175 		   "name %s inode %ld", dentry->d_name.name, dir->i_ino);
176 
177 	/* Convert to UTF-8 */
178 	if (BEFS_SB(sb)->nls) {
179 		ret =
180 		    befs_nls2utf(sb, name, strlen(name), &utfname, &utfnamelen);
181 		if (ret < 0) {
182 			befs_debug(sb, "<--- befs_lookup() ERROR");
183 			return ERR_PTR(ret);
184 		}
185 		ret = befs_btree_find(sb, ds, utfname, &offset);
186 		kfree(utfname);
187 
188 	} else {
189 		ret = befs_btree_find(sb, ds, dentry->d_name.name, &offset);
190 	}
191 
192 	if (ret == BEFS_BT_NOT_FOUND) {
193 		befs_debug(sb, "<--- befs_lookup() %s not found",
194 			   dentry->d_name.name);
195 		return ERR_PTR(-ENOENT);
196 
197 	} else if (ret != BEFS_OK || offset == 0) {
198 		befs_warning(sb, "<--- befs_lookup() Error");
199 		return ERR_PTR(-ENODATA);
200 	}
201 
202 	inode = befs_iget(dir->i_sb, (ino_t) offset);
203 	if (IS_ERR(inode))
204 		return ERR_CAST(inode);
205 
206 	d_add(dentry, inode);
207 
208 	befs_debug(sb, "<--- befs_lookup()");
209 
210 	return NULL;
211 }
212 
213 static int
214 befs_readdir(struct file *file, struct dir_context *ctx)
215 {
216 	struct inode *inode = file_inode(file);
217 	struct super_block *sb = inode->i_sb;
218 	befs_data_stream *ds = &BEFS_I(inode)->i_data.ds;
219 	befs_off_t value;
220 	int result;
221 	size_t keysize;
222 	unsigned char d_type;
223 	char keybuf[BEFS_NAME_LEN + 1];
224 	const char *dirname = file->f_path.dentry->d_name.name;
225 
226 	befs_debug(sb, "---> befs_readdir() "
227 		   "name %s, inode %ld, ctx->pos %Ld",
228 		   dirname, inode->i_ino, ctx->pos);
229 
230 more:
231 	result = befs_btree_read(sb, ds, ctx->pos, BEFS_NAME_LEN + 1,
232 				 keybuf, &keysize, &value);
233 
234 	if (result == BEFS_ERR) {
235 		befs_debug(sb, "<--- befs_readdir() ERROR");
236 		befs_error(sb, "IO error reading %s (inode %lu)",
237 			   dirname, inode->i_ino);
238 		return -EIO;
239 
240 	} else if (result == BEFS_BT_END) {
241 		befs_debug(sb, "<--- befs_readdir() END");
242 		return 0;
243 
244 	} else if (result == BEFS_BT_EMPTY) {
245 		befs_debug(sb, "<--- befs_readdir() Empty directory");
246 		return 0;
247 	}
248 
249 	d_type = DT_UNKNOWN;
250 
251 	/* Convert to NLS */
252 	if (BEFS_SB(sb)->nls) {
253 		char *nlsname;
254 		int nlsnamelen;
255 		result =
256 		    befs_utf2nls(sb, keybuf, keysize, &nlsname, &nlsnamelen);
257 		if (result < 0) {
258 			befs_debug(sb, "<--- befs_readdir() ERROR");
259 			return result;
260 		}
261 		if (!dir_emit(ctx, nlsname, nlsnamelen,
262 				 (ino_t) value, d_type)) {
263 			kfree(nlsname);
264 			return 0;
265 		}
266 		kfree(nlsname);
267 	} else {
268 		if (!dir_emit(ctx, keybuf, keysize,
269 				 (ino_t) value, d_type))
270 			return 0;
271 	}
272 	ctx->pos++;
273 	goto more;
274 
275 	befs_debug(sb, "<--- befs_readdir() pos %Ld", ctx->pos);
276 
277 	return 0;
278 }
279 
280 static struct inode *
281 befs_alloc_inode(struct super_block *sb)
282 {
283         struct befs_inode_info *bi;
284         bi = (struct befs_inode_info *)kmem_cache_alloc(befs_inode_cachep,
285 							GFP_KERNEL);
286         if (!bi)
287                 return NULL;
288         return &bi->vfs_inode;
289 }
290 
291 static void befs_i_callback(struct rcu_head *head)
292 {
293 	struct inode *inode = container_of(head, struct inode, i_rcu);
294         kmem_cache_free(befs_inode_cachep, BEFS_I(inode));
295 }
296 
297 static void befs_destroy_inode(struct inode *inode)
298 {
299 	call_rcu(&inode->i_rcu, befs_i_callback);
300 }
301 
302 static void init_once(void *foo)
303 {
304         struct befs_inode_info *bi = (struct befs_inode_info *) foo;
305 
306 	inode_init_once(&bi->vfs_inode);
307 }
308 
309 static struct inode *befs_iget(struct super_block *sb, unsigned long ino)
310 {
311 	struct buffer_head *bh = NULL;
312 	befs_inode *raw_inode = NULL;
313 
314 	befs_sb_info *befs_sb = BEFS_SB(sb);
315 	befs_inode_info *befs_ino = NULL;
316 	struct inode *inode;
317 	long ret = -EIO;
318 
319 	befs_debug(sb, "---> befs_read_inode() " "inode = %lu", ino);
320 
321 	inode = iget_locked(sb, ino);
322 	if (IS_ERR(inode))
323 		return inode;
324 	if (!(inode->i_state & I_NEW))
325 		return inode;
326 
327 	befs_ino = BEFS_I(inode);
328 
329 	/* convert from vfs's inode number to befs's inode number */
330 	befs_ino->i_inode_num = blockno2iaddr(sb, inode->i_ino);
331 
332 	befs_debug(sb, "  real inode number [%u, %hu, %hu]",
333 		   befs_ino->i_inode_num.allocation_group,
334 		   befs_ino->i_inode_num.start, befs_ino->i_inode_num.len);
335 
336 	bh = befs_bread(sb, inode->i_ino);
337 	if (!bh) {
338 		befs_error(sb, "unable to read inode block - "
339 			   "inode = %lu", inode->i_ino);
340 		goto unacquire_none;
341 	}
342 
343 	raw_inode = (befs_inode *) bh->b_data;
344 
345 	befs_dump_inode(sb, raw_inode);
346 
347 	if (befs_check_inode(sb, raw_inode, inode->i_ino) != BEFS_OK) {
348 		befs_error(sb, "Bad inode: %lu", inode->i_ino);
349 		goto unacquire_bh;
350 	}
351 
352 	inode->i_mode = (umode_t) fs32_to_cpu(sb, raw_inode->mode);
353 
354 	/*
355 	 * set uid and gid.  But since current BeOS is single user OS, so
356 	 * you can change by "uid" or "gid" options.
357 	 */
358 
359 	inode->i_uid = befs_sb->mount_opts.use_uid ?
360 		befs_sb->mount_opts.uid :
361 		make_kuid(&init_user_ns, fs32_to_cpu(sb, raw_inode->uid));
362 	inode->i_gid = befs_sb->mount_opts.use_gid ?
363 		befs_sb->mount_opts.gid :
364 		make_kgid(&init_user_ns, fs32_to_cpu(sb, raw_inode->gid));
365 
366 	set_nlink(inode, 1);
367 
368 	/*
369 	 * BEFS's time is 64 bits, but current VFS is 32 bits...
370 	 * BEFS don't have access time. Nor inode change time. VFS
371 	 * doesn't have creation time.
372 	 * Also, the lower 16 bits of the last_modified_time and
373 	 * create_time are just a counter to help ensure uniqueness
374 	 * for indexing purposes. (PFD, page 54)
375 	 */
376 
377 	inode->i_mtime.tv_sec =
378 	    fs64_to_cpu(sb, raw_inode->last_modified_time) >> 16;
379 	inode->i_mtime.tv_nsec = 0;   /* lower 16 bits are not a time */
380 	inode->i_ctime = inode->i_mtime;
381 	inode->i_atime = inode->i_mtime;
382 
383 	befs_ino->i_inode_num = fsrun_to_cpu(sb, raw_inode->inode_num);
384 	befs_ino->i_parent = fsrun_to_cpu(sb, raw_inode->parent);
385 	befs_ino->i_attribute = fsrun_to_cpu(sb, raw_inode->attributes);
386 	befs_ino->i_flags = fs32_to_cpu(sb, raw_inode->flags);
387 
388 	if (S_ISLNK(inode->i_mode) && !(befs_ino->i_flags & BEFS_LONG_SYMLINK)){
389 		inode->i_size = 0;
390 		inode->i_blocks = befs_sb->block_size / VFS_BLOCK_SIZE;
391 		strncpy(befs_ino->i_data.symlink, raw_inode->data.symlink,
392 			BEFS_SYMLINK_LEN - 1);
393 		befs_ino->i_data.symlink[BEFS_SYMLINK_LEN - 1] = '\0';
394 	} else {
395 		int num_blks;
396 
397 		befs_ino->i_data.ds =
398 		    fsds_to_cpu(sb, &raw_inode->data.datastream);
399 
400 		num_blks = befs_count_blocks(sb, &befs_ino->i_data.ds);
401 		inode->i_blocks =
402 		    num_blks * (befs_sb->block_size / VFS_BLOCK_SIZE);
403 		inode->i_size = befs_ino->i_data.ds.size;
404 	}
405 
406 	inode->i_mapping->a_ops = &befs_aops;
407 
408 	if (S_ISREG(inode->i_mode)) {
409 		inode->i_fop = &generic_ro_fops;
410 	} else if (S_ISDIR(inode->i_mode)) {
411 		inode->i_op = &befs_dir_inode_operations;
412 		inode->i_fop = &befs_dir_operations;
413 	} else if (S_ISLNK(inode->i_mode)) {
414 		inode->i_op = &befs_symlink_inode_operations;
415 	} else {
416 		befs_error(sb, "Inode %lu is not a regular file, "
417 			   "directory or symlink. THAT IS WRONG! BeFS has no "
418 			   "on disk special files", inode->i_ino);
419 		goto unacquire_bh;
420 	}
421 
422 	brelse(bh);
423 	befs_debug(sb, "<--- befs_read_inode()");
424 	unlock_new_inode(inode);
425 	return inode;
426 
427       unacquire_bh:
428 	brelse(bh);
429 
430       unacquire_none:
431 	iget_failed(inode);
432 	befs_debug(sb, "<--- befs_read_inode() - Bad inode");
433 	return ERR_PTR(ret);
434 }
435 
436 /* Initialize the inode cache. Called at fs setup.
437  *
438  * Taken from NFS implementation by Al Viro.
439  */
440 static int
441 befs_init_inodecache(void)
442 {
443 	befs_inode_cachep = kmem_cache_create("befs_inode_cache",
444 					      sizeof (struct befs_inode_info),
445 					      0, (SLAB_RECLAIM_ACCOUNT|
446 						SLAB_MEM_SPREAD),
447 					      init_once);
448 	if (befs_inode_cachep == NULL) {
449 		printk(KERN_ERR "befs_init_inodecache: "
450 		       "Couldn't initialize inode slabcache\n");
451 		return -ENOMEM;
452 	}
453 
454 	return 0;
455 }
456 
457 /* Called at fs teardown.
458  *
459  * Taken from NFS implementation by Al Viro.
460  */
461 static void
462 befs_destroy_inodecache(void)
463 {
464 	/*
465 	 * Make sure all delayed rcu free inodes are flushed before we
466 	 * destroy cache.
467 	 */
468 	rcu_barrier();
469 	kmem_cache_destroy(befs_inode_cachep);
470 }
471 
472 /*
473  * The inode of symbolic link is different to data stream.
474  * The data stream become link name. Unless the LONG_SYMLINK
475  * flag is set.
476  */
477 static void *
478 befs_follow_link(struct dentry *dentry, struct nameidata *nd)
479 {
480 	befs_inode_info *befs_ino = BEFS_I(dentry->d_inode);
481 	char *link;
482 
483 	if (befs_ino->i_flags & BEFS_LONG_SYMLINK) {
484 		struct super_block *sb = dentry->d_sb;
485 		befs_data_stream *data = &befs_ino->i_data.ds;
486 		befs_off_t len = data->size;
487 
488 		if (len == 0) {
489 			befs_error(sb, "Long symlink with illegal length");
490 			link = ERR_PTR(-EIO);
491 		} else {
492 			befs_debug(sb, "Follow long symlink");
493 
494 			link = kmalloc(len, GFP_NOFS);
495 			if (!link) {
496 				link = ERR_PTR(-ENOMEM);
497 			} else if (befs_read_lsymlink(sb, data, link, len) != len) {
498 				kfree(link);
499 				befs_error(sb, "Failed to read entire long symlink");
500 				link = ERR_PTR(-EIO);
501 			} else {
502 				link[len - 1] = '\0';
503 			}
504 		}
505 	} else {
506 		link = befs_ino->i_data.symlink;
507 	}
508 
509 	nd_set_link(nd, link);
510 	return NULL;
511 }
512 
513 static void befs_put_link(struct dentry *dentry, struct nameidata *nd, void *p)
514 {
515 	befs_inode_info *befs_ino = BEFS_I(dentry->d_inode);
516 	if (befs_ino->i_flags & BEFS_LONG_SYMLINK) {
517 		char *link = nd_get_link(nd);
518 		if (!IS_ERR(link))
519 			kfree(link);
520 	}
521 }
522 
523 /*
524  * UTF-8 to NLS charset  convert routine
525  *
526  *
527  * Changed 8/10/01 by Will Dyson. Now use uni2char() / char2uni() rather than
528  * the nls tables directly
529  */
530 
531 static int
532 befs_utf2nls(struct super_block *sb, const char *in,
533 	     int in_len, char **out, int *out_len)
534 {
535 	struct nls_table *nls = BEFS_SB(sb)->nls;
536 	int i, o;
537 	unicode_t uni;
538 	int unilen, utflen;
539 	char *result;
540 	/* The utf8->nls conversion won't make the final nls string bigger
541 	 * than the utf one, but if the string is pure ascii they'll have the
542 	 * same width and an extra char is needed to save the additional \0
543 	 */
544 	int maxlen = in_len + 1;
545 
546 	befs_debug(sb, "---> utf2nls()");
547 
548 	if (!nls) {
549 		befs_error(sb, "befs_utf2nls called with no NLS table loaded");
550 		return -EINVAL;
551 	}
552 
553 	*out = result = kmalloc(maxlen, GFP_NOFS);
554 	if (!*out) {
555 		befs_error(sb, "befs_utf2nls() cannot allocate memory");
556 		*out_len = 0;
557 		return -ENOMEM;
558 	}
559 
560 	for (i = o = 0; i < in_len; i += utflen, o += unilen) {
561 
562 		/* convert from UTF-8 to Unicode */
563 		utflen = utf8_to_utf32(&in[i], in_len - i, &uni);
564 		if (utflen < 0)
565 			goto conv_err;
566 
567 		/* convert from Unicode to nls */
568 		if (uni > MAX_WCHAR_T)
569 			goto conv_err;
570 		unilen = nls->uni2char(uni, &result[o], in_len - o);
571 		if (unilen < 0)
572 			goto conv_err;
573 	}
574 	result[o] = '\0';
575 	*out_len = o;
576 
577 	befs_debug(sb, "<--- utf2nls()");
578 
579 	return o;
580 
581       conv_err:
582 	befs_error(sb, "Name using character set %s contains a character that "
583 		   "cannot be converted to unicode.", nls->charset);
584 	befs_debug(sb, "<--- utf2nls()");
585 	kfree(result);
586 	return -EILSEQ;
587 }
588 
589 /**
590  * befs_nls2utf - Convert NLS string to utf8 encodeing
591  * @sb: Superblock
592  * @src: Input string buffer in NLS format
593  * @srclen: Length of input string in bytes
594  * @dest: The output string in UTF-8 format
595  * @destlen: Length of the output buffer
596  *
597  * Converts input string @src, which is in the format of the loaded NLS map,
598  * into a utf8 string.
599  *
600  * The destination string @dest is allocated by this function and the caller is
601  * responsible for freeing it with kfree()
602  *
603  * On return, *@destlen is the length of @dest in bytes.
604  *
605  * On success, the return value is the number of utf8 characters written to
606  * the output buffer @dest.
607  *
608  * On Failure, a negative number coresponding to the error code is returned.
609  */
610 
611 static int
612 befs_nls2utf(struct super_block *sb, const char *in,
613 	     int in_len, char **out, int *out_len)
614 {
615 	struct nls_table *nls = BEFS_SB(sb)->nls;
616 	int i, o;
617 	wchar_t uni;
618 	int unilen, utflen;
619 	char *result;
620 	/* There're nls characters that will translate to 3-chars-wide UTF-8
621 	 * characters, a additional byte is needed to save the final \0
622 	 * in special cases */
623 	int maxlen = (3 * in_len) + 1;
624 
625 	befs_debug(sb, "---> nls2utf()\n");
626 
627 	if (!nls) {
628 		befs_error(sb, "befs_nls2utf called with no NLS table loaded.");
629 		return -EINVAL;
630 	}
631 
632 	*out = result = kmalloc(maxlen, GFP_NOFS);
633 	if (!*out) {
634 		befs_error(sb, "befs_nls2utf() cannot allocate memory");
635 		*out_len = 0;
636 		return -ENOMEM;
637 	}
638 
639 	for (i = o = 0; i < in_len; i += unilen, o += utflen) {
640 
641 		/* convert from nls to unicode */
642 		unilen = nls->char2uni(&in[i], in_len - i, &uni);
643 		if (unilen < 0)
644 			goto conv_err;
645 
646 		/* convert from unicode to UTF-8 */
647 		utflen = utf32_to_utf8(uni, &result[o], 3);
648 		if (utflen <= 0)
649 			goto conv_err;
650 	}
651 
652 	result[o] = '\0';
653 	*out_len = o;
654 
655 	befs_debug(sb, "<--- nls2utf()");
656 
657 	return i;
658 
659       conv_err:
660 	befs_error(sb, "Name using charecter set %s contains a charecter that "
661 		   "cannot be converted to unicode.", nls->charset);
662 	befs_debug(sb, "<--- nls2utf()");
663 	kfree(result);
664 	return -EILSEQ;
665 }
666 
667 /**
668  * Use the
669  *
670  */
671 enum {
672 	Opt_uid, Opt_gid, Opt_charset, Opt_debug, Opt_err,
673 };
674 
675 static const match_table_t befs_tokens = {
676 	{Opt_uid, "uid=%d"},
677 	{Opt_gid, "gid=%d"},
678 	{Opt_charset, "iocharset=%s"},
679 	{Opt_debug, "debug"},
680 	{Opt_err, NULL}
681 };
682 
683 static int
684 parse_options(char *options, befs_mount_options * opts)
685 {
686 	char *p;
687 	substring_t args[MAX_OPT_ARGS];
688 	int option;
689 	kuid_t uid;
690 	kgid_t gid;
691 
692 	/* Initialize options */
693 	opts->uid = GLOBAL_ROOT_UID;
694 	opts->gid = GLOBAL_ROOT_GID;
695 	opts->use_uid = 0;
696 	opts->use_gid = 0;
697 	opts->iocharset = NULL;
698 	opts->debug = 0;
699 
700 	if (!options)
701 		return 1;
702 
703 	while ((p = strsep(&options, ",")) != NULL) {
704 		int token;
705 		if (!*p)
706 			continue;
707 
708 		token = match_token(p, befs_tokens, args);
709 		switch (token) {
710 		case Opt_uid:
711 			if (match_int(&args[0], &option))
712 				return 0;
713 			uid = INVALID_UID;
714 			if (option >= 0)
715 				uid = make_kuid(current_user_ns(), option);
716 			if (!uid_valid(uid)) {
717 				printk(KERN_ERR "BeFS: Invalid uid %d, "
718 						"using default\n", option);
719 				break;
720 			}
721 			opts->uid = uid;
722 			opts->use_uid = 1;
723 			break;
724 		case Opt_gid:
725 			if (match_int(&args[0], &option))
726 				return 0;
727 			gid = INVALID_GID;
728 			if (option >= 0)
729 				gid = make_kgid(current_user_ns(), option);
730 			if (!gid_valid(gid)) {
731 				printk(KERN_ERR "BeFS: Invalid gid %d, "
732 						"using default\n", option);
733 				break;
734 			}
735 			opts->gid = gid;
736 			opts->use_gid = 1;
737 			break;
738 		case Opt_charset:
739 			kfree(opts->iocharset);
740 			opts->iocharset = match_strdup(&args[0]);
741 			if (!opts->iocharset) {
742 				printk(KERN_ERR "BeFS: allocation failure for "
743 						"iocharset string\n");
744 				return 0;
745 			}
746 			break;
747 		case Opt_debug:
748 			opts->debug = 1;
749 			break;
750 		default:
751 			printk(KERN_ERR "BeFS: Unrecognized mount option \"%s\" "
752 					"or missing value\n", p);
753 			return 0;
754 		}
755 	}
756 	return 1;
757 }
758 
759 /* This function has the responsibiltiy of getting the
760  * filesystem ready for unmounting.
761  * Basically, we free everything that we allocated in
762  * befs_read_inode
763  */
764 static void
765 befs_put_super(struct super_block *sb)
766 {
767 	kfree(BEFS_SB(sb)->mount_opts.iocharset);
768 	BEFS_SB(sb)->mount_opts.iocharset = NULL;
769 	unload_nls(BEFS_SB(sb)->nls);
770 	kfree(sb->s_fs_info);
771 	sb->s_fs_info = NULL;
772 }
773 
774 /* Allocate private field of the superblock, fill it.
775  *
776  * Finish filling the public superblock fields
777  * Make the root directory
778  * Load a set of NLS translations if needed.
779  */
780 static int
781 befs_fill_super(struct super_block *sb, void *data, int silent)
782 {
783 	struct buffer_head *bh;
784 	befs_sb_info *befs_sb;
785 	befs_super_block *disk_sb;
786 	struct inode *root;
787 	long ret = -EINVAL;
788 	const unsigned long sb_block = 0;
789 	const off_t x86_sb_off = 512;
790 
791 	save_mount_options(sb, data);
792 
793 	sb->s_fs_info = kmalloc(sizeof (*befs_sb), GFP_KERNEL);
794 	if (sb->s_fs_info == NULL) {
795 		printk(KERN_ERR
796 		       "BeFS(%s): Unable to allocate memory for private "
797 		       "portion of superblock. Bailing.\n", sb->s_id);
798 		goto unacquire_none;
799 	}
800 	befs_sb = BEFS_SB(sb);
801 	memset(befs_sb, 0, sizeof(befs_sb_info));
802 
803 	if (!parse_options((char *) data, &befs_sb->mount_opts)) {
804 		befs_error(sb, "cannot parse mount options");
805 		goto unacquire_priv_sbp;
806 	}
807 
808 	befs_debug(sb, "---> befs_fill_super()");
809 
810 #ifndef CONFIG_BEFS_RW
811 	if (!(sb->s_flags & MS_RDONLY)) {
812 		befs_warning(sb,
813 			     "No write support. Marking filesystem read-only");
814 		sb->s_flags |= MS_RDONLY;
815 	}
816 #endif				/* CONFIG_BEFS_RW */
817 
818 	/*
819 	 * Set dummy blocksize to read super block.
820 	 * Will be set to real fs blocksize later.
821 	 *
822 	 * Linux 2.4.10 and later refuse to read blocks smaller than
823 	 * the hardsect size for the device. But we also need to read at
824 	 * least 1k to get the second 512 bytes of the volume.
825 	 * -WD 10-26-01
826 	 */
827 	sb_min_blocksize(sb, 1024);
828 
829 	if (!(bh = sb_bread(sb, sb_block))) {
830 		befs_error(sb, "unable to read superblock");
831 		goto unacquire_priv_sbp;
832 	}
833 
834 	/* account for offset of super block on x86 */
835 	disk_sb = (befs_super_block *) bh->b_data;
836 	if ((disk_sb->magic1 == BEFS_SUPER_MAGIC1_LE) ||
837 	    (disk_sb->magic1 == BEFS_SUPER_MAGIC1_BE)) {
838 		befs_debug(sb, "Using PPC superblock location");
839 	} else {
840 		befs_debug(sb, "Using x86 superblock location");
841 		disk_sb =
842 		    (befs_super_block *) ((void *) bh->b_data + x86_sb_off);
843 	}
844 
845 	if (befs_load_sb(sb, disk_sb) != BEFS_OK)
846 		goto unacquire_bh;
847 
848 	befs_dump_super_block(sb, disk_sb);
849 
850 	brelse(bh);
851 
852 	if (befs_check_sb(sb) != BEFS_OK)
853 		goto unacquire_priv_sbp;
854 
855 	if( befs_sb->num_blocks > ~((sector_t)0) ) {
856 		befs_error(sb, "blocks count: %Lu "
857 			"is larger than the host can use",
858 			befs_sb->num_blocks);
859 		goto unacquire_priv_sbp;
860 	}
861 
862 	/*
863 	 * set up enough so that it can read an inode
864 	 * Fill in kernel superblock fields from private sb
865 	 */
866 	sb->s_magic = BEFS_SUPER_MAGIC;
867 	/* Set real blocksize of fs */
868 	sb_set_blocksize(sb, (ulong) befs_sb->block_size);
869 	sb->s_op = &befs_sops;
870 	root = befs_iget(sb, iaddr2blockno(sb, &(befs_sb->root_dir)));
871 	if (IS_ERR(root)) {
872 		ret = PTR_ERR(root);
873 		goto unacquire_priv_sbp;
874 	}
875 	sb->s_root = d_make_root(root);
876 	if (!sb->s_root) {
877 		befs_error(sb, "get root inode failed");
878 		goto unacquire_priv_sbp;
879 	}
880 
881 	/* load nls library */
882 	if (befs_sb->mount_opts.iocharset) {
883 		befs_debug(sb, "Loading nls: %s",
884 			   befs_sb->mount_opts.iocharset);
885 		befs_sb->nls = load_nls(befs_sb->mount_opts.iocharset);
886 		if (!befs_sb->nls) {
887 			befs_warning(sb, "Cannot load nls %s"
888 					" loading default nls",
889 					befs_sb->mount_opts.iocharset);
890 			befs_sb->nls = load_nls_default();
891 		}
892 	/* load default nls if none is specified  in mount options */
893 	} else {
894 		befs_debug(sb, "Loading default nls");
895 		befs_sb->nls = load_nls_default();
896 	}
897 
898 	return 0;
899 /*****************/
900       unacquire_bh:
901 	brelse(bh);
902 
903       unacquire_priv_sbp:
904 	kfree(befs_sb->mount_opts.iocharset);
905 	kfree(sb->s_fs_info);
906 
907       unacquire_none:
908 	sb->s_fs_info = NULL;
909 	return ret;
910 }
911 
912 static int
913 befs_remount(struct super_block *sb, int *flags, char *data)
914 {
915 	if (!(*flags & MS_RDONLY))
916 		return -EINVAL;
917 	return 0;
918 }
919 
920 static int
921 befs_statfs(struct dentry *dentry, struct kstatfs *buf)
922 {
923 	struct super_block *sb = dentry->d_sb;
924 	u64 id = huge_encode_dev(sb->s_bdev->bd_dev);
925 
926 	befs_debug(sb, "---> befs_statfs()");
927 
928 	buf->f_type = BEFS_SUPER_MAGIC;
929 	buf->f_bsize = sb->s_blocksize;
930 	buf->f_blocks = BEFS_SB(sb)->num_blocks;
931 	buf->f_bfree = BEFS_SB(sb)->num_blocks - BEFS_SB(sb)->used_blocks;
932 	buf->f_bavail = buf->f_bfree;
933 	buf->f_files = 0;	/* UNKNOWN */
934 	buf->f_ffree = 0;	/* UNKNOWN */
935 	buf->f_fsid.val[0] = (u32)id;
936 	buf->f_fsid.val[1] = (u32)(id >> 32);
937 	buf->f_namelen = BEFS_NAME_LEN;
938 
939 	befs_debug(sb, "<--- befs_statfs()");
940 
941 	return 0;
942 }
943 
944 static struct dentry *
945 befs_mount(struct file_system_type *fs_type, int flags, const char *dev_name,
946 	    void *data)
947 {
948 	return mount_bdev(fs_type, flags, dev_name, data, befs_fill_super);
949 }
950 
951 static struct file_system_type befs_fs_type = {
952 	.owner		= THIS_MODULE,
953 	.name		= "befs",
954 	.mount		= befs_mount,
955 	.kill_sb	= kill_block_super,
956 	.fs_flags	= FS_REQUIRES_DEV,
957 };
958 MODULE_ALIAS_FS("befs");
959 
960 static int __init
961 init_befs_fs(void)
962 {
963 	int err;
964 
965 	printk(KERN_INFO "BeFS version: %s\n", BEFS_VERSION);
966 
967 	err = befs_init_inodecache();
968 	if (err)
969 		goto unacquire_none;
970 
971 	err = register_filesystem(&befs_fs_type);
972 	if (err)
973 		goto unacquire_inodecache;
974 
975 	return 0;
976 
977 unacquire_inodecache:
978 	befs_destroy_inodecache();
979 
980 unacquire_none:
981 	return err;
982 }
983 
984 static void __exit
985 exit_befs_fs(void)
986 {
987 	befs_destroy_inodecache();
988 
989 	unregister_filesystem(&befs_fs_type);
990 }
991 
992 /*
993 Macros that typecheck the init and exit functions,
994 ensures that they are called at init and cleanup,
995 and eliminates warnings about unused functions.
996 */
997 module_init(init_befs_fs)
998 module_exit(exit_befs_fs)
999