4 * Internal header for wimlib.
8 * Copyright (C) 2012, 2013 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))
60 #define WIM_MAGIC_LEN 8
61 #define WIM_GID_LEN 16
62 #define WIM_UNUSED_LEN 60
64 /* Length of the WIM header on disk. */
65 #define WIM_HEADER_DISK_SIZE (148 + WIM_UNUSED_LEN)
67 /* Compressed resources in the WIM are divided into separated compressed chunks
69 #define WIM_CHUNK_SIZE 32768
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
75 /* Metadata for a resource in a WIM file. */
76 struct resource_entry {
77 /* Size, in bytes, of the resource in the WIM file. */
80 /* Bitwise or of one or more of the WIM_RESHDR_FLAG_* flags. */
83 /* Offset, in bytes, of the resource in the WIM file. */
86 /* Uncompressed size of the resource in the WIM file. Is the same as
87 * @size if the resource is uncompressed. */
91 /* Flags for the `flags' field of the struct resource_entry structure. */
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
100 /* Indicates that the stream is a metadata resource for a WIM image. */
101 #define WIM_RESHDR_FLAG_METADATA 0x02
103 /* Indicates that the stream is compressed. */
104 #define WIM_RESHDR_FLAG_COMPRESSED 0x04
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
112 /* Header at the very beginning of the WIM file. */
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];
118 /* size of WIM header in bytes. */
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. */
126 /* Bitwise OR of one or more of the WIM_HDR_FLAG_* defined below. */
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".*/
135 /* A unique identifier for the WIM file. */
136 u8 guid[WIM_GID_LEN];
138 /* Part number of the WIM file in a spanned set. */
141 /* Total number of parts in a spanned set. */
144 /* Number of images in the WIM file. */
147 /* Location, size, and flags of the lookup table of the WIM. */
148 struct resource_entry lookup_table_res_entry;
150 /* Location, size, and flags for the XML data of the WIM. */
151 struct resource_entry xml_res_entry;
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;
158 /* The index of the bootable image in the WIM file. If 0, there are no
159 * bootable images available. */
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;
166 /* Reserved for future disuse */
167 //u8 unused[WIM_UNUSED_LEN];
170 /* Flags for the `flags' field of the struct wim_header: */
172 /* Reserved for future use */
173 #define WIM_HDR_FLAG_RESERVED 0x00000001
175 /* Files and metadata in the WIM are compressed. */
176 #define WIM_HDR_FLAG_COMPRESSION 0x00000002
178 /* WIM is read-only (wimlib ignores this because it's pretty much pointless) */
179 #define WIM_HDR_FLAG_READONLY 0x00000004
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
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
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
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
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
203 /* Unused, reserved flag for another compression type */
204 #define WIM_HDR_FLAG_COMPRESS_RESERVED 0x00010000
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
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
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). */
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.) */
232 /* Array of sizes of the descriptors in the array @descriptors. */
235 /* Array of descriptors. */
239 /* Metadata for a WIM image */
240 struct wim_image_metadata {
242 /* Number of WIMStruct's that are sharing this image metadata (from
243 * calls to wimlib_export_image().) */
244 unsigned long refcnt;
246 /* Pointer to the root dentry of the image. */
247 struct wim_dentry *root_dentry;
249 /* Pointer to the security data of the image. */
250 struct wim_security_data *security_data;
252 /* Pointer to the lookup table entry for this image's metadata resource
254 struct wim_lookup_table_entry *metadata_lte;
256 /* Linked list of 'struct wim_inode's for this image. */
257 struct list_head inode_list;
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;
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. */
271 /* 1 iff this image has been mounted read-write */
272 u8 has_been_mounted_rw : 1;
275 struct _ntfs_volume *ntfs_vol;
279 /* The opaque structure exposed to the wimlib API. */
282 /* A pointer to the file indicated by @filename, opened for reading. */
286 /* Extra file pointers to be used by concurrent readers */
288 size_t num_allocated_fps;
289 pthread_mutex_t fp_tab_mutex;
292 /* FILE pointer for the WIM file (if any) currently being written. */
295 /* The name of the WIM file (if any) that has been opened. */
298 /* The lookup table for the WIM file. */
299 struct wim_lookup_table *lookup_table;
301 /* Pointer to the XML data read from the WIM file (UTF16LE-encoded). */
302 utf16lechar *xml_data;
304 /* Information retrieved from the XML data, arranged in an orderly
306 struct wim_info *wim_info;
308 /* Array of the image metadata, one for each image in the WIM. */
309 struct wim_image_metadata **image_metadata;
311 /* The header of the WIM file. */
312 struct wim_header hdr;
314 /* Temporary field */
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. */
322 u8 deletion_occurred : 1;
323 u8 all_images_verified : 1;
327 /* Inline utility functions for WIMStructs. */
329 static inline struct wim_image_metadata *
330 wim_get_current_image_metadata(WIMStruct *w)
332 return w->image_metadata[w->current_image - 1];
335 static inline const struct wim_image_metadata *
336 wim_get_const_current_image_metadata(const WIMStruct *w)
338 return w->image_metadata[w->current_image - 1];
341 static inline struct wim_dentry *
342 wim_root_dentry(WIMStruct *w)
344 return wim_get_current_image_metadata(w)->root_dentry;
347 static inline struct wim_security_data *
348 wim_security_data(WIMStruct *w)
350 return wim_get_current_image_metadata(w)->security_data;
353 static inline const struct wim_security_data *
354 wim_const_security_data(const WIMStruct *w)
356 return wim_get_const_current_image_metadata(w)->security_data;
359 /* Nonzero if a struct resource_entry indicates a compressed resource. */
361 resource_is_compressed(const struct resource_entry *entry)
363 return (entry->flags & WIM_RESHDR_FLAG_COMPRESSED);
366 #define image_for_each_inode(inode, imd) \
367 list_for_each_entry(inode, &imd->inode_list, i_list)
369 #define image_for_each_unhashed_stream(lte, imd) \
370 list_for_each_entry(lte, &imd->unhashed_streams, unhashed_list)
372 #define image_for_each_unhashed_stream_safe(lte, tmp, imd) \
373 list_for_each_entry_safe(lte, tmp, &imd->unhashed_streams, unhashed_list)
376 # define copy_resource_entry(dst, src) memcpy(dst, src, sizeof(struct resource_entry))
379 copy_resource_entry(struct resource_entry *dst,
380 const struct resource_entry *src)
382 memcpy(dst, src, sizeof(struct resource_entry));
383 BUILD_BUG_ON(sizeof(struct resource_entry) != 24);
384 ((u64*)dst)[0] = ((u64*)src)[0];
385 ((u64*)dst)[1] = ((u64*)src)[1];
386 ((u64*)dst)[2] = ((u64*)src)[2];
393 exclude_path(const tchar *path, size_t path_len,
394 const struct wimlib_capture_config *config,
395 bool exclude_prefix);
397 /* extract_image.c */
399 /* Internal use only */
400 #define WIMLIB_EXTRACT_FLAG_MULTI_IMAGE 0x80000000
401 #define WIMLIB_EXTRACT_FLAG_NO_STREAMS 0x40000000
402 #define WIMLIB_EXTRACT_MASK_PUBLIC 0x3fffffff
406 /* Hash table to find inodes, given an inode number (in the case of reading
407 * a WIM images), or both an inode number and a device number (in the case of
408 * capturing a WIM image). */
409 struct wim_inode_table {
410 /* Fields for the hash table */
411 struct hlist_head *array;
416 * Linked list of "extra" inodes. These may be:
418 * - inodes with link count 1, which are all allowed to have 0 for their
419 * inode number, meaning we cannot insert them into the hash table.
421 * - Groups we create ourselves by splitting a nominal inode due to
422 * inconsistencies in the dentries. These inodes will share an inode
423 * number with some other inode until assign_inode_numbers() is
426 struct list_head extra_inodes;
430 init_inode_table(struct wim_inode_table *table, size_t capacity);
433 inode_table_new_dentry(struct wim_inode_table *table, const tchar *name,
434 u64 ino, u64 devno, struct wim_dentry **dentry_ret);
437 inode_ref_streams(struct wim_inode *inode);
440 inode_table_prepare_inode_list(struct wim_inode_table *table,
441 struct list_head *head);
444 destroy_inode_table(struct wim_inode_table *table)
451 dentry_tree_fix_inodes(struct wim_dentry *root, struct list_head *inode_list);
456 read_header(FILE *fp, struct wim_header *hdr, int split_ok);
459 write_header(const struct wim_header *hdr, FILE *out);
462 init_header(struct wim_header *hdr, int ctype);
466 #define WIM_INTEGRITY_OK 0
467 #define WIM_INTEGRITY_NOT_OK -1
468 #define WIM_INTEGRITY_NONEXISTENT -2
471 write_integrity_table(FILE *out, struct resource_entry *integrity_res_entry,
472 off_t new_lookup_table_end,
473 off_t old_lookup_table_end,
474 wimlib_progress_func_t progress_func);
477 check_wim_integrity(WIMStruct *w, wimlib_progress_func_t progress_func);
482 new_joined_lookup_table(WIMStruct *w, WIMStruct **additional_swms,
483 unsigned num_additional_swms,
484 struct wim_lookup_table **table_ret);
486 /* metadata_resource.c */
489 read_metadata_resource(WIMStruct *w,
490 struct wim_image_metadata *image_metadata);
493 write_metadata_resource(WIMStruct *w);
501 union wimlib_progress_info progress;
502 wimlib_progress_func_t progress_func;
503 int (*apply_dentry)(struct wim_dentry *, void *);
507 /* NTFS apply only */
508 struct _ntfs_volume *vol;
512 /* Normal apply only (UNIX) */
513 unsigned long num_utime_warnings;
517 /* Normal apply only (Win32) */
518 unsigned long num_set_sacl_priv_notheld;
519 unsigned long num_set_sd_access_denied;
525 apply_dentry_ntfs(struct wim_dentry *dentry, void *arg);
528 apply_dentry_timestamps_ntfs(struct wim_dentry *dentry, void *arg);
531 libntfs3g_global_init();
535 /* The types of these two callbacks are intentionally the same. */
536 typedef int (*consume_data_callback_t)(const void *buf, size_t len, void *ctx);
539 read_ntfs_file_prefix(const struct wim_lookup_table_entry *lte,
541 consume_data_callback_t cb,
545 build_dentry_tree_ntfs(struct wim_dentry **root_p,
547 struct wim_lookup_table *lookup_table,
548 struct wim_inode_table *inode_table,
549 struct sd_set *sd_set,
550 const struct wimlib_capture_config *config,
552 wimlib_progress_func_t progress_func,
556 do_ntfs_umount(struct _ntfs_volume *vol);
560 #define WIMLIB_RESOURCE_FLAG_RAW 0x1
561 #define WIMLIB_RESOURCE_FLAG_THREADSAFE_READ 0x2
562 #define WIMLIB_RESOURCE_FLAG_RECOMPRESS 0x4
563 //#define WIMLIB_RESOURCE_FLAG_OVERWRITE_INPLACE 0x8
566 read_resource_prefix(const struct wim_lookup_table_entry *lte,
567 u64 size, consume_data_callback_t cb, void *ctx_or_buf,
571 get_resource_entry(const void *p, struct resource_entry *entry);
574 put_resource_entry(void *p, const struct resource_entry *entry);
577 read_uncompressed_resource(FILE *fp, u64 offset, u64 size, void *buf);
580 read_partial_wim_resource_into_buf(const struct wim_lookup_table_entry *lte,
581 size_t size, u64 offset, void *buf,
584 read_full_resource_into_buf(const struct wim_lookup_table_entry *lte,
585 void *buf, bool thread_safe);
588 write_wim_resource(struct wim_lookup_table_entry *lte, FILE *out_fp,
589 int out_ctype, struct resource_entry *out_res_entry,
593 extract_wim_resource(const struct wim_lookup_table_entry *lte,
595 consume_data_callback_t extract_chunk,
596 void *extract_chunk_arg);
599 extract_wim_resource_to_fd(const struct wim_lookup_table_entry *lte,
603 sha1_resource(struct wim_lookup_table_entry *lte);
606 copy_resource(struct wim_lookup_table_entry *lte, void *w);
610 read_security_data(const u8 metadata_resource[],
611 u64 metadata_resource_len, struct wim_security_data **sd_p);
613 print_security_data(const struct wim_security_data *sd);
616 write_security_data(const struct wim_security_data *sd, u8 *p);
619 free_security_data(struct wim_security_data *sd);
625 inode_readlink(const struct wim_inode *inode, char *buf, size_t buf_len,
626 const WIMStruct *w, bool threadsafe);
629 inode_set_symlink(struct wim_inode *inode, const char *target,
630 struct wim_lookup_table *lookup_table,
631 struct wim_lookup_table_entry **lte_ret);
637 verify_dentry(struct wim_dentry *dentry, void *wim);
640 wim_run_full_verifications(WIMStruct *w);
643 verify_swm_set(WIMStruct *w,
644 WIMStruct **additional_swms, unsigned num_additional_swms);
649 select_wim_image(WIMStruct *w, int image);
652 for_image(WIMStruct *w, int image, int (*visitor)(WIMStruct *));
655 destroy_image_metadata(struct wim_image_metadata *imd,
656 struct wim_lookup_table *table,
657 bool free_metadata_lte);
660 put_image_metadata(struct wim_image_metadata *imd,
661 struct wim_lookup_table *table);
664 append_image_metadata(WIMStruct *w, struct wim_image_metadata *imd);
666 extern struct wim_image_metadata *
667 new_image_metadata();
669 extern struct wim_image_metadata **
670 new_image_metadata_array(unsigned num_images);
673 wim_checksum_unhashed_streams(WIMStruct *w);
677 /* Internal use only */
678 #define WIMLIB_WRITE_FLAG_NO_LOOKUP_TABLE 0x80000000
679 #define WIMLIB_WRITE_FLAG_REUSE_INTEGRITY_TABLE 0x40000000
680 #define WIMLIB_WRITE_FLAG_CHECKPOINT_AFTER_XML 0x20000000
681 //#define WIMLIB_WRITE_FLAG_OVERWRITE_INPLACE 0x10000000
682 #define WIMLIB_WRITE_MASK_PUBLIC 0x0fffffff
684 /* We are capturing a tree to be placed in the root of the WIM image */
685 #define WIMLIB_ADD_IMAGE_FLAG_ROOT 0x80000000
687 /* We are capturing a dentry that will become the root of a tree to be added to
689 #define WIMLIB_ADD_IMAGE_FLAG_SOURCE 0x40000000
693 begin_write(WIMStruct *w, const tchar *path, int write_flags);
696 close_wim_writable(WIMStruct *w);
699 finish_write(WIMStruct *w, int image, int write_flags,
700 wimlib_progress_func_t progress_func);
702 #if defined(HAVE_SYS_FILE_H) && defined(HAVE_FLOCK)
704 lock_wim(WIMStruct *w, FILE *fp);
707 lock_wim(WIMStruct *w, FILE *fp)
713 #endif /* _WIMLIB_INTERNAL_H */