Whamcloud - gitweb
00400dfb76b76ff1ef20e9ce796f4b73e123fd61
[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,
343                                         ret >= 0 ? strerror(ret) : "");
344                                 return ret;
345                         }
346                         strscpy(mop->mo_loopdev, l_device,
347                                 sizeof(mop->mo_loopdev));
348                         return ret;
349                 }
350         }
351
352         fprintf(stderr, "%s: out of loop devices!\n", progname);
353         return EMFILE;
354 }
355
356 int loop_cleanup(struct mkfs_opts *mop)
357 {
358         char cmd[150];
359         int ret = 1;
360         if ((mop->mo_flags & MO_IS_LOOP) && *mop->mo_loopdev) {
361                 sprintf(cmd, "losetup -d %s", mop->mo_loopdev);
362                 ret = run_command(cmd, sizeof(cmd));
363         }
364         return ret;
365 }
366
367 int loop_format(struct mkfs_opts *mop)
368 {
369         int fd;
370
371         if (mop->mo_device_sz == 0) {
372                 fatal();
373                 fprintf(stderr, "loop device requires a --device-size= "
374                         "param\n");
375                 return EINVAL;
376         }
377
378         fd = creat(mop->mo_device, S_IRUSR|S_IWUSR);
379         if (fd < 0) {
380                 fatal();
381                 fprintf(stderr, "%s: Unable to create backing store: %s\n",
382                         progname, strerror(errno));
383                 return errno;
384         }
385
386         if (ftruncate(fd, mop->mo_device_sz * 1024) != 0) {
387                 close(fd);
388                 fatal();
389                 fprintf(stderr, "%s: Unable to truncate backing store: %s\n",
390                         progname, strerror(errno));
391                 return errno;
392         }
393
394         close(fd);
395         return 0;
396 }
397
398 /* Write the server config files */
399 int osd_write_ldd(struct mkfs_opts *mop)
400 {
401         struct lustre_disk_data *ldd = &mop->mo_ldd;
402         int ret;
403
404         switch (ldd->ldd_mount_type) {
405 #ifdef HAVE_LDISKFS_OSD
406         case LDD_MT_LDISKFS:
407         case LDD_MT_LDISKFS2:
408                 ret = ldiskfs_write_ldd(mop);
409                 break;
410 #endif /* HAVE_LDISKFS_OSD */
411 #ifdef HAVE_ZFS_OSD
412         case LDD_MT_ZFS:
413                 ret = zfs_write_ldd(mop);
414                 break;
415 #endif /* HAVE_ZFS_OSD */
416         default:
417                 fatal();
418                 fprintf(stderr, "unknown fs type %d '%s'\n",
419                         ldd->ldd_mount_type, MT_STR(ldd));
420                 ret = EINVAL;
421                 break;
422         }
423
424         return ret;
425 }
426
427 /* Read the server config files */
428 int osd_read_ldd(char *dev, struct lustre_disk_data *ldd)
429 {
430         int ret;
431
432         switch (ldd->ldd_mount_type) {
433 #ifdef HAVE_LDISKFS_OSD
434         case LDD_MT_LDISKFS:
435         case LDD_MT_LDISKFS2:
436                 ret = ldiskfs_read_ldd(dev, ldd);
437                 break;
438 #endif /* HAVE_LDISKFS_OSD */
439 #ifdef HAVE_ZFS_OSD
440         case LDD_MT_ZFS:
441                 ret = zfs_read_ldd(dev, ldd);
442                 break;
443 #endif /* HAVE_ZFS_OSD */
444         default:
445                 fatal();
446                 fprintf(stderr, "unknown fs type %d '%s'\n",
447                         ldd->ldd_mount_type, MT_STR(ldd));
448                 ret = EINVAL;
449                 break;
450         }
451
452         return ret;
453 }
454
455 /* Was this device formatted for Lustre */
456 int osd_is_lustre(char *dev, unsigned *mount_type)
457 {
458         vprint("checking for existing Lustre data: ");
459
460 #ifdef HAVE_LDISKFS_OSD
461         if (ldiskfs_is_lustre(dev, mount_type)) {
462                 vprint("found\n");
463                 return 1;
464         }
465 #endif /* HAVE_LDISKFS_OSD */
466 #ifdef HAVE_ZFS_OSD
467         if (zfs_is_lustre(dev, mount_type)) {
468                 vprint("found\n");
469                 return 1;
470         }
471 #endif /* HAVE_ZFS_OSD */
472
473         vprint("not found\n");
474         return 0;
475 }
476
477 /* Build fs according to type */
478 int osd_make_lustre(struct mkfs_opts *mop)
479 {
480         struct lustre_disk_data *ldd = &mop->mo_ldd;
481         int ret;
482
483         switch (ldd->ldd_mount_type) {
484 #ifdef HAVE_LDISKFS_OSD
485         case LDD_MT_LDISKFS:
486         case LDD_MT_LDISKFS2:
487                 ret = ldiskfs_make_lustre(mop);
488                 break;
489 #endif /* HAVE_LDISKFS_OSD */
490 #ifdef HAVE_ZFS_OSD
491         case LDD_MT_ZFS:
492                 ret = zfs_make_lustre(mop);
493                 break;
494 #endif /* HAVE_ZFS_OSD */
495         default:
496                 fatal();
497                 fprintf(stderr, "unknown fs type %d '%s'\n",
498                         ldd->ldd_mount_type, MT_STR(ldd));
499                 ret = EINVAL;
500                 break;
501         }
502
503         return ret;
504 }
505
506 int osd_prepare_lustre(struct mkfs_opts *mop,
507                 char *default_mountopts, int default_len,
508                 char *always_mountopts, int always_len)
509 {
510         struct lustre_disk_data *ldd = &mop->mo_ldd;
511         int ret;
512
513         switch (ldd->ldd_mount_type) {
514 #ifdef HAVE_LDISKFS_OSD
515         case LDD_MT_LDISKFS:
516         case LDD_MT_LDISKFS2:
517                 ret = ldiskfs_prepare_lustre(mop,
518                                              default_mountopts, default_len,
519                                              always_mountopts, always_len);
520                 break;
521 #endif /* HAVE_LDISKFS_OSD */
522 #ifdef HAVE_ZFS_OSD
523         case LDD_MT_ZFS:
524                 ret = zfs_prepare_lustre(mop,
525                                          default_mountopts, default_len,
526                                          always_mountopts, always_len);
527                 break;
528 #endif /* HAVE_ZFS_OSD */
529         default:
530                 fatal();
531                 fprintf(stderr, "unknown fs type %d '%s'\n",
532                         ldd->ldd_mount_type, MT_STR(ldd));
533                 ret = EINVAL;
534                 break;
535         }
536
537         return ret;
538 }
539
540 int osd_tune_lustre(char *dev, struct mount_opts *mop)
541 {
542         struct lustre_disk_data *ldd = &mop->mo_ldd;
543         int ret;
544
545         switch (ldd->ldd_mount_type) {
546 #ifdef HAVE_LDISKFS_OSD
547         case LDD_MT_LDISKFS:
548         case LDD_MT_LDISKFS2:
549                 ret = ldiskfs_tune_lustre(dev, mop);
550                 break;
551 #endif /* HAVE_LDISKFS_OSD */
552 #ifdef HAVE_ZFS_OSD
553         case LDD_MT_ZFS:
554                 ret = zfs_tune_lustre(dev, mop);
555                 break;
556 #endif /* HAVE_ZFS_OSD */
557         default:
558                 fatal();
559                 fprintf(stderr, "unknown fs type %d '%s'\n",
560                                 ldd->ldd_mount_type, MT_STR(ldd));
561                 ret = EINVAL;
562                 break;
563         }
564
565         return ret;
566 }
567
568 int osd_label_lustre(struct mount_opts *mop)
569 {
570         struct lustre_disk_data *ldd = &mop->mo_ldd;
571         int ret;
572
573         switch (ldd->ldd_mount_type) {
574 #ifdef HAVE_LDISKFS_OSD
575         case LDD_MT_LDISKFS:
576         case LDD_MT_LDISKFS2:
577                 ret = ldiskfs_label_lustre(mop);
578                 break;
579 #endif /* HAVE_LDISKFS_OSD */
580 #ifdef HAVE_ZFS_OSD
581         case LDD_MT_ZFS:
582                 ret = zfs_label_lustre(mop);
583                 break;
584 #endif /* HAVE_ZFS_OSD */
585         default:
586                 fatal();
587                 fprintf(stderr, "unknown fs type %d '%s'\n",
588                         ldd->ldd_mount_type, MT_STR(ldd));
589                 ret = EINVAL;
590                 break;
591         }
592
593         return ret;
594 }
595
596 /* Enable quota accounting */
597 int osd_enable_quota(struct mkfs_opts *mop)
598 {
599         struct lustre_disk_data *ldd = &mop->mo_ldd;
600         int ret;
601
602         switch (ldd->ldd_mount_type) {
603 #ifdef HAVE_LDISKFS_OSD
604         case LDD_MT_EXT3:
605         case LDD_MT_LDISKFS:
606         case LDD_MT_LDISKFS2:
607                 ret = ldiskfs_enable_quota(mop);
608                 break;
609 #endif /* HAVE_LDISKFS_OSD */
610 #ifdef HAVE_ZFS_OSD
611         case LDD_MT_ZFS:
612                 fprintf(stderr, "this option is only valid for ldiskfs\n");
613                 ret = EINVAL;
614                 break;
615 #endif /* HAVE_ZFS_OSD */
616         default:
617                 fatal();
618                 fprintf(stderr, "unknown fs type %d '%s'\n",
619                         ldd->ldd_mount_type, MT_STR(ldd));
620                 ret = EINVAL;
621                 break;
622         }
623
624         return ret;
625 }
626
627 int osd_init(void)
628 {
629         int ret = 0;
630
631 #ifdef HAVE_LDISKFS_OSD
632         ret = ldiskfs_init();
633         if (ret)
634                 return ret;
635 #endif /* HAVE_LDISKFS_OSD */
636 #ifdef HAVE_ZFS_OSD
637         ret = zfs_init();
638         /* we want to be able to set up a ldiskfs-based filesystem w/o
639          * the ZFS modules installed, see ORI-425 */
640         if (ret)
641                 ret = 0;
642 #endif /* HAVE_ZFS_OSD */
643
644         return ret;
645 }
646
647 void osd_fini(void)
648 {
649 #ifdef HAVE_LDISKFS_OSD
650         ldiskfs_fini();
651 #endif /* HAVE_LDISKFS_OSD */
652 #ifdef HAVE_ZFS_OSD
653         zfs_fini();
654 #endif /* HAVE_ZFS_OSD */
655 }
656
657 __u64 get_device_size(char* device)
658 {
659         int ret, fd;
660         __u64 size = 0;
661
662         fd = open(device, O_RDONLY);
663         if (fd < 0) {
664                 fprintf(stderr, "%s: cannot open %s: %s\n",
665                         progname, device, strerror(errno));
666                 return 0;
667         }
668
669 #ifdef BLKGETSIZE64
670         /* size in bytes. bz5831 */
671         ret = ioctl(fd, BLKGETSIZE64, (void*)&size);
672 #else
673         {
674                 __u32 lsize = 0;
675                 /* size in blocks */
676                 ret = ioctl(fd, BLKGETSIZE, (void*)&lsize);
677                 size = (__u64)lsize * 512;
678         }
679 #endif
680         close(fd);
681         if (ret < 0) {
682                 fprintf(stderr, "%s: size ioctl failed: %s\n",
683                         progname, strerror(errno));
684                 return 0;
685         }
686
687         vprint("device size = "LPU64"MB\n", size >> 20);
688         /* return value in KB */
689         return size >> 10;
690 }
691
692 int file_create(char *path, __u64 size)
693 {
694         __u64 size_max;
695         int ret;
696         int fd;
697
698         /*
699          * Since "size" is in KB, the file offset it represents could overflow
700          * off_t.
701          */
702         size_max = (off_t)1 << (_FILE_OFFSET_BITS - 1 - 10);
703         if (size >= size_max) {
704                 fprintf(stderr, "%s: %llu KB: Backing store size must be "
705                         "smaller than %llu KB\n", progname, size, size_max);
706                 return EFBIG;
707         }
708
709         ret = access(path, F_OK);
710         if (ret == 0) {
711                 ret = unlink(path);
712                 if (ret != 0)
713                         return errno;
714         }
715
716         fd = creat(path, S_IRUSR|S_IWUSR);
717         if (fd < 0) {
718                 fatal();
719                 fprintf(stderr, "%s: Unable to create backing store: %s\n",
720                         progname, strerror(errno));
721                 return errno;
722         }
723
724         ret = ftruncate(fd, size * 1024);
725         close(fd);
726         if (ret != 0) {
727                 fatal();
728                 fprintf(stderr, "%s: Unable to truncate backing store: %s\n",
729                         progname, strerror(errno));
730                 return errno;
731         }
732
733         return 0;
734 }