ext2: Explicitly assign values to on-disk enum of filetypes
PATCH 1/1 ext2: Explicitly assign values to on-disk enum of filetypes
Here is an old patch that I found in my tree. Andreas, it seems that this is something you proposed.
Comments?
Jan
Quoted 1 line
From
290d3d969850ff9555bc213035b1c4e401ea9adaMon Sep 17 00:00:00 2001
From: Jan Blunck <[email protected]>
Date: Wed, 18 Nov 2009 17:10:56 +0100
Subject: [PATCH] ext2: Explicitly assign values to on-disk enum of filetypes
It is somewhat dangerous to use a straight enum here, because this will reassign values of later variables if one of the earlier ones is removed.
--- include/linux/ext2_fs.h | 16 ++++++++-------- 1 files changed, 8 insertions(+), 8 deletions(-)
include/linux/ext2_fs.h +8 -8
@@ -565,14 +565,14 @@ struct ext2_dir_entry_2 {* other bits are reserved for now. */ enum { -EXT2_FT_UNKNOWN , -EXT2_FT_REG_FILE , -EXT2_FT_DIR , -EXT2_FT_CHRDEV , -EXT2_FT_BLKDEV , -EXT2_FT_FIFO , -EXT2_FT_SOCK , -EXT2_FT_SYMLINK , +EXT2_FT_UNKNOWN =0 , +EXT2_FT_REG_FILE =1 , +EXT2_FT_DIR =2 , +EXT2_FT_CHRDEV =3 , +EXT2_FT_BLKDEV =4 , +EXT2_FT_FIFO =5 , +EXT2_FT_SOCK =6 , +EXT2_FT_SYMLINK =7 ,EXT2_FT_MAX };
Signature · 1 line
1.6.4.2
Quoted 3 lines · Jan Blunck
Here is an old patch that I found in my tree. Andreas, it seems that this is something you proposed.
Comments?
This is definitely my preferred coding style for constants that form a permanent part of the API/ABI/disk format.
The enum is useful because some debuggers can display the symbolic name of a constant if a named enum is present (though in this case it isn't), but it avoids the risk of someone accidentally inserting or removing a value in the middle of the enum.
For in-memory-only enums that isn't important at all, but for some developers it isn't always clear what is in-memory and what is on-disk or part of an API. Also, the compiler will warn if the same value is assigned multiple times, which isn't necessarily a worry with the few values here, but for large lists of #defines like e.g. EXT2_FEATURE_INCOMPAT_* it is a real risk, and I've seen a few cases where the same value was #defined multiple times accidentally (e.g. with patches vs. upstream merges).
Quoted 44 lines
From
290d3d969850ff9555bc213035b1c4e401ea9adaMon Sep 17 00:00:00 2001
From: Jan Blunck <[email protected]>
Date: Wed, 18 Nov 2009 17:10:56 +0100
Subject: [PATCH] ext2: Explicitly assign values to on-disk enum of filetypesIt is somewhat dangerous to use a straight enum here, because this will reassign values of later variables if one of the earlier ones is removed.
Signed-off-by Jan Blunck <[email protected]>Cc Andreas Dilger <[email protected]>---
include/linux/ext2_fs.h| 16 ++++++++--------1 files changed, 8 insertions(+), 8 deletions(-)include/linux/ext2_fs.h +8
-8@@ -565,14 +565,14 @@ struct ext2_dir_entry_2 {* other bits are reserved for now. */ enum { -EXT2_FT_UNKNOWN , -EXT2_FT_REG_FILE , -EXT2_FT_DIR , -EXT2_FT_CHRDEV , -EXT2_FT_BLKDEV , -EXT2_FT_FIFO , -EXT2_FT_SOCK , -EXT2_FT_SYMLINK , +EXT2_FT_UNKNOWN =0 , +EXT2_FT_REG_FILE =1 , +EXT2_FT_DIR =2 , +EXT2_FT_CHRDEV =3 , +EXT2_FT_BLKDEV =4 , +EXT2_FT_FIFO =5 , +EXT2_FT_SOCK =6 , +EXT2_FT_SYMLINK =7 ,EXT2_FT_MAX };Signature · 1 line
1.6.4.2
Cheers, Andreas
--
Andreas Dilger
Sr. Staff Engineer, Lustre Group
Sun Microsystems of Canada, Inc.
Quoted 6 lines · Andreas Dilger
Quoted 4 lines · Jan Blunck
Here is an old patch that I found in my tree. Andreas, it seems that this is something you proposed.
Comments?
Quoted 7 lines
This is definitely my preferred coding style for constants that form a permanent part of the API/ABI/disk format.
The enum is useful because some debuggers can display the symbolic name of a constant if a named enum is present (though in this case it isn't), but it avoids the risk of someone accidentally inserting or removing a value in the middle of the enum.
In this particular case, I don't have a strong opinion... There isn't
much churn in FT_ fields but OTOH it doesn't hurt to have numbers explicitely assigned and as you write for on-disk format it's really important to have them fixed. OK, probably I'm slightly in favor of merging the patch so I've queued it up.
Honza
Signature · 2 lines
Jan Kara <[email protected]> SUSE Labs, CR