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 General Public License as published by the Free
15 * Software Foundation; either version 3 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 General Public License for more
23 * You should have received a copy of the GNU 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_MAGIC_LEN 8
35 #define WIM_GID_LEN 16
36 #define WIM_UNUSED_LEN 60
39 /* Length of the WIM header on disk. */
40 #define WIM_HEADER_DISK_SIZE (148 + WIM_UNUSED_LEN)
42 /* Compressed resources in the WIM are divided into separated compressed chunks
44 #define WIM_CHUNK_SIZE 32768
46 /* Version of the WIM file. There is an older version, but we don't support it
47 * yet. The differences between the versions are undocumented. */
48 #define WIM_VERSION 0x10d00
50 enum wim_integrity_status {
53 WIM_INTEGRITY_NONEXISTENT,
56 /* Metadata for a resource in a WIM file. */
57 struct resource_entry {
58 /* Size, in bytes, of the resource in the WIM file. */
61 /* Bitwise or of one or more of the WIM_RESHDR_FLAG_* flags. */
64 /* Offset, in bytes, of the resource in the WIM file. */
67 /* Uncompressed size of the resource in the WIM file. Is the same as
68 * @size if the resource is uncompressed. */
72 /* Flags for the `flags' field of the struct resource_entry structure. */
74 /* I haven't seen this flag used in any of the WIMs I have examined. I assume
75 * it means that there are no references to the stream, so the space is free.
76 * However, even after deleting files from a WIM mounted with `imagex.exe
77 * /mountrw', I could not see this flag being used. Either way, we don't
78 * actually use this flag for anything. */
79 #define WIM_RESHDR_FLAG_FREE 0x01
81 /* Indicates that the stream is a metadata resource for a WIM image. */
82 #define WIM_RESHDR_FLAG_METADATA 0x02
84 /* Indicates that the stream is compressed. */
85 #define WIM_RESHDR_FLAG_COMPRESSED 0x04
87 /* I haven't seen this flag used in any of the WIMs I have examined. Perhaps it
88 * means that a stream could possibly be split among multiple split WIM parts.
89 * However, `imagex.exe /split' does not seem to create any WIMs like this.
90 * Either way, we don't actually use this flag for anything. */
91 #define WIM_RESHDR_FLAG_SPANNED 0x08
94 /* Header at the very beginning of the WIM file. */
96 /* Identifies the file as WIM file. Must be exactly
97 * {'M', 'S', 'W', 'I', 'M', 0, 0, 0} */
98 //u8 magic[WIM_MAGIC_LEN];
100 /* size of WIM header in bytes. */
103 /* Version of the WIM file. M$ provides no documentation about exactly
104 * what this field affects about the file format, other than the fact
105 * that more recent versions have a higher value. */
108 /* Bitwise OR of one or more of the WIM_HDR_FLAG_* defined below. */
111 /* The size of the pieces that the uncompressed files were split up into
112 * when they were compressed. This should be the same as
113 * WIM_CHUNK_SIZE. M$ incorrectly documents this as "the size of the
114 * compressed .wim file in bytes".*/
117 /* A unique identifier for the WIM file. */
118 u8 guid[WIM_GID_LEN];
120 /* Part number of the WIM file in a spanned set. */
123 /* Total number of parts in a spanned set. */
126 /* Number of images in the WIM file. */
129 /* Location, size, and flags of the lookup table of the WIM. */
130 struct resource_entry lookup_table_res_entry;
132 /* Location, size, and flags for the XML data of the WIM. */
133 struct resource_entry xml_res_entry;
135 /* Location, size, and flags for the boot metadata. This means the
136 * metadata resource for the image specified by boot_idx below. Should
137 * be zeroed out if boot_idx is 0. */
138 struct resource_entry boot_metadata_res_entry;
140 /* The index of the bootable image in the WIM file. If 0, there are no
141 * bootable images available. */
144 /* The location of the optional integrity table used to verify the
145 * integrity WIM. Zeroed out if there is no integrity table.*/
146 struct resource_entry integrity;
148 /* Reserved for future disuse */
149 //u8 unused[WIM_UNUSED_LEN];
152 /* Flags for the `flags' field of the struct wim_header: */
154 /* Reserved for future use by M$ */
155 #define WIM_HDR_FLAG_RESERVED 0x00000001
157 /* Files and metadata in the WIM are compressed. */
158 #define WIM_HDR_FLAG_COMPRESSION 0x00000002
160 /* WIM is read-only (we ignore this). */
161 #define WIM_HDR_FLAG_READONLY 0x00000004
163 /* Resource data specified by images in this WIM may be contained in a different
164 * WIM. Or in other words, this WIM is part of a split WIM. */
165 #define WIM_HDR_FLAG_SPANNED 0x00000008
167 /* The WIM contains resources only; no filesystem metadata. We ignore this
168 * flag, as we look for file resources in all the WIMs anyway. */
169 #define WIM_HDR_FLAG_RESOURCE_ONLY 0x00000010
171 /* The WIM contains metadata only. We ignore this flag. Note that all the
172 * metadata resources for a split WIM should be in the first part. */
173 #define WIM_HDR_FLAG_METADATA_ONLY 0x00000020
175 /* Lock field to prevent multiple writers from writing the WIM concurrently. We
176 * ignore this flag. */
177 #define WIM_HDR_FLAG_WRITE_IN_PROGRESS 0x00000040
179 /* Reparse point fixup ???
180 * This has something to do with absolute targets of reparse points / symbolic
181 * links but I don't know what. We ignore this flag. */
182 #define WIM_HDR_FLAG_RP_FIX 0x00000080
184 /* Unused, reserved flag for another compression type */
185 #define WIM_HDR_FLAG_COMPRESS_RESERVED 0x00010000
187 /* Resources within the WIM are compressed using "XPRESS" compression, which is
188 * a LZ77-based compression algorithm. */
189 #define WIM_HDR_FLAG_COMPRESS_XPRESS 0x00020000
191 /* Resources within the WIM are compressed using "LZX" compression. This is also
192 * a LZ77-based algorithm. */
193 #define WIM_HDR_FLAG_COMPRESS_LZX 0x00040000
196 typedef struct _ntfs_volume ntfs_volume;
199 /* Structure for security data. Each image in the WIM file has its own security
201 struct wim_security_data {
202 /* The total length of the security data, in bytes. A typical size is
203 * 2048 bytes. If there is no security data, though (as in the WIMs
204 * that wimlib writes, currently), it will be 8 bytes. */
207 /* The number of security descriptors in the array @descriptors, below.
208 * It is really an unsigned int, but it must fit into an int because the
209 * security ID's are signed. (Not like you would ever have more than a
210 * few hundred security descriptors anyway). */
213 /* Array of sizes of the descriptors in the array @descriptors. */
216 /* Array of descriptors. */
219 /* keep track of how many WIMs reference this security data (used when
220 * exporting images between WIMs) */
224 struct link_group_table;
227 /* Metadata resource for an image. */
228 struct image_metadata {
229 /* Pointer to the root dentry for the image. */
230 struct dentry *root_dentry;
232 /* Pointer to the security data for the image. */
233 struct wim_security_data *security_data;
235 /* Hard link group table */
236 struct link_group_table *lgt;
238 /* A pointer to the lookup table entry for this image's metadata
240 struct lookup_table_entry *metadata_lte;
242 /* True if the filesystem of the image has been modified. If this is
243 * the case, the memory for the filesystem is not freed when switching
244 * to a different WIM image. */
249 /* The opaque structure exposed to the wimlib API. */
250 typedef struct WIMStruct {
252 /* A pointer to the file indicated by @filename, opened for reading. */
255 /* FILE pointer for the WIM file that is being written. */
258 /* The name of the WIM file that has been opened. */
261 /* The lookup table for the WIM file. */
262 struct lookup_table *lookup_table;
264 /* Pointer to the XML data read from the WIM file. */
267 /* Information retrieved from the XML data, arranged
268 * in an orderly manner. */
269 struct wim_info *wim_info;
271 /* Array of the image metadata of length image_count. Each image in the
272 * WIM has a image metadata associated with it. */
273 struct image_metadata *image_metadata;
275 /* The header of the WIM file. */
276 struct wim_header hdr;
278 /* Temporary flags to use when extracting a WIM image or adding a WIM
287 ntfs_volume *ntfs_vol;
290 /* The currently selected image, indexed starting at 1. If not 0,
291 * subtract 1 from this to get the index of the current image in the
292 * image_metadata array. */
297 /* Inline utility functions for WIMStructs. */
299 static inline struct dentry *wim_root_dentry(WIMStruct *w)
301 return w->image_metadata[w->current_image - 1].root_dentry;
304 static inline struct wim_security_data *
305 wim_security_data(WIMStruct *w)
307 return w->image_metadata[w->current_image - 1].security_data;
309 static inline const struct wim_security_data *
310 wim_const_security_data(const WIMStruct *w)
312 return w->image_metadata[w->current_image - 1].security_data;
315 static inline struct lookup_table_entry*
316 wim_metadata_lookup_table_entry(WIMStruct *w)
318 return w->image_metadata[w->current_image - 1].metadata_lte;
321 /* Nonzero if a struct resource_entry indicates a compressed resource. */
322 static inline int resource_is_compressed(const struct resource_entry *entry)
324 return (entry->flags & WIM_RESHDR_FLAG_COMPRESSED);
327 static inline struct image_metadata *
328 wim_get_current_image_metadata(WIMStruct *w)
330 return &w->image_metadata[w->current_image - 1];
333 struct pattern_list {
336 size_t num_allocated_pats;
339 struct capture_config {
340 struct pattern_list exclusion_list;
341 struct pattern_list exclusion_exception;
342 struct pattern_list compression_exclusion_list;
343 struct pattern_list alignment_list;
351 struct link_group_table *new_link_group_table(size_t capacity);
352 int link_group_table_insert(struct dentry *dentry,
354 void free_link_group_table(struct link_group_table *table);
355 u64 assign_link_group_ids(struct link_group_table *table);
356 int fix_link_groups(struct link_group_table *table);
360 extern int read_header(FILE *fp, struct wim_header *hdr, int split_ok);
361 extern int write_header(const struct wim_header *hdr, FILE *out);
362 extern int init_header(struct wim_header *hdr, int ctype);
365 extern int write_integrity_table(FILE *out, u64 end_header_offset,
366 u64 end_lookup_table_offset,
368 extern int check_wim_integrity(WIMStruct *w, int show_progress, int *status);
372 extern int new_joined_lookup_table(WIMStruct *w,
373 WIMStruct **additional_swms,
374 unsigned num_additional_swms,
375 struct lookup_table **table_ret);
377 extern int verify_swm_set(WIMStruct *w,
378 WIMStruct **additional_swms,
379 unsigned num_additional_swms);
381 extern void destroy_image_metadata(struct image_metadata *imd,
382 struct lookup_table *lt);
383 extern bool exclude_path(const char *path,
384 const struct capture_config *config,
385 bool exclude_prefix);
386 extern int do_add_image(WIMStruct *w, const char *dir, const char *name,
387 const char *config_str, size_t config_len,
389 int (*capture_tree)(struct dentry **, const char *,
390 struct lookup_table *,
391 struct wim_security_data *,
392 const struct capture_config *,
397 extern const u8 *get_resource_entry(const u8 *p, struct resource_entry *entry);
398 extern u8 *put_resource_entry(u8 *p, const struct resource_entry *entry);
400 extern int read_uncompressed_resource(FILE *fp, u64 offset, u64 size, u8 buf[]);
402 extern int read_wim_resource(const struct lookup_table_entry *lte, u8 buf[],
403 size_t size, u64 offset, bool raw);
405 extern int read_full_wim_resource(const struct lookup_table_entry *lte, u8 buf[]);
407 extern int extract_wim_resource_to_fd(const struct lookup_table_entry *lte,
411 extern int extract_full_wim_resource_to_fd(const struct lookup_table_entry *lte,
414 extern int read_metadata_resource(WIMStruct *w,
415 struct image_metadata *image_metadata);
418 extern int write_dentry_resources(struct dentry *dentry, void *wim_p);
419 extern int copy_resource(struct lookup_table_entry *lte, void *w);
420 extern int write_metadata_resource(WIMStruct *w);
424 int read_security_data(const u8 metadata_resource[],
425 u64 metadata_resource_len, struct wim_security_data **sd_p);
427 void print_security_data(const struct wim_security_data *sd);
428 u8 *write_security_data(const struct wim_security_data *sd, u8 *p);
429 void free_security_data(struct wim_security_data *sd);
432 ssize_t dentry_readlink(const struct dentry *dentry, char *buf, size_t buf_len,
434 extern void *make_symlink_reparse_data_buf(const char *symlink_target,
436 extern int dentry_set_symlink(struct dentry *dentry,
438 struct lookup_table *lookup_table,
439 struct lookup_table_entry **lte_ret);
442 extern WIMStruct *new_wim_struct();
443 extern int wimlib_select_image(WIMStruct *w, int image);
444 extern int wim_hdr_flags_compression_type(int wim_hdr_flags);
445 extern int for_image(WIMStruct *w, int image, int (*visitor)(WIMStruct *));
448 extern int finish_write(WIMStruct *w, int image, int flags,
449 int write_lookup_table);
451 extern int begin_write(WIMStruct *w, const char *path, int flags);
456 #endif /* _WIMLIB_INTERNAL_H */