compat: merge compat library into EAL
Subsystems (2)
PATCH 1/1 compat: merge compat library into EAL
Since compat library is only a single header, we can easily move it into the EAL common headers instead of tracking it separately. The downside of this is that it becomes a little more difficult to have any libs that are built before EAL depend on it. Thankfully, this is not the case, so there are no big complications to the move.
However, to ensure that we don't later hit problems later with this, we can add EAL common headers folder to the global include list in the meson build which means that all common headers can be safely used by all libraries, no matter what their build order.
---
lib/Makefile | 2 --
lib/librte_cmdline/meson.build | 1 -
lib/librte_compat/Makefile | 13 -------------
lib/librte_compat/meson.build | 8 --------
lib/librte_eal/common/Makefile | 2 +-
.../common/include}/rte_compat.h | 0
lib/librte_eal/common/meson.build | 1 +
lib/librte_eal/linuxapp/eal/meson.build | 2 +-
lib/librte_eal/meson.build | 1 -
lib/librte_kvargs/meson.build | 3 ---
lib/meson.build | 2 +-
meson.build | 2 +-
12 files changed, 5 insertions(+), 32 deletions(-)
delete mode 100644 lib/librte_compat/Makefile
delete mode 100644 lib/librte_compat/meson.build
rename lib/{librte_compat => librte_eal/common/include}/rte_compat.h (100%)lib/Makefile +0 -2
@@ -3,9 +3,7 @@ include $(RTE_SDK)/mk/rte.vars.mk -DIRS-y += librte_compat DIRS-$(CONFIG_RTE_LIBRTE_KVARGS) += librte_kvargs -DEPDIRS-librte_kvargs := librte_compat DIRS-$(CONFIG_RTE_LIBRTE_EAL) += librte_eal DEPDIRS-librte_eal := librte_kvargs DIRS-$(CONFIG_RTE_LIBRTE_PCI) += librte_pci
lib/librte_cmdline/meson.build +0 -1
@@ -3,7 +3,6 @@ # This library is processed before EAL includes = [global_inc] -includes += include_directories('../librte_eal/common/include') version = 2 sources = files('cmdline.c',
lib/librte_compat/Makefile deleted +0 -13
@@ -1,13 +0,0 @@ -# SPDX-License-Identifier: BSD-3-Clause -# Copyright(c) 2013 Neil Horman <[email protected]> -# All rights reserved. - -include $(RTE_SDK)/mk/rte.vars.mk - - -LIBABIVER := 1 - -# install includes -SYMLINK-y-include := rte_compat.h - -include $(RTE_SDK)/mk/rte.install.mk
lib/librte_compat/meson.build deleted +0 -8
@@ -1,8 +0,0 @@ -# SPDX-License-Identifier: BSD-3-Clause -# Copyright(c) 2017 Intel Corporation - - -install_headers('rte_compat.h') - -set_variable('dep_rte_compat', - declare_dependency(include_directories: include_directories('.')))
lib/librte_eal/common/Makefile +1 -1
@@ -3,7 +3,7 @@ include $(RTE_SDK)/mk/rte.vars.mk -INC := rte_branch_prediction.h rte_common.h +INC := rte_branch_prediction.h rte_common.h rte_compat.h INC += rte_debug.h rte_eal.h rte_eal_interrupts.h INC += rte_errno.h rte_launch.h rte_lcore.h INC += rte_log.h rte_memory.h rte_memzone.h
lib/librte_eal/common/include/rte_compat.h renamed from lib/librte_compat/rte_compat.h +0 -0
lib/librte_eal/common/meson.build +1 -0
@@ -53,6 +53,7 @@ common_headers = files( 'include/rte_bitmap.h', 'include/rte_class.h', 'include/rte_common.h', + 'include/rte_compat.h', 'include/rte_debug.h', 'include/rte_devargs.h', 'include/rte_dev.h',
lib/librte_eal/linuxapp/eal/meson.build +1 -1
@@ -1,7 +1,7 @@ # SPDX-License-Identifier: BSD-3-Clause # Copyright(c) 2017 Intel Corporation -eal_inc += include_directories('include', '../../../librte_compat') +eal_inc += include_directories('include') install_subdir('include/exec-env', install_dir: get_option('includedir')) env_objs = []
lib/librte_eal/meson.build +0 -1
@@ -23,7 +23,6 @@ endif version = 9 # the version of the EAL API allow_experimental_apis = true -deps += 'compat' deps += 'kvargs' sources = common_sources + env_sources objs = common_objs + env_objs
lib/librte_kvargs/meson.build +0 -3
@@ -2,10 +2,7 @@ # Copyright(c) 2017 Intel Corporation includes = [global_inc] -includes += include_directories('../librte_eal/common/include') version = 1 sources = files('rte_kvargs.c') headers = files('rte_kvargs.h') - -deps += 'compat'
lib/meson.build +1 -1
@@ -8,7 +8,7 @@ # sometimes skip deps that would be implied by others, e.g. if mempool is # given as a dep, no need to mention ring. This is especially true for the # core libs which are widely reused, so their deps are kept to a minimum. -libraries = [ 'compat', # just a header, used for versioning +libraries = [ 'cmdline', # ethdev depends on cmdline for parsing functions 'kvargs', # eal depends on kvargs 'eal', 'ring', 'mempool', 'mbuf', 'net', 'meter', 'ethdev', 'pci', # core
meson.build +1 -1
@@ -32,7 +32,7 @@ eal_pmd_path = join_paths(get_option('prefix'), driver_install_path) # configure the build, and make sure configs here and in config folder are # able to be included in any file. We also store a global array of include dirs # for passing to pmdinfogen scripts -global_inc = include_directories('.', 'config') +global_inc = include_directories('.', 'config', 'lib/librte_eal/common/include') subdir('config') # build libs and drivers
Signature · 1 line
2.20.1
Quoted 6 lines · Bruce Richardson
Since compat library is only a single header, we can easily move it into the EAL common headers instead of tracking it separately. The downside of this is that it becomes a little more difficult to have any libs that are built before EAL depend on it. Thankfully, this is not the case, so there are no big complications to the move.
Quoted 7 lines
However, to ensure that we don't later hit problems later with this, we can add EAL common headers folder to the global include list in the meson build which means that all common headers can be safely used by all libraries, no matter what their build order.
Signed-off-by Bruce Richardson <[email protected]>---
Presumably this makes my patch obsolete?
Signature · 2 lines
Thanks, Anatoly
Quoted 12 lines · Anatoly
Quoted 11 lines · Bruce Richardson
Since compat library is only a single header, we can easily move it into the EAL common headers instead of tracking it separately. The downside of this is that it becomes a little more difficult to have any libs that are built before EAL depend on it. Thankfully, this is not the case, so there are no big complications to the move.
However, to ensure that we don't later hit problems later with this, we can add EAL common headers folder to the global include list in the meson build which means that all common headers can be safely used by all libraries, no matter what their build order.
Quoted 5 lines
Quoted 2 lines
Signed-off-by Bruce Richardson <[email protected]>---
Presumably this makes my patch obsolete?
If it also fixes the issue, yes. I suppose I'll need to pull in the fixes tag from your patch too, in that case.
/Bruce
Quoted 6 lines · Bruce Richardson
Since compat library is only a single header, we can easily move it into the EAL common headers instead of tracking it separately. The downside of this is that it becomes a little more difficult to have any libs that are built before EAL depend on it. Thankfully, this is not the case, so there are no big complications to the move.
Quoted 7 lines
However, to ensure that we don't later hit problems later with this, we can add EAL common headers folder to the global include list in the meson build which means that all common headers can be safely used by all libraries, no matter what their build order.
Signed-off-by Bruce Richardson <[email protected]>
Currently testing this patch, I just noticed some remaining traces of librte_compat:
[dmarchan@dmarchan dpdk]$ git grep librte_compat MAINTAINERS:F: lib/librte_compat/
doc/api/doxy-api.conf.in: @TOPDIR@/lib/librte_compat
\doc/guides/contributing/documentation.rst: |-- librte_compat
doc/guides/contributing/versioning.rst:To support backward compatibility the ``lib/librte_compat/rte_compat.h``
and librte_compat_netmap does not exist:examples/netmap_compat/bridge/bridge.c: "Couldn't
initialize librte_compat_netmap\n");examples/netmap_compat/bridge/bridge.c:printf("librte_compat_netmap initialized\n");
Signature · 1 line
David Marchand
Quoted 19 lines · David Marchand
Quoted 14 lines · Bruce Richardson
Since compat library is only a single header, we can easily move it into the EAL common headers instead of tracking it separately. The downside of this is that it becomes a little more difficult to have any libs that are built before EAL depend on it. Thankfully, this is not the case, so there are no big complications to the move.
However, to ensure that we don't later hit problems later with this, we can
add EAL common headers folder to the global include list in the meson build
which means that all common headers can be safely used by all libraries, no
matter what their build order.
Quoted 6 lines
Quoted 2 lines
Signed-off-by Bruce Richardson <[email protected]>Currently testing this patch, I just noticed some remaining traces of
librte_compat:
Checked build with make and meson on rhel7.
Signature · 1 line
David Marchand
Quoted 22 lines · David Marchand
On Thu, Jan 10, 2019 at 1:28 PM David Marchand
<[1][email protected]> wrote:On Thu, Jan 10, 2019 at 12:12 PM Bruce Richardson <[2][email protected]> wrote:
Since compat library is only a single header, we can easily move it into
the EAL common headers instead of tracking it separately. The downside of
this is that it becomes a little more difficult to have any libs that are
built before EAL depend on it. Thankfully, this is not the case, so there
are no big complications to the move.
However, to ensure that we don't later hit problems later with this, we can
add EAL common headers folder to the global include list in the meson build
which means that all common headers can be safely used by all libraries, no
matter what their build order.
Quoted 9 lines
Signed-off-by Bruce Richardson <[3][email protected]>Currently testing this patch, I just noticed some remaining traces of
librte_compat:Checked build with make and meson on rhel7.
--
David Marchand
Thanks, I'll check those out and do a V2.
/Bruce
PATCH v2 1/1 compat: merge compat library into EAL
In reply to Bruce RichardsonSince compat library is only a single header, we can easily move it into the EAL common headers instead of tracking it separately. The downside of this is that it becomes a little more difficult to have any libs that are built before EAL depend on it. Thankfully, this is not a major problem as the only library which uses rte_compat.h and is built before EAL (kvargs) already has the path to the compat.h header file explicitly called out as an include path.
However, to ensure that we don't later hit problems later with this, we can add EAL common headers folder to the global include list in the meson build which means that all common headers can be safely used by all libraries, no matter what their build order.
As a side-effect, this patch also fixes an issue with building on BSD using meson, due to compat lib no longer needing to be listed as a dependency.
---
V2: Clean up a few missed references to the compat library in our
documentation and MAINTAINERS file.
Added in fixes tag, as this patch should also fix build issues with BSD.
---
MAINTAINERS | 1 -
doc/api/doxy-api.conf.in | 1 -
doc/guides/contributing/documentation.rst | 1 -
doc/guides/contributing/versioning.rst | 2 +-
lib/Makefile | 2 --
lib/librte_cmdline/meson.build | 1 -
lib/librte_compat/Makefile | 13 -------------
lib/librte_compat/meson.build | 8 --------
lib/librte_eal/common/Makefile | 2 +-
.../common/include}/rte_compat.h | 0
lib/librte_eal/common/meson.build | 1 +
lib/librte_eal/linuxapp/eal/meson.build | 2 +-
lib/librte_eal/meson.build | 1 -
lib/librte_kvargs/meson.build | 3 ---
lib/meson.build | 2 +-
meson.build | 2 +-
16 files changed, 6 insertions(+), 36 deletions(-)
delete mode 100644 lib/librte_compat/Makefile
delete mode 100644 lib/librte_compat/meson.build
rename lib/{librte_compat => librte_eal/common/include}/rte_compat.h (100%)MAINTAINERS +0 -1
@@ -121,7 +121,6 @@ F: buildtools/symlink-drivers-solibs.sh ABI versioning M: Neil Horman <[email protected]> -F: lib/librte_compat/ F: doc/guides/rel_notes/deprecation.rst F: devtools/validate-abi.sh F: devtools/check-symbol-change.sh
doc/api/doxy-api.conf.in +0 -1
@@ -22,7 +22,6 @@ INPUT = @TOPDIR@/doc/api/doxy-api-index.md \ @TOPDIR@/lib/librte_bpf \ @TOPDIR@/lib/librte_cfgfile \ @TOPDIR@/lib/librte_cmdline \ - @TOPDIR@/lib/librte_compat \ @TOPDIR@/lib/librte_compressdev \ @TOPDIR@/lib/librte_cryptodev \ @TOPDIR@/lib/librte_distributor \
doc/guides/contributing/documentation.rst +0 -1
@@ -22,7 +22,6 @@ The main directories that contain files related to documentation are shown below |-- librte_acl |-- librte_cfgfile |-- librte_cmdline - |-- librte_compat |-- librte_eal | |-- ... ...
doc/guides/contributing/versioning.rst +1 -1
@@ -167,7 +167,7 @@ functionality or behavior. When that occurs, it is desirable to allow for backward compatibility for a time with older binaries that are dynamically linked to the DPDK. -To support backward compatibility the ``lib/librte_compat/rte_compat.h`` +To support backward compatibility the ``rte_compat.h`` header file provides macros to use when updating exported functions. These macros are used in conjunction with the ``rte_<library>_version.map`` file for a given library to allow multiple versions of a symbol to exist in a shared
lib/Makefile +0 -2
@@ -3,9 +3,7 @@ include $(RTE_SDK)/mk/rte.vars.mk -DIRS-y += librte_compat DIRS-$(CONFIG_RTE_LIBRTE_KVARGS) += librte_kvargs -DEPDIRS-librte_kvargs := librte_compat DIRS-$(CONFIG_RTE_LIBRTE_EAL) += librte_eal DEPDIRS-librte_eal := librte_kvargs DIRS-$(CONFIG_RTE_LIBRTE_PCI) += librte_pci
lib/librte_cmdline/meson.build +0 -1
@@ -3,7 +3,6 @@ # This library is processed before EAL includes = [global_inc] -includes += include_directories('../librte_eal/common/include') version = 2 sources = files('cmdline.c',
lib/librte_compat/Makefile deleted +0 -13
@@ -1,13 +0,0 @@ -# SPDX-License-Identifier: BSD-3-Clause -# Copyright(c) 2013 Neil Horman <[email protected]> -# All rights reserved. - -include $(RTE_SDK)/mk/rte.vars.mk - - -LIBABIVER := 1 - -# install includes -SYMLINK-y-include := rte_compat.h - -include $(RTE_SDK)/mk/rte.install.mk
lib/librte_compat/meson.build deleted +0 -8
@@ -1,8 +0,0 @@ -# SPDX-License-Identifier: BSD-3-Clause -# Copyright(c) 2017 Intel Corporation - - -install_headers('rte_compat.h') - -set_variable('dep_rte_compat', - declare_dependency(include_directories: include_directories('.')))
lib/librte_eal/common/Makefile +1 -1
@@ -3,7 +3,7 @@ include $(RTE_SDK)/mk/rte.vars.mk -INC := rte_branch_prediction.h rte_common.h +INC := rte_branch_prediction.h rte_common.h rte_compat.h INC += rte_debug.h rte_eal.h rte_eal_interrupts.h INC += rte_errno.h rte_launch.h rte_lcore.h INC += rte_log.h rte_memory.h rte_memzone.h
lib/librte_eal/common/include/rte_compat.h renamed from lib/librte_compat/rte_compat.h +0 -0
lib/librte_eal/common/meson.build +1 -0
@@ -53,6 +53,7 @@ common_headers = files( 'include/rte_bitmap.h', 'include/rte_class.h', 'include/rte_common.h', + 'include/rte_compat.h', 'include/rte_debug.h', 'include/rte_devargs.h', 'include/rte_dev.h',
lib/librte_eal/linuxapp/eal/meson.build +1 -1
@@ -1,7 +1,7 @@ # SPDX-License-Identifier: BSD-3-Clause # Copyright(c) 2017 Intel Corporation -eal_inc += include_directories('include', '../../../librte_compat') +eal_inc += include_directories('include') install_subdir('include/exec-env', install_dir: get_option('includedir')) env_objs = []
lib/librte_eal/meson.build +0 -1
@@ -23,7 +23,6 @@ endif version = 9 # the version of the EAL API allow_experimental_apis = true -deps += 'compat' deps += 'kvargs' sources = common_sources + env_sources objs = common_objs + env_objs
lib/librte_kvargs/meson.build +0 -3
@@ -2,10 +2,7 @@ # Copyright(c) 2017 Intel Corporation includes = [global_inc] -includes += include_directories('../librte_eal/common/include') version = 1 sources = files('rte_kvargs.c') headers = files('rte_kvargs.h') - -deps += 'compat'
lib/meson.build +1 -1
@@ -8,7 +8,7 @@ # sometimes skip deps that would be implied by others, e.g. if mempool is # given as a dep, no need to mention ring. This is especially true for the # core libs which are widely reused, so their deps are kept to a minimum. -libraries = [ 'compat', # just a header, used for versioning +libraries = [ 'cmdline', # ethdev depends on cmdline for parsing functions 'kvargs', # eal depends on kvargs 'eal', 'ring', 'mempool', 'mbuf', 'net', 'meter', 'ethdev', 'pci', # core
meson.build +1 -1
@@ -32,7 +32,7 @@ eal_pmd_path = join_paths(get_option('prefix'), driver_install_path) # configure the build, and make sure configs here and in config folder are # able to be included in any file. We also store a global array of include dirs # for passing to pmdinfogen scripts -global_inc = include_directories('.', 'config') +global_inc = include_directories('.', 'config', 'lib/librte_eal/common/include') subdir('config') # build libs and drivers
Signature · 1 line
2.20.1
Quoted 8 lines · Bruce Richardson
Since compat library is only a single header, we can easily move it into the EAL common headers instead of tracking it separately. The downside of this is that it becomes a little more difficult to have any libs that are built before EAL depend on it. Thankfully, this is not a major problem as the only library which uses
rte_compat.hand is built before EAL (kvargs) already has the path to thecompat.hheader file explicitly called out as an include path.
Quoted 8 lines
However, to ensure that we don't later hit problems later with this, we can add EAL common headers folder to the global include list in the meson build which means that all common headers can be safely used by all libraries, no matter what their build order.
As a side-effect, this patch also fixes an issue with building on BSD using meson, due to compat lib no longer needing to be listed as a dependency.
CC stable.
Quoted 38 lines
Fixes a8499f65a1d1 ("log: add missing experimental tag")Signed-off-by Bruce Richardson <[email protected]>---
V2: Clean up a few missed references to the compat library in our
documentation andMAINTAINERSfile.
Added in fixes tag, as this patch should also fix build issues with BSD.--- MAINTAINERS | 1 - doc/api/doxy-api.conf.in | 1 - doc/guides/contributing/documentation.rst | 1 - doc/guides/contributing/versioning.rst | 2 +- lib/Makefile | 2 -- lib/librte_cmdline/meson.build | 1 - lib/librte_compat/Makefile | 13 ------------- lib/librte_compat/meson.build | 8 -------- lib/librte_eal/common/Makefile | 2 +- .../common/include}/rte_compat.h | 0 lib/librte_eal/common/meson.build | 1 + lib/librte_eal/linuxapp/eal/meson.build | 2 +- lib/librte_eal/meson.build | 1 - lib/librte_kvargs/meson.build | 3 --- lib/meson.build | 2 +- meson.build | 2 +- 16 files changed, 6 insertions(+), 36 deletions(-) delete mode 100644 lib/librte_compat/Makefile delete mode 100644 lib/librte_compat/meson.build rename lib/{librte_compat => librte_eal/common/include}/rte_compat.h(100%)
MAINTAINERS +0
-0
MAINTAINERS F: buildtools/symlink-drivers-solibs.sh · line 124
Quoted 5 lines
MAINTAINERS +0
-1@@ -121,7 +121,6 @@ F: buildtools/symlink-drivers-solibs.sh ABI versioning M: Neil Horman <[email protected]> -F: lib/librte_compat/
Maybe ?
+F: lib/librte_eal/common/include/rte_compat.h
Signature · 1 line
David Marchand
Quoted 28 lines · David Marchand
On Thu, Jan 10, 2019 at 2:48 PM Bruce Richardson <[1][email protected]> wrote:
Since compat library is only a single header, we can easily move it into
the EAL common headers instead of tracking it separately. The downside of
this is that it becomes a little more difficult to have any libs that are
built before EAL depend on it. Thankfully, this is not a major problem as
the only library which usesrte_compat.hand is built before EAL (kvargs)
already has the path to thecompat.hheader file explicitly called out as
an include path.
However, to ensure that we don't later hit problems later with this, we can
add EAL common headers folder to the global include list in the meson build
which means that all common headers can be safely used by all libraries, no
matter what their build order.
As a side-effect, this patch also fixes an issue with building on BSD using
meson, due to compat lib no longer needing to be listed as a dependency.
Quoted 2 lines
CC stable.
Not needed. Defect introduced in a commit earlier in this release.
Quoted 39 lines
Fixes a8499f65a1d1 ("log: add missing experimental tag")Signed-off-by Bruce Richardson <[2][email protected]>---
V2: Clean up a few missed references to the compat library in our
documentation andMAINTAINERSfile.
Added in fixes tag, as this patch should also fix build issues with BSD.
---
MAINTAINERS| 1 -
doc/api/[3]doxy-api.conf.in | 1 -
doc/guides/contributing/documentation.rst| 1 -
doc/guides/contributing/versioning.rst| 2 +-
lib/Makefile | 2 --
lib/librte_cmdline/meson.build| 1 -
lib/librte_compat/Makefile| 13
-------------
lib/librte_compat/meson.build| 8 --------
lib/librte_eal/common/Makefile| 2 +-
.../common/include}/rte_compat.h| 0
lib/librte_eal/common/meson.build| 1 +
lib/librte_eal/linuxapp/eal/meson.build| 2 +-
lib/librte_eal/meson.build| 1 -
lib/librte_kvargs/meson.build| 3 ---
lib/meson.build| 2 +-
meson.build | 2 +-
16 files changed, 6 insertions(+), 36 deletions(-) delete mode 100644lib/librte_compat/Makefile
delete mode 100644lib/librte_compat/meson.buildrenamelib/{librte_compat=>
librte_eal/common/include}/rte_compat.h(100%)
diff --git a/MAINTAINERS b/MAINTAINERS
index470f36b9c..4dbb111a0100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -121,7 +121,6 @@ F:buildtools/symlink-drivers-solibs.sh
ABI versioning
M: Neil Horman <[4][email protected]>
-F:lib/librte_compat/
Quoted 5 lines
Maybe ?
+F:lib/librte_eal/common/include/rte_compat.hTested-by David Marchand <[5][email protected]>Reviewed-by David Marchand <[6][email protected]>--
CC: Neil
Not sure. I was thinking it would be covered just as part of the EAL generally, but I'm ok if Neil still wants explicit ownership of the file. If it is to be added, hopefully that could just be done on apply.
/Bruce
Quoted 18 lines · Bruce Richardson
Since compat library is only a single header, we can easily move it into the EAL common headers instead of tracking it separately. The downside of this is that it becomes a little more difficult to have any libs that are built before EAL depend on it. Thankfully, this is not a major problem as the only library which uses
rte_compat.hand is built before EAL (kvargs) already has the path to thecompat.hheader file explicitly called out as an include path.However, to ensure that we don't later hit problems later with this, we can add EAL common headers folder to the global include list in the meson build which means that all common headers can be safely used by all libraries, no matter what their build order.
As a side-effect, this patch also fixes an issue with building on BSD using meson, due to compat lib no longer needing to be listed as a dependency.
Fixes a8499f65a1d1 ("log: add missing experimental tag")
Quoted 8 lines
Signed-off-by Bruce Richardson <[email protected]>---
V2: Clean up a few missed references to the compat library in our
documentation andMAINTAINERSfile.
Added in fixes tag, as this patch should also fix build issues with BSD.
---
I can confirm that this fixes current FreeBSD meson build issues.
Signature · 2 lines
Thanks, Anatoly
Quoted 9 lines · Bruce Richardson
Since compat library is only a single header, we can easily move it into the EAL common headers instead of tracking it separately. The downside of this is that it becomes a little more difficult to have any libs that are built before EAL depend on it. Thankfully, this is not a major problem as the only library which uses
rte_compat.hand is built before EAL (kvargs) already has the path to thecompat.hheader file explicitly called out as an include path.However, to ensure that we don't later hit problems later with this, we can
Also, later you might later want to fix it later when applying the patch later :)
Quoted 12 lines
add EAL common headers folder to the global include list in the meson build which means that all common headers can be safely used by all libraries, no matter what their build order.
As a side-effect, this patch also fixes an issue with building on BSD using meson, due to compat lib no longer needing to be listed as a dependency.
Fixes a8499f65a1d1 ("log: add missing experimental tag")Signed-off-by Bruce Richardson <[email protected]>---
Signature · 2 lines
Thanks, Anatoly
PATCH v3 1/1 compat: merge compat library into EAL
In reply to Bruce RichardsonSince compat library is only a single header, we can easily move it into the EAL common headers instead of tracking it separately. The downside of this is that it becomes a little more difficult to have any libs that are built before EAL depend on it. Thankfully, this is not a major problem as the only library which uses rte_compat.h and is built before EAL (kvargs) already has the path to the compat.h header file explicitly called out as an include path.
However, to ensure that we don't hit problems later with this, we can add EAL common headers folder to the global include list in the meson build which means that all common headers can be safely used by all libraries, no matter what their build order.
As a side-effect, this patch also fixes an issue with building on BSD using meson, due to compat lib no longer needing to be listed as a dependency.
---
V3: Add stable on CC, and remove extra word in commit log.
V2: Clean up a few missed references to the compat library in our
documentation and MAINTAINERS file.
Added in fixes tag, as this patch should also fix build issues with BSD.
---
MAINTAINERS | 1 -
doc/api/doxy-api.conf.in | 1 -
doc/guides/contributing/documentation.rst | 1 -
doc/guides/contributing/versioning.rst | 2 +-
lib/Makefile | 2 --
lib/librte_cmdline/meson.build | 1 -
lib/librte_compat/Makefile | 13 -------------
lib/librte_compat/meson.build | 8 --------
lib/librte_eal/common/Makefile | 2 +-
.../common/include}/rte_compat.h | 0
lib/librte_eal/common/meson.build | 1 +
lib/librte_eal/linuxapp/eal/meson.build | 2 +-
lib/librte_eal/meson.build | 1 -
lib/librte_kvargs/meson.build | 3 ---
lib/meson.build | 2 +-
meson.build | 2 +-
16 files changed, 6 insertions(+), 36 deletions(-)
delete mode 100644 lib/librte_compat/Makefile
delete mode 100644 lib/librte_compat/meson.build
rename lib/{librte_compat => librte_eal/common/include}/rte_compat.h (100%)MAINTAINERS +0 -1
@@ -121,7 +121,6 @@ F: buildtools/symlink-drivers-solibs.sh ABI versioning M: Neil Horman <[email protected]> -F: lib/librte_compat/ F: doc/guides/rel_notes/deprecation.rst F: devtools/validate-abi.sh F: devtools/check-symbol-change.sh
doc/api/doxy-api.conf.in +0 -1
@@ -23,7 +23,6 @@ INPUT = @TOPDIR@/doc/api/doxy-api-index.md \ @TOPDIR@/lib/librte_bpf \ @TOPDIR@/lib/librte_cfgfile \ @TOPDIR@/lib/librte_cmdline \ - @TOPDIR@/lib/librte_compat \ @TOPDIR@/lib/librte_compressdev \ @TOPDIR@/lib/librte_cryptodev \ @TOPDIR@/lib/librte_distributor \
doc/guides/contributing/documentation.rst +0 -1
@@ -22,7 +22,6 @@ The main directories that contain files related to documentation are shown below |-- librte_acl |-- librte_cfgfile |-- librte_cmdline - |-- librte_compat |-- librte_eal | |-- ... ...
doc/guides/contributing/versioning.rst +1 -1
@@ -167,7 +167,7 @@ functionality or behavior. When that occurs, it is desirable to allow for backward compatibility for a time with older binaries that are dynamically linked to the DPDK. -To support backward compatibility the ``lib/librte_compat/rte_compat.h`` +To support backward compatibility the ``rte_compat.h`` header file provides macros to use when updating exported functions. These macros are used in conjunction with the ``rte_<library>_version.map`` file for a given library to allow multiple versions of a symbol to exist in a shared
lib/Makefile +0 -2
@@ -3,9 +3,7 @@ include $(RTE_SDK)/mk/rte.vars.mk -DIRS-y += librte_compat DIRS-$(CONFIG_RTE_LIBRTE_KVARGS) += librte_kvargs -DEPDIRS-librte_kvargs := librte_compat DIRS-$(CONFIG_RTE_LIBRTE_EAL) += librte_eal DEPDIRS-librte_eal := librte_kvargs DIRS-$(CONFIG_RTE_LIBRTE_PCI) += librte_pci
lib/librte_cmdline/meson.build +0 -1
@@ -3,7 +3,6 @@ # This library is processed before EAL includes = [global_inc] -includes += include_directories('../librte_eal/common/include') version = 2 sources = files('cmdline.c',
lib/librte_compat/Makefile deleted +0 -13
@@ -1,13 +0,0 @@ -# SPDX-License-Identifier: BSD-3-Clause -# Copyright(c) 2013 Neil Horman <[email protected]> -# All rights reserved. - -include $(RTE_SDK)/mk/rte.vars.mk - - -LIBABIVER := 1 - -# install includes -SYMLINK-y-include := rte_compat.h - -include $(RTE_SDK)/mk/rte.install.mk
lib/librte_compat/meson.build deleted +0 -8
@@ -1,8 +0,0 @@ -# SPDX-License-Identifier: BSD-3-Clause -# Copyright(c) 2017 Intel Corporation - - -install_headers('rte_compat.h') - -set_variable('dep_rte_compat', - declare_dependency(include_directories: include_directories('.')))
lib/librte_eal/common/Makefile +1 -1
@@ -3,7 +3,7 @@ include $(RTE_SDK)/mk/rte.vars.mk -INC := rte_branch_prediction.h rte_common.h +INC := rte_branch_prediction.h rte_common.h rte_compat.h INC += rte_debug.h rte_eal.h rte_eal_interrupts.h INC += rte_errno.h rte_launch.h rte_lcore.h INC += rte_log.h rte_memory.h rte_memzone.h
lib/librte_eal/common/include/rte_compat.h renamed from lib/librte_compat/rte_compat.h +0 -0
lib/librte_eal/common/meson.build +1 -0
@@ -53,6 +53,7 @@ common_headers = files( 'include/rte_bitmap.h', 'include/rte_class.h', 'include/rte_common.h', + 'include/rte_compat.h', 'include/rte_debug.h', 'include/rte_devargs.h', 'include/rte_dev.h',
lib/librte_eal/linuxapp/eal/meson.build +1 -1
@@ -1,7 +1,7 @@ # SPDX-License-Identifier: BSD-3-Clause # Copyright(c) 2017 Intel Corporation -eal_inc += include_directories('include', '../../../librte_compat') +eal_inc += include_directories('include') install_subdir('include/exec-env', install_dir: get_option('includedir')) env_objs = []
lib/librte_eal/meson.build +0 -1
@@ -23,7 +23,6 @@ endif version = 9 # the version of the EAL API allow_experimental_apis = true -deps += 'compat' deps += 'kvargs' sources = common_sources + env_sources objs = common_objs + env_objs
lib/librte_kvargs/meson.build +0 -3
@@ -2,10 +2,7 @@ # Copyright(c) 2017 Intel Corporation includes = [global_inc] -includes += include_directories('../librte_eal/common/include') version = 1 sources = files('rte_kvargs.c') headers = files('rte_kvargs.h') - -deps += 'compat'
lib/meson.build +1 -1
@@ -8,7 +8,7 @@ # sometimes skip deps that would be implied by others, e.g. if mempool is # given as a dep, no need to mention ring. This is especially true for the # core libs which are widely reused, so their deps are kept to a minimum. -libraries = [ 'compat', # just a header, used for versioning +libraries = [ 'cmdline', # ethdev depends on cmdline for parsing functions 'kvargs', # eal depends on kvargs 'eal', 'ring', 'mempool', 'mbuf', 'net', 'meter', 'ethdev', 'pci', # core
meson.build +1 -1
@@ -32,7 +32,7 @@ eal_pmd_path = join_paths(get_option('prefix'), driver_install_path) # configure the build, and make sure configs here and in config folder are # able to be included in any file. We also store a global array of include dirs # for passing to pmdinfogen scripts -global_inc = include_directories('.', 'config') +global_inc = include_directories('.', 'config', 'lib/librte_eal/common/include') subdir('config') # build libs and drivers
Signature · 1 line
2.20.1
Quoted 8 lines · Bruce Richardson
Since compat library is only a single header, we can easily move it into the EAL common headers instead of tracking it separately. The downside of this is that it becomes a little more difficult to have any libs that are built before EAL depend on it. Thankfully, this is not a major problem as the only library which uses
rte_compat.hand is built before EAL (kvargs) already has the path to thecompat.hheader file explicitly called out as an include path.
Quoted 5 lines
However, to ensure that we don't hit problems later with this, we can add EAL common headers folder to the global include list in the meson build which means that all common headers can be safely used by all libraries, no matter what their build order.
This assumes that the compat lib will always just be a header though, no? Will this work in the event that someone wants to add some compatibility code that requires its own C compilation unit?
Quoted 3 lines
As a side-effect, this patch also fixes an issue with building on BSD using meson, due to compat lib no longer needing to be listed as a dependency.
Can you elaborate here a bit please? listing a lib as a dependency seems like a fundamental function of a build system, was there a bug with meson in this capacity?
Thanks
Neil
Quoted 243 lines
Fixes a8499f65a1d1 ("log: add missing experimental tag")CC Neil Horman <[email protected]>Signed-off-by Bruce Richardson <[email protected]>Reviewed-by David Marchand <[email protected]>Tested-by David Marchand <[email protected]>Tested-by Anatoly Burakov <[email protected]>---
V3: Add stable on CC, and remove extra word in commit log.
V2: Clean up a few missed references to the compat library in our
documentation andMAINTAINERSfile.
Added in fixes tag, as this patch should also fix build issues with BSD.--- MAINTAINERS | 1 - doc/api/doxy-api.conf.in | 1 - doc/guides/contributing/documentation.rst | 1 - doc/guides/contributing/versioning.rst | 2 +- lib/Makefile | 2 -- lib/librte_cmdline/meson.build | 1 - lib/librte_compat/Makefile | 13 ------------- lib/librte_compat/meson.build | 8 -------- lib/librte_eal/common/Makefile | 2 +- .../common/include}/rte_compat.h | 0 lib/librte_eal/common/meson.build | 1 + lib/librte_eal/linuxapp/eal/meson.build | 2 +- lib/librte_eal/meson.build | 1 - lib/librte_kvargs/meson.build | 3 --- lib/meson.build | 2 +- meson.build | 2 +- 16 files changed, 6 insertions(+), 36 deletions(-) delete mode 100644 lib/librte_compat/Makefile delete mode 100644 lib/librte_compat/meson.build rename lib/{librte_compat => librte_eal/common/include}/rte_compat.h (100%)MAINTAINERS +0
-1@@ -121,7 +121,6 @@ F: buildtools/symlink-drivers-solibs.sh ABI versioning M: Neil Horman <[email protected]> -F: lib/librte_compat/ F: doc/guides/rel_notes/deprecation.rst F: devtools/validate-abi.sh F: devtools/check-symbol-change.shdoc/api/doxy-api.conf.in +0
-1@@ -23,7 +23,6 @@ INPUT = @TOPDIR@/doc/api/doxy-api-index.md \ @TOPDIR@/lib/librte_bpf \ @TOPDIR@/lib/librte_cfgfile \ @TOPDIR@/lib/librte_cmdline \ - @TOPDIR@/lib/librte_compat \ @TOPDIR@/lib/librte_compressdev \ @TOPDIR@/lib/librte_cryptodev \ @TOPDIR@/lib/librte_distributor \doc/guides/contributing/documentation.rst +0
-1@@ -22,7 +22,6 @@ The main directories that contain files related to documentation are shown below |-- librte_acl |-- librte_cfgfile |-- librte_cmdline - |-- librte_compat |-- librte_eal | |-- ...doc/guides/contributing/versioning.rst +1
-1@@ -167,7 +167,7 @@ functionality or behavior. When that occurs, it is desirable to allow for backward compatibility for a time with older binaries that are dynamically linked to the DPDK. -To support backward compatibility the ``lib/librte_compat/rte_compat.h`` +To support backward compatibility the ``rte_compat.h`` header file provides macros to use when updating exported functions. These macros are used in conjunction with the ``rte_<library>_version.map`` file for a given library to allow multiple versions of a symbol to exist in a sharedlib/Makefile +0
-2@@ -3,9 +3,7 @@ include $(RTE_SDK)/mk/rte.vars.mk -DIRS-y += librte_compat DIRS-$(CONFIG_RTE_LIBRTE_KVARGS) += librte_kvargs -DEPDIRS-librte_kvargs := librte_compat DIRS-$(CONFIG_RTE_LIBRTE_EAL) += librte_eal DEPDIRS-librte_eal := librte_kvargs DIRS-$(CONFIG_RTE_LIBRTE_PCI) += librte_pcilib/librte_cmdline/meson.build +0
-1@@ -3,7 +3,6 @@ # This library is processed before EAL includes = [global_inc] -includes += include_directories('../librte_eal/common/include') version = 2 sources = files('cmdline.c',lib/librte_compat/Makefile deleted +0
-13@@ -1,13 +0,0 @@ -# SPDX-License-Identifier: BSD-3-Clause -# Copyright(c) 2013 Neil Horman <[email protected]> -# All rights reserved. - -include $(RTE_SDK)/mk/rte.vars.mk - - -LIBABIVER := 1 - -# install includes -SYMLINK-y-include := rte_compat.h - -include $(RTE_SDK)/mk/rte.install.mklib/librte_compat/meson.build deleted +0
-8@@ -1,8 +0,0 @@ -# SPDX-License-Identifier: BSD-3-Clause -# Copyright(c) 2017 Intel Corporation - - -install_headers('rte_compat.h') - -set_variable('dep_rte_compat', - declare_dependency(include_directories: include_directories('.')))lib/librte_eal/common/Makefile +1
-1@@ -3,7 +3,7 @@ include $(RTE_SDK)/mk/rte.vars.mk -INC := rte_branch_prediction.h rte_common.h +INC := rte_branch_prediction.h rte_common.h rte_compat.h INC += rte_debug.h rte_eal.h rte_eal_interrupts.h INC += rte_errno.h rte_launch.h rte_lcore.h INC += rte_log.h rte_memory.h rte_memzone.hlib/librte_eal/common/include/rte_compat.h renamed from lib/librte_compat/rte_compat.h +0
-0lib/librte_eal/common/meson.build +1
-0@@ -53,6 +53,7 @@ common_headers = files( 'include/rte_bitmap.h', 'include/rte_class.h', 'include/rte_common.h', + 'include/rte_compat.h', 'include/rte_debug.h', 'include/rte_devargs.h', 'include/rte_dev.h',lib/librte_eal/linuxapp/eal/meson.build +1
-1@@ -1,7 +1,7 @@ # SPDX-License-Identifier: BSD-3-Clause # Copyright(c) 2017 Intel Corporation -eal_inc += include_directories('include', '../../../librte_compat') +eal_inc += include_directories('include') install_subdir('include/exec-env', install_dir: get_option('includedir')) env_objs = []lib/librte_eal/meson.build +0
-1@@ -23,7 +23,6 @@ endif version = 9 # the version of the EAL API allow_experimental_apis = true -deps += 'compat' deps += 'kvargs' sources = common_sources + env_sources objs = common_objs + env_objslib/librte_kvargs/meson.build +0
-3@@ -2,10 +2,7 @@ # Copyright(c) 2017 Intel Corporation includes = [global_inc] -includes += include_directories('../librte_eal/common/include') version = 1 sources = files('rte_kvargs.c') headers = files('rte_kvargs.h') - -deps += 'compat'lib/meson.build +1
-1@@ -8,7 +8,7 @@ # sometimes skip deps that would be implied by others, e.g. if mempool is # given as a dep, no need to mention ring. This is especially true for the # core libs which are widely reused, so their deps are kept to a minimum. -libraries = [ 'compat', # just a header, used for versioning +libraries = [ 'cmdline', # ethdev depends on cmdline for parsing functions 'kvargs', # eal depends on kvargs 'eal', 'ring', 'mempool', 'mbuf', 'net', 'meter', 'ethdev', 'pci', # coremeson.build +1
-1@@ -32,7 +32,7 @@ eal_pmd_path = join_paths(get_option('prefix'), driver_install_path) # configure the build, and make sure configs here and in config folder are # able to be included in any file. We also store a global array of include dirs # for passing to pmdinfogen scripts -global_inc = include_directories('.', 'config') +global_inc = include_directories('.', 'config', 'lib/librte_eal/common/include') subdir('config') # build libs and driversSignature · 1 line
2.20.1
Quoted 9 lines · Neil Horman
Quoted 8 lines · Bruce Richardson
Since compat library is only a single header, we can easily move it into the EAL common headers instead of tracking it separately. The downside of this is that it becomes a little more difficult to have any libs that are built before EAL depend on it. Thankfully, this is not a major problem as the only library which uses
rte_compat.hand is built before EAL (kvargs) already has the path to thecompat.hheader file explicitly called out as an include path.
Quoted 9 lines
Quoted 5 lines
However, to ensure that we don't hit problems later with this, we can add EAL common headers folder to the global include list in the meson build which means that all common headers can be safely used by all libraries, no matter what their build order.
This assumes that the compat lib will always just be a header though, no? Will this work in the event that someone wants to add some compatibility code that requires its own C compilation unit?
No, it probably won't work, you'll hit an issue with any libraries that don't depend on EAL and need that functionality. The question is whether this is likely to be an issue in the future for us. I'd say the possiblity is fairly remote, but I'm open to input on it.
Quoted 7 lines
Quoted 3 lines
As a side-effect, this patch also fixes an issue with building on BSD using meson, due to compat lib no longer needing to be listed as a dependency.
Can you elaborate here a bit please? listing a lib as a dependency seems like a fundamental function of a build system, was there a bug with meson in this capacity?
It was a bug in DPDK. There was already a dependency on the compat library from libeal from linux, but not from BSD, so when a further dependency was added globally, the BSD build broke, but the linux one didn't.
/Bruce
Quoted 20 lines · Bruce Richardson
Quoted 9 lines · Neil Horman
Quoted 8 lines · Bruce Richardson
Since compat library is only a single header, we can easily move it into the EAL common headers instead of tracking it separately. The downside of this is that it becomes a little more difficult to have any libs that are built before EAL depend on it. Thankfully, this is not a major problem as the only library which uses
rte_compat.hand is built before EAL (kvargs) already has the path to thecompat.hheader file explicitly called out as an include path.Quoted 9 lines
Quoted 5 lines
However, to ensure that we don't hit problems later with this, we can add EAL common headers folder to the global include list in the meson build which means that all common headers can be safely used by all libraries, no matter what their build order.
This assumes that the compat lib will always just be a header though, no? Will this work in the event that someone wants to add some compatibility code that requires its own C compilation unit?
Quoted 5 lines
No, it probably won't work, you'll hit an issue with any libraries that don't depend on EAL and need that functionality. The question is whether this is likely to be an issue in the future for us. I'd say the possiblity is fairly remote, but I'm open to input on it.
Im afraid I don't have any more visibility on that than anyone else. The fact that it hasn't been needed yet is likely a good sign, but I am concerned at the notion that this change enjoins us from having that flexibility.
Quoted 8 lines
Quoted 7 lines
Quoted 3 lines
As a side-effect, this patch also fixes an issue with building on BSD using meson, due to compat lib no longer needing to be listed as a dependency.
Can you elaborate here a bit please? listing a lib as a dependency seems like a fundamental function of a build system, was there a bug with meson in this capacity?
Quoted 5 lines
It was a bug in DPDK. There was already a dependency on the compat library from libeal from linux, but not from BSD, so when a further dependency was added globally, the BSD build broke, but the linux one didn't.
Do you have a link to the breakage details? I'd like to look at it to see if there is a way around this without enjoining us from adding compat C files in the future.
Thanks
Neil
Quoted 2 lines
/Bruce
Quoted 21 lines · Neil Horman
Quoted 20 lines · Bruce Richardson
Quoted 18 lines · Neil Horman
Quoted 8 lines · Bruce Richardson
Since compat library is only a single header, we can easily move it into the EAL common headers instead of tracking it separately. The downside of this is that it becomes a little more difficult to have any libs that are built before EAL depend on it. Thankfully, this is not a major problem as the only library which uses
rte_compat.hand is built before EAL (kvargs) already has the path to thecompat.hheader file explicitly called out as an include path.Quoted 5 lines
However, to ensure that we don't hit problems later with this, we can add EAL common headers folder to the global include list in the meson build which means that all common headers can be safely used by all libraries, no matter what their build order.
This assumes that the compat lib will always just be a header though, no? Will this work in the event that someone wants to add some compatibility code that requires its own C compilation unit?
Quoted 9 lines
Quoted 5 lines
No, it probably won't work, you'll hit an issue with any libraries that don't depend on EAL and need that functionality. The question is whether this is likely to be an issue in the future for us. I'd say the possiblity is fairly remote, but I'm open to input on it.
Im afraid I don't have any more visibility on that than anyone else. The fact that it hasn't been needed yet is likely a good sign, but I am concerned at the notion that this change enjoins us from having that flexibility.
Yes. However, in general is it not the case that compatibility code belongs in the actual library wanting to provide the compatibility? That is what has been done up till now. If we do need compatibility code placed more centrally, I think EAL is as good a place for it as any - the only library which doesn't depend on EAL now is kvargs, so our risk area is pretty low, I think.
Also, if we do need a compat libraries with .c files in it, there is no reason we can't undo this change. It would be no more user visible than adding a .c file to the existing structure, given that in both cases an extra .so file will appear in the build output.
Quoted 8 lines
Quoted 8 lines
Quoted 7 lines
Quoted 3 lines
As a side-effect, this patch also fixes an issue with building on BSD using meson, due to compat lib no longer needing to be listed as a dependency.
Can you elaborate here a bit please? listing a lib as a dependency seems like a fundamental function of a build system, was there a bug with meson in this capacity?
Quoted 9 lines
Quoted 5 lines
It was a bug in DPDK. There was already a dependency on the compat library from libeal from linux, but not from BSD, so when a further dependency was added globally, the BSD build broke, but the linux one didn't.
Do you have a link to the breakage details? I'd like to look at it to see if there is a way around this without enjoining us from adding compat C files in the future.
Don't have a link handy, but the basics, as I understand them are as below:
Commit a8499f65a1d1 ("log: add missing experimental tag"), added the experimental tag to a log function. To get this tag definition rte_compat.h header was included in the rte_log.h file in the "common" EAL folder. In build tests on linux, this was no problem since linuxapp/eal/meson.build had the line:
eal_inc += include_directories('include', '../../../librte_compat')However, the BSD eal/meson.build file did not have this line, giving a compiler error.
/Bruce
PS: Now that I also look at the files more closely, with this move to put compat.h into EAL, we can probably remove the special case processing in lib/meson.build for libraries with an empty source array.
Neil Horman
Acked-byQuoted 38 lines · Bruce Richardson
Quoted 21 lines · Neil Horman
Quoted 20 lines · Bruce Richardson
Quoted 18 lines · Neil Horman
Quoted 8 lines · Bruce Richardson
Since compat library is only a single header, we can easily move it into the EAL common headers instead of tracking it separately. The downside of this is that it becomes a little more difficult to have any libs that are built before EAL depend on it. Thankfully, this is not a major problem as the only library which uses
rte_compat.hand is built before EAL (kvargs) already has the path to thecompat.hheader file explicitly called out as an include path.Quoted 5 lines
However, to ensure that we don't hit problems later with this, we can add EAL common headers folder to the global include list in the meson build which means that all common headers can be safely used by all libraries, no matter what their build order.
This assumes that the compat lib will always just be a header though, no? Will this work in the event that someone wants to add some compatibility code that requires its own C compilation unit?
Quoted 9 lines
Quoted 5 lines
No, it probably won't work, you'll hit an issue with any libraries that don't depend on EAL and need that functionality. The question is whether this is likely to be an issue in the future for us. I'd say the possiblity is fairly remote, but I'm open to input on it.
Im afraid I don't have any more visibility on that than anyone else. The fact that it hasn't been needed yet is likely a good sign, but I am concerned at the notion that this change enjoins us from having that flexibility.
Yes. However, in general is it not the case that compatibility code belongs in the actual library wanting to provide the compatibility? That is what has been done up till now. If we do need compatibility code placed more centrally, I think EAL is as good a place for it as any - the only library which doesn't depend on EAL now is kvargs, so our risk area is pretty low, I think.
Quoted 5 lines
Also, if we do need a compat libraries with .c files in it, there is no reason we can't undo this change. It would be no more user visible than adding a .c file to the existing structure, given that in both cases an extra .so file will appear in the build output.
If the consensus is that compat code can all live in the EAL library, then I'm ok with it, even if its C code. The only thing I don't want is for our plan to be, in the event we need C code, to immediately undo this change. That just doesn't make sense to me.
So, if you're ok with compat C code in eal, then
Quoted 35 lines
Quoted 8 lines
Quoted 8 lines
Quoted 7 lines
Quoted 3 lines
As a side-effect, this patch also fixes an issue with building on BSD using meson, due to compat lib no longer needing to be listed as a dependency.
Can you elaborate here a bit please? listing a lib as a dependency seems like a fundamental function of a build system, was there a bug with meson in this capacity?
Quoted 9 lines
Quoted 5 lines
It was a bug in DPDK. There was already a dependency on the compat library from libeal from linux, but not from BSD, so when a further dependency was added globally, the BSD build broke, but the linux one didn't.
Do you have a link to the breakage details? I'd like to look at it to see if there is a way around this without enjoining us from adding compat C files in the future.
Don't have a link handy, but the basics, as I understand them are as below:
Commit
a8499f65a1d1("log: add missing experimental tag"), added the experimental tag to a log function. To get this tag definitionrte_compat.hheader was included in therte_log.hfile in the "common" EAL folder. In build tests on linux, this was no problem since linuxapp/eal/meson.build had the line:eal_inc += include_directories('include', '../../../librte_compat')However, the BSD eal/meson.build file did not have this line, giving a compiler error.
/Bruce
PS: Now that I also look at the files more closely, with this move to put
compat.hinto EAL, we can probably remove the special case processing inlib/meson.buildfor libraries with an empty source array.
Quoted 44 lines · Neil Horman
Quoted 38 lines · Bruce Richardson
Quoted 21 lines · Neil Horman
Quoted 20 lines · Bruce Richardson
Quoted 18 lines · Neil Horman
Quoted 8 lines · Bruce Richardson
Since compat library is only a single header, we can easily move it into the EAL common headers instead of tracking it separately. The downside of this is that it becomes a little more difficult to have any libs that are built before EAL depend on it. Thankfully, this is not a major problem as the only library which uses
rte_compat.hand is built before EAL (kvargs) already has the path to thecompat.hheader file explicitly called out as an include path.Quoted 5 lines
However, to ensure that we don't hit problems later with this, we can add EAL common headers folder to the global include list in the meson build which means that all common headers can be safely used by all libraries, no matter what their build order.
This assumes that the compat lib will always just be a header though, no? Will this work in the event that someone wants to add some compatibility code that requires its own C compilation unit?
Quoted 9 lines
Quoted 5 lines
No, it probably won't work, you'll hit an issue with any libraries that don't depend on EAL and need that functionality. The question is whether this is likely to be an issue in the future for us. I'd say the possiblity is fairly remote, but I'm open to input on it.
Im afraid I don't have any more visibility on that than anyone else. The fact that it hasn't been needed yet is likely a good sign, but I am concerned at the notion that this change enjoins us from having that flexibility.
Yes. However, in general is it not the case that compatibility code belongs in the actual library wanting to provide the compatibility? That is what has been done up till now. If we do need compatibility code placed more centrally, I think EAL is as good a place for it as any - the only library which doesn't depend on EAL now is kvargs, so our risk area is pretty low, I think.
Quoted 5 lines
Also, if we do need a compat libraries with .c files in it, there is no reason we can't undo this change. It would be no more user visible than adding a .c file to the existing structure, given that in both cases an extra .so file will appear in the build output.
Quoted 8 lines
If the consensus is that compat code can all live in the EAL library, then I'm ok with it, even if its C code. The only thing I don't want is for our plan to be, in the event we need C code, to immediately undo this change. That just doesn't make sense to me.
So, if you're ok with compat C code in eal, then
Acked-by Neil Horman <[email protected]>
Can you clarify what you would see as the compat C code that would be needed - perhaps an example from another project? From the little function versioning I've done in DPDK, I would have thought what was in the headers was enough for all cases we might encounter.
/Bruce
Quoted 50 lines · Bruce Richardson
Quoted 49 lines · Neil Horman
Quoted 38 lines · Bruce Richardson
Quoted 21 lines · Neil Horman
Quoted 20 lines · Bruce Richardson
Quoted 18 lines · Neil Horman
Quoted 8 lines · Bruce Richardson
Since compat library is only a single header, we can easily move it into the EAL common headers instead of tracking it separately. The downside of this is that it becomes a little more difficult to have any libs that are built before EAL depend on it. Thankfully, this is not a major problem as the only library which uses
rte_compat.hand is built before EAL (kvargs) already has the path to thecompat.hheader file explicitly called out as an include path.Quoted 5 lines
However, to ensure that we don't hit problems later with this, we can add EAL common headers folder to the global include list in the meson build which means that all common headers can be safely used by all libraries, no matter what their build order.
This assumes that the compat lib will always just be a header though, no? Will this work in the event that someone wants to add some compatibility code that requires its own C compilation unit?
Quoted 9 lines
Quoted 5 lines
No, it probably won't work, you'll hit an issue with any libraries that don't depend on EAL and need that functionality. The question is whether this is likely to be an issue in the future for us. I'd say the possiblity is fairly remote, but I'm open to input on it.
Im afraid I don't have any more visibility on that than anyone else. The fact that it hasn't been needed yet is likely a good sign, but I am concerned at the notion that this change enjoins us from having that flexibility.
Yes. However, in general is it not the case that compatibility code belongs in the actual library wanting to provide the compatibility? That is what has been done up till now. If we do need compatibility code placed more centrally, I think EAL is as good a place for it as any - the only library which doesn't depend on EAL now is kvargs, so our risk area is pretty low, I think.
Quoted 5 lines
Also, if we do need a compat libraries with .c files in it, there is no reason we can't undo this change. It would be no more user visible than adding a .c file to the existing structure, given that in both cases an extra .so file will appear in the build output.
If the consensus is that compat code can all live in the EAL library, then I'm ok with it, even if its C code. The only thing I don't want is for our plan to be, in the event we need C code, to immediately undo this change. That just doesn't make sense to me.
Quoted 8 lines
Quoted 3 lines
So, if you're ok with compat C code in eal, then
Acked-by Neil Horman <[email protected]>Can you clarify what you would see as the compat C code that would be needed - perhaps an example from another project? From the little function versioning I've done in DPDK, I would have thought what was in the headers was enough for all cases we might encounter.
I can't, hence my ACK. I was really just concerned that we were making a change that enjoined us from being able to add C compilation units should we need them, but if we can add them directly to the EAL libraries, I'm satisfied with that.
Neil
Quoted 2 lines
/Bruce
Quoted 59 lines · Neil Horman
Quoted 50 lines · Bruce Richardson
Quoted 49 lines · Neil Horman
Quoted 38 lines · Bruce Richardson
Quoted 21 lines · Neil Horman
Quoted 20 lines · Bruce Richardson
Quoted 18 lines · Neil Horman
Quoted 8 lines · Bruce Richardson
Since compat library is only a single header, we can easily move it into the EAL common headers instead of tracking it separately. The downside of this is that it becomes a little more difficult to have any libs that are built before EAL depend on it. Thankfully, this is not a major problem as the only library which uses
rte_compat.hand is built before EAL (kvargs) already has the path to thecompat.hheader file explicitly called out as an include path.Quoted 5 lines
However, to ensure that we don't hit problems later with this, we can add EAL common headers folder to the global include list in the meson build which means that all common headers can be safely used by all libraries, no matter what their build order.
This assumes that the compat lib will always just be a header though, no? Will this work in the event that someone wants to add some compatibility code that requires its own C compilation unit?
Quoted 9 lines
Quoted 5 lines
No, it probably won't work, you'll hit an issue with any libraries that don't depend on EAL and need that functionality. The question is whether this is likely to be an issue in the future for us. I'd say the possiblity is fairly remote, but I'm open to input on it.
Im afraid I don't have any more visibility on that than anyone else. The fact that it hasn't been needed yet is likely a good sign, but I am concerned at the notion that this change enjoins us from having that flexibility.
Yes. However, in general is it not the case that compatibility code belongs in the actual library wanting to provide the compatibility? That is what has been done up till now. If we do need compatibility code placed more centrally, I think EAL is as good a place for it as any - the only library which doesn't depend on EAL now is kvargs, so our risk area is pretty low, I think.
Quoted 5 lines
Also, if we do need a compat libraries with .c files in it, there is no reason we can't undo this change. It would be no more user visible than adding a .c file to the existing structure, given that in both cases an extra .so file will appear in the build output.
If the consensus is that compat code can all live in the EAL library, then I'm ok with it, even if its C code. The only thing I don't want is for our plan to be, in the event we need C code, to immediately undo this change. That just doesn't make sense to me.
Quoted 8 lines
Quoted 3 lines
So, if you're ok with compat C code in eal, then
Acked-by Neil Horman <[email protected]>Can you clarify what you would see as the compat C code that would be needed - perhaps an example from another project? From the little function versioning I've done in DPDK, I would have thought what was in the headers was enough for all cases we might encounter.
Quoted 6 lines
I can't, hence my ACK. I was really just concerned that we were making a change that enjoined us from being able to add C compilation units should we need them, but if we can add them directly to the EAL libraries, I'm satisfied with that.
Neil
Ok, thanks, Neil.
+Thomas, in case you have any concerns or thoughts here.
Quoted 64 lines · Bruce Richardson
Quoted 63 lines · Neil Horman
Quoted 50 lines · Bruce Richardson
Quoted 49 lines · Neil Horman
Quoted 38 lines · Bruce Richardson
Quoted 21 lines · Neil Horman
Quoted 20 lines · Bruce Richardson
Quoted 18 lines · Neil Horman
Quoted 8 lines · Bruce Richardson
Since compat library is only a single header, we can easily move it into the EAL common headers instead of tracking it separately. The downside of this is that it becomes a little more difficult to have any libs that are built before EAL depend on it. Thankfully, this is not a major problem as the only library which uses
rte_compat.hand is built before EAL (kvargs) already has the path to thecompat.hheader file explicitly called out as an include path.Quoted 5 lines
However, to ensure that we don't hit problems later with this, we can add EAL common headers folder to the global include list in the meson build which means that all common headers can be safely used by all libraries, no matter what their build order.
This assumes that the compat lib will always just be a header though, no? Will this work in the event that someone wants to add some compatibility code that requires its own C compilation unit?
Quoted 9 lines
Quoted 5 lines
No, it probably won't work, you'll hit an issue with any libraries that don't depend on EAL and need that functionality. The question is whether this is likely to be an issue in the future for us. I'd say the possiblity is fairly remote, but I'm open to input on it.
Im afraid I don't have any more visibility on that than anyone else. The fact that it hasn't been needed yet is likely a good sign, but I am concerned at the notion that this change enjoins us from having that flexibility.
Yes. However, in general is it not the case that compatibility code belongs in the actual library wanting to provide the compatibility? That is what has been done up till now. If we do need compatibility code placed more centrally, I think EAL is as good a place for it as any - the only library which doesn't depend on EAL now is kvargs, so our risk area is pretty low, I think.
Quoted 5 lines
Also, if we do need a compat libraries with .c files in it, there is no reason we can't undo this change. It would be no more user visible than adding a .c file to the existing structure, given that in both cases an extra .so file will appear in the build output.
If the consensus is that compat code can all live in the EAL library, then I'm ok with it, even if its C code. The only thing I don't want is for our plan to be, in the event we need C code, to immediately undo this change. That just doesn't make sense to me.
Quoted 8 lines
Quoted 3 lines
So, if you're ok with compat C code in eal, then
Acked-by Neil Horman <[email protected]>Can you clarify what you would see as the compat C code that would be needed - perhaps an example from another project? From the little function versioning I've done in DPDK, I would have thought what was in the headers was enough for all cases we might encounter.
I can't, hence my ACK. I was really just concerned that we were making a change that enjoined us from being able to add C compilation units should we need them, but if we can add them directly to the EAL libraries, I'm satisfied with that.
Quoted 5 lines
Quoted 2 lines
Neil
Ok, thanks, Neil.
+Thomas, in case you have any concerns or thoughts here.
Ping on this patch. As far as I am concerned, this is ready for merge.
Currently the FreeBSD builds using meson are broken, and this patch or another fix is needed to get them working again.
Regards,
/Bruce
Thomas Monjalon
Applied06/02/2019 12:01, Bruce Richardson:
Quoted 16 lines
Since compat library is only a single header, we can easily move it into the EAL common headers instead of tracking it separately. The downside of this is that it becomes a little more difficult to have any libs that are built before EAL depend on it. Thankfully, this is not a major problem as the only library which uses
rte_compat.hand is built before EAL (kvargs) already has the path to thecompat.hheader file explicitly called out as an include path.However, to ensure that we don't hit problems later with this, we can add EAL common headers folder to the global include list in the meson build which means that all common headers can be safely used by all libraries, no matter what their build order.
As a side-effect, this patch also fixes an issue with building on BSD using meson, due to compat lib no longer needing to be listed as a dependency.
Quoted 8 lines
Fixes a8499f65a1d1 ("log: add missing experimental tag")CC Neil Horman <[email protected]>Signed-off-by Bruce Richardson <[email protected]>Reviewed-by David Marchand <[email protected]>Tested-by David Marchand <[email protected]>Tested-by Anatoly Burakov <[email protected]>
Applied, thanks