4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
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.
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).
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
23 * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Use is subject to license terms.
26 * Copyright (c) 2012, 2017, Intel Corporation.
29 * This file is part of Lustre, http://www.lustre.org/
32 #ifndef _MOUNT_UTILS_H_
33 #define _MOUNT_UTILS_H_
35 /* Some of the userland headers for libzfs also require
36 * zfs/spl linux kernel headers, but including these pull
37 * in linux kernel headers which conflicts with the
38 * userland version of libcfs. So the solution is tell the
39 * libzfs user land headrs that the zfs/spl kernel headers
40 * are already included even if this is not the case.
53 #include <sys/types.h>
56 #include <libcfs/util/list.h>
57 #include <linux/lustre/lustre_param.h>
58 #ifdef HAVE_SERVER_SUPPORT
59 #include <linux/lustre/lustre_disk.h>
62 extern char *progname;
66 #define vprint(fmt, arg...) if (verbose > 0) printf(fmt, ##arg)
67 #define verrprint(fmt, arg...) if (verbose >= 0) fprintf(stderr, fmt, ##arg)
70 #define MO_IS_LOOP 0x01
71 #define MO_FORCEFORMAT 0x02
72 #define MO_FAILOVER 0x04
73 #define MO_DRYRUN 0x08
75 #define MO_NOHOSTID_CHECK 0x20
76 #define MO_RENAME 0x40
77 #define MO_ERASE_ALL 0x80
79 #define MAX_LOOP_DEVICES 16
80 #define INDEX_UNASSIGNED 0xFFFF
82 /* Maximum length of on-disk parameters in the form key=<value> */
83 #define PARAM_MAX 4096
85 #ifdef HAVE_SERVER_SUPPORT
86 /* On-disk configuration file. In host-endian order. */
87 struct lustre_disk_data {
89 __u32 ldd_feature_compat; /* compatible feature flags */
90 __u32 ldd_feature_rocompat; /* read-only compatible feature flags */
91 __u32 ldd_feature_incompat; /* incompatible feature flags */
93 __u32 ldd_config_ver; /* config rewrite count - not used */
94 __u32 ldd_flags; /* LDD_SV_TYPE */
95 __u32 ldd_svindex; /* server index (0001), must match
98 __u32 ldd_mount_type; /* target fs type LDD_MT_* */
99 char ldd_fsname[64]; /* filesystem this server is part of,
102 char ldd_svname[64]; /* this server's name (lustre-mdt0001)*/
103 __u8 ldd_uuid[40]; /* server UUID (COMPAT_146) */
105 char ldd_userdata[1024 - 200]; /* arbitrary user string '200' */
106 __u8 ldd_padding[4096 - 1024]; /* 1024 */
107 char ldd_mount_opts[4096]; /* target fs mount opts '4096' */
108 char ldd_params[4096]; /* key=value pairs '8192' */
111 /* used to describe the options to format the lustre disk, not persistent */
113 struct lustre_disk_data mo_ldd; /* to be written in MOUNT_DATA_FILE */
114 char mo_device[128]; /* disk device name */
115 char **mo_pool_vdevs; /* list of pool vdevs */
116 char mo_loopdev[128]; /* in case a loop dev is needed */
117 char mo_mkfsopts[512]; /* options for backing-store mkfs */
118 char *mo_mountopts; /* mount options for backing fs */
119 long long mo_device_kb; /* in KB */
120 int mo_blocksize_kb; /* blocksize in KB */
123 int mo_mgs_failnodes;
128 /* used to describe the options to mount the lustre disk */
130 #ifdef HAVE_SERVER_SUPPORT
131 struct lustre_disk_data mo_ldd;
133 char *mo_orig_options;
134 char *mo_usource; /* user-specified mount device */
135 char *mo_source; /* our mount device name */
136 char mo_target[PATH_MAX]; /* mount directory */
138 char mo_skpath[PATH_MAX]; /* shared key file/directory */
145 int mo_md_stripe_cache_size;
147 int mo_max_sectors_kb;
150 #ifdef HAVE_SERVER_SUPPORT
151 int get_mountdata(char *, struct lustre_disk_data *);
153 static inline const char *mt_str(enum ldd_mount_type mt)
155 static const char * const mount_type_string[] = {
163 return mount_type_string[mt];
166 static inline const char *mt_type(enum ldd_mount_type mt)
168 static const char * const mount_type_string[] = {
176 return mount_type_string[mt];
178 #endif /* HAVE_SERVER_SUPPORT */
180 #define MT_STR(data) mt_str((data)->ldd_mount_type)
182 #define IS_MDT(data) ((data)->ldd_flags & LDD_F_SV_TYPE_MDT)
183 #define IS_OST(data) ((data)->ldd_flags & LDD_F_SV_TYPE_OST)
184 #define IS_MGS(data) ((data)->ldd_flags & LDD_F_SV_TYPE_MGS)
185 #define IS_SEPARATED_MGS(data) ((data)->ldd_flags == LDD_F_SV_TYPE_MGS)
186 #define IS_SERVER(data) ((data)->ldd_flags & (LDD_F_SV_TYPE_MGS | \
187 LDD_F_SV_TYPE_MDT | LDD_F_SV_TYPE_OST))
190 /* mkfs/mount helper functions */
192 int run_command_err(char *cmd, int cmdsz, char *error_msg);
193 int run_command(char *cmd, int cmdsz);
194 int add_param(char *buf, char *key, char *val);
195 int append_param(char *buf, char *key, char *val, char sep);
196 int get_param(char *buf, char *key, char **val);
197 char *strscat(char *dst, char *src, int buflen);
198 char *strscpy(char *dst, char *src, int buflen);
199 int check_mtab_entry(char *spec1, char *spec2, char *mntpt, char *type);
200 int update_mtab_entry(char *spec, char *mtpt, char *type, char *opts,
201 int flags, int freq, int pass);
202 int update_utab_entry(struct mount_opts *mop);
203 int check_mountfsoptions(char *mountopts, char *wanted_mountopts);
204 void trim_mountfsoptions(char *s);
205 #ifdef HAVE_SERVER_SUPPORT
206 __u64 get_device_size(char* device);
207 int lustre_rename_fsname(struct mkfs_opts *mop, const char *mntpt,
208 const char *oldname);
210 /* loopback helper functions */
211 int file_create(char *path, __u64 size);
212 int loop_format(struct mkfs_opts *mop);
213 int loop_setup(struct mkfs_opts *mop);
214 int loop_cleanup(struct mkfs_opts *mop);
216 /* generic target support */
217 int osd_write_ldd(struct mkfs_opts *mop);
218 int osd_read_ldd(char *dev, struct lustre_disk_data *ldd);
219 int osd_erase_ldd(struct mkfs_opts *mop, char *param);
220 void osd_print_ldd_params(struct mkfs_opts *mop);
221 int osd_is_lustre(char *dev, unsigned *mount_type);
222 int osd_make_lustre(struct mkfs_opts *mop);
223 int osd_prepare_lustre(struct mkfs_opts *mop,
224 char *wanted_mountopts, size_t len);
225 int osd_fix_mountopts(struct mkfs_opts *mop, char *mountopts, size_t len);
226 int osd_tune_lustre(char *dev, struct mount_opts *mop);
227 int osd_label_lustre(struct mount_opts *mop);
228 int osd_rename_fsname(struct mkfs_opts *mop, const char *oldname);
229 int osd_enable_quota(struct mkfs_opts *mop);
233 struct module_backfs_ops {
236 int (*read_ldd)(char *ds, struct lustre_disk_data *ldd);
237 int (*write_ldd)(struct mkfs_opts *mop);
238 int (*erase_ldd)(struct mkfs_opts *mop, char *param);
239 void (*print_ldd_params)(struct mkfs_opts *mop);
240 int (*is_lustre)(char *dev, enum ldd_mount_type *mount_type);
241 int (*make_lustre)(struct mkfs_opts *mop);
242 int (*prepare_lustre)(struct mkfs_opts *mop,
243 char *wanted_mountopts, size_t len);
244 int (*fix_mountopts)(struct mkfs_opts *mop,
245 char *mountopts, size_t len);
246 int (*tune_lustre)(char *dev, struct mount_opts *mop);
247 int (*label_lustre)(struct mount_opts *mop);
248 int (*enable_quota)(struct mkfs_opts *mop);
249 int (*rename_fsname)(struct mkfs_opts *mop, const char *oldname);
253 extern struct module_backfs_ops zfs_ops;
254 extern struct module_backfs_ops ldiskfs_ops;
256 struct module_backfs_ops *load_backfs_module(enum ldd_mount_type mount_type);
257 void unload_backfs_ops(struct module_backfs_ops *ops);
260 #ifdef HAVE_OPENSSL_SSK
261 int load_shared_keys(struct mount_opts *mop);
263 static inline int load_shared_keys(struct mount_opts *mop)