]> wimlib.net Git - wimlib/blob - src/mount_image.c
Remove unnecessary argument to hlist iteration macros
[wimlib] / src / mount_image.c
1 /*
2  * mount_image.c
3  *
4  * This file implements mounting of WIM images using FUSE
5  * (Filesystem in Userspace).  See http://fuse.sourceforge.net/.
6  *
7  * Currently it is only expected to work on Linux.
8  */
9
10 /*
11  * Copyright (C) 2012, 2013, 2014, 2015 Eric Biggers
12  *
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
16  * later version.
17  *
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
21  * details.
22  *
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/.
25  */
26
27 #ifdef HAVE_CONFIG_H
28 #  include "config.h"
29 #endif
30
31 #include "wimlib.h"
32 #include "wimlib/error.h"
33
34 #ifdef WITH_FUSE
35
36 #ifdef __WIN32__
37 #  error "FUSE mount not supported on Windows!  Please configure --without-fuse"
38 #endif
39
40 #define FUSE_USE_VERSION 26
41
42 #include <attr/xattr.h>
43 #include <dirent.h>
44 #include <errno.h>
45 #include <fuse.h>
46 #include <limits.h>
47 #include <mqueue.h>
48 #include <pthread.h>
49 #include <stdlib.h>
50 #include <string.h>
51 #include <sys/stat.h>
52 #include <sys/time.h>
53 #include <sys/types.h>
54 #include <unistd.h>
55 #include <utime.h>
56
57 #include "wimlib/blob_table.h"
58 #include "wimlib/dentry.h"
59 #include "wimlib/encoding.h"
60 #include "wimlib/metadata.h"
61 #include "wimlib/paths.h"
62 #include "wimlib/progress.h"
63 #include "wimlib/reparse.h"
64 #include "wimlib/timestamp.h"
65 #include "wimlib/unix_data.h"
66 #include "wimlib/write.h"
67 #include "wimlib/xml.h"
68
69 #ifndef O_NOFOLLOW
70 #  define O_NOFOLLOW 0  /* Security only...  */
71 #endif
72
73 #define WIMFS_MQUEUE_NAME_LEN 32
74
75 #define WIMLIB_UNMOUNT_FLAG_SEND_PROGRESS 0x80000000
76
77 struct wimfs_unmount_info {
78         unsigned unmount_flags;
79         char mq_name[WIMFS_MQUEUE_NAME_LEN + 1];
80 };
81
82 struct commit_progress_report {
83         enum wimlib_progress_msg msg;
84         union wimlib_progress_info info;
85 };
86
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.  */
93 struct wimfs_fd {
94
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;
99
100         /* Pointer to the blob descriptor for the data stream that has been
101          * opened.  'num_opened_fds' of the blob descriptor tracks the number of
102          * file descriptors that reference it.  Or, this value may be NULL,
103          * which indicates that the opened stream is empty and consequently does
104          * not have a blob descriptor.  */
105         struct blob_descriptor *f_blob;
106
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'.
112          *
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;
118
119         /* 0-based index of this file descriptor in the file descriptor table of
120          * its inode.  */
121         u16 f_idx;
122
123         /* Unique ID of the opened stream in the inode.  This will stay the same
124          * even if the indices of the inode's streams are changed by a deletion.
125          */
126         u32 f_stream_id;
127 };
128
129 #define WIMFS_FD(fi) ((struct wimfs_fd *)(uintptr_t)((fi)->fh))
130
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).  */
135         WIMStruct *wim;
136
137         /* Flags passed to wimlib_mount_image() (WIMLIB_MOUNT_FLAG_*).  */
138         int mount_flags;
139
140         /* Default flags for path lookup in the WIM image.  */
141         int default_lookup_flags;
142
143         /* Information about the user who has mounted the WIM image  */
144         uid_t owner_uid;
145         gid_t owner_gid;
146
147         /* Information about the staging directory for a read-write mount.  */
148         int parent_dir_fd;
149         int staging_dir_fd;
150         char *staging_dir_name;
151
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.  */
156         u64 next_ino;
157
158         /* Number of file descriptors open to the mounted WIM image.  */
159         unsigned long num_open_fds;
160
161         /* Original list of blobs in the mounted image, linked by
162          * 'struct blob_descriptor'.orig_blob_list.  */
163         struct list_head orig_blob_list;
164
165         /* Parameters for unmounting the image (can be set via extended
166          * attribute "wimfs.unmount_info").  */
167         struct wimfs_unmount_info unmount_info;
168 };
169
170 #define WIMFS_CTX(fuse_ctx) ((struct wimfs_context*)(fuse_ctx)->private_data)
171
172 /* Retrieve the context structure for the currently mounted WIM image.
173  *
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)
179 {
180         return WIMFS_CTX(fuse_get_context());
181 }
182
183 static void
184 wimfs_inc_num_open_fds(void)
185 {
186         wimfs_get_context()->num_open_fds++;
187 }
188
189 static void
190 wimfs_dec_num_open_fds(void)
191 {
192         wimfs_get_context()->num_open_fds--;
193 }
194
195 /* Retrieve the WIMStruct for the currently mounted WIM image.  */
196 static inline WIMStruct *
197 wimfs_get_WIMStruct(void)
198 {
199         return wimfs_get_context()->wim;
200 }
201
202 /* Is write permission requested on the file?  */
203 static inline bool
204 flags_writable(int open_flags)
205 {
206         int accmode = (open_flags & O_ACCMODE);
207         return (accmode == O_RDWR || accmode == O_WRONLY);
208 }
209
210 static mode_t
211 fuse_mask_mode(mode_t mode, const struct fuse_context *fuse_ctx)
212 {
213 #if FUSE_MAJOR_VERSION > 2 || (FUSE_MAJOR_VERSION == 2 && FUSE_MINOR_VERSION >= 8)
214         mode &= ~fuse_ctx->umask;
215 #endif
216         return mode;
217 }
218
219 /*
220  * Allocate a file descriptor to a data stream in the mounted WIM image.
221  *
222  * @inode
223  *      The inode containing the stream being opened
224  * @strm
225  *      The stream of the inode being opened
226  * @fd_ret
227  *      On success, a pointer to the new file descriptor will be stored here.
228  *
229  * Returns 0 or a -errno code.
230  */
231 static int
232 alloc_wimfs_fd(struct wim_inode *inode,
233                struct wim_inode_stream *strm,
234                struct wimfs_fd **fd_ret)
235 {
236         static const u16 min_fds_per_alloc = 8;
237         static const u16 max_fds = 0xffff;
238         u16 i;
239         struct wimfs_fd *fd;
240
241         if (inode->i_num_opened_fds == inode->i_num_allocated_fds) {
242                 u16 num_new_fds;
243                 struct wimfs_fd **fds;
244
245                 /* Expand this inode's file descriptor table.  */
246
247                 num_new_fds = max(min_fds_per_alloc,
248                                   inode->i_num_allocated_fds / 4);
249
250                 num_new_fds = min(num_new_fds,
251                                   max_fds - inode->i_num_allocated_fds);
252
253                 if (num_new_fds == 0)
254                         return -EMFILE;
255
256                 fds = REALLOC(inode->i_fds,
257                               (inode->i_num_allocated_fds + num_new_fds) *
258                                 sizeof(fds[0]));
259                 if (!fds)
260                         return -ENOMEM;
261
262                 memset(&fds[inode->i_num_allocated_fds], 0,
263                        num_new_fds * sizeof(fds[0]));
264                 inode->i_fds = fds;
265                 inode->i_num_allocated_fds += num_new_fds;
266                 inode->i_next_fd = inode->i_num_opened_fds;
267         }
268
269         /* Allocate the file descriptor in the first available space in the
270          * inode's file descriptor table.
271          *
272          * i_next_fd is the lower bound on the next open slot.  */
273         for (i = inode->i_next_fd; inode->i_fds[i]; i++)
274                 ;
275
276         fd = MALLOC(sizeof(*fd));
277         if (!fd)
278                 return -ENOMEM;
279
280         fd->f_inode     = inode;
281         fd->f_blob      = stream_blob_resolved(strm);
282         filedes_invalidate(&fd->f_staging_fd);
283         fd->f_idx       = i;
284         fd->f_stream_id = strm->stream_id;
285         *fd_ret         = fd;
286         inode->i_fds[i] = fd;
287         inode->i_num_opened_fds++;
288         if (fd->f_blob)
289                 fd->f_blob->num_opened_fds++;
290         wimfs_inc_num_open_fds();
291         inode->i_next_fd = i + 1;
292         return 0;
293 }
294
295 /*
296  * Close a file descriptor to a data stream in the mounted WIM image.
297  *
298  * Returns 0 or a -errno code.  The file descriptor is always closed.
299  */
300 static int
301 close_wimfs_fd(struct wimfs_fd *fd)
302 {
303         int ret = 0;
304         struct wim_inode *inode;
305
306         /* Close the staging file if open.  */
307         if (filedes_valid(&fd->f_staging_fd))
308                  if (filedes_close(&fd->f_staging_fd))
309                          ret = -errno;
310
311         /* Release this file descriptor from its blob descriptor.  */
312         if (fd->f_blob)
313                 blob_decrement_num_opened_fds(fd->f_blob);
314
315         wimfs_dec_num_open_fds();
316
317         /* Release this file descriptor from its inode.  */
318         inode = fd->f_inode;
319         inode->i_fds[fd->f_idx] = NULL;
320         if (fd->f_idx < inode->i_next_fd)
321                 inode->i_next_fd = fd->f_idx;
322         FREE(fd);
323         inode_dec_num_opened_fds(inode);
324         return ret;
325 }
326
327 /*
328  * Translate a path into the corresponding inode in the mounted WIM image.
329  *
330  * See get_dentry() for more information.
331  *
332  * Returns a pointer to the resulting inode, or NULL with errno set.
333  */
334 static struct wim_inode *
335 wim_pathname_to_inode(WIMStruct *wim, const char *path)
336 {
337         struct wim_dentry *dentry;
338
339         dentry = get_dentry(wim, path, WIMLIB_CASE_SENSITIVE);
340         if (!dentry)
341                 return NULL;
342         return dentry->d_inode;
343 }
344
345 /* Can look up named data stream with colon syntax  */
346 #define LOOKUP_FLAG_ADS_OK              0x01
347
348 /* Can look up directory (otherwise get -ENOTDIR)  */
349 #define LOOKUP_FLAG_DIRECTORY_OK        0x02
350
351 /* Get the data stream of the specified name from the specified inode.  Returns
352  * NULL with errno set if not found.  */
353 static struct wim_inode_stream *
354 inode_get_data_stream_tstr(const struct wim_inode *inode,
355                            const char *stream_name)
356 {
357         struct wim_inode_stream *strm;
358
359         if (!stream_name || !*stream_name) {
360                 strm = inode_get_unnamed_stream(inode, STREAM_TYPE_DATA);
361         } else {
362                 const utf16lechar *uname;
363
364                 if (tstr_get_utf16le(stream_name, &uname))
365                         return NULL;
366                 strm = inode_get_stream(inode, STREAM_TYPE_DATA, uname);
367                 tstr_put_utf16le(uname);
368         }
369         if (!strm)
370                 errno = ENOENT;
371         return strm;
372 }
373
374 /*
375  * Translate a path into the corresponding dentry and stream in the mounted WIM
376  * image.
377  *
378  * Returns 0 or a -errno code.  @dentry_ret and @strm_ret are both optional.
379  */
380 static int
381 wim_pathname_to_stream(const struct wimfs_context *ctx,
382                        const char *path,
383                        int lookup_flags,
384                        struct wim_dentry **dentry_ret,
385                        struct wim_inode_stream **strm_ret)
386 {
387         WIMStruct *wim = ctx->wim;
388         struct wim_dentry *dentry;
389         struct wim_inode *inode;
390         struct wim_inode_stream *strm;
391         const char *stream_name = NULL;
392         char *p = NULL;
393
394         lookup_flags |= ctx->default_lookup_flags;
395
396         if (lookup_flags & LOOKUP_FLAG_ADS_OK) {
397                 stream_name = path_stream_name(path);
398                 if (stream_name) {
399                         p = (char *)stream_name - 1;
400                         *p = '\0';
401                 }
402         }
403
404         dentry = get_dentry(wim, path, WIMLIB_CASE_SENSITIVE);
405         if (p)
406                 *p = ':';
407         if (!dentry)
408                 return -errno;
409
410         inode = dentry->d_inode;
411
412         if (inode_resolve_streams(inode, wim->blob_table, false))
413                 return -EIO;
414
415         if (!(lookup_flags & LOOKUP_FLAG_DIRECTORY_OK)
416               && inode_is_directory(inode))
417                 return -EISDIR;
418
419         strm = inode_get_data_stream_tstr(inode, stream_name);
420         if (!strm) {
421                 /* Force creation of an unnamed data stream  */
422                 if (!stream_name)
423                         strm = inode_add_stream(inode, STREAM_TYPE_DATA,
424                                                 NO_STREAM_NAME, NULL);
425                 if (!strm)
426                         return -errno;
427         }
428
429         if (dentry_ret)
430                 *dentry_ret = dentry;
431         if (strm_ret)
432                 *strm_ret = strm;
433         return 0;
434 }
435
436 /*
437  * Create a new file in the mounted WIM image.
438  *
439  * @fuse_ctx
440  *      The FUSE context for the mounted image.
441  * @path
442  *      The path at which to create the first link to the new file.  If a file
443  *      already exists at this path, -EEXIST is returned.
444  * @mode
445  *      The UNIX mode for the new file.  This is only honored if
446  *      WIMLIB_MOUNT_FLAG_UNIX_DATA was passed to wimlib_mount_image().
447  * @rdev
448  *      The device ID for the new file, encoding the major and minor device
449  *      numbers.  This is only honored if WIMLIB_MOUNT_FLAG_UNIX_DATA was passed
450  *      to wimlib_mount_image().
451  * @attributes
452  *      Windows file attributes to use for the new file.
453  * @dentry_ret
454  *      On success, a pointer to the new dentry is returned here.  Its d_inode
455  *      member will point to the new inode that was created for it and added to
456  *      the mounted WIM image.
457  *
458  * Returns 0 or a -errno code.
459  */
460 static int
461 create_file(struct fuse_context *fuse_ctx, const char *path,
462             mode_t mode, dev_t rdev, u32 attributes,
463             struct wim_dentry **dentry_ret)
464 {
465         struct wimfs_context *wimfs_ctx = WIMFS_CTX(fuse_ctx);
466         struct wim_dentry *parent;
467         const char *basename;
468         struct wim_dentry *new_dentry;
469         struct wim_inode *new_inode;
470
471         parent = get_parent_dentry(wimfs_ctx->wim, path, WIMLIB_CASE_SENSITIVE);
472         if (!parent)
473                 return -errno;
474
475         if (!dentry_is_directory(parent))
476                 return -ENOTDIR;
477
478         basename = path_basename(path);
479
480         if (get_dentry_child_with_name(parent, basename, WIMLIB_CASE_SENSITIVE))
481                 return -EEXIST;
482
483         if (new_dentry_with_new_inode(basename, true, &new_dentry))
484                 return -ENOMEM;
485
486         new_inode = new_dentry->d_inode;
487
488         new_inode->i_ino = wimfs_ctx->next_ino++;
489         new_inode->i_attributes = attributes;
490
491         if (wimfs_ctx->mount_flags & WIMLIB_MOUNT_FLAG_UNIX_DATA) {
492                 struct wimlib_unix_data unix_data;
493
494                 unix_data.uid = fuse_ctx->uid;
495                 unix_data.gid = fuse_ctx->gid;
496                 unix_data.mode = fuse_mask_mode(mode, fuse_ctx);
497                 unix_data.rdev = rdev;
498                 if (!inode_set_unix_data(new_inode, &unix_data, UNIX_DATA_ALL))
499                 {
500                         free_dentry(new_dentry);
501                         return -ENOMEM;
502                 }
503         }
504
505         list_add_tail(&new_inode->i_list,
506                       &wim_get_current_image_metadata(wimfs_ctx->wim)->inode_list);
507
508         dentry_add_child(parent, new_dentry);
509
510         *dentry_ret = new_dentry;
511         return 0;
512 }
513
514 /*
515  * Remove a dentry from the mounted WIM image; i.e. remove an alias for an
516  * inode.
517  */
518 static void
519 remove_dentry(struct wim_dentry *dentry, struct blob_table *blob_table)
520 {
521         /* Drop blob references.  */
522         inode_unref_blobs(dentry->d_inode, blob_table);
523
524         /* Unlink the dentry from the image's dentry tree.  */
525         unlink_dentry(dentry);
526
527         /* Delete the dentry.  This will also decrement the link count of the
528          * corresponding inode, and possibly cause it to be deleted as well.  */
529         free_dentry(dentry);
530 }
531
532 /* Generate UNIX filetype mode bits for the specified WIM inode, based on its
533  * Windows file attributes.  */
534 static mode_t
535 inode_unix_file_type(const struct wim_inode *inode)
536 {
537         if (inode_is_symlink(inode))
538                 return S_IFLNK;
539         else if (inode_is_directory(inode))
540                 return S_IFDIR;
541         else
542                 return S_IFREG;
543 }
544
545 /* Generate a default UNIX mode for the specified WIM inode.  */
546 static mode_t
547 inode_default_unix_mode(const struct wim_inode *inode)
548 {
549         return inode_unix_file_type(inode) | 0777;
550 }
551
552 /*
553  * Retrieve standard UNIX metadata ('struct stat') for a WIM inode.
554  *
555  * @blob is the blob descriptor for the stream of the inode that is being
556  * queried, or NULL.  We mostly return the same information for all streams, but
557  * st_size and st_blocks may be different for different streams.
558  *
559  * This always returns 0.
560  */
561 static int
562 inode_to_stbuf(const struct wim_inode *inode,
563                const struct blob_descriptor *blob, struct stat *stbuf)
564 {
565         const struct wimfs_context *ctx = wimfs_get_context();
566         struct wimlib_unix_data unix_data;
567
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))
571         {
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;
578         } else {
579                 /* Generate default values for the user ID, group ID, and mode.
580                  *
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);
586         }
587         stbuf->st_ino = inode->i_ino;
588         stbuf->st_nlink = inode->i_nlink;
589         if (blob)
590                 stbuf->st_size = blob->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;
595 #else
596         stbuf->st_atime = wim_timestamp_to_time_t(inode->i_last_access_time);
597         stbuf->st_mtime = wim_timestamp_to_time_t(inode->i_last_write_time);
598         stbuf->st_ctime = stbuf->st_mtime;
599 #endif
600         stbuf->st_blocks = DIV_ROUND_UP(stbuf->st_size, 512);
601         return 0;
602 }
603
604 /* Update the last access and last write timestamps of a WIM inode.  */
605 static void
606 touch_inode(struct wim_inode *inode)
607 {
608         u64 now = now_as_wim_timestamp();
609         inode->i_last_access_time = now;
610         inode->i_last_write_time = now;
611 }
612
613 static void
614 touch_parent(struct wim_dentry *dentry)
615 {
616         touch_inode(dentry->d_parent->d_inode);
617 }
618
619 /*
620  * Create a new file in the staging directory for a read-write mounted image.
621  *
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
624  * @name_ret.
625  *
626  * On failure, returns -1 and sets errno.
627  */
628 static int
629 create_staging_file(const struct wimfs_context *ctx, char **name_ret)
630 {
631
632         static const size_t STAGING_FILE_NAME_LEN = 20;
633         char *name;
634         int fd;
635
636         name = MALLOC(STAGING_FILE_NAME_LEN + 1);
637         if (!name)
638                 return -1;
639         name[STAGING_FILE_NAME_LEN] = '\0';
640
641 retry:
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.  */
648                         goto retry;
649                 FREE(name);
650         } else {
651                 *name_ret = name;
652         }
653         return fd;
654 }
655
656 /*
657  * Extract a blob to the staging directory.  This is necessary when a stream
658  * using the blob is being opened for writing and the blob has not already been
659  * extracted to the staging directory.
660  *
661  * @inode
662  *      The inode containing the stream being opened for writing.
663  * @strm
664  *      The stream being opened for writing.  The blob descriptor to which the
665  *      stream refers will be changed by this function.
666  * @size
667  *      Number of bytes of the blob to extract and include in the staging file.
668  *      It may be less than the actual blob length, in which case only a prefix
669  *      of the blob will be extracted.  It may also be more than the actual blob
670  *      length, in which case the extra space will be zero-filled.
671  *
672  * Returns 0 or a -errno code.
673  */
674 static int
675 extract_blob_to_staging_dir(struct wim_inode *inode,
676                             struct wim_inode_stream *strm,
677                             off_t size, const struct wimfs_context *ctx)
678 {
679         struct blob_descriptor *old_blob;
680         struct blob_descriptor *new_blob;
681         char *staging_file_name;
682         int staging_fd;
683         off_t extract_size;
684         int result;
685         int ret;
686
687         old_blob = stream_blob_resolved(strm);
688
689         /* Create the staging file.  */
690         staging_fd = create_staging_file(ctx, &staging_file_name);
691         if (unlikely(staging_fd < 0))
692                 return -errno;
693
694         /* Extract the stream to the staging file (possibly truncated).  */
695         if (old_blob) {
696                 struct filedes fd;
697
698                 filedes_init(&fd, staging_fd);
699                 errno = 0;
700                 extract_size = min(old_blob->size, size);
701                 result = extract_blob_to_fd(old_blob, &fd, extract_size);
702         } else {
703                 extract_size = 0;
704                 result = 0;
705         }
706
707         /* In the case of truncate() to more than the file length, extend the
708          * staging file with zeroes by calling ftruncate().  */
709         if (!result && size > extract_size)
710                 result = ftruncate(staging_fd, size);
711
712         /* Close the staging file.  */
713         if (close(staging_fd))
714                 result = -1;
715
716         /* If an error occurred, unlink the staging file.  */
717         if (unlikely(result)) {
718                 /* extract_blob_to_fd() should set errno, but if it didn't,
719                  * set a default value.  */
720                 ret = errno ? -errno : -EIO;
721                 goto out_delete_staging_file;
722         }
723
724         /* Create a blob descriptor for the staging file.  */
725         new_blob = new_blob_descriptor();
726         if (unlikely(!new_blob)) {
727                 ret = -ENOMEM;
728                 goto out_delete_staging_file;
729         }
730
731         /* There may already be open file descriptors to this stream if it's
732          * previously been opened read-only, but just now we're opening it
733          * read-write.  Identify those file descriptors, update them to use the
734          * new blob descriptor, and open staging file descriptors for them.  */
735         for (u16 i = 0, j = 0; j < inode->i_num_opened_fds; i++) {
736                 struct wimfs_fd *fd;
737                 int raw_fd;
738
739                 fd = inode->i_fds[i];
740                 if (!fd)
741                         continue;
742
743                 j++;
744
745                 if (fd->f_stream_id != strm->stream_id)
746                         continue;
747
748                 /* This is a readonly fd for the same stream.  */
749                 fd->f_blob = new_blob;
750                 new_blob->num_opened_fds++;
751                 raw_fd = openat(ctx->staging_dir_fd, staging_file_name,
752                                 O_RDONLY | O_NOFOLLOW);
753                 if (unlikely(raw_fd < 0)) {
754                         ret = -errno;
755                         goto out_revert_fd_changes;
756                 }
757                 filedes_init(&fd->f_staging_fd, raw_fd);
758         }
759
760         if (old_blob)
761                 old_blob->num_opened_fds -= new_blob->num_opened_fds;
762
763         new_blob->blob_location     = BLOB_IN_STAGING_FILE;
764         new_blob->staging_file_name = staging_file_name;
765         new_blob->staging_dir_fd    = ctx->staging_dir_fd;
766         new_blob->size              = size;
767
768         prepare_unhashed_blob(new_blob, inode, strm->stream_id,
769                               &wim_get_current_image_metadata(ctx->wim)->unhashed_blobs);
770         inode_replace_stream_blob(inode, strm, new_blob, ctx->wim->blob_table);
771         return 0;
772
773 out_revert_fd_changes:
774         for (u16 i = 0; new_blob->num_opened_fds; i++) {
775                 struct wimfs_fd *fd = inode->i_fds[i];
776                 if (fd && fd->f_stream_id == strm->stream_id) {
777                         fd->f_blob = old_blob;
778                         if (filedes_valid(&fd->f_staging_fd)) {
779                                 filedes_close(&fd->f_staging_fd);
780                                 filedes_invalidate(&fd->f_staging_fd);
781                         }
782                         new_blob->num_opened_fds--;
783                 }
784         }
785         free_blob_descriptor(new_blob);
786 out_delete_staging_file:
787         unlinkat(ctx->staging_dir_fd, staging_file_name, 0);
788         FREE(staging_file_name);
789         return ret;
790 }
791
792 /*
793  * Create the staging directory for the WIM file.
794  *
795  * The staging directory will be created in the directory specified by the open
796  * file descriptor @parent_dir_fd.  It will be given a randomly generated name
797  * based on @wim_basename, the name of the WIM file.
798  *
799  * On success, returns a file descriptor to the open staging directory with
800  * O_RDONLY access.  In addition, stores the allocated name of the staging
801  * directory (relative to @parent_dir_fd) in @staging_dir_name_ret.
802  * On failure, returns -1 and sets errno.
803  */
804 static int
805 make_staging_dir_at(int parent_dir_fd, const char *wim_basename,
806                     char **staging_dir_name_ret)
807 {
808         static const char common_suffix[8] = ".staging";
809         static const size_t random_suffix_len = 10;
810         size_t wim_basename_len;
811         size_t staging_dir_name_len;
812         char *staging_dir_name;
813         char *p;
814         int fd;
815
816         wim_basename_len = strlen(wim_basename);
817         staging_dir_name_len = wim_basename_len + sizeof(common_suffix) +
818                                random_suffix_len;
819         staging_dir_name = MALLOC(staging_dir_name_len + 1);
820         if (!staging_dir_name)
821                 return -1;
822
823         p = staging_dir_name;
824         p = mempcpy(p, wim_basename, wim_basename_len);
825         p = mempcpy(p, common_suffix, sizeof(common_suffix));
826         randomize_char_array_with_alnum(p, random_suffix_len);
827         p += random_suffix_len;
828         *p = '\0';
829
830         if (mkdirat(parent_dir_fd, staging_dir_name, 0700))
831                 goto err1;
832
833         fd = openat(parent_dir_fd, staging_dir_name,
834                     O_RDONLY | O_DIRECTORY | O_NOFOLLOW);
835         if (fd < 0)
836                 goto err2;
837
838         *staging_dir_name_ret = staging_dir_name;
839         return fd;
840
841 err2:
842         unlinkat(parent_dir_fd, staging_dir_name, AT_REMOVEDIR);
843 err1:
844         FREE(staging_dir_name);
845         return -1;
846 }
847
848 /*
849  * Create the staging directory and set ctx->staging_dir_fd,
850  * ctx->staging_dir_name, and ctx->parent_dir_fd.
851  */
852 static int
853 make_staging_dir(struct wimfs_context *ctx, const char *parent_dir_path)
854 {
855         const char *wim_basename;
856         char *end = NULL;
857         int ret;
858
859         wim_basename = path_basename(ctx->wim->filename);
860
861         if (!parent_dir_path) {
862                 /* The user did not specify a directory.  Default to creating
863                  * the staging directory alongside the WIM file.  */
864                 if (wim_basename > ctx->wim->filename) {
865                         parent_dir_path = ctx->wim->filename;
866                         end = (char *)(wim_basename - 1);
867                         /* *end must be a slash.  Temporarily overwrite it so we
868                          * can open the parent directory.  */
869                         *end = '\0';
870                 } else {
871                         parent_dir_path = ".";
872                 }
873         }
874
875         /* Open the parent directory (in which we'll create our staging
876          * directory).  */
877         ctx->parent_dir_fd = open(parent_dir_path, O_RDONLY | O_DIRECTORY);
878         if (ctx->parent_dir_fd < 0) {
879                 ERROR_WITH_ERRNO("Can't open directory \"%s\"",
880                                  parent_dir_path);
881                 ret = WIMLIB_ERR_OPENDIR;
882                 goto out_restore_wim_filename;
883         }
884
885         ctx->staging_dir_fd = make_staging_dir_at(ctx->parent_dir_fd,
886                                                   wim_basename,
887                                                   &ctx->staging_dir_name);
888         if (ctx->staging_dir_fd < 0) {
889                 ERROR_WITH_ERRNO("Can't create staging directory in \"%s\"",
890                                  parent_dir_path);
891                 close(ctx->parent_dir_fd);
892                 ret = WIMLIB_ERR_MKDIR;
893                 goto out_restore_wim_filename;
894         }
895         ret = 0;
896 out_restore_wim_filename:
897         if (end)
898                 *end = '/';
899         return ret;
900 }
901
902 /* Deletes the staging directory, undoing the effects of a successful call to
903  * make_staging_dir().  */
904 static void
905 delete_staging_dir(struct wimfs_context *ctx)
906 {
907         DIR *dir;
908         struct dirent *ent;
909
910         dir = fdopendir(ctx->staging_dir_fd);
911         if (dir) {
912                 while ((ent = readdir(dir)))
913                         unlinkat(ctx->staging_dir_fd, ent->d_name, 0);
914                 closedir(dir);
915         } else {
916                 close(ctx->staging_dir_fd);
917         }
918         if (unlinkat(ctx->parent_dir_fd, ctx->staging_dir_name, AT_REMOVEDIR))
919                 WARNING_WITH_ERRNO("Could not delete staging directory");
920         FREE(ctx->staging_dir_name);
921         close(ctx->parent_dir_fd);
922 }
923
924 /* Number the inodes in the mounted image sequentially.  */
925 static void
926 reassign_inode_numbers(struct wimfs_context *ctx)
927 {
928         struct wim_image_metadata *imd;
929         struct wim_inode *inode;
930
931         ctx->next_ino = 1;
932         imd = wim_get_current_image_metadata(ctx->wim);
933         image_for_each_inode(inode, imd)
934                 inode->i_ino = ctx->next_ino++;
935 }
936
937 static void
938 release_extra_refcnts(struct wimfs_context *ctx)
939 {
940         struct list_head *list = &ctx->orig_blob_list;
941         struct blob_table *blob_table = ctx->wim->blob_table;
942         struct blob_descriptor *blob, *tmp;
943
944         list_for_each_entry_safe(blob, tmp, list, orig_blob_list)
945                 blob_subtract_refcnt(blob, blob_table, blob->out_refcnt);
946 }
947
948 /* Delete the 'struct blob_descriptor' for any stream that was modified
949  * or created in the read-write mounted image and had a final size of 0.  */
950 static void
951 delete_empty_blobs(struct wimfs_context *ctx)
952 {
953         struct blob_descriptor *blob, *tmp;
954         struct wim_image_metadata *imd;
955
956         imd = wim_get_current_image_metadata(ctx->wim);
957
958         image_for_each_unhashed_blob_safe(blob, tmp, imd) {
959                 if (!blob->size) {
960                         *retrieve_pointer_to_unhashed_blob(blob) = NULL;
961                         list_del(&blob->unhashed_list);
962                         free_blob_descriptor(blob);
963                 }
964         }
965 }
966
967 /* Close all file descriptors open to the specified inode.
968  *
969  * Note: closing the last file descriptor might free the inode.  */
970 static void
971 inode_close_fds(struct wim_inode *inode)
972 {
973         u16 num_open_fds = inode->i_num_opened_fds;
974         for (u16 i = 0; num_open_fds; i++) {
975                 if (inode->i_fds[i]) {
976                         close_wimfs_fd(inode->i_fds[i]);
977                         num_open_fds--;
978                 }
979         }
980 }
981
982 /* Close all file descriptors open to the mounted image.  */
983 static void
984 close_all_fds(struct wimfs_context *ctx)
985 {
986         struct wim_inode *inode, *tmp;
987         struct wim_image_metadata *imd;
988
989         imd = wim_get_current_image_metadata(ctx->wim);
990
991         list_for_each_entry_safe(inode, tmp, &imd->inode_list, i_list)
992                 inode_close_fds(inode);
993 }
994
995 /* Moves the currently selected image, which may have been modified, to a new
996  * index, and sets the original index to refer to a reset (unmodified) copy of
997  * the image.  */
998 static int
999 renew_current_image(struct wimfs_context *ctx)
1000 {
1001         WIMStruct *wim = ctx->wim;
1002         int idx = wim->current_image - 1;
1003         struct wim_image_metadata *imd = wim->image_metadata[idx];
1004         struct wim_image_metadata *replace_imd;
1005         struct blob_descriptor *new_blob;
1006         int ret;
1007
1008         /* Create 'replace_imd' structure to use for the reset original,
1009          * unmodified image.  */
1010         ret = WIMLIB_ERR_NOMEM;
1011         replace_imd = new_image_metadata();
1012         if (!replace_imd)
1013                 goto err;
1014
1015         /* Create new blob descriptor for the modified image's metadata
1016          * resource, which doesn't exist yet.  */
1017         ret = WIMLIB_ERR_NOMEM;
1018         new_blob = new_blob_descriptor();
1019         if (!new_blob)
1020                 goto err_put_replace_imd;
1021
1022         new_blob->refcnt = 1;
1023         new_blob->unhashed = 1;
1024         new_blob->is_metadata = 1;
1025
1026         /* Make the image being moved available at a new index.  Increments the
1027          * WIM's image count, but does not increment the reference count of the
1028          * 'struct image_metadata'.  */
1029         ret = append_image_metadata(wim, imd);
1030         if (ret)
1031                 goto err_free_new_blob;
1032
1033         ret = xml_add_image(wim, "");
1034         if (ret)
1035                 goto err_undo_append;
1036
1037         replace_imd->metadata_blob = imd->metadata_blob;
1038         imd->metadata_blob = new_blob;
1039         wim->image_metadata[idx] = replace_imd;
1040         wim->current_image = wim->hdr.image_count;
1041         return 0;
1042
1043 err_undo_append:
1044         wim->hdr.image_count--;
1045 err_free_new_blob:
1046         free_blob_descriptor(new_blob);
1047 err_put_replace_imd:
1048         put_image_metadata(replace_imd, NULL);
1049 err:
1050         return ret;
1051 }
1052
1053 static enum wimlib_progress_status
1054 commit_progress_func(enum wimlib_progress_msg msg,
1055                      union wimlib_progress_info *info, void *progctx)
1056 {
1057         mqd_t mq = *(mqd_t *)progctx;
1058         struct commit_progress_report report;
1059
1060         memset(&report, 0, sizeof(report));
1061         report.msg = msg;
1062         if (info)
1063                 report.info = *info;
1064         mq_send(mq, (const char *)&report, sizeof(report), 1);
1065         return WIMLIB_PROGRESS_STATUS_CONTINUE;
1066 }
1067
1068 /* Commit the mounted image to the underlying WIM file.  */
1069 static int
1070 commit_image(struct wimfs_context *ctx, int unmount_flags, mqd_t mq)
1071 {
1072         int write_flags;
1073
1074         if (unmount_flags & WIMLIB_UNMOUNT_FLAG_SEND_PROGRESS)
1075                 wimlib_register_progress_function(ctx->wim,
1076                                                   commit_progress_func, &mq);
1077         else
1078                 wimlib_register_progress_function(ctx->wim, NULL, NULL);
1079
1080         if (unmount_flags & WIMLIB_UNMOUNT_FLAG_NEW_IMAGE) {
1081                 int ret = renew_current_image(ctx);
1082                 if (ret)
1083                         return ret;
1084         } else {
1085                 release_extra_refcnts(ctx);
1086         }
1087         INIT_LIST_HEAD(&ctx->orig_blob_list);
1088         delete_empty_blobs(ctx);
1089         xml_update_image_info(ctx->wim, ctx->wim->current_image);
1090
1091         write_flags = 0;
1092
1093         if (unmount_flags & WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY)
1094                 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
1095
1096         if (unmount_flags & WIMLIB_UNMOUNT_FLAG_REBUILD)
1097                 write_flags |= WIMLIB_WRITE_FLAG_REBUILD;
1098
1099         if (unmount_flags & WIMLIB_UNMOUNT_FLAG_RECOMPRESS)
1100                 write_flags |= WIMLIB_WRITE_FLAG_RECOMPRESS;
1101
1102         return wimlib_overwrite(ctx->wim, write_flags, 0);
1103 }
1104
1105 /* In the case of an allow_other mount, only the mount owner and root are
1106  * allowed to unmount the filesystem.  */
1107 static bool
1108 may_unmount_wimfs(void)
1109 {
1110         const struct fuse_context *fuse_ctx = fuse_get_context();
1111         const struct wimfs_context *wimfs_ctx = WIMFS_CTX(fuse_ctx);
1112
1113         return (fuse_ctx->uid == wimfs_ctx->owner_uid ||
1114                 fuse_ctx->uid == 0);
1115 }
1116
1117 /* Unmount the mounted image, called from the daemon process.  */
1118 static int
1119 unmount_wimfs(void)
1120 {
1121         struct fuse_context *fuse_ctx = fuse_get_context();
1122         struct wimfs_context *wimfs_ctx = WIMFS_CTX(fuse_ctx);
1123         const struct wimfs_unmount_info *info = &wimfs_ctx->unmount_info;
1124         int unmount_flags = info->unmount_flags;
1125         mqd_t mq = (mqd_t)-1;
1126         int ret;
1127
1128         /* Ignore COMMIT if the image is mounted read-only.  */
1129         if (!(wimfs_ctx->mount_flags & WIMLIB_MOUNT_FLAG_READWRITE))
1130                 unmount_flags &= ~WIMLIB_UNMOUNT_FLAG_COMMIT;
1131
1132         if (unmount_flags & WIMLIB_UNMOUNT_FLAG_SEND_PROGRESS) {
1133                 mq = mq_open(info->mq_name, O_WRONLY | O_NONBLOCK);
1134                 if (mq == (mqd_t)-1) {
1135                         ret = WIMLIB_ERR_MQUEUE;
1136                         goto out;
1137                 }
1138         }
1139
1140         if (wimfs_ctx->num_open_fds) {
1141
1142                 /* There are still open file descriptors to the image.  */
1143
1144                 /* With COMMIT, refuse to unmount unless FORCE is also
1145                  * specified.  */
1146                 if ((unmount_flags & (WIMLIB_UNMOUNT_FLAG_COMMIT |
1147                                       WIMLIB_UNMOUNT_FLAG_FORCE))
1148                                  == WIMLIB_UNMOUNT_FLAG_COMMIT)
1149                 {
1150                         ret = WIMLIB_ERR_MOUNTED_IMAGE_IS_BUSY;
1151                         goto out;
1152                 }
1153
1154                 /* Force-close all file descriptors.  */
1155                 close_all_fds(wimfs_ctx);
1156         }
1157
1158         if (unmount_flags & WIMLIB_UNMOUNT_FLAG_COMMIT)
1159                 ret = commit_image(wimfs_ctx, unmount_flags, mq);
1160         else
1161                 ret = 0;  /* Read-only mount, or discarding changes to
1162                              a read-write mount  */
1163
1164 out:
1165         /* Leave the image mounted if commit failed, unless this is a
1166          * forced unmount.  The user can retry without COMMIT if they
1167          * want.  */
1168         if (!ret || (unmount_flags & WIMLIB_UNMOUNT_FLAG_FORCE)) {
1169                 unlock_wim_for_append(wimfs_ctx->wim);
1170                 fuse_exit(fuse_ctx->fuse);
1171         }
1172         if (mq != (mqd_t)-1)
1173                 mq_close(mq);
1174         return ret;
1175 }
1176
1177 static int
1178 wimfs_chmod(const char *path, mode_t mask)
1179 {
1180         const struct wimfs_context *ctx = wimfs_get_context();
1181         struct wim_inode *inode;
1182         struct wimlib_unix_data unix_data;
1183
1184         if (!(ctx->mount_flags & WIMLIB_MOUNT_FLAG_UNIX_DATA))
1185                 return -EOPNOTSUPP;
1186
1187         inode = wim_pathname_to_inode(ctx->wim, path);
1188         if (!inode)
1189                 return -errno;
1190
1191         unix_data.uid = ctx->owner_uid;
1192         unix_data.gid = ctx->owner_gid;
1193         unix_data.mode = mask;
1194         unix_data.rdev = 0;
1195
1196         if (!inode_set_unix_data(inode, &unix_data, UNIX_DATA_MODE))
1197                 return -ENOMEM;
1198
1199         return 0;
1200 }
1201
1202 static int
1203 wimfs_chown(const char *path, uid_t uid, gid_t gid)
1204 {
1205         const struct wimfs_context *ctx = wimfs_get_context();
1206         struct wim_inode *inode;
1207         struct wimlib_unix_data unix_data;
1208         int which;
1209
1210         if (!(ctx->mount_flags & WIMLIB_MOUNT_FLAG_UNIX_DATA))
1211                 return -EOPNOTSUPP;
1212
1213         inode = wim_pathname_to_inode(ctx->wim, path);
1214         if (!inode)
1215                 return -errno;
1216
1217         which = 0;
1218
1219         if (uid != (uid_t)-1)
1220                 which |= UNIX_DATA_UID;
1221         else
1222                 uid = ctx->owner_uid;
1223
1224         if (gid != (gid_t)-1)
1225                 which |= UNIX_DATA_GID;
1226         else
1227                 gid = ctx->owner_gid;
1228
1229         unix_data.uid = uid;
1230         unix_data.gid = gid;
1231         unix_data.mode = inode_default_unix_mode(inode);
1232         unix_data.rdev = 0;
1233
1234         if (!inode_set_unix_data(inode, &unix_data, which))
1235                 return -ENOMEM;
1236
1237         return 0;
1238 }
1239
1240 static int
1241 wimfs_fgetattr(const char *path, struct stat *stbuf, struct fuse_file_info *fi)
1242 {
1243         struct wimfs_fd *fd = WIMFS_FD(fi);
1244         return inode_to_stbuf(fd->f_inode, fd->f_blob, stbuf);
1245 }
1246
1247 static int
1248 wimfs_ftruncate(const char *path, off_t size, struct fuse_file_info *fi)
1249 {
1250         struct wimfs_fd *fd = WIMFS_FD(fi);
1251         if (ftruncate(fd->f_staging_fd.fd, size))
1252                 return -errno;
1253         touch_inode(fd->f_inode);
1254         fd->f_blob->size = size;
1255         return 0;
1256 }
1257
1258 static int
1259 wimfs_getattr(const char *path, struct stat *stbuf)
1260 {
1261         const struct wimfs_context *ctx = wimfs_get_context();
1262         struct wim_dentry *dentry;
1263         struct wim_inode_stream *strm;
1264         int ret;
1265
1266         ret = wim_pathname_to_stream(ctx, path, LOOKUP_FLAG_DIRECTORY_OK,
1267                                      &dentry, &strm);
1268         if (ret)
1269                 return ret;
1270
1271         return inode_to_stbuf(dentry->d_inode,
1272                               stream_blob_resolved(strm), stbuf);
1273 }
1274
1275 static int
1276 copy_xattr(char *dest, size_t destsize, const void *src, size_t srcsize)
1277 {
1278         if (destsize) {
1279                 if (destsize < srcsize)
1280                         return -ERANGE;
1281                 memcpy(dest, src, srcsize);
1282         }
1283         return srcsize;
1284 }
1285
1286 static int
1287 wimfs_getxattr(const char *path, const char *name, char *value,
1288                size_t size)
1289 {
1290         const struct wimfs_context *ctx = wimfs_get_context();
1291         struct wim_inode *inode;
1292         struct wim_inode_stream *strm;
1293         struct blob_descriptor *blob;
1294
1295         if (!strncmp(name, "wimfs.", 6)) {
1296                 /* Handle some magical extended attributes.  These really should
1297                  * be ioctls, but directory ioctls aren't supported until
1298                  * libfuse 2.9, and even then they are broken.  */
1299                 name += 6;
1300                 if (!strcmp(name, "wim_filename")) {
1301                         return copy_xattr(value, size, ctx->wim->filename,
1302                                           strlen(ctx->wim->filename));
1303                 }
1304                 if (!strcmp(name, "wim_info")) {
1305                         struct wimlib_wim_info info;
1306
1307                         wimlib_get_wim_info(ctx->wim, &info);
1308
1309                         return copy_xattr(value, size, &info, sizeof(info));
1310                 }
1311                 if (!strcmp(name, "mounted_image")) {
1312                         return copy_xattr(value, size,
1313                                           &ctx->wim->current_image, sizeof(int));
1314                 }
1315                 if (!strcmp(name, "mount_flags")) {
1316                         return copy_xattr(value, size,
1317                                           &ctx->mount_flags, sizeof(int));
1318                 }
1319                 if (!strcmp(name, "unmount")) {
1320                         if (!may_unmount_wimfs())
1321                                 return -EPERM;
1322                         if (size) {
1323                                 int status;
1324
1325                                 if (size < sizeof(int))
1326                                         return -ERANGE;
1327                                 status = unmount_wimfs();
1328                                 memcpy(value, &status, sizeof(int));
1329                         }
1330                         return sizeof(int);
1331                 }
1332                 return -ENOATTR;
1333         }
1334
1335         if (!(ctx->mount_flags & WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR))
1336                 return -ENOTSUP;
1337
1338         if (strncmp(name, "user.", 5))
1339                 return -ENOATTR;
1340         name += 5;
1341
1342         if (!*name)
1343                 return -ENOATTR;
1344
1345         /* Querying a named data stream  */
1346
1347         inode = wim_pathname_to_inode(ctx->wim, path);
1348         if (!inode)
1349                 return -errno;
1350
1351         strm = inode_get_data_stream_tstr(inode, name);
1352         if (!strm)
1353                 return (errno == ENOENT) ? -ENOATTR : -errno;
1354
1355         blob = stream_blob_resolved(strm);
1356         if (!blob)
1357                 return 0;
1358
1359         if (unlikely(blob->size > INT_MAX))
1360                 return -EFBIG;
1361
1362         if (size) {
1363                 if (size < blob->size)
1364                         return -ERANGE;
1365
1366                 if (read_full_blob_into_buf(blob, value))
1367                         return errno ? -errno : -EIO;
1368         }
1369         return blob->size;
1370 }
1371
1372 static int
1373 wimfs_link(const char *existing_path, const char *new_path)
1374 {
1375         WIMStruct *wim = wimfs_get_WIMStruct();
1376         const char *new_name;
1377         struct wim_inode *inode;
1378         struct wim_dentry *dir;
1379         struct wim_dentry *new_alias;
1380
1381         inode = wim_pathname_to_inode(wim, existing_path);
1382         if (!inode)
1383                 return -errno;
1384
1385         if (inode->i_attributes & (FILE_ATTRIBUTE_DIRECTORY |
1386                                    FILE_ATTRIBUTE_REPARSE_POINT))
1387                 return -EPERM;
1388
1389         new_name = path_basename(new_path);
1390
1391         dir = get_parent_dentry(wim, new_path, WIMLIB_CASE_SENSITIVE);
1392         if (!dir)
1393                 return -errno;
1394
1395         if (!dentry_is_directory(dir))
1396                 return -ENOTDIR;
1397
1398         if (get_dentry_child_with_name(dir, new_name, WIMLIB_CASE_SENSITIVE))
1399                 return -EEXIST;
1400
1401         if (new_dentry_with_existing_inode(new_name, inode, &new_alias))
1402                 return -ENOMEM;
1403
1404         dentry_add_child(dir, new_alias);
1405         touch_inode(dir->d_inode);
1406         return 0;
1407 }
1408
1409 static int
1410 wimfs_listxattr(const char *path, char *list, size_t size)
1411 {
1412         const struct wimfs_context *ctx = wimfs_get_context();
1413         const struct wim_inode *inode;
1414         char *p = list;
1415         char *end = list + size;
1416         int total_size = 0;
1417
1418         if (!(ctx->mount_flags & WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR))
1419                 return -ENOTSUP;
1420
1421         /* List named data streams, or get the list size.  We report each named
1422          * data stream "X" as an extended attribute "user.X".  */
1423
1424         inode = wim_pathname_to_inode(ctx->wim, path);
1425         if (!inode)
1426                 return -errno;
1427
1428         for (unsigned i = 0; i < inode->i_num_streams; i++) {
1429                 const struct wim_inode_stream *strm;
1430                 char *stream_name_mbs;
1431                 size_t stream_name_mbs_nbytes;
1432
1433                 strm = &inode->i_streams[i];
1434
1435                 if (!stream_is_named_data_stream(strm))
1436                         continue;
1437
1438                 if (utf16le_to_tstr(strm->stream_name,
1439                                     utf16le_len_bytes(strm->stream_name),
1440                                     &stream_name_mbs,
1441                                     &stream_name_mbs_nbytes))
1442                         return -errno;
1443
1444                 if (unlikely(INT_MAX - total_size < stream_name_mbs_nbytes + 6)) {
1445                         FREE(stream_name_mbs);
1446                         return -EFBIG;
1447                 }
1448
1449                 total_size += stream_name_mbs_nbytes + 6;
1450                 if (size) {
1451                         if (end - p < stream_name_mbs_nbytes + 6) {
1452                                 FREE(stream_name_mbs);
1453                                 return -ERANGE;
1454                         }
1455                         p = mempcpy(p, "user.", 5);
1456                         p = mempcpy(p, stream_name_mbs, stream_name_mbs_nbytes);
1457                         *p++ = '\0';
1458                 }
1459                 FREE(stream_name_mbs);
1460         }
1461         return total_size;
1462 }
1463
1464 static int
1465 wimfs_mkdir(const char *path, mode_t mode)
1466 {
1467         struct wim_dentry *dentry;
1468         int ret;
1469
1470         /* Note: according to fuse.h, mode may not include S_IFDIR  */
1471         ret = create_file(fuse_get_context(), path, mode | S_IFDIR, 0,
1472                           FILE_ATTRIBUTE_DIRECTORY, &dentry);
1473         if (ret)
1474                 return ret;
1475         touch_parent(dentry);
1476         return 0;
1477 }
1478
1479 static int
1480 wimfs_mknod(const char *path, mode_t mode, dev_t rdev)
1481 {
1482         struct fuse_context *fuse_ctx = fuse_get_context();
1483         struct wimfs_context *wimfs_ctx = WIMFS_CTX(fuse_ctx);
1484         const char *stream_name;
1485
1486         if ((wimfs_ctx->mount_flags & WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS)
1487              && (stream_name = path_stream_name(path)))
1488         {
1489                 struct wim_inode *inode;
1490                 struct wim_inode_stream *existing_strm;
1491                 struct wim_inode_stream *new_strm;
1492                 char *p;
1493                 const utf16lechar *uname;
1494
1495                 /* Create a named data stream.  */
1496
1497                 if (!S_ISREG(mode))
1498                         return -EOPNOTSUPP;
1499
1500                 p = (char *)stream_name - 1;
1501
1502                 *p = '\0';
1503                 inode = wim_pathname_to_inode(wimfs_ctx->wim, path);
1504                 *p = ':';
1505                 if (!inode)
1506                         return -errno;
1507
1508                 if (tstr_get_utf16le(stream_name, &uname))
1509                         return -errno;
1510
1511                 existing_strm = inode_get_stream(inode, STREAM_TYPE_DATA, uname);
1512                 if (existing_strm) {
1513                         tstr_put_utf16le(uname);
1514                         return -EEXIST;
1515                 }
1516
1517                 new_strm = inode_add_stream(inode, STREAM_TYPE_DATA, uname, NULL);
1518
1519                 tstr_put_utf16le(uname);
1520
1521                 if (!new_strm)
1522                         return -errno;
1523                 return 0;
1524         } else {
1525                 /* Create a regular file, device node, named pipe, or socket.
1526                  */
1527                 struct wim_dentry *dentry;
1528                 int ret;
1529
1530                 if (!S_ISREG(mode) &&
1531                     !(wimfs_ctx->mount_flags & WIMLIB_MOUNT_FLAG_UNIX_DATA))
1532                         return -EPERM;
1533
1534                 /* Note: we still use FILE_ATTRIBUTE_NORMAL for device nodes,
1535                  * named pipes, and sockets.  The real mode is in the UNIX
1536                  * metadata.  */
1537                 ret = create_file(fuse_ctx, path, mode, rdev,
1538                                   FILE_ATTRIBUTE_NORMAL, &dentry);
1539                 if (ret)
1540                         return ret;
1541                 touch_parent(dentry);
1542                 return 0;
1543         }
1544 }
1545
1546 static int
1547 wimfs_open(const char *path, struct fuse_file_info *fi)
1548 {
1549         struct wimfs_context *ctx = wimfs_get_context();
1550         struct wim_dentry *dentry;
1551         struct wim_inode *inode;
1552         struct wim_inode_stream *strm;
1553         struct blob_descriptor *blob;
1554         struct wimfs_fd *fd;
1555         int ret;
1556
1557         ret = wim_pathname_to_stream(ctx, path, 0, &dentry, &strm);
1558         if (ret)
1559                 return ret;
1560
1561         inode = dentry->d_inode;
1562         blob = stream_blob_resolved(strm);
1563
1564         /* The data of the file being opened may be in the staging directory
1565          * (read-write mounts only) or in the WIM.  If it's in the staging
1566          * directory, we need to open a native file descriptor for the
1567          * corresponding file.  Otherwise, we can read the file data directly
1568          * from the WIM file if we are opening it read-only, but we need to
1569          * extract the data to the staging directory if we are opening it
1570          * writable.  */
1571
1572         if (flags_writable(fi->flags) &&
1573             (!blob || blob->blob_location != BLOB_IN_STAGING_FILE)) {
1574                 ret = extract_blob_to_staging_dir(inode,
1575                                                   strm,
1576                                                   blob ? blob->size : 0,
1577                                                   ctx);
1578                 if (ret)
1579                         return ret;
1580                 blob = stream_blob_resolved(strm);
1581         }
1582
1583         ret = alloc_wimfs_fd(inode, strm, &fd);
1584         if (ret)
1585                 return ret;
1586
1587         if (blob && blob->blob_location == BLOB_IN_STAGING_FILE) {
1588                 int raw_fd;
1589
1590                 raw_fd = openat(blob->staging_dir_fd, blob->staging_file_name,
1591                                 (fi->flags & O_ACCMODE) | O_NOFOLLOW);
1592                 if (raw_fd < 0) {
1593                         close_wimfs_fd(fd);
1594                         return -errno;
1595                 }
1596                 filedes_init(&fd->f_staging_fd, raw_fd);
1597         }
1598         fi->fh = (uintptr_t)fd;
1599         return 0;
1600 }
1601
1602 static int
1603 wimfs_opendir(const char *path, struct fuse_file_info *fi)
1604 {
1605         WIMStruct *wim = wimfs_get_WIMStruct();
1606         struct wim_inode *inode;
1607         struct wim_inode_stream *strm;
1608         struct wimfs_fd *fd;
1609         int ret;
1610
1611         inode = wim_pathname_to_inode(wim, path);
1612         if (!inode)
1613                 return -errno;
1614         if (!inode_is_directory(inode))
1615                 return -ENOTDIR;
1616         strm = inode_get_unnamed_stream(inode, STREAM_TYPE_DATA);
1617         if (!strm)
1618                 return -ENOTDIR;
1619         ret = alloc_wimfs_fd(inode, strm, &fd);
1620         if (ret)
1621                 return ret;
1622         fi->fh = (uintptr_t)fd;
1623         return 0;
1624 }
1625
1626 static int
1627 wimfs_read(const char *path, char *buf, size_t size,
1628            off_t offset, struct fuse_file_info *fi)
1629 {
1630         struct wimfs_fd *fd = WIMFS_FD(fi);
1631         const struct blob_descriptor *blob;
1632         ssize_t ret;
1633
1634         blob = fd->f_blob;
1635         if (!blob)
1636                 return 0;
1637
1638         if (offset >= blob->size)
1639                 return 0;
1640
1641         if (size > blob->size - offset)
1642                 size = blob->size - offset;
1643
1644         if (!size)
1645                 return 0;
1646
1647         switch (blob->blob_location) {
1648         case BLOB_IN_WIM:
1649                 if (read_partial_wim_blob_into_buf(blob, size, offset, buf))
1650                         ret = errno ? -errno : -EIO;
1651                 else
1652                         ret = size;
1653                 break;
1654         case BLOB_IN_STAGING_FILE:
1655                 ret = raw_pread(&fd->f_staging_fd, buf, size, offset);
1656                 if (ret < 0)
1657                         ret = -errno;
1658                 break;
1659         case BLOB_IN_ATTACHED_BUFFER:
1660                 memcpy(buf, blob->attached_buffer + offset, size);
1661                 ret = size;
1662                 break;
1663         default:
1664                 ret = -EINVAL;
1665                 break;
1666         }
1667         return ret;
1668 }
1669
1670 static int
1671 wimfs_readdir(const char *path, void *buf, fuse_fill_dir_t filler,
1672               off_t offset, struct fuse_file_info *fi)
1673 {
1674         struct wimfs_fd *fd = WIMFS_FD(fi);
1675         const struct wim_inode *inode;
1676         const struct wim_dentry *child;
1677         int ret;
1678
1679         inode = fd->f_inode;
1680
1681         ret = filler(buf, ".", NULL, 0);
1682         if (ret)
1683                 return ret;
1684         ret = filler(buf, "..", NULL, 0);
1685         if (ret)
1686                 return ret;
1687
1688         for_inode_child(child, inode) {
1689                 char *file_name_mbs;
1690                 size_t file_name_mbs_nbytes;
1691
1692                 ret = utf16le_to_tstr(child->file_name,
1693                                       child->file_name_nbytes,
1694                                       &file_name_mbs,
1695                                       &file_name_mbs_nbytes);
1696                 if (ret)
1697                         return -errno;
1698
1699                 ret = filler(buf, file_name_mbs, NULL, 0);
1700                 FREE(file_name_mbs);
1701                 if (ret)
1702                         return ret;
1703         }
1704         return 0;
1705 }
1706
1707 static int
1708 wimfs_readlink(const char *path, char *buf, size_t buf_len)
1709 {
1710         WIMStruct *wim = wimfs_get_WIMStruct();
1711         const struct wim_inode *inode;
1712         ssize_t ret;
1713
1714         inode = wim_pathname_to_inode(wim, path);
1715         if (!inode)
1716                 return -errno;
1717         if (!inode_is_symlink(inode))
1718                 return -EINVAL;
1719         if (buf_len == 0)
1720                 return -EINVAL;
1721         ret = wim_inode_readlink(inode, buf, buf_len - 1, NULL);
1722         if (ret >= 0) {
1723                 buf[ret] = '\0';
1724                 ret = 0;
1725         } else if (ret == -ENAMETOOLONG) {
1726                 buf[buf_len - 1] = '\0';
1727         }
1728         return ret;
1729 }
1730
1731 /* We use this for both release() and releasedir(), since in both cases we
1732  * simply need to close the file descriptor.  */
1733 static int
1734 wimfs_release(const char *path, struct fuse_file_info *fi)
1735 {
1736         return close_wimfs_fd(WIMFS_FD(fi));
1737 }
1738
1739 static int
1740 wimfs_removexattr(const char *path, const char *name)
1741 {
1742         struct wimfs_context *ctx = wimfs_get_context();
1743         struct wim_inode *inode;
1744         struct wim_inode_stream *strm;
1745
1746         if (!(ctx->mount_flags & WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR))
1747                 return -ENOTSUP;
1748
1749         if (strncmp(name, "user.", 5))
1750                 return -ENOATTR;
1751         name += 5;
1752
1753         if (!*name)
1754                 return -ENOATTR;
1755
1756         /* Removing a named data stream.  */
1757
1758         inode = wim_pathname_to_inode(ctx->wim, path);
1759         if (!inode)
1760                 return -errno;
1761
1762         strm = inode_get_data_stream_tstr(inode, name);
1763         if (!strm)
1764                 return (errno == ENOENT) ? -ENOATTR : -errno;
1765
1766         inode_remove_stream(inode, strm, ctx->wim->blob_table);
1767         return 0;
1768 }
1769
1770 static int
1771 wimfs_rename(const char *from, const char *to)
1772 {
1773         return rename_wim_path(wimfs_get_WIMStruct(), from, to,
1774                                WIMLIB_CASE_SENSITIVE, NULL);
1775 }
1776
1777 static int
1778 wimfs_rmdir(const char *path)
1779 {
1780         WIMStruct *wim = wimfs_get_WIMStruct();
1781         struct wim_dentry *dentry;
1782
1783         dentry = get_dentry(wim, path, WIMLIB_CASE_SENSITIVE);
1784         if (!dentry)
1785                 return -errno;
1786
1787         if (!dentry_is_directory(dentry))
1788                 return -ENOTDIR;
1789
1790         if (dentry_has_children(dentry))
1791                 return -ENOTEMPTY;
1792
1793         touch_parent(dentry);
1794         remove_dentry(dentry, wim->blob_table);
1795         return 0;
1796 }
1797
1798 static int
1799 wimfs_setxattr(const char *path, const char *name,
1800                const char *value, size_t size, int flags)
1801 {
1802         struct wimfs_context *ctx = wimfs_get_context();
1803         struct wim_inode *inode;
1804         struct wim_inode_stream *strm;
1805         const utf16lechar *uname;
1806         int ret;
1807
1808         if (!strncmp(name, "wimfs.", 6)) {
1809                 /* Handle some magical extended attributes.  These really should
1810                  * be ioctls, but directory ioctls aren't supported until
1811                  * libfuse 2.9, and even then they are broken.  [Fixed by
1812                  * libfuse commit e3b7d4c278a26520be63d99d6ea84b26906fe73d]  */
1813                 name += 6;
1814                 if (!strcmp(name, "unmount_info")) {
1815                         if (!may_unmount_wimfs())
1816                                 return -EPERM;
1817                         if (size < sizeof(struct wimfs_unmount_info))
1818                                 return -EINVAL;
1819                         memcpy(&ctx->unmount_info, value,
1820                                sizeof(struct wimfs_unmount_info));
1821                         return 0;
1822                 }
1823                 return -ENOATTR;
1824         }
1825
1826         if (!(ctx->mount_flags & WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR))
1827                 return -ENOTSUP;
1828
1829         if (strncmp(name, "user.", 5))
1830                 return -ENOATTR;
1831         name += 5;
1832
1833         if (!*name)
1834                 return -ENOATTR;
1835
1836         /* Setting the contents of a named data stream.  */
1837
1838         inode = wim_pathname_to_inode(ctx->wim, path);
1839         if (!inode)
1840                 return -errno;
1841
1842         ret = tstr_get_utf16le(name, &uname);
1843         if (ret)
1844                 return -errno;
1845
1846         strm = inode_get_stream(inode, STREAM_TYPE_DATA, uname);
1847         if (strm) {
1848                 ret = -EEXIST;
1849                 if (flags & XATTR_CREATE)
1850                         goto out_put_uname;
1851         } else {
1852                 ret = -ENOATTR;
1853                 if (flags & XATTR_REPLACE)
1854                         goto out_put_uname;
1855         }
1856
1857         if (strm) {
1858                 if (!inode_replace_stream_data(inode, strm, value, size,
1859                                                ctx->wim->blob_table))
1860                 {
1861                         ret = -errno;
1862                         goto out_put_uname;
1863                 }
1864         } else {
1865                 if (!inode_add_stream_with_data(inode, STREAM_TYPE_DATA, uname,
1866                                                 value, size, ctx->wim->blob_table))
1867                 {
1868                         ret = -errno;
1869                         goto out_put_uname;
1870                 }
1871         }
1872
1873         ret = 0;
1874 out_put_uname:
1875         tstr_put_utf16le(uname);
1876         return ret;
1877 }
1878
1879 static int
1880 wimfs_symlink(const char *to, const char *from)
1881 {
1882         struct fuse_context *fuse_ctx = fuse_get_context();
1883         struct wimfs_context *wimfs_ctx = WIMFS_CTX(fuse_ctx);
1884         struct wim_dentry *dentry;
1885         int ret;
1886
1887         ret = create_file(fuse_ctx, from, S_IFLNK | 0777, 0,
1888                           FILE_ATTRIBUTE_REPARSE_POINT, &dentry);
1889         if (ret)
1890                 return ret;
1891         dentry->d_inode->i_reparse_tag = WIM_IO_REPARSE_TAG_SYMLINK;
1892         ret = wim_inode_set_symlink(dentry->d_inode, to,
1893                                     wimfs_ctx->wim->blob_table);
1894         if (ret) {
1895                 remove_dentry(dentry, wimfs_ctx->wim->blob_table);
1896                 if (ret == WIMLIB_ERR_NOMEM)
1897                         ret = -ENOMEM;
1898                 else
1899                         ret = -EINVAL;
1900         } else {
1901                 touch_parent(dentry);
1902         }
1903         return ret;
1904 }
1905
1906 static int
1907 wimfs_truncate(const char *path, off_t size)
1908 {
1909         const struct wimfs_context *ctx = wimfs_get_context();
1910         struct wim_dentry *dentry;
1911         struct wim_inode_stream *strm;
1912         struct blob_descriptor *blob;
1913         int ret;
1914         int fd;
1915
1916         ret = wim_pathname_to_stream(ctx, path, 0, &dentry, &strm);
1917         if (ret)
1918                 return ret;
1919
1920         blob = stream_blob_resolved(strm);
1921
1922         if (!blob && !size)
1923                 return 0;
1924
1925         if (!blob || blob->blob_location != BLOB_IN_STAGING_FILE) {
1926                 return extract_blob_to_staging_dir(dentry->d_inode,
1927                                                    strm, size, ctx);
1928         }
1929
1930         /* Truncate the staging file.  */
1931         fd = openat(blob->staging_dir_fd, blob->staging_file_name,
1932                     O_WRONLY | O_NOFOLLOW);
1933         if (fd < 0)
1934                 return -errno;
1935         ret = ftruncate(fd, size);
1936         if (close(fd) || ret)
1937                 return -errno;
1938         blob->size = size;
1939         touch_inode(dentry->d_inode);
1940         return 0;
1941 }
1942
1943 static int
1944 wimfs_unlink(const char *path)
1945 {
1946         const struct wimfs_context *ctx = wimfs_get_context();
1947         struct wim_dentry *dentry;
1948         struct wim_inode_stream *strm;
1949         int ret;
1950
1951         ret = wim_pathname_to_stream(ctx, path, 0, &dentry, &strm);
1952         if (ret)
1953                 return ret;
1954
1955         if (stream_is_named(strm)) {
1956                 inode_remove_stream(dentry->d_inode, strm,
1957                                     ctx->wim->blob_table);
1958         } else {
1959                 touch_parent(dentry);
1960                 remove_dentry(dentry, ctx->wim->blob_table);
1961         }
1962         return 0;
1963 }
1964
1965 #ifdef HAVE_UTIMENSAT
1966 /*
1967  * Change the timestamp on a file dentry.
1968  *
1969  * Note that alternate data streams do not have their own timestamps.
1970  */
1971 static int
1972 wimfs_utimens(const char *path, const struct timespec tv[2])
1973 {
1974         WIMStruct *wim = wimfs_get_WIMStruct();
1975         struct wim_inode *inode;
1976
1977         inode = wim_pathname_to_inode(wim, path);
1978         if (!inode)
1979                 return -errno;
1980
1981         if (tv[0].tv_nsec != UTIME_OMIT) {
1982                 if (tv[0].tv_nsec == UTIME_NOW)
1983                         inode->i_last_access_time = now_as_wim_timestamp();
1984                 else
1985                         inode->i_last_access_time = timespec_to_wim_timestamp(&tv[0]);
1986         }
1987         if (tv[1].tv_nsec != UTIME_OMIT) {
1988                 if (tv[1].tv_nsec == UTIME_NOW)
1989                         inode->i_last_write_time = now_as_wim_timestamp();
1990                 else
1991                         inode->i_last_write_time = timespec_to_wim_timestamp(&tv[1]);
1992         }
1993         return 0;
1994 }
1995 #else /* HAVE_UTIMENSAT */
1996 static int
1997 wimfs_utime(const char *path, struct utimbuf *times)
1998 {
1999         WIMStruct *wim = wimfs_get_WIMStruct();
2000         struct wim_inode *inode;
2001
2002         inode = wim_pathname_to_inode(wim, path);
2003         if (!inode)
2004                 return -errno;
2005
2006         inode->i_last_access_time = time_t_to_wim_timestamp(times->actime);
2007         inode->i_last_write_time = time_t_to_wim_timestamp(times->modtime);
2008         return 0;
2009 }
2010 #endif /* !HAVE_UTIMENSAT */
2011
2012 static int
2013 wimfs_write(const char *path, const char *buf, size_t size,
2014             off_t offset, struct fuse_file_info *fi)
2015 {
2016         struct wimfs_fd *fd = WIMFS_FD(fi);
2017         ssize_t ret;
2018
2019         ret = raw_pwrite(&fd->f_staging_fd, buf, size, offset);
2020         if (ret < 0)
2021                 return -errno;
2022
2023         if (offset + size > fd->f_blob->size)
2024                 fd->f_blob->size = offset + size;
2025
2026         touch_inode(fd->f_inode);
2027         return ret;
2028 }
2029
2030 static struct fuse_operations wimfs_operations = {
2031         .chmod       = wimfs_chmod,
2032         .chown       = wimfs_chown,
2033         .fgetattr    = wimfs_fgetattr,
2034         .ftruncate   = wimfs_ftruncate,
2035         .getattr     = wimfs_getattr,
2036         .getxattr    = wimfs_getxattr,
2037         .link        = wimfs_link,
2038         .listxattr   = wimfs_listxattr,
2039         .mkdir       = wimfs_mkdir,
2040         .mknod       = wimfs_mknod,
2041         .open        = wimfs_open,
2042         .opendir     = wimfs_opendir,
2043         .read        = wimfs_read,
2044         .readdir     = wimfs_readdir,
2045         .readlink    = wimfs_readlink,
2046         .release     = wimfs_release,
2047         .releasedir  = wimfs_release,
2048         .removexattr = wimfs_removexattr,
2049         .rename      = wimfs_rename,
2050         .rmdir       = wimfs_rmdir,
2051         .setxattr    = wimfs_setxattr,
2052         .symlink     = wimfs_symlink,
2053         .truncate    = wimfs_truncate,
2054         .unlink      = wimfs_unlink,
2055 #ifdef HAVE_UTIMENSAT
2056         .utimens     = wimfs_utimens,
2057 #else
2058         .utime       = wimfs_utime,
2059 #endif
2060         .write       = wimfs_write,
2061
2062         /* We keep track of file descriptor structures (struct wimfs_fd), so
2063          * there is no need to have the file path provided on operations such as
2064          * read().  */
2065 #if FUSE_MAJOR_VERSION > 2 || (FUSE_MAJOR_VERSION == 2 && FUSE_MINOR_VERSION >= 8)
2066         .flag_nullpath_ok = 1,
2067 #endif
2068 #if FUSE_MAJOR_VERSION > 2 || (FUSE_MAJOR_VERSION == 2 && FUSE_MINOR_VERSION >= 9)
2069         .flag_nopath = 1,
2070         .flag_utime_omit_ok = 1,
2071 #endif
2072 };
2073
2074 /* API function documented in wimlib.h  */
2075 WIMLIBAPI int
2076 wimlib_mount_image(WIMStruct *wim, int image, const char *dir,
2077                    int mount_flags, const char *staging_dir)
2078 {
2079         int ret;
2080         struct wim_image_metadata *imd;
2081         struct wimfs_context ctx;
2082         char *fuse_argv[16];
2083         int fuse_argc;
2084
2085         if (!wim || !dir || !*dir)
2086                 return WIMLIB_ERR_INVALID_PARAM;
2087
2088         if (mount_flags & ~(WIMLIB_MOUNT_FLAG_READWRITE |
2089                             WIMLIB_MOUNT_FLAG_DEBUG |
2090                             WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE |
2091                             WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR |
2092                             WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS |
2093                             WIMLIB_MOUNT_FLAG_UNIX_DATA |
2094                             WIMLIB_MOUNT_FLAG_ALLOW_OTHER))
2095                 return WIMLIB_ERR_INVALID_PARAM;
2096
2097         /* For read-write mount, check for write access to the WIM.  */
2098         if (mount_flags & WIMLIB_MOUNT_FLAG_READWRITE) {
2099                 if (!wim->filename)
2100                         return WIMLIB_ERR_NO_FILENAME;
2101                 ret = can_modify_wim(wim);
2102                 if (ret)
2103                         return ret;
2104         }
2105
2106         /* Select the image to mount.  */
2107         ret = select_wim_image(wim, image);
2108         if (ret)
2109                 return ret;
2110
2111         /* Get the metadata for the image to mount.  */
2112         imd = wim_get_current_image_metadata(wim);
2113
2114         if (imd->modified) {
2115                 /* To avoid complicating things, we don't support mounting
2116                  * images to which in-memory modifications have already been
2117                  * made.  */
2118                 ERROR("Cannot mount a modified WIM image!");
2119                 return WIMLIB_ERR_INVALID_PARAM;
2120         }
2121
2122         if (mount_flags & WIMLIB_MOUNT_FLAG_READWRITE) {
2123                 ret = lock_wim_for_append(wim);
2124                 if (ret)
2125                         return ret;
2126         }
2127
2128         /* If the user did not specify an interface for accessing named
2129          * data streams, use the default (extended attributes).  */
2130         if (!(mount_flags & (WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE |
2131                              WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR |
2132                              WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS)))
2133                 mount_flags |= WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR;
2134
2135         /* Start initializing the wimfs_context.  */
2136         memset(&ctx, 0, sizeof(struct wimfs_context));
2137         ctx.wim = wim;
2138         ctx.mount_flags = mount_flags;
2139         if (mount_flags & WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS)
2140                 ctx.default_lookup_flags = LOOKUP_FLAG_ADS_OK;
2141         /* For read-write mount, create the staging directory.  */
2142         if (mount_flags & WIMLIB_MOUNT_FLAG_READWRITE) {
2143                 ret = make_staging_dir(&ctx, staging_dir);
2144                 if (ret)
2145                         goto out_unlock;
2146         }
2147         ctx.owner_uid = getuid();
2148         ctx.owner_gid = getgid();
2149
2150         /* Add each blob referenced by files in the image to a list and
2151          * preemptively double the number of references to each.  This is done
2152          * to allow implementing the WIMLIB_UNMOUNT_FLAG_NEW_IMAGE semantics.
2153          */
2154         INIT_LIST_HEAD(&ctx.orig_blob_list);
2155         if (mount_flags & WIMLIB_MOUNT_FLAG_READWRITE) {
2156                 unsigned i;
2157                 struct wim_inode *inode;
2158                 struct blob_descriptor *blob;
2159
2160                 image_for_each_inode(inode, imd) {
2161                         for (i = 0; i < inode->i_num_streams; i++) {
2162                                 blob = stream_blob(&inode->i_streams[i],
2163                                                    wim->blob_table);
2164                                 if (blob)
2165                                         blob->out_refcnt = 0;
2166                         }
2167                 }
2168
2169                 image_for_each_inode(inode, imd) {
2170                         for (i = 0; i < inode->i_num_streams; i++) {
2171                                 blob = stream_blob(&inode->i_streams[i],
2172                                                    wim->blob_table);
2173                                 if (blob) {
2174                                         if (blob->out_refcnt == 0)
2175                                                 list_add(&blob->orig_blob_list,
2176                                                          &ctx.orig_blob_list);
2177                                         blob->out_refcnt += inode->i_nlink;
2178                                         blob->refcnt += inode->i_nlink;
2179                                 }
2180                         }
2181                 }
2182         }
2183
2184         /* Assign new inode numbers.  */
2185         reassign_inode_numbers(&ctx);
2186
2187         /* If a read-write mount, mark the image as modified.  */
2188         if (mount_flags & WIMLIB_MOUNT_FLAG_READWRITE)
2189                 imd->modified = 1;
2190
2191         /* Build the FUSE command line.  */
2192
2193         fuse_argc = 0;
2194         fuse_argv[fuse_argc++] = "wimlib";
2195         fuse_argv[fuse_argc++] = (char *)dir;
2196
2197         /* Disable multi-threaded operation.  */
2198         fuse_argv[fuse_argc++] = "-s";
2199
2200         /* Enable FUSE debug mode (don't fork) if requested by the user.  */
2201         if (mount_flags & WIMLIB_MOUNT_FLAG_DEBUG)
2202                 fuse_argv[fuse_argc++] = "-d";
2203
2204         /*
2205          * Build the FUSE mount options:
2206          *
2207          * use_ino
2208          *      FUSE will use the inode numbers we provide.  We want this,
2209          *      because we have inodes and will number them ourselves.
2210          *
2211          * subtype=wimfs
2212          *      Name for our filesystem (main type is "fuse").
2213          *
2214          * hard_remove
2215          *      If an open file is unlinked, unlink it for real rather than
2216          *      renaming it to a hidden file.  Our code supports this; an
2217          *      unlinked inode is retained until all its file descriptors have
2218          *      been closed.
2219          *
2220          * default_permissions
2221          *      FUSE will perform permission checking.  Useful when
2222          *      WIMLIB_MOUNT_FLAG_UNIX_DATA is provided and the WIM image
2223          *      contains the UNIX permissions for each file.
2224          *
2225          * kernel_cache
2226          *      Cache the contents of files.  This will speed up repeated access
2227          *      to files on a mounted WIM image, since they won't need to be
2228          *      decompressed repeatedly.  This option is valid because data in
2229          *      the WIM image should never be changed externally.  (Although, if
2230          *      someone really wanted to they could modify the WIM file or mess
2231          *      with the staging directory; but then they're asking for
2232          *      trouble.)
2233          *
2234          * entry_timeout=1000000000
2235          *      Cache positive name lookups indefinitely, since names can only
2236          *      be added, removed, or modified through the mounted filesystem
2237          *      itself.
2238          *
2239          * negative_timeout=1000000000
2240          *      Cache negative name lookups indefinitely, since names can only
2241          *      be added, removed, or modified through the mounted filesystem
2242          *      itself.
2243          *
2244          * attr_timeout=0
2245          *      Don't cache file/directory attributes.  This is needed as a
2246          *      workaround for the fact that when caching attributes, the high
2247          *      level interface to libfuse considers a file which has several
2248          *      hard-linked names as several different files.  (Otherwise, we
2249          *      could cache our file/directory attributes indefinitely, since
2250          *      they can only be changed through the mounted filesystem itself.)
2251          */
2252         char optstring[256] =
2253                 "use_ino"
2254                 ",subtype=wimfs"
2255                 ",hard_remove"
2256                 ",default_permissions"
2257                 ",kernel_cache"
2258                 ",entry_timeout=1000000000"
2259                 ",negative_timeout=1000000000"
2260                 ",attr_timeout=0"
2261                 ;
2262         fuse_argv[fuse_argc++] = "-o";
2263         fuse_argv[fuse_argc++] = optstring;
2264         if (!(mount_flags & WIMLIB_MOUNT_FLAG_READWRITE))
2265                 strcat(optstring, ",ro");
2266         if (mount_flags & WIMLIB_MOUNT_FLAG_ALLOW_OTHER)
2267                 strcat(optstring, ",allow_other");
2268         fuse_argv[fuse_argc] = NULL;
2269
2270         /* Mount our filesystem.  */
2271         ret = fuse_main(fuse_argc, fuse_argv, &wimfs_operations, &ctx);
2272
2273         /* Cleanup and return.  */
2274         if (ret)
2275                 ret = WIMLIB_ERR_FUSE;
2276         release_extra_refcnts(&ctx);
2277         if (mount_flags & WIMLIB_MOUNT_FLAG_READWRITE)
2278                 delete_staging_dir(&ctx);
2279 out_unlock:
2280         unlock_wim_for_append(wim);
2281         return ret;
2282 }
2283
2284 struct commit_progress_thread_args {
2285         mqd_t mq;
2286         wimlib_progress_func_t progfunc;
2287         void *progctx;
2288 };
2289
2290 static void *
2291 commit_progress_thread_proc(void *_args)
2292 {
2293         struct commit_progress_thread_args *args = _args;
2294         struct commit_progress_report report;
2295         ssize_t ret;
2296
2297         for (;;) {
2298                 ret = mq_receive(args->mq,
2299                                  (char *)&report, sizeof(report), NULL);
2300                 if (ret == sizeof(report)) {
2301                         call_progress(args->progfunc, report.msg,
2302                                       &report.info, args->progctx);
2303                 } else {
2304                         if (ret == 0 || (ret < 0 && errno != EINTR))
2305                                 break;
2306                 }
2307         }
2308         return NULL;
2309 }
2310
2311 static void
2312 generate_message_queue_name(char name[WIMFS_MQUEUE_NAME_LEN + 1])
2313 {
2314         name[0] = '/';
2315         memcpy(name + 1, "wimfs-", 6);
2316         randomize_char_array_with_alnum(name + 7, WIMFS_MQUEUE_NAME_LEN - 7);
2317         name[WIMFS_MQUEUE_NAME_LEN] = '\0';
2318 }
2319
2320 static mqd_t
2321 create_message_queue(const char *name)
2322 {
2323         bool am_root;
2324         mode_t umask_save;
2325         mode_t mode;
2326         struct mq_attr attr;
2327         mqd_t mq;
2328
2329         memset(&attr, 0, sizeof(attr));
2330         attr.mq_maxmsg = 8;
2331         attr.mq_msgsize = sizeof(struct commit_progress_report);
2332
2333         am_root = (geteuid() == 0);
2334         if (am_root) {
2335                 /* Filesystem mounted as normal user with --allow-other should
2336                  * be able to send messages to root user, if they're doing the
2337                  * unmount.  */
2338                 umask_save = umask(0);
2339                 mode = 0666;
2340         } else {
2341                 mode = 0600;
2342         }
2343         mq = mq_open(name, O_RDWR | O_CREAT | O_EXCL, mode, &attr);
2344         if (am_root)
2345                 umask(umask_save);
2346         return mq;
2347 }
2348
2349 /* Unmount a read-only or read-write mounted WIM image.  */
2350 static int
2351 do_unmount(const char *dir)
2352 {
2353         int status;
2354         ssize_t len;
2355
2356         len = getxattr(dir, "wimfs.unmount", &status, sizeof(int));
2357         if (len == sizeof(int))
2358                 return status;
2359         else if (len < 0 && (errno == EACCES || errno == EPERM))
2360                 return WIMLIB_ERR_NOT_PERMITTED_TO_UNMOUNT;
2361         else
2362                 return WIMLIB_ERR_NOT_A_MOUNTPOINT;
2363 }
2364
2365 static int
2366 set_unmount_info(const char *dir, const struct wimfs_unmount_info *unmount_info)
2367 {
2368         if (!setxattr(dir, "wimfs.unmount_info",
2369                       unmount_info, sizeof(struct wimfs_unmount_info), 0))
2370                 return 0;
2371         else if (errno == EROFS)
2372                 return 0;
2373         else if (errno == EACCES || errno == EPERM)
2374                 return WIMLIB_ERR_NOT_PERMITTED_TO_UNMOUNT;
2375         else
2376                 return WIMLIB_ERR_NOT_A_MOUNTPOINT;
2377 }
2378
2379 static int
2380 do_unmount_discard(const char *dir)
2381 {
2382         int ret;
2383         struct wimfs_unmount_info unmount_info;
2384
2385         memset(&unmount_info, 0, sizeof(unmount_info));
2386
2387         ret = set_unmount_info(dir, &unmount_info);
2388         if (ret)
2389                 return ret;
2390         return do_unmount(dir);
2391 }
2392
2393 /* Unmount a read-write mounted WIM image, committing the changes.  */
2394 static int
2395 do_unmount_commit(const char *dir, int unmount_flags,
2396                   wimlib_progress_func_t progfunc, void *progctx)
2397 {
2398         struct wimfs_unmount_info unmount_info;
2399         mqd_t mq;
2400         struct commit_progress_thread_args args;
2401         pthread_t commit_progress_tid;
2402         int ret;
2403
2404         memset(&unmount_info, 0, sizeof(unmount_info));
2405         unmount_info.unmount_flags = unmount_flags;
2406
2407         /* The current thread will be stuck in getxattr() until the image is
2408          * committed.  Create a thread to handle the progress messages.  */
2409         if (progfunc) {
2410                 generate_message_queue_name(unmount_info.mq_name);
2411
2412                 mq = create_message_queue(unmount_info.mq_name);
2413                 if (mq == (mqd_t)-1) {
2414                         ERROR_WITH_ERRNO("Can't create POSIX message queue");
2415                         return WIMLIB_ERR_MQUEUE;
2416                 }
2417                 args.mq = mq;
2418                 args.progfunc = progfunc;
2419                 args.progctx = progctx;
2420                 ret = pthread_create(&commit_progress_tid, NULL,
2421                                      commit_progress_thread_proc, &args);
2422                 if (ret) {
2423                         errno = ret;
2424                         ERROR_WITH_ERRNO("Can't create thread");
2425                         ret = WIMLIB_ERR_NOMEM;
2426                         goto out_delete_mq;
2427                 }
2428                 unmount_info.unmount_flags |= WIMLIB_UNMOUNT_FLAG_SEND_PROGRESS;
2429         }
2430
2431         ret = set_unmount_info(dir, &unmount_info);
2432         if (!ret)
2433                 ret = do_unmount(dir);
2434         if (progfunc) {
2435                 /* Terminate the progress thread.  */
2436                 char empty[1];
2437                 mq_send(mq, empty, 0, 1);
2438                 pthread_join(commit_progress_tid, NULL);
2439         }
2440 out_delete_mq:
2441         if (progfunc) {
2442                 mq_close(mq);
2443                 mq_unlink(unmount_info.mq_name);
2444         }
2445         return ret;
2446 }
2447
2448 static int
2449 begin_unmount(const char *dir, int unmount_flags, int *mount_flags_ret,
2450               wimlib_progress_func_t progfunc, void *progctx)
2451 {
2452         int mount_flags;
2453         int mounted_image;
2454         int wim_filename_len;
2455         union wimlib_progress_info progress;
2456
2457         if (getxattr(dir, "wimfs.mount_flags",
2458                      &mount_flags, sizeof(int)) != sizeof(int))
2459                 return WIMLIB_ERR_NOT_A_MOUNTPOINT;
2460
2461         *mount_flags_ret = mount_flags;
2462
2463         if (!progfunc)
2464                 return 0;
2465
2466         if (getxattr(dir, "wimfs.mounted_image",
2467                      &mounted_image, sizeof(int)) != sizeof(int))
2468                 return WIMLIB_ERR_NOT_A_MOUNTPOINT;
2469
2470         wim_filename_len = getxattr(dir, "wimfs.wim_filename", NULL, 0);
2471         if (wim_filename_len < 0)
2472                 return WIMLIB_ERR_NOT_A_MOUNTPOINT;
2473
2474         char wim_filename[wim_filename_len + 1];
2475         if (getxattr(dir, "wimfs.wim_filename",
2476                      wim_filename, wim_filename_len) != wim_filename_len)
2477                 return WIMLIB_ERR_NOT_A_MOUNTPOINT;
2478         wim_filename[wim_filename_len] = '\0';
2479
2480         progress.unmount.mountpoint = dir;
2481         progress.unmount.mounted_wim = wim_filename;
2482         progress.unmount.mounted_image = mounted_image;
2483         progress.unmount.mount_flags = mount_flags;
2484         progress.unmount.unmount_flags = unmount_flags;
2485
2486         return call_progress(progfunc, WIMLIB_PROGRESS_MSG_UNMOUNT_BEGIN,
2487                              &progress, progctx);
2488 }
2489
2490 /* API function documented in wimlib.h  */
2491 WIMLIBAPI int
2492 wimlib_unmount_image_with_progress(const char *dir, int unmount_flags,
2493                                    wimlib_progress_func_t progfunc, void *progctx)
2494 {
2495         int mount_flags;
2496         int ret;
2497
2498         ret = wimlib_global_init(WIMLIB_INIT_FLAG_ASSUME_UTF8);
2499         if (ret)
2500                 return ret;
2501
2502         if (unmount_flags & ~(WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY |
2503                               WIMLIB_UNMOUNT_FLAG_COMMIT |
2504                               WIMLIB_UNMOUNT_FLAG_REBUILD |
2505                               WIMLIB_UNMOUNT_FLAG_RECOMPRESS |
2506                               WIMLIB_UNMOUNT_FLAG_FORCE |
2507                               WIMLIB_UNMOUNT_FLAG_NEW_IMAGE))
2508                 return WIMLIB_ERR_INVALID_PARAM;
2509
2510         ret = begin_unmount(dir, unmount_flags, &mount_flags,
2511                             progfunc, progctx);
2512         if (ret)
2513                 return ret;
2514
2515         if ((unmount_flags & WIMLIB_UNMOUNT_FLAG_COMMIT) &&
2516             (mount_flags & WIMLIB_MOUNT_FLAG_READWRITE))
2517                 return do_unmount_commit(dir, unmount_flags,
2518                                          progfunc, progctx);
2519         else
2520                 return do_unmount_discard(dir);
2521 }
2522
2523 #else /* WITH_FUSE */
2524
2525
2526 static int
2527 mount_unsupported_error(void)
2528 {
2529 #if defined(__WIN32__)
2530         ERROR("Sorry-- Mounting WIM images is not supported on Windows!");
2531 #else
2532         ERROR("wimlib was compiled with --without-fuse, which disables support "
2533               "for mounting WIMs.");
2534 #endif
2535         return WIMLIB_ERR_UNSUPPORTED;
2536 }
2537
2538 WIMLIBAPI int
2539 wimlib_unmount_image_with_progress(const tchar *dir, int unmount_flags,
2540                                    wimlib_progress_func_t progfunc, void *progctx)
2541 {
2542         return mount_unsupported_error();
2543 }
2544
2545 WIMLIBAPI int
2546 wimlib_mount_image(WIMStruct *wim, int image, const tchar *dir,
2547                    int mount_flags, const tchar *staging_dir)
2548 {
2549         return mount_unsupported_error();
2550 }
2551
2552 #endif /* !WITH_FUSE */
2553
2554 WIMLIBAPI int
2555 wimlib_unmount_image(const tchar *dir, int unmount_flags)
2556 {
2557         return wimlib_unmount_image_with_progress(dir, unmount_flags, NULL, NULL);
2558 }