Re: [PATCH] x86: break mutual header inclusion

[Adrian Bunk <bunk@kernel.org>]

On Wed, May 28, 2008 at 12:01:02AM +0200, Vegard Nossum wrote:
> Hi!
> 
> On Tue, May 27, 2008 at 11:38 PM, Adrian Bunk <bunk@kernel.org> wrote:
> > On Tue, May 27, 2008 at 10:49:26PM +0200, Vegard Nossum wrote:
> >> Hi,
> >>
> >> What do you think about this? The new file (vm86_mask.h) could actually be
> >> embedded completely in processor-flags.h, but I went for what I believe is
> >> the safer approach.
> >
> > Breaking the mutual header inclusion is appreciated, but some comments
> > are below.
> 
> [...]
> 
> >> -/* the DS BTS struct is used for ptrace as well */
> >> -#include <asm/ds.h>
> >> -
> >>  struct task_struct;
> >>
> >>  extern void ptrace_bts_take_timestamp(struct task_struct *, enum bts_qualifier);
> >
> > Moving #include's out of an #ifdef __KERNEL__ can (and does here) break
> > our userspace headers.
> >
> > Running "make headers_check" after touching anything under include/ is
> > recommended since it catches these problems.
> >
> 
> Ah, that's true. My mistake.
> 
>   CHECK   include/asm/ptrace.h
> [...]/usr/include/asm/ptrace.h requires asm/ds.h, which does not exist
> in exported headers
> 
> What do you reckon is better here, to put #ifdef __KERNEL__ around the
> whole of ds.h and export it, or put #ifdef __KERNEL__ around the
> #include in ptrace.h? It feels wasteful to put it around the whole
> ds.h, since what is the point in exporting an empty file? On the other
> hand, it makes much more sense to put it there than in the "caller" in
> order to avoid the duplication of #ifdef __KERNEL__. So unless you
> prefer otherwise, I will choose the former (to export ds.h as well).

Our userspace headers are an API, and offering empty previsously 
unexported headers to userspace sounds like the worse choice to me.

Additionally, asm/segment.h (and asm/vm86_mask.h) have the same problem.

> I hope you agree with the idea of moving the #include line to the top
> of the file, however?

For me it looks good.

> Thanks for the tip, that is very useful. I didn't realize I should use
> that and I'm sorry for wasting your time with the first attempt :-(

No problem, and I don't consider it a waste of time.

>...
> Thanks for the help :-)
> 
> Vegard

cu
Adrian

-- 

       "Is there not promise of rain?" Ling Tan asked suddenly out
        of the darkness. There had been need of rain for many days.
       "Only a promise," Lao Er said.
                                       Pearl S. Buck - Dragon Seed