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
35 #define WIMLIB_MAKEVERSION(major, minor, patch) \
36 ((major << 20) | (minor << 10) | patch)
39 #define WIMLIB_VERSION_CODE \
40 WIMLIB_MAKEVERSION(WIMLIB_MAJOR_VERSION,\
41 WIMLIB_MINOR_VERSION,\
44 #define WIMLIB_GET_PATCH_VERSION(version) \
45 ((version >> 0) & ((1 << 10) - 1))
46 #define WIMLIB_GET_MINOR_VERSION(version) \
47 ((version >> 10) & ((1 << 10) - 1))
48 #define WIMLIB_GET_MAJOR_VERSION(version) \
49 ((version >> 20) & ((1 << 10) - 1))
57 #define WIM_MAGIC_LEN 8
58 #define WIM_GID_LEN 16
59 #define WIM_UNUSED_LEN 60
61 /* Length of the WIM header on disk. */
62 #define WIM_HEADER_DISK_SIZE (148 + WIM_UNUSED_LEN)
64 /* Compressed resources in the WIM are divided into separated compressed chunks
66 #define WIM_CHUNK_SIZE 32768
68 /* Version of the WIM file. There is an older version, but we don't support it
69 * yet. The differences between the versions are undocumented. */
70 #define WIM_VERSION 0x10d00
72 #define REPARSE_POINT_MAX_SIZE (16 * 1024)
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 flag. See docs for --rpfix and --norpfix in imagex, or
198 * WIMLIB_ADD_FLAG_{RPFIX,NORPFIX} in wimlib.h. Note that
199 * WIM_HDR_FLAG_RP_FIX is a header flag and just sets the default behavior for
200 * the WIM; it can still be overridder on a per-image basis. But there is no
201 * flag to set the default behavior for a specific image. */
202 #define WIM_HDR_FLAG_RP_FIX 0x00000080
204 /* Unused, reserved flag for another compression type */
205 #define WIM_HDR_FLAG_COMPRESS_RESERVED 0x00010000
207 /* Resources within the WIM are compressed using "XPRESS" compression, which is
208 * a LZ77-based compression algorithm. */
209 #define WIM_HDR_FLAG_COMPRESS_XPRESS 0x00020000
211 /* Resources within the WIM are compressed using "LZX" compression. This is also
212 * a LZ77-based algorithm. */
213 #define WIM_HDR_FLAG_COMPRESS_LZX 0x00040000
219 /* Table of security descriptors for a WIM image. */
220 struct wim_security_data {
221 /* The total length of the security data, in bytes. If there are no
222 * security descriptors, this field, when read from the on-disk metadata
223 * resource, may be either 8 (which is correct) or 0 (which is
224 * interpreted as 0). */
227 /* The number of security descriptors in the array @descriptors, below.
228 * It is really an unsigned int on-disk, but it must fit into an int
229 * because the security ID's are signed. (Not like you would ever have
230 * more than a few hundred security descriptors anyway.) */
233 /* Array of sizes of the descriptors in the array @descriptors. */
236 /* Array of descriptors. */
240 /* Metadata for a WIM image */
241 struct wim_image_metadata {
243 /* Number of WIMStruct's that are sharing this image metadata (from
244 * calls to wimlib_export_image().) */
245 unsigned long refcnt;
247 /* Pointer to the root dentry of the image. */
248 struct wim_dentry *root_dentry;
250 /* Pointer to the security data of the image. */
251 struct wim_security_data *security_data;
253 /* Pointer to the lookup table entry for this image's metadata resource
255 struct wim_lookup_table_entry *metadata_lte;
257 /* Linked list of 'struct wim_inode's for this image. */
258 struct list_head inode_list;
260 /* Linked list of 'struct wim_lookup_table_entry's for this image that
261 * are referred to in the dentry tree, but have not had a SHA1 message
262 * digest calculated yet and therefore have not been inserted into the
263 * WIM's lookup table. This list is added to during wimlib_add_image()
264 * and wimlib_mount_image() (read-write only). */
265 struct list_head unhashed_streams;
267 /* 1 iff the dentry tree has been modified. If this is the case, the
268 * memory for the dentry tree should not be freed when switching to a
269 * different WIM image. */
273 struct _ntfs_volume *ntfs_vol;
277 /* The opaque structure exposed to the wimlib API. */
280 /* File descriptor for the WIM file, opened for reading, or -1 if it has
281 * not been opened or there is no associated file backing it yet. */
284 /* File descriptor, opened either for writing only or for
285 * reading+writing, for the WIM file (if any) currently being written.
289 /* The name of the WIM file (if any) that has been opened. */
292 /* The lookup table for the WIM file. */
293 struct wim_lookup_table *lookup_table;
295 /* Information retrieved from the XML data, arranged in an orderly
297 struct wim_info *wim_info;
299 /* Array of the image metadata, one for each image in the WIM. */
300 struct wim_image_metadata **image_metadata;
302 /* The header of the WIM file. */
303 struct wim_header hdr;
305 /* Temporary field */
308 /* The currently selected image, indexed starting at 1. If not 0,
309 * subtract 1 from this to get the index of the current image in the
310 * image_metadata array. */
313 /* Have any images been deleted? */
314 u8 deletion_occurred : 1;
316 u8 all_images_verified : 1;
320 /* Inline utility functions for WIMStructs. */
322 static inline struct wim_image_metadata *
323 wim_get_current_image_metadata(WIMStruct *w)
325 return w->image_metadata[w->current_image - 1];
328 static inline const struct wim_image_metadata *
329 wim_get_const_current_image_metadata(const WIMStruct *w)
331 return w->image_metadata[w->current_image - 1];
334 static inline struct wim_dentry *
335 wim_root_dentry(WIMStruct *w)
337 return wim_get_current_image_metadata(w)->root_dentry;
340 static inline struct wim_security_data *
341 wim_security_data(WIMStruct *w)
343 return wim_get_current_image_metadata(w)->security_data;
346 static inline const struct wim_security_data *
347 wim_const_security_data(const WIMStruct *w)
349 return wim_get_const_current_image_metadata(w)->security_data;
352 /* Nonzero if a struct resource_entry indicates a compressed resource. */
354 resource_is_compressed(const struct resource_entry *entry)
356 return (entry->flags & WIM_RESHDR_FLAG_COMPRESSED);
359 /* Iterate over each inode in a WIM image that has not yet been hashed */
360 #define image_for_each_inode(inode, imd) \
361 list_for_each_entry(inode, &imd->inode_list, i_list)
363 /* Iterate over each stream in a WIM image that has not yet been hashed */
364 #define image_for_each_unhashed_stream(lte, imd) \
365 list_for_each_entry(lte, &imd->unhashed_streams, unhashed_list)
367 /* Iterate over each stream in a WIM image that has not yet been hashed (safe
368 * against stream removal) */
369 #define image_for_each_unhashed_stream_safe(lte, tmp, imd) \
370 list_for_each_entry_safe(lte, tmp, &imd->unhashed_streams, unhashed_list)
373 # define copy_resource_entry(dst, src) memcpy(dst, src, sizeof(struct resource_entry))
374 # define zero_resource_entry(entry) memset(entry, 0, sizeof(struct resource_entry))
377 copy_resource_entry(struct resource_entry *dst,
378 const struct resource_entry *src)
380 BUILD_BUG_ON(sizeof(struct resource_entry) != 24);
381 ((u64*)dst)[0] = ((u64*)src)[0];
382 ((u64*)dst)[1] = ((u64*)src)[1];
383 ((u64*)dst)[2] = ((u64*)src)[2];
387 zero_resource_entry(struct resource_entry *entry)
389 BUILD_BUG_ON(sizeof(struct resource_entry) != 24);
390 ((u64*)entry)[0] = 0;
391 ((u64*)entry)[1] = 0;
392 ((u64*)entry)[2] = 0;
398 /* Hash table to find inodes, given an inode number (in the case of reading
399 * a WIM images), or both an inode number and a device number (in the case of
400 * capturing a WIM image). */
401 struct wim_inode_table {
402 /* Fields for the hash table */
403 struct hlist_head *array;
408 * Linked list of "extra" inodes. These may be:
410 * - inodes with link count 1, which are all allowed to have 0 for their
411 * inode number, meaning we cannot insert them into the hash table.
413 * - Groups we create ourselves by splitting a nominal inode due to
414 * inconsistencies in the dentries. These inodes will share an inode
415 * number with some other inode until assign_inode_numbers() is
418 struct list_head extra_inodes;
421 /* Common parameters to implementations of building an in-memory dentry tree
422 * from an on-disk directory structure. */
423 struct add_image_params {
424 /* Pointer to the lookup table of the WIM. */
425 struct wim_lookup_table *lookup_table;
427 /* Hash table of inodes that have been captured for this tree so far. */
428 struct wim_inode_table inode_table;
430 /* The set of security descriptors that have been captured for this
432 struct sd_set sd_set;
434 /* Pointer to the capture configuration, which indicates whether any
435 * files should be excluded from capture or not. */
436 const struct wimlib_capture_config *config;
438 /* Flags that affect the capture operation (WIMLIB_ADD_FLAG_*) */
441 /* If non-NULL, the user-supplied progress function. */
442 wimlib_progress_func_t progress_func;
444 /* Extra argument; set to point to a pointer to the ntfs_volume for
445 * libntfs-3g capture. */
448 u64 capture_root_ino;
449 u64 capture_root_dev;
453 /* capture_common.c */
456 exclude_path(const tchar *path, size_t path_len,
457 const struct wimlib_capture_config *config,
458 bool exclude_prefix);
460 extern struct wimlib_capture_config *
461 copy_capture_config(const struct wimlib_capture_config *config);
464 copy_and_canonicalize_capture_config(const struct wimlib_capture_config *config,
465 struct wimlib_capture_config **config_copy_ret);
468 free_capture_config(struct wimlib_capture_config *config);
470 /* extract_image.c */
472 /* Internal use only */
473 #define WIMLIB_EXTRACT_FLAG_MULTI_IMAGE 0x80000000
474 #define WIMLIB_EXTRACT_FLAG_NO_STREAMS 0x40000000
475 #define WIMLIB_EXTRACT_MASK_PUBLIC 0x3fffffff
480 init_inode_table(struct wim_inode_table *table, size_t capacity);
483 inode_table_new_dentry(struct wim_inode_table *table, const tchar *name,
484 u64 ino, u64 devno, bool noshare,
485 struct wim_dentry **dentry_ret);
488 inode_ref_streams(struct wim_inode *inode);
491 inode_table_prepare_inode_list(struct wim_inode_table *table,
492 struct list_head *head);
495 destroy_inode_table(struct wim_inode_table *table)
502 dentry_tree_fix_inodes(struct wim_dentry *root, struct list_head *inode_list);
507 read_header(const tchar *filename, int in_fd, struct wim_header *hdr,
511 write_header(const struct wim_header *hdr, int out_fd);
514 init_header(struct wim_header *hdr, int ctype);
518 #define WIM_INTEGRITY_OK 0
519 #define WIM_INTEGRITY_NOT_OK -1
520 #define WIM_INTEGRITY_NONEXISTENT -2
523 write_integrity_table(int fd,
524 struct resource_entry *integrity_res_entry,
525 off_t new_lookup_table_end,
526 off_t old_lookup_table_end,
527 wimlib_progress_func_t progress_func);
530 check_wim_integrity(WIMStruct *w, wimlib_progress_func_t progress_func);
535 merge_lookup_tables(WIMStruct *w,
536 WIMStruct **additional_swms, unsigned num_additional_swms);
539 unmerge_lookup_table(WIMStruct *wim);
541 /* metadata_resource.c */
544 read_metadata_resource(WIMStruct *w,
545 struct wim_image_metadata *image_metadata);
548 write_metadata_resource(WIMStruct *w);
555 unsigned target_nchars;
556 unsigned wim_source_path_nchars;
557 struct wim_dentry *extract_root;
558 tchar *target_realpath;
559 unsigned target_realpath_len;
561 union wimlib_progress_info progress;
562 wimlib_progress_func_t progress_func;
563 int (*apply_dentry)(struct wim_dentry *, void *);
567 /* NTFS apply only */
568 struct _ntfs_volume *vol;
573 /* Normal apply only (Win32) */
574 unsigned long num_set_sacl_priv_notheld;
575 unsigned long num_set_sd_access_denied;
577 unsigned long num_hard_links_failed;
578 unsigned long num_soft_links_failed;
583 /* Normal apply only (UNIX) */
584 unsigned long num_utime_warnings;
591 apply_dentry_ntfs(struct wim_dentry *dentry, void *arg);
594 apply_dentry_timestamps_ntfs(struct wim_dentry *dentry, void *arg);
597 libntfs3g_global_init();
601 typedef int (*consume_data_callback_t)(const void *buf, size_t len, void *ctx);
604 read_ntfs_file_prefix(const struct wim_lookup_table_entry *lte,
606 consume_data_callback_t cb,
610 build_dentry_tree_ntfs(struct wim_dentry **root_p,
612 struct add_image_params *ctx);
616 do_ntfs_umount(struct _ntfs_volume *vol);
621 /* Structured format for symbolic link, junction point, or mount point reparse
623 struct reparse_data {
624 /* Reparse point tag (see WIM_IO_REPARSE_TAG_* values) */
627 /* Length of reparse data, not including the 8-byte header (ReparseTag,
628 * ReparseDataLength, ReparseReserved) */
631 /* ReparseReserved */
634 /* Flags (only for WIM_IO_REPARSE_TAG_SYMLINK reparse points).
635 * SYMBOLIC_LINK_RELATIVE means this is a relative symbolic link;
636 * otherwise should be set to 0. */
637 #define SYMBOLIC_LINK_RELATIVE 0x00000001
640 /* Pointer to the substitute name of the link (UTF-16LE). */
641 utf16lechar *substitute_name;
643 /* Pointer to the print name of the link (UTF-16LE). */
644 utf16lechar *print_name;
646 /* Number of bytes of the substitute name, not including null terminator
648 u16 substitute_name_nbytes;
650 /* Number of bytes of the print name, not including null terminator if
652 u16 print_name_nbytes;
656 SUBST_NAME_IS_RELATIVE_LINK = -1,
657 SUBST_NAME_IS_VOLUME_JUNCTION = -2,
658 SUBST_NAME_IS_UNKNOWN = -3,
661 parse_substitute_name(const utf16lechar *substitute_name,
662 u16 substitute_name_nbytes,
666 parse_reparse_data(const u8 *rpbuf, u16 rpbuflen, struct reparse_data *rpdata);
669 make_reparse_buffer(const struct reparse_data *rpdata, u8 *buf);
672 wim_inode_get_reparse_data(const struct wim_inode *inode, u8 *rpbuf);
676 wim_inode_readlink(const struct wim_inode *inode, char *buf, size_t buf_len);
679 wim_inode_set_symlink(struct wim_inode *inode, const char *target,
680 struct wim_lookup_table *lookup_table);
683 capture_fixup_absolute_symlink(tchar *dest,
684 u64 capture_root_ino, u64 capture_root_dev);
689 #define WIMLIB_RESOURCE_FLAG_RAW 0x1
690 #define WIMLIB_RESOURCE_FLAG_RECOMPRESS 0x4
693 read_resource_prefix(const struct wim_lookup_table_entry *lte,
694 u64 size, consume_data_callback_t cb, void *ctx_or_buf,
698 get_resource_entry(const void *p, struct resource_entry *entry);
701 put_resource_entry(void *p, const struct resource_entry *entry);
704 read_partial_wim_resource_into_buf(const struct wim_lookup_table_entry *lte,
705 size_t size, u64 offset, void *buf);
707 read_full_resource_into_buf(const struct wim_lookup_table_entry *lte, void *buf);
710 write_wim_resource(struct wim_lookup_table_entry *lte, int out_fd,
711 int out_ctype, struct resource_entry *out_res_entry,
715 extract_wim_resource(const struct wim_lookup_table_entry *lte,
717 consume_data_callback_t extract_chunk,
718 void *extract_chunk_arg);
721 extract_wim_resource_to_fd(const struct wim_lookup_table_entry *lte,
725 sha1_resource(struct wim_lookup_table_entry *lte);
728 copy_resource(struct wim_lookup_table_entry *lte, void *w);
731 extern struct wim_security_data *
732 new_wim_security_data();
735 read_security_data(const u8 metadata_resource[],
736 u64 metadata_resource_len, struct wim_security_data **sd_p);
738 print_security_data(const struct wim_security_data *sd);
741 write_security_data(const struct wim_security_data *sd, u8 *p);
744 free_security_data(struct wim_security_data *sd);
749 unix_do_apply_dentry(const char *output_path, size_t output_path_len,
750 struct wim_dentry *dentry, struct apply_args *args);
752 unix_do_apply_dentry_timestamps(const char *output_path,
753 size_t output_path_len,
754 struct wim_dentry *dentry,
755 struct apply_args *args);
761 unix_build_dentry_tree(struct wim_dentry **root_ret,
762 const char *root_disk_path,
763 struct add_image_params *params);
768 rename_wim_path(WIMStruct *wim, const tchar *from, const tchar *to);
773 verify_dentry(struct wim_dentry *dentry, void *wim);
776 wim_run_full_verifications(WIMStruct *w);
779 verify_swm_set(WIMStruct *w,
780 WIMStruct **additional_swms, unsigned num_additional_swms);
785 select_wim_image(WIMStruct *w, int image);
788 for_image(WIMStruct *w, int image, int (*visitor)(WIMStruct *));
791 destroy_image_metadata(struct wim_image_metadata *imd,
792 struct wim_lookup_table *table,
793 bool free_metadata_lte);
796 put_image_metadata(struct wim_image_metadata *imd,
797 struct wim_lookup_table *table);
800 append_image_metadata(WIMStruct *w, struct wim_image_metadata *imd);
802 extern struct wim_image_metadata *
803 new_image_metadata();
805 extern struct wim_image_metadata **
806 new_image_metadata_array(unsigned num_images);
809 wim_checksum_unhashed_streams(WIMStruct *w);
812 reopen_wim(WIMStruct *w);
815 close_wim(WIMStruct *w);
819 /* Internal use only */
820 #define WIMLIB_WRITE_FLAG_NO_LOOKUP_TABLE 0x80000000
821 #define WIMLIB_WRITE_FLAG_REUSE_INTEGRITY_TABLE 0x40000000
822 #define WIMLIB_WRITE_FLAG_CHECKPOINT_AFTER_XML 0x20000000
823 #define WIMLIB_WRITE_MASK_PUBLIC 0x1fffffff
825 /* We are capturing a tree to be placed in the root of the WIM image */
826 #define WIMLIB_ADD_FLAG_ROOT 0x80000000
829 begin_write(WIMStruct *w, const tchar *path, int write_flags);
832 close_wim_writable(WIMStruct *w);
835 finish_write(WIMStruct *w, int image, int write_flags,
836 wimlib_progress_func_t progress_func);
838 #if defined(HAVE_SYS_FILE_H) && defined(HAVE_FLOCK)
840 lock_wim(WIMStruct *w, int fd);
843 lock_wim(WIMStruct *w, int fd)
849 #endif /* _WIMLIB_INTERNAL_H */