Refactoring/rewrites
[wimlib] / src / wimlib_internal.h
1 /*
2  * wimlib_internal.h
3  *
4  * Internal header for wimlib.
5  */
6
7 /*
8  * Copyright (C) 2012 Eric Biggers
9  *
10  * This file is part of wimlib, a library for working with WIM files.
11  *
12  * wimlib is free software; you can redistribute it and/or modify it under the
13  * terms of the GNU General Public License as published by the Free
14  * Software Foundation; either version 3 of the License, or (at your option)
15  * any later version.
16  *
17  * wimlib is distributed in the hope that it will be useful, but WITHOUT ANY
18  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
19  * A PARTICULAR PURPOSE. See the GNU General Public License for more
20  * details.
21  *
22  * You should have received a copy of the GNU General Public License
23  * along with wimlib; if not, see http://www.gnu.org/licenses/.
24  */
25
26 #ifndef _WIMLIB_INTERNAL_H
27 #define _WIMLIB_INTERNAL_H
28
29 #include "config.h"
30 #include "util.h"
31 #include "list.h"
32 #include "wimlib.h"
33
34 #ifdef WITH_FUSE
35 #include <pthread.h>
36 #endif
37
38 struct stat;
39 struct dentry;
40 struct inode;
41
42 #define WIM_MAGIC_LEN  8
43 #define WIM_GID_LEN    16
44 #define WIM_UNUSED_LEN 60
45
46 /* Length of the WIM header on disk. */
47 #define WIM_HEADER_DISK_SIZE (148 + WIM_UNUSED_LEN)
48
49 /* Compressed resources in the WIM are divided into separated compressed chunks
50  * of this size. */
51 #define WIM_CHUNK_SIZE 32768
52
53 /* Version of the WIM file.  There is an older version, but we don't support it
54  * yet.  The differences between the versions are undocumented. */
55 #define WIM_VERSION 0x10d00
56
57 /* Metadata for a resource in a WIM file. */
58 struct resource_entry {
59         /* Size, in bytes, of the resource in the WIM file. */
60         u64 size  : 56;
61
62         /* Bitwise or of one or more of the WIM_RESHDR_FLAG_* flags. */
63         u64 flags : 8;
64
65         /* Offset, in bytes, of the resource in the WIM file. */
66         u64 offset;
67
68         /* Uncompressed size of the resource in the WIM file.  Is the same as
69          * @size if the resource is uncompressed. */
70         u64 original_size;
71 };
72
73 /* Flags for the `flags' field of the struct resource_entry structure. */
74
75 /* I haven't seen this flag used in any of the WIMs I have examined.  I assume
76  * it means that there are no references to the stream, so the space is free.
77  * However, even after deleting files from a WIM mounted with `imagex.exe
78  * /mountrw', I could not see this flag being used.  Either way, we don't
79  * actually use this flag for anything. */
80 #define WIM_RESHDR_FLAG_FREE            0x01
81
82 /* Indicates that the stream is a metadata resource for a WIM image. */
83 #define WIM_RESHDR_FLAG_METADATA        0x02
84
85 /* Indicates that the stream is compressed. */
86 #define WIM_RESHDR_FLAG_COMPRESSED      0x04
87
88 /* I haven't seen this flag used in any of the WIMs I have examined.  Perhaps it
89  * means that a stream could possibly be split among multiple split WIM parts.
90  * However, `imagex.exe /split' does not seem to create any WIMs like this.
91  * Either way, we don't actually use this flag for anything.  */
92 #define WIM_RESHDR_FLAG_SPANNED         0x08
93
94 /* Header at the very beginning of the WIM file. */
95 struct wim_header {
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];
99
100         /* size of WIM header in bytes. */
101         //u32 hdr_size;
102
103         /* Version of the WIM file.  Microsoft provides no documentation about
104          * exactly what this field affects about the file format, other than the
105          * fact that more recent versions have a higher value. */
106         //u32 version;
107
108         /* Bitwise OR of one or more of the WIM_HDR_FLAG_* defined below. */
109         u32 flags;
110
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.  Microsoft incorrectly documents this as "the size of
114          * the compressed .wim file in bytes".*/
115         //u32 chunk_size;
116
117         /* A unique identifier for the WIM file. */
118         u8 guid[WIM_GID_LEN];
119
120         /* Part number of the WIM file in a spanned set. */
121         u16 part_number;
122
123         /* Total number of parts in a spanned set. */
124         u16 total_parts;
125
126         /* Number of images in the WIM file. */
127         u32 image_count;
128
129         /* Location, size, and flags of the lookup table of the WIM. */
130         struct resource_entry lookup_table_res_entry;
131
132         /* Location, size, and flags for the XML data of the WIM. */
133         struct resource_entry xml_res_entry;
134
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;
139
140         /* The index of the bootable image in the WIM file. If 0, there are no
141          * bootable images available. */
142         u32 boot_idx;
143
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;
147
148         /* Reserved for future disuse */
149         //u8 unused[WIM_UNUSED_LEN];
150 };
151
152 /* Flags for the `flags' field of the struct wim_header: */
153
154 /* Reserved for future use */
155 #define WIM_HDR_FLAG_RESERVED           0x00000001
156
157 /* Files and metadata in the WIM are compressed. */
158 #define WIM_HDR_FLAG_COMPRESSION        0x00000002
159
160 /* WIM is read-only (wimlib ignores this because it's pretty much pointless) */
161 #define WIM_HDR_FLAG_READONLY           0x00000004
162
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
166
167 /* The WIM contains resources only; no filesystem metadata.  wimlib ignores this
168  * flag, as it looks for resources in all the WIMs anyway. */
169 #define WIM_HDR_FLAG_RESOURCE_ONLY      0x00000010
170
171 /* The WIM contains metadata only.  wimlib ignores 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
174
175 /* Lock field to prevent multiple writers from writing the WIM concurrently.
176  * wimlib ignores this flag as it uses flock() to acquire a real lock on the
177  * file (if supported by the underlying filesystem). */
178 #define WIM_HDR_FLAG_WRITE_IN_PROGRESS  0x00000040
179
180 /* Reparse point fixup ???
181  * This has something to do with absolute targets of reparse points / symbolic
182  * links but I don't know what.  wimlib ignores this flag.  */
183 #define WIM_HDR_FLAG_RP_FIX             0x00000080
184
185 /* Unused, reserved flag for another compression type */
186 #define WIM_HDR_FLAG_COMPRESS_RESERVED  0x00010000
187
188 /* Resources within the WIM are compressed using "XPRESS" compression, which is
189  * a LZ77-based compression algorithm. */
190 #define WIM_HDR_FLAG_COMPRESS_XPRESS    0x00020000
191
192 /* Resources within the WIM are compressed using "LZX" compression.  This is also
193  * a LZ77-based algorithm. */
194 #define WIM_HDR_FLAG_COMPRESS_LZX       0x00040000
195
196 #ifdef WITH_NTFS_3G
197 struct _ntfs_volume;
198 #endif
199
200 /* Structure for security data.  Each image in the WIM file has its own security
201  * data. */
202 struct wim_security_data {
203         /* The total length of the security data, in bytes.  If there are no
204          * security descriptors, this field may be either 8 (which is correct)
205          * or 0 (which is interpreted as 0). */
206         u32 total_length;
207
208         /* The number of security descriptors in the array @descriptors, below.
209          * It is really an unsigned int, but it must fit into an int because the
210          * security ID's are signed.  (Not like you would ever have more than a
211          * few hundred security descriptors anyway.) */
212         int32_t num_entries;
213
214         /* Array of sizes of the descriptors in the array @descriptors. */
215         u64 *sizes;
216
217         /* Array of descriptors. */
218         u8 **descriptors;
219
220         /* Keep track of how many WIMs reference this security data (used when
221          * exporting images between WIMs) */
222         u32 refcnt;
223 };
224
225 struct inode_table;
226
227 /* Metadata resource for an image. */
228 struct image_metadata {
229         /* Pointer to the root dentry for the image. */
230         struct dentry    *root_dentry;
231
232         /* Pointer to the security data for the image. */
233         struct wim_security_data *security_data;
234
235         /* A pointer to the lookup table entry for this image's metadata
236          * resource. */
237         struct lookup_table_entry *metadata_lte;
238
239         /* Linked list of inodes for this image. */
240         struct hlist_head inode_list;
241
242         /* True iff the dentry tree has been modified.  If this is the case, the
243          * memory for the dentry tree is not freed when switching to a different
244          * WIM image. */
245         u8 modified : 1;
246
247         /* True iff this image has been mounted read-write. */
248         u8 has_been_mounted_rw : 1;
249 };
250
251 /* The opaque structure exposed to the wimlib API. */
252 struct WIMStruct {
253
254         /* A pointer to the file indicated by @filename, opened for reading. */
255         FILE *fp;
256
257 #ifdef WITH_FUSE
258         /* Extra file pointers to be used by concurrent readers */
259         FILE **fp_tab;
260         size_t num_allocated_fps;
261         pthread_mutex_t fp_tab_mutex;
262 #endif
263
264         /* FILE pointer for the WIM file (if any) currently being written. */
265         FILE *out_fp;
266
267         /* The name of the WIM file that has been opened. */
268         char *filename;
269
270         /* The lookup table for the WIM file. */
271         struct lookup_table *lookup_table;
272
273         /* Pointer to the XML data read from the WIM file. */
274         u8 *xml_data;
275
276         /* Information retrieved from the XML data, arranged in an orderly
277          * manner. */
278         struct wim_info *wim_info;
279
280         /* Array of the image metadata, one for each image in the WIM. */
281         struct image_metadata *image_metadata;
282
283         /* The header of the WIM file. */
284         struct wim_header hdr;
285
286         /* Temporary fields */
287         union {
288                 bool write_metadata;
289                 void *private;
290         };
291 #ifdef WITH_NTFS_3G
292         struct _ntfs_volume *ntfs_vol;
293 #endif
294
295         /* The currently selected image, indexed starting at 1.  If not 0,
296          * subtract 1 from this to get the index of the current image in the
297          * image_metadata array. */
298         int current_image;
299
300         u8 deletion_occurred : 1;
301         u8 all_images_verified : 1;
302         u8 full_verification_in_progress : 1;
303 };
304
305 /* Inline utility functions for WIMStructs. */
306
307 static inline struct dentry *wim_root_dentry(WIMStruct *w)
308 {
309         return w->image_metadata[w->current_image - 1].root_dentry;
310 }
311
312 static inline struct wim_security_data *
313 wim_security_data(WIMStruct *w)
314 {
315         return w->image_metadata[w->current_image - 1].security_data;
316 }
317 static inline const struct wim_security_data *
318 wim_const_security_data(const WIMStruct *w)
319 {
320         return w->image_metadata[w->current_image - 1].security_data;
321 }
322
323 static inline struct image_metadata *
324 wim_get_current_image_metadata(WIMStruct *w)
325 {
326         return &w->image_metadata[w->current_image - 1];
327 }
328
329 /* Nonzero if a struct resource_entry indicates a compressed resource. */
330 static inline int resource_is_compressed(const struct resource_entry *entry)
331 {
332         return (entry->flags & WIM_RESHDR_FLAG_COMPRESSED);
333 }
334
335 /* add_image.c */
336
337 struct pattern_list {
338         const char **pats;
339         size_t num_pats;
340         size_t num_allocated_pats;
341 };
342
343 struct capture_config {
344         struct pattern_list exclusion_list;
345         struct pattern_list exclusion_exception;
346         struct pattern_list compression_exclusion_list;
347         struct pattern_list alignment_list;
348         char *config_str;
349         char *prefix;
350         size_t prefix_len;
351 };
352 extern bool exclude_path(const char *path,
353                          const struct capture_config *config,
354                          bool exclude_prefix);
355 extern int add_new_dentry_tree(WIMStruct *dest_wim, struct dentry *root,
356                                struct wim_security_data *sd);
357
358 /* extract_image.c */
359
360 /* Internal use only */
361 #define WIMLIB_EXTRACT_FLAG_MULTI_IMAGE         0x80000000
362 #define WIMLIB_EXTRACT_FLAG_NO_STREAMS          0x40000000
363 #define WIMLIB_EXTRACT_MASK_PUBLIC              0x3fffffff
364
365 /* hardlink.c */
366
367 extern u64 assign_inode_numbers(struct hlist_head *inode_list);
368
369 extern int dentry_tree_fix_inodes(struct dentry *root,
370                                   struct hlist_head *inode_list);
371
372 /* header.c */
373 extern int read_header(FILE *fp, struct wim_header *hdr, int split_ok);
374 extern int write_header(const struct wim_header *hdr, FILE *out);
375 extern int init_header(struct wim_header *hdr, int ctype);
376
377 /* integrity.c */
378
379 #define WIM_INTEGRITY_OK 0
380 #define WIM_INTEGRITY_NOT_OK -1
381 #define WIM_INTEGRITY_NONEXISTENT -2
382
383 extern int write_integrity_table(FILE *out,
384                                  struct resource_entry *integrity_res_entry,
385                                  off_t new_lookup_table_end,
386                                  off_t old_lookup_table_end,
387                                  wimlib_progress_func_t progress_func);
388
389 extern int check_wim_integrity(WIMStruct *w,
390                                wimlib_progress_func_t progress_func);
391
392 /* join.c */
393
394 extern int new_joined_lookup_table(WIMStruct *w,
395                                    WIMStruct **additional_swms,
396                                    unsigned num_additional_swms,
397                                    struct lookup_table **table_ret);
398
399 /* ntfs-apply.c */
400
401 struct apply_args {
402         WIMStruct *w;
403         const char *target;
404         int extract_flags;
405         unsigned num_lutimes_warnings;
406         struct list_head *stream_list;
407         union wimlib_progress_info progress;
408 #ifdef WITH_NTFS_3G
409         struct _ntfs_volume *vol;
410 #endif
411         struct list_head empty_files;
412         wimlib_progress_func_t progress_func;
413 };
414
415 extern int apply_dentry_ntfs(struct dentry *dentry, void *arg);
416 extern int apply_dentry_timestamps_ntfs(struct dentry *dentry, void *arg);
417
418 /* ntfs-capture.c */
419 extern int build_dentry_tree_ntfs(struct dentry **root_p,
420                                   const char *device,
421                                   struct lookup_table *lookup_table,
422                                   struct wim_security_data *sd,
423                                   const struct capture_config *config,
424                                   int add_image_flags,
425                                   wimlib_progress_func_t progress_func,
426                                   void *extra_arg);
427
428 /* resource.c */
429
430 #define WIMLIB_RESOURCE_FLAG_RAW                0x1
431 #define WIMLIB_RESOURCE_FLAG_MULTITHREADED      0x2
432 #define WIMLIB_RESOURCE_FLAG_RECOMPRESS         0x4
433
434 extern const u8 *get_resource_entry(const u8 *p, struct resource_entry *entry);
435 extern u8 *put_resource_entry(u8 *p, const struct resource_entry *entry);
436
437 extern int read_uncompressed_resource(FILE *fp, u64 offset, u64 size, u8 buf[]);
438
439 extern int read_wim_resource(const struct lookup_table_entry *lte, u8 buf[],
440                              size_t size, u64 offset, int flags);
441
442 extern int read_full_wim_resource(const struct lookup_table_entry *lte,
443                                   u8 buf[], int flags);
444
445 extern int write_wim_resource(struct lookup_table_entry *lte,
446                               FILE *out_fp, int out_ctype,
447                               struct resource_entry *out_res_entry,
448                               int flags);
449
450 extern int extract_wim_resource_to_fd(const struct lookup_table_entry *lte,
451                                       int fd, u64 size);
452
453
454 extern int extract_full_wim_resource_to_fd(const struct lookup_table_entry *lte,
455                                            int fd);
456
457 extern int read_metadata_resource(WIMStruct *w,
458                                   struct image_metadata *image_metadata);
459
460
461 extern int write_dentry_resources(struct dentry *dentry, void *wim_p);
462 extern int copy_resource(struct lookup_table_entry *lte, void *w);
463 extern int write_metadata_resource(WIMStruct *w);
464
465
466 /* security.c */
467 extern int read_security_data(const u8 metadata_resource[],
468                               u64 metadata_resource_len,
469                               struct wim_security_data **sd_p);
470 extern void print_security_data(const struct wim_security_data *sd);
471 extern u8 *write_security_data(const struct wim_security_data *sd, u8 *p);
472 extern void free_security_data(struct wim_security_data *sd);
473
474 /* symlink.c */
475 ssize_t inode_readlink(const struct inode *inode, char *buf, size_t buf_len,
476                         const WIMStruct *w, int read_resource_flags);
477 extern int inode_set_symlink(struct inode *inode,
478                              const char *target,
479                              struct lookup_table *lookup_table,
480                              struct lookup_table_entry **lte_ret);
481
482 /* verify.c */
483 extern int verify_dentry(struct dentry *dentry, void *wim);
484 extern int wim_run_full_verifications(WIMStruct *w);
485 extern int verify_swm_set(WIMStruct *w,
486                           WIMStruct **additional_swms,
487                           unsigned num_additional_swms);
488
489 /* wim.c */
490 extern int select_wim_image(WIMStruct *w, int image);
491 extern int for_image(WIMStruct *w, int image, int (*visitor)(WIMStruct *));
492 extern void destroy_image_metadata(struct image_metadata *imd,
493                                    struct lookup_table *lt);
494
495
496 /* write.c */
497
498 /* Internal use only */
499 #define WIMLIB_WRITE_FLAG_NO_LOOKUP_TABLE       0x80000000
500 #define WIMLIB_WRITE_FLAG_REUSE_INTEGRITY_TABLE 0x40000000
501 #define WIMLIB_WRITE_FLAG_CHECKPOINT_AFTER_XML  0x20000000
502 #define WIMLIB_WRITE_MASK_PUBLIC                0x1fffffff
503
504 extern int begin_write(WIMStruct *w, const char *path, int write_flags);
505 extern void close_wim_writable(WIMStruct *w);
506
507 extern int finish_write(WIMStruct *w, int image, int write_flags,
508                         wimlib_progress_func_t progress_func);
509
510 #if defined(HAVE_SYS_FILE_H) && defined(HAVE_FLOCK)
511 extern int lock_wim(FILE *fp, const char *path);
512 #else
513 static inline int lock_wim(FILE *fp, const char *path)
514 {
515         return 0;
516 }
517 #endif
518
519 #endif /* _WIMLIB_INTERNAL_H */
520