]> bbs.cooldavid.org Git - net-next-2.6.git/blob - fs/ocfs2/dlmfs/dlmfs.c
fs/ocfs2: Remove unnecessary casts of private_data
[net-next-2.6.git] / fs / ocfs2 / dlmfs / 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/backing-dev.h>
46 #include <linux/poll.h>
47
48 #include <asm/uaccess.h>
49
50 #include "stackglue.h"
51 #include "userdlm.h"
52 #include "dlmfsver.h"
53
54 #define MLOG_MASK_PREFIX ML_DLMFS
55 #include "cluster/masklog.h"
56
57
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;
64
65 struct workqueue_struct *user_dlm_worker;
66
67
68
69 /*
70  * These are the ABI capabilities of dlmfs.
71  *
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.
77  *
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
80  * loaded.
81  *
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
84  * interaction.
85  *
86  * Capabilities:
87  * - bast       : POLLIN against the file descriptor of a held lock
88  *                signifies a bast fired on the lock.
89  */
90 #define DLMFS_CAPABILITIES "bast stackglue"
91 extern int param_set_dlmfs_capabilities(const char *val,
92                                         struct kernel_param *kp)
93 {
94         printk(KERN_ERR "%s: readonly parameter\n", kp->name);
95         return -EINVAL;
96 }
97 static int param_get_dlmfs_capabilities(char *buffer,
98                                         struct kernel_param *kp)
99 {
100         return strlcpy(buffer, DLMFS_CAPABILITIES,
101                        strlen(DLMFS_CAPABILITIES) + 1);
102 }
103 module_param_call(capabilities, param_set_dlmfs_capabilities,
104                   param_get_dlmfs_capabilities, NULL, 0444);
105 MODULE_PARM_DESC(capabilities, DLMFS_CAPABILITIES);
106
107
108 /*
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
114  *
115  * O_NONBLOCK -> NOQUEUE
116  */
117 static int dlmfs_decode_open_flags(int open_flags,
118                                    int *level,
119                                    int *flags)
120 {
121         if (open_flags & (O_WRONLY|O_RDWR))
122                 *level = DLM_LOCK_EX;
123         else
124                 *level = DLM_LOCK_PR;
125
126         *flags = 0;
127         if (open_flags & O_NONBLOCK)
128                 *flags |= DLM_LKF_NOQUEUE;
129
130         return 0;
131 }
132
133 static int dlmfs_file_open(struct inode *inode,
134                            struct file *file)
135 {
136         int status, level, flags;
137         struct dlmfs_filp_private *fp = NULL;
138         struct dlmfs_inode_private *ip;
139
140         if (S_ISDIR(inode->i_mode))
141                 BUG();
142
143         mlog(0, "open called on inode %lu, flags 0x%x\n", inode->i_ino,
144                 file->f_flags);
145
146         status = dlmfs_decode_open_flags(file->f_flags, &level, &flags);
147         if (status < 0)
148                 goto bail;
149
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;
153
154         fp = kmalloc(sizeof(*fp), GFP_NOFS);
155         if (!fp) {
156                 status = -ENOMEM;
157                 goto bail;
158         }
159         fp->fp_lock_level = level;
160
161         ip = DLMFS_I(inode);
162
163         status = user_dlm_cluster_lock(&ip->ip_lockres, level, flags);
164         if (status < 0) {
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
168                  * granted. */
169                 if (flags & DLM_LKF_NOQUEUE && status == -EAGAIN)
170                         status = -ETXTBSY;
171                 kfree(fp);
172                 goto bail;
173         }
174
175         file->private_data = fp;
176 bail:
177         return status;
178 }
179
180 static int dlmfs_file_release(struct inode *inode,
181                               struct file *file)
182 {
183         int level, status;
184         struct dlmfs_inode_private *ip = DLMFS_I(inode);
185         struct dlmfs_filp_private *fp = file->private_data;
186
187         if (S_ISDIR(inode->i_mode))
188                 BUG();
189
190         mlog(0, "close called on inode %lu\n", inode->i_ino);
191
192         status = 0;
193         if (fp) {
194                 level = fp->fp_lock_level;
195                 if (level != DLM_LOCK_IV)
196                         user_dlm_cluster_unlock(&ip->ip_lockres, level);
197
198                 kfree(fp);
199                 file->private_data = NULL;
200         }
201
202         return 0;
203 }
204
205 /*
206  * We do ->setattr() just to override size changes.  Our size is the size
207  * of the LVB and nothing else.
208  */
209 static int dlmfs_file_setattr(struct dentry *dentry, struct iattr *attr)
210 {
211         int error;
212         struct inode *inode = dentry->d_inode;
213
214         attr->ia_valid &= ~ATTR_SIZE;
215         error = inode_change_ok(inode, attr);
216         if (!error)
217                 error = inode_setattr(inode, attr);
218
219         return error;
220 }
221
222 static unsigned int dlmfs_file_poll(struct file *file, poll_table *wait)
223 {
224         int event = 0;
225         struct inode *inode = file->f_path.dentry->d_inode;
226         struct dlmfs_inode_private *ip = DLMFS_I(inode);
227
228         poll_wait(file, &ip->ip_lockres.l_event, wait);
229
230         spin_lock(&ip->ip_lockres.l_lock);
231         if (ip->ip_lockres.l_flags & USER_LOCK_BLOCKED)
232                 event = POLLIN | POLLRDNORM;
233         spin_unlock(&ip->ip_lockres.l_lock);
234
235         return event;
236 }
237
238 static ssize_t dlmfs_file_read(struct file *filp,
239                                char __user *buf,
240                                size_t count,
241                                loff_t *ppos)
242 {
243         int bytes_left;
244         ssize_t readlen, got;
245         char *lvb_buf;
246         struct inode *inode = filp->f_path.dentry->d_inode;
247
248         mlog(0, "inode %lu, count = %zu, *ppos = %llu\n",
249                 inode->i_ino, count, *ppos);
250
251         if (*ppos >= i_size_read(inode))
252                 return 0;
253
254         if (!count)
255                 return 0;
256
257         if (!access_ok(VERIFY_WRITE, buf, count))
258                 return -EFAULT;
259
260         /* don't read past the lvb */
261         if ((count + *ppos) > i_size_read(inode))
262                 readlen = i_size_read(inode) - *ppos;
263         else
264                 readlen = count;
265
266         lvb_buf = kmalloc(readlen, GFP_NOFS);
267         if (!lvb_buf)
268                 return -ENOMEM;
269
270         got = user_dlm_read_lvb(inode, lvb_buf, readlen);
271         if (got) {
272                 BUG_ON(got != readlen);
273                 bytes_left = __copy_to_user(buf, lvb_buf, readlen);
274                 readlen -= bytes_left;
275         } else
276                 readlen = 0;
277
278         kfree(lvb_buf);
279
280         *ppos = *ppos + readlen;
281
282         mlog(0, "read %zd bytes\n", readlen);
283         return readlen;
284 }
285
286 static ssize_t dlmfs_file_write(struct file *filp,
287                                 const char __user *buf,
288                                 size_t count,
289                                 loff_t *ppos)
290 {
291         int bytes_left;
292         ssize_t writelen;
293         char *lvb_buf;
294         struct inode *inode = filp->f_path.dentry->d_inode;
295
296         mlog(0, "inode %lu, count = %zu, *ppos = %llu\n",
297                 inode->i_ino, count, *ppos);
298
299         if (*ppos >= i_size_read(inode))
300                 return -ENOSPC;
301
302         if (!count)
303                 return 0;
304
305         if (!access_ok(VERIFY_READ, buf, count))
306                 return -EFAULT;
307
308         /* don't write past the lvb */
309         if ((count + *ppos) > i_size_read(inode))
310                 writelen = i_size_read(inode) - *ppos;
311         else
312                 writelen = count - *ppos;
313
314         lvb_buf = kmalloc(writelen, GFP_NOFS);
315         if (!lvb_buf)
316                 return -ENOMEM;
317
318         bytes_left = copy_from_user(lvb_buf, buf, writelen);
319         writelen -= bytes_left;
320         if (writelen)
321                 user_dlm_write_lvb(inode, lvb_buf, writelen);
322
323         kfree(lvb_buf);
324
325         *ppos = *ppos + writelen;
326         mlog(0, "wrote %zd bytes\n", writelen);
327         return writelen;
328 }
329
330 static void dlmfs_init_once(void *foo)
331 {
332         struct dlmfs_inode_private *ip =
333                 (struct dlmfs_inode_private *) foo;
334
335         ip->ip_conn = NULL;
336         ip->ip_parent = NULL;
337
338         inode_init_once(&ip->ip_vfs_inode);
339 }
340
341 static struct inode *dlmfs_alloc_inode(struct super_block *sb)
342 {
343         struct dlmfs_inode_private *ip;
344
345         ip = kmem_cache_alloc(dlmfs_inode_cache, GFP_NOFS);
346         if (!ip)
347                 return NULL;
348
349         return &ip->ip_vfs_inode;
350 }
351
352 static void dlmfs_destroy_inode(struct inode *inode)
353 {
354         kmem_cache_free(dlmfs_inode_cache, DLMFS_I(inode));
355 }
356
357 static void dlmfs_clear_inode(struct inode *inode)
358 {
359         int status;
360         struct dlmfs_inode_private *ip;
361
362         if (!inode)
363                 return;
364
365         mlog(0, "inode %lu\n", inode->i_ino);
366
367         ip = DLMFS_I(inode);
368
369         if (S_ISREG(inode->i_mode)) {
370                 status = user_dlm_destroy_lock(&ip->ip_lockres);
371                 if (status < 0)
372                         mlog_errno(status);
373                 iput(ip->ip_parent);
374                 goto clear_fields;
375         }
376
377         mlog(0, "we're a directory, ip->ip_conn = 0x%p\n", ip->ip_conn);
378         /* we must be a directory. If required, lets unregister the
379          * dlm context now. */
380         if (ip->ip_conn)
381                 user_dlm_unregister(ip->ip_conn);
382 clear_fields:
383         ip->ip_parent = NULL;
384         ip->ip_conn = NULL;
385 }
386
387 static struct backing_dev_info dlmfs_backing_dev_info = {
388         .name           = "ocfs2-dlmfs",
389         .ra_pages       = 0,    /* No readahead */
390         .capabilities   = BDI_CAP_NO_ACCT_AND_WRITEBACK,
391 };
392
393 static struct inode *dlmfs_get_root_inode(struct super_block *sb)
394 {
395         struct inode *inode = new_inode(sb);
396         int mode = S_IFDIR | 0755;
397         struct dlmfs_inode_private *ip;
398
399         if (inode) {
400                 ip = DLMFS_I(inode);
401
402                 inode->i_mode = mode;
403                 inode->i_uid = current_fsuid();
404                 inode->i_gid = current_fsgid();
405                 inode->i_mapping->backing_dev_info = &dlmfs_backing_dev_info;
406                 inode->i_atime = inode->i_mtime = inode->i_ctime = CURRENT_TIME;
407                 inc_nlink(inode);
408
409                 inode->i_fop = &simple_dir_operations;
410                 inode->i_op = &dlmfs_root_inode_operations;
411         }
412
413         return inode;
414 }
415
416 static struct inode *dlmfs_get_inode(struct inode *parent,
417                                      struct dentry *dentry,
418                                      int mode)
419 {
420         struct super_block *sb = parent->i_sb;
421         struct inode * inode = new_inode(sb);
422         struct dlmfs_inode_private *ip;
423
424         if (!inode)
425                 return NULL;
426
427         inode->i_mode = mode;
428         inode->i_uid = current_fsuid();
429         inode->i_gid = current_fsgid();
430         inode->i_mapping->backing_dev_info = &dlmfs_backing_dev_info;
431         inode->i_atime = inode->i_mtime = inode->i_ctime = CURRENT_TIME;
432
433         ip = DLMFS_I(inode);
434         ip->ip_conn = DLMFS_I(parent)->ip_conn;
435
436         switch (mode & S_IFMT) {
437         default:
438                 /* for now we don't support anything other than
439                  * directories and regular files. */
440                 BUG();
441                 break;
442         case S_IFREG:
443                 inode->i_op = &dlmfs_file_inode_operations;
444                 inode->i_fop = &dlmfs_file_operations;
445
446                 i_size_write(inode,  DLM_LVB_LEN);
447
448                 user_dlm_lock_res_init(&ip->ip_lockres, dentry);
449
450                 /* released at clear_inode time, this insures that we
451                  * get to drop the dlm reference on each lock *before*
452                  * we call the unregister code for releasing parent
453                  * directories. */
454                 ip->ip_parent = igrab(parent);
455                 BUG_ON(!ip->ip_parent);
456                 break;
457         case S_IFDIR:
458                 inode->i_op = &dlmfs_dir_inode_operations;
459                 inode->i_fop = &simple_dir_operations;
460
461                 /* directory inodes start off with i_nlink ==
462                  * 2 (for "." entry) */
463                 inc_nlink(inode);
464                 break;
465         }
466
467         if (parent->i_mode & S_ISGID) {
468                 inode->i_gid = parent->i_gid;
469                 if (S_ISDIR(mode))
470                         inode->i_mode |= S_ISGID;
471         }
472
473         return inode;
474 }
475
476 /*
477  * File creation. Allocate an inode, and we're done..
478  */
479 /* SMP-safe */
480 static int dlmfs_mkdir(struct inode * dir,
481                        struct dentry * dentry,
482                        int mode)
483 {
484         int status;
485         struct inode *inode = NULL;
486         struct qstr *domain = &dentry->d_name;
487         struct dlmfs_inode_private *ip;
488         struct ocfs2_cluster_connection *conn;
489
490         mlog(0, "mkdir %.*s\n", domain->len, domain->name);
491
492         /* verify that we have a proper domain */
493         if (domain->len >= GROUP_NAME_MAX) {
494                 status = -EINVAL;
495                 mlog(ML_ERROR, "invalid domain name for directory.\n");
496                 goto bail;
497         }
498
499         inode = dlmfs_get_inode(dir, dentry, mode | S_IFDIR);
500         if (!inode) {
501                 status = -ENOMEM;
502                 mlog_errno(status);
503                 goto bail;
504         }
505
506         ip = DLMFS_I(inode);
507
508         conn = user_dlm_register(domain);
509         if (IS_ERR(conn)) {
510                 status = PTR_ERR(conn);
511                 mlog(ML_ERROR, "Error %d could not register domain \"%.*s\"\n",
512                      status, domain->len, domain->name);
513                 goto bail;
514         }
515         ip->ip_conn = conn;
516
517         inc_nlink(dir);
518         d_instantiate(dentry, inode);
519         dget(dentry);   /* Extra count - pin the dentry in core */
520
521         status = 0;
522 bail:
523         if (status < 0)
524                 iput(inode);
525         return status;
526 }
527
528 static int dlmfs_create(struct inode *dir,
529                         struct dentry *dentry,
530                         int mode,
531                         struct nameidata *nd)
532 {
533         int status = 0;
534         struct inode *inode;
535         struct qstr *name = &dentry->d_name;
536
537         mlog(0, "create %.*s\n", name->len, name->name);
538
539         /* verify name is valid and doesn't contain any dlm reserved
540          * characters */
541         if (name->len >= USER_DLM_LOCK_ID_MAX_LEN ||
542             name->name[0] == '$') {
543                 status = -EINVAL;
544                 mlog(ML_ERROR, "invalid lock name, %.*s\n", name->len,
545                      name->name);
546                 goto bail;
547         }
548
549         inode = dlmfs_get_inode(dir, dentry, mode | S_IFREG);
550         if (!inode) {
551                 status = -ENOMEM;
552                 mlog_errno(status);
553                 goto bail;
554         }
555
556         d_instantiate(dentry, inode);
557         dget(dentry);   /* Extra count - pin the dentry in core */
558 bail:
559         return status;
560 }
561
562 static int dlmfs_unlink(struct inode *dir,
563                         struct dentry *dentry)
564 {
565         int status;
566         struct inode *inode = dentry->d_inode;
567
568         mlog(0, "unlink inode %lu\n", inode->i_ino);
569
570         /* if there are no current holders, or none that are waiting
571          * to acquire a lock, this basically destroys our lockres. */
572         status = user_dlm_destroy_lock(&DLMFS_I(inode)->ip_lockres);
573         if (status < 0) {
574                 mlog(ML_ERROR, "unlink %.*s, error %d from destroy\n",
575                      dentry->d_name.len, dentry->d_name.name, status);
576                 goto bail;
577         }
578         status = simple_unlink(dir, dentry);
579 bail:
580         return status;
581 }
582
583 static int dlmfs_fill_super(struct super_block * sb,
584                             void * data,
585                             int silent)
586 {
587         struct inode * inode;
588         struct dentry * root;
589
590         sb->s_maxbytes = MAX_LFS_FILESIZE;
591         sb->s_blocksize = PAGE_CACHE_SIZE;
592         sb->s_blocksize_bits = PAGE_CACHE_SHIFT;
593         sb->s_magic = DLMFS_MAGIC;
594         sb->s_op = &dlmfs_ops;
595         inode = dlmfs_get_root_inode(sb);
596         if (!inode)
597                 return -ENOMEM;
598
599         root = d_alloc_root(inode);
600         if (!root) {
601                 iput(inode);
602                 return -ENOMEM;
603         }
604         sb->s_root = root;
605         return 0;
606 }
607
608 static const struct file_operations dlmfs_file_operations = {
609         .open           = dlmfs_file_open,
610         .release        = dlmfs_file_release,
611         .poll           = dlmfs_file_poll,
612         .read           = dlmfs_file_read,
613         .write          = dlmfs_file_write,
614 };
615
616 static const struct inode_operations dlmfs_dir_inode_operations = {
617         .create         = dlmfs_create,
618         .lookup         = simple_lookup,
619         .unlink         = dlmfs_unlink,
620 };
621
622 /* this way we can restrict mkdir to only the toplevel of the fs. */
623 static const struct inode_operations dlmfs_root_inode_operations = {
624         .lookup         = simple_lookup,
625         .mkdir          = dlmfs_mkdir,
626         .rmdir          = simple_rmdir,
627 };
628
629 static const struct super_operations dlmfs_ops = {
630         .statfs         = simple_statfs,
631         .alloc_inode    = dlmfs_alloc_inode,
632         .destroy_inode  = dlmfs_destroy_inode,
633         .clear_inode    = dlmfs_clear_inode,
634         .drop_inode     = generic_delete_inode,
635 };
636
637 static const struct inode_operations dlmfs_file_inode_operations = {
638         .getattr        = simple_getattr,
639         .setattr        = dlmfs_file_setattr,
640 };
641
642 static int dlmfs_get_sb(struct file_system_type *fs_type,
643         int flags, const char *dev_name, void *data, struct vfsmount *mnt)
644 {
645         return get_sb_nodev(fs_type, flags, data, dlmfs_fill_super, mnt);
646 }
647
648 static struct file_system_type dlmfs_fs_type = {
649         .owner          = THIS_MODULE,
650         .name           = "ocfs2_dlmfs",
651         .get_sb         = dlmfs_get_sb,
652         .kill_sb        = kill_litter_super,
653 };
654
655 static int __init init_dlmfs_fs(void)
656 {
657         int status;
658         int cleanup_inode = 0, cleanup_worker = 0;
659
660         dlmfs_print_version();
661
662         status = bdi_init(&dlmfs_backing_dev_info);
663         if (status)
664                 return status;
665
666         dlmfs_inode_cache = kmem_cache_create("dlmfs_inode_cache",
667                                 sizeof(struct dlmfs_inode_private),
668                                 0, (SLAB_HWCACHE_ALIGN|SLAB_RECLAIM_ACCOUNT|
669                                         SLAB_MEM_SPREAD),
670                                 dlmfs_init_once);
671         if (!dlmfs_inode_cache) {
672                 status = -ENOMEM;
673                 goto bail;
674         }
675         cleanup_inode = 1;
676
677         user_dlm_worker = create_singlethread_workqueue("user_dlm");
678         if (!user_dlm_worker) {
679                 status = -ENOMEM;
680                 goto bail;
681         }
682         cleanup_worker = 1;
683
684         user_dlm_set_locking_protocol();
685         status = register_filesystem(&dlmfs_fs_type);
686 bail:
687         if (status) {
688                 if (cleanup_inode)
689                         kmem_cache_destroy(dlmfs_inode_cache);
690                 if (cleanup_worker)
691                         destroy_workqueue(user_dlm_worker);
692                 bdi_destroy(&dlmfs_backing_dev_info);
693         } else
694                 printk("OCFS2 User DLM kernel interface loaded\n");
695         return status;
696 }
697
698 static void __exit exit_dlmfs_fs(void)
699 {
700         unregister_filesystem(&dlmfs_fs_type);
701
702         flush_workqueue(user_dlm_worker);
703         destroy_workqueue(user_dlm_worker);
704
705         kmem_cache_destroy(dlmfs_inode_cache);
706
707         bdi_destroy(&dlmfs_backing_dev_info);
708 }
709
710 MODULE_AUTHOR("Oracle");
711 MODULE_LICENSE("GPL");
712
713 module_init(init_dlmfs_fs)
714 module_exit(exit_dlmfs_fs)