fs/ocfs2/dlm/dlmfs.c

   1 /* -*- mode: c; c-basic-offset: 8; -*-
   2  * vim: noexpandtab sw=8 ts=8 sts=0:
   3  *
   4  * dlmfs.c
   5  *
   6  * Code which implements the kernel side of a minimal userspace
   7  * interface to our DLM. This file handles the virtual file system
   8  * used for communication with userspace. Credit should go to ramfs,
   9  * which was a template for the fs side of this module.
  10  *
  11  * Copyright (C) 2003, 2004 Oracle.  All rights reserved.
  12  *
  13  * This program is free software; you can redistribute it and/or
  14  * modify it under the terms of the GNU General Public
  15  * License as published by the Free Software Foundation; either
  16  * version 2 of the License, or (at your option) any later version.
  17  *
  18  * This program is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  21  * General Public License for more details.
  22  *
  23  * You should have received a copy of the GNU General Public
  24  * License along with this program; if not, write to the
  25  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  26  * Boston, MA 021110-1307, USA.
  27  */
  28
  29 /* Simple VFS hooks based on: */
  30 /*
  31  * Resizable simple ram filesystem for Linux.
  32  *
  33  * Copyright (C) 2000 Linus Torvalds.
  34  *               2000 Transmeta Corp.
  35  */
  36
  37 #include <linux/module.h>
  38 #include <linux/fs.h>
  39 #include <linux/pagemap.h>
  40 #include <linux/types.h>
  41 #include <linux/slab.h>
  42 #include <linux/highmem.h>
  43 #include <linux/init.h>
  44 #include <linux/string.h>
  45 #include <linux/smp_lock.h>
  46 #include <linux/backing-dev.h>
  47 #include <linux/vs_tag.h>
  48
  49 #include <asm/uaccess.h>
  50
  51
  52 #include "cluster/nodemanager.h"
  53 #include "cluster/heartbeat.h"
  54 #include "cluster/tcp.h"
  55
  56 #include "dlmapi.h"
  57
  58 #include "userdlm.h"
  59
  60 #include "dlmfsver.h"
  61
  62 #define MLOG_MASK_PREFIX ML_DLMFS
  63 #include "cluster/masklog.h"
  64
  65 static struct super_operations dlmfs_ops;
  66 static struct file_operations dlmfs_file_operations;
  67 static struct inode_operations dlmfs_dir_inode_operations;
  68 static struct inode_operations dlmfs_root_inode_operations;
  69 static struct inode_operations dlmfs_file_inode_operations;
  70 static struct kmem_cache *dlmfs_inode_cache;
  71
  72 struct workqueue_struct *user_dlm_worker;
  73
  74 /*
  75  * decodes a set of open flags into a valid lock level and a set of flags.
  76  * returns < 0 if we have invalid flags
  77  * flags which mean something to us:
  78  * O_RDONLY -> PRMODE level
  79  * O_WRONLY -> EXMODE level
  80  *
  81  * O_NONBLOCK -> LKM_NOQUEUE
  82  */
  83 static int dlmfs_decode_open_flags(int open_flags,
  84                                    int *level,
  85                                    int *flags)
  86 {
  87         if (open_flags & (O_WRONLY|O_RDWR))
  88                 *level = LKM_EXMODE;
  89         else
  90                 *level = LKM_PRMODE;
  91
  92         *flags = 0;
  93         if (open_flags & O_NONBLOCK)
  94                 *flags |= LKM_NOQUEUE;
  95
  96         return 0;
  97 }
  98
  99 static int dlmfs_file_open(struct inode *inode,
 100                            struct file *file)
 101 {
 102         int status, level, flags;
 103         struct dlmfs_filp_private *fp = NULL;
 104         struct dlmfs_inode_private *ip;
 105
 106         if (S_ISDIR(inode->i_mode))
 107                 BUG();
 108
 109         mlog(0, "open called on inode %lu, flags 0x%x\n", inode->i_ino,
 110                 file->f_flags);
 111
 112         status = dlmfs_decode_open_flags(file->f_flags, &level, &flags);
 113         if (status < 0)
 114                 goto bail;
 115
 116         /* We don't want to honor O_APPEND at read/write time as it
 117          * doesn't make sense for LVB writes. */
 118         file->f_flags &= ~O_APPEND;
 119
 120         fp = kmalloc(sizeof(*fp), GFP_NOFS);
 121         if (!fp) {
 122                 status = -ENOMEM;
 123                 goto bail;
 124         }
 125         fp->fp_lock_level = level;
 126
 127         ip = DLMFS_I(inode);
 128
 129         status = user_dlm_cluster_lock(&ip->ip_lockres, level, flags);
 130         if (status < 0) {
 131                 /* this is a strange error to return here but I want
 132                  * to be able userspace to be able to distinguish a
 133                  * valid lock request from one that simply couldn't be
 134                  * granted. */
 135                 if (flags & LKM_NOQUEUE && status == -EAGAIN)
 136                         status = -ETXTBSY;
 137                 kfree(fp);
 138                 goto bail;
 139         }
 140
 141         file->private_data = fp;
 142 bail:
 143         return status;
 144 }
 145
 146 static int dlmfs_file_release(struct inode *inode,
 147                               struct file *file)
 148 {
 149         int level, status;
 150         struct dlmfs_inode_private *ip = DLMFS_I(inode);
 151         struct dlmfs_filp_private *fp =
 152                 (struct dlmfs_filp_private *) file->private_data;
 153
 154         if (S_ISDIR(inode->i_mode))
 155                 BUG();
 156
 157         mlog(0, "close called on inode %lu\n", inode->i_ino);
 158
 159         status = 0;
 160         if (fp) {
 161                 level = fp->fp_lock_level;
 162                 if (level != LKM_IVMODE)
 163                         user_dlm_cluster_unlock(&ip->ip_lockres, level);
 164
 165                 kfree(fp);
 166                 file->private_data = NULL;
 167         }
 168
 169         return 0;
 170 }
 171
 172 static ssize_t dlmfs_file_read(struct file *filp,
 173                                char __user *buf,
 174                                size_t count,
 175                                loff_t *ppos)
 176 {
 177         int bytes_left;
 178         ssize_t readlen;
 179         char *lvb_buf;
 180         struct inode *inode = filp->f_path.dentry->d_inode;
 181
 182         mlog(0, "inode %lu, count = %zu, *ppos = %llu\n",
 183                 inode->i_ino, count, *ppos);
 184
 185         if (*ppos >= i_size_read(inode))
 186                 return 0;
 187
 188         if (!count)
 189                 return 0;
 190
 191         if (!access_ok(VERIFY_WRITE, buf, count))
 192                 return -EFAULT;
 193
 194         /* don't read past the lvb */
 195         if ((count + *ppos) > i_size_read(inode))
 196                 readlen = i_size_read(inode) - *ppos;
 197         else
 198                 readlen = count - *ppos;
 199
 200         lvb_buf = kmalloc(readlen, GFP_NOFS);
 201         if (!lvb_buf)
 202                 return -ENOMEM;
 203
 204         user_dlm_read_lvb(inode, lvb_buf, readlen);
 205         bytes_left = __copy_to_user(buf, lvb_buf, readlen);
 206         readlen -= bytes_left;
 207
 208         kfree(lvb_buf);
 209
 210         *ppos = *ppos + readlen;
 211
 212         mlog(0, "read %zd bytes\n", readlen);
 213         return readlen;
 214 }
 215
 216 static ssize_t dlmfs_file_write(struct file *filp,
 217                                 const char __user *buf,
 218                                 size_t count,
 219                                 loff_t *ppos)
 220 {
 221         int bytes_left;
 222         ssize_t writelen;
 223         char *lvb_buf;
 224         struct inode *inode = filp->f_path.dentry->d_inode;
 225
 226         mlog(0, "inode %lu, count = %zu, *ppos = %llu\n",
 227                 inode->i_ino, count, *ppos);
 228
 229         if (*ppos >= i_size_read(inode))
 230                 return -ENOSPC;
 231
 232         if (!count)
 233                 return 0;
 234
 235         if (!access_ok(VERIFY_READ, buf, count))
 236                 return -EFAULT;
 237
 238         /* don't write past the lvb */
 239         if ((count + *ppos) > i_size_read(inode))
 240                 writelen = i_size_read(inode) - *ppos;
 241         else
 242                 writelen = count - *ppos;
 243
 244         lvb_buf = kmalloc(writelen, GFP_NOFS);
 245         if (!lvb_buf)
 246                 return -ENOMEM;
 247
 248         bytes_left = copy_from_user(lvb_buf, buf, writelen);
 249         writelen -= bytes_left;
 250         if (writelen)
 251                 user_dlm_write_lvb(inode, lvb_buf, writelen);
 252
 253         kfree(lvb_buf);
 254
 255         *ppos = *ppos + writelen;
 256         mlog(0, "wrote %zd bytes\n", writelen);
 257         return writelen;
 258 }
 259
 260 static void dlmfs_init_once(void *foo,
 261                             struct kmem_cache *cachep,
 262                             unsigned long flags)
 263 {
 264         struct dlmfs_inode_private *ip =
 265                 (struct dlmfs_inode_private *) foo;
 266
 267         if ((flags & (SLAB_CTOR_VERIFY|SLAB_CTOR_CONSTRUCTOR)) ==
 268             SLAB_CTOR_CONSTRUCTOR) {
 269                 ip->ip_dlm = NULL;
 270                 ip->ip_parent = NULL;
 271
 272                 inode_init_once(&ip->ip_vfs_inode);
 273         }
 274 }
 275
 276 static struct inode *dlmfs_alloc_inode(struct super_block *sb)
 277 {
 278         struct dlmfs_inode_private *ip;
 279
 280         ip = kmem_cache_alloc(dlmfs_inode_cache, GFP_NOFS);
 281         if (!ip)
 282                 return NULL;
 283
 284         return &ip->ip_vfs_inode;
 285 }
 286
 287 static void dlmfs_destroy_inode(struct inode *inode)
 288 {
 289         kmem_cache_free(dlmfs_inode_cache, DLMFS_I(inode));
 290 }
 291
 292 static void dlmfs_clear_inode(struct inode *inode)
 293 {
 294         int status;
 295         struct dlmfs_inode_private *ip;
 296
 297         if (!inode)
 298                 return;
 299
 300         mlog(0, "inode %lu\n", inode->i_ino);
 301
 302         ip = DLMFS_I(inode);
 303
 304         if (S_ISREG(inode->i_mode)) {
 305                 status = user_dlm_destroy_lock(&ip->ip_lockres);
 306                 if (status < 0)
 307                         mlog_errno(status);
 308                 iput(ip->ip_parent);
 309                 goto clear_fields;
 310         }
 311
 312         mlog(0, "we're a directory, ip->ip_dlm = 0x%p\n", ip->ip_dlm);
 313         /* we must be a directory. If required, lets unregister the
 314          * dlm context now. */
 315         if (ip->ip_dlm)
 316                 user_dlm_unregister_context(ip->ip_dlm);
 317 clear_fields:
 318         ip->ip_parent = NULL;
 319         ip->ip_dlm = NULL;
 320 }
 321
 322 static struct backing_dev_info dlmfs_backing_dev_info = {
 323         .ra_pages       = 0,    /* No readahead */
 324         .capabilities   = BDI_CAP_NO_ACCT_DIRTY | BDI_CAP_NO_WRITEBACK,
 325 };
 326
 327 static struct inode *dlmfs_get_root_inode(struct super_block *sb)
 328 {
 329         struct inode *inode = new_inode(sb);
 330         int mode = S_IFDIR | 0755;
 331         struct dlmfs_inode_private *ip;
 332
 333         if (inode) {
 334                 ip = DLMFS_I(inode);
 335
 336                 inode->i_mode = mode;
 337                 inode->i_uid = current->fsuid;
 338                 inode->i_gid = current->fsgid;
 339                 inode->i_tag = dx_current_fstag(sb);
 340                 inode->i_blocks = 0;
 341                 inode->i_mapping->backing_dev_info = &dlmfs_backing_dev_info;
 342                 inode->i_atime = inode->i_mtime = inode->i_ctime = CURRENT_TIME;
 343                 inc_nlink(inode);
 344
 345                 inode->i_fop = &simple_dir_operations;
 346                 inode->i_op = &dlmfs_root_inode_operations;
 347         }
 348
 349         return inode;
 350 }
 351
 352 static struct inode *dlmfs_get_inode(struct inode *parent,
 353                                      struct dentry *dentry,
 354                                      int mode)
 355 {
 356         struct super_block *sb = parent->i_sb;
 357         struct inode * inode = new_inode(sb);
 358         struct dlmfs_inode_private *ip;
 359
 360         if (!inode)
 361                 return NULL;
 362
 363         inode->i_mode = mode;
 364         inode->i_uid = current->fsuid;
 365         inode->i_gid = current->fsgid;
 366         inode->i_tag = dx_current_fstag(sb);
 367         inode->i_blocks = 0;
 368         inode->i_mapping->backing_dev_info = &dlmfs_backing_dev_info;
 369         inode->i_atime = inode->i_mtime = inode->i_ctime = CURRENT_TIME;
 370
 371         ip = DLMFS_I(inode);
 372         ip->ip_dlm = DLMFS_I(parent)->ip_dlm;
 373
 374         switch (mode & S_IFMT) {
 375         default:
 376                 /* for now we don't support anything other than
 377                  * directories and regular files. */
 378                 BUG();
 379                 break;
 380         case S_IFREG:
 381                 inode->i_op = &dlmfs_file_inode_operations;
 382                 inode->i_fop = &dlmfs_file_operations;
 383
 384                 i_size_write(inode,  DLM_LVB_LEN);
 385
 386                 user_dlm_lock_res_init(&ip->ip_lockres, dentry);
 387
 388                 /* released at clear_inode time, this insures that we
 389                  * get to drop the dlm reference on each lock *before*
 390                  * we call the unregister code for releasing parent
 391                  * directories. */
 392                 ip->ip_parent = igrab(parent);
 393                 BUG_ON(!ip->ip_parent);
 394                 break;
 395         case S_IFDIR:
 396                 inode->i_op = &dlmfs_dir_inode_operations;
 397                 inode->i_fop = &simple_dir_operations;
 398
 399                 /* directory inodes start off with i_nlink ==
 400                  * 2 (for "." entry) */
 401                 inc_nlink(inode);
 402                 break;
 403         }
 404
 405         if (parent->i_mode & S_ISGID) {
 406                 inode->i_gid = parent->i_gid;
 407                 if (S_ISDIR(mode))
 408                         inode->i_mode |= S_ISGID;
 409         }
 410
 411         return inode;
 412 }
 413
 414 /*
 415  * File creation. Allocate an inode, and we're done..
 416  */
 417 /* SMP-safe */
 418 static int dlmfs_mkdir(struct inode * dir,
 419                        struct dentry * dentry,
 420                        int mode)
 421 {
 422         int status;
 423         struct inode *inode = NULL;
 424         struct qstr *domain = &dentry->d_name;
 425         struct dlmfs_inode_private *ip;
 426         struct dlm_ctxt *dlm;
 427
 428         mlog(0, "mkdir %.*s\n", domain->len, domain->name);
 429
 430         /* verify that we have a proper domain */
 431         if (domain->len >= O2NM_MAX_NAME_LEN) {
 432                 status = -EINVAL;
 433                 mlog(ML_ERROR, "invalid domain name for directory.\n");
 434                 goto bail;
 435         }
 436
 437         inode = dlmfs_get_inode(dir, dentry, mode | S_IFDIR);
 438         if (!inode) {
 439                 status = -ENOMEM;
 440                 mlog_errno(status);
 441                 goto bail;
 442         }
 443
 444         ip = DLMFS_I(inode);
 445
 446         dlm = user_dlm_register_context(domain);
 447         if (IS_ERR(dlm)) {
 448                 status = PTR_ERR(dlm);
 449                 mlog(ML_ERROR, "Error %d could not register domain \"%.*s\"\n",
 450                      status, domain->len, domain->name);
 451                 goto bail;
 452         }
 453         ip->ip_dlm = dlm;
 454
 455         inc_nlink(dir);
 456         d_instantiate(dentry, inode);
 457         dget(dentry);   /* Extra count - pin the dentry in core */
 458
 459         status = 0;
 460 bail:
 461         if (status < 0)
 462                 iput(inode);
 463         return status;
 464 }
 465
 466 static int dlmfs_create(struct inode *dir,
 467                         struct dentry *dentry,
 468                         int mode,
 469                         struct nameidata *nd)
 470 {
 471         int status = 0;
 472         struct inode *inode;
 473         struct qstr *name = &dentry->d_name;
 474
 475         mlog(0, "create %.*s\n", name->len, name->name);
 476
 477         /* verify name is valid and doesn't contain any dlm reserved
 478          * characters */
 479         if (name->len >= USER_DLM_LOCK_ID_MAX_LEN ||
 480             name->name[0] == '$') {
 481                 status = -EINVAL;
 482                 mlog(ML_ERROR, "invalid lock name, %.*s\n", name->len,
 483                      name->name);
 484                 goto bail;
 485         }
 486
 487         inode = dlmfs_get_inode(dir, dentry, mode | S_IFREG);
 488         if (!inode) {
 489                 status = -ENOMEM;
 490                 mlog_errno(status);
 491                 goto bail;
 492         }
 493
 494         d_instantiate(dentry, inode);
 495         dget(dentry);   /* Extra count - pin the dentry in core */
 496 bail:
 497         return status;
 498 }
 499
 500 static int dlmfs_unlink(struct inode *dir,
 501                         struct dentry *dentry)
 502 {
 503         int status;
 504         struct inode *inode = dentry->d_inode;
 505
 506         mlog(0, "unlink inode %lu\n", inode->i_ino);
 507
 508         /* if there are no current holders, or none that are waiting
 509          * to acquire a lock, this basically destroys our lockres. */
 510         status = user_dlm_destroy_lock(&DLMFS_I(inode)->ip_lockres);
 511         if (status < 0) {
 512                 mlog(ML_ERROR, "unlink %.*s, error %d from destroy\n",
 513                      dentry->d_name.len, dentry->d_name.name, status);
 514                 goto bail;
 515         }
 516         status = simple_unlink(dir, dentry);
 517 bail:
 518         return status;
 519 }
 520
 521 static int dlmfs_fill_super(struct super_block * sb,
 522                             void * data,
 523                             int silent)
 524 {
 525         struct inode * inode;
 526         struct dentry * root;
 527
 528         sb->s_maxbytes = MAX_LFS_FILESIZE;
 529         sb->s_blocksize = PAGE_CACHE_SIZE;
 530         sb->s_blocksize_bits = PAGE_CACHE_SHIFT;
 531         sb->s_magic = DLMFS_MAGIC;
 532         sb->s_op = &dlmfs_ops;
 533         inode = dlmfs_get_root_inode(sb);
 534         if (!inode)
 535                 return -ENOMEM;
 536
 537         root = d_alloc_root(inode);
 538         if (!root) {
 539                 iput(inode);
 540                 return -ENOMEM;
 541         }
 542         sb->s_root = root;
 543         return 0;
 544 }
 545
 546 static struct file_operations dlmfs_file_operations = {
 547         .open           = dlmfs_file_open,
 548         .release        = dlmfs_file_release,
 549         .read           = dlmfs_file_read,
 550         .write          = dlmfs_file_write,
 551 };
 552
 553 static struct inode_operations dlmfs_dir_inode_operations = {
 554         .create         = dlmfs_create,
 555         .lookup         = simple_lookup,
 556         .unlink         = dlmfs_unlink,
 557 };
 558
 559 /* this way we can restrict mkdir to only the toplevel of the fs. */
 560 static struct inode_operations dlmfs_root_inode_operations = {
 561         .lookup         = simple_lookup,
 562         .mkdir          = dlmfs_mkdir,
 563         .rmdir          = simple_rmdir,
 564 };
 565
 566 static struct super_operations dlmfs_ops = {
 567         .statfs         = simple_statfs,
 568         .alloc_inode    = dlmfs_alloc_inode,
 569         .destroy_inode  = dlmfs_destroy_inode,
 570         .clear_inode    = dlmfs_clear_inode,
 571         .drop_inode     = generic_delete_inode,
 572 };
 573
 574 static struct inode_operations dlmfs_file_inode_operations = {
 575         .getattr        = simple_getattr,
 576 };
 577
 578 static int dlmfs_get_sb(struct file_system_type *fs_type,
 579         int flags, const char *dev_name, void *data, struct vfsmount *mnt)
 580 {
 581         return get_sb_nodev(fs_type, flags, data, dlmfs_fill_super, mnt);
 582 }
 583
 584 static struct file_system_type dlmfs_fs_type = {
 585         .owner          = THIS_MODULE,
 586         .name           = "ocfs2_dlmfs",
 587         .get_sb         = dlmfs_get_sb,
 588         .kill_sb        = kill_litter_super,
 589 };
 590
 591 static int __init init_dlmfs_fs(void)
 592 {
 593         int status;
 594         int cleanup_inode = 0, cleanup_worker = 0;
 595
 596         dlmfs_print_version();
 597
 598         dlmfs_inode_cache = kmem_cache_create("dlmfs_inode_cache",
 599                                 sizeof(struct dlmfs_inode_private),
 600                                 0, (SLAB_HWCACHE_ALIGN|SLAB_RECLAIM_ACCOUNT|
 601                                         SLAB_MEM_SPREAD),
 602                                 dlmfs_init_once, NULL);
 603         if (!dlmfs_inode_cache)
 604                 return -ENOMEM;
 605         cleanup_inode = 1;
 606
 607         user_dlm_worker = create_singlethread_workqueue("user_dlm");
 608         if (!user_dlm_worker) {
 609                 status = -ENOMEM;
 610                 goto bail;
 611         }
 612         cleanup_worker = 1;
 613
 614         status = register_filesystem(&dlmfs_fs_type);
 615 bail:
 616         if (status) {
 617                 if (cleanup_inode)
 618                         kmem_cache_destroy(dlmfs_inode_cache);
 619                 if (cleanup_worker)
 620                         destroy_workqueue(user_dlm_worker);
 621         } else
 622                 printk("OCFS2 User DLM kernel interface loaded\n");
 623         return status;
 624 }
 625
 626 static void __exit exit_dlmfs_fs(void)
 627 {
 628         unregister_filesystem(&dlmfs_fs_type);
 629
 630         flush_workqueue(user_dlm_worker);
 631         destroy_workqueue(user_dlm_worker);
 632
 633         kmem_cache_destroy(dlmfs_inode_cache);
 634 }
 635
 636 MODULE_AUTHOR("Oracle");
 637 MODULE_LICENSE("GPL");
 638
 639 module_init(init_dlmfs_fs)
 640 module_exit(exit_dlmfs_fs)