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, int flags);
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 int (* fs_post_cleanup)(struct obd_device *obd, struct vfsmount *mnt);
96 int (* fs_get_reint_log_ctxt)(struct super_block *sb,
97 struct llog_ctxt **ctxt);
98 int (* fs_set_kml_flags)(struct inode *inode);
99 int (* fs_clear_kml_flags)(struct inode *inode);
100 int (* fs_set_ost_flags)(struct super_block *sb);
101 int (* fs_set_mds_flags)(struct super_block *sb);
102 int (* fs_precreate_rec)(struct dentry *dentry, int *num,
104 int (* fs_set_xattr)(struct inode *inode, void *handle, char *name,
105 void *buffer, int buffer_size);
106 int (* fs_get_xattr)(struct inode *inode, char *name,
107 void *buffer, int buffer_size);
109 int (* fs_init_extents_ea)(struct inode *inode);
110 int (* fs_insert_extents_ea)(struct inode *inode, unsigned long from,
112 int (* fs_write_extents)(struct dentry *dentry,
113 unsigned long offset, unsigned long blks);
114 int (* fs_remove_extents_ea)(struct inode *inode, unsigned long from,
116 int (* fs_get_ino_write_extents)(struct super_block *sb, ino_t ino,
117 char **pbuf, int *size);
118 int (* fs_free_write_extents)(struct super_block *sb, ino_t ino,
119 char *pbuf, int size);
120 int (* fs_get_inode_write_extents)(struct inode *inode, char **pbuf,
122 int (* fs_get_write_extents_num)(struct inode *inode, int* size);
124 int (* fs_get_op_len)(int, struct fsfilt_objinfo *, int);
125 int (* fs_add_dir_entry)(struct obd_device *, struct dentry *,
126 char *, int, unsigned long, unsigned long,
128 int (* fs_del_dir_entry)(struct obd_device *, struct dentry *);
130 int (* fs_is_redirector)(struct inode *inode);
131 int (* fs_is_indirect)(struct inode *inode);
133 struct inode * (* fs_create_indirect)(struct inode *pri, int index,
134 unsigned int gen, struct inode *parent,
136 struct inode * (* fs_get_indirect)(struct inode *pri, int *table,
138 ino_t (* fs_get_indirect_ino)(struct inode *pri, int index);
139 int (* fs_destroy_indirect)(struct inode *pri, int index,
140 struct inode *next_ind);
141 int (* fs_restore_indirect)(struct inode *pri, int index);
142 int (* fs_iterate)(struct super_block *sb,
143 int (*repeat)(struct inode *inode, void *priv),
144 struct inode **start, void *priv, int flag);
145 int (* fs_copy_block)(struct inode *dst, struct inode *src, int blk);
146 int (* fs_set_indirect)(struct inode *pri, int index,
147 ino_t ind_ino, ino_t parent_ino);
148 int (* fs_snap_feature)(struct super_block *sb, int feature, int op);
149 int (* fs_set_snap_info)(struct super_block *sb, struct inode *inode,
150 void* key, __u32 keylen, void *val,
152 int (* fs_get_snap_info)(struct super_block *sb, struct inode *inode,
153 void* key, __u32 keylen, void *val,
157 extern int fsfilt_register_ops(struct fsfilt_operations *fs_ops);
158 extern void fsfilt_unregister_ops(struct fsfilt_operations *fs_ops);
159 extern struct fsfilt_operations *fsfilt_get_ops(const char *type);
160 extern void fsfilt_put_ops(struct fsfilt_operations *fs_ops);
162 #define FSFILT_OP_UNLINK 1
163 #define FSFILT_OP_RMDIR 2
164 #define FSFILT_OP_RENAME 3
165 #define FSFILT_OP_CREATE 4
166 #define FSFILT_OP_MKDIR 5
167 #define FSFILT_OP_SYMLINK 6
168 #define FSFILT_OP_MKNOD 7
169 #define FSFILT_OP_SETATTR 8
170 #define FSFILT_OP_LINK 9
171 #define FSFILT_OP_CANCEL_UNLINK 10
172 #define FSFILT_OP_NOOP 15
174 /* XXX BUG 3188 -- must return to one set of opcodes */
175 #define KML_UNLINK 0x11
176 #define KML_RMDIR 0x12
177 #define KML_RENAME 0x13
178 #define KML_CREATE 0x14
179 #define KML_MKDIR 0x15
180 #define KML_SYMLINK 0x16
181 #define KML_MKNOD 0x17
182 #define KML_LINK 0x19
184 #define CACHE_UNLINK 0x21
185 #define CACHE_RMDIR 0x22
186 #define CACHE_RENAME 0x23
187 #define CACHE_CREATE 0x24
188 #define CACHE_MKDIR 0x25
189 #define CACHE_SYMLINK 0x26
190 #define CACHE_MKNOD 0x27
191 #define CACHE_LINK 0x29
192 #define CACHE_NOOP 0x2f
194 #define KML_CACHE_UNLINK 0x31
195 #define KML_CACHE_RMDIR 0x32
196 #define KML_CACHE_RENAME 0x33
197 #define KML_CACHE_CREATE 0x34
198 #define KML_CACHE_MKDIR 0x35
199 #define KML_CACHE_SYMLINK 0x36
200 #define KML_CACHE_MKNOD 0x37
201 #define KML_CACHE_LINK 0x39
202 #define KML_CACHE_NOOP 0x3f
204 /*for fsfilt set md ea*/
209 fsfilt_start_ops(struct fsfilt_operations *ops, struct inode *inode,
210 int op, struct obd_trans_info *oti, int logs)
212 unsigned long now = jiffies;
213 void *parent_handle = oti ? oti->oti_handle : NULL;
214 void *handle = ops->fs_start(inode, op, parent_handle, logs);
215 CDEBUG(D_HA, "started handle %p (%p)\n", handle, parent_handle);
218 if (parent_handle == NULL) {
219 oti->oti_handle = handle;
220 } else if (handle != parent_handle) {
221 CERROR("mismatch: parent %p, handle %p, oti %p\n",
222 parent_handle, handle, oti);
226 if (time_after(jiffies, now + 15 * HZ))
227 CERROR("long journal start time %lus\n", (jiffies - now) / HZ);
232 fsfilt_start_log(struct obd_device *obd, struct inode *inode,
233 int op, struct obd_trans_info *oti, int logs)
235 return fsfilt_start_ops(obd->obd_fsops, inode, op, oti, logs);
239 fsfilt_start(struct obd_device *obd, struct inode *inode,
240 int op, struct obd_trans_info *oti)
242 return fsfilt_start_ops(obd->obd_fsops, inode, op, oti, 0);
246 llog_fsfilt_start(struct llog_ctxt *ctxt, struct inode *inode,
247 int op, struct obd_trans_info *oti)
249 return fsfilt_start_ops(ctxt->loc_fsops, inode, op, oti, 1);
253 fsfilt_commit_ops(struct fsfilt_operations *ops, struct super_block *sb,
254 struct inode *inode, void *handle, int force_sync)
256 unsigned long now = jiffies;
257 int rc = ops->fs_commit(sb, inode, handle, force_sync);
258 CDEBUG(D_HA, "committing handle %p\n", handle);
260 if (time_after(jiffies, now + 15 * HZ))
261 CERROR("long journal start time %lus\n", (jiffies - now) / HZ);
267 fsfilt_commit(struct obd_device *obd, struct super_block *sb,
268 struct inode *inode, void *handle, int force_sync)
270 return fsfilt_commit_ops(obd->obd_fsops, sb, inode, handle, force_sync);
274 llog_fsfilt_commit(struct llog_ctxt *ctxt, struct inode *inode,
275 void *handle, int force_sync)
277 return fsfilt_commit_ops(ctxt->loc_fsops, inode->i_sb, inode, handle,
282 fsfilt_brw_start_log(struct obd_device *obd, int objcount,
283 struct fsfilt_objinfo *fso, int niocount,
284 struct niobuf_local *nb, struct obd_trans_info *oti,
287 unsigned long now = jiffies;
288 void *parent_handle = oti ? oti->oti_handle : NULL;
289 void *handle = obd->obd_fsops->fs_brw_start(objcount, fso, niocount, nb,
290 parent_handle, logs);
291 CDEBUG(D_HA, "started handle %p (%p)\n", handle, parent_handle);
294 if (parent_handle == NULL) {
295 oti->oti_handle = handle;
296 } else if (handle != parent_handle) {
297 CERROR("mismatch: parent %p, handle %p, oti %p\n",
298 parent_handle, handle, oti);
302 if (time_after(jiffies, now + 15 * HZ))
303 CERROR("long journal start time %lus\n", (jiffies - now) / HZ);
309 fsfilt_brw_start(struct obd_device *obd, int objcount,
310 struct fsfilt_objinfo *fso, int niocount,
311 struct niobuf_local *nb, struct obd_trans_info *oti)
313 return fsfilt_brw_start_log(obd, objcount, fso, niocount, nb, oti, 0);
317 fsfilt_commit_async(struct obd_device *obd, struct inode *inode,
318 void *handle, void **wait_handle)
320 unsigned long now = jiffies;
321 int rc = obd->obd_fsops->fs_commit_async(inode, handle, wait_handle);
323 CDEBUG(D_HA, "committing handle %p (async)\n", *wait_handle);
324 if (time_after(jiffies, now + 15 * HZ))
325 CERROR("long journal start time %lus\n", (jiffies - now) / HZ);
331 fsfilt_commit_wait(struct obd_device *obd, struct inode *inode, void *handle)
333 unsigned long now = jiffies;
334 int rc = obd->obd_fsops->fs_commit_wait(inode, handle);
335 CDEBUG(D_HA, "waiting for completion %p\n", handle);
336 if (time_after(jiffies, now + 15 * HZ))
337 CERROR("long journal start time %lus\n", (jiffies - now) / HZ);
342 fsfilt_setattr(struct obd_device *obd, struct dentry *dentry,
343 void *handle, struct iattr *iattr, int do_trunc)
345 unsigned long now = jiffies;
347 rc = obd->obd_fsops->fs_setattr(dentry, handle, iattr, do_trunc);
348 if (time_after(jiffies, now + 15 * HZ))
349 CERROR("long setattr time %lus\n", (jiffies - now) / HZ);
354 fsfilt_iocontrol(struct obd_device *obd, struct inode *inode,
355 struct file *file, unsigned int cmd,
358 return obd->obd_fsops->fs_iocontrol(inode, file, cmd, arg);
361 static inline int fsfilt_setup(struct obd_device *obd,
362 struct super_block *fs)
364 if (obd->obd_fsops->fs_setup)
365 return obd->obd_fsops->fs_setup(obd, fs);
369 fsfilt_set_md(struct obd_device *obd, struct inode *inode,
370 void *handle, void *md, int size, int flags)
372 return obd->obd_fsops->fs_set_md(inode, handle, md, size, flags);
376 fsfilt_get_md(struct obd_device *obd, struct inode *inode,
377 void *md, int size, int flags)
379 return obd->obd_fsops->fs_get_md(inode, md, size, flags);
382 #if (LINUX_VERSION_CODE > KERNEL_VERSION(2,5,0))
384 fsfilt_send_bio(struct obd_device *obd, struct inode *inode,
388 fsfilt_send_bio(struct obd_device *obd, struct inode *inode,
392 return obd->obd_fsops->fs_send_bio(inode, bio);
396 fsfilt_putpage(struct obd_device *obd, struct inode *inode,
400 struct filter_obd *filter;
401 unsigned long now = jiffies;
403 LASSERT(obd != NULL);
404 LASSERT(inode != NULL);
405 LASSERT(page != NULL);
407 filter = &obd->u.filter;
409 if (!obd->obd_fsops->fs_putpage)
412 CDEBUG(D_INFO, "putpage %lx\n", page->index);
414 rc = obd->obd_fsops->fs_putpage(inode, page);
416 if (time_after(jiffies, now + 15 * HZ))
417 CERROR("long putpage time %lus\n", (jiffies - now) / HZ);
422 static inline struct page *
423 fsfilt_getpage(struct obd_device *obd, struct inode *inode,
427 unsigned long now = jiffies;
429 LASSERT(obd != NULL);
430 LASSERT(inode != NULL);
432 if (!obd->obd_fsops->fs_getpage)
433 return ERR_PTR(-ENOSYS);
435 CDEBUG(D_INFO, "getpage %lx\n", index);
437 page = obd->obd_fsops->fs_getpage(inode, index);
439 if (time_after(jiffies, now + 15 * HZ))
440 CERROR("long getpage time %lus\n", (jiffies - now) / HZ);
445 static inline ssize_t
446 fsfilt_readpage(struct obd_device *obd, struct file *file, char *buf,
447 size_t count, loff_t *offset)
449 return obd->obd_fsops->fs_readpage(file, buf, count, offset);
453 fsfilt_add_journal_cb(struct obd_device *obd, struct super_block *sb,
454 __u64 last_rcvd, void *handle, fsfilt_cb_t cb_func,
457 return obd->obd_fsops->fs_add_journal_cb(obd, sb, last_rcvd, handle,
461 /* very similar to obd_statfs(), but caller already holds obd_osfs_lock */
463 fsfilt_statfs(struct obd_device *obd, struct super_block *sb,
464 unsigned long max_age)
468 CDEBUG(D_SUPER, "osfs %lu, max_age %lu\n", obd->obd_osfs_age, max_age);
469 if (time_before(obd->obd_osfs_age, max_age)) {
470 rc = obd->obd_fsops->fs_statfs(sb, &obd->obd_osfs);
471 if (rc == 0) /* N.B. statfs can't really fail */
472 obd->obd_osfs_age = jiffies;
474 CDEBUG(D_SUPER, "using cached obd_statfs data\n");
481 fsfilt_sync(struct obd_device *obd, struct super_block *sb)
483 return obd->obd_fsops->fs_sync(sb);
486 static inline int fsfilt_map_inode_pages(struct obd_device *obd,
488 struct page **page, int pages,
489 unsigned long *blocks, int *created,
490 int create, struct semaphore *sem)
492 return obd->obd_fsops->fs_map_inode_pages(inode, page, pages, blocks,
493 created, create, sem);
497 fsfilt_write_extents(struct obd_device *obd, struct dentry *dentry,
498 unsigned long offset, unsigned long blks)
500 if (obd->obd_fsops->fs_write_extents)
501 return obd->obd_fsops->fs_write_extents(dentry,
507 fs_prep_san_write(struct obd_device *obd, struct inode *inode,
508 long *blocks, int nblocks, loff_t newsize)
510 return obd->obd_fsops->fs_prep_san_write(inode, blocks,
515 fsfilt_read_record(struct obd_device *obd, struct file *file,
516 void *buf, loff_t size, loff_t *offs)
518 return obd->obd_fsops->fs_read_record(file, buf, size, offs);
522 llog_fsfilt_read_record(struct llog_ctxt *ctxt, struct file *file,
523 void *buf, loff_t size, loff_t *offs)
525 return ctxt->loc_fsops->fs_read_record(file, buf, size, offs);
529 fsfilt_write_record(struct obd_device *obd, struct file *file,
530 void *buf, loff_t size, loff_t *offs, int force_sync)
532 return obd->obd_fsops->fs_write_record(file, buf, size, offs,
537 llog_fsfilt_write_record(struct llog_ctxt *ctxt, struct file *file,
538 void *buf, loff_t size, loff_t *offs,
541 return ctxt->loc_fsops->fs_write_record(file, buf, size, offs,
546 fsfilt_set_kml_flags(struct obd_device *obd, struct inode *inode)
548 if (obd->obd_fsops->fs_set_kml_flags)
549 return obd->obd_fsops->fs_set_kml_flags(inode);
554 fsfilt_clear_kml_flags(struct obd_device *obd, struct inode *inode)
556 if (obd->obd_fsops->fs_clear_kml_flags)
557 return obd->obd_fsops->fs_clear_kml_flags(inode);
561 fsfilt_precreate_rec(struct obd_device *obd, struct dentry *dentry,
562 int *num, struct obdo *oa)
564 if (obd->obd_fsops->fs_precreate_rec)
565 return obd->obd_fsops->fs_precreate_rec(dentry, num, oa);
570 fsfilt_post_setup(struct obd_device *obd)
572 if (obd->obd_fsops->fs_post_setup)
573 return obd->obd_fsops->fs_post_setup(obd,
574 obd->obd_lvfs_ctxt.pwdmnt);
579 fsfilt_post_cleanup(struct obd_device *obd)
581 if (obd->obd_fsops->fs_post_cleanup)
582 return obd->obd_fsops->fs_post_cleanup(obd,
583 obd->obd_lvfs_ctxt.pwdmnt);
588 fsfilt_get_ino_write_extents(struct obd_device *obd,
589 struct super_block *sb,
590 int ino, char **buf, int *size)
592 if (obd->obd_fsops->fs_get_ino_write_extents)
593 return obd->obd_fsops->fs_get_ino_write_extents(sb, ino,
599 fsfilt_free_write_extents(struct obd_device *obd,
600 struct super_block *sb,
601 int ino, char *buf, int size)
603 if (obd->obd_fsops->fs_free_write_extents)
604 return obd->obd_fsops->fs_free_write_extents(sb, ino,
610 fsfilt_get_reint_log_ctxt(struct obd_device *obd,
611 struct super_block *sb,
612 struct llog_ctxt **ctxt)
614 if (obd->obd_fsops->fs_get_reint_log_ctxt)
615 return obd->obd_fsops->fs_get_reint_log_ctxt(sb, ctxt);
620 fsfilt_set_ost_flags(struct obd_device *obd, struct super_block *sb)
622 if (obd->obd_fsops->fs_set_ost_flags)
623 return obd->obd_fsops->fs_set_ost_flags(sb);
628 fsfilt_set_mds_flags(struct obd_device *obd, struct super_block *sb)
630 if (obd->obd_fsops->fs_set_mds_flags)
631 return obd->obd_fsops->fs_set_mds_flags(sb);
636 fsfilt_add_dir_entry(struct obd_device *obd, struct dentry *dir,
637 char *name, int namelen, unsigned long ino,
638 unsigned long generation, unsigned mds)
640 LASSERT(obd->obd_fsops->fs_add_dir_entry);
641 return obd->obd_fsops->fs_add_dir_entry(obd, dir, name,
642 namelen, ino, generation, mds);
646 fsfilt_del_dir_entry(struct obd_device *obd, struct dentry *dentry)
648 LASSERT(obd->obd_fsops->fs_del_dir_entry);
649 return obd->obd_fsops->fs_del_dir_entry(obd, dentry);
652 #endif /* __KERNEL__ */