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