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_interpret)(const struct lu_env *env,
 290                                struct ptlrpc_request *req,
 291                                void *args,
 292                                int rc);
 293
 294         int (*lfsck_dump)(const struct lu_env *env,
 295                           struct lfsck_component *com,
 296                           char *buf,
 297                           int len);
 298
 299         int (*lfsck_double_scan)(const struct lu_env *env,
 300                                  struct lfsck_component *com);
 301
 302         void (*lfsck_data_release)(const struct lu_env *env,
 303                                    struct lfsck_component *com);
 304
 305         void (*lfsck_quit)(const struct lu_env *env,
 306                            struct lfsck_component *com);
 307
 308         int (*lfsck_in_notify)(const struct lu_env *env,
 309                                struct lfsck_component *com,
 310                                struct lfsck_request *lr);
 311
 312         int (*lfsck_query)(const struct lu_env *env,
 313                            struct lfsck_component *com);
 314
 315         int (*lfsck_stop_notify)(const struct lu_env *env,
 316                                  struct lfsck_component *com,
 317                                  struct lfsck_tgt_descs *ltds,
 318                                  struct lfsck_tgt_desc *ltd,
 319                                  struct ptlrpc_request_set *set);
 320
 321         int (*lfsck_join)(const struct lu_env *env,
 322                           struct lfsck_component *com,
 323                           struct lfsck_start_param *lsp);
 324 };
 325
 326 #define TGT_PTRS                256     /* number of pointers at 1st level */
 327 #define TGT_PTRS_PER_BLOCK      256     /* number of pointers at 2nd level */
 328
 329 struct lfsck_tgt_desc {
 330         struct list_head   ltd_orphan_list;
 331         struct dt_device  *ltd_tgt;
 332         struct dt_device  *ltd_key;
 333         struct obd_export *ltd_exp;
 334         struct list_head   ltd_layout_list;
 335         struct list_head   ltd_layout_phase_list;
 336         atomic_t           ltd_ref;
 337         __u32              ltd_index;
 338         __u32              ltd_layout_gen;
 339         unsigned int       ltd_dead:1,
 340                            ltd_layout_done:1;
 341 };
 342
 343 struct lfsck_tgt_desc_idx {
 344         struct lfsck_tgt_desc *ldi_tgts[TGT_PTRS_PER_BLOCK];
 345 };
 346
 347 struct lfsck_tgt_descs {
 348         /* list of known TGTs */
 349         struct lfsck_tgt_desc_idx       *ltd_tgts_idx[TGT_PTRS];
 350
 351         /* bitmap of TGTs available */
 352         cfs_bitmap_t                    *ltd_tgts_bitmap;
 353
 354         /* for lfsck_tgt_desc::ltd_xxx_list */
 355         spinlock_t                       ltd_lock;
 356
 357         /* for tgts table accessing and changes */
 358         struct rw_semaphore              ltd_rw_sem;
 359
 360         /* Temporary list for orphan targets. */
 361         struct list_head                 ltd_orphan;
 362
 363         /* number of registered TGTs */
 364         int                              ltd_tgtnr;
 365 };
 366
 367 #define LTD_TGT(ltd, index)     \
 368         ((ltd)->ltd_tgts_idx[(index) / TGT_PTRS_PER_BLOCK]->\
 369          ldi_tgts[(index) % TGT_PTRS_PER_BLOCK])
 370
 371 #define OST_TGT(lfsck, index)   LTD_TGT(&lfsck->li_ost_descs, index)
 372 #define MDT_TGT(lfsck, index)   LTD_TGT(&lfsck->li_mdt_descs, index)
 373
 374 struct lfsck_component {
 375         /* into lfsck_instance::li_list_(scan,double_scan,idle} */
 376         cfs_list_t               lc_link;
 377
 378         /* into lfsck_instance::li_list_dir */
 379         cfs_list_t               lc_link_dir;
 380
 381         struct rw_semaphore      lc_sem;
 382         atomic_t                 lc_ref;
 383
 384         struct lfsck_position    lc_pos_start;
 385         struct lfsck_instance   *lc_lfsck;
 386         struct dt_object        *lc_obj;
 387         struct lfsck_operations *lc_ops;
 388         void                    *lc_file_ram;
 389         void                    *lc_file_disk;
 390         void                    *lc_data;
 391
 392         /* The time for last checkpoint, jiffies */
 393         cfs_time_t               lc_time_last_checkpoint;
 394
 395         /* The time for next checkpoint, jiffies */
 396         cfs_time_t               lc_time_next_checkpoint;
 397
 398         __u32                    lc_file_size;
 399
 400         /* How many objects have been checked since last checkpoint. */
 401         __u32                    lc_new_checked;
 402
 403         /* How many objects have been scanned since last sleep. */
 404         __u32                    lc_new_scanned;
 405
 406         unsigned int             lc_journal:1;
 407         __u16                    lc_type;
 408 };
 409
 410 struct lfsck_instance {
 411         struct mutex              li_mutex;
 412         spinlock_t                li_lock;
 413
 414         /* Link into the lfsck_instance_list. */
 415         cfs_list_t                li_link;
 416
 417         /* For the components in (first) scanning via otable-based iteration. */
 418         cfs_list_t                li_list_scan;
 419
 420         /* For the components in scanning via directory traversal. Because
 421          * directory traversal cannot guarantee all the object be scanned,
 422          * so the component in the li_list_dir must be in li_list_scan. */
 423         cfs_list_t                li_list_dir;
 424
 425         /* For the components in double scanning. */
 426         cfs_list_t                li_list_double_scan;
 427
 428         /* For the components those are not scanning now. */
 429         cfs_list_t                li_list_idle;
 430
 431         atomic_t                  li_ref;
 432         atomic_t                  li_double_scan_count;
 433         struct ptlrpc_thread      li_thread;
 434
 435         /* The time for last checkpoint, jiffies */
 436         cfs_time_t                li_time_last_checkpoint;
 437
 438         /* The time for next checkpoint, jiffies */
 439         cfs_time_t                li_time_next_checkpoint;
 440
 441         lfsck_out_notify          li_out_notify;
 442         void                     *li_out_notify_data;
 443         struct dt_device         *li_next;
 444         struct dt_device         *li_bottom;
 445         struct obd_device        *li_obd;
 446         struct ldlm_namespace    *li_namespace;
 447         struct local_oid_storage *li_los;
 448         struct lu_fid             li_local_root_fid;  /* backend root "/" */
 449         struct lu_fid             li_global_root_fid; /* /ROOT */
 450         struct dt_object         *li_bookmark_obj;
 451         struct lfsck_bookmark     li_bookmark_ram;
 452         struct lfsck_bookmark     li_bookmark_disk;
 453         struct lfsck_position     li_pos_current;
 454
 455         /* Obj for otable-based iteration */
 456         struct dt_object         *li_obj_oit;
 457
 458         /* Obj for directory traversal */
 459         struct dt_object         *li_obj_dir;
 460
 461         /* It for otable-based iteration */
 462         struct dt_it             *li_di_oit;
 463
 464         /* It for directory traversal */
 465         struct dt_it             *li_di_dir;
 466
 467         /* Description of OST */
 468         struct lfsck_tgt_descs    li_ost_descs;
 469
 470         /* Description of MDT */
 471         struct lfsck_tgt_descs    li_mdt_descs;
 472
 473         /* namespace-based directory traversal position. */
 474         __u64                     li_cookie_dir;
 475
 476         /* Arguments for low layer otable-based iteration. */
 477         __u32                     li_args_oit;
 478
 479         /* Arugments for namespace-based directory traversal. */
 480         __u32                     li_args_dir;
 481
 482         /* Schedule for every N objects. */
 483         __u32                     li_sleep_rate;
 484
 485         /* Sleep N jiffies for each schedule. */
 486         __u32                     li_sleep_jif;
 487
 488         /* How many objects have been scanned since last sleep. */
 489         __u32                     li_new_scanned;
 490
 491         /* The status when the LFSCK stopped or paused. */
 492         __u32                     li_status;
 493
 494         /* The flags when the lFSCK stopped or paused. */
 495         __u32                     li_flags;
 496
 497         unsigned int              li_oit_over:1, /* oit is finished. */
 498                                   li_drop_dryrun:1, /* Ever dryrun, not now. */
 499                                   li_master:1, /* Master instance or not. */
 500                                   li_current_oit_processed:1,
 501                                   li_start_unplug:1;
 502 };
 503
 504 enum lfsck_linkea_flags {
 505         /* The linkea entries does not match the object nlinks. */
 506         LLF_UNMATCH_NLINKS      = 0x01,
 507
 508         /* Fail to repair the multiple-linked objects during the double scan. */
 509         LLF_REPAIR_FAILED       = 0x02,
 510 };
 511
 512 struct lfsck_async_interpret_args {
 513         struct lfsck_component          *laia_com;
 514         struct lfsck_tgt_descs          *laia_ltds;
 515         struct lfsck_tgt_desc           *laia_ltd;
 516         struct lfsck_request            *laia_lr;
 517         int                              laia_result;
 518         unsigned int                     laia_shared:1;
 519 };
 520
 521 struct lfsck_thread_args {
 522         struct lu_env                    lta_env;
 523         struct lfsck_instance           *lta_lfsck;
 524         struct lfsck_component          *lta_com;
 525         struct lfsck_start_param        *lta_lsp;
 526 };
 527
 528 struct lfsck_thread_info {
 529         struct lu_name          lti_name;
 530         struct lu_buf           lti_buf;
 531         struct lu_buf           lti_linkea_buf;
 532         struct lu_buf           lti_big_buf;
 533         struct lu_fid           lti_fid;
 534         struct lu_fid           lti_fid2;
 535         struct lu_attr          lti_la;
 536         struct lu_attr          lti_la2;
 537         struct lu_attr          lti_la3;
 538         struct ost_id           lti_oi;
 539         union {
 540                 struct lustre_mdt_attrs lti_lma;
 541                 /* old LMA for compatibility */
 542                 char                    lti_lma_old[LMA_OLD_SIZE];
 543         };
 544         struct dt_object_format lti_dof;
 545         /* lti_ent and lti_key must be conjoint,
 546          * then lti_ent::lde_name will be lti_key. */
 547         struct lu_dirent        lti_ent;
 548         char                    lti_key[NAME_MAX + 16];
 549         struct lfsck_request    lti_lr;
 550         struct lfsck_async_interpret_args lti_laia;
 551         struct lfsck_start      lti_start;
 552         struct lfsck_stop       lti_stop;
 553         ldlm_policy_data_t      lti_policy;
 554         struct ldlm_res_id      lti_resid;
 555         union {
 556                 struct filter_fid_old   lti_old_pfid;
 557                 struct filter_fid       lti_new_pfid;
 558         };
 559         struct dt_allocation_hint lti_hint;
 560 };
 561
 562 /* lfsck_lib.c */
 563 const char *lfsck_status2names(enum lfsck_status status);
 564 void lfsck_component_cleanup(const struct lu_env *env,
 565                              struct lfsck_component *com);
 566 void lfsck_instance_cleanup(const struct lu_env *env,
 567                             struct lfsck_instance *lfsck);
 568 int lfsck_bits_dump(char **buf, int *len, int bits, const char *names[],
 569                     const char *prefix);
 570 int lfsck_time_dump(char **buf, int *len, __u64 time, const char *prefix);
 571 int lfsck_pos_dump(char **buf, int *len, struct lfsck_position *pos,
 572                    const char *prefix);
 573 void lfsck_pos_fill(const struct lu_env *env, struct lfsck_instance *lfsck,
 574                     struct lfsck_position *pos, bool init);
 575 void lfsck_control_speed(struct lfsck_instance *lfsck);
 576 void lfsck_control_speed_by_self(struct lfsck_component *com);
 577 int lfsck_reset(const struct lu_env *env, struct lfsck_instance *lfsck,
 578                 bool init);
 579 struct lfsck_thread_args *lfsck_thread_args_init(struct lfsck_instance *lfsck,
 580                                                  struct lfsck_component *com,
 581                                                  struct lfsck_start_param *lsp);
 582 void lfsck_thread_args_fini(struct lfsck_thread_args *lta);
 583 void lfsck_fail(const struct lu_env *env, struct lfsck_instance *lfsck,
 584                 bool new_checked);
 585 int lfsck_checkpoint(const struct lu_env *env, struct lfsck_instance *lfsck);
 586 int lfsck_prep(const struct lu_env *env, struct lfsck_instance *lfsck,
 587                struct lfsck_start_param *lsp);
 588 int lfsck_exec_oit(const struct lu_env *env, struct lfsck_instance *lfsck,
 589                    struct dt_object *obj);
 590 int lfsck_exec_dir(const struct lu_env *env, struct lfsck_instance *lfsck,
 591                    struct dt_object *obj, struct lu_dirent *ent);
 592 int lfsck_post(const struct lu_env *env, struct lfsck_instance *lfsck,
 593                int result);
 594 int lfsck_double_scan(const struct lu_env *env, struct lfsck_instance *lfsck);
 595 void lfsck_quit(const struct lu_env *env, struct lfsck_instance *lfsck);
 596 int lfsck_async_request(const struct lu_env *env, struct obd_export *exp,
 597                         struct lfsck_request *lr,
 598                         struct ptlrpc_request_set *set,
 599                         ptlrpc_interpterer_t interpterer,
 600                         void *args, int request);
 601
 602 /* lfsck_engine.c */
 603 int lfsck_master_engine(void *args);
 604
 605 /* lfsck_bookmark.c */
 606 int lfsck_bookmark_store(const struct lu_env *env,
 607                          struct lfsck_instance *lfsck);
 608 int lfsck_bookmark_setup(const struct lu_env *env,
 609                          struct lfsck_instance *lfsck);
 610
 611 /* lfsck_namespace.c */
 612 int lfsck_namespace_setup(const struct lu_env *env,
 613                           struct lfsck_instance *lfsck);
 614
 615 /* lfsck_layout.c */
 616 int lfsck_layout_setup(const struct lu_env *env, struct lfsck_instance *lfsck);
 617
 618 extern const char *lfsck_flags_names[];
 619 extern const char *lfsck_param_names[];
 620 extern struct lu_context_key lfsck_thread_key;
 621
 622 static inline struct dt_device *lfsck_obj2dt_dev(struct dt_object *obj)
 623 {
 624         return container_of0(obj->do_lu.lo_dev, struct dt_device, dd_lu_dev);
 625 }
 626
 627 static inline struct lfsck_thread_info *
 628 lfsck_env_info(const struct lu_env *env)
 629 {
 630         struct lfsck_thread_info *info;
 631
 632         info = lu_context_key_get(&env->le_ctx, &lfsck_thread_key);
 633         LASSERT(info != NULL);
 634         return info;
 635 }
 636
 637 static inline const struct lu_name *
 638 lfsck_name_get_const(const struct lu_env *env, const void *area, ssize_t len)
 639 {
 640         struct lu_name *lname;
 641
 642         lname = &lfsck_env_info(env)->lti_name;
 643         lname->ln_name = area;
 644         lname->ln_namelen = len;
 645         return lname;
 646 }
 647
 648 static inline struct lu_buf *
 649 lfsck_buf_get(const struct lu_env *env, void *area, ssize_t len)
 650 {
 651         struct lu_buf *buf;
 652
 653         buf = &lfsck_env_info(env)->lti_buf;
 654         buf->lb_buf = area;
 655         buf->lb_len = len;
 656         return buf;
 657 }
 658
 659 static inline const struct lu_buf *
 660 lfsck_buf_get_const(const struct lu_env *env, const void *area, ssize_t len)
 661 {
 662         struct lu_buf *buf;
 663
 664         buf = &lfsck_env_info(env)->lti_buf;
 665         buf->lb_buf = (void *)area;
 666         buf->lb_len = len;
 667         return buf;
 668 }
 669
 670 static inline char *lfsck_lfsck2name(struct lfsck_instance *lfsck)
 671 {
 672         return lfsck->li_bottom->dd_lu_dev.ld_obd->obd_name;
 673 }
 674
 675 static inline const struct lu_fid *lfsck_dto2fid(const struct dt_object *obj)
 676 {
 677         return lu_object_fid(&obj->do_lu);
 678 }
 679
 680 static inline void lfsck_pos_set_zero(struct lfsck_position *pos)
 681 {
 682         memset(pos, 0, sizeof(*pos));
 683 }
 684
 685 static inline int lfsck_pos_is_zero(const struct lfsck_position *pos)
 686 {
 687         return pos->lp_oit_cookie == 0 && fid_is_zero(&pos->lp_dir_parent);
 688 }
 689
 690 static inline int lfsck_pos_is_eq(const struct lfsck_position *pos1,
 691                                   const struct lfsck_position *pos2)
 692 {
 693         if (pos1->lp_oit_cookie < pos2->lp_oit_cookie)
 694                 return -1;
 695
 696         if (pos1->lp_oit_cookie > pos2->lp_oit_cookie)
 697                 return 1;
 698
 699         if (fid_is_zero(&pos1->lp_dir_parent) &&
 700             !fid_is_zero(&pos2->lp_dir_parent))
 701                 return -1;
 702
 703         if (!fid_is_zero(&pos1->lp_dir_parent) &&
 704             fid_is_zero(&pos2->lp_dir_parent))
 705                 return 1;
 706
 707         if (fid_is_zero(&pos1->lp_dir_parent) &&
 708             fid_is_zero(&pos2->lp_dir_parent))
 709                 return 0;
 710
 711         LASSERT(lu_fid_eq(&pos1->lp_dir_parent, &pos2->lp_dir_parent));
 712
 713         if (pos1->lp_dir_cookie < pos2->lp_dir_cookie)
 714                 return -1;
 715
 716         if (pos1->lp_dir_cookie > pos2->lp_dir_cookie)
 717                 return 1;
 718
 719         return 0;
 720 }
 721
 722 static void inline lfsck_position_le_to_cpu(struct lfsck_position *des,
 723                                             struct lfsck_position *src)
 724 {
 725         des->lp_oit_cookie = le64_to_cpu(src->lp_oit_cookie);
 726         fid_le_to_cpu(&des->lp_dir_parent, &src->lp_dir_parent);
 727         des->lp_dir_cookie = le64_to_cpu(src->lp_dir_cookie);
 728 }
 729
 730 static void inline lfsck_position_cpu_to_le(struct lfsck_position *des,
 731                                             struct lfsck_position *src)
 732 {
 733         des->lp_oit_cookie = cpu_to_le64(src->lp_oit_cookie);
 734         fid_cpu_to_le(&des->lp_dir_parent, &src->lp_dir_parent);
 735         des->lp_dir_cookie = cpu_to_le64(src->lp_dir_cookie);
 736 }
 737
 738 static inline umode_t lfsck_object_type(const struct dt_object *obj)
 739 {
 740         return lu_object_attr(&obj->do_lu);
 741 }
 742
 743 static inline int lfsck_is_dead_obj(const struct dt_object *obj)
 744 {
 745         struct lu_object_header *loh = obj->do_lu.lo_header;
 746
 747         return !!test_bit(LU_OBJECT_HEARD_BANSHEE, &loh->loh_flags);
 748 }
 749
 750 static inline struct dt_object *lfsck_object_find(const struct lu_env *env,
 751                                                   struct lfsck_instance *lfsck,
 752                                                   const struct lu_fid *fid)
 753 {
 754         return lu2dt(lu_object_find_slice(env, dt2lu_dev(lfsck->li_next),
 755                      fid, NULL));
 756 }
 757
 758 static inline struct dt_object *lfsck_object_get(struct dt_object *obj)
 759 {
 760         lu_object_get(&obj->do_lu);
 761         return obj;
 762 }
 763
 764 static inline void lfsck_object_put(const struct lu_env *env,
 765                                     struct dt_object *obj)
 766 {
 767         lu_object_put(env, &obj->do_lu);
 768 }
 769
 770 static inline struct dt_object *
 771 lfsck_object_find_by_dev(const struct lu_env *env, struct dt_device *dev,
 772                          const struct lu_fid *fid)
 773 {
 774         struct dt_object *obj;
 775
 776         obj = lu2dt(lu_object_find_slice(env, dt2lu_dev(dev), fid, NULL));
 777         if (unlikely(obj == NULL))
 778                 return ERR_PTR(-ENOENT);
 779
 780         return obj;
 781 }
 782
 783 static inline struct lfsck_tgt_desc *lfsck_tgt_get(struct lfsck_tgt_descs *ltds,
 784                                                    __u32 index)
 785 {
 786         struct lfsck_tgt_desc *ltd;
 787
 788         ltd = LTD_TGT(ltds, index);
 789         if (ltd != NULL)
 790                 atomic_inc(&ltd->ltd_ref);
 791
 792         return ltd;
 793 }
 794
 795 static inline void lfsck_tgt_put(struct lfsck_tgt_desc *ltd)
 796 {
 797         if (atomic_dec_and_test(&ltd->ltd_ref))
 798                 OBD_FREE_PTR(ltd);
 799 }
 800
 801 static inline struct lfsck_component *
 802 lfsck_component_get(struct lfsck_component *com)
 803 {
 804         atomic_inc(&com->lc_ref);
 805
 806         return com;
 807 }
 808
 809 static inline void lfsck_component_put(const struct lu_env *env,
 810                                        struct lfsck_component *com)
 811 {
 812         if (atomic_dec_and_test(&com->lc_ref)) {
 813                 if (com->lc_obj != NULL)
 814                         lu_object_put_nocache(env, &com->lc_obj->do_lu);
 815                 if (com->lc_file_ram != NULL)
 816                         OBD_FREE(com->lc_file_ram, com->lc_file_size);
 817                 if (com->lc_file_disk != NULL)
 818                         OBD_FREE(com->lc_file_disk, com->lc_file_size);
 819                 if (com->lc_data != NULL) {
 820                         LASSERT(com->lc_ops->lfsck_data_release != NULL);
 821
 822                         com->lc_ops->lfsck_data_release(env, com);
 823                 }
 824
 825                 OBD_FREE_PTR(com);
 826         }
 827 }
 828
 829 static inline struct lfsck_instance *
 830 lfsck_instance_get(struct lfsck_instance *lfsck)
 831 {
 832         atomic_inc(&lfsck->li_ref);
 833
 834         return lfsck;
 835 }
 836
 837 static inline void lfsck_instance_put(const struct lu_env *env,
 838                                       struct lfsck_instance *lfsck)
 839 {
 840         if (atomic_dec_and_test(&lfsck->li_ref))
 841                 lfsck_instance_cleanup(env, lfsck);
 842 }
 843
 844 static inline mdsno_t lfsck_dev_idx(struct dt_device *dev)
 845 {
 846         return dev->dd_lu_dev.ld_site->ld_seq_site->ss_node_id;
 847 }
 848
 849 #endif /* _LFSCK_INTERNAL_H */