fs/ocfs2/dlmfs/dlmfs.c

   1 // SPDX-License-Identifier: GPL-2.0-or-later
   2 /* -*- mode: c; c-basic-offset: 8; -*-
   3  * vim: noexpandtab sw=8 ts=8 sts=0:
   4  *
   5  * dlmfs.c
   6  *
   7  * Code which implements the kernel side of a minimal userspace
   8  * interface to our DLM. This file handles the virtual file system
   9  * used for communication with userspace. Credit should go to ramfs,
  10  * which was a template for the fs side of this module.
  11  *
  12  * Copyright (C) 2003, 2004 Oracle.  All rights reserved.
  13  */
  14
  15 /* Simple VFS hooks based on: */
  16 /*
  17  * Resizable simple ram filesystem for Linux.
  18  *
  19  * Copyright (C) 2000 Linus Torvalds.
  20  *               2000 Transmeta Corp.
  21  */
  22
  23 #include <linux/module.h>
  24 #include <linux/fs.h>
  25 #include <linux/pagemap.h>
  26 #include <linux/types.h>
  27 #include <linux/slab.h>
  28 #include <linux/highmem.h>
  29 #include <linux/init.h>
  30 #include <linux/string.h>
  31 #include <linux/backing-dev.h>
  32 #include <linux/poll.h>
  33
  34 #include <linux/uaccess.h>
  35
  36 #include "../stackglue.h"
  37 #include "userdlm.h"
  38
  39 #define MLOG_MASK_PREFIX ML_DLMFS
  40 #include "../cluster/masklog.h"
  41
  42
  43 static const struct super_operations dlmfs_ops;
  44 static const struct file_operations dlmfs_file_operations;
  45 static const struct inode_operations dlmfs_dir_inode_operations;
  46 static const struct inode_operations dlmfs_root_inode_operations;
  47 static const struct inode_operations dlmfs_file_inode_operations;
  48 static struct kmem_cache *dlmfs_inode_cache;
  49
  50 struct workqueue_struct *user_dlm_worker;
  51
  52
  53
  54 /*
  55  * These are the ABI capabilities of dlmfs.
  56  *
  57  * Over time, dlmfs has added some features that were not part of the
  58  * initial ABI.  Unfortunately, some of these features are not detectable
  59  * via standard usage.  For example, Linux's default poll always returns
  60  * EPOLLIN, so there is no way for a caller of poll(2) to know when dlmfs
  61  * added poll support.  Instead, we provide this list of new capabilities.
  62  *
  63  * Capabilities is a read-only attribute.  We do it as a module parameter
  64  * so we can discover it whether dlmfs is built in, loaded, or even not
  65  * loaded.
  66  *
  67  * The ABI features are local to this machine's dlmfs mount.  This is
  68  * distinct from the locking protocol, which is concerned with inter-node
  69  * interaction.
  70  *
  71  * Capabilities:
  72  * - bast       : EPOLLIN against the file descriptor of a held lock
  73  *                signifies a bast fired on the lock.
  74  */
  75 #define DLMFS_CAPABILITIES "bast stackglue"
  76 static int param_set_dlmfs_capabilities(const char *val,
  77                                         const struct kernel_param *kp)
  78 {
  79         printk(KERN_ERR "%s: readonly parameter\n", kp->name);
  80         return -EINVAL;
  81 }
  82 static int param_get_dlmfs_capabilities(char *buffer,
  83                                         const struct kernel_param *kp)
  84 {
  85         return strlcpy(buffer, DLMFS_CAPABILITIES,
  86                        strlen(DLMFS_CAPABILITIES) + 1);
  87 }
  88 module_param_call(capabilities, param_set_dlmfs_capabilities,
  89                   param_get_dlmfs_capabilities, NULL, 0444);
  90 MODULE_PARM_DESC(capabilities, DLMFS_CAPABILITIES);
  91
  92
  93 /*
  94  * decodes a set of open flags into a valid lock level and a set of flags.
  95  * returns < 0 if we have invalid flags
  96  * flags which mean something to us:
  97  * O_RDONLY -> PRMODE level
  98  * O_WRONLY -> EXMODE level
  99  *
 100  * O_NONBLOCK -> NOQUEUE
 101  */
 102 static int dlmfs_decode_open_flags(int open_flags,
 103                                    int *level,
 104                                    int *flags)
 105 {
 106         if (open_flags & (O_WRONLY|O_RDWR))
 107                 *level = DLM_LOCK_EX;
 108         else
 109                 *level = DLM_LOCK_PR;
 110
 111         *flags = 0;
 112         if (open_flags & O_NONBLOCK)
 113                 *flags |= DLM_LKF_NOQUEUE;
 114
 115         return 0;
 116 }
 117
 118 static int dlmfs_file_open(struct inode *inode,
 119                            struct file *file)
 120 {
 121         int status, level, flags;
 122         struct dlmfs_filp_private *fp = NULL;
 123         struct dlmfs_inode_private *ip;
 124
 125         if (S_ISDIR(inode->i_mode))
 126                 BUG();
 127
 128         mlog(0, "open called on inode %lu, flags 0x%x\n", inode->i_ino,
 129                 file->f_flags);
 130
 131         status = dlmfs_decode_open_flags(file->f_flags, &level, &flags);
 132         if (status < 0)
 133                 goto bail;
 134
 135         /* We don't want to honor O_APPEND at read/write time as it
 136          * doesn't make sense for LVB writes. */
 137         file->f_flags &= ~O_APPEND;
 138
 139         fp = kmalloc(sizeof(*fp), GFP_NOFS);
 140         if (!fp) {
 141                 status = -ENOMEM;
 142                 goto bail;
 143         }
 144         fp->fp_lock_level = level;
 145
 146         ip = DLMFS_I(inode);
 147
 148         status = user_dlm_cluster_lock(&ip->ip_lockres, level, flags);
 149         if (status < 0) {
 150                 /* this is a strange error to return here but I want
 151                  * to be able userspace to be able to distinguish a
 152                  * valid lock request from one that simply couldn't be
 153                  * granted. */
 154                 if (flags & DLM_LKF_NOQUEUE && status == -EAGAIN)
 155                         status = -ETXTBSY;
 156                 kfree(fp);
 157                 goto bail;
 158         }
 159
 160         file->private_data = fp;
 161 bail:
 162         return status;
 163 }
 164
 165 static int dlmfs_file_release(struct inode *inode,
 166                               struct file *file)
 167 {
 168         int level;
 169         struct dlmfs_inode_private *ip = DLMFS_I(inode);
 170         struct dlmfs_filp_private *fp = file->private_data;
 171
 172         if (S_ISDIR(inode->i_mode))
 173                 BUG();
 174
 175         mlog(0, "close called on inode %lu\n", inode->i_ino);
 176
 177         if (fp) {
 178                 level = fp->fp_lock_level;
 179                 if (level != DLM_LOCK_IV)
 180                         user_dlm_cluster_unlock(&ip->ip_lockres, level);
 181
 182                 kfree(fp);
 183                 file->private_data = NULL;
 184         }
 185
 186         return 0;
 187 }
 188
 189 /*
 190  * We do ->setattr() just to override size changes.  Our size is the size
 191  * of the LVB and nothing else.
 192  */
 193 static int dlmfs_file_setattr(struct dentry *dentry, struct iattr *attr)
 194 {
 195         int error;
 196         struct inode *inode = d_inode(dentry);
 197
 198         attr->ia_valid &= ~ATTR_SIZE;
 199         error = setattr_prepare(dentry, attr);
 200         if (error)
 201                 return error;
 202
 203         setattr_copy(inode, attr);
 204         mark_inode_dirty(inode);
 205         return 0;
 206 }
 207
 208 static __poll_t dlmfs_file_poll(struct file *file, poll_table *wait)
 209 {
 210         __poll_t event = 0;
 211         struct inode *inode = file_inode(file);
 212         struct dlmfs_inode_private *ip = DLMFS_I(inode);
 213
 214         poll_wait(file, &ip->ip_lockres.l_event, wait);
 215
 216         spin_lock(&ip->ip_lockres.l_lock);
 217         if (ip->ip_lockres.l_flags & USER_LOCK_BLOCKED)
 218                 event = EPOLLIN | EPOLLRDNORM;
 219         spin_unlock(&ip->ip_lockres.l_lock);
 220
 221         return event;
 222 }
 223
 224 static ssize_t dlmfs_file_read(struct file *filp,
 225                                char __user *buf,
 226                                size_t count,
 227                                loff_t *ppos)
 228 {
 229         int bytes_left;
 230         ssize_t readlen, got;
 231         char *lvb_buf;
 232         struct inode *inode = file_inode(filp);
 233
 234         mlog(0, "inode %lu, count = %zu, *ppos = %llu\n",
 235                 inode->i_ino, count, *ppos);
 236
 237         if (*ppos >= i_size_read(inode))
 238                 return 0;
 239
 240         if (!count)
 241                 return 0;
 242
 243         if (!access_ok(buf, count))
 244                 return -EFAULT;
 245
 246         /* don't read past the lvb */
 247         if ((count + *ppos) > i_size_read(inode))
 248                 readlen = i_size_read(inode) - *ppos;
 249         else
 250                 readlen = count;
 251
 252         lvb_buf = kmalloc(readlen, GFP_NOFS);
 253         if (!lvb_buf)
 254                 return -ENOMEM;
 255
 256         got = user_dlm_read_lvb(inode, lvb_buf, readlen);
 257         if (got) {
 258                 BUG_ON(got != readlen);
 259                 bytes_left = __copy_to_user(buf, lvb_buf, readlen);
 260                 readlen -= bytes_left;
 261         } else
 262                 readlen = 0;
 263
 264         kfree(lvb_buf);
 265
 266         *ppos = *ppos + readlen;
 267
 268         mlog(0, "read %zd bytes\n", readlen);
 269         return readlen;
 270 }
 271
 272 static ssize_t dlmfs_file_write(struct file *filp,
 273                                 const char __user *buf,
 274                                 size_t count,
 275                                 loff_t *ppos)
 276 {
 277         int bytes_left;
 278         ssize_t writelen;
 279         char *lvb_buf;
 280         struct inode *inode = file_inode(filp);
 281
 282         mlog(0, "inode %lu, count = %zu, *ppos = %llu\n",
 283                 inode->i_ino, count, *ppos);
 284
 285         if (*ppos >= i_size_read(inode))
 286                 return -ENOSPC;
 287
 288         if (!count)
 289                 return 0;
 290
 291         if (!access_ok(buf, count))
 292                 return -EFAULT;
 293
 294         /* don't write past the lvb */
 295         if ((count + *ppos) > i_size_read(inode))
 296                 writelen = i_size_read(inode) - *ppos;
 297         else
 298                 writelen = count - *ppos;
 299
 300         lvb_buf = kmalloc(writelen, GFP_NOFS);
 301         if (!lvb_buf)
 302                 return -ENOMEM;
 303
 304         bytes_left = copy_from_user(lvb_buf, buf, writelen);
 305         writelen -= bytes_left;
 306         if (writelen)
 307                 user_dlm_write_lvb(inode, lvb_buf, writelen);
 308
 309         kfree(lvb_buf);
 310
 311         *ppos = *ppos + writelen;
 312         mlog(0, "wrote %zd bytes\n", writelen);
 313         return writelen;
 314 }
 315
 316 static void dlmfs_init_once(void *foo)
 317 {
 318         struct dlmfs_inode_private *ip =
 319                 (struct dlmfs_inode_private *) foo;
 320
 321         ip->ip_conn = NULL;
 322         ip->ip_parent = NULL;
 323
 324         inode_init_once(&ip->ip_vfs_inode);
 325 }
 326
 327 static struct inode *dlmfs_alloc_inode(struct super_block *sb)
 328 {
 329         struct dlmfs_inode_private *ip;
 330
 331         ip = kmem_cache_alloc(dlmfs_inode_cache, GFP_NOFS);
 332         if (!ip)
 333                 return NULL;
 334
 335         return &ip->ip_vfs_inode;
 336 }
 337
 338 static void dlmfs_free_inode(struct inode *inode)
 339 {
 340         kmem_cache_free(dlmfs_inode_cache, DLMFS_I(inode));
 341 }
 342
 343 static void dlmfs_evict_inode(struct inode *inode)
 344 {
 345         int status;
 346         struct dlmfs_inode_private *ip;
 347
 348         clear_inode(inode);
 349
 350         mlog(0, "inode %lu\n", inode->i_ino);
 351
 352         ip = DLMFS_I(inode);
 353
 354         if (S_ISREG(inode->i_mode)) {
 355                 status = user_dlm_destroy_lock(&ip->ip_lockres);
 356                 if (status < 0)
 357                         mlog_errno(status);
 358                 iput(ip->ip_parent);
 359                 goto clear_fields;
 360         }
 361
 362         mlog(0, "we're a directory, ip->ip_conn = 0x%p\n", ip->ip_conn);
 363         /* we must be a directory. If required, lets unregister the
 364          * dlm context now. */
 365         if (ip->ip_conn)
 366                 user_dlm_unregister(ip->ip_conn);
 367 clear_fields:
 368         ip->ip_parent = NULL;
 369         ip->ip_conn = NULL;
 370 }
 371
 372 static struct inode *dlmfs_get_root_inode(struct super_block *sb)
 373 {
 374         struct inode *inode = new_inode(sb);
 375         umode_t mode = S_IFDIR | 0755;
 376
 377         if (inode) {
 378                 inode->i_ino = get_next_ino();
 379                 inode_init_owner(inode, NULL, mode);
 380                 inode->i_atime = inode->i_mtime = inode->i_ctime = current_time(inode);
 381                 inc_nlink(inode);
 382
 383                 inode->i_fop = &simple_dir_operations;
 384                 inode->i_op = &dlmfs_root_inode_operations;
 385         }
 386
 387         return inode;
 388 }
 389
 390 static struct inode *dlmfs_get_inode(struct inode *parent,
 391                                      struct dentry *dentry,
 392                                      umode_t mode)
 393 {
 394         struct super_block *sb = parent->i_sb;
 395         struct inode * inode = new_inode(sb);
 396         struct dlmfs_inode_private *ip;
 397
 398         if (!inode)
 399                 return NULL;
 400
 401         inode->i_ino = get_next_ino();
 402         inode_init_owner(inode, parent, mode);
 403         inode->i_atime = inode->i_mtime = inode->i_ctime = current_time(inode);
 404
 405         ip = DLMFS_I(inode);
 406         ip->ip_conn = DLMFS_I(parent)->ip_conn;
 407
 408         switch (mode & S_IFMT) {
 409         default:
 410                 /* for now we don't support anything other than
 411                  * directories and regular files. */
 412                 BUG();
 413                 break;
 414         case S_IFREG:
 415                 inode->i_op = &dlmfs_file_inode_operations;
 416                 inode->i_fop = &dlmfs_file_operations;
 417
 418                 i_size_write(inode,  DLM_LVB_LEN);
 419
 420                 user_dlm_lock_res_init(&ip->ip_lockres, dentry);
 421
 422                 /* released at clear_inode time, this insures that we
 423                  * get to drop the dlm reference on each lock *before*
 424                  * we call the unregister code for releasing parent
 425                  * directories. */
 426                 ip->ip_parent = igrab(parent);
 427                 BUG_ON(!ip->ip_parent);
 428                 break;
 429         case S_IFDIR:
 430                 inode->i_op = &dlmfs_dir_inode_operations;
 431                 inode->i_fop = &simple_dir_operations;
 432
 433                 /* directory inodes start off with i_nlink ==
 434                  * 2 (for "." entry) */
 435                 inc_nlink(inode);
 436                 break;
 437         }
 438         return inode;
 439 }
 440
 441 /*
 442  * File creation. Allocate an inode, and we're done..
 443  */
 444 /* SMP-safe */
 445 static int dlmfs_mkdir(struct inode * dir,
 446                        struct dentry * dentry,
 447                        umode_t mode)
 448 {
 449         int status;
 450         struct inode *inode = NULL;
 451         const struct qstr *domain = &dentry->d_name;
 452         struct dlmfs_inode_private *ip;
 453         struct ocfs2_cluster_connection *conn;
 454
 455         mlog(0, "mkdir %.*s\n", domain->len, domain->name);
 456
 457         /* verify that we have a proper domain */
 458         if (domain->len >= GROUP_NAME_MAX) {
 459                 status = -EINVAL;
 460                 mlog(ML_ERROR, "invalid domain name for directory.\n");
 461                 goto bail;
 462         }
 463
 464         inode = dlmfs_get_inode(dir, dentry, mode | S_IFDIR);
 465         if (!inode) {
 466                 status = -ENOMEM;
 467                 mlog_errno(status);
 468                 goto bail;
 469         }
 470
 471         ip = DLMFS_I(inode);
 472
 473         conn = user_dlm_register(domain);
 474         if (IS_ERR(conn)) {
 475                 status = PTR_ERR(conn);
 476                 mlog(ML_ERROR, "Error %d could not register domain \"%.*s\"\n",
 477                      status, domain->len, domain->name);
 478                 goto bail;
 479         }
 480         ip->ip_conn = conn;
 481
 482         inc_nlink(dir);
 483         d_instantiate(dentry, inode);
 484         dget(dentry);   /* Extra count - pin the dentry in core */
 485
 486         status = 0;
 487 bail:
 488         if (status < 0)
 489                 iput(inode);
 490         return status;
 491 }
 492
 493 static int dlmfs_create(struct inode *dir,
 494                         struct dentry *dentry,
 495                         umode_t mode,
 496                         bool excl)
 497 {
 498         int status = 0;
 499         struct inode *inode;
 500         const struct qstr *name = &dentry->d_name;
 501
 502         mlog(0, "create %.*s\n", name->len, name->name);
 503
 504         /* verify name is valid and doesn't contain any dlm reserved
 505          * characters */
 506         if (name->len >= USER_DLM_LOCK_ID_MAX_LEN ||
 507             name->name[0] == '$') {
 508                 status = -EINVAL;
 509                 mlog(ML_ERROR, "invalid lock name, %.*s\n", name->len,
 510                      name->name);
 511                 goto bail;
 512         }
 513
 514         inode = dlmfs_get_inode(dir, dentry, mode | S_IFREG);
 515         if (!inode) {
 516                 status = -ENOMEM;
 517                 mlog_errno(status);
 518                 goto bail;
 519         }
 520
 521         d_instantiate(dentry, inode);
 522         dget(dentry);   /* Extra count - pin the dentry in core */
 523 bail:
 524         return status;
 525 }
 526
 527 static int dlmfs_unlink(struct inode *dir,
 528                         struct dentry *dentry)
 529 {
 530         int status;
 531         struct inode *inode = d_inode(dentry);
 532
 533         mlog(0, "unlink inode %lu\n", inode->i_ino);
 534
 535         /* if there are no current holders, or none that are waiting
 536          * to acquire a lock, this basically destroys our lockres. */
 537         status = user_dlm_destroy_lock(&DLMFS_I(inode)->ip_lockres);
 538         if (status < 0) {
 539                 mlog(ML_ERROR, "unlink %pd, error %d from destroy\n",
 540                      dentry, status);
 541                 goto bail;
 542         }
 543         status = simple_unlink(dir, dentry);
 544 bail:
 545         return status;
 546 }
 547
 548 static int dlmfs_fill_super(struct super_block * sb,
 549                             void * data,
 550                             int silent)
 551 {
 552         sb->s_maxbytes = MAX_LFS_FILESIZE;
 553         sb->s_blocksize = PAGE_SIZE;
 554         sb->s_blocksize_bits = PAGE_SHIFT;
 555         sb->s_magic = DLMFS_MAGIC;
 556         sb->s_op = &dlmfs_ops;
 557         sb->s_root = d_make_root(dlmfs_get_root_inode(sb));
 558         if (!sb->s_root)
 559                 return -ENOMEM;
 560         return 0;
 561 }
 562
 563 static const struct file_operations dlmfs_file_operations = {
 564         .open           = dlmfs_file_open,
 565         .release        = dlmfs_file_release,
 566         .poll           = dlmfs_file_poll,
 567         .read           = dlmfs_file_read,
 568         .write          = dlmfs_file_write,
 569         .llseek         = default_llseek,
 570 };
 571
 572 static const struct inode_operations dlmfs_dir_inode_operations = {
 573         .create         = dlmfs_create,
 574         .lookup         = simple_lookup,
 575         .unlink         = dlmfs_unlink,
 576 };
 577
 578 /* this way we can restrict mkdir to only the toplevel of the fs. */
 579 static const struct inode_operations dlmfs_root_inode_operations = {
 580         .lookup         = simple_lookup,
 581         .mkdir          = dlmfs_mkdir,
 582         .rmdir          = simple_rmdir,
 583 };
 584
 585 static const struct super_operations dlmfs_ops = {
 586         .statfs         = simple_statfs,
 587         .alloc_inode    = dlmfs_alloc_inode,
 588         .free_inode     = dlmfs_free_inode,
 589         .evict_inode    = dlmfs_evict_inode,
 590         .drop_inode     = generic_delete_inode,
 591 };
 592
 593 static const struct inode_operations dlmfs_file_inode_operations = {
 594         .getattr        = simple_getattr,
 595         .setattr        = dlmfs_file_setattr,
 596 };
 597
 598 static struct dentry *dlmfs_mount(struct file_system_type *fs_type,
 599         int flags, const char *dev_name, void *data)
 600 {
 601         return mount_nodev(fs_type, flags, data, dlmfs_fill_super);
 602 }
 603
 604 static struct file_system_type dlmfs_fs_type = {
 605         .owner          = THIS_MODULE,
 606         .name           = "ocfs2_dlmfs",
 607         .mount          = dlmfs_mount,
 608         .kill_sb        = kill_litter_super,
 609 };
 610 MODULE_ALIAS_FS("ocfs2_dlmfs");
 611
 612 static int __init init_dlmfs_fs(void)
 613 {
 614         int status;
 615         int cleanup_inode = 0, cleanup_worker = 0;
 616
 617         dlmfs_inode_cache = kmem_cache_create("dlmfs_inode_cache",
 618                                 sizeof(struct dlmfs_inode_private),
 619                                 0, (SLAB_HWCACHE_ALIGN|SLAB_RECLAIM_ACCOUNT|
 620                                         SLAB_MEM_SPREAD|SLAB_ACCOUNT),
 621                                 dlmfs_init_once);
 622         if (!dlmfs_inode_cache) {
 623                 status = -ENOMEM;
 624                 goto bail;
 625         }
 626         cleanup_inode = 1;
 627
 628         user_dlm_worker = alloc_workqueue("user_dlm", WQ_MEM_RECLAIM, 0);
 629         if (!user_dlm_worker) {
 630                 status = -ENOMEM;
 631                 goto bail;
 632         }
 633         cleanup_worker = 1;
 634
 635         user_dlm_set_locking_protocol();
 636         status = register_filesystem(&dlmfs_fs_type);
 637 bail:
 638         if (status) {
 639                 if (cleanup_inode)
 640                         kmem_cache_destroy(dlmfs_inode_cache);
 641                 if (cleanup_worker)
 642                         destroy_workqueue(user_dlm_worker);
 643         } else
 644                 printk("OCFS2 User DLM kernel interface loaded\n");
 645         return status;
 646 }
 647
 648 static void __exit exit_dlmfs_fs(void)
 649 {
 650         unregister_filesystem(&dlmfs_fs_type);
 651
 652         destroy_workqueue(user_dlm_worker);
 653
 654         /*
 655          * Make sure all delayed rcu free inodes are flushed before we
 656          * destroy cache.
 657          */
 658         rcu_barrier();
 659         kmem_cache_destroy(dlmfs_inode_cache);
 660
 661 }
 662
 663 MODULE_AUTHOR("Oracle");
 664 MODULE_LICENSE("GPL");
 665 MODULE_DESCRIPTION("OCFS2 DLM-Filesystem");
 666
 667 module_init(init_dlmfs_fs)
 668 module_exit(exit_dlmfs_fs)