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