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
|
/* SPDX-License-Identifier: LGPL-3.0-or-later */
/*
* id_table.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_ID_TABLE_H
#define SQFS_ID_TABLE_H
#include "sqfs/predef.h"
/**
* @file id_table.h
*
* @brief Contains declarations for the @ref sqfs_id_table_t data structure.
*/
/**
* @struct sqfs_id_table_t
*
* @brief A simple data structure that encapsulates ID to index mapping for
* user and group IDs.
*
* SquashFS does not store user and group IDs in inodes directly. Instead, it
* collects the unique 32 bit IDs in a table with at most 64k entries and
* stores a 16 bit index into the inode. This allows SquashFS to only have 16
* bit UID/GID entries in the inodes but actually have 32 bit UIDs/GIDs under
* the hood (at least 64k selected ones).
*/
#ifdef __cplusplus
extern "C" {
#endif
/**
* @brief Create an ID table object.
*
* @memberof sqfs_id_table_t
*
* @return A pointer to an ID table object, NULL on allocation failure.
*/
SQFS_API sqfs_id_table_t *sqfs_id_table_create(void);
/**
* @brief Destroy an ID table object and free all memory used by it.
*
* @memberof sqfs_id_table_t
*
* @param tbl A pointer to an ID table object.
*/
SQFS_API void sqfs_id_table_destroy(sqfs_id_table_t *tbl);
/**
* @brief Resolve a 32 bit ID to a unique 16 bit index.
*
* @memberof sqfs_id_table_t
*
* @param tbl A pointer to an ID table object.
* @param id The ID to resolve.
* @param out Returns the unique table index.
*
* @return Zero on success, an @ref E_SQFS_ERROR on failure.
*/
SQFS_API int sqfs_id_table_id_to_index(sqfs_id_table_t *tbl, uint32_t id,
uint16_t *out);
/**
* @brief Write an ID table to disk.
*
* @memberof sqfs_id_table_t
*
* @param tbl A pointer to an ID table object.
* @param file The underlying file to append the table to.
* @param super A pointer to a super block in which to store the ID table
* start location.
* @param cmp A compressor to use to compress the ID table.
*
* @return Zero on success, an @ref E_SQFS_ERROR on failure.
*/
SQFS_API int sqfs_id_table_write(sqfs_id_table_t *tbl, sqfs_file_t *file,
sqfs_super_t *super, sqfs_compressor_t *cmp);
/**
* @brief Read an ID table from disk.
*
* @memberof sqfs_id_table_t
*
* @param tbl A pointer to an ID table object.
* @param file The underlying file to read the table from.
* @param super A pointer to a super block from which to get
* the ID table location.
* @param cmp A compressor to use to extract compressed table blocks.
*
* @return Zero on success, an @ref E_SQFS_ERROR on failure.
*/
SQFS_API int sqfs_id_table_read(sqfs_id_table_t *tbl, sqfs_file_t *file,
sqfs_super_t *super, sqfs_compressor_t *cmp);
/**
* @brief Resolve a 16 bit index to a 32 bit ID.
*
* @memberof sqfs_id_table_t
*
* @param tbl A pointer to an ID table object.
* @param index The table index to resolve.
* @param out Returns the underlying 32 bit ID that the index maps to.
*
* @return Zero on success, an @ref E_SQFS_ERROR on failure.
*/
SQFS_API int sqfs_id_table_index_to_id(const sqfs_id_table_t *tbl,
uint16_t index, uint32_t *out);
#ifdef __cplusplus
}
#endif
#endif /* SQFS_ID_TABLE_H */
|
