summaryrefslogtreecommitdiff
path: root/include/sqfs/block_writer.h
blob: f8bc67101b212ac423dbb2acf5f93d9f99daa26e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
/* SPDX-License-Identifier: LGPL-3.0-or-later */
/*
 * block_writer.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_BLOCK_WRITER_H
#define SQFS_BLOCK_WRITER_H

#include "sqfs/predef.h"

/**
 * @file block_writer.h
 *
 * @brief Contains declarations for the @ref sqfs_block_writer_t structure.
 */

/**
 * @interface sqfs_block_writer_t
 *
 * @implements sqfs_object_t
 *
 * @brief Abstracts writing and deduplicating of data and fragment blocks.
 *
 * A default reference implementation can be obtaiend
 * through @ref sqfs_block_writer_create. The default implementation is not
 * copyable, i.e. @ref sqfs_copy will always return NULL.
 */
struct sqfs_block_writer_t {
	sqfs_object_t base;

	/**
	 * @brief Submit a data block to a block writer.
	 *
	 * @memberof sqfs_block_writer_t
	 *
	 * If the @ref SQFS_BLK_FIRST_BLOCK flag is set, the data block writer
	 * memorizes the starting location and block index of the block. If the
	 * @ref SQFS_BLK_LAST_BLOCK flag is set, it uses those stored locations
	 * to do block deduplication.
	 *
	 * If the flag @ref SQFS_BLK_ALIGN is set in combination with the
	 * @ref SQFS_BLK_FIRST_BLOCK, the file size is padded to a multiple of
	 * the device block size before writing. If it is set together with the
	 * @ref SQFS_BLK_LAST_BLOCK flag, the padding is added afterwards.
	 *
	 * @param wr A pointer to a block writer.
	 * @param size The size of the block to write.
	 * @param checksum A 32 bit checksum of the block data.
	 * @param flags A combination of @ref SQFS_BLK_FLAGS flag bits
	 *              describing the block.
	 * @arapm data A pointer to the data to write.
	 * @param location Returns the location where the block has been
	 *        written. If the @ref SQFS_BLK_LAST_BLOCK flag was set,
	 *        deduplication is performed and this returns the (new) location
	 *        of the first block instead.
	 *
	 * @return Zero on success, an @ref SQFS_ERROR error on failure.
	 */
	int (*write_data_block)(sqfs_block_writer_t *wr, sqfs_u32 size,
				sqfs_u32 checksum, sqfs_u32 flags,
				const sqfs_u8 *data, sqfs_u64 *location);

	/**
	 * @brief Get the number of blocks actually written to disk.
	 *
	 * @memberof sqfs_block_writer_t
	 *
	 * @param wr A pointer to a block writer.
	 *
	 * @return The number of blocks written, excluding deduplicated blocks.
	 */
	sqfs_u64 (*get_block_count)(const sqfs_block_writer_t *wr);
};

#ifdef __cplusplus
extern "C" {
#endif

/**
 * @brief Create an instance of a default block writer implementation.
 *
 * @memberof sqfs_block_writer_t
 *
 * @param file A pointer to a file object that data should be appended to.
 * @param devblksz The underlying device block size if output data
 *                 should be aligned.
 * @param flags Currently must be set to 0 or creation will fail.
 *
 * @return A pointer to a new block writer on success, NULL on failure.
 */
SQFS_API sqfs_block_writer_t *sqfs_block_writer_create(sqfs_file_t *file,
						       size_t devblksz,
						       sqfs_u32 flags);

#ifdef __cplusplus
}
#endif

#endif /* SQFS_BLOCK_WRITER_H */