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, "cache")) {
84 SMFS_SET(*flags, SMFS_PLG_LRU);
85 } else if (!strcmp(pos, "snap")) {
86 SMFS_SET(*flags, SMFS_PLG_COW);
88 /* So it is wrong or backfs option,
100 //save dev & type for further use
102 *devstr = strcpy(ret + strlen(ret) + 1, *devstr);
104 *namestr = strcpy(*devstr + strlen(*devstr) + 1, *namestr);
106 OBD_FREE(temp, strlen(data) + 1);
111 static struct smfs_super_info *smfs_init_smb(struct super_block *sb)
113 struct smfs_super_info *smb;
116 OBD_ALLOC(smb, sizeof(*smb));
121 INIT_LIST_HEAD(&smb->smsi_plg_list);
126 static void smfs_cleanup_smb(struct smfs_super_info *smb)
131 OBD_FREE(smb, sizeof(*smb));
135 static int smfs_init_fsfilt_ops(struct smfs_super_info *smb)
138 if (!smb->sm_cache_fsfilt) {
139 smb->sm_cache_fsfilt =
140 fsfilt_get_ops(smb->smsi_cache_ftype);
141 if (!smb->sm_cache_fsfilt) {
142 CERROR("Can not get %s fsfilt ops needed by smfs\n",
143 smb->smsi_cache_ftype);
147 if (!smb->sm_fsfilt) {
149 fsfilt_get_ops(smb->smsi_ftype);
150 if (!smb->sm_fsfilt) {
151 CERROR("Can not get %s fsfilt ops needed by smfs\n",
159 void smfs_cleanup_fsfilt_ops(struct smfs_super_info *smb)
161 if (smb->sm_cache_fsfilt)
162 fsfilt_put_ops(smb->sm_cache_fsfilt);
164 fsfilt_put_ops(smb->sm_fsfilt);
167 static void smfs_filter_flags(struct filter_obd * filt, struct inode * o_dir)
169 struct dentry * dentry = NULL;
172 CDEBUG(D_SUPER,"OST OBD post_setup\n");
173 /* enable plugins for all in O */
174 SMFS_SET(I2SMI(o_dir)->smi_flags, SMFS_PLG_ALL);
175 /* enable plugins for all already created d<n> dirs */
176 for (j = 1; j < filt->fo_group_count; j++) {
177 for (i = 0; i < filt->fo_subdir_count; i++) {
178 dentry = (filt->fo_subdirs + j)->dentry[i];
179 SMFS_SET(I2SMI(dentry->d_inode)->smi_flags,
185 static void smfs_mds_flags(struct mds_obd * mds, struct inode * root)
187 struct inode * pend = mds->mds_pending_dir->d_inode;
189 CDEBUG(D_SUPER,"MDS OBD post_setup\n");
190 /* enable plugins for all in ROOT */
191 SMFS_SET(I2SMI(root)->smi_flags, SMFS_PLG_ALL);
192 /* the same for PENDING */
193 SMFS_SET(I2SMI(pend)->smi_flags, SMFS_PLG_ALL);
197 int smfs_post_setup(struct obd_device *obd, struct vfsmount *mnt,
198 struct dentry * root_dentry)
200 struct lvfs_run_ctxt saved, *current_ctxt = NULL;
201 struct smfs_super_info *smb = S2SMI(mnt->mnt_sb);
206 OBD_ALLOC(current_ctxt, sizeof(*current_ctxt));
210 OBD_SET_CTXT_MAGIC(current_ctxt);
212 current_ctxt->pwdmnt = mnt;
213 current_ctxt->pwd = mnt->mnt_root;
214 current_ctxt->fs = get_ds();
215 smb->smsi_ctxt = current_ctxt;
217 push_ctxt(&saved, smb->smsi_ctxt, NULL);
219 rc = smfs_llog_setup(smb);
221 rc = SMFS_PLG_HELP(mnt->mnt_sb, PLG_START, NULL);
224 pop_ctxt(&saved, smb->smsi_ctxt, NULL);
226 /* connect KML ctxt to obd */
227 if (obd && smb->smsi_kml_log) {
228 smb->smsi_kml_log->loc_idx = LLOG_REINT_ORIG_CTXT;
229 smb->smsi_kml_log->loc_obd = obd;
230 obd->obd_llog_ctxt[LLOG_REINT_ORIG_CTXT] = smb->smsi_kml_log;
233 /* enable plugins for directories on MDS or OST */
234 if (obd && obd->obd_type && obd->obd_type->typ_name) {
235 if (!strcmp(obd->obd_type->typ_name, "obdfilter")) {
236 struct filter_obd *filt = &obd->u.filter;
238 smfs_filter_flags(filt, root_dentry->d_inode);
240 else if (!strcmp(obd->obd_type->typ_name, "mds")) {
241 struct mds_obd * mds = &obd->u.mds;
243 smfs_mds_flags(mds, root_dentry->d_inode);
246 CDEBUG(D_SUPER,"Unknown OBD (%s) post_setup\n",
247 obd->obd_type->typ_name);
251 OBD_FREE(current_ctxt, sizeof(*current_ctxt));
256 void smfs_post_cleanup(struct super_block *sb)
258 struct smfs_super_info *smb = S2SMI(sb);
262 smfs_llog_cleanup(smb);
263 SMFS_PLG_HELP(sb, PLG_STOP, NULL);
266 OBD_FREE(smb->smsi_ctxt, sizeof(struct lvfs_run_ctxt));
271 static int smfs_mount_cache(struct smfs_super_info *smb, char *devstr,
272 char *typestr, char *opts)
274 int err = 0, typelen;
275 struct vfsmount *mnt;
278 typelen = strlen(typestr);
280 CDEBUG(D_INODE, "smfs: mounting %s at %s\n", typestr, devstr);
281 mnt = do_kern_mount(typestr, 0, devstr, (void *)opts);
283 CERROR("do_kern_mount failed: rc = %ld\n",
285 GOTO(err_out, err = PTR_ERR(mnt));
288 smb->smsi_sb = mnt->mnt_sb;
291 smfs_init_sm_ops(smb);
293 OBD_ALLOC(smb->smsi_cache_ftype, strlen(typestr) + 1);
294 memcpy(smb->smsi_cache_ftype, typestr, strlen(typestr));
296 OBD_ALLOC(smb->smsi_ftype, strlen(SMFS_TYPE) + 1);
297 memcpy(smb->smsi_ftype, SMFS_TYPE, strlen(SMFS_TYPE));
299 err = smfs_init_fsfilt_ops(smb);
304 static int smfs_umount_cache(struct smfs_super_info *smb)
306 mntput(smb->smsi_mnt);
307 smfs_cleanup_sm_ops(smb);
308 smfs_cleanup_fsfilt_ops(smb);
310 if (smb->smsi_cache_ftype)
311 OBD_FREE(smb->smsi_cache_ftype,
312 strlen(smb->smsi_cache_ftype) + 1);
314 OBD_FREE(smb->smsi_ftype, strlen(smb->smsi_ftype) + 1);
319 /* This function initializes plugins in SMFS
320 * @flags: are filled while options parsing
321 * @sb: smfs super block
324 static int smfs_init_plugins(struct super_block * sb, int flags)
326 struct smfs_super_info * smb = S2SMI(sb);
330 INIT_LIST_HEAD(&smb->smsi_plg_list);
331 init_rwsem(&smb->plg_sem);
333 if (SMFS_IS(flags, SMFS_PLG_KML))
335 if (SMFS_IS(flags, SMFS_PLG_LRU))
338 if (SMFS_IS(flags, SMFS_PLG_COW))
344 static void smfs_remove_plugins(struct super_block *sb)
348 SMFS_PLG_HELP(sb, PLG_EXIT, (void*)sb);
353 void smfs_put_super(struct super_block *sb)
355 struct smfs_super_info *smb = S2SMI(sb);
357 smfs_remove_plugins(sb);
362 smfs_umount_cache(smb);
364 smfs_cleanup_smb(smb);
368 int smfs_fill_super(struct super_block *sb, void *data, int silent)
370 struct inode *root_inode = NULL;
371 struct inode *back_root_inode = NULL;
372 struct smfs_super_info *smb = NULL;
373 char *devstr = NULL, *typestr = NULL;
381 CERROR("no mount options. At least name and dev are needed\n");
386 CDEBUG(D_SUPER, "mount opts: %s\n", (char *)data);
388 smb = smfs_init_smb(sb);
392 OBD_ALLOC(opts, strlen(data) + 1);
398 err = smfs_options(data, &devstr, &typestr, opts, &flags);
402 if (!typestr || !devstr) {
403 CERROR("mount options name and dev are mandatory\n");
408 CDEBUG(D_SUPER, "backfs mount opts: %s\n", opts);
410 err = smfs_mount_cache(smb, devstr, typestr, opts);
412 CERROR("Can not mount %s as %s\n", devstr, typestr);
416 OBD_FREE(opts, strlen(data) + 1);
419 duplicate_sb(sb, smb->smsi_sb);
420 sb->s_bdev = smb->smsi_sb->s_bdev;
421 sm_set_sb_ops(smb->smsi_sb, sb);
423 /* init the root_inode of smfs. */
424 back_root_inode = S2CSB(sb)->s_root->d_inode;
425 root_inode = smfs_get_inode(sb, back_root_inode, NULL, 0);
427 CDEBUG(D_SUPER, "readinode %p, root ino %ld, root inode at %p\n",
428 sb->s_op->read_inode, root_inode->i_ino, root_inode);
430 sb->s_root = d_alloc_root(root_inode);
436 /* all entries created until post_setup() should not be logged */
437 SMFS_CLEAR((I2SMI(root_inode))->smi_flags, SMFS_PLG_ALL);
439 #if (LINUX_VERSION_CODE < KERNEL_VERSION(2,5,0))
440 CDEBUG(D_SUPER, "sb %lx, &sb->u.generic_sbp: %lx\n",
441 (ulong)sb, (ulong)&sb->u.generic_sbp);
443 CDEBUG(D_SUPER, "sb %lx(%p), &sb->s_fs_info: %lx\n",
444 (ulong)sb, smb->smsi_sb, (ulong)&sb->s_fs_info);
447 smfs_init_plugins(sb, flags);
452 smfs_umount_cache(smb);
455 OBD_FREE(opts, strlen(data) + 1);
457 smfs_cleanup_smb(smb);
462 void *smfs_trans_start(struct inode *inode, int op, void *desc_private)
464 struct fsfilt_operations *fsfilt = S2SMI(inode->i_sb)->sm_fsfilt;
466 if (fsfilt->fs_start)
467 return fsfilt->fs_start(inode, op, NULL, 0);
471 void smfs_trans_commit(struct inode *inode, void *handle, int force_sync)
473 struct fsfilt_operations *fsfilt = S2SMI(inode->i_sb)->sm_fsfilt;
475 if (handle && fsfilt->fs_commit)
476 fsfilt->fs_commit(inode->i_sb, inode, handle, force_sync);
479 int smfs_register_plugin(struct super_block * sb,
480 struct smfs_plugin * plg)
482 struct smfs_plugin * tmp = NULL;
483 struct smfs_super_info * smb = S2SMI(sb);
484 struct list_head * plist = &smb->smsi_plg_list;
489 down_write(&smb->plg_sem);
490 list_for_each_entry(tmp, plist, plg_list) {
491 if (tmp->plg_type == plg->plg_type) {
492 CWARN("Plugin is already registered\n");
498 list_add_tail(&plg->plg_list, plist);
500 up_write(&smb->plg_sem);
504 struct smfs_plugin * smfs_deregister_plugin(struct super_block *sb, int type)
506 struct smfs_plugin * plg = NULL;
507 struct smfs_super_info *smb = S2SMI(sb);
508 struct list_head * plist = &smb->smsi_plg_list;
511 down_write(&smb->plg_sem);
512 list_for_each_entry(plg, plist, plg_list) {
513 if (plg->plg_type == type) {
514 list_del(&plg->plg_list);
518 up_write(&smb->plg_sem);
522 void smfs_pre_hook (struct inode * inode, int op, void * msg)
524 struct smfs_super_info *smb = S2SMI(inode->i_sb);
525 struct smfs_inode_info *smi = I2SMI(inode);
526 struct list_head *hlist = &smb->smsi_plg_list;
527 struct smfs_plugin *plg;
530 LASSERT(op < HOOK_MAX);
531 //call hook operations
532 down_read(&smb->plg_sem);
533 list_for_each_entry(plg, hlist, plg_list) {
534 //check that plugin is active
535 if(!SMFS_IS(smb->plg_flags, plg->plg_type))
537 //check that inode is allowed
538 if (!SMFS_IS(smi->smi_flags, plg->plg_type))
542 plg->plg_pre_op(op, inode, msg, 0, plg->plg_private);
544 up_read(&smb->plg_sem);
548 void smfs_post_hook (struct inode * inode, int op, void * msg, int ret)
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 down_read(&smb->plg_sem);
557 list_for_each_entry(plg, hlist, plg_list) {
558 //check that plugin is active
559 if(!SMFS_IS(smb->plg_flags, plg->plg_type))
561 //check that inode is allowed
562 if (!SMFS_IS(smi->smi_flags, plg->plg_type))
565 if (plg->plg_post_op)
566 plg->plg_post_op(op, inode, msg, ret, plg->plg_private);
568 up_read(&smb->plg_sem);
572 int smfs_helper (struct super_block * sb, int op, void * msg)
574 struct smfs_super_info *smb = S2SMI(sb);
575 struct list_head *hlist = &smb->smsi_plg_list;
576 struct smfs_plugin *plg, *tmp;
580 LASSERT(op < PLG_HELPER_MAX);
581 //call hook operations
582 down_read(&smb->plg_sem);
583 list_for_each_entry_safe(plg, tmp, hlist, plg_list) {
584 //check that plugin is active
585 if(!SMFS_IS(smb->plg_flags, plg->plg_type) && (op != PLG_START))
589 rc += plg->plg_helper(op, sb, msg, plg->plg_private);
591 up_read(&smb->plg_sem);