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 [sun.com URL with a
  20  * copy of GPLv2].
  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 #define XATTR_LUSTRE_MDS_LOV_EA         "lov"
  62
  63 struct lustre_dquot;
  64 struct fsfilt_operations {
  65         struct list_head fs_list;
  66         struct module *fs_owner;
  67         char   *fs_type;
  68         char   *(* fs_getlabel)(struct super_block *sb);
  69         int     (* fs_setlabel)(struct super_block *sb, char *label);
  70         char   *(* fs_uuid)(struct super_block *sb);
  71         void   *(* fs_start)(struct inode *inode, int op, void *desc_private,
  72                              int logs);
  73         void   *(* fs_brw_start)(int objcount, struct fsfilt_objinfo *fso,
  74                                  int niocount, struct niobuf_local *nb,
  75                                  void *desc_private, int logs);
  76         int     (* fs_extend)(struct inode *inode, unsigned nblocks, void *h);
  77         int     (* fs_commit)(struct inode *inode, void *handle,int force_sync);
  78         int     (* fs_commit_async)(struct inode *inode, void *handle,
  79                                         void **wait_handle);
  80         int     (* fs_commit_wait)(struct inode *inode, void *handle);
  81         int     (* fs_setattr)(struct dentry *dentry, void *handle,
  82                                struct iattr *iattr, int do_trunc);
  83         int     (* fs_iocontrol)(struct inode *inode, struct file *file,
  84                                  unsigned int cmd, unsigned long arg);
  85         int     (* fs_set_md)(struct inode *inode, void *handle, void *md,
  86                               int size, const char *name);
  87         int     (* fs_get_md)(struct inode *inode, void *md, int size,
  88                               const char *name);
  89         /*
  90          * this method is needed to make IO operation fsfilt nature depend.
  91          *
  92          * This operation maybe synchronous or asynchronous.
  93          *
  94          * Return convention: positive number of bytes written (synchronously)
  95          * on success. Negative errno value on failure. Zero if asynchronous
  96          * IO was submitted successfully.
  97          *
  98          */
  99         int     (* fs_send_bio)(int rw, struct inode *inode,struct kiobuf *bio);
 100         ssize_t (* fs_readpage)(struct file *file, char *buf, size_t count,
 101                                 loff_t *offset);
 102         int     (* fs_add_journal_cb)(struct obd_device *obd, __u64 last_rcvd,
 103                                       void *handle, fsfilt_cb_t cb_func,
 104                                       void *cb_data);
 105         int     (* fs_statfs)(struct super_block *sb, struct obd_statfs *osfs);
 106         int     (* fs_sync)(struct super_block *sb);
 107         int     (* fs_map_inode_pages)(struct inode *inode, struct page **page,
 108                                        int pages, unsigned long *blocks,
 109                                        int *created, int create,
 110                                        struct semaphore *sem);
 111         int     (* fs_write_record)(struct file *, void *, int size, loff_t *,
 112                                     int force_sync);
 113         int     (* fs_read_record)(struct file *, void *, int size, loff_t *);
 114         int     (* fs_setup)(struct super_block *sb);
 115         int     (* fs_get_op_len)(int, struct fsfilt_objinfo *, int);
 116         int     (* fs_quotactl)(struct super_block *sb,
 117                                 struct obd_quotactl *oqctl);
 118         int     (* fs_quotacheck)(struct super_block *sb,
 119                                   struct obd_quotactl *oqctl);
 120         __u64   (* fs_get_version) (struct inode *inode);
 121         __u64   (* fs_set_version) (struct inode *inode, __u64 new_version);
 122         int     (* fs_quotainfo)(struct lustre_quota_info *lqi, int type,
 123                                  int cmd);
 124         int     (* fs_qids)(struct file *file, struct inode *inode, int type,
 125                             struct list_head *list);
 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
 183 #define __fsfilt_check_slow(obd, start, msg)                            \
 184 do {                                                                    \
 185         if (time_before(jiffies, start + 15 * HZ))                      \
 186                 break;                                                  \
 187         else if (time_before(jiffies, start + 30 * HZ))                 \
 188                 CDEBUG(D_VFSTRACE, "%s: slow %s %lus\n", obd->obd_name, \
 189                        msg, (jiffies-start) / HZ);                      \
 190         else if (time_before(jiffies, start + DISK_TIMEOUT * HZ))       \
 191                 CWARN("%s: slow %s %lus\n", obd->obd_name, msg,         \
 192                       (jiffies - start) / HZ);                          \
 193         else                                                            \
 194                 CERROR("%s: slow %s %lus\n", obd->obd_name, msg,        \
 195                        (jiffies - start) / HZ);                         \
 196 } while (0)
 197
 198 #define fsfilt_check_slow(obd, start, msg)              \
 199 do {                                                    \
 200         __fsfilt_check_slow(obd, start, msg);           \
 201         start = jiffies;                                \
 202 } while (0)
 203
 204 static inline void *fsfilt_start_log(struct obd_device *obd,
 205                                      struct inode *inode, int op,
 206                                      struct obd_trans_info *oti, int logs)
 207 {
 208         unsigned long now = jiffies;
 209         void *parent_handle = oti ? oti->oti_handle : NULL;
 210         void *handle;
 211
 212         if (obd->obd_fail)
 213                 return ERR_PTR(-EROFS);
 214
 215         handle = obd->obd_fsops->fs_start(inode, op, parent_handle, logs);
 216         CDEBUG(D_INFO, "started handle %p (%p)\n", handle, parent_handle);
 217
 218         if (oti != NULL) {
 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);
 224                         LBUG();
 225                 }
 226         }
 227         fsfilt_check_slow(obd, now, "journal start");
 228         return handle;
 229 }
 230
 231 static inline void *fsfilt_start(struct obd_device *obd, struct inode *inode,
 232                                  int op, struct obd_trans_info *oti)
 233 {
 234         return fsfilt_start_log(obd, inode, op, oti, 0);
 235 }
 236
 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)
 241 {
 242         unsigned long now = jiffies;
 243         void *parent_handle = oti ? oti->oti_handle : NULL;
 244         void *handle;
 245
 246         if (obd->obd_fail)
 247                 return ERR_PTR(-EROFS);
 248
 249         handle = obd->obd_fsops->fs_brw_start(objcount, fso, niocount, nb,
 250                                               parent_handle, logs);
 251         CDEBUG(D_INFO, "started handle %p (%p)\n", handle, parent_handle);
 252
 253         if (oti != NULL) {
 254                 if (parent_handle == NULL) {
 255                         oti->oti_handle = handle;
 256                 } else if (handle != parent_handle) {
 257                         CERROR("mismatch: parent %p, handle %p, oti %p\n",
 258                                parent_handle, handle, oti);
 259                         LBUG();
 260                 }
 261         }
 262         fsfilt_check_slow(obd, now, "journal start");
 263
 264         return handle;
 265 }
 266
 267 static inline void *fsfilt_brw_start(struct obd_device *obd, int objcount,
 268                                      struct fsfilt_objinfo *fso, int niocount,
 269                                      struct niobuf_local *nb,
 270                                      struct obd_trans_info *oti)
 271 {
 272         return fsfilt_brw_start_log(obd, objcount, fso, niocount, nb, oti, 0);
 273 }
 274
 275 static inline int fsfilt_extend(struct obd_device *obd, struct inode *inode,
 276                                 unsigned int nblocks, void *handle)
 277 {
 278         unsigned long now = jiffies;
 279         int rc = obd->obd_fsops->fs_extend(inode, nblocks, handle);
 280         CDEBUG(D_INFO, "extending handle %p with %u blocks\n", handle, nblocks);
 281
 282         fsfilt_check_slow(obd, now, "journal extend");
 283
 284         return rc;
 285 }
 286
 287 static inline int fsfilt_commit(struct obd_device *obd, struct inode *inode,
 288                                 void *handle, int force_sync)
 289 {
 290         unsigned long now = jiffies;
 291         int rc = obd->obd_fsops->fs_commit(inode, handle, force_sync);
 292         CDEBUG(D_INFO, "committing handle %p\n", handle);
 293
 294         fsfilt_check_slow(obd, now, "journal start");
 295
 296         return rc;
 297 }
 298
 299 static inline int fsfilt_commit_async(struct obd_device *obd,
 300                                       struct inode *inode, void *handle,
 301                                       void **wait_handle)
 302 {
 303         unsigned long now = jiffies;
 304         int rc = obd->obd_fsops->fs_commit_async(inode, handle, wait_handle);
 305
 306         CDEBUG(D_INFO, "committing handle %p (async)\n", *wait_handle);
 307         fsfilt_check_slow(obd, now, "journal start");
 308
 309         return rc;
 310 }
 311
 312 static inline int fsfilt_commit_wait(struct obd_device *obd,
 313                                      struct inode *inode, void *handle)
 314 {
 315         unsigned long now = jiffies;
 316         int rc = obd->obd_fsops->fs_commit_wait(inode, handle);
 317         CDEBUG(D_INFO, "waiting for completion %p\n", handle);
 318         fsfilt_check_slow(obd, now, "journal start");
 319         return rc;
 320 }
 321
 322 static inline int fsfilt_setattr(struct obd_device *obd, struct dentry *dentry,
 323                                  void *handle, struct iattr *iattr,int do_trunc)
 324 {
 325         unsigned long now = jiffies;
 326         int rc;
 327         rc = obd->obd_fsops->fs_setattr(dentry, handle, iattr, do_trunc);
 328         fsfilt_check_slow(obd, now, "setattr");
 329         return rc;
 330 }
 331
 332 static inline int fsfilt_iocontrol(struct obd_device *obd, struct inode *inode,
 333                                    struct file *file, unsigned int cmd,
 334                                    unsigned long arg)
 335 {
 336         return obd->obd_fsops->fs_iocontrol(inode, file, cmd, arg);
 337 }
 338
 339 static inline int fsfilt_set_md(struct obd_device *obd, struct inode *inode,
 340                                 void *handle, void *md, int size,
 341                                 const char *name)
 342 {
 343         return obd->obd_fsops->fs_set_md(inode, handle, md, size, name);
 344 }
 345
 346 static inline int fsfilt_get_md(struct obd_device *obd, struct inode *inode,
 347                                 void *md, int size, const char *name)
 348 {
 349         return obd->obd_fsops->fs_get_md(inode, md, size, name);
 350 }
 351
 352 static inline int fsfilt_send_bio(int rw, struct obd_device *obd,
 353                                   struct inode *inode, void *bio)
 354 {
 355         LASSERTF(rw == OBD_BRW_WRITE || rw == OBD_BRW_READ, "%x\n", rw);
 356
 357         if (rw == OBD_BRW_READ)
 358                 return obd->obd_fsops->fs_send_bio(READ, inode, bio);
 359         return obd->obd_fsops->fs_send_bio(WRITE, inode, bio);
 360 }
 361
 362 static inline ssize_t fsfilt_readpage(struct obd_device *obd,
 363                                       struct file *file, char *buf,
 364                                       size_t count, loff_t *offset)
 365 {
 366         return obd->obd_fsops->fs_readpage(file, buf, count, offset);
 367 }
 368
 369 static inline int fsfilt_add_journal_cb(struct obd_device *obd, __u64 last_rcvd,
 370                                         void *handle, fsfilt_cb_t cb_func,
 371                                         void *cb_data)
 372 {
 373         return obd->obd_fsops->fs_add_journal_cb(obd, last_rcvd,
 374                                                  handle, cb_func, cb_data);
 375 }
 376
 377 /* very similar to obd_statfs(), but caller already holds obd_osfs_lock */
 378 static inline int fsfilt_statfs(struct obd_device *obd, struct super_block *sb,
 379                                 __u64 max_age)
 380 {
 381         int rc = 0;
 382
 383         CDEBUG(D_SUPER, "osfs "LPU64", max_age "LPU64"\n",
 384                 obd->obd_osfs_age, max_age);
 385         if (cfs_time_before_64(obd->obd_osfs_age, max_age)) {
 386                 rc = obd->obd_fsops->fs_statfs(sb, &obd->obd_osfs);
 387                 if (rc == 0) /* N.B. statfs can't really fail */
 388                         obd->obd_osfs_age = cfs_time_current_64();
 389         } else {
 390                 CDEBUG(D_SUPER, "using cached obd_statfs data\n");
 391         }
 392
 393         return rc;
 394 }
 395
 396 static inline int fsfilt_sync(struct obd_device *obd, struct super_block *sb)
 397 {
 398         return obd->obd_fsops->fs_sync(sb);
 399 }
 400
 401 static inline int fsfilt_quotacheck(struct obd_device *obd,
 402                                     struct super_block *sb,
 403                                     struct obd_quotactl *oqctl)
 404 {
 405         if (obd->obd_fsops->fs_quotacheck)
 406                 return obd->obd_fsops->fs_quotacheck(sb, oqctl);
 407         return -ENOTSUPP;
 408 }
 409
 410 static inline int fsfilt_quotactl(struct obd_device *obd,
 411                                   struct super_block *sb,
 412                                   struct obd_quotactl *oqctl)
 413 {
 414         if (obd->obd_fsops->fs_quotactl)
 415                 return obd->obd_fsops->fs_quotactl(sb, oqctl);
 416         return -ENOTSUPP;
 417 }
 418
 419 static inline int fsfilt_quotainfo(struct obd_device *obd,
 420                                    struct lustre_quota_info *lqi,
 421                                    int type, int cmd)
 422 {
 423         if (obd->obd_fsops->fs_quotainfo)
 424                 return obd->obd_fsops->fs_quotainfo(lqi, type, cmd);
 425         return -ENOTSUPP;
 426 }
 427
 428 static inline int fsfilt_qids(struct obd_device *obd, struct file *file,
 429                               struct inode *inode, int type,
 430                               struct list_head *list)
 431 {
 432         if (obd->obd_fsops->fs_qids)
 433                 return obd->obd_fsops->fs_qids(file, inode, type, list);
 434         return -ENOTSUPP;
 435 }
 436
 437 static inline int fsfilt_dquot(struct obd_device *obd,
 438                                struct lustre_dquot *dquot, int cmd)
 439 {
 440         if (obd->obd_fsops->fs_dquot)
 441                 return obd->obd_fsops->fs_dquot(dquot, cmd);
 442         return -ENOTSUPP;
 443 }
 444
 445 static inline int fsfilt_map_inode_pages(struct obd_device *obd,
 446                                          struct inode *inode,
 447                                          struct page **page, int pages,
 448                                          unsigned long *blocks, int *created,
 449                                          int create, struct semaphore *sem)
 450 {
 451         return obd->obd_fsops->fs_map_inode_pages(inode, page, pages, blocks,
 452                                                   created, create, sem);
 453 }
 454
 455 static inline int fsfilt_read_record(struct obd_device *obd, struct file *file,
 456                                      void *buf, loff_t size, loff_t *offs)
 457 {
 458         return obd->obd_fsops->fs_read_record(file, buf, size, offs);
 459 }
 460
 461 static inline int fsfilt_write_record(struct obd_device *obd, struct file *file,
 462                                       void *buf, loff_t size, loff_t *offs,
 463                                       int force_sync)
 464 {
 465         return obd->obd_fsops->fs_write_record(file, buf, size,offs,force_sync);
 466 }
 467
 468 static inline int fsfilt_setup(struct obd_device *obd, struct super_block *fs)
 469 {
 470         if (obd->obd_fsops->fs_setup)
 471                 return obd->obd_fsops->fs_setup(fs);
 472         return 0;
 473 }
 474
 475 static inline __u64 fsfilt_set_version(struct obd_device *obd,
 476                                       struct inode *inode, __u64 new_version)
 477 {
 478         if (obd->obd_fsops->fs_set_version)
 479                 return obd->obd_fsops->fs_set_version(inode, new_version);
 480         return -EOPNOTSUPP;
 481 }
 482
 483 static inline __u64 fsfilt_get_version(struct obd_device *obd,
 484                                        struct inode *inode)
 485 {
 486         if (obd->obd_fsops->fs_set_version)
 487                 return obd->obd_fsops->fs_get_version(inode);
 488         return -EOPNOTSUPP;
 489 }
 490
 491 #endif /* __KERNEL__ */
 492
 493 #endif