diff mbox series

[1/1] doc: add deprecation notice for CPU build flags

Message ID 20200805142141.32337-2-bruce.richardson@intel.com (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers show
Series RFC: remove build-type CPU flag macros | expand

Checks

Context Check Description
ci/travis-robot warning Travis build: failed
ci/Intel-compilation success Compilation OK
ci/checkpatch success coding style OK

Commit Message

Bruce Richardson Aug. 5, 2020, 2:21 p.m. UTC
The RTE_MACHINE_CPUFLAGS_* macros in DPDK build just duplicate info from
the compiler macros, so we can remove them and just use the compiler
versions directly.

Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
---
 doc/guides/rel_notes/deprecation.rst | 5 +++++
 1 file changed, 5 insertions(+)

Comments

Jerin Jacob Aug. 5, 2020, 2:23 p.m. UTC | #1
On Wed, Aug 5, 2020 at 7:52 PM Bruce Richardson
<bruce.richardson@intel.com> wrote:
>
> The RTE_MACHINE_CPUFLAGS_* macros in DPDK build just duplicate info from
> the compiler macros, so we can remove them and just use the compiler
> versions directly.
>
> Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>

Acked-by: Jerin Jacob <jerinj@marvell.com>



> ---
>  doc/guides/rel_notes/deprecation.rst | 5 +++++
>  1 file changed, 5 insertions(+)
>
> diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
> index ea4cfa7a4..68a63f345 100644
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> @@ -17,6 +17,11 @@ Deprecation Notices
>    can be got using the ``pip``, or ``pip3``, tool for downloading python
>    packages.
>
> +* build macros: The macros defining RTE_MACHINE_CPUFLAG_* will be removed
> +  from the build. The information provided by these macros is available
> +  through standard compiler macros. For example, RTE_MACHINE_CPUFLAG_SSE3
> +  duplicates the compiler-provided macro __SSE3__.
> +
>  * kvargs: The function ``rte_kvargs_process`` will get a new parameter
>    for returning key match count. It will ease handling of no-match case.
>
> --
> 2.25.1
>
Thomas Monjalon Aug. 5, 2020, 2:57 p.m. UTC | #2
05/08/2020 16:21, Bruce Richardson:
> The RTE_MACHINE_CPUFLAGS_* macros in DPDK build just duplicate info from
> the compiler macros, so we can remove them and just use the compiler
> versions directly.
> 
> Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
> ---
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> +* build macros: The macros defining RTE_MACHINE_CPUFLAG_* will be removed
> +  from the build. The information provided by these macros is available
> +  through standard compiler macros. For example, RTE_MACHINE_CPUFLAG_SSE3
> +  duplicates the compiler-provided macro __SSE3__.

I see 2 advantages of having alias:
	- if 2 compilers differ, we can manage
	- we can find all such macros with grep RTE_MACHINE_CPUFLAG
Bruce Richardson Aug. 5, 2020, 3:07 p.m. UTC | #3
On Wed, Aug 05, 2020 at 04:57:42PM +0200, Thomas Monjalon wrote:
> 05/08/2020 16:21, Bruce Richardson:
> > The RTE_MACHINE_CPUFLAGS_* macros in DPDK build just duplicate info from
> > the compiler macros, so we can remove them and just use the compiler
> > versions directly.
> > 
> > Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
> > ---
> > --- a/doc/guides/rel_notes/deprecation.rst
> > +++ b/doc/guides/rel_notes/deprecation.rst
> > +* build macros: The macros defining RTE_MACHINE_CPUFLAG_* will be removed
> > +  from the build. The information provided by these macros is available
> > +  through standard compiler macros. For example, RTE_MACHINE_CPUFLAG_SSE3
> > +  duplicates the compiler-provided macro __SSE3__.
> 
> I see 2 advantages of having alias:
> 	- if 2 compilers differ, we can manage
> 	- we can find all such macros with grep RTE_MACHINE_CPUFLAG
>

Sure, if you think it's worthwhile keeping them, we can do so. It's just
right now they seem to be largely a waste of space. For #2, I'm not sure
when we would want to grep for them all, except possibly to remove them.
:-)
Thomas Monjalon Aug. 5, 2020, 3:15 p.m. UTC | #4
05/08/2020 17:07, Bruce Richardson:
> On Wed, Aug 05, 2020 at 04:57:42PM +0200, Thomas Monjalon wrote:
> > 05/08/2020 16:21, Bruce Richardson:
> > > The RTE_MACHINE_CPUFLAGS_* macros in DPDK build just duplicate info from
> > > the compiler macros, so we can remove them and just use the compiler
> > > versions directly.
> > > 
> > > Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
> > > ---
> > > --- a/doc/guides/rel_notes/deprecation.rst
> > > +++ b/doc/guides/rel_notes/deprecation.rst
> > > +* build macros: The macros defining RTE_MACHINE_CPUFLAG_* will be removed
> > > +  from the build. The information provided by these macros is available
> > > +  through standard compiler macros. For example, RTE_MACHINE_CPUFLAG_SSE3
> > > +  duplicates the compiler-provided macro __SSE3__.
> > 
> > I see 2 advantages of having alias:
> > 	- if 2 compilers differ, we can manage
> > 	- we can find all such macros with grep RTE_MACHINE_CPUFLAG
> >
> 
> Sure, if you think it's worthwhile keeping them, we can do so. It's just
> right now they seem to be largely a waste of space. For #2, I'm not sure
> when we would want to grep for them all, except possibly to remove them.
> :-)

For instance, in a lib, I grep where we have CPU specific code.

We probably need more opinions, I can change my mind.
Bruce Richardson Aug. 5, 2020, 4:45 p.m. UTC | #5
On Wed, Aug 05, 2020 at 05:15:31PM +0200, Thomas Monjalon wrote:
> 05/08/2020 17:07, Bruce Richardson:
> > On Wed, Aug 05, 2020 at 04:57:42PM +0200, Thomas Monjalon wrote:
> > > 05/08/2020 16:21, Bruce Richardson:
> > > > The RTE_MACHINE_CPUFLAGS_* macros in DPDK build just duplicate info from
> > > > the compiler macros, so we can remove them and just use the compiler
> > > > versions directly.
> > > > 
> > > > Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
> > > > ---
> > > > --- a/doc/guides/rel_notes/deprecation.rst
> > > > +++ b/doc/guides/rel_notes/deprecation.rst
> > > > +* build macros: The macros defining RTE_MACHINE_CPUFLAG_* will be removed
> > > > +  from the build. The information provided by these macros is available
> > > > +  through standard compiler macros. For example, RTE_MACHINE_CPUFLAG_SSE3
> > > > +  duplicates the compiler-provided macro __SSE3__.
> > > 
> > > I see 2 advantages of having alias:
> > > 	- if 2 compilers differ, we can manage
> > > 	- we can find all such macros with grep RTE_MACHINE_CPUFLAG
> > >
> > 
> > Sure, if you think it's worthwhile keeping them, we can do so. It's just
> > right now they seem to be largely a waste of space. For #2, I'm not sure
> > when we would want to grep for them all, except possibly to remove them.
> > :-)
> 
> For instance, in a lib, I grep where we have CPU specific code.
> 
> We probably need more opinions, I can change my mind.
> 
Yes, we need some more opinions here.

For the above point, yes it's useful to be able to grep for these things,
but it does assume that everybody uses the DPDK-defines and doesn't use the
compiler ones directly. There are a few instances where there seems to be
x86, ARM or PPC compiler flags already directly used in the code.

As well as brevity, the other big reason I see for removing them is to
avoid having to maintain these lists of flags for future use. Right now,
with -march=skylake-avx512, gcc will define 7 different AVX feature flags.
DPDK, on the other hand, only provides equivalent defines for 3 of them.
We have no automatic way of pulling all newly added flags from gcc/clang
into our build, so we just add them on an as-needed basis, which makes it
more awkward for those adding new features that may depend on the flags. If
we always try to add in all flags to keep things in sync, we are just
duplicating the efforts the compiler authors have already done for us, and
wasting the effort for those flags that are unused.

/Bruce
Thomas Monjalon Aug. 5, 2020, 5:02 p.m. UTC | #6
05/08/2020 18:45, Bruce Richardson:
> On Wed, Aug 05, 2020 at 05:15:31PM +0200, Thomas Monjalon wrote:
> > 05/08/2020 17:07, Bruce Richardson:
> > > On Wed, Aug 05, 2020 at 04:57:42PM +0200, Thomas Monjalon wrote:
> > > > 05/08/2020 16:21, Bruce Richardson:
> > > > > The RTE_MACHINE_CPUFLAGS_* macros in DPDK build just duplicate info from
> > > > > the compiler macros, so we can remove them and just use the compiler
> > > > > versions directly.
> > > > > 
> > > > > Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
> > > > > ---
> > > > > --- a/doc/guides/rel_notes/deprecation.rst
> > > > > +++ b/doc/guides/rel_notes/deprecation.rst
> > > > > +* build macros: The macros defining RTE_MACHINE_CPUFLAG_* will be removed
> > > > > +  from the build. The information provided by these macros is available
> > > > > +  through standard compiler macros. For example, RTE_MACHINE_CPUFLAG_SSE3
> > > > > +  duplicates the compiler-provided macro __SSE3__.
> > > > 
> > > > I see 2 advantages of having alias:
> > > > 	- if 2 compilers differ, we can manage
> > > > 	- we can find all such macros with grep RTE_MACHINE_CPUFLAG
> > > >
> > > 
> > > Sure, if you think it's worthwhile keeping them, we can do so. It's just
> > > right now they seem to be largely a waste of space. For #2, I'm not sure
> > > when we would want to grep for them all, except possibly to remove them.
> > > :-)
> > 
> > For instance, in a lib, I grep where we have CPU specific code.
> > 
> > We probably need more opinions, I can change my mind.
> > 
> Yes, we need some more opinions here.
> 
> For the above point, yes it's useful to be able to grep for these things,
> but it does assume that everybody uses the DPDK-defines and doesn't use the
> compiler ones directly. There are a few instances where there seems to be
> x86, ARM or PPC compiler flags already directly used in the code.
> 
> As well as brevity, the other big reason I see for removing them is to
> avoid having to maintain these lists of flags for future use. Right now,
> with -march=skylake-avx512, gcc will define 7 different AVX feature flags.
> DPDK, on the other hand, only provides equivalent defines for 3 of them.
> We have no automatic way of pulling all newly added flags from gcc/clang
> into our build, so we just add them on an as-needed basis, which makes it
> more awkward for those adding new features that may depend on the flags. If
> we always try to add in all flags to keep things in sync, we are just
> duplicating the efforts the compiler authors have already done for us, and
> wasting the effort for those flags that are unused.

You see, you can provide good arguments :)
Maybe some of them deserve to be part of the patch.

Acked-by: Thomas Monjalon <thomas@monjalon.net>
Thomas Monjalon Aug. 6, 2020, 4:01 p.m. UTC | #7
Any other opinions?

05/08/2020 19:02, Thomas Monjalon:
> 05/08/2020 18:45, Bruce Richardson:
> > On Wed, Aug 05, 2020 at 05:15:31PM +0200, Thomas Monjalon wrote:
> > > 05/08/2020 17:07, Bruce Richardson:
> > > > On Wed, Aug 05, 2020 at 04:57:42PM +0200, Thomas Monjalon wrote:
> > > > > 05/08/2020 16:21, Bruce Richardson:
> > > > > > The RTE_MACHINE_CPUFLAGS_* macros in DPDK build just duplicate info from
> > > > > > the compiler macros, so we can remove them and just use the compiler
> > > > > > versions directly.
> > > > > > 
> > > > > > Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
> > > > > > ---
> > > > > > --- a/doc/guides/rel_notes/deprecation.rst
> > > > > > +++ b/doc/guides/rel_notes/deprecation.rst
> > > > > > +* build macros: The macros defining RTE_MACHINE_CPUFLAG_* will be removed
> > > > > > +  from the build. The information provided by these macros is available
> > > > > > +  through standard compiler macros. For example, RTE_MACHINE_CPUFLAG_SSE3
> > > > > > +  duplicates the compiler-provided macro __SSE3__.
> > > > > 
> > > > > I see 2 advantages of having alias:
> > > > > 	- if 2 compilers differ, we can manage
> > > > > 	- we can find all such macros with grep RTE_MACHINE_CPUFLAG
> > > > >
> > > > 
> > > > Sure, if you think it's worthwhile keeping them, we can do so. It's just
> > > > right now they seem to be largely a waste of space. For #2, I'm not sure
> > > > when we would want to grep for them all, except possibly to remove them.
> > > > :-)
> > > 
> > > For instance, in a lib, I grep where we have CPU specific code.
> > > 
> > > We probably need more opinions, I can change my mind.
> > > 
> > Yes, we need some more opinions here.
> > 
> > For the above point, yes it's useful to be able to grep for these things,
> > but it does assume that everybody uses the DPDK-defines and doesn't use the
> > compiler ones directly. There are a few instances where there seems to be
> > x86, ARM or PPC compiler flags already directly used in the code.
> > 
> > As well as brevity, the other big reason I see for removing them is to
> > avoid having to maintain these lists of flags for future use. Right now,
> > with -march=skylake-avx512, gcc will define 7 different AVX feature flags.
> > DPDK, on the other hand, only provides equivalent defines for 3 of them.
> > We have no automatic way of pulling all newly added flags from gcc/clang
> > into our build, so we just add them on an as-needed basis, which makes it
> > more awkward for those adding new features that may depend on the flags. If
> > we always try to add in all flags to keep things in sync, we are just
> > duplicating the efforts the compiler authors have already done for us, and
> > wasting the effort for those flags that are unused.
> 
> You see, you can provide good arguments :)
> Maybe some of them deserve to be part of the patch.
> 
> Acked-by: Thomas Monjalon <thomas@monjalon.net>
Ferruh Yigit Aug. 6, 2020, 9:41 p.m. UTC | #8
On 8/5/2020 5:45 PM, Bruce Richardson wrote:
> On Wed, Aug 05, 2020 at 05:15:31PM +0200, Thomas Monjalon wrote:
>> 05/08/2020 17:07, Bruce Richardson:
>>> On Wed, Aug 05, 2020 at 04:57:42PM +0200, Thomas Monjalon wrote:
>>>> 05/08/2020 16:21, Bruce Richardson:
>>>>> The RTE_MACHINE_CPUFLAGS_* macros in DPDK build just duplicate info from
>>>>> the compiler macros, so we can remove them and just use the compiler
>>>>> versions directly.
>>>>>
>>>>> Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
>>>>> ---
>>>>> --- a/doc/guides/rel_notes/deprecation.rst
>>>>> +++ b/doc/guides/rel_notes/deprecation.rst
>>>>> +* build macros: The macros defining RTE_MACHINE_CPUFLAG_* will be removed
>>>>> +  from the build. The information provided by these macros is available
>>>>> +  through standard compiler macros. For example, RTE_MACHINE_CPUFLAG_SSE3
>>>>> +  duplicates the compiler-provided macro __SSE3__.
>>>>
>>>> I see 2 advantages of having alias:
>>>> 	- if 2 compilers differ, we can manage
>>>> 	- we can find all such macros with grep RTE_MACHINE_CPUFLAG
>>>>
>>>
>>> Sure, if you think it's worthwhile keeping them, we can do so. It's just
>>> right now they seem to be largely a waste of space. For #2, I'm not sure
>>> when we would want to grep for them all, except possibly to remove them.
>>> :-)
>>
>> For instance, in a lib, I grep where we have CPU specific code.
>>
>> We probably need more opinions, I can change my mind.
>>
> Yes, we need some more opinions here.
> 
> For the above point, yes it's useful to be able to grep for these things,
> but it does assume that everybody uses the DPDK-defines and doesn't use the
> compiler ones directly. There are a few instances where there seems to be
> x86, ARM or PPC compiler flags already directly used in the code.
> 
> As well as brevity, the other big reason I see for removing them is to
> avoid having to maintain these lists of flags for future use. Right now,
> with -march=skylake-avx512, gcc will define 7 different AVX feature flags.
> DPDK, on the other hand, only provides equivalent defines for 3 of them.
> We have no automatic way of pulling all newly added flags from gcc/clang
> into our build, so we just add them on an as-needed basis, which makes it
> more awkward for those adding new features that may depend on the flags. If
> we always try to add in all flags to keep things in sync, we are just
> duplicating the efforts the compiler authors have already done for us, and
> wasting the effort for those flags that are unused.
> 

Sounds reasonable,

Acked-by: Ferruh Yigit <ferruh.yigit@intel.com>
Thomas Monjalon Aug. 7, 2020, 1:48 p.m. UTC | #9
06/08/2020 23:41, Ferruh Yigit:
> On 8/5/2020 5:45 PM, Bruce Richardson wrote:
> > On Wed, Aug 05, 2020 at 05:15:31PM +0200, Thomas Monjalon wrote:
> >> 05/08/2020 17:07, Bruce Richardson:
> >>> On Wed, Aug 05, 2020 at 04:57:42PM +0200, Thomas Monjalon wrote:
> >>>> 05/08/2020 16:21, Bruce Richardson:
> >>>>> The RTE_MACHINE_CPUFLAGS_* macros in DPDK build just duplicate info from
> >>>>> the compiler macros, so we can remove them and just use the compiler
> >>>>> versions directly.
> >>>>>
> >>>>> Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
> >>>>> ---
> >>>>> --- a/doc/guides/rel_notes/deprecation.rst
> >>>>> +++ b/doc/guides/rel_notes/deprecation.rst
> >>>>> +* build macros: The macros defining RTE_MACHINE_CPUFLAG_* will be removed
> >>>>> +  from the build. The information provided by these macros is available
> >>>>> +  through standard compiler macros. For example, RTE_MACHINE_CPUFLAG_SSE3
> >>>>> +  duplicates the compiler-provided macro __SSE3__.
> >>>>
> >>>> I see 2 advantages of having alias:
> >>>> 	- if 2 compilers differ, we can manage
> >>>> 	- we can find all such macros with grep RTE_MACHINE_CPUFLAG
> >>>>
> >>>
> >>> Sure, if you think it's worthwhile keeping them, we can do so. It's just
> >>> right now they seem to be largely a waste of space. For #2, I'm not sure
> >>> when we would want to grep for them all, except possibly to remove them.
> >>> :-)
> >>
> >> For instance, in a lib, I grep where we have CPU specific code.
> >>
> >> We probably need more opinions, I can change my mind.
> >>
> > Yes, we need some more opinions here.
> > 
> > For the above point, yes it's useful to be able to grep for these things,
> > but it does assume that everybody uses the DPDK-defines and doesn't use the
> > compiler ones directly. There are a few instances where there seems to be
> > x86, ARM or PPC compiler flags already directly used in the code.
> > 
> > As well as brevity, the other big reason I see for removing them is to
> > avoid having to maintain these lists of flags for future use. Right now,
> > with -march=skylake-avx512, gcc will define 7 different AVX feature flags.
> > DPDK, on the other hand, only provides equivalent defines for 3 of them.
> > We have no automatic way of pulling all newly added flags from gcc/clang
> > into our build, so we just add them on an as-needed basis, which makes it
> > more awkward for those adding new features that may depend on the flags. If
> > we always try to add in all flags to keep things in sync, we are just
> > duplicating the efforts the compiler authors have already done for us, and
> > wasting the effort for those flags that are unused.
> > 
> 
> Sounds reasonable,
> 
> Acked-by: Ferruh Yigit <ferruh.yigit@intel.com>

Applied
diff mbox series

Patch

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index ea4cfa7a4..68a63f345 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -17,6 +17,11 @@  Deprecation Notices
   can be got using the ``pip``, or ``pip3``, tool for downloading python
   packages.
 
+* build macros: The macros defining RTE_MACHINE_CPUFLAG_* will be removed
+  from the build. The information provided by these macros is available
+  through standard compiler macros. For example, RTE_MACHINE_CPUFLAG_SSE3
+  duplicates the compiler-provided macro __SSE3__.
+
 * kvargs: The function ``rte_kvargs_process`` will get a new parameter
   for returning key match count. It will ease handling of no-match case.