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         /* enable plugins for all in O */
 176         SMFS_SET(I2SMI(o_dir)->smi_flags, SMFS_PLG_ALL);
 177         /* enable plugins for all already created d<n> dirs */
 178         for (j = 1; j < filt->fo_group_count; j++) {
 179                 for (i = 0; i < filt->fo_subdir_count; i++) {
 180                         dentry = (filt->fo_subdirs + j)->dentry[i];
 181                         SMFS_SET(I2SMI(dentry->d_inode)->smi_flags,
 182                                          SMFS_PLG_ALL);
 183                 }
 184         }
 185 }
 186
 187 static void smfs_mds_flags(struct mds_obd *mds, struct inode *root)
 188 {
 189         struct inode *pend = mds->mds_pending_dir->d_inode;
 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
 196         /* the same for PENDING */
 197         SMFS_SET(I2SMI(pend)->smi_flags, SMFS_PLG_ALL);
 198 }
 199
 200 extern int (*audit_id2name_superhack) (struct obd_device *obd, char **name,
 201                                        int *namelen, struct lustre_id *id);
 202
 203 int smfs_post_setup(struct obd_device *obd, struct vfsmount *mnt,
 204                     struct dentry *root_dentry)
 205 {
 206         struct lvfs_run_ctxt saved, *current_ctxt = NULL;
 207         struct smfs_super_info *smb = S2SMI(mnt->mnt_sb);
 208         int rc = 0;
 209         ENTRY;
 210
 211         /* XXX to register id2name function of mds in smfs */
 212         //if (data != NULL)
 213         //        audit_id2name_superhack = data;
 214
 215         OBD_ALLOC(current_ctxt, sizeof(*current_ctxt));
 216         if (!current_ctxt)
 217                 RETURN(-ENOMEM);
 218
 219         OBD_SET_CTXT_MAGIC(current_ctxt);
 220
 221         current_ctxt->pwdmnt = mnt;
 222         current_ctxt->pwd = mnt->mnt_root;
 223         current_ctxt->fs = get_ds();
 224         smb->smsi_ctxt = current_ctxt;
 225
 226         push_ctxt(&saved, smb->smsi_ctxt, NULL);
 227
 228         rc = smfs_llog_setup(&smb->smsi_logs_dir, &smb->smsi_objects_dir);
 229         if (!rc)
 230                 rc = SMFS_PLG_HELP(mnt->mnt_sb, PLG_START, obd);
 231
 232         pop_ctxt(&saved, smb->smsi_ctxt, NULL);
 233
 234         /* enable plugins for directories on MDS or OST */
 235         if (obd && obd->obd_type && obd->obd_type->typ_name) {
 236                 if (!strcmp(obd->obd_type->typ_name, OBD_FILTER_DEVICENAME)) {
 237                         struct filter_obd *filt = &obd->u.filter;
 238                         smfs_filter_flags(filt, root_dentry->d_inode);
 239                 } else if (!strcmp(obd->obd_type->typ_name, OBD_MDS_DEVICENAME)) {
 240                         struct mds_obd * mds = &obd->u.mds;
 241                         smfs_mds_flags(mds, root_dentry->d_inode);
 242                         SMFS_SET_HND_IBLOCKS(smb);
 243                 } else {
 244                         CDEBUG(D_SUPER,"Unknown OBD (%s) post_setup\n",
 245                                obd->obd_type->typ_name);
 246                 }
 247         }
 248
 249         if (rc)
 250                 OBD_FREE(current_ctxt, sizeof(*current_ctxt));
 251
 252         RETURN(rc);
 253 }
 254
 255 void smfs_post_cleanup(struct super_block *sb)
 256 {
 257         struct smfs_super_info *smb = S2SMI(sb);
 258
 259         ENTRY;
 260
 261         smfs_llog_cleanup(smb);
 262         SMFS_PLG_HELP(sb, PLG_STOP, NULL);
 263
 264         if (smb->smsi_ctxt)
 265                 OBD_FREE(smb->smsi_ctxt, sizeof(struct lvfs_run_ctxt));
 266
 267         EXIT;
 268 }
 269
 270 static int smfs_mount_cache(struct smfs_super_info *smb, char *devstr,
 271                             char *typestr, char *opts)
 272 {
 273         int err = 0, typelen;
 274         struct vfsmount *mnt;
 275         ENTRY;
 276
 277         typelen = strlen(typestr);
 278
 279         CDEBUG(D_INODE, "smfs: mounting %s at %s\n", typestr, devstr);
 280
 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_AUDIT))
 334                 smfs_init_audit(sb);
 335         if (SMFS_IS(flags, SMFS_PLG_KML))
 336                 smfs_init_kml(sb);
 337         if (SMFS_IS(flags, SMFS_PLG_LRU))
 338                 smfs_init_lru(sb);
 339 #if CONFIG_SNAPFS
 340         if (SMFS_IS(flags, SMFS_PLG_COW))
 341                 smfs_init_cow(sb);
 342 #endif
 343         RETURN(0);
 344 }
 345
 346 static void smfs_remove_plugins(struct super_block *sb)
 347 {
 348         struct smfs_plugin * plg, *tmp;
 349         struct smfs_super_info *smb = S2SMI(sb);
 350         struct list_head * plist = &smb->smsi_plg_list;
 351
 352         ENTRY;
 353
 354         list_for_each_entry_safe(plg, tmp, plist, plg_list) {
 355                 plg->plg_exit(sb, plg->plg_private);
 356         }
 357
 358         EXIT;
 359 }
 360
 361 void smfs_put_super(struct super_block *sb)
 362 {
 363         struct smfs_super_info *smb = S2SMI(sb);
 364         ENTRY;
 365         smfs_remove_plugins(sb);
 366
 367         dput(sb->s_root);
 368
 369         if (smb->smsi_mnt)
 370                 smfs_umount_cache(smb);
 371
 372         smfs_cleanup_smb(smb);
 373         EXIT;
 374 }
 375
 376 int smfs_fill_super(struct super_block *sb, void *data, int silent)
 377 {
 378         struct inode *root_inode = NULL;
 379         struct inode *back_root_inode = NULL;
 380         struct smfs_super_info *smb = NULL;
 381         char *devstr = NULL, *typestr = NULL;
 382         unsigned long page = 0;
 383         char *opts = NULL;
 384         int flags = 0;
 385         int err = 0;
 386
 387         ENTRY;
 388
 389         if (!data) {
 390                 CERROR("no mount options. At least name and dev are needed\n");
 391                 err = -EINVAL;
 392                 goto out_err;
 393         }
 394
 395         CDEBUG(D_SUPER, "mount opts: %s\n", (char *)data);
 396
 397         smb = smfs_init_smb(sb);
 398         if (!smb)
 399                 RETURN(-ENOMEM);
 400
 401         lock_kernel();
 402
 403         /* 2.6.9 selinux wants a full option page for do_kern_mount (bug6471) */
 404         page = get_zeroed_page(GFP_KERNEL);
 405         if (!page) {
 406                 err = -ENOMEM;
 407                 goto out_err;
 408         }
 409         opts = (char *)page;
 410
 411         err = smfs_options(data, &devstr, &typestr, opts, &flags);
 412         if (err)
 413                 goto out_err;
 414
 415         if (!typestr || !devstr) {
 416                 CERROR("mount options name and dev are mandatory\n");
 417                 err = -EINVAL;
 418                 goto out_err;
 419         }
 420
 421         CDEBUG(D_SUPER, "backfs mount opts: %s\n", opts);
 422
 423         err = smfs_mount_cache(smb, devstr, typestr, opts);
 424         if (err) {
 425                 CERROR("Can not mount %s as %s\n", devstr, typestr);
 426                 goto out_err;
 427         }
 428
 429         free_page(page);
 430         page = 0;
 431
 432         duplicate_sb(sb, smb->smsi_sb);
 433         sb->s_bdev = smb->smsi_sb->s_bdev;
 434         sm_set_sb_ops(smb->smsi_sb, sb);
 435
 436         /* init the root_inode of smfs. */
 437         back_root_inode = S2CSB(sb)->s_root->d_inode;
 438         root_inode = smfs_get_inode(sb, back_root_inode, NULL, 0);
 439
 440         CDEBUG(D_SUPER, "readinode %p, root ino %ld, root inode at %p\n",
 441                sb->s_op->read_inode, root_inode->i_ino, root_inode);
 442
 443         sb->s_root = d_alloc_root(root_inode);
 444         if (!sb->s_root) {
 445                 err = -ENOMEM;
 446                 goto out_err;
 447         }
 448
 449         /* all entries created until post_setup() should not be logged */
 450         SMFS_CLEAR((I2SMI(root_inode))->smi_flags, SMFS_PLG_ALL);
 451
 452 #if (LINUX_VERSION_CODE < KERNEL_VERSION(2,5,0))
 453         CDEBUG(D_SUPER, "sb %lx, &sb->u.generic_sbp: %lx\n",
 454                (ulong)sb, (ulong)&sb->u.generic_sbp);
 455 #else
 456         CDEBUG(D_SUPER, "sb %lx(%p), &sb->s_fs_info: %lx\n",
 457                (ulong)sb, smb->smsi_sb, (ulong)&sb->s_fs_info);
 458 #endif
 459
 460         smfs_init_plugins(sb, flags);
 461         unlock_kernel();
 462         RETURN (0);
 463 out_err:
 464         if (smb->smsi_mnt)
 465                 smfs_umount_cache(smb);
 466
 467         if (page)
 468                 free_page(page);
 469
 470         smfs_cleanup_smb(smb);
 471         unlock_kernel();
 472         RETURN(err);
 473 }
 474
 475 void *smfs_trans_start(struct inode *inode, int op, void *desc_private)
 476 {
 477         struct fsfilt_operations *fsfilt = S2SMI(inode->i_sb)->sm_fsfilt;
 478
 479         if (fsfilt->fs_start)
 480                 return fsfilt->fs_start(inode, op, NULL, 0);
 481         return NULL;
 482 }
 483
 484 void smfs_trans_commit(struct inode *inode, void *handle, int force_sync)
 485 {
 486         struct fsfilt_operations *fsfilt = S2SMI(inode->i_sb)->sm_fsfilt;
 487
 488         if (handle && fsfilt->fs_commit)
 489                 fsfilt->fs_commit(inode->i_sb, inode, handle, force_sync);
 490 }
 491 /* Plugin API */
 492 int smfs_register_plugin(struct super_block * sb,
 493                          struct smfs_plugin * plg)
 494 {
 495         struct smfs_plugin * tmp = NULL;
 496         struct smfs_super_info * smb = S2SMI(sb);
 497         struct list_head * plist = &smb->smsi_plg_list;
 498         int rc = 0;
 499
 500         ENTRY;
 501
 502         down_write(&smb->plg_sem);
 503         list_for_each_entry(tmp, plist, plg_list) {
 504                 if (tmp->plg_type == plg->plg_type) {
 505                         CWARN("Plugin is already registered\n");
 506                         rc = -EEXIST;
 507                         goto exit;
 508                 }
 509         }
 510
 511         list_add_tail(&plg->plg_list, plist);
 512 exit:
 513         up_write(&smb->plg_sem);
 514         RETURN(0);
 515 }
 516
 517 struct smfs_plugin * smfs_deregister_plugin(struct super_block *sb, int type)
 518 {
 519         struct smfs_plugin * plg = NULL;
 520         struct smfs_super_info *smb = S2SMI(sb);
 521         struct list_head * plist = &smb->smsi_plg_list;
 522
 523         ENTRY;
 524         down_write(&smb->plg_sem);
 525         list_for_each_entry(plg, plist, plg_list) {
 526                 if (plg->plg_type == type) {
 527                         list_del(&plg->plg_list);
 528                         break;
 529                 }
 530         }
 531         up_write(&smb->plg_sem);
 532         RETURN(plg);
 533 }
 534
 535 void smfs_pre_hook (struct inode * inode, hook_op op, void * msg)
 536 {
 537         struct smfs_super_info *smb = S2SMI(inode->i_sb);
 538         struct smfs_inode_info *smi = I2SMI(inode);
 539         struct list_head *hlist = &smb->smsi_plg_list;
 540         struct smfs_plugin *plg;
 541
 542         //ENTRY;
 543         LASSERT(op < HOOK_MAX);
 544         //call hook operations
 545         down_read(&smb->plg_sem);
 546         list_for_each_entry(plg, hlist, plg_list) {
 547                 //check that plugin is active
 548                 if(!SMFS_IS(smb->plg_flags, plg->plg_type))
 549                         continue;
 550                 //check that inode is allowed
 551                 if (!SMFS_IS(smi->smi_flags, plg->plg_type))
 552                         continue;
 553
 554                 if (plg->plg_pre_op)
 555                         plg->plg_pre_op(op, inode, msg, 0, plg->plg_private);
 556         }
 557         up_read(&smb->plg_sem);
 558         //EXIT;
 559 }
 560
 561 void smfs_post_hook (struct inode * inode, hook_op op, void * msg, int ret)
 562 {
 563         struct smfs_super_info *smb = S2SMI(inode->i_sb);
 564         //struct smfs_inode_info *smi = I2SMI(inode);
 565         struct list_head *hlist = &smb->smsi_plg_list;
 566         struct smfs_plugin *plg;
 567
 568         //ENTRY;
 569         down_read(&smb->plg_sem);
 570         list_for_each_entry(plg, hlist, plg_list) {
 571                 //check that plugin is active
 572                 if(!SMFS_IS(smb->plg_flags, plg->plg_type))
 573                         continue;
 574                 /* this will be checked inside plg_post_op()
 575                 if (!SMFS_IS(smi->smi_flags, plg->plg_type))
 576                         continue;
 577                 */
 578                 if (plg->plg_post_op)
 579                         plg->plg_post_op(op, inode, msg, ret, plg->plg_private);
 580         }
 581         up_read(&smb->plg_sem);
 582         //EXIT;
 583 }
 584
 585 int smfs_helper (struct super_block * sb, int op, void * msg)
 586 {
 587         struct smfs_super_info *smb = S2SMI(sb);
 588         struct list_head *hlist = &smb->smsi_plg_list;
 589         struct smfs_plugin *plg, *tmp;
 590         int rc = 0;
 591
 592         //ENTRY;
 593         LASSERT(op < PLG_HELPER_MAX);
 594         //call hook operations
 595         down_read(&smb->plg_sem);
 596         list_for_each_entry_safe(plg, tmp, hlist, plg_list) {
 597                 //check that plugin is active
 598                 if(!SMFS_IS(smb->plg_flags, plg->plg_type) &&
 599                    !(op == PLG_START || op == PLG_EXIT))
 600                         continue;
 601
 602                 if (plg->plg_helper)
 603                        rc += plg->plg_helper(op, sb, msg, plg->plg_private);
 604         }
 605         up_read(&smb->plg_sem);
 606         //EXIT;
 607
 608         return rc;
 609 }
 610
 611 void * smfs_get_plg_priv(struct smfs_super_info * smb, int type)
 612 {
 613         struct list_head *hlist = &smb->smsi_plg_list;
 614         struct smfs_plugin *plg, *tmp;
 615
 616         list_for_each_entry_safe(plg, tmp, hlist, plg_list) {
 617                 if (plg->plg_type == type) {
 618                         return (plg->plg_private);
 619                 }
 620         }
 621
 622         EXIT;
 623
 624         return NULL;
 625 }
 626