1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2 * vim:expandtab:shiftwidth=8:tabstop=8:
6 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 only,
10 * as published by the Free Software Foundation.
12 * This program is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * General Public License version 2 for more details (a copy is included
16 * in the LICENSE file that accompanied this code).
18 * You should have received a copy of the GNU General Public License
19 * version 2 along with this program; If not, see
20 * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
22 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
23 * CA 95054 USA or visit www.sun.com if you need additional information or
29 * Copyright 2008 Sun Microsystems, Inc. All rights reserved
30 * Use is subject to license terms.
33 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
36 * lustre/include/linux/lustre_fsfilt.h
38 * Filesystem interface helper.
41 #ifndef _LINUX_LUSTRE_FSFILT_H
42 #define _LINUX_LUSTRE_FSFILT_H
44 #ifndef _LUSTRE_FSFILT_H
45 #error Do not #include this file directly. #include <lustre_fsfilt.h> instead
51 #include <obd_class.h>
53 typedef void (*fsfilt_cb_t)(struct obd_device *obd, __u64 last_rcvd,
54 void *data, int error);
56 struct fsfilt_objinfo {
57 struct dentry *fso_dentry;
62 struct fsfilt_operations {
63 struct list_head fs_list;
64 struct module *fs_owner;
66 char *(* fs_getlabel)(struct super_block *sb);
67 int (* fs_setlabel)(struct super_block *sb, char *label);
68 char *(* fs_uuid)(struct super_block *sb);
69 void *(* fs_start)(struct inode *inode, int op, void *desc_private,
71 void *(* fs_brw_start)(int objcount, struct fsfilt_objinfo *fso,
72 int niocount, struct niobuf_local *nb,
73 void *desc_private, int logs);
74 int (* fs_extend)(struct inode *inode, unsigned nblocks, void *h);
75 int (* fs_commit)(struct inode *inode, void *handle,int force_sync);
76 int (* fs_commit_async)(struct inode *inode, void *handle,
78 int (* fs_commit_wait)(struct inode *inode, void *handle);
79 int (* fs_setattr)(struct dentry *dentry, void *handle,
80 struct iattr *iattr, int do_trunc);
81 int (* fs_iocontrol)(struct inode *inode, struct file *file,
82 unsigned int cmd, unsigned long arg);
83 int (* fs_set_md)(struct inode *inode, void *handle, void *md,
84 int size, const char *name);
85 int (* fs_get_md)(struct inode *inode, void *md, int size,
88 * this method is needed to make IO operation fsfilt nature depend.
90 * This operation maybe synchronous or asynchronous.
92 * Return convention: positive number of bytes written (synchronously)
93 * on success. Negative errno value on failure. Zero if asynchronous
94 * IO was submitted successfully.
97 int (* fs_send_bio)(int rw, struct inode *inode,struct kiobuf *bio);
98 ssize_t (* fs_readpage)(struct file *file, char *buf, size_t count,
100 int (* fs_add_journal_cb)(struct obd_device *obd, __u64 last_rcvd,
101 void *handle, fsfilt_cb_t cb_func,
103 int (* fs_statfs)(struct super_block *sb, struct obd_statfs *osfs);
104 int (* fs_sync)(struct super_block *sb);
105 int (* fs_map_inode_pages)(struct inode *inode, struct page **page,
106 int pages, unsigned long *blocks,
107 int *created, int create,
108 struct semaphore *sem);
109 int (* fs_write_record)(struct file *, void *, int size, loff_t *,
111 int (* fs_read_record)(struct file *, void *, int size, loff_t *);
112 int (* fs_setup)(struct super_block *sb);
113 int (* fs_get_op_len)(int, struct fsfilt_objinfo *, int);
114 int (* fs_quotacheck)(struct super_block *sb,
115 struct obd_quotactl *oqctl);
116 __u64 (* fs_get_version) (struct inode *inode);
117 __u64 (* fs_set_version) (struct inode *inode, __u64 new_version);
118 int (* fs_quotactl)(struct super_block *sb,
119 struct obd_quotactl *oqctl);
120 int (* fs_quotainfo)(struct lustre_quota_info *lqi, int type,
122 int (* fs_qids)(struct file *file, struct inode *inode, int type,
123 struct list_head *list);
124 int (* fs_get_mblk)(struct super_block *sb, int *count,
125 struct inode *inode, int frags);
126 int (* fs_dquot)(struct lustre_dquot *dquot, int cmd);
127 lvfs_sbdev_type (* fs_journal_sbdev)(struct super_block *sb);
130 extern int fsfilt_register_ops(struct fsfilt_operations *fs_ops);
131 extern void fsfilt_unregister_ops(struct fsfilt_operations *fs_ops);
132 extern struct fsfilt_operations *fsfilt_get_ops(const char *type);
133 extern void fsfilt_put_ops(struct fsfilt_operations *fs_ops);
135 static inline char *fsfilt_get_label(struct obd_device *obd,
136 struct super_block *sb)
138 if (obd->obd_fsops->fs_getlabel == NULL)
140 if (obd->obd_fsops->fs_getlabel(sb)[0] == '\0')
143 return obd->obd_fsops->fs_getlabel(sb);
146 static inline int fsfilt_set_label(struct obd_device *obd,
147 struct super_block *sb, char *label)
149 if (obd->obd_fsops->fs_setlabel == NULL)
151 return (obd->obd_fsops->fs_setlabel(sb, label));
154 static inline __u8 *fsfilt_uuid(struct obd_device *obd, struct super_block *sb)
156 if (obd->obd_fsops->fs_uuid == NULL)
159 return obd->obd_fsops->fs_uuid(sb);
162 static inline lvfs_sbdev_type fsfilt_journal_sbdev(struct obd_device *obd,
163 struct super_block *sb)
165 if (obd && obd->obd_fsops && obd->obd_fsops->fs_journal_sbdev)
166 return obd->obd_fsops->fs_journal_sbdev(sb);
167 return (lvfs_sbdev_type)0;
170 #define FSFILT_OP_UNLINK 1
171 #define FSFILT_OP_RMDIR 2
172 #define FSFILT_OP_RENAME 3
173 #define FSFILT_OP_CREATE 4
174 #define FSFILT_OP_MKDIR 5
175 #define FSFILT_OP_SYMLINK 6
176 #define FSFILT_OP_MKNOD 7
177 #define FSFILT_OP_SETATTR 8
178 #define FSFILT_OP_LINK 9
179 #define FSFILT_OP_CANCEL_UNLINK 10
180 #define FSFILT_OP_JOIN 11
181 #define FSFILT_OP_NOOP 15
182 #define FSFILT_OP_UNLINK_PARTIAL_CHILD 21
183 #define FSFILT_OP_UNLINK_PARTIAL_PARENT 22
184 #define FSFILT_OP_CREATE_PARTIAL_CHILD 23
186 #define __fsfilt_check_slow(obd, start, msg) \
188 if (time_before(jiffies, start + 15 * HZ)) \
190 else if (time_before(jiffies, start + 30 * HZ)) \
191 CDEBUG(D_VFSTRACE, "%s: slow %s %lus\n", obd->obd_name, \
192 msg, (jiffies-start) / HZ); \
193 else if (time_before(jiffies, start + DISK_TIMEOUT * HZ)) \
194 CWARN("%s: slow %s %lus\n", obd->obd_name, msg, \
195 (jiffies - start) / HZ); \
197 CERROR("%s: slow %s %lus\n", obd->obd_name, msg, \
198 (jiffies - start) / HZ); \
201 #define fsfilt_check_slow(obd, start, msg) \
203 __fsfilt_check_slow(obd, start, msg); \
207 static inline void *fsfilt_start_log(struct obd_device *obd,
208 struct inode *inode, int op,
209 struct obd_trans_info *oti, int logs)
211 unsigned long now = jiffies;
212 void *parent_handle = oti ? oti->oti_handle : NULL;
215 handle = obd->obd_fsops->fs_start(inode, op, parent_handle, logs);
216 CDEBUG(D_INFO, "started handle %p (%p)\n", handle, parent_handle);
219 if (parent_handle == NULL) {
220 oti->oti_handle = handle;
221 } else if (handle != parent_handle) {
222 CERROR("mismatch: parent %p, handle %p, oti %p\n",
223 parent_handle, handle, oti);
227 fsfilt_check_slow(obd, now, "journal start");
231 static inline void *fsfilt_start(struct obd_device *obd, struct inode *inode,
232 int op, struct obd_trans_info *oti)
234 return fsfilt_start_log(obd, inode, op, oti, 0);
237 static inline void *fsfilt_brw_start_log(struct obd_device *obd, int objcount,
238 struct fsfilt_objinfo *fso,
239 int niocount, struct niobuf_local *nb,
240 struct obd_trans_info *oti, int logs)
242 unsigned long now = jiffies;
243 void *parent_handle = oti ? oti->oti_handle : NULL;
246 handle = obd->obd_fsops->fs_brw_start(objcount, fso, niocount, nb,
247 parent_handle, logs);
248 CDEBUG(D_INFO, "started handle %p (%p)\n", handle, parent_handle);
251 if (parent_handle == NULL) {
252 oti->oti_handle = handle;
253 } else if (handle != parent_handle) {
254 CERROR("mismatch: parent %p, handle %p, oti %p\n",
255 parent_handle, handle, oti);
259 fsfilt_check_slow(obd, now, "journal start");
264 static inline void *fsfilt_brw_start(struct obd_device *obd, int objcount,
265 struct fsfilt_objinfo *fso, int niocount,
266 struct niobuf_local *nb,
267 struct obd_trans_info *oti)
269 return fsfilt_brw_start_log(obd, objcount, fso, niocount, nb, oti, 0);
272 static inline int fsfilt_extend(struct obd_device *obd, struct inode *inode,
273 unsigned int nblocks, void *handle)
275 unsigned long now = jiffies;
276 int rc = obd->obd_fsops->fs_extend(inode, nblocks, handle);
277 CDEBUG(D_INFO, "extending handle %p with %u blocks\n", handle, nblocks);
279 fsfilt_check_slow(obd, now, "journal extend");
284 static inline int fsfilt_commit(struct obd_device *obd, struct inode *inode,
285 void *handle, int force_sync)
287 unsigned long now = jiffies;
288 int rc = obd->obd_fsops->fs_commit(inode, handle, force_sync);
289 CDEBUG(D_INFO, "committing handle %p\n", handle);
291 fsfilt_check_slow(obd, now, "journal start");
296 static inline int fsfilt_commit_async(struct obd_device *obd,
297 struct inode *inode, void *handle,
300 unsigned long now = jiffies;
301 int rc = obd->obd_fsops->fs_commit_async(inode, handle, wait_handle);
303 CDEBUG(D_INFO, "committing handle %p (async)\n", *wait_handle);
304 fsfilt_check_slow(obd, now, "journal start");
309 static inline int fsfilt_commit_wait(struct obd_device *obd,
310 struct inode *inode, void *handle)
312 unsigned long now = jiffies;
313 int rc = obd->obd_fsops->fs_commit_wait(inode, handle);
314 CDEBUG(D_INFO, "waiting for completion %p\n", handle);
315 fsfilt_check_slow(obd, now, "journal start");
319 static inline int fsfilt_setattr(struct obd_device *obd, struct dentry *dentry,
320 void *handle, struct iattr *iattr,int do_trunc)
322 unsigned long now = jiffies;
324 rc = obd->obd_fsops->fs_setattr(dentry, handle, iattr, do_trunc);
325 fsfilt_check_slow(obd, now, "setattr");
329 static inline int fsfilt_iocontrol(struct obd_device *obd, struct dentry *dentry,
330 unsigned int cmd, unsigned long arg)
332 struct file *dummy_file = NULL;
335 OBD_ALLOC_PTR(dummy_file);
339 dummy_file->f_dentry = dentry;
340 dummy_file->f_vfsmnt = obd->u.obt.obt_vfsmnt;
342 ret = obd->obd_fsops->fs_iocontrol(dentry->d_inode, dummy_file, cmd,
345 OBD_FREE_PTR(dummy_file);
349 static inline int fsfilt_set_md(struct obd_device *obd, struct inode *inode,
350 void *handle, void *md, int size,
353 return obd->obd_fsops->fs_set_md(inode, handle, md, size, name);
356 static inline int fsfilt_get_md(struct obd_device *obd, struct inode *inode,
357 void *md, int size, const char *name)
359 return obd->obd_fsops->fs_get_md(inode, md, size, name);
362 static inline int fsfilt_send_bio(int rw, struct obd_device *obd,
363 struct inode *inode, void *bio)
365 LASSERTF(rw == OBD_BRW_WRITE || rw == OBD_BRW_READ, "%x\n", rw);
367 if (rw == OBD_BRW_READ)
368 return obd->obd_fsops->fs_send_bio(READ, inode, bio);
369 return obd->obd_fsops->fs_send_bio(WRITE, inode, bio);
372 static inline ssize_t fsfilt_readpage(struct obd_device *obd,
373 struct file *file, char *buf,
374 size_t count, loff_t *offset)
376 return obd->obd_fsops->fs_readpage(file, buf, count, offset);
379 static inline int fsfilt_add_journal_cb(struct obd_device *obd, __u64 last_rcvd,
380 void *handle, fsfilt_cb_t cb_func,
383 return obd->obd_fsops->fs_add_journal_cb(obd, last_rcvd,
384 handle, cb_func, cb_data);
387 /* very similar to obd_statfs(), but caller already holds obd_osfs_lock */
388 static inline int fsfilt_statfs(struct obd_device *obd, struct super_block *sb,
393 CDEBUG(D_SUPER, "osfs "LPU64", max_age "LPU64"\n",
394 obd->obd_osfs_age, max_age);
395 if (cfs_time_before_64(obd->obd_osfs_age, max_age)) {
396 rc = obd->obd_fsops->fs_statfs(sb, &obd->obd_osfs);
397 if (rc == 0) /* N.B. statfs can't really fail */
398 obd->obd_osfs_age = cfs_time_current_64();
400 CDEBUG(D_SUPER, "using cached obd_statfs data\n");
406 static inline int fsfilt_sync(struct obd_device *obd, struct super_block *sb)
408 return obd->obd_fsops->fs_sync(sb);
411 static inline int fsfilt_quotacheck(struct obd_device *obd,
412 struct super_block *sb,
413 struct obd_quotactl *oqctl)
415 if (obd->obd_fsops->fs_quotacheck)
416 return obd->obd_fsops->fs_quotacheck(sb, oqctl);
420 static inline int fsfilt_quotactl(struct obd_device *obd,
421 struct super_block *sb,
422 struct obd_quotactl *oqctl)
424 if (obd->obd_fsops->fs_quotactl)
425 return obd->obd_fsops->fs_quotactl(sb, oqctl);
429 static inline int fsfilt_quotainfo(struct obd_device *obd,
430 struct lustre_quota_info *lqi,
433 if (obd->obd_fsops->fs_quotainfo)
434 return obd->obd_fsops->fs_quotainfo(lqi, type, cmd);
438 static inline int fsfilt_qids(struct obd_device *obd, struct file *file,
439 struct inode *inode, int type,
440 struct list_head *list)
442 if (obd->obd_fsops->fs_qids)
443 return obd->obd_fsops->fs_qids(file, inode, type, list);
447 static inline int fsfilt_dquot(struct obd_device *obd,
448 struct lustre_dquot *dquot, int cmd)
450 if (obd->obd_fsops->fs_dquot)
451 return obd->obd_fsops->fs_dquot(dquot, cmd);
455 static inline int fsfilt_get_mblk(struct obd_device *obd,
456 struct super_block *sb, int *count,
457 struct inode *inode, int frags)
459 if (obd->obd_fsops->fs_get_mblk)
460 return obd->obd_fsops->fs_get_mblk(sb, count, inode, frags);
464 static inline int fsfilt_map_inode_pages(struct obd_device *obd,
466 struct page **page, int pages,
467 unsigned long *blocks, int *created,
468 int create, struct semaphore *sem)
470 return obd->obd_fsops->fs_map_inode_pages(inode, page, pages, blocks,
471 created, create, sem);
474 static inline int fsfilt_read_record(struct obd_device *obd, struct file *file,
475 void *buf, loff_t size, loff_t *offs)
477 return obd->obd_fsops->fs_read_record(file, buf, size, offs);
480 static inline int fsfilt_write_record(struct obd_device *obd, struct file *file,
481 void *buf, loff_t size, loff_t *offs,
484 return obd->obd_fsops->fs_write_record(file, buf, size,offs,force_sync);
487 static inline int fsfilt_setup(struct obd_device *obd, struct super_block *fs)
489 if (obd->obd_fsops->fs_setup)
490 return obd->obd_fsops->fs_setup(fs);
494 static inline __u64 fsfilt_set_version(struct obd_device *obd,
495 struct inode *inode, __u64 new_version)
497 if (obd->obd_fsops->fs_set_version)
498 return obd->obd_fsops->fs_set_version(inode, new_version);
502 static inline __u64 fsfilt_get_version(struct obd_device *obd,
505 if (obd->obd_fsops->fs_get_version)
506 return obd->obd_fsops->fs_get_version(inode);
510 #endif /* __KERNEL__ */