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>
38 * This is due to us being out of kernel and the way the OpenSFS branch
42 # include <uapi/linux/lustre/lustre_user.h>
44 # include <linux/lustre/lustre_user.h>
61 * -----------------------------------------------------------------
65 * LS_SCANNING_PHASE2 LS_FAILED LS_STOPPED LS_PAUSED LS_CRASHED LS_PARTIAL
69 * | (lfsck:restart) |: |: |: |: |:
71 * -----------------------------------------------------------------
77 /* The lfsck file is new created, for new MDT, upgrading from old disk,
78 * or re-creating the lfsck file manually. */
81 /* The first-step system scanning. The checked items during the phase1
82 * scanning depends on the LFSCK type. */
83 LS_SCANNING_PHASE1 = 1,
85 /* The second-step system scanning. The checked items during the phase2
86 * scanning depends on the LFSCK type. */
87 LS_SCANNING_PHASE2 = 2,
89 /* The LFSCK processing has completed for all objects. */
92 /* The LFSCK exited automatically for failure, will not auto restart. */
95 /* The LFSCK is stopped manually, will not auto restart. */
98 /* LFSCK is paused automatically when umount,
99 * will be restarted automatically when remount. */
102 /* System crashed during the LFSCK,
103 * will be restarted automatically after recovery. */
106 /* Some OST/MDT failed during the LFSCK, or not join the LFSCK. */
109 /* The LFSCK is failed because its controller is failed. */
112 /* The LFSCK is stopped because its controller is stopped. */
115 /* The LFSCK is paused because its controller is paused. */
121 static inline const char *lfsck_status2name(int status)
123 static const char * const lfsck_status_names[] = {
125 [LS_SCANNING_PHASE1] = "scanning-phase1",
126 [LS_SCANNING_PHASE2] = "scanning-phase2",
127 [LS_COMPLETED] = "completed",
128 [LS_FAILED] = "failed",
129 [LS_STOPPED] = "stopped",
130 [LS_PAUSED] = "paused",
131 [LS_CRASHED] = "crashed",
132 [LS_PARTIAL] = "partial",
133 [LS_CO_FAILED] = "co-failed",
134 [LS_CO_STOPPED] = "co-stopped",
135 [LS_CO_PAUSED] = "co-paused"
138 if (status < 0 || status >= LS_MAX)
141 return lfsck_status_names[status];
144 enum lfsck_param_flags {
145 /* Reset LFSCK iterator position to the device beginning. */
148 /* Exit when fail. */
149 LPF_FAILOUT = 0x0002,
151 /* Dryrun mode, only check without modification */
154 /* LFSCK runs on all targets. */
155 LPF_ALL_TGT = 0x0008,
157 /* Broadcast the command to other MDTs. Only valid on the sponsor MDT */
158 LPF_BROADCAST = 0x0010,
160 /* Handle orphan OST-objects. */
161 LPF_OST_ORPHAN = 0x0020,
163 /* Create OST-object for dangling LOV EA. */
164 LPF_CREATE_OSTOBJ = 0x0040,
166 /* Create MDT-object for dangling name entry. */
167 LPF_CREATE_MDTOBJ = 0x0080,
169 /* Do not return until the LFSCK not running. */
172 /* Delay to create OST-object for dangling LOV EA. */
173 LPF_DELAY_CREATE_OSTOBJ = 0x0200,
177 /* For MDT and OST internal OSD consistency check/repair. */
178 LFSCK_TYPE_SCRUB = 0x0000,
180 /* For MDT-OST (layout, object) consistency check/repair. */
181 LFSCK_TYPE_LAYOUT = 0x0001,
183 /* For MDT (FID-in-dirent, linkEA) consistency check/repair. */
184 LFSCK_TYPE_NAMESPACE = 0x0004,
185 LFSCK_TYPES_SUPPORTED = (LFSCK_TYPE_SCRUB | LFSCK_TYPE_LAYOUT |
186 LFSCK_TYPE_NAMESPACE),
187 LFSCK_TYPES_DEF = LFSCK_TYPES_SUPPORTED,
188 LFSCK_TYPES_ALL = ((__u16)(~0))
191 #define LFSCK_VERSION_V1 1
192 #define LFSCK_VERSION_V2 2
194 #define LFSCK_SPEED_NO_LIMIT 0
195 #define LFSCK_SPEED_LIMIT_DEF LFSCK_SPEED_NO_LIMIT
196 #define LFSCK_ASYNC_WIN_DEFAULT 1024
197 #define LFSCK_ASYNC_WIN_MAX ((__u16)(~0))
198 #define LFSCK_TYPE_BITS 16
200 enum lfsck_start_valid {
201 LSV_SPEED_LIMIT = 0x00000001,
202 LSV_ERROR_HANDLE = 0x00000002,
203 LSV_DRYRUN = 0x00000004,
204 LSV_ASYNC_WINDOWS = 0x00000008,
205 LSV_CREATE_OSTOBJ = 0x00000010,
206 LSV_CREATE_MDTOBJ = 0x00000020,
207 LSV_DELAY_CREATE_OSTOBJ = 0x00000040,
210 /* Arguments for starting lfsck. */
212 /* Which arguments are valid, see 'enum lfsck_start_valid'. */
215 /* How many items can be scanned at most per second. */
216 __u32 ls_speed_limit;
218 /* For compatibility between user space tools and kernel service. */
221 /* Which LFSCK components to be (have been) started. */
224 /* Flags for the LFSCK, see 'enum lfsck_param_flags'. */
227 /* The windows size for async requests pipeline. */
228 __u16 ls_async_windows;
234 __u16 ls_padding_1; /* For 64-bits aligned. */
241 __u32 lu_mdts_count[LFSCK_TYPE_BITS][LS_MAX + 1];
242 __u32 lu_osts_count[LFSCK_TYPE_BITS][LS_MAX + 1];
243 __u64 lu_repaired[LFSCK_TYPE_BITS];
246 #endif /* _LUSTRE_LFSCK_USER_H */