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 /* Metadata resource for an image. */
212 struct image_metadata {
213 /* Pointer to the root dentry for the image. */
214 struct dentry *root_dentry;
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 /* Temporary flags to use when extracting a WIM image or adding a WIM
269 /* The currently selected image, indexed starting at 1. If not 0,
270 * subtract 1 from this to get the index of the current image in the
271 * image_metadata array. */
275 /* Set to true when extracting multiple images */
276 bool is_multi_image_extraction;
283 /* Inline utility functions for WIMStructs. */
285 static inline struct dentry *wim_root_dentry(WIMStruct *w)
287 return w->image_metadata[w->current_image - 1].root_dentry;
290 static inline struct dentry **wim_root_dentry_p(WIMStruct *w)
292 return &w->image_metadata[w->current_image - 1].root_dentry;
295 static inline struct wim_security_data *wim_security_data(WIMStruct *w)
297 return w->image_metadata[w->current_image - 1].security_data;
300 static inline struct lookup_table_entry*
301 wim_metadata_lookup_table_entry(WIMStruct *w)
303 return w->image_metadata[w->current_image - 1].metadata_lte;
306 /* Nonzero if a struct resource_entry indicates a compressed resource. */
307 static inline int resource_is_compressed(const struct resource_entry *entry)
309 return (entry->flags & WIM_RESHDR_FLAG_COMPRESSED);
312 static inline struct image_metadata *wim_get_current_image_metadata(WIMStruct *w)
314 return &w->image_metadata[w->current_image - 1];
317 /* Prints a hash code field. */
318 static inline void print_hash(const u8 hash[])
320 print_byte_field(hash, WIM_HASH_SIZE);
325 extern int read_header(FILE *fp, struct wim_header *hdr, int split_ok);
326 extern int write_header(const struct wim_header *hdr, FILE *out);
327 extern int init_header(struct wim_header *hdr, int ctype);
330 extern int write_integrity_table(FILE *out, u64 end_header_offset,
331 u64 end_lookup_table_offset,
333 extern int check_wim_integrity(WIMStruct *w, int show_progress, int *status);
337 extern const u8 *get_resource_entry(const u8 *p, struct resource_entry *entry);
338 extern u8 *put_resource_entry(u8 *p, const struct resource_entry *entry);
340 extern int read_resource(FILE *fp, u64 resource_size,
341 u64 resource_original_size,
342 u64 resource_offset, int resource_ctype, u64 len,
343 u64 offset, void *contents_ret);
345 extern int read_uncompressed_resource(FILE *fp, u64 offset, u64 len,
349 extern int extract_resource_to_fd(WIMStruct *w,
350 const struct resource_entry *entry,
354 extern int extract_full_resource_to_fd(WIMStruct *w,
355 const struct resource_entry *entry,
358 extern int read_metadata_resource(FILE *fp, int wim_ctype,
359 struct image_metadata *image_metadata);
361 extern int resource_compression_type(int wim_ctype, int reshdr_flags);
363 static inline int read_full_resource(FILE *fp, u64 resource_size,
364 u64 resource_original_size,
366 int resource_ctype, void *contents_ret)
368 return read_resource(fp, resource_size, resource_original_size,
369 resource_offset, resource_ctype,
370 resource_original_size, 0, contents_ret);
373 extern int write_dentry_resources(struct dentry *dentry, void *wim_p);
374 extern int copy_resource(struct lookup_table_entry *lte, void *w);
375 extern int copy_between_files(FILE *in, off_t in_offset, FILE *out, size_t len);
376 extern int write_resource_from_memory(const u8 resource[], int out_ctype,
377 u64 resource_original_size, FILE *out,
378 u64 *resource_size_ret);
379 extern int write_metadata_resource(WIMStruct *w);
383 int read_security_data(const u8 metadata_resource[],
384 u64 metadata_resource_len, struct wim_security_data **sd_p);
386 void print_security_data(const struct wim_security_data *sd);
387 u8 *write_security_data(const struct wim_security_data *sd, u8 *p);
388 void free_security_data(struct wim_security_data *sd);
391 ssize_t dentry_readlink(const struct dentry *dentry, char *buf, size_t buf_len,
393 extern void *make_symlink_reparse_data_buf(const char *symlink_target,
397 extern WIMStruct *new_wim_struct();
398 extern int wimlib_select_image(WIMStruct *w, int image);
399 extern int wim_hdr_flags_compression_type(int wim_hdr_flags);
400 extern int wim_resource_compression_type(const WIMStruct *w,
401 const struct resource_entry *entry);
402 extern int for_image(WIMStruct *w, int image, int (*visitor)(WIMStruct *));
405 extern int finish_write(WIMStruct *w, int image, int flags,
406 int write_lookup_table);
408 extern int begin_write(WIMStruct *w, const char *path, int flags);
413 #endif /* _WIMLIB_INTERNAL_H */