fd78414ee7e4cc81efdf2803cc0acf7d2238eb82
[linux-2.6.git] / fs / hfs / super.c
1 /*
2  *  linux/fs/hfs/super.c
3  *
4  * Copyright (C) 1995-1997  Paul H. Hargrove
5  * (C) 2003 Ardis Technologies <roman@ardistech.com>
6  * This file may be distributed under the terms of the GNU General Public License.
7  *
8  * This file contains hfs_read_super(), some of the super_ops and
9  * init_module() and cleanup_module().  The remaining super_ops are in
10  * inode.c since they deal with inodes.
11  *
12  * Based on the minix file system code, (C) 1991, 1992 by Linus Torvalds
13  */
14
15 #include <linux/config.h>
16 #include <linux/module.h>
17 #include <linux/blkdev.h>
18 #include <linux/mount.h>
19 #include <linux/init.h>
20 #include <linux/parser.h>
21 #include <linux/seq_file.h>
22 #include <linux/vfs.h>
23
24 #include "hfs_fs.h"
25 #include "btree.h"
26
27 static kmem_cache_t *hfs_inode_cachep;
28
29 MODULE_LICENSE("GPL");
30
31 /*
32  * hfs_write_super()
33  *
34  * Description:
35  *   This function is called by the VFS only. When the filesystem
36  *   is mounted r/w it updates the MDB on disk.
37  * Input Variable(s):
38  *   struct super_block *sb: Pointer to the hfs superblock
39  * Output Variable(s):
40  *   NONE
41  * Returns:
42  *   void
43  * Preconditions:
44  *   'sb' points to a "valid" (struct super_block).
45  * Postconditions:
46  *   The MDB is marked 'unsuccessfully unmounted' by clearing bit 8 of drAtrb
47  *   (hfs_put_super() must set this flag!). Some MDB fields are updated
48  *   and the MDB buffer is written to disk by calling hfs_mdb_commit().
49  */
50 static void hfs_write_super(struct super_block *sb)
51 {
52         sb->s_dirt = 0;
53         if (sb->s_flags & MS_RDONLY)
54                 return;
55         /* sync everything to the buffers */
56         hfs_mdb_commit(sb);
57 }
58
59 /*
60  * hfs_put_super()
61  *
62  * This is the put_super() entry in the super_operations structure for
63  * HFS filesystems.  The purpose is to release the resources
64  * associated with the superblock sb.
65  */
66 static void hfs_put_super(struct super_block *sb)
67 {
68         hfs_mdb_close(sb);
69         /* release the MDB's resources */
70         hfs_mdb_put(sb);
71 }
72
73 /*
74  * hfs_statfs()
75  *
76  * This is the statfs() entry in the super_operations structure for
77  * HFS filesystems.  The purpose is to return various data about the
78  * filesystem.
79  *
80  * changed f_files/f_ffree to reflect the fs_ablock/free_ablocks.
81  */
82 static int hfs_statfs(struct super_block *sb, struct kstatfs *buf)
83 {
84         buf->f_type = HFS_SUPER_MAGIC;
85         buf->f_bsize = sb->s_blocksize;
86         buf->f_blocks = (u32)HFS_SB(sb)->fs_ablocks * HFS_SB(sb)->fs_div;
87         buf->f_bfree = (u32)HFS_SB(sb)->free_ablocks * HFS_SB(sb)->fs_div;
88         buf->f_bavail = buf->f_bfree;
89         buf->f_files = HFS_SB(sb)->fs_ablocks;
90         buf->f_ffree = HFS_SB(sb)->free_ablocks;
91         buf->f_namelen = HFS_NAMELEN;
92
93         return 0;
94 }
95
96 static int hfs_remount(struct super_block *sb, int *flags, char *data)
97 {
98         *flags |= MS_NODIRATIME;
99         if ((*flags & MS_RDONLY) == (sb->s_flags & MS_RDONLY))
100                 return 0;
101         if (!(*flags & MS_RDONLY)) {
102                 if (!(HFS_SB(sb)->mdb->drAtrb & cpu_to_be16(HFS_SB_ATTRIB_UNMNT))) {
103                         printk("HFS-fs warning: Filesystem was not cleanly unmounted, "
104                                "running fsck.hfs is recommended.  leaving read-only.\n");
105                         sb->s_flags |= MS_RDONLY;
106                         *flags |= MS_RDONLY;
107                 } else if (HFS_SB(sb)->mdb->drAtrb & cpu_to_be16(HFS_SB_ATTRIB_SLOCK)) {
108                         printk("HFS-fs: Filesystem is marked locked, leaving read-only.\n");
109                         sb->s_flags |= MS_RDONLY;
110                         *flags |= MS_RDONLY;
111                 }
112         }
113         return 0;
114 }
115
116 static int hfs_show_options(struct seq_file *seq, struct vfsmount *mnt)
117 {
118         struct hfs_sb_info *sbi = HFS_SB(mnt->mnt_sb);
119
120         if (sbi->s_creator != cpu_to_be32(0x3f3f3f3f))
121                 seq_printf(seq, ",creator=%.4s", (char *)&sbi->s_creator);
122         if (sbi->s_type != cpu_to_be32(0x3f3f3f3f))
123                 seq_printf(seq, ",type=%.4s", (char *)&sbi->s_type);
124         seq_printf(seq, ",uid=%u,gid=%u", sbi->s_uid, sbi->s_gid);
125         if (sbi->s_file_umask != 0133)
126                 seq_printf(seq, ",file_umask=%o", sbi->s_file_umask);
127         if (sbi->s_dir_umask != 0022)
128                 seq_printf(seq, ",dir_umask=%o", sbi->s_dir_umask);
129         if (sbi->part >= 0)
130                 seq_printf(seq, ",part=%u", sbi->part);
131         if (sbi->session >= 0)
132                 seq_printf(seq, ",session=%u", sbi->session);
133         if (sbi->s_quiet)
134                 seq_printf(seq, ",quiet");
135         return 0;
136 }
137
138 static struct inode *hfs_alloc_inode(struct super_block *sb)
139 {
140         struct hfs_inode_info *i;
141
142         i = kmem_cache_alloc(hfs_inode_cachep, SLAB_KERNEL);
143         return i ? &i->vfs_inode : NULL;
144 }
145
146 static void hfs_destroy_inode(struct inode *inode)
147 {
148         kmem_cache_free(hfs_inode_cachep, HFS_I(inode));
149 }
150
151 static struct super_operations hfs_super_operations = {
152         .alloc_inode    = hfs_alloc_inode,
153         .destroy_inode  = hfs_destroy_inode,
154         .write_inode    = hfs_write_inode,
155         .clear_inode    = hfs_clear_inode,
156         .put_super      = hfs_put_super,
157         .write_super    = hfs_write_super,
158         .statfs         = hfs_statfs,
159         .remount_fs     = hfs_remount,
160         .show_options   = hfs_show_options,
161 };
162
163 enum {
164         opt_uid, opt_gid, opt_umask, opt_file_umask, opt_dir_umask,
165         opt_part, opt_session, opt_type, opt_creator, opt_quiet,
166         opt_err
167 };
168
169 static match_table_t tokens = {
170         { opt_uid, "uid=%u" },
171         { opt_gid, "gid=%u" },
172         { opt_umask, "umask=%o" },
173         { opt_file_umask, "file_umask=%o" },
174         { opt_dir_umask, "dir_umask=%o" },
175         { opt_part, "part=%u" },
176         { opt_session, "session=%u" },
177         { opt_type, "type=%s" },
178         { opt_creator, "creator=%s" },
179         { opt_quiet, "quiet" },
180         { opt_err, NULL }
181 };
182
183 static inline int match_fourchar(substring_t *arg, u32 *result)
184 {
185         if (arg->to - arg->from != 4)
186                 return -EINVAL;
187         memcpy(result, arg->from, 4);
188         return 0;
189 }
190
191 /*
192  * parse_options()
193  *
194  * adapted from linux/fs/msdos/inode.c written 1992,93 by Werner Almesberger
195  * This function is called by hfs_read_super() to parse the mount options.
196  */
197 static int parse_options(char *options, struct hfs_sb_info *hsb)
198 {
199         char *p;
200         substring_t args[MAX_OPT_ARGS];
201         int tmp, token;
202
203         /* initialize the sb with defaults */
204         hsb->s_uid = current->uid;
205         hsb->s_gid = current->gid;
206         hsb->s_file_umask = 0133;
207         hsb->s_dir_umask = 0022;
208         hsb->s_type = hsb->s_creator = cpu_to_be32(0x3f3f3f3f); /* == '????' */
209         hsb->s_quiet = 0;
210         hsb->part = -1;
211         hsb->session = -1;
212
213         if (!options)
214                 return 1;
215
216         while ((p = strsep(&options, ",")) != NULL) {
217                 if (!*p)
218                         continue;
219
220                 token = match_token(p, tokens, args);
221                 switch (token) {
222                 case opt_uid:
223                         if (match_int(&args[0], &tmp)) {
224                                 printk("HFS: uid requires an argument\n");
225                                 return 0;
226                         }
227                         hsb->s_uid = (uid_t)tmp;
228                         break;
229                 case opt_gid:
230                         if (match_int(&args[0], &tmp)) {
231                                 printk("HFS: gid requires an argument\n");
232                                 return 0;
233                         }
234                         hsb->s_gid = (gid_t)tmp;
235                         break;
236                 case opt_umask:
237                         if (match_octal(&args[0], &tmp)) {
238                                 printk("HFS: umask requires a value\n");
239                                 return 0;
240                         }
241                         hsb->s_file_umask = (umode_t)tmp;
242                         hsb->s_dir_umask = (umode_t)tmp;
243                         break;
244                 case opt_file_umask:
245                         if (match_octal(&args[0], &tmp)) {
246                                 printk("HFS: file_umask requires a value\n");
247                                 return 0;
248                         }
249                         hsb->s_file_umask = (umode_t)tmp;
250                         break;
251                 case opt_dir_umask:
252                         if (match_octal(&args[0], &tmp)) {
253                                 printk("HFS: dir_umask requires a value\n");
254                                 return 0;
255                         }
256                         hsb->s_dir_umask = (umode_t)tmp;
257                         break;
258                 case opt_part:
259                         if (match_int(&args[0], &hsb->part)) {
260                                 printk("HFS: part requires an argument\n");
261                                 return 0;
262                         }
263                         break;
264                 case opt_session:
265                         if (match_int(&args[0], &hsb->session)) {
266                                 printk("HFS: session requires an argument\n");
267                                 return 0;
268                         }
269                         break;
270                 case opt_type:
271                         if (match_fourchar(&args[0], &hsb->s_type)) {
272                                 printk("HFS+-fs: type requires a 4 character value\n");
273                                 return 0;
274                         }
275                         break;
276                 case opt_creator:
277                         if (match_fourchar(&args[0], &hsb->s_creator)) {
278                                 printk("HFS+-fs: creator requires a 4 character value\n");
279                                 return 0;
280                         }
281                         break;
282                 case opt_quiet:
283                         hsb->s_quiet = 1;
284                         break;
285                 default:
286                         return 0;
287                 }
288         }
289
290         hsb->s_dir_umask &= 0777;
291         hsb->s_file_umask &= 0577;
292
293         return 1;
294 }
295
296 /*
297  * hfs_read_super()
298  *
299  * This is the function that is responsible for mounting an HFS
300  * filesystem.  It performs all the tasks necessary to get enough data
301  * from the disk to read the root inode.  This includes parsing the
302  * mount options, dealing with Macintosh partitions, reading the
303  * superblock and the allocation bitmap blocks, calling
304  * hfs_btree_init() to get the necessary data about the extents and
305  * catalog B-trees and, finally, reading the root inode into memory.
306  */
307 static int hfs_fill_super(struct super_block *sb, void *data, int silent)
308 {
309         struct hfs_sb_info *sbi;
310         struct hfs_find_data fd;
311         hfs_cat_rec rec;
312         struct inode *root_inode;
313         int res;
314
315         sbi = kmalloc(sizeof(struct hfs_sb_info), GFP_KERNEL);
316         if (!sbi)
317                 return -ENOMEM;
318         sb->s_fs_info = sbi;
319         memset(sbi, 0, sizeof(struct hfs_sb_info));
320         INIT_HLIST_HEAD(&sbi->rsrc_inodes);
321
322         res = -EINVAL;
323         if (!parse_options((char *)data, sbi)) {
324                 hfs_warn("hfs_fs: unable to parse mount options.\n");
325                 goto bail;
326         }
327
328         sb->s_op = &hfs_super_operations;
329         sb->s_flags |= MS_NODIRATIME;
330         init_MUTEX(&sbi->bitmap_lock);
331
332         res = hfs_mdb_get(sb);
333         if (res) {
334                 if (!silent)
335                         hfs_warn("VFS: Can't find a HFS filesystem on dev %s.\n",
336                                 hfs_mdb_name(sb));
337                 res = -EINVAL;
338                 goto bail;
339         }
340
341         /* try to get the root inode */
342         hfs_find_init(HFS_SB(sb)->cat_tree, &fd);
343         res = hfs_cat_find_brec(sb, HFS_ROOT_CNID, &fd);
344         if (!res)
345                 hfs_bnode_read(fd.bnode, &rec, fd.entryoffset, fd.entrylength);
346         if (res) {
347                 hfs_find_exit(&fd);
348                 goto bail_no_root;
349         }
350         root_inode = hfs_iget(sb, &fd.search_key->cat, &rec);
351         hfs_find_exit(&fd);
352         if (!root_inode)
353                 goto bail_no_root;
354
355         sb->s_root = d_alloc_root(root_inode);
356         if (!sb->s_root)
357                 goto bail_iput;
358
359         sb->s_root->d_op = &hfs_dentry_operations;
360
361         /* everything's okay */
362         return 0;
363
364 bail_iput:
365         iput(root_inode);
366 bail_no_root:
367         hfs_warn("hfs_fs: get root inode failed.\n");
368 bail:
369         hfs_mdb_put(sb);
370         return res;
371 }
372
373 static struct super_block *hfs_get_sb(struct file_system_type *fs_type,
374                                       int flags, const char *dev_name, void *data)
375 {
376         return get_sb_bdev(fs_type, flags, dev_name, data, hfs_fill_super);
377 }
378
379 static struct file_system_type hfs_fs_type = {
380         .owner          = THIS_MODULE,
381         .name           = "hfs",
382         .get_sb         = hfs_get_sb,
383         .kill_sb        = kill_block_super,
384         .fs_flags       = FS_REQUIRES_DEV,
385 };
386
387 static void hfs_init_once(void *p, kmem_cache_t *cachep, unsigned long flags)
388 {
389         struct hfs_inode_info *i = p;
390
391         if ((flags & (SLAB_CTOR_VERIFY|SLAB_CTOR_CONSTRUCTOR)) == SLAB_CTOR_CONSTRUCTOR)
392                 inode_init_once(&i->vfs_inode);
393 }
394
395 static int __init init_hfs_fs(void)
396 {
397         int err;
398
399         hfs_inode_cachep = kmem_cache_create("hfs_inode_cache",
400                 sizeof(struct hfs_inode_info), 0, SLAB_HWCACHE_ALIGN,
401                 hfs_init_once, NULL);
402         if (!hfs_inode_cachep)
403                 return -ENOMEM;
404         err = register_filesystem(&hfs_fs_type);
405         if (err)
406                 kmem_cache_destroy(hfs_inode_cachep);
407         return err;
408 }
409
410 static void __exit exit_hfs_fs(void)
411 {
412         unregister_filesystem(&hfs_fs_type);
413         if (kmem_cache_destroy(hfs_inode_cachep))
414                 printk(KERN_INFO "hfs_inode_cache: not all structures were freed\n");
415 }
416
417 module_init(init_hfs_fs)
418 module_exit(exit_hfs_fs)