1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2 * vim:expandtab:shiftwidth=8:tabstop=8:
4 * Copyright (C) 2001-2004 Cluster File Systems, Inc. <info@clusterfs.com>
6 * This file is part of Lustre, http://www.lustre.org.
8 * Lustre is free software; you can redistribute it and/or
9 * modify it under the terms of version 2 of the GNU General Public
10 * License as published by the Free Software Foundation.
12 * Lustre is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with Lustre; if not, write to the Free Software
19 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21 * Filesystem interface helper.
25 #ifndef _LUSTRE_FSFILT_H
26 #define _LUSTRE_FSFILT_H
30 #include <linux/obd.h>
31 #include <linux/lustre_log.h>
32 #include <linux/obd_class.h>
34 typedef void (*fsfilt_cb_t)(struct obd_device *obd, __u64 last_rcvd,
35 void *data, int error);
37 struct fsfilt_objinfo {
38 struct dentry *fso_dentry;
42 struct fsfilt_operations {
43 struct list_head fs_list;
44 struct module *fs_owner;
46 void *(* fs_start)(struct inode *inode, int op, void *desc_private,
48 void *(* fs_brw_start)(int objcount, struct fsfilt_objinfo *fso,
49 int niocount, struct niobuf_local *nb,
50 void *desc_private, int logs);
51 int (* fs_commit)(struct super_block *sb, struct inode *inode,
52 void *handle,int force_sync);
53 int (* fs_commit_async)(struct inode *inode, void *handle,
55 int (* fs_commit_wait)(struct inode *inode, void *handle);
56 int (* fs_setattr)(struct dentry *dentry, void *handle,
57 struct iattr *iattr, int do_trunc);
58 int (* fs_iocontrol)(struct inode *inode, struct file *file,
59 unsigned int cmd, unsigned long arg);
60 int (* fs_set_md)(struct inode *inode, void *handle, void *md,
62 int (* fs_get_md)(struct inode *inode, void *md, int size);
64 /* this method is needed to make IO operation fsfilt nature depend. */
65 #if (LINUX_VERSION_CODE > KERNEL_VERSION(2,5,0))
66 int (* fs_send_bio)(struct inode *inode, struct bio *bio);
68 int (* fs_send_bio)(struct inode *inode, struct kiobuf *bio);
71 /* methods for getting page from backing fs and putting page there
72 * during IO. Used on OST. */
73 int (* fs_putpage)(struct inode *inode, struct page *page);
74 struct page *(* fs_getpage)(struct inode *inode, long int index);
76 ssize_t (* fs_readpage)(struct file *file, char *buf, size_t count,
78 int (* fs_add_journal_cb)(struct obd_device *obd, struct super_block *sb,
79 __u64 last_rcvd, void *handle, fsfilt_cb_t cb_func,
81 int (* fs_statfs)(struct super_block *sb, struct obd_statfs *osfs);
82 int (* fs_sync)(struct super_block *sb);
83 int (* fs_map_inode_pages)(struct inode *inode, struct page **page,
84 int pages, unsigned long *blocks,
85 int *created, int create,
86 struct semaphore *sem);
87 int (* fs_prep_san_write)(struct inode *inode, long *blocks,
88 int nblocks, loff_t newsize);
89 int (* fs_write_record)(struct file *, void *, int size, loff_t *,
91 int (* fs_read_record)(struct file *, void *, int size, loff_t *);
92 int (* fs_setup)(struct obd_device *, struct super_block *);
94 int (* fs_post_setup)(struct obd_device *obd, struct vfsmount *mnt,
95 struct dentry *dentry);
96 int (* fs_post_cleanup)(struct obd_device *obd, struct vfsmount *mnt);
97 int (* fs_get_reint_log_ctxt)(struct super_block *sb,
98 struct llog_ctxt **ctxt);
99 int (* fs_set_fs_flags)(struct inode *inode, int flags);
100 int (* fs_clear_fs_flags)(struct inode *inode, int flags);
101 int (* fs_set_ost_flags)(struct super_block *sb);
102 int (* fs_set_mds_flags)(struct super_block *sb);
103 int (* fs_precreate_rec)(struct dentry *dentry, int *num,
105 int (* fs_set_xattr)(struct inode *inode, void *handle, char *name,
106 void *buffer, int buffer_size);
107 int (* fs_get_xattr)(struct inode *inode, char *name,
108 void *buffer, int buffer_size);
110 int (* fs_init_extents_ea)(struct inode *inode);
111 int (* fs_insert_extents_ea)(struct inode *inode, unsigned long from,
113 int (* fs_do_write_cow)(struct dentry *dentry, void *extents, int nexts);
114 int (* fs_write_extents)(struct dentry *dentry,
115 unsigned long offset, unsigned long blks);
116 int (* fs_get_fs_flags)(struct dentry *dentry);
117 int (* fs_remove_extents_ea)(struct inode *inode, unsigned long from,
119 int (* fs_get_ino_write_extents)(struct super_block *sb, ino_t ino,
120 char **pbuf, int *size);
121 int (* fs_free_write_extents)(struct super_block *sb, ino_t ino,
122 char *pbuf, int size);
123 int (* fs_get_inode_write_extents)(struct inode *inode, char **pbuf,
125 int (* fs_get_write_extents_num)(struct inode *inode, int* size);
127 int (* fs_get_op_len)(int, struct fsfilt_objinfo *, int);
128 int (* fs_add_dir_entry)(struct obd_device *, struct dentry *,
129 char *, int, unsigned long, unsigned long,
131 int (* fs_del_dir_entry)(struct obd_device *, struct dentry *);
133 int (* fs_is_redirector)(struct inode *inode);
134 int (* fs_is_indirect)(struct inode *inode);
136 struct inode * (* fs_create_indirect)(struct inode *pri, int index,
137 unsigned int gen, struct inode *parent,
139 struct inode * (* fs_get_indirect)(struct inode *pri, int *table,
141 ino_t (* fs_get_indirect_ino)(struct inode *pri, int index);
142 int (* fs_destroy_indirect)(struct inode *pri, int index,
143 struct inode *next_ind);
144 int (* fs_restore_indirect)(struct inode *pri, int index);
145 int (* fs_iterate)(struct super_block *sb,
146 int (*repeat)(struct inode *inode, void *priv),
147 struct inode **start, void *priv, int flag);
148 int (* fs_copy_block)(struct inode *dst, struct inode *src, int blk);
149 int (* fs_set_indirect)(struct inode *pri, int index,
150 ino_t ind_ino, ino_t parent_ino);
151 int (* fs_snap_feature)(struct super_block *sb, int feature, int op);
152 int (* fs_set_snap_info)(struct inode *inode, void* key, __u32 keylen,
153 void *val, __u32 *vallen);
154 int (* fs_get_snap_info)(struct inode *inode, void* key, __u32 keylen,
155 void *val, __u32 *vallen);
156 int (* fs_set_snap_item)(struct super_block *sb, char *name);
159 extern int fsfilt_register_ops(struct fsfilt_operations *fs_ops);
160 extern void fsfilt_unregister_ops(struct fsfilt_operations *fs_ops);
161 extern struct fsfilt_operations *fsfilt_get_ops(const char *type);
162 extern void fsfilt_put_ops(struct fsfilt_operations *fs_ops);
164 #define FSFILT_OP_UNLINK 1
165 #define FSFILT_OP_RMDIR 2
166 #define FSFILT_OP_RENAME 3
167 #define FSFILT_OP_CREATE 4
168 #define FSFILT_OP_MKDIR 5
169 #define FSFILT_OP_SYMLINK 6
170 #define FSFILT_OP_MKNOD 7
171 #define FSFILT_OP_SETATTR 8
172 #define FSFILT_OP_LINK 9
173 #define FSFILT_OP_CANCEL_UNLINK 10
174 #define FSFILT_OP_NOOP 15
176 /* XXX BUG 3188 -- must return to one set of opcodes */
177 #define KML_UNLINK 0x11
178 #define KML_RMDIR 0x12
179 #define KML_RENAME 0x13
180 #define KML_CREATE 0x14
181 #define KML_MKDIR 0x15
182 #define KML_SYMLINK 0x16
183 #define KML_MKNOD 0x17
184 #define KML_LINK 0x19
186 #define CACHE_UNLINK 0x21
187 #define CACHE_RMDIR 0x22
188 #define CACHE_RENAME 0x23
189 #define CACHE_CREATE 0x24
190 #define CACHE_MKDIR 0x25
191 #define CACHE_SYMLINK 0x26
192 #define CACHE_MKNOD 0x27
193 #define CACHE_LINK 0x29
194 #define CACHE_NOOP 0x2f
196 #define KML_CACHE_UNLINK 0x31
197 #define KML_CACHE_RMDIR 0x32
198 #define KML_CACHE_RENAME 0x33
199 #define KML_CACHE_CREATE 0x34
200 #define KML_CACHE_MKDIR 0x35
201 #define KML_CACHE_SYMLINK 0x36
202 #define KML_CACHE_MKNOD 0x37
203 #define KML_CACHE_LINK 0x39
204 #define KML_CACHE_NOOP 0x3f
206 /*for fsfilt set md ea*/
211 fsfilt_start_ops(struct fsfilt_operations *ops, struct inode *inode,
212 int op, struct obd_trans_info *oti, int logs)
214 unsigned long now = jiffies;
215 void *parent_handle = oti ? oti->oti_handle : NULL;
216 void *handle = ops->fs_start(inode, op, parent_handle, logs);
217 CDEBUG(D_INFO, "started handle %p (%p)\n", handle, parent_handle);
220 if (parent_handle == NULL) {
221 oti->oti_handle = handle;
222 } else if (handle != parent_handle) {
223 CERROR("mismatch: parent %p, handle %p, oti %p\n",
224 parent_handle, handle, oti);
228 if (time_after(jiffies, now + 15 * HZ))
229 CERROR("long journal start time %lus\n", (jiffies - now) / HZ);
234 fsfilt_start_log(struct obd_device *obd, struct inode *inode,
235 int op, struct obd_trans_info *oti, int logs)
237 return fsfilt_start_ops(obd->obd_fsops, inode, op, oti, logs);
241 fsfilt_start(struct obd_device *obd, struct inode *inode,
242 int op, struct obd_trans_info *oti)
244 return fsfilt_start_ops(obd->obd_fsops, inode, op, oti, 0);
248 llog_fsfilt_start(struct llog_ctxt *ctxt, struct inode *inode,
249 int op, struct obd_trans_info *oti)
251 return fsfilt_start_ops(ctxt->loc_fsops, inode, op, oti, 1);
255 fsfilt_commit_ops(struct fsfilt_operations *ops, struct super_block *sb,
256 struct inode *inode, void *handle, int force_sync)
258 unsigned long now = jiffies;
259 int rc = ops->fs_commit(sb, inode, handle, force_sync);
260 CDEBUG(D_INFO, "committing handle %p\n", handle);
262 if (time_after(jiffies, now + 15 * HZ))
263 CERROR("long journal start time %lus\n", (jiffies - now) / HZ);
269 fsfilt_commit(struct obd_device *obd, struct super_block *sb,
270 struct inode *inode, void *handle, int force_sync)
272 return fsfilt_commit_ops(obd->obd_fsops, sb, inode, handle, force_sync);
276 llog_fsfilt_commit(struct llog_ctxt *ctxt, struct inode *inode,
277 void *handle, int force_sync)
279 return fsfilt_commit_ops(ctxt->loc_fsops, inode->i_sb, inode, handle,
284 fsfilt_brw_start_log(struct obd_device *obd, int objcount,
285 struct fsfilt_objinfo *fso, int niocount,
286 struct niobuf_local *nb, struct obd_trans_info *oti,
289 unsigned long now = jiffies;
290 void *parent_handle = oti ? oti->oti_handle : NULL;
291 void *handle = obd->obd_fsops->fs_brw_start(objcount, fso, niocount, nb,
292 parent_handle, logs);
293 CDEBUG(D_INFO, "started handle %p (%p)\n", handle, parent_handle);
296 if (parent_handle == NULL) {
297 oti->oti_handle = handle;
298 } else if (handle != parent_handle) {
299 CERROR("mismatch: parent %p, handle %p, oti %p\n",
300 parent_handle, handle, oti);
304 if (time_after(jiffies, now + 15 * HZ))
305 CERROR("long journal start time %lus\n", (jiffies - now) / HZ);
311 fsfilt_brw_start(struct obd_device *obd, int objcount,
312 struct fsfilt_objinfo *fso, int niocount,
313 struct niobuf_local *nb, struct obd_trans_info *oti)
315 return fsfilt_brw_start_log(obd, objcount, fso, niocount, nb, oti, 0);
319 fsfilt_commit_async(struct obd_device *obd, struct inode *inode,
320 void *handle, void **wait_handle)
322 unsigned long now = jiffies;
323 int rc = obd->obd_fsops->fs_commit_async(inode, handle, wait_handle);
325 CDEBUG(D_INFO, "committing handle %p (async)\n", *wait_handle);
326 if (time_after(jiffies, now + 15 * HZ))
327 CERROR("long journal start time %lus\n", (jiffies - now) / HZ);
333 fsfilt_commit_wait(struct obd_device *obd, struct inode *inode, void *handle)
335 unsigned long now = jiffies;
336 int rc = obd->obd_fsops->fs_commit_wait(inode, handle);
337 CDEBUG(D_INFO, "waiting for completion %p\n", handle);
338 if (time_after(jiffies, now + 15 * HZ))
339 CERROR("long journal start time %lus\n", (jiffies - now) / HZ);
344 fsfilt_setattr(struct obd_device *obd, struct dentry *dentry,
345 void *handle, struct iattr *iattr, int do_trunc)
347 unsigned long now = jiffies;
349 rc = obd->obd_fsops->fs_setattr(dentry, handle, iattr, do_trunc);
350 if (time_after(jiffies, now + 15 * HZ))
351 CERROR("long setattr time %lus\n", (jiffies - now) / HZ);
356 fsfilt_iocontrol(struct obd_device *obd, struct inode *inode,
357 struct file *file, unsigned int cmd,
360 return obd->obd_fsops->fs_iocontrol(inode, file, cmd, arg);
363 static inline int fsfilt_setup(struct obd_device *obd,
364 struct super_block *fs)
366 if (obd->obd_fsops->fs_setup)
367 return obd->obd_fsops->fs_setup(obd, fs);
371 fsfilt_set_md(struct obd_device *obd, struct inode *inode,
372 void *handle, void *md, int size)
374 return obd->obd_fsops->fs_set_md(inode, handle, md, size);
378 fsfilt_get_md(struct obd_device *obd, struct inode *inode,
381 return obd->obd_fsops->fs_get_md(inode, md, size);
384 #if (LINUX_VERSION_CODE > KERNEL_VERSION(2,5,0))
386 fsfilt_send_bio(struct obd_device *obd, struct inode *inode,
390 fsfilt_send_bio(struct obd_device *obd, struct inode *inode,
394 return obd->obd_fsops->fs_send_bio(inode, bio);
398 fsfilt_putpage(struct obd_device *obd, struct inode *inode,
402 struct filter_obd *filter;
403 unsigned long now = jiffies;
405 LASSERT(obd != NULL);
406 LASSERT(inode != NULL);
407 LASSERT(page != NULL);
409 filter = &obd->u.filter;
411 if (!obd->obd_fsops->fs_putpage)
414 CDEBUG(D_INFO, "putpage %lx\n", page->index);
416 rc = obd->obd_fsops->fs_putpage(inode, page);
418 if (time_after(jiffies, now + 15 * HZ))
419 CERROR("long putpage time %lus\n", (jiffies - now) / HZ);
424 static inline struct page *
425 fsfilt_getpage(struct obd_device *obd, struct inode *inode,
429 unsigned long now = jiffies;
431 LASSERT(obd != NULL);
432 LASSERT(inode != NULL);
434 if (!obd->obd_fsops->fs_getpage)
435 return ERR_PTR(-ENOSYS);
437 CDEBUG(D_INFO, "getpage %lx\n", index);
439 page = obd->obd_fsops->fs_getpage(inode, index);
441 if (time_after(jiffies, now + 15 * HZ))
442 CERROR("long getpage time %lus\n", (jiffies - now) / HZ);
447 static inline ssize_t
448 fsfilt_readpage(struct obd_device *obd, struct file *file, char *buf,
449 size_t count, loff_t *offset)
451 return obd->obd_fsops->fs_readpage(file, buf, count, offset);
455 fsfilt_add_journal_cb(struct obd_device *obd, struct super_block *sb,
456 __u64 last_rcvd, void *handle, fsfilt_cb_t cb_func,
459 return obd->obd_fsops->fs_add_journal_cb(obd, sb, last_rcvd, handle,
463 /* very similar to obd_statfs(), but caller already holds obd_osfs_lock */
465 fsfilt_statfs(struct obd_device *obd, struct super_block *sb,
466 unsigned long max_age)
470 CDEBUG(D_SUPER, "osfs %lu, max_age %lu\n", obd->obd_osfs_age, max_age);
471 if (time_before(obd->obd_osfs_age, max_age)) {
472 rc = obd->obd_fsops->fs_statfs(sb, &obd->obd_osfs);
473 if (rc == 0) /* N.B. statfs can't really fail */
474 obd->obd_osfs_age = jiffies;
476 CDEBUG(D_SUPER, "using cached obd_statfs data\n");
483 fsfilt_sync(struct obd_device *obd, struct super_block *sb)
485 return obd->obd_fsops->fs_sync(sb);
488 static inline int fsfilt_map_inode_pages(struct obd_device *obd,
490 struct page **page, int pages,
491 unsigned long *blocks, int *created,
492 int create, struct semaphore *sem)
494 return obd->obd_fsops->fs_map_inode_pages(inode, page, pages, blocks,
495 created, create, sem);
497 static inline int fsfilt_get_fs_flags(struct obd_device *obd,
498 struct dentry *dentry)
500 if (obd->obd_fsops->fs_get_fs_flags)
501 return obd->obd_fsops->fs_get_fs_flags(dentry);
506 fsfilt_write_extents(struct obd_device *obd, struct dentry *dentry,
507 unsigned long offset, unsigned long blks)
509 if (obd->obd_fsops->fs_write_extents)
510 return obd->obd_fsops->fs_write_extents(dentry,
515 fsfilt_do_write_cow(struct obd_device *obd, struct dentry *dentry,
516 void *extents, int num_extents)
518 if (obd->obd_fsops->fs_do_write_cow)
519 return obd->obd_fsops->fs_do_write_cow(dentry, extents,
524 fs_prep_san_write(struct obd_device *obd, struct inode *inode,
525 long *blocks, int nblocks, loff_t newsize)
527 return obd->obd_fsops->fs_prep_san_write(inode, blocks,
532 fsfilt_read_record(struct obd_device *obd, struct file *file,
533 void *buf, loff_t size, loff_t *offs)
535 return obd->obd_fsops->fs_read_record(file, buf, size, offs);
539 llog_fsfilt_read_record(struct llog_ctxt *ctxt, struct file *file,
540 void *buf, loff_t size, loff_t *offs)
542 return ctxt->loc_fsops->fs_read_record(file, buf, size, offs);
546 fsfilt_write_record(struct obd_device *obd, struct file *file,
547 void *buf, loff_t size, loff_t *offs, int force_sync)
549 return obd->obd_fsops->fs_write_record(file, buf, size, offs,
554 llog_fsfilt_write_record(struct llog_ctxt *ctxt, struct file *file,
555 void *buf, loff_t size, loff_t *offs,
558 return ctxt->loc_fsops->fs_write_record(file, buf, size, offs,
563 fsfilt_set_fs_flags(struct obd_device *obd, struct inode *inode, int flags)
565 if (obd->obd_fsops->fs_set_fs_flags)
566 return obd->obd_fsops->fs_set_fs_flags(inode, flags);
571 fsfilt_clear_fs_flags(struct obd_device *obd, struct inode *inode, int flags)
573 if (obd->obd_fsops->fs_clear_fs_flags)
574 return obd->obd_fsops->fs_clear_fs_flags(inode, flags);
578 fsfilt_precreate_rec(struct obd_device *obd, struct dentry *dentry,
579 int *num, struct obdo *oa)
581 if (obd->obd_fsops->fs_precreate_rec)
582 return obd->obd_fsops->fs_precreate_rec(dentry, num, oa);
587 fsfilt_post_setup(struct obd_device *obd, struct dentry *de)
589 if (obd->obd_fsops->fs_post_setup)
590 return obd->obd_fsops->fs_post_setup(obd,
591 obd->obd_lvfs_ctxt.pwdmnt, de);
596 fsfilt_post_cleanup(struct obd_device *obd)
598 if (obd->obd_fsops->fs_post_cleanup)
599 return obd->obd_fsops->fs_post_cleanup(obd,
600 obd->obd_lvfs_ctxt.pwdmnt);
605 fsfilt_get_ino_write_extents(struct obd_device *obd,
606 struct super_block *sb,
607 int ino, char **buf, int *size)
609 if (obd->obd_fsops->fs_get_ino_write_extents)
610 return obd->obd_fsops->fs_get_ino_write_extents(sb, ino,
616 fsfilt_free_write_extents(struct obd_device *obd,
617 struct super_block *sb,
618 int ino, char *buf, int size)
620 if (obd->obd_fsops->fs_free_write_extents)
621 return obd->obd_fsops->fs_free_write_extents(sb, ino,
627 fsfilt_get_reint_log_ctxt(struct obd_device *obd,
628 struct super_block *sb,
629 struct llog_ctxt **ctxt)
631 if (obd->obd_fsops->fs_get_reint_log_ctxt)
632 return obd->obd_fsops->fs_get_reint_log_ctxt(sb, ctxt);
637 fsfilt_set_ost_flags(struct obd_device *obd, struct super_block *sb)
639 if (obd->obd_fsops->fs_set_ost_flags)
640 return obd->obd_fsops->fs_set_ost_flags(sb);
645 fsfilt_set_mds_flags(struct obd_device *obd, struct super_block *sb)
647 if (obd->obd_fsops->fs_set_mds_flags)
648 return obd->obd_fsops->fs_set_mds_flags(sb);
653 fsfilt_add_dir_entry(struct obd_device *obd, struct dentry *dir,
654 char *name, int namelen, unsigned long ino,
655 unsigned long generation, unsigned mds)
657 LASSERT(obd->obd_fsops->fs_add_dir_entry);
658 return obd->obd_fsops->fs_add_dir_entry(obd, dir, name,
659 namelen, ino, generation, mds);
663 fsfilt_del_dir_entry(struct obd_device *obd, struct dentry *dentry)
665 LASSERT(obd->obd_fsops->fs_del_dir_entry);
666 return obd->obd_fsops->fs_del_dir_entry(obd, dentry);
670 fsfilt_set_snap_item(struct obd_device *obd, struct super_block *sb,
673 if (obd->obd_fsops->fs_set_snap_item)
674 return obd->obd_fsops->fs_set_snap_item(sb, name);
677 #endif /* __KERNEL__ */