lustre/include/linux/lustre_fsfilt.h

   1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
   2  * vim:expandtab:shiftwidth=8:tabstop=8:
   3  *
   4  * GPL HEADER START
   5  *
   6  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   7  *
   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.
  11  *
  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).
  17  *
  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
  21  *
  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
  24  * have any questions.
  25  *
  26  * GPL HEADER END
  27  */
  28 /*
  29  * Copyright  2008 Sun Microsystems, Inc. All rights reserved
  30  * Use is subject to license terms.
  31  */
  32 /*
  33  * This file is part of Lustre, http://www.lustre.org/
  34  * Lustre is a trademark of Sun Microsystems, Inc.
  35  *
  36  * lustre/include/linux/lustre_fsfilt.h
  37  *
  38  * Filesystem interface helper.
  39  */
  40
  41 #ifndef _LINUX_LUSTRE_FSFILT_H
  42 #define _LINUX_LUSTRE_FSFILT_H
  43
  44 #ifndef _LUSTRE_FSFILT_H
  45 #error Do not #include this file directly. #include <lustre_fsfilt.h> instead
  46 #endif
  47
  48 #ifdef __KERNEL__
  49
  50 #include <obd.h>
  51 #include <obd_class.h>
  52
  53 typedef void (*fsfilt_cb_t)(struct obd_device *obd, __u64 last_rcvd,
  54                             void *data, int error);
  55
  56 struct fsfilt_objinfo {
  57         struct dentry *fso_dentry;
  58         int fso_bufcnt;
  59 };
  60
  61 struct lustre_dquot;
  62 struct fsfilt_operations {
  63         struct list_head fs_list;
  64         struct module *fs_owner;
  65         char   *fs_type;
  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,
  70                              int logs);
  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,
  77                                         void **wait_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,
  86                               const char *name);
  87         /*
  88          * this method is needed to make IO operation fsfilt nature depend.
  89          *
  90          * This operation maybe synchronous or asynchronous.
  91          *
  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.
  95          *
  96          */
  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,
  99                                 loff_t *offset);
 100         int     (* fs_add_journal_cb)(struct obd_device *obd, __u64 last_rcvd,
 101                                       void *handle, fsfilt_cb_t cb_func,
 102                                       void *cb_data);
 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 *,
 110                                     int force_sync);
 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,
 121                                  int cmd);
 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);
 128 };
 129
 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);
 134
 135 static inline char *fsfilt_get_label(struct obd_device *obd,
 136                                      struct super_block *sb)
 137 {
 138         if (obd->obd_fsops->fs_getlabel == NULL)
 139                 return NULL;
 140         if (obd->obd_fsops->fs_getlabel(sb)[0] == '\0')
 141                 return NULL;
 142
 143         return obd->obd_fsops->fs_getlabel(sb);
 144 }
 145
 146 static inline int fsfilt_set_label(struct obd_device *obd,
 147                                    struct super_block *sb, char *label)
 148 {
 149         if (obd->obd_fsops->fs_setlabel == NULL)
 150                 return -ENOSYS;
 151         return (obd->obd_fsops->fs_setlabel(sb, label));
 152 }
 153
 154 static inline __u8 *fsfilt_uuid(struct obd_device *obd, struct super_block *sb)
 155 {
 156         if (obd->obd_fsops->fs_uuid == NULL)
 157                 return NULL;
 158
 159         return obd->obd_fsops->fs_uuid(sb);
 160 }
 161
 162 static inline lvfs_sbdev_type fsfilt_journal_sbdev(struct obd_device *obd,
 163                                                    struct super_block *sb)
 164 {
 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;
 168 }
 169
 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
 185
 186 #define __fsfilt_check_slow(obd, start, msg)                            \
 187 do {                                                                    \
 188         if (time_before(jiffies, start + 15 * HZ))                      \
 189                 break;                                                  \
 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);                          \
 196         else                                                            \
 197                 CERROR("%s: slow %s %lus\n", obd->obd_name, msg,        \
 198                        (jiffies - start) / HZ);                         \
 199 } while (0)
 200
 201 #define fsfilt_check_slow(obd, start, msg)              \
 202 do {                                                    \
 203         __fsfilt_check_slow(obd, start, msg);           \
 204         start = jiffies;                                \
 205 } while (0)
 206
 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)
 210 {
 211         unsigned long now = jiffies;
 212         void *parent_handle = oti ? oti->oti_handle : NULL;
 213         void *handle;
 214
 215         if (obd->obd_fail)
 216                 return ERR_PTR(-EROFS);
 217
 218         handle = obd->obd_fsops->fs_start(inode, op, parent_handle, logs);
 219         CDEBUG(D_INFO, "started handle %p (%p)\n", handle, parent_handle);
 220
 221         if (oti != NULL) {
 222                 if (parent_handle == NULL) {
 223                         oti->oti_handle = handle;
 224                 } else if (handle != parent_handle) {
 225                         CERROR("mismatch: parent %p, handle %p, oti %p\n",
 226                                parent_handle, handle, oti);
 227                         LBUG();
 228                 }
 229         }
 230         fsfilt_check_slow(obd, now, "journal start");
 231         return handle;
 232 }
 233
 234 static inline void *fsfilt_start(struct obd_device *obd, struct inode *inode,
 235                                  int op, struct obd_trans_info *oti)
 236 {
 237         return fsfilt_start_log(obd, inode, op, oti, 0);
 238 }
 239
 240 static inline void *fsfilt_brw_start_log(struct obd_device *obd, int objcount,
 241                                          struct fsfilt_objinfo *fso,
 242                                          int niocount, struct niobuf_local *nb,
 243                                          struct obd_trans_info *oti, int logs)
 244 {
 245         unsigned long now = jiffies;
 246         void *parent_handle = oti ? oti->oti_handle : NULL;
 247         void *handle;
 248
 249         if (obd->obd_fail)
 250                 return ERR_PTR(-EROFS);
 251
 252         handle = obd->obd_fsops->fs_brw_start(objcount, fso, niocount, nb,
 253                                               parent_handle, logs);
 254         CDEBUG(D_INFO, "started handle %p (%p)\n", handle, parent_handle);
 255
 256         if (oti != NULL) {
 257                 if (parent_handle == NULL) {
 258                         oti->oti_handle = handle;
 259                 } else if (handle != parent_handle) {
 260                         CERROR("mismatch: parent %p, handle %p, oti %p\n",
 261                                parent_handle, handle, oti);
 262                         LBUG();
 263                 }
 264         }
 265         fsfilt_check_slow(obd, now, "journal start");
 266
 267         return handle;
 268 }
 269
 270 static inline void *fsfilt_brw_start(struct obd_device *obd, int objcount,
 271                                      struct fsfilt_objinfo *fso, int niocount,
 272                                      struct niobuf_local *nb,
 273                                      struct obd_trans_info *oti)
 274 {
 275         return fsfilt_brw_start_log(obd, objcount, fso, niocount, nb, oti, 0);
 276 }
 277
 278 static inline int fsfilt_extend(struct obd_device *obd, struct inode *inode,
 279                                 unsigned int nblocks, void *handle)
 280 {
 281         unsigned long now = jiffies;
 282         int rc = obd->obd_fsops->fs_extend(inode, nblocks, handle);
 283         CDEBUG(D_INFO, "extending handle %p with %u blocks\n", handle, nblocks);
 284
 285         fsfilt_check_slow(obd, now, "journal extend");
 286
 287         return rc;
 288 }
 289
 290 static inline int fsfilt_commit(struct obd_device *obd, struct inode *inode,
 291                                 void *handle, int force_sync)
 292 {
 293         unsigned long now = jiffies;
 294         int rc = obd->obd_fsops->fs_commit(inode, handle, force_sync);
 295         CDEBUG(D_INFO, "committing handle %p\n", handle);
 296
 297         fsfilt_check_slow(obd, now, "journal start");
 298
 299         return rc;
 300 }
 301
 302 static inline int fsfilt_commit_async(struct obd_device *obd,
 303                                       struct inode *inode, void *handle,
 304                                       void **wait_handle)
 305 {
 306         unsigned long now = jiffies;
 307         int rc = obd->obd_fsops->fs_commit_async(inode, handle, wait_handle);
 308
 309         CDEBUG(D_INFO, "committing handle %p (async)\n", *wait_handle);
 310         fsfilt_check_slow(obd, now, "journal start");
 311
 312         return rc;
 313 }
 314
 315 static inline int fsfilt_commit_wait(struct obd_device *obd,
 316                                      struct inode *inode, void *handle)
 317 {
 318         unsigned long now = jiffies;
 319         int rc = obd->obd_fsops->fs_commit_wait(inode, handle);
 320         CDEBUG(D_INFO, "waiting for completion %p\n", handle);
 321         fsfilt_check_slow(obd, now, "journal start");
 322         return rc;
 323 }
 324
 325 static inline int fsfilt_setattr(struct obd_device *obd, struct dentry *dentry,
 326                                  void *handle, struct iattr *iattr,int do_trunc)
 327 {
 328         unsigned long now = jiffies;
 329         int rc;
 330         rc = obd->obd_fsops->fs_setattr(dentry, handle, iattr, do_trunc);
 331         fsfilt_check_slow(obd, now, "setattr");
 332         return rc;
 333 }
 334
 335 static inline int fsfilt_iocontrol(struct obd_device *obd, struct inode *inode,
 336                                    struct file *file, unsigned int cmd,
 337                                    unsigned long arg)
 338 {
 339         return obd->obd_fsops->fs_iocontrol(inode, file, cmd, arg);
 340 }
 341
 342 static inline int fsfilt_set_md(struct obd_device *obd, struct inode *inode,
 343                                 void *handle, void *md, int size,
 344                                 const char *name)
 345 {
 346         return obd->obd_fsops->fs_set_md(inode, handle, md, size, name);
 347 }
 348
 349 static inline int fsfilt_get_md(struct obd_device *obd, struct inode *inode,
 350                                 void *md, int size, const char *name)
 351 {
 352         return obd->obd_fsops->fs_get_md(inode, md, size, name);
 353 }
 354
 355 static inline int fsfilt_send_bio(int rw, struct obd_device *obd,
 356                                   struct inode *inode, void *bio)
 357 {
 358         LASSERTF(rw == OBD_BRW_WRITE || rw == OBD_BRW_READ, "%x\n", rw);
 359
 360         if (rw == OBD_BRW_READ)
 361                 return obd->obd_fsops->fs_send_bio(READ, inode, bio);
 362         return obd->obd_fsops->fs_send_bio(WRITE, inode, bio);
 363 }
 364
 365 static inline ssize_t fsfilt_readpage(struct obd_device *obd,
 366                                       struct file *file, char *buf,
 367                                       size_t count, loff_t *offset)
 368 {
 369         return obd->obd_fsops->fs_readpage(file, buf, count, offset);
 370 }
 371
 372 static inline int fsfilt_add_journal_cb(struct obd_device *obd, __u64 last_rcvd,
 373                                         void *handle, fsfilt_cb_t cb_func,
 374                                         void *cb_data)
 375 {
 376         return obd->obd_fsops->fs_add_journal_cb(obd, last_rcvd,
 377                                                  handle, cb_func, cb_data);
 378 }
 379
 380 /* very similar to obd_statfs(), but caller already holds obd_osfs_lock */
 381 static inline int fsfilt_statfs(struct obd_device *obd, struct super_block *sb,
 382                                 __u64 max_age)
 383 {
 384         int rc = 0;
 385
 386         CDEBUG(D_SUPER, "osfs "LPU64", max_age "LPU64"\n",
 387                 obd->obd_osfs_age, max_age);
 388         if (cfs_time_before_64(obd->obd_osfs_age, max_age)) {
 389                 rc = obd->obd_fsops->fs_statfs(sb, &obd->obd_osfs);
 390                 if (rc == 0) /* N.B. statfs can't really fail */
 391                         obd->obd_osfs_age = cfs_time_current_64();
 392         } else {
 393                 CDEBUG(D_SUPER, "using cached obd_statfs data\n");
 394         }
 395
 396         return rc;
 397 }
 398
 399 static inline int fsfilt_sync(struct obd_device *obd, struct super_block *sb)
 400 {
 401         return obd->obd_fsops->fs_sync(sb);
 402 }
 403
 404 static inline int fsfilt_quotacheck(struct obd_device *obd,
 405                                     struct super_block *sb,
 406                                     struct obd_quotactl *oqctl)
 407 {
 408         if (obd->obd_fsops->fs_quotacheck)
 409                 return obd->obd_fsops->fs_quotacheck(sb, oqctl);
 410         return -ENOTSUPP;
 411 }
 412
 413 static inline int fsfilt_quotactl(struct obd_device *obd,
 414                                   struct super_block *sb,
 415                                   struct obd_quotactl *oqctl)
 416 {
 417         if (obd->obd_fsops->fs_quotactl)
 418                 return obd->obd_fsops->fs_quotactl(sb, oqctl);
 419         return -ENOTSUPP;
 420 }
 421
 422 static inline int fsfilt_quotainfo(struct obd_device *obd,
 423                                    struct lustre_quota_info *lqi,
 424                                    int type, int cmd)
 425 {
 426         if (obd->obd_fsops->fs_quotainfo)
 427                 return obd->obd_fsops->fs_quotainfo(lqi, type, cmd);
 428         return -ENOTSUPP;
 429 }
 430
 431 static inline int fsfilt_qids(struct obd_device *obd, struct file *file,
 432                               struct inode *inode, int type,
 433                               struct list_head *list)
 434 {
 435         if (obd->obd_fsops->fs_qids)
 436                 return obd->obd_fsops->fs_qids(file, inode, type, list);
 437         return -ENOTSUPP;
 438 }
 439
 440 static inline int fsfilt_dquot(struct obd_device *obd,
 441                                struct lustre_dquot *dquot, int cmd)
 442 {
 443         if (obd->obd_fsops->fs_dquot)
 444                 return obd->obd_fsops->fs_dquot(dquot, cmd);
 445         return -ENOTSUPP;
 446 }
 447
 448 static inline int fsfilt_get_mblk(struct obd_device *obd,
 449                                   struct super_block *sb, int *count,
 450                                   struct inode *inode, int frags)
 451 {
 452         if (obd->obd_fsops->fs_get_mblk)
 453                 return obd->obd_fsops->fs_get_mblk(sb, count, inode, frags);
 454         return -ENOTSUPP;
 455 }
 456
 457 static inline int fsfilt_map_inode_pages(struct obd_device *obd,
 458                                          struct inode *inode,
 459                                          struct page **page, int pages,
 460                                          unsigned long *blocks, int *created,
 461                                          int create, struct semaphore *sem)
 462 {
 463         return obd->obd_fsops->fs_map_inode_pages(inode, page, pages, blocks,
 464                                                   created, create, sem);
 465 }
 466
 467 static inline int fsfilt_read_record(struct obd_device *obd, struct file *file,
 468                                      void *buf, loff_t size, loff_t *offs)
 469 {
 470         return obd->obd_fsops->fs_read_record(file, buf, size, offs);
 471 }
 472
 473 static inline int fsfilt_write_record(struct obd_device *obd, struct file *file,
 474                                       void *buf, loff_t size, loff_t *offs,
 475                                       int force_sync)
 476 {
 477         return obd->obd_fsops->fs_write_record(file, buf, size,offs,force_sync);
 478 }
 479
 480 static inline int fsfilt_setup(struct obd_device *obd, struct super_block *fs)
 481 {
 482         if (obd->obd_fsops->fs_setup)
 483                 return obd->obd_fsops->fs_setup(fs);
 484         return 0;
 485 }
 486
 487 static inline __u64 fsfilt_set_version(struct obd_device *obd,
 488                                       struct inode *inode, __u64 new_version)
 489 {
 490         if (obd->obd_fsops->fs_set_version)
 491                 return obd->obd_fsops->fs_set_version(inode, new_version);
 492         return -EOPNOTSUPP;
 493 }
 494
 495 static inline __u64 fsfilt_get_version(struct obd_device *obd,
 496                                        struct inode *inode)
 497 {
 498         if (obd->obd_fsops->fs_set_version)
 499                 return obd->obd_fsops->fs_get_version(inode);
 500         return -EOPNOTSUPP;
 501 }
 502
 503 #endif /* __KERNEL__ */
 504
 505 #endif