29c5ea6bf2f9284df8b6cf6269e673473795a3a7
[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 ???
201  * This has something to do with absolute targets of reparse points / symbolic
202  * links but I don't know what.  wimlib ignores this flag.  */
203 #define WIM_HDR_FLAG_RP_FIX             0x00000080
204
205 /* Unused, reserved flag for another compression type */
206 #define WIM_HDR_FLAG_COMPRESS_RESERVED  0x00010000
207
208 /* Resources within the WIM are compressed using "XPRESS" compression, which is
209  * a LZ77-based compression algorithm. */
210 #define WIM_HDR_FLAG_COMPRESS_XPRESS    0x00020000
211
212 /* Resources within the WIM are compressed using "LZX" compression.  This is also
213  * a LZ77-based algorithm. */
214 #define WIM_HDR_FLAG_COMPRESS_LZX       0x00040000
215
216 #ifdef WITH_NTFS_3G
217 struct _ntfs_volume;
218 #endif
219
220 /* Table of security descriptors for a WIM image. */
221 struct wim_security_data {
222         /* The total length of the security data, in bytes.  If there are no
223          * security descriptors, this field, when read from the on-disk metadata
224          * resource, may be either 8 (which is correct) or 0 (which is
225          * interpreted as 0). */
226         u32 total_length;
227
228         /* The number of security descriptors in the array @descriptors, below.
229          * It is really an unsigned int on-disk, but it must fit into an int
230          * because the security ID's are signed.  (Not like you would ever have
231          * more than a few hundred security descriptors anyway.) */
232         int32_t num_entries;
233
234         /* Array of sizes of the descriptors in the array @descriptors. */
235         u64 *sizes;
236
237         /* Array of descriptors. */
238         u8 **descriptors;
239 };
240
241 /* Metadata for a WIM image */
242 struct wim_image_metadata {
243
244         /* Number of WIMStruct's that are sharing this image metadata (from
245          * calls to wimlib_export_image().) */
246         unsigned long refcnt;
247
248         /* Pointer to the root dentry of the image. */
249         struct wim_dentry *root_dentry;
250
251         /* Pointer to the security data of the image. */
252         struct wim_security_data *security_data;
253
254         /* Pointer to the lookup table entry for this image's metadata resource
255          */
256         struct wim_lookup_table_entry *metadata_lte;
257
258         /* Linked list of 'struct wim_inode's for this image. */
259         struct list_head inode_list;
260
261         /* Linked list of 'struct wim_lookup_table_entry's for this image that
262          * are referred to in the dentry tree, but have not had a SHA1 message
263          * digest calculated yet and therefore have not been inserted into the
264          * WIM's lookup table.  This list is added to during wimlib_add_image()
265          * and wimlib_mount_image() (read-write only). */
266         struct list_head unhashed_streams;
267
268         /* 1 iff the dentry tree has been modified.  If this is the case, the
269          * memory for the dentry tree should not be freed when switching to a
270          * different WIM image. */
271         u8 modified : 1;
272
273 #ifdef WITH_NTFS_3G
274         struct _ntfs_volume *ntfs_vol;
275 #endif
276 };
277
278 /* The opaque structure exposed to the wimlib API. */
279 struct WIMStruct {
280
281         /* A pointer to the file indicated by @filename, opened for reading. */
282         FILE *fp;
283
284 #if defined(WITH_FUSE) || defined(ENABLE_MULTITHREADED_COMPRESSION)
285         /* Extra file pointers to be used by concurrent readers */
286         FILE **fp_tab;
287         size_t num_allocated_fps;
288         pthread_mutex_t fp_tab_mutex;
289 #endif
290
291         /* FILE pointer for the WIM file (if any) currently being written. */
292         FILE *out_fp;
293
294         /* The name of the WIM file (if any) that has been opened. */
295         tchar *filename;
296
297         /* The lookup table for the WIM file. */
298         struct wim_lookup_table *lookup_table;
299
300         /* Information retrieved from the XML data, arranged in an orderly
301          * manner. */
302         struct wim_info *wim_info;
303
304         /* Array of the image metadata, one for each image in the WIM. */
305         struct wim_image_metadata **image_metadata;
306
307         /* The header of the WIM file. */
308         struct wim_header hdr;
309
310         /* Temporary field */
311         void *private;
312
313         /* The currently selected image, indexed starting at 1.  If not 0,
314          * subtract 1 from this to get the index of the current image in the
315          * image_metadata array. */
316         int current_image;
317
318         u8 deletion_occurred : 1;
319         u8 all_images_verified : 1;
320         u8 wim_locked : 1;
321 };
322
323 /* Inline utility functions for WIMStructs. */
324
325 static inline struct wim_image_metadata *
326 wim_get_current_image_metadata(WIMStruct *w)
327 {
328         return w->image_metadata[w->current_image - 1];
329 }
330
331 static inline const struct wim_image_metadata *
332 wim_get_const_current_image_metadata(const WIMStruct *w)
333 {
334         return w->image_metadata[w->current_image - 1];
335 }
336
337 static inline struct wim_dentry *
338 wim_root_dentry(WIMStruct *w)
339 {
340         return wim_get_current_image_metadata(w)->root_dentry;
341 }
342
343 static inline struct wim_security_data *
344 wim_security_data(WIMStruct *w)
345 {
346         return wim_get_current_image_metadata(w)->security_data;
347 }
348
349 static inline const struct wim_security_data *
350 wim_const_security_data(const WIMStruct *w)
351 {
352         return wim_get_const_current_image_metadata(w)->security_data;
353 }
354
355 /* Nonzero if a struct resource_entry indicates a compressed resource. */
356 static inline int
357 resource_is_compressed(const struct resource_entry *entry)
358 {
359         return (entry->flags & WIM_RESHDR_FLAG_COMPRESSED);
360 }
361
362 /* Iterate over each inode in a WIM image that has not yet been hashed */
363 #define image_for_each_inode(inode, imd) \
364         list_for_each_entry(inode, &imd->inode_list, i_list)
365
366 /* Iterate over each stream in a WIM image that has not yet been hashed */
367 #define image_for_each_unhashed_stream(lte, imd) \
368         list_for_each_entry(lte, &imd->unhashed_streams, unhashed_list)
369
370 /* Iterate over each stream in a WIM image that has not yet been hashed (safe
371  * against stream removal) */
372 #define image_for_each_unhashed_stream_safe(lte, tmp, imd) \
373         list_for_each_entry_safe(lte, tmp, &imd->unhashed_streams, unhashed_list)
374
375 #if 1
376 #  define copy_resource_entry(dst, src) memcpy(dst, src, sizeof(struct resource_entry))
377 #  define zero_resource_entry(entry) memset(entry, 0, sizeof(struct resource_entry))
378 #else
379 static inline void
380 copy_resource_entry(struct resource_entry *dst,
381                     const struct resource_entry *src)
382 {
383         BUILD_BUG_ON(sizeof(struct resource_entry) != 24);
384         ((u64*)dst)[0] = ((u64*)src)[0];
385         ((u64*)dst)[1] = ((u64*)src)[1];
386         ((u64*)dst)[2] = ((u64*)src)[2];
387 }
388
389 static inline void
390 zero_resource_entry(struct resource_entry *entry)
391 {
392         BUILD_BUG_ON(sizeof(struct resource_entry) != 24);
393         ((u64*)entry)[0] = 0;
394         ((u64*)entry)[1] = 0;
395         ((u64*)entry)[2] = 0;
396 }
397 #endif
398
399 /* add_image.c */
400
401 extern bool
402 exclude_path(const tchar *path, size_t path_len,
403              const struct wimlib_capture_config *config,
404              bool exclude_prefix);
405
406 /* extract_image.c */
407
408 /* Internal use only */
409 #define WIMLIB_EXTRACT_FLAG_MULTI_IMAGE         0x80000000
410 #define WIMLIB_EXTRACT_FLAG_NO_STREAMS          0x40000000
411 #define WIMLIB_EXTRACT_MASK_PUBLIC              0x3fffffff
412
413 /* hardlink.c */
414
415 /* Hash table to find inodes, given an inode number (in the case of reading
416  * a WIM images), or both an inode number and a device number (in the case of
417  * capturing a WIM image). */
418 struct wim_inode_table {
419         /* Fields for the hash table */
420         struct hlist_head *array;
421         u64 num_entries;
422         u64 capacity;
423
424         /*
425          * Linked list of "extra" inodes.  These may be:
426          *
427          * - inodes with link count 1, which are all allowed to have 0 for their
428          *   inode number, meaning we cannot insert them into the hash table.
429          *
430          * - Groups we create ourselves by splitting a nominal inode due to
431          *   inconsistencies in the dentries.  These inodes will share an inode
432          *   number with some other inode until assign_inode_numbers() is
433          *   called.
434          */
435         struct list_head extra_inodes;
436 };
437
438 extern int
439 init_inode_table(struct wim_inode_table *table, size_t capacity);
440
441 extern int
442 inode_table_new_dentry(struct wim_inode_table *table, const tchar *name,
443                        u64 ino, u64 devno, struct wim_dentry **dentry_ret);
444
445 extern void
446 inode_ref_streams(struct wim_inode *inode);
447
448 extern void
449 inode_table_prepare_inode_list(struct wim_inode_table *table,
450                                struct list_head *head);
451
452 static inline void
453 destroy_inode_table(struct wim_inode_table *table)
454 {
455         FREE(table->array);
456 }
457
458
459 extern int
460 dentry_tree_fix_inodes(struct wim_dentry *root, struct list_head *inode_list);
461
462 /* header.c */
463
464 extern int
465 read_header(FILE *fp, struct wim_header *hdr, int split_ok);
466
467 extern int
468 write_header(const struct wim_header *hdr, FILE *out);
469
470 extern int
471 init_header(struct wim_header *hdr, int ctype);
472
473 /* integrity.c */
474
475 #define WIM_INTEGRITY_OK 0
476 #define WIM_INTEGRITY_NOT_OK -1
477 #define WIM_INTEGRITY_NONEXISTENT -2
478
479 extern int
480 write_integrity_table(FILE *out, struct resource_entry *integrity_res_entry,
481                       off_t new_lookup_table_end,
482                       off_t old_lookup_table_end,
483                       wimlib_progress_func_t progress_func);
484
485 extern int
486 check_wim_integrity(WIMStruct *w, wimlib_progress_func_t progress_func);
487
488 /* join.c */
489
490 extern int
491 new_joined_lookup_table(WIMStruct *w, WIMStruct **additional_swms,
492                         unsigned num_additional_swms,
493                         struct wim_lookup_table **table_ret);
494
495 /* metadata_resource.c */
496
497 extern int
498 read_metadata_resource(WIMStruct *w,
499                                   struct wim_image_metadata *image_metadata);
500
501 extern int
502 write_metadata_resource(WIMStruct *w);
503
504 /* ntfs-apply.c */
505
506 struct apply_args {
507         WIMStruct *w;
508         const tchar *target;
509         int extract_flags;
510         union wimlib_progress_info progress;
511         wimlib_progress_func_t progress_func;
512         int (*apply_dentry)(struct wim_dentry *, void *);
513         union {
514         #ifdef WITH_NTFS_3G
515                 struct {
516                         /* NTFS apply only */
517                         struct _ntfs_volume *vol;
518                 };
519         #endif
520                 struct {
521                         /* Normal apply only (UNIX) */
522                         unsigned long num_utime_warnings;
523                 };
524
525                 struct {
526                         /* Normal apply only (Win32) */
527                         unsigned long num_set_sacl_priv_notheld;
528                         unsigned long num_set_sd_access_denied;
529                         unsigned vol_flags;
530                         bool have_vol_flags;
531                 };
532         };
533 };
534
535 extern int
536 apply_dentry_ntfs(struct wim_dentry *dentry, void *arg);
537
538 extern int
539 apply_dentry_timestamps_ntfs(struct wim_dentry *dentry, void *arg);
540
541 extern void
542 libntfs3g_global_init();
543
544 /* ntfs-capture.c */
545
546 typedef int (*consume_data_callback_t)(const void *buf, size_t len, void *ctx);
547
548 extern int
549 read_ntfs_file_prefix(const struct wim_lookup_table_entry *lte,
550                       u64 size,
551                       consume_data_callback_t cb,
552                       void *ctx_or_buf,
553                       int _ignored_flags);
554 extern int
555 build_dentry_tree_ntfs(struct wim_dentry **root_p,
556                        const tchar *device,
557                        struct wim_lookup_table *lookup_table,
558                        struct wim_inode_table *inode_table,
559                        struct sd_set *sd_set,
560                        const struct wimlib_capture_config *config,
561                        int add_image_flags,
562                        wimlib_progress_func_t progress_func,
563                        void *extra_arg);
564
565 #ifdef WITH_NTFS_3G
566 extern int
567 do_ntfs_umount(struct _ntfs_volume *vol);
568 #endif
569
570 /* resource.c */
571
572 #define WIMLIB_RESOURCE_FLAG_RAW                0x1
573 #define WIMLIB_RESOURCE_FLAG_THREADSAFE_READ    0x2
574 #define WIMLIB_RESOURCE_FLAG_RECOMPRESS         0x4
575
576 extern int
577 read_resource_prefix(const struct wim_lookup_table_entry *lte,
578                      u64 size, consume_data_callback_t cb, void *ctx_or_buf,
579                      int flags);
580
581 extern const void *
582 get_resource_entry(const void *p, struct resource_entry *entry);
583
584 extern void *
585 put_resource_entry(void *p, const struct resource_entry *entry);
586
587 extern int
588 read_uncompressed_resource(FILE *fp, u64 offset, u64 size, void *buf);
589
590 extern int
591 read_partial_wim_resource_into_buf(const struct wim_lookup_table_entry *lte,
592                                    size_t size, u64 offset, void *buf,
593                                    bool threadsafe);
594 extern int
595 read_full_resource_into_buf(const struct wim_lookup_table_entry *lte,
596                             void *buf, bool thread_safe);
597
598 extern int
599 write_wim_resource(struct wim_lookup_table_entry *lte, FILE *out_fp,
600                    int out_ctype, struct resource_entry *out_res_entry,
601                    int flags);
602
603 extern int
604 extract_wim_resource(const struct wim_lookup_table_entry *lte,
605                      u64 size,
606                      consume_data_callback_t extract_chunk,
607                      void *extract_chunk_arg);
608
609 extern int
610 extract_wim_resource_to_fd(const struct wim_lookup_table_entry *lte,
611                            int fd, u64 size);
612
613 extern int
614 sha1_resource(struct wim_lookup_table_entry *lte);
615
616 extern int
617 copy_resource(struct wim_lookup_table_entry *lte, void *w);
618
619 /* security.c */
620 extern int
621 read_security_data(const u8 metadata_resource[],
622                    u64 metadata_resource_len, struct wim_security_data **sd_p);
623 extern void
624 print_security_data(const struct wim_security_data *sd);
625
626 extern u8 *
627 write_security_data(const struct wim_security_data *sd, u8 *p);
628
629 extern void
630 free_security_data(struct wim_security_data *sd);
631
632 /* symlink.c */
633
634 #ifndef __WIN32__
635 ssize_t
636 inode_readlink(const struct wim_inode *inode, char *buf, size_t buf_len,
637                const WIMStruct *w, bool threadsafe);
638
639 extern int
640 inode_set_symlink(struct wim_inode *inode, const char *target,
641                   struct wim_lookup_table *lookup_table,
642                   struct wim_lookup_table_entry **lte_ret);
643 #endif
644
645 /* verify.c */
646
647 extern int
648 verify_dentry(struct wim_dentry *dentry, void *wim);
649
650 extern int
651 wim_run_full_verifications(WIMStruct *w);
652
653 extern int
654 verify_swm_set(WIMStruct *w,
655                WIMStruct **additional_swms, unsigned num_additional_swms);
656
657 /* wim.c */
658
659 extern int
660 select_wim_image(WIMStruct *w, int image);
661
662 extern int
663 for_image(WIMStruct *w, int image, int (*visitor)(WIMStruct *));
664
665 extern void
666 destroy_image_metadata(struct wim_image_metadata *imd,
667                        struct wim_lookup_table *table,
668                        bool free_metadata_lte);
669
670 extern void
671 put_image_metadata(struct wim_image_metadata *imd,
672                    struct wim_lookup_table *table);
673
674 extern int
675 append_image_metadata(WIMStruct *w, struct wim_image_metadata *imd);
676
677 extern struct wim_image_metadata *
678 new_image_metadata();
679
680 extern struct wim_image_metadata **
681 new_image_metadata_array(unsigned num_images);
682
683 extern int
684 wim_checksum_unhashed_streams(WIMStruct *w);
685
686 /* write.c */
687
688 /* Internal use only */
689 #define WIMLIB_WRITE_FLAG_NO_LOOKUP_TABLE       0x80000000
690 #define WIMLIB_WRITE_FLAG_REUSE_INTEGRITY_TABLE 0x40000000
691 #define WIMLIB_WRITE_FLAG_CHECKPOINT_AFTER_XML  0x20000000
692 #define WIMLIB_WRITE_MASK_PUBLIC                0x1fffffff
693
694 /* We are capturing a tree to be placed in the root of the WIM image */
695 #define WIMLIB_ADD_IMAGE_FLAG_ROOT      0x80000000
696
697 /* We are capturing a dentry that will become the root of a tree to be added to
698  * the WIM image */
699 #define WIMLIB_ADD_IMAGE_FLAG_SOURCE    0x40000000
700
701 extern int
702 begin_write(WIMStruct *w, const tchar *path, int write_flags);
703
704 extern void
705 close_wim_writable(WIMStruct *w);
706
707 extern int
708 finish_write(WIMStruct *w, int image, int write_flags,
709              wimlib_progress_func_t progress_func);
710
711 #if defined(HAVE_SYS_FILE_H) && defined(HAVE_FLOCK)
712 extern int
713 lock_wim(WIMStruct *w, FILE *fp);
714 #else
715 static inline int
716 lock_wim(WIMStruct *w, FILE *fp)
717 {
718         return 0;
719 }
720 #endif
721
722 #endif /* _WIMLIB_INTERNAL_H */
723