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, 2014, 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
35 # include <lustre/lustre_user.h>
51 * -----------------------------------------------------------------
55 * LS_SCANNING_PHASE2 LS_FAILED LS_STOPPED LS_PAUSED LS_CRASHED LS_PARTIAL
59 * | (lfsck:restart) |: |: |: |: |:
61 * -----------------------------------------------------------------
67 /* The lfsck file is new created, for new MDT, upgrading from old disk,
68 * or re-creating the lfsck file manually. */
71 /* The first-step system scanning. The checked items during the phase1
72 * scanning depends on the LFSCK type. */
73 LS_SCANNING_PHASE1 = 1,
75 /* The second-step system scanning. The checked items during the phase2
76 * scanning depends on the LFSCK type. */
77 LS_SCANNING_PHASE2 = 2,
79 /* The LFSCK processing has completed for all objects. */
82 /* The LFSCK exited automatically for failure, will not auto restart. */
85 /* The LFSCK is stopped manually, will not auto restart. */
88 /* LFSCK is paused automatically when umount,
89 * will be restarted automatically when remount. */
92 /* System crashed during the LFSCK,
93 * will be restarted automatically after recovery. */
96 /* Some OST/MDT failed during the LFSCK, or not join the LFSCK. */
99 /* The LFSCK is failed because its controller is failed. */
102 /* The LFSCK is stopped because its controller is stopped. */
105 /* The LFSCK is paused because its controller is paused. */
111 static inline const char *lfsck_status2name(int status)
113 static const char * const lfsck_status_names[] = {
115 [LS_SCANNING_PHASE1] = "scanning-phase1",
116 [LS_SCANNING_PHASE2] = "scanning-phase2",
117 [LS_COMPLETED] = "completed",
118 [LS_FAILED] = "failed",
119 [LS_STOPPED] = "stopped",
120 [LS_PAUSED] = "paused",
121 [LS_CRASHED] = "crashed",
122 [LS_PARTIAL] = "partial",
123 [LS_CO_FAILED] = "co-failed",
124 [LS_CO_STOPPED] = "co-stopped",
125 [LS_CO_PAUSED] = "co-paused"
128 if (status < 0 || status >= LS_MAX)
131 return lfsck_status_names[status];
134 enum lfsck_param_flags {
135 /* Reset LFSCK iterator position to the device beginning. */
138 /* Exit when fail. */
139 LPF_FAILOUT = 0x0002,
141 /* Dryrun mode, only check without modification */
144 /* LFSCK runs on all targets. */
145 LPF_ALL_TGT = 0x0008,
147 /* Broadcast the command to other MDTs. Only valid on the sponsor MDT */
148 LPF_BROADCAST = 0x0010,
150 /* Handle orphan OST-objects. */
151 LPF_OST_ORPHAN = 0x0020,
153 /* Create OST-object for dangling LOV EA. */
154 LPF_CREATE_OSTOBJ = 0x0040,
156 /* Create MDT-object for dangling name entry. */
157 LPF_CREATE_MDTOBJ = 0x0080,
159 /* Do not return until the LFSCK not running. */
164 /* For MDT and OST internal OSD consistency check/repair. */
165 LFSCK_TYPE_SCRUB = 0x0000,
167 /* For MDT-OST (layout, object) consistency check/repair. */
168 LFSCK_TYPE_LAYOUT = 0x0001,
170 /* For MDT (FID-in-dirent, linkEA) consistency check/repair. */
171 LFSCK_TYPE_NAMESPACE = 0x0004,
172 LFSCK_TYPES_SUPPORTED = (LFSCK_TYPE_SCRUB | LFSCK_TYPE_LAYOUT |
173 LFSCK_TYPE_NAMESPACE),
174 LFSCK_TYPES_DEF = LFSCK_TYPES_SUPPORTED,
175 LFSCK_TYPES_ALL = ((__u16)(~0))
178 #define LFSCK_VERSION_V1 1
179 #define LFSCK_VERSION_V2 2
181 #define LFSCK_SPEED_NO_LIMIT 0
182 #define LFSCK_SPEED_LIMIT_DEF LFSCK_SPEED_NO_LIMIT
183 #define LFSCK_ASYNC_WIN_DEFAULT 1024
184 #define LFSCK_ASYNC_WIN_MAX ((__u16)(~0))
185 #define LFSCK_TYPE_BITS 16
187 enum lfsck_start_valid {
188 LSV_SPEED_LIMIT = 0x00000001,
189 LSV_ERROR_HANDLE = 0x00000002,
190 LSV_DRYRUN = 0x00000004,
191 LSV_ASYNC_WINDOWS = 0x00000008,
192 LSV_CREATE_OSTOBJ = 0x00000010,
193 LSV_CREATE_MDTOBJ = 0x00000020,
196 /* Arguments for starting lfsck. */
198 /* Which arguments are valid, see 'enum lfsck_start_valid'. */
201 /* How many items can be scanned at most per second. */
202 __u32 ls_speed_limit;
204 /* For compatibility between user space tools and kernel service. */
207 /* Which LFSCK components to be (have been) started. */
210 /* Flags for the LFSCK, see 'enum lfsck_param_flags'. */
213 /* The windows size for async requests pipeline. */
214 __u16 ls_async_windows;
220 __u16 ls_padding_1; /* For 64-bits aligned. */
227 __u32 lu_mdts_count[LFSCK_TYPE_BITS][LS_MAX + 1];
228 __u32 lu_osts_count[LFSCK_TYPE_BITS][LS_MAX + 1];
229 __u64 lu_repaired[LFSCK_TYPE_BITS];
232 #endif /* _LUSTRE_LFSCK_USER_H */