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 (c) 2002, 2010, Oracle and/or its affiliates. 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;
67 struct fsfilt_operations {
69 cfs_module_t *fs_owner;
71 char *(* fs_getlabel)(struct super_block *sb);
72 int (* fs_setlabel)(struct super_block *sb, char *label);
73 char *(* fs_uuid)(struct super_block *sb);
74 void *(* fs_start)(struct inode *inode, int op, void *desc_private,
76 void *(* fs_brw_start)(int objcount, struct fsfilt_objinfo *fso,
77 int niocount, struct niobuf_local *nb,
78 void *desc_private, int logs);
79 int (* fs_extend)(struct inode *inode, unsigned nblocks, void *h);
80 int (* fs_commit)(struct inode *inode, void *handle,int force_sync);
81 int (* fs_commit_async)(struct inode *inode, void *handle,
83 int (* fs_commit_wait)(struct inode *inode, void *handle);
84 int (* fs_setattr)(struct dentry *dentry, void *handle,
85 struct iattr *iattr, int do_trunc);
86 int (* fs_iocontrol)(struct inode *inode, struct file *file,
87 unsigned int cmd, unsigned long arg);
88 int (* fs_set_md)(struct inode *inode, void *handle, void *md,
89 int size, const char *name);
90 int (* fs_get_md)(struct inode *inode, void *md, int size,
93 * this method is needed to make IO operation fsfilt nature depend.
95 * This operation maybe synchronous or asynchronous.
97 * Return convention: positive number of bytes written (synchronously)
98 * on success. Negative errno value on failure. Zero if asynchronous
99 * IO was submitted successfully.
102 int (* fs_send_bio)(int rw, struct inode *inode,struct kiobuf *bio);
103 ssize_t (* fs_readpage)(struct file *file, char *buf, size_t count,
105 int (* fs_add_journal_cb)(struct obd_device *obd, __u64 last_rcvd,
106 void *handle, fsfilt_cb_t cb_func,
108 int (* fs_statfs)(struct super_block *sb, struct obd_statfs *osfs);
109 int (* fs_sync)(struct super_block *sb);
110 int (* fs_map_inode_pages)(struct inode *inode, struct page **page,
111 int pages, unsigned long *blocks,
112 int *created, int create,
113 cfs_semaphore_t *sem);
114 int (* fs_write_record)(struct file *, void *, int size, loff_t *,
116 int (* fs_read_record)(struct file *, void *, int size, loff_t *);
117 int (* fs_setup)(struct super_block *sb);
118 int (* fs_get_op_len)(int, struct fsfilt_objinfo *, int);
119 int (* fs_quotacheck)(struct super_block *sb,
120 struct obd_quotactl *oqctl);
121 __u64 (* fs_get_version) (struct inode *inode);
122 __u64 (* fs_set_version) (struct inode *inode, __u64 new_version);
123 int (* fs_quotactl)(struct super_block *sb,
124 struct obd_quotactl *oqctl);
125 int (* fs_quotainfo)(struct lustre_quota_info *lqi, int type,
127 int (* fs_qids)(struct file *file, struct inode *inode, int type,
129 int (* fs_get_mblk)(struct super_block *sb, int *count,
130 struct inode *inode, int frags);
131 int (* fs_dquot)(struct lustre_dquot *dquot, int cmd);
132 lvfs_sbdev_type (* fs_journal_sbdev)(struct super_block *sb);
133 struct dentry *(* fs_fid2dentry)(struct vfsmount *mnt,
134 struct fsfilt_fid *fid,
138 extern int fsfilt_register_ops(struct fsfilt_operations *fs_ops);
139 extern void fsfilt_unregister_ops(struct fsfilt_operations *fs_ops);
140 extern struct fsfilt_operations *fsfilt_get_ops(const char *type);
141 extern void fsfilt_put_ops(struct fsfilt_operations *fs_ops);
143 static inline char *fsfilt_get_label(struct obd_device *obd,
144 struct super_block *sb)
146 if (obd->obd_fsops->fs_getlabel == NULL)
148 if (obd->obd_fsops->fs_getlabel(sb)[0] == '\0')
151 return obd->obd_fsops->fs_getlabel(sb);
154 static inline int fsfilt_set_label(struct obd_device *obd,
155 struct super_block *sb, char *label)
157 if (obd->obd_fsops->fs_setlabel == NULL)
159 return (obd->obd_fsops->fs_setlabel(sb, label));
162 static inline __u8 *fsfilt_uuid(struct obd_device *obd, struct super_block *sb)
164 if (obd->obd_fsops->fs_uuid == NULL)
167 return obd->obd_fsops->fs_uuid(sb);
170 static inline lvfs_sbdev_type fsfilt_journal_sbdev(struct obd_device *obd,
171 struct super_block *sb)
173 if (obd && obd->obd_fsops && obd->obd_fsops->fs_journal_sbdev)
174 return obd->obd_fsops->fs_journal_sbdev(sb);
175 return (lvfs_sbdev_type)0;
178 #define FSFILT_OP_UNLINK 1
179 #define FSFILT_OP_RMDIR 2
180 #define FSFILT_OP_RENAME 3
181 #define FSFILT_OP_CREATE 4
182 #define FSFILT_OP_MKDIR 5
183 #define FSFILT_OP_SYMLINK 6
184 #define FSFILT_OP_MKNOD 7
185 #define FSFILT_OP_SETATTR 8
186 #define FSFILT_OP_LINK 9
187 #define FSFILT_OP_CANCEL_UNLINK 10
188 #define FSFILT_OP_NOOP 15
189 #define FSFILT_OP_UNLINK_PARTIAL_CHILD 21
190 #define FSFILT_OP_UNLINK_PARTIAL_PARENT 22
191 #define FSFILT_OP_CREATE_PARTIAL_CHILD 23
193 #define __fsfilt_check_slow(obd, start, msg) \
195 if (cfs_time_before(jiffies, start + 15 * CFS_HZ)) \
197 else if (cfs_time_before(jiffies, start + 30 * CFS_HZ)) \
198 CDEBUG(D_VFSTRACE, "%s: slow %s %lus\n", obd->obd_name, \
199 msg, (jiffies-start) / CFS_HZ); \
200 else if (cfs_time_before(jiffies, start + DISK_TIMEOUT * CFS_HZ)) \
201 CWARN("%s: slow %s %lus\n", obd->obd_name, msg, \
202 (jiffies - start) / CFS_HZ); \
204 CERROR("%s: slow %s %lus\n", obd->obd_name, msg, \
205 (jiffies - start) / CFS_HZ); \
208 #define fsfilt_check_slow(obd, start, msg) \
210 __fsfilt_check_slow(obd, start, msg); \
214 static inline void *fsfilt_start_log(struct obd_device *obd,
215 struct inode *inode, int op,
216 struct obd_trans_info *oti, int logs)
218 unsigned long now = jiffies;
219 void *parent_handle = oti ? oti->oti_handle : NULL;
222 handle = obd->obd_fsops->fs_start(inode, op, parent_handle, logs);
223 CDEBUG(D_INFO, "started handle %p (%p)\n", handle, parent_handle);
226 if (parent_handle == NULL) {
227 oti->oti_handle = handle;
228 } else if (handle != parent_handle) {
229 CERROR("mismatch: parent %p, handle %p, oti %p\n",
230 parent_handle, handle, oti);
234 fsfilt_check_slow(obd, now, "journal start");
238 static inline void *fsfilt_start(struct obd_device *obd, struct inode *inode,
239 int op, struct obd_trans_info *oti)
241 return fsfilt_start_log(obd, inode, op, oti, 0);
244 static inline void *fsfilt_brw_start_log(struct obd_device *obd, int objcount,
245 struct fsfilt_objinfo *fso,
246 int niocount, struct niobuf_local *nb,
247 struct obd_trans_info *oti, int logs)
249 unsigned long now = jiffies;
250 void *parent_handle = oti ? oti->oti_handle : NULL;
253 handle = obd->obd_fsops->fs_brw_start(objcount, fso, niocount, nb,
254 parent_handle, logs);
255 CDEBUG(D_INFO, "started handle %p (%p)\n", handle, parent_handle);
258 if (parent_handle == NULL) {
259 oti->oti_handle = handle;
260 } else if (handle != parent_handle) {
261 CERROR("mismatch: parent %p, handle %p, oti %p\n",
262 parent_handle, handle, oti);
266 fsfilt_check_slow(obd, now, "journal start");
271 static inline void *fsfilt_brw_start(struct obd_device *obd, int objcount,
272 struct fsfilt_objinfo *fso, int niocount,
273 struct niobuf_local *nb,
274 struct obd_trans_info *oti)
276 return fsfilt_brw_start_log(obd, objcount, fso, niocount, nb, oti, 0);
279 static inline int fsfilt_extend(struct obd_device *obd, struct inode *inode,
280 unsigned int nblocks, void *handle)
282 unsigned long now = jiffies;
283 int rc = obd->obd_fsops->fs_extend(inode, nblocks, handle);
284 CDEBUG(D_INFO, "extending handle %p with %u blocks\n", handle, nblocks);
286 fsfilt_check_slow(obd, now, "journal extend");
291 static inline int fsfilt_commit(struct obd_device *obd, struct inode *inode,
292 void *handle, int force_sync)
294 unsigned long now = jiffies;
295 int rc = obd->obd_fsops->fs_commit(inode, handle, force_sync);
296 CDEBUG(D_INFO, "committing handle %p\n", handle);
298 fsfilt_check_slow(obd, now, "journal start");
303 static inline int fsfilt_commit_async(struct obd_device *obd,
304 struct inode *inode, void *handle,
307 unsigned long now = jiffies;
308 int rc = obd->obd_fsops->fs_commit_async(inode, handle, wait_handle);
310 CDEBUG(D_INFO, "committing handle %p (async)\n", *wait_handle);
311 fsfilt_check_slow(obd, now, "journal start");
316 static inline int fsfilt_commit_wait(struct obd_device *obd,
317 struct inode *inode, void *handle)
319 unsigned long now = jiffies;
320 int rc = obd->obd_fsops->fs_commit_wait(inode, handle);
321 CDEBUG(D_INFO, "waiting for completion %p\n", handle);
322 fsfilt_check_slow(obd, now, "journal start");
326 static inline int fsfilt_setattr(struct obd_device *obd, struct dentry *dentry,
327 void *handle, struct iattr *iattr,int do_trunc)
329 unsigned long now = jiffies;
331 rc = obd->obd_fsops->fs_setattr(dentry, handle, iattr, do_trunc);
332 fsfilt_check_slow(obd, now, "setattr");
336 static inline int fsfilt_iocontrol(struct obd_device *obd, struct dentry *dentry,
337 unsigned int cmd, unsigned long arg)
339 struct file *dummy_file = NULL;
342 OBD_ALLOC_PTR(dummy_file);
346 dummy_file->f_dentry = dentry;
347 dummy_file->f_vfsmnt = obd->u.obt.obt_vfsmnt;
349 ret = obd->obd_fsops->fs_iocontrol(dentry->d_inode, dummy_file, cmd,
352 OBD_FREE_PTR(dummy_file);
356 static inline int fsfilt_set_md(struct obd_device *obd, struct inode *inode,
357 void *handle, void *md, int size,
360 return obd->obd_fsops->fs_set_md(inode, handle, md, size, name);
363 static inline int fsfilt_get_md(struct obd_device *obd, struct inode *inode,
364 void *md, int size, const char *name)
366 return obd->obd_fsops->fs_get_md(inode, md, size, name);
369 static inline int fsfilt_send_bio(int rw, struct obd_device *obd,
370 struct inode *inode, void *bio)
372 LASSERTF(rw == OBD_BRW_WRITE || rw == OBD_BRW_READ, "%x\n", rw);
374 if (rw == OBD_BRW_READ)
375 return obd->obd_fsops->fs_send_bio(READ, inode, bio);
376 return obd->obd_fsops->fs_send_bio(WRITE, inode, bio);
379 static inline ssize_t fsfilt_readpage(struct obd_device *obd,
380 struct file *file, char *buf,
381 size_t count, loff_t *offset)
383 return obd->obd_fsops->fs_readpage(file, buf, count, offset);
386 static inline int fsfilt_add_journal_cb(struct obd_device *obd, __u64 last_rcvd,
387 void *handle, fsfilt_cb_t cb_func,
390 return obd->obd_fsops->fs_add_journal_cb(obd, last_rcvd,
391 handle, cb_func, cb_data);
394 /* very similar to obd_statfs(), but caller already holds obd_osfs_lock */
395 static inline int fsfilt_statfs(struct obd_device *obd, struct super_block *sb,
400 CDEBUG(D_SUPER, "osfs "LPU64", max_age "LPU64"\n",
401 obd->obd_osfs_age, max_age);
402 if (cfs_time_before_64(obd->obd_osfs_age, max_age)) {
403 rc = obd->obd_fsops->fs_statfs(sb, &obd->obd_osfs);
404 if (rc == 0) /* N.B. statfs can't really fail */
405 obd->obd_osfs_age = cfs_time_current_64();
407 CDEBUG(D_SUPER, "using cached obd_statfs data\n");
413 static inline int fsfilt_sync(struct obd_device *obd, struct super_block *sb)
415 return obd->obd_fsops->fs_sync(sb);
418 static inline int fsfilt_quotacheck(struct obd_device *obd,
419 struct super_block *sb,
420 struct obd_quotactl *oqctl)
422 if (obd->obd_fsops->fs_quotacheck)
423 return obd->obd_fsops->fs_quotacheck(sb, oqctl);
427 static inline int fsfilt_quotactl(struct obd_device *obd,
428 struct super_block *sb,
429 struct obd_quotactl *oqctl)
431 if (obd->obd_fsops->fs_quotactl)
432 return obd->obd_fsops->fs_quotactl(sb, oqctl);
436 static inline int fsfilt_quotainfo(struct obd_device *obd,
437 struct lustre_quota_info *lqi,
440 if (obd->obd_fsops->fs_quotainfo)
441 return obd->obd_fsops->fs_quotainfo(lqi, type, cmd);
445 static inline int fsfilt_qids(struct obd_device *obd, struct file *file,
446 struct inode *inode, int type,
449 if (obd->obd_fsops->fs_qids)
450 return obd->obd_fsops->fs_qids(file, inode, type, list);
454 static inline int fsfilt_dquot(struct obd_device *obd,
455 struct lustre_dquot *dquot, int cmd)
457 if (obd->obd_fsops->fs_dquot)
458 return obd->obd_fsops->fs_dquot(dquot, cmd);
462 static inline int fsfilt_get_mblk(struct obd_device *obd,
463 struct super_block *sb, int *count,
464 struct inode *inode, int frags)
466 if (obd->obd_fsops->fs_get_mblk)
467 return obd->obd_fsops->fs_get_mblk(sb, count, inode, frags);
471 static inline int fsfilt_map_inode_pages(struct obd_device *obd,
473 struct page **page, int pages,
474 unsigned long *blocks, int *created,
475 int create, cfs_semaphore_t *sem)
477 return obd->obd_fsops->fs_map_inode_pages(inode, page, pages, blocks,
478 created, create, sem);
481 static inline int fsfilt_read_record(struct obd_device *obd, struct file *file,
482 void *buf, loff_t size, loff_t *offs)
484 return obd->obd_fsops->fs_read_record(file, buf, size, offs);
487 static inline int fsfilt_write_record(struct obd_device *obd, struct file *file,
488 void *buf, loff_t size, loff_t *offs,
491 return obd->obd_fsops->fs_write_record(file, buf, size,offs,force_sync);
494 static inline int fsfilt_setup(struct obd_device *obd, struct super_block *fs)
496 if (obd->obd_fsops->fs_setup)
497 return obd->obd_fsops->fs_setup(fs);
501 static inline __u64 fsfilt_set_version(struct obd_device *obd,
502 struct inode *inode, __u64 new_version)
504 if (obd->obd_fsops->fs_set_version)
505 return obd->obd_fsops->fs_set_version(inode, new_version);
509 static inline __u64 fsfilt_get_version(struct obd_device *obd,
512 if (obd->obd_fsops->fs_get_version)
513 return obd->obd_fsops->fs_get_version(inode);
517 static inline struct dentry *fsfilt_fid2dentry(struct obd_device *obd,
518 struct vfsmount *mnt,
519 struct fsfilt_fid *fid,
522 if (obd->obd_fsops->fs_fid2dentry)
523 return obd->obd_fsops->fs_fid2dentry(mnt, fid, ignore_gen);
524 return ERR_PTR(-EOPNOTSUPP);
527 #endif /* __KERNEL__ */