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_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. */
75 #define WIM_RESHDR_FLAG_FREE 0x01
77 /* Indicates that a file resource is a metadata resource. */
78 #define WIM_RESHDR_FLAG_METADATA 0x02
80 /* Indicates that a file resource is compressed. */
81 #define WIM_RESHDR_FLAG_COMPRESSED 0x04
84 #define WIM_RESHDR_FLAG_SPANNED 0x08
87 /* Header at the very beginning of the WIM file. */
89 /* Identifies the file as WIM file. Must be exactly
90 * {'M', 'S', 'W', 'I', 'M', 0, 0, 0} */
91 //u8 magic[WIM_MAGIC_LEN];
93 /* size of WIM header in bytes. */
96 /* Version of the WIM file. M$ provides no documentation about exactly
97 * what this field affects about the file format, other than the fact
98 * that more recent versions have a higher value. */
101 /* Bitwise OR of one or more of the WIM_HDR_FLAG_* defined below. */
104 /* The size of the pieces that the uncompressed files were split up into
105 * when they were compressed. This should be the same as
106 * WIM_CHUNK_SIZE. M$ incorrectly documents this as "the size of the
107 * compressed .wim file in bytes".*/
110 /* A unique identifier for the WIM file. */
111 u8 guid[WIM_GID_LEN];
113 /* Part number of the WIM file in a spanned set. */
116 /* Total number of parts in a spanned set. */
119 /* Number of images in the WIM file. */
122 /* Location, size, and flags of the lookup table of the WIM. */
123 struct resource_entry lookup_table_res_entry;
125 /* Location, size, and flags for the XML data of the WIM. */
126 struct resource_entry xml_res_entry;
128 /* Location, size, and flags for the boot metadata. This means the
129 * metadata resource for the image specified by boot_idx below. Should
130 * be zeroed out if boot_idx is 0. */
131 struct resource_entry boot_metadata_res_entry;
133 /* The index of the bootable image in the WIM file. If 0, there are no
134 * bootable images available. */
137 /* The location of the optional integrity table used to verify the
138 * integrity WIM. Zeroed out if there is no integrity table.*/
139 struct resource_entry integrity;
141 /* Reserved for future disuse */
142 //u8 unused[WIM_UNUSED_LEN];
145 /* Flags for the `flags' field of the struct wim_header. */
148 /* Reserved for future use by M$ */
149 #define WIM_HDR_FLAG_RESERVED 0x00000001
151 /* Files and metadata in the WIM are compressed. */
152 #define WIM_HDR_FLAG_COMPRESSION 0x00000002
154 /* WIM is read-only. */
155 #define WIM_HDR_FLAG_READONLY 0x00000004
157 /* Resource data specified by images in this WIM may be contained in a different
159 #define WIM_HDR_FLAG_SPANNED 0x00000008
161 /* The WIM contains resources only; no filesystem metadata. */
162 #define WIM_HDR_FLAG_RESOURCE_ONLY 0x00000010
164 /* The WIM contains metadata only. */
165 #define WIM_HDR_FLAG_METADATA_ONLY 0x00000020
167 /* Lock field to prevent multiple writers from writing the WIM concurrently. */
168 #define WIM_HDR_FLAG_WRITE_IN_PROGRESS 0x00000040
170 /* Reparse point fixup ??? */
171 #define WIM_HDR_FLAG_RP_FIX 0x00000080
173 /* Unknown compression type */
174 #define WIM_HDR_FLAG_COMPRESS_RESERVED 0x00010000
176 /* Resources within the WIM are compressed using "XPRESS" compression, which is
177 * a LZ77-based compression algorithm. */
178 #define WIM_HDR_FLAG_COMPRESS_XPRESS 0x00020000
180 /* Resources within the WIM are compressed using "LZX" compression. This is also
181 * a LZ77-based algorithm. */
182 #define WIM_HDR_FLAG_COMPRESS_LZX 0x00040000
185 /* Structure for security data. Each image in the WIM file has its own security
187 struct wim_security_data {
188 /* The total length of the security data, in bytes. A typical size is
189 * 2048 bytes. If there is no security data, though (as in the WIMs
190 * that wimlib writes, currently), it will be 8 bytes. */
193 /* The number of security descriptors in the array @descriptors, below. */
196 /* Array of sizes of the descriptors in the array @descriptors. */
199 /* Array of descriptors. */
202 /* keep track of how many WIMs reference this security data (used when
203 * exporting images between WIMs) */
207 struct link_group_table;
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 /* Pointer to the security data for the image. */
216 struct wim_security_data *security_data;
218 /* Hard link group table */
219 struct link_group_table *lgt;
221 /* A pointer to the lookup table entry for this image's metadata
223 struct lookup_table_entry *metadata_lte;
225 /* True if the filesystem of the image has been modified. If this is
226 * the case, the memory for the filesystem is not freed when switching
227 * to a different WIM image. */
232 /* The opaque structure exposed to the wimlib API. */
233 typedef struct WIMStruct {
235 /* A pointer to the file indicated by @filename, opened for reading. */
238 /* FILE pointer for the WIM file that is being written. */
241 /* The name of the WIM file that has been opened. */
244 /* The lookup table for the WIM file. */
245 struct lookup_table *lookup_table;
247 /* Pointer to the XML data read from the WIM file. */
250 /* Information retrieved from the XML data, arranged
251 * in an orderly manner. */
252 struct wim_info *wim_info;
254 /* Array of the image metadata of length image_count. Each image in the
255 * WIM has a image metadata associated with it. */
256 struct image_metadata *image_metadata;
258 /* The header of the WIM file. */
259 struct wim_header hdr;
261 /* Temporary flags to use when extracting a WIM image or adding a WIM
268 /* The currently selected image, indexed starting at 1. If not 0,
269 * subtract 1 from this to get the index of the current image in the
270 * image_metadata array. */
277 /* Inline utility functions for WIMStructs. */
279 static inline struct dentry *wim_root_dentry(WIMStruct *w)
281 return w->image_metadata[w->current_image - 1].root_dentry;
284 static inline struct dentry **wim_root_dentry_p(WIMStruct *w)
286 return &w->image_metadata[w->current_image - 1].root_dentry;
289 static inline struct wim_security_data *wim_security_data(WIMStruct *w)
291 return w->image_metadata[w->current_image - 1].security_data;
294 static inline struct lookup_table_entry*
295 wim_metadata_lookup_table_entry(WIMStruct *w)
297 return w->image_metadata[w->current_image - 1].metadata_lte;
300 /* Nonzero if a struct resource_entry indicates a compressed resource. */
301 static inline int resource_is_compressed(const struct resource_entry *entry)
303 return (entry->flags & WIM_RESHDR_FLAG_COMPRESSED);
306 static inline struct image_metadata *wim_get_current_image_metadata(WIMStruct *w)
308 return &w->image_metadata[w->current_image - 1];
313 struct link_group_table *new_link_group_table(u64 capacity);
314 int link_group_table_insert(struct dentry *dentry,
316 void free_link_group_table(struct link_group_table *table);
317 u64 assign_link_groups(struct link_group_table *table);
318 int link_groups_free_duplicate_data(struct link_group_table *table);
322 extern int read_header(FILE *fp, struct wim_header *hdr, int split_ok);
323 extern int write_header(const struct wim_header *hdr, FILE *out);
324 extern int init_header(struct wim_header *hdr, int ctype);
327 extern int write_integrity_table(FILE *out, u64 end_header_offset,
328 u64 end_lookup_table_offset,
330 extern int check_wim_integrity(WIMStruct *w, int show_progress, int *status);
333 extern void destroy_image_metadata(struct image_metadata *imd,
334 struct lookup_table *lt);
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,
395 extern int dentry_set_symlink(struct dentry *dentry,
397 struct lookup_table *lookup_table,
398 struct lookup_table_entry **lte_ret);
401 extern WIMStruct *new_wim_struct();
402 extern int wimlib_select_image(WIMStruct *w, int image);
403 extern int wim_hdr_flags_compression_type(int wim_hdr_flags);
404 extern int wim_resource_compression_type(const WIMStruct *w,
405 const struct resource_entry *entry);
406 extern int for_image(WIMStruct *w, int image, int (*visitor)(WIMStruct *));
409 extern int finish_write(WIMStruct *w, int image, int flags,
410 int write_lookup_table);
412 extern int begin_write(WIMStruct *w, const char *path, int flags);
417 #endif /* _WIMLIB_INTERNAL_H */