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 int (* fs_send_bio)(int rw, struct inode *inode,struct kiobuf *bio);
67 /* methods for getting page from backing fs and putting page there
68 * during IO. Used on OST. */
69 int (* fs_putpage)(struct inode *inode, struct page *page);
70 struct page *(* fs_getpage)(struct inode *inode, long int index);
72 ssize_t (* fs_readpage)(struct file *file, char *buf, size_t count,
74 int (* fs_add_journal_cb)(struct obd_device *obd,
75 struct super_block *sb,
76 __u64 last_rcvd, void *handle,
79 int (* fs_statfs)(struct super_block *sb, struct obd_statfs *osfs);
80 int (* fs_sync)(struct super_block *sb);
81 int (* fs_map_inode_pages)(struct inode *inode, struct page **page,
82 int pages, unsigned long *blocks,
83 int *created, int create,
84 struct semaphore *sem);
85 int (* fs_prep_san_write)(struct inode *inode, long *blocks,
86 int nblocks, loff_t newsize);
87 int (* fs_write_record)(struct file *, void *, int size, loff_t *,
89 int (* fs_read_record)(struct file *, void *, int size, loff_t *);
90 int (* fs_setup)(struct obd_device *, struct super_block *);
92 int (* fs_post_setup)(struct obd_device *obd, struct vfsmount *mnt,
93 struct dentry *dentry);
94 int (* fs_post_cleanup)(struct obd_device *obd, struct vfsmount *mnt);
95 int (* fs_get_reint_log_ctxt)(struct super_block *sb,
96 struct llog_ctxt **ctxt);
97 int (* fs_set_fs_flags)(struct inode *inode, int flags);
98 int (* fs_clear_fs_flags)(struct inode *inode, int flags);
99 int (* fs_set_ost_flags)(struct super_block *sb);
100 int (* fs_set_mds_flags)(struct super_block *sb);
101 int (* fs_precreate_rec)(struct dentry *dentry, int *num,
103 int (* fs_set_xattr)(struct inode *inode, void *handle, char *name,
104 void *buffer, int buffer_size);
105 int (* fs_get_xattr)(struct inode *inode, char *name,
106 void *buffer, int buffer_size);
108 int (* fs_init_extents_ea)(struct inode *inode);
109 int (* fs_insert_extents_ea)(struct inode *inode, unsigned long from,
111 int (* fs_do_write_cow)(struct dentry *dentry, void *extents, int nexts);
112 int (* fs_write_extents)(struct dentry *dentry,
113 unsigned long offset, unsigned long blks);
114 int (* fs_get_fs_flags)(struct dentry *dentry);
115 int (* fs_remove_extents_ea)(struct inode *inode, unsigned long from,
117 int (* fs_get_ino_write_extents)(struct super_block *sb, ino_t ino,
118 char **pbuf, int *size);
119 int (* fs_free_write_extents)(struct super_block *sb, ino_t ino,
120 char *pbuf, int size);
121 int (* fs_get_inode_write_extents)(struct inode *inode, char **pbuf,
123 int (* fs_get_write_extents_num)(struct inode *inode, int* size);
125 int (* fs_get_op_len)(int, struct fsfilt_objinfo *, int);
126 int (* fs_add_dir_entry)(struct obd_device *, struct dentry *,
127 char *, int, unsigned long, unsigned long,
129 int (* fs_del_dir_entry)(struct obd_device *, struct dentry *);
131 int (* fs_is_redirector)(struct inode *inode);
132 int (* fs_is_indirect)(struct inode *inode);
134 struct inode * (* fs_create_indirect)(struct inode *pri, int index,
136 struct inode *parent,
138 struct inode * (* fs_get_indirect)(struct inode *pri, int *table,
140 ino_t (* fs_get_indirect_ino)(struct super_block *sb, ino_t pri,
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,
150 int (* fs_set_indirect)(struct inode *pri, int index,
151 ino_t ind_ino, ino_t parent_ino);
152 int (* fs_snap_feature)(struct super_block *sb, int feature,
154 int (* fs_set_snap_info)(struct inode *inode, void* key,
155 __u32 keylen, void *val, __u32 *vallen);
156 int (* fs_get_snap_info)(struct inode *inode, void* key,
157 __u32 keylen, void *val, __u32 *vallen);
158 int (* fs_set_snap_item)(struct super_block *sb, char *name);
159 int (* fs_read_dotsnap_dir_page)(struct file *file, char *buf,
160 size_t count, loff_t *ppos);
161 int (* fs_dir_ent_size)(char *name);
162 int (* fs_set_dir_ent)(struct super_block *sb, char *name,
163 char *buf, int buf_off, int nlen,
167 extern int fsfilt_register_ops(struct fsfilt_operations *fs_ops);
168 extern void fsfilt_unregister_ops(struct fsfilt_operations *fs_ops);
169 extern struct fsfilt_operations *fsfilt_get_ops(const char *type);
170 extern void fsfilt_put_ops(struct fsfilt_operations *fs_ops);
172 #define FSFILT_OP_UNLINK 1
173 #define FSFILT_OP_RMDIR 2
174 #define FSFILT_OP_RENAME 3
175 #define FSFILT_OP_CREATE 4
176 #define FSFILT_OP_MKDIR 5
177 #define FSFILT_OP_SYMLINK 6
178 #define FSFILT_OP_MKNOD 7
179 #define FSFILT_OP_SETATTR 8
180 #define FSFILT_OP_LINK 9
181 #define FSFILT_OP_CANCEL_UNLINK 10
182 #define FSFILT_OP_NOOP 15
184 /* XXX BUG 3188 -- must return to one set of opcodes */
185 #define KML_UNLINK 0x11
186 #define KML_RMDIR 0x12
187 #define KML_RENAME 0x13
188 #define KML_CREATE 0x14
189 #define KML_MKDIR 0x15
190 #define KML_SYMLINK 0x16
191 #define KML_MKNOD 0x17
192 #define KML_LINK 0x19
194 #define CACHE_UNLINK 0x21
195 #define CACHE_RMDIR 0x22
196 #define CACHE_RENAME 0x23
197 #define CACHE_CREATE 0x24
198 #define CACHE_MKDIR 0x25
199 #define CACHE_SYMLINK 0x26
200 #define CACHE_MKNOD 0x27
201 #define CACHE_LINK 0x29
202 #define CACHE_NOOP 0x2f
204 #define KML_CACHE_UNLINK 0x31
205 #define KML_CACHE_RMDIR 0x32
206 #define KML_CACHE_RENAME 0x33
207 #define KML_CACHE_CREATE 0x34
208 #define KML_CACHE_MKDIR 0x35
209 #define KML_CACHE_SYMLINK 0x36
210 #define KML_CACHE_MKNOD 0x37
211 #define KML_CACHE_LINK 0x39
212 #define KML_CACHE_NOOP 0x3f
214 /*for fsfilt set md ea*/
219 fsfilt_start_ops(struct fsfilt_operations *ops, struct inode *inode,
220 int op, struct obd_trans_info *oti, int logs)
222 unsigned long now = jiffies;
223 void *parent_handle = oti ? oti->oti_handle : NULL;
224 void *handle = ops->fs_start(inode, op, parent_handle, logs);
225 CDEBUG(D_INFO, "started handle %p (%p)\n", handle, parent_handle);
228 if (parent_handle == NULL) {
229 oti->oti_handle = handle;
230 } else if (handle != parent_handle) {
231 CERROR("mismatch: parent %p, handle %p, oti %p\n",
232 parent_handle, handle, oti);
236 if (time_after(jiffies, now + 15 * HZ))
237 CERROR("long journal start time %lus\n", (jiffies - now) / HZ);
242 fsfilt_start_log(struct obd_device *obd, struct inode *inode,
243 int op, struct obd_trans_info *oti, int logs)
245 return fsfilt_start_ops(obd->obd_fsops, inode, op, oti, logs);
249 fsfilt_start(struct obd_device *obd, struct inode *inode,
250 int op, struct obd_trans_info *oti)
252 return fsfilt_start_ops(obd->obd_fsops, inode, op, oti, 0);
256 llog_fsfilt_start(struct llog_ctxt *ctxt, struct inode *inode,
257 int op, struct obd_trans_info *oti)
259 return fsfilt_start_ops(ctxt->loc_fsops, inode, op, oti, 1);
263 fsfilt_commit_ops(struct fsfilt_operations *ops, struct super_block *sb,
264 struct inode *inode, void *handle, int force_sync)
266 unsigned long now = jiffies;
267 int rc = ops->fs_commit(sb, inode, handle, force_sync);
268 CDEBUG(D_INFO, "committing handle %p\n", handle);
270 if (time_after(jiffies, now + 15 * HZ))
271 CERROR("long journal start time %lus\n", (jiffies - now) / HZ);
277 fsfilt_commit(struct obd_device *obd, struct super_block *sb,
278 struct inode *inode, void *handle, int force_sync)
280 return fsfilt_commit_ops(obd->obd_fsops, sb, inode, handle, force_sync);
284 llog_fsfilt_commit(struct llog_ctxt *ctxt, struct inode *inode,
285 void *handle, int force_sync)
287 return fsfilt_commit_ops(ctxt->loc_fsops, inode->i_sb, inode, handle,
292 fsfilt_brw_start_log(struct obd_device *obd, int objcount,
293 struct fsfilt_objinfo *fso, int niocount,
294 struct niobuf_local *nb, struct obd_trans_info *oti,
297 unsigned long now = jiffies;
298 void *parent_handle = oti ? oti->oti_handle : NULL;
299 void *handle = obd->obd_fsops->fs_brw_start(objcount, fso, niocount, nb,
300 parent_handle, logs);
301 CDEBUG(D_INFO, "started handle %p (%p)\n", handle, parent_handle);
304 if (parent_handle == NULL) {
305 oti->oti_handle = handle;
306 } else if (handle != parent_handle) {
307 CERROR("mismatch: parent %p, handle %p, oti %p\n",
308 parent_handle, handle, oti);
312 if (time_after(jiffies, now + 15 * HZ))
313 CERROR("long journal start time %lus\n", (jiffies - now) / HZ);
319 fsfilt_brw_start(struct obd_device *obd, int objcount,
320 struct fsfilt_objinfo *fso, int niocount,
321 struct niobuf_local *nb, struct obd_trans_info *oti)
323 return fsfilt_brw_start_log(obd, objcount, fso, niocount, nb, oti, 0);
327 fsfilt_commit_async(struct obd_device *obd, struct inode *inode,
328 void *handle, void **wait_handle)
330 unsigned long now = jiffies;
331 int rc = obd->obd_fsops->fs_commit_async(inode, handle, wait_handle);
333 CDEBUG(D_INFO, "committing handle %p (async)\n", *wait_handle);
334 if (time_after(jiffies, now + 15 * HZ))
335 CERROR("long journal start time %lus\n", (jiffies - now) / HZ);
341 fsfilt_commit_wait(struct obd_device *obd, struct inode *inode, void *handle)
343 unsigned long now = jiffies;
344 int rc = obd->obd_fsops->fs_commit_wait(inode, handle);
345 CDEBUG(D_INFO, "waiting for completion %p\n", handle);
346 if (time_after(jiffies, now + 15 * HZ))
347 CERROR("long journal start time %lus\n", (jiffies - now) / HZ);
352 fsfilt_setattr(struct obd_device *obd, struct dentry *dentry,
353 void *handle, struct iattr *iattr, int do_trunc)
355 unsigned long now = jiffies;
357 rc = obd->obd_fsops->fs_setattr(dentry, handle, iattr, do_trunc);
358 if (time_after(jiffies, now + 15 * HZ))
359 CERROR("long setattr time %lus\n", (jiffies - now) / HZ);
364 fsfilt_iocontrol(struct obd_device *obd, struct inode *inode,
365 struct file *file, unsigned int cmd,
368 return obd->obd_fsops->fs_iocontrol(inode, file, cmd, arg);
371 static inline int fsfilt_setup(struct obd_device *obd,
372 struct super_block *fs)
374 if (obd->obd_fsops->fs_setup)
375 return obd->obd_fsops->fs_setup(obd, fs);
379 fsfilt_set_md(struct obd_device *obd, struct inode *inode,
380 void *handle, void *md, int size)
382 return obd->obd_fsops->fs_set_md(inode, handle, md, size);
386 fsfilt_get_md(struct obd_device *obd, struct inode *inode,
389 return obd->obd_fsops->fs_get_md(inode, md, size);
392 static inline int fsfilt_send_bio(int rw, struct obd_device *obd,
393 struct inode *inode, void *bio)
395 LASSERTF(rw == OBD_BRW_WRITE || rw == OBD_BRW_READ, "%x\n", rw);
397 if (rw == OBD_BRW_READ)
398 return obd->obd_fsops->fs_send_bio(READ, inode, bio);
400 return obd->obd_fsops->fs_send_bio(WRITE, inode, bio);
404 fsfilt_putpage(struct obd_device *obd, struct inode *inode,
408 struct filter_obd *filter;
409 unsigned long now = jiffies;
411 LASSERT(obd != NULL);
412 LASSERT(inode != NULL);
413 LASSERT(page != NULL);
415 filter = &obd->u.filter;
417 if (!obd->obd_fsops->fs_putpage)
420 CDEBUG(D_INFO, "putpage %lx\n", page->index);
422 rc = obd->obd_fsops->fs_putpage(inode, page);
424 if (time_after(jiffies, now + 15 * HZ))
425 CERROR("long putpage time %lus\n", (jiffies - now) / HZ);
430 static inline struct page *
431 fsfilt_getpage(struct obd_device *obd, struct inode *inode,
435 unsigned long now = jiffies;
437 LASSERT(obd != NULL);
438 LASSERT(inode != NULL);
440 if (!obd->obd_fsops->fs_getpage)
441 return ERR_PTR(-ENOSYS);
443 CDEBUG(D_INFO, "getpage %lx\n", index);
445 page = obd->obd_fsops->fs_getpage(inode, index);
447 if (time_after(jiffies, now + 15 * HZ))
448 CERROR("long getpage time %lus\n", (jiffies - now) / HZ);
453 static inline ssize_t
454 fsfilt_readpage(struct obd_device *obd, struct file *file, char *buf,
455 size_t count, loff_t *offset)
457 return obd->obd_fsops->fs_readpage(file, buf, count, offset);
461 fsfilt_add_journal_cb(struct obd_device *obd, struct super_block *sb,
462 __u64 last_rcvd, void *handle, fsfilt_cb_t cb_func,
465 return obd->obd_fsops->fs_add_journal_cb(obd, sb, last_rcvd, handle,
469 /* very similar to obd_statfs(), but caller already holds obd_osfs_lock */
471 fsfilt_statfs(struct obd_device *obd, struct super_block *sb,
472 unsigned long max_age)
476 CDEBUG(D_SUPER, "osfs %lu, max_age %lu\n", obd->obd_osfs_age, max_age);
477 if (time_before(obd->obd_osfs_age, max_age)) {
478 rc = obd->obd_fsops->fs_statfs(sb, &obd->obd_osfs);
479 if (rc == 0) /* N.B. statfs can't really fail */
480 obd->obd_osfs_age = jiffies;
482 CDEBUG(D_SUPER, "using cached obd_statfs data\n");
489 fsfilt_sync(struct obd_device *obd, struct super_block *sb)
491 return obd->obd_fsops->fs_sync(sb);
494 static inline int fsfilt_map_inode_pages(struct obd_device *obd,
496 struct page **page, int pages,
497 unsigned long *blocks, int *created,
498 int create, struct semaphore *sem)
500 return obd->obd_fsops->fs_map_inode_pages(inode, page, pages, blocks,
501 created, create, sem);
503 static inline int fsfilt_get_fs_flags(struct obd_device *obd,
504 struct dentry *dentry)
506 if (obd->obd_fsops->fs_get_fs_flags)
507 return obd->obd_fsops->fs_get_fs_flags(dentry);
512 fsfilt_write_extents(struct obd_device *obd, struct dentry *dentry,
513 unsigned long offset, unsigned long blks)
515 if (obd->obd_fsops->fs_write_extents)
516 return obd->obd_fsops->fs_write_extents(dentry,
521 fsfilt_do_write_cow(struct obd_device *obd, struct dentry *dentry,
522 void *extents, int num_extents)
524 if (obd->obd_fsops->fs_do_write_cow)
525 return obd->obd_fsops->fs_do_write_cow(dentry, extents,
530 fs_prep_san_write(struct obd_device *obd, struct inode *inode,
531 long *blocks, int nblocks, loff_t newsize)
533 return obd->obd_fsops->fs_prep_san_write(inode, blocks,
538 fsfilt_read_record(struct obd_device *obd, struct file *file,
539 void *buf, loff_t size, loff_t *offs)
541 return obd->obd_fsops->fs_read_record(file, buf, size, offs);
545 llog_fsfilt_read_record(struct llog_ctxt *ctxt, struct file *file,
546 void *buf, loff_t size, loff_t *offs)
548 return ctxt->loc_fsops->fs_read_record(file, buf, size, offs);
552 fsfilt_write_record(struct obd_device *obd, struct file *file,
553 void *buf, loff_t size, loff_t *offs, int force_sync)
555 return obd->obd_fsops->fs_write_record(file, buf, size, offs,
560 llog_fsfilt_write_record(struct llog_ctxt *ctxt, struct file *file,
561 void *buf, loff_t size, loff_t *offs,
564 return ctxt->loc_fsops->fs_write_record(file, buf, size, offs,
569 fsfilt_set_fs_flags(struct obd_device *obd, struct inode *inode, int flags)
571 if (obd->obd_fsops->fs_set_fs_flags)
572 return obd->obd_fsops->fs_set_fs_flags(inode, flags);
577 fsfilt_clear_fs_flags(struct obd_device *obd, struct inode *inode, int flags)
579 if (obd->obd_fsops->fs_clear_fs_flags)
580 return obd->obd_fsops->fs_clear_fs_flags(inode, flags);
584 fsfilt_precreate_rec(struct obd_device *obd, struct dentry *dentry,
585 int *num, struct obdo *oa)
587 if (obd->obd_fsops->fs_precreate_rec)
588 return obd->obd_fsops->fs_precreate_rec(dentry, num, oa);
593 fsfilt_post_setup(struct obd_device *obd, struct dentry *de)
595 if (obd->obd_fsops->fs_post_setup)
596 return obd->obd_fsops->fs_post_setup(obd,
597 obd->obd_lvfs_ctxt.pwdmnt, de);
602 fsfilt_post_cleanup(struct obd_device *obd)
604 if (obd->obd_fsops->fs_post_cleanup)
605 return obd->obd_fsops->fs_post_cleanup(obd,
606 obd->obd_lvfs_ctxt.pwdmnt);
611 fsfilt_get_ino_write_extents(struct obd_device *obd,
612 struct super_block *sb,
613 int ino, char **buf, int *size)
615 if (obd->obd_fsops->fs_get_ino_write_extents)
616 return obd->obd_fsops->fs_get_ino_write_extents(sb, ino,
622 fsfilt_free_write_extents(struct obd_device *obd,
623 struct super_block *sb,
624 int ino, char *buf, int size)
626 if (obd->obd_fsops->fs_free_write_extents)
627 return obd->obd_fsops->fs_free_write_extents(sb, ino,
633 fsfilt_get_reint_log_ctxt(struct obd_device *obd,
634 struct super_block *sb,
635 struct llog_ctxt **ctxt)
637 if (obd->obd_fsops->fs_get_reint_log_ctxt)
638 return obd->obd_fsops->fs_get_reint_log_ctxt(sb, ctxt);
643 fsfilt_set_ost_flags(struct obd_device *obd, struct super_block *sb)
645 if (obd->obd_fsops->fs_set_ost_flags)
646 return obd->obd_fsops->fs_set_ost_flags(sb);
651 fsfilt_set_mds_flags(struct obd_device *obd, struct super_block *sb)
653 if (obd->obd_fsops->fs_set_mds_flags)
654 return obd->obd_fsops->fs_set_mds_flags(sb);
659 fsfilt_add_dir_entry(struct obd_device *obd, struct dentry *dir,
660 char *name, int namelen, unsigned long ino,
661 unsigned long generation, unsigned mds)
663 LASSERT(obd->obd_fsops->fs_add_dir_entry);
664 return obd->obd_fsops->fs_add_dir_entry(obd, dir, name,
665 namelen, ino, generation, mds);
669 fsfilt_del_dir_entry(struct obd_device *obd, struct dentry *dentry)
671 LASSERT(obd->obd_fsops->fs_del_dir_entry);
672 return obd->obd_fsops->fs_del_dir_entry(obd, dentry);
676 fsfilt_set_snap_item(struct obd_device *obd, struct super_block *sb,
679 if (obd->obd_fsops->fs_set_snap_item)
680 return obd->obd_fsops->fs_set_snap_item(sb, name);
683 #endif /* __KERNEL__ */