2 * Copyright (C) 2005, 2006
3 * Avishay Traeger (avishay@gmail.com)
4 * Copyright (C) 2008, 2009
5 * Boaz Harrosh <bharrosh@panasas.com>
7 * Copyrights for code taken from ext2:
8 * Copyright (C) 1992, 1993, 1994, 1995
9 * Remy Card (card@masi.ibp.fr)
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/smp_lock.h>
35 #include <linux/string.h>
36 #include <linux/parser.h>
37 #include <linux/vfs.h>
38 #include <linux/random.h>
39 #include <linux/exportfs.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
, &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
->s_numdevs
) {
268 int i
= --sbi
->s_numdevs
;
269 struct osd_dev
*od
= sbi
->s_ods
[i
];
272 sbi
->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
->s_ods
[0], sbi
->s_pid
);
304 sb
->s_fs_info
= NULL
;
307 static int _read_and_match_data_map(struct exofs_sb_info
*sbi
, unsigned numdevs
,
308 struct exofs_device_table
*dt
)
310 sbi
->data_map
.odm_num_comps
=
311 le32_to_cpu(dt
->dt_data_map
.cb_num_comps
);
312 sbi
->data_map
.odm_stripe_unit
=
313 le64_to_cpu(dt
->dt_data_map
.cb_stripe_unit
);
314 sbi
->data_map
.odm_group_width
=
315 le32_to_cpu(dt
->dt_data_map
.cb_group_width
);
316 sbi
->data_map
.odm_group_depth
=
317 le32_to_cpu(dt
->dt_data_map
.cb_group_depth
);
318 sbi
->data_map
.odm_mirror_cnt
=
319 le32_to_cpu(dt
->dt_data_map
.cb_mirror_cnt
);
320 sbi
->data_map
.odm_raid_algorithm
=
321 le32_to_cpu(dt
->dt_data_map
.cb_raid_algorithm
);
323 /* FIXME: Hard coded mirror only for now. if not so do not mount */
324 if ((sbi
->data_map
.odm_num_comps
!= numdevs
) ||
325 (sbi
->data_map
.odm_stripe_unit
!= EXOFS_BLKSIZE
) ||
326 (sbi
->data_map
.odm_raid_algorithm
!= PNFS_OSD_RAID_0
) ||
327 (sbi
->data_map
.odm_mirror_cnt
!= (numdevs
- 1)))
333 /* @odi is valid only as long as @fscb_dev is valid */
334 static int exofs_devs_2_odi(struct exofs_dt_device_info
*dt_dev
,
335 struct osd_dev_info
*odi
)
337 odi
->systemid_len
= le32_to_cpu(dt_dev
->systemid_len
);
338 memcpy(odi
->systemid
, dt_dev
->systemid
, odi
->systemid_len
);
340 odi
->osdname_len
= le32_to_cpu(dt_dev
->osdname_len
);
341 odi
->osdname
= dt_dev
->osdname
;
343 /* FIXME support long names. Will need a _put function */
344 if (dt_dev
->long_name_offset
)
347 /* Make sure osdname is printable!
348 * mkexofs should give us space for a null-terminator else the
349 * device-table is invalid.
351 if (unlikely(odi
->osdname_len
>= sizeof(dt_dev
->osdname
)))
352 odi
->osdname_len
= sizeof(dt_dev
->osdname
) - 1;
353 dt_dev
->osdname
[odi
->osdname_len
] = 0;
355 /* If it's all zeros something is bad we read past end-of-obj */
356 return !(odi
->systemid_len
|| odi
->osdname_len
);
359 static int exofs_read_lookup_dev_table(struct exofs_sb_info
**psbi
,
360 unsigned table_count
)
362 struct exofs_sb_info
*sbi
= *psbi
;
363 struct osd_dev
*fscb_od
;
364 struct osd_obj_id obj
= {.partition
= sbi
->s_pid
,
365 .id
= EXOFS_DEVTABLE_ID
};
366 struct exofs_device_table
*dt
;
367 unsigned table_bytes
= table_count
* sizeof(dt
->dt_dev_table
[0]) +
372 dt
= kmalloc(table_bytes
, GFP_KERNEL
);
374 EXOFS_ERR("ERROR: allocating %x bytes for device table\n",
379 fscb_od
= sbi
->s_ods
[0];
380 sbi
->s_ods
[0] = NULL
;
382 ret
= exofs_read_kern(fscb_od
, sbi
->s_cred
, &obj
, 0, dt
, table_bytes
);
384 EXOFS_ERR("ERROR: reading device table\n");
388 numdevs
= le64_to_cpu(dt
->dt_num_devices
);
389 if (unlikely(!numdevs
)) {
393 WARN_ON(table_count
!= numdevs
);
395 ret
= _read_and_match_data_map(sbi
, numdevs
, dt
);
399 if (likely(numdevs
> 1)) {
400 unsigned size
= numdevs
* sizeof(sbi
->s_ods
[0]);
402 sbi
= krealloc(sbi
, sizeof(*sbi
) + size
, GFP_KERNEL
);
403 if (unlikely(!sbi
)) {
407 memset(&sbi
->s_ods
[1], 0, size
- sizeof(sbi
->s_ods
[0]));
411 for (i
= 0; i
< numdevs
; i
++) {
412 struct exofs_fscb fscb
;
413 struct osd_dev_info odi
;
416 if (exofs_devs_2_odi(&dt
->dt_dev_table
[i
], &odi
)) {
417 EXOFS_ERR("ERROR: Read all-zeros device entry\n");
422 printk(KERN_NOTICE
"Add device[%d]: osd_name-%s\n",
425 /* On all devices the device table is identical. The user can
426 * specify any one of the participating devices on the command
427 * line. We always keep them in device-table order.
429 if (fscb_od
&& osduld_device_same(fscb_od
, &odi
)) {
430 sbi
->s_ods
[i
] = fscb_od
;
436 od
= osduld_info_lookup(&odi
);
437 if (unlikely(IS_ERR(od
))) {
439 EXOFS_ERR("ERROR: device requested is not found "
440 "osd_name-%s =>%d\n", odi
.osdname
, ret
);
447 /* Read the fscb of the other devices to make sure the FS
448 * partition is there.
450 ret
= exofs_read_kern(od
, sbi
->s_cred
, &obj
, 0, &fscb
,
453 EXOFS_ERR("ERROR: Malformed participating device "
454 "error reading fscb osd_name-%s\n",
459 /* TODO: verify other information is correct and FS-uuid
460 * matches. Benny what did you say about device table
461 * generation and old devices?
467 if (unlikely(!ret
&& fscb_od
)) {
469 "ERROR: Bad device-table container device not present\n");
470 osduld_put_device(fscb_od
);
478 * Read the superblock from the OSD and fill in the fields
480 static int exofs_fill_super(struct super_block
*sb
, void *data
, int silent
)
483 struct exofs_mountopt
*opts
= data
;
484 struct exofs_sb_info
*sbi
; /*extended info */
485 struct osd_dev
*od
; /* Master device */
486 struct exofs_fscb fscb
; /*on-disk superblock info */
487 struct osd_obj_id obj
;
488 unsigned table_count
;
491 sbi
= kzalloc(sizeof(*sbi
), GFP_KERNEL
);
495 /* use mount options to fill superblock */
496 od
= osduld_path_lookup(opts
->dev_name
);
504 sbi
->s_pid
= opts
->pid
;
505 sbi
->s_timeout
= opts
->timeout
;
507 /* fill in some other data by hand */
508 memset(sb
->s_id
, 0, sizeof(sb
->s_id
));
509 strcpy(sb
->s_id
, "exofs");
510 sb
->s_blocksize
= EXOFS_BLKSIZE
;
511 sb
->s_blocksize_bits
= EXOFS_BLKSHIFT
;
512 sb
->s_maxbytes
= MAX_LFS_FILESIZE
;
513 atomic_set(&sbi
->s_curr_pending
, 0);
517 obj
.partition
= sbi
->s_pid
;
518 obj
.id
= EXOFS_SUPER_ID
;
519 exofs_make_credential(sbi
->s_cred
, &obj
);
521 ret
= exofs_read_kern(od
, sbi
->s_cred
, &obj
, 0, &fscb
, sizeof(fscb
));
525 sb
->s_magic
= le16_to_cpu(fscb
.s_magic
);
526 sbi
->s_nextid
= le64_to_cpu(fscb
.s_nextid
);
527 sbi
->s_numfiles
= le32_to_cpu(fscb
.s_numfiles
);
529 /* make sure what we read from the object store is correct */
530 if (sb
->s_magic
!= EXOFS_SUPER_MAGIC
) {
532 EXOFS_ERR("ERROR: Bad magic value\n");
536 if (le32_to_cpu(fscb
.s_version
) != EXOFS_FSCB_VER
) {
537 EXOFS_ERR("ERROR: Bad FSCB version expected-%d got-%d\n",
538 EXOFS_FSCB_VER
, le32_to_cpu(fscb
.s_version
));
543 /* start generation numbers from a random point */
544 get_random_bytes(&sbi
->s_next_generation
, sizeof(u32
));
545 spin_lock_init(&sbi
->s_next_gen_lock
);
547 table_count
= le64_to_cpu(fscb
.s_dev_table_count
);
549 ret
= exofs_read_lookup_dev_table(&sbi
, table_count
);
554 /* set up operation vectors */
556 sb
->s_op
= &exofs_sops
;
557 sb
->s_export_op
= &exofs_export_ops
;
558 root
= exofs_iget(sb
, EXOFS_ROOT_ID
- EXOFS_OBJ_OFF
);
560 EXOFS_ERR("ERROR: exofs_iget failed\n");
564 sb
->s_root
= d_alloc_root(root
);
567 EXOFS_ERR("ERROR: get root inode failed\n");
572 if (!S_ISDIR(root
->i_mode
)) {
575 EXOFS_ERR("ERROR: corrupt root inode (mode = %hd)\n",
581 _exofs_print_device("Mounting", opts
->dev_name
, sbi
->s_ods
[0],
586 EXOFS_ERR("Unable to mount exofs on %s pid=0x%llx err=%d\n",
587 opts
->dev_name
, sbi
->s_pid
, ret
);
593 * Set up the superblock (calls exofs_fill_super eventually)
595 static int exofs_get_sb(struct file_system_type
*type
,
596 int flags
, const char *dev_name
,
597 void *data
, struct vfsmount
*mnt
)
599 struct exofs_mountopt opts
;
602 ret
= parse_options(data
, &opts
);
606 opts
.dev_name
= dev_name
;
607 return get_sb_nodev(type
, flags
, &opts
, exofs_fill_super
, mnt
);
611 * Return information about the file system state in the buffer. This is used
612 * by the 'df' command, for example.
614 static int exofs_statfs(struct dentry
*dentry
, struct kstatfs
*buf
)
616 struct super_block
*sb
= dentry
->d_sb
;
617 struct exofs_sb_info
*sbi
= sb
->s_fs_info
;
618 struct exofs_io_state
*ios
;
619 struct osd_attr attrs
[] = {
620 ATTR_DEF(OSD_APAGE_PARTITION_QUOTAS
,
621 OSD_ATTR_PQ_CAPACITY_QUOTA
, sizeof(__be64
)),
622 ATTR_DEF(OSD_APAGE_PARTITION_INFORMATION
,
623 OSD_ATTR_PI_USED_CAPACITY
, sizeof(__be64
)),
625 uint64_t capacity
= ULLONG_MAX
;
626 uint64_t used
= ULLONG_MAX
;
627 uint8_t cred_a
[OSD_CAP_LEN
];
630 ret
= exofs_get_io_state(sbi
, &ios
);
632 EXOFS_DBGMSG("exofs_get_io_state failed.\n");
636 exofs_make_credential(cred_a
, &ios
->obj
);
637 ios
->cred
= sbi
->s_cred
;
638 ios
->in_attr
= attrs
;
639 ios
->in_attr_len
= ARRAY_SIZE(attrs
);
641 ret
= exofs_sbi_read(ios
);
645 ret
= extract_attr_from_ios(ios
, &attrs
[0]);
647 capacity
= get_unaligned_be64(attrs
[0].val_ptr
);
648 if (unlikely(!capacity
))
649 capacity
= ULLONG_MAX
;
651 EXOFS_DBGMSG("exofs_statfs: get capacity failed.\n");
653 ret
= extract_attr_from_ios(ios
, &attrs
[1]);
655 used
= get_unaligned_be64(attrs
[1].val_ptr
);
657 EXOFS_DBGMSG("exofs_statfs: get used-space failed.\n");
659 /* fill in the stats buffer */
660 buf
->f_type
= EXOFS_SUPER_MAGIC
;
661 buf
->f_bsize
= EXOFS_BLKSIZE
;
662 buf
->f_blocks
= capacity
>> 9;
663 buf
->f_bfree
= (capacity
- used
) >> 9;
664 buf
->f_bavail
= buf
->f_bfree
;
665 buf
->f_files
= sbi
->s_numfiles
;
666 buf
->f_ffree
= EXOFS_MAX_ID
- sbi
->s_numfiles
;
667 buf
->f_namelen
= EXOFS_NAME_LEN
;
670 exofs_put_io_state(ios
);
674 static const struct super_operations exofs_sops
= {
675 .alloc_inode
= exofs_alloc_inode
,
676 .destroy_inode
= exofs_destroy_inode
,
677 .write_inode
= exofs_write_inode
,
678 .delete_inode
= exofs_delete_inode
,
679 .put_super
= exofs_put_super
,
680 .write_super
= exofs_write_super
,
681 .sync_fs
= exofs_sync_fs
,
682 .statfs
= exofs_statfs
,
685 /******************************************************************************
687 *****************************************************************************/
689 struct dentry
*exofs_get_parent(struct dentry
*child
)
691 unsigned long ino
= exofs_parent_ino(child
);
696 return d_obtain_alias(exofs_iget(child
->d_inode
->i_sb
, ino
));
699 static struct inode
*exofs_nfs_get_inode(struct super_block
*sb
,
700 u64 ino
, u32 generation
)
704 inode
= exofs_iget(sb
, ino
);
706 return ERR_CAST(inode
);
707 if (generation
&& inode
->i_generation
!= generation
) {
708 /* we didn't find the right inode.. */
710 return ERR_PTR(-ESTALE
);
715 static struct dentry
*exofs_fh_to_dentry(struct super_block
*sb
,
716 struct fid
*fid
, int fh_len
, int fh_type
)
718 return generic_fh_to_dentry(sb
, fid
, fh_len
, fh_type
,
719 exofs_nfs_get_inode
);
722 static struct dentry
*exofs_fh_to_parent(struct super_block
*sb
,
723 struct fid
*fid
, int fh_len
, int fh_type
)
725 return generic_fh_to_parent(sb
, fid
, fh_len
, fh_type
,
726 exofs_nfs_get_inode
);
729 static const struct export_operations exofs_export_ops
= {
730 .fh_to_dentry
= exofs_fh_to_dentry
,
731 .fh_to_parent
= exofs_fh_to_parent
,
732 .get_parent
= exofs_get_parent
,
735 /******************************************************************************
737 *****************************************************************************/
740 * struct that describes this file system
742 static struct file_system_type exofs_type
= {
743 .owner
= THIS_MODULE
,
745 .get_sb
= exofs_get_sb
,
746 .kill_sb
= generic_shutdown_super
,
749 static int __init
init_exofs(void)
753 err
= init_inodecache();
757 err
= register_filesystem(&exofs_type
);
763 destroy_inodecache();
768 static void __exit
exit_exofs(void)
770 unregister_filesystem(&exofs_type
);
771 destroy_inodecache();
774 MODULE_AUTHOR("Avishay Traeger <avishay@gmail.com>");
775 MODULE_DESCRIPTION("exofs");
776 MODULE_LICENSE("GPL");
778 module_init(init_exofs
)
779 module_exit(exit_exofs
)