4 * This file implements mounting of WIM images using FUSE
5 * (Filesystem in Userspace). See http://fuse.sourceforge.net/.
7 * Currently it is only expected to work on Linux.
11 * Copyright (C) 2012, 2013, 2014, 2015 Eric Biggers
13 * This file is free software; you can redistribute it and/or modify it under
14 * the terms of the GNU Lesser General Public License as published by the Free
15 * Software Foundation; either version 3 of the License, or (at your option) any
18 * This file is distributed in the hope that it will be useful, but WITHOUT
19 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
20 * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
23 * You should have received a copy of the GNU Lesser General Public License
24 * along with this file; if not, see http://www.gnu.org/licenses/.
32 #include "wimlib/error.h"
37 # error "FUSE mount not supported on Windows! Please configure --without-fuse"
40 #define FUSE_USE_VERSION 26
42 #include <attr/xattr.h>
53 #include <sys/types.h>
57 #include "wimlib/blob_table.h"
58 #include "wimlib/dentry.h"
59 #include "wimlib/encoding.h"
60 #include "wimlib/metadata.h"
61 #include "wimlib/paths.h"
62 #include "wimlib/progress.h"
63 #include "wimlib/reparse.h"
64 #include "wimlib/timestamp.h"
65 #include "wimlib/unix_data.h"
66 #include "wimlib/write.h"
67 #include "wimlib/xml.h"
70 # define O_NOFOLLOW 0 /* Security only... */
73 #define WIMFS_MQUEUE_NAME_LEN 32
75 #define WIMLIB_UNMOUNT_FLAG_SEND_PROGRESS 0x80000000
77 struct wimfs_unmount_info {
78 unsigned unmount_flags;
79 char mq_name[WIMFS_MQUEUE_NAME_LEN + 1];
82 struct commit_progress_report {
83 enum wimlib_progress_msg msg;
84 union wimlib_progress_info info;
87 /* Description of an open file on a mounted WIM image. Actually, this
88 * represents the open state of a particular data stream of an inode, rather
89 * than the inode itself. (An inode might have multiple named data streams in
90 * addition to the default, unnamed data stream.) At a given time, an inode in
91 * the WIM image might have multiple file descriptors open to it, each to any
92 * one of its data streams. */
95 /* Pointer to the inode of this open file.
96 * 'i_num_opened_fds' of the inode tracks the number of file descriptors
97 * that reference it. */
98 struct wim_inode *f_inode;
100 /* Pointer to the blob descriptor for the data stream that has been
101 * opened. 'num_opened_fds' of the blob descriptor tracks the number of
102 * file descriptors that reference it. Or, this value may be NULL,
103 * which indicates that the opened stream is empty and consequently does
104 * not have a blob descriptor. */
105 struct blob_descriptor *f_blob;
107 /* If valid (filedes_valid(&f_staging_fd)), this contains the
108 * corresponding native file descriptor for the staging file that has
109 * been created for reading from and/or writing to this open stream. A
110 * single staging file might have multiple file descriptors open to it
111 * simultaneously, each used by a different 'struct wimfs_fd'.
113 * Or, if invalid (!filedes_valid(&f_staging_fd)), this 'struct
114 * wimfs_fd' is not associated with a staging file. This is permissible
115 * only if this 'struct wimfs_fd' was opened read-only and the stream
116 * has not yet been extracted to a staging file. */
117 struct filedes f_staging_fd;
119 /* 0-based index of this file descriptor in the file descriptor table of
123 /* Unique ID of the opened stream in the inode. This will stay the same
124 * even if the indices of the inode's streams are changed by a deletion.
129 #define WIMFS_FD(fi) ((struct wimfs_fd *)(uintptr_t)((fi)->fh))
131 /* Context structure for a mounted WIM image. */
132 struct wimfs_context {
133 /* The WIMStruct containing the mounted image. The mounted image is the
134 * currently selected image (wim->current_image). */
137 /* Flags passed to wimlib_mount_image() (WIMLIB_MOUNT_FLAG_*). */
140 /* Default flags for path lookup in the WIM image. */
141 int default_lookup_flags;
143 /* Information about the user who has mounted the WIM image */
147 /* Information about the staging directory for a read-write mount. */
150 char *staging_dir_name;
152 /* For read-write mounts, the inode number to be assigned to the next
153 * created file. Note: since this isn't a persistent filesystem and we
154 * can re-assign the inode numbers just before mounting the image, it's
155 * good enough to just generate inode numbers sequentially. */
158 /* Number of file descriptors open to the mounted WIM image. */
159 unsigned long num_open_fds;
161 /* Original list of blobs in the mounted image, linked by
162 * 'struct blob_descriptor'.orig_blob_list. */
163 struct list_head orig_blob_list;
165 /* Parameters for unmounting the image (can be set via extended
166 * attribute "wimfs.unmount_info"). */
167 struct wimfs_unmount_info unmount_info;
170 #define WIMFS_CTX(fuse_ctx) ((struct wimfs_context*)(fuse_ctx)->private_data)
172 /* Retrieve the context structure for the currently mounted WIM image.
174 * Note: this is a per-thread variable. It is possible for different threads to
175 * mount different images at the same time in the same process, although they
176 * must use different WIMStructs! */
177 static inline struct wimfs_context *
178 wimfs_get_context(void)
180 return WIMFS_CTX(fuse_get_context());
184 wimfs_inc_num_open_fds(void)
186 wimfs_get_context()->num_open_fds++;
190 wimfs_dec_num_open_fds(void)
192 wimfs_get_context()->num_open_fds--;
195 /* Retrieve the WIMStruct for the currently mounted WIM image. */
196 static inline WIMStruct *
197 wimfs_get_WIMStruct(void)
199 return wimfs_get_context()->wim;
202 /* Is write permission requested on the file? */
204 flags_writable(int open_flags)
206 int accmode = (open_flags & O_ACCMODE);
207 return (accmode == O_RDWR || accmode == O_WRONLY);
211 fuse_mask_mode(mode_t mode, const struct fuse_context *fuse_ctx)
213 #if FUSE_MAJOR_VERSION > 2 || (FUSE_MAJOR_VERSION == 2 && FUSE_MINOR_VERSION >= 8)
214 mode &= ~fuse_ctx->umask;
220 * Allocate a file descriptor to a data stream in the mounted WIM image.
223 * The inode containing the stream being opened
225 * The stream of the inode being opened
227 * On success, a pointer to the new file descriptor will be stored here.
229 * Returns 0 or a -errno code.
232 alloc_wimfs_fd(struct wim_inode *inode,
233 struct wim_inode_stream *strm,
234 struct wimfs_fd **fd_ret)
236 static const u16 min_fds_per_alloc = 8;
237 static const u16 max_fds = 0xffff;
241 if (inode->i_num_opened_fds == inode->i_num_allocated_fds) {
243 struct wimfs_fd **fds;
245 /* Expand this inode's file descriptor table. */
247 num_new_fds = max(min_fds_per_alloc,
248 inode->i_num_allocated_fds / 4);
250 num_new_fds = min(num_new_fds,
251 max_fds - inode->i_num_allocated_fds);
253 if (num_new_fds == 0)
256 fds = REALLOC(inode->i_fds,
257 (inode->i_num_allocated_fds + num_new_fds) *
262 memset(&fds[inode->i_num_allocated_fds], 0,
263 num_new_fds * sizeof(fds[0]));
265 inode->i_num_allocated_fds += num_new_fds;
266 inode->i_next_fd = inode->i_num_opened_fds;
269 /* Allocate the file descriptor in the first available space in the
270 * inode's file descriptor table.
272 * i_next_fd is the lower bound on the next open slot. */
273 for (i = inode->i_next_fd; inode->i_fds[i]; i++)
276 fd = MALLOC(sizeof(*fd));
281 fd->f_blob = stream_blob_resolved(strm);
282 filedes_invalidate(&fd->f_staging_fd);
284 fd->f_stream_id = strm->stream_id;
286 inode->i_fds[i] = fd;
287 inode->i_num_opened_fds++;
289 fd->f_blob->num_opened_fds++;
290 wimfs_inc_num_open_fds();
291 inode->i_next_fd = i + 1;
296 * Close a file descriptor to a data stream in the mounted WIM image.
298 * Returns 0 or a -errno code. The file descriptor is always closed.
301 close_wimfs_fd(struct wimfs_fd *fd)
304 struct wim_inode *inode;
306 /* Close the staging file if open. */
307 if (filedes_valid(&fd->f_staging_fd))
308 if (filedes_close(&fd->f_staging_fd))
311 /* Release this file descriptor from its blob descriptor. */
313 blob_decrement_num_opened_fds(fd->f_blob);
315 wimfs_dec_num_open_fds();
317 /* Release this file descriptor from its inode. */
319 inode->i_fds[fd->f_idx] = NULL;
320 if (fd->f_idx < inode->i_next_fd)
321 inode->i_next_fd = fd->f_idx;
323 inode_dec_num_opened_fds(inode);
328 * Translate a path into the corresponding inode in the mounted WIM image.
330 * See get_dentry() for more information.
332 * Returns a pointer to the resulting inode, or NULL with errno set.
334 static struct wim_inode *
335 wim_pathname_to_inode(WIMStruct *wim, const char *path)
337 struct wim_dentry *dentry;
339 dentry = get_dentry(wim, path, WIMLIB_CASE_SENSITIVE);
342 return dentry->d_inode;
345 /* Can look up named data stream with colon syntax */
346 #define LOOKUP_FLAG_ADS_OK 0x01
348 /* Can look up directory (otherwise get -ENOTDIR) */
349 #define LOOKUP_FLAG_DIRECTORY_OK 0x02
351 /* Get the data stream of the specified name from the specified inode. Returns
352 * NULL with errno set if not found. */
353 static struct wim_inode_stream *
354 inode_get_data_stream_tstr(const struct wim_inode *inode,
355 const char *stream_name)
357 struct wim_inode_stream *strm;
359 if (!stream_name || !*stream_name) {
360 strm = inode_get_unnamed_data_stream(inode);
362 const utf16lechar *uname;
364 if (tstr_get_utf16le(stream_name, &uname))
366 strm = inode_get_stream(inode, STREAM_TYPE_DATA, uname);
367 tstr_put_utf16le(uname);
375 * Translate a path into the corresponding dentry and stream in the mounted WIM
378 * Returns 0 or a -errno code. @dentry_ret and @strm_ret are both optional.
381 wim_pathname_to_stream(const struct wimfs_context *ctx,
384 struct wim_dentry **dentry_ret,
385 struct wim_inode_stream **strm_ret)
387 WIMStruct *wim = ctx->wim;
388 struct wim_dentry *dentry;
389 struct wim_inode *inode;
390 struct wim_inode_stream *strm;
391 const char *stream_name = NULL;
394 lookup_flags |= ctx->default_lookup_flags;
396 if (lookup_flags & LOOKUP_FLAG_ADS_OK) {
397 stream_name = path_stream_name(path);
399 p = (char *)stream_name - 1;
404 dentry = get_dentry(wim, path, WIMLIB_CASE_SENSITIVE);
410 inode = dentry->d_inode;
412 if (inode_resolve_streams(inode, wim->blob_table, false))
415 if (!(lookup_flags & LOOKUP_FLAG_DIRECTORY_OK)
416 && inode_is_directory(inode))
419 strm = inode_get_data_stream_tstr(inode, stream_name);
421 /* Force creation of an unnamed data stream */
423 strm = inode_add_stream(inode, STREAM_TYPE_DATA,
424 NO_STREAM_NAME, NULL);
430 *dentry_ret = dentry;
437 * Create a new file in the mounted WIM image.
440 * The FUSE context for the mounted image.
442 * The path at which to create the first link to the new file. If a file
443 * already exists at this path, -EEXIST is returned.
445 * The UNIX mode for the new file. This is only honored if
446 * WIMLIB_MOUNT_FLAG_UNIX_DATA was passed to wimlib_mount_image().
448 * The device ID for the new file, encoding the major and minor device
449 * numbers. This is only honored if WIMLIB_MOUNT_FLAG_UNIX_DATA was passed
450 * to wimlib_mount_image().
452 * Windows file attributes to use for the new file.
454 * On success, a pointer to the new dentry is returned here. Its d_inode
455 * member will point to the new inode that was created for it and added to
456 * the mounted WIM image.
458 * Returns 0 or a -errno code.
461 create_file(struct fuse_context *fuse_ctx, const char *path,
462 mode_t mode, dev_t rdev, u32 attributes,
463 struct wim_dentry **dentry_ret)
465 struct wimfs_context *wimfs_ctx = WIMFS_CTX(fuse_ctx);
466 struct wim_dentry *parent;
467 const char *basename;
468 struct wim_dentry *new_dentry;
469 struct wim_inode *new_inode;
471 parent = get_parent_dentry(wimfs_ctx->wim, path, WIMLIB_CASE_SENSITIVE);
475 if (!dentry_is_directory(parent))
478 basename = path_basename(path);
480 if (get_dentry_child_with_name(parent, basename, WIMLIB_CASE_SENSITIVE))
483 if (new_dentry_with_new_inode(basename, true, &new_dentry))
486 new_inode = new_dentry->d_inode;
488 new_inode->i_ino = wimfs_ctx->next_ino++;
489 new_inode->i_attributes = attributes;
491 if (wimfs_ctx->mount_flags & WIMLIB_MOUNT_FLAG_UNIX_DATA) {
492 struct wimlib_unix_data unix_data;
494 unix_data.uid = fuse_ctx->uid;
495 unix_data.gid = fuse_ctx->gid;
496 unix_data.mode = fuse_mask_mode(mode, fuse_ctx);
497 unix_data.rdev = rdev;
498 if (!inode_set_unix_data(new_inode, &unix_data, UNIX_DATA_ALL))
500 free_dentry(new_dentry);
505 hlist_add_head(&new_inode->i_hlist,
506 &wim_get_current_image_metadata(wimfs_ctx->wim)->inode_list);
508 dentry_add_child(parent, new_dentry);
510 *dentry_ret = new_dentry;
515 * Remove a dentry from the mounted WIM image; i.e. remove an alias for an
519 remove_dentry(struct wim_dentry *dentry, struct blob_table *blob_table)
521 /* Drop blob references. */
522 inode_unref_blobs(dentry->d_inode, blob_table);
524 /* Unlink the dentry from the image's dentry tree. */
525 unlink_dentry(dentry);
527 /* Delete the dentry. This will also decrement the link count of the
528 * corresponding inode, and possibly cause it to be deleted as well. */
532 /* Generate UNIX filetype mode bits for the specified WIM inode, based on its
533 * Windows file attributes. */
535 inode_unix_file_type(const struct wim_inode *inode)
537 if (inode_is_symlink(inode))
539 else if (inode_is_directory(inode))
545 /* Generate a default UNIX mode for the specified WIM inode. */
547 inode_default_unix_mode(const struct wim_inode *inode)
549 return inode_unix_file_type(inode) | 0777;
553 blob_size(const struct blob_descriptor *blob)
561 blob_stored_size(const struct blob_descriptor *blob)
565 if (blob->blob_location == BLOB_IN_WIM &&
566 blob->size == blob->rdesc->uncompressed_size)
567 return blob->rdesc->size_in_wim;
572 * Retrieve standard UNIX metadata ('struct stat') for a WIM inode.
574 * @blob is the blob descriptor for the stream of the inode that is being
575 * queried, or NULL. We mostly return the same information for all streams, but
576 * st_size and st_blocks may be different for different streams.
578 * This always returns 0.
581 inode_to_stbuf(const struct wim_inode *inode,
582 const struct blob_descriptor *blob, struct stat *stbuf)
584 const struct wimfs_context *ctx = wimfs_get_context();
585 struct wimlib_unix_data unix_data;
587 memset(stbuf, 0, sizeof(struct stat));
588 if ((ctx->mount_flags & WIMLIB_MOUNT_FLAG_UNIX_DATA) &&
589 inode_get_unix_data(inode, &unix_data))
591 /* Use the user ID, group ID, mode, and device ID from the
592 * inode's extra UNIX metadata information. */
593 stbuf->st_uid = unix_data.uid;
594 stbuf->st_gid = unix_data.gid;
595 stbuf->st_mode = unix_data.mode;
596 stbuf->st_rdev = unix_data.rdev;
598 /* Generate default values for the user ID, group ID, and mode.
600 * Note: in the case of an allow_other mount, fuse_context.uid
601 * may not be the same as wimfs_context.owner_uid! */
602 stbuf->st_uid = ctx->owner_uid;
603 stbuf->st_gid = ctx->owner_gid;
604 stbuf->st_mode = inode_default_unix_mode(inode);
606 stbuf->st_ino = inode->i_ino;
607 stbuf->st_nlink = inode->i_nlink;
608 stbuf->st_size = blob_size(blob);
609 #ifdef HAVE_STAT_NANOSECOND_PRECISION
610 stbuf->st_atim = wim_timestamp_to_timespec(inode->i_last_access_time);
611 stbuf->st_mtim = wim_timestamp_to_timespec(inode->i_last_write_time);
612 stbuf->st_ctim = stbuf->st_mtim;
614 stbuf->st_atime = wim_timestamp_to_time_t(inode->i_last_access_time);
615 stbuf->st_mtime = wim_timestamp_to_time_t(inode->i_last_write_time);
616 stbuf->st_ctime = stbuf->st_mtime;
618 stbuf->st_blocks = DIV_ROUND_UP(blob_stored_size(blob), 512);
622 /* Update the last access and last write timestamps of a WIM inode. */
624 touch_inode(struct wim_inode *inode)
626 u64 now = now_as_wim_timestamp();
627 inode->i_last_access_time = now;
628 inode->i_last_write_time = now;
632 touch_parent(struct wim_dentry *dentry)
634 touch_inode(dentry->d_parent->d_inode);
638 * Create a new file in the staging directory for a read-write mounted image.
640 * On success, returns the file descriptor for the new staging file, opened for
641 * writing. In addition, stores the allocated name of the staging file in
644 * On failure, returns -1 and sets errno.
647 create_staging_file(const struct wimfs_context *ctx, char **name_ret)
650 static const size_t STAGING_FILE_NAME_LEN = 20;
654 name = MALLOC(STAGING_FILE_NAME_LEN + 1);
657 name[STAGING_FILE_NAME_LEN] = '\0';
660 randomize_char_array_with_alnum(name, STAGING_FILE_NAME_LEN);
661 fd = openat(ctx->staging_dir_fd, name,
662 O_WRONLY | O_CREAT | O_EXCL | O_NOFOLLOW, 0600);
663 if (unlikely(fd < 0)) {
664 if (unlikely(errno == EEXIST))
665 /* Try again with another name. */
675 * Extract a blob to the staging directory. This is necessary when a stream
676 * using the blob is being opened for writing and the blob has not already been
677 * extracted to the staging directory.
680 * The inode containing the stream being opened for writing.
682 * The stream being opened for writing. The blob descriptor to which the
683 * stream refers will be changed by this function.
685 * Number of bytes of the blob to extract and include in the staging file.
686 * It may be less than the actual blob length, in which case only a prefix
687 * of the blob will be extracted. It may also be more than the actual blob
688 * length, in which case the extra space will be zero-filled.
690 * Returns 0 or a -errno code.
693 extract_blob_to_staging_dir(struct wim_inode *inode,
694 struct wim_inode_stream *strm,
695 off_t size, const struct wimfs_context *ctx)
697 struct blob_descriptor *old_blob;
698 struct blob_descriptor *new_blob;
699 char *staging_file_name;
705 old_blob = stream_blob_resolved(strm);
707 /* Create the staging file. */
708 staging_fd = create_staging_file(ctx, &staging_file_name);
709 if (unlikely(staging_fd < 0))
712 /* Extract the stream to the staging file (possibly truncated). */
716 filedes_init(&fd, staging_fd);
718 extract_size = min(old_blob->size, size);
719 result = extract_blob_to_fd(old_blob, &fd, extract_size);
725 /* In the case of truncate() to more than the file length, extend the
726 * staging file with zeroes by calling ftruncate(). */
727 if (!result && size > extract_size)
728 result = ftruncate(staging_fd, size);
730 /* Close the staging file. */
731 if (close(staging_fd))
734 /* If an error occurred, unlink the staging file. */
735 if (unlikely(result)) {
736 /* extract_blob_to_fd() should set errno, but if it didn't,
737 * set a default value. */
738 ret = errno ? -errno : -EIO;
739 goto out_delete_staging_file;
742 /* Create a blob descriptor for the staging file. */
743 new_blob = new_blob_descriptor();
744 if (unlikely(!new_blob)) {
746 goto out_delete_staging_file;
749 /* There may already be open file descriptors to this stream if it's
750 * previously been opened read-only, but just now we're opening it
751 * read-write. Identify those file descriptors, update them to use the
752 * new blob descriptor, and open staging file descriptors for them. */
753 for (u16 i = 0, j = 0; j < inode->i_num_opened_fds; i++) {
757 fd = inode->i_fds[i];
763 if (fd->f_stream_id != strm->stream_id)
766 /* This is a readonly fd for the same stream. */
767 fd->f_blob = new_blob;
768 new_blob->num_opened_fds++;
769 raw_fd = openat(ctx->staging_dir_fd, staging_file_name,
770 O_RDONLY | O_NOFOLLOW);
771 if (unlikely(raw_fd < 0)) {
773 goto out_revert_fd_changes;
775 filedes_init(&fd->f_staging_fd, raw_fd);
779 old_blob->num_opened_fds -= new_blob->num_opened_fds;
781 new_blob->blob_location = BLOB_IN_STAGING_FILE;
782 new_blob->staging_file_name = staging_file_name;
783 new_blob->staging_dir_fd = ctx->staging_dir_fd;
784 new_blob->size = size;
786 prepare_unhashed_blob(new_blob, inode, strm->stream_id,
787 &wim_get_current_image_metadata(ctx->wim)->unhashed_blobs);
788 inode_replace_stream_blob(inode, strm, new_blob, ctx->wim->blob_table);
791 out_revert_fd_changes:
792 for (u16 i = 0; new_blob->num_opened_fds; i++) {
793 struct wimfs_fd *fd = inode->i_fds[i];
794 if (fd && fd->f_stream_id == strm->stream_id) {
795 fd->f_blob = old_blob;
796 if (filedes_valid(&fd->f_staging_fd)) {
797 filedes_close(&fd->f_staging_fd);
798 filedes_invalidate(&fd->f_staging_fd);
800 new_blob->num_opened_fds--;
803 free_blob_descriptor(new_blob);
804 out_delete_staging_file:
805 unlinkat(ctx->staging_dir_fd, staging_file_name, 0);
806 FREE(staging_file_name);
811 * Create the staging directory for the WIM file.
813 * The staging directory will be created in the directory specified by the open
814 * file descriptor @parent_dir_fd. It will be given a randomly generated name
815 * based on @wim_basename, the name of the WIM file.
817 * On success, returns a file descriptor to the open staging directory with
818 * O_RDONLY access. In addition, stores the allocated name of the staging
819 * directory (relative to @parent_dir_fd) in @staging_dir_name_ret.
820 * On failure, returns -1 and sets errno.
823 make_staging_dir_at(int parent_dir_fd, const char *wim_basename,
824 char **staging_dir_name_ret)
826 static const char common_suffix[8] = ".staging";
827 static const size_t random_suffix_len = 10;
828 size_t wim_basename_len;
829 size_t staging_dir_name_len;
830 char *staging_dir_name;
834 wim_basename_len = strlen(wim_basename);
835 staging_dir_name_len = wim_basename_len + sizeof(common_suffix) +
837 staging_dir_name = MALLOC(staging_dir_name_len + 1);
838 if (!staging_dir_name)
841 p = staging_dir_name;
842 p = mempcpy(p, wim_basename, wim_basename_len);
843 p = mempcpy(p, common_suffix, sizeof(common_suffix));
844 randomize_char_array_with_alnum(p, random_suffix_len);
845 p += random_suffix_len;
848 if (mkdirat(parent_dir_fd, staging_dir_name, 0700))
851 fd = openat(parent_dir_fd, staging_dir_name,
852 O_RDONLY | O_DIRECTORY | O_NOFOLLOW);
856 *staging_dir_name_ret = staging_dir_name;
860 unlinkat(parent_dir_fd, staging_dir_name, AT_REMOVEDIR);
862 FREE(staging_dir_name);
867 * Create the staging directory and set ctx->staging_dir_fd,
868 * ctx->staging_dir_name, and ctx->parent_dir_fd.
871 make_staging_dir(struct wimfs_context *ctx, const char *parent_dir_path)
873 const char *wim_basename;
877 wim_basename = path_basename(ctx->wim->filename);
879 if (!parent_dir_path) {
880 /* The user did not specify a directory. Default to creating
881 * the staging directory alongside the WIM file. */
882 if (wim_basename > ctx->wim->filename) {
883 parent_dir_path = ctx->wim->filename;
884 end = (char *)(wim_basename - 1);
885 /* *end must be a slash. Temporarily overwrite it so we
886 * can open the parent directory. */
889 parent_dir_path = ".";
893 /* Open the parent directory (in which we'll create our staging
895 ctx->parent_dir_fd = open(parent_dir_path, O_RDONLY | O_DIRECTORY);
896 if (ctx->parent_dir_fd < 0) {
897 ERROR_WITH_ERRNO("Can't open directory \"%s\"",
899 ret = WIMLIB_ERR_OPENDIR;
900 goto out_restore_wim_filename;
903 ctx->staging_dir_fd = make_staging_dir_at(ctx->parent_dir_fd,
905 &ctx->staging_dir_name);
906 if (ctx->staging_dir_fd < 0) {
907 ERROR_WITH_ERRNO("Can't create staging directory in \"%s\"",
909 close(ctx->parent_dir_fd);
910 ret = WIMLIB_ERR_MKDIR;
911 goto out_restore_wim_filename;
914 out_restore_wim_filename:
920 /* Deletes the staging directory, undoing the effects of a successful call to
921 * make_staging_dir(). */
923 delete_staging_dir(struct wimfs_context *ctx)
928 dir = fdopendir(ctx->staging_dir_fd);
930 while ((ent = readdir(dir)))
931 unlinkat(ctx->staging_dir_fd, ent->d_name, 0);
934 close(ctx->staging_dir_fd);
936 if (unlinkat(ctx->parent_dir_fd, ctx->staging_dir_name, AT_REMOVEDIR))
937 WARNING_WITH_ERRNO("Could not delete staging directory");
938 FREE(ctx->staging_dir_name);
939 close(ctx->parent_dir_fd);
942 /* Number the inodes in the mounted image sequentially. */
944 reassign_inode_numbers(struct wimfs_context *ctx)
946 struct wim_image_metadata *imd;
947 struct wim_inode *inode;
950 imd = wim_get_current_image_metadata(ctx->wim);
951 image_for_each_inode(inode, imd)
952 inode->i_ino = ctx->next_ino++;
956 release_extra_refcnts(struct wimfs_context *ctx)
958 struct list_head *list = &ctx->orig_blob_list;
959 struct blob_table *blob_table = ctx->wim->blob_table;
960 struct blob_descriptor *blob, *tmp;
962 list_for_each_entry_safe(blob, tmp, list, orig_blob_list)
963 blob_subtract_refcnt(blob, blob_table, blob->out_refcnt);
966 /* Delete the 'struct blob_descriptor' for any stream that was modified
967 * or created in the read-write mounted image and had a final size of 0. */
969 delete_empty_blobs(struct wimfs_context *ctx)
971 struct blob_descriptor *blob, *tmp;
972 struct wim_image_metadata *imd;
974 imd = wim_get_current_image_metadata(ctx->wim);
976 image_for_each_unhashed_blob_safe(blob, tmp, imd) {
978 *retrieve_pointer_to_unhashed_blob(blob) = NULL;
979 list_del(&blob->unhashed_list);
980 free_blob_descriptor(blob);
985 /* Close all file descriptors open to the specified inode.
987 * Note: closing the last file descriptor might free the inode. */
989 inode_close_fds(struct wim_inode *inode)
991 u16 num_open_fds = inode->i_num_opened_fds;
992 for (u16 i = 0; num_open_fds; i++) {
993 if (inode->i_fds[i]) {
994 close_wimfs_fd(inode->i_fds[i]);
1000 /* Close all file descriptors open to the mounted image. */
1002 close_all_fds(struct wimfs_context *ctx)
1004 struct wim_inode *inode;
1005 struct hlist_node *tmp;
1006 struct wim_image_metadata *imd;
1008 imd = wim_get_current_image_metadata(ctx->wim);
1010 image_for_each_inode_safe(inode, tmp, imd)
1011 inode_close_fds(inode);
1014 /* Moves the currently selected image, which may have been modified, to a new
1015 * index, and sets the original index to refer to a reset (unmodified) copy of
1018 renew_current_image(struct wimfs_context *ctx)
1020 WIMStruct *wim = ctx->wim;
1021 int idx = wim->current_image - 1;
1022 struct wim_image_metadata *imd = wim->image_metadata[idx];
1023 struct wim_image_metadata *replace_imd;
1024 struct blob_descriptor *new_blob;
1027 /* Create 'replace_imd' structure to use for the reset original,
1028 * unmodified image. */
1029 ret = WIMLIB_ERR_NOMEM;
1030 replace_imd = new_image_metadata();
1034 /* Create new blob descriptor for the modified image's metadata
1035 * resource, which doesn't exist yet. */
1036 ret = WIMLIB_ERR_NOMEM;
1037 new_blob = new_blob_descriptor();
1039 goto err_put_replace_imd;
1041 new_blob->refcnt = 1;
1042 new_blob->unhashed = 1;
1043 new_blob->is_metadata = 1;
1045 /* Make the image being moved available at a new index. Increments the
1046 * WIM's image count, but does not increment the reference count of the
1047 * 'struct image_metadata'. */
1048 ret = append_image_metadata(wim, imd);
1050 goto err_free_new_blob;
1052 ret = xml_add_image(wim, "");
1054 goto err_undo_append;
1056 replace_imd->metadata_blob = imd->metadata_blob;
1057 imd->metadata_blob = new_blob;
1058 wim->image_metadata[idx] = replace_imd;
1059 wim->current_image = wim->hdr.image_count;
1063 wim->hdr.image_count--;
1065 free_blob_descriptor(new_blob);
1066 err_put_replace_imd:
1067 put_image_metadata(replace_imd, NULL);
1072 static enum wimlib_progress_status
1073 commit_progress_func(enum wimlib_progress_msg msg,
1074 union wimlib_progress_info *info, void *progctx)
1076 mqd_t mq = *(mqd_t *)progctx;
1077 struct commit_progress_report report;
1079 memset(&report, 0, sizeof(report));
1082 report.info = *info;
1083 mq_send(mq, (const char *)&report, sizeof(report), 1);
1084 return WIMLIB_PROGRESS_STATUS_CONTINUE;
1087 /* Commit the mounted image to the underlying WIM file. */
1089 commit_image(struct wimfs_context *ctx, int unmount_flags, mqd_t mq)
1093 if (unmount_flags & WIMLIB_UNMOUNT_FLAG_SEND_PROGRESS)
1094 wimlib_register_progress_function(ctx->wim,
1095 commit_progress_func, &mq);
1097 wimlib_register_progress_function(ctx->wim, NULL, NULL);
1099 if (unmount_flags & WIMLIB_UNMOUNT_FLAG_NEW_IMAGE) {
1100 int ret = renew_current_image(ctx);
1104 release_extra_refcnts(ctx);
1106 INIT_LIST_HEAD(&ctx->orig_blob_list);
1107 delete_empty_blobs(ctx);
1108 xml_update_image_info(ctx->wim, ctx->wim->current_image);
1112 if (unmount_flags & WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY)
1113 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
1115 if (unmount_flags & WIMLIB_UNMOUNT_FLAG_REBUILD)
1116 write_flags |= WIMLIB_WRITE_FLAG_REBUILD;
1118 if (unmount_flags & WIMLIB_UNMOUNT_FLAG_RECOMPRESS)
1119 write_flags |= WIMLIB_WRITE_FLAG_RECOMPRESS;
1121 return wimlib_overwrite(ctx->wim, write_flags, 0);
1124 /* In the case of an allow_other mount, only the mount owner and root are
1125 * allowed to unmount the filesystem. */
1127 may_unmount_wimfs(void)
1129 const struct fuse_context *fuse_ctx = fuse_get_context();
1130 const struct wimfs_context *wimfs_ctx = WIMFS_CTX(fuse_ctx);
1132 return (fuse_ctx->uid == wimfs_ctx->owner_uid ||
1133 fuse_ctx->uid == 0);
1136 /* Unmount the mounted image, called from the daemon process. */
1140 struct fuse_context *fuse_ctx = fuse_get_context();
1141 struct wimfs_context *wimfs_ctx = WIMFS_CTX(fuse_ctx);
1142 const struct wimfs_unmount_info *info = &wimfs_ctx->unmount_info;
1143 int unmount_flags = info->unmount_flags;
1144 mqd_t mq = (mqd_t)-1;
1147 /* Ignore COMMIT if the image is mounted read-only. */
1148 if (!(wimfs_ctx->mount_flags & WIMLIB_MOUNT_FLAG_READWRITE))
1149 unmount_flags &= ~WIMLIB_UNMOUNT_FLAG_COMMIT;
1151 if (unmount_flags & WIMLIB_UNMOUNT_FLAG_SEND_PROGRESS) {
1152 mq = mq_open(info->mq_name, O_WRONLY | O_NONBLOCK);
1153 if (mq == (mqd_t)-1) {
1154 ret = WIMLIB_ERR_MQUEUE;
1159 if (wimfs_ctx->num_open_fds) {
1161 /* There are still open file descriptors to the image. */
1163 /* With COMMIT, refuse to unmount unless FORCE is also
1165 if ((unmount_flags & (WIMLIB_UNMOUNT_FLAG_COMMIT |
1166 WIMLIB_UNMOUNT_FLAG_FORCE))
1167 == WIMLIB_UNMOUNT_FLAG_COMMIT)
1169 ret = WIMLIB_ERR_MOUNTED_IMAGE_IS_BUSY;
1173 /* Force-close all file descriptors. */
1174 close_all_fds(wimfs_ctx);
1177 if (unmount_flags & WIMLIB_UNMOUNT_FLAG_COMMIT)
1178 ret = commit_image(wimfs_ctx, unmount_flags, mq);
1180 ret = 0; /* Read-only mount, or discarding changes to
1181 a read-write mount */
1184 /* Leave the image mounted if commit failed, unless this is a
1185 * forced unmount. The user can retry without COMMIT if they
1187 if (!ret || (unmount_flags & WIMLIB_UNMOUNT_FLAG_FORCE)) {
1188 unlock_wim_for_append(wimfs_ctx->wim);
1189 fuse_exit(fuse_ctx->fuse);
1191 if (mq != (mqd_t)-1)
1197 wimfs_chmod(const char *path, mode_t mask)
1199 const struct wimfs_context *ctx = wimfs_get_context();
1200 struct wim_inode *inode;
1201 struct wimlib_unix_data unix_data;
1203 if (!(ctx->mount_flags & WIMLIB_MOUNT_FLAG_UNIX_DATA))
1206 inode = wim_pathname_to_inode(ctx->wim, path);
1210 unix_data.uid = ctx->owner_uid;
1211 unix_data.gid = ctx->owner_gid;
1212 unix_data.mode = mask;
1215 if (!inode_set_unix_data(inode, &unix_data, UNIX_DATA_MODE))
1222 wimfs_chown(const char *path, uid_t uid, gid_t gid)
1224 const struct wimfs_context *ctx = wimfs_get_context();
1225 struct wim_inode *inode;
1226 struct wimlib_unix_data unix_data;
1229 if (!(ctx->mount_flags & WIMLIB_MOUNT_FLAG_UNIX_DATA))
1232 inode = wim_pathname_to_inode(ctx->wim, path);
1238 if (uid != (uid_t)-1)
1239 which |= UNIX_DATA_UID;
1241 uid = ctx->owner_uid;
1243 if (gid != (gid_t)-1)
1244 which |= UNIX_DATA_GID;
1246 gid = ctx->owner_gid;
1248 unix_data.uid = uid;
1249 unix_data.gid = gid;
1250 unix_data.mode = inode_default_unix_mode(inode);
1253 if (!inode_set_unix_data(inode, &unix_data, which))
1260 wimfs_fgetattr(const char *path, struct stat *stbuf, struct fuse_file_info *fi)
1262 struct wimfs_fd *fd = WIMFS_FD(fi);
1263 return inode_to_stbuf(fd->f_inode, fd->f_blob, stbuf);
1267 wimfs_ftruncate(const char *path, off_t size, struct fuse_file_info *fi)
1269 struct wimfs_fd *fd = WIMFS_FD(fi);
1270 if (ftruncate(fd->f_staging_fd.fd, size))
1272 touch_inode(fd->f_inode);
1273 fd->f_blob->size = size;
1278 wimfs_getattr(const char *path, struct stat *stbuf)
1280 const struct wimfs_context *ctx = wimfs_get_context();
1281 struct wim_dentry *dentry;
1282 struct wim_inode_stream *strm;
1285 ret = wim_pathname_to_stream(ctx, path, LOOKUP_FLAG_DIRECTORY_OK,
1290 return inode_to_stbuf(dentry->d_inode,
1291 stream_blob_resolved(strm), stbuf);
1295 copy_xattr(char *dest, size_t destsize, const void *src, size_t srcsize)
1298 if (destsize < srcsize)
1300 memcpy(dest, src, srcsize);
1306 wimfs_getxattr(const char *path, const char *name, char *value,
1309 const struct wimfs_context *ctx = wimfs_get_context();
1310 struct wim_inode *inode;
1311 struct wim_inode_stream *strm;
1312 struct blob_descriptor *blob;
1314 if (!strncmp(name, "wimfs.", 6)) {
1315 /* Handle some magical extended attributes. These really should
1316 * be ioctls, but directory ioctls aren't supported until
1317 * libfuse 2.9, and even then they are broken. */
1319 if (!strcmp(name, "wim_filename")) {
1320 return copy_xattr(value, size, ctx->wim->filename,
1321 strlen(ctx->wim->filename));
1323 if (!strcmp(name, "wim_info")) {
1324 struct wimlib_wim_info info;
1326 wimlib_get_wim_info(ctx->wim, &info);
1328 return copy_xattr(value, size, &info, sizeof(info));
1330 if (!strcmp(name, "mounted_image")) {
1331 return copy_xattr(value, size,
1332 &ctx->wim->current_image, sizeof(int));
1334 if (!strcmp(name, "mount_flags")) {
1335 return copy_xattr(value, size,
1336 &ctx->mount_flags, sizeof(int));
1338 if (!strcmp(name, "unmount")) {
1339 if (!may_unmount_wimfs())
1344 if (size < sizeof(int))
1346 status = unmount_wimfs();
1347 memcpy(value, &status, sizeof(int));
1354 if (!(ctx->mount_flags & WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR))
1357 if (strncmp(name, "user.", 5))
1364 /* Querying a named data stream */
1366 inode = wim_pathname_to_inode(ctx->wim, path);
1370 strm = inode_get_data_stream_tstr(inode, name);
1372 return (errno == ENOENT) ? -ENOATTR : -errno;
1374 blob = stream_blob_resolved(strm);
1378 if (unlikely(blob->size > INT_MAX))
1382 if (size < blob->size)
1385 if (read_full_blob_into_buf(blob, value))
1386 return errno ? -errno : -EIO;
1392 wimfs_link(const char *existing_path, const char *new_path)
1394 WIMStruct *wim = wimfs_get_WIMStruct();
1395 const char *new_name;
1396 struct wim_inode *inode;
1397 struct wim_dentry *dir;
1398 struct wim_dentry *new_alias;
1400 inode = wim_pathname_to_inode(wim, existing_path);
1404 if (inode->i_attributes & (FILE_ATTRIBUTE_DIRECTORY |
1405 FILE_ATTRIBUTE_REPARSE_POINT))
1408 new_name = path_basename(new_path);
1410 dir = get_parent_dentry(wim, new_path, WIMLIB_CASE_SENSITIVE);
1414 if (!dentry_is_directory(dir))
1417 if (get_dentry_child_with_name(dir, new_name, WIMLIB_CASE_SENSITIVE))
1420 if (new_dentry_with_existing_inode(new_name, inode, &new_alias))
1423 dentry_add_child(dir, new_alias);
1424 touch_inode(dir->d_inode);
1429 wimfs_listxattr(const char *path, char *list, size_t size)
1431 const struct wimfs_context *ctx = wimfs_get_context();
1432 const struct wim_inode *inode;
1434 char *end = list + size;
1437 if (!(ctx->mount_flags & WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR))
1440 /* List named data streams, or get the list size. We report each named
1441 * data stream "X" as an extended attribute "user.X". */
1443 inode = wim_pathname_to_inode(ctx->wim, path);
1447 for (unsigned i = 0; i < inode->i_num_streams; i++) {
1448 const struct wim_inode_stream *strm;
1449 char *stream_name_mbs;
1450 size_t stream_name_mbs_nbytes;
1452 strm = &inode->i_streams[i];
1454 if (!stream_is_named_data_stream(strm))
1457 if (utf16le_to_tstr(strm->stream_name,
1458 utf16le_len_bytes(strm->stream_name),
1460 &stream_name_mbs_nbytes))
1463 if (unlikely(INT_MAX - total_size < stream_name_mbs_nbytes + 6)) {
1464 FREE(stream_name_mbs);
1468 total_size += stream_name_mbs_nbytes + 6;
1470 if (end - p < stream_name_mbs_nbytes + 6) {
1471 FREE(stream_name_mbs);
1474 p = mempcpy(p, "user.", 5);
1475 p = mempcpy(p, stream_name_mbs, stream_name_mbs_nbytes);
1478 FREE(stream_name_mbs);
1484 wimfs_mkdir(const char *path, mode_t mode)
1486 struct wim_dentry *dentry;
1489 /* Note: according to fuse.h, mode may not include S_IFDIR */
1490 ret = create_file(fuse_get_context(), path, mode | S_IFDIR, 0,
1491 FILE_ATTRIBUTE_DIRECTORY, &dentry);
1494 touch_parent(dentry);
1499 wimfs_mknod(const char *path, mode_t mode, dev_t rdev)
1501 struct fuse_context *fuse_ctx = fuse_get_context();
1502 struct wimfs_context *wimfs_ctx = WIMFS_CTX(fuse_ctx);
1503 const char *stream_name;
1505 if ((wimfs_ctx->mount_flags & WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS)
1506 && (stream_name = path_stream_name(path)))
1508 struct wim_inode *inode;
1509 struct wim_inode_stream *existing_strm;
1510 struct wim_inode_stream *new_strm;
1512 const utf16lechar *uname;
1514 /* Create a named data stream. */
1519 p = (char *)stream_name - 1;
1522 inode = wim_pathname_to_inode(wimfs_ctx->wim, path);
1527 if (tstr_get_utf16le(stream_name, &uname))
1530 existing_strm = inode_get_stream(inode, STREAM_TYPE_DATA, uname);
1531 if (existing_strm) {
1532 tstr_put_utf16le(uname);
1536 new_strm = inode_add_stream(inode, STREAM_TYPE_DATA, uname, NULL);
1538 tstr_put_utf16le(uname);
1544 /* Create a regular file, device node, named pipe, or socket.
1546 struct wim_dentry *dentry;
1549 if (!S_ISREG(mode) &&
1550 !(wimfs_ctx->mount_flags & WIMLIB_MOUNT_FLAG_UNIX_DATA))
1553 /* Note: we still use FILE_ATTRIBUTE_NORMAL for device nodes,
1554 * named pipes, and sockets. The real mode is in the UNIX
1556 ret = create_file(fuse_ctx, path, mode, rdev,
1557 FILE_ATTRIBUTE_NORMAL, &dentry);
1560 touch_parent(dentry);
1566 wimfs_open(const char *path, struct fuse_file_info *fi)
1568 struct wimfs_context *ctx = wimfs_get_context();
1569 struct wim_dentry *dentry;
1570 struct wim_inode *inode;
1571 struct wim_inode_stream *strm;
1572 struct blob_descriptor *blob;
1573 struct wimfs_fd *fd;
1576 ret = wim_pathname_to_stream(ctx, path, 0, &dentry, &strm);
1580 inode = dentry->d_inode;
1581 blob = stream_blob_resolved(strm);
1583 /* The data of the file being opened may be in the staging directory
1584 * (read-write mounts only) or in the WIM. If it's in the staging
1585 * directory, we need to open a native file descriptor for the
1586 * corresponding file. Otherwise, we can read the file data directly
1587 * from the WIM file if we are opening it read-only, but we need to
1588 * extract the data to the staging directory if we are opening it
1591 if (flags_writable(fi->flags) &&
1592 (!blob || blob->blob_location != BLOB_IN_STAGING_FILE)) {
1593 ret = extract_blob_to_staging_dir(inode,
1599 blob = stream_blob_resolved(strm);
1602 ret = alloc_wimfs_fd(inode, strm, &fd);
1606 if (blob && blob->blob_location == BLOB_IN_STAGING_FILE) {
1609 raw_fd = openat(blob->staging_dir_fd, blob->staging_file_name,
1610 (fi->flags & O_ACCMODE) | O_NOFOLLOW);
1615 filedes_init(&fd->f_staging_fd, raw_fd);
1617 fi->fh = (uintptr_t)fd;
1622 wimfs_opendir(const char *path, struct fuse_file_info *fi)
1624 WIMStruct *wim = wimfs_get_WIMStruct();
1625 struct wim_inode *inode;
1626 struct wim_inode_stream *strm;
1627 struct wimfs_fd *fd;
1630 inode = wim_pathname_to_inode(wim, path);
1633 if (!inode_is_directory(inode))
1635 strm = inode_get_unnamed_data_stream(inode);
1638 ret = alloc_wimfs_fd(inode, strm, &fd);
1641 fi->fh = (uintptr_t)fd;
1646 wimfs_read(const char *path, char *buf, size_t size,
1647 off_t offset, struct fuse_file_info *fi)
1649 struct wimfs_fd *fd = WIMFS_FD(fi);
1650 const struct blob_descriptor *blob;
1657 if (offset >= blob->size)
1660 if (size > blob->size - offset)
1661 size = blob->size - offset;
1666 switch (blob->blob_location) {
1668 if (read_partial_wim_blob_into_buf(blob, size, offset, buf))
1669 ret = errno ? -errno : -EIO;
1673 case BLOB_IN_STAGING_FILE:
1674 ret = raw_pread(&fd->f_staging_fd, buf, size, offset);
1678 case BLOB_IN_ATTACHED_BUFFER:
1679 memcpy(buf, blob->attached_buffer + offset, size);
1690 wimfs_readdir(const char *path, void *buf, fuse_fill_dir_t filler,
1691 off_t offset, struct fuse_file_info *fi)
1693 struct wimfs_fd *fd = WIMFS_FD(fi);
1694 const struct wim_inode *inode;
1695 const struct wim_dentry *child;
1698 inode = fd->f_inode;
1700 ret = filler(buf, ".", NULL, 0);
1703 ret = filler(buf, "..", NULL, 0);
1707 for_inode_child(child, inode) {
1708 char *file_name_mbs;
1709 size_t file_name_mbs_nbytes;
1711 ret = utf16le_to_tstr(child->file_name,
1712 child->file_name_nbytes,
1714 &file_name_mbs_nbytes);
1718 ret = filler(buf, file_name_mbs, NULL, 0);
1719 FREE(file_name_mbs);
1727 wimfs_readlink(const char *path, char *buf, size_t buf_len)
1729 WIMStruct *wim = wimfs_get_WIMStruct();
1730 const struct wim_inode *inode;
1733 inode = wim_pathname_to_inode(wim, path);
1736 if (!inode_is_symlink(inode))
1740 ret = wim_inode_readlink(inode, buf, buf_len - 1, NULL);
1744 } else if (ret == -ENAMETOOLONG) {
1745 buf[buf_len - 1] = '\0';
1750 /* We use this for both release() and releasedir(), since in both cases we
1751 * simply need to close the file descriptor. */
1753 wimfs_release(const char *path, struct fuse_file_info *fi)
1755 return close_wimfs_fd(WIMFS_FD(fi));
1759 wimfs_removexattr(const char *path, const char *name)
1761 struct wimfs_context *ctx = wimfs_get_context();
1762 struct wim_inode *inode;
1763 struct wim_inode_stream *strm;
1765 if (!(ctx->mount_flags & WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR))
1768 if (strncmp(name, "user.", 5))
1775 /* Removing a named data stream. */
1777 inode = wim_pathname_to_inode(ctx->wim, path);
1781 strm = inode_get_data_stream_tstr(inode, name);
1783 return (errno == ENOENT) ? -ENOATTR : -errno;
1785 inode_remove_stream(inode, strm, ctx->wim->blob_table);
1790 wimfs_rename(const char *from, const char *to)
1792 return rename_wim_path(wimfs_get_WIMStruct(), from, to,
1793 WIMLIB_CASE_SENSITIVE, NULL);
1797 wimfs_rmdir(const char *path)
1799 WIMStruct *wim = wimfs_get_WIMStruct();
1800 struct wim_dentry *dentry;
1802 dentry = get_dentry(wim, path, WIMLIB_CASE_SENSITIVE);
1806 if (!dentry_is_directory(dentry))
1809 if (dentry_has_children(dentry))
1812 touch_parent(dentry);
1813 remove_dentry(dentry, wim->blob_table);
1818 wimfs_setxattr(const char *path, const char *name,
1819 const char *value, size_t size, int flags)
1821 struct wimfs_context *ctx = wimfs_get_context();
1822 struct wim_inode *inode;
1823 struct wim_inode_stream *strm;
1824 const utf16lechar *uname;
1827 if (!strncmp(name, "wimfs.", 6)) {
1828 /* Handle some magical extended attributes. These really should
1829 * be ioctls, but directory ioctls aren't supported until
1830 * libfuse 2.9, and even then they are broken. [Fixed by
1831 * libfuse commit e3b7d4c278a26520be63d99d6ea84b26906fe73d] */
1833 if (!strcmp(name, "unmount_info")) {
1834 if (!may_unmount_wimfs())
1836 if (size < sizeof(struct wimfs_unmount_info))
1838 memcpy(&ctx->unmount_info, value,
1839 sizeof(struct wimfs_unmount_info));
1845 if (!(ctx->mount_flags & WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR))
1848 if (strncmp(name, "user.", 5))
1855 /* Setting the contents of a named data stream. */
1857 inode = wim_pathname_to_inode(ctx->wim, path);
1861 ret = tstr_get_utf16le(name, &uname);
1865 strm = inode_get_stream(inode, STREAM_TYPE_DATA, uname);
1868 if (flags & XATTR_CREATE)
1872 if (flags & XATTR_REPLACE)
1877 if (!inode_replace_stream_data(inode, strm, value, size,
1878 ctx->wim->blob_table))
1884 if (!inode_add_stream_with_data(inode, STREAM_TYPE_DATA, uname,
1885 value, size, ctx->wim->blob_table))
1894 tstr_put_utf16le(uname);
1899 wimfs_symlink(const char *to, const char *from)
1901 struct fuse_context *fuse_ctx = fuse_get_context();
1902 struct wimfs_context *wimfs_ctx = WIMFS_CTX(fuse_ctx);
1903 struct wim_dentry *dentry;
1906 ret = create_file(fuse_ctx, from, S_IFLNK | 0777, 0,
1907 FILE_ATTRIBUTE_REPARSE_POINT, &dentry);
1910 dentry->d_inode->i_reparse_tag = WIM_IO_REPARSE_TAG_SYMLINK;
1911 ret = wim_inode_set_symlink(dentry->d_inode, to,
1912 wimfs_ctx->wim->blob_table);
1914 remove_dentry(dentry, wimfs_ctx->wim->blob_table);
1915 if (ret == WIMLIB_ERR_NOMEM)
1920 touch_parent(dentry);
1926 wimfs_truncate(const char *path, off_t size)
1928 const struct wimfs_context *ctx = wimfs_get_context();
1929 struct wim_dentry *dentry;
1930 struct wim_inode_stream *strm;
1931 struct blob_descriptor *blob;
1935 ret = wim_pathname_to_stream(ctx, path, 0, &dentry, &strm);
1939 blob = stream_blob_resolved(strm);
1944 if (!blob || blob->blob_location != BLOB_IN_STAGING_FILE) {
1945 return extract_blob_to_staging_dir(dentry->d_inode,
1949 /* Truncate the staging file. */
1950 fd = openat(blob->staging_dir_fd, blob->staging_file_name,
1951 O_WRONLY | O_NOFOLLOW);
1954 ret = ftruncate(fd, size);
1955 if (close(fd) || ret)
1958 touch_inode(dentry->d_inode);
1963 wimfs_unlink(const char *path)
1965 const struct wimfs_context *ctx = wimfs_get_context();
1966 struct wim_dentry *dentry;
1967 struct wim_inode_stream *strm;
1970 ret = wim_pathname_to_stream(ctx, path, 0, &dentry, &strm);
1974 if (stream_is_named(strm)) {
1975 inode_remove_stream(dentry->d_inode, strm,
1976 ctx->wim->blob_table);
1978 touch_parent(dentry);
1979 remove_dentry(dentry, ctx->wim->blob_table);
1984 #ifdef HAVE_UTIMENSAT
1986 * Change the timestamp on a file dentry.
1988 * Note that alternate data streams do not have their own timestamps.
1991 wimfs_utimens(const char *path, const struct timespec tv[2])
1993 WIMStruct *wim = wimfs_get_WIMStruct();
1994 struct wim_inode *inode;
1996 inode = wim_pathname_to_inode(wim, path);
2000 if (tv[0].tv_nsec != UTIME_OMIT) {
2001 if (tv[0].tv_nsec == UTIME_NOW)
2002 inode->i_last_access_time = now_as_wim_timestamp();
2004 inode->i_last_access_time = timespec_to_wim_timestamp(&tv[0]);
2006 if (tv[1].tv_nsec != UTIME_OMIT) {
2007 if (tv[1].tv_nsec == UTIME_NOW)
2008 inode->i_last_write_time = now_as_wim_timestamp();
2010 inode->i_last_write_time = timespec_to_wim_timestamp(&tv[1]);
2014 #else /* HAVE_UTIMENSAT */
2016 wimfs_utime(const char *path, struct utimbuf *times)
2018 WIMStruct *wim = wimfs_get_WIMStruct();
2019 struct wim_inode *inode;
2021 inode = wim_pathname_to_inode(wim, path);
2025 inode->i_last_access_time = time_t_to_wim_timestamp(times->actime);
2026 inode->i_last_write_time = time_t_to_wim_timestamp(times->modtime);
2029 #endif /* !HAVE_UTIMENSAT */
2032 wimfs_write(const char *path, const char *buf, size_t size,
2033 off_t offset, struct fuse_file_info *fi)
2035 struct wimfs_fd *fd = WIMFS_FD(fi);
2038 ret = raw_pwrite(&fd->f_staging_fd, buf, size, offset);
2042 if (offset + size > fd->f_blob->size)
2043 fd->f_blob->size = offset + size;
2045 touch_inode(fd->f_inode);
2049 static struct fuse_operations wimfs_operations = {
2050 .chmod = wimfs_chmod,
2051 .chown = wimfs_chown,
2052 .fgetattr = wimfs_fgetattr,
2053 .ftruncate = wimfs_ftruncate,
2054 .getattr = wimfs_getattr,
2055 .getxattr = wimfs_getxattr,
2057 .listxattr = wimfs_listxattr,
2058 .mkdir = wimfs_mkdir,
2059 .mknod = wimfs_mknod,
2061 .opendir = wimfs_opendir,
2063 .readdir = wimfs_readdir,
2064 .readlink = wimfs_readlink,
2065 .release = wimfs_release,
2066 .releasedir = wimfs_release,
2067 .removexattr = wimfs_removexattr,
2068 .rename = wimfs_rename,
2069 .rmdir = wimfs_rmdir,
2070 .setxattr = wimfs_setxattr,
2071 .symlink = wimfs_symlink,
2072 .truncate = wimfs_truncate,
2073 .unlink = wimfs_unlink,
2074 #ifdef HAVE_UTIMENSAT
2075 .utimens = wimfs_utimens,
2077 .utime = wimfs_utime,
2079 .write = wimfs_write,
2081 /* We keep track of file descriptor structures (struct wimfs_fd), so
2082 * there is no need to have the file path provided on operations such as
2084 #if FUSE_MAJOR_VERSION > 2 || (FUSE_MAJOR_VERSION == 2 && FUSE_MINOR_VERSION >= 8)
2085 .flag_nullpath_ok = 1,
2087 #if FUSE_MAJOR_VERSION > 2 || (FUSE_MAJOR_VERSION == 2 && FUSE_MINOR_VERSION >= 9)
2089 .flag_utime_omit_ok = 1,
2093 /* API function documented in wimlib.h */
2095 wimlib_mount_image(WIMStruct *wim, int image, const char *dir,
2096 int mount_flags, const char *staging_dir)
2099 struct wim_image_metadata *imd;
2100 struct wimfs_context ctx;
2101 char *fuse_argv[16];
2104 if (!wim || !dir || !*dir)
2105 return WIMLIB_ERR_INVALID_PARAM;
2107 if (mount_flags & ~(WIMLIB_MOUNT_FLAG_READWRITE |
2108 WIMLIB_MOUNT_FLAG_DEBUG |
2109 WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE |
2110 WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR |
2111 WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS |
2112 WIMLIB_MOUNT_FLAG_UNIX_DATA |
2113 WIMLIB_MOUNT_FLAG_ALLOW_OTHER))
2114 return WIMLIB_ERR_INVALID_PARAM;
2116 /* For read-write mount, check for write access to the WIM. */
2117 if (mount_flags & WIMLIB_MOUNT_FLAG_READWRITE) {
2119 return WIMLIB_ERR_NO_FILENAME;
2120 ret = can_modify_wim(wim);
2125 /* Select the image to mount. */
2126 ret = select_wim_image(wim, image);
2130 /* Get the metadata for the image to mount. */
2131 imd = wim_get_current_image_metadata(wim);
2133 if (imd->modified) {
2134 /* To avoid complicating things, we don't support mounting
2135 * images to which in-memory modifications have already been
2137 ERROR("Cannot mount a modified WIM image!");
2138 return WIMLIB_ERR_INVALID_PARAM;
2141 if (mount_flags & WIMLIB_MOUNT_FLAG_READWRITE) {
2142 ret = lock_wim_for_append(wim);
2147 if (wim_has_solid_resources(wim)) {
2148 WARNING("Mounting a WIM file containing solid-compressed data; "
2149 "file access may be slow.");
2152 /* If the user did not specify an interface for accessing named
2153 * data streams, use the default (extended attributes). */
2154 if (!(mount_flags & (WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE |
2155 WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR |
2156 WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS)))
2157 mount_flags |= WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR;
2159 /* Start initializing the wimfs_context. */
2160 memset(&ctx, 0, sizeof(struct wimfs_context));
2162 ctx.mount_flags = mount_flags;
2163 if (mount_flags & WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS)
2164 ctx.default_lookup_flags = LOOKUP_FLAG_ADS_OK;
2165 /* For read-write mount, create the staging directory. */
2166 if (mount_flags & WIMLIB_MOUNT_FLAG_READWRITE) {
2167 ret = make_staging_dir(&ctx, staging_dir);
2171 ctx.owner_uid = getuid();
2172 ctx.owner_gid = getgid();
2174 /* Add each blob referenced by files in the image to a list and
2175 * preemptively double the number of references to each. This is done
2176 * to allow implementing the WIMLIB_UNMOUNT_FLAG_NEW_IMAGE semantics.
2178 INIT_LIST_HEAD(&ctx.orig_blob_list);
2179 if (mount_flags & WIMLIB_MOUNT_FLAG_READWRITE) {
2181 struct wim_inode *inode;
2182 struct blob_descriptor *blob;
2184 image_for_each_inode(inode, imd) {
2185 for (i = 0; i < inode->i_num_streams; i++) {
2186 blob = stream_blob(&inode->i_streams[i],
2189 blob->out_refcnt = 0;
2193 image_for_each_inode(inode, imd) {
2194 for (i = 0; i < inode->i_num_streams; i++) {
2195 blob = stream_blob(&inode->i_streams[i],
2198 if (blob->out_refcnt == 0)
2199 list_add(&blob->orig_blob_list,
2200 &ctx.orig_blob_list);
2201 blob->out_refcnt += inode->i_nlink;
2202 blob->refcnt += inode->i_nlink;
2208 /* Assign new inode numbers. */
2209 reassign_inode_numbers(&ctx);
2211 /* If a read-write mount, mark the image as modified. */
2212 if (mount_flags & WIMLIB_MOUNT_FLAG_READWRITE)
2215 /* Build the FUSE command line. */
2218 fuse_argv[fuse_argc++] = "wimlib";
2219 fuse_argv[fuse_argc++] = (char *)dir;
2221 /* Disable multi-threaded operation. */
2222 fuse_argv[fuse_argc++] = "-s";
2224 /* Enable FUSE debug mode (don't fork) if requested by the user. */
2225 if (mount_flags & WIMLIB_MOUNT_FLAG_DEBUG)
2226 fuse_argv[fuse_argc++] = "-d";
2229 * Build the FUSE mount options:
2232 * FUSE will use the inode numbers we provide. We want this,
2233 * because we have inodes and will number them ourselves.
2236 * Name for our filesystem (main type is "fuse").
2239 * If an open file is unlinked, unlink it for real rather than
2240 * renaming it to a hidden file. Our code supports this; an
2241 * unlinked inode is retained until all its file descriptors have
2244 * default_permissions
2245 * FUSE will perform permission checking. Useful when
2246 * WIMLIB_MOUNT_FLAG_UNIX_DATA is provided and the WIM image
2247 * contains the UNIX permissions for each file.
2250 * Cache the contents of files. This will speed up repeated access
2251 * to files on a mounted WIM image, since they won't need to be
2252 * decompressed repeatedly. This option is valid because data in
2253 * the WIM image should never be changed externally. (Although, if
2254 * someone really wanted to they could modify the WIM file or mess
2255 * with the staging directory; but then they're asking for
2258 * entry_timeout=1000000000
2259 * Cache positive name lookups indefinitely, since names can only
2260 * be added, removed, or modified through the mounted filesystem
2263 * negative_timeout=1000000000
2264 * Cache negative name lookups indefinitely, since names can only
2265 * be added, removed, or modified through the mounted filesystem
2269 * Don't cache file/directory attributes. This is needed as a
2270 * workaround for the fact that when caching attributes, the high
2271 * level interface to libfuse considers a file which has several
2272 * hard-linked names as several different files. (Otherwise, we
2273 * could cache our file/directory attributes indefinitely, since
2274 * they can only be changed through the mounted filesystem itself.)
2276 char optstring[256] =
2280 ",default_permissions"
2282 ",entry_timeout=1000000000"
2283 ",negative_timeout=1000000000"
2286 fuse_argv[fuse_argc++] = "-o";
2287 fuse_argv[fuse_argc++] = optstring;
2288 if (!(mount_flags & WIMLIB_MOUNT_FLAG_READWRITE))
2289 strcat(optstring, ",ro");
2290 if (mount_flags & WIMLIB_MOUNT_FLAG_ALLOW_OTHER)
2291 strcat(optstring, ",allow_other");
2292 fuse_argv[fuse_argc] = NULL;
2294 /* Mount our filesystem. */
2295 ret = fuse_main(fuse_argc, fuse_argv, &wimfs_operations, &ctx);
2297 /* Cleanup and return. */
2299 ret = WIMLIB_ERR_FUSE;
2300 release_extra_refcnts(&ctx);
2301 if (mount_flags & WIMLIB_MOUNT_FLAG_READWRITE)
2302 delete_staging_dir(&ctx);
2304 unlock_wim_for_append(wim);
2308 struct commit_progress_thread_args {
2310 wimlib_progress_func_t progfunc;
2315 commit_progress_thread_proc(void *_args)
2317 struct commit_progress_thread_args *args = _args;
2318 struct commit_progress_report report;
2322 ret = mq_receive(args->mq,
2323 (char *)&report, sizeof(report), NULL);
2324 if (ret == sizeof(report)) {
2325 call_progress(args->progfunc, report.msg,
2326 &report.info, args->progctx);
2328 if (ret == 0 || (ret < 0 && errno != EINTR))
2336 generate_message_queue_name(char name[WIMFS_MQUEUE_NAME_LEN + 1])
2339 memcpy(name + 1, "wimfs-", 6);
2340 randomize_char_array_with_alnum(name + 7, WIMFS_MQUEUE_NAME_LEN - 7);
2341 name[WIMFS_MQUEUE_NAME_LEN] = '\0';
2345 create_message_queue(const char *name)
2350 struct mq_attr attr;
2353 memset(&attr, 0, sizeof(attr));
2355 attr.mq_msgsize = sizeof(struct commit_progress_report);
2357 am_root = (geteuid() == 0);
2359 /* Filesystem mounted as normal user with --allow-other should
2360 * be able to send messages to root user, if they're doing the
2362 umask_save = umask(0);
2367 mq = mq_open(name, O_RDWR | O_CREAT | O_EXCL, mode, &attr);
2373 /* Unmount a read-only or read-write mounted WIM image. */
2375 do_unmount(const char *dir)
2380 len = getxattr(dir, "wimfs.unmount", &status, sizeof(int));
2381 if (len == sizeof(int))
2383 else if (len < 0 && (errno == EACCES || errno == EPERM))
2384 return WIMLIB_ERR_NOT_PERMITTED_TO_UNMOUNT;
2386 return WIMLIB_ERR_NOT_A_MOUNTPOINT;
2390 set_unmount_info(const char *dir, const struct wimfs_unmount_info *unmount_info)
2392 if (!setxattr(dir, "wimfs.unmount_info",
2393 unmount_info, sizeof(struct wimfs_unmount_info), 0))
2395 else if (errno == EROFS)
2397 else if (errno == EACCES || errno == EPERM)
2398 return WIMLIB_ERR_NOT_PERMITTED_TO_UNMOUNT;
2400 return WIMLIB_ERR_NOT_A_MOUNTPOINT;
2404 do_unmount_discard(const char *dir)
2407 struct wimfs_unmount_info unmount_info;
2409 memset(&unmount_info, 0, sizeof(unmount_info));
2411 ret = set_unmount_info(dir, &unmount_info);
2414 return do_unmount(dir);
2417 /* Unmount a read-write mounted WIM image, committing the changes. */
2419 do_unmount_commit(const char *dir, int unmount_flags,
2420 wimlib_progress_func_t progfunc, void *progctx)
2422 struct wimfs_unmount_info unmount_info;
2424 struct commit_progress_thread_args args;
2425 pthread_t commit_progress_tid;
2428 memset(&unmount_info, 0, sizeof(unmount_info));
2429 unmount_info.unmount_flags = unmount_flags;
2431 /* The current thread will be stuck in getxattr() until the image is
2432 * committed. Create a thread to handle the progress messages. */
2434 generate_message_queue_name(unmount_info.mq_name);
2436 mq = create_message_queue(unmount_info.mq_name);
2437 if (mq == (mqd_t)-1) {
2438 ERROR_WITH_ERRNO("Can't create POSIX message queue");
2439 return WIMLIB_ERR_MQUEUE;
2442 args.progfunc = progfunc;
2443 args.progctx = progctx;
2444 ret = pthread_create(&commit_progress_tid, NULL,
2445 commit_progress_thread_proc, &args);
2448 ERROR_WITH_ERRNO("Can't create thread");
2449 ret = WIMLIB_ERR_NOMEM;
2452 unmount_info.unmount_flags |= WIMLIB_UNMOUNT_FLAG_SEND_PROGRESS;
2455 ret = set_unmount_info(dir, &unmount_info);
2457 ret = do_unmount(dir);
2459 /* Terminate the progress thread. */
2461 mq_send(mq, empty, 0, 1);
2462 pthread_join(commit_progress_tid, NULL);
2467 mq_unlink(unmount_info.mq_name);
2473 begin_unmount(const char *dir, int unmount_flags, int *mount_flags_ret,
2474 wimlib_progress_func_t progfunc, void *progctx)
2478 int wim_filename_len;
2479 union wimlib_progress_info progress;
2481 if (getxattr(dir, "wimfs.mount_flags",
2482 &mount_flags, sizeof(int)) != sizeof(int))
2483 return WIMLIB_ERR_NOT_A_MOUNTPOINT;
2485 *mount_flags_ret = mount_flags;
2490 if (getxattr(dir, "wimfs.mounted_image",
2491 &mounted_image, sizeof(int)) != sizeof(int))
2492 return WIMLIB_ERR_NOT_A_MOUNTPOINT;
2494 wim_filename_len = getxattr(dir, "wimfs.wim_filename", NULL, 0);
2495 if (wim_filename_len < 0)
2496 return WIMLIB_ERR_NOT_A_MOUNTPOINT;
2498 char wim_filename[wim_filename_len + 1];
2499 if (getxattr(dir, "wimfs.wim_filename",
2500 wim_filename, wim_filename_len) != wim_filename_len)
2501 return WIMLIB_ERR_NOT_A_MOUNTPOINT;
2502 wim_filename[wim_filename_len] = '\0';
2504 progress.unmount.mountpoint = dir;
2505 progress.unmount.mounted_wim = wim_filename;
2506 progress.unmount.mounted_image = mounted_image;
2507 progress.unmount.mount_flags = mount_flags;
2508 progress.unmount.unmount_flags = unmount_flags;
2510 return call_progress(progfunc, WIMLIB_PROGRESS_MSG_UNMOUNT_BEGIN,
2511 &progress, progctx);
2514 /* API function documented in wimlib.h */
2516 wimlib_unmount_image_with_progress(const char *dir, int unmount_flags,
2517 wimlib_progress_func_t progfunc, void *progctx)
2522 ret = wimlib_global_init(WIMLIB_INIT_FLAG_ASSUME_UTF8);
2526 if (unmount_flags & ~(WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY |
2527 WIMLIB_UNMOUNT_FLAG_COMMIT |
2528 WIMLIB_UNMOUNT_FLAG_REBUILD |
2529 WIMLIB_UNMOUNT_FLAG_RECOMPRESS |
2530 WIMLIB_UNMOUNT_FLAG_FORCE |
2531 WIMLIB_UNMOUNT_FLAG_NEW_IMAGE))
2532 return WIMLIB_ERR_INVALID_PARAM;
2534 ret = begin_unmount(dir, unmount_flags, &mount_flags,
2539 if ((unmount_flags & WIMLIB_UNMOUNT_FLAG_COMMIT) &&
2540 (mount_flags & WIMLIB_MOUNT_FLAG_READWRITE))
2541 return do_unmount_commit(dir, unmount_flags,
2544 return do_unmount_discard(dir);
2547 #else /* WITH_FUSE */
2551 mount_unsupported_error(void)
2553 #if defined(__WIN32__)
2554 ERROR("Sorry-- Mounting WIM images is not supported on Windows!");
2556 ERROR("wimlib was compiled with --without-fuse, which disables support "
2557 "for mounting WIMs.");
2559 return WIMLIB_ERR_UNSUPPORTED;
2563 wimlib_unmount_image_with_progress(const tchar *dir, int unmount_flags,
2564 wimlib_progress_func_t progfunc, void *progctx)
2566 return mount_unsupported_error();
2570 wimlib_mount_image(WIMStruct *wim, int image, const tchar *dir,
2571 int mount_flags, const tchar *staging_dir)
2573 return mount_unsupported_error();
2576 #endif /* !WITH_FUSE */
2579 wimlib_unmount_image(const tchar *dir, int unmount_flags)
2581 return wimlib_unmount_image_with_progress(dir, unmount_flags, NULL, NULL);