sqsh_table_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_TABLE_PRIVATE_H
#define SQSH_TABLE_PRIVATE_H
 
#include "sqsh_extract_private.h"
#include "sqsh_mapper_private.h"
#include "sqsh_table.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct SqshFile;
struct SqshDataFragment;
struct SqshDataXattrLookupTable;
 
/***************************************
 * table/table.c
 */
 
struct SqshTable {
    struct SqshArchive *sqsh;
    struct SqshMapper *mapper;
    struct SqshMapReader lookup_table;
    uint64_t start_block;
    size_t element_size;
    size_t element_count;
};
 
SQSH_NO_EXPORT SQSH_NO_UNUSED int sqsh__table_init(
        struct SqshTable *table, struct SqshArchive *sqsh, uint64_t start_block,
        size_t element_size, size_t element_count);
 
SQSH_NO_EXPORT int sqsh__table_cleanup(struct SqshTable *table);
 
/***************************************
 * table/id_table.c
 */
 
struct SqshIdTable {
    struct SqshTable table;
};
 
SQSH_NO_EXPORT int
sqsh__id_table_init(struct SqshIdTable *table, struct SqshArchive *sqsh);
 
SQSH_NO_EXPORT int sqsh__id_table_cleanup(struct SqshIdTable *table);
 
/***************************************
 * table/export_table.c
 */
 
struct SqshExportTable {
    struct SqshTable table;
};
 
SQSH_NO_EXPORT int sqsh__export_table_init(
        struct SqshExportTable *table, struct SqshArchive *sqsh);
 
SQSH_NO_EXPORT int sqsh__export_table_cleanup(struct SqshExportTable *table);
 
/***************************************
 * file/fragment_table.c
 */
 
struct SqshFragmentTable {
    struct SqshTable table;
    struct SqshExtractManager extract_manager;
};
 
SQSH_NO_EXPORT SQSH_NO_UNUSED int sqsh__fragment_table_init(
        struct SqshFragmentTable *table, struct SqshArchive *sqsh);
 
SQSH_NO_EXPORT int sqsh__fragment_table_get(
        const struct SqshFragmentTable *table, const struct SqshFile *inode,
        struct SqshDataFragment *fragment);
 
SQSH_NO_EXPORT int
sqsh__fragment_table_cleanup(struct SqshFragmentTable *table);
 
/***************************************
 * table/xattr_table.c
 */
 
struct SqshXattrTable {
    struct SqshMapReader header;
    struct SqshTable table;
};
 
SQSH_NO_EXPORT uint64_t sqsh__xattr_table_start(struct SqshXattrTable *table);
 
SQSH_NO_EXPORT SQSH_NO_UNUSED int sqsh__xattr_table_get(
        const struct SqshXattrTable *table, sqsh_index_t index,
        struct SqshDataXattrLookupTable *target);
 
#ifdef __cplusplus
}
#endif
#endif /* SQSH_TABLE_PRIVATE_H */