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