sqsh_archive_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_ARCHIVE_PRIVATE_H
#define SQSH_ARCHIVE_PRIVATE_H
 
#include "sqsh_archive.h"
 
#include "sqsh_error.h"
#include "sqsh_file_private.h"
#include "sqsh_utils_private.h"
#include "sqsh_xattr_private.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/***************************************
 * archive/trailing_context.c
 */
 
struct SqshTrailingContext {
    struct SqshMapReader cursor;
};
 
SQSH_NO_UNUSED SQSH_NO_EXPORT int sqsh__trailing_init(
        struct SqshTrailingContext *context, struct SqshArchive *sqsh);
 
SQSH_NO_EXPORT int sqsh__trailing_cleanup(struct SqshTrailingContext *context);
 
/***************************************
 * archive/inode_map.c
 */
 
struct SqshInodeMapImpl {
    int (*init)(struct SqshInodeMap *map, struct SqshArchive *archive);
    uint64_t (*get)(
            const struct SqshInodeMap *map, uint32_t inode_number, int *err);
    int (*set)(
            struct SqshInodeMap *map, uint32_t inode_number,
            uint64_t inode_ref);
    int (*cleanup)(struct SqshInodeMap *map);
};
struct SqshInodeMap {
    const struct SqshInodeMapImpl *impl;
    sqsh__mutex_t *mutex;
    struct CxRadixTree inode_refs;
    size_t inode_count;
    struct SqshExportTable *export_table;
};
 
SQSH_NO_UNUSED SQSH_NO_EXPORT int
sqsh__inode_map_init(struct SqshInodeMap *map, struct SqshArchive *archive);
 
SQSH_NO_EXPORT int sqsh__inode_map_cleanup(struct SqshInodeMap *map);
 
/***************************************
 * archive/superblock.c
 */
 
struct SqshSuperblock {
    struct SqshMapReader cursor;
};
 
SQSH_NO_UNUSED SQSH_NO_EXPORT int sqsh__superblock_init(
        struct SqshSuperblock *superblock, struct SqshMapManager *mapper);
 
SQSH_NO_EXPORT int sqsh__superblock_cleanup(struct SqshSuperblock *superblock);
 
/***************************************
 * archive/compression_options.c
 */
 
struct SqshCompressionOptions {
    uint16_t compression_id;
    struct SqshMetablockIterator metablock;
};
 
SQSH_NO_EXPORT SQSH_NO_UNUSED int sqsh__compression_options_init(
        struct SqshCompressionOptions *compression_options,
        struct SqshArchive *sqsh);
 
SQSH_NO_EXPORT int sqsh__compression_options_cleanup(
        struct SqshCompressionOptions *compression_options);
 
/***************************************
 * archive/archive.c
 */
 
struct SqshArchive {
    struct SqshMapManager map_manager;
    struct SqshExtractManager data_extract_manager;
    struct SqshExtractManager metablock_extract_manager;
    struct SqshSuperblock superblock;
    struct SqshIdTable id_table;
    struct SqshExportTable export_table;
    struct SqshXattrTable xattr_table;
    struct SqshFragmentTable fragment_table;
    struct SqshInodeMap inode_map;
    uint8_t initialized;
    struct SqshConfig config;
    sqsh__mutex_t lock;
    uint8_t *zero_block;
};
 
SQSH_NO_EXPORT SQSH_NO_UNUSED int sqsh__archive_init(
        struct SqshArchive *sqsh, const void *source,
        const struct SqshConfig *config);
 
SQSH_NO_EXPORT int sqsh__archive_data_extract_manager(
        struct SqshArchive *archive,
        struct SqshExtractManager **data_extract_manager);
 
SQSH_NO_EXPORT struct SqshExtractManager *
sqsh__archive_metablock_extract_manager(struct SqshArchive *archive);
 
SQSH_NO_EXPORT const uint8_t *
sqsh__archive_zero_block(const struct SqshArchive *archive);
 
SQSH_NO_EXPORT size_t
sqsh__archive_zero_block_size(const struct SqshArchive *archive);
 
SQSH_NO_EXPORT int sqsh__archive_cleanup(struct SqshArchive *sqsh);
 
#ifdef __cplusplus
}
#endif
#endif /* SQSH_ARCHIVE_PRIVATE_H */