1ddec8e3c84f38fcfdc36c562131fa95eecf50b0
[wimlib] / src / wimlib_internal.h
1 /*
2  * wimlib_internal.h
3  *
4  * Internal header for wimlib.
5  */
6
7 /*
8  * Copyright (C) 2012, 2013 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 #if defined(WITH_FUSE) || defined(ENABLE_MULTITHREADED_COMPRESSION)
35 #include <pthread.h>
36 #endif
37
38 #define WIMLIB_MAKEVERSION(major, minor, patch) \
39         ((major << 20) | (minor << 10) | patch)
40
41
42 #define WIMLIB_VERSION_CODE \
43                 WIMLIB_MAKEVERSION(WIMLIB_MAJOR_VERSION,\
44                                    WIMLIB_MINOR_VERSION,\
45                                    WIMLIB_PATCH_VERSION)
46
47 #define WIMLIB_GET_PATCH_VERSION(version) \
48         ((version >> 0) & ((1 << 10) - 1))
49 #define WIMLIB_GET_MINOR_VERSION(version) \
50         ((version >> 10) & ((1 << 10) - 1))
51 #define WIMLIB_GET_MAJOR_VERSION(version) \
52         ((version >> 20) & ((1 << 10) - 1))
53
54
55 struct stat;
56 struct wim_dentry;
57 struct wim_inode;
58 struct sd_set;
59
60 #define WIM_MAGIC_LEN  8
61 #define WIM_GID_LEN    16
62 #define WIM_UNUSED_LEN 60
63
64 /* Length of the WIM header on disk. */
65 #define WIM_HEADER_DISK_SIZE (148 + WIM_UNUSED_LEN)
66
67 /* Compressed resources in the WIM are divided into separated compressed chunks
68  * of this size. */
69 #define WIM_CHUNK_SIZE 32768
70
71 /* Version of the WIM file.  There is an older version, but we don't support it
72  * yet.  The differences between the versions are undocumented. */
73 #define WIM_VERSION 0x10d00
74
75 #define REPARSE_POINT_MAX_SIZE (16 * 1024)
76
77 /* Metadata for a resource in a WIM file. */
78 struct resource_entry {
79         /* Size, in bytes, of the resource in the WIM file. */
80         u64 size  : 56;
81
82         /* Bitwise or of one or more of the WIM_RESHDR_FLAG_* flags. */
83         u64 flags : 8;
84
85         /* Offset, in bytes, of the resource in the WIM file. */
86         u64 offset;
87
88         /* Uncompressed size of the resource in the WIM file.  Is the same as
89          * @size if the resource is uncompressed. */
90         u64 original_size;
91 };
92
93 /* Flags for the `flags' field of the struct resource_entry structure. */
94
95 /* I haven't seen this flag used in any of the WIMs I have examined.  I assume
96  * it means that there are no references to the stream, so the space is free.
97  * However, even after deleting files from a WIM mounted with `imagex.exe
98  * /mountrw', I could not see this flag being used.  Either way, we don't
99  * actually use this flag for anything. */
100 #define WIM_RESHDR_FLAG_FREE            0x01
101
102 /* Indicates that the stream is a metadata resource for a WIM image. */
103 #define WIM_RESHDR_FLAG_METADATA        0x02
104
105 /* Indicates that the stream is compressed. */
106 #define WIM_RESHDR_FLAG_COMPRESSED      0x04
107
108 /* I haven't seen this flag used in any of the WIMs I have examined.  Perhaps it
109  * means that a stream could possibly be split among multiple split WIM parts.
110  * However, `imagex.exe /split' does not seem to create any WIMs like this.
111  * Either way, we don't actually use this flag for anything.  */
112 #define WIM_RESHDR_FLAG_SPANNED         0x08
113
114 /* Header at the very beginning of the WIM file. */
115 struct wim_header {
116         /* Identifies the file as WIM file. Must be exactly
117          * {'M', 'S', 'W', 'I', 'M', 0, 0, 0}  */
118         //u8  magic[WIM_MAGIC_LEN];
119
120         /* size of WIM header in bytes. */
121         //u32 hdr_size;
122
123         /* Version of the WIM file.  Microsoft provides no documentation about
124          * exactly what this field affects about the file format, other than the
125          * fact that more recent versions have a higher value. */
126         //u32 version;
127
128         /* Bitwise OR of one or more of the WIM_HDR_FLAG_* defined below. */
129         u32 flags;
130
131         /* The size of the pieces that the uncompressed files were split up into
132          * when they were compressed.  This should be the same as
133          * WIM_CHUNK_SIZE.  Microsoft incorrectly documents this as "the size of
134          * the compressed .wim file in bytes".*/
135         //u32 chunk_size;
136
137         /* A unique identifier for the WIM file. */
138         u8 guid[WIM_GID_LEN];
139
140         /* Part number of the WIM file in a spanned set. */
141         u16 part_number;
142
143         /* Total number of parts in a spanned set. */
144         u16 total_parts;
145
146         /* Number of images in the WIM file. */
147         u32 image_count;
148
149         /* Location, size, and flags of the lookup table of the WIM. */
150         struct resource_entry lookup_table_res_entry;
151
152         /* Location, size, and flags for the XML data of the WIM. */
153         struct resource_entry xml_res_entry;
154
155         /* Location, size, and flags for the boot metadata.  This means the
156          * metadata resource for the image specified by boot_idx below.  Should
157          * be zeroed out if boot_idx is 0. */
158         struct resource_entry boot_metadata_res_entry;
159
160         /* The index of the bootable image in the WIM file. If 0, there are no
161          * bootable images available. */
162         u32 boot_idx;
163
164         /* The location of the optional integrity table used to verify the
165          * integrity WIM.  Zeroed out if there is no integrity table.*/
166         struct resource_entry integrity;
167
168         /* Reserved for future disuse */
169         //u8 unused[WIM_UNUSED_LEN];
170 };
171
172 /* Flags for the `flags' field of the struct wim_header: */
173
174 /* Reserved for future use */
175 #define WIM_HDR_FLAG_RESERVED           0x00000001
176
177 /* Files and metadata in the WIM are compressed. */
178 #define WIM_HDR_FLAG_COMPRESSION        0x00000002
179
180 /* WIM is read-only (wimlib ignores this because it's pretty much pointless) */
181 #define WIM_HDR_FLAG_READONLY           0x00000004
182
183 /* Resource data specified by images in this WIM may be contained in a different
184  * WIM.  Or in other words, this WIM is part of a split WIM.  */
185 #define WIM_HDR_FLAG_SPANNED            0x00000008
186
187 /* The WIM contains resources only; no filesystem metadata.  wimlib ignores this
188  * flag, as it looks for resources in all the WIMs anyway. */
189 #define WIM_HDR_FLAG_RESOURCE_ONLY      0x00000010
190
191 /* The WIM contains metadata only.  wimlib ignores this flag.  Note that all the
192  * metadata resources for a split WIM should be in the first part. */
193 #define WIM_HDR_FLAG_METADATA_ONLY      0x00000020
194
195 /* Lock field to prevent multiple writers from writing the WIM concurrently.
196  * wimlib ignores this flag as it uses flock() to acquire a real lock on the
197  * file (if supported by the underlying filesystem). */
198 #define WIM_HDR_FLAG_WRITE_IN_PROGRESS  0x00000040
199
200 /* Reparse point fixup flag.  See docs for --rpfix and --norpfix in imagex, or
201  * WIMLIB_ADD_IMAGE_FLAG_{RPFIX,NORPFIX} in wimlib.h.  Note that
202  * WIM_HDR_FLAG_RP_FIX is a header flag and just sets the default behavior for
203  * the WIM; it can still be overridder on a per-image basis.  But there is no
204  * flag to set the default behavior for a specific image. */
205 #define WIM_HDR_FLAG_RP_FIX             0x00000080
206
207 /* Unused, reserved flag for another compression type */
208 #define WIM_HDR_FLAG_COMPRESS_RESERVED  0x00010000
209
210 /* Resources within the WIM are compressed using "XPRESS" compression, which is
211  * a LZ77-based compression algorithm. */
212 #define WIM_HDR_FLAG_COMPRESS_XPRESS    0x00020000
213
214 /* Resources within the WIM are compressed using "LZX" compression.  This is also
215  * a LZ77-based algorithm. */
216 #define WIM_HDR_FLAG_COMPRESS_LZX       0x00040000
217
218 #ifdef WITH_NTFS_3G
219 struct _ntfs_volume;
220 #endif
221
222 /* Table of security descriptors for a WIM image. */
223 struct wim_security_data {
224         /* The total length of the security data, in bytes.  If there are no
225          * security descriptors, this field, when read from the on-disk metadata
226          * resource, may be either 8 (which is correct) or 0 (which is
227          * interpreted as 0). */
228         u32 total_length;
229
230         /* The number of security descriptors in the array @descriptors, below.
231          * It is really an unsigned int on-disk, but it must fit into an int
232          * because the security ID's are signed.  (Not like you would ever have
233          * more than a few hundred security descriptors anyway.) */
234         int32_t num_entries;
235
236         /* Array of sizes of the descriptors in the array @descriptors. */
237         u64 *sizes;
238
239         /* Array of descriptors. */
240         u8 **descriptors;
241 };
242
243 /* Metadata for a WIM image */
244 struct wim_image_metadata {
245
246         /* Number of WIMStruct's that are sharing this image metadata (from
247          * calls to wimlib_export_image().) */
248         unsigned long refcnt;
249
250         /* Pointer to the root dentry of the image. */
251         struct wim_dentry *root_dentry;
252
253         /* Pointer to the security data of the image. */
254         struct wim_security_data *security_data;
255
256         /* Pointer to the lookup table entry for this image's metadata resource
257          */
258         struct wim_lookup_table_entry *metadata_lte;
259
260         /* Linked list of 'struct wim_inode's for this image. */
261         struct list_head inode_list;
262
263         /* Linked list of 'struct wim_lookup_table_entry's for this image that
264          * are referred to in the dentry tree, but have not had a SHA1 message
265          * digest calculated yet and therefore have not been inserted into the
266          * WIM's lookup table.  This list is added to during wimlib_add_image()
267          * and wimlib_mount_image() (read-write only). */
268         struct list_head unhashed_streams;
269
270         /* 1 iff the dentry tree has been modified.  If this is the case, the
271          * memory for the dentry tree should not be freed when switching to a
272          * different WIM image. */
273         u8 modified : 1;
274
275 #ifdef WITH_NTFS_3G
276         struct _ntfs_volume *ntfs_vol;
277 #endif
278 };
279
280 /* The opaque structure exposed to the wimlib API. */
281 struct WIMStruct {
282
283         /* File descriptor for the WIM file, opened for reading, or -1 if it has
284          * not been opened or there is no associated file backing it yet. */
285         int in_fd;
286
287         /* File descriptor, opened either for writing only or for
288          * reading+writing, for the WIM file (if any) currently being written.
289          * */
290         int out_fd;
291
292         /* The name of the WIM file (if any) that has been opened. */
293         tchar *filename;
294
295         /* The lookup table for the WIM file. */
296         struct wim_lookup_table *lookup_table;
297
298         /* Information retrieved from the XML data, arranged in an orderly
299          * manner. */
300         struct wim_info *wim_info;
301
302         /* Array of the image metadata, one for each image in the WIM. */
303         struct wim_image_metadata **image_metadata;
304
305         /* The header of the WIM file. */
306         struct wim_header hdr;
307
308         /* Temporary field */
309         void *private;
310
311         /* The currently selected image, indexed starting at 1.  If not 0,
312          * subtract 1 from this to get the index of the current image in the
313          * image_metadata array. */
314         int current_image;
315
316         u8 deletion_occurred : 1;
317         u8 all_images_verified : 1;
318         u8 wim_locked : 1;
319 };
320
321 /* Inline utility functions for WIMStructs. */
322
323 static inline struct wim_image_metadata *
324 wim_get_current_image_metadata(WIMStruct *w)
325 {
326         return w->image_metadata[w->current_image - 1];
327 }
328
329 static inline const struct wim_image_metadata *
330 wim_get_const_current_image_metadata(const WIMStruct *w)
331 {
332         return w->image_metadata[w->current_image - 1];
333 }
334
335 static inline struct wim_dentry *
336 wim_root_dentry(WIMStruct *w)
337 {
338         return wim_get_current_image_metadata(w)->root_dentry;
339 }
340
341 static inline struct wim_security_data *
342 wim_security_data(WIMStruct *w)
343 {
344         return wim_get_current_image_metadata(w)->security_data;
345 }
346
347 static inline const struct wim_security_data *
348 wim_const_security_data(const WIMStruct *w)
349 {
350         return wim_get_const_current_image_metadata(w)->security_data;
351 }
352
353 /* Nonzero if a struct resource_entry indicates a compressed resource. */
354 static inline int
355 resource_is_compressed(const struct resource_entry *entry)
356 {
357         return (entry->flags & WIM_RESHDR_FLAG_COMPRESSED);
358 }
359
360 /* Iterate over each inode in a WIM image that has not yet been hashed */
361 #define image_for_each_inode(inode, imd) \
362         list_for_each_entry(inode, &imd->inode_list, i_list)
363
364 /* Iterate over each stream in a WIM image that has not yet been hashed */
365 #define image_for_each_unhashed_stream(lte, imd) \
366         list_for_each_entry(lte, &imd->unhashed_streams, unhashed_list)
367
368 /* Iterate over each stream in a WIM image that has not yet been hashed (safe
369  * against stream removal) */
370 #define image_for_each_unhashed_stream_safe(lte, tmp, imd) \
371         list_for_each_entry_safe(lte, tmp, &imd->unhashed_streams, unhashed_list)
372
373 #if 1
374 #  define copy_resource_entry(dst, src) memcpy(dst, src, sizeof(struct resource_entry))
375 #  define zero_resource_entry(entry) memset(entry, 0, sizeof(struct resource_entry))
376 #else
377 static inline void
378 copy_resource_entry(struct resource_entry *dst,
379                     const struct resource_entry *src)
380 {
381         BUILD_BUG_ON(sizeof(struct resource_entry) != 24);
382         ((u64*)dst)[0] = ((u64*)src)[0];
383         ((u64*)dst)[1] = ((u64*)src)[1];
384         ((u64*)dst)[2] = ((u64*)src)[2];
385 }
386
387 static inline void
388 zero_resource_entry(struct resource_entry *entry)
389 {
390         BUILD_BUG_ON(sizeof(struct resource_entry) != 24);
391         ((u64*)entry)[0] = 0;
392         ((u64*)entry)[1] = 0;
393         ((u64*)entry)[2] = 0;
394 }
395 #endif
396
397 /* add_image.c */
398
399 /* Hash table to find inodes, given an inode number (in the case of reading
400  * a WIM images), or both an inode number and a device number (in the case of
401  * capturing a WIM image). */
402 struct wim_inode_table {
403         /* Fields for the hash table */
404         struct hlist_head *array;
405         u64 num_entries;
406         u64 capacity;
407
408         /*
409          * Linked list of "extra" inodes.  These may be:
410          *
411          * - inodes with link count 1, which are all allowed to have 0 for their
412          *   inode number, meaning we cannot insert them into the hash table.
413          *
414          * - Groups we create ourselves by splitting a nominal inode due to
415          *   inconsistencies in the dentries.  These inodes will share an inode
416          *   number with some other inode until assign_inode_numbers() is
417          *   called.
418          */
419         struct list_head extra_inodes;
420 };
421
422 /* Common parameters to implementations of building an in-memory dentry tree
423  * from an on-disk directory structure. */
424 struct add_image_params {
425         /* Pointer to the lookup table of the WIM. */
426         struct wim_lookup_table *lookup_table;
427
428         /* Pointer to a hash table of inodes that have been captured for this
429          * WIM image so far. */
430         struct wim_inode_table *inode_table;
431
432         /* Pointer to the set of security descriptors that have been captured
433          * for this image so far. */
434         struct sd_set *sd_set;
435
436         /* Pointer to the capture configuration, which indicates whether any
437          * files should be excluded from capture or not. */
438         const struct wimlib_capture_config *config;
439
440         /* Flags that affect the capture operation (WIMLIB_ADD_IMAGE_FLAG_*) */
441         int add_image_flags;
442
443         /* If non-NULL, the user-supplied progress function. */
444         wimlib_progress_func_t progress_func;
445
446         /* Extra argument; set to point to a pointer to the ntfs_volume for
447          * libntfs-3g capture.  */
448         void *extra_arg;
449
450         u64 capture_root_ino;
451         u64 capture_root_dev;
452 };
453
454 extern bool
455 exclude_path(const tchar *path, size_t path_len,
456              const struct wimlib_capture_config *config,
457              bool exclude_prefix);
458
459 /* extract_image.c */
460
461 /* Internal use only */
462 #define WIMLIB_EXTRACT_FLAG_MULTI_IMAGE         0x80000000
463 #define WIMLIB_EXTRACT_FLAG_NO_STREAMS          0x40000000
464 #define WIMLIB_EXTRACT_MASK_PUBLIC              0x3fffffff
465
466 /* hardlink.c */
467
468 extern int
469 init_inode_table(struct wim_inode_table *table, size_t capacity);
470
471 extern int
472 inode_table_new_dentry(struct wim_inode_table *table, const tchar *name,
473                        u64 ino, u64 devno, bool noshare,
474                        struct wim_dentry **dentry_ret);
475
476 extern void
477 inode_ref_streams(struct wim_inode *inode);
478
479 extern void
480 inode_table_prepare_inode_list(struct wim_inode_table *table,
481                                struct list_head *head);
482
483 static inline void
484 destroy_inode_table(struct wim_inode_table *table)
485 {
486         FREE(table->array);
487 }
488
489
490 extern int
491 dentry_tree_fix_inodes(struct wim_dentry *root, struct list_head *inode_list);
492
493 /* header.c */
494
495 extern int
496 read_header(const tchar *filename, int in_fd, struct wim_header *hdr,
497             int split_ok);
498
499 extern int
500 write_header(const struct wim_header *hdr, int out_fd);
501
502 extern int
503 init_header(struct wim_header *hdr, int ctype);
504
505 /* integrity.c */
506
507 #define WIM_INTEGRITY_OK 0
508 #define WIM_INTEGRITY_NOT_OK -1
509 #define WIM_INTEGRITY_NONEXISTENT -2
510
511 extern int
512 write_integrity_table(int fd,
513                       struct resource_entry *integrity_res_entry,
514                       off_t new_lookup_table_end,
515                       off_t old_lookup_table_end,
516                       wimlib_progress_func_t progress_func);
517
518 extern int
519 check_wim_integrity(WIMStruct *w, wimlib_progress_func_t progress_func);
520
521 /* join.c */
522
523 extern int
524 new_joined_lookup_table(WIMStruct *w, WIMStruct **additional_swms,
525                         unsigned num_additional_swms,
526                         struct wim_lookup_table **table_ret);
527
528 /* metadata_resource.c */
529
530 extern int
531 read_metadata_resource(WIMStruct *w,
532                                   struct wim_image_metadata *image_metadata);
533
534 extern int
535 write_metadata_resource(WIMStruct *w);
536
537 /* ntfs-apply.c */
538
539 struct apply_args {
540         WIMStruct *w;
541         const tchar *target;
542         unsigned target_nchars;
543         unsigned wim_source_path_nchars;
544         struct wim_dentry *extract_root;
545         tchar *target_realpath;
546         unsigned target_realpath_len;
547         int extract_flags;
548         union wimlib_progress_info progress;
549         wimlib_progress_func_t progress_func;
550         int (*apply_dentry)(struct wim_dentry *, void *);
551         union {
552         #ifdef WITH_NTFS_3G
553                 struct {
554                         /* NTFS apply only */
555                         struct _ntfs_volume *vol;
556                 };
557         #endif
558         #ifdef __WIN32__
559                 struct {
560                         /* Normal apply only (Win32) */
561                         unsigned long num_set_sacl_priv_notheld;
562                         unsigned long num_set_sd_access_denied;
563                         unsigned vol_flags;
564                         unsigned long num_hard_links_failed;
565                         unsigned long num_soft_links_failed;
566                         bool have_vol_flags;
567                 };
568         #else
569                 struct {
570                         /* Normal apply only (UNIX) */
571                         unsigned long num_utime_warnings;
572                 };
573         #endif
574         };
575 };
576
577 extern int
578 apply_dentry_ntfs(struct wim_dentry *dentry, void *arg);
579
580 extern int
581 apply_dentry_timestamps_ntfs(struct wim_dentry *dentry, void *arg);
582
583 extern void
584 libntfs3g_global_init();
585
586 /* ntfs-capture.c */
587
588 typedef int (*consume_data_callback_t)(const void *buf, size_t len, void *ctx);
589
590 extern int
591 read_ntfs_file_prefix(const struct wim_lookup_table_entry *lte,
592                       u64 size,
593                       consume_data_callback_t cb,
594                       void *ctx_or_buf,
595                       int _ignored_flags);
596 extern int
597 build_dentry_tree_ntfs(struct wim_dentry **root_p,
598                        const tchar *device,
599                        struct add_image_params *ctx);
600
601 #ifdef WITH_NTFS_3G
602 extern int
603 do_ntfs_umount(struct _ntfs_volume *vol);
604 #endif
605
606 /* reparse.c */
607
608 /* Structured format for symbolic link, junction point, or mount point reparse
609  * data. */
610 struct reparse_data {
611         /* Reparse point tag (see WIM_IO_REPARSE_TAG_* values) */
612         u32 rptag;
613
614         /* Length of reparse data, not including the 8-byte header (ReparseTag,
615          * ReparseDataLength, ReparseReserved) */
616         u16 rpdatalen;
617
618         /* ReparseReserved */
619         u16 rpreserved;
620
621         /* Flags (only for WIM_IO_REPARSE_TAG_SYMLINK reparse points).
622          * SYMBOLIC_LINK_RELATIVE means this is a relative symbolic link;
623          * otherwise should be set to 0. */
624 #define SYMBOLIC_LINK_RELATIVE 0x00000001
625         u32 rpflags;
626
627         /* Pointer to the substitute name of the link (UTF-16LE). */
628         utf16lechar *substitute_name;
629
630         /* Pointer to the print name of the link (UTF-16LE). */
631         utf16lechar *print_name;
632
633         /* Number of bytes of the substitute name, not including null terminator
634          * if present */
635         u16 substitute_name_nbytes;
636
637         /* Number of bytes of the print name, not including null terminator if
638          * present */
639         u16 print_name_nbytes;
640 };
641
642 enum {
643         SUBST_NAME_IS_RELATIVE_LINK = -1,
644         SUBST_NAME_IS_VOLUME_JUNCTION = -2,
645         SUBST_NAME_IS_UNKNOWN = -3,
646 };
647 extern int
648 parse_substitute_name(const utf16lechar *substitute_name,
649                       u16 substitute_name_nbytes,
650                       u32 rptag);
651
652 extern int
653 parse_reparse_data(const u8 *rpbuf, u16 rpbuflen, struct reparse_data *rpdata);
654
655 extern int
656 make_reparse_buffer(const struct reparse_data *rpdata, u8 *buf);
657
658 extern int
659 wim_inode_get_reparse_data(const struct wim_inode *inode, u8 *rpbuf);
660
661 #ifndef __WIN32__
662 ssize_t
663 wim_inode_readlink(const struct wim_inode *inode, char *buf, size_t buf_len);
664
665 extern int
666 wim_inode_set_symlink(struct wim_inode *inode, const char *target,
667                       struct wim_lookup_table *lookup_table);
668 #endif
669 extern tchar *
670 capture_fixup_absolute_symlink(tchar *dest,
671                                u64 capture_root_ino, u64 capture_root_dev);
672
673
674 /* resource.c */
675
676 #define WIMLIB_RESOURCE_FLAG_RAW                0x1
677 #define WIMLIB_RESOURCE_FLAG_RECOMPRESS         0x4
678
679 extern int
680 read_resource_prefix(const struct wim_lookup_table_entry *lte,
681                      u64 size, consume_data_callback_t cb, void *ctx_or_buf,
682                      int flags);
683
684 extern const void *
685 get_resource_entry(const void *p, struct resource_entry *entry);
686
687 extern void *
688 put_resource_entry(void *p, const struct resource_entry *entry);
689
690 extern int
691 read_partial_wim_resource_into_buf(const struct wim_lookup_table_entry *lte,
692                                    size_t size, u64 offset, void *buf);
693 extern int
694 read_full_resource_into_buf(const struct wim_lookup_table_entry *lte, void *buf);
695
696 extern int
697 write_wim_resource(struct wim_lookup_table_entry *lte, int out_fd,
698                    int out_ctype, struct resource_entry *out_res_entry,
699                    int flags);
700
701 extern int
702 extract_wim_resource(const struct wim_lookup_table_entry *lte,
703                      u64 size,
704                      consume_data_callback_t extract_chunk,
705                      void *extract_chunk_arg);
706
707 extern int
708 extract_wim_resource_to_fd(const struct wim_lookup_table_entry *lte,
709                            int fd, u64 size);
710
711 extern int
712 sha1_resource(struct wim_lookup_table_entry *lte);
713
714 extern int
715 copy_resource(struct wim_lookup_table_entry *lte, void *w);
716
717 /* security.c */
718 extern int
719 read_security_data(const u8 metadata_resource[],
720                    u64 metadata_resource_len, struct wim_security_data **sd_p);
721 extern void
722 print_security_data(const struct wim_security_data *sd);
723
724 extern u8 *
725 write_security_data(const struct wim_security_data *sd, u8 *p);
726
727 extern void
728 free_security_data(struct wim_security_data *sd);
729
730 /* verify.c */
731
732 extern int
733 verify_dentry(struct wim_dentry *dentry, void *wim);
734
735 extern int
736 wim_run_full_verifications(WIMStruct *w);
737
738 extern int
739 verify_swm_set(WIMStruct *w,
740                WIMStruct **additional_swms, unsigned num_additional_swms);
741
742 /* wim.c */
743
744 extern int
745 select_wim_image(WIMStruct *w, int image);
746
747 extern int
748 for_image(WIMStruct *w, int image, int (*visitor)(WIMStruct *));
749
750 extern void
751 destroy_image_metadata(struct wim_image_metadata *imd,
752                        struct wim_lookup_table *table,
753                        bool free_metadata_lte);
754
755 extern void
756 put_image_metadata(struct wim_image_metadata *imd,
757                    struct wim_lookup_table *table);
758
759 extern int
760 append_image_metadata(WIMStruct *w, struct wim_image_metadata *imd);
761
762 extern struct wim_image_metadata *
763 new_image_metadata();
764
765 extern struct wim_image_metadata **
766 new_image_metadata_array(unsigned num_images);
767
768 extern int
769 wim_checksum_unhashed_streams(WIMStruct *w);
770
771 extern int
772 reopen_wim(WIMStruct *w);
773
774 extern int
775 close_wim(WIMStruct *w);
776
777 /* write.c */
778
779 /* Internal use only */
780 #define WIMLIB_WRITE_FLAG_NO_LOOKUP_TABLE       0x80000000
781 #define WIMLIB_WRITE_FLAG_REUSE_INTEGRITY_TABLE 0x40000000
782 #define WIMLIB_WRITE_FLAG_CHECKPOINT_AFTER_XML  0x20000000
783 #define WIMLIB_WRITE_MASK_PUBLIC                0x1fffffff
784
785 /* We are capturing a tree to be placed in the root of the WIM image */
786 #define WIMLIB_ADD_IMAGE_FLAG_ROOT      0x80000000
787
788 /* We are capturing a dentry that will become the root of a tree to be added to
789  * the WIM image */
790 #define WIMLIB_ADD_IMAGE_FLAG_SOURCE    0x40000000
791
792 extern int
793 begin_write(WIMStruct *w, const tchar *path, int write_flags);
794
795 extern void
796 close_wim_writable(WIMStruct *w);
797
798 extern int
799 finish_write(WIMStruct *w, int image, int write_flags,
800              wimlib_progress_func_t progress_func);
801
802 #if defined(HAVE_SYS_FILE_H) && defined(HAVE_FLOCK)
803 extern int
804 lock_wim(WIMStruct *w, int fd);
805 #else
806 static inline int
807 lock_wim(WIMStruct *w, int fd)
808 {
809         return 0;
810 }
811 #endif
812
813 #endif /* _WIMLIB_INTERNAL_H */
814