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