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 /* lustre EA type (MEA, LOV, etc.) */
52 struct fsfilt_operations {
53 struct list_head fs_list;
54 struct module *fs_owner;
57 void *(* fs_start)(struct inode *inode, int op, void *desc_private,
59 void *(* fs_brw_start)(int objcount, struct fsfilt_objinfo *fso,
60 int niocount, struct niobuf_local *nb,
61 void *desc_private, int logs);
62 int (* fs_commit)(struct super_block *sb, struct inode *inode,
63 void *handle,int force_sync);
64 int (* fs_commit_async)(struct inode *inode, void *handle,
66 int (* fs_commit_wait)(struct inode *inode, void *handle);
67 int (* fs_setattr)(struct dentry *dentry, void *handle,
68 struct iattr *iattr, int do_trunc);
69 int (* fs_iocontrol)(struct inode *inode, struct file *file,
70 unsigned int cmd, unsigned long arg);
72 /* two methods for setting getting diff. kind of EAs from inode. */
73 int (* fs_set_md)(struct inode *inode, void *handle, void *md,
74 int size, enum ea_type type);
75 int (* fs_get_md)(struct inode *inode, void *md, int size,
78 int (* fs_send_bio)(int rw, struct inode *inode, void *bio);
80 /* methods for getting page from backing fs and putting page there
81 * during IO. Used on OST. */
82 int (* fs_putpage)(struct inode *inode, struct page *page);
83 struct page *(* fs_getpage)(struct inode *inode, long int index);
85 ssize_t (* fs_readpage)(struct file *file, char *buf, size_t count,
87 int (* fs_add_journal_cb)(struct obd_device *obd,
88 struct super_block *sb,
89 __u64 last_rcvd, void *handle,
90 fsfilt_cb_t cb_func, void *cb_data);
91 int (* fs_statfs)(struct super_block *sb, struct obd_statfs *osfs);
92 int (* fs_sync)(struct super_block *sb);
93 int (* fs_map_inode_pages)(struct inode *inode, struct page **page,
94 int pages, unsigned long *blocks,
95 int *created, int create,
96 struct semaphore *sem);
97 int (* fs_prep_san_write)(struct inode *inode, long *blocks,
98 int nblocks, loff_t newsize);
99 int (* fs_write_record)(struct file *, void *, int size, loff_t *,
101 int (* fs_read_record)(struct file *, void *, int size, loff_t *);
102 int (* fs_setup)(struct obd_device *, struct super_block *);
104 int (* fs_post_setup)(struct obd_device *obd, struct vfsmount *mnt,
105 struct dentry *dentry);
106 int (* fs_post_cleanup)(struct obd_device *obd, struct vfsmount *mnt);
107 int (* fs_set_info)(struct super_block *, struct inode *,
108 __u32, void *, __u32, void *);
109 int (* fs_get_info)(struct super_block *, struct inode *,
110 __u32, void *, __u32 *, void *);
111 int (* fs_set_fs_flags)(struct inode *inode, int flags);
112 int (* fs_clear_fs_flags)(struct inode *inode, int flags);
113 int (* fs_set_ost_flags)(struct super_block *sb);
114 int (* fs_set_mds_flags)(struct super_block *sb);
115 int (* fs_precreate_rec)(struct dentry *dentry, int *num,
117 int (* fs_set_xattr)(struct inode *inode, void *handle, char *name,
118 void *buffer, int buffer_size);
119 int (* fs_get_xattr)(struct inode *inode, char *name,
120 void *buffer, int buffer_size);
122 int (* fs_init_extents_ea)(struct inode *inode);
123 int (* fs_insert_extents_ea)(struct inode *inode, unsigned long from,
125 int (* fs_do_write_cow)(struct dentry *dentry, void *extents, int nexts);
126 int (* fs_write_extents)(struct dentry *dentry,
127 unsigned long offset, unsigned long blks);
128 int (* fs_get_fs_flags)(struct dentry *dentry);
129 int (* fs_remove_extents_ea)(struct inode *inode, unsigned long from,
131 int (* fs_get_ino_write_extents)(struct super_block *sb, ino_t ino,
132 char **pbuf, int *size);
133 int (* fs_free_write_extents)(struct super_block *sb, ino_t ino,
134 char *pbuf, int size);
135 int (* fs_get_inode_write_extents)(struct inode *inode, char **pbuf,
137 int (* fs_get_write_extents_num)(struct inode *inode, int* size);
139 int (* fs_get_op_len)(int, struct fsfilt_objinfo *, int);
140 int (* fs_add_dir_entry)(struct obd_device *, struct dentry *,
141 char *, int, unsigned long, unsigned long,
142 unsigned long, unsigned long);
143 int (* fs_del_dir_entry)(struct obd_device *, struct dentry *);
145 int (* fs_is_redirector)(struct inode *inode);
146 int (* fs_is_indirect)(struct inode *inode);
148 struct inode * (* fs_create_indirect)(struct inode *pri, int index,
150 struct inode *parent,
152 struct inode * (* fs_get_indirect)(struct inode *pri, int *table,
154 ino_t (* fs_get_indirect_ino)(struct super_block *sb, ino_t pri,
156 int (* fs_destroy_indirect)(struct inode *pri, int index,
157 struct inode *next_ind);
158 int (* fs_restore_indirect)(struct inode *pri, int index);
159 int (* fs_iterate)(struct super_block *sb,
160 int (*repeat)(struct inode *inode, void *priv),
161 struct inode **start, void *priv, int flag);
162 int (* fs_copy_block)(struct inode *dst, struct inode *src,
164 int (* fs_set_indirect)(struct inode *pri, int index,
165 ino_t ind_ino, ino_t parent_ino);
166 int (* fs_snap_feature)(struct super_block *sb, int feature,
168 int (* fs_set_snap_info)(struct inode *inode, void* key,
169 __u32 keylen, void *val, __u32 *vallen);
170 int (* fs_get_snap_info)(struct inode *inode, void* key,
171 __u32 keylen, void *val, __u32 *vallen);
172 int (* fs_set_snap_item)(struct super_block *sb, char *name);
173 int (* fs_read_dotsnap_dir_page)(struct file *file, char *buf,
174 size_t count, loff_t *ppos);
175 int (* fs_dir_ent_size)(char *name);
176 int (* fs_set_dir_ent)(struct super_block *sb, char *name,
177 char *buf, int buf_off, int nlen,
181 extern int fsfilt_register_ops(struct fsfilt_operations *fs_ops);
182 extern void fsfilt_unregister_ops(struct fsfilt_operations *fs_ops);
183 extern struct fsfilt_operations *fsfilt_get_ops(const char *type);
184 extern void fsfilt_put_ops(struct fsfilt_operations *fs_ops);
186 #define FSFILT_OP_UNLINK 1
187 #define FSFILT_OP_RMDIR 2
188 #define FSFILT_OP_RENAME 3
189 #define FSFILT_OP_CREATE 4
190 #define FSFILT_OP_MKDIR 5
191 #define FSFILT_OP_SYMLINK 6
192 #define FSFILT_OP_MKNOD 7
193 #define FSFILT_OP_SETATTR 8
194 #define FSFILT_OP_LINK 9
195 #define FSFILT_OP_CANCEL_UNLINK 10
196 #define FSFILT_OP_NOOP 15
198 /* XXX BUG 3188 -- must return to one set of opcodes */
199 #define KML_UNLINK 0x11
200 #define KML_RMDIR 0x12
201 #define KML_RENAME 0x13
202 #define KML_CREATE 0x14
203 #define KML_MKDIR 0x15
204 #define KML_SYMLINK 0x16
205 #define KML_MKNOD 0x17
206 #define KML_LINK 0x19
208 #define CACHE_UNLINK 0x21
209 #define CACHE_RMDIR 0x22
210 #define CACHE_RENAME 0x23
211 #define CACHE_CREATE 0x24
212 #define CACHE_MKDIR 0x25
213 #define CACHE_SYMLINK 0x26
214 #define CACHE_MKNOD 0x27
215 #define CACHE_LINK 0x29
216 #define CACHE_NOOP 0x2f
218 #define KML_CACHE_UNLINK 0x31
219 #define KML_CACHE_RMDIR 0x32
220 #define KML_CACHE_RENAME 0x33
221 #define KML_CACHE_CREATE 0x34
222 #define KML_CACHE_MKDIR 0x35
223 #define KML_CACHE_SYMLINK 0x36
224 #define KML_CACHE_MKNOD 0x37
225 #define KML_CACHE_LINK 0x39
226 #define KML_CACHE_NOOP 0x3f
228 /*for fsfilt set md ea*/
232 #define fsfilt_check_slow(start, timeout, msg) \
234 if (time_before(jiffies, start + 15 * HZ)) \
236 else if (time_before(jiffies, start + timeout / 2 * HZ)) \
237 CWARN("slow %s %lus\n", msg, (jiffies - start) / HZ); \
239 CERROR("slow %s %lus\n", msg, (jiffies - start) / HZ); \
243 fsfilt_start_ops(struct fsfilt_operations *ops, struct inode *inode,
244 int op, struct obd_trans_info *oti, int logs)
246 unsigned long now = jiffies;
247 void *parent_handle = oti ? oti->oti_handle : NULL;
248 void *handle = ops->fs_start(inode, op, parent_handle, logs);
249 CDEBUG(D_INFO, "started handle %p (%p)\n", handle, parent_handle);
252 if (parent_handle == NULL) {
253 oti->oti_handle = handle;
254 } else if (handle != parent_handle) {
255 CERROR("mismatch: parent %p, handle %p, oti %p\n",
256 parent_handle, handle, oti);
260 fsfilt_check_slow(now, 60, "journal start");
265 fsfilt_start_log(struct obd_device *obd, struct inode *inode,
266 int op, struct obd_trans_info *oti, int logs)
268 return fsfilt_start_ops(obd->obd_fsops, inode, op, oti, logs);
272 fsfilt_start(struct obd_device *obd, struct inode *inode,
273 int op, struct obd_trans_info *oti)
275 return fsfilt_start_ops(obd->obd_fsops, inode, op, oti, 0);
279 llog_fsfilt_start(struct llog_ctxt *ctxt, struct inode *inode,
280 int op, struct obd_trans_info *oti)
282 return fsfilt_start_ops(ctxt->loc_fsops, inode, op, oti, 1);
286 fsfilt_commit_ops(struct fsfilt_operations *ops, struct super_block *sb,
287 struct inode *inode, void *handle, int force_sync)
289 unsigned long now = jiffies;
290 int rc = ops->fs_commit(sb, inode, handle, force_sync);
291 CDEBUG(D_INFO, "committing handle %p\n", handle);
293 fsfilt_check_slow(now, 60, "journal start");
299 fsfilt_commit(struct obd_device *obd, struct super_block *sb,
300 struct inode *inode, void *handle, int force_sync)
302 return fsfilt_commit_ops(obd->obd_fsops, sb, inode, handle, force_sync);
306 llog_fsfilt_commit(struct llog_ctxt *ctxt, struct inode *inode,
307 void *handle, int force_sync)
309 return fsfilt_commit_ops(ctxt->loc_fsops, inode->i_sb, inode, handle,
314 fsfilt_brw_start_log(struct obd_device *obd, int objcount,
315 struct fsfilt_objinfo *fso, int niocount,
316 struct niobuf_local *nb, struct obd_trans_info *oti,
319 unsigned long now = jiffies;
320 void *parent_handle = oti ? oti->oti_handle : NULL;
321 void *handle = obd->obd_fsops->fs_brw_start(objcount, fso, niocount, nb,
322 parent_handle, logs);
323 CDEBUG(D_INFO, "started handle %p (%p)\n", handle, parent_handle);
326 if (parent_handle == NULL) {
327 oti->oti_handle = handle;
328 } else if (handle != parent_handle) {
329 CERROR("mismatch: parent %p, handle %p, oti %p\n",
330 parent_handle, handle, oti);
334 fsfilt_check_slow(now, obd_timeout, "journal start");
340 fsfilt_brw_start(struct obd_device *obd, int objcount,
341 struct fsfilt_objinfo *fso, int niocount,
342 struct niobuf_local *nb, struct obd_trans_info *oti)
344 return fsfilt_brw_start_log(obd, objcount, fso, niocount, nb, oti, 0);
348 fsfilt_commit_async(struct obd_device *obd, struct inode *inode,
349 void *handle, void **wait_handle)
351 unsigned long now = jiffies;
352 int rc = obd->obd_fsops->fs_commit_async(inode, handle, wait_handle);
354 CDEBUG(D_INFO, "committing handle %p (async)\n", *wait_handle);
355 fsfilt_check_slow(now, obd_timeout, "journal start");
361 fsfilt_commit_wait(struct obd_device *obd, struct inode *inode, void *handle)
363 unsigned long now = jiffies;
364 int rc = obd->obd_fsops->fs_commit_wait(inode, handle);
365 CDEBUG(D_INFO, "waiting for completion %p\n", handle);
366 fsfilt_check_slow(now, obd_timeout, "journal start");
371 fsfilt_setattr(struct obd_device *obd, struct dentry *dentry,
372 void *handle, struct iattr *iattr, int do_trunc)
374 unsigned long now = jiffies;
376 rc = obd->obd_fsops->fs_setattr(dentry, handle, iattr, do_trunc);
377 fsfilt_check_slow(now, obd_timeout, "setattr");
382 fsfilt_iocontrol(struct obd_device *obd, struct inode *inode,
383 struct file *file, unsigned int cmd,
386 return obd->obd_fsops->fs_iocontrol(inode, file, cmd, arg);
389 static inline int fsfilt_setup(struct obd_device *obd,
390 struct super_block *fs)
392 if (obd->obd_fsops->fs_setup)
393 return obd->obd_fsops->fs_setup(obd, fs);
398 fsfilt_set_md(struct obd_device *obd, struct inode *inode,
399 void *handle, void *md, int size, enum ea_type type)
401 if (!obd->obd_fsops->fs_set_md)
404 return obd->obd_fsops->fs_set_md(inode, handle, md,
409 fsfilt_get_md(struct obd_device *obd, struct inode *inode,
410 void *md, int size, enum ea_type type)
412 if (!obd->obd_fsops->fs_get_md)
415 return obd->obd_fsops->fs_get_md(inode, md, size,
419 static inline int fsfilt_send_bio(int rw, struct obd_device *obd,
420 struct inode *inode, void *bio)
422 LASSERTF(rw == OBD_BRW_WRITE || rw == OBD_BRW_READ, "%x\n", rw);
424 if (rw == OBD_BRW_READ)
425 return obd->obd_fsops->fs_send_bio(READ, inode, bio);
427 return obd->obd_fsops->fs_send_bio(WRITE, inode, bio);
431 fsfilt_putpage(struct obd_device *obd, struct inode *inode,
435 struct filter_obd *filter;
436 unsigned long now = jiffies;
438 LASSERT(obd != NULL);
439 LASSERT(inode != NULL);
440 LASSERT(page != NULL);
442 filter = &obd->u.filter;
444 if (!obd->obd_fsops->fs_putpage)
447 CDEBUG(D_INFO, "putpage %lx\n", page->index);
449 rc = obd->obd_fsops->fs_putpage(inode, page);
451 fsfilt_check_slow(now, obd_timeout, "putpage");
456 static inline struct page *
457 fsfilt_getpage(struct obd_device *obd, struct inode *inode,
461 unsigned long now = jiffies;
463 LASSERT(obd != NULL);
464 LASSERT(inode != NULL);
466 if (!obd->obd_fsops->fs_getpage)
467 return ERR_PTR(-ENOSYS);
469 CDEBUG(D_INFO, "getpage %lx\n", index);
471 page = obd->obd_fsops->fs_getpage(inode, index);
473 fsfilt_check_slow(now, obd_timeout, "getpage");
478 static inline ssize_t
479 fsfilt_readpage(struct obd_device *obd, struct file *file, char *buf,
480 size_t count, loff_t *offset)
482 return obd->obd_fsops->fs_readpage(file, buf, count, offset);
486 fsfilt_add_journal_cb(struct obd_device *obd, struct super_block *sb,
487 __u64 last_num, void *handle, fsfilt_cb_t cb_func,
490 return obd->obd_fsops->fs_add_journal_cb(obd, sb, last_num, handle,
494 /* very similar to obd_statfs(), but caller already holds obd_osfs_lock */
496 fsfilt_statfs(struct obd_device *obd, struct super_block *sb,
497 unsigned long max_age)
501 CDEBUG(D_SUPER, "osfs %lu, max_age %lu\n", obd->obd_osfs_age, max_age);
502 if (time_before(obd->obd_osfs_age, max_age)) {
503 rc = obd->obd_fsops->fs_statfs(sb, &obd->obd_osfs);
504 if (rc == 0) /* N.B. statfs can't really fail */
505 obd->obd_osfs_age = jiffies;
507 CDEBUG(D_SUPER, "using cached obd_statfs data\n");
514 fsfilt_sync(struct obd_device *obd, struct super_block *sb)
516 return obd->obd_fsops->fs_sync(sb);
519 static inline int fsfilt_map_inode_pages(struct obd_device *obd,
521 struct page **page, int pages,
522 unsigned long *blocks, int *created,
523 int create, struct semaphore *sem)
525 return obd->obd_fsops->fs_map_inode_pages(inode, page, pages, blocks,
526 created, create, sem);
528 static inline int fsfilt_get_fs_flags(struct obd_device *obd,
529 struct dentry *dentry)
531 if (obd->obd_fsops->fs_get_fs_flags)
532 return obd->obd_fsops->fs_get_fs_flags(dentry);
537 fsfilt_write_extents(struct obd_device *obd, struct dentry *dentry,
538 unsigned long offset, unsigned long blks)
540 if (obd->obd_fsops->fs_write_extents)
541 return obd->obd_fsops->fs_write_extents(dentry,
546 fsfilt_do_write_cow(struct obd_device *obd, struct dentry *dentry,
547 void *extents, int num_extents)
549 if (obd->obd_fsops->fs_do_write_cow)
550 return obd->obd_fsops->fs_do_write_cow(dentry, extents,
555 fs_prep_san_write(struct obd_device *obd, struct inode *inode,
556 long *blocks, int nblocks, loff_t newsize)
558 return obd->obd_fsops->fs_prep_san_write(inode, blocks,
563 fsfilt_read_record(struct obd_device *obd, struct file *file,
564 void *buf, loff_t size, loff_t *offs)
566 return obd->obd_fsops->fs_read_record(file, buf, size, offs);
570 llog_fsfilt_read_record(struct llog_ctxt *ctxt, struct file *file,
571 void *buf, loff_t size, loff_t *offs)
573 return ctxt->loc_fsops->fs_read_record(file, buf, size, offs);
577 fsfilt_write_record(struct obd_device *obd, struct file *file,
578 void *buf, loff_t size, loff_t *offs, int force_sync)
580 return obd->obd_fsops->fs_write_record(file, buf, size, offs,
585 llog_fsfilt_write_record(struct llog_ctxt *ctxt, struct file *file,
586 void *buf, loff_t size, loff_t *offs,
589 return ctxt->loc_fsops->fs_write_record(file, buf, size, offs,
594 fsfilt_set_fs_flags(struct obd_device *obd, struct inode *inode, int flags)
596 if (obd->obd_fsops->fs_set_fs_flags)
597 return obd->obd_fsops->fs_set_fs_flags(inode, flags);
602 fsfilt_clear_fs_flags(struct obd_device *obd, struct inode *inode, int flags)
604 if (obd->obd_fsops->fs_clear_fs_flags)
605 return obd->obd_fsops->fs_clear_fs_flags(inode, flags);
610 fsfilt_precreate_rec(struct obd_device *obd, struct dentry *dentry,
611 int *num, struct obdo *oa)
613 if (obd->obd_fsops->fs_precreate_rec)
614 return obd->obd_fsops->fs_precreate_rec(dentry, num, oa);
619 fsfilt_post_setup(struct obd_device *obd, struct dentry *de)
621 if (obd->obd_fsops->fs_post_setup)
622 return obd->obd_fsops->fs_post_setup(obd,
623 obd->obd_lvfs_ctxt.pwdmnt, de);
628 fsfilt_post_cleanup(struct obd_device *obd)
630 if (obd->obd_fsops->fs_post_cleanup)
631 return obd->obd_fsops->fs_post_cleanup(obd,
632 obd->obd_lvfs_ctxt.pwdmnt);
637 fsfilt_get_ino_write_extents(struct obd_device *obd,
638 struct super_block *sb,
639 int ino, char **buf, int *size)
641 if (obd->obd_fsops->fs_get_ino_write_extents)
642 return obd->obd_fsops->fs_get_ino_write_extents(sb, ino,
648 fsfilt_free_write_extents(struct obd_device *obd,
649 struct super_block *sb,
650 int ino, char *buf, int size)
652 if (obd->obd_fsops->fs_free_write_extents)
653 return obd->obd_fsops->fs_free_write_extents(sb, ino,
659 fsfilt_set_info(struct obd_device *obd, struct super_block *sb,
660 struct inode * inode, __u32 keylen, void * key,
661 __u32 valsize, void * val)
663 if (obd->obd_fsops->fs_set_info)
664 return obd->obd_fsops->fs_set_info(sb, inode,
671 fsfilt_get_info(struct obd_device *obd, struct super_block *sb,
672 struct inode * inode, __u32 keylen, void * key,
673 __u32 * valsize, void * val)
675 if (obd->obd_fsops->fs_get_info)
676 return obd->obd_fsops->fs_get_info(sb, inode, keylen, key,
682 fsfilt_set_ost_flags(struct obd_device *obd, struct super_block *sb)
684 if (obd->obd_fsops->fs_set_ost_flags)
685 return obd->obd_fsops->fs_set_ost_flags(sb);
690 fsfilt_set_mds_flags(struct obd_device *obd, struct super_block *sb)
692 if (obd->obd_fsops->fs_set_mds_flags)
693 return obd->obd_fsops->fs_set_mds_flags(sb);
698 fsfilt_add_dir_entry(struct obd_device *obd, struct dentry *dir,
699 char *name, int namelen, unsigned long ino,
700 unsigned long generation, unsigned long mds,
703 LASSERT(obd->obd_fsops->fs_add_dir_entry);
705 return obd->obd_fsops->fs_add_dir_entry(obd, dir, name,
712 fsfilt_del_dir_entry(struct obd_device *obd, struct dentry *dentry)
714 LASSERT(obd->obd_fsops->fs_del_dir_entry);
715 return obd->obd_fsops->fs_del_dir_entry(obd, dentry);
719 fsfilt_set_snap_item(struct obd_device *obd, struct super_block *sb,
722 if (obd->obd_fsops->fs_set_snap_item)
723 return obd->obd_fsops->fs_set_snap_item(sb, name);
726 #endif /* __KERNEL__ */