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, 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
  49 #define HALF_SEC                        (HZ >> 1)
  50 #define LFSCK_CHECKPOINT_INTERVAL       60
  51
  52 #define LFSCK_NAMEENTRY_DEAD            1 /* The object has been unlinked. */
  53 #define LFSCK_NAMEENTRY_REMOVED         2 /* The entry has been removed. */
  54 #define LFSCK_NAMEENTRY_RECREATED       3 /* The entry has been recreated. */
  55
  56 enum lfsck_flags {
  57         /* Finish the first cycle scanning. */
  58         LF_SCANNED_ONCE         = 0x00000001ULL,
  59
  60         /* There is some namespace inconsistency. */
  61         LF_INCONSISTENT         = 0x00000002ULL,
  62
  63         /* The device is upgraded from 1.8 format. */
  64         LF_UPGRADE              = 0x00000004ULL,
  65
  66         /* The server ever restarted during the LFSCK, and may miss to process
  67          * some objects check/repair. */
  68         LF_INCOMPLETE           = 0x00000008ULL,
  69
  70         /* The LAST_ID (file) crashed. */
  71         LF_CRASHED_LASTID       = 0x00000010ULL,
  72 };
  73
  74 struct lfsck_position {
  75         /* low layer object table-based iteration position. */
  76         __u64   lp_oit_cookie;
  77
  78         /* parent FID for directory traversal. */
  79         struct lu_fid lp_dir_parent;
  80
  81         /* namespace-based directory traversal position. */
  82         __u64   lp_dir_cookie;
  83 };
  84
  85 struct lfsck_bookmark {
  86         /* Magic number to detect that this struct contains valid data. */
  87         __u32   lb_magic;
  88
  89         /* For compatible with old versions. */
  90         __u16   lb_version;
  91
  92         /* See 'enum lfsck_param_flags' */
  93         __u16   lb_param;
  94
  95         /* How many items can be scanned at most per second. */
  96         __u32   lb_speed_limit;
  97
  98         /* The windows size for async requests pipeline. */
  99         __u16   lb_async_windows;
 100
 101         /* For 64-bits aligned. */
 102         __u16   lb_padding;
 103
 104         /* For future using. */
 105         __u64   lb_reserved[6];
 106 };
 107
 108 struct lfsck_namespace {
 109         /* Magic number to detect that this struct contains valid data. */
 110         __u32   ln_magic;
 111
 112         /* See 'enum lfsck_status'. */
 113         __u32   ln_status;
 114
 115         /* See 'enum lfsck_flags'. */
 116         __u32   ln_flags;
 117
 118         /* How many completed LFSCK runs on the device. */
 119         __u32   ln_success_count;
 120
 121         /*  How long the LFSCK phase1 has run in seconds. */
 122         __u32   ln_run_time_phase1;
 123
 124         /*  How long the LFSCK phase2 has run in seconds. */
 125         __u32   ln_run_time_phase2;
 126
 127         /* Time for the last LFSCK completed in seconds since epoch. */
 128         __u64   ln_time_last_complete;
 129
 130         /* Time for the latest LFSCK ran in seconds since epoch. */
 131         __u64   ln_time_latest_start;
 132
 133         /* Time for the last LFSCK checkpoint in seconds since epoch. */
 134         __u64   ln_time_last_checkpoint;
 135
 136         /* Position for the latest LFSCK started from. */
 137         struct lfsck_position   ln_pos_latest_start;
 138
 139         /* Position for the last LFSCK checkpoint. */
 140         struct lfsck_position   ln_pos_last_checkpoint;
 141
 142         /* Position for the first should be updated object. */
 143         struct lfsck_position   ln_pos_first_inconsistent;
 144
 145         /* How many items (including dir) have been checked. */
 146         __u64   ln_items_checked;
 147
 148         /* How many items have been repaired. */
 149         __u64   ln_items_repaired;
 150
 151         /* How many items failed to be processed. */
 152         __u64   ln_items_failed;
 153
 154         /* How many directories have been traversed. */
 155         __u64   ln_dirs_checked;
 156
 157         /* How many multiple-linked objects have been checked. */
 158         __u64   ln_mlinked_checked;
 159
 160         /* How many objects have been double scanned. */
 161         __u64   ln_objs_checked_phase2;
 162
 163         /* How many objects have been reparied during double scan. */
 164         __u64   ln_objs_repaired_phase2;
 165
 166         /* How many objects failed to be processed during double scan. */
 167         __u64   ln_objs_failed_phase2;
 168
 169         /* How many objects with nlink fixed. */
 170         __u64   ln_objs_nlink_repaired;
 171
 172         /* How many objects were lost before, but found back now. */
 173         __u64   ln_objs_lost_found;
 174
 175         /* The latest object has been processed (failed) during double scan. */
 176         struct lu_fid   ln_fid_latest_scanned_phase2;
 177
 178         /* For further using. 256-bytes aligned now. */
 179         __u64   ln_reserved[2];
 180 };
 181
 182 enum lfsck_layout_inconsistency_type {
 183         LLIT_NONE                       = 0,
 184         LLIT_DANGLING                   = 1,
 185         LLIT_UNMATCHED_PAIR             = 2,
 186         LLIT_MULTIPLE_REFERENCED        = 3,
 187         LLIT_ORPHAN                     = 4,
 188         LLIT_INCONSISTENT_OWNER         = 5,
 189         LLIT_OTHERS                     = 6,
 190         LLIT_MAX                        = LLIT_OTHERS
 191 };
 192
 193 struct lfsck_layout {
 194         /* Magic number to detect that this struct contains valid data. */
 195         __u32   ll_magic;
 196
 197         /* See 'enum lfsck_status'. */
 198         __u32   ll_status;
 199
 200         /* See 'enum lfsck_flags'. */
 201         __u32   ll_flags;
 202
 203         /* How many completed LFSCK runs on the device. */
 204         __u32   ll_success_count;
 205
 206         /*  How long the LFSCK phase1 has run in seconds. */
 207         __u32   ll_run_time_phase1;
 208
 209         /*  How long the LFSCK phase2 has run in seconds. */
 210         __u32   ll_run_time_phase2;
 211
 212         /* Time for the last LFSCK completed in seconds since epoch. */
 213         __u64   ll_time_last_complete;
 214
 215         /* Time for the latest LFSCK ran in seconds since epoch. */
 216         __u64   ll_time_latest_start;
 217
 218         /* Time for the last LFSCK checkpoint in seconds since epoch. */
 219         __u64   ll_time_last_checkpoint;
 220
 221         /* Position for the latest LFSCK started from. */
 222         __u64   ll_pos_latest_start;
 223
 224         /* Position for the last LFSCK checkpoint. */
 225         __u64   ll_pos_last_checkpoint;
 226
 227         /* Position for the first should be updated object. */
 228         __u64   ll_pos_first_inconsistent;
 229
 230         /* How many objects have been checked. */
 231         __u64   ll_objs_checked_phase1;
 232
 233         /* How many objects failed to be processed. */
 234         __u64   ll_objs_failed_phase1;
 235
 236         /* How many objects have been double scanned. */
 237         __u64   ll_objs_checked_phase2;
 238
 239         /* How many objects failed to be processed during double scan. */
 240         __u64   ll_objs_failed_phase2;
 241
 242         /* kinds of inconsistency have been repaired.
 243          * ll_objs_repaired[type - 1] is the count for the given @type. */
 244         __u64   ll_objs_repaired[LLIT_MAX];
 245
 246         /* How many objects have been skipped because of related
 247          * MDT(s)/OST(s) do not participate in the LFSCK */
 248         __u64   ll_objs_skipped;
 249
 250         /* For further using. 256-bytes aligned now. */
 251         __u64   ll_reserved[12];
 252 };
 253
 254 struct lfsck_component;
 255 struct lfsck_tgt_descs;
 256 struct lfsck_tgt_desc;
 257
 258 struct lfsck_operations {
 259         int (*lfsck_reset)(const struct lu_env *env,
 260                            struct lfsck_component *com,
 261                            bool init);
 262
 263         void (*lfsck_fail)(const struct lu_env *env,
 264                            struct lfsck_component *com,
 265                            bool new_checked);
 266
 267         int (*lfsck_checkpoint)(const struct lu_env *env,
 268                                 struct lfsck_component *com,
 269                                 bool init);
 270
 271         int (*lfsck_prep)(const struct lu_env *env,
 272                           struct lfsck_component *com,
 273                           struct lfsck_start_param *lsp);
 274
 275         int (*lfsck_exec_oit)(const struct lu_env *env,
 276                               struct lfsck_component *com,
 277                               struct dt_object *obj);
 278
 279         int (*lfsck_exec_dir)(const struct lu_env *env,
 280                               struct lfsck_component *com,
 281                               struct dt_object *obj,
 282                               struct lu_dirent *ent);
 283
 284         int (*lfsck_post)(const struct lu_env *env,
 285                           struct lfsck_component *com,
 286                           int result,
 287                           bool init);
 288
 289         int (*lfsck_dump)(const struct lu_env *env,
 290                           struct lfsck_component *com,
 291                           char *buf,
 292                           int len);
 293
 294         int (*lfsck_double_scan)(const struct lu_env *env,
 295                                  struct lfsck_component *com);
 296
 297         void (*lfsck_data_release)(const struct lu_env *env,
 298                                    struct lfsck_component *com);
 299
 300         void (*lfsck_quit)(const struct lu_env *env,
 301                            struct lfsck_component *com);
 302
 303         int (*lfsck_in_notify)(const struct lu_env *env,
 304                                struct lfsck_component *com,
 305                                struct lfsck_request *lr);
 306
 307         int (*lfsck_query)(const struct lu_env *env,
 308                            struct lfsck_component *com);
 309
 310         int (*lfsck_stop_notify)(const struct lu_env *env,
 311                                  struct lfsck_component *com,
 312                                  struct lfsck_tgt_descs *ltds,
 313                                  struct lfsck_tgt_desc *ltd,
 314                                  struct ptlrpc_request_set *set);
 315
 316         int (*lfsck_join)(const struct lu_env *env,
 317                           struct lfsck_component *com,
 318                           struct lfsck_start_param *lsp);
 319 };
 320
 321 #define TGT_PTRS                256     /* number of pointers at 1st level */
 322 #define TGT_PTRS_PER_BLOCK      256     /* number of pointers at 2nd level */
 323
 324 struct lfsck_tgt_desc {
 325         struct list_head   ltd_orphan_list;
 326         struct dt_device  *ltd_tgt;
 327         struct dt_device  *ltd_key;
 328         struct obd_export *ltd_exp;
 329         struct list_head   ltd_layout_list;
 330         struct list_head   ltd_layout_phase_list;
 331         atomic_t           ltd_ref;
 332         __u32              ltd_index;
 333         __u32              ltd_layout_gen;
 334         unsigned int       ltd_dead:1,
 335                            ltd_layout_done:1;
 336 };
 337
 338 struct lfsck_tgt_desc_idx {
 339         struct lfsck_tgt_desc *ldi_tgts[TGT_PTRS_PER_BLOCK];
 340 };
 341
 342 struct lfsck_tgt_descs {
 343         /* list of known TGTs */
 344         struct lfsck_tgt_desc_idx       *ltd_tgts_idx[TGT_PTRS];
 345
 346         /* bitmap of TGTs available */
 347         cfs_bitmap_t                    *ltd_tgts_bitmap;
 348
 349         /* for lfsck_tgt_desc::ltd_xxx_list */
 350         spinlock_t                       ltd_lock;
 351
 352         /* for tgts table accessing and changes */
 353         struct rw_semaphore              ltd_rw_sem;
 354
 355         /* Temporary list for orphan targets. */
 356         struct list_head                 ltd_orphan;
 357
 358         /* number of registered TGTs */
 359         int                              ltd_tgtnr;
 360 };
 361
 362 #define LTD_TGT(ltd, index)     \
 363         ((ltd)->ltd_tgts_idx[(index) / TGT_PTRS_PER_BLOCK]->\
 364          ldi_tgts[(index) % TGT_PTRS_PER_BLOCK])
 365
 366 #define OST_TGT(lfsck, index)   LTD_TGT(&lfsck->li_ost_descs, index)
 367 #define MDT_TGT(lfsck, index)   LTD_TGT(&lfsck->li_mdt_descs, index)
 368
 369 struct lfsck_component {
 370         /* into lfsck_instance::li_list_(scan,double_scan,idle} */
 371         cfs_list_t               lc_link;
 372
 373         /* into lfsck_instance::li_list_dir */
 374         cfs_list_t               lc_link_dir;
 375
 376         struct rw_semaphore      lc_sem;
 377         atomic_t                 lc_ref;
 378
 379         struct lfsck_position    lc_pos_start;
 380         struct lfsck_instance   *lc_lfsck;
 381         struct dt_object        *lc_obj;
 382         struct lfsck_operations *lc_ops;
 383         void                    *lc_file_ram;
 384         void                    *lc_file_disk;
 385         void                    *lc_data;
 386
 387         /* The time for last checkpoint, jiffies */
 388         cfs_time_t               lc_time_last_checkpoint;
 389
 390         /* The time for next checkpoint, jiffies */
 391         cfs_time_t               lc_time_next_checkpoint;
 392
 393         __u32                    lc_file_size;
 394
 395         /* How many objects have been checked since last checkpoint. */
 396         __u32                    lc_new_checked;
 397
 398         /* How many objects have been scanned since last sleep. */
 399         __u32                    lc_new_scanned;
 400
 401         unsigned int             lc_journal:1;
 402         __u16                    lc_type;
 403 };
 404
 405 struct lfsck_instance {
 406         struct mutex              li_mutex;
 407         spinlock_t                li_lock;
 408
 409         /* Link into the lfsck_instance_list. */
 410         cfs_list_t                li_link;
 411
 412         /* For the components in (first) scanning via otable-based iteration. */
 413         cfs_list_t                li_list_scan;
 414
 415         /* For the components in scanning via directory traversal. Because
 416          * directory traversal cannot guarantee all the object be scanned,
 417          * so the component in the li_list_dir must be in li_list_scan. */
 418         cfs_list_t                li_list_dir;
 419
 420         /* For the components in double scanning. */
 421         cfs_list_t                li_list_double_scan;
 422
 423         /* For the components those are not scanning now. */
 424         cfs_list_t                li_list_idle;
 425
 426         atomic_t                  li_ref;
 427         atomic_t                  li_double_scan_count;
 428         struct ptlrpc_thread      li_thread;
 429
 430         /* The time for last checkpoint, jiffies */
 431         cfs_time_t                li_time_last_checkpoint;
 432
 433         /* The time for next checkpoint, jiffies */
 434         cfs_time_t                li_time_next_checkpoint;
 435
 436         lfsck_out_notify          li_out_notify;
 437         void                     *li_out_notify_data;
 438         struct dt_device         *li_next;
 439         struct dt_device         *li_bottom;
 440         struct obd_device        *li_obd;
 441         struct ldlm_namespace    *li_namespace;
 442         struct local_oid_storage *li_los;
 443         struct lu_fid             li_local_root_fid;  /* backend root "/" */
 444         struct lu_fid             li_global_root_fid; /* /ROOT */
 445         struct dt_object         *li_bookmark_obj;
 446         struct lfsck_bookmark     li_bookmark_ram;
 447         struct lfsck_bookmark     li_bookmark_disk;
 448         struct lfsck_position     li_pos_current;
 449
 450         /* Obj for otable-based iteration */
 451         struct dt_object         *li_obj_oit;
 452
 453         /* Obj for directory traversal */
 454         struct dt_object         *li_obj_dir;
 455
 456         /* It for otable-based iteration */
 457         struct dt_it             *li_di_oit;
 458
 459         /* It for directory traversal */
 460         struct dt_it             *li_di_dir;
 461
 462         /* Description of OST */
 463         struct lfsck_tgt_descs    li_ost_descs;
 464
 465         /* Description of MDT */
 466         struct lfsck_tgt_descs    li_mdt_descs;
 467
 468         /* namespace-based directory traversal position. */
 469         __u64                     li_cookie_dir;
 470
 471         /* Arguments for low layer otable-based iteration. */
 472         __u32                     li_args_oit;
 473
 474         /* Arugments for namespace-based directory traversal. */
 475         __u32                     li_args_dir;
 476
 477         /* Schedule for every N objects. */
 478         __u32                     li_sleep_rate;
 479
 480         /* Sleep N jiffies for each schedule. */
 481         __u32                     li_sleep_jif;
 482
 483         /* How many objects have been scanned since last sleep. */
 484         __u32                     li_new_scanned;
 485
 486         /* The status when the LFSCK stopped or paused. */
 487         __u32                     li_status;
 488
 489         /* The flags when the lFSCK stopped or paused. */
 490         __u32                     li_flags;
 491
 492         unsigned int              li_oit_over:1, /* oit is finished. */
 493                                   li_drop_dryrun:1, /* Ever dryrun, not now. */
 494                                   li_master:1, /* Master instance or not. */
 495                                   li_current_oit_processed:1;
 496 };
 497
 498 enum lfsck_linkea_flags {
 499         /* The linkea entries does not match the object nlinks. */
 500         LLF_UNMATCH_NLINKS      = 0x01,
 501
 502         /* Fail to repair the multiple-linked objects during the double scan. */
 503         LLF_REPAIR_FAILED       = 0x02,
 504 };
 505
 506 struct lfsck_async_interpret_args {
 507         struct lfsck_component          *laia_com;
 508         struct lfsck_tgt_descs          *laia_ltds;
 509         struct lfsck_tgt_desc           *laia_ltd;
 510         struct lfsck_request            *laia_lr;
 511 };
 512
 513 struct lfsck_thread_args {
 514         struct lu_env                    lta_env;
 515         struct lfsck_instance           *lta_lfsck;
 516         struct lfsck_component          *lta_com;
 517         struct lfsck_start_param        *lta_lsp;
 518 };
 519
 520 struct lfsck_thread_info {
 521         struct lu_name          lti_name;
 522         struct lu_buf           lti_buf;
 523         struct lu_buf           lti_linkea_buf;
 524         struct lu_buf           lti_big_buf;
 525         struct lu_fid           lti_fid;
 526         struct lu_fid           lti_fid2;
 527         struct lu_attr          lti_la;
 528         struct lu_attr          lti_la2;
 529         struct ost_id           lti_oi;
 530         union {
 531                 struct lustre_mdt_attrs lti_lma;
 532                 /* old LMA for compatibility */
 533                 char                    lti_lma_old[LMA_OLD_SIZE];
 534         };
 535         struct dt_object_format lti_dof;
 536         /* lti_ent and lti_key must be conjoint,
 537          * then lti_ent::lde_name will be lti_key. */
 538         struct lu_dirent        lti_ent;
 539         char                    lti_key[NAME_MAX + 16];
 540         struct lfsck_request    lti_lr;
 541         struct lfsck_async_interpret_args lti_laia;
 542         struct lfsck_stop       lti_stop;
 543         ldlm_policy_data_t      lti_policy;
 544         struct ldlm_res_id      lti_resid;
 545         union {
 546                 struct filter_fid_old   lti_old_pfid;
 547                 struct filter_fid       lti_new_pfid;
 548         };
 549         struct dt_allocation_hint lti_hint;
 550 };
 551
 552 /* lfsck_lib.c */
 553 const char *lfsck_status2names(enum lfsck_status status);
 554 void lfsck_component_cleanup(const struct lu_env *env,
 555                              struct lfsck_component *com);
 556 void lfsck_instance_cleanup(const struct lu_env *env,
 557                             struct lfsck_instance *lfsck);
 558 int lfsck_bits_dump(char **buf, int *len, int bits, const char *names[],
 559                     const char *prefix);
 560 int lfsck_time_dump(char **buf, int *len, __u64 time, const char *prefix);
 561 int lfsck_pos_dump(char **buf, int *len, struct lfsck_position *pos,
 562                    const char *prefix);
 563 void lfsck_pos_fill(const struct lu_env *env, struct lfsck_instance *lfsck,
 564                     struct lfsck_position *pos, bool init);
 565 void lfsck_control_speed(struct lfsck_instance *lfsck);
 566 void lfsck_control_speed_by_self(struct lfsck_component *com);
 567 int lfsck_reset(const struct lu_env *env, struct lfsck_instance *lfsck,
 568                 bool init);
 569 struct lfsck_thread_args *lfsck_thread_args_init(struct lfsck_instance *lfsck,
 570                                                  struct lfsck_component *com,
 571                                                  struct lfsck_start_param *lsp);
 572 void lfsck_thread_args_fini(struct lfsck_thread_args *lta);
 573 void lfsck_fail(const struct lu_env *env, struct lfsck_instance *lfsck,
 574                 bool new_checked);
 575 int lfsck_checkpoint(const struct lu_env *env, struct lfsck_instance *lfsck);
 576 int lfsck_prep(const struct lu_env *env, struct lfsck_instance *lfsck,
 577                struct lfsck_start_param *lsp);
 578 int lfsck_exec_oit(const struct lu_env *env, struct lfsck_instance *lfsck,
 579                    struct dt_object *obj);
 580 int lfsck_exec_dir(const struct lu_env *env, struct lfsck_instance *lfsck,
 581                    struct dt_object *obj, struct lu_dirent *ent);
 582 int lfsck_post(const struct lu_env *env, struct lfsck_instance *lfsck,
 583                int result);
 584 int lfsck_double_scan(const struct lu_env *env, struct lfsck_instance *lfsck);
 585 void lfsck_quit(const struct lu_env *env, struct lfsck_instance *lfsck);
 586 int lfsck_async_request(const struct lu_env *env, struct obd_export *exp,
 587                         struct lfsck_request *lr,
 588                         struct ptlrpc_request_set *set,
 589                         ptlrpc_interpterer_t interpterer,
 590                         void *args, int request);
 591
 592 /* lfsck_engine.c */
 593 int lfsck_master_engine(void *args);
 594
 595 /* lfsck_bookmark.c */
 596 int lfsck_bookmark_store(const struct lu_env *env,
 597                          struct lfsck_instance *lfsck);
 598 int lfsck_bookmark_setup(const struct lu_env *env,
 599                          struct lfsck_instance *lfsck);
 600
 601 /* lfsck_namespace.c */
 602 int lfsck_namespace_setup(const struct lu_env *env,
 603                           struct lfsck_instance *lfsck);
 604
 605 /* lfsck_layout.c */
 606 int lfsck_layout_setup(const struct lu_env *env, struct lfsck_instance *lfsck);
 607
 608 extern const char *lfsck_flags_names[];
 609 extern const char *lfsck_param_names[];
 610 extern struct lu_context_key lfsck_thread_key;
 611
 612 static inline struct dt_device *lfsck_obj2dt_dev(struct dt_object *obj)
 613 {
 614         return container_of0(obj->do_lu.lo_dev, struct dt_device, dd_lu_dev);
 615 }
 616
 617 static inline struct lfsck_thread_info *
 618 lfsck_env_info(const struct lu_env *env)
 619 {
 620         struct lfsck_thread_info *info;
 621
 622         info = lu_context_key_get(&env->le_ctx, &lfsck_thread_key);
 623         LASSERT(info != NULL);
 624         return info;
 625 }
 626
 627 static inline const struct lu_name *
 628 lfsck_name_get_const(const struct lu_env *env, const void *area, ssize_t len)
 629 {
 630         struct lu_name *lname;
 631
 632         lname = &lfsck_env_info(env)->lti_name;
 633         lname->ln_name = area;
 634         lname->ln_namelen = len;
 635         return lname;
 636 }
 637
 638 static inline struct lu_buf *
 639 lfsck_buf_get(const struct lu_env *env, void *area, ssize_t len)
 640 {
 641         struct lu_buf *buf;
 642
 643         buf = &lfsck_env_info(env)->lti_buf;
 644         buf->lb_buf = area;
 645         buf->lb_len = len;
 646         return buf;
 647 }
 648
 649 static inline const struct lu_buf *
 650 lfsck_buf_get_const(const struct lu_env *env, const void *area, ssize_t len)
 651 {
 652         struct lu_buf *buf;
 653
 654         buf = &lfsck_env_info(env)->lti_buf;
 655         buf->lb_buf = (void *)area;
 656         buf->lb_len = len;
 657         return buf;
 658 }
 659
 660 static inline char *lfsck_lfsck2name(struct lfsck_instance *lfsck)
 661 {
 662         return lfsck->li_bottom->dd_lu_dev.ld_obd->obd_name;
 663 }
 664
 665 static inline const struct lu_fid *lfsck_dto2fid(const struct dt_object *obj)
 666 {
 667         return lu_object_fid(&obj->do_lu);
 668 }
 669
 670 static inline void lfsck_pos_set_zero(struct lfsck_position *pos)
 671 {
 672         memset(pos, 0, sizeof(*pos));
 673 }
 674
 675 static inline int lfsck_pos_is_zero(const struct lfsck_position *pos)
 676 {
 677         return pos->lp_oit_cookie == 0 && fid_is_zero(&pos->lp_dir_parent);
 678 }
 679
 680 static inline int lfsck_pos_is_eq(const struct lfsck_position *pos1,
 681                                   const struct lfsck_position *pos2)
 682 {
 683         if (pos1->lp_oit_cookie < pos2->lp_oit_cookie)
 684                 return -1;
 685
 686         if (pos1->lp_oit_cookie > pos2->lp_oit_cookie)
 687                 return 1;
 688
 689         if (fid_is_zero(&pos1->lp_dir_parent) &&
 690             !fid_is_zero(&pos2->lp_dir_parent))
 691                 return -1;
 692
 693         if (!fid_is_zero(&pos1->lp_dir_parent) &&
 694             fid_is_zero(&pos2->lp_dir_parent))
 695                 return 1;
 696
 697         if (fid_is_zero(&pos1->lp_dir_parent) &&
 698             fid_is_zero(&pos2->lp_dir_parent))
 699                 return 0;
 700
 701         LASSERT(lu_fid_eq(&pos1->lp_dir_parent, &pos2->lp_dir_parent));
 702
 703         if (pos1->lp_dir_cookie < pos2->lp_dir_cookie)
 704                 return -1;
 705
 706         if (pos1->lp_dir_cookie > pos2->lp_dir_cookie)
 707                 return 1;
 708
 709         return 0;
 710 }
 711
 712 static void inline lfsck_position_le_to_cpu(struct lfsck_position *des,
 713                                             struct lfsck_position *src)
 714 {
 715         des->lp_oit_cookie = le64_to_cpu(src->lp_oit_cookie);
 716         fid_le_to_cpu(&des->lp_dir_parent, &src->lp_dir_parent);
 717         des->lp_dir_cookie = le64_to_cpu(src->lp_dir_cookie);
 718 }
 719
 720 static void inline lfsck_position_cpu_to_le(struct lfsck_position *des,
 721                                             struct lfsck_position *src)
 722 {
 723         des->lp_oit_cookie = cpu_to_le64(src->lp_oit_cookie);
 724         fid_cpu_to_le(&des->lp_dir_parent, &src->lp_dir_parent);
 725         des->lp_dir_cookie = cpu_to_le64(src->lp_dir_cookie);
 726 }
 727
 728 static inline umode_t lfsck_object_type(const struct dt_object *obj)
 729 {
 730         return lu_object_attr(&obj->do_lu);
 731 }
 732
 733 static inline int lfsck_is_dead_obj(const struct dt_object *obj)
 734 {
 735         struct lu_object_header *loh = obj->do_lu.lo_header;
 736
 737         return !!test_bit(LU_OBJECT_HEARD_BANSHEE, &loh->loh_flags);
 738 }
 739
 740 static inline struct dt_object *lfsck_object_find(const struct lu_env *env,
 741                                                   struct lfsck_instance *lfsck,
 742                                                   const struct lu_fid *fid)
 743 {
 744         return lu2dt(lu_object_find_slice(env, dt2lu_dev(lfsck->li_next),
 745                      fid, NULL));
 746 }
 747
 748 static inline struct dt_object *lfsck_object_get(struct dt_object *obj)
 749 {
 750         lu_object_get(&obj->do_lu);
 751         return obj;
 752 }
 753
 754 static inline void lfsck_object_put(const struct lu_env *env,
 755                                     struct dt_object *obj)
 756 {
 757         lu_object_put(env, &obj->do_lu);
 758 }
 759
 760 static inline struct dt_object *
 761 lfsck_object_find_by_dev(const struct lu_env *env, struct dt_device *dev,
 762                          const struct lu_fid *fid)
 763 {
 764         struct dt_object *obj;
 765
 766         obj = lu2dt(lu_object_find_slice(env, dt2lu_dev(dev), fid, NULL));
 767         if (unlikely(obj == NULL))
 768                 return ERR_PTR(-ENOENT);
 769
 770         return obj;
 771 }
 772
 773 static inline struct lfsck_tgt_desc *lfsck_tgt_get(struct lfsck_tgt_descs *ltds,
 774                                                    __u32 index)
 775 {
 776         struct lfsck_tgt_desc *ltd;
 777
 778         ltd = LTD_TGT(ltds, index);
 779         if (ltd != NULL)
 780                 atomic_inc(&ltd->ltd_ref);
 781
 782         return ltd;
 783 }
 784
 785 static inline void lfsck_tgt_put(struct lfsck_tgt_desc *ltd)
 786 {
 787         if (atomic_dec_and_test(&ltd->ltd_ref))
 788                 OBD_FREE_PTR(ltd);
 789 }
 790
 791 static inline struct lfsck_component *
 792 lfsck_component_get(struct lfsck_component *com)
 793 {
 794         atomic_inc(&com->lc_ref);
 795
 796         return com;
 797 }
 798
 799 static inline void lfsck_component_put(const struct lu_env *env,
 800                                        struct lfsck_component *com)
 801 {
 802         if (atomic_dec_and_test(&com->lc_ref)) {
 803                 if (com->lc_obj != NULL)
 804                         lu_object_put_nocache(env, &com->lc_obj->do_lu);
 805                 if (com->lc_file_ram != NULL)
 806                         OBD_FREE(com->lc_file_ram, com->lc_file_size);
 807                 if (com->lc_file_disk != NULL)
 808                         OBD_FREE(com->lc_file_disk, com->lc_file_size);
 809                 if (com->lc_data != NULL) {
 810                         LASSERT(com->lc_ops->lfsck_data_release != NULL);
 811
 812                         com->lc_ops->lfsck_data_release(env, com);
 813                 }
 814
 815                 OBD_FREE_PTR(com);
 816         }
 817 }
 818
 819 static inline struct lfsck_instance *
 820 lfsck_instance_get(struct lfsck_instance *lfsck)
 821 {
 822         atomic_inc(&lfsck->li_ref);
 823
 824         return lfsck;
 825 }
 826
 827 static inline void lfsck_instance_put(const struct lu_env *env,
 828                                       struct lfsck_instance *lfsck)
 829 {
 830         if (atomic_dec_and_test(&lfsck->li_ref))
 831                 lfsck_instance_cleanup(env, lfsck);
 832 }
 833
 834 static inline mdsno_t lfsck_dev_idx(struct dt_device *dev)
 835 {
 836         return dev->dd_lu_dev.ld_site->ld_seq_site->ss_node_id;
 837 }
 838
 839 #endif /* _LFSCK_INTERNAL_H */