block_processor.h

Go to the documentation of this file.

/* SPDX-License-Identifier: LGPL-3.0-or-later */
/*
 * block_processor.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 SFQS_BLOCK_PROCESSOR_H
#define SFQS_BLOCK_PROCESSOR_H
 
#include "sqfs/predef.h"
 
struct sqfs_block_processor_stats_t {
    size_t size;
 
    sqfs_u64 input_bytes_read;
 
    sqfs_u64 output_bytes_generated;
 
    sqfs_u64 data_block_count;
 
    sqfs_u64 frag_block_count;
 
    sqfs_u64 sparse_block_count;
 
    sqfs_u64 total_frag_count;
 
    sqfs_u64 actual_frag_count;
};
 
struct sqfs_block_processor_desc_t {
    sqfs_u32 size;
 
    sqfs_u32 max_block_size;
 
    sqfs_u32 num_workers;
 
    sqfs_u32 max_backlog;
 
    sqfs_compressor_t *cmp;
 
    sqfs_block_writer_t *wr;
 
    sqfs_frag_table_t *tbl;
 
    sqfs_file_t *file;
 
    sqfs_compressor_t *uncmp;
};
 
#ifdef __cplusplus
extern "C" {
#endif
 
SQFS_API
sqfs_block_processor_t *sqfs_block_processor_create(size_t max_block_size,
                            sqfs_compressor_t *cmp,
                            unsigned int num_workers,
                            size_t max_backlog,
                            sqfs_block_writer_t *wr,
                            sqfs_frag_table_t *tbl);
 
SQFS_API
int sqfs_block_processor_create_ex(const sqfs_block_processor_desc_t *desc,
                   sqfs_block_processor_t **out);
 
SQFS_API int sqfs_block_processor_begin_file(sqfs_block_processor_t *proc,
                         sqfs_inode_generic_t **inode,
                         void *user, sqfs_u32 flags);
 
SQFS_API int sqfs_block_processor_append(sqfs_block_processor_t *proc,
                     const void *data, size_t size);
 
SQFS_API int sqfs_block_processor_end_file(sqfs_block_processor_t *proc);
 
SQFS_API int sqfs_block_processor_submit_block(sqfs_block_processor_t *proc,
                           void *user, sqfs_u32 flags,
                           const void *data, size_t size);
 
SQFS_API int sqfs_block_processor_sync(sqfs_block_processor_t *proc);
 
SQFS_API int sqfs_block_processor_finish(sqfs_block_processor_t *proc);
 
SQFS_API const sqfs_block_processor_stats_t
*sqfs_block_processor_get_stats(const sqfs_block_processor_t *proc);
 
#ifdef __cplusplus
}
#endif
 
#endif /* SFQS_BLOCK_PROCESSOR_H */