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