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/.
38 # error "FUSE mount not supported on Windows! Please configure --without-fuse"
41 #include "wimlib/dentry.h"
42 #include "wimlib/encoding.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,
377 WIMStruct *wim = ctx->wim;
378 struct wim_dentry *dentry;
379 struct wim_lookup_table_entry *lte;
381 const tchar *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 = (tchar*)stream_name - 1;
395 dentry = get_dentry(wim, path, WIMLIB_CASE_SENSITIVE);
401 inode = dentry->d_inode;
403 if (!inode->i_resolved)
404 if (inode_resolve_streams(inode, wim->lookup_table, false))
407 if (!(lookup_flags & LOOKUP_FLAG_DIRECTORY_OK)
408 && inode_is_directory(inode))
412 struct wim_ads_entry *ads_entry;
414 ads_entry = inode_get_ads_entry(inode, stream_name);
418 stream_idx = ads_entry - inode->i_ads_entries + 1;
419 lte = ads_entry->lte;
421 lte = inode_unnamed_stream_resolved(inode, &stream_idx);
424 *dentry_ret = dentry;
428 *stream_idx_ret = stream_idx;
433 * Create a new file in the mounted WIM image.
436 * The FUSE context for the mounted image.
438 * The path at which to create the first link to the new file. If a file
439 * already exists at this path, -EEXIST is returned.
441 * The UNIX mode for the new file. This is only honored if
442 * WIMLIB_MOUNT_FLAG_UNIX_DATA was passed to wimlib_mount_image().
444 * The device ID for the new file, encoding the major and minor device
445 * numbers. This is only honored if WIMLIB_MOUNT_FLAG_UNIX_DATA was passed
446 * to wimlib_mount_image().
448 * Windows file attributes to use for the new file.
450 * On success, a pointer to the new dentry is returned here. Its d_inode
451 * member will point to the new inode that was created for it and added to
452 * the mounted WIM image.
454 * Returns 0 or a -errno code.
457 create_dentry(struct fuse_context *fuse_ctx, const char *path,
458 mode_t mode, dev_t rdev, u32 attributes,
459 struct wim_dentry **dentry_ret)
461 struct wimfs_context *wimfs_ctx = WIMFS_CTX(fuse_ctx);
462 struct wim_dentry *parent;
463 const char *basename;
464 struct wim_dentry *new_dentry;
465 struct wim_inode *new_inode;
467 parent = get_parent_dentry(wimfs_ctx->wim, path, WIMLIB_CASE_SENSITIVE);
471 if (!dentry_is_directory(parent))
474 basename = path_basename(path);
476 if (get_dentry_child_with_name(parent, basename, WIMLIB_CASE_SENSITIVE))
479 if (new_dentry_with_inode(basename, &new_dentry))
482 new_inode = new_dentry->d_inode;
484 new_inode->i_resolved = 1;
485 new_inode->i_ino = wimfs_ctx->next_ino++;
486 new_inode->i_attributes = attributes;
488 if (wimfs_ctx->mount_flags & WIMLIB_MOUNT_FLAG_UNIX_DATA) {
489 struct wimlib_unix_data unix_data;
491 unix_data.uid = fuse_ctx->uid;
492 unix_data.gid = fuse_ctx->gid;
493 unix_data.mode = fuse_mask_mode(mode, fuse_ctx);
494 unix_data.rdev = rdev;
495 if (!inode_set_unix_data(new_inode, &unix_data, UNIX_DATA_ALL))
497 free_dentry(new_dentry);
502 list_add_tail(&new_inode->i_list,
503 &wim_get_current_image_metadata(wimfs_ctx->wim)->inode_list);
505 dentry_add_child(parent, new_dentry);
508 *dentry_ret = new_dentry;
513 * Remove a dentry from the mounted WIM image; i.e. remove an alias for an
517 remove_dentry(struct wim_dentry *dentry,
518 struct wim_lookup_table *lookup_table)
520 /* Drop the reference to each stream the inode contains. */
521 inode_unref_streams(dentry->d_inode, lookup_table);
523 /* Unlink the dentry from the image's dentry tree. */
524 unlink_dentry(dentry);
526 /* Delete the dentry. This will also decrement the link count of the
527 * corresponding inode, and possibly cause it to be deleted as well. */
531 /* Generate UNIX filetype mode bits for the specified WIM inode, based on its
532 * Windows file attributes. */
534 inode_unix_file_type(const struct wim_inode *inode)
536 if (inode_is_symlink(inode))
538 else if (inode_is_directory(inode))
544 /* Generate a default UNIX mode for the specified WIM inode. */
546 inode_default_unix_mode(const struct wim_inode *inode)
548 return inode_unix_file_type(inode) | 0777;
552 * Retrieve standard UNIX metadata ('struct stat') for a WIM inode.
554 * @lte specifies the stream of the inode that is being queried. We mostly
555 * return the same information for all streams, but st_size and st_blocks may be
556 * different for different streams.
558 * This always returns 0.
561 inode_to_stbuf(const struct wim_inode *inode,
562 const struct wim_lookup_table_entry *lte,
565 const struct wimfs_context *ctx = wimfs_get_context();
566 struct wimlib_unix_data unix_data;
568 memset(stbuf, 0, sizeof(struct stat));
569 if ((ctx->mount_flags & WIMLIB_MOUNT_FLAG_UNIX_DATA) &&
570 inode_get_unix_data(inode, &unix_data))
572 /* Use the user ID, group ID, mode, and device ID from the
573 * inode's extra UNIX metadata information. */
574 stbuf->st_uid = unix_data.uid;
575 stbuf->st_gid = unix_data.gid;
576 stbuf->st_mode = unix_data.mode;
577 stbuf->st_rdev = unix_data.rdev;
579 /* Generate default values for the user ID, group ID, and mode.
581 * Note: in the case of an allow_other mount, fuse_context.uid
582 * may not be the same as wimfs_context.owner_uid! */
583 stbuf->st_uid = ctx->owner_uid;
584 stbuf->st_gid = ctx->owner_gid;
585 stbuf->st_mode = inode_default_unix_mode(inode);
587 stbuf->st_ino = inode->i_ino;
588 stbuf->st_nlink = inode->i_nlink;
590 stbuf->st_size = lte->size;
591 #ifdef HAVE_STAT_NANOSECOND_PRECISION
592 stbuf->st_atim = wim_timestamp_to_timespec(inode->i_last_access_time);
593 stbuf->st_mtim = wim_timestamp_to_timespec(inode->i_last_write_time);
594 stbuf->st_ctim = stbuf->st_mtim;
596 stbuf->st_atime = wim_timestamp_to_unix(inode->i_last_access_time);
597 stbuf->st_mtime = wim_timestamp_to_unix(inode->i_last_write_time);
598 stbuf->st_ctime = stbuf->st_mtime;
600 stbuf->st_blocks = (stbuf->st_size + 511) / 512;
604 /* Update the last access and last write timestamps of a WIM inode. */
606 touch_inode(struct wim_inode *inode)
608 u64 now = get_wim_timestamp();
609 inode->i_last_access_time = now;
610 inode->i_last_write_time = now;
614 touch_parent(struct wim_dentry *dentry)
616 touch_inode(dentry->d_parent->d_inode);
620 * Create a new file in the staging directory for a read-write mounted image.
622 * On success, returns the file descriptor for the new staging file, opened for
623 * writing. In addition, stores the allocated name of the staging file in
626 * On failure, returns -1 and sets errno.
629 create_staging_file(const struct wimfs_context *ctx, char **name_ret)
632 static const size_t STAGING_FILE_NAME_LEN = 20;
636 name = MALLOC(STAGING_FILE_NAME_LEN + 1);
639 name[STAGING_FILE_NAME_LEN] = '\0';
642 randomize_char_array_with_alnum(name, STAGING_FILE_NAME_LEN);
643 fd = openat(ctx->staging_dir_fd, name,
644 O_WRONLY | O_CREAT | O_EXCL | O_NOFOLLOW, 0600);
645 if (unlikely(fd < 0)) {
646 if (unlikely(errno == EEXIST))
647 /* Try again with another name. */
657 * Extract a WIM resource to the staging directory.
658 * This is necessary if a stream using the resource is being opened for writing.
661 * The inode containing the stream being opened for writing.
664 * The index of the stream in @inode being opened for writing.
667 * *lte_ptr is the lookup table entry for the stream being extracted, or
668 * NULL if the stream does not have a lookup table entry (which is possible
669 * if the stream is empty). On success, *lte_ptr will be set to point to a
670 * lookup table entry that represents the resource in its new location in a
671 * staging file. This may be the same as the old entry in the case that it
672 * was reused, or it may be a new entry.
675 * Number of bytes of the stream to extract and include in the staging file
676 * resource. It may be less than the actual stream length, in which case
677 * only a prefix of the resource will be extracted. It may also be more
678 * than the actual stream length, in which case the extra space will be
681 * Returns 0 or a -errno code.
684 extract_resource_to_staging_dir(struct wim_inode *inode,
686 struct wim_lookup_table_entry **lte_ptr,
688 const struct wimfs_context *ctx)
690 struct wim_lookup_table_entry *old_lte;
691 struct wim_lookup_table_entry *new_lte;
692 char *staging_file_name;
701 /* Create the staging file. */
702 staging_fd = create_staging_file(ctx, &staging_file_name);
703 if (unlikely(staging_fd < 0))
706 /* Extract the stream to the staging file (possibly truncated). */
710 filedes_init(&fd, staging_fd);
712 extract_size = min(old_lte->size, size);
713 result = extract_stream_to_fd(old_lte, &fd, extract_size);
719 /* In the case of truncate() to more than the file length, extend the
720 * staging file with zeroes by calling ftruncate(). */
721 if (!result && size > extract_size)
722 result = ftruncate(staging_fd, size);
724 /* Close the staging file. */
725 if (close(staging_fd))
728 /* If an error occurred, unlink the staging file. */
729 if (unlikely(result)) {
730 /* extract_stream_to_fd() should set errno, but if it didn't,
731 * set a default value. */
732 ret = errno ? -errno : -EIO;
733 goto out_delete_staging_file;
736 /* Now deal with the lookup table entries. We may be able to re-use the
737 * existing entry, but we may have to create a new one instead. */
739 stream_id = inode_stream_idx_to_id(inode, stream_idx);
741 if (old_lte && inode->i_nlink == old_lte->refcnt) {
742 /* The reference count of the existing lookup table entry is the
743 * same as the link count of the inode that contains the stream
744 * we're opening. Therefore, all the references to the lookup
745 * table entry correspond to the stream we're trying to extract,
746 * so the lookup table entry can be re-used. */
747 lookup_table_unlink(ctx->wim->lookup_table, old_lte);
748 lte_put_resource(old_lte);
751 /* We need to split the old lookup table entry because it also
752 * has other references. Or, there was no old lookup table
753 * entry, so we need to create a new one anyway. */
755 new_lte = new_lookup_table_entry();
756 if (unlikely(!new_lte)) {
758 goto out_delete_staging_file;
761 /* There may already be open file descriptors to this stream if
762 * it's previously been opened read-only, but just now we're
763 * opening it read-write. Identify those file descriptors and
764 * change their lookup table entry pointers to point to the new
765 * lookup table entry, and open staging file descriptors for
768 * At the same time, we need to count the number of these opened
769 * file descriptors to the new lookup table entry. If there's
770 * an old lookup table entry, this number needs to be subtracted
771 * from the fd's opened to the old entry. */
772 for (u16 i = 0, j = 0; j < inode->i_num_opened_fds; i++) {
776 fd = inode->i_fds[i];
782 if (fd->f_stream_id != stream_id)
785 /* This is a readonly fd for the same stream. */
787 new_lte->num_opened_fds++;
788 raw_fd = openat(ctx->staging_dir_fd, staging_file_name,
789 O_RDONLY | O_NOFOLLOW);
790 if (unlikely(raw_fd < 0)) {
792 goto out_revert_fd_changes;
794 filedes_init(&fd->f_staging_fd, raw_fd);
797 old_lte->num_opened_fds -= new_lte->num_opened_fds;
798 old_lte->refcnt -= inode->i_nlink;
802 new_lte->refcnt = inode->i_nlink;
803 new_lte->resource_location = RESOURCE_IN_STAGING_FILE;
804 new_lte->staging_file_name = staging_file_name;
805 new_lte->staging_dir_fd = ctx->staging_dir_fd;
806 new_lte->size = size;
808 add_unhashed_stream(new_lte, inode, stream_id,
809 &wim_get_current_image_metadata(ctx->wim)->unhashed_streams);
811 inode->i_lte = new_lte;
813 inode->i_ads_entries[stream_idx - 1].lte = new_lte;
817 out_revert_fd_changes:
818 for (u16 i = 0; new_lte->num_opened_fds; i++) {
819 struct wimfs_fd *fd = inode->i_fds[i];
820 if (fd && fd->f_stream_id == stream_id) {
822 if (filedes_valid(&fd->f_staging_fd)) {
823 filedes_close(&fd->f_staging_fd);
824 filedes_invalidate(&fd->f_staging_fd);
826 new_lte->num_opened_fds--;
829 free_lookup_table_entry(new_lte);
830 out_delete_staging_file:
831 unlinkat(ctx->staging_dir_fd, staging_file_name, 0);
832 FREE(staging_file_name);
837 * Create the staging directory for the WIM file.
839 * The staging directory will be created in the directory specified by the open
840 * file descriptor @parent_dir_fd. It will be given a randomly generated name
841 * based on @wim_basename, the name of the WIM file.
843 * On success, returns a file descriptor to the open staging directory with
844 * O_RDONLY access. In addition, stores the allocated name of the staging
845 * directory (relative to @parent_dir_fd) in @staging_dir_name_ret.
846 * On failure, returns -1 and sets errno.
849 make_staging_dir_at(int parent_dir_fd, const char *wim_basename,
850 char **staging_dir_name_ret)
852 static const char common_suffix[8] = ".staging";
853 static const size_t random_suffix_len = 10;
854 size_t wim_basename_len;
855 size_t staging_dir_name_len;
856 char *staging_dir_name;
860 wim_basename_len = strlen(wim_basename);
861 staging_dir_name_len = wim_basename_len + sizeof(common_suffix) +
863 staging_dir_name = MALLOC(staging_dir_name_len + 1);
864 if (!staging_dir_name)
867 p = staging_dir_name;
868 p = mempcpy(p, wim_basename, wim_basename_len);
869 p = mempcpy(p, common_suffix, sizeof(common_suffix));
870 randomize_char_array_with_alnum(p, random_suffix_len);
871 p += random_suffix_len;
874 if (mkdirat(parent_dir_fd, staging_dir_name, 0700))
877 fd = openat(parent_dir_fd, staging_dir_name,
878 O_RDONLY | O_DIRECTORY | O_NOFOLLOW);
882 *staging_dir_name_ret = staging_dir_name;
886 unlinkat(parent_dir_fd, staging_dir_name, AT_REMOVEDIR);
888 FREE(staging_dir_name);
893 * Create the staging directory and set ctx->staging_dir_fd,
894 * ctx->staging_dir_name, and ctx->parent_dir_fd.
897 make_staging_dir(struct wimfs_context *ctx, const char *parent_dir_path)
899 const char *wim_basename;
903 wim_basename = path_basename(ctx->wim->filename);
905 if (!parent_dir_path) {
906 /* The user did not specify a directory. Default to creating
907 * the staging directory alongside the WIM file. */
908 if (wim_basename > ctx->wim->filename) {
909 parent_dir_path = ctx->wim->filename;
910 end = (char *)(wim_basename - 1);
911 /* *end must be a slash. Temporarily overwrite it so we
912 * can open the parent directory. */
915 parent_dir_path = ".";
919 /* Open the parent directory (in which we'll create our staging
921 ctx->parent_dir_fd = open(parent_dir_path, O_RDONLY | O_DIRECTORY);
922 if (ctx->parent_dir_fd < 0) {
923 ERROR_WITH_ERRNO("Can't open directory \"%s\"",
925 ret = WIMLIB_ERR_OPENDIR;
926 goto out_restore_wim_filename;
929 ctx->staging_dir_fd = make_staging_dir_at(ctx->parent_dir_fd,
931 &ctx->staging_dir_name);
932 if (ctx->staging_dir_fd < 0) {
933 ERROR_WITH_ERRNO("Can't create staging directory in \"%s\"",
935 close(ctx->parent_dir_fd);
936 ret = WIMLIB_ERR_MKDIR;
937 goto out_restore_wim_filename;
940 out_restore_wim_filename:
946 /* Deletes the staging directory, undoing the effects of a succesful call to
947 * make_staging_dir(). */
949 delete_staging_dir(struct wimfs_context *ctx)
954 dir = fdopendir(ctx->staging_dir_fd);
956 while ((ent = readdir(dir)))
957 unlinkat(ctx->staging_dir_fd, ent->d_name, 0);
960 close(ctx->staging_dir_fd);
962 if (unlinkat(ctx->parent_dir_fd, ctx->staging_dir_name, AT_REMOVEDIR))
963 WARNING_WITH_ERRNO("Could not delete staging directory");
964 FREE(ctx->staging_dir_name);
965 close(ctx->parent_dir_fd);
969 reassign_inode_numbers(struct wimfs_context *ctx)
971 struct wim_image_metadata *imd;
972 struct wim_inode *inode;
975 imd = wim_get_current_image_metadata(ctx->wim);
976 image_for_each_inode(inode, imd)
977 inode->i_ino = ctx->next_ino++;
981 release_extra_refcnts(struct wimfs_context *ctx)
983 struct list_head *list = &ctx->orig_stream_list;
984 struct wim_lookup_table *lookup_table = ctx->wim->lookup_table;
985 struct wim_lookup_table_entry *lte, *tmp;
987 list_for_each_entry_safe(lte, tmp, list, orig_stream_list) {
988 u32 n = lte->out_refcnt;
990 lte_decrement_refcnt(lte, lookup_table);
995 delete_empty_streams(struct wimfs_context *ctx)
997 struct wim_lookup_table_entry *lte, *tmp;
998 struct wim_image_metadata *imd;
1000 imd = wim_get_current_image_metadata(ctx->wim);
1002 image_for_each_unhashed_stream_safe(lte, tmp, imd) {
1004 *retrieve_lte_pointer(lte) = NULL;
1005 list_del(<e->unhashed_list);
1006 free_lookup_table_entry(lte);
1012 inode_close_fds(struct wim_inode *inode)
1014 u16 num_open_fds = inode->i_num_opened_fds;
1015 for (u16 i = 0; num_open_fds; i++) {
1016 if (inode->i_fds[i]) {
1017 close_wimfs_fd(inode->i_fds[i]);
1024 close_all_fds(struct wimfs_context *ctx)
1026 struct wim_inode *inode, *tmp;
1027 struct wim_image_metadata *imd;
1029 imd = wim_get_current_image_metadata(ctx->wim);
1031 list_for_each_entry_safe(inode, tmp, &imd->inode_list, i_list)
1032 inode_close_fds(inode);
1035 /* Moves the currently selected image, which may have been modified, to a new
1036 * index, and sets the original index to refer to a reset (unmodified) copy of
1039 renew_current_image(struct wimfs_context *ctx)
1041 WIMStruct *wim = ctx->wim;
1042 int idx = wim->current_image - 1;
1043 struct wim_image_metadata *imd = wim->image_metadata[idx];
1044 struct wim_image_metadata *replace_imd;
1045 struct wim_lookup_table_entry *new_lte;
1048 /* Create 'replace_imd' structure to use for the reset original,
1049 * unmodified image. */
1050 ret = WIMLIB_ERR_NOMEM;
1051 replace_imd = new_image_metadata();
1055 /* Create new stream reference for the modified image's metadata
1056 * resource, which doesn't exist yet. */
1057 ret = WIMLIB_ERR_NOMEM;
1058 new_lte = new_lookup_table_entry();
1060 goto err_put_replace_imd;
1061 new_lte->flags = WIM_RESHDR_FLAG_METADATA;
1062 new_lte->unhashed = 1;
1064 /* Make the image being moved available at a new index. Increments the
1065 * WIM's image count, but does not increment the reference count of the
1066 * 'struct image_metadata'. */
1067 ret = append_image_metadata(wim, imd);
1069 goto err_free_new_lte;
1071 ret = xml_add_image(wim, T(""));
1073 goto err_undo_append;
1075 replace_imd->metadata_lte = imd->metadata_lte;
1076 imd->metadata_lte = new_lte;
1077 wim->image_metadata[idx] = replace_imd;
1078 wim->current_image = wim->hdr.image_count;
1082 wim->hdr.image_count--;
1084 free_lookup_table_entry(new_lte);
1085 err_put_replace_imd:
1086 put_image_metadata(replace_imd, NULL);
1091 static enum wimlib_progress_status
1092 commit_progress_func(enum wimlib_progress_msg msg,
1093 union wimlib_progress_info *info, void *progctx)
1095 mqd_t mq = *(mqd_t *)progctx;
1096 struct commit_progress_report report;
1098 memset(&report, 0, sizeof(report));
1101 report.info = *info;
1102 mq_send(mq, (const char *)&report, sizeof(report), 1);
1103 return WIMLIB_PROGRESS_STATUS_CONTINUE;
1106 /* Commit the mounted image to the underlying WIM file. */
1108 commit_image(struct wimfs_context *ctx, int unmount_flags, mqd_t mq)
1112 if (unmount_flags & WIMLIB_UNMOUNT_FLAG_SEND_PROGRESS)
1113 wimlib_register_progress_function(ctx->wim,
1114 commit_progress_func, &mq);
1116 wimlib_register_progress_function(ctx->wim, NULL, NULL);
1118 if (unmount_flags & WIMLIB_UNMOUNT_FLAG_NEW_IMAGE) {
1119 int ret = renew_current_image(ctx);
1123 release_extra_refcnts(ctx);
1125 INIT_LIST_HEAD(&ctx->orig_stream_list);
1126 delete_empty_streams(ctx);
1127 xml_update_image_info(ctx->wim, ctx->wim->current_image);
1130 if (unmount_flags & WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY)
1131 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
1132 if (unmount_flags & WIMLIB_UNMOUNT_FLAG_REBUILD)
1133 write_flags |= WIMLIB_WRITE_FLAG_REBUILD;
1134 if (unmount_flags & WIMLIB_UNMOUNT_FLAG_RECOMPRESS)
1135 write_flags |= WIMLIB_WRITE_FLAG_RECOMPRESS;
1136 return wimlib_overwrite(ctx->wim, write_flags, 0);
1139 /* In the case of an allow_other mount, only the owner and root should be
1140 * allowed to unmount the filesystem. */
1142 may_unmount_wimfs(void)
1144 const struct fuse_context *fuse_ctx = fuse_get_context();
1145 const struct wimfs_context *wimfs_ctx = WIMFS_CTX(fuse_ctx);
1147 return (fuse_ctx->uid == wimfs_ctx->owner_uid ||
1148 fuse_ctx->uid == 0);
1154 struct fuse_context *fuse_ctx = fuse_get_context();
1155 struct wimfs_context *wimfs_ctx = WIMFS_CTX(fuse_ctx);
1156 const struct wimfs_unmount_info *info = &wimfs_ctx->unmount_info;
1157 int unmount_flags = info->unmount_flags;
1158 mqd_t mq = (mqd_t)-1;
1161 /* Ignore COMMIT if the image is mounted read-only. */
1162 if (!(wimfs_ctx->mount_flags & WIMLIB_MOUNT_FLAG_READWRITE))
1163 unmount_flags &= ~WIMLIB_UNMOUNT_FLAG_COMMIT;
1165 if (unmount_flags & WIMLIB_UNMOUNT_FLAG_SEND_PROGRESS) {
1166 mq = mq_open(info->mq_name, O_WRONLY | O_NONBLOCK);
1167 if (mq == (mqd_t)-1) {
1168 ret = WIMLIB_ERR_MQUEUE;
1173 if (wimfs_ctx->num_open_fds) {
1174 if ((unmount_flags & (WIMLIB_UNMOUNT_FLAG_COMMIT |
1175 WIMLIB_UNMOUNT_FLAG_FORCE))
1176 == WIMLIB_UNMOUNT_FLAG_COMMIT)
1178 ret = WIMLIB_ERR_MOUNTED_IMAGE_IS_BUSY;
1181 close_all_fds(wimfs_ctx);
1184 if (unmount_flags & WIMLIB_UNMOUNT_FLAG_COMMIT)
1185 ret = commit_image(wimfs_ctx, unmount_flags, mq);
1189 /* Leave the image mounted if commit failed, unless this is a
1190 * forced unmount. The user can retry without commit if they
1192 if (!ret || (unmount_flags & WIMLIB_UNMOUNT_FLAG_FORCE))
1193 fuse_exit(fuse_ctx->fuse);
1194 if (mq != (mqd_t)-1)
1200 wimfs_chmod(const char *path, mode_t mask)
1202 const struct wimfs_context *ctx = wimfs_get_context();
1203 struct wim_inode *inode;
1204 struct wimlib_unix_data unix_data;
1206 if (!(ctx->mount_flags & WIMLIB_MOUNT_FLAG_UNIX_DATA))
1209 inode = wim_pathname_to_inode(ctx->wim, path);
1213 unix_data.uid = ctx->owner_uid;
1214 unix_data.gid = ctx->owner_gid;
1215 unix_data.mode = mask;
1218 if (!inode_set_unix_data(inode, &unix_data, UNIX_DATA_MODE))
1225 wimfs_chown(const char *path, uid_t uid, gid_t gid)
1227 const struct wimfs_context *ctx = wimfs_get_context();
1228 struct wim_inode *inode;
1229 struct wimlib_unix_data unix_data;
1232 if (!(ctx->mount_flags & WIMLIB_MOUNT_FLAG_UNIX_DATA))
1235 inode = wim_pathname_to_inode(ctx->wim, path);
1241 if (uid != (uid_t)-1)
1242 which |= UNIX_DATA_UID;
1244 uid = ctx->owner_uid;
1246 if (gid != (gid_t)-1)
1247 which |= UNIX_DATA_GID;
1249 gid = ctx->owner_gid;
1251 unix_data.uid = uid;
1252 unix_data.gid = gid;
1253 unix_data.mode = inode_default_unix_mode(inode);
1256 if (!inode_set_unix_data(inode, &unix_data, which))
1263 wimfs_fgetattr(const char *path, struct stat *stbuf, struct fuse_file_info *fi)
1265 struct wimfs_fd *fd = WIMFS_FD(fi);
1266 return inode_to_stbuf(fd->f_inode, fd->f_lte, stbuf);
1270 wimfs_ftruncate(const char *path, off_t size, struct fuse_file_info *fi)
1272 struct wimfs_fd *fd = WIMFS_FD(fi);
1273 if (ftruncate(fd->f_staging_fd.fd, size))
1275 touch_inode(fd->f_inode);
1276 fd->f_lte->size = size;
1281 wimfs_getattr(const char *path, struct stat *stbuf)
1283 const struct wimfs_context *ctx = wimfs_get_context();
1284 struct wim_dentry *dentry;
1285 struct wim_lookup_table_entry *lte;
1288 ret = wim_pathname_to_stream(ctx, path, LOOKUP_FLAG_DIRECTORY_OK,
1289 &dentry, <e, NULL);
1292 return inode_to_stbuf(dentry->d_inode, lte, stbuf);
1296 copy_xattr(char *dest, size_t destsize, const void *src, size_t srcsize)
1300 if (destsize < srcsize)
1302 memcpy(dest, src, srcsize);
1307 wimfs_getxattr(const char *path, const char *name, char *value,
1310 const struct wimfs_context *ctx = wimfs_get_context();
1311 struct wim_inode *inode;
1312 struct wim_ads_entry *ads_entry;
1313 struct wim_lookup_table_entry *lte;
1315 if (!strncmp(name, "wimfs.", 6)) {
1316 /* Handle some magical extended attributes. These really should
1317 * be ioctls, but directory ioctls aren't supported until
1318 * libfuse 2.9, and even then they are broken. */
1320 if (!strcmp(name, "wim_filename")) {
1321 return copy_xattr(value, size, ctx->wim->filename,
1322 strlen(ctx->wim->filename));
1324 if (!strcmp(name, "wim_info")) {
1325 struct wimlib_wim_info info;
1327 wimlib_get_wim_info(ctx->wim, &info);
1329 return copy_xattr(value, size, &info, sizeof(info));
1331 if (!strcmp(name, "mounted_image")) {
1332 return copy_xattr(value, size,
1333 &ctx->wim->current_image, sizeof(int));
1335 if (!strcmp(name, "mount_flags")) {
1336 return copy_xattr(value, size,
1337 &ctx->mount_flags, sizeof(int));
1339 if (!strcmp(name, "unmount")) {
1340 if (!may_unmount_wimfs())
1345 if (size < sizeof(int))
1347 status = unmount_wimfs();
1348 memcpy(value, &status, sizeof(int));
1355 if (!(ctx->mount_flags & WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR))
1358 if (strncmp(name, "user.", 5))
1362 /* Querying a named data stream */
1364 inode = wim_pathname_to_inode(ctx->wim, path);
1368 ads_entry = inode_get_ads_entry(inode, name);
1370 return (errno == ENOENT) ? -ENOATTR : -errno;
1372 lte = ads_entry->lte;
1376 if (unlikely(lte->size > INT_MAX))
1380 if (lte->size > size)
1383 if (read_full_stream_into_buf(lte, value))
1390 wimfs_link(const char *existing_path, const char *new_path)
1392 WIMStruct *wim = wimfs_get_WIMStruct();
1393 const char *new_name;
1394 struct wim_inode *inode;
1395 struct wim_dentry *dir;
1396 struct wim_dentry *new_alias;
1398 inode = wim_pathname_to_inode(wim, existing_path);
1402 if (inode->i_attributes & (FILE_ATTRIBUTE_DIRECTORY |
1403 FILE_ATTRIBUTE_REPARSE_POINT))
1406 new_name = path_basename(new_path);
1408 dir = get_parent_dentry(wim, new_path, WIMLIB_CASE_SENSITIVE);
1412 if (!dentry_is_directory(dir))
1415 if (get_dentry_child_with_name(dir, new_name, WIMLIB_CASE_SENSITIVE))
1418 if (new_dentry(new_name, &new_alias))
1421 new_alias->d_inode = inode;
1422 inode_add_dentry(new_alias, inode);
1423 dentry_add_child(dir, new_alias);
1424 touch_inode(dir->d_inode);
1426 inode_ref_streams(inode);
1431 wimfs_listxattr(const char *path, char *list, size_t size)
1433 const struct wimfs_context *ctx = wimfs_get_context();
1434 const struct wim_inode *inode;
1436 char *end = list + size;
1439 if (!(ctx->mount_flags & WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR))
1442 /* List named data streams, or get the list size. We report each named
1443 * data stream "X" as an extended attribute "user.X". */
1445 inode = wim_pathname_to_inode(ctx->wim, path);
1449 for (u16 i = 0; i < inode->i_num_ads; i++) {
1450 const struct wim_ads_entry *entry;
1451 char *stream_name_mbs;
1452 size_t stream_name_mbs_nbytes;
1454 entry = &inode->i_ads_entries[i];
1456 if (!entry->stream_name_nbytes)
1459 if (utf16le_to_tstr(entry->stream_name,
1460 entry->stream_name_nbytes,
1462 &stream_name_mbs_nbytes))
1465 if (unlikely(INT_MAX - total_size < stream_name_mbs_nbytes + 6)) {
1466 FREE(stream_name_mbs);
1470 total_size += stream_name_mbs_nbytes + 6;
1472 if (end - p < stream_name_mbs_nbytes + 6) {
1473 FREE(stream_name_mbs);
1476 p = mempcpy(p, "user.", 5);
1477 p = mempcpy(p, stream_name_mbs, stream_name_mbs_nbytes);
1480 FREE(stream_name_mbs);
1486 wimfs_mkdir(const char *path, mode_t mode)
1488 struct wim_dentry *dentry;
1491 /* Note: according to fuse.h, mode may not include S_IFDIR */
1492 ret = create_dentry(fuse_get_context(), path, mode | S_IFDIR, 0,
1493 FILE_ATTRIBUTE_DIRECTORY, &dentry);
1496 touch_parent(dentry);
1501 wimfs_mknod(const char *path, mode_t mode, dev_t rdev)
1503 struct fuse_context *fuse_ctx = fuse_get_context();
1504 struct wimfs_context *wimfs_ctx = WIMFS_CTX(fuse_ctx);
1505 const char *stream_name;
1507 if ((wimfs_ctx->mount_flags & WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS)
1508 && (stream_name = path_stream_name(path)))
1510 struct wim_ads_entry *old_entry;
1511 struct wim_ads_entry *new_entry;
1512 struct wim_inode *inode;
1515 /* Create a named data stream. */
1520 p = (char *)stream_name - 1;
1523 inode = wim_pathname_to_inode(wimfs_ctx->wim, path);
1528 old_entry = inode_get_ads_entry(inode, stream_name);
1531 if (errno != ENOENT)
1534 new_entry = inode_add_ads(inode, stream_name);
1539 /* Create a regular file, device node, named pipe, or socket.
1541 struct wim_dentry *dentry;
1544 if (!S_ISREG(mode) &&
1545 !(wimfs_ctx->mount_flags & WIMLIB_MOUNT_FLAG_UNIX_DATA))
1548 /* Note: we still use FILE_ATTRIBUTE_NORMAL for device nodes,
1549 * named pipes, and sockets. The real mode is in the UNIX
1551 ret = create_dentry(fuse_ctx, path, mode, rdev,
1552 FILE_ATTRIBUTE_NORMAL, &dentry);
1555 touch_parent(dentry);
1561 wimfs_open(const char *path, struct fuse_file_info *fi)
1563 struct wimfs_context *ctx = wimfs_get_context();
1564 struct wim_dentry *dentry;
1565 struct wim_inode *inode;
1566 struct wim_lookup_table_entry *lte;
1568 struct wimfs_fd *fd;
1571 ret = wim_pathname_to_stream(ctx, path, 0, &dentry, <e, &stream_idx);
1575 inode = dentry->d_inode;
1577 /* The file resource may be in the staging directory (read-write mounts
1578 * only) or in the WIM. If it's in the staging directory, we need to
1579 * open a native file descriptor for the corresponding file. Otherwise,
1580 * we can read the file resource directly from the WIM file if we are
1581 * opening it read-only, but we need to extract the resource to the
1582 * staging directory if we are opening it writable. */
1584 if (flags_writable(fi->flags) &&
1585 (!lte || lte->resource_location != RESOURCE_IN_STAGING_FILE)) {
1586 ret = extract_resource_to_staging_dir(inode,
1589 lte ? lte->size : 0,
1595 ret = alloc_wimfs_fd(inode, inode_stream_idx_to_id(inode, stream_idx),
1600 if (lte && lte->resource_location == RESOURCE_IN_STAGING_FILE) {
1603 raw_fd = openat(lte->staging_dir_fd, lte->staging_file_name,
1604 (fi->flags & O_ACCMODE) | O_NOFOLLOW);
1609 filedes_init(&fd->f_staging_fd, raw_fd);
1611 fi->fh = (uintptr_t)fd;
1616 wimfs_opendir(const char *path, struct fuse_file_info *fi)
1618 WIMStruct *wim = wimfs_get_WIMStruct();
1619 struct wim_inode *inode;
1620 struct wimfs_fd *fd;
1623 inode = wim_pathname_to_inode(wim, path);
1626 if (!inode_is_directory(inode))
1628 ret = alloc_wimfs_fd(inode, 0, NULL, &fd);
1631 fi->fh = (uintptr_t)fd;
1636 wimfs_read(const char *path, char *buf, size_t size,
1637 off_t offset, struct fuse_file_info *fi)
1639 struct wimfs_fd *fd = WIMFS_FD(fi);
1640 const struct wim_lookup_table_entry *lte;
1647 if (offset >= lte->size)
1650 if (size > lte->size - offset)
1651 size = lte->size - offset;
1656 switch (lte->resource_location) {
1657 case RESOURCE_IN_WIM:
1658 if (read_partial_wim_stream_into_buf(lte, size, offset, buf))
1663 case RESOURCE_IN_STAGING_FILE:
1664 ret = raw_pread(&fd->f_staging_fd, buf, size, offset);
1668 case RESOURCE_IN_ATTACHED_BUFFER:
1669 memcpy(buf, lte->attached_buffer + offset, size);
1680 wimfs_readdir(const char *path, void *buf, fuse_fill_dir_t filler,
1681 off_t offset, struct fuse_file_info *fi)
1683 struct wimfs_fd *fd = WIMFS_FD(fi);
1684 const struct wim_inode *inode;
1685 const struct wim_dentry *child;
1688 inode = fd->f_inode;
1690 ret = filler(buf, ".", NULL, 0);
1693 ret = filler(buf, "..", NULL, 0);
1697 for_inode_child(child, inode) {
1698 char *file_name_mbs;
1699 size_t file_name_mbs_nbytes;
1701 ret = utf16le_to_tstr(child->file_name,
1702 child->file_name_nbytes,
1704 &file_name_mbs_nbytes);
1708 ret = filler(buf, file_name_mbs, NULL, 0);
1709 FREE(file_name_mbs);
1717 wimfs_readlink(const char *path, char *buf, size_t buf_len)
1719 WIMStruct *wim = wimfs_get_WIMStruct();
1720 const struct wim_inode *inode;
1723 inode = wim_pathname_to_inode(wim, path);
1726 if (!inode_is_symlink(inode))
1730 ret = wim_inode_readlink(inode, buf, buf_len - 1, NULL);
1734 } else if (ret == -ENAMETOOLONG) {
1735 buf[buf_len - 1] = '\0';
1740 /* We use this for both release() and releasedir(), since in both cases we
1741 * simply need to close the file descriptor. */
1743 wimfs_release(const char *path, struct fuse_file_info *fi)
1745 return close_wimfs_fd(WIMFS_FD(fi));
1749 wimfs_removexattr(const char *path, const char *name)
1751 struct wimfs_context *ctx = wimfs_get_context();
1752 struct wim_inode *inode;
1753 struct wim_ads_entry *ads_entry;
1755 if (!(ctx->mount_flags & WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR))
1758 if (strncmp(name, "user.", 5))
1762 /* Removing a named data stream. */
1764 inode = wim_pathname_to_inode(ctx->wim, path);
1768 ads_entry = inode_get_ads_entry(inode, name);
1770 return (errno == ENOENT) ? -ENOATTR : -errno;
1772 inode_remove_ads(inode, ads_entry, ctx->wim->lookup_table);
1777 wimfs_rename(const char *from, const char *to)
1779 return rename_wim_path(wimfs_get_WIMStruct(), from, to,
1780 WIMLIB_CASE_SENSITIVE, NULL);
1784 wimfs_rmdir(const char *path)
1786 WIMStruct *wim = wimfs_get_WIMStruct();
1787 struct wim_dentry *dentry;
1789 dentry = get_dentry(wim, path, WIMLIB_CASE_SENSITIVE);
1793 if (!dentry_is_directory(dentry))
1796 if (dentry_has_children(dentry))
1799 touch_parent(dentry);
1800 remove_dentry(dentry, wim->lookup_table);
1805 wimfs_setxattr(const char *path, const char *name,
1806 const char *value, size_t size, int flags)
1808 struct wimfs_context *ctx = wimfs_get_context();
1809 struct wim_inode *inode;
1810 struct wim_ads_entry *existing_entry;
1812 if (!strncmp(name, "wimfs.", 6)) {
1813 /* Handle some magical extended attributes. These really should
1814 * be ioctls, but directory ioctls aren't supported until
1815 * libfuse 2.9, and even then they are broken. */
1817 if (!strcmp(name, "unmount_info")) {
1818 if (!may_unmount_wimfs())
1820 if (size < sizeof(struct wimfs_unmount_info))
1822 memcpy(&ctx->unmount_info, value,
1823 sizeof(struct wimfs_unmount_info));
1829 if (!(ctx->mount_flags & WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR))
1832 if (strncmp(name, "user.", 5))
1836 /* Setting the contents of a named data stream. */
1838 inode = wim_pathname_to_inode(ctx->wim, path);
1842 existing_entry = inode_get_ads_entry(inode, name);
1843 if (existing_entry) {
1844 if (flags & XATTR_CREATE)
1847 if (errno != ENOENT)
1849 if (flags & XATTR_REPLACE)
1853 if (!inode_add_ads_with_data(inode, name, value,
1854 size, ctx->wim->lookup_table))
1857 inode_remove_ads(inode, existing_entry, ctx->wim->lookup_table);
1862 wimfs_symlink(const char *to, const char *from)
1864 struct fuse_context *fuse_ctx = fuse_get_context();
1865 struct wimfs_context *wimfs_ctx = WIMFS_CTX(fuse_ctx);
1866 struct wim_dentry *dentry;
1869 ret = create_dentry(fuse_ctx, from, S_IFLNK | 0777, 0,
1870 FILE_ATTRIBUTE_REPARSE_POINT, &dentry);
1873 dentry->d_inode->i_reparse_tag = WIM_IO_REPARSE_TAG_SYMLINK;
1874 ret = wim_inode_set_symlink(dentry->d_inode, to,
1875 wimfs_ctx->wim->lookup_table);
1877 remove_dentry(dentry, wimfs_ctx->wim->lookup_table);
1878 if (ret == WIMLIB_ERR_NOMEM)
1883 touch_parent(dentry);
1889 wimfs_truncate(const char *path, off_t size)
1891 const struct wimfs_context *ctx = wimfs_get_context();
1892 struct wim_dentry *dentry;
1893 struct wim_lookup_table_entry *lte;
1898 ret = wim_pathname_to_stream(ctx, path, 0, &dentry, <e, &stream_idx);
1905 if (!lte || lte->resource_location != RESOURCE_IN_STAGING_FILE) {
1906 return extract_resource_to_staging_dir(dentry->d_inode,
1911 /* Truncate the staging file. */
1912 fd = openat(lte->staging_dir_fd, lte->staging_file_name,
1913 O_WRONLY | O_NOFOLLOW);
1916 ret = ftruncate(fd, size);
1917 if (close(fd) || ret)
1924 wimfs_unlink(const char *path)
1926 const struct wimfs_context *ctx = wimfs_get_context();
1927 struct wim_dentry *dentry;
1931 ret = wim_pathname_to_stream(ctx, path, 0, &dentry, NULL, &stream_idx);
1935 if (inode_stream_name_nbytes(dentry->d_inode, stream_idx) == 0) {
1936 touch_parent(dentry);
1937 remove_dentry(dentry, ctx->wim->lookup_table);
1939 inode_remove_ads(dentry->d_inode,
1940 &dentry->d_inode->i_ads_entries[stream_idx - 1],
1941 ctx->wim->lookup_table);
1946 #ifdef HAVE_UTIMENSAT
1948 * Change the timestamp on a file dentry.
1950 * Note that alternate data streams do not have their own timestamps.
1953 wimfs_utimens(const char *path, const struct timespec tv[2])
1955 WIMStruct *wim = wimfs_get_WIMStruct();
1956 struct wim_inode *inode;
1958 inode = wim_pathname_to_inode(wim, path);
1962 if (tv[0].tv_nsec != UTIME_OMIT) {
1963 if (tv[0].tv_nsec == UTIME_NOW)
1964 inode->i_last_access_time = get_wim_timestamp();
1966 inode->i_last_access_time = timespec_to_wim_timestamp(tv[0]);
1968 if (tv[1].tv_nsec != UTIME_OMIT) {
1969 if (tv[1].tv_nsec == UTIME_NOW)
1970 inode->i_last_write_time = get_wim_timestamp();
1972 inode->i_last_write_time = timespec_to_wim_timestamp(tv[1]);
1976 #else /* HAVE_UTIMENSAT */
1978 wimfs_utime(const char *path, struct utimbuf *times)
1980 WIMStruct *wim = wimfs_get_WIMStruct();
1981 struct wim_inode *inode;
1983 inode = wim_pathname_to_inode(wim, path);
1987 inode->i_last_access_time = unix_timestamp_to_wim(times->actime);
1988 inode->i_last_write_time = unix_timestamp_to_wim(times->modtime);
1991 #endif /* !HAVE_UTIMENSAT */
1994 wimfs_write(const char *path, const char *buf, size_t size,
1995 off_t offset, struct fuse_file_info *fi)
1997 struct wimfs_fd *fd = WIMFS_FD(fi);
2000 ret = raw_pwrite(&fd->f_staging_fd, buf, size, offset);
2004 if (offset + size > fd->f_lte->size)
2005 fd->f_lte->size = offset + size;
2007 touch_inode(fd->f_inode);
2011 static struct fuse_operations wimfs_operations = {
2012 .chmod = wimfs_chmod,
2013 .chown = wimfs_chown,
2014 .fgetattr = wimfs_fgetattr,
2015 .ftruncate = wimfs_ftruncate,
2016 .getattr = wimfs_getattr,
2017 .getxattr = wimfs_getxattr,
2019 .listxattr = wimfs_listxattr,
2020 .mkdir = wimfs_mkdir,
2021 .mknod = wimfs_mknod,
2023 .opendir = wimfs_opendir,
2025 .readdir = wimfs_readdir,
2026 .readlink = wimfs_readlink,
2027 .release = wimfs_release,
2028 .releasedir = wimfs_release,
2029 .removexattr = wimfs_removexattr,
2030 .rename = wimfs_rename,
2031 .rmdir = wimfs_rmdir,
2032 .setxattr = wimfs_setxattr,
2033 .symlink = wimfs_symlink,
2034 .truncate = wimfs_truncate,
2035 .unlink = wimfs_unlink,
2036 #ifdef HAVE_UTIMENSAT
2037 .utimens = wimfs_utimens,
2039 .utime = wimfs_utime,
2041 .write = wimfs_write,
2043 /* We keep track of file descriptor structures (struct wimfs_fd), so
2044 * there is no need to have the file path provided on operations such as
2046 #if FUSE_MAJOR_VERSION > 2 || (FUSE_MAJOR_VERSION == 2 && FUSE_MINOR_VERSION >= 8)
2047 .flag_nullpath_ok = 1,
2049 #if FUSE_MAJOR_VERSION > 2 || (FUSE_MAJOR_VERSION == 2 && FUSE_MINOR_VERSION >= 9)
2051 .flag_utime_omit_ok = 1,
2055 /* API function documented in wimlib.h */
2057 wimlib_mount_image(WIMStruct *wim, int image, const char *dir,
2058 int mount_flags, const char *staging_dir)
2061 struct wim_image_metadata *imd;
2062 struct wimfs_context ctx;
2063 char *fuse_argv[16];
2066 if (!wim || !dir || !*dir)
2067 return WIMLIB_ERR_INVALID_PARAM;
2069 if (mount_flags & ~(WIMLIB_MOUNT_FLAG_READWRITE |
2070 WIMLIB_MOUNT_FLAG_DEBUG |
2071 WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE |
2072 WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR |
2073 WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS |
2074 WIMLIB_MOUNT_FLAG_UNIX_DATA |
2075 WIMLIB_MOUNT_FLAG_ALLOW_OTHER))
2076 return WIMLIB_ERR_INVALID_PARAM;
2078 /* For read-write mount, check for write access to the WIM. */
2079 if (mount_flags & WIMLIB_MOUNT_FLAG_READWRITE) {
2080 ret = can_delete_from_wim(wim);
2085 /* Select the image to mount. */
2086 ret = select_wim_image(wim, image);
2090 /* Get the metadata for the image to mount. */
2091 imd = wim_get_current_image_metadata(wim);
2093 if (imd->modified) {
2094 /* To avoid complicating things, we don't support mounting
2095 * images to which in-memory modifications have already been
2097 ERROR("Cannot mount a modified WIM image!");
2098 return WIMLIB_ERR_INVALID_PARAM;
2101 ret = lock_wim_for_append(wim, wim->in_fd.fd);
2105 /* If the user did not specify an interface for accessing named
2106 * data streams, use the default (extended attributes). */
2107 if (!(mount_flags & (WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE |
2108 WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR |
2109 WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS)))
2110 mount_flags |= WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR;
2112 /* Start initializing the wimfs_context. */
2113 memset(&ctx, 0, sizeof(struct wimfs_context));
2115 ctx.mount_flags = mount_flags;
2116 if (mount_flags & WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS)
2117 ctx.default_lookup_flags = LOOKUP_FLAG_ADS_OK;
2118 /* For read-write mount, create the staging directory. */
2119 if (mount_flags & WIMLIB_MOUNT_FLAG_READWRITE) {
2120 ret = make_staging_dir(&ctx, staging_dir);
2124 ctx.owner_uid = getuid();
2125 ctx.owner_gid = getgid();
2127 /* Add each stream referenced by files in the image to a list and
2128 * preemptively double the number of references to each. This is done
2129 * to allow implementing the WIMLIB_UNMOUNT_FLAG_NEW_IMAGE semantics.
2131 INIT_LIST_HEAD(&ctx.orig_stream_list);
2132 if (mount_flags & WIMLIB_MOUNT_FLAG_READWRITE) {
2134 struct wim_inode *inode;
2135 struct wim_lookup_table_entry *lte;
2137 image_for_each_inode(inode, imd) {
2138 for (i = 0; i <= inode->i_num_ads; i++) {
2139 lte = inode_stream_lte(inode, i,
2142 lte->out_refcnt = 0;
2146 image_for_each_inode(inode, imd) {
2147 for (i = 0; i <= inode->i_num_ads; i++) {
2148 lte = inode_stream_lte(inode, i,
2151 if (lte->out_refcnt == 0)
2152 list_add(<e->orig_stream_list,
2153 &ctx.orig_stream_list);
2154 lte->out_refcnt += inode->i_nlink;
2155 lte->refcnt += inode->i_nlink;
2161 /* Assign new inode numbers. */
2162 reassign_inode_numbers(&ctx);
2164 /* If a read-write mount, mark the image as modified. */
2165 if (mount_flags & WIMLIB_MOUNT_FLAG_READWRITE)
2168 /* Build the FUSE command line. */
2171 fuse_argv[fuse_argc++] = "wimlib";
2172 fuse_argv[fuse_argc++] = (char *)dir;
2174 /* Disable multi-threaded operation. */
2175 fuse_argv[fuse_argc++] = "-s";
2177 /* Enable FUSE debug mode (don't fork) if requested by the user. */
2178 if (mount_flags & WIMLIB_MOUNT_FLAG_DEBUG)
2179 fuse_argv[fuse_argc++] = "-d";
2182 * Build the FUSE mount options:
2185 * FUSE will use the inode numbers we provide. We want this,
2186 * because we have inodes and will number them ourselves.
2189 * Name for our filesystem (main type is "fuse").
2192 * If an open file is unlinked, unlink it for real rather than
2193 * renaming it to a hidden file. Our code supports this; an
2194 * unlinked inode is retained until all its file descriptors have
2197 * default_permissions
2198 * FUSE will perform permission checking. Useful when
2199 * WIMLIB_MOUNT_FLAG_UNIX_DATA is provided and the WIM image
2200 * contains the UNIX permissions for each file.
2203 * Cache the contents of files. This will speed up repeated access
2204 * to files on a mounted WIM image, since they won't need to be
2205 * decompressed repeatedly. This option is valid because data in
2206 * the WIM image should never be changed externally. (Although, if
2207 * someone really wanted to they could modify the WIM file or mess
2208 * with the staging directory; but then they're asking for
2211 * entry_timeout=1000000000
2212 * Cache positive name lookups indefinitely, since names can only
2213 * be added, removed, or modified through the mounted filesystem
2216 * negative_timeout=1000000000
2217 * Cache negative name lookups indefinitely, since names can only
2218 * be added, removed, or modified through the mounted filesystem
2222 * Don't cache file/directory attributes. This is needed as a
2223 * workaround for the fact that when caching attributes, the high
2224 * level interface to libfuse considers a file which has several
2225 * hard-linked names as several different files. (Otherwise, we
2226 * could cache our file/directory attributes indefinitely, since
2227 * they can only be changed through the mounted filesystem itself.)
2229 char optstring[256] =
2234 ",default_permissions"
2236 ",entry_timeout=1000000000"
2237 ",negative_timeout=1000000000"
2240 fuse_argv[fuse_argc++] = "-o";
2241 fuse_argv[fuse_argc++] = optstring;
2242 if (!(mount_flags & WIMLIB_MOUNT_FLAG_READWRITE))
2243 strcat(optstring, ",ro");
2244 if (mount_flags & WIMLIB_MOUNT_FLAG_ALLOW_OTHER)
2245 strcat(optstring, ",allow_other");
2246 fuse_argv[fuse_argc] = NULL;
2248 /* Mount our filesystem. */
2249 ret = fuse_main(fuse_argc, fuse_argv, &wimfs_operations, &ctx);
2251 /* Cleanup and return. */
2253 ret = WIMLIB_ERR_FUSE;
2254 release_extra_refcnts(&ctx);
2255 if (mount_flags & WIMLIB_MOUNT_FLAG_READWRITE)
2256 delete_staging_dir(&ctx);
2258 unlock_wim_for_append(wim, wim->in_fd.fd);
2262 struct commit_progress_thread_args {
2264 wimlib_progress_func_t progfunc;
2269 commit_progress_thread_proc(void *_args)
2271 struct commit_progress_thread_args *args = _args;
2272 struct commit_progress_report report;
2276 ret = mq_receive(args->mq,
2277 (char *)&report, sizeof(report), NULL);
2278 if (ret == sizeof(report)) {
2279 call_progress(args->progfunc, report.msg,
2280 &report.info, args->progctx);
2282 if (ret == 0 || (ret < 0 && errno != EINTR))
2290 generate_message_queue_name(char name[WIMFS_MQUEUE_NAME_LEN + 1])
2293 memcpy(name + 1, "wimfs-", 6);
2294 randomize_char_array_with_alnum(name + 7, WIMFS_MQUEUE_NAME_LEN - 7);
2295 name[WIMFS_MQUEUE_NAME_LEN] = '\0';
2299 create_message_queue(const char *name, bool have_progfunc)
2301 bool am_root = (getuid() == 0);
2302 mode_t umask_save = 0;
2304 struct mq_attr attr;
2307 memset(&attr, 0, sizeof(attr));
2310 attr.mq_msgsize = sizeof(struct commit_progress_report);
2312 attr.mq_msgsize = sizeof(int);
2315 /* Filesystem mounted as normal user with --allow-other should
2316 * be able to send messages to root user, if they're doing the
2318 umask_save = umask(0);
2321 mq = mq_open(name, O_RDWR | O_CREAT | O_EXCL, mode, &attr);
2327 /* Unmount a read-only or read-write mounted WIM image. */
2329 do_unmount(const char *dir)
2334 len = getxattr(dir, "wimfs.unmount", &status, sizeof(int));
2335 if (len == sizeof(int))
2337 else if (len < 0 && (errno == EACCES || errno == EPERM))
2338 return WIMLIB_ERR_NOT_PERMITTED_TO_UNMOUNT;
2340 return WIMLIB_ERR_NOT_A_MOUNTPOINT;
2344 set_unmount_info(const char *dir, const struct wimfs_unmount_info *unmount_info)
2346 if (!setxattr(dir, "wimfs.unmount_info",
2347 unmount_info, sizeof(struct wimfs_unmount_info), 0))
2349 else if (errno == EROFS)
2351 else if (errno == EACCES || errno == EPERM)
2352 return WIMLIB_ERR_NOT_PERMITTED_TO_UNMOUNT;
2354 return WIMLIB_ERR_NOT_A_MOUNTPOINT;
2358 do_unmount_discard(const char *dir)
2361 struct wimfs_unmount_info unmount_info;
2363 memset(&unmount_info, 0, sizeof(unmount_info));
2365 ret = set_unmount_info(dir, &unmount_info);
2368 return do_unmount(dir);
2371 /* Unmount a read-write mounted WIM image, committing the changes. */
2373 do_unmount_commit(const char *dir, int unmount_flags,
2374 wimlib_progress_func_t progfunc, void *progctx)
2376 struct wimfs_unmount_info unmount_info;
2378 struct commit_progress_thread_args args;
2379 pthread_t commit_progress_tid;
2382 memset(&unmount_info, 0, sizeof(unmount_info));
2383 unmount_info.unmount_flags = unmount_flags;
2385 /* The current thread will be stuck in getxattr() until the image is
2386 * committed. Create a thread to handle the progress messages. */
2388 generate_message_queue_name(unmount_info.mq_name);
2390 mq = create_message_queue(unmount_info.mq_name, progfunc != NULL);
2391 if (mq == (mqd_t)-1) {
2392 ERROR_WITH_ERRNO("Can't create POSIX message queue");
2393 return WIMLIB_ERR_MQUEUE;
2396 args.progfunc = progfunc;
2397 args.progctx = progctx;
2398 ret = pthread_create(&commit_progress_tid, NULL,
2399 commit_progress_thread_proc, &args);
2402 ERROR_WITH_ERRNO("Can't create thread");
2403 ret = WIMLIB_ERR_NOMEM;
2406 unmount_info.unmount_flags |= WIMLIB_UNMOUNT_FLAG_SEND_PROGRESS;
2409 ret = set_unmount_info(dir, &unmount_info);
2411 ret = do_unmount(dir);
2413 /* Terminate the progress thread. */
2414 mq_send(mq, NULL, 0, 1);
2415 pthread_join(commit_progress_tid, NULL);
2420 mq_unlink(unmount_info.mq_name);
2426 begin_unmount(const char *dir, int unmount_flags, int *mount_flags_ret,
2427 wimlib_progress_func_t progfunc, void *progctx)
2431 int wim_filename_len;
2432 union wimlib_progress_info progress;
2434 if (getxattr(dir, "wimfs.mount_flags",
2435 &mount_flags, sizeof(int)) != sizeof(int))
2436 return WIMLIB_ERR_NOT_A_MOUNTPOINT;
2438 *mount_flags_ret = mount_flags;
2443 if (getxattr(dir, "wimfs.mounted_image",
2444 &mounted_image, sizeof(int)) != sizeof(int))
2445 return WIMLIB_ERR_NOT_A_MOUNTPOINT;
2447 wim_filename_len = getxattr(dir, "wimfs.wim_filename", NULL, 0);
2448 if (wim_filename_len < 0)
2449 return WIMLIB_ERR_NOT_A_MOUNTPOINT;
2451 char wim_filename[wim_filename_len + 1];
2452 if (getxattr(dir, "wimfs.wim_filename",
2453 wim_filename, wim_filename_len) != wim_filename_len)
2454 return WIMLIB_ERR_NOT_A_MOUNTPOINT;
2455 wim_filename[wim_filename_len] = '\0';
2457 progress.unmount.mountpoint = dir;
2458 progress.unmount.mounted_wim = wim_filename;
2459 progress.unmount.mounted_image = mounted_image;
2460 progress.unmount.mount_flags = mount_flags;
2461 progress.unmount.unmount_flags = unmount_flags;
2463 return call_progress(progfunc, WIMLIB_PROGRESS_MSG_UNMOUNT_BEGIN,
2464 &progress, progctx);
2467 /* API function documented in wimlib.h */
2469 wimlib_unmount_image_with_progress(const char *dir, int unmount_flags,
2470 wimlib_progress_func_t progfunc, void *progctx)
2475 wimlib_global_init(WIMLIB_INIT_FLAG_ASSUME_UTF8);
2477 if (unmount_flags & ~(WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY |
2478 WIMLIB_UNMOUNT_FLAG_COMMIT |
2479 WIMLIB_UNMOUNT_FLAG_REBUILD |
2480 WIMLIB_UNMOUNT_FLAG_RECOMPRESS |
2481 WIMLIB_UNMOUNT_FLAG_FORCE |
2482 WIMLIB_UNMOUNT_FLAG_NEW_IMAGE))
2483 return WIMLIB_ERR_INVALID_PARAM;
2485 ret = begin_unmount(dir, unmount_flags, &mount_flags,
2490 if ((unmount_flags & WIMLIB_UNMOUNT_FLAG_COMMIT) &&
2491 (mount_flags & WIMLIB_MOUNT_FLAG_READWRITE))
2492 return do_unmount_commit(dir, unmount_flags,
2495 return do_unmount_discard(dir);
2498 #else /* WITH_FUSE */
2502 mount_unsupported_error(void)
2504 #if defined(__WIN32__)
2505 ERROR("Sorry-- Mounting WIM images is not supported on Windows!");
2507 ERROR("wimlib was compiled with --without-fuse, which disables support "
2508 "for mounting WIMs.");
2510 return WIMLIB_ERR_UNSUPPORTED;
2514 wimlib_unmount_image_with_progress(const tchar *dir, int unmount_flags,
2515 wimlib_progress_func_t progfunc, void *progctx)
2517 return mount_unsupported_error();
2521 wimlib_mount_image(WIMStruct *wim, int image, const tchar *dir,
2522 int mount_flags, const tchar *staging_dir)
2524 return mount_unsupported_error();
2527 #endif /* !WITH_FUSE */
2530 wimlib_unmount_image(const tchar *dir, int unmount_flags)
2532 return wimlib_unmount_image_with_progress(dir, unmount_flags, NULL, NULL);