Fixes, comments
[wimlib] / src / wimlib_internal.h
1 /*
2  * wimlib_internal.h
3  *
4  * Internal header for wimlib.
5  */
6
7 /*
8  * Copyright (C) 2012, 2013 Eric Biggers
9  *
10  * This file is part of wimlib, a library for working with WIM files.
11  *
12  * wimlib is free software; you can redistribute it and/or modify it under the
13  * terms of the GNU General Public License as published by the Free
14  * Software Foundation; either version 3 of the License, or (at your option)
15  * any later version.
16  *
17  * wimlib is distributed in the hope that it will be useful, but WITHOUT ANY
18  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
19  * A PARTICULAR PURPOSE. See the GNU General Public License for more
20  * details.
21  *
22  * You should have received a copy of the GNU General Public License
23  * along with wimlib; if not, see http://www.gnu.org/licenses/.
24  */
25
26 #ifndef _WIMLIB_INTERNAL_H
27 #define _WIMLIB_INTERNAL_H
28
29 #include "config.h"
30 #include "util.h"
31 #include "list.h"
32 #include "wimlib.h"
33
34 #ifdef WITH_FUSE
35 #include <pthread.h>
36 #endif
37
38 #define WIMLIB_MAKEVERSION(major, minor, patch) \
39         ((major << 20) | (minor << 10) | patch)
40
41
42 #define WIMLIB_VERSION_CODE \
43                 WIMLIB_MAKEVERSION(WIMLIB_MAJOR_VERSION,\
44                                    WIMLIB_MINOR_VERSION,\
45                                    WIMLIB_PATCH_VERSION)
46
47 #define WIMLIB_GET_PATCH_VERSION(version) \
48         ((version >> 0) & ((1 << 10) - 1))
49 #define WIMLIB_GET_MINOR_VERSION(version) \
50         ((version >> 10) & ((1 << 10) - 1))
51 #define WIMLIB_GET_MAJOR_VERSION(version) \
52         ((version >> 20) & ((1 << 10) - 1))
53
54
55 struct stat;
56 struct wim_dentry;
57 struct wim_inode;
58 struct sd_set;
59
60 #define WIM_MAGIC_LEN  8
61 #define WIM_GID_LEN    16
62 #define WIM_UNUSED_LEN 60
63
64 /* Length of the WIM header on disk. */
65 #define WIM_HEADER_DISK_SIZE (148 + WIM_UNUSED_LEN)
66
67 /* Compressed resources in the WIM are divided into separated compressed chunks
68  * of this size. */
69 #define WIM_CHUNK_SIZE 32768
70
71 /* Version of the WIM file.  There is an older version, but we don't support it
72  * yet.  The differences between the versions are undocumented. */
73 #define WIM_VERSION 0x10d00
74
75 /* Metadata for a resource in a WIM file. */
76 struct resource_entry {
77         /* Size, in bytes, of the resource in the WIM file. */
78         u64 size  : 56;
79
80         /* Bitwise or of one or more of the WIM_RESHDR_FLAG_* flags. */
81         u64 flags : 8;
82
83         /* Offset, in bytes, of the resource in the WIM file. */
84         u64 offset;
85
86         /* Uncompressed size of the resource in the WIM file.  Is the same as
87          * @size if the resource is uncompressed. */
88         u64 original_size;
89 };
90
91 /* Flags for the `flags' field of the struct resource_entry structure. */
92
93 /* I haven't seen this flag used in any of the WIMs I have examined.  I assume
94  * it means that there are no references to the stream, so the space is free.
95  * However, even after deleting files from a WIM mounted with `imagex.exe
96  * /mountrw', I could not see this flag being used.  Either way, we don't
97  * actually use this flag for anything. */
98 #define WIM_RESHDR_FLAG_FREE            0x01
99
100 /* Indicates that the stream is a metadata resource for a WIM image. */
101 #define WIM_RESHDR_FLAG_METADATA        0x02
102
103 /* Indicates that the stream is compressed. */
104 #define WIM_RESHDR_FLAG_COMPRESSED      0x04
105
106 /* I haven't seen this flag used in any of the WIMs I have examined.  Perhaps it
107  * means that a stream could possibly be split among multiple split WIM parts.
108  * However, `imagex.exe /split' does not seem to create any WIMs like this.
109  * Either way, we don't actually use this flag for anything.  */
110 #define WIM_RESHDR_FLAG_SPANNED         0x08
111
112 /* Header at the very beginning of the WIM file. */
113 struct wim_header {
114         /* Identifies the file as WIM file. Must be exactly
115          * {'M', 'S', 'W', 'I', 'M', 0, 0, 0}  */
116         //u8  magic[WIM_MAGIC_LEN];
117
118         /* size of WIM header in bytes. */
119         //u32 hdr_size;
120
121         /* Version of the WIM file.  Microsoft provides no documentation about
122          * exactly what this field affects about the file format, other than the
123          * fact that more recent versions have a higher value. */
124         //u32 version;
125
126         /* Bitwise OR of one or more of the WIM_HDR_FLAG_* defined below. */
127         u32 flags;
128
129         /* The size of the pieces that the uncompressed files were split up into
130          * when they were compressed.  This should be the same as
131          * WIM_CHUNK_SIZE.  Microsoft incorrectly documents this as "the size of
132          * the compressed .wim file in bytes".*/
133         //u32 chunk_size;
134
135         /* A unique identifier for the WIM file. */
136         u8 guid[WIM_GID_LEN];
137
138         /* Part number of the WIM file in a spanned set. */
139         u16 part_number;
140
141         /* Total number of parts in a spanned set. */
142         u16 total_parts;
143
144         /* Number of images in the WIM file. */
145         u32 image_count;
146
147         /* Location, size, and flags of the lookup table of the WIM. */
148         struct resource_entry lookup_table_res_entry;
149
150         /* Location, size, and flags for the XML data of the WIM. */
151         struct resource_entry xml_res_entry;
152
153         /* Location, size, and flags for the boot metadata.  This means the
154          * metadata resource for the image specified by boot_idx below.  Should
155          * be zeroed out if boot_idx is 0. */
156         struct resource_entry boot_metadata_res_entry;
157
158         /* The index of the bootable image in the WIM file. If 0, there are no
159          * bootable images available. */
160         u32 boot_idx;
161
162         /* The location of the optional integrity table used to verify the
163          * integrity WIM.  Zeroed out if there is no integrity table.*/
164         struct resource_entry integrity;
165
166         /* Reserved for future disuse */
167         //u8 unused[WIM_UNUSED_LEN];
168 };
169
170 /* Flags for the `flags' field of the struct wim_header: */
171
172 /* Reserved for future use */
173 #define WIM_HDR_FLAG_RESERVED           0x00000001
174
175 /* Files and metadata in the WIM are compressed. */
176 #define WIM_HDR_FLAG_COMPRESSION        0x00000002
177
178 /* WIM is read-only (wimlib ignores this because it's pretty much pointless) */
179 #define WIM_HDR_FLAG_READONLY           0x00000004
180
181 /* Resource data specified by images in this WIM may be contained in a different
182  * WIM.  Or in other words, this WIM is part of a split WIM.  */
183 #define WIM_HDR_FLAG_SPANNED            0x00000008
184
185 /* The WIM contains resources only; no filesystem metadata.  wimlib ignores this
186  * flag, as it looks for resources in all the WIMs anyway. */
187 #define WIM_HDR_FLAG_RESOURCE_ONLY      0x00000010
188
189 /* The WIM contains metadata only.  wimlib ignores this flag.  Note that all the
190  * metadata resources for a split WIM should be in the first part. */
191 #define WIM_HDR_FLAG_METADATA_ONLY      0x00000020
192
193 /* Lock field to prevent multiple writers from writing the WIM concurrently.
194  * wimlib ignores this flag as it uses flock() to acquire a real lock on the
195  * file (if supported by the underlying filesystem). */
196 #define WIM_HDR_FLAG_WRITE_IN_PROGRESS  0x00000040
197
198 /* Reparse point fixup ???
199  * This has something to do with absolute targets of reparse points / symbolic
200  * links but I don't know what.  wimlib ignores this flag.  */
201 #define WIM_HDR_FLAG_RP_FIX             0x00000080
202
203 /* Unused, reserved flag for another compression type */
204 #define WIM_HDR_FLAG_COMPRESS_RESERVED  0x00010000
205
206 /* Resources within the WIM are compressed using "XPRESS" compression, which is
207  * a LZ77-based compression algorithm. */
208 #define WIM_HDR_FLAG_COMPRESS_XPRESS    0x00020000
209
210 /* Resources within the WIM are compressed using "LZX" compression.  This is also
211  * a LZ77-based algorithm. */
212 #define WIM_HDR_FLAG_COMPRESS_LZX       0x00040000
213
214 #ifdef WITH_NTFS_3G
215 struct _ntfs_volume;
216 #endif
217
218 /* Table of security descriptors for a WIM image. */
219 struct wim_security_data {
220         /* The total length of the security data, in bytes.  If there are no
221          * security descriptors, this field, when read from the on-disk metadata
222          * resource, may be either 8 (which is correct) or 0 (which is
223          * interpreted as 0). */
224         u32 total_length;
225
226         /* The number of security descriptors in the array @descriptors, below.
227          * It is really an unsigned int on-disk, but it must fit into an int
228          * because the security ID's are signed.  (Not like you would ever have
229          * more than a few hundred security descriptors anyway.) */
230         int32_t num_entries;
231
232         /* Array of sizes of the descriptors in the array @descriptors. */
233         u64 *sizes;
234
235         /* Array of descriptors. */
236         u8 **descriptors;
237 };
238
239 /* Metadata for a WIM image */
240 struct wim_image_metadata {
241
242         /* Number of WIMStruct's that are sharing this image metadata (from
243          * calls to wimlib_export_image().) */
244         unsigned long refcnt;
245
246         /* Pointer to the root dentry of the image. */
247         struct wim_dentry *root_dentry;
248
249         /* Pointer to the security data of the image. */
250         struct wim_security_data *security_data;
251
252         /* Pointer to the lookup table entry for this image's metadata resource
253          */
254         struct wim_lookup_table_entry *metadata_lte;
255
256         /* Linked list of 'struct wim_inode's for this image. */
257         struct list_head inode_list;
258
259         /* Linked list of 'struct wim_lookup_table_entry's for this image that
260          * are referred to in the dentry tree, but have not had a SHA1 message
261          * digest calculated yet and therefore have not been inserted into the
262          * WIM's lookup table.  This list is added to during wimlib_add_image()
263          * and wimlib_mount_image() (read-write only). */
264         struct list_head unhashed_streams;
265
266         /* 1 iff the dentry tree has been modified.  If this is the case, the
267          * memory for the dentry tree should not be freed when switching to a
268          * different WIM image. */
269         u8 modified : 1;
270
271         /* 1 iff this image has been mounted read-write */
272         u8 has_been_mounted_rw : 1;
273 };
274
275 /* The opaque structure exposed to the wimlib API. */
276 struct WIMStruct {
277
278         /* A pointer to the file indicated by @filename, opened for reading. */
279         FILE *fp;
280
281 #ifdef WITH_FUSE
282         /* Extra file pointers to be used by concurrent readers */
283         FILE **fp_tab;
284         size_t num_allocated_fps;
285         pthread_mutex_t fp_tab_mutex;
286 #endif
287
288         /* FILE pointer for the WIM file (if any) currently being written. */
289         FILE *out_fp;
290
291         /* The name of the WIM file (if any) that has been opened. */
292         tchar *filename;
293
294         /* The lookup table for the WIM file. */
295         struct wim_lookup_table *lookup_table;
296
297         /* Pointer to the XML data read from the WIM file (UTF16LE-encoded). */
298         utf16lechar *xml_data;
299
300         /* Information retrieved from the XML data, arranged in an orderly
301          * manner. */
302         struct wim_info *wim_info;
303
304         /* Array of the image metadata, one for each image in the WIM. */
305         struct wim_image_metadata **image_metadata;
306
307         /* The header of the WIM file. */
308         struct wim_header hdr;
309
310         /* Temporary field */
311         void *private;
312
313 #ifdef WITH_NTFS_3G
314         struct _ntfs_volume *ntfs_vol;
315 #endif
316
317         /* The currently selected image, indexed starting at 1.  If not 0,
318          * subtract 1 from this to get the index of the current image in the
319          * image_metadata array. */
320         int current_image;
321
322         u8 deletion_occurred : 1;
323         u8 all_images_verified : 1;
324         u8 wim_locked : 1;
325 };
326
327 /* Inline utility functions for WIMStructs. */
328
329 static inline struct wim_image_metadata *
330 wim_get_current_image_metadata(WIMStruct *w)
331 {
332         return w->image_metadata[w->current_image - 1];
333 }
334
335 static inline const struct wim_image_metadata *
336 wim_get_const_current_image_metadata(const WIMStruct *w)
337 {
338         return w->image_metadata[w->current_image - 1];
339 }
340
341 static inline struct wim_dentry *
342 wim_root_dentry(WIMStruct *w)
343 {
344         return wim_get_current_image_metadata(w)->root_dentry;
345 }
346
347 static inline struct wim_security_data *
348 wim_security_data(WIMStruct *w)
349 {
350         return wim_get_current_image_metadata(w)->security_data;
351 }
352
353 static inline const struct wim_security_data *
354 wim_const_security_data(const WIMStruct *w)
355 {
356         return wim_get_const_current_image_metadata(w)->security_data;
357 }
358
359 /* Nonzero if a struct resource_entry indicates a compressed resource. */
360 static inline int
361 resource_is_compressed(const struct resource_entry *entry)
362 {
363         return (entry->flags & WIM_RESHDR_FLAG_COMPRESSED);
364 }
365
366 #define image_for_each_inode(inode, imd) \
367         list_for_each_entry(inode, &imd->inode_list, i_list)
368
369 #define image_for_each_unhashed_stream(lte, imd) \
370         list_for_each_entry(lte, &imd->unhashed_streams, unhashed_list)
371
372 /* add_image.c */
373
374 extern bool
375 exclude_path(const tchar *path, size_t path_len,
376              const struct wimlib_capture_config *config,
377              bool exclude_prefix);
378
379 /* extract_image.c */
380
381 /* Internal use only */
382 #define WIMLIB_EXTRACT_FLAG_MULTI_IMAGE         0x80000000
383 #define WIMLIB_EXTRACT_FLAG_NO_STREAMS          0x40000000
384 #define WIMLIB_EXTRACT_MASK_PUBLIC              0x3fffffff
385
386 /* hardlink.c */
387
388 /* Hash table to find inodes, given an inode number (in the case of reading
389  * a WIM images), or both an inode number and a device number (in the case of
390  * capturing a WIM image). */
391 struct wim_inode_table {
392         /* Fields for the hash table */
393         struct hlist_head *array;
394         u64 num_entries;
395         u64 capacity;
396
397         /*
398          * Linked list of "extra" inodes.  These may be:
399          *
400          * - inodes with link count 1, which are all allowed to have 0 for their
401          *   inode number, meaning we cannot insert them into the hash table.
402          *
403          * - Groups we create ourselves by splitting a nominal inode due to
404          *   inconsistencies in the dentries.  These inodes will share an inode
405          *   number with some other inode until assign_inode_numbers() is
406          *   called.
407          */
408         struct list_head extra_inodes;
409 };
410
411 extern int
412 init_inode_table(struct wim_inode_table *table, size_t capacity);
413
414 extern int
415 inode_table_new_dentry(struct wim_inode_table *table, const tchar *name,
416                        u64 ino, u64 devno, struct wim_dentry **dentry_ret);
417
418 extern void
419 inode_ref_streams(struct wim_inode *inode);
420
421 extern void
422 inode_table_prepare_inode_list(struct wim_inode_table *table,
423                                struct list_head *head);
424
425 static inline void
426 destroy_inode_table(struct wim_inode_table *table)
427 {
428         FREE(table->array);
429 }
430
431
432 extern int
433 dentry_tree_fix_inodes(struct wim_dentry *root, struct list_head *inode_list);
434
435 /* header.c */
436
437 extern int
438 read_header(FILE *fp, struct wim_header *hdr, int split_ok);
439
440 extern int
441 write_header(const struct wim_header *hdr, FILE *out);
442
443 extern int
444 init_header(struct wim_header *hdr, int ctype);
445
446 /* integrity.c */
447
448 #define WIM_INTEGRITY_OK 0
449 #define WIM_INTEGRITY_NOT_OK -1
450 #define WIM_INTEGRITY_NONEXISTENT -2
451
452 extern int
453 write_integrity_table(FILE *out, struct resource_entry *integrity_res_entry,
454                       off_t new_lookup_table_end,
455                       off_t old_lookup_table_end,
456                       wimlib_progress_func_t progress_func);
457
458 extern int
459 check_wim_integrity(WIMStruct *w, wimlib_progress_func_t progress_func);
460
461 /* join.c */
462
463 extern int
464 new_joined_lookup_table(WIMStruct *w, WIMStruct **additional_swms,
465                         unsigned num_additional_swms,
466                         struct wim_lookup_table **table_ret);
467
468 /* metadata_resource.c */
469
470 extern int
471 read_metadata_resource(WIMStruct *w,
472                                   struct wim_image_metadata *image_metadata);
473
474 extern int
475 write_metadata_resource(WIMStruct *w);
476
477 /* ntfs-apply.c */
478
479 struct apply_args {
480         WIMStruct *w;
481         const tchar *target;
482         int extract_flags;
483         union wimlib_progress_info progress;
484         wimlib_progress_func_t progress_func;
485         int (*apply_dentry)(struct wim_dentry *, void *);
486         union {
487         #ifdef WITH_NTFS_3G
488                 struct {
489                         /* NTFS apply only */
490                         struct _ntfs_volume *vol;
491                 };
492         #endif
493                 struct {
494                         /* Normal apply only (UNIX) */
495                         unsigned long num_utime_warnings;
496                 };
497
498                 struct {
499                         /* Normal apply only (Win32) */
500                         unsigned long num_set_sacl_priv_notheld;
501                         unsigned long num_set_sd_access_denied;
502                 };
503         };
504 };
505
506 extern int
507 apply_dentry_ntfs(struct wim_dentry *dentry, void *arg);
508
509 extern int
510 apply_dentry_timestamps_ntfs(struct wim_dentry *dentry, void *arg);
511
512 extern void
513 libntfs3g_global_init();
514
515 /* ntfs-capture.c */
516
517 /* The types of these two callbacks are intentionally the same. */
518 typedef int (*consume_data_callback_t)(const void *buf, size_t len, void *ctx);
519
520 extern int
521 read_ntfs_file_prefix(const struct wim_lookup_table_entry *lte,
522                       u64 size,
523                       consume_data_callback_t cb,
524                       void *ctx_or_buf,
525                       int _ignored_flags);
526 extern int
527 build_dentry_tree_ntfs(struct wim_dentry **root_p,
528                        const tchar *device,
529                        struct wim_lookup_table *lookup_table,
530                        struct wim_inode_table *inode_table,
531                        struct sd_set *sd_set,
532                        const struct wimlib_capture_config *config,
533                        int add_image_flags,
534                        wimlib_progress_func_t progress_func,
535                        void *extra_arg);
536
537 /* resource.c */
538
539 #define WIMLIB_RESOURCE_FLAG_RAW                0x1
540 #define WIMLIB_RESOURCE_FLAG_MULTITHREADED      0x2
541 #define WIMLIB_RESOURCE_FLAG_RECOMPRESS         0x4
542
543 extern int
544 read_resource_prefix(const struct wim_lookup_table_entry *lte,
545                      u64 size, consume_data_callback_t cb, void *ctx_or_buf,
546                      int flags);
547
548 extern const void *
549 get_resource_entry(const void *p, struct resource_entry *entry);
550
551 extern void *
552 put_resource_entry(void *p, const struct resource_entry *entry);
553
554 extern int
555 read_uncompressed_resource(FILE *fp, u64 offset, u64 size, void *buf);
556
557 extern int
558 read_partial_wim_resource_into_buf(const struct wim_lookup_table_entry *lte,
559                                    size_t size, u64 offset, void *buf,
560                                    bool threadsafe);
561 extern int
562 read_full_resource_into_buf(const struct wim_lookup_table_entry *lte,
563                             void *buf, bool thread_safe);
564
565 extern int
566 write_wim_resource(struct wim_lookup_table_entry *lte, FILE *out_fp,
567                    int out_ctype, struct resource_entry *out_res_entry,
568                    int flags);
569
570 extern int
571 extract_wim_resource(const struct wim_lookup_table_entry *lte,
572                      u64 size,
573                      consume_data_callback_t extract_chunk,
574                      void *extract_chunk_arg);
575
576 extern int
577 extract_wim_resource_to_fd(const struct wim_lookup_table_entry *lte,
578                            int fd, u64 size);
579
580 extern int
581 copy_resource(struct wim_lookup_table_entry *lte, void *w);
582
583 /* security.c */
584 extern int
585 read_security_data(const u8 metadata_resource[],
586                    u64 metadata_resource_len, struct wim_security_data **sd_p);
587 extern void
588 print_security_data(const struct wim_security_data *sd);
589
590 extern u8 *
591 write_security_data(const struct wim_security_data *sd, u8 *p);
592
593 extern void
594 free_security_data(struct wim_security_data *sd);
595
596 /* symlink.c */
597
598 #ifndef __WIN32__
599 ssize_t
600 inode_readlink(const struct wim_inode *inode, char *buf, size_t buf_len,
601                const WIMStruct *w, bool threadsafe);
602
603 extern int
604 inode_set_symlink(struct wim_inode *inode, const char *target,
605                   struct wim_lookup_table *lookup_table,
606                   struct wim_lookup_table_entry **lte_ret);
607 #endif
608
609 /* verify.c */
610
611 extern int
612 verify_dentry(struct wim_dentry *dentry, void *wim);
613
614 extern int
615 wim_run_full_verifications(WIMStruct *w);
616
617 extern int
618 verify_swm_set(WIMStruct *w,
619                WIMStruct **additional_swms, unsigned num_additional_swms);
620
621 /* wim.c */
622
623 extern int
624 select_wim_image(WIMStruct *w, int image);
625
626 extern int
627 for_image(WIMStruct *w, int image, int (*visitor)(WIMStruct *));
628
629 extern void
630 destroy_image_metadata(struct wim_image_metadata *imd,
631                        struct wim_lookup_table *table,
632                        bool free_metadata_lte);
633
634 extern void
635 put_image_metadata(struct wim_image_metadata *imd,
636                    struct wim_lookup_table *table);
637
638 extern int
639 append_image_metadata(WIMStruct *w, struct wim_image_metadata *imd);
640
641 extern struct wim_image_metadata *
642 new_image_metadata();
643
644 extern struct wim_image_metadata **
645 new_image_metadata_array(unsigned num_images);
646
647 /* write.c */
648
649 /* Internal use only */
650 #define WIMLIB_WRITE_FLAG_NO_LOOKUP_TABLE       0x80000000
651 #define WIMLIB_WRITE_FLAG_REUSE_INTEGRITY_TABLE 0x40000000
652 #define WIMLIB_WRITE_FLAG_CHECKPOINT_AFTER_XML  0x20000000
653 #define WIMLIB_WRITE_MASK_PUBLIC                0x1fffffff
654
655 /* We are capturing a tree to be placed in the root of the WIM image */
656 #define WIMLIB_ADD_IMAGE_FLAG_ROOT      0x80000000
657
658 /* We are capturing a dentry that will become the root of a tree to be added to
659  * the WIM image */
660 #define WIMLIB_ADD_IMAGE_FLAG_SOURCE    0x40000000
661
662
663 extern int
664 begin_write(WIMStruct *w, const tchar *path, int write_flags);
665
666 extern void
667 close_wim_writable(WIMStruct *w);
668
669 extern int
670 finish_write(WIMStruct *w, int image, int write_flags,
671              wimlib_progress_func_t progress_func);
672
673 #if defined(HAVE_SYS_FILE_H) && defined(HAVE_FLOCK)
674 extern int
675 lock_wim(WIMStruct *w, FILE *fp);
676 #else
677 static inline int
678 lock_wim(WIMStruct *w, FILE *fp)
679 {
680         return 0;
681 }
682 #endif
683
684 #endif /* _WIMLIB_INTERNAL_H */
685