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.) */
51 struct fsfilt_operations {
52 struct list_head fs_list;
53 struct module *fs_owner;
56 void *(* fs_start)(struct inode *inode, int op, void *desc_private,
58 void *(* fs_brw_start)(int objcount, struct fsfilt_objinfo *fso,
59 int niocount, struct niobuf_local *nb,
60 void *desc_private, int logs);
61 int (* fs_commit)(struct super_block *sb, struct inode *inode,
62 void *handle,int force_sync);
63 int (* fs_commit_async)(struct inode *inode, void *handle,
65 int (* fs_commit_wait)(struct inode *inode, void *handle);
66 int (* fs_setattr)(struct dentry *dentry, void *handle,
67 struct iattr *iattr, int do_trunc);
68 int (* fs_iocontrol)(struct inode *inode, struct file *file,
69 unsigned int cmd, unsigned long arg);
71 /* two methods for setting getting diff. kind of EAs from inode. */
72 int (* fs_set_md)(struct inode *inode, void *handle, void *md,
73 int size, enum ea_type type);
74 int (* fs_get_md)(struct inode *inode, void *md, int size,
77 int (* fs_send_bio)(int rw, struct inode *inode, void *bio);
79 /* methods for getting page from backing fs and putting page there
80 * during IO. Used on OST. */
81 int (* fs_putpage)(struct inode *inode, struct page *page);
82 struct page *(* fs_getpage)(struct inode *inode, long int index);
84 ssize_t (* fs_readpage)(struct file *file, char *buf, size_t count,
86 int (* fs_add_journal_cb)(struct obd_device *obd,
87 struct super_block *sb,
88 __u64 last_rcvd, void *handle,
89 fsfilt_cb_t cb_func, void *cb_data);
90 int (* fs_statfs)(struct super_block *sb, struct obd_statfs *osfs);
91 int (* fs_sync)(struct super_block *sb);
92 int (* fs_map_inode_pages)(struct inode *inode, struct page **page,
93 int pages, unsigned long *blocks,
94 int *created, int create,
95 struct semaphore *sem);
96 int (* fs_prep_san_write)(struct inode *inode, long *blocks,
97 int nblocks, loff_t newsize);
98 int (* fs_write_record)(struct file *, void *, int size, loff_t *,
100 int (* fs_read_record)(struct file *, void *, int size, loff_t *);
101 int (* fs_setup)(struct obd_device *, struct super_block *);
103 int (* fs_post_setup)(struct obd_device *obd, struct vfsmount *mnt,
104 struct dentry *dentry);
105 int (* fs_post_cleanup)(struct obd_device *obd, struct vfsmount *mnt);
106 int (* fs_get_reint_log_ctxt)(struct super_block *sb,
107 struct llog_ctxt **ctxt);
108 int (* fs_set_fs_flags)(struct inode *inode, int flags);
109 int (* fs_clear_fs_flags)(struct inode *inode, int flags);
110 int (* fs_set_ost_flags)(struct super_block *sb);
111 int (* fs_set_mds_flags)(struct super_block *sb);
112 int (* fs_precreate_rec)(struct dentry *dentry, int *num,
114 int (* fs_set_xattr)(struct inode *inode, void *handle, char *name,
115 void *buffer, int buffer_size);
116 int (* fs_get_xattr)(struct inode *inode, char *name,
117 void *buffer, int buffer_size);
119 int (* fs_init_extents_ea)(struct inode *inode);
120 int (* fs_insert_extents_ea)(struct inode *inode, unsigned long from,
122 int (* fs_do_write_cow)(struct dentry *dentry, void *extents, int nexts);
123 int (* fs_write_extents)(struct dentry *dentry,
124 unsigned long offset, unsigned long blks);
125 int (* fs_get_fs_flags)(struct dentry *dentry);
126 int (* fs_remove_extents_ea)(struct inode *inode, unsigned long from,
128 int (* fs_get_ino_write_extents)(struct super_block *sb, ino_t ino,
129 char **pbuf, int *size);
130 int (* fs_free_write_extents)(struct super_block *sb, ino_t ino,
131 char *pbuf, int size);
132 int (* fs_get_inode_write_extents)(struct inode *inode, char **pbuf,
134 int (* fs_get_write_extents_num)(struct inode *inode, int* size);
136 int (* fs_get_op_len)(int, struct fsfilt_objinfo *, int);
137 int (* fs_add_dir_entry)(struct obd_device *, struct dentry *,
138 char *, int, unsigned long, unsigned long,
139 unsigned long, unsigned long);
140 int (* fs_del_dir_entry)(struct obd_device *, struct dentry *);
142 int (* fs_is_redirector)(struct inode *inode);
143 int (* fs_is_indirect)(struct inode *inode);
145 struct inode * (* fs_create_indirect)(struct inode *pri, int index,
147 struct inode *parent,
149 struct inode * (* fs_get_indirect)(struct inode *pri, int *table,
151 ino_t (* fs_get_indirect_ino)(struct super_block *sb, ino_t pri,
153 int (* fs_destroy_indirect)(struct inode *pri, int index,
154 struct inode *next_ind);
155 int (* fs_restore_indirect)(struct inode *pri, int index);
156 int (* fs_iterate)(struct super_block *sb,
157 int (*repeat)(struct inode *inode, void *priv),
158 struct inode **start, void *priv, int flag);
159 int (* fs_copy_block)(struct inode *dst, struct inode *src,
161 int (* fs_set_indirect)(struct inode *pri, int index,
162 ino_t ind_ino, ino_t parent_ino);
163 int (* fs_snap_feature)(struct super_block *sb, int feature,
165 int (* fs_set_snap_info)(struct inode *inode, void* key,
166 __u32 keylen, void *val, __u32 *vallen);
167 int (* fs_get_snap_info)(struct inode *inode, void* key,
168 __u32 keylen, void *val, __u32 *vallen);
169 int (* fs_set_snap_item)(struct super_block *sb, char *name);
170 int (* fs_read_dotsnap_dir_page)(struct file *file, char *buf,
171 size_t count, loff_t *ppos);
172 int (* fs_dir_ent_size)(char *name);
173 int (* fs_set_dir_ent)(struct super_block *sb, char *name,
174 char *buf, int buf_off, int nlen,
178 extern int fsfilt_register_ops(struct fsfilt_operations *fs_ops);
179 extern void fsfilt_unregister_ops(struct fsfilt_operations *fs_ops);
180 extern struct fsfilt_operations *fsfilt_get_ops(const char *type);
181 extern void fsfilt_put_ops(struct fsfilt_operations *fs_ops);
183 #define FSFILT_OP_UNLINK 1
184 #define FSFILT_OP_RMDIR 2
185 #define FSFILT_OP_RENAME 3
186 #define FSFILT_OP_CREATE 4
187 #define FSFILT_OP_MKDIR 5
188 #define FSFILT_OP_SYMLINK 6
189 #define FSFILT_OP_MKNOD 7
190 #define FSFILT_OP_SETATTR 8
191 #define FSFILT_OP_LINK 9
192 #define FSFILT_OP_CANCEL_UNLINK 10
193 #define FSFILT_OP_NOOP 15
195 /* XXX BUG 3188 -- must return to one set of opcodes */
196 #define KML_UNLINK 0x11
197 #define KML_RMDIR 0x12
198 #define KML_RENAME 0x13
199 #define KML_CREATE 0x14
200 #define KML_MKDIR 0x15
201 #define KML_SYMLINK 0x16
202 #define KML_MKNOD 0x17
203 #define KML_LINK 0x19
205 #define CACHE_UNLINK 0x21
206 #define CACHE_RMDIR 0x22
207 #define CACHE_RENAME 0x23
208 #define CACHE_CREATE 0x24
209 #define CACHE_MKDIR 0x25
210 #define CACHE_SYMLINK 0x26
211 #define CACHE_MKNOD 0x27
212 #define CACHE_LINK 0x29
213 #define CACHE_NOOP 0x2f
215 #define KML_CACHE_UNLINK 0x31
216 #define KML_CACHE_RMDIR 0x32
217 #define KML_CACHE_RENAME 0x33
218 #define KML_CACHE_CREATE 0x34
219 #define KML_CACHE_MKDIR 0x35
220 #define KML_CACHE_SYMLINK 0x36
221 #define KML_CACHE_MKNOD 0x37
222 #define KML_CACHE_LINK 0x39
223 #define KML_CACHE_NOOP 0x3f
225 /*for fsfilt set md ea*/
229 #define fsfilt_check_slow(start, timeout, msg) \
231 if (time_before(jiffies, start + 15 * HZ)) \
233 else if (time_before(jiffies, start + timeout / 2 * HZ)) \
234 CWARN("slow %s %lus\n", msg, (jiffies - start) / HZ); \
236 CERROR("slow %s %lus\n", msg, (jiffies - start) / HZ); \
240 fsfilt_start_ops(struct fsfilt_operations *ops, struct inode *inode,
241 int op, struct obd_trans_info *oti, int logs)
243 unsigned long now = jiffies;
244 void *parent_handle = oti ? oti->oti_handle : NULL;
245 void *handle = ops->fs_start(inode, op, parent_handle, logs);
246 CDEBUG(D_INFO, "started handle %p (%p)\n", handle, parent_handle);
249 if (parent_handle == NULL) {
250 oti->oti_handle = handle;
251 } else if (handle != parent_handle) {
252 CERROR("mismatch: parent %p, handle %p, oti %p\n",
253 parent_handle, handle, oti);
257 fsfilt_check_slow(now, 60, "journal start");
262 fsfilt_start_log(struct obd_device *obd, struct inode *inode,
263 int op, struct obd_trans_info *oti, int logs)
265 return fsfilt_start_ops(obd->obd_fsops, inode, op, oti, logs);
269 fsfilt_start(struct obd_device *obd, struct inode *inode,
270 int op, struct obd_trans_info *oti)
272 return fsfilt_start_ops(obd->obd_fsops, inode, op, oti, 0);
276 llog_fsfilt_start(struct llog_ctxt *ctxt, struct inode *inode,
277 int op, struct obd_trans_info *oti)
279 return fsfilt_start_ops(ctxt->loc_fsops, inode, op, oti, 1);
283 fsfilt_commit_ops(struct fsfilt_operations *ops, struct super_block *sb,
284 struct inode *inode, void *handle, int force_sync)
286 unsigned long now = jiffies;
287 int rc = ops->fs_commit(sb, inode, handle, force_sync);
288 CDEBUG(D_INFO, "committing handle %p\n", handle);
290 fsfilt_check_slow(now, 60, "journal start");
296 fsfilt_commit(struct obd_device *obd, struct super_block *sb,
297 struct inode *inode, void *handle, int force_sync)
299 return fsfilt_commit_ops(obd->obd_fsops, sb, inode, handle, force_sync);
303 llog_fsfilt_commit(struct llog_ctxt *ctxt, struct inode *inode,
304 void *handle, int force_sync)
306 return fsfilt_commit_ops(ctxt->loc_fsops, inode->i_sb, inode, handle,
311 fsfilt_brw_start_log(struct obd_device *obd, int objcount,
312 struct fsfilt_objinfo *fso, int niocount,
313 struct niobuf_local *nb, struct obd_trans_info *oti,
316 unsigned long now = jiffies;
317 void *parent_handle = oti ? oti->oti_handle : NULL;
318 void *handle = obd->obd_fsops->fs_brw_start(objcount, fso, niocount, nb,
319 parent_handle, logs);
320 CDEBUG(D_INFO, "started handle %p (%p)\n", handle, parent_handle);
323 if (parent_handle == NULL) {
324 oti->oti_handle = handle;
325 } else if (handle != parent_handle) {
326 CERROR("mismatch: parent %p, handle %p, oti %p\n",
327 parent_handle, handle, oti);
331 fsfilt_check_slow(now, obd_timeout, "journal start");
337 fsfilt_brw_start(struct obd_device *obd, int objcount,
338 struct fsfilt_objinfo *fso, int niocount,
339 struct niobuf_local *nb, struct obd_trans_info *oti)
341 return fsfilt_brw_start_log(obd, objcount, fso, niocount, nb, oti, 0);
345 fsfilt_commit_async(struct obd_device *obd, struct inode *inode,
346 void *handle, void **wait_handle)
348 unsigned long now = jiffies;
349 int rc = obd->obd_fsops->fs_commit_async(inode, handle, wait_handle);
351 CDEBUG(D_INFO, "committing handle %p (async)\n", *wait_handle);
352 fsfilt_check_slow(now, obd_timeout, "journal start");
358 fsfilt_commit_wait(struct obd_device *obd, struct inode *inode, void *handle)
360 unsigned long now = jiffies;
361 int rc = obd->obd_fsops->fs_commit_wait(inode, handle);
362 CDEBUG(D_INFO, "waiting for completion %p\n", handle);
363 fsfilt_check_slow(now, obd_timeout, "journal start");
368 fsfilt_setattr(struct obd_device *obd, struct dentry *dentry,
369 void *handle, struct iattr *iattr, int do_trunc)
371 unsigned long now = jiffies;
373 rc = obd->obd_fsops->fs_setattr(dentry, handle, iattr, do_trunc);
374 fsfilt_check_slow(now, obd_timeout, "setattr");
379 fsfilt_iocontrol(struct obd_device *obd, struct inode *inode,
380 struct file *file, unsigned int cmd,
383 return obd->obd_fsops->fs_iocontrol(inode, file, cmd, arg);
386 static inline int fsfilt_setup(struct obd_device *obd,
387 struct super_block *fs)
389 if (obd->obd_fsops->fs_setup)
390 return obd->obd_fsops->fs_setup(obd, fs);
395 fsfilt_set_md(struct obd_device *obd, struct inode *inode,
396 void *handle, void *md, int size, enum ea_type type)
398 if (!obd->obd_fsops->fs_set_md)
401 return obd->obd_fsops->fs_set_md(inode, handle, md,
406 fsfilt_get_md(struct obd_device *obd, struct inode *inode,
407 void *md, int size, enum ea_type type)
409 if (!obd->obd_fsops->fs_get_md)
412 return obd->obd_fsops->fs_get_md(inode, md, size,
416 static inline int fsfilt_send_bio(int rw, struct obd_device *obd,
417 struct inode *inode, void *bio)
419 LASSERTF(rw == OBD_BRW_WRITE || rw == OBD_BRW_READ, "%x\n", rw);
421 if (rw == OBD_BRW_READ)
422 return obd->obd_fsops->fs_send_bio(READ, inode, bio);
424 return obd->obd_fsops->fs_send_bio(WRITE, inode, bio);
428 fsfilt_putpage(struct obd_device *obd, struct inode *inode,
432 struct filter_obd *filter;
433 unsigned long now = jiffies;
435 LASSERT(obd != NULL);
436 LASSERT(inode != NULL);
437 LASSERT(page != NULL);
439 filter = &obd->u.filter;
441 if (!obd->obd_fsops->fs_putpage)
444 CDEBUG(D_INFO, "putpage %lx\n", page->index);
446 rc = obd->obd_fsops->fs_putpage(inode, page);
448 fsfilt_check_slow(now, obd_timeout, "putpage");
453 static inline struct page *
454 fsfilt_getpage(struct obd_device *obd, struct inode *inode,
458 unsigned long now = jiffies;
460 LASSERT(obd != NULL);
461 LASSERT(inode != NULL);
463 if (!obd->obd_fsops->fs_getpage)
464 return ERR_PTR(-ENOSYS);
466 CDEBUG(D_INFO, "getpage %lx\n", index);
468 page = obd->obd_fsops->fs_getpage(inode, index);
470 fsfilt_check_slow(now, obd_timeout, "getpage");
475 static inline ssize_t
476 fsfilt_readpage(struct obd_device *obd, struct file *file, char *buf,
477 size_t count, loff_t *offset)
479 return obd->obd_fsops->fs_readpage(file, buf, count, offset);
483 fsfilt_add_journal_cb(struct obd_device *obd, struct super_block *sb,
484 __u64 last_num, void *handle, fsfilt_cb_t cb_func,
487 return obd->obd_fsops->fs_add_journal_cb(obd, sb, last_num, handle,
491 /* very similar to obd_statfs(), but caller already holds obd_osfs_lock */
493 fsfilt_statfs(struct obd_device *obd, struct super_block *sb,
494 unsigned long max_age)
498 CDEBUG(D_SUPER, "osfs %lu, max_age %lu\n", obd->obd_osfs_age, max_age);
499 if (time_before(obd->obd_osfs_age, max_age)) {
500 rc = obd->obd_fsops->fs_statfs(sb, &obd->obd_osfs);
501 if (rc == 0) /* N.B. statfs can't really fail */
502 obd->obd_osfs_age = jiffies;
504 CDEBUG(D_SUPER, "using cached obd_statfs data\n");
511 fsfilt_sync(struct obd_device *obd, struct super_block *sb)
513 return obd->obd_fsops->fs_sync(sb);
516 static inline int fsfilt_map_inode_pages(struct obd_device *obd,
518 struct page **page, int pages,
519 unsigned long *blocks, int *created,
520 int create, struct semaphore *sem)
522 return obd->obd_fsops->fs_map_inode_pages(inode, page, pages, blocks,
523 created, create, sem);
525 static inline int fsfilt_get_fs_flags(struct obd_device *obd,
526 struct dentry *dentry)
528 if (obd->obd_fsops->fs_get_fs_flags)
529 return obd->obd_fsops->fs_get_fs_flags(dentry);
534 fsfilt_write_extents(struct obd_device *obd, struct dentry *dentry,
535 unsigned long offset, unsigned long blks)
537 if (obd->obd_fsops->fs_write_extents)
538 return obd->obd_fsops->fs_write_extents(dentry,
543 fsfilt_do_write_cow(struct obd_device *obd, struct dentry *dentry,
544 void *extents, int num_extents)
546 if (obd->obd_fsops->fs_do_write_cow)
547 return obd->obd_fsops->fs_do_write_cow(dentry, extents,
552 fs_prep_san_write(struct obd_device *obd, struct inode *inode,
553 long *blocks, int nblocks, loff_t newsize)
555 return obd->obd_fsops->fs_prep_san_write(inode, blocks,
560 fsfilt_read_record(struct obd_device *obd, struct file *file,
561 void *buf, loff_t size, loff_t *offs)
563 return obd->obd_fsops->fs_read_record(file, buf, size, offs);
567 llog_fsfilt_read_record(struct llog_ctxt *ctxt, struct file *file,
568 void *buf, loff_t size, loff_t *offs)
570 return ctxt->loc_fsops->fs_read_record(file, buf, size, offs);
574 fsfilt_write_record(struct obd_device *obd, struct file *file,
575 void *buf, loff_t size, loff_t *offs, int force_sync)
577 return obd->obd_fsops->fs_write_record(file, buf, size, offs,
582 llog_fsfilt_write_record(struct llog_ctxt *ctxt, struct file *file,
583 void *buf, loff_t size, loff_t *offs,
586 return ctxt->loc_fsops->fs_write_record(file, buf, size, offs,
591 fsfilt_set_fs_flags(struct obd_device *obd, struct inode *inode, int flags)
593 if (obd->obd_fsops->fs_set_fs_flags)
594 return obd->obd_fsops->fs_set_fs_flags(inode, flags);
599 fsfilt_clear_fs_flags(struct obd_device *obd, struct inode *inode, int flags)
601 if (obd->obd_fsops->fs_clear_fs_flags)
602 return obd->obd_fsops->fs_clear_fs_flags(inode, flags);
607 fsfilt_precreate_rec(struct obd_device *obd, struct dentry *dentry,
608 int *num, struct obdo *oa)
610 if (obd->obd_fsops->fs_precreate_rec)
611 return obd->obd_fsops->fs_precreate_rec(dentry, num, oa);
616 fsfilt_post_setup(struct obd_device *obd, struct dentry *de)
618 if (obd->obd_fsops->fs_post_setup)
619 return obd->obd_fsops->fs_post_setup(obd,
620 obd->obd_lvfs_ctxt.pwdmnt, de);
625 fsfilt_post_cleanup(struct obd_device *obd)
627 if (obd->obd_fsops->fs_post_cleanup)
628 return obd->obd_fsops->fs_post_cleanup(obd,
629 obd->obd_lvfs_ctxt.pwdmnt);
634 fsfilt_get_ino_write_extents(struct obd_device *obd,
635 struct super_block *sb,
636 int ino, char **buf, int *size)
638 if (obd->obd_fsops->fs_get_ino_write_extents)
639 return obd->obd_fsops->fs_get_ino_write_extents(sb, ino,
645 fsfilt_free_write_extents(struct obd_device *obd,
646 struct super_block *sb,
647 int ino, char *buf, int size)
649 if (obd->obd_fsops->fs_free_write_extents)
650 return obd->obd_fsops->fs_free_write_extents(sb, ino,
656 fsfilt_get_reint_log_ctxt(struct obd_device *obd,
657 struct super_block *sb,
658 struct llog_ctxt **ctxt)
660 if (obd->obd_fsops->fs_get_reint_log_ctxt)
661 return obd->obd_fsops->fs_get_reint_log_ctxt(sb, ctxt);
666 fsfilt_set_ost_flags(struct obd_device *obd, struct super_block *sb)
668 if (obd->obd_fsops->fs_set_ost_flags)
669 return obd->obd_fsops->fs_set_ost_flags(sb);
674 fsfilt_set_mds_flags(struct obd_device *obd, struct super_block *sb)
676 if (obd->obd_fsops->fs_set_mds_flags)
677 return obd->obd_fsops->fs_set_mds_flags(sb);
682 fsfilt_add_dir_entry(struct obd_device *obd, struct dentry *dir,
683 char *name, int namelen, unsigned long ino,
684 unsigned long generation, unsigned long mds,
687 LASSERT(obd->obd_fsops->fs_add_dir_entry);
689 return obd->obd_fsops->fs_add_dir_entry(obd, dir, name,
696 fsfilt_del_dir_entry(struct obd_device *obd, struct dentry *dentry)
698 LASSERT(obd->obd_fsops->fs_del_dir_entry);
699 return obd->obd_fsops->fs_del_dir_entry(obd, dentry);
703 fsfilt_set_snap_item(struct obd_device *obd, struct super_block *sb,
706 if (obd->obd_fsops->fs_set_snap_item)
707 return obd->obd_fsops->fs_set_snap_item(sb, name);
710 #endif /* __KERNEL__ */