DPDK-dev Archive on lore.kernel.org
 help / color / Atom feed
* [dpdk-dev] [RFC 0/6] Add ABI compatibility checks to the meson build
@ 2019-10-23  1:07 Kevin Laatz
  2019-10-23  1:07 ` [dpdk-dev] [RFC 1/6] build: enable debug info by default in meson builds Kevin Laatz
                   ` (7 more replies)
  0 siblings, 8 replies; 60+ messages in thread
From: Kevin Laatz @ 2019-10-23  1:07 UTC (permalink / raw)
  To: dev; +Cc: bruce.richardson, thomas, ray.kinsella, Kevin Laatz

With the recent changes made to stabilize ABI versioning in DPDK, it will
become increasingly important to check patches for ABI compatibility. We
propose adding the ABI compatibility checking to be done as part of the

The advantages to adding the ABI compatibility checking to the build are
two-fold. Firstly, developers can easily check their patches to make sure
they don’t break the ABI without adding any extra steps. Secondly, it
makes the integration into existing CI seamless since there are no extra
scripts to make the CI run. The build will run as usual and if an
incompatibility is detected in the ABI, the build will fail and show the
incompatibility. As an added bonus, enabling the ABI compatibility checks
does not impact the build speed.

The proposed solution works as follows:
1. Generate the ABI dump of the baseline. This can be done with the new
   script added in this RFC. This step will only need to be done when the
   ABI version changes (so once a year) and can be added to master so it
   exists by default. This step can be skipped if the dump files for the
   baseline already exist.
2. Build with meson. If there is an ABI incompatibility, the build will
   fail and print the incompatibility information.

The patches accompanying this RFC add the ABI dump file generating script,
the meson option required to enable/disable the checks, and the required
meson changes to run the compatibility checks during the build.

This patchset depends on:
 - The "Implement the new ABI policy and add helper scripts" patchset
 - The "Add scanning for experimental symbols to meson" patchset
 - "build: enable extra warnings for meson build" patch

Bruce Richardson (2):
  build: enable debug info by default in meson builds
  build: use meson warning levels

Kevin Laatz (4):
  devtools: add abi dump generation script
  build: add meson option for abi related checks
  build: add lib abi checks to meson
  build: add drivers abi checks to meson

 buildtools/meson.build   |  4 ++++
 config/meson.build       | 40 +++++++++++++++++++++-------------------
 devtools/gen-abi-dump.sh | 24 ++++++++++++++++++++++++
 drivers/meson.build      | 17 ++++++++++++++++-
 lib/meson.build          | 17 ++++++++++++++++-
 meson.build              |  9 ++++++++-
 meson_options.txt        |  2 ++
 7 files changed, 91 insertions(+), 22 deletions(-)
 create mode 100755 devtools/gen-abi-dump.sh


^ permalink raw reply	[flat|nested] 60+ messages in thread