lustre/obdfilter/filter_internal.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 (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
  30  * Use is subject to license terms.
  31  *
  32  * Copyright (c) 2011, Whamcloud, Inc.
  33  */
  34 /*
  35  * This file is part of Lustre, http://www.lustre.org/
  36  * Lustre is a trademark of Sun Microsystems, Inc.
  37  */
  38
  39 #ifndef _FILTER_INTERNAL_H
  40 #define _FILTER_INTERNAL_H
  41
  42 #ifdef __KERNEL__
  43 # include <linux/spinlock.h>
  44 #endif
  45 #include <lustre_handles.h>
  46 #include <lustre_debug.h>
  47 #include <obd.h>
  48 #include <obd_class.h>
  49 #include <lprocfs_status.h>
  50
  51 #define FILTER_LAYOUT_VERSION "2"
  52
  53 #define FILTER_INIT_OBJID 0
  54
  55 #define FILTER_SUBDIR_COUNT 32 /* set to zero for no subdirs */
  56 #define FILTER_GROUPS        3 /* must be at least 3; not dynamic yet */
  57
  58 #define FILTER_ROCOMPAT_SUPP (0)
  59
  60 #define FILTER_INCOMPAT_SUPP (OBD_INCOMPAT_GROUPS | OBD_INCOMPAT_OST | \
  61                               OBD_INCOMPAT_COMMON_LR)
  62
  63 #define FILTER_GRANT_CHUNK (2ULL * PTLRPC_MAX_BRW_SIZE)
  64 #define FILTER_GRANT_SHRINK_LIMIT (16ULL * FILTER_GRANT_CHUNK)
  65 #define GRANT_FOR_LLOG(obd) 16
  66
  67 extern struct file_operations filter_per_export_stats_fops;
  68 extern struct file_operations filter_per_nid_stats_fops;
  69
  70 /* Limit the returned fields marked valid to those that we actually might set */
  71 #define FILTER_VALID_FLAGS (OBD_MD_FLTYPE | OBD_MD_FLMODE | OBD_MD_FLGENER  |\
  72                             OBD_MD_FLSIZE | OBD_MD_FLBLOCKS | OBD_MD_FLBLKSZ|\
  73                             OBD_MD_FLATIME | OBD_MD_FLMTIME | OBD_MD_FLCTIME)
  74
  75 /* per-client-per-object persistent state (LRU) */
  76 struct filter_mod_data {
  77         cfs_list_t       fmd_list;       /* linked to fed_mod_list */
  78         __u64            fmd_id;         /* object being written to */
  79         __u64            fmd_gr;         /* group being written to */
  80         __u64            fmd_mactime_xid;/* xid highest {m,a,c}time
  81                                               * setattr */
  82         unsigned long    fmd_expire;   /* jiffies when it should expire */
  83         int              fmd_refcount; /* reference counter, list holds 1 */
  84 };
  85
  86 #ifdef HAVE_BGL_SUPPORT
  87 #define FILTER_FMD_MAX_NUM_DEFAULT 128 /* many active files per client on BGL */
  88 #else
  89 #define FILTER_FMD_MAX_NUM_DEFAULT  32
  90 #endif
  91 /* Client cache seconds */
  92 #define FILTER_FMD_MAX_AGE_DEFAULT ((obd_timeout + 10) * CFS_HZ)
  93
  94 #ifndef HAVE_PAGE_CONSTANT
  95 #define mapping_cap_page_constant_write(mapping) 0
  96 #define SetPageConstant(page) do {} while (0)
  97 #define ClearPageConstant(page) do {} while (0)
  98 #endif
  99
 100 struct filter_mod_data *filter_fmd_find(struct obd_export *exp,
 101                                         obd_id objid, obd_seq seq);
 102 struct filter_mod_data *filter_fmd_get(struct obd_export *exp,
 103                                        obd_id objid, obd_seq seq);
 104 void filter_fmd_put(struct obd_export *exp, struct filter_mod_data *fmd);
 105 void filter_fmd_expire(struct obd_export *exp);
 106
 107 enum {
 108         LPROC_FILTER_READ_BYTES = 0,
 109         LPROC_FILTER_WRITE_BYTES = 1,
 110         LPROC_FILTER_GET_PAGE = 2,
 111         LPROC_FILTER_NO_PAGE = 3,
 112         LPROC_FILTER_CACHE_ACCESS = 4,
 113         LPROC_FILTER_CACHE_HIT = 5,
 114         LPROC_FILTER_CACHE_MISS = 6,
 115         LPROC_FILTER_LAST,
 116 };
 117
 118 //#define FILTER_MAX_CACHE_SIZE (32 * 1024 * 1024) /* was OBD_OBJECT_EOF */
 119 #define FILTER_MAX_CACHE_SIZE OBD_OBJECT_EOF
 120
 121 /* We have to pass a 'created' array to fsfilt_map_inode_pages() which we
 122  * then ignore.  So we pre-allocate one that everyone can use... */
 123 #define OBDFILTER_CREATED_SCRATCHPAD_ENTRIES 1024
 124 extern int *obdfilter_created_scratchpad;
 125
 126 extern void target_recovery_fini(struct obd_device *obd);
 127 extern void target_recovery_init(struct lu_target *lut,
 128                                  svc_handler_t handler);
 129
 130 /* filter.c */
 131 void f_dput(struct dentry *);
 132 struct dentry *filter_fid2dentry(struct obd_device *, struct dentry *dir,
 133                                  obd_seq seq, obd_id id);
 134 struct dentry *__filter_oa2dentry(struct obd_device *obd, struct ost_id *ostid,
 135                                   const char *what, int quiet);
 136 #define filter_oa2dentry(obd, ostid) __filter_oa2dentry(obd, ostid,     \
 137                                                         __func__, 0)
 138
 139 int filter_finish_transno(struct obd_export *, struct inode *,
 140                           struct obd_trans_info *, int rc, int force_sync);
 141 __u64 filter_next_id(struct filter_obd *, struct obdo *);
 142 __u64 filter_last_id(struct filter_obd *, obd_seq seq);
 143 int filter_update_fidea(struct obd_export *exp, struct inode *inode,
 144                         void *handle, struct obdo *oa);
 145 int filter_update_server_data(struct obd_device *);
 146 int filter_update_last_objid(struct obd_device *, obd_seq, int force_sync);
 147 int filter_common_setup(struct obd_device *, struct lustre_cfg *lcfg,
 148                         void *option);
 149 int filter_destroy(struct obd_export *exp, struct obdo *oa,
 150                    struct lov_stripe_md *md, struct obd_trans_info *,
 151                    struct obd_export *, void *);
 152 int filter_setattr_internal(struct obd_export *exp, struct dentry *dentry,
 153                             struct obdo *oa, struct obd_trans_info *oti);
 154 int filter_setattr(struct obd_export *exp, struct obd_info *oinfo,
 155                    struct obd_trans_info *oti);
 156
 157 int filter_create(struct obd_export *exp, struct obdo *oa,
 158                   struct lov_stripe_md **ea, struct obd_trans_info *oti);
 159
 160 struct obd_llog_group *filter_find_olg(struct obd_device *obd, int seq);
 161
 162 /* filter_lvb.c */
 163 extern struct ldlm_valblock_ops filter_lvbo;
 164
 165
 166 /* filter_io.c */
 167 int filter_preprw(int cmd, struct obd_export *, struct obdo *, int objcount,
 168                   struct obd_ioobj *, struct niobuf_remote *,
 169                   int *, struct niobuf_local *, struct obd_trans_info *,
 170                   struct lustre_capa *);
 171 int filter_commitrw(int cmd, struct obd_export *, struct obdo *, int objcount,
 172                     struct obd_ioobj *, struct niobuf_remote *,  int,
 173                     struct niobuf_local *, struct obd_trans_info *, int rc);
 174 int filter_brw(int cmd, struct obd_export *, struct obd_info *oinfo,
 175                obd_count oa_bufs, struct brw_page *pga, struct obd_trans_info *);
 176 void filter_release_cache(struct obd_device *, struct obd_ioobj *,
 177                           struct niobuf_remote *, struct inode *);
 178
 179 /* filter_io_*.c */
 180 struct filter_iobuf;
 181 int filter_commitrw_write(struct obd_export *exp, struct obdo *oa, int objcount,
 182                           struct obd_ioobj *obj, struct niobuf_remote *, int,
 183                           struct niobuf_local *res, struct obd_trans_info *oti,
 184                           int rc);
 185 obd_size filter_grant_space_left(struct obd_export *exp);
 186 long filter_grant(struct obd_export *exp, obd_size current_grant,
 187                   obd_size want, obd_size fs_space_left, int conservative);
 188 void filter_grant_commit(struct obd_export *exp, int niocount,
 189                          struct niobuf_local *res);
 190 void filter_grant_incoming(struct obd_export *exp, struct obdo *oa);
 191 struct filter_iobuf *filter_alloc_iobuf(struct filter_obd *, int rw,
 192                                         int num_pages);
 193 void filter_free_iobuf(struct filter_iobuf *iobuf);
 194 int filter_iobuf_add_page(struct obd_device *obd, struct filter_iobuf *iobuf,
 195                           struct inode *inode, struct page *page);
 196 void *filter_iobuf_get(struct filter_obd *filter, struct obd_trans_info *oti);
 197 void filter_iobuf_put(struct filter_obd *filter, struct filter_iobuf *iobuf,
 198                       struct obd_trans_info *oti);
 199 int filter_direct_io(int rw, struct dentry *dchild, struct filter_iobuf *iobuf,
 200                      struct obd_export *exp, struct iattr *attr,
 201                      struct obd_trans_info *oti, void **wait_handle);
 202 int filter_clear_truncated_page(struct inode *inode);
 203
 204 /* filter_log.c */
 205 struct ost_filterdata {
 206         __u32  ofd_epoch;
 207 };
 208 int filter_log_sz_change(struct llog_handle *cathandle,
 209                          struct ll_fid *mds_fid,
 210                          __u32 ioepoch,
 211                          struct llog_cookie *logcookie,
 212                          struct inode *inode);
 213 //int filter_get_catalog(struct obd_device *);
 214 void filter_cancel_cookies_cb(struct obd_device *obd, __u64 transno,
 215                               void *cb_data, int error);
 216 int filter_recov_log_mds_ost_cb(struct llog_handle *llh,
 217                                struct llog_rec_hdr *rec, void *data);
 218
 219 #ifdef LPROCFS
 220 void filter_tally(struct obd_export *exp, struct page **pages, int nr_pages,
 221                   unsigned long *blocks, int blocks_per_page, int wr);
 222 int lproc_filter_attach_seqstat(struct obd_device *dev);
 223 void lprocfs_filter_init_vars(struct lprocfs_static_vars *lvars);
 224 #else
 225 static inline void filter_tally(struct obd_export *exp, struct page **pages,
 226                                 int nr_pages, unsigned long *blocks,
 227                                 int blocks_per_page, int wr) {}
 228 static inline int lproc_filter_attach_seqstat(struct obd_device *dev) {}
 229 static void lprocfs_filter_init_vars(struct lprocfs_static_vars *lvars)
 230 {
 231         memset(lvars, 0, sizeof(*lvars));
 232 }
 233 #endif
 234
 235 /* Quota stuff */
 236 extern quota_interface_t *filter_quota_interface_ref;
 237
 238 int filter_update_capa_key(struct obd_device *obd, struct lustre_capa_key *key);
 239 int filter_auth_capa(struct obd_export *exp, struct lu_fid *fid, obd_seq seq,
 240                      struct lustre_capa *capa, __u64 opc);
 241 int filter_capa_fixoa(struct obd_export *exp, struct obdo *oa, obd_seq seq,
 242                       struct lustre_capa *capa);
 243 void filter_free_capa_keys(struct filter_obd *filter);
 244
 245 void blacklist_add(uid_t uid);
 246 void blacklist_del(uid_t uid);
 247 int blacklist_display(char *buf, int bufsize);
 248
 249 /* sync on lock cancel is useless when we force a journal flush,
 250  * and if we enable async journal commit, we should also turn on
 251  * sync on lock cancel if it is not enabled already. */
 252 static inline void filter_slc_set(struct filter_obd *filter)
 253 {
 254         if (filter->fo_syncjournal == 1)
 255                 filter->fo_sync_lock_cancel = NEVER_SYNC_ON_CANCEL;
 256         else if (filter->fo_sync_lock_cancel == NEVER_SYNC_ON_CANCEL)
 257                 filter->fo_sync_lock_cancel = ALWAYS_SYNC_ON_CANCEL;
 258 }
 259
 260 #endif /* _FILTER_INTERNAL_H */