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         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 struct lfsck_async_interpret_args {
 756         struct lfsck_component          *laia_com;
 757         struct lfsck_tgt_descs          *laia_ltds;
 758         struct lfsck_tgt_desc           *laia_ltd;
 759         struct lfsck_request            *laia_lr;
 760         atomic_t                        *laia_count;
 761         int                              laia_result;
 762         unsigned int                     laia_shared:1;
 763 };
 764
 765 struct lfsck_thread_args {
 766         struct lu_env                    lta_env;
 767         struct lfsck_instance           *lta_lfsck;
 768         struct lfsck_component          *lta_com;
 769         struct lfsck_start_param        *lta_lsp;
 770 };
 771
 772 struct lfsck_assistant_req {
 773         struct list_head                 lar_list;
 774         struct lfsck_assistant_object   *lar_parent;
 775 };
 776
 777 struct lfsck_namespace_req {
 778         struct lfsck_assistant_req       lnr_lar;
 779         struct lfsck_lmv                *lnr_lmv;
 780         struct lu_fid                    lnr_fid;
 781         __u64                            lnr_dir_cookie;
 782         __u32                            lnr_attr;
 783         __u32                            lnr_size;
 784         __u16                            lnr_type;
 785         __u16                            lnr_namelen;
 786         char                             lnr_name[0];
 787 };
 788
 789 struct lfsck_layout_req {
 790         struct lfsck_assistant_req       llr_lar;
 791         struct dt_object                *llr_child;
 792         __u32                            llr_comp_id;
 793         __u32                            llr_ost_idx;
 794         __u32                            llr_lov_idx; /* offset in LOV EA */
 795 };
 796
 797 struct lfsck_assistant_operations {
 798         int (*la_handler_p1)(const struct lu_env *env,
 799                              struct lfsck_component *com,
 800                              struct lfsck_assistant_req *lar);
 801
 802         int (*la_handler_p2)(const struct lu_env *env,
 803                              struct lfsck_component *com);
 804
 805         void (*la_fill_pos)(const struct lu_env *env,
 806                             struct lfsck_component *com,
 807                             struct lfsck_position *pos);
 808
 809         int (*la_double_scan_result)(const struct lu_env *env,
 810                                      struct lfsck_component *com,
 811                                      int rc);
 812
 813         void (*la_req_fini)(const struct lu_env *env,
 814                             struct lfsck_assistant_req *lar);
 815
 816         void (*la_sync_failures)(const struct lu_env *env,
 817                                  struct lfsck_component *com,
 818                                  struct lfsck_request *lr);
 819 };
 820
 821 struct lfsck_assistant_data {
 822         spinlock_t                               lad_lock;
 823         struct list_head                         lad_req_list;
 824
 825         /* list for the ost targets involve LFSCK. */
 826         struct list_head                         lad_ost_list;
 827
 828         /* list for the ost targets in phase1 scanning. */
 829         struct list_head                         lad_ost_phase1_list;
 830
 831         /* list for the ost targets in phase2 scanning. */
 832         struct list_head                         lad_ost_phase2_list;
 833
 834         /* list for the mdt targets involve LFSCK. */
 835         struct list_head                         lad_mdt_list;
 836
 837         /* list for the mdt targets in phase1 scanning. */
 838         struct list_head                         lad_mdt_phase1_list;
 839
 840         /* list for the mdt targets in phase2 scanning. */
 841         struct list_head                         lad_mdt_phase2_list;
 842
 843         const char                              *lad_name;
 844         struct ptlrpc_thread                     lad_thread;
 845         struct task_struct                      *lad_task;
 846
 847         struct lfsck_assistant_operations       *lad_ops;
 848
 849         struct cfs_bitmap                               *lad_bitmap;
 850
 851         __u32                                    lad_touch_gen;
 852         int                                      lad_prefetched;
 853         int                                      lad_assistant_status;
 854         int                                      lad_post_result;
 855         unsigned long                            lad_flags;
 856         bool                                     lad_advance_lock;
 857 };
 858 enum {
 859         LAD_TO_POST = 0,
 860         LAD_TO_DOUBLE_SCAN = 1,
 861         LAD_IN_DOUBLE_SCAN = 2,
 862         LAD_EXIT = 3,
 863         LAD_INCOMPLETE = 4,
 864 };
 865
 866 #define LFSCK_TMPBUF_LEN        64
 867
 868 struct lfsck_lock_handle {
 869         struct lustre_handle    llh_pdo_lh;
 870         struct lustre_handle    llh_reg_lh;
 871         enum ldlm_mode          llh_pdo_mode;
 872         enum ldlm_mode          llh_reg_mode;
 873 };
 874
 875 struct lfsck_thread_info {
 876         struct lu_name          lti_name_const;
 877         struct lu_name          lti_name;
 878         struct lu_name          lti_name2;
 879         struct lu_buf           lti_buf;
 880         struct lu_buf           lti_linkea_buf;
 881         struct lu_buf           lti_linkea_buf2;
 882         struct lu_buf           lti_big_buf;
 883         struct lu_fid           lti_fid;
 884         struct lu_fid           lti_fid2;
 885         struct lu_fid           lti_fid3;
 886         struct lu_fid           lti_fid4;
 887         struct lu_attr          lti_la;
 888         struct lu_attr          lti_la2;
 889         struct ost_id           lti_oi;
 890         struct lustre_ost_attrs lti_loa;
 891         struct dt_object_format lti_dof;
 892         /* There will be '\0' at the end of the name. */
 893         char            lti_key[sizeof(struct lu_dirent) + NAME_MAX + 1];
 894         char                    lti_tmpbuf[LFSCK_TMPBUF_LEN];
 895         char                    lti_tmpbuf2[LFSCK_TMPBUF_LEN];
 896         struct lfsck_request    lti_lr;
 897         struct lfsck_async_interpret_args lti_laia;
 898         struct lfsck_async_interpret_args lti_laia2;
 899         struct lfsck_start      lti_start;
 900         struct lfsck_stop       lti_stop;
 901         union ldlm_policy_data  lti_policy;
 902         struct ldlm_enqueue_info lti_einfo;
 903         struct ldlm_res_id      lti_resid;
 904         struct filter_fid       lti_ff;
 905         struct dt_allocation_hint lti_hint;
 906         struct lu_orphan_rec_v3 lti_rec;
 907         struct lov_user_md      lti_lum;
 908         struct dt_insert_rec    lti_dt_rec;
 909         struct lu_object_conf   lti_conf;
 910         struct lu_seq_range     lti_range;
 911         struct lmv_mds_md_v1    lti_lmv;
 912         struct lmv_mds_md_v1    lti_lmv2;
 913         struct lmv_mds_md_v1    lti_lmv3;
 914         struct lmv_mds_md_v1    lti_lmv4;
 915         struct lfsck_lock_handle lti_llh;
 916         struct lfsck_layout_dangling_key lti_lldk;
 917 };
 918
 919 /* lfsck_lib.c */
 920 int lfsck_fid_alloc(const struct lu_env *env, struct lfsck_instance *lfsck,
 921                     struct lu_fid *fid, bool locked);
 922 int lfsck_ibits_lock(const struct lu_env *env, struct lfsck_instance *lfsck,
 923                      struct dt_object *obj, struct lustre_handle *lh,
 924                      __u64 bits, enum ldlm_mode mode);
 925 void lfsck_ibits_unlock(struct lustre_handle *lh, enum ldlm_mode mode);
 926 int lfsck_remote_lookup_lock(const struct lu_env *env,
 927                              struct lfsck_instance *lfsck,
 928                              struct dt_object *pobj, struct dt_object *obj,
 929                              struct lustre_handle *lh, enum ldlm_mode mode);
 930 int lfsck_lock(const struct lu_env *env, struct lfsck_instance *lfsck,
 931                struct dt_object *obj, const char *name,
 932                struct lfsck_lock_handle *llh, __u64 bits, enum ldlm_mode mode);
 933 void lfsck_unlock(struct lfsck_lock_handle *llh);
 934 int lfsck_find_mdt_idx_by_fid(const struct lu_env *env,
 935                               struct lfsck_instance *lfsck,
 936                               const struct lu_fid *fid);
 937 int lfsck_verify_lpf(const struct lu_env *env, struct lfsck_instance *lfsck);
 938 struct lfsck_instance *lfsck_instance_find(struct dt_device *key, bool ref,
 939                                            bool unlink);
 940 struct lfsck_component *lfsck_component_find(struct lfsck_instance *lfsck,
 941                                              __u16 type);
 942 void lfsck_component_cleanup(const struct lu_env *env,
 943                              struct lfsck_component *com);
 944 void lfsck_instance_cleanup(const struct lu_env *env,
 945                             struct lfsck_instance *lfsck);
 946 void lfsck_bits_dump(struct seq_file *m, int bits, const char *names[],
 947                      const char *prefix);
 948 void lfsck_time_dump(struct seq_file *m, time64_t time, const char *name);
 949 void lfsck_pos_dump(struct seq_file *m, struct lfsck_position *pos,
 950                     const char *prefix);
 951 void lfsck_pos_fill(const struct lu_env *env, struct lfsck_instance *lfsck,
 952                     struct lfsck_position *pos, bool init);
 953 bool __lfsck_set_speed(struct lfsck_instance *lfsck, __u32 limit);
 954 void lfsck_control_speed(struct lfsck_instance *lfsck);
 955 void lfsck_control_speed_by_self(struct lfsck_component *com);
 956 void lfsck_thread_args_fini(struct lfsck_thread_args *lta);
 957 struct lfsck_assistant_data *
 958 lfsck_assistant_data_init(struct lfsck_assistant_operations *lao,
 959                           const char *name);
 960 struct lfsck_assistant_object *
 961 lfsck_assistant_object_init(const struct lu_env *env, const struct lu_fid *fid,
 962                             const struct lu_attr *attr, __u64 cookie,
 963                             bool is_dir);
 964 struct dt_object *
 965 lfsck_assistant_object_load(const struct lu_env *env,
 966                             struct lfsck_instance *lfsck,
 967                             struct lfsck_assistant_object *lso);
 968 int lfsck_async_interpret_common(const struct lu_env *env,
 969                                  struct ptlrpc_request *req,
 970                                  void *args, int rc);
 971 int lfsck_async_request(const struct lu_env *env, struct obd_export *exp,
 972                         struct lfsck_request *lr,
 973                         struct ptlrpc_request_set *set,
 974                         ptlrpc_interpterer_t interpterer,
 975                         void *args, int request);
 976 int lfsck_query_all(const struct lu_env *env, struct lfsck_component *com);
 977 int lfsck_start_assistant(const struct lu_env *env, struct lfsck_component *com,
 978                           struct lfsck_start_param *lsp);
 979 int lfsck_checkpoint_generic(const struct lu_env *env,
 980                              struct lfsck_component *com);
 981 void lfsck_post_generic(const struct lu_env *env,
 982                         struct lfsck_component *com, int *result);
 983 int lfsck_double_scan_generic(const struct lu_env *env,
 984                               struct lfsck_component *com, int status);
 985 void lfsck_quit_generic(const struct lu_env *env,
 986                         struct lfsck_component *com);
 987 int lfsck_load_one_trace_file(const struct lu_env *env,
 988                               struct lfsck_component *com,
 989                               struct dt_object *parent,
 990                               struct dt_object **child,
 991                               const struct dt_index_features *ft,
 992                               const char *name, bool reset);
 993 int lfsck_load_sub_trace_files(const struct lu_env *env,
 994                                struct lfsck_component *com,
 995                                const struct dt_index_features *ft,
 996                                const char *prefix, bool reset);
 997
 998 /* lfsck_engine.c */
 999 int lfsck_unpack_ent(struct lu_dirent *ent, __u64 *cookie, __u16 *type);
1000 void lfsck_close_dir(const struct lu_env *env,
1001                      struct lfsck_instance *lfsck, int result);
1002 int lfsck_open_dir(const struct lu_env *env,
1003                    struct lfsck_instance *lfsck, __u64 cookie);
1004 int lfsck_master_engine(void *args);
1005 int lfsck_assistant_engine(void *args);
1006
1007 /* lfsck_bookmark.c */
1008 void lfsck_bookmark_cpu_to_le(struct lfsck_bookmark *des,
1009                               struct lfsck_bookmark *src);
1010 int lfsck_bookmark_store(const struct lu_env *env,
1011                          struct lfsck_instance *lfsck);
1012 int lfsck_bookmark_setup(const struct lu_env *env,
1013                          struct lfsck_instance *lfsck);
1014 int lfsck_set_param(const struct lu_env *env, struct lfsck_instance *lfsck,
1015                     struct lfsck_start *start, bool reset);
1016
1017 /* lfsck_namespace.c */
1018 int lfsck_namespace_trace_update(const struct lu_env *env,
1019                                  struct lfsck_component *com,
1020                                  const struct lu_fid *fid,
1021                                  const __u8 flags, bool add);
1022 int lfsck_namespace_check_exist(const struct lu_env *env,
1023                                 struct dt_object *dir,
1024                                 struct dt_object *obj, const char *name);
1025 int __lfsck_links_read(const struct lu_env *env, struct dt_object *obj,
1026                        struct linkea_data *ldata, bool with_rec);
1027 int lfsck_namespace_rebuild_linkea(const struct lu_env *env,
1028                                    struct lfsck_component *com,
1029                                    struct dt_object *obj,
1030                                    struct linkea_data *ldata);
1031 int lfsck_namespace_repair_dangling(const struct lu_env *env,
1032                                     struct lfsck_component *com,
1033                                     struct dt_object *parent,
1034                                     struct dt_object *child,
1035                                     struct lfsck_namespace_req *lnr);
1036 int lfsck_namespace_repair_dirent(const struct lu_env *env,
1037                                   struct lfsck_component *com,
1038                                   struct dt_object *parent,
1039                                   struct dt_object *child,
1040                                   const char *name, const char *name2,
1041                                   __u16 type, bool update, bool dec);
1042 int lfsck_verify_linkea(const struct lu_env *env, struct dt_object *obj,
1043                         const struct lu_name *cname, const struct lu_fid *pfid);
1044 int lfsck_links_get_first(const struct lu_env *env, struct dt_object *obj,
1045                           char *name, struct lu_fid *pfid);
1046 int lfsck_update_name_entry(const struct lu_env *env,
1047                             struct lfsck_instance *lfsck,
1048                             struct dt_object *dir, const char *name,
1049                             const struct lu_fid *fid, __u32 type);
1050 int lfsck_namespace_setup(const struct lu_env *env,
1051                           struct lfsck_instance *lfsck);
1052
1053 /* lfsck_striped_dir.c */
1054 void lfsck_lmv_put(const struct lu_env *env, struct lfsck_lmv *llmv);
1055 int lfsck_read_stripe_lmv(const struct lu_env *env,
1056                           struct lfsck_instance *lfsck,
1057                           struct dt_object *obj,
1058                           struct lmv_mds_md_v1 *lmv);
1059 int lfsck_shard_name_to_index(const struct lu_env *env, const char *name,
1060                               int namelen, __u16 type,
1061                               const struct lu_fid *fid);
1062 bool lfsck_is_valid_slave_name_entry(const struct lu_env *env,
1063                                      struct lfsck_lmv *llmv,
1064                                      const char *name, int namelen);
1065 int lfsck_namespace_check_name(const struct lu_env *env,
1066                                struct lfsck_instance *lfsck,
1067                                struct dt_object *parent,
1068                                struct dt_object *child,
1069                                const struct lu_name *cname);
1070 int lfsck_namespace_update_lmv(const struct lu_env *env,
1071                                struct lfsck_component *com,
1072                                struct dt_object *obj,
1073                                struct lmv_mds_md_v1 *lmv, bool locked);
1074 int lfsck_namespace_verify_stripe_slave(const struct lu_env *env,
1075                                         struct lfsck_component *com,
1076                                         struct dt_object *obj,
1077                                         struct lfsck_lmv *llmv);
1078 int lfsck_namespace_scan_shard(const struct lu_env *env,
1079                                struct lfsck_component *com,
1080                                struct dt_object *child);
1081 int lfsck_namespace_notify_lmv_master_local(const struct lu_env *env,
1082                                             struct lfsck_component *com,
1083                                             struct dt_object *obj);
1084 int lfsck_namespace_repair_bad_name_hash(const struct lu_env *env,
1085                                          struct lfsck_component *com,
1086                                          struct dt_object *shard,
1087                                          struct lfsck_lmv *llmv,
1088                                          const char *name);
1089 int lfsck_namespace_striped_dir_rescan(const struct lu_env *env,
1090                                        struct lfsck_component *com,
1091                                        struct lfsck_namespace_req *lnr);
1092 int lfsck_namespace_handle_striped_master(const struct lu_env *env,
1093                                           struct lfsck_component *com,
1094                                           struct lfsck_namespace_req *lnr);
1095
1096 /* lfsck_layout.c */
1097 int lfsck_layout_setup(const struct lu_env *env, struct lfsck_instance *lfsck);
1098
1099 extern const char dot[];
1100 extern const char dotdot[];
1101 extern const char *lfsck_flags_names[];
1102 extern const char *lfsck_param_names[];
1103 extern struct lu_context_key lfsck_thread_key;
1104
1105 static inline struct dt_device *lfsck_obj2dev(struct dt_object *obj)
1106 {
1107         return container_of0(obj->do_lu.lo_dev, struct dt_device, dd_lu_dev);
1108 }
1109
1110 static inline struct lfsck_thread_info *
1111 lfsck_env_info(const struct lu_env *env)
1112 {
1113         struct lfsck_thread_info *info;
1114
1115         info = lu_context_key_get(&env->le_ctx, &lfsck_thread_key);
1116         LASSERT(info != NULL);
1117         return info;
1118 }
1119
1120 static inline const struct lu_name *
1121 lfsck_name_get_const(const struct lu_env *env, const void *area, ssize_t len)
1122 {
1123         struct lu_name *lname;
1124
1125         lname = &lfsck_env_info(env)->lti_name_const;
1126         lname->ln_name = area;
1127         lname->ln_namelen = len;
1128         return lname;
1129 }
1130
1131 static inline void
1132 lfsck_buf_init(struct lu_buf *buf, void *area, ssize_t len)
1133 {
1134         buf->lb_buf = area;
1135         buf->lb_len = len;
1136 }
1137
1138 static inline struct lu_buf *
1139 lfsck_buf_get(const struct lu_env *env, void *area, ssize_t len)
1140 {
1141         struct lu_buf *buf;
1142
1143         buf = &lfsck_env_info(env)->lti_buf;
1144         buf->lb_buf = area;
1145         buf->lb_len = len;
1146         return buf;
1147 }
1148
1149 static inline const struct lu_buf *
1150 lfsck_buf_get_const(const struct lu_env *env, const void *area, ssize_t len)
1151 {
1152         struct lu_buf *buf;
1153
1154         buf = &lfsck_env_info(env)->lti_buf;
1155         buf->lb_buf = (void *)area;
1156         buf->lb_len = len;
1157         return buf;
1158 }
1159
1160 static inline char *lfsck_lfsck2name(struct lfsck_instance *lfsck)
1161 {
1162         return lfsck->li_bottom->dd_lu_dev.ld_obd->obd_name;
1163 }
1164
1165 static inline const struct lu_fid *lfsck_dto2fid(const struct dt_object *obj)
1166 {
1167         return lu_object_fid(&obj->do_lu);
1168 }
1169
1170 static inline void lfsck_pos_set_zero(struct lfsck_position *pos)
1171 {
1172         memset(pos, 0, sizeof(*pos));
1173 }
1174
1175 static inline int lfsck_pos_is_zero(const struct lfsck_position *pos)
1176 {
1177         return pos->lp_oit_cookie == 0 && fid_is_zero(&pos->lp_dir_parent);
1178 }
1179
1180 static inline int lfsck_pos_is_eq(const struct lfsck_position *pos1,
1181                                   const struct lfsck_position *pos2)
1182 {
1183         if (pos1->lp_oit_cookie < pos2->lp_oit_cookie)
1184                 return -1;
1185
1186         if (pos1->lp_oit_cookie > pos2->lp_oit_cookie)
1187                 return 1;
1188
1189         if (fid_is_zero(&pos1->lp_dir_parent) &&
1190             !fid_is_zero(&pos2->lp_dir_parent))
1191                 return -1;
1192
1193         if (!fid_is_zero(&pos1->lp_dir_parent) &&
1194             fid_is_zero(&pos2->lp_dir_parent))
1195                 return 1;
1196
1197         if (fid_is_zero(&pos1->lp_dir_parent) &&
1198             fid_is_zero(&pos2->lp_dir_parent))
1199                 return 0;
1200
1201         LASSERT(lu_fid_eq(&pos1->lp_dir_parent, &pos2->lp_dir_parent));
1202
1203         if (pos1->lp_dir_cookie < pos2->lp_dir_cookie)
1204                 return -1;
1205
1206         if (pos1->lp_dir_cookie > pos2->lp_dir_cookie)
1207                 return 1;
1208
1209         return 0;
1210 }
1211
1212 static void inline lfsck_position_le_to_cpu(struct lfsck_position *des,
1213                                             struct lfsck_position *src)
1214 {
1215         des->lp_oit_cookie = le64_to_cpu(src->lp_oit_cookie);
1216         fid_le_to_cpu(&des->lp_dir_parent, &src->lp_dir_parent);
1217         des->lp_dir_cookie = le64_to_cpu(src->lp_dir_cookie);
1218 }
1219
1220 static void inline lfsck_position_cpu_to_le(struct lfsck_position *des,
1221                                             struct lfsck_position *src)
1222 {
1223         des->lp_oit_cookie = cpu_to_le64(src->lp_oit_cookie);
1224         fid_cpu_to_le(&des->lp_dir_parent, &src->lp_dir_parent);
1225         des->lp_dir_cookie = cpu_to_le64(src->lp_dir_cookie);
1226 }
1227
1228 static inline umode_t lfsck_object_type(const struct dt_object *obj)
1229 {
1230         return lu_object_attr(&obj->do_lu);
1231 }
1232
1233 static inline int lfsck_is_dead_obj(const struct dt_object *obj)
1234 {
1235         return lu_object_is_dying(obj->do_lu.lo_header);
1236 }
1237
1238 static inline struct dt_object *lfsck_object_get(struct dt_object *obj)
1239 {
1240         lu_object_get(&obj->do_lu);
1241         return obj;
1242 }
1243
1244 static inline void lfsck_object_put(const struct lu_env *env,
1245                                     struct dt_object *obj)
1246 {
1247         dt_object_put(env, obj);
1248 }
1249
1250 static inline struct seq_server_site
1251 *lfsck_dev_site(struct lfsck_instance *lfsck)
1252 {
1253         return lu_site2seq(lfsck->li_bottom->dd_lu_dev.ld_site);
1254 }
1255
1256 static inline u32 lfsck_dev_idx(struct lfsck_instance *lfsck)
1257 {
1258         return lfsck_dev_site(lfsck)->ss_node_id;
1259 }
1260
1261 static inline struct dt_object *
1262 lfsck_object_find_by_dev_new(const struct lu_env *env, struct dt_device *dev,
1263                              const struct lu_fid *fid)
1264 {
1265         struct lu_object_conf   *conf = &lfsck_env_info(env)->lti_conf;
1266
1267         conf->loc_flags = LOC_F_NEW;
1268         return lu2dt(lu_object_find_slice(env, dt2lu_dev(dev), fid, conf));
1269 }
1270
1271 static inline struct dt_object *
1272 lfsck_object_find_by_dev(const struct lu_env *env, struct dt_device *dev,
1273                          const struct lu_fid *fid)
1274 {
1275         return lu2dt(lu_object_find_slice(env, dt2lu_dev(dev), fid, NULL));
1276 }
1277
1278 static inline struct dt_device *
1279 lfsck_find_dev_by_fid(const struct lu_env *env, struct lfsck_instance *lfsck,
1280                       const struct lu_fid *fid)
1281 {
1282         struct dt_device *dev;
1283         int               idx;
1284
1285         if (!lfsck->li_master)
1286                 return lfsck->li_bottom;
1287
1288         idx = lfsck_find_mdt_idx_by_fid(env, lfsck, fid);
1289         if (idx < 0)
1290                 return ERR_PTR(idx);
1291
1292         if (idx == lfsck_dev_idx(lfsck)) {
1293                 dev = lfsck->li_bottom;
1294         } else {
1295                 struct lfsck_tgt_desc *ltd;
1296
1297                 ltd = lfsck_ltd2tgt(&lfsck->li_mdt_descs, idx);
1298                 if (unlikely(ltd == NULL))
1299                         return ERR_PTR(-ENODEV);
1300
1301                 dev = ltd->ltd_tgt;
1302         }
1303
1304         return dev;
1305 }
1306
1307 static inline struct dt_object *
1308 lfsck_object_find_bottom(const struct lu_env *env, struct lfsck_instance *lfsck,
1309                          const struct lu_fid *fid)
1310 {
1311         struct dt_device *dev;
1312
1313         dev = lfsck_find_dev_by_fid(env, lfsck, fid);
1314         if (IS_ERR(dev))
1315                 return (struct dt_object *)dev;
1316
1317         return lfsck_object_find_by_dev(env, dev, fid);
1318 }
1319
1320 static inline struct dt_object *
1321 lfsck_object_find_bottom_new(const struct lu_env *env,
1322                              struct lfsck_instance *lfsck,
1323                              const struct lu_fid *fid)
1324 {
1325         struct dt_device *dev;
1326
1327         dev = lfsck_find_dev_by_fid(env, lfsck, fid);
1328         if (IS_ERR(dev))
1329                 return (struct dt_object *)dev;
1330
1331         return lfsck_object_find_by_dev_new(env, dev, fid);
1332 }
1333
1334 static inline struct dt_object *
1335 lfsck_object_locate(struct dt_device *dev, struct dt_object *obj)
1336 {
1337         if (lfsck_obj2dev(obj) == dev) {
1338                 return obj;
1339         } else {
1340                 struct lu_object *lo;
1341
1342                 lo = lu_object_locate(obj->do_lu.lo_header,
1343                                       dev->dd_lu_dev.ld_type);
1344                 if (unlikely(lo == NULL))
1345                         return ERR_PTR(-ENOENT);
1346
1347                 return lu2dt(lo);
1348         }
1349 }
1350
1351 static inline struct lfsck_tgt_desc *lfsck_tgt_get(struct lfsck_tgt_descs *ltds,
1352                                                    __u32 index)
1353 {
1354         struct lfsck_tgt_desc *ltd;
1355
1356         ltd = lfsck_ltd2tgt(ltds, index);
1357         if (ltd != NULL)
1358                 atomic_inc(&ltd->ltd_ref);
1359
1360         return ltd;
1361 }
1362
1363 static inline void lfsck_tgt_put(struct lfsck_tgt_desc *ltd)
1364 {
1365         if (atomic_dec_and_test(&ltd->ltd_ref))
1366                 OBD_FREE_PTR(ltd);
1367 }
1368
1369 static inline struct lfsck_component *
1370 lfsck_component_get(struct lfsck_component *com)
1371 {
1372         atomic_inc(&com->lc_ref);
1373
1374         return com;
1375 }
1376
1377 static inline void lfsck_component_put(const struct lu_env *env,
1378                                        struct lfsck_component *com)
1379 {
1380         if (atomic_dec_and_test(&com->lc_ref)) {
1381                 struct lfsck_sub_trace_obj *lsto;
1382                 int                         i;
1383
1384                 for (i = 0, lsto = &com->lc_sub_trace_objs[0];
1385                      i < LFSCK_STF_COUNT; i++, lsto++) {
1386                         if (lsto->lsto_obj != NULL)
1387                                 lfsck_object_put(env, lsto->lsto_obj);
1388                 }
1389
1390                 if (com->lc_obj != NULL)
1391                         lfsck_object_put(env, com->lc_obj);
1392                 if (com->lc_file_ram != NULL)
1393                         OBD_FREE(com->lc_file_ram, com->lc_file_size);
1394                 if (com->lc_file_disk != NULL)
1395                         OBD_FREE(com->lc_file_disk, com->lc_file_size);
1396                 if (com->lc_data != NULL) {
1397                         LASSERT(com->lc_ops->lfsck_data_release != NULL);
1398
1399                         com->lc_ops->lfsck_data_release(env, com);
1400                 }
1401
1402                 OBD_FREE_PTR(com);
1403         }
1404 }
1405
1406 static inline struct lfsck_instance *
1407 lfsck_instance_get(struct lfsck_instance *lfsck)
1408 {
1409         atomic_inc(&lfsck->li_ref);
1410
1411         return lfsck;
1412 }
1413
1414 static inline void lfsck_instance_put(const struct lu_env *env,
1415                                       struct lfsck_instance *lfsck)
1416 {
1417         if (atomic_dec_and_test(&lfsck->li_ref))
1418                 lfsck_instance_cleanup(env, lfsck);
1419 }
1420
1421 static inline bool lfsck_phase2_next_ready(struct lfsck_assistant_data *lad)
1422 {
1423         return list_empty(&lad->lad_mdt_phase1_list) &&
1424                (!list_empty(&lad->lad_ost_phase2_list) ||
1425                 list_empty(&lad->lad_ost_phase1_list));
1426 }
1427
1428 static inline void lfsck_lad_set_bitmap(const struct lu_env *env,
1429                                         struct lfsck_component *com,
1430                                         __u32 index)
1431 {
1432         struct lfsck_assistant_data     *lad    = com->lc_data;
1433         struct cfs_bitmap               *bitmap = lad->lad_bitmap;
1434
1435         LASSERT(com->lc_lfsck->li_master);
1436         LASSERT(bitmap != NULL);
1437
1438         if (likely(bitmap->size > index)) {
1439                 cfs_bitmap_set(bitmap, index);
1440                 set_bit(LAD_INCOMPLETE, &lad->lad_flags);
1441         } else if (com->lc_type == LFSCK_TYPE_NAMESPACE) {
1442                 struct lfsck_namespace *ns = com->lc_file_ram;
1443
1444                 ns->ln_flags |= LF_INCOMPLETE;
1445         }
1446
1447         CDEBUG(D_LFSCK, "%s: %s LFSCK set bitmap (%p/%u) for idx %u\n",
1448                lfsck_lfsck2name(com->lc_lfsck), lad->lad_name, bitmap,
1449                bitmap->size, index);
1450 }
1451
1452 static inline int lfsck_links_read(const struct lu_env *env,
1453                                    struct dt_object *obj,
1454                                    struct linkea_data *ldata)
1455 {
1456         ldata->ld_buf =
1457                 lu_buf_check_and_alloc(&lfsck_env_info(env)->lti_linkea_buf,
1458                                        MAX_LINKEA_SIZE);
1459
1460         return __lfsck_links_read(env, obj, ldata, false);
1461 }
1462
1463 /* Read linkEA for the given object, the linkEA should contain
1464  * at least one entry, otherwise, -ENODATA will be returned. */
1465 static inline int lfsck_links_read_with_rec(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, true);
1474 }
1475
1476 static inline int lfsck_links_read2_with_rec(const struct lu_env *env,
1477                                              struct dt_object *obj,
1478                                              struct linkea_data *ldata)
1479 {
1480         ldata->ld_buf =
1481                 lu_buf_check_and_alloc(&lfsck_env_info(env)->lti_linkea_buf2,
1482                                        MAX_LINKEA_SIZE);
1483
1484         return __lfsck_links_read(env, obj, ldata, true);
1485 }
1486
1487 static inline struct lfsck_lmv *lfsck_lmv_get(struct lfsck_lmv *llmv)
1488 {
1489         if (llmv != NULL)
1490                 atomic_inc(&llmv->ll_ref);
1491
1492         return llmv;
1493 }
1494
1495 static inline int lfsck_sub_trace_file_fid2idx(const struct lu_fid *fid)
1496 {
1497         return fid->f_oid & (LFSCK_STF_COUNT - 1);
1498 }
1499
1500 static inline void lfsck_lmv_header_le_to_cpu(struct lmv_mds_md_v1 *dst,
1501                                               const struct lmv_mds_md_v1 *src)
1502 {
1503         dst->lmv_magic = le32_to_cpu(src->lmv_magic);
1504         dst->lmv_stripe_count = le32_to_cpu(src->lmv_stripe_count);
1505         dst->lmv_master_mdt_index = le32_to_cpu(src->lmv_master_mdt_index);
1506         dst->lmv_hash_type = le32_to_cpu(src->lmv_hash_type);
1507         dst->lmv_layout_version = le32_to_cpu(src->lmv_layout_version);
1508         dst->lmv_migrate_offset = le32_to_cpu(src->lmv_migrate_offset);
1509         dst->lmv_migrate_hash = le32_to_cpu(src->lmv_migrate_hash);
1510 }
1511
1512 static inline void lfsck_lmv_header_cpu_to_le(struct lmv_mds_md_v1 *dst,
1513                                               const struct lmv_mds_md_v1 *src)
1514 {
1515         dst->lmv_magic = cpu_to_le32(src->lmv_magic);
1516         dst->lmv_stripe_count = cpu_to_le32(src->lmv_stripe_count);
1517         dst->lmv_master_mdt_index = cpu_to_le32(src->lmv_master_mdt_index);
1518         dst->lmv_hash_type = cpu_to_le32(src->lmv_hash_type);
1519         dst->lmv_layout_version = cpu_to_le32(src->lmv_layout_version);
1520         dst->lmv_migrate_offset = cpu_to_le32(src->lmv_migrate_offset);
1521         dst->lmv_migrate_hash = cpu_to_le32(src->lmv_migrate_hash);
1522 }
1523
1524 static inline struct lfsck_assistant_object *
1525 lfsck_assistant_object_get(struct lfsck_assistant_object *lso)
1526 {
1527         atomic_inc(&lso->lso_ref);
1528
1529         return lso;
1530 }
1531
1532 static inline void
1533 lfsck_assistant_object_put(const struct lu_env *env,
1534                            struct lfsck_assistant_object *lso)
1535 {
1536         if (atomic_dec_and_test(&lso->lso_ref))
1537                 OBD_FREE_PTR(lso);
1538 }
1539 #endif /* _LFSCK_INTERNAL_H */