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, "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);
  89                 } else {
  90                         /* So it is wrong or backfs option,
  91                          * let's save it
  92                          */
  93                         if (strlen(ret))
  94                                 strcat(ret, ",");
  95
  96                         strcat(ret, pos);
  97                 }
  98
  99                 pos = next;
 100         }
 101
 102         //save dev & type for further use
 103         if (*devstr)
 104                 *devstr = strcpy(ret + strlen(ret) + 1, *devstr);
 105         if (*namestr)
 106                 *namestr = strcpy(*devstr + strlen(*devstr) + 1, *namestr);
 107
 108         OBD_FREE(temp, strlen(data) + 1);
 109
 110         RETURN(0);
 111 }
 112
 113 static struct smfs_super_info *smfs_init_smb(struct super_block *sb)
 114 {
 115         struct smfs_super_info *smb;
 116         ENTRY;
 117
 118         OBD_ALLOC(smb, sizeof(*smb));
 119         if (!smb)
 120                 RETURN(NULL);
 121
 122         S2FSI(sb) = smb;
 123         INIT_LIST_HEAD(&smb->smsi_plg_list);
 124
 125         RETURN(smb);
 126 }
 127
 128 static void smfs_cleanup_smb(struct smfs_super_info *smb)
 129 {
 130         ENTRY;
 131
 132         if (smb)
 133                 OBD_FREE(smb, sizeof(*smb));
 134         EXIT;
 135 }
 136
 137 static int smfs_init_fsfilt_ops(struct smfs_super_info *smb)
 138 {
 139         ENTRY;
 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);
 146                         RETURN(-EINVAL);
 147                 }
 148         }
 149         if (!smb->sm_fsfilt) {
 150                 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",
 154                                smb->smsi_ftype);
 155                         RETURN(-EINVAL);
 156                 }
 157         }
 158         RETURN(0);
 159 }
 160
 161 void smfs_cleanup_fsfilt_ops(struct smfs_super_info *smb)
 162 {
 163         if (smb->sm_cache_fsfilt)
 164                 fsfilt_put_ops(smb->sm_cache_fsfilt);
 165         if (smb->sm_fsfilt)
 166                 fsfilt_put_ops(smb->sm_fsfilt);
 167 }
 168
 169 static void smfs_filter_flags(struct filter_obd *filt, struct inode *o_dir)
 170 {
 171         struct dentry * dentry = NULL;
 172         int i,j;
 173
 174         CDEBUG(D_SUPER,"OST OBD post_setup\n");
 175
 176         /* enable plugins for all in O */
 177         /* SMFS_SET(I2SMI(o_dir)->smi_flags, SMFS_PLG_ALL); */
 178
 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,
 184                                          SMFS_PLG_ALL);
 185                 }
 186         }
 187 }
 188
 189 static void smfs_mds_flags(struct mds_obd *mds, struct inode *root)
 190 {
 191         CDEBUG(D_SUPER,"MDS OBD post_setup\n");
 192
 193         /* enable plugins for all in ROOT */
 194         SMFS_SET(I2SMI(root)->smi_flags, SMFS_PLG_ALL);
 195         SMFS_SET(I2SMI(mds->mds_unnamed_dir->d_inode)->smi_flags, SMFS_PLG_ALL);
 196 }
 197
 198 extern int (*audit_id2name_superhack) (struct obd_device *obd, char **name,
 199                                        int *namelen, struct lustre_id *id);
 200
 201 int smfs_post_setup(struct obd_device *obd, struct vfsmount *mnt,
 202                     struct dentry *root_dentry)
 203 {
 204         struct lvfs_run_ctxt saved, *current_ctxt = NULL;
 205         struct smfs_super_info *smb = S2SMI(mnt->mnt_sb);
 206         int rc = 0;
 207         ENTRY;
 208
 209         /* XXX to register id2name function of mds in smfs */
 210         //if (data != NULL)
 211         //        audit_id2name_superhack = data;
 212
 213         OBD_ALLOC(current_ctxt, sizeof(*current_ctxt));
 214         if (!current_ctxt)
 215                 RETURN(-ENOMEM);
 216
 217         OBD_SET_CTXT_MAGIC(current_ctxt);
 218
 219         current_ctxt->pwdmnt = mnt;
 220         current_ctxt->pwd = mnt->mnt_root;
 221         current_ctxt->fs = get_ds();
 222         smb->smsi_ctxt = current_ctxt;
 223
 224         push_ctxt(&saved, smb->smsi_ctxt, NULL);
 225
 226         rc = smfs_llog_setup(&smb->smsi_logs_dir, &smb->smsi_objects_dir);
 227         if (!rc)
 228                 rc = SMFS_PLG_HELP(mnt->mnt_sb, PLG_START, obd);
 229
 230         pop_ctxt(&saved, smb->smsi_ctxt, NULL);
 231
 232         /* enable plugins for directories on MDS or OST */
 233         if (obd && obd->obd_type && obd->obd_type->typ_name) {
 234                 if (!strcmp(obd->obd_type->typ_name, OBD_FILTER_DEVICENAME)) {
 235                         struct filter_obd *filt = &obd->u.filter;
 236                         smfs_filter_flags(filt, root_dentry->d_inode);
 237                 } else if (!strcmp(obd->obd_type->typ_name, OBD_MDS_DEVICENAME)) {
 238                         struct mds_obd * mds = &obd->u.mds;
 239                         smfs_mds_flags(mds, root_dentry->d_inode);
 240                         SMFS_SET_HND_IBLOCKS(smb);
 241                 } else {
 242                         CDEBUG(D_SUPER,"Unknown OBD (%s) post_setup\n",
 243                                obd->obd_type->typ_name);
 244                 }
 245         }
 246
 247         if (rc)
 248                 OBD_FREE(current_ctxt, sizeof(*current_ctxt));
 249
 250         RETURN(rc);
 251 }
 252
 253 void smfs_post_cleanup(struct super_block *sb)
 254 {
 255         struct smfs_super_info *smb = S2SMI(sb);
 256
 257         ENTRY;
 258
 259         smfs_llog_cleanup(smb);
 260         SMFS_PLG_HELP(sb, PLG_STOP, NULL);
 261
 262         if (smb->smsi_ctxt)
 263                 OBD_FREE(smb->smsi_ctxt, sizeof(struct lvfs_run_ctxt));
 264
 265         EXIT;
 266 }
 267
 268 static int smfs_mount_cache(struct smfs_super_info *smb, char *devstr,
 269                             char *typestr, char *opts)
 270 {
 271         int err = 0, typelen;
 272         struct vfsmount *mnt;
 273         ENTRY;
 274
 275         typelen = strlen(typestr);
 276
 277         CDEBUG(D_INODE, "smfs: mounting %s at %s\n", typestr, devstr);
 278
 279         mnt = do_kern_mount(typestr, 0, devstr, (void *)opts);
 280         if (IS_ERR(mnt)) {
 281                 CERROR("do_kern_mount failed: rc = %d\n",
 282                        (int)PTR_ERR(mnt));
 283                 RETURN(PTR_ERR(mnt));
 284         }
 285
 286         smb->smsi_sb = mnt->mnt_sb;
 287         smb->smsi_mnt = mnt;
 288
 289         smfs_init_sm_ops(smb);
 290
 291         OBD_ALLOC(smb->smsi_cache_ftype, strlen(typestr) + 1);
 292         if (!smb->smsi_cache_ftype)
 293                 GOTO(err_umount_cache, err = -ENOMEM);
 294
 295         memcpy(smb->smsi_cache_ftype, typestr, strlen(typestr));
 296
 297         OBD_ALLOC(smb->smsi_ftype, strlen(SMFS_TYPE) + 1);
 298         if (!smb->smsi_ftype)
 299                 GOTO(err_free_cache_fstype, err = -ENOMEM);
 300
 301         memcpy(smb->smsi_ftype, SMFS_TYPE, strlen(SMFS_TYPE));
 302
 303         err = smfs_init_fsfilt_ops(smb);
 304         RETURN(err);
 305 err_free_cache_fstype:
 306         OBD_FREE(smb->smsi_cache_ftype, strlen(typestr) + 1);
 307 err_umount_cache:
 308         mntput(mnt);
 309         return err;
 310 }
 311
 312 static int smfs_umount_cache(struct smfs_super_info *smb)
 313 {
 314         ENTRY;
 315
 316         mntput(smb->smsi_mnt);
 317         smfs_cleanup_sm_ops(smb);
 318         smfs_cleanup_fsfilt_ops(smb);
 319
 320         if (smb->smsi_cache_ftype) {
 321                 OBD_FREE(smb->smsi_cache_ftype,
 322                          strlen(smb->smsi_cache_ftype) + 1);
 323                 smb->smsi_cache_ftype = NULL;
 324         }
 325         if (smb->smsi_ftype) {
 326                 OBD_FREE(smb->smsi_ftype,
 327                          strlen(smb->smsi_ftype) + 1);
 328                 smb->smsi_ftype = NULL;
 329         }
 330
 331         RETURN(0);
 332 }
 333
 334 /* This function initializes plugins in SMFS
 335  * @flags: are filled while options parsing
 336  * @sb: smfs super block
 337  */
 338 static int smfs_init_plugins(struct super_block * sb, int flags)
 339 {
 340         struct smfs_super_info * smb = S2SMI(sb);
 341
 342         ENTRY;
 343
 344         INIT_LIST_HEAD(&smb->smsi_plg_list);
 345         init_rwsem(&smb->plg_sem);
 346
 347         if (SMFS_IS(flags, SMFS_PLG_AUDIT))
 348                 smfs_init_audit(sb);
 349         if (SMFS_IS(flags, SMFS_PLG_KML))
 350                 smfs_init_kml(sb);
 351         if (SMFS_IS(flags, SMFS_PLG_LRU))
 352                 smfs_init_lru(sb);
 353 #if CONFIG_SNAPFS
 354         if (SMFS_IS(flags, SMFS_PLG_COW))
 355                 smfs_init_cow(sb);
 356 #endif
 357         RETURN(0);
 358 }
 359
 360 static void smfs_remove_plugins(struct super_block *sb)
 361 {
 362         struct smfs_plugin * plg, *tmp;
 363         struct smfs_super_info *smb = S2SMI(sb);
 364         struct list_head * plist = &smb->smsi_plg_list;
 365
 366         ENTRY;
 367
 368         list_for_each_entry_safe(plg, tmp, plist, plg_list) {
 369                 plg->plg_exit(sb, plg->plg_private);
 370         }
 371
 372         EXIT;
 373 }
 374
 375 void smfs_put_super(struct super_block *sb)
 376 {
 377         struct smfs_super_info *smb = S2SMI(sb);
 378         ENTRY;
 379         smfs_remove_plugins(sb);
 380
 381         dput(sb->s_root);
 382
 383         if (smb->smsi_mnt)
 384                 smfs_umount_cache(smb);
 385
 386         smfs_cleanup_smb(smb);
 387         EXIT;
 388 }
 389
 390 int smfs_fill_super(struct super_block *sb, void *data, int silent)
 391 {
 392         struct inode *root_inode = NULL;
 393         struct inode *back_root_inode = NULL;
 394         struct smfs_super_info *smb = NULL;
 395         char *devstr = NULL, *typestr = NULL;
 396         unsigned long page = 0;
 397         char *opts = NULL;
 398         int flags = 0;
 399         int err = 0;
 400
 401         ENTRY;
 402
 403         if (!data) {
 404                 CERROR("no mount options. At least name and dev are needed\n");
 405                 err = -EINVAL;
 406                 goto out_err;
 407         }
 408
 409         CDEBUG(D_SUPER, "mount opts: %s\n", (char *)data);
 410
 411         smb = smfs_init_smb(sb);
 412         if (!smb)
 413                 RETURN(-ENOMEM);
 414
 415         lock_kernel();
 416
 417         /* 2.6.9 selinux wants a full option page for do_kern_mount (bug6471) */
 418         page = get_zeroed_page(GFP_KERNEL);
 419         if (!page) {
 420                 err = -ENOMEM;
 421                 goto out_err;
 422         }
 423         opts = (char *)page;
 424
 425         err = smfs_options(data, &devstr, &typestr, opts, &flags);
 426         if (err)
 427                 goto out_err;
 428
 429         if (!typestr || !devstr) {
 430                 CERROR("mount options name and dev are mandatory\n");
 431                 err = -EINVAL;
 432                 goto out_err;
 433         }
 434
 435         CDEBUG(D_SUPER, "backfs mount opts: %s\n", opts);
 436
 437         err = smfs_mount_cache(smb, devstr, typestr, opts);
 438         if (err) {
 439                 CERROR("Can not mount %s as %s\n", devstr, typestr);
 440                 goto out_err;
 441         }
 442
 443         free_page(page);
 444         page = 0;
 445
 446         duplicate_sb(sb, smb->smsi_sb);
 447         sb->s_bdev = smb->smsi_sb->s_bdev;
 448         sm_set_sb_ops(smb->smsi_sb, sb);
 449
 450         /* init the root_inode of smfs. */
 451         back_root_inode = S2CSB(sb)->s_root->d_inode;
 452         root_inode = smfs_get_inode(sb, back_root_inode, NULL, 0);
 453
 454         CDEBUG(D_SUPER, "readinode %p, root ino %ld, root inode at %p\n",
 455                sb->s_op->read_inode, root_inode->i_ino, root_inode);
 456
 457         sb->s_root = d_alloc_root(root_inode);
 458         if (!sb->s_root) {
 459                 err = -ENOMEM;
 460                 goto out_err;
 461         }
 462
 463         /* all entries created until post_setup() should not be logged */
 464         SMFS_CLEAR((I2SMI(root_inode))->smi_flags, SMFS_PLG_ALL);
 465
 466 #if (LINUX_VERSION_CODE < KERNEL_VERSION(2,5,0))
 467         CDEBUG(D_SUPER, "sb %lx, &sb->u.generic_sbp: %lx\n",
 468                (ulong)sb, (ulong)&sb->u.generic_sbp);
 469 #else
 470         CDEBUG(D_SUPER, "sb %lx(%p), &sb->s_fs_info: %lx\n",
 471                (ulong)sb, smb->smsi_sb, (ulong)&sb->s_fs_info);
 472 #endif
 473
 474         smfs_init_plugins(sb, flags);
 475         unlock_kernel();
 476         RETURN (0);
 477 out_err:
 478         if (smb->smsi_mnt)
 479                 smfs_umount_cache(smb);
 480
 481         if (page)
 482                 free_page(page);
 483
 484         smfs_cleanup_smb(smb);
 485         unlock_kernel();
 486         RETURN(err);
 487 }
 488
 489 void *smfs_trans_start(struct inode *inode, int op, void *desc_private)
 490 {
 491         struct fsfilt_operations *fsfilt = S2SMI(inode->i_sb)->sm_fsfilt;
 492
 493         if (fsfilt->fs_start)
 494                 return fsfilt->fs_start(inode, op, NULL, 0);
 495         return NULL;
 496 }
 497
 498 void smfs_trans_commit(struct inode *inode, void *handle, int force_sync)
 499 {
 500         struct fsfilt_operations *fsfilt = S2SMI(inode->i_sb)->sm_fsfilt;
 501
 502         if (handle && fsfilt->fs_commit)
 503                 fsfilt->fs_commit(inode->i_sb, inode, handle, force_sync);
 504 }
 505 /* Plugin API */
 506 int smfs_register_plugin(struct super_block * sb,
 507                          struct smfs_plugin * plg)
 508 {
 509         struct smfs_plugin * tmp = NULL;
 510         struct smfs_super_info * smb = S2SMI(sb);
 511         struct list_head * plist = &smb->smsi_plg_list;
 512         int rc = 0;
 513
 514         ENTRY;
 515
 516         down_write(&smb->plg_sem);
 517         list_for_each_entry(tmp, plist, plg_list) {
 518                 if (tmp->plg_type == plg->plg_type) {
 519                         CWARN("Plugin is already registered\n");
 520                         rc = -EEXIST;
 521                         goto exit;
 522                 }
 523         }
 524
 525         list_add_tail(&plg->plg_list, plist);
 526 exit:
 527         up_write(&smb->plg_sem);
 528         RETURN(0);
 529 }
 530
 531 struct smfs_plugin * smfs_deregister_plugin(struct super_block *sb, int type)
 532 {
 533         struct smfs_plugin * plg = NULL;
 534         struct smfs_super_info *smb = S2SMI(sb);
 535         struct list_head * plist = &smb->smsi_plg_list;
 536
 537         ENTRY;
 538         down_write(&smb->plg_sem);
 539         list_for_each_entry(plg, plist, plg_list) {
 540                 if (plg->plg_type == type) {
 541                         list_del(&plg->plg_list);
 542                         break;
 543                 }
 544         }
 545         up_write(&smb->plg_sem);
 546         RETURN(plg);
 547 }
 548
 549 void smfs_pre_hook (struct inode * inode, hook_op op, void * msg)
 550 {
 551         struct smfs_super_info *smb = S2SMI(inode->i_sb);
 552         struct smfs_inode_info *smi = I2SMI(inode);
 553         struct list_head *hlist = &smb->smsi_plg_list;
 554         struct smfs_plugin *plg;
 555
 556         //ENTRY;
 557         LASSERT(op < HOOK_MAX);
 558         //call hook operations
 559         down_read(&smb->plg_sem);
 560         list_for_each_entry(plg, hlist, plg_list) {
 561                 //check that plugin is active
 562                 if(!SMFS_IS(smb->plg_flags, plg->plg_type))
 563                         continue;
 564                 //check that inode is allowed
 565                 if (!SMFS_IS(smi->smi_flags, plg->plg_type))
 566                         continue;
 567
 568                 if (plg->plg_pre_op)
 569                         plg->plg_pre_op(op, inode, msg, 0, plg->plg_private);
 570         }
 571         up_read(&smb->plg_sem);
 572         //EXIT;
 573 }
 574
 575 void smfs_post_hook (struct inode * inode, hook_op op, void * msg, int ret)
 576 {
 577         struct smfs_super_info *smb = S2SMI(inode->i_sb);
 578         //struct smfs_inode_info *smi = I2SMI(inode);
 579         struct list_head *hlist = &smb->smsi_plg_list;
 580         struct smfs_plugin *plg;
 581
 582         //ENTRY;
 583         down_read(&smb->plg_sem);
 584         list_for_each_entry(plg, hlist, plg_list) {
 585                 //check that plugin is active
 586                 if(!SMFS_IS(smb->plg_flags, plg->plg_type))
 587                         continue;
 588                 /* this will be checked inside plg_post_op()
 589                 if (!SMFS_IS(smi->smi_flags, plg->plg_type))
 590                         continue;
 591                 */
 592                 if (plg->plg_post_op)
 593                         plg->plg_post_op(op, inode, msg, ret, plg->plg_private);
 594         }
 595         up_read(&smb->plg_sem);
 596         //EXIT;
 597 }
 598
 599 int smfs_helper (struct super_block * sb, int op, void * msg)
 600 {
 601         struct smfs_super_info *smb = S2SMI(sb);
 602         struct list_head *hlist = &smb->smsi_plg_list;
 603         struct smfs_plugin *plg, *tmp;
 604         int rc = 0;
 605
 606         //ENTRY;
 607         LASSERT(op < PLG_HELPER_MAX);
 608         //call hook operations
 609         down_read(&smb->plg_sem);
 610         list_for_each_entry_safe(plg, tmp, hlist, plg_list) {
 611                 //check that plugin is active
 612                 if(!SMFS_IS(smb->plg_flags, plg->plg_type) &&
 613                    !(op == PLG_START || op == PLG_EXIT))
 614                         continue;
 615
 616                 if (plg->plg_helper)
 617                        rc += plg->plg_helper(op, sb, msg, plg->plg_private);
 618         }
 619         up_read(&smb->plg_sem);
 620         //EXIT;
 621
 622         return rc;
 623 }
 624
 625 void * smfs_get_plg_priv(struct smfs_super_info * smb, int type)
 626 {
 627         struct list_head *hlist = &smb->smsi_plg_list;
 628         struct smfs_plugin *plg, *tmp;
 629
 630         list_for_each_entry_safe(plg, tmp, hlist, plg_list) {
 631                 if (plg->plg_type == type) {
 632                         return (plg->plg_private);
 633                 }
 634         }
 635
 636         EXIT;
 637
 638         return NULL;
 639 }
 640