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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
|
/* SPDX-License-Identifier: LGPL-3.0-or-later */
/*
* block.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_H
#define SQFS_BLOCK_H
#include "sqfs/predef.h"
/**
* @file block.h
*
* @brief Contains the definition of the @ref sqfs_block_t data structure.
*/
/**
* @enum E_SQFS_BLK_FLAGS
*
* @brief Generic flags that tell the processor what to do with a block and
* flags that the processor sets when it is done with a block.
*/
typedef enum {
/**
* @brief Only calculate checksum, do NOT compress the data.
*/
SQFS_BLK_DONT_COMPRESS = 0x0001,
/**
* @brief Indicates that an equeued block is the first block of a file.
*/
SQFS_BLK_FIRST_BLOCK = 0x0002,
/**
* @brief Indicates that an equeued block is the last block of a file.
*/
SQFS_BLK_LAST_BLOCK = 0x0004,
/**
* @brief Allign the block on disk to device block size.
*
* If set in combination with @ref SQFS_BLK_FIRST_BLOCK, the output
* file is padded to a multiple of the device block size before writing
* the block.
*
* If used with @ref SQFS_BLK_LAST_BLOCK, the output file is padded
* after writing the block.
*/
SQFS_BLK_ALLIGN = 0x0008,
/**
* @brief Indicates that a block is a tail end of a file and the block
* processor should take care of fragment packing and accounting.
*/
SQFS_BLK_IS_FRAGMENT = 0x0010,
/**
* @brief Set by the block processor on fragment blocks that
* it generates.
*/
SQFS_BLK_FRAGMENT_BLOCK = 0x4000,
/**
* @brief Set by compressor worker if the block was actually compressed.
*/
SQFS_BLK_IS_COMPRESSED = 0x8000,
/**
* @brief The combination of all flags that are user settable.
*/
SQFS_BLK_USER_SETTABLE_FLAGS = 0x001F,
} E_SQFS_BLK_FLAGS;
/**
* @struct sqfs_block_t
*
* @brief Encapsulates a chunk of data to be processed by the block processor.
*/
struct sqfs_block_t {
/**
* @brief Used internally, existing value is ignored and overwritten
* when enqueueing a block.
*/
sqfs_block_t *next;
/**
* @brief Used internally, existing value is ignored and overwritten
* when enqueueing a block.
*/
uint32_t sequence_number;
/**
* @brief Size of the data area.
*/
uint32_t size;
/**
* @brief Checksum of the input data.
*/
uint32_t checksum;
/**
* @brief Data block index within the inode.
*/
uint32_t index;
/**
* @brief The squashfs inode related to this block.
*/
sqfs_inode_generic_t *inode;
/**
* @brief User settable flag field.
*
* A combination of @ref E_SQFS_BLK_FLAGS and custom, user
* settable flags.
*/
uint32_t flags;
/**
* @brief Raw data to be processed.
*/
uint8_t data[];
};
#endif /* SQFS_BLOCK_H */
|
