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