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