5a04756ba2e3006a7ad5e6ea0d06132b1f499fc1
[wimlib] / include / wimlib / wim.h
1 #ifndef _WIMLIB_WIM_H
2 #define _WIMLIB_WIM_H
3
4 #include "wimlib/header.h"
5 #include "wimlib/types.h"
6 #include "wimlib/file_io.h"
7 #include "wimlib/list.h"
8
9 struct wim_info;
10 struct wim_lookup_table;
11 struct wim_image_metadata;
12
13 /* The opaque structure exposed to the wimlib API. */
14 struct WIMStruct {
15
16         /* File descriptor for the WIM file, opened for reading.  in_fd.fd is -1
17          * if the WIM file has not been opened or there is no associated file
18          * backing it yet. */
19         struct filedes in_fd;
20
21         /* File descriptor, opened either for writing only or for
22          * reading+writing, for the WIM file (if any) currently being written.
23          * */
24         struct filedes out_fd;
25
26         /* The name of the WIM file (if any) that has been opened. */
27         tchar *filename;
28
29         /* The lookup table for the WIM file. */
30         struct wim_lookup_table *lookup_table;
31
32         /* Information retrieved from the XML data, arranged in an orderly
33          * manner. */
34         struct wim_info *wim_info;
35
36         /* Array of the image metadata, one for each image in the WIM. */
37         struct wim_image_metadata **image_metadata;
38
39         /* The header of the WIM file. */
40         struct wim_header hdr;
41
42         /* Temporary field */
43         void *private;
44
45         struct list_head subwims;
46
47         struct list_head subwim_node;
48
49         /* The currently selected image, indexed starting at 1.  If not 0,
50          * subtract 1 from this to get the index of the current image in the
51          * image_metadata array. */
52         int current_image;
53
54         /* Have any images been deleted? */
55         u8 deletion_occurred : 1;
56
57         /* Do we know that all the stream reference counts in the WIM are
58          * correct?  If so, this is set to 1 and deletions are safe; otherwise
59          * this is set to 0 and deletions are not safe until reference counts
60          * are recalculated.  (This is due to a bug in M$'s software that
61          * generates WIMs with invalid reference counts.)  */
62         u8 refcnts_ok : 1;
63
64         u8 wim_locked : 1;
65
66         u8 being_unmerged : 1;
67
68         u8 guid_set_explicitly : 1;
69
70         /* One of WIMLIB_COMPRESSION_TYPE_*, cached from the header flags. */
71         u8 compression_type : 2;
72 };
73
74 static inline bool wim_is_pipable(const WIMStruct *wim)
75 {
76         return (wim->hdr.magic == PWM_MAGIC);
77 }
78
79 static inline bool wim_has_integrity_table(const WIMStruct *wim)
80 {
81         return (wim->hdr.integrity.offset != 0);
82 }
83
84 static inline bool wim_has_metadata(const WIMStruct *wim)
85 {
86         return (wim->image_metadata != NULL || wim->hdr.image_count == 0);
87 }
88
89 extern void
90 wim_recalculate_refcnts(WIMStruct *wim);
91
92 extern int
93 init_wim_header(struct wim_header *hdr, int ctype);
94
95 extern int
96 read_wim_header(const tchar *filename, struct filedes *in_fd,
97                 struct wim_header *hdr);
98
99 extern int
100 write_wim_header(const struct wim_header *hdr, struct filedes *out_fd);
101
102 extern int
103 write_wim_header_at_offset(const struct wim_header *hdr, struct filedes *out_fd,
104                            off_t offset);
105
106 extern int
107 write_wim_header_flags(u32 hdr_flags, struct filedes *out_fd);
108
109 extern int
110 rename_wim_path(WIMStruct *wim, const tchar *from, const tchar *to);
111
112 extern int
113 select_wim_image(WIMStruct *wim, int image);
114
115 extern int
116 for_image(WIMStruct *wim, int image, int (*visitor)(WIMStruct *));
117
118 extern int
119 wim_checksum_unhashed_streams(WIMStruct *wim);
120
121 extern int
122 reopen_wim(WIMStruct *wim);
123
124 /* Internal open flags (pass to open_wim_as_WIMStruct(), not wimlib_open_wim())
125  */
126 #define WIMLIB_OPEN_FLAG_FROM_PIPE      0x80000000
127 #define WIMLIB_OPEN_MASK_PUBLIC         0x7fffffff
128
129 extern int
130 open_wim_as_WIMStruct(const void *wim_filename_or_fd, int open_flags,
131                       WIMStruct **wim_ret,
132                       wimlib_progress_func_t progress_func);
133
134 extern int
135 close_wim(WIMStruct *wim);
136
137 extern int
138 can_modify_wim(WIMStruct *wim);
139
140 extern int
141 can_delete_from_wim(WIMStruct *wim);
142
143 #endif /* _WIMLIB_WIM_H */