Whamcloud - gitweb
b8e97c40859965f3d3a909507f1fff502913000b
[fs/lustre-release.git] / lustre / utils / mount_utils.c
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  * Copyright (c) 2011, 2012, Intel Corporation.
30  */
31 /*
32  * This file is part of Lustre, http://www.lustre.org/
33  * Lustre is a trademark of Sun Microsystems, Inc.
34  */
35
36 #if HAVE_CONFIG_H
37 #  include "config.h"
38 #endif /* HAVE_CONFIG_H */
39
40 #include "mount_utils.h"
41 #include <stdio.h>
42 #include <errno.h>
43 #include <string.h>
44 #include <config.h>
45 #include <lustre_disk.h>
46 #include <lustre_ver.h>
47 #include <sys/stat.h>
48 #include <sys/utsname.h>
49
50 extern char *progname;
51 extern int verbose;
52
53 #define vprint(fmt, arg...) if (verbose > 0) printf(fmt, ##arg)
54 #define verrprint(fmt, arg...) if (verbose >= 0) fprintf(stderr, fmt, ##arg)
55
56 void fatal(void)
57 {
58         verbose = 0;
59         fprintf(stderr, "\n%s FATAL: ", progname);
60 }
61
62 int run_command(char *cmd, int cmdsz)
63 {
64         char log[] = "/tmp/run_command_logXXXXXX";
65         int fd = -1, rc;
66
67         if ((cmdsz - strlen(cmd)) < 6) {
68                 fatal();
69                 fprintf(stderr, "Command buffer overflow: %.*s...\n",
70                         cmdsz, cmd);
71                 return ENOMEM;
72         }
73
74         if (verbose > 1) {
75                 printf("cmd: %s\n", cmd);
76         } else {
77                 if ((fd = mkstemp(log)) >= 0) {
78                         close(fd);
79                         strcat(cmd, " >");
80                         strcat(cmd, log);
81                 }
82         }
83         strcat(cmd, " 2>&1");
84
85         /* Can't use popen because we need the rv of the command */
86         rc = system(cmd);
87         if (rc && (fd >= 0)) {
88                 char buf[128];
89                 FILE *fp;
90                 fp = fopen(log, "r");
91                 if (fp) {
92                         while (fgets(buf, sizeof(buf), fp) != NULL) {
93                                 printf("   %s", buf);
94                         }
95                         fclose(fp);
96                 }
97         }
98         if (fd >= 0)
99                 remove(log);
100         return rc;
101 }
102
103 int add_param(char *buf, char *key, char *val)
104 {
105         int end = sizeof(((struct lustre_disk_data *)0)->ldd_params);
106         int start = strlen(buf);
107         int keylen = 0;
108
109         if (key)
110                 keylen = strlen(key);
111         if (start + 1 + keylen + strlen(val) >= end) {
112                 fprintf(stderr, "%s: params are too long-\n%s %s%s\n",
113                         progname, buf, key ? key : "", val);
114                 return 1;
115         }
116
117         sprintf(buf + start, " %s%s", key ? key : "", val);
118         return 0;
119 }
120
121 int get_param(char *buf, char *key, char **val)
122 {
123         int i, key_len = strlen(key);
124         char *ptr;
125
126         ptr = strstr(buf, key);
127         if (ptr) {
128                 *val = strdup(ptr + key_len);
129                 if (*val == NULL)
130                         return ENOMEM;
131
132                 for (i = 0; i < strlen(*val); i++)
133                         if (((*val)[i] == ' ') || ((*val)[i] == '\0'))
134                                 break;
135
136                 (*val)[i] = '\0';
137                 return 0;
138         }
139
140         return ENOENT;
141 }
142
143 char *strscat(char *dst, char *src, int buflen)
144 {
145         dst[buflen - 1] = 0;
146         if (strlen(dst) + strlen(src) >= buflen) {
147                 fprintf(stderr, "string buffer overflow (max %d): '%s' + '%s'"
148                         "\n", buflen, dst, src);
149                 exit(EOVERFLOW);
150         }
151         return strcat(dst, src);
152 }
153
154 char *strscpy(char *dst, char *src, int buflen)
155 {
156         dst[0] = 0;
157         return strscat(dst, src, buflen);
158 }
159
160 int check_mtab_entry(char *spec1, char *spec2, char *mtpt, char *type)
161 {
162         FILE *fp;
163         struct mntent *mnt;
164
165         fp = setmntent(MOUNTED, "r");
166         if (fp == NULL)
167                 return 0;
168
169         while ((mnt = getmntent(fp)) != NULL) {
170                 if ((strcmp(mnt->mnt_fsname, spec1) == 0 ||
171                      strcmp(mnt->mnt_fsname, spec2) == 0) &&
172                     (mtpt == NULL || strcmp(mnt->mnt_dir, mtpt) == 0) &&
173                     (type == NULL || strcmp(mnt->mnt_type, type) == 0)) {
174                         endmntent(fp);
175                         return(EEXIST);
176                 }
177         }
178         endmntent(fp);
179
180         return 0;
181 }
182
183 #define PROC_DIR        "/proc/"
184 static int mtab_is_proc(const char *mtab)
185 {
186         char path[16];
187
188         if (readlink(mtab, path, sizeof(path)) < 0)
189                 return 0;
190
191         if (strncmp(path, PROC_DIR, strlen(PROC_DIR)))
192                 return 0;
193
194         return 1;
195 }
196
197 int update_mtab_entry(char *spec, char *mtpt, char *type, char *opts,
198                 int flags, int freq, int pass)
199 {
200         FILE *fp;
201         struct mntent mnt;
202         int rc = 0;
203
204         /* Don't update mtab if it is linked to any file in /proc direcotry.*/
205         if (mtab_is_proc(MOUNTED))
206                 return 0;
207
208         mnt.mnt_fsname = spec;
209         mnt.mnt_dir = mtpt;
210         mnt.mnt_type = type;
211         mnt.mnt_opts = opts ? opts : "";
212         mnt.mnt_freq = freq;
213         mnt.mnt_passno = pass;
214
215         fp = setmntent(MOUNTED, "a+");
216         if (fp == NULL) {
217                 fprintf(stderr, "%s: setmntent(%s): %s:",
218                         progname, MOUNTED, strerror (errno));
219                 rc = 16;
220         } else {
221                 if ((addmntent(fp, &mnt)) == 1) {
222                         fprintf(stderr, "%s: addmntent: %s:",
223                                 progname, strerror (errno));
224                         rc = 16;
225                 }
226                 endmntent(fp);
227         }
228
229         return rc;
230 }
231
232 /* Search for opt in mntlist, returning true if found.
233  */
234 static int in_mntlist(char *opt, char *mntlist)
235 {
236         char *ml, *mlp, *item, *ctx = NULL;
237
238         if (!(ml = strdup(mntlist))) {
239                 fprintf(stderr, "%s: out of memory\n", progname);
240                 exit(1);
241         }
242         mlp = ml;
243         while ((item = strtok_r(mlp, ",", &ctx))) {
244                 if (!strcmp(opt, item))
245                         break;
246                 mlp = NULL;
247         }
248         free(ml);
249         return (item != NULL);
250 }
251
252 /* Issue a message on stderr for every item in wanted_mountopts that is not
253  * present in mountopts.  The justwarn boolean toggles between error and
254  * warning message.  Return an error count.
255  */
256 int check_mountfsoptions(char *mountopts, char *wanted_mountopts,
257                          int justwarn)
258 {
259         char *ml, *mlp, *item, *ctx = NULL;
260         int errors = 0;
261
262         if (!(ml = strdup(wanted_mountopts))) {
263                 fprintf(stderr, "%s: out of memory\n", progname);
264                 exit(1);
265         }
266         mlp = ml;
267         while ((item = strtok_r(mlp, ",", &ctx))) {
268                 if (!in_mntlist(item, mountopts)) {
269                         fprintf(stderr, "%s: %s mount option `%s' is missing\n",
270                                 progname, justwarn ? "Warning: default"
271                                 : "Error: mandatory", item);
272                         errors++;
273                 }
274                 mlp = NULL;
275         }
276         free(ml);
277         return errors;
278 }
279
280 /* Trim embedded white space, leading and trailing commas from string s.
281  */
282 void trim_mountfsoptions(char *s)
283 {
284         char *p;
285
286         for (p = s; *p; ) {
287                 if (isspace(*p)) {
288                         memmove(p, p + 1, strlen(p + 1) + 1);
289                         continue;
290                 }
291                 p++;
292         }
293
294         while (s[0] == ',')
295                 memmove(&s[0], &s[1], strlen(&s[1]) + 1);
296
297         p = s + strlen(s) - 1;
298         while (p >= s && *p == ',')
299                 *p-- = '\0';
300 }
301
302 /* Setup a file in the first unused loop_device */
303 int loop_setup(struct mkfs_opts *mop)
304 {
305         char loop_base[20];
306         char l_device[64];
307         int i, ret = 0;
308
309         /* Figure out the loop device names */
310         if (!access("/dev/loop0", F_OK | R_OK)) {
311                 strcpy(loop_base, "/dev/loop\0");
312         } else if (!access("/dev/loop/0", F_OK | R_OK)) {
313                 strcpy(loop_base, "/dev/loop/\0");
314         } else {
315                 fprintf(stderr, "%s: can't access loop devices\n", progname);
316                 return EACCES;
317         }
318
319         /* Find unused loop device */
320         for (i = 0; i < MAX_LOOP_DEVICES; i++) {
321                 char cmd[PATH_MAX];
322                 int cmdsz = sizeof(cmd);
323
324                 sprintf(l_device, "%s%d", loop_base, i);
325                 if (access(l_device, F_OK | R_OK))
326                         break;
327                 snprintf(cmd, cmdsz, "losetup %s > /dev/null 2>&1", l_device);
328                 ret = system(cmd);
329
330                 /* losetup gets 1 (ret=256) for non-set-up device */
331                 if (ret) {
332                         /* Set up a loopback device to our file */
333                         snprintf(cmd, cmdsz, "losetup %s %s", l_device,
334                                  mop->mo_device);
335                         ret = run_command(cmd, cmdsz);
336                         if (ret == 256)
337                                 /* someone else picked up this loop device
338                                  * behind our back */
339                                 continue;
340                         if (ret) {
341                                 fprintf(stderr, "%s: error %d on losetup: %s\n",
342                                         progname, ret, strerror(ret));
343                                 return ret;
344                         }
345                         strscpy(mop->mo_loopdev, l_device,
346                                 sizeof(mop->mo_loopdev));
347                         return ret;
348                 }
349         }
350
351         fprintf(stderr, "%s: out of loop devices!\n", progname);
352         return EMFILE;
353 }
354
355 int loop_cleanup(struct mkfs_opts *mop)
356 {
357         char cmd[150];
358         int ret = 1;
359         if ((mop->mo_flags & MO_IS_LOOP) && *mop->mo_loopdev) {
360                 sprintf(cmd, "losetup -d %s", mop->mo_loopdev);
361                 ret = run_command(cmd, sizeof(cmd));
362         }
363         return ret;
364 }
365
366 int loop_format(struct mkfs_opts *mop)
367 {
368         int fd;
369
370         if (mop->mo_device_sz == 0) {
371                 fatal();
372                 fprintf(stderr, "loop device requires a --device-size= "
373                         "param\n");
374                 return EINVAL;
375         }
376
377         fd = creat(mop->mo_device, S_IRUSR|S_IWUSR);
378         if (fd < 0) {
379                 fatal();
380                 fprintf(stderr, "%s: Unable to create backing store: %s\n",
381                         progname, strerror(errno));
382                 return errno;
383         }
384
385         if (ftruncate(fd, mop->mo_device_sz * 1024) != 0) {
386                 close(fd);
387                 fatal();
388                 fprintf(stderr, "%s: Unable to truncate backing store: %s\n",
389                         progname, strerror(errno));
390                 return errno;
391         }
392
393         close(fd);
394         return 0;
395 }
396
397 /* Write the server config files */
398 int osd_write_ldd(struct mkfs_opts *mop)
399 {
400         struct lustre_disk_data *ldd = &mop->mo_ldd;
401         int ret;
402
403         switch (ldd->ldd_mount_type) {
404 #ifdef HAVE_LDISKFS_OSD
405         case LDD_MT_LDISKFS:
406         case LDD_MT_LDISKFS2:
407                 ret = ldiskfs_write_ldd(mop);
408                 break;
409 #endif /* HAVE_LDISKFS_OSD */
410 #ifdef HAVE_ZFS_OSD
411         case LDD_MT_ZFS:
412                 ret = zfs_write_ldd(mop);
413                 break;
414 #endif /* HAVE_ZFS_OSD */
415         default:
416                 fatal();
417                 fprintf(stderr, "unknown fs type %d '%s'\n",
418                         ldd->ldd_mount_type, MT_STR(ldd));
419                 ret = EINVAL;
420                 break;
421         }
422
423         return ret;
424 }
425
426 /* Read the server config files */
427 int osd_read_ldd(char *dev, struct lustre_disk_data *ldd)
428 {
429         int ret;
430
431         switch (ldd->ldd_mount_type) {
432 #ifdef HAVE_LDISKFS_OSD
433         case LDD_MT_LDISKFS:
434         case LDD_MT_LDISKFS2:
435                 ret = ldiskfs_read_ldd(dev, ldd);
436                 break;
437 #endif /* HAVE_LDISKFS_OSD */
438 #ifdef HAVE_ZFS_OSD
439         case LDD_MT_ZFS:
440                 ret = zfs_read_ldd(dev, ldd);
441                 break;
442 #endif /* HAVE_ZFS_OSD */
443         default:
444                 fatal();
445                 fprintf(stderr, "unknown fs type %d '%s'\n",
446                         ldd->ldd_mount_type, MT_STR(ldd));
447                 ret = EINVAL;
448                 break;
449         }
450
451         return ret;
452 }
453
454 /* Was this device formatted for Lustre */
455 int osd_is_lustre(char *dev, unsigned *mount_type)
456 {
457         vprint("checking for existing Lustre data: ");
458
459 #ifdef HAVE_LDISKFS_OSD
460         if (ldiskfs_is_lustre(dev, mount_type)) {
461                 vprint("found\n");
462                 return 1;
463         }
464 #endif /* HAVE_LDISKFS_OSD */
465 #ifdef HAVE_ZFS_OSD
466         if (zfs_is_lustre(dev, mount_type)) {
467                 vprint("found\n");
468                 return 1;
469         }
470 #endif /* HAVE_ZFS_OSD */
471
472         vprint("not found\n");
473         return 0;
474 }
475
476 /* Build fs according to type */
477 int osd_make_lustre(struct mkfs_opts *mop)
478 {
479         struct lustre_disk_data *ldd = &mop->mo_ldd;
480         int ret;
481
482         switch (ldd->ldd_mount_type) {
483 #ifdef HAVE_LDISKFS_OSD
484         case LDD_MT_LDISKFS:
485         case LDD_MT_LDISKFS2:
486                 ret = ldiskfs_make_lustre(mop);
487                 break;
488 #endif /* HAVE_LDISKFS_OSD */
489 #ifdef HAVE_ZFS_OSD
490         case LDD_MT_ZFS:
491                 ret = zfs_make_lustre(mop);
492                 break;
493 #endif /* HAVE_ZFS_OSD */
494         default:
495                 fatal();
496                 fprintf(stderr, "unknown fs type %d '%s'\n",
497                         ldd->ldd_mount_type, MT_STR(ldd));
498                 ret = EINVAL;
499                 break;
500         }
501
502         return ret;
503 }
504
505 int osd_prepare_lustre(struct mkfs_opts *mop,
506                 char *default_mountopts, int default_len,
507                 char *always_mountopts, int always_len)
508 {
509         struct lustre_disk_data *ldd = &mop->mo_ldd;
510         int ret;
511
512         switch (ldd->ldd_mount_type) {
513 #ifdef HAVE_LDISKFS_OSD
514         case LDD_MT_LDISKFS:
515         case LDD_MT_LDISKFS2:
516                 ret = ldiskfs_prepare_lustre(mop,
517                                              default_mountopts, default_len,
518                                              always_mountopts, always_len);
519                 break;
520 #endif /* HAVE_LDISKFS_OSD */
521 #ifdef HAVE_ZFS_OSD
522         case LDD_MT_ZFS:
523                 ret = zfs_prepare_lustre(mop,
524                                          default_mountopts, default_len,
525                                          always_mountopts, always_len);
526                 break;
527 #endif /* HAVE_ZFS_OSD */
528         default:
529                 fatal();
530                 fprintf(stderr, "unknown fs type %d '%s'\n",
531                         ldd->ldd_mount_type, MT_STR(ldd));
532                 ret = EINVAL;
533                 break;
534         }
535
536         return ret;
537 }
538
539 int osd_tune_lustre(char *dev, struct mount_opts *mop)
540 {
541         struct lustre_disk_data *ldd = &mop->mo_ldd;
542         int ret;
543
544         switch (ldd->ldd_mount_type) {
545 #ifdef HAVE_LDISKFS_OSD
546         case LDD_MT_LDISKFS:
547         case LDD_MT_LDISKFS2:
548                 ret = ldiskfs_tune_lustre(dev, mop);
549                 break;
550 #endif /* HAVE_LDISKFS_OSD */
551 #ifdef HAVE_ZFS_OSD
552         case LDD_MT_ZFS:
553                 ret = zfs_tune_lustre(dev, mop);
554                 break;
555 #endif /* HAVE_ZFS_OSD */
556         default:
557                 fatal();
558                 fprintf(stderr, "unknown fs type %d '%s'\n",
559                                 ldd->ldd_mount_type, MT_STR(ldd));
560                 ret = EINVAL;
561                 break;
562         }
563
564         return ret;
565 }
566
567 int osd_label_lustre(struct mount_opts *mop)
568 {
569         struct lustre_disk_data *ldd = &mop->mo_ldd;
570         int ret;
571
572         switch (ldd->ldd_mount_type) {
573 #ifdef HAVE_LDISKFS_OSD
574         case LDD_MT_LDISKFS:
575         case LDD_MT_LDISKFS2:
576                 ret = ldiskfs_label_lustre(mop);
577                 break;
578 #endif /* HAVE_LDISKFS_OSD */
579 #ifdef HAVE_ZFS_OSD
580         case LDD_MT_ZFS:
581                 ret = zfs_label_lustre(mop);
582                 break;
583 #endif /* HAVE_ZFS_OSD */
584         default:
585                 fatal();
586                 fprintf(stderr, "unknown fs type %d '%s'\n",
587                         ldd->ldd_mount_type, MT_STR(ldd));
588                 ret = EINVAL;
589                 break;
590         }
591
592         return ret;
593 }
594
595 /* Enable quota accounting */
596 int osd_enable_quota(struct mkfs_opts *mop)
597 {
598         struct lustre_disk_data *ldd = &mop->mo_ldd;
599         int ret;
600
601         switch (ldd->ldd_mount_type) {
602 #ifdef HAVE_LDISKFS_OSD
603         case LDD_MT_EXT3:
604         case LDD_MT_LDISKFS:
605         case LDD_MT_LDISKFS2:
606                 ret = ldiskfs_enable_quota(mop);
607                 break;
608 #endif /* HAVE_LDISKFS_OSD */
609 #ifdef HAVE_ZFS_OSD
610         case LDD_MT_ZFS:
611                 fprintf(stderr, "this option is only valid for ldiskfs\n");
612                 ret = EINVAL;
613                 break;
614 #endif /* HAVE_ZFS_OSD */
615         default:
616                 fatal();
617                 fprintf(stderr, "unknown fs type %d '%s'\n",
618                         ldd->ldd_mount_type, MT_STR(ldd));
619                 ret = EINVAL;
620                 break;
621         }
622
623         return ret;
624 }
625
626 int osd_init(void)
627 {
628         int ret = 0;
629
630 #ifdef HAVE_LDISKFS_OSD
631         ret = ldiskfs_init();
632         if (ret)
633                 return ret;
634 #endif /* HAVE_LDISKFS_OSD */
635 #ifdef HAVE_ZFS_OSD
636         ret = zfs_init();
637         /* we want to be able to set up a ldiskfs-based filesystem w/o
638          * the ZFS modules installed, see ORI-425 */
639         if (ret)
640                 ret = 0;
641 #endif /* HAVE_ZFS_OSD */
642
643         return ret;
644 }
645
646 void osd_fini(void)
647 {
648 #ifdef HAVE_LDISKFS_OSD
649         ldiskfs_fini();
650 #endif /* HAVE_LDISKFS_OSD */
651 #ifdef HAVE_ZFS_OSD
652         zfs_fini();
653 #endif /* HAVE_ZFS_OSD */
654 }
655
656 __u64 get_device_size(char* device)
657 {
658         int ret, fd;
659         __u64 size = 0;
660
661         fd = open(device, O_RDONLY);
662         if (fd < 0) {
663                 fprintf(stderr, "%s: cannot open %s: %s\n",
664                         progname, device, strerror(errno));
665                 return 0;
666         }
667
668 #ifdef BLKGETSIZE64
669         /* size in bytes. bz5831 */
670         ret = ioctl(fd, BLKGETSIZE64, (void*)&size);
671 #else
672         {
673                 __u32 lsize = 0;
674                 /* size in blocks */
675                 ret = ioctl(fd, BLKGETSIZE, (void*)&lsize);
676                 size = (__u64)lsize * 512;
677         }
678 #endif
679         close(fd);
680         if (ret < 0) {
681                 fprintf(stderr, "%s: size ioctl failed: %s\n",
682                         progname, strerror(errno));
683                 return 0;
684         }
685
686         vprint("device size = "LPU64"MB\n", size >> 20);
687         /* return value in KB */
688         return size >> 10;
689 }
690
691 int file_create(char *path, int size)
692 {
693         int ret;
694         int fd;
695
696         ret = access(path, F_OK);
697         if (ret == 0) {
698                 ret = unlink(path);
699                 if (ret != 0)
700                         return errno;
701         }
702
703         fd = creat(path, S_IRUSR|S_IWUSR);
704         if (fd < 0) {
705                 fatal();
706                 fprintf(stderr, "%s: Unable to create backing store: %s\n",
707                         progname, strerror(errno));
708                 return errno;
709         }
710
711         ret = ftruncate(fd, size * 1024);
712         close(fd);
713         if (ret != 0) {
714                 fatal();
715                 fprintf(stderr, "%s: Unable to truncate backing store: %s\n",
716                         progname, strerror(errno));
717                 return errno;
718         }
719
720         return 0;
721 }