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 user_namespace *mnt_userns,
 194                               struct dentry *dentry, struct iattr *attr)
 195 {
 196         int error;
 197         struct inode *inode = d_inode(dentry);
 198
 199         attr->ia_valid &= ~ATTR_SIZE;
 200         error = setattr_prepare(&init_user_ns, dentry, attr);
 201         if (error)
 202                 return error;
 203
 204         setattr_copy(&init_user_ns, inode, attr);
 205         mark_inode_dirty(inode);
 206         return 0;
 207 }
 208
 209 static __poll_t dlmfs_file_poll(struct file *file, poll_table *wait)
 210 {
 211         __poll_t event = 0;
 212         struct inode *inode = file_inode(file);
 213         struct dlmfs_inode_private *ip = DLMFS_I(inode);
 214
 215         poll_wait(file, &ip->ip_lockres.l_event, wait);
 216
 217         spin_lock(&ip->ip_lockres.l_lock);
 218         if (ip->ip_lockres.l_flags & USER_LOCK_BLOCKED)
 219                 event = EPOLLIN | EPOLLRDNORM;
 220         spin_unlock(&ip->ip_lockres.l_lock);
 221
 222         return event;
 223 }
 224
 225 static ssize_t dlmfs_file_read(struct file *file,
 226                                char __user *buf,
 227                                size_t count,
 228                                loff_t *ppos)
 229 {
 230         char lvb[DLM_LVB_LEN];
 231
 232         if (!user_dlm_read_lvb(file_inode(file), lvb))
 233                 return 0;
 234
 235         return simple_read_from_buffer(buf, count, ppos, lvb, sizeof(lvb));
 236 }
 237
 238 static ssize_t dlmfs_file_write(struct file *filp,
 239                                 const char __user *buf,
 240                                 size_t count,
 241                                 loff_t *ppos)
 242 {
 243         char lvb_buf[DLM_LVB_LEN];
 244         int bytes_left;
 245         struct inode *inode = file_inode(filp);
 246
 247         mlog(0, "inode %lu, count = %zu, *ppos = %llu\n",
 248                 inode->i_ino, count, *ppos);
 249
 250         if (*ppos >= DLM_LVB_LEN)
 251                 return -ENOSPC;
 252
 253         /* don't write past the lvb */
 254         if (count > DLM_LVB_LEN - *ppos)
 255                 count = DLM_LVB_LEN - *ppos;
 256
 257         if (!count)
 258                 return 0;
 259
 260         bytes_left = copy_from_user(lvb_buf, buf, count);
 261         count -= bytes_left;
 262         if (count)
 263                 user_dlm_write_lvb(inode, lvb_buf, count);
 264
 265         *ppos = *ppos + count;
 266         mlog(0, "wrote %zu bytes\n", count);
 267         return count;
 268 }
 269
 270 static void dlmfs_init_once(void *foo)
 271 {
 272         struct dlmfs_inode_private *ip =
 273                 (struct dlmfs_inode_private *) foo;
 274
 275         ip->ip_conn = NULL;
 276         ip->ip_parent = NULL;
 277
 278         inode_init_once(&ip->ip_vfs_inode);
 279 }
 280
 281 static struct inode *dlmfs_alloc_inode(struct super_block *sb)
 282 {
 283         struct dlmfs_inode_private *ip;
 284
 285         ip = kmem_cache_alloc(dlmfs_inode_cache, GFP_NOFS);
 286         if (!ip)
 287                 return NULL;
 288
 289         return &ip->ip_vfs_inode;
 290 }
 291
 292 static void dlmfs_free_inode(struct inode *inode)
 293 {
 294         kmem_cache_free(dlmfs_inode_cache, DLMFS_I(inode));
 295 }
 296
 297 static void dlmfs_evict_inode(struct inode *inode)
 298 {
 299         int status;
 300         struct dlmfs_inode_private *ip;
 301
 302         clear_inode(inode);
 303
 304         mlog(0, "inode %lu\n", inode->i_ino);
 305
 306         ip = DLMFS_I(inode);
 307
 308         if (S_ISREG(inode->i_mode)) {
 309                 status = user_dlm_destroy_lock(&ip->ip_lockres);
 310                 if (status < 0)
 311                         mlog_errno(status);
 312                 iput(ip->ip_parent);
 313                 goto clear_fields;
 314         }
 315
 316         mlog(0, "we're a directory, ip->ip_conn = 0x%p\n", ip->ip_conn);
 317         /* we must be a directory. If required, lets unregister the
 318          * dlm context now. */
 319         if (ip->ip_conn)
 320                 user_dlm_unregister(ip->ip_conn);
 321 clear_fields:
 322         ip->ip_parent = NULL;
 323         ip->ip_conn = NULL;
 324 }
 325
 326 static struct inode *dlmfs_get_root_inode(struct super_block *sb)
 327 {
 328         struct inode *inode = new_inode(sb);
 329         umode_t mode = S_IFDIR | 0755;
 330
 331         if (inode) {
 332                 inode->i_ino = get_next_ino();
 333                 inode_init_owner(&init_user_ns, inode, NULL, mode);
 334                 inode->i_atime = inode->i_mtime = inode->i_ctime = current_time(inode);
 335                 inc_nlink(inode);
 336
 337                 inode->i_fop = &simple_dir_operations;
 338                 inode->i_op = &dlmfs_root_inode_operations;
 339         }
 340
 341         return inode;
 342 }
 343
 344 static struct inode *dlmfs_get_inode(struct inode *parent,
 345                                      struct dentry *dentry,
 346                                      umode_t mode)
 347 {
 348         struct super_block *sb = parent->i_sb;
 349         struct inode * inode = new_inode(sb);
 350         struct dlmfs_inode_private *ip;
 351
 352         if (!inode)
 353                 return NULL;
 354
 355         inode->i_ino = get_next_ino();
 356         inode_init_owner(&init_user_ns, inode, parent, mode);
 357         inode->i_atime = inode->i_mtime = inode->i_ctime = current_time(inode);
 358
 359         ip = DLMFS_I(inode);
 360         ip->ip_conn = DLMFS_I(parent)->ip_conn;
 361
 362         switch (mode & S_IFMT) {
 363         default:
 364                 /* for now we don't support anything other than
 365                  * directories and regular files. */
 366                 BUG();
 367                 break;
 368         case S_IFREG:
 369                 inode->i_op = &dlmfs_file_inode_operations;
 370                 inode->i_fop = &dlmfs_file_operations;
 371
 372                 i_size_write(inode,  DLM_LVB_LEN);
 373
 374                 user_dlm_lock_res_init(&ip->ip_lockres, dentry);
 375
 376                 /* released at clear_inode time, this insures that we
 377                  * get to drop the dlm reference on each lock *before*
 378                  * we call the unregister code for releasing parent
 379                  * directories. */
 380                 ip->ip_parent = igrab(parent);
 381                 BUG_ON(!ip->ip_parent);
 382                 break;
 383         case S_IFDIR:
 384                 inode->i_op = &dlmfs_dir_inode_operations;
 385                 inode->i_fop = &simple_dir_operations;
 386
 387                 /* directory inodes start off with i_nlink ==
 388                  * 2 (for "." entry) */
 389                 inc_nlink(inode);
 390                 break;
 391         }
 392         return inode;
 393 }
 394
 395 /*
 396  * File creation. Allocate an inode, and we're done..
 397  */
 398 /* SMP-safe */
 399 static int dlmfs_mkdir(struct user_namespace * mnt_userns,
 400                        struct inode * dir,
 401                        struct dentry * dentry,
 402                        umode_t mode)
 403 {
 404         int status;
 405         struct inode *inode = NULL;
 406         const struct qstr *domain = &dentry->d_name;
 407         struct dlmfs_inode_private *ip;
 408         struct ocfs2_cluster_connection *conn;
 409
 410         mlog(0, "mkdir %.*s\n", domain->len, domain->name);
 411
 412         /* verify that we have a proper domain */
 413         if (domain->len >= GROUP_NAME_MAX) {
 414                 status = -EINVAL;
 415                 mlog(ML_ERROR, "invalid domain name for directory.\n");
 416                 goto bail;
 417         }
 418
 419         inode = dlmfs_get_inode(dir, dentry, mode | S_IFDIR);
 420         if (!inode) {
 421                 status = -ENOMEM;
 422                 mlog_errno(status);
 423                 goto bail;
 424         }
 425
 426         ip = DLMFS_I(inode);
 427
 428         conn = user_dlm_register(domain);
 429         if (IS_ERR(conn)) {
 430                 status = PTR_ERR(conn);
 431                 mlog(ML_ERROR, "Error %d could not register domain \"%.*s\"\n",
 432                      status, domain->len, domain->name);
 433                 goto bail;
 434         }
 435         ip->ip_conn = conn;
 436
 437         inc_nlink(dir);
 438         d_instantiate(dentry, inode);
 439         dget(dentry);   /* Extra count - pin the dentry in core */
 440
 441         status = 0;
 442 bail:
 443         if (status < 0)
 444                 iput(inode);
 445         return status;
 446 }
 447
 448 static int dlmfs_create(struct user_namespace *mnt_userns,
 449                         struct inode *dir,
 450                         struct dentry *dentry,
 451                         umode_t mode,
 452                         bool excl)
 453 {
 454         int status = 0;
 455         struct inode *inode;
 456         const struct qstr *name = &dentry->d_name;
 457
 458         mlog(0, "create %.*s\n", name->len, name->name);
 459
 460         /* verify name is valid and doesn't contain any dlm reserved
 461          * characters */
 462         if (name->len >= USER_DLM_LOCK_ID_MAX_LEN ||
 463             name->name[0] == '$') {
 464                 status = -EINVAL;
 465                 mlog(ML_ERROR, "invalid lock name, %.*s\n", name->len,
 466                      name->name);
 467                 goto bail;
 468         }
 469
 470         inode = dlmfs_get_inode(dir, dentry, mode | S_IFREG);
 471         if (!inode) {
 472                 status = -ENOMEM;
 473                 mlog_errno(status);
 474                 goto bail;
 475         }
 476
 477         d_instantiate(dentry, inode);
 478         dget(dentry);   /* Extra count - pin the dentry in core */
 479 bail:
 480         return status;
 481 }
 482
 483 static int dlmfs_unlink(struct inode *dir,
 484                         struct dentry *dentry)
 485 {
 486         int status;
 487         struct inode *inode = d_inode(dentry);
 488
 489         mlog(0, "unlink inode %lu\n", inode->i_ino);
 490
 491         /* if there are no current holders, or none that are waiting
 492          * to acquire a lock, this basically destroys our lockres. */
 493         status = user_dlm_destroy_lock(&DLMFS_I(inode)->ip_lockres);
 494         if (status < 0) {
 495                 mlog(ML_ERROR, "unlink %pd, error %d from destroy\n",
 496                      dentry, status);
 497                 goto bail;
 498         }
 499         status = simple_unlink(dir, dentry);
 500 bail:
 501         return status;
 502 }
 503
 504 static int dlmfs_fill_super(struct super_block * sb,
 505                             void * data,
 506                             int silent)
 507 {
 508         sb->s_maxbytes = MAX_LFS_FILESIZE;
 509         sb->s_blocksize = PAGE_SIZE;
 510         sb->s_blocksize_bits = PAGE_SHIFT;
 511         sb->s_magic = DLMFS_MAGIC;
 512         sb->s_op = &dlmfs_ops;
 513         sb->s_root = d_make_root(dlmfs_get_root_inode(sb));
 514         if (!sb->s_root)
 515                 return -ENOMEM;
 516         return 0;
 517 }
 518
 519 static const struct file_operations dlmfs_file_operations = {
 520         .open           = dlmfs_file_open,
 521         .release        = dlmfs_file_release,
 522         .poll           = dlmfs_file_poll,
 523         .read           = dlmfs_file_read,
 524         .write          = dlmfs_file_write,
 525         .llseek         = default_llseek,
 526 };
 527
 528 static const struct inode_operations dlmfs_dir_inode_operations = {
 529         .create         = dlmfs_create,
 530         .lookup         = simple_lookup,
 531         .unlink         = dlmfs_unlink,
 532 };
 533
 534 /* this way we can restrict mkdir to only the toplevel of the fs. */
 535 static const struct inode_operations dlmfs_root_inode_operations = {
 536         .lookup         = simple_lookup,
 537         .mkdir          = dlmfs_mkdir,
 538         .rmdir          = simple_rmdir,
 539 };
 540
 541 static const struct super_operations dlmfs_ops = {
 542         .statfs         = simple_statfs,
 543         .alloc_inode    = dlmfs_alloc_inode,
 544         .free_inode     = dlmfs_free_inode,
 545         .evict_inode    = dlmfs_evict_inode,
 546         .drop_inode     = generic_delete_inode,
 547 };
 548
 549 static const struct inode_operations dlmfs_file_inode_operations = {
 550         .getattr        = simple_getattr,
 551         .setattr        = dlmfs_file_setattr,
 552 };
 553
 554 static struct dentry *dlmfs_mount(struct file_system_type *fs_type,
 555         int flags, const char *dev_name, void *data)
 556 {
 557         return mount_nodev(fs_type, flags, data, dlmfs_fill_super);
 558 }
 559
 560 static struct file_system_type dlmfs_fs_type = {
 561         .owner          = THIS_MODULE,
 562         .name           = "ocfs2_dlmfs",
 563         .mount          = dlmfs_mount,
 564         .kill_sb        = kill_litter_super,
 565 };
 566 MODULE_ALIAS_FS("ocfs2_dlmfs");
 567
 568 static int __init init_dlmfs_fs(void)
 569 {
 570         int status;
 571         int cleanup_inode = 0, cleanup_worker = 0;
 572
 573         dlmfs_inode_cache = kmem_cache_create("dlmfs_inode_cache",
 574                                 sizeof(struct dlmfs_inode_private),
 575                                 0, (SLAB_HWCACHE_ALIGN|SLAB_RECLAIM_ACCOUNT|
 576                                         SLAB_MEM_SPREAD|SLAB_ACCOUNT),
 577                                 dlmfs_init_once);
 578         if (!dlmfs_inode_cache) {
 579                 status = -ENOMEM;
 580                 goto bail;
 581         }
 582         cleanup_inode = 1;
 583
 584         user_dlm_worker = alloc_workqueue("user_dlm", WQ_MEM_RECLAIM, 0);
 585         if (!user_dlm_worker) {
 586                 status = -ENOMEM;
 587                 goto bail;
 588         }
 589         cleanup_worker = 1;
 590
 591         user_dlm_set_locking_protocol();
 592         status = register_filesystem(&dlmfs_fs_type);
 593 bail:
 594         if (status) {
 595                 if (cleanup_inode)
 596                         kmem_cache_destroy(dlmfs_inode_cache);
 597                 if (cleanup_worker)
 598                         destroy_workqueue(user_dlm_worker);
 599         } else
 600                 printk("OCFS2 User DLM kernel interface loaded\n");
 601         return status;
 602 }
 603
 604 static void __exit exit_dlmfs_fs(void)
 605 {
 606         unregister_filesystem(&dlmfs_fs_type);
 607
 608         destroy_workqueue(user_dlm_worker);
 609
 610         /*
 611          * Make sure all delayed rcu free inodes are flushed before we
 612          * destroy cache.
 613          */
 614         rcu_barrier();
 615         kmem_cache_destroy(dlmfs_inode_cache);
 616
 617 }
 618
 619 MODULE_AUTHOR("Oracle");
 620 MODULE_LICENSE("GPL");
 621 MODULE_DESCRIPTION("OCFS2 DLM-Filesystem");
 622
 623 module_init(init_dlmfs_fs)
 624 module_exit(exit_dlmfs_fs)