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_retry_start:1,
 477                            ltd_layout_done:1,
 478                            ltd_namespace_done:1,
 479                            ltd_synced_failures:1;
 480 };
 481
 482 struct lfsck_tgt_desc_idx {
 483         struct lfsck_tgt_desc *ldi_tgts[TGT_PTRS_PER_BLOCK];
 484 };
 485
 486 struct lfsck_tgt_descs {
 487         /* list of known TGTs */
 488         struct lfsck_tgt_desc_idx       *ltd_tgts_idx[TGT_PTRS];
 489
 490         /* bitmap of TGTs available */
 491         struct cfs_bitmap                       *ltd_tgts_bitmap;
 492
 493         /* for lfsck_tgt_desc::ltd_xxx_list */
 494         spinlock_t                       ltd_lock;
 495
 496         /* for tgts table accessing and changes */
 497         struct rw_semaphore              ltd_rw_sem;
 498
 499         /* Temporary list for orphan targets. */
 500         struct list_head                 ltd_orphan;
 501
 502         /* number of registered TGTs */
 503         __u32                            ltd_tgtnr;
 504 };
 505
 506 static inline struct lfsck_tgt_desc *
 507 lfsck_ltd2tgt(struct lfsck_tgt_descs *ltd, __u32 index)
 508 {
 509         __u32 idx1 = index / TGT_PTRS_PER_BLOCK;
 510         __u32 idx2 = index % TGT_PTRS_PER_BLOCK;
 511         struct lfsck_tgt_desc *__tgt = NULL;
 512
 513         if (unlikely(idx1 >= TGT_PTRS))
 514                 CDEBUG(D_LFSCK, "The target idx %u is invalid.\n", index);
 515         else if (likely(ltd->ltd_tgts_idx[idx1] != NULL))
 516                 __tgt = ltd->ltd_tgts_idx[idx1]->ldi_tgts[idx2];
 517
 518         return __tgt;
 519 }
 520
 521 static inline void lfsck_assign_tgt(struct lfsck_tgt_descs *ltd,
 522                                     struct lfsck_tgt_desc *tgt, __u32 index)
 523 {
 524         __u32 idx1 = index / TGT_PTRS_PER_BLOCK;
 525         __u32 idx2 = index % TGT_PTRS_PER_BLOCK;
 526
 527         if (likely(idx1 < TGT_PTRS && ltd->ltd_tgts_idx[idx1] != NULL))
 528                 ltd->ltd_tgts_idx[idx1]->ldi_tgts[idx2] = tgt;
 529 }
 530
 531 #define LFSCK_STF_BITS  4
 532 /* If want to adjust the LFSCK_STF_COUNT, please change LFSCK_STF_BITS. */
 533 #define LFSCK_STF_COUNT (1 << LFSCK_STF_BITS)
 534
 535 struct lfsck_sub_trace_obj {
 536         struct dt_object        *lsto_obj;
 537         struct mutex             lsto_mutex;
 538 };
 539
 540 struct lfsck_component {
 541         /* into lfsck_instance::li_list_(scan,double_scan,idle} */
 542         struct list_head         lc_link;
 543
 544         /* into lfsck_instance::li_list_dir */
 545         struct list_head         lc_link_dir;
 546
 547         struct rw_semaphore      lc_sem;
 548         atomic_t                 lc_ref;
 549
 550         struct lfsck_position    lc_pos_start;
 551         struct lfsck_instance   *lc_lfsck;
 552         struct dt_object        *lc_obj;
 553         struct lfsck_sub_trace_obj lc_sub_trace_objs[LFSCK_STF_COUNT];
 554         struct lfsck_operations *lc_ops;
 555         void                    *lc_file_ram;
 556         void                    *lc_file_disk;
 557         void                    *lc_data;
 558         struct lu_fid            lc_fid_latest_scanned_phase2;
 559
 560         /* The time for last checkpoint, jiffies */
 561         cfs_time_t               lc_time_last_checkpoint;
 562
 563         /* The time for next checkpoint, jiffies */
 564         cfs_time_t               lc_time_next_checkpoint;
 565
 566         __u32                    lc_file_size;
 567
 568         /* How many objects have been checked since last checkpoint. */
 569         __u32                    lc_new_checked;
 570
 571         /* How many objects have been scanned since last sleep. */
 572         __u32                    lc_new_scanned;
 573
 574         __u16                    lc_type;
 575 };
 576
 577 #define LFSCK_LMV_MAX_STRIPES   LMV_MAX_STRIPE_COUNT
 578 #define LFSCK_LMV_DEF_STRIPES   4
 579
 580 /* Warning: NOT change the lfsck_slave_lmv_flags members order,
 581  *          otherwise the lfsck_record_lmv() may be wrong. */
 582 enum lfsck_slave_lmv_flags {
 583         LSLF_NONE       = 0,
 584         LSLF_BAD_INDEX2 = 1,
 585         LSLF_NO_LMVEA   = 2,
 586         LSLF_DANGLING   = 3,
 587         LSLF_BAD_INDEX1 = 4,
 588 };
 589
 590 /* When the namespace LFSCK scans a striped directory, it will record all
 591  * the known shards' information in the structure "lfsck_slave_lmv_rec",
 592  * including the shard's FID, index, slave LMV EA, and so on. Each shard
 593  * will take one lfsck_slave_lmv_rec slot. After the 1st cycle scanning
 594  * the striped directory, the LFSCK will get all the information about
 595  * whether there are some inconsistency, and then it can repair them in
 596  * the 2nd cycle scanning. */
 597 struct lfsck_slave_lmv_rec {
 598         struct lu_fid   lslr_fid;
 599         __u32           lslr_stripe_count;
 600         __u32           lslr_index; /* the index in name or in slave lmv */
 601         __u32           lslr_hash_type;
 602         __u32           lslr_flags;
 603 };
 604
 605 struct lfsck_lmv {
 606         struct lmv_mds_md_v1             ll_lmv;
 607         atomic_t                         ll_ref;
 608         int                              ll_stripes_allocated;
 609         int                              ll_stripes_filled;
 610         int                              ll_exit_value;
 611         __u32                            ll_max_stripe_count;
 612         __u32                            ll_max_filled_off;
 613         __u32                            ll_hash_type;
 614         unsigned int                     ll_lmv_master:1,
 615                                          ll_lmv_slave:1,
 616                                          ll_lmv_verified:1,
 617                                          ll_lmv_updated:1,
 618                                          ll_inline:1,
 619                                          ll_failed:1,
 620                                          ll_ignore:1;
 621         struct lfsck_slave_lmv_rec      *ll_lslr; /* may be vmalloc'd */
 622 };
 623
 624 /* If the namespace LFSCK finds that the master MDT-object of a striped
 625  * directory lost its master LMV EA, it will re-generate the master LMV
 626  * EA and notify the LFSCK instance on the MDT on which the striped dir
 627  * master MDT-object resides to rescan the striped directory. To do that,
 628  * the notify handler will insert a "lfsck_lmv_unit" structure into the
 629  * lfsck::li_list_lmv. The LFSCK instance will scan such list from time
 630  * to time to check whether needs to rescan some stirped directories. */
 631 struct lfsck_lmv_unit {
 632         struct list_head         llu_link;
 633         struct lfsck_lmv         llu_lmv;
 634         struct dt_object        *llu_obj;
 635         struct lfsck_instance   *llu_lfsck;
 636 };
 637
 638 struct lfsck_rec_lmv_save {
 639         struct lu_fid           lrls_fid;
 640         struct lmv_mds_md_v1    lrls_lmv;
 641 };
 642
 643 /* Allow lfsck_record_lmv() to be called recursively at most three times. */
 644 #define LFSCK_REC_LMV_MAX_DEPTH 3
 645
 646 struct lfsck_instance {
 647         struct mutex              li_mutex;
 648         spinlock_t                li_lock;
 649
 650         /* Link into the lfsck_instance_list. */
 651         struct list_head          li_link;
 652
 653         /* For the components in (first) scanning via otable-based iteration. */
 654         struct list_head          li_list_scan;
 655
 656         /* For the components in scanning via directory traversal. Because
 657          * directory traversal cannot guarantee all the object be scanned,
 658          * so the component in the li_list_dir must be in li_list_scan. */
 659         struct list_head          li_list_dir;
 660
 661         /* For the components in double scanning. */
 662         struct list_head          li_list_double_scan;
 663
 664         /* For the components those are not scanning now. */
 665         struct list_head          li_list_idle;
 666
 667         /* For the lfsck_lmv_unit to be handled. */
 668         struct list_head          li_list_lmv;
 669
 670         atomic_t                  li_ref;
 671         atomic_t                  li_double_scan_count;
 672         struct ptlrpc_thread      li_thread;
 673
 674         /* The time for last checkpoint, jiffies */
 675         cfs_time_t                li_time_last_checkpoint;
 676
 677         /* The time for next checkpoint, jiffies */
 678         cfs_time_t                li_time_next_checkpoint;
 679
 680         lfsck_out_notify          li_out_notify;
 681         void                     *li_out_notify_data;
 682         struct dt_device         *li_next;
 683         struct dt_device         *li_bottom;
 684         struct obd_device        *li_obd;
 685         struct ldlm_namespace    *li_namespace;
 686         struct local_oid_storage *li_los;
 687         struct lu_fid             li_local_root_fid;  /* backend root "/" */
 688         struct lu_fid             li_global_root_fid; /* /ROOT */
 689         struct dt_object         *li_lfsck_dir;
 690         struct dt_object         *li_bookmark_obj;
 691         struct dt_object         *li_lpf_obj;
 692         struct dt_object         *li_lpf_root_obj;
 693         struct lu_client_seq     *li_seq;
 694         struct lfsck_bookmark     li_bookmark_ram;
 695         struct lfsck_bookmark     li_bookmark_disk;
 696         struct lfsck_position     li_pos_current;
 697         struct lfsck_position     li_pos_checkpoint;
 698
 699         struct lfsck_lmv         *li_lmv;
 700
 701         /* Obj for otable-based iteration */
 702         struct dt_object         *li_obj_oit;
 703
 704         /* Obj for directory traversal */
 705         struct dt_object         *li_obj_dir;
 706
 707         /* It for otable-based iteration */
 708         struct dt_it             *li_di_oit;
 709
 710         /* It for directory traversal */
 711         struct dt_it             *li_di_dir;
 712
 713         /* Description of OST */
 714         struct lfsck_tgt_descs    li_ost_descs;
 715
 716         /* Description of MDT */
 717         struct lfsck_tgt_descs    li_mdt_descs;
 718
 719         /* namespace-based directory traversal position. */
 720         __u64                     li_cookie_dir;
 721
 722         /* Arguments for low layer otable-based iteration. */
 723         __u32                     li_args_oit;
 724
 725         /* Arugments for namespace-based directory traversal. */
 726         __u32                     li_args_dir;
 727
 728         /* Schedule for every N objects. */
 729         __u32                     li_sleep_rate;
 730
 731         /* Sleep N jiffies for each schedule. */
 732         __u32                     li_sleep_jif;
 733
 734         /* How many objects have been scanned since last sleep. */
 735         __u32                     li_new_scanned;
 736
 737         /* The status when the LFSCK stopped or paused. */
 738         __u32                     li_status;
 739
 740         /* The flags when the lFSCK stopped or paused. */
 741         __u32                     li_flags;
 742
 743         unsigned int              li_oit_over:1, /* oit is finished. */
 744                                   li_drop_dryrun:1, /* Ever dryrun, not now. */
 745                                   li_master:1, /* Master instance or not. */
 746                                   li_current_oit_processed:1,
 747                                   li_start_unplug:1,
 748                                   li_stopping:1;
 749         struct lfsck_rec_lmv_save li_rec_lmv_save[LFSCK_REC_LMV_MAX_DEPTH];
 750 };
 751
 752 struct lfsck_async_interpret_args {
 753         struct lfsck_component          *laia_com;
 754         struct lfsck_tgt_descs          *laia_ltds;
 755         struct lfsck_tgt_desc           *laia_ltd;
 756         struct lfsck_request            *laia_lr;
 757         atomic_t                        *laia_count;
 758         int                              laia_result;
 759         unsigned int                     laia_shared:1;
 760 };
 761
 762 struct lfsck_thread_args {
 763         struct lu_env                    lta_env;
 764         struct lfsck_instance           *lta_lfsck;
 765         struct lfsck_component          *lta_com;
 766         struct lfsck_start_param        *lta_lsp;
 767 };
 768
 769 struct lfsck_assistant_req {
 770         struct list_head                 lar_list;
 771         struct lfsck_assistant_object   *lar_parent;
 772 };
 773
 774 struct lfsck_namespace_req {
 775         struct lfsck_assistant_req       lnr_lar;
 776         struct lfsck_lmv                *lnr_lmv;
 777         struct lu_fid                    lnr_fid;
 778         __u64                            lnr_dir_cookie;
 779         __u32                            lnr_attr;
 780         __u32                            lnr_size;
 781         __u16                            lnr_type;
 782         __u16                            lnr_namelen;
 783         char                             lnr_name[0];
 784 };
 785
 786 struct lfsck_layout_req {
 787         struct lfsck_assistant_req       llr_lar;
 788         struct dt_object                *llr_child;
 789         __u32                            llr_comp_id;
 790         __u32                            llr_ost_idx;
 791         __u32                            llr_lov_idx; /* offset in LOV EA */
 792 };
 793
 794 struct lfsck_assistant_operations {
 795         int (*la_handler_p1)(const struct lu_env *env,
 796                              struct lfsck_component *com,
 797                              struct lfsck_assistant_req *lar);
 798
 799         int (*la_handler_p2)(const struct lu_env *env,
 800                              struct lfsck_component *com);
 801
 802         void (*la_fill_pos)(const struct lu_env *env,
 803                             struct lfsck_component *com,
 804                             struct lfsck_position *pos);
 805
 806         int (*la_double_scan_result)(const struct lu_env *env,
 807                                      struct lfsck_component *com,
 808                                      int rc);
 809
 810         void (*la_req_fini)(const struct lu_env *env,
 811                             struct lfsck_assistant_req *lar);
 812
 813         void (*la_sync_failures)(const struct lu_env *env,
 814                                  struct lfsck_component *com,
 815                                  struct lfsck_request *lr);
 816 };
 817
 818 struct lfsck_assistant_data {
 819         spinlock_t                               lad_lock;
 820         struct list_head                         lad_req_list;
 821
 822         /* list for the ost targets involve LFSCK. */
 823         struct list_head                         lad_ost_list;
 824
 825         /* list for the ost targets in phase1 scanning. */
 826         struct list_head                         lad_ost_phase1_list;
 827
 828         /* list for the ost targets in phase2 scanning. */
 829         struct list_head                         lad_ost_phase2_list;
 830
 831         /* list for the mdt targets involve LFSCK. */
 832         struct list_head                         lad_mdt_list;
 833
 834         /* list for the mdt targets in phase1 scanning. */
 835         struct list_head                         lad_mdt_phase1_list;
 836
 837         /* list for the mdt targets in phase2 scanning. */
 838         struct list_head                         lad_mdt_phase2_list;
 839
 840         const char                              *lad_name;
 841         struct ptlrpc_thread                     lad_thread;
 842         struct task_struct                      *lad_task;
 843
 844         struct lfsck_assistant_operations       *lad_ops;
 845
 846         struct cfs_bitmap                               *lad_bitmap;
 847
 848         __u32                                    lad_touch_gen;
 849         int                                      lad_prefetched;
 850         int                                      lad_assistant_status;
 851         int                                      lad_post_result;
 852         unsigned int                             lad_to_post:1,
 853                                                  lad_to_double_scan:1,
 854                                                  lad_in_double_scan:1,
 855                                                  lad_exit:1,
 856                                                  lad_incomplete:1;
 857         bool                                     lad_advance_lock;
 858 };
 859
 860 #define LFSCK_TMPBUF_LEN        64
 861
 862 struct lfsck_lock_handle {
 863         struct lustre_handle    llh_pdo_lh;
 864         struct lustre_handle    llh_reg_lh;
 865         enum ldlm_mode          llh_pdo_mode;
 866         enum ldlm_mode          llh_reg_mode;
 867 };
 868
 869 struct lfsck_thread_info {
 870         struct lu_name          lti_name_const;
 871         struct lu_name          lti_name;
 872         struct lu_name          lti_name2;
 873         struct lu_buf           lti_buf;
 874         struct lu_buf           lti_linkea_buf;
 875         struct lu_buf           lti_linkea_buf2;
 876         struct lu_buf           lti_big_buf;
 877         struct lu_fid           lti_fid;
 878         struct lu_fid           lti_fid2;
 879         struct lu_fid           lti_fid3;
 880         struct lu_fid           lti_fid4;
 881         struct lu_attr          lti_la;
 882         struct lu_attr          lti_la2;
 883         struct ost_id           lti_oi;
 884         struct lustre_ost_attrs lti_loa;
 885         struct dt_object_format lti_dof;
 886         /* There will be '\0' at the end of the name. */
 887         char            lti_key[sizeof(struct lu_dirent) + NAME_MAX + 1];
 888         char                    lti_tmpbuf[LFSCK_TMPBUF_LEN];
 889         char                    lti_tmpbuf2[LFSCK_TMPBUF_LEN];
 890         struct lfsck_request    lti_lr;
 891         struct lfsck_async_interpret_args lti_laia;
 892         struct lfsck_async_interpret_args lti_laia2;
 893         struct lfsck_start      lti_start;
 894         struct lfsck_stop       lti_stop;
 895         union ldlm_policy_data  lti_policy;
 896         struct ldlm_enqueue_info lti_einfo;
 897         struct ldlm_res_id      lti_resid;
 898         struct filter_fid       lti_ff;
 899         struct dt_allocation_hint lti_hint;
 900         struct lu_orphan_rec_v2 lti_rec;
 901         struct lov_user_md      lti_lum;
 902         struct dt_insert_rec    lti_dt_rec;
 903         struct lu_object_conf   lti_conf;
 904         struct lu_seq_range     lti_range;
 905         struct lmv_mds_md_v1    lti_lmv;
 906         struct lmv_mds_md_v1    lti_lmv2;
 907         struct lmv_mds_md_v1    lti_lmv3;
 908         struct lmv_mds_md_v1    lti_lmv4;
 909         struct lfsck_lock_handle lti_llh;
 910         struct lfsck_layout_dangling_key lti_lldk;
 911 };
 912
 913 /* lfsck_lib.c */
 914 int lfsck_fid_alloc(const struct lu_env *env, struct lfsck_instance *lfsck,
 915                     struct lu_fid *fid, bool locked);
 916 int lfsck_ibits_lock(const struct lu_env *env, struct lfsck_instance *lfsck,
 917                      struct dt_object *obj, struct lustre_handle *lh,
 918                      __u64 bits, enum ldlm_mode mode);
 919 void lfsck_ibits_unlock(struct lustre_handle *lh, enum ldlm_mode mode);
 920 int lfsck_lock(const struct lu_env *env, struct lfsck_instance *lfsck,
 921                struct dt_object *obj, const char *name,
 922                struct lfsck_lock_handle *llh, __u64 bits, enum ldlm_mode mode);
 923 void lfsck_unlock(struct lfsck_lock_handle *llh);
 924 int lfsck_find_mdt_idx_by_fid(const struct lu_env *env,
 925                               struct lfsck_instance *lfsck,
 926                               const struct lu_fid *fid);
 927 int lfsck_verify_lpf(const struct lu_env *env, struct lfsck_instance *lfsck);
 928 struct lfsck_instance *lfsck_instance_find(struct dt_device *key, bool ref,
 929                                            bool unlink);
 930 struct lfsck_component *lfsck_component_find(struct lfsck_instance *lfsck,
 931                                              __u16 type);
 932 void lfsck_component_cleanup(const struct lu_env *env,
 933                              struct lfsck_component *com);
 934 void lfsck_instance_cleanup(const struct lu_env *env,
 935                             struct lfsck_instance *lfsck);
 936 void lfsck_bits_dump(struct seq_file *m, int bits, const char *names[],
 937                      const char *prefix);
 938 void lfsck_time_dump(struct seq_file *m, __u64 time, const char *name);
 939 void lfsck_pos_dump(struct seq_file *m, struct lfsck_position *pos,
 940                     const char *prefix);
 941 void lfsck_pos_fill(const struct lu_env *env, struct lfsck_instance *lfsck,
 942                     struct lfsck_position *pos, bool init);
 943 bool __lfsck_set_speed(struct lfsck_instance *lfsck, __u32 limit);
 944 void lfsck_control_speed(struct lfsck_instance *lfsck);
 945 void lfsck_control_speed_by_self(struct lfsck_component *com);
 946 void lfsck_thread_args_fini(struct lfsck_thread_args *lta);
 947 struct lfsck_assistant_data *
 948 lfsck_assistant_data_init(struct lfsck_assistant_operations *lao,
 949                           const char *name);
 950 struct lfsck_assistant_object *
 951 lfsck_assistant_object_init(const struct lu_env *env, const struct lu_fid *fid,
 952                             const struct lu_attr *attr, __u64 cookie,
 953                             bool is_dir);
 954 struct dt_object *
 955 lfsck_assistant_object_load(const struct lu_env *env,
 956                             struct lfsck_instance *lfsck,
 957                             struct lfsck_assistant_object *lso);
 958 int lfsck_async_interpret_common(const struct lu_env *env,
 959                                  struct ptlrpc_request *req,
 960                                  void *args, int rc);
 961 int lfsck_async_request(const struct lu_env *env, struct obd_export *exp,
 962                         struct lfsck_request *lr,
 963                         struct ptlrpc_request_set *set,
 964                         ptlrpc_interpterer_t interpterer,
 965                         void *args, int request);
 966 int lfsck_query_all(const struct lu_env *env, struct lfsck_component *com);
 967 int lfsck_start_assistant(const struct lu_env *env, struct lfsck_component *com,
 968                           struct lfsck_start_param *lsp);
 969 int lfsck_checkpoint_generic(const struct lu_env *env,
 970                              struct lfsck_component *com);
 971 void lfsck_post_generic(const struct lu_env *env,
 972                         struct lfsck_component *com, int *result);
 973 int lfsck_double_scan_generic(const struct lu_env *env,
 974                               struct lfsck_component *com, int status);
 975 void lfsck_quit_generic(const struct lu_env *env,
 976                         struct lfsck_component *com);
 977 int lfsck_load_one_trace_file(const struct lu_env *env,
 978                               struct lfsck_component *com,
 979                               struct dt_object *parent,
 980                               struct dt_object **child,
 981                               const struct dt_index_features *ft,
 982                               const char *name, bool reset);
 983 int lfsck_load_sub_trace_files(const struct lu_env *env,
 984                                struct lfsck_component *com,
 985                                const struct dt_index_features *ft,
 986                                const char *prefix, bool reset);
 987
 988 /* lfsck_engine.c */
 989 int lfsck_unpack_ent(struct lu_dirent *ent, __u64 *cookie, __u16 *type);
 990 void lfsck_close_dir(const struct lu_env *env,
 991                      struct lfsck_instance *lfsck, int result);
 992 int lfsck_open_dir(const struct lu_env *env,
 993                    struct lfsck_instance *lfsck, __u64 cookie);
 994 int lfsck_master_engine(void *args);
 995 int lfsck_assistant_engine(void *args);
 996
 997 /* lfsck_bookmark.c */
 998 void lfsck_bookmark_cpu_to_le(struct lfsck_bookmark *des,
 999                               struct lfsck_bookmark *src);
1000 int lfsck_bookmark_store(const struct lu_env *env,
1001                          struct lfsck_instance *lfsck);
1002 int lfsck_bookmark_setup(const struct lu_env *env,
1003                          struct lfsck_instance *lfsck);
1004 int lfsck_set_param(const struct lu_env *env, struct lfsck_instance *lfsck,
1005                     struct lfsck_start *start, bool reset);
1006
1007 /* lfsck_namespace.c */
1008 int lfsck_namespace_trace_update(const struct lu_env *env,
1009                                  struct lfsck_component *com,
1010                                  const struct lu_fid *fid,
1011                                  const __u8 flags, bool add);
1012 int lfsck_namespace_check_exist(const struct lu_env *env,
1013                                 struct dt_object *dir,
1014                                 struct dt_object *obj, const char *name);
1015 int __lfsck_links_read(const struct lu_env *env, struct dt_object *obj,
1016                        struct linkea_data *ldata, bool with_rec);
1017 int lfsck_namespace_rebuild_linkea(const struct lu_env *env,
1018                                    struct lfsck_component *com,
1019                                    struct dt_object *obj,
1020                                    struct linkea_data *ldata);
1021 int lfsck_namespace_repair_dangling(const struct lu_env *env,
1022                                     struct lfsck_component *com,
1023                                     struct dt_object *parent,
1024                                     struct dt_object *child,
1025                                     struct lfsck_namespace_req *lnr);
1026 int lfsck_namespace_repair_dirent(const struct lu_env *env,
1027                                   struct lfsck_component *com,
1028                                   struct dt_object *parent,
1029                                   struct dt_object *child,
1030                                   const char *name, const char *name2,
1031                                   __u16 type, bool update, bool dec);
1032 int lfsck_verify_linkea(const struct lu_env *env, struct dt_object *obj,
1033                         const struct lu_name *cname, const struct lu_fid *pfid);
1034 int lfsck_links_get_first(const struct lu_env *env, struct dt_object *obj,
1035                           char *name, struct lu_fid *pfid);
1036 int lfsck_update_name_entry(const struct lu_env *env,
1037                             struct lfsck_instance *lfsck,
1038                             struct dt_object *dir, const char *name,
1039                             const struct lu_fid *fid, __u32 type);
1040 int lfsck_namespace_setup(const struct lu_env *env,
1041                           struct lfsck_instance *lfsck);
1042
1043 /* lfsck_striped_dir.c */
1044 void lfsck_lmv_put(const struct lu_env *env, struct lfsck_lmv *llmv);
1045 int lfsck_read_stripe_lmv(const struct lu_env *env, struct dt_object *obj,
1046                           struct lmv_mds_md_v1 *lmv);
1047 int lfsck_shard_name_to_index(const struct lu_env *env, const char *name,
1048                               int namelen, __u16 type,
1049                               const struct lu_fid *fid);
1050 bool lfsck_is_valid_slave_name_entry(const struct lu_env *env,
1051                                      struct lfsck_lmv *llmv,
1052                                      const char *name, int namelen);
1053 int lfsck_namespace_check_name(const struct lu_env *env,
1054                                struct dt_object *parent,
1055                                struct dt_object *child,
1056                                const struct lu_name *cname);
1057 int lfsck_namespace_update_lmv(const struct lu_env *env,
1058                                struct lfsck_component *com,
1059                                struct dt_object *obj,
1060                                struct lmv_mds_md_v1 *lmv, bool locked);
1061 int lfsck_namespace_verify_stripe_slave(const struct lu_env *env,
1062                                         struct lfsck_component *com,
1063                                         struct dt_object *obj,
1064                                         struct lfsck_lmv *llmv);
1065 int lfsck_namespace_scan_shard(const struct lu_env *env,
1066                                struct lfsck_component *com,
1067                                struct dt_object *child);
1068 int lfsck_namespace_notify_lmv_master_local(const struct lu_env *env,
1069                                             struct lfsck_component *com,
1070                                             struct dt_object *obj);
1071 int lfsck_namespace_repair_bad_name_hash(const struct lu_env *env,
1072                                          struct lfsck_component *com,
1073                                          struct dt_object *shard,
1074                                          struct lfsck_lmv *llmv,
1075                                          const char *name);
1076 int lfsck_namespace_striped_dir_rescan(const struct lu_env *env,
1077                                        struct lfsck_component *com,
1078                                        struct lfsck_namespace_req *lnr);
1079 int lfsck_namespace_handle_striped_master(const struct lu_env *env,
1080                                           struct lfsck_component *com,
1081                                           struct lfsck_namespace_req *lnr);
1082
1083 /* lfsck_layout.c */
1084 int lfsck_layout_setup(const struct lu_env *env, struct lfsck_instance *lfsck);
1085
1086 extern const char dot[];
1087 extern const char dotdot[];
1088 extern const char *lfsck_flags_names[];
1089 extern const char *lfsck_param_names[];
1090 extern struct lu_context_key lfsck_thread_key;
1091
1092 static inline bool name_is_dot_or_dotdot(const char *name, int namelen)
1093 {
1094         return name[0] == '.' &&
1095                (namelen == 1 || (namelen == 2 && name[1] == '.'));
1096 }
1097
1098 static inline struct dt_device *lfsck_obj2dev(struct dt_object *obj)
1099 {
1100         return container_of0(obj->do_lu.lo_dev, struct dt_device, dd_lu_dev);
1101 }
1102
1103 static inline struct lfsck_thread_info *
1104 lfsck_env_info(const struct lu_env *env)
1105 {
1106         struct lfsck_thread_info *info;
1107
1108         info = lu_context_key_get(&env->le_ctx, &lfsck_thread_key);
1109         LASSERT(info != NULL);
1110         return info;
1111 }
1112
1113 static inline const struct lu_name *
1114 lfsck_name_get_const(const struct lu_env *env, const void *area, ssize_t len)
1115 {
1116         struct lu_name *lname;
1117
1118         lname = &lfsck_env_info(env)->lti_name_const;
1119         lname->ln_name = area;
1120         lname->ln_namelen = len;
1121         return lname;
1122 }
1123
1124 static inline void
1125 lfsck_buf_init(struct lu_buf *buf, void *area, ssize_t len)
1126 {
1127         buf->lb_buf = area;
1128         buf->lb_len = len;
1129 }
1130
1131 static inline struct lu_buf *
1132 lfsck_buf_get(const struct lu_env *env, void *area, ssize_t len)
1133 {
1134         struct lu_buf *buf;
1135
1136         buf = &lfsck_env_info(env)->lti_buf;
1137         buf->lb_buf = area;
1138         buf->lb_len = len;
1139         return buf;
1140 }
1141
1142 static inline const struct lu_buf *
1143 lfsck_buf_get_const(const struct lu_env *env, const void *area, ssize_t len)
1144 {
1145         struct lu_buf *buf;
1146
1147         buf = &lfsck_env_info(env)->lti_buf;
1148         buf->lb_buf = (void *)area;
1149         buf->lb_len = len;
1150         return buf;
1151 }
1152
1153 static inline char *lfsck_lfsck2name(struct lfsck_instance *lfsck)
1154 {
1155         return lfsck->li_bottom->dd_lu_dev.ld_obd->obd_name;
1156 }
1157
1158 static inline const struct lu_fid *lfsck_dto2fid(const struct dt_object *obj)
1159 {
1160         return lu_object_fid(&obj->do_lu);
1161 }
1162
1163 static inline void lfsck_pos_set_zero(struct lfsck_position *pos)
1164 {
1165         memset(pos, 0, sizeof(*pos));
1166 }
1167
1168 static inline int lfsck_pos_is_zero(const struct lfsck_position *pos)
1169 {
1170         return pos->lp_oit_cookie == 0 && fid_is_zero(&pos->lp_dir_parent);
1171 }
1172
1173 static inline int lfsck_pos_is_eq(const struct lfsck_position *pos1,
1174                                   const struct lfsck_position *pos2)
1175 {
1176         if (pos1->lp_oit_cookie < pos2->lp_oit_cookie)
1177                 return -1;
1178
1179         if (pos1->lp_oit_cookie > pos2->lp_oit_cookie)
1180                 return 1;
1181
1182         if (fid_is_zero(&pos1->lp_dir_parent) &&
1183             !fid_is_zero(&pos2->lp_dir_parent))
1184                 return -1;
1185
1186         if (!fid_is_zero(&pos1->lp_dir_parent) &&
1187             fid_is_zero(&pos2->lp_dir_parent))
1188                 return 1;
1189
1190         if (fid_is_zero(&pos1->lp_dir_parent) &&
1191             fid_is_zero(&pos2->lp_dir_parent))
1192                 return 0;
1193
1194         LASSERT(lu_fid_eq(&pos1->lp_dir_parent, &pos2->lp_dir_parent));
1195
1196         if (pos1->lp_dir_cookie < pos2->lp_dir_cookie)
1197                 return -1;
1198
1199         if (pos1->lp_dir_cookie > pos2->lp_dir_cookie)
1200                 return 1;
1201
1202         return 0;
1203 }
1204
1205 static void inline lfsck_position_le_to_cpu(struct lfsck_position *des,
1206                                             struct lfsck_position *src)
1207 {
1208         des->lp_oit_cookie = le64_to_cpu(src->lp_oit_cookie);
1209         fid_le_to_cpu(&des->lp_dir_parent, &src->lp_dir_parent);
1210         des->lp_dir_cookie = le64_to_cpu(src->lp_dir_cookie);
1211 }
1212
1213 static void inline lfsck_position_cpu_to_le(struct lfsck_position *des,
1214                                             struct lfsck_position *src)
1215 {
1216         des->lp_oit_cookie = cpu_to_le64(src->lp_oit_cookie);
1217         fid_cpu_to_le(&des->lp_dir_parent, &src->lp_dir_parent);
1218         des->lp_dir_cookie = cpu_to_le64(src->lp_dir_cookie);
1219 }
1220
1221 static inline umode_t lfsck_object_type(const struct dt_object *obj)
1222 {
1223         return lu_object_attr(&obj->do_lu);
1224 }
1225
1226 static inline int lfsck_is_dead_obj(const struct dt_object *obj)
1227 {
1228         return lu_object_is_dying(obj->do_lu.lo_header);
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(const struct lu_env *env, struct dt_device *dev,
1266                          const struct lu_fid *fid)
1267 {
1268         return lu2dt(lu_object_find_slice(env, dt2lu_dev(dev), fid, NULL));
1269 }
1270
1271 static inline struct dt_device *
1272 lfsck_find_dev_by_fid(const struct lu_env *env, struct lfsck_instance *lfsck,
1273                       const struct lu_fid *fid)
1274 {
1275         struct dt_device *dev;
1276         int               idx;
1277
1278         if (!lfsck->li_master)
1279                 return lfsck->li_bottom;
1280
1281         idx = lfsck_find_mdt_idx_by_fid(env, lfsck, fid);
1282         if (idx < 0)
1283                 return ERR_PTR(idx);
1284
1285         if (idx == lfsck_dev_idx(lfsck)) {
1286                 dev = lfsck->li_bottom;
1287         } else {
1288                 struct lfsck_tgt_desc *ltd;
1289
1290                 ltd = lfsck_ltd2tgt(&lfsck->li_mdt_descs, idx);
1291                 if (unlikely(ltd == NULL))
1292                         return ERR_PTR(-ENODEV);
1293
1294                 dev = ltd->ltd_tgt;
1295         }
1296
1297         return dev;
1298 }
1299
1300 static inline struct dt_object *
1301 lfsck_object_find_bottom(const struct lu_env *env, struct lfsck_instance *lfsck,
1302                          const struct lu_fid *fid)
1303 {
1304         struct dt_device *dev;
1305
1306         dev = lfsck_find_dev_by_fid(env, lfsck, fid);
1307         if (IS_ERR(dev))
1308                 return (struct dt_object *)dev;
1309
1310         return lfsck_object_find_by_dev(env, dev, fid);
1311 }
1312
1313 static inline struct dt_object *
1314 lfsck_object_find_bottom_new(const struct lu_env *env,
1315                              struct lfsck_instance *lfsck,
1316                              const struct lu_fid *fid)
1317 {
1318         struct dt_device *dev;
1319
1320         dev = lfsck_find_dev_by_fid(env, lfsck, fid);
1321         if (IS_ERR(dev))
1322                 return (struct dt_object *)dev;
1323
1324         return lfsck_object_find_by_dev_new(env, dev, fid);
1325 }
1326
1327 static inline struct dt_object *
1328 lfsck_object_locate(struct dt_device *dev, struct dt_object *obj)
1329 {
1330         if (lfsck_obj2dev(obj) == dev) {
1331                 return obj;
1332         } else {
1333                 struct lu_object *lo;
1334
1335                 lo = lu_object_locate(obj->do_lu.lo_header,
1336                                       dev->dd_lu_dev.ld_type);
1337                 if (unlikely(lo == NULL))
1338                         return ERR_PTR(-ENOENT);
1339
1340                 return lu2dt(lo);
1341         }
1342 }
1343
1344 static inline struct lfsck_tgt_desc *lfsck_tgt_get(struct lfsck_tgt_descs *ltds,
1345                                                    __u32 index)
1346 {
1347         struct lfsck_tgt_desc *ltd;
1348
1349         ltd = lfsck_ltd2tgt(ltds, index);
1350         if (ltd != NULL)
1351                 atomic_inc(&ltd->ltd_ref);
1352
1353         return ltd;
1354 }
1355
1356 static inline void lfsck_tgt_put(struct lfsck_tgt_desc *ltd)
1357 {
1358         if (atomic_dec_and_test(&ltd->ltd_ref))
1359                 OBD_FREE_PTR(ltd);
1360 }
1361
1362 static inline struct lfsck_component *
1363 lfsck_component_get(struct lfsck_component *com)
1364 {
1365         atomic_inc(&com->lc_ref);
1366
1367         return com;
1368 }
1369
1370 static inline void lfsck_component_put(const struct lu_env *env,
1371                                        struct lfsck_component *com)
1372 {
1373         if (atomic_dec_and_test(&com->lc_ref)) {
1374                 struct lfsck_sub_trace_obj *lsto;
1375                 int                         i;
1376
1377                 for (i = 0, lsto = &com->lc_sub_trace_objs[0];
1378                      i < LFSCK_STF_COUNT; i++, lsto++) {
1379                         if (lsto->lsto_obj != NULL)
1380                                 lfsck_object_put(env, lsto->lsto_obj);
1381                 }
1382
1383                 if (com->lc_obj != NULL)
1384                         lfsck_object_put(env, com->lc_obj);
1385                 if (com->lc_file_ram != NULL)
1386                         OBD_FREE(com->lc_file_ram, com->lc_file_size);
1387                 if (com->lc_file_disk != NULL)
1388                         OBD_FREE(com->lc_file_disk, com->lc_file_size);
1389                 if (com->lc_data != NULL) {
1390                         LASSERT(com->lc_ops->lfsck_data_release != NULL);
1391
1392                         com->lc_ops->lfsck_data_release(env, com);
1393                 }
1394
1395                 OBD_FREE_PTR(com);
1396         }
1397 }
1398
1399 static inline struct lfsck_instance *
1400 lfsck_instance_get(struct lfsck_instance *lfsck)
1401 {
1402         atomic_inc(&lfsck->li_ref);
1403
1404         return lfsck;
1405 }
1406
1407 static inline void lfsck_instance_put(const struct lu_env *env,
1408                                       struct lfsck_instance *lfsck)
1409 {
1410         if (atomic_dec_and_test(&lfsck->li_ref))
1411                 lfsck_instance_cleanup(env, lfsck);
1412 }
1413
1414 static inline bool lfsck_phase2_next_ready(struct lfsck_assistant_data *lad)
1415 {
1416         return list_empty(&lad->lad_mdt_phase1_list) &&
1417                (!list_empty(&lad->lad_ost_phase2_list) ||
1418                 list_empty(&lad->lad_ost_phase1_list));
1419 }
1420
1421 static inline void lfsck_lad_set_bitmap(const struct lu_env *env,
1422                                         struct lfsck_component *com,
1423                                         __u32 index)
1424 {
1425         struct lfsck_assistant_data     *lad    = com->lc_data;
1426         struct cfs_bitmap               *bitmap = lad->lad_bitmap;
1427
1428         LASSERT(com->lc_lfsck->li_master);
1429         LASSERT(bitmap != NULL);
1430
1431         if (likely(bitmap->size > index)) {
1432                 cfs_bitmap_set(bitmap, index);
1433                 lad->lad_incomplete = 1;
1434         } else if (com->lc_type == LFSCK_TYPE_NAMESPACE) {
1435                 struct lfsck_namespace *ns = com->lc_file_ram;
1436
1437                 ns->ln_flags |= LF_INCOMPLETE;
1438         }
1439
1440         CDEBUG(D_LFSCK, "%s: %s LFSCK set bitmap (%p/%u) for idx %u\n",
1441                lfsck_lfsck2name(com->lc_lfsck), lad->lad_name, bitmap,
1442                bitmap->size, index);
1443 }
1444
1445 static inline int lfsck_links_read(const struct lu_env *env,
1446                                    struct dt_object *obj,
1447                                    struct linkea_data *ldata)
1448 {
1449         ldata->ld_buf =
1450                 lu_buf_check_and_alloc(&lfsck_env_info(env)->lti_linkea_buf,
1451                                        MAX_LINKEA_SIZE);
1452
1453         return __lfsck_links_read(env, obj, ldata, false);
1454 }
1455
1456 /* Read linkEA for the given object, the linkEA should contain
1457  * at least one entry, otherwise, -ENODATA will be returned. */
1458 static inline int lfsck_links_read_with_rec(const struct lu_env *env,
1459                                             struct dt_object *obj,
1460                                             struct linkea_data *ldata)
1461 {
1462         ldata->ld_buf =
1463                 lu_buf_check_and_alloc(&lfsck_env_info(env)->lti_linkea_buf,
1464                                        MAX_LINKEA_SIZE);
1465
1466         return __lfsck_links_read(env, obj, ldata, true);
1467 }
1468
1469 static inline int lfsck_links_read2_with_rec(const struct lu_env *env,
1470                                              struct dt_object *obj,
1471                                              struct linkea_data *ldata)
1472 {
1473         ldata->ld_buf =
1474                 lu_buf_check_and_alloc(&lfsck_env_info(env)->lti_linkea_buf2,
1475                                        MAX_LINKEA_SIZE);
1476
1477         return __lfsck_links_read(env, obj, ldata, true);
1478 }
1479
1480 static inline struct lfsck_lmv *lfsck_lmv_get(struct lfsck_lmv *llmv)
1481 {
1482         if (llmv != NULL)
1483                 atomic_inc(&llmv->ll_ref);
1484
1485         return llmv;
1486 }
1487
1488 static inline int lfsck_sub_trace_file_fid2idx(const struct lu_fid *fid)
1489 {
1490         return fid->f_oid & (LFSCK_STF_COUNT - 1);
1491 }
1492
1493 static inline void lfsck_lmv_header_le_to_cpu(struct lmv_mds_md_v1 *dst,
1494                                               const struct lmv_mds_md_v1 *src)
1495 {
1496         dst->lmv_magic = le32_to_cpu(src->lmv_magic);
1497         dst->lmv_stripe_count = le32_to_cpu(src->lmv_stripe_count);
1498         dst->lmv_master_mdt_index = le32_to_cpu(src->lmv_master_mdt_index);
1499         dst->lmv_hash_type = le32_to_cpu(src->lmv_hash_type);
1500         dst->lmv_layout_version = le32_to_cpu(src->lmv_layout_version);
1501 }
1502
1503 static inline void lfsck_lmv_header_cpu_to_le(struct lmv_mds_md_v1 *dst,
1504                                               const struct lmv_mds_md_v1 *src)
1505 {
1506         dst->lmv_magic = cpu_to_le32(src->lmv_magic);
1507         dst->lmv_stripe_count = cpu_to_le32(src->lmv_stripe_count);
1508         dst->lmv_master_mdt_index = cpu_to_le32(src->lmv_master_mdt_index);
1509         dst->lmv_hash_type = cpu_to_le32(src->lmv_hash_type);
1510         dst->lmv_layout_version = cpu_to_le32(src->lmv_layout_version);
1511 }
1512
1513 static inline struct lfsck_assistant_object *
1514 lfsck_assistant_object_get(struct lfsck_assistant_object *lso)
1515 {
1516         atomic_inc(&lso->lso_ref);
1517
1518         return lso;
1519 }
1520
1521 static inline void
1522 lfsck_assistant_object_put(const struct lu_env *env,
1523                            struct lfsck_assistant_object *lso)
1524 {
1525         if (atomic_dec_and_test(&lso->lso_ref))
1526                 OBD_FREE_PTR(lso);
1527 }
1528 #endif /* _LFSCK_INTERNAL_H */