lustre/utils/mount_utils.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.sun.com/software/products/lustre/docs/GPLv2.pdf
  19  *
  20  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  21  * CA 95054 USA or visit www.sun.com if you need additional information or
  22  * have any questions.
  23  *
  24  * GPL HEADER END
  25  */
  26 /*
  27  * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
  28  * Use is subject to license terms.
  29  *
  30  * Copyright (c) 2012, Whamcloud, Inc.
  31  */
  32 /*
  33  * This file is part of Lustre, http://www.lustre.org/
  34  * Lustre is a trademark of Sun Microsystems, Inc.
  35  */
  36
  37 #ifndef _MOUNT_UTILS_H_
  38 #define _MOUNT_UTILS_H_
  39
  40 #include <lustre_disk.h>
  41 #include <lustre_param.h>
  42
  43 extern char *progname;
  44 extern int verbose;
  45 extern int failover;
  46
  47 #define vprint(fmt, arg...) if (verbose > 0) printf(fmt, ##arg)
  48 #define verrprint(fmt, arg...) if (verbose >= 0) fprintf(stderr, fmt, ##arg)
  49
  50 /* mo_flags */
  51 #define MO_IS_LOOP              0x01
  52 #define MO_FORCEFORMAT          0x02
  53 #define MO_FAILOVER             0x04
  54 #define MO_DRYRUN               0x08
  55
  56 #define MAX_LOOP_DEVICES        16
  57 #define INDEX_UNASSIGNED        0xFFFF
  58
  59 /* used to describe the options to format the lustre disk, not persistent */
  60 struct mkfs_opts {
  61         struct lustre_disk_data mo_ldd; /* to be written in MOUNT_DATA_FILE */
  62         char    mo_device[128];   /* disk device name */
  63         char    **mo_pool_vdevs;  /* list of pool vdevs */
  64         char    mo_loopdev[128];  /* in case a loop dev is needed */
  65         char    mo_mkfsopts[512]; /* options to the backing-store mkfs */
  66         __u64   mo_device_sz;     /* in KB */
  67         int     mo_stripe_count;
  68         int     mo_flags;
  69         int     mo_mgs_failnodes;
  70 };
  71
  72 /* used to describe the options to mount the lustre disk */
  73 struct mount_opts {
  74         struct lustre_disk_data  mo_ldd;
  75         char    *mo_orig_options;
  76         char    *mo_usource;            /* user-specified mount device */
  77         char    *mo_source;             /* our mount device name */
  78         char     mo_target[PATH_MAX];   /* mount directory */
  79         int      mo_nomtab;
  80         int      mo_fake;
  81         int      mo_force;
  82         int      mo_retry;
  83         int      mo_have_mgsnid;
  84         int      mo_md_stripe_cache_size;
  85         int      mo_nosvc;
  86 };
  87
  88 int get_mountdata(char *, struct lustre_disk_data *);
  89
  90 #define MT_STR(data)   mt_str((data)->ldd_mount_type)
  91
  92 #undef IS_MDT
  93 #define IS_MDT(data)   ((data)->ldd_flags & LDD_F_SV_TYPE_MDT)
  94 #undef IS_OST
  95 #define IS_OST(data)   ((data)->ldd_flags & LDD_F_SV_TYPE_OST)
  96 #undef IS_MGS
  97 #define IS_MGS(data)  ((data)->ldd_flags & LDD_F_SV_TYPE_MGS)
  98
  99 /* mkfs/mount helper functions */
 100 void fatal(void);
 101 int run_command_err(char *cmd, int cmdsz, char *error_msg);
 102 int run_command(char *cmd, int cmdsz);
 103 int add_param(char *buf, char *key, char *val);
 104 int get_param(char *buf, char *key, char **val);
 105 char *strscat(char *dst, char *src, int buflen);
 106 char *strscpy(char *dst, char *src, int buflen);
 107 int check_mtab_entry(char *spec1, char *spec2, char *mntpt, char *type);
 108 int update_mtab_entry(char *spec, char *mtpt, char *type, char *opts,
 109                       int flags, int freq, int pass);
 110 int check_mountfsoptions(char *mountopts, char *wanted_mountopts, int justwarn);
 111 void trim_mountfsoptions(char *s);
 112 __u64 get_device_size(char* device);
 113
 114 int is_block(char *devname);
 115 void disp_old_e2fsprogs_msg(const char *feature, int make_backfs);
 116 int make_lustre_backfs(struct mkfs_opts *mop);
 117 int write_local_files(struct mkfs_opts *mop);
 118 int read_local_files(struct mkfs_opts *mop);
 119 int is_lustre_target(struct mkfs_opts *mop);
 120
 121 /* loopback helper functions */
 122 int file_create(char *path, int size);
 123 int loop_format(struct mkfs_opts *mop);
 124 int loop_setup(struct mkfs_opts *mop);
 125 int loop_cleanup(struct mkfs_opts *mop);
 126
 127 /* generic target support */
 128 int osd_write_ldd(struct mkfs_opts *mop);
 129 int osd_read_ldd(char *dev, struct lustre_disk_data *ldd);
 130 int osd_is_lustre(char *dev, unsigned *mount_type);
 131 int osd_make_lustre(struct mkfs_opts *mop);
 132 int osd_prepare_lustre(struct mkfs_opts *mop,
 133                        char *default_mountopts, int default_len,
 134                        char *always_mountopts, int always_len);
 135 int osd_tune_lustre(char *dev, struct mount_opts *mop);
 136 int osd_label_lustre(struct mount_opts *mop);
 137 int osd_init(void);
 138 void osd_fini(void);
 139
 140 int ldiskfs_write_ldd(struct mkfs_opts *mop);
 141 int ldiskfs_read_ldd(char *dev, struct lustre_disk_data *ldd);
 142 int ldiskfs_is_lustre(char *dev, unsigned *mount_type);
 143 int ldiskfs_make_lustre(struct mkfs_opts *mop);
 144 int ldiskfs_prepare_lustre(struct mkfs_opts *mop,
 145                            char *default_mountopts, int default_len,
 146                            char *always_mountopts, int always_len);
 147 int ldiskfs_tune_lustre(char *dev, struct mount_opts *mop);
 148 int ldiskfs_label_lustre(struct mount_opts *mop);
 149 int ldiskfs_init(void);
 150 void ldiskfs_fini(void);
 151
 152 #ifdef HAVE_ZFS_OSD
 153 int zfs_write_ldd(struct mkfs_opts *mop);
 154 int zfs_read_ldd(char *ds,  struct lustre_disk_data *ldd);
 155 int zfs_is_lustre(char *dev, unsigned *mount_type);
 156 int zfs_make_lustre(struct mkfs_opts *mop);
 157 int zfs_prepare_lustre(struct mkfs_opts *mop,
 158                        char *default_mountopts, int default_len,
 159                        char *always_mountopts, int always_len);
 160 int zfs_tune_lustre(char *dev, struct mount_opts *mop);
 161 int zfs_label_lustre(struct mount_opts *mop);
 162 int zfs_init(void);
 163 void zfs_fini(void);
 164 #endif
 165
 166 #endif