4 * This file implements mounting of WIM files using FUSE, which stands for
5 * Filesystem in Userspace. FUSE allows a filesystem to be implemented in a
6 * userspace process by implementing the filesystem primitives--- read(),
7 * write(), readdir(), etc.
11 * Copyright (C) 2012, 2013, 2014 Eric Biggers
13 * This file is part of wimlib, a library for working with WIM files.
15 * wimlib is free software; you can redistribute it and/or modify it under the
16 * terms of the GNU General Public License as published by the Free
17 * Software Foundation; either version 3 of the License, or (at your option)
20 * wimlib is distributed in the hope that it will be useful, but WITHOUT ANY
21 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
22 * A PARTICULAR PURPOSE. See the GNU General Public License for more
25 * You should have received a copy of the GNU General Public License
26 * along with wimlib; if not, see http://www.gnu.org/licenses/.
34 #include "wimlib/error.h"
39 # error "FUSE mount not supported on Windows! Please configure --without-fuse"
42 #include "wimlib/dentry.h"
43 #include "wimlib/encoding.h"
44 #include "wimlib/metadata.h"
45 #include "wimlib/paths.h"
46 #include "wimlib/progress.h"
47 #include "wimlib/reparse.h"
48 #include "wimlib/timestamp.h"
49 #include "wimlib/unix_data.h"
50 #include "wimlib/write.h"
51 #include "wimlib/xml.h"
62 #include <sys/types.h>
66 #define FUSE_USE_VERSION 26
68 #include <attr/xattr.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 lookup table entry for the data stream that has been
102 * opened. 'num_opened_fds' of the lookup table entry tracks the number
103 * of 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 lookup table entry. */
106 struct wim_lookup_table_entry *f_lte;
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 alternate data streams are changed
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 /* Information about the staging directory for a read-write mount. */
151 char *staging_dir_name;
153 /* For read-write mounts, the inode number to be assigned to the next
154 * created file. Note: since this isn't a persistent filesystem and we
155 * can re-assign the inode numbers just before mounting the image, it's
156 * good enough to just generate inode numbers sequentially. */
159 /* Number of file descriptors open to the mounted WIM image. */
160 unsigned long num_open_fds;
162 /* Original list of single-instance streams in the mounted image, linked
163 * by 'struct wim_lookup_table_entry'.orig_stream_list. */
164 struct list_head orig_stream_list;
166 /* Parameters for unmounting the image (can be set via extended
167 * attribute "wimfs.unmount_info"). */
168 struct wimfs_unmount_info unmount_info;
171 #define WIMFS_CTX(fuse_ctx) ((struct wimfs_context*)(fuse_ctx)->private_data)
173 /* Retrieve the context structure for the currently mounted WIM image.
175 * Note: this is a per-thread variable. It is possible for different threads to
176 * mount different images at the same time in the same process, although they
177 * must use different WIMStructs! */
178 static inline struct wimfs_context *
179 wimfs_get_context(void)
181 return WIMFS_CTX(fuse_get_context());
185 wimfs_inc_num_open_fds(void)
187 wimfs_get_context()->num_open_fds++;
191 wimfs_dec_num_open_fds(void)
193 wimfs_get_context()->num_open_fds--;
196 /* Retrieve the WIMStruct for the currently mounted WIM image. */
197 static inline WIMStruct *
198 wimfs_get_WIMStruct(void)
200 return wimfs_get_context()->wim;
203 /* Is write permission requested on the file? */
205 flags_writable(int open_flags)
207 int accmode = (open_flags & O_ACCMODE);
208 return (accmode == O_RDWR || accmode == O_WRONLY);
212 fuse_mask_mode(mode_t mode, const struct fuse_context *fuse_ctx)
214 #if FUSE_MAJOR_VERSION > 2 || (FUSE_MAJOR_VERSION == 2 && FUSE_MINOR_VERSION >= 8)
215 mode &= ~fuse_ctx->umask;
221 * Allocate a file descriptor to a data stream in the mounted WIM image.
224 * A pointer to the inode containing the stream being opened.
226 * The ID of the data stream being opened within the inode.
228 * A pointer to the lookup table entry for the stream data. Or, for a
229 * 0-byte stream, this may be NULL.
231 * On success, a pointer to the new file descriptor will be stored here.
233 * Returns 0 or a -errno code.
236 alloc_wimfs_fd(struct wim_inode *inode,
238 struct wim_lookup_table_entry *lte,
239 struct wimfs_fd **fd_ret)
241 static const u16 min_fds_per_alloc = 8;
242 static const u16 max_fds = 0xffff;
246 if (inode->i_num_opened_fds == inode->i_num_allocated_fds) {
248 struct wimfs_fd **fds;
250 /* Expand this inode's file descriptor table. */
252 num_new_fds = max(min_fds_per_alloc,
253 inode->i_num_allocated_fds / 4);
255 num_new_fds = min(num_new_fds,
256 max_fds - inode->i_num_allocated_fds);
258 if (num_new_fds == 0)
261 fds = REALLOC(inode->i_fds,
262 (inode->i_num_allocated_fds + num_new_fds) *
267 memset(&fds[inode->i_num_allocated_fds], 0,
268 num_new_fds * sizeof(fds[0]));
270 inode->i_num_allocated_fds += num_new_fds;
271 inode->i_next_fd = inode->i_num_opened_fds;
274 /* Allocate the file descriptor in the first available space in the
275 * inode's file descriptor table.
277 * i_next_fd is the lower bound on the next open slot. */
278 for (i = inode->i_next_fd; inode->i_fds[i]; i++)
281 fd = MALLOC(sizeof(*fd));
287 filedes_invalidate(&fd->f_staging_fd);
289 fd->f_stream_id = stream_id;
291 inode->i_fds[i] = fd;
292 inode->i_num_opened_fds++;
294 lte->num_opened_fds++;
295 wimfs_inc_num_open_fds();
296 inode->i_next_fd = i + 1;
301 * Close a file descriptor to a data stream in the mounted WIM image.
303 * Returns 0 or a -errno code. The file descriptor is always closed.
306 close_wimfs_fd(struct wimfs_fd *fd)
309 struct wim_inode *inode;
311 /* Close the staging file if open. */
312 if (filedes_valid(&fd->f_staging_fd))
313 if (filedes_close(&fd->f_staging_fd))
316 /* Release this file descriptor from its lookup table entry. */
318 lte_decrement_num_opened_fds(fd->f_lte);
320 wimfs_dec_num_open_fds();
322 /* Release this file descriptor from its inode. */
324 inode->i_fds[fd->f_idx] = NULL;
325 if (fd->f_idx < inode->i_next_fd)
326 inode->i_next_fd = fd->f_idx;
328 if (--inode->i_num_opened_fds == 0) {
329 /* The last file descriptor to this inode was closed. */
332 inode->i_num_allocated_fds = 0;
333 if (inode->i_nlink == 0)
334 /* No links to this inode remain. Get rid of it. */
341 * Translate a path into the corresponding inode in the mounted WIM image.
343 * See get_dentry() for more information.
345 * Returns a pointer to the resulting inode, or NULL with errno set.
347 static struct wim_inode *
348 wim_pathname_to_inode(WIMStruct *wim, const char *path)
350 struct wim_dentry *dentry;
352 dentry = get_dentry(wim, path, WIMLIB_CASE_SENSITIVE);
355 return dentry->d_inode;
358 /* Can look up named data stream with colon syntax */
359 #define LOOKUP_FLAG_ADS_OK 0x01
361 /* Can look up directory (otherwise get -ENOTDIR) */
362 #define LOOKUP_FLAG_DIRECTORY_OK 0x02
365 * Translate a path into the corresponding dentry, lookup table entry, and
366 * stream index in the mounted WIM image.
368 * Returns 0 or a -errno code. All of @dentry_ret, @lte_ret, and
369 * @stream_idx_ret are optional.
372 wim_pathname_to_stream(const struct wimfs_context *ctx, const char *path,
374 struct wim_dentry **dentry_ret,
375 struct wim_lookup_table_entry **lte_ret,
378 WIMStruct *wim = ctx->wim;
379 struct wim_dentry *dentry;
380 struct wim_lookup_table_entry *lte;
382 const char *stream_name = NULL;
383 struct wim_inode *inode;
386 lookup_flags |= ctx->default_lookup_flags;
388 if (lookup_flags & LOOKUP_FLAG_ADS_OK) {
389 stream_name = path_stream_name(path);
391 p = (char *)stream_name - 1;
396 dentry = get_dentry(wim, path, WIMLIB_CASE_SENSITIVE);
402 inode = dentry->d_inode;
404 if (!inode->i_resolved)
405 if (inode_resolve_streams(inode, wim->lookup_table, false))
408 if (!(lookup_flags & LOOKUP_FLAG_DIRECTORY_OK)
409 && inode_is_directory(inode))
413 struct wim_ads_entry *ads_entry;
415 ads_entry = inode_get_ads_entry(inode, stream_name);
419 stream_idx = ads_entry - inode->i_ads_entries + 1;
420 lte = ads_entry->lte;
422 lte = inode_unnamed_stream_resolved(inode, &stream_idx);
425 *dentry_ret = dentry;
429 *stream_idx_ret = stream_idx;
434 * Create a new file in the mounted WIM image.
437 * The FUSE context for the mounted image.
439 * The path at which to create the first link to the new file. If a file
440 * already exists at this path, -EEXIST is returned.
442 * The UNIX mode for the new file. This is only honored if
443 * WIMLIB_MOUNT_FLAG_UNIX_DATA was passed to wimlib_mount_image().
445 * The device ID for the new file, encoding the major and minor device
446 * numbers. This is only honored if WIMLIB_MOUNT_FLAG_UNIX_DATA was passed
447 * to wimlib_mount_image().
449 * Windows file attributes to use for the new file.
451 * On success, a pointer to the new dentry is returned here. Its d_inode
452 * member will point to the new inode that was created for it and added to
453 * the mounted WIM image.
455 * Returns 0 or a -errno code.
458 create_dentry(struct fuse_context *fuse_ctx, const char *path,
459 mode_t mode, dev_t rdev, u32 attributes,
460 struct wim_dentry **dentry_ret)
462 struct wimfs_context *wimfs_ctx = WIMFS_CTX(fuse_ctx);
463 struct wim_dentry *parent;
464 const char *basename;
465 struct wim_dentry *new_dentry;
466 struct wim_inode *new_inode;
468 parent = get_parent_dentry(wimfs_ctx->wim, path, WIMLIB_CASE_SENSITIVE);
472 if (!dentry_is_directory(parent))
475 basename = path_basename(path);
477 if (get_dentry_child_with_name(parent, basename, WIMLIB_CASE_SENSITIVE))
480 if (new_dentry_with_inode(basename, &new_dentry))
483 new_inode = new_dentry->d_inode;
485 new_inode->i_resolved = 1;
486 new_inode->i_ino = wimfs_ctx->next_ino++;
487 new_inode->i_attributes = attributes;
489 if (wimfs_ctx->mount_flags & WIMLIB_MOUNT_FLAG_UNIX_DATA) {
490 struct wimlib_unix_data unix_data;
492 unix_data.uid = fuse_ctx->uid;
493 unix_data.gid = fuse_ctx->gid;
494 unix_data.mode = fuse_mask_mode(mode, fuse_ctx);
495 unix_data.rdev = rdev;
496 if (!inode_set_unix_data(new_inode, &unix_data, UNIX_DATA_ALL))
498 free_dentry(new_dentry);
503 list_add_tail(&new_inode->i_list,
504 &wim_get_current_image_metadata(wimfs_ctx->wim)->inode_list);
506 dentry_add_child(parent, new_dentry);
509 *dentry_ret = new_dentry;
514 * Remove a dentry from the mounted WIM image; i.e. remove an alias for an
518 remove_dentry(struct wim_dentry *dentry,
519 struct wim_lookup_table *lookup_table)
521 /* Drop the reference to each stream the inode contains. */
522 inode_unref_streams(dentry->d_inode, lookup_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 * Retrieve standard UNIX metadata ('struct stat') for a WIM inode.
555 * @lte specifies the stream of the inode that is being queried. We mostly
556 * return the same information for all streams, but st_size and st_blocks may be
557 * different for different streams.
559 * This always returns 0.
562 inode_to_stbuf(const struct wim_inode *inode,
563 const struct wim_lookup_table_entry *lte,
566 const struct wimfs_context *ctx = wimfs_get_context();
567 struct wimlib_unix_data unix_data;
569 memset(stbuf, 0, sizeof(struct stat));
570 if ((ctx->mount_flags & WIMLIB_MOUNT_FLAG_UNIX_DATA) &&
571 inode_get_unix_data(inode, &unix_data))
573 /* Use the user ID, group ID, mode, and device ID from the
574 * inode's extra UNIX metadata information. */
575 stbuf->st_uid = unix_data.uid;
576 stbuf->st_gid = unix_data.gid;
577 stbuf->st_mode = unix_data.mode;
578 stbuf->st_rdev = unix_data.rdev;
580 /* Generate default values for the user ID, group ID, and mode.
582 * Note: in the case of an allow_other mount, fuse_context.uid
583 * may not be the same as wimfs_context.owner_uid! */
584 stbuf->st_uid = ctx->owner_uid;
585 stbuf->st_gid = ctx->owner_gid;
586 stbuf->st_mode = inode_default_unix_mode(inode);
588 stbuf->st_ino = inode->i_ino;
589 stbuf->st_nlink = inode->i_nlink;
591 stbuf->st_size = lte->size;
592 #ifdef HAVE_STAT_NANOSECOND_PRECISION
593 stbuf->st_atim = wim_timestamp_to_timespec(inode->i_last_access_time);
594 stbuf->st_mtim = wim_timestamp_to_timespec(inode->i_last_write_time);
595 stbuf->st_ctim = stbuf->st_mtim;
597 stbuf->st_atime = wim_timestamp_to_unix(inode->i_last_access_time);
598 stbuf->st_mtime = wim_timestamp_to_unix(inode->i_last_write_time);
599 stbuf->st_ctime = stbuf->st_mtime;
601 stbuf->st_blocks = (stbuf->st_size + 511) / 512;
605 /* Update the last access and last write timestamps of a WIM inode. */
607 touch_inode(struct wim_inode *inode)
609 u64 now = get_wim_timestamp();
610 inode->i_last_access_time = now;
611 inode->i_last_write_time = now;
615 touch_parent(struct wim_dentry *dentry)
617 touch_inode(dentry->d_parent->d_inode);
621 * Create a new file in the staging directory for a read-write mounted image.
623 * On success, returns the file descriptor for the new staging file, opened for
624 * writing. In addition, stores the allocated name of the staging file in
627 * On failure, returns -1 and sets errno.
630 create_staging_file(const struct wimfs_context *ctx, char **name_ret)
633 static const size_t STAGING_FILE_NAME_LEN = 20;
637 name = MALLOC(STAGING_FILE_NAME_LEN + 1);
640 name[STAGING_FILE_NAME_LEN] = '\0';
643 randomize_char_array_with_alnum(name, STAGING_FILE_NAME_LEN);
644 fd = openat(ctx->staging_dir_fd, name,
645 O_WRONLY | O_CREAT | O_EXCL | O_NOFOLLOW, 0600);
646 if (unlikely(fd < 0)) {
647 if (unlikely(errno == EEXIST))
648 /* Try again with another name. */
658 * Extract a WIM resource to the staging directory.
659 * This is necessary if a stream using the resource is being opened for writing.
662 * The inode containing the stream being opened for writing.
665 * The index of the stream in @inode being opened for writing.
668 * *lte_ptr is the lookup table entry for the stream being extracted, or
669 * NULL if the stream does not have a lookup table entry (which is possible
670 * if the stream is empty). On success, *lte_ptr will be set to point to a
671 * lookup table entry that represents the resource in its new location in a
672 * staging file. This may be the same as the old entry in the case that it
673 * was reused, or it may be a new entry.
676 * Number of bytes of the stream to extract and include in the staging file
677 * resource. It may be less than the actual stream length, in which case
678 * only a prefix of the resource will be extracted. It may also be more
679 * than the actual stream length, in which case the extra space will be
682 * Returns 0 or a -errno code.
685 extract_resource_to_staging_dir(struct wim_inode *inode,
687 struct wim_lookup_table_entry **lte_ptr,
689 const struct wimfs_context *ctx)
691 struct wim_lookup_table_entry *old_lte;
692 struct wim_lookup_table_entry *new_lte;
693 char *staging_file_name;
702 /* Create the staging file. */
703 staging_fd = create_staging_file(ctx, &staging_file_name);
704 if (unlikely(staging_fd < 0))
707 /* Extract the stream to the staging file (possibly truncated). */
711 filedes_init(&fd, staging_fd);
713 extract_size = min(old_lte->size, size);
714 result = extract_stream_to_fd(old_lte, &fd, extract_size);
720 /* In the case of truncate() to more than the file length, extend the
721 * staging file with zeroes by calling ftruncate(). */
722 if (!result && size > extract_size)
723 result = ftruncate(staging_fd, size);
725 /* Close the staging file. */
726 if (close(staging_fd))
729 /* If an error occurred, unlink the staging file. */
730 if (unlikely(result)) {
731 /* extract_stream_to_fd() should set errno, but if it didn't,
732 * set a default value. */
733 ret = errno ? -errno : -EIO;
734 goto out_delete_staging_file;
737 /* Now deal with the lookup table entries. We may be able to re-use the
738 * existing entry, but we may have to create a new one instead. */
740 stream_id = inode_stream_idx_to_id(inode, stream_idx);
742 if (old_lte && inode->i_nlink == old_lte->refcnt) {
743 /* The reference count of the existing lookup table entry is the
744 * same as the link count of the inode that contains the stream
745 * we're opening. Therefore, all the references to the lookup
746 * table entry correspond to the stream we're trying to extract,
747 * so the lookup table entry can be re-used. */
748 lookup_table_unlink(ctx->wim->lookup_table, old_lte);
749 lte_put_resource(old_lte);
752 /* We need to split the old lookup table entry because it also
753 * has other references. Or, there was no old lookup table
754 * entry, so we need to create a new one anyway. */
756 new_lte = new_lookup_table_entry();
757 if (unlikely(!new_lte)) {
759 goto out_delete_staging_file;
762 /* There may already be open file descriptors to this stream if
763 * it's previously been opened read-only, but just now we're
764 * opening it read-write. Identify those file descriptors and
765 * change their lookup table entry pointers to point to the new
766 * lookup table entry, and open staging file descriptors for
769 * At the same time, we need to count the number of these opened
770 * file descriptors to the new lookup table entry. If there's
771 * an old lookup table entry, this number needs to be subtracted
772 * from the fd's opened to the old entry. */
773 for (u16 i = 0, j = 0; j < inode->i_num_opened_fds; i++) {
777 fd = inode->i_fds[i];
783 if (fd->f_stream_id != stream_id)
786 /* This is a readonly fd for the same stream. */
788 new_lte->num_opened_fds++;
789 raw_fd = openat(ctx->staging_dir_fd, staging_file_name,
790 O_RDONLY | O_NOFOLLOW);
791 if (unlikely(raw_fd < 0)) {
793 goto out_revert_fd_changes;
795 filedes_init(&fd->f_staging_fd, raw_fd);
798 old_lte->num_opened_fds -= new_lte->num_opened_fds;
799 old_lte->refcnt -= inode->i_nlink;
803 new_lte->refcnt = inode->i_nlink;
804 new_lte->resource_location = RESOURCE_IN_STAGING_FILE;
805 new_lte->staging_file_name = staging_file_name;
806 new_lte->staging_dir_fd = ctx->staging_dir_fd;
807 new_lte->size = size;
809 add_unhashed_stream(new_lte, inode, stream_id,
810 &wim_get_current_image_metadata(ctx->wim)->unhashed_streams);
812 inode->i_lte = new_lte;
814 inode->i_ads_entries[stream_idx - 1].lte = new_lte;
818 out_revert_fd_changes:
819 for (u16 i = 0; new_lte->num_opened_fds; i++) {
820 struct wimfs_fd *fd = inode->i_fds[i];
821 if (fd && fd->f_stream_id == stream_id) {
823 if (filedes_valid(&fd->f_staging_fd)) {
824 filedes_close(&fd->f_staging_fd);
825 filedes_invalidate(&fd->f_staging_fd);
827 new_lte->num_opened_fds--;
830 free_lookup_table_entry(new_lte);
831 out_delete_staging_file:
832 unlinkat(ctx->staging_dir_fd, staging_file_name, 0);
833 FREE(staging_file_name);
838 * Create the staging directory for the WIM file.
840 * The staging directory will be created in the directory specified by the open
841 * file descriptor @parent_dir_fd. It will be given a randomly generated name
842 * based on @wim_basename, the name of the WIM file.
844 * On success, returns a file descriptor to the open staging directory with
845 * O_RDONLY access. In addition, stores the allocated name of the staging
846 * directory (relative to @parent_dir_fd) in @staging_dir_name_ret.
847 * On failure, returns -1 and sets errno.
850 make_staging_dir_at(int parent_dir_fd, const char *wim_basename,
851 char **staging_dir_name_ret)
853 static const char common_suffix[8] = ".staging";
854 static const size_t random_suffix_len = 10;
855 size_t wim_basename_len;
856 size_t staging_dir_name_len;
857 char *staging_dir_name;
861 wim_basename_len = strlen(wim_basename);
862 staging_dir_name_len = wim_basename_len + sizeof(common_suffix) +
864 staging_dir_name = MALLOC(staging_dir_name_len + 1);
865 if (!staging_dir_name)
868 p = staging_dir_name;
869 p = mempcpy(p, wim_basename, wim_basename_len);
870 p = mempcpy(p, common_suffix, sizeof(common_suffix));
871 randomize_char_array_with_alnum(p, random_suffix_len);
872 p += random_suffix_len;
875 if (mkdirat(parent_dir_fd, staging_dir_name, 0700))
878 fd = openat(parent_dir_fd, staging_dir_name,
879 O_RDONLY | O_DIRECTORY | O_NOFOLLOW);
883 *staging_dir_name_ret = staging_dir_name;
887 unlinkat(parent_dir_fd, staging_dir_name, AT_REMOVEDIR);
889 FREE(staging_dir_name);
894 * Create the staging directory and set ctx->staging_dir_fd,
895 * ctx->staging_dir_name, and ctx->parent_dir_fd.
898 make_staging_dir(struct wimfs_context *ctx, const char *parent_dir_path)
900 const char *wim_basename;
904 wim_basename = path_basename(ctx->wim->filename);
906 if (!parent_dir_path) {
907 /* The user did not specify a directory. Default to creating
908 * the staging directory alongside the WIM file. */
909 if (wim_basename > ctx->wim->filename) {
910 parent_dir_path = ctx->wim->filename;
911 end = (char *)(wim_basename - 1);
912 /* *end must be a slash. Temporarily overwrite it so we
913 * can open the parent directory. */
916 parent_dir_path = ".";
920 /* Open the parent directory (in which we'll create our staging
922 ctx->parent_dir_fd = open(parent_dir_path, O_RDONLY | O_DIRECTORY);
923 if (ctx->parent_dir_fd < 0) {
924 ERROR_WITH_ERRNO("Can't open directory \"%s\"",
926 ret = WIMLIB_ERR_OPENDIR;
927 goto out_restore_wim_filename;
930 ctx->staging_dir_fd = make_staging_dir_at(ctx->parent_dir_fd,
932 &ctx->staging_dir_name);
933 if (ctx->staging_dir_fd < 0) {
934 ERROR_WITH_ERRNO("Can't create staging directory in \"%s\"",
936 close(ctx->parent_dir_fd);
937 ret = WIMLIB_ERR_MKDIR;
938 goto out_restore_wim_filename;
941 out_restore_wim_filename:
947 /* Deletes the staging directory, undoing the effects of a succesful call to
948 * make_staging_dir(). */
950 delete_staging_dir(struct wimfs_context *ctx)
955 dir = fdopendir(ctx->staging_dir_fd);
957 while ((ent = readdir(dir)))
958 unlinkat(ctx->staging_dir_fd, ent->d_name, 0);
961 close(ctx->staging_dir_fd);
963 if (unlinkat(ctx->parent_dir_fd, ctx->staging_dir_name, AT_REMOVEDIR))
964 WARNING_WITH_ERRNO("Could not delete staging directory");
965 FREE(ctx->staging_dir_name);
966 close(ctx->parent_dir_fd);
970 reassign_inode_numbers(struct wimfs_context *ctx)
972 struct wim_image_metadata *imd;
973 struct wim_inode *inode;
976 imd = wim_get_current_image_metadata(ctx->wim);
977 image_for_each_inode(inode, imd)
978 inode->i_ino = ctx->next_ino++;
982 release_extra_refcnts(struct wimfs_context *ctx)
984 struct list_head *list = &ctx->orig_stream_list;
985 struct wim_lookup_table *lookup_table = ctx->wim->lookup_table;
986 struct wim_lookup_table_entry *lte, *tmp;
988 list_for_each_entry_safe(lte, tmp, list, orig_stream_list) {
989 u32 n = lte->out_refcnt;
991 lte_decrement_refcnt(lte, lookup_table);
996 delete_empty_streams(struct wimfs_context *ctx)
998 struct wim_lookup_table_entry *lte, *tmp;
999 struct wim_image_metadata *imd;
1001 imd = wim_get_current_image_metadata(ctx->wim);
1003 image_for_each_unhashed_stream_safe(lte, tmp, imd) {
1005 *retrieve_lte_pointer(lte) = NULL;
1006 list_del(<e->unhashed_list);
1007 free_lookup_table_entry(lte);
1013 inode_close_fds(struct wim_inode *inode)
1015 u16 num_open_fds = inode->i_num_opened_fds;
1016 for (u16 i = 0; num_open_fds; i++) {
1017 if (inode->i_fds[i]) {
1018 close_wimfs_fd(inode->i_fds[i]);
1025 close_all_fds(struct wimfs_context *ctx)
1027 struct wim_inode *inode, *tmp;
1028 struct wim_image_metadata *imd;
1030 imd = wim_get_current_image_metadata(ctx->wim);
1032 list_for_each_entry_safe(inode, tmp, &imd->inode_list, i_list)
1033 inode_close_fds(inode);
1036 /* Moves the currently selected image, which may have been modified, to a new
1037 * index, and sets the original index to refer to a reset (unmodified) copy of
1040 renew_current_image(struct wimfs_context *ctx)
1042 WIMStruct *wim = ctx->wim;
1043 int idx = wim->current_image - 1;
1044 struct wim_image_metadata *imd = wim->image_metadata[idx];
1045 struct wim_image_metadata *replace_imd;
1046 struct wim_lookup_table_entry *new_lte;
1049 /* Create 'replace_imd' structure to use for the reset original,
1050 * unmodified image. */
1051 ret = WIMLIB_ERR_NOMEM;
1052 replace_imd = new_image_metadata();
1056 /* Create new stream reference for the modified image's metadata
1057 * resource, which doesn't exist yet. */
1058 ret = WIMLIB_ERR_NOMEM;
1059 new_lte = new_lookup_table_entry();
1061 goto err_put_replace_imd;
1062 new_lte->flags = WIM_RESHDR_FLAG_METADATA;
1063 new_lte->unhashed = 1;
1065 /* Make the image being moved available at a new index. Increments the
1066 * WIM's image count, but does not increment the reference count of the
1067 * 'struct image_metadata'. */
1068 ret = append_image_metadata(wim, imd);
1070 goto err_free_new_lte;
1072 ret = xml_add_image(wim, T(""));
1074 goto err_undo_append;
1076 replace_imd->metadata_lte = imd->metadata_lte;
1077 imd->metadata_lte = new_lte;
1078 wim->image_metadata[idx] = replace_imd;
1079 wim->current_image = wim->hdr.image_count;
1083 wim->hdr.image_count--;
1085 free_lookup_table_entry(new_lte);
1086 err_put_replace_imd:
1087 put_image_metadata(replace_imd, NULL);
1092 static enum wimlib_progress_status
1093 commit_progress_func(enum wimlib_progress_msg msg,
1094 union wimlib_progress_info *info, void *progctx)
1096 mqd_t mq = *(mqd_t *)progctx;
1097 struct commit_progress_report report;
1099 memset(&report, 0, sizeof(report));
1102 report.info = *info;
1103 mq_send(mq, (const char *)&report, sizeof(report), 1);
1104 return WIMLIB_PROGRESS_STATUS_CONTINUE;
1107 /* Commit the mounted image to the underlying WIM file. */
1109 commit_image(struct wimfs_context *ctx, int unmount_flags, mqd_t mq)
1113 if (unmount_flags & WIMLIB_UNMOUNT_FLAG_SEND_PROGRESS)
1114 wimlib_register_progress_function(ctx->wim,
1115 commit_progress_func, &mq);
1117 wimlib_register_progress_function(ctx->wim, NULL, NULL);
1119 if (unmount_flags & WIMLIB_UNMOUNT_FLAG_NEW_IMAGE) {
1120 int ret = renew_current_image(ctx);
1124 release_extra_refcnts(ctx);
1126 INIT_LIST_HEAD(&ctx->orig_stream_list);
1127 delete_empty_streams(ctx);
1128 xml_update_image_info(ctx->wim, ctx->wim->current_image);
1131 if (unmount_flags & WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY)
1132 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
1133 if (unmount_flags & WIMLIB_UNMOUNT_FLAG_REBUILD)
1134 write_flags |= WIMLIB_WRITE_FLAG_REBUILD;
1135 if (unmount_flags & WIMLIB_UNMOUNT_FLAG_RECOMPRESS)
1136 write_flags |= WIMLIB_WRITE_FLAG_RECOMPRESS;
1137 return wimlib_overwrite(ctx->wim, write_flags, 0);
1140 /* In the case of an allow_other mount, only the owner and root should be
1141 * allowed to unmount the filesystem. */
1143 may_unmount_wimfs(void)
1145 const struct fuse_context *fuse_ctx = fuse_get_context();
1146 const struct wimfs_context *wimfs_ctx = WIMFS_CTX(fuse_ctx);
1148 return (fuse_ctx->uid == wimfs_ctx->owner_uid ||
1149 fuse_ctx->uid == 0);
1155 struct fuse_context *fuse_ctx = fuse_get_context();
1156 struct wimfs_context *wimfs_ctx = WIMFS_CTX(fuse_ctx);
1157 const struct wimfs_unmount_info *info = &wimfs_ctx->unmount_info;
1158 int unmount_flags = info->unmount_flags;
1159 mqd_t mq = (mqd_t)-1;
1162 /* Ignore COMMIT if the image is mounted read-only. */
1163 if (!(wimfs_ctx->mount_flags & WIMLIB_MOUNT_FLAG_READWRITE))
1164 unmount_flags &= ~WIMLIB_UNMOUNT_FLAG_COMMIT;
1166 if (unmount_flags & WIMLIB_UNMOUNT_FLAG_SEND_PROGRESS) {
1167 mq = mq_open(info->mq_name, O_WRONLY | O_NONBLOCK);
1168 if (mq == (mqd_t)-1) {
1169 ret = WIMLIB_ERR_MQUEUE;
1174 if (wimfs_ctx->num_open_fds) {
1175 if ((unmount_flags & (WIMLIB_UNMOUNT_FLAG_COMMIT |
1176 WIMLIB_UNMOUNT_FLAG_FORCE))
1177 == WIMLIB_UNMOUNT_FLAG_COMMIT)
1179 ret = WIMLIB_ERR_MOUNTED_IMAGE_IS_BUSY;
1182 close_all_fds(wimfs_ctx);
1185 if (unmount_flags & WIMLIB_UNMOUNT_FLAG_COMMIT)
1186 ret = commit_image(wimfs_ctx, unmount_flags, mq);
1190 /* Leave the image mounted if commit failed, unless this is a
1191 * forced unmount. The user can retry without commit if they
1193 if (!ret || (unmount_flags & WIMLIB_UNMOUNT_FLAG_FORCE)) {
1194 unlock_wim_for_append(wimfs_ctx->wim);
1195 fuse_exit(fuse_ctx->fuse);
1197 if (mq != (mqd_t)-1)
1203 wimfs_chmod(const char *path, mode_t mask)
1205 const struct wimfs_context *ctx = wimfs_get_context();
1206 struct wim_inode *inode;
1207 struct wimlib_unix_data unix_data;
1209 if (!(ctx->mount_flags & WIMLIB_MOUNT_FLAG_UNIX_DATA))
1212 inode = wim_pathname_to_inode(ctx->wim, path);
1216 unix_data.uid = ctx->owner_uid;
1217 unix_data.gid = ctx->owner_gid;
1218 unix_data.mode = mask;
1221 if (!inode_set_unix_data(inode, &unix_data, UNIX_DATA_MODE))
1228 wimfs_chown(const char *path, uid_t uid, gid_t gid)
1230 const struct wimfs_context *ctx = wimfs_get_context();
1231 struct wim_inode *inode;
1232 struct wimlib_unix_data unix_data;
1235 if (!(ctx->mount_flags & WIMLIB_MOUNT_FLAG_UNIX_DATA))
1238 inode = wim_pathname_to_inode(ctx->wim, path);
1244 if (uid != (uid_t)-1)
1245 which |= UNIX_DATA_UID;
1247 uid = ctx->owner_uid;
1249 if (gid != (gid_t)-1)
1250 which |= UNIX_DATA_GID;
1252 gid = ctx->owner_gid;
1254 unix_data.uid = uid;
1255 unix_data.gid = gid;
1256 unix_data.mode = inode_default_unix_mode(inode);
1259 if (!inode_set_unix_data(inode, &unix_data, which))
1266 wimfs_fgetattr(const char *path, struct stat *stbuf, struct fuse_file_info *fi)
1268 struct wimfs_fd *fd = WIMFS_FD(fi);
1269 return inode_to_stbuf(fd->f_inode, fd->f_lte, stbuf);
1273 wimfs_ftruncate(const char *path, off_t size, struct fuse_file_info *fi)
1275 struct wimfs_fd *fd = WIMFS_FD(fi);
1276 if (ftruncate(fd->f_staging_fd.fd, size))
1278 touch_inode(fd->f_inode);
1279 fd->f_lte->size = size;
1284 wimfs_getattr(const char *path, struct stat *stbuf)
1286 const struct wimfs_context *ctx = wimfs_get_context();
1287 struct wim_dentry *dentry;
1288 struct wim_lookup_table_entry *lte;
1291 ret = wim_pathname_to_stream(ctx, path, LOOKUP_FLAG_DIRECTORY_OK,
1292 &dentry, <e, NULL);
1295 return inode_to_stbuf(dentry->d_inode, lte, stbuf);
1299 copy_xattr(char *dest, size_t destsize, const void *src, size_t srcsize)
1303 if (destsize < srcsize)
1305 memcpy(dest, src, srcsize);
1310 wimfs_getxattr(const char *path, const char *name, char *value,
1313 const struct wimfs_context *ctx = wimfs_get_context();
1314 struct wim_inode *inode;
1315 struct wim_ads_entry *ads_entry;
1316 struct wim_lookup_table_entry *lte;
1318 if (!strncmp(name, "wimfs.", 6)) {
1319 /* Handle some magical extended attributes. These really should
1320 * be ioctls, but directory ioctls aren't supported until
1321 * libfuse 2.9, and even then they are broken. */
1323 if (!strcmp(name, "wim_filename")) {
1324 return copy_xattr(value, size, ctx->wim->filename,
1325 strlen(ctx->wim->filename));
1327 if (!strcmp(name, "wim_info")) {
1328 struct wimlib_wim_info info;
1330 wimlib_get_wim_info(ctx->wim, &info);
1332 return copy_xattr(value, size, &info, sizeof(info));
1334 if (!strcmp(name, "mounted_image")) {
1335 return copy_xattr(value, size,
1336 &ctx->wim->current_image, sizeof(int));
1338 if (!strcmp(name, "mount_flags")) {
1339 return copy_xattr(value, size,
1340 &ctx->mount_flags, sizeof(int));
1342 if (!strcmp(name, "unmount")) {
1343 if (!may_unmount_wimfs())
1348 if (size < sizeof(int))
1350 status = unmount_wimfs();
1351 memcpy(value, &status, sizeof(int));
1358 if (!(ctx->mount_flags & WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR))
1361 if (strncmp(name, "user.", 5))
1365 /* Querying a named data stream */
1367 inode = wim_pathname_to_inode(ctx->wim, path);
1371 ads_entry = inode_get_ads_entry(inode, name);
1373 return (errno == ENOENT) ? -ENOATTR : -errno;
1375 lte = ads_entry->lte;
1379 if (unlikely(lte->size > INT_MAX))
1383 if (lte->size > size)
1386 if (read_full_stream_into_buf(lte, value))
1393 wimfs_link(const char *existing_path, const char *new_path)
1395 WIMStruct *wim = wimfs_get_WIMStruct();
1396 const char *new_name;
1397 struct wim_inode *inode;
1398 struct wim_dentry *dir;
1399 struct wim_dentry *new_alias;
1401 inode = wim_pathname_to_inode(wim, existing_path);
1405 if (inode->i_attributes & (FILE_ATTRIBUTE_DIRECTORY |
1406 FILE_ATTRIBUTE_REPARSE_POINT))
1409 new_name = path_basename(new_path);
1411 dir = get_parent_dentry(wim, new_path, WIMLIB_CASE_SENSITIVE);
1415 if (!dentry_is_directory(dir))
1418 if (get_dentry_child_with_name(dir, new_name, WIMLIB_CASE_SENSITIVE))
1421 if (new_dentry(new_name, &new_alias))
1424 new_alias->d_inode = inode;
1425 inode_add_dentry(new_alias, inode);
1426 dentry_add_child(dir, new_alias);
1427 touch_inode(dir->d_inode);
1429 inode_ref_streams(inode);
1434 wimfs_listxattr(const char *path, char *list, size_t size)
1436 const struct wimfs_context *ctx = wimfs_get_context();
1437 const struct wim_inode *inode;
1439 char *end = list + size;
1442 if (!(ctx->mount_flags & WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR))
1445 /* List named data streams, or get the list size. We report each named
1446 * data stream "X" as an extended attribute "user.X". */
1448 inode = wim_pathname_to_inode(ctx->wim, path);
1452 for (u16 i = 0; i < inode->i_num_ads; i++) {
1453 const struct wim_ads_entry *entry;
1454 char *stream_name_mbs;
1455 size_t stream_name_mbs_nbytes;
1457 entry = &inode->i_ads_entries[i];
1459 if (!entry->stream_name_nbytes)
1462 if (utf16le_to_tstr(entry->stream_name,
1463 entry->stream_name_nbytes,
1465 &stream_name_mbs_nbytes))
1468 if (unlikely(INT_MAX - total_size < stream_name_mbs_nbytes + 6)) {
1469 FREE(stream_name_mbs);
1473 total_size += stream_name_mbs_nbytes + 6;
1475 if (end - p < stream_name_mbs_nbytes + 6) {
1476 FREE(stream_name_mbs);
1479 p = mempcpy(p, "user.", 5);
1480 p = mempcpy(p, stream_name_mbs, stream_name_mbs_nbytes);
1483 FREE(stream_name_mbs);
1489 wimfs_mkdir(const char *path, mode_t mode)
1491 struct wim_dentry *dentry;
1494 /* Note: according to fuse.h, mode may not include S_IFDIR */
1495 ret = create_dentry(fuse_get_context(), path, mode | S_IFDIR, 0,
1496 FILE_ATTRIBUTE_DIRECTORY, &dentry);
1499 touch_parent(dentry);
1504 wimfs_mknod(const char *path, mode_t mode, dev_t rdev)
1506 struct fuse_context *fuse_ctx = fuse_get_context();
1507 struct wimfs_context *wimfs_ctx = WIMFS_CTX(fuse_ctx);
1508 const char *stream_name;
1510 if ((wimfs_ctx->mount_flags & WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS)
1511 && (stream_name = path_stream_name(path)))
1513 struct wim_ads_entry *old_entry;
1514 struct wim_ads_entry *new_entry;
1515 struct wim_inode *inode;
1518 /* Create a named data stream. */
1523 p = (char *)stream_name - 1;
1526 inode = wim_pathname_to_inode(wimfs_ctx->wim, path);
1531 old_entry = inode_get_ads_entry(inode, stream_name);
1534 if (errno != ENOENT)
1537 new_entry = inode_add_ads(inode, stream_name);
1542 /* Create a regular file, device node, named pipe, or socket.
1544 struct wim_dentry *dentry;
1547 if (!S_ISREG(mode) &&
1548 !(wimfs_ctx->mount_flags & WIMLIB_MOUNT_FLAG_UNIX_DATA))
1551 /* Note: we still use FILE_ATTRIBUTE_NORMAL for device nodes,
1552 * named pipes, and sockets. The real mode is in the UNIX
1554 ret = create_dentry(fuse_ctx, path, mode, rdev,
1555 FILE_ATTRIBUTE_NORMAL, &dentry);
1558 touch_parent(dentry);
1564 wimfs_open(const char *path, struct fuse_file_info *fi)
1566 struct wimfs_context *ctx = wimfs_get_context();
1567 struct wim_dentry *dentry;
1568 struct wim_inode *inode;
1569 struct wim_lookup_table_entry *lte;
1571 struct wimfs_fd *fd;
1574 ret = wim_pathname_to_stream(ctx, path, 0, &dentry, <e, &stream_idx);
1578 inode = dentry->d_inode;
1580 /* The file resource may be in the staging directory (read-write mounts
1581 * only) or in the WIM. If it's in the staging directory, we need to
1582 * open a native file descriptor for the corresponding file. Otherwise,
1583 * we can read the file resource directly from the WIM file if we are
1584 * opening it read-only, but we need to extract the resource to the
1585 * staging directory if we are opening it writable. */
1587 if (flags_writable(fi->flags) &&
1588 (!lte || lte->resource_location != RESOURCE_IN_STAGING_FILE)) {
1589 ret = extract_resource_to_staging_dir(inode,
1592 lte ? lte->size : 0,
1598 ret = alloc_wimfs_fd(inode, inode_stream_idx_to_id(inode, stream_idx),
1603 if (lte && lte->resource_location == RESOURCE_IN_STAGING_FILE) {
1606 raw_fd = openat(lte->staging_dir_fd, lte->staging_file_name,
1607 (fi->flags & O_ACCMODE) | O_NOFOLLOW);
1612 filedes_init(&fd->f_staging_fd, raw_fd);
1614 fi->fh = (uintptr_t)fd;
1619 wimfs_opendir(const char *path, struct fuse_file_info *fi)
1621 WIMStruct *wim = wimfs_get_WIMStruct();
1622 struct wim_inode *inode;
1623 struct wimfs_fd *fd;
1626 inode = wim_pathname_to_inode(wim, path);
1629 if (!inode_is_directory(inode))
1631 ret = alloc_wimfs_fd(inode, 0, NULL, &fd);
1634 fi->fh = (uintptr_t)fd;
1639 wimfs_read(const char *path, char *buf, size_t size,
1640 off_t offset, struct fuse_file_info *fi)
1642 struct wimfs_fd *fd = WIMFS_FD(fi);
1643 const struct wim_lookup_table_entry *lte;
1650 if (offset >= lte->size)
1653 if (size > lte->size - offset)
1654 size = lte->size - offset;
1659 switch (lte->resource_location) {
1660 case RESOURCE_IN_WIM:
1661 if (read_partial_wim_stream_into_buf(lte, size, offset, buf))
1666 case RESOURCE_IN_STAGING_FILE:
1667 ret = raw_pread(&fd->f_staging_fd, buf, size, offset);
1671 case RESOURCE_IN_ATTACHED_BUFFER:
1672 memcpy(buf, lte->attached_buffer + offset, size);
1683 wimfs_readdir(const char *path, void *buf, fuse_fill_dir_t filler,
1684 off_t offset, struct fuse_file_info *fi)
1686 struct wimfs_fd *fd = WIMFS_FD(fi);
1687 const struct wim_inode *inode;
1688 const struct wim_dentry *child;
1691 inode = fd->f_inode;
1693 ret = filler(buf, ".", NULL, 0);
1696 ret = filler(buf, "..", NULL, 0);
1700 for_inode_child(child, inode) {
1701 char *file_name_mbs;
1702 size_t file_name_mbs_nbytes;
1704 ret = utf16le_to_tstr(child->file_name,
1705 child->file_name_nbytes,
1707 &file_name_mbs_nbytes);
1711 ret = filler(buf, file_name_mbs, NULL, 0);
1712 FREE(file_name_mbs);
1720 wimfs_readlink(const char *path, char *buf, size_t buf_len)
1722 WIMStruct *wim = wimfs_get_WIMStruct();
1723 const struct wim_inode *inode;
1726 inode = wim_pathname_to_inode(wim, path);
1729 if (!inode_is_symlink(inode))
1733 ret = wim_inode_readlink(inode, buf, buf_len - 1, NULL);
1737 } else if (ret == -ENAMETOOLONG) {
1738 buf[buf_len - 1] = '\0';
1743 /* We use this for both release() and releasedir(), since in both cases we
1744 * simply need to close the file descriptor. */
1746 wimfs_release(const char *path, struct fuse_file_info *fi)
1748 return close_wimfs_fd(WIMFS_FD(fi));
1752 wimfs_removexattr(const char *path, const char *name)
1754 struct wimfs_context *ctx = wimfs_get_context();
1755 struct wim_inode *inode;
1756 struct wim_ads_entry *ads_entry;
1758 if (!(ctx->mount_flags & WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR))
1761 if (strncmp(name, "user.", 5))
1765 /* Removing a named data stream. */
1767 inode = wim_pathname_to_inode(ctx->wim, path);
1771 ads_entry = inode_get_ads_entry(inode, name);
1773 return (errno == ENOENT) ? -ENOATTR : -errno;
1775 inode_remove_ads(inode, ads_entry, ctx->wim->lookup_table);
1780 wimfs_rename(const char *from, const char *to)
1782 return rename_wim_path(wimfs_get_WIMStruct(), from, to,
1783 WIMLIB_CASE_SENSITIVE, NULL);
1787 wimfs_rmdir(const char *path)
1789 WIMStruct *wim = wimfs_get_WIMStruct();
1790 struct wim_dentry *dentry;
1792 dentry = get_dentry(wim, path, WIMLIB_CASE_SENSITIVE);
1796 if (!dentry_is_directory(dentry))
1799 if (dentry_has_children(dentry))
1802 touch_parent(dentry);
1803 remove_dentry(dentry, wim->lookup_table);
1808 wimfs_setxattr(const char *path, const char *name,
1809 const char *value, size_t size, int flags)
1811 struct wimfs_context *ctx = wimfs_get_context();
1812 struct wim_inode *inode;
1813 struct wim_ads_entry *existing_entry;
1815 if (!strncmp(name, "wimfs.", 6)) {
1816 /* Handle some magical extended attributes. These really should
1817 * be ioctls, but directory ioctls aren't supported until
1818 * libfuse 2.9, and even then they are broken. */
1820 if (!strcmp(name, "unmount_info")) {
1821 if (!may_unmount_wimfs())
1823 if (size < sizeof(struct wimfs_unmount_info))
1825 memcpy(&ctx->unmount_info, value,
1826 sizeof(struct wimfs_unmount_info));
1832 if (!(ctx->mount_flags & WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR))
1835 if (strncmp(name, "user.", 5))
1839 /* Setting the contents of a named data stream. */
1841 inode = wim_pathname_to_inode(ctx->wim, path);
1845 existing_entry = inode_get_ads_entry(inode, name);
1846 if (existing_entry) {
1847 if (flags & XATTR_CREATE)
1850 if (errno != ENOENT)
1852 if (flags & XATTR_REPLACE)
1856 if (!inode_add_ads_with_data(inode, name, value,
1857 size, ctx->wim->lookup_table))
1860 inode_remove_ads(inode, existing_entry, ctx->wim->lookup_table);
1865 wimfs_symlink(const char *to, const char *from)
1867 struct fuse_context *fuse_ctx = fuse_get_context();
1868 struct wimfs_context *wimfs_ctx = WIMFS_CTX(fuse_ctx);
1869 struct wim_dentry *dentry;
1872 ret = create_dentry(fuse_ctx, from, S_IFLNK | 0777, 0,
1873 FILE_ATTRIBUTE_REPARSE_POINT, &dentry);
1876 dentry->d_inode->i_reparse_tag = WIM_IO_REPARSE_TAG_SYMLINK;
1877 ret = wim_inode_set_symlink(dentry->d_inode, to,
1878 wimfs_ctx->wim->lookup_table);
1880 remove_dentry(dentry, wimfs_ctx->wim->lookup_table);
1881 if (ret == WIMLIB_ERR_NOMEM)
1886 touch_parent(dentry);
1892 wimfs_truncate(const char *path, off_t size)
1894 const struct wimfs_context *ctx = wimfs_get_context();
1895 struct wim_dentry *dentry;
1896 struct wim_lookup_table_entry *lte;
1901 ret = wim_pathname_to_stream(ctx, path, 0, &dentry, <e, &stream_idx);
1908 if (!lte || lte->resource_location != RESOURCE_IN_STAGING_FILE) {
1909 return extract_resource_to_staging_dir(dentry->d_inode,
1914 /* Truncate the staging file. */
1915 fd = openat(lte->staging_dir_fd, lte->staging_file_name,
1916 O_WRONLY | O_NOFOLLOW);
1919 ret = ftruncate(fd, size);
1920 if (close(fd) || ret)
1927 wimfs_unlink(const char *path)
1929 const struct wimfs_context *ctx = wimfs_get_context();
1930 struct wim_dentry *dentry;
1934 ret = wim_pathname_to_stream(ctx, path, 0, &dentry, NULL, &stream_idx);
1938 if (inode_stream_name_nbytes(dentry->d_inode, stream_idx) == 0) {
1939 touch_parent(dentry);
1940 remove_dentry(dentry, ctx->wim->lookup_table);
1942 inode_remove_ads(dentry->d_inode,
1943 &dentry->d_inode->i_ads_entries[stream_idx - 1],
1944 ctx->wim->lookup_table);
1949 #ifdef HAVE_UTIMENSAT
1951 * Change the timestamp on a file dentry.
1953 * Note that alternate data streams do not have their own timestamps.
1956 wimfs_utimens(const char *path, const struct timespec tv[2])
1958 WIMStruct *wim = wimfs_get_WIMStruct();
1959 struct wim_inode *inode;
1961 inode = wim_pathname_to_inode(wim, path);
1965 if (tv[0].tv_nsec != UTIME_OMIT) {
1966 if (tv[0].tv_nsec == UTIME_NOW)
1967 inode->i_last_access_time = get_wim_timestamp();
1969 inode->i_last_access_time = timespec_to_wim_timestamp(tv[0]);
1971 if (tv[1].tv_nsec != UTIME_OMIT) {
1972 if (tv[1].tv_nsec == UTIME_NOW)
1973 inode->i_last_write_time = get_wim_timestamp();
1975 inode->i_last_write_time = timespec_to_wim_timestamp(tv[1]);
1979 #else /* HAVE_UTIMENSAT */
1981 wimfs_utime(const char *path, struct utimbuf *times)
1983 WIMStruct *wim = wimfs_get_WIMStruct();
1984 struct wim_inode *inode;
1986 inode = wim_pathname_to_inode(wim, path);
1990 inode->i_last_access_time = unix_timestamp_to_wim(times->actime);
1991 inode->i_last_write_time = unix_timestamp_to_wim(times->modtime);
1994 #endif /* !HAVE_UTIMENSAT */
1997 wimfs_write(const char *path, const char *buf, size_t size,
1998 off_t offset, struct fuse_file_info *fi)
2000 struct wimfs_fd *fd = WIMFS_FD(fi);
2003 ret = raw_pwrite(&fd->f_staging_fd, buf, size, offset);
2007 if (offset + size > fd->f_lte->size)
2008 fd->f_lte->size = offset + size;
2010 touch_inode(fd->f_inode);
2014 static struct fuse_operations wimfs_operations = {
2015 .chmod = wimfs_chmod,
2016 .chown = wimfs_chown,
2017 .fgetattr = wimfs_fgetattr,
2018 .ftruncate = wimfs_ftruncate,
2019 .getattr = wimfs_getattr,
2020 .getxattr = wimfs_getxattr,
2022 .listxattr = wimfs_listxattr,
2023 .mkdir = wimfs_mkdir,
2024 .mknod = wimfs_mknod,
2026 .opendir = wimfs_opendir,
2028 .readdir = wimfs_readdir,
2029 .readlink = wimfs_readlink,
2030 .release = wimfs_release,
2031 .releasedir = wimfs_release,
2032 .removexattr = wimfs_removexattr,
2033 .rename = wimfs_rename,
2034 .rmdir = wimfs_rmdir,
2035 .setxattr = wimfs_setxattr,
2036 .symlink = wimfs_symlink,
2037 .truncate = wimfs_truncate,
2038 .unlink = wimfs_unlink,
2039 #ifdef HAVE_UTIMENSAT
2040 .utimens = wimfs_utimens,
2042 .utime = wimfs_utime,
2044 .write = wimfs_write,
2046 /* We keep track of file descriptor structures (struct wimfs_fd), so
2047 * there is no need to have the file path provided on operations such as
2049 #if FUSE_MAJOR_VERSION > 2 || (FUSE_MAJOR_VERSION == 2 && FUSE_MINOR_VERSION >= 8)
2050 .flag_nullpath_ok = 1,
2052 #if FUSE_MAJOR_VERSION > 2 || (FUSE_MAJOR_VERSION == 2 && FUSE_MINOR_VERSION >= 9)
2054 .flag_utime_omit_ok = 1,
2058 /* API function documented in wimlib.h */
2060 wimlib_mount_image(WIMStruct *wim, int image, const char *dir,
2061 int mount_flags, const char *staging_dir)
2064 struct wim_image_metadata *imd;
2065 struct wimfs_context ctx;
2066 char *fuse_argv[16];
2069 if (!wim || !dir || !*dir)
2070 return WIMLIB_ERR_INVALID_PARAM;
2072 if (mount_flags & ~(WIMLIB_MOUNT_FLAG_READWRITE |
2073 WIMLIB_MOUNT_FLAG_DEBUG |
2074 WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE |
2075 WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR |
2076 WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS |
2077 WIMLIB_MOUNT_FLAG_UNIX_DATA |
2078 WIMLIB_MOUNT_FLAG_ALLOW_OTHER))
2079 return WIMLIB_ERR_INVALID_PARAM;
2081 /* For read-write mount, check for write access to the WIM. */
2082 if (mount_flags & WIMLIB_MOUNT_FLAG_READWRITE) {
2083 ret = can_delete_from_wim(wim);
2088 /* Select the image to mount. */
2089 ret = select_wim_image(wim, image);
2093 /* Get the metadata for the image to mount. */
2094 imd = wim_get_current_image_metadata(wim);
2096 if (imd->modified) {
2097 /* To avoid complicating things, we don't support mounting
2098 * images to which in-memory modifications have already been
2100 ERROR("Cannot mount a modified WIM image!");
2101 return WIMLIB_ERR_INVALID_PARAM;
2104 if (mount_flags & WIMLIB_MOUNT_FLAG_READWRITE) {
2105 ret = lock_wim_for_append(wim);
2110 /* If the user did not specify an interface for accessing named
2111 * data streams, use the default (extended attributes). */
2112 if (!(mount_flags & (WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE |
2113 WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR |
2114 WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS)))
2115 mount_flags |= WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR;
2117 /* Start initializing the wimfs_context. */
2118 memset(&ctx, 0, sizeof(struct wimfs_context));
2120 ctx.mount_flags = mount_flags;
2121 if (mount_flags & WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS)
2122 ctx.default_lookup_flags = LOOKUP_FLAG_ADS_OK;
2123 /* For read-write mount, create the staging directory. */
2124 if (mount_flags & WIMLIB_MOUNT_FLAG_READWRITE) {
2125 ret = make_staging_dir(&ctx, staging_dir);
2129 ctx.owner_uid = getuid();
2130 ctx.owner_gid = getgid();
2132 /* Add each stream referenced by files in the image to a list and
2133 * preemptively double the number of references to each. This is done
2134 * to allow implementing the WIMLIB_UNMOUNT_FLAG_NEW_IMAGE semantics.
2136 INIT_LIST_HEAD(&ctx.orig_stream_list);
2137 if (mount_flags & WIMLIB_MOUNT_FLAG_READWRITE) {
2139 struct wim_inode *inode;
2140 struct wim_lookup_table_entry *lte;
2142 image_for_each_inode(inode, imd) {
2143 for (i = 0; i <= inode->i_num_ads; i++) {
2144 lte = inode_stream_lte(inode, i,
2147 lte->out_refcnt = 0;
2151 image_for_each_inode(inode, imd) {
2152 for (i = 0; i <= inode->i_num_ads; i++) {
2153 lte = inode_stream_lte(inode, i,
2156 if (lte->out_refcnt == 0)
2157 list_add(<e->orig_stream_list,
2158 &ctx.orig_stream_list);
2159 lte->out_refcnt += inode->i_nlink;
2160 lte->refcnt += inode->i_nlink;
2166 /* Assign new inode numbers. */
2167 reassign_inode_numbers(&ctx);
2169 /* If a read-write mount, mark the image as modified. */
2170 if (mount_flags & WIMLIB_MOUNT_FLAG_READWRITE)
2173 /* Build the FUSE command line. */
2176 fuse_argv[fuse_argc++] = "wimlib";
2177 fuse_argv[fuse_argc++] = (char *)dir;
2179 /* Disable multi-threaded operation. */
2180 fuse_argv[fuse_argc++] = "-s";
2182 /* Enable FUSE debug mode (don't fork) if requested by the user. */
2183 if (mount_flags & WIMLIB_MOUNT_FLAG_DEBUG)
2184 fuse_argv[fuse_argc++] = "-d";
2187 * Build the FUSE mount options:
2190 * FUSE will use the inode numbers we provide. We want this,
2191 * because we have inodes and will number them ourselves.
2194 * Name for our filesystem (main type is "fuse").
2197 * If an open file is unlinked, unlink it for real rather than
2198 * renaming it to a hidden file. Our code supports this; an
2199 * unlinked inode is retained until all its file descriptors have
2202 * default_permissions
2203 * FUSE will perform permission checking. Useful when
2204 * WIMLIB_MOUNT_FLAG_UNIX_DATA is provided and the WIM image
2205 * contains the UNIX permissions for each file.
2208 * Cache the contents of files. This will speed up repeated access
2209 * to files on a mounted WIM image, since they won't need to be
2210 * decompressed repeatedly. This option is valid because data in
2211 * the WIM image should never be changed externally. (Although, if
2212 * someone really wanted to they could modify the WIM file or mess
2213 * with the staging directory; but then they're asking for
2216 * entry_timeout=1000000000
2217 * Cache positive name lookups indefinitely, since names can only
2218 * be added, removed, or modified through the mounted filesystem
2221 * negative_timeout=1000000000
2222 * Cache negative name lookups indefinitely, since names can only
2223 * be added, removed, or modified through the mounted filesystem
2227 * Don't cache file/directory attributes. This is needed as a
2228 * workaround for the fact that when caching attributes, the high
2229 * level interface to libfuse considers a file which has several
2230 * hard-linked names as several different files. (Otherwise, we
2231 * could cache our file/directory attributes indefinitely, since
2232 * they can only be changed through the mounted filesystem itself.)
2234 char optstring[256] =
2239 ",default_permissions"
2241 ",entry_timeout=1000000000"
2242 ",negative_timeout=1000000000"
2245 fuse_argv[fuse_argc++] = "-o";
2246 fuse_argv[fuse_argc++] = optstring;
2247 if (!(mount_flags & WIMLIB_MOUNT_FLAG_READWRITE))
2248 strcat(optstring, ",ro");
2249 if (mount_flags & WIMLIB_MOUNT_FLAG_ALLOW_OTHER)
2250 strcat(optstring, ",allow_other");
2251 fuse_argv[fuse_argc] = NULL;
2253 /* Mount our filesystem. */
2254 ret = fuse_main(fuse_argc, fuse_argv, &wimfs_operations, &ctx);
2256 /* Cleanup and return. */
2258 ret = WIMLIB_ERR_FUSE;
2259 release_extra_refcnts(&ctx);
2260 if (mount_flags & WIMLIB_MOUNT_FLAG_READWRITE)
2261 delete_staging_dir(&ctx);
2263 unlock_wim_for_append(wim);
2267 struct commit_progress_thread_args {
2269 wimlib_progress_func_t progfunc;
2274 commit_progress_thread_proc(void *_args)
2276 struct commit_progress_thread_args *args = _args;
2277 struct commit_progress_report report;
2281 ret = mq_receive(args->mq,
2282 (char *)&report, sizeof(report), NULL);
2283 if (ret == sizeof(report)) {
2284 call_progress(args->progfunc, report.msg,
2285 &report.info, args->progctx);
2287 if (ret == 0 || (ret < 0 && errno != EINTR))
2295 generate_message_queue_name(char name[WIMFS_MQUEUE_NAME_LEN + 1])
2298 memcpy(name + 1, "wimfs-", 6);
2299 randomize_char_array_with_alnum(name + 7, WIMFS_MQUEUE_NAME_LEN - 7);
2300 name[WIMFS_MQUEUE_NAME_LEN] = '\0';
2304 create_message_queue(const char *name, bool have_progfunc)
2306 bool am_root = (getuid() == 0);
2307 mode_t umask_save = 0;
2309 struct mq_attr attr;
2312 memset(&attr, 0, sizeof(attr));
2315 attr.mq_msgsize = sizeof(struct commit_progress_report);
2317 attr.mq_msgsize = sizeof(int);
2320 /* Filesystem mounted as normal user with --allow-other should
2321 * be able to send messages to root user, if they're doing the
2323 umask_save = umask(0);
2326 mq = mq_open(name, O_RDWR | O_CREAT | O_EXCL, mode, &attr);
2332 /* Unmount a read-only or read-write mounted WIM image. */
2334 do_unmount(const char *dir)
2339 len = getxattr(dir, "wimfs.unmount", &status, sizeof(int));
2340 if (len == sizeof(int))
2342 else if (len < 0 && (errno == EACCES || errno == EPERM))
2343 return WIMLIB_ERR_NOT_PERMITTED_TO_UNMOUNT;
2345 return WIMLIB_ERR_NOT_A_MOUNTPOINT;
2349 set_unmount_info(const char *dir, const struct wimfs_unmount_info *unmount_info)
2351 if (!setxattr(dir, "wimfs.unmount_info",
2352 unmount_info, sizeof(struct wimfs_unmount_info), 0))
2354 else if (errno == EROFS)
2356 else if (errno == EACCES || errno == EPERM)
2357 return WIMLIB_ERR_NOT_PERMITTED_TO_UNMOUNT;
2359 return WIMLIB_ERR_NOT_A_MOUNTPOINT;
2363 do_unmount_discard(const char *dir)
2366 struct wimfs_unmount_info unmount_info;
2368 memset(&unmount_info, 0, sizeof(unmount_info));
2370 ret = set_unmount_info(dir, &unmount_info);
2373 return do_unmount(dir);
2376 /* Unmount a read-write mounted WIM image, committing the changes. */
2378 do_unmount_commit(const char *dir, int unmount_flags,
2379 wimlib_progress_func_t progfunc, void *progctx)
2381 struct wimfs_unmount_info unmount_info;
2383 struct commit_progress_thread_args args;
2384 pthread_t commit_progress_tid;
2387 memset(&unmount_info, 0, sizeof(unmount_info));
2388 unmount_info.unmount_flags = unmount_flags;
2390 /* The current thread will be stuck in getxattr() until the image is
2391 * committed. Create a thread to handle the progress messages. */
2393 generate_message_queue_name(unmount_info.mq_name);
2395 mq = create_message_queue(unmount_info.mq_name, progfunc != NULL);
2396 if (mq == (mqd_t)-1) {
2397 ERROR_WITH_ERRNO("Can't create POSIX message queue");
2398 return WIMLIB_ERR_MQUEUE;
2401 args.progfunc = progfunc;
2402 args.progctx = progctx;
2403 ret = pthread_create(&commit_progress_tid, NULL,
2404 commit_progress_thread_proc, &args);
2407 ERROR_WITH_ERRNO("Can't create thread");
2408 ret = WIMLIB_ERR_NOMEM;
2411 unmount_info.unmount_flags |= WIMLIB_UNMOUNT_FLAG_SEND_PROGRESS;
2414 ret = set_unmount_info(dir, &unmount_info);
2416 ret = do_unmount(dir);
2418 /* Terminate the progress thread. */
2419 mq_send(mq, NULL, 0, 1);
2420 pthread_join(commit_progress_tid, NULL);
2425 mq_unlink(unmount_info.mq_name);
2431 begin_unmount(const char *dir, int unmount_flags, int *mount_flags_ret,
2432 wimlib_progress_func_t progfunc, void *progctx)
2436 int wim_filename_len;
2437 union wimlib_progress_info progress;
2439 if (getxattr(dir, "wimfs.mount_flags",
2440 &mount_flags, sizeof(int)) != sizeof(int))
2441 return WIMLIB_ERR_NOT_A_MOUNTPOINT;
2443 *mount_flags_ret = mount_flags;
2448 if (getxattr(dir, "wimfs.mounted_image",
2449 &mounted_image, sizeof(int)) != sizeof(int))
2450 return WIMLIB_ERR_NOT_A_MOUNTPOINT;
2452 wim_filename_len = getxattr(dir, "wimfs.wim_filename", NULL, 0);
2453 if (wim_filename_len < 0)
2454 return WIMLIB_ERR_NOT_A_MOUNTPOINT;
2456 char wim_filename[wim_filename_len + 1];
2457 if (getxattr(dir, "wimfs.wim_filename",
2458 wim_filename, wim_filename_len) != wim_filename_len)
2459 return WIMLIB_ERR_NOT_A_MOUNTPOINT;
2460 wim_filename[wim_filename_len] = '\0';
2462 progress.unmount.mountpoint = dir;
2463 progress.unmount.mounted_wim = wim_filename;
2464 progress.unmount.mounted_image = mounted_image;
2465 progress.unmount.mount_flags = mount_flags;
2466 progress.unmount.unmount_flags = unmount_flags;
2468 return call_progress(progfunc, WIMLIB_PROGRESS_MSG_UNMOUNT_BEGIN,
2469 &progress, progctx);
2472 /* API function documented in wimlib.h */
2474 wimlib_unmount_image_with_progress(const char *dir, int unmount_flags,
2475 wimlib_progress_func_t progfunc, void *progctx)
2480 wimlib_global_init(WIMLIB_INIT_FLAG_ASSUME_UTF8);
2482 if (unmount_flags & ~(WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY |
2483 WIMLIB_UNMOUNT_FLAG_COMMIT |
2484 WIMLIB_UNMOUNT_FLAG_REBUILD |
2485 WIMLIB_UNMOUNT_FLAG_RECOMPRESS |
2486 WIMLIB_UNMOUNT_FLAG_FORCE |
2487 WIMLIB_UNMOUNT_FLAG_NEW_IMAGE))
2488 return WIMLIB_ERR_INVALID_PARAM;
2490 ret = begin_unmount(dir, unmount_flags, &mount_flags,
2495 if ((unmount_flags & WIMLIB_UNMOUNT_FLAG_COMMIT) &&
2496 (mount_flags & WIMLIB_MOUNT_FLAG_READWRITE))
2497 return do_unmount_commit(dir, unmount_flags,
2500 return do_unmount_discard(dir);
2503 #else /* WITH_FUSE */
2507 mount_unsupported_error(void)
2509 #if defined(__WIN32__)
2510 ERROR("Sorry-- Mounting WIM images is not supported on Windows!");
2512 ERROR("wimlib was compiled with --without-fuse, which disables support "
2513 "for mounting WIMs.");
2515 return WIMLIB_ERR_UNSUPPORTED;
2519 wimlib_unmount_image_with_progress(const tchar *dir, int unmount_flags,
2520 wimlib_progress_func_t progfunc, void *progctx)
2522 return mount_unsupported_error();
2526 wimlib_mount_image(WIMStruct *wim, int image, const tchar *dir,
2527 int mount_flags, const tchar *staging_dir)
2529 return mount_unsupported_error();
2532 #endif /* !WITH_FUSE */
2535 wimlib_unmount_image(const tchar *dir, int unmount_flags)
2537 return wimlib_unmount_image_with_progress(dir, unmount_flags, NULL, NULL);