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 #define CONFIGS_FILE      "mountdata"
  54 /** Persistent mount data are stored on the disk in this file. */
  55 #define MOUNT_DATA_FILE    MOUNT_CONFIGS_DIR"/"CONFIGS_FILE
  56 #define LAST_RCVD         "last_rcvd"
  57 #define LOV_OBJID         "lov_objid"
  58 #define HEALTH_CHECK      "health_check"
  59 #define CAPA_KEYS         "capa_keys"
  60 #define CHANGELOG_CATALOG "changelog_catalog"
  61
  62
  63 /****************** persistent mount data *********************/
  64
  65 #define LDD_F_SV_TYPE_MDT   0x0001
  66 #define LDD_F_SV_TYPE_OST   0x0002
  67 #define LDD_F_SV_TYPE_MGS   0x0004
  68 #define LDD_F_SV_ALL        0x0008
  69 /** need an index assignment */
  70 #define LDD_F_NEED_INDEX    0x0010
  71 /** never registered */
  72 #define LDD_F_VIRGIN        0x0020
  73 /** update the config logs for this server*/
  74 #define LDD_F_UPDATE        0x0040
  75 /** rewrite the LDD */
  76 #define LDD_F_REWRITE_LDD   0x0080
  77 /** regenerate all logs for this fs */
  78 #define LDD_F_WRITECONF     0x0100
  79 /** COMPAT_14 */
  80 #define LDD_F_UPGRADE14     0x0200
  81 /** process as lctl conf_param */
  82 #define LDD_F_PARAM         0x0400
  83 /** backend fs make use of IAM directory format. */
  84 #define LDD_F_IAM_DIR       0x0800
  85
  86 enum ldd_mount_type {
  87         LDD_MT_EXT3 = 0,
  88         LDD_MT_LDISKFS,
  89         LDD_MT_SMFS,
  90         LDD_MT_REISERFS,
  91         LDD_MT_LDISKFS2,
  92         LDD_MT_LAST
  93 };
  94
  95 static inline char *mt_str(enum ldd_mount_type mt)
  96 {
  97         static char *mount_type_string[] = {
  98                 "ext3",
  99                 "ldiskfs",
 100                 "smfs",
 101                 "reiserfs",
 102                 "ldiskfs2"
 103         };
 104         return mount_type_string[mt];
 105 }
 106
 107 #define LDD_INCOMPAT_SUPP 0
 108 #define LDD_ROCOMPAT_SUPP 0
 109
 110 #define LDD_MAGIC 0x1dd00001
 111
 112 /* On-disk configuration file. In host-endian order. */
 113 struct lustre_disk_data {
 114         __u32      ldd_magic;
 115         __u32      ldd_feature_compat;  /* compatible feature flags */
 116         __u32      ldd_feature_rocompat;/* read-only compatible feature flags */
 117         __u32      ldd_feature_incompat;/* incompatible feature flags */
 118
 119         __u32      ldd_config_ver;      /* config rewrite count - not used */
 120         __u32      ldd_flags;           /* LDD_SV_TYPE */
 121         __u32      ldd_svindex;         /* server index (0001), must match
 122                                            svname */
 123         __u32      ldd_mount_type;      /* target fs type LDD_MT_* */
 124         char       ldd_fsname[64];      /* filesystem this server is part of */
 125         char       ldd_svname[64];      /* this server's name (lustre-mdt0001)*/
 126         __u8       ldd_uuid[40];        /* server UUID (COMPAT_146) */
 127
 128 /*200*/ char       ldd_userdata[1024 - 200]; /* arbitrary user string */
 129 /*1024*/__u8       ldd_padding[4096 - 1024];
 130 /*4096*/char       ldd_mount_opts[4096]; /* target fs mount opts */
 131 /*8192*/char       ldd_params[4096];     /* key=value pairs */
 132 };
 133
 134 #define IS_MDT(data)   ((data)->ldd_flags & LDD_F_SV_TYPE_MDT)
 135 #define IS_OST(data)   ((data)->ldd_flags & LDD_F_SV_TYPE_OST)
 136 #define IS_MGS(data)  ((data)->ldd_flags & LDD_F_SV_TYPE_MGS)
 137 #define MT_STR(data)   mt_str((data)->ldd_mount_type)
 138
 139 /* Make the mdt/ost server obd name based on the filesystem name */
 140 static inline int server_make_name(__u32 flags, __u16 index, char *fs,
 141                                    char *name)
 142 {
 143         if (flags & (LDD_F_SV_TYPE_MDT | LDD_F_SV_TYPE_OST)) {
 144                 if (!(flags & LDD_F_SV_ALL))
 145                         sprintf(name, "%.8s-%s%04x", fs,
 146                                 (flags & LDD_F_SV_TYPE_MDT) ? "MDT" : "OST",
 147                                 index);
 148         } else if (flags & LDD_F_SV_TYPE_MGS) {
 149                 sprintf(name, "MGS");
 150         } else {
 151                 CERROR("unknown server type %#x\n", flags);
 152                 return 1;
 153         }
 154         return 0;
 155 }
 156
 157 /* Get the index from the obd name */
 158 int server_name2index(char *svname, __u32 *idx, char **endptr);
 159
 160
 161 /****************** mount command *********************/
 162
 163 /* The lmd is only used internally by Lustre; mount simply passes
 164    everything as string options */
 165
 166 #define LMD_MAGIC    0xbdacbd03
 167
 168 /* gleaned from the mount command - no persistent info here */
 169 struct lustre_mount_data {
 170         __u32      lmd_magic;
 171         __u32      lmd_flags;         /* lustre mount flags */
 172         int        lmd_mgs_failnodes; /* mgs failover node count */
 173         int        lmd_exclude_count;
 174         char      *lmd_dev;           /* device name */
 175         char      *lmd_profile;       /* client only */
 176         char      *lmd_mgssec;        /* sptlrpc flavor to mgs */
 177         char      *lmd_opts;          /* lustre mount options (as opposed to
 178                                          _device_ mount options) */
 179         __u32     *lmd_exclude;       /* array of OSTs to ignore */
 180 };
 181
 182 #define LMD_FLG_SERVER       0x0001  /* Mounting a server */
 183 #define LMD_FLG_CLIENT       0x0002  /* Mounting a client */
 184 #define LMD_FLG_ABORT_RECOV  0x0008  /* Abort recovery */
 185 #define LMD_FLG_NOSVC        0x0010  /* Only start MGS/MGC for servers,
 186                                         no other services */
 187 #define LMD_FLG_NOMGS        0x0020  /* Only start target for servers, reusing
 188                                         existing MGS services */
 189
 190 #define lmd_is_client(x) ((x)->lmd_flags & LMD_FLG_CLIENT)
 191
 192
 193 /****************** last_rcvd file *********************/
 194
 195 #define LR_SERVER_SIZE   512
 196 #define LR_CLIENT_START 8192
 197 #define LR_CLIENT_SIZE   128
 198 #if LR_CLIENT_START < LR_SERVER_SIZE
 199 #error "Can't have LR_CLIENT_START < LR_SERVER_SIZE"
 200 #endif
 201
 202 /*
 203  * This limit is arbitrary (131072 clients on x86), but it is convenient to use
 204  * 2^n * CFS_PAGE_SIZE * 8 for the number of bits that fit an order-n allocation.
 205  * If we need more than 131072 clients (order-2 allocation on x86) then this
 206  * should become an array of single-page pointers that are allocated on demand.
 207  */
 208 #if (128 * 1024UL) > (CFS_PAGE_SIZE * 8)
 209 #define LR_MAX_CLIENTS (128 * 1024UL)
 210 #else
 211 #define LR_MAX_CLIENTS (CFS_PAGE_SIZE * 8)
 212 #endif
 213
 214 /** COMPAT_146: this is an OST (temporary) */
 215 #define OBD_COMPAT_OST          0x00000002
 216 /** COMPAT_146: this is an MDT (temporary) */
 217 #define OBD_COMPAT_MDT          0x00000004
 218
 219 /** MDS handles LOV_OBJID file */
 220 #define OBD_ROCOMPAT_LOVOBJID   0x00000001
 221
 222 /** OST handles group subdirs */
 223 #define OBD_INCOMPAT_GROUPS     0x00000001
 224 /** this is an OST */
 225 #define OBD_INCOMPAT_OST        0x00000002
 226 /** this is an MDT */
 227 #define OBD_INCOMPAT_MDT        0x00000004
 228 /** common last_rvcd format */
 229 #define OBD_INCOMPAT_COMMON_LR  0x00000008
 230 /** FID is enabled */
 231 #define OBD_INCOMPAT_FID        0x00000010
 232 /**
 233  * lustre disk using iam format to store directory entries
 234  */
 235 #define OBD_INCOMPAT_IAM_DIR    0x00000020
 236
 237
 238 /* Data stored per server at the head of the last_rcvd file.  In le32 order.
 239    This should be common to filter_internal.h, lustre_mds.h */
 240 struct lr_server_data {
 241         __u8  lsd_uuid[40];        /* server UUID */
 242         __u64 lsd_last_transno;    /* last completed transaction ID */
 243         __u64 lsd_compat14;        /* reserved - compat with old last_rcvd */
 244         __u64 lsd_mount_count;     /* incarnation number */
 245         __u32 lsd_feature_compat;  /* compatible feature flags */
 246         __u32 lsd_feature_rocompat;/* read-only compatible feature flags */
 247         __u32 lsd_feature_incompat;/* incompatible feature flags */
 248         __u32 lsd_server_size;     /* size of server data area */
 249         __u32 lsd_client_start;    /* start of per-client data area */
 250         __u16 lsd_client_size;     /* size of per-client data area */
 251         __u16 lsd_subdir_count;    /* number of subdirectories for objects */
 252         __u64 lsd_catalog_oid;     /* recovery catalog object id */
 253         __u32 lsd_catalog_ogen;    /* recovery catalog inode generation */
 254         __u8  lsd_peeruuid[40];    /* UUID of MDS associated with this OST */
 255         __u32 lsd_ost_index;       /* index number of OST in LOV */
 256         __u32 lsd_mdt_index;       /* index number of MDT in LMV */
 257         __u8  lsd_padding[LR_SERVER_SIZE - 148];
 258 };
 259
 260 /* Data stored per client in the last_rcvd file.  In le32 order. */
 261 struct lsd_client_data {
 262         __u8  lcd_uuid[40];      /* client UUID */
 263         __u64 lcd_last_transno; /* last completed transaction ID */
 264         __u64 lcd_last_xid;     /* xid for the last transaction */
 265         __u32 lcd_last_result;  /* result from last RPC */
 266         __u32 lcd_last_data;    /* per-op data (disposition for open &c.) */
 267         /* for MDS_CLOSE requests */
 268         __u64 lcd_last_close_transno; /* last completed transaction ID */
 269         __u64 lcd_last_close_xid;     /* xid for the last transaction */
 270         __u32 lcd_last_close_result;  /* result from last RPC */
 271         __u32 lcd_last_close_data;    /* per-op data */
 272         __u8  lcd_padding[LR_CLIENT_SIZE - 88];
 273 };
 274
 275
 276 /****************** superblock additional info *********************/
 277 #ifdef __KERNEL__
 278
 279 struct ll_sb_info;
 280
 281 struct lustre_sb_info {
 282         int                       lsi_flags;
 283         struct obd_device        *lsi_mgc;     /* mgc obd */
 284         struct lustre_mount_data *lsi_lmd;     /* mount command info */
 285         struct lustre_disk_data  *lsi_ldd;     /* mount info on-disk */
 286         struct ll_sb_info        *lsi_llsbi;   /* add'l client sbi info */
 287         struct vfsmount          *lsi_srv_mnt; /* the one server mount */
 288         atomic_t                  lsi_mounts;  /* references to the srv_mnt */
 289 };
 290
 291 #define LSI_SERVER                       0x00000001
 292 #define LSI_UMOUNT_FORCE                 0x00000010
 293 #define LSI_UMOUNT_FAILOVER              0x00000020
 294
 295 #define     s2lsi(sb)        ((struct lustre_sb_info *)((sb)->s_fs_info))
 296 #define     s2lsi_nocast(sb) ((sb)->s_fs_info)
 297
 298 #define     get_profile_name(sb)   (s2lsi(sb)->lsi_lmd->lmd_profile)
 299
 300 #endif /* __KERNEL__ */
 301
 302 /****************** mount lookup info *********************/
 303
 304 struct lustre_mount_info {
 305         char               *lmi_name;
 306         struct super_block *lmi_sb;
 307         struct vfsmount    *lmi_mnt;
 308         struct list_head    lmi_list_chain;
 309 };
 310
 311 /****************** prototypes *********************/
 312
 313 #ifdef __KERNEL__
 314 #include <obd_class.h>
 315
 316 /* obd_mount.c */
 317 void lustre_register_client_fill_super(int (*cfs)(struct super_block *sb));
 318 void lustre_register_kill_super_cb(void (*cfs)(struct super_block *sb));
 319
 320
 321 int lustre_common_put_super(struct super_block *sb);
 322 int lustre_process_log(struct super_block *sb, char *logname,
 323                      struct config_llog_instance *cfg);
 324 int lustre_end_log(struct super_block *sb, char *logname,
 325                        struct config_llog_instance *cfg);
 326 struct lustre_mount_info *server_get_mount(const char *name);
 327 struct lustre_mount_info *server_get_mount_2(const char *name);
 328 int server_put_mount(const char *name, struct vfsmount *mnt);
 329 int server_put_mount_2(const char *name, struct vfsmount *mnt);
 330 int server_register_target(struct super_block *sb);
 331 struct mgs_target_info;
 332 int server_mti_print(char *title, struct mgs_target_info *mti);
 333
 334 /* mgc_request.c */
 335 int mgc_fsname2resid(char *fsname, struct ldlm_res_id *res_id);
 336
 337 #endif
 338
 339 #endif // _LUSTRE_DISK_H