Whamcloud - gitweb
7c9751b58300bf2cf92e28ef88d3e911dbac5faf
[fs/lustre-release.git] / lustre / include / lustre / lustre_lfsck_user.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, 2013, Intel Corporation.
24  */
25 /*
26  * lustre/include/lustre/lustre_lfsck_user.h
27  *
28  * Lustre LFSCK userspace interfaces.
29  *
30  * Author: Fan, Yong <fan.yong@intel.com>
31  */
32
33 #ifndef _LUSTRE_LFSCK_USER_H
34 # define _LUSTRE_LFSCK_USER_H
35
36 enum lfsck_param_flags {
37         /* Reset LFSCK iterator position to the device beginning. */
38         LPF_RESET       = 0x0001,
39
40         /* Exit when fail. */
41         LPF_FAILOUT     = 0x0002,
42
43         /* Dryrun mode, only check without modification */
44         LPF_DRYRUN      = 0x0004,
45
46         /* LFSCK runs on all targets. */
47         LPF_ALL_TGT     = 0x0008,
48
49         /* Broadcast the command to other MDTs. Only valid on the sponsor MDT */
50         LPF_BROADCAST   = 0x0010,
51
52         /* Handle orphan objects. */
53         LPF_ORPHAN      = 0x0020,
54 };
55
56 enum lfsck_type {
57         /* For MDT-OST consistency check/repair. */
58         LT_LAYOUT       = 0x0001,
59
60         /* For MDT-MDT consistency check/repair. */
61         LT_DNE          = 0x0002,
62
63         /* For FID-in-dirent and linkEA consistency check/repair. */
64         LT_NAMESPACE    = 0x0004,
65 };
66
67 #define LFSCK_VERSION_V1        1
68 #define LFSCK_VERSION_V2        2
69
70 #define LFSCK_TYPES_ALL         ((__u16)(~0))
71 #define LFSCK_TYPES_DEF         ((__u16)0)
72 #define LFSCK_TYPES_SUPPORTED   (LT_LAYOUT | LT_NAMESPACE)
73
74 #define LFSCK_SPEED_NO_LIMIT    0
75 #define LFSCK_SPEED_LIMIT_DEF   LFSCK_SPEED_NO_LIMIT
76 #define LFSCK_ASYNC_WIN_DEFAULT 1024
77 #define LFSCK_ASYNC_WIN_MAX     ((__u16)(~0))
78
79 enum lfsck_start_valid {
80         LSV_SPEED_LIMIT         = 0x00000001,
81         LSV_ERROR_HANDLE        = 0x00000002,
82         LSV_DRYRUN              = 0x00000004,
83         LSV_ASYNC_WINDOWS       = 0x00000008,
84 };
85
86 /* Arguments for starting lfsck. */
87 struct lfsck_start {
88         /* Which arguments are valid, see 'enum lfsck_start_valid'. */
89         __u32   ls_valid;
90
91         /* How many items can be scanned at most per second. */
92         __u32   ls_speed_limit;
93
94         /* For compatibility between user space tools and kernel service. */
95         __u16   ls_version;
96
97         /* Which LFSCK components to be (have been) started. */
98         __u16   ls_active;
99
100         /* Flags for the LFSCK, see 'enum lfsck_param_flags'. */
101         __u16   ls_flags;
102
103         /* The windows size for async requests pipeline. */
104         __u16   ls_async_windows;
105 };
106
107 struct lfsck_stop {
108         __u32   ls_status;
109         __u16   ls_flags;
110         __u16   ls_padding_1; /* For 64-bits aligned. */
111         __u64   ls_padding_2;
112 };
113
114 #endif /* _LUSTRE_LFSCK_USER_H */