Whamcloud - gitweb
LU-9341 utils: fix lfs find for composite files
[fs/lustre-release.git] / lustre / include / lustre_disk.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, but
11  * WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * General Public License version 2 for more details (a copy is included
14  * in the LICENSE file that accompanied this code).
15  *
16  * You should have received a copy of the GNU General Public License
17  * version 2 along with this program; If not, see
18  * http://www.gnu.org/licenses/gpl-2.0.html
19  *
20  * GPL HEADER END
21  */
22 /*
23  * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
24  * Use is subject to license terms.
25  *
26  * Copyright (c) 2011, 2017, Intel Corporation.
27  */
28 /*
29  * This file is part of Lustre, http://www.lustre.org/
30  * Lustre is a trademark of Sun Microsystems, Inc.
31  *
32  * lustre/include/lustre_disk.h
33  *
34  * Lustre disk format definitions.
35  *
36  * Author: Nathan Rutman <nathan@clusterfs.com>
37  */
38
39 #ifndef _LUSTRE_DISK_H
40 #define _LUSTRE_DISK_H
41
42 /** \defgroup disk disk
43  *
44  * @{
45  */
46 #include <asm/byteorder.h>
47 #include <linux/types.h>
48 #include <linux/backing-dev.h>
49 #include <linux/list.h>
50 #include <libcfs/libcfs.h>
51 #include <uapi/linux/lustre/lustre_disk.h>
52 #include <uapi/linux/lustre/lustre_idl.h>
53
54 #define IS_MDT(data)            ((data)->lsi_flags & LDD_F_SV_TYPE_MDT)
55 #define IS_OST(data)            ((data)->lsi_flags & LDD_F_SV_TYPE_OST)
56 #define IS_MGS(data)            ((data)->lsi_flags & LDD_F_SV_TYPE_MGS)
57 #define IS_SERVER(data)         ((data)->lsi_flags & (LDD_F_SV_TYPE_MGS | \
58                                                       LDD_F_SV_TYPE_MDT | \
59                                                       LDD_F_SV_TYPE_OST))
60 #define MT_STR(data)            mt_str((data)->ldd_mount_type)
61
62 /****************** mount command *********************/
63
64 /* The lmd is only used internally by Lustre; mount simply passes
65  * everything as string options
66  */
67 #define LMD_MAGIC               0xbdacbd03
68 #define LMD_PARAMS_MAXLEN       4096
69
70 /* gleaned from the mount command - no persistent info here */
71 struct lustre_mount_data {
72         u32     lmd_magic;
73         u32     lmd_flags;      /* lustre mount flags */
74         int     lmd_mgs_failnodes; /* mgs failover node count */
75         int     lmd_exclude_count;
76         int     lmd_recovery_time_soft;
77         int     lmd_recovery_time_hard;
78         char   *lmd_dev;        /* device name */
79         char   *lmd_profile;    /* client only */
80         char   *lmd_fileset;    /* mount fileset */
81         char   *lmd_mgssec;     /* sptlrpc flavor to mgs */
82         char   *lmd_opts;       /* lustre mount options (as opposed to
83                                  * device_ mount options) */
84         char   *lmd_params;     /* lustre params */
85         u32    *lmd_exclude;    /* array of OSTs to ignore */
86         char   *lmd_mgs;        /* MGS nid */
87         char   *lmd_osd_type;   /* OSD type */
88         char   *lmd_nidnet;     /* network to restrict this client to */
89 };
90
91 #define LMD_FLG_SERVER          0x0001  /* Mounting a server */
92 #define LMD_FLG_CLIENT          0x0002  /* Mounting a client */
93 #define LMD_FLG_SKIP_LFSCK      0x0004  /* NOT auto resume LFSCK when mount */
94 #define LMD_FLG_ABORT_RECOV     0x0008  /* Abort recovery */
95 #define LMD_FLG_NOSVC           0x0010  /* Only start MGS/MGC for servers,
96                                            no other services */
97 #define LMD_FLG_NOMGS           0x0020  /* Only start target for servers, reusing
98                                            existing MGS services */
99 #define LMD_FLG_WRITECONF       0x0040  /* Rewrite config log */
100 #define LMD_FLG_NOIR            0x0080  /* NO imperative recovery */
101 #define LMD_FLG_NOSCRUB         0x0100  /* Do not trigger scrub automatically */
102 #define LMD_FLG_MGS             0x0200  /* Also start MGS along with server */
103 #define LMD_FLG_IAM             0x0400  /* IAM dir */
104 #define LMD_FLG_NO_PRIMNODE     0x0800  /* all nodes are service nodes */
105 #define LMD_FLG_VIRGIN          0x1000  /* the service registers first time */
106 #define LMD_FLG_UPDATE          0x2000  /* update parameters */
107 #define LMD_FLG_HSM             0x4000  /* Start coordinator */
108 #define LMD_FLG_DEV_RDONLY      0x8000  /* discard modification quitely */
109
110 #define lmd_is_client(x) ((x)->lmd_flags & LMD_FLG_CLIENT)
111
112 /****************** superblock additional info *********************/
113 struct ll_sb_info;
114 struct kobject;
115
116 struct lustre_sb_info {
117         int                       lsi_flags;
118         struct obd_device        *lsi_mgc;     /* mgc obd */
119         struct lustre_mount_data *lsi_lmd;     /* mount command info */
120         struct ll_sb_info        *lsi_llsbi;   /* add'l client sbi info */
121         struct dt_device         *lsi_dt_dev;  /* dt device to access disk fs*/
122         atomic_t                  lsi_mounts;  /* references to the srv_mnt */
123         struct kobject           *lsi_kobj;
124         char                      lsi_svname[MTI_NAME_MAXLEN];
125         /* lsi_osd_obdname format = 'lsi->ls_svname'-osd */
126         char                      lsi_osd_obdname[MTI_NAME_MAXLEN + 4];
127         /* lsi_osd_uuid format = 'lsi->ls_osd_obdname'_UUID */
128         char                      lsi_osd_uuid[MTI_NAME_MAXLEN + 9];
129         struct obd_export        *lsi_osd_exp;
130         char                      lsi_osd_type[16];
131         char                      lsi_fstype[16];
132         struct backing_dev_info   lsi_bdi;     /* each client mountpoint needs
133                                                   own backing_dev_info */
134         struct list_head          lsi_lwp_list;
135         spinlock_t                lsi_lwp_lock;
136         unsigned long             lsi_lwp_started:1;
137 };
138
139 #define LSI_UMOUNT_FAILOVER              0x00200000
140
141 #define     s2lsi(sb)        ((struct lustre_sb_info *)((sb)->s_fs_info))
142 #define     s2lsi_nocast(sb) ((sb)->s_fs_info)
143
144 #define     get_profile_name(sb)   (s2lsi(sb)->lsi_lmd->lmd_profile)
145 #define     get_mount_fileset(sb)  (s2lsi(sb)->lsi_lmd->lmd_fileset)
146
147 # ifdef HAVE_SERVER_SUPPORT
148 /* opc for target register */
149 #define LDD_F_OPC_REG   0x10000000
150 #define LDD_F_OPC_UNREG 0x20000000
151 #define LDD_F_OPC_READY 0x40000000
152 #define LDD_F_OPC_MASK  0xf0000000
153
154 #define LDD_F_MASK      0xFFFF
155
156 /*
157  * This limit is arbitrary (131072 clients on x86), but it is convenient to use
158  * 2^n * PAGE_SIZE * 8 for the number of bits that fit an order-n allocation.
159  * If we need more than 131072 clients (order-2 allocation on x86) then this
160  * should become an array of single-page pointers that are allocated on demand.
161  */
162 #if (128 * 1024UL) > (PAGE_SIZE * 8)
163 #define LR_MAX_CLIENTS (128 * 1024UL)
164 #else
165 #define LR_MAX_CLIENTS (PAGE_SIZE * 8)
166 #endif
167
168 /** COMPAT_146: this is an OST (temporary) */
169 #define OBD_COMPAT_OST          0x00000002
170 /** COMPAT_146: this is an MDT (temporary) */
171 #define OBD_COMPAT_MDT          0x00000004
172 /** 2.0 server, interop flag to show server version is changed */
173 #define OBD_COMPAT_20           0x00000008
174
175 /** MDS handles LOV_OBJID file */
176 #define OBD_ROCOMPAT_LOVOBJID           0x00000001
177 /** store OST index in the IDIF */
178 #define OBD_ROCOMPAT_IDX_IN_IDIF        0x00000002
179
180 /** OST handles group subdirs */
181 #define OBD_INCOMPAT_GROUPS     0x00000001
182 /** this is an OST */
183 #define OBD_INCOMPAT_OST        0x00000002
184 /** this is an MDT */
185 #define OBD_INCOMPAT_MDT        0x00000004
186 /** common last_rvcd format */
187 #define OBD_INCOMPAT_COMMON_LR  0x00000008
188 /** FID is enabled */
189 #define OBD_INCOMPAT_FID        0x00000010
190 /** Size-on-MDS is enabled */
191 #define OBD_INCOMPAT_SOM        0x00000020
192 /** filesystem using iam format to store directory entries */
193 #define OBD_INCOMPAT_IAM_DIR    0x00000040
194 /** LMA attribute contains per-inode incompatible flags */
195 #define OBD_INCOMPAT_LMA        0x00000080
196 /** lmm_stripe_count has been shrunk from u32 to u16 and the remaining 16
197  * bits are now used to store a generation. Once we start changing the layout
198  * and bumping the generation, old versions expecting a 32-bit lmm_stripe_count
199  * will be confused by interpreting stripe_count | gen << 16 as the actual
200  * stripe count */
201 #define OBD_INCOMPAT_LMM_VER    0x00000100
202 /** multiple OI files for MDT */
203 #define OBD_INCOMPAT_MULTI_OI   0x00000200
204 /** multiple RPCs in flight */
205 #define OBD_INCOMPAT_MULTI_RPCS 0x00000400
206
207 /* last_rcvd handling */
208 static inline void lsd_le_to_cpu(struct lr_server_data *buf,
209                                  struct lr_server_data *lsd)
210 {
211         int i;
212
213         memcpy(lsd->lsd_uuid, buf->lsd_uuid, sizeof(lsd->lsd_uuid));
214         lsd->lsd_last_transno = le64_to_cpu(buf->lsd_last_transno);
215         lsd->lsd_compat14 = le64_to_cpu(buf->lsd_compat14);
216         lsd->lsd_mount_count = le64_to_cpu(buf->lsd_mount_count);
217         lsd->lsd_feature_compat = le32_to_cpu(buf->lsd_feature_compat);
218         lsd->lsd_feature_rocompat = le32_to_cpu(buf->lsd_feature_rocompat);
219         lsd->lsd_feature_incompat = le32_to_cpu(buf->lsd_feature_incompat);
220         lsd->lsd_server_size = le32_to_cpu(buf->lsd_server_size);
221         lsd->lsd_client_start = le32_to_cpu(buf->lsd_client_start);
222         lsd->lsd_client_size = le16_to_cpu(buf->lsd_client_size);
223         lsd->lsd_subdir_count = le16_to_cpu(buf->lsd_subdir_count);
224         lsd->lsd_catalog_oid = le64_to_cpu(buf->lsd_catalog_oid);
225         lsd->lsd_catalog_ogen = le32_to_cpu(buf->lsd_catalog_ogen);
226         memcpy(lsd->lsd_peeruuid, buf->lsd_peeruuid, sizeof(lsd->lsd_peeruuid));
227         lsd->lsd_osd_index = le32_to_cpu(buf->lsd_osd_index);
228         lsd->lsd_padding1 = le32_to_cpu(buf->lsd_padding1);
229         lsd->lsd_start_epoch = le32_to_cpu(buf->lsd_start_epoch);
230         for (i = 0; i < LR_EXPIRE_INTERVALS; i++)
231                 lsd->lsd_trans_table[i] = le64_to_cpu(buf->lsd_trans_table[i]);
232         lsd->lsd_trans_table_time = le32_to_cpu(buf->lsd_trans_table_time);
233         lsd->lsd_expire_intervals = le32_to_cpu(buf->lsd_expire_intervals);
234 }
235
236 static inline void lsd_cpu_to_le(struct lr_server_data *lsd,
237                                  struct lr_server_data *buf)
238 {
239         int i;
240
241         memcpy(buf->lsd_uuid, lsd->lsd_uuid, sizeof(buf->lsd_uuid));
242         buf->lsd_last_transno = cpu_to_le64(lsd->lsd_last_transno);
243         buf->lsd_compat14 = cpu_to_le64(lsd->lsd_compat14);
244         buf->lsd_mount_count = cpu_to_le64(lsd->lsd_mount_count);
245         buf->lsd_feature_compat = cpu_to_le32(lsd->lsd_feature_compat);
246         buf->lsd_feature_rocompat = cpu_to_le32(lsd->lsd_feature_rocompat);
247         buf->lsd_feature_incompat = cpu_to_le32(lsd->lsd_feature_incompat);
248         buf->lsd_server_size = cpu_to_le32(lsd->lsd_server_size);
249         buf->lsd_client_start = cpu_to_le32(lsd->lsd_client_start);
250         buf->lsd_client_size = cpu_to_le16(lsd->lsd_client_size);
251         buf->lsd_subdir_count = cpu_to_le16(lsd->lsd_subdir_count);
252         buf->lsd_catalog_oid = cpu_to_le64(lsd->lsd_catalog_oid);
253         buf->lsd_catalog_ogen = cpu_to_le32(lsd->lsd_catalog_ogen);
254         memcpy(buf->lsd_peeruuid, lsd->lsd_peeruuid, sizeof(buf->lsd_peeruuid));
255         buf->lsd_osd_index = cpu_to_le32(lsd->lsd_osd_index);
256         buf->lsd_padding1 = cpu_to_le32(lsd->lsd_padding1);
257         buf->lsd_start_epoch = cpu_to_le32(lsd->lsd_start_epoch);
258         for (i = 0; i < LR_EXPIRE_INTERVALS; i++)
259                 buf->lsd_trans_table[i] = cpu_to_le64(lsd->lsd_trans_table[i]);
260         buf->lsd_trans_table_time = cpu_to_le32(lsd->lsd_trans_table_time);
261         buf->lsd_expire_intervals = cpu_to_le32(lsd->lsd_expire_intervals);
262 }
263
264 static inline void lcd_le_to_cpu(struct lsd_client_data *buf,
265                                  struct lsd_client_data *lcd)
266 {
267         memcpy(lcd->lcd_uuid, buf->lcd_uuid, sizeof (lcd->lcd_uuid));
268         lcd->lcd_last_transno = le64_to_cpu(buf->lcd_last_transno);
269         lcd->lcd_last_xid = le64_to_cpu(buf->lcd_last_xid);
270         lcd->lcd_last_result = le32_to_cpu(buf->lcd_last_result);
271         lcd->lcd_last_data = le32_to_cpu(buf->lcd_last_data);
272         lcd->lcd_last_close_transno = le64_to_cpu(buf->lcd_last_close_transno);
273         lcd->lcd_last_close_xid = le64_to_cpu(buf->lcd_last_close_xid);
274         lcd->lcd_last_close_result = le32_to_cpu(buf->lcd_last_close_result);
275         lcd->lcd_last_close_data = le32_to_cpu(buf->lcd_last_close_data);
276         lcd->lcd_pre_versions[0] = le64_to_cpu(buf->lcd_pre_versions[0]);
277         lcd->lcd_pre_versions[1] = le64_to_cpu(buf->lcd_pre_versions[1]);
278         lcd->lcd_pre_versions[2] = le64_to_cpu(buf->lcd_pre_versions[2]);
279         lcd->lcd_pre_versions[3] = le64_to_cpu(buf->lcd_pre_versions[3]);
280         lcd->lcd_last_epoch = le32_to_cpu(buf->lcd_last_epoch);
281         lcd->lcd_generation = le32_to_cpu(buf->lcd_generation);
282 }
283
284 static inline void lcd_cpu_to_le(struct lsd_client_data *lcd,
285                                  struct lsd_client_data *buf)
286 {
287         memcpy(buf->lcd_uuid, lcd->lcd_uuid, sizeof (lcd->lcd_uuid));
288         buf->lcd_last_transno = cpu_to_le64(lcd->lcd_last_transno);
289         buf->lcd_last_xid = cpu_to_le64(lcd->lcd_last_xid);
290         buf->lcd_last_result = cpu_to_le32(lcd->lcd_last_result);
291         buf->lcd_last_data = cpu_to_le32(lcd->lcd_last_data);
292         buf->lcd_last_close_transno = cpu_to_le64(lcd->lcd_last_close_transno);
293         buf->lcd_last_close_xid = cpu_to_le64(lcd->lcd_last_close_xid);
294         buf->lcd_last_close_result = cpu_to_le32(lcd->lcd_last_close_result);
295         buf->lcd_last_close_data = cpu_to_le32(lcd->lcd_last_close_data);
296         buf->lcd_pre_versions[0] = cpu_to_le64(lcd->lcd_pre_versions[0]);
297         buf->lcd_pre_versions[1] = cpu_to_le64(lcd->lcd_pre_versions[1]);
298         buf->lcd_pre_versions[2] = cpu_to_le64(lcd->lcd_pre_versions[2]);
299         buf->lcd_pre_versions[3] = cpu_to_le64(lcd->lcd_pre_versions[3]);
300         buf->lcd_last_epoch = cpu_to_le32(lcd->lcd_last_epoch);
301         buf->lcd_generation = cpu_to_le32(lcd->lcd_generation);
302 }
303
304 static inline u64 lcd_last_transno(struct lsd_client_data *lcd)
305 {
306         return (lcd->lcd_last_transno > lcd->lcd_last_close_transno ?
307                 lcd->lcd_last_transno : lcd->lcd_last_close_transno);
308 }
309
310 static inline u64 lcd_last_xid(struct lsd_client_data *lcd)
311 {
312         return (lcd->lcd_last_xid > lcd->lcd_last_close_xid ?
313                 lcd->lcd_last_xid : lcd->lcd_last_close_xid);
314 }
315
316 /****************** mount lookup info *********************/
317
318 struct lustre_mount_info {
319         char                    *lmi_name;
320         struct super_block      *lmi_sb;
321         struct list_head         lmi_list_chain;
322 };
323
324 /****************** prototypes *********************/
325
326 /* obd_mount_server.c */
327 int server_fill_super(struct super_block *sb);
328 struct lustre_mount_info *server_get_mount(const char *name);
329 int server_put_mount(const char *name, bool dereg_mnt);
330 struct mgs_target_info;
331 int server_mti_print(const char *title, struct mgs_target_info *mti);
332 void server_calc_timeout(struct lustre_sb_info *lsi, struct obd_device *obd);
333
334 /* obd_mount.c */
335 int server_name2svname(const char *label, char *svname, const char **endptr,
336                        size_t svsize);
337
338 int server_name_is_ost(const char *svname);
339 int target_name2index(const char *svname, u32 *idx, const char **endptr);
340
341 int lustre_put_lsi(struct super_block *sb);
342 int lustre_start_simple(char *obdname, char *type, char *uuid,
343                         char *s1, char *s2, char *s3, char *s4);
344 int lustre_start_mgc(struct super_block *sb);
345 #endif /* HAVE_SERVER_SUPPORT */
346 int server_name2fsname(const char *svname, char *fsname, const char **endptr);
347 void obdname2fsname(const char *tgt, char *fsname, size_t fslen);
348
349 void lustre_register_client_fill_super(int (*cfs)(struct super_block *sb,
350                                                   struct vfsmount *mnt));
351 void lustre_register_kill_super_cb(void (*cfs)(struct super_block *sb));
352 int lustre_common_put_super(struct super_block *sb);
353
354 int mgc_fsname2resid(char *fsname, struct ldlm_res_id *res_id, int type);
355 int mgc_logname2resid(char *fsname, struct ldlm_res_id *res_id, int type);
356
357 /** @} disk */
358
359 #endif /* _LUSTRE_DISK_H */