diff options
| -rw-r--r-- | Makefile.am | 2 | ||||
| -rw-r--r-- | include/common.h | 1 | ||||
| -rw-r--r-- | include/dir_tree.h | 180 | ||||
| -rw-r--r-- | include/sqfs/dir_reader.h | 162 | ||||
| -rw-r--r-- | lib/common/Makemodule.am | 10 | ||||
| -rw-r--r-- | lib/common/src/dir_tree.c (renamed from lib/sqfs/src/dir_reader/get_path.c) | 25 | ||||
| -rw-r--r-- | lib/common/src/read_tree.c (renamed from lib/sqfs/src/dir_reader/read_tree.c) | 27 | ||||
| -rw-r--r-- | lib/common/test/get_node_path.c (renamed from lib/sqfs/test/get_node_path.c) | 1 | ||||
| -rw-r--r-- | lib/sqfs/Makemodule.am | 6 |
9 files changed, 218 insertions, 196 deletions
diff --git a/Makefile.am b/Makefile.am index 141973e..ab960c5 100644 --- a/Makefile.am +++ b/Makefile.am @@ -40,7 +40,7 @@ include bin/sqfs2tar/Makemodule.am include bin/sqfsdiff/Makemodule.am include bin/tar2sqfs/Makemodule.am -include extras/Makemodule.am +#include extras/Makemodule.am if HAVE_DOXYGEN @DX_RULES@ diff --git a/include/common.h b/include/common.h index bf3f34c..ca95ba6 100644 --- a/include/common.h +++ b/include/common.h @@ -21,6 +21,7 @@ #include "simple_writer.h" #include "compress_cli.h" +#include "dir_tree.h" #include "io/std.h" #include "compat.h" #include "fstree.h" diff --git a/include/dir_tree.h b/include/dir_tree.h new file mode 100644 index 0000000..ee630d5 --- /dev/null +++ b/include/dir_tree.h @@ -0,0 +1,180 @@ +/* SPDX-License-Identifier: GPL-3.0-or-later */ +/* + * dir_tree.h + * + * Copyright (C) 2019 David Oberhollenzer <goliath@infraroot.at> + */ +#ifndef DIR_TREE_H +#define DIR_TREE_H + +/** + * @enum SQFS_TREE_FILTER_FLAGS + * + * @brief Filter flags for @ref sqfs_dir_reader_get_full_hierarchy + */ +typedef enum { + /** + * @brief Omit device special files from the final tree. + */ + SQFS_TREE_NO_DEVICES = 0x01, + + /** + * @brief Omit socket files from the final tree. + */ + SQFS_TREE_NO_SOCKETS = 0x02, + + /** + * @brief Omit named pipes from the final tree. + */ + SQFS_TREE_NO_FIFO = 0x04, + + /** + * @brief Omit symbolic links from the final tree. + */ + SQFS_TREE_NO_SLINKS = 0x08, + + /** + * @brief Omit empty directories from the final tree. + * + * If a directory is not empty on-disk, but ends up empty after + * applying all the other filter rules, it is also omitted. + */ + SQFS_TREE_NO_EMPTY = 0x10, + + /** + * @brief Do not recurse into sub directories. + * + * If the start node is a directory, the tree deserializer will still + * recurse into it, but it will not go beyond that. + */ + SQFS_TREE_NO_RECURSE = 0x20, + + /** + * @brief Store the list of parent nodes all the way to the target node + * + * When traversing towards the selected node, also collect the chain + * of parent nodes with the subtree stored at the end. + */ + SQFS_TREE_STORE_PARENTS = 0x40, + + SQFS_TREE_ALL_FLAGS = 0x7F, +} SQFS_TREE_FILTER_FLAGS; + +/** + * @struct sqfs_tree_node_t + * + * @brief Encapsulates a node in the filesystem tree read by + * @ref sqfs_dir_reader_get_full_hierarchy. + */ +struct sqfs_tree_node_t { + /** + * @brief Pointer to parent, NULL for the root node + */ + sqfs_tree_node_t *parent; + + /** + * @brief For directories, a linked list of children. + */ + sqfs_tree_node_t *children; + + /** + * @brief Linked list next pointer for children list. + */ + sqfs_tree_node_t *next; + + /** + * @brief Inode representing this element in the tree. + */ + sqfs_inode_generic_t *inode; + + /** + * @brief Resolved 32 bit user ID from the inode + */ + sqfs_u32 uid; + + /** + * @brief Resolved 32 bit group ID from the inode + */ + sqfs_u32 gid; + + /** + * @brief null-terminated entry name. + */ + sqfs_u8 name[]; +}; + +#ifdef __cplusplus +extern "C" { +#endif + +/** + * @brief Recursively destroy a tree of @ref sqfs_tree_node_t nodes + * + * This function can be used to clean up after + * @ref sqfs_dir_reader_get_full_hierarchy. + * + * @param root A pointer to the root node or NULL. + */ +SQFS_INTERNAL void sqfs_dir_tree_destroy(sqfs_tree_node_t *root); + +/** + * @brief Recursively destroy a tree of @ref sqfs_tree_node_t nodes + * + * @memberof sqfs_tree_node_t + * + * This function can be used to assemble an absolute path from a tree + * node returned by @ref sqfs_dir_reader_get_full_hierarchy. + * + * The function recursively walks up the tree to assemble a path string. It + * returns "/" for the root node and assembles paths beginning with "/" for + * non-root nodes. The resulting path is slash separated, but (except for + * the root) never ends with a slash. + * + * While walking the node list, the function enforces various invariantes. It + * returns @ref SQFS_ERROR_LINK_LOOP if the list of parent pointers is cyclical, + * @ref SQFS_ERROR_CORRUPTED if any node has an empty name, or a name that + * contains '/' or equals ".." or ".". The function + * returns @ref SQFS_ERROR_ARG_INVALID if given NULL node or the root has a name + * set. Additionally, the function can return overflow or allocation failures + * while constructing the path. + * + * The returned string needs to be free'd with @ref sqfs_free. + * + * @param node A pointer to a tree node. + * @param out Returns a pointer to a string on success, set to NULL on failure. + * + * @return Zero on success, an @ref SQFS_ERROR value on failure. + */ +SQFS_INTERNAL int sqfs_tree_node_get_path(const sqfs_tree_node_t *node, + char **out); + +/** + * @brief High level helper function for deserializing the entire file system + * hierarchy into an in-memory tree structure. + * + * @memberof sqfs_dir_reader_t + * + * This function internally navigates to a specified inode using + * @ref sqfs_dir_reader_find_by_path and starting from that recursively + * deserializes the entire hierarchy into a tree structure holding all inodes. + * + * @param rd A pointer to a directory reader. + * @param path A path to resolve into an inode. Forward or backward slashes can + * be used to separate path components. Resolving '.' or '..' is + * not supported. Can be set to NULL to get the root inode. + * @param flags A combination of @ref SQFS_TREE_FILTER_FLAGS flags. + * @param out Returns the top most tree node. + * + * @return Zero on success, an @ref SQFS_ERROR value on failure. + */ +SQFS_INTERNAL int sqfs_dir_reader_get_full_hierarchy(sqfs_dir_reader_t *rd, + const sqfs_id_table_t *idtbl, + const char *path, + sqfs_u32 flags, + sqfs_tree_node_t **out); + +#ifdef __cplusplus +} +#endif + +#endif /* DIR_TREE_H */ diff --git a/include/sqfs/dir_reader.h b/include/sqfs/dir_reader.h index 1489a1f..cb071c2 100644 --- a/include/sqfs/dir_reader.h +++ b/include/sqfs/dir_reader.h @@ -53,102 +53,6 @@ */ /** - * @enum SQFS_TREE_FILTER_FLAGS - * - * @brief Filter flags for @ref sqfs_dir_reader_get_full_hierarchy - */ -typedef enum { - /** - * @brief Omit device special files from the final tree. - */ - SQFS_TREE_NO_DEVICES = 0x01, - - /** - * @brief Omit socket files from the final tree. - */ - SQFS_TREE_NO_SOCKETS = 0x02, - - /** - * @brief Omit named pipes from the final tree. - */ - SQFS_TREE_NO_FIFO = 0x04, - - /** - * @brief Omit symbolic links from the final tree. - */ - SQFS_TREE_NO_SLINKS = 0x08, - - /** - * @brief Omit empty directories from the final tree. - * - * If a directory is not empty on-disk, but ends up empty after - * applying all the other filter rules, it is also omitted. - */ - SQFS_TREE_NO_EMPTY = 0x10, - - /** - * @brief Do not recurse into sub directories. - * - * If the start node is a directory, the tree deserializer will still - * recurse into it, but it will not go beyond that. - */ - SQFS_TREE_NO_RECURSE = 0x20, - - /** - * @brief Store the list of parent nodes all the way to the target node - * - * When traversing towards the selected node, also collect the chain - * of parent nodes with the subtree stored at the end. - */ - SQFS_TREE_STORE_PARENTS = 0x40, - - SQFS_TREE_ALL_FLAGS = 0x7F, -} SQFS_TREE_FILTER_FLAGS; - -/** - * @struct sqfs_tree_node_t - * - * @brief Encapsulates a node in the filesystem tree read by - * @ref sqfs_dir_reader_get_full_hierarchy. - */ -struct sqfs_tree_node_t { - /** - * @brief Pointer to parent, NULL for the root node - */ - sqfs_tree_node_t *parent; - - /** - * @brief For directories, a linked list of children. - */ - sqfs_tree_node_t *children; - - /** - * @brief Linked list next pointer for children list. - */ - sqfs_tree_node_t *next; - - /** - * @brief Inode representing this element in the tree. - */ - sqfs_inode_generic_t *inode; - - /** - * @brief Resolved 32 bit user ID from the inode - */ - sqfs_u32 uid; - - /** - * @brief Resolved 32 bit group ID from the inode - */ - sqfs_u32 gid; - - /** - * @brief null-terminated entry name. - */ - sqfs_u8 name[]; -}; - -/** * @enum SQFS_DIR_READER_FLAGS * * @brief Flags for @ref sqfs_dir_reader_create @@ -348,72 +252,6 @@ SQFS_API int sqfs_dir_reader_find_by_path(sqfs_dir_reader_t *rd, const char *path, sqfs_inode_generic_t **out); -/** - * @brief High level helper function for deserializing the entire file system - * hierarchy into an in-memory tree structure. - * - * @memberof sqfs_dir_reader_t - * - * This function internally navigates to a specified inode using - * @ref sqfs_dir_reader_find_by_path and starting from that recursively - * deserializes the entire hierarchy into a tree structure holding all inodes. - * - * @param rd A pointer to a directory reader. - * @param path A path to resolve into an inode. Forward or backward slashes can - * be used to separate path components. Resolving '.' or '..' is - * not supported. Can be set to NULL to get the root inode. - * @param flags A combination of @ref SQFS_TREE_FILTER_FLAGS flags. - * @param out Returns the top most tree node. - * - * @return Zero on success, an @ref SQFS_ERROR value on failure. - */ -SQFS_API int sqfs_dir_reader_get_full_hierarchy(sqfs_dir_reader_t *rd, - const sqfs_id_table_t *idtbl, - const char *path, - sqfs_u32 flags, - sqfs_tree_node_t **out); - -/** - * @brief Recursively destroy a tree of @ref sqfs_tree_node_t nodes - * - * This function can be used to clean up after - * @ref sqfs_dir_reader_get_full_hierarchy. - * - * @param root A pointer to the root node or NULL. - */ -SQFS_API void sqfs_dir_tree_destroy(sqfs_tree_node_t *root); - -/** - * @brief Recursively destroy a tree of @ref sqfs_tree_node_t nodes - * - * @memberof sqfs_tree_node_t - * - * This function can be used to assemble an absolute path from a tree - * node returned by @ref sqfs_dir_reader_get_full_hierarchy. - * - * The function recursively walks up the tree to assemble a path string. It - * returns "/" for the root node and assembles paths beginning with "/" for - * non-root nodes. The resulting path is slash separated, but (except for - * the root) never ends with a slash. - * - * While walking the node list, the function enforces various invariantes. It - * returns @ref SQFS_ERROR_LINK_LOOP if the list of parent pointers is cyclical, - * @ref SQFS_ERROR_CORRUPTED if any node has an empty name, or a name that - * contains '/' or equals ".." or ".". The function - * returns @ref SQFS_ERROR_ARG_INVALID if given NULL node or the root has a name - * set. Additionally, the function can return overflow or allocation failures - * while constructing the path. - * - * The returned string needs to be free'd with @ref sqfs_free. - * - * @param node A pointer to a tree node. - * @param out Returns a pointer to a string on success, set to NULL on failure. - * - * @return Zero on success, an @ref SQFS_ERROR value on failure. - */ -SQFS_API int sqfs_tree_node_get_path(const sqfs_tree_node_t *node, - char **out); - #ifdef __cplusplus } #endif diff --git a/lib/common/Makemodule.am b/lib/common/Makemodule.am index a50ddcb..5549cc3 100644 --- a/lib/common/Makemodule.am +++ b/lib/common/Makemodule.am @@ -1,11 +1,12 @@ libcommon_a_SOURCES = include/common.h include/simple_writer.h \ - include/compress_cli.h \ + include/compress_cli.h include/dir_tree.h \ lib/common/src/hardlink.c lib/common/src/print_version.c \ lib/common/src/compress.c lib/common/src/comp_opt.c \ lib/common/src/parse_size.c lib/common/src/print_size.c \ lib/common/src/writer/init.c lib/common/src/writer/cleanup.c \ lib/common/src/writer/serialize_fstree.c lib/common/src/writer/finish.c\ - lib/common/src/fstree_cli.c lib/common/src/perror.c + lib/common/src/fstree_cli.c lib/common/src/perror.c \ + lib/common/src/dir_tree.c lib/common/src/read_tree.c libcommon_a_CFLAGS = $(AM_CFLAGS) $(LZO_CFLAGS) if WITH_LZO @@ -17,8 +18,11 @@ noinst_LIBRARIES += libcommon.a test_fstree_cli_SOURCES = lib/common/test/fstree_cli.c test_fstree_cli_LDADD = libcommon.a libio.a libutil.a libcompat.a +test_get_node_path_SOURCES = lib/common/test/get_node_path.c +test_get_node_path_LDADD = libcommon.a libsquashfs.la libcompat.a + LIBCOMMON_TESTS = \ - test_fstree_cli + test_fstree_cli test_get_node_path check_PROGRAMS += $(LIBCOMMON_TESTS) TESTS += $(LIBCOMMON_TESTS) diff --git a/lib/sqfs/src/dir_reader/get_path.c b/lib/common/src/dir_tree.c index 847bfd3..1d778a2 100644 --- a/lib/sqfs/src/dir_reader/get_path.c +++ b/lib/common/src/dir_tree.c @@ -1,15 +1,32 @@ -/* SPDX-License-Identifier: LGPL-3.0-or-later */ +/* SPDX-License-Identifier: GPL-3.0-or-later */ /* - * get_path.c + * dir_tree.c * * Copyright (C) 2019 David Oberhollenzer <goliath@infraroot.at> */ -#define SQFS_BUILDING_DLL -#include "internal.h" +#include "common.h" #include <string.h> #include <stdlib.h> +void sqfs_dir_tree_destroy(sqfs_tree_node_t *root) +{ + sqfs_tree_node_t *it; + + if (!root) + return; + + while (root->children != NULL) { + it = root->children; + root->children = it->next; + + sqfs_dir_tree_destroy(it); + } + + free(root->inode); + free(root); +} + int sqfs_tree_node_get_path(const sqfs_tree_node_t *node, char **out) { const sqfs_tree_node_t *it; diff --git a/lib/sqfs/src/dir_reader/read_tree.c b/lib/common/src/read_tree.c index 7d6bf67..5d089e5 100644 --- a/lib/sqfs/src/dir_reader/read_tree.c +++ b/lib/common/src/read_tree.c @@ -1,11 +1,14 @@ -/* SPDX-License-Identifier: LGPL-3.0-or-later */ +/* SPDX-License-Identifier: GPL-3.0-or-later */ /* * read_tree.c * * Copyright (C) 2019 David Oberhollenzer <goliath@infraroot.at> */ -#define SQFS_BUILDING_DLL -#include "internal.h" +#include "util/util.h" +#include "common.h" + +#include <string.h> +#include <stdlib.h> static int should_skip(int type, unsigned int flags) { @@ -163,24 +166,6 @@ static int resolve_ids(sqfs_tree_node_t *root, const sqfs_id_table_t *idtbl) &root->gid); } -void sqfs_dir_tree_destroy(sqfs_tree_node_t *root) -{ - sqfs_tree_node_t *it; - - if (!root) - return; - - while (root->children != NULL) { - it = root->children; - root->children = it->next; - - sqfs_dir_tree_destroy(it); - } - - free(root->inode); - free(root); -} - int sqfs_dir_reader_get_full_hierarchy(sqfs_dir_reader_t *rd, const sqfs_id_table_t *idtbl, const char *path, unsigned int flags, diff --git a/lib/sqfs/test/get_node_path.c b/lib/common/test/get_node_path.c index c76cc1c..b02689f 100644 --- a/lib/sqfs/test/get_node_path.c +++ b/lib/common/test/get_node_path.c @@ -10,6 +10,7 @@ #include "sqfs/dir_reader.h" #include "sqfs/error.h" +#include "dir_tree.h" int main(int argc, char **argv) { diff --git a/lib/sqfs/Makemodule.am b/lib/sqfs/Makemodule.am index 3d61cd5..00105e8 100644 --- a/lib/sqfs/Makemodule.am +++ b/lib/sqfs/Makemodule.am @@ -19,7 +19,6 @@ libsquashfs_la_SOURCES = $(LIBSQFS_HEARDS) lib/sqfs/src/id_table.c \ lib/sqfs/src/dir_writer.c lib/sqfs/src/xattr/xattr_reader.c \ lib/sqfs/src/read_table.c lib/sqfs/src/comp/compressor.c \ lib/sqfs/src/comp/internal.h lib/sqfs/src/dir_reader/dir_reader.c \ - lib/sqfs/src/dir_reader/read_tree.c lib/sqfs/src/dir_reader/get_path.c \ lib/sqfs/src/dir_reader/internal.h lib/sqfs/src/inode.c \ lib/sqfs/src/xattr/xattr_writer.c \ lib/sqfs/src/xattr/xattr_writer_flush.c \ @@ -125,9 +124,6 @@ test_xattr_writer_LDADD = libsquashfs.la libcompat.a xattr_benchmark_SOURCES = lib/sqfs/test/xattr_benchmark.c xattr_benchmark_LDADD = libcommon.a libsquashfs.la libcompat.a -test_get_node_path_SOURCES = lib/sqfs/test/get_node_path.c -test_get_node_path_LDADD = libcommon.a libsquashfs.la libcompat.a - test_istream_read_SOURCES = lib/sqfs/test/istream_read.c test_istream_read_LDADD = libio.a libsquashfs.la libutil.a libcompat.a @@ -144,7 +140,7 @@ test_hl_dir_SOURCES = lib/sqfs/test/hl_dir.c test_hl_dir_LDADD = libsquashfs.la libio.a libutil.a libcompat.a LIBSQFS_TESTS = \ - test_abi test_xattr test_table test_xattr_writer test_get_node_path \ + test_abi test_xattr test_table test_xattr_writer \ test_istream_read test_istream_skip test_stream_splice test_rec_dir \ test_hl_dir noinst_PROGRAMS += xattr_benchmark |