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 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 #include "wimlib/dentry.h"
41 #include "wimlib/encoding.h"
42 #include "wimlib/lookup_table.h"
43 #include "wimlib/metadata.h"
44 #include "wimlib/paths.h"
45 #include "wimlib/progress.h"
46 #include "wimlib/reparse.h"
47 #include "wimlib/timestamp.h"
48 #include "wimlib/unix_data.h"
49 #include "wimlib/write.h"
50 #include "wimlib/xml.h"
61 #include <sys/types.h>
65 #define FUSE_USE_VERSION 26
67 #include <attr/xattr.h>
70 # define O_NOFOLLOW 0 /* Security only... */
73 #define WIMFS_MQUEUE_NAME_LEN 32
75 #define WIMLIB_UNMOUNT_FLAG_SEND_PROGRESS 0x80000000
77 struct wimfs_unmount_info {
78 unsigned unmount_flags;
79 char mq_name[WIMFS_MQUEUE_NAME_LEN + 1];
82 struct commit_progress_report {
83 enum wimlib_progress_msg msg;
84 union wimlib_progress_info info;
87 /* Description of an open file on a mounted WIM image. Actually, this
88 * represents the open state of a particular data stream of an inode, rather
89 * than the inode itself. (An inode might have multiple named data streams in
90 * addition to the default, unnamed data stream.) At a given time, an inode in
91 * the WIM image might have multiple file descriptors open to it, each to any
92 * one of its data streams. */
95 /* Pointer to the inode of this open file.
96 * 'i_num_opened_fds' of the inode tracks the number of file descriptors
97 * that reference it. */
98 struct wim_inode *f_inode;
100 /* Pointer to the lookup table entry for the data stream that has been
101 * opened. 'num_opened_fds' of the lookup table entry tracks the number
102 * of file descriptors that reference it. Or, this value may be NULL,
103 * which indicates that the opened stream is empty and consequently does
104 * not have a lookup table entry. */
105 struct wim_lookup_table_entry *f_lte;
107 /* If valid (filedes_valid(&f_staging_fd)), this contains the
108 * corresponding native file descriptor for the staging file that has
109 * been created for reading from and/or writing to this open stream. A
110 * single staging file might have multiple file descriptors open to it
111 * simultaneously, each used by a different 'struct wimfs_fd'.
113 * Or, if invalid (!filedes_valid(&f_staging_fd)), this 'struct
114 * wimfs_fd' is not associated with a staging file. This is permissible
115 * only if this 'struct wimfs_fd' was opened read-only and the stream
116 * has not yet been extracted to a staging file. */
117 struct filedes f_staging_fd;
119 /* 0-based index of this file descriptor in the file descriptor table of
123 /* Unique ID of the opened stream in the inode. This will stay the same
124 * even if the indices of the inode's alternate data streams are changed
129 #define WIMFS_FD(fi) ((struct wimfs_fd *)(uintptr_t)((fi)->fh))
131 /* Context structure for a mounted WIM image. */
132 struct wimfs_context {
133 /* The WIMStruct containing the mounted image. The mounted image is the
134 * currently selected image (wim->current_image). */
137 /* Flags passed to wimlib_mount_image() (WIMLIB_MOUNT_FLAG_*). */
140 /* Default flags for path lookup in the WIM image. */
141 int default_lookup_flags;
143 /* Information about the user who has mounted the WIM image */
147 /* Information about the staging directory for a read-write mount. */
150 char *staging_dir_name;
152 /* For read-write mounts, the inode number to be assigned to the next
153 * created file. Note: since this isn't a persistent filesystem and we
154 * can re-assign the inode numbers just before mounting the image, it's
155 * good enough to just generate inode numbers sequentially. */
158 /* Number of file descriptors open to the mounted WIM image. */
159 unsigned long num_open_fds;
161 /* Original list of single-instance streams in the mounted image, linked
162 * by 'struct wim_lookup_table_entry'.orig_stream_list. */
163 struct list_head orig_stream_list;
165 /* Parameters for unmounting the image (can be set via extended
166 * attribute "wimfs.unmount_info"). */
167 struct wimfs_unmount_info unmount_info;
170 #define WIMFS_CTX(fuse_ctx) ((struct wimfs_context*)(fuse_ctx)->private_data)
172 /* Retrieve the context structure for the currently mounted WIM image.
174 * Note: this is a per-thread variable. It is possible for different threads to
175 * mount different images at the same time in the same process, although they
176 * must use different WIMStructs! */
177 static inline struct wimfs_context *
178 wimfs_get_context(void)
180 return WIMFS_CTX(fuse_get_context());
184 wimfs_inc_num_open_fds(void)
186 wimfs_get_context()->num_open_fds++;
190 wimfs_dec_num_open_fds(void)
192 wimfs_get_context()->num_open_fds--;
195 /* Retrieve the WIMStruct for the currently mounted WIM image. */
196 static inline WIMStruct *
197 wimfs_get_WIMStruct(void)
199 return wimfs_get_context()->wim;
202 /* Is write permission requested on the file? */
204 flags_writable(int open_flags)
206 int accmode = (open_flags & O_ACCMODE);
207 return (accmode == O_RDWR || accmode == O_WRONLY);
211 fuse_mask_mode(mode_t mode, const struct fuse_context *fuse_ctx)
213 #if FUSE_MAJOR_VERSION > 2 || (FUSE_MAJOR_VERSION == 2 && FUSE_MINOR_VERSION >= 8)
214 mode &= ~fuse_ctx->umask;
220 * Allocate a file descriptor to a data stream in the mounted WIM image.
223 * A pointer to the inode containing the stream being opened.
225 * The ID of the data stream being opened within the inode.
227 * A pointer to the lookup table entry for the stream data. Or, for a
228 * 0-byte stream, this may be NULL.
230 * On success, a pointer to the new file descriptor will be stored here.
232 * Returns 0 or a -errno code.
235 alloc_wimfs_fd(struct wim_inode *inode,
237 struct wim_lookup_table_entry *lte,
238 struct wimfs_fd **fd_ret)
240 static const u16 min_fds_per_alloc = 8;
241 static const u16 max_fds = 0xffff;
245 if (inode->i_num_opened_fds == inode->i_num_allocated_fds) {
247 struct wimfs_fd **fds;
249 /* Expand this inode's file descriptor table. */
251 num_new_fds = max(min_fds_per_alloc,
252 inode->i_num_allocated_fds / 4);
254 num_new_fds = min(num_new_fds,
255 max_fds - inode->i_num_allocated_fds);
257 if (num_new_fds == 0)
260 fds = REALLOC(inode->i_fds,
261 (inode->i_num_allocated_fds + num_new_fds) *
266 memset(&fds[inode->i_num_allocated_fds], 0,
267 num_new_fds * sizeof(fds[0]));
269 inode->i_num_allocated_fds += num_new_fds;
270 inode->i_next_fd = inode->i_num_opened_fds;
273 /* Allocate the file descriptor in the first available space in the
274 * inode's file descriptor table.
276 * i_next_fd is the lower bound on the next open slot. */
277 for (i = inode->i_next_fd; inode->i_fds[i]; i++)
280 fd = MALLOC(sizeof(*fd));
286 filedes_invalidate(&fd->f_staging_fd);
288 fd->f_stream_id = stream_id;
290 inode->i_fds[i] = fd;
291 inode->i_num_opened_fds++;
293 lte->num_opened_fds++;
294 wimfs_inc_num_open_fds();
295 inode->i_next_fd = i + 1;
300 * Close a file descriptor to a data stream in the mounted WIM image.
302 * Returns 0 or a -errno code. The file descriptor is always closed.
305 close_wimfs_fd(struct wimfs_fd *fd)
308 struct wim_inode *inode;
310 /* Close the staging file if open. */
311 if (filedes_valid(&fd->f_staging_fd))
312 if (filedes_close(&fd->f_staging_fd))
315 /* Release this file descriptor from its lookup table entry. */
317 lte_decrement_num_opened_fds(fd->f_lte);
319 wimfs_dec_num_open_fds();
321 /* Release this file descriptor from its inode. */
323 inode->i_fds[fd->f_idx] = NULL;
324 if (fd->f_idx < inode->i_next_fd)
325 inode->i_next_fd = fd->f_idx;
327 if (--inode->i_num_opened_fds == 0) {
328 /* The last file descriptor to this inode was closed. */
331 inode->i_num_allocated_fds = 0;
332 if (inode->i_nlink == 0)
333 /* No links to this inode remain. Get rid of it. */
340 * Translate a path into the corresponding inode in the mounted WIM image.
342 * See get_dentry() for more information.
344 * Returns a pointer to the resulting inode, or NULL with errno set.
346 static struct wim_inode *
347 wim_pathname_to_inode(WIMStruct *wim, const char *path)
349 struct wim_dentry *dentry;
351 dentry = get_dentry(wim, path, WIMLIB_CASE_SENSITIVE);
354 return dentry->d_inode;
357 /* Can look up named data stream with colon syntax */
358 #define LOOKUP_FLAG_ADS_OK 0x01
360 /* Can look up directory (otherwise get -ENOTDIR) */
361 #define LOOKUP_FLAG_DIRECTORY_OK 0x02
364 * Translate a path into the corresponding dentry, lookup table entry, and
365 * stream index in the mounted WIM image.
367 * Returns 0 or a -errno code. All of @dentry_ret, @lte_ret, and
368 * @stream_idx_ret are optional.
371 wim_pathname_to_stream(const struct wimfs_context *ctx, const char *path,
373 struct wim_dentry **dentry_ret,
374 struct wim_lookup_table_entry **lte_ret,
375 unsigned *stream_idx_ret)
377 WIMStruct *wim = ctx->wim;
378 struct wim_dentry *dentry;
379 struct wim_lookup_table_entry *lte;
381 const char *stream_name = NULL;
382 struct wim_inode *inode;
385 lookup_flags |= ctx->default_lookup_flags;
387 if (lookup_flags & LOOKUP_FLAG_ADS_OK) {
388 stream_name = path_stream_name(path);
390 p = (char *)stream_name - 1;
395 dentry = get_dentry(wim, path, WIMLIB_CASE_SENSITIVE);
401 inode = dentry->d_inode;
403 if (inode_resolve_streams(inode, wim->lookup_table, false))
406 if (!(lookup_flags & LOOKUP_FLAG_DIRECTORY_OK)
407 && inode_is_directory(inode))
411 struct wim_ads_entry *ads_entry;
413 ads_entry = inode_get_ads_entry(inode, stream_name);
417 stream_idx = ads_entry - inode->i_ads_entries + 1;
418 lte = ads_entry->lte;
420 lte = inode_unnamed_stream_resolved(inode, &stream_idx);
423 *dentry_ret = dentry;
427 *stream_idx_ret = stream_idx;
432 * Create a new file in the mounted WIM image.
435 * The FUSE context for the mounted image.
437 * The path at which to create the first link to the new file. If a file
438 * already exists at this path, -EEXIST is returned.
440 * The UNIX mode for the new file. This is only honored if
441 * WIMLIB_MOUNT_FLAG_UNIX_DATA was passed to wimlib_mount_image().
443 * The device ID for the new file, encoding the major and minor device
444 * numbers. This is only honored if WIMLIB_MOUNT_FLAG_UNIX_DATA was passed
445 * to wimlib_mount_image().
447 * Windows file attributes to use for the new file.
449 * On success, a pointer to the new dentry is returned here. Its d_inode
450 * member will point to the new inode that was created for it and added to
451 * the mounted WIM image.
453 * Returns 0 or a -errno code.
456 create_dentry(struct fuse_context *fuse_ctx, const char *path,
457 mode_t mode, dev_t rdev, u32 attributes,
458 struct wim_dentry **dentry_ret)
460 struct wimfs_context *wimfs_ctx = WIMFS_CTX(fuse_ctx);
461 struct wim_dentry *parent;
462 const char *basename;
463 struct wim_dentry *new_dentry;
464 struct wim_inode *new_inode;
466 parent = get_parent_dentry(wimfs_ctx->wim, path, WIMLIB_CASE_SENSITIVE);
470 if (!dentry_is_directory(parent))
473 basename = path_basename(path);
475 if (get_dentry_child_with_name(parent, basename, WIMLIB_CASE_SENSITIVE))
478 if (new_dentry_with_inode(basename, &new_dentry))
481 new_inode = new_dentry->d_inode;
483 new_inode->i_resolved = 1;
484 new_inode->i_ino = wimfs_ctx->next_ino++;
485 new_inode->i_attributes = attributes;
487 if (wimfs_ctx->mount_flags & WIMLIB_MOUNT_FLAG_UNIX_DATA) {
488 struct wimlib_unix_data unix_data;
490 unix_data.uid = fuse_ctx->uid;
491 unix_data.gid = fuse_ctx->gid;
492 unix_data.mode = fuse_mask_mode(mode, fuse_ctx);
493 unix_data.rdev = rdev;
494 if (!inode_set_unix_data(new_inode, &unix_data, UNIX_DATA_ALL))
496 free_dentry(new_dentry);
501 list_add_tail(&new_inode->i_list,
502 &wim_get_current_image_metadata(wimfs_ctx->wim)->inode_list);
504 dentry_add_child(parent, new_dentry);
506 *dentry_ret = new_dentry;
511 * Remove a dentry from the mounted WIM image; i.e. remove an alias for an
515 remove_dentry(struct wim_dentry *dentry,
516 struct wim_lookup_table *lookup_table)
518 /* Drop the reference to each stream the inode contains. */
519 inode_unref_streams(dentry->d_inode, lookup_table);
521 /* Unlink the dentry from the image's dentry tree. */
522 unlink_dentry(dentry);
524 /* Delete the dentry. This will also decrement the link count of the
525 * corresponding inode, and possibly cause it to be deleted as well. */
529 /* Generate UNIX filetype mode bits for the specified WIM inode, based on its
530 * Windows file attributes. */
532 inode_unix_file_type(const struct wim_inode *inode)
534 if (inode_is_symlink(inode))
536 else if (inode_is_directory(inode))
542 /* Generate a default UNIX mode for the specified WIM inode. */
544 inode_default_unix_mode(const struct wim_inode *inode)
546 return inode_unix_file_type(inode) | 0777;
550 * Retrieve standard UNIX metadata ('struct stat') for a WIM inode.
552 * @lte specifies the stream of the inode that is being queried. We mostly
553 * return the same information for all streams, but st_size and st_blocks may be
554 * different for different streams.
556 * This always returns 0.
559 inode_to_stbuf(const struct wim_inode *inode,
560 const struct wim_lookup_table_entry *lte,
563 const struct wimfs_context *ctx = wimfs_get_context();
564 struct wimlib_unix_data unix_data;
566 memset(stbuf, 0, sizeof(struct stat));
567 if ((ctx->mount_flags & WIMLIB_MOUNT_FLAG_UNIX_DATA) &&
568 inode_get_unix_data(inode, &unix_data))
570 /* Use the user ID, group ID, mode, and device ID from the
571 * inode's extra UNIX metadata information. */
572 stbuf->st_uid = unix_data.uid;
573 stbuf->st_gid = unix_data.gid;
574 stbuf->st_mode = unix_data.mode;
575 stbuf->st_rdev = unix_data.rdev;
577 /* Generate default values for the user ID, group ID, and mode.
579 * Note: in the case of an allow_other mount, fuse_context.uid
580 * may not be the same as wimfs_context.owner_uid! */
581 stbuf->st_uid = ctx->owner_uid;
582 stbuf->st_gid = ctx->owner_gid;
583 stbuf->st_mode = inode_default_unix_mode(inode);
585 stbuf->st_ino = inode->i_ino;
586 stbuf->st_nlink = inode->i_nlink;
588 stbuf->st_size = lte->size;
589 #ifdef HAVE_STAT_NANOSECOND_PRECISION
590 stbuf->st_atim = wim_timestamp_to_timespec(inode->i_last_access_time);
591 stbuf->st_mtim = wim_timestamp_to_timespec(inode->i_last_write_time);
592 stbuf->st_ctim = stbuf->st_mtim;
594 stbuf->st_atime = wim_timestamp_to_time_t(inode->i_last_access_time);
595 stbuf->st_mtime = wim_timestamp_to_time_t(inode->i_last_write_time);
596 stbuf->st_ctime = stbuf->st_mtime;
598 stbuf->st_blocks = DIV_ROUND_UP(stbuf->st_size, 512);
602 /* Update the last access and last write timestamps of a WIM inode. */
604 touch_inode(struct wim_inode *inode)
606 u64 now = now_as_wim_timestamp();
607 inode->i_last_access_time = now;
608 inode->i_last_write_time = now;
612 touch_parent(struct wim_dentry *dentry)
614 touch_inode(dentry->d_parent->d_inode);
618 * Create a new file in the staging directory for a read-write mounted image.
620 * On success, returns the file descriptor for the new staging file, opened for
621 * writing. In addition, stores the allocated name of the staging file in
624 * On failure, returns -1 and sets errno.
627 create_staging_file(const struct wimfs_context *ctx, char **name_ret)
630 static const size_t STAGING_FILE_NAME_LEN = 20;
634 name = MALLOC(STAGING_FILE_NAME_LEN + 1);
637 name[STAGING_FILE_NAME_LEN] = '\0';
640 randomize_char_array_with_alnum(name, STAGING_FILE_NAME_LEN);
641 fd = openat(ctx->staging_dir_fd, name,
642 O_WRONLY | O_CREAT | O_EXCL | O_NOFOLLOW, 0600);
643 if (unlikely(fd < 0)) {
644 if (unlikely(errno == EEXIST))
645 /* Try again with another name. */
655 * Extract a WIM resource to the staging directory.
656 * This is necessary if a stream using the resource is being opened for writing.
659 * The inode containing the stream being opened for writing.
662 * The index of the stream in @inode being opened for writing.
665 * *lte_ptr is the lookup table entry for the stream being extracted, or
666 * NULL if the stream does not have a lookup table entry (which is possible
667 * if the stream is empty). On success, *lte_ptr will be set to point to a
668 * lookup table entry that represents the resource in its new location in a
669 * staging file. This may be the same as the old entry in the case that it
670 * was reused, or it may be a new entry.
673 * Number of bytes of the stream to extract and include in the staging file
674 * resource. It may be less than the actual stream length, in which case
675 * only a prefix of the resource will be extracted. It may also be more
676 * than the actual stream length, in which case the extra space will be
679 * Returns 0 or a -errno code.
682 extract_resource_to_staging_dir(struct wim_inode *inode,
684 struct wim_lookup_table_entry **lte_ptr,
686 const struct wimfs_context *ctx)
688 struct wim_lookup_table_entry *old_lte;
689 struct wim_lookup_table_entry *new_lte;
690 char *staging_file_name;
699 /* Create the staging file. */
700 staging_fd = create_staging_file(ctx, &staging_file_name);
701 if (unlikely(staging_fd < 0))
704 /* Extract the stream to the staging file (possibly truncated). */
708 filedes_init(&fd, staging_fd);
710 extract_size = min(old_lte->size, size);
711 result = extract_stream_to_fd(old_lte, &fd, extract_size);
717 /* In the case of truncate() to more than the file length, extend the
718 * staging file with zeroes by calling ftruncate(). */
719 if (!result && size > extract_size)
720 result = ftruncate(staging_fd, size);
722 /* Close the staging file. */
723 if (close(staging_fd))
726 /* If an error occurred, unlink the staging file. */
727 if (unlikely(result)) {
728 /* extract_stream_to_fd() should set errno, but if it didn't,
729 * set a default value. */
730 ret = errno ? -errno : -EIO;
731 goto out_delete_staging_file;
734 /* Now deal with the lookup table entries. We may be able to re-use the
735 * existing entry, but we may have to create a new one instead. */
737 stream_id = inode_stream_idx_to_id(inode, stream_idx);
739 if (old_lte && inode->i_nlink == old_lte->refcnt) {
740 /* The reference count of the existing lookup table entry is the
741 * same as the link count of the inode that contains the stream
742 * we're opening. Therefore, all the references to the lookup
743 * table entry correspond to the stream we're trying to extract,
744 * so the lookup table entry can be re-used. */
745 lookup_table_unlink(ctx->wim->lookup_table, old_lte);
746 lte_put_resource(old_lte);
749 /* We need to split the old lookup table entry because it also
750 * has other references. Or, there was no old lookup table
751 * entry, so we need to create a new one anyway. */
753 new_lte = new_lookup_table_entry();
754 if (unlikely(!new_lte)) {
756 goto out_delete_staging_file;
759 /* There may already be open file descriptors to this stream if
760 * it's previously been opened read-only, but just now we're
761 * opening it read-write. Identify those file descriptors and
762 * change their lookup table entry pointers to point to the new
763 * lookup table entry, and open staging file descriptors for
766 * At the same time, we need to count the number of these opened
767 * file descriptors to the new lookup table entry. If there's
768 * an old lookup table entry, this number needs to be subtracted
769 * from the fd's opened to the old entry. */
770 for (u16 i = 0, j = 0; j < inode->i_num_opened_fds; i++) {
774 fd = inode->i_fds[i];
780 if (fd->f_stream_id != stream_id)
783 /* This is a readonly fd for the same stream. */
785 new_lte->num_opened_fds++;
786 raw_fd = openat(ctx->staging_dir_fd, staging_file_name,
787 O_RDONLY | O_NOFOLLOW);
788 if (unlikely(raw_fd < 0)) {
790 goto out_revert_fd_changes;
792 filedes_init(&fd->f_staging_fd, raw_fd);
795 old_lte->num_opened_fds -= new_lte->num_opened_fds;
796 old_lte->refcnt -= inode->i_nlink;
800 new_lte->refcnt = inode->i_nlink;
801 new_lte->resource_location = RESOURCE_IN_STAGING_FILE;
802 new_lte->staging_file_name = staging_file_name;
803 new_lte->staging_dir_fd = ctx->staging_dir_fd;
804 new_lte->size = size;
806 add_unhashed_stream(new_lte, inode, stream_id,
807 &wim_get_current_image_metadata(ctx->wim)->unhashed_streams);
809 inode->i_lte = new_lte;
811 inode->i_ads_entries[stream_idx - 1].lte = new_lte;
815 out_revert_fd_changes:
816 for (u16 i = 0; new_lte->num_opened_fds; i++) {
817 struct wimfs_fd *fd = inode->i_fds[i];
818 if (fd && fd->f_stream_id == stream_id) {
820 if (filedes_valid(&fd->f_staging_fd)) {
821 filedes_close(&fd->f_staging_fd);
822 filedes_invalidate(&fd->f_staging_fd);
824 new_lte->num_opened_fds--;
827 free_lookup_table_entry(new_lte);
828 out_delete_staging_file:
829 unlinkat(ctx->staging_dir_fd, staging_file_name, 0);
830 FREE(staging_file_name);
835 * Create the staging directory for the WIM file.
837 * The staging directory will be created in the directory specified by the open
838 * file descriptor @parent_dir_fd. It will be given a randomly generated name
839 * based on @wim_basename, the name of the WIM file.
841 * On success, returns a file descriptor to the open staging directory with
842 * O_RDONLY access. In addition, stores the allocated name of the staging
843 * directory (relative to @parent_dir_fd) in @staging_dir_name_ret.
844 * On failure, returns -1 and sets errno.
847 make_staging_dir_at(int parent_dir_fd, const char *wim_basename,
848 char **staging_dir_name_ret)
850 static const char common_suffix[8] = ".staging";
851 static const size_t random_suffix_len = 10;
852 size_t wim_basename_len;
853 size_t staging_dir_name_len;
854 char *staging_dir_name;
858 wim_basename_len = strlen(wim_basename);
859 staging_dir_name_len = wim_basename_len + sizeof(common_suffix) +
861 staging_dir_name = MALLOC(staging_dir_name_len + 1);
862 if (!staging_dir_name)
865 p = staging_dir_name;
866 p = mempcpy(p, wim_basename, wim_basename_len);
867 p = mempcpy(p, common_suffix, sizeof(common_suffix));
868 randomize_char_array_with_alnum(p, random_suffix_len);
869 p += random_suffix_len;
872 if (mkdirat(parent_dir_fd, staging_dir_name, 0700))
875 fd = openat(parent_dir_fd, staging_dir_name,
876 O_RDONLY | O_DIRECTORY | O_NOFOLLOW);
880 *staging_dir_name_ret = staging_dir_name;
884 unlinkat(parent_dir_fd, staging_dir_name, AT_REMOVEDIR);
886 FREE(staging_dir_name);
891 * Create the staging directory and set ctx->staging_dir_fd,
892 * ctx->staging_dir_name, and ctx->parent_dir_fd.
895 make_staging_dir(struct wimfs_context *ctx, const char *parent_dir_path)
897 const char *wim_basename;
901 wim_basename = path_basename(ctx->wim->filename);
903 if (!parent_dir_path) {
904 /* The user did not specify a directory. Default to creating
905 * the staging directory alongside the WIM file. */
906 if (wim_basename > ctx->wim->filename) {
907 parent_dir_path = ctx->wim->filename;
908 end = (char *)(wim_basename - 1);
909 /* *end must be a slash. Temporarily overwrite it so we
910 * can open the parent directory. */
913 parent_dir_path = ".";
917 /* Open the parent directory (in which we'll create our staging
919 ctx->parent_dir_fd = open(parent_dir_path, O_RDONLY | O_DIRECTORY);
920 if (ctx->parent_dir_fd < 0) {
921 ERROR_WITH_ERRNO("Can't open directory \"%s\"",
923 ret = WIMLIB_ERR_OPENDIR;
924 goto out_restore_wim_filename;
927 ctx->staging_dir_fd = make_staging_dir_at(ctx->parent_dir_fd,
929 &ctx->staging_dir_name);
930 if (ctx->staging_dir_fd < 0) {
931 ERROR_WITH_ERRNO("Can't create staging directory in \"%s\"",
933 close(ctx->parent_dir_fd);
934 ret = WIMLIB_ERR_MKDIR;
935 goto out_restore_wim_filename;
938 out_restore_wim_filename:
944 /* Deletes the staging directory, undoing the effects of a successful call to
945 * make_staging_dir(). */
947 delete_staging_dir(struct wimfs_context *ctx)
952 dir = fdopendir(ctx->staging_dir_fd);
954 while ((ent = readdir(dir)))
955 unlinkat(ctx->staging_dir_fd, ent->d_name, 0);
958 close(ctx->staging_dir_fd);
960 if (unlinkat(ctx->parent_dir_fd, ctx->staging_dir_name, AT_REMOVEDIR))
961 WARNING_WITH_ERRNO("Could not delete staging directory");
962 FREE(ctx->staging_dir_name);
963 close(ctx->parent_dir_fd);
966 /* Number the inodes in the mounted image sequentially. */
968 reassign_inode_numbers(struct wimfs_context *ctx)
970 struct wim_image_metadata *imd;
971 struct wim_inode *inode;
974 imd = wim_get_current_image_metadata(ctx->wim);
975 image_for_each_inode(inode, imd)
976 inode->i_ino = ctx->next_ino++;
980 release_extra_refcnts(struct wimfs_context *ctx)
982 struct list_head *list = &ctx->orig_stream_list;
983 struct wim_lookup_table *lookup_table = ctx->wim->lookup_table;
984 struct wim_lookup_table_entry *lte, *tmp;
986 list_for_each_entry_safe(lte, tmp, list, orig_stream_list) {
987 u32 n = lte->out_refcnt;
989 lte_decrement_refcnt(lte, lookup_table);
993 /* Delete the 'struct wim_lookup_table_entry' for any stream that was modified
994 * or created in the read-write mounted image and had a final size of 0. */
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);
1012 /* Close all file descriptors open to the specified inode.
1014 * Note: closing the last file descriptor might free the inode. */
1016 inode_close_fds(struct wim_inode *inode)
1018 u16 num_open_fds = inode->i_num_opened_fds;
1019 for (u16 i = 0; num_open_fds; i++) {
1020 if (inode->i_fds[i]) {
1021 close_wimfs_fd(inode->i_fds[i]);
1027 /* Close all file descriptors open to the mounted image. */
1029 close_all_fds(struct wimfs_context *ctx)
1031 struct wim_inode *inode, *tmp;
1032 struct wim_image_metadata *imd;
1034 imd = wim_get_current_image_metadata(ctx->wim);
1036 list_for_each_entry_safe(inode, tmp, &imd->inode_list, i_list)
1037 inode_close_fds(inode);
1040 /* Moves the currently selected image, which may have been modified, to a new
1041 * index, and sets the original index to refer to a reset (unmodified) copy of
1044 renew_current_image(struct wimfs_context *ctx)
1046 WIMStruct *wim = ctx->wim;
1047 int idx = wim->current_image - 1;
1048 struct wim_image_metadata *imd = wim->image_metadata[idx];
1049 struct wim_image_metadata *replace_imd;
1050 struct wim_lookup_table_entry *new_lte;
1053 /* Create 'replace_imd' structure to use for the reset original,
1054 * unmodified image. */
1055 ret = WIMLIB_ERR_NOMEM;
1056 replace_imd = new_image_metadata();
1060 /* Create new stream reference for the modified image's metadata
1061 * resource, which doesn't exist yet. */
1062 ret = WIMLIB_ERR_NOMEM;
1063 new_lte = new_lookup_table_entry();
1065 goto err_put_replace_imd;
1066 new_lte->flags = WIM_RESHDR_FLAG_METADATA;
1067 new_lte->unhashed = 1;
1069 /* Make the image being moved available at a new index. Increments the
1070 * WIM's image count, but does not increment the reference count of the
1071 * 'struct image_metadata'. */
1072 ret = append_image_metadata(wim, imd);
1074 goto err_free_new_lte;
1076 ret = xml_add_image(wim, "");
1078 goto err_undo_append;
1080 replace_imd->metadata_lte = imd->metadata_lte;
1081 imd->metadata_lte = new_lte;
1082 wim->image_metadata[idx] = replace_imd;
1083 wim->current_image = wim->hdr.image_count;
1087 wim->hdr.image_count--;
1089 free_lookup_table_entry(new_lte);
1090 err_put_replace_imd:
1091 put_image_metadata(replace_imd, NULL);
1096 static enum wimlib_progress_status
1097 commit_progress_func(enum wimlib_progress_msg msg,
1098 union wimlib_progress_info *info, void *progctx)
1100 mqd_t mq = *(mqd_t *)progctx;
1101 struct commit_progress_report report;
1103 memset(&report, 0, sizeof(report));
1106 report.info = *info;
1107 mq_send(mq, (const char *)&report, sizeof(report), 1);
1108 return WIMLIB_PROGRESS_STATUS_CONTINUE;
1111 /* Commit the mounted image to the underlying WIM file. */
1113 commit_image(struct wimfs_context *ctx, int unmount_flags, mqd_t mq)
1117 if (unmount_flags & WIMLIB_UNMOUNT_FLAG_SEND_PROGRESS)
1118 wimlib_register_progress_function(ctx->wim,
1119 commit_progress_func, &mq);
1121 wimlib_register_progress_function(ctx->wim, NULL, NULL);
1123 if (unmount_flags & WIMLIB_UNMOUNT_FLAG_NEW_IMAGE) {
1124 int ret = renew_current_image(ctx);
1128 release_extra_refcnts(ctx);
1130 INIT_LIST_HEAD(&ctx->orig_stream_list);
1131 delete_empty_streams(ctx);
1132 xml_update_image_info(ctx->wim, ctx->wim->current_image);
1136 if (unmount_flags & WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY)
1137 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
1139 if (unmount_flags & WIMLIB_UNMOUNT_FLAG_REBUILD)
1140 write_flags |= WIMLIB_WRITE_FLAG_REBUILD;
1142 if (unmount_flags & WIMLIB_UNMOUNT_FLAG_RECOMPRESS)
1143 write_flags |= WIMLIB_WRITE_FLAG_RECOMPRESS;
1145 return wimlib_overwrite(ctx->wim, write_flags, 0);
1148 /* In the case of an allow_other mount, only the mount owner and root are
1149 * allowed to unmount the filesystem. */
1151 may_unmount_wimfs(void)
1153 const struct fuse_context *fuse_ctx = fuse_get_context();
1154 const struct wimfs_context *wimfs_ctx = WIMFS_CTX(fuse_ctx);
1156 return (fuse_ctx->uid == wimfs_ctx->owner_uid ||
1157 fuse_ctx->uid == 0);
1160 /* Unmount the mounted image, called from the daemon process. */
1164 struct fuse_context *fuse_ctx = fuse_get_context();
1165 struct wimfs_context *wimfs_ctx = WIMFS_CTX(fuse_ctx);
1166 const struct wimfs_unmount_info *info = &wimfs_ctx->unmount_info;
1167 int unmount_flags = info->unmount_flags;
1168 mqd_t mq = (mqd_t)-1;
1171 /* Ignore COMMIT if the image is mounted read-only. */
1172 if (!(wimfs_ctx->mount_flags & WIMLIB_MOUNT_FLAG_READWRITE))
1173 unmount_flags &= ~WIMLIB_UNMOUNT_FLAG_COMMIT;
1175 if (unmount_flags & WIMLIB_UNMOUNT_FLAG_SEND_PROGRESS) {
1176 mq = mq_open(info->mq_name, O_WRONLY | O_NONBLOCK);
1177 if (mq == (mqd_t)-1) {
1178 ret = WIMLIB_ERR_MQUEUE;
1183 if (wimfs_ctx->num_open_fds) {
1185 /* There are still open file descriptors to the image. */
1187 /* With COMMIT, refuse to unmount unless FORCE is also
1189 if ((unmount_flags & (WIMLIB_UNMOUNT_FLAG_COMMIT |
1190 WIMLIB_UNMOUNT_FLAG_FORCE))
1191 == WIMLIB_UNMOUNT_FLAG_COMMIT)
1193 ret = WIMLIB_ERR_MOUNTED_IMAGE_IS_BUSY;
1197 /* Force-close all file descriptors. */
1198 close_all_fds(wimfs_ctx);
1201 if (unmount_flags & WIMLIB_UNMOUNT_FLAG_COMMIT)
1202 ret = commit_image(wimfs_ctx, unmount_flags, mq);
1204 ret = 0; /* Read-only mount, or discarding changes to
1205 a read-write mount */
1208 /* Leave the image mounted if commit failed, unless this is a
1209 * forced unmount. The user can retry without COMMIT if they
1211 if (!ret || (unmount_flags & WIMLIB_UNMOUNT_FLAG_FORCE)) {
1212 unlock_wim_for_append(wimfs_ctx->wim);
1213 fuse_exit(fuse_ctx->fuse);
1215 if (mq != (mqd_t)-1)
1221 wimfs_chmod(const char *path, mode_t mask)
1223 const struct wimfs_context *ctx = wimfs_get_context();
1224 struct wim_inode *inode;
1225 struct wimlib_unix_data unix_data;
1227 if (!(ctx->mount_flags & WIMLIB_MOUNT_FLAG_UNIX_DATA))
1230 inode = wim_pathname_to_inode(ctx->wim, path);
1234 unix_data.uid = ctx->owner_uid;
1235 unix_data.gid = ctx->owner_gid;
1236 unix_data.mode = mask;
1239 if (!inode_set_unix_data(inode, &unix_data, UNIX_DATA_MODE))
1246 wimfs_chown(const char *path, uid_t uid, gid_t gid)
1248 const struct wimfs_context *ctx = wimfs_get_context();
1249 struct wim_inode *inode;
1250 struct wimlib_unix_data unix_data;
1253 if (!(ctx->mount_flags & WIMLIB_MOUNT_FLAG_UNIX_DATA))
1256 inode = wim_pathname_to_inode(ctx->wim, path);
1262 if (uid != (uid_t)-1)
1263 which |= UNIX_DATA_UID;
1265 uid = ctx->owner_uid;
1267 if (gid != (gid_t)-1)
1268 which |= UNIX_DATA_GID;
1270 gid = ctx->owner_gid;
1272 unix_data.uid = uid;
1273 unix_data.gid = gid;
1274 unix_data.mode = inode_default_unix_mode(inode);
1277 if (!inode_set_unix_data(inode, &unix_data, which))
1284 wimfs_fgetattr(const char *path, struct stat *stbuf, struct fuse_file_info *fi)
1286 struct wimfs_fd *fd = WIMFS_FD(fi);
1287 return inode_to_stbuf(fd->f_inode, fd->f_lte, stbuf);
1291 wimfs_ftruncate(const char *path, off_t size, struct fuse_file_info *fi)
1293 struct wimfs_fd *fd = WIMFS_FD(fi);
1294 if (ftruncate(fd->f_staging_fd.fd, size))
1296 touch_inode(fd->f_inode);
1297 fd->f_lte->size = size;
1302 wimfs_getattr(const char *path, struct stat *stbuf)
1304 const struct wimfs_context *ctx = wimfs_get_context();
1305 struct wim_dentry *dentry;
1306 struct wim_lookup_table_entry *lte;
1309 ret = wim_pathname_to_stream(ctx, path, LOOKUP_FLAG_DIRECTORY_OK,
1310 &dentry, <e, NULL);
1313 return inode_to_stbuf(dentry->d_inode, lte, stbuf);
1317 copy_xattr(char *dest, size_t destsize, const void *src, size_t srcsize)
1320 if (destsize < srcsize)
1322 memcpy(dest, src, srcsize);
1328 wimfs_getxattr(const char *path, const char *name, char *value,
1331 const struct wimfs_context *ctx = wimfs_get_context();
1332 struct wim_inode *inode;
1333 struct wim_ads_entry *ads_entry;
1334 struct wim_lookup_table_entry *lte;
1336 if (!strncmp(name, "wimfs.", 6)) {
1337 /* Handle some magical extended attributes. These really should
1338 * be ioctls, but directory ioctls aren't supported until
1339 * libfuse 2.9, and even then they are broken. */
1341 if (!strcmp(name, "wim_filename")) {
1342 return copy_xattr(value, size, ctx->wim->filename,
1343 strlen(ctx->wim->filename));
1345 if (!strcmp(name, "wim_info")) {
1346 struct wimlib_wim_info info;
1348 wimlib_get_wim_info(ctx->wim, &info);
1350 return copy_xattr(value, size, &info, sizeof(info));
1352 if (!strcmp(name, "mounted_image")) {
1353 return copy_xattr(value, size,
1354 &ctx->wim->current_image, sizeof(int));
1356 if (!strcmp(name, "mount_flags")) {
1357 return copy_xattr(value, size,
1358 &ctx->mount_flags, sizeof(int));
1360 if (!strcmp(name, "unmount")) {
1361 if (!may_unmount_wimfs())
1366 if (size < sizeof(int))
1368 status = unmount_wimfs();
1369 memcpy(value, &status, sizeof(int));
1376 if (!(ctx->mount_flags & WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR))
1379 if (strncmp(name, "user.", 5))
1383 /* Querying a named data stream */
1385 inode = wim_pathname_to_inode(ctx->wim, path);
1389 ads_entry = inode_get_ads_entry(inode, name);
1391 return (errno == ENOENT) ? -ENOATTR : -errno;
1393 lte = ads_entry->lte;
1397 if (unlikely(lte->size > INT_MAX))
1401 if (size < lte->size)
1404 if (read_full_stream_into_buf(lte, value))
1405 return errno ? -errno : -EIO;
1411 wimfs_link(const char *existing_path, const char *new_path)
1413 WIMStruct *wim = wimfs_get_WIMStruct();
1414 const char *new_name;
1415 struct wim_inode *inode;
1416 struct wim_dentry *dir;
1417 struct wim_dentry *new_alias;
1419 inode = wim_pathname_to_inode(wim, existing_path);
1423 if (inode->i_attributes & (FILE_ATTRIBUTE_DIRECTORY |
1424 FILE_ATTRIBUTE_REPARSE_POINT))
1427 new_name = path_basename(new_path);
1429 dir = get_parent_dentry(wim, new_path, WIMLIB_CASE_SENSITIVE);
1433 if (!dentry_is_directory(dir))
1436 if (get_dentry_child_with_name(dir, new_name, WIMLIB_CASE_SENSITIVE))
1439 if (new_dentry(new_name, &new_alias))
1442 new_alias->d_inode = inode;
1443 inode_add_dentry(new_alias, inode);
1444 dentry_add_child(dir, new_alias);
1445 touch_inode(dir->d_inode);
1447 inode_ref_streams(inode);
1452 wimfs_listxattr(const char *path, char *list, size_t size)
1454 const struct wimfs_context *ctx = wimfs_get_context();
1455 const struct wim_inode *inode;
1457 char *end = list + size;
1460 if (!(ctx->mount_flags & WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR))
1463 /* List named data streams, or get the list size. We report each named
1464 * data stream "X" as an extended attribute "user.X". */
1466 inode = wim_pathname_to_inode(ctx->wim, path);
1470 for (u16 i = 0; i < inode->i_num_ads; i++) {
1471 const struct wim_ads_entry *entry;
1472 char *stream_name_mbs;
1473 size_t stream_name_mbs_nbytes;
1475 entry = &inode->i_ads_entries[i];
1477 if (!entry->stream_name_nbytes)
1480 if (utf16le_to_tstr(entry->stream_name,
1481 entry->stream_name_nbytes,
1483 &stream_name_mbs_nbytes))
1486 if (unlikely(INT_MAX - total_size < stream_name_mbs_nbytes + 6)) {
1487 FREE(stream_name_mbs);
1491 total_size += stream_name_mbs_nbytes + 6;
1493 if (end - p < stream_name_mbs_nbytes + 6) {
1494 FREE(stream_name_mbs);
1497 p = mempcpy(p, "user.", 5);
1498 p = mempcpy(p, stream_name_mbs, stream_name_mbs_nbytes);
1501 FREE(stream_name_mbs);
1507 wimfs_mkdir(const char *path, mode_t mode)
1509 struct wim_dentry *dentry;
1512 /* Note: according to fuse.h, mode may not include S_IFDIR */
1513 ret = create_dentry(fuse_get_context(), path, mode | S_IFDIR, 0,
1514 FILE_ATTRIBUTE_DIRECTORY, &dentry);
1517 touch_parent(dentry);
1522 wimfs_mknod(const char *path, mode_t mode, dev_t rdev)
1524 struct fuse_context *fuse_ctx = fuse_get_context();
1525 struct wimfs_context *wimfs_ctx = WIMFS_CTX(fuse_ctx);
1526 const char *stream_name;
1528 if ((wimfs_ctx->mount_flags & WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS)
1529 && (stream_name = path_stream_name(path)))
1531 struct wim_ads_entry *old_entry;
1532 struct wim_ads_entry *new_entry;
1533 struct wim_inode *inode;
1536 /* Create a named data stream. */
1541 p = (char *)stream_name - 1;
1544 inode = wim_pathname_to_inode(wimfs_ctx->wim, path);
1549 old_entry = inode_get_ads_entry(inode, stream_name);
1552 if (errno != ENOENT)
1555 new_entry = inode_add_ads(inode, stream_name);
1560 /* Create a regular file, device node, named pipe, or socket.
1562 struct wim_dentry *dentry;
1565 if (!S_ISREG(mode) &&
1566 !(wimfs_ctx->mount_flags & WIMLIB_MOUNT_FLAG_UNIX_DATA))
1569 /* Note: we still use FILE_ATTRIBUTE_NORMAL for device nodes,
1570 * named pipes, and sockets. The real mode is in the UNIX
1572 ret = create_dentry(fuse_ctx, path, mode, rdev,
1573 FILE_ATTRIBUTE_NORMAL, &dentry);
1576 touch_parent(dentry);
1582 wimfs_open(const char *path, struct fuse_file_info *fi)
1584 struct wimfs_context *ctx = wimfs_get_context();
1585 struct wim_dentry *dentry;
1586 struct wim_inode *inode;
1587 struct wim_lookup_table_entry *lte;
1588 unsigned stream_idx;
1589 struct wimfs_fd *fd;
1592 ret = wim_pathname_to_stream(ctx, path, 0, &dentry, <e, &stream_idx);
1596 inode = dentry->d_inode;
1598 /* The file resource may be in the staging directory (read-write mounts
1599 * only) or in the WIM. If it's in the staging directory, we need to
1600 * open a native file descriptor for the corresponding file. Otherwise,
1601 * we can read the file resource directly from the WIM file if we are
1602 * opening it read-only, but we need to extract the resource to the
1603 * staging directory if we are opening it writable. */
1605 if (flags_writable(fi->flags) &&
1606 (!lte || lte->resource_location != RESOURCE_IN_STAGING_FILE)) {
1607 ret = extract_resource_to_staging_dir(inode,
1610 lte ? lte->size : 0,
1616 ret = alloc_wimfs_fd(inode, inode_stream_idx_to_id(inode, stream_idx),
1621 if (lte && lte->resource_location == RESOURCE_IN_STAGING_FILE) {
1624 raw_fd = openat(lte->staging_dir_fd, lte->staging_file_name,
1625 (fi->flags & O_ACCMODE) | O_NOFOLLOW);
1630 filedes_init(&fd->f_staging_fd, raw_fd);
1632 fi->fh = (uintptr_t)fd;
1637 wimfs_opendir(const char *path, struct fuse_file_info *fi)
1639 WIMStruct *wim = wimfs_get_WIMStruct();
1640 struct wim_inode *inode;
1641 struct wimfs_fd *fd;
1644 inode = wim_pathname_to_inode(wim, path);
1647 if (!inode_is_directory(inode))
1649 ret = alloc_wimfs_fd(inode, 0, NULL, &fd);
1652 fi->fh = (uintptr_t)fd;
1657 wimfs_read(const char *path, char *buf, size_t size,
1658 off_t offset, struct fuse_file_info *fi)
1660 struct wimfs_fd *fd = WIMFS_FD(fi);
1661 const struct wim_lookup_table_entry *lte;
1668 if (offset >= lte->size)
1671 if (size > lte->size - offset)
1672 size = lte->size - offset;
1677 switch (lte->resource_location) {
1678 case RESOURCE_IN_WIM:
1679 if (read_partial_wim_stream_into_buf(lte, size, offset, buf))
1680 ret = errno ? -errno : -EIO;
1684 case RESOURCE_IN_STAGING_FILE:
1685 ret = raw_pread(&fd->f_staging_fd, buf, size, offset);
1689 case RESOURCE_IN_ATTACHED_BUFFER:
1690 memcpy(buf, lte->attached_buffer + offset, size);
1701 wimfs_readdir(const char *path, void *buf, fuse_fill_dir_t filler,
1702 off_t offset, struct fuse_file_info *fi)
1704 struct wimfs_fd *fd = WIMFS_FD(fi);
1705 const struct wim_inode *inode;
1706 const struct wim_dentry *child;
1709 inode = fd->f_inode;
1711 ret = filler(buf, ".", NULL, 0);
1714 ret = filler(buf, "..", NULL, 0);
1718 for_inode_child(child, inode) {
1719 char *file_name_mbs;
1720 size_t file_name_mbs_nbytes;
1722 ret = utf16le_to_tstr(child->file_name,
1723 child->file_name_nbytes,
1725 &file_name_mbs_nbytes);
1729 ret = filler(buf, file_name_mbs, NULL, 0);
1730 FREE(file_name_mbs);
1738 wimfs_readlink(const char *path, char *buf, size_t buf_len)
1740 WIMStruct *wim = wimfs_get_WIMStruct();
1741 const struct wim_inode *inode;
1744 inode = wim_pathname_to_inode(wim, path);
1747 if (!inode_is_symlink(inode))
1751 ret = wim_inode_readlink(inode, buf, buf_len - 1, NULL);
1755 } else if (ret == -ENAMETOOLONG) {
1756 buf[buf_len - 1] = '\0';
1761 /* We use this for both release() and releasedir(), since in both cases we
1762 * simply need to close the file descriptor. */
1764 wimfs_release(const char *path, struct fuse_file_info *fi)
1766 return close_wimfs_fd(WIMFS_FD(fi));
1770 wimfs_removexattr(const char *path, const char *name)
1772 struct wimfs_context *ctx = wimfs_get_context();
1773 struct wim_inode *inode;
1774 struct wim_ads_entry *ads_entry;
1776 if (!(ctx->mount_flags & WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR))
1779 if (strncmp(name, "user.", 5))
1783 /* Removing a named data stream. */
1785 inode = wim_pathname_to_inode(ctx->wim, path);
1789 ads_entry = inode_get_ads_entry(inode, name);
1791 return (errno == ENOENT) ? -ENOATTR : -errno;
1793 inode_remove_ads(inode, ads_entry, ctx->wim->lookup_table);
1798 wimfs_rename(const char *from, const char *to)
1800 return rename_wim_path(wimfs_get_WIMStruct(), from, to,
1801 WIMLIB_CASE_SENSITIVE, NULL);
1805 wimfs_rmdir(const char *path)
1807 WIMStruct *wim = wimfs_get_WIMStruct();
1808 struct wim_dentry *dentry;
1810 dentry = get_dentry(wim, path, WIMLIB_CASE_SENSITIVE);
1814 if (!dentry_is_directory(dentry))
1817 if (dentry_has_children(dentry))
1820 touch_parent(dentry);
1821 remove_dentry(dentry, wim->lookup_table);
1826 wimfs_setxattr(const char *path, const char *name,
1827 const char *value, size_t size, int flags)
1829 struct wimfs_context *ctx = wimfs_get_context();
1830 struct wim_inode *inode;
1831 struct wim_ads_entry *existing_entry;
1833 if (!strncmp(name, "wimfs.", 6)) {
1834 /* Handle some magical extended attributes. These really should
1835 * be ioctls, but directory ioctls aren't supported until
1836 * libfuse 2.9, and even then they are broken. [Fixed by
1837 * libfuse commit e3b7d4c278a26520be63d99d6ea84b26906fe73d] */
1839 if (!strcmp(name, "unmount_info")) {
1840 if (!may_unmount_wimfs())
1842 if (size < sizeof(struct wimfs_unmount_info))
1844 memcpy(&ctx->unmount_info, value,
1845 sizeof(struct wimfs_unmount_info));
1851 if (!(ctx->mount_flags & WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR))
1854 if (strncmp(name, "user.", 5))
1858 /* Setting the contents of a named data stream. */
1860 inode = wim_pathname_to_inode(ctx->wim, path);
1864 existing_entry = inode_get_ads_entry(inode, name);
1865 if (existing_entry) {
1866 if (flags & XATTR_CREATE)
1869 if (errno != ENOENT)
1871 if (flags & XATTR_REPLACE)
1875 if (!inode_add_ads_with_data(inode, name, value,
1876 size, ctx->wim->lookup_table))
1879 inode_remove_ads(inode, existing_entry, ctx->wim->lookup_table);
1884 wimfs_symlink(const char *to, const char *from)
1886 struct fuse_context *fuse_ctx = fuse_get_context();
1887 struct wimfs_context *wimfs_ctx = WIMFS_CTX(fuse_ctx);
1888 struct wim_dentry *dentry;
1891 ret = create_dentry(fuse_ctx, from, S_IFLNK | 0777, 0,
1892 FILE_ATTRIBUTE_REPARSE_POINT, &dentry);
1895 dentry->d_inode->i_reparse_tag = WIM_IO_REPARSE_TAG_SYMLINK;
1896 ret = wim_inode_set_symlink(dentry->d_inode, to,
1897 wimfs_ctx->wim->lookup_table);
1899 remove_dentry(dentry, wimfs_ctx->wim->lookup_table);
1900 if (ret == WIMLIB_ERR_NOMEM)
1905 touch_parent(dentry);
1911 wimfs_truncate(const char *path, off_t size)
1913 const struct wimfs_context *ctx = wimfs_get_context();
1914 struct wim_dentry *dentry;
1915 struct wim_lookup_table_entry *lte;
1916 unsigned stream_idx;
1920 ret = wim_pathname_to_stream(ctx, path, 0, &dentry, <e, &stream_idx);
1927 if (!lte || lte->resource_location != RESOURCE_IN_STAGING_FILE) {
1928 return extract_resource_to_staging_dir(dentry->d_inode,
1933 /* Truncate the staging file. */
1934 fd = openat(lte->staging_dir_fd, lte->staging_file_name,
1935 O_WRONLY | O_NOFOLLOW);
1938 ret = ftruncate(fd, size);
1939 if (close(fd) || ret)
1946 wimfs_unlink(const char *path)
1948 const struct wimfs_context *ctx = wimfs_get_context();
1949 struct wim_dentry *dentry;
1950 unsigned stream_idx;
1953 ret = wim_pathname_to_stream(ctx, path, 0, &dentry, NULL, &stream_idx);
1957 if (inode_stream_name_nbytes(dentry->d_inode, stream_idx) == 0) {
1958 touch_parent(dentry);
1959 remove_dentry(dentry, ctx->wim->lookup_table);
1961 inode_remove_ads(dentry->d_inode,
1962 &dentry->d_inode->i_ads_entries[stream_idx - 1],
1963 ctx->wim->lookup_table);
1968 #ifdef HAVE_UTIMENSAT
1970 * Change the timestamp on a file dentry.
1972 * Note that alternate data streams do not have their own timestamps.
1975 wimfs_utimens(const char *path, const struct timespec tv[2])
1977 WIMStruct *wim = wimfs_get_WIMStruct();
1978 struct wim_inode *inode;
1980 inode = wim_pathname_to_inode(wim, path);
1984 if (tv[0].tv_nsec != UTIME_OMIT) {
1985 if (tv[0].tv_nsec == UTIME_NOW)
1986 inode->i_last_access_time = now_as_wim_timestamp();
1988 inode->i_last_access_time = timespec_to_wim_timestamp(&tv[0]);
1990 if (tv[1].tv_nsec != UTIME_OMIT) {
1991 if (tv[1].tv_nsec == UTIME_NOW)
1992 inode->i_last_write_time = now_as_wim_timestamp();
1994 inode->i_last_write_time = timespec_to_wim_timestamp(&tv[1]);
1998 #else /* HAVE_UTIMENSAT */
2000 wimfs_utime(const char *path, struct utimbuf *times)
2002 WIMStruct *wim = wimfs_get_WIMStruct();
2003 struct wim_inode *inode;
2005 inode = wim_pathname_to_inode(wim, path);
2009 inode->i_last_access_time = time_t_to_wim_timestamp(times->actime);
2010 inode->i_last_write_time = time_t_to_wim_timestamp(times->modtime);
2013 #endif /* !HAVE_UTIMENSAT */
2016 wimfs_write(const char *path, const char *buf, size_t size,
2017 off_t offset, struct fuse_file_info *fi)
2019 struct wimfs_fd *fd = WIMFS_FD(fi);
2022 ret = raw_pwrite(&fd->f_staging_fd, buf, size, offset);
2026 if (offset + size > fd->f_lte->size)
2027 fd->f_lte->size = offset + size;
2029 touch_inode(fd->f_inode);
2033 static struct fuse_operations wimfs_operations = {
2034 .chmod = wimfs_chmod,
2035 .chown = wimfs_chown,
2036 .fgetattr = wimfs_fgetattr,
2037 .ftruncate = wimfs_ftruncate,
2038 .getattr = wimfs_getattr,
2039 .getxattr = wimfs_getxattr,
2041 .listxattr = wimfs_listxattr,
2042 .mkdir = wimfs_mkdir,
2043 .mknod = wimfs_mknod,
2045 .opendir = wimfs_opendir,
2047 .readdir = wimfs_readdir,
2048 .readlink = wimfs_readlink,
2049 .release = wimfs_release,
2050 .releasedir = wimfs_release,
2051 .removexattr = wimfs_removexattr,
2052 .rename = wimfs_rename,
2053 .rmdir = wimfs_rmdir,
2054 .setxattr = wimfs_setxattr,
2055 .symlink = wimfs_symlink,
2056 .truncate = wimfs_truncate,
2057 .unlink = wimfs_unlink,
2058 #ifdef HAVE_UTIMENSAT
2059 .utimens = wimfs_utimens,
2061 .utime = wimfs_utime,
2063 .write = wimfs_write,
2065 /* We keep track of file descriptor structures (struct wimfs_fd), so
2066 * there is no need to have the file path provided on operations such as
2068 #if FUSE_MAJOR_VERSION > 2 || (FUSE_MAJOR_VERSION == 2 && FUSE_MINOR_VERSION >= 8)
2069 .flag_nullpath_ok = 1,
2071 #if FUSE_MAJOR_VERSION > 2 || (FUSE_MAJOR_VERSION == 2 && FUSE_MINOR_VERSION >= 9)
2073 .flag_utime_omit_ok = 1,
2077 /* API function documented in wimlib.h */
2079 wimlib_mount_image(WIMStruct *wim, int image, const char *dir,
2080 int mount_flags, const char *staging_dir)
2083 struct wim_image_metadata *imd;
2084 struct wimfs_context ctx;
2085 char *fuse_argv[16];
2088 if (!wim || !dir || !*dir)
2089 return WIMLIB_ERR_INVALID_PARAM;
2091 if (mount_flags & ~(WIMLIB_MOUNT_FLAG_READWRITE |
2092 WIMLIB_MOUNT_FLAG_DEBUG |
2093 WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE |
2094 WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR |
2095 WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS |
2096 WIMLIB_MOUNT_FLAG_UNIX_DATA |
2097 WIMLIB_MOUNT_FLAG_ALLOW_OTHER))
2098 return WIMLIB_ERR_INVALID_PARAM;
2100 /* For read-write mount, check for write access to the WIM. */
2101 if (mount_flags & WIMLIB_MOUNT_FLAG_READWRITE) {
2103 return WIMLIB_ERR_NO_FILENAME;
2104 ret = can_modify_wim(wim);
2109 /* Select the image to mount. */
2110 ret = select_wim_image(wim, image);
2114 /* Get the metadata for the image to mount. */
2115 imd = wim_get_current_image_metadata(wim);
2117 if (imd->modified) {
2118 /* To avoid complicating things, we don't support mounting
2119 * images to which in-memory modifications have already been
2121 ERROR("Cannot mount a modified WIM image!");
2122 return WIMLIB_ERR_INVALID_PARAM;
2125 if (mount_flags & WIMLIB_MOUNT_FLAG_READWRITE) {
2126 ret = lock_wim_for_append(wim);
2131 /* If the user did not specify an interface for accessing named
2132 * data streams, use the default (extended attributes). */
2133 if (!(mount_flags & (WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE |
2134 WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR |
2135 WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS)))
2136 mount_flags |= WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR;
2138 /* Start initializing the wimfs_context. */
2139 memset(&ctx, 0, sizeof(struct wimfs_context));
2141 ctx.mount_flags = mount_flags;
2142 if (mount_flags & WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS)
2143 ctx.default_lookup_flags = LOOKUP_FLAG_ADS_OK;
2144 /* For read-write mount, create the staging directory. */
2145 if (mount_flags & WIMLIB_MOUNT_FLAG_READWRITE) {
2146 ret = make_staging_dir(&ctx, staging_dir);
2150 ctx.owner_uid = getuid();
2151 ctx.owner_gid = getgid();
2153 /* Add each stream referenced by files in the image to a list and
2154 * preemptively double the number of references to each. This is done
2155 * to allow implementing the WIMLIB_UNMOUNT_FLAG_NEW_IMAGE semantics.
2157 INIT_LIST_HEAD(&ctx.orig_stream_list);
2158 if (mount_flags & WIMLIB_MOUNT_FLAG_READWRITE) {
2160 struct wim_inode *inode;
2161 struct wim_lookup_table_entry *lte;
2163 image_for_each_inode(inode, imd) {
2164 for (i = 0; i <= inode->i_num_ads; i++) {
2165 lte = inode_stream_lte(inode, i,
2168 lte->out_refcnt = 0;
2172 image_for_each_inode(inode, imd) {
2173 for (i = 0; i <= inode->i_num_ads; i++) {
2174 lte = inode_stream_lte(inode, i,
2177 if (lte->out_refcnt == 0)
2178 list_add(<e->orig_stream_list,
2179 &ctx.orig_stream_list);
2180 lte->out_refcnt += inode->i_nlink;
2181 lte->refcnt += inode->i_nlink;
2187 /* Assign new inode numbers. */
2188 reassign_inode_numbers(&ctx);
2190 /* If a read-write mount, mark the image as modified. */
2191 if (mount_flags & WIMLIB_MOUNT_FLAG_READWRITE)
2194 /* Build the FUSE command line. */
2197 fuse_argv[fuse_argc++] = "wimlib";
2198 fuse_argv[fuse_argc++] = (char *)dir;
2200 /* Disable multi-threaded operation. */
2201 fuse_argv[fuse_argc++] = "-s";
2203 /* Enable FUSE debug mode (don't fork) if requested by the user. */
2204 if (mount_flags & WIMLIB_MOUNT_FLAG_DEBUG)
2205 fuse_argv[fuse_argc++] = "-d";
2208 * Build the FUSE mount options:
2211 * FUSE will use the inode numbers we provide. We want this,
2212 * because we have inodes and will number them ourselves.
2215 * Name for our filesystem (main type is "fuse").
2218 * If an open file is unlinked, unlink it for real rather than
2219 * renaming it to a hidden file. Our code supports this; an
2220 * unlinked inode is retained until all its file descriptors have
2223 * default_permissions
2224 * FUSE will perform permission checking. Useful when
2225 * WIMLIB_MOUNT_FLAG_UNIX_DATA is provided and the WIM image
2226 * contains the UNIX permissions for each file.
2229 * Cache the contents of files. This will speed up repeated access
2230 * to files on a mounted WIM image, since they won't need to be
2231 * decompressed repeatedly. This option is valid because data in
2232 * the WIM image should never be changed externally. (Although, if
2233 * someone really wanted to they could modify the WIM file or mess
2234 * with the staging directory; but then they're asking for
2237 * entry_timeout=1000000000
2238 * Cache positive name lookups indefinitely, since names can only
2239 * be added, removed, or modified through the mounted filesystem
2242 * negative_timeout=1000000000
2243 * Cache negative name lookups indefinitely, since names can only
2244 * be added, removed, or modified through the mounted filesystem
2248 * Don't cache file/directory attributes. This is needed as a
2249 * workaround for the fact that when caching attributes, the high
2250 * level interface to libfuse considers a file which has several
2251 * hard-linked names as several different files. (Otherwise, we
2252 * could cache our file/directory attributes indefinitely, since
2253 * they can only be changed through the mounted filesystem itself.)
2255 char optstring[256] =
2259 ",default_permissions"
2261 ",entry_timeout=1000000000"
2262 ",negative_timeout=1000000000"
2265 fuse_argv[fuse_argc++] = "-o";
2266 fuse_argv[fuse_argc++] = optstring;
2267 if (!(mount_flags & WIMLIB_MOUNT_FLAG_READWRITE))
2268 strcat(optstring, ",ro");
2269 if (mount_flags & WIMLIB_MOUNT_FLAG_ALLOW_OTHER)
2270 strcat(optstring, ",allow_other");
2271 fuse_argv[fuse_argc] = NULL;
2273 /* Mount our filesystem. */
2274 ret = fuse_main(fuse_argc, fuse_argv, &wimfs_operations, &ctx);
2276 /* Cleanup and return. */
2278 ret = WIMLIB_ERR_FUSE;
2279 release_extra_refcnts(&ctx);
2280 if (mount_flags & WIMLIB_MOUNT_FLAG_READWRITE)
2281 delete_staging_dir(&ctx);
2283 unlock_wim_for_append(wim);
2287 struct commit_progress_thread_args {
2289 wimlib_progress_func_t progfunc;
2294 commit_progress_thread_proc(void *_args)
2296 struct commit_progress_thread_args *args = _args;
2297 struct commit_progress_report report;
2301 ret = mq_receive(args->mq,
2302 (char *)&report, sizeof(report), NULL);
2303 if (ret == sizeof(report)) {
2304 call_progress(args->progfunc, report.msg,
2305 &report.info, args->progctx);
2307 if (ret == 0 || (ret < 0 && errno != EINTR))
2315 generate_message_queue_name(char name[WIMFS_MQUEUE_NAME_LEN + 1])
2318 memcpy(name + 1, "wimfs-", 6);
2319 randomize_char_array_with_alnum(name + 7, WIMFS_MQUEUE_NAME_LEN - 7);
2320 name[WIMFS_MQUEUE_NAME_LEN] = '\0';
2324 create_message_queue(const char *name)
2329 struct mq_attr attr;
2332 memset(&attr, 0, sizeof(attr));
2334 attr.mq_msgsize = sizeof(struct commit_progress_report);
2336 am_root = (geteuid() == 0);
2338 /* Filesystem mounted as normal user with --allow-other should
2339 * be able to send messages to root user, if they're doing the
2341 umask_save = umask(0);
2346 mq = mq_open(name, O_RDWR | O_CREAT | O_EXCL, mode, &attr);
2352 /* Unmount a read-only or read-write mounted WIM image. */
2354 do_unmount(const char *dir)
2359 len = getxattr(dir, "wimfs.unmount", &status, sizeof(int));
2360 if (len == sizeof(int))
2362 else if (len < 0 && (errno == EACCES || errno == EPERM))
2363 return WIMLIB_ERR_NOT_PERMITTED_TO_UNMOUNT;
2365 return WIMLIB_ERR_NOT_A_MOUNTPOINT;
2369 set_unmount_info(const char *dir, const struct wimfs_unmount_info *unmount_info)
2371 if (!setxattr(dir, "wimfs.unmount_info",
2372 unmount_info, sizeof(struct wimfs_unmount_info), 0))
2374 else if (errno == EROFS)
2376 else if (errno == EACCES || errno == EPERM)
2377 return WIMLIB_ERR_NOT_PERMITTED_TO_UNMOUNT;
2379 return WIMLIB_ERR_NOT_A_MOUNTPOINT;
2383 do_unmount_discard(const char *dir)
2386 struct wimfs_unmount_info unmount_info;
2388 memset(&unmount_info, 0, sizeof(unmount_info));
2390 ret = set_unmount_info(dir, &unmount_info);
2393 return do_unmount(dir);
2396 /* Unmount a read-write mounted WIM image, committing the changes. */
2398 do_unmount_commit(const char *dir, int unmount_flags,
2399 wimlib_progress_func_t progfunc, void *progctx)
2401 struct wimfs_unmount_info unmount_info;
2403 struct commit_progress_thread_args args;
2404 pthread_t commit_progress_tid;
2407 memset(&unmount_info, 0, sizeof(unmount_info));
2408 unmount_info.unmount_flags = unmount_flags;
2410 /* The current thread will be stuck in getxattr() until the image is
2411 * committed. Create a thread to handle the progress messages. */
2413 generate_message_queue_name(unmount_info.mq_name);
2415 mq = create_message_queue(unmount_info.mq_name);
2416 if (mq == (mqd_t)-1) {
2417 ERROR_WITH_ERRNO("Can't create POSIX message queue");
2418 return WIMLIB_ERR_MQUEUE;
2421 args.progfunc = progfunc;
2422 args.progctx = progctx;
2423 ret = pthread_create(&commit_progress_tid, NULL,
2424 commit_progress_thread_proc, &args);
2427 ERROR_WITH_ERRNO("Can't create thread");
2428 ret = WIMLIB_ERR_NOMEM;
2431 unmount_info.unmount_flags |= WIMLIB_UNMOUNT_FLAG_SEND_PROGRESS;
2434 ret = set_unmount_info(dir, &unmount_info);
2436 ret = do_unmount(dir);
2438 /* Terminate the progress thread. */
2440 mq_send(mq, empty, 0, 1);
2441 pthread_join(commit_progress_tid, NULL);
2446 mq_unlink(unmount_info.mq_name);
2452 begin_unmount(const char *dir, int unmount_flags, int *mount_flags_ret,
2453 wimlib_progress_func_t progfunc, void *progctx)
2457 int wim_filename_len;
2458 union wimlib_progress_info progress;
2460 if (getxattr(dir, "wimfs.mount_flags",
2461 &mount_flags, sizeof(int)) != sizeof(int))
2462 return WIMLIB_ERR_NOT_A_MOUNTPOINT;
2464 *mount_flags_ret = mount_flags;
2469 if (getxattr(dir, "wimfs.mounted_image",
2470 &mounted_image, sizeof(int)) != sizeof(int))
2471 return WIMLIB_ERR_NOT_A_MOUNTPOINT;
2473 wim_filename_len = getxattr(dir, "wimfs.wim_filename", NULL, 0);
2474 if (wim_filename_len < 0)
2475 return WIMLIB_ERR_NOT_A_MOUNTPOINT;
2477 char wim_filename[wim_filename_len + 1];
2478 if (getxattr(dir, "wimfs.wim_filename",
2479 wim_filename, wim_filename_len) != wim_filename_len)
2480 return WIMLIB_ERR_NOT_A_MOUNTPOINT;
2481 wim_filename[wim_filename_len] = '\0';
2483 progress.unmount.mountpoint = dir;
2484 progress.unmount.mounted_wim = wim_filename;
2485 progress.unmount.mounted_image = mounted_image;
2486 progress.unmount.mount_flags = mount_flags;
2487 progress.unmount.unmount_flags = unmount_flags;
2489 return call_progress(progfunc, WIMLIB_PROGRESS_MSG_UNMOUNT_BEGIN,
2490 &progress, progctx);
2493 /* API function documented in wimlib.h */
2495 wimlib_unmount_image_with_progress(const char *dir, int unmount_flags,
2496 wimlib_progress_func_t progfunc, void *progctx)
2501 ret = wimlib_global_init(WIMLIB_INIT_FLAG_ASSUME_UTF8);
2505 if (unmount_flags & ~(WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY |
2506 WIMLIB_UNMOUNT_FLAG_COMMIT |
2507 WIMLIB_UNMOUNT_FLAG_REBUILD |
2508 WIMLIB_UNMOUNT_FLAG_RECOMPRESS |
2509 WIMLIB_UNMOUNT_FLAG_FORCE |
2510 WIMLIB_UNMOUNT_FLAG_NEW_IMAGE))
2511 return WIMLIB_ERR_INVALID_PARAM;
2513 ret = begin_unmount(dir, unmount_flags, &mount_flags,
2518 if ((unmount_flags & WIMLIB_UNMOUNT_FLAG_COMMIT) &&
2519 (mount_flags & WIMLIB_MOUNT_FLAG_READWRITE))
2520 return do_unmount_commit(dir, unmount_flags,
2523 return do_unmount_discard(dir);
2526 #else /* WITH_FUSE */
2530 mount_unsupported_error(void)
2532 #if defined(__WIN32__)
2533 ERROR("Sorry-- Mounting WIM images is not supported on Windows!");
2535 ERROR("wimlib was compiled with --without-fuse, which disables support "
2536 "for mounting WIMs.");
2538 return WIMLIB_ERR_UNSUPPORTED;
2542 wimlib_unmount_image_with_progress(const tchar *dir, int unmount_flags,
2543 wimlib_progress_func_t progfunc, void *progctx)
2545 return mount_unsupported_error();
2549 wimlib_mount_image(WIMStruct *wim, int image, const tchar *dir,
2550 int mount_flags, const tchar *staging_dir)
2552 return mount_unsupported_error();
2555 #endif /* !WITH_FUSE */
2558 wimlib_unmount_image(const tchar *dir, int unmount_flags)
2560 return wimlib_unmount_image_with_progress(dir, unmount_flags, NULL, NULL);