4 * This file implements mounting of WIM files using FUSE, which stands for
5 * Filesystem in Userspace. FUSE allows a filesystem to be implemented in a
6 * userspace process by implementing the filesystem primitives--- read(),
7 * write(), readdir(), etc.
11 * Copyright (C) 2012, 2013, 2014 Eric Biggers
13 * This file is part of wimlib, a library for working with WIM files.
15 * wimlib is free software; you can redistribute it and/or modify it under the
16 * terms of the GNU General Public License as published by the Free
17 * Software Foundation; either version 3 of the License, or (at your option)
20 * wimlib is distributed in the hope that it will be useful, but WITHOUT ANY
21 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
22 * A PARTICULAR PURPOSE. See the GNU General Public License for more
25 * You should have received a copy of the GNU General Public License
26 * along with wimlib; if not, see http://www.gnu.org/licenses/.
34 #include "wimlib/error.h"
39 # error "FUSE mount not supported on Win32! Please configure --without-fuse"
42 #include "wimlib/encoding.h"
43 #include "wimlib/file_io.h"
44 #include "wimlib/dentry.h"
45 #include "wimlib/inode.h"
46 #include "wimlib/lookup_table.h"
47 #include "wimlib/metadata.h"
48 #include "wimlib/paths.h"
49 #include "wimlib/reparse.h"
50 #include "wimlib/resource.h"
51 #include "wimlib/timestamp.h"
52 #include "wimlib/version.h"
53 #include "wimlib/write.h"
54 #include "wimlib/xml.h"
65 #include <sys/types.h>
70 #define FUSE_USE_VERSION 26
74 #include <attr/xattr.h>
77 #define MSG_VERSION_TOO_HIGH -1
78 #define MSG_BREAK_LOOP -2
80 /* File descriptor to a file open on the WIM filesystem. */
82 struct wim_inode *f_inode;
83 struct wim_lookup_table_entry *f_lte;
84 struct filedes staging_fd;
89 struct wimfs_context {
90 /* The WIMStruct for the mounted WIM. */
93 /* Name of the staging directory for a read-write mount. Whenever a new file is
94 * created, it is done so in the staging directory. Furthermore, whenever a
95 * file in the WIM is modified, it is extracted to the staging directory. If
96 * changes are commited when the WIM is unmounted, the file resources are merged
97 * in from the staging directory when writing the new WIM. */
98 char *staging_dir_name;
99 size_t staging_dir_name_len;
101 /* Flags passed to wimlib_mount(). */
104 /* Default flags to use when looking up a WIM dentry (depends on whether
105 * the Windows interface to alternate data streams is being used or
107 int default_lookup_flags;
109 /* Next inode number to be assigned. Note: I didn't bother with a
110 * bitmap of free inode numbers since this isn't even a "real"
111 * filesystem anyway. */
114 /* List of inodes in the mounted image */
115 struct list_head *image_inode_list;
117 /* Original list of streams in the mounted image, linked by
118 * mount_orig_stream_list. */
119 struct list_head orig_stream_list;
121 /* Name and message queue descriptors for message queues between the
122 * filesystem daemon process and the unmount process. These are used
123 * when the filesystem is unmounted and the process running
124 * wimlib_unmount_image() needs to communicate with the filesystem
125 * daemon running fuse_main() (i.e. the process created by a call to
126 * wimlib_mount_image(). */
127 char *unmount_to_daemon_mq_name;
128 char *daemon_to_unmount_mq_name;
129 mqd_t unmount_to_daemon_mq;
130 mqd_t daemon_to_unmount_mq;
140 init_wimfs_context(struct wimfs_context *ctx)
142 memset(ctx, 0, sizeof(*ctx));
143 ctx->unmount_to_daemon_mq = (mqd_t)-1;
144 ctx->daemon_to_unmount_mq = (mqd_t)-1;
147 #define WIMFS_CTX(fuse_ctx) ((struct wimfs_context*)(fuse_ctx)->private_data)
149 static inline struct wimfs_context *
150 wimfs_get_context(void)
152 return WIMFS_CTX(fuse_get_context());
155 static inline WIMStruct *
156 wimfs_get_WIMStruct(void)
158 return wimfs_get_context()->wim;
162 get_lookup_flags(const struct wimfs_context *ctx)
164 return ctx->default_lookup_flags;
167 /* Returns nonzero if write permission is requested on the file open flags */
169 flags_writable(int open_flags)
171 int accmode = (open_flags & O_ACCMODE);
172 return (accmode == O_RDWR || accmode == O_WRONLY);
176 * Allocate a file descriptor for a stream.
178 * @inode: inode containing the stream we're opening
179 * @stream_id: ID of the stream we're opening
180 * @lte: Lookup table entry for the stream (may be NULL)
181 * @fd_ret: Return the allocated file descriptor if successful.
183 * Return 0 iff successful or negative error code if unsuccessful.
186 alloc_wimfs_fd(struct wim_inode *inode,
188 struct wim_lookup_table_entry *lte,
189 struct wimfs_fd **fd_ret)
191 static const u16 fds_per_alloc = 8;
192 static const u16 max_fds = 0xffff;
194 DEBUG("Allocating fd for stream ID %u from inode %#"PRIx64" "
195 "(open = %u, allocated = %u)",
196 stream_id, inode->i_ino, inode->i_num_opened_fds,
197 inode->i_num_allocated_fds);
199 if (inode->i_num_opened_fds == inode->i_num_allocated_fds) {
200 struct wimfs_fd **fds;
203 if (inode->i_num_allocated_fds == max_fds)
206 num_new_fds = min(fds_per_alloc,
207 max_fds - inode->i_num_allocated_fds);
209 fds = REALLOC(inode->i_fds,
210 (inode->i_num_allocated_fds + num_new_fds) *
211 sizeof(inode->i_fds[0]));
215 memset(&fds[inode->i_num_allocated_fds], 0,
216 num_new_fds * sizeof(fds[0]));
218 inode->i_num_allocated_fds += num_new_fds;
220 for (u16 i = 0; ; i++) {
221 if (!inode->i_fds[i]) {
222 struct wimfs_fd *fd = CALLOC(1, sizeof(*fd));
228 filedes_invalidate(&fd->staging_fd);
230 fd->stream_id = stream_id;
232 inode->i_fds[i] = fd;
233 inode->i_num_opened_fds++;
235 lte->num_opened_fds++;
236 DEBUG("Allocated fd (idx = %u)", fd->idx);
243 inode_put_fd(struct wim_inode *inode, struct wimfs_fd *fd)
245 wimlib_assert(inode != NULL);
246 wimlib_assert(fd->f_inode == inode);
247 wimlib_assert(inode->i_num_opened_fds != 0);
248 wimlib_assert(fd->idx < inode->i_num_allocated_fds);
249 wimlib_assert(inode->i_fds[fd->idx] == fd);
251 inode->i_fds[fd->idx] = NULL;
253 if (--inode->i_num_opened_fds == 0) {
256 inode->i_num_allocated_fds = 0;
257 if (inode->i_nlink == 0)
263 lte_put_fd(struct wim_lookup_table_entry *lte, struct wimfs_fd *fd)
265 wimlib_assert(fd->f_lte == lte);
267 if (!lte) /* Empty stream with no lookup table entry */
270 /* Close staging file descriptor if needed. */
272 if (lte->resource_location == RESOURCE_IN_STAGING_FILE
273 && filedes_valid(&fd->staging_fd))
275 if (filedes_close(&fd->staging_fd)) {
276 ERROR_WITH_ERRNO("Failed to close staging file");
280 lte_decrement_num_opened_fds(lte);
284 /* Close a file descriptor. */
286 close_wimfs_fd(struct wimfs_fd *fd)
289 DEBUG("Closing fd (ino = %#"PRIx64", opened = %u, allocated = %u)",
290 fd->f_inode->i_ino, fd->f_inode->i_num_opened_fds,
291 fd->f_inode->i_num_allocated_fds);
292 ret = lte_put_fd(fd->f_lte, fd);
296 inode_put_fd(fd->f_inode, fd);
301 fuse_mask_mode(mode_t mode, struct fuse_context *fuse_ctx)
303 #if FUSE_MAJOR_VERSION > 2 || (FUSE_MAJOR_VERSION == 2 && FUSE_MINOR_VERSION >= 8)
304 mode &= ~fuse_ctx->umask;
310 * Add a new dentry with a new inode to a WIM image.
312 * Returns 0 on success, or negative error number on failure.
315 create_dentry(struct fuse_context *fuse_ctx, const char *path,
316 mode_t mode, int attributes, struct wim_dentry **dentry_ret)
318 struct wim_dentry *parent;
319 struct wim_dentry *new;
320 const char *basename;
321 struct wimfs_context *wimfs_ctx = WIMFS_CTX(fuse_ctx);
324 parent = get_parent_dentry(wimfs_ctx->wim, path, WIMLIB_CASE_SENSITIVE);
328 if (!dentry_is_directory(parent))
331 basename = path_basename(path);
332 if (get_dentry_child_with_name(parent, basename, WIMLIB_CASE_SENSITIVE))
335 ret = new_dentry_with_inode(basename, &new);
339 new->d_inode->i_resolved = 1;
340 new->d_inode->i_ino = wimfs_ctx->next_ino++;
341 new->d_inode->i_attributes = attributes;
343 if (wimfs_ctx->mount_flags & WIMLIB_MOUNT_FLAG_UNIX_DATA) {
344 new->d_inode->i_unix_data.uid = fuse_ctx->uid;
345 new->d_inode->i_unix_data.gid = fuse_ctx->gid;
346 new->d_inode->i_unix_data.mode = fuse_mask_mode(mode, fuse_ctx);
348 dentry_add_child(parent, new);
349 list_add_tail(&new->d_inode->i_list, wimfs_ctx->image_inode_list);
355 static struct wim_inode *
356 wim_pathname_to_inode(WIMStruct *wim, const tchar *path)
358 struct wim_dentry *dentry;
359 dentry = get_dentry(wim, path, WIMLIB_CASE_SENSITIVE);
361 return dentry->d_inode;
367 * Remove a dentry from a mounted WIM image; i.e. remove an alias for an inode.
370 remove_dentry(struct wim_dentry *dentry,
371 struct wim_lookup_table *lookup_table)
373 /* Put a reference to each stream the inode contains. */
374 inode_unref_streams(dentry->d_inode, lookup_table);
376 /* Unlink the dentry from the image's dentry tree. */
377 unlink_dentry(dentry);
379 /* Delete the dentry. This will also decrement the link count of the
380 * corresponding inode. */
385 inode_unix_file_type(const struct wim_inode *inode)
387 if (inode_is_symlink(inode))
389 else if (inode_is_directory(inode))
396 inode_default_unix_mode(const struct wim_inode *inode)
398 return inode_unix_file_type(inode) | 0777;
401 /* Transfers file attributes from a struct wim_inode to a `stat' buffer.
403 * The lookup table entry tells us which stream in the inode we are statting.
404 * For a named data stream, everything returned is the same as the unnamed data
405 * stream except possibly the size and block count. */
407 inode_to_stbuf(const struct wim_inode *inode,
408 const struct wim_lookup_table_entry *lte,
411 const struct wimfs_context *ctx = wimfs_get_context();
413 memset(stbuf, 0, sizeof(struct stat));
414 if ((ctx->mount_flags & WIMLIB_MOUNT_FLAG_UNIX_DATA) &&
415 inode_has_unix_data(inode))
417 stbuf->st_uid = inode->i_unix_data.uid;
418 stbuf->st_gid = inode->i_unix_data.gid;
419 stbuf->st_mode = inode->i_unix_data.mode;
421 stbuf->st_uid = ctx->default_uid;
422 stbuf->st_gid = ctx->default_gid;
423 stbuf->st_mode = inode_default_unix_mode(inode);
425 stbuf->st_ino = (ino_t)inode->i_ino;
426 stbuf->st_nlink = inode->i_nlink;
428 stbuf->st_size = lte->size;
431 #ifdef HAVE_STAT_NANOSECOND_PRECISION
432 stbuf->st_atim = wim_timestamp_to_timespec(inode->i_last_access_time);
433 stbuf->st_mtim = wim_timestamp_to_timespec(inode->i_last_write_time);
434 stbuf->st_ctim = stbuf->st_mtim;
436 stbuf->st_atime = wim_timestamp_to_unix(inode->i_last_access_time);
437 stbuf->st_mtime = wim_timestamp_to_unix(inode->i_last_write_time);
438 stbuf->st_ctime = stbuf->st_mtime;
440 stbuf->st_blocks = (stbuf->st_size + 511) / 512;
445 touch_inode(struct wim_inode *inode)
447 u64 now = get_wim_timestamp();
448 inode->i_last_access_time = now;
449 inode->i_last_write_time = now;
452 /* Creates a new staging file and returns its file descriptor opened for
455 * @name_ret: A location into which the a pointer to the newly allocated name of
456 * the staging file is stored.
458 * @ctx: Context for the WIM filesystem; this provides the name of the
461 * On success, returns the file descriptor for the staging file, opened for
462 * writing. On failure, returns -1 and sets errno.
465 create_staging_file(char **name_ret, struct wimfs_context *ctx)
473 static const size_t STAGING_FILE_NAME_LEN = 20;
475 name_len = ctx->staging_dir_name_len + 1 + STAGING_FILE_NAME_LEN;
476 name = MALLOC(name_len + 1);
484 memcpy(name, ctx->staging_dir_name, ctx->staging_dir_name_len);
485 name[ctx->staging_dir_name_len] = '/';
486 randomize_char_array_with_alnum(name + ctx->staging_dir_name_len + 1,
487 STAGING_FILE_NAME_LEN);
488 name[name_len] = '\0';
491 /* Just in case, verify that the randomly generated name doesn't name an
492 * existing file, and try again if so */
493 } while (stat(name, &stbuf) == 0);
495 if (errno != ENOENT) /* other error?! */
498 /* doesn't exist--- ok */
500 DEBUG("Creating staging file `%s'", name);
502 fd = open(name, O_WRONLY | O_CREAT | O_EXCL, 0600);
514 * Extract a WIM resource to the staging directory.
516 * @inode: Inode that contains the stream we are extracting
518 * @stream_id: Identifier for the stream (it stays constant even if the indices
519 * of the stream entries are changed)
521 * @lte: Pointer to pointer to the lookup table entry for the stream we need to
522 * extract, or NULL if there was no lookup table entry present for the stream
524 * @size: Number of bytes of the stream we want to extract (this supports the
525 * wimfs_truncate() function). It may be more than the actual stream length, in
526 * which case the extra space is filled with zeroes.
528 * @ctx: Context for the WIM filesystem.
530 * Returns 0 on success or a negative error code on failure.
533 extract_resource_to_staging_dir(struct wim_inode *inode,
535 struct wim_lookup_table_entry **lte,
537 struct wimfs_context *ctx)
539 char *staging_file_name;
542 struct wim_lookup_table_entry *old_lte, *new_lte;
545 DEBUG("Extracting resource to staging dir: inode %"PRIu64", "
546 "stream id %"PRIu32, inode->i_ino, stream_id);
550 wimlib_assert(old_lte == NULL ||
551 old_lte->resource_location != RESOURCE_IN_STAGING_FILE);
553 /* Create the staging file */
554 fd = create_staging_file(&staging_file_name, ctx);
558 /* Extract the stream to the staging file (possibly truncated) */
560 struct filedes wimlib_fd;
561 filedes_init(&wimlib_fd, fd);
562 extract_size = min(old_lte->size, size);
563 ret = extract_stream_to_fd(old_lte, &wimlib_fd, extract_size);
569 /* In the case of truncate() to more than the file length, extend the
570 * file with zeroes by calling ftruncate() on the underlying staging
572 if (ret == 0 && size > extract_size)
573 ret = ftruncate(fd, size);
575 /* Close the staging file descriptor and check for errors. If there's
576 * an error, unlink the staging file. */
577 if (ret != 0 || close(fd) != 0) {
583 goto out_delete_staging_file;
586 /* Now deal with the lookup table entries. We may be able to re-use the
587 * existing entry, but we may have to create a new one instead. */
589 if (old_lte && inode->i_nlink == old_lte->refcnt) {
590 /* The reference count of the existing lookup table entry is the
591 * same as the link count of the inode that contains the stream
592 * we're opening. Therefore, ALL the references to the lookup
593 * table entry correspond to the stream we're trying to extract,
594 * so the lookup table entry can be re-used. */
595 DEBUG("Re-using lookup table entry");
596 lookup_table_unlink(ctx->wim->lookup_table, old_lte);
600 /* There's an existing lookup table entry, but its
601 * reference count is greater than the link count for
602 * the inode containing a stream we're opening.
603 * Therefore, we need to split the lookup table entry.
605 wimlib_assert(old_lte->refcnt > inode->i_nlink);
606 DEBUG("Splitting lookup table entry "
607 "(inode->i_nlink = %u, old_lte->refcnt = %u)",
608 inode->i_nlink, old_lte->refcnt);
611 new_lte = new_lookup_table_entry();
614 goto out_delete_staging_file;
617 /* There may already be open file descriptors to this stream if
618 * it's previously been opened read-only, but just now we're
619 * opening it read-write. Identify those file descriptors and
620 * change their lookup table entry pointers to point to the new
621 * lookup table entry, and open staging file descriptors for
624 * At the same time, we need to count the number of these opened
625 * file descriptors to the new lookup table entry. If there's
626 * an old lookup table entry, this number needs to be subtracted
627 * from the fd's opened to the old entry. */
628 for (u16 i = 0, j = 0; j < inode->i_num_opened_fds; i++) {
629 struct wimfs_fd *fd = inode->i_fds[i];
631 if (fd->stream_id == stream_id) {
634 wimlib_assert(fd->f_lte == old_lte);
635 wimlib_assert(!filedes_valid(&fd->staging_fd));
637 new_lte->num_opened_fds++;
638 raw_fd = open(staging_file_name, O_RDONLY);
641 goto out_revert_fd_changes;
643 filedes_init(&fd->staging_fd, raw_fd);
648 DEBUG("%hu fd's were already opened to the file we extracted",
649 new_lte->num_opened_fds);
651 old_lte->num_opened_fds -= new_lte->num_opened_fds;
652 old_lte->refcnt -= inode->i_nlink;
656 lte_put_resource(new_lte);
657 new_lte->refcnt = inode->i_nlink;
658 new_lte->resource_location = RESOURCE_IN_STAGING_FILE;
659 new_lte->staging_file_name = staging_file_name;
660 new_lte->size = size;
662 add_unhashed_stream(new_lte, inode, stream_id,
663 &wim_get_current_image_metadata(ctx->wim)->unhashed_streams);
664 *retrieve_lte_pointer(new_lte) = new_lte;
667 out_revert_fd_changes:
668 for (u16 i = 0, j = 0; j < new_lte->num_opened_fds; i++) {
669 struct wimfs_fd *fd = inode->i_fds[i];
670 if (fd && fd->stream_id == stream_id && fd->f_lte == new_lte) {
672 if (filedes_valid(&fd->staging_fd)) {
673 filedes_close(&fd->staging_fd);
674 filedes_invalidate(&fd->staging_fd);
679 free_lookup_table_entry(new_lte);
680 out_delete_staging_file:
681 unlink(staging_file_name);
682 FREE(staging_file_name);
687 * Creates a randomly named staging directory and saves its name in the
688 * filesystem context structure.
691 make_staging_dir(struct wimfs_context *ctx, const char *user_prefix)
693 static const size_t random_suffix_len = 10;
694 static const char *common_suffix = ".staging";
695 static const size_t common_suffix_len = 8;
697 char *staging_dir_name = NULL;
698 size_t staging_dir_name_len;
700 const char *wim_basename;
701 char *real_user_prefix = NULL;
705 real_user_prefix = realpath(user_prefix, NULL);
706 if (!real_user_prefix) {
707 ERROR_WITH_ERRNO("Could not resolve `%s'",
709 ret = WIMLIB_ERR_NOTDIR;
712 wim_basename = path_basename(ctx->wim->filename);
713 prefix_len = strlen(real_user_prefix) + 1 + strlen(wim_basename);
715 prefix_len = strlen(ctx->wim->filename);
718 staging_dir_name_len = prefix_len + common_suffix_len + random_suffix_len;
720 staging_dir_name = MALLOC(staging_dir_name_len + 1);
721 if (!staging_dir_name) {
722 ret = WIMLIB_ERR_NOMEM;
726 if (real_user_prefix)
727 sprintf(staging_dir_name, "%s/%s", real_user_prefix, wim_basename);
729 strcpy(staging_dir_name, ctx->wim->filename);
731 strcat(staging_dir_name, common_suffix);
733 randomize_char_array_with_alnum(staging_dir_name + prefix_len + common_suffix_len,
736 staging_dir_name[staging_dir_name_len] = '\0';
738 if (mkdir(staging_dir_name, 0700) != 0) {
739 ERROR_WITH_ERRNO("Failed to create temporary directory `%s'",
741 ret = WIMLIB_ERR_MKDIR;
746 FREE(real_user_prefix);
748 ctx->staging_dir_name = staging_dir_name;
749 ctx->staging_dir_name_len = staging_dir_name_len;
751 FREE(staging_dir_name);
757 remove_file_or_directory(const char *fpath, const struct stat *sb,
758 int typeflag, struct FTW *ftwbuf)
760 if (remove(fpath) == 0)
763 ERROR_WITH_ERRNO("Cannot remove `%s'", fpath);
764 return WIMLIB_ERR_DELETE_STAGING_DIR;
769 * Deletes the staging directory and all the files contained in it.
772 delete_staging_dir(struct wimfs_context *ctx)
775 ret = nftw(ctx->staging_dir_name, remove_file_or_directory,
777 FREE(ctx->staging_dir_name);
778 ctx->staging_dir_name = NULL;
783 inode_close_fds(struct wim_inode *inode)
785 u16 num_opened_fds = inode->i_num_opened_fds;
786 for (u16 i = 0, j = 0; j < num_opened_fds; i++) {
787 struct wimfs_fd *fd = inode->i_fds[i];
789 wimlib_assert(fd->f_inode == inode);
790 int ret = close_wimfs_fd(fd);
799 /* Overwrites the WIM file, with changes saved. */
801 rebuild_wim(struct wimfs_context *ctx, int write_flags,
802 wimlib_progress_func_t progress_func)
805 struct wim_lookup_table_entry *lte, *tmp;
806 WIMStruct *wim = ctx->wim;
807 struct wim_image_metadata *imd = wim_get_current_image_metadata(ctx->wim);
809 DEBUG("Closing all staging file descriptors.");
810 image_for_each_unhashed_stream_safe(lte, tmp, imd) {
811 ret = inode_close_fds(lte->back_inode);
816 DEBUG("Freeing entries for zero-length streams");
817 image_for_each_unhashed_stream_safe(lte, tmp, imd) {
818 wimlib_assert(lte->unhashed);
819 if (lte->size == 0) {
820 struct wim_lookup_table_entry **back_ptr;
821 back_ptr = retrieve_lte_pointer(lte);
823 list_del(<e->unhashed_list);
824 free_lookup_table_entry(lte);
828 xml_update_image_info(wim, wim->current_image);
829 ret = wimlib_overwrite(wim, write_flags, 0, progress_func);
831 ERROR("Failed to commit changes to mounted WIM image");
835 /* Simple function that returns the concatenation of 2 strings. */
837 strcat_dup(const char *s1, const char *s2, size_t max_len)
839 size_t len = strlen(s1) + strlen(s2);
842 char *p = MALLOC(len + 1);
845 snprintf(p, len + 1, "%s%s", s1, s2);
850 set_message_queue_names(struct wimfs_context *ctx, const char *mount_dir)
852 static const char *u2d_prefix = "/wimlib-unmount-to-daemon-mq";
853 static const char *d2u_prefix = "/wimlib-daemon-to-unmount-mq";
858 dir_path = realpath(mount_dir, NULL);
860 ERROR_WITH_ERRNO("Failed to resolve path \"%s\"", mount_dir);
862 return WIMLIB_ERR_NOMEM;
864 return WIMLIB_ERR_NOTDIR;
867 for (p = dir_path; *p; p++)
871 ctx->unmount_to_daemon_mq_name = strcat_dup(u2d_prefix, dir_path,
873 if (!ctx->unmount_to_daemon_mq_name) {
874 ret = WIMLIB_ERR_NOMEM;
875 goto out_free_dir_path;
877 ctx->daemon_to_unmount_mq_name = strcat_dup(d2u_prefix, dir_path,
879 if (!ctx->daemon_to_unmount_mq_name) {
880 ret = WIMLIB_ERR_NOMEM;
881 goto out_free_unmount_to_daemon_mq_name;
885 goto out_free_dir_path;
886 out_free_unmount_to_daemon_mq_name:
887 FREE(ctx->unmount_to_daemon_mq_name);
888 ctx->unmount_to_daemon_mq_name = NULL;
895 free_message_queue_names(struct wimfs_context *ctx)
897 FREE(ctx->unmount_to_daemon_mq_name);
898 FREE(ctx->daemon_to_unmount_mq_name);
899 ctx->unmount_to_daemon_mq_name = NULL;
900 ctx->daemon_to_unmount_mq_name = NULL;
904 * Opens two POSIX message queue: one for sending messages from the unmount
905 * process to the daemon process, and one to go the other way. The names of the
906 * message queues, which must be system-wide unique, are be based on the mount
909 * @daemon specifies whether the calling process is the filesystem daemon or the
913 open_message_queues(struct wimfs_context *ctx, bool daemon)
915 int unmount_to_daemon_mq_flags = O_WRONLY | O_CREAT;
916 int daemon_to_unmount_mq_flags = O_RDONLY | O_CREAT;
922 swap(unmount_to_daemon_mq_flags, daemon_to_unmount_mq_flags);
928 orig_umask = umask(0000);
929 DEBUG("Opening message queue \"%s\"", ctx->unmount_to_daemon_mq_name);
930 ctx->unmount_to_daemon_mq = mq_open(ctx->unmount_to_daemon_mq_name,
931 unmount_to_daemon_mq_flags, mode, NULL);
933 if (ctx->unmount_to_daemon_mq == (mqd_t)-1) {
934 ERROR_WITH_ERRNO("mq_open()");
935 ret = WIMLIB_ERR_MQUEUE;
939 DEBUG("Opening message queue \"%s\"", ctx->daemon_to_unmount_mq_name);
940 ctx->daemon_to_unmount_mq = mq_open(ctx->daemon_to_unmount_mq_name,
941 daemon_to_unmount_mq_flags, mode, NULL);
943 if (ctx->daemon_to_unmount_mq == (mqd_t)-1) {
944 ERROR_WITH_ERRNO("mq_open()");
945 mq_close(ctx->unmount_to_daemon_mq);
946 mq_unlink(ctx->unmount_to_daemon_mq_name);
947 ctx->unmount_to_daemon_mq = (mqd_t)-1;
948 ret = WIMLIB_ERR_MQUEUE;
957 /* Try to determine the maximum message size of a message queue. The return
958 * value is the maximum message size, or a guess of 8192 bytes if it cannot be
961 mq_get_msgsize(mqd_t mq)
963 static const char *msgsize_max_file = "/proc/sys/fs/mqueue/msgsize_max";
968 if (mq_getattr(mq, &attr) == 0) {
969 msgsize = attr.mq_msgsize;
971 ERROR_WITH_ERRNO("mq_getattr()");
972 ERROR("Attempting to read %s", msgsize_max_file);
973 fp = fopen(msgsize_max_file, "rb");
975 if (fscanf(fp, "%ld", &msgsize) != 1) {
976 ERROR("Assuming message size of 8192");
981 ERROR_WITH_ERRNO("Failed to open the file `%s'",
983 ERROR("Assuming message size of 8192");
991 get_mailbox(mqd_t mq, long needed_msgsize, long *msgsize_ret,
997 msgsize = mq_get_msgsize(mq);
999 if (msgsize < needed_msgsize) {
1000 ERROR("Message queue max size must be at least %ld!",
1002 return WIMLIB_ERR_MQUEUE;
1005 mailbox = MALLOC(msgsize);
1007 ERROR("Failed to allocate %ld bytes for mailbox", msgsize);
1008 return WIMLIB_ERR_NOMEM;
1010 *msgsize_ret = msgsize;
1011 *mailbox_ret = mailbox;
1016 unlink_message_queues(struct wimfs_context *ctx)
1018 mq_unlink(ctx->unmount_to_daemon_mq_name);
1019 mq_unlink(ctx->daemon_to_unmount_mq_name);
1022 /* Closes the message queues, which are allocated in static variables */
1024 close_message_queues(struct wimfs_context *ctx)
1026 DEBUG("Closing message queues");
1027 mq_close(ctx->unmount_to_daemon_mq);
1028 ctx->unmount_to_daemon_mq = (mqd_t)(-1);
1029 mq_close(ctx->daemon_to_unmount_mq);
1030 ctx->daemon_to_unmount_mq = (mqd_t)(-1);
1031 unlink_message_queues(ctx);
1035 struct unmount_msg_hdr {
1040 } _packed_attribute;
1042 struct msg_unmount_request {
1043 struct unmount_msg_hdr hdr;
1045 u8 want_progress_messages;
1046 } _packed_attribute;
1048 struct msg_daemon_info {
1049 struct unmount_msg_hdr hdr;
1052 } _packed_attribute;
1054 struct msg_unmount_finished {
1055 struct unmount_msg_hdr hdr;
1057 } _packed_attribute;
1059 struct msg_write_streams_progress {
1060 struct unmount_msg_hdr hdr;
1061 union wimlib_progress_info info;
1062 } _packed_attribute;
1065 MSG_TYPE_UNMOUNT_REQUEST,
1066 MSG_TYPE_DAEMON_INFO,
1067 MSG_TYPE_WRITE_STREAMS_PROGRESS,
1068 MSG_TYPE_UNMOUNT_FINISHED,
1072 struct msg_handler_context_hdr {
1073 int timeout_seconds;
1076 struct unmount_msg_handler_context {
1077 struct msg_handler_context_hdr hdr;
1081 wimlib_progress_func_t progress_func;
1084 struct daemon_msg_handler_context {
1085 struct msg_handler_context_hdr hdr;
1086 struct wimfs_context *wimfs_ctx;
1090 send_unmount_request_msg(mqd_t mq, int unmount_flags, u8 want_progress_messages)
1092 DEBUG("Sending unmount request msg");
1093 struct msg_unmount_request msg = {
1095 .min_version = ((unmount_flags & WIMLIB_UNMOUNT_FLAG_NEW_IMAGE) ?
1096 WIMLIB_MAKEVERSION(1, 6, 2) :
1097 WIMLIB_MAKEVERSION(1, 2, 1)),
1098 .cur_version = WIMLIB_VERSION_CODE,
1099 .msg_type = MSG_TYPE_UNMOUNT_REQUEST,
1100 .msg_size = sizeof(msg),
1102 .unmount_flags = unmount_flags,
1103 .want_progress_messages = want_progress_messages,
1106 if (mq_send(mq, (void*)&msg, sizeof(msg), 1)) {
1107 ERROR_WITH_ERRNO("Failed to communicate with filesystem daemon");
1108 return WIMLIB_ERR_MQUEUE;
1114 send_daemon_info_msg(mqd_t mq, pid_t pid, int mount_flags)
1116 DEBUG("Sending daemon info msg (pid = %d, mount_flags=%x)",
1119 struct msg_daemon_info msg = {
1121 .min_version = WIMLIB_MAKEVERSION(1, 2, 1),
1122 .cur_version = WIMLIB_VERSION_CODE,
1123 .msg_type = MSG_TYPE_DAEMON_INFO,
1124 .msg_size = sizeof(msg),
1127 .mount_flags = mount_flags,
1129 if (mq_send(mq, (void*)&msg, sizeof(msg), 1)) {
1130 ERROR_WITH_ERRNO("Failed to send daemon info to unmount process");
1131 return WIMLIB_ERR_MQUEUE;
1137 send_unmount_finished_msg(mqd_t mq, int status)
1139 DEBUG("Sending unmount finished msg");
1140 struct msg_unmount_finished msg = {
1142 .min_version = WIMLIB_MAKEVERSION(1, 2, 1),
1143 .cur_version = WIMLIB_VERSION_CODE,
1144 .msg_type = MSG_TYPE_UNMOUNT_FINISHED,
1145 .msg_size = sizeof(msg),
1149 if (mq_send(mq, (void*)&msg, sizeof(msg), 1))
1150 ERROR_WITH_ERRNO("Failed to send status to unmount process");
1154 unmount_progress_func(enum wimlib_progress_msg msg,
1155 const union wimlib_progress_info *info)
1157 if (msg == WIMLIB_PROGRESS_MSG_WRITE_STREAMS) {
1158 struct msg_write_streams_progress msg = {
1160 .min_version = WIMLIB_MAKEVERSION(1, 2, 1),
1161 .cur_version = WIMLIB_VERSION_CODE,
1162 .msg_type = MSG_TYPE_WRITE_STREAMS_PROGRESS,
1163 .msg_size = sizeof(msg),
1167 if (mq_send(wimfs_get_context()->daemon_to_unmount_mq,
1168 (void*)&msg, sizeof(msg), 1))
1170 ERROR_WITH_ERRNO("Failed to send progress information "
1171 "to unmount process");
1178 release_extra_refcnts(struct wimfs_context *ctx)
1180 struct list_head *list = &ctx->orig_stream_list;
1181 struct wim_lookup_table *lookup_table = ctx->wim->lookup_table;
1182 struct wim_lookup_table_entry *lte, *tmp;
1184 list_for_each_entry_safe(lte, tmp, list, orig_stream_list) {
1185 u32 n = lte->out_refcnt;
1187 lte_decrement_refcnt(lte, lookup_table);
1191 /* Moves the currently selected image, which may have been modified, to a new
1192 * index, and sets the original index to refer to a reset (unmodified) copy of
1195 renew_current_image(struct wimfs_context *ctx)
1197 WIMStruct *wim = ctx->wim;
1199 int idx = wim->current_image - 1;
1200 struct wim_image_metadata *imd = wim->image_metadata[idx];
1201 struct wim_image_metadata *replace_imd;
1202 struct wim_lookup_table_entry *new_lte;
1204 if (imd->metadata_lte->resource_location != RESOURCE_IN_WIM) {
1205 ERROR("Can't reset modified image that doesn't yet "
1206 "exist in the on-disk WIM file!");
1207 return WIMLIB_ERR_METADATA_NOT_FOUND;
1210 /* Create 'replace_imd' structure to use for the reset original,
1211 * unmodified image. */
1212 replace_imd = new_image_metadata();
1214 return WIMLIB_ERR_NOMEM;
1216 /* Create new stream reference for the modified image's metadata
1217 * resource, which doesn't exist yet. */
1218 ret = WIMLIB_ERR_NOMEM;
1219 new_lte = new_lookup_table_entry();
1221 goto err_put_replace_imd;
1222 new_lte->flags = WIM_RESHDR_FLAG_METADATA;
1223 new_lte->unhashed = 1;
1225 /* Make the image being moved available at a new index. Increments the
1226 * WIM's image count, but does not increment the reference count of the
1227 * 'struct image_metadata'. */
1228 ret = append_image_metadata(wim, imd);
1230 goto err_free_new_lte;
1232 ret = xml_add_image(wim, T(""));
1234 goto err_undo_append;
1236 replace_imd->metadata_lte = imd->metadata_lte;
1237 imd->metadata_lte = new_lte;
1238 wim->image_metadata[idx] = replace_imd;
1239 wim->current_image = wim->hdr.image_count;
1243 wim->hdr.image_count--;
1245 free_lookup_table_entry(new_lte);
1246 err_put_replace_imd:
1247 put_image_metadata(replace_imd, NULL);
1252 msg_unmount_request_handler(const void *_msg, void *_handler_ctx)
1254 const struct msg_unmount_request *msg = _msg;
1255 struct daemon_msg_handler_context *handler_ctx = _handler_ctx;
1256 struct wimfs_context *wimfs_ctx;
1260 wimlib_progress_func_t progress_func;
1262 DEBUG("Handling unmount request msg");
1264 wimfs_ctx = handler_ctx->wimfs_ctx;
1265 if (msg->hdr.msg_size < sizeof(*msg)) {
1266 status = WIMLIB_ERR_INVALID_UNMOUNT_MESSAGE;
1270 unmount_flags = msg->unmount_flags;
1271 if (msg->want_progress_messages)
1272 progress_func = unmount_progress_func;
1274 progress_func = NULL;
1276 ret = send_daemon_info_msg(wimfs_ctx->daemon_to_unmount_mq, getpid(),
1277 wimfs_ctx->mount_flags);
1283 if (wimfs_ctx->mount_flags & WIMLIB_MOUNT_FLAG_READWRITE) {
1284 if (unmount_flags & WIMLIB_UNMOUNT_FLAG_COMMIT) {
1286 if (unmount_flags & WIMLIB_UNMOUNT_FLAG_NEW_IMAGE) {
1287 ret = renew_current_image(wimfs_ctx);
1293 release_extra_refcnts(wimfs_ctx);
1295 INIT_LIST_HEAD(&wimfs_ctx->orig_stream_list);
1297 int write_flags = 0;
1298 if (unmount_flags & WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY)
1299 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
1300 if (unmount_flags & WIMLIB_UNMOUNT_FLAG_REBUILD)
1301 write_flags |= WIMLIB_WRITE_FLAG_REBUILD;
1302 if (unmount_flags & WIMLIB_UNMOUNT_FLAG_RECOMPRESS)
1303 write_flags |= WIMLIB_WRITE_FLAG_RECOMPRESS;
1304 status = rebuild_wim(wimfs_ctx, write_flags,
1308 DEBUG("Read-only mount");
1313 if (wimfs_ctx->mount_flags & WIMLIB_MOUNT_FLAG_READWRITE) {
1314 ret = delete_staging_dir(wimfs_ctx);
1316 ERROR("Failed to delete the staging directory");
1321 wimfs_ctx->status = status;
1322 wimfs_ctx->have_status = true;
1323 return MSG_BREAK_LOOP;
1327 msg_daemon_info_handler(const void *_msg, void *_handler_ctx)
1329 const struct msg_daemon_info *msg = _msg;
1330 struct unmount_msg_handler_context *handler_ctx = _handler_ctx;
1332 DEBUG("Handling daemon info msg");
1333 if (msg->hdr.msg_size < sizeof(*msg))
1334 return WIMLIB_ERR_INVALID_UNMOUNT_MESSAGE;
1335 handler_ctx->daemon_pid = msg->daemon_pid;
1336 handler_ctx->mount_flags = msg->mount_flags;
1337 handler_ctx->hdr.timeout_seconds = 1;
1338 DEBUG("pid of daemon is %d; mount flags were %#x",
1339 handler_ctx->daemon_pid,
1340 handler_ctx->mount_flags);
1345 msg_write_streams_progress_handler(const void *_msg, void *_handler_ctx)
1347 const struct msg_write_streams_progress *msg = _msg;
1348 struct unmount_msg_handler_context *handler_ctx = _handler_ctx;
1350 if (msg->hdr.msg_size < sizeof(*msg))
1351 return WIMLIB_ERR_INVALID_UNMOUNT_MESSAGE;
1352 if (handler_ctx->progress_func) {
1353 handler_ctx->progress_func(WIMLIB_PROGRESS_MSG_WRITE_STREAMS,
1360 msg_unmount_finished_handler(const void *_msg, void *_handler_ctx)
1362 const struct msg_unmount_finished *msg = _msg;
1363 struct unmount_msg_handler_context *handler_ctx = _handler_ctx;
1365 DEBUG("Handling unmount finished message");
1366 if (msg->hdr.msg_size < sizeof(*msg))
1367 return WIMLIB_ERR_INVALID_UNMOUNT_MESSAGE;
1368 handler_ctx->status = msg->status;
1369 DEBUG("status is %d", handler_ctx->status);
1370 return MSG_BREAK_LOOP;
1374 unmount_timed_out_cb(void *_handler_ctx)
1376 const struct unmount_msg_handler_context *handler_ctx = _handler_ctx;
1378 if (handler_ctx->daemon_pid == 0 ||
1379 (kill(handler_ctx->daemon_pid, 0) != 0 && errno == ESRCH))
1381 ERROR("The filesystem daemon has crashed! Changes to the "
1382 "WIM may not have been commited.");
1383 return WIMLIB_ERR_FILESYSTEM_DAEMON_CRASHED;
1386 DEBUG("Filesystem daemon is still alive... "
1387 "Waiting another %d seconds", handler_ctx->hdr.timeout_seconds);
1392 daemon_timed_out_cb(void *_handler_ctx)
1394 ERROR("Timed out waiting for unmount request! "
1395 "Changes to the mounted WIM will not be committed.");
1396 return WIMLIB_ERR_TIMEOUT;
1399 typedef int (*msg_handler_t)(const void *_msg, void *_handler_ctx);
1401 struct msg_handler_callbacks {
1402 int (*timed_out)(void * _handler_ctx);
1403 msg_handler_t msg_handlers[MSG_TYPE_MAX];
1406 static const struct msg_handler_callbacks unmount_msg_handler_callbacks = {
1407 .timed_out = unmount_timed_out_cb,
1409 [MSG_TYPE_DAEMON_INFO] = msg_daemon_info_handler,
1410 [MSG_TYPE_WRITE_STREAMS_PROGRESS] = msg_write_streams_progress_handler,
1411 [MSG_TYPE_UNMOUNT_FINISHED] = msg_unmount_finished_handler,
1415 static const struct msg_handler_callbacks daemon_msg_handler_callbacks = {
1416 .timed_out = daemon_timed_out_cb,
1418 [MSG_TYPE_UNMOUNT_REQUEST] = msg_unmount_request_handler,
1423 receive_message(mqd_t mq,
1424 struct msg_handler_context_hdr *handler_ctx,
1425 const msg_handler_t msg_handlers[],
1426 long mailbox_size, void *mailbox)
1429 struct timespec timeout;
1430 ssize_t bytes_received;
1431 struct unmount_msg_hdr *hdr;
1434 gettimeofday(&now, NULL);
1435 timeout.tv_sec = now.tv_sec + handler_ctx->timeout_seconds;
1436 timeout.tv_nsec = now.tv_usec * 1000;
1438 bytes_received = mq_timedreceive(mq, mailbox,
1439 mailbox_size, NULL, &timeout);
1441 if (bytes_received == -1) {
1442 if (errno == ETIMEDOUT) {
1443 ret = WIMLIB_ERR_TIMEOUT;
1445 ERROR_WITH_ERRNO("mq_timedreceive()");
1446 ret = WIMLIB_ERR_MQUEUE;
1448 } else if (bytes_received < sizeof(*hdr) ||
1449 bytes_received != hdr->msg_size) {
1450 ret = WIMLIB_ERR_INVALID_UNMOUNT_MESSAGE;
1451 } else if (WIMLIB_VERSION_CODE < hdr->min_version) {
1452 /*ERROR("Cannot understand the received message. "*/
1453 /*"Please upgrade wimlib to at least v%d.%d.%d",*/
1454 /*WIMLIB_GET_MAJOR_VERSION(hdr->min_version),*/
1455 /*WIMLIB_GET_MINOR_VERSION(hdr->min_version),*/
1456 /*WIMLIB_GET_PATCH_VERSION(hdr->min_version));*/
1457 ret = MSG_VERSION_TOO_HIGH;
1458 } else if (hdr->msg_type >= MSG_TYPE_MAX) {
1459 ret = WIMLIB_ERR_INVALID_UNMOUNT_MESSAGE;
1460 } else if (msg_handlers[hdr->msg_type] == NULL) {
1461 ret = WIMLIB_ERR_INVALID_UNMOUNT_MESSAGE;
1463 ret = msg_handlers[hdr->msg_type](mailbox, handler_ctx);
1469 message_loop(mqd_t mq,
1470 const struct msg_handler_callbacks *callbacks,
1471 struct msg_handler_context_hdr *handler_ctx)
1473 static const size_t MAX_MSG_SIZE = 512;
1478 DEBUG("Entering message loop");
1480 ret = get_mailbox(mq, MAX_MSG_SIZE, &msgsize, &mailbox);
1484 ret = receive_message(mq, handler_ctx,
1485 callbacks->msg_handlers,
1487 if (ret == 0 || ret == MSG_VERSION_TOO_HIGH) {
1489 } else if (ret == MSG_BREAK_LOOP) {
1492 } else if (ret == WIMLIB_ERR_TIMEOUT) {
1493 if (callbacks->timed_out)
1494 ret = callbacks->timed_out(handler_ctx);
1500 ERROR_WITH_ERRNO("Error communicating with "
1501 "filesystem daemon");
1506 DEBUG("Exiting message loop");
1510 /* Execute `fusermount -u', which is installed setuid root, to unmount the WIM.
1512 * FUSE does not yet implement synchronous unmounts. This means that fusermount
1513 * -u will return before the filesystem daemon returns from wimfs_destroy().
1514 * This is partly what we want, because we need to send a message from this
1515 * process to the filesystem daemon telling whether --commit was specified or
1516 * not. However, after that, the unmount process must wait for the filesystem
1517 * daemon to finish writing the WIM file.
1520 execute_fusermount(const char *dir, bool lazy)
1528 ERROR_WITH_ERRNO("Failed to fork()");
1529 return WIMLIB_ERR_FORK;
1535 *argp++ = "fusermount";
1539 *argp++ = (char*)dir;
1541 execvp("fusermount", argv);
1542 ERROR_WITH_ERRNO("Failed to execute `fusermount'");
1543 exit(WIMLIB_ERR_FUSERMOUNT);
1547 ret = waitpid(pid, &status, 0);
1549 ERROR_WITH_ERRNO("Failed to wait for fusermount process to "
1551 return WIMLIB_ERR_FUSERMOUNT;
1554 if (!WIFEXITED(status)) {
1555 ERROR("'fusermount' did not terminate normally!");
1556 return WIMLIB_ERR_FUSERMOUNT;
1559 status = WEXITSTATUS(status);
1564 if (status != WIMLIB_ERR_FUSERMOUNT)
1565 return WIMLIB_ERR_FUSERMOUNT;
1567 /* Try again, but with the `umount' program. This is required on other
1568 * FUSE implementations such as FreeBSD's that do not have a
1569 * `fusermount' program. */
1570 ERROR("Falling back to 'umount'. Note: you may need to be "
1571 "root for this to work");
1574 ERROR_WITH_ERRNO("Failed to fork()");
1575 return WIMLIB_ERR_FORK;
1584 *argp++ = (char*)dir;
1586 execvp("umount", argv);
1587 ERROR_WITH_ERRNO("Failed to execute `umount'");
1588 exit(WIMLIB_ERR_FUSERMOUNT);
1592 ret = waitpid(pid, &status, 0);
1594 ERROR_WITH_ERRNO("Failed to wait for `umount' process to "
1596 return WIMLIB_ERR_FUSERMOUNT;
1599 if (!WIFEXITED(status) || WEXITSTATUS(status) != 0) {
1600 ERROR("`umount' did not successfully complete");
1601 return WIMLIB_ERR_FUSERMOUNT;
1608 wimfs_chmod(const char *path, mode_t mask)
1610 struct wim_dentry *dentry;
1611 struct wim_inode *inode;
1612 struct wimfs_context *ctx = wimfs_get_context();
1615 if (!(ctx->mount_flags & WIMLIB_MOUNT_FLAG_UNIX_DATA))
1618 ret = wim_pathname_to_stream(ctx->wim, path, LOOKUP_FLAG_DIRECTORY_OK,
1619 &dentry, NULL, NULL);
1623 inode = dentry->d_inode;
1625 if (!inode_has_unix_data(inode)) {
1626 inode->i_unix_data.uid = ctx->default_uid;
1627 inode->i_unix_data.gid = ctx->default_gid;
1629 inode->i_unix_data.mode = mask;
1634 wimfs_chown(const char *path, uid_t uid, gid_t gid)
1636 struct wim_dentry *dentry;
1637 struct wim_inode *inode;
1638 struct wimfs_context *ctx = wimfs_get_context();
1641 if (!(ctx->mount_flags & WIMLIB_MOUNT_FLAG_UNIX_DATA))
1644 ret = wim_pathname_to_stream(ctx->wim, path, LOOKUP_FLAG_DIRECTORY_OK,
1645 &dentry, NULL, NULL);
1649 inode = dentry->d_inode;
1651 if (!inode_has_unix_data(inode))
1652 inode->i_unix_data.mode = inode_default_unix_mode(inode);
1653 inode->i_unix_data.uid = uid;
1654 inode->i_unix_data.gid = gid;
1658 /* Called when the filesystem is unmounted. */
1660 wimfs_destroy(void *p)
1662 struct wimfs_context *wimfs_ctx = wimfs_get_context();
1663 if (open_message_queues(wimfs_ctx, true) == 0) {
1664 struct daemon_msg_handler_context handler_ctx = {
1666 .timeout_seconds = 5,
1668 .wimfs_ctx = wimfs_ctx,
1670 message_loop(wimfs_ctx->unmount_to_daemon_mq,
1671 &daemon_msg_handler_callbacks,
1677 wimfs_fgetattr(const char *path, struct stat *stbuf,
1678 struct fuse_file_info *fi)
1680 struct wimfs_fd *fd = (struct wimfs_fd*)(uintptr_t)fi->fh;
1681 return inode_to_stbuf(fd->f_inode, fd->f_lte, stbuf);
1685 wimfs_ftruncate(const char *path, off_t size, struct fuse_file_info *fi)
1687 struct wimfs_fd *fd = (struct wimfs_fd*)(uintptr_t)fi->fh;
1688 int ret = ftruncate(fd->staging_fd.fd, size);
1691 touch_inode(fd->f_inode);
1692 fd->f_lte->size = size;
1697 * Fills in a `struct stat' that corresponds to a file or directory in the WIM.
1700 wimfs_getattr(const char *path, struct stat *stbuf)
1702 struct wim_dentry *dentry;
1703 struct wim_lookup_table_entry *lte;
1705 struct wimfs_context *ctx = wimfs_get_context();
1707 ret = wim_pathname_to_stream(ctx->wim, path,
1708 get_lookup_flags(ctx) |
1709 LOOKUP_FLAG_DIRECTORY_OK,
1710 &dentry, <e, NULL);
1713 return inode_to_stbuf(dentry->d_inode, lte, stbuf);
1717 /* Read an alternate data stream through the XATTR interface, or get its size */
1719 wimfs_getxattr(const char *path, const char *name, char *value,
1723 struct wim_inode *inode;
1724 struct wim_ads_entry *ads_entry;
1726 struct wim_lookup_table_entry *lte;
1727 struct wimfs_context *ctx = wimfs_get_context();
1729 if (!(ctx->mount_flags & WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR))
1732 if (strlen(name) <= 5 || memcmp(name, "user.", 5) != 0)
1736 inode = wim_pathname_to_inode(ctx->wim, path);
1740 ads_entry = inode_get_ads_entry(inode, name, NULL);
1744 lte = ads_entry->lte;
1745 stream_size = lte->size;
1750 if (stream_size > size)
1753 ret = read_full_stream_into_buf(lte, value);
1764 /* Create a hard link */
1766 wimfs_link(const char *to, const char *from)
1768 struct wim_dentry *from_dentry, *from_dentry_parent;
1769 const char *link_name;
1770 struct wim_inode *inode;
1771 WIMStruct *wim = wimfs_get_WIMStruct();
1774 inode = wim_pathname_to_inode(wim, to);
1778 if (inode->i_attributes & (FILE_ATTRIBUTE_DIRECTORY |
1779 FILE_ATTRIBUTE_REPARSE_POINT))
1782 from_dentry_parent = get_parent_dentry(wim, from, WIMLIB_CASE_SENSITIVE);
1783 if (!from_dentry_parent)
1785 if (!dentry_is_directory(from_dentry_parent))
1788 link_name = path_basename(from);
1789 if (get_dentry_child_with_name(from_dentry_parent, link_name,
1790 WIMLIB_CASE_SENSITIVE))
1793 ret = new_dentry(link_name, &from_dentry);
1798 inode_ref_streams(inode);
1799 from_dentry->d_inode = inode;
1800 inode_add_dentry(from_dentry, inode);
1801 dentry_add_child(from_dentry_parent, from_dentry);
1807 wimfs_listxattr(const char *path, char *list, size_t size)
1810 struct wim_inode *inode;
1811 struct wimfs_context *ctx = wimfs_get_context();
1814 bool size_only = (size == 0);
1816 if (!(ctx->mount_flags & WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR))
1819 /* List alternate data streams, or get the list size */
1821 inode = wim_pathname_to_inode(ctx->wim, path);
1826 for (i = 0; i < inode->i_num_ads; i++) {
1828 if (!ads_entry_is_named_stream(&inode->i_ads_entries[i]))
1831 char *stream_name_mbs;
1832 size_t stream_name_mbs_nbytes;
1835 ret = utf16le_to_tstr(inode->i_ads_entries[i].stream_name,
1836 inode->i_ads_entries[i].stream_name_nbytes,
1838 &stream_name_mbs_nbytes);
1842 needed_size = stream_name_mbs_nbytes + 6;
1844 if (needed_size > size) {
1845 FREE(stream_name_mbs);
1848 sprintf(p, "user.%s", stream_name_mbs);
1849 size -= needed_size;
1852 FREE(stream_name_mbs);
1859 /* Create a directory in the WIM image. */
1861 wimfs_mkdir(const char *path, mode_t mode)
1863 return create_dentry(fuse_get_context(), path, mode | S_IFDIR,
1864 FILE_ATTRIBUTE_DIRECTORY, NULL);
1867 /* Create a regular file or alternate data stream in the WIM image. */
1869 wimfs_mknod(const char *path, mode_t mode, dev_t rdev)
1871 const char *stream_name;
1872 struct fuse_context *fuse_ctx = fuse_get_context();
1873 struct wimfs_context *wimfs_ctx = WIMFS_CTX(fuse_ctx);
1878 if ((wimfs_ctx->mount_flags & WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS)
1879 && (stream_name = path_stream_name(path))) {
1880 /* Make an alternate data stream */
1881 struct wim_ads_entry *new_entry;
1882 struct wim_inode *inode;
1884 char *p = (char*)stream_name - 1;
1885 wimlib_assert(*p == ':');
1888 inode = wim_pathname_to_inode(wimfs_ctx->wim, path);
1891 if (inode->i_attributes & FILE_ATTRIBUTE_REPARSE_POINT)
1893 if (inode_get_ads_entry(inode, stream_name, NULL))
1895 new_entry = inode_add_ads(inode, stream_name);
1900 /* Make a normal file (not an alternate data stream) */
1901 return create_dentry(fuse_ctx, path, mode | S_IFREG,
1902 FILE_ATTRIBUTE_NORMAL, NULL);
1908 wimfs_open(const char *path, struct fuse_file_info *fi)
1910 struct wim_dentry *dentry;
1911 struct wim_lookup_table_entry *lte;
1913 struct wimfs_fd *fd;
1914 struct wim_inode *inode;
1917 struct wimfs_context *ctx = wimfs_get_context();
1918 struct wim_lookup_table_entry **back_ptr;
1920 ret = wim_pathname_to_stream(ctx->wim, path, get_lookup_flags(ctx),
1921 &dentry, <e, &stream_idx);
1925 inode = dentry->d_inode;
1927 if (stream_idx == 0) {
1929 back_ptr = &inode->i_lte;
1931 stream_id = inode->i_ads_entries[stream_idx - 1].stream_id;
1932 back_ptr = &inode->i_ads_entries[stream_idx - 1].lte;
1935 /* The file resource may be in the staging directory (read-write mounts
1936 * only) or in the WIM. If it's in the staging directory, we need to
1937 * open a native file descriptor for the corresponding file. Otherwise,
1938 * we can read the file resource directly from the WIM file if we are
1939 * opening it read-only, but we need to extract the resource to the
1940 * staging directory if we are opening it writable. */
1942 if (flags_writable(fi->flags) &&
1943 (!lte || lte->resource_location != RESOURCE_IN_STAGING_FILE)) {
1944 u64 size = (lte) ? lte->size : 0;
1945 ret = extract_resource_to_staging_dir(inode, stream_id,
1952 ret = alloc_wimfs_fd(inode, stream_id, lte, &fd);
1956 if (lte && lte->resource_location == RESOURCE_IN_STAGING_FILE) {
1959 raw_fd = open(lte->staging_file_name, fi->flags);
1961 int errno_save = errno;
1965 filedes_init(&fd->staging_fd, raw_fd);
1967 fi->fh = (uintptr_t)fd;
1971 /* Opens a directory. */
1973 wimfs_opendir(const char *path, struct fuse_file_info *fi)
1975 struct wim_inode *inode;
1977 struct wimfs_fd *fd = NULL;
1978 struct wimfs_context *ctx = wimfs_get_context();
1979 WIMStruct *wim = ctx->wim;
1981 inode = wim_pathname_to_inode(wim, path);
1984 if (!inode_is_directory(inode))
1986 ret = alloc_wimfs_fd(inode, 0, NULL, &fd);
1987 fi->fh = (uintptr_t)fd;
1993 * Read data from a file in the WIM or in the staging directory.
1996 wimfs_read(const char *path, char *buf, size_t size,
1997 off_t offset, struct fuse_file_info *fi)
1999 struct wimfs_fd *fd = (struct wimfs_fd*)(uintptr_t)fi->fh;
2010 stream_size = fd->f_lte->size;
2014 if (offset > stream_size)
2017 size = min(size, stream_size - offset);
2021 switch (fd->f_lte->resource_location) {
2022 case RESOURCE_IN_STAGING_FILE:
2023 ret = raw_pread(&fd->staging_fd, buf, size, offset);
2027 case RESOURCE_IN_WIM:
2028 if (read_partial_wim_stream_into_buf(fd->f_lte, size,
2030 ret = errno ? -errno : -EIO;
2034 case RESOURCE_IN_ATTACHED_BUFFER:
2035 memcpy(buf, fd->f_lte->attached_buffer + offset, size);
2039 ERROR("Invalid resource location");
2046 /* Fills in the entries of the directory specified by @path using the
2047 * FUSE-provided function @filler. */
2049 wimfs_readdir(const char *path, void *buf, fuse_fill_dir_t filler,
2050 off_t offset, struct fuse_file_info *fi)
2052 struct wimfs_fd *fd = (struct wimfs_fd*)(uintptr_t)fi->fh;
2053 struct wim_inode *inode;
2054 struct wim_dentry *child;
2060 inode = fd->f_inode;
2062 ret = filler(buf, ".", NULL, 0);
2065 ret = filler(buf, "..", NULL, 0);
2069 for_inode_child(child, inode) {
2070 char *file_name_mbs;
2071 size_t file_name_mbs_nbytes;
2073 ret = utf16le_to_tstr(child->file_name,
2074 child->file_name_nbytes,
2076 &file_name_mbs_nbytes);
2080 ret = filler(buf, file_name_mbs, NULL, 0);
2081 FREE(file_name_mbs);
2090 wimfs_readlink(const char *path, char *buf, size_t buf_len)
2092 struct wimfs_context *ctx = wimfs_get_context();
2093 struct wim_inode *inode = wim_pathname_to_inode(ctx->wim, path);
2097 if (!inode_is_symlink(inode))
2101 ret = wim_inode_readlink(inode, buf, buf_len - 1, NULL);
2103 wimlib_assert(ret <= buf_len - 1);
2106 } else if (ret == -ENAMETOOLONG) {
2107 buf[buf_len - 1] = '\0';
2114 wimfs_release(const char *path, struct fuse_file_info *fi)
2116 struct wimfs_fd *fd = (struct wimfs_fd*)(uintptr_t)fi->fh;
2117 return close_wimfs_fd(fd);
2120 /* Close a directory */
2122 wimfs_releasedir(const char *path, struct fuse_file_info *fi)
2124 struct wimfs_fd *fd = (struct wimfs_fd*)(uintptr_t)fi->fh;
2125 return close_wimfs_fd(fd);
2129 /* Remove an alternate data stream through the XATTR interface */
2131 wimfs_removexattr(const char *path, const char *name)
2133 struct wim_inode *inode;
2134 struct wim_ads_entry *ads_entry;
2136 struct wimfs_context *ctx = wimfs_get_context();
2138 if (!(ctx->mount_flags & WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR))
2141 if (strlen(name) < 5 || memcmp(name, "user.", 5) != 0)
2145 inode = wim_pathname_to_inode(ctx->wim, path);
2149 ads_entry = inode_get_ads_entry(inode, name, &ads_idx);
2152 inode_remove_ads(inode, ads_idx, ctx->wim->lookup_table);
2157 /* Renames a file or directory. See rename (3) */
2159 wimfs_rename(const char *from, const char *to)
2161 return rename_wim_path(wimfs_get_WIMStruct(), from, to,
2162 WIMLIB_CASE_SENSITIVE, NULL);
2165 /* Remove a directory */
2167 wimfs_rmdir(const char *path)
2169 struct wim_dentry *dentry;
2170 WIMStruct *wim = wimfs_get_WIMStruct();
2172 dentry = get_dentry(wim, path, WIMLIB_CASE_SENSITIVE);
2176 if (!dentry_is_directory(dentry))
2179 if (dentry_has_children(dentry))
2182 remove_dentry(dentry, wim->lookup_table);
2187 /* Write an alternate data stream through the XATTR interface */
2189 wimfs_setxattr(const char *path, const char *name,
2190 const char *value, size_t size, int flags)
2192 struct wim_ads_entry *existing_ads_entry;
2193 struct wim_inode *inode;
2195 struct wimfs_context *ctx = wimfs_get_context();
2198 if (!(ctx->mount_flags & WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR))
2201 if (strlen(name) <= 5 || memcmp(name, "user.", 5) != 0)
2205 inode = wim_pathname_to_inode(ctx->wim, path);
2209 existing_ads_entry = inode_get_ads_entry(inode, name, &ads_idx);
2210 if (existing_ads_entry) {
2211 if (flags & XATTR_CREATE)
2214 if (flags & XATTR_REPLACE)
2218 ret = inode_add_ads_with_data(inode, name, value,
2219 size, ctx->wim->lookup_table);
2221 if (existing_ads_entry)
2222 inode_remove_ads(inode, ads_idx, ctx->wim->lookup_table);
2231 wimfs_symlink(const char *to, const char *from)
2233 struct fuse_context *fuse_ctx = fuse_get_context();
2234 struct wimfs_context *wimfs_ctx = WIMFS_CTX(fuse_ctx);
2235 struct wim_dentry *dentry;
2238 ret = create_dentry(fuse_ctx, from, S_IFLNK | 0777,
2239 FILE_ATTRIBUTE_REPARSE_POINT, &dentry);
2241 dentry->d_inode->i_reparse_tag = WIM_IO_REPARSE_TAG_SYMLINK;
2242 ret = wim_inode_set_symlink(dentry->d_inode, to,
2243 wimfs_ctx->wim->lookup_table);
2245 remove_dentry(dentry, wimfs_ctx->wim->lookup_table);
2246 if (ret == WIMLIB_ERR_NOMEM)
2256 /* Reduce the size of a file */
2258 wimfs_truncate(const char *path, off_t size)
2260 struct wim_dentry *dentry;
2261 struct wim_lookup_table_entry *lte;
2265 struct wim_inode *inode;
2266 struct wimfs_context *ctx = wimfs_get_context();
2268 ret = wim_pathname_to_stream(ctx->wim, path, get_lookup_flags(ctx),
2269 &dentry, <e, &stream_idx);
2274 if (lte == NULL && size == 0)
2277 if (lte != NULL && lte->resource_location == RESOURCE_IN_STAGING_FILE) {
2278 ret = truncate(lte->staging_file_name, size);
2284 /* File in WIM. Extract it to the staging directory, but only
2285 * the first @size bytes of it. */
2286 struct wim_lookup_table_entry **back_ptr;
2288 inode = dentry->d_inode;
2289 if (stream_idx == 0) {
2291 back_ptr = &inode->i_lte;
2293 stream_id = inode->i_ads_entries[stream_idx - 1].stream_id;
2294 back_ptr = &inode->i_ads_entries[stream_idx - 1].lte;
2296 ret = extract_resource_to_staging_dir(inode, stream_id,
2303 /* Unlink a non-directory or alternate data stream */
2305 wimfs_unlink(const char *path)
2307 struct wim_dentry *dentry;
2308 struct wim_lookup_table_entry *lte;
2311 struct wimfs_context *ctx = wimfs_get_context();
2313 ret = wim_pathname_to_stream(ctx->wim, path, get_lookup_flags(ctx),
2314 &dentry, <e, &stream_idx);
2319 if (inode_stream_name_nbytes(dentry->d_inode, stream_idx) == 0)
2320 remove_dentry(dentry, ctx->wim->lookup_table);
2322 inode_remove_ads(dentry->d_inode, stream_idx - 1,
2323 ctx->wim->lookup_table);
2327 #ifdef HAVE_UTIMENSAT
2329 * Change the timestamp on a file dentry.
2331 * Note that alternate data streams do not have their own timestamps.
2334 wimfs_utimens(const char *path, const struct timespec tv[2])
2336 struct wim_inode *inode;
2337 WIMStruct *wim = wimfs_get_WIMStruct();
2339 inode = wim_pathname_to_inode(wim, path);
2343 if (tv[0].tv_nsec != UTIME_OMIT) {
2344 if (tv[0].tv_nsec == UTIME_NOW)
2345 inode->i_last_access_time = get_wim_timestamp();
2347 inode->i_last_access_time = timespec_to_wim_timestamp(tv[0]);
2349 if (tv[1].tv_nsec != UTIME_OMIT) {
2350 if (tv[1].tv_nsec == UTIME_NOW)
2351 inode->i_last_write_time = get_wim_timestamp();
2353 inode->i_last_write_time = timespec_to_wim_timestamp(tv[1]);
2357 #else /* HAVE_UTIMENSAT */
2359 wimfs_utime(const char *path, struct utimbuf *times)
2361 struct wim_inode *inode;
2362 WIMStruct *wim = wimfs_get_WIMStruct();
2364 inode = wim_pathname_to_inode(wim, path);
2368 inode->i_last_write_time = unix_timestamp_to_wim(times->modtime);
2369 inode->i_last_access_time = unix_timestamp_to_wim(times->actime);
2372 #endif /* !HAVE_UTIMENSAT */
2374 /* Writes to a file in the WIM filesystem.
2375 * It may be an alternate data stream, but here we don't even notice because we
2376 * just get a lookup table entry. */
2378 wimfs_write(const char *path, const char *buf, size_t size,
2379 off_t offset, struct fuse_file_info *fi)
2381 struct wimfs_fd *fd = (struct wimfs_fd*)(uintptr_t)fi->fh;
2387 wimlib_assert(fd->f_lte != NULL);
2388 wimlib_assert(fd->f_lte->staging_file_name != NULL);
2389 wimlib_assert(filedes_valid(&fd->staging_fd));
2390 wimlib_assert(fd->f_inode != NULL);
2392 /* Write the data. */
2393 ret = raw_pwrite(&fd->staging_fd, buf, size, offset);
2397 /* Update file size */
2398 if (offset + size > fd->f_lte->size) {
2399 DEBUG("Update file size %"PRIu64 " => %"PRIu64"",
2400 fd->f_lte->size, offset + size);
2401 fd->f_lte->size = offset + size;
2404 /* Update timestamps */
2405 touch_inode(fd->f_inode);
2409 static struct fuse_operations wimfs_operations = {
2410 .chmod = wimfs_chmod,
2411 .chown = wimfs_chown,
2412 .destroy = wimfs_destroy,
2413 .fgetattr = wimfs_fgetattr,
2414 .ftruncate = wimfs_ftruncate,
2415 .getattr = wimfs_getattr,
2417 .getxattr = wimfs_getxattr,
2421 .listxattr = wimfs_listxattr,
2423 .mkdir = wimfs_mkdir,
2424 .mknod = wimfs_mknod,
2426 .opendir = wimfs_opendir,
2428 .readdir = wimfs_readdir,
2429 .readlink = wimfs_readlink,
2430 .release = wimfs_release,
2431 .releasedir = wimfs_releasedir,
2433 .removexattr = wimfs_removexattr,
2435 .rename = wimfs_rename,
2436 .rmdir = wimfs_rmdir,
2438 .setxattr = wimfs_setxattr,
2440 .symlink = wimfs_symlink,
2441 .truncate = wimfs_truncate,
2442 .unlink = wimfs_unlink,
2443 #ifdef HAVE_UTIMENSAT
2444 .utimens = wimfs_utimens,
2446 .utime = wimfs_utime,
2448 .write = wimfs_write,
2450 /* wimfs keeps file descriptor structures (struct wimfs_fd), so there is
2451 * no need to have the file path provided on operations such as read()
2452 * where only the file descriptor is needed. */
2453 #if FUSE_MAJOR_VERSION > 2 || (FUSE_MAJOR_VERSION == 2 && FUSE_MINOR_VERSION >= 8)
2454 .flag_nullpath_ok = 1,
2456 #if FUSE_MAJOR_VERSION > 2 || (FUSE_MAJOR_VERSION == 2 && FUSE_MINOR_VERSION >= 9)
2458 .flag_utime_omit_ok = 1,
2463 /* API function documented in wimlib.h */
2465 wimlib_mount_image(WIMStruct *wim, int image, const char *dir,
2466 int mount_flags, const char *staging_dir)
2472 struct wim_image_metadata *imd;
2473 struct wimfs_context ctx;
2474 struct wim_inode *inode;
2476 DEBUG("Mount: wim = %p, image = %d, dir = %s, flags = %d, ",
2477 wim, image, dir, mount_flags);
2480 return WIMLIB_ERR_INVALID_PARAM;
2482 if (mount_flags & ~(WIMLIB_MOUNT_FLAG_READWRITE |
2483 WIMLIB_MOUNT_FLAG_DEBUG |
2484 WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE |
2485 WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR |
2486 WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS |
2487 WIMLIB_MOUNT_FLAG_UNIX_DATA |
2488 WIMLIB_MOUNT_FLAG_ALLOW_OTHER))
2489 return WIMLIB_ERR_INVALID_PARAM;
2491 if (mount_flags & WIMLIB_MOUNT_FLAG_READWRITE) {
2492 ret = can_delete_from_wim(wim);
2497 ret = select_wim_image(wim, image);
2501 DEBUG("Selected image %d", image);
2503 imd = wim_get_current_image_metadata(wim);
2505 if (imd->modified) {
2506 /* wimfs_read() only supports a limited number of stream
2507 * locations, not including RESOURCE_IN_FILE_ON_DISK,
2508 * RESOURCE_IN_NTFS_VOLUME, etc. that might appear if files were
2509 * added to the WIM image. */
2510 ERROR("Cannot mount an image with newly added files!");
2511 return WIMLIB_ERR_INVALID_PARAM;
2514 if (mount_flags & WIMLIB_MOUNT_FLAG_READWRITE) {
2515 ret = lock_wim(wim, wim->in_fd.fd);
2520 /* Use default stream interface if one was not specified */
2521 if (!(mount_flags & (WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE |
2522 WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR |
2523 WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS)))
2524 mount_flags |= WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR;
2526 DEBUG("Initializing struct wimfs_context");
2527 init_wimfs_context(&ctx);
2529 ctx.mount_flags = mount_flags;
2530 ctx.image_inode_list = &imd->inode_list;
2531 ctx.default_uid = getuid();
2532 ctx.default_gid = getgid();
2533 wimlib_assert(list_empty(&imd->unhashed_streams));
2534 if (mount_flags & WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS)
2535 ctx.default_lookup_flags = LOOKUP_FLAG_ADS_OK;
2537 DEBUG("Unlinking message queues in case they already exist");
2538 ret = set_message_queue_names(&ctx, dir);
2541 unlink_message_queues(&ctx);
2543 DEBUG("Preparing arguments to fuse_main()");
2545 dir_copy = STRDUP(dir);
2547 ret = WIMLIB_ERR_NOMEM;
2548 goto out_free_message_queue_names;
2552 argv[argc++] = "wimlib";
2553 argv[argc++] = dir_copy;
2555 /* disable multi-threaded operation */
2556 argv[argc++] = "-s";
2558 if (mount_flags & WIMLIB_MOUNT_FLAG_DEBUG)
2559 argv[argc++] = "-d";
2562 * We provide the use_ino option to the FUSE mount because we are going
2563 * to assign inode numbers ourselves. */
2564 char optstring[256] =
2568 #if FUSE_MAJOR_VERSION > 2 || (FUSE_MAJOR_VERSION == 2 && FUSE_MINOR_VERSION >= 8)
2571 ",default_permissions"
2573 argv[argc++] = "-o";
2574 argv[argc++] = optstring;
2575 if ((mount_flags & WIMLIB_MOUNT_FLAG_READWRITE)) {
2576 /* Read-write mount. Make the staging directory */
2577 ret = make_staging_dir(&ctx, staging_dir);
2579 goto out_free_dir_copy;
2581 /* Read-only mount */
2582 strcat(optstring, ",ro");
2584 if (mount_flags & WIMLIB_MOUNT_FLAG_ALLOW_OTHER)
2585 strcat(optstring, ",allow_other");
2591 DEBUG("FUSE command line (argc = %d): ", argc);
2592 for (i = 0; i < argc; i++) {
2593 fputs(argv[i], stdout);
2601 /* Assign inode numbers. Also, if a read-write mount was requested,
2602 * mark the dentry tree as modified, and add each stream referenced by
2603 * files in the image to a list and preemptively double the number of
2604 * references to each. The latter is done to allow implementing the
2605 * WIMLIB_UNMOUNT_FLAG_NEW_IMAGE semantics. */
2607 INIT_LIST_HEAD(&ctx.orig_stream_list);
2608 if (mount_flags & WIMLIB_MOUNT_FLAG_READWRITE) {
2610 image_for_each_inode(inode, imd) {
2611 inode->i_ino = ctx.next_ino++;
2612 for (unsigned i = 0; i <= inode->i_num_ads; i++) {
2613 struct wim_lookup_table_entry *lte;
2615 lte = inode_stream_lte(inode, i, wim->lookup_table);
2617 lte->out_refcnt = 0;
2620 image_for_each_inode(inode, imd) {
2621 for (unsigned i = 0; i <= inode->i_num_ads; i++) {
2622 struct wim_lookup_table_entry *lte;
2624 lte = inode_stream_lte(inode, i,
2627 if (lte->out_refcnt == 0)
2628 list_add(<e->orig_stream_list,
2629 &ctx.orig_stream_list);
2630 lte->out_refcnt += inode->i_nlink;
2631 lte->refcnt += inode->i_nlink;
2636 image_for_each_inode(inode, imd)
2637 inode->i_ino = ctx.next_ino++;
2640 DEBUG("(next_ino = %"PRIu64")", ctx.next_ino);
2642 DEBUG("Calling fuse_main()");
2644 ret = fuse_main(argc, argv, &wimfs_operations, &ctx);
2646 DEBUG("Returned from fuse_main() (ret = %d)", ret);
2649 ret = WIMLIB_ERR_FUSE;
2651 if (ctx.have_status)
2654 ret = WIMLIB_ERR_TIMEOUT;
2656 if (ctx.daemon_to_unmount_mq != (mqd_t)(-1)) {
2657 send_unmount_finished_msg(ctx.daemon_to_unmount_mq, ret);
2658 close_message_queues(&ctx);
2661 release_extra_refcnts(&ctx);
2663 /* Try to delete the staging directory if a deletion wasn't yet
2664 * attempted due to an earlier error */
2665 if (ctx.staging_dir_name)
2666 delete_staging_dir(&ctx);
2670 wim->wim_locked = 0;
2671 out_free_message_queue_names:
2672 free_message_queue_names(&ctx);
2676 /* API function documented in wimlib.h */
2678 wimlib_unmount_image(const char *dir, int unmount_flags,
2679 wimlib_progress_func_t progress_func)
2682 struct wimfs_context wimfs_ctx;
2684 if (unmount_flags & ~(WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY |
2685 WIMLIB_UNMOUNT_FLAG_COMMIT |
2686 WIMLIB_UNMOUNT_FLAG_REBUILD |
2687 WIMLIB_UNMOUNT_FLAG_RECOMPRESS |
2688 WIMLIB_UNMOUNT_FLAG_LAZY |
2689 WIMLIB_UNMOUNT_FLAG_NEW_IMAGE))
2690 return WIMLIB_ERR_INVALID_PARAM;
2692 init_wimfs_context(&wimfs_ctx);
2694 ret = set_message_queue_names(&wimfs_ctx, dir);
2698 ret = open_message_queues(&wimfs_ctx, false);
2700 goto out_free_message_queue_names;
2702 ret = send_unmount_request_msg(wimfs_ctx.unmount_to_daemon_mq,
2704 progress_func != NULL);
2706 goto out_close_message_queues;
2708 ret = execute_fusermount(dir, (unmount_flags & WIMLIB_UNMOUNT_FLAG_LAZY) != 0);
2710 goto out_close_message_queues;
2712 struct unmount_msg_handler_context handler_ctx = {
2714 .timeout_seconds = 5,
2717 .progress_func = progress_func,
2720 ret = message_loop(wimfs_ctx.daemon_to_unmount_mq,
2721 &unmount_msg_handler_callbacks,
2724 ret = handler_ctx.status;
2725 out_close_message_queues:
2726 close_message_queues(&wimfs_ctx);
2727 out_free_message_queue_names:
2728 free_message_queue_names(&wimfs_ctx);
2733 #else /* WITH_FUSE */
2737 mount_unsupported_error(void)
2739 #if defined(__WIN32__)
2740 ERROR("Sorry-- Mounting WIM images is not supported on Windows!");
2742 ERROR("wimlib was compiled with --without-fuse, which disables support "
2743 "for mounting WIMs.");
2745 return WIMLIB_ERR_UNSUPPORTED;
2749 wimlib_unmount_image(const tchar *dir, int unmount_flags,
2750 wimlib_progress_func_t progress_func)
2752 return mount_unsupported_error();
2756 wimlib_mount_image(WIMStruct *wim, int image, const tchar *dir,
2757 int mount_flags, const tchar *staging_dir)
2759 return mount_unsupported_error();
2762 #endif /* !WITH_FUSE */