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