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 int smfs_options(char *data, char **devstr, char **namestr,
  49                  char *ret, int *flags)
  50 {
  51         char * temp;
  52         char * pos = NULL, *next = NULL;
  53
  54         ENTRY;
  55
  56         LASSERT(flags);
  57         //allocate temporary buffer
  58         OBD_ALLOC(temp, strlen(data) + 1);
  59         if (!temp) {
  60                 CERROR("Can not allocate memory for options\n");
  61                 RETURN(-ENOMEM);
  62         }
  63
  64         memcpy(temp, data, strlen(data));
  65         pos = temp;
  66
  67         while (pos) {
  68                 next = strchr(pos, ',');
  69                 if (next) {
  70                         *next = '\0';
  71                         next++;
  72                 }
  73
  74                 //now pos points to one-options string
  75                 if (!strncmp(pos, "dev=", 4)) {
  76                         if (devstr != NULL)
  77                                 *devstr = pos + 4;
  78                 } else if (!strncmp(pos, "type=", 5)) {
  79                         if (namestr != NULL)
  80                                 *namestr = pos + 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);
  87                 } else {
  88                         /* So it is wrong or backfs option,
  89                          * let's save it
  90                          */
  91                         if (strlen(ret))
  92                                 strcat(ret, ",");
  93
  94                         strcat(ret, pos);
  95                 }
  96
  97                 pos = next;
  98         }
  99
 100         //save dev & type for further use
 101         if (*devstr)
 102                 *devstr = strcpy(ret + strlen(ret) + 1, *devstr);
 103         if (*namestr)
 104                 *namestr = strcpy(*devstr + strlen(*devstr) + 1, *namestr);
 105
 106         OBD_FREE(temp, strlen(data) + 1);
 107
 108         RETURN(0);
 109 }
 110
 111 static struct smfs_super_info *smfs_init_smb(struct super_block *sb)
 112 {
 113         struct smfs_super_info *smb;
 114         ENTRY;
 115
 116         OBD_ALLOC(smb, sizeof(*smb));
 117         if (!smb)
 118                 RETURN(NULL);
 119
 120         S2FSI(sb) = smb;
 121         INIT_LIST_HEAD(&smb->smsi_plg_list);
 122
 123         RETURN(smb);
 124 }
 125
 126 static void smfs_cleanup_smb(struct smfs_super_info *smb)
 127 {
 128         ENTRY;
 129
 130         if (smb)
 131                 OBD_FREE(smb, sizeof(*smb));
 132         EXIT;
 133 }
 134
 135 static int smfs_init_fsfilt_ops(struct smfs_super_info *smb)
 136 {
 137         ENTRY;
 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);
 144                         RETURN(-EINVAL);
 145                 }
 146         }
 147         if (!smb->sm_fsfilt) {
 148                 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",
 152                                smb->smsi_ftype);
 153                         RETURN(-EINVAL);
 154                 }
 155         }
 156         RETURN(0);
 157 }
 158
 159 void smfs_cleanup_fsfilt_ops(struct smfs_super_info *smb)
 160 {
 161         if (smb->sm_cache_fsfilt)
 162                 fsfilt_put_ops(smb->sm_cache_fsfilt);
 163         if (smb->sm_fsfilt)
 164                 fsfilt_put_ops(smb->sm_fsfilt);
 165 }
 166
 167 static void smfs_filter_flags(struct filter_obd * filt, struct inode * o_dir)
 168 {
 169         struct dentry * dentry = NULL;
 170         int i,j;
 171
 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,
 180                                          SMFS_PLG_ALL);
 181                 }
 182         }
 183 }
 184
 185 static void smfs_mds_flags(struct mds_obd * mds, struct inode * root)
 186 {
 187         struct inode * pend = mds->mds_pending_dir->d_inode;
 188
 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);
 194 }
 195
 196
 197 int smfs_post_setup(struct obd_device *obd, struct vfsmount *mnt,
 198                     struct dentry * root_dentry)
 199 {
 200         struct lvfs_run_ctxt saved, *current_ctxt = NULL;
 201         struct smfs_super_info *smb = S2SMI(mnt->mnt_sb);
 202         int rc = 0;
 203
 204         ENTRY;
 205
 206         OBD_ALLOC(current_ctxt, sizeof(*current_ctxt));
 207         if (!current_ctxt)
 208                 RETURN(-ENOMEM);
 209
 210         OBD_SET_CTXT_MAGIC(current_ctxt);
 211
 212         current_ctxt->pwdmnt = mnt;
 213         current_ctxt->pwd = mnt->mnt_root;
 214         current_ctxt->fs = get_ds();
 215         smb->smsi_ctxt = current_ctxt;
 216
 217         push_ctxt(&saved, smb->smsi_ctxt, NULL);
 218
 219         rc = smfs_llog_setup(smb);
 220         if (!rc) {
 221                 rc = SMFS_PLG_HELP(mnt->mnt_sb, PLG_START, NULL);
 222         }
 223
 224         pop_ctxt(&saved, smb->smsi_ctxt, NULL);
 225
 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;
 231         }
 232
 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;
 237
 238                         smfs_filter_flags(filt, root_dentry->d_inode);
 239                 }
 240                 else if (!strcmp(obd->obd_type->typ_name, "mds")) {
 241                         struct mds_obd * mds = &obd->u.mds;
 242
 243                         smfs_mds_flags(mds, root_dentry->d_inode);
 244                 }
 245                 else
 246                         CDEBUG(D_SUPER,"Unknown OBD (%s) post_setup\n",
 247                                obd->obd_type->typ_name);
 248         }
 249
 250         if (rc)
 251                 OBD_FREE(current_ctxt, sizeof(*current_ctxt));
 252
 253         RETURN(rc);
 254 }
 255
 256 void smfs_post_cleanup(struct super_block *sb)
 257 {
 258         struct smfs_super_info *smb = S2SMI(sb);
 259
 260         ENTRY;
 261
 262         smfs_llog_cleanup(smb);
 263         SMFS_PLG_HELP(sb, PLG_STOP, NULL);
 264
 265         if (smb->smsi_ctxt)
 266                 OBD_FREE(smb->smsi_ctxt, sizeof(struct lvfs_run_ctxt));
 267
 268         EXIT;
 269 }
 270
 271 static int smfs_mount_cache(struct smfs_super_info *smb, char *devstr,
 272                             char *typestr, char *opts)
 273 {
 274         int err = 0, typelen;
 275         struct vfsmount *mnt;
 276         ENTRY;
 277
 278         typelen = strlen(typestr);
 279
 280         CDEBUG(D_INODE, "smfs: mounting %s at %s\n", typestr, devstr);
 281         mnt = do_kern_mount(typestr, 0, devstr, (void *)opts);
 282         if (IS_ERR(mnt)) {
 283                 CERROR("do_kern_mount failed: rc = %ld\n",
 284                        PTR_ERR(mnt));
 285                 GOTO(err_out, err = PTR_ERR(mnt));
 286         }
 287
 288         smb->smsi_sb = mnt->mnt_sb;
 289         smb->smsi_mnt = mnt;
 290
 291         smfs_init_sm_ops(smb);
 292
 293         OBD_ALLOC(smb->smsi_cache_ftype, strlen(typestr) + 1);
 294         memcpy(smb->smsi_cache_ftype, typestr, strlen(typestr));
 295
 296         OBD_ALLOC(smb->smsi_ftype, strlen(SMFS_TYPE) + 1);
 297         memcpy(smb->smsi_ftype, SMFS_TYPE, strlen(SMFS_TYPE));
 298
 299         err = smfs_init_fsfilt_ops(smb);
 300 err_out:
 301         RETURN(err);
 302 }
 303
 304 static int smfs_umount_cache(struct smfs_super_info *smb)
 305 {
 306         mntput(smb->smsi_mnt);
 307         smfs_cleanup_sm_ops(smb);
 308         smfs_cleanup_fsfilt_ops(smb);
 309
 310         if (smb->smsi_cache_ftype)
 311                 OBD_FREE(smb->smsi_cache_ftype,
 312                          strlen(smb->smsi_cache_ftype) + 1);
 313         if (smb->smsi_ftype)
 314                 OBD_FREE(smb->smsi_ftype, strlen(smb->smsi_ftype) + 1);
 315
 316         return 0;
 317 }
 318
 319 /* This function initializes plugins in SMFS
 320  * @flags: are filled while options parsing
 321  * @sb: smfs super block
 322  */
 323
 324 static int smfs_init_plugins(struct super_block * sb, int flags)
 325 {
 326         struct smfs_super_info * smb = S2SMI(sb);
 327
 328         ENTRY;
 329
 330         INIT_LIST_HEAD(&smb->smsi_plg_list);
 331         init_rwsem(&smb->plg_sem);
 332
 333         if (SMFS_IS(flags, SMFS_PLG_KML))
 334                 smfs_init_kml(sb);
 335         if (SMFS_IS(flags, SMFS_PLG_LRU))
 336                 smfs_init_lru(sb);
 337 #if CONFIG_SNAPFS
 338         if (SMFS_IS(flags, SMFS_PLG_COW))
 339                 smfs_init_cow(sb);
 340 #endif
 341         RETURN(0);
 342 }
 343
 344 static void smfs_remove_plugins(struct super_block *sb)
 345 {
 346         ENTRY;
 347
 348         SMFS_PLG_HELP(sb, PLG_EXIT, (void*)sb);
 349
 350         EXIT;
 351 }
 352
 353 void smfs_put_super(struct super_block *sb)
 354 {
 355         struct smfs_super_info *smb = S2SMI(sb);
 356         ENTRY;
 357         smfs_remove_plugins(sb);
 358
 359         dput(sb->s_root);
 360
 361         if (smb->smsi_mnt)
 362                 smfs_umount_cache(smb);
 363
 364         smfs_cleanup_smb(smb);
 365         EXIT;
 366 }
 367
 368 int smfs_fill_super(struct super_block *sb, void *data, int silent)
 369 {
 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;
 374         char *opts = NULL;
 375         int err = 0;
 376         int flags = 0;
 377
 378         ENTRY;
 379
 380         if (!data) {
 381                 CERROR("no mount options. At least name and dev are needed\n");
 382                 err = -EINVAL;
 383                 goto out_err;
 384         }
 385
 386         CDEBUG(D_SUPER, "mount opts: %s\n", (char *)data);
 387
 388         smb = smfs_init_smb(sb);
 389         if (!smb)
 390                 RETURN(-ENOMEM);
 391         lock_kernel();
 392         OBD_ALLOC(opts, strlen(data) + 1);
 393         if (!opts) {
 394                 err = -ENOMEM;
 395                 goto out_err;
 396         }
 397
 398         err = smfs_options(data, &devstr, &typestr, opts, &flags);
 399         if (err)
 400                 goto out_err;
 401
 402         if (!typestr || !devstr) {
 403                 CERROR("mount options name and dev are mandatory\n");
 404                 err = -EINVAL;
 405                 goto out_err;
 406         }
 407
 408         CDEBUG(D_SUPER, "backfs mount opts: %s\n", opts);
 409
 410         err = smfs_mount_cache(smb, devstr, typestr, opts);
 411         if (err) {
 412                 CERROR("Can not mount %s as %s\n", devstr, typestr);
 413                 goto out_err;
 414         }
 415
 416         OBD_FREE(opts, strlen(data) + 1);
 417         opts = NULL;
 418
 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);
 422
 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);
 426
 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);
 429
 430         sb->s_root = d_alloc_root(root_inode);
 431         if (!sb->s_root) {
 432                 err = -ENOMEM;
 433                 goto out_err;
 434         }
 435
 436         /* all entries created until post_setup() should not be logged */
 437         SMFS_CLEAR((I2SMI(root_inode))->smi_flags, SMFS_PLG_ALL);
 438
 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);
 442 #else
 443         CDEBUG(D_SUPER, "sb %lx(%p), &sb->s_fs_info: %lx\n",
 444                (ulong)sb, smb->smsi_sb, (ulong)&sb->s_fs_info);
 445 #endif
 446
 447         smfs_init_plugins(sb, flags);
 448         unlock_kernel();
 449         RETURN (0);
 450 out_err:
 451         if (smb->smsi_mnt)
 452                 smfs_umount_cache(smb);
 453
 454         if (opts)
 455                 OBD_FREE(opts, strlen(data) + 1);
 456
 457         smfs_cleanup_smb(smb);
 458         unlock_kernel();
 459         RETURN(err);
 460 }
 461
 462 void *smfs_trans_start(struct inode *inode, int op, void *desc_private)
 463 {
 464         struct fsfilt_operations *fsfilt = S2SMI(inode->i_sb)->sm_fsfilt;
 465
 466         if (fsfilt->fs_start)
 467                 return fsfilt->fs_start(inode, op, NULL, 0);
 468         return NULL;
 469 }
 470
 471 void smfs_trans_commit(struct inode *inode, void *handle, int force_sync)
 472 {
 473         struct fsfilt_operations *fsfilt = S2SMI(inode->i_sb)->sm_fsfilt;
 474
 475         if (handle && fsfilt->fs_commit)
 476                 fsfilt->fs_commit(inode->i_sb, inode, handle, force_sync);
 477 }
 478 /* Plugin API */
 479 int smfs_register_plugin(struct super_block * sb,
 480                          struct smfs_plugin * plg)
 481 {
 482         struct smfs_plugin * tmp = NULL;
 483         struct smfs_super_info * smb = S2SMI(sb);
 484         struct list_head * plist = &smb->smsi_plg_list;
 485         int rc = 0;
 486
 487         ENTRY;
 488
 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");
 493                         rc = -EEXIST;
 494                         goto exit;
 495                 }
 496         }
 497
 498         list_add_tail(&plg->plg_list, plist);
 499 exit:
 500         up_write(&smb->plg_sem);
 501         RETURN(0);
 502 }
 503
 504 struct smfs_plugin * smfs_deregister_plugin(struct super_block *sb, int type)
 505 {
 506         struct smfs_plugin * plg = NULL;
 507         struct smfs_super_info *smb = S2SMI(sb);
 508         struct list_head * plist = &smb->smsi_plg_list;
 509
 510         ENTRY;
 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);
 515                         break;
 516                 }
 517         }
 518         up_write(&smb->plg_sem);
 519         RETURN(plg);
 520 }
 521
 522 void smfs_pre_hook (struct inode * inode, int op, void * msg)
 523 {
 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;
 528
 529         //ENTRY;
 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))
 536                         continue;
 537                 //check that inode is allowed
 538                 if (!SMFS_IS(smi->smi_flags, plg->plg_type))
 539                         continue;
 540
 541                 if (plg->plg_pre_op)
 542                         plg->plg_pre_op(op, inode, msg, 0, plg->plg_private);
 543         }
 544         up_read(&smb->plg_sem);
 545         //EXIT;
 546 }
 547
 548 void smfs_post_hook (struct inode * inode, int op, void * msg, int ret)
 549 {
 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;
 554
 555         //ENTRY;
 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))
 560                         continue;
 561                 //check that inode is allowed
 562                 if (!SMFS_IS(smi->smi_flags, plg->plg_type))
 563                         continue;
 564
 565                 if (plg->plg_post_op)
 566                         plg->plg_post_op(op, inode, msg, ret, plg->plg_private);
 567         }
 568         up_read(&smb->plg_sem);
 569         //EXIT;
 570 }
 571
 572 int smfs_helper (struct super_block * sb, int op, void * msg)
 573 {
 574         struct smfs_super_info *smb = S2SMI(sb);
 575         struct list_head *hlist = &smb->smsi_plg_list;
 576         struct smfs_plugin *plg, *tmp;
 577         int rc = 0;
 578
 579         //ENTRY;
 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))
 586                         continue;
 587
 588                 if (plg->plg_helper)
 589                        rc += plg->plg_helper(op, sb, msg, plg->plg_private);
 590         }
 591         up_read(&smb->plg_sem);
 592         //EXIT;
 593
 594         return rc;
 595 }
 596
 597