It's UTF-8
[linux-flexiantxendom0-natty.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 #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
19 #include "befs.h"
20 #include "btree.h"
21 #include "inode.h"
22 #include "datastream.h"
23 #include "super.h"
24 #include "io.h"
25 #include "endian.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 *, void *, filldir_t);
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 *, struct nameidata *);
39 static void befs_read_inode(struct inode *ino);
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 super_block *, struct kstatfs *);
53 static int parse_options(char *, befs_mount_options *);
54
55 static const struct super_operations befs_sops = {
56         .read_inode     = befs_read_inode,      /* initialize & read inode */
57         .alloc_inode    = befs_alloc_inode,     /* allocate a new inode */
58         .destroy_inode  = befs_destroy_inode, /* deallocate an inode */
59         .put_super      = befs_put_super,       /* uninit super */
60         .statfs         = befs_statfs,  /* statfs */
61         .remount_fs     = befs_remount,
62 };
63
64 /* slab cache for befs_inode_info objects */
65 static kmem_cache_t *befs_inode_cachep;
66
67 static struct file_operations befs_dir_operations = {
68         .read           = generic_read_dir,
69         .readdir        = befs_readdir,
70 };
71
72 static struct inode_operations befs_dir_inode_operations = {
73         .lookup         = befs_lookup,
74 };
75
76 static struct address_space_operations befs_aops = {
77         .readpage       = befs_readpage,
78         .sync_page      = block_sync_page,
79         .bmap           = befs_bmap,
80 };
81
82 static 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, struct nameidata *nd)
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 = iget(dir->i_sb, (ino_t) offset);
203         if (!inode)
204                 return ERR_PTR(-EACCES);
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 *filp, void *dirent, filldir_t filldir)
215 {
216         struct inode *inode = filp->f_dentry->d_inode;
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         char *nlsname;
225         int nlsnamelen;
226         const char *dirname = filp->f_dentry->d_name.name;
227
228         befs_debug(sb, "---> befs_readdir() "
229                    "name %s, inode %ld, filp->f_pos %Ld",
230                    dirname, inode->i_ino, filp->f_pos);
231
232         result = befs_btree_read(sb, ds, filp->f_pos, BEFS_NAME_LEN + 1,
233                                  keybuf, &keysize, &value);
234
235         if (result == BEFS_ERR) {
236                 befs_debug(sb, "<--- befs_readdir() ERROR");
237                 befs_error(sb, "IO error reading %s (inode %lu)",
238                            dirname, inode->i_ino);
239                 return -EIO;
240
241         } else if (result == BEFS_BT_END) {
242                 befs_debug(sb, "<--- befs_readdir() END");
243                 return 0;
244
245         } else if (result == BEFS_BT_EMPTY) {
246                 befs_debug(sb, "<--- befs_readdir() Empty directory");
247                 return 0;
248         }
249
250         d_type = DT_UNKNOWN;
251
252         /* Convert to NLS */
253         if (BEFS_SB(sb)->nls) {
254                 result =
255                     befs_utf2nls(sb, keybuf, keysize, &nlsname, &nlsnamelen);
256                 if (result < 0) {
257                         befs_debug(sb, "<--- befs_readdir() ERROR");
258                         return result;
259                 }
260                 result = filldir(dirent, nlsname, nlsnamelen, filp->f_pos,
261                                  (ino_t) value, d_type);
262                 kfree(nlsname);
263
264         } else {
265                 result = filldir(dirent, keybuf, keysize, filp->f_pos,
266                                  (ino_t) value, d_type);
267         }
268
269         filp->f_pos++;
270
271         befs_debug(sb, "<--- befs_readdir() filp->f_pos %Ld", filp->f_pos);
272
273         return 0;
274 }
275
276 static struct inode *
277 befs_alloc_inode(struct super_block *sb)
278 {
279         struct befs_inode_info *bi;
280         bi = (struct befs_inode_info *)kmem_cache_alloc(befs_inode_cachep,
281                                                         SLAB_KERNEL);
282         if (!bi)
283                 return NULL;
284         return &bi->vfs_inode;
285 }
286
287 static void
288 befs_destroy_inode(struct inode *inode)
289 {
290         kmem_cache_free(befs_inode_cachep, BEFS_I(inode));
291 }
292
293 static void init_once(void * foo, kmem_cache_t * cachep, unsigned long flags)
294 {
295         struct befs_inode_info *bi = (struct befs_inode_info *) foo;
296         
297                 if ((flags & (SLAB_CTOR_VERIFY|SLAB_CTOR_CONSTRUCTOR)) ==
298                             SLAB_CTOR_CONSTRUCTOR) {
299                         inode_init_once(&bi->vfs_inode);
300                 }
301 }
302
303 static void
304 befs_read_inode(struct inode *inode)
305 {
306         struct buffer_head *bh = NULL;
307         befs_inode *raw_inode = NULL;
308
309         struct super_block *sb = inode->i_sb;
310         befs_sb_info *befs_sb = BEFS_SB(sb);
311         befs_inode_info *befs_ino = NULL;
312
313         befs_debug(sb, "---> befs_read_inode() " "inode = %lu", inode->i_ino);
314
315         befs_ino = BEFS_I(inode);
316
317         /* convert from vfs's inode number to befs's inode number */
318         befs_ino->i_inode_num = blockno2iaddr(sb, inode->i_ino);
319
320         befs_debug(sb, "  real inode number [%u, %hu, %hu]",
321                    befs_ino->i_inode_num.allocation_group,
322                    befs_ino->i_inode_num.start, befs_ino->i_inode_num.len);
323
324         bh = befs_bread(sb, inode->i_ino);
325         if (!bh) {
326                 befs_error(sb, "unable to read inode block - "
327                            "inode = %lu", inode->i_ino);
328                 goto unaquire_none;
329         }
330
331         raw_inode = (befs_inode *) bh->b_data;
332
333         befs_dump_inode(sb, raw_inode);
334
335         if (befs_check_inode(sb, raw_inode, inode->i_ino) != BEFS_OK) {
336                 befs_error(sb, "Bad inode: %lu", inode->i_ino);
337                 goto unaquire_bh;
338         }
339
340         inode->i_mode = (umode_t) fs32_to_cpu(sb, raw_inode->mode);
341
342         /*
343          * set uid and gid.  But since current BeOS is single user OS, so
344          * you can change by "uid" or "gid" options.
345          */   
346
347         inode->i_uid = befs_sb->mount_opts.use_uid ?
348             befs_sb->mount_opts.uid : (uid_t) fs32_to_cpu(sb, raw_inode->uid);
349         inode->i_gid = befs_sb->mount_opts.use_gid ?
350             befs_sb->mount_opts.gid : (gid_t) fs32_to_cpu(sb, raw_inode->gid);
351
352         inode->i_nlink = 1;
353
354         /*
355          * BEFS's time is 64 bits, but current VFS is 32 bits...
356          * BEFS don't have access time. Nor inode change time. VFS
357          * doesn't have creation time.
358          * Also, the lower 16 bits of the last_modified_time and 
359          * create_time are just a counter to help ensure uniqueness
360          * for indexing purposes. (PFD, page 54)
361          */
362
363         inode->i_mtime.tv_sec =
364             fs64_to_cpu(sb, raw_inode->last_modified_time) >> 16;
365         inode->i_mtime.tv_nsec = 0;   /* lower 16 bits are not a time */        
366         inode->i_ctime = inode->i_mtime;
367         inode->i_atime = inode->i_mtime;
368         inode->i_blksize = befs_sb->block_size;
369
370         befs_ino->i_inode_num = fsrun_to_cpu(sb, raw_inode->inode_num);
371         befs_ino->i_parent = fsrun_to_cpu(sb, raw_inode->parent);
372         befs_ino->i_attribute = fsrun_to_cpu(sb, raw_inode->attributes);
373         befs_ino->i_flags = fs32_to_cpu(sb, raw_inode->flags);
374
375         if (S_ISLNK(inode->i_mode) && !(befs_ino->i_flags & BEFS_LONG_SYMLINK)){
376                 inode->i_size = 0;
377                 inode->i_blocks = befs_sb->block_size / VFS_BLOCK_SIZE;
378                 strncpy(befs_ino->i_data.symlink, raw_inode->data.symlink,
379                         BEFS_SYMLINK_LEN);
380         } else {
381                 int num_blks;
382
383                 befs_ino->i_data.ds =
384                     fsds_to_cpu(sb, raw_inode->data.datastream);
385
386                 num_blks = befs_count_blocks(sb, &befs_ino->i_data.ds);
387                 inode->i_blocks =
388                     num_blks * (befs_sb->block_size / VFS_BLOCK_SIZE);
389                 inode->i_size = befs_ino->i_data.ds.size;
390         }
391
392         inode->i_mapping->a_ops = &befs_aops;
393
394         if (S_ISREG(inode->i_mode)) {
395                 inode->i_fop = &generic_ro_fops;
396         } else if (S_ISDIR(inode->i_mode)) {
397                 inode->i_op = &befs_dir_inode_operations;
398                 inode->i_fop = &befs_dir_operations;
399         } else if (S_ISLNK(inode->i_mode)) {
400                 inode->i_op = &befs_symlink_inode_operations;
401         } else {
402                 befs_error(sb, "Inode %lu is not a regular file, "
403                            "directory or symlink. THAT IS WRONG! BeFS has no "
404                            "on disk special files", inode->i_ino);
405                 goto unaquire_bh;
406         }
407
408         brelse(bh);
409         befs_debug(sb, "<--- befs_read_inode()");
410         return;
411
412       unaquire_bh:
413         brelse(bh);
414
415       unaquire_none:
416         make_bad_inode(inode);
417         befs_debug(sb, "<--- befs_read_inode() - Bad inode");
418         return;
419 }
420
421 /* Initialize the inode cache. Called at fs setup.
422  * 
423  * Taken from NFS implementation by Al Viro.
424  */
425 static int
426 befs_init_inodecache(void)
427 {
428         befs_inode_cachep = kmem_cache_create("befs_inode_cache",
429                                               sizeof (struct befs_inode_info),
430                                               0, SLAB_RECLAIM_ACCOUNT,
431                                               init_once, NULL);
432         if (befs_inode_cachep == NULL) {
433                 printk(KERN_ERR "befs_init_inodecache: "
434                        "Couldn't initalize inode slabcache\n");
435                 return -ENOMEM;
436         }
437
438         return 0;
439 }
440
441 /* Called at fs teardown.
442  * 
443  * Taken from NFS implementation by Al Viro.
444  */
445 static void
446 befs_destroy_inodecache(void)
447 {
448         if (kmem_cache_destroy(befs_inode_cachep))
449                 printk(KERN_ERR "befs_destroy_inodecache: "
450                        "not all structures were freed\n");
451 }
452
453 /*
454  * The inode of symbolic link is different to data stream.
455  * The data stream become link name. Unless the LONG_SYMLINK
456  * flag is set.
457  */
458 static void *
459 befs_follow_link(struct dentry *dentry, struct nameidata *nd)
460 {
461         befs_inode_info *befs_ino = BEFS_I(dentry->d_inode);
462         char *link;
463
464         if (befs_ino->i_flags & BEFS_LONG_SYMLINK) {
465                 struct super_block *sb = dentry->d_sb;
466                 befs_data_stream *data = &befs_ino->i_data.ds;
467                 befs_off_t len = data->size;
468
469                 befs_debug(sb, "Follow long symlink");
470
471                 link = kmalloc(len, GFP_NOFS);
472                 if (!link) {
473                         link = ERR_PTR(-ENOMEM);
474                 } else if (befs_read_lsymlink(sb, data, link, len) != len) {
475                         kfree(link);
476                         befs_error(sb, "Failed to read entire long symlink");
477                         link = ERR_PTR(-EIO);
478                 }
479         } else {
480                 link = befs_ino->i_data.symlink;
481         }
482
483         nd_set_link(nd, link);
484         return NULL;
485 }
486
487 static void befs_put_link(struct dentry *dentry, struct nameidata *nd, void *p)
488 {
489         befs_inode_info *befs_ino = BEFS_I(dentry->d_inode);
490         if (befs_ino->i_flags & BEFS_LONG_SYMLINK) {
491                 char *p = nd_get_link(nd);
492                 if (!IS_ERR(p))
493                         kfree(p);
494         }
495 }
496
497 /*
498  * UTF-8 to NLS charset  convert routine
499  * 
500  *
501  * Changed 8/10/01 by Will Dyson. Now use uni2char() / char2uni() rather than
502  * the nls tables directly
503  */
504
505 static int
506 befs_utf2nls(struct super_block *sb, const char *in,
507              int in_len, char **out, int *out_len)
508 {
509         struct nls_table *nls = BEFS_SB(sb)->nls;
510         int i, o;
511         wchar_t uni;
512         int unilen, utflen;
513         char *result;
514         int maxlen = in_len; /* The utf8->nls conversion can't make more chars */
515
516         befs_debug(sb, "---> utf2nls()");
517
518         if (!nls) {
519                 befs_error(sb, "befs_utf2nls called with no NLS table loaded");
520                 return -EINVAL;
521         }
522
523         *out = result = kmalloc(maxlen, GFP_NOFS);
524         if (!*out) {
525                 befs_error(sb, "befs_utf2nls() cannot allocate memory");
526                 *out_len = 0;
527                 return -ENOMEM;
528         }
529
530         for (i = o = 0; i < in_len; i += utflen, o += unilen) {
531
532                 /* convert from UTF-8 to Unicode */
533                 utflen = utf8_mbtowc(&uni, &in[i], in_len - i);
534                 if (utflen < 0) {
535                         goto conv_err;
536                 }
537
538                 /* convert from Unicode to nls */
539                 unilen = nls->uni2char(uni, &result[o], in_len - o);
540                 if (unilen < 0) {
541                         goto conv_err;
542                 }
543         }
544         result[o] = '\0';
545         *out_len = o;
546
547         befs_debug(sb, "<--- utf2nls()");
548
549         return o;
550
551       conv_err:
552         befs_error(sb, "Name using character set %s contains a character that "
553                    "cannot be converted to unicode.", nls->charset);
554         befs_debug(sb, "<--- utf2nls()");
555         kfree(result);
556         return -EILSEQ;
557 }
558
559 /**
560  * befs_nls2utf - Convert NLS string to utf8 encodeing
561  * @sb: Superblock
562  * @src: Input string buffer in NLS format
563  * @srclen: Length of input string in bytes
564  * @dest: The output string in UTF-8 format
565  * @destlen: Length of the output buffer
566  * 
567  * Converts input string @src, which is in the format of the loaded NLS map,
568  * into a utf8 string.
569  * 
570  * The destination string @dest is allocated by this function and the caller is
571  * responsible for freeing it with kfree()
572  * 
573  * On return, *@destlen is the length of @dest in bytes.
574  *
575  * On success, the return value is the number of utf8 characters written to
576  * the output buffer @dest.
577  *  
578  * On Failure, a negative number coresponding to the error code is returned.
579  */
580
581 static int
582 befs_nls2utf(struct super_block *sb, const char *in,
583              int in_len, char **out, int *out_len)
584 {
585         struct nls_table *nls = BEFS_SB(sb)->nls;
586         int i, o;
587         wchar_t uni;
588         int unilen, utflen;
589         char *result;
590         int maxlen = 3 * in_len;
591
592         befs_debug(sb, "---> nls2utf()\n");
593
594         if (!nls) {
595                 befs_error(sb, "befs_nls2utf called with no NLS table loaded.");
596                 return -EINVAL;
597         }
598
599         *out = result = kmalloc(maxlen, GFP_NOFS);
600         if (!*out) {
601                 befs_error(sb, "befs_nls2utf() cannot allocate memory");
602                 *out_len = 0;
603                 return -ENOMEM;
604         }
605
606         for (i = o = 0; i < in_len; i += unilen, o += utflen) {
607
608                 /* convert from nls to unicode */
609                 unilen = nls->char2uni(&in[i], in_len - i, &uni);
610                 if (unilen < 0) {
611                         goto conv_err;
612                 }
613
614                 /* convert from unicode to UTF-8 */
615                 utflen = utf8_wctomb(&result[o], uni, 3);
616                 if (utflen <= 0) {
617                         goto conv_err;
618                 }
619         }
620
621         result[o] = '\0';
622         *out_len = o;
623
624         befs_debug(sb, "<--- nls2utf()");
625
626         return i;
627
628       conv_err:
629         befs_error(sb, "Name using charecter set %s contains a charecter that "
630                    "cannot be converted to unicode.", nls->charset);
631         befs_debug(sb, "<--- nls2utf()");
632         kfree(result);
633         return -EILSEQ;
634 }
635
636 /**
637  * Use the
638  *
639  */
640 enum {
641         Opt_uid, Opt_gid, Opt_charset, Opt_debug, Opt_err,
642 };
643
644 static match_table_t befs_tokens = {
645         {Opt_uid, "uid=%d"},
646         {Opt_gid, "gid=%d"},
647         {Opt_charset, "iocharset=%s"},
648         {Opt_debug, "debug"},
649         {Opt_err, NULL}
650 };
651
652 static int
653 parse_options(char *options, befs_mount_options * opts)
654 {
655         char *p;
656         substring_t args[MAX_OPT_ARGS];
657         int option;
658
659         /* Initialize options */
660         opts->uid = 0;
661         opts->gid = 0;
662         opts->use_uid = 0;
663         opts->use_gid = 0;
664         opts->iocharset = NULL;
665         opts->debug = 0;
666
667         if (!options)
668                 return 1;
669
670         while ((p = strsep(&options, ",")) != NULL) {
671                 int token;
672                 if (!*p)
673                         continue;
674
675                 token = match_token(p, befs_tokens, args);
676                 switch (token) {
677                 case Opt_uid:
678                         if (match_int(&args[0], &option))
679                                 return 0;
680                         if (option < 0) {
681                                 printk(KERN_ERR "BeFS: Invalid uid %d, "
682                                                 "using default\n", option);
683                                 break;
684                         }
685                         opts->uid = option;
686                         opts->use_uid = 1;
687                         break;
688                 case Opt_gid:
689                         if (match_int(&args[0], &option))
690                                 return 0;
691                         if (option < 0) {
692                                 printk(KERN_ERR "BeFS: Invalid gid %d, "
693                                                 "using default\n", option);
694                                 break;
695                         }
696                         opts->gid = option;
697                         opts->use_gid = 1;
698                         break;
699                 case Opt_charset:
700                         kfree(opts->iocharset);
701                         opts->iocharset = match_strdup(&args[0]);
702                         if (!opts->iocharset) {
703                                 printk(KERN_ERR "BeFS: allocation failure for "
704                                                 "iocharset string\n");
705                                 return 0;
706                         }
707                         break;
708                 case Opt_debug:
709                         opts->debug = 1;
710                         break;
711                 default:
712                         printk(KERN_ERR "BeFS: Unrecognized mount option \"%s\" "
713                                         "or missing value\n", p);
714                         return 0;
715                 }
716         }
717         return 1;
718 }
719
720 /* This function has the responsibiltiy of getting the
721  * filesystem ready for unmounting. 
722  * Basicly, we free everything that we allocated in
723  * befs_read_inode
724  */
725 static void
726 befs_put_super(struct super_block *sb)
727 {
728         kfree(BEFS_SB(sb)->mount_opts.iocharset);
729         BEFS_SB(sb)->mount_opts.iocharset = NULL;
730
731         if (BEFS_SB(sb)->nls) {
732                 unload_nls(BEFS_SB(sb)->nls);
733                 BEFS_SB(sb)->nls = NULL;
734         }
735
736         kfree(sb->s_fs_info);
737         sb->s_fs_info = NULL;
738         return;
739 }
740
741 /* Allocate private field of the superblock, fill it.
742  *
743  * Finish filling the public superblock fields
744  * Make the root directory
745  * Load a set of NLS translations if needed.
746  */
747 static int
748 befs_fill_super(struct super_block *sb, void *data, int silent)
749 {
750         struct buffer_head *bh;
751         befs_sb_info *befs_sb;
752         befs_super_block *disk_sb;
753         struct inode *root;
754
755         const unsigned long sb_block = 0;
756         const off_t x86_sb_off = 512;
757
758         sb->s_fs_info = kmalloc(sizeof (*befs_sb), GFP_KERNEL);
759         if (sb->s_fs_info == NULL) {
760                 printk(KERN_ERR
761                        "BeFS(%s): Unable to allocate memory for private "
762                        "portion of superblock. Bailing.\n", sb->s_id);
763                 goto unaquire_none;
764         }
765         befs_sb = BEFS_SB(sb);
766         memset(befs_sb, 0, sizeof(befs_sb_info));
767
768         if (!parse_options((char *) data, &befs_sb->mount_opts)) {
769                 befs_error(sb, "cannot parse mount options");
770                 goto unaquire_priv_sbp;
771         }
772
773         befs_debug(sb, "---> befs_fill_super()");
774
775 #ifndef CONFIG_BEFS_RW
776         if (!(sb->s_flags & MS_RDONLY)) {
777                 befs_warning(sb,
778                              "No write support. Marking filesystem read-only");
779                 sb->s_flags |= MS_RDONLY;
780         }
781 #endif                          /* CONFIG_BEFS_RW */
782
783         /*
784          * Set dummy blocksize to read super block.
785          * Will be set to real fs blocksize later.
786          *
787          * Linux 2.4.10 and later refuse to read blocks smaller than
788          * the hardsect size for the device. But we also need to read at 
789          * least 1k to get the second 512 bytes of the volume.
790          * -WD 10-26-01
791          */ 
792         sb_min_blocksize(sb, 1024);
793
794         if (!(bh = sb_bread(sb, sb_block))) {
795                 befs_error(sb, "unable to read superblock");
796                 goto unaquire_priv_sbp;
797         }
798
799         /* account for offset of super block on x86 */
800         disk_sb = (befs_super_block *) bh->b_data;
801         if ((le32_to_cpu(disk_sb->magic1) == BEFS_SUPER_MAGIC1) ||
802             (be32_to_cpu(disk_sb->magic1) == BEFS_SUPER_MAGIC1)) {
803                 befs_debug(sb, "Using PPC superblock location");
804         } else {
805                 befs_debug(sb, "Using x86 superblock location");
806                 disk_sb =
807                     (befs_super_block *) ((void *) bh->b_data + x86_sb_off);
808         }
809
810         if (befs_load_sb(sb, disk_sb) != BEFS_OK)
811                 goto unaquire_bh;
812
813         befs_dump_super_block(sb, disk_sb);
814
815         brelse(bh);
816
817         if (befs_check_sb(sb) != BEFS_OK)
818                 goto unaquire_priv_sbp;
819
820         if( befs_sb->num_blocks > ~((sector_t)0) ) {
821                 befs_error(sb, "blocks count: %Lu "
822                         "is larger than the host can use",
823                         befs_sb->num_blocks);
824                 goto unaquire_priv_sbp;
825         }
826
827         /*
828          * set up enough so that it can read an inode
829          * Fill in kernel superblock fields from private sb
830          */
831         sb->s_magic = BEFS_SUPER_MAGIC;
832         /* Set real blocksize of fs */
833         sb_set_blocksize(sb, (ulong) befs_sb->block_size);
834         sb->s_op = (struct super_operations *) &befs_sops;
835         root = iget(sb, iaddr2blockno(sb, &(befs_sb->root_dir)));
836         sb->s_root = d_alloc_root(root);
837         if (!sb->s_root) {
838                 iput(root);
839                 befs_error(sb, "get root inode failed");
840                 goto unaquire_priv_sbp;
841         }
842
843         /* load nls library */
844         if (befs_sb->mount_opts.iocharset) {
845                 befs_debug(sb, "Loading nls: %s",
846                            befs_sb->mount_opts.iocharset);
847                 befs_sb->nls = load_nls(befs_sb->mount_opts.iocharset);
848                 if (!befs_sb->nls) {
849                         befs_warning(sb, "Cannot load nls %s"
850                                         " loading default nls",
851                                         befs_sb->mount_opts.iocharset);
852                         befs_sb->nls = load_nls_default();
853                 }
854         /* load default nls if none is specified  in mount options */
855         } else {
856                 befs_debug(sb, "Loading default nls");
857                 befs_sb->nls = load_nls_default();
858         }
859
860         return 0;
861 /*****************/
862       unaquire_bh:
863         brelse(bh);
864
865       unaquire_priv_sbp:
866         kfree(sb->s_fs_info);
867
868       unaquire_none:
869         sb->s_fs_info = NULL;
870         return -EINVAL;
871 }
872
873 static int
874 befs_remount(struct super_block *sb, int *flags, char *data)
875 {
876         if (!(*flags & MS_RDONLY))
877                 return -EINVAL;
878         return 0;
879 }
880
881 static int
882 befs_statfs(struct super_block *sb, struct kstatfs *buf)
883 {
884
885         befs_debug(sb, "---> befs_statfs()");
886
887         buf->f_type = BEFS_SUPER_MAGIC;
888         buf->f_bsize = sb->s_blocksize;
889         buf->f_blocks = BEFS_SB(sb)->num_blocks;
890         buf->f_bfree = BEFS_SB(sb)->num_blocks - BEFS_SB(sb)->used_blocks;
891         buf->f_bavail = buf->f_bfree;
892         buf->f_files = 0;       /* UNKNOWN */
893         buf->f_ffree = 0;       /* UNKNOWN */
894         buf->f_namelen = BEFS_NAME_LEN;
895
896         befs_debug(sb, "<--- befs_statfs()");
897
898         return 0;
899 }
900
901 static struct super_block *
902 befs_get_sb(struct file_system_type *fs_type, int flags, const char *dev_name,
903             void *data)
904 {
905         return get_sb_bdev(fs_type, flags, dev_name, data, befs_fill_super);
906 }
907
908 static struct file_system_type befs_fs_type = {
909         .owner          = THIS_MODULE,
910         .name           = "befs",
911         .get_sb         = befs_get_sb,
912         .kill_sb        = kill_block_super,
913         .fs_flags       = FS_REQUIRES_DEV,      
914 };
915
916 static int __init
917 init_befs_fs(void)
918 {
919         int err;
920
921         printk(KERN_INFO "BeFS version: %s\n", BEFS_VERSION);
922
923         err = befs_init_inodecache();
924         if (err)
925                 goto unaquire_none;
926
927         err = register_filesystem(&befs_fs_type);
928         if (err)
929                 goto unaquire_inodecache;
930
931         return 0;
932
933 unaquire_inodecache:
934         befs_destroy_inodecache();
935
936 unaquire_none:
937         return err;
938 }
939
940 static void __exit
941 exit_befs_fs(void)
942 {
943         befs_destroy_inodecache();
944
945         unregister_filesystem(&befs_fs_type);
946 }
947
948 /*
949 Macros that typecheck the init and exit functions,
950 ensures that they are called at init and cleanup,
951 and eliminates warnings about unused functions.
952 */
953 module_init(init_befs_fs)
954 module_exit(exit_befs_fs)