lustre/lfsck/lfsck_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,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License version 2 for more details.  A copy is
  14  * included in the COPYING file that accompanied this code.
  15
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  19  *
  20  * GPL HEADER END
  21  */
  22 /*
  23  * Copyright (c) 2013, 2017, Intel Corporation.
  24  */
  25 /*
  26  * lustre/lfsck/lfsck_internal.h
  27  *
  28  * Shared definitions and declarations for the LFSCK.
  29  *
  30  * Author: Fan, Yong <fan.yong@intel.com>
  31  */
  32
  33 #ifndef _LFSCK_INTERNAL_H
  34 # define _LFSCK_INTERNAL_H
  35
  36 #include <lustre_lfsck.h>
  37 #include <obd.h>
  38 #include <lu_object.h>
  39 #include <dt_object.h>
  40 #include <md_object.h>
  41 #include <lustre_net.h>
  42 #include <lustre_dlm.h>
  43 #include <lustre_fid.h>
  44 #include <md_object.h>
  45 #include <lustre_linkea.h>
  46
  47 #define LFSCK_CHECKPOINT_INTERVAL       60
  48
  49 enum lfsck_flags {
  50         /* Finish the first cycle scanning. */
  51         LF_SCANNED_ONCE         = 0x00000001ULL,
  52
  53         /* There is some namespace inconsistency. */
  54         LF_INCONSISTENT         = 0x00000002ULL,
  55
  56         /* The device is upgraded from 1.8 format. */
  57         LF_UPGRADE              = 0x00000004ULL,
  58
  59         /* The server ever restarted during the LFSCK, and may miss to process
  60          * some objects check/repair. */
  61         LF_INCOMPLETE           = 0x00000008ULL,
  62
  63         /* The LAST_ID (file) crashed. */
  64         LF_CRASHED_LASTID       = 0x00000010ULL,
  65 };
  66
  67 struct lfsck_position {
  68         /* low layer object table-based iteration position. */
  69         __u64   lp_oit_cookie;
  70
  71         /* parent FID for directory traversal. */
  72         struct lu_fid lp_dir_parent;
  73
  74         /* namespace-based directory traversal position. */
  75         __u64   lp_dir_cookie;
  76 };
  77
  78 struct lfsck_bookmark {
  79         /* Magic number to detect that this struct contains valid data. */
  80         __u32   lb_magic;
  81
  82         /* For compatible with old versions. */
  83         __u16   lb_version;
  84
  85         /* See 'enum lfsck_param_flags' */
  86         __u16   lb_param;
  87
  88         /* How many items can be scanned at most per second. */
  89         __u32   lb_speed_limit;
  90
  91         /* The windows size for async requests pipeline. */
  92         __u16   lb_async_windows;
  93
  94         /* For 64-bits aligned. */
  95         __u16   lb_padding;
  96
  97         /* The FID for .lustre/lost+found/MDTxxxx */
  98         struct lu_fid   lb_lpf_fid;
  99
 100         /* The FID for the last MDT-object created by the LFSCK repairing. */
 101         struct lu_fid   lb_last_fid;
 102
 103         /* For future using. */
 104         __u64   lb_reserved[2];
 105 };
 106
 107 enum lfsck_namespace_trace_flags {
 108         LNTF_CHECK_LINKEA       = 0x01,
 109         LNTF_CHECK_PARENT       = 0x02,
 110         LNTF_CHECK_ORPHAN       = 0x08,
 111         LNTF_UNCERTAIN_LMV      = 0x10,
 112         LNTF_RECHECK_NAME_HASH  = 0x20,
 113         LNTF_CHECK_AGENT_ENTRY  = 0x40,
 114         LNTF_ALL                = 0xff
 115 };
 116
 117 enum lfsck_namespace_inconsistency_type {
 118         LNIT_NONE               = 0,
 119         LNIT_BAD_LINKEA         = 1,
 120         LNIT_UNMATCHED_PAIRS    = 2,
 121         LNIT_DANGLING           = 3,
 122         LNIT_MUL_REF            = 4,
 123         LNIT_BAD_TYPE           = 5,
 124         LNIT_BAD_DIRENT         = 6,
 125 };
 126
 127 struct lfsck_namespace {
 128         /* Magic number to detect that this struct contains valid data. */
 129         __u32   ln_magic;
 130
 131         /* See 'enum lfsck_status'. */
 132         __u32   ln_status;
 133
 134         /* See 'enum lfsck_flags'. */
 135         __u32   ln_flags;
 136
 137         /* How many completed LFSCK runs on the device. */
 138         __u32   ln_success_count;
 139
 140         /*  How long the LFSCK phase1 has run in seconds. */
 141         time64_t ln_run_time_phase1;
 142
 143         /*  How long the LFSCK phase2 has run in seconds. */
 144         time64_t ln_run_time_phase2;
 145
 146         /* Time for the last LFSCK completed in seconds since epoch. */
 147         time64_t ln_time_last_complete;
 148
 149         /* Time for the latest LFSCK ran in seconds since epoch. */
 150         time64_t ln_time_latest_start;
 151
 152         /* Time for the last LFSCK checkpoint in seconds since epoch. */
 153         time64_t ln_time_last_checkpoint;
 154
 155         /* Position for the latest LFSCK started from. */
 156         struct lfsck_position   ln_pos_latest_start;
 157
 158         /* Position for the last LFSCK checkpoint. */
 159         struct lfsck_position   ln_pos_last_checkpoint;
 160
 161         /* Position for the first should be updated object. */
 162         struct lfsck_position   ln_pos_first_inconsistent;
 163
 164         /* How many items (including dir) have been checked. */
 165         __u64   ln_items_checked;
 166
 167         /* How many items have been repaired. */
 168         __u64   ln_items_repaired;
 169
 170         /* How many items failed to be processed. */
 171         __u64   ln_items_failed;
 172
 173         /* How many directories have been traversed. */
 174         __u64   ln_dirs_checked;
 175
 176         /* How many objects have been double scanned. */
 177         __u64   ln_objs_checked_phase2;
 178
 179         /* How many objects have been reparied during double scan. */
 180         __u64   ln_objs_repaired_phase2;
 181
 182         /* How many objects failed to be processed during double scan. */
 183         __u64   ln_objs_failed_phase2;
 184
 185         /* How many objects with nlink fixed. */
 186         __u64   ln_objs_nlink_repaired;
 187
 188         /* The latest object has been processed (failed) during double scan. */
 189         struct lu_fid   ln_fid_latest_scanned_phase2;
 190
 191         /* How many FID-in-dirent entries have been repaired. */
 192         __u64   ln_dirent_repaired;
 193
 194         /* How many linkEA entries have been repaired. */
 195         __u64   ln_linkea_repaired;
 196
 197         /* How many multiple-linked objects have been checked. */
 198         __u64   ln_mul_linked_checked;
 199
 200         /* How many multiple-linked objects have been repaired. */
 201         __u64   ln_mul_linked_repaired;
 202
 203         /* How many undefined inconsistency found in phase2. */
 204         __u64   ln_unknown_inconsistency;
 205
 206         /* How many unmatched pairs have been repaired. */
 207         __u64   ln_unmatched_pairs_repaired;
 208
 209         /* How many dangling name entries have been found/repaired. */
 210         __u64   ln_dangling_repaired;
 211
 212         /* How many multiple referenced name entries have been
 213          * found/repaired. */
 214         __u64   ln_mul_ref_repaired;
 215
 216         /* How many name entries with bad file type have been repaired. */
 217         __u64   ln_bad_type_repaired;
 218
 219         /* How many lost name entries have been re-inserted. */
 220         __u64   ln_lost_dirent_repaired;
 221
 222         /* How many objects under /lost+found have been scanned. */
 223         __u64   ln_local_lpf_scanned;
 224
 225         /* How many objects under /lost+found have been moved to
 226          * namespace visible directory. */
 227         __u64   ln_local_lpf_moved;
 228
 229         /* How many objects under /lost+found have been skipped. */
 230         __u64   ln_local_lpf_skipped;
 231
 232         /* How many objects under /lost+found failed to be processed. */
 233         __u64   ln_local_lpf_failed;
 234
 235         /* How many striped directories (master) have been scanned. */
 236         __u64   ln_striped_dirs_scanned;
 237
 238         /* How many striped directories (master) have been repaired. */
 239         __u64   ln_striped_dirs_repaired;
 240
 241         /* How many striped directories (master) failed verification. */
 242         __u64   ln_striped_dirs_failed;
 243
 244         /* How many striped directories (master) has been disabled. */
 245         __u64   ln_striped_dirs_disabled;
 246
 247         /* How many striped directory's (master) have been skipped
 248          * (for shards verification) because of lost master LMV EA. */
 249         __u64   ln_striped_dirs_skipped;
 250
 251         /* How many striped directory's shards (slave) have been scanned. */
 252         __u64   ln_striped_shards_scanned;
 253
 254         /* How many striped directory's shards (slave) have been repaired. */
 255         __u64   ln_striped_shards_repaired;
 256
 257         /* How many striped directory's shards (slave) failed verification. */
 258         __u64   ln_striped_shards_failed;
 259
 260         /* How many striped directory's shards (slave) have been skipped
 261          * (for name hash verification) because do not know whether the slave
 262          * LMV EA is valid or not. */
 263         __u64   ln_striped_shards_skipped;
 264
 265         /* How many name entries under striped directory with bad name
 266          * hash have been repaired. */
 267         __u64   ln_name_hash_repaired;
 268
 269         /* The size of MDT targets bitmap with nbits. Such bitmap records
 270          * the MDTs that contain non-verified MDT-objects. */
 271         __u32   ln_bitmap_size;
 272
 273         /* For further using. 256-bytes aligned now. */
 274         __u32   ln_reserved_1;
 275
 276         /* Time for the latest LFSCK scan in seconds from the beginning. */
 277         time64_t ln_time_latest_reset;
 278
 279         /* How many linkEA overflow timestamp have been cleared. */
 280         __u64   ln_linkea_overflow_cleared;
 281
 282         /* How many agent entries have been repaired. */
 283         __u64   ln_agent_entries_repaired;
 284
 285         /* For further using. 256-bytes aligned now. */
 286         __u64   ln_reserved[11];
 287 };
 288
 289 enum lfsck_layout_inconsistency_type {
 290         LLIT_NONE                       = 0,
 291         LLIT_DANGLING                   = 1,
 292         LLIT_UNMATCHED_PAIR             = 2,
 293         LLIT_MULTIPLE_REFERENCED        = 3,
 294         LLIT_ORPHAN                     = 4,
 295         LLIT_INCONSISTENT_OWNER         = 5,
 296         LLIT_OTHERS                     = 6,
 297         LLIT_MAX                        = LLIT_OTHERS
 298 };
 299
 300 struct lfsck_layout {
 301         /* Magic number to detect that this struct contains valid data. */
 302         __u32   ll_magic;
 303
 304         /* See 'enum lfsck_status'. */
 305         __u32   ll_status;
 306
 307         /* See 'enum lfsck_flags'. */
 308         __u32   ll_flags;
 309
 310         /* How many completed LFSCK runs on the device. */
 311         __u32   ll_success_count;
 312
 313         /*  How long the LFSCK phase1 has run in seconds. */
 314         time64_t ll_run_time_phase1;
 315
 316         /*  How long the LFSCK phase2 has run in seconds. */
 317         time64_t ll_run_time_phase2;
 318
 319         /* Time for the last LFSCK completed in seconds since epoch. */
 320         time64_t ll_time_last_complete;
 321
 322         /* Time for the latest LFSCK ran in seconds since epoch. */
 323         time64_t ll_time_latest_start;
 324
 325         /* Time for the last LFSCK checkpoint in seconds since epoch. */
 326         time64_t ll_time_last_checkpoint;
 327
 328         /* Position for the latest LFSCK started from. */
 329         __u64   ll_pos_latest_start;
 330
 331         /* Position for the last LFSCK checkpoint. */
 332         __u64   ll_pos_last_checkpoint;
 333
 334         /* Position for the first object to be fixed or
 335          * failed to be checked in the phase1. */
 336         __u64   ll_pos_first_inconsistent;
 337
 338         /* How many objects have been checked. */
 339         __u64   ll_objs_checked_phase1;
 340
 341         /* How many objects failed to be processed. */
 342         __u64   ll_objs_failed_phase1;
 343
 344         /* How many objects have been double scanned. */
 345         __u64   ll_objs_checked_phase2;
 346
 347         /* How many objects failed to be processed during double scan. */
 348         __u64   ll_objs_failed_phase2;
 349
 350         /* kinds of inconsistency have been or to be repaired.
 351          * ll_objs_repaired[type - 1] is the count for the given @type. */
 352         __u64   ll_objs_repaired[LLIT_MAX];
 353
 354         /* How many objects have been skipped because of related
 355          * MDT(s)/OST(s) do not participate in the LFSCK */
 356         __u64   ll_objs_skipped;
 357
 358         /* The size of ll_ost_bitmap with nbits. */
 359         __u32   ll_bitmap_size;
 360
 361         /* For further using. 256-bytes aligned now. */
 362         __u32   ll_reserved_1;
 363
 364         /* The latest object has been processed (failed) during double scan. */
 365         struct lfsck_layout_dangling_key ll_lldk_latest_scanned_phase2;
 366
 367         /* For further using */
 368         u64     ll_reserved_2[7];
 369
 370         /* The OST targets bitmap to record the OSTs that contain
 371          * non-verified OST-objects. */
 372         __u8    ll_ost_bitmap[0];
 373 };
 374
 375 struct lfsck_assistant_object {
 376         struct lu_fid           lso_fid;
 377         __u64                   lso_oit_cookie;
 378         struct lu_attr          lso_attr;
 379         atomic_t                lso_ref;
 380         unsigned int            lso_dead:1,
 381                                 lso_is_dir:1;
 382 };
 383
 384 struct lfsck_component;
 385 struct lfsck_tgt_descs;
 386 struct lfsck_tgt_desc;
 387
 388 struct lfsck_operations {
 389         int (*lfsck_reset)(const struct lu_env *env,
 390                            struct lfsck_component *com,
 391                            bool init);
 392
 393         void (*lfsck_fail)(const struct lu_env *env,
 394                            struct lfsck_component *com,
 395                            bool new_checked);
 396
 397         void (*lfsck_close_dir)(const struct lu_env *env,
 398                                 struct lfsck_component *com);
 399
 400         int (*lfsck_open_dir)(const struct lu_env *env,
 401                               struct lfsck_component *com);
 402
 403         int (*lfsck_checkpoint)(const struct lu_env *env,
 404                                 struct lfsck_component *com,
 405                                 bool init);
 406
 407         int (*lfsck_prep)(const struct lu_env *env,
 408                           struct lfsck_component *com,
 409                           struct lfsck_start_param *lsp);
 410
 411         int (*lfsck_exec_oit)(const struct lu_env *env,
 412                               struct lfsck_component *com,
 413                               struct dt_object *obj);
 414
 415         int (*lfsck_exec_dir)(const struct lu_env *env,
 416                               struct lfsck_component *com,
 417                               struct lfsck_assistant_object *lso,
 418                               struct lu_dirent *ent,
 419                               __u16 type);
 420
 421         int (*lfsck_post)(const struct lu_env *env,
 422                           struct lfsck_component *com,
 423                           int result,
 424                           bool init);
 425
 426         void (*lfsck_dump)(const struct lu_env *env,
 427                            struct lfsck_component *com,
 428                            struct seq_file *m);
 429
 430         int (*lfsck_double_scan)(const struct lu_env *env,
 431                                  struct lfsck_component *com);
 432
 433         void (*lfsck_data_release)(const struct lu_env *env,
 434                                    struct lfsck_component *com);
 435
 436         void (*lfsck_quit)(const struct lu_env *env,
 437                            struct lfsck_component *com);
 438
 439         int (*lfsck_in_notify_local)(const struct lu_env *env,
 440                                      struct lfsck_component *com,
 441                                      struct lfsck_req_local *lrl,
 442                                      struct thandle *th);
 443
 444         int (*lfsck_in_notify)(const struct lu_env *env,
 445                                struct lfsck_component *com,
 446                                struct lfsck_request *lr);
 447
 448         int (*lfsck_query)(const struct lu_env *env,
 449                            struct lfsck_component *com,
 450                            struct lfsck_request *req,
 451                            struct lfsck_reply *rep,
 452                            struct lfsck_query *que, int idx);
 453
 454         int (*lfsck_join)(const struct lu_env *env,
 455                           struct lfsck_component *com,
 456                           struct lfsck_start_param *lsp);
 457 };
 458
 459 struct lfsck_tgt_desc {
 460         struct list_head   ltd_orphan_list;
 461         struct dt_device  *ltd_tgt;
 462         struct dt_device  *ltd_key;
 463         struct obd_export *ltd_exp;
 464         struct list_head   ltd_layout_list;
 465         struct list_head   ltd_layout_phase_list;
 466         struct list_head   ltd_namespace_list;
 467         struct list_head   ltd_namespace_phase_list;
 468         __u32              ltd_layout_status;
 469         __u32              ltd_namespace_status;
 470         __u64              ltd_layout_repaired;
 471         __u64              ltd_namespace_repaired;
 472         atomic_t           ltd_ref;
 473         __u32              ltd_index;
 474         __u32              ltd_layout_gen;
 475         __u32              ltd_namespace_gen;
 476         unsigned int       ltd_dead:1,
 477                            ltd_retry_start:1,
 478                            ltd_layout_done:1,
 479                            ltd_namespace_done:1,
 480                            ltd_synced_failures:1;
 481 };
 482
 483 struct lfsck_tgt_desc_idx {
 484         struct lfsck_tgt_desc *ldi_tgts[TGT_PTRS_PER_BLOCK];
 485 };
 486
 487 struct lfsck_tgt_descs {
 488         /* list of known TGTs */
 489         struct lfsck_tgt_desc_idx       *ltd_tgts_idx[TGT_PTRS];
 490
 491         /* bitmap of TGTs available */
 492         struct cfs_bitmap                       *ltd_tgts_bitmap;
 493
 494         /* for lfsck_tgt_desc::ltd_xxx_list */
 495         spinlock_t                       ltd_lock;
 496
 497         /* for tgts table accessing and changes */
 498         struct rw_semaphore              ltd_rw_sem;
 499
 500         /* Temporary list for orphan targets. */
 501         struct list_head                 ltd_orphan;
 502
 503         /* number of registered TGTs */
 504         __u32                            ltd_tgtnr;
 505 };
 506
 507 static inline struct lfsck_tgt_desc *
 508 lfsck_ltd2tgt(struct lfsck_tgt_descs *ltd, __u32 index)
 509 {
 510         __u32 idx1 = index / TGT_PTRS_PER_BLOCK;
 511         __u32 idx2 = index % TGT_PTRS_PER_BLOCK;
 512         struct lfsck_tgt_desc *__tgt = NULL;
 513
 514         if (unlikely(idx1 >= TGT_PTRS))
 515                 CDEBUG(D_LFSCK, "The target idx %u is invalid.\n", index);
 516         else if (likely(ltd->ltd_tgts_idx[idx1] != NULL))
 517                 __tgt = ltd->ltd_tgts_idx[idx1]->ldi_tgts[idx2];
 518
 519         return __tgt;
 520 }
 521
 522 static inline void lfsck_assign_tgt(struct lfsck_tgt_descs *ltd,
 523                                     struct lfsck_tgt_desc *tgt, __u32 index)
 524 {
 525         __u32 idx1 = index / TGT_PTRS_PER_BLOCK;
 526         __u32 idx2 = index % TGT_PTRS_PER_BLOCK;
 527
 528         if (likely(idx1 < TGT_PTRS && ltd->ltd_tgts_idx[idx1] != NULL))
 529                 ltd->ltd_tgts_idx[idx1]->ldi_tgts[idx2] = tgt;
 530 }
 531
 532 #define LFSCK_STF_BITS  4
 533 /* If want to adjust the LFSCK_STF_COUNT, please change LFSCK_STF_BITS. */
 534 #define LFSCK_STF_COUNT (1 << LFSCK_STF_BITS)
 535
 536 struct lfsck_sub_trace_obj {
 537         struct dt_object        *lsto_obj;
 538         struct mutex             lsto_mutex;
 539 };
 540
 541 struct lfsck_component {
 542         /* into lfsck_instance::li_list_(scan,double_scan,idle} */
 543         struct list_head         lc_link;
 544
 545         /* into lfsck_instance::li_list_dir */
 546         struct list_head         lc_link_dir;
 547
 548         struct rw_semaphore      lc_sem;
 549         atomic_t                 lc_ref;
 550
 551         struct lfsck_position    lc_pos_start;
 552         struct lfsck_instance   *lc_lfsck;
 553         struct dt_object        *lc_obj;
 554         struct lfsck_sub_trace_obj lc_sub_trace_objs[LFSCK_STF_COUNT];
 555         const struct lfsck_operations *lc_ops;
 556         void                    *lc_file_ram;
 557         void                    *lc_file_disk;
 558         void                    *lc_data;
 559         struct lu_fid            lc_fid_latest_scanned_phase2;
 560
 561         /* The time for last checkpoint, seconds */
 562         time64_t                 lc_time_last_checkpoint;
 563
 564         /* The time for next checkpoint, seconds */
 565         time64_t                 lc_time_next_checkpoint;
 566
 567         __u32                    lc_file_size;
 568
 569         /* How many objects have been checked since last checkpoint. */
 570         __u32                    lc_new_checked;
 571
 572         /* How many objects have been scanned since last sleep. */
 573         __u32                    lc_new_scanned;
 574
 575         __u16                    lc_type;
 576 };
 577
 578 #define LFSCK_LMV_MAX_STRIPES   LMV_MAX_STRIPE_COUNT
 579 #define LFSCK_LMV_DEF_STRIPES   4
 580
 581 /* Warning: NOT change the lfsck_slave_lmv_flags members order,
 582  *          otherwise the lfsck_record_lmv() may be wrong. */
 583 enum lfsck_slave_lmv_flags {
 584         LSLF_NONE       = 0,
 585         LSLF_BAD_INDEX2 = 1,
 586         LSLF_NO_LMVEA   = 2,
 587         LSLF_DANGLING   = 3,
 588         LSLF_BAD_INDEX1 = 4,
 589 };
 590
 591 /* When the namespace LFSCK scans a striped directory, it will record all
 592  * the known shards' information in the structure "lfsck_slave_lmv_rec",
 593  * including the shard's FID, index, slave LMV EA, and so on. Each shard
 594  * will take one lfsck_slave_lmv_rec slot. After the 1st cycle scanning
 595  * the striped directory, the LFSCK will get all the information about
 596  * whether there are some inconsistency, and then it can repair them in
 597  * the 2nd cycle scanning. */
 598 struct lfsck_slave_lmv_rec {
 599         struct lu_fid   lslr_fid;
 600         __u32           lslr_stripe_count;
 601         __u32           lslr_index; /* the index in name or in slave lmv */
 602         __u32           lslr_hash_type;
 603         __u32           lslr_flags;
 604 };
 605
 606 struct lfsck_lmv {
 607         struct lmv_mds_md_v1             ll_lmv;
 608         atomic_t                         ll_ref;
 609         int                              ll_stripes_allocated;
 610         int                              ll_stripes_filled;
 611         int                              ll_exit_value;
 612         __u32                            ll_max_stripe_count;
 613         __u32                            ll_max_filled_off;
 614         __u32                            ll_hash_type;
 615         unsigned int                     ll_lmv_master:1,
 616                                          ll_lmv_slave:1,
 617                                          ll_lmv_verified:1,
 618                                          ll_lmv_updated:1,
 619                                          ll_inline:1,
 620                                          ll_failed:1,
 621                                          ll_ignore:1,
 622                                          ll_counted:1;
 623         struct lfsck_slave_lmv_rec      *ll_lslr; /* may be vmalloc'd */
 624 };
 625
 626 /* If the namespace LFSCK finds that the master MDT-object of a striped
 627  * directory lost its master LMV EA, it will re-generate the master LMV
 628  * EA and notify the LFSCK instance on the MDT on which the striped dir
 629  * master MDT-object resides to rescan the striped directory. To do that,
 630  * the notify handler will insert a "lfsck_lmv_unit" structure into the
 631  * lfsck::li_list_lmv. The LFSCK instance will scan such list from time
 632  * to time to check whether needs to rescan some stirped directories. */
 633 struct lfsck_lmv_unit {
 634         struct list_head         llu_link;
 635         struct lfsck_lmv         llu_lmv;
 636         struct dt_object        *llu_obj;
 637         struct lfsck_instance   *llu_lfsck;
 638 };
 639
 640 struct lfsck_rec_lmv_save {
 641         struct lu_fid           lrls_fid;
 642         struct lmv_mds_md_v1    lrls_lmv;
 643 };
 644
 645 /* Allow lfsck_record_lmv() to be called recursively at most three times. */
 646 #define LFSCK_REC_LMV_MAX_DEPTH 3
 647
 648 struct lfsck_instance {
 649         struct mutex              li_mutex;
 650         spinlock_t                li_lock;
 651
 652         /* Link into the lfsck_instance_list. */
 653         struct list_head          li_link;
 654
 655         /* For the components in (first) scanning via otable-based iteration. */
 656         struct list_head          li_list_scan;
 657
 658         /* For the components in scanning via directory traversal. Because
 659          * directory traversal cannot guarantee all the object be scanned,
 660          * so the component in the li_list_dir must be in li_list_scan. */
 661         struct list_head          li_list_dir;
 662
 663         /* For the components in double scanning. */
 664         struct list_head          li_list_double_scan;
 665
 666         /* For the components those are not scanning now. */
 667         struct list_head          li_list_idle;
 668
 669         /* For the lfsck_lmv_unit to be handled. */
 670         struct list_head          li_list_lmv;
 671
 672         atomic_t                  li_ref;
 673         atomic_t                  li_double_scan_count;
 674         struct ptlrpc_thread      li_thread;
 675         struct task_struct       *li_task;
 676
 677         /* The time for last checkpoint, seconds */
 678         time64_t                  li_time_last_checkpoint;
 679
 680         /* The time for next checkpoint, seconds */
 681         time64_t                  li_time_next_checkpoint;
 682
 683         lfsck_out_notify          li_out_notify;
 684         void                     *li_out_notify_data;
 685         struct dt_device         *li_next;
 686         struct dt_device         *li_bottom;
 687         struct obd_device        *li_obd;
 688         struct ldlm_namespace    *li_namespace;
 689         struct local_oid_storage *li_los;
 690         struct lu_fid             li_local_root_fid;  /* backend root "/" */
 691         struct lu_fid             li_global_root_fid; /* /ROOT */
 692         struct dt_object         *li_lfsck_dir;
 693         struct dt_object         *li_bookmark_obj;
 694         struct dt_object         *li_lpf_obj;
 695         struct dt_object         *li_lpf_root_obj;
 696         struct lu_client_seq     *li_seq;
 697         struct lfsck_bookmark     li_bookmark_ram;
 698         struct lfsck_bookmark     li_bookmark_disk;
 699         struct lfsck_position     li_pos_current;
 700         struct lfsck_position     li_pos_checkpoint;
 701
 702         struct lfsck_lmv         *li_lmv;
 703
 704         /* Obj for otable-based iteration */
 705         struct dt_object         *li_obj_oit;
 706
 707         /* Obj for directory traversal */
 708         struct dt_object         *li_obj_dir;
 709
 710         /* It for otable-based iteration */
 711         struct dt_it             *li_di_oit;
 712
 713         /* It for directory traversal */
 714         struct dt_it             *li_di_dir;
 715
 716         /* Description of OST */
 717         struct lfsck_tgt_descs    li_ost_descs;
 718
 719         /* Description of MDT */
 720         struct lfsck_tgt_descs    li_mdt_descs;
 721
 722         /* namespace-based directory traversal position. */
 723         __u64                     li_cookie_dir;
 724
 725         /* Arguments for low layer otable-based iteration. */
 726         __u32                     li_args_oit;
 727
 728         /* Arugments for namespace-based directory traversal. */
 729         __u32                     li_args_dir;
 730
 731         /* Schedule for every N objects. */
 732         __u32                     li_sleep_rate;
 733
 734         /* Sleep N jiffies for each schedule. */
 735         __u32                     li_sleep_jif;
 736
 737         /* How many objects have been scanned since last sleep. */
 738         __u32                     li_new_scanned;
 739
 740         /* The status when the LFSCK stopped or paused. */
 741         __u32                     li_status;
 742
 743         /* The flags when the lFSCK stopped or paused. */
 744         __u32                     li_flags;
 745
 746         unsigned int              li_oit_over:1, /* oit is finished. */
 747                                   li_drop_dryrun:1, /* Ever dryrun, not now. */
 748                                   li_master:1, /* Master instance or not. */
 749                                   li_current_oit_processed:1,
 750                                   li_start_unplug:1,
 751                                   li_stopping:1;
 752         struct lfsck_rec_lmv_save li_rec_lmv_save[LFSCK_REC_LMV_MAX_DEPTH];
 753 };
 754
 755 static inline bool lfsck_is_dryrun(struct lfsck_instance *lfsck)
 756 {
 757         return lfsck->li_bookmark_ram.lb_param & LPF_DRYRUN;
 758 }
 759
 760 struct lfsck_async_interpret_args {
 761         struct lfsck_component          *laia_com;
 762         struct lfsck_tgt_descs          *laia_ltds;
 763         struct lfsck_tgt_desc           *laia_ltd;
 764         struct lfsck_request            *laia_lr;
 765         atomic_t                        *laia_count;
 766         int                              laia_result;
 767         unsigned int                     laia_shared:1;
 768 };
 769
 770 struct lfsck_thread_args {
 771         struct lu_env                    lta_env;
 772         struct lfsck_instance           *lta_lfsck;
 773         struct lfsck_component          *lta_com;
 774         struct lfsck_start_param        *lta_lsp;
 775 };
 776
 777 struct lfsck_assistant_req {
 778         struct list_head                 lar_list;
 779         struct lfsck_assistant_object   *lar_parent;
 780 };
 781
 782 struct lfsck_namespace_req {
 783         struct lfsck_assistant_req       lnr_lar;
 784         struct lfsck_lmv                *lnr_lmv;
 785         struct lu_fid                    lnr_fid;
 786         __u64                            lnr_dir_cookie;
 787         __u32                            lnr_attr;
 788         __u32                            lnr_size;
 789         __u16                            lnr_type;
 790         __u16                            lnr_namelen;
 791         char                             lnr_name[0];
 792 };
 793
 794 struct lfsck_layout_req {
 795         struct lfsck_assistant_req       llr_lar;
 796         struct dt_object                *llr_child;
 797         __u32                            llr_comp_id;
 798         __u32                            llr_ost_idx;
 799         __u32                            llr_lov_idx; /* offset in LOV EA */
 800 };
 801
 802 struct lfsck_assistant_operations {
 803         int (*la_handler_p1)(const struct lu_env *env,
 804                              struct lfsck_component *com,
 805                              struct lfsck_assistant_req *lar);
 806
 807         int (*la_handler_p2)(const struct lu_env *env,
 808                              struct lfsck_component *com);
 809
 810         void (*la_fill_pos)(const struct lu_env *env,
 811                             struct lfsck_component *com,
 812                             struct lfsck_position *pos);
 813
 814         int (*la_double_scan_result)(const struct lu_env *env,
 815                                      struct lfsck_component *com,
 816                                      int rc);
 817
 818         void (*la_req_fini)(const struct lu_env *env,
 819                             struct lfsck_assistant_req *lar);
 820
 821         void (*la_sync_failures)(const struct lu_env *env,
 822                                  struct lfsck_component *com,
 823                                  struct lfsck_request *lr);
 824 };
 825
 826 struct lfsck_assistant_data {
 827         spinlock_t                               lad_lock;
 828         struct list_head                         lad_req_list;
 829
 830         /* list for the ost targets involve LFSCK. */
 831         struct list_head                         lad_ost_list;
 832
 833         /* list for the ost targets in phase1 scanning. */
 834         struct list_head                         lad_ost_phase1_list;
 835
 836         /* list for the ost targets in phase2 scanning. */
 837         struct list_head                         lad_ost_phase2_list;
 838
 839         /* list for the mdt targets involve LFSCK. */
 840         struct list_head                         lad_mdt_list;
 841
 842         /* list for the mdt targets in phase1 scanning. */
 843         struct list_head                         lad_mdt_phase1_list;
 844
 845         /* list for the mdt targets in phase2 scanning. */
 846         struct list_head                         lad_mdt_phase2_list;
 847
 848         const char                              *lad_name;
 849         struct ptlrpc_thread                     lad_thread;
 850         struct task_struct                      *lad_task;
 851
 852         const struct lfsck_assistant_operations *lad_ops;
 853
 854         struct cfs_bitmap                               *lad_bitmap;
 855
 856         __u32                                    lad_touch_gen;
 857         int                                      lad_prefetched;
 858         int                                      lad_assistant_status;
 859         int                                      lad_post_result;
 860         unsigned long                            lad_flags;
 861         bool                                     lad_advance_lock;
 862 };
 863 enum {
 864         LAD_TO_POST = 0,
 865         LAD_TO_DOUBLE_SCAN = 1,
 866         LAD_IN_DOUBLE_SCAN = 2,
 867         LAD_EXIT = 3,
 868         LAD_INCOMPLETE = 4,
 869 };
 870
 871 #define LFSCK_TMPBUF_LEN        64
 872
 873 struct lfsck_lock_handle {
 874         struct lustre_handle    llh_pdo_lh;
 875         struct lustre_handle    llh_reg_lh;
 876         enum ldlm_mode          llh_pdo_mode;
 877         enum ldlm_mode          llh_reg_mode;
 878 };
 879
 880 struct lfsck_thread_info {
 881         struct lu_name          lti_name_const;
 882         struct lu_name          lti_name;
 883         struct lu_name          lti_name2;
 884         struct lu_buf           lti_buf;
 885         struct lu_buf           lti_linkea_buf;
 886         struct lu_buf           lti_linkea_buf2;
 887         struct lu_buf           lti_big_buf;
 888         struct lu_fid           lti_fid;
 889         struct lu_fid           lti_fid2;
 890         struct lu_fid           lti_fid3;
 891         struct lu_fid           lti_fid4;
 892         struct lu_attr          lti_la;
 893         struct lu_attr          lti_la2;
 894         struct ost_id           lti_oi;
 895         struct lustre_ost_attrs lti_loa;
 896         struct dt_object_format lti_dof;
 897         /* There will be '\0' at the end of the name. */
 898         char            lti_key[sizeof(struct lu_dirent) + NAME_MAX + 1];
 899         char                    lti_tmpbuf[LFSCK_TMPBUF_LEN];
 900         char                    lti_tmpbuf2[LFSCK_TMPBUF_LEN];
 901         struct lfsck_request    lti_lr;
 902         struct lfsck_async_interpret_args lti_laia;
 903         struct lfsck_async_interpret_args lti_laia2;
 904         struct lfsck_start      lti_start;
 905         struct lfsck_stop       lti_stop;
 906         union ldlm_policy_data  lti_policy;
 907         struct ldlm_enqueue_info lti_einfo;
 908         struct ldlm_res_id      lti_resid;
 909         struct filter_fid       lti_ff;
 910         struct dt_allocation_hint lti_hint;
 911         struct lu_orphan_rec_v3 lti_rec;
 912         struct lov_user_md      lti_lum;
 913         struct dt_insert_rec    lti_dt_rec;
 914         struct lu_object_conf   lti_conf;
 915         struct lu_seq_range     lti_range;
 916         struct lmv_mds_md_v1    lti_lmv;
 917         struct lmv_mds_md_v1    lti_lmv2;
 918         struct lmv_mds_md_v1    lti_lmv3;
 919         struct lmv_mds_md_v1    lti_lmv4;
 920         struct lfsck_lock_handle lti_llh;
 921         struct lfsck_layout_dangling_key lti_lldk;
 922 };
 923
 924 /* lfsck_lib.c */
 925 int lfsck_fid_alloc(const struct lu_env *env, struct lfsck_instance *lfsck,
 926                     struct lu_fid *fid, bool locked);
 927 int lfsck_ibits_lock(const struct lu_env *env, struct lfsck_instance *lfsck,
 928                      struct dt_object *obj, struct lustre_handle *lh,
 929                      __u64 bits, enum ldlm_mode mode);
 930 void lfsck_ibits_unlock(struct lustre_handle *lh, enum ldlm_mode mode);
 931 int lfsck_remote_lookup_lock(const struct lu_env *env,
 932                              struct lfsck_instance *lfsck,
 933                              struct dt_object *pobj, struct dt_object *obj,
 934                              struct lustre_handle *lh, enum ldlm_mode mode);
 935 int lfsck_lock(const struct lu_env *env, struct lfsck_instance *lfsck,
 936                struct dt_object *obj, const char *name,
 937                struct lfsck_lock_handle *llh, __u64 bits, enum ldlm_mode mode);
 938 void lfsck_unlock(struct lfsck_lock_handle *llh);
 939 int lfsck_find_mdt_idx_by_fid(const struct lu_env *env,
 940                               struct lfsck_instance *lfsck,
 941                               const struct lu_fid *fid);
 942 int lfsck_verify_lpf(const struct lu_env *env, struct lfsck_instance *lfsck);
 943 struct lfsck_instance *lfsck_instance_find(struct dt_device *key, bool ref,
 944                                            bool unlink);
 945 struct lfsck_component *lfsck_component_find(struct lfsck_instance *lfsck,
 946                                              __u16 type);
 947 void lfsck_component_cleanup(const struct lu_env *env,
 948                              struct lfsck_component *com);
 949 void lfsck_instance_cleanup(const struct lu_env *env,
 950                             struct lfsck_instance *lfsck);
 951 void lfsck_bits_dump(struct seq_file *m, int bits, const char *const names[],
 952                      const char *prefix);
 953 void lfsck_time_dump(struct seq_file *m, time64_t time, const char *name);
 954 void lfsck_pos_dump(struct seq_file *m, struct lfsck_position *pos,
 955                     const char *prefix);
 956 void lfsck_pos_fill(const struct lu_env *env, struct lfsck_instance *lfsck,
 957                     struct lfsck_position *pos, bool init);
 958 bool __lfsck_set_speed(struct lfsck_instance *lfsck, __u32 limit);
 959 void lfsck_control_speed(struct lfsck_instance *lfsck);
 960 void lfsck_control_speed_by_self(struct lfsck_component *com);
 961 void lfsck_thread_args_fini(struct lfsck_thread_args *lta);
 962 struct lfsck_assistant_data *
 963 lfsck_assistant_data_init(const struct lfsck_assistant_operations *lao,
 964                           const char *name);
 965 struct lfsck_assistant_object *
 966 lfsck_assistant_object_init(const struct lu_env *env, const struct lu_fid *fid,
 967                             const struct lu_attr *attr, __u64 cookie,
 968                             bool is_dir);
 969 struct dt_object *
 970 lfsck_assistant_object_load(const struct lu_env *env,
 971                             struct lfsck_instance *lfsck,
 972                             struct lfsck_assistant_object *lso);
 973 int lfsck_async_interpret_common(const struct lu_env *env,
 974                                  struct ptlrpc_request *req,
 975                                  void *args, int rc);
 976 int lfsck_async_request(const struct lu_env *env, struct obd_export *exp,
 977                         struct lfsck_request *lr,
 978                         struct ptlrpc_request_set *set,
 979                         ptlrpc_interpterer_t interpterer,
 980                         void *args, int request);
 981 int lfsck_query_all(const struct lu_env *env, struct lfsck_component *com);
 982 int lfsck_start_assistant(const struct lu_env *env, struct lfsck_component *com,
 983                           struct lfsck_start_param *lsp);
 984 int lfsck_checkpoint_generic(const struct lu_env *env,
 985                              struct lfsck_component *com);
 986 void lfsck_post_generic(const struct lu_env *env,
 987                         struct lfsck_component *com, int *result);
 988 int lfsck_double_scan_generic(const struct lu_env *env,
 989                               struct lfsck_component *com, int status);
 990 void lfsck_quit_generic(const struct lu_env *env,
 991                         struct lfsck_component *com);
 992 int lfsck_load_one_trace_file(const struct lu_env *env,
 993                               struct lfsck_component *com,
 994                               struct dt_object *parent,
 995                               struct dt_object **child,
 996                               const struct dt_index_features *ft,
 997                               const char *name, bool reset);
 998 int lfsck_load_sub_trace_files(const struct lu_env *env,
 999                                struct lfsck_component *com,
1000                                const struct dt_index_features *ft,
1001                                const char *prefix, bool reset);
1002
1003 /* lfsck_engine.c */
1004 int lfsck_unpack_ent(struct lu_dirent *ent, __u64 *cookie, __u16 *type);
1005 void lfsck_close_dir(const struct lu_env *env,
1006                      struct lfsck_instance *lfsck, int result);
1007 int lfsck_open_dir(const struct lu_env *env,
1008                    struct lfsck_instance *lfsck, __u64 cookie);
1009 int lfsck_master_engine(void *args);
1010 int lfsck_assistant_engine(void *args);
1011
1012 /* lfsck_bookmark.c */
1013 void lfsck_bookmark_cpu_to_le(struct lfsck_bookmark *des,
1014                               struct lfsck_bookmark *src);
1015 int lfsck_bookmark_store(const struct lu_env *env,
1016                          struct lfsck_instance *lfsck);
1017 int lfsck_bookmark_setup(const struct lu_env *env,
1018                          struct lfsck_instance *lfsck);
1019 int lfsck_set_param(const struct lu_env *env, struct lfsck_instance *lfsck,
1020                     struct lfsck_start *start, bool reset);
1021
1022 /* lfsck_namespace.c */
1023 int lfsck_namespace_trace_update(const struct lu_env *env,
1024                                  struct lfsck_component *com,
1025                                  const struct lu_fid *fid,
1026                                  const __u8 flags, bool add);
1027 int lfsck_namespace_check_exist(const struct lu_env *env,
1028                                 struct dt_object *dir,
1029                                 struct dt_object *obj, const char *name);
1030 int __lfsck_links_read(const struct lu_env *env, struct dt_object *obj,
1031                        struct linkea_data *ldata, bool with_rec);
1032 int lfsck_namespace_rebuild_linkea(const struct lu_env *env,
1033                                    struct lfsck_component *com,
1034                                    struct dt_object *obj,
1035                                    struct linkea_data *ldata);
1036 int lfsck_namespace_repair_dangling(const struct lu_env *env,
1037                                     struct lfsck_component *com,
1038                                     struct dt_object *parent,
1039                                     struct dt_object *child,
1040                                     struct lfsck_namespace_req *lnr);
1041 int lfsck_namespace_repair_dirent(const struct lu_env *env,
1042                                   struct lfsck_component *com,
1043                                   struct dt_object *parent,
1044                                   struct dt_object *child,
1045                                   const char *name, const char *name2,
1046                                   __u16 type, bool update, bool dec);
1047 int lfsck_verify_linkea(const struct lu_env *env, struct lfsck_instance *lfsck,
1048                         struct dt_object *obj, const struct lu_name *cname,
1049                         const struct lu_fid *pfid);
1050 int lfsck_links_get_first(const struct lu_env *env, struct dt_object *obj,
1051                           char *name, struct lu_fid *pfid);
1052 int lfsck_update_name_entry(const struct lu_env *env,
1053                             struct lfsck_instance *lfsck,
1054                             struct dt_object *dir, const char *name,
1055                             const struct lu_fid *fid, __u32 type);
1056 int lfsck_namespace_setup(const struct lu_env *env,
1057                           struct lfsck_instance *lfsck);
1058
1059 /* lfsck_striped_dir.c */
1060 void lfsck_lmv_put(const struct lu_env *env, struct lfsck_lmv *llmv);
1061 int lfsck_read_stripe_lmv(const struct lu_env *env,
1062                           struct lfsck_instance *lfsck,
1063                           struct dt_object *obj,
1064                           struct lmv_mds_md_v1 *lmv);
1065 int lfsck_shard_name_to_index(const struct lu_env *env, const char *name,
1066                               int namelen, __u16 type,
1067                               const struct lu_fid *fid);
1068 bool lfsck_is_valid_slave_name_entry(const struct lu_env *env,
1069                                      struct lfsck_lmv *llmv,
1070                                      const char *name, int namelen);
1071 int lfsck_namespace_check_name(const struct lu_env *env,
1072                                struct lfsck_instance *lfsck,
1073                                struct dt_object *parent,
1074                                struct dt_object *child,
1075                                const struct lu_name *cname);
1076 int lfsck_namespace_update_lmv(const struct lu_env *env,
1077                                struct lfsck_component *com,
1078                                struct dt_object *obj,
1079                                struct lmv_mds_md_v1 *lmv, bool locked);
1080 int lfsck_namespace_verify_stripe_slave(const struct lu_env *env,
1081                                         struct lfsck_component *com,
1082                                         struct dt_object *obj,
1083                                         struct lfsck_lmv *llmv);
1084 int lfsck_namespace_scan_shard(const struct lu_env *env,
1085                                struct lfsck_component *com,
1086                                struct dt_object *child);
1087 int lfsck_namespace_notify_lmv_master_local(const struct lu_env *env,
1088                                             struct lfsck_component *com,
1089                                             struct dt_object *obj);
1090 int lfsck_namespace_repair_bad_name_hash(const struct lu_env *env,
1091                                          struct lfsck_component *com,
1092                                          struct dt_object *shard,
1093                                          struct lfsck_lmv *llmv,
1094                                          const char *name);
1095 int lfsck_namespace_striped_dir_rescan(const struct lu_env *env,
1096                                        struct lfsck_component *com,
1097                                        struct lfsck_namespace_req *lnr);
1098 int lfsck_namespace_handle_striped_master(const struct lu_env *env,
1099                                           struct lfsck_component *com,
1100                                           struct lfsck_namespace_req *lnr);
1101
1102 /* lfsck_layout.c */
1103 int lfsck_layout_setup(const struct lu_env *env, struct lfsck_instance *lfsck);
1104
1105 extern const char dot[];
1106 extern const char dotdot[];
1107 extern const char *const lfsck_flags_names[];
1108 extern const char *const lfsck_param_names[];
1109 extern struct lu_context_key lfsck_thread_key;
1110
1111 static inline struct dt_device *lfsck_obj2dev(struct dt_object *obj)
1112 {
1113         return container_of_safe(obj->do_lu.lo_dev, struct dt_device,
1114                                  dd_lu_dev);
1115 }
1116
1117 static inline struct lfsck_thread_info *
1118 lfsck_env_info(const struct lu_env *env)
1119 {
1120         struct lfsck_thread_info *info;
1121
1122         info = lu_context_key_get(&env->le_ctx, &lfsck_thread_key);
1123         LASSERT(info != NULL);
1124         return info;
1125 }
1126
1127 static inline const struct lu_name *
1128 lfsck_name_get_const(const struct lu_env *env, const void *area, ssize_t len)
1129 {
1130         struct lu_name *lname;
1131
1132         lname = &lfsck_env_info(env)->lti_name_const;
1133         lname->ln_name = area;
1134         lname->ln_namelen = len;
1135         return lname;
1136 }
1137
1138 static inline void
1139 lfsck_buf_init(struct lu_buf *buf, void *area, ssize_t len)
1140 {
1141         buf->lb_buf = area;
1142         buf->lb_len = len;
1143 }
1144
1145 static inline struct lu_buf *
1146 lfsck_buf_get(const struct lu_env *env, void *area, ssize_t len)
1147 {
1148         struct lu_buf *buf;
1149
1150         buf = &lfsck_env_info(env)->lti_buf;
1151         buf->lb_buf = area;
1152         buf->lb_len = len;
1153         return buf;
1154 }
1155
1156 static inline const struct lu_buf *
1157 lfsck_buf_get_const(const struct lu_env *env, const void *area, ssize_t len)
1158 {
1159         struct lu_buf *buf;
1160
1161         buf = &lfsck_env_info(env)->lti_buf;
1162         buf->lb_buf = (void *)area;
1163         buf->lb_len = len;
1164         return buf;
1165 }
1166
1167 static inline char *lfsck_lfsck2name(struct lfsck_instance *lfsck)
1168 {
1169         return lfsck->li_bottom->dd_lu_dev.ld_obd->obd_name;
1170 }
1171
1172 static inline const struct lu_fid *lfsck_dto2fid(const struct dt_object *obj)
1173 {
1174         return lu_object_fid(&obj->do_lu);
1175 }
1176
1177 static inline void lfsck_pos_set_zero(struct lfsck_position *pos)
1178 {
1179         memset(pos, 0, sizeof(*pos));
1180 }
1181
1182 static inline int lfsck_pos_is_zero(const struct lfsck_position *pos)
1183 {
1184         return pos->lp_oit_cookie == 0 && fid_is_zero(&pos->lp_dir_parent);
1185 }
1186
1187 static inline int lfsck_pos_is_eq(const struct lfsck_position *pos1,
1188                                   const struct lfsck_position *pos2)
1189 {
1190         if (pos1->lp_oit_cookie < pos2->lp_oit_cookie)
1191                 return -1;
1192
1193         if (pos1->lp_oit_cookie > pos2->lp_oit_cookie)
1194                 return 1;
1195
1196         if (fid_is_zero(&pos1->lp_dir_parent) &&
1197             !fid_is_zero(&pos2->lp_dir_parent))
1198                 return -1;
1199
1200         if (!fid_is_zero(&pos1->lp_dir_parent) &&
1201             fid_is_zero(&pos2->lp_dir_parent))
1202                 return 1;
1203
1204         if (fid_is_zero(&pos1->lp_dir_parent) &&
1205             fid_is_zero(&pos2->lp_dir_parent))
1206                 return 0;
1207
1208         LASSERT(lu_fid_eq(&pos1->lp_dir_parent, &pos2->lp_dir_parent));
1209
1210         if (pos1->lp_dir_cookie < pos2->lp_dir_cookie)
1211                 return -1;
1212
1213         if (pos1->lp_dir_cookie > pos2->lp_dir_cookie)
1214                 return 1;
1215
1216         return 0;
1217 }
1218
1219 static void inline lfsck_position_le_to_cpu(struct lfsck_position *des,
1220                                             struct lfsck_position *src)
1221 {
1222         des->lp_oit_cookie = le64_to_cpu(src->lp_oit_cookie);
1223         fid_le_to_cpu(&des->lp_dir_parent, &src->lp_dir_parent);
1224         des->lp_dir_cookie = le64_to_cpu(src->lp_dir_cookie);
1225 }
1226
1227 static void inline lfsck_position_cpu_to_le(struct lfsck_position *des,
1228                                             struct lfsck_position *src)
1229 {
1230         des->lp_oit_cookie = cpu_to_le64(src->lp_oit_cookie);
1231         fid_cpu_to_le(&des->lp_dir_parent, &src->lp_dir_parent);
1232         des->lp_dir_cookie = cpu_to_le64(src->lp_dir_cookie);
1233 }
1234
1235 static inline umode_t lfsck_object_type(const struct dt_object *obj)
1236 {
1237         return lu_object_attr(&obj->do_lu);
1238 }
1239
1240 static inline int lfsck_is_dead_obj(const struct dt_object *obj)
1241 {
1242         return lu_object_is_dying(obj->do_lu.lo_header);
1243 }
1244
1245 static inline struct dt_object *lfsck_object_get(struct dt_object *obj)
1246 {
1247         lu_object_get(&obj->do_lu);
1248         return obj;
1249 }
1250
1251 static inline void lfsck_object_put(const struct lu_env *env,
1252                                     struct dt_object *obj)
1253 {
1254         dt_object_put(env, obj);
1255 }
1256
1257 static inline struct seq_server_site
1258 *lfsck_dev_site(struct lfsck_instance *lfsck)
1259 {
1260         return lu_site2seq(lfsck->li_bottom->dd_lu_dev.ld_site);
1261 }
1262
1263 static inline u32 lfsck_dev_idx(struct lfsck_instance *lfsck)
1264 {
1265         return lfsck_dev_site(lfsck)->ss_node_id;
1266 }
1267
1268 static inline struct dt_object *
1269 lfsck_object_find_by_dev_new(const struct lu_env *env, struct dt_device *dev,
1270                              const struct lu_fid *fid)
1271 {
1272         struct lu_object_conf   *conf = &lfsck_env_info(env)->lti_conf;
1273
1274         conf->loc_flags = LOC_F_NEW;
1275         return lu2dt(lu_object_find_slice(env, dt2lu_dev(dev), fid, conf));
1276 }
1277
1278 static inline struct dt_object *
1279 lfsck_object_find_by_dev(const struct lu_env *env, struct dt_device *dev,
1280                          const struct lu_fid *fid)
1281 {
1282         return lu2dt(lu_object_find_slice(env, dt2lu_dev(dev), fid, NULL));
1283 }
1284
1285 static inline struct dt_device *
1286 lfsck_find_dev_by_fid(const struct lu_env *env, struct lfsck_instance *lfsck,
1287                       const struct lu_fid *fid)
1288 {
1289         struct dt_device *dev;
1290         int               idx;
1291
1292         if (!lfsck->li_master)
1293                 return lfsck->li_bottom;
1294
1295         idx = lfsck_find_mdt_idx_by_fid(env, lfsck, fid);
1296         if (idx < 0)
1297                 return ERR_PTR(idx);
1298
1299         if (idx == lfsck_dev_idx(lfsck)) {
1300                 dev = lfsck->li_bottom;
1301         } else {
1302                 struct lfsck_tgt_desc *ltd;
1303
1304                 ltd = lfsck_ltd2tgt(&lfsck->li_mdt_descs, idx);
1305                 if (unlikely(ltd == NULL))
1306                         return ERR_PTR(-ENODEV);
1307
1308                 dev = ltd->ltd_tgt;
1309         }
1310
1311         return dev;
1312 }
1313
1314 static inline struct dt_object *
1315 lfsck_object_find_bottom(const struct lu_env *env, struct lfsck_instance *lfsck,
1316                          const struct lu_fid *fid)
1317 {
1318         struct dt_device *dev;
1319
1320         dev = lfsck_find_dev_by_fid(env, lfsck, fid);
1321         if (IS_ERR(dev))
1322                 return (struct dt_object *)dev;
1323
1324         return lfsck_object_find_by_dev(env, dev, fid);
1325 }
1326
1327 static inline struct dt_object *
1328 lfsck_object_find_bottom_new(const struct lu_env *env,
1329                              struct lfsck_instance *lfsck,
1330                              const struct lu_fid *fid)
1331 {
1332         struct dt_device *dev;
1333
1334         dev = lfsck_find_dev_by_fid(env, lfsck, fid);
1335         if (IS_ERR(dev))
1336                 return (struct dt_object *)dev;
1337
1338         return lfsck_object_find_by_dev_new(env, dev, fid);
1339 }
1340
1341 static inline struct dt_object *
1342 lfsck_object_locate(struct dt_device *dev, struct dt_object *obj)
1343 {
1344         if (lfsck_obj2dev(obj) == dev) {
1345                 return obj;
1346         } else {
1347                 struct lu_object *lo;
1348
1349                 lo = lu_object_locate(obj->do_lu.lo_header,
1350                                       dev->dd_lu_dev.ld_type);
1351                 if (unlikely(lo == NULL))
1352                         return ERR_PTR(-ENOENT);
1353
1354                 return lu2dt(lo);
1355         }
1356 }
1357
1358 static inline struct lfsck_tgt_desc *lfsck_tgt_get(struct lfsck_tgt_descs *ltds,
1359                                                    __u32 index)
1360 {
1361         struct lfsck_tgt_desc *ltd;
1362
1363         ltd = lfsck_ltd2tgt(ltds, index);
1364         if (ltd != NULL)
1365                 atomic_inc(&ltd->ltd_ref);
1366
1367         return ltd;
1368 }
1369
1370 static inline void lfsck_tgt_put(struct lfsck_tgt_desc *ltd)
1371 {
1372         if (atomic_dec_and_test(&ltd->ltd_ref))
1373                 OBD_FREE_PTR(ltd);
1374 }
1375
1376 static inline struct lfsck_component *
1377 lfsck_component_get(struct lfsck_component *com)
1378 {
1379         atomic_inc(&com->lc_ref);
1380
1381         return com;
1382 }
1383
1384 static inline void lfsck_component_put(const struct lu_env *env,
1385                                        struct lfsck_component *com)
1386 {
1387         if (atomic_dec_and_test(&com->lc_ref)) {
1388                 struct lfsck_sub_trace_obj *lsto;
1389                 int                         i;
1390
1391                 for (i = 0, lsto = &com->lc_sub_trace_objs[0];
1392                      i < LFSCK_STF_COUNT; i++, lsto++) {
1393                         if (lsto->lsto_obj != NULL)
1394                                 lfsck_object_put(env, lsto->lsto_obj);
1395                 }
1396
1397                 if (com->lc_obj != NULL)
1398                         lfsck_object_put(env, com->lc_obj);
1399                 if (com->lc_file_ram != NULL)
1400                         OBD_FREE(com->lc_file_ram, com->lc_file_size);
1401                 if (com->lc_file_disk != NULL)
1402                         OBD_FREE(com->lc_file_disk, com->lc_file_size);
1403                 if (com->lc_data != NULL) {
1404                         LASSERT(com->lc_ops->lfsck_data_release != NULL);
1405
1406                         com->lc_ops->lfsck_data_release(env, com);
1407                 }
1408
1409                 OBD_FREE_PTR(com);
1410         }
1411 }
1412
1413 static inline struct lfsck_instance *
1414 lfsck_instance_get(struct lfsck_instance *lfsck)
1415 {
1416         atomic_inc(&lfsck->li_ref);
1417
1418         return lfsck;
1419 }
1420
1421 static inline void lfsck_instance_put(const struct lu_env *env,
1422                                       struct lfsck_instance *lfsck)
1423 {
1424         if (atomic_dec_and_test(&lfsck->li_ref))
1425                 lfsck_instance_cleanup(env, lfsck);
1426 }
1427
1428 static inline bool lfsck_phase2_next_ready(struct lfsck_assistant_data *lad)
1429 {
1430         return list_empty(&lad->lad_mdt_phase1_list) &&
1431                (!list_empty(&lad->lad_ost_phase2_list) ||
1432                 list_empty(&lad->lad_ost_phase1_list));
1433 }
1434
1435 static inline void lfsck_lad_set_bitmap(const struct lu_env *env,
1436                                         struct lfsck_component *com,
1437                                         __u32 index)
1438 {
1439         struct lfsck_assistant_data     *lad    = com->lc_data;
1440         struct cfs_bitmap               *bitmap = lad->lad_bitmap;
1441
1442         LASSERT(com->lc_lfsck->li_master);
1443         LASSERT(bitmap != NULL);
1444
1445         if (likely(bitmap->size > index)) {
1446                 cfs_bitmap_set(bitmap, index);
1447                 set_bit(LAD_INCOMPLETE, &lad->lad_flags);
1448         } else if (com->lc_type == LFSCK_TYPE_NAMESPACE) {
1449                 struct lfsck_namespace *ns = com->lc_file_ram;
1450
1451                 ns->ln_flags |= LF_INCOMPLETE;
1452         }
1453
1454         CDEBUG(D_LFSCK, "%s: %s LFSCK set bitmap (%p/%u) for idx %u\n",
1455                lfsck_lfsck2name(com->lc_lfsck), lad->lad_name, bitmap,
1456                bitmap->size, index);
1457 }
1458
1459 static inline int lfsck_links_read(const struct lu_env *env,
1460                                    struct dt_object *obj,
1461                                    struct linkea_data *ldata)
1462 {
1463         ldata->ld_buf =
1464                 lu_buf_check_and_alloc(&lfsck_env_info(env)->lti_linkea_buf,
1465                                        MAX_LINKEA_SIZE);
1466
1467         return __lfsck_links_read(env, obj, ldata, false);
1468 }
1469
1470 /* Read linkEA for the given object, the linkEA should contain
1471  * at least one entry, otherwise, -ENODATA will be returned. */
1472 static inline int lfsck_links_read_with_rec(const struct lu_env *env,
1473                                             struct dt_object *obj,
1474                                             struct linkea_data *ldata)
1475 {
1476         ldata->ld_buf =
1477                 lu_buf_check_and_alloc(&lfsck_env_info(env)->lti_linkea_buf,
1478                                        MAX_LINKEA_SIZE);
1479
1480         return __lfsck_links_read(env, obj, ldata, true);
1481 }
1482
1483 static inline int lfsck_links_read2_with_rec(const struct lu_env *env,
1484                                              struct dt_object *obj,
1485                                              struct linkea_data *ldata)
1486 {
1487         ldata->ld_buf =
1488                 lu_buf_check_and_alloc(&lfsck_env_info(env)->lti_linkea_buf2,
1489                                        MAX_LINKEA_SIZE);
1490
1491         return __lfsck_links_read(env, obj, ldata, true);
1492 }
1493
1494 static inline struct lfsck_lmv *lfsck_lmv_get(struct lfsck_lmv *llmv)
1495 {
1496         if (llmv != NULL)
1497                 atomic_inc(&llmv->ll_ref);
1498
1499         return llmv;
1500 }
1501
1502 static inline int lfsck_sub_trace_file_fid2idx(const struct lu_fid *fid)
1503 {
1504         return fid->f_oid & (LFSCK_STF_COUNT - 1);
1505 }
1506
1507 static inline void lfsck_lmv_header_le_to_cpu(struct lmv_mds_md_v1 *dst,
1508                                               const struct lmv_mds_md_v1 *src)
1509 {
1510         dst->lmv_magic = le32_to_cpu(src->lmv_magic);
1511         dst->lmv_stripe_count = le32_to_cpu(src->lmv_stripe_count);
1512         dst->lmv_master_mdt_index = le32_to_cpu(src->lmv_master_mdt_index);
1513         dst->lmv_hash_type = le32_to_cpu(src->lmv_hash_type);
1514         dst->lmv_layout_version = le32_to_cpu(src->lmv_layout_version);
1515         dst->lmv_migrate_offset = le32_to_cpu(src->lmv_migrate_offset);
1516         dst->lmv_migrate_hash = le32_to_cpu(src->lmv_migrate_hash);
1517 }
1518
1519 static inline void lfsck_lmv_header_cpu_to_le(struct lmv_mds_md_v1 *dst,
1520                                               const struct lmv_mds_md_v1 *src)
1521 {
1522         dst->lmv_magic = cpu_to_le32(src->lmv_magic);
1523         dst->lmv_stripe_count = cpu_to_le32(src->lmv_stripe_count);
1524         dst->lmv_master_mdt_index = cpu_to_le32(src->lmv_master_mdt_index);
1525         dst->lmv_hash_type = cpu_to_le32(src->lmv_hash_type);
1526         dst->lmv_layout_version = cpu_to_le32(src->lmv_layout_version);
1527         dst->lmv_migrate_offset = cpu_to_le32(src->lmv_migrate_offset);
1528         dst->lmv_migrate_hash = cpu_to_le32(src->lmv_migrate_hash);
1529 }
1530
1531 static inline struct lfsck_assistant_object *
1532 lfsck_assistant_object_get(struct lfsck_assistant_object *lso)
1533 {
1534         atomic_inc(&lso->lso_ref);
1535
1536         return lso;
1537 }
1538
1539 static inline void
1540 lfsck_assistant_object_put(const struct lu_env *env,
1541                            struct lfsck_assistant_object *lso)
1542 {
1543         if (atomic_dec_and_test(&lso->lso_ref))
1544                 OBD_FREE_PTR(lso);
1545 }
1546
1547 static inline struct thandle*
1548 lfsck_trans_create(const struct lu_env *env, struct dt_device *dev,
1549                    struct lfsck_instance *lfsck)
1550 {
1551         if (lfsck->li_bookmark_ram.lb_param & LPF_DRYRUN) {
1552                 CERROR("%s: transaction is being created in DRYRUN mode!\n",
1553                        lfsck_lfsck2name(lfsck));
1554
1555                 dump_stack();
1556                 return ERR_PTR(-EINVAL);
1557         }
1558
1559         return dt_trans_create(env, dev);
1560 }
1561 #endif /* _LFSCK_INTERNAL_H */