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.gnu.org/licenses/gpl-2.0.html
  19  *
  20  * GPL HEADER END
  21  */
  22 /*
  23  * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
  24  * Use is subject to license terms.
  25  *
  26  * Copyright (c) 2012, 2016, 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
  33 #ifndef _MOUNT_UTILS_H_
  34 #define _MOUNT_UTILS_H_
  35
  36 /* Some of the userland headers for libzfs also require
  37  * zfs/spl linux kernel headers, but including these pull
  38  * in linux kernel headers which conflicts with the
  39  * userland version of libcfs. So the solution is tell the
  40  * libzfs user land headrs that the zfs/spl kernel headers
  41  * are already included even if this is not the case.
  42  */
  43 #ifdef HAVE_ZFS_OSD
  44 #define _SPL_ZFS_H
  45 #define _SPL_SIGNAL_H
  46 #endif
  47 #include <ctype.h>
  48 #include <errno.h>
  49 #include <fcntl.h>
  50 #include <limits.h>
  51 #include <stdbool.h>
  52 #include <stdlib.h>
  53 #include <string.h>
  54 #include <sys/types.h>
  55 #include <sys/stat.h>
  56
  57 #include <libcfs/util/list.h>
  58 #include <linux/lustre_disk.h>
  59 #include <lustre_param.h>
  60
  61 extern char *progname;
  62 extern int verbose;
  63 extern int failover;
  64
  65 #define vprint(fmt, arg...) if (verbose > 0) printf(fmt, ##arg)
  66 #define verrprint(fmt, arg...) if (verbose >= 0) fprintf(stderr, fmt, ##arg)
  67
  68 /* mo_flags */
  69 #define MO_IS_LOOP              0x01
  70 #define MO_FORCEFORMAT          0x02
  71 #define MO_FAILOVER             0x04
  72 #define MO_DRYRUN               0x08
  73 #define MO_QUOTA                0x10
  74 #define MO_NOHOSTID_CHECK       0x20
  75 #define MO_RENAME               0x40
  76 #define MO_ERASE_ALL            0x80
  77
  78 #define MAX_LOOP_DEVICES        16
  79 #define INDEX_UNASSIGNED        0xFFFF
  80
  81 /* Maximum length of on-disk parameters in the form key=<value> */
  82 #define PARAM_MAX               4096
  83
  84 /* used to describe the options to format the lustre disk, not persistent */
  85 struct mkfs_opts {
  86         struct lustre_disk_data mo_ldd; /* to be written in MOUNT_DATA_FILE */
  87         char    mo_device[128];   /* disk device name */
  88         char    **mo_pool_vdevs;  /* list of pool vdevs */
  89         char    mo_loopdev[128];  /* in case a loop dev is needed */
  90         char    mo_mkfsopts[512]; /* options to the backing-store mkfs */
  91         char    *mo_mountopts;    /* mount options for backing fs */
  92         __u64   mo_device_kb;     /* in KB */
  93         int     mo_stripe_count;
  94         int     mo_flags;
  95         int     mo_mgs_failnodes;
  96 };
  97
  98 /* used to describe the options to mount the lustre disk */
  99 struct mount_opts {
 100         struct lustre_disk_data  mo_ldd;
 101         char    *mo_orig_options;
 102         char    *mo_usource;            /* user-specified mount device */
 103         char    *mo_source;             /* our mount device name */
 104         char     mo_target[PATH_MAX];   /* mount directory */
 105 #ifdef HAVE_GSS
 106         char     mo_skpath[PATH_MAX];   /* shared key file/directory */
 107 #endif
 108         int      mo_nomtab;
 109         int      mo_fake;
 110         int      mo_force;
 111         int      mo_retry;
 112         int      mo_have_mgsnid;
 113         int      mo_md_stripe_cache_size;
 114         int      mo_nosvc;
 115         int      mo_max_sectors_kb;
 116 };
 117
 118 int get_mountdata(char *, struct lustre_disk_data *);
 119
 120 static inline char *mt_str(enum ldd_mount_type mt)
 121 {
 122         static char *mount_type_string[] = {
 123                 "ext3",
 124                 "ldiskfs",
 125                 "smfs",
 126                 "reiserfs",
 127                 "ldiskfs2",
 128                 "zfs",
 129         };
 130         return mount_type_string[mt];
 131 }
 132
 133 static inline char *mt_type(enum ldd_mount_type mt)
 134 {
 135         static char *mount_type_string[] = {
 136                 "osd-ldiskfs",
 137                 "osd-ldiskfs",
 138                 "osd-smfs",
 139                 "osd-reiserfs",
 140                 "osd-ldiskfs",
 141                 "osd-zfs",
 142         };
 143         return mount_type_string[mt];
 144 }
 145
 146 #define MT_STR(data)   mt_str((data)->ldd_mount_type)
 147
 148 #define IS_MDT(data)   ((data)->ldd_flags & LDD_F_SV_TYPE_MDT)
 149 #define IS_OST(data)   ((data)->ldd_flags & LDD_F_SV_TYPE_OST)
 150 #define IS_MGS(data)  ((data)->ldd_flags & LDD_F_SV_TYPE_MGS)
 151 #define IS_SEPARATED_MGS(data)  ((data)->ldd_flags == LDD_F_SV_TYPE_MGS)
 152 #define IS_SERVER(data) ((data)->ldd_flags & (LDD_F_SV_TYPE_MGS | \
 153                           LDD_F_SV_TYPE_MDT | LDD_F_SV_TYPE_OST))
 154
 155
 156 /* mkfs/mount helper functions */
 157 void fatal(void);
 158 int run_command_err(char *cmd, int cmdsz, char *error_msg);
 159 int run_command(char *cmd, int cmdsz);
 160 int add_param(char *buf, char *key, char *val);
 161 int append_param(char *buf, char *key, char *val, char sep);
 162 int get_param(char *buf, char *key, char **val);
 163 char *strscat(char *dst, char *src, int buflen);
 164 char *strscpy(char *dst, char *src, int buflen);
 165 int check_mtab_entry(char *spec1, char *spec2, char *mntpt, char *type);
 166 int update_mtab_entry(char *spec, char *mtpt, char *type, char *opts,
 167                       int flags, int freq, int pass);
 168 int update_utab_entry(struct mount_opts *mop);
 169 int check_mountfsoptions(char *mountopts, char *wanted_mountopts);
 170 void trim_mountfsoptions(char *s);
 171 __u64 get_device_size(char* device);
 172 int lustre_rename_fsname(struct mkfs_opts *mop, const char *mntpt,
 173                          const char *oldname);
 174
 175 /* loopback helper functions */
 176 int file_create(char *path, __u64 size);
 177 int loop_format(struct mkfs_opts *mop);
 178 int loop_setup(struct mkfs_opts *mop);
 179 int loop_cleanup(struct mkfs_opts *mop);
 180
 181 /* generic target support */
 182 int osd_write_ldd(struct mkfs_opts *mop);
 183 int osd_read_ldd(char *dev, struct lustre_disk_data *ldd);
 184 int osd_erase_ldd(struct mkfs_opts *mop, char *param);
 185 void osd_print_ldd_params(struct mkfs_opts *mop);
 186 int osd_is_lustre(char *dev, unsigned *mount_type);
 187 int osd_make_lustre(struct mkfs_opts *mop);
 188 int osd_prepare_lustre(struct mkfs_opts *mop,
 189                        char *wanted_mountopts, size_t len);
 190 int osd_fix_mountopts(struct mkfs_opts *mop, char *mountopts, size_t len);
 191 int osd_tune_lustre(char *dev, struct mount_opts *mop);
 192 int osd_label_lustre(struct mount_opts *mop);
 193 int osd_rename_fsname(struct mkfs_opts *mop, const char *oldname);
 194 int osd_enable_quota(struct mkfs_opts *mop);
 195 int osd_init(void);
 196 void osd_fini(void);
 197
 198 struct module_backfs_ops {
 199         int     (*init)(void);
 200         void    (*fini)(void);
 201         int     (*read_ldd)(char *ds,  struct lustre_disk_data *ldd);
 202         int     (*write_ldd)(struct mkfs_opts *mop);
 203         int     (*erase_ldd)(struct mkfs_opts *mop, char *param);
 204         void    (*print_ldd_params)(struct mkfs_opts *mop);
 205         int     (*is_lustre)(char *dev, enum ldd_mount_type *mount_type);
 206         int     (*make_lustre)(struct mkfs_opts *mop);
 207         int     (*prepare_lustre)(struct mkfs_opts *mop,
 208                                   char *wanted_mountopts, size_t len);
 209         int     (*fix_mountopts)(struct mkfs_opts *mop,
 210                                  char *mountopts, size_t len);
 211         int     (*tune_lustre)(char *dev, struct mount_opts *mop);
 212         int     (*label_lustre)(struct mount_opts *mop);
 213         int     (*enable_quota)(struct mkfs_opts *mop);
 214         int     (*rename_fsname)(struct mkfs_opts *mop, const char *oldname);
 215         void   *dl_handle;
 216 };
 217
 218 struct module_backfs_ops *load_backfs_module(enum ldd_mount_type mount_type);
 219 void unload_backfs_ops(struct module_backfs_ops *ops);
 220 #ifdef HAVE_OPENSSL_SSK
 221 int load_shared_keys(struct mount_opts *mop);
 222 #else
 223 static inline int load_shared_keys(struct mount_opts *mop)
 224 {
 225         return EOPNOTSUPP;
 226 }
 227 #endif
 228 #endif