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