sqsh_extract_private.h

Go to the documentation of this file.

/******************************************************************************
 *                                                                            *
 * Copyright (c) 2023-2024, Enno Boland <g@s01.de>                            *
 *                                                                            *
 * Redistribution and use in source and binary forms, with or without         *
 * modification, are permitted provided that the following conditions are     *
 * met:                                                                       *
 *                                                                            *
 * * Redistributions of source code must retain the above copyright notice,   *
 *   this list of conditions and the following disclaimer.                    *
 * * Redistributions in binary form must reproduce the above copyright        *
 *   notice, this list of conditions and the following disclaimer in the      *
 *   documentation and/or other materials provided with the distribution.     *
 *                                                                            *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS    *
 * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,  *
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR     *
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR          *
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,      *
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,        *
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR         *
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF     *
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING       *
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS         *
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.               *
 *                                                                            *
 ******************************************************************************/
 
#ifndef SQSH_EXTRACT_PRIVATE_H
#define SQSH_EXTRACT_PRIVATE_H
 
#include <cextras/collection.h>
 
#include <sqsh_data.h>
#include <sqsh_utils_private.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct SqshArchive;
struct SqshMapReader;
 
/***************************************
 * extract/extractor2.c
 */
 
typedef uint8_t sqsh__extractor_context_t[256];
 
extern const struct SqshExtractorImpl *const volatile sqsh__impl_lzo;
 
struct SqshExtractorImpl {
    int (*init)(void *context, uint8_t *target, size_t target_size);
    int (*write)(
            void *context, const uint8_t *compressed,
            const size_t compressed_size);
    int (*finish)(void *context, uint8_t *target, size_t *target_size);
};
 
struct SqshExtractor {
    struct CxBuffer *buffer;
    const struct SqshExtractorImpl *impl;
    sqsh__extractor_context_t context;
    uint8_t *target;
    size_t block_size;
};
 
SQSH_NO_EXPORT const struct SqshExtractorImpl *
sqsh__extractor_impl_from_id(enum SqshSuperblockCompressionId id);
 
SQSH_NO_EXPORT SQSH_NO_UNUSED int sqsh__extractor_init(
        struct SqshExtractor *extractor, struct CxBuffer *buffer,
        const struct SqshExtractorImpl *impl, size_t block_size);
 
SQSH_NO_EXPORT SQSH_NO_UNUSED int sqsh__extractor_write(
        struct SqshExtractor *extractor, const uint8_t *compressed,
        const size_t compressed_size);
 
SQSH_NO_EXPORT int sqsh__extractor_finish(struct SqshExtractor *extractor);
 
SQSH_NO_EXPORT int sqsh__extractor_cleanup(struct SqshExtractor *extractor);
 
/***************************************
 * extract/extract_manager.c
 */
 
struct SqshExtractManager {
    struct CxRcRadixTree cache;
    const struct SqshExtractorImpl *extractor_impl;
    uint32_t block_size;
    struct SqshMapManager *map_manager;
    struct CxLru lru;
    sqsh__mutex_t lock;
};
 
SQSH_NO_EXPORT SQSH_NO_UNUSED int sqsh__extract_manager_init(
        struct SqshExtractManager *manager, struct SqshArchive *archive,
        uint32_t block_size, size_t lru_size);
 
SQSH_NO_EXPORT int sqsh__extract_manager_uncompress(
        struct SqshExtractManager *manager, const struct SqshMapReader *reader,
        const struct CxBuffer **target);
 
SQSH_NO_EXPORT int sqsh__extract_manager_release(
        struct SqshExtractManager *manager, uint64_t address);
 
SQSH_NO_EXPORT int
sqsh__extract_manager_cleanup(struct SqshExtractManager *manager);
 
/***************************************
 * extract/extract_view.c
 */
 
struct SqshExtractView {
    struct SqshExtractManager *manager;
    const struct CxBuffer *buffer;
    uint64_t address;
    size_t size;
};
 
SQSH_NO_EXPORT SQSH_NO_UNUSED int sqsh__extract_view_init(
        struct SqshExtractView *view, struct SqshExtractManager *manager,
        const struct SqshMapReader *reader);
 
SQSH_NO_EXPORT const uint8_t *
sqsh__extract_view_data(const struct SqshExtractView *view);
 
SQSH_NO_EXPORT size_t
sqsh__extract_view_size(const struct SqshExtractView *view);
 
SQSH_NO_EXPORT int sqsh__extract_view_cleanup(struct SqshExtractView *view);
 
/***************************************
 * extract/lz4.c
 */
 
SQSH_NO_EXPORT extern const struct SqshExtractorImpl *const sqsh__impl_lz4;
/***************************************
 * extract/lzma.c
 */
 
SQSH_NO_EXPORT extern const struct SqshExtractorImpl *const sqsh__impl_lzma;
SQSH_NO_EXPORT extern const struct SqshExtractorImpl *const sqsh__impl_xz;
 
/***************************************
 * extract/zlib.c
 */
 
SQSH_NO_EXPORT extern const struct SqshExtractorImpl *const sqsh__impl_zlib;
 
/***************************************
 * extract/zstd.c
 */
 
SQSH_NO_EXPORT extern const struct SqshExtractorImpl *const sqsh__impl_zstd;
 
#ifdef __cplusplus
}
#endif
#endif /* SQSH_EXTRACT_PRIVATE_H */