Add extract_full_stream_to_fd()
[wimlib] / include / wimlib / resource.h
1 #ifndef _WIMLIB_RESOURCE_H
2 #define _WIMLIB_RESOURCE_H
3
4 #include "wimlib/callback.h"
5 #include "wimlib/file_io.h"
6 #include "wimlib/list.h"
7 #include "wimlib/sha1.h"
8 #include "wimlib/types.h"
9
10 struct wim_lookup_table_entry;
11 struct wim_image_metadata;
12
13 /* Specification of a resource in a WIM file.
14  *
15  * If a `struct wim_lookup_table_entry' lte has
16  * (lte->resource_location == RESOURCE_IN_WIM), then lte->wim_res_spec points to
17  * an instance of this structure.
18  *
19  * Normally, there is a one-to-one correspondence between WIM lookup table
20  * entries ("streams", each of which may be the contents of a file, for example)
21  * and WIM resources.  However, WIM resources with the
22  * WIM_RESHDR_FLAG_PACKED_STREAMS flag set may actually contain multiple streams
23  * compressed together.  */
24 struct wim_resource_spec {
25         /* The WIM containing this resource.  @wim->in_fd is expected to be a
26          * file descriptor to the underlying WIM file, opened for reading.  */
27         WIMStruct *wim;
28
29         /* The offset, in bytes, from the start of WIM file at which this
30          * resource starts.  */
31         u64 offset_in_wim;
32
33         /* The size of this resource in the WIM file.  For compressed resources
34          * this is the compressed size, including overhead such as the chunk
35          * table.  */
36         u64 size_in_wim;
37
38         /* The number of bytes of uncompressed data this resource decompresses
39          * to.  */
40         u64 uncompressed_size;
41
42         /* The list of streams this resource contains.  */
43         struct list_head stream_list;
44
45         /* Flags for this resource (WIM_RESHDR_FLAG_*).  */
46         u32 flags : 8;
47
48         /* [wimlib extension] This flag will be set if the WIM is pipable.  In
49          * such cases, the resource will be in a slightly different format if it
50          * is compressed.  */
51         u32 is_pipable : 1;
52
53         /* Temporary flag.  */
54         u32 raw_copy_ok : 1;
55 };
56
57 /* On-disk version of a WIM resource header.  */
58 struct wim_reshdr_disk {
59         /* Size of the resource as it appears in the WIM file (possibly
60          * compressed).  */
61         u8 size_in_wim[7];
62
63         /* Zero or more of the WIM_RESHDR_FLAG_* flags.  These indicate, for
64          * example, whether the resource is compressed or not.  */
65         u8 flags;
66
67         /* Offset of the resource from the start of the WIM file, in bytes.  */
68         le64 offset_in_wim;
69
70         /* Uncompressed size of the resource, in bytes.  */
71         le64 uncompressed_size;
72 } _packed_attribute;
73
74 /* In-memory version of a WIM resource header (`struct wim_reshdr_disk').  */
75 struct wim_reshdr {
76         u64 size_in_wim : 56;
77         u64 flags : 8;
78         u64 offset_in_wim;
79         u64 uncompressed_size;
80 };
81
82 /* Flags for the `flags' field of WIM resource headers (`struct wim_reshdr').
83  */
84
85 /* Unknown meaning; may be intended to indicate spaces in the WIM that are free
86  * to overwrite.  Currently ignored by wimlib.  */
87 #define WIM_RESHDR_FLAG_FREE            0x01
88
89 /* The resource is a metadata resource for a WIM image, or is the lookup table
90  * or XML data for the WIM.  */
91 #define WIM_RESHDR_FLAG_METADATA        0x02
92
93 /* The resource is compressed using the WIM's default compression type and uses
94  * the regular chunk table format.  */
95 #define WIM_RESHDR_FLAG_COMPRESSED      0x04
96
97 /* Unknown meaning; may be intended to indicate a partial stream.  Currently
98  * ignored by wimlib.  */
99 #define WIM_RESHDR_FLAG_SPANNED         0x08
100
101 /* The resource is packed in a special format that may contain multiple
102  * underlying streams, or this resource entry represents a stream packed into
103  * one such resource.  When resources have this flag set, the WIM version number
104  * should be WIM_VERSION_PACKED_STREAMS.  */
105 #define WIM_RESHDR_FLAG_PACKED_STREAMS  0x10
106
107 /* Magic number in the 'uncompressed_size' field of the resource header that
108  * identifies the main entry for a pack.  */
109 #define WIM_PACK_MAGIC_NUMBER           0x100000000ULL
110
111 /* Returns true if the specified WIM resource is compressed, using either the
112  * original chunk table layout or the alternate layout for resources that may
113  * contain multiple packed streams.  */
114 static inline bool
115 resource_is_compressed(const struct wim_resource_spec *rspec)
116 {
117         return (rspec->flags & (WIM_RESHDR_FLAG_COMPRESSED |
118                                 WIM_RESHDR_FLAG_PACKED_STREAMS));
119 }
120
121 static inline void
122 copy_reshdr(struct wim_reshdr *dest, const struct wim_reshdr *src)
123 {
124         memcpy(dest, src, sizeof(struct wim_reshdr));
125 }
126
127 static inline void
128 zero_reshdr(struct wim_reshdr *reshdr)
129 {
130         memset(reshdr, 0, sizeof(struct wim_reshdr));
131 }
132
133 extern void
134 wim_res_hdr_to_spec(const struct wim_reshdr *reshdr, WIMStruct *wim,
135                     struct wim_resource_spec *rspec);
136
137 extern void
138 wim_res_spec_to_hdr(const struct wim_resource_spec *rspec,
139                     struct wim_reshdr *reshdr);
140
141 extern void
142 get_wim_reshdr(const struct wim_reshdr_disk *disk_reshdr,
143                struct wim_reshdr *reshdr);
144
145 void
146 put_wim_reshdr(const struct wim_reshdr *reshdr,
147                struct wim_reshdr_disk *disk_reshdr);
148
149 /* Alternate chunk table format for resources with
150  * WIM_RESHDR_FLAG_PACKED_STREAMS set.  */
151 struct alt_chunk_table_header_disk {
152         /* Uncompressed size of the resource in bytes.  */
153         le64 res_usize;
154
155         /* Number of bytes each compressed chunk decompresses into, except
156          * possibly the last which decompresses into the remainder.  This
157          * overrides the chunk size specified by the WIM header.  */
158         le32 chunk_size;
159
160         /* Compression format used for compressed chunks:
161          * 0 = None
162          * 1 = LZX
163          * 2 = XPRESS
164          * 3 = LZMS
165          *
166          * This overrides the compression type specified by the WIM header.  */
167         le32 compression_format;
168
169         /* This header is directly followed by a table of compressed sizes of
170          * the chunks (4 bytes per entry).  */
171 } _packed_attribute;
172
173 /* Functions to read streams  */
174
175 extern int
176 read_partial_wim_stream_into_buf(const struct wim_lookup_table_entry *lte,
177                                  size_t size, u64 offset, void *buf);
178
179 extern int
180 read_full_stream_into_buf(const struct wim_lookup_table_entry *lte, void *buf);
181
182 extern int
183 read_full_stream_into_alloc_buf(const struct wim_lookup_table_entry *lte,
184                                 void **buf_ret);
185
186 extern int
187 wim_reshdr_to_data(const struct wim_reshdr *reshdr,
188                    WIMStruct *wim, void **buf_ret);
189
190 extern int
191 skip_wim_stream(struct wim_lookup_table_entry *lte);
192
193 /*
194  * Type of callback function for beginning to read a stream.
195  *
196  * @lte:
197  *      Stream that is about to be read.
198  *
199  * @is_partial_res:
200  *      Set to true if the stream is just one of several being read from a
201  *      single pack and therefore would be extra expensive to read
202  *      independently.
203  *
204  * @ctx:
205  *      User-provided context.
206  *
207  * Must return 0 on success, a positive error code on failure, or the special
208  * value BEGIN_STREAM_STATUS_SKIP_STREAM to indicate that the stream should not
209  * be read, and read_stream_list() should continue on to the next stream
210  * (without calling @consume_chunk or @end_stream).
211  */
212 typedef int (*read_stream_list_begin_stream_t)(struct wim_lookup_table_entry *lte,
213                                                bool is_partial_res,
214                                                void *ctx);
215
216 #define BEGIN_STREAM_STATUS_SKIP_STREAM -1
217
218 /*
219  * Type of callback function for finishing reading a stream.
220  *
221  * @lte:
222  *      Stream that has been fully read, or stream that started being read but
223  *      could not be fully read due to a read error.
224  *
225  * @status:
226  *      0 if reading the stream was successful; otherwise a nonzero error code
227  *      that specifies the return status.
228  *
229  * @ctx:
230  *      User-provided context.
231  */
232 typedef int (*read_stream_list_end_stream_t)(struct wim_lookup_table_entry *lte,
233                                              int status,
234                                              void *ctx);
235
236
237 /* Callback functions and contexts for read_stream_list().  */
238 struct read_stream_list_callbacks {
239
240         /* Called when a stream is about to be read.  */
241         read_stream_list_begin_stream_t begin_stream;
242
243         /* Called when a chunk of data has been read.  */
244         consume_data_callback_t consume_chunk;
245
246         /* Called when a stream has been fully read.  A successful call to
247          * @begin_stream will always be matched by a call to @end_stream.  */
248         read_stream_list_end_stream_t end_stream;
249
250         /* Parameter passed to @begin_stream.  */
251         void *begin_stream_ctx;
252
253         /* Parameter passed to @consume_chunk.  */
254         void *consume_chunk_ctx;
255
256         /* Parameter passed to @end_stream.  */
257         void *end_stream_ctx;
258 };
259
260 /* Flags for read_stream_list()  */
261 #define VERIFY_STREAM_HASHES            0x1
262 #define COMPUTE_MISSING_STREAM_HASHES   0x2
263 #define STREAM_LIST_ALREADY_SORTED      0x4
264
265 extern int
266 read_stream_list(struct list_head *stream_list,
267                  size_t list_head_offset,
268                  const struct read_stream_list_callbacks *cbs,
269                  int flags);
270
271 /* Functions to extract streams.  */
272
273 extern int
274 extract_stream(struct wim_lookup_table_entry *lte,
275                u64 size,
276                consume_data_callback_t extract_chunk,
277                void *extract_chunk_arg);
278
279 extern int
280 extract_stream_to_fd(struct wim_lookup_table_entry *lte,
281                      struct filedes *fd, u64 size);
282
283 extern int
284 extract_full_stream_to_fd(struct wim_lookup_table_entry *lte,
285                           struct filedes *fd);
286
287 extern int
288 extract_chunk_to_fd(const void *chunk, size_t size, void *_fd_p);
289
290 /* Miscellaneous stream functions.  */
291
292 extern int
293 sha1_stream(struct wim_lookup_table_entry *lte);
294
295 /* Functions to read/write metadata resources.  */
296
297 extern int
298 read_metadata_resource(WIMStruct *wim,
299                        struct wim_image_metadata *image_metadata);
300
301 extern int
302 write_metadata_resource(WIMStruct *wim, int image, int write_resource_flags);
303
304 /* Definitions specific to pipable WIM resources.  */
305
306 /* Arbitrary number to begin each stream in the pipable WIM, used for sanity
307  * checking.  */
308 #define PWM_STREAM_MAGIC 0x2b9b9ba2443db9d8ULL
309
310 /* Header that precedes each resource in a pipable WIM.  */
311 struct pwm_stream_hdr {
312         le64 magic;                     /* +0   */
313         le64 uncompressed_size;         /* +8   */
314         u8 hash[SHA1_HASH_SIZE];        /* +16  */
315         le32 flags;                     /* +36  */
316                                         /* +40  */
317 } _packed_attribute;
318
319 /* Extra flag for the @flags field in `struct pipable_wim_stream_hdr': Indicates
320  * that the SHA1 message digest of the stream has not been calculated.
321  * Currently only used for the XML data.  */
322 #define PWM_RESHDR_FLAG_UNHASHED         0x100
323
324 /* Header that precedes each chunk of a compressed resource in a pipable WIM.
325  */
326 struct pwm_chunk_hdr {
327         le32 compressed_size;
328 } _packed_attribute;
329
330 #endif /* _WIMLIB_RESOURCE_H */