Date: Tue, 3 Jan 2023 18:51:45 -0700 From: Warner Losh <imp@bsdimp.com> To: Mark Johnston <markj@freebsd.org> Cc: Konstantin Belousov <kostikbel@gmail.com>, Mateusz Guzik <mjguzik@gmail.com>, src-committers <src-committers@freebsd.org>, "<dev-commits-src-all@freebsd.org>" <dev-commits-src-all@freebsd.org>, dev-commits-src-main@freebsd.org Subject: Re: git: 68912701700c - main - ffs_suspend.c: clean up includes Message-ID: <CANCZdfpOZwNAu34phCspy8otpsa0naQ6bwN=bm=_pbO4dESL9w@mail.gmail.com> In-Reply-To: <Y7TNygrOr8W86XJz@framework> References: <202212292056.2BTKuOIu047460@gitrepo.freebsd.org> <CAGudoHEqJVvxp8-PbbrHM9=Qz=jSV8PQR8q848HJOmULiVSZzg@mail.gmail.com> <Y7QXN18gBTKDMj8j@kib.kiev.ua> <Y7TNygrOr8W86XJz@framework>
next in thread | previous in thread | raw e-mail | index | archive | help
[-- Attachment #1 --] On Tue, Jan 3, 2023, 5:52 PM Mark Johnston <markj@freebsd.org> wrote: > On Tue, Jan 03, 2023 at 01:53:27PM +0200, Konstantin Belousov wrote: > > On Mon, Jan 02, 2023 at 06:29:57PM +0100, Mateusz Guzik wrote: > > > On 12/29/22, Konstantin Belousov <kib@freebsd.org> wrote: > > > > The branch main has been updated by kib: > > > > > > > > URL: > > > > > https://cgit.FreeBSD.org/src/commit/?id=68912701700ca3230f3e2d4b7858a038f884a327 > > > > > > > > commit 68912701700ca3230f3e2d4b7858a038f884a327 > > > > Author: Konstantin Belousov <kib@FreeBSD.org> > > > > AuthorDate: 2022-12-28 18:17:53 +0000 > > > > Commit: Konstantin Belousov <kib@FreeBSD.org> > > > > CommitDate: 2022-12-29 20:55:39 +0000 > > > > > > > > ffs_suspend.c: clean up includes > > > > > > > > Order includes alphabetically. > > > > Remove unneeded sys/param.h, it is already included by > sys/systm.h. > > > > > > > > Reviewed by: mckusick > > > > Sponsored by: The FreeBSD Foundation > > > > MFC after: 1 week > > > > Differential revision: https://reviews.freebsd.org/D37896 > > > > --- > > > > sys/ufs/ffs/ffs_suspend.c | 7 +++---- > > > > 1 file changed, 3 insertions(+), 4 deletions(-) > > > > > > > > diff --git a/sys/ufs/ffs/ffs_suspend.c b/sys/ufs/ffs/ffs_suspend.c > > > > index d13097109758..e7c976b6e921 100644 > > > > --- a/sys/ufs/ffs/ffs_suspend.c > > > > +++ b/sys/ufs/ffs/ffs_suspend.c > > > > @@ -33,15 +33,14 @@ > > > > #include <sys/cdefs.h> > > > > __FBSDID("$FreeBSD$"); > > > > > > > > -#include <sys/param.h> > > > > #include <sys/systm.h> > > > > #include <sys/buf.h> > > > > -#include <sys/ioccom.h> > > > > -#include <sys/mount.h> > > > > -#include <sys/vnode.h> > > > > #include <sys/conf.h> > > > > +#include <sys/ioccom.h> > > > > #include <sys/jail.h> > > > > +#include <sys/mount.h> > > > > #include <sys/sx.h> > > > > +#include <sys/vnode.h> > > > > > > > > #include <security/mac/mac_framework.h> > > > > > > > > > > > > > > tinderbox fails the KCSAN et al kernels: > > > > > > In file included from /usr/src/sys/ufs/ffs/ffs_suspend.c:36: > > > In file included from /usr/src/sys/sys/systm.h:44: > > > In file included from ./machine/atomic.h:73: > > > /usr/src/sys/sys/atomic_san.h:117:24: error: unknown type name > 'uint8_t' > > > ATOMIC_SAN_FUNCS(char, uint8_t); > > > ^ > > > it bisects to this commit > > > > > So the problem is that sys/systm.h includes machine/atomic.h which always > > had the pre-requisite sys/types.h, and this is documented in atomic(9). > > But sys/atomic_san.h uses C89 types in prototypes, not just macros, and > > this breaks for real. > > > > I can > > 1. Just add sys/types.h to ufs_suspend.c (I prefer not) > > 2. Add sys/types.h to sys/atomic_san.h. > > 3. Add sys/types.h to sys/systm.h. > > > > IMO #2 is not the best solution, since it pollutes systm.h only > sometimes, > > when the right kernel options are used. > > All machine/atomic.h include atomic_common.h, which includes > sys/types.h. Admittedly this inlcude was added quite recently, but it > means that systm.h is always polluted, so it seems reasonable to me. > > > I would prefer #3, it seems, but > > want to ensure that there is a consensus about the addition to > sys/systm.h. > > As Mike notes, systm.h already includes param.h, but it happens too late. > > Most of systm.h is _KERNEL-only, so I can't see why the includes at the > beginning are unguarded. Does userspace (or the boot loader) rely on > systm.h for anything? Perhaps we should guard the whole file with > _KERNEL and put includes in the right order. That would also solve the > problem. > I prefer mark's review that makes the atomic_san.h file self contained. Warner > [-- Attachment #2 --] <div dir="auto"><div><br><br><div class="gmail_quote"><div dir="ltr" class="gmail_attr">On Tue, Jan 3, 2023, 5:52 PM Mark Johnston <<a href="mailto:markj@freebsd.org">markj@freebsd.org</a>> wrote:<br></div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">On Tue, Jan 03, 2023 at 01:53:27PM +0200, Konstantin Belousov wrote:<br> > On Mon, Jan 02, 2023 at 06:29:57PM +0100, Mateusz Guzik wrote:<br> > > On 12/29/22, Konstantin Belousov <<a href="mailto:kib@freebsd.org" target="_blank" rel="noreferrer">kib@freebsd.org</a>> wrote:<br> > > > The branch main has been updated by kib:<br> > > ><br> > > > URL:<br> > > > <a href="https://cgit.FreeBSD.org/src/commit/?id=68912701700ca3230f3e2d4b7858a038f884a327" rel="noreferrer noreferrer" target="_blank">https://cgit.FreeBSD.org/src/commit/?id=68912701700ca3230f3e2d4b7858a038f884a327</a><br>; > > ><br> > > > commit 68912701700ca3230f3e2d4b7858a038f884a327<br> > > > Author: Konstantin Belousov <kib@FreeBSD.org><br> > > > AuthorDate: 2022-12-28 18:17:53 +0000<br> > > > Commit: Konstantin Belousov <kib@FreeBSD.org><br> > > > CommitDate: 2022-12-29 20:55:39 +0000<br> > > ><br> > > > ffs_suspend.c: clean up includes<br> > > ><br> > > > Order includes alphabetically.<br> > > > Remove unneeded sys/param.h, it is already included by sys/systm.h.<br> > > ><br> > > > Reviewed by: mckusick<br> > > > Sponsored by: The FreeBSD Foundation<br> > > > MFC after: 1 week<br> > > > Differential revision: <a href="https://reviews.freebsd.org/D37896" rel="noreferrer noreferrer" target="_blank">https://reviews.freebsd.org/D37896</a><br>; > > > ---<br> > > > sys/ufs/ffs/ffs_suspend.c | 7 +++----<br> > > > 1 file changed, 3 insertions(+), 4 deletions(-)<br> > > ><br> > > > diff --git a/sys/ufs/ffs/ffs_suspend.c b/sys/ufs/ffs/ffs_suspend.c<br> > > > index d13097109758..e7c976b6e921 100644<br> > > > --- a/sys/ufs/ffs/ffs_suspend.c<br> > > > +++ b/sys/ufs/ffs/ffs_suspend.c<br> > > > @@ -33,15 +33,14 @@<br> > > > #include <sys/cdefs.h><br> > > > __FBSDID("$FreeBSD$");<br> > > ><br> > > > -#include <sys/param.h><br> > > > #include <sys/systm.h><br> > > > #include <sys/buf.h><br> > > > -#include <sys/ioccom.h><br> > > > -#include <sys/mount.h><br> > > > -#include <sys/vnode.h><br> > > > #include <sys/conf.h><br> > > > +#include <sys/ioccom.h><br> > > > #include <sys/jail.h><br> > > > +#include <sys/mount.h><br> > > > #include <sys/sx.h><br> > > > +#include <sys/vnode.h><br> > > ><br> > > > #include <security/mac/mac_framework.h><br> > > ><br> > > ><br> > > <br> > > tinderbox fails the KCSAN et al kernels:<br> > > <br> > > In file included from /usr/src/sys/ufs/ffs/ffs_suspend.c:36:<br> > > In file included from /usr/src/sys/sys/systm.h:44:<br> > > In file included from ./machine/atomic.h:73:<br> > > /usr/src/sys/sys/atomic_san.h:117:24: error: unknown type name 'uint8_t'<br> > > ATOMIC_SAN_FUNCS(char, uint8_t);<br> > > ^<br> > > it bisects to this commit<br> > > <br> > So the problem is that sys/systm.h includes machine/atomic.h which always<br> > had the pre-requisite sys/types.h, and this is documented in atomic(9).<br> > But sys/atomic_san.h uses C89 types in prototypes, not just macros, and<br> > this breaks for real.<br> > <br> > I can<br> > 1. Just add sys/types.h to ufs_suspend.c (I prefer not)<br> > 2. Add sys/types.h to sys/atomic_san.h.<br> > 3. Add sys/types.h to sys/systm.h.<br> > <br> > IMO #2 is not the best solution, since it pollutes systm.h only sometimes,<br> > when the right kernel options are used.<br> <br> All machine/atomic.h include atomic_common.h, which includes<br> sys/types.h. Admittedly this inlcude was added quite recently, but it<br> means that systm.h is always polluted, so it seems reasonable to me.<br> <br> > I would prefer #3, it seems, but<br> > want to ensure that there is a consensus about the addition to sys/systm.h.<br> <br> As Mike notes, systm.h already includes param.h, but it happens too late.<br> <br> Most of systm.h is _KERNEL-only, so I can't see why the includes at the<br> beginning are unguarded. Does userspace (or the boot loader) rely on<br> systm.h for anything? Perhaps we should guard the whole file with<br> _KERNEL and put includes in the right order. That would also solve the<br> problem.<br></blockquote></div></div><div dir="auto"><br></div><div dir="auto">I prefer mark's review that makes the atomic_san.h file self contained. </div><div dir="auto"><br></div><div dir="auto">Warner </div><div dir="auto"><div class="gmail_quote"><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"> </blockquote></div></div></div>
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?CANCZdfpOZwNAu34phCspy8otpsa0naQ6bwN=bm=_pbO4dESL9w>