mount: fix mtab support (but it is still rather buggy)
[oweals/busybox.git] / util-linux / mount.c
1 /* vi: set sw=4 ts=4: */
2 /*
3  * Mini mount implementation for busybox
4  *
5  * Copyright (C) 1995, 1996 by Bruce Perens <bruce@pixar.com>.
6  * Copyright (C) 1999-2004 by Erik Andersen <andersen@codepoet.org>
7  * Copyright (C) 2005-2006 by Rob Landley <rob@landley.net>
8  *
9  * Licensed under GPLv2 or later, see file LICENSE in this tarball for details.
10  */
11
12 /* todo:
13  * bb_getopt_ulflags();
14  */
15
16 /* Design notes: There is no spec for mount.  Remind me to write one.
17
18    mount_main() calls singlemount() which calls mount_it_now().
19
20    mount_main() can loop through /etc/fstab for mount -a
21    singlemount() can loop through /etc/filesystems for fstype detection.
22    mount_it_now() does the actual mount.
23 */
24
25 #include "busybox.h"
26 #include <mntent.h>
27
28 // Not real flags, but we want to be able to check for this.
29 #define MOUNT_NOAUTO    (1<<29)
30 #define MOUNT_SWAP      (1<<30)
31
32 /* Standard mount options (from -o options or --options), with corresponding
33  * flags */
34
35 struct {
36         char *name;
37         long flags;
38 } static mount_options[] = {
39         // MS_FLAGS set a bit.  ~MS_FLAGS disable that bit.  0 flags are NOPs.
40
41         USE_FEATURE_MOUNT_LOOP(
42                 {"loop", 0},
43         )
44
45         USE_FEATURE_MOUNT_FSTAB(
46                 {"defaults", 0},
47                 {"quiet", 0},
48                 {"noauto",MOUNT_NOAUTO},
49                 {"swap",MOUNT_SWAP},
50         )
51
52         USE_FEATURE_MOUNT_FLAGS(
53                 // vfs flags
54                 {"nosuid", MS_NOSUID},
55                 {"suid", ~MS_NOSUID},
56                 {"dev", ~MS_NODEV},
57                 {"nodev", MS_NODEV},
58                 {"exec", ~MS_NOEXEC},
59                 {"noexec", MS_NOEXEC},
60                 {"sync", MS_SYNCHRONOUS},
61                 {"async", ~MS_SYNCHRONOUS},
62                 {"atime", ~MS_NOATIME},
63                 {"noatime", MS_NOATIME},
64                 {"diratime", ~MS_NODIRATIME},
65                 {"nodiratime", MS_NODIRATIME},
66                 {"loud", ~MS_SILENT},
67
68                 // action flags
69
70                 {"bind", MS_BIND},
71                 {"move", MS_MOVE},
72                 {"shared", MS_SHARED},
73                 {"slave", MS_SLAVE},
74                 {"private", MS_PRIVATE},
75                 {"unbindable", MS_UNBINDABLE},
76                 {"rshared", MS_SHARED|MS_RECURSIVE},
77                 {"rslave", MS_SLAVE|MS_RECURSIVE},
78                 {"rprivate", MS_SLAVE|MS_RECURSIVE},
79                 {"runbindable", MS_UNBINDABLE|MS_RECURSIVE},
80         )
81
82         // Always understood.
83
84         {"ro", MS_RDONLY},        // vfs flag
85         {"rw", ~MS_RDONLY},       // vfs flag
86         {"remount", MS_REMOUNT},  // action flag
87
88
89 };
90
91 /* Append mount options to string */
92 static void append_mount_options(char **oldopts, char *newopts)
93 {
94         if(*oldopts && **oldopts) {
95                 char *temp = xasprintf("%s,%s",*oldopts,newopts);
96                 free(*oldopts);
97                 *oldopts = temp;
98         } else {
99                 if (ENABLE_FEATURE_CLEAN_UP) free(*oldopts);
100                 *oldopts = xstrdup(newopts);
101         }
102 }
103
104 /* Use the mount_options list to parse options into flags.
105  * Also return list of unrecognized options if unrecognized!=NULL */
106 static int parse_mount_options(char *options, char **unrecognized)
107 {
108         int flags = MS_SILENT;
109
110         // Loop through options
111         for (;;) {
112                 int i;
113                 char *comma = strchr(options, ',');
114
115                 if (comma) *comma = 0;
116
117                 // Find this option in mount_options
118                 for (i = 0; i < (sizeof(mount_options) / sizeof(*mount_options)); i++) {
119                         if (!strcasecmp(mount_options[i].name, options)) {
120                                 long fl = mount_options[i].flags;
121                                 if(fl < 0) flags &= fl;
122                                 else flags |= fl;
123                                 break;
124                         }
125                 }
126                 // If unrecognized not NULL, append unrecognized mount options */
127                 if (unrecognized
128                                 && i == (sizeof(mount_options) / sizeof(*mount_options)))
129                 {
130                         // Add it to strflags, to pass on to kernel
131                         i = *unrecognized ? strlen(*unrecognized) : 0;
132                         *unrecognized = xrealloc(*unrecognized, i+strlen(options)+2);
133
134                         // Comma separated if it's not the first one
135                         if (i) (*unrecognized)[i++] = ',';
136                         strcpy((*unrecognized)+i, options);
137                 }
138
139                 // Advance to next option, or finish
140                 if(comma) {
141                         *comma = ',';
142                         options = ++comma;
143                 } else break;
144         }
145
146         return flags;
147 }
148
149 // Return a list of all block device backed filesystems
150
151 static llist_t *get_block_backed_filesystems(void)
152 {
153         char *fs, *buf,
154                  *filesystems[] = {"/etc/filesystems", "/proc/filesystems", 0};
155         llist_t *list = 0;
156         int i;
157         FILE *f;
158
159         for(i = 0; filesystems[i]; i++) {
160                 if(!(f = fopen(filesystems[i], "r"))) continue;
161
162                 for(fs = buf = 0; (fs = buf = bb_get_chomped_line_from_file(f));
163                         free(buf))
164                 {
165                         if(!strncmp(buf,"nodev",5) && isspace(buf[5])) continue;
166
167                         while(isspace(*fs)) fs++;
168                         if(*fs=='#' || *fs=='*') continue;
169                         if(!*fs) continue;
170
171                         llist_add_to_end(&list,xstrdup(fs));
172                 }
173                 if (ENABLE_FEATURE_CLEAN_UP) fclose(f);
174         }
175
176         return list;
177 }
178
179 llist_t *fslist = 0;
180
181 #if ENABLE_FEATURE_CLEAN_UP
182 static void delete_block_backed_filesystems(void)
183 {
184         llist_free(fslist, free);
185 }
186 #else
187 void delete_block_backed_filesystems(void);
188 #endif
189
190 #if ENABLE_FEATURE_MTAB_SUPPORT
191 static int useMtab = 1;
192 static int fakeIt;
193 #else
194 #define useMtab 0
195 #define fakeIt 0
196 #endif
197
198 // Perform actual mount of specific filesystem at specific location.
199 int mount_it_now(struct mntent *mp, int vfsflags, char *filteropts)
200 {
201         int rc;
202
203         if (fakeIt) { return 0; }
204
205         // Mount, with fallback to read-only if necessary.
206
207         for(;;) {
208                 rc = mount(mp->mnt_fsname, mp->mnt_dir, mp->mnt_type,
209                                 vfsflags, filteropts);
210                 if(!rc || (vfsflags&MS_RDONLY) || (errno!=EACCES && errno!=EROFS))
211                         break;
212                 bb_error_msg("%s is write-protected, mounting read-only",
213                                 mp->mnt_fsname);
214                 vfsflags |= MS_RDONLY;
215         }
216
217         // Abort entirely if permission denied.
218
219         if (rc && errno == EPERM)
220                 bb_error_msg_and_die(bb_msg_perm_denied_are_you_root);
221
222         /* If the mount was successful, and we're maintaining an old-style
223          * mtab file by hand, add the new entry to it now. */
224
225         if(ENABLE_FEATURE_MTAB_SUPPORT && useMtab && !rc) {
226                 char dirbuf[PATH_MAX];
227                 char srcbuf[PATH_MAX];
228                 FILE *mountTable = setmntent(bb_path_mtab_file, "a+");
229                 int i;
230
231                 if(!mountTable)
232                         bb_error_msg("no %s",bb_path_mtab_file);
233
234                 // Add vfs string flags
235
236                 for(i=0; mount_options[i].flags != MS_REMOUNT; i++)
237                         if (mount_options[i].flags > 0 && (mount_options[i].flags&vfsflags))
238                                 append_mount_options(&(mp->mnt_opts), mount_options[i].name);
239
240                 // Remove trailing / (if any) from directory we mounted on
241
242                 i = strlen(mp->mnt_dir) - 1;
243                 if(i > 0 && mp->mnt_dir[i] == '/') mp->mnt_dir[i] = 0;
244
245                 // Add full pathnames as needed
246
247                 if (mp->mnt_dir[0] != '/') {
248                         getcwd(dirbuf, sizeof(dirbuf));
249                         i = strlen(dirbuf);
250                         /* strcat() would be unsafe here */
251                         snprintf(dirbuf+i, sizeof(dirbuf)-i, "/%s", mp->mnt_dir);
252                         mp->mnt_dir = dirbuf;
253                 }
254                 if (!mp->mnt_type || !*mp->mnt_type) { /* bind mount */
255                         if (mp->mnt_fsname[0] != '/') {
256                                 getcwd(srcbuf, sizeof(srcbuf));
257                                 i = strlen(srcbuf);
258                                 snprintf(srcbuf+i, sizeof(srcbuf)-i, "/%s",
259                                                 mp->mnt_fsname);
260                                 mp->mnt_fsname = srcbuf;
261                         }
262                         mp->mnt_type = "none";
263                         mp->mnt_freq = mp->mnt_passno = 0;
264                 }
265
266                 // Write and close.
267
268                 addmntent(mountTable, mp);
269                 endmntent(mountTable);
270         }
271
272         return rc;
273 }
274
275 // Mount one directory.  Handles CIFS, NFS, loopback, autobind, and filesystem
276 // type detection.  Returns 0 for success, nonzero for failure.
277
278 static int singlemount(struct mntent *mp, int ignore_busy)
279 {
280         int rc = -1, vfsflags;
281         char *loopFile = 0, *filteropts = 0;
282         llist_t *fl = 0;
283         struct stat st;
284
285         vfsflags = parse_mount_options(mp->mnt_opts, &filteropts);
286
287         // Treat fstype "auto" as unspecified.
288
289         if (mp->mnt_type && !strcmp(mp->mnt_type,"auto")) mp->mnt_type = 0;
290
291         // Might this be an CIFS filesystem?
292
293         if(ENABLE_FEATURE_MOUNT_CIFS &&
294                 (!mp->mnt_type || !strcmp(mp->mnt_type,"cifs")) &&
295                 (mp->mnt_fsname[0]==mp->mnt_fsname[1] && (mp->mnt_fsname[0]=='/' || mp->mnt_fsname[0]=='\\')))
296         {
297                 struct hostent *he;
298                 char ip[32], *s;
299
300                 rc = 1;
301                 // Replace '/' with '\' and verify that unc points to "//server/share".
302
303                 for (s = mp->mnt_fsname; *s; ++s)
304                         if (*s == '/') *s = '\\';
305
306                 // get server IP
307
308                 s = strrchr(mp->mnt_fsname, '\\');
309                 if (s == mp->mnt_fsname+1) goto report_error;
310                 *s = 0;
311                 he = gethostbyname(mp->mnt_fsname+2);
312                 *s = '\\';
313                 if (!he) goto report_error;
314
315                 // Insert ip=... option into string flags.  (NOTE: Add IPv6 support.)
316
317                 sprintf(ip, "ip=%d.%d.%d.%d", he->h_addr[0], he->h_addr[1],
318                                 he->h_addr[2], he->h_addr[3]);
319                 parse_mount_options(ip, &filteropts);
320
321                 // compose new unc '\\server-ip\share'
322
323                 s = xasprintf("\\\\%s%s",ip+3,strchr(mp->mnt_fsname+2,'\\'));
324                 if (ENABLE_FEATURE_CLEAN_UP) free(mp->mnt_fsname);
325                 mp->mnt_fsname = s;
326
327                 // lock is required
328                 vfsflags |= MS_MANDLOCK;
329
330                 mp->mnt_type = "cifs";
331                 rc = mount_it_now(mp, vfsflags, filteropts);
332                 goto report_error;
333         }
334
335         // Might this be an NFS filesystem?
336
337         if (ENABLE_FEATURE_MOUNT_NFS &&
338                 (!mp->mnt_type || !strcmp(mp->mnt_type,"nfs")) &&
339                 strchr(mp->mnt_fsname, ':') != NULL)
340         {
341                 rc = nfsmount(mp, vfsflags, filteropts);
342                 goto report_error;
343         }
344
345         // Look at the file.  (Not found isn't a failure for remount, or for
346         // a synthetic filesystem like proc or sysfs.)
347
348         if (!lstat(mp->mnt_fsname, &st) && !(vfsflags & (MS_REMOUNT | MS_BIND | MS_MOVE)))
349         {
350                 // Do we need to allocate a loopback device for it?
351
352                 if (ENABLE_FEATURE_MOUNT_LOOP && S_ISREG(st.st_mode)) {
353                         loopFile = bb_simplify_path(mp->mnt_fsname);
354                         mp->mnt_fsname = 0;
355                         switch(set_loop(&(mp->mnt_fsname), loopFile, 0)) {
356                                 case 0:
357                                 case 1:
358                                         break;
359                                 default:
360                                         bb_error_msg( errno == EPERM || errno == EACCES
361                                                 ? bb_msg_perm_denied_are_you_root
362                                                 : "cannot setup loop device");
363                                         return errno;
364                         }
365
366                 // Autodetect bind mounts
367
368                 } else if (S_ISDIR(st.st_mode) && !mp->mnt_type)
369                         vfsflags |= MS_BIND;
370         }
371
372         /* If we know the fstype (or don't need to), jump straight
373          * to the actual mount. */
374
375         if (mp->mnt_type || (vfsflags & (MS_REMOUNT | MS_BIND | MS_MOVE)))
376                 rc = mount_it_now(mp, vfsflags, filteropts);
377
378         // Loop through filesystem types until mount succeeds or we run out
379
380         else {
381
382                 /* Initialize list of block backed filesystems.  This has to be
383                  * done here so that during "mount -a", mounts after /proc shows up
384                  * can autodetect. */
385
386                 if (!fslist) {
387                         fslist = get_block_backed_filesystems();
388                         if (ENABLE_FEATURE_CLEAN_UP && fslist)
389                                 atexit(delete_block_backed_filesystems);
390                 }
391
392                 for (fl = fslist; fl; fl = fl->link) {
393                         mp->mnt_type = fl->data;
394
395                         if (!(rc = mount_it_now(mp,vfsflags, filteropts))) break;
396
397                         mp->mnt_type = 0;
398                 }
399         }
400
401         // If mount failed, clean up loop file (if any).
402
403         if (ENABLE_FEATURE_MOUNT_LOOP && rc && loopFile) {
404                 del_loop(mp->mnt_fsname);
405                 if (ENABLE_FEATURE_CLEAN_UP) {
406                         free(loopFile);
407                         free(mp->mnt_fsname);
408                 }
409         }
410
411 report_error:
412         if (ENABLE_FEATURE_CLEAN_UP) free(filteropts);
413
414         if (rc && errno == EBUSY && ignore_busy) rc = 0;
415         if (rc < 0)
416                 /* perror here sometimes says "mounting ... on ... failed: Success" */
417                 bb_error_msg("mounting %s on %s failed", mp->mnt_fsname, mp->mnt_dir);
418
419         return rc;
420 }
421
422 // Parse options, if necessary parse fstab/mtab, and call singlemount for
423 // each directory to be mounted.
424
425 int mount_main(int argc, char **argv)
426 {
427         char *cmdopts = xstrdup(""), *fstabname, *fstype=0, *storage_path=0;
428         FILE *fstab;
429         int i, opt, all = FALSE, rc = 0;
430         struct mntent mtpair[2], *mtcur = mtpair;
431
432         /* parse long options, like --bind and --move.  Note that -o option
433          * and --option are synonymous.  Yes, this means --remount,rw works. */
434
435         for (i = opt = 0; i < argc; i++) {
436                 if (argv[i][0] == '-' && argv[i][1] == '-') {
437                         append_mount_options(&cmdopts,argv[i]+2);
438                 } else argv[opt++] = argv[i];
439         }
440         argc = opt;
441
442         // Parse remaining options
443
444         while ((opt = getopt(argc, argv, "o:t:rwavnf")) > 0) {
445                 switch (opt) {
446                         case 'o':
447                                 append_mount_options(&cmdopts, optarg);
448                                 break;
449                         case 't':
450                                 fstype = optarg;
451                                 break;
452                         case 'r':
453                                 append_mount_options(&cmdopts, "ro");
454                                 break;
455                         case 'w':
456                                 append_mount_options(&cmdopts, "rw");
457                                 break;
458                         case 'a':
459                                 all = TRUE;
460                                 break;
461                         case 'n':
462                                 USE_FEATURE_MTAB_SUPPORT(useMtab = FALSE;)
463                                 break;
464                         case 'f':
465                                 USE_FEATURE_MTAB_SUPPORT(fakeIt = FALSE;)
466                                 break;
467                         case 'v':
468                                 break;          // ignore -v
469                         default:
470                                 bb_show_usage();
471                 }
472         }
473
474         // Three or more non-option arguments?  Die with a usage message.
475
476         if (optind-argc>2) bb_show_usage();
477
478         // If we have no arguments, show currently mounted filesystems
479
480         if (optind == argc) {
481                 if (!all) {
482                         FILE *mountTable = setmntent(bb_path_mtab_file, "r");
483
484                         if(!mountTable) bb_error_msg_and_die("no %s",bb_path_mtab_file);
485
486                         while (getmntent_r(mountTable,mtpair,bb_common_bufsiz1,
487                                                                 sizeof(bb_common_bufsiz1)))
488                         {
489                                 // Don't show rootfs.
490                                 if (!strcmp(mtpair->mnt_fsname, "rootfs")) continue;
491
492                                 if (!fstype || !strcmp(mtpair->mnt_type, fstype))
493                                         printf("%s on %s type %s (%s)\n", mtpair->mnt_fsname,
494                                                         mtpair->mnt_dir, mtpair->mnt_type,
495                                                         mtpair->mnt_opts);
496                         }
497                         if (ENABLE_FEATURE_CLEAN_UP) endmntent(mountTable);
498                         return EXIT_SUCCESS;
499                 }
500         } else storage_path = bb_simplify_path(argv[optind]);
501
502         // When we have two arguments, the second is the directory and we can
503         // skip looking at fstab entirely.  We can always abspath() the directory
504         // argument when we get it.
505
506         if (optind+2 == argc) {
507                 mtpair->mnt_fsname = argv[optind];
508                 mtpair->mnt_dir = argv[optind+1];
509                 mtpair->mnt_type = fstype;
510                 mtpair->mnt_opts = cmdopts;
511                 rc = singlemount(mtpair, 0);
512                 goto clean_up;
513         }
514
515         // If we have a shared subtree flag, don't worry about fstab or mtab.
516         i = parse_mount_options(cmdopts,0);
517         if (ENABLE_FEATURE_MOUNT_FLAGS &&
518                         (i & (MS_SHARED | MS_PRIVATE | MS_SLAVE | MS_UNBINDABLE )))
519         {
520                 rc = mount("", argv[optind], "", i, "");
521                 if (rc) bb_perror_msg_and_die("%s", argv[optind]);
522                 goto clean_up;
523         }
524         
525         // Open either fstab or mtab
526
527         if (parse_mount_options(cmdopts,0) & MS_REMOUNT)
528                 fstabname = bb_path_mtab_file;
529         else fstabname="/etc/fstab";
530
531         if (!(fstab=setmntent(fstabname,"r")))
532                 bb_perror_msg_and_die("cannot read %s",fstabname);
533
534         // Loop through entries until we find what we're looking for.
535
536         memset(mtpair,0,sizeof(mtpair));
537         for (;;) {
538                 struct mntent *mtnext = mtpair + (mtcur==mtpair ? 1 : 0);
539
540                 // Get next fstab entry
541
542                 if (!getmntent_r(fstab, mtcur, bb_common_bufsiz1
543                                         + (mtcur==mtpair ? sizeof(bb_common_bufsiz1)/2 : 0),
544                                 sizeof(bb_common_bufsiz1)/2))
545                 {
546                         // Were we looking for something specific?
547
548                         if (optind != argc) {
549
550                                 // If we didn't find anything, complain.
551
552                                 if (!mtnext->mnt_fsname)
553                                         bb_error_msg_and_die("can't find %s in %s",
554                                                 argv[optind], fstabname);
555
556                                 // Mount the last thing we found.
557
558                                 mtcur = mtnext;
559                                 mtcur->mnt_opts = xstrdup(mtcur->mnt_opts);
560                                 append_mount_options(&(mtcur->mnt_opts),cmdopts);
561                                 rc = singlemount(mtcur, 0);
562                                 free(mtcur->mnt_opts);
563                         }
564                         goto clean_up;
565                 }
566
567                 /* If we're trying to mount something specific and this isn't it,
568                  * skip it.  Note we must match both the exact text in fstab (ala
569                  * "proc") or a full path from root */
570
571                 if (optind != argc) {
572
573                         // Is this what we're looking for?
574
575                         if(strcmp(argv[optind],mtcur->mnt_fsname) &&
576                            strcmp(storage_path,mtcur->mnt_fsname) &&
577                            strcmp(argv[optind],mtcur->mnt_dir) &&
578                            strcmp(storage_path,mtcur->mnt_dir)) continue;
579
580                         // Remember this entry.  Something later may have overmounted
581                         // it, and we want the _last_ match.
582
583                         mtcur = mtnext;
584
585                 // If we're mounting all.
586
587                 } else {
588
589                         // Do we need to match a filesystem type?
590                         if (fstype && strcmp(mtcur->mnt_type,fstype)) continue;
591
592                         // Skip noauto and swap anyway.
593
594                         if (parse_mount_options(mtcur->mnt_opts,0)
595                                 & (MOUNT_NOAUTO | MOUNT_SWAP)) continue;
596
597                         // Mount this thing.
598
599                         if (singlemount(mtcur, 1)) {
600                                 /* Count number of failed mounts */
601                                 rc++;
602                         }
603                 }
604         }
605         if (ENABLE_FEATURE_CLEAN_UP) endmntent(fstab);
606
607 clean_up:
608
609         if (ENABLE_FEATURE_CLEAN_UP) {
610                 free(storage_path);
611                 free(cmdopts);
612         }
613
614         return rc;
615 }