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 <sys/types.h> /* sometimes required before <attr/xattr.h> */
44 #include <attr/xattr.h>
58 #include "wimlib/blob_table.h"
59 #include "wimlib/dentry.h"
60 #include "wimlib/encoding.h"
61 #include "wimlib/metadata.h"
62 #include "wimlib/paths.h"
63 #include "wimlib/progress.h"
64 #include "wimlib/reparse.h"
65 #include "wimlib/timestamp.h"
66 #include "wimlib/unix_data.h"
67 #include "wimlib/write.h"
68 #include "wimlib/xml.h"
71 # define O_NOFOLLOW 0 /* Security only... */
74 #define WIMFS_MQUEUE_NAME_LEN 32
76 #define WIMLIB_UNMOUNT_FLAG_SEND_PROGRESS 0x80000000
78 struct wimfs_unmount_info {
79 unsigned unmount_flags;
80 char mq_name[WIMFS_MQUEUE_NAME_LEN + 1];
83 struct commit_progress_report {
84 enum wimlib_progress_msg msg;
85 union wimlib_progress_info info;
88 /* Description of an open file on a mounted WIM image. Actually, this
89 * represents the open state of a particular data stream of an inode, rather
90 * than the inode itself. (An inode might have multiple named data streams in
91 * addition to the default, unnamed data stream.) At a given time, an inode in
92 * the WIM image might have multiple file descriptors open to it, each to any
93 * one of its data streams. */
96 /* Pointer to the inode of this open file.
97 * 'i_num_opened_fds' of the inode tracks the number of file descriptors
98 * that reference it. */
99 struct wim_inode *f_inode;
101 /* Pointer to the blob descriptor for the data stream that has been
102 * opened. 'num_opened_fds' of the blob descriptor tracks the number of
103 * file descriptors that reference it. Or, this value may be NULL,
104 * which indicates that the opened stream is empty and consequently does
105 * not have a blob descriptor. */
106 struct blob_descriptor *f_blob;
108 /* If valid (filedes_valid(&f_staging_fd)), this contains the
109 * corresponding native file descriptor for the staging file that has
110 * been created for reading from and/or writing to this open stream. A
111 * single staging file might have multiple file descriptors open to it
112 * simultaneously, each used by a different 'struct wimfs_fd'.
114 * Or, if invalid (!filedes_valid(&f_staging_fd)), this 'struct
115 * wimfs_fd' is not associated with a staging file. This is permissible
116 * only if this 'struct wimfs_fd' was opened read-only and the stream
117 * has not yet been extracted to a staging file. */
118 struct filedes f_staging_fd;
120 /* 0-based index of this file descriptor in the file descriptor table of
124 /* Unique ID of the opened stream in the inode. This will stay the same
125 * even if the indices of the inode's streams are changed by a deletion.
130 #define WIMFS_FD(fi) ((struct wimfs_fd *)(uintptr_t)((fi)->fh))
132 /* Context structure for a mounted WIM image. */
133 struct wimfs_context {
134 /* The WIMStruct containing the mounted image. The mounted image is the
135 * currently selected image (wim->current_image). */
138 /* Flags passed to wimlib_mount_image() (WIMLIB_MOUNT_FLAG_*). */
141 /* Default flags for path lookup in the WIM image. */
142 int default_lookup_flags;
144 /* Information about the user who has mounted the WIM image */
148 /* Absolute path to the mountpoint directory (may be needed for absolute
149 * symbolic link fixups) */
150 char *mountpoint_abspath;
151 size_t mountpoint_abspath_nchars;
153 /* Information about the staging directory for a read-write mount. */
156 char *staging_dir_name;
158 /* For read-write mounts, the inode number to be assigned to the next
159 * created file. Note: since this isn't a persistent filesystem and we
160 * can re-assign the inode numbers just before mounting the image, it's
161 * good enough to just generate inode numbers sequentially. */
164 /* Number of file descriptors open to the mounted WIM image. */
165 unsigned long num_open_fds;
167 /* Original list of blobs in the mounted image, linked by
168 * 'struct blob_descriptor'.orig_blob_list. */
169 struct list_head orig_blob_list;
171 /* Parameters for unmounting the image (can be set via extended
172 * attribute "wimfs.unmount_info"). */
173 struct wimfs_unmount_info unmount_info;
176 #define WIMFS_CTX(fuse_ctx) ((struct wimfs_context*)(fuse_ctx)->private_data)
178 /* Retrieve the context structure for the currently mounted WIM image.
180 * Note: this is a per-thread variable. It is possible for different threads to
181 * mount different images at the same time in the same process, although they
182 * must use different WIMStructs! */
183 static inline struct wimfs_context *
184 wimfs_get_context(void)
186 return WIMFS_CTX(fuse_get_context());
190 wimfs_inc_num_open_fds(void)
192 wimfs_get_context()->num_open_fds++;
196 wimfs_dec_num_open_fds(void)
198 wimfs_get_context()->num_open_fds--;
201 /* Retrieve the WIMStruct for the currently mounted WIM image. */
202 static inline WIMStruct *
203 wimfs_get_WIMStruct(void)
205 return wimfs_get_context()->wim;
208 /* Is write permission requested on the file? */
210 flags_writable(int open_flags)
212 int accmode = (open_flags & O_ACCMODE);
213 return (accmode == O_RDWR || accmode == O_WRONLY);
217 fuse_mask_mode(mode_t mode, const struct fuse_context *fuse_ctx)
219 #if FUSE_MAJOR_VERSION > 2 || (FUSE_MAJOR_VERSION == 2 && FUSE_MINOR_VERSION >= 8)
220 mode &= ~fuse_ctx->umask;
226 * Allocate a file descriptor to a data stream in the mounted WIM image.
229 * The inode containing the stream being opened
231 * The stream of the inode being opened
233 * On success, a pointer to the new file descriptor will be stored here.
235 * Returns 0 or a -errno code.
238 alloc_wimfs_fd(struct wim_inode *inode,
239 struct wim_inode_stream *strm,
240 struct wimfs_fd **fd_ret)
242 static const u16 min_fds_per_alloc = 8;
243 static const u16 max_fds = 0xffff;
247 if (inode->i_num_opened_fds == inode->i_num_allocated_fds) {
249 struct wimfs_fd **fds;
251 /* Expand this inode's file descriptor table. */
253 num_new_fds = max(min_fds_per_alloc,
254 inode->i_num_allocated_fds / 4);
256 num_new_fds = min(num_new_fds,
257 max_fds - inode->i_num_allocated_fds);
259 if (num_new_fds == 0)
262 fds = REALLOC(inode->i_fds,
263 (inode->i_num_allocated_fds + num_new_fds) *
268 memset(&fds[inode->i_num_allocated_fds], 0,
269 num_new_fds * sizeof(fds[0]));
271 inode->i_num_allocated_fds += num_new_fds;
272 inode->i_next_fd = inode->i_num_opened_fds;
275 /* Allocate the file descriptor in the first available space in the
276 * inode's file descriptor table.
278 * i_next_fd is the lower bound on the next open slot. */
279 for (i = inode->i_next_fd; inode->i_fds[i]; i++)
282 fd = MALLOC(sizeof(*fd));
287 fd->f_blob = stream_blob_resolved(strm);
288 filedes_invalidate(&fd->f_staging_fd);
290 fd->f_stream_id = strm->stream_id;
292 inode->i_fds[i] = fd;
293 inode->i_num_opened_fds++;
295 fd->f_blob->num_opened_fds++;
296 wimfs_inc_num_open_fds();
297 inode->i_next_fd = i + 1;
302 * Close a file descriptor to a data stream in the mounted WIM image.
304 * Returns 0 or a -errno code. The file descriptor is always closed.
307 close_wimfs_fd(struct wimfs_fd *fd)
310 struct wim_inode *inode;
312 /* Close the staging file if open. */
313 if (filedes_valid(&fd->f_staging_fd))
314 if (filedes_close(&fd->f_staging_fd))
317 /* Release this file descriptor from its blob descriptor. */
319 blob_decrement_num_opened_fds(fd->f_blob);
321 wimfs_dec_num_open_fds();
323 /* Release this file descriptor from its inode. */
325 inode->i_fds[fd->f_idx] = NULL;
326 if (fd->f_idx < inode->i_next_fd)
327 inode->i_next_fd = fd->f_idx;
329 inode_dec_num_opened_fds(inode);
334 * Translate a path into the corresponding inode in the mounted WIM image.
336 * See get_dentry() for more information.
338 * Returns a pointer to the resulting inode, or NULL with errno set.
340 static struct wim_inode *
341 wim_pathname_to_inode(WIMStruct *wim, const char *path)
343 struct wim_dentry *dentry;
345 dentry = get_dentry(wim, path, WIMLIB_CASE_SENSITIVE);
348 return dentry->d_inode;
351 /* Can look up named data stream with colon syntax */
352 #define LOOKUP_FLAG_ADS_OK 0x01
354 /* Can look up directory (otherwise get -ENOTDIR) */
355 #define LOOKUP_FLAG_DIRECTORY_OK 0x02
357 /* Get the data stream of the specified name from the specified inode. Returns
358 * NULL with errno set if not found. */
359 static struct wim_inode_stream *
360 inode_get_data_stream_tstr(const struct wim_inode *inode,
361 const char *stream_name)
363 struct wim_inode_stream *strm;
365 if (!stream_name || !*stream_name) {
366 strm = inode_get_unnamed_data_stream(inode);
368 const utf16lechar *uname;
370 if (tstr_get_utf16le(stream_name, &uname))
372 strm = inode_get_stream(inode, STREAM_TYPE_DATA, uname);
373 tstr_put_utf16le(uname);
381 * Translate a path into the corresponding dentry and stream in the mounted WIM
384 * Returns 0 or a -errno code. @dentry_ret and @strm_ret are both optional.
387 wim_pathname_to_stream(const struct wimfs_context *ctx,
390 struct wim_dentry **dentry_ret,
391 struct wim_inode_stream **strm_ret)
393 WIMStruct *wim = ctx->wim;
394 struct wim_dentry *dentry;
395 struct wim_inode *inode;
396 struct wim_inode_stream *strm;
397 const char *stream_name = NULL;
400 lookup_flags |= ctx->default_lookup_flags;
402 if (lookup_flags & LOOKUP_FLAG_ADS_OK) {
403 stream_name = path_stream_name(path);
405 p = (char *)stream_name - 1;
410 dentry = get_dentry(wim, path, WIMLIB_CASE_SENSITIVE);
416 inode = dentry->d_inode;
418 if (inode_resolve_streams(inode, wim->blob_table, false))
421 if (!(lookup_flags & LOOKUP_FLAG_DIRECTORY_OK)
422 && inode_is_directory(inode))
425 strm = inode_get_data_stream_tstr(inode, stream_name);
427 /* Force creation of an unnamed data stream */
429 strm = inode_add_stream(inode, STREAM_TYPE_DATA,
430 NO_STREAM_NAME, NULL);
436 *dentry_ret = dentry;
443 * Create a new file in the mounted WIM image.
446 * The FUSE context for the mounted image.
448 * The path at which to create the first link to the new file. If a file
449 * already exists at this path, -EEXIST is returned.
451 * The UNIX mode for the new file. This is only fully honored if
452 * WIMLIB_MOUNT_FLAG_UNIX_DATA was passed to wimlib_mount_image().
454 * The device ID for the new file, encoding the major and minor device
455 * numbers. This is only honored if WIMLIB_MOUNT_FLAG_UNIX_DATA was passed
456 * to wimlib_mount_image().
458 * On success, a pointer to the new dentry is returned here. Its d_inode
459 * member will point to the new inode that was created for it and added to
460 * the mounted WIM image.
462 * Returns 0 or a -errno code.
465 create_file(struct fuse_context *fuse_ctx, const char *path,
466 mode_t mode, dev_t rdev, struct wim_dentry **dentry_ret)
468 struct wimfs_context *wimfs_ctx = WIMFS_CTX(fuse_ctx);
469 struct wim_dentry *parent;
470 const char *basename;
471 struct wim_dentry *dentry;
472 struct wim_inode *inode;
474 parent = get_parent_dentry(wimfs_ctx->wim, path, WIMLIB_CASE_SENSITIVE);
478 if (!dentry_is_directory(parent))
481 basename = path_basename(path);
483 if (get_dentry_child_with_name(parent, basename, WIMLIB_CASE_SENSITIVE))
486 if (new_dentry_with_new_inode(basename, true, &dentry))
489 inode = dentry->d_inode;
491 inode->i_ino = wimfs_ctx->next_ino++;
493 /* Note: we still use FILE_ATTRIBUTE_NORMAL for device nodes, named
494 * pipes, and sockets. The real mode is in the UNIX metadata. */
496 inode->i_attributes = FILE_ATTRIBUTE_DIRECTORY;
498 inode->i_attributes = FILE_ATTRIBUTE_NORMAL;
500 if (wimfs_ctx->mount_flags & WIMLIB_MOUNT_FLAG_UNIX_DATA) {
501 struct wimlib_unix_data unix_data;
503 unix_data.uid = fuse_ctx->uid;
504 unix_data.gid = fuse_ctx->gid;
505 unix_data.mode = fuse_mask_mode(mode, fuse_ctx);
506 unix_data.rdev = rdev;
507 if (!inode_set_unix_data(inode, &unix_data, UNIX_DATA_ALL))
514 hlist_add_head(&inode->i_hlist_node,
515 &wim_get_current_image_metadata(wimfs_ctx->wim)->inode_list);
517 dentry_add_child(parent, dentry);
519 *dentry_ret = dentry;
524 * Remove a dentry from the mounted WIM image; i.e. remove an alias for an
528 remove_dentry(struct wim_dentry *dentry, struct blob_table *blob_table)
530 /* Drop blob references. */
531 inode_unref_blobs(dentry->d_inode, blob_table);
533 /* Unlink the dentry from the image's dentry tree. */
534 unlink_dentry(dentry);
536 /* Delete the dentry. This will also decrement the link count of the
537 * corresponding inode, and possibly cause it to be deleted as well. */
541 /* Generate UNIX filetype mode bits for the specified WIM inode, based on its
542 * Windows file attributes. */
544 inode_unix_file_type(const struct wim_inode *inode)
546 if (inode_is_symlink(inode))
548 else if (inode_is_directory(inode))
554 /* Generate a default UNIX mode for the specified WIM inode. */
556 inode_default_unix_mode(const struct wim_inode *inode)
558 return inode_unix_file_type(inode) | 0777;
562 blob_size(const struct blob_descriptor *blob)
570 blob_stored_size(const struct blob_descriptor *blob)
574 if (blob->blob_location == BLOB_IN_WIM &&
575 blob->size == blob->rdesc->uncompressed_size)
576 return blob->rdesc->size_in_wim;
581 * Retrieve standard UNIX metadata ('struct stat') for a WIM inode.
583 * @blob is the blob descriptor for the stream of the inode that is being
584 * queried, or NULL. We mostly return the same information for all streams, but
585 * st_size and st_blocks may be different for different streams.
587 * This always returns 0.
590 inode_to_stbuf(const struct wim_inode *inode,
591 const struct blob_descriptor *blob, struct stat *stbuf)
593 const struct wimfs_context *ctx = wimfs_get_context();
594 struct wimlib_unix_data unix_data;
596 memset(stbuf, 0, sizeof(struct stat));
597 if ((ctx->mount_flags & WIMLIB_MOUNT_FLAG_UNIX_DATA) &&
598 inode_get_unix_data(inode, &unix_data))
600 /* Use the user ID, group ID, mode, and device ID from the
601 * inode's extra UNIX metadata information. */
602 stbuf->st_uid = unix_data.uid;
603 stbuf->st_gid = unix_data.gid;
604 stbuf->st_mode = unix_data.mode;
605 stbuf->st_rdev = unix_data.rdev;
607 /* Generate default values for the user ID, group ID, and mode.
609 * Note: in the case of an allow_other mount, fuse_context.uid
610 * may not be the same as wimfs_context.owner_uid! */
611 stbuf->st_uid = ctx->owner_uid;
612 stbuf->st_gid = ctx->owner_gid;
613 stbuf->st_mode = inode_default_unix_mode(inode);
615 stbuf->st_ino = inode->i_ino;
616 stbuf->st_nlink = inode->i_nlink;
617 stbuf->st_size = blob_size(blob);
618 #ifdef HAVE_STAT_NANOSECOND_PRECISION
619 stbuf->st_atim = wim_timestamp_to_timespec(inode->i_last_access_time);
620 stbuf->st_mtim = wim_timestamp_to_timespec(inode->i_last_write_time);
621 stbuf->st_ctim = stbuf->st_mtim;
623 stbuf->st_atime = wim_timestamp_to_time_t(inode->i_last_access_time);
624 stbuf->st_mtime = wim_timestamp_to_time_t(inode->i_last_write_time);
625 stbuf->st_ctime = stbuf->st_mtime;
627 stbuf->st_blocks = DIV_ROUND_UP(blob_stored_size(blob), 512);
631 /* Update the last access and last write timestamps of a WIM inode. */
633 touch_inode(struct wim_inode *inode)
635 u64 now = now_as_wim_timestamp();
636 inode->i_last_access_time = now;
637 inode->i_last_write_time = now;
641 touch_parent(struct wim_dentry *dentry)
643 touch_inode(dentry->d_parent->d_inode);
647 * Create a new file in the staging directory for a read-write mounted image.
649 * On success, returns the file descriptor for the new staging file, opened for
650 * writing. In addition, stores the allocated name of the staging file in
653 * On failure, returns -1 and sets errno.
656 create_staging_file(const struct wimfs_context *ctx, char **name_ret)
659 static const size_t STAGING_FILE_NAME_LEN = 20;
663 name = MALLOC(STAGING_FILE_NAME_LEN + 1);
666 name[STAGING_FILE_NAME_LEN] = '\0';
669 randomize_char_array_with_alnum(name, STAGING_FILE_NAME_LEN);
670 fd = openat(ctx->staging_dir_fd, name,
671 O_WRONLY | O_CREAT | O_EXCL | O_NOFOLLOW, 0600);
672 if (unlikely(fd < 0)) {
673 if (unlikely(errno == EEXIST))
674 /* Try again with another name. */
684 * Extract a blob to the staging directory. This is necessary when a stream
685 * using the blob is being opened for writing and the blob has not already been
686 * extracted to the staging directory.
689 * The inode containing the stream being opened for writing.
691 * The stream being opened for writing. The blob descriptor to which the
692 * stream refers will be changed by this function.
694 * Number of bytes of the blob to extract and include in the staging file.
695 * It may be less than the actual blob length, in which case only a prefix
696 * of the blob will be extracted. It may also be more than the actual blob
697 * length, in which case the extra space will be zero-filled.
699 * Returns 0 or a -errno code.
702 extract_blob_to_staging_dir(struct wim_inode *inode,
703 struct wim_inode_stream *strm,
704 off_t size, const struct wimfs_context *ctx)
706 struct blob_descriptor *old_blob;
707 struct blob_descriptor *new_blob;
708 char *staging_file_name;
714 old_blob = stream_blob_resolved(strm);
716 /* Create the staging file. */
717 staging_fd = create_staging_file(ctx, &staging_file_name);
718 if (unlikely(staging_fd < 0))
721 /* Extract the stream to the staging file (possibly truncated). */
725 filedes_init(&fd, staging_fd);
727 extract_size = min(old_blob->size, size);
728 result = extract_blob_prefix_to_fd(old_blob, extract_size, &fd);
734 /* In the case of truncate() to more than the file length, extend the
735 * staging file with zeroes by calling ftruncate(). */
736 if (!result && size > extract_size)
737 result = ftruncate(staging_fd, size);
739 /* Close the staging file. */
740 if (close(staging_fd))
743 /* If an error occurred, unlink the staging file. */
744 if (unlikely(result)) {
745 /* extract_blob_to_fd() should set errno, but if it didn't,
746 * set a default value. */
747 ret = errno ? -errno : -EIO;
748 goto out_delete_staging_file;
751 /* Create a blob descriptor for the staging file. */
752 new_blob = new_blob_descriptor();
753 if (unlikely(!new_blob)) {
755 goto out_delete_staging_file;
758 /* There may already be open file descriptors to this stream if it's
759 * previously been opened read-only, but just now we're opening it
760 * read-write. Identify those file descriptors, update them to use the
761 * new blob descriptor, and open staging file descriptors for them. */
762 for (u16 i = 0, j = 0; j < inode->i_num_opened_fds; i++) {
766 fd = inode->i_fds[i];
772 if (fd->f_stream_id != strm->stream_id)
775 /* This is a readonly fd for the same stream. */
776 fd->f_blob = new_blob;
777 new_blob->num_opened_fds++;
778 raw_fd = openat(ctx->staging_dir_fd, staging_file_name,
779 O_RDONLY | O_NOFOLLOW);
780 if (unlikely(raw_fd < 0)) {
782 goto out_revert_fd_changes;
784 filedes_init(&fd->f_staging_fd, raw_fd);
788 old_blob->num_opened_fds -= new_blob->num_opened_fds;
790 new_blob->blob_location = BLOB_IN_STAGING_FILE;
791 new_blob->staging_file_name = staging_file_name;
792 new_blob->staging_dir_fd = ctx->staging_dir_fd;
793 new_blob->size = size;
795 prepare_unhashed_blob(new_blob, inode, strm->stream_id,
796 &wim_get_current_image_metadata(ctx->wim)->unhashed_blobs);
797 inode_replace_stream_blob(inode, strm, new_blob, ctx->wim->blob_table);
800 out_revert_fd_changes:
801 for (u16 i = 0; new_blob->num_opened_fds; i++) {
802 struct wimfs_fd *fd = inode->i_fds[i];
803 if (fd && fd->f_stream_id == strm->stream_id) {
804 fd->f_blob = old_blob;
805 if (filedes_valid(&fd->f_staging_fd)) {
806 filedes_close(&fd->f_staging_fd);
807 filedes_invalidate(&fd->f_staging_fd);
809 new_blob->num_opened_fds--;
812 free_blob_descriptor(new_blob);
813 out_delete_staging_file:
814 unlinkat(ctx->staging_dir_fd, staging_file_name, 0);
815 FREE(staging_file_name);
820 * Create the staging directory for the WIM file.
822 * The staging directory will be created in the directory specified by the open
823 * file descriptor @parent_dir_fd. It will be given a randomly generated name
824 * based on @wim_basename, the name of the WIM file.
826 * On success, returns a file descriptor to the open staging directory with
827 * O_RDONLY access. In addition, stores the allocated name of the staging
828 * directory (relative to @parent_dir_fd) in @staging_dir_name_ret.
829 * On failure, returns -1 and sets errno.
832 make_staging_dir_at(int parent_dir_fd, const char *wim_basename,
833 char **staging_dir_name_ret)
835 static const char common_suffix[8] = ".staging";
836 static const size_t random_suffix_len = 10;
837 size_t wim_basename_len;
838 size_t staging_dir_name_len;
839 char *staging_dir_name;
843 wim_basename_len = strlen(wim_basename);
844 staging_dir_name_len = wim_basename_len + sizeof(common_suffix) +
846 staging_dir_name = MALLOC(staging_dir_name_len + 1);
847 if (!staging_dir_name)
850 p = staging_dir_name;
851 p = mempcpy(p, wim_basename, wim_basename_len);
852 p = mempcpy(p, common_suffix, sizeof(common_suffix));
853 randomize_char_array_with_alnum(p, random_suffix_len);
854 p += random_suffix_len;
857 if (mkdirat(parent_dir_fd, staging_dir_name, 0700))
860 fd = openat(parent_dir_fd, staging_dir_name,
861 O_RDONLY | O_DIRECTORY | O_NOFOLLOW);
865 *staging_dir_name_ret = staging_dir_name;
869 unlinkat(parent_dir_fd, staging_dir_name, AT_REMOVEDIR);
871 FREE(staging_dir_name);
876 * Create the staging directory and set ctx->staging_dir_fd,
877 * ctx->staging_dir_name, and ctx->parent_dir_fd.
880 make_staging_dir(struct wimfs_context *ctx, const char *parent_dir_path)
882 const char *wim_basename;
886 wim_basename = path_basename(ctx->wim->filename);
888 if (!parent_dir_path) {
889 /* The user did not specify a directory. Default to creating
890 * the staging directory alongside the WIM file. */
891 if (wim_basename > ctx->wim->filename) {
892 parent_dir_path = ctx->wim->filename;
893 end = (char *)(wim_basename - 1);
894 /* *end must be a slash. Temporarily overwrite it so we
895 * can open the parent directory. */
898 parent_dir_path = ".";
902 /* Open the parent directory (in which we'll create our staging
904 ctx->parent_dir_fd = open(parent_dir_path, O_RDONLY | O_DIRECTORY);
905 if (ctx->parent_dir_fd < 0) {
906 ERROR_WITH_ERRNO("Can't open directory \"%s\"",
908 ret = WIMLIB_ERR_OPENDIR;
909 goto out_restore_wim_filename;
912 ctx->staging_dir_fd = make_staging_dir_at(ctx->parent_dir_fd,
914 &ctx->staging_dir_name);
915 if (ctx->staging_dir_fd < 0) {
916 ERROR_WITH_ERRNO("Can't create staging directory in \"%s\"",
918 close(ctx->parent_dir_fd);
919 ret = WIMLIB_ERR_MKDIR;
920 goto out_restore_wim_filename;
923 out_restore_wim_filename:
929 /* Deletes the staging directory, undoing the effects of a successful call to
930 * make_staging_dir(). */
932 delete_staging_dir(struct wimfs_context *ctx)
937 dir = fdopendir(ctx->staging_dir_fd);
939 while ((ent = readdir(dir)))
940 unlinkat(ctx->staging_dir_fd, ent->d_name, 0);
943 close(ctx->staging_dir_fd);
945 if (unlinkat(ctx->parent_dir_fd, ctx->staging_dir_name, AT_REMOVEDIR))
946 WARNING_WITH_ERRNO("Could not delete staging directory");
947 FREE(ctx->staging_dir_name);
948 close(ctx->parent_dir_fd);
952 prepare_inodes(struct wimfs_context *ctx)
954 struct wim_image_metadata *imd;
955 struct wim_inode *inode;
958 imd = wim_get_current_image_metadata(ctx->wim);
959 image_for_each_inode(inode, imd) {
960 inode->i_ino = ctx->next_ino++;
961 inode->i_num_opened_fds = 0;
962 inode->i_num_allocated_fds = 0;
968 release_extra_refcnts(struct wimfs_context *ctx)
970 struct list_head *list = &ctx->orig_blob_list;
971 struct blob_table *blob_table = ctx->wim->blob_table;
972 struct blob_descriptor *blob, *tmp;
974 list_for_each_entry_safe(blob, tmp, list, orig_blob_list)
975 blob_subtract_refcnt(blob, blob_table, blob->out_refcnt);
978 /* Delete the 'struct blob_descriptor' for any stream that was modified
979 * or created in the read-write mounted image and had a final size of 0. */
981 delete_empty_blobs(struct wimfs_context *ctx)
983 struct blob_descriptor *blob, *tmp;
984 struct wim_image_metadata *imd;
986 imd = wim_get_current_image_metadata(ctx->wim);
988 image_for_each_unhashed_blob_safe(blob, tmp, imd) {
990 *retrieve_pointer_to_unhashed_blob(blob) = NULL;
991 list_del(&blob->unhashed_list);
992 free_blob_descriptor(blob);
997 /* Close all file descriptors open to the specified inode.
999 * Note: closing the last file descriptor might free the inode. */
1001 inode_close_fds(struct wim_inode *inode)
1003 u16 num_open_fds = inode->i_num_opened_fds;
1004 for (u16 i = 0; num_open_fds; i++) {
1005 if (inode->i_fds[i]) {
1006 close_wimfs_fd(inode->i_fds[i]);
1012 /* Close all file descriptors open to the mounted image. */
1014 close_all_fds(struct wimfs_context *ctx)
1016 struct wim_inode *inode;
1017 struct hlist_node *tmp;
1018 struct wim_image_metadata *imd;
1020 imd = wim_get_current_image_metadata(ctx->wim);
1022 image_for_each_inode_safe(inode, tmp, imd)
1023 inode_close_fds(inode);
1026 /* Moves the currently selected image, which may have been modified, to a new
1027 * index, and sets the original index to refer to a reset (unmodified) copy of
1030 renew_current_image(struct wimfs_context *ctx)
1032 WIMStruct *wim = ctx->wim;
1033 int idx = wim->current_image - 1;
1034 struct wim_image_metadata *imd = wim->image_metadata[idx];
1035 struct wim_image_metadata *replace_imd;
1036 struct blob_descriptor *new_blob;
1039 /* Create 'replace_imd' structure to use for the reset original,
1040 * unmodified image. */
1041 ret = WIMLIB_ERR_NOMEM;
1042 replace_imd = new_image_metadata();
1046 /* Create new blob descriptor for the modified image's metadata
1047 * resource, which doesn't exist yet. */
1048 ret = WIMLIB_ERR_NOMEM;
1049 new_blob = new_blob_descriptor();
1051 goto err_put_replace_imd;
1053 new_blob->refcnt = 1;
1054 new_blob->is_metadata = 1;
1056 /* Make the image being moved available at a new index. Increments the
1057 * WIM's image count, but does not increment the reference count of the
1058 * 'struct image_metadata'. */
1059 ret = append_image_metadata(wim, imd);
1061 goto err_free_new_blob;
1063 ret = xml_add_image(wim->xml_info, NULL);
1065 goto err_undo_append;
1067 replace_imd->metadata_blob = imd->metadata_blob;
1068 imd->metadata_blob = new_blob;
1069 wim->image_metadata[idx] = replace_imd;
1070 wim->current_image = wim->hdr.image_count;
1074 wim->hdr.image_count--;
1076 free_blob_descriptor(new_blob);
1077 err_put_replace_imd:
1078 put_image_metadata(replace_imd, NULL);
1083 static enum wimlib_progress_status
1084 commit_progress_func(enum wimlib_progress_msg msg,
1085 union wimlib_progress_info *info, void *progctx)
1087 mqd_t mq = *(mqd_t *)progctx;
1088 struct commit_progress_report report;
1090 memset(&report, 0, sizeof(report));
1093 report.info = *info;
1094 mq_send(mq, (const char *)&report, sizeof(report), 1);
1095 return WIMLIB_PROGRESS_STATUS_CONTINUE;
1098 /* Commit the mounted image to the underlying WIM file. */
1100 commit_image(struct wimfs_context *ctx, int unmount_flags, mqd_t mq)
1104 if (unmount_flags & WIMLIB_UNMOUNT_FLAG_SEND_PROGRESS)
1105 wimlib_register_progress_function(ctx->wim,
1106 commit_progress_func, &mq);
1108 wimlib_register_progress_function(ctx->wim, NULL, NULL);
1110 if (unmount_flags & WIMLIB_UNMOUNT_FLAG_NEW_IMAGE) {
1111 int ret = renew_current_image(ctx);
1115 release_extra_refcnts(ctx);
1117 INIT_LIST_HEAD(&ctx->orig_blob_list);
1118 delete_empty_blobs(ctx);
1119 mark_image_dirty(wim_get_current_image_metadata(ctx->wim));
1123 if (unmount_flags & WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY)
1124 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
1126 if (unmount_flags & WIMLIB_UNMOUNT_FLAG_REBUILD)
1127 write_flags |= WIMLIB_WRITE_FLAG_REBUILD;
1129 if (unmount_flags & WIMLIB_UNMOUNT_FLAG_RECOMPRESS)
1130 write_flags |= WIMLIB_WRITE_FLAG_RECOMPRESS;
1132 return wimlib_overwrite(ctx->wim, write_flags, 0);
1135 /* In the case of an allow_other mount, only the mount owner and root are
1136 * allowed to unmount the filesystem. */
1138 may_unmount_wimfs(void)
1140 const struct fuse_context *fuse_ctx = fuse_get_context();
1141 const struct wimfs_context *wimfs_ctx = WIMFS_CTX(fuse_ctx);
1143 return (fuse_ctx->uid == wimfs_ctx->owner_uid ||
1144 fuse_ctx->uid == 0);
1147 /* Unmount the mounted image, called from the daemon process. */
1151 struct fuse_context *fuse_ctx = fuse_get_context();
1152 struct wimfs_context *wimfs_ctx = WIMFS_CTX(fuse_ctx);
1153 const struct wimfs_unmount_info *info = &wimfs_ctx->unmount_info;
1154 int unmount_flags = info->unmount_flags;
1155 mqd_t mq = (mqd_t)-1;
1158 /* Ignore COMMIT if the image is mounted read-only. */
1159 if (!(wimfs_ctx->mount_flags & WIMLIB_MOUNT_FLAG_READWRITE))
1160 unmount_flags &= ~WIMLIB_UNMOUNT_FLAG_COMMIT;
1162 if (unmount_flags & WIMLIB_UNMOUNT_FLAG_SEND_PROGRESS) {
1163 mq = mq_open(info->mq_name, O_WRONLY | O_NONBLOCK);
1164 if (mq == (mqd_t)-1) {
1165 ret = WIMLIB_ERR_MQUEUE;
1170 if (wimfs_ctx->num_open_fds) {
1172 /* There are still open file descriptors to the image. */
1174 /* With COMMIT, refuse to unmount unless FORCE is also
1176 if ((unmount_flags & (WIMLIB_UNMOUNT_FLAG_COMMIT |
1177 WIMLIB_UNMOUNT_FLAG_FORCE))
1178 == WIMLIB_UNMOUNT_FLAG_COMMIT)
1180 ret = WIMLIB_ERR_MOUNTED_IMAGE_IS_BUSY;
1184 /* Force-close all file descriptors. */
1185 close_all_fds(wimfs_ctx);
1188 if (unmount_flags & WIMLIB_UNMOUNT_FLAG_COMMIT)
1189 ret = commit_image(wimfs_ctx, unmount_flags, mq);
1191 ret = 0; /* Read-only mount, or discarding changes to
1192 a read-write mount */
1195 /* Leave the image mounted if commit failed, unless this is a
1196 * forced unmount. The user can retry without COMMIT if they
1198 if (!ret || (unmount_flags & WIMLIB_UNMOUNT_FLAG_FORCE)) {
1199 unlock_wim_for_append(wimfs_ctx->wim);
1200 fuse_exit(fuse_ctx->fuse);
1202 if (mq != (mqd_t)-1)
1208 wimfs_chmod(const char *path, mode_t mask)
1210 const struct wimfs_context *ctx = wimfs_get_context();
1211 struct wim_inode *inode;
1212 struct wimlib_unix_data unix_data;
1214 if (!(ctx->mount_flags & WIMLIB_MOUNT_FLAG_UNIX_DATA))
1217 inode = wim_pathname_to_inode(ctx->wim, path);
1221 unix_data.uid = ctx->owner_uid;
1222 unix_data.gid = ctx->owner_gid;
1223 unix_data.mode = mask;
1226 if (!inode_set_unix_data(inode, &unix_data, UNIX_DATA_MODE))
1233 wimfs_chown(const char *path, uid_t uid, gid_t gid)
1235 const struct wimfs_context *ctx = wimfs_get_context();
1236 struct wim_inode *inode;
1237 struct wimlib_unix_data unix_data;
1240 if (!(ctx->mount_flags & WIMLIB_MOUNT_FLAG_UNIX_DATA))
1243 inode = wim_pathname_to_inode(ctx->wim, path);
1249 if (uid != (uid_t)-1)
1250 which |= UNIX_DATA_UID;
1252 uid = ctx->owner_uid;
1254 if (gid != (gid_t)-1)
1255 which |= UNIX_DATA_GID;
1257 gid = ctx->owner_gid;
1259 unix_data.uid = uid;
1260 unix_data.gid = gid;
1261 unix_data.mode = inode_default_unix_mode(inode);
1264 if (!inode_set_unix_data(inode, &unix_data, which))
1271 wimfs_fgetattr(const char *path, struct stat *stbuf, struct fuse_file_info *fi)
1273 struct wimfs_fd *fd = WIMFS_FD(fi);
1274 return inode_to_stbuf(fd->f_inode, fd->f_blob, stbuf);
1278 wimfs_ftruncate(const char *path, off_t size, struct fuse_file_info *fi)
1280 struct wimfs_fd *fd = WIMFS_FD(fi);
1281 if (ftruncate(fd->f_staging_fd.fd, size))
1283 touch_inode(fd->f_inode);
1284 fd->f_blob->size = size;
1289 wimfs_getattr(const char *path, struct stat *stbuf)
1291 const struct wimfs_context *ctx = wimfs_get_context();
1292 struct wim_dentry *dentry;
1293 struct wim_inode_stream *strm;
1296 ret = wim_pathname_to_stream(ctx, path, LOOKUP_FLAG_DIRECTORY_OK,
1301 return inode_to_stbuf(dentry->d_inode,
1302 stream_blob_resolved(strm), stbuf);
1306 copy_xattr(char *dest, size_t destsize, const void *src, size_t srcsize)
1309 if (destsize < srcsize)
1311 memcpy(dest, src, srcsize);
1317 wimfs_getxattr(const char *path, const char *name, char *value,
1320 const struct wimfs_context *ctx = wimfs_get_context();
1321 const struct wim_inode *inode;
1322 const struct wim_inode_stream *strm;
1323 const struct blob_descriptor *blob;
1325 if (!strncmp(name, "wimfs.", 6)) {
1326 /* Handle some magical extended attributes. These really should
1327 * be ioctls, but directory ioctls aren't supported until
1328 * libfuse 2.9, and even then they are broken. */
1330 if (!strcmp(name, "wim_filename")) {
1331 return copy_xattr(value, size, ctx->wim->filename,
1332 strlen(ctx->wim->filename));
1334 if (!strcmp(name, "wim_info")) {
1335 struct wimlib_wim_info info;
1337 wimlib_get_wim_info(ctx->wim, &info);
1339 return copy_xattr(value, size, &info, sizeof(info));
1341 if (!strcmp(name, "mounted_image")) {
1342 return copy_xattr(value, size,
1343 &ctx->wim->current_image, sizeof(int));
1345 if (!strcmp(name, "mount_flags")) {
1346 return copy_xattr(value, size,
1347 &ctx->mount_flags, sizeof(int));
1349 if (!strcmp(name, "unmount")) {
1350 if (!may_unmount_wimfs())
1355 if (size < sizeof(int))
1357 status = unmount_wimfs();
1358 memcpy(value, &status, sizeof(int));
1365 if (!(ctx->mount_flags & WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR))
1368 if (strncmp(name, "user.", 5))
1375 /* Querying a named data stream */
1377 inode = wim_pathname_to_inode(ctx->wim, path);
1381 strm = inode_get_data_stream_tstr(inode, name);
1383 return (errno == ENOENT) ? -ENOATTR : -errno;
1385 blob = stream_blob_resolved(strm);
1389 if (unlikely(blob->size > INT_MAX))
1393 if (size < blob->size)
1396 if (read_blob_into_buf(blob, value))
1397 return errno ? -errno : -EIO;
1403 wimfs_link(const char *existing_path, const char *new_path)
1405 WIMStruct *wim = wimfs_get_WIMStruct();
1406 const char *new_name;
1407 struct wim_inode *inode;
1408 struct wim_dentry *dir;
1409 struct wim_dentry *new_alias;
1411 inode = wim_pathname_to_inode(wim, existing_path);
1415 if (inode->i_attributes & (FILE_ATTRIBUTE_DIRECTORY |
1416 FILE_ATTRIBUTE_REPARSE_POINT))
1419 new_name = path_basename(new_path);
1421 dir = get_parent_dentry(wim, new_path, WIMLIB_CASE_SENSITIVE);
1425 if (!dentry_is_directory(dir))
1428 if (get_dentry_child_with_name(dir, new_name, WIMLIB_CASE_SENSITIVE))
1431 if (new_dentry_with_existing_inode(new_name, inode, &new_alias))
1434 dentry_add_child(dir, new_alias);
1435 touch_inode(dir->d_inode);
1440 wimfs_listxattr(const char *path, char *list, size_t size)
1442 const struct wimfs_context *ctx = wimfs_get_context();
1443 const struct wim_inode *inode;
1445 char *end = list + size;
1448 if (!(ctx->mount_flags & WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR))
1451 /* List named data streams, or get the list size. We report each named
1452 * data stream "X" as an extended attribute "user.X". */
1454 inode = wim_pathname_to_inode(ctx->wim, path);
1458 for (unsigned i = 0; i < inode->i_num_streams; i++) {
1459 const struct wim_inode_stream *strm;
1460 char *stream_name_mbs;
1461 size_t stream_name_mbs_nbytes;
1463 strm = &inode->i_streams[i];
1465 if (!stream_is_named_data_stream(strm))
1468 if (utf16le_to_tstr(strm->stream_name,
1469 utf16le_len_bytes(strm->stream_name),
1471 &stream_name_mbs_nbytes))
1474 if (unlikely(INT_MAX - total_size < stream_name_mbs_nbytes + 6)) {
1475 FREE(stream_name_mbs);
1479 total_size += stream_name_mbs_nbytes + 6;
1481 if (end - p < stream_name_mbs_nbytes + 6) {
1482 FREE(stream_name_mbs);
1485 p = mempcpy(p, "user.", 5);
1486 p = mempcpy(p, stream_name_mbs, stream_name_mbs_nbytes);
1489 FREE(stream_name_mbs);
1495 wimfs_mkdir(const char *path, mode_t mode)
1497 struct wim_dentry *dentry;
1500 /* Note: according to fuse.h, mode may not include S_IFDIR */
1501 ret = create_file(fuse_get_context(), path, mode | S_IFDIR, 0, &dentry);
1504 touch_parent(dentry);
1509 wimfs_mknod(const char *path, mode_t mode, dev_t rdev)
1511 struct fuse_context *fuse_ctx = fuse_get_context();
1512 struct wimfs_context *wimfs_ctx = WIMFS_CTX(fuse_ctx);
1513 const char *stream_name;
1515 if ((wimfs_ctx->mount_flags & WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS)
1516 && (stream_name = path_stream_name(path)))
1518 struct wim_inode *inode;
1519 struct wim_inode_stream *existing_strm;
1520 struct wim_inode_stream *new_strm;
1522 const utf16lechar *uname;
1524 /* Create a named data stream. */
1529 p = (char *)stream_name - 1;
1532 inode = wim_pathname_to_inode(wimfs_ctx->wim, path);
1537 if (tstr_get_utf16le(stream_name, &uname))
1540 existing_strm = inode_get_stream(inode, STREAM_TYPE_DATA, uname);
1541 if (existing_strm) {
1542 tstr_put_utf16le(uname);
1546 new_strm = inode_add_stream(inode, STREAM_TYPE_DATA, uname, NULL);
1548 tstr_put_utf16le(uname);
1554 /* Create a regular file, device node, named pipe, or socket.
1556 struct wim_dentry *dentry;
1559 if (!S_ISREG(mode) &&
1560 !(wimfs_ctx->mount_flags & WIMLIB_MOUNT_FLAG_UNIX_DATA))
1563 ret = create_file(fuse_ctx, path, mode, rdev, &dentry);
1566 touch_parent(dentry);
1572 wimfs_open(const char *path, struct fuse_file_info *fi)
1574 struct wimfs_context *ctx = wimfs_get_context();
1575 struct wim_dentry *dentry;
1576 struct wim_inode *inode;
1577 struct wim_inode_stream *strm;
1578 struct blob_descriptor *blob;
1579 struct wimfs_fd *fd;
1582 ret = wim_pathname_to_stream(ctx, path, 0, &dentry, &strm);
1586 inode = dentry->d_inode;
1587 blob = stream_blob_resolved(strm);
1589 /* The data of the file being opened may be in the staging directory
1590 * (read-write mounts only) or in the WIM. If it's in the staging
1591 * directory, we need to open a native file descriptor for the
1592 * corresponding file. Otherwise, we can read the file data directly
1593 * from the WIM file if we are opening it read-only, but we need to
1594 * extract the data to the staging directory if we are opening it
1597 if (flags_writable(fi->flags) &&
1598 (!blob || blob->blob_location != BLOB_IN_STAGING_FILE)) {
1599 ret = extract_blob_to_staging_dir(inode,
1605 blob = stream_blob_resolved(strm);
1608 ret = alloc_wimfs_fd(inode, strm, &fd);
1612 if (blob && blob->blob_location == BLOB_IN_STAGING_FILE) {
1615 raw_fd = openat(blob->staging_dir_fd, blob->staging_file_name,
1616 (fi->flags & O_ACCMODE) | O_NOFOLLOW);
1621 filedes_init(&fd->f_staging_fd, raw_fd);
1623 fi->fh = (uintptr_t)fd;
1628 wimfs_opendir(const char *path, struct fuse_file_info *fi)
1630 WIMStruct *wim = wimfs_get_WIMStruct();
1631 struct wim_inode *inode;
1632 struct wim_inode_stream *strm;
1633 struct wimfs_fd *fd;
1636 inode = wim_pathname_to_inode(wim, path);
1639 if (!inode_is_directory(inode))
1641 strm = inode_get_unnamed_data_stream(inode);
1644 ret = alloc_wimfs_fd(inode, strm, &fd);
1647 fi->fh = (uintptr_t)fd;
1652 wimfs_read(const char *path, char *buf, size_t size,
1653 off_t offset, struct fuse_file_info *fi)
1655 struct wimfs_fd *fd = WIMFS_FD(fi);
1656 const struct blob_descriptor *blob;
1663 if (offset >= blob->size)
1666 if (size > blob->size - offset)
1667 size = blob->size - offset;
1672 switch (blob->blob_location) {
1674 if (read_partial_wim_blob_into_buf(blob, offset, size, buf))
1675 ret = errno ? -errno : -EIO;
1679 case BLOB_IN_STAGING_FILE:
1680 ret = pread(fd->f_staging_fd.fd, buf, size, offset);
1684 case BLOB_IN_ATTACHED_BUFFER:
1685 memcpy(buf, blob->attached_buffer + offset, size);
1696 wimfs_readdir(const char *path, void *buf, fuse_fill_dir_t filler,
1697 off_t offset, struct fuse_file_info *fi)
1699 struct wimfs_fd *fd = WIMFS_FD(fi);
1700 const struct wim_inode *inode;
1701 const struct wim_dentry *child;
1704 inode = fd->f_inode;
1706 ret = filler(buf, ".", NULL, 0);
1709 ret = filler(buf, "..", NULL, 0);
1713 for_inode_child(child, inode) {
1717 if (utf16le_to_tstr(child->d_name, child->d_name_nbytes,
1718 &name, &name_nbytes))
1721 ret = filler(buf, name, NULL, 0);
1730 wimfs_readlink(const char *path, char *buf, size_t bufsize)
1732 struct wimfs_context *ctx = wimfs_get_context();
1733 const struct wim_inode *inode;
1736 inode = wim_pathname_to_inode(ctx->wim, path);
1741 ret = wim_inode_readlink(inode, buf, bufsize - 1, NULL,
1742 ctx->mountpoint_abspath,
1743 ctx->mountpoint_abspath_nchars);
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, &dentry);
1909 ret = wim_inode_set_symlink(dentry->d_inode, to,
1910 wimfs_ctx->wim->blob_table);
1912 remove_dentry(dentry, wimfs_ctx->wim->blob_table);
1913 if (ret == WIMLIB_ERR_NOMEM)
1918 touch_parent(dentry);
1924 wimfs_truncate(const char *path, off_t size)
1926 const struct wimfs_context *ctx = wimfs_get_context();
1927 struct wim_dentry *dentry;
1928 struct wim_inode_stream *strm;
1929 struct blob_descriptor *blob;
1933 ret = wim_pathname_to_stream(ctx, path, 0, &dentry, &strm);
1937 blob = stream_blob_resolved(strm);
1942 if (!blob || blob->blob_location != BLOB_IN_STAGING_FILE) {
1943 return extract_blob_to_staging_dir(dentry->d_inode,
1947 /* Truncate the staging file. */
1948 fd = openat(blob->staging_dir_fd, blob->staging_file_name,
1949 O_WRONLY | O_NOFOLLOW);
1952 ret = ftruncate(fd, size);
1953 if (close(fd) || ret)
1956 touch_inode(dentry->d_inode);
1961 wimfs_unlink(const char *path)
1963 const struct wimfs_context *ctx = wimfs_get_context();
1964 struct wim_dentry *dentry;
1965 struct wim_inode_stream *strm;
1968 ret = wim_pathname_to_stream(ctx, path, 0, &dentry, &strm);
1972 if (stream_is_named(strm)) {
1973 inode_remove_stream(dentry->d_inode, strm,
1974 ctx->wim->blob_table);
1976 touch_parent(dentry);
1977 remove_dentry(dentry, ctx->wim->blob_table);
1982 #ifdef HAVE_UTIMENSAT
1984 * Change the timestamp on a file dentry.
1986 * Note that alternate data streams do not have their own timestamps.
1989 wimfs_utimens(const char *path, const struct timespec tv[2])
1991 WIMStruct *wim = wimfs_get_WIMStruct();
1992 struct wim_inode *inode;
1994 inode = wim_pathname_to_inode(wim, path);
1998 if (tv[0].tv_nsec != UTIME_OMIT) {
1999 if (tv[0].tv_nsec == UTIME_NOW)
2000 inode->i_last_access_time = now_as_wim_timestamp();
2002 inode->i_last_access_time = timespec_to_wim_timestamp(&tv[0]);
2004 if (tv[1].tv_nsec != UTIME_OMIT) {
2005 if (tv[1].tv_nsec == UTIME_NOW)
2006 inode->i_last_write_time = now_as_wim_timestamp();
2008 inode->i_last_write_time = timespec_to_wim_timestamp(&tv[1]);
2012 #else /* HAVE_UTIMENSAT */
2014 wimfs_utime(const char *path, struct utimbuf *times)
2016 WIMStruct *wim = wimfs_get_WIMStruct();
2017 struct wim_inode *inode;
2019 inode = wim_pathname_to_inode(wim, path);
2023 inode->i_last_access_time = time_t_to_wim_timestamp(times->actime);
2024 inode->i_last_write_time = time_t_to_wim_timestamp(times->modtime);
2027 #endif /* !HAVE_UTIMENSAT */
2030 wimfs_write(const char *path, const char *buf, size_t size,
2031 off_t offset, struct fuse_file_info *fi)
2033 struct wimfs_fd *fd = WIMFS_FD(fi);
2036 ret = pwrite(fd->f_staging_fd.fd, buf, size, offset);
2040 if (offset + size > fd->f_blob->size)
2041 fd->f_blob->size = offset + size;
2043 touch_inode(fd->f_inode);
2047 static struct fuse_operations wimfs_operations = {
2048 .chmod = wimfs_chmod,
2049 .chown = wimfs_chown,
2050 .fgetattr = wimfs_fgetattr,
2051 .ftruncate = wimfs_ftruncate,
2052 .getattr = wimfs_getattr,
2053 .getxattr = wimfs_getxattr,
2055 .listxattr = wimfs_listxattr,
2056 .mkdir = wimfs_mkdir,
2057 .mknod = wimfs_mknod,
2059 .opendir = wimfs_opendir,
2061 .readdir = wimfs_readdir,
2062 .readlink = wimfs_readlink,
2063 .release = wimfs_release,
2064 .releasedir = wimfs_release,
2065 .removexattr = wimfs_removexattr,
2066 .rename = wimfs_rename,
2067 .rmdir = wimfs_rmdir,
2068 .setxattr = wimfs_setxattr,
2069 .symlink = wimfs_symlink,
2070 .truncate = wimfs_truncate,
2071 .unlink = wimfs_unlink,
2072 #ifdef HAVE_UTIMENSAT
2073 .utimens = wimfs_utimens,
2075 .utime = wimfs_utime,
2077 .write = wimfs_write,
2079 /* We keep track of file descriptor structures (struct wimfs_fd), so
2080 * there is no need to have the file path provided on operations such as
2082 #if FUSE_MAJOR_VERSION > 2 || (FUSE_MAJOR_VERSION == 2 && FUSE_MINOR_VERSION >= 8)
2083 .flag_nullpath_ok = 1,
2085 #if FUSE_MAJOR_VERSION > 2 || (FUSE_MAJOR_VERSION == 2 && FUSE_MINOR_VERSION >= 9)
2087 .flag_utime_omit_ok = 1,
2091 /* API function documented in wimlib.h */
2093 wimlib_mount_image(WIMStruct *wim, int image, const char *dir,
2094 int mount_flags, const char *staging_dir)
2097 struct wim_image_metadata *imd;
2098 struct wimfs_context ctx;
2099 char *fuse_argv[16];
2102 if (!wim || !dir || !*dir)
2103 return WIMLIB_ERR_INVALID_PARAM;
2105 if (mount_flags & ~(WIMLIB_MOUNT_FLAG_READWRITE |
2106 WIMLIB_MOUNT_FLAG_DEBUG |
2107 WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE |
2108 WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR |
2109 WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS |
2110 WIMLIB_MOUNT_FLAG_UNIX_DATA |
2111 WIMLIB_MOUNT_FLAG_ALLOW_OTHER))
2112 return WIMLIB_ERR_INVALID_PARAM;
2114 /* For read-write mount, check for write access to the WIM. */
2115 if (mount_flags & WIMLIB_MOUNT_FLAG_READWRITE) {
2117 return WIMLIB_ERR_NO_FILENAME;
2118 ret = can_modify_wim(wim);
2123 /* Select the image to mount. */
2124 ret = select_wim_image(wim, image);
2128 /* Get the metadata for the image to mount. */
2129 imd = wim_get_current_image_metadata(wim);
2131 /* To avoid complicating things, we don't support mounting images to
2132 * which in-memory modifications have already been made. */
2133 if (is_image_dirty(imd)) {
2134 ERROR("Cannot mount a modified WIM image!");
2135 return WIMLIB_ERR_INVALID_PARAM;
2138 if (mount_flags & WIMLIB_MOUNT_FLAG_READWRITE) {
2139 if (imd->refcnt > 1)
2140 return WIMLIB_ERR_IMAGE_HAS_MULTIPLE_REFERENCES;
2141 ret = lock_wim_for_append(wim);
2146 if (wim_has_solid_resources(wim)) {
2147 WARNING("Mounting a WIM file containing solid-compressed data; "
2148 "file access may be slow.");
2151 /* If the user did not specify an interface for accessing named
2152 * data streams, use the default (extended attributes). */
2153 if (!(mount_flags & (WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE |
2154 WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR |
2155 WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS)))
2156 mount_flags |= WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR;
2158 /* Start initializing the wimfs_context. */
2159 memset(&ctx, 0, sizeof(struct wimfs_context));
2161 ctx.mount_flags = mount_flags;
2162 if (mount_flags & WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS)
2163 ctx.default_lookup_flags = LOOKUP_FLAG_ADS_OK;
2164 /* For read-write mount, create the staging directory. */
2165 if (mount_flags & WIMLIB_MOUNT_FLAG_READWRITE) {
2166 ret = make_staging_dir(&ctx, staging_dir);
2170 ctx.owner_uid = getuid();
2171 ctx.owner_gid = getgid();
2173 /* Add each blob referenced by files in the image to a list and
2174 * preemptively double the number of references to each. This is done
2175 * to allow implementing the WIMLIB_UNMOUNT_FLAG_NEW_IMAGE semantics.
2177 INIT_LIST_HEAD(&ctx.orig_blob_list);
2178 if (mount_flags & WIMLIB_MOUNT_FLAG_READWRITE) {
2180 struct wim_inode *inode;
2181 struct blob_descriptor *blob;
2183 image_for_each_inode(inode, imd) {
2184 for (i = 0; i < inode->i_num_streams; i++) {
2185 blob = stream_blob(&inode->i_streams[i],
2188 blob->out_refcnt = 0;
2192 image_for_each_inode(inode, imd) {
2193 for (i = 0; i < inode->i_num_streams; i++) {
2194 blob = stream_blob(&inode->i_streams[i],
2197 if (blob->out_refcnt == 0)
2198 list_add(&blob->orig_blob_list,
2199 &ctx.orig_blob_list);
2200 blob->out_refcnt += inode->i_nlink;
2201 blob->refcnt += inode->i_nlink;
2207 /* Number the inodes in the mounted image sequentially and initialize
2208 * the file descriptor arrays */
2209 prepare_inodes(&ctx);
2211 /* Save the absolute path to the mountpoint directory. */
2212 ctx.mountpoint_abspath = realpath(dir, NULL);
2213 if (ctx.mountpoint_abspath)
2214 ctx.mountpoint_abspath_nchars = strlen(ctx.mountpoint_abspath);
2216 /* Build the FUSE command line. */
2219 fuse_argv[fuse_argc++] = "wimlib";
2220 fuse_argv[fuse_argc++] = (char *)dir;
2222 /* Disable multi-threaded operation. */
2223 fuse_argv[fuse_argc++] = "-s";
2225 /* Enable FUSE debug mode (don't fork) if requested by the user. */
2226 if (mount_flags & WIMLIB_MOUNT_FLAG_DEBUG)
2227 fuse_argv[fuse_argc++] = "-d";
2230 * Build the FUSE mount options:
2233 * FUSE will use the inode numbers we provide. We want this,
2234 * because we have inodes and will number them ourselves.
2237 * Name for our filesystem (main type is "fuse").
2240 * If an open file is unlinked, unlink it for real rather than
2241 * renaming it to a hidden file. Our code supports this; an
2242 * unlinked inode is retained until all its file descriptors have
2245 * default_permissions
2246 * FUSE will perform permission checking. Useful when
2247 * WIMLIB_MOUNT_FLAG_UNIX_DATA is provided and the WIM image
2248 * contains the UNIX permissions for each file.
2251 * Cache the contents of files. This will speed up repeated access
2252 * to files on a mounted WIM image, since they won't need to be
2253 * decompressed repeatedly. This option is valid because data in
2254 * the WIM image should never be changed externally. (Although, if
2255 * someone really wanted to they could modify the WIM file or mess
2256 * with the staging directory; but then they're asking for
2259 * entry_timeout=1000000000
2260 * Cache positive name lookups indefinitely, since names can only
2261 * be added, removed, or modified through the mounted filesystem
2264 * negative_timeout=1000000000
2265 * Cache negative name lookups indefinitely, since names can only
2266 * be added, removed, or modified through the mounted filesystem
2270 * Don't cache file/directory attributes. This is needed as a
2271 * workaround for the fact that when caching attributes, the high
2272 * level interface to libfuse considers a file which has several
2273 * hard-linked names as several different files. (Otherwise, we
2274 * could cache our file/directory attributes indefinitely, since
2275 * they can only be changed through the mounted filesystem itself.)
2277 char optstring[256] =
2281 ",default_permissions"
2283 ",entry_timeout=1000000000"
2284 ",negative_timeout=1000000000"
2287 fuse_argv[fuse_argc++] = "-o";
2288 fuse_argv[fuse_argc++] = optstring;
2289 if (!(mount_flags & WIMLIB_MOUNT_FLAG_READWRITE))
2290 strcat(optstring, ",ro");
2291 if (mount_flags & WIMLIB_MOUNT_FLAG_ALLOW_OTHER)
2292 strcat(optstring, ",allow_other");
2293 fuse_argv[fuse_argc] = NULL;
2295 /* Mount our filesystem. */
2296 ret = fuse_main(fuse_argc, fuse_argv, &wimfs_operations, &ctx);
2298 /* Cleanup and return. */
2300 ret = WIMLIB_ERR_FUSE;
2301 FREE(ctx.mountpoint_abspath);
2302 release_extra_refcnts(&ctx);
2303 if (mount_flags & WIMLIB_MOUNT_FLAG_READWRITE)
2304 delete_staging_dir(&ctx);
2306 unlock_wim_for_append(wim);
2310 struct commit_progress_thread_args {
2312 wimlib_progress_func_t progfunc;
2317 commit_progress_thread_proc(void *_args)
2319 struct commit_progress_thread_args *args = _args;
2320 struct commit_progress_report report;
2324 ret = mq_receive(args->mq,
2325 (char *)&report, sizeof(report), NULL);
2326 if (ret == sizeof(report)) {
2327 call_progress(args->progfunc, report.msg,
2328 &report.info, args->progctx);
2330 if (ret == 0 || (ret < 0 && errno != EINTR))
2338 generate_message_queue_name(char name[WIMFS_MQUEUE_NAME_LEN + 1])
2341 memcpy(name + 1, "wimfs-", 6);
2342 randomize_char_array_with_alnum(name + 7, WIMFS_MQUEUE_NAME_LEN - 7);
2343 name[WIMFS_MQUEUE_NAME_LEN] = '\0';
2347 create_message_queue(const char *name)
2352 struct mq_attr attr;
2355 memset(&attr, 0, sizeof(attr));
2357 attr.mq_msgsize = sizeof(struct commit_progress_report);
2359 am_root = (geteuid() == 0);
2361 /* Filesystem mounted as normal user with --allow-other should
2362 * be able to send messages to root user, if they're doing the
2364 umask_save = umask(0);
2369 mq = mq_open(name, O_RDWR | O_CREAT | O_EXCL, mode, &attr);
2375 /* Unmount a read-only or read-write mounted WIM image. */
2377 do_unmount(const char *dir)
2382 len = getxattr(dir, "wimfs.unmount", &status, sizeof(int));
2383 if (len == sizeof(int))
2385 else if (len < 0 && (errno == EACCES || errno == EPERM))
2386 return WIMLIB_ERR_NOT_PERMITTED_TO_UNMOUNT;
2388 return WIMLIB_ERR_NOT_A_MOUNTPOINT;
2392 set_unmount_info(const char *dir, const struct wimfs_unmount_info *unmount_info)
2394 if (!setxattr(dir, "wimfs.unmount_info",
2395 unmount_info, sizeof(struct wimfs_unmount_info), 0))
2397 else if (errno == EROFS)
2399 else if (errno == EACCES || errno == EPERM)
2400 return WIMLIB_ERR_NOT_PERMITTED_TO_UNMOUNT;
2402 return WIMLIB_ERR_NOT_A_MOUNTPOINT;
2406 do_unmount_discard(const char *dir)
2409 struct wimfs_unmount_info unmount_info;
2411 memset(&unmount_info, 0, sizeof(unmount_info));
2413 ret = set_unmount_info(dir, &unmount_info);
2416 return do_unmount(dir);
2419 /* Unmount a read-write mounted WIM image, committing the changes. */
2421 do_unmount_commit(const char *dir, int unmount_flags,
2422 wimlib_progress_func_t progfunc, void *progctx)
2424 struct wimfs_unmount_info unmount_info;
2426 struct commit_progress_thread_args args;
2427 pthread_t commit_progress_tid;
2430 memset(&unmount_info, 0, sizeof(unmount_info));
2431 unmount_info.unmount_flags = unmount_flags;
2433 /* The current thread will be stuck in getxattr() until the image is
2434 * committed. Create a thread to handle the progress messages. */
2436 generate_message_queue_name(unmount_info.mq_name);
2438 mq = create_message_queue(unmount_info.mq_name);
2439 if (mq == (mqd_t)-1) {
2440 ERROR_WITH_ERRNO("Can't create POSIX message queue");
2441 return WIMLIB_ERR_MQUEUE;
2444 args.progfunc = progfunc;
2445 args.progctx = progctx;
2446 ret = pthread_create(&commit_progress_tid, NULL,
2447 commit_progress_thread_proc, &args);
2450 ERROR_WITH_ERRNO("Can't create thread");
2451 ret = WIMLIB_ERR_NOMEM;
2454 unmount_info.unmount_flags |= WIMLIB_UNMOUNT_FLAG_SEND_PROGRESS;
2457 ret = set_unmount_info(dir, &unmount_info);
2459 ret = do_unmount(dir);
2461 /* Terminate the progress thread. */
2463 mq_send(mq, empty, 0, 1);
2464 pthread_join(commit_progress_tid, NULL);
2469 mq_unlink(unmount_info.mq_name);
2475 begin_unmount(const char *dir, int unmount_flags, int *mount_flags_ret,
2476 wimlib_progress_func_t progfunc, void *progctx)
2480 int wim_filename_len;
2481 union wimlib_progress_info progress;
2483 if (getxattr(dir, "wimfs.mount_flags",
2484 &mount_flags, sizeof(int)) != sizeof(int))
2485 return WIMLIB_ERR_NOT_A_MOUNTPOINT;
2487 *mount_flags_ret = mount_flags;
2492 if (getxattr(dir, "wimfs.mounted_image",
2493 &mounted_image, sizeof(int)) != sizeof(int))
2494 return WIMLIB_ERR_NOT_A_MOUNTPOINT;
2496 wim_filename_len = getxattr(dir, "wimfs.wim_filename", NULL, 0);
2497 if (wim_filename_len < 0)
2498 return WIMLIB_ERR_NOT_A_MOUNTPOINT;
2500 char wim_filename[wim_filename_len + 1];
2501 if (getxattr(dir, "wimfs.wim_filename",
2502 wim_filename, wim_filename_len) != wim_filename_len)
2503 return WIMLIB_ERR_NOT_A_MOUNTPOINT;
2504 wim_filename[wim_filename_len] = '\0';
2506 progress.unmount.mountpoint = dir;
2507 progress.unmount.mounted_wim = wim_filename;
2508 progress.unmount.mounted_image = mounted_image;
2509 progress.unmount.mount_flags = mount_flags;
2510 progress.unmount.unmount_flags = unmount_flags;
2512 return call_progress(progfunc, WIMLIB_PROGRESS_MSG_UNMOUNT_BEGIN,
2513 &progress, progctx);
2516 /* API function documented in wimlib.h */
2518 wimlib_unmount_image_with_progress(const char *dir, int unmount_flags,
2519 wimlib_progress_func_t progfunc, void *progctx)
2524 ret = wimlib_global_init(WIMLIB_INIT_FLAG_ASSUME_UTF8);
2528 if (unmount_flags & ~(WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY |
2529 WIMLIB_UNMOUNT_FLAG_COMMIT |
2530 WIMLIB_UNMOUNT_FLAG_REBUILD |
2531 WIMLIB_UNMOUNT_FLAG_RECOMPRESS |
2532 WIMLIB_UNMOUNT_FLAG_FORCE |
2533 WIMLIB_UNMOUNT_FLAG_NEW_IMAGE))
2534 return WIMLIB_ERR_INVALID_PARAM;
2536 ret = begin_unmount(dir, unmount_flags, &mount_flags,
2541 if ((unmount_flags & WIMLIB_UNMOUNT_FLAG_COMMIT) &&
2542 (mount_flags & WIMLIB_MOUNT_FLAG_READWRITE))
2543 return do_unmount_commit(dir, unmount_flags,
2546 return do_unmount_discard(dir);
2549 #else /* WITH_FUSE */
2553 mount_unsupported_error(void)
2555 #if defined(__WIN32__)
2556 ERROR("Sorry-- Mounting WIM images is not supported on Windows!");
2558 ERROR("wimlib was compiled with --without-fuse, which disables support "
2559 "for mounting WIMs.");
2561 return WIMLIB_ERR_UNSUPPORTED;
2565 wimlib_unmount_image_with_progress(const tchar *dir, int unmount_flags,
2566 wimlib_progress_func_t progfunc, void *progctx)
2568 return mount_unsupported_error();
2572 wimlib_mount_image(WIMStruct *wim, int image, const tchar *dir,
2573 int mount_flags, const tchar *staging_dir)
2575 return mount_unsupported_error();
2578 #endif /* !WITH_FUSE */
2581 wimlib_unmount_image(const tchar *dir, int unmount_flags)
2583 return wimlib_unmount_image_with_progress(dir, unmount_flags, NULL, NULL);