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.) */
50 struct fsfilt_operations {
51 struct list_head fs_list;
52 struct module *fs_owner;
55 void *(* fs_start)(struct inode *inode, int op, void *desc_private,
57 void *(* fs_brw_start)(int objcount, struct fsfilt_objinfo *fso,
58 int niocount, struct niobuf_local *nb,
59 void *desc_private, int logs);
60 int (* fs_commit)(struct super_block *sb, struct inode *inode,
61 void *handle,int force_sync);
62 int (* fs_commit_async)(struct inode *inode, void *handle,
64 int (* fs_commit_wait)(struct inode *inode, void *handle);
65 int (* fs_setattr)(struct dentry *dentry, void *handle,
66 struct iattr *iattr, int do_trunc);
67 int (* fs_iocontrol)(struct inode *inode, struct file *file,
68 unsigned int cmd, unsigned long arg);
70 /* two methods for setting getting diff. kind of EAs from inode. */
71 int (* fs_set_md)(struct inode *inode, void *handle, void *md,
72 int size, enum ea_type type);
73 int (* fs_get_md)(struct inode *inode, void *md, int size,
76 int (* fs_send_bio)(int rw, struct inode *inode, void *bio);
78 /* methods for getting page from backing fs and putting page there
79 * during IO. Used on OST. */
80 int (* fs_putpage)(struct inode *inode, struct page *page);
81 struct page *(* fs_getpage)(struct inode *inode, long int index);
83 ssize_t (* fs_readpage)(struct file *file, char *buf, size_t count,
85 int (* fs_add_journal_cb)(struct obd_device *obd,
86 struct super_block *sb,
87 __u64 last_rcvd, void *handle,
88 fsfilt_cb_t cb_func, void *cb_data);
89 int (* fs_statfs)(struct super_block *sb, struct obd_statfs *osfs);
90 int (* fs_sync)(struct super_block *sb);
91 int (* fs_map_inode_pages)(struct inode *inode, struct page **page,
92 int pages, unsigned long *blocks,
93 int *created, int create,
94 struct semaphore *sem);
95 int (* fs_prep_san_write)(struct inode *inode, long *blocks,
96 int nblocks, loff_t newsize);
97 int (* fs_write_record)(struct file *, void *, int size, loff_t *,
99 int (* fs_read_record)(struct file *, void *, int size, loff_t *);
100 int (* fs_setup)(struct obd_device *, struct super_block *);
102 int (* fs_post_setup)(struct obd_device *obd, struct vfsmount *mnt,
103 struct dentry *dentry);
104 int (* fs_post_cleanup)(struct obd_device *obd, struct vfsmount *mnt);
105 int (* fs_get_reint_log_ctxt)(struct super_block *sb,
106 struct llog_ctxt **ctxt);
107 int (* fs_set_fs_flags)(struct inode *inode, int flags);
108 int (* fs_clear_fs_flags)(struct inode *inode, int flags);
109 int (* fs_set_ost_flags)(struct super_block *sb);
110 int (* fs_set_mds_flags)(struct super_block *sb);
111 int (* fs_precreate_rec)(struct dentry *dentry, int *num,
113 int (* fs_set_xattr)(struct inode *inode, void *handle, char *name,
114 void *buffer, int buffer_size);
115 int (* fs_get_xattr)(struct inode *inode, char *name,
116 void *buffer, int buffer_size);
118 int (* fs_init_extents_ea)(struct inode *inode);
119 int (* fs_insert_extents_ea)(struct inode *inode, unsigned long from,
121 int (* fs_do_write_cow)(struct dentry *dentry, void *extents, int nexts);
122 int (* fs_write_extents)(struct dentry *dentry,
123 unsigned long offset, unsigned long blks);
124 int (* fs_get_fs_flags)(struct dentry *dentry);
125 int (* fs_remove_extents_ea)(struct inode *inode, unsigned long from,
127 int (* fs_get_ino_write_extents)(struct super_block *sb, ino_t ino,
128 char **pbuf, int *size);
129 int (* fs_free_write_extents)(struct super_block *sb, ino_t ino,
130 char *pbuf, int size);
131 int (* fs_get_inode_write_extents)(struct inode *inode, char **pbuf,
133 int (* fs_get_write_extents_num)(struct inode *inode, int* size);
135 int (* fs_get_op_len)(int, struct fsfilt_objinfo *, int);
136 int (* fs_add_dir_entry)(struct obd_device *, struct dentry *,
137 char *, int, unsigned long, unsigned long,
138 unsigned long, unsigned long);
139 int (* fs_del_dir_entry)(struct obd_device *, struct dentry *);
141 int (* fs_is_redirector)(struct inode *inode);
142 int (* fs_is_indirect)(struct inode *inode);
144 struct inode * (* fs_create_indirect)(struct inode *pri, int index,
146 struct inode *parent,
148 struct inode * (* fs_get_indirect)(struct inode *pri, int *table,
150 ino_t (* fs_get_indirect_ino)(struct super_block *sb, ino_t pri,
152 int (* fs_destroy_indirect)(struct inode *pri, int index,
153 struct inode *next_ind);
154 int (* fs_restore_indirect)(struct inode *pri, int index);
155 int (* fs_iterate)(struct super_block *sb,
156 int (*repeat)(struct inode *inode, void *priv),
157 struct inode **start, void *priv, int flag);
158 int (* fs_copy_block)(struct inode *dst, struct inode *src,
160 int (* fs_set_indirect)(struct inode *pri, int index,
161 ino_t ind_ino, ino_t parent_ino);
162 int (* fs_snap_feature)(struct super_block *sb, int feature,
164 int (* fs_set_snap_info)(struct inode *inode, void* key,
165 __u32 keylen, void *val, __u32 *vallen);
166 int (* fs_get_snap_info)(struct inode *inode, void* key,
167 __u32 keylen, void *val, __u32 *vallen);
168 int (* fs_set_snap_item)(struct super_block *sb, char *name);
169 int (* fs_read_dotsnap_dir_page)(struct file *file, char *buf,
170 size_t count, loff_t *ppos);
171 int (* fs_dir_ent_size)(char *name);
172 int (* fs_set_dir_ent)(struct super_block *sb, char *name,
173 char *buf, int buf_off, int nlen,
177 extern int fsfilt_register_ops(struct fsfilt_operations *fs_ops);
178 extern void fsfilt_unregister_ops(struct fsfilt_operations *fs_ops);
179 extern struct fsfilt_operations *fsfilt_get_ops(const char *type);
180 extern void fsfilt_put_ops(struct fsfilt_operations *fs_ops);
182 #define FSFILT_OP_UNLINK 1
183 #define FSFILT_OP_RMDIR 2
184 #define FSFILT_OP_RENAME 3
185 #define FSFILT_OP_CREATE 4
186 #define FSFILT_OP_MKDIR 5
187 #define FSFILT_OP_SYMLINK 6
188 #define FSFILT_OP_MKNOD 7
189 #define FSFILT_OP_SETATTR 8
190 #define FSFILT_OP_LINK 9
191 #define FSFILT_OP_CANCEL_UNLINK 10
192 #define FSFILT_OP_NOOP 15
194 /* XXX BUG 3188 -- must return to one set of opcodes */
195 #define KML_UNLINK 0x11
196 #define KML_RMDIR 0x12
197 #define KML_RENAME 0x13
198 #define KML_CREATE 0x14
199 #define KML_MKDIR 0x15
200 #define KML_SYMLINK 0x16
201 #define KML_MKNOD 0x17
202 #define KML_LINK 0x19
204 #define CACHE_UNLINK 0x21
205 #define CACHE_RMDIR 0x22
206 #define CACHE_RENAME 0x23
207 #define CACHE_CREATE 0x24
208 #define CACHE_MKDIR 0x25
209 #define CACHE_SYMLINK 0x26
210 #define CACHE_MKNOD 0x27
211 #define CACHE_LINK 0x29
212 #define CACHE_NOOP 0x2f
214 #define KML_CACHE_UNLINK 0x31
215 #define KML_CACHE_RMDIR 0x32
216 #define KML_CACHE_RENAME 0x33
217 #define KML_CACHE_CREATE 0x34
218 #define KML_CACHE_MKDIR 0x35
219 #define KML_CACHE_SYMLINK 0x36
220 #define KML_CACHE_MKNOD 0x37
221 #define KML_CACHE_LINK 0x39
222 #define KML_CACHE_NOOP 0x3f
224 /*for fsfilt set md ea*/
228 #define fsfilt_check_slow(start, timeout, msg) \
230 if (time_before(jiffies, start + 15 * HZ)) \
232 else if (time_before(jiffies, start + timeout / 2 * HZ)) \
233 CWARN("slow %s %lus\n", msg, (jiffies - start) / HZ); \
235 CERROR("slow %s %lus\n", msg, (jiffies - start) / HZ); \
239 fsfilt_start_ops(struct fsfilt_operations *ops, struct inode *inode,
240 int op, struct obd_trans_info *oti, int logs)
242 unsigned long now = jiffies;
243 void *parent_handle = oti ? oti->oti_handle : NULL;
244 void *handle = ops->fs_start(inode, op, parent_handle, logs);
245 CDEBUG(D_INFO, "started handle %p (%p)\n", handle, parent_handle);
248 if (parent_handle == NULL) {
249 oti->oti_handle = handle;
250 } else if (handle != parent_handle) {
251 CERROR("mismatch: parent %p, handle %p, oti %p\n",
252 parent_handle, handle, oti);
256 fsfilt_check_slow(now, 60, "journal start");
261 fsfilt_start_log(struct obd_device *obd, struct inode *inode,
262 int op, struct obd_trans_info *oti, int logs)
264 return fsfilt_start_ops(obd->obd_fsops, inode, op, oti, logs);
268 fsfilt_start(struct obd_device *obd, struct inode *inode,
269 int op, struct obd_trans_info *oti)
271 return fsfilt_start_ops(obd->obd_fsops, inode, op, oti, 0);
275 llog_fsfilt_start(struct llog_ctxt *ctxt, struct inode *inode,
276 int op, struct obd_trans_info *oti)
278 return fsfilt_start_ops(ctxt->loc_fsops, inode, op, oti, 1);
282 fsfilt_commit_ops(struct fsfilt_operations *ops, struct super_block *sb,
283 struct inode *inode, void *handle, int force_sync)
285 unsigned long now = jiffies;
286 int rc = ops->fs_commit(sb, inode, handle, force_sync);
287 CDEBUG(D_INFO, "committing handle %p\n", handle);
289 fsfilt_check_slow(now, 60, "journal start");
295 fsfilt_commit(struct obd_device *obd, struct super_block *sb,
296 struct inode *inode, void *handle, int force_sync)
298 return fsfilt_commit_ops(obd->obd_fsops, sb, inode, handle, force_sync);
302 llog_fsfilt_commit(struct llog_ctxt *ctxt, struct inode *inode,
303 void *handle, int force_sync)
305 return fsfilt_commit_ops(ctxt->loc_fsops, inode->i_sb, inode, handle,
310 fsfilt_brw_start_log(struct obd_device *obd, int objcount,
311 struct fsfilt_objinfo *fso, int niocount,
312 struct niobuf_local *nb, struct obd_trans_info *oti,
315 unsigned long now = jiffies;
316 void *parent_handle = oti ? oti->oti_handle : NULL;
317 void *handle = obd->obd_fsops->fs_brw_start(objcount, fso, niocount, nb,
318 parent_handle, logs);
319 CDEBUG(D_INFO, "started handle %p (%p)\n", handle, parent_handle);
322 if (parent_handle == NULL) {
323 oti->oti_handle = handle;
324 } else if (handle != parent_handle) {
325 CERROR("mismatch: parent %p, handle %p, oti %p\n",
326 parent_handle, handle, oti);
330 fsfilt_check_slow(now, obd_timeout, "journal start");
336 fsfilt_brw_start(struct obd_device *obd, int objcount,
337 struct fsfilt_objinfo *fso, int niocount,
338 struct niobuf_local *nb, struct obd_trans_info *oti)
340 return fsfilt_brw_start_log(obd, objcount, fso, niocount, nb, oti, 0);
344 fsfilt_commit_async(struct obd_device *obd, struct inode *inode,
345 void *handle, void **wait_handle)
347 unsigned long now = jiffies;
348 int rc = obd->obd_fsops->fs_commit_async(inode, handle, wait_handle);
350 CDEBUG(D_INFO, "committing handle %p (async)\n", *wait_handle);
351 fsfilt_check_slow(now, obd_timeout, "journal start");
357 fsfilt_commit_wait(struct obd_device *obd, struct inode *inode, void *handle)
359 unsigned long now = jiffies;
360 int rc = obd->obd_fsops->fs_commit_wait(inode, handle);
361 CDEBUG(D_INFO, "waiting for completion %p\n", handle);
362 fsfilt_check_slow(now, obd_timeout, "journal start");
367 fsfilt_setattr(struct obd_device *obd, struct dentry *dentry,
368 void *handle, struct iattr *iattr, int do_trunc)
370 unsigned long now = jiffies;
372 rc = obd->obd_fsops->fs_setattr(dentry, handle, iattr, do_trunc);
373 fsfilt_check_slow(now, obd_timeout, "setattr");
378 fsfilt_iocontrol(struct obd_device *obd, struct inode *inode,
379 struct file *file, unsigned int cmd,
382 return obd->obd_fsops->fs_iocontrol(inode, file, cmd, arg);
385 static inline int fsfilt_setup(struct obd_device *obd,
386 struct super_block *fs)
388 if (obd->obd_fsops->fs_setup)
389 return obd->obd_fsops->fs_setup(obd, fs);
394 fsfilt_set_md(struct obd_device *obd, struct inode *inode,
395 void *handle, void *md, int size, enum ea_type type)
397 if (!obd->obd_fsops->fs_set_md)
400 return obd->obd_fsops->fs_set_md(inode, handle, md,
405 fsfilt_get_md(struct obd_device *obd, struct inode *inode,
406 void *md, int size, enum ea_type type)
408 if (!obd->obd_fsops->fs_get_md)
411 return obd->obd_fsops->fs_get_md(inode, md, size,
415 static inline int fsfilt_send_bio(int rw, struct obd_device *obd,
416 struct inode *inode, void *bio)
418 LASSERTF(rw == OBD_BRW_WRITE || rw == OBD_BRW_READ, "%x\n", rw);
420 if (rw == OBD_BRW_READ)
421 return obd->obd_fsops->fs_send_bio(READ, inode, bio);
423 return obd->obd_fsops->fs_send_bio(WRITE, inode, bio);
427 fsfilt_putpage(struct obd_device *obd, struct inode *inode,
431 struct filter_obd *filter;
432 unsigned long now = jiffies;
434 LASSERT(obd != NULL);
435 LASSERT(inode != NULL);
436 LASSERT(page != NULL);
438 filter = &obd->u.filter;
440 if (!obd->obd_fsops->fs_putpage)
443 CDEBUG(D_INFO, "putpage %lx\n", page->index);
445 rc = obd->obd_fsops->fs_putpage(inode, page);
447 fsfilt_check_slow(now, obd_timeout, "putpage");
452 static inline struct page *
453 fsfilt_getpage(struct obd_device *obd, struct inode *inode,
457 unsigned long now = jiffies;
459 LASSERT(obd != NULL);
460 LASSERT(inode != NULL);
462 if (!obd->obd_fsops->fs_getpage)
463 return ERR_PTR(-ENOSYS);
465 CDEBUG(D_INFO, "getpage %lx\n", index);
467 page = obd->obd_fsops->fs_getpage(inode, index);
469 fsfilt_check_slow(now, obd_timeout, "getpage");
474 static inline ssize_t
475 fsfilt_readpage(struct obd_device *obd, struct file *file, char *buf,
476 size_t count, loff_t *offset)
478 return obd->obd_fsops->fs_readpage(file, buf, count, offset);
482 fsfilt_add_journal_cb(struct obd_device *obd, struct super_block *sb,
483 __u64 last_num, void *handle, fsfilt_cb_t cb_func,
486 return obd->obd_fsops->fs_add_journal_cb(obd, sb, last_num, handle,
490 /* very similar to obd_statfs(), but caller already holds obd_osfs_lock */
492 fsfilt_statfs(struct obd_device *obd, struct super_block *sb,
493 unsigned long max_age)
497 CDEBUG(D_SUPER, "osfs %lu, max_age %lu\n", obd->obd_osfs_age, max_age);
498 if (time_before(obd->obd_osfs_age, max_age)) {
499 rc = obd->obd_fsops->fs_statfs(sb, &obd->obd_osfs);
500 if (rc == 0) /* N.B. statfs can't really fail */
501 obd->obd_osfs_age = jiffies;
503 CDEBUG(D_SUPER, "using cached obd_statfs data\n");
510 fsfilt_sync(struct obd_device *obd, struct super_block *sb)
512 return obd->obd_fsops->fs_sync(sb);
515 static inline int fsfilt_map_inode_pages(struct obd_device *obd,
517 struct page **page, int pages,
518 unsigned long *blocks, int *created,
519 int create, struct semaphore *sem)
521 return obd->obd_fsops->fs_map_inode_pages(inode, page, pages, blocks,
522 created, create, sem);
524 static inline int fsfilt_get_fs_flags(struct obd_device *obd,
525 struct dentry *dentry)
527 if (obd->obd_fsops->fs_get_fs_flags)
528 return obd->obd_fsops->fs_get_fs_flags(dentry);
533 fsfilt_write_extents(struct obd_device *obd, struct dentry *dentry,
534 unsigned long offset, unsigned long blks)
536 if (obd->obd_fsops->fs_write_extents)
537 return obd->obd_fsops->fs_write_extents(dentry,
542 fsfilt_do_write_cow(struct obd_device *obd, struct dentry *dentry,
543 void *extents, int num_extents)
545 if (obd->obd_fsops->fs_do_write_cow)
546 return obd->obd_fsops->fs_do_write_cow(dentry, extents,
551 fs_prep_san_write(struct obd_device *obd, struct inode *inode,
552 long *blocks, int nblocks, loff_t newsize)
554 return obd->obd_fsops->fs_prep_san_write(inode, blocks,
559 fsfilt_read_record(struct obd_device *obd, struct file *file,
560 void *buf, loff_t size, loff_t *offs)
562 return obd->obd_fsops->fs_read_record(file, buf, size, offs);
566 llog_fsfilt_read_record(struct llog_ctxt *ctxt, struct file *file,
567 void *buf, loff_t size, loff_t *offs)
569 return ctxt->loc_fsops->fs_read_record(file, buf, size, offs);
573 fsfilt_write_record(struct obd_device *obd, struct file *file,
574 void *buf, loff_t size, loff_t *offs, int force_sync)
576 return obd->obd_fsops->fs_write_record(file, buf, size, offs,
581 llog_fsfilt_write_record(struct llog_ctxt *ctxt, struct file *file,
582 void *buf, loff_t size, loff_t *offs,
585 return ctxt->loc_fsops->fs_write_record(file, buf, size, offs,
590 fsfilt_set_fs_flags(struct obd_device *obd, struct inode *inode, int flags)
592 if (obd->obd_fsops->fs_set_fs_flags)
593 return obd->obd_fsops->fs_set_fs_flags(inode, flags);
598 fsfilt_clear_fs_flags(struct obd_device *obd, struct inode *inode, int flags)
600 if (obd->obd_fsops->fs_clear_fs_flags)
601 return obd->obd_fsops->fs_clear_fs_flags(inode, flags);
606 fsfilt_precreate_rec(struct obd_device *obd, struct dentry *dentry,
607 int *num, struct obdo *oa)
609 if (obd->obd_fsops->fs_precreate_rec)
610 return obd->obd_fsops->fs_precreate_rec(dentry, num, oa);
615 fsfilt_post_setup(struct obd_device *obd, struct dentry *de)
617 if (obd->obd_fsops->fs_post_setup)
618 return obd->obd_fsops->fs_post_setup(obd,
619 obd->obd_lvfs_ctxt.pwdmnt, de);
624 fsfilt_post_cleanup(struct obd_device *obd)
626 if (obd->obd_fsops->fs_post_cleanup)
627 return obd->obd_fsops->fs_post_cleanup(obd,
628 obd->obd_lvfs_ctxt.pwdmnt);
633 fsfilt_get_ino_write_extents(struct obd_device *obd,
634 struct super_block *sb,
635 int ino, char **buf, int *size)
637 if (obd->obd_fsops->fs_get_ino_write_extents)
638 return obd->obd_fsops->fs_get_ino_write_extents(sb, ino,
644 fsfilt_free_write_extents(struct obd_device *obd,
645 struct super_block *sb,
646 int ino, char *buf, int size)
648 if (obd->obd_fsops->fs_free_write_extents)
649 return obd->obd_fsops->fs_free_write_extents(sb, ino,
655 fsfilt_get_reint_log_ctxt(struct obd_device *obd,
656 struct super_block *sb,
657 struct llog_ctxt **ctxt)
659 if (obd->obd_fsops->fs_get_reint_log_ctxt)
660 return obd->obd_fsops->fs_get_reint_log_ctxt(sb, ctxt);
665 fsfilt_set_ost_flags(struct obd_device *obd, struct super_block *sb)
667 if (obd->obd_fsops->fs_set_ost_flags)
668 return obd->obd_fsops->fs_set_ost_flags(sb);
673 fsfilt_set_mds_flags(struct obd_device *obd, struct super_block *sb)
675 if (obd->obd_fsops->fs_set_mds_flags)
676 return obd->obd_fsops->fs_set_mds_flags(sb);
681 fsfilt_add_dir_entry(struct obd_device *obd, struct dentry *dir,
682 char *name, int namelen, unsigned long ino,
683 unsigned long generation, unsigned long mds,
686 LASSERT(obd->obd_fsops->fs_add_dir_entry);
688 return obd->obd_fsops->fs_add_dir_entry(obd, dir, name,
695 fsfilt_del_dir_entry(struct obd_device *obd, struct dentry *dentry)
697 LASSERT(obd->obd_fsops->fs_del_dir_entry);
698 return obd->obd_fsops->fs_del_dir_entry(obd, dentry);
702 fsfilt_set_snap_item(struct obd_device *obd, struct super_block *sb,
705 if (obd->obd_fsops->fs_set_snap_item)
706 return obd->obd_fsops->fs_set_snap_item(sb, name);
709 #endif /* __KERNEL__ */