From 03ec75b9e6ad4cb372f86d1581c2b1b2ef987c72 Mon Sep 17 00:00:00 2001 From: Zhihao Cheng Date: Mon, 11 Nov 2024 16:36:33 +0800 Subject: ubifs-utils: Decouple mkfs.ubifs.h out of other modules Header file mkfs.ubifs.h is included in other modules(eg. compr.c, lpt.c, fscrypt.h, sign.c), decouple it out of other modules. There are two parts in mkfs.ubifs.h: 1. common functions, for example dbg_msg, err_msg and write_leb, move these functions into common/defs.h and common/ubifs.h. 2. devtable related definations, move them into a new header file common/devtable.h. Splitting common functions from mkfs.ubifs.h is also a preparation for importing libubifs(from linux kernel) to replace current UBIFS libs. Signed-off-by: Zhihao Cheng Signed-off-by: David Oberhollenzer --- ubifs-utils/Makemodule.am | 4 +- ubifs-utils/common/compr.c | 19 +++-- ubifs-utils/common/compr.h | 8 -- ubifs-utils/common/crypto.c | 6 +- ubifs-utils/common/defs.h | 24 ++++++ ubifs-utils/common/devtable.c | 9 +- ubifs-utils/common/devtable.h | 77 ++++++++++++++++++ ubifs-utils/common/fscrypt.c | 4 + ubifs-utils/common/fscrypt.h | 8 +- ubifs-utils/common/lpt.c | 10 ++- ubifs-utils/common/lpt.h | 2 + ubifs-utils/common/sign.c | 9 +- ubifs-utils/common/ubifs.h | 5 ++ ubifs-utils/mkfs.ubifs/mkfs.ubifs.c | 21 ++++- ubifs-utils/mkfs.ubifs/mkfs.ubifs.h | 158 ------------------------------------ 15 files changed, 174 insertions(+), 190 deletions(-) create mode 100644 ubifs-utils/common/devtable.h delete mode 100644 ubifs-utils/mkfs.ubifs/mkfs.ubifs.h diff --git a/ubifs-utils/Makemodule.am b/ubifs-utils/Makemodule.am index 4a617c1..8af65be 100644 --- a/ubifs-utils/Makemodule.am +++ b/ubifs-utils/Makemodule.am @@ -9,6 +9,7 @@ common_SOURCES = \ ubifs-utils/common/hashtable/hashtable_private.h \ ubifs-utils/common/hashtable/hashtable.c \ ubifs-utils/common/hashtable/hashtable_itr.c \ + ubifs-utils/common/devtable.h \ ubifs-utils/common/devtable.c \ ubifs-utils/common/ubifs.h \ ubifs-utils/common/key.h \ @@ -27,12 +28,11 @@ endif mkfs_ubifs_SOURCES = \ $(common_SOURCES) \ - ubifs-utils/mkfs.ubifs/mkfs.ubifs.h \ ubifs-utils/mkfs.ubifs/mkfs.ubifs.c mkfs_ubifs_LDADD = libmtd.a libubi.a $(ZLIB_LIBS) $(LZO_LIBS) $(ZSTD_LIBS) $(UUID_LIBS) $(LIBSELINUX_LIBS) $(OPENSSL_LIBS) -lm mkfs_ubifs_CPPFLAGS = $(AM_CPPFLAGS) $(ZLIB_CFLAGS) $(LZO_CFLAGS) $(ZSTD_CFLAGS) $(UUID_CFLAGS) $(LIBSELINUX_CFLAGS) \ - -I$(top_srcdir)/ubi-utils/include -I$(top_srcdir)/ubifs-utils/mkfs.ubifs/ -I$(top_srcdir)/ubifs-utils/common + -I$(top_srcdir)/ubi-utils/include -I$(top_srcdir)/ubifs-utils/common EXTRA_DIST += ubifs-utils/common/README diff --git a/ubifs-utils/common/compr.c b/ubifs-utils/common/compr.c index e4324f3..6f90151 100644 --- a/ubifs-utils/common/compr.c +++ b/ubifs-utils/common/compr.c @@ -39,11 +39,12 @@ #endif #include "compr.h" -#include "mkfs.ubifs.h" +#include "ubifs.h" static void *lzo_mem; static unsigned long long errcnt = 0; #ifdef WITH_LZO +extern struct ubifs_info info_; static struct ubifs_info *c = &info_; #endif @@ -181,12 +182,12 @@ static int favor_lzo_compress(void *in_buf, size_t in_len, void *out_buf, select_lzo: *out_len = lzo_len; - *type = MKFS_UBIFS_COMPR_LZO; + *type = UBIFS_COMPR_LZO; return 0; select_zlib: *out_len = zlib_len; - *type = MKFS_UBIFS_COMPR_ZLIB; + *type = UBIFS_COMPR_ZLIB; memcpy(out_buf, zlib_buf, zlib_len); return 0; } @@ -199,7 +200,7 @@ int compress_data(void *in_buf, size_t in_len, void *out_buf, size_t *out_len, if (in_len < UBIFS_MIN_COMPR_LEN) { no_compress(in_buf, in_len, out_buf, out_len); - return MKFS_UBIFS_COMPR_NONE; + return UBIFS_COMPR_NONE; } #if defined(WITH_LZO) && defined(WITH_ZLIB) @@ -211,21 +212,21 @@ int compress_data(void *in_buf, size_t in_len, void *out_buf, size_t *out_len, #endif switch (type) { #ifdef WITH_LZO - case MKFS_UBIFS_COMPR_LZO: + case UBIFS_COMPR_LZO: ret = lzo_compress(in_buf, in_len, out_buf, out_len); break; #endif #ifdef WITH_ZLIB - case MKFS_UBIFS_COMPR_ZLIB: + case UBIFS_COMPR_ZLIB: ret = zlib_deflate(in_buf, in_len, out_buf, out_len); break; #endif #ifdef WITH_ZSTD - case MKFS_UBIFS_COMPR_ZSTD: + case UBIFS_COMPR_ZSTD: ret = zstd_compress(in_buf, in_len, out_buf, out_len); break; #endif - case MKFS_UBIFS_COMPR_NONE: + case UBIFS_COMPR_NONE: ret = 1; break; default: @@ -236,7 +237,7 @@ int compress_data(void *in_buf, size_t in_len, void *out_buf, size_t *out_len, } if (ret || *out_len >= in_len) { no_compress(in_buf, in_len, out_buf, out_len); - return MKFS_UBIFS_COMPR_NONE; + return UBIFS_COMPR_NONE; } return type; } diff --git a/ubifs-utils/common/compr.h b/ubifs-utils/common/compr.h index d58c7c7..3e8e9b6 100644 --- a/ubifs-utils/common/compr.h +++ b/ubifs-utils/common/compr.h @@ -31,14 +31,6 @@ */ #define WORST_COMPR_FACTOR 4 -enum compression_type -{ - MKFS_UBIFS_COMPR_NONE, - MKFS_UBIFS_COMPR_LZO, - MKFS_UBIFS_COMPR_ZLIB, - MKFS_UBIFS_COMPR_ZSTD, -}; - int compress_data(void *in_buf, size_t in_len, void *out_buf, size_t *out_len, int type); int init_compression(void); diff --git a/ubifs-utils/common/crypto.c b/ubifs-utils/common/crypto.c index 19c445e..60a67a4 100644 --- a/ubifs-utils/common/crypto.c +++ b/ubifs-utils/common/crypto.c @@ -17,14 +17,16 @@ * Authors: David Oberhollenzer */ -#define PROGRAM_NAME "mkfs.ubifs" #include #include +#include #include #include -#include "fscrypt.h" +#define PROGRAM_NAME "mkfs.ubifs" #include "common.h" +#include "defs.h" +#include "fscrypt.h" static int do_hash(const EVP_MD *md, const unsigned char *in, size_t len, unsigned char *out) { diff --git a/ubifs-utils/common/defs.h b/ubifs-utils/common/defs.h index 8db5277..e1aded0 100644 --- a/ubifs-utils/common/defs.h +++ b/ubifs-utils/common/defs.h @@ -6,6 +6,30 @@ #ifndef __UBIFS_DEFS_H__ #define __UBIFS_DEFS_H__ +#include +#include +#include +#include +#include + +extern int debug_level; + +#define dbg_msg(lvl, fmt, ...) do {if (debug_level >= lvl) \ + printf("mkfs.ubifs: %s: " fmt "\n", __FUNCTION__, ##__VA_ARGS__); \ +} while(0) + +#define err_msg(fmt, ...) ({ \ + fprintf(stderr, "Error: " fmt "\n", ##__VA_ARGS__); \ + -1; \ +}) + +#define sys_err_msg(fmt, ...) ({ \ + int err_ = errno; \ + fprintf(stderr, "Error: " fmt "\n", ##__VA_ARGS__); \ + fprintf(stderr, " %s (error %d)\n", strerror(err_), err_); \ + -1; \ +}) + #define t16(x) ({ \ uint16_t __b = (x); \ (__LITTLE_ENDIAN==__BYTE_ORDER) ? __b : bswap_16(__b); \ diff --git a/ubifs-utils/common/devtable.c b/ubifs-utils/common/devtable.c index aa815fb..2b9c6ef 100644 --- a/ubifs-utils/common/devtable.c +++ b/ubifs-utils/common/devtable.c @@ -45,7 +45,14 @@ * for more information about what the device table is. */ -#include "mkfs.ubifs.h" +#include +#include +#include +#include +#include + +#include "devtable.h" +#include "defs.h" #include "hashtable/hashtable.h" #include "hashtable/hashtable_itr.h" diff --git a/ubifs-utils/common/devtable.h b/ubifs-utils/common/devtable.h new file mode 100644 index 0000000..97585f2 --- /dev/null +++ b/ubifs-utils/common/devtable.h @@ -0,0 +1,77 @@ +/* + * Copyright (C) 2008 Nokia Corporation. + * Copyright (C) 2008 University of Szeged, Hungary + * + * This program is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 as published by + * the Free Software Foundation. + * + * 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 General Public License along with + * this program; if not, write to the Free Software Foundation, Inc., 51 + * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA + * + * Authors: Artem Bityutskiy + * Adrian Hunter + * Zoltan Sogor + */ + +#ifndef __DEVTABLE_H__ +#define __DEVTABLE_H__ + +/** + * struct path_htbl_element - an element of the path hash table. + * @path: the UBIFS path the element describes (the key of the element) + * @name_htbl: one more (nested) hash table containing names of all + * files/directories/device nodes which should be created at this + * path + * + * See device table handling for more information. + */ +struct path_htbl_element { + const char *path; + struct hashtable *name_htbl; +}; + +/** + * struct name_htbl_element - an element in the name hash table + * @name: name of the file/directory/device node (the key of the element) + * @mode: accsess rights and file type + * @uid: user ID + * @gid: group ID + * @major: device node major number + * @minor: device node minor number + * + * This is an element of the name hash table. Name hash table sits in the path + * hash table elements and describes file names which should be created/changed + * at this path. + */ +struct name_htbl_element { + const char *name; + unsigned int mode; + unsigned int uid; + unsigned int gid; + dev_t dev; +}; + +struct hashtable_itr; + +int parse_devtable(const char *tbl_file); +struct path_htbl_element *devtbl_find_path(const char *path); +struct name_htbl_element *devtbl_find_name(struct path_htbl_element *ph_elt, + const char *name); +int override_attributes(struct stat *st, struct path_htbl_element *ph_elt, + struct name_htbl_element *nh_elt); +struct name_htbl_element * +first_name_htbl_element(struct path_htbl_element *ph_elt, + struct hashtable_itr **itr); +struct name_htbl_element * +next_name_htbl_element(struct path_htbl_element *ph_elt, + struct hashtable_itr **itr); +void free_devtable_info(void); + +#endif diff --git a/ubifs-utils/common/fscrypt.c b/ubifs-utils/common/fscrypt.c index b75bdf7..94c6c37 100644 --- a/ubifs-utils/common/fscrypt.c +++ b/ubifs-utils/common/fscrypt.c @@ -18,8 +18,12 @@ * David Oberhollenzer */ +#include + #define PROGRAM_NAME "mkfs.ubifs" +#include "common.h" #include "fscrypt.h" +#include "defs.h" static __u8 fscrypt_masterkey[FS_MAX_KEY_SIZE]; diff --git a/ubifs-utils/common/fscrypt.h b/ubifs-utils/common/fscrypt.h index ff3d326..908a504 100644 --- a/ubifs-utils/common/fscrypt.h +++ b/ubifs-utils/common/fscrypt.h @@ -21,9 +21,11 @@ #ifndef FSCRYPT_H #define FSCRYPT_H - -#include "mkfs.ubifs.h" -#include +#ifdef WITH_CRYPTO +#include +#endif +#include +#include "ubifs.h" #include "crypto.h" #ifndef FS_KEY_DESCRIPTOR_SIZE diff --git a/ubifs-utils/common/lpt.c b/ubifs-utils/common/lpt.c index 7ee739a..23ffe7f 100644 --- a/ubifs-utils/common/lpt.c +++ b/ubifs-utils/common/lpt.c @@ -20,12 +20,18 @@ * Artem Bityutskiy */ -#include "mkfs.ubifs.h" - #ifdef WITH_CRYPTO #include #endif +#define PROGRAM_NAME "mkfs.ubifs" +#include "common.h" +#include "lpt.h" +#include "defs.h" +#include "ubifs.h" +#include "crc16.h" +#include "sign.h" + /** * do_calc_lpt_geom - calculate sizes for the LPT area. * @c: the UBIFS file-system description object diff --git a/ubifs-utils/common/lpt.h b/ubifs-utils/common/lpt.h index 4cde59d..86148a2 100644 --- a/ubifs-utils/common/lpt.h +++ b/ubifs-utils/common/lpt.h @@ -22,6 +22,8 @@ #ifndef __UBIFS_LPT_H__ #define __UBIFS_LPT_H__ +#include "ubifs.h" + int calc_dflt_lpt_geom(struct ubifs_info *c, int *main_lebs, int *big_lpt); int create_lpt(struct ubifs_info *c); diff --git a/ubifs-utils/common/sign.c b/ubifs-utils/common/sign.c index 7f284f8..93399ff 100644 --- a/ubifs-utils/common/sign.c +++ b/ubifs-utils/common/sign.c @@ -17,9 +17,7 @@ * Author: Sascha Hauer */ -#include "mkfs.ubifs.h" -#include "common.h" - +#include #include #include #include @@ -30,6 +28,11 @@ #include #include +#include "sign.h" +#include "defs.h" +#include "ubifs.h" + +extern struct ubifs_info info_; static struct ubifs_info *c = &info_; EVP_MD_CTX *hash_md; diff --git a/ubifs-utils/common/ubifs.h b/ubifs-utils/common/ubifs.h index 55937ce..0eef31a 100644 --- a/ubifs-utils/common/ubifs.h +++ b/ubifs-utils/common/ubifs.h @@ -25,6 +25,9 @@ #ifndef __UBIFS_H__ #define __UBIFS_H__ +#include +#include "libubi.h" + /* Maximum logical eraseblock size in bytes */ #define UBIFS_MAX_LEB_SZ (2*1024*1024) @@ -468,4 +471,6 @@ struct ubifs_branch *ubifs_idx_branch(const struct ubifs_info *c, (UBIFS_BRANCH_SZ + c->key_len + c->hash_len) * bnum); } +int write_leb(int lnum, int len, void *buf); + #endif /* __UBIFS_H__ */ diff --git a/ubifs-utils/mkfs.ubifs/mkfs.ubifs.c b/ubifs-utils/mkfs.ubifs/mkfs.ubifs.c index f4cb512..0304ae7 100644 --- a/ubifs-utils/mkfs.ubifs/mkfs.ubifs.c +++ b/ubifs-utils/mkfs.ubifs/mkfs.ubifs.c @@ -22,10 +22,17 @@ #define _XOPEN_SOURCE 500 /* For realpath() */ -#include "mkfs.ubifs.h" +#include +#include +#include +#include +#include #include -#include "common.h" +#include +#include #include +#include +#include #ifdef WITH_XATTR #include #endif @@ -39,8 +46,18 @@ #include #endif +/* common.h requires the PROGRAM_NAME macro */ +#define PROGRAM_NAME "mkfs.ubifs" +#include "common.h" +#include "defs.h" #include "crypto.h" #include "fscrypt.h" +#include "ubifs.h" +#include "lpt.h" +#include "compr.h" +#include "key.h" +#include "sign.h" +#include "devtable.h" /* Size (prime number) of hash table for link counting */ #define HASH_TABLE_SIZE 10099 diff --git a/ubifs-utils/mkfs.ubifs/mkfs.ubifs.h b/ubifs-utils/mkfs.ubifs/mkfs.ubifs.h deleted file mode 100644 index 5690984..0000000 --- a/ubifs-utils/mkfs.ubifs/mkfs.ubifs.h +++ /dev/null @@ -1,158 +0,0 @@ -/* - * Copyright (C) 2008 Nokia Corporation. - * Copyright (C) 2008 University of Szeged, Hungary - * - * This program is free software; you can redistribute it and/or modify it - * under the terms of the GNU General Public License version 2 as published by - * the Free Software Foundation. - * - * 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 General Public License along with - * this program; if not, write to the Free Software Foundation, Inc., 51 - * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA - * - * Authors: Artem Bityutskiy - * Adrian Hunter - * Zoltan Sogor - */ - -#ifndef __MKFS_UBIFS_H__ -#define __MKFS_UBIFS_H__ - -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include - -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include - -#ifdef WITH_CRYPTO -#include -#endif - -#include - -/* common.h requires the PROGRAM_NAME macro */ -#define PROGRAM_NAME "mkfs.ubifs" -#include "common.h" - -#include "libubi.h" -#include "defs.h" -#include "crc16.h" -#include "ubifs.h" -#include "key.h" -#include "lpt.h" -#include "compr.h" -#include "sign.h" - -/* - * Compression flags are duplicated so that compr.c can compile without ubifs.h. - * Here we make sure they are the same. - */ -#if MKFS_UBIFS_COMPR_NONE != UBIFS_COMPR_NONE -#error MKFS_UBIFS_COMPR_NONE != UBIFS_COMPR_NONE -#endif -#if MKFS_UBIFS_COMPR_LZO != UBIFS_COMPR_LZO -#error MKFS_UBIFS_COMPR_LZO != UBIFS_COMPR_LZO -#endif -#if MKFS_UBIFS_COMPR_ZLIB != UBIFS_COMPR_ZLIB -#error MKFS_UBIFS_COMPR_ZLIB != UBIFS_COMPR_ZLIB -#endif -#if MKFS_UBIFS_COMPR_ZSTD != UBIFS_COMPR_ZSTD -#error MKFS_UBIFS_COMPR_ZSTD != UBIFS_COMPR_ZSTD -#endif - -extern int verbose; -extern int debug_level; - -#define dbg_msg(lvl, fmt, ...) do {if (debug_level >= lvl) \ - printf("mkfs.ubifs: %s: " fmt "\n", __FUNCTION__, ##__VA_ARGS__); \ -} while(0) - -#define err_msg(fmt, ...) ({ \ - fprintf(stderr, "Error: " fmt "\n", ##__VA_ARGS__); \ - -1; \ -}) - -#define sys_err_msg(fmt, ...) ({ \ - int err_ = errno; \ - fprintf(stderr, "Error: " fmt "\n", ##__VA_ARGS__); \ - fprintf(stderr, " %s (error %d)\n", strerror(err_), err_); \ - -1; \ -}) - -/** - * struct path_htbl_element - an element of the path hash table. - * @path: the UBIFS path the element describes (the key of the element) - * @name_htbl: one more (nested) hash table containing names of all - * files/directories/device nodes which should be created at this - * path - * - * See device table handling for more information. - */ -struct path_htbl_element { - const char *path; - struct hashtable *name_htbl; -}; - -/** - * struct name_htbl_element - an element in the name hash table - * @name: name of the file/directory/device node (the key of the element) - * @mode: accsess rights and file type - * @uid: user ID - * @gid: group ID - * @major: device node major number - * @minor: device node minor number - * - * This is an element of the name hash table. Name hash table sits in the path - * hash table elements and describes file names which should be created/changed - * at this path. - */ -struct name_htbl_element { - const char *name; - unsigned int mode; - unsigned int uid; - unsigned int gid; - dev_t dev; -}; - -extern struct ubifs_info info_; - -struct hashtable_itr; - -int write_leb(int lnum, int len, void *buf); -int parse_devtable(const char *tbl_file); -struct path_htbl_element *devtbl_find_path(const char *path); -struct name_htbl_element *devtbl_find_name(struct path_htbl_element *ph_elt, - const char *name); -int override_attributes(struct stat *st, struct path_htbl_element *ph_elt, - struct name_htbl_element *nh_elt); -struct name_htbl_element * -first_name_htbl_element(struct path_htbl_element *ph_elt, - struct hashtable_itr **itr); -struct name_htbl_element * -next_name_htbl_element(struct path_htbl_element *ph_elt, - struct hashtable_itr **itr); -void free_devtable_info(void); - -#endif -- cgit v1.2.3