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