1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2 * vim:expandtab:shiftwidth=8:tabstop=8:
4 * linux/fs/filter/filter.c
6 * Copyright (C) 2001 Cluster File Systems, Inc.
8 * This code is issued under the GNU General Public License.
9 * See the file COPYING in this distribution
11 * by Peter Braam <braam@clusterfs.com>
15 #define DEBUG_SUBSYSTEM S_FILTER
17 #include <linux/module.h>
18 #include <linux/lustre_dlm.h>
19 #include <linux/obd_filter.h>
20 #include <linux/ext3_jbd.h>
21 #include <linux/quotaops.h>
23 extern struct obd_device obd_dev[MAX_OBD_DEVICES];
26 #define FILTER_ROOTINO 2
29 static char *obd_type_by_mode[S_IFMT >> S_SHIFT] = {
31 [S_IFREG >> S_SHIFT] "R",
32 [S_IFDIR >> S_SHIFT] "D",
33 [S_IFCHR >> S_SHIFT] "C",
34 [S_IFBLK >> S_SHIFT] "B",
35 [S_IFIFO >> S_SHIFT] "F",
36 [S_IFSOCK >> S_SHIFT] "S",
37 [S_IFLNK >> S_SHIFT] "L"
40 static inline const char *obd_mode_to_type(int mode)
42 return obd_type_by_mode[(mode & S_IFMT) >> S_SHIFT];
45 /* write the pathname into the string */
46 static int filter_id(char *buf, obd_id id, obd_mode mode)
48 return sprintf(buf, "O/%s/%Ld", obd_mode_to_type(mode),
49 (unsigned long long)id);
52 /* setup the object store with correct subdirectories */
53 static int filter_prep(struct obd_device *obddev)
55 struct obd_run_ctxt saved;
56 struct filter_obd *filter = &obddev->u.filter;
57 struct dentry *dentry;
66 push_ctxt(&saved, &filter->fo_ctxt);
67 dentry = simple_mkdir(current->fs->pwd, "O", 0700);
68 CDEBUG(D_INODE, "got/created O: %p\n", dentry);
71 CERROR("cannot open/create O: rc = %d\n", rc);
74 filter->fo_dentry_O = dentry;
75 dentry = simple_mkdir(current->fs->pwd, "P", 0700);
76 CDEBUG(D_INODE, "got/created P: %p\n", dentry);
79 CERROR("cannot open/create P: rc = %d\n", rc);
82 CDEBUG(D_INODE, "putting P: %p, count = %d\n", dentry,
83 atomic_read(&dentry->d_count) - 1);
85 dentry = simple_mkdir(current->fs->pwd, "D", 0700);
86 CDEBUG(D_INODE, "got/created D: %p\n", dentry);
89 CERROR("cannot open/create D: rc = %d\n", rc);
92 CDEBUG(D_INODE, "putting D: %p, count = %d\n", dentry,
93 atomic_read(&dentry->d_count) - 1);
97 * Create directories and/or get dentries for each object type.
98 * This saves us from having to do multiple lookups for each one.
100 for (mode = 0; mode < (S_IFMT >> S_SHIFT); mode++) {
101 char *type = obd_type_by_mode[mode];
104 filter->fo_dentry_O_mode[mode] = NULL;
107 dentry = simple_mkdir(filter->fo_dentry_O, type, 0700);
108 CDEBUG(D_INODE, "got/created O/%s: %p\n", type, dentry);
109 if (IS_ERR(dentry)) {
110 rc = PTR_ERR(dentry);
111 CERROR("cannot create O/%s: rc = %d\n", type, rc);
112 GOTO(out_O_mode, rc);
114 filter->fo_dentry_O_mode[mode] = dentry;
117 filter_id(rootid, FILTER_ROOTINO, S_IFDIR);
118 file = filp_open(rootid, O_RDWR | O_CREAT, 0755);
121 CERROR("OBD filter: cannot open/create root %s: rc = %d\n",
123 GOTO(out_O_mode, rc);
127 file = filp_open("D/status", O_RDWR | O_CREAT, 0700);
128 if ( !file || IS_ERR(file) ) {
130 CERROR("OBD filter: cannot open/create status %s: rc = %d\n",
132 GOTO(out_O_mode, rc);
135 /* steal operations */
136 inode = file->f_dentry->d_inode;
137 filter->fo_fop = file->f_op;
138 filter->fo_iop = inode->i_op;
139 filter->fo_aops = inode->i_mapping->a_ops;
142 if (inode->i_size == 0) {
143 ssize_t retval = file->f_op->write(file, (char *)&lastino,
144 sizeof(lastino), &off);
145 if (retval != sizeof(lastino)) {
146 CDEBUG(D_INODE, "OBD filter: error writing lastino\n");
148 GOTO(out_O_mode, rc = -EIO);
151 ssize_t retval = file->f_op->read(file, (char *)&lastino,
152 sizeof(lastino), &off);
153 if (retval != sizeof(lastino)) {
154 CDEBUG(D_INODE, "OBD filter: error reading lastino\n");
156 GOTO(out_O_mode, rc = -EIO);
159 filter->fo_lastino = lastino;
170 struct dentry *dentry = filter->fo_dentry_O_mode[mode];
172 CDEBUG(D_INODE, "putting O/%s: %p, count = %d\n",
173 obd_type_by_mode[mode], dentry,
174 atomic_read(&dentry->d_count) - 1);
176 filter->fo_dentry_O_mode[mode] = NULL;
180 CDEBUG(D_INODE, "putting O: %p, count = %d\n", filter->fo_dentry_O,
181 atomic_read(&filter->fo_dentry_O->d_count) - 1);
182 dput(filter->fo_dentry_O);
183 filter->fo_dentry_O = NULL;
187 /* cleanup the filter: write last used object id to status file */
188 static void filter_post(struct obd_device *obddev)
190 struct obd_run_ctxt saved;
191 struct filter_obd *filter = &obddev->u.filter;
197 push_ctxt(&saved, &filter->fo_ctxt);
198 file = filp_open("D/status", O_RDWR | O_CREAT, 0700);
200 CERROR("OBD filter: cannot create status file\n");
203 rc = file->f_op->write(file, (char *)&filter->fo_lastino,
204 sizeof(filter->fo_lastino), &off);
205 if (rc != sizeof(filter->fo_lastino))
206 CERROR("OBD filter: error writing lastino: rc = %ld\n", rc);
208 rc = filp_close(file, NULL);
210 CERROR("OBD filter: cannot close status file: rc = %ld\n", rc);
212 for (mode = 0; mode < (S_IFMT >> S_SHIFT); mode++) {
213 struct dentry *dentry = filter->fo_dentry_O_mode[mode];
215 CDEBUG(D_INODE, "putting O/%s: %p, count = %d\n",
216 obd_type_by_mode[mode], dentry,
217 atomic_read(&dentry->d_count) - 1);
219 filter->fo_dentry_O_mode[mode] = NULL;
222 CDEBUG(D_INODE, "putting O: %p, count = %d\n", filter->fo_dentry_O,
223 atomic_read(&filter->fo_dentry_O->d_count) - 1);
224 dput(filter->fo_dentry_O);
230 static __u64 filter_next_id(struct obd_device *obddev)
233 spin_lock(&obddev->u.filter.fo_lock);
234 obddev->u.filter.fo_lastino++;
235 id = obddev->u.filter.fo_lastino;
236 spin_unlock(&obddev->u.filter.fo_lock);
240 /* how to get files, dentries, inodes from object id's */
241 /* parent i_sem is already held if needed for exclusivity */
242 static struct dentry *filter_fid2dentry(struct obd_device *obddev,
243 struct dentry *dparent,
244 __u64 id, __u32 type)
246 struct super_block *sb = obddev->u.filter.fo_sb;
247 struct dentry *dchild;
252 if (!sb || !sb->s_dev) {
253 CERROR("fatal: device not initialized.\n");
254 RETURN(ERR_PTR(-ENXIO));
258 CERROR("fatal: invalid object #0\n");
260 RETURN(ERR_PTR(-ESTALE));
263 if (!(type & S_IFMT)) {
264 CERROR("OBD %s, object %Lu has bad type: %o\n", __FUNCTION__,
265 (unsigned long long)id, type);
266 RETURN(ERR_PTR(-EINVAL));
269 len = sprintf(name, "%Ld", id);
270 CDEBUG(D_INODE, "opening object O/%s/%s\n", obd_mode_to_type(type),
272 dchild = lookup_one_len(name, dparent, len);
273 CDEBUG(D_INODE, "got child obj O/%s/%s: %p, count = %d\n",
274 obd_mode_to_type(type), name, dchild,
275 atomic_read(&dchild->d_count));
277 if (IS_ERR(dchild)) {
278 CERROR("child lookup error %ld\n", PTR_ERR(dchild));
285 static struct file *filter_obj_open(struct obd_device *obddev,
286 __u64 id, __u32 type)
288 struct super_block *sb = obddev->u.filter.fo_sb;
289 struct obd_run_ctxt saved;
294 if (!sb || !sb->s_dev) {
295 CERROR("fatal: device not initialized.\n");
296 RETURN(ERR_PTR(-ENXIO));
300 CERROR("fatal: invalid obdo %Lu\n", (unsigned long long)id);
301 RETURN(ERR_PTR(-ESTALE));
304 if (!(type & S_IFMT)) {
305 CERROR("OBD %s, no type (%Ld), mode %o!\n", __FUNCTION__,
306 (unsigned long long)id, type);
307 RETURN(ERR_PTR(-EINVAL));
310 filter_id(name, id, type);
311 push_ctxt(&saved, &obddev->u.filter.fo_ctxt);
312 file = filp_open(name, O_RDONLY | O_LARGEFILE, 0 /* type? */);
315 CDEBUG(D_INODE, "opening obdo %s: rc = %p\n", name, file);
322 static struct dentry *filter_parent(struct obd_device *obddev, obd_mode mode)
324 struct filter_obd *filter = &obddev->u.filter;
326 return filter->fo_dentry_O_mode[(mode & S_IFMT) >> S_SHIFT];
330 static struct inode *filter_inode_from_obj(struct obd_device *obddev,
331 __u64 id, __u32 type)
333 struct dentry *dentry;
336 dentry = filter_fid2dentry(obddev, filter_parent(obddev, type),
338 if (IS_ERR(dentry)) {
339 CERROR("%s: lookup failed: rc = %ld\n", __FUNCTION__,
345 inode = iget(dentry->d_inode->i_sb, dentry->d_inode->i_ino);
347 CDEBUG(D_INODE, "put child %p, count = %d\n", dentry,
348 atomic_read(&dentry->d_count) - 1);
350 CDEBUG(D_INODE, "got inode %p (%ld), count = %d\n", inode, inode->i_ino,
351 atomic_read(&inode->i_count));
356 static int filter_connect(struct obd_conn *conn, struct obd_device *obd)
361 rc = gen_connect(conn, obd);
369 static int filter_disconnect(struct obd_conn *conn)
373 rc = gen_disconnect(conn);
377 /* XXX cleanup preallocated inodes */
381 /* mount the file system (secretly) */
382 static int filter_setup(struct obd_device *obddev, obd_count len, void *buf)
384 struct obd_ioctl_data* data = buf;
385 struct filter_obd *filter;
386 struct vfsmount *mnt;
390 if (!data->ioc_inlbuf1 || !data->ioc_inlbuf2)
394 mnt = do_kern_mount(data->ioc_inlbuf2, 0, data->ioc_inlbuf1, NULL);
399 filter = &obddev->u.filter;;
400 filter->fo_sb = mnt->mnt_root->d_inode->i_sb;
401 /* XXX is this even possible if do_kern_mount succeeded? */
403 GOTO(err_put, err = -ENODEV);
405 filter->fo_vfsmnt = mnt;
406 filter->fo_fstype = strdup(data->ioc_inlbuf2);
408 OBD_SET_CTXT_MAGIC(&filter->fo_ctxt);
409 filter->fo_ctxt.pwdmnt = mnt;
410 filter->fo_ctxt.pwd = mnt->mnt_root;
411 filter->fo_ctxt.fs = get_ds();
413 err = filter_prep(obddev);
415 GOTO(err_kfree, err);
416 spin_lock_init(&filter->fo_lock);
418 obddev->obd_namespace =
419 ldlm_namespace_new("filter-tgt", LDLM_NAMESPACE_SERVER);
420 if (obddev->obd_namespace == NULL)
426 kfree(filter->fo_fstype);
429 mntput(filter->fo_vfsmnt);
439 static int filter_cleanup(struct obd_device * obddev)
441 struct super_block *sb;
444 if (!(obddev->obd_flags & OBD_SET_UP))
447 if (!list_empty(&obddev->obd_exports)) {
448 CERROR("still has clients!\n");
452 ldlm_namespace_free(obddev->obd_namespace);
454 sb = obddev->u.filter.fo_sb;
455 if (!obddev->u.filter.fo_sb)
460 shrink_dcache_parent(sb->s_root);
462 mntput(obddev->u.filter.fo_vfsmnt);
463 obddev->u.filter.fo_sb = 0;
464 kfree(obddev->u.filter.fo_fstype);
473 static inline void filter_from_inode(struct obdo *oa, struct inode *inode)
475 int type = oa->o_mode & S_IFMT;
478 CDEBUG(D_INFO, "src inode %ld, dst obdo %ld valid 0x%08x\n",
479 inode->i_ino, (long)oa->o_id, oa->o_valid);
480 obdo_from_inode(oa, inode);
481 oa->o_mode &= ~S_IFMT;
484 if (S_ISCHR(inode->i_mode) || S_ISBLK(inode->i_mode)) {
485 obd_rdev rdev = kdev_t_to_nr(inode->i_rdev);
486 CDEBUG(D_INODE, "copying device %x from inode to obdo\n",
488 *((obd_rdev *)oa->o_inline) = rdev;
489 oa->o_obdflags |= OBD_FL_INLINEDATA;
490 oa->o_valid |= OBD_MD_FLINLINE;
494 else if (filter_has_inline(inode)) {
495 CDEBUG(D_INFO, "copying inline from inode to obdo\n");
496 memcpy(oa->o_inline, inode->u.ext2_i.i_data,
497 MIN(sizeof(inode->u.ext2_i.i_data),OBD_INLINESZ));
498 oa->o_obdflags |= OBD_FL_INLINEDATA;
499 oa->o_valid |= OBD_MD_FLINLINE;
502 if (filter_has_obdmd(inode)) {
503 /* XXX this will change when we don't store the obdmd in data */
504 CDEBUG(D_INFO, "copying obdmd from inode to obdo\n");
505 memcpy(oa->o_obdmd, inode->u.ext2_i.i_data,
506 MIN(sizeof(inode->u.ext2_i.i_data),OBD_INLINESZ));
507 oa->o_obdflags |= OBD_FL_OBDMDEXISTS;
508 oa->o_valid |= OBD_MD_FLOBDMD;
514 static int filter_getattr(struct obd_conn *conn, struct obdo *oa)
516 struct obd_device *obddev = gen_conn2obd(conn);
517 struct dentry *dentry;
520 if (!gen_client(conn)) {
521 CDEBUG(D_IOCTL, "fatal: invalid client %Lx\n", conn->addr);
525 obddev = gen_conn2obd(conn);
526 dentry = filter_fid2dentry(obddev, filter_parent(obddev, oa->o_mode),
527 oa->o_id, oa->o_mode);
529 RETURN(PTR_ERR(dentry));
531 oa->o_valid &= ~OBD_MD_FLID;
532 filter_from_inode(oa, dentry->d_inode);
538 static int filter_setattr(struct obd_conn *conn, struct obdo *oa)
540 struct obd_run_ctxt saved;
541 struct obd_device *obd = gen_conn2obd(conn);
542 struct dentry *dentry;
548 dentry = filter_fid2dentry(obd, filter_parent(obd, oa->o_mode),
549 oa->o_id, oa->o_mode);
551 RETURN(PTR_ERR(dentry));
553 inode = dentry->d_inode;
554 iattr_from_obdo(&iattr, oa);
555 iattr.ia_mode &= ~S_IFMT;
556 iattr.ia_mode |= S_IFREG;
558 if (iattr.ia_mode & ATTR_SIZE)
560 push_ctxt(&saved, &obd->u.filter.fo_ctxt);
561 if (inode->i_op->setattr)
562 rc = inode->i_op->setattr(dentry, &iattr);
564 rc = inode_setattr(inode, &iattr);
566 if (iattr.ia_mode & ATTR_SIZE) {
568 oa->o_valid = OBD_MD_FLBLOCKS | OBD_MD_FLCTIME | OBD_MD_FLMTIME;
569 obdo_from_inode(oa, inode);
573 CDEBUG(D_INODE, "put dentry %p, count = %d\n", inode,
574 atomic_read(&dentry->d_count) - 1);
579 static int filter_open(struct obd_conn *conn, struct obdo *oa)
581 struct obd_device *obd;
582 struct dentry *dentry;
585 if (!gen_client(conn)) {
586 CDEBUG(D_IOCTL, "fatal: invalid client %Lx\n", conn->addr);
590 obd = gen_conn2obd(conn);
591 dentry = filter_fid2dentry(obd, filter_parent(obd, oa->o_mode),
592 oa->o_id, oa->o_mode);
594 RETURN(PTR_ERR(dentry));
599 static int filter_close(struct obd_conn *conn, struct obdo *oa)
601 struct obd_device *obd;
602 struct dentry *dentry;
605 if (!gen_client(conn)) {
606 CDEBUG(D_IOCTL, "fatal: invalid client %Lx\n", conn->addr);
610 obd = gen_conn2obd(conn);
611 dentry = filter_fid2dentry(obd, filter_parent(obd, oa->o_mode),
612 oa->o_id, oa->o_mode);
614 RETURN(PTR_ERR(dentry));
616 CDEBUG(D_INODE, "put dentry %p, count = %d\n", dentry,
617 atomic_read(&dentry->d_count) - 1);
618 dput(dentry); /* for the close */
619 CDEBUG(D_INODE, "put dentry %p, count = %d\n", dentry,
620 atomic_read(&dentry->d_count) - 1);
621 dput(dentry); /* for this call */
625 static int filter_create(struct obd_conn* conn, struct obdo *oa)
628 struct obd_run_ctxt saved;
631 struct obd_device *obd = gen_conn2obd(conn);
635 if (!gen_client(conn)) {
636 CERROR("invalid client %Lx\n", conn->addr);
640 oa->o_id = filter_next_id(obd);
641 if (!(oa->o_mode && S_IFMT)) {
642 CERROR("filter obd: no type!\n");
646 filter_id(name, oa->o_id, oa->o_mode);
647 mode = (oa->o_mode & ~S_IFMT) | S_IFREG;
648 push_ctxt(&saved, &obd->u.filter.fo_ctxt);
649 file = filp_open(name, O_RDONLY | O_CREAT, mode);
652 CERROR("Error mknod obj %s, err %ld\n", name, PTR_ERR(file));
657 /* Set flags for fields we have set in the inode struct */
658 oa->o_valid |= OBD_MD_FLID | OBD_MD_FLBLKSZ | OBD_MD_FLBLOCKS |
659 OBD_MD_FLMTIME | OBD_MD_FLATIME | OBD_MD_FLCTIME |
660 OBD_MD_FLUID | OBD_MD_FLGID;
662 /* XXX Hmm, shouldn't we copy the fields into the obdo here? */
666 static int filter_destroy(struct obd_conn *conn, struct obdo *oa)
668 struct obd_run_ctxt saved;
669 struct obd_device *obd;
670 struct obd_export *export;
672 struct dentry *dir_dentry, *object_dentry;
676 if (!(export = gen_client(conn))) {
677 CERROR("invalid client %Lx\n", conn->addr);
681 CDEBUG(D_INODE, "destroying object %Ld\n",oa->o_id);
682 obd = gen_conn2obd(conn);
684 dir_dentry = filter_parent(obd, oa->o_mode);
685 down(&dir_dentry->d_inode->i_sem);
687 object_dentry = filter_fid2dentry(obd, dir_dentry, oa->o_id,
689 if (IS_ERR(object_dentry))
690 GOTO(out, rc = -ENOENT);
692 inode = object_dentry->d_inode;
693 if (inode->i_nlink != 1) {
694 CERROR("destroying inode with nlink = %d\n", inode->i_nlink);
697 inode->i_mode = S_IFREG;
699 push_ctxt(&saved, &obd->u.filter.fo_ctxt);
701 rc = vfs_unlink(dir_dentry->d_inode, object_dentry);
703 CDEBUG(D_INODE, "put child %p, count = %d\n", object_dentry,
704 atomic_read(&object_dentry->d_count) - 1);
709 up(&dir_dentry->d_inode->i_sem);
713 /* NB count and offset are used for punch, but not truncate */
714 static int filter_truncate(struct obd_conn *conn, struct obdo *oa,
715 obd_size count, obd_off offset)
720 CDEBUG(D_INODE, "calling truncate for object #%Ld, valid = %x, "
721 "o_size = %Ld\n", oa->o_id, oa->o_valid, oa->o_size);
722 error = filter_setattr(conn, oa);
727 static int filter_pgcache_brw(int cmd, struct obd_conn *conn, obd_count num_oa,
728 struct obdo **oa, obd_count *oa_bufs,
729 struct page **pages, obd_size *count,
730 obd_off *offset, obd_flag *flags, void *callback)
732 struct obd_run_ctxt saved;
733 struct super_block *sb;
734 int onum; /* index to oas */
735 int pnum; /* index to pages (bufs) */
736 unsigned long retval;
739 struct obd_device *obd = gen_conn2obd(conn);
742 if (!gen_client(conn)) {
743 CDEBUG(D_IOCTL, "invalid client %Lx\n", conn->addr);
747 sb = obd->u.filter.fo_sb;
748 push_ctxt(&saved, &obd->u.filter.fo_ctxt);
749 pnum = 0; /* pnum indexes buf 0..num_pages */
750 for (onum = 0; onum < num_oa; onum++) {
753 file = filter_obj_open(obd, oa[onum]->o_id, oa[onum]->o_mode);
755 GOTO(out, retval = PTR_ERR(file));
757 /* count doubles as retval */
758 for (pg = 0; pg < oa_bufs[onum]; pg++) {
759 CDEBUG(D_INODE, "OP %d obdo no/pno: (%d,%d) (%ld,%ld) "
760 "off count (%Ld,%Ld)\n",
761 cmd, onum, pnum, file->f_dentry->d_inode->i_ino,
762 (unsigned long)offset[pnum] >> PAGE_CACHE_SHIFT,
763 (unsigned long long)offset[pnum],
764 (unsigned long long)count[pnum]);
765 if (cmd & OBD_BRW_WRITE) {
769 buffer = kmap(pages[pnum]);
770 retval = file->f_op->write(file, buffer, count[pnum], &off);
772 CDEBUG(D_INODE, "retval %ld\n", retval);
774 loff_t off = offset[pnum];
775 char *buffer = kmap(pages[pnum]);
777 if (off >= file->f_dentry->d_inode->i_size) {
778 memset(buffer, 0, count[pnum]);
779 retval = count[pnum];
781 retval = file->f_op->read(file, buffer, count[pnum], &off);
785 if (retval != count[pnum]) {
787 GOTO(out, retval = -EIO);
789 CDEBUG(D_INODE, "retval %ld\n", retval);
793 /* sizes and blocks are set by generic_file_write */
794 /* ctimes/mtimes will follow with a setattr call */
801 error = (retval >= 0) ? 0 : retval;
806 struct inode *ioobj_to_inode(struct obd_conn *conn, struct obd_ioobj *o)
808 struct obd_device *obd = gen_conn2obd(conn);
809 struct super_block *sb = obd->u.filter.fo_sb;
810 struct inode *inode = NULL;
813 if (!sb || !sb->s_dev) {
814 CDEBUG(D_SUPER, "fatal: device not initialized.\n");
819 CDEBUG(D_INODE, "fatal: invalid obdo %lu\n", (long)o->ioo_id);
823 inode = filter_inode_from_obj(obd, o->ioo_id, S_IFREG);
824 if (!inode || inode->i_nlink == 0 || is_bad_inode(inode)) {
825 CERROR("from obdo - fatal: invalid inode %ld (%s).\n",
826 (long)o->ioo_id, inode ? inode->i_nlink ? "bad inode" :
827 "no links" : "NULL");
836 * Calculate the number of buffer credits needed to write multiple pages in
837 * a single ext3/extN transaction. No, this shouldn't be here, but as yet
838 * ext3 doesn't have a nice API for calculating this sort of thing in advance.
840 * See comment above ext3_writepage_trans_blocks for details. We assume
841 * no data journaling is being done, but it does allow for all of the pages
842 * being non-contiguous. If we are guaranteed contiguous pages we could
843 * reduce the number of (d)indirect blocks a lot.
845 * With N blocks per page and P pages, for each inode we have at most:
847 * min(N*P, blocksize/4 + 1) dindirect blocks
850 * For the entire filesystem, we have at most:
851 * min(sum(nindir + P), ngroups) bitmap blocks (from the above)
852 * min(sum(nindir + P), gdblocks) group descriptor blocks (from the above)
855 * 2 * EXT3_SINGLEDATA_TRANS_BLOCKS for the quota files
857 static int ext3_credits_needed(struct super_block *sb, int objcount,
858 struct obd_ioobj *obj)
860 struct obd_ioobj *o = obj;
861 int blockpp = 1 << (PAGE_CACHE_SHIFT - sb->s_blocksize_bits);
862 int addrpp = EXT3_ADDR_PER_BLOCK(sb) * blockpp;
865 int needed = objcount + 1;
868 for (i = 0; i < objcount; i++, o++) {
869 int nblocks = o->ioo_bufcnt * blockpp;
870 int ndindirect = min(nblocks, addrpp + 1);
871 int nindir = nblocks + ndindirect + 1;
873 nbitmaps += nindir + nblocks;
874 ngdblocks += nindir + nblocks;
879 if (nbitmaps > EXT3_SB(sb)->s_groups_count)
880 nbitmaps = EXT3_SB(sb)->s_groups_count;
881 if (ngdblocks > EXT3_SB(sb)->s_gdb_count)
882 ngdblocks = EXT3_SB(sb)->s_gdb_count;
884 needed += nbitmaps + ngdblocks;
887 /* We assume that there will be 1 bit set in s_dquot.flags for each
888 * quota file that is active. This is at least true for now.
890 needed += hweight32(sb_any_quota_enabled(sb)) *
891 EXT3_SINGLEDATA_TRANS_BLOCKS;
897 /* We have to start a huge journal transaction here to hold all of the
898 * metadata for the pages being written here. This is necessitated by
899 * the fact that we do lots of prepare_write operations before we do
900 * any of the matching commit_write operations, so even if we split
901 * up to use "smaller" transactions none of them could complete until
902 * all of them were opened. By having a single journal transaction,
903 * we eliminate duplicate reservations for common blocks like the
904 * superblock and group descriptors or bitmaps.
906 * We will start the transaction here, but each prepare_write will
907 * add a refcount to the transaction, and each commit_write will
908 * remove a refcount. The transaction will be closed when all of
909 * the pages have been written.
911 static void *ext3_filter_journal_start(struct filter_obd *filter,
912 int objcount, struct obd_ioobj *obj,
913 int niocount, struct niobuf_remote *nb)
915 journal_t *journal = NULL;
916 handle_t *handle = NULL;
919 /* Assumes ext3 and extN have same sb_info layout, but avoids issues
920 * with having extN built properly before filterobd for now.
922 journal = EXT3_SB(filter->fo_sb)->s_journal;
923 needed = ext3_credits_needed(filter->fo_sb, objcount, obj);
925 /* The number of blocks we could _possibly_ dirty can very large.
926 * We reduce our request if it is absurd (and we couldn't get that
927 * many credits for a single handle anyways).
929 * At some point we have to limit the size of I/Os sent at one time,
930 * increase the size of the journal, or we have to calculate the
931 * actual journal requirements more carefully by checking all of
932 * the blocks instead of being maximally pessimistic. It remains to
933 * be seen if this is a real problem or not.
935 if (needed > journal->j_max_transaction_buffers) {
936 CERROR("want too many journal credits (%d) using %d instead\n",
937 needed, journal->j_max_transaction_buffers);
938 needed = journal->j_max_transaction_buffers;
941 handle = journal_start(journal, needed);
943 CERROR("can't get handle for %d credits: rc = %ld\n", needed,
949 static void *filter_journal_start(void **journal_save,
950 struct filter_obd *filter,
951 int objcount, struct obd_ioobj *obj,
952 int niocount, struct niobuf_remote *nb)
956 /* This may not be necessary - we probably never have a
957 * transaction started when we enter here, so we can
958 * remove the saving of the journal state entirely.
959 * For now leave it in just to see if it ever happens.
961 *journal_save = current->journal_info;
963 CERROR("Already have handle %p???\n", *journal_save);
965 current->journal_info = NULL;
968 if (!strcmp(filter->fo_fstype, "ext3") ||
969 !strcmp(filter->fo_fstype, "extN"))
970 handle = ext3_filter_journal_start(filter, objcount, obj,
975 static int ext3_filter_journal_stop(void *handle)
979 /* We got a refcount on the handle for each call to prepare_write,
980 * so we can drop the "parent" handle here to avoid the need for
981 * osc to call back into filterobd to close the handle. The
982 * remaining references will be dropped in commit_write.
984 rc = journal_stop((handle_t *)handle);
989 static int filter_journal_stop(void *journal_save, struct filter_obd *filter,
994 if (!strcmp(filter->fo_fstype, "ext3") ||
995 !strcmp(filter->fo_fstype, "extN"))
996 rc = ext3_filter_journal_stop(handle);
999 CERROR("error on journal stop: rc = %d\n", rc);
1001 current->journal_info = journal_save;
1006 struct page *filter_get_page_write(struct inode *inode, unsigned long index,
1007 struct niobuf_local *lnb)
1009 struct address_space *mapping = inode->i_mapping;
1013 //ASSERT_PAGE_INDEX(index, GOTO(err, rc = -EINVAL));
1014 page = grab_cache_page_nowait(mapping, index); /* locked page */
1016 /* This page is currently locked, so get a temporary page instead */
1019 CDEBUG(D_PAGE, "ino %ld page %ld locked\n", inode->i_ino,index);
1020 addr = __get_free_pages(GFP_KERNEL, 0); /* locked page */
1022 CERROR("no memory for a temp page\n");
1024 GOTO(err, rc = -ENOMEM);
1026 page = virt_to_page(addr);
1028 page->index = index;
1029 lnb->flags |= N_LOCAL_TEMP_PAGE;
1030 } else if (!IS_ERR(page)) {
1031 /* Note: Called with "O" and "PAGE_SIZE" this is essentially
1032 * a no-op for most filesystems, because we write the whole
1033 * page. For partial-page I/O this will read in the page.
1036 rc = mapping->a_ops->prepare_write(NULL, page, 0, PAGE_SIZE);
1038 CERROR("page index %lu, rc = %d\n", index, rc);
1041 GOTO(err_unlock, rc);
1043 /* XXX not sure if we need this if we are overwriting page */
1044 if (PageError(page)) {
1045 CERROR("error on page index %lu, rc = %d\n", index, rc);
1047 GOTO(err_unlock, rc = -EIO);
1054 lustre_put_page(page);
1060 * We need to balance prepare_write() calls with commit_write() calls.
1061 * If the page has been prepared, but we have no data for it, we don't
1062 * want to overwrite valid data on disk, but we still need to zero out
1063 * data for space which was newly allocated. Like part of what happens
1064 * in __block_prepare_write() for newly allocated blocks.
1066 * XXX currently __block_prepare_write() creates buffers for all the
1067 * pages, and the filesystems mark these buffers as BH_New if they
1068 * were newly allocated from disk. We use the BH_New flag similarly.
1070 static int filter_commit_write(struct page *page, unsigned from, unsigned to,
1074 unsigned block_start, block_end;
1075 struct buffer_head *bh, *head = page->buffers;
1076 unsigned blocksize = head->b_size;
1077 void *addr = page_address(page);
1079 /* Currently one buffer per page, but in the future... */
1080 for (bh = head, block_start = 0; bh != head || !block_start;
1081 block_start = block_end, bh = bh->b_this_page) {
1082 block_end = block_start + blocksize;
1084 memset(addr + block_start, 0, blocksize);
1088 return lustre_commit_write(page, from, to);
1091 static int filter_preprw(int cmd, struct obd_conn *conn,
1092 int objcount, struct obd_ioobj *obj,
1093 int niocount, struct niobuf_remote *nb,
1094 struct niobuf_local *res, void **desc_private)
1096 struct obd_run_ctxt saved;
1097 struct obd_device *obd;
1098 struct obd_ioobj *o = obj;
1099 struct niobuf_remote *b = nb;
1100 struct niobuf_local *r = res;
1101 void *journal_save = NULL;
1106 memset(res, 0, sizeof(*res) * niocount);
1107 obd = gen_conn2obd(conn);
1109 push_ctxt(&saved, &obd->u.filter.fo_ctxt);
1111 if (cmd & OBD_BRW_WRITE) {
1112 *desc_private = filter_journal_start(&journal_save,
1114 objcount, obj, niocount,
1116 if (IS_ERR(*desc_private))
1117 GOTO(out_ctxt, rc = PTR_ERR(*desc_private));
1120 for (i = 0; i < objcount; i++, o++) {
1121 struct dentry *dentry;
1122 struct inode *inode;
1125 dentry = filter_fid2dentry(obd,
1126 filter_parent(obd, S_IFREG),
1127 o->ioo_id, S_IFREG);
1129 GOTO(out_clean, rc = PTR_ERR(dentry));
1130 inode = dentry->d_inode;
1132 CERROR("trying to BRW to non-existent file %Ld\n",
1133 (unsigned long long)o->ioo_id);
1135 GOTO(out_clean, rc = -ENOENT);
1138 for (j = 0; j < o->ioo_bufcnt; j++, b++, r++) {
1139 unsigned long index = b->offset >> PAGE_SHIFT;
1145 r->dentry = dget(dentry);
1147 if (cmd & OBD_BRW_WRITE)
1148 page = filter_get_page_write(inode, index, r);
1150 page = lustre_get_page_read(inode, index);
1154 GOTO(out_clean, rc = PTR_ERR(page));
1157 r->addr = page_address(page);
1158 r->offset = b->offset;
1165 if (cmd & OBD_BRW_WRITE) {
1166 int err = filter_journal_stop(journal_save, &obd->u.filter,
1177 if (cmd & OBD_BRW_WRITE)
1178 filter_commit_write(r->page, 0, PAGE_SIZE, rc);
1180 lustre_put_page(r->page);
1185 static int filter_write_locked_page(struct niobuf_local *lnb)
1190 lpage = lustre_get_page_write(lnb->dentry->d_inode, lnb->page->index);
1191 if (IS_ERR(lpage)) {
1192 /* It is highly unlikely that we would ever get an error here.
1193 * The page we want to get was previously locked, so it had to
1194 * have already allocated the space, and we were just writing
1195 * over the same data, so there would be no hole in the file.
1197 * XXX: possibility of a race with truncate could exist, need
1198 * to check that. There are no guarantees w.r.t.
1199 * write order even on a local filesystem, although the
1200 * normal response would be to return the number of bytes
1201 * successfully written and leave the rest to the app.
1203 rc = PTR_ERR(lpage);
1204 CERROR("error getting locked page index %ld: rc = %d\n",
1205 lnb->page->index, rc);
1209 memcpy(page_address(lpage), kmap(lnb->page), PAGE_SIZE);
1210 rc = lustre_commit_write(lpage, 0, PAGE_SIZE);
1212 CERROR("error committing locked page %ld: rc = %d\n",
1213 lnb->page->index, rc);
1216 __free_pages(lnb->page, 0);
1222 static int filter_commitrw(int cmd, struct obd_conn *conn,
1223 int objcount, struct obd_ioobj *obj,
1224 int niocount, struct niobuf_local *res,
1227 struct obd_run_ctxt saved;
1228 struct obd_ioobj *o = obj;
1229 struct niobuf_local *r = res;
1230 struct obd_device *obd = gen_conn2obd(conn);
1232 int found_locked = 0;
1237 push_ctxt(&saved, &obd->u.filter.fo_ctxt);
1238 journal_save = current->journal_info;
1240 CERROR("Existing handle %p???\n", journal_save);
1241 current->journal_info = private;
1242 for (i = 0; i < objcount; i++, obj++) {
1244 for (j = 0 ; j < o->ioo_bufcnt ; j++, r++) {
1245 struct page *page = r->page;
1250 if (r->flags & N_LOCAL_TEMP_PAGE) {
1255 if (cmd & OBD_BRW_WRITE) {
1256 int err = filter_commit_write(page, 0,
1262 lustre_put_page(page);
1265 "put inode %p (%ld), count = %d, nlink = %d\n",
1266 page->mapping->host,
1267 page->mapping->host->i_ino,
1268 atomic_read(&page->mapping->host->i_count) - 1,
1269 page->mapping->host->i_nlink);
1276 for (i = 0; i < objcount; i++, obj++) {
1278 for (j = 0 ; j < o->ioo_bufcnt ; j++, r++) {
1280 if (!(r->flags & N_LOCAL_TEMP_PAGE))
1283 err = filter_write_locked_page(r);
1290 current->journal_info = journal_save;
1295 static int filter_statfs(struct obd_conn *conn, struct statfs * statfs)
1297 struct super_block *sb;
1301 if (!gen_client(conn)) {
1302 CDEBUG(D_IOCTL, "invalid client %Lx\n", conn->addr);
1306 sb = gen_conn2obd(conn)->u.filter.fo_sb;
1308 err = sb->s_op->statfs(sb, statfs);
1310 } /* filter_statfs */
1313 static int filter_get_info(struct obd_conn *conn, obd_count keylen,
1314 void *key, obd_count *vallen, void **val)
1316 struct obd_device *obd;
1317 struct obd_export * export;
1320 if (!(export = gen_client(conn))) {
1321 CDEBUG(D_IOCTL, "invalid client %Lx\n", conn->addr);
1325 obd = gen_conn2obd(conn);
1327 if ( keylen == strlen("blocksize") &&
1328 memcmp(key, "blocksize", keylen) == 0 ) {
1329 *vallen = sizeof(long);
1330 *val = (void *)(long)obd->u.filter.fo_sb->s_blocksize;
1334 if ( keylen == strlen("blocksize_bits") &&
1335 memcmp(key, "blocksize_bits", keylen) == 0 ){
1336 *vallen = sizeof(long);
1337 *val = (void *)(long)obd->u.filter.fo_sb->s_blocksize_bits;
1341 if ( keylen == strlen("root_ino") &&
1342 memcmp(key, "root_ino", keylen) == 0 ){
1343 *vallen = sizeof(long);
1344 *val = (void *)(long)FILTER_ROOTINO;
1348 CDEBUG(D_IOCTL, "invalid key\n");
1353 static struct obd_ops filter_obd_ops = {
1354 o_get_info: filter_get_info,
1355 o_setup: filter_setup,
1356 o_cleanup: filter_cleanup,
1357 o_connect: filter_connect,
1358 o_disconnect: filter_disconnect,
1359 o_statfs: filter_statfs,
1360 o_getattr: filter_getattr,
1361 o_create: filter_create,
1362 o_setattr: filter_setattr,
1363 o_destroy: filter_destroy,
1364 o_open: filter_open,
1365 o_close: filter_close,
1366 o_brw: filter_pgcache_brw,
1367 o_punch: filter_truncate,
1368 o_preprw: filter_preprw,
1369 o_commitrw: filter_commitrw
1371 o_preallocate: filter_preallocate_inodes,
1372 o_migrate: filter_migrate,
1373 o_copy: gen_copy_data,
1374 o_iterate: filter_iterate
1379 static int __init obdfilter_init(void)
1381 printk(KERN_INFO "Filtering OBD driver v0.001, braam@clusterfs.com\n");
1382 return obd_register_type(&filter_obd_ops, OBD_FILTER_DEVICENAME);
1385 static void __exit obdfilter_exit(void)
1387 obd_unregister_type(OBD_FILTER_DEVICENAME);
1390 MODULE_AUTHOR("Peter J. Braam <braam@clusterfs.com>");
1391 MODULE_DESCRIPTION("Lustre Filtering OBD driver v1.0");
1392 MODULE_LICENSE("GPL");
1394 module_init(obdfilter_init);
1395 module_exit(obdfilter_exit);