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