#ifndef _WIMLIB_RESOURCE_H
#define _WIMLIB_RESOURCE_H
-#include "wimlib/callback.h"
#include "wimlib/list.h"
#include "wimlib/sha1.h"
#include "wimlib/types.h"
* identifies the main entry for a solid resource. */
#define SOLID_RESOURCE_MAGIC_NUMBER 0x100000000ULL
-/* Returns true if the specified WIM resource is compressed (may be either solid
- * or non-solid) */
-static inline bool
-resource_is_compressed(const struct wim_resource_descriptor *rdesc)
-{
- return (rdesc->flags & (WIM_RESHDR_FLAG_COMPRESSED |
- WIM_RESHDR_FLAG_SOLID));
-}
-
static inline void
copy_reshdr(struct wim_reshdr *dest, const struct wim_reshdr *src)
{
}
extern void
-wim_res_hdr_to_desc(const struct wim_reshdr *reshdr, WIMStruct *wim,
- struct wim_resource_descriptor *rdesc);
+wim_reshdr_to_desc(const struct wim_reshdr *reshdr, WIMStruct *wim,
+ struct wim_resource_descriptor *rdesc);
extern void
-wim_res_desc_to_hdr(const struct wim_resource_descriptor *rdesc,
- struct wim_reshdr *reshdr);
+wim_reshdr_to_desc_and_blob(const struct wim_reshdr *reshdr, WIMStruct *wim,
+ struct wim_resource_descriptor *rdesc,
+ struct blob_descriptor *blob);
extern void
get_wim_reshdr(const struct wim_reshdr_disk *disk_reshdr,
struct wim_reshdr *reshdr);
-void
+extern void
put_wim_reshdr(const struct wim_reshdr *reshdr,
struct wim_reshdr_disk *disk_reshdr);
extern int
read_partial_wim_blob_into_buf(const struct blob_descriptor *blob,
- size_t size, u64 offset, void *buf);
+ u64 offset, size_t size, void *buf);
extern int
-read_full_blob_into_buf(const struct blob_descriptor *blob, void *buf);
+read_blob_into_buf(const struct blob_descriptor *blob, void *buf);
extern int
-read_full_blob_into_alloc_buf(const struct blob_descriptor *blob, void **buf_ret);
+read_blob_into_alloc_buf(const struct blob_descriptor *blob, void **buf_ret);
extern int
-wim_reshdr_to_data(const struct wim_reshdr *reshdr,
- WIMStruct *wim, void **buf_ret);
+wim_reshdr_to_data(const struct wim_reshdr *reshdr, WIMStruct *wim,
+ void **buf_ret);
extern int
wim_reshdr_to_hash(const struct wim_reshdr *reshdr, WIMStruct *wim,
u8 hash[SHA1_HASH_SIZE]);
extern int
-skip_wim_resource(struct wim_resource_descriptor *rdesc);
-
-/*
- * Type of callback function for beginning to read a blob.
- *
- * @blob:
- * Blob that is about to be read.
- *
- * @ctx:
- * User-provided context.
- *
- * Must return 0 on success, a positive error code on failure, or the special
- * value BEGIN_BLOB_STATUS_SKIP_BLOB to indicate that the blob should not be
- * read, and read_blob_list() should continue on to the next blob (without
- * calling @consume_chunk or @end_blob).
- */
-typedef int (*read_blob_list_begin_blob_t)(struct blob_descriptor *blob, void *ctx);
-
-#define BEGIN_BLOB_STATUS_SKIP_BLOB -1
+skip_wim_resource(const struct wim_resource_descriptor *rdesc);
/*
- * Type of callback function for finishing reading a blob.
- *
- * @blob:
- * Blob that has been fully read, or blob that started being read but could
- * not be fully read due to a read error.
- *
- * @status:
- * 0 if reading the blob was successful; otherwise a nonzero error code
- * that specifies the return status.
- *
- * @ctx:
- * User-provided context.
+ * Callback function for reading chunks. Called whenever the next chunk of
+ * uncompressed data is available, passing 'ctx' as the last argument. 'size' is
+ * guaranteed to be nonzero. Must return 0 on success, or a positive wimlib
+ * error code on failure.
*/
-typedef int (*read_blob_list_end_blob_t)(struct blob_descriptor *blob,
- int status,
- void *ctx);
-
-
-/* Callback functions and contexts for read_blob_list(). */
-struct read_blob_list_callbacks {
-
- /* Called when a blob is about to be read. */
- read_blob_list_begin_blob_t begin_blob;
+struct consume_chunk_callback {
+ int (*func)(const void *chunk, size_t size, void *ctx);
+ void *ctx;
+};
- /* Called when a chunk of data has been read. */
- consume_data_callback_t consume_chunk;
+/* Pass a chunk of data to the specified consume_chunk callback */
+static inline int
+consume_chunk(const struct consume_chunk_callback *cb,
+ const void *chunk, size_t size)
+{
+ return (*cb->func)(chunk, size, cb->ctx);
+}
- /* Called when a blob has been fully read. A successful call to
- * @begin_blob will always be matched by a call to @end_blob. */
- read_blob_list_end_blob_t end_blob;
+/* Callback functions for reading blobs */
+struct read_blob_callbacks {
+
+ /* Called when starting to read a blob. Must return 0 on success, or a
+ * positive wimlib error code on failure, or in the case of
+ * read_blob_list(), the special value BEGIN_BLOB_STATUS_SKIP_BLOB which
+ * indicates that the data for this blob should not be read. */
+ int (*begin_blob)(struct blob_descriptor *blob, void *ctx);
+#define BEGIN_BLOB_STATUS_SKIP_BLOB (-1)
+
+ /* Called when the next chunk of uncompressed data is available. 'size'
+ * is guaranteed to be nonzero. Must return 0 on success, or a positive
+ * wimlib error code on failure. */
+ int (*continue_blob)(const struct blob_descriptor *blob, u64 offset,
+ const void *chunk, size_t size, void *ctx);
+
+ /* Called when a blob has been successfully read (status=0), or when
+ * begin_blob() was successfully called but an error occurred before the
+ * blob was fully read (status != 0; in this case the implementation
+ * should do cleanup and then pass on the status). Must return 0 on
+ * success, or a positive wimlib error code on failure. */
+ int (*end_blob)(struct blob_descriptor *blob, int status, void *ctx);
+
+ /* Parameter passed to each of the callback functions. */
+ void *ctx;
+};
- /* Parameter passed to @begin_blob. */
- void *begin_blob_ctx;
+/* Call cbs->begin_blob() if present. */
+static inline int
+call_begin_blob(struct blob_descriptor *blob,
+ const struct read_blob_callbacks *cbs)
+{
+ if (!cbs->begin_blob)
+ return 0;
+ return (*cbs->begin_blob)(blob, cbs->ctx);
+}
- /* Parameter passed to @consume_chunk. */
- void *consume_chunk_ctx;
+/* Call cbs->continue_blob() if present. */
+static inline int
+call_continue_blob(const struct blob_descriptor *blob, u64 offset,
+ const void *chunk, size_t size,
+ const struct read_blob_callbacks *cbs)
+{
+ if (!cbs->continue_blob)
+ return 0;
+ return (*cbs->continue_blob)(blob, offset, chunk, size, cbs->ctx);
+}
- /* Parameter passed to @end_blob. */
- void *end_blob_ctx;
-};
+/* Call cbs->end_blob() if present. */
+static inline int
+call_end_blob(struct blob_descriptor *blob, int status,
+ const struct read_blob_callbacks *cbs)
+{
+ if (!cbs->end_blob)
+ return status;
+ return (*cbs->end_blob)(blob, status, cbs->ctx);
+}
/* Flags for read_blob_list() */
#define VERIFY_BLOB_HASHES 0x1
extern int
read_blob_list(struct list_head *blob_list, size_t list_head_offset,
- const struct read_blob_list_callbacks *cbs, int flags);
+ const struct read_blob_callbacks *cbs, int flags);
-/* Functions to extract blobs. */
+extern int
+read_blob_with_cbs(struct blob_descriptor *blob,
+ const struct read_blob_callbacks *cbs);
extern int
-extract_blob(struct blob_descriptor *blob, u64 size,
- consume_data_callback_t extract_chunk, void *extract_chunk_arg);
+read_blob_with_sha1(struct blob_descriptor *blob,
+ const struct read_blob_callbacks *cbs);
extern int
-extract_blob_to_fd(struct blob_descriptor *blob, struct filedes *fd, u64 size);
+extract_blob_prefix_to_fd(struct blob_descriptor *blob, u64 size,
+ struct filedes *fd);
extern int
-extract_full_blob_to_fd(struct blob_descriptor *blob, struct filedes *fd);
+extract_blob_to_fd(struct blob_descriptor *blob, struct filedes *fd);
/* Miscellaneous blob functions. */
* checking. */
#define PWM_BLOB_MAGIC 0x2b9b9ba2443db9d8ULL
-/* Header that precedes each resource in a pipable WIM. */
+/* Header that precedes each blob in a pipable WIM. */
struct pwm_blob_hdr {
le64 magic; /* +0 */
le64 uncompressed_size; /* +8 */
/* +40 */
} _packed_attribute;
-/* Extra flag for the @flags field in `struct pwm_blob_hdr': Indicates that the
- * SHA-1 message digest of the stream has not been calculated. Currently only
- * used for the XML data. */
-#define PWM_RESHDR_FLAG_UNHASHED 0x100
-
/* Header that precedes each chunk of a compressed resource in a pipable WIM.
*/
struct pwm_chunk_hdr {
git://wimlib.net / wimlib / blobdiff