4 * Internal header for wimlib.
8 * Copyright (C) 2010 Carl Thijssen
9 * Copyright (C) 2012 Eric Biggers
11 * This file is part of wimlib, a library for working with WIM files.
13 * wimlib is free software; you can redistribute it and/or modify it under the
14 * terms of the GNU Lesser General Public License as published by the Free
15 * Software Foundation; either version 2.1 of the License, or (at your option)
18 * wimlib is distributed in the hope that it will be useful, but WITHOUT ANY
19 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
20 * A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
23 * You should have received a copy of the GNU Lesser General Public License
24 * along with wimlib; if not, see http://www.gnu.org/licenses/.
27 #ifndef _WIMLIB_INTERNAL_H
28 #define _WIMLIB_INTERNAL_H
34 #define WIM_HASH_SIZE 20
35 #define WIM_MAGIC_LEN 8
36 #define WIM_GID_LEN 16
37 #define WIM_UNUSED_LEN 60
40 /* Length of the WIM header on disk. */
41 #define WIM_HEADER_DISK_SIZE (148 + WIM_UNUSED_LEN)
43 /* Compressed resources in the WIM are divided into separated compressed chunks
45 #define WIM_CHUNK_SIZE 32768
47 /* Version of the WIM file. I don't know if there has ever been a different
49 #define WIM_VERSION 0x10d00
51 enum wim_integrity_status {
54 WIM_INTEGRITY_NONEXISTENT,
57 /* Metadata for a resource in a WIM file. */
58 struct resource_entry {
59 /* Size, in bytes, of the resource in the WIM file. */
62 /* Bitwise or of one or more of the WIM_RESHDR_FLAG_* flags. */
65 /* Offset, in bytes, of the resource in the WIM file. */
68 /* Uncompressed size of the resource in the WIM file. Is the same as
69 * @size if the resource is uncompressed. */
73 /* Flags for the `flags' field of the struct resource_entry structure. */
76 #define WIM_RESHDR_FLAG_FREE 0x01
78 /* Indicates that a file resource is a metadata resource. */
79 #define WIM_RESHDR_FLAG_METADATA 0x02
81 /* Indicates that a file resource is compressed. */
82 #define WIM_RESHDR_FLAG_COMPRESSED 0x04
85 #define WIM_RESHDR_FLAG_SPANNED 0x08
88 /* Header at the very beginning of the WIM file. */
90 /* Identifies the file as WIM file. Must be exactly
91 * {'M', 'S', 'W', 'I', 'M', 0, 0, 0} */
92 //u8 magic[WIM_MAGIC_LEN];
94 /* size of WIM header in bytes. */
97 /* Version of the WIM file. M$ provides no documentation about exactly
98 * what this field affects about the file format, other than the fact
99 * that more recent versions have a higher value. */
102 /* Bitwise OR of one or more of the WIM_HDR_FLAG_* defined below. */
105 /* The size of the pieces that the uncompressed files were split up into
106 * when they were compressed. This should be the same as
107 * WIM_CHUNK_SIZE. M$ incorrectly documents this as "the size of the
108 * compressed .wim file in bytes".*/
111 /* A unique identifier for the WIM file. */
112 u8 guid[WIM_GID_LEN];
114 /* Part number of the WIM file in a spanned set. */
117 /* Total number of parts in a spanned set. */
120 /* Number of images in the WIM file. */
123 /* Location, size, and flags of the lookup table of the WIM. */
124 struct resource_entry lookup_table_res_entry;
126 /* Location, size, and flags for the XML data of the WIM. */
127 struct resource_entry xml_res_entry;
129 /* Location, size, and flags for the boot metadata. This means the
130 * metadata resource for the image specified by boot_idx below. Should
131 * be zeroed out if boot_idx is 0. */
132 struct resource_entry boot_metadata_res_entry;
134 /* The index of the bootable image in the WIM file. If 0, there are no
135 * bootable images available. */
138 /* The location of the optional integrity table used to verify the
139 * integrity WIM. Zeroed out if there is no integrity table.*/
140 struct resource_entry integrity;
142 /* Reserved for future disuse */
143 //u8 unused[WIM_UNUSED_LEN];
146 /* Flags for the `flags' field of the struct wim_header. */
149 /* Reserved for future use by M$ */
150 #define WIM_HDR_FLAG_RESERVED 0x00000001
152 /* Files and metadata in the WIM are compressed. */
153 #define WIM_HDR_FLAG_COMPRESSION 0x00000002
155 /* WIM is read-only. */
156 #define WIM_HDR_FLAG_READONLY 0x00000004
158 /* Resource data specified by images in this WIM may be contained in a different
160 #define WIM_HDR_FLAG_SPANNED 0x00000008
162 /* The WIM contains resources only; no filesystem metadata. */
163 #define WIM_HDR_FLAG_RESOURCE_ONLY 0x00000010
165 /* The WIM contains metadata only. */
166 #define WIM_HDR_FLAG_METADATA_ONLY 0x00000020
168 /* Lock field to prevent multiple writers from writing the WIM concurrently. */
169 #define WIM_HDR_FLAG_WRITE_IN_PROGRESS 0x00000040
171 /* Reparse point fixup ??? */
172 #define WIM_HDR_FLAG_RP_FIX 0x00000080
174 /* Unknown compression type */
175 #define WIM_HDR_FLAG_COMPRESS_RESERVED 0x00010000
177 /* Resources within the WIM are compressed using "XPRESS" compression, which is
178 * a LZ77-based compression algorithm. */
179 #define WIM_HDR_FLAG_COMPRESS_XPRESS 0x00020000
181 /* Resources within the WIM are compressed using "LZX" compression. This is also
182 * a LZ77-based algorithm. */
183 #define WIM_HDR_FLAG_COMPRESS_LZX 0x00040000
186 #ifdef ENABLE_SECURITY_DATA
187 /* Structure for security data. Each image in the WIM file has its own security
189 struct wim_security_data {
190 /* The total length of the security data, in bytes. A typical size is
191 * 2048 bytes. If there is no security data, though (as in the WIMs
192 * that wimlib writes, currently), it will be 8 bytes. */
195 /* The number of security descriptors in the array @descriptors, below. */
198 /* Array of sizes of the descriptors in the array @descriptors. */
201 /* Array of descriptors. */
204 /* keep track of how many WIMs reference this security data (used when
205 * exporting images between WIMs) */
210 /* Metadata resource for an image. */
211 struct image_metadata {
212 /* Pointer to the root dentry for the image. */
213 struct dentry *root_dentry;
215 #ifdef ENABLE_SECURITY_DATA
216 /* Pointer to the security data for the image. */
217 struct wim_security_data *security_data;
219 /* A pointer to the lookup table entry for this image's metadata
221 struct lookup_table_entry *metadata_lte;
223 /* True if the filesystem of the image has been modified. If this is
224 * the case, the memory for the filesystem is not freed when switching
225 * to a different WIM image. */
230 /* The opaque structure exposed to the wimlib API. */
231 typedef struct WIMStruct {
233 /* A pointer to the file indicated by @filename, opened for reading. */
236 /* FILE pointer for the WIM file that is being written. */
239 /* The name of the WIM file that has been opened. */
242 /* The lookup table for the WIM file. */
243 struct lookup_table *lookup_table;
245 /* Pointer to the XML data read from the WIM file. */
248 /* Information retrieved from the XML data, arranged
249 * in an orderly manner. */
250 struct wim_info *wim_info;
252 /* Array of the image metadata of length image_count. Each image in the
253 * WIM has a image metadata associated with it. */
254 struct image_metadata *image_metadata;
256 /* Name of the output directory for extraction. */
259 /* The header of the WIM file. */
260 struct wim_header hdr;
262 /* The type of links to create when extracting files (hard, symbolic, or
266 /* The currently selected image, indexed starting at 1. If not 0,
267 * subtract 1 from this to get the index of the current image in the
268 * image_metadata array. */
271 /* True if files names are to be printed when doing extraction.
272 * May be used for other things later. */
276 /* Set to true when extracting multiple images */
277 bool is_multi_image_extraction;
284 /* Inline utility functions for WIMStructs. */
286 static inline struct dentry *wim_root_dentry(WIMStruct *w)
288 return w->image_metadata[w->current_image - 1].root_dentry;
291 static inline struct dentry **wim_root_dentry_p(WIMStruct *w)
293 return &w->image_metadata[w->current_image - 1].root_dentry;
296 #ifdef ENABLE_SECURITY_DATA
297 static inline struct wim_security_data *wim_security_data(WIMStruct *w)
299 return w->image_metadata[w->current_image - 1].security_data;
303 static inline struct lookup_table_entry*
304 wim_metadata_lookup_table_entry(WIMStruct *w)
306 return w->image_metadata[w->current_image - 1].metadata_lte;
309 /* Nonzero if a struct resource_entry indicates a compressed resource. */
310 static inline int resource_is_compressed(const struct resource_entry *entry)
312 return (entry->flags & WIM_RESHDR_FLAG_COMPRESSED);
315 static inline struct image_metadata *wim_get_current_image_metadata(WIMStruct *w)
317 return &w->image_metadata[w->current_image - 1];
320 /* Prints a hash code field. */
321 static inline void print_hash(const u8 hash[])
323 print_byte_field(hash, WIM_HASH_SIZE);
328 extern int read_header(FILE *fp, struct wim_header *hdr, int split_ok);
329 extern int write_header(const struct wim_header *hdr, FILE *out);
330 extern int init_header(struct wim_header *hdr, int ctype);
333 extern int write_integrity_table(FILE *out, u64 end_header_offset,
334 u64 end_lookup_table_offset,
336 extern int check_wim_integrity(WIMStruct *w, int show_progress, int *status);
340 extern const u8 *get_resource_entry(const u8 *p, struct resource_entry *entry);
341 extern u8 *put_resource_entry(u8 *p, const struct resource_entry *entry);
343 extern int read_resource(FILE *fp, u64 resource_size,
344 u64 resource_original_size,
345 u64 resource_offset, int resource_ctype, u64 len,
346 u64 offset, void *contents_ret);
348 extern int read_uncompressed_resource(FILE *fp, u64 offset, u64 len,
352 extern int extract_resource_to_fd(WIMStruct *w,
353 const struct resource_entry *entry,
357 extern int extract_full_resource_to_fd(WIMStruct *w,
358 const struct resource_entry *entry,
361 extern int read_metadata_resource(FILE *fp, int wim_ctype,
362 struct image_metadata *image_metadata);
364 extern int resource_compression_type(int wim_ctype, int reshdr_flags);
366 static inline int read_full_resource(FILE *fp, u64 resource_size,
367 u64 resource_original_size,
369 int resource_ctype, void *contents_ret)
371 return read_resource(fp, resource_size, resource_original_size,
372 resource_offset, resource_ctype,
373 resource_original_size, 0, contents_ret);
376 extern int write_file_resource(struct dentry *dentry, void *wim_p);
377 extern int copy_resource(struct lookup_table_entry *lte, void *w);
378 extern int copy_between_files(FILE *in, off_t in_offset, FILE *out, size_t len);
379 extern int write_resource_from_memory(const u8 resource[], int out_ctype,
380 u64 resource_original_size, FILE *out,
381 u64 *resource_size_ret);
382 extern int write_metadata_resource(WIMStruct *w);
384 #ifdef ENABLE_SECURITY_DATA
385 int read_security_data(const u8 metadata_resource[],
386 u64 metadata_resource_len, struct wim_security_data **sd_p);
388 void print_security_data(const struct wim_security_data *sd);
389 u8 *write_security_data(const struct wim_security_data *sd, u8 *p);
390 void free_security_data(struct wim_security_data *sd);
394 extern WIMStruct *new_wim_struct();
395 extern int wimlib_select_image(WIMStruct *w, int image);
396 extern int wim_hdr_flags_compression_type(int wim_hdr_flags);
397 extern int wim_resource_compression_type(const WIMStruct *w,
398 const struct resource_entry *entry);
399 extern int for_image(WIMStruct *w, int image, int (*visitor)(WIMStruct *));
402 extern int finish_write(WIMStruct *w, int image, int flags,
403 int write_lookup_table);
405 extern int begin_write(WIMStruct *w, const char *path, int flags);
410 #endif /* _WIMLIB_INTERNAL_H */