sqsh_file_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_FILE_PRIVATE_H
#define SQSH_FILE_PRIVATE_H
 
#include "sqsh_file.h"
 
#include "sqsh_extract_private.h"
#include "sqsh_mapper_private.h"
#include "sqsh_metablock_private.h"
#include "sqsh_reader_private.h"
#include <stdint.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct SqshArchive;
struct SqshDataInode;
 
/***************************************
 * file/fragment_view.c
 */
 
struct SqshFragmentView {
    const struct SqshFragmentTable *fragment_table;
    struct SqshMapReader map_reader;
    struct SqshExtractView extract_view;
    const uint8_t *data;
    size_t size;
};
 
SQSH_NO_EXPORT int sqsh__fragment_view_init(
        struct SqshFragmentView *view, const struct SqshFile *file);
 
SQSH_NO_EXPORT const uint8_t *
sqsh__fragment_view_data(const struct SqshFragmentView *view);
 
SQSH_NO_EXPORT size_t
sqsh__fragment_view_size(const struct SqshFragmentView *view);
 
SQSH_NO_EXPORT int sqsh__fragment_view_cleanup(struct SqshFragmentView *view);
 
/***************************************
 * file/file_iterator.c
 */
 
struct SqshFileIterator {
    const struct SqshFile *file;
    struct SqshExtractManager *compression_manager;
    struct SqshMapReader map_reader;
    struct SqshExtractView extract_view;
    struct SqshFragmentView fragment_view;
    size_t sparse_size;
    size_t block_size;
    uint32_t block_index;
    const uint8_t *data;
    size_t size;
};
 
SQSH_NO_EXPORT SQSH_NO_UNUSED int sqsh__file_iterator_init(
        struct SqshFileIterator *iterator, const struct SqshFile *file);
 
SQSH_NO_EXPORT int
sqsh__file_iterator_cleanup(struct SqshFileIterator *iterator);
 
/***************************************
 * context/file_reader.c
 */
 
struct SqshFileReader {
    struct SqshFileIterator iterator;
    struct SqshReader reader;
};
 
SQSH_NO_EXPORT SQSH_NO_UNUSED int sqsh__file_reader_init(
        struct SqshFileReader *reader, const struct SqshFile *file);
 
SQSH_NO_EXPORT int sqsh__file_reader_cleanup(struct SqshFileReader *reader);
 
/***************************************
 * file/file.c
 */
 
#define SQSH_INODE_REF_NULL UINT64_MAX
 
struct SqshInodeImpl {
    size_t header_size;
    size_t (*payload_size)(
            const struct SqshDataInode *inode,
            const struct SqshArchive *archive);
 
    uint32_t (*hard_link_count)(const struct SqshDataInode *inode);
    uint64_t (*size)(const struct SqshDataInode *inode);
 
    uint64_t (*blocks_start)(const struct SqshDataInode *inode);
    uint32_t (*block_size_info)(
            const struct SqshDataInode *inode, sqsh_index_t index);
    uint32_t (*fragment_block_index)(const struct SqshDataInode *inode);
    uint32_t (*fragment_block_offset)(const struct SqshDataInode *inode);
 
    uint32_t (*directory_block_start)(const struct SqshDataInode *inode);
    uint16_t (*directory_block_offset)(const struct SqshDataInode *inode);
    uint32_t (*directory_parent_inode)(const struct SqshDataInode *inode);
 
    const char *(*symlink_target_path)(const struct SqshDataInode *inode);
    uint32_t (*symlink_target_size)(const struct SqshDataInode *inode);
 
    uint32_t (*device_id)(const struct SqshDataInode *inode);
 
    uint32_t (*xattr_index)(const struct SqshDataInode *inode);
};
 
struct SqshFile {
    uint64_t inode_ref;
    struct SqshMetablockReader metablock;
    struct SqshArchive *archive;
    const struct SqshInodeImpl *impl;
    enum SqshFileType type;
    uint64_t parent_inode_ref;
};
 
SQSH_NO_EXPORT SQSH_NO_UNUSED int sqsh__file_init(
        struct SqshFile *context, struct SqshArchive *sqsh, uint64_t inode_ref);
 
SQSH_NO_EXPORT void sqsh__file_set_parent_inode_ref(
        struct SqshFile *context, uint64_t parent_inode_ref);
 
SQSH_NO_EXPORT uint64_t
sqsh__file_parent_inode_ref(struct SqshFile *context, int *err);
 
SQSH_NO_EXPORT int sqsh__file_cleanup(struct SqshFile *context);
 
/***************************************
 * file/inode_directory.c
 */
 
SQSH_NO_EXPORT extern const struct SqshInodeImpl sqsh__inode_directory_impl;
SQSH_NO_EXPORT extern const struct SqshInodeImpl sqsh__inode_directory_ext_impl;
 
/***************************************
 * file/inode_file.c
 */
 
SQSH_NO_EXPORT extern const struct SqshInodeImpl sqsh__inode_file_impl;
SQSH_NO_EXPORT extern const struct SqshInodeImpl sqsh__inode_file_ext_impl;
 
/***************************************
 * file/inode_symlink.c
 */
 
SQSH_NO_EXPORT extern const struct SqshInodeImpl sqsh__inode_symlink_impl;
SQSH_NO_EXPORT extern const struct SqshInodeImpl sqsh__inode_symlink_ext_impl;
 
/***************************************
 * file/inode_device.c
 */
 
SQSH_NO_EXPORT extern const struct SqshInodeImpl sqsh__inode_device_impl;
SQSH_NO_EXPORT extern const struct SqshInodeImpl sqsh__inode_device_ext_impl;
 
/***************************************
 * file/inode_ipc.c
 */
 
SQSH_NO_EXPORT extern const struct SqshInodeImpl sqsh__inode_ipc_impl;
SQSH_NO_EXPORT extern const struct SqshInodeImpl sqsh__inode_ipc_ext_impl;
 
/***************************************
 * file/inode_null.c
 */
 
SQSH_NO_EXPORT uint32_t
sqsh__file_inode_null_directory_block_start(const struct SqshDataInode *inode);
 
SQSH_NO_EXPORT uint16_t
sqsh__file_inode_null_directory_block_offset(const struct SqshDataInode *inode);
 
SQSH_NO_EXPORT uint32_t
sqsh__file_inode_null_directory_parent_inode(const struct SqshDataInode *inode);
 
SQSH_NO_EXPORT uint64_t
sqsh__file_inode_null_blocks_start(const struct SqshDataInode *inode);
 
SQSH_NO_EXPORT uint32_t sqsh__file_inode_null_block_size_info(
        const struct SqshDataInode *inode, sqsh_index_t index);
 
SQSH_NO_EXPORT uint32_t
sqsh__file_inode_null_fragment_block_index(const struct SqshDataInode *inode);
 
SQSH_NO_EXPORT uint32_t
sqsh__file_inode_null_fragment_block_offset(const struct SqshDataInode *inode);
 
SQSH_NO_EXPORT const char *
sqsh__file_inode_null_symlink_target_path(const struct SqshDataInode *inode);
 
SQSH_NO_EXPORT uint32_t
sqsh__file_inode_null_symlink_target_size(const struct SqshDataInode *inode);
 
SQSH_NO_EXPORT uint32_t
sqsh__file_inode_null_device_id(const struct SqshDataInode *inode);
 
SQSH_NO_EXPORT uint32_t
sqsh__file_inode_null_xattr_index(const struct SqshDataInode *inode);
 
#ifdef __cplusplus
}
#endif
#endif /* SQSH_FILE_PRIVATE_H */