4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
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.
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.
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
23 * Copyright (c) 2012, 2017, Intel Corporation.
26 * lustre/include/lustre/lustre_lfsck_user.h
28 * Lustre LFSCK userspace interfaces.
30 * Author: Fan, Yong <fan.yong@intel.com>
33 #ifndef _LUSTRE_LFSCK_USER_H
34 # define _LUSTRE_LFSCK_USER_H
36 #include <linux/types.h>
37 #include <linux/lustre/lustre_user.h>
53 * -----------------------------------------------------------------
57 * LS_SCANNING_PHASE2 LS_FAILED LS_STOPPED LS_PAUSED LS_CRASHED LS_PARTIAL
61 * | (lfsck:restart) |: |: |: |: |:
63 * -----------------------------------------------------------------
69 /* The lfsck file is new created, for new MDT, upgrading from old disk,
70 * or re-creating the lfsck file manually.
74 /* The first-step system scanning. The checked items during the phase1
75 * scanning depends on the LFSCK type.
77 LS_SCANNING_PHASE1 = 1,
79 /* The second-step system scanning. The checked items during the phase2
80 * scanning depends on the LFSCK type.
82 LS_SCANNING_PHASE2 = 2,
84 /* The LFSCK processing has completed for all objects. */
87 /* The LFSCK exited automatically for failure, will not auto restart. */
90 /* The LFSCK is stopped manually, will not auto restart. */
93 /* LFSCK is paused automatically when umount,
94 * will be restarted automatically when remount.
98 /* System crashed during the LFSCK,
99 * will be restarted automatically after recovery.
103 /* Some OST/MDT failed during the LFSCK, or not join the LFSCK. */
106 /* The LFSCK is failed because its controller is failed. */
109 /* The LFSCK is stopped because its controller is stopped. */
112 /* The LFSCK is paused because its controller is paused. */
118 static inline const char *lfsck_status2name(int status)
120 static const char * const lfsck_status_names[] = {
122 [LS_SCANNING_PHASE1] = "scanning-phase1",
123 [LS_SCANNING_PHASE2] = "scanning-phase2",
124 [LS_COMPLETED] = "completed",
125 [LS_FAILED] = "failed",
126 [LS_STOPPED] = "stopped",
127 [LS_PAUSED] = "paused",
128 [LS_CRASHED] = "crashed",
129 [LS_PARTIAL] = "partial",
130 [LS_CO_FAILED] = "co-failed",
131 [LS_CO_STOPPED] = "co-stopped",
132 [LS_CO_PAUSED] = "co-paused"
135 if (status < 0 || status >= LS_MAX)
138 return lfsck_status_names[status];
141 enum lfsck_param_flags {
142 /* Reset LFSCK iterator position to the device beginning. */
145 /* Exit when fail. */
146 LPF_FAILOUT = 0x0002,
148 /* Dryrun mode, only check without modification */
151 /* LFSCK runs on all targets. */
152 LPF_ALL_TGT = 0x0008,
154 /* Broadcast the command to other MDTs. Only valid on the sponsor MDT */
155 LPF_BROADCAST = 0x0010,
157 /* Handle orphan OST-objects. */
158 LPF_OST_ORPHAN = 0x0020,
160 /* Create OST-object for dangling LOV EA. */
161 LPF_CREATE_OSTOBJ = 0x0040,
163 /* Create MDT-object for dangling name entry. */
164 LPF_CREATE_MDTOBJ = 0x0080,
166 /* Do not return until the LFSCK not running. */
169 /* Delay to create OST-object for dangling LOV EA. */
170 LPF_DELAY_CREATE_OSTOBJ = 0x0200,
174 /* For MDT and OST internal OSD consistency check/repair. */
175 LFSCK_TYPE_SCRUB = 0x0000,
177 /* For MDT-OST (layout, object) consistency check/repair. */
178 LFSCK_TYPE_LAYOUT = 0x0001,
180 /* For MDT (FID-in-dirent, linkEA) consistency check/repair. */
181 LFSCK_TYPE_NAMESPACE = 0x0004,
182 LFSCK_TYPES_SUPPORTED = (LFSCK_TYPE_SCRUB | LFSCK_TYPE_LAYOUT |
183 LFSCK_TYPE_NAMESPACE),
184 LFSCK_TYPES_DEF = LFSCK_TYPES_SUPPORTED,
185 LFSCK_TYPES_ALL = ((__u16)(~0))
188 #define LFSCK_VERSION_V1 1
189 #define LFSCK_VERSION_V2 2
191 #define LFSCK_SPEED_NO_LIMIT 0
192 #define LFSCK_SPEED_LIMIT_DEF LFSCK_SPEED_NO_LIMIT
193 #define LFSCK_ASYNC_WIN_DEFAULT 1024
194 #define LFSCK_ASYNC_WIN_MAX ((__u16)(~0))
195 #define LFSCK_TYPE_BITS 16
197 enum lfsck_start_valid {
198 LSV_SPEED_LIMIT = 0x00000001,
199 LSV_ERROR_HANDLE = 0x00000002,
200 LSV_DRYRUN = 0x00000004,
201 LSV_ASYNC_WINDOWS = 0x00000008,
202 LSV_CREATE_OSTOBJ = 0x00000010,
203 LSV_CREATE_MDTOBJ = 0x00000020,
204 LSV_DELAY_CREATE_OSTOBJ = 0x00000040,
207 /* Arguments for starting lfsck. */
209 /* Which arguments are valid, see 'enum lfsck_start_valid'. */
212 /* How many items can be scanned at most per second. */
213 __u32 ls_speed_limit;
215 /* For compatibility between user space tools and kernel service. */
218 /* Which LFSCK components to be (have been) started. */
221 /* Flags for the LFSCK, see 'enum lfsck_param_flags'. */
224 /* The windows size for async requests pipeline. */
225 __u16 ls_async_windows;
231 __u16 ls_padding_1; /* For 64-bits aligned. */
238 __u32 lu_mdts_count[LFSCK_TYPE_BITS][LS_MAX + 1];
239 __u32 lu_osts_count[LFSCK_TYPE_BITS][LS_MAX + 1];
240 __u64 lu_repaired[LFSCK_TYPE_BITS];
243 #endif /* _LUSTRE_LFSCK_USER_H */