2 * Copyright (C) 2005, 2006
4 * Copyright (C) 2008, 2009
7 * Copyrights for code taken from ext2:
8 * Copyright (C) 1992, 1993, 1994, 1995
10 * Laboratoire MASI - Institut Blaise Pascal
11 * Universite Pierre et Marie Curie (Paris VI)
13 * linux/fs/minix/inode.c
14 * Copyright (C) 1991, 1992 Linus Torvalds
16 * This file is part of exofs.
18 * exofs is free software; you can redistribute it and/or modify
19 * it under the terms of the GNU General Public License as published by
20 * the Free Software Foundation. Since it is based on ext2, and the only
21 * valid version of GPL for the Linux kernel is version 2, the only valid
22 * version of GPL for exofs is version 2.
24 * exofs is distributed in the hope that it will be useful,
25 * but WITHOUT ANY WARRANTY; without even the implied warranty of
26 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
27 * GNU General Public License for more details.
29 * You should have received a copy of the GNU General Public License
30 * along with exofs; if not, write to the Free Software
31 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
34 #include <linux/string.h>
35 #include <linux/parser.h>
36 #include <linux/vfs.h>
37 #include <linux/random.h>
38 #include <linux/exportfs.h>
39 #include <linux/slab.h>
43 /******************************************************************************
45 *****************************************************************************/
48 * struct to hold what we get from mount options
50 struct exofs_mountopt {
57 * exofs-specific mount-time options.
59 enum { Opt_pid, Opt_to, Opt_mkfs, Opt_format, Opt_err };
62 * Our mount-time options. These should ideally be 64-bit unsigned, but the
63 * kernel's parsing functions do not currently support that. 32-bit should be
64 * sufficient for most applications now.
66 static match_table_t tokens = {
73 * The main option parsing method. Also makes sure that all of the mandatory
74 * mount options were set.
76 static int parse_options(char *options, struct exofs_mountopt *opts)
79 substring_t args[MAX_OPT_ARGS];
83 EXOFS_DBGMSG("parse_options %s\n", options);
85 memset(opts, 0, sizeof(*opts));
86 opts->timeout = BLK_DEFAULT_SG_TIMEOUT;
88 while ((p = strsep(&options, ",")) != NULL) {
95 token = match_token(p, tokens, args);
98 if (0 == match_strlcpy(str, &args[0], sizeof(str)))
100 opts->pid = simple_strtoull(str, NULL, 0);
101 if (opts->pid < EXOFS_MIN_PID) {
102 EXOFS_ERR("Partition ID must be >= %u",
109 if (match_int(&args[0], &option))
112 EXOFS_ERR("Timout must be > 0");
115 opts->timeout = option * HZ;
121 EXOFS_ERR("Need to specify the following options:\n");
122 EXOFS_ERR(" -o pid=pid_no_to_use\n");
129 /******************************************************************************
131 *****************************************************************************/
134 * Our inode cache. Isn't it pretty?
136 static struct kmem_cache *exofs_inode_cachep;
139 * Allocate an inode in the cache
141 static struct inode *exofs_alloc_inode(struct super_block *sb)
143 struct exofs_i_info *oi;
145 oi = kmem_cache_alloc(exofs_inode_cachep, GFP_KERNEL);
149 oi->vfs_inode.i_version = 1;
150 return &oi->vfs_inode;
154 * Remove an inode from the cache
156 static void exofs_destroy_inode(struct inode *inode)
158 kmem_cache_free(exofs_inode_cachep, exofs_i(inode));
162 * Initialize the inode
164 static void exofs_init_once(void *foo)
166 struct exofs_i_info *oi = foo;
168 inode_init_once(&oi->vfs_inode);
172 * Create and initialize the inode cache
174 static int init_inodecache(void)
176 exofs_inode_cachep = kmem_cache_create("exofs_inode_cache",
177 sizeof(struct exofs_i_info), 0,
178 SLAB_RECLAIM_ACCOUNT | SLAB_MEM_SPREAD,
180 if (exofs_inode_cachep == NULL)
186 * Destroy the inode cache
188 static void destroy_inodecache(void)
190 kmem_cache_destroy(exofs_inode_cachep);
193 /******************************************************************************
194 * SUPERBLOCK FUNCTIONS
195 *****************************************************************************/
196 static const struct super_operations exofs_sops;
197 static const struct export_operations exofs_export_ops;
200 * Write the superblock to the OSD
202 int exofs_sync_fs(struct super_block *sb, int wait)
204 struct exofs_sb_info *sbi;
205 struct exofs_fscb *fscb;
206 struct exofs_io_state *ios;
213 ret = exofs_get_io_state(&sbi->layout, &ios);
217 /* Note: We only write the changing part of the fscb. .i.e upto the
218 * the fscb->s_dev_table_oid member. There is no read-modify-write
221 ios->length = offsetof(struct exofs_fscb, s_dev_table_oid);
222 memset(fscb, 0, ios->length);
223 fscb->s_nextid = cpu_to_le64(sbi->s_nextid);
224 fscb->s_numfiles = cpu_to_le32(sbi->s_numfiles);
225 fscb->s_magic = cpu_to_le16(sb->s_magic);
227 fscb->s_version = EXOFS_FSCB_VER;
229 ios->obj.id = EXOFS_SUPER_ID;
231 ios->kern_buff = fscb;
232 ios->cred = sbi->s_cred;
234 ret = exofs_sbi_write(ios);
236 EXOFS_ERR("%s: exofs_sbi_write failed.\n", __func__);
242 EXOFS_DBGMSG("s_nextid=0x%llx ret=%d\n", _LLU(sbi->s_nextid), ret);
243 exofs_put_io_state(ios);
248 static void exofs_write_super(struct super_block *sb)
250 if (!(sb->s_flags & MS_RDONLY))
251 exofs_sync_fs(sb, 1);
256 static void _exofs_print_device(const char *msg, const char *dev_path,
257 struct osd_dev *od, u64 pid)
259 const struct osd_dev_info *odi = osduld_device_info(od);
261 printk(KERN_NOTICE "exofs: %s %s osd_name-%s pid-0x%llx\n",
262 msg, dev_path ?: "", odi->osdname, _LLU(pid));
265 void exofs_free_sbi(struct exofs_sb_info *sbi)
267 while (sbi->layout.s_numdevs) {
268 int i = --sbi->layout.s_numdevs;
269 struct osd_dev *od = sbi->layout.s_ods[i];
272 sbi->layout.s_ods[i] = NULL;
273 osduld_put_device(od);
280 * This function is called when the vfs is freeing the superblock. We just
281 * need to free our own part.
283 static void exofs_put_super(struct super_block *sb)
286 struct exofs_sb_info *sbi = sb->s_fs_info;
289 exofs_write_super(sb);
291 /* make sure there are no pending commands */
292 for (num_pend = atomic_read(&sbi->s_curr_pending); num_pend > 0;
293 num_pend = atomic_read(&sbi->s_curr_pending)) {
294 wait_queue_head_t wq;
295 init_waitqueue_head(&wq);
296 wait_event_timeout(wq,
297 (atomic_read(&sbi->s_curr_pending) == 0),
298 msecs_to_jiffies(100));
301 _exofs_print_device("Unmounting", NULL, sbi->layout.s_ods[0],
304 bdi_destroy(&sbi->bdi);
306 sb->s_fs_info = NULL;
309 static int _read_and_match_data_map(struct exofs_sb_info *sbi, unsigned numdevs,
310 struct exofs_device_table *dt)
314 sbi->data_map.odm_num_comps =
315 le32_to_cpu(dt->dt_data_map.cb_num_comps);
316 sbi->data_map.odm_stripe_unit =
317 le64_to_cpu(dt->dt_data_map.cb_stripe_unit);
318 sbi->data_map.odm_group_width =
319 le32_to_cpu(dt->dt_data_map.cb_group_width);
320 sbi->data_map.odm_group_depth =
321 le32_to_cpu(dt->dt_data_map.cb_group_depth);
322 sbi->data_map.odm_mirror_cnt =
323 le32_to_cpu(dt->dt_data_map.cb_mirror_cnt);
324 sbi->data_map.odm_raid_algorithm =
325 le32_to_cpu(dt->dt_data_map.cb_raid_algorithm);
327 /* FIXME: Only raid0 for now. if not so, do not mount */
328 if (sbi->data_map.odm_num_comps != numdevs) {
329 EXOFS_ERR("odm_num_comps(%u) != numdevs(%u)\n",
330 sbi->data_map.odm_num_comps, numdevs);
333 if (sbi->data_map.odm_raid_algorithm != PNFS_OSD_RAID_0) {
334 EXOFS_ERR("Only RAID_0 for now\n");
337 if (0 != (numdevs % (sbi->data_map.odm_mirror_cnt + 1))) {
338 EXOFS_ERR("Data Map wrong, numdevs=%d mirrors=%d\n",
339 numdevs, sbi->data_map.odm_mirror_cnt);
343 if (0 != (sbi->data_map.odm_stripe_unit & ~PAGE_MASK)) {
344 EXOFS_ERR("Stripe Unit(0x%llx)"
345 " must be Multples of PAGE_SIZE(0x%lx)\n",
346 _LLU(sbi->data_map.odm_stripe_unit), PAGE_SIZE);
350 sbi->layout.stripe_unit = sbi->data_map.odm_stripe_unit;
351 sbi->layout.mirrors_p1 = sbi->data_map.odm_mirror_cnt + 1;
353 if (sbi->data_map.odm_group_width) {
354 sbi->layout.group_width = sbi->data_map.odm_group_width;
355 sbi->layout.group_depth = sbi->data_map.odm_group_depth;
356 if (!sbi->layout.group_depth) {
357 EXOFS_ERR("group_depth == 0 && group_width != 0\n");
360 sbi->layout.group_count = sbi->data_map.odm_num_comps /
361 sbi->layout.mirrors_p1 /
362 sbi->data_map.odm_group_width;
364 if (sbi->data_map.odm_group_depth) {
365 printk(KERN_NOTICE "Warning: group_depth ignored "
366 "group_width == 0 && group_depth == %d\n",
367 sbi->data_map.odm_group_depth);
368 sbi->data_map.odm_group_depth = 0;
370 sbi->layout.group_width = sbi->data_map.odm_num_comps /
371 sbi->layout.mirrors_p1;
372 sbi->layout.group_depth = -1;
373 sbi->layout.group_count = 1;
376 stripe_length = (u64)sbi->layout.group_width * sbi->layout.stripe_unit;
377 if (stripe_length >= (1ULL << 32)) {
378 EXOFS_ERR("Total Stripe length(0x%llx)"
379 " >= 32bit is not supported\n", _LLU(stripe_length));
386 /* @odi is valid only as long as @fscb_dev is valid */
387 static int exofs_devs_2_odi(struct exofs_dt_device_info *dt_dev,
388 struct osd_dev_info *odi)
390 odi->systemid_len = le32_to_cpu(dt_dev->systemid_len);
391 memcpy(odi->systemid, dt_dev->systemid, odi->systemid_len);
393 odi->osdname_len = le32_to_cpu(dt_dev->osdname_len);
394 odi->osdname = dt_dev->osdname;
396 /* FIXME support long names. Will need a _put function */
397 if (dt_dev->long_name_offset)
400 /* Make sure osdname is printable!
401 * mkexofs should give us space for a null-terminator else the
402 * device-table is invalid.
404 if (unlikely(odi->osdname_len >= sizeof(dt_dev->osdname)))
405 odi->osdname_len = sizeof(dt_dev->osdname) - 1;
406 dt_dev->osdname[odi->osdname_len] = 0;
408 /* If it's all zeros something is bad we read past end-of-obj */
409 return !(odi->systemid_len || odi->osdname_len);
412 static int exofs_read_lookup_dev_table(struct exofs_sb_info **psbi,
413 unsigned table_count)
415 struct exofs_sb_info *sbi = *psbi;
416 struct osd_dev *fscb_od;
417 struct osd_obj_id obj = {.partition = sbi->layout.s_pid,
418 .id = EXOFS_DEVTABLE_ID};
419 struct exofs_device_table *dt;
420 unsigned table_bytes = table_count * sizeof(dt->dt_dev_table[0]) +
425 dt = kmalloc(table_bytes, GFP_KERNEL);
427 EXOFS_ERR("ERROR: allocating %x bytes for device table\n",
432 fscb_od = sbi->layout.s_ods[0];
433 sbi->layout.s_ods[0] = NULL;
434 sbi->layout.s_numdevs = 0;
435 ret = exofs_read_kern(fscb_od, sbi->s_cred, &obj, 0, dt, table_bytes);
437 EXOFS_ERR("ERROR: reading device table\n");
441 numdevs = le64_to_cpu(dt->dt_num_devices);
442 if (unlikely(!numdevs)) {
446 WARN_ON(table_count != numdevs);
448 ret = _read_and_match_data_map(sbi, numdevs, dt);
452 if (likely(numdevs > 1)) {
453 unsigned size = numdevs * sizeof(sbi->layout.s_ods[0]);
455 sbi = krealloc(sbi, sizeof(*sbi) + size, GFP_KERNEL);
456 if (unlikely(!sbi)) {
460 memset(&sbi->layout.s_ods[1], 0,
461 size - sizeof(sbi->layout.s_ods[0]));
465 for (i = 0; i < numdevs; i++) {
466 struct exofs_fscb fscb;
467 struct osd_dev_info odi;
470 if (exofs_devs_2_odi(&dt->dt_dev_table[i], &odi)) {
471 EXOFS_ERR("ERROR: Read all-zeros device entry\n");
476 printk(KERN_NOTICE "Add device[%d]: osd_name-%s\n",
479 /* On all devices the device table is identical. The user can
480 * specify any one of the participating devices on the command
481 * line. We always keep them in device-table order.
483 if (fscb_od && osduld_device_same(fscb_od, &odi)) {
484 sbi->layout.s_ods[i] = fscb_od;
485 ++sbi->layout.s_numdevs;
490 od = osduld_info_lookup(&odi);
491 if (unlikely(IS_ERR(od))) {
493 EXOFS_ERR("ERROR: device requested is not found "
494 "osd_name-%s =>%d\n", odi.osdname, ret);
498 sbi->layout.s_ods[i] = od;
499 ++sbi->layout.s_numdevs;
501 /* Read the fscb of the other devices to make sure the FS
502 * partition is there.
504 ret = exofs_read_kern(od, sbi->s_cred, &obj, 0, &fscb,
507 EXOFS_ERR("ERROR: Malformed participating device "
508 "error reading fscb osd_name-%s\n",
513 /* TODO: verify other information is correct and FS-uuid
514 * matches. Benny what did you say about device table
515 * generation and old devices?
521 if (unlikely(!ret && fscb_od)) {
523 "ERROR: Bad device-table container device not present\n");
524 osduld_put_device(fscb_od);
532 * Read the superblock from the OSD and fill in the fields
534 static int exofs_fill_super(struct super_block *sb, void *data, int silent)
537 struct exofs_mountopt *opts = data;
538 struct exofs_sb_info *sbi; /*extended info */
539 struct osd_dev *od; /* Master device */
540 struct exofs_fscb fscb; /*on-disk superblock info */
541 struct osd_obj_id obj;
542 unsigned table_count;
545 sbi = kzalloc(sizeof(*sbi), GFP_KERNEL);
549 ret = bdi_setup_and_register(&sbi->bdi, "exofs", BDI_CAP_MAP_COPY);
553 /* use mount options to fill superblock */
554 od = osduld_path_lookup(opts->dev_name);
560 /* Default layout in case we do not have a device-table */
561 sbi->layout.stripe_unit = PAGE_SIZE;
562 sbi->layout.mirrors_p1 = 1;
563 sbi->layout.group_width = 1;
564 sbi->layout.group_depth = -1;
565 sbi->layout.group_count = 1;
566 sbi->layout.s_ods[0] = od;
567 sbi->layout.s_numdevs = 1;
568 sbi->layout.s_pid = opts->pid;
569 sbi->s_timeout = opts->timeout;
571 /* fill in some other data by hand */
572 memset(sb->s_id, 0, sizeof(sb->s_id));
573 strcpy(sb->s_id, "exofs");
574 sb->s_blocksize = EXOFS_BLKSIZE;
575 sb->s_blocksize_bits = EXOFS_BLKSHIFT;
576 sb->s_maxbytes = MAX_LFS_FILESIZE;
577 atomic_set(&sbi->s_curr_pending, 0);
581 obj.partition = sbi->layout.s_pid;
582 obj.id = EXOFS_SUPER_ID;
583 exofs_make_credential(sbi->s_cred, &obj);
585 ret = exofs_read_kern(od, sbi->s_cred, &obj, 0, &fscb, sizeof(fscb));
589 sb->s_magic = le16_to_cpu(fscb.s_magic);
590 sbi->s_nextid = le64_to_cpu(fscb.s_nextid);
591 sbi->s_numfiles = le32_to_cpu(fscb.s_numfiles);
593 /* make sure what we read from the object store is correct */
594 if (sb->s_magic != EXOFS_SUPER_MAGIC) {
596 EXOFS_ERR("ERROR: Bad magic value\n");
600 if (le32_to_cpu(fscb.s_version) != EXOFS_FSCB_VER) {
601 EXOFS_ERR("ERROR: Bad FSCB version expected-%d got-%d\n",
602 EXOFS_FSCB_VER, le32_to_cpu(fscb.s_version));
607 /* start generation numbers from a random point */
608 get_random_bytes(&sbi->s_next_generation, sizeof(u32));
609 spin_lock_init(&sbi->s_next_gen_lock);
611 table_count = le64_to_cpu(fscb.s_dev_table_count);
613 ret = exofs_read_lookup_dev_table(&sbi, table_count);
618 /* set up operation vectors */
619 sb->s_bdi = &sbi->bdi;
621 sb->s_op = &exofs_sops;
622 sb->s_export_op = &exofs_export_ops;
623 root = exofs_iget(sb, EXOFS_ROOT_ID - EXOFS_OBJ_OFF);
625 EXOFS_ERR("ERROR: exofs_iget failed\n");
629 sb->s_root = d_alloc_root(root);
632 EXOFS_ERR("ERROR: get root inode failed\n");
637 if (!S_ISDIR(root->i_mode)) {
640 EXOFS_ERR("ERROR: corrupt root inode (mode = %hd)\n",
646 _exofs_print_device("Mounting", opts->dev_name, sbi->layout.s_ods[0],
651 bdi_destroy(&sbi->bdi);
653 EXOFS_ERR("Unable to mount exofs on %s pid=0x%llx err=%d\n",
654 opts->dev_name, sbi->layout.s_pid, ret);
660 * Set up the superblock (calls exofs_fill_super eventually)
662 static struct dentry *exofs_mount(struct file_system_type *type,
663 int flags, const char *dev_name,
666 struct exofs_mountopt opts;
669 ret = parse_options(data, &opts);
673 opts.dev_name = dev_name;
674 return mount_nodev(type, flags, &opts, exofs_fill_super);
678 * Return information about the file system state in the buffer. This is used
679 * by the 'df' command, for example.
681 static int exofs_statfs(struct dentry *dentry, struct kstatfs *buf)
683 struct super_block *sb = dentry->d_sb;
684 struct exofs_sb_info *sbi = sb->s_fs_info;
685 struct exofs_io_state *ios;
686 struct osd_attr attrs[] = {
687 ATTR_DEF(OSD_APAGE_PARTITION_QUOTAS,
688 OSD_ATTR_PQ_CAPACITY_QUOTA, sizeof(__be64)),
689 ATTR_DEF(OSD_APAGE_PARTITION_INFORMATION,
690 OSD_ATTR_PI_USED_CAPACITY, sizeof(__be64)),
692 uint64_t capacity = ULLONG_MAX;
693 uint64_t used = ULLONG_MAX;
694 uint8_t cred_a[OSD_CAP_LEN];
697 ret = exofs_get_io_state(&sbi->layout, &ios);
699 EXOFS_DBGMSG("exofs_get_io_state failed.\n");
703 exofs_make_credential(cred_a, &ios->obj);
704 ios->cred = sbi->s_cred;
705 ios->in_attr = attrs;
706 ios->in_attr_len = ARRAY_SIZE(attrs);
708 ret = exofs_sbi_read(ios);
712 ret = extract_attr_from_ios(ios, &attrs[0]);
714 capacity = get_unaligned_be64(attrs[0].val_ptr);
715 if (unlikely(!capacity))
716 capacity = ULLONG_MAX;
718 EXOFS_DBGMSG("exofs_statfs: get capacity failed.\n");
720 ret = extract_attr_from_ios(ios, &attrs[1]);
722 used = get_unaligned_be64(attrs[1].val_ptr);
724 EXOFS_DBGMSG("exofs_statfs: get used-space failed.\n");
726 /* fill in the stats buffer */
727 buf->f_type = EXOFS_SUPER_MAGIC;
728 buf->f_bsize = EXOFS_BLKSIZE;
729 buf->f_blocks = capacity >> 9;
730 buf->f_bfree = (capacity - used) >> 9;
731 buf->f_bavail = buf->f_bfree;
732 buf->f_files = sbi->s_numfiles;
733 buf->f_ffree = EXOFS_MAX_ID - sbi->s_numfiles;
734 buf->f_namelen = EXOFS_NAME_LEN;
737 exofs_put_io_state(ios);
741 static const struct super_operations exofs_sops = {
742 .alloc_inode = exofs_alloc_inode,
743 .destroy_inode = exofs_destroy_inode,
744 .write_inode = exofs_write_inode,
745 .evict_inode = exofs_evict_inode,
746 .put_super = exofs_put_super,
747 .write_super = exofs_write_super,
748 .sync_fs = exofs_sync_fs,
749 .statfs = exofs_statfs,
752 /******************************************************************************
754 *****************************************************************************/
756 struct dentry *exofs_get_parent(struct dentry *child)
758 unsigned long ino = exofs_parent_ino(child);
763 return d_obtain_alias(exofs_iget(child->d_inode->i_sb, ino));
766 static struct inode *exofs_nfs_get_inode(struct super_block *sb,
767 u64 ino, u32 generation)
771 inode = exofs_iget(sb, ino);
773 return ERR_CAST(inode);
774 if (generation && inode->i_generation != generation) {
775 /* we didn't find the right inode.. */
777 return ERR_PTR(-ESTALE);
782 static struct dentry *exofs_fh_to_dentry(struct super_block *sb,
783 struct fid *fid, int fh_len, int fh_type)
785 return generic_fh_to_dentry(sb, fid, fh_len, fh_type,
786 exofs_nfs_get_inode);
789 static struct dentry *exofs_fh_to_parent(struct super_block *sb,
790 struct fid *fid, int fh_len, int fh_type)
792 return generic_fh_to_parent(sb, fid, fh_len, fh_type,
793 exofs_nfs_get_inode);
796 static const struct export_operations exofs_export_ops = {
797 .fh_to_dentry = exofs_fh_to_dentry,
798 .fh_to_parent = exofs_fh_to_parent,
799 .get_parent = exofs_get_parent,
802 /******************************************************************************
804 *****************************************************************************/
807 * struct that describes this file system
809 static struct file_system_type exofs_type = {
810 .owner = THIS_MODULE,
812 .mount = exofs_mount,
813 .kill_sb = generic_shutdown_super,
816 static int __init init_exofs(void)
820 err = init_inodecache();
824 err = register_filesystem(&exofs_type);
830 destroy_inodecache();
835 static void __exit exit_exofs(void)
837 unregister_filesystem(&exofs_type);
838 destroy_inodecache();
842 MODULE_DESCRIPTION("exofs");
843 MODULE_LICENSE("GPL");
845 module_init(init_exofs)
846 module_exit(exit_exofs)