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 <obd.h>
  40 #include <lu_object.h>
  41 #include <dt_object.h>
  42 #include <lustre_net.h>
  43 #include <lustre_dlm.h>
  44 #include <lustre_fid.h>
  45
  46 #define HALF_SEC                        (CFS_HZ >> 1)
  47 #define LFSCK_CHECKPOINT_INTERVAL       60
  48
  49 #define LFSCK_NAMEENTRY_DEAD            1 /* The object has been unlinked. */
  50 #define LFSCK_NAMEENTRY_REMOVED         2 /* The entry has been removed. */
  51 #define LFSCK_NAMEENTRY_RECREATED       3 /* The entry has been recreated. */
  52
  53 enum lfsck_status {
  54         /* The lfsck file is new created, for new MDT, upgrading from old disk,
  55          * or re-creating the lfsck file manually. */
  56         LS_INIT                 = 0,
  57
  58         /* The first-step system scanning. */
  59         LS_SCANNING_PHASE1      = 1,
  60
  61         /* The second-step system scanning. */
  62         LS_SCANNING_PHASE2      = 2,
  63
  64         /* The LFSCK processing has completed for all objects. */
  65         LS_COMPLETED            = 3,
  66
  67         /* The LFSCK exited automatically for failure, will not auto restart. */
  68         LS_FAILED               = 4,
  69
  70         /* The LFSCK is stopped manually, will not auto restart. */
  71         LS_STOPPED              = 5,
  72
  73         /* LFSCK is paused automatically when umount,
  74          * will be restarted automatically when remount. */
  75         LS_PAUSED               = 6,
  76
  77         /* System crashed during the LFSCK,
  78          * will be restarted automatically after recovery. */
  79         LS_CRASHED              = 7,
  80 };
  81
  82 enum lfsck_flags {
  83         /* Finish to the cycle scanning. */
  84         LF_SCANNED_ONCE = 0x00000001ULL,
  85
  86         /* There is some namespace inconsistency. */
  87         LF_INCONSISTENT = 0x00000002ULL,
  88
  89         /* The device is upgraded from 1.8 format. */
  90         LF_UPGRADE      = 0x00000004ULL,
  91 };
  92
  93 struct lfsck_position {
  94         /* low layer object table-based iteration position. */
  95         __u64   lp_oit_cookie;
  96
  97         /* parent FID for directory traversal. */
  98         struct lu_fid lp_dir_parent;
  99
 100         /* namespace-based directory traversal position. */
 101         __u64   lp_dir_cookie;
 102 };
 103
 104 struct lfsck_bookmark {
 105         /* Magic number to detect that this struct contains valid data. */
 106         __u32   lb_magic;
 107
 108         /* For compatible with old versions. */
 109         __u16   lb_version;
 110
 111         /* See 'enum lfsck_param_flags' */
 112         __u16   lb_param;
 113
 114         /* How many items can be scanned at most per second. */
 115         __u32   lb_speed_limit;
 116
 117         /* For 64-bits aligned. */
 118         __u32   lb_padding;
 119
 120         /* For future using. */
 121         __u64   lb_reserved[6];
 122 };
 123
 124 struct lfsck_namespace {
 125         /* Magic number to detect that this struct contains valid data. */
 126         __u32   ln_magic;
 127
 128         /* See 'enum lfsck_status'. */
 129         __u32   ln_status;
 130
 131         /* See 'enum lfsck_flags'. */
 132         __u32   ln_flags;
 133
 134         /* How many completed LFSCK runs on the device. */
 135         __u32   ln_success_count;
 136
 137         /*  How long the LFSCK phase1 has run in seconds. */
 138         __u32   ln_run_time_phase1;
 139
 140         /*  How long the LFSCK phase2 has run in seconds. */
 141         __u32   ln_run_time_phase2;
 142
 143         /* Time for the last LFSCK completed in seconds since epoch. */
 144         __u64   ln_time_last_complete;
 145
 146         /* Time for the latest LFSCK ran in seconds since epoch. */
 147         __u64   ln_time_latest_start;
 148
 149         /* Time for the last LFSCK checkpoint in seconds since epoch. */
 150         __u64   ln_time_last_checkpoint;
 151
 152         /* Position for the latest LFSCK started from. */
 153         struct lfsck_position   ln_pos_latest_start;
 154
 155         /* Position for the last LFSCK checkpoint. */
 156         struct lfsck_position   ln_pos_last_checkpoint;
 157
 158         /* Position for the first should be updated object. */
 159         struct lfsck_position   ln_pos_first_inconsistent;
 160
 161         /* How many items (including dir) have been checked. */
 162         __u64   ln_items_checked;
 163
 164         /* How many items have been repaired. */
 165         __u64   ln_items_repaired;
 166
 167         /* How many items failed to be processed. */
 168         __u64   ln_items_failed;
 169
 170         /* How many directories have been traversed. */
 171         __u64   ln_dirs_checked;
 172
 173         /* How many multiple-linked objects have been checked. */
 174         __u64   ln_mlinked_checked;
 175
 176         /* How many objects have been double scanned. */
 177         __u64   ln_objs_checked_phase2;
 178
 179         /* How many objects have been reparied during double scan. */
 180         __u64   ln_objs_repaired_phase2;
 181
 182         /* How many objects failed to be processed during double scan. */
 183         __u64   ln_objs_failed_phase2;
 184
 185         /* How many objects with nlink fixed. */
 186         __u64   ln_objs_nlink_repaired;
 187
 188         /* How many objects were lost before, but found back now. */
 189         __u64   ln_objs_lost_found;
 190
 191         /* The latest object has been processed (failed) during double scan. */
 192         struct lu_fid   ln_fid_latest_scanned_phase2;
 193
 194         /* For further using. 256-bytes aligned now. */
 195         __u64   ln_reserved[2];
 196 };
 197
 198 struct lfsck_component;
 199
 200 struct lfsck_operations {
 201         int (*lfsck_reset)(const struct lu_env *env,
 202                            struct lfsck_component *com,
 203                            bool init);
 204
 205         void (*lfsck_fail)(const struct lu_env *env,
 206                            struct lfsck_component *com,
 207                            bool new_checked);
 208
 209         int (*lfsck_checkpoint)(const struct lu_env *env,
 210                                 struct lfsck_component *com,
 211                                 bool init);
 212
 213         int (*lfsck_prep)(const struct lu_env *env,
 214                           struct lfsck_component *com);
 215
 216         int (*lfsck_exec_oit)(const struct lu_env *env,
 217                               struct lfsck_component *com,
 218                               struct dt_object *obj);
 219
 220         int (*lfsck_exec_dir)(const struct lu_env *env,
 221                               struct lfsck_component *com,
 222                               struct dt_object *obj,
 223                               struct lu_dirent *ent);
 224
 225         int (*lfsck_post)(const struct lu_env *env,
 226                           struct lfsck_component *com,
 227                           int result,
 228                           bool init);
 229
 230         int (*lfsck_dump)(const struct lu_env *env,
 231                           struct lfsck_component *com,
 232                           char *buf,
 233                           int len);
 234
 235         int (*lfsck_double_scan)(const struct lu_env *env,
 236                                  struct lfsck_component *com);
 237 };
 238
 239 struct lfsck_component {
 240         /* into lfsck_instance::li_list_(scan,double_scan,idle} */
 241         cfs_list_t               lc_link;
 242
 243         /* into lfsck_instance::li_list_dir */
 244         cfs_list_t               lc_link_dir;
 245         struct rw_semaphore      lc_sem;
 246         cfs_atomic_t             lc_ref;
 247
 248         struct lfsck_position    lc_pos_start;
 249         struct lfsck_instance   *lc_lfsck;
 250         struct dt_object        *lc_obj;
 251         struct lfsck_operations *lc_ops;
 252         void                    *lc_file_ram;
 253         void                    *lc_file_disk;
 254         __u32                    lc_file_size;
 255
 256         /* How many objects have been checked since last checkpoint. */
 257         __u32                    lc_new_checked;
 258         unsigned int             lc_journal:1;
 259         __u16                    lc_type;
 260 };
 261
 262 struct lfsck_instance {
 263         struct mutex              li_mutex;
 264         spinlock_t                li_lock;
 265
 266         /* Link into the lfsck_instance_list. */
 267         cfs_list_t                li_link;
 268
 269         /* For the components in (first) scanning via otable-based iteration. */
 270         cfs_list_t                li_list_scan;
 271
 272         /* For the components in scanning via directory traversal. Because
 273          * directory traversal cannot guarantee all the object be scanned,
 274          * so the component in the li_list_dir must be in li_list_scan. */
 275         cfs_list_t                li_list_dir;
 276
 277         /* For the components in double scanning. */
 278         cfs_list_t                li_list_double_scan;
 279
 280         /* For the components those are not scanning now. */
 281         cfs_list_t                li_list_idle;
 282
 283         cfs_atomic_t              li_ref;
 284         struct ptlrpc_thread      li_thread;
 285
 286         /* The time for last checkpoint, jiffies */
 287         cfs_time_t                li_time_last_checkpoint;
 288
 289         /* The time for next checkpoint, jiffies */
 290         cfs_time_t                li_time_next_checkpoint;
 291
 292         struct dt_device         *li_next;
 293         struct dt_device         *li_bottom;
 294         struct ldlm_namespace    *li_namespace;
 295         struct local_oid_storage *li_los;
 296         struct dt_object         *li_local_root; /* backend root "/" */
 297         struct lu_fid             li_global_root_fid; /* /ROOT */
 298         struct dt_object         *li_bookmark_obj;
 299         struct lfsck_bookmark     li_bookmark_ram;
 300         struct lfsck_bookmark     li_bookmark_disk;
 301         struct lfsck_position     li_pos_current;
 302
 303         /* Obj for otable-based iteration */
 304         struct dt_object         *li_obj_oit;
 305
 306         /* Obj for directory traversal */
 307         struct dt_object         *li_obj_dir;
 308
 309         /* It for otable-based iteration */
 310         struct dt_it             *li_di_oit;
 311
 312         /* It for directory traversal */
 313         struct dt_it             *li_di_dir;
 314
 315         /* Arguments for low layer otable-based iteration. */
 316         __u32                     li_args_oit;
 317
 318         /* Arugments for namespace-based directory traversal. */
 319         __u32                     li_args_dir;
 320
 321         /* Schedule for every N objects. */
 322         __u32                     li_sleep_rate;
 323
 324         /* Sleep N jiffies for each schedule. */
 325         __u32                     li_sleep_jif;
 326
 327         /* How many objects have been scanned since last sleep. */
 328         __u32                     li_new_scanned;
 329
 330         unsigned int              li_paused:1, /* The lfsck is paused. */
 331                                   li_oit_over:1, /* oit is finished. */
 332                                   li_drop_dryrun:1, /* Ever dryrun, not now. */
 333                                   li_master:1, /* Master instance or not. */
 334                                   li_current_oit_processed:1;
 335 };
 336
 337 enum lfsck_linkea_flags {
 338         /* The linkea entries does not match the object nlinks. */
 339         LLF_UNMATCH_NLINKS      = 0x01,
 340
 341         /* Fail to repair the multiple-linked objects during the double scan. */
 342         LLF_REPAIR_FAILED       = 0x02,
 343 };
 344
 345 struct lfsck_thread_info {
 346         struct lu_name          lti_name;
 347         struct lu_buf           lti_buf;
 348         struct lu_buf           lti_linkea_buf;
 349         struct lu_fid           lti_fid;
 350         struct lu_fid           lti_fid2;
 351         struct lu_attr          lti_la;
 352         /* lti_ent and lti_key must be conjoint,
 353          * then lti_ent::lde_name will be lti_key. */
 354         struct lu_dirent        lti_ent;
 355         char                    lti_key[NAME_MAX + 16];
 356 };
 357
 358 /* lfsck_lib.c */
 359 void lfsck_component_cleanup(const struct lu_env *env,
 360                              struct lfsck_component *com);
 361 int lfsck_bits_dump(char **buf, int *len, int bits, const char *names[],
 362                     const char *prefix);
 363 int lfsck_time_dump(char **buf, int *len, __u64 time, const char *prefix);
 364 int lfsck_pos_dump(char **buf, int *len, struct lfsck_position *pos,
 365                    const char *prefix);
 366 void lfsck_pos_fill(const struct lu_env *env, struct lfsck_instance *lfsck,
 367                     struct lfsck_position *pos, bool init);
 368 void lfsck_control_speed(struct lfsck_instance *lfsck);
 369 int lfsck_reset(const struct lu_env *env, struct lfsck_instance *lfsck,
 370                 bool init);
 371 void lfsck_fail(const struct lu_env *env, struct lfsck_instance *lfsck,
 372                 bool new_checked);
 373 int lfsck_checkpoint(const struct lu_env *env, struct lfsck_instance *lfsck);
 374 int lfsck_prep(const struct lu_env *env, struct lfsck_instance *lfsck);
 375 int lfsck_exec_oit(const struct lu_env *env, struct lfsck_instance *lfsck,
 376                    struct dt_object *obj);
 377 int lfsck_exec_dir(const struct lu_env *env, struct lfsck_instance *lfsck,
 378                    struct dt_object *obj, struct lu_dirent *ent);
 379 int lfsck_post(const struct lu_env *env, struct lfsck_instance *lfsck,
 380                int result);
 381 int lfsck_double_scan(const struct lu_env *env, struct lfsck_instance *lfsck);
 382
 383 /* lfsck_engine.c */
 384 int lfsck_master_engine(void *args);
 385
 386 /* lfsck_bookmark.c */
 387 int lfsck_bookmark_store(const struct lu_env *env,
 388                          struct lfsck_instance *lfsck);
 389 int lfsck_bookmark_setup(const struct lu_env *env,
 390                          struct lfsck_instance *lfsck);
 391
 392 /* lfsck_namespace.c */
 393 int lfsck_namespace_setup(const struct lu_env *env,
 394                           struct lfsck_instance *lfsck);
 395
 396 extern const char *lfsck_status_names[];
 397 extern const char *lfsck_flags_names[];
 398 extern const char *lfsck_param_names[];
 399 extern struct lu_context_key lfsck_thread_key;
 400
 401 static inline struct lfsck_thread_info *
 402 lfsck_env_info(const struct lu_env *env)
 403 {
 404         struct lfsck_thread_info *info;
 405
 406         info = lu_context_key_get(&env->le_ctx, &lfsck_thread_key);
 407         LASSERT(info != NULL);
 408         return info;
 409 }
 410
 411 static inline const struct lu_name *
 412 lfsck_name_get_const(const struct lu_env *env, const void *area, ssize_t len)
 413 {
 414         struct lu_name *lname;
 415
 416         lname = &lfsck_env_info(env)->lti_name;
 417         lname->ln_name = area;
 418         lname->ln_namelen = len;
 419         return lname;
 420 }
 421
 422 static inline struct lu_buf *
 423 lfsck_buf_get(const struct lu_env *env, void *area, ssize_t len)
 424 {
 425         struct lu_buf *buf;
 426
 427         buf = &lfsck_env_info(env)->lti_buf;
 428         buf->lb_buf = area;
 429         buf->lb_len = len;
 430         return buf;
 431 }
 432
 433 static inline const struct lu_buf *
 434 lfsck_buf_get_const(const struct lu_env *env, const void *area, ssize_t len)
 435 {
 436         struct lu_buf *buf;
 437
 438         buf = &lfsck_env_info(env)->lti_buf;
 439         buf->lb_buf = (void *)area;
 440         buf->lb_len = len;
 441         return buf;
 442 }
 443
 444 static inline char *lfsck_lfsck2name(struct lfsck_instance *lfsck)
 445 {
 446         return lfsck->li_bottom->dd_lu_dev.ld_obd->obd_name;
 447 }
 448
 449 static inline const struct lu_fid *lfsck_dto2fid(const struct dt_object *obj)
 450 {
 451         return lu_object_fid(&obj->do_lu);
 452 }
 453
 454 static inline void lfsck_pos_set_zero(struct lfsck_position *pos)
 455 {
 456         memset(pos, 0, sizeof(*pos));
 457 }
 458
 459 static inline int lfsck_pos_is_zero(const struct lfsck_position *pos)
 460 {
 461         return pos->lp_oit_cookie == 0 && fid_is_zero(&pos->lp_dir_parent);
 462 }
 463
 464 static inline int lfsck_pos_is_eq(const struct lfsck_position *pos1,
 465                                   const struct lfsck_position *pos2)
 466 {
 467         if (pos1->lp_oit_cookie < pos2->lp_oit_cookie)
 468                 return -1;
 469
 470         if (pos1->lp_oit_cookie > pos2->lp_oit_cookie)
 471                 return 1;
 472
 473         if (fid_is_zero(&pos1->lp_dir_parent) &&
 474             !fid_is_zero(&pos2->lp_dir_parent))
 475                 return -1;
 476
 477         if (!fid_is_zero(&pos1->lp_dir_parent) &&
 478             fid_is_zero(&pos2->lp_dir_parent))
 479                 return 1;
 480
 481         if (fid_is_zero(&pos1->lp_dir_parent) &&
 482             fid_is_zero(&pos2->lp_dir_parent))
 483                 return 0;
 484
 485         LASSERT(lu_fid_eq(&pos1->lp_dir_parent, &pos2->lp_dir_parent));
 486
 487         if (pos1->lp_dir_cookie < pos2->lp_dir_cookie)
 488                 return -1;
 489
 490         if (pos1->lp_dir_cookie > pos2->lp_dir_cookie)
 491                 return 1;
 492
 493         return 0;
 494 }
 495
 496 static void inline lfsck_position_le_to_cpu(struct lfsck_position *des,
 497                                             struct lfsck_position *src)
 498 {
 499         des->lp_oit_cookie = le64_to_cpu(src->lp_oit_cookie);
 500         fid_le_to_cpu(&des->lp_dir_parent, &src->lp_dir_parent);
 501         des->lp_dir_cookie = le64_to_cpu(src->lp_dir_cookie);
 502 }
 503
 504 static void inline lfsck_position_cpu_to_le(struct lfsck_position *des,
 505                                             struct lfsck_position *src)
 506 {
 507         des->lp_oit_cookie = cpu_to_le64(src->lp_oit_cookie);
 508         fid_cpu_to_le(&des->lp_dir_parent, &src->lp_dir_parent);
 509         des->lp_dir_cookie = cpu_to_le64(src->lp_dir_cookie);
 510 }
 511
 512 static inline cfs_umode_t lfsck_object_type(const struct dt_object *obj)
 513 {
 514         return lu_object_attr(&obj->do_lu);
 515 }
 516
 517 static inline int lfsck_is_dead_obj(const struct dt_object *obj)
 518 {
 519         struct lu_object_header *loh = obj->do_lu.lo_header;
 520
 521         return !!test_bit(LU_OBJECT_HEARD_BANSHEE, &loh->loh_flags);
 522 }
 523
 524 static inline struct dt_object *lfsck_object_find(const struct lu_env *env,
 525                                                   struct lfsck_instance *lfsck,
 526                                                   const struct lu_fid *fid)
 527 {
 528         return lu2dt(lu_object_find_slice(env, dt2lu_dev(lfsck->li_next),
 529                      fid, NULL));
 530 }
 531
 532 static inline struct dt_object *lfsck_object_get(struct dt_object *obj)
 533 {
 534         lu_object_get(&obj->do_lu);
 535         return obj;
 536 }
 537
 538 static inline void lfsck_object_put(const struct lu_env *env,
 539                                     struct dt_object *obj)
 540 {
 541         lu_object_put(env, &obj->do_lu);
 542 }
 543
 544 #endif /* _LFSCK_INTERNAL_H */