lustre/ofd/ofd_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, 2012, 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 _OFD_INTERNAL_H
  38 #define _OFD_INTERNAL_H
  39
  40 #include <obd.h>
  41 #include <obd_class.h>
  42 #include <dt_object.h>
  43 #include <lustre_fid.h>
  44 #include <lustre_capa.h>
  45
  46 #define OFD_INIT_OBJID  0
  47 #define OFD_ROCOMPAT_SUPP (0)
  48 #define OFD_INCOMPAT_SUPP (OBD_INCOMPAT_GROUPS | OBD_INCOMPAT_OST | \
  49                            OBD_INCOMPAT_COMMON_LR)
  50 #define OFD_MAX_GROUPS  256
  51
  52 /* per-client-per-object persistent state (LRU) */
  53 struct ofd_mod_data {
  54         cfs_list_t      fmd_list;        /* linked to fed_mod_list */
  55         struct lu_fid   fmd_fid;         /* FID being written to */
  56         __u64           fmd_mactime_xid; /* xid highest {m,a,c}time setattr */
  57         cfs_time_t      fmd_expire;      /* time when the fmd should expire */
  58         int             fmd_refcount;    /* reference counter - list holds 1 */
  59 };
  60
  61 #define OFD_FMD_MAX_NUM_DEFAULT 128
  62 #define OFD_FMD_MAX_AGE_DEFAULT ((obd_timeout + 10) * CFS_HZ)
  63
  64 enum {
  65         LPROC_OFD_READ_BYTES = 0,
  66         LPROC_OFD_WRITE_BYTES = 1,
  67         LPROC_OFD_LAST,
  68 };
  69
  70 struct ofd_device {
  71         struct dt_device         ofd_dt_dev;
  72         struct dt_device        *ofd_osd;
  73         struct dt_device_param   ofd_dt_conf;
  74         /* DLM name-space for meta-data locks maintained by this server */
  75         struct ldlm_namespace   *ofd_namespace;
  76
  77         /* last_rcvd file */
  78         struct lu_target         ofd_lut;
  79         struct dt_object        *ofd_last_group_file;
  80         struct dt_object        *ofd_health_check_file;
  81
  82         int                      ofd_subdir_count;
  83
  84         int                      ofd_max_group;
  85         obd_id                   ofd_last_objids[OFD_MAX_GROUPS];
  86         cfs_mutex_t              ofd_create_locks[OFD_MAX_GROUPS];
  87         struct dt_object        *ofd_lastid_obj[OFD_MAX_GROUPS];
  88         cfs_spinlock_t           ofd_objid_lock;
  89
  90         /* protect all statfs-related counters */
  91         cfs_spinlock_t           ofd_osfs_lock;
  92         /* statfs optimization: we cache a bit  */
  93         struct obd_statfs        ofd_osfs;
  94         __u64                    ofd_osfs_age;
  95         int                      ofd_blockbits;
  96         /* writes which might be be accounted twice in ofd_osfs.os_bavail */
  97         obd_size                 ofd_osfs_unstable;
  98
  99         /* counters used during statfs update, protected by ofd_osfs_lock.
 100          * record when some statfs refresh are in progress */
 101         int                      ofd_statfs_inflight;
 102         /* track writes completed while statfs refresh is underway.
 103          * tracking is only effective when ofd_statfs_inflight > 1 */
 104         obd_size                 ofd_osfs_inflight;
 105
 106         /* grants: all values in bytes */
 107         /* grant lock to protect all grant counters */
 108         cfs_spinlock_t           ofd_grant_lock;
 109         /* total amount of dirty data reported by clients in incoming obdo */
 110         obd_size                 ofd_tot_dirty;
 111         /* sum of filesystem space granted to clients for async writes */
 112         obd_size                 ofd_tot_granted;
 113         /* grant used by I/Os in progress (between prepare and commit) */
 114         obd_size                 ofd_tot_pending;
 115         /* free space threshold over which we stop granting space to clients
 116          * ofd_grant_ratio is stored as a fixed-point fraction using
 117          * OFD_GRANT_RATIO_SHIFT of the remaining free space, not in percentage
 118          * values */
 119         int                      ofd_grant_ratio;
 120         /* number of clients using grants */
 121         int                      ofd_tot_granted_clients;
 122
 123         /* ofd mod data: ofd_device wide values */
 124         int                      ofd_fmd_max_num; /* per ofd ofd_mod_data */
 125         cfs_duration_t           ofd_fmd_max_age; /* time to fmd expiry */
 126
 127         cfs_spinlock_t           ofd_flags_lock;
 128         unsigned long            ofd_raid_degraded:1,
 129                                  /* sync journal on writes */
 130                                  ofd_syncjournal:1,
 131                                  /* sync on lock cancel */
 132                                  ofd_sync_lock_cancel:2,
 133                                  /* shall we grant space to clients not
 134                                   * supporting OBD_CONNECT_GRANT_PARAM? */
 135                                  ofd_grant_compat_disable:1;
 136
 137         struct lu_site           ofd_site;
 138 };
 139
 140 static inline struct ofd_device *ofd_dev(struct lu_device *d)
 141 {
 142         return container_of0(d, struct ofd_device, ofd_dt_dev.dd_lu_dev);
 143 }
 144
 145 static inline struct obd_device *ofd_obd(struct ofd_device *ofd)
 146 {
 147         return ofd->ofd_dt_dev.dd_lu_dev.ld_obd;
 148 }
 149
 150 static inline struct ofd_device *ofd_exp(struct obd_export *exp)
 151 {
 152         return ofd_dev(exp->exp_obd->obd_lu_dev);
 153 }
 154
 155 static inline char *ofd_name(struct ofd_device *ofd)
 156 {
 157         return ofd->ofd_dt_dev.dd_lu_dev.ld_obd->obd_name;
 158 }
 159
 160 struct ofd_object {
 161         struct lu_object_header ofo_header;
 162         struct dt_object        ofo_obj;
 163 };
 164
 165 static inline struct ofd_object *ofd_obj(struct lu_object *o)
 166 {
 167         return container_of0(o, struct ofd_object, ofo_obj.do_lu);
 168 }
 169
 170 /*
 171  * Common data shared by obdofd-level handlers. This is allocated per-thread
 172  * to reduce stack consumption.
 173  */
 174 struct ofd_thread_info {
 175         const struct lu_env             *fti_env;
 176
 177         struct obd_export               *fti_exp;
 178         struct lu_fid                    fti_fid;
 179         struct lu_attr                   fti_attr;
 180         union {
 181                 char                     name[64]; /* for ofd_init0() */
 182                 struct obd_statfs        osfs;    /* for obdofd_statfs() */
 183         } fti_u;
 184
 185         struct dt_object_format          fti_dof;
 186         struct lu_buf                    fti_buf;
 187         loff_t                           fti_off;
 188
 189         /* Space used by the I/O, used by grant code */
 190         unsigned long                    fti_used;
 191 };
 192
 193 extern void target_recovery_fini(struct obd_device *obd);
 194 extern void target_recovery_init(struct lu_target *lut, svc_handler_t handler);
 195
 196 /* ofd_capa.c */
 197 int ofd_update_capa_key(struct ofd_device *ofd, struct lustre_capa_key *key);
 198 int ofd_auth_capa(struct obd_export *exp, struct lu_fid *fid, obd_seq seq,
 199                   struct lustre_capa *capa, __u64 opc);
 200 void ofd_free_capa_keys(struct ofd_device *ofd);
 201
 202 /* ofd_dev.c */
 203 extern struct lu_context_key ofd_thread_key;
 204
 205 /* ofd_obd.c */
 206 extern struct obd_ops ofd_obd_ops;
 207 int ofd_statfs_internal(const struct lu_env *env, struct ofd_device *ofd,
 208                         struct obd_statfs *osfs, __u64 max_age,
 209                         int *from_cache);
 210
 211 /* ofd_fs.c */
 212 obd_id ofd_last_id(struct ofd_device *ofd, obd_seq seq);
 213 int ofd_group_load(const struct lu_env *env, struct ofd_device *ofd, int);
 214 int ofd_fs_setup(const struct lu_env *env, struct ofd_device *ofd,
 215                  struct obd_device *obd);
 216 void ofd_fs_cleanup(const struct lu_env *env, struct ofd_device *ofd);
 217
 218 /* lproc_ofd.c */
 219 void lprocfs_ofd_init_vars(struct lprocfs_static_vars *lvars);
 220 int lproc_ofd_attach_seqstat(struct obd_device *dev);
 221 extern struct file_operations ofd_per_nid_stats_fops;
 222
 223 /* ofd_grants.c */
 224 #define OFD_GRANT_RATIO_SHIFT 8
 225 static inline __u64 ofd_grant_reserved(struct ofd_device *ofd, obd_size bavail)
 226 {
 227         return (bavail * ofd->ofd_grant_ratio) >> OFD_GRANT_RATIO_SHIFT;
 228 }
 229
 230 static inline int ofd_grant_ratio_conv(int percentage)
 231 {
 232         return (percentage << OFD_GRANT_RATIO_SHIFT) / 100;
 233 }
 234
 235 static inline int ofd_grant_param_supp(struct obd_export *exp)
 236 {
 237         return !!(exp->exp_connect_flags & OBD_CONNECT_GRANT_PARAM);
 238 }
 239
 240 /* Blocksize used for client not supporting OBD_CONNECT_GRANT_PARAM.
 241  * That's 4KB=2^12 which is the biggest block size known to work whatever
 242  * the client's page size is. */
 243 #define COMPAT_BSIZE_SHIFT 12
 244 static inline int ofd_grant_compat(struct obd_export *exp,
 245                                    struct ofd_device *ofd)
 246 {
 247         /* Clients which don't support OBD_CONNECT_GRANT_PARAM cannot handle
 248          * a block size > page size and consume CFS_PAGE_SIZE of grant when
 249          * dirtying a page regardless of the block size */
 250         return !!(ofd_obd(ofd)->obd_self_export != exp &&
 251                   ofd->ofd_blockbits > COMPAT_BSIZE_SHIFT &&
 252                   !ofd_grant_param_supp(exp));
 253 }
 254
 255 static inline int ofd_grant_prohibit(struct obd_export *exp,
 256                                      struct ofd_device *ofd)
 257 {
 258         /* When ofd_grant_compat_disable is set, we don't grant any space to
 259          * clients not supporting OBD_CONNECT_GRANT_PARAM.
 260          * Otherwise, space granted to such a client is inflated since it
 261          * consumes CFS_PAGE_SIZE of grant space per block */
 262         return !!(ofd_grant_compat(exp, ofd) && ofd->ofd_grant_compat_disable);
 263 }
 264
 265 void ofd_grant_sanity_check(struct obd_device *obd, const char *func);
 266 long ofd_grant_connect(const struct lu_env *env, struct obd_export *exp,
 267                        obd_size want);
 268 void ofd_grant_discard(struct obd_export *exp);
 269 void ofd_grant_prepare_read(const struct lu_env *env, struct obd_export *exp,
 270                             struct obdo *oa);
 271 void ofd_grant_prepare_write(const struct lu_env *env, struct obd_export *exp,
 272                              struct obdo *oa, struct niobuf_remote *rnb,
 273                              int niocount);
 274 void ofd_grant_commit(const struct lu_env *env, struct obd_export *exp, int rc);
 275 int ofd_grant_create(const struct lu_env *env, struct obd_export *exp, int *nr);
 276
 277 /* ofd_fmd.c */
 278 int ofd_fmd_init(void);
 279 void ofd_fmd_exit(void);
 280 struct ofd_mod_data *ofd_fmd_find(struct obd_export *exp,
 281                                   struct lu_fid *fid);
 282 struct ofd_mod_data *ofd_fmd_get(struct obd_export *exp,
 283                                  struct lu_fid *fid);
 284 void ofd_fmd_put(struct obd_export *exp, struct ofd_mod_data *fmd);
 285 void ofd_fmd_expire(struct obd_export *exp);
 286 void ofd_fmd_cleanup(struct obd_export *exp);
 287 #ifdef DO_FMD_DROP
 288 void ofd_fmd_drop(struct obd_export *exp, struct lu_fid *fid);
 289 #else
 290 #define ofd_fmd_drop(exp, fid) do {} while (0)
 291 #endif
 292
 293 static inline struct ofd_thread_info * ofd_info(const struct lu_env *env)
 294 {
 295         struct ofd_thread_info *info;
 296
 297         info = lu_context_key_get(&env->le_ctx, &ofd_thread_key);
 298         LASSERT(info);
 299         LASSERT(info->fti_env);
 300         LASSERT(info->fti_env == env);
 301         return info;
 302 }
 303
 304 static inline struct ofd_thread_info * ofd_info_init(const struct lu_env *env,
 305                                                      struct obd_export *exp)
 306 {
 307         struct ofd_thread_info *info;
 308
 309         info = lu_context_key_get(&env->le_ctx, &ofd_thread_key);
 310         LASSERT(info);
 311         LASSERT(info->fti_exp == NULL);
 312         LASSERT(info->fti_env == NULL);
 313
 314         info->fti_env = env;
 315         info->fti_exp = exp;
 316         return info;
 317 }
 318
 319 /* sync on lock cancel is useless when we force a journal flush,
 320  * and if we enable async journal commit, we should also turn on
 321  * sync on lock cancel if it is not enabled already. */
 322 static inline void ofd_slc_set(struct ofd_device *ofd)
 323 {
 324         if (ofd->ofd_syncjournal == 1)
 325                 ofd->ofd_sync_lock_cancel = NEVER_SYNC_ON_CANCEL;
 326         else if (ofd->ofd_sync_lock_cancel == NEVER_SYNC_ON_CANCEL)
 327                 ofd->ofd_sync_lock_cancel = ALWAYS_SYNC_ON_CANCEL;
 328 }
 329
 330 /* niobuf_local has no rnb_ prefix in master */
 331 #define rnb_offset offset
 332 #define rnb_flags  flags
 333 #define rnb_len    len
 334
 335 #endif /* _OFD_INTERNAL_H */