edadad2ab0bfdc6a5ddd26191e358e58b9384cd5
[wimlib] / src / wimlib_internal.h
1 /*
2  * wimlib_internal.h
3  *
4  * Internal header for wimlib.
5  */
6
7 /*
8  * Copyright (C) 2010 Carl Thijssen
9  * Copyright (C) 2012 Eric Biggers
10  *
11  * This file is part of wimlib, a library for working with WIM files.
12  *
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)
16  * any later version.
17  *
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
21  * details.
22  *
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/.
25  */
26
27 #ifndef _WIMLIB_INTERNAL_H
28 #define _WIMLIB_INTERNAL_H
29
30 #include "util.h"
31 #include "list.h"
32
33 struct stat;
34 struct dentry;
35 struct inode;
36
37 #define WIM_MAGIC_LEN  8
38 #define WIM_GID_LEN    16
39 #define WIM_UNUSED_LEN 60
40
41
42 /* Length of the WIM header on disk. */
43 #define WIM_HEADER_DISK_SIZE (148 + WIM_UNUSED_LEN)
44
45 /* Compressed resources in the WIM are divided into separated compressed chunks
46  * of this size. */
47 #define WIM_CHUNK_SIZE 32768
48
49 /* Version of the WIM file.  There is an older version, but we don't support it
50  * yet.  The differences between the versions are undocumented. */
51 #define WIM_VERSION 0x10d00
52
53 enum wim_integrity_status {
54         WIM_INTEGRITY_OK,
55         WIM_INTEGRITY_NOT_OK,
56         WIM_INTEGRITY_NONEXISTENT,
57 };
58
59 /* Metadata for a resource in a WIM file. */
60 struct resource_entry {
61         /* Size, in bytes, of the resource in the WIM file. */
62         u64 size  : 56;
63
64         /* Bitwise or of one or more of the WIM_RESHDR_FLAG_* flags. */
65         u64 flags : 8;
66
67         /* Offset, in bytes, of the resource in the WIM file. */
68         u64 offset;
69
70         /* Uncompressed size of the resource in the WIM file.  Is the same as
71          * @size if the resource is uncompressed. */
72         u64 original_size;
73 };
74
75 /* Flags for the `flags' field of the struct resource_entry structure. */
76
77 /* I haven't seen this flag used in any of the WIMs I have examined.  I assume
78  * it means that there are no references to the stream, so the space is free.
79  * However, even after deleting files from a WIM mounted with `imagex.exe
80  * /mountrw', I could not see this flag being used.  Either way, we don't
81  * actually use this flag for anything. */
82 #define WIM_RESHDR_FLAG_FREE            0x01
83
84 /* Indicates that the stream is a metadata resource for a WIM image. */
85 #define WIM_RESHDR_FLAG_METADATA        0x02
86
87 /* Indicates that the stream is compressed. */
88 #define WIM_RESHDR_FLAG_COMPRESSED      0x04
89
90 /* I haven't seen this flag used in any of the WIMs I have examined.  Perhaps it
91  * means that a stream could possibly be split among multiple split WIM parts.
92  * However, `imagex.exe /split' does not seem to create any WIMs like this.
93  * Either way, we don't actually use this flag for anything.  */
94 #define WIM_RESHDR_FLAG_SPANNED         0x08
95
96
97 /* Header at the very beginning of the WIM file. */
98 struct wim_header {
99         /* Identifies the file as WIM file. Must be exactly
100          * {'M', 'S', 'W', 'I', 'M', 0, 0, 0}  */
101         //u8  magic[WIM_MAGIC_LEN];
102
103         /* size of WIM header in bytes. */
104         //u32 hdr_size;
105
106         /* Version of the WIM file.  M$ provides no documentation about exactly
107          * what this field affects about the file format, other than the fact
108          * that more recent versions have a higher value. */
109         //u32 version;
110
111         /* Bitwise OR of one or more of the WIM_HDR_FLAG_* defined below. */
112         u32 flags;
113
114         /* The size of the pieces that the uncompressed files were split up into
115          * when they were compressed.  This should be the same as
116          * WIM_CHUNK_SIZE.  M$ incorrectly documents this as "the size of the
117          * compressed .wim file in bytes".*/
118         //u32 chunk_size;
119
120         /* A unique identifier for the WIM file. */
121         u8  guid[WIM_GID_LEN];
122
123         /* Part number of the WIM file in a spanned set. */
124         u16 part_number;
125
126         /* Total number of parts in a spanned set. */
127         u16 total_parts;
128
129         /* Number of images in the WIM file. */
130         u32 image_count;
131
132         /* Location, size, and flags of the lookup table of the WIM. */
133         struct resource_entry lookup_table_res_entry;
134
135         /* Location, size, and flags for the XML data of the WIM. */
136         struct resource_entry xml_res_entry;
137
138         /* Location, size, and flags for the boot metadata.  This means the
139          * metadata resource for the image specified by boot_idx below.  Should
140          * be zeroed out if boot_idx is 0. */
141         struct resource_entry boot_metadata_res_entry;
142
143         /* The index of the bootable image in the WIM file. If 0, there are no
144          * bootable images available. */
145         u32 boot_idx;
146
147         /* The location of the optional integrity table used to verify the
148          * integrity WIM.  Zeroed out if there is no integrity table.*/
149         struct resource_entry integrity;
150
151         /* Reserved for future disuse */
152         //u8 unused[WIM_UNUSED_LEN];
153 };
154
155 /* Flags for the `flags' field of the struct wim_header: */
156
157 /* Reserved for future use by M$ */
158 #define WIM_HDR_FLAG_RESERVED           0x00000001
159
160 /* Files and metadata in the WIM are compressed. */
161 #define WIM_HDR_FLAG_COMPRESSION        0x00000002
162
163 /* WIM is read-only (we ignore this). */
164 #define WIM_HDR_FLAG_READONLY           0x00000004
165
166 /* Resource data specified by images in this WIM may be contained in a different
167  * WIM.  Or in other words, this WIM is part of a split WIM.  */
168 #define WIM_HDR_FLAG_SPANNED            0x00000008
169
170 /* The WIM contains resources only; no filesystem metadata.  We ignore this
171  * flag, as we look for file resources in all the WIMs anyway. */
172 #define WIM_HDR_FLAG_RESOURCE_ONLY      0x00000010
173
174 /* The WIM contains metadata only.  We ignore this flag.  Note that all the
175  * metadata resources for a split WIM should be in the first part. */
176 #define WIM_HDR_FLAG_METADATA_ONLY      0x00000020
177
178 /* Lock field to prevent multiple writers from writing the WIM concurrently.  We
179  * ignore this flag. */
180 #define WIM_HDR_FLAG_WRITE_IN_PROGRESS  0x00000040
181
182 /* Reparse point fixup ???
183  * This has something to do with absolute targets of reparse points / symbolic
184  * links but I don't know what.  We ignore this flag.  */
185 #define WIM_HDR_FLAG_RP_FIX             0x00000080
186
187 /* Unused, reserved flag for another compression type */
188 #define WIM_HDR_FLAG_COMPRESS_RESERVED  0x00010000
189
190 /* Resources within the WIM are compressed using "XPRESS" compression, which is
191  * a LZ77-based compression algorithm. */
192 #define WIM_HDR_FLAG_COMPRESS_XPRESS    0x00020000
193
194 /* Resources within the WIM are compressed using "LZX" compression.  This is also
195  * a LZ77-based algorithm. */
196 #define WIM_HDR_FLAG_COMPRESS_LZX       0x00040000
197
198 #ifdef WITH_NTFS_3G
199 struct _ntfs_volume;
200 #endif
201
202 /* Structure for security data.  Each image in the WIM file has its own security
203  * data. */
204 struct wim_security_data {
205         /* The total length of the security data, in bytes.  A typical size is
206          * 2048 bytes.  If there is no security data, though (as in the WIMs
207          * that wimlib writes, currently), it will be 8 bytes. */
208         u32 total_length;
209
210         /* The number of security descriptors in the array @descriptors, below.
211          * It is really an unsigned int, but it must fit into an int because the
212          * security ID's are signed.  (Not like you would ever have more than a
213          * few hundred security descriptors anyway). */
214         int32_t num_entries;
215
216         /* Array of sizes of the descriptors in the array @descriptors. */
217         u64 *sizes;
218
219         /* Array of descriptors. */
220         u8 **descriptors;
221
222         /* keep track of how many WIMs reference this security data (used when
223          * exporting images between WIMs) */
224         u32 refcnt;
225 };
226
227 struct inode_table;
228
229
230 /* Metadata resource for an image. */
231 struct image_metadata {
232         /* Pointer to the root dentry for the image. */
233         struct dentry    *root_dentry;
234
235         /* Pointer to the security data for the image. */
236         struct wim_security_data *security_data;
237
238         /* A pointer to the lookup table entry for this image's metadata
239          * resource. */
240         struct lookup_table_entry *metadata_lte;
241
242         struct hlist_head inode_list;
243
244         /* True if the filesystem of the image has been modified.  If this is
245          * the case, the memory for the filesystem is not freed when switching
246          * to a different WIM image. */
247         bool modified;
248
249 };
250
251 /* The opaque structure exposed to the wimlib API. */
252 typedef struct WIMStruct {
253
254         /* A pointer to the file indicated by @filename, opened for reading. */
255         FILE  *fp;
256
257         /* FILE pointer for the WIM file that is being written. */
258         FILE  *out_fp;
259
260         /* The name of the WIM file that has been opened. */
261         char  *filename;
262
263         /* The lookup table for the WIM file. */
264         struct lookup_table *lookup_table;
265
266         /* Pointer to the XML data read from the WIM file. */
267         u8    *xml_data;
268
269         /* Information retrieved from the XML data, arranged
270          * in an orderly manner. */
271         struct wim_info      *wim_info;
272
273         /* Array of the image metadata of length image_count.  Each image in the
274          * WIM has a image metadata associated with it. */
275         struct image_metadata     *image_metadata;
276
277         /* The header of the WIM file. */
278         struct wim_header    hdr;
279
280         /* Temporary flags to use when extracting a WIM image or adding a WIM
281          * image. */
282         union {
283                 int extract_flags;
284                 int add_flags;
285                 int write_flags;
286                 bool write_metadata;
287         };
288 #ifdef WITH_NTFS_3G
289         struct _ntfs_volume *ntfs_vol;
290 #endif
291
292         /* The currently selected image, indexed starting at 1.  If not 0,
293          * subtract 1 from this to get the index of the current image in the
294          * image_metadata array. */
295         int current_image;
296 } WIMStruct;
297
298
299 /* Inline utility functions for WIMStructs. */
300
301 static inline struct dentry *wim_root_dentry(WIMStruct *w)
302 {
303         return w->image_metadata[w->current_image - 1].root_dentry;
304 }
305
306 static inline struct wim_security_data *
307 wim_security_data(WIMStruct *w)
308 {
309         return w->image_metadata[w->current_image - 1].security_data;
310 }
311 static inline const struct wim_security_data *
312 wim_const_security_data(const WIMStruct *w)
313 {
314         return w->image_metadata[w->current_image - 1].security_data;
315 }
316
317 static inline struct lookup_table_entry*
318 wim_metadata_lookup_table_entry(WIMStruct *w)
319 {
320         return w->image_metadata[w->current_image - 1].metadata_lte;
321 }
322
323 /* Nonzero if a struct resource_entry indicates a compressed resource. */
324 static inline int resource_is_compressed(const struct resource_entry *entry)
325 {
326         return (entry->flags & WIM_RESHDR_FLAG_COMPRESSED);
327 }
328
329 static inline struct image_metadata *
330 wim_get_current_image_metadata(WIMStruct *w)
331 {
332         return &w->image_metadata[w->current_image - 1];
333 }
334
335 struct pattern_list {
336         const char **pats;
337         size_t num_pats;
338         size_t num_allocated_pats;
339 };
340
341 struct capture_config {
342         struct pattern_list exclusion_list;
343         struct pattern_list exclusion_exception;
344         struct pattern_list compression_exclusion_list;
345         struct pattern_list alignment_list;
346         char *config_str;
347         char *prefix;
348         size_t prefix_len;
349 };
350
351 /* hardlink.c */
352
353 /* Hash table to find inodes, identified by their inode ID.
354  * */
355 struct inode_table {
356         /* Fields for the hash table */
357         struct hlist_head *array;
358         u64 num_entries;
359         u64 capacity;
360
361         /*
362          * Linked list of "extra" inodes.  These may be:
363          *
364          * - inodes with link count 1, which are all allowed to have 0 for their
365          *   inode number, meaning we cannot insert them into the hash table
366          *   before calling assign_inode_numbers().
367          *
368          * - Groups we create ourselves by splitting a nominal inode due to
369          *   inconsistencies in the dentries.  These inodes will share a inode
370          *   ID with some other inode until assign_inode_numbers() is called.
371          */
372         struct hlist_head extra_inodes;
373 };
374
375 int init_inode_table(struct inode_table *table, size_t capacity);
376 static inline void destroy_inode_table(struct inode_table *table)
377 {
378         FREE(table->array);
379 }
380 int inode_table_insert(struct dentry *dentry, void *__table);
381 u64 assign_inode_numbers(struct hlist_head *inode_list);
382 int fix_inodes(struct inode_table *table, struct hlist_head *inode_list);
383
384
385 /* header.c */
386 extern int read_header(FILE *fp, struct wim_header *hdr, int split_ok);
387 extern int write_header(const struct wim_header *hdr, FILE *out);
388 extern int init_header(struct wim_header *hdr, int ctype);
389
390 /* integrity.c */
391 extern int write_integrity_table(FILE *out, u64 end_header_offset,
392                                  u64 end_lookup_table_offset,
393                                  int show_progress);
394 extern int check_wim_integrity(WIMStruct *w, int show_progress, int *status);
395
396 /* join.c */
397
398 extern int new_joined_lookup_table(WIMStruct *w,
399                                    WIMStruct **additional_swms,
400                                    unsigned num_additional_swms,
401                                    struct lookup_table **table_ret);
402
403 extern int verify_swm_set(WIMStruct *w,
404                           WIMStruct **additional_swms,
405                           unsigned num_additional_swms);
406 /* modify.c */
407 extern void destroy_image_metadata(struct image_metadata *imd,
408                                    struct lookup_table *lt);
409 extern bool exclude_path(const char *path,
410                          const struct capture_config *config,
411                          bool exclude_prefix);
412 extern int do_add_image(WIMStruct *w, const char *dir, const char *name,
413                         const char *config_str, size_t config_len,
414                         int flags,
415                         int (*capture_tree)(struct dentry **, const char *,
416                                      struct lookup_table *,
417                                      struct wim_security_data *,
418                                      const struct capture_config *,
419                                      int, void *),
420                         void *extra_arg);
421
422 /* resource.c */
423 extern const u8 *get_resource_entry(const u8 *p, struct resource_entry *entry);
424 extern u8 *put_resource_entry(u8 *p, const struct resource_entry *entry);
425
426 extern int read_uncompressed_resource(FILE *fp, u64 offset, u64 size, u8 buf[]);
427
428 extern int read_wim_resource(const struct lookup_table_entry *lte, u8 buf[],
429                              size_t size, u64 offset, bool raw);
430
431 extern int read_full_wim_resource(const struct lookup_table_entry *lte, u8 buf[]);
432
433 extern int extract_wim_resource_to_fd(const struct lookup_table_entry *lte,
434                                       int fd, u64 size);
435
436
437 extern int extract_full_wim_resource_to_fd(const struct lookup_table_entry *lte,
438                                            int fd);
439
440 extern int read_metadata_resource(WIMStruct *w,
441                                   struct image_metadata *image_metadata);
442
443
444 extern int write_dentry_resources(struct dentry *dentry, void *wim_p);
445 extern int copy_resource(struct lookup_table_entry *lte, void *w);
446 extern int write_metadata_resource(WIMStruct *w);
447
448
449 /* security.c */
450 int read_security_data(const u8 metadata_resource[],
451                 u64 metadata_resource_len, struct wim_security_data **sd_p);
452
453 void print_security_data(const struct wim_security_data *sd);
454 u8 *write_security_data(const struct wim_security_data *sd, u8 *p);
455 void free_security_data(struct wim_security_data *sd);
456
457 /* symlink.c */
458 ssize_t inode_readlink(const struct inode *inode, char *buf, size_t buf_len,
459                         const WIMStruct *w);
460 extern void *make_symlink_reparse_data_buf(const char *symlink_target,
461                                            size_t *len_ret);
462 extern int inode_set_symlink(struct inode *inode,
463                              const char *target,
464                              struct lookup_table *lookup_table,
465                              struct lookup_table_entry **lte_ret);
466
467 /* wim.c */
468 extern WIMStruct *new_wim_struct();
469 extern int select_wim_image(WIMStruct *w, int image);
470 extern int wim_hdr_flags_compression_type(int wim_hdr_flags);
471 extern int for_image(WIMStruct *w, int image, int (*visitor)(WIMStruct *));
472
473 /* Internal use only */
474 #define WIMLIB_WRITE_FLAG_NO_LOOKUP_TABLE 0x80000000
475
476 /* write.c */
477 extern int begin_write(WIMStruct *w, const char *path, int write_flags);
478 extern int finish_write(WIMStruct *w, int image, int write_flags);
479
480
481 #include "wimlib.h"
482
483 #endif /* _WIMLIB_INTERNAL_H */
484