lustre/include/linux/lustre_fsfilt.h

   1 /*
   2  * GPL HEADER START
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License version 2 only,
   8  * as published by the Free Software Foundation.
   9  *
  10  * This program is distributed in the hope that it will be useful, but
  11  * WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * General Public License version 2 for more details (a copy is included
  14  * in the LICENSE file that accompanied this code).
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * version 2 along with this program; If not, see
  18  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
  19  *
  20  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  21  * CA 95054 USA or visit www.sun.com if you need additional information or
  22  * have any questions.
  23  *
  24  * GPL HEADER END
  25  */
  26 /*
  27  * Copyright (c) 2002, 2010, Oracle and/or its affiliates. All rights reserved.
  28  * Use is subject to license terms.
  29  *
  30  * Copyright (c) 2012, 2013, Intel Corporation.
  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_operations {
  57         cfs_list_t fs_list;
  58         cfs_module_t *fs_owner;
  59         char   *fs_type;
  60         char   *(* fs_getlabel)(struct super_block *sb);
  61         void   *(* fs_start)(struct inode *inode, int op, void *desc_private,
  62                              int logs);
  63         int     (* fs_commit)(struct inode *inode, void *handle,int force_sync);
  64         int     (* fs_map_inode_pages)(struct inode *inode, struct page **page,
  65                                        int pages, unsigned long *blocks,
  66                                        int create, struct mutex *sem);
  67         int     (* fs_write_record)(struct file *, void *, int size, loff_t *,
  68                                     int force_sync);
  69         int     (* fs_read_record)(struct file *, void *, int size, loff_t *);
  70         int     (* fs_setup)(struct super_block *sb);
  71 };
  72
  73 extern int fsfilt_register_ops(struct fsfilt_operations *fs_ops);
  74 extern void fsfilt_unregister_ops(struct fsfilt_operations *fs_ops);
  75 extern struct fsfilt_operations *fsfilt_get_ops(const char *type);
  76 extern void fsfilt_put_ops(struct fsfilt_operations *fs_ops);
  77
  78 static inline char *fsfilt_get_label(struct obd_device *obd,
  79                                      struct super_block *sb)
  80 {
  81         if (obd->obd_fsops->fs_getlabel == NULL)
  82                 return NULL;
  83         if (obd->obd_fsops->fs_getlabel(sb)[0] == '\0')
  84                 return NULL;
  85
  86         return obd->obd_fsops->fs_getlabel(sb);
  87 }
  88
  89 #define FSFILT_OP_UNLINK                1
  90 #define FSFILT_OP_CANCEL_UNLINK         10
  91
  92 #define __fsfilt_check_slow(obd, start, msg)                              \
  93 do {                                                                      \
  94         if (cfs_time_before(jiffies, start + 15 * CFS_HZ))                \
  95                 break;                                                    \
  96         else if (cfs_time_before(jiffies, start + 30 * CFS_HZ))           \
  97                 CDEBUG(D_VFSTRACE, "%s: slow %s %lus\n", obd->obd_name,   \
  98                        msg, (jiffies-start) / CFS_HZ);                    \
  99         else if (cfs_time_before(jiffies, start + DISK_TIMEOUT * CFS_HZ)) \
 100                 CWARN("%s: slow %s %lus\n", obd->obd_name, msg,           \
 101                       (jiffies - start) / CFS_HZ);                        \
 102         else                                                              \
 103                 CERROR("%s: slow %s %lus\n", obd->obd_name, msg,          \
 104                        (jiffies - start) / CFS_HZ);                       \
 105 } while (0)
 106
 107 #define fsfilt_check_slow(obd, start, msg)              \
 108 do {                                                    \
 109         __fsfilt_check_slow(obd, start, msg);           \
 110         start = jiffies;                                \
 111 } while (0)
 112
 113 static inline void *fsfilt_start_log(struct obd_device *obd,
 114                                      struct inode *inode, int op,
 115                                      struct obd_trans_info *oti, int logs)
 116 {
 117         unsigned long now = jiffies;
 118         void *parent_handle = oti ? oti->oti_handle : NULL;
 119         void *handle;
 120
 121         handle = obd->obd_fsops->fs_start(inode, op, parent_handle, logs);
 122         CDEBUG(D_INFO, "started handle %p (%p)\n", handle, parent_handle);
 123
 124         if (oti != NULL) {
 125                 if (parent_handle == NULL) {
 126                         oti->oti_handle = handle;
 127                 } else if (handle != parent_handle) {
 128                         CERROR("mismatch: parent %p, handle %p, oti %p\n",
 129                                parent_handle, handle, oti);
 130                         LBUG();
 131                 }
 132         }
 133         fsfilt_check_slow(obd, now, "journal start");
 134         return handle;
 135 }
 136
 137 static inline int fsfilt_commit(struct obd_device *obd, struct inode *inode,
 138                                 void *handle, int force_sync)
 139 {
 140         unsigned long now = jiffies;
 141         int rc = obd->obd_fsops->fs_commit(inode, handle, force_sync);
 142         CDEBUG(D_INFO, "committing handle %p\n", handle);
 143
 144         fsfilt_check_slow(obd, now, "journal start");
 145
 146         return rc;
 147 }
 148
 149 static inline int fsfilt_read_record(struct obd_device *obd, struct file *file,
 150                                      void *buf, loff_t size, loff_t *offs)
 151 {
 152         return obd->obd_fsops->fs_read_record(file, buf, size, offs);
 153 }
 154
 155 static inline int fsfilt_write_record(struct obd_device *obd, struct file *file,
 156                                       void *buf, loff_t size, loff_t *offs,
 157                                       int force_sync)
 158 {
 159         return obd->obd_fsops->fs_write_record(file, buf, size,offs,force_sync);
 160 }
 161
 162 static inline int fsfilt_setup(struct obd_device *obd, struct super_block *fs)
 163 {
 164         if (obd->obd_fsops->fs_setup)
 165                 return obd->obd_fsops->fs_setup(fs);
 166         return 0;
 167 }
 168
 169
 170
 171 #endif /* __KERNEL__ */
 172
 173 #endif