sqsh_mapper_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_PRIVATE_MAPPER_H
#define SQSH_PRIVATE_MAPPER_H
 
#include <sqsh_mapper.h>
 
#include "sqsh_reader_private.h"
#include "sqsh_utils_private.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct SqshArchive;
struct SqshConfig;
 
/***************************************
 * mapper/mapper.c
 */
 
struct SqshMapSlice;
 
struct SqshMapper {
    const struct SqshMemoryMapperImpl *impl;
    size_t block_size;
    uint64_t archive_size;
    void *user_data;
};
 
SQSH_NO_EXPORT SQSH_NO_UNUSED int sqsh__mapper_init(
        struct SqshMapper *mapper, const void *source,
        const struct SqshConfig *config);
 
SQSH_NO_EXPORT int sqsh__mapper_cleanup(struct SqshMapper *mapper);
 
/***************************************
 * mapper/map_slice.c
 */
 
struct SqshMapSlice {
    struct SqshMapper *mapper;
    uint64_t index;
    uint8_t *data;
    size_t size;
};
 
SQSH_NO_EXPORT const uint8_t *
sqsh__map_slice_data(const struct SqshMapSlice *mapping);
 
SQSH_NO_EXPORT size_t sqsh__map_slice_size(const struct SqshMapSlice *mapping);
 
SQSH_NO_EXPORT int sqsh__map_slice_cleanup(struct SqshMapSlice *mapping);
SQSH_NO_EXPORT SQSH_NO_UNUSED int sqsh__map_slice_init(
        struct SqshMapSlice *mapping, struct SqshMapper *mapper,
        uint64_t address, uint64_t offset, size_t size);
 
/***************************************
 * mapper/map_manager.c
 */
 
struct SqshMapManager {
    struct SqshMapper mapper;
    struct CxLru lru;
    struct CxRcRadixTree maps;
    uint64_t archive_offset;
    uint64_t block_count;
    sqsh__mutex_t lock;
};
 
SQSH_NO_EXPORT SQSH_NO_UNUSED int sqsh__map_manager_init(
        struct SqshMapManager *manager, const void *input,
        const struct SqshConfig *config);
 
SQSH_NO_EXPORT uint64_t
sqsh__map_manager_size(const struct SqshMapManager *manager);
 
SQSH_NO_EXPORT size_t
sqsh__map_manager_block_size(const struct SqshMapManager *manager);
 
SQSH_NO_EXPORT SQSH_NO_UNUSED int sqsh__map_manager_get(
        struct SqshMapManager *manager, sqsh_index_t index,
        const struct SqshMapSlice **target);
 
SQSH_NO_EXPORT int sqsh__map_manager_release(
        struct SqshMapManager *manager, const struct SqshMapSlice *mapping);
SQSH_NO_EXPORT int sqsh__map_manager_cleanup(struct SqshMapManager *manager);
 
/***************************************
 * mapper/map_iterator.c
 */
 
struct SqshMapIterator {
    sqsh_index_t next_index;
    uint64_t segment_count;
    struct SqshMapManager *map_manager;
    const struct SqshMapSlice *mapping;
    const uint8_t *data;
    size_t size;
};
 
SQSH_NO_EXPORT SQSH_NO_UNUSED int sqsh__map_iterator_init(
        struct SqshMapIterator *iterator, struct SqshMapManager *manager,
        uint64_t address);
 
SQSH_NO_EXPORT SQSH_NO_UNUSED bool
sqsh__map_iterator_next(struct SqshMapIterator *iterator, int *err);
 
SQSH_NO_EXPORT SQSH_NO_UNUSED int
sqsh__map_iterator_skip(struct SqshMapIterator *iterator, uint64_t *offset);
 
SQSH_NO_EXPORT const uint8_t *
sqsh__map_iterator_data(const struct SqshMapIterator *iterator);
 
SQSH_NO_EXPORT size_t
sqsh__map_iterator_block_size(const struct SqshMapIterator *iterator);
 
SQSH_NO_EXPORT size_t
sqsh__map_iterator_size(const struct SqshMapIterator *iterator);
 
SQSH_NO_EXPORT int sqsh__map_iterator_cleanup(struct SqshMapIterator *iterator);
 
/***************************************
 * mapper/map_reader.c
 */
 
struct SqshMapReader {
    uint64_t address;
    uint64_t upper_limit;
    struct SqshMapIterator iterator;
    struct SqshReader reader;
};
 
SQSH_NO_EXPORT SQSH_NO_UNUSED int sqsh__map_reader_init(
        struct SqshMapReader *reader, struct SqshMapManager *mapper,
        const uint64_t start_address, uint64_t upper_limit);
 
SQSH_NO_EXPORT size_t
sqsh__map_reader_remaining_direct(const struct SqshMapReader *reader);
 
SQSH_NO_EXPORT SQSH_NO_UNUSED uint64_t
sqsh__map_reader_address(const struct SqshMapReader *reader);
 
SQSH_NO_EXPORT SQSH_NO_UNUSED int sqsh__map_reader_advance(
        struct SqshMapReader *reader, uint64_t offset, size_t size);
 
SQSH_NO_EXPORT SQSH_NO_UNUSED int
sqsh__map_reader_all(struct SqshMapReader *reader);
 
SQSH_NO_EXPORT const uint8_t *
sqsh__map_reader_data(const struct SqshMapReader *reader);
 
SQSH_NO_EXPORT size_t sqsh__map_reader_size(const struct SqshMapReader *reader);
 
SQSH_NO_EXPORT int sqsh__map_reader_cleanup(struct SqshMapReader *reader);
 
#ifdef __cplusplus
}
#endif
#endif /* SQSH_PRIVATE_MAPPER_H */