fs/ntfs3: Refactor header includes
v2 cover fs/ntfs3: Refactor header includes
Right now header includes are big mess with ntfs3 imo. We cannot example include ntfs3 headers without need of punch of includes to source file. This patch set try to address that. When this patch series is applied we can include any header file without need of include anything else. This does not mean source file should rely what header file includes. Instead it should include them by self also if it needs them.
When some include is added I have write why this is needed to commit message. Hopefully this will help when someone wants to correct them again. I have also just delete unnecessary headers from some .c files and not added what is needed. Usually deleted headers where there because ntfs_fs.h need them not file itself. When file was simple enough I added all necessary linux headers.
I did not add linux/headers to all files yet. That is big job. This is good starting point. I did try to build every file itself so this will build like it should.
Please do not hesitate to tell if there is something wrong with this series or somethings could be done better.
V2:
Add missing first patch
Rebase
Use base-commit with format-patch
Kari Argillander (8):
fs/ntfs3. Add forward declarations for structs to debug.h fs/ntfs3: Add missing header files to ntfs.h
fs/ntfs3: Add missing headers and forward declarations to ntfs_fs.h fs/ntfs3: Add missing header and guards to lib/ headers fs/ntfs3: Change right headers to bitfunc.c
fs/ntfs3: Change right headers to upcase.c
fs/ntfs3: Change right headers to lznt.c
fs/ntfs3: Remove unneeded header files from c files
fs/ntfs3/attrib.c | 5 ----- fs/ntfs3/attrlist.c | 3 --- fs/ntfs3/bitfunc.c | 7 +------ fs/ntfs3/bitmap.c | 3 --- fs/ntfs3/debug.h | 3 +++ fs/ntfs3/dir.c | 3 --- fs/ntfs3/file.c | 1 - fs/ntfs3/frecord.c | 3 --- fs/ntfs3/fslog.c | 4 ---- fs/ntfs3/fsntfs.c | 1 - fs/ntfs3/index.c | 1 - fs/ntfs3/inode.c | 2 -- fs/ntfs3/lib/decompress_common.h | 5 +++++ fs/ntfs3/lib/lib.h | 6 ++++++ fs/ntfs3/lznt.c | 10 +++++----- fs/ntfs3/namei.c | 4 ---- fs/ntfs3/ntfs.h | 9 +++++++++ fs/ntfs3/ntfs_fs.h | 31 +++++++++++++++++++++++++++++++ fs/ntfs3/record.c | 3 --- fs/ntfs3/run.c | 2 -- fs/ntfs3/super.c | 2 -- fs/ntfs3/upcase.c | 8 ++------ fs/ntfs3/xattr.c | 3 --- 23 files changed, 62 insertions(+), 57 deletions(-)
base-commit: d3624466b56dd5b1886c1dff500525b544c19c83
Signature · 1 line
2.25.1
PATCH v2 1/8 fs/ntfs3. Add forward declarations for structs to debug.h
Add forward declarations for structs so that we can include this file without warnings even without linux/fs.h
--- fs/ntfs3/debug.h | 3 +++ 1 file changed, 3 insertions(+)
fs/ntfs3/debug.h +3 -0
@@ -11,6 +11,9 @@#ifndef _LINUX_NTFS3_DEBUG_H#define _LINUX_NTFS3_DEBUG_H +struct super_block ; +struct inode ; +#ifndef Add2Ptr#define Add2Ptr (P ,I ) ((void *)((u8 *)(P) + (I)))#define PtrOffset (B ,O ) ((size_t)((size_t)(O) - (size_t)(B)))
Signature · 1 line
2.25.1
PATCH v2 2/8 fs/ntfs3: Add missing header files to ntfs.h
In reply to Kari ArgillanderWe do not have header files at all in this file. Add following headers and there is also explanation which for it was added. Note that explanation might not be complete, but it just proofs it is needed.
<linux/blkdev.h> // SECTOR_SHIFT <linux/build_bug.h> // static_assert() <linux/kernel.h> // cpu_to_le64, cpu_to_le32, ALIGN <linux/stddef.h> // offsetof() <linux/string.h> // memcmp() <linux/types.h> //__le32, __le16
"debug.h" // PtrOffset(), Add2Ptr()
--- fs/ntfs3/ntfs.h | 9 +++++++++ 1 file changed, 9 insertions(+)
fs/ntfs3/ntfs.h +9 -0
@@ -10,6 +10,15 @@#ifndef _LINUX_NTFS3_NTFS_H#define _LINUX_NTFS3_NTFS_H +#include <linux/blkdev.h> +#include <linux/build_bug.h> +#include <linux/kernel.h> +#include <linux/stddef.h> +#include <linux/string.h> +#include <linux/types.h> + +#include "debug.h" +/* TODO: Check 4K MFT record and 512 bytes cluster. */ /* Activate this define to use binary search in indexes. */
Signature · 1 line
2.25.1
PATCH v2 3/8 fs/ntfs3: Add missing headers and forward declarations to ntfs_fs.h
In reply to Kari ArgillanderWe do not have headers at all in this file. We should have them so that not every .c file needs to include all of the stuff which this file need for building. This way we can remove some headers from other files and get better picture what is needed. This can save some compilation time. And this can help if we sometimes want to separate this one big header.
Also use forward declarations for structs and enums when it not included straight with include and it is used in function declarations input. This will prevent possible compiler warning:
xxx declared inside parameter list will not be visible outside of this definition or declaration
Here is list which I made when parsing this. There is not necessarily all example from this header file, but this just proofs we need it.
<linux/blkdev.h> SECTOR_SHIFT <linux/buffer_head.h> sb_bread(), put_bh <linux/cleancache.h> put_page()
<linux/fs.h> struct inode (Just struct ntfs_inode need it) <linux/highmem.h> kunmap(), kmap() <linux/kernel.h> cpu_to_leXX() ALIGN
<linux/mm.h> kvfree()
<linux/mutex.h> struct mutex, mutex_(un/try)lock() <linux/page-flags.h> PageError() <linux/pagemap.h> read_mapping_page() <linux/rbtree.h> struct rb_root
<linux/rwsem.h> struct rw_semaphore <linux/slab.h> krfree(), kzalloc() <linux/string.h> memset()
<linux/time64.h> struct timespec64 <linux/types.h> uXX, __leXX
<linux/uidgid.h> kuid_t, kgid_t
<asm/div64.h> do_div()
<asm/page.h> PAGE_SIZE
"debug.h" ntfs_err() (Just one entry. Maybe we can drop this) "ntfs.h" Do you even ask?
--- fs/ntfs3/ntfs_fs.h | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+)
fs/ntfs3/ntfs_fs.h +31 -0
@@ -9,6 +9,37 @@#ifndef _LINUX_NTFS3_NTFS_FS_H#define _LINUX_NTFS3_NTFS_FS_H +#include <linux/blkdev.h> +#include <linux/buffer_head.h> +#include <linux/cleancache.h> +#include <linux/fs.h> +#include <linux/highmem.h> +#include <linux/kernel.h> +#include <linux/mm.h> +#include <linux/mutex.h> +#include <linux/page-flags.h> +#include <linux/pagemap.h> +#include <linux/rbtree.h> +#include <linux/rwsem.h> +#include <linux/slab.h> +#include <linux/string.h> +#include <linux/time64.h> +#include <linux/types.h> +#include <linux/uidgid.h> +#include <asm/div64.h> +#include <asm/page.h> + +#include "debug.h" +#include "ntfs.h" + +struct dentry ; +struct fiemap_extent_info ; +struct user_namespace ; +struct page ; +struct writeback_control ; +enum utf16_endian ; + +#define MINUS_ONE_T ((size_t)(-1))/* Biggest MFT / smallest cluster */ #define MAXIMUM_BYTES_PER_MFT 4096
Signature · 1 line
2.25.1
PATCH v2 4/8 fs/ntfs3: Add missing header and guards to lib/ headers
In reply to Kari Argillandersize_t needs header. Add missing header guards so that compiler will only include these ones.
--- fs/ntfs3/lib/decompress_common.h | 5 +++++ fs/ntfs3/lib/lib.h | 6 ++++++ 2 files changed, 11 insertions(+)
fs/ntfs3/lib/decompress_common.h +5 -0
@@ -19,6 +19,9 @@* this program. If not, see <http://www.gnu.org/licenses/>. */ +#ifndef _LINUX_NTFS3_LIB_DECOMPRESS_COMMON_H +#define _LINUX_NTFS3_LIB_DECOMPRESS_COMMON_H +#include <linux/string.h> #include <linux/compiler.h> #include <linux/types.h>
@@ -350,3 +353,5 @@ static forceinline u8 *lz_copy(u8 *dst, u32 length, u32 offset, const u8 *bufend return dst; } + +#endif /* _LINUX_NTFS3_LIB_DECOMPRESS_COMMON_H */
fs/ntfs3/lib/lib.h +6 -0
@@ -7,6 +7,10 @@* - linux kernel code style */ +#ifndef _LINUX_NTFS3_LIB_LIB_H +#define _LINUX_NTFS3_LIB_LIB_H + +#include <linux/types.h> /* globals from xpress_decompress.c */ struct xpress_decompressor *xpress_allocate_decompressor (void );
@@ -24,3 +28,5 @@ int lzx_decompress(struct lzx_decompressor *__restrict d,const void *__restrict compressed_data, size_t compressed_size, void *__restrict uncompressed_data, size_t uncompressed_size); + +#endif /* _LINUX_NTFS3_LIB_LIB_H */
Signature · 1 line
2.25.1
PATCH v2 5/8 fs/ntfs3: Change right headers to bitfunc.c
In reply to Kari ArgillanderWe only need linux/types.h for types like u8 etc. So we can remove rest and help compiler a little bit.
--- fs/ntfs3/bitfunc.c | 7 +------ 1 file changed, 1 insertion(+), 6 deletions(-)
fs/ntfs3/bitfunc.c +1 -6
@@ -5,13 +5,8 @@* */ -#include <linux/blkdev.h> -#include <linux/buffer_head.h> -#include <linux/fs.h> -#include <linux/nls.h> +#include <linux/types.h> -#include "debug.h" -#include "ntfs.h" #include "ntfs_fs.h" #define BITS_IN_SIZE_T (sizeof(size_t) * 8)
Signature · 1 line
2.25.1
PATCH v2 6/8 fs/ntfs3: Change right headers to upcase.c
In reply to Kari ArgillanderThere is no headers. They will be included through ntfs_fs.c, but that is not right thing to do. Let's include headers what this file need straight away.
types.h is needed for __le16, u8 etc.kernel.h is needed for le16_to_cpu()
--- fs/ntfs3/upcase.c | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-)
fs/ntfs3/upcase.c +2 -6
@@ -5,13 +5,9 @@* */ -#include <linux/blkdev.h> -#include <linux/buffer_head.h> -#include <linux/module.h> -#include <linux/nls.h> +#include <linux/kernel.h> +#include <linux/types.h> -#include "debug.h" -#include "ntfs.h" #include "ntfs_fs.h" static inline u16 upcase_unicode_char (const u16 *upcase,u16 chr)
Signature · 1 line
2.25.1
PATCH v2 7/8 fs/ntfs3: Change right headers to lznt.c
In reply to Kari ArgillanderThere is lot of headers which we do not need in this file. Delete them and add what we really need. Here is list which identify why we need this header.
<linux/kernel.h> // min()
<linux/slab.h> // kzalloc()
<linux/stddef.h> // offsetof()
<linux/string.h> // memcpy(), memset()
<linux/types.h> // u8, size_t, etc.
"debug.h" // PtrOffset()
--- fs/ntfs3/lznt.c | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-)
fs/ntfs3/lznt.c +5 -5
@@ -5,13 +5,13 @@* */ -#include <linux/blkdev.h> -#include <linux/buffer_head.h> -#include <linux/fs.h> -#include <linux/nls.h> +#include <linux/kernel.h> +#include <linux/slab.h> +#include <linux/stddef.h> +#include <linux/string.h> +#include <linux/types.h> #include "debug.h" -#include "ntfs.h" #include "ntfs_fs.h" // clang-format off
Signature · 1 line
2.25.1
PATCH v2 8/8 fs/ntfs3: Remove unneeded header files from c files
In reply to Kari ArgillanderWe have lot of unnecessary headers in these files. Remove them so that we help compiler a little bit.
--- fs/ntfs3/attrib.c | 5 ----- fs/ntfs3/attrlist.c | 3 --- fs/ntfs3/bitmap.c | 3 --- fs/ntfs3/dir.c | 3 --- fs/ntfs3/file.c | 1 - fs/ntfs3/frecord.c | 3 --- fs/ntfs3/fslog.c | 4 ---- fs/ntfs3/fsntfs.c | 1 - fs/ntfs3/index.c | 1 - fs/ntfs3/inode.c | 2 -- fs/ntfs3/namei.c | 4 ---- fs/ntfs3/record.c | 3 --- fs/ntfs3/run.c | 2 -- fs/ntfs3/super.c | 2 -- fs/ntfs3/xattr.c | 3 --- 15 files changed, 40 deletions(-)
fs/ntfs3/attrib.c +0 -5
@@ -6,12 +6,7 @@* TODO: Merge attr_set_size/attr_data_get_block/attr_allocate_frame? */ -#include <linux/blkdev.h> -#include <linux/buffer_head.h> #include <linux/fs.h> -#include <linux/hash.h> -#include <linux/nls.h> -#include <linux/ratelimit.h> #include <linux/slab.h> #include "debug.h"
fs/ntfs3/attrlist.c +0 -3
@@ -5,10 +5,7 @@* */ -#include <linux/blkdev.h> -#include <linux/buffer_head.h> #include <linux/fs.h> -#include <linux/nls.h> #include "debug.h" #include "ntfs.h"
fs/ntfs3/bitmap.c +0 -3
@@ -10,12 +10,9 @@* */ -#include <linux/blkdev.h> #include <linux/buffer_head.h> #include <linux/fs.h> -#include <linux/nls.h> -#include "debug.h" #include "ntfs.h" #include "ntfs_fs.h"
fs/ntfs3/dir.c +0 -3
@@ -7,10 +7,7 @@* */ -#include <linux/blkdev.h> -#include <linux/buffer_head.h> #include <linux/fs.h> -#include <linux/iversion.h> #include <linux/nls.h> #include "debug.h"
fs/ntfs3/file.c +0 -1
@@ -12,7 +12,6 @@#include <linux/compat.h> #include <linux/falloc.h> #include <linux/fiemap.h> -#include <linux/nls.h> #include "debug.h" #include "ntfs.h"
fs/ntfs3/frecord.c +0 -3
@@ -5,11 +5,8 @@* */ -#include <linux/blkdev.h> -#include <linux/buffer_head.h> #include <linux/fiemap.h> #include <linux/fs.h> -#include <linux/nls.h> #include <linux/vmalloc.h> #include "debug.h"
fs/ntfs3/fslog.c +0 -4
@@ -6,12 +6,8 @@*/ #include <linux/blkdev.h> -#include <linux/buffer_head.h> #include <linux/fs.h> -#include <linux/hash.h> -#include <linux/nls.h> #include <linux/random.h> -#include <linux/ratelimit.h> #include <linux/slab.h> #include "debug.h"
fs/ntfs3/fsntfs.c +0 -1
@@ -8,7 +8,6 @@#include <linux/blkdev.h> #include <linux/buffer_head.h> #include <linux/fs.h> -#include <linux/nls.h> #include "debug.h" #include "ntfs.h"
fs/ntfs3/index.c +0 -1
@@ -8,7 +8,6 @@#include <linux/blkdev.h> #include <linux/buffer_head.h> #include <linux/fs.h> -#include <linux/nls.h> #include "debug.h" #include "ntfs.h"
fs/ntfs3/inode.c +0 -2
@@ -5,10 +5,8 @@* */ -#include <linux/blkdev.h> #include <linux/buffer_head.h> #include <linux/fs.h> -#include <linux/iversion.h> #include <linux/mpage.h> #include <linux/namei.h> #include <linux/nls.h>
fs/ntfs3/namei.c +0 -4
@@ -5,11 +5,7 @@* */ -#include <linux/blkdev.h> -#include <linux/buffer_head.h> #include <linux/fs.h> -#include <linux/iversion.h> -#include <linux/namei.h> #include <linux/nls.h> #include "debug.h"
fs/ntfs3/record.c +0 -3
@@ -5,10 +5,7 @@* */ -#include <linux/blkdev.h> -#include <linux/buffer_head.h> #include <linux/fs.h> -#include <linux/nls.h> #include "debug.h" #include "ntfs.h"
fs/ntfs3/run.c +0 -2
@@ -7,10 +7,8 @@*/ #include <linux/blkdev.h> -#include <linux/buffer_head.h> #include <linux/fs.h> #include <linux/log2.h> -#include <linux/nls.h> #include "debug.h" #include "ntfs.h"
fs/ntfs3/super.c +0 -2
@@ -23,12 +23,10 @@* */ -#include <linux/backing-dev.h> #include <linux/blkdev.h> #include <linux/buffer_head.h> #include <linux/exportfs.h> #include <linux/fs.h> -#include <linux/iversion.h> #include <linux/log2.h> #include <linux/module.h> #include <linux/nls.h>
fs/ntfs3/xattr.c +0 -3
@@ -5,10 +5,7 @@* */ -#include <linux/blkdev.h> -#include <linux/buffer_head.h> #include <linux/fs.h> -#include <linux/nls.h> #include <linux/posix_acl.h> #include <linux/posix_acl_xattr.h> #include <linux/xattr.h>
Signature · 1 line
2.25.1
Konstantin Komarov
maintainerQuoted 62 lines · Kari Argillander
Right now header includes are big mess with ntfs3 imo. We cannot example include ntfs3 headers without need of punch of includes to source file. This patch set try to address that. When this patch series is applied we can include any header file without need of include anything else. This does not mean source file should rely what header file includes. Instead it should include them by self also if it needs them.
When some include is added I have write why this is needed to commit message. Hopefully this will help when someone wants to correct them again. I have also just delete unnecessary headers from some .c files and not added what is needed. Usually deleted headers where there because
ntfs_fs.hneed them not file itself. When file was simple enough I added all necessary linux headers.I did not add linux/headers to all files yet. That is big job. This is good starting point. I did try to build every file itself so this will build like it should.
Please do not hesitate to tell if there is something wrong with this series or somethings could be done better.
V2:
Add missing first patch
Rebase
Use base-commit with format-patchKari Argillander (8):
fs/ntfs3. Add forward declarations for structs todebug.hfs/ntfs3: Add missing header files tontfs.h
fs/ntfs3: Add missing headers and forward declarations tontfs_fs.hfs/ntfs3: Add missing header and guards tolib/headers fs/ntfs3: Change right headers tobitfunc.c
fs/ntfs3: Change right headers toupcase.c
fs/ntfs3: Change right headers tolznt.c
fs/ntfs3: Remove unneeded header files from c filesfs/ntfs3/attrib.c | 5 ----- fs/ntfs3/attrlist.c | 3 --- fs/ntfs3/bitfunc.c | 7 +------ fs/ntfs3/bitmap.c | 3 --- fs/ntfs3/debug.h | 3 +++ fs/ntfs3/dir.c | 3 --- fs/ntfs3/file.c | 1 - fs/ntfs3/frecord.c | 3 --- fs/ntfs3/fslog.c | 4 ---- fs/ntfs3/fsntfs.c | 1 - fs/ntfs3/index.c | 1 - fs/ntfs3/inode.c | 2 -- fs/ntfs3/lib/decompress_common.h | 5 +++++ fs/ntfs3/lib/lib.h | 6 ++++++ fs/ntfs3/lznt.c | 10 +++++----- fs/ntfs3/namei.c | 4 ---- fs/ntfs3/ntfs.h | 9 +++++++++ fs/ntfs3/ntfs_fs.h | 31 +++++++++++++++++++++++++++++++ fs/ntfs3/record.c | 3 --- fs/ntfs3/run.c | 2 -- fs/ntfs3/super.c | 2 -- fs/ntfs3/upcase.c | 8 ++------ fs/ntfs3/xattr.c | 3 --- 23 files changed, 62 insertions(+), 57 deletions(-)
Quoted 2 lines
base-commit:
d3624466b56dd5b1886c1dff500525b544c19c83
Hi Kari!
Thanks for work - applied!