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