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  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
  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 #define POSTID LPU64":"LPU64
  99 /**
 100  * Validate ost_id in obdo
 101  */
 102 static inline int
 103 filter_validate_obdo(struct obdo *oa, struct obd_export *exp)
 104 {
 105         if (oa != NULL && !(oa->o_valid & OBD_MD_FLGROUP)) {
 106                 oa->o_seq = FID_SEQ_OST_MDT0;
 107         /* remove fid_seq_is_rsvd() after FID-on-OST allows SEQ > 9 */
 108         } else if (oa == NULL || !fid_seq_is_rsvd(oa->o_seq)) {
 109                 CERROR("%s: client %s sent invalid object "POSTID"\n",
 110                        exp->exp_obd->obd_name, obd_export_nid2str(exp),
 111                        oa ? oa->o_id : -1, oa ? oa->o_seq : -1);
 112                 return -EPROTO;
 113         }
 114         oa->o_seq = ostid_seq(&oa->o_oi);
 115         oa->o_id = ostid_id(&oa->o_oi);
 116         return 0;
 117 }
 118
 119 struct filter_mod_data *filter_fmd_find(struct obd_export *exp,
 120                                         obd_id objid, obd_seq seq);
 121 struct filter_mod_data *filter_fmd_get(struct obd_export *exp,
 122                                        obd_id objid, obd_seq seq);
 123 void filter_fmd_put(struct obd_export *exp, struct filter_mod_data *fmd);
 124 void filter_fmd_expire(struct obd_export *exp);
 125
 126 enum {
 127         LPROC_FILTER_READ_BYTES = 0,
 128         LPROC_FILTER_WRITE_BYTES = 1,
 129         LPROC_FILTER_GET_PAGE = 2,
 130         LPROC_FILTER_NO_PAGE = 3,
 131         LPROC_FILTER_CACHE_ACCESS = 4,
 132         LPROC_FILTER_CACHE_HIT = 5,
 133         LPROC_FILTER_CACHE_MISS = 6,
 134         LPROC_FILTER_LAST,
 135 };
 136
 137 //#define FILTER_MAX_CACHE_SIZE (32 * 1024 * 1024) /* was OBD_OBJECT_EOF */
 138 #define FILTER_MAX_CACHE_SIZE OBD_OBJECT_EOF
 139
 140 /* We have to pass a 'created' array to fsfilt_map_inode_pages() which we
 141  * then ignore.  So we pre-allocate one that everyone can use... */
 142 #define OBDFILTER_CREATED_SCRATCHPAD_ENTRIES 1024
 143 extern int *obdfilter_created_scratchpad;
 144
 145 extern void target_recovery_fini(struct obd_device *obd);
 146 extern void target_recovery_init(struct lu_target *lut,
 147                                  svc_handler_t handler);
 148
 149 /* filter.c */
 150 void f_dput(struct dentry *);
 151 struct dentry *filter_fid2dentry(struct obd_device *, struct dentry *dir,
 152                                  obd_seq seq, obd_id id);
 153 struct dentry *__filter_oa2dentry(struct obd_device *obd, struct ost_id *ostid,
 154                                   const char *what, int quiet);
 155 #define filter_oa2dentry(obd, ostid) __filter_oa2dentry(obd, ostid,     \
 156                                                         __func__, 0)
 157
 158 int filter_finish_transno(struct obd_export *, struct inode *,
 159                           struct obd_trans_info *, int rc, int force_sync);
 160 __u64 filter_next_id(struct filter_obd *, struct obdo *);
 161 __u64 filter_last_id(struct filter_obd *, obd_seq seq);
 162 int filter_update_fidea(struct obd_export *exp, struct inode *inode,
 163                         void *handle, struct obdo *oa);
 164 int filter_update_server_data(struct obd_device *);
 165 int filter_update_last_objid(struct obd_device *, obd_seq, int force_sync);
 166 int filter_common_setup(struct obd_device *, struct lustre_cfg *lcfg,
 167                         void *option);
 168 int filter_destroy(struct obd_export *exp, struct obdo *oa,
 169                    struct lov_stripe_md *md, struct obd_trans_info *,
 170                    struct obd_export *, void *);
 171 int filter_setattr_internal(struct obd_export *exp, struct dentry *dentry,
 172                             struct obdo *oa, struct obd_trans_info *oti);
 173 int filter_setattr(struct obd_export *exp, struct obd_info *oinfo,
 174                    struct obd_trans_info *oti);
 175
 176 struct dentry *filter_create_object(struct obd_device *obd, struct obdo *oa);
 177
 178 struct obd_llog_group *filter_find_olg(struct obd_device *obd, int seq);
 179
 180 /* filter_lvb.c */
 181 extern struct ldlm_valblock_ops filter_lvbo;
 182
 183
 184 /* filter_io.c */
 185 int filter_preprw(int cmd, struct obd_export *, 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(int cmd, struct obd_export *, struct obdo *, int objcount,
 190                     struct obd_ioobj *, struct niobuf_remote *,  int,
 191                     struct niobuf_local *, struct obd_trans_info *, int rc);
 192 int filter_brw(int cmd, struct obd_export *, struct obd_info *oinfo,
 193                obd_count oa_bufs, struct brw_page *pga, struct obd_trans_info *);
 194 void filter_release_cache(struct obd_device *, struct obd_ioobj *,
 195                           struct niobuf_remote *, struct inode *);
 196
 197 /* filter_io_*.c */
 198 struct filter_iobuf;
 199 int filter_commitrw_write(struct obd_export *exp, struct obdo *oa, int objcount,
 200                           struct obd_ioobj *obj, struct niobuf_remote *, int,
 201                           struct niobuf_local *res, struct obd_trans_info *oti,
 202                           int rc);
 203 obd_size filter_grant_space_left(struct obd_export *exp);
 204 long filter_grant(struct obd_export *exp, obd_size current_grant,
 205                   obd_size want, obd_size fs_space_left, int conservative);
 206 void filter_grant_commit(struct obd_export *exp, int niocount,
 207                          struct niobuf_local *res);
 208 void filter_grant_incoming(struct obd_export *exp, struct obdo *oa);
 209 struct filter_iobuf *filter_alloc_iobuf(struct filter_obd *, int rw,
 210                                         int num_pages);
 211 void filter_free_iobuf(struct filter_iobuf *iobuf);
 212 int filter_iobuf_add_page(struct obd_device *obd, struct filter_iobuf *iobuf,
 213                           struct inode *inode, struct page *page);
 214 void *filter_iobuf_get(struct filter_obd *filter, struct obd_trans_info *oti);
 215 void filter_iobuf_put(struct filter_obd *filter, struct filter_iobuf *iobuf,
 216                       struct obd_trans_info *oti);
 217 int filter_direct_io(int rw, struct dentry *dchild, struct filter_iobuf *iobuf,
 218                      struct obd_export *exp, struct iattr *attr,
 219                      struct obd_trans_info *oti, void **wait_handle);
 220 int filter_clear_truncated_page(struct inode *inode);
 221
 222 /* filter_log.c */
 223 struct ost_filterdata {
 224         __u32  ofd_epoch;
 225 };
 226 int filter_log_sz_change(struct llog_handle *cathandle,
 227                          struct ll_fid *mds_fid,
 228                          __u32 ioepoch,
 229                          struct llog_cookie *logcookie,
 230                          struct inode *inode);
 231 //int filter_get_catalog(struct obd_device *);
 232 void filter_cancel_cookies_cb(struct obd_device *obd, __u64 transno,
 233                               void *cb_data, int error);
 234 int filter_recov_log_mds_ost_cb(struct llog_handle *llh,
 235                                struct llog_rec_hdr *rec, void *data);
 236
 237 #ifdef LPROCFS
 238 void filter_tally(struct obd_export *exp, struct page **pages, int nr_pages,
 239                   unsigned long *blocks, int blocks_per_page, int wr);
 240 int lproc_filter_attach_seqstat(struct obd_device *dev);
 241 void lprocfs_filter_init_vars(struct lprocfs_static_vars *lvars);
 242 #else
 243 static inline void filter_tally(struct obd_export *exp, struct page **pages,
 244                                 int nr_pages, unsigned long *blocks,
 245                                 int blocks_per_page, int wr) {}
 246 static inline int lproc_filter_attach_seqstat(struct obd_device *dev) {}
 247 static void lprocfs_filter_init_vars(struct lprocfs_static_vars *lvars)
 248 {
 249         memset(lvars, 0, sizeof(*lvars));
 250 }
 251 #endif
 252
 253 /* Quota stuff */
 254 extern quota_interface_t *filter_quota_interface_ref;
 255
 256 int filter_update_capa_key(struct obd_device *obd, struct lustre_capa_key *key);
 257 int filter_auth_capa(struct obd_export *exp, struct lu_fid *fid, obd_seq seq,
 258                      struct lustre_capa *capa, __u64 opc);
 259 int filter_capa_fixoa(struct obd_export *exp, struct obdo *oa, obd_seq seq,
 260                       struct lustre_capa *capa);
 261 void filter_free_capa_keys(struct filter_obd *filter);
 262
 263 void blacklist_add(uid_t uid);
 264 void blacklist_del(uid_t uid);
 265 int blacklist_display(char *buf, int bufsize);
 266
 267 #endif /* _FILTER_INTERNAL_H */