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.gnu.org/licenses/gpl-2.0.html
  19  *
  20  * GPL HEADER END
  21  */
  22 /*
  23  * Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
  24  * Use is subject to license terms.
  25  *
  26  * Copyright (c) 2012, 2017, Intel Corporation.
  27  */
  28 /*
  29  * This file is part of Lustre, http://www.lustre.org/
  30  * Lustre is a trademark of Sun Microsystems, Inc.
  31  */
  32
  33 #ifndef _OFD_INTERNAL_H
  34 #define _OFD_INTERNAL_H
  35
  36 #include <obd.h>
  37 #include <obd_class.h>
  38 #include <dt_object.h>
  39 #include <md_object.h>
  40 #include <lustre_fid.h>
  41
  42 #define OFD_INIT_OBJID  0
  43 #define OFD_PRECREATE_BATCH_DEFAULT (OBJ_SUBDIR_COUNT * 4)
  44
  45 /* on small filesystems we should not precreate too many objects in
  46  * a single transaction, otherwise we can overflow transactions */
  47 #define OFD_PRECREATE_SMALL_FS          (1024ULL * 1024 * 1024)
  48 #define OFD_PRECREATE_BATCH_SMALL       8
  49
  50 /* Limit the returned fields marked valid to those that we actually might set */
  51 #define OFD_VALID_FLAGS (LA_TYPE | LA_MODE | LA_SIZE | LA_BLOCKS | \
  52                          LA_BLKSIZE | LA_ATIME | LA_MTIME | LA_CTIME)
  53
  54 /* per-client-per-object persistent state (LRU) */
  55 struct ofd_mod_data {
  56         struct list_head fmd_list;        /* linked to fed_mod_list */
  57         struct lu_fid    fmd_fid;         /* FID being written to */
  58         __u64            fmd_mactime_xid; /* xid highest {m,a,c}time setattr */
  59         time64_t         fmd_expire;      /* time when the fmd should expire */
  60         int              fmd_refcount;    /* reference counter - list holds 1 */
  61 };
  62
  63 #define OFD_FMD_MAX_NUM_DEFAULT 128
  64 #define OFD_FMD_MAX_AGE_DEFAULT (obd_timeout + 10)
  65
  66 #define OFD_SOFT_SYNC_LIMIT_DEFAULT 16
  67
  68 /* request stats */
  69 enum {
  70         LPROC_OFD_STATS_READ = 0,
  71         LPROC_OFD_STATS_WRITE,
  72         LPROC_OFD_STATS_GETATTR,
  73         LPROC_OFD_STATS_SETATTR,
  74         LPROC_OFD_STATS_PUNCH,
  75         LPROC_OFD_STATS_SYNC,
  76         LPROC_OFD_STATS_DESTROY,
  77         LPROC_OFD_STATS_CREATE,
  78         LPROC_OFD_STATS_STATFS,
  79         LPROC_OFD_STATS_GET_INFO,
  80         LPROC_OFD_STATS_SET_INFO,
  81         LPROC_OFD_STATS_QUOTACTL,
  82         LPROC_OFD_STATS_LAST,
  83 };
  84
  85 static inline void ofd_counter_incr(struct obd_export *exp, int opcode,
  86                                     char *jobid, long amount)
  87 {
  88         if (exp->exp_obd && exp->exp_obd->obd_stats)
  89                 lprocfs_counter_add(exp->exp_obd->obd_stats, opcode, amount);
  90
  91         if (exp->exp_obd && exp->exp_obd->u.obt.obt_jobstats.ojs_hash &&
  92             (exp_connect_flags(exp) & OBD_CONNECT_JOBSTATS))
  93                 lprocfs_job_stats_log(exp->exp_obd, jobid, opcode, amount);
  94
  95         if (exp->exp_nid_stats != NULL &&
  96             exp->exp_nid_stats->nid_stats != NULL) {
  97                 lprocfs_counter_add(exp->exp_nid_stats->nid_stats, opcode,
  98                                     amount);
  99         }
 100 }
 101
 102 struct ofd_seq {
 103         struct list_head        os_list;
 104         struct ost_id           os_oi;
 105         spinlock_t              os_last_oid_lock;
 106         struct mutex            os_create_lock;
 107         atomic_t                os_refc;
 108         struct dt_object        *os_lastid_obj;
 109         unsigned long           os_destroys_in_progress:1,
 110                                 os_last_id_synced:1;
 111 };
 112
 113 struct ofd_device {
 114         struct dt_device         ofd_dt_dev;
 115         struct dt_device        *ofd_osd;
 116         struct obd_export       *ofd_osd_exp;
 117         /* DLM name-space for meta-data locks maintained by this server */
 118         struct ldlm_namespace   *ofd_namespace;
 119
 120         /* last_rcvd file */
 121         struct lu_target         ofd_lut;
 122         struct dt_object        *ofd_health_check_file;
 123         struct local_oid_storage *ofd_los;
 124
 125         __u64                    ofd_inconsistency_self_detected;
 126         __u64                    ofd_inconsistency_self_repaired;
 127
 128         struct list_head        ofd_seq_list;
 129         rwlock_t                ofd_seq_list_lock;
 130         int                     ofd_seq_count;
 131         int                     ofd_precreate_batch;
 132         spinlock_t              ofd_batch_lock;
 133
 134         /* preferred BRW size, decided by storage type and capability */
 135         __u32                    ofd_brw_size;
 136         /* checksum types supported on this node */
 137         enum cksum_types         ofd_cksum_types_supported;
 138
 139         /* ofd mod data: ofd_device wide values */
 140         int                      ofd_fmd_max_num; /* per ofd ofd_mod_data */
 141         time64_t                 ofd_fmd_max_age; /* time to fmd expiry */
 142
 143         spinlock_t               ofd_flags_lock;
 144         unsigned long            ofd_raid_degraded:1,
 145                                  /* sync journal on writes */
 146                                  ofd_sync_journal:1,
 147                                  /* Protected by ofd_lastid_rwsem. */
 148                                  ofd_lastid_rebuilding:1,
 149                                  ofd_record_fid_accessed:1,
 150                                  ofd_lfsck_verify_pfid:1,
 151                                  ofd_skip_lfsck:1,
 152                                  /* Whether to enforce T10PI checksum of RPC */
 153                                  ofd_checksum_t10pi_enforce:1;
 154         struct seq_server_site   ofd_seq_site;
 155         /* the limit of SOFT_SYNC RPCs that will trigger a soft sync */
 156         unsigned int             ofd_soft_sync_limit;
 157         /* Protect ::ofd_lastid_rebuilding */
 158         struct rw_semaphore      ofd_lastid_rwsem;
 159         __u64                    ofd_lastid_gen;
 160         struct ptlrpc_thread     ofd_inconsistency_thread;
 161         struct list_head         ofd_inconsistency_list;
 162         spinlock_t               ofd_inconsistency_lock;
 163         /* Backwards compatibility */
 164         struct attribute        *ofd_read_cache_enable;
 165         struct attribute        *ofd_read_cache_max_filesize;
 166         struct attribute        *ofd_write_cache_enable;
 167 };
 168
 169 static inline struct ofd_device *ofd_dev(struct lu_device *d)
 170 {
 171         return container_of0(d, struct ofd_device, ofd_dt_dev.dd_lu_dev);
 172 }
 173
 174 static inline struct obd_device *ofd_obd(struct ofd_device *ofd)
 175 {
 176         return ofd->ofd_dt_dev.dd_lu_dev.ld_obd;
 177 }
 178
 179 static inline struct ofd_device *ofd_exp(struct obd_export *exp)
 180 {
 181         return ofd_dev(exp->exp_obd->obd_lu_dev);
 182 }
 183
 184 static inline char *ofd_name(struct ofd_device *ofd)
 185 {
 186         return ofd->ofd_dt_dev.dd_lu_dev.ld_obd->obd_name;
 187 }
 188
 189 struct ofd_object {
 190         struct lu_object_header ofo_header;
 191         struct dt_object        ofo_obj;
 192         struct filter_fid       ofo_ff;
 193         unsigned int            ofo_pfid_checking:1,
 194                                 ofo_pfid_verified:1;
 195 };
 196
 197 static inline struct ofd_object *ofd_obj(struct lu_object *o)
 198 {
 199         return container_of0(o, struct ofd_object, ofo_obj.do_lu);
 200 }
 201
 202 static inline int ofd_object_exists(struct ofd_object *obj)
 203 {
 204         LASSERT(obj != NULL);
 205         if (lu_object_is_dying(obj->ofo_obj.do_lu.lo_header))
 206                 return 0;
 207         return lu_object_exists(&obj->ofo_obj.do_lu);
 208 }
 209
 210 static inline struct dt_object *fo2dt(struct ofd_object *obj)
 211 {
 212         return &obj->ofo_obj;
 213 }
 214
 215 static inline struct dt_object *ofd_object_child(struct ofd_object *_obj)
 216 {
 217         struct lu_object *lu = &(_obj)->ofo_obj.do_lu;
 218
 219         return container_of0(lu_object_next(lu), struct dt_object, do_lu);
 220 }
 221
 222 static inline struct ofd_device *ofd_obj2dev(const struct ofd_object *fo)
 223 {
 224         return ofd_dev(fo->ofo_obj.do_lu.lo_dev);
 225 }
 226
 227 static inline void ofd_read_lock(const struct lu_env *env,
 228                                  struct ofd_object *fo)
 229 {
 230         struct dt_object  *next = ofd_object_child(fo);
 231
 232         next->do_ops->do_read_lock(env, next, 0);
 233 }
 234
 235 static inline void ofd_read_unlock(const struct lu_env *env,
 236                                    struct ofd_object *fo)
 237 {
 238         struct dt_object  *next = ofd_object_child(fo);
 239
 240         next->do_ops->do_read_unlock(env, next);
 241 }
 242
 243 static inline void ofd_write_lock(const struct lu_env *env,
 244                                   struct ofd_object *fo)
 245 {
 246         struct dt_object *next = ofd_object_child(fo);
 247
 248         next->do_ops->do_write_lock(env, next, 0);
 249 }
 250
 251 static inline void ofd_write_unlock(const struct lu_env *env,
 252                                     struct ofd_object *fo)
 253 {
 254         struct dt_object  *next = ofd_object_child(fo);
 255
 256         next->do_ops->do_write_unlock(env, next);
 257 }
 258
 259 /*
 260  * Common data shared by obdofd-level handlers. This is allocated per-thread
 261  * to reduce stack consumption.
 262  */
 263 struct ofd_thread_info {
 264         const struct lu_env             *fti_env;
 265
 266         struct obd_export               *fti_exp;
 267         __u64                            fti_xid;
 268         __u64                            fti_pre_version;
 269
 270         struct lu_fid                    fti_fid;
 271         struct lu_attr                   fti_attr;
 272         struct lu_attr                   fti_attr2;
 273         struct ldlm_res_id               fti_resid;
 274         struct filter_fid                fti_mds_fid;
 275         struct ost_id                    fti_ostid;
 276         struct ofd_object               *fti_obj;
 277         union {
 278                 char                     name[64]; /* for ofd_init0() */
 279                 struct obd_statfs        osfs;    /* for obdofd_statfs() */
 280         } fti_u;
 281
 282         /* Ops object filename */
 283         struct lu_name                   fti_name;
 284         struct dt_object_format          fti_dof;
 285         struct lu_buf                    fti_buf;
 286         loff_t                           fti_off;
 287
 288         struct ost_lvb                   fti_lvb;
 289         union {
 290                 struct lfsck_req_local   fti_lrl;
 291                 struct obd_connect_data  fti_ocd;
 292         };
 293 };
 294
 295 extern void target_recovery_fini(struct obd_device *obd);
 296 extern void target_recovery_init(struct lu_target *lut, svc_handler_t handler);
 297
 298 /* ofd_dev.c */
 299 extern struct lu_context_key ofd_thread_key;
 300 int ofd_postrecov(const struct lu_env *env, struct ofd_device *ofd);
 301 int ofd_fiemap_get(const struct lu_env *env, struct ofd_device *ofd,
 302                    struct lu_fid *fid, struct fiemap *fiemap);
 303
 304 /* ofd_obd.c */
 305 extern struct obd_ops ofd_obd_ops;
 306 int ofd_destroy_by_fid(const struct lu_env *env, struct ofd_device *ofd,
 307                        const struct lu_fid *fid, int orphan);
 308 int ofd_statfs(const struct lu_env *env,  struct obd_export *exp,
 309                struct obd_statfs *osfs, time64_t max_age, __u32 flags);
 310 int ofd_obd_disconnect(struct obd_export *exp);
 311
 312 /* ofd_fs.c */
 313 u64 ofd_seq_last_oid(struct ofd_seq *oseq);
 314 void ofd_seq_last_oid_set(struct ofd_seq *oseq, u64 id);
 315 int ofd_seq_last_oid_write(const struct lu_env *env, struct ofd_device *ofd,
 316                            struct ofd_seq *oseq);
 317 int ofd_seqs_init(const struct lu_env *env, struct ofd_device *ofd);
 318 struct ofd_seq *ofd_seq_get(struct ofd_device *ofd, u64 seq);
 319 void ofd_seq_put(const struct lu_env *env, struct ofd_seq *oseq);
 320
 321 int ofd_fs_setup(const struct lu_env *env, struct ofd_device *ofd,
 322                  struct obd_device *obd);
 323 void ofd_fs_cleanup(const struct lu_env *env, struct ofd_device *ofd);
 324 int ofd_precreate_batch(struct ofd_device *ofd, int batch);
 325 struct ofd_seq *ofd_seq_load(const struct lu_env *env, struct ofd_device *ofd,
 326                              u64 seq);
 327 void ofd_seqs_fini(const struct lu_env *env, struct ofd_device *ofd);
 328 void ofd_seqs_free(const struct lu_env *env, struct ofd_device *ofd);
 329
 330 /* ofd_io.c */
 331 int ofd_start_inconsistency_verification_thread(struct ofd_device *ofd);
 332 int ofd_stop_inconsistency_verification_thread(struct ofd_device *ofd);
 333 int ofd_verify_ff(const struct lu_env *env, struct ofd_object *fo,
 334                   struct obdo *oa);
 335 int ofd_verify_layout_version(const struct lu_env *env,
 336                               struct ofd_object *fo, const struct obdo *oa);
 337 int ofd_preprw(const struct lu_env *env,int cmd, struct obd_export *exp,
 338                struct obdo *oa, int objcount, struct obd_ioobj *obj,
 339                struct niobuf_remote *rnb, int *nr_local,
 340                struct niobuf_local *lnb);
 341 int ofd_commitrw(const struct lu_env *env, int cmd, struct obd_export *exp,
 342                  struct obdo *oa, int objcount, struct obd_ioobj *obj,
 343                  struct niobuf_remote *rnb, int npages,
 344                  struct niobuf_local *lnb, int old_rc);
 345
 346 /* ofd_trans.c */
 347 struct thandle *ofd_trans_create(const struct lu_env *env,
 348                                  struct ofd_device *ofd);
 349 int ofd_trans_start(const struct lu_env *env,
 350                     struct ofd_device *ofd, struct ofd_object *fo,
 351                     struct thandle *th);
 352 int ofd_trans_stop(const struct lu_env *env, struct ofd_device *ofd,
 353                     struct thandle *th, int rc);
 354 int ofd_txn_stop_cb(const struct lu_env *env, struct thandle *txn,
 355                     void *cookie);
 356
 357 /* lproc_ofd.c */
 358 int ofd_tunables_init(struct ofd_device *ofd);
 359 #ifdef CONFIG_PROC_FS
 360 void ofd_stats_counter_init(struct lprocfs_stats *stats);
 361 #else
 362 static inline void ofd_stats_counter_init(struct lprocfs_stats *stats) {}
 363 #endif
 364
 365 /* ofd_objects.c */
 366 struct ofd_object *ofd_object_find(const struct lu_env *env,
 367                                    struct ofd_device *ofd,
 368                                    const struct lu_fid *fid);
 369 int ofd_object_ff_load(const struct lu_env *env, struct ofd_object *fo);
 370 int ofd_object_ff_update(const struct lu_env *env, struct ofd_object *fo,
 371                          const struct obdo *oa, struct filter_fid *ff);
 372 int ofd_precreate_objects(const struct lu_env *env, struct ofd_device *ofd,
 373                           u64 id, struct ofd_seq *oseq, int nr, int sync);
 374
 375 static inline void ofd_object_put(const struct lu_env *env,
 376                                   struct ofd_object *fo)
 377 {
 378         dt_object_put(env, &fo->ofo_obj);
 379 }
 380 int ofd_attr_set(const struct lu_env *env, struct ofd_object *fo,
 381                  struct lu_attr *la, struct obdo *oa);
 382 int ofd_object_punch(const struct lu_env *env, struct ofd_object *fo,
 383                      __u64 start, __u64 end, struct lu_attr *la,
 384                      struct obdo *oa);
 385 int ofd_destroy(const struct lu_env *, struct ofd_object *, int);
 386 int ofd_attr_get(const struct lu_env *env, struct ofd_object *fo,
 387                  struct lu_attr *la);
 388 int ofd_attr_handle_id(const struct lu_env *env, struct ofd_object *fo,
 389                          struct lu_attr *la, int is_setattr);
 390
 391 static inline
 392 struct ofd_object *ofd_object_find_exists(const struct lu_env *env,
 393                                           struct ofd_device *ofd,
 394                                           const struct lu_fid *fid)
 395 {
 396         struct ofd_object *fo;
 397
 398         fo = ofd_object_find(env, ofd, fid);
 399         if (!IS_ERR(fo) && !ofd_object_exists(fo)) {
 400                 ofd_object_put(env, fo);
 401                 fo = ERR_PTR(-ENOENT);
 402         }
 403         return fo;
 404 }
 405
 406 /* ofd_fmd.c */
 407 int ofd_fmd_init(void);
 408 void ofd_fmd_exit(void);
 409 struct ofd_mod_data *ofd_fmd_find(struct obd_export *exp,
 410                                   const struct lu_fid *fid);
 411 struct ofd_mod_data *ofd_fmd_get(struct obd_export *exp,
 412                                  const struct lu_fid *fid);
 413 void ofd_fmd_put(struct obd_export *exp, struct ofd_mod_data *fmd);
 414 void ofd_fmd_expire(struct obd_export *exp);
 415 void ofd_fmd_cleanup(struct obd_export *exp);
 416 #ifdef DO_FMD_DROP
 417 void ofd_fmd_drop(struct obd_export *exp, const struct lu_fid *fid);
 418 #else
 419 #define ofd_fmd_drop(exp, fid) do {} while (0)
 420 #endif
 421
 422 /* ofd_dev.c */
 423 int ofd_fid_set_index(const struct lu_env *env, struct ofd_device *ofd,
 424                       int index);
 425 int ofd_fid_init(const struct lu_env *env, struct ofd_device *ofd);
 426 int ofd_fid_fini(const struct lu_env *env, struct ofd_device *ofd);
 427
 428 /* ofd_lvb.c */
 429 extern struct ldlm_valblock_ops ofd_lvbo;
 430
 431 /* ofd_dlm.c */
 432 extern struct kmem_cache *ldlm_glimpse_work_kmem;
 433
 434 int ofd_intent_policy(const struct lu_env *env, struct ldlm_namespace *ns,
 435                       struct ldlm_lock **lockp, void *req_cookie,
 436                       enum ldlm_mode mode, __u64 flags, void *data);
 437
 438 static inline struct ofd_thread_info *ofd_info(const struct lu_env *env)
 439 {
 440         struct ofd_thread_info *info;
 441
 442         lu_env_refill((void *)env);
 443         info = lu_context_key_get(&env->le_ctx, &ofd_thread_key);
 444         LASSERT(info);
 445         return info;
 446 }
 447
 448 static inline struct ofd_thread_info *ofd_info_init(const struct lu_env *env,
 449                                                     struct obd_export *exp)
 450 {
 451         struct ofd_thread_info *info;
 452
 453         info = ofd_info(env);
 454         LASSERT(info->fti_exp == NULL);
 455         LASSERT(info->fti_env == NULL);
 456         LASSERT(info->fti_attr.la_valid == 0);
 457
 458         info->fti_env = env;
 459         info->fti_exp = exp;
 460         info->fti_pre_version = 0;
 461         return info;
 462 }
 463
 464 static inline struct ofd_thread_info *tsi2ofd_info(struct tgt_session_info *tsi)
 465 {
 466         struct ptlrpc_request   *req = tgt_ses_req(tsi);
 467         struct ofd_thread_info  *info;
 468
 469         info = ofd_info(tsi->tsi_env);
 470         LASSERT(info->fti_exp == NULL);
 471         LASSERT(info->fti_env == NULL);
 472         LASSERT(info->fti_attr.la_valid == 0);
 473
 474         info->fti_env = tsi->tsi_env;
 475         info->fti_exp = tsi->tsi_exp;
 476
 477         info->fti_xid = req->rq_xid;
 478         /** VBR: take versions from request */
 479         if (req->rq_reqmsg != NULL &&
 480             lustre_msg_get_flags(req->rq_reqmsg) & MSG_REPLAY) {
 481                 __u64 *pre_version = lustre_msg_get_versions(req->rq_reqmsg);
 482
 483                 info->fti_pre_version = pre_version ? pre_version[0] : 0;
 484         }
 485         return info;
 486 }
 487
 488 /* sync on lock cancel is useless when we force a journal flush,
 489  * and if we enable async journal commit, we should also turn on
 490  * sync on lock cancel if it is not enabled already. */
 491 static inline void ofd_slc_set(struct ofd_device *ofd)
 492 {
 493         if (ofd->ofd_sync_journal == 1)
 494                 ofd->ofd_lut.lut_sync_lock_cancel = NEVER_SYNC_ON_CANCEL;
 495         else if (ofd->ofd_lut.lut_sync_lock_cancel == NEVER_SYNC_ON_CANCEL)
 496                 ofd->ofd_lut.lut_sync_lock_cancel = ALWAYS_SYNC_ON_CANCEL;
 497 }
 498
 499 static inline int ofd_validate_seq(struct obd_export *exp, __u64 seq)
 500 {
 501         struct filter_export_data *fed = &exp->exp_filter_data;
 502
 503         if (unlikely(seq == FID_SEQ_OST_MDT0 && fed->fed_group != 0)) {
 504                 /* IDIF request only operates on MDT0 group */
 505                 CERROR("%s: Invalid sequence %#llx for group %u\n",
 506                        exp->exp_obd->obd_name, seq, fed->fed_group);
 507                 RETURN(-EINVAL);
 508         }
 509
 510         return 0;
 511 }
 512 #endif /* _OFD_INTERNAL_H */