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