4 * Internal header for wimlib.
8 * Copyright (C) 2012 Eric Biggers
10 * This file is part of wimlib, a library for working with WIM files.
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)
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
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/.
26 #ifndef _WIMLIB_INTERNAL_H
27 #define _WIMLIB_INTERNAL_H
38 #define WIMLIB_MAKEVERSION(major, minor, patch) \
39 ((major << 20) | (minor << 10) | patch)
42 #define WIMLIB_VERSION_CODE \
43 WIMLIB_MAKEVERSION(WIMLIB_MAJOR_VERSION,\
44 WIMLIB_MINOR_VERSION,\
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))
59 #define WIM_MAGIC_LEN 8
60 #define WIM_GID_LEN 16
61 #define WIM_UNUSED_LEN 60
63 /* Length of the WIM header on disk. */
64 #define WIM_HEADER_DISK_SIZE (148 + WIM_UNUSED_LEN)
66 /* Compressed resources in the WIM are divided into separated compressed chunks
68 #define WIM_CHUNK_SIZE 32768
70 /* Version of the WIM file. There is an older version, but we don't support it
71 * yet. The differences between the versions are undocumented. */
72 #define WIM_VERSION 0x10d00
74 /* Metadata for a resource in a WIM file. */
75 struct resource_entry {
76 /* Size, in bytes, of the resource in the WIM file. */
79 /* Bitwise or of one or more of the WIM_RESHDR_FLAG_* flags. */
82 /* Offset, in bytes, of the resource in the WIM file. */
85 /* Uncompressed size of the resource in the WIM file. Is the same as
86 * @size if the resource is uncompressed. */
90 /* Flags for the `flags' field of the struct resource_entry structure. */
92 /* I haven't seen this flag used in any of the WIMs I have examined. I assume
93 * it means that there are no references to the stream, so the space is free.
94 * However, even after deleting files from a WIM mounted with `imagex.exe
95 * /mountrw', I could not see this flag being used. Either way, we don't
96 * actually use this flag for anything. */
97 #define WIM_RESHDR_FLAG_FREE 0x01
99 /* Indicates that the stream is a metadata resource for a WIM image. */
100 #define WIM_RESHDR_FLAG_METADATA 0x02
102 /* Indicates that the stream is compressed. */
103 #define WIM_RESHDR_FLAG_COMPRESSED 0x04
105 /* I haven't seen this flag used in any of the WIMs I have examined. Perhaps it
106 * means that a stream could possibly be split among multiple split WIM parts.
107 * However, `imagex.exe /split' does not seem to create any WIMs like this.
108 * Either way, we don't actually use this flag for anything. */
109 #define WIM_RESHDR_FLAG_SPANNED 0x08
111 /* Header at the very beginning of the WIM file. */
113 /* Identifies the file as WIM file. Must be exactly
114 * {'M', 'S', 'W', 'I', 'M', 0, 0, 0} */
115 //u8 magic[WIM_MAGIC_LEN];
117 /* size of WIM header in bytes. */
120 /* Version of the WIM file. Microsoft provides no documentation about
121 * exactly what this field affects about the file format, other than the
122 * fact that more recent versions have a higher value. */
125 /* Bitwise OR of one or more of the WIM_HDR_FLAG_* defined below. */
128 /* The size of the pieces that the uncompressed files were split up into
129 * when they were compressed. This should be the same as
130 * WIM_CHUNK_SIZE. Microsoft incorrectly documents this as "the size of
131 * the compressed .wim file in bytes".*/
134 /* A unique identifier for the WIM file. */
135 u8 guid[WIM_GID_LEN];
137 /* Part number of the WIM file in a spanned set. */
140 /* Total number of parts in a spanned set. */
143 /* Number of images in the WIM file. */
146 /* Location, size, and flags of the lookup table of the WIM. */
147 struct resource_entry lookup_table_res_entry;
149 /* Location, size, and flags for the XML data of the WIM. */
150 struct resource_entry xml_res_entry;
152 /* Location, size, and flags for the boot metadata. This means the
153 * metadata resource for the image specified by boot_idx below. Should
154 * be zeroed out if boot_idx is 0. */
155 struct resource_entry boot_metadata_res_entry;
157 /* The index of the bootable image in the WIM file. If 0, there are no
158 * bootable images available. */
161 /* The location of the optional integrity table used to verify the
162 * integrity WIM. Zeroed out if there is no integrity table.*/
163 struct resource_entry integrity;
165 /* Reserved for future disuse */
166 //u8 unused[WIM_UNUSED_LEN];
169 /* Flags for the `flags' field of the struct wim_header: */
171 /* Reserved for future use */
172 #define WIM_HDR_FLAG_RESERVED 0x00000001
174 /* Files and metadata in the WIM are compressed. */
175 #define WIM_HDR_FLAG_COMPRESSION 0x00000002
177 /* WIM is read-only (wimlib ignores this because it's pretty much pointless) */
178 #define WIM_HDR_FLAG_READONLY 0x00000004
180 /* Resource data specified by images in this WIM may be contained in a different
181 * WIM. Or in other words, this WIM is part of a split WIM. */
182 #define WIM_HDR_FLAG_SPANNED 0x00000008
184 /* The WIM contains resources only; no filesystem metadata. wimlib ignores this
185 * flag, as it looks for resources in all the WIMs anyway. */
186 #define WIM_HDR_FLAG_RESOURCE_ONLY 0x00000010
188 /* The WIM contains metadata only. wimlib ignores this flag. Note that all the
189 * metadata resources for a split WIM should be in the first part. */
190 #define WIM_HDR_FLAG_METADATA_ONLY 0x00000020
192 /* Lock field to prevent multiple writers from writing the WIM concurrently.
193 * wimlib ignores this flag as it uses flock() to acquire a real lock on the
194 * file (if supported by the underlying filesystem). */
195 #define WIM_HDR_FLAG_WRITE_IN_PROGRESS 0x00000040
197 /* Reparse point fixup ???
198 * This has something to do with absolute targets of reparse points / symbolic
199 * links but I don't know what. wimlib ignores this flag. */
200 #define WIM_HDR_FLAG_RP_FIX 0x00000080
202 /* Unused, reserved flag for another compression type */
203 #define WIM_HDR_FLAG_COMPRESS_RESERVED 0x00010000
205 /* Resources within the WIM are compressed using "XPRESS" compression, which is
206 * a LZ77-based compression algorithm. */
207 #define WIM_HDR_FLAG_COMPRESS_XPRESS 0x00020000
209 /* Resources within the WIM are compressed using "LZX" compression. This is also
210 * a LZ77-based algorithm. */
211 #define WIM_HDR_FLAG_COMPRESS_LZX 0x00040000
217 /* Table of security descriptors for a WIM image. */
218 struct wim_security_data {
219 /* The total length of the security data, in bytes. If there are no
220 * security descriptors, this field, when read from the on-disk metadata
221 * resource, may be either 8 (which is correct) or 0 (which is
222 * interpreted as 0). */
225 /* The number of security descriptors in the array @descriptors, below.
226 * It is really an unsigned int on-disk, but it must fit into an int
227 * because the security ID's are signed. (Not like you would ever have
228 * more than a few hundred security descriptors anyway.) */
231 /* Array of sizes of the descriptors in the array @descriptors. */
234 /* Array of descriptors. */
237 /* Keep track of how many WIMs reference this security data (used when
238 * exporting images between WIMs) */
242 /* Metadata for a WIM image */
243 struct wim_image_metadata {
245 /* Pointer to the root dentry of the image. */
246 struct wim_dentry *root_dentry;
248 /* Pointer to the security data of the image. */
249 struct wim_security_data *security_data;
251 /* Pointer to the lookup table entry for this image's metadata resource
253 struct wim_lookup_table_entry *metadata_lte;
255 /* Linked list of inodes of this image */
256 struct hlist_head inode_list;
258 /* 1 iff the dentry tree has been modified. If this is the case, the
259 * memory for the dentry tree should not be freed when switching to a
260 * different WIM image. */
263 /* 1 iff this image has been mounted read-write */
264 u8 has_been_mounted_rw : 1;
267 /* The opaque structure exposed to the wimlib API. */
270 /* A pointer to the file indicated by @filename, opened for reading. */
274 /* Extra file pointers to be used by concurrent readers */
276 size_t num_allocated_fps;
277 pthread_mutex_t fp_tab_mutex;
280 /* FILE pointer for the WIM file (if any) currently being written. */
283 /* The name of the WIM file (if any) that has been opened. */
286 /* The lookup table for the WIM file. */
287 struct wim_lookup_table *lookup_table;
289 /* Pointer to the XML data read from the WIM file (UTF16LE-encoded). */
290 utf16lechar *xml_data;
292 /* Information retrieved from the XML data, arranged in an orderly
294 struct wim_info *wim_info;
296 /* Array of the image metadata, one for each image in the WIM. */
297 struct wim_image_metadata *image_metadata;
299 /* The header of the WIM file. */
300 struct wim_header hdr;
302 /* Temporary fields */
308 struct _ntfs_volume *ntfs_vol;
311 /* The currently selected image, indexed starting at 1. If not 0,
312 * subtract 1 from this to get the index of the current image in the
313 * image_metadata array. */
316 u8 deletion_occurred : 1;
317 u8 all_images_verified : 1;
318 u8 full_verification_in_progress : 1;
322 /* Inline utility functions for WIMStructs. */
324 static inline struct wim_dentry *
325 wim_root_dentry(WIMStruct *w)
327 return w->image_metadata[w->current_image - 1].root_dentry;
330 static inline struct wim_security_data *
331 wim_security_data(WIMStruct *w)
333 return w->image_metadata[w->current_image - 1].security_data;
335 static inline const struct wim_security_data *
336 wim_const_security_data(const WIMStruct *w)
338 return w->image_metadata[w->current_image - 1].security_data;
341 static inline struct wim_image_metadata *
342 wim_get_current_image_metadata(WIMStruct *w)
344 return &w->image_metadata[w->current_image - 1];
347 /* Nonzero if a struct resource_entry indicates a compressed resource. */
349 resource_is_compressed(const struct resource_entry *entry)
351 return (entry->flags & WIM_RESHDR_FLAG_COMPRESSED);
356 struct pattern_list {
359 size_t num_allocated_pats;
362 struct capture_config {
363 struct pattern_list exclusion_list;
364 struct pattern_list exclusion_exception;
365 struct pattern_list compression_exclusion_list;
366 struct pattern_list alignment_list;
372 exclude_path(const mbchar *path, const struct capture_config *config,
373 bool exclude_prefix);
376 add_new_dentry_tree(WIMStruct *dest_wim, struct wim_dentry *root,
377 struct wim_security_data *sd);
380 /* extract_image.c */
382 /* Internal use only */
383 #define WIMLIB_EXTRACT_FLAG_MULTI_IMAGE 0x80000000
384 #define WIMLIB_EXTRACT_FLAG_NO_STREAMS 0x40000000
385 #define WIMLIB_EXTRACT_MASK_PUBLIC 0x3fffffff
390 assign_inode_numbers(struct hlist_head *inode_list);
393 dentry_tree_fix_inodes(struct wim_dentry *root, struct hlist_head *inode_list);
398 read_header(FILE *fp, struct wim_header *hdr, int split_ok);
401 write_header(const struct wim_header *hdr, FILE *out);
404 init_header(struct wim_header *hdr, int ctype);
408 #define WIM_INTEGRITY_OK 0
409 #define WIM_INTEGRITY_NOT_OK -1
410 #define WIM_INTEGRITY_NONEXISTENT -2
413 write_integrity_table(FILE *out, struct resource_entry *integrity_res_entry,
414 off_t new_lookup_table_end,
415 off_t old_lookup_table_end,
416 wimlib_progress_func_t progress_func);
419 check_wim_integrity(WIMStruct *w, wimlib_progress_func_t progress_func);
424 new_joined_lookup_table(WIMStruct *w, WIMStruct **additional_swms,
425 unsigned num_additional_swms,
426 struct wim_lookup_table **table_ret);
428 /* metadata_resource.c */
431 read_metadata_resource(WIMStruct *w,
432 struct wim_image_metadata *image_metadata);
435 write_metadata_resource(WIMStruct *w);
441 const mbchar *target;
443 unsigned num_utime_warnings;
444 struct list_head *stream_list;
445 union wimlib_progress_info progress;
447 struct _ntfs_volume *vol;
449 wimlib_progress_func_t progress_func;
450 int (*apply_dentry)(struct wim_dentry *, void *);
454 apply_dentry_ntfs(struct wim_dentry *dentry, void *arg);
457 apply_dentry_timestamps_ntfs(struct wim_dentry *dentry, void *arg);
460 libntfs3g_global_init();
464 build_dentry_tree_ntfs(struct wim_dentry **root_p,
465 const mbchar *device,
466 struct wim_lookup_table *lookup_table,
467 struct wim_security_data *sd,
468 const struct capture_config *config,
470 wimlib_progress_func_t progress_func,
475 #define WIMLIB_RESOURCE_FLAG_RAW 0x1
476 #define WIMLIB_RESOURCE_FLAG_MULTITHREADED 0x2
477 #define WIMLIB_RESOURCE_FLAG_RECOMPRESS 0x4
480 get_resource_entry(const u8 *p, struct resource_entry *entry);
483 put_resource_entry(u8 *p, const struct resource_entry *entry);
486 read_uncompressed_resource(FILE *fp, u64 offset, u64 size, void *buf);
489 read_wim_resource(const struct wim_lookup_table_entry *lte, void *buf,
490 size_t size, u64 offset, int flags);
493 read_full_wim_resource(const struct wim_lookup_table_entry *lte,
494 void *buf, int flags);
497 write_wim_resource(struct wim_lookup_table_entry *lte, FILE *out_fp,
498 int out_ctype, struct resource_entry *out_res_entry,
502 typedef int (*extract_chunk_func_t)(const void *, size_t, u64, void *);
505 extract_wim_chunk_to_fd(const void *buf, size_t len, u64 offset, void *arg);
508 extract_wim_resource(const struct wim_lookup_table_entry *lte,
509 u64 size, extract_chunk_func_t extract_chunk,
510 void *extract_chunk_arg);
513 * Extracts the first @size bytes of the WIM resource specified by @lte to the
514 * open file descriptor @fd.
516 * Returns 0 on success; nonzero on failure.
519 extract_wim_resource_to_fd(const struct wim_lookup_table_entry *lte,
522 return extract_wim_resource(lte, size,
523 extract_wim_chunk_to_fd, &fd);
528 write_dentry_resources(struct wim_dentry *dentry, void *wim_p);
531 copy_resource(struct wim_lookup_table_entry *lte, void *w);
536 read_security_data(const u8 metadata_resource[],
537 u64 metadata_resource_len, struct wim_security_data **sd_p);
539 print_security_data(const struct wim_security_data *sd);
542 write_security_data(const struct wim_security_data *sd, u8 *p);
545 free_security_data(struct wim_security_data *sd);
549 inode_readlink(const struct wim_inode *inode, char *buf, size_t buf_len,
550 const WIMStruct *w, int read_resource_flags);
553 inode_set_symlink(struct wim_inode *inode, const mbchar *target,
554 struct wim_lookup_table *lookup_table,
555 struct wim_lookup_table_entry **lte_ret);
560 verify_dentry(struct wim_dentry *dentry, void *wim);
563 wim_run_full_verifications(WIMStruct *w);
566 verify_swm_set(WIMStruct *w,
567 WIMStruct **additional_swms, unsigned num_additional_swms);
572 select_wim_image(WIMStruct *w, int image);
575 for_image(WIMStruct *w, int image, int (*visitor)(WIMStruct *));
578 destroy_image_metadata(struct wim_image_metadata *imd,
579 struct wim_lookup_table *lt);
583 /* Internal use only */
584 #define WIMLIB_WRITE_FLAG_NO_LOOKUP_TABLE 0x80000000
585 #define WIMLIB_WRITE_FLAG_REUSE_INTEGRITY_TABLE 0x40000000
586 #define WIMLIB_WRITE_FLAG_CHECKPOINT_AFTER_XML 0x20000000
587 #define WIMLIB_WRITE_MASK_PUBLIC 0x1fffffff
589 #define WIMLIB_ADD_IMAGE_FLAG_ROOT 0x80000000
590 #define WIMLIB_ADD_IMAGE_FLAG_SOURCE 0x40000000
594 begin_write(WIMStruct *w, const mbchar *path, int write_flags);
597 close_wim_writable(WIMStruct *w);
600 finish_write(WIMStruct *w, int image, int write_flags,
601 wimlib_progress_func_t progress_func);
603 #if defined(HAVE_SYS_FILE_H) && defined(HAVE_FLOCK)
605 lock_wim(WIMStruct *w, FILE *fp);
608 lock_wim(WIMStruct *w, FILE *fp)
614 #endif /* _WIMLIB_INTERNAL_H */