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