meta_reader.h

Go to the documentation of this file.

/* SPDX-License-Identifier: LGPL-3.0-or-later */
/*
 * meta_reader.h - This file is part of libsquashfs
 *
 * Copyright (C) 2019 David Oberhollenzer <goliath@infraroot.at>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published
 * by the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
#ifndef SQFS_META_READER_H
#define SQFS_META_READER_H
 
#include "sqfs/predef.h"
#include "sqfs/super.h"
 
struct sqfs_readdir_state_t {
    struct {
        sqfs_u64 block;
        size_t offset;
        size_t size;
    } init, current;
 
    size_t entries;
 
    sqfs_u32 inum_base;
    sqfs_u64 inode_block;
};
 
static SQFS_INLINE void sqfs_readdir_state_reset(sqfs_readdir_state_t *s)
{
    s->current = s->init;
    s->entries = 0;
}
 
#ifdef __cplusplus
extern "C" {
#endif
 
SQFS_API sqfs_meta_reader_t *sqfs_meta_reader_create(sqfs_file_t *file,
                             sqfs_compressor_t *cmp,
                             sqfs_u64 start,
                             sqfs_u64 limit);
 
SQFS_API int sqfs_meta_reader_seek(sqfs_meta_reader_t *m, sqfs_u64 block_start,
                   size_t offset);
 
SQFS_API void sqfs_meta_reader_get_position(const sqfs_meta_reader_t *m,
                        sqfs_u64 *block_start,
                        size_t *offset);
 
SQFS_API int sqfs_meta_reader_read(sqfs_meta_reader_t *m, void *data,
                   size_t size);
 
SQFS_API int sqfs_meta_reader_read_dir_header(sqfs_meta_reader_t *m,
                          sqfs_dir_header_t *hdr);
 
SQFS_API int sqfs_meta_reader_read_dir_ent(sqfs_meta_reader_t *m,
                       sqfs_dir_entry_t **ent);
 
SQFS_API
int sqfs_readdir_state_init(sqfs_readdir_state_t *s, const sqfs_super_t *super,
                const sqfs_inode_generic_t *inode);
 
SQFS_API int sqfs_meta_reader_readdir(sqfs_meta_reader_t *m,
                      sqfs_readdir_state_t *s,
                      sqfs_dir_entry_t **ent,
                      sqfs_u32 *inum, sqfs_u64 *iref);
 
SQFS_API
int sqfs_meta_reader_read_inode(sqfs_meta_reader_t *ir,
                const sqfs_super_t *super,
                sqfs_u64 block_start, size_t offset,
                sqfs_inode_generic_t **out);
 
#ifdef __cplusplus
}
#endif
 
#endif /* SQFS_META_READER_H */