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
34 #if defined(WITH_FUSE) || defined(ENABLE_MULTITHREADED_COMPRESSION)
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 #define REPARSE_POINT_MAX_SIZE (16 * 1024)
77 /* Metadata for a resource in a WIM file. */
78 struct resource_entry {
79 /* Size, in bytes, of the resource in the WIM file. */
82 /* Bitwise or of one or more of the WIM_RESHDR_FLAG_* flags. */
85 /* Offset, in bytes, of the resource in the WIM file. */
88 /* Uncompressed size of the resource in the WIM file. Is the same as
89 * @size if the resource is uncompressed. */
93 /* Flags for the `flags' field of the struct resource_entry structure. */
95 /* I haven't seen this flag used in any of the WIMs I have examined. I assume
96 * it means that there are no references to the stream, so the space is free.
97 * However, even after deleting files from a WIM mounted with `imagex.exe
98 * /mountrw', I could not see this flag being used. Either way, we don't
99 * actually use this flag for anything. */
100 #define WIM_RESHDR_FLAG_FREE 0x01
102 /* Indicates that the stream is a metadata resource for a WIM image. */
103 #define WIM_RESHDR_FLAG_METADATA 0x02
105 /* Indicates that the stream is compressed. */
106 #define WIM_RESHDR_FLAG_COMPRESSED 0x04
108 /* I haven't seen this flag used in any of the WIMs I have examined. Perhaps it
109 * means that a stream could possibly be split among multiple split WIM parts.
110 * However, `imagex.exe /split' does not seem to create any WIMs like this.
111 * Either way, we don't actually use this flag for anything. */
112 #define WIM_RESHDR_FLAG_SPANNED 0x08
114 /* Header at the very beginning of the WIM file. */
116 /* Identifies the file as WIM file. Must be exactly
117 * {'M', 'S', 'W', 'I', 'M', 0, 0, 0} */
118 //u8 magic[WIM_MAGIC_LEN];
120 /* size of WIM header in bytes. */
123 /* Version of the WIM file. Microsoft provides no documentation about
124 * exactly what this field affects about the file format, other than the
125 * fact that more recent versions have a higher value. */
128 /* Bitwise OR of one or more of the WIM_HDR_FLAG_* defined below. */
131 /* The size of the pieces that the uncompressed files were split up into
132 * when they were compressed. This should be the same as
133 * WIM_CHUNK_SIZE. Microsoft incorrectly documents this as "the size of
134 * the compressed .wim file in bytes".*/
137 /* A unique identifier for the WIM file. */
138 u8 guid[WIM_GID_LEN];
140 /* Part number of the WIM file in a spanned set. */
143 /* Total number of parts in a spanned set. */
146 /* Number of images in the WIM file. */
149 /* Location, size, and flags of the lookup table of the WIM. */
150 struct resource_entry lookup_table_res_entry;
152 /* Location, size, and flags for the XML data of the WIM. */
153 struct resource_entry xml_res_entry;
155 /* Location, size, and flags for the boot metadata. This means the
156 * metadata resource for the image specified by boot_idx below. Should
157 * be zeroed out if boot_idx is 0. */
158 struct resource_entry boot_metadata_res_entry;
160 /* The index of the bootable image in the WIM file. If 0, there are no
161 * bootable images available. */
164 /* The location of the optional integrity table used to verify the
165 * integrity WIM. Zeroed out if there is no integrity table.*/
166 struct resource_entry integrity;
168 /* Reserved for future disuse */
169 //u8 unused[WIM_UNUSED_LEN];
172 /* Flags for the `flags' field of the struct wim_header: */
174 /* Reserved for future use */
175 #define WIM_HDR_FLAG_RESERVED 0x00000001
177 /* Files and metadata in the WIM are compressed. */
178 #define WIM_HDR_FLAG_COMPRESSION 0x00000002
180 /* WIM is read-only (wimlib ignores this because it's pretty much pointless) */
181 #define WIM_HDR_FLAG_READONLY 0x00000004
183 /* Resource data specified by images in this WIM may be contained in a different
184 * WIM. Or in other words, this WIM is part of a split WIM. */
185 #define WIM_HDR_FLAG_SPANNED 0x00000008
187 /* The WIM contains resources only; no filesystem metadata. wimlib ignores this
188 * flag, as it looks for resources in all the WIMs anyway. */
189 #define WIM_HDR_FLAG_RESOURCE_ONLY 0x00000010
191 /* The WIM contains metadata only. wimlib ignores this flag. Note that all the
192 * metadata resources for a split WIM should be in the first part. */
193 #define WIM_HDR_FLAG_METADATA_ONLY 0x00000020
195 /* Lock field to prevent multiple writers from writing the WIM concurrently.
196 * wimlib ignores this flag as it uses flock() to acquire a real lock on the
197 * file (if supported by the underlying filesystem). */
198 #define WIM_HDR_FLAG_WRITE_IN_PROGRESS 0x00000040
200 /* Reparse point fixup flag. See docs for --rpfix and --norpfix in imagex, or
201 * WIMLIB_ADD_FLAG_{RPFIX,NORPFIX} in wimlib.h. Note that
202 * WIM_HDR_FLAG_RP_FIX is a header flag and just sets the default behavior for
203 * the WIM; it can still be overridder on a per-image basis. But there is no
204 * flag to set the default behavior for a specific image. */
205 #define WIM_HDR_FLAG_RP_FIX 0x00000080
207 /* Unused, reserved flag for another compression type */
208 #define WIM_HDR_FLAG_COMPRESS_RESERVED 0x00010000
210 /* Resources within the WIM are compressed using "XPRESS" compression, which is
211 * a LZ77-based compression algorithm. */
212 #define WIM_HDR_FLAG_COMPRESS_XPRESS 0x00020000
214 /* Resources within the WIM are compressed using "LZX" compression. This is also
215 * a LZ77-based algorithm. */
216 #define WIM_HDR_FLAG_COMPRESS_LZX 0x00040000
222 /* Table of security descriptors for a WIM image. */
223 struct wim_security_data {
224 /* The total length of the security data, in bytes. If there are no
225 * security descriptors, this field, when read from the on-disk metadata
226 * resource, may be either 8 (which is correct) or 0 (which is
227 * interpreted as 0). */
230 /* The number of security descriptors in the array @descriptors, below.
231 * It is really an unsigned int on-disk, but it must fit into an int
232 * because the security ID's are signed. (Not like you would ever have
233 * more than a few hundred security descriptors anyway.) */
236 /* Array of sizes of the descriptors in the array @descriptors. */
239 /* Array of descriptors. */
243 /* Metadata for a WIM image */
244 struct wim_image_metadata {
246 /* Number of WIMStruct's that are sharing this image metadata (from
247 * calls to wimlib_export_image().) */
248 unsigned long refcnt;
250 /* Pointer to the root dentry of the image. */
251 struct wim_dentry *root_dentry;
253 /* Pointer to the security data of the image. */
254 struct wim_security_data *security_data;
256 /* Pointer to the lookup table entry for this image's metadata resource
258 struct wim_lookup_table_entry *metadata_lte;
260 /* Linked list of 'struct wim_inode's for this image. */
261 struct list_head inode_list;
263 /* Linked list of 'struct wim_lookup_table_entry's for this image that
264 * are referred to in the dentry tree, but have not had a SHA1 message
265 * digest calculated yet and therefore have not been inserted into the
266 * WIM's lookup table. This list is added to during wimlib_add_image()
267 * and wimlib_mount_image() (read-write only). */
268 struct list_head unhashed_streams;
270 /* 1 iff the dentry tree has been modified. If this is the case, the
271 * memory for the dentry tree should not be freed when switching to a
272 * different WIM image. */
276 struct _ntfs_volume *ntfs_vol;
280 /* The opaque structure exposed to the wimlib API. */
283 /* File descriptor for the WIM file, opened for reading, or -1 if it has
284 * not been opened or there is no associated file backing it yet. */
287 /* File descriptor, opened either for writing only or for
288 * reading+writing, for the WIM file (if any) currently being written.
292 /* The name of the WIM file (if any) that has been opened. */
295 /* The lookup table for the WIM file. */
296 struct wim_lookup_table *lookup_table;
298 /* Information retrieved from the XML data, arranged in an orderly
300 struct wim_info *wim_info;
302 /* Array of the image metadata, one for each image in the WIM. */
303 struct wim_image_metadata **image_metadata;
305 /* The header of the WIM file. */
306 struct wim_header hdr;
308 /* Temporary field */
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 /* Have any images been deleted? */
317 u8 deletion_occurred : 1;
319 u8 all_images_verified : 1;
323 /* Inline utility functions for WIMStructs. */
325 static inline struct wim_image_metadata *
326 wim_get_current_image_metadata(WIMStruct *w)
328 return w->image_metadata[w->current_image - 1];
331 static inline const struct wim_image_metadata *
332 wim_get_const_current_image_metadata(const WIMStruct *w)
334 return w->image_metadata[w->current_image - 1];
337 static inline struct wim_dentry *
338 wim_root_dentry(WIMStruct *w)
340 return wim_get_current_image_metadata(w)->root_dentry;
343 static inline struct wim_security_data *
344 wim_security_data(WIMStruct *w)
346 return wim_get_current_image_metadata(w)->security_data;
349 static inline const struct wim_security_data *
350 wim_const_security_data(const WIMStruct *w)
352 return wim_get_const_current_image_metadata(w)->security_data;
355 /* Nonzero if a struct resource_entry indicates a compressed resource. */
357 resource_is_compressed(const struct resource_entry *entry)
359 return (entry->flags & WIM_RESHDR_FLAG_COMPRESSED);
362 /* Iterate over each inode in a WIM image that has not yet been hashed */
363 #define image_for_each_inode(inode, imd) \
364 list_for_each_entry(inode, &imd->inode_list, i_list)
366 /* Iterate over each stream in a WIM image that has not yet been hashed */
367 #define image_for_each_unhashed_stream(lte, imd) \
368 list_for_each_entry(lte, &imd->unhashed_streams, unhashed_list)
370 /* Iterate over each stream in a WIM image that has not yet been hashed (safe
371 * against stream removal) */
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))
377 # define zero_resource_entry(entry) memset(entry, 0, sizeof(struct resource_entry))
380 copy_resource_entry(struct resource_entry *dst,
381 const struct resource_entry *src)
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];
390 zero_resource_entry(struct resource_entry *entry)
392 BUILD_BUG_ON(sizeof(struct resource_entry) != 24);
393 ((u64*)entry)[0] = 0;
394 ((u64*)entry)[1] = 0;
395 ((u64*)entry)[2] = 0;
401 /* Hash table to find inodes, given an inode number (in the case of reading
402 * a WIM images), or both an inode number and a device number (in the case of
403 * capturing a WIM image). */
404 struct wim_inode_table {
405 /* Fields for the hash table */
406 struct hlist_head *array;
411 * Linked list of "extra" inodes. These may be:
413 * - inodes with link count 1, which are all allowed to have 0 for their
414 * inode number, meaning we cannot insert them into the hash table.
416 * - Groups we create ourselves by splitting a nominal inode due to
417 * inconsistencies in the dentries. These inodes will share an inode
418 * number with some other inode until assign_inode_numbers() is
421 struct list_head extra_inodes;
424 /* Common parameters to implementations of building an in-memory dentry tree
425 * from an on-disk directory structure. */
426 struct add_image_params {
427 /* Pointer to the lookup table of the WIM. */
428 struct wim_lookup_table *lookup_table;
430 /* Pointer to a hash table of inodes that have been captured for this
431 * WIM image so far. */
432 struct wim_inode_table *inode_table;
434 /* Pointer to the set of security descriptors that have been captured
435 * for this image so far. */
436 struct sd_set *sd_set;
438 /* Pointer to the capture configuration, which indicates whether any
439 * files should be excluded from capture or not. */
440 const struct wimlib_capture_config *config;
442 /* Flags that affect the capture operation (WIMLIB_ADD_FLAG_*) */
445 /* If non-NULL, the user-supplied progress function. */
446 wimlib_progress_func_t progress_func;
448 /* Extra argument; set to point to a pointer to the ntfs_volume for
449 * libntfs-3g capture. */
452 u64 capture_root_ino;
453 u64 capture_root_dev;
457 /* capture_common.c */
460 exclude_path(const tchar *path, size_t path_len,
461 const struct wimlib_capture_config *config,
462 bool exclude_prefix);
464 extern struct wimlib_capture_config *
465 copy_capture_config(const struct wimlib_capture_config *config);
468 copy_and_canonicalize_capture_config(const struct wimlib_capture_config *config,
469 struct wimlib_capture_config **config_copy_ret);
472 free_capture_config(struct wimlib_capture_config *config);
474 /* extract_image.c */
476 /* Internal use only */
477 #define WIMLIB_EXTRACT_FLAG_MULTI_IMAGE 0x80000000
478 #define WIMLIB_EXTRACT_FLAG_NO_STREAMS 0x40000000
479 #define WIMLIB_EXTRACT_MASK_PUBLIC 0x3fffffff
484 init_inode_table(struct wim_inode_table *table, size_t capacity);
487 inode_table_new_dentry(struct wim_inode_table *table, const tchar *name,
488 u64 ino, u64 devno, bool noshare,
489 struct wim_dentry **dentry_ret);
492 inode_ref_streams(struct wim_inode *inode);
495 inode_table_prepare_inode_list(struct wim_inode_table *table,
496 struct list_head *head);
499 destroy_inode_table(struct wim_inode_table *table)
506 dentry_tree_fix_inodes(struct wim_dentry *root, struct list_head *inode_list);
511 read_header(const tchar *filename, int in_fd, struct wim_header *hdr,
515 write_header(const struct wim_header *hdr, int out_fd);
518 init_header(struct wim_header *hdr, int ctype);
522 #define WIM_INTEGRITY_OK 0
523 #define WIM_INTEGRITY_NOT_OK -1
524 #define WIM_INTEGRITY_NONEXISTENT -2
527 write_integrity_table(int fd,
528 struct resource_entry *integrity_res_entry,
529 off_t new_lookup_table_end,
530 off_t old_lookup_table_end,
531 wimlib_progress_func_t progress_func);
534 check_wim_integrity(WIMStruct *w, wimlib_progress_func_t progress_func);
539 new_joined_lookup_table(WIMStruct *w, WIMStruct **additional_swms,
540 unsigned num_additional_swms,
541 struct wim_lookup_table **table_ret);
543 /* metadata_resource.c */
546 read_metadata_resource(WIMStruct *w,
547 struct wim_image_metadata *image_metadata);
550 write_metadata_resource(WIMStruct *w);
557 unsigned target_nchars;
558 unsigned wim_source_path_nchars;
559 struct wim_dentry *extract_root;
560 tchar *target_realpath;
561 unsigned target_realpath_len;
563 union wimlib_progress_info progress;
564 wimlib_progress_func_t progress_func;
565 int (*apply_dentry)(struct wim_dentry *, void *);
569 /* NTFS apply only */
570 struct _ntfs_volume *vol;
575 /* Normal apply only (Win32) */
576 unsigned long num_set_sacl_priv_notheld;
577 unsigned long num_set_sd_access_denied;
579 unsigned long num_hard_links_failed;
580 unsigned long num_soft_links_failed;
585 /* Normal apply only (UNIX) */
586 unsigned long num_utime_warnings;
593 apply_dentry_ntfs(struct wim_dentry *dentry, void *arg);
596 apply_dentry_timestamps_ntfs(struct wim_dentry *dentry, void *arg);
599 libntfs3g_global_init();
603 typedef int (*consume_data_callback_t)(const void *buf, size_t len, void *ctx);
606 read_ntfs_file_prefix(const struct wim_lookup_table_entry *lte,
608 consume_data_callback_t cb,
612 build_dentry_tree_ntfs(struct wim_dentry **root_p,
614 struct add_image_params *ctx);
618 do_ntfs_umount(struct _ntfs_volume *vol);
623 /* Structured format for symbolic link, junction point, or mount point reparse
625 struct reparse_data {
626 /* Reparse point tag (see WIM_IO_REPARSE_TAG_* values) */
629 /* Length of reparse data, not including the 8-byte header (ReparseTag,
630 * ReparseDataLength, ReparseReserved) */
633 /* ReparseReserved */
636 /* Flags (only for WIM_IO_REPARSE_TAG_SYMLINK reparse points).
637 * SYMBOLIC_LINK_RELATIVE means this is a relative symbolic link;
638 * otherwise should be set to 0. */
639 #define SYMBOLIC_LINK_RELATIVE 0x00000001
642 /* Pointer to the substitute name of the link (UTF-16LE). */
643 utf16lechar *substitute_name;
645 /* Pointer to the print name of the link (UTF-16LE). */
646 utf16lechar *print_name;
648 /* Number of bytes of the substitute name, not including null terminator
650 u16 substitute_name_nbytes;
652 /* Number of bytes of the print name, not including null terminator if
654 u16 print_name_nbytes;
658 SUBST_NAME_IS_RELATIVE_LINK = -1,
659 SUBST_NAME_IS_VOLUME_JUNCTION = -2,
660 SUBST_NAME_IS_UNKNOWN = -3,
663 parse_substitute_name(const utf16lechar *substitute_name,
664 u16 substitute_name_nbytes,
668 parse_reparse_data(const u8 *rpbuf, u16 rpbuflen, struct reparse_data *rpdata);
671 make_reparse_buffer(const struct reparse_data *rpdata, u8 *buf);
674 wim_inode_get_reparse_data(const struct wim_inode *inode, u8 *rpbuf);
678 wim_inode_readlink(const struct wim_inode *inode, char *buf, size_t buf_len);
681 wim_inode_set_symlink(struct wim_inode *inode, const char *target,
682 struct wim_lookup_table *lookup_table);
685 capture_fixup_absolute_symlink(tchar *dest,
686 u64 capture_root_ino, u64 capture_root_dev);
691 #define WIMLIB_RESOURCE_FLAG_RAW 0x1
692 #define WIMLIB_RESOURCE_FLAG_RECOMPRESS 0x4
695 read_resource_prefix(const struct wim_lookup_table_entry *lte,
696 u64 size, consume_data_callback_t cb, void *ctx_or_buf,
700 get_resource_entry(const void *p, struct resource_entry *entry);
703 put_resource_entry(void *p, const struct resource_entry *entry);
706 read_partial_wim_resource_into_buf(const struct wim_lookup_table_entry *lte,
707 size_t size, u64 offset, void *buf);
709 read_full_resource_into_buf(const struct wim_lookup_table_entry *lte, void *buf);
712 write_wim_resource(struct wim_lookup_table_entry *lte, int out_fd,
713 int out_ctype, struct resource_entry *out_res_entry,
717 extract_wim_resource(const struct wim_lookup_table_entry *lte,
719 consume_data_callback_t extract_chunk,
720 void *extract_chunk_arg);
723 extract_wim_resource_to_fd(const struct wim_lookup_table_entry *lte,
727 sha1_resource(struct wim_lookup_table_entry *lte);
730 copy_resource(struct wim_lookup_table_entry *lte, void *w);
733 extern struct wim_security_data *
734 new_wim_security_data();
737 read_security_data(const u8 metadata_resource[],
738 u64 metadata_resource_len, struct wim_security_data **sd_p);
740 print_security_data(const struct wim_security_data *sd);
743 write_security_data(const struct wim_security_data *sd, u8 *p);
746 free_security_data(struct wim_security_data *sd);
751 unix_do_apply_dentry(const char *output_path, size_t output_path_len,
752 struct wim_dentry *dentry, struct apply_args *args);
754 unix_do_apply_dentry_timestamps(const char *output_path,
755 size_t output_path_len,
756 struct wim_dentry *dentry,
757 struct apply_args *args);
763 unix_build_dentry_tree(struct wim_dentry **root_ret,
764 const char *root_disk_path,
765 struct add_image_params *params);
770 rename_wim_path(WIMStruct *wim, const tchar *from, const tchar *to);
775 verify_dentry(struct wim_dentry *dentry, void *wim);
778 wim_run_full_verifications(WIMStruct *w);
781 verify_swm_set(WIMStruct *w,
782 WIMStruct **additional_swms, unsigned num_additional_swms);
787 select_wim_image(WIMStruct *w, int image);
790 for_image(WIMStruct *w, int image, int (*visitor)(WIMStruct *));
793 destroy_image_metadata(struct wim_image_metadata *imd,
794 struct wim_lookup_table *table,
795 bool free_metadata_lte);
798 put_image_metadata(struct wim_image_metadata *imd,
799 struct wim_lookup_table *table);
802 append_image_metadata(WIMStruct *w, struct wim_image_metadata *imd);
804 extern struct wim_image_metadata *
805 new_image_metadata();
807 extern struct wim_image_metadata **
808 new_image_metadata_array(unsigned num_images);
811 wim_checksum_unhashed_streams(WIMStruct *w);
814 reopen_wim(WIMStruct *w);
817 close_wim(WIMStruct *w);
821 /* Internal use only */
822 #define WIMLIB_WRITE_FLAG_NO_LOOKUP_TABLE 0x80000000
823 #define WIMLIB_WRITE_FLAG_REUSE_INTEGRITY_TABLE 0x40000000
824 #define WIMLIB_WRITE_FLAG_CHECKPOINT_AFTER_XML 0x20000000
825 #define WIMLIB_WRITE_MASK_PUBLIC 0x1fffffff
827 /* We are capturing a tree to be placed in the root of the WIM image */
828 #define WIMLIB_ADD_FLAG_ROOT 0x80000000
831 begin_write(WIMStruct *w, const tchar *path, int write_flags);
834 close_wim_writable(WIMStruct *w);
837 finish_write(WIMStruct *w, int image, int write_flags,
838 wimlib_progress_func_t progress_func);
840 #if defined(HAVE_SYS_FILE_H) && defined(HAVE_FLOCK)
842 lock_wim(WIMStruct *w, int fd);
845 lock_wim(WIMStruct *w, int fd)
851 #endif /* _WIMLIB_INTERNAL_H */