1 /* -*- mode: c; c-basic-offset: 8; -*-
2 * vim: noexpandtab sw=8 ts=8 sts=0:
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.
11 * Copyright (C) 2003, 2004 Oracle. All rights reserved.
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.
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.
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.
29 /* Simple VFS hooks based on: */
31 * Resizable simple ram filesystem for Linux.
33 * Copyright (C) 2000 Linus Torvalds.
34 * 2000 Transmeta Corp.
37 #include <linux/module.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/backing-dev.h>
46 #include <linux/poll.h>
48 #include <asm/uaccess.h>
50 #include "stackglue.h"
54 #define MLOG_MASK_PREFIX ML_DLMFS
55 #include "cluster/masklog.h"
58 static const struct super_operations dlmfs_ops
;
59 static const struct file_operations dlmfs_file_operations
;
60 static const struct inode_operations dlmfs_dir_inode_operations
;
61 static const struct inode_operations dlmfs_root_inode_operations
;
62 static const struct inode_operations dlmfs_file_inode_operations
;
63 static struct kmem_cache
*dlmfs_inode_cache
;
65 struct workqueue_struct
*user_dlm_worker
;
70 * These are the ABI capabilities of dlmfs.
72 * Over time, dlmfs has added some features that were not part of the
73 * initial ABI. Unfortunately, some of these features are not detectable
74 * via standard usage. For example, Linux's default poll always returns
75 * POLLIN, so there is no way for a caller of poll(2) to know when dlmfs
76 * added poll support. Instead, we provide this list of new capabilities.
78 * Capabilities is a read-only attribute. We do it as a module parameter
79 * so we can discover it whether dlmfs is built in, loaded, or even not
82 * The ABI features are local to this machine's dlmfs mount. This is
83 * distinct from the locking protocol, which is concerned with inter-node
87 * - bast : POLLIN against the file descriptor of a held lock
88 * signifies a bast fired on the lock.
90 #define DLMFS_CAPABILITIES "bast stackglue"
91 static int param_set_dlmfs_capabilities(const char *val
,
92 struct kernel_param
*kp
)
94 printk(KERN_ERR
"%s: readonly parameter\n", kp
->name
);
97 static int param_get_dlmfs_capabilities(char *buffer
,
98 struct kernel_param
*kp
)
100 return strlcpy(buffer
, DLMFS_CAPABILITIES
,
101 strlen(DLMFS_CAPABILITIES
) + 1);
103 module_param_call(capabilities
, param_set_dlmfs_capabilities
,
104 param_get_dlmfs_capabilities
, NULL
, 0444);
105 MODULE_PARM_DESC(capabilities
, DLMFS_CAPABILITIES
);
109 * decodes a set of open flags into a valid lock level and a set of flags.
110 * returns < 0 if we have invalid flags
111 * flags which mean something to us:
112 * O_RDONLY -> PRMODE level
113 * O_WRONLY -> EXMODE level
115 * O_NONBLOCK -> NOQUEUE
117 static int dlmfs_decode_open_flags(int open_flags
,
121 if (open_flags
& (O_WRONLY
|O_RDWR
))
122 *level
= DLM_LOCK_EX
;
124 *level
= DLM_LOCK_PR
;
127 if (open_flags
& O_NONBLOCK
)
128 *flags
|= DLM_LKF_NOQUEUE
;
133 static int dlmfs_file_open(struct inode
*inode
,
136 int status
, level
, flags
;
137 struct dlmfs_filp_private
*fp
= NULL
;
138 struct dlmfs_inode_private
*ip
;
140 if (S_ISDIR(inode
->i_mode
))
143 mlog(0, "open called on inode %lu, flags 0x%x\n", inode
->i_ino
,
146 status
= dlmfs_decode_open_flags(file
->f_flags
, &level
, &flags
);
150 /* We don't want to honor O_APPEND at read/write time as it
151 * doesn't make sense for LVB writes. */
152 file
->f_flags
&= ~O_APPEND
;
154 fp
= kmalloc(sizeof(*fp
), GFP_NOFS
);
159 fp
->fp_lock_level
= level
;
163 status
= user_dlm_cluster_lock(&ip
->ip_lockres
, level
, flags
);
165 /* this is a strange error to return here but I want
166 * to be able userspace to be able to distinguish a
167 * valid lock request from one that simply couldn't be
169 if (flags
& DLM_LKF_NOQUEUE
&& status
== -EAGAIN
)
175 file
->private_data
= fp
;
180 static int dlmfs_file_release(struct inode
*inode
,
184 struct dlmfs_inode_private
*ip
= DLMFS_I(inode
);
185 struct dlmfs_filp_private
*fp
= file
->private_data
;
187 if (S_ISDIR(inode
->i_mode
))
190 mlog(0, "close called on inode %lu\n", inode
->i_ino
);
194 level
= fp
->fp_lock_level
;
195 if (level
!= DLM_LOCK_IV
)
196 user_dlm_cluster_unlock(&ip
->ip_lockres
, level
);
199 file
->private_data
= NULL
;
206 * We do ->setattr() just to override size changes. Our size is the size
207 * of the LVB and nothing else.
209 static int dlmfs_file_setattr(struct dentry
*dentry
, struct iattr
*attr
)
212 struct inode
*inode
= dentry
->d_inode
;
214 attr
->ia_valid
&= ~ATTR_SIZE
;
215 error
= inode_change_ok(inode
, attr
);
219 setattr_copy(inode
, attr
);
220 mark_inode_dirty(inode
);
224 static unsigned int dlmfs_file_poll(struct file
*file
, poll_table
*wait
)
227 struct inode
*inode
= file
->f_path
.dentry
->d_inode
;
228 struct dlmfs_inode_private
*ip
= DLMFS_I(inode
);
230 poll_wait(file
, &ip
->ip_lockres
.l_event
, wait
);
232 spin_lock(&ip
->ip_lockres
.l_lock
);
233 if (ip
->ip_lockres
.l_flags
& USER_LOCK_BLOCKED
)
234 event
= POLLIN
| POLLRDNORM
;
235 spin_unlock(&ip
->ip_lockres
.l_lock
);
240 static ssize_t
dlmfs_file_read(struct file
*filp
,
246 ssize_t readlen
, got
;
248 struct inode
*inode
= filp
->f_path
.dentry
->d_inode
;
250 mlog(0, "inode %lu, count = %zu, *ppos = %llu\n",
251 inode
->i_ino
, count
, *ppos
);
253 if (*ppos
>= i_size_read(inode
))
259 if (!access_ok(VERIFY_WRITE
, buf
, count
))
262 /* don't read past the lvb */
263 if ((count
+ *ppos
) > i_size_read(inode
))
264 readlen
= i_size_read(inode
) - *ppos
;
268 lvb_buf
= kmalloc(readlen
, GFP_NOFS
);
272 got
= user_dlm_read_lvb(inode
, lvb_buf
, readlen
);
274 BUG_ON(got
!= readlen
);
275 bytes_left
= __copy_to_user(buf
, lvb_buf
, readlen
);
276 readlen
-= bytes_left
;
282 *ppos
= *ppos
+ readlen
;
284 mlog(0, "read %zd bytes\n", readlen
);
288 static ssize_t
dlmfs_file_write(struct file
*filp
,
289 const char __user
*buf
,
296 struct inode
*inode
= filp
->f_path
.dentry
->d_inode
;
298 mlog(0, "inode %lu, count = %zu, *ppos = %llu\n",
299 inode
->i_ino
, count
, *ppos
);
301 if (*ppos
>= i_size_read(inode
))
307 if (!access_ok(VERIFY_READ
, buf
, count
))
310 /* don't write past the lvb */
311 if ((count
+ *ppos
) > i_size_read(inode
))
312 writelen
= i_size_read(inode
) - *ppos
;
314 writelen
= count
- *ppos
;
316 lvb_buf
= kmalloc(writelen
, GFP_NOFS
);
320 bytes_left
= copy_from_user(lvb_buf
, buf
, writelen
);
321 writelen
-= bytes_left
;
323 user_dlm_write_lvb(inode
, lvb_buf
, writelen
);
327 *ppos
= *ppos
+ writelen
;
328 mlog(0, "wrote %zd bytes\n", writelen
);
332 static void dlmfs_init_once(void *foo
)
334 struct dlmfs_inode_private
*ip
=
335 (struct dlmfs_inode_private
*) foo
;
338 ip
->ip_parent
= NULL
;
340 inode_init_once(&ip
->ip_vfs_inode
);
343 static struct inode
*dlmfs_alloc_inode(struct super_block
*sb
)
345 struct dlmfs_inode_private
*ip
;
347 ip
= kmem_cache_alloc(dlmfs_inode_cache
, GFP_NOFS
);
351 return &ip
->ip_vfs_inode
;
354 static void dlmfs_i_callback(struct rcu_head
*head
)
356 struct inode
*inode
= container_of(head
, struct inode
, i_rcu
);
357 INIT_LIST_HEAD(&inode
->i_dentry
);
358 kmem_cache_free(dlmfs_inode_cache
, DLMFS_I(inode
));
361 static void dlmfs_destroy_inode(struct inode
*inode
)
363 call_rcu(&inode
->i_rcu
, dlmfs_i_callback
);
366 static void dlmfs_evict_inode(struct inode
*inode
)
369 struct dlmfs_inode_private
*ip
;
371 end_writeback(inode
);
373 mlog(0, "inode %lu\n", inode
->i_ino
);
377 if (S_ISREG(inode
->i_mode
)) {
378 status
= user_dlm_destroy_lock(&ip
->ip_lockres
);
385 mlog(0, "we're a directory, ip->ip_conn = 0x%p\n", ip
->ip_conn
);
386 /* we must be a directory. If required, lets unregister the
387 * dlm context now. */
389 user_dlm_unregister(ip
->ip_conn
);
391 ip
->ip_parent
= NULL
;
395 static struct backing_dev_info dlmfs_backing_dev_info
= {
396 .name
= "ocfs2-dlmfs",
397 .ra_pages
= 0, /* No readahead */
398 .capabilities
= BDI_CAP_NO_ACCT_AND_WRITEBACK
,
401 static struct inode
*dlmfs_get_root_inode(struct super_block
*sb
)
403 struct inode
*inode
= new_inode(sb
);
404 int mode
= S_IFDIR
| 0755;
405 struct dlmfs_inode_private
*ip
;
410 inode
->i_ino
= get_next_ino();
411 inode
->i_mode
= mode
;
412 inode
->i_uid
= current_fsuid();
413 inode
->i_gid
= current_fsgid();
414 inode
->i_mapping
->backing_dev_info
= &dlmfs_backing_dev_info
;
415 inode
->i_atime
= inode
->i_mtime
= inode
->i_ctime
= CURRENT_TIME
;
418 inode
->i_fop
= &simple_dir_operations
;
419 inode
->i_op
= &dlmfs_root_inode_operations
;
425 static struct inode
*dlmfs_get_inode(struct inode
*parent
,
426 struct dentry
*dentry
,
429 struct super_block
*sb
= parent
->i_sb
;
430 struct inode
* inode
= new_inode(sb
);
431 struct dlmfs_inode_private
*ip
;
436 inode
->i_ino
= get_next_ino();
437 inode
->i_mode
= mode
;
438 inode
->i_uid
= current_fsuid();
439 inode
->i_gid
= current_fsgid();
440 inode
->i_mapping
->backing_dev_info
= &dlmfs_backing_dev_info
;
441 inode
->i_atime
= inode
->i_mtime
= inode
->i_ctime
= CURRENT_TIME
;
444 ip
->ip_conn
= DLMFS_I(parent
)->ip_conn
;
446 switch (mode
& S_IFMT
) {
448 /* for now we don't support anything other than
449 * directories and regular files. */
453 inode
->i_op
= &dlmfs_file_inode_operations
;
454 inode
->i_fop
= &dlmfs_file_operations
;
456 i_size_write(inode
, DLM_LVB_LEN
);
458 user_dlm_lock_res_init(&ip
->ip_lockres
, dentry
);
460 /* released at clear_inode time, this insures that we
461 * get to drop the dlm reference on each lock *before*
462 * we call the unregister code for releasing parent
464 ip
->ip_parent
= igrab(parent
);
465 BUG_ON(!ip
->ip_parent
);
468 inode
->i_op
= &dlmfs_dir_inode_operations
;
469 inode
->i_fop
= &simple_dir_operations
;
471 /* directory inodes start off with i_nlink ==
472 * 2 (for "." entry) */
477 if (parent
->i_mode
& S_ISGID
) {
478 inode
->i_gid
= parent
->i_gid
;
480 inode
->i_mode
|= S_ISGID
;
487 * File creation. Allocate an inode, and we're done..
490 static int dlmfs_mkdir(struct inode
* dir
,
491 struct dentry
* dentry
,
495 struct inode
*inode
= NULL
;
496 struct qstr
*domain
= &dentry
->d_name
;
497 struct dlmfs_inode_private
*ip
;
498 struct ocfs2_cluster_connection
*conn
;
500 mlog(0, "mkdir %.*s\n", domain
->len
, domain
->name
);
502 /* verify that we have a proper domain */
503 if (domain
->len
>= GROUP_NAME_MAX
) {
505 mlog(ML_ERROR
, "invalid domain name for directory.\n");
509 inode
= dlmfs_get_inode(dir
, dentry
, mode
| S_IFDIR
);
518 conn
= user_dlm_register(domain
);
520 status
= PTR_ERR(conn
);
521 mlog(ML_ERROR
, "Error %d could not register domain \"%.*s\"\n",
522 status
, domain
->len
, domain
->name
);
528 d_instantiate(dentry
, inode
);
529 dget(dentry
); /* Extra count - pin the dentry in core */
538 static int dlmfs_create(struct inode
*dir
,
539 struct dentry
*dentry
,
541 struct nameidata
*nd
)
545 struct qstr
*name
= &dentry
->d_name
;
547 mlog(0, "create %.*s\n", name
->len
, name
->name
);
549 /* verify name is valid and doesn't contain any dlm reserved
551 if (name
->len
>= USER_DLM_LOCK_ID_MAX_LEN
||
552 name
->name
[0] == '$') {
554 mlog(ML_ERROR
, "invalid lock name, %.*s\n", name
->len
,
559 inode
= dlmfs_get_inode(dir
, dentry
, mode
| S_IFREG
);
566 d_instantiate(dentry
, inode
);
567 dget(dentry
); /* Extra count - pin the dentry in core */
572 static int dlmfs_unlink(struct inode
*dir
,
573 struct dentry
*dentry
)
576 struct inode
*inode
= dentry
->d_inode
;
578 mlog(0, "unlink inode %lu\n", inode
->i_ino
);
580 /* if there are no current holders, or none that are waiting
581 * to acquire a lock, this basically destroys our lockres. */
582 status
= user_dlm_destroy_lock(&DLMFS_I(inode
)->ip_lockres
);
584 mlog(ML_ERROR
, "unlink %.*s, error %d from destroy\n",
585 dentry
->d_name
.len
, dentry
->d_name
.name
, status
);
588 status
= simple_unlink(dir
, dentry
);
593 static int dlmfs_fill_super(struct super_block
* sb
,
597 struct inode
* inode
;
598 struct dentry
* root
;
600 sb
->s_maxbytes
= MAX_LFS_FILESIZE
;
601 sb
->s_blocksize
= PAGE_CACHE_SIZE
;
602 sb
->s_blocksize_bits
= PAGE_CACHE_SHIFT
;
603 sb
->s_magic
= DLMFS_MAGIC
;
604 sb
->s_op
= &dlmfs_ops
;
605 inode
= dlmfs_get_root_inode(sb
);
609 root
= d_alloc_root(inode
);
618 static const struct file_operations dlmfs_file_operations
= {
619 .open
= dlmfs_file_open
,
620 .release
= dlmfs_file_release
,
621 .poll
= dlmfs_file_poll
,
622 .read
= dlmfs_file_read
,
623 .write
= dlmfs_file_write
,
624 .llseek
= default_llseek
,
627 static const struct inode_operations dlmfs_dir_inode_operations
= {
628 .create
= dlmfs_create
,
629 .lookup
= simple_lookup
,
630 .unlink
= dlmfs_unlink
,
633 /* this way we can restrict mkdir to only the toplevel of the fs. */
634 static const struct inode_operations dlmfs_root_inode_operations
= {
635 .lookup
= simple_lookup
,
636 .mkdir
= dlmfs_mkdir
,
637 .rmdir
= simple_rmdir
,
640 static const struct super_operations dlmfs_ops
= {
641 .statfs
= simple_statfs
,
642 .alloc_inode
= dlmfs_alloc_inode
,
643 .destroy_inode
= dlmfs_destroy_inode
,
644 .evict_inode
= dlmfs_evict_inode
,
645 .drop_inode
= generic_delete_inode
,
648 static const struct inode_operations dlmfs_file_inode_operations
= {
649 .getattr
= simple_getattr
,
650 .setattr
= dlmfs_file_setattr
,
653 static struct dentry
*dlmfs_mount(struct file_system_type
*fs_type
,
654 int flags
, const char *dev_name
, void *data
)
656 return mount_nodev(fs_type
, flags
, data
, dlmfs_fill_super
);
659 static struct file_system_type dlmfs_fs_type
= {
660 .owner
= THIS_MODULE
,
661 .name
= "ocfs2_dlmfs",
662 .mount
= dlmfs_mount
,
663 .kill_sb
= kill_litter_super
,
666 static int __init
init_dlmfs_fs(void)
669 int cleanup_inode
= 0, cleanup_worker
= 0;
671 dlmfs_print_version();
673 status
= bdi_init(&dlmfs_backing_dev_info
);
677 dlmfs_inode_cache
= kmem_cache_create("dlmfs_inode_cache",
678 sizeof(struct dlmfs_inode_private
),
679 0, (SLAB_HWCACHE_ALIGN
|SLAB_RECLAIM_ACCOUNT
|
682 if (!dlmfs_inode_cache
) {
688 user_dlm_worker
= create_singlethread_workqueue("user_dlm");
689 if (!user_dlm_worker
) {
695 user_dlm_set_locking_protocol();
696 status
= register_filesystem(&dlmfs_fs_type
);
700 kmem_cache_destroy(dlmfs_inode_cache
);
702 destroy_workqueue(user_dlm_worker
);
703 bdi_destroy(&dlmfs_backing_dev_info
);
705 printk("OCFS2 User DLM kernel interface loaded\n");
709 static void __exit
exit_dlmfs_fs(void)
711 unregister_filesystem(&dlmfs_fs_type
);
713 flush_workqueue(user_dlm_worker
);
714 destroy_workqueue(user_dlm_worker
);
716 kmem_cache_destroy(dlmfs_inode_cache
);
718 bdi_destroy(&dlmfs_backing_dev_info
);
721 MODULE_AUTHOR("Oracle");
722 MODULE_LICENSE("GPL");
724 module_init(init_dlmfs_fs
)
725 module_exit(exit_dlmfs_fs
)