1 /* grub-mount.c - FUSE driver for filesystems that GRUB understands */
3 * GRUB -- GRand Unified Bootloader
4 * Copyright (C) 2008,2009,2010 Free Software Foundation, Inc.
6 * GRUB is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
11 * GRUB is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with GRUB. If not, see <http://www.gnu.org/licenses/>.
19 #define FUSE_USE_VERSION 26
21 #include <grub/types.h>
22 #include <grub/emu/misc.h>
23 #include <grub/util/misc.h>
24 #include <grub/misc.h>
25 #include <grub/device.h>
26 #include <grub/disk.h>
27 #include <grub/file.h>
30 #include <grub/term.h>
32 #include <grub/lib/hexdump.h>
33 #include <grub/crypto.h>
34 #include <grub/command.h>
35 #include <grub/zfs/zfs.h>
36 #include <grub/i18n.h>
37 #include <fuse/fuse.h>
44 #pragma GCC diagnostic ignored "-Wmissing-prototypes"
45 #pragma GCC diagnostic ignored "-Wmissing-declarations"
47 #pragma GCC diagnostic error "-Wmissing-prototypes"
48 #pragma GCC diagnostic error "-Wmissing-declarations"
52 static const char *root
= NULL
;
53 grub_device_t dev
= NULL
;
55 static char **images
= NULL
;
56 static char *debug_str
= NULL
;
57 static char **fuse_args
= NULL
;
58 static int fuse_argc
= 0;
59 static int num_disks
= 0;
60 static int mount_crypt
= 0;
63 execute_command (const char *name
, int n
, char **args
)
67 cmd
= grub_command_find (name
);
69 grub_util_error (_("can't find command `%s'"), name
);
71 return (cmd
->func
) (cmd
, n
, args
);
74 /* Translate GRUB error numbers into OS error numbers. Print any unexpected
77 translate_error (void)
87 case GRUB_ERR_OUT_OF_MEMORY
:
92 case GRUB_ERR_BAD_FILE_TYPE
:
93 /* This could also be EISDIR. Take a guess. */
97 case GRUB_ERR_FILE_NOT_FOUND
:
101 case GRUB_ERR_FILE_READ_ERROR
:
102 case GRUB_ERR_READ_ERROR
:
108 case GRUB_ERR_SYMLINK_LOOP
:
118 /* Any previous errors were handled. */
119 grub_errno
= GRUB_ERR_NONE
;
124 /* Context for fuse_getattr. */
125 struct fuse_getattr_ctx
128 struct grub_dirhook_info file_info
;
132 /* A hook for iterating directories. */
134 fuse_getattr_find_file (const char *cur_filename
,
135 const struct grub_dirhook_info
*info
, void *data
)
137 struct fuse_getattr_ctx
*ctx
= data
;
139 if ((info
->case_insensitive
? grub_strcasecmp (cur_filename
, ctx
->filename
)
140 : grub_strcmp (cur_filename
, ctx
->filename
)) == 0)
142 ctx
->file_info
= *info
;
143 ctx
->file_exists
= 1;
150 fuse_getattr (const char *path
, struct stat
*st
)
152 struct fuse_getattr_ctx ctx
;
153 char *pathname
, *path2
;
154 const char *pathname_t
;
156 if (path
[0] == '/' && path
[1] == 0)
160 st
->st_mode
= 0555 | S_IFDIR
;
165 st
->st_blksize
= 512;
166 st
->st_blocks
= (st
->st_blksize
+ 511) >> 9;
167 st
->st_atime
= st
->st_mtime
= st
->st_ctime
= 0;
173 pathname_t
= grub_strchr (path
, ')');
178 pathname
= xstrdup (pathname_t
);
180 /* Remove trailing '/'. */
181 while (*pathname
&& pathname
[grub_strlen (pathname
) - 1] == '/')
182 pathname
[grub_strlen (pathname
) - 1] = 0;
184 /* Split into path and filename. */
185 ctx
.filename
= grub_strrchr (pathname
, '/');
188 path2
= grub_strdup ("/");
189 ctx
.filename
= pathname
;
194 path2
= grub_strdup (pathname
);
195 path2
[ctx
.filename
- pathname
] = 0;
198 /* It's the whole device. */
199 (fs
->dir
) (dev
, path2
, fuse_getattr_find_file
, &ctx
);
202 if (!ctx
.file_exists
)
204 grub_errno
= GRUB_ERR_NONE
;
209 st
->st_mode
= ctx
.file_info
.dir
? (0555 | S_IFDIR
) : (0444 | S_IFREG
);
214 if (!ctx
.file_info
.dir
)
217 file
= grub_file_open (path
);
218 if (! file
&& grub_errno
== GRUB_ERR_BAD_FILE_TYPE
)
220 grub_errno
= GRUB_ERR_NONE
;
221 st
->st_mode
= (0555 | S_IFDIR
);
224 return translate_error ();
227 st
->st_size
= file
->size
;
228 grub_file_close (file
);
231 st
->st_blksize
= 512;
232 st
->st_blocks
= (st
->st_size
+ 511) >> 9;
233 st
->st_atime
= st
->st_mtime
= st
->st_ctime
= ctx
.file_info
.mtimeset
234 ? ctx
.file_info
.mtime
: 0;
235 grub_errno
= GRUB_ERR_NONE
;
240 fuse_opendir (const char *path
, struct fuse_file_info
*fi
)
246 static grub_file_t files
[65536];
247 static int first_fd
= 1;
250 fuse_open (const char *path
, struct fuse_file_info
*fi
__attribute__ ((unused
)))
253 file
= grub_file_open (path
);
255 return translate_error ();
256 files
[first_fd
++] = file
;
258 files
[first_fd
++] = file
;
259 grub_errno
= GRUB_ERR_NONE
;
264 fuse_read (const char *path
, char *buf
, size_t sz
, off_t off
,
265 struct fuse_file_info
*fi
)
267 grub_file_t file
= files
[fi
->fh
];
270 if (off
> file
->size
)
275 size
= grub_file_read (file
, buf
, sz
);
277 return translate_error ();
280 grub_errno
= GRUB_ERR_NONE
;
286 fuse_release (const char *path
, struct fuse_file_info
*fi
)
288 grub_file_close (files
[fi
->fh
]);
289 files
[fi
->fh
] = NULL
;
290 grub_errno
= GRUB_ERR_NONE
;
294 /* Context for fuse_readdir. */
295 struct fuse_readdir_ctx
299 fuse_fill_dir_t fill
;
302 /* Helper for fuse_readdir. */
304 fuse_readdir_call_fill (const char *filename
,
305 const struct grub_dirhook_info
*info
, void *data
)
307 struct fuse_readdir_ctx
*ctx
= data
;
310 grub_memset (&st
, 0, sizeof (st
));
311 st
.st_mode
= info
->dir
? (0555 | S_IFDIR
) : (0444 | S_IFREG
);
316 tmp
= xasprintf ("%s/%s", ctx
->path
, filename
);
317 file
= grub_file_open (tmp
);
319 /* Symlink to directory. */
320 if (! file
&& grub_errno
== GRUB_ERR_BAD_FILE_TYPE
)
322 grub_errno
= GRUB_ERR_NONE
;
323 st
.st_mode
= (0555 | S_IFDIR
);
327 grub_errno
= GRUB_ERR_NONE
;
331 st
.st_size
= file
->size
;
332 grub_file_close (file
);
336 st
.st_blocks
= (st
.st_size
+ 511) >> 9;
337 st
.st_atime
= st
.st_mtime
= st
.st_ctime
338 = info
->mtimeset
? info
->mtime
: 0;
339 ctx
->fill (ctx
->buf
, filename
, &st
, 0);
344 fuse_readdir (const char *path
, void *buf
,
345 fuse_fill_dir_t fill
, off_t off
, struct fuse_file_info
*fi
)
347 struct fuse_readdir_ctx ctx
= {
354 pathname
= xstrdup (path
);
356 /* Remove trailing '/'. */
357 while (pathname
[0] && pathname
[1]
358 && pathname
[grub_strlen (pathname
) - 1] == '/')
359 pathname
[grub_strlen (pathname
) - 1] = 0;
361 (fs
->dir
) (dev
, pathname
, fuse_readdir_call_fill
, &ctx
);
363 grub_errno
= GRUB_ERR_NONE
;
367 struct fuse_operations grub_opers
= {
368 .getattr
= fuse_getattr
,
370 .release
= fuse_release
,
371 .opendir
= fuse_opendir
,
372 .readdir
= fuse_readdir
,
381 for (i
= 0; i
< num_disks
; i
++)
386 loop_name
= grub_xasprintf ("loop%d", i
);
388 grub_util_error ("%s", grub_errmsg
);
390 host_file
= grub_xasprintf ("(host)%s", images
[i
]);
392 grub_util_error ("%s", grub_errmsg
);
397 if (execute_command ("loopback", 2, argv
))
398 grub_util_error (_("`loopback' command fails: %s"), grub_errmsg
);
400 grub_free (loop_name
);
401 grub_free (host_file
);
406 char *argv
[2] = { xstrdup ("-a"), NULL
};
407 if (execute_command ("cryptomount", 1, argv
))
408 grub_util_error (_("`cryptomount' command fails: %s"),
414 grub_mdraid09_fini ();
415 grub_mdraid1x_fini ();
416 grub_diskfilter_fini ();
417 grub_diskfilter_init ();
418 grub_mdraid09_init ();
419 grub_mdraid1x_init ();
422 dev
= grub_device_open (0);
426 fs
= grub_fs_probe (dev
);
429 grub_device_close (dev
);
433 if (fuse_main (fuse_argc
, fuse_args
, &grub_opers
, NULL
))
434 grub_error (GRUB_ERR_IO
, "fuse_main failed");
436 for (i
= 0; i
< num_disks
; i
++)
441 loop_name
= grub_xasprintf ("loop%d", i
);
443 grub_util_error ("%s", grub_errmsg
);
445 argv
[0] = xstrdup ("-d");
448 execute_command ("loopback", 2, argv
);
451 grub_free (loop_name
);
457 static struct argp_option options
[] = {
458 {"root", 'r', N_("DEVICE_NAME"), 0, N_("Set root device."), 2},
459 {"debug", 'd', N_("STRING"), 0, N_("Set debug environment variable."), 2},
460 {"crypto", 'C', NULL
, 0, N_("Mount crypto devices."), 2},
462 /* TRANSLATORS: "prompt" is a keyword. */
463 N_("FILE|prompt"), 0, N_("Load zfs crypto key."), 2},
464 {"verbose", 'v', NULL
, 0, N_("print verbose messages."), 2},
468 /* Print the version information. */
470 print_version (FILE *stream
, struct argp_state
*state
)
472 fprintf (stream
, "%s (%s) %s\n", program_name
, PACKAGE_NAME
, PACKAGE_VERSION
);
474 void (*argp_program_version_hook
) (FILE *, struct argp_state
*) = print_version
;
477 argp_parser (int key
, char *arg
, struct argp_state
*state
)
486 if (strcmp (arg
, "prompt") == 0)
489 grub_printf ("%s", _("Enter ZFS password: "));
490 if (grub_password_get (buf
, 1023))
492 grub_zfs_add_key ((grub_uint8_t
*) buf
, grub_strlen (buf
), 1);
499 grub_uint8_t buf
[1024];
500 f
= grub_util_fopen (arg
, "rb");
503 printf (_("%s: error:"), program_name
);
504 printf (_("cannot open `%s': %s"), arg
, strerror (errno
));
508 real_size
= fread (buf
, 1, 1024, f
);
511 printf (_("%s: error:"), program_name
);
512 printf (_("cannot read `%s': %s"), arg
,
518 grub_zfs_add_key (buf
, real_size
, 0);
543 fuse_args
= xrealloc (fuse_args
, (fuse_argc
+ 1) * sizeof (fuse_args
[0]));
544 fuse_args
[fuse_argc
] = xstrdup (arg
);
549 images
= xrealloc (images
, (num_disks
+ 1) * sizeof (images
[0]));
550 images
[num_disks
] = canonicalize_file_name (arg
);
557 options
, argp_parser
, N_("IMAGE1 [IMAGE2 ...] MOUNTPOINT"),
558 N_("Debug tool for filesystem driver."),
563 main (int argc
, char *argv
[])
565 const char *default_root
;
568 grub_util_host_init (&argc
, &argv
);
570 fuse_args
= xrealloc (fuse_args
, (fuse_argc
+ 2) * sizeof (fuse_args
[0]));
571 fuse_args
[fuse_argc
] = xstrdup (argv
[0]);
573 /* Run single-threaded. */
574 fuse_args
[fuse_argc
] = xstrdup ("-s");
577 argp_parse (&argp
, argc
, argv
, 0, 0, 0);
580 grub_util_error ("%s", _("need an image and mountpoint"));
581 fuse_args
= xrealloc (fuse_args
, (fuse_argc
+ 2) * sizeof (fuse_args
[0]));
582 fuse_args
[fuse_argc
] = images
[num_disks
- 1];
585 fuse_args
[fuse_argc
] = NULL
;
587 /* Initialize all modules. */
591 grub_env_set ("debug", debug_str
);
593 default_root
= (num_disks
== 1) ? "loop0" : "md0";
597 if ((*root
>= '0') && (*root
<= '9'))
599 alloc_root
= xmalloc (strlen (default_root
) + strlen (root
) + 2);
601 sprintf (alloc_root
, "%s,%s", default_root
, root
);
608 grub_env_set ("root", root
);
621 /* Free resources. */