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 <obd_ost.h>
  45 #include <lustre_capa.h>
  46
  47 #define OFD_INIT_OBJID  0
  48 #define OFD_ROCOMPAT_SUPP (0)
  49 #define OFD_INCOMPAT_SUPP (OBD_INCOMPAT_GROUPS | OBD_INCOMPAT_OST | \
  50                            OBD_INCOMPAT_COMMON_LR)
  51 #define OFD_MAX_GROUPS  256
  52
  53 /* per-client-per-object persistent state (LRU) */
  54 struct ofd_mod_data {
  55         cfs_list_t      fmd_list;        /* linked to fed_mod_list */
  56         struct lu_fid   fmd_fid;         /* FID being written to */
  57         __u64           fmd_mactime_xid; /* xid highest {m,a,c}time setattr */
  58         cfs_time_t      fmd_expire;      /* time when the fmd should expire */
  59         int             fmd_refcount;    /* reference counter - list holds 1 */
  60 };
  61
  62 #define OFD_FMD_MAX_NUM_DEFAULT 128
  63 #define OFD_FMD_MAX_AGE_DEFAULT ((obd_timeout + 10) * CFS_HZ)
  64
  65 enum {
  66         LPROC_OFD_READ_BYTES = 0,
  67         LPROC_OFD_WRITE_BYTES = 1,
  68         LPROC_OFD_LAST,
  69 };
  70
  71 struct ofd_device {
  72         struct dt_device         ofd_dt_dev;
  73         struct dt_device        *ofd_osd;
  74         struct dt_device_param   ofd_dt_conf;
  75         /* DLM name-space for meta-data locks maintained by this server */
  76         struct ldlm_namespace   *ofd_namespace;
  77
  78         /* transaction callbacks */
  79         struct dt_txn_callback   ofd_txn_cb;
  80
  81         /* last_rcvd file */
  82         struct lu_target         ofd_lut;
  83         struct dt_object        *ofd_last_group_file;
  84         struct dt_object        *ofd_health_check_file;
  85
  86         int                      ofd_subdir_count;
  87
  88         int                      ofd_max_group;
  89         obd_id                   ofd_last_objids[OFD_MAX_GROUPS];
  90         cfs_mutex_t              ofd_create_locks[OFD_MAX_GROUPS];
  91         struct dt_object        *ofd_lastid_obj[OFD_MAX_GROUPS];
  92         cfs_spinlock_t           ofd_objid_lock;
  93
  94         /* protect all statfs-related counters */
  95         cfs_spinlock_t           ofd_osfs_lock;
  96         /* statfs optimization: we cache a bit  */
  97         struct obd_statfs        ofd_osfs;
  98         __u64                    ofd_osfs_age;
  99         int                      ofd_blockbits;
 100         /* writes which might be be accounted twice in ofd_osfs.os_bavail */
 101         obd_size                 ofd_osfs_unstable;
 102
 103         /* counters used during statfs update, protected by ofd_osfs_lock.
 104          * record when some statfs refresh are in progress */
 105         int                      ofd_statfs_inflight;
 106         /* track writes completed while statfs refresh is underway.
 107          * tracking is only effective when ofd_statfs_inflight > 1 */
 108         obd_size                 ofd_osfs_inflight;
 109
 110         /* grants: all values in bytes */
 111         /* grant lock to protect all grant counters */
 112         cfs_spinlock_t           ofd_grant_lock;
 113         /* total amount of dirty data reported by clients in incoming obdo */
 114         obd_size                 ofd_tot_dirty;
 115         /* sum of filesystem space granted to clients for async writes */
 116         obd_size                 ofd_tot_granted;
 117         /* grant used by I/Os in progress (between prepare and commit) */
 118         obd_size                 ofd_tot_pending;
 119         /* free space threshold over which we stop granting space to clients
 120          * ofd_grant_ratio is stored as a fixed-point fraction using
 121          * OFD_GRANT_RATIO_SHIFT of the remaining free space, not in percentage
 122          * values */
 123         int                      ofd_grant_ratio;
 124         /* number of clients using grants */
 125         int                      ofd_tot_granted_clients;
 126
 127         /* ofd mod data: ofd_device wide values */
 128         int                      ofd_fmd_max_num; /* per ofd ofd_mod_data */
 129         cfs_duration_t           ofd_fmd_max_age; /* time to fmd expiry */
 130
 131         cfs_spinlock_t           ofd_flags_lock;
 132         unsigned long            ofd_raid_degraded:1,
 133                                  /* sync journal on writes */
 134                                  ofd_syncjournal:1,
 135                                  /* sync on lock cancel */
 136                                  ofd_sync_lock_cancel:2,
 137                                  /* shall we grant space to clients not
 138                                   * supporting OBD_CONNECT_GRANT_PARAM? */
 139                                  ofd_grant_compat_disable:1;
 140
 141         struct lu_site           ofd_site;
 142 };
 143
 144 static inline struct ofd_device *ofd_dev(struct lu_device *d)
 145 {
 146         return container_of0(d, struct ofd_device, ofd_dt_dev.dd_lu_dev);
 147 }
 148
 149 static inline struct obd_device *ofd_obd(struct ofd_device *ofd)
 150 {
 151         return ofd->ofd_dt_dev.dd_lu_dev.ld_obd;
 152 }
 153
 154 static inline struct ofd_device *ofd_exp(struct obd_export *exp)
 155 {
 156         return ofd_dev(exp->exp_obd->obd_lu_dev);
 157 }
 158
 159 static inline char *ofd_name(struct ofd_device *ofd)
 160 {
 161         return ofd->ofd_dt_dev.dd_lu_dev.ld_obd->obd_name;
 162 }
 163
 164 struct ofd_object {
 165         struct lu_object_header ofo_header;
 166         struct dt_object        ofo_obj;
 167         int                     ofo_ff_exists;
 168 };
 169
 170 static inline struct ofd_object *ofd_obj(struct lu_object *o)
 171 {
 172         return container_of0(o, struct ofd_object, ofo_obj.do_lu);
 173 }
 174
 175 static inline int ofd_object_exists(struct ofd_object *obj)
 176 {
 177         LASSERT(obj != NULL);
 178         if (lu_object_is_dying(obj->ofo_obj.do_lu.lo_header))
 179                 return 0;
 180         return lu_object_exists(&obj->ofo_obj.do_lu);
 181 }
 182
 183 static inline struct dt_object *fo2dt(struct ofd_object *obj)
 184 {
 185         return &obj->ofo_obj;
 186 }
 187
 188 static inline struct dt_object *ofd_object_child(struct ofd_object *_obj)
 189 {
 190         struct lu_object *lu = &(_obj)->ofo_obj.do_lu;
 191
 192         return container_of0(lu_object_next(lu), struct dt_object, do_lu);
 193 }
 194
 195 static inline struct ofd_device *ofd_obj2dev(const struct ofd_object *fo)
 196 {
 197         return ofd_dev(fo->ofo_obj.do_lu.lo_dev);
 198 }
 199
 200 static inline struct lustre_capa *ofd_object_capa(const struct lu_env *env,
 201                                                   const struct ofd_object *obj)
 202 {
 203         /* TODO: see mdd_object_capa() */
 204         return BYPASS_CAPA;
 205 }
 206
 207 static inline void ofd_read_lock(const struct lu_env *env,
 208                                  struct ofd_object *fo)
 209 {
 210         struct dt_object  *next = ofd_object_child(fo);
 211
 212         next->do_ops->do_read_lock(env, next, 0);
 213 }
 214
 215 static inline void ofd_read_unlock(const struct lu_env *env,
 216                                    struct ofd_object *fo)
 217 {
 218         struct dt_object  *next = ofd_object_child(fo);
 219
 220         next->do_ops->do_read_unlock(env, next);
 221 }
 222
 223 static inline void ofd_write_lock(const struct lu_env *env,
 224                                   struct ofd_object *fo)
 225 {
 226         struct dt_object *next = ofd_object_child(fo);
 227
 228         next->do_ops->do_write_lock(env, next, 0);
 229 }
 230
 231 static inline void ofd_write_unlock(const struct lu_env *env,
 232                                     struct ofd_object *fo)
 233 {
 234         struct dt_object  *next = ofd_object_child(fo);
 235
 236         next->do_ops->do_write_unlock(env, next);
 237 }
 238
 239 /*
 240  * Common data shared by obdofd-level handlers. This is allocated per-thread
 241  * to reduce stack consumption.
 242  */
 243 struct ofd_thread_info {
 244         const struct lu_env             *fti_env;
 245
 246         struct obd_export               *fti_exp;
 247         __u64                            fti_xid;
 248         __u64                            fti_transno;
 249         __u64                            fti_pre_version;
 250         __u32                            fti_has_trans:1, /* has txn already */
 251                                          fti_mult_trans:1;
 252
 253         struct lu_fid                    fti_fid;
 254         struct lu_attr                   fti_attr;
 255         struct lu_attr                   fti_attr2;
 256         struct filter_fid                fti_mds_fid2;
 257         struct ost_id                    fti_ostid;
 258         struct ofd_object               *fti_obj;
 259         union {
 260                 char                     name[64]; /* for ofd_init0() */
 261                 struct obd_statfs        osfs;    /* for obdofd_statfs() */
 262         } fti_u;
 263
 264         /* Ops object filename */
 265         struct lu_name                   fti_name;
 266         struct dt_object_format          fti_dof;
 267         struct lu_buf                    fti_buf;
 268         loff_t                           fti_off;
 269
 270         /* Space used by the I/O, used by grant code */
 271         unsigned long                    fti_used;
 272 };
 273
 274 extern void target_recovery_fini(struct obd_device *obd);
 275 extern void target_recovery_init(struct lu_target *lut, svc_handler_t handler);
 276
 277 /* ofd_capa.c */
 278 int ofd_update_capa_key(struct ofd_device *ofd, struct lustre_capa_key *key);
 279 int ofd_auth_capa(struct obd_export *exp, struct lu_fid *fid, obd_seq seq,
 280                   struct lustre_capa *capa, __u64 opc);
 281 void ofd_free_capa_keys(struct ofd_device *ofd);
 282
 283 /* ofd_dev.c */
 284 extern struct lu_context_key ofd_thread_key;
 285
 286 /* ofd_obd.c */
 287 extern struct obd_ops ofd_obd_ops;
 288 int ofd_statfs_internal(const struct lu_env *env, struct ofd_device *ofd,
 289                         struct obd_statfs *osfs, __u64 max_age,
 290                         int *from_cache);
 291
 292 /* ofd_fs.c */
 293 obd_id ofd_last_id(struct ofd_device *ofd, obd_seq seq);
 294 void ofd_last_id_set(struct ofd_device *ofd, obd_id id, obd_seq seq);
 295 int ofd_group_load(const struct lu_env *env, struct ofd_device *ofd, int);
 296 int ofd_fs_setup(const struct lu_env *env, struct ofd_device *ofd,
 297                  struct obd_device *obd);
 298 void ofd_fs_cleanup(const struct lu_env *env, struct ofd_device *ofd);
 299
 300 /* ofd_trans.c */
 301 struct thandle *ofd_trans_create(const struct lu_env *env,
 302                                  struct ofd_device *ofd);
 303 int ofd_trans_start(const struct lu_env *env,
 304                     struct ofd_device *ofd, struct ofd_object *fo,
 305                     struct thandle *th);
 306 void ofd_trans_stop(const struct lu_env *env, struct ofd_device *ofd,
 307                     struct thandle *th, int rc);
 308 int ofd_txn_stop_cb(const struct lu_env *env, struct thandle *txn,
 309                     void *cookie);
 310
 311 /* lproc_ofd.c */
 312 void lprocfs_ofd_init_vars(struct lprocfs_static_vars *lvars);
 313 int lproc_ofd_attach_seqstat(struct obd_device *dev);
 314 extern struct file_operations ofd_per_nid_stats_fops;
 315
 316 /* ofd_objects.c */
 317 struct ofd_object *ofd_object_find(const struct lu_env *env,
 318                                    struct ofd_device *ofd,
 319                                    const struct lu_fid *fid);
 320 struct ofd_object *ofd_object_find_or_create(const struct lu_env *env,
 321                                              struct ofd_device *ofd,
 322                                              const struct lu_fid *fid,
 323                                              struct lu_attr *attr);
 324 int ofd_object_ff_check(const struct lu_env *env, struct ofd_object *fo);
 325 int ofd_precreate_object(const struct lu_env *env, struct ofd_device *ofd,
 326                          obd_id id, obd_seq seq);
 327
 328 void ofd_object_put(const struct lu_env *env, struct ofd_object *fo);
 329 int ofd_attr_set(const struct lu_env *env, struct ofd_object *fo,
 330                  struct lu_attr *la, struct filter_fid *ff);
 331 int ofd_object_punch(const struct lu_env *env, struct ofd_object *fo,
 332                      __u64 start, __u64 end, struct lu_attr *la,
 333                      struct filter_fid *ff);
 334 int ofd_object_destroy(const struct lu_env *, struct ofd_object *, int);
 335 int ofd_attr_get(const struct lu_env *env, struct ofd_object *fo,
 336                  struct lu_attr *la);
 337 int ofd_attr_handle_ugid(const struct lu_env *env, struct ofd_object *fo,
 338                          struct lu_attr *la, int is_setattr);
 339
 340 /* ofd_grants.c */
 341 #define OFD_GRANT_RATIO_SHIFT 8
 342 static inline __u64 ofd_grant_reserved(struct ofd_device *ofd, obd_size bavail)
 343 {
 344         return (bavail * ofd->ofd_grant_ratio) >> OFD_GRANT_RATIO_SHIFT;
 345 }
 346
 347 static inline int ofd_grant_ratio_conv(int percentage)
 348 {
 349         return (percentage << OFD_GRANT_RATIO_SHIFT) / 100;
 350 }
 351
 352 static inline int ofd_grant_param_supp(struct obd_export *exp)
 353 {
 354         return !!(exp->exp_connect_flags & OBD_CONNECT_GRANT_PARAM);
 355 }
 356
 357 /* Blocksize used for client not supporting OBD_CONNECT_GRANT_PARAM.
 358  * That's 4KB=2^12 which is the biggest block size known to work whatever
 359  * the client's page size is. */
 360 #define COMPAT_BSIZE_SHIFT 12
 361 static inline int ofd_grant_compat(struct obd_export *exp,
 362                                    struct ofd_device *ofd)
 363 {
 364         /* Clients which don't support OBD_CONNECT_GRANT_PARAM cannot handle
 365          * a block size > page size and consume CFS_PAGE_SIZE of grant when
 366          * dirtying a page regardless of the block size */
 367         return !!(ofd_obd(ofd)->obd_self_export != exp &&
 368                   ofd->ofd_blockbits > COMPAT_BSIZE_SHIFT &&
 369                   !ofd_grant_param_supp(exp));
 370 }
 371
 372 static inline int ofd_grant_prohibit(struct obd_export *exp,
 373                                      struct ofd_device *ofd)
 374 {
 375         /* When ofd_grant_compat_disable is set, we don't grant any space to
 376          * clients not supporting OBD_CONNECT_GRANT_PARAM.
 377          * Otherwise, space granted to such a client is inflated since it
 378          * consumes CFS_PAGE_SIZE of grant space per block */
 379         return !!(ofd_grant_compat(exp, ofd) && ofd->ofd_grant_compat_disable);
 380 }
 381
 382 void ofd_grant_sanity_check(struct obd_device *obd, const char *func);
 383 long ofd_grant_connect(const struct lu_env *env, struct obd_export *exp,
 384                        obd_size want);
 385 void ofd_grant_discard(struct obd_export *exp);
 386 void ofd_grant_prepare_read(const struct lu_env *env, struct obd_export *exp,
 387                             struct obdo *oa);
 388 void ofd_grant_prepare_write(const struct lu_env *env, struct obd_export *exp,
 389                              struct obdo *oa, struct niobuf_remote *rnb,
 390                              int niocount);
 391 void ofd_grant_commit(const struct lu_env *env, struct obd_export *exp, int rc);
 392 int ofd_grant_create(const struct lu_env *env, struct obd_export *exp, int *nr);
 393
 394 /* ofd_fmd.c */
 395 int ofd_fmd_init(void);
 396 void ofd_fmd_exit(void);
 397 struct ofd_mod_data *ofd_fmd_find(struct obd_export *exp,
 398                                   struct lu_fid *fid);
 399 struct ofd_mod_data *ofd_fmd_get(struct obd_export *exp,
 400                                  struct lu_fid *fid);
 401 void ofd_fmd_put(struct obd_export *exp, struct ofd_mod_data *fmd);
 402 void ofd_fmd_expire(struct obd_export *exp);
 403 void ofd_fmd_cleanup(struct obd_export *exp);
 404 #ifdef DO_FMD_DROP
 405 void ofd_fmd_drop(struct obd_export *exp, struct lu_fid *fid);
 406 #else
 407 #define ofd_fmd_drop(exp, fid) do {} while (0)
 408 #endif
 409
 410 /* ofd_lvb.c */
 411 extern struct ldlm_valblock_ops ofd_lvbo;
 412
 413 /* ofd_dlm.c */
 414 int ofd_intent_policy(struct ldlm_namespace *ns, struct ldlm_lock **lockp,
 415                       void *req_cookie, ldlm_mode_t mode, int flags,
 416                       void *data);
 417
 418 static inline struct ofd_thread_info * ofd_info(const struct lu_env *env)
 419 {
 420         struct ofd_thread_info *info;
 421
 422         info = lu_context_key_get(&env->le_ctx, &ofd_thread_key);
 423         LASSERT(info);
 424         LASSERT(info->fti_env);
 425         LASSERT(info->fti_env == env);
 426         return info;
 427 }
 428
 429 static inline struct ofd_thread_info * ofd_info_init(const struct lu_env *env,
 430                                                      struct obd_export *exp)
 431 {
 432         struct ofd_thread_info *info;
 433
 434         info = lu_context_key_get(&env->le_ctx, &ofd_thread_key);
 435         LASSERT(info);
 436         LASSERT(info->fti_exp == NULL);
 437         LASSERT(info->fti_env == NULL);
 438         LASSERT(info->fti_attr.la_valid == 0);
 439
 440         info->fti_env = env;
 441         info->fti_exp = exp;
 442         info->fti_pre_version = 0;
 443         info->fti_transno = 0;
 444         info->fti_has_trans = 0;
 445         return info;
 446 }
 447
 448 /* The same as osc_build_res_name() */
 449 static inline void ofd_build_resid(const struct lu_fid *fid,
 450                                    struct ldlm_res_id *resname)
 451 {
 452         if (fid_is_idif(fid)) {
 453                 /* get id/seq like ostid_idif_pack() does */
 454                 osc_build_res_name(fid_idif_id(fid_seq(fid), fid_oid(fid),
 455                                                fid_ver(fid)),
 456                                    FID_SEQ_OST_MDT0, resname);
 457         } else {
 458                 /* In the future, where OSTs have FID sequences allocated. */
 459                 fid_build_reg_res_name(fid, resname);
 460         }
 461 }
 462
 463 static inline void ofd_fid_from_resid(struct lu_fid *fid,
 464                                       const struct ldlm_res_id *name)
 465 {
 466         /* if seq is FID_SEQ_OST_MDT0 then we have IDIF and resid was built
 467          * using osc_build_res_name function. */
 468         if (fid_seq_is_mdt0(name->name[LUSTRE_RES_ID_VER_OID_OFF])) {
 469                 struct ost_id ostid;
 470
 471                 ostid.oi_id = name->name[LUSTRE_RES_ID_SEQ_OFF];
 472                 ostid.oi_seq = name->name[LUSTRE_RES_ID_VER_OID_OFF];
 473                 fid_ostid_unpack(fid, &ostid, 0);
 474         } else {
 475                 fid->f_seq = name->name[LUSTRE_RES_ID_SEQ_OFF];
 476                 fid->f_oid = (__u32)name->name[LUSTRE_RES_ID_VER_OID_OFF];
 477                 fid->f_ver = name->name[LUSTRE_RES_ID_VER_OID_OFF] >> 32;
 478         }
 479 }
 480
 481 /* sync on lock cancel is useless when we force a journal flush,
 482  * and if we enable async journal commit, we should also turn on
 483  * sync on lock cancel if it is not enabled already. */
 484 static inline void ofd_slc_set(struct ofd_device *ofd)
 485 {
 486         if (ofd->ofd_syncjournal == 1)
 487                 ofd->ofd_sync_lock_cancel = NEVER_SYNC_ON_CANCEL;
 488         else if (ofd->ofd_sync_lock_cancel == NEVER_SYNC_ON_CANCEL)
 489                 ofd->ofd_sync_lock_cancel = ALWAYS_SYNC_ON_CANCEL;
 490 }
 491
 492 static inline void ofd_prepare_fidea(struct filter_fid *ff, struct obdo *oa)
 493 {
 494         if (!(oa->o_valid & OBD_MD_FLGROUP))
 495                 oa->o_seq = 0;
 496         /* packing fid and converting it to LE for storing into EA.
 497          * Here ->o_stripe_idx should be filled by LOV and rest of
 498          * fields - by client. */
 499         ff->ff_parent.f_seq = cpu_to_le64(oa->o_parent_seq);
 500         ff->ff_parent.f_oid = cpu_to_le32(oa->o_parent_oid);
 501         /* XXX: we are ignoring o_parent_ver here, since this should
 502          *      be the same for all objects in this fileset. */
 503         ff->ff_parent.f_ver = cpu_to_le32(oa->o_stripe_idx);
 504         ff->ff_objid = cpu_to_le64(oa->o_id);
 505         ff->ff_seq = cpu_to_le64(oa->o_seq);
 506 }
 507
 508 /* niobuf_local has no rnb_ prefix in master */
 509 #define rnb_offset offset
 510 #define rnb_flags  flags
 511 #define rnb_len    len
 512
 513 #endif /* _OFD_INTERNAL_H */