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