[PATCH 0/4] minor cleanup of filenames and deps

[PATCH 0/4] minor cleanup of filenames and deps

[Bruce Richardson]

While working on a build system replacement, I find a number of small
inconsistencies and minor issues with our current code, which, if fixed
would make it simplier to generalize DPDK build rules. Main set of changes
is to have the name of the version.map file for libs/drivers consistent
with the component name - especially in cases where the directory name and
component name differ slightly.

NOTE: this patchset is not meant to cover all instances of filename cleanup,
it just covers the instances I've encountered thus far. Any other instances
can be fixed as necessary as drivers are being "mesonified" [1].

[1] http://www.gocomics.com/calvinandhobbes/1993/01/25 :-)

Bruce Richardson (4):
  ip_frag: change map filename to standardized value
  net/ring: change map filename to standardized value
  ether: rename version file to match library name
  crypto/qat: remove dependency on ether library

 drivers/crypto/qat/qat_crypto.c                                         | 1 -
 drivers/net/ring/Makefile                                               | 2 +-
 drivers/net/ring/{rte_eth_ring_version.map => rte_pmd_ring_version.map} | 0
 lib/librte_ether/Makefile                                               | 2 +-
 lib/librte_ether/{rte_ether_version.map => rte_ethdev_version.map}      | 0
 lib/librte_ip_frag/Makefile                                             | 2 +-
 lib/librte_ip_frag/{rte_ipfrag_version.map => rte_ip_frag_version.map}  | 0
 7 files changed, 3 insertions(+), 4 deletions(-)
 rename drivers/net/ring/{rte_eth_ring_version.map => rte_pmd_ring_version.map} (100%)
 rename lib/librte_ether/{rte_ether_version.map => rte_ethdev_version.map} (100%)
 rename lib/librte_ip_frag/{rte_ipfrag_version.map => rte_ip_frag_version.map} (100%)

-- 
2.13.5

[PATCH 1/4] ip_frag: change map filename to standardized value

[Bruce Richardson]

The filenames of the linker map files for DPDK libraries, all follow a
standard format: rte_<libname>_version.map. The ip_frag version, however,
was missing an underscore in the name, so was non-standard. By changing
this, we no longer need the build system to explicitly be given the name of
the mapfile, as it can determine it from the directory/library name.

Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
---
 lib/librte_ip_frag/Makefile                                            | 2 +-
 lib/librte_ip_frag/{rte_ipfrag_version.map => rte_ip_frag_version.map} | 0
 2 files changed, 1 insertion(+), 1 deletion(-)
 rename lib/librte_ip_frag/{rte_ipfrag_version.map => rte_ip_frag_version.map} (100%)

diff --git a/lib/librte_ip_frag/Makefile b/lib/librte_ip_frag/Makefile
index 4e693bf8f..2a8c3e374 100644
--- a/lib/librte_ip_frag/Makefile
+++ b/lib/librte_ip_frag/Makefile
@@ -37,7 +37,7 @@ LIB = librte_ip_frag.a
 CFLAGS += -O3
 CFLAGS += $(WERROR_FLAGS) -I$(SRCDIR)
 
-EXPORT_MAP := rte_ipfrag_version.map
+EXPORT_MAP := rte_ip_frag_version.map
 
 LIBABIVER := 1
 
diff --git a/lib/librte_ip_frag/rte_ipfrag_version.map b/lib/librte_ip_frag/rte_ip_frag_version.map
similarity index 100%
rename from lib/librte_ip_frag/rte_ipfrag_version.map
rename to lib/librte_ip_frag/rte_ip_frag_version.map
-- 
2.13.5

[PATCH 2/4] net/ring: change map filename to standardized value

[Bruce Richardson]

The filenames of the linker map files for DPDK PMDs, all follow a
standard format: rte_pmd_<libname>_version.map. The ring version, however,
had eth instead of pmd in the name, so was non-standard. By changing
this, we no longer need the build system to explicitly be given the name of
the mapfile, as it can determine it from the directory name.

Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
---
 drivers/net/ring/Makefile                                               | 2 +-
 drivers/net/ring/{rte_eth_ring_version.map => rte_pmd_ring_version.map} | 0
 2 files changed, 1 insertion(+), 1 deletion(-)
 rename drivers/net/ring/{rte_eth_ring_version.map => rte_pmd_ring_version.map} (100%)

diff --git a/drivers/net/ring/Makefile b/drivers/net/ring/Makefile
index b7e1a378a..7ae15ef44 100644
--- a/drivers/net/ring/Makefile
+++ b/drivers/net/ring/Makefile
@@ -39,7 +39,7 @@ LIB = librte_pmd_ring.a
 CFLAGS += -O3
 CFLAGS += $(WERROR_FLAGS)
 
-EXPORT_MAP := rte_eth_ring_version.map
+EXPORT_MAP := rte_pmd_ring_version.map
 
 LIBABIVER := 2
 
diff --git a/drivers/net/ring/rte_eth_ring_version.map b/drivers/net/ring/rte_pmd_ring_version.map
similarity index 100%
rename from drivers/net/ring/rte_eth_ring_version.map
rename to drivers/net/ring/rte_pmd_ring_version.map
-- 
2.13.5

[PATCH 3/4] ether: rename version file to match library name

[Bruce Richardson]

While almost all libraries have the library name match the directory name,
some libraries and drivers do not. For those that don't, some have the
version filename use the libname, e.g. null_crypto, others have it use the
directory name, e.g. ether. Using the library name seems the better
standard to follow, so rename rte_ether_version.map to
rte_ethdev_version.map.

Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
---
 lib/librte_ether/Makefile                                          | 2 +-
 lib/librte_ether/{rte_ether_version.map => rte_ethdev_version.map} | 0
 2 files changed, 1 insertion(+), 1 deletion(-)
 rename lib/librte_ether/{rte_ether_version.map => rte_ethdev_version.map} (100%)

diff --git a/lib/librte_ether/Makefile b/lib/librte_ether/Makefile
index db692ae4d..27d9766a8 100644
--- a/lib/librte_ether/Makefile
+++ b/lib/librte_ether/Makefile
@@ -39,7 +39,7 @@ LIB = librte_ethdev.a
 CFLAGS += -O3
 CFLAGS += $(WERROR_FLAGS)
 
-EXPORT_MAP := rte_ether_version.map
+EXPORT_MAP := rte_ethdev_version.map
 
 LIBABIVER := 6
 
diff --git a/lib/librte_ether/rte_ether_version.map b/lib/librte_ether/rte_ethdev_version.map
similarity index 100%
rename from lib/librte_ether/rte_ether_version.map
rename to lib/librte_ether/rte_ethdev_version.map
-- 
2.13.5

[PATCH 4/4] crypto/qat: remove dependency on ether library

[Bruce Richardson]

The QAT crypto driver does not need to depend on the ether library, so
remove the unnecessary header inclusion.

Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
---
 drivers/crypto/qat/qat_crypto.c | 1 -
 1 file changed, 1 deletion(-)

diff --git a/drivers/crypto/qat/qat_crypto.c b/drivers/crypto/qat/qat_crypto.c
index 1f52cabfd..62ee175ba 100644
--- a/drivers/crypto/qat/qat_crypto.c
+++ b/drivers/crypto/qat/qat_crypto.c
@@ -46,7 +46,6 @@
 #include <rte_memory.h>
 #include <rte_memzone.h>
 #include <rte_tailq.h>
-#include <rte_ether.h>
 #include <rte_malloc.h>
 #include <rte_launch.h>
 #include <rte_eal.h>
-- 
2.13.5

Re: [PATCH 0/4] minor cleanup of filenames and deps

[Ferruh Yigit]

On 8/31/2017 2:42 PM, Bruce Richardson wrote:
> While working on a build system replacement, I find a number of small
> inconsistencies and minor issues with our current code, which, if fixed
> would make it simplier to generalize DPDK build rules. Main set of changes
> is to have the name of the version.map file for libs/drivers consistent
> with the component name - especially in cases where the directory name and
> component name differ slightly.
> 
> NOTE: this patchset is not meant to cover all instances of filename cleanup,
> it just covers the instances I've encountered thus far. Any other instances
> can be fixed as necessary as drivers are being "mesonified" [1].
> 
> [1] http://www.gocomics.com/calvinandhobbes/1993/01/25 :-)
> 
> Bruce Richardson (4):
>   ip_frag: change map filename to standardized value
>   net/ring: change map filename to standardized value
>   ether: rename version file to match library name
>   crypto/qat: remove dependency on ether library

Series Reviewed-by: Ferruh Yigit <ferruh.yigit@intel.com>

Re: [PATCH 3/4] ether: rename version file to match library name

[Ferruh Yigit]

On 8/31/2017 2:42 PM, Bruce Richardson wrote:
> While almost all libraries have the library name match the directory name,
> some libraries and drivers do not. For those that don't, some have the
> version filename use the libname, e.g. null_crypto, others have it use the
> directory name, e.g. ether. Using the library name seems the better
> standard to follow, so rename rte_ether_version.map to
> rte_ethdev_version.map.
> 
> Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
> ---
>  lib/librte_ether/Makefile                                          | 2 +-
>  lib/librte_ether/{rte_ether_version.map => rte_ethdev_version.map} | 0
>  2 files changed, 1 insertion(+), 1 deletion(-)
>  rename lib/librte_ether/{rte_ether_version.map => rte_ethdev_version.map} (100%)
> 
> diff --git a/lib/librte_ether/Makefile b/lib/librte_ether/Makefile
> index db692ae4d..27d9766a8 100644
> --- a/lib/librte_ether/Makefile
> +++ b/lib/librte_ether/Makefile
> @@ -39,7 +39,7 @@ LIB = librte_ethdev.a
>  CFLAGS += -O3
>  CFLAGS += $(WERROR_FLAGS)
>  
> -EXPORT_MAP := rte_ether_version.map
> +EXPORT_MAP := rte_ethdev_version.map

Why library name and folder name is different for ethdev, will it break
anything if folder also renamed to librte_ethdev? for consistency.

>  
>  LIBABIVER := 6
>  
> diff --git a/lib/librte_ether/rte_ether_version.map b/lib/librte_ether/rte_ethdev_version.map
> similarity index 100%
> rename from lib/librte_ether/rte_ether_version.map
> rename to lib/librte_ether/rte_ethdev_version.map
> 

Re: [PATCH 3/4] ether: rename version file to match library name

[Bruce Richardson]

On Thu, Aug 31, 2017 at 03:18:47PM +0100, Ferruh Yigit wrote:
> On 8/31/2017 2:42 PM, Bruce Richardson wrote:
> > While almost all libraries have the library name match the directory name,
> > some libraries and drivers do not. For those that don't, some have the
> > version filename use the libname, e.g. null_crypto, others have it use the
> > directory name, e.g. ether. Using the library name seems the better
> > standard to follow, so rename rte_ether_version.map to
> > rte_ethdev_version.map.
> > 
> > Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
> > ---
> >  lib/librte_ether/Makefile                                          | 2 +-
> >  lib/librte_ether/{rte_ether_version.map => rte_ethdev_version.map} | 0
> >  2 files changed, 1 insertion(+), 1 deletion(-)
> >  rename lib/librte_ether/{rte_ether_version.map => rte_ethdev_version.map} (100%)
> > 
> > diff --git a/lib/librte_ether/Makefile b/lib/librte_ether/Makefile
> > index db692ae4d..27d9766a8 100644
> > --- a/lib/librte_ether/Makefile
> > +++ b/lib/librte_ether/Makefile
> > @@ -39,7 +39,7 @@ LIB = librte_ethdev.a
> >  CFLAGS += -O3
> >  CFLAGS += $(WERROR_FLAGS)
> >  
> > -EXPORT_MAP := rte_ether_version.map
> > +EXPORT_MAP := rte_ethdev_version.map
> 
> Why library name and folder name is different for ethdev, will it break
> anything if folder also renamed to librte_ethdev? for consistency.
> 

Probably not, but it would be a much more visible change than just
changing the map filename, so I left it as-is for now. For the drivers,
there a quite a number of instances where the driver name is not going
to match the directory name, e.g  to include "crypto" or "event" for
clarity in the resulting library name. Because of that, I'm adding
support for allowing drivers to specify their name independently of the
directory name, and for consistency, I'm going to allow doing so for
libs too, since I want both drivers and libs to take more-or-less the
same set of parameters in their build files.

That said, no objection to a more comprehensive patch to rename the
folder. :-)

/Bruce

Re: [PATCH 0/4] minor cleanup of filenames and deps

[Bruce Richardson]

On Thu, Aug 31, 2017 at 03:15:05PM +0100, Ferruh Yigit wrote:
> On 8/31/2017 2:42 PM, Bruce Richardson wrote:
> > While working on a build system replacement, I find a number of small
> > inconsistencies and minor issues with our current code, which, if fixed
> > would make it simplier to generalize DPDK build rules. Main set of changes
> > is to have the name of the version.map file for libs/drivers consistent
> > with the component name - especially in cases where the directory name and
> > component name differ slightly.
> > 
> > NOTE: this patchset is not meant to cover all instances of filename cleanup,
> > it just covers the instances I've encountered thus far. Any other instances
> > can be fixed as necessary as drivers are being "mesonified" [1].
> > 
> > [1] http://www.gocomics.com/calvinandhobbes/1993/01/25 :-)
> > 
> > Bruce Richardson (4):
> >   ip_frag: change map filename to standardized value
> >   net/ring: change map filename to standardized value
> >   ether: rename version file to match library name
> >   crypto/qat: remove dependency on ether library
> 
> Series Reviewed-by: Ferruh Yigit <ferruh.yigit@intel.com>

Hi Thomas,

while these patches are mainly to enable my meson build work, it would
be easier for me, I think, if they could be applied on the main tree
directly, rather than going through the "next" tree. That way the
content on my tree is solely build-system related.

Is that ok with you?

/Bruce

Re: [PATCH 0/4] minor cleanup of filenames and deps

[Thomas Monjalon]

31/08/2017 16:34, Bruce Richardson:
> On Thu, Aug 31, 2017 at 03:15:05PM +0100, Ferruh Yigit wrote:
> > On 8/31/2017 2:42 PM, Bruce Richardson wrote:
> > > While working on a build system replacement, I find a number of small
> > > inconsistencies and minor issues with our current code, which, if fixed
> > > would make it simplier to generalize DPDK build rules. Main set of changes
> > > is to have the name of the version.map file for libs/drivers consistent
> > > with the component name - especially in cases where the directory name and
> > > component name differ slightly.
> > > 
> > > NOTE: this patchset is not meant to cover all instances of filename cleanup,
> > > it just covers the instances I've encountered thus far. Any other instances
> > > can be fixed as necessary as drivers are being "mesonified" [1].
> > > 
> > > [1] http://www.gocomics.com/calvinandhobbes/1993/01/25 :-)
> > > 
> > > Bruce Richardson (4):
> > >   ip_frag: change map filename to standardized value
> > >   net/ring: change map filename to standardized value
> > >   ether: rename version file to match library name
> > >   crypto/qat: remove dependency on ether library
> > 
> > Series Reviewed-by: Ferruh Yigit <ferruh.yigit@intel.com>
> 
> Hi Thomas,
> 
> while these patches are mainly to enable my meson build work, it would
> be easier for me, I think, if they could be applied on the main tree
> directly, rather than going through the "next" tree. That way the
> content on my tree is solely build-system related.
> 
> Is that ok with you?

Yes OK

Re: [PATCH 0/4] minor cleanup of filenames and deps

[Thomas Monjalon]

31/08/2017 17:26, Thomas Monjalon:
> 31/08/2017 16:34, Bruce Richardson:
> > On Thu, Aug 31, 2017 at 03:15:05PM +0100, Ferruh Yigit wrote:
> > > On 8/31/2017 2:42 PM, Bruce Richardson wrote:
> > > > While working on a build system replacement, I find a number of small
> > > > inconsistencies and minor issues with our current code, which, if fixed
> > > > would make it simplier to generalize DPDK build rules. Main set of changes
> > > > is to have the name of the version.map file for libs/drivers consistent
> > > > with the component name - especially in cases where the directory name and
> > > > component name differ slightly.
> > > > 
> > > > NOTE: this patchset is not meant to cover all instances of filename cleanup,
> > > > it just covers the instances I've encountered thus far. Any other instances
> > > > can be fixed as necessary as drivers are being "mesonified" [1].
> > > > 
> > > > [1] http://www.gocomics.com/calvinandhobbes/1993/01/25 :-)
> > > > 
> > > > Bruce Richardson (4):
> > > >   ip_frag: change map filename to standardized value
> > > >   net/ring: change map filename to standardized value
> > > >   ether: rename version file to match library name
> > > >   crypto/qat: remove dependency on ether library
> > > 
> > > Series Reviewed-by: Ferruh Yigit <ferruh.yigit@intel.com>
> > 
> > Hi Thomas,
> > 
> > while these patches are mainly to enable my meson build work, it would
> > be easier for me, I think, if they could be applied on the main tree
> > directly, rather than going through the "next" tree. That way the
> > content on my tree is solely build-system related.
> > 
> > Is that ok with you?
> 
> Yes OK

Applied, thanks