Initial rewrite of resource code
[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         /* Keep track of how many WIMs reference this security data (used when
239          * exporting images between WIMs) */
240         u32 refcnt;
241 };
242
243 /* Metadata for a WIM image */
244 struct wim_image_metadata {
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 inodes of this image */
257         struct hlist_head inode_list;
258
259         struct list_head unhashed_streams;
260
261         /* 1 iff the dentry tree has been modified.  If this is the case, the
262          * memory for the dentry tree should not be freed when switching to a
263          * different WIM image. */
264         u8 modified : 1;
265
266         /* 1 iff this image has been mounted read-write */
267         u8 has_been_mounted_rw : 1;
268 };
269
270 /* The opaque structure exposed to the wimlib API. */
271 struct WIMStruct {
272
273         /* A pointer to the file indicated by @filename, opened for reading. */
274         FILE *fp;
275
276 #ifdef WITH_FUSE
277         /* Extra file pointers to be used by concurrent readers */
278         FILE **fp_tab;
279         size_t num_allocated_fps;
280         pthread_mutex_t fp_tab_mutex;
281 #endif
282
283         /* FILE pointer for the WIM file (if any) currently being written. */
284         FILE *out_fp;
285
286         /* The name of the WIM file (if any) that has been opened. */
287         tchar *filename;
288
289         /* The lookup table for the WIM file. */
290         struct wim_lookup_table *lookup_table;
291
292         /* Pointer to the XML data read from the WIM file (UTF16LE-encoded). */
293         utf16lechar *xml_data;
294
295         /* Information retrieved from the XML data, arranged in an orderly
296          * manner. */
297         struct wim_info *wim_info;
298
299         /* Array of the image metadata, one for each image in the WIM. */
300         struct wim_image_metadata *image_metadata;
301
302         /* The header of the WIM file. */
303         struct wim_header hdr;
304
305         /* Temporary field */
306         void *private;
307
308 #ifdef WITH_NTFS_3G
309         struct _ntfs_volume *ntfs_vol;
310 #endif
311
312         /* The currently selected image, indexed starting at 1.  If not 0,
313          * subtract 1 from this to get the index of the current image in the
314          * image_metadata array. */
315         int current_image;
316
317         u8 deletion_occurred : 1;
318         u8 all_images_verified : 1;
319         u8 wim_locked : 1;
320 };
321
322 /* Inline utility functions for WIMStructs. */
323
324 static inline struct wim_dentry *
325 wim_root_dentry(WIMStruct *w)
326 {
327         return w->image_metadata[w->current_image - 1].root_dentry;
328 }
329
330 static inline struct wim_security_data *
331 wim_security_data(WIMStruct *w)
332 {
333         return w->image_metadata[w->current_image - 1].security_data;
334 }
335 static inline const struct wim_security_data *
336 wim_const_security_data(const WIMStruct *w)
337 {
338         return w->image_metadata[w->current_image - 1].security_data;
339 }
340
341 static inline struct wim_image_metadata *
342 wim_get_current_image_metadata(WIMStruct *w)
343 {
344         return &w->image_metadata[w->current_image - 1];
345 }
346
347 /* Nonzero if a struct resource_entry indicates a compressed resource. */
348 static inline int
349 resource_is_compressed(const struct resource_entry *entry)
350 {
351         return (entry->flags & WIM_RESHDR_FLAG_COMPRESSED);
352 }
353
354 /* add_image.c */
355
356 extern bool
357 exclude_path(const tchar *path, size_t path_len,
358              const struct wimlib_capture_config *config,
359              bool exclude_prefix);
360
361 extern int
362 add_new_dentry_tree(WIMStruct *dest_wim, struct wim_dentry *root,
363                     struct wim_security_data *sd);
364
365
366 /* extract_image.c */
367
368 /* Internal use only */
369 #define WIMLIB_EXTRACT_FLAG_MULTI_IMAGE         0x80000000
370 #define WIMLIB_EXTRACT_FLAG_NO_STREAMS          0x40000000
371 #define WIMLIB_EXTRACT_MASK_PUBLIC              0x3fffffff
372
373 /* hardlink.c */
374
375 /* Hash table to find inodes, given an inode number (in the case of reading
376  * a WIM images), or both an inode number and a device number (in the case of
377  * capturing a WIM image). */
378 struct wim_inode_table {
379         /* Fields for the hash table */
380         struct hlist_head *array;
381         u64 num_entries;
382         u64 capacity;
383
384         /*
385          * Linked list of "extra" inodes.  These may be:
386          *
387          * - inodes with link count 1, which are all allowed to have 0 for their
388          *   inode number, meaning we cannot insert them into the hash table.
389          *
390          * - Groups we create ourselves by splitting a nominal inode due to
391          *   inconsistencies in the dentries.  These inodes will share an inode
392          *   number with some other inode until assign_inode_numbers() is
393          *   called.
394          */
395         struct hlist_head extra_inodes;
396 };
397
398 extern int
399 init_inode_table(struct wim_inode_table *table, size_t capacity);
400
401 extern int
402 inode_table_new_dentry(struct wim_inode_table *table, const tchar *name,
403                        u64 ino, u64 devno, struct wim_dentry **dentry_ret);
404
405 extern void
406 inode_table_prepare_inode_list(struct wim_inode_table *table,
407                                struct hlist_head *head);
408
409 static inline void
410 destroy_inode_table(struct wim_inode_table *table)
411 {
412         FREE(table->array);
413 }
414
415
416 extern int
417 dentry_tree_fix_inodes(struct wim_dentry *root, struct hlist_head *inode_list);
418
419 /* header.c */
420
421 extern int
422 read_header(FILE *fp, struct wim_header *hdr, int split_ok);
423
424 extern int
425 write_header(const struct wim_header *hdr, FILE *out);
426
427 extern int
428 init_header(struct wim_header *hdr, int ctype);
429
430 /* integrity.c */
431
432 #define WIM_INTEGRITY_OK 0
433 #define WIM_INTEGRITY_NOT_OK -1
434 #define WIM_INTEGRITY_NONEXISTENT -2
435
436 extern int
437 write_integrity_table(FILE *out, struct resource_entry *integrity_res_entry,
438                       off_t new_lookup_table_end,
439                       off_t old_lookup_table_end,
440                       wimlib_progress_func_t progress_func);
441
442 extern int
443 check_wim_integrity(WIMStruct *w, wimlib_progress_func_t progress_func);
444
445 /* join.c */
446
447 extern int
448 new_joined_lookup_table(WIMStruct *w, WIMStruct **additional_swms,
449                         unsigned num_additional_swms,
450                         struct wim_lookup_table **table_ret);
451
452 /* metadata_resource.c */
453
454 extern int
455 read_metadata_resource(WIMStruct *w,
456                                   struct wim_image_metadata *image_metadata);
457
458 extern int
459 write_metadata_resource(WIMStruct *w);
460
461 /* ntfs-apply.c */
462
463 struct apply_args {
464         WIMStruct *w;
465         const tchar *target;
466         int extract_flags;
467         union wimlib_progress_info progress;
468         wimlib_progress_func_t progress_func;
469         int (*apply_dentry)(struct wim_dentry *, void *);
470         union {
471         #ifdef WITH_NTFS_3G
472                 struct {
473                         /* NTFS apply only */
474                         struct _ntfs_volume *vol;
475                 };
476         #endif
477                 struct {
478                         /* Normal apply only (UNIX) */
479                         unsigned long num_utime_warnings;
480                 };
481
482                 struct {
483                         /* Normal apply only (Win32) */
484                         unsigned long num_set_sacl_priv_notheld;
485                         unsigned long num_set_sd_access_denied;
486                 };
487         };
488 };
489
490 extern int
491 apply_dentry_ntfs(struct wim_dentry *dentry, void *arg);
492
493 extern int
494 apply_dentry_timestamps_ntfs(struct wim_dentry *dentry, void *arg);
495
496 extern void
497 libntfs3g_global_init();
498
499 /* ntfs-capture.c */
500
501 /* The types of these two callbacks are intentionally the same. */
502 typedef int (*consume_data_callback_t)(const void *buf, size_t len, void *ctx);
503
504 extern int
505 read_ntfs_file_prefix(const struct wim_lookup_table_entry *lte,
506                       u64 size,
507                       consume_data_callback_t cb,
508                       void *ctx_or_buf,
509                       int _ignored_flags);
510 extern int
511 build_dentry_tree_ntfs(struct wim_dentry **root_p,
512                        const tchar *device,
513                        struct wim_lookup_table *lookup_table,
514                        struct wim_inode_table *inode_table,
515                        struct sd_set *sd_set,
516                        const struct wimlib_capture_config *config,
517                        int add_image_flags,
518                        wimlib_progress_func_t progress_func,
519                        void *extra_arg);
520
521 /* resource.c */
522
523 #define WIMLIB_RESOURCE_FLAG_RAW                0x1
524 #define WIMLIB_RESOURCE_FLAG_MULTITHREADED      0x2
525 #define WIMLIB_RESOURCE_FLAG_RECOMPRESS         0x4
526
527 extern int
528 read_resource_prefix(const struct wim_lookup_table_entry *lte,
529                      u64 size, consume_data_callback_t cb, void *ctx_or_buf,
530                      int flags);
531
532 extern const void *
533 get_resource_entry(const void *p, struct resource_entry *entry);
534
535 extern void *
536 put_resource_entry(void *p, const struct resource_entry *entry);
537
538 extern int
539 read_uncompressed_resource(FILE *fp, u64 offset, u64 size, void *buf);
540
541 extern int
542 read_partial_wim_resource_into_buf(const struct wim_lookup_table_entry *lte,
543                                    size_t size, u64 offset, void *buf,
544                                    bool threadsafe);
545 extern int
546 read_full_resource_into_buf(const struct wim_lookup_table_entry *lte,
547                             void *buf, bool thread_safe);
548
549 extern int
550 write_wim_resource(struct wim_lookup_table_entry *lte, FILE *out_fp,
551                    int out_ctype, struct resource_entry *out_res_entry,
552                    int flags);
553
554 extern int
555 extract_wim_resource(const struct wim_lookup_table_entry *lte,
556                      u64 size,
557                      consume_data_callback_t extract_chunk,
558                      void *extract_chunk_arg);
559
560 extern int
561 extract_wim_resource_to_fd(const struct wim_lookup_table_entry *lte,
562                            int fd, u64 size);
563
564 extern int
565 copy_resource(struct wim_lookup_table_entry *lte, void *w);
566
567 /* security.c */
568 extern int
569 read_security_data(const u8 metadata_resource[],
570                    u64 metadata_resource_len, struct wim_security_data **sd_p);
571 extern void
572 print_security_data(const struct wim_security_data *sd);
573
574 extern u8 *
575 write_security_data(const struct wim_security_data *sd, u8 *p);
576
577 extern void
578 free_security_data(struct wim_security_data *sd);
579
580 /* symlink.c */
581
582 #ifndef __WIN32__
583 ssize_t
584 inode_readlink(const struct wim_inode *inode, char *buf, size_t buf_len,
585                const WIMStruct *w, bool threadsafe);
586
587 extern int
588 inode_set_symlink(struct wim_inode *inode, const char *target,
589                   struct wim_lookup_table *lookup_table,
590                   struct wim_lookup_table_entry **lte_ret);
591 #endif
592
593 /* verify.c */
594
595 extern int
596 verify_dentry(struct wim_dentry *dentry, void *wim);
597
598 extern int
599 wim_run_full_verifications(WIMStruct *w);
600
601 extern int
602 verify_swm_set(WIMStruct *w,
603                WIMStruct **additional_swms, unsigned num_additional_swms);
604
605 /* wim.c */
606
607 extern int
608 select_wim_image(WIMStruct *w, int image);
609
610 extern int
611 for_image(WIMStruct *w, int image, int (*visitor)(WIMStruct *));
612
613 extern void
614 destroy_image_metadata(struct wim_image_metadata *imd,
615                        struct wim_lookup_table *lt);
616
617 /* write.c */
618
619 /* Internal use only */
620 #define WIMLIB_WRITE_FLAG_NO_LOOKUP_TABLE       0x80000000
621 #define WIMLIB_WRITE_FLAG_REUSE_INTEGRITY_TABLE 0x40000000
622 #define WIMLIB_WRITE_FLAG_CHECKPOINT_AFTER_XML  0x20000000
623 #define WIMLIB_WRITE_MASK_PUBLIC                0x1fffffff
624
625 /* We are capturing a tree to be placed in the root of the WIM image */
626 #define WIMLIB_ADD_IMAGE_FLAG_ROOT      0x80000000
627
628 /* We are capturing a dentry that will become the root of a tree to be added to
629  * the WIM image */
630 #define WIMLIB_ADD_IMAGE_FLAG_SOURCE    0x40000000
631
632
633 extern int
634 begin_write(WIMStruct *w, const tchar *path, int write_flags);
635
636 extern void
637 close_wim_writable(WIMStruct *w);
638
639 extern int
640 finish_write(WIMStruct *w, int image, int write_flags,
641              wimlib_progress_func_t progress_func);
642
643 #if defined(HAVE_SYS_FILE_H) && defined(HAVE_FLOCK)
644 extern int
645 lock_wim(WIMStruct *w, FILE *fp);
646 #else
647 static inline int
648 lock_wim(WIMStruct *w, FILE *fp)
649 {
650         return 0;
651 }
652 #endif
653
654 #endif /* _WIMLIB_INTERNAL_H */
655