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
35 #define WIM_HASH_SIZE 20
38 #define WIM_MAGIC_LEN 8
39 #define WIM_GID_LEN 16
40 #define WIM_UNUSED_LEN 60
43 /* Length of the WIM header on disk. */
44 #define WIM_HEADER_DISK_SIZE (148 + WIM_UNUSED_LEN)
46 /* Compressed resources in the WIM are divided into separated compressed chunks
48 #define WIM_CHUNK_SIZE 32768
50 /* Version of the WIM file. There is an older version, but we don't support it
51 * yet. The differences between the versions are undocumented. */
52 #define WIM_VERSION 0x10d00
54 enum wim_integrity_status {
57 WIM_INTEGRITY_NONEXISTENT,
60 /* Metadata for a resource in a WIM file. */
61 struct resource_entry {
62 /* Size, in bytes, of the resource in the WIM file. */
65 /* Bitwise or of one or more of the WIM_RESHDR_FLAG_* flags. */
68 /* Offset, in bytes, of the resource in the WIM file. */
71 /* Uncompressed size of the resource in the WIM file. Is the same as
72 * @size if the resource is uncompressed. */
76 /* Flags for the `flags' field of the struct resource_entry structure. */
79 #define WIM_RESHDR_FLAG_FREE 0x01
81 /* Indicates that a file resource is a metadata resource. */
82 #define WIM_RESHDR_FLAG_METADATA 0x02
84 /* Indicates that a file resource is compressed. */
85 #define WIM_RESHDR_FLAG_COMPRESSED 0x04
88 #define WIM_RESHDR_FLAG_SPANNED 0x08
91 /* Header at the very beginning of the WIM file. */
93 /* Identifies the file as WIM file. Must be exactly
94 * {'M', 'S', 'W', 'I', 'M', 0, 0, 0} */
95 //u8 magic[WIM_MAGIC_LEN];
97 /* size of WIM header in bytes. */
100 /* Version of the WIM file. M$ provides no documentation about exactly
101 * what this field affects about the file format, other than the fact
102 * that more recent versions have a higher value. */
105 /* Bitwise OR of one or more of the WIM_HDR_FLAG_* defined below. */
108 /* The size of the pieces that the uncompressed files were split up into
109 * when they were compressed. This should be the same as
110 * WIM_CHUNK_SIZE. M$ incorrectly documents this as "the size of the
111 * compressed .wim file in bytes".*/
114 /* A unique identifier for the WIM file. */
115 u8 guid[WIM_GID_LEN];
117 /* Part number of the WIM file in a spanned set. */
120 /* Total number of parts in a spanned set. */
123 /* Number of images in the WIM file. */
126 /* Location, size, and flags of the lookup table of the WIM. */
127 struct resource_entry lookup_table_res_entry;
129 /* Location, size, and flags for the XML data of the WIM. */
130 struct resource_entry xml_res_entry;
132 /* Location, size, and flags for the boot metadata. This means the
133 * metadata resource for the image specified by boot_idx below. Should
134 * be zeroed out if boot_idx is 0. */
135 struct resource_entry boot_metadata_res_entry;
137 /* The index of the bootable image in the WIM file. If 0, there are no
138 * bootable images available. */
141 /* The location of the optional integrity table used to verify the
142 * integrity WIM. Zeroed out if there is no integrity table.*/
143 struct resource_entry integrity;
145 /* Reserved for future disuse */
146 //u8 unused[WIM_UNUSED_LEN];
149 /* Flags for the `flags' field of the struct wim_header. */
152 /* Reserved for future use by M$ */
153 #define WIM_HDR_FLAG_RESERVED 0x00000001
155 /* Files and metadata in the WIM are compressed. */
156 #define WIM_HDR_FLAG_COMPRESSION 0x00000002
158 /* WIM is read-only. */
159 #define WIM_HDR_FLAG_READONLY 0x00000004
161 /* Resource data specified by images in this WIM may be contained in a different
163 #define WIM_HDR_FLAG_SPANNED 0x00000008
165 /* The WIM contains resources only; no filesystem metadata. */
166 #define WIM_HDR_FLAG_RESOURCE_ONLY 0x00000010
168 /* The WIM contains metadata only. */
169 #define WIM_HDR_FLAG_METADATA_ONLY 0x00000020
171 /* Lock field to prevent multiple writers from writing the WIM concurrently. */
172 #define WIM_HDR_FLAG_WRITE_IN_PROGRESS 0x00000040
174 /* Reparse point fixup ??? */
175 #define WIM_HDR_FLAG_RP_FIX 0x00000080
177 /* Unknown compression type */
178 #define WIM_HDR_FLAG_COMPRESS_RESERVED 0x00010000
180 /* Resources within the WIM are compressed using "XPRESS" compression, which is
181 * a LZ77-based compression algorithm. */
182 #define WIM_HDR_FLAG_COMPRESS_XPRESS 0x00020000
184 /* Resources within the WIM are compressed using "LZX" compression. This is also
185 * a LZ77-based algorithm. */
186 #define WIM_HDR_FLAG_COMPRESS_LZX 0x00040000
189 /* Structure for security data. Each image in the WIM file has its own security
191 struct wim_security_data {
192 /* The total length of the security data, in bytes. A typical size is
193 * 2048 bytes. If there is no security data, though (as in the WIMs
194 * that wimlib writes, currently), it will be 8 bytes. */
197 /* The number of security descriptors in the array @descriptors, below. */
200 /* Array of sizes of the descriptors in the array @descriptors. */
203 /* Array of descriptors. */
206 /* keep track of how many WIMs reference this security data (used when
207 * exporting images between WIMs) */
211 struct link_group_table;
214 /* Metadata resource for an image. */
215 struct image_metadata {
216 /* Pointer to the root dentry for the image. */
217 struct dentry *root_dentry;
219 /* Pointer to the security data for the image. */
220 struct wim_security_data *security_data;
222 /* A pointer to the lookup table entry for this image's metadata
224 struct lookup_table_entry *metadata_lte;
226 /* Hard link group table */
227 struct link_group_table *lgt;
229 /* True if the filesystem of the image has been modified. If this is
230 * the case, the memory for the filesystem is not freed when switching
231 * to a different WIM image. */
236 /* The opaque structure exposed to the wimlib API. */
237 typedef struct WIMStruct {
239 /* A pointer to the file indicated by @filename, opened for reading. */
242 /* FILE pointer for the WIM file that is being written. */
245 /* The name of the WIM file that has been opened. */
248 /* The lookup table for the WIM file. */
249 struct lookup_table *lookup_table;
251 /* Pointer to the XML data read from the WIM file. */
254 /* Information retrieved from the XML data, arranged
255 * in an orderly manner. */
256 struct wim_info *wim_info;
258 /* Array of the image metadata of length image_count. Each image in the
259 * WIM has a image metadata associated with it. */
260 struct image_metadata *image_metadata;
262 /* The header of the WIM file. */
263 struct wim_header hdr;
265 /* Temporary flags to use when extracting a WIM image or adding a WIM
272 /* The currently selected image, indexed starting at 1. If not 0,
273 * subtract 1 from this to get the index of the current image in the
274 * image_metadata array. */
281 /* Inline utility functions for WIMStructs. */
283 static inline struct dentry *wim_root_dentry(WIMStruct *w)
285 return w->image_metadata[w->current_image - 1].root_dentry;
288 static inline struct dentry **wim_root_dentry_p(WIMStruct *w)
290 return &w->image_metadata[w->current_image - 1].root_dentry;
293 static inline struct wim_security_data *wim_security_data(WIMStruct *w)
295 return w->image_metadata[w->current_image - 1].security_data;
298 static inline struct lookup_table_entry*
299 wim_metadata_lookup_table_entry(WIMStruct *w)
301 return w->image_metadata[w->current_image - 1].metadata_lte;
304 /* Nonzero if a struct resource_entry indicates a compressed resource. */
305 static inline int resource_is_compressed(const struct resource_entry *entry)
307 return (entry->flags & WIM_RESHDR_FLAG_COMPRESSED);
310 static inline struct image_metadata *wim_get_current_image_metadata(WIMStruct *w)
312 return &w->image_metadata[w->current_image - 1];
315 /* Prints a hash code field. */
316 static inline void print_hash(const u8 hash[])
318 print_byte_field(hash, WIM_HASH_SIZE);
323 struct link_group_table *new_link_group_table(u64 capacity);
324 int link_group_table_insert(struct dentry *dentry,
325 struct link_group_table *table);
326 void free_link_group_table(struct link_group_table *table);
327 u64 assign_link_groups(struct link_group_table *table);
328 int link_groups_free_duplicate_data(struct link_group_table *table);
332 extern int read_header(FILE *fp, struct wim_header *hdr, int split_ok);
333 extern int write_header(const struct wim_header *hdr, FILE *out);
334 extern int init_header(struct wim_header *hdr, int ctype);
337 extern int write_integrity_table(FILE *out, u64 end_header_offset,
338 u64 end_lookup_table_offset,
340 extern int check_wim_integrity(WIMStruct *w, int show_progress, int *status);
343 extern void destroy_image_metadata(struct image_metadata *imd,
344 struct lookup_table *lt);
347 extern const u8 *get_resource_entry(const u8 *p, struct resource_entry *entry);
348 extern u8 *put_resource_entry(u8 *p, const struct resource_entry *entry);
350 extern int read_resource(FILE *fp, u64 resource_size,
351 u64 resource_original_size,
352 u64 resource_offset, int resource_ctype, u64 len,
353 u64 offset, void *contents_ret);
355 extern int read_uncompressed_resource(FILE *fp, u64 offset, u64 len,
359 extern int extract_resource_to_fd(WIMStruct *w,
360 const struct resource_entry *entry,
364 extern int extract_full_resource_to_fd(WIMStruct *w,
365 const struct resource_entry *entry,
368 extern int read_metadata_resource(FILE *fp, int wim_ctype,
369 struct image_metadata *image_metadata);
371 extern int resource_compression_type(int wim_ctype, int reshdr_flags);
373 static inline int read_full_resource(FILE *fp, u64 resource_size,
374 u64 resource_original_size,
376 int resource_ctype, void *contents_ret)
378 return read_resource(fp, resource_size, resource_original_size,
379 resource_offset, resource_ctype,
380 resource_original_size, 0, contents_ret);
383 extern int write_dentry_resources(struct dentry *dentry, void *wim_p);
384 extern int copy_resource(struct lookup_table_entry *lte, void *w);
385 extern int copy_between_files(FILE *in, off_t in_offset, FILE *out, size_t len);
386 extern int write_resource_from_memory(const u8 resource[], int out_ctype,
387 u64 resource_original_size, FILE *out,
388 u64 *resource_size_ret);
389 extern int write_metadata_resource(WIMStruct *w);
393 int read_security_data(const u8 metadata_resource[],
394 u64 metadata_resource_len, struct wim_security_data **sd_p);
396 void print_security_data(const struct wim_security_data *sd);
397 u8 *write_security_data(const struct wim_security_data *sd, u8 *p);
398 void free_security_data(struct wim_security_data *sd);
401 ssize_t dentry_readlink(const struct dentry *dentry, char *buf, size_t buf_len,
403 extern void *make_symlink_reparse_data_buf(const char *symlink_target,
405 extern int dentry_set_symlink(struct dentry *dentry,
407 struct lookup_table *lookup_table);
410 extern WIMStruct *new_wim_struct();
411 extern int wimlib_select_image(WIMStruct *w, int image);
412 extern int wim_hdr_flags_compression_type(int wim_hdr_flags);
413 extern int wim_resource_compression_type(const WIMStruct *w,
414 const struct resource_entry *entry);
415 extern int for_image(WIMStruct *w, int image, int (*visitor)(WIMStruct *));
418 extern int finish_write(WIMStruct *w, int image, int flags,
419 int write_lookup_table);
421 extern int begin_write(WIMStruct *w, const char *path, int flags);
426 #endif /* _WIMLIB_INTERNAL_H */