fbb4e36c4f9a9c7252650f7fd46a0b5bce9f77ca
[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 this.  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 <limits.h>
26 #include <stdlib.h>
27 #include <unistd.h>
28 #include <errno.h>
29 #include <string.h>
30 #include <stdio.h>
31 #include <mntent.h>
32 #include <ctype.h>
33 #include <sys/mount.h>
34 #include <fcntl.h>              // for CONFIG_FEATURE_MOUNT_LOOP
35 #include <sys/ioctl.h>  // for CONFIG_FEATURE_MOUNT_LOOP
36 #include "busybox.h"
37
38 // These two aren't always defined in old headers
39 #ifndef MS_BIND
40 #define MS_BIND         4096
41 #endif
42 #ifndef MS_MOVE
43 #define MS_MOVE         8192
44 #endif
45 #ifndef MS_SILENT
46 #define MS_SILENT       32768
47 #endif
48
49 // Not real flags, but we want to be able to check for this.
50 #define MOUNT_NOAUTO    (1<<29)
51 #define MOUNT_SWAP      (1<<30)
52 /* Standard mount options (from -o options or --options), with corresponding
53  * flags */
54
55 struct {
56         const char *name;
57         long flags;
58 } static const mount_options[] = {
59         // NOP flags.
60
61         {"loop", 0},
62         {"defaults", 0},
63         {"quiet", 0},
64
65         // vfs flags
66
67         {"ro", MS_RDONLY},
68         {"rw", ~MS_RDONLY},
69         {"nosuid", MS_NOSUID},
70         {"suid", ~MS_NOSUID},
71         {"dev", ~MS_NODEV},
72         {"nodev", MS_NODEV},
73         {"exec", ~MS_NOEXEC},
74         {"noexec", MS_NOEXEC},
75         {"sync", MS_SYNCHRONOUS},
76         {"async", ~MS_SYNCHRONOUS},
77         {"atime", ~MS_NOATIME},
78         {"noatime", MS_NOATIME},
79         {"diratime", ~MS_NODIRATIME},
80         {"nodiratime", MS_NODIRATIME},
81         {"loud", ~MS_SILENT},
82
83         // action flags
84
85         {"remount", MS_REMOUNT},
86         {"bind", MS_BIND},
87         {"move", MS_MOVE},
88         {"noauto",MOUNT_NOAUTO},
89         {"swap",MOUNT_SWAP}
90 };
91
92 /* Append mount options to string */
93 static void append_mount_options(char **oldopts, char *newopts)
94 {
95         if(*oldopts && **oldopts) {
96                 char *temp=bb_xasprintf("%s,%s",*oldopts,newopts);
97                 free(*oldopts);
98                 *oldopts=temp;
99         } else {
100                 if (ENABLE_FEATURE_CLEAN_UP) free(*oldopts);
101                 *oldopts = bb_xstrdup(newopts);
102         }
103 }
104
105 /* Use the mount_options list to parse options into flags.
106  * Return list of unrecognized options in *strflags if strflags!=NULL */
107 static int parse_mount_options(char *options, char **unrecognized)
108 {
109         int flags = MS_SILENT;
110
111         // Loop through options
112         for (;;) {
113                 int i;
114                 char *comma = strchr(options, ',');
115
116                 if (comma) *comma = 0;
117
118                 // Find this option in mount_options
119                 for (i = 0; i < (sizeof(mount_options) / sizeof(*mount_options)); i++) {
120                         if (!strcasecmp(mount_options[i].name, options)) {
121                                 long fl = mount_options[i].flags;
122                                 if(fl < 0) flags &= fl;
123                                 else flags |= fl;
124                                 break;
125                         }
126                 }
127                 // If unrecognized not NULL, append unrecognized mount options */
128                 if (unrecognized
129                                 && i == (sizeof(mount_options) / sizeof(*mount_options)))
130                 {
131                         // Add it to strflags, to pass on to kernel
132                         i = *unrecognized ? strlen(*unrecognized) : 0;
133                         *unrecognized = xrealloc(*unrecognized, i+strlen(options)+2);
134
135                         // Comma separated if it's not the first one
136                         if (i) (*unrecognized)[i++] = ',';
137                         strcpy((*unrecognized)+i, options);
138                 }
139
140                 // Advance to next option, or finish
141                 if(comma) {
142                         *comma = ',';
143                         options = ++comma;
144                 } else break;
145         }
146
147         return flags;
148 }
149
150 // Return a list of all block device backed filesystems
151
152 static llist_t *get_block_backed_filesystems(void)
153 {
154         char *fs, *buf,
155                  *filesystems[] = {"/etc/filesystems", "/proc/filesystems", 0};
156         llist_t *list = 0;
157         int i;
158         FILE *f;
159
160         for(i = 0; filesystems[i]; i++) {
161                 if(!(f = fopen(filesystems[i], "r"))) continue;
162
163                 for(fs = buf = 0; (fs = buf = bb_get_chomped_line_from_file(f));
164                         free(buf))
165                 {
166                         if(!strncmp(buf,"nodev",5) && isspace(buf[5])) continue;
167
168                         while(isspace(*fs)) fs++;
169                         if(*fs=='#' || *fs=='*') continue;
170                         if(!*fs) continue;
171
172                         list=llist_add_to_end(list,bb_xstrdup(fs));
173                 }
174                 if (ENABLE_FEATURE_CLEAN_UP) fclose(f);
175         }
176
177         return list;
178 }
179
180 llist_t *fslist = 0;
181
182 #if ENABLE_FEATURE_CLEAN_UP
183 static void delete_block_backed_filesystems(void)
184 {
185         llist_free(fslist);
186 }
187 #else
188 void delete_block_backed_filesystems(void);
189 #endif
190
191 #if ENABLE_FEATURE_MTAB_SUPPORT
192 static int useMtab;
193 static int fakeIt;
194 #else
195 #define useMtab 0
196 #define fakeIt 0
197 #endif
198
199 // Perform actual mount of specific filesystem at specific location.
200
201 static int mount_it_now(struct mntent *mp, int vfsflags, char *filteropts)
202 {
203         int rc;
204
205         if (fakeIt) { return 0; }
206
207         // Mount, with fallback to read-only if necessary.
208
209         for(;;) {
210                 rc = mount(mp->mnt_fsname, mp->mnt_dir, mp->mnt_type,
211                                 vfsflags, filteropts);
212                 if(!rc || (vfsflags&MS_RDONLY) || (errno!=EACCES && errno!=EROFS))
213                         break;
214                 bb_error_msg("%s is write-protected, mounting read-only",
215                                 mp->mnt_fsname);
216                 vfsflags |= MS_RDONLY;
217         }
218
219         // Abort entirely if permission denied.
220
221         if (rc && errno == EPERM)
222                 bb_error_msg_and_die(bb_msg_perm_denied_are_you_root);
223
224         /* If the mount was successful, and we're maintaining an old-style
225          * mtab file by hand, add the new entry to it now. */
226
227         if(ENABLE_FEATURE_MTAB_SUPPORT && useMtab && !rc) {
228                 FILE *mountTable = setmntent(bb_path_mtab_file, "a+");
229                 int i;
230
231                 if(!mountTable)
232                         bb_error_msg("No %s\n",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)
238                                 append_mount_options(&(mp->mnt_opts),
239 // Shut up about the darn const.  It's not important.  I don't care.
240                                                 (char *)mount_options[i].name);
241
242                 // Remove trailing / (if any) from directory we mounted on
243
244                 i = strlen(mp->mnt_dir);
245                 if(i>1 && mp->mnt_dir[i-1] == '/') mp->mnt_dir[i-1] = 0;
246
247                 // Write and close.
248
249                 if(!mp->mnt_type || !*mp->mnt_type) mp->mnt_type="--bind";
250                 addmntent(mountTable, mp);
251                 endmntent(mountTable);
252                 if (ENABLE_FEATURE_CLEAN_UP)
253                         if(strcmp(mp->mnt_type,"--bind")) mp->mnt_type = 0;
254         }
255
256         return rc;
257 }
258
259
260 // Mount one directory.  Handles NFS, loopback, autobind, and filesystem type
261 // detection.  Returns 0 for success, nonzero for failure.
262
263 static int singlemount(struct mntent *mp)
264 {
265         int rc = 1, vfsflags;
266         char *loopFile = 0, *filteropts = 0;
267         llist_t *fl = 0;
268         struct stat st;
269
270         vfsflags = parse_mount_options(mp->mnt_opts, &filteropts);
271
272         // Treat fstype "auto" as unspecified.
273
274         if (mp->mnt_type && !strcmp(mp->mnt_type,"auto")) mp->mnt_type = 0;
275
276         // Might this be an NFS filesystem?
277
278         if (ENABLE_FEATURE_MOUNT_NFS &&
279                 (!mp->mnt_type || !strcmp(mp->mnt_type,"nfs")) &&
280                 strchr(mp->mnt_fsname, ':') != NULL)
281         {
282                 if (nfsmount(mp->mnt_fsname, mp->mnt_dir, &vfsflags, &filteropts, 1)) {
283                         bb_perror_msg("nfsmount failed");
284                         return 1;
285                 } else {
286                         // Strangely enough, nfsmount() doesn't actually mount() anything.
287                         rc = mount_it_now(mp, vfsflags, filteropts);
288                         if (ENABLE_FEATURE_CLEAN_UP) free(filteropts);
289                         
290                         return rc;
291                 }
292         }
293
294         // Look at the file.  (Not found isn't a failure for remount.)
295
296         if (lstat(mp->mnt_fsname, &st));
297
298         if (!(vfsflags & (MS_REMOUNT | MS_BIND | MS_MOVE))) {
299                 // Do we need to allocate a loopback device for it?
300
301                 if (ENABLE_FEATURE_MOUNT_LOOP && S_ISREG(st.st_mode)) {
302                         loopFile = bb_simplify_path(mp->mnt_fsname);
303                         mp->mnt_fsname = 0;
304                         switch(set_loop(&(mp->mnt_fsname), loopFile, 0)) {
305                                 case 0:
306                                 case 1:
307                                         break;
308                                 default:
309                                         bb_error_msg( errno == EPERM || errno == EACCES
310                                                 ? bb_msg_perm_denied_are_you_root
311                                                 : "Couldn't setup loop device");
312                                         return errno;
313                         }
314
315                 // Autodetect bind mounts
316
317                 } else if (S_ISDIR(st.st_mode) && !mp->mnt_type) vfsflags |= MS_BIND;
318         }
319
320         /* If we know the fstype (or don't need to), jump straight
321          * to the actual mount. */
322
323         if (mp->mnt_type || (vfsflags & (MS_REMOUNT | MS_BIND | MS_MOVE)))
324                 rc = mount_it_now(mp, vfsflags, filteropts);
325
326         // Loop through filesystem types until mount succeeds or we run out
327
328         else {
329
330                 /* Initialize list of block backed filesystems.  This has to be
331                  * done here so that during "mount -a", mounts after /proc shows up
332                  * can autodetect. */
333
334                 if (!fslist) {
335                         fslist = get_block_backed_filesystems();
336                         if (ENABLE_FEATURE_CLEAN_UP && fslist)
337                                 atexit(delete_block_backed_filesystems);
338                 }
339
340                 for (fl = fslist; fl; fl = fl->link) {
341                         mp->mnt_type = fl->data;
342
343                         if (!(rc = mount_it_now(mp,vfsflags, filteropts))) break;
344
345                         mp->mnt_type = 0;
346                 }
347         }
348
349         if (ENABLE_FEATURE_CLEAN_UP) free(filteropts);
350
351         // If mount failed, clean up loop file (if any).
352
353         if (rc && loopFile) {
354                 del_loop(mp->mnt_fsname);
355                 if (ENABLE_FEATURE_CLEAN_UP) {
356                         free(loopFile);
357                         free(mp->mnt_fsname);
358                 }
359         }
360         return rc;
361 }
362
363
364 // Parse options, if necessary parse fstab/mtab, and call singlemount for
365 // each directory to be mounted.
366
367 int mount_main(int argc, char **argv)
368 {
369         char *cmdopts = bb_xstrdup(""), *fstabname, *fstype=0, *storage_path=0;
370         FILE *fstab;
371         int i, opt, all = FALSE, rc = 1;
372         struct mntent mtpair[2], *mtcur = mtpair;
373
374         /* parse long options, like --bind and --move.  Note that -o option
375          * and --option are synonymous.  Yes, this means --remount,rw works. */
376
377         for (i = opt = 0; i < argc; i++) {
378                 if (argv[i][0] == '-' && argv[i][1] == '-') {
379                         append_mount_options(&cmdopts,argv[i]+2);
380                 } else argv[opt++] = argv[i];
381         }
382         argc = opt;
383
384         // Parse remaining options
385
386         while ((opt = getopt(argc, argv, "o:t:rwavnf")) > 0) {
387                 switch (opt) {
388                         case 'o':
389                                 append_mount_options(&cmdopts, optarg);
390                                 break;
391                         case 't':
392                                 fstype = optarg;
393                                 break;
394                         case 'r':
395                                 append_mount_options(&cmdopts, "ro");
396                                 break;
397                         case 'w':
398                                 append_mount_options(&cmdopts, "rw");
399                                 break;
400                         case 'a':
401                                 all = TRUE;
402                                 break;
403                         case 'n':
404                                 USE_FEATURE_MTAB_SUPPORT(useMtab = FALSE;)
405                                 break;
406                         case 'f':
407                                 USE_FEATURE_MTAB_SUPPORT(fakeIt = FALSE;)
408                                 break;
409                         case 'v':
410                                 break;          // ignore -v
411                         default:
412                                 bb_show_usage();
413                 }
414         }
415
416         // Three or more non-option arguments?  Die with a usage message.
417
418         if (optind-argc>2) bb_show_usage();
419
420         // If we have no arguments, show currently mounted filesystems
421
422         if (optind == argc) {
423                 if (!all) {
424                         FILE *mountTable = setmntent(bb_path_mtab_file, "r");
425
426                         if(!mountTable) bb_error_msg_and_die("No %s",bb_path_mtab_file);
427
428                         while (getmntent_r(mountTable,mtpair,bb_common_bufsiz1,
429                                                                 sizeof(bb_common_bufsiz1)))
430                         {
431                                 // Don't show rootfs.
432                                 if (!strcmp(mtpair->mnt_fsname, "rootfs")) continue;
433
434                                 if (!fstype || !strcmp(mtpair->mnt_type, fstype))
435                                         printf("%s on %s type %s (%s)\n", mtpair->mnt_fsname,
436                                                         mtpair->mnt_dir, mtpair->mnt_type,
437                                                         mtpair->mnt_opts);
438                         }
439                         if (ENABLE_FEATURE_CLEAN_UP) endmntent(mountTable);
440                         return EXIT_SUCCESS;
441                 }
442         }
443
444         // When we have two arguments, the second is the directory and we can
445         // skip looking at fstab entirely.  We can always abspath() the directory
446         // argument when we get it.
447
448         if (optind+2 == argc) {
449                 mtpair->mnt_fsname = argv[optind];
450                 mtpair->mnt_dir = argv[optind+1];
451                 mtpair->mnt_type = fstype;
452                 mtpair->mnt_opts = cmdopts;
453                 rc = singlemount(mtpair);
454                 goto clean_up;
455         }
456
457         // If we have at least one argument, it's the storage location
458
459         if (optind < argc) storage_path = bb_simplify_path(argv[optind]);
460
461         // Open either fstab or mtab
462
463         if (parse_mount_options(cmdopts,0) & MS_REMOUNT)
464                 fstabname = (char *)bb_path_mtab_file;  // Again with the evil const.
465         else fstabname="/etc/fstab";
466
467         if (!(fstab=setmntent(fstabname,"r")))
468                 bb_perror_msg_and_die("Cannot read %s",fstabname);
469
470         // Loop through entries until we find what we're looking for.
471
472         memset(mtpair,0,sizeof(mtpair));
473         for (;;) {
474                 struct mntent *mtnext = mtpair + (mtcur==mtpair ? 1 : 0);
475
476                 // Get next fstab entry
477
478                 if (!getmntent_r(fstab, mtcur, bb_common_bufsiz1,
479                                         sizeof(bb_common_bufsiz1)))
480                 {
481                         // Were we looking for something specific?
482
483                         if (optind != argc) {
484
485                                 // If we didn't find anything, complain.
486
487                                 if (!mtnext->mnt_fsname)
488                                         bb_error_msg_and_die("Can't find %s in %s",
489                                                 argv[optind], fstabname);
490
491                                 // Mount the last thing we found.
492
493                                 mtcur = mtnext;
494                                 mtcur->mnt_opts=bb_xstrdup(mtcur->mnt_opts);
495                                 append_mount_options(&(mtcur->mnt_opts),cmdopts);
496                                 rc = singlemount(mtcur);
497                                 free(mtcur->mnt_opts);
498                         }
499                         break;
500                 }
501
502                 /* If we're trying to mount something specific and this isn't it,
503                  * skip it.  Note we must match both the exact text in fstab (ala
504                  * "proc") or a full path from root */
505
506                 if (optind != argc) {
507
508                         // Is this what we're looking for?
509
510                         if(strcmp(argv[optind],mtcur->mnt_fsname) &&
511                            strcmp(storage_path,mtcur->mnt_fsname) &&
512                            strcmp(argv[optind],mtcur->mnt_dir) &&
513                            strcmp(storage_path,mtcur->mnt_dir)) continue;
514
515                         // Remember this entry.  Something later may have overmounted
516                         // it, and we want the _last_ match.
517
518                         mtcur = mtnext;
519
520                 // If we're mounting all.
521
522                 } else {
523
524                         // Do we need to match a filesystem type?
525                         if (fstype && strcmp(mtcur->mnt_type,fstype)) continue;
526
527                         // Skip noauto and swap anyway.
528
529                         if (parse_mount_options(mtcur->mnt_opts,0)
530                                 & (MOUNT_NOAUTO | MOUNT_SWAP)) continue;
531
532                         // Mount this thing.
533
534                         rc = singlemount(mtcur);
535                         if (rc) {
536                                 // Don't whine about already mounted fs when mounting all.
537                                 if (errno == EBUSY) rc = 0;
538                                 else break;
539                         }
540                 }
541         }
542         if (ENABLE_FEATURE_CLEAN_UP) endmntent(fstab);
543
544 clean_up:
545
546         if (ENABLE_FEATURE_CLEAN_UP) {
547                 free(storage_path);
548                 free(cmdopts);
549         }
550
551         if(rc)
552                 bb_perror_msg("Mounting %s on %s failed",
553                                 mtcur->mnt_fsname, mtcur->mnt_dir);
554
555         return rc;
556 }