lustre/smfs/smfs_lib.c

   1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
   2  * vim:expandtab:shiftwidth=8:tabstop=8:
   3  *
   4  *  lustre/smfs/super.c
   5  *  Lustre filesystem abstraction routines
   6  *
   7  *  Copyright (C) 2004 Cluster File Systems, Inc.
   8  *
   9  *   This file is part of Lustre, http://www.lustre.org.
  10  *
  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.
  14  *
  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.
  19  *
  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.
  23  */
  24
  25 #define DEBUG_SUBSYSTEM S_SM
  26
  27 #include <linux/config.h>
  28 #include <linux/module.h>
  29 #include <linux/kmod.h>
  30 #include <linux/init.h>
  31 #include <linux/fs.h>
  32 #include <linux/string.h>
  33 #include <linux/mm.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"
  47
  48 static char *smfs_options(char *data, char **devstr, char **namestr,
  49                           char *opts, int *flags)
  50 {
  51         struct option *opt_value = NULL;
  52         char   *pos;
  53
  54         LASSERT(opts && flags);
  55
  56         while (!(get_opt(&opt_value, &pos))) {
  57                 if (!strcmp(opt_value->opt, "dev")) {
  58                         if (devstr != NULL)
  59                                 *devstr = opt_value->value;
  60                 } else if (!strcmp(opt_value->opt, "type")) {
  61                         if (namestr != NULL)
  62                                 *namestr = opt_value->value;
  63                 } else if (!strcmp(opt_value->opt, "kml")) {
  64                         *flags |= SM_DO_REC;
  65                 } else if (!strcmp(opt_value->opt, "cache")) {
  66                         *flags |= SM_CACHE_HOOK;
  67                 } else if (!strcmp(opt_value->opt, "snap")) {
  68                         *flags |= SM_DO_COW;
  69                 } else if (!strcmp(opt_value->opt, "options")) {
  70                         if (strlen(opts) == 0)
  71                                 sprintf((char *)opts + strlen(opts), "%s",
  72                                         opt_value->value);
  73                         else
  74                                 sprintf((char *)opts + strlen(opts), ",%s",
  75                                         opt_value->value);
  76                 } else {
  77                         /*FIXME:WANGDI How about the opt_value->value*/
  78                         if (strlen(opts) == 0)
  79                                 sprintf((char *)opts + strlen(opts), "%s",
  80                                         opt_value->opt);
  81                         else
  82                                 sprintf((char *)opts + strlen(opts), ",%s",
  83                                         opt_value->opt);
  84                 }
  85         }
  86         return pos;
  87 }
  88 static struct smfs_super_info *smfs_init_smb(struct super_block *sb)
  89 {
  90         struct smfs_super_info *smb;
  91         ENTRY;
  92
  93         OBD_ALLOC(smb, sizeof(*smb));
  94         if (!smb)
  95                 RETURN(NULL);
  96
  97         S2SMI(sb) = smb;
  98         RETURN(smb);
  99 }
 100 static int smfs_init_fsfilt_ops(struct smfs_super_info *smb)
 101 {
 102         ENTRY;
 103         if (!smb->sm_cache_fsfilt) {
 104                 smb->sm_cache_fsfilt = fsfilt_get_ops(smb->smsi_cache_ftype);
 105                 if (!smb->sm_cache_fsfilt) {
 106                         CERROR("Can not get %s fsfilt ops needed by kml\n",
 107                                smb->smsi_cache_ftype);
 108                         RETURN(-EINVAL);
 109                 }
 110         }
 111         if (!smb->sm_fsfilt) {
 112                 smb->sm_fsfilt = fsfilt_get_ops(smb->smsi_ftype);
 113                 if (!smb->sm_fsfilt) {
 114                         CERROR("Can not get %s fsfilt ops needed by kml\n",
 115                                smb->smsi_ftype);
 116                         RETURN(-EINVAL);
 117                 }
 118         }
 119         RETURN(0);
 120 }
 121
 122 void smfs_cleanup_fsfilt_ops(struct smfs_super_info *smb)
 123 {
 124         if (smb->sm_cache_fsfilt)
 125                 fsfilt_put_ops(smb->sm_cache_fsfilt);
 126         if (smb->sm_fsfilt)
 127                 fsfilt_put_ops(smb->sm_fsfilt);
 128 }
 129
 130 static int smfs_mount_cache(struct smfs_super_info *smb, char *devstr,
 131                             char *typestr, char *opts)
 132 {
 133         int err = 0, typelen;
 134         struct vfsmount *mnt;
 135         ENTRY;
 136
 137         typelen = strlen(typestr);
 138
 139         printk("smfs: mounting %s at %s\n", typestr, devstr);
 140
 141         mnt = do_kern_mount(typestr, 0, devstr, (void *)opts);
 142
 143         if (IS_ERR(mnt)) {
 144                 CERROR("do_kern_mount failed: rc = %ld\n", PTR_ERR(mnt));
 145                 GOTO(err_out, err = PTR_ERR(mnt));
 146         }
 147
 148         smb->smsi_sb = mnt->mnt_sb;
 149         smb->smsi_mnt = mnt;
 150
 151         smfs_init_sm_ops(smb);
 152
 153         OBD_ALLOC(smb->smsi_cache_ftype, strlen(typestr) + 1);
 154         memcpy(smb->smsi_cache_ftype, typestr, strlen(typestr));
 155
 156         OBD_ALLOC(smb->smsi_ftype, strlen(SMFS_TYPE) + 1);
 157         memcpy(smb->smsi_ftype, SMFS_TYPE, strlen(SMFS_TYPE));
 158
 159         err = smfs_init_fsfilt_ops(smb);
 160 err_out:
 161         RETURN(err);
 162 }
 163
 164 static int smfs_umount_cache(struct smfs_super_info *smb)
 165 {
 166         iput(smb->smsi_sb->s_root->d_inode);
 167         dput(smb->smsi_sb->s_root);
 168         mntput(smb->smsi_mnt);
 169         smfs_cleanup_sm_ops(smb);
 170         smfs_cleanup_fsfilt_ops(smb);
 171
 172         if (smb->smsi_cache_ftype)
 173                 OBD_FREE(smb->smsi_cache_ftype,
 174                          strlen(smb->smsi_cache_ftype) + 1);
 175         if (smb->smsi_ftype)
 176                 OBD_FREE(smb->smsi_ftype, strlen(smb->smsi_ftype) + 1);
 177
 178         return 0;
 179 }
 180
 181 static int smfs_init_hook_ops(struct smfs_super_info *smb)
 182 {
 183         ENTRY;
 184
 185         INIT_LIST_HEAD(&smb->smsi_hook_list);
 186
 187         RETURN(0);
 188 }
 189 static void smfs_cleanup_hook_ops(struct smfs_super_info *smb)
 190 {
 191         struct list_head *hlist = &smb->smsi_hook_list;
 192         ENTRY;
 193
 194         while (!list_empty(hlist)) {
 195                 struct smfs_hook_ops *smfs_hops;
 196
 197                 smfs_hops = list_entry(hlist->next, struct smfs_hook_ops,
 198                                        smh_list);
 199                 CERROR("Unregister %s hook ops\n", smfs_hops->smh_name);
 200
 201                 smfs_unregister_hook_ops(smb, smfs_hops->smh_name);
 202                 smfs_free_hook_ops(smfs_hops);
 203         }
 204         EXIT;
 205         return;
 206 }
 207
 208 static void smfs_cleanup_smb(struct super_block *sb)
 209 {
 210         struct smfs_super_info *smb;
 211         ENTRY;
 212
 213         smb = S2SMI(sb);
 214         if (smb)
 215                 OBD_FREE(smb, sizeof(*smb));
 216         EXIT;
 217         return;
 218 }
 219 static void smfs_cleanup_hooks(struct smfs_super_info *smb)
 220 {
 221
 222         if (SMFS_CACHE_HOOK(smb))
 223                 cache_space_hook_exit(smb);
 224         if (SMFS_DO_REC(smb))
 225                 smfs_rec_cleanup(smb);
 226 #if CONFIG_SNAPFS
 227         if (SMFS_DO_COW(smb))
 228                 smfs_cow_cleanup(smb);
 229 #endif
 230 }
 231
 232 void smfs_put_super(struct super_block *sb)
 233 {
 234         struct smfs_super_info *smfs_info = S2SMI(sb);
 235
 236         smfs_cleanup_hooks(smfs_info);
 237
 238         smfs_cleanup_hook_ops(smfs_info);
 239         if (sb)
 240                 smfs_umount_cache(smfs_info);
 241         smfs_cleanup_smb(sb);
 242         return;
 243 }
 244
 245 static int smfs_init_hooks(struct super_block *sb)
 246 {
 247         ENTRY;
 248
 249         if (SMFS_DO_REC(S2SMI(sb)))
 250                 smfs_rec_init(sb);
 251         if (SMFS_CACHE_HOOK(S2SMI(sb)))
 252                 cache_space_hook_init(sb);
 253 #if CONFIG_SNAPFS
 254         if (SMFS_DO_COW(S2SMI(sb)))
 255                 smfs_cow_init(sb);
 256 #endif
 257         RETURN(0);
 258 }
 259
 260 int smfs_fill_super(struct super_block *sb, void *data, int silent)
 261 {
 262         struct inode *root_inode = NULL;
 263         struct smfs_super_info *smb = NULL;
 264         char *devstr = NULL, *typestr = NULL;
 265         char *opts = NULL, *cache_data = NULL;
 266         unsigned long page;
 267         int err = 0;
 268         ino_t root_ino;
 269
 270         ENTRY;
 271
 272         CDEBUG(D_SUPER, "mount opts: %s\n", data ?  (char *)data : "(none)");
 273
 274         smb = smfs_init_smb(sb);
 275         if (!smb)
 276                 RETURN(-ENOMEM);
 277
 278         page = __get_free_page(GFP_KERNEL);
 279         if (!page)
 280                 GOTO(out_err, err = -ENOMEM);
 281
 282         memset((void *)page, 0, PAGE_SIZE);
 283         opts = (char *)page;
 284
 285         init_option(data);
 286         cache_data = smfs_options(data, &devstr, &typestr, opts,
 287                                   &smb->smsi_flags);
 288         if (*cache_data)
 289                 CWARN("smfs_fill_super(): options parsing stoped at "
 290                       "option %s\n", cache_data);
 291
 292         if (!typestr || !devstr) {
 293                 CERROR("mount options name and dev mandatory\n");
 294                 free_page(page);
 295                 GOTO(out_err, err = -EINVAL);
 296         }
 297         err = smfs_mount_cache(smb, devstr, typestr, opts);
 298
 299         free_page(page);
 300
 301         if (err) {
 302                 CERROR("Can not mount %s as %s\n", devstr, typestr);
 303                 GOTO(out_err, 0);
 304         }
 305
 306         duplicate_sb(sb, smb->smsi_sb);
 307         sm_set_sb_ops(smb->smsi_sb, sb);
 308
 309         err = smfs_init_hook_ops(smb);
 310         if (err) {
 311                 CERROR("Can not init super hook ops err %d\n", err);
 312                 GOTO(out_err, 0);
 313         }
 314         /*init the root_inode of smfs*/
 315         dget(S2CSB(sb)->s_root);
 316         root_ino = S2CSB(sb)->s_root->d_inode->i_ino;
 317         root_inode = smfs_get_inode(sb, root_ino, NULL, 0);
 318
 319         CDEBUG(D_SUPER, "readinode %p, root ino %ld, root inode at %p\n",
 320                sb->s_op->read_inode, root_ino, root_inode);
 321
 322         sb->s_root = d_alloc_root(root_inode);
 323
 324         if (!sb->s_root) {
 325                 smfs_umount_cache(smb);
 326                 GOTO(out_err, err=-EINVAL);
 327         }
 328
 329         err = smfs_init_hooks(sb);
 330         if (err) {
 331                 smfs_umount_cache(smb);
 332                 GOTO(out_err, err=-EINVAL);
 333         }
 334 #if (LINUX_VERSION_CODE < KERNEL_VERSION(2,5,0))
 335         CDEBUG(D_SUPER, "sb %lx, &sb->u.generic_sbp: %lx\n",
 336                (ulong)sb, (ulong)&sb->u.generic_sbp);
 337 #else
 338         CDEBUG(D_SUPER, "sb %lx, &sb->s_fs_info: %lx\n",
 339                (ulong)sb, (ulong)&sb->s_fs_info);
 340 #endif
 341 out_err:
 342         cleanup_option();
 343         if (err)
 344                 smfs_cleanup_smb(sb);
 345         return err;
 346 }
 347 struct smfs_hook_ops *smfs_alloc_hook_ops(char *name, smfs_hook_func pre_hook,
 348                                           smfs_hook_func post_hook)
 349 {
 350         struct smfs_hook_ops *smfs_hops = NULL;
 351
 352         ENTRY;
 353         OBD_ALLOC(smfs_hops, sizeof(struct smfs_hook_ops));
 354
 355         if (!smfs_hops)
 356                 RETURN(NULL);
 357
 358         OBD_ALLOC(smfs_hops->smh_name, strlen(name) + 1);
 359
 360         if (!smfs_hops->smh_name) {
 361                 OBD_FREE(smfs_hops, sizeof(struct smfs_hook_ops));
 362                 RETURN(NULL);
 363         }
 364
 365         memcpy(smfs_hops->smh_name, name, strlen(name));
 366
 367         smfs_hops->smh_post_op = post_hook;
 368         smfs_hops->smh_pre_op = pre_hook;
 369
 370         RETURN(smfs_hops);
 371 }
 372
 373 void smfs_free_hook_ops(struct smfs_hook_ops *hops)
 374 {
 375         if (hops) {
 376                 if (hops->smh_name){
 377                         OBD_FREE(hops->smh_name, strlen(hops->smh_name) + 1);
 378                 }
 379                 OBD_FREE(hops, sizeof(struct smfs_hook_ops));
 380         }
 381 }
 382
 383 int smfs_register_hook_ops(struct smfs_super_info *smb,
 384                            struct smfs_hook_ops *smh_ops)
 385 {
 386         struct list_head *hlist = &smb->smsi_hook_list;
 387         struct list_head *p;
 388         ENTRY;
 389
 390         list_for_each(p, hlist) {
 391                 struct smfs_hook_ops *found;
 392                 found = list_entry(p, struct smfs_hook_ops, smh_list);
 393                 if (!strcmp(found->smh_name, smh_ops->smh_name)) {
 394                         CWARN("hook ops %s list  reregister\n", smh_ops->smh_name);
 395                         RETURN(0);
 396                 }
 397         }
 398         list_add(&smh_ops->smh_list, hlist);
 399         RETURN(0);
 400 }
 401 struct smfs_hook_ops *smfs_unregister_hook_ops(struct smfs_super_info *smb,
 402                                                char *name)
 403 {
 404         struct list_head *hlist = &smb->smsi_hook_list;
 405         struct list_head *p;
 406         ENTRY;
 407
 408         list_for_each(p, hlist) {
 409                 struct smfs_hook_ops *found;
 410
 411                 found = list_entry(p, typeof(*found), smh_list);
 412                 if (!memcmp(found->smh_name, name, strlen(name))) {
 413                         list_del(p);
 414                         RETURN(found);
 415                 }
 416         }
 417         RETURN(NULL);
 418 }
 419
 420 void *smfs_trans_start(struct inode *inode, int op, void *desc_private)
 421 {
 422         struct fsfilt_operations *fsfilt = S2SMI(inode->i_sb)->sm_fsfilt;
 423
 424         CDEBUG(D_INFO, "trans start %p\n", fsfilt->fs_start);
 425
 426         SMFS_TRANS_OP(inode, op);
 427
 428         /* There are some problem here. fs_start in fsfilt is used by lustre
 429          * the journal blocks of write rec are not counted in FIXME later */
 430         if (fsfilt->fs_start)
 431                 return fsfilt->fs_start(inode, op, desc_private, 0);
 432         return NULL;
 433 }
 434
 435 void smfs_trans_commit(struct inode *inode, void *handle, int force_sync)
 436 {
 437         struct fsfilt_operations *fsfilt = S2SMI(inode->i_sb)->sm_fsfilt;
 438
 439         if (!handle)
 440                 return;
 441
 442         CDEBUG(D_INFO, "trans commit %p\n", fsfilt->fs_commit);
 443
 444         if (fsfilt->fs_commit)
 445                 fsfilt->fs_commit(inode->i_sb, inode, handle, force_sync);
 446 }
 447