sqsh_archive.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_H
#define SQSH_ARCHIVE_H
 
#include "sqsh_common.h"
#include "sqsh_data.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct SqshInodeMap;
struct SqshIdTable;
struct SqshExportTable;
struct SqshXattrTable;
struct SqshFragmentTable;
 
/***************************************
 * archive/trailing_context.c
 */
 
struct SqshTrailingContext;
 
size_t sqsh_trailing_size(const struct SqshTrailingContext *context);
 
const uint8_t *sqsh_trailing_data(const struct SqshTrailingContext *context);
 
/***************************************
 * archive/inode_map.c
 */
 
__attribute__((deprecated("Since 1.2.0. Use sqsh_inode_map_get2() "
                          "instead."))) SQSH_NO_UNUSED uint64_t
sqsh_inode_map_get(const struct SqshInodeMap *map, uint64_t inode_number);
 
SQSH_NO_UNUSED uint64_t sqsh_inode_map_get2(
        const struct SqshInodeMap *map, uint32_t inode_number, int *err);
 
__attribute__((deprecated("Since 1.2.0. Use sqsh_inode_map_set2() "
                          "instead."))) SQSH_NO_UNUSED int
sqsh_inode_map_set(
        struct SqshInodeMap *map, uint64_t inode_number, uint64_t inode_ref);
 
SQSH_NO_UNUSED int sqsh_inode_map_set2(
        struct SqshInodeMap *map, uint32_t inode_number, uint64_t inode_ref);
 
/***************************************
 * archive/superblock_context.c
 */
 
struct SqshSuperblock;
 
enum SqshSuperblockCompressionId
sqsh_superblock_compression_id(const struct SqshSuperblock *context);
 
uint64_t
sqsh_superblock_directory_table_start(const struct SqshSuperblock *context);
 
uint64_t
sqsh_superblock_fragment_table_start(const struct SqshSuperblock *context);
 
uint32_t sqsh_superblock_inode_count(const struct SqshSuperblock *context);
 
uint16_t sqsh_superblock_version_major(const struct SqshSuperblock *superblock);
 
uint16_t sqsh_superblock_version_minor(const struct SqshSuperblock *superblock);
 
uint64_t
sqsh_superblock_inode_table_start(const struct SqshSuperblock *context);
 
uint64_t sqsh_superblock_id_table_start(const struct SqshSuperblock *context);
 
uint16_t sqsh_superblock_id_count(const struct SqshSuperblock *context);
 
uint64_t
sqsh_superblock_export_table_start(const struct SqshSuperblock *context);
 
uint64_t
sqsh_superblock_xattr_id_table_start(const struct SqshSuperblock *context);
 
uint64_t sqsh_superblock_inode_root_ref(const struct SqshSuperblock *context);
 
bool sqsh_superblock_has_fragments(const struct SqshSuperblock *context);
 
bool sqsh_superblock_has_export_table(const struct SqshSuperblock *context);
 
bool sqsh_superblock_has_xattr_table(const struct SqshSuperblock *context);
 
bool
sqsh_superblock_has_compression_options(const struct SqshSuperblock *context);
 
uint32_t sqsh_superblock_block_size(const struct SqshSuperblock *context);
 
uint32_t
sqsh_superblock_modification_time(const struct SqshSuperblock *context);
 
uint32_t
sqsh_superblock_fragment_entry_count(const struct SqshSuperblock *context);
 
uint64_t sqsh_superblock_bytes_used(const struct SqshSuperblock *context);
 
/***************************************
 * archive/archive.c
 */
 
struct SqshConfig {
    uint64_t archive_offset;
 
    uint64_t source_size;
 
    const struct SqshMemoryMapperImpl *source_mapper;
 
    int mapper_block_size;
 
    int mapper_lru_size;
 
#ifndef SQSH__NO_DEPRECATED_FIELD
    __attribute__((
            deprecated("Since 1.5.0. data_lru_size or metablock_lru_size "
                       "instead.")))
#endif
    int compression_lru_size;
 
    size_t max_symlink_depth;
 
    int data_lru_size;
 
    int metablock_lru_size;
 
    char _reserved[128];
};
 
struct SqshArchive;
 
SQSH_NO_UNUSED struct SqshArchive *sqsh_archive_open(
        const void *source, const struct SqshConfig *config, int *err);
 
const struct SqshConfig *sqsh_archive_config(const struct SqshArchive *archive);
 
const struct SqshSuperblock *
sqsh_archive_superblock(const struct SqshArchive *archive);
 
struct SqshMapManager *sqsh_archive_map_manager(struct SqshArchive *archive);
 
SQSH_NO_UNUSED int sqsh_archive_id_table(
        struct SqshArchive *archive, struct SqshIdTable **id_table);
 
SQSH_NO_UNUSED int sqsh_archive_inode_map(
        struct SqshArchive *archive, struct SqshInodeMap **inode_map);
 
SQSH_NO_UNUSED int sqsh_archive_export_table(
        struct SqshArchive *archive, struct SqshExportTable **export_table);
 
SQSH_NO_UNUSED int sqsh_archive_fragment_table(
        struct SqshArchive *archive, struct SqshFragmentTable **fragment_table);
 
SQSH_NO_UNUSED int sqsh_archive_xattr_table(
        struct SqshArchive *archive, struct SqshXattrTable **xattr_table);
 
int sqsh_archive_close(struct SqshArchive *archive);
 
/***************************************
 * archive/compression_options_context.c
 */
 
SQSH_NO_UNUSED
struct SqshCompressionOptions *
sqsh_compression_options_new(struct SqshArchive *sqsh, int *err);
 
uint32_t sqsh_compression_options_gzip_compression_level(
        const struct SqshCompressionOptions *context);
uint16_t sqsh_compression_options_gzip_window_size(
        const struct SqshCompressionOptions *context);
enum SqshGzipStrategies sqsh_compression_options_gzip_strategies(
        const struct SqshCompressionOptions *context);
 
uint32_t sqsh_compression_options_xz_dictionary_size(
        const struct SqshCompressionOptions *context);
enum SqshXzFilters sqsh_compression_options_xz_filters(
        const struct SqshCompressionOptions *context);
 
uint32_t sqsh_compression_options_lz4_version(
        const struct SqshCompressionOptions *context);
uint32_t sqsh_compression_options_lz4_flags(
        const struct SqshCompressionOptions *context);
 
uint32_t sqsh_compression_options_zstd_compression_level(
        const struct SqshCompressionOptions *context);
 
enum SqshLzoAlgorithm sqsh_compression_options_lzo_algorithm(
        const struct SqshCompressionOptions *context);
uint32_t sqsh_compression_options_lzo_compression_level(
        const struct SqshCompressionOptions *context);
 
size_t
sqsh_compression_options_size(const struct SqshCompressionOptions *context);
 
int sqsh_compression_options_free(struct SqshCompressionOptions *context);
 
#ifdef __cplusplus
}
#endif
#endif /* SQSH_ARCHIVE_H */