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
44 #define WIM_MAGIC_LEN 8
45 #define WIM_GID_LEN 16
46 #define WIM_UNUSED_LEN 60
49 /* Length of the WIM header on disk. */
50 #define WIM_HEADER_DISK_SIZE (148 + WIM_UNUSED_LEN)
52 /* Compressed resources in the WIM are divided into separated compressed chunks
54 #define WIM_CHUNK_SIZE 32768
56 /* Version of the WIM file. There is an older version, but we don't support it
57 * yet. The differences between the versions are undocumented. */
58 #define WIM_VERSION 0x10d00
60 #define WIM_INTEGRITY_OK 0
61 #define WIM_INTEGRITY_NOT_OK -1
62 #define WIM_INTEGRITY_NONEXISTENT -2
64 /* Metadata for a resource in a WIM file. */
65 struct resource_entry {
66 /* Size, in bytes, of the resource in the WIM file. */
69 /* Bitwise or of one or more of the WIM_RESHDR_FLAG_* flags. */
72 /* Offset, in bytes, of the resource in the WIM file. */
75 /* Uncompressed size of the resource in the WIM file. Is the same as
76 * @size if the resource is uncompressed. */
80 /* Flags for the `flags' field of the struct resource_entry structure. */
82 /* I haven't seen this flag used in any of the WIMs I have examined. I assume
83 * it means that there are no references to the stream, so the space is free.
84 * However, even after deleting files from a WIM mounted with `imagex.exe
85 * /mountrw', I could not see this flag being used. Either way, we don't
86 * actually use this flag for anything. */
87 #define WIM_RESHDR_FLAG_FREE 0x01
89 /* Indicates that the stream is a metadata resource for a WIM image. */
90 #define WIM_RESHDR_FLAG_METADATA 0x02
92 /* Indicates that the stream is compressed. */
93 #define WIM_RESHDR_FLAG_COMPRESSED 0x04
95 /* I haven't seen this flag used in any of the WIMs I have examined. Perhaps it
96 * means that a stream could possibly be split among multiple split WIM parts.
97 * However, `imagex.exe /split' does not seem to create any WIMs like this.
98 * Either way, we don't actually use this flag for anything. */
99 #define WIM_RESHDR_FLAG_SPANNED 0x08
102 /* Header at the very beginning of the WIM file. */
104 /* Identifies the file as WIM file. Must be exactly
105 * {'M', 'S', 'W', 'I', 'M', 0, 0, 0} */
106 //u8 magic[WIM_MAGIC_LEN];
108 /* size of WIM header in bytes. */
111 /* Version of the WIM file. M$ provides no documentation about exactly
112 * what this field affects about the file format, other than the fact
113 * that more recent versions have a higher value. */
116 /* Bitwise OR of one or more of the WIM_HDR_FLAG_* defined below. */
119 /* The size of the pieces that the uncompressed files were split up into
120 * when they were compressed. This should be the same as
121 * WIM_CHUNK_SIZE. M$ incorrectly documents this as "the size of the
122 * compressed .wim file in bytes".*/
125 /* A unique identifier for the WIM file. */
126 u8 guid[WIM_GID_LEN];
128 /* Part number of the WIM file in a spanned set. */
131 /* Total number of parts in a spanned set. */
134 /* Number of images in the WIM file. */
137 /* Location, size, and flags of the lookup table of the WIM. */
138 struct resource_entry lookup_table_res_entry;
140 /* Location, size, and flags for the XML data of the WIM. */
141 struct resource_entry xml_res_entry;
143 /* Location, size, and flags for the boot metadata. This means the
144 * metadata resource for the image specified by boot_idx below. Should
145 * be zeroed out if boot_idx is 0. */
146 struct resource_entry boot_metadata_res_entry;
148 /* The index of the bootable image in the WIM file. If 0, there are no
149 * bootable images available. */
152 /* The location of the optional integrity table used to verify the
153 * integrity WIM. Zeroed out if there is no integrity table.*/
154 struct resource_entry integrity;
156 /* Reserved for future disuse */
157 //u8 unused[WIM_UNUSED_LEN];
160 /* Flags for the `flags' field of the struct wim_header: */
162 /* Reserved for future use by M$ */
163 #define WIM_HDR_FLAG_RESERVED 0x00000001
165 /* Files and metadata in the WIM are compressed. */
166 #define WIM_HDR_FLAG_COMPRESSION 0x00000002
168 /* WIM is read-only (we ignore this). */
169 #define WIM_HDR_FLAG_READONLY 0x00000004
171 /* Resource data specified by images in this WIM may be contained in a different
172 * WIM. Or in other words, this WIM is part of a split WIM. */
173 #define WIM_HDR_FLAG_SPANNED 0x00000008
175 /* The WIM contains resources only; no filesystem metadata. We ignore this
176 * flag, as we look for file resources in all the WIMs anyway. */
177 #define WIM_HDR_FLAG_RESOURCE_ONLY 0x00000010
179 /* The WIM contains metadata only. We ignore this flag. Note that all the
180 * metadata resources for a split WIM should be in the first part. */
181 #define WIM_HDR_FLAG_METADATA_ONLY 0x00000020
183 /* Lock field to prevent multiple writers from writing the WIM concurrently. We
184 * ignore this flag. */
185 #define WIM_HDR_FLAG_WRITE_IN_PROGRESS 0x00000040
187 /* Reparse point fixup ???
188 * This has something to do with absolute targets of reparse points / symbolic
189 * links but I don't know what. We ignore this flag. */
190 #define WIM_HDR_FLAG_RP_FIX 0x00000080
192 /* Unused, reserved flag for another compression type */
193 #define WIM_HDR_FLAG_COMPRESS_RESERVED 0x00010000
195 /* Resources within the WIM are compressed using "XPRESS" compression, which is
196 * a LZ77-based compression algorithm. */
197 #define WIM_HDR_FLAG_COMPRESS_XPRESS 0x00020000
199 /* Resources within the WIM are compressed using "LZX" compression. This is also
200 * a LZ77-based algorithm. */
201 #define WIM_HDR_FLAG_COMPRESS_LZX 0x00040000
207 /* Structure for security data. Each image in the WIM file has its own security
209 struct wim_security_data {
210 /* The total length of the security data, in bytes. A typical size is
211 * 2048 bytes. If there is no security data, though (as in the WIMs
212 * that wimlib writes, currently), it will be 8 bytes. */
215 /* The number of security descriptors in the array @descriptors, below.
216 * It is really an unsigned int, but it must fit into an int because the
217 * security ID's are signed. (Not like you would ever have more than a
218 * few hundred security descriptors anyway). */
221 /* Array of sizes of the descriptors in the array @descriptors. */
224 /* Array of descriptors. */
227 /* keep track of how many WIMs reference this security data (used when
228 * exporting images between WIMs) */
235 /* Metadata resource for an image. */
236 struct image_metadata {
237 /* Pointer to the root dentry for the image. */
238 struct dentry *root_dentry;
240 /* Pointer to the security data for the image. */
241 struct wim_security_data *security_data;
243 /* A pointer to the lookup table entry for this image's metadata
245 struct lookup_table_entry *metadata_lte;
247 struct hlist_head inode_list;
249 /* True if the filesystem of the image has been modified. If this is
250 * the case, the memory for the filesystem is not freed when switching
251 * to a different WIM image. */
253 u8 has_been_mounted_rw : 1;
256 #define WIMLIB_RESOURCE_FLAG_RAW 0x1
257 #define WIMLIB_RESOURCE_FLAG_MULTITHREADED 0x2
258 #define WIMLIB_RESOURCE_FLAG_RECOMPRESS 0x4
260 /* The opaque structure exposed to the wimlib API. */
263 /* A pointer to the file indicated by @filename, opened for reading. */
267 /* Extra file pointers to be used by concurrent readers */
269 size_t num_allocated_fps;
270 pthread_mutex_t fp_tab_mutex;
273 /* FILE pointer for the WIM file that is being written. */
276 /* The name of the WIM file that has been opened. */
279 /* The lookup table for the WIM file. */
280 struct lookup_table *lookup_table;
282 /* Pointer to the XML data read from the WIM file. */
285 /* Information retrieved from the XML data, arranged
286 * in an orderly manner. */
287 struct wim_info *wim_info;
289 /* Array of the image metadata of length image_count. Each image in the
290 * WIM has a image metadata associated with it. */
291 struct image_metadata *image_metadata;
293 /* The header of the WIM file. */
294 struct wim_header hdr;
296 /* Temporary fields */
302 struct _ntfs_volume *ntfs_vol;
305 /* The currently selected image, indexed starting at 1. If not 0,
306 * subtract 1 from this to get the index of the current image in the
307 * image_metadata array. */
310 /* %true iff any images have been deleted from this WIM. */
311 bool deletion_occurred;
315 /* Inline utility functions for WIMStructs. */
317 static inline struct dentry *wim_root_dentry(WIMStruct *w)
319 return w->image_metadata[w->current_image - 1].root_dentry;
322 static inline struct wim_security_data *
323 wim_security_data(WIMStruct *w)
325 return w->image_metadata[w->current_image - 1].security_data;
327 static inline const struct wim_security_data *
328 wim_const_security_data(const WIMStruct *w)
330 return w->image_metadata[w->current_image - 1].security_data;
333 static inline struct lookup_table_entry*
334 wim_metadata_lookup_table_entry(WIMStruct *w)
336 return w->image_metadata[w->current_image - 1].metadata_lte;
339 /* Nonzero if a struct resource_entry indicates a compressed resource. */
340 static inline int resource_is_compressed(const struct resource_entry *entry)
342 return (entry->flags & WIM_RESHDR_FLAG_COMPRESSED);
345 static inline struct image_metadata *
346 wim_get_current_image_metadata(WIMStruct *w)
348 return &w->image_metadata[w->current_image - 1];
351 struct pattern_list {
354 size_t num_allocated_pats;
357 struct capture_config {
358 struct pattern_list exclusion_list;
359 struct pattern_list exclusion_exception;
360 struct pattern_list compression_exclusion_list;
361 struct pattern_list alignment_list;
369 /* Hash table to find inodes, identified by their inode ID.
372 /* Fields for the hash table */
373 struct hlist_head *array;
378 * Linked list of "extra" inodes. These may be:
380 * - inodes with link count 1, which are all allowed to have 0 for their
381 * inode number, meaning we cannot insert them into the hash table
382 * before calling assign_inode_numbers().
384 * - Groups we create ourselves by splitting a nominal inode due to
385 * inconsistencies in the dentries. These inodes will share a inode
386 * ID with some other inode until assign_inode_numbers() is called.
388 struct hlist_head extra_inodes;
391 extern int init_inode_table(struct inode_table *table, size_t capacity);
392 static inline void destroy_inode_table(struct inode_table *table)
396 extern int inode_table_insert(struct dentry *dentry, void *__table);
397 extern u64 assign_inode_numbers(struct hlist_head *inode_list);
398 extern int fix_inodes(struct inode_table *table, struct hlist_head *inode_list);
402 extern int read_header(FILE *fp, struct wim_header *hdr, int split_ok);
403 extern int write_header(const struct wim_header *hdr, FILE *out);
404 extern int init_header(struct wim_header *hdr, int ctype);
407 extern int write_integrity_table(FILE *out,
408 struct resource_entry *integrity_res_entry,
409 off_t new_lookup_table_end,
410 off_t old_lookup_table_end,
411 wimlib_progress_func_t progress_func);
413 extern int check_wim_integrity(WIMStruct *w,
414 wimlib_progress_func_t progress_func);
418 extern int new_joined_lookup_table(WIMStruct *w,
419 WIMStruct **additional_swms,
420 unsigned num_additional_swms,
421 struct lookup_table **table_ret);
423 extern int verify_swm_set(WIMStruct *w,
424 WIMStruct **additional_swms,
425 unsigned num_additional_swms);
427 extern void destroy_image_metadata(struct image_metadata *imd,
428 struct lookup_table *lt);
429 extern bool exclude_path(const char *path,
430 const struct capture_config *config,
431 bool exclude_prefix);
432 extern int do_add_image(WIMStruct *w, const char *dir, const char *name,
433 const char *config_str, size_t config_len,
435 int (*capture_tree)(struct dentry **, const char *,
436 struct lookup_table *,
437 struct wim_security_data *,
438 const struct capture_config *,
441 wimlib_progress_func_t progress_func);
449 unsigned num_lutimes_warnings;
450 struct list_head *stream_list;
451 union wimlib_progress_info progress;
453 struct _ntfs_volume *vol;
455 struct list_head empty_files;
456 wimlib_progress_func_t progress_func;
459 extern int apply_dentry_ntfs(struct dentry *dentry, void *arg);
460 extern int apply_dentry_timestamps_ntfs(struct dentry *dentry, void *arg);
463 extern int build_dentry_tree_ntfs(struct dentry **root_p,
465 struct lookup_table *lookup_table,
466 struct wim_security_data *sd,
467 const struct capture_config *config,
469 wimlib_progress_func_t progress_func,
473 extern const u8 *get_resource_entry(const u8 *p, struct resource_entry *entry);
474 extern u8 *put_resource_entry(u8 *p, const struct resource_entry *entry);
476 extern int read_uncompressed_resource(FILE *fp, u64 offset, u64 size, u8 buf[]);
478 extern int read_wim_resource(const struct lookup_table_entry *lte, u8 buf[],
479 size_t size, u64 offset, int flags);
481 extern int read_full_wim_resource(const struct lookup_table_entry *lte,
482 u8 buf[], int flags);
484 extern int write_wim_resource(struct lookup_table_entry *lte,
485 FILE *out_fp, int out_ctype,
486 struct resource_entry *out_res_entry,
489 extern int extract_wim_resource_to_fd(const struct lookup_table_entry *lte,
493 extern int extract_full_wim_resource_to_fd(const struct lookup_table_entry *lte,
496 extern int read_metadata_resource(WIMStruct *w,
497 struct image_metadata *image_metadata);
500 extern int write_dentry_resources(struct dentry *dentry, void *wim_p);
501 extern int copy_resource(struct lookup_table_entry *lte, void *w);
502 extern int write_metadata_resource(WIMStruct *w);
506 int read_security_data(const u8 metadata_resource[],
507 u64 metadata_resource_len, struct wim_security_data **sd_p);
509 void print_security_data(const struct wim_security_data *sd);
510 u8 *write_security_data(const struct wim_security_data *sd, u8 *p);
511 void free_security_data(struct wim_security_data *sd);
514 ssize_t inode_readlink(const struct inode *inode, char *buf, size_t buf_len,
515 const WIMStruct *w, int read_resource_flags);
516 extern void *make_symlink_reparse_data_buf(const char *symlink_target,
518 extern int inode_set_symlink(struct inode *inode,
520 struct lookup_table *lookup_table,
521 struct lookup_table_entry **lte_ret);
524 extern WIMStruct *new_wim_struct();
525 extern int select_wim_image(WIMStruct *w, int image);
526 extern int wim_hdr_flags_compression_type(int wim_hdr_flags);
527 extern int for_image(WIMStruct *w, int image, int (*visitor)(WIMStruct *));
529 /* Internal use only */
530 #define WIMLIB_WRITE_FLAG_NO_LOOKUP_TABLE 0x80000000
531 #define WIMLIB_WRITE_FLAG_REUSE_INTEGRITY_TABLE 0x40000000
532 #define WIMLIB_WRITE_FLAG_CHECKPOINT_AFTER_XML 0x20000000
533 #define WIMLIB_WRITE_MASK_PUBLIC 0x1fffffff
535 /* Internal use only */
536 #define WIMLIB_EXTRACT_FLAG_MULTI_IMAGE 0x80000000
537 #define WIMLIB_EXTRACT_FLAG_NO_STREAMS 0x40000000
538 #define WIMLIB_EXTRACT_MASK_PUBLIC 0x3fffffff
542 extern int begin_write(WIMStruct *w, const char *path, int write_flags);
543 extern void close_wim_writable(WIMStruct *w);
545 extern int finish_write(WIMStruct *w, int image, int write_flags,
546 wimlib_progress_func_t progress_func);
548 #if defined(HAVE_SYS_FILE_H) && defined(HAVE_FLOCK)
549 extern int lock_wim(FILE *fp, const char *path);
551 static inline int lock_wim(FILE *fp, const char *path)
557 #endif /* _WIMLIB_INTERNAL_H */