Whamcloud - gitweb
LU-957 lfsck: user space tools for LFSCK/scrub
[fs/lustre-release.git] / lustre / osd-ldiskfs / osd_scrub.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) 2012 Whamcloud, Inc.
24  */
25 /*
26  * lustre/osd-ldiskfs/osd_scrub.h
27  *
28  * Shared definitions and declarations for OI scrub.
29  *
30  * Author: Fan Yong <yong.fan@whamcloud.com>
31  */
32
33 #ifndef _OSD_SCRUB_H
34 # define _OSD_SCRUB_H
35
36 #include "osd_oi.h"
37
38 #define SCRUB_MAGIC_V1                  0x4C5FD252
39 #define SCRUB_CHECKPOINT_INTERVAL       60
40 #define SCRUB_OI_BITMAP_SIZE            (OSD_OI_FID_NR_MAX >> 3)
41 #define SCRUB_WINDOW_SIZE               1024
42
43 enum scrub_status {
44         /* The scrub file is new created, for new MDT, upgrading from old disk,
45          * or re-creating the scrub file manually. */
46         SS_INIT         = 0,
47
48         /* The scrub is checking/repairing the OI files. */
49         SS_SCANNING     = 1,
50
51         /* The scrub checked/repaired the OI files successfully. */
52         SS_COMPLETED    = 2,
53
54         /* The scrub failed to check/repair the OI files. */
55         SS_FAILED       = 3,
56
57         /* The scrub is stopped manually, the OI files may be inconsistent. */
58         SS_STOPPED      = 4,
59
60         /* The scrub is paused automatically when umount. */
61         SS_PAUSED       = 5,
62
63         /* The scrub crashed during the scanning, should be restarted. */
64         SS_CRASHED      = 6,
65 };
66
67 enum scrub_flags {
68         /* OI files have been recreated, OI mappings should be re-inserted. */
69         SF_RECREATED    = 0x0000000000000001ULL,
70
71         /* OI files are invalid, should be rebuild ASAP */
72         SF_INCONSISTENT = 0x0000000000000002ULL,
73
74         /* OI scrub is triggered automatically. */
75         SF_AUTO         = 0x0000000000000004ULL,
76 };
77
78 enum scrub_param {
79         /* Exit when fail. */
80         SP_FAILOUT      = 0x0001,
81 };
82
83 enum scrub_start {
84         /* Set failout flag. */
85         SS_SET_FAILOUT          = 0x00000001,
86
87         /* Clear failout flag. */
88         SS_CLEAR_FAILOUT        = 0x00000002,
89
90         /* Reset scrub start position. */
91         SS_RESET                = 0x00000004,
92
93         /* Trigger scrub automatically. */
94         SS_AUTO                 = 0x00000008,
95 };
96
97 struct scrub_file {
98         /* 128-bit uuid for volume. */
99         __u8    sf_uuid[16];
100
101         /* See 'enum scrub_flags'. */
102         __u64   sf_flags;
103
104         /* The scrub magic. */
105         __u32   sf_magic;
106
107         /* See 'enum scrub_status'. */
108         __u16   sf_status;
109
110         /* See 'enum scrub_param'. */
111         __u16   sf_param;
112
113         /* The time for the last OI scrub completed. */
114         __u64   sf_time_last_complete;
115
116         /* The time for the latest OI scrub ran. */
117         __u64   sf_time_latest_start;
118
119         /* The time for the last OI scrub checkpoint. */
120         __u64   sf_time_last_checkpoint;
121
122         /* The position for the latest OI scrub started from. */
123         __u64   sf_pos_latest_start;
124
125         /* The position for the last OI scrub checkpoint. */
126         __u64   sf_pos_last_checkpoint;
127
128         /* The position for the first should be updated object. */
129         __u64   sf_pos_first_inconsistent;
130
131         /* How many objects have been checked. */
132         __u64   sf_items_checked;
133
134         /* How many objects have been updated. */
135         __u64   sf_items_updated;
136
137         /* How many objects failed to be processed. */
138         __u64   sf_items_failed;
139
140         /* How many prior objects have been updated during scanning. */
141         __u64   sf_items_updated_prior;
142
143         /* How long the OI scrub has run. */
144         __u32   sf_run_time;
145
146         /* How many completed OI scrub ran on the device. */
147         __u32   sf_success_count;
148
149         /* How many OI files. */
150         __u16   sf_oi_count;
151
152         /* Update the magic or flags if want to use the reserved fields. */
153         __u16   sf_reserved_0;
154         __u32   sf_reserved_1;
155         __u64   sf_reserved_2[16];
156
157         /* Bitmap for OI files recreated case. */
158         __u8    sf_oi_bitmap[SCRUB_OI_BITMAP_SIZE];
159 };
160
161 struct osd_scrub {
162         struct lvfs_run_ctxt    os_ctxt;
163         struct ptlrpc_thread    os_thread;
164         struct osd_idmap_cache  os_oic;
165         cfs_list_t              os_inconsistent_items;
166
167         /* write lock for scrub prep/update/post/checkpoint,
168          * read lock for scrub dump. */
169         cfs_rw_semaphore_t      os_rwsem;
170         cfs_spinlock_t          os_lock;
171
172         /* Scrub file in memory. */
173         struct scrub_file       os_file;
174
175         /* Buffer for scrub file load/store. */
176         struct scrub_file       os_file_disk;
177
178         /* Inode for the scrub file. */
179         struct inode           *os_inode;
180
181         /* The time for last checkpoint, jiffies */
182         cfs_time_t              os_time_last_checkpoint;
183
184         /* The time for next checkpoint, jiffies */
185         cfs_time_t              os_time_next_checkpoint;
186
187         /* How many objects have been checked since last checkpoint. */
188         __u32                   os_new_checked;
189         __u32                   os_pos_current;
190         __u32                   os_start_flags;
191         unsigned int            os_in_prior:1, /* process inconsistent item
192                                                 * found by RPC prior */
193                                 os_waiting:1, /* Waiting for scan window. */
194                                 os_full_speed:1, /* run w/o speed limit */
195                                 os_no_scrub:1, /* NOT auto trigger OI scrub*/
196                                 os_paused:1; /* The scrub is paused. */
197 };
198
199 #endif /* _OSD_SCRUB_H */