1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2 * vim:expandtab:shiftwidth=8:tabstop=8:
5 * Lustre filesystem abstraction routines
7 * Copyright (C) 2004 Cluster File Systems, Inc.
9 * This file is part of Lustre, http://www.lustre.org.
11 * Lustre is free software; you can redistribute it and/or
12 * modify it under the terms of version 2 of the GNU General Public
13 * License as published by the Free Software Foundation.
15 * Lustre is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with Lustre; if not, write to the Free Software
22 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
25 #define DEBUG_SUBSYSTEM S_SM
27 #include <linux/config.h>
28 #include <linux/module.h>
29 #include <linux/kmod.h>
30 #include <linux/init.h>
32 #include <linux/string.h>
34 #include <linux/utime.h>
35 #include <linux/file.h>
36 #include <linux/slab.h>
37 #include <linux/dcache.h>
38 #include <linux/loop.h>
39 #include <linux/errno.h>
40 #include <linux/obd_class.h>
41 #include <linux/obd_support.h>
42 #include <linux/lustre_lib.h>
43 #include <linux/lustre_idl.h>
44 #include <linux/lustre_fsfilt.h>
45 #include <linux/lustre_smfs.h>
46 #include "smfs_internal.h"
48 int smfs_options(char *data, char **devstr, char **namestr,
49 char *ret, int *flags)
52 char * pos = NULL, *next = NULL;
57 //allocate temporary buffer
58 OBD_ALLOC(temp, strlen(data) + 1);
60 CERROR("Can not allocate memory for options\n");
64 memcpy(temp, data, strlen(data));
68 next = strchr(pos, ',');
74 //now pos points to one-options string
75 if (!strncmp(pos, "dev=", 4)) {
78 } else if (!strncmp(pos, "type=", 5)) {
81 } else if (!strcmp(pos, "kml")) {
82 SMFS_SET(*flags, SMFS_PLG_KML);
83 } else if (!strcmp(pos, "audit")) {
84 SMFS_SET(*flags, SMFS_PLG_AUDIT);
85 } else if (!strcmp(pos, "cache")) {
86 SMFS_SET(*flags, SMFS_PLG_LRU);
87 } else if (!strcmp(pos, "snap")) {
88 SMFS_SET(*flags, SMFS_PLG_COW);
90 /* So it is wrong or backfs option,
102 //save dev & type for further use
104 *devstr = strcpy(ret + strlen(ret) + 1, *devstr);
106 *namestr = strcpy(*devstr + strlen(*devstr) + 1, *namestr);
108 OBD_FREE(temp, strlen(data) + 1);
113 static struct smfs_super_info *smfs_init_smb(struct super_block *sb)
115 struct smfs_super_info *smb;
118 OBD_ALLOC(smb, sizeof(*smb));
123 INIT_LIST_HEAD(&smb->smsi_plg_list);
128 static void smfs_cleanup_smb(struct smfs_super_info *smb)
133 OBD_FREE(smb, sizeof(*smb));
137 static int smfs_init_fsfilt_ops(struct smfs_super_info *smb)
140 if (!smb->sm_cache_fsfilt) {
141 smb->sm_cache_fsfilt =
142 fsfilt_get_ops(smb->smsi_cache_ftype);
143 if (!smb->sm_cache_fsfilt) {
144 CERROR("Can not get %s fsfilt ops needed by smfs\n",
145 smb->smsi_cache_ftype);
149 if (!smb->sm_fsfilt) {
151 fsfilt_get_ops(smb->smsi_ftype);
152 if (!smb->sm_fsfilt) {
153 CERROR("Can not get %s fsfilt ops needed by smfs\n",
161 void smfs_cleanup_fsfilt_ops(struct smfs_super_info *smb)
163 if (smb->sm_cache_fsfilt)
164 fsfilt_put_ops(smb->sm_cache_fsfilt);
166 fsfilt_put_ops(smb->sm_fsfilt);
169 static void smfs_filter_flags(struct filter_obd *filt, struct inode *o_dir)
171 struct dentry * dentry = NULL;
174 CDEBUG(D_SUPER,"OST OBD post_setup\n");
176 /* enable plugins for all in O */
177 /* SMFS_SET(I2SMI(o_dir)->smi_flags, SMFS_PLG_ALL); */
179 /* enable plugins for all already created d<n> dirs */
180 for (j = 1; j < filt->fo_group_count; j++) {
181 for (i = 0; i < filt->fo_subdir_count; i++) {
182 dentry = (filt->fo_subdirs + j)->dentry[i];
183 SMFS_SET(I2SMI(dentry->d_inode)->smi_flags,
189 static void smfs_mds_flags(struct mds_obd *mds, struct inode *root)
191 CDEBUG(D_SUPER,"MDS OBD post_setup\n");
193 /* enable plugins for all in ROOT */
194 SMFS_SET(I2SMI(root)->smi_flags, SMFS_PLG_ALL);
197 extern int (*audit_id2name_superhack) (struct obd_device *obd, char **name,
198 int *namelen, struct lustre_id *id);
200 int smfs_post_setup(struct obd_device *obd, struct vfsmount *mnt,
201 struct dentry *root_dentry)
203 struct lvfs_run_ctxt saved, *current_ctxt = NULL;
204 struct smfs_super_info *smb = S2SMI(mnt->mnt_sb);
208 /* XXX to register id2name function of mds in smfs */
210 // audit_id2name_superhack = data;
212 OBD_ALLOC(current_ctxt, sizeof(*current_ctxt));
216 OBD_SET_CTXT_MAGIC(current_ctxt);
218 current_ctxt->pwdmnt = mnt;
219 current_ctxt->pwd = mnt->mnt_root;
220 current_ctxt->fs = get_ds();
221 smb->smsi_ctxt = current_ctxt;
223 push_ctxt(&saved, smb->smsi_ctxt, NULL);
225 rc = smfs_llog_setup(&smb->smsi_logs_dir, &smb->smsi_objects_dir);
227 rc = SMFS_PLG_HELP(mnt->mnt_sb, PLG_START, obd);
229 pop_ctxt(&saved, smb->smsi_ctxt, NULL);
231 /* enable plugins for directories on MDS or OST */
232 if (obd && obd->obd_type && obd->obd_type->typ_name) {
233 if (!strcmp(obd->obd_type->typ_name, OBD_FILTER_DEVICENAME)) {
234 struct filter_obd *filt = &obd->u.filter;
235 smfs_filter_flags(filt, root_dentry->d_inode);
236 } else if (!strcmp(obd->obd_type->typ_name, OBD_MDS_DEVICENAME)) {
237 struct mds_obd * mds = &obd->u.mds;
238 smfs_mds_flags(mds, root_dentry->d_inode);
239 SMFS_SET_HND_IBLOCKS(smb);
241 CDEBUG(D_SUPER,"Unknown OBD (%s) post_setup\n",
242 obd->obd_type->typ_name);
247 OBD_FREE(current_ctxt, sizeof(*current_ctxt));
252 void smfs_post_cleanup(struct super_block *sb)
254 struct smfs_super_info *smb = S2SMI(sb);
258 smfs_llog_cleanup(smb);
259 SMFS_PLG_HELP(sb, PLG_STOP, NULL);
262 OBD_FREE(smb->smsi_ctxt, sizeof(struct lvfs_run_ctxt));
267 static int smfs_mount_cache(struct smfs_super_info *smb, char *devstr,
268 char *typestr, char *opts)
270 int err = 0, typelen;
271 struct vfsmount *mnt;
274 typelen = strlen(typestr);
276 CDEBUG(D_INODE, "smfs: mounting %s at %s\n", typestr, devstr);
278 mnt = do_kern_mount(typestr, 0, devstr, (void *)opts);
280 CERROR("do_kern_mount failed: rc = %d\n",
282 RETURN(PTR_ERR(mnt));
285 smb->smsi_sb = mnt->mnt_sb;
288 smfs_init_sm_ops(smb);
290 OBD_ALLOC(smb->smsi_cache_ftype, strlen(typestr) + 1);
291 if (!smb->smsi_cache_ftype)
292 GOTO(err_umount_cache, err = -ENOMEM);
294 memcpy(smb->smsi_cache_ftype, typestr, strlen(typestr));
296 OBD_ALLOC(smb->smsi_ftype, strlen(SMFS_TYPE) + 1);
297 if (!smb->smsi_ftype)
298 GOTO(err_free_cache_fstype, err = -ENOMEM);
300 memcpy(smb->smsi_ftype, SMFS_TYPE, strlen(SMFS_TYPE));
302 err = smfs_init_fsfilt_ops(smb);
304 err_free_cache_fstype:
305 OBD_FREE(smb->smsi_cache_ftype, strlen(typestr) + 1);
311 static int smfs_umount_cache(struct smfs_super_info *smb)
315 mntput(smb->smsi_mnt);
316 smfs_cleanup_sm_ops(smb);
317 smfs_cleanup_fsfilt_ops(smb);
319 if (smb->smsi_cache_ftype) {
320 OBD_FREE(smb->smsi_cache_ftype,
321 strlen(smb->smsi_cache_ftype) + 1);
322 smb->smsi_cache_ftype = NULL;
324 if (smb->smsi_ftype) {
325 OBD_FREE(smb->smsi_ftype,
326 strlen(smb->smsi_ftype) + 1);
327 smb->smsi_ftype = NULL;
333 /* This function initializes plugins in SMFS
334 * @flags: are filled while options parsing
335 * @sb: smfs super block
337 static int smfs_init_plugins(struct super_block * sb, int flags)
339 struct smfs_super_info * smb = S2SMI(sb);
343 INIT_LIST_HEAD(&smb->smsi_plg_list);
344 init_rwsem(&smb->plg_sem);
346 if (SMFS_IS(flags, SMFS_PLG_AUDIT))
348 if (SMFS_IS(flags, SMFS_PLG_KML))
350 if (SMFS_IS(flags, SMFS_PLG_LRU))
353 if (SMFS_IS(flags, SMFS_PLG_COW))
359 static void smfs_remove_plugins(struct super_block *sb)
361 struct smfs_plugin * plg, *tmp;
362 struct smfs_super_info *smb = S2SMI(sb);
363 struct list_head * plist = &smb->smsi_plg_list;
367 list_for_each_entry_safe(plg, tmp, plist, plg_list) {
368 plg->plg_exit(sb, plg->plg_private);
374 void smfs_put_super(struct super_block *sb)
376 struct smfs_super_info *smb = S2SMI(sb);
378 smfs_remove_plugins(sb);
383 smfs_umount_cache(smb);
385 smfs_cleanup_smb(smb);
389 int smfs_fill_super(struct super_block *sb, void *data, int silent)
391 struct inode *root_inode = NULL;
392 struct inode *back_root_inode = NULL;
393 struct smfs_super_info *smb = NULL;
394 char *devstr = NULL, *typestr = NULL;
395 unsigned long page = 0;
403 CERROR("no mount options. At least name and dev are needed\n");
408 CDEBUG(D_SUPER, "mount opts: %s\n", (char *)data);
410 smb = smfs_init_smb(sb);
416 /* 2.6.9 selinux wants a full option page for do_kern_mount (bug6471) */
417 page = get_zeroed_page(GFP_KERNEL);
424 err = smfs_options(data, &devstr, &typestr, opts, &flags);
428 if (!typestr || !devstr) {
429 CERROR("mount options name and dev are mandatory\n");
434 CDEBUG(D_SUPER, "backfs mount opts: %s\n", opts);
436 err = smfs_mount_cache(smb, devstr, typestr, opts);
438 CERROR("Can not mount %s as %s\n", devstr, typestr);
445 duplicate_sb(sb, smb->smsi_sb);
446 sb->s_bdev = smb->smsi_sb->s_bdev;
447 sm_set_sb_ops(smb->smsi_sb, sb);
449 /* init the root_inode of smfs. */
450 back_root_inode = S2CSB(sb)->s_root->d_inode;
451 root_inode = smfs_get_inode(sb, back_root_inode, NULL, 0);
453 CDEBUG(D_SUPER, "readinode %p, root ino %ld, root inode at %p\n",
454 sb->s_op->read_inode, root_inode->i_ino, root_inode);
456 sb->s_root = d_alloc_root(root_inode);
462 /* all entries created until post_setup() should not be logged */
463 SMFS_CLEAR((I2SMI(root_inode))->smi_flags, SMFS_PLG_ALL);
465 #if (LINUX_VERSION_CODE < KERNEL_VERSION(2,5,0))
466 CDEBUG(D_SUPER, "sb %lx, &sb->u.generic_sbp: %lx\n",
467 (ulong)sb, (ulong)&sb->u.generic_sbp);
469 CDEBUG(D_SUPER, "sb %lx(%p), &sb->s_fs_info: %lx\n",
470 (ulong)sb, smb->smsi_sb, (ulong)&sb->s_fs_info);
473 smfs_init_plugins(sb, flags);
478 smfs_umount_cache(smb);
483 smfs_cleanup_smb(smb);
488 void *smfs_trans_start(struct inode *inode, int op, void *desc_private)
490 struct fsfilt_operations *fsfilt = S2SMI(inode->i_sb)->sm_fsfilt;
492 if (fsfilt->fs_start)
493 return fsfilt->fs_start(inode, op, NULL, 0);
497 void smfs_trans_commit(struct inode *inode, void *handle, int force_sync)
499 struct fsfilt_operations *fsfilt = S2SMI(inode->i_sb)->sm_fsfilt;
501 if (handle && fsfilt->fs_commit)
502 fsfilt->fs_commit(inode->i_sb, inode, handle, force_sync);
505 int smfs_register_plugin(struct super_block * sb,
506 struct smfs_plugin * plg)
508 struct smfs_plugin * tmp = NULL;
509 struct smfs_super_info * smb = S2SMI(sb);
510 struct list_head * plist = &smb->smsi_plg_list;
515 down_write(&smb->plg_sem);
516 list_for_each_entry(tmp, plist, plg_list) {
517 if (tmp->plg_type == plg->plg_type) {
518 CWARN("Plugin is already registered\n");
524 list_add_tail(&plg->plg_list, plist);
526 up_write(&smb->plg_sem);
530 struct smfs_plugin * smfs_deregister_plugin(struct super_block *sb, int type)
532 struct smfs_plugin * plg = NULL;
533 struct smfs_super_info *smb = S2SMI(sb);
534 struct list_head * plist = &smb->smsi_plg_list;
537 down_write(&smb->plg_sem);
538 list_for_each_entry(plg, plist, plg_list) {
539 if (plg->plg_type == type) {
540 list_del(&plg->plg_list);
544 up_write(&smb->plg_sem);
548 void smfs_pre_hook (struct inode * inode, hook_op op, void * msg)
550 struct smfs_super_info *smb = S2SMI(inode->i_sb);
551 struct smfs_inode_info *smi = I2SMI(inode);
552 struct list_head *hlist = &smb->smsi_plg_list;
553 struct smfs_plugin *plg;
556 LASSERT(op < HOOK_MAX);
557 //call hook operations
558 down_read(&smb->plg_sem);
559 list_for_each_entry(plg, hlist, plg_list) {
560 //check that plugin is active
561 if(!SMFS_IS(smb->plg_flags, plg->plg_type))
563 //check that inode is allowed
564 if (!SMFS_IS(smi->smi_flags, plg->plg_type))
568 plg->plg_pre_op(op, inode, msg, 0, plg->plg_private);
570 up_read(&smb->plg_sem);
574 void smfs_post_hook (struct inode * inode, hook_op op, void * msg, int ret)
576 struct smfs_super_info *smb = S2SMI(inode->i_sb);
577 //struct smfs_inode_info *smi = I2SMI(inode);
578 struct list_head *hlist = &smb->smsi_plg_list;
579 struct smfs_plugin *plg;
582 down_read(&smb->plg_sem);
583 list_for_each_entry(plg, hlist, plg_list) {
584 //check that plugin is active
585 if(!SMFS_IS(smb->plg_flags, plg->plg_type))
587 /* this will be checked inside plg_post_op()
588 if (!SMFS_IS(smi->smi_flags, plg->plg_type))
591 if (plg->plg_post_op)
592 plg->plg_post_op(op, inode, msg, ret, plg->plg_private);
594 up_read(&smb->plg_sem);
598 int smfs_helper (struct super_block * sb, int op, void * msg)
600 struct smfs_super_info *smb = S2SMI(sb);
601 struct list_head *hlist = &smb->smsi_plg_list;
602 struct smfs_plugin *plg, *tmp;
606 LASSERT(op < PLG_HELPER_MAX);
607 //call hook operations
608 down_read(&smb->plg_sem);
609 list_for_each_entry_safe(plg, tmp, hlist, plg_list) {
610 //check that plugin is active
611 if(!SMFS_IS(smb->plg_flags, plg->plg_type) &&
612 !(op == PLG_START || op == PLG_EXIT))
616 rc += plg->plg_helper(op, sb, msg, plg->plg_private);
618 up_read(&smb->plg_sem);
624 void * smfs_get_plg_priv(struct smfs_super_info * smb, int type)
626 struct list_head *hlist = &smb->smsi_plg_list;
627 struct smfs_plugin *plg, *tmp;
629 list_for_each_entry_safe(plg, tmp, hlist, plg_list) {
630 if (plg->plg_type == type) {
631 return (plg->plg_private);