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