Call delete_staging_dir() only on read-write mount
[wimlib] / src / mount.c
1 /*
2  * mount.c
3  *
4  * This file implements mounting of WIM files using FUSE, which stands for
5  * Filesystem in Userspace.  FUSE allows a filesystem to be implemented in a
6  * userspace process by implementing the filesystem primitives--- read(),
7  * write(), readdir(), etc.
8  *
9  * Copyright (C) 2012 Eric Biggers
10  *
11  * wimlib - Library for working with WIM files 
12  *
13  * This library 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 2.1 of the License, or (at your option) any
16  * later version.
17  *
18  * This library is distributed in the hope that it will be useful, but WITHOUT ANY
19  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
20  * PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
21  *
22  * You should have received a copy of the GNU Lesser General Public License along
23  * with this library; if not, write to the Free Software Foundation, Inc., 59
24  * Temple Place, Suite 330, Boston, MA 02111-1307 USA 
25  */
26
27 #include "wimlib_internal.h"
28
29 #ifdef WITH_FUSE
30 #include "lookup_table.h"
31 #include "xml.h"
32 #include <stdlib.h>
33 #include <unistd.h>
34 #include <sys/wait.h>
35 #define FUSE_USE_VERSION 26
36 #include <errno.h>
37 #include <string.h>
38 #include <sys/time.h>
39 #include <fuse.h>
40 #include <ftw.h>
41 #include <mqueue.h>
42
43 /* The WIMStruct for the mounted WIM. */
44 static WIMStruct *w;
45
46 /* Working directory when `imagex mount' is run. */
47 static const char *working_directory;
48
49 /* Name of the staging directory for a read-write mount.  Whenever a new file is
50  * created, it is done so in the staging directory.  Furthermore, whenever a
51  * file in the WIM is modified, it is extracted to the staging directory.  If
52  * changes are commited when the WIM is unmounted, the file resources are merged
53  * in from the staging directory when writing the new WIM. */
54 static char *staging_dir_name;
55 static size_t staging_dir_name_len;
56
57 /* Flags passed to wimlib_mount(). */
58 static int mount_flags;
59
60 /* Name of the directory on which the WIM file is mounted. */
61 static const char *mount_dir;
62
63
64 /* 
65  * Creates a randomly named staging directory and returns its name into the
66  * static variable staging_dir_name.
67  *
68  * If the staging directory cannot be created, staging_dir_name is set to NULL.
69  * */
70 static void make_staging_dir()
71 {
72         /* XXX Give the user an option of where to stage files */
73
74         static char prefix[] = "wimlib-staging-";
75         static const size_t prefix_len = 15;
76         static const size_t suffix_len = 10;
77
78         size_t pwd_len = strlen(working_directory);
79
80         staging_dir_name_len = pwd_len + 1 + prefix_len + suffix_len;
81
82         staging_dir_name = MALLOC(staging_dir_name_len + 1);
83         if (!staging_dir_name) {
84                 ERROR("Out of memory!\n");
85                 return;
86         }
87
88         memcpy(staging_dir_name, working_directory, pwd_len);
89         staging_dir_name[pwd_len] = '/';
90         memcpy(staging_dir_name + pwd_len + 1, prefix, prefix_len);
91         randomize_char_array_with_alnum(staging_dir_name + pwd_len + 1 + prefix_len,
92                                 suffix_len);
93         staging_dir_name[staging_dir_name_len] = '\0';
94
95         if (mkdir(staging_dir_name, 0700) != 0) {
96                 ERROR("Failed to create temporary directory `%s': %m\n",
97                                 staging_dir_name);
98                 FREE(staging_dir_name);
99                 staging_dir_name = NULL;
100         }
101 }
102
103 static int remove_file_or_directory(const char *fpath, const struct stat *sb,
104                 int typeflag, struct FTW *ftwbuf)
105 {
106         if (remove(fpath) == 0)
107                 return 0;
108         else
109                 return WIMLIB_ERR_DELETE_STAGING_DIR;
110 }
111
112
113 /* 
114  * Deletes the staging directory and all the files contained in it. 
115  */
116 static inline int delete_staging_dir()
117 {
118         return nftw(staging_dir_name, remove_file_or_directory, 10, FTW_DEPTH);
119 }
120
121 /* Name and message queue descriptors for message queues between the filesystem
122  * daemon process and the unmount process.  These are used when the filesystem
123  * is unmounted and the process running wimlib_mount() (i.e. the `imagex
124  * unmount' command) needs to communicate with the filesystem daemon running
125  * fuse_main() (i.e. that spawned by the `imagex mount' or `imagex mountrw'
126  * commands */
127 static char *unmount_to_daemon_mq_name;
128 static char *daemon_to_unmount_mq_name;
129 static int unmount_to_daemon_mq;
130 static int daemon_to_unmount_mq;
131
132 /* Simple function that returns the concatenation of 4 strings. */
133 static char *strcat_dup(const char *s1, const char *s2, const char *s3, 
134                                                         const char *s4)
135 {
136         size_t len = strlen(s1) + strlen(s2) + strlen(s3) + strlen(s4) + 1;
137         char *p = MALLOC(len);
138         if (!p)
139                 return NULL;
140         *p = '\0';
141         strcat(p, s1);
142         strcat(p, s2);
143         strcat(p, s3);
144         strcat(p, s4);
145         return p;
146 }
147
148 /* Removes trailing forward slashes in a string. */
149 static void remove_trailing_slashes(char *s)
150 {
151         long len = strlen(s);
152         for (long i = len - 1; i >= 1; i--) {
153                 if (s[i] == '/')
154                         s[i] = '\0';
155                 else
156                         break;
157         }
158 }
159
160 /* Changes forward slashes to underscores in a string. */
161 static void s_slashes_underscores_g(char *s)
162 {
163         while (*s) {
164                 if (*s == '/')
165                         *s = '_';
166                 s++;
167         }
168 }
169
170 /* 
171  * Opens two POSIX message queue: one for sending messages from the unmount
172  * process to the daemon process, and one to go the other way.  The names of the
173  * message queues, which must be system-wide unique, are be based on the mount
174  * point.  (There of course is still a possibility of a collision if one were to
175  * unmount two identically named directories simultaneously...)
176  *
177  * @daemon specifies whether the calling process is the filesystem daemon or the
178  * unmount process.
179  */
180 static int open_message_queues(bool daemon)
181 {
182         static const char *slash = "/";
183         static const char *prefix = "wimlib-";
184         static const char *u2d_suffix = "unmount-to-daemon-mq";
185         static const char *d2u_suffix = "daemon-to-unmount-mq";
186
187         const char *mount_dir_basename = path_basename(mount_dir);
188         int flags;
189         int ret;
190
191         unmount_to_daemon_mq_name = strcat_dup(slash, mount_dir_basename,
192                                                 prefix, u2d_suffix);
193         if (!unmount_to_daemon_mq_name) {
194                 ERROR("Out of memory!\n");
195                 return WIMLIB_ERR_NOMEM;
196         }
197         daemon_to_unmount_mq_name = strcat_dup(slash, mount_dir_basename,
198                                                 prefix, d2u_suffix);
199         if (!daemon_to_unmount_mq_name) {
200                 ERROR("Out of memory!\n");
201                 ret = WIMLIB_ERR_NOMEM;
202                 goto err1;
203         }
204
205         remove_trailing_slashes(unmount_to_daemon_mq_name);
206         remove_trailing_slashes(daemon_to_unmount_mq_name);
207         s_slashes_underscores_g(unmount_to_daemon_mq_name + 1);
208         s_slashes_underscores_g(daemon_to_unmount_mq_name + 1);
209
210         if (daemon)
211                 flags = O_RDONLY | O_CREAT;
212         else
213                 flags = O_WRONLY | O_CREAT;
214
215         unmount_to_daemon_mq = mq_open(unmount_to_daemon_mq_name, flags, 
216                                        0700, NULL);
217
218         if (unmount_to_daemon_mq == -1) {
219                 ERROR("mq_open(): %m\n");
220                 ret = WIMLIB_ERR_MQUEUE;
221                 goto err2;
222         }
223
224         if (daemon)
225                 flags = O_WRONLY | O_CREAT;
226         else
227                 flags = O_RDONLY | O_CREAT;
228
229         daemon_to_unmount_mq = mq_open(daemon_to_unmount_mq_name, flags, 
230                                        0700, NULL);
231
232         if (daemon_to_unmount_mq == -1) {
233                 ERROR("mq_open(): %m\n");
234                 ret = WIMLIB_ERR_MQUEUE;
235                 goto err3;
236         }
237         return 0;
238 err3:
239         mq_close(unmount_to_daemon_mq);
240         mq_unlink(unmount_to_daemon_mq_name);
241 err2:
242         FREE(daemon_to_unmount_mq_name);
243 err1:
244         FREE(unmount_to_daemon_mq_name);
245         return ret;
246 }
247
248 static int mq_get_msgsize(mqd_t mq)
249 {
250         static const char *msgsize_max_file = "/proc/sys/fs/mqueue/msgsize_max";
251         FILE *fp;
252         struct mq_attr attr;
253         int msgsize;
254
255         if (mq_getattr(unmount_to_daemon_mq, &attr) == 0) {
256                 msgsize = attr.mq_msgsize;
257         } else {
258                 ERROR("mq_getattr(): %m\n");
259                 ERROR("Attempting to read %s\n", msgsize_max_file);
260                 fp = fopen(msgsize_max_file, "rb");
261                 if (fp) {
262                         if (fscanf(fp, "%d", &msgsize) != 1) {
263                                 ERROR("Assuming message size of 8192\n");
264                                 msgsize = 8192;
265                         }
266                         fclose(fp);
267                 } else {
268                         ERROR("Failed to open file %s: %m\n", 
269                                 msgsize_max_file);
270                         ERROR("Assuming message size of 8192\n");
271                         msgsize = 8192;
272                 }
273         }
274         return msgsize;
275 }
276
277 /* Closes the message queues, which are allocated in static variables */
278 static void close_message_queues()
279 {
280         mq_close(unmount_to_daemon_mq);
281         mq_close(daemon_to_unmount_mq);
282         mq_unlink(unmount_to_daemon_mq_name);
283         mq_unlink(daemon_to_unmount_mq_name);
284 }
285
286 static int wimfs_access(const char *path, int mask)
287 {
288         /* XXX Permissions not implemented */
289         return 0;
290 }
291
292 /* Closes the staging file descriptor associated with the lookup table entry, if
293  * it is opened. */
294 static int close_staging_file(struct lookup_table_entry *lte, void *ignore)
295 {
296         if (lte->staging_file_name && lte->staging_num_times_opened) {
297                 if (close(lte->staging_fd) != 0) {
298                         ERROR("Failed close file `%s': %m\n",
299                                         lte->staging_file_name);
300                         return WIMLIB_ERR_WRITE;
301                 }
302         }
303         return 0;
304 }
305
306
307 /* Calculates the SHA1 sum for @dentry if its file resource is in a staging
308  * file.  Updates the SHA1 sum in the dentry and the lookup table entry.  If
309  * there is already a lookup table entry with the same checksum, increment its
310  * reference count and destroy the lookup entry with the updated checksum. */
311 static int calculate_sha1sum_for_staging_file(struct dentry *dentry, void *lookup_table)
312 {
313         struct lookup_table *table;
314         struct lookup_table_entry *lte; 
315         struct lookup_table_entry *existing;
316         int ret;
317
318         table = lookup_table;
319         lte = lookup_resource(table, dentry->hash);
320         
321         if (lte && lte->staging_file_name) {
322
323                 DEBUG("Calculating SHA1 hash for file `%s'\n", dentry->file_name_utf8);
324                 ret = sha1sum(lte->staging_file_name, dentry->hash);
325                 if (ret != 0)
326                         return ret;
327
328                 lookup_table_unlink(table, lte);
329                 memcpy(lte->hash, dentry->hash, WIM_HASH_SIZE);
330                 existing = lookup_resource(table, dentry->hash);
331                 if (existing) {
332                         DEBUG("Merging duplicate lookup table entries for "
333                                 "file `%s'\n", dentry->file_name_utf8);
334                         free_lookup_table_entry(lte);
335                         existing->refcnt++;
336                 } else {
337                         lookup_table_insert(table, lte);
338                 }
339         }
340         return 0;
341 }
342
343 /* Overwrites the WIM file, with changes saved. */
344 static int rebuild_wim(WIMStruct *w, bool check_integrity)
345 {
346         int ret;
347         struct dentry *root;
348
349         root = wim_root_dentry(w);
350
351         DEBUG("Closing all staging file descriptors.\n");
352         /* Close all the staging file descriptors. */
353         ret = for_lookup_table_entry(w->lookup_table, 
354                                      close_staging_file, NULL);
355         if (ret != 0) {
356                 ERROR("Failed to close all staging files!\n");
357                 return ret;
358         }
359
360         DEBUG("Calculating SHA1 checksums for all new staging files.\n");
361         /* Calculate SHA1 checksums for all staging files, and merge unnecessary
362          * lookup table entries. */
363         ret = for_dentry_in_tree(root, calculate_sha1sum_for_staging_file,
364                                  w->lookup_table);
365         if (ret != 0) {
366                 ERROR("Failed to calculate new SHA1 checksums!\n");
367                 return ret;
368         }
369
370         xml_update_image_info(w, w->current_image);
371
372         ret = wimlib_overwrite(w, check_integrity);
373         if (ret != 0) {
374                 ERROR("Failed to commit changes\n");
375                 return ret;
376         }
377         return ret;
378 }
379
380 /* Called when the filesystem is unmounted. */
381 static void wimfs_destroy(void *p)
382 {
383
384         /* For read-write mounts, the `imagex unmount' command, which is
385          * running in a separate process and is executing the
386          * wimlib_unmount() function, will send this process a byte
387          * through a message queue that indicates whether the --commit
388          * option was specified or not. */
389
390         int msgsize;
391         struct timespec timeout;
392         struct timeval now;
393         ssize_t bytes_received;
394         int ret;
395         char commit;
396         char check_integrity;
397         char status;
398
399         ret = open_message_queues(true);
400         if (ret != 0)
401                 exit(1);
402
403         msgsize = mq_get_msgsize(unmount_to_daemon_mq);
404         char msg[msgsize];
405         msg[0] = 0;
406         msg[1] = 0;
407
408         /* Wait at most 3 seconds before giving up and discarding changes. */
409         gettimeofday(&now, NULL);
410         timeout.tv_sec = now.tv_sec + 3;
411         timeout.tv_nsec = now.tv_usec * 1000;
412         DEBUG("Waiting for message telling us whether to commit or not, "
413                         "and whether to include integrity checks.\n");
414
415         bytes_received = mq_timedreceive(unmount_to_daemon_mq, msg, 
416                                          msgsize, NULL, &timeout);
417         commit = msg[0];
418         check_integrity = msg[1];
419         if (bytes_received == -1) {
420                 if (errno == ETIMEDOUT) {
421                         ERROR("Timed out.\n");
422                 } else {
423                         ERROR("mq_timedreceive(): %m\n");
424                 }
425                 ERROR("Not committing.\n");
426         } else {
427                 DEBUG("Received message: [%d %d]\n", msg[0], msg[1]);
428         }
429
430         status = 0;
431         if (mount_flags & WIMLIB_MOUNT_FLAG_READWRITE) {
432                 if (commit) {
433                         status = chdir(working_directory);
434                         if (status != 0) {
435                                 ERROR("chdir(): %m\n");
436                                 status = WIMLIB_ERR_NOTDIR;
437                                 goto done;
438                         }
439                         status = rebuild_wim(w, (check_integrity != 0));
440                 }
441                 ret = delete_staging_dir();
442                 if (ret != 0) {
443                         ERROR("Failed to delete the staging directory: %m\n");
444                         if (status == 0)
445                                 status = ret;
446                 }
447         }
448 done:
449         ret = mq_send(daemon_to_unmount_mq, &status, 1, 1);
450         if (ret == -1)
451                 ERROR("Failed to send status to unmount process: %m\n");
452         close_message_queues();
453 }
454
455 /*
456  * Fills in a `struct stat' that corresponds to a file or directory in the WIM.
457  */
458 static int wimfs_getattr(const char *path, struct stat *stbuf)
459 {
460         struct dentry *dentry = get_dentry(w, path);
461         if (!dentry)
462                 return -ENOENT;
463         dentry_to_stbuf(dentry, stbuf, w->lookup_table);
464         return 0;
465 }
466
467 /* 
468  * Create a directory in the WIM.  
469  * @mode is currently ignored.
470  */
471 static int wimfs_mkdir(const char *path, mode_t mode)
472 {
473         struct dentry *parent;
474         struct dentry *newdir;
475         const char *basename;
476         
477         parent = get_parent_dentry(w, path);
478         if (!parent)
479                 return -ENOENT;
480
481         if (!dentry_is_directory(parent))
482                 return -ENOTDIR;
483
484         basename = path_basename(path);
485         if (get_dentry_child_with_name(parent, basename))
486                 return -EEXIST;
487
488         newdir = new_dentry(basename);
489         newdir->attributes |= WIM_FILE_ATTRIBUTE_DIRECTORY;
490         link_dentry(newdir, parent);
491         return 0;
492 }
493
494 /* Creates a new staging file and returns its file descriptor opened for
495  * writing.
496  *
497  * @name_ret: A location into which the a pointer to the newly allocated name of
498  *                      the staging file is stored.
499  * @return:  The file descriptor for the new file.  Returns -1 and sets errno on
500  *              error, for any reason possible from the creat() function.
501  */
502 static int create_staging_file(char **name_ret)
503 {
504         size_t name_len;
505         char *name;
506         struct stat stbuf;
507         int fd;
508         int errno_save;
509
510         name_len = staging_dir_name_len + 1 + WIM_HASH_SIZE;
511         name = MALLOC(name_len + 1);
512         if (!name) {
513                 errno = ENOMEM;
514                 return -1;
515         }
516
517         memcpy(name, staging_dir_name, staging_dir_name_len);
518         name[staging_dir_name_len] = '/';
519         randomize_char_array_with_alnum(name + staging_dir_name_len + 1,
520                                         WIM_HASH_SIZE);
521         name[name_len] = '\0';
522
523
524         /* Just in case, verify that the randomly generated name doesn't name an
525          * existing file, and try again if so  */
526         if (stat(name, &stbuf) == 0) {
527                 /* stat succeeded-- the file must exist. Try another name. */
528                 FREE(name);
529                 return create_staging_file(name_ret);
530         } else {
531                 if (errno != ENOENT)
532                         /* other error! */
533                         return -1;
534                 /* doesn't exist--- ok */
535         }
536
537         DEBUG("Creating staging file '%s'\n", name);
538
539         fd = creat(name, 0600); 
540         if (fd == -1) {
541                 errno_save = errno;
542                 FREE(name);
543                 errno = errno_save;
544         } else {
545                 *name_ret = name;
546         }
547         return fd;
548 }
549
550 /* Creates a regular file.  This is done in the staging directory.  */
551 static int wimfs_mknod(const char *path, mode_t mode, dev_t rdev)
552 {
553         struct dentry *parent, *dentry;
554         const char *basename;
555         struct lookup_table_entry *lte;
556         char *tmpfile_name;
557         int fd;
558         int err;
559
560         /* Make sure that the parent of @path exists and is a directory, and
561          * that the dentry named by @path does not already exist.  */
562         parent = get_parent_dentry(w, path);
563         if (!parent)
564                 return -ENOENT;
565         if (!dentry_is_directory(parent))
566                 return -ENOTDIR;
567         basename = path_basename(path);
568         if (get_dentry_child_with_name(parent, path))
569                 return -EEXIST;
570
571         dentry = new_dentry(basename);
572
573         /* XXX fill in a temporary random hash value- really should check for
574          * duplicates */
575         randomize_byte_array(dentry->hash, WIM_HASH_SIZE);
576
577         /* Create a lookup table entry having the same hash value */
578         lte = new_lookup_table_entry();
579         lte->staging_num_times_opened = 0;
580         lte->resource_entry.original_size = 0;
581         memcpy(lte->hash, dentry->hash, WIM_HASH_SIZE);
582
583         fd = create_staging_file(&tmpfile_name);
584
585         if (fd == -1)
586                 goto mknod_error;
587
588         if (close(fd) != 0)
589                 goto mknod_error;
590
591         lte->staging_file_name = tmpfile_name;
592
593         /* Insert the lookup table entry, and link the new dentry with its
594          * parent. */
595         lookup_table_insert(w->lookup_table, lte);
596         link_dentry(dentry, parent);
597         return 0;
598 mknod_error:
599         err = errno;
600         free_lookup_table_entry(lte);
601         return -err;
602 }
603
604 /* Open a file.  */
605 static int wimfs_open(const char *path, struct fuse_file_info *fi)
606 {
607         struct dentry *dentry;
608         struct lookup_table_entry *lte;
609         
610         dentry = get_dentry(w, path);
611
612         if (!dentry)
613                 return -EEXIST;
614         if (dentry_is_directory(dentry))
615                 return -EISDIR;
616         lte = wim_lookup_resource(w, dentry);
617
618         if (lte) {
619                 /* If this file is in the staging directory and the file is not
620                  * currently open, open it. */
621                 if (lte->staging_file_name && lte->staging_num_times_opened == 0) {
622                         lte->staging_fd = open(lte->staging_file_name, O_RDWR);
623                         if (lte->staging_fd == -1)
624                                 return -errno;
625                         lte->staging_offset = 0;
626                 }
627         } else {
628                 /* no lookup table entry, so the file must be empty.  Create a
629                  * lookup table entry for the file. */
630                 char *tmpfile_name;
631                 int err;
632                 int fd;
633
634                 lte = new_lookup_table_entry();
635                 if (!lte)
636                         return -ENOMEM;
637
638                 fd = create_staging_file(&tmpfile_name);
639
640                 if (fd == -1) {
641                         err = errno;
642                         free(lte);
643                         return -errno;
644                 }
645                 lte->resource_entry.original_size = 0;
646                 randomize_byte_array(lte->hash, WIM_HASH_SIZE);
647                 memcpy(dentry->hash, lte->hash, WIM_HASH_SIZE);
648                 lte->staging_file_name = tmpfile_name;
649                 lte->staging_fd = fd;
650                 lte->staging_offset = 0;
651                 lookup_table_insert(w->lookup_table, lte);
652         }
653         lte->staging_num_times_opened++;
654         return 0;
655 }
656
657 /* Opens a directory. */
658 static int wimfs_opendir(const char *path, struct fuse_file_info *fi)
659 {
660         struct dentry *dentry;
661         
662         dentry = get_dentry(w, path);
663         if (!dentry || !dentry_is_directory(dentry))
664                 return -ENOTDIR;
665         return 0;
666 }
667
668
669 /*
670  * Read data from a file in the WIM or in the staging directory. 
671  */
672 static int wimfs_read(const char *path, char *buf, size_t size, 
673                 off_t offset, struct fuse_file_info *fi)
674 {
675         struct dentry *dentry;
676         struct lookup_table_entry *lte;
677         
678         dentry = get_dentry(w, path);
679
680         if (!dentry)
681                 return -EEXIST;
682
683         if (!dentry_is_regular_file(dentry))
684                 return -EISDIR;
685
686         lte = wim_lookup_resource(w, dentry);
687
688         if (!lte)
689                 return 0;
690
691         if (lte->staging_file_name) {
692
693                 /* Read from staging */
694                 int fd;
695                 off_t cur_offset;
696                 ssize_t ret;
697
698                 if (lte->staging_num_times_opened == 0)
699                         return -EBADF;
700
701                 fd = lte->staging_fd;
702                 cur_offset = lte->staging_offset;
703                 if (cur_offset != offset)
704                         if (lseek(fd, offset, SEEK_SET) == -1)
705                                 return -errno;
706                 lte->staging_offset = offset;
707
708                 ret = read(fd, buf, size);
709                 if (ret == -1)
710                         return -errno;
711                 lte->staging_offset = offset + ret;
712
713                 return ret;
714         } else {
715
716                 /* Read from WIM */
717
718                 struct resource_entry *res_entry;
719                 int ctype;
720                 
721                 res_entry = &lte->resource_entry;
722
723                 ctype = wim_resource_compression_type(w, res_entry);
724
725                 if (offset > res_entry->original_size)
726                         return -EOVERFLOW;
727
728                 size = min(size, res_entry->original_size - offset);
729
730                 if (read_resource(w->fp, res_entry->size, 
731                                   res_entry->original_size,
732                                   res_entry->offset, ctype, size, 
733                                   offset, buf) != 0)
734                         return -EIO;
735                 return size;
736         }
737 }
738
739 /* Fills in the entries of the directory specified by @path using the
740  * FUSE-provided function @filler.  */
741 static int wimfs_readdir(const char *path, void *buf, fuse_fill_dir_t filler, 
742                                 off_t offset, struct fuse_file_info *fi)
743 {
744         struct dentry *parent;
745         struct dentry *child;
746         struct stat st;
747
748         parent = get_dentry(w, path);
749
750         if (!parent)
751                 return -EEXIST;
752
753         if (!dentry_is_directory(parent))
754                 return -ENOTDIR;
755
756         filler(buf, ".", NULL, 0);
757         filler(buf, "..", NULL, 0);
758
759         child = parent->children;
760
761         if (!child)
762                 return 0;
763
764         do {
765                 memset(&st, 0, sizeof(st));
766                 if (filler(buf, child->file_name_utf8, &st, 0))
767                         return 0;
768                 child = child->next;
769         } while (child != parent->children);
770         return 0;
771 }
772
773 /* Close a file. */
774 static int wimfs_release(const char *path, struct fuse_file_info *fi)
775 {
776         struct dentry *dentry;
777         struct lookup_table_entry *lte;
778         int ret;
779         
780         dentry = get_dentry(w, path);
781         if (!dentry)
782                 return -EEXIST;
783         lte = wim_lookup_resource(w, dentry);
784
785         if (!lte)
786                 return 0;
787         
788         if (lte->staging_num_times_opened == 0)
789                 return -EBADF;
790
791         if (--lte->staging_num_times_opened == 0 && lte->staging_file_name) {
792                 ret = close(lte->staging_fd);
793                 if (ret != 0)
794                         return -errno;
795         }
796         return 0;
797 }
798
799 /* Renames a file or directory.  See rename (3) */
800 static int wimfs_rename(const char *from, const char *to)
801 {
802         struct dentry *src;
803         struct dentry *dst;
804         struct dentry *parent_of_dst;
805         
806         src = get_dentry(w, from);
807         if (!src)
808                 return -ENOENT;
809
810         dst = get_dentry(w, to);
811
812         if (dst) {
813                 if (!dentry_is_directory(src)) {
814                         /* Cannot rename non-directory to directory. */
815                         if (dentry_is_directory(dst))
816                                 return -EISDIR;
817                 } else {
818                         /* Cannot rename directory to a non-directory or a non-empty
819                          * directory */
820                         if (!dentry_is_directory(dst))
821                                 return -ENOTDIR;
822                         if (dst->children != NULL)
823                                 return -ENOTEMPTY;
824                 }
825                 parent_of_dst = dst->parent;
826                 unlink_dentry(dst);
827                 lookup_table_decrement_refcnt(w->lookup_table, dst->hash);
828                 free_dentry(dst);
829         } else {
830                 parent_of_dst = get_parent_dentry(w, to);
831                 if (!parent_of_dst)
832                         return -ENOENT;
833         }
834
835         unlink_dentry(src);
836         change_dentry_name(src, path_basename(to));
837         link_dentry(src, parent_of_dst);
838         /*calculate_dentry_full_path(src);*/
839         return 0;
840 }
841
842 /* Remove a directory */
843 static int wimfs_rmdir(const char *path)
844 {
845         struct dentry *dentry;
846         
847         dentry = get_dentry(w, path);
848         if (!dentry)
849                 return -EEXIST;
850
851         if (!dentry_is_empty_directory(dentry))
852                 return -EEXIST;
853
854         unlink_dentry(dentry);
855         free_dentry(dentry);
856         return 0;
857 }
858
859 /* Extracts the resource corresponding to @dentry and its lookup table entry
860  * @lte to a file in the staging directory.  The lookup table entry for @dentry
861  * is updated to point to the new file.  If @lte has multiple dentries
862  * referencing it, a new lookup table entry is created and the hash of @dentry
863  * is changed to point to the new lookup table entry.
864  *
865  * Only @size bytes are extracted, to support truncating the file. 
866  *
867  * Returns the negative error code on failure.
868  */
869 static int extract_resource_to_staging_dir(struct dentry *dentry, 
870                                            struct lookup_table_entry *lte, 
871                                            u64 size)
872 {
873         int err, fd;
874         bool ret;
875         char *staging_file_name;
876         struct lookup_table_entry *new_lte;
877
878         /* File in WIM.  Copy it to the staging directory. */
879         fd = create_staging_file(&staging_file_name);
880         if (fd == -1)
881                 return -errno;
882
883         ret = extract_resource_to_fd(w, &lte->resource_entry, fd, size);
884         if (ret != 0) {
885                 if (errno != 0)
886                         ret = -errno;
887                 else
888                         ret = -EIO;
889                 unlink(staging_file_name);
890                 FREE(staging_file_name);
891                 return ret;
892         }
893
894         if (lte->refcnt != 1) {
895                 /* Need to make a new lookup table entry if we are
896                  * changing only one copy of a hardlinked entry */
897                 lte->refcnt--;
898
899                 new_lte = new_lookup_table_entry();
900                 if (!new_lte)
901                         return -ENOMEM;
902                 randomize_byte_array(dentry->hash, WIM_HASH_SIZE);
903                 memcpy(new_lte->hash, dentry->hash, WIM_HASH_SIZE);
904
905                 new_lte->resource_entry.flags = 0;
906                 new_lte->staging_num_times_opened = lte->staging_num_times_opened;
907
908                 lookup_table_insert(w->lookup_table, new_lte);
909
910                 lte = new_lte;
911         } 
912
913         lte->resource_entry.original_size = size;
914         lte->staging_file_name = staging_file_name;
915         
916         if (lte->staging_num_times_opened == 0)
917                 close(fd);
918         else
919                 lte->staging_fd = fd;
920         return 0;
921 }
922
923 /* Reduce the size of a file */
924 static int wimfs_truncate(const char *path, off_t size)
925 {
926         struct dentry *dentry;
927         struct lookup_table_entry *lte;
928         int ret;
929
930         dentry = get_dentry(w, path);
931         if (!dentry)
932                 return -EEXIST;
933         lte = wim_lookup_resource(w, dentry);
934
935         if (!lte) /* Already a zero-length file */
936                 return 0;
937         if (lte->staging_file_name) {
938                 /* File on disk.  Call POSIX API */
939                 if (lte->staging_num_times_opened != 0)
940                         ret = ftruncate(lte->staging_fd, size);
941                 else
942                         ret = truncate(lte->staging_file_name, size);
943                 if (ret != 0)
944                         return -errno;
945                 dentry_update_all_timestamps(dentry);
946                 lte->resource_entry.original_size = size;
947                 return 0;
948         } else {
949                 /* File in WIM.  Extract it to the staging directory, but only
950                  * the first @size bytes of it. */
951                 return extract_resource_to_staging_dir(dentry, lte, size);
952         }
953 }
954
955 /* Remove a regular file */
956 static int wimfs_unlink(const char *path)
957 {
958         struct dentry *dentry;
959         struct lookup_table_entry *lte;
960         
961         dentry = get_dentry(w, path);
962         if (!dentry)
963                 return -EEXIST;
964
965         if (!dentry_is_regular_file(dentry))
966                 return -EEXIST;
967
968         lte = wim_lookup_resource(w, dentry);
969         if (lte) {
970                 if (lte->staging_file_name)
971                         if (unlink(lte->staging_file_name) != 0)
972                                 return -errno;
973                 lookup_table_decrement_refcnt(w->lookup_table, dentry->hash);
974         }
975
976         unlink_dentry(dentry);
977         free_dentry(dentry);
978         return 0;
979 }
980
981 /* Writes to a file in the WIM filesystem. */
982 static int wimfs_write(const char *path, const char *buf, size_t size, 
983                                 off_t offset, struct fuse_file_info *fi)
984 {
985         struct dentry *dentry;
986         struct lookup_table_entry *lte;
987         ssize_t ret;
988
989         dentry = get_dentry(w, path);
990         if (!dentry)
991                 return -EEXIST;
992         lte = wim_lookup_resource(w, dentry);
993
994         if (!lte) /* this should not happen */
995                 return -EEXIST;
996
997         if (lte->staging_num_times_opened == 0)
998                 return -EBADF;
999         if (lte->staging_file_name) {
1000
1001                 /* File in staging directory. We can write to it directly. */
1002
1003                 /* Seek to correct position in file if needed. */
1004                 if (lte->staging_offset != offset) {
1005                         if (lseek(lte->staging_fd, offset, SEEK_SET) == -1)
1006                                 return -errno;
1007                         lte->staging_offset = offset;
1008                 }
1009
1010                 /* Write the data. */
1011                 ret = write(lte->staging_fd, buf, size);
1012                 if (ret == -1)
1013                         return -errno;
1014
1015                 /* Adjust the stored offset of staging_fd. */
1016                 lte->staging_offset = offset + ret;
1017
1018                 /* Increase file size if needed. */
1019                 if (lte->resource_entry.original_size < lte->staging_offset)
1020                         lte->resource_entry.original_size = lte->staging_offset;
1021
1022                 /* The file has been modified, so all its timestamps must be
1023                  * updated. */
1024                 dentry_update_all_timestamps(dentry);
1025                 return ret;
1026         } else {
1027                 /* File in the WIM.  We must extract it to the staging directory
1028                  * before it can be written to. */
1029                 ret = extract_resource_to_staging_dir(dentry, lte, 
1030                                         lte->resource_entry.original_size);
1031                 if (ret != 0)
1032                         return ret;
1033                 else
1034                         return wimfs_write(path, buf, size, offset, fi);
1035         }
1036 }
1037
1038
1039 static struct fuse_operations wimfs_oper = {
1040         .access   = wimfs_access,
1041         .destroy  = wimfs_destroy,
1042         .getattr  = wimfs_getattr,
1043         .mkdir    = wimfs_mkdir,
1044         .mknod    = wimfs_mknod,
1045         .open     = wimfs_open,
1046         .opendir  = wimfs_opendir,
1047         .read     = wimfs_read,
1048         .readdir  = wimfs_readdir,
1049         .release  = wimfs_release,
1050         .rename   = wimfs_rename,
1051         .rmdir    = wimfs_rmdir,
1052         .truncate = wimfs_truncate,
1053         .unlink   = wimfs_unlink,
1054         .write    = wimfs_write,
1055 };
1056
1057
1058 /* Mounts a WIM file. */
1059 WIMLIBAPI int wimlib_mount(WIMStruct *wim, int image, const char *dir, 
1060                            int flags)
1061 {
1062         int argc = 0;
1063         char *argv[6];
1064         int ret;
1065         char *p;
1066
1067         DEBUG("Mount: wim = %p, image = %d, dir = %s, flags = %d, ",
1068                         wim, image, dir, flags);
1069
1070         if (!dir)
1071                 return WIMLIB_ERR_INVALID_PARAM;
1072
1073         ret = wimlib_select_image(wim, image);
1074
1075         if (ret != 0)
1076                 return ret;
1077
1078         if (flags & WIMLIB_MOUNT_FLAG_READWRITE)
1079                 wim_get_current_image_metadata(wim)->modified = true;
1080
1081         mount_dir = dir;
1082         working_directory = getcwd(NULL, 0);
1083         if (!working_directory) {
1084                 ERROR("Could not determine current directory: %m\n");
1085                 return WIMLIB_ERR_NOTDIR;
1086         }
1087
1088         p = STRDUP(dir);
1089         if (!p)
1090                 return WIMLIB_ERR_NOMEM;
1091
1092         argv[argc++] = "mount";
1093         argv[argc++] = p;
1094         argv[argc++] = "-s"; /* disable multi-threaded operation */
1095
1096         if (flags & WIMLIB_MOUNT_FLAG_DEBUG) {
1097                 argv[argc++] = "-d";
1098         }
1099         if (!(flags & WIMLIB_MOUNT_FLAG_READWRITE)) {
1100                 argv[argc++] = "-o";
1101                 argv[argc++] = "ro";
1102         } else {
1103                 make_staging_dir();
1104                 if (!staging_dir_name) {
1105                         FREE(p);
1106                         return WIMLIB_ERR_MKDIR;
1107                 }
1108         }
1109
1110 #ifdef ENABLE_DEBUG
1111         {
1112                 int i;
1113                 DEBUG("FUSE command line (argc = %d): ", argc);
1114                 for (i = 0; i < argc; i++) {
1115                         fputs(argv[i], stdout);
1116                         putchar(' ');
1117                 }
1118                 putchar('\n');
1119                 fflush(stdout);
1120         }
1121 #endif
1122
1123         /* Set static variables. */
1124         w = wim;
1125         mount_flags = flags;
1126
1127         ret = fuse_main(argc, argv, &wimfs_oper, NULL);
1128
1129         return (ret == 0) ? 0 : WIMLIB_ERR_FUSE;
1130 }
1131
1132
1133 /* 
1134  * Unmounts the WIM file that was previously mounted on @dir by using
1135  * wimlib_mount().
1136  */
1137 WIMLIBAPI int wimlib_unmount(const char *dir, int flags)
1138 {
1139         pid_t pid;
1140         int status;
1141         int ret;
1142         char msg[2];
1143         struct timeval now;
1144         struct timespec timeout;
1145         int msgsize;
1146         int errno_save;
1147
1148         /* Execute `fusermount -u', which is installed setuid root, to unmount
1149          * the WIM.
1150          *
1151          * FUSE does not yet implement synchronous unmounts.  This means that
1152          * fusermount -u will return before the filesystem daemon returns from
1153          * wimfs_destroy().  This is partly what we want, because we need to
1154          * send a message from this process to the filesystem daemon telling
1155          * whether --commit was specified or not.  However, after that, the
1156          * unmount process must wait for the filesystem daemon to finish writing
1157          * the WIM file. 
1158          */
1159
1160         mount_dir = dir;
1161         pid = fork();
1162         if (pid == -1) {
1163                 ERROR("Failed to fork(): %m\n");
1164                 return WIMLIB_ERR_FORK;
1165         }
1166         if (pid == 0) {
1167                 execlp("fusermount", "fusermount", "-u", dir, NULL);
1168                 ERROR("Failed to execute `fusermount': %m\n");
1169                 return WIMLIB_ERR_FUSERMOUNT;
1170         }
1171
1172         ret = waitpid(pid, &status, 0);
1173         if (ret == -1) {
1174                 ERROR("Failed to wait for fusermount process to "
1175                                 "terminate: %m\n");
1176                 return WIMLIB_ERR_FUSERMOUNT;
1177         }
1178
1179         if (status != 0) {
1180                 ERROR("fusermount exited with status %d!\n", status);
1181                 return WIMLIB_ERR_FUSERMOUNT;
1182         }
1183
1184         /* Open message queues between the unmount process and the
1185          * filesystem daemon. */
1186         ret = open_message_queues(false);
1187         if (ret != 0)
1188                 return ret;
1189
1190         /* Send a message to the filesystem saying whether to commit or
1191          * not. */
1192         msg[0] = (flags & WIMLIB_UNMOUNT_FLAG_COMMIT) ? 1 : 0;
1193         msg[1] = (flags & WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY) ? 1 : 0;
1194
1195         DEBUG("Sending message: %s, %s\n", 
1196                         (msg[0] == 0) ? "don't commit" : "commit",
1197                         (msg[1] == 0) ? "don't check"  : "check");
1198         ret = mq_send(unmount_to_daemon_mq, msg, 2, 1);
1199         if (ret == -1) {
1200                 ERROR("Failed to notify filesystem daemon whether "
1201                                 "we want to commit changes or not!\n");
1202                 close_message_queues();
1203                 return WIMLIB_ERR_MQUEUE;
1204         }
1205
1206         /* Wait for a message from the filesytem daemon indicating whether  the
1207          * filesystem was unmounted successfully (0) or an error occurred (1).
1208          * This may take a long time if a big WIM file needs to be rewritten. */
1209
1210         /* Wait at most 600??? seconds before giving up and returning false.
1211          * Either it's a really big WIM file, or (more likely) the
1212          * filesystem daemon has crashed or failed for some reason.
1213          *
1214          * XXX come up with some method to determine if the filesystem
1215          * daemon has really crashed or not. */
1216
1217         gettimeofday(&now, NULL);
1218         timeout.tv_sec = now.tv_sec + 600;
1219         timeout.tv_nsec = now.tv_usec * 1000;
1220
1221         msgsize = mq_get_msgsize(daemon_to_unmount_mq);
1222         char mailbox[msgsize];
1223
1224         mailbox[0] = 0;
1225         DEBUG("Waiting for message telling us whether the unmount was "
1226                         "successful or not.\n");
1227         ret = mq_timedreceive(daemon_to_unmount_mq, mailbox, msgsize,
1228                               NULL, &timeout);
1229         errno_save = errno;
1230         close_message_queues();
1231         if (ret == -1) {
1232                 if (errno_save == ETIMEDOUT) {
1233                         ERROR("Timed out- probably the filesystem "
1234                                         "daemon crashed and the WIM was not "
1235                                         "written successfully.\n");
1236                         return WIMLIB_ERR_TIMEOUT;
1237                 } else {
1238                         ERROR("mq_receive(): %s\n",
1239                                         strerror(errno_save));
1240                         return WIMLIB_ERR_MQUEUE;
1241                 }
1242
1243         }
1244         DEBUG("Received message: %s\n", (mailbox[0] == 0) ? 
1245                                         "Unmount OK" : "Unmount Failed");
1246         if (mailbox[0] != 0)
1247                 ERROR("Unmount failed\n");
1248         return mailbox[0];
1249 }
1250
1251 #else /* WITH_FUSE */
1252
1253
1254 static inline int mount_unsupported_error()
1255 {
1256         ERROR("WIMLIB was compiled with --without-fuse, which "
1257                         "disables support for mounting WIMs.\n");
1258         return WIMLIB_ERR_UNSUPPORTED;
1259 }
1260
1261 WIMLIBAPI int wimlib_unmount(const char *dir, int flags)
1262 {
1263         return mount_unsupported_error();
1264 }
1265
1266 WIMLIBAPI int wimlib_mount(WIMStruct *wim_p, int image, const char *dir, 
1267                            int flags)
1268 {
1269         return mount_unsupported_error();
1270 }
1271
1272 #endif /* WITH_FUSE */