Re: [f2fs-dev] [RFC] errno.h: Provide EFSCORRUPTED for everybody
On Tue, Nov 05, 2019 at 04:15:50PM +0100, David Sterba wrote: > On Sat, Nov 02, 2019 at 08:38:23AM +1100, Dave Chinner wrote: > > On Fri, Nov 01, 2019 at 09:57:31PM +0100, Geert Uytterhoeven wrote: > > > Hi Valdis, > > > > > > On Thu, Oct 31, 2019 at 2:11 AM Valdis Kletnieks > > > wrote: > > > > Three questions: (a) ACK/NAK on this patch, (b) should it be all in one > > > > patch, or one to add to errno.h and 6 patches for 6 filesystems?), and > > > > (c) if one patch, who gets to shepherd it through? > > > > > > > > There's currently 6 filesystems that have the same #define. Move it > > > > into errno.h so it's defined in just one place. > > > > > > > > Signed-off-by: Valdis Kletnieks > > > > > > Thanks for your patch! > > > > > > > --- a/include/uapi/asm-generic/errno.h > > > > +++ b/include/uapi/asm-generic/errno.h > > > > @@ -98,6 +98,7 @@ > > > > #defineEINPROGRESS 115 /* Operation now in progress */ > > > > #defineESTALE 116 /* Stale file handle */ > > > > #defineEUCLEAN 117 /* Structure needs cleaning */ > > > > +#defineEFSCORRUPTEDEUCLEAN > > > > > > I have two questions: > > > a) Why not use EUCLEAN everywhere instead? > > > Having two different names for the same errno complicates grepping. > > > > Because: > > a) EUCLEAN is horrible for code documentation. EFSCORRUPTED > > describes exactly the error being returned and/or checked for. > > > > b) we've used EFSCORRUPTED in XFS since 1993. i.e. it was an > > official, published error value on Irix, and we've kept it > > in the linux code for the past ~20 years because of a) > > > > c) Userspace programs that include filesystem specific > > headers have already been exposed to and use EFSCORRUPTED, > > so we can't remove/change it without breaking userspace. > > > > d) EUCLEAN has a convenient userspace string description > > that is appropriate for filesystem corruption: "Structure > > needs cleaning" is precisely what needs to happen. Repair of > > the filesystem (i.e. recovery to a clean state) is what is > > required to fix the error > > The description is very confusing to users that are also not filesystem > developers. That's a pretty good description of most error messages for modern software packages. Anything that is a non-trivial error requires web searching to understand and diagnose these days. Google knows exactly what you are looking for if you search for "mount structure needs cleaning" or other similar error messages. That means users also know what it means and what they need to do to address it. i.e. it's been around long enough that there's a deep history in internet search engines and question forums like stackexchange. > "Structure needs cleaning" says what needs to be done but > not what happened. Unlike other error codes like "not enough memory", > "IO error" etc. We don't have EBUYMEM / "Buy more memory" instead of > ENOMEM. Message grammar is largely irrelevant. And not unique to EUCLEAN. e.g. EAGAIN = "Try again". > Fuzzing tests and crafted images produce most of the EUCLEAN errors and > in this context "structure needs cleaning" makes even less sense. It's pretty silly to argue that a developer crafting and/or fuzzing corrupted filesystem images is not going to understand what the error message returned when they successfully corrupt a filesystem actually means > > > b) Perhaps both errors should use different values? > > > > That horse bolted to userspace years ago - this is just > > formalising the practice that has spread across multiple linux > > filesystems from XFS over the past ~10 years.. > > EFSCORRUPTED is a appropriate name but to share the number with > EUCLEAN was a terrible decision and now every filesystem has to > suffer and explain to users what the code really means and point > to the the sad story when asked "So why don't you have a separate > code?". Damned if you do, damned if you don't. Back in 2005-2006, XFS developers tried to make EFSCORRUPTED a proper system wide errno (like we had on Irix). The NIH was strong in the linux community back then, and we were largely told to go away as the superior Linux filesystems would never need to report corruption to userspace so we don't need a special errno just because some shitty Irix filesystem port needs it. And so we didn't get a new errno and went with the second choice: precedence set by older unix systems commit 9e1fd551aba7291564d5d6c28948405142d5e2ca Author: Nathan Scott Date: Tue Jun 20 03:49:47 2006 + Map EFSCORRUPTED to an actual error code, not just a made up one (990). Turns out some ye-olde unices used EUCLEAN as Filesystem-needs-cleaning, so now we use that too. Merge of xfs-linux-melb:xfs-kern:26286a by kenmcd. diff --git a/fs/xfs/linux-2.6/xfs_linux.h b/fs/xfs/linux-2.6/xfs_linux.h index 3910afa7..b4083f8c 100644 --- a/fs/xfs/linux-2.6/xfs_linux.h
Re: [f2fs-dev] [RFC] errno.h: Provide EFSCORRUPTED for everybody
On Fri, Nov 01, 2019 at 09:57:31PM +0100, Geert Uytterhoeven wrote: > Hi Valdis, > > On Thu, Oct 31, 2019 at 2:11 AM Valdis Kletnieks > wrote: > > Three questions: (a) ACK/NAK on this patch, (b) should it be all in one > > patch, or one to add to errno.h and 6 patches for 6 filesystems?), and > > (c) if one patch, who gets to shepherd it through? > > > > There's currently 6 filesystems that have the same #define. Move it > > into errno.h so it's defined in just one place. > > > > Signed-off-by: Valdis Kletnieks > > Thanks for your patch! > > > --- a/include/uapi/asm-generic/errno.h > > +++ b/include/uapi/asm-generic/errno.h > > @@ -98,6 +98,7 @@ > > #defineEINPROGRESS 115 /* Operation now in progress */ > > #defineESTALE 116 /* Stale file handle */ > > #defineEUCLEAN 117 /* Structure needs cleaning */ > > +#defineEFSCORRUPTEDEUCLEAN > > I have two questions: > a) Why not use EUCLEAN everywhere instead? > Having two different names for the same errno complicates grepping. Because: a) EUCLEAN is horrible for code documentation. EFSCORRUPTED describes exactly the error being returned and/or checked for. b) we've used EFSCORRUPTED in XFS since 1993. i.e. it was an official, published error value on Irix, and we've kept it in the linux code for the past ~20 years because of a) c) Userspace programs that include filesystem specific headers have already been exposed to and use EFSCORRUPTED, so we can't remove/change it without breaking userspace. d) EUCLEAN has a convenient userspace string description that is appropriate for filesystem corruption: "Structure needs cleaning" is precisely what needs to happen. Repair of the filesystem (i.e. recovery to a clean state) is what is required to fix the error > b) Perhaps both errors should use different values? That horse bolted to userspace years ago - this is just formalising the practice that has spread across multiple linux filesystems from XFS over the past ~10 years.. Cheers, Dave. -- Dave Chinner da...@fromorbit.com ___ Linux-f2fs-devel mailing list Linux-f2fs-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/linux-f2fs-devel
Re: [f2fs-dev] [RFC] errno.h: Provide EFSCORRUPTED for everybody
On Wed, Oct 30, 2019 at 09:07:33PM -0400, Valdis Kletnieks wrote: > Three questions: (a) ACK/NAK on this patch, (b) should it be all in one > patch, or one to add to errno.h and 6 patches for 6 filesystems?), and > (c) if one patch, who gets to shepherd it through? Acked-by: Theodore Ts'o ___ Linux-f2fs-devel mailing list Linux-f2fs-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/linux-f2fs-devel
Re: [f2fs-dev] [RFC] errno.h: Provide EFSCORRUPTED for everybody
On Wed 30-10-19 21:07:33, Valdis Kletnieks wrote:
> Three questions: (a) ACK/NAK on this patch, (b) should it be all in one
> patch, or one to add to errno.h and 6 patches for 6 filesystems?), and
> (c) if one patch, who gets to shepherd it through?
>
>
> There's currently 6 filesystems that have the same #define. Move it
> into errno.h so it's defined in just one place.
>
> Signed-off-by: Valdis Kletnieks
Looks good to me. You can add:
Reviewed-by: Jan Kara
Honza
> ---
> drivers/staging/exfat/exfat.h| 2 --
> fs/erofs/internal.h | 2 --
> fs/ext4/ext4.h | 1 -
> fs/f2fs/f2fs.h | 1 -
> fs/xfs/xfs_linux.h | 1 -
> include/linux/jbd2.h | 1 -
> include/uapi/asm-generic/errno.h | 1 +
> 7 files changed, 1 insertion(+), 8 deletions(-)
>
> diff --git a/drivers/staging/exfat/exfat.h b/drivers/staging/exfat/exfat.h
> index 84de1123e178..3cf7e54af0b7 100644
> --- a/drivers/staging/exfat/exfat.h
> +++ b/drivers/staging/exfat/exfat.h
> @@ -30,8 +30,6 @@
> #undef DEBUG
> #endif
>
> -#define EFSCORRUPTED EUCLEAN /* Filesystem is corrupted */
> -
> #define DENTRY_SIZE 32 /* dir entry size */
> #define DENTRY_SIZE_BITS 5
>
> diff --git a/fs/erofs/internal.h b/fs/erofs/internal.h
> index 544a453f3076..3980026a8882 100644
> --- a/fs/erofs/internal.h
> +++ b/fs/erofs/internal.h
> @@ -425,7 +425,5 @@ static inline int z_erofs_init_zip_subsystem(void) {
> return 0; }
> static inline void z_erofs_exit_zip_subsystem(void) {}
> #endif /* !CONFIG_EROFS_FS_ZIP */
>
> -#define EFSCORRUPTEDEUCLEAN /* Filesystem is corrupted */
> -
> #endif /* __EROFS_INTERNAL_H */
>
> diff --git a/fs/ext4/ext4.h b/fs/ext4/ext4.h
> index 03db3e71676c..a86c2585457d 100644
> --- a/fs/ext4/ext4.h
> +++ b/fs/ext4/ext4.h
> @@ -3396,6 +3396,5 @@ static inline int ext4_buffer_uptodate(struct
> buffer_head *bh)
> #endif /* __KERNEL__ */
>
> #define EFSBADCRCEBADMSG /* Bad CRC detected */
> -#define EFSCORRUPTED EUCLEAN /* Filesystem is corrupted */
>
> #endif /* _EXT4_H */
> diff --git a/fs/f2fs/f2fs.h b/fs/f2fs/f2fs.h
> index 4024790028aa..04ebe77569a3 100644
> --- a/fs/f2fs/f2fs.h
> +++ b/fs/f2fs/f2fs.h
> @@ -3752,6 +3752,5 @@ static inline bool is_journalled_quota(struct
> f2fs_sb_info *sbi)
> }
>
> #define EFSBADCRCEBADMSG /* Bad CRC detected */
> -#define EFSCORRUPTED EUCLEAN /* Filesystem is corrupted */
>
> #endif /* _LINUX_F2FS_H */
> diff --git a/fs/xfs/xfs_linux.h b/fs/xfs/xfs_linux.h
> index ca15105681ca..3409d02a7d21 100644
> --- a/fs/xfs/xfs_linux.h
> +++ b/fs/xfs/xfs_linux.h
> @@ -123,7 +123,6 @@ typedef __u32 xfs_nlink_t;
>
> #define ENOATTR ENODATA /* Attribute not found */
> #define EWRONGFS EINVAL /* Mount with wrong filesystem type */
> -#define EFSCORRUPTED EUCLEAN /* Filesystem is corrupted */
> #define EFSBADCRCEBADMSG /* Bad CRC detected */
>
> #define SYNCHRONIZE()barrier()
> diff --git a/include/linux/jbd2.h b/include/linux/jbd2.h
> index 564793c24d12..1ecd3859d040 100644
> --- a/include/linux/jbd2.h
> +++ b/include/linux/jbd2.h
> @@ -1657,6 +1657,5 @@ static inline tid_t
> jbd2_get_latest_transaction(journal_t *journal)
> #endif /* __KERNEL__ */
>
> #define EFSBADCRCEBADMSG /* Bad CRC detected */
> -#define EFSCORRUPTED EUCLEAN /* Filesystem is corrupted */
>
> #endif /* _LINUX_JBD2_H */
> diff --git a/include/uapi/asm-generic/errno.h
> b/include/uapi/asm-generic/errno.h
> index cf9c51ac49f9..1d5ffdf54cb0 100644
> --- a/include/uapi/asm-generic/errno.h
> +++ b/include/uapi/asm-generic/errno.h
> @@ -98,6 +98,7 @@
> #define EINPROGRESS 115 /* Operation now in progress */
> #define ESTALE 116 /* Stale file handle */
> #define EUCLEAN 117 /* Structure needs cleaning */
> +#define EFSCORRUPTEDEUCLEAN
> #define ENOTNAM 118 /* Not a XENIX named type file */
> #define ENAVAIL 119 /* No XENIX semaphores available */
> #define EISNAM 120 /* Is a named type file */
> --
> 2.24.0.rc1
>
--
Jan Kara
SUSE Labs, CR
___
Linux-f2fs-devel mailing list
Linux-f2fs-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/linux-f2fs-devel
Re: [f2fs-dev] [RFC] errno.h: Provide EFSCORRUPTED for everybody
On Wed, Oct 30, 2019 at 09:07:33PM -0400, Valdis Kletnieks wrote:
> Three questions: (a) ACK/NAK on this patch,
Acked-by: Darrick J. Wong
> (b) should it be all in one patch, or one to add to errno.h and 6
> patches for 6 filesystems?), and
I don't particularly care, but I've a slight preference for changing it
all at once so that it's obvious as a move.
> (c) if one patch, who gets to shepherd it through?
Heh. :)
I would add (d) can we do the same to EFSBADCRC, seeing as f2fs,
ext4, xfs, and jbd2 all define it the same way?
--D
> There's currently 6 filesystems that have the same #define. Move it
> into errno.h so it's defined in just one place.
>
> Signed-off-by: Valdis Kletnieks
> ---
> drivers/staging/exfat/exfat.h| 2 --
> fs/erofs/internal.h | 2 --
> fs/ext4/ext4.h | 1 -
> fs/f2fs/f2fs.h | 1 -
> fs/xfs/xfs_linux.h | 1 -
> include/linux/jbd2.h | 1 -
> include/uapi/asm-generic/errno.h | 1 +
> 7 files changed, 1 insertion(+), 8 deletions(-)
>
> diff --git a/drivers/staging/exfat/exfat.h b/drivers/staging/exfat/exfat.h
> index 84de1123e178..3cf7e54af0b7 100644
> --- a/drivers/staging/exfat/exfat.h
> +++ b/drivers/staging/exfat/exfat.h
> @@ -30,8 +30,6 @@
> #undef DEBUG
> #endif
>
> -#define EFSCORRUPTED EUCLEAN /* Filesystem is corrupted */
> -
> #define DENTRY_SIZE 32 /* dir entry size */
> #define DENTRY_SIZE_BITS 5
>
> diff --git a/fs/erofs/internal.h b/fs/erofs/internal.h
> index 544a453f3076..3980026a8882 100644
> --- a/fs/erofs/internal.h
> +++ b/fs/erofs/internal.h
> @@ -425,7 +425,5 @@ static inline int z_erofs_init_zip_subsystem(void) {
> return 0; }
> static inline void z_erofs_exit_zip_subsystem(void) {}
> #endif /* !CONFIG_EROFS_FS_ZIP */
>
> -#define EFSCORRUPTEDEUCLEAN /* Filesystem is corrupted */
> -
> #endif /* __EROFS_INTERNAL_H */
>
> diff --git a/fs/ext4/ext4.h b/fs/ext4/ext4.h
> index 03db3e71676c..a86c2585457d 100644
> --- a/fs/ext4/ext4.h
> +++ b/fs/ext4/ext4.h
> @@ -3396,6 +3396,5 @@ static inline int ext4_buffer_uptodate(struct
> buffer_head *bh)
> #endif /* __KERNEL__ */
>
> #define EFSBADCRCEBADMSG /* Bad CRC detected */
> -#define EFSCORRUPTED EUCLEAN /* Filesystem is corrupted */
>
> #endif /* _EXT4_H */
> diff --git a/fs/f2fs/f2fs.h b/fs/f2fs/f2fs.h
> index 4024790028aa..04ebe77569a3 100644
> --- a/fs/f2fs/f2fs.h
> +++ b/fs/f2fs/f2fs.h
> @@ -3752,6 +3752,5 @@ static inline bool is_journalled_quota(struct
> f2fs_sb_info *sbi)
> }
>
> #define EFSBADCRCEBADMSG /* Bad CRC detected */
> -#define EFSCORRUPTED EUCLEAN /* Filesystem is corrupted */
>
> #endif /* _LINUX_F2FS_H */
> diff --git a/fs/xfs/xfs_linux.h b/fs/xfs/xfs_linux.h
> index ca15105681ca..3409d02a7d21 100644
> --- a/fs/xfs/xfs_linux.h
> +++ b/fs/xfs/xfs_linux.h
> @@ -123,7 +123,6 @@ typedef __u32 xfs_nlink_t;
>
> #define ENOATTR ENODATA /* Attribute not found */
> #define EWRONGFS EINVAL /* Mount with wrong filesystem type */
> -#define EFSCORRUPTED EUCLEAN /* Filesystem is corrupted */
> #define EFSBADCRCEBADMSG /* Bad CRC detected */
>
> #define SYNCHRONIZE()barrier()
> diff --git a/include/linux/jbd2.h b/include/linux/jbd2.h
> index 564793c24d12..1ecd3859d040 100644
> --- a/include/linux/jbd2.h
> +++ b/include/linux/jbd2.h
> @@ -1657,6 +1657,5 @@ static inline tid_t
> jbd2_get_latest_transaction(journal_t *journal)
> #endif /* __KERNEL__ */
>
> #define EFSBADCRCEBADMSG /* Bad CRC detected */
> -#define EFSCORRUPTED EUCLEAN /* Filesystem is corrupted */
>
> #endif /* _LINUX_JBD2_H */
> diff --git a/include/uapi/asm-generic/errno.h
> b/include/uapi/asm-generic/errno.h
> index cf9c51ac49f9..1d5ffdf54cb0 100644
> --- a/include/uapi/asm-generic/errno.h
> +++ b/include/uapi/asm-generic/errno.h
> @@ -98,6 +98,7 @@
> #define EINPROGRESS 115 /* Operation now in progress */
> #define ESTALE 116 /* Stale file handle */
> #define EUCLEAN 117 /* Structure needs cleaning */
> +#define EFSCORRUPTEDEUCLEAN
> #define ENOTNAM 118 /* Not a XENIX named type file */
> #define ENAVAIL 119 /* No XENIX semaphores available */
> #define EISNAM 120 /* Is a named type file */
> --
> 2.24.0.rc1
>
___
Linux-f2fs-devel mailing list
Linux-f2fs-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/linux-f2fs-devel
[f2fs-dev] [RFC] errno.h: Provide EFSCORRUPTED for everybody
Three questions: (a) ACK/NAK on this patch, (b) should it be all in one
patch, or one to add to errno.h and 6 patches for 6 filesystems?), and
(c) if one patch, who gets to shepherd it through?
There's currently 6 filesystems that have the same #define. Move it
into errno.h so it's defined in just one place.
Signed-off-by: Valdis Kletnieks
---
drivers/staging/exfat/exfat.h| 2 --
fs/erofs/internal.h | 2 --
fs/ext4/ext4.h | 1 -
fs/f2fs/f2fs.h | 1 -
fs/xfs/xfs_linux.h | 1 -
include/linux/jbd2.h | 1 -
include/uapi/asm-generic/errno.h | 1 +
7 files changed, 1 insertion(+), 8 deletions(-)
diff --git a/drivers/staging/exfat/exfat.h b/drivers/staging/exfat/exfat.h
index 84de1123e178..3cf7e54af0b7 100644
--- a/drivers/staging/exfat/exfat.h
+++ b/drivers/staging/exfat/exfat.h
@@ -30,8 +30,6 @@
#undef DEBUG
#endif
-#define EFSCORRUPTED EUCLEAN /* Filesystem is corrupted */
-
#define DENTRY_SIZE32 /* dir entry size */
#define DENTRY_SIZE_BITS 5
diff --git a/fs/erofs/internal.h b/fs/erofs/internal.h
index 544a453f3076..3980026a8882 100644
--- a/fs/erofs/internal.h
+++ b/fs/erofs/internal.h
@@ -425,7 +425,5 @@ static inline int z_erofs_init_zip_subsystem(void) { return
0; }
static inline void z_erofs_exit_zip_subsystem(void) {}
#endif /* !CONFIG_EROFS_FS_ZIP */
-#define EFSCORRUPTEDEUCLEAN /* Filesystem is corrupted */
-
#endif /* __EROFS_INTERNAL_H */
diff --git a/fs/ext4/ext4.h b/fs/ext4/ext4.h
index 03db3e71676c..a86c2585457d 100644
--- a/fs/ext4/ext4.h
+++ b/fs/ext4/ext4.h
@@ -3396,6 +3396,5 @@ static inline int ext4_buffer_uptodate(struct buffer_head
*bh)
#endif /* __KERNEL__ */
#define EFSBADCRC EBADMSG /* Bad CRC detected */
-#define EFSCORRUPTED EUCLEAN /* Filesystem is corrupted */
#endif /* _EXT4_H */
diff --git a/fs/f2fs/f2fs.h b/fs/f2fs/f2fs.h
index 4024790028aa..04ebe77569a3 100644
--- a/fs/f2fs/f2fs.h
+++ b/fs/f2fs/f2fs.h
@@ -3752,6 +3752,5 @@ static inline bool is_journalled_quota(struct
f2fs_sb_info *sbi)
}
#define EFSBADCRC EBADMSG /* Bad CRC detected */
-#define EFSCORRUPTED EUCLEAN /* Filesystem is corrupted */
#endif /* _LINUX_F2FS_H */
diff --git a/fs/xfs/xfs_linux.h b/fs/xfs/xfs_linux.h
index ca15105681ca..3409d02a7d21 100644
--- a/fs/xfs/xfs_linux.h
+++ b/fs/xfs/xfs_linux.h
@@ -123,7 +123,6 @@ typedef __u32 xfs_nlink_t;
#define ENOATTRENODATA /* Attribute not found */
#define EWRONGFS EINVAL /* Mount with wrong filesystem type */
-#define EFSCORRUPTED EUCLEAN /* Filesystem is corrupted */
#define EFSBADCRC EBADMSG /* Bad CRC detected */
#define SYNCHRONIZE() barrier()
diff --git a/include/linux/jbd2.h b/include/linux/jbd2.h
index 564793c24d12..1ecd3859d040 100644
--- a/include/linux/jbd2.h
+++ b/include/linux/jbd2.h
@@ -1657,6 +1657,5 @@ static inline tid_t
jbd2_get_latest_transaction(journal_t *journal)
#endif /* __KERNEL__ */
#define EFSBADCRC EBADMSG /* Bad CRC detected */
-#define EFSCORRUPTED EUCLEAN /* Filesystem is corrupted */
#endif /* _LINUX_JBD2_H */
diff --git a/include/uapi/asm-generic/errno.h b/include/uapi/asm-generic/errno.h
index cf9c51ac49f9..1d5ffdf54cb0 100644
--- a/include/uapi/asm-generic/errno.h
+++ b/include/uapi/asm-generic/errno.h
@@ -98,6 +98,7 @@
#defineEINPROGRESS 115 /* Operation now in progress */
#defineESTALE 116 /* Stale file handle */
#defineEUCLEAN 117 /* Structure needs cleaning */
+#defineEFSCORRUPTEDEUCLEAN
#defineENOTNAM 118 /* Not a XENIX named type file */
#defineENAVAIL 119 /* No XENIX semaphores available */
#defineEISNAM 120 /* Is a named type file */
--
2.24.0.rc1
___
Linux-f2fs-devel mailing list
Linux-f2fs-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/linux-f2fs-devel
