Whamcloud - gitweb
b=16776
[fs/lustre-release.git] / lustre / include / lustre_disk.h
1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2  * vim:expandtab:shiftwidth=8:tabstop=8:
3  *
4  * GPL HEADER START
5  *
6  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
7  *
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License version 2 only,
10  * as published by the Free Software Foundation.
11  *
12  * This program is distributed in the hope that it will be useful, but
13  * WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * General Public License version 2 for more details (a copy is included
16  * in the LICENSE file that accompanied this code).
17  *
18  * You should have received a copy of the GNU General Public License
19  * version 2 along with this program; If not, see
20  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
21  *
22  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
23  * CA 95054 USA or visit www.sun.com if you need additional information or
24  * have any questions.
25  *
26  * GPL HEADER END
27  */
28 /*
29  * Copyright  2008 Sun Microsystems, Inc. All rights reserved
30  * Use is subject to license terms.
31  */
32 /*
33  * This file is part of Lustre, http://www.lustre.org/
34  * Lustre is a trademark of Sun Microsystems, Inc.
35  *
36  * lustre/include/lustre_disk.h
37  *
38  * Lustre disk format definitions.
39  *
40  * Author: Nathan Rutman <nathan@clusterfs.com>
41  */
42
43 #ifndef _LUSTRE_DISK_H
44 #define _LUSTRE_DISK_H
45
46 #include <libcfs/libcfs.h>
47 #include <lnet/types.h>
48
49 /****************** on-disk files *********************/
50
51 #define MDT_LOGS_DIR      "LOGS"  /* COMPAT_146 */
52 #define MOUNT_CONFIGS_DIR "CONFIGS"
53 /* Persistent mount data are stored on the disk in this file. */
54 #define MOUNT_DATA_FILE    MOUNT_CONFIGS_DIR"/mountdata"
55 #define LAST_RCVD         "last_received"
56 #define LOV_OBJID         "lov_objid"
57 #define HEALTH_CHECK      "health_check"
58 #define CAPA_KEYS         "capa_keys"
59
60 /****************** persistent mount data *********************/
61
62 #define LDD_F_SV_TYPE_MDT   0x0001
63 #define LDD_F_SV_TYPE_OST   0x0002
64 #define LDD_F_SV_TYPE_MGS   0x0004
65 #define LDD_F_NEED_INDEX    0x0010 /* need an index assignment */
66 #define LDD_F_VIRGIN        0x0020 /* never registered */
67 #define LDD_F_UPDATE        0x0040 /* update the config logs for this server*/
68 #define LDD_F_REWRITE_LDD   0x0080 /* rewrite the LDD */
69 #define LDD_F_WRITECONF     0x0100 /* regenerate all logs for this fs */
70 #define LDD_F_UPGRADE14     0x0200 /* COMPAT_14 */
71 #define LDD_F_PARAM         0x0400 /* process as lctl conf_param */
72
73 enum ldd_mount_type {
74         LDD_MT_EXT3 = 0,
75         LDD_MT_LDISKFS,
76         LDD_MT_SMFS,
77         LDD_MT_REISERFS,
78         LDD_MT_LDISKFS2,
79         LDD_MT_LAST
80 };
81
82 static inline char *mt_str(enum ldd_mount_type mt)
83 {
84         static char *mount_type_string[] = {
85                 "ext3",
86                 "ldiskfs",
87                 "smfs",
88                 "reiserfs",
89                 "ldiskfs2"
90         };
91         return mount_type_string[mt];
92 }
93
94 #define LDD_INCOMPAT_SUPP 0
95 #define LDD_ROCOMPAT_SUPP 0
96
97 #define LDD_MAGIC 0x1dd00001
98
99 /* On-disk configuration file. In host-endian order. */
100 struct lustre_disk_data {
101         __u32      ldd_magic;
102         __u32      ldd_feature_compat;  /* compatible feature flags */
103         __u32      ldd_feature_rocompat;/* read-only compatible feature flags */
104         __u32      ldd_feature_incompat;/* incompatible feature flags */
105
106         __u32      ldd_config_ver;      /* config rewrite count - not used */
107         __u32      ldd_flags;           /* LDD_SV_TYPE */
108         __u32      ldd_svindex;         /* server index (0001), must match 
109                                            svname */
110         __u32      ldd_mount_type;      /* target fs type LDD_MT_* */
111         char       ldd_fsname[64];      /* filesystem this server is part of */
112         char       ldd_svname[64];      /* this server's name (lustre-mdt0001)*/
113         __u8       ldd_uuid[40];        /* server UUID (COMPAT_146) */
114
115 /*200*/ char       ldd_userdata[1024 - 200]; /* arbitrary user string */
116 /*1024*/__u8       ldd_padding[4096 - 1024];
117 /*4096*/char       ldd_mount_opts[4096]; /* target fs mount opts */
118 /*8192*/char       ldd_params[4096];     /* key=value pairs */
119 };
120
121 #define IS_MDT(data)   ((data)->ldd_flags & LDD_F_SV_TYPE_MDT)
122 #define IS_OST(data)   ((data)->ldd_flags & LDD_F_SV_TYPE_OST)
123 #define IS_MGS(data)  ((data)->ldd_flags & LDD_F_SV_TYPE_MGS)
124 #define MT_STR(data)   mt_str((data)->ldd_mount_type)
125
126 /* Make the mdt/ost server obd name based on the filesystem name */
127 static inline int server_make_name(__u32 flags, __u16 index, char *fs,
128                                    char *name)
129 {
130         if (flags & (LDD_F_SV_TYPE_MDT | LDD_F_SV_TYPE_OST)) {
131                 sprintf(name, "%.8s-%s%04x", fs,
132                         (flags & LDD_F_SV_TYPE_MDT) ? "MDT" : "OST",
133                         index);
134         } else if (flags & LDD_F_SV_TYPE_MGS) {
135                 sprintf(name, "MGS");
136         } else {
137                 CERROR("unknown server type %#x\n", flags);
138                 return 1;
139         }
140         return 0;
141 }
142
143 /* Get the index from the obd name */
144 int server_name2index(char *svname, __u32 *idx, char **endptr);
145
146
147 /****************** mount command *********************/
148
149 /* The lmd is only used internally by Lustre; mount simply passes 
150    everything as string options */
151
152 #define LMD_MAGIC    0xbdacbd03
153
154 /* gleaned from the mount command - no persistent info here */
155 struct lustre_mount_data {
156         __u32      lmd_magic;
157         __u32      lmd_flags;         /* lustre mount flags */
158         int        lmd_mgs_failnodes; /* mgs failover node count */
159         int        lmd_exclude_count;
160         char      *lmd_dev;           /* device name */
161         char      *lmd_profile;       /* client only */
162         char      *lmd_opts;          /* lustre mount options (as opposed to 
163                                          _device_ mount options) */
164         __u32     *lmd_exclude;       /* array of OSTs to ignore */
165 };
166
167 #define LMD_FLG_SERVER       0x0001  /* Mounting a server */
168 #define LMD_FLG_CLIENT       0x0002  /* Mounting a client */
169 #define LMD_FLG_ABORT_RECOV  0x0008  /* Abort recovery */
170 #define LMD_FLG_NOSVC        0x0010  /* Only start MGS/MGC for servers, 
171                                         no other services */
172 #define LMD_FLG_NOMGS        0x0020  /* Only start target for servers, reusing
173                                         existing MGS services */
174
175 #define lmd_is_client(x) ((x)->lmd_flags & LMD_FLG_CLIENT) 
176
177
178 /****************** last_rcvd file *********************/
179
180 #define LR_SERVER_SIZE   512
181 #define LR_CLIENT_START 8192
182 #define LR_CLIENT_SIZE   128
183 #if LR_CLIENT_START < LR_SERVER_SIZE
184 #error "Can't have LR_CLIENT_START < LR_SERVER_SIZE"
185 #endif
186
187 /*
188  * This limit is arbitrary (131072 clients on x86), but it is convenient to use
189  * 2^n * CFS_PAGE_SIZE * 8 for the number of bits that fit an order-n allocation.
190  * If we need more than 131072 clients (order-2 allocation on x86) then this
191  * should become an array of single-page pointers that are allocated on demand.
192  */
193 #if (128 * 1024UL) > (CFS_PAGE_SIZE * 8)
194 #define LR_MAX_CLIENTS (128 * 1024UL)
195 #else
196 #define LR_MAX_CLIENTS (CFS_PAGE_SIZE * 8)
197 #endif
198
199 /* COMPAT_146 */
200 #define OBD_COMPAT_OST          0x00000002 /* this is an OST (temporary) */
201 #define OBD_COMPAT_MDT          0x00000004 /* this is an MDT (temporary) */
202 /* end COMPAT_146 */
203
204 #define OBD_ROCOMPAT_LOVOBJID   0x00000001 /* MDS handles LOV_OBJID file */
205
206 #define OBD_INCOMPAT_GROUPS     0x00000001 /* OST handles group subdirs */
207 #define OBD_INCOMPAT_OST        0x00000002 /* this is an OST */
208 #define OBD_INCOMPAT_MDT        0x00000004 /* this is an MDT */
209 #define OBD_INCOMPAT_COMMON_LR  0x00000008 /* common last_rvcd format */
210
211
212 /* Data stored per server at the head of the last_rcvd file.  In le32 order.
213    This should be common to filter_internal.h, lustre_mds.h */
214 struct lr_server_data {
215         __u8  lsd_uuid[40];        /* server UUID */
216         __u64 lsd_last_transno;    /* last completed transaction ID */
217         __u64 lsd_compat14;        /* reserved - compat with old last_rcvd */
218         __u64 lsd_mount_count;     /* incarnation number */
219         __u32 lsd_feature_compat;  /* compatible feature flags */
220         __u32 lsd_feature_rocompat;/* read-only compatible feature flags */
221         __u32 lsd_feature_incompat;/* incompatible feature flags */
222         __u32 lsd_server_size;     /* size of server data area */
223         __u32 lsd_client_start;    /* start of per-client data area */
224         __u16 lsd_client_size;     /* size of per-client data area */
225         __u16 lsd_subdir_count;    /* number of subdirectories for objects */
226         __u64 lsd_catalog_oid;     /* recovery catalog object id */
227         __u32 lsd_catalog_ogen;    /* recovery catalog inode generation */
228         __u8  lsd_peeruuid[40];    /* UUID of MDS associated with this OST */
229         __u32 lsd_ost_index;       /* index number of OST in LOV */
230         __u32 lsd_mdt_index;       /* index number of MDT in LMV */
231         __u8  lsd_padding[LR_SERVER_SIZE - 148];
232 };
233
234 /* Data stored per client in the last_rcvd file.  In le32 order. */
235 struct lsd_client_data {
236         __u8  lcd_uuid[40];      /* client UUID */
237         __u64 lcd_last_transno; /* last completed transaction ID */
238         __u64 lcd_last_xid;     /* xid for the last transaction */
239         __u32 lcd_last_result;  /* result from last RPC */
240         __u32 lcd_last_data;    /* per-op data (disposition for open &c.) */
241         /* for MDS_CLOSE requests */
242         __u64 lcd_last_close_transno; /* last completed transaction ID */
243         __u64 lcd_last_close_xid;     /* xid for the last transaction */
244         __u32 lcd_last_close_result;  /* result from last RPC */
245         __u32 lcd_last_close_data;    /* per-op data */
246         __u8  lcd_padding[LR_CLIENT_SIZE - 88];
247 };
248
249
250 #ifdef __KERNEL__
251 /****************** superblock additional info *********************/
252 struct ll_sb_info;
253
254 struct lustre_sb_info {
255         int                       lsi_flags;
256         struct obd_device        *lsi_mgc;     /* mgc obd */
257         struct lustre_mount_data *lsi_lmd;     /* mount command info */
258         struct lustre_disk_data  *lsi_ldd;     /* mount info on-disk */
259         struct ll_sb_info        *lsi_llsbi;   /* add'l client sbi info */
260         struct vfsmount          *lsi_srv_mnt; /* the one server mount */
261         atomic_t                  lsi_mounts;  /* references to the srv_mnt */
262 };
263
264 #define LSI_SERVER                       0x00000001
265 #define LSI_UMOUNT_FORCE                 0x00000010
266 #define LSI_UMOUNT_FAILOVER              0x00000020
267
268 #define     s2lsi(sb)        ((struct lustre_sb_info *)((sb)->s_fs_info))
269 #define     s2lsi_nocast(sb) ((sb)->s_fs_info)
270
271 #define     get_profile_name(sb)   (s2lsi(sb)->lsi_lmd->lmd_profile)
272
273 #endif /* __KERNEL__ */
274
275 /****************** mount lookup info *********************/
276
277 struct lustre_mount_info {
278         char               *lmi_name;
279         struct super_block *lmi_sb;
280         struct vfsmount    *lmi_mnt;
281         struct list_head    lmi_list_chain;
282 };
283
284 /****************** prototypes *********************/
285
286 #ifdef __KERNEL__
287 #include <obd_class.h>
288
289 /* obd_mount.c */
290 void lustre_register_client_fill_super(int (*cfs)(struct super_block *sb));
291 void lustre_register_kill_super_cb(void (*cfs)(struct super_block *sb));
292
293
294 int lustre_common_put_super(struct super_block *sb);
295 int lustre_process_log(struct super_block *sb, char *logname, 
296                      struct config_llog_instance *cfg);
297 int lustre_end_log(struct super_block *sb, char *logname, 
298                        struct config_llog_instance *cfg);
299 struct lustre_mount_info *server_get_mount(const char *name);
300 struct lustre_mount_info *server_get_mount_2(const char *name);
301 int server_put_mount(const char *name, struct vfsmount *mnt);
302 int server_put_mount_2(const char *name, struct vfsmount *mnt);
303 int server_register_target(struct super_block *sb);
304 struct mgs_target_info;
305 int server_mti_print(char *title, struct mgs_target_info *mti);
306
307 /* mgc_request.c */
308 int mgc_fsname2resid(char *fsname, struct ldlm_res_id *res_id);
309
310 #endif
311
312 #endif // _LUSTRE_DISK_H