* [dpdk-dev] [PATCH v9 0/4] doc: changes to abi policy introducing major abi versions
@ 2019-11-08 12:46 Ray Kinsella
2019-11-08 12:46 ` [dpdk-dev] [PATCH v9 1/4] doc: separate versioning.rst into version and policy Ray Kinsella
` (5 more replies)
0 siblings, 6 replies; 20+ messages in thread
From: Ray Kinsella @ 2019-11-08 12:46 UTC (permalink / raw)
To: dev
Cc: mdr, thomas, stephen, bruce.richardson, ferruh.yigit,
konstantin.ananyev, jerinj, olivier.matz, nhorman,
maxime.coquelin, john.mcnamara, marko.kovacevic, hemant.agrawal,
ktraynor, aconole
TL;DR abbreviation:
A major ABI version that all DPDK releases during an agreed period support. ABI
versioning is managed at a project-level, in place of library-level management.
ABI changes to add new features are permitted, as long as ABI compatibility with
the major ABI version is maintained.
Detail:
This patch introduces major ABI versions, initally released aligned with the LTS
release and maintained for one year through subsequent releases. The intention
is that the one year abi support period, will then be reviewed after the initial
year with the intention of lengthening the period for the next ABI version and
declaring new major ABI versions less frequently.
ABI changes that preserve ABI compatibility with the major ABI version are
permitted in subsequent releases. ABI changes, follow similar approval rules as
before with the additional gate of now requiring technical board approval. The
merging and release of ABI breaking changes would now be pushed to the
declaration of the next major ABI version.
This change encourages developers to maintain ABI compatibility with the major
ABI version, by promoting a permissive culture around those changes that
preserve ABI compatibility. This approach begins to align DPDK with those
projects that declare major ABI versions (e.g. version 2.x, 3.x) and support
those versions for some period, typically two years or more.
To provide an example of how this might work in practice:
* DPDK v20 is declared as the supported ABI version for one year, aligned with
the DPDK v19.11 (LTS) release. All library sonames are updated to reflect the
new ABI version, e.g. librte_eal.so.20, librte_acl.so.20...
* DPDK v20.02 .. v20.08 releases are ABI compatible with the DPDK v20 ABI. ABI
changes are permitted from DPDK v20.02 onwards, with the condition that ABI
compatibility with DPDK v20 is preserved.
* DPDK v21 is declared as the new supported ABI version for two years, aligned
with the DPDK v20.11 (LTS) release. The DPDK v20 ABI is now depreciated,
library sonames are updated to v21 and ABI compatibility breaking changes may
be introduced.
v9
* Loosened up word around when new major ABI's are declared.
(as suggested by Thomas Monjalon and agreed at the Techboard)
v8
* Fixed intermediate build warnings, figure annotations and typo's.
(as suggested by John McNamara).
v7
* PNGs are now SVG. Some additional clarifications. Fixed typos and grammatical
errors. (as suggested by Thomas Monjalon and David Marchand)
v6
* Added figure to abi_policy.rst, comparing and contrasting the DPDK abi and
api. (as suggested by Aaron Conole)
v5
* Added figure to abi_policy.rst, mapping abi versions and abi compatibility to
DPDK releases. (as suggested by Neil Horman)
v4
* Removed changes to stable.rst, fixed typos and clarified the ABI policy
"warning".
v3
* Added myself as the maintainer of the ABI policy.
* Updated the policy and versioning guides to use the year of the LTS+1 (e.g.
v20), as the abi major version number.
v2
* Restructured the patch into 3 patches:
1. Splits the original versioning document into an ABI policy document
and ABI versioning document.
2. Add changes to the policy document introducing major ABI versions.
3. Fixes up the versioning document in light of major ABI versioning.
* Reduces the initial ABI stability from two years to one year, with a review
after the first year.
* Adds detail around ABI version handling for experimental libraries.
* Adds detail around chain of responsility for removing deprecated symbols.
Ray Kinsella (4):
doc: separate versioning.rst into version and policy
doc: changes to abi policy introducing major abi versions
doc: updates to versioning guide for abi versions
doc: add maintainer for abi policy
MAINTAINERS | 4 +
doc/guides/contributing/abi_policy.rst | 326 ++++++
doc/guides/contributing/abi_versioning.rst | 515 ++++++++++
.../contributing/img/abi_stability_policy.svg | 1059 ++++++++++++++++++++
doc/guides/contributing/img/what_is_an_abi.svg | 382 +++++++
doc/guides/contributing/index.rst | 3 +-
doc/guides/contributing/patches.rst | 6 +-
doc/guides/contributing/stable.rst | 12 +-
doc/guides/contributing/versioning.rst | 591 -----------
doc/guides/rel_notes/deprecation.rst | 6 +-
10 files changed, 2298 insertions(+), 606 deletions(-)
create mode 100644 doc/guides/contributing/abi_policy.rst
create mode 100644 doc/guides/contributing/abi_versioning.rst
create mode 100644 doc/guides/contributing/img/abi_stability_policy.svg
create mode 100644 doc/guides/contributing/img/what_is_an_abi.svg
delete mode 100644 doc/guides/contributing/versioning.rst
--
2.7.4
^ permalink raw reply [flat|nested] 20+ messages in thread* [dpdk-dev] [PATCH v9 1/4] doc: separate versioning.rst into version and policy 2019-11-08 12:46 [dpdk-dev] [PATCH v9 0/4] doc: changes to abi policy introducing major abi versions Ray Kinsella @ 2019-11-08 12:46 ` Ray Kinsella 2019-11-08 12:46 ` [dpdk-dev] [PATCH v9 2/4] doc: changes to abi policy introducing major abi versions Ray Kinsella ` (4 subsequent siblings) 5 siblings, 0 replies; 20+ messages in thread From: Ray Kinsella @ 2019-11-08 12:46 UTC (permalink / raw) To: dev Cc: mdr, thomas, stephen, bruce.richardson, ferruh.yigit, konstantin.ananyev, jerinj, olivier.matz, nhorman, maxime.coquelin, john.mcnamara, marko.kovacevic, hemant.agrawal, ktraynor, aconole Separate versioning.rst into abi versioning and abi policy guidance, in preparation for adding more detail to the abi policy. Signed-off-by: Ray Kinsella <mdr@ashroe.eu> Acked-by: John Mcnamara <john.mcnamara@intel.com> Acked-by: Stephen Hemminger <stephen@networkplumber.org> --- doc/guides/contributing/abi_policy.rst | 167 ++++++++ doc/guides/contributing/abi_versioning.rst | 427 +++++++++++++++++++++ doc/guides/contributing/index.rst | 3 +- doc/guides/contributing/patches.rst | 2 +- doc/guides/contributing/versioning.rst | 591 ----------------------------- doc/guides/rel_notes/deprecation.rst | 2 +- 6 files changed, 598 insertions(+), 594 deletions(-) create mode 100644 doc/guides/contributing/abi_policy.rst create mode 100644 doc/guides/contributing/abi_versioning.rst delete mode 100644 doc/guides/contributing/versioning.rst diff --git a/doc/guides/contributing/abi_policy.rst b/doc/guides/contributing/abi_policy.rst new file mode 100644 index 0000000..d4f4e9f --- /dev/null +++ b/doc/guides/contributing/abi_policy.rst @@ -0,0 +1,167 @@ +.. SPDX-License-Identifier: BSD-3-Clause + Copyright 2018 The DPDK contributors + +DPDK ABI/API policy +=================== + +Description +----------- + +This document details some methods for handling ABI management in the DPDK. + +General Guidelines +------------------ + +#. Whenever possible, ABI should be preserved +#. ABI/API may be changed with a deprecation process +#. The modification of symbols can generally be managed with versioning +#. Libraries or APIs marked in ``experimental`` state may change without constraint +#. New APIs will be marked as ``experimental`` for at least one release to allow + any issues found by users of the new API to be fixed quickly +#. The addition of symbols is generally not problematic +#. The removal of symbols generally is an ABI break and requires bumping of the + LIBABIVER macro +#. Updates to the minimum hardware requirements, which drop support for hardware which + was previously supported, should be treated as an ABI change. + +What is an ABI +~~~~~~~~~~~~~~ + +An ABI (Application Binary Interface) is the set of runtime interfaces exposed +by a library. It is similar to an API (Application Programming Interface) but +is the result of compilation. It is also effectively cloned when applications +link to dynamic libraries. That is to say when an application is compiled to +link against dynamic libraries, it is assumed that the ABI remains constant +between the time the application is compiled/linked, and the time that it runs. +Therefore, in the case of dynamic linking, it is critical that an ABI is +preserved, or (when modified), done in such a way that the application is unable +to behave improperly or in an unexpected fashion. + + +ABI/API Deprecation +------------------- + +The DPDK ABI policy +~~~~~~~~~~~~~~~~~~~ + +ABI versions are set at the time of major release labeling, and the ABI may +change multiple times, without warning, between the last release label and the +HEAD label of the git tree. + +ABI versions, once released, are available until such time as their +deprecation has been noted in the Release Notes for at least one major release +cycle. For example consider the case where the ABI for DPDK 2.0 has been +shipped and then a decision is made to modify it during the development of +DPDK 2.1. The decision will be recorded in the Release Notes for the DPDK 2.1 +release and the modification will be made available in the DPDK 2.2 release. + +ABI versions may be deprecated in whole or in part as needed by a given +update. + +Some ABI changes may be too significant to reasonably maintain multiple +versions. In those cases ABI's may be updated without backward compatibility +being provided. The requirements for doing so are: + +#. At least 3 acknowledgments of the need to do so must be made on the + dpdk.org mailing list. + + - The acknowledgment of the maintainer of the component is mandatory, or if + no maintainer is available for the component, the tree/sub-tree maintainer + for that component must acknowledge the ABI change instead. + + - It is also recommended that acknowledgments from different "areas of + interest" be sought for each deprecation, for example: from NIC vendors, + CPU vendors, end-users, etc. + +#. The changes (including an alternative map file) can be included with + deprecation notice, in wrapped way by the ``RTE_NEXT_ABI`` option, + to provide more details about oncoming changes. + ``RTE_NEXT_ABI`` wrapper will be removed when it become the default ABI. + More preferred way to provide this information is sending the feature + as a separate patch and reference it in deprecation notice. + +#. A full deprecation cycle, as explained above, must be made to offer + downstream consumers sufficient warning of the change. + +Note that the above process for ABI deprecation should not be undertaken +lightly. ABI stability is extremely important for downstream consumers of the +DPDK, especially when distributed in shared object form. Every effort should +be made to preserve the ABI whenever possible. The ABI should only be changed +for significant reasons, such as performance enhancements. ABI breakage due to +changes such as reorganizing public structure fields for aesthetic or +readability purposes should be avoided. + +.. note:: + + Updates to the minimum hardware requirements, which drop support for hardware + which was previously supported, should be treated as an ABI change, and + follow the relevant deprecation policy procedures as above: 3 acks and + announcement at least one release in advance. + +Examples of Deprecation Notices +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The following are some examples of ABI deprecation notices which would be +added to the Release Notes: + +* The Macro ``#RTE_FOO`` is deprecated and will be removed with version 2.0, + to be replaced with the inline function ``rte_foo()``. + +* The function ``rte_mbuf_grok()`` has been updated to include a new parameter + in version 2.0. Backwards compatibility will be maintained for this function + until the release of version 2.1 + +* The members of ``struct rte_foo`` have been reorganized in release 2.0 for + performance reasons. Existing binary applications will have backwards + compatibility in release 2.0, while newly built binaries will need to + reference the new structure variant ``struct rte_foo2``. Compatibility will + be removed in release 2.2, and all applications will require updating and + rebuilding to the new structure at that time, which will be renamed to the + original ``struct rte_foo``. + +* Significant ABI changes are planned for the ``librte_dostuff`` library. The + upcoming release 2.0 will not contain these changes, but release 2.1 will, + and no backwards compatibility is planned due to the extensive nature of + these changes. Binaries using this library built prior to version 2.1 will + require updating and recompilation. + +New API replacing previous one +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +If a new API proposed functionally replaces an existing one, when the new API +becomes non-experimental then the old one is marked with ``__rte_deprecated``. +Deprecated APIs are removed completely just after the next LTS. + +Reminder that old API should follow deprecation process to be removed. + + +Experimental APIs +----------------- + +APIs marked as ``experimental`` are not considered part of the ABI and may +change without warning at any time. Since changes to APIs are most likely +immediately after their introduction, as users begin to take advantage of +those new APIs and start finding issues with them, new DPDK APIs will be +automatically marked as ``experimental`` to allow for a period of stabilization +before they become part of a tracked ABI. + +Note that marking an API as experimental is a multi step process. +To mark an API as experimental, the symbols which are desired to be exported +must be placed in an EXPERIMENTAL version block in the corresponding libraries' +version map script. +Secondly, the corresponding prototypes of those exported functions (in the +development header files), must be marked with the ``__rte_experimental`` tag +(see ``rte_compat.h``). +The DPDK build makefiles perform a check to ensure that the map file and the +C code reflect the same list of symbols. +This check can be circumvented by defining ``ALLOW_EXPERIMENTAL_API`` +during compilation in the corresponding library Makefile. + +In addition to tagging the code with ``__rte_experimental``, +the doxygen markup must also contain the EXPERIMENTAL string, +and the MAINTAINERS file should note the EXPERIMENTAL libraries. + +For removing the experimental tag associated with an API, deprecation notice +is not required. Though, an API should remain in experimental state for at least +one release. Thereafter, normal process of posting patch for review to mailing +list can be followed. diff --git a/doc/guides/contributing/abi_versioning.rst b/doc/guides/contributing/abi_versioning.rst new file mode 100644 index 0000000..1c5612c --- /dev/null +++ b/doc/guides/contributing/abi_versioning.rst @@ -0,0 +1,427 @@ +.. SPDX-License-Identifier: BSD-3-Clause + Copyright 2018 The DPDK contributors + +.. library_versioning: + +Library versioning +------------------ + +Downstreams might want to provide different DPDK releases at the same time to +support multiple consumers of DPDK linked against older and newer sonames. + +Also due to the interdependencies that DPDK libraries can have applications +might end up with an executable space in which multiple versions of a library +are mapped by ld.so. + +Think of LibA that got an ABI bump and LibB that did not get an ABI bump but is +depending on LibA. + +.. note:: + + Application + \-> LibA.old + \-> LibB.new -> LibA.new + +That is a conflict which can be avoided by setting ``CONFIG_RTE_MAJOR_ABI``. +If set, the value of ``CONFIG_RTE_MAJOR_ABI`` overwrites all - otherwise per +library - versions defined in the libraries ``LIBABIVER``. +An example might be ``CONFIG_RTE_MAJOR_ABI=16.11`` which will make all libraries +``librte<?>.so.16.11`` instead of ``librte<?>.so.<LIBABIVER>``. + + +ABI versioning +-------------- + +Versioning Macros +~~~~~~~~~~~~~~~~~ + +When a symbol is exported from a library to provide an API, it also provides a +calling convention (ABI) that is embodied in its name, return type and +arguments. Occasionally that function may need to change to accommodate new +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 ``rte_function_versioning.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 +library so that older binaries need not be immediately recompiled. + +The macros exported are: + +* ``VERSION_SYMBOL(b, e, n)``: Creates a symbol version table entry binding + versioned symbol ``b@DPDK_n`` to the internal function ``b_e``. + +* ``BIND_DEFAULT_SYMBOL(b, e, n)``: Creates a symbol version entry instructing + the linker to bind references to symbol ``b`` to the internal symbol + ``b_e``. + +* ``MAP_STATIC_SYMBOL(f, p)``: Declare the prototype ``f``, and map it to the + fully qualified function ``p``, so that if a symbol becomes versioned, it + can still be mapped back to the public symbol name. + +Examples of ABI Macro use +^^^^^^^^^^^^^^^^^^^^^^^^^ + +Updating a public API +_____________________ + +Assume we have a function as follows + +.. code-block:: c + + /* + * Create an acl context object for apps to + * manipulate + */ + struct rte_acl_ctx * + rte_acl_create(const struct rte_acl_param *param) + { + ... + } + + +Assume that struct rte_acl_ctx is a private structure, and that a developer +wishes to enhance the acl api so that a debugging flag can be enabled on a +per-context basis. This requires an addition to the structure (which, being +private, is safe), but it also requires modifying the code as follows + +.. code-block:: c + + /* + * Create an acl context object for apps to + * manipulate + */ + struct rte_acl_ctx * + rte_acl_create(const struct rte_acl_param *param, int debug) + { + ... + } + + +Note also that, being a public function, the header file prototype must also be +changed, as must all the call sites, to reflect the new ABI footprint. We will +maintain previous ABI versions that are accessible only to previously compiled +binaries + +The addition of a parameter to the function is ABI breaking as the function is +public, and existing application may use it in its current form. However, the +compatibility macros in DPDK allow a developer to use symbol versioning so that +multiple functions can be mapped to the same public symbol based on when an +application was linked to it. To see how this is done, we start with the +requisite libraries version map file. Initially the version map file for the +acl library looks like this + +.. code-block:: none + + DPDK_2.0 { + global: + + rte_acl_add_rules; + rte_acl_build; + rte_acl_classify; + rte_acl_classify_alg; + rte_acl_classify_scalar; + rte_acl_create; + rte_acl_dump; + rte_acl_find_existing; + rte_acl_free; + rte_acl_ipv4vlan_add_rules; + rte_acl_ipv4vlan_build; + rte_acl_list_dump; + rte_acl_reset; + rte_acl_reset_rules; + rte_acl_set_ctx_classify; + + local: *; + }; + +This file needs to be modified as follows + +.. code-block:: none + + DPDK_2.0 { + global: + + rte_acl_add_rules; + rte_acl_build; + rte_acl_classify; + rte_acl_classify_alg; + rte_acl_classify_scalar; + rte_acl_create; + rte_acl_dump; + rte_acl_find_existing; + rte_acl_free; + rte_acl_ipv4vlan_add_rules; + rte_acl_ipv4vlan_build; + rte_acl_list_dump; + rte_acl_reset; + rte_acl_reset_rules; + rte_acl_set_ctx_classify; + + local: *; + }; + + DPDK_2.1 { + global: + rte_acl_create; + + } DPDK_2.0; + +The addition of the new block tells the linker that a new version node is +available (DPDK_2.1), which contains the symbol rte_acl_create, and inherits the +symbols from the DPDK_2.0 node. This list is directly translated into a list of +exported symbols when DPDK is compiled as a shared library + +Next, we need to specify in the code which function map to the rte_acl_create +symbol at which versions. First, at the site of the initial symbol definition, +we need to update the function so that it is uniquely named, and not in conflict +with the public symbol name + +.. code-block:: c + + struct rte_acl_ctx * + -rte_acl_create(const struct rte_acl_param *param) + +rte_acl_create_v20(const struct rte_acl_param *param) + { + size_t sz; + struct rte_acl_ctx *ctx; + ... + +Note that the base name of the symbol was kept intact, as this is conducive to +the macros used for versioning symbols. That is our next step, mapping this new +symbol name to the initial symbol name at version node 2.0. Immediately after +the function, we add this line of code + +.. code-block:: c + + VERSION_SYMBOL(rte_acl_create, _v20, 2.0); + +Remembering to also add the rte_function_versioning.h header to the requisite c file where +these changes are being made. The above macro instructs the linker to create a +new symbol ``rte_acl_create@DPDK_2.0``, which matches the symbol created in older +builds, but now points to the above newly named function. We have now mapped +the original rte_acl_create symbol to the original function (but with a new +name) + +Next, we need to create the 2.1 version of the symbol. We create a new function +name, with a different suffix, and implement it appropriately + +.. code-block:: c + + struct rte_acl_ctx * + rte_acl_create_v21(const struct rte_acl_param *param, int debug); + { + struct rte_acl_ctx *ctx = rte_acl_create_v20(param); + + ctx->debug = debug; + + return ctx; + } + +This code serves as our new API call. Its the same as our old call, but adds +the new parameter in place. Next we need to map this function to the symbol +``rte_acl_create@DPDK_2.1``. To do this, we modify the public prototype of the call +in the header file, adding the macro there to inform all including applications, +that on re-link, the default rte_acl_create symbol should point to this +function. Note that we could do this by simply naming the function above +rte_acl_create, and the linker would chose the most recent version tag to apply +in the version script, but we can also do this in the header file + +.. code-block:: c + + struct rte_acl_ctx * + -rte_acl_create(const struct rte_acl_param *param); + +rte_acl_create(const struct rte_acl_param *param, int debug); + +BIND_DEFAULT_SYMBOL(rte_acl_create, _v21, 2.1); + +The BIND_DEFAULT_SYMBOL macro explicitly tells applications that include this +header, to link to the rte_acl_create_v21 function and apply the DPDK_2.1 +version node to it. This method is more explicit and flexible than just +re-implementing the exact symbol name, and allows for other features (such as +linking to the old symbol version by default, when the new ABI is to be opt-in +for a period. + +One last thing we need to do. Note that we've taken what was a public symbol, +and duplicated it into two uniquely and differently named symbols. We've then +mapped each of those back to the public symbol ``rte_acl_create`` with different +version tags. This only applies to dynamic linking, as static linking has no +notion of versioning. That leaves this code in a position of no longer having a +symbol simply named ``rte_acl_create`` and a static build will fail on that +missing symbol. + +To correct this, we can simply map a function of our choosing back to the public +symbol in the static build with the ``MAP_STATIC_SYMBOL`` macro. Generally the +assumption is that the most recent version of the symbol is the one you want to +map. So, back in the C file where, immediately after ``rte_acl_create_v21`` is +defined, we add this + +.. code-block:: c + + struct rte_acl_ctx * + rte_acl_create_v21(const struct rte_acl_param *param, int debug) + { + ... + } + MAP_STATIC_SYMBOL(struct rte_acl_ctx *rte_acl_create(const struct rte_acl_param *param, int debug), rte_acl_create_v21); + +That tells the compiler that, when building a static library, any calls to the +symbol ``rte_acl_create`` should be linked to ``rte_acl_create_v21`` + +That's it, on the next shared library rebuild, there will be two versions of +rte_acl_create, an old DPDK_2.0 version, used by previously built applications, +and a new DPDK_2.1 version, used by future built applications. + + +Deprecating part of a public API +________________________________ + +Lets assume that you've done the above update, and after a few releases have +passed you decide you would like to retire the old version of the function. +After having gone through the ABI deprecation announcement process, removal is +easy. Start by removing the symbol from the requisite version map file: + +.. code-block:: none + + DPDK_2.0 { + global: + + rte_acl_add_rules; + rte_acl_build; + rte_acl_classify; + rte_acl_classify_alg; + rte_acl_classify_scalar; + rte_acl_dump; + - rte_acl_create + rte_acl_find_existing; + rte_acl_free; + rte_acl_ipv4vlan_add_rules; + rte_acl_ipv4vlan_build; + rte_acl_list_dump; + rte_acl_reset; + rte_acl_reset_rules; + rte_acl_set_ctx_classify; + + local: *; + }; + + DPDK_2.1 { + global: + rte_acl_create; + } DPDK_2.0; + + +Next remove the corresponding versioned export. + +.. code-block:: c + + -VERSION_SYMBOL(rte_acl_create, _v20, 2.0); + + +Note that the internal function definition could also be removed, but its used +in our example by the newer version _v21, so we leave it in place. This is a +coding style choice. + +Lastly, we need to bump the LIBABIVER number for this library in the Makefile to +indicate to applications doing dynamic linking that this is a later, and +possibly incompatible library version: + +.. code-block:: c + + -LIBABIVER := 1 + +LIBABIVER := 2 + +Deprecating an entire ABI version +_________________________________ + +While removing a symbol from and ABI may be useful, it is often more practical +to remove an entire version node at once. If a version node completely +specifies an API, then removing part of it, typically makes it incomplete. In +those cases it is better to remove the entire node + +To do this, start by modifying the version map file, such that all symbols from +the node to be removed are merged into the next node in the map + +In the case of our map above, it would transform to look as follows + +.. code-block:: none + + DPDK_2.1 { + global: + + rte_acl_add_rules; + rte_acl_build; + rte_acl_classify; + rte_acl_classify_alg; + rte_acl_classify_scalar; + rte_acl_dump; + rte_acl_create + rte_acl_find_existing; + rte_acl_free; + rte_acl_ipv4vlan_add_rules; + rte_acl_ipv4vlan_build; + rte_acl_list_dump; + rte_acl_reset; + rte_acl_reset_rules; + rte_acl_set_ctx_classify; + + local: *; + }; + +Then any uses of BIND_DEFAULT_SYMBOL that pointed to the old node should be +updated to point to the new version node in any header files for all affected +symbols. + +.. code-block:: c + + -BIND_DEFAULT_SYMBOL(rte_acl_create, _v20, 2.0); + +BIND_DEFAULT_SYMBOL(rte_acl_create, _v21, 2.1); + +Lastly, any VERSION_SYMBOL macros that point to the old version node should be +removed, taking care to keep, where need old code in place to support newer +versions of the symbol. + + +Running the ABI Validator +------------------------- + +The ``devtools`` directory in the DPDK source tree contains a utility program, +``validate-abi.sh``, for validating the DPDK ABI based on the Linux `ABI +Compliance Checker +<http://ispras.linuxbase.org/index.php/ABI_compliance_checker>`_. + +This has a dependency on the ``abi-compliance-checker`` and ``and abi-dumper`` +utilities which can be installed via a package manager. For example:: + + sudo yum install abi-compliance-checker + sudo yum install abi-dumper + +The syntax of the ``validate-abi.sh`` utility is:: + + ./devtools/validate-abi.sh <REV1> <REV2> + +Where ``REV1`` and ``REV2`` are valid gitrevisions(7) +https://www.kernel.org/pub/software/scm/git/docs/gitrevisions.html +on the local repo. + +For example:: + + # Check between the previous and latest commit: + ./devtools/validate-abi.sh HEAD~1 HEAD + + # Check on a specific compilation target: + ./devtools/validate-abi.sh -t x86_64-native-linux-gcc HEAD~1 HEAD + + # Check between two tags: + ./devtools/validate-abi.sh v2.0.0 v2.1.0 + + # Check between git master and local topic-branch "vhost-hacking": + ./devtools/validate-abi.sh master vhost-hacking + +After the validation script completes (it can take a while since it need to +compile both tags) it will create compatibility reports in the +``./abi-check/compat_report`` directory. Listed incompatibilities can be found +as follows:: + + grep -lr Incompatible abi-check/compat_reports/ diff --git a/doc/guides/contributing/index.rst b/doc/guides/contributing/index.rst index e2608d3..2fefd91 100644 --- a/doc/guides/contributing/index.rst +++ b/doc/guides/contributing/index.rst @@ -10,7 +10,8 @@ Contributor's Guidelines coding_style design - versioning + abi_policy + abi_versioning documentation patches vulnerability diff --git a/doc/guides/contributing/patches.rst b/doc/guides/contributing/patches.rst index 9e1013b..c9ec529 100644 --- a/doc/guides/contributing/patches.rst +++ b/doc/guides/contributing/patches.rst @@ -157,7 +157,7 @@ Make your planned changes in the cloned ``dpdk`` repo. Here are some guidelines * For other PMDs and more info, refer to the ``MAINTAINERS`` file. * New external functions should be added to the local ``version.map`` file. - See the :doc:`Guidelines for ABI policy and versioning </contributing/versioning>`. + See the :doc:`Guidelines for ABI policy and versioning </contributing/abi_versioning>`. New external functions should also be added in alphabetical order. * Important changes will require an addition to the release notes in ``doc/guides/rel_notes/``. diff --git a/doc/guides/contributing/versioning.rst b/doc/guides/contributing/versioning.rst deleted file mode 100644 index 64984c5..0000000 --- a/doc/guides/contributing/versioning.rst +++ /dev/null @@ -1,591 +0,0 @@ -.. SPDX-License-Identifier: BSD-3-Clause - Copyright 2018 The DPDK contributors - -DPDK ABI/API policy -=================== - -Description ------------ - -This document details some methods for handling ABI management in the DPDK. - -General Guidelines ------------------- - -#. Whenever possible, ABI should be preserved -#. ABI/API may be changed with a deprecation process -#. The modification of symbols can generally be managed with versioning -#. Libraries or APIs marked in ``experimental`` state may change without constraint -#. New APIs will be marked as ``experimental`` for at least one release to allow - any issues found by users of the new API to be fixed quickly -#. The addition of symbols is generally not problematic -#. The removal of symbols generally is an ABI break and requires bumping of the - LIBABIVER macro -#. Updates to the minimum hardware requirements, which drop support for hardware which - was previously supported, should be treated as an ABI change. - -What is an ABI -~~~~~~~~~~~~~~ - -An ABI (Application Binary Interface) is the set of runtime interfaces exposed -by a library. It is similar to an API (Application Programming Interface) but -is the result of compilation. It is also effectively cloned when applications -link to dynamic libraries. That is to say when an application is compiled to -link against dynamic libraries, it is assumed that the ABI remains constant -between the time the application is compiled/linked, and the time that it runs. -Therefore, in the case of dynamic linking, it is critical that an ABI is -preserved, or (when modified), done in such a way that the application is unable -to behave improperly or in an unexpected fashion. - - -ABI/API Deprecation -------------------- - -The DPDK ABI policy -~~~~~~~~~~~~~~~~~~~ - -ABI versions are set at the time of major release labeling, and the ABI may -change multiple times, without warning, between the last release label and the -HEAD label of the git tree. - -ABI versions, once released, are available until such time as their -deprecation has been noted in the Release Notes for at least one major release -cycle. For example consider the case where the ABI for DPDK 2.0 has been -shipped and then a decision is made to modify it during the development of -DPDK 2.1. The decision will be recorded in the Release Notes for the DPDK 2.1 -release and the modification will be made available in the DPDK 2.2 release. - -ABI versions may be deprecated in whole or in part as needed by a given -update. - -Some ABI changes may be too significant to reasonably maintain multiple -versions. In those cases ABI's may be updated without backward compatibility -being provided. The requirements for doing so are: - -#. At least 3 acknowledgments of the need to do so must be made on the - dpdk.org mailing list. - - - The acknowledgment of the maintainer of the component is mandatory, or if - no maintainer is available for the component, the tree/sub-tree maintainer - for that component must acknowledge the ABI change instead. - - - It is also recommended that acknowledgments from different "areas of - interest" be sought for each deprecation, for example: from NIC vendors, - CPU vendors, end-users, etc. - -#. The changes (including an alternative map file) can be included with - deprecation notice, in wrapped way by the ``RTE_NEXT_ABI`` option, - to provide more details about oncoming changes. - ``RTE_NEXT_ABI`` wrapper will be removed when it become the default ABI. - More preferred way to provide this information is sending the feature - as a separate patch and reference it in deprecation notice. - -#. A full deprecation cycle, as explained above, must be made to offer - downstream consumers sufficient warning of the change. - -Note that the above process for ABI deprecation should not be undertaken -lightly. ABI stability is extremely important for downstream consumers of the -DPDK, especially when distributed in shared object form. Every effort should -be made to preserve the ABI whenever possible. The ABI should only be changed -for significant reasons, such as performance enhancements. ABI breakage due to -changes such as reorganizing public structure fields for aesthetic or -readability purposes should be avoided. - -.. note:: - - Updates to the minimum hardware requirements, which drop support for hardware - which was previously supported, should be treated as an ABI change, and - follow the relevant deprecation policy procedures as above: 3 acks and - announcement at least one release in advance. - -Examples of Deprecation Notices -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -The following are some examples of ABI deprecation notices which would be -added to the Release Notes: - -* The Macro ``#RTE_FOO`` is deprecated and will be removed with version 2.0, - to be replaced with the inline function ``rte_foo()``. - -* The function ``rte_mbuf_grok()`` has been updated to include a new parameter - in version 2.0. Backwards compatibility will be maintained for this function - until the release of version 2.1 - -* The members of ``struct rte_foo`` have been reorganized in release 2.0 for - performance reasons. Existing binary applications will have backwards - compatibility in release 2.0, while newly built binaries will need to - reference the new structure variant ``struct rte_foo2``. Compatibility will - be removed in release 2.2, and all applications will require updating and - rebuilding to the new structure at that time, which will be renamed to the - original ``struct rte_foo``. - -* Significant ABI changes are planned for the ``librte_dostuff`` library. The - upcoming release 2.0 will not contain these changes, but release 2.1 will, - and no backwards compatibility is planned due to the extensive nature of - these changes. Binaries using this library built prior to version 2.1 will - require updating and recompilation. - -New API replacing previous one -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -If a new API proposed functionally replaces an existing one, when the new API -becomes non-experimental then the old one is marked with ``__rte_deprecated``. -Deprecated APIs are removed completely just after the next LTS. - -Reminder that old API should follow deprecation process to be removed. - - -Experimental APIs ------------------ - -APIs marked as ``experimental`` are not considered part of the ABI and may -change without warning at any time. Since changes to APIs are most likely -immediately after their introduction, as users begin to take advantage of -those new APIs and start finding issues with them, new DPDK APIs will be -automatically marked as ``experimental`` to allow for a period of stabilization -before they become part of a tracked ABI. - -Note that marking an API as experimental is a multi step process. -To mark an API as experimental, the symbols which are desired to be exported -must be placed in an EXPERIMENTAL version block in the corresponding libraries' -version map script. -Secondly, the corresponding prototypes of those exported functions (in the -development header files), must be marked with the ``__rte_experimental`` tag -(see ``rte_compat.h``). -The DPDK build makefiles perform a check to ensure that the map file and the -C code reflect the same list of symbols. -This check can be circumvented by defining ``ALLOW_EXPERIMENTAL_API`` -during compilation in the corresponding library Makefile. - -In addition to tagging the code with ``__rte_experimental``, -the doxygen markup must also contain the EXPERIMENTAL string, -and the MAINTAINERS file should note the EXPERIMENTAL libraries. - -For removing the experimental tag associated with an API, deprecation notice -is not required. Though, an API should remain in experimental state for at least -one release. Thereafter, normal process of posting patch for review to mailing -list can be followed. - - -Library versioning ------------------- - -Downstreams might want to provide different DPDK releases at the same time to -support multiple consumers of DPDK linked against older and newer sonames. - -Also due to the interdependencies that DPDK libraries can have applications -might end up with an executable space in which multiple versions of a library -are mapped by ld.so. - -Think of LibA that got an ABI bump and LibB that did not get an ABI bump but is -depending on LibA. - -.. note:: - - Application - \-> LibA.old - \-> LibB.new -> LibA.new - -That is a conflict which can be avoided by setting ``CONFIG_RTE_MAJOR_ABI``. -If set, the value of ``CONFIG_RTE_MAJOR_ABI`` overwrites all - otherwise per -library - versions defined in the libraries ``LIBABIVER``. -An example might be ``CONFIG_RTE_MAJOR_ABI=16.11`` which will make all libraries -``librte<?>.so.16.11`` instead of ``librte<?>.so.<LIBABIVER>``. - - -ABI versioning --------------- - -Versioning Macros -~~~~~~~~~~~~~~~~~ - -When a symbol is exported from a library to provide an API, it also provides a -calling convention (ABI) that is embodied in its name, return type and -arguments. Occasionally that function may need to change to accommodate new -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 ``rte_function_versioning.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 -library so that older binaries need not be immediately recompiled. - -The macros exported are: - -* ``VERSION_SYMBOL(b, e, n)``: Creates a symbol version table entry binding - versioned symbol ``b@DPDK_n`` to the internal function ``b_e``. - -* ``BIND_DEFAULT_SYMBOL(b, e, n)``: Creates a symbol version entry instructing - the linker to bind references to symbol ``b`` to the internal symbol - ``b_e``. - -* ``MAP_STATIC_SYMBOL(f, p)``: Declare the prototype ``f``, and map it to the - fully qualified function ``p``, so that if a symbol becomes versioned, it - can still be mapped back to the public symbol name. - -Examples of ABI Macro use -^^^^^^^^^^^^^^^^^^^^^^^^^ - -Updating a public API -_____________________ - -Assume we have a function as follows - -.. code-block:: c - - /* - * Create an acl context object for apps to - * manipulate - */ - struct rte_acl_ctx * - rte_acl_create(const struct rte_acl_param *param) - { - ... - } - - -Assume that struct rte_acl_ctx is a private structure, and that a developer -wishes to enhance the acl api so that a debugging flag can be enabled on a -per-context basis. This requires an addition to the structure (which, being -private, is safe), but it also requires modifying the code as follows - -.. code-block:: c - - /* - * Create an acl context object for apps to - * manipulate - */ - struct rte_acl_ctx * - rte_acl_create(const struct rte_acl_param *param, int debug) - { - ... - } - - -Note also that, being a public function, the header file prototype must also be -changed, as must all the call sites, to reflect the new ABI footprint. We will -maintain previous ABI versions that are accessible only to previously compiled -binaries - -The addition of a parameter to the function is ABI breaking as the function is -public, and existing application may use it in its current form. However, the -compatibility macros in DPDK allow a developer to use symbol versioning so that -multiple functions can be mapped to the same public symbol based on when an -application was linked to it. To see how this is done, we start with the -requisite libraries version map file. Initially the version map file for the -acl library looks like this - -.. code-block:: none - - DPDK_2.0 { - global: - - rte_acl_add_rules; - rte_acl_build; - rte_acl_classify; - rte_acl_classify_alg; - rte_acl_classify_scalar; - rte_acl_create; - rte_acl_dump; - rte_acl_find_existing; - rte_acl_free; - rte_acl_ipv4vlan_add_rules; - rte_acl_ipv4vlan_build; - rte_acl_list_dump; - rte_acl_reset; - rte_acl_reset_rules; - rte_acl_set_ctx_classify; - - local: *; - }; - -This file needs to be modified as follows - -.. code-block:: none - - DPDK_2.0 { - global: - - rte_acl_add_rules; - rte_acl_build; - rte_acl_classify; - rte_acl_classify_alg; - rte_acl_classify_scalar; - rte_acl_create; - rte_acl_dump; - rte_acl_find_existing; - rte_acl_free; - rte_acl_ipv4vlan_add_rules; - rte_acl_ipv4vlan_build; - rte_acl_list_dump; - rte_acl_reset; - rte_acl_reset_rules; - rte_acl_set_ctx_classify; - - local: *; - }; - - DPDK_2.1 { - global: - rte_acl_create; - - } DPDK_2.0; - -The addition of the new block tells the linker that a new version node is -available (DPDK_2.1), which contains the symbol rte_acl_create, and inherits the -symbols from the DPDK_2.0 node. This list is directly translated into a list of -exported symbols when DPDK is compiled as a shared library - -Next, we need to specify in the code which function map to the rte_acl_create -symbol at which versions. First, at the site of the initial symbol definition, -we need to update the function so that it is uniquely named, and not in conflict -with the public symbol name - -.. code-block:: c - - struct rte_acl_ctx * - -rte_acl_create(const struct rte_acl_param *param) - +rte_acl_create_v20(const struct rte_acl_param *param) - { - size_t sz; - struct rte_acl_ctx *ctx; - ... - -Note that the base name of the symbol was kept intact, as this is conducive to -the macros used for versioning symbols. That is our next step, mapping this new -symbol name to the initial symbol name at version node 2.0. Immediately after -the function, we add this line of code - -.. code-block:: c - - VERSION_SYMBOL(rte_acl_create, _v20, 2.0); - -Remembering to also add the rte_function_versioning.h header to the requisite c file where -these changes are being made. The above macro instructs the linker to create a -new symbol ``rte_acl_create@DPDK_2.0``, which matches the symbol created in older -builds, but now points to the above newly named function. We have now mapped -the original rte_acl_create symbol to the original function (but with a new -name) - -Next, we need to create the 2.1 version of the symbol. We create a new function -name, with a different suffix, and implement it appropriately - -.. code-block:: c - - struct rte_acl_ctx * - rte_acl_create_v21(const struct rte_acl_param *param, int debug); - { - struct rte_acl_ctx *ctx = rte_acl_create_v20(param); - - ctx->debug = debug; - - return ctx; - } - -This code serves as our new API call. Its the same as our old call, but adds -the new parameter in place. Next we need to map this function to the symbol -``rte_acl_create@DPDK_2.1``. To do this, we modify the public prototype of the call -in the header file, adding the macro there to inform all including applications, -that on re-link, the default rte_acl_create symbol should point to this -function. Note that we could do this by simply naming the function above -rte_acl_create, and the linker would chose the most recent version tag to apply -in the version script, but we can also do this in the header file - -.. code-block:: c - - struct rte_acl_ctx * - -rte_acl_create(const struct rte_acl_param *param); - +rte_acl_create(const struct rte_acl_param *param, int debug); - +BIND_DEFAULT_SYMBOL(rte_acl_create, _v21, 2.1); - -The BIND_DEFAULT_SYMBOL macro explicitly tells applications that include this -header, to link to the rte_acl_create_v21 function and apply the DPDK_2.1 -version node to it. This method is more explicit and flexible than just -re-implementing the exact symbol name, and allows for other features (such as -linking to the old symbol version by default, when the new ABI is to be opt-in -for a period. - -One last thing we need to do. Note that we've taken what was a public symbol, -and duplicated it into two uniquely and differently named symbols. We've then -mapped each of those back to the public symbol ``rte_acl_create`` with different -version tags. This only applies to dynamic linking, as static linking has no -notion of versioning. That leaves this code in a position of no longer having a -symbol simply named ``rte_acl_create`` and a static build will fail on that -missing symbol. - -To correct this, we can simply map a function of our choosing back to the public -symbol in the static build with the ``MAP_STATIC_SYMBOL`` macro. Generally the -assumption is that the most recent version of the symbol is the one you want to -map. So, back in the C file where, immediately after ``rte_acl_create_v21`` is -defined, we add this - -.. code-block:: c - - struct rte_acl_ctx * - rte_acl_create_v21(const struct rte_acl_param *param, int debug) - { - ... - } - MAP_STATIC_SYMBOL(struct rte_acl_ctx *rte_acl_create(const struct rte_acl_param *param, int debug), rte_acl_create_v21); - -That tells the compiler that, when building a static library, any calls to the -symbol ``rte_acl_create`` should be linked to ``rte_acl_create_v21`` - -That's it, on the next shared library rebuild, there will be two versions of -rte_acl_create, an old DPDK_2.0 version, used by previously built applications, -and a new DPDK_2.1 version, used by future built applications. - - -Deprecating part of a public API -________________________________ - -Lets assume that you've done the above update, and after a few releases have -passed you decide you would like to retire the old version of the function. -After having gone through the ABI deprecation announcement process, removal is -easy. Start by removing the symbol from the requisite version map file: - -.. code-block:: none - - DPDK_2.0 { - global: - - rte_acl_add_rules; - rte_acl_build; - rte_acl_classify; - rte_acl_classify_alg; - rte_acl_classify_scalar; - rte_acl_dump; - - rte_acl_create - rte_acl_find_existing; - rte_acl_free; - rte_acl_ipv4vlan_add_rules; - rte_acl_ipv4vlan_build; - rte_acl_list_dump; - rte_acl_reset; - rte_acl_reset_rules; - rte_acl_set_ctx_classify; - - local: *; - }; - - DPDK_2.1 { - global: - rte_acl_create; - } DPDK_2.0; - - -Next remove the corresponding versioned export. - -.. code-block:: c - - -VERSION_SYMBOL(rte_acl_create, _v20, 2.0); - - -Note that the internal function definition could also be removed, but its used -in our example by the newer version _v21, so we leave it in place. This is a -coding style choice. - -Lastly, we need to bump the LIBABIVER number for this library in the Makefile to -indicate to applications doing dynamic linking that this is a later, and -possibly incompatible library version: - -.. code-block:: c - - -LIBABIVER := 1 - +LIBABIVER := 2 - -Deprecating an entire ABI version -_________________________________ - -While removing a symbol from and ABI may be useful, it is often more practical -to remove an entire version node at once. If a version node completely -specifies an API, then removing part of it, typically makes it incomplete. In -those cases it is better to remove the entire node - -To do this, start by modifying the version map file, such that all symbols from -the node to be removed are merged into the next node in the map - -In the case of our map above, it would transform to look as follows - -.. code-block:: none - - DPDK_2.1 { - global: - - rte_acl_add_rules; - rte_acl_build; - rte_acl_classify; - rte_acl_classify_alg; - rte_acl_classify_scalar; - rte_acl_dump; - rte_acl_create - rte_acl_find_existing; - rte_acl_free; - rte_acl_ipv4vlan_add_rules; - rte_acl_ipv4vlan_build; - rte_acl_list_dump; - rte_acl_reset; - rte_acl_reset_rules; - rte_acl_set_ctx_classify; - - local: *; - }; - -Then any uses of BIND_DEFAULT_SYMBOL that pointed to the old node should be -updated to point to the new version node in any header files for all affected -symbols. - -.. code-block:: c - - -BIND_DEFAULT_SYMBOL(rte_acl_create, _v20, 2.0); - +BIND_DEFAULT_SYMBOL(rte_acl_create, _v21, 2.1); - -Lastly, any VERSION_SYMBOL macros that point to the old version node should be -removed, taking care to keep, where need old code in place to support newer -versions of the symbol. - - -Running the ABI Validator -------------------------- - -The ``devtools`` directory in the DPDK source tree contains a utility program, -``validate-abi.sh``, for validating the DPDK ABI based on the Linux `ABI -Compliance Checker -<http://ispras.linuxbase.org/index.php/ABI_compliance_checker>`_. - -This has a dependency on the ``abi-compliance-checker`` and ``and abi-dumper`` -utilities which can be installed via a package manager. For example:: - - sudo yum install abi-compliance-checker - sudo yum install abi-dumper - -The syntax of the ``validate-abi.sh`` utility is:: - - ./devtools/validate-abi.sh <REV1> <REV2> - -Where ``REV1`` and ``REV2`` are valid gitrevisions(7) -https://www.kernel.org/pub/software/scm/git/docs/gitrevisions.html -on the local repo. - -For example:: - - # Check between the previous and latest commit: - ./devtools/validate-abi.sh HEAD~1 HEAD - - # Check on a specific compilation target: - ./devtools/validate-abi.sh -t x86_64-native-linux-gcc HEAD~1 HEAD - - # Check between two tags: - ./devtools/validate-abi.sh v2.0.0 v2.1.0 - - # Check between git master and local topic-branch "vhost-hacking": - ./devtools/validate-abi.sh master vhost-hacking - -After the validation script completes (it can take a while since it need to -compile both tags) it will create compatibility reports in the -``./abi-check/compat_report`` directory. Listed incompatibilities can be found -as follows:: - - grep -lr Incompatible abi-check/compat_reports/ diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst index 4249aab..cf37d80 100644 --- a/doc/guides/rel_notes/deprecation.rst +++ b/doc/guides/rel_notes/deprecation.rst @@ -4,7 +4,7 @@ ABI and API Deprecation ======================= -See the :doc:`guidelines document for details of the ABI policy </contributing/versioning>`. +See the :doc:`guidelines document for details of the ABI policy </contributing/abi_versioning>`. API and ABI deprecation notices are to be posted here. -- 2.7.4 ^ permalink raw reply [flat|nested] 20+ messages in thread
* [dpdk-dev] [PATCH v9 2/4] doc: changes to abi policy introducing major abi versions 2019-11-08 12:46 [dpdk-dev] [PATCH v9 0/4] doc: changes to abi policy introducing major abi versions Ray Kinsella 2019-11-08 12:46 ` [dpdk-dev] [PATCH v9 1/4] doc: separate versioning.rst into version and policy Ray Kinsella @ 2019-11-08 12:46 ` Ray Kinsella 2019-11-08 17:11 ` Thomas Monjalon 2019-11-08 12:46 ` [dpdk-dev] [PATCH v9 3/4] doc: updates to versioning guide for " Ray Kinsella ` (3 subsequent siblings) 5 siblings, 1 reply; 20+ messages in thread From: Ray Kinsella @ 2019-11-08 12:46 UTC (permalink / raw) To: dev Cc: mdr, thomas, stephen, bruce.richardson, ferruh.yigit, konstantin.ananyev, jerinj, olivier.matz, nhorman, maxime.coquelin, john.mcnamara, marko.kovacevic, hemant.agrawal, ktraynor, aconole This policy change introduces major ABI versions, these are declared every year, typically aligned with the LTS release and are supported by subsequent releases in the following year. This change is intended to improve ABI stabilty for those projects consuming DPDK. Signed-off-by: Ray Kinsella <mdr@ashroe.eu> Acked-by: John Mcnamara <john.mcnamara@intel.com> Acked-by: Stephen Hemminger <stephen@networkplumber.org> --- doc/guides/contributing/abi_policy.rst | 324 ++++-- .../contributing/img/abi_stability_policy.svg | 1059 ++++++++++++++++++++ doc/guides/contributing/img/what_is_an_abi.svg | 382 +++++++ doc/guides/contributing/stable.rst | 12 +- 4 files changed, 1686 insertions(+), 91 deletions(-) create mode 100644 doc/guides/contributing/img/abi_stability_policy.svg create mode 100644 doc/guides/contributing/img/what_is_an_abi.svg diff --git a/doc/guides/contributing/abi_policy.rst b/doc/guides/contributing/abi_policy.rst index d4f4e9f..0965bcc 100644 --- a/doc/guides/contributing/abi_policy.rst +++ b/doc/guides/contributing/abi_policy.rst @@ -1,31 +1,47 @@ .. SPDX-License-Identifier: BSD-3-Clause - Copyright 2018 The DPDK contributors + Copyright 2019 The DPDK contributors -DPDK ABI/API policy -=================== +ABI Policy +========== Description ----------- -This document details some methods for handling ABI management in the DPDK. +This document details the management policy that ensures the long-term stability +of the DPDK ABI and API. General Guidelines ------------------ -#. Whenever possible, ABI should be preserved -#. ABI/API may be changed with a deprecation process -#. The modification of symbols can generally be managed with versioning -#. Libraries or APIs marked in ``experimental`` state may change without constraint -#. New APIs will be marked as ``experimental`` for at least one release to allow - any issues found by users of the new API to be fixed quickly -#. The addition of symbols is generally not problematic -#. The removal of symbols generally is an ABI break and requires bumping of the - LIBABIVER macro -#. Updates to the minimum hardware requirements, which drop support for hardware which - was previously supported, should be treated as an ABI change. - -What is an ABI -~~~~~~~~~~~~~~ +#. Major ABI versions are declared no more frequently than yearly. Compatibility + with the major ABI version is mandatory in subsequent releases until a new + major ABI version is declared. +#. Major ABI version are usually but not always declared aligned with a + :ref:`LTS release <stable_lts_releases>`. +#. The ABI version is managed at a project level in DPDK, with the ABI version + reflected in all library's soname. +#. The ABI should be preserved and not changed lightly. ABI changes must follow + the outlined :ref:`deprecation process <abi_changes>`. +#. The addition of symbols is generally not problematic. The modification of + symbols is managed with ABI Versioning. +#. The removal of symbols is considered an :ref:`ABI breakage <abi_breakages>`, + once approved these will form part of the next ABI version. +#. Libraries or APIs marked as :ref:`Experimental <experimental_apis>` are not + considered part of an ABI version and may change without constraint. +#. Updates to the :ref:`minimum hardware requirements <hw_rqmts>`, which drop + support for hardware which was previously supported, should be treated as an + ABI change. + +.. note:: + + In 2019, the DPDK community stated its intention to move to ABI stable + releases, over a number of release cycles. This change begins with + maintaining ABI stability through one year of DPDK releases starting from + DPDK 19.11. This policy will be reviewed in 2020, with intention of + lengthening the stability period. + +What is an ABI? +~~~~~~~~~~~~~~~ An ABI (Application Binary Interface) is the set of runtime interfaces exposed by a library. It is similar to an API (Application Programming Interface) but @@ -37,30 +53,82 @@ Therefore, in the case of dynamic linking, it is critical that an ABI is preserved, or (when modified), done in such a way that the application is unable to behave improperly or in an unexpected fashion. +.. _figure_what_is_an_abi: + +.. figure:: img/what_is_an_abi.* + + Illustration of DPDK API and ABI. -ABI/API Deprecation -------------------- + +What is an ABI version? +~~~~~~~~~~~~~~~~~~~~~~~ + +An ABI version is an instance of a library's ABI at a specific release. Certain +releases are considered to be milestone releases, the yearly LTS release for +example. The ABI of a milestone release may be declared as a 'major ABI +version', where this ABI version is then supported for some number of subsequent +releases and is annotated in the library's soname. + +ABI version support in subsequent releases facilitates application upgrades, by +enabling applications built against the milestone release to upgrade to +subsequent releases of a library without a rebuild. + +More details on major ABI version can be found in the ABI Versioning guide. The DPDK ABI policy -~~~~~~~~~~~~~~~~~~~ +------------------- + +A new major ABI version is declared no more frequently than yearly, with +declarations usually aligning with a LTS release, e.g. ABI 20 for DPDK 19.11. +Compatibility with the major ABI version is then mandatory in subsequent +releases until the next major ABI version is declared, e.g. ABI 21 for DPDK +20.11. -ABI versions are set at the time of major release labeling, and the ABI may -change multiple times, without warning, between the last release label and the -HEAD label of the git tree. +At the declaration of a major ABI version, major version numbers encoded in +libraries' sonames are bumped to indicate the new version, with the minor +version reset to ``0``. An example would be ``librte_eal.so.20.3`` would become +``librte_eal.so.21.0``. -ABI versions, once released, are available until such time as their -deprecation has been noted in the Release Notes for at least one major release -cycle. For example consider the case where the ABI for DPDK 2.0 has been -shipped and then a decision is made to modify it during the development of -DPDK 2.1. The decision will be recorded in the Release Notes for the DPDK 2.1 -release and the modification will be made available in the DPDK 2.2 release. +The ABI may then change multiple times, without warning, between the last major +ABI version increment and the HEAD label of the git tree, with the condition +that ABI compatibility with the major ABI version is preserved and therefore +sonames do not change. -ABI versions may be deprecated in whole or in part as needed by a given -update. +Minor versions are incremented to indicate the release of a new ABI compatible +DPDK release, typically the DPDK quarterly releases. An example of this, might +be that ``librte_eal.so.20.1`` would indicate the first ABI compatible DPDK +release, following the declaration of the new major ABI version ``20``. -Some ABI changes may be too significant to reasonably maintain multiple -versions. In those cases ABI's may be updated without backward compatibility -being provided. The requirements for doing so are: +An ABI version is supported in all new releases until the next major ABI version +is declared. When changing the major ABI version, the release notes will detail +all ABI changes. + +.. _figure_abi_stability_policy: + +.. figure:: img/abi_stability_policy.* + + Mapping of new ABI versions and ABI version compatibility to DPDK + releases. + +.. _abi_changes: + +ABI Changes +~~~~~~~~~~~ + +The ABI may still change after the declaration of a major ABI version, that is +new APIs may be still added or existing APIs may be modified. + +.. Warning:: + + Note that, this policy details the method by which the ABI may be changed, + with due regard to preserving compatibility and observing deprecation + notices. This process however should not be undertaken lightly, as a general + rule ABI stability is extremely important for downstream consumers of DPDK. + The API should only be changed for significant reasons, such as performance + enhancements. API breakages due to changes such as reorganizing public + structure fields for aesthetic or readability purposes should be avoided. + +The requirements for changing the ABI are: #. At least 3 acknowledgments of the need to do so must be made on the dpdk.org mailing list. @@ -69,34 +137,119 @@ being provided. The requirements for doing so are: no maintainer is available for the component, the tree/sub-tree maintainer for that component must acknowledge the ABI change instead. + - The acknowledgment of three members of the technical board, as delegates + of the `technical board <https://core.dpdk.org/techboard/>`_ acknowledging + the need for the ABI change, is also mandatory. + - It is also recommended that acknowledgments from different "areas of interest" be sought for each deprecation, for example: from NIC vendors, CPU vendors, end-users, etc. -#. The changes (including an alternative map file) can be included with - deprecation notice, in wrapped way by the ``RTE_NEXT_ABI`` option, - to provide more details about oncoming changes. - ``RTE_NEXT_ABI`` wrapper will be removed when it become the default ABI. - More preferred way to provide this information is sending the feature - as a separate patch and reference it in deprecation notice. +#. Backward compatibility with the major ABI version must be maintained through + ABI Versioning, with :ref:`forward-only <forward-only>` compatibility + offered for any ABI changes that are indicated to be part of the next ABI + version. -#. A full deprecation cycle, as explained above, must be made to offer - downstream consumers sufficient warning of the change. + - In situations where backward compatibility is not possible, read the + section on :ref:`abi_breakages`. -Note that the above process for ABI deprecation should not be undertaken -lightly. ABI stability is extremely important for downstream consumers of the -DPDK, especially when distributed in shared object form. Every effort should -be made to preserve the ABI whenever possible. The ABI should only be changed -for significant reasons, such as performance enhancements. ABI breakage due to -changes such as reorganizing public structure fields for aesthetic or -readability purposes should be avoided. + - No backward or forward compatibility is offered for API changes marked as + ``experimental``, as described in the section on :ref:`Experimental APIs + and Libraries <experimental_apis>`. -.. note:: +#. If a newly proposed API functionally replaces an existing one, when the new + API becomes non-experimental, then the old one is marked with + ``__rte_deprecated``. + + - The depreciated API should follow the notification process to be removed, + see :ref:`deprecation_notices`. + + - At the declaration of the next major ABI version, those ABI changes then + become a formal part of the new ABI and the requirement to preserve ABI + compatibility with the last major ABI version is then dropped. + + - The responsibility for removing redundant ABI compatibility code rests + with the original contributor of the ABI changes, failing that, then with + the contributor's company and then finally with the maintainer. + +.. _forward-only: + +.. Note:: + + Note that forward-only compatibility is offered for those changes made + between major ABI versions. As a library's soname can only describe + compatibility with the last major ABI version, until the next major ABI + version is declared, these changes therefore cannot be resolved as a runtime + dependency through the soname. Therefore any application wishing to make use + of these ABI changes can only ensure that its runtime dependencies are met + through Operating System package versioning. + +.. _hw_rqmts: + +.. Note:: Updates to the minimum hardware requirements, which drop support for hardware which was previously supported, should be treated as an ABI change, and - follow the relevant deprecation policy procedures as above: 3 acks and - announcement at least one release in advance. + follow the relevant deprecation policy procedures as above: 3 acks, technical + board approval and announcement at least one release in advance. + +.. _abi_breakages: + +ABI Breakages +~~~~~~~~~~~~~ + +For those ABI changes that are too significant to reasonably maintain multiple +symbol versions, there is an amended process. In these cases, ABIs may be +updated without the requirement of backward compatibility being provided. These +changes must follow the same process :ref:`described above <abi_changes>` as non-breaking +changes, however with the following additional requirements: + +#. ABI breaking changes (including an alternative map file) can be included with + deprecation notice, in wrapped way by the ``RTE_NEXT_ABI`` option, to provide + more details about oncoming changes. ``RTE_NEXT_ABI`` wrapper will be removed + at the declaration of the next major ABI version. + +#. Once approved, and after the deprecation notice has been observed these + changes will form part of the next declared major ABI version. + +Examples of ABI Changes +~~~~~~~~~~~~~~~~~~~~~~~ + +The following are examples of allowable ABI changes occurring between +declarations of major ABI versions. + +* DPDK 19.11 release, defines the function ``rte_foo()``, and ``rte_foo()`` + as part of the major ABI version ``20``. + +* DPDK 20.02 release defines a new function ``rte_foo(uint8_t bar)``, and + this is not a problem as long as the symbol ``rte_foo@DPDK20`` is + preserved through ABI Versioning. + + - The new function may be marked with the ``__rte_experimental`` tag for a + number of releases, as described in the section :ref:`experimental_apis`. + + - Once ``rte_foo(uint8_t bar)`` becomes non-experimental ``rte_foo()`` is then + declared as ``__rte_depreciated``, with an associated deprecation notice + provided. + +* DPDK 19.11 is not re-released to include ``rte_foo(uint8_t bar)``, the new + version of ``rte_foo`` only exists from DPDK 20.02 onwards as described in the + :ref:`note on forward-only compatibility<forward-only>`. + +* DPDK 20.02 release defines the experimental function ``__rte_experimental + rte_baz()``. This function may or may not exist in the DPDK 20.05 release. + +* An application ``dPacket`` wishes to use ``rte_foo(uint8_t bar)``, before the + declaration of the DPDK ``21`` major API version. The application can only + ensure its runtime dependencies are met by specifying ``DPDK (>= 20.2)`` as + an explicit package dependency, as the soname only may only indicate the + supported major ABI version. + +* At the release of DPDK 20.11, the function ``rte_foo(uint8_t bar)`` becomes + formally part of then new major ABI version DPDK 21.0 and ``rte_foo()`` may be + removed. + +.. _deprecation_notices: Examples of Deprecation Notices ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -104,46 +257,42 @@ Examples of Deprecation Notices The following are some examples of ABI deprecation notices which would be added to the Release Notes: -* The Macro ``#RTE_FOO`` is deprecated and will be removed with version 2.0, - to be replaced with the inline function ``rte_foo()``. +* The Macro ``#RTE_FOO`` is deprecated and will be removed with ABI version + 21, to be replaced with the inline function ``rte_foo()``. * The function ``rte_mbuf_grok()`` has been updated to include a new parameter - in version 2.0. Backwards compatibility will be maintained for this function - until the release of version 2.1 + in version 20.2. Backwards compatibility will be maintained for this function + until the release of the new DPDK major ABI version 21, in DPDK version + 20.11. -* The members of ``struct rte_foo`` have been reorganized in release 2.0 for +* The members of ``struct rte_foo`` have been reorganized in DPDK 20.02 for performance reasons. Existing binary applications will have backwards - compatibility in release 2.0, while newly built binaries will need to - reference the new structure variant ``struct rte_foo2``. Compatibility will - be removed in release 2.2, and all applications will require updating and + compatibility in release 20.02, while newly built binaries will need to + reference the new structure variant ``struct rte_foo2``. Compatibility will be + removed in release 20.11, and all applications will require updating and rebuilding to the new structure at that time, which will be renamed to the original ``struct rte_foo``. * Significant ABI changes are planned for the ``librte_dostuff`` library. The - upcoming release 2.0 will not contain these changes, but release 2.1 will, + upcoming release 20.02 will not contain these changes, but release 20.11 will, and no backwards compatibility is planned due to the extensive nature of - these changes. Binaries using this library built prior to version 2.1 will + these changes. Binaries using this library built prior to ABI version 21 will require updating and recompilation. -New API replacing previous one -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -If a new API proposed functionally replaces an existing one, when the new API -becomes non-experimental then the old one is marked with ``__rte_deprecated``. -Deprecated APIs are removed completely just after the next LTS. +.. _experimental_apis: -Reminder that old API should follow deprecation process to be removed. +Experimental +------------ +APIs +~~~~ -Experimental APIs ------------------ - -APIs marked as ``experimental`` are not considered part of the ABI and may -change without warning at any time. Since changes to APIs are most likely -immediately after their introduction, as users begin to take advantage of -those new APIs and start finding issues with them, new DPDK APIs will be -automatically marked as ``experimental`` to allow for a period of stabilization -before they become part of a tracked ABI. +APIs marked as ``experimental`` are not considered part of an ABI version and +may change without warning at any time. Since changes to APIs are most likely +immediately after their introduction, as users begin to take advantage of those +new APIs and start finding issues with them, new DPDK APIs will be automatically +marked as ``experimental`` to allow for a period of stabilization before they +become part of a tracked ABI version. Note that marking an API as experimental is a multi step process. To mark an API as experimental, the symbols which are desired to be exported @@ -161,7 +310,16 @@ In addition to tagging the code with ``__rte_experimental``, the doxygen markup must also contain the EXPERIMENTAL string, and the MAINTAINERS file should note the EXPERIMENTAL libraries. -For removing the experimental tag associated with an API, deprecation notice -is not required. Though, an API should remain in experimental state for at least -one release. Thereafter, normal process of posting patch for review to mailing -list can be followed. +For removing the experimental tag associated with an API, deprecation notice is +not required. Though, an API should remain in experimental state for at least +one release. Thereafter, the normal process of posting patch for review to +mailing list can be followed. + +Libraries +~~~~~~~~~ + +Libraries marked as ``experimental`` are entirely not considered part of an ABI +version, and may change without warning at any time. Experimental libraries +always have a major version of ``0`` to indicate they exist outside of +ABI Versioning, with the minor version incremented with each ABI change +to library. diff --git a/doc/guides/contributing/img/abi_stability_policy.svg b/doc/guides/contributing/img/abi_stability_policy.svg new file mode 100644 index 0000000..4fd4007 --- /dev/null +++ b/doc/guides/contributing/img/abi_stability_policy.svg @@ -0,0 +1,1059 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<svg + xmlns:dc="http://purl.org/dc/elements/1.1/" + xmlns:cc="http://creativecommons.org/ns#" + xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" + xmlns:svg="http://www.w3.org/2000/svg" + xmlns="http://www.w3.org/2000/svg" + xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd" + xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape" + width="1237.4869" + height="481.37463" + version="1.1" + viewBox="0 0 1237.4869 481.37463" + xml:space="preserve" + id="svg7800" + sodipodi:docname="abi_stability_policy.svg" + inkscape:version="0.92.2 (5c3e80d, 2017-08-06)"><metadata + id="metadata7804"><rdf:RDF><cc:Work + rdf:about=""><dc:format>image/svg+xml</dc:format><dc:type + rdf:resource="http://purl.org/dc/dcmitype/StillImage" /></cc:Work></rdf:RDF></metadata><sodipodi:namedview + pagecolor="#ffffff" + bordercolor="#666666" + borderopacity="1" + objecttolerance="10" + gridtolerance="10" + guidetolerance="10" + inkscape:pageopacity="0" + inkscape:pageshadow="2" + inkscape:window-width="1920" + inkscape:window-height="1017" + id="namedview7802" + showgrid="false" + inkscape:zoom="0.8875" + inkscape:cx="840.50495" + inkscape:cy="179.36692" + inkscape:window-x="-8" + inkscape:window-y="-8" + inkscape:window-maximized="1" + inkscape:current-layer="svg7800" /><defs + id="defs7394"><clipPath + id="clipPath3975"><path + d="M 0,1.2207e-4 H 960 V 540.00012 H 0 Z" + id="path7226" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4003"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7229" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4025"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7232" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4037"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7235" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4049"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7238" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4061"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7241" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4073"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7244" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4085"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7247" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4097"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7250" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4109"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7253" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4121"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7256" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4133"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7259" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4145"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7262" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4157"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7265" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4169"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7268" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4181"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7271" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4193"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7274" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4205"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7277" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4217"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7280" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4229"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7283" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4241"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7286" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4253"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7289" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4265"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7292" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4277"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7295" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4289"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7298" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4301"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7301" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4313"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7304" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4327"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7307" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4339"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7310" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4351"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7313" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4363"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7316" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4375"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7319" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4389"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7322" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4403"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7325" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4417"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7328" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4429"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7331" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4441"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7334" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4453"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7337" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4477"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7340" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4489"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7343" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4501"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7346" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4513"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7349" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4525"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7352" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4537"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7355" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4549"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7358" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4561"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7361" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4573"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7364" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4589"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7367" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4601"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7370" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4615"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7373" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4629"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7376" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4641"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7379" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4653"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7382" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4673"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7385" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4685"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7388" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4699"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7391" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath></defs><g + id="g7406" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><path + style="fill:#44546a" + inkscape:connector-curvature="0" + id="path7400" + d="m 161.83,180.57 773.79,4.78 c 0.82,0.01 1.49,0.68 1.49,1.51 -0.01,0.83 -0.68,1.5 -1.51,1.49 l -773.79,-4.78 c -0.83,-0.01 -1.5,-0.68 -1.49,-1.51 0.01,-0.83 0.68,-1.5 1.51,-1.49 z m 772.3,1.77 8.97,4.56 -9.03,4.44 z" /><path + style="fill:#00b050;fill-rule:evenodd" + inkscape:connector-curvature="0" + id="path7402" + d="m 173.28,182.22 c 0,4.67 3.36,8.46 7.5,8.46 4.14,0 7.5,-3.79 7.5,-8.46 0,-4.67 -3.36,-8.46 -7.5,-8.46 -4.14,0 -7.5,3.79 -7.5,8.46 z" /><path + style="fill:#00b050;fill-rule:evenodd" + inkscape:connector-curvature="0" + id="path7404" + d="m 612.24,183.78 c 0,4.67 3.36,8.46 7.5,8.46 4.14,0 7.5,-3.79 7.5,-8.46 0,-4.67 -3.36,-8.46 -7.5,-8.46 -4.14,0 -7.5,3.79 -7.5,8.46 z" /></g><g + style="fill:#ff0000;fill-rule:evenodd" + id="g7420" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><path + inkscape:connector-curvature="0" + id="path7408" + d="m 228.12,182.22 c 0,4.67 3.36,8.46 7.5,8.46 4.14,0 7.5,-3.79 7.5,-8.46 0,-4.67 -3.36,-8.46 -7.5,-8.46 -4.14,0 -7.5,3.79 -7.5,8.46 z" /><path + inkscape:connector-curvature="0" + id="path7410" + d="m 282.96,182.22 c 0,4.67 3.36,8.46 7.5,8.46 4.14,0 7.5,-3.79 7.5,-8.46 0,-4.67 -3.36,-8.46 -7.5,-8.46 -4.14,0 -7.5,3.79 -7.5,8.46 z" /><path + inkscape:connector-curvature="0" + id="path7412" + d="m 337.8,182.22 c 0,4.67 3.38,8.46 7.56,8.46 4.18,0 7.56,-3.79 7.56,-8.46 0,-4.67 -3.38,-8.46 -7.56,-8.46 -4.18,0 -7.56,3.79 -7.56,8.46 z" /><path + inkscape:connector-curvature="0" + id="path7414" + d="m 447.6,182.22 c 0,4.67 3.36,8.46 7.5,8.46 4.14,0 7.5,-3.79 7.5,-8.46 0,-4.67 -3.36,-8.46 -7.5,-8.46 -4.14,0 -7.5,3.79 -7.5,8.46 z" /><path + inkscape:connector-curvature="0" + id="path7416" + d="m 502.44,182.34 c 0,4.67 3.38,8.46 7.56,8.46 4.18,0 7.56,-3.79 7.56,-8.46 0,-4.67 -3.38,-8.46 -7.56,-8.46 -4.18,0 -7.56,3.79 -7.56,8.46 z" /><path + inkscape:connector-curvature="0" + id="path7418" + d="m 557.28,182.34 c 0,4.67 3.38,8.46 7.56,8.46 4.18,0 7.56,-3.79 7.56,-8.46 0,-4.67 -3.38,-8.46 -7.56,-8.46 -4.18,0 -7.56,3.79 -7.56,8.46 z" /></g><g + id="g7426" + clip-path="url(#clipPath4003)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7424" + font-size="14.04px" + transform="matrix(1,0,0,-1,152.98,149.45)"><tspan + id="tspan7422" + y="0" + x="0 6.3460798 13.46436 20.52648 24.10668 31.22496">v19.11</tspan></text> +</g><path + style="fill:#00b050;fill-rule:evenodd;stroke-width:1.33329999" + inkscape:connector-curvature="0" + id="path7428" + d="m 499.42541,379.9105 c 0,-6.22651 4.47989,-11.27972 9.99975,-11.27972 5.51986,0 9.99975,5.05321 9.99975,11.27972 0,6.22651 -4.47989,11.27972 -9.99975,11.27972 -5.51986,0 -9.99975,-5.05321 -9.99975,-11.27972 z" /><path + style="fill:#00b050;fill-rule:evenodd;stroke-width:1.33329999" + inkscape:connector-curvature="0" + id="path7430" + d="m 1084.6908,373.67065 c 0,-6.22651 4.4799,-11.27971 9.9997,-11.27971 5.5199,0 9.9998,5.0532 9.9998,11.27971 0,6.22652 -4.4799,11.27972 -9.9998,11.27972 -5.5198,0 -9.9997,-5.0532 -9.9997,-11.27972 z" /><g + style="fill:#ff0000;fill-rule:evenodd" + id="g7438" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><path + inkscape:connector-curvature="0" + id="path7432" + d="m 667.08,185.4 c 0,4.64 3.36,8.4 7.5,8.4 4.14,0 7.5,-3.76 7.5,-8.4 0,-4.64 -3.36,-8.4 -7.5,-8.4 -4.14,0 -7.5,3.76 -7.5,8.4 z" /><path + inkscape:connector-curvature="0" + id="path7434" + d="m 721.92,185.58 c 0,4.67 3.38,8.46 7.56,8.46 4.18,0 7.56,-3.79 7.56,-8.46 0,-4.67 -3.38,-8.46 -7.56,-8.46 -4.18,0 -7.56,3.79 -7.56,8.46 z" /><path + inkscape:connector-curvature="0" + id="path7436" + d="m 776.76,185.58 c 0,4.67 3.38,8.46 7.56,8.46 4.18,0 7.56,-3.79 7.56,-8.46 0,-4.67 -3.38,-8.46 -7.56,-8.46 -4.18,0 -7.56,3.79 -7.56,8.46 z" /></g><g + id="g7444" + clip-path="url(#clipPath4025)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7442" + font-size="14.04px" + transform="matrix(1,0,0,-1,210.14,150.1)"><tspan + id="tspan7440" + y="0" + x="0 6.3460798 13.46436 20.52648 24.10668 31.22496">v20.02</tspan></text> +</g><g + id="g7450" + clip-path="url(#clipPath4037)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7448" + font-size="14.04px" + transform="matrix(1,0,0,-1,265.01,150.1)"><tspan + id="tspan7446" + y="0" + x="0 6.3460798 13.46436 20.52648 24.10668 31.22496">v20.05</tspan></text> +</g><g + id="g7456" + clip-path="url(#clipPath4049)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7454" + font-size="14.04px" + transform="matrix(1,0,0,-1,319.9,150.77)"><tspan + id="tspan7452" + y="0" + x="0 6.3460798 13.46436 20.52648 24.10668 31.22496">v20.08</tspan></text> +</g><g + id="g7462" + clip-path="url(#clipPath4061)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.06400013px;font-family:Calibri;fill:#000000" + id="text7460" + font-size="14.064px" + transform="matrix(1,0,0,-1,375,150.94)"><tspan + id="tspan7458" + y="0" + x="0 7.9180322 14.992224 22.066416 25.652737 32.726929">V20.11</tspan></text> +</g><g + id="g7468" + clip-path="url(#clipPath4073)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.06400013px;font-family:Calibri;fill:#000000" + id="text7466" + font-size="14.064px" + transform="matrix(1,0,0,-1,429.17,150.94)"><tspan + id="tspan7464" + y="0" + x="0 6.3569279 13.445184 20.519377 24.105696 31.179888">v21.02</tspan></text> +</g><g + id="g7474" + clip-path="url(#clipPath4085)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7472" + font-size="14.04px" + transform="matrix(1,0,0,-1,483,150.55)"><tspan + id="tspan7470" + y="0" + x="0 6.3460798 13.46436 20.52648 24.10668 31.22496">v21.05</tspan></text> +</g><g + id="g7480" + clip-path="url(#clipPath4097)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.06400013px;font-family:Calibri;fill:#000000" + id="text7478" + font-size="14.064px" + transform="matrix(1,0,0,-1,537.38,150.82)"><tspan + id="tspan7476" + y="0" + x="0 6.3569279 13.445184 20.519377 24.105696 31.179888">v21.08</tspan></text> +</g><g + id="g7486" + clip-path="url(#clipPath4109)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.06400013px;font-family:Calibri;fill:#000000" + id="text7484" + font-size="14.064px" + transform="matrix(1,0,0,-1,592.27,150.82)"><tspan + id="tspan7482" + y="0" + x="0 6.3569279 13.445184 20.519377 24.105696 31.179888">v21.11</tspan></text> +</g><g + id="g7492" + clip-path="url(#clipPath4121)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7490" + font-size="14.04px" + transform="matrix(1,0,0,-1,647.14,151.46)"><tspan + id="tspan7488" + y="0" + x="0 6.3460798 13.46436 20.52648 24.10668 31.22496">v22.02</tspan></text> +</g><g + id="g7498" + clip-path="url(#clipPath4133)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7496" + font-size="14.04px" + transform="matrix(1,0,0,-1,702.24,151.63)"><tspan + id="tspan7494" + y="0" + x="0 7.96068 14.99472 22.113001 25.651079 32.76936">V22.05</tspan></text> +</g><g + id="g7504" + clip-path="url(#clipPath4145)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7502" + font-size="14.04px" + transform="matrix(1,0,0,-1,756.43,151.63)"><tspan + id="tspan7500" + y="0" + x="0 7.96068 14.99472 22.113001 25.651079 32.76936">V22.08</tspan></text> +</g><g + id="g7510" + clip-path="url(#clipPath4157)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7508" + font-size="14.04px" + transform="matrix(1,0,0,-1,811.99,151.63)"><tspan + id="tspan7506" + y="0" + x="0 7.96068 14.99472 22.113001 25.651079 32.76936">V22.11</tspan></text> +</g><g + id="g7516" + clip-path="url(#clipPath4169)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7514" + font-size="14.04px" + transform="matrix(1,0,0,-1,105.82,214.18)"><tspan + id="tspan7512" + y="0" + x="0 6.3460798 13.46436">v20</tspan></text> +</g><g + id="g7522" + clip-path="url(#clipPath4181)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.06400013px;font-family:Calibri;fill:#000000" + id="text7520" + font-size="14.064px" + transform="matrix(1,0,0,-1,105.5,247.68)"><tspan + id="tspan7518" + y="0" + x="0 6.3569279 13.445184">v21</tspan></text> +</g><g + id="g7528" + clip-path="url(#clipPath4193)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7526" + font-size="14.04px" + transform="matrix(1,0,0,-1,228.79,214.51)"><tspan + id="tspan7524" + y="0" + x="0">√</tspan></text> +</g><g + id="g7534" + clip-path="url(#clipPath4205)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7532" + font-size="14.04px" + transform="matrix(1,0,0,-1,283.8,214.51)"><tspan + id="tspan7530" + y="0" + x="0">√</tspan></text> +</g><g + id="g7540" + clip-path="url(#clipPath4217)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7538" + font-size="14.04px" + transform="matrix(1,0,0,-1,337.68,214.51)"><tspan + id="tspan7536" + y="0" + x="0">√</tspan></text> +</g><g + id="g7546" + clip-path="url(#clipPath4229)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7544" + font-size="14.04px" + transform="matrix(1,0,0,-1,611.66,285.79)"><tspan + id="tspan7542" + y="0" + x="0">√</tspan></text> +</g><g + id="g7552" + clip-path="url(#clipPath4241)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7550" + font-size="14.04px" + transform="matrix(1,0,0,-1,666.65,285.79)"><tspan + id="tspan7548" + y="0" + x="0">√</tspan></text> +</g><g + id="g7558" + clip-path="url(#clipPath4253)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7556" + font-size="14.04px" + transform="matrix(1,0,0,-1,719.4,285.79)"><tspan + id="tspan7554" + y="0" + x="0">√</tspan></text> +</g><g + id="g7564" + clip-path="url(#clipPath4265)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7562" + font-size="14.04px" + transform="matrix(1,0,0,-1,775.56,285.79)"><tspan + id="tspan7560" + y="0" + x="0">√</tspan></text> +</g><g + id="g7570" + clip-path="url(#clipPath4277)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7568" + font-size="14.04px" + transform="matrix(1,0,0,-1,398.54,249.22)"><tspan + id="tspan7566" + y="0" + x="0">√</tspan></text> +</g><g + id="g7576" + clip-path="url(#clipPath4289)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7574" + font-size="14.04px" + transform="matrix(1,0,0,-1,453.53,249.22)"><tspan + id="tspan7572" + y="0" + x="0">√</tspan></text> +</g><g + id="g7582" + clip-path="url(#clipPath4301)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7580" + font-size="14.04px" + transform="matrix(1,0,0,-1,507.43,249.22)"><tspan + id="tspan7578" + y="0" + x="0">√</tspan></text> +</g><g + id="g7588" + clip-path="url(#clipPath4313)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7586" + font-size="14.04px" + transform="matrix(1,0,0,-1,561.05,249.22)"><tspan + id="tspan7584" + y="0" + x="0">√</tspan></text> +</g><path + style="fill:#44546a;stroke-width:1.33329999" + inkscape:connector-curvature="0" + id="path7590" + d="m 217.67245,474.73479 v -25.14603 c 0,-1.10664 -0.89331,-1.99995 -1.99995,-1.99995 -1.10664,0 -1.99995,0.89331 -1.99995,1.99995 v 25.14603 c 0,1.09331 0.89331,1.99995 1.99995,1.99995 1.10664,0 1.99995,-0.90664 1.99995,-1.99995 z m 3.9999,-23.14608 -5.99985,-11.9997 -5.99985,11.9997 z" /><g + id="g7596" + clip-path="url(#clipPath4327)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7594" + font-size="14.04px" + transform="matrix(1,0,0,-1,170.83,214.51)"><tspan + id="tspan7592" + y="0" + x="0">√</tspan></text> +</g><g + id="g7602" + clip-path="url(#clipPath4339)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-weight:bold;font-size:14.06400013px;font-family:Calibri;fill:#000000" + id="text7600" + font-weight="bold" + font-size="14.064px" + transform="matrix(1,0,0,-1,23.4,272.33)"><tspan + id="tspan7598" + y="0" + x="0 8.5227842 16.412687 20.167776">ABI </tspan></text> +</g><g + id="g7608" + clip-path="url(#clipPath4351)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-weight:bold;font-size:14.06400013px;font-family:Calibri;fill:#000000" + id="text7606" + font-weight="bold" + font-size="14.064px" + transform="matrix(1,0,0,-1,46.68,272.33)"><tspan + id="tspan7604" + y="0" + x="0 7.566432 14.640624 19.563025 25.174561 28.662432 36.228863">Version</tspan></text> +</g><g + id="g7614" + clip-path="url(#clipPath4363)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-weight:bold;font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7612" + font-weight="bold" + font-size="14.04px" + transform="matrix(1,0,0,-1,17.64,255.5)"><tspan + id="tspan7610" + y="0" + x="0 7.4271598 14.98068 26.395201 33.934681 40.80024 45.700199 49.154041 56.7216 60.175442 63.671398 67.125237 72.053284">Compatibility</tspan></text> +</g><g + id="g7620" + clip-path="url(#clipPath4375)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7618" + font-size="14.04px" + transform="matrix(1,0,0,-1,191.28,116.86)"><tspan + id="tspan7616" + y="0" + x="0 6.3460798 13.46436">v20</tspan></text> +</g><path + style="fill:#44546a;stroke-width:1.33329999" + inkscape:connector-curvature="0" + id="path7622" + d="m 511.7451,474.89479 v -25.14604 c 0,-1.10664 -0.89331,-1.99995 -1.99995,-1.99995 -1.10664,0 -1.99995,0.89331 -1.99995,1.99995 v 25.14604 c 0,1.09331 0.89331,1.99995 1.99995,1.99995 1.10664,0 1.99995,-0.90664 1.99995,-1.99995 z m 3.9999,-23.14609 -5.99985,-11.9997 -5.99985,11.9997 z" /><g + id="g7628" + clip-path="url(#clipPath4389)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7626" + font-size="14.04px" + transform="matrix(1,0,0,-1,407.06,115.63)"><tspan + id="tspan7624" + y="0" + x="0 6.3460798 13.46436">v21</tspan></text> +</g><path + style="fill:#44546a;stroke-width:1.33329999" + inkscape:connector-curvature="0" + id="path7630" + d="m 804.53778,476.01476 v -25.14604 c 0,-1.10664 -0.89331,-1.99995 -1.99995,-1.99995 -1.10664,0 -1.99995,0.89331 -1.99995,1.99995 v 25.14604 c 0,1.09331 0.89331,1.99995 1.99995,1.99995 1.10664,0 1.99995,-0.90664 1.99995,-1.99995 z m 3.9999,-23.14609 -5.99985,-11.9997 -5.99985,11.9997 z" /><g + id="g7636" + clip-path="url(#clipPath4403)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7634" + font-size="14.04px" + transform="matrix(1,0,0,-1,626.66,114.74)"><tspan + id="tspan7632" + y="0" + x="0 6.3460798 13.46436">v22</tspan></text> +</g><path + style="fill:#44546a;stroke-width:1.33329999" + inkscape:connector-curvature="0" + id="path7638" + d="m 1098.2904,479.37468 v -25.14604 c 0,-1.10664 -0.8933,-1.99995 -1.9999,-1.99995 -1.1067,0 -2,0.89331 -2,1.99995 v 25.14604 c 0,1.0933 0.8933,1.99995 2,1.99995 1.1066,0 1.9999,-0.90665 1.9999,-1.99995 z m 3.9999,-23.14609 -5.9998,-11.9997 -5.9999,11.9997 z" /><g + id="g7644" + clip-path="url(#clipPath4417)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.06400013px;font-family:Calibri;fill:#000000" + id="text7642" + font-size="14.064px" + transform="matrix(1,0,0,-1,846.96,112.22)"><tspan + id="tspan7640" + y="0" + x="0 6.3569279 13.445184">v23</tspan></text> +</g><g + id="g7650" + clip-path="url(#clipPath4429)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7648" + font-size="14.04px" + transform="matrix(1,0,0,-1,832.87,318.46)"><tspan + id="tspan7646" + y="0" + x="0">√</tspan></text> +</g><g + id="g7656" + clip-path="url(#clipPath4441)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7654" + font-size="14.04px" + transform="matrix(1,0,0,-1,105.5,285.67)"><tspan + id="tspan7652" + y="0" + x="0 6.3460798 13.46436">v22</tspan></text> +</g><g + id="g7662" + clip-path="url(#clipPath4453)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7660" + font-size="14.04px" + transform="matrix(1,0,0,-1,104.93,319.87)"><tspan + id="tspan7658" + y="0" + x="0 6.3460798 13.46436">v23</tspan></text> +</g><path + style="fill:none;stroke:#5b9bd5;stroke-width:0.63998401;stroke-miterlimit:10;stroke-dasharray:2.559936, 1.919952" + inkscape:connector-curvature="0" + id="path7664" + stroke-miterlimit="10" + d="m 1104.7569,213.75465 -934.60326,0.39999" /><path + style="fill:none;stroke:#5b9bd5;stroke-width:0.63998401;stroke-miterlimit:10;stroke-dasharray:2.559936, 1.919952" + inkscape:connector-curvature="0" + id="path7666" + stroke-miterlimit="10" + d="M 1105.3969,255.35361 170.79362,255.7536" /><path + style="fill:none;stroke:#5b9bd5;stroke-width:0.63998401;stroke-miterlimit:10;stroke-dasharray:2.559936, 1.919952" + inkscape:connector-curvature="0" + id="path7668" + stroke-miterlimit="10" + d="M 1105.3969,299.35251 170.79362,299.7525" /><g + id="g7674" + clip-path="url(#clipPath4477)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.06400013px;font-family:Calibri;fill:#8497b0" + id="text7672" + font-size="14.064px" + transform="matrix(1,0,0,-1,283.8,251.38)"><tspan + id="tspan7670" + y="0" + x="0">√</tspan></text> +</g><g + id="g7680" + clip-path="url(#clipPath4489)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#8497b0" + id="text7678" + font-size="14.04px" + transform="matrix(1,0,0,-1,339.5,251.95)"><tspan + id="tspan7676" + y="0" + x="0">√</tspan></text> +</g><g + id="g7686" + clip-path="url(#clipPath4501)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#d0cece" + id="text7684" + font-size="14.04px" + transform="matrix(1,0,0,-1,229.8,250.63)"><tspan + id="tspan7682" + y="0" + x="0">√</tspan></text> +</g><g + id="g7692" + clip-path="url(#clipPath4513)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#d0cece" + id="text7690" + font-size="14.04px" + transform="matrix(1,0,0,-1,453.53,286.63)"><tspan + id="tspan7688" + y="0" + x="0">√</tspan></text> +</g><g + id="g7698" + clip-path="url(#clipPath4525)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#8497b0" + id="text7696" + font-size="14.04px" + transform="matrix(1,0,0,-1,507.43,286.63)"><tspan + id="tspan7694" + y="0" + x="0">√</tspan></text> +</g><g + id="g7704" + clip-path="url(#clipPath4537)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#8497b0" + id="text7702" + font-size="14.04px" + transform="matrix(1,0,0,-1,561.05,286.63)"><tspan + id="tspan7700" + y="0" + x="0">√</tspan></text> +</g><g + id="g7710" + clip-path="url(#clipPath4549)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#d0cece" + id="text7708" + font-size="14.04px" + transform="matrix(1,0,0,-1,667.39,318.89)"><tspan + id="tspan7706" + y="0" + x="0">√</tspan></text> +</g><g + id="g7716" + clip-path="url(#clipPath4561)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#8497b0" + id="text7714" + font-size="14.04px" + transform="matrix(1,0,0,-1,720.14,318.89)"><tspan + id="tspan7712" + y="0" + x="0">√</tspan></text> +</g><g + id="g7722" + clip-path="url(#clipPath4573)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#8497b0" + id="text7720" + font-size="14.04px" + transform="matrix(1,0,0,-1,776.3,318.89)"><tspan + id="tspan7718" + y="0" + x="0">√</tspan></text> +</g><path + style="fill:#7030a0;stroke-width:1.33329999" + inkscape:connector-curvature="0" + id="path7724" + d="m 211.36594,305.0057 2.18661,-227.154316 c 0.0133,-1.0933 -0.87997,-1.99995 -1.98661,-2.01328 -1.09331,-0.0133 -1.99995,0.87998 -2.01329,1.98662 l -2.18661,227.140986 c -0.0133,1.10663 0.87998,2.01328 1.98662,2.02661 1.10664,0.0133 1.99995,-0.87998 2.01328,-1.98662 z m -7.97313,-2.07994 5.87985,12.06636 6.11985,-11.94637 z" /><path + style="fill:#7030a0;stroke-width:1.33329999" + inkscape:connector-curvature="0" + id="path7726" + d="M 289.03067,238.94069 V 107.43731 c 0,-1.10664 -0.89331,-1.99995 -1.99995,-1.99995 -1.10664,0 -1.99995,0.89331 -1.99995,1.99995 v 131.50338 c 0,1.09331 0.89331,1.99995 1.99995,1.99995 1.10664,0 1.99995,-0.90664 1.99995,-1.99995 z m -7.9998,-1.99995 5.99985,11.9997 5.99985,-11.9997 z" /><g + id="g7732" + clip-path="url(#clipPath4589)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7730" + font-size="14.04px" + transform="matrix(1,0,0,-1,164.59,422.74)"><tspan + id="tspan7728" + y="0" + x="0 6.3460798 13.46436 20.52648 23.75568 31.88484 39.578758 43.06068 46.065239 49.294441 54.784081 57.957119 65.271957 72.263878 78.118561 81.347763 88.072922 92.762283 99.754204 107.04096 110.38248 117.10764 120.33684 123.56604 130.17888 137.50777 144.49968 151.78644 155.12796 165.16656 168.43788 173.14128 180.44208 183.67128 190.01736 197.13564 204.19775 207.77795 214.89624 221.94432 225.17352 229.9752 236.70036">v20 ABI is declared aligned with v19.11 LTS</tspan></text> +</g><g + id="g7738" + clip-path="url(#clipPath4601)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.06400013px;font-family:Calibri;fill:#000000" + id="text7736" + font-size="14.064px" + transform="matrix(1,0,0,-1,222.12,398.3)"><tspan + id="tspan7734" + y="0" + x="0 6.3569279 13.445184 20.519377 23.740032 29.014032 35.385025 46.537777 53.851055 61.262783 64.497505 70.038719 73.034355 79.771011 84.440254 91.401939 94.622589 101.35925 108.65846 115.97174 122.93343 130.2467 133.59393 140.3306 147.62981 154.94308 158.16374 164.52068 171.60893 178.68312 181.90378 187.17778 193.54877 204.70152 212.0148 219.42653 222.66125 228.20247 231.32468 238.06133 242.73058 249.69226 252.81447 263.98129 271.39301 278.77661 282.01132 286.30084 289.53555 296.53943 303.82458 307.34061 310.51904 316.0462 323.3595 330.67276 337.98605 345.39777 350.30612 355.01755 358.13977 362.21832 369.63004 374.53839 377.5762 383.93314 391.02139 398.09558 401.2178 409.36084 417.03979 420.51361 423.6358 429.40204 436.81378 444.04266 448.75412 451.98883 459.28806 466.60132 473.56302 479.06204">v21 symbols are added and v20 symbols are modified, support for v20 ABI continues.</tspan></text> +</g><path + style="fill:#7030a0;stroke-width:1.33329999" + inkscape:connector-curvature="0" + id="path7740" + d="m 510.78512,258.56686 -0.31999,-126.17017 c 0,-1.09331 0.89331,-1.99995 1.99995,-1.99995 1.09331,0 1.99995,0.89331 1.99995,1.99995 l 0.31999,126.15684 c 0,1.10664 -0.89331,2.01328 -1.99995,2.01328 -1.0933,0 -1.99995,-0.89331 -1.99995,-1.99995 z m 7.9998,-2.01328 -5.97318,12.01303 -6.02652,-11.98636 z" /><g + id="g7746" + clip-path="url(#clipPath4615)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7744" + font-size="14.04px" + transform="matrix(1,0,0,-1,388.51,373.39)"><tspan + id="tspan7742" + y="0" + x="0 6.3460798 13.46436 20.52648 23.75568 31.88484 39.578758 43.06068 46.065239 49.294441 54.784081 57.957119 65.271957 72.263878 78.118561 81.347763 88.072922 92.762283 99.754204 107.04096 110.38248 117.10764 120.33684 123.56604 130.17888 137.50777 144.49968 151.78644 155.12796 165.16656 168.43788 173.14128 180.44208 183.67128 190.01736 197.13564 204.19775 207.77795 214.89624 221.94432 225.17352 229.9752 236.70036 243.14471 246.65472 249.78564 254.46095 261.45288 272.58661 279.31177 282.54095 289.86984 293.09903 300.47003 307.02673 310.36823 316.71432 323.83261 330.89471 334.12393 339.40295 345.76309 356.92487 364.23972 371.63879 374.91013 380.39975 383.4324 390.15756 394.83289 401.8248 404.99783 409.71527 416.70721 427.84091 435.23999 441.51587 448.50781 455.79456">v21 ABI is declared aligned with v20.11 LTS, remaining v20 symbols are removed.</tspan></text> +</g><path + style="fill:none;stroke:#7030a0;stroke-width:2.07994795;stroke-miterlimit:10" + inkscape:connector-curvature="0" + id="path7748" + stroke-miterlimit="10" + d="M 278.23094,342.95142 H 449.58665 V 261.03347 H 278.23094 Z" /><g + id="g7754" + clip-path="url(#clipPath4629)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-weight:bold;font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7752" + font-weight="bold" + font-size="14.04px" + transform="matrix(1,0,0,-1,23.616,114.74)"><tspan + id="tspan7750" + y="0" + x="0 8.5082397 16.4268 20.17548 23.26428 30.817801 37.879921 42.821999 48.423962 51.93396 59.48748 67.026962">ABI Versions</tspan></text> +</g><g + id="g7760" + clip-path="url(#clipPath4641)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-weight:bold;font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7758" + font-weight="bold" + font-size="14.04px" + transform="matrix(1,0,0,-1,20.064,150.17)"><tspan + id="tspan7756" + y="0" + x="0 8.8451996 16.31448 25.159679 32.839561 36.0126 43.67844 50.740559 54.222481 61.284599 68.248444 73.850403 80.954643">DPDK Releases</tspan></text> +</g><g + id="g7766" + clip-path="url(#clipPath4653)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7764" + font-size="14.04px" + transform="matrix(1,0,0,-1,444,346.1)"><tspan + id="tspan7762" + y="0" + x="0 6.3460798 13.46436 20.52648 23.75568 29.034719 35.39484 46.556641 53.871479 61.270561 64.541878 70.031517 73.064163 79.789322 84.464638 91.456558 94.629601 101.35476 108.72576 116.02656 123.01848 130.30524 133.64676 140.37192 147.68677 155.0016 158.2308 164.57687 171.69516 178.75728 181.98648 187.26552 193.62564 204.78745 212.10228 219.50136 222.77267 228.26231 231.43536 238.16052 242.80775 249.79968 252.88847 264.05029 271.44937 278.82037 282.04956 286.33176 289.60309 296.595 303.88177 307.39175 310.56479 316.1106 323.42545 330.74026 338.05511 345.45419 350.39627 355.09967 358.20251 362.28815 369.68723 374.62933 377.63388 383.97995 391.09824 398.16037 401.27725 409.4064 417.10031 420.58224 423.69913 429.45551 436.85461 444.09924 448.80264 452.03183 459.33264 466.64749 473.6394 479.12903 488.81665 492.43896">v22 symbols are added and v21 symbols are modified, support for v21 ABI continues…..</tspan></text> +</g><path + style="fill:#7030a0;stroke-width:1.33329999" + inkscape:connector-curvature="0" + id="path7768" + d="m 583.39664,198.26171 -0.13333,-30.49257 c 0,-1.10664 0.89331,-2.01329 1.98662,-2.01329 1.10664,0 2.01328,0.89331 2.01328,1.98662 l 0.13333,30.49257 c 0,1.10664 -0.89331,2.01328 -1.99995,2.01328 -1.0933,0 -1.99995,-0.89331 -1.99995,-1.98661 z m 7.98647,-2.03995 -5.94652,12.02636 -6.05318,-11.97303 z" /><path + style="fill:none;stroke:#7030a0;stroke-width:2.07994795;stroke-miterlimit:10" + inkscape:connector-curvature="0" + id="path7770" + stroke-miterlimit="10" + d="M 571.18361,299.43251 H 742.37933 V 212.87467 H 571.18361 Z" /><path + style="fill:#00b050;fill-rule:evenodd;stroke-width:1.33329999" + inkscape:connector-curvature="0" + id="path7772" + d="m 933.01457,30.959224 c 0,-6.22651 4.50655,-11.27972 10.07975,-11.27972 5.57319,0 10.07974,5.05321 10.07974,11.27972 0,6.22651 -4.50655,11.27972 -10.07974,11.27972 -5.5732,0 -10.07975,-5.05321 -10.07975,-11.27972 z" /><path + style="fill:#ff0000;fill-rule:evenodd;stroke-width:1.33329999" + inkscape:connector-curvature="0" + id="path7774" + d="m 1081.3309,29.759254 c 0,-6.18651 4.4798,-11.19972 9.9997,-11.19972 5.5199,0 9.9998,5.01321 9.9998,11.19972 0,6.18651 -4.4799,11.19972 -9.9998,11.19972 -5.5199,0 -9.9997,-5.01321 -9.9997,-11.19972 z" /><g + id="g7780" + clip-path="url(#clipPath4673)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7778" + font-size="14.04px" + transform="matrix(1,0,0,-1,744.89,439.54)"><tspan + id="tspan7776" + y="0" + x="0 4.8016801 11.52684 17.971201 21.144239 28.5714 35.56332 38.792519 45.728279 52.453442 57.943081">LTS Release</tspan></text> +</g><g + id="g7786" + clip-path="url(#clipPath4685)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7784" + font-size="14.04px" + transform="matrix(1,0,0,-1,856.06,439.75)"><tspan + id="tspan7782" + y="0" + x="0 12.0042 15.2334 22.562281 29.961361 34.903439 38.020321 45.461521 52.453442 55.68264 62.618401 69.343559 74.833199">Minor Release</tspan></text> +</g><path + style="fill:#44546a;stroke-width:1.33329999" + inkscape:connector-curvature="0" + id="path7788" + d="m 779.25841,46.265514 v -25.14604 c 0,-1.10664 -0.89331,-1.99995 -1.99995,-1.99995 -1.10664,0 -1.99995,0.89331 -1.99995,1.99995 v 25.14604 c 0,1.0933 0.89331,1.99995 1.99995,1.99995 1.10664,0 1.99995,-0.90665 1.99995,-1.99995 z m 3.9999,-23.14609 -5.99985,-11.9997 -5.99985,11.9997 z" /><g + id="g7794" + clip-path="url(#clipPath4699)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7792" + font-size="14.04px" + transform="matrix(1,0,0,-1,622.34,439.54)"><tspan + id="tspan7790" + y="0" + x="0 8.1291599 15.82308 19.305 22.309561 29.512079 36.504002 41.151241 46.640881 49.870079 57.339359">ABI Version</tspan></text> +</g><path + style="fill:none;stroke:#002060;stroke-width:1.27996802;stroke-miterlimit:10" + inkscape:connector-curvature="0" + id="path7796" + stroke-miterlimit="10" + d="M 763.41881,62.078444 H 1236.847 V 0.63998401 H 763.41881 Z" /></svg> \ No newline at end of file diff --git a/doc/guides/contributing/img/what_is_an_abi.svg b/doc/guides/contributing/img/what_is_an_abi.svg new file mode 100644 index 0000000..fd3d993 --- /dev/null +++ b/doc/guides/contributing/img/what_is_an_abi.svg @@ -0,0 +1,382 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<svg + xmlns:dc="http://purl.org/dc/elements/1.1/" + xmlns:cc="http://creativecommons.org/ns#" + xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" + xmlns:svg="http://www.w3.org/2000/svg" + xmlns="http://www.w3.org/2000/svg" + xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd" + xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape" + width="970.69568" + height="522.22693" + version="1.1" + viewBox="0 0 970.69568 522.22693" + xml:space="preserve" + id="svg8399" + sodipodi:docname="what_is_an_abi.svg" + inkscape:version="0.92.2 (5c3e80d, 2017-08-06)"><metadata + id="metadata8403"><rdf:RDF><cc:Work + rdf:about=""><dc:format>image/svg+xml</dc:format><dc:type + rdf:resource="http://purl.org/dc/dcmitype/StillImage" /></cc:Work></rdf:RDF></metadata><sodipodi:namedview + pagecolor="#ffffff" + bordercolor="#666666" + borderopacity="1" + objecttolerance="10" + gridtolerance="10" + guidetolerance="10" + inkscape:pageopacity="0" + inkscape:pageshadow="2" + inkscape:window-width="1920" + inkscape:window-height="1017" + id="namedview8401" + showgrid="false" + inkscape:zoom="0.62755727" + inkscape:cx="820.83951" + inkscape:cy="-47.473217" + inkscape:window-x="-8" + inkscape:window-y="-8" + inkscape:window-maximized="1" + inkscape:current-layer="svg8399" /><defs + id="defs8269"><clipPath + id="clipPath26"><path + d="M 0,1.2207e-4 H 960 V 540.00012 H 0 Z" + id="path8206" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><radialGradient + id="radialGradient40" + cx="0" + cy="0" + r="1" + gradientTransform="matrix(386.44367,-1.3123672e-5,-1.3123672e-5,-386.44367,470.30824,246.15384)" + gradientUnits="userSpaceOnUse"><stop + stop-color="#f9d8e2" + offset="0" + id="stop8209" /><stop + stop-color="#fff" + offset=".74" + id="stop8211" /><stop + stop-color="#fff" + offset=".83" + id="stop8213" /><stop + stop-color="#fff" + offset="1" + id="stop8215" /></radialGradient><clipPath + id="clipPath56"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path8218" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath68"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path8221" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath82"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path8224" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath96"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path8227" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath108"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path8230" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath120"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path8233" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath132"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path8236" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath144"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path8239" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath156"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path8242" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath168"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path8245" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath180"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path8248" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath192"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path8251" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath204"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path8254" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath216"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path8257" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath228"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path8260" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath240"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path8263" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath260"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path8266" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath></defs><path + inkscape:connector-curvature="0" + style="fill:url(#radialGradient40);fill-rule:evenodd;stroke-width:1.33329999" + id="path8275" + d="m 116.15709,143.06309 c 0,-28.46596 23.07942,-51.545378 51.54538,-51.545378 h 605.21154 c 28.46595,0 51.54537,23.079418 51.54537,51.545378 V 349.2446 c 0,28.46595 -23.07942,51.54538 -51.54537,51.54538 H 167.70247 c -28.46595,0 -51.54538,-23.07943 -51.54538,-51.54538 z" /><path + style="fill:#00b050;stroke-width:1.33329999" + inkscape:connector-curvature="0" + id="path8277" + d="m 478.70803,73.758152 0.58665,373.057338 c 0,1.67996 -1.35997,3.03993 -3.03992,3.03993 -1.67996,0.0133 -3.03993,-1.34663 -3.03993,-3.02659 L 472.62818,73.758152 c 0,-1.67995 1.35997,-3.03992 3.03992,-3.03992 1.67996,0 3.03993,1.35997 3.03993,3.03992 z m 6.65317,370.004088 -9.09311,18.25287 -9.14644,-18.22621 z" /><path + style="fill:none;stroke:#7030a0;stroke-width:6.07984781;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:10" + inkscape:connector-curvature="0" + id="path8279" + stroke-miterlimit="10" + d="m 3.0399239,186.92866 c 0,-36.70575 29.7459201,-66.45167 66.4516701,-66.45167 H 778.00721 c 36.70575,0 66.45167,29.74592 66.45167,66.45167 v 265.80669 c 0,36.70574 -29.74592,66.45167 -66.45167,66.45167 H 69.491594 c -36.70575,0 -66.4516701,-29.74593 -66.4516701,-66.45167 z" /><path + style="fill:none;stroke:#3b3059;stroke-width:6.07984781;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:10" + inkscape:connector-curvature="0" + id="path8281" + stroke-miterlimit="10" + d="m 101.27746,71.464882 c 0,-37.78572 30.63924,-68.4249581 68.42496,-68.4249581 h 729.52846 c 37.7857,0 68.4249,30.6392381 68.4249,68.4249581 V 345.1647 c 0,37.78572 -30.6392,68.42496 -68.4249,68.42496 H 169.70242 c -37.78572,0 -68.42496,-30.63924 -68.42496,-68.42496 z" /><g + id="g8287" + clip-path="url(#clipPath56)" + transform="matrix(1.3333,0,0,-1.3333,-143.35642,633.10417)"><text + style="font-size:32.06399918px;font-family:'Century Gothic';fill:#3b3059" + id="text8285" + font-size="32.064px" + transform="matrix(1,0,0,-1,409.78,93.312)"><tspan + id="tspan8283" + y="0" + x="0 23.855616 42.837505 66.693123">DPDK</tspan></text> +</g><g + id="g8293" + clip-path="url(#clipPath68)" + transform="matrix(1.3333,0,0,-1.3333,-143.35642,633.10417)"><text + style="font-size:32.06399918px;font-family:'Century Gothic';fill:#3b3059" + id="text8291" + font-size="32.064px" + transform="matrix(1,0,0,-1,358.03,435.43)"><tspan + id="tspan8289" + y="0" + x="0 23.72736 45.595009 67.462654 73.875458 80.160004 100.90541 122.80512 133.54655 139.95937 160.96127">Application</tspan></text> +</g><path + style="fill:#f9d8e2;fill-opacity:0.70196001;fill-rule:evenodd;stroke-width:1.33329999" + inkscape:connector-curvature="0" + id="path8295" + d="M 424.30939,345.59136 H 531.18672 V 277.91305 H 424.30939 Z" /><g + id="g8301" + clip-path="url(#clipPath82)" + transform="matrix(1.3333,0,0,-1.3333,-143.35642,633.10417)"><text + style="font-size:32.04000092px;font-family:'Century Gothic';fill:#3b3059" + id="text8299" + font-size="32.04px" + transform="matrix(1,0,0,-1,432.96,231.41)"><tspan + id="tspan8297" + y="0" + x="0 23.7096 42.67728">API</tspan></text> +</g><path + style="fill:#f9d8e2;fill-opacity:0.70196001;fill-rule:evenodd;stroke-width:1.33329999" + inkscape:connector-curvature="0" + id="path8303" + d="m 422.38944,213.91465 h 107.19732 v -67.8383 H 422.38944 Z" /><g + id="g8309" + clip-path="url(#clipPath96)" + transform="matrix(1.3333,0,0,-1.3333,-143.35642,633.10417)"><text + style="font-size:32.04000092px;font-family:'Century Gothic';fill:#3b3059" + id="text8307" + font-size="32.04px" + transform="matrix(1,0,0,-1,431.54,330.29)"><tspan + id="tspan8305" + y="0" + x="0 23.7096 42.100559">ABI</tspan></text> +</g><g + id="g8315" + clip-path="url(#clipPath108)" + transform="matrix(1.3333,0,0,-1.3333,-143.35642,633.10417)"><text + style="font-size:15.96000004px;font-family:'Century Gothic';fill:#3b3059" + id="text8313" + font-size="15.96px" + transform="matrix(1,0,0,-1,221.78,293.23)"><tspan + id="tspan8311" + y="0" + x="0 9.4483204 14.25228 24.706079 35.447159 40.203239 51.10392 66.106323 81.076797 84.332642 94.068237">Programming</tspan></text> +</g><g + id="g8321" + clip-path="url(#clipPath120)" + transform="matrix(1.3333,0,0,-1.3333,-143.35642,633.10417)"><text + style="font-size:15.98400021px;font-family:'Century Gothic';fill:#3b3059" + id="text8319" + font-size="15.984px" + transform="matrix(1,0,0,-1,221.78,274.03)"><tspan + id="tspan8317" + y="0" + x="0 7.320672 18.237743 27.987984 38.633327 48.351601 59.268673 69.945984">Language</tspan></text> +</g><g + id="g8327" + clip-path="url(#clipPath132)" + transform="matrix(1.3333,0,0,-1.3333,-143.35642,633.10417)"><text + style="font-size:15.96000004px;font-family:'Century Gothic';fill:#3b3059" + id="text8325" + font-size="15.96px" + transform="matrix(1,0,0,-1,221.78,254.81)"><tspan + id="tspan8323" + y="0" + x="0 7.6767602 17.38044 27.116039 37.442162 42.708961 45.93288 56.386681 66.122276">Functions</tspan></text> +</g><g + id="g8333" + clip-path="url(#clipPath144)" + transform="matrix(1.3333,0,0,-1.3333,-143.35642,633.10417)"><text + style="font-size:15.96000004px;font-family:'Century Gothic';fill:#3b3059" + id="text8331" + font-size="15.96px" + transform="matrix(1,0,0,-1,221.78,235.61)"><tspan + id="tspan8329" + y="0" + x="0 11.87424 22.77492 28.073641 38.974319 44.273041 52.891441 63.776161 74.150162">Datatypes</tspan></text> +</g><g + id="g8339" + clip-path="url(#clipPath156)" + transform="matrix(1.3333,0,0,-1.3333,-143.35642,633.10417)"><text + style="font-size:15.96000004px;font-family:'Century Gothic';fill:#3b3059" + id="text8337" + font-size="15.96px" + transform="matrix(1,0,0,-1,221.78,216.41)"><tspan + id="tspan8335" + y="0" + x="0 9.6877203 20.06172 25.312559 35.016239 39.820202 49.555801 54.216122 60.823559 69.441963 80.326683 90.700684">Return Types</tspan></text> +</g><g + id="g8345" + clip-path="url(#clipPath168)" + transform="matrix(1.3333,0,0,-1.3333,-143.35642,633.10417)"><text + style="font-size:15.96000004px;font-family:'Century Gothic';fill:#3b3059" + id="text8343" + font-size="15.96px" + transform="matrix(1,0,0,-1,221.78,197.21)"><tspan + id="tspan8341" + y="0" + x="0 12.97548 23.429279 33.164879 39.357361 44.640121 55.540798 65.276398 70.559158">Constants</tspan></text> +</g><g + id="g8351" + clip-path="url(#clipPath180)" + transform="matrix(1.3333,0,0,-1.3333,-143.35642,633.10417)"><text + style="font-size:15.96000004px;font-family:'Century Gothic';fill:#3b3059" + id="text8349" + font-size="15.96px" + transform="matrix(1,0,0,-1,221.78,178.01)"><tspan + id="tspan8347" + y="0" + x="0">…</tspan></text> +</g><g + id="g8357" + clip-path="url(#clipPath192)" + transform="matrix(1.3333,0,0,-1.3333,-143.35642,633.10417)"><text + style="font-size:15.96000004px;font-family:'Century Gothic';fill:#3b3059" + id="text8355" + font-size="15.96px" + transform="matrix(1,0,0,-1,546.38,354.12)"><tspan + id="tspan8353" + y="0" + x="0 3.8304 13.566 19.75848 25.07316 29.877119 39.580799 49.906921 55.189678 58.413601 68.867401 78.602997 83.2314 89.423882 99.797882">Instruction set</tspan></text> +</g><g + id="g8363" + clip-path="url(#clipPath204)" + transform="matrix(1.3333,0,0,-1.3333,-143.35642,633.10417)"><text + style="font-size:15.98400021px;font-family:'Century Gothic';fill:#3b3059" + id="text8361" + font-size="15.984px" + transform="matrix(1,0,0,-1,546.38,332.88)"><tspan + id="tspan8359" + y="0" + x="0 8.5674238 16.239744 26.517456 36.859104 46.577377 51.836113 62.753185 73.654274 77.026894 87.352562 91.892014 103.99191 108.33955 115.66022 118.85703 128.60727 136.63123 147.02083">Executable & Linker</tspan></text> +</g><g + id="g8369" + clip-path="url(#clipPath216)" + transform="matrix(1.3333,0,0,-1.3333,-143.35642,633.10417)"><text + style="font-size:15.96000004px;font-family:'Century Gothic';fill:#3b3059" + id="text8367" + font-size="15.96px" + transform="matrix(1,0,0,-1,546.38,313.66)"><tspan + id="tspan8365" + y="0" + x="0 7.6767602 18.13056 22.934521 37.904999 48.805679">Format</tspan></text> +</g><g + id="g8375" + clip-path="url(#clipPath228)" + transform="matrix(1.3333,0,0,-1.3333,-143.35642,633.10417)"><text + style="font-size:15.96000004px;font-family:'Century Gothic';fill:#3b3059" + id="text8373" + font-size="15.96px" + transform="matrix(1,0,0,-1,546.38,292.42)"><tspan + id="tspan8371" + y="0" + x="0 12.97548 23.87616 27.22776 30.579359 33.80328 43.538879 54.200161 58.39764 71.373123 81.82692 91.562523 100.6278 110.95392 120.68952 125.95632 129.18024 139.63403 149.36964 155.56212">Calling Conventions.</tspan></text> +</g><g + id="g8381" + clip-path="url(#clipPath240)" + transform="matrix(1.3333,0,0,-1.3333,-143.35642,633.10417)"><text + style="font-size:15.96000004px;font-family:'Century Gothic';fill:#3b3059" + id="text8379" + font-size="15.96px" + transform="matrix(1,0,0,-1,546.38,271.3)"><tspan + id="tspan8377" + y="0" + x="0">…</tspan></text> +</g><path + style="fill:none;stroke:#ffffff;stroke-width:6.07984781;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:10;stroke-dasharray:18.239544, 24.319392" + inkscape:connector-curvature="0" + id="path8383" + stroke-miterlimit="10" + d="M 122.71693,120.47699 H 782.84709" /><path + style="fill:none;stroke:#ffffff;stroke-width:6.07984781;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:10;stroke-dasharray:18.239544, 24.319392" + inkscape:connector-curvature="0" + id="path8385" + stroke-miterlimit="10" + d="M 177.27556,413.58966 H 837.40573" /><g + id="g8391" + clip-path="url(#clipPath260)" + transform="matrix(1.3333,0,0,-1.3333,-143.35642,633.10417)"><text + style="font-style:italic;font-size:15.96000004px;font-family:'Century Gothic';fill:#3b3059" + id="text8389" + font-style="italic" + font-size="15.96px" + transform="matrix(1,0,0,-1,483.19,405.82)"><tspan + id="tspan8387" + y="0" + x="0 5.0114398 14.71512 24.45072 34.77684 40.299 43.522919 53.976719 63.712318 68.13324 78.459358 89.360039 92.583961 95.807877">function calls</tspan></text> +</g><path + style="fill:none;stroke:#3b3059;stroke-width:0.95997602;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:10" + inkscape:connector-curvature="0" + id="path8393" + stroke-miterlimit="10" + d="m 574.38564,303.03242 c -11.93304,0 -21.59946,-1.61329 -21.59946,-3.59991 V 164.62255 c 0,-1.98662 -9.66643,-3.59991 -21.59946,-3.59991 11.93303,0 21.59946,-1.61329 21.59946,-3.59991 v -18.30621 c 0,-1.98662 9.66642,-3.59991 21.59946,-3.59991" /><path + style="fill:none;stroke:#3b3059;stroke-width:0.95997602;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:10" + inkscape:connector-curvature="0" + id="path8395" + stroke-miterlimit="10" + d="m 372.63068,389.43026 c 13.293,0 24.0794,-1.79995 24.0794,-4.01323 v -91.53105 c 0,-2.21327 10.78639,-4.01323 24.0794,-4.01323 -13.29301,0 -24.0794,-1.79995 -24.0794,-4.01323 v -65.3717 c 0,-2.21328 -10.7864,-4.01323 -24.0794,-4.01323" /></svg> \ No newline at end of file diff --git a/doc/guides/contributing/stable.rst b/doc/guides/contributing/stable.rst index 6a5eee9..4d38bb8 100644 --- a/doc/guides/contributing/stable.rst +++ b/doc/guides/contributing/stable.rst @@ -1,7 +1,7 @@ .. SPDX-License-Identifier: BSD-3-Clause Copyright 2018 The DPDK contributors -.. stable_lts_releases: +.. _stable_lts_releases: DPDK Stable Releases and Long Term Support ========================================== @@ -53,6 +53,9 @@ year's November (X.11) release will be maintained as an LTS for 2 years. After the X.11 release, an LTS branch will be created for it at http://git.dpdk.org/dpdk-stable where bugfixes will be backported to. +A LTS release may align with the declaration of a new major ABI version, +please read the :doc:`abi_policy` for more information. + It is anticipated that there will be at least 4 releases per year of the LTS or approximately 1 every 3 months. However, the cadence can be shorter or longer depending on the number and criticality of the backported @@ -119,10 +122,3 @@ A Stable Release will be released by: list. Stable releases are available on the `dpdk.org download page <http://core.dpdk.org/download/>`_. - - -ABI ---- - -The Stable Release should not be seen as a way of breaking or circumventing -the DPDK ABI policy. -- 2.7.4 ^ permalink raw reply [flat|nested] 20+ messages in thread
* Re: [dpdk-dev] [PATCH v9 2/4] doc: changes to abi policy introducing major abi versions 2019-11-08 12:46 ` [dpdk-dev] [PATCH v9 2/4] doc: changes to abi policy introducing major abi versions Ray Kinsella @ 2019-11-08 17:11 ` Thomas Monjalon 2019-11-08 17:12 ` Ray Kinsella 0 siblings, 1 reply; 20+ messages in thread From: Thomas Monjalon @ 2019-11-08 17:11 UTC (permalink / raw) To: Ray Kinsella Cc: dev, stephen, bruce.richardson, ferruh.yigit, konstantin.ananyev, jerinj, olivier.matz, nhorman, maxime.coquelin, john.mcnamara, marko.kovacevic, hemant.agrawal, ktraynor, aconole 08/11/2019 13:46, Ray Kinsella: > This policy change introduces major ABI versions, these are > declared every year, typically aligned with the LTS release > and are supported by subsequent releases in the following year. > This change is intended to improve ABI stabilty for those projects > consuming DPDK. > > Signed-off-by: Ray Kinsella <mdr@ashroe.eu> > Acked-by: John Mcnamara <john.mcnamara@intel.com> > Acked-by: Stephen Hemminger <stephen@networkplumber.org> Acked-by: Thomas Monjalon <thomas@monjalon.net> > --- > +#. Major ABI versions are declared no more frequently than yearly. Compatibility > + with the major ABI version is mandatory in subsequent releases until a new > + major ABI version is declared. > +#. Major ABI version are usually but not always declared aligned with a > + :ref:`LTS release <stable_lts_releases>`. OK thanks > +#. The ABI version is managed at a project level in DPDK, with the ABI version > + reflected in all library's soname. It is not specifying the experimental lib exception. But I can live without it. > +A new major ABI version is declared no more frequently than yearly, with > +declarations usually aligning with a LTS release, e.g. ABI 20 for DPDK 19.11. > +Compatibility with the major ABI version is then mandatory in subsequent > +releases until the next major ABI version is declared, e.g. ABI 21 for DPDK > +20.11. OK thanks > + Note that, this policy details the method by which the ABI may be changed, > + with due regard to preserving compatibility and observing deprecation > + notices. This process however should not be undertaken lightly, as a general > + rule ABI stability is extremely important for downstream consumers of DPDK. > + The API should only be changed for significant reasons, such as performance > + enhancements. API breakages due to changes such as reorganizing public > + structure fields for aesthetic or readability purposes should be avoided. OK thanks > +Libraries marked as ``experimental`` are entirely not considered part of an ABI > +version, and may change without warning at any time. Experimental libraries > +always have a major version of ``0`` to indicate they exist outside of > +ABI Versioning, with the minor version incremented with each ABI change > +to library. OK ^ permalink raw reply [flat|nested] 20+ messages in thread
* Re: [dpdk-dev] [PATCH v9 2/4] doc: changes to abi policy introducing major abi versions 2019-11-08 17:11 ` Thomas Monjalon @ 2019-11-08 17:12 ` Ray Kinsella 2019-11-08 17:38 ` Thomas Monjalon 0 siblings, 1 reply; 20+ messages in thread From: Ray Kinsella @ 2019-11-08 17:12 UTC (permalink / raw) To: Thomas Monjalon Cc: dev, stephen, bruce.richardson, ferruh.yigit, konstantin.ananyev, jerinj, olivier.matz, nhorman, maxime.coquelin, john.mcnamara, marko.kovacevic, hemant.agrawal, ktraynor, aconole On 08/11/2019 17:11, Thomas Monjalon wrote: > 08/11/2019 13:46, Ray Kinsella: >> This policy change introduces major ABI versions, these are >> declared every year, typically aligned with the LTS release >> and are supported by subsequent releases in the following year. >> This change is intended to improve ABI stabilty for those projects >> consuming DPDK. >> >> Signed-off-by: Ray Kinsella <mdr@ashroe.eu> >> Acked-by: John Mcnamara <john.mcnamara@intel.com> >> Acked-by: Stephen Hemminger <stephen@networkplumber.org> > > Acked-by: Thomas Monjalon <thomas@monjalon.net> > >> --- >> +#. Major ABI versions are declared no more frequently than yearly. Compatibility >> + with the major ABI version is mandatory in subsequent releases until a new >> + major ABI version is declared. >> +#. Major ABI version are usually but not always declared aligned with a >> + :ref:`LTS release <stable_lts_releases>`. > > OK thanks > >> +#. The ABI version is managed at a project level in DPDK, with the ABI version >> + reflected in all library's soname. > > It is not specifying the experimental lib exception. > But I can live without it. I will fix in a follow up on Monday. > >> +A new major ABI version is declared no more frequently than yearly, with >> +declarations usually aligning with a LTS release, e.g. ABI 20 for DPDK 19.11. >> +Compatibility with the major ABI version is then mandatory in subsequent >> +releases until the next major ABI version is declared, e.g. ABI 21 for DPDK >> +20.11. > > OK thanks > >> + Note that, this policy details the method by which the ABI may be changed, >> + with due regard to preserving compatibility and observing deprecation >> + notices. This process however should not be undertaken lightly, as a general >> + rule ABI stability is extremely important for downstream consumers of DPDK. >> + The API should only be changed for significant reasons, such as performance >> + enhancements. API breakages due to changes such as reorganizing public >> + structure fields for aesthetic or readability purposes should be avoided. > > OK thanks > >> +Libraries marked as ``experimental`` are entirely not considered part of an ABI >> +version, and may change without warning at any time. Experimental libraries >> +always have a major version of ``0`` to indicate they exist outside of >> +ABI Versioning, with the minor version incremented with each ABI change >> +to library. > > OK > > ^ permalink raw reply [flat|nested] 20+ messages in thread
* Re: [dpdk-dev] [PATCH v9 2/4] doc: changes to abi policy introducing major abi versions 2019-11-08 17:12 ` Ray Kinsella @ 2019-11-08 17:38 ` Thomas Monjalon 2019-11-11 11:03 ` Ray Kinsella 0 siblings, 1 reply; 20+ messages in thread From: Thomas Monjalon @ 2019-11-08 17:38 UTC (permalink / raw) To: Ray Kinsella Cc: dev, stephen, bruce.richardson, ferruh.yigit, konstantin.ananyev, jerinj, olivier.matz, nhorman, maxime.coquelin, john.mcnamara, marko.kovacevic, hemant.agrawal, ktraynor, aconole 08/11/2019 18:12, Ray Kinsella: > On 08/11/2019 17:11, Thomas Monjalon wrote: > > 08/11/2019 13:46, Ray Kinsella: > >> +#. The ABI version is managed at a project level in DPDK, with the ABI version > >> + reflected in all library's soname. > > > > It is not specifying the experimental lib exception. > > But I can live without it. > > I will fix in a follow up on Monday. If you send a new version, please rebase as there was a change in master with LTO series. Thanks ^ permalink raw reply [flat|nested] 20+ messages in thread
* Re: [dpdk-dev] [PATCH v9 2/4] doc: changes to abi policy introducing major abi versions 2019-11-08 17:38 ` Thomas Monjalon @ 2019-11-11 11:03 ` Ray Kinsella 0 siblings, 0 replies; 20+ messages in thread From: Ray Kinsella @ 2019-11-11 11:03 UTC (permalink / raw) To: Thomas Monjalon, dpdk-dev On 08/11/2019 17:38, Thomas Monjalon wrote: > 08/11/2019 18:12, Ray Kinsella: >> On 08/11/2019 17:11, Thomas Monjalon wrote: >>> 08/11/2019 13:46, Ray Kinsella: >>>> +#. The ABI version is managed at a project level in DPDK, with the ABI version >>>> + reflected in all library's soname. >>> >>> It is not specifying the experimental lib exception. >>> But I can live without it. >> >> I will fix in a follow up on Monday. > > If you send a new version, please rebase as there was a change in master > with LTO series. Thanks Balls, neglected to rebase before sending the v10. I will take care of it. Ray K ^ permalink raw reply [flat|nested] 20+ messages in thread
* [dpdk-dev] [PATCH v9 3/4] doc: updates to versioning guide for abi versions 2019-11-08 12:46 [dpdk-dev] [PATCH v9 0/4] doc: changes to abi policy introducing major abi versions Ray Kinsella 2019-11-08 12:46 ` [dpdk-dev] [PATCH v9 1/4] doc: separate versioning.rst into version and policy Ray Kinsella 2019-11-08 12:46 ` [dpdk-dev] [PATCH v9 2/4] doc: changes to abi policy introducing major abi versions Ray Kinsella @ 2019-11-08 12:46 ` Ray Kinsella 2019-11-08 12:46 ` [dpdk-dev] [PATCH v9 4/4] doc: add maintainer for abi policy Ray Kinsella ` (2 subsequent siblings) 5 siblings, 0 replies; 20+ messages in thread From: Ray Kinsella @ 2019-11-08 12:46 UTC (permalink / raw) To: dev Cc: mdr, thomas, stephen, bruce.richardson, ferruh.yigit, konstantin.ananyev, jerinj, olivier.matz, nhorman, maxime.coquelin, john.mcnamara, marko.kovacevic, hemant.agrawal, ktraynor, aconole Updates to the ABI versioning guide, to account for the changes to the DPDK ABI/API policy. Fixes for references to abi versioning and policy guides. Signed-off-by: Ray Kinsella <mdr@ashroe.eu> Acked-by: John Mcnamara <john.mcnamara@intel.com> Acked-by: Stephen Hemminger <stephen@networkplumber.org> --- doc/guides/contributing/abi_policy.rst | 15 +- doc/guides/contributing/abi_versioning.rst | 250 +++++++++++++++++++---------- doc/guides/contributing/patches.rst | 6 +- doc/guides/rel_notes/deprecation.rst | 6 +- 4 files changed, 183 insertions(+), 94 deletions(-) diff --git a/doc/guides/contributing/abi_policy.rst b/doc/guides/contributing/abi_policy.rst index 0965bcc..6ebdd83 100644 --- a/doc/guides/contributing/abi_policy.rst +++ b/doc/guides/contributing/abi_policy.rst @@ -19,11 +19,11 @@ General Guidelines #. Major ABI version are usually but not always declared aligned with a :ref:`LTS release <stable_lts_releases>`. #. The ABI version is managed at a project level in DPDK, with the ABI version - reflected in all library's soname. + reflected in all :ref:`library's soname <what_is_soname>`. #. The ABI should be preserved and not changed lightly. ABI changes must follow the outlined :ref:`deprecation process <abi_changes>`. #. The addition of symbols is generally not problematic. The modification of - symbols is managed with ABI Versioning. + symbols is managed with :ref:`ABI Versioning <abi_versioning>`. #. The removal of symbols is considered an :ref:`ABI breakage <abi_breakages>`, once approved these will form part of the next ABI version. #. Libraries or APIs marked as :ref:`Experimental <experimental_apis>` are not @@ -67,13 +67,14 @@ An ABI version is an instance of a library's ABI at a specific release. Certain releases are considered to be milestone releases, the yearly LTS release for example. The ABI of a milestone release may be declared as a 'major ABI version', where this ABI version is then supported for some number of subsequent -releases and is annotated in the library's soname. +releases and is annotated in the library's :ref:`soname<what_is_soname>`. ABI version support in subsequent releases facilitates application upgrades, by enabling applications built against the milestone release to upgrade to subsequent releases of a library without a rebuild. -More details on major ABI version can be found in the ABI Versioning guide. +More details on major ABI version can be found in the :ref:`ABI versioning +<major_abi_versions>` guide. The DPDK ABI policy ------------------- @@ -146,7 +147,7 @@ The requirements for changing the ABI are: CPU vendors, end-users, etc. #. Backward compatibility with the major ABI version must be maintained through - ABI Versioning, with :ref:`forward-only <forward-only>` compatibility + :ref:`abi_versioning`, with :ref:`forward-only <forward-only>` compatibility offered for any ABI changes that are indicated to be part of the next ABI version. @@ -223,7 +224,7 @@ declarations of major ABI versions. * DPDK 20.02 release defines a new function ``rte_foo(uint8_t bar)``, and this is not a problem as long as the symbol ``rte_foo@DPDK20`` is - preserved through ABI Versioning. + preserved through :ref:`abi_versioning`. - The new function may be marked with the ``__rte_experimental`` tag for a number of releases, as described in the section :ref:`experimental_apis`. @@ -321,5 +322,5 @@ Libraries Libraries marked as ``experimental`` are entirely not considered part of an ABI version, and may change without warning at any time. Experimental libraries always have a major version of ``0`` to indicate they exist outside of -ABI Versioning, with the minor version incremented with each ABI change +:ref:`abi_versioning` , with the minor version incremented with each ABI change to library. diff --git a/doc/guides/contributing/abi_versioning.rst b/doc/guides/contributing/abi_versioning.rst index 1c5612c..a3d5479 100644 --- a/doc/guides/contributing/abi_versioning.rst +++ b/doc/guides/contributing/abi_versioning.rst @@ -1,44 +1,134 @@ .. SPDX-License-Identifier: BSD-3-Clause Copyright 2018 The DPDK contributors -.. library_versioning: +.. _abi_versioning: -Library versioning +ABI Versioning +============== + +This document details the mechanics of ABI version management in DPDK. + +.. _what_is_soname: + +What is a library's soname? +--------------------------- + +System libraries usually adopt the familiar major and minor version naming +convention, where major versions (e.g. ``librte_eal 20.x, 21.x``) are presumed +to be ABI incompatible with each other and minor versions (e.g. ``librte_eal +20.1, 20.2``) are presumed to be ABI compatible. A library's `soname +<https://en.wikipedia.org/wiki/Soname>`_. is typically used to provide backward +compatibility information about a given library, describing the lowest common +denominator ABI supported by the library. The soname or logical name for the +library, is typically comprised of the library's name and major version e.g. +``librte_eal.so.20``. + +During an application's build process, a library's soname is noted as a runtime +dependency of the application. This information is then used by the `dynamic +linker <https://en.wikipedia.org/wiki/Dynamic_linker>`_ when resolving the +applications dependencies at runtime, to load a library supporting the correct +ABI version. The library loaded at runtime therefore, may be a minor revision +supporting the same major ABI version (e.g. ``librte_eal.20.2``), as the library +used to link the application (e.g ``librte_eal.20.0``). + +.. _major_abi_versions: + +Major ABI versions ------------------ -Downstreams might want to provide different DPDK releases at the same time to -support multiple consumers of DPDK linked against older and newer sonames. +An ABI version change to a given library, especially in core libraries such as +``librte_mbuf``, may cause an implicit ripple effect on the ABI of it's +consuming libraries, causing ABI breakages. There may however be no explicit +reason to bump a dependent library's ABI version, as there may have been no +obvious change to the dependent library's API, even though the library's ABI +compatibility will have been broken. + +This interdependence of DPDK libraries, means that ABI versioning of libraries +is more manageable at a project level, with all project libraries sharing a +**single ABI version**. In addition, the need to maintain a stable ABI for some +number of releases as described in the section :doc:`abi_policy`, means +that ABI version increments need to carefully planned and managed at a project +level. + +Major ABI versions are therefore declared typically aligned with an LTS release +and is then supported some number of subsequent releases, shared across all +libraries. This means that a single project level ABI version, reflected in all +individual library's soname, library filenames and associated version maps +persists over multiple releases. + +.. code-block:: none + + $ head ./lib/librte_acl/rte_acl_version.map + DPDK_20 { + global: + ... -Also due to the interdependencies that DPDK libraries can have applications -might end up with an executable space in which multiple versions of a library -are mapped by ld.so. + $ head ./lib/librte_eal/rte_eal_version.map + DPDK_20 { + global: + ... -Think of LibA that got an ABI bump and LibB that did not get an ABI bump but is -depending on LibA. +When an ABI change is made between major ABI versions to a given library, a new +section is added to that library's version map describing the impending new ABI +version, as described in the section :ref:`example_abi_macro_usage`. The +library's soname and filename however do not change, e.g. ``libacl.so.20``, as +ABI compatibility with the last major ABI version continues to be preserved for +that library. -.. note:: +.. code-block:: none - Application - \-> LibA.old - \-> LibB.new -> LibA.new + $ head ./lib/librte_acl/rte_acl_version.map + DPDK_20 { + global: + ... -That is a conflict which can be avoided by setting ``CONFIG_RTE_MAJOR_ABI``. -If set, the value of ``CONFIG_RTE_MAJOR_ABI`` overwrites all - otherwise per -library - versions defined in the libraries ``LIBABIVER``. -An example might be ``CONFIG_RTE_MAJOR_ABI=16.11`` which will make all libraries -``librte<?>.so.16.11`` instead of ``librte<?>.so.<LIBABIVER>``. + DPDK_21 { + global: + + } DPDK_20; + ... + $ head ./lib/librte_eal/rte_eal_version.map + DPDK_20 { + global: + ... + +However when a new ABI version is declared, for example DPDK ``21``, old +depreciated functions may be safely removed at this point and the entire old +major ABI version removed, see the section :ref:`deprecating_entire_abi` on +how this may be done. + +.. code-block:: none + + $ head ./lib/librte_acl/rte_acl_version.map + DPDK_21 { + global: + ... + + $ head ./lib/librte_eal/rte_eal_version.map + DPDK_21 { + global: + ... + +At the same time, the major ABI version is changed atomically across all +libraries by incrementing the major version in individual library's soname, e.g. +``libacl.so.21``. This is done by bumping the LIBABIVER number in the libraries +Makefile to indicate to dynamic linking applications that this is a later, and +possibly incompatible library version: + +.. code-block:: c + + -LIBABIVER := 20 + +LIBABIVER := 21 -ABI versioning --------------- Versioning Macros -~~~~~~~~~~~~~~~~~ +----------------- When a symbol is exported from a library to provide an API, it also provides a calling convention (ABI) that is embodied in its name, return type and arguments. Occasionally that function may need to change to accommodate new -functionality or behavior. When that occurs, it is desirable to allow for +functionality or behavior. When that occurs, it is may be required to allow for backward compatibility for a time with older binaries that are dynamically linked to the DPDK. @@ -61,8 +151,10 @@ The macros exported are: fully qualified function ``p``, so that if a symbol becomes versioned, it can still be mapped back to the public symbol name. +.. _example_abi_macro_usage: + Examples of ABI Macro use -^^^^^^^^^^^^^^^^^^^^^^^^^ +~~~~~~~~~~~~~~~~~~~~~~~~~ Updating a public API _____________________ @@ -106,16 +198,16 @@ maintain previous ABI versions that are accessible only to previously compiled binaries The addition of a parameter to the function is ABI breaking as the function is -public, and existing application may use it in its current form. However, the +public, and existing application may use it in its current form. However, the compatibility macros in DPDK allow a developer to use symbol versioning so that multiple functions can be mapped to the same public symbol based on when an -application was linked to it. To see how this is done, we start with the -requisite libraries version map file. Initially the version map file for the -acl library looks like this +application was linked to it. To see how this is done, we start with the +requisite libraries version map file. Initially the version map file for the acl +library looks like this .. code-block:: none - DPDK_2.0 { + DPDK_20 { global: rte_acl_add_rules; @@ -141,7 +233,7 @@ This file needs to be modified as follows .. code-block:: none - DPDK_2.0 { + DPDK_20 { global: rte_acl_add_rules; @@ -163,16 +255,16 @@ This file needs to be modified as follows local: *; }; - DPDK_2.1 { + DPDK_21 { global: rte_acl_create; - } DPDK_2.0; + } DPDK_20; The addition of the new block tells the linker that a new version node is -available (DPDK_2.1), which contains the symbol rte_acl_create, and inherits the -symbols from the DPDK_2.0 node. This list is directly translated into a list of -exported symbols when DPDK is compiled as a shared library +available (DPDK_21), which contains the symbol rte_acl_create, and inherits +the symbols from the DPDK_20 node. This list is directly translated into a +list of exported symbols when DPDK is compiled as a shared library Next, we need to specify in the code which function map to the rte_acl_create symbol at which versions. First, at the site of the initial symbol definition, @@ -191,22 +283,22 @@ with the public symbol name Note that the base name of the symbol was kept intact, as this is conducive to the macros used for versioning symbols. That is our next step, mapping this new -symbol name to the initial symbol name at version node 2.0. Immediately after +symbol name to the initial symbol name at version node 20. Immediately after the function, we add this line of code .. code-block:: c - VERSION_SYMBOL(rte_acl_create, _v20, 2.0); + VERSION_SYMBOL(rte_acl_create, _v20, 20); -Remembering to also add the rte_function_versioning.h header to the requisite c file where -these changes are being made. The above macro instructs the linker to create a -new symbol ``rte_acl_create@DPDK_2.0``, which matches the symbol created in older -builds, but now points to the above newly named function. We have now mapped -the original rte_acl_create symbol to the original function (but with a new -name) +Remembering to also add the rte_function_versioning.h header to the requisite c +file where these changes are being made. The above macro instructs the linker to +create a new symbol ``rte_acl_create@DPDK_20``, which matches the symbol created +in older builds, but now points to the above newly named function. We have now +mapped the original rte_acl_create symbol to the original function (but with a +new name). -Next, we need to create the 2.1 version of the symbol. We create a new function -name, with a different suffix, and implement it appropriately +Next, we need to create the 21 version of the symbol. We create a new function +name, with a different suffix, and implement it appropriately .. code-block:: c @@ -220,12 +312,12 @@ name, with a different suffix, and implement it appropriately return ctx; } -This code serves as our new API call. Its the same as our old call, but adds -the new parameter in place. Next we need to map this function to the symbol -``rte_acl_create@DPDK_2.1``. To do this, we modify the public prototype of the call -in the header file, adding the macro there to inform all including applications, -that on re-link, the default rte_acl_create symbol should point to this -function. Note that we could do this by simply naming the function above +This code serves as our new API call. Its the same as our old call, but adds the +new parameter in place. Next we need to map this function to the symbol +``rte_acl_create@DPDK_21``. To do this, we modify the public prototype of the +call in the header file, adding the macro there to inform all including +applications, that on re-link, the default rte_acl_create symbol should point to +this function. Note that we could do this by simply naming the function above rte_acl_create, and the linker would chose the most recent version tag to apply in the version script, but we can also do this in the header file @@ -233,11 +325,11 @@ in the version script, but we can also do this in the header file struct rte_acl_ctx * -rte_acl_create(const struct rte_acl_param *param); - +rte_acl_create(const struct rte_acl_param *param, int debug); - +BIND_DEFAULT_SYMBOL(rte_acl_create, _v21, 2.1); + +rte_acl_create_v21(const struct rte_acl_param *param, int debug); + +BIND_DEFAULT_SYMBOL(rte_acl_create, _v21, 21); The BIND_DEFAULT_SYMBOL macro explicitly tells applications that include this -header, to link to the rte_acl_create_v21 function and apply the DPDK_2.1 +header, to link to the rte_acl_create_v21 function and apply the DPDK_21 version node to it. This method is more explicit and flexible than just re-implementing the exact symbol name, and allows for other features (such as linking to the old symbol version by default, when the new ABI is to be opt-in @@ -257,6 +349,7 @@ assumption is that the most recent version of the symbol is the one you want to map. So, back in the C file where, immediately after ``rte_acl_create_v21`` is defined, we add this + .. code-block:: c struct rte_acl_ctx * @@ -270,21 +363,22 @@ That tells the compiler that, when building a static library, any calls to the symbol ``rte_acl_create`` should be linked to ``rte_acl_create_v21`` That's it, on the next shared library rebuild, there will be two versions of -rte_acl_create, an old DPDK_2.0 version, used by previously built applications, -and a new DPDK_2.1 version, used by future built applications. +rte_acl_create, an old DPDK_20 version, used by previously built applications, +and a new DPDK_21 version, used by future built applications. Deprecating part of a public API ________________________________ -Lets assume that you've done the above update, and after a few releases have -passed you decide you would like to retire the old version of the function. -After having gone through the ABI deprecation announcement process, removal is -easy. Start by removing the symbol from the requisite version map file: +Lets assume that you've done the above update, and in preparation for the next +major ABI version you decide you would like to retire the old version of the +function. After having gone through the ABI deprecation announcement process, +removal is easy. Start by removing the symbol from the requisite version map +file: .. code-block:: none - DPDK_2.0 { + DPDK_20 { global: rte_acl_add_rules; @@ -306,48 +400,42 @@ easy. Start by removing the symbol from the requisite version map file: local: *; }; - DPDK_2.1 { + DPDK_21 { global: rte_acl_create; - } DPDK_2.0; + } DPDK_20; Next remove the corresponding versioned export. .. code-block:: c - -VERSION_SYMBOL(rte_acl_create, _v20, 2.0); + -VERSION_SYMBOL(rte_acl_create, _v20, 20); Note that the internal function definition could also be removed, but its used -in our example by the newer version _v21, so we leave it in place. This is a -coding style choice. - -Lastly, we need to bump the LIBABIVER number for this library in the Makefile to -indicate to applications doing dynamic linking that this is a later, and -possibly incompatible library version: - -.. code-block:: c +in our example by the newer version v21, so we leave it in place and declare it +as static. This is a coding style choice. - -LIBABIVER := 1 - +LIBABIVER := 2 +.. _deprecating_entire_abi: Deprecating an entire ABI version _________________________________ -While removing a symbol from and ABI may be useful, it is often more practical -to remove an entire version node at once. If a version node completely -specifies an API, then removing part of it, typically makes it incomplete. In -those cases it is better to remove the entire node +While removing a symbol from an ABI may be useful, it is more practical to +remove an entire version node at once, as is typically done at the declaration +of a major ABI version. If a version node completely specifies an API, then +removing part of it, typically makes it incomplete. In those cases it is better +to remove the entire node. To do this, start by modifying the version map file, such that all symbols from -the node to be removed are merged into the next node in the map +the node to be removed are merged into the next node in the map. In the case of our map above, it would transform to look as follows .. code-block:: none - DPDK_2.1 { + DPDK_21 { global: rte_acl_add_rules; @@ -375,8 +463,8 @@ symbols. .. code-block:: c - -BIND_DEFAULT_SYMBOL(rte_acl_create, _v20, 2.0); - +BIND_DEFAULT_SYMBOL(rte_acl_create, _v21, 2.1); + -BIND_DEFAULT_SYMBOL(rte_acl_create, _v20, 20); + +BIND_DEFAULT_SYMBOL(rte_acl_create, _v21, 21); Lastly, any VERSION_SYMBOL macros that point to the old version node should be removed, taking care to keep, where need old code in place to support newer diff --git a/doc/guides/contributing/patches.rst b/doc/guides/contributing/patches.rst index c9ec529..2140303 100644 --- a/doc/guides/contributing/patches.rst +++ b/doc/guides/contributing/patches.rst @@ -156,9 +156,9 @@ Make your planned changes in the cloned ``dpdk`` repo. Here are some guidelines * For other PMDs and more info, refer to the ``MAINTAINERS`` file. -* New external functions should be added to the local ``version.map`` file. - See the :doc:`Guidelines for ABI policy and versioning </contributing/abi_versioning>`. - New external functions should also be added in alphabetical order. +* New external functions should be added to the local ``version.map`` file. See + the :doc:`ABI policy <abi_policy>` and :ref:`ABI versioning <abi_versioning>` + guides. New external functions should also be added in alphabetical order. * Important changes will require an addition to the release notes in ``doc/guides/rel_notes/``. See the :ref:`Release Notes section of the Documentation Guidelines <doc_guidelines>` for details. diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst index cf37d80..d454915 100644 --- a/doc/guides/rel_notes/deprecation.rst +++ b/doc/guides/rel_notes/deprecation.rst @@ -4,9 +4,9 @@ ABI and API Deprecation ======================= -See the :doc:`guidelines document for details of the ABI policy </contributing/abi_versioning>`. -API and ABI deprecation notices are to be posted here. - +See the guidelines document for details of the :doc:`ABI policy +<../contributing/abi_policy>`. API and ABI deprecation notices are to be posted +here. Deprecation Notices ------------------- -- 2.7.4 ^ permalink raw reply [flat|nested] 20+ messages in thread
* [dpdk-dev] [PATCH v9 4/4] doc: add maintainer for abi policy 2019-11-08 12:46 [dpdk-dev] [PATCH v9 0/4] doc: changes to abi policy introducing major abi versions Ray Kinsella ` (2 preceding siblings ...) 2019-11-08 12:46 ` [dpdk-dev] [PATCH v9 3/4] doc: updates to versioning guide for " Ray Kinsella @ 2019-11-08 12:46 ` Ray Kinsella 2019-11-08 17:18 ` Thomas Monjalon 2019-11-11 10:37 ` [dpdk-dev] [PATCH v10 0/3] doc: changes to abi policy introducing major abi versions Ray Kinsella 2019-11-11 11:57 ` [dpdk-dev] [PATCH v11 0/3] doc: changes to abi policy introducing major " Ray Kinsella 5 siblings, 1 reply; 20+ messages in thread From: Ray Kinsella @ 2019-11-08 12:46 UTC (permalink / raw) To: dev Cc: mdr, thomas, stephen, bruce.richardson, ferruh.yigit, konstantin.ananyev, jerinj, olivier.matz, nhorman, maxime.coquelin, john.mcnamara, marko.kovacevic, hemant.agrawal, ktraynor, aconole Add an entry to the maintainer file for the abi policy. Signed-off-by: Ray Kinsella <mdr@ashroe.eu> Acked-by: John Mcnamara <john.mcnamara@intel.com> --- MAINTAINERS | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/MAINTAINERS b/MAINTAINERS index 717c318..d5bb806 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -84,6 +84,10 @@ M: Marko Kovacevic <marko.kovacevic@intel.com> F: README F: doc/ +ABI Policy +M: Ray Kinsella <mdr@ashroe.eu> +F: doc/guides/contributing/abi_*.rst + Developers and Maintainers Tools M: Thomas Monjalon <thomas@monjalon.net> F: MAINTAINERS -- 2.7.4 ^ permalink raw reply [flat|nested] 20+ messages in thread
* Re: [dpdk-dev] [PATCH v9 4/4] doc: add maintainer for abi policy 2019-11-08 12:46 ` [dpdk-dev] [PATCH v9 4/4] doc: add maintainer for abi policy Ray Kinsella @ 2019-11-08 17:18 ` Thomas Monjalon 0 siblings, 0 replies; 20+ messages in thread From: Thomas Monjalon @ 2019-11-08 17:18 UTC (permalink / raw) To: Ray Kinsella Cc: dev, stephen, bruce.richardson, ferruh.yigit, konstantin.ananyev, jerinj, olivier.matz, nhorman, maxime.coquelin, john.mcnamara, marko.kovacevic, hemant.agrawal, ktraynor, aconole 08/11/2019 13:46, Ray Kinsella: > Add an entry to the maintainer file for the abi policy. > > Signed-off-by: Ray Kinsella <mdr@ashroe.eu> > Acked-by: John Mcnamara <john.mcnamara@intel.com> > --- > --- a/MAINTAINERS > +++ b/MAINTAINERS > +ABI Policy > +M: Ray Kinsella <mdr@ashroe.eu> > +F: doc/guides/contributing/abi_*.rst If you are doing a new version, this patch can be squashed in the first one. If you are doing a new version, please use --in-reply-to. ^ permalink raw reply [flat|nested] 20+ messages in thread
* [dpdk-dev] [PATCH v10 0/3] doc: changes to abi policy introducing major abi versions 2019-11-08 12:46 [dpdk-dev] [PATCH v9 0/4] doc: changes to abi policy introducing major abi versions Ray Kinsella ` (3 preceding siblings ...) 2019-11-08 12:46 ` [dpdk-dev] [PATCH v9 4/4] doc: add maintainer for abi policy Ray Kinsella @ 2019-11-11 10:37 ` Ray Kinsella 2019-11-11 10:37 ` [dpdk-dev] [PATCH v10 1/3] doc: separate versioning.rst into version and policy Ray Kinsella ` (2 more replies) 2019-11-11 11:57 ` [dpdk-dev] [PATCH v11 0/3] doc: changes to abi policy introducing major " Ray Kinsella 5 siblings, 3 replies; 20+ messages in thread From: Ray Kinsella @ 2019-11-11 10:37 UTC (permalink / raw) To: dev Cc: mdr, thomas, stephen, bruce.richardson, ferruh.yigit, konstantin.ananyev, jerinj, olivier.matz, nhorman, maxime.coquelin, john.mcnamara, marko.kovacevic, hemant.agrawal, ktraynor, aconole TL;DR abbreviation: A major ABI version that all DPDK releases during an agreed period support. ABI versioning is managed at a project-level, in place of library-level management. ABI changes to add new features are permitted, as long as ABI compatibility with the major ABI version is maintained. Detail: This patch introduces major ABI versions, initally released aligned with the LTS release and maintained for one year through subsequent releases. The intention is that the one year abi support period, will then be reviewed after the initial year with the intention of lengthening the period for the next ABI version and declaring new major ABI versions less frequently. ABI changes that preserve ABI compatibility with the major ABI version are permitted in subsequent releases. ABI changes, follow similar approval rules as before with the additional gate of now requiring technical board approval. The merging and release of ABI breaking changes would now be pushed to the declaration of the next major ABI version. This change encourages developers to maintain ABI compatibility with the major ABI version, by promoting a permissive culture around those changes that preserve ABI compatibility. This approach begins to align DPDK with those projects that declare major ABI versions (e.g. version 2.x, 3.x) and support those versions for some period, typically two years or more. To provide an example of how this might work in practice: * DPDK v20 is declared as the supported ABI version for one year, aligned with the DPDK v19.11 (LTS) release. All library sonames are updated to reflect the new ABI version, e.g. librte_eal.so.20, librte_acl.so.20... * DPDK v20.02 .. v20.08 releases are ABI compatible with the DPDK v20 ABI. ABI changes are permitted from DPDK v20.02 onwards, with the condition that ABI compatibility with DPDK v20 is preserved. * DPDK v21 is declared as the new supported ABI version for two years, aligned with the DPDK v20.11 (LTS) release. The DPDK v20 ABI is now depreciated, library sonames are updated to v21 and ABI compatibility breaking changes may be introduced. v9 * Fixed the upwording on experimental libraries in summary. v9 * Loosened up word around when new major ABI's are declared. (as suggested by Thomas Monjalon and agreed at the Techboard) v8 * Fixed intermediate build warnings, figure annotations and typo's. (as suggested by John McNamara). v7 * PNGs are now SVG. Some additional clarifications. Fixed typos and grammatical errors. (as suggested by Thomas Monjalon and David Marchand) v6 * Added figure to abi_policy.rst, comparing and contrasting the DPDK abi and api. (as suggested by Aaron Conole) v5 * Added figure to abi_policy.rst, mapping abi versions and abi compatibility to DPDK releases. (as suggested by Neil Horman) v4 * Removed changes to stable.rst, fixed typos and clarified the ABI policy "warning". v3 * Added myself as the maintainer of the ABI policy. * Updated the policy and versioning guides to use the year of the LTS+1 (e.g. v20), as the abi major version number. v2 * Restructured the patch into 3 patches: 1. Splits the original versioning document into an ABI policy document and ABI versioning document. 2. Add changes to the policy document introducing major ABI versions. 3. Fixes up the versioning document in light of major ABI versioning. * Reduces the initial ABI stability from two years to one year, with a review after the first year. * Adds detail around ABI version handling for experimental libraries. * Adds detail around chain of responsility for removing deprecated symbols. Ray Kinsella (3): doc: separate versioning.rst into version and policy doc: changes to abi policy introducing major abi versions doc: updates to versioning guide for abi versions MAINTAINERS | 4 + doc/guides/contributing/abi_policy.rst | 327 ++++++ doc/guides/contributing/abi_versioning.rst | 515 ++++++++++ .../contributing/img/abi_stability_policy.svg | 1059 ++++++++++++++++++++ doc/guides/contributing/img/what_is_an_abi.svg | 382 +++++++ doc/guides/contributing/index.rst | 3 +- doc/guides/contributing/patches.rst | 6 +- doc/guides/contributing/stable.rst | 12 +- doc/guides/contributing/versioning.rst | 591 ----------- doc/guides/rel_notes/deprecation.rst | 6 +- 10 files changed, 2299 insertions(+), 606 deletions(-) create mode 100644 doc/guides/contributing/abi_policy.rst create mode 100644 doc/guides/contributing/abi_versioning.rst create mode 100644 doc/guides/contributing/img/abi_stability_policy.svg create mode 100644 doc/guides/contributing/img/what_is_an_abi.svg delete mode 100644 doc/guides/contributing/versioning.rst -- 2.7.4 ^ permalink raw reply [flat|nested] 20+ messages in thread
* [dpdk-dev] [PATCH v10 1/3] doc: separate versioning.rst into version and policy 2019-11-11 10:37 ` [dpdk-dev] [PATCH v10 0/3] doc: changes to abi policy introducing major abi versions Ray Kinsella @ 2019-11-11 10:37 ` Ray Kinsella 2019-11-11 10:37 ` [dpdk-dev] [PATCH v10 2/3] doc: changes to abi policy introducing major abi versions Ray Kinsella 2019-11-11 10:37 ` [dpdk-dev] [PATCH v10 3/3] doc: updates to versioning guide for " Ray Kinsella 2 siblings, 0 replies; 20+ messages in thread From: Ray Kinsella @ 2019-11-11 10:37 UTC (permalink / raw) To: dev Cc: mdr, thomas, stephen, bruce.richardson, ferruh.yigit, konstantin.ananyev, jerinj, olivier.matz, nhorman, maxime.coquelin, john.mcnamara, marko.kovacevic, hemant.agrawal, ktraynor, aconole Separate versioning.rst into abi versioning and abi policy guidance, in preparation for adding more detail to the abi policy. Add an entry to the maintainer file for the abi policy. Signed-off-by: Ray Kinsella <mdr@ashroe.eu> Acked-by: John Mcnamara <john.mcnamara@intel.com> Acked-by: Stephen Hemminger <stephen@networkplumber.org> --- MAINTAINERS | 4 + doc/guides/contributing/abi_policy.rst | 167 ++++++++ doc/guides/contributing/abi_versioning.rst | 427 +++++++++++++++++++++ doc/guides/contributing/index.rst | 3 +- doc/guides/contributing/patches.rst | 2 +- doc/guides/contributing/versioning.rst | 591 ----------------------------- doc/guides/rel_notes/deprecation.rst | 2 +- 7 files changed, 602 insertions(+), 594 deletions(-) create mode 100644 doc/guides/contributing/abi_policy.rst create mode 100644 doc/guides/contributing/abi_versioning.rst delete mode 100644 doc/guides/contributing/versioning.rst diff --git a/MAINTAINERS b/MAINTAINERS index 717c318..d5bb806 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -84,6 +84,10 @@ M: Marko Kovacevic <marko.kovacevic@intel.com> F: README F: doc/ +ABI Policy +M: Ray Kinsella <mdr@ashroe.eu> +F: doc/guides/contributing/abi_*.rst + Developers and Maintainers Tools M: Thomas Monjalon <thomas@monjalon.net> F: MAINTAINERS diff --git a/doc/guides/contributing/abi_policy.rst b/doc/guides/contributing/abi_policy.rst new file mode 100644 index 0000000..d4f4e9f --- /dev/null +++ b/doc/guides/contributing/abi_policy.rst @@ -0,0 +1,167 @@ +.. SPDX-License-Identifier: BSD-3-Clause + Copyright 2018 The DPDK contributors + +DPDK ABI/API policy +=================== + +Description +----------- + +This document details some methods for handling ABI management in the DPDK. + +General Guidelines +------------------ + +#. Whenever possible, ABI should be preserved +#. ABI/API may be changed with a deprecation process +#. The modification of symbols can generally be managed with versioning +#. Libraries or APIs marked in ``experimental`` state may change without constraint +#. New APIs will be marked as ``experimental`` for at least one release to allow + any issues found by users of the new API to be fixed quickly +#. The addition of symbols is generally not problematic +#. The removal of symbols generally is an ABI break and requires bumping of the + LIBABIVER macro +#. Updates to the minimum hardware requirements, which drop support for hardware which + was previously supported, should be treated as an ABI change. + +What is an ABI +~~~~~~~~~~~~~~ + +An ABI (Application Binary Interface) is the set of runtime interfaces exposed +by a library. It is similar to an API (Application Programming Interface) but +is the result of compilation. It is also effectively cloned when applications +link to dynamic libraries. That is to say when an application is compiled to +link against dynamic libraries, it is assumed that the ABI remains constant +between the time the application is compiled/linked, and the time that it runs. +Therefore, in the case of dynamic linking, it is critical that an ABI is +preserved, or (when modified), done in such a way that the application is unable +to behave improperly or in an unexpected fashion. + + +ABI/API Deprecation +------------------- + +The DPDK ABI policy +~~~~~~~~~~~~~~~~~~~ + +ABI versions are set at the time of major release labeling, and the ABI may +change multiple times, without warning, between the last release label and the +HEAD label of the git tree. + +ABI versions, once released, are available until such time as their +deprecation has been noted in the Release Notes for at least one major release +cycle. For example consider the case where the ABI for DPDK 2.0 has been +shipped and then a decision is made to modify it during the development of +DPDK 2.1. The decision will be recorded in the Release Notes for the DPDK 2.1 +release and the modification will be made available in the DPDK 2.2 release. + +ABI versions may be deprecated in whole or in part as needed by a given +update. + +Some ABI changes may be too significant to reasonably maintain multiple +versions. In those cases ABI's may be updated without backward compatibility +being provided. The requirements for doing so are: + +#. At least 3 acknowledgments of the need to do so must be made on the + dpdk.org mailing list. + + - The acknowledgment of the maintainer of the component is mandatory, or if + no maintainer is available for the component, the tree/sub-tree maintainer + for that component must acknowledge the ABI change instead. + + - It is also recommended that acknowledgments from different "areas of + interest" be sought for each deprecation, for example: from NIC vendors, + CPU vendors, end-users, etc. + +#. The changes (including an alternative map file) can be included with + deprecation notice, in wrapped way by the ``RTE_NEXT_ABI`` option, + to provide more details about oncoming changes. + ``RTE_NEXT_ABI`` wrapper will be removed when it become the default ABI. + More preferred way to provide this information is sending the feature + as a separate patch and reference it in deprecation notice. + +#. A full deprecation cycle, as explained above, must be made to offer + downstream consumers sufficient warning of the change. + +Note that the above process for ABI deprecation should not be undertaken +lightly. ABI stability is extremely important for downstream consumers of the +DPDK, especially when distributed in shared object form. Every effort should +be made to preserve the ABI whenever possible. The ABI should only be changed +for significant reasons, such as performance enhancements. ABI breakage due to +changes such as reorganizing public structure fields for aesthetic or +readability purposes should be avoided. + +.. note:: + + Updates to the minimum hardware requirements, which drop support for hardware + which was previously supported, should be treated as an ABI change, and + follow the relevant deprecation policy procedures as above: 3 acks and + announcement at least one release in advance. + +Examples of Deprecation Notices +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The following are some examples of ABI deprecation notices which would be +added to the Release Notes: + +* The Macro ``#RTE_FOO`` is deprecated and will be removed with version 2.0, + to be replaced with the inline function ``rte_foo()``. + +* The function ``rte_mbuf_grok()`` has been updated to include a new parameter + in version 2.0. Backwards compatibility will be maintained for this function + until the release of version 2.1 + +* The members of ``struct rte_foo`` have been reorganized in release 2.0 for + performance reasons. Existing binary applications will have backwards + compatibility in release 2.0, while newly built binaries will need to + reference the new structure variant ``struct rte_foo2``. Compatibility will + be removed in release 2.2, and all applications will require updating and + rebuilding to the new structure at that time, which will be renamed to the + original ``struct rte_foo``. + +* Significant ABI changes are planned for the ``librte_dostuff`` library. The + upcoming release 2.0 will not contain these changes, but release 2.1 will, + and no backwards compatibility is planned due to the extensive nature of + these changes. Binaries using this library built prior to version 2.1 will + require updating and recompilation. + +New API replacing previous one +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +If a new API proposed functionally replaces an existing one, when the new API +becomes non-experimental then the old one is marked with ``__rte_deprecated``. +Deprecated APIs are removed completely just after the next LTS. + +Reminder that old API should follow deprecation process to be removed. + + +Experimental APIs +----------------- + +APIs marked as ``experimental`` are not considered part of the ABI and may +change without warning at any time. Since changes to APIs are most likely +immediately after their introduction, as users begin to take advantage of +those new APIs and start finding issues with them, new DPDK APIs will be +automatically marked as ``experimental`` to allow for a period of stabilization +before they become part of a tracked ABI. + +Note that marking an API as experimental is a multi step process. +To mark an API as experimental, the symbols which are desired to be exported +must be placed in an EXPERIMENTAL version block in the corresponding libraries' +version map script. +Secondly, the corresponding prototypes of those exported functions (in the +development header files), must be marked with the ``__rte_experimental`` tag +(see ``rte_compat.h``). +The DPDK build makefiles perform a check to ensure that the map file and the +C code reflect the same list of symbols. +This check can be circumvented by defining ``ALLOW_EXPERIMENTAL_API`` +during compilation in the corresponding library Makefile. + +In addition to tagging the code with ``__rte_experimental``, +the doxygen markup must also contain the EXPERIMENTAL string, +and the MAINTAINERS file should note the EXPERIMENTAL libraries. + +For removing the experimental tag associated with an API, deprecation notice +is not required. Though, an API should remain in experimental state for at least +one release. Thereafter, normal process of posting patch for review to mailing +list can be followed. diff --git a/doc/guides/contributing/abi_versioning.rst b/doc/guides/contributing/abi_versioning.rst new file mode 100644 index 0000000..1c5612c --- /dev/null +++ b/doc/guides/contributing/abi_versioning.rst @@ -0,0 +1,427 @@ +.. SPDX-License-Identifier: BSD-3-Clause + Copyright 2018 The DPDK contributors + +.. library_versioning: + +Library versioning +------------------ + +Downstreams might want to provide different DPDK releases at the same time to +support multiple consumers of DPDK linked against older and newer sonames. + +Also due to the interdependencies that DPDK libraries can have applications +might end up with an executable space in which multiple versions of a library +are mapped by ld.so. + +Think of LibA that got an ABI bump and LibB that did not get an ABI bump but is +depending on LibA. + +.. note:: + + Application + \-> LibA.old + \-> LibB.new -> LibA.new + +That is a conflict which can be avoided by setting ``CONFIG_RTE_MAJOR_ABI``. +If set, the value of ``CONFIG_RTE_MAJOR_ABI`` overwrites all - otherwise per +library - versions defined in the libraries ``LIBABIVER``. +An example might be ``CONFIG_RTE_MAJOR_ABI=16.11`` which will make all libraries +``librte<?>.so.16.11`` instead of ``librte<?>.so.<LIBABIVER>``. + + +ABI versioning +-------------- + +Versioning Macros +~~~~~~~~~~~~~~~~~ + +When a symbol is exported from a library to provide an API, it also provides a +calling convention (ABI) that is embodied in its name, return type and +arguments. Occasionally that function may need to change to accommodate new +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 ``rte_function_versioning.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 +library so that older binaries need not be immediately recompiled. + +The macros exported are: + +* ``VERSION_SYMBOL(b, e, n)``: Creates a symbol version table entry binding + versioned symbol ``b@DPDK_n`` to the internal function ``b_e``. + +* ``BIND_DEFAULT_SYMBOL(b, e, n)``: Creates a symbol version entry instructing + the linker to bind references to symbol ``b`` to the internal symbol + ``b_e``. + +* ``MAP_STATIC_SYMBOL(f, p)``: Declare the prototype ``f``, and map it to the + fully qualified function ``p``, so that if a symbol becomes versioned, it + can still be mapped back to the public symbol name. + +Examples of ABI Macro use +^^^^^^^^^^^^^^^^^^^^^^^^^ + +Updating a public API +_____________________ + +Assume we have a function as follows + +.. code-block:: c + + /* + * Create an acl context object for apps to + * manipulate + */ + struct rte_acl_ctx * + rte_acl_create(const struct rte_acl_param *param) + { + ... + } + + +Assume that struct rte_acl_ctx is a private structure, and that a developer +wishes to enhance the acl api so that a debugging flag can be enabled on a +per-context basis. This requires an addition to the structure (which, being +private, is safe), but it also requires modifying the code as follows + +.. code-block:: c + + /* + * Create an acl context object for apps to + * manipulate + */ + struct rte_acl_ctx * + rte_acl_create(const struct rte_acl_param *param, int debug) + { + ... + } + + +Note also that, being a public function, the header file prototype must also be +changed, as must all the call sites, to reflect the new ABI footprint. We will +maintain previous ABI versions that are accessible only to previously compiled +binaries + +The addition of a parameter to the function is ABI breaking as the function is +public, and existing application may use it in its current form. However, the +compatibility macros in DPDK allow a developer to use symbol versioning so that +multiple functions can be mapped to the same public symbol based on when an +application was linked to it. To see how this is done, we start with the +requisite libraries version map file. Initially the version map file for the +acl library looks like this + +.. code-block:: none + + DPDK_2.0 { + global: + + rte_acl_add_rules; + rte_acl_build; + rte_acl_classify; + rte_acl_classify_alg; + rte_acl_classify_scalar; + rte_acl_create; + rte_acl_dump; + rte_acl_find_existing; + rte_acl_free; + rte_acl_ipv4vlan_add_rules; + rte_acl_ipv4vlan_build; + rte_acl_list_dump; + rte_acl_reset; + rte_acl_reset_rules; + rte_acl_set_ctx_classify; + + local: *; + }; + +This file needs to be modified as follows + +.. code-block:: none + + DPDK_2.0 { + global: + + rte_acl_add_rules; + rte_acl_build; + rte_acl_classify; + rte_acl_classify_alg; + rte_acl_classify_scalar; + rte_acl_create; + rte_acl_dump; + rte_acl_find_existing; + rte_acl_free; + rte_acl_ipv4vlan_add_rules; + rte_acl_ipv4vlan_build; + rte_acl_list_dump; + rte_acl_reset; + rte_acl_reset_rules; + rte_acl_set_ctx_classify; + + local: *; + }; + + DPDK_2.1 { + global: + rte_acl_create; + + } DPDK_2.0; + +The addition of the new block tells the linker that a new version node is +available (DPDK_2.1), which contains the symbol rte_acl_create, and inherits the +symbols from the DPDK_2.0 node. This list is directly translated into a list of +exported symbols when DPDK is compiled as a shared library + +Next, we need to specify in the code which function map to the rte_acl_create +symbol at which versions. First, at the site of the initial symbol definition, +we need to update the function so that it is uniquely named, and not in conflict +with the public symbol name + +.. code-block:: c + + struct rte_acl_ctx * + -rte_acl_create(const struct rte_acl_param *param) + +rte_acl_create_v20(const struct rte_acl_param *param) + { + size_t sz; + struct rte_acl_ctx *ctx; + ... + +Note that the base name of the symbol was kept intact, as this is conducive to +the macros used for versioning symbols. That is our next step, mapping this new +symbol name to the initial symbol name at version node 2.0. Immediately after +the function, we add this line of code + +.. code-block:: c + + VERSION_SYMBOL(rte_acl_create, _v20, 2.0); + +Remembering to also add the rte_function_versioning.h header to the requisite c file where +these changes are being made. The above macro instructs the linker to create a +new symbol ``rte_acl_create@DPDK_2.0``, which matches the symbol created in older +builds, but now points to the above newly named function. We have now mapped +the original rte_acl_create symbol to the original function (but with a new +name) + +Next, we need to create the 2.1 version of the symbol. We create a new function +name, with a different suffix, and implement it appropriately + +.. code-block:: c + + struct rte_acl_ctx * + rte_acl_create_v21(const struct rte_acl_param *param, int debug); + { + struct rte_acl_ctx *ctx = rte_acl_create_v20(param); + + ctx->debug = debug; + + return ctx; + } + +This code serves as our new API call. Its the same as our old call, but adds +the new parameter in place. Next we need to map this function to the symbol +``rte_acl_create@DPDK_2.1``. To do this, we modify the public prototype of the call +in the header file, adding the macro there to inform all including applications, +that on re-link, the default rte_acl_create symbol should point to this +function. Note that we could do this by simply naming the function above +rte_acl_create, and the linker would chose the most recent version tag to apply +in the version script, but we can also do this in the header file + +.. code-block:: c + + struct rte_acl_ctx * + -rte_acl_create(const struct rte_acl_param *param); + +rte_acl_create(const struct rte_acl_param *param, int debug); + +BIND_DEFAULT_SYMBOL(rte_acl_create, _v21, 2.1); + +The BIND_DEFAULT_SYMBOL macro explicitly tells applications that include this +header, to link to the rte_acl_create_v21 function and apply the DPDK_2.1 +version node to it. This method is more explicit and flexible than just +re-implementing the exact symbol name, and allows for other features (such as +linking to the old symbol version by default, when the new ABI is to be opt-in +for a period. + +One last thing we need to do. Note that we've taken what was a public symbol, +and duplicated it into two uniquely and differently named symbols. We've then +mapped each of those back to the public symbol ``rte_acl_create`` with different +version tags. This only applies to dynamic linking, as static linking has no +notion of versioning. That leaves this code in a position of no longer having a +symbol simply named ``rte_acl_create`` and a static build will fail on that +missing symbol. + +To correct this, we can simply map a function of our choosing back to the public +symbol in the static build with the ``MAP_STATIC_SYMBOL`` macro. Generally the +assumption is that the most recent version of the symbol is the one you want to +map. So, back in the C file where, immediately after ``rte_acl_create_v21`` is +defined, we add this + +.. code-block:: c + + struct rte_acl_ctx * + rte_acl_create_v21(const struct rte_acl_param *param, int debug) + { + ... + } + MAP_STATIC_SYMBOL(struct rte_acl_ctx *rte_acl_create(const struct rte_acl_param *param, int debug), rte_acl_create_v21); + +That tells the compiler that, when building a static library, any calls to the +symbol ``rte_acl_create`` should be linked to ``rte_acl_create_v21`` + +That's it, on the next shared library rebuild, there will be two versions of +rte_acl_create, an old DPDK_2.0 version, used by previously built applications, +and a new DPDK_2.1 version, used by future built applications. + + +Deprecating part of a public API +________________________________ + +Lets assume that you've done the above update, and after a few releases have +passed you decide you would like to retire the old version of the function. +After having gone through the ABI deprecation announcement process, removal is +easy. Start by removing the symbol from the requisite version map file: + +.. code-block:: none + + DPDK_2.0 { + global: + + rte_acl_add_rules; + rte_acl_build; + rte_acl_classify; + rte_acl_classify_alg; + rte_acl_classify_scalar; + rte_acl_dump; + - rte_acl_create + rte_acl_find_existing; + rte_acl_free; + rte_acl_ipv4vlan_add_rules; + rte_acl_ipv4vlan_build; + rte_acl_list_dump; + rte_acl_reset; + rte_acl_reset_rules; + rte_acl_set_ctx_classify; + + local: *; + }; + + DPDK_2.1 { + global: + rte_acl_create; + } DPDK_2.0; + + +Next remove the corresponding versioned export. + +.. code-block:: c + + -VERSION_SYMBOL(rte_acl_create, _v20, 2.0); + + +Note that the internal function definition could also be removed, but its used +in our example by the newer version _v21, so we leave it in place. This is a +coding style choice. + +Lastly, we need to bump the LIBABIVER number for this library in the Makefile to +indicate to applications doing dynamic linking that this is a later, and +possibly incompatible library version: + +.. code-block:: c + + -LIBABIVER := 1 + +LIBABIVER := 2 + +Deprecating an entire ABI version +_________________________________ + +While removing a symbol from and ABI may be useful, it is often more practical +to remove an entire version node at once. If a version node completely +specifies an API, then removing part of it, typically makes it incomplete. In +those cases it is better to remove the entire node + +To do this, start by modifying the version map file, such that all symbols from +the node to be removed are merged into the next node in the map + +In the case of our map above, it would transform to look as follows + +.. code-block:: none + + DPDK_2.1 { + global: + + rte_acl_add_rules; + rte_acl_build; + rte_acl_classify; + rte_acl_classify_alg; + rte_acl_classify_scalar; + rte_acl_dump; + rte_acl_create + rte_acl_find_existing; + rte_acl_free; + rte_acl_ipv4vlan_add_rules; + rte_acl_ipv4vlan_build; + rte_acl_list_dump; + rte_acl_reset; + rte_acl_reset_rules; + rte_acl_set_ctx_classify; + + local: *; + }; + +Then any uses of BIND_DEFAULT_SYMBOL that pointed to the old node should be +updated to point to the new version node in any header files for all affected +symbols. + +.. code-block:: c + + -BIND_DEFAULT_SYMBOL(rte_acl_create, _v20, 2.0); + +BIND_DEFAULT_SYMBOL(rte_acl_create, _v21, 2.1); + +Lastly, any VERSION_SYMBOL macros that point to the old version node should be +removed, taking care to keep, where need old code in place to support newer +versions of the symbol. + + +Running the ABI Validator +------------------------- + +The ``devtools`` directory in the DPDK source tree contains a utility program, +``validate-abi.sh``, for validating the DPDK ABI based on the Linux `ABI +Compliance Checker +<http://ispras.linuxbase.org/index.php/ABI_compliance_checker>`_. + +This has a dependency on the ``abi-compliance-checker`` and ``and abi-dumper`` +utilities which can be installed via a package manager. For example:: + + sudo yum install abi-compliance-checker + sudo yum install abi-dumper + +The syntax of the ``validate-abi.sh`` utility is:: + + ./devtools/validate-abi.sh <REV1> <REV2> + +Where ``REV1`` and ``REV2`` are valid gitrevisions(7) +https://www.kernel.org/pub/software/scm/git/docs/gitrevisions.html +on the local repo. + +For example:: + + # Check between the previous and latest commit: + ./devtools/validate-abi.sh HEAD~1 HEAD + + # Check on a specific compilation target: + ./devtools/validate-abi.sh -t x86_64-native-linux-gcc HEAD~1 HEAD + + # Check between two tags: + ./devtools/validate-abi.sh v2.0.0 v2.1.0 + + # Check between git master and local topic-branch "vhost-hacking": + ./devtools/validate-abi.sh master vhost-hacking + +After the validation script completes (it can take a while since it need to +compile both tags) it will create compatibility reports in the +``./abi-check/compat_report`` directory. Listed incompatibilities can be found +as follows:: + + grep -lr Incompatible abi-check/compat_reports/ diff --git a/doc/guides/contributing/index.rst b/doc/guides/contributing/index.rst index e2608d3..2fefd91 100644 --- a/doc/guides/contributing/index.rst +++ b/doc/guides/contributing/index.rst @@ -10,7 +10,8 @@ Contributor's Guidelines coding_style design - versioning + abi_policy + abi_versioning documentation patches vulnerability diff --git a/doc/guides/contributing/patches.rst b/doc/guides/contributing/patches.rst index 9e1013b..c9ec529 100644 --- a/doc/guides/contributing/patches.rst +++ b/doc/guides/contributing/patches.rst @@ -157,7 +157,7 @@ Make your planned changes in the cloned ``dpdk`` repo. Here are some guidelines * For other PMDs and more info, refer to the ``MAINTAINERS`` file. * New external functions should be added to the local ``version.map`` file. - See the :doc:`Guidelines for ABI policy and versioning </contributing/versioning>`. + See the :doc:`Guidelines for ABI policy and versioning </contributing/abi_versioning>`. New external functions should also be added in alphabetical order. * Important changes will require an addition to the release notes in ``doc/guides/rel_notes/``. diff --git a/doc/guides/contributing/versioning.rst b/doc/guides/contributing/versioning.rst deleted file mode 100644 index 64984c5..0000000 --- a/doc/guides/contributing/versioning.rst +++ /dev/null @@ -1,591 +0,0 @@ -.. SPDX-License-Identifier: BSD-3-Clause - Copyright 2018 The DPDK contributors - -DPDK ABI/API policy -=================== - -Description ------------ - -This document details some methods for handling ABI management in the DPDK. - -General Guidelines ------------------- - -#. Whenever possible, ABI should be preserved -#. ABI/API may be changed with a deprecation process -#. The modification of symbols can generally be managed with versioning -#. Libraries or APIs marked in ``experimental`` state may change without constraint -#. New APIs will be marked as ``experimental`` for at least one release to allow - any issues found by users of the new API to be fixed quickly -#. The addition of symbols is generally not problematic -#. The removal of symbols generally is an ABI break and requires bumping of the - LIBABIVER macro -#. Updates to the minimum hardware requirements, which drop support for hardware which - was previously supported, should be treated as an ABI change. - -What is an ABI -~~~~~~~~~~~~~~ - -An ABI (Application Binary Interface) is the set of runtime interfaces exposed -by a library. It is similar to an API (Application Programming Interface) but -is the result of compilation. It is also effectively cloned when applications -link to dynamic libraries. That is to say when an application is compiled to -link against dynamic libraries, it is assumed that the ABI remains constant -between the time the application is compiled/linked, and the time that it runs. -Therefore, in the case of dynamic linking, it is critical that an ABI is -preserved, or (when modified), done in such a way that the application is unable -to behave improperly or in an unexpected fashion. - - -ABI/API Deprecation -------------------- - -The DPDK ABI policy -~~~~~~~~~~~~~~~~~~~ - -ABI versions are set at the time of major release labeling, and the ABI may -change multiple times, without warning, between the last release label and the -HEAD label of the git tree. - -ABI versions, once released, are available until such time as their -deprecation has been noted in the Release Notes for at least one major release -cycle. For example consider the case where the ABI for DPDK 2.0 has been -shipped and then a decision is made to modify it during the development of -DPDK 2.1. The decision will be recorded in the Release Notes for the DPDK 2.1 -release and the modification will be made available in the DPDK 2.2 release. - -ABI versions may be deprecated in whole or in part as needed by a given -update. - -Some ABI changes may be too significant to reasonably maintain multiple -versions. In those cases ABI's may be updated without backward compatibility -being provided. The requirements for doing so are: - -#. At least 3 acknowledgments of the need to do so must be made on the - dpdk.org mailing list. - - - The acknowledgment of the maintainer of the component is mandatory, or if - no maintainer is available for the component, the tree/sub-tree maintainer - for that component must acknowledge the ABI change instead. - - - It is also recommended that acknowledgments from different "areas of - interest" be sought for each deprecation, for example: from NIC vendors, - CPU vendors, end-users, etc. - -#. The changes (including an alternative map file) can be included with - deprecation notice, in wrapped way by the ``RTE_NEXT_ABI`` option, - to provide more details about oncoming changes. - ``RTE_NEXT_ABI`` wrapper will be removed when it become the default ABI. - More preferred way to provide this information is sending the feature - as a separate patch and reference it in deprecation notice. - -#. A full deprecation cycle, as explained above, must be made to offer - downstream consumers sufficient warning of the change. - -Note that the above process for ABI deprecation should not be undertaken -lightly. ABI stability is extremely important for downstream consumers of the -DPDK, especially when distributed in shared object form. Every effort should -be made to preserve the ABI whenever possible. The ABI should only be changed -for significant reasons, such as performance enhancements. ABI breakage due to -changes such as reorganizing public structure fields for aesthetic or -readability purposes should be avoided. - -.. note:: - - Updates to the minimum hardware requirements, which drop support for hardware - which was previously supported, should be treated as an ABI change, and - follow the relevant deprecation policy procedures as above: 3 acks and - announcement at least one release in advance. - -Examples of Deprecation Notices -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -The following are some examples of ABI deprecation notices which would be -added to the Release Notes: - -* The Macro ``#RTE_FOO`` is deprecated and will be removed with version 2.0, - to be replaced with the inline function ``rte_foo()``. - -* The function ``rte_mbuf_grok()`` has been updated to include a new parameter - in version 2.0. Backwards compatibility will be maintained for this function - until the release of version 2.1 - -* The members of ``struct rte_foo`` have been reorganized in release 2.0 for - performance reasons. Existing binary applications will have backwards - compatibility in release 2.0, while newly built binaries will need to - reference the new structure variant ``struct rte_foo2``. Compatibility will - be removed in release 2.2, and all applications will require updating and - rebuilding to the new structure at that time, which will be renamed to the - original ``struct rte_foo``. - -* Significant ABI changes are planned for the ``librte_dostuff`` library. The - upcoming release 2.0 will not contain these changes, but release 2.1 will, - and no backwards compatibility is planned due to the extensive nature of - these changes. Binaries using this library built prior to version 2.1 will - require updating and recompilation. - -New API replacing previous one -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -If a new API proposed functionally replaces an existing one, when the new API -becomes non-experimental then the old one is marked with ``__rte_deprecated``. -Deprecated APIs are removed completely just after the next LTS. - -Reminder that old API should follow deprecation process to be removed. - - -Experimental APIs ------------------ - -APIs marked as ``experimental`` are not considered part of the ABI and may -change without warning at any time. Since changes to APIs are most likely -immediately after their introduction, as users begin to take advantage of -those new APIs and start finding issues with them, new DPDK APIs will be -automatically marked as ``experimental`` to allow for a period of stabilization -before they become part of a tracked ABI. - -Note that marking an API as experimental is a multi step process. -To mark an API as experimental, the symbols which are desired to be exported -must be placed in an EXPERIMENTAL version block in the corresponding libraries' -version map script. -Secondly, the corresponding prototypes of those exported functions (in the -development header files), must be marked with the ``__rte_experimental`` tag -(see ``rte_compat.h``). -The DPDK build makefiles perform a check to ensure that the map file and the -C code reflect the same list of symbols. -This check can be circumvented by defining ``ALLOW_EXPERIMENTAL_API`` -during compilation in the corresponding library Makefile. - -In addition to tagging the code with ``__rte_experimental``, -the doxygen markup must also contain the EXPERIMENTAL string, -and the MAINTAINERS file should note the EXPERIMENTAL libraries. - -For removing the experimental tag associated with an API, deprecation notice -is not required. Though, an API should remain in experimental state for at least -one release. Thereafter, normal process of posting patch for review to mailing -list can be followed. - - -Library versioning ------------------- - -Downstreams might want to provide different DPDK releases at the same time to -support multiple consumers of DPDK linked against older and newer sonames. - -Also due to the interdependencies that DPDK libraries can have applications -might end up with an executable space in which multiple versions of a library -are mapped by ld.so. - -Think of LibA that got an ABI bump and LibB that did not get an ABI bump but is -depending on LibA. - -.. note:: - - Application - \-> LibA.old - \-> LibB.new -> LibA.new - -That is a conflict which can be avoided by setting ``CONFIG_RTE_MAJOR_ABI``. -If set, the value of ``CONFIG_RTE_MAJOR_ABI`` overwrites all - otherwise per -library - versions defined in the libraries ``LIBABIVER``. -An example might be ``CONFIG_RTE_MAJOR_ABI=16.11`` which will make all libraries -``librte<?>.so.16.11`` instead of ``librte<?>.so.<LIBABIVER>``. - - -ABI versioning --------------- - -Versioning Macros -~~~~~~~~~~~~~~~~~ - -When a symbol is exported from a library to provide an API, it also provides a -calling convention (ABI) that is embodied in its name, return type and -arguments. Occasionally that function may need to change to accommodate new -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 ``rte_function_versioning.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 -library so that older binaries need not be immediately recompiled. - -The macros exported are: - -* ``VERSION_SYMBOL(b, e, n)``: Creates a symbol version table entry binding - versioned symbol ``b@DPDK_n`` to the internal function ``b_e``. - -* ``BIND_DEFAULT_SYMBOL(b, e, n)``: Creates a symbol version entry instructing - the linker to bind references to symbol ``b`` to the internal symbol - ``b_e``. - -* ``MAP_STATIC_SYMBOL(f, p)``: Declare the prototype ``f``, and map it to the - fully qualified function ``p``, so that if a symbol becomes versioned, it - can still be mapped back to the public symbol name. - -Examples of ABI Macro use -^^^^^^^^^^^^^^^^^^^^^^^^^ - -Updating a public API -_____________________ - -Assume we have a function as follows - -.. code-block:: c - - /* - * Create an acl context object for apps to - * manipulate - */ - struct rte_acl_ctx * - rte_acl_create(const struct rte_acl_param *param) - { - ... - } - - -Assume that struct rte_acl_ctx is a private structure, and that a developer -wishes to enhance the acl api so that a debugging flag can be enabled on a -per-context basis. This requires an addition to the structure (which, being -private, is safe), but it also requires modifying the code as follows - -.. code-block:: c - - /* - * Create an acl context object for apps to - * manipulate - */ - struct rte_acl_ctx * - rte_acl_create(const struct rte_acl_param *param, int debug) - { - ... - } - - -Note also that, being a public function, the header file prototype must also be -changed, as must all the call sites, to reflect the new ABI footprint. We will -maintain previous ABI versions that are accessible only to previously compiled -binaries - -The addition of a parameter to the function is ABI breaking as the function is -public, and existing application may use it in its current form. However, the -compatibility macros in DPDK allow a developer to use symbol versioning so that -multiple functions can be mapped to the same public symbol based on when an -application was linked to it. To see how this is done, we start with the -requisite libraries version map file. Initially the version map file for the -acl library looks like this - -.. code-block:: none - - DPDK_2.0 { - global: - - rte_acl_add_rules; - rte_acl_build; - rte_acl_classify; - rte_acl_classify_alg; - rte_acl_classify_scalar; - rte_acl_create; - rte_acl_dump; - rte_acl_find_existing; - rte_acl_free; - rte_acl_ipv4vlan_add_rules; - rte_acl_ipv4vlan_build; - rte_acl_list_dump; - rte_acl_reset; - rte_acl_reset_rules; - rte_acl_set_ctx_classify; - - local: *; - }; - -This file needs to be modified as follows - -.. code-block:: none - - DPDK_2.0 { - global: - - rte_acl_add_rules; - rte_acl_build; - rte_acl_classify; - rte_acl_classify_alg; - rte_acl_classify_scalar; - rte_acl_create; - rte_acl_dump; - rte_acl_find_existing; - rte_acl_free; - rte_acl_ipv4vlan_add_rules; - rte_acl_ipv4vlan_build; - rte_acl_list_dump; - rte_acl_reset; - rte_acl_reset_rules; - rte_acl_set_ctx_classify; - - local: *; - }; - - DPDK_2.1 { - global: - rte_acl_create; - - } DPDK_2.0; - -The addition of the new block tells the linker that a new version node is -available (DPDK_2.1), which contains the symbol rte_acl_create, and inherits the -symbols from the DPDK_2.0 node. This list is directly translated into a list of -exported symbols when DPDK is compiled as a shared library - -Next, we need to specify in the code which function map to the rte_acl_create -symbol at which versions. First, at the site of the initial symbol definition, -we need to update the function so that it is uniquely named, and not in conflict -with the public symbol name - -.. code-block:: c - - struct rte_acl_ctx * - -rte_acl_create(const struct rte_acl_param *param) - +rte_acl_create_v20(const struct rte_acl_param *param) - { - size_t sz; - struct rte_acl_ctx *ctx; - ... - -Note that the base name of the symbol was kept intact, as this is conducive to -the macros used for versioning symbols. That is our next step, mapping this new -symbol name to the initial symbol name at version node 2.0. Immediately after -the function, we add this line of code - -.. code-block:: c - - VERSION_SYMBOL(rte_acl_create, _v20, 2.0); - -Remembering to also add the rte_function_versioning.h header to the requisite c file where -these changes are being made. The above macro instructs the linker to create a -new symbol ``rte_acl_create@DPDK_2.0``, which matches the symbol created in older -builds, but now points to the above newly named function. We have now mapped -the original rte_acl_create symbol to the original function (but with a new -name) - -Next, we need to create the 2.1 version of the symbol. We create a new function -name, with a different suffix, and implement it appropriately - -.. code-block:: c - - struct rte_acl_ctx * - rte_acl_create_v21(const struct rte_acl_param *param, int debug); - { - struct rte_acl_ctx *ctx = rte_acl_create_v20(param); - - ctx->debug = debug; - - return ctx; - } - -This code serves as our new API call. Its the same as our old call, but adds -the new parameter in place. Next we need to map this function to the symbol -``rte_acl_create@DPDK_2.1``. To do this, we modify the public prototype of the call -in the header file, adding the macro there to inform all including applications, -that on re-link, the default rte_acl_create symbol should point to this -function. Note that we could do this by simply naming the function above -rte_acl_create, and the linker would chose the most recent version tag to apply -in the version script, but we can also do this in the header file - -.. code-block:: c - - struct rte_acl_ctx * - -rte_acl_create(const struct rte_acl_param *param); - +rte_acl_create(const struct rte_acl_param *param, int debug); - +BIND_DEFAULT_SYMBOL(rte_acl_create, _v21, 2.1); - -The BIND_DEFAULT_SYMBOL macro explicitly tells applications that include this -header, to link to the rte_acl_create_v21 function and apply the DPDK_2.1 -version node to it. This method is more explicit and flexible than just -re-implementing the exact symbol name, and allows for other features (such as -linking to the old symbol version by default, when the new ABI is to be opt-in -for a period. - -One last thing we need to do. Note that we've taken what was a public symbol, -and duplicated it into two uniquely and differently named symbols. We've then -mapped each of those back to the public symbol ``rte_acl_create`` with different -version tags. This only applies to dynamic linking, as static linking has no -notion of versioning. That leaves this code in a position of no longer having a -symbol simply named ``rte_acl_create`` and a static build will fail on that -missing symbol. - -To correct this, we can simply map a function of our choosing back to the public -symbol in the static build with the ``MAP_STATIC_SYMBOL`` macro. Generally the -assumption is that the most recent version of the symbol is the one you want to -map. So, back in the C file where, immediately after ``rte_acl_create_v21`` is -defined, we add this - -.. code-block:: c - - struct rte_acl_ctx * - rte_acl_create_v21(const struct rte_acl_param *param, int debug) - { - ... - } - MAP_STATIC_SYMBOL(struct rte_acl_ctx *rte_acl_create(const struct rte_acl_param *param, int debug), rte_acl_create_v21); - -That tells the compiler that, when building a static library, any calls to the -symbol ``rte_acl_create`` should be linked to ``rte_acl_create_v21`` - -That's it, on the next shared library rebuild, there will be two versions of -rte_acl_create, an old DPDK_2.0 version, used by previously built applications, -and a new DPDK_2.1 version, used by future built applications. - - -Deprecating part of a public API -________________________________ - -Lets assume that you've done the above update, and after a few releases have -passed you decide you would like to retire the old version of the function. -After having gone through the ABI deprecation announcement process, removal is -easy. Start by removing the symbol from the requisite version map file: - -.. code-block:: none - - DPDK_2.0 { - global: - - rte_acl_add_rules; - rte_acl_build; - rte_acl_classify; - rte_acl_classify_alg; - rte_acl_classify_scalar; - rte_acl_dump; - - rte_acl_create - rte_acl_find_existing; - rte_acl_free; - rte_acl_ipv4vlan_add_rules; - rte_acl_ipv4vlan_build; - rte_acl_list_dump; - rte_acl_reset; - rte_acl_reset_rules; - rte_acl_set_ctx_classify; - - local: *; - }; - - DPDK_2.1 { - global: - rte_acl_create; - } DPDK_2.0; - - -Next remove the corresponding versioned export. - -.. code-block:: c - - -VERSION_SYMBOL(rte_acl_create, _v20, 2.0); - - -Note that the internal function definition could also be removed, but its used -in our example by the newer version _v21, so we leave it in place. This is a -coding style choice. - -Lastly, we need to bump the LIBABIVER number for this library in the Makefile to -indicate to applications doing dynamic linking that this is a later, and -possibly incompatible library version: - -.. code-block:: c - - -LIBABIVER := 1 - +LIBABIVER := 2 - -Deprecating an entire ABI version -_________________________________ - -While removing a symbol from and ABI may be useful, it is often more practical -to remove an entire version node at once. If a version node completely -specifies an API, then removing part of it, typically makes it incomplete. In -those cases it is better to remove the entire node - -To do this, start by modifying the version map file, such that all symbols from -the node to be removed are merged into the next node in the map - -In the case of our map above, it would transform to look as follows - -.. code-block:: none - - DPDK_2.1 { - global: - - rte_acl_add_rules; - rte_acl_build; - rte_acl_classify; - rte_acl_classify_alg; - rte_acl_classify_scalar; - rte_acl_dump; - rte_acl_create - rte_acl_find_existing; - rte_acl_free; - rte_acl_ipv4vlan_add_rules; - rte_acl_ipv4vlan_build; - rte_acl_list_dump; - rte_acl_reset; - rte_acl_reset_rules; - rte_acl_set_ctx_classify; - - local: *; - }; - -Then any uses of BIND_DEFAULT_SYMBOL that pointed to the old node should be -updated to point to the new version node in any header files for all affected -symbols. - -.. code-block:: c - - -BIND_DEFAULT_SYMBOL(rte_acl_create, _v20, 2.0); - +BIND_DEFAULT_SYMBOL(rte_acl_create, _v21, 2.1); - -Lastly, any VERSION_SYMBOL macros that point to the old version node should be -removed, taking care to keep, where need old code in place to support newer -versions of the symbol. - - -Running the ABI Validator -------------------------- - -The ``devtools`` directory in the DPDK source tree contains a utility program, -``validate-abi.sh``, for validating the DPDK ABI based on the Linux `ABI -Compliance Checker -<http://ispras.linuxbase.org/index.php/ABI_compliance_checker>`_. - -This has a dependency on the ``abi-compliance-checker`` and ``and abi-dumper`` -utilities which can be installed via a package manager. For example:: - - sudo yum install abi-compliance-checker - sudo yum install abi-dumper - -The syntax of the ``validate-abi.sh`` utility is:: - - ./devtools/validate-abi.sh <REV1> <REV2> - -Where ``REV1`` and ``REV2`` are valid gitrevisions(7) -https://www.kernel.org/pub/software/scm/git/docs/gitrevisions.html -on the local repo. - -For example:: - - # Check between the previous and latest commit: - ./devtools/validate-abi.sh HEAD~1 HEAD - - # Check on a specific compilation target: - ./devtools/validate-abi.sh -t x86_64-native-linux-gcc HEAD~1 HEAD - - # Check between two tags: - ./devtools/validate-abi.sh v2.0.0 v2.1.0 - - # Check between git master and local topic-branch "vhost-hacking": - ./devtools/validate-abi.sh master vhost-hacking - -After the validation script completes (it can take a while since it need to -compile both tags) it will create compatibility reports in the -``./abi-check/compat_report`` directory. Listed incompatibilities can be found -as follows:: - - grep -lr Incompatible abi-check/compat_reports/ diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst index 4249aab..cf37d80 100644 --- a/doc/guides/rel_notes/deprecation.rst +++ b/doc/guides/rel_notes/deprecation.rst @@ -4,7 +4,7 @@ ABI and API Deprecation ======================= -See the :doc:`guidelines document for details of the ABI policy </contributing/versioning>`. +See the :doc:`guidelines document for details of the ABI policy </contributing/abi_versioning>`. API and ABI deprecation notices are to be posted here. -- 2.7.4 ^ permalink raw reply [flat|nested] 20+ messages in thread
* [dpdk-dev] [PATCH v10 2/3] doc: changes to abi policy introducing major abi versions 2019-11-11 10:37 ` [dpdk-dev] [PATCH v10 0/3] doc: changes to abi policy introducing major abi versions Ray Kinsella 2019-11-11 10:37 ` [dpdk-dev] [PATCH v10 1/3] doc: separate versioning.rst into version and policy Ray Kinsella @ 2019-11-11 10:37 ` Ray Kinsella 2019-11-11 10:37 ` [dpdk-dev] [PATCH v10 3/3] doc: updates to versioning guide for " Ray Kinsella 2 siblings, 0 replies; 20+ messages in thread From: Ray Kinsella @ 2019-11-11 10:37 UTC (permalink / raw) To: dev Cc: mdr, thomas, stephen, bruce.richardson, ferruh.yigit, konstantin.ananyev, jerinj, olivier.matz, nhorman, maxime.coquelin, john.mcnamara, marko.kovacevic, hemant.agrawal, ktraynor, aconole This policy change introduces major ABI versions, these are declared every year, typically aligned with the LTS release and are supported by subsequent releases in the following year. This change is intended to improve ABI stabilty for those projects consuming DPDK. Signed-off-by: Ray Kinsella <mdr@ashroe.eu> Acked-by: John Mcnamara <john.mcnamara@intel.com> Acked-by: Stephen Hemminger <stephen@networkplumber.org> Acked-by: Thomas Monjalon <thomas@monjalon.net> --- doc/guides/contributing/abi_policy.rst | 325 ++++-- .../contributing/img/abi_stability_policy.svg | 1059 ++++++++++++++++++++ doc/guides/contributing/img/what_is_an_abi.svg | 382 +++++++ doc/guides/contributing/stable.rst | 12 +- 4 files changed, 1687 insertions(+), 91 deletions(-) create mode 100644 doc/guides/contributing/img/abi_stability_policy.svg create mode 100644 doc/guides/contributing/img/what_is_an_abi.svg diff --git a/doc/guides/contributing/abi_policy.rst b/doc/guides/contributing/abi_policy.rst index d4f4e9f..81b617c 100644 --- a/doc/guides/contributing/abi_policy.rst +++ b/doc/guides/contributing/abi_policy.rst @@ -1,31 +1,48 @@ .. SPDX-License-Identifier: BSD-3-Clause - Copyright 2018 The DPDK contributors + Copyright 2019 The DPDK contributors -DPDK ABI/API policy -=================== +ABI Policy +========== Description ----------- -This document details some methods for handling ABI management in the DPDK. +This document details the management policy that ensures the long-term stability +of the DPDK ABI and API. General Guidelines ------------------ -#. Whenever possible, ABI should be preserved -#. ABI/API may be changed with a deprecation process -#. The modification of symbols can generally be managed with versioning -#. Libraries or APIs marked in ``experimental`` state may change without constraint -#. New APIs will be marked as ``experimental`` for at least one release to allow - any issues found by users of the new API to be fixed quickly -#. The addition of symbols is generally not problematic -#. The removal of symbols generally is an ABI break and requires bumping of the - LIBABIVER macro -#. Updates to the minimum hardware requirements, which drop support for hardware which - was previously supported, should be treated as an ABI change. - -What is an ABI -~~~~~~~~~~~~~~ +#. Major ABI versions are declared no more frequently than yearly. Compatibility + with the major ABI version is mandatory in subsequent releases until a new + major ABI version is declared. +#. Major ABI versions are usually but not always declared aligned with a + :ref:`LTS release <stable_lts_releases>`. +#. The ABI version is managed at a project level in DPDK, and is reflected in + all non-experimental library's soname. +#. The ABI should be preserved and not changed lightly. ABI changes must follow + the outlined :ref:`deprecation process <abi_changes>`. +#. The addition of symbols is generally not problematic. The modification of + symbols is managed with ABI Versioning. +#. The removal of symbols is considered an :ref:`ABI breakage <abi_breakages>`, + once approved these will form part of the next ABI version. +#. Libraries or APIs marked as :ref:`experimental <experimental_apis>` may + change without constraint, as they are not considered part of an ABI version. + Experimental libraries have the major ABI version ``0``. +#. Updates to the :ref:`minimum hardware requirements <hw_rqmts>`, which drop + support for hardware which was previously supported, should be treated as an + ABI change. + +.. note:: + + In 2019, the DPDK community stated its intention to move to ABI stable + releases, over a number of release cycles. This change begins with + maintaining ABI stability through one year of DPDK releases starting from + DPDK 19.11. This policy will be reviewed in 2020, with intention of + lengthening the stability period. + +What is an ABI? +~~~~~~~~~~~~~~~ An ABI (Application Binary Interface) is the set of runtime interfaces exposed by a library. It is similar to an API (Application Programming Interface) but @@ -37,30 +54,82 @@ Therefore, in the case of dynamic linking, it is critical that an ABI is preserved, or (when modified), done in such a way that the application is unable to behave improperly or in an unexpected fashion. +.. _figure_what_is_an_abi: + +.. figure:: img/what_is_an_abi.* + + Illustration of DPDK API and ABI. -ABI/API Deprecation -------------------- + +What is an ABI version? +~~~~~~~~~~~~~~~~~~~~~~~ + +An ABI version is an instance of a library's ABI at a specific release. Certain +releases are considered to be milestone releases, the yearly LTS release for +example. The ABI of a milestone release may be declared as a 'major ABI +version', where this ABI version is then supported for some number of subsequent +releases and is annotated in the library's soname. + +ABI version support in subsequent releases facilitates application upgrades, by +enabling applications built against the milestone release to upgrade to +subsequent releases of a library without a rebuild. + +More details on major ABI version can be found in the ABI Versioning guide. The DPDK ABI policy -~~~~~~~~~~~~~~~~~~~ +------------------- + +A new major ABI version is declared no more frequently than yearly, with +declarations usually aligning with a LTS release, e.g. ABI 20 for DPDK 19.11. +Compatibility with the major ABI version is then mandatory in subsequent +releases until the next major ABI version is declared, e.g. ABI 21 for DPDK +20.11. -ABI versions are set at the time of major release labeling, and the ABI may -change multiple times, without warning, between the last release label and the -HEAD label of the git tree. +At the declaration of a major ABI version, major version numbers encoded in +libraries' sonames are bumped to indicate the new version, with the minor +version reset to ``0``. An example would be ``librte_eal.so.20.3`` would become +``librte_eal.so.21.0``. -ABI versions, once released, are available until such time as their -deprecation has been noted in the Release Notes for at least one major release -cycle. For example consider the case where the ABI for DPDK 2.0 has been -shipped and then a decision is made to modify it during the development of -DPDK 2.1. The decision will be recorded in the Release Notes for the DPDK 2.1 -release and the modification will be made available in the DPDK 2.2 release. +The ABI may then change multiple times, without warning, between the last major +ABI version increment and the HEAD label of the git tree, with the condition +that ABI compatibility with the major ABI version is preserved and therefore +sonames do not change. -ABI versions may be deprecated in whole or in part as needed by a given -update. +Minor versions are incremented to indicate the release of a new ABI compatible +DPDK release, typically the DPDK quarterly releases. An example of this, might +be that ``librte_eal.so.20.1`` would indicate the first ABI compatible DPDK +release, following the declaration of the new major ABI version ``20``. -Some ABI changes may be too significant to reasonably maintain multiple -versions. In those cases ABI's may be updated without backward compatibility -being provided. The requirements for doing so are: +An ABI version is supported in all new releases until the next major ABI version +is declared. When changing the major ABI version, the release notes will detail +all ABI changes. + +.. _figure_abi_stability_policy: + +.. figure:: img/abi_stability_policy.* + + Mapping of new ABI versions and ABI version compatibility to DPDK + releases. + +.. _abi_changes: + +ABI Changes +~~~~~~~~~~~ + +The ABI may still change after the declaration of a major ABI version, that is +new APIs may be still added or existing APIs may be modified. + +.. Warning:: + + Note that, this policy details the method by which the ABI may be changed, + with due regard to preserving compatibility and observing deprecation + notices. This process however should not be undertaken lightly, as a general + rule ABI stability is extremely important for downstream consumers of DPDK. + The API should only be changed for significant reasons, such as performance + enhancements. API breakages due to changes such as reorganizing public + structure fields for aesthetic or readability purposes should be avoided. + +The requirements for changing the ABI are: #. At least 3 acknowledgments of the need to do so must be made on the dpdk.org mailing list. @@ -69,34 +138,119 @@ being provided. The requirements for doing so are: no maintainer is available for the component, the tree/sub-tree maintainer for that component must acknowledge the ABI change instead. + - The acknowledgment of three members of the technical board, as delegates + of the `technical board <https://core.dpdk.org/techboard/>`_ acknowledging + the need for the ABI change, is also mandatory. + - It is also recommended that acknowledgments from different "areas of interest" be sought for each deprecation, for example: from NIC vendors, CPU vendors, end-users, etc. -#. The changes (including an alternative map file) can be included with - deprecation notice, in wrapped way by the ``RTE_NEXT_ABI`` option, - to provide more details about oncoming changes. - ``RTE_NEXT_ABI`` wrapper will be removed when it become the default ABI. - More preferred way to provide this information is sending the feature - as a separate patch and reference it in deprecation notice. +#. Backward compatibility with the major ABI version must be maintained through + ABI Versioning, with :ref:`forward-only <forward-only>` compatibility + offered for any ABI changes that are indicated to be part of the next ABI + version. -#. A full deprecation cycle, as explained above, must be made to offer - downstream consumers sufficient warning of the change. + - In situations where backward compatibility is not possible, read the + section on :ref:`abi_breakages`. -Note that the above process for ABI deprecation should not be undertaken -lightly. ABI stability is extremely important for downstream consumers of the -DPDK, especially when distributed in shared object form. Every effort should -be made to preserve the ABI whenever possible. The ABI should only be changed -for significant reasons, such as performance enhancements. ABI breakage due to -changes such as reorganizing public structure fields for aesthetic or -readability purposes should be avoided. + - No backward or forward compatibility is offered for API changes marked as + ``experimental``, as described in the section on :ref:`Experimental APIs + and Libraries <experimental_apis>`. -.. note:: +#. If a newly proposed API functionally replaces an existing one, when the new + API becomes non-experimental, then the old one is marked with + ``__rte_deprecated``. + + - The depreciated API should follow the notification process to be removed, + see :ref:`deprecation_notices`. + + - At the declaration of the next major ABI version, those ABI changes then + become a formal part of the new ABI and the requirement to preserve ABI + compatibility with the last major ABI version is then dropped. + + - The responsibility for removing redundant ABI compatibility code rests + with the original contributor of the ABI changes, failing that, then with + the contributor's company and then finally with the maintainer. + +.. _forward-only: + +.. Note:: + + Note that forward-only compatibility is offered for those changes made + between major ABI versions. As a library's soname can only describe + compatibility with the last major ABI version, until the next major ABI + version is declared, these changes therefore cannot be resolved as a runtime + dependency through the soname. Therefore any application wishing to make use + of these ABI changes can only ensure that its runtime dependencies are met + through Operating System package versioning. + +.. _hw_rqmts: + +.. Note:: Updates to the minimum hardware requirements, which drop support for hardware which was previously supported, should be treated as an ABI change, and - follow the relevant deprecation policy procedures as above: 3 acks and - announcement at least one release in advance. + follow the relevant deprecation policy procedures as above: 3 acks, technical + board approval and announcement at least one release in advance. + +.. _abi_breakages: + +ABI Breakages +~~~~~~~~~~~~~ + +For those ABI changes that are too significant to reasonably maintain multiple +symbol versions, there is an amended process. In these cases, ABIs may be +updated without the requirement of backward compatibility being provided. These +changes must follow the same process :ref:`described above <abi_changes>` as non-breaking +changes, however with the following additional requirements: + +#. ABI breaking changes (including an alternative map file) can be included with + deprecation notice, in wrapped way by the ``RTE_NEXT_ABI`` option, to provide + more details about oncoming changes. ``RTE_NEXT_ABI`` wrapper will be removed + at the declaration of the next major ABI version. + +#. Once approved, and after the deprecation notice has been observed these + changes will form part of the next declared major ABI version. + +Examples of ABI Changes +~~~~~~~~~~~~~~~~~~~~~~~ + +The following are examples of allowable ABI changes occurring between +declarations of major ABI versions. + +* DPDK 19.11 release, defines the function ``rte_foo()``, and ``rte_foo()`` + as part of the major ABI version ``20``. + +* DPDK 20.02 release defines a new function ``rte_foo(uint8_t bar)``, and + this is not a problem as long as the symbol ``rte_foo@DPDK20`` is + preserved through ABI Versioning. + + - The new function may be marked with the ``__rte_experimental`` tag for a + number of releases, as described in the section :ref:`experimental_apis`. + + - Once ``rte_foo(uint8_t bar)`` becomes non-experimental ``rte_foo()`` is then + declared as ``__rte_depreciated``, with an associated deprecation notice + provided. + +* DPDK 19.11 is not re-released to include ``rte_foo(uint8_t bar)``, the new + version of ``rte_foo`` only exists from DPDK 20.02 onwards as described in the + :ref:`note on forward-only compatibility<forward-only>`. + +* DPDK 20.02 release defines the experimental function ``__rte_experimental + rte_baz()``. This function may or may not exist in the DPDK 20.05 release. + +* An application ``dPacket`` wishes to use ``rte_foo(uint8_t bar)``, before the + declaration of the DPDK ``21`` major API version. The application can only + ensure its runtime dependencies are met by specifying ``DPDK (>= 20.2)`` as + an explicit package dependency, as the soname only may only indicate the + supported major ABI version. + +* At the release of DPDK 20.11, the function ``rte_foo(uint8_t bar)`` becomes + formally part of then new major ABI version DPDK 21.0 and ``rte_foo()`` may be + removed. + +.. _deprecation_notices: Examples of Deprecation Notices ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -104,46 +258,42 @@ Examples of Deprecation Notices The following are some examples of ABI deprecation notices which would be added to the Release Notes: -* The Macro ``#RTE_FOO`` is deprecated and will be removed with version 2.0, - to be replaced with the inline function ``rte_foo()``. +* The Macro ``#RTE_FOO`` is deprecated and will be removed with ABI version + 21, to be replaced with the inline function ``rte_foo()``. * The function ``rte_mbuf_grok()`` has been updated to include a new parameter - in version 2.0. Backwards compatibility will be maintained for this function - until the release of version 2.1 + in version 20.2. Backwards compatibility will be maintained for this function + until the release of the new DPDK major ABI version 21, in DPDK version + 20.11. -* The members of ``struct rte_foo`` have been reorganized in release 2.0 for +* The members of ``struct rte_foo`` have been reorganized in DPDK 20.02 for performance reasons. Existing binary applications will have backwards - compatibility in release 2.0, while newly built binaries will need to - reference the new structure variant ``struct rte_foo2``. Compatibility will - be removed in release 2.2, and all applications will require updating and + compatibility in release 20.02, while newly built binaries will need to + reference the new structure variant ``struct rte_foo2``. Compatibility will be + removed in release 20.11, and all applications will require updating and rebuilding to the new structure at that time, which will be renamed to the original ``struct rte_foo``. * Significant ABI changes are planned for the ``librte_dostuff`` library. The - upcoming release 2.0 will not contain these changes, but release 2.1 will, + upcoming release 20.02 will not contain these changes, but release 20.11 will, and no backwards compatibility is planned due to the extensive nature of - these changes. Binaries using this library built prior to version 2.1 will + these changes. Binaries using this library built prior to ABI version 21 will require updating and recompilation. -New API replacing previous one -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -If a new API proposed functionally replaces an existing one, when the new API -becomes non-experimental then the old one is marked with ``__rte_deprecated``. -Deprecated APIs are removed completely just after the next LTS. +.. _experimental_apis: -Reminder that old API should follow deprecation process to be removed. +Experimental +------------ +APIs +~~~~ -Experimental APIs ------------------ - -APIs marked as ``experimental`` are not considered part of the ABI and may -change without warning at any time. Since changes to APIs are most likely -immediately after their introduction, as users begin to take advantage of -those new APIs and start finding issues with them, new DPDK APIs will be -automatically marked as ``experimental`` to allow for a period of stabilization -before they become part of a tracked ABI. +APIs marked as ``experimental`` are not considered part of an ABI version and +may change without warning at any time. Since changes to APIs are most likely +immediately after their introduction, as users begin to take advantage of those +new APIs and start finding issues with them, new DPDK APIs will be automatically +marked as ``experimental`` to allow for a period of stabilization before they +become part of a tracked ABI version. Note that marking an API as experimental is a multi step process. To mark an API as experimental, the symbols which are desired to be exported @@ -161,7 +311,16 @@ In addition to tagging the code with ``__rte_experimental``, the doxygen markup must also contain the EXPERIMENTAL string, and the MAINTAINERS file should note the EXPERIMENTAL libraries. -For removing the experimental tag associated with an API, deprecation notice -is not required. Though, an API should remain in experimental state for at least -one release. Thereafter, normal process of posting patch for review to mailing -list can be followed. +For removing the experimental tag associated with an API, deprecation notice is +not required. Though, an API should remain in experimental state for at least +one release. Thereafter, the normal process of posting patch for review to +mailing list can be followed. + +Libraries +~~~~~~~~~ + +Libraries marked as ``experimental`` are entirely not considered part of an ABI +version, and may change without warning at any time. Experimental libraries +always have a major version of ``0`` to indicate they exist outside of +ABI Versioning, with the minor version incremented with each ABI change +to library. diff --git a/doc/guides/contributing/img/abi_stability_policy.svg b/doc/guides/contributing/img/abi_stability_policy.svg new file mode 100644 index 0000000..4fd4007 --- /dev/null +++ b/doc/guides/contributing/img/abi_stability_policy.svg @@ -0,0 +1,1059 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<svg + xmlns:dc="http://purl.org/dc/elements/1.1/" + xmlns:cc="http://creativecommons.org/ns#" + xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" + xmlns:svg="http://www.w3.org/2000/svg" + xmlns="http://www.w3.org/2000/svg" + xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd" + xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape" + width="1237.4869" + height="481.37463" + version="1.1" + viewBox="0 0 1237.4869 481.37463" + xml:space="preserve" + id="svg7800" + sodipodi:docname="abi_stability_policy.svg" + inkscape:version="0.92.2 (5c3e80d, 2017-08-06)"><metadata + id="metadata7804"><rdf:RDF><cc:Work + rdf:about=""><dc:format>image/svg+xml</dc:format><dc:type + rdf:resource="http://purl.org/dc/dcmitype/StillImage" /></cc:Work></rdf:RDF></metadata><sodipodi:namedview + pagecolor="#ffffff" + bordercolor="#666666" + borderopacity="1" + objecttolerance="10" + gridtolerance="10" + guidetolerance="10" + inkscape:pageopacity="0" + inkscape:pageshadow="2" + inkscape:window-width="1920" + inkscape:window-height="1017" + id="namedview7802" + showgrid="false" + inkscape:zoom="0.8875" + inkscape:cx="840.50495" + inkscape:cy="179.36692" + inkscape:window-x="-8" + inkscape:window-y="-8" + inkscape:window-maximized="1" + inkscape:current-layer="svg7800" /><defs + id="defs7394"><clipPath + id="clipPath3975"><path + d="M 0,1.2207e-4 H 960 V 540.00012 H 0 Z" + id="path7226" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4003"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7229" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4025"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7232" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4037"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7235" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4049"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7238" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4061"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7241" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4073"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7244" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4085"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7247" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4097"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7250" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4109"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7253" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4121"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7256" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4133"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7259" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4145"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7262" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4157"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7265" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4169"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7268" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4181"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7271" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4193"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7274" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4205"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7277" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4217"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7280" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4229"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7283" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4241"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7286" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4253"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7289" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4265"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7292" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4277"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7295" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4289"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7298" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4301"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7301" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4313"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7304" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4327"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7307" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4339"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7310" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4351"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7313" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4363"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7316" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4375"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7319" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4389"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7322" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4403"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7325" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4417"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7328" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4429"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7331" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4441"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7334" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4453"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7337" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4477"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7340" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4489"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7343" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4501"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7346" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4513"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7349" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4525"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7352" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4537"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7355" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4549"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7358" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4561"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7361" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4573"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7364" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4589"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7367" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4601"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7370" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4615"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7373" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4629"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7376" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4641"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7379" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4653"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7382" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4673"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7385" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4685"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7388" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4699"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7391" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath></defs><g + id="g7406" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><path + style="fill:#44546a" + inkscape:connector-curvature="0" + id="path7400" + d="m 161.83,180.57 773.79,4.78 c 0.82,0.01 1.49,0.68 1.49,1.51 -0.01,0.83 -0.68,1.5 -1.51,1.49 l -773.79,-4.78 c -0.83,-0.01 -1.5,-0.68 -1.49,-1.51 0.01,-0.83 0.68,-1.5 1.51,-1.49 z m 772.3,1.77 8.97,4.56 -9.03,4.44 z" /><path + style="fill:#00b050;fill-rule:evenodd" + inkscape:connector-curvature="0" + id="path7402" + d="m 173.28,182.22 c 0,4.67 3.36,8.46 7.5,8.46 4.14,0 7.5,-3.79 7.5,-8.46 0,-4.67 -3.36,-8.46 -7.5,-8.46 -4.14,0 -7.5,3.79 -7.5,8.46 z" /><path + style="fill:#00b050;fill-rule:evenodd" + inkscape:connector-curvature="0" + id="path7404" + d="m 612.24,183.78 c 0,4.67 3.36,8.46 7.5,8.46 4.14,0 7.5,-3.79 7.5,-8.46 0,-4.67 -3.36,-8.46 -7.5,-8.46 -4.14,0 -7.5,3.79 -7.5,8.46 z" /></g><g + style="fill:#ff0000;fill-rule:evenodd" + id="g7420" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><path + inkscape:connector-curvature="0" + id="path7408" + d="m 228.12,182.22 c 0,4.67 3.36,8.46 7.5,8.46 4.14,0 7.5,-3.79 7.5,-8.46 0,-4.67 -3.36,-8.46 -7.5,-8.46 -4.14,0 -7.5,3.79 -7.5,8.46 z" /><path + inkscape:connector-curvature="0" + id="path7410" + d="m 282.96,182.22 c 0,4.67 3.36,8.46 7.5,8.46 4.14,0 7.5,-3.79 7.5,-8.46 0,-4.67 -3.36,-8.46 -7.5,-8.46 -4.14,0 -7.5,3.79 -7.5,8.46 z" /><path + inkscape:connector-curvature="0" + id="path7412" + d="m 337.8,182.22 c 0,4.67 3.38,8.46 7.56,8.46 4.18,0 7.56,-3.79 7.56,-8.46 0,-4.67 -3.38,-8.46 -7.56,-8.46 -4.18,0 -7.56,3.79 -7.56,8.46 z" /><path + inkscape:connector-curvature="0" + id="path7414" + d="m 447.6,182.22 c 0,4.67 3.36,8.46 7.5,8.46 4.14,0 7.5,-3.79 7.5,-8.46 0,-4.67 -3.36,-8.46 -7.5,-8.46 -4.14,0 -7.5,3.79 -7.5,8.46 z" /><path + inkscape:connector-curvature="0" + id="path7416" + d="m 502.44,182.34 c 0,4.67 3.38,8.46 7.56,8.46 4.18,0 7.56,-3.79 7.56,-8.46 0,-4.67 -3.38,-8.46 -7.56,-8.46 -4.18,0 -7.56,3.79 -7.56,8.46 z" /><path + inkscape:connector-curvature="0" + id="path7418" + d="m 557.28,182.34 c 0,4.67 3.38,8.46 7.56,8.46 4.18,0 7.56,-3.79 7.56,-8.46 0,-4.67 -3.38,-8.46 -7.56,-8.46 -4.18,0 -7.56,3.79 -7.56,8.46 z" /></g><g + id="g7426" + clip-path="url(#clipPath4003)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7424" + font-size="14.04px" + transform="matrix(1,0,0,-1,152.98,149.45)"><tspan + id="tspan7422" + y="0" + x="0 6.3460798 13.46436 20.52648 24.10668 31.22496">v19.11</tspan></text> +</g><path + style="fill:#00b050;fill-rule:evenodd;stroke-width:1.33329999" + inkscape:connector-curvature="0" + id="path7428" + d="m 499.42541,379.9105 c 0,-6.22651 4.47989,-11.27972 9.99975,-11.27972 5.51986,0 9.99975,5.05321 9.99975,11.27972 0,6.22651 -4.47989,11.27972 -9.99975,11.27972 -5.51986,0 -9.99975,-5.05321 -9.99975,-11.27972 z" /><path + style="fill:#00b050;fill-rule:evenodd;stroke-width:1.33329999" + inkscape:connector-curvature="0" + id="path7430" + d="m 1084.6908,373.67065 c 0,-6.22651 4.4799,-11.27971 9.9997,-11.27971 5.5199,0 9.9998,5.0532 9.9998,11.27971 0,6.22652 -4.4799,11.27972 -9.9998,11.27972 -5.5198,0 -9.9997,-5.0532 -9.9997,-11.27972 z" /><g + style="fill:#ff0000;fill-rule:evenodd" + id="g7438" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><path + inkscape:connector-curvature="0" + id="path7432" + d="m 667.08,185.4 c 0,4.64 3.36,8.4 7.5,8.4 4.14,0 7.5,-3.76 7.5,-8.4 0,-4.64 -3.36,-8.4 -7.5,-8.4 -4.14,0 -7.5,3.76 -7.5,8.4 z" /><path + inkscape:connector-curvature="0" + id="path7434" + d="m 721.92,185.58 c 0,4.67 3.38,8.46 7.56,8.46 4.18,0 7.56,-3.79 7.56,-8.46 0,-4.67 -3.38,-8.46 -7.56,-8.46 -4.18,0 -7.56,3.79 -7.56,8.46 z" /><path + inkscape:connector-curvature="0" + id="path7436" + d="m 776.76,185.58 c 0,4.67 3.38,8.46 7.56,8.46 4.18,0 7.56,-3.79 7.56,-8.46 0,-4.67 -3.38,-8.46 -7.56,-8.46 -4.18,0 -7.56,3.79 -7.56,8.46 z" /></g><g + id="g7444" + clip-path="url(#clipPath4025)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7442" + font-size="14.04px" + transform="matrix(1,0,0,-1,210.14,150.1)"><tspan + id="tspan7440" + y="0" + x="0 6.3460798 13.46436 20.52648 24.10668 31.22496">v20.02</tspan></text> +</g><g + id="g7450" + clip-path="url(#clipPath4037)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7448" + font-size="14.04px" + transform="matrix(1,0,0,-1,265.01,150.1)"><tspan + id="tspan7446" + y="0" + x="0 6.3460798 13.46436 20.52648 24.10668 31.22496">v20.05</tspan></text> +</g><g + id="g7456" + clip-path="url(#clipPath4049)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7454" + font-size="14.04px" + transform="matrix(1,0,0,-1,319.9,150.77)"><tspan + id="tspan7452" + y="0" + x="0 6.3460798 13.46436 20.52648 24.10668 31.22496">v20.08</tspan></text> +</g><g + id="g7462" + clip-path="url(#clipPath4061)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.06400013px;font-family:Calibri;fill:#000000" + id="text7460" + font-size="14.064px" + transform="matrix(1,0,0,-1,375,150.94)"><tspan + id="tspan7458" + y="0" + x="0 7.9180322 14.992224 22.066416 25.652737 32.726929">V20.11</tspan></text> +</g><g + id="g7468" + clip-path="url(#clipPath4073)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.06400013px;font-family:Calibri;fill:#000000" + id="text7466" + font-size="14.064px" + transform="matrix(1,0,0,-1,429.17,150.94)"><tspan + id="tspan7464" + y="0" + x="0 6.3569279 13.445184 20.519377 24.105696 31.179888">v21.02</tspan></text> +</g><g + id="g7474" + clip-path="url(#clipPath4085)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7472" + font-size="14.04px" + transform="matrix(1,0,0,-1,483,150.55)"><tspan + id="tspan7470" + y="0" + x="0 6.3460798 13.46436 20.52648 24.10668 31.22496">v21.05</tspan></text> +</g><g + id="g7480" + clip-path="url(#clipPath4097)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.06400013px;font-family:Calibri;fill:#000000" + id="text7478" + font-size="14.064px" + transform="matrix(1,0,0,-1,537.38,150.82)"><tspan + id="tspan7476" + y="0" + x="0 6.3569279 13.445184 20.519377 24.105696 31.179888">v21.08</tspan></text> +</g><g + id="g7486" + clip-path="url(#clipPath4109)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.06400013px;font-family:Calibri;fill:#000000" + id="text7484" + font-size="14.064px" + transform="matrix(1,0,0,-1,592.27,150.82)"><tspan + id="tspan7482" + y="0" + x="0 6.3569279 13.445184 20.519377 24.105696 31.179888">v21.11</tspan></text> +</g><g + id="g7492" + clip-path="url(#clipPath4121)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7490" + font-size="14.04px" + transform="matrix(1,0,0,-1,647.14,151.46)"><tspan + id="tspan7488" + y="0" + x="0 6.3460798 13.46436 20.52648 24.10668 31.22496">v22.02</tspan></text> +</g><g + id="g7498" + clip-path="url(#clipPath4133)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7496" + font-size="14.04px" + transform="matrix(1,0,0,-1,702.24,151.63)"><tspan + id="tspan7494" + y="0" + x="0 7.96068 14.99472 22.113001 25.651079 32.76936">V22.05</tspan></text> +</g><g + id="g7504" + clip-path="url(#clipPath4145)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7502" + font-size="14.04px" + transform="matrix(1,0,0,-1,756.43,151.63)"><tspan + id="tspan7500" + y="0" + x="0 7.96068 14.99472 22.113001 25.651079 32.76936">V22.08</tspan></text> +</g><g + id="g7510" + clip-path="url(#clipPath4157)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7508" + font-size="14.04px" + transform="matrix(1,0,0,-1,811.99,151.63)"><tspan + id="tspan7506" + y="0" + x="0 7.96068 14.99472 22.113001 25.651079 32.76936">V22.11</tspan></text> +</g><g + id="g7516" + clip-path="url(#clipPath4169)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7514" + font-size="14.04px" + transform="matrix(1,0,0,-1,105.82,214.18)"><tspan + id="tspan7512" + y="0" + x="0 6.3460798 13.46436">v20</tspan></text> +</g><g + id="g7522" + clip-path="url(#clipPath4181)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.06400013px;font-family:Calibri;fill:#000000" + id="text7520" + font-size="14.064px" + transform="matrix(1,0,0,-1,105.5,247.68)"><tspan + id="tspan7518" + y="0" + x="0 6.3569279 13.445184">v21</tspan></text> +</g><g + id="g7528" + clip-path="url(#clipPath4193)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7526" + font-size="14.04px" + transform="matrix(1,0,0,-1,228.79,214.51)"><tspan + id="tspan7524" + y="0" + x="0">√</tspan></text> +</g><g + id="g7534" + clip-path="url(#clipPath4205)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7532" + font-size="14.04px" + transform="matrix(1,0,0,-1,283.8,214.51)"><tspan + id="tspan7530" + y="0" + x="0">√</tspan></text> +</g><g + id="g7540" + clip-path="url(#clipPath4217)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7538" + font-size="14.04px" + transform="matrix(1,0,0,-1,337.68,214.51)"><tspan + id="tspan7536" + y="0" + x="0">√</tspan></text> +</g><g + id="g7546" + clip-path="url(#clipPath4229)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7544" + font-size="14.04px" + transform="matrix(1,0,0,-1,611.66,285.79)"><tspan + id="tspan7542" + y="0" + x="0">√</tspan></text> +</g><g + id="g7552" + clip-path="url(#clipPath4241)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7550" + font-size="14.04px" + transform="matrix(1,0,0,-1,666.65,285.79)"><tspan + id="tspan7548" + y="0" + x="0">√</tspan></text> +</g><g + id="g7558" + clip-path="url(#clipPath4253)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7556" + font-size="14.04px" + transform="matrix(1,0,0,-1,719.4,285.79)"><tspan + id="tspan7554" + y="0" + x="0">√</tspan></text> +</g><g + id="g7564" + clip-path="url(#clipPath4265)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7562" + font-size="14.04px" + transform="matrix(1,0,0,-1,775.56,285.79)"><tspan + id="tspan7560" + y="0" + x="0">√</tspan></text> +</g><g + id="g7570" + clip-path="url(#clipPath4277)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7568" + font-size="14.04px" + transform="matrix(1,0,0,-1,398.54,249.22)"><tspan + id="tspan7566" + y="0" + x="0">√</tspan></text> +</g><g + id="g7576" + clip-path="url(#clipPath4289)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7574" + font-size="14.04px" + transform="matrix(1,0,0,-1,453.53,249.22)"><tspan + id="tspan7572" + y="0" + x="0">√</tspan></text> +</g><g + id="g7582" + clip-path="url(#clipPath4301)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7580" + font-size="14.04px" + transform="matrix(1,0,0,-1,507.43,249.22)"><tspan + id="tspan7578" + y="0" + x="0">√</tspan></text> +</g><g + id="g7588" + clip-path="url(#clipPath4313)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7586" + font-size="14.04px" + transform="matrix(1,0,0,-1,561.05,249.22)"><tspan + id="tspan7584" + y="0" + x="0">√</tspan></text> +</g><path + style="fill:#44546a;stroke-width:1.33329999" + inkscape:connector-curvature="0" + id="path7590" + d="m 217.67245,474.73479 v -25.14603 c 0,-1.10664 -0.89331,-1.99995 -1.99995,-1.99995 -1.10664,0 -1.99995,0.89331 -1.99995,1.99995 v 25.14603 c 0,1.09331 0.89331,1.99995 1.99995,1.99995 1.10664,0 1.99995,-0.90664 1.99995,-1.99995 z m 3.9999,-23.14608 -5.99985,-11.9997 -5.99985,11.9997 z" /><g + id="g7596" + clip-path="url(#clipPath4327)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7594" + font-size="14.04px" + transform="matrix(1,0,0,-1,170.83,214.51)"><tspan + id="tspan7592" + y="0" + x="0">√</tspan></text> +</g><g + id="g7602" + clip-path="url(#clipPath4339)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-weight:bold;font-size:14.06400013px;font-family:Calibri;fill:#000000" + id="text7600" + font-weight="bold" + font-size="14.064px" + transform="matrix(1,0,0,-1,23.4,272.33)"><tspan + id="tspan7598" + y="0" + x="0 8.5227842 16.412687 20.167776">ABI </tspan></text> +</g><g + id="g7608" + clip-path="url(#clipPath4351)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-weight:bold;font-size:14.06400013px;font-family:Calibri;fill:#000000" + id="text7606" + font-weight="bold" + font-size="14.064px" + transform="matrix(1,0,0,-1,46.68,272.33)"><tspan + id="tspan7604" + y="0" + x="0 7.566432 14.640624 19.563025 25.174561 28.662432 36.228863">Version</tspan></text> +</g><g + id="g7614" + clip-path="url(#clipPath4363)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-weight:bold;font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7612" + font-weight="bold" + font-size="14.04px" + transform="matrix(1,0,0,-1,17.64,255.5)"><tspan + id="tspan7610" + y="0" + x="0 7.4271598 14.98068 26.395201 33.934681 40.80024 45.700199 49.154041 56.7216 60.175442 63.671398 67.125237 72.053284">Compatibility</tspan></text> +</g><g + id="g7620" + clip-path="url(#clipPath4375)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7618" + font-size="14.04px" + transform="matrix(1,0,0,-1,191.28,116.86)"><tspan + id="tspan7616" + y="0" + x="0 6.3460798 13.46436">v20</tspan></text> +</g><path + style="fill:#44546a;stroke-width:1.33329999" + inkscape:connector-curvature="0" + id="path7622" + d="m 511.7451,474.89479 v -25.14604 c 0,-1.10664 -0.89331,-1.99995 -1.99995,-1.99995 -1.10664,0 -1.99995,0.89331 -1.99995,1.99995 v 25.14604 c 0,1.09331 0.89331,1.99995 1.99995,1.99995 1.10664,0 1.99995,-0.90664 1.99995,-1.99995 z m 3.9999,-23.14609 -5.99985,-11.9997 -5.99985,11.9997 z" /><g + id="g7628" + clip-path="url(#clipPath4389)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7626" + font-size="14.04px" + transform="matrix(1,0,0,-1,407.06,115.63)"><tspan + id="tspan7624" + y="0" + x="0 6.3460798 13.46436">v21</tspan></text> +</g><path + style="fill:#44546a;stroke-width:1.33329999" + inkscape:connector-curvature="0" + id="path7630" + d="m 804.53778,476.01476 v -25.14604 c 0,-1.10664 -0.89331,-1.99995 -1.99995,-1.99995 -1.10664,0 -1.99995,0.89331 -1.99995,1.99995 v 25.14604 c 0,1.09331 0.89331,1.99995 1.99995,1.99995 1.10664,0 1.99995,-0.90664 1.99995,-1.99995 z m 3.9999,-23.14609 -5.99985,-11.9997 -5.99985,11.9997 z" /><g + id="g7636" + clip-path="url(#clipPath4403)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7634" + font-size="14.04px" + transform="matrix(1,0,0,-1,626.66,114.74)"><tspan + id="tspan7632" + y="0" + x="0 6.3460798 13.46436">v22</tspan></text> +</g><path + style="fill:#44546a;stroke-width:1.33329999" + inkscape:connector-curvature="0" + id="path7638" + d="m 1098.2904,479.37468 v -25.14604 c 0,-1.10664 -0.8933,-1.99995 -1.9999,-1.99995 -1.1067,0 -2,0.89331 -2,1.99995 v 25.14604 c 0,1.0933 0.8933,1.99995 2,1.99995 1.1066,0 1.9999,-0.90665 1.9999,-1.99995 z m 3.9999,-23.14609 -5.9998,-11.9997 -5.9999,11.9997 z" /><g + id="g7644" + clip-path="url(#clipPath4417)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.06400013px;font-family:Calibri;fill:#000000" + id="text7642" + font-size="14.064px" + transform="matrix(1,0,0,-1,846.96,112.22)"><tspan + id="tspan7640" + y="0" + x="0 6.3569279 13.445184">v23</tspan></text> +</g><g + id="g7650" + clip-path="url(#clipPath4429)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7648" + font-size="14.04px" + transform="matrix(1,0,0,-1,832.87,318.46)"><tspan + id="tspan7646" + y="0" + x="0">√</tspan></text> +</g><g + id="g7656" + clip-path="url(#clipPath4441)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7654" + font-size="14.04px" + transform="matrix(1,0,0,-1,105.5,285.67)"><tspan + id="tspan7652" + y="0" + x="0 6.3460798 13.46436">v22</tspan></text> +</g><g + id="g7662" + clip-path="url(#clipPath4453)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7660" + font-size="14.04px" + transform="matrix(1,0,0,-1,104.93,319.87)"><tspan + id="tspan7658" + y="0" + x="0 6.3460798 13.46436">v23</tspan></text> +</g><path + style="fill:none;stroke:#5b9bd5;stroke-width:0.63998401;stroke-miterlimit:10;stroke-dasharray:2.559936, 1.919952" + inkscape:connector-curvature="0" + id="path7664" + stroke-miterlimit="10" + d="m 1104.7569,213.75465 -934.60326,0.39999" /><path + style="fill:none;stroke:#5b9bd5;stroke-width:0.63998401;stroke-miterlimit:10;stroke-dasharray:2.559936, 1.919952" + inkscape:connector-curvature="0" + id="path7666" + stroke-miterlimit="10" + d="M 1105.3969,255.35361 170.79362,255.7536" /><path + style="fill:none;stroke:#5b9bd5;stroke-width:0.63998401;stroke-miterlimit:10;stroke-dasharray:2.559936, 1.919952" + inkscape:connector-curvature="0" + id="path7668" + stroke-miterlimit="10" + d="M 1105.3969,299.35251 170.79362,299.7525" /><g + id="g7674" + clip-path="url(#clipPath4477)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.06400013px;font-family:Calibri;fill:#8497b0" + id="text7672" + font-size="14.064px" + transform="matrix(1,0,0,-1,283.8,251.38)"><tspan + id="tspan7670" + y="0" + x="0">√</tspan></text> +</g><g + id="g7680" + clip-path="url(#clipPath4489)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#8497b0" + id="text7678" + font-size="14.04px" + transform="matrix(1,0,0,-1,339.5,251.95)"><tspan + id="tspan7676" + y="0" + x="0">√</tspan></text> +</g><g + id="g7686" + clip-path="url(#clipPath4501)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#d0cece" + id="text7684" + font-size="14.04px" + transform="matrix(1,0,0,-1,229.8,250.63)"><tspan + id="tspan7682" + y="0" + x="0">√</tspan></text> +</g><g + id="g7692" + clip-path="url(#clipPath4513)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#d0cece" + id="text7690" + font-size="14.04px" + transform="matrix(1,0,0,-1,453.53,286.63)"><tspan + id="tspan7688" + y="0" + x="0">√</tspan></text> +</g><g + id="g7698" + clip-path="url(#clipPath4525)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#8497b0" + id="text7696" + font-size="14.04px" + transform="matrix(1,0,0,-1,507.43,286.63)"><tspan + id="tspan7694" + y="0" + x="0">√</tspan></text> +</g><g + id="g7704" + clip-path="url(#clipPath4537)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#8497b0" + id="text7702" + font-size="14.04px" + transform="matrix(1,0,0,-1,561.05,286.63)"><tspan + id="tspan7700" + y="0" + x="0">√</tspan></text> +</g><g + id="g7710" + clip-path="url(#clipPath4549)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#d0cece" + id="text7708" + font-size="14.04px" + transform="matrix(1,0,0,-1,667.39,318.89)"><tspan + id="tspan7706" + y="0" + x="0">√</tspan></text> +</g><g + id="g7716" + clip-path="url(#clipPath4561)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#8497b0" + id="text7714" + font-size="14.04px" + transform="matrix(1,0,0,-1,720.14,318.89)"><tspan + id="tspan7712" + y="0" + x="0">√</tspan></text> +</g><g + id="g7722" + clip-path="url(#clipPath4573)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#8497b0" + id="text7720" + font-size="14.04px" + transform="matrix(1,0,0,-1,776.3,318.89)"><tspan + id="tspan7718" + y="0" + x="0">√</tspan></text> +</g><path + style="fill:#7030a0;stroke-width:1.33329999" + inkscape:connector-curvature="0" + id="path7724" + d="m 211.36594,305.0057 2.18661,-227.154316 c 0.0133,-1.0933 -0.87997,-1.99995 -1.98661,-2.01328 -1.09331,-0.0133 -1.99995,0.87998 -2.01329,1.98662 l -2.18661,227.140986 c -0.0133,1.10663 0.87998,2.01328 1.98662,2.02661 1.10664,0.0133 1.99995,-0.87998 2.01328,-1.98662 z m -7.97313,-2.07994 5.87985,12.06636 6.11985,-11.94637 z" /><path + style="fill:#7030a0;stroke-width:1.33329999" + inkscape:connector-curvature="0" + id="path7726" + d="M 289.03067,238.94069 V 107.43731 c 0,-1.10664 -0.89331,-1.99995 -1.99995,-1.99995 -1.10664,0 -1.99995,0.89331 -1.99995,1.99995 v 131.50338 c 0,1.09331 0.89331,1.99995 1.99995,1.99995 1.10664,0 1.99995,-0.90664 1.99995,-1.99995 z m -7.9998,-1.99995 5.99985,11.9997 5.99985,-11.9997 z" /><g + id="g7732" + clip-path="url(#clipPath4589)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7730" + font-size="14.04px" + transform="matrix(1,0,0,-1,164.59,422.74)"><tspan + id="tspan7728" + y="0" + x="0 6.3460798 13.46436 20.52648 23.75568 31.88484 39.578758 43.06068 46.065239 49.294441 54.784081 57.957119 65.271957 72.263878 78.118561 81.347763 88.072922 92.762283 99.754204 107.04096 110.38248 117.10764 120.33684 123.56604 130.17888 137.50777 144.49968 151.78644 155.12796 165.16656 168.43788 173.14128 180.44208 183.67128 190.01736 197.13564 204.19775 207.77795 214.89624 221.94432 225.17352 229.9752 236.70036">v20 ABI is declared aligned with v19.11 LTS</tspan></text> +</g><g + id="g7738" + clip-path="url(#clipPath4601)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.06400013px;font-family:Calibri;fill:#000000" + id="text7736" + font-size="14.064px" + transform="matrix(1,0,0,-1,222.12,398.3)"><tspan + id="tspan7734" + y="0" + x="0 6.3569279 13.445184 20.519377 23.740032 29.014032 35.385025 46.537777 53.851055 61.262783 64.497505 70.038719 73.034355 79.771011 84.440254 91.401939 94.622589 101.35925 108.65846 115.97174 122.93343 130.2467 133.59393 140.3306 147.62981 154.94308 158.16374 164.52068 171.60893 178.68312 181.90378 187.17778 193.54877 204.70152 212.0148 219.42653 222.66125 228.20247 231.32468 238.06133 242.73058 249.69226 252.81447 263.98129 271.39301 278.77661 282.01132 286.30084 289.53555 296.53943 303.82458 307.34061 310.51904 316.0462 323.3595 330.67276 337.98605 345.39777 350.30612 355.01755 358.13977 362.21832 369.63004 374.53839 377.5762 383.93314 391.02139 398.09558 401.2178 409.36084 417.03979 420.51361 423.6358 429.40204 436.81378 444.04266 448.75412 451.98883 459.28806 466.60132 473.56302 479.06204">v21 symbols are added and v20 symbols are modified, support for v20 ABI continues.</tspan></text> +</g><path + style="fill:#7030a0;stroke-width:1.33329999" + inkscape:connector-curvature="0" + id="path7740" + d="m 510.78512,258.56686 -0.31999,-126.17017 c 0,-1.09331 0.89331,-1.99995 1.99995,-1.99995 1.09331,0 1.99995,0.89331 1.99995,1.99995 l 0.31999,126.15684 c 0,1.10664 -0.89331,2.01328 -1.99995,2.01328 -1.0933,0 -1.99995,-0.89331 -1.99995,-1.99995 z m 7.9998,-2.01328 -5.97318,12.01303 -6.02652,-11.98636 z" /><g + id="g7746" + clip-path="url(#clipPath4615)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7744" + font-size="14.04px" + transform="matrix(1,0,0,-1,388.51,373.39)"><tspan + id="tspan7742" + y="0" + x="0 6.3460798 13.46436 20.52648 23.75568 31.88484 39.578758 43.06068 46.065239 49.294441 54.784081 57.957119 65.271957 72.263878 78.118561 81.347763 88.072922 92.762283 99.754204 107.04096 110.38248 117.10764 120.33684 123.56604 130.17888 137.50777 144.49968 151.78644 155.12796 165.16656 168.43788 173.14128 180.44208 183.67128 190.01736 197.13564 204.19775 207.77795 214.89624 221.94432 225.17352 229.9752 236.70036 243.14471 246.65472 249.78564 254.46095 261.45288 272.58661 279.31177 282.54095 289.86984 293.09903 300.47003 307.02673 310.36823 316.71432 323.83261 330.89471 334.12393 339.40295 345.76309 356.92487 364.23972 371.63879 374.91013 380.39975 383.4324 390.15756 394.83289 401.8248 404.99783 409.71527 416.70721 427.84091 435.23999 441.51587 448.50781 455.79456">v21 ABI is declared aligned with v20.11 LTS, remaining v20 symbols are removed.</tspan></text> +</g><path + style="fill:none;stroke:#7030a0;stroke-width:2.07994795;stroke-miterlimit:10" + inkscape:connector-curvature="0" + id="path7748" + stroke-miterlimit="10" + d="M 278.23094,342.95142 H 449.58665 V 261.03347 H 278.23094 Z" /><g + id="g7754" + clip-path="url(#clipPath4629)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-weight:bold;font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7752" + font-weight="bold" + font-size="14.04px" + transform="matrix(1,0,0,-1,23.616,114.74)"><tspan + id="tspan7750" + y="0" + x="0 8.5082397 16.4268 20.17548 23.26428 30.817801 37.879921 42.821999 48.423962 51.93396 59.48748 67.026962">ABI Versions</tspan></text> +</g><g + id="g7760" + clip-path="url(#clipPath4641)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-weight:bold;font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7758" + font-weight="bold" + font-size="14.04px" + transform="matrix(1,0,0,-1,20.064,150.17)"><tspan + id="tspan7756" + y="0" + x="0 8.8451996 16.31448 25.159679 32.839561 36.0126 43.67844 50.740559 54.222481 61.284599 68.248444 73.850403 80.954643">DPDK Releases</tspan></text> +</g><g + id="g7766" + clip-path="url(#clipPath4653)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7764" + font-size="14.04px" + transform="matrix(1,0,0,-1,444,346.1)"><tspan + id="tspan7762" + y="0" + x="0 6.3460798 13.46436 20.52648 23.75568 29.034719 35.39484 46.556641 53.871479 61.270561 64.541878 70.031517 73.064163 79.789322 84.464638 91.456558 94.629601 101.35476 108.72576 116.02656 123.01848 130.30524 133.64676 140.37192 147.68677 155.0016 158.2308 164.57687 171.69516 178.75728 181.98648 187.26552 193.62564 204.78745 212.10228 219.50136 222.77267 228.26231 231.43536 238.16052 242.80775 249.79968 252.88847 264.05029 271.44937 278.82037 282.04956 286.33176 289.60309 296.595 303.88177 307.39175 310.56479 316.1106 323.42545 330.74026 338.05511 345.45419 350.39627 355.09967 358.20251 362.28815 369.68723 374.62933 377.63388 383.97995 391.09824 398.16037 401.27725 409.4064 417.10031 420.58224 423.69913 429.45551 436.85461 444.09924 448.80264 452.03183 459.33264 466.64749 473.6394 479.12903 488.81665 492.43896">v22 symbols are added and v21 symbols are modified, support for v21 ABI continues…..</tspan></text> +</g><path + style="fill:#7030a0;stroke-width:1.33329999" + inkscape:connector-curvature="0" + id="path7768" + d="m 583.39664,198.26171 -0.13333,-30.49257 c 0,-1.10664 0.89331,-2.01329 1.98662,-2.01329 1.10664,0 2.01328,0.89331 2.01328,1.98662 l 0.13333,30.49257 c 0,1.10664 -0.89331,2.01328 -1.99995,2.01328 -1.0933,0 -1.99995,-0.89331 -1.99995,-1.98661 z m 7.98647,-2.03995 -5.94652,12.02636 -6.05318,-11.97303 z" /><path + style="fill:none;stroke:#7030a0;stroke-width:2.07994795;stroke-miterlimit:10" + inkscape:connector-curvature="0" + id="path7770" + stroke-miterlimit="10" + d="M 571.18361,299.43251 H 742.37933 V 212.87467 H 571.18361 Z" /><path + style="fill:#00b050;fill-rule:evenodd;stroke-width:1.33329999" + inkscape:connector-curvature="0" + id="path7772" + d="m 933.01457,30.959224 c 0,-6.22651 4.50655,-11.27972 10.07975,-11.27972 5.57319,0 10.07974,5.05321 10.07974,11.27972 0,6.22651 -4.50655,11.27972 -10.07974,11.27972 -5.5732,0 -10.07975,-5.05321 -10.07975,-11.27972 z" /><path + style="fill:#ff0000;fill-rule:evenodd;stroke-width:1.33329999" + inkscape:connector-curvature="0" + id="path7774" + d="m 1081.3309,29.759254 c 0,-6.18651 4.4798,-11.19972 9.9997,-11.19972 5.5199,0 9.9998,5.01321 9.9998,11.19972 0,6.18651 -4.4799,11.19972 -9.9998,11.19972 -5.5199,0 -9.9997,-5.01321 -9.9997,-11.19972 z" /><g + id="g7780" + clip-path="url(#clipPath4673)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7778" + font-size="14.04px" + transform="matrix(1,0,0,-1,744.89,439.54)"><tspan + id="tspan7776" + y="0" + x="0 4.8016801 11.52684 17.971201 21.144239 28.5714 35.56332 38.792519 45.728279 52.453442 57.943081">LTS Release</tspan></text> +</g><g + id="g7786" + clip-path="url(#clipPath4685)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7784" + font-size="14.04px" + transform="matrix(1,0,0,-1,856.06,439.75)"><tspan + id="tspan7782" + y="0" + x="0 12.0042 15.2334 22.562281 29.961361 34.903439 38.020321 45.461521 52.453442 55.68264 62.618401 69.343559 74.833199">Minor Release</tspan></text> +</g><path + style="fill:#44546a;stroke-width:1.33329999" + inkscape:connector-curvature="0" + id="path7788" + d="m 779.25841,46.265514 v -25.14604 c 0,-1.10664 -0.89331,-1.99995 -1.99995,-1.99995 -1.10664,0 -1.99995,0.89331 -1.99995,1.99995 v 25.14604 c 0,1.0933 0.89331,1.99995 1.99995,1.99995 1.10664,0 1.99995,-0.90665 1.99995,-1.99995 z m 3.9999,-23.14609 -5.99985,-11.9997 -5.99985,11.9997 z" /><g + id="g7794" + clip-path="url(#clipPath4699)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7792" + font-size="14.04px" + transform="matrix(1,0,0,-1,622.34,439.54)"><tspan + id="tspan7790" + y="0" + x="0 8.1291599 15.82308 19.305 22.309561 29.512079 36.504002 41.151241 46.640881 49.870079 57.339359">ABI Version</tspan></text> +</g><path + style="fill:none;stroke:#002060;stroke-width:1.27996802;stroke-miterlimit:10" + inkscape:connector-curvature="0" + id="path7796" + stroke-miterlimit="10" + d="M 763.41881,62.078444 H 1236.847 V 0.63998401 H 763.41881 Z" /></svg> \ No newline at end of file diff --git a/doc/guides/contributing/img/what_is_an_abi.svg b/doc/guides/contributing/img/what_is_an_abi.svg new file mode 100644 index 0000000..fd3d993 --- /dev/null +++ b/doc/guides/contributing/img/what_is_an_abi.svg @@ -0,0 +1,382 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<svg + xmlns:dc="http://purl.org/dc/elements/1.1/" + xmlns:cc="http://creativecommons.org/ns#" + xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" + xmlns:svg="http://www.w3.org/2000/svg" + xmlns="http://www.w3.org/2000/svg" + xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd" + xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape" + width="970.69568" + height="522.22693" + version="1.1" + viewBox="0 0 970.69568 522.22693" + xml:space="preserve" + id="svg8399" + sodipodi:docname="what_is_an_abi.svg" + inkscape:version="0.92.2 (5c3e80d, 2017-08-06)"><metadata + id="metadata8403"><rdf:RDF><cc:Work + rdf:about=""><dc:format>image/svg+xml</dc:format><dc:type + rdf:resource="http://purl.org/dc/dcmitype/StillImage" /></cc:Work></rdf:RDF></metadata><sodipodi:namedview + pagecolor="#ffffff" + bordercolor="#666666" + borderopacity="1" + objecttolerance="10" + gridtolerance="10" + guidetolerance="10" + inkscape:pageopacity="0" + inkscape:pageshadow="2" + inkscape:window-width="1920" + inkscape:window-height="1017" + id="namedview8401" + showgrid="false" + inkscape:zoom="0.62755727" + inkscape:cx="820.83951" + inkscape:cy="-47.473217" + inkscape:window-x="-8" + inkscape:window-y="-8" + inkscape:window-maximized="1" + inkscape:current-layer="svg8399" /><defs + id="defs8269"><clipPath + id="clipPath26"><path + d="M 0,1.2207e-4 H 960 V 540.00012 H 0 Z" + id="path8206" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><radialGradient + id="radialGradient40" + cx="0" + cy="0" + r="1" + gradientTransform="matrix(386.44367,-1.3123672e-5,-1.3123672e-5,-386.44367,470.30824,246.15384)" + gradientUnits="userSpaceOnUse"><stop + stop-color="#f9d8e2" + offset="0" + id="stop8209" /><stop + stop-color="#fff" + offset=".74" + id="stop8211" /><stop + stop-color="#fff" + offset=".83" + id="stop8213" /><stop + stop-color="#fff" + offset="1" + id="stop8215" /></radialGradient><clipPath + id="clipPath56"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path8218" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath68"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path8221" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath82"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path8224" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath96"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path8227" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath108"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path8230" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath120"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path8233" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath132"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path8236" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath144"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path8239" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath156"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path8242" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath168"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path8245" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath180"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path8248" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath192"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path8251" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath204"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path8254" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath216"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path8257" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath228"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path8260" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath240"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path8263" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath260"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path8266" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath></defs><path + inkscape:connector-curvature="0" + style="fill:url(#radialGradient40);fill-rule:evenodd;stroke-width:1.33329999" + id="path8275" + d="m 116.15709,143.06309 c 0,-28.46596 23.07942,-51.545378 51.54538,-51.545378 h 605.21154 c 28.46595,0 51.54537,23.079418 51.54537,51.545378 V 349.2446 c 0,28.46595 -23.07942,51.54538 -51.54537,51.54538 H 167.70247 c -28.46595,0 -51.54538,-23.07943 -51.54538,-51.54538 z" /><path + style="fill:#00b050;stroke-width:1.33329999" + inkscape:connector-curvature="0" + id="path8277" + d="m 478.70803,73.758152 0.58665,373.057338 c 0,1.67996 -1.35997,3.03993 -3.03992,3.03993 -1.67996,0.0133 -3.03993,-1.34663 -3.03993,-3.02659 L 472.62818,73.758152 c 0,-1.67995 1.35997,-3.03992 3.03992,-3.03992 1.67996,0 3.03993,1.35997 3.03993,3.03992 z m 6.65317,370.004088 -9.09311,18.25287 -9.14644,-18.22621 z" /><path + style="fill:none;stroke:#7030a0;stroke-width:6.07984781;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:10" + inkscape:connector-curvature="0" + id="path8279" + stroke-miterlimit="10" + d="m 3.0399239,186.92866 c 0,-36.70575 29.7459201,-66.45167 66.4516701,-66.45167 H 778.00721 c 36.70575,0 66.45167,29.74592 66.45167,66.45167 v 265.80669 c 0,36.70574 -29.74592,66.45167 -66.45167,66.45167 H 69.491594 c -36.70575,0 -66.4516701,-29.74593 -66.4516701,-66.45167 z" /><path + style="fill:none;stroke:#3b3059;stroke-width:6.07984781;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:10" + inkscape:connector-curvature="0" + id="path8281" + stroke-miterlimit="10" + d="m 101.27746,71.464882 c 0,-37.78572 30.63924,-68.4249581 68.42496,-68.4249581 h 729.52846 c 37.7857,0 68.4249,30.6392381 68.4249,68.4249581 V 345.1647 c 0,37.78572 -30.6392,68.42496 -68.4249,68.42496 H 169.70242 c -37.78572,0 -68.42496,-30.63924 -68.42496,-68.42496 z" /><g + id="g8287" + clip-path="url(#clipPath56)" + transform="matrix(1.3333,0,0,-1.3333,-143.35642,633.10417)"><text + style="font-size:32.06399918px;font-family:'Century Gothic';fill:#3b3059" + id="text8285" + font-size="32.064px" + transform="matrix(1,0,0,-1,409.78,93.312)"><tspan + id="tspan8283" + y="0" + x="0 23.855616 42.837505 66.693123">DPDK</tspan></text> +</g><g + id="g8293" + clip-path="url(#clipPath68)" + transform="matrix(1.3333,0,0,-1.3333,-143.35642,633.10417)"><text + style="font-size:32.06399918px;font-family:'Century Gothic';fill:#3b3059" + id="text8291" + font-size="32.064px" + transform="matrix(1,0,0,-1,358.03,435.43)"><tspan + id="tspan8289" + y="0" + x="0 23.72736 45.595009 67.462654 73.875458 80.160004 100.90541 122.80512 133.54655 139.95937 160.96127">Application</tspan></text> +</g><path + style="fill:#f9d8e2;fill-opacity:0.70196001;fill-rule:evenodd;stroke-width:1.33329999" + inkscape:connector-curvature="0" + id="path8295" + d="M 424.30939,345.59136 H 531.18672 V 277.91305 H 424.30939 Z" /><g + id="g8301" + clip-path="url(#clipPath82)" + transform="matrix(1.3333,0,0,-1.3333,-143.35642,633.10417)"><text + style="font-size:32.04000092px;font-family:'Century Gothic';fill:#3b3059" + id="text8299" + font-size="32.04px" + transform="matrix(1,0,0,-1,432.96,231.41)"><tspan + id="tspan8297" + y="0" + x="0 23.7096 42.67728">API</tspan></text> +</g><path + style="fill:#f9d8e2;fill-opacity:0.70196001;fill-rule:evenodd;stroke-width:1.33329999" + inkscape:connector-curvature="0" + id="path8303" + d="m 422.38944,213.91465 h 107.19732 v -67.8383 H 422.38944 Z" /><g + id="g8309" + clip-path="url(#clipPath96)" + transform="matrix(1.3333,0,0,-1.3333,-143.35642,633.10417)"><text + style="font-size:32.04000092px;font-family:'Century Gothic';fill:#3b3059" + id="text8307" + font-size="32.04px" + transform="matrix(1,0,0,-1,431.54,330.29)"><tspan + id="tspan8305" + y="0" + x="0 23.7096 42.100559">ABI</tspan></text> +</g><g + id="g8315" + clip-path="url(#clipPath108)" + transform="matrix(1.3333,0,0,-1.3333,-143.35642,633.10417)"><text + style="font-size:15.96000004px;font-family:'Century Gothic';fill:#3b3059" + id="text8313" + font-size="15.96px" + transform="matrix(1,0,0,-1,221.78,293.23)"><tspan + id="tspan8311" + y="0" + x="0 9.4483204 14.25228 24.706079 35.447159 40.203239 51.10392 66.106323 81.076797 84.332642 94.068237">Programming</tspan></text> +</g><g + id="g8321" + clip-path="url(#clipPath120)" + transform="matrix(1.3333,0,0,-1.3333,-143.35642,633.10417)"><text + style="font-size:15.98400021px;font-family:'Century Gothic';fill:#3b3059" + id="text8319" + font-size="15.984px" + transform="matrix(1,0,0,-1,221.78,274.03)"><tspan + id="tspan8317" + y="0" + x="0 7.320672 18.237743 27.987984 38.633327 48.351601 59.268673 69.945984">Language</tspan></text> +</g><g + id="g8327" + clip-path="url(#clipPath132)" + transform="matrix(1.3333,0,0,-1.3333,-143.35642,633.10417)"><text + style="font-size:15.96000004px;font-family:'Century Gothic';fill:#3b3059" + id="text8325" + font-size="15.96px" + transform="matrix(1,0,0,-1,221.78,254.81)"><tspan + id="tspan8323" + y="0" + x="0 7.6767602 17.38044 27.116039 37.442162 42.708961 45.93288 56.386681 66.122276">Functions</tspan></text> +</g><g + id="g8333" + clip-path="url(#clipPath144)" + transform="matrix(1.3333,0,0,-1.3333,-143.35642,633.10417)"><text + style="font-size:15.96000004px;font-family:'Century Gothic';fill:#3b3059" + id="text8331" + font-size="15.96px" + transform="matrix(1,0,0,-1,221.78,235.61)"><tspan + id="tspan8329" + y="0" + x="0 11.87424 22.77492 28.073641 38.974319 44.273041 52.891441 63.776161 74.150162">Datatypes</tspan></text> +</g><g + id="g8339" + clip-path="url(#clipPath156)" + transform="matrix(1.3333,0,0,-1.3333,-143.35642,633.10417)"><text + style="font-size:15.96000004px;font-family:'Century Gothic';fill:#3b3059" + id="text8337" + font-size="15.96px" + transform="matrix(1,0,0,-1,221.78,216.41)"><tspan + id="tspan8335" + y="0" + x="0 9.6877203 20.06172 25.312559 35.016239 39.820202 49.555801 54.216122 60.823559 69.441963 80.326683 90.700684">Return Types</tspan></text> +</g><g + id="g8345" + clip-path="url(#clipPath168)" + transform="matrix(1.3333,0,0,-1.3333,-143.35642,633.10417)"><text + style="font-size:15.96000004px;font-family:'Century Gothic';fill:#3b3059" + id="text8343" + font-size="15.96px" + transform="matrix(1,0,0,-1,221.78,197.21)"><tspan + id="tspan8341" + y="0" + x="0 12.97548 23.429279 33.164879 39.357361 44.640121 55.540798 65.276398 70.559158">Constants</tspan></text> +</g><g + id="g8351" + clip-path="url(#clipPath180)" + transform="matrix(1.3333,0,0,-1.3333,-143.35642,633.10417)"><text + style="font-size:15.96000004px;font-family:'Century Gothic';fill:#3b3059" + id="text8349" + font-size="15.96px" + transform="matrix(1,0,0,-1,221.78,178.01)"><tspan + id="tspan8347" + y="0" + x="0">…</tspan></text> +</g><g + id="g8357" + clip-path="url(#clipPath192)" + transform="matrix(1.3333,0,0,-1.3333,-143.35642,633.10417)"><text + style="font-size:15.96000004px;font-family:'Century Gothic';fill:#3b3059" + id="text8355" + font-size="15.96px" + transform="matrix(1,0,0,-1,546.38,354.12)"><tspan + id="tspan8353" + y="0" + x="0 3.8304 13.566 19.75848 25.07316 29.877119 39.580799 49.906921 55.189678 58.413601 68.867401 78.602997 83.2314 89.423882 99.797882">Instruction set</tspan></text> +</g><g + id="g8363" + clip-path="url(#clipPath204)" + transform="matrix(1.3333,0,0,-1.3333,-143.35642,633.10417)"><text + style="font-size:15.98400021px;font-family:'Century Gothic';fill:#3b3059" + id="text8361" + font-size="15.984px" + transform="matrix(1,0,0,-1,546.38,332.88)"><tspan + id="tspan8359" + y="0" + x="0 8.5674238 16.239744 26.517456 36.859104 46.577377 51.836113 62.753185 73.654274 77.026894 87.352562 91.892014 103.99191 108.33955 115.66022 118.85703 128.60727 136.63123 147.02083">Executable & Linker</tspan></text> +</g><g + id="g8369" + clip-path="url(#clipPath216)" + transform="matrix(1.3333,0,0,-1.3333,-143.35642,633.10417)"><text + style="font-size:15.96000004px;font-family:'Century Gothic';fill:#3b3059" + id="text8367" + font-size="15.96px" + transform="matrix(1,0,0,-1,546.38,313.66)"><tspan + id="tspan8365" + y="0" + x="0 7.6767602 18.13056 22.934521 37.904999 48.805679">Format</tspan></text> +</g><g + id="g8375" + clip-path="url(#clipPath228)" + transform="matrix(1.3333,0,0,-1.3333,-143.35642,633.10417)"><text + style="font-size:15.96000004px;font-family:'Century Gothic';fill:#3b3059" + id="text8373" + font-size="15.96px" + transform="matrix(1,0,0,-1,546.38,292.42)"><tspan + id="tspan8371" + y="0" + x="0 12.97548 23.87616 27.22776 30.579359 33.80328 43.538879 54.200161 58.39764 71.373123 81.82692 91.562523 100.6278 110.95392 120.68952 125.95632 129.18024 139.63403 149.36964 155.56212">Calling Conventions.</tspan></text> +</g><g + id="g8381" + clip-path="url(#clipPath240)" + transform="matrix(1.3333,0,0,-1.3333,-143.35642,633.10417)"><text + style="font-size:15.96000004px;font-family:'Century Gothic';fill:#3b3059" + id="text8379" + font-size="15.96px" + transform="matrix(1,0,0,-1,546.38,271.3)"><tspan + id="tspan8377" + y="0" + x="0">…</tspan></text> +</g><path + style="fill:none;stroke:#ffffff;stroke-width:6.07984781;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:10;stroke-dasharray:18.239544, 24.319392" + inkscape:connector-curvature="0" + id="path8383" + stroke-miterlimit="10" + d="M 122.71693,120.47699 H 782.84709" /><path + style="fill:none;stroke:#ffffff;stroke-width:6.07984781;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:10;stroke-dasharray:18.239544, 24.319392" + inkscape:connector-curvature="0" + id="path8385" + stroke-miterlimit="10" + d="M 177.27556,413.58966 H 837.40573" /><g + id="g8391" + clip-path="url(#clipPath260)" + transform="matrix(1.3333,0,0,-1.3333,-143.35642,633.10417)"><text + style="font-style:italic;font-size:15.96000004px;font-family:'Century Gothic';fill:#3b3059" + id="text8389" + font-style="italic" + font-size="15.96px" + transform="matrix(1,0,0,-1,483.19,405.82)"><tspan + id="tspan8387" + y="0" + x="0 5.0114398 14.71512 24.45072 34.77684 40.299 43.522919 53.976719 63.712318 68.13324 78.459358 89.360039 92.583961 95.807877">function calls</tspan></text> +</g><path + style="fill:none;stroke:#3b3059;stroke-width:0.95997602;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:10" + inkscape:connector-curvature="0" + id="path8393" + stroke-miterlimit="10" + d="m 574.38564,303.03242 c -11.93304,0 -21.59946,-1.61329 -21.59946,-3.59991 V 164.62255 c 0,-1.98662 -9.66643,-3.59991 -21.59946,-3.59991 11.93303,0 21.59946,-1.61329 21.59946,-3.59991 v -18.30621 c 0,-1.98662 9.66642,-3.59991 21.59946,-3.59991" /><path + style="fill:none;stroke:#3b3059;stroke-width:0.95997602;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:10" + inkscape:connector-curvature="0" + id="path8395" + stroke-miterlimit="10" + d="m 372.63068,389.43026 c 13.293,0 24.0794,-1.79995 24.0794,-4.01323 v -91.53105 c 0,-2.21327 10.78639,-4.01323 24.0794,-4.01323 -13.29301,0 -24.0794,-1.79995 -24.0794,-4.01323 v -65.3717 c 0,-2.21328 -10.7864,-4.01323 -24.0794,-4.01323" /></svg> \ No newline at end of file diff --git a/doc/guides/contributing/stable.rst b/doc/guides/contributing/stable.rst index 6a5eee9..4d38bb8 100644 --- a/doc/guides/contributing/stable.rst +++ b/doc/guides/contributing/stable.rst @@ -1,7 +1,7 @@ .. SPDX-License-Identifier: BSD-3-Clause Copyright 2018 The DPDK contributors -.. stable_lts_releases: +.. _stable_lts_releases: DPDK Stable Releases and Long Term Support ========================================== @@ -53,6 +53,9 @@ year's November (X.11) release will be maintained as an LTS for 2 years. After the X.11 release, an LTS branch will be created for it at http://git.dpdk.org/dpdk-stable where bugfixes will be backported to. +A LTS release may align with the declaration of a new major ABI version, +please read the :doc:`abi_policy` for more information. + It is anticipated that there will be at least 4 releases per year of the LTS or approximately 1 every 3 months. However, the cadence can be shorter or longer depending on the number and criticality of the backported @@ -119,10 +122,3 @@ A Stable Release will be released by: list. Stable releases are available on the `dpdk.org download page <http://core.dpdk.org/download/>`_. - - -ABI ---- - -The Stable Release should not be seen as a way of breaking or circumventing -the DPDK ABI policy. -- 2.7.4 ^ permalink raw reply [flat|nested] 20+ messages in thread
* [dpdk-dev] [PATCH v10 3/3] doc: updates to versioning guide for abi versions 2019-11-11 10:37 ` [dpdk-dev] [PATCH v10 0/3] doc: changes to abi policy introducing major abi versions Ray Kinsella 2019-11-11 10:37 ` [dpdk-dev] [PATCH v10 1/3] doc: separate versioning.rst into version and policy Ray Kinsella 2019-11-11 10:37 ` [dpdk-dev] [PATCH v10 2/3] doc: changes to abi policy introducing major abi versions Ray Kinsella @ 2019-11-11 10:37 ` Ray Kinsella 2 siblings, 0 replies; 20+ messages in thread From: Ray Kinsella @ 2019-11-11 10:37 UTC (permalink / raw) To: dev Cc: mdr, thomas, stephen, bruce.richardson, ferruh.yigit, konstantin.ananyev, jerinj, olivier.matz, nhorman, maxime.coquelin, john.mcnamara, marko.kovacevic, hemant.agrawal, ktraynor, aconole Updates to the ABI versioning guide, to account for the changes to the DPDK ABI/API policy. Fixes for references to abi versioning and policy guides. Signed-off-by: Ray Kinsella <mdr@ashroe.eu> Acked-by: John Mcnamara <john.mcnamara@intel.com> Acked-by: Stephen Hemminger <stephen@networkplumber.org> --- doc/guides/contributing/abi_policy.rst | 15 +- doc/guides/contributing/abi_versioning.rst | 250 +++++++++++++++++++---------- doc/guides/contributing/patches.rst | 6 +- doc/guides/rel_notes/deprecation.rst | 6 +- 4 files changed, 183 insertions(+), 94 deletions(-) diff --git a/doc/guides/contributing/abi_policy.rst b/doc/guides/contributing/abi_policy.rst index 81b617c..05ca959 100644 --- a/doc/guides/contributing/abi_policy.rst +++ b/doc/guides/contributing/abi_policy.rst @@ -19,11 +19,11 @@ General Guidelines #. Major ABI versions are usually but not always declared aligned with a :ref:`LTS release <stable_lts_releases>`. #. The ABI version is managed at a project level in DPDK, and is reflected in - all non-experimental library's soname. + all non-experimental :ref:`library's soname <what_is_soname>`. #. The ABI should be preserved and not changed lightly. ABI changes must follow the outlined :ref:`deprecation process <abi_changes>`. #. The addition of symbols is generally not problematic. The modification of - symbols is managed with ABI Versioning. + symbols is managed with :ref:`ABI Versioning <abi_versioning>`. #. The removal of symbols is considered an :ref:`ABI breakage <abi_breakages>`, once approved these will form part of the next ABI version. #. Libraries or APIs marked as :ref:`experimental <experimental_apis>` may @@ -68,13 +68,14 @@ An ABI version is an instance of a library's ABI at a specific release. Certain releases are considered to be milestone releases, the yearly LTS release for example. The ABI of a milestone release may be declared as a 'major ABI version', where this ABI version is then supported for some number of subsequent -releases and is annotated in the library's soname. +releases and is annotated in the library's :ref:`soname<what_is_soname>`. ABI version support in subsequent releases facilitates application upgrades, by enabling applications built against the milestone release to upgrade to subsequent releases of a library without a rebuild. -More details on major ABI version can be found in the ABI Versioning guide. +More details on major ABI version can be found in the :ref:`ABI versioning +<major_abi_versions>` guide. The DPDK ABI policy ------------------- @@ -147,7 +148,7 @@ The requirements for changing the ABI are: CPU vendors, end-users, etc. #. Backward compatibility with the major ABI version must be maintained through - ABI Versioning, with :ref:`forward-only <forward-only>` compatibility + :ref:`abi_versioning`, with :ref:`forward-only <forward-only>` compatibility offered for any ABI changes that are indicated to be part of the next ABI version. @@ -224,7 +225,7 @@ declarations of major ABI versions. * DPDK 20.02 release defines a new function ``rte_foo(uint8_t bar)``, and this is not a problem as long as the symbol ``rte_foo@DPDK20`` is - preserved through ABI Versioning. + preserved through :ref:`abi_versioning`. - The new function may be marked with the ``__rte_experimental`` tag for a number of releases, as described in the section :ref:`experimental_apis`. @@ -322,5 +323,5 @@ Libraries Libraries marked as ``experimental`` are entirely not considered part of an ABI version, and may change without warning at any time. Experimental libraries always have a major version of ``0`` to indicate they exist outside of -ABI Versioning, with the minor version incremented with each ABI change +:ref:`abi_versioning` , with the minor version incremented with each ABI change to library. diff --git a/doc/guides/contributing/abi_versioning.rst b/doc/guides/contributing/abi_versioning.rst index 1c5612c..a3d5479 100644 --- a/doc/guides/contributing/abi_versioning.rst +++ b/doc/guides/contributing/abi_versioning.rst @@ -1,44 +1,134 @@ .. SPDX-License-Identifier: BSD-3-Clause Copyright 2018 The DPDK contributors -.. library_versioning: +.. _abi_versioning: -Library versioning +ABI Versioning +============== + +This document details the mechanics of ABI version management in DPDK. + +.. _what_is_soname: + +What is a library's soname? +--------------------------- + +System libraries usually adopt the familiar major and minor version naming +convention, where major versions (e.g. ``librte_eal 20.x, 21.x``) are presumed +to be ABI incompatible with each other and minor versions (e.g. ``librte_eal +20.1, 20.2``) are presumed to be ABI compatible. A library's `soname +<https://en.wikipedia.org/wiki/Soname>`_. is typically used to provide backward +compatibility information about a given library, describing the lowest common +denominator ABI supported by the library. The soname or logical name for the +library, is typically comprised of the library's name and major version e.g. +``librte_eal.so.20``. + +During an application's build process, a library's soname is noted as a runtime +dependency of the application. This information is then used by the `dynamic +linker <https://en.wikipedia.org/wiki/Dynamic_linker>`_ when resolving the +applications dependencies at runtime, to load a library supporting the correct +ABI version. The library loaded at runtime therefore, may be a minor revision +supporting the same major ABI version (e.g. ``librte_eal.20.2``), as the library +used to link the application (e.g ``librte_eal.20.0``). + +.. _major_abi_versions: + +Major ABI versions ------------------ -Downstreams might want to provide different DPDK releases at the same time to -support multiple consumers of DPDK linked against older and newer sonames. +An ABI version change to a given library, especially in core libraries such as +``librte_mbuf``, may cause an implicit ripple effect on the ABI of it's +consuming libraries, causing ABI breakages. There may however be no explicit +reason to bump a dependent library's ABI version, as there may have been no +obvious change to the dependent library's API, even though the library's ABI +compatibility will have been broken. + +This interdependence of DPDK libraries, means that ABI versioning of libraries +is more manageable at a project level, with all project libraries sharing a +**single ABI version**. In addition, the need to maintain a stable ABI for some +number of releases as described in the section :doc:`abi_policy`, means +that ABI version increments need to carefully planned and managed at a project +level. + +Major ABI versions are therefore declared typically aligned with an LTS release +and is then supported some number of subsequent releases, shared across all +libraries. This means that a single project level ABI version, reflected in all +individual library's soname, library filenames and associated version maps +persists over multiple releases. + +.. code-block:: none + + $ head ./lib/librte_acl/rte_acl_version.map + DPDK_20 { + global: + ... -Also due to the interdependencies that DPDK libraries can have applications -might end up with an executable space in which multiple versions of a library -are mapped by ld.so. + $ head ./lib/librte_eal/rte_eal_version.map + DPDK_20 { + global: + ... -Think of LibA that got an ABI bump and LibB that did not get an ABI bump but is -depending on LibA. +When an ABI change is made between major ABI versions to a given library, a new +section is added to that library's version map describing the impending new ABI +version, as described in the section :ref:`example_abi_macro_usage`. The +library's soname and filename however do not change, e.g. ``libacl.so.20``, as +ABI compatibility with the last major ABI version continues to be preserved for +that library. -.. note:: +.. code-block:: none - Application - \-> LibA.old - \-> LibB.new -> LibA.new + $ head ./lib/librte_acl/rte_acl_version.map + DPDK_20 { + global: + ... -That is a conflict which can be avoided by setting ``CONFIG_RTE_MAJOR_ABI``. -If set, the value of ``CONFIG_RTE_MAJOR_ABI`` overwrites all - otherwise per -library - versions defined in the libraries ``LIBABIVER``. -An example might be ``CONFIG_RTE_MAJOR_ABI=16.11`` which will make all libraries -``librte<?>.so.16.11`` instead of ``librte<?>.so.<LIBABIVER>``. + DPDK_21 { + global: + + } DPDK_20; + ... + $ head ./lib/librte_eal/rte_eal_version.map + DPDK_20 { + global: + ... + +However when a new ABI version is declared, for example DPDK ``21``, old +depreciated functions may be safely removed at this point and the entire old +major ABI version removed, see the section :ref:`deprecating_entire_abi` on +how this may be done. + +.. code-block:: none + + $ head ./lib/librte_acl/rte_acl_version.map + DPDK_21 { + global: + ... + + $ head ./lib/librte_eal/rte_eal_version.map + DPDK_21 { + global: + ... + +At the same time, the major ABI version is changed atomically across all +libraries by incrementing the major version in individual library's soname, e.g. +``libacl.so.21``. This is done by bumping the LIBABIVER number in the libraries +Makefile to indicate to dynamic linking applications that this is a later, and +possibly incompatible library version: + +.. code-block:: c + + -LIBABIVER := 20 + +LIBABIVER := 21 -ABI versioning --------------- Versioning Macros -~~~~~~~~~~~~~~~~~ +----------------- When a symbol is exported from a library to provide an API, it also provides a calling convention (ABI) that is embodied in its name, return type and arguments. Occasionally that function may need to change to accommodate new -functionality or behavior. When that occurs, it is desirable to allow for +functionality or behavior. When that occurs, it is may be required to allow for backward compatibility for a time with older binaries that are dynamically linked to the DPDK. @@ -61,8 +151,10 @@ The macros exported are: fully qualified function ``p``, so that if a symbol becomes versioned, it can still be mapped back to the public symbol name. +.. _example_abi_macro_usage: + Examples of ABI Macro use -^^^^^^^^^^^^^^^^^^^^^^^^^ +~~~~~~~~~~~~~~~~~~~~~~~~~ Updating a public API _____________________ @@ -106,16 +198,16 @@ maintain previous ABI versions that are accessible only to previously compiled binaries The addition of a parameter to the function is ABI breaking as the function is -public, and existing application may use it in its current form. However, the +public, and existing application may use it in its current form. However, the compatibility macros in DPDK allow a developer to use symbol versioning so that multiple functions can be mapped to the same public symbol based on when an -application was linked to it. To see how this is done, we start with the -requisite libraries version map file. Initially the version map file for the -acl library looks like this +application was linked to it. To see how this is done, we start with the +requisite libraries version map file. Initially the version map file for the acl +library looks like this .. code-block:: none - DPDK_2.0 { + DPDK_20 { global: rte_acl_add_rules; @@ -141,7 +233,7 @@ This file needs to be modified as follows .. code-block:: none - DPDK_2.0 { + DPDK_20 { global: rte_acl_add_rules; @@ -163,16 +255,16 @@ This file needs to be modified as follows local: *; }; - DPDK_2.1 { + DPDK_21 { global: rte_acl_create; - } DPDK_2.0; + } DPDK_20; The addition of the new block tells the linker that a new version node is -available (DPDK_2.1), which contains the symbol rte_acl_create, and inherits the -symbols from the DPDK_2.0 node. This list is directly translated into a list of -exported symbols when DPDK is compiled as a shared library +available (DPDK_21), which contains the symbol rte_acl_create, and inherits +the symbols from the DPDK_20 node. This list is directly translated into a +list of exported symbols when DPDK is compiled as a shared library Next, we need to specify in the code which function map to the rte_acl_create symbol at which versions. First, at the site of the initial symbol definition, @@ -191,22 +283,22 @@ with the public symbol name Note that the base name of the symbol was kept intact, as this is conducive to the macros used for versioning symbols. That is our next step, mapping this new -symbol name to the initial symbol name at version node 2.0. Immediately after +symbol name to the initial symbol name at version node 20. Immediately after the function, we add this line of code .. code-block:: c - VERSION_SYMBOL(rte_acl_create, _v20, 2.0); + VERSION_SYMBOL(rte_acl_create, _v20, 20); -Remembering to also add the rte_function_versioning.h header to the requisite c file where -these changes are being made. The above macro instructs the linker to create a -new symbol ``rte_acl_create@DPDK_2.0``, which matches the symbol created in older -builds, but now points to the above newly named function. We have now mapped -the original rte_acl_create symbol to the original function (but with a new -name) +Remembering to also add the rte_function_versioning.h header to the requisite c +file where these changes are being made. The above macro instructs the linker to +create a new symbol ``rte_acl_create@DPDK_20``, which matches the symbol created +in older builds, but now points to the above newly named function. We have now +mapped the original rte_acl_create symbol to the original function (but with a +new name). -Next, we need to create the 2.1 version of the symbol. We create a new function -name, with a different suffix, and implement it appropriately +Next, we need to create the 21 version of the symbol. We create a new function +name, with a different suffix, and implement it appropriately .. code-block:: c @@ -220,12 +312,12 @@ name, with a different suffix, and implement it appropriately return ctx; } -This code serves as our new API call. Its the same as our old call, but adds -the new parameter in place. Next we need to map this function to the symbol -``rte_acl_create@DPDK_2.1``. To do this, we modify the public prototype of the call -in the header file, adding the macro there to inform all including applications, -that on re-link, the default rte_acl_create symbol should point to this -function. Note that we could do this by simply naming the function above +This code serves as our new API call. Its the same as our old call, but adds the +new parameter in place. Next we need to map this function to the symbol +``rte_acl_create@DPDK_21``. To do this, we modify the public prototype of the +call in the header file, adding the macro there to inform all including +applications, that on re-link, the default rte_acl_create symbol should point to +this function. Note that we could do this by simply naming the function above rte_acl_create, and the linker would chose the most recent version tag to apply in the version script, but we can also do this in the header file @@ -233,11 +325,11 @@ in the version script, but we can also do this in the header file struct rte_acl_ctx * -rte_acl_create(const struct rte_acl_param *param); - +rte_acl_create(const struct rte_acl_param *param, int debug); - +BIND_DEFAULT_SYMBOL(rte_acl_create, _v21, 2.1); + +rte_acl_create_v21(const struct rte_acl_param *param, int debug); + +BIND_DEFAULT_SYMBOL(rte_acl_create, _v21, 21); The BIND_DEFAULT_SYMBOL macro explicitly tells applications that include this -header, to link to the rte_acl_create_v21 function and apply the DPDK_2.1 +header, to link to the rte_acl_create_v21 function and apply the DPDK_21 version node to it. This method is more explicit and flexible than just re-implementing the exact symbol name, and allows for other features (such as linking to the old symbol version by default, when the new ABI is to be opt-in @@ -257,6 +349,7 @@ assumption is that the most recent version of the symbol is the one you want to map. So, back in the C file where, immediately after ``rte_acl_create_v21`` is defined, we add this + .. code-block:: c struct rte_acl_ctx * @@ -270,21 +363,22 @@ That tells the compiler that, when building a static library, any calls to the symbol ``rte_acl_create`` should be linked to ``rte_acl_create_v21`` That's it, on the next shared library rebuild, there will be two versions of -rte_acl_create, an old DPDK_2.0 version, used by previously built applications, -and a new DPDK_2.1 version, used by future built applications. +rte_acl_create, an old DPDK_20 version, used by previously built applications, +and a new DPDK_21 version, used by future built applications. Deprecating part of a public API ________________________________ -Lets assume that you've done the above update, and after a few releases have -passed you decide you would like to retire the old version of the function. -After having gone through the ABI deprecation announcement process, removal is -easy. Start by removing the symbol from the requisite version map file: +Lets assume that you've done the above update, and in preparation for the next +major ABI version you decide you would like to retire the old version of the +function. After having gone through the ABI deprecation announcement process, +removal is easy. Start by removing the symbol from the requisite version map +file: .. code-block:: none - DPDK_2.0 { + DPDK_20 { global: rte_acl_add_rules; @@ -306,48 +400,42 @@ easy. Start by removing the symbol from the requisite version map file: local: *; }; - DPDK_2.1 { + DPDK_21 { global: rte_acl_create; - } DPDK_2.0; + } DPDK_20; Next remove the corresponding versioned export. .. code-block:: c - -VERSION_SYMBOL(rte_acl_create, _v20, 2.0); + -VERSION_SYMBOL(rte_acl_create, _v20, 20); Note that the internal function definition could also be removed, but its used -in our example by the newer version _v21, so we leave it in place. This is a -coding style choice. - -Lastly, we need to bump the LIBABIVER number for this library in the Makefile to -indicate to applications doing dynamic linking that this is a later, and -possibly incompatible library version: - -.. code-block:: c +in our example by the newer version v21, so we leave it in place and declare it +as static. This is a coding style choice. - -LIBABIVER := 1 - +LIBABIVER := 2 +.. _deprecating_entire_abi: Deprecating an entire ABI version _________________________________ -While removing a symbol from and ABI may be useful, it is often more practical -to remove an entire version node at once. If a version node completely -specifies an API, then removing part of it, typically makes it incomplete. In -those cases it is better to remove the entire node +While removing a symbol from an ABI may be useful, it is more practical to +remove an entire version node at once, as is typically done at the declaration +of a major ABI version. If a version node completely specifies an API, then +removing part of it, typically makes it incomplete. In those cases it is better +to remove the entire node. To do this, start by modifying the version map file, such that all symbols from -the node to be removed are merged into the next node in the map +the node to be removed are merged into the next node in the map. In the case of our map above, it would transform to look as follows .. code-block:: none - DPDK_2.1 { + DPDK_21 { global: rte_acl_add_rules; @@ -375,8 +463,8 @@ symbols. .. code-block:: c - -BIND_DEFAULT_SYMBOL(rte_acl_create, _v20, 2.0); - +BIND_DEFAULT_SYMBOL(rte_acl_create, _v21, 2.1); + -BIND_DEFAULT_SYMBOL(rte_acl_create, _v20, 20); + +BIND_DEFAULT_SYMBOL(rte_acl_create, _v21, 21); Lastly, any VERSION_SYMBOL macros that point to the old version node should be removed, taking care to keep, where need old code in place to support newer diff --git a/doc/guides/contributing/patches.rst b/doc/guides/contributing/patches.rst index c9ec529..2140303 100644 --- a/doc/guides/contributing/patches.rst +++ b/doc/guides/contributing/patches.rst @@ -156,9 +156,9 @@ Make your planned changes in the cloned ``dpdk`` repo. Here are some guidelines * For other PMDs and more info, refer to the ``MAINTAINERS`` file. -* New external functions should be added to the local ``version.map`` file. - See the :doc:`Guidelines for ABI policy and versioning </contributing/abi_versioning>`. - New external functions should also be added in alphabetical order. +* New external functions should be added to the local ``version.map`` file. See + the :doc:`ABI policy <abi_policy>` and :ref:`ABI versioning <abi_versioning>` + guides. New external functions should also be added in alphabetical order. * Important changes will require an addition to the release notes in ``doc/guides/rel_notes/``. See the :ref:`Release Notes section of the Documentation Guidelines <doc_guidelines>` for details. diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst index cf37d80..d454915 100644 --- a/doc/guides/rel_notes/deprecation.rst +++ b/doc/guides/rel_notes/deprecation.rst @@ -4,9 +4,9 @@ ABI and API Deprecation ======================= -See the :doc:`guidelines document for details of the ABI policy </contributing/abi_versioning>`. -API and ABI deprecation notices are to be posted here. - +See the guidelines document for details of the :doc:`ABI policy +<../contributing/abi_policy>`. API and ABI deprecation notices are to be posted +here. Deprecation Notices ------------------- -- 2.7.4 ^ permalink raw reply [flat|nested] 20+ messages in thread
* [dpdk-dev] [PATCH v11 0/3] doc: changes to abi policy introducing major abi versions 2019-11-08 12:46 [dpdk-dev] [PATCH v9 0/4] doc: changes to abi policy introducing major abi versions Ray Kinsella ` (4 preceding siblings ...) 2019-11-11 10:37 ` [dpdk-dev] [PATCH v10 0/3] doc: changes to abi policy introducing major abi versions Ray Kinsella @ 2019-11-11 11:57 ` Ray Kinsella 2019-11-11 11:57 ` [dpdk-dev] [PATCH v11 1/3] doc: separate versioning.rst into version and policy Ray Kinsella ` (3 more replies) 5 siblings, 4 replies; 20+ messages in thread From: Ray Kinsella @ 2019-11-11 11:57 UTC (permalink / raw) To: dev Cc: mdr, thomas, stephen, bruce.richardson, ferruh.yigit, konstantin.ananyev, jerinj, olivier.matz, nhorman, maxime.coquelin, john.mcnamara, marko.kovacevic, hemant.agrawal, ktraynor, aconole TL;DR abbreviation: A major ABI version that all DPDK releases during an agreed period support. ABI versioning is managed at a project-level, in place of library-level management. ABI changes to add new features are permitted, as long as ABI compatibility with the major ABI version is maintained. Detail: This patch introduces major ABI versions, initally released aligned with the LTS release and maintained for one year through subsequent releases. The intention is that the one year abi support period, will then be reviewed after the initial year with the intention of lengthening the period for the next ABI version and declaring new major ABI versions less frequently. ABI changes that preserve ABI compatibility with the major ABI version are permitted in subsequent releases. ABI changes, follow similar approval rules as before with the additional gate of now requiring technical board approval. The merging and release of ABI breaking changes would now be pushed to the declaration of the next major ABI version. This change encourages developers to maintain ABI compatibility with the major ABI version, by promoting a permissive culture around those changes that preserve ABI compatibility. This approach begins to align DPDK with those projects that declare major ABI versions (e.g. version 2.x, 3.x) and support those versions for some period, typically two years or more. To provide an example of how this might work in practice: * DPDK v20 is declared as the supported ABI version for one year, aligned with the DPDK v19.11 (LTS) release. All library sonames are updated to reflect the new ABI version, e.g. librte_eal.so.20, librte_acl.so.20... * DPDK v20.02 .. v20.08 releases are ABI compatible with the DPDK v20 ABI. ABI changes are permitted from DPDK v20.02 onwards, with the condition that ABI compatibility with DPDK v20 is preserved. * DPDK v21 is declared as the new supported ABI version for two years, aligned with the DPDK v20.11 (LTS) release. The DPDK v20 ABI is now depreciated, library sonames are updated to v21 and ABI compatibility breaking changes may be introduced. v11 * Neglected to rebase the v10 onto origin/master, fixed in v11. v10 * Fixed the upwording on experimental libraries in summary. v9 * Loosened up word around when new major ABI's are declared. (as suggested by Thomas Monjalon and agreed at the Techboard) v8 * Fixed intermediate build warnings, figure annotations and typo's. (as suggested by John McNamara). v7 * PNGs are now SVG. Some additional clarifications. Fixed typos and grammatical errors. (as suggested by Thomas Monjalon and David Marchand) v6 * Added figure to abi_policy.rst, comparing and contrasting the DPDK abi and api. (as suggested by Aaron Conole) v5 * Added figure to abi_policy.rst, mapping abi versions and abi compatibility to DPDK releases. (as suggested by Neil Horman) v4 * Removed changes to stable.rst, fixed typos and clarified the ABI policy "warning". v3 * Added myself as the maintainer of the ABI policy. * Updated the policy and versioning guides to use the year of the LTS+1 (e.g. v20), as the abi major version number. v2 * Restructured the patch into 3 patches: 1. Splits the original versioning document into an ABI policy document and ABI versioning document. 2. Add changes to the policy document introducing major ABI versions. 3. Fixes up the versioning document in light of major ABI versioning. * Reduces the initial ABI stability from two years to one year, with a review after the first year. * Adds detail around ABI version handling for experimental libraries. * Adds detail around chain of responsility for removing deprecated symbols. Ray Kinsella (3): doc: separate versioning.rst into version and policy doc: changes to abi policy introducing major abi versions doc: updates to versioning guide for abi versions MAINTAINERS | 4 + doc/guides/contributing/abi_policy.rst | 327 ++++++ doc/guides/contributing/abi_versioning.rst | 521 ++++++++++ .../contributing/img/abi_stability_policy.svg | 1059 ++++++++++++++++++++ doc/guides/contributing/img/what_is_an_abi.svg | 382 +++++++ doc/guides/contributing/index.rst | 3 +- doc/guides/contributing/patches.rst | 6 +- doc/guides/contributing/stable.rst | 12 +- doc/guides/contributing/versioning.rst | 597 ----------- doc/guides/rel_notes/deprecation.rst | 6 +- 10 files changed, 2305 insertions(+), 612 deletions(-) create mode 100644 doc/guides/contributing/abi_policy.rst create mode 100644 doc/guides/contributing/abi_versioning.rst create mode 100644 doc/guides/contributing/img/abi_stability_policy.svg create mode 100644 doc/guides/contributing/img/what_is_an_abi.svg delete mode 100644 doc/guides/contributing/versioning.rst -- 2.7.4 ^ permalink raw reply [flat|nested] 20+ messages in thread
* [dpdk-dev] [PATCH v11 1/3] doc: separate versioning.rst into version and policy 2019-11-11 11:57 ` [dpdk-dev] [PATCH v11 0/3] doc: changes to abi policy introducing major " Ray Kinsella @ 2019-11-11 11:57 ` Ray Kinsella 2019-11-11 11:57 ` [dpdk-dev] [PATCH v11 2/3] doc: changes to abi policy introducing major abi versions Ray Kinsella ` (2 subsequent siblings) 3 siblings, 0 replies; 20+ messages in thread From: Ray Kinsella @ 2019-11-11 11:57 UTC (permalink / raw) To: dev Cc: mdr, thomas, stephen, bruce.richardson, ferruh.yigit, konstantin.ananyev, jerinj, olivier.matz, nhorman, maxime.coquelin, john.mcnamara, marko.kovacevic, hemant.agrawal, ktraynor, aconole Separate versioning.rst into abi versioning and abi policy guidance, in preparation for adding more detail to the abi policy. Add an entry to the maintainer file for the abi policy. Signed-off-by: Ray Kinsella <mdr@ashroe.eu> Acked-by: John Mcnamara <john.mcnamara@intel.com> Acked-by: Stephen Hemminger <stephen@networkplumber.org> --- MAINTAINERS | 4 + doc/guides/contributing/abi_policy.rst | 167 ++++++++ doc/guides/contributing/abi_versioning.rst | 433 +++++++++++++++++++++ doc/guides/contributing/index.rst | 3 +- doc/guides/contributing/patches.rst | 2 +- doc/guides/contributing/versioning.rst | 597 ----------------------------- doc/guides/rel_notes/deprecation.rst | 2 +- 7 files changed, 608 insertions(+), 600 deletions(-) create mode 100644 doc/guides/contributing/abi_policy.rst create mode 100644 doc/guides/contributing/abi_versioning.rst delete mode 100644 doc/guides/contributing/versioning.rst diff --git a/MAINTAINERS b/MAINTAINERS index e8d79ea..aedb593 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -84,6 +84,10 @@ M: Marko Kovacevic <marko.kovacevic@intel.com> F: README F: doc/ +ABI Policy +M: Ray Kinsella <mdr@ashroe.eu> +F: doc/guides/contributing/abi_*.rst + Developers and Maintainers Tools M: Thomas Monjalon <thomas@monjalon.net> F: MAINTAINERS diff --git a/doc/guides/contributing/abi_policy.rst b/doc/guides/contributing/abi_policy.rst new file mode 100644 index 0000000..d4f4e9f --- /dev/null +++ b/doc/guides/contributing/abi_policy.rst @@ -0,0 +1,167 @@ +.. SPDX-License-Identifier: BSD-3-Clause + Copyright 2018 The DPDK contributors + +DPDK ABI/API policy +=================== + +Description +----------- + +This document details some methods for handling ABI management in the DPDK. + +General Guidelines +------------------ + +#. Whenever possible, ABI should be preserved +#. ABI/API may be changed with a deprecation process +#. The modification of symbols can generally be managed with versioning +#. Libraries or APIs marked in ``experimental`` state may change without constraint +#. New APIs will be marked as ``experimental`` for at least one release to allow + any issues found by users of the new API to be fixed quickly +#. The addition of symbols is generally not problematic +#. The removal of symbols generally is an ABI break and requires bumping of the + LIBABIVER macro +#. Updates to the minimum hardware requirements, which drop support for hardware which + was previously supported, should be treated as an ABI change. + +What is an ABI +~~~~~~~~~~~~~~ + +An ABI (Application Binary Interface) is the set of runtime interfaces exposed +by a library. It is similar to an API (Application Programming Interface) but +is the result of compilation. It is also effectively cloned when applications +link to dynamic libraries. That is to say when an application is compiled to +link against dynamic libraries, it is assumed that the ABI remains constant +between the time the application is compiled/linked, and the time that it runs. +Therefore, in the case of dynamic linking, it is critical that an ABI is +preserved, or (when modified), done in such a way that the application is unable +to behave improperly or in an unexpected fashion. + + +ABI/API Deprecation +------------------- + +The DPDK ABI policy +~~~~~~~~~~~~~~~~~~~ + +ABI versions are set at the time of major release labeling, and the ABI may +change multiple times, without warning, between the last release label and the +HEAD label of the git tree. + +ABI versions, once released, are available until such time as their +deprecation has been noted in the Release Notes for at least one major release +cycle. For example consider the case where the ABI for DPDK 2.0 has been +shipped and then a decision is made to modify it during the development of +DPDK 2.1. The decision will be recorded in the Release Notes for the DPDK 2.1 +release and the modification will be made available in the DPDK 2.2 release. + +ABI versions may be deprecated in whole or in part as needed by a given +update. + +Some ABI changes may be too significant to reasonably maintain multiple +versions. In those cases ABI's may be updated without backward compatibility +being provided. The requirements for doing so are: + +#. At least 3 acknowledgments of the need to do so must be made on the + dpdk.org mailing list. + + - The acknowledgment of the maintainer of the component is mandatory, or if + no maintainer is available for the component, the tree/sub-tree maintainer + for that component must acknowledge the ABI change instead. + + - It is also recommended that acknowledgments from different "areas of + interest" be sought for each deprecation, for example: from NIC vendors, + CPU vendors, end-users, etc. + +#. The changes (including an alternative map file) can be included with + deprecation notice, in wrapped way by the ``RTE_NEXT_ABI`` option, + to provide more details about oncoming changes. + ``RTE_NEXT_ABI`` wrapper will be removed when it become the default ABI. + More preferred way to provide this information is sending the feature + as a separate patch and reference it in deprecation notice. + +#. A full deprecation cycle, as explained above, must be made to offer + downstream consumers sufficient warning of the change. + +Note that the above process for ABI deprecation should not be undertaken +lightly. ABI stability is extremely important for downstream consumers of the +DPDK, especially when distributed in shared object form. Every effort should +be made to preserve the ABI whenever possible. The ABI should only be changed +for significant reasons, such as performance enhancements. ABI breakage due to +changes such as reorganizing public structure fields for aesthetic or +readability purposes should be avoided. + +.. note:: + + Updates to the minimum hardware requirements, which drop support for hardware + which was previously supported, should be treated as an ABI change, and + follow the relevant deprecation policy procedures as above: 3 acks and + announcement at least one release in advance. + +Examples of Deprecation Notices +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The following are some examples of ABI deprecation notices which would be +added to the Release Notes: + +* The Macro ``#RTE_FOO`` is deprecated and will be removed with version 2.0, + to be replaced with the inline function ``rte_foo()``. + +* The function ``rte_mbuf_grok()`` has been updated to include a new parameter + in version 2.0. Backwards compatibility will be maintained for this function + until the release of version 2.1 + +* The members of ``struct rte_foo`` have been reorganized in release 2.0 for + performance reasons. Existing binary applications will have backwards + compatibility in release 2.0, while newly built binaries will need to + reference the new structure variant ``struct rte_foo2``. Compatibility will + be removed in release 2.2, and all applications will require updating and + rebuilding to the new structure at that time, which will be renamed to the + original ``struct rte_foo``. + +* Significant ABI changes are planned for the ``librte_dostuff`` library. The + upcoming release 2.0 will not contain these changes, but release 2.1 will, + and no backwards compatibility is planned due to the extensive nature of + these changes. Binaries using this library built prior to version 2.1 will + require updating and recompilation. + +New API replacing previous one +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +If a new API proposed functionally replaces an existing one, when the new API +becomes non-experimental then the old one is marked with ``__rte_deprecated``. +Deprecated APIs are removed completely just after the next LTS. + +Reminder that old API should follow deprecation process to be removed. + + +Experimental APIs +----------------- + +APIs marked as ``experimental`` are not considered part of the ABI and may +change without warning at any time. Since changes to APIs are most likely +immediately after their introduction, as users begin to take advantage of +those new APIs and start finding issues with them, new DPDK APIs will be +automatically marked as ``experimental`` to allow for a period of stabilization +before they become part of a tracked ABI. + +Note that marking an API as experimental is a multi step process. +To mark an API as experimental, the symbols which are desired to be exported +must be placed in an EXPERIMENTAL version block in the corresponding libraries' +version map script. +Secondly, the corresponding prototypes of those exported functions (in the +development header files), must be marked with the ``__rte_experimental`` tag +(see ``rte_compat.h``). +The DPDK build makefiles perform a check to ensure that the map file and the +C code reflect the same list of symbols. +This check can be circumvented by defining ``ALLOW_EXPERIMENTAL_API`` +during compilation in the corresponding library Makefile. + +In addition to tagging the code with ``__rte_experimental``, +the doxygen markup must also contain the EXPERIMENTAL string, +and the MAINTAINERS file should note the EXPERIMENTAL libraries. + +For removing the experimental tag associated with an API, deprecation notice +is not required. Though, an API should remain in experimental state for at least +one release. Thereafter, normal process of posting patch for review to mailing +list can be followed. diff --git a/doc/guides/contributing/abi_versioning.rst b/doc/guides/contributing/abi_versioning.rst new file mode 100644 index 0000000..d278de4 --- /dev/null +++ b/doc/guides/contributing/abi_versioning.rst @@ -0,0 +1,433 @@ +.. SPDX-License-Identifier: BSD-3-Clause + Copyright 2018 The DPDK contributors + +.. library_versioning: + +Library versioning +------------------ + +Downstreams might want to provide different DPDK releases at the same time to +support multiple consumers of DPDK linked against older and newer sonames. + +Also due to the interdependencies that DPDK libraries can have applications +might end up with an executable space in which multiple versions of a library +are mapped by ld.so. + +Think of LibA that got an ABI bump and LibB that did not get an ABI bump but is +depending on LibA. + +.. note:: + + Application + \-> LibA.old + \-> LibB.new -> LibA.new + +That is a conflict which can be avoided by setting ``CONFIG_RTE_MAJOR_ABI``. +If set, the value of ``CONFIG_RTE_MAJOR_ABI`` overwrites all - otherwise per +library - versions defined in the libraries ``LIBABIVER``. +An example might be ``CONFIG_RTE_MAJOR_ABI=16.11`` which will make all libraries +``librte<?>.so.16.11`` instead of ``librte<?>.so.<LIBABIVER>``. + + +ABI versioning +-------------- + +Versioning Macros +~~~~~~~~~~~~~~~~~ + +When a symbol is exported from a library to provide an API, it also provides a +calling convention (ABI) that is embodied in its name, return type and +arguments. Occasionally that function may need to change to accommodate new +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 ``rte_function_versioning.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 +library so that older binaries need not be immediately recompiled. + +The macros exported are: + +* ``VERSION_SYMBOL(b, e, n)``: Creates a symbol version table entry binding + versioned symbol ``b@DPDK_n`` to the internal function ``be``. + +* ``BIND_DEFAULT_SYMBOL(b, e, n)``: Creates a symbol version entry instructing + the linker to bind references to symbol ``b`` to the internal symbol + ``be``. + +* ``MAP_STATIC_SYMBOL(f, p)``: Declare the prototype ``f``, and map it to the + fully qualified function ``p``, so that if a symbol becomes versioned, it + can still be mapped back to the public symbol name. + +* ``__vsym``: Annotation to be used in a declaration of the internal symbol + ``be`` to signal that it is being used as an implementation of a particular + version of symbol ``b``. + +Examples of ABI Macro use +^^^^^^^^^^^^^^^^^^^^^^^^^ + +Updating a public API +_____________________ + +Assume we have a function as follows + +.. code-block:: c + + /* + * Create an acl context object for apps to + * manipulate + */ + struct rte_acl_ctx * + rte_acl_create(const struct rte_acl_param *param) + { + ... + } + + +Assume that struct rte_acl_ctx is a private structure, and that a developer +wishes to enhance the acl api so that a debugging flag can be enabled on a +per-context basis. This requires an addition to the structure (which, being +private, is safe), but it also requires modifying the code as follows + +.. code-block:: c + + /* + * Create an acl context object for apps to + * manipulate + */ + struct rte_acl_ctx * + rte_acl_create(const struct rte_acl_param *param, int debug) + { + ... + } + + +Note also that, being a public function, the header file prototype must also be +changed, as must all the call sites, to reflect the new ABI footprint. We will +maintain previous ABI versions that are accessible only to previously compiled +binaries + +The addition of a parameter to the function is ABI breaking as the function is +public, and existing application may use it in its current form. However, the +compatibility macros in DPDK allow a developer to use symbol versioning so that +multiple functions can be mapped to the same public symbol based on when an +application was linked to it. To see how this is done, we start with the +requisite libraries version map file. Initially the version map file for the +acl library looks like this + +.. code-block:: none + + DPDK_2.0 { + global: + + rte_acl_add_rules; + rte_acl_build; + rte_acl_classify; + rte_acl_classify_alg; + rte_acl_classify_scalar; + rte_acl_create; + rte_acl_dump; + rte_acl_find_existing; + rte_acl_free; + rte_acl_ipv4vlan_add_rules; + rte_acl_ipv4vlan_build; + rte_acl_list_dump; + rte_acl_reset; + rte_acl_reset_rules; + rte_acl_set_ctx_classify; + + local: *; + }; + +This file needs to be modified as follows + +.. code-block:: none + + DPDK_2.0 { + global: + + rte_acl_add_rules; + rte_acl_build; + rte_acl_classify; + rte_acl_classify_alg; + rte_acl_classify_scalar; + rte_acl_create; + rte_acl_dump; + rte_acl_find_existing; + rte_acl_free; + rte_acl_ipv4vlan_add_rules; + rte_acl_ipv4vlan_build; + rte_acl_list_dump; + rte_acl_reset; + rte_acl_reset_rules; + rte_acl_set_ctx_classify; + + local: *; + }; + + DPDK_2.1 { + global: + rte_acl_create; + + } DPDK_2.0; + +The addition of the new block tells the linker that a new version node is +available (DPDK_2.1), which contains the symbol rte_acl_create, and inherits the +symbols from the DPDK_2.0 node. This list is directly translated into a list of +exported symbols when DPDK is compiled as a shared library + +Next, we need to specify in the code which function map to the rte_acl_create +symbol at which versions. First, at the site of the initial symbol definition, +we need to update the function so that it is uniquely named, and not in conflict +with the public symbol name + +.. code-block:: c + + -struct rte_acl_ctx * + -rte_acl_create(const struct rte_acl_param *param) + +struct rte_acl_ctx * __vsym + +rte_acl_create_v20(const struct rte_acl_param *param) + { + size_t sz; + struct rte_acl_ctx *ctx; + ... + +Note that the base name of the symbol was kept intact, as this is conducive to +the macros used for versioning symbols and we have annotated the function as an +implementation of versioned symbol. That is our next step, mapping this new +symbol name to the initial symbol name at version node 2.0. Immediately after +the function, we add this line of code + +.. code-block:: c + + VERSION_SYMBOL(rte_acl_create, _v20, 2.0); + +Remembering to also add the rte_function_versioning.h header to the requisite c file where +these changes are being made. The above macro instructs the linker to create a +new symbol ``rte_acl_create@DPDK_2.0``, which matches the symbol created in older +builds, but now points to the above newly named function. We have now mapped +the original rte_acl_create symbol to the original function (but with a new +name) + +Next, we need to create the 2.1 version of the symbol. We create a new function +name, with a different suffix, and implement it appropriately + +.. code-block:: c + + struct rte_acl_ctx * __vsym + rte_acl_create_v21(const struct rte_acl_param *param, int debug); + { + struct rte_acl_ctx *ctx = rte_acl_create_v20(param); + + ctx->debug = debug; + + return ctx; + } + +This code serves as our new API call. Its the same as our old call, but adds +the new parameter in place. Next we need to map this function to the symbol +``rte_acl_create@DPDK_2.1``. To do this, we modify the public prototype of the call +in the header file, adding the macro there to inform all including applications, +that on re-link, the default rte_acl_create symbol should point to this +function. Note that we could do this by simply naming the function above +rte_acl_create, and the linker would chose the most recent version tag to apply +in the version script, but we can also do this in the header file + +.. code-block:: c + + struct rte_acl_ctx * + -rte_acl_create(const struct rte_acl_param *param); + +rte_acl_create(const struct rte_acl_param *param, int debug); + +BIND_DEFAULT_SYMBOL(rte_acl_create, _v21, 2.1); + +The BIND_DEFAULT_SYMBOL macro explicitly tells applications that include this +header, to link to the rte_acl_create_v21 function and apply the DPDK_2.1 +version node to it. This method is more explicit and flexible than just +re-implementing the exact symbol name, and allows for other features (such as +linking to the old symbol version by default, when the new ABI is to be opt-in +for a period. + +One last thing we need to do. Note that we've taken what was a public symbol, +and duplicated it into two uniquely and differently named symbols. We've then +mapped each of those back to the public symbol ``rte_acl_create`` with different +version tags. This only applies to dynamic linking, as static linking has no +notion of versioning. That leaves this code in a position of no longer having a +symbol simply named ``rte_acl_create`` and a static build will fail on that +missing symbol. + +To correct this, we can simply map a function of our choosing back to the public +symbol in the static build with the ``MAP_STATIC_SYMBOL`` macro. Generally the +assumption is that the most recent version of the symbol is the one you want to +map. So, back in the C file where, immediately after ``rte_acl_create_v21`` is +defined, we add this + +.. code-block:: c + + struct rte_acl_ctx * __vsym + rte_acl_create_v21(const struct rte_acl_param *param, int debug) + { + ... + } + MAP_STATIC_SYMBOL(struct rte_acl_ctx *rte_acl_create(const struct rte_acl_param *param, int debug), rte_acl_create_v21); + +That tells the compiler that, when building a static library, any calls to the +symbol ``rte_acl_create`` should be linked to ``rte_acl_create_v21`` + +That's it, on the next shared library rebuild, there will be two versions of +rte_acl_create, an old DPDK_2.0 version, used by previously built applications, +and a new DPDK_2.1 version, used by future built applications. + + +Deprecating part of a public API +________________________________ + +Lets assume that you've done the above update, and after a few releases have +passed you decide you would like to retire the old version of the function. +After having gone through the ABI deprecation announcement process, removal is +easy. Start by removing the symbol from the requisite version map file: + +.. code-block:: none + + DPDK_2.0 { + global: + + rte_acl_add_rules; + rte_acl_build; + rte_acl_classify; + rte_acl_classify_alg; + rte_acl_classify_scalar; + rte_acl_dump; + - rte_acl_create + rte_acl_find_existing; + rte_acl_free; + rte_acl_ipv4vlan_add_rules; + rte_acl_ipv4vlan_build; + rte_acl_list_dump; + rte_acl_reset; + rte_acl_reset_rules; + rte_acl_set_ctx_classify; + + local: *; + }; + + DPDK_2.1 { + global: + rte_acl_create; + } DPDK_2.0; + + +Next remove the corresponding versioned export. + +.. code-block:: c + + -VERSION_SYMBOL(rte_acl_create, _v20, 2.0); + + +Note that the internal function definition could also be removed, but its used +in our example by the newer version _v21, so we leave it in place. This is a +coding style choice. + +Lastly, we need to bump the LIBABIVER number for this library in the Makefile to +indicate to applications doing dynamic linking that this is a later, and +possibly incompatible library version: + +.. code-block:: c + + -LIBABIVER := 1 + +LIBABIVER := 2 + +Deprecating an entire ABI version +_________________________________ + +While removing a symbol from and ABI may be useful, it is often more practical +to remove an entire version node at once. If a version node completely +specifies an API, then removing part of it, typically makes it incomplete. In +those cases it is better to remove the entire node + +To do this, start by modifying the version map file, such that all symbols from +the node to be removed are merged into the next node in the map + +In the case of our map above, it would transform to look as follows + +.. code-block:: none + + DPDK_2.1 { + global: + + rte_acl_add_rules; + rte_acl_build; + rte_acl_classify; + rte_acl_classify_alg; + rte_acl_classify_scalar; + rte_acl_dump; + rte_acl_create + rte_acl_find_existing; + rte_acl_free; + rte_acl_ipv4vlan_add_rules; + rte_acl_ipv4vlan_build; + rte_acl_list_dump; + rte_acl_reset; + rte_acl_reset_rules; + rte_acl_set_ctx_classify; + + local: *; + }; + +Then any uses of BIND_DEFAULT_SYMBOL that pointed to the old node should be +updated to point to the new version node in any header files for all affected +symbols. + +.. code-block:: c + + -BIND_DEFAULT_SYMBOL(rte_acl_create, _v20, 2.0); + +BIND_DEFAULT_SYMBOL(rte_acl_create, _v21, 2.1); + +Lastly, any VERSION_SYMBOL macros that point to the old version node should be +removed, taking care to keep, where need old code in place to support newer +versions of the symbol. + + +Running the ABI Validator +------------------------- + +The ``devtools`` directory in the DPDK source tree contains a utility program, +``validate-abi.sh``, for validating the DPDK ABI based on the Linux `ABI +Compliance Checker +<http://ispras.linuxbase.org/index.php/ABI_compliance_checker>`_. + +This has a dependency on the ``abi-compliance-checker`` and ``and abi-dumper`` +utilities which can be installed via a package manager. For example:: + + sudo yum install abi-compliance-checker + sudo yum install abi-dumper + +The syntax of the ``validate-abi.sh`` utility is:: + + ./devtools/validate-abi.sh <REV1> <REV2> + +Where ``REV1`` and ``REV2`` are valid gitrevisions(7) +https://www.kernel.org/pub/software/scm/git/docs/gitrevisions.html +on the local repo. + +For example:: + + # Check between the previous and latest commit: + ./devtools/validate-abi.sh HEAD~1 HEAD + + # Check on a specific compilation target: + ./devtools/validate-abi.sh -t x86_64-native-linux-gcc HEAD~1 HEAD + + # Check between two tags: + ./devtools/validate-abi.sh v2.0.0 v2.1.0 + + # Check between git master and local topic-branch "vhost-hacking": + ./devtools/validate-abi.sh master vhost-hacking + +After the validation script completes (it can take a while since it need to +compile both tags) it will create compatibility reports in the +``./abi-check/compat_report`` directory. Listed incompatibilities can be found +as follows:: + + grep -lr Incompatible abi-check/compat_reports/ diff --git a/doc/guides/contributing/index.rst b/doc/guides/contributing/index.rst index e2608d3..2fefd91 100644 --- a/doc/guides/contributing/index.rst +++ b/doc/guides/contributing/index.rst @@ -10,7 +10,8 @@ Contributor's Guidelines coding_style design - versioning + abi_policy + abi_versioning documentation patches vulnerability diff --git a/doc/guides/contributing/patches.rst b/doc/guides/contributing/patches.rst index 9e1013b..c9ec529 100644 --- a/doc/guides/contributing/patches.rst +++ b/doc/guides/contributing/patches.rst @@ -157,7 +157,7 @@ Make your planned changes in the cloned ``dpdk`` repo. Here are some guidelines * For other PMDs and more info, refer to the ``MAINTAINERS`` file. * New external functions should be added to the local ``version.map`` file. - See the :doc:`Guidelines for ABI policy and versioning </contributing/versioning>`. + See the :doc:`Guidelines for ABI policy and versioning </contributing/abi_versioning>`. New external functions should also be added in alphabetical order. * Important changes will require an addition to the release notes in ``doc/guides/rel_notes/``. diff --git a/doc/guides/contributing/versioning.rst b/doc/guides/contributing/versioning.rst deleted file mode 100644 index fcd2d50..0000000 --- a/doc/guides/contributing/versioning.rst +++ /dev/null @@ -1,597 +0,0 @@ -.. SPDX-License-Identifier: BSD-3-Clause - Copyright 2018 The DPDK contributors - -DPDK ABI/API policy -=================== - -Description ------------ - -This document details some methods for handling ABI management in the DPDK. - -General Guidelines ------------------- - -#. Whenever possible, ABI should be preserved -#. ABI/API may be changed with a deprecation process -#. The modification of symbols can generally be managed with versioning -#. Libraries or APIs marked in ``experimental`` state may change without constraint -#. New APIs will be marked as ``experimental`` for at least one release to allow - any issues found by users of the new API to be fixed quickly -#. The addition of symbols is generally not problematic -#. The removal of symbols generally is an ABI break and requires bumping of the - LIBABIVER macro -#. Updates to the minimum hardware requirements, which drop support for hardware which - was previously supported, should be treated as an ABI change. - -What is an ABI -~~~~~~~~~~~~~~ - -An ABI (Application Binary Interface) is the set of runtime interfaces exposed -by a library. It is similar to an API (Application Programming Interface) but -is the result of compilation. It is also effectively cloned when applications -link to dynamic libraries. That is to say when an application is compiled to -link against dynamic libraries, it is assumed that the ABI remains constant -between the time the application is compiled/linked, and the time that it runs. -Therefore, in the case of dynamic linking, it is critical that an ABI is -preserved, or (when modified), done in such a way that the application is unable -to behave improperly or in an unexpected fashion. - - -ABI/API Deprecation -------------------- - -The DPDK ABI policy -~~~~~~~~~~~~~~~~~~~ - -ABI versions are set at the time of major release labeling, and the ABI may -change multiple times, without warning, between the last release label and the -HEAD label of the git tree. - -ABI versions, once released, are available until such time as their -deprecation has been noted in the Release Notes for at least one major release -cycle. For example consider the case where the ABI for DPDK 2.0 has been -shipped and then a decision is made to modify it during the development of -DPDK 2.1. The decision will be recorded in the Release Notes for the DPDK 2.1 -release and the modification will be made available in the DPDK 2.2 release. - -ABI versions may be deprecated in whole or in part as needed by a given -update. - -Some ABI changes may be too significant to reasonably maintain multiple -versions. In those cases ABI's may be updated without backward compatibility -being provided. The requirements for doing so are: - -#. At least 3 acknowledgments of the need to do so must be made on the - dpdk.org mailing list. - - - The acknowledgment of the maintainer of the component is mandatory, or if - no maintainer is available for the component, the tree/sub-tree maintainer - for that component must acknowledge the ABI change instead. - - - It is also recommended that acknowledgments from different "areas of - interest" be sought for each deprecation, for example: from NIC vendors, - CPU vendors, end-users, etc. - -#. The changes (including an alternative map file) can be included with - deprecation notice, in wrapped way by the ``RTE_NEXT_ABI`` option, - to provide more details about oncoming changes. - ``RTE_NEXT_ABI`` wrapper will be removed when it become the default ABI. - More preferred way to provide this information is sending the feature - as a separate patch and reference it in deprecation notice. - -#. A full deprecation cycle, as explained above, must be made to offer - downstream consumers sufficient warning of the change. - -Note that the above process for ABI deprecation should not be undertaken -lightly. ABI stability is extremely important for downstream consumers of the -DPDK, especially when distributed in shared object form. Every effort should -be made to preserve the ABI whenever possible. The ABI should only be changed -for significant reasons, such as performance enhancements. ABI breakage due to -changes such as reorganizing public structure fields for aesthetic or -readability purposes should be avoided. - -.. note:: - - Updates to the minimum hardware requirements, which drop support for hardware - which was previously supported, should be treated as an ABI change, and - follow the relevant deprecation policy procedures as above: 3 acks and - announcement at least one release in advance. - -Examples of Deprecation Notices -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -The following are some examples of ABI deprecation notices which would be -added to the Release Notes: - -* The Macro ``#RTE_FOO`` is deprecated and will be removed with version 2.0, - to be replaced with the inline function ``rte_foo()``. - -* The function ``rte_mbuf_grok()`` has been updated to include a new parameter - in version 2.0. Backwards compatibility will be maintained for this function - until the release of version 2.1 - -* The members of ``struct rte_foo`` have been reorganized in release 2.0 for - performance reasons. Existing binary applications will have backwards - compatibility in release 2.0, while newly built binaries will need to - reference the new structure variant ``struct rte_foo2``. Compatibility will - be removed in release 2.2, and all applications will require updating and - rebuilding to the new structure at that time, which will be renamed to the - original ``struct rte_foo``. - -* Significant ABI changes are planned for the ``librte_dostuff`` library. The - upcoming release 2.0 will not contain these changes, but release 2.1 will, - and no backwards compatibility is planned due to the extensive nature of - these changes. Binaries using this library built prior to version 2.1 will - require updating and recompilation. - -New API replacing previous one -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -If a new API proposed functionally replaces an existing one, when the new API -becomes non-experimental then the old one is marked with ``__rte_deprecated``. -Deprecated APIs are removed completely just after the next LTS. - -Reminder that old API should follow deprecation process to be removed. - - -Experimental APIs ------------------ - -APIs marked as ``experimental`` are not considered part of the ABI and may -change without warning at any time. Since changes to APIs are most likely -immediately after their introduction, as users begin to take advantage of -those new APIs and start finding issues with them, new DPDK APIs will be -automatically marked as ``experimental`` to allow for a period of stabilization -before they become part of a tracked ABI. - -Note that marking an API as experimental is a multi step process. -To mark an API as experimental, the symbols which are desired to be exported -must be placed in an EXPERIMENTAL version block in the corresponding libraries' -version map script. -Secondly, the corresponding prototypes of those exported functions (in the -development header files), must be marked with the ``__rte_experimental`` tag -(see ``rte_compat.h``). -The DPDK build makefiles perform a check to ensure that the map file and the -C code reflect the same list of symbols. -This check can be circumvented by defining ``ALLOW_EXPERIMENTAL_API`` -during compilation in the corresponding library Makefile. - -In addition to tagging the code with ``__rte_experimental``, -the doxygen markup must also contain the EXPERIMENTAL string, -and the MAINTAINERS file should note the EXPERIMENTAL libraries. - -For removing the experimental tag associated with an API, deprecation notice -is not required. Though, an API should remain in experimental state for at least -one release. Thereafter, normal process of posting patch for review to mailing -list can be followed. - - -Library versioning ------------------- - -Downstreams might want to provide different DPDK releases at the same time to -support multiple consumers of DPDK linked against older and newer sonames. - -Also due to the interdependencies that DPDK libraries can have applications -might end up with an executable space in which multiple versions of a library -are mapped by ld.so. - -Think of LibA that got an ABI bump and LibB that did not get an ABI bump but is -depending on LibA. - -.. note:: - - Application - \-> LibA.old - \-> LibB.new -> LibA.new - -That is a conflict which can be avoided by setting ``CONFIG_RTE_MAJOR_ABI``. -If set, the value of ``CONFIG_RTE_MAJOR_ABI`` overwrites all - otherwise per -library - versions defined in the libraries ``LIBABIVER``. -An example might be ``CONFIG_RTE_MAJOR_ABI=16.11`` which will make all libraries -``librte<?>.so.16.11`` instead of ``librte<?>.so.<LIBABIVER>``. - - -ABI versioning --------------- - -Versioning Macros -~~~~~~~~~~~~~~~~~ - -When a symbol is exported from a library to provide an API, it also provides a -calling convention (ABI) that is embodied in its name, return type and -arguments. Occasionally that function may need to change to accommodate new -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 ``rte_function_versioning.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 -library so that older binaries need not be immediately recompiled. - -The macros exported are: - -* ``VERSION_SYMBOL(b, e, n)``: Creates a symbol version table entry binding - versioned symbol ``b@DPDK_n`` to the internal function ``be``. - -* ``BIND_DEFAULT_SYMBOL(b, e, n)``: Creates a symbol version entry instructing - the linker to bind references to symbol ``b`` to the internal symbol - ``be``. - -* ``MAP_STATIC_SYMBOL(f, p)``: Declare the prototype ``f``, and map it to the - fully qualified function ``p``, so that if a symbol becomes versioned, it - can still be mapped back to the public symbol name. - -* ``__vsym``: Annotation to be used in a declaration of the internal symbol - ``be`` to signal that it is being used as an implementation of a particular - version of symbol ``b``. - -Examples of ABI Macro use -^^^^^^^^^^^^^^^^^^^^^^^^^ - -Updating a public API -_____________________ - -Assume we have a function as follows - -.. code-block:: c - - /* - * Create an acl context object for apps to - * manipulate - */ - struct rte_acl_ctx * - rte_acl_create(const struct rte_acl_param *param) - { - ... - } - - -Assume that struct rte_acl_ctx is a private structure, and that a developer -wishes to enhance the acl api so that a debugging flag can be enabled on a -per-context basis. This requires an addition to the structure (which, being -private, is safe), but it also requires modifying the code as follows - -.. code-block:: c - - /* - * Create an acl context object for apps to - * manipulate - */ - struct rte_acl_ctx * - rte_acl_create(const struct rte_acl_param *param, int debug) - { - ... - } - - -Note also that, being a public function, the header file prototype must also be -changed, as must all the call sites, to reflect the new ABI footprint. We will -maintain previous ABI versions that are accessible only to previously compiled -binaries - -The addition of a parameter to the function is ABI breaking as the function is -public, and existing application may use it in its current form. However, the -compatibility macros in DPDK allow a developer to use symbol versioning so that -multiple functions can be mapped to the same public symbol based on when an -application was linked to it. To see how this is done, we start with the -requisite libraries version map file. Initially the version map file for the -acl library looks like this - -.. code-block:: none - - DPDK_2.0 { - global: - - rte_acl_add_rules; - rte_acl_build; - rte_acl_classify; - rte_acl_classify_alg; - rte_acl_classify_scalar; - rte_acl_create; - rte_acl_dump; - rte_acl_find_existing; - rte_acl_free; - rte_acl_ipv4vlan_add_rules; - rte_acl_ipv4vlan_build; - rte_acl_list_dump; - rte_acl_reset; - rte_acl_reset_rules; - rte_acl_set_ctx_classify; - - local: *; - }; - -This file needs to be modified as follows - -.. code-block:: none - - DPDK_2.0 { - global: - - rte_acl_add_rules; - rte_acl_build; - rte_acl_classify; - rte_acl_classify_alg; - rte_acl_classify_scalar; - rte_acl_create; - rte_acl_dump; - rte_acl_find_existing; - rte_acl_free; - rte_acl_ipv4vlan_add_rules; - rte_acl_ipv4vlan_build; - rte_acl_list_dump; - rte_acl_reset; - rte_acl_reset_rules; - rte_acl_set_ctx_classify; - - local: *; - }; - - DPDK_2.1 { - global: - rte_acl_create; - - } DPDK_2.0; - -The addition of the new block tells the linker that a new version node is -available (DPDK_2.1), which contains the symbol rte_acl_create, and inherits the -symbols from the DPDK_2.0 node. This list is directly translated into a list of -exported symbols when DPDK is compiled as a shared library - -Next, we need to specify in the code which function map to the rte_acl_create -symbol at which versions. First, at the site of the initial symbol definition, -we need to update the function so that it is uniquely named, and not in conflict -with the public symbol name - -.. code-block:: c - - -struct rte_acl_ctx * - -rte_acl_create(const struct rte_acl_param *param) - +struct rte_acl_ctx * __vsym - +rte_acl_create_v20(const struct rte_acl_param *param) - { - size_t sz; - struct rte_acl_ctx *ctx; - ... - -Note that the base name of the symbol was kept intact, as this is conducive to -the macros used for versioning symbols and we have annotated the function as an -implementation of versioned symbol. That is our next step, mapping this new -symbol name to the initial symbol name at version node 2.0. Immediately after -the function, we add this line of code - -.. code-block:: c - - VERSION_SYMBOL(rte_acl_create, _v20, 2.0); - -Remembering to also add the rte_function_versioning.h header to the requisite c file where -these changes are being made. The above macro instructs the linker to create a -new symbol ``rte_acl_create@DPDK_2.0``, which matches the symbol created in older -builds, but now points to the above newly named function. We have now mapped -the original rte_acl_create symbol to the original function (but with a new -name) - -Next, we need to create the 2.1 version of the symbol. We create a new function -name, with a different suffix, and implement it appropriately - -.. code-block:: c - - struct rte_acl_ctx * __vsym - rte_acl_create_v21(const struct rte_acl_param *param, int debug); - { - struct rte_acl_ctx *ctx = rte_acl_create_v20(param); - - ctx->debug = debug; - - return ctx; - } - -This code serves as our new API call. Its the same as our old call, but adds -the new parameter in place. Next we need to map this function to the symbol -``rte_acl_create@DPDK_2.1``. To do this, we modify the public prototype of the call -in the header file, adding the macro there to inform all including applications, -that on re-link, the default rte_acl_create symbol should point to this -function. Note that we could do this by simply naming the function above -rte_acl_create, and the linker would chose the most recent version tag to apply -in the version script, but we can also do this in the header file - -.. code-block:: c - - struct rte_acl_ctx * - -rte_acl_create(const struct rte_acl_param *param); - +rte_acl_create(const struct rte_acl_param *param, int debug); - +BIND_DEFAULT_SYMBOL(rte_acl_create, _v21, 2.1); - -The BIND_DEFAULT_SYMBOL macro explicitly tells applications that include this -header, to link to the rte_acl_create_v21 function and apply the DPDK_2.1 -version node to it. This method is more explicit and flexible than just -re-implementing the exact symbol name, and allows for other features (such as -linking to the old symbol version by default, when the new ABI is to be opt-in -for a period. - -One last thing we need to do. Note that we've taken what was a public symbol, -and duplicated it into two uniquely and differently named symbols. We've then -mapped each of those back to the public symbol ``rte_acl_create`` with different -version tags. This only applies to dynamic linking, as static linking has no -notion of versioning. That leaves this code in a position of no longer having a -symbol simply named ``rte_acl_create`` and a static build will fail on that -missing symbol. - -To correct this, we can simply map a function of our choosing back to the public -symbol in the static build with the ``MAP_STATIC_SYMBOL`` macro. Generally the -assumption is that the most recent version of the symbol is the one you want to -map. So, back in the C file where, immediately after ``rte_acl_create_v21`` is -defined, we add this - -.. code-block:: c - - struct rte_acl_ctx * __vsym - rte_acl_create_v21(const struct rte_acl_param *param, int debug) - { - ... - } - MAP_STATIC_SYMBOL(struct rte_acl_ctx *rte_acl_create(const struct rte_acl_param *param, int debug), rte_acl_create_v21); - -That tells the compiler that, when building a static library, any calls to the -symbol ``rte_acl_create`` should be linked to ``rte_acl_create_v21`` - -That's it, on the next shared library rebuild, there will be two versions of -rte_acl_create, an old DPDK_2.0 version, used by previously built applications, -and a new DPDK_2.1 version, used by future built applications. - - -Deprecating part of a public API -________________________________ - -Lets assume that you've done the above update, and after a few releases have -passed you decide you would like to retire the old version of the function. -After having gone through the ABI deprecation announcement process, removal is -easy. Start by removing the symbol from the requisite version map file: - -.. code-block:: none - - DPDK_2.0 { - global: - - rte_acl_add_rules; - rte_acl_build; - rte_acl_classify; - rte_acl_classify_alg; - rte_acl_classify_scalar; - rte_acl_dump; - - rte_acl_create - rte_acl_find_existing; - rte_acl_free; - rte_acl_ipv4vlan_add_rules; - rte_acl_ipv4vlan_build; - rte_acl_list_dump; - rte_acl_reset; - rte_acl_reset_rules; - rte_acl_set_ctx_classify; - - local: *; - }; - - DPDK_2.1 { - global: - rte_acl_create; - } DPDK_2.0; - - -Next remove the corresponding versioned export. - -.. code-block:: c - - -VERSION_SYMBOL(rte_acl_create, _v20, 2.0); - - -Note that the internal function definition could also be removed, but its used -in our example by the newer version _v21, so we leave it in place. This is a -coding style choice. - -Lastly, we need to bump the LIBABIVER number for this library in the Makefile to -indicate to applications doing dynamic linking that this is a later, and -possibly incompatible library version: - -.. code-block:: c - - -LIBABIVER := 1 - +LIBABIVER := 2 - -Deprecating an entire ABI version -_________________________________ - -While removing a symbol from and ABI may be useful, it is often more practical -to remove an entire version node at once. If a version node completely -specifies an API, then removing part of it, typically makes it incomplete. In -those cases it is better to remove the entire node - -To do this, start by modifying the version map file, such that all symbols from -the node to be removed are merged into the next node in the map - -In the case of our map above, it would transform to look as follows - -.. code-block:: none - - DPDK_2.1 { - global: - - rte_acl_add_rules; - rte_acl_build; - rte_acl_classify; - rte_acl_classify_alg; - rte_acl_classify_scalar; - rte_acl_dump; - rte_acl_create - rte_acl_find_existing; - rte_acl_free; - rte_acl_ipv4vlan_add_rules; - rte_acl_ipv4vlan_build; - rte_acl_list_dump; - rte_acl_reset; - rte_acl_reset_rules; - rte_acl_set_ctx_classify; - - local: *; - }; - -Then any uses of BIND_DEFAULT_SYMBOL that pointed to the old node should be -updated to point to the new version node in any header files for all affected -symbols. - -.. code-block:: c - - -BIND_DEFAULT_SYMBOL(rte_acl_create, _v20, 2.0); - +BIND_DEFAULT_SYMBOL(rte_acl_create, _v21, 2.1); - -Lastly, any VERSION_SYMBOL macros that point to the old version node should be -removed, taking care to keep, where need old code in place to support newer -versions of the symbol. - - -Running the ABI Validator -------------------------- - -The ``devtools`` directory in the DPDK source tree contains a utility program, -``validate-abi.sh``, for validating the DPDK ABI based on the Linux `ABI -Compliance Checker -<http://ispras.linuxbase.org/index.php/ABI_compliance_checker>`_. - -This has a dependency on the ``abi-compliance-checker`` and ``and abi-dumper`` -utilities which can be installed via a package manager. For example:: - - sudo yum install abi-compliance-checker - sudo yum install abi-dumper - -The syntax of the ``validate-abi.sh`` utility is:: - - ./devtools/validate-abi.sh <REV1> <REV2> - -Where ``REV1`` and ``REV2`` are valid gitrevisions(7) -https://www.kernel.org/pub/software/scm/git/docs/gitrevisions.html -on the local repo. - -For example:: - - # Check between the previous and latest commit: - ./devtools/validate-abi.sh HEAD~1 HEAD - - # Check on a specific compilation target: - ./devtools/validate-abi.sh -t x86_64-native-linux-gcc HEAD~1 HEAD - - # Check between two tags: - ./devtools/validate-abi.sh v2.0.0 v2.1.0 - - # Check between git master and local topic-branch "vhost-hacking": - ./devtools/validate-abi.sh master vhost-hacking - -After the validation script completes (it can take a while since it need to -compile both tags) it will create compatibility reports in the -``./abi-check/compat_report`` directory. Listed incompatibilities can be found -as follows:: - - grep -lr Incompatible abi-check/compat_reports/ diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst index fad208b..3de702a 100644 --- a/doc/guides/rel_notes/deprecation.rst +++ b/doc/guides/rel_notes/deprecation.rst @@ -4,7 +4,7 @@ ABI and API Deprecation ======================= -See the :doc:`guidelines document for details of the ABI policy </contributing/versioning>`. +See the :doc:`guidelines document for details of the ABI policy </contributing/abi_versioning>`. API and ABI deprecation notices are to be posted here. -- 2.7.4 ^ permalink raw reply [flat|nested] 20+ messages in thread
* [dpdk-dev] [PATCH v11 2/3] doc: changes to abi policy introducing major abi versions 2019-11-11 11:57 ` [dpdk-dev] [PATCH v11 0/3] doc: changes to abi policy introducing major " Ray Kinsella 2019-11-11 11:57 ` [dpdk-dev] [PATCH v11 1/3] doc: separate versioning.rst into version and policy Ray Kinsella @ 2019-11-11 11:57 ` Ray Kinsella 2019-11-11 11:57 ` [dpdk-dev] [PATCH v11 3/3] doc: updates to versioning guide for " Ray Kinsella 2019-11-12 7:55 ` [dpdk-dev] [PATCH v11 0/3] doc: changes to abi policy introducing major " Thomas Monjalon 3 siblings, 0 replies; 20+ messages in thread From: Ray Kinsella @ 2019-11-11 11:57 UTC (permalink / raw) To: dev Cc: mdr, thomas, stephen, bruce.richardson, ferruh.yigit, konstantin.ananyev, jerinj, olivier.matz, nhorman, maxime.coquelin, john.mcnamara, marko.kovacevic, hemant.agrawal, ktraynor, aconole This policy change introduces major ABI versions, these are declared every year, typically aligned with the LTS release and are supported by subsequent releases in the following year. This change is intended to improve ABI stabilty for those projects consuming DPDK. Signed-off-by: Ray Kinsella <mdr@ashroe.eu> Acked-by: John Mcnamara <john.mcnamara@intel.com> Acked-by: Stephen Hemminger <stephen@networkplumber.org> Acked-by: Thomas Monjalon <thomas@monjalon.net> --- doc/guides/contributing/abi_policy.rst | 325 ++++-- .../contributing/img/abi_stability_policy.svg | 1059 ++++++++++++++++++++ doc/guides/contributing/img/what_is_an_abi.svg | 382 +++++++ doc/guides/contributing/stable.rst | 12 +- 4 files changed, 1687 insertions(+), 91 deletions(-) create mode 100644 doc/guides/contributing/img/abi_stability_policy.svg create mode 100644 doc/guides/contributing/img/what_is_an_abi.svg diff --git a/doc/guides/contributing/abi_policy.rst b/doc/guides/contributing/abi_policy.rst index d4f4e9f..81b617c 100644 --- a/doc/guides/contributing/abi_policy.rst +++ b/doc/guides/contributing/abi_policy.rst @@ -1,31 +1,48 @@ .. SPDX-License-Identifier: BSD-3-Clause - Copyright 2018 The DPDK contributors + Copyright 2019 The DPDK contributors -DPDK ABI/API policy -=================== +ABI Policy +========== Description ----------- -This document details some methods for handling ABI management in the DPDK. +This document details the management policy that ensures the long-term stability +of the DPDK ABI and API. General Guidelines ------------------ -#. Whenever possible, ABI should be preserved -#. ABI/API may be changed with a deprecation process -#. The modification of symbols can generally be managed with versioning -#. Libraries or APIs marked in ``experimental`` state may change without constraint -#. New APIs will be marked as ``experimental`` for at least one release to allow - any issues found by users of the new API to be fixed quickly -#. The addition of symbols is generally not problematic -#. The removal of symbols generally is an ABI break and requires bumping of the - LIBABIVER macro -#. Updates to the minimum hardware requirements, which drop support for hardware which - was previously supported, should be treated as an ABI change. - -What is an ABI -~~~~~~~~~~~~~~ +#. Major ABI versions are declared no more frequently than yearly. Compatibility + with the major ABI version is mandatory in subsequent releases until a new + major ABI version is declared. +#. Major ABI versions are usually but not always declared aligned with a + :ref:`LTS release <stable_lts_releases>`. +#. The ABI version is managed at a project level in DPDK, and is reflected in + all non-experimental library's soname. +#. The ABI should be preserved and not changed lightly. ABI changes must follow + the outlined :ref:`deprecation process <abi_changes>`. +#. The addition of symbols is generally not problematic. The modification of + symbols is managed with ABI Versioning. +#. The removal of symbols is considered an :ref:`ABI breakage <abi_breakages>`, + once approved these will form part of the next ABI version. +#. Libraries or APIs marked as :ref:`experimental <experimental_apis>` may + change without constraint, as they are not considered part of an ABI version. + Experimental libraries have the major ABI version ``0``. +#. Updates to the :ref:`minimum hardware requirements <hw_rqmts>`, which drop + support for hardware which was previously supported, should be treated as an + ABI change. + +.. note:: + + In 2019, the DPDK community stated its intention to move to ABI stable + releases, over a number of release cycles. This change begins with + maintaining ABI stability through one year of DPDK releases starting from + DPDK 19.11. This policy will be reviewed in 2020, with intention of + lengthening the stability period. + +What is an ABI? +~~~~~~~~~~~~~~~ An ABI (Application Binary Interface) is the set of runtime interfaces exposed by a library. It is similar to an API (Application Programming Interface) but @@ -37,30 +54,82 @@ Therefore, in the case of dynamic linking, it is critical that an ABI is preserved, or (when modified), done in such a way that the application is unable to behave improperly or in an unexpected fashion. +.. _figure_what_is_an_abi: + +.. figure:: img/what_is_an_abi.* + + Illustration of DPDK API and ABI. -ABI/API Deprecation -------------------- + +What is an ABI version? +~~~~~~~~~~~~~~~~~~~~~~~ + +An ABI version is an instance of a library's ABI at a specific release. Certain +releases are considered to be milestone releases, the yearly LTS release for +example. The ABI of a milestone release may be declared as a 'major ABI +version', where this ABI version is then supported for some number of subsequent +releases and is annotated in the library's soname. + +ABI version support in subsequent releases facilitates application upgrades, by +enabling applications built against the milestone release to upgrade to +subsequent releases of a library without a rebuild. + +More details on major ABI version can be found in the ABI Versioning guide. The DPDK ABI policy -~~~~~~~~~~~~~~~~~~~ +------------------- + +A new major ABI version is declared no more frequently than yearly, with +declarations usually aligning with a LTS release, e.g. ABI 20 for DPDK 19.11. +Compatibility with the major ABI version is then mandatory in subsequent +releases until the next major ABI version is declared, e.g. ABI 21 for DPDK +20.11. -ABI versions are set at the time of major release labeling, and the ABI may -change multiple times, without warning, between the last release label and the -HEAD label of the git tree. +At the declaration of a major ABI version, major version numbers encoded in +libraries' sonames are bumped to indicate the new version, with the minor +version reset to ``0``. An example would be ``librte_eal.so.20.3`` would become +``librte_eal.so.21.0``. -ABI versions, once released, are available until such time as their -deprecation has been noted in the Release Notes for at least one major release -cycle. For example consider the case where the ABI for DPDK 2.0 has been -shipped and then a decision is made to modify it during the development of -DPDK 2.1. The decision will be recorded in the Release Notes for the DPDK 2.1 -release and the modification will be made available in the DPDK 2.2 release. +The ABI may then change multiple times, without warning, between the last major +ABI version increment and the HEAD label of the git tree, with the condition +that ABI compatibility with the major ABI version is preserved and therefore +sonames do not change. -ABI versions may be deprecated in whole or in part as needed by a given -update. +Minor versions are incremented to indicate the release of a new ABI compatible +DPDK release, typically the DPDK quarterly releases. An example of this, might +be that ``librte_eal.so.20.1`` would indicate the first ABI compatible DPDK +release, following the declaration of the new major ABI version ``20``. -Some ABI changes may be too significant to reasonably maintain multiple -versions. In those cases ABI's may be updated without backward compatibility -being provided. The requirements for doing so are: +An ABI version is supported in all new releases until the next major ABI version +is declared. When changing the major ABI version, the release notes will detail +all ABI changes. + +.. _figure_abi_stability_policy: + +.. figure:: img/abi_stability_policy.* + + Mapping of new ABI versions and ABI version compatibility to DPDK + releases. + +.. _abi_changes: + +ABI Changes +~~~~~~~~~~~ + +The ABI may still change after the declaration of a major ABI version, that is +new APIs may be still added or existing APIs may be modified. + +.. Warning:: + + Note that, this policy details the method by which the ABI may be changed, + with due regard to preserving compatibility and observing deprecation + notices. This process however should not be undertaken lightly, as a general + rule ABI stability is extremely important for downstream consumers of DPDK. + The API should only be changed for significant reasons, such as performance + enhancements. API breakages due to changes such as reorganizing public + structure fields for aesthetic or readability purposes should be avoided. + +The requirements for changing the ABI are: #. At least 3 acknowledgments of the need to do so must be made on the dpdk.org mailing list. @@ -69,34 +138,119 @@ being provided. The requirements for doing so are: no maintainer is available for the component, the tree/sub-tree maintainer for that component must acknowledge the ABI change instead. + - The acknowledgment of three members of the technical board, as delegates + of the `technical board <https://core.dpdk.org/techboard/>`_ acknowledging + the need for the ABI change, is also mandatory. + - It is also recommended that acknowledgments from different "areas of interest" be sought for each deprecation, for example: from NIC vendors, CPU vendors, end-users, etc. -#. The changes (including an alternative map file) can be included with - deprecation notice, in wrapped way by the ``RTE_NEXT_ABI`` option, - to provide more details about oncoming changes. - ``RTE_NEXT_ABI`` wrapper will be removed when it become the default ABI. - More preferred way to provide this information is sending the feature - as a separate patch and reference it in deprecation notice. +#. Backward compatibility with the major ABI version must be maintained through + ABI Versioning, with :ref:`forward-only <forward-only>` compatibility + offered for any ABI changes that are indicated to be part of the next ABI + version. -#. A full deprecation cycle, as explained above, must be made to offer - downstream consumers sufficient warning of the change. + - In situations where backward compatibility is not possible, read the + section on :ref:`abi_breakages`. -Note that the above process for ABI deprecation should not be undertaken -lightly. ABI stability is extremely important for downstream consumers of the -DPDK, especially when distributed in shared object form. Every effort should -be made to preserve the ABI whenever possible. The ABI should only be changed -for significant reasons, such as performance enhancements. ABI breakage due to -changes such as reorganizing public structure fields for aesthetic or -readability purposes should be avoided. + - No backward or forward compatibility is offered for API changes marked as + ``experimental``, as described in the section on :ref:`Experimental APIs + and Libraries <experimental_apis>`. -.. note:: +#. If a newly proposed API functionally replaces an existing one, when the new + API becomes non-experimental, then the old one is marked with + ``__rte_deprecated``. + + - The depreciated API should follow the notification process to be removed, + see :ref:`deprecation_notices`. + + - At the declaration of the next major ABI version, those ABI changes then + become a formal part of the new ABI and the requirement to preserve ABI + compatibility with the last major ABI version is then dropped. + + - The responsibility for removing redundant ABI compatibility code rests + with the original contributor of the ABI changes, failing that, then with + the contributor's company and then finally with the maintainer. + +.. _forward-only: + +.. Note:: + + Note that forward-only compatibility is offered for those changes made + between major ABI versions. As a library's soname can only describe + compatibility with the last major ABI version, until the next major ABI + version is declared, these changes therefore cannot be resolved as a runtime + dependency through the soname. Therefore any application wishing to make use + of these ABI changes can only ensure that its runtime dependencies are met + through Operating System package versioning. + +.. _hw_rqmts: + +.. Note:: Updates to the minimum hardware requirements, which drop support for hardware which was previously supported, should be treated as an ABI change, and - follow the relevant deprecation policy procedures as above: 3 acks and - announcement at least one release in advance. + follow the relevant deprecation policy procedures as above: 3 acks, technical + board approval and announcement at least one release in advance. + +.. _abi_breakages: + +ABI Breakages +~~~~~~~~~~~~~ + +For those ABI changes that are too significant to reasonably maintain multiple +symbol versions, there is an amended process. In these cases, ABIs may be +updated without the requirement of backward compatibility being provided. These +changes must follow the same process :ref:`described above <abi_changes>` as non-breaking +changes, however with the following additional requirements: + +#. ABI breaking changes (including an alternative map file) can be included with + deprecation notice, in wrapped way by the ``RTE_NEXT_ABI`` option, to provide + more details about oncoming changes. ``RTE_NEXT_ABI`` wrapper will be removed + at the declaration of the next major ABI version. + +#. Once approved, and after the deprecation notice has been observed these + changes will form part of the next declared major ABI version. + +Examples of ABI Changes +~~~~~~~~~~~~~~~~~~~~~~~ + +The following are examples of allowable ABI changes occurring between +declarations of major ABI versions. + +* DPDK 19.11 release, defines the function ``rte_foo()``, and ``rte_foo()`` + as part of the major ABI version ``20``. + +* DPDK 20.02 release defines a new function ``rte_foo(uint8_t bar)``, and + this is not a problem as long as the symbol ``rte_foo@DPDK20`` is + preserved through ABI Versioning. + + - The new function may be marked with the ``__rte_experimental`` tag for a + number of releases, as described in the section :ref:`experimental_apis`. + + - Once ``rte_foo(uint8_t bar)`` becomes non-experimental ``rte_foo()`` is then + declared as ``__rte_depreciated``, with an associated deprecation notice + provided. + +* DPDK 19.11 is not re-released to include ``rte_foo(uint8_t bar)``, the new + version of ``rte_foo`` only exists from DPDK 20.02 onwards as described in the + :ref:`note on forward-only compatibility<forward-only>`. + +* DPDK 20.02 release defines the experimental function ``__rte_experimental + rte_baz()``. This function may or may not exist in the DPDK 20.05 release. + +* An application ``dPacket`` wishes to use ``rte_foo(uint8_t bar)``, before the + declaration of the DPDK ``21`` major API version. The application can only + ensure its runtime dependencies are met by specifying ``DPDK (>= 20.2)`` as + an explicit package dependency, as the soname only may only indicate the + supported major ABI version. + +* At the release of DPDK 20.11, the function ``rte_foo(uint8_t bar)`` becomes + formally part of then new major ABI version DPDK 21.0 and ``rte_foo()`` may be + removed. + +.. _deprecation_notices: Examples of Deprecation Notices ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -104,46 +258,42 @@ Examples of Deprecation Notices The following are some examples of ABI deprecation notices which would be added to the Release Notes: -* The Macro ``#RTE_FOO`` is deprecated and will be removed with version 2.0, - to be replaced with the inline function ``rte_foo()``. +* The Macro ``#RTE_FOO`` is deprecated and will be removed with ABI version + 21, to be replaced with the inline function ``rte_foo()``. * The function ``rte_mbuf_grok()`` has been updated to include a new parameter - in version 2.0. Backwards compatibility will be maintained for this function - until the release of version 2.1 + in version 20.2. Backwards compatibility will be maintained for this function + until the release of the new DPDK major ABI version 21, in DPDK version + 20.11. -* The members of ``struct rte_foo`` have been reorganized in release 2.0 for +* The members of ``struct rte_foo`` have been reorganized in DPDK 20.02 for performance reasons. Existing binary applications will have backwards - compatibility in release 2.0, while newly built binaries will need to - reference the new structure variant ``struct rte_foo2``. Compatibility will - be removed in release 2.2, and all applications will require updating and + compatibility in release 20.02, while newly built binaries will need to + reference the new structure variant ``struct rte_foo2``. Compatibility will be + removed in release 20.11, and all applications will require updating and rebuilding to the new structure at that time, which will be renamed to the original ``struct rte_foo``. * Significant ABI changes are planned for the ``librte_dostuff`` library. The - upcoming release 2.0 will not contain these changes, but release 2.1 will, + upcoming release 20.02 will not contain these changes, but release 20.11 will, and no backwards compatibility is planned due to the extensive nature of - these changes. Binaries using this library built prior to version 2.1 will + these changes. Binaries using this library built prior to ABI version 21 will require updating and recompilation. -New API replacing previous one -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -If a new API proposed functionally replaces an existing one, when the new API -becomes non-experimental then the old one is marked with ``__rte_deprecated``. -Deprecated APIs are removed completely just after the next LTS. +.. _experimental_apis: -Reminder that old API should follow deprecation process to be removed. +Experimental +------------ +APIs +~~~~ -Experimental APIs ------------------ - -APIs marked as ``experimental`` are not considered part of the ABI and may -change without warning at any time. Since changes to APIs are most likely -immediately after their introduction, as users begin to take advantage of -those new APIs and start finding issues with them, new DPDK APIs will be -automatically marked as ``experimental`` to allow for a period of stabilization -before they become part of a tracked ABI. +APIs marked as ``experimental`` are not considered part of an ABI version and +may change without warning at any time. Since changes to APIs are most likely +immediately after their introduction, as users begin to take advantage of those +new APIs and start finding issues with them, new DPDK APIs will be automatically +marked as ``experimental`` to allow for a period of stabilization before they +become part of a tracked ABI version. Note that marking an API as experimental is a multi step process. To mark an API as experimental, the symbols which are desired to be exported @@ -161,7 +311,16 @@ In addition to tagging the code with ``__rte_experimental``, the doxygen markup must also contain the EXPERIMENTAL string, and the MAINTAINERS file should note the EXPERIMENTAL libraries. -For removing the experimental tag associated with an API, deprecation notice -is not required. Though, an API should remain in experimental state for at least -one release. Thereafter, normal process of posting patch for review to mailing -list can be followed. +For removing the experimental tag associated with an API, deprecation notice is +not required. Though, an API should remain in experimental state for at least +one release. Thereafter, the normal process of posting patch for review to +mailing list can be followed. + +Libraries +~~~~~~~~~ + +Libraries marked as ``experimental`` are entirely not considered part of an ABI +version, and may change without warning at any time. Experimental libraries +always have a major version of ``0`` to indicate they exist outside of +ABI Versioning, with the minor version incremented with each ABI change +to library. diff --git a/doc/guides/contributing/img/abi_stability_policy.svg b/doc/guides/contributing/img/abi_stability_policy.svg new file mode 100644 index 0000000..4fd4007 --- /dev/null +++ b/doc/guides/contributing/img/abi_stability_policy.svg @@ -0,0 +1,1059 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<svg + xmlns:dc="http://purl.org/dc/elements/1.1/" + xmlns:cc="http://creativecommons.org/ns#" + xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" + xmlns:svg="http://www.w3.org/2000/svg" + xmlns="http://www.w3.org/2000/svg" + xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd" + xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape" + width="1237.4869" + height="481.37463" + version="1.1" + viewBox="0 0 1237.4869 481.37463" + xml:space="preserve" + id="svg7800" + sodipodi:docname="abi_stability_policy.svg" + inkscape:version="0.92.2 (5c3e80d, 2017-08-06)"><metadata + id="metadata7804"><rdf:RDF><cc:Work + rdf:about=""><dc:format>image/svg+xml</dc:format><dc:type + rdf:resource="http://purl.org/dc/dcmitype/StillImage" /></cc:Work></rdf:RDF></metadata><sodipodi:namedview + pagecolor="#ffffff" + bordercolor="#666666" + borderopacity="1" + objecttolerance="10" + gridtolerance="10" + guidetolerance="10" + inkscape:pageopacity="0" + inkscape:pageshadow="2" + inkscape:window-width="1920" + inkscape:window-height="1017" + id="namedview7802" + showgrid="false" + inkscape:zoom="0.8875" + inkscape:cx="840.50495" + inkscape:cy="179.36692" + inkscape:window-x="-8" + inkscape:window-y="-8" + inkscape:window-maximized="1" + inkscape:current-layer="svg7800" /><defs + id="defs7394"><clipPath + id="clipPath3975"><path + d="M 0,1.2207e-4 H 960 V 540.00012 H 0 Z" + id="path7226" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4003"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7229" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4025"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7232" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4037"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7235" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4049"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7238" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4061"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7241" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4073"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7244" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4085"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7247" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4097"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7250" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4109"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7253" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4121"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7256" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4133"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7259" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4145"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7262" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4157"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7265" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4169"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7268" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4181"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7271" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4193"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7274" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4205"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7277" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4217"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7280" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4229"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7283" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4241"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7286" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4253"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7289" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4265"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7292" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4277"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7295" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4289"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7298" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4301"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7301" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4313"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7304" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4327"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7307" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4339"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7310" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4351"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7313" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4363"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7316" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4375"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7319" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4389"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7322" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4403"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7325" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4417"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7328" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4429"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7331" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4441"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7334" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4453"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7337" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4477"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7340" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4489"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7343" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4501"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7346" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4513"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7349" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4525"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7352" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4537"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7355" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4549"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7358" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4561"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7361" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4573"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7364" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4589"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7367" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4601"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7370" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4615"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7373" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4629"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7376" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4641"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7379" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4653"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7382" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4673"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7385" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4685"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7388" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath4699"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path7391" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath></defs><g + id="g7406" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><path + style="fill:#44546a" + inkscape:connector-curvature="0" + id="path7400" + d="m 161.83,180.57 773.79,4.78 c 0.82,0.01 1.49,0.68 1.49,1.51 -0.01,0.83 -0.68,1.5 -1.51,1.49 l -773.79,-4.78 c -0.83,-0.01 -1.5,-0.68 -1.49,-1.51 0.01,-0.83 0.68,-1.5 1.51,-1.49 z m 772.3,1.77 8.97,4.56 -9.03,4.44 z" /><path + style="fill:#00b050;fill-rule:evenodd" + inkscape:connector-curvature="0" + id="path7402" + d="m 173.28,182.22 c 0,4.67 3.36,8.46 7.5,8.46 4.14,0 7.5,-3.79 7.5,-8.46 0,-4.67 -3.36,-8.46 -7.5,-8.46 -4.14,0 -7.5,3.79 -7.5,8.46 z" /><path + style="fill:#00b050;fill-rule:evenodd" + inkscape:connector-curvature="0" + id="path7404" + d="m 612.24,183.78 c 0,4.67 3.36,8.46 7.5,8.46 4.14,0 7.5,-3.79 7.5,-8.46 0,-4.67 -3.36,-8.46 -7.5,-8.46 -4.14,0 -7.5,3.79 -7.5,8.46 z" /></g><g + style="fill:#ff0000;fill-rule:evenodd" + id="g7420" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><path + inkscape:connector-curvature="0" + id="path7408" + d="m 228.12,182.22 c 0,4.67 3.36,8.46 7.5,8.46 4.14,0 7.5,-3.79 7.5,-8.46 0,-4.67 -3.36,-8.46 -7.5,-8.46 -4.14,0 -7.5,3.79 -7.5,8.46 z" /><path + inkscape:connector-curvature="0" + id="path7410" + d="m 282.96,182.22 c 0,4.67 3.36,8.46 7.5,8.46 4.14,0 7.5,-3.79 7.5,-8.46 0,-4.67 -3.36,-8.46 -7.5,-8.46 -4.14,0 -7.5,3.79 -7.5,8.46 z" /><path + inkscape:connector-curvature="0" + id="path7412" + d="m 337.8,182.22 c 0,4.67 3.38,8.46 7.56,8.46 4.18,0 7.56,-3.79 7.56,-8.46 0,-4.67 -3.38,-8.46 -7.56,-8.46 -4.18,0 -7.56,3.79 -7.56,8.46 z" /><path + inkscape:connector-curvature="0" + id="path7414" + d="m 447.6,182.22 c 0,4.67 3.36,8.46 7.5,8.46 4.14,0 7.5,-3.79 7.5,-8.46 0,-4.67 -3.36,-8.46 -7.5,-8.46 -4.14,0 -7.5,3.79 -7.5,8.46 z" /><path + inkscape:connector-curvature="0" + id="path7416" + d="m 502.44,182.34 c 0,4.67 3.38,8.46 7.56,8.46 4.18,0 7.56,-3.79 7.56,-8.46 0,-4.67 -3.38,-8.46 -7.56,-8.46 -4.18,0 -7.56,3.79 -7.56,8.46 z" /><path + inkscape:connector-curvature="0" + id="path7418" + d="m 557.28,182.34 c 0,4.67 3.38,8.46 7.56,8.46 4.18,0 7.56,-3.79 7.56,-8.46 0,-4.67 -3.38,-8.46 -7.56,-8.46 -4.18,0 -7.56,3.79 -7.56,8.46 z" /></g><g + id="g7426" + clip-path="url(#clipPath4003)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7424" + font-size="14.04px" + transform="matrix(1,0,0,-1,152.98,149.45)"><tspan + id="tspan7422" + y="0" + x="0 6.3460798 13.46436 20.52648 24.10668 31.22496">v19.11</tspan></text> +</g><path + style="fill:#00b050;fill-rule:evenodd;stroke-width:1.33329999" + inkscape:connector-curvature="0" + id="path7428" + d="m 499.42541,379.9105 c 0,-6.22651 4.47989,-11.27972 9.99975,-11.27972 5.51986,0 9.99975,5.05321 9.99975,11.27972 0,6.22651 -4.47989,11.27972 -9.99975,11.27972 -5.51986,0 -9.99975,-5.05321 -9.99975,-11.27972 z" /><path + style="fill:#00b050;fill-rule:evenodd;stroke-width:1.33329999" + inkscape:connector-curvature="0" + id="path7430" + d="m 1084.6908,373.67065 c 0,-6.22651 4.4799,-11.27971 9.9997,-11.27971 5.5199,0 9.9998,5.0532 9.9998,11.27971 0,6.22652 -4.4799,11.27972 -9.9998,11.27972 -5.5198,0 -9.9997,-5.0532 -9.9997,-11.27972 z" /><g + style="fill:#ff0000;fill-rule:evenodd" + id="g7438" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><path + inkscape:connector-curvature="0" + id="path7432" + d="m 667.08,185.4 c 0,4.64 3.36,8.4 7.5,8.4 4.14,0 7.5,-3.76 7.5,-8.4 0,-4.64 -3.36,-8.4 -7.5,-8.4 -4.14,0 -7.5,3.76 -7.5,8.4 z" /><path + inkscape:connector-curvature="0" + id="path7434" + d="m 721.92,185.58 c 0,4.67 3.38,8.46 7.56,8.46 4.18,0 7.56,-3.79 7.56,-8.46 0,-4.67 -3.38,-8.46 -7.56,-8.46 -4.18,0 -7.56,3.79 -7.56,8.46 z" /><path + inkscape:connector-curvature="0" + id="path7436" + d="m 776.76,185.58 c 0,4.67 3.38,8.46 7.56,8.46 4.18,0 7.56,-3.79 7.56,-8.46 0,-4.67 -3.38,-8.46 -7.56,-8.46 -4.18,0 -7.56,3.79 -7.56,8.46 z" /></g><g + id="g7444" + clip-path="url(#clipPath4025)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7442" + font-size="14.04px" + transform="matrix(1,0,0,-1,210.14,150.1)"><tspan + id="tspan7440" + y="0" + x="0 6.3460798 13.46436 20.52648 24.10668 31.22496">v20.02</tspan></text> +</g><g + id="g7450" + clip-path="url(#clipPath4037)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7448" + font-size="14.04px" + transform="matrix(1,0,0,-1,265.01,150.1)"><tspan + id="tspan7446" + y="0" + x="0 6.3460798 13.46436 20.52648 24.10668 31.22496">v20.05</tspan></text> +</g><g + id="g7456" + clip-path="url(#clipPath4049)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7454" + font-size="14.04px" + transform="matrix(1,0,0,-1,319.9,150.77)"><tspan + id="tspan7452" + y="0" + x="0 6.3460798 13.46436 20.52648 24.10668 31.22496">v20.08</tspan></text> +</g><g + id="g7462" + clip-path="url(#clipPath4061)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.06400013px;font-family:Calibri;fill:#000000" + id="text7460" + font-size="14.064px" + transform="matrix(1,0,0,-1,375,150.94)"><tspan + id="tspan7458" + y="0" + x="0 7.9180322 14.992224 22.066416 25.652737 32.726929">V20.11</tspan></text> +</g><g + id="g7468" + clip-path="url(#clipPath4073)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.06400013px;font-family:Calibri;fill:#000000" + id="text7466" + font-size="14.064px" + transform="matrix(1,0,0,-1,429.17,150.94)"><tspan + id="tspan7464" + y="0" + x="0 6.3569279 13.445184 20.519377 24.105696 31.179888">v21.02</tspan></text> +</g><g + id="g7474" + clip-path="url(#clipPath4085)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7472" + font-size="14.04px" + transform="matrix(1,0,0,-1,483,150.55)"><tspan + id="tspan7470" + y="0" + x="0 6.3460798 13.46436 20.52648 24.10668 31.22496">v21.05</tspan></text> +</g><g + id="g7480" + clip-path="url(#clipPath4097)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.06400013px;font-family:Calibri;fill:#000000" + id="text7478" + font-size="14.064px" + transform="matrix(1,0,0,-1,537.38,150.82)"><tspan + id="tspan7476" + y="0" + x="0 6.3569279 13.445184 20.519377 24.105696 31.179888">v21.08</tspan></text> +</g><g + id="g7486" + clip-path="url(#clipPath4109)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.06400013px;font-family:Calibri;fill:#000000" + id="text7484" + font-size="14.064px" + transform="matrix(1,0,0,-1,592.27,150.82)"><tspan + id="tspan7482" + y="0" + x="0 6.3569279 13.445184 20.519377 24.105696 31.179888">v21.11</tspan></text> +</g><g + id="g7492" + clip-path="url(#clipPath4121)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7490" + font-size="14.04px" + transform="matrix(1,0,0,-1,647.14,151.46)"><tspan + id="tspan7488" + y="0" + x="0 6.3460798 13.46436 20.52648 24.10668 31.22496">v22.02</tspan></text> +</g><g + id="g7498" + clip-path="url(#clipPath4133)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7496" + font-size="14.04px" + transform="matrix(1,0,0,-1,702.24,151.63)"><tspan + id="tspan7494" + y="0" + x="0 7.96068 14.99472 22.113001 25.651079 32.76936">V22.05</tspan></text> +</g><g + id="g7504" + clip-path="url(#clipPath4145)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7502" + font-size="14.04px" + transform="matrix(1,0,0,-1,756.43,151.63)"><tspan + id="tspan7500" + y="0" + x="0 7.96068 14.99472 22.113001 25.651079 32.76936">V22.08</tspan></text> +</g><g + id="g7510" + clip-path="url(#clipPath4157)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7508" + font-size="14.04px" + transform="matrix(1,0,0,-1,811.99,151.63)"><tspan + id="tspan7506" + y="0" + x="0 7.96068 14.99472 22.113001 25.651079 32.76936">V22.11</tspan></text> +</g><g + id="g7516" + clip-path="url(#clipPath4169)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7514" + font-size="14.04px" + transform="matrix(1,0,0,-1,105.82,214.18)"><tspan + id="tspan7512" + y="0" + x="0 6.3460798 13.46436">v20</tspan></text> +</g><g + id="g7522" + clip-path="url(#clipPath4181)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.06400013px;font-family:Calibri;fill:#000000" + id="text7520" + font-size="14.064px" + transform="matrix(1,0,0,-1,105.5,247.68)"><tspan + id="tspan7518" + y="0" + x="0 6.3569279 13.445184">v21</tspan></text> +</g><g + id="g7528" + clip-path="url(#clipPath4193)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7526" + font-size="14.04px" + transform="matrix(1,0,0,-1,228.79,214.51)"><tspan + id="tspan7524" + y="0" + x="0">√</tspan></text> +</g><g + id="g7534" + clip-path="url(#clipPath4205)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7532" + font-size="14.04px" + transform="matrix(1,0,0,-1,283.8,214.51)"><tspan + id="tspan7530" + y="0" + x="0">√</tspan></text> +</g><g + id="g7540" + clip-path="url(#clipPath4217)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7538" + font-size="14.04px" + transform="matrix(1,0,0,-1,337.68,214.51)"><tspan + id="tspan7536" + y="0" + x="0">√</tspan></text> +</g><g + id="g7546" + clip-path="url(#clipPath4229)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7544" + font-size="14.04px" + transform="matrix(1,0,0,-1,611.66,285.79)"><tspan + id="tspan7542" + y="0" + x="0">√</tspan></text> +</g><g + id="g7552" + clip-path="url(#clipPath4241)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7550" + font-size="14.04px" + transform="matrix(1,0,0,-1,666.65,285.79)"><tspan + id="tspan7548" + y="0" + x="0">√</tspan></text> +</g><g + id="g7558" + clip-path="url(#clipPath4253)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7556" + font-size="14.04px" + transform="matrix(1,0,0,-1,719.4,285.79)"><tspan + id="tspan7554" + y="0" + x="0">√</tspan></text> +</g><g + id="g7564" + clip-path="url(#clipPath4265)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7562" + font-size="14.04px" + transform="matrix(1,0,0,-1,775.56,285.79)"><tspan + id="tspan7560" + y="0" + x="0">√</tspan></text> +</g><g + id="g7570" + clip-path="url(#clipPath4277)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7568" + font-size="14.04px" + transform="matrix(1,0,0,-1,398.54,249.22)"><tspan + id="tspan7566" + y="0" + x="0">√</tspan></text> +</g><g + id="g7576" + clip-path="url(#clipPath4289)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7574" + font-size="14.04px" + transform="matrix(1,0,0,-1,453.53,249.22)"><tspan + id="tspan7572" + y="0" + x="0">√</tspan></text> +</g><g + id="g7582" + clip-path="url(#clipPath4301)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7580" + font-size="14.04px" + transform="matrix(1,0,0,-1,507.43,249.22)"><tspan + id="tspan7578" + y="0" + x="0">√</tspan></text> +</g><g + id="g7588" + clip-path="url(#clipPath4313)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7586" + font-size="14.04px" + transform="matrix(1,0,0,-1,561.05,249.22)"><tspan + id="tspan7584" + y="0" + x="0">√</tspan></text> +</g><path + style="fill:#44546a;stroke-width:1.33329999" + inkscape:connector-curvature="0" + id="path7590" + d="m 217.67245,474.73479 v -25.14603 c 0,-1.10664 -0.89331,-1.99995 -1.99995,-1.99995 -1.10664,0 -1.99995,0.89331 -1.99995,1.99995 v 25.14603 c 0,1.09331 0.89331,1.99995 1.99995,1.99995 1.10664,0 1.99995,-0.90664 1.99995,-1.99995 z m 3.9999,-23.14608 -5.99985,-11.9997 -5.99985,11.9997 z" /><g + id="g7596" + clip-path="url(#clipPath4327)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7594" + font-size="14.04px" + transform="matrix(1,0,0,-1,170.83,214.51)"><tspan + id="tspan7592" + y="0" + x="0">√</tspan></text> +</g><g + id="g7602" + clip-path="url(#clipPath4339)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-weight:bold;font-size:14.06400013px;font-family:Calibri;fill:#000000" + id="text7600" + font-weight="bold" + font-size="14.064px" + transform="matrix(1,0,0,-1,23.4,272.33)"><tspan + id="tspan7598" + y="0" + x="0 8.5227842 16.412687 20.167776">ABI </tspan></text> +</g><g + id="g7608" + clip-path="url(#clipPath4351)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-weight:bold;font-size:14.06400013px;font-family:Calibri;fill:#000000" + id="text7606" + font-weight="bold" + font-size="14.064px" + transform="matrix(1,0,0,-1,46.68,272.33)"><tspan + id="tspan7604" + y="0" + x="0 7.566432 14.640624 19.563025 25.174561 28.662432 36.228863">Version</tspan></text> +</g><g + id="g7614" + clip-path="url(#clipPath4363)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-weight:bold;font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7612" + font-weight="bold" + font-size="14.04px" + transform="matrix(1,0,0,-1,17.64,255.5)"><tspan + id="tspan7610" + y="0" + x="0 7.4271598 14.98068 26.395201 33.934681 40.80024 45.700199 49.154041 56.7216 60.175442 63.671398 67.125237 72.053284">Compatibility</tspan></text> +</g><g + id="g7620" + clip-path="url(#clipPath4375)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7618" + font-size="14.04px" + transform="matrix(1,0,0,-1,191.28,116.86)"><tspan + id="tspan7616" + y="0" + x="0 6.3460798 13.46436">v20</tspan></text> +</g><path + style="fill:#44546a;stroke-width:1.33329999" + inkscape:connector-curvature="0" + id="path7622" + d="m 511.7451,474.89479 v -25.14604 c 0,-1.10664 -0.89331,-1.99995 -1.99995,-1.99995 -1.10664,0 -1.99995,0.89331 -1.99995,1.99995 v 25.14604 c 0,1.09331 0.89331,1.99995 1.99995,1.99995 1.10664,0 1.99995,-0.90664 1.99995,-1.99995 z m 3.9999,-23.14609 -5.99985,-11.9997 -5.99985,11.9997 z" /><g + id="g7628" + clip-path="url(#clipPath4389)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7626" + font-size="14.04px" + transform="matrix(1,0,0,-1,407.06,115.63)"><tspan + id="tspan7624" + y="0" + x="0 6.3460798 13.46436">v21</tspan></text> +</g><path + style="fill:#44546a;stroke-width:1.33329999" + inkscape:connector-curvature="0" + id="path7630" + d="m 804.53778,476.01476 v -25.14604 c 0,-1.10664 -0.89331,-1.99995 -1.99995,-1.99995 -1.10664,0 -1.99995,0.89331 -1.99995,1.99995 v 25.14604 c 0,1.09331 0.89331,1.99995 1.99995,1.99995 1.10664,0 1.99995,-0.90664 1.99995,-1.99995 z m 3.9999,-23.14609 -5.99985,-11.9997 -5.99985,11.9997 z" /><g + id="g7636" + clip-path="url(#clipPath4403)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7634" + font-size="14.04px" + transform="matrix(1,0,0,-1,626.66,114.74)"><tspan + id="tspan7632" + y="0" + x="0 6.3460798 13.46436">v22</tspan></text> +</g><path + style="fill:#44546a;stroke-width:1.33329999" + inkscape:connector-curvature="0" + id="path7638" + d="m 1098.2904,479.37468 v -25.14604 c 0,-1.10664 -0.8933,-1.99995 -1.9999,-1.99995 -1.1067,0 -2,0.89331 -2,1.99995 v 25.14604 c 0,1.0933 0.8933,1.99995 2,1.99995 1.1066,0 1.9999,-0.90665 1.9999,-1.99995 z m 3.9999,-23.14609 -5.9998,-11.9997 -5.9999,11.9997 z" /><g + id="g7644" + clip-path="url(#clipPath4417)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.06400013px;font-family:Calibri;fill:#000000" + id="text7642" + font-size="14.064px" + transform="matrix(1,0,0,-1,846.96,112.22)"><tspan + id="tspan7640" + y="0" + x="0 6.3569279 13.445184">v23</tspan></text> +</g><g + id="g7650" + clip-path="url(#clipPath4429)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7648" + font-size="14.04px" + transform="matrix(1,0,0,-1,832.87,318.46)"><tspan + id="tspan7646" + y="0" + x="0">√</tspan></text> +</g><g + id="g7656" + clip-path="url(#clipPath4441)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7654" + font-size="14.04px" + transform="matrix(1,0,0,-1,105.5,285.67)"><tspan + id="tspan7652" + y="0" + x="0 6.3460798 13.46436">v22</tspan></text> +</g><g + id="g7662" + clip-path="url(#clipPath4453)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7660" + font-size="14.04px" + transform="matrix(1,0,0,-1,104.93,319.87)"><tspan + id="tspan7658" + y="0" + x="0 6.3460798 13.46436">v23</tspan></text> +</g><path + style="fill:none;stroke:#5b9bd5;stroke-width:0.63998401;stroke-miterlimit:10;stroke-dasharray:2.559936, 1.919952" + inkscape:connector-curvature="0" + id="path7664" + stroke-miterlimit="10" + d="m 1104.7569,213.75465 -934.60326,0.39999" /><path + style="fill:none;stroke:#5b9bd5;stroke-width:0.63998401;stroke-miterlimit:10;stroke-dasharray:2.559936, 1.919952" + inkscape:connector-curvature="0" + id="path7666" + stroke-miterlimit="10" + d="M 1105.3969,255.35361 170.79362,255.7536" /><path + style="fill:none;stroke:#5b9bd5;stroke-width:0.63998401;stroke-miterlimit:10;stroke-dasharray:2.559936, 1.919952" + inkscape:connector-curvature="0" + id="path7668" + stroke-miterlimit="10" + d="M 1105.3969,299.35251 170.79362,299.7525" /><g + id="g7674" + clip-path="url(#clipPath4477)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.06400013px;font-family:Calibri;fill:#8497b0" + id="text7672" + font-size="14.064px" + transform="matrix(1,0,0,-1,283.8,251.38)"><tspan + id="tspan7670" + y="0" + x="0">√</tspan></text> +</g><g + id="g7680" + clip-path="url(#clipPath4489)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#8497b0" + id="text7678" + font-size="14.04px" + transform="matrix(1,0,0,-1,339.5,251.95)"><tspan + id="tspan7676" + y="0" + x="0">√</tspan></text> +</g><g + id="g7686" + clip-path="url(#clipPath4501)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#d0cece" + id="text7684" + font-size="14.04px" + transform="matrix(1,0,0,-1,229.8,250.63)"><tspan + id="tspan7682" + y="0" + x="0">√</tspan></text> +</g><g + id="g7692" + clip-path="url(#clipPath4513)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#d0cece" + id="text7690" + font-size="14.04px" + transform="matrix(1,0,0,-1,453.53,286.63)"><tspan + id="tspan7688" + y="0" + x="0">√</tspan></text> +</g><g + id="g7698" + clip-path="url(#clipPath4525)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#8497b0" + id="text7696" + font-size="14.04px" + transform="matrix(1,0,0,-1,507.43,286.63)"><tspan + id="tspan7694" + y="0" + x="0">√</tspan></text> +</g><g + id="g7704" + clip-path="url(#clipPath4537)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#8497b0" + id="text7702" + font-size="14.04px" + transform="matrix(1,0,0,-1,561.05,286.63)"><tspan + id="tspan7700" + y="0" + x="0">√</tspan></text> +</g><g + id="g7710" + clip-path="url(#clipPath4549)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#d0cece" + id="text7708" + font-size="14.04px" + transform="matrix(1,0,0,-1,667.39,318.89)"><tspan + id="tspan7706" + y="0" + x="0">√</tspan></text> +</g><g + id="g7716" + clip-path="url(#clipPath4561)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#8497b0" + id="text7714" + font-size="14.04px" + transform="matrix(1,0,0,-1,720.14,318.89)"><tspan + id="tspan7712" + y="0" + x="0">√</tspan></text> +</g><g + id="g7722" + clip-path="url(#clipPath4573)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#8497b0" + id="text7720" + font-size="14.04px" + transform="matrix(1,0,0,-1,776.3,318.89)"><tspan + id="tspan7718" + y="0" + x="0">√</tspan></text> +</g><path + style="fill:#7030a0;stroke-width:1.33329999" + inkscape:connector-curvature="0" + id="path7724" + d="m 211.36594,305.0057 2.18661,-227.154316 c 0.0133,-1.0933 -0.87997,-1.99995 -1.98661,-2.01328 -1.09331,-0.0133 -1.99995,0.87998 -2.01329,1.98662 l -2.18661,227.140986 c -0.0133,1.10663 0.87998,2.01328 1.98662,2.02661 1.10664,0.0133 1.99995,-0.87998 2.01328,-1.98662 z m -7.97313,-2.07994 5.87985,12.06636 6.11985,-11.94637 z" /><path + style="fill:#7030a0;stroke-width:1.33329999" + inkscape:connector-curvature="0" + id="path7726" + d="M 289.03067,238.94069 V 107.43731 c 0,-1.10664 -0.89331,-1.99995 -1.99995,-1.99995 -1.10664,0 -1.99995,0.89331 -1.99995,1.99995 v 131.50338 c 0,1.09331 0.89331,1.99995 1.99995,1.99995 1.10664,0 1.99995,-0.90664 1.99995,-1.99995 z m -7.9998,-1.99995 5.99985,11.9997 5.99985,-11.9997 z" /><g + id="g7732" + clip-path="url(#clipPath4589)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7730" + font-size="14.04px" + transform="matrix(1,0,0,-1,164.59,422.74)"><tspan + id="tspan7728" + y="0" + x="0 6.3460798 13.46436 20.52648 23.75568 31.88484 39.578758 43.06068 46.065239 49.294441 54.784081 57.957119 65.271957 72.263878 78.118561 81.347763 88.072922 92.762283 99.754204 107.04096 110.38248 117.10764 120.33684 123.56604 130.17888 137.50777 144.49968 151.78644 155.12796 165.16656 168.43788 173.14128 180.44208 183.67128 190.01736 197.13564 204.19775 207.77795 214.89624 221.94432 225.17352 229.9752 236.70036">v20 ABI is declared aligned with v19.11 LTS</tspan></text> +</g><g + id="g7738" + clip-path="url(#clipPath4601)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.06400013px;font-family:Calibri;fill:#000000" + id="text7736" + font-size="14.064px" + transform="matrix(1,0,0,-1,222.12,398.3)"><tspan + id="tspan7734" + y="0" + x="0 6.3569279 13.445184 20.519377 23.740032 29.014032 35.385025 46.537777 53.851055 61.262783 64.497505 70.038719 73.034355 79.771011 84.440254 91.401939 94.622589 101.35925 108.65846 115.97174 122.93343 130.2467 133.59393 140.3306 147.62981 154.94308 158.16374 164.52068 171.60893 178.68312 181.90378 187.17778 193.54877 204.70152 212.0148 219.42653 222.66125 228.20247 231.32468 238.06133 242.73058 249.69226 252.81447 263.98129 271.39301 278.77661 282.01132 286.30084 289.53555 296.53943 303.82458 307.34061 310.51904 316.0462 323.3595 330.67276 337.98605 345.39777 350.30612 355.01755 358.13977 362.21832 369.63004 374.53839 377.5762 383.93314 391.02139 398.09558 401.2178 409.36084 417.03979 420.51361 423.6358 429.40204 436.81378 444.04266 448.75412 451.98883 459.28806 466.60132 473.56302 479.06204">v21 symbols are added and v20 symbols are modified, support for v20 ABI continues.</tspan></text> +</g><path + style="fill:#7030a0;stroke-width:1.33329999" + inkscape:connector-curvature="0" + id="path7740" + d="m 510.78512,258.56686 -0.31999,-126.17017 c 0,-1.09331 0.89331,-1.99995 1.99995,-1.99995 1.09331,0 1.99995,0.89331 1.99995,1.99995 l 0.31999,126.15684 c 0,1.10664 -0.89331,2.01328 -1.99995,2.01328 -1.0933,0 -1.99995,-0.89331 -1.99995,-1.99995 z m 7.9998,-2.01328 -5.97318,12.01303 -6.02652,-11.98636 z" /><g + id="g7746" + clip-path="url(#clipPath4615)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7744" + font-size="14.04px" + transform="matrix(1,0,0,-1,388.51,373.39)"><tspan + id="tspan7742" + y="0" + x="0 6.3460798 13.46436 20.52648 23.75568 31.88484 39.578758 43.06068 46.065239 49.294441 54.784081 57.957119 65.271957 72.263878 78.118561 81.347763 88.072922 92.762283 99.754204 107.04096 110.38248 117.10764 120.33684 123.56604 130.17888 137.50777 144.49968 151.78644 155.12796 165.16656 168.43788 173.14128 180.44208 183.67128 190.01736 197.13564 204.19775 207.77795 214.89624 221.94432 225.17352 229.9752 236.70036 243.14471 246.65472 249.78564 254.46095 261.45288 272.58661 279.31177 282.54095 289.86984 293.09903 300.47003 307.02673 310.36823 316.71432 323.83261 330.89471 334.12393 339.40295 345.76309 356.92487 364.23972 371.63879 374.91013 380.39975 383.4324 390.15756 394.83289 401.8248 404.99783 409.71527 416.70721 427.84091 435.23999 441.51587 448.50781 455.79456">v21 ABI is declared aligned with v20.11 LTS, remaining v20 symbols are removed.</tspan></text> +</g><path + style="fill:none;stroke:#7030a0;stroke-width:2.07994795;stroke-miterlimit:10" + inkscape:connector-curvature="0" + id="path7748" + stroke-miterlimit="10" + d="M 278.23094,342.95142 H 449.58665 V 261.03347 H 278.23094 Z" /><g + id="g7754" + clip-path="url(#clipPath4629)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-weight:bold;font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7752" + font-weight="bold" + font-size="14.04px" + transform="matrix(1,0,0,-1,23.616,114.74)"><tspan + id="tspan7750" + y="0" + x="0 8.5082397 16.4268 20.17548 23.26428 30.817801 37.879921 42.821999 48.423962 51.93396 59.48748 67.026962">ABI Versions</tspan></text> +</g><g + id="g7760" + clip-path="url(#clipPath4641)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-weight:bold;font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7758" + font-weight="bold" + font-size="14.04px" + transform="matrix(1,0,0,-1,20.064,150.17)"><tspan + id="tspan7756" + y="0" + x="0 8.8451996 16.31448 25.159679 32.839561 36.0126 43.67844 50.740559 54.222481 61.284599 68.248444 73.850403 80.954643">DPDK Releases</tspan></text> +</g><g + id="g7766" + clip-path="url(#clipPath4653)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7764" + font-size="14.04px" + transform="matrix(1,0,0,-1,444,346.1)"><tspan + id="tspan7762" + y="0" + x="0 6.3460798 13.46436 20.52648 23.75568 29.034719 35.39484 46.556641 53.871479 61.270561 64.541878 70.031517 73.064163 79.789322 84.464638 91.456558 94.629601 101.35476 108.72576 116.02656 123.01848 130.30524 133.64676 140.37192 147.68677 155.0016 158.2308 164.57687 171.69516 178.75728 181.98648 187.26552 193.62564 204.78745 212.10228 219.50136 222.77267 228.26231 231.43536 238.16052 242.80775 249.79968 252.88847 264.05029 271.44937 278.82037 282.04956 286.33176 289.60309 296.595 303.88177 307.39175 310.56479 316.1106 323.42545 330.74026 338.05511 345.45419 350.39627 355.09967 358.20251 362.28815 369.68723 374.62933 377.63388 383.97995 391.09824 398.16037 401.27725 409.4064 417.10031 420.58224 423.69913 429.45551 436.85461 444.09924 448.80264 452.03183 459.33264 466.64749 473.6394 479.12903 488.81665 492.43896">v22 symbols are added and v21 symbols are modified, support for v21 ABI continues…..</tspan></text> +</g><path + style="fill:#7030a0;stroke-width:1.33329999" + inkscape:connector-curvature="0" + id="path7768" + d="m 583.39664,198.26171 -0.13333,-30.49257 c 0,-1.10664 0.89331,-2.01329 1.98662,-2.01329 1.10664,0 2.01328,0.89331 2.01328,1.98662 l 0.13333,30.49257 c 0,1.10664 -0.89331,2.01328 -1.99995,2.01328 -1.0933,0 -1.99995,-0.89331 -1.99995,-1.98661 z m 7.98647,-2.03995 -5.94652,12.02636 -6.05318,-11.97303 z" /><path + style="fill:none;stroke:#7030a0;stroke-width:2.07994795;stroke-miterlimit:10" + inkscape:connector-curvature="0" + id="path7770" + stroke-miterlimit="10" + d="M 571.18361,299.43251 H 742.37933 V 212.87467 H 571.18361 Z" /><path + style="fill:#00b050;fill-rule:evenodd;stroke-width:1.33329999" + inkscape:connector-curvature="0" + id="path7772" + d="m 933.01457,30.959224 c 0,-6.22651 4.50655,-11.27972 10.07975,-11.27972 5.57319,0 10.07974,5.05321 10.07974,11.27972 0,6.22651 -4.50655,11.27972 -10.07974,11.27972 -5.5732,0 -10.07975,-5.05321 -10.07975,-11.27972 z" /><path + style="fill:#ff0000;fill-rule:evenodd;stroke-width:1.33329999" + inkscape:connector-curvature="0" + id="path7774" + d="m 1081.3309,29.759254 c 0,-6.18651 4.4798,-11.19972 9.9997,-11.19972 5.5199,0 9.9998,5.01321 9.9998,11.19972 0,6.18651 -4.4799,11.19972 -9.9998,11.19972 -5.5199,0 -9.9997,-5.01321 -9.9997,-11.19972 z" /><g + id="g7780" + clip-path="url(#clipPath4673)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7778" + font-size="14.04px" + transform="matrix(1,0,0,-1,744.89,439.54)"><tspan + id="tspan7776" + y="0" + x="0 4.8016801 11.52684 17.971201 21.144239 28.5714 35.56332 38.792519 45.728279 52.453442 57.943081">LTS Release</tspan></text> +</g><g + id="g7786" + clip-path="url(#clipPath4685)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7784" + font-size="14.04px" + transform="matrix(1,0,0,-1,856.06,439.75)"><tspan + id="tspan7782" + y="0" + x="0 12.0042 15.2334 22.562281 29.961361 34.903439 38.020321 45.461521 52.453442 55.68264 62.618401 69.343559 74.833199">Minor Release</tspan></text> +</g><path + style="fill:#44546a;stroke-width:1.33329999" + inkscape:connector-curvature="0" + id="path7788" + d="m 779.25841,46.265514 v -25.14604 c 0,-1.10664 -0.89331,-1.99995 -1.99995,-1.99995 -1.10664,0 -1.99995,0.89331 -1.99995,1.99995 v 25.14604 c 0,1.0933 0.89331,1.99995 1.99995,1.99995 1.10664,0 1.99995,-0.90665 1.99995,-1.99995 z m 3.9999,-23.14609 -5.99985,-11.9997 -5.99985,11.9997 z" /><g + id="g7794" + clip-path="url(#clipPath4699)" + transform="matrix(1.3333,0,0,-1.3333,-24.241503,623.02442)"><text + style="font-size:14.03999996px;font-family:Calibri;fill:#000000" + id="text7792" + font-size="14.04px" + transform="matrix(1,0,0,-1,622.34,439.54)"><tspan + id="tspan7790" + y="0" + x="0 8.1291599 15.82308 19.305 22.309561 29.512079 36.504002 41.151241 46.640881 49.870079 57.339359">ABI Version</tspan></text> +</g><path + style="fill:none;stroke:#002060;stroke-width:1.27996802;stroke-miterlimit:10" + inkscape:connector-curvature="0" + id="path7796" + stroke-miterlimit="10" + d="M 763.41881,62.078444 H 1236.847 V 0.63998401 H 763.41881 Z" /></svg> \ No newline at end of file diff --git a/doc/guides/contributing/img/what_is_an_abi.svg b/doc/guides/contributing/img/what_is_an_abi.svg new file mode 100644 index 0000000..fd3d993 --- /dev/null +++ b/doc/guides/contributing/img/what_is_an_abi.svg @@ -0,0 +1,382 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<svg + xmlns:dc="http://purl.org/dc/elements/1.1/" + xmlns:cc="http://creativecommons.org/ns#" + xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" + xmlns:svg="http://www.w3.org/2000/svg" + xmlns="http://www.w3.org/2000/svg" + xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd" + xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape" + width="970.69568" + height="522.22693" + version="1.1" + viewBox="0 0 970.69568 522.22693" + xml:space="preserve" + id="svg8399" + sodipodi:docname="what_is_an_abi.svg" + inkscape:version="0.92.2 (5c3e80d, 2017-08-06)"><metadata + id="metadata8403"><rdf:RDF><cc:Work + rdf:about=""><dc:format>image/svg+xml</dc:format><dc:type + rdf:resource="http://purl.org/dc/dcmitype/StillImage" /></cc:Work></rdf:RDF></metadata><sodipodi:namedview + pagecolor="#ffffff" + bordercolor="#666666" + borderopacity="1" + objecttolerance="10" + gridtolerance="10" + guidetolerance="10" + inkscape:pageopacity="0" + inkscape:pageshadow="2" + inkscape:window-width="1920" + inkscape:window-height="1017" + id="namedview8401" + showgrid="false" + inkscape:zoom="0.62755727" + inkscape:cx="820.83951" + inkscape:cy="-47.473217" + inkscape:window-x="-8" + inkscape:window-y="-8" + inkscape:window-maximized="1" + inkscape:current-layer="svg8399" /><defs + id="defs8269"><clipPath + id="clipPath26"><path + d="M 0,1.2207e-4 H 960 V 540.00012 H 0 Z" + id="path8206" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><radialGradient + id="radialGradient40" + cx="0" + cy="0" + r="1" + gradientTransform="matrix(386.44367,-1.3123672e-5,-1.3123672e-5,-386.44367,470.30824,246.15384)" + gradientUnits="userSpaceOnUse"><stop + stop-color="#f9d8e2" + offset="0" + id="stop8209" /><stop + stop-color="#fff" + offset=".74" + id="stop8211" /><stop + stop-color="#fff" + offset=".83" + id="stop8213" /><stop + stop-color="#fff" + offset="1" + id="stop8215" /></radialGradient><clipPath + id="clipPath56"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path8218" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath68"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path8221" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath82"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path8224" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath96"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path8227" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath108"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path8230" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath120"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path8233" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath132"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path8236" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath144"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path8239" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath156"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path8242" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath168"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path8245" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath180"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path8248" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath192"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path8251" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath204"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path8254" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath216"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path8257" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath228"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path8260" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath240"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path8263" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath><clipPath + id="clipPath260"><path + d="M 1.4305e-5,0 H 960.00001 V 540 H 1.4305e-5 Z" + id="path8266" + inkscape:connector-curvature="0" + style="clip-rule:evenodd" /></clipPath></defs><path + inkscape:connector-curvature="0" + style="fill:url(#radialGradient40);fill-rule:evenodd;stroke-width:1.33329999" + id="path8275" + d="m 116.15709,143.06309 c 0,-28.46596 23.07942,-51.545378 51.54538,-51.545378 h 605.21154 c 28.46595,0 51.54537,23.079418 51.54537,51.545378 V 349.2446 c 0,28.46595 -23.07942,51.54538 -51.54537,51.54538 H 167.70247 c -28.46595,0 -51.54538,-23.07943 -51.54538,-51.54538 z" /><path + style="fill:#00b050;stroke-width:1.33329999" + inkscape:connector-curvature="0" + id="path8277" + d="m 478.70803,73.758152 0.58665,373.057338 c 0,1.67996 -1.35997,3.03993 -3.03992,3.03993 -1.67996,0.0133 -3.03993,-1.34663 -3.03993,-3.02659 L 472.62818,73.758152 c 0,-1.67995 1.35997,-3.03992 3.03992,-3.03992 1.67996,0 3.03993,1.35997 3.03993,3.03992 z m 6.65317,370.004088 -9.09311,18.25287 -9.14644,-18.22621 z" /><path + style="fill:none;stroke:#7030a0;stroke-width:6.07984781;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:10" + inkscape:connector-curvature="0" + id="path8279" + stroke-miterlimit="10" + d="m 3.0399239,186.92866 c 0,-36.70575 29.7459201,-66.45167 66.4516701,-66.45167 H 778.00721 c 36.70575,0 66.45167,29.74592 66.45167,66.45167 v 265.80669 c 0,36.70574 -29.74592,66.45167 -66.45167,66.45167 H 69.491594 c -36.70575,0 -66.4516701,-29.74593 -66.4516701,-66.45167 z" /><path + style="fill:none;stroke:#3b3059;stroke-width:6.07984781;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:10" + inkscape:connector-curvature="0" + id="path8281" + stroke-miterlimit="10" + d="m 101.27746,71.464882 c 0,-37.78572 30.63924,-68.4249581 68.42496,-68.4249581 h 729.52846 c 37.7857,0 68.4249,30.6392381 68.4249,68.4249581 V 345.1647 c 0,37.78572 -30.6392,68.42496 -68.4249,68.42496 H 169.70242 c -37.78572,0 -68.42496,-30.63924 -68.42496,-68.42496 z" /><g + id="g8287" + clip-path="url(#clipPath56)" + transform="matrix(1.3333,0,0,-1.3333,-143.35642,633.10417)"><text + style="font-size:32.06399918px;font-family:'Century Gothic';fill:#3b3059" + id="text8285" + font-size="32.064px" + transform="matrix(1,0,0,-1,409.78,93.312)"><tspan + id="tspan8283" + y="0" + x="0 23.855616 42.837505 66.693123">DPDK</tspan></text> +</g><g + id="g8293" + clip-path="url(#clipPath68)" + transform="matrix(1.3333,0,0,-1.3333,-143.35642,633.10417)"><text + style="font-size:32.06399918px;font-family:'Century Gothic';fill:#3b3059" + id="text8291" + font-size="32.064px" + transform="matrix(1,0,0,-1,358.03,435.43)"><tspan + id="tspan8289" + y="0" + x="0 23.72736 45.595009 67.462654 73.875458 80.160004 100.90541 122.80512 133.54655 139.95937 160.96127">Application</tspan></text> +</g><path + style="fill:#f9d8e2;fill-opacity:0.70196001;fill-rule:evenodd;stroke-width:1.33329999" + inkscape:connector-curvature="0" + id="path8295" + d="M 424.30939,345.59136 H 531.18672 V 277.91305 H 424.30939 Z" /><g + id="g8301" + clip-path="url(#clipPath82)" + transform="matrix(1.3333,0,0,-1.3333,-143.35642,633.10417)"><text + style="font-size:32.04000092px;font-family:'Century Gothic';fill:#3b3059" + id="text8299" + font-size="32.04px" + transform="matrix(1,0,0,-1,432.96,231.41)"><tspan + id="tspan8297" + y="0" + x="0 23.7096 42.67728">API</tspan></text> +</g><path + style="fill:#f9d8e2;fill-opacity:0.70196001;fill-rule:evenodd;stroke-width:1.33329999" + inkscape:connector-curvature="0" + id="path8303" + d="m 422.38944,213.91465 h 107.19732 v -67.8383 H 422.38944 Z" /><g + id="g8309" + clip-path="url(#clipPath96)" + transform="matrix(1.3333,0,0,-1.3333,-143.35642,633.10417)"><text + style="font-size:32.04000092px;font-family:'Century Gothic';fill:#3b3059" + id="text8307" + font-size="32.04px" + transform="matrix(1,0,0,-1,431.54,330.29)"><tspan + id="tspan8305" + y="0" + x="0 23.7096 42.100559">ABI</tspan></text> +</g><g + id="g8315" + clip-path="url(#clipPath108)" + transform="matrix(1.3333,0,0,-1.3333,-143.35642,633.10417)"><text + style="font-size:15.96000004px;font-family:'Century Gothic';fill:#3b3059" + id="text8313" + font-size="15.96px" + transform="matrix(1,0,0,-1,221.78,293.23)"><tspan + id="tspan8311" + y="0" + x="0 9.4483204 14.25228 24.706079 35.447159 40.203239 51.10392 66.106323 81.076797 84.332642 94.068237">Programming</tspan></text> +</g><g + id="g8321" + clip-path="url(#clipPath120)" + transform="matrix(1.3333,0,0,-1.3333,-143.35642,633.10417)"><text + style="font-size:15.98400021px;font-family:'Century Gothic';fill:#3b3059" + id="text8319" + font-size="15.984px" + transform="matrix(1,0,0,-1,221.78,274.03)"><tspan + id="tspan8317" + y="0" + x="0 7.320672 18.237743 27.987984 38.633327 48.351601 59.268673 69.945984">Language</tspan></text> +</g><g + id="g8327" + clip-path="url(#clipPath132)" + transform="matrix(1.3333,0,0,-1.3333,-143.35642,633.10417)"><text + style="font-size:15.96000004px;font-family:'Century Gothic';fill:#3b3059" + id="text8325" + font-size="15.96px" + transform="matrix(1,0,0,-1,221.78,254.81)"><tspan + id="tspan8323" + y="0" + x="0 7.6767602 17.38044 27.116039 37.442162 42.708961 45.93288 56.386681 66.122276">Functions</tspan></text> +</g><g + id="g8333" + clip-path="url(#clipPath144)" + transform="matrix(1.3333,0,0,-1.3333,-143.35642,633.10417)"><text + style="font-size:15.96000004px;font-family:'Century Gothic';fill:#3b3059" + id="text8331" + font-size="15.96px" + transform="matrix(1,0,0,-1,221.78,235.61)"><tspan + id="tspan8329" + y="0" + x="0 11.87424 22.77492 28.073641 38.974319 44.273041 52.891441 63.776161 74.150162">Datatypes</tspan></text> +</g><g + id="g8339" + clip-path="url(#clipPath156)" + transform="matrix(1.3333,0,0,-1.3333,-143.35642,633.10417)"><text + style="font-size:15.96000004px;font-family:'Century Gothic';fill:#3b3059" + id="text8337" + font-size="15.96px" + transform="matrix(1,0,0,-1,221.78,216.41)"><tspan + id="tspan8335" + y="0" + x="0 9.6877203 20.06172 25.312559 35.016239 39.820202 49.555801 54.216122 60.823559 69.441963 80.326683 90.700684">Return Types</tspan></text> +</g><g + id="g8345" + clip-path="url(#clipPath168)" + transform="matrix(1.3333,0,0,-1.3333,-143.35642,633.10417)"><text + style="font-size:15.96000004px;font-family:'Century Gothic';fill:#3b3059" + id="text8343" + font-size="15.96px" + transform="matrix(1,0,0,-1,221.78,197.21)"><tspan + id="tspan8341" + y="0" + x="0 12.97548 23.429279 33.164879 39.357361 44.640121 55.540798 65.276398 70.559158">Constants</tspan></text> +</g><g + id="g8351" + clip-path="url(#clipPath180)" + transform="matrix(1.3333,0,0,-1.3333,-143.35642,633.10417)"><text + style="font-size:15.96000004px;font-family:'Century Gothic';fill:#3b3059" + id="text8349" + font-size="15.96px" + transform="matrix(1,0,0,-1,221.78,178.01)"><tspan + id="tspan8347" + y="0" + x="0">…</tspan></text> +</g><g + id="g8357" + clip-path="url(#clipPath192)" + transform="matrix(1.3333,0,0,-1.3333,-143.35642,633.10417)"><text + style="font-size:15.96000004px;font-family:'Century Gothic';fill:#3b3059" + id="text8355" + font-size="15.96px" + transform="matrix(1,0,0,-1,546.38,354.12)"><tspan + id="tspan8353" + y="0" + x="0 3.8304 13.566 19.75848 25.07316 29.877119 39.580799 49.906921 55.189678 58.413601 68.867401 78.602997 83.2314 89.423882 99.797882">Instruction set</tspan></text> +</g><g + id="g8363" + clip-path="url(#clipPath204)" + transform="matrix(1.3333,0,0,-1.3333,-143.35642,633.10417)"><text + style="font-size:15.98400021px;font-family:'Century Gothic';fill:#3b3059" + id="text8361" + font-size="15.984px" + transform="matrix(1,0,0,-1,546.38,332.88)"><tspan + id="tspan8359" + y="0" + x="0 8.5674238 16.239744 26.517456 36.859104 46.577377 51.836113 62.753185 73.654274 77.026894 87.352562 91.892014 103.99191 108.33955 115.66022 118.85703 128.60727 136.63123 147.02083">Executable & Linker</tspan></text> +</g><g + id="g8369" + clip-path="url(#clipPath216)" + transform="matrix(1.3333,0,0,-1.3333,-143.35642,633.10417)"><text + style="font-size:15.96000004px;font-family:'Century Gothic';fill:#3b3059" + id="text8367" + font-size="15.96px" + transform="matrix(1,0,0,-1,546.38,313.66)"><tspan + id="tspan8365" + y="0" + x="0 7.6767602 18.13056 22.934521 37.904999 48.805679">Format</tspan></text> +</g><g + id="g8375" + clip-path="url(#clipPath228)" + transform="matrix(1.3333,0,0,-1.3333,-143.35642,633.10417)"><text + style="font-size:15.96000004px;font-family:'Century Gothic';fill:#3b3059" + id="text8373" + font-size="15.96px" + transform="matrix(1,0,0,-1,546.38,292.42)"><tspan + id="tspan8371" + y="0" + x="0 12.97548 23.87616 27.22776 30.579359 33.80328 43.538879 54.200161 58.39764 71.373123 81.82692 91.562523 100.6278 110.95392 120.68952 125.95632 129.18024 139.63403 149.36964 155.56212">Calling Conventions.</tspan></text> +</g><g + id="g8381" + clip-path="url(#clipPath240)" + transform="matrix(1.3333,0,0,-1.3333,-143.35642,633.10417)"><text + style="font-size:15.96000004px;font-family:'Century Gothic';fill:#3b3059" + id="text8379" + font-size="15.96px" + transform="matrix(1,0,0,-1,546.38,271.3)"><tspan + id="tspan8377" + y="0" + x="0">…</tspan></text> +</g><path + style="fill:none;stroke:#ffffff;stroke-width:6.07984781;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:10;stroke-dasharray:18.239544, 24.319392" + inkscape:connector-curvature="0" + id="path8383" + stroke-miterlimit="10" + d="M 122.71693,120.47699 H 782.84709" /><path + style="fill:none;stroke:#ffffff;stroke-width:6.07984781;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:10;stroke-dasharray:18.239544, 24.319392" + inkscape:connector-curvature="0" + id="path8385" + stroke-miterlimit="10" + d="M 177.27556,413.58966 H 837.40573" /><g + id="g8391" + clip-path="url(#clipPath260)" + transform="matrix(1.3333,0,0,-1.3333,-143.35642,633.10417)"><text + style="font-style:italic;font-size:15.96000004px;font-family:'Century Gothic';fill:#3b3059" + id="text8389" + font-style="italic" + font-size="15.96px" + transform="matrix(1,0,0,-1,483.19,405.82)"><tspan + id="tspan8387" + y="0" + x="0 5.0114398 14.71512 24.45072 34.77684 40.299 43.522919 53.976719 63.712318 68.13324 78.459358 89.360039 92.583961 95.807877">function calls</tspan></text> +</g><path + style="fill:none;stroke:#3b3059;stroke-width:0.95997602;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:10" + inkscape:connector-curvature="0" + id="path8393" + stroke-miterlimit="10" + d="m 574.38564,303.03242 c -11.93304,0 -21.59946,-1.61329 -21.59946,-3.59991 V 164.62255 c 0,-1.98662 -9.66643,-3.59991 -21.59946,-3.59991 11.93303,0 21.59946,-1.61329 21.59946,-3.59991 v -18.30621 c 0,-1.98662 9.66642,-3.59991 21.59946,-3.59991" /><path + style="fill:none;stroke:#3b3059;stroke-width:0.95997602;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:10" + inkscape:connector-curvature="0" + id="path8395" + stroke-miterlimit="10" + d="m 372.63068,389.43026 c 13.293,0 24.0794,-1.79995 24.0794,-4.01323 v -91.53105 c 0,-2.21327 10.78639,-4.01323 24.0794,-4.01323 -13.29301,0 -24.0794,-1.79995 -24.0794,-4.01323 v -65.3717 c 0,-2.21328 -10.7864,-4.01323 -24.0794,-4.01323" /></svg> \ No newline at end of file diff --git a/doc/guides/contributing/stable.rst b/doc/guides/contributing/stable.rst index 6a5eee9..4d38bb8 100644 --- a/doc/guides/contributing/stable.rst +++ b/doc/guides/contributing/stable.rst @@ -1,7 +1,7 @@ .. SPDX-License-Identifier: BSD-3-Clause Copyright 2018 The DPDK contributors -.. stable_lts_releases: +.. _stable_lts_releases: DPDK Stable Releases and Long Term Support ========================================== @@ -53,6 +53,9 @@ year's November (X.11) release will be maintained as an LTS for 2 years. After the X.11 release, an LTS branch will be created for it at http://git.dpdk.org/dpdk-stable where bugfixes will be backported to. +A LTS release may align with the declaration of a new major ABI version, +please read the :doc:`abi_policy` for more information. + It is anticipated that there will be at least 4 releases per year of the LTS or approximately 1 every 3 months. However, the cadence can be shorter or longer depending on the number and criticality of the backported @@ -119,10 +122,3 @@ A Stable Release will be released by: list. Stable releases are available on the `dpdk.org download page <http://core.dpdk.org/download/>`_. - - -ABI ---- - -The Stable Release should not be seen as a way of breaking or circumventing -the DPDK ABI policy. -- 2.7.4 ^ permalink raw reply [flat|nested] 20+ messages in thread
* [dpdk-dev] [PATCH v11 3/3] doc: updates to versioning guide for abi versions 2019-11-11 11:57 ` [dpdk-dev] [PATCH v11 0/3] doc: changes to abi policy introducing major " Ray Kinsella 2019-11-11 11:57 ` [dpdk-dev] [PATCH v11 1/3] doc: separate versioning.rst into version and policy Ray Kinsella 2019-11-11 11:57 ` [dpdk-dev] [PATCH v11 2/3] doc: changes to abi policy introducing major abi versions Ray Kinsella @ 2019-11-11 11:57 ` Ray Kinsella 2019-11-12 7:55 ` [dpdk-dev] [PATCH v11 0/3] doc: changes to abi policy introducing major " Thomas Monjalon 3 siblings, 0 replies; 20+ messages in thread From: Ray Kinsella @ 2019-11-11 11:57 UTC (permalink / raw) To: dev Cc: mdr, thomas, stephen, bruce.richardson, ferruh.yigit, konstantin.ananyev, jerinj, olivier.matz, nhorman, maxime.coquelin, john.mcnamara, marko.kovacevic, hemant.agrawal, ktraynor, aconole Updates to the ABI versioning guide, to account for the changes to the DPDK ABI/API policy. Fixes for references to abi versioning and policy guides. Signed-off-by: Ray Kinsella <mdr@ashroe.eu> Acked-by: John Mcnamara <john.mcnamara@intel.com> Acked-by: Stephen Hemminger <stephen@networkplumber.org> --- doc/guides/contributing/abi_policy.rst | 15 +- doc/guides/contributing/abi_versioning.rst | 250 +++++++++++++++++++---------- doc/guides/contributing/patches.rst | 6 +- doc/guides/rel_notes/deprecation.rst | 6 +- 4 files changed, 183 insertions(+), 94 deletions(-) diff --git a/doc/guides/contributing/abi_policy.rst b/doc/guides/contributing/abi_policy.rst index 81b617c..05ca959 100644 --- a/doc/guides/contributing/abi_policy.rst +++ b/doc/guides/contributing/abi_policy.rst @@ -19,11 +19,11 @@ General Guidelines #. Major ABI versions are usually but not always declared aligned with a :ref:`LTS release <stable_lts_releases>`. #. The ABI version is managed at a project level in DPDK, and is reflected in - all non-experimental library's soname. + all non-experimental :ref:`library's soname <what_is_soname>`. #. The ABI should be preserved and not changed lightly. ABI changes must follow the outlined :ref:`deprecation process <abi_changes>`. #. The addition of symbols is generally not problematic. The modification of - symbols is managed with ABI Versioning. + symbols is managed with :ref:`ABI Versioning <abi_versioning>`. #. The removal of symbols is considered an :ref:`ABI breakage <abi_breakages>`, once approved these will form part of the next ABI version. #. Libraries or APIs marked as :ref:`experimental <experimental_apis>` may @@ -68,13 +68,14 @@ An ABI version is an instance of a library's ABI at a specific release. Certain releases are considered to be milestone releases, the yearly LTS release for example. The ABI of a milestone release may be declared as a 'major ABI version', where this ABI version is then supported for some number of subsequent -releases and is annotated in the library's soname. +releases and is annotated in the library's :ref:`soname<what_is_soname>`. ABI version support in subsequent releases facilitates application upgrades, by enabling applications built against the milestone release to upgrade to subsequent releases of a library without a rebuild. -More details on major ABI version can be found in the ABI Versioning guide. +More details on major ABI version can be found in the :ref:`ABI versioning +<major_abi_versions>` guide. The DPDK ABI policy ------------------- @@ -147,7 +148,7 @@ The requirements for changing the ABI are: CPU vendors, end-users, etc. #. Backward compatibility with the major ABI version must be maintained through - ABI Versioning, with :ref:`forward-only <forward-only>` compatibility + :ref:`abi_versioning`, with :ref:`forward-only <forward-only>` compatibility offered for any ABI changes that are indicated to be part of the next ABI version. @@ -224,7 +225,7 @@ declarations of major ABI versions. * DPDK 20.02 release defines a new function ``rte_foo(uint8_t bar)``, and this is not a problem as long as the symbol ``rte_foo@DPDK20`` is - preserved through ABI Versioning. + preserved through :ref:`abi_versioning`. - The new function may be marked with the ``__rte_experimental`` tag for a number of releases, as described in the section :ref:`experimental_apis`. @@ -322,5 +323,5 @@ Libraries Libraries marked as ``experimental`` are entirely not considered part of an ABI version, and may change without warning at any time. Experimental libraries always have a major version of ``0`` to indicate they exist outside of -ABI Versioning, with the minor version incremented with each ABI change +:ref:`abi_versioning` , with the minor version incremented with each ABI change to library. diff --git a/doc/guides/contributing/abi_versioning.rst b/doc/guides/contributing/abi_versioning.rst index d278de4..050c971 100644 --- a/doc/guides/contributing/abi_versioning.rst +++ b/doc/guides/contributing/abi_versioning.rst @@ -1,44 +1,134 @@ .. SPDX-License-Identifier: BSD-3-Clause Copyright 2018 The DPDK contributors -.. library_versioning: +.. _abi_versioning: -Library versioning +ABI Versioning +============== + +This document details the mechanics of ABI version management in DPDK. + +.. _what_is_soname: + +What is a library's soname? +--------------------------- + +System libraries usually adopt the familiar major and minor version naming +convention, where major versions (e.g. ``librte_eal 20.x, 21.x``) are presumed +to be ABI incompatible with each other and minor versions (e.g. ``librte_eal +20.1, 20.2``) are presumed to be ABI compatible. A library's `soname +<https://en.wikipedia.org/wiki/Soname>`_. is typically used to provide backward +compatibility information about a given library, describing the lowest common +denominator ABI supported by the library. The soname or logical name for the +library, is typically comprised of the library's name and major version e.g. +``librte_eal.so.20``. + +During an application's build process, a library's soname is noted as a runtime +dependency of the application. This information is then used by the `dynamic +linker <https://en.wikipedia.org/wiki/Dynamic_linker>`_ when resolving the +applications dependencies at runtime, to load a library supporting the correct +ABI version. The library loaded at runtime therefore, may be a minor revision +supporting the same major ABI version (e.g. ``librte_eal.20.2``), as the library +used to link the application (e.g ``librte_eal.20.0``). + +.. _major_abi_versions: + +Major ABI versions ------------------ -Downstreams might want to provide different DPDK releases at the same time to -support multiple consumers of DPDK linked against older and newer sonames. +An ABI version change to a given library, especially in core libraries such as +``librte_mbuf``, may cause an implicit ripple effect on the ABI of it's +consuming libraries, causing ABI breakages. There may however be no explicit +reason to bump a dependent library's ABI version, as there may have been no +obvious change to the dependent library's API, even though the library's ABI +compatibility will have been broken. + +This interdependence of DPDK libraries, means that ABI versioning of libraries +is more manageable at a project level, with all project libraries sharing a +**single ABI version**. In addition, the need to maintain a stable ABI for some +number of releases as described in the section :doc:`abi_policy`, means +that ABI version increments need to carefully planned and managed at a project +level. + +Major ABI versions are therefore declared typically aligned with an LTS release +and is then supported some number of subsequent releases, shared across all +libraries. This means that a single project level ABI version, reflected in all +individual library's soname, library filenames and associated version maps +persists over multiple releases. + +.. code-block:: none + + $ head ./lib/librte_acl/rte_acl_version.map + DPDK_20 { + global: + ... -Also due to the interdependencies that DPDK libraries can have applications -might end up with an executable space in which multiple versions of a library -are mapped by ld.so. + $ head ./lib/librte_eal/rte_eal_version.map + DPDK_20 { + global: + ... -Think of LibA that got an ABI bump and LibB that did not get an ABI bump but is -depending on LibA. +When an ABI change is made between major ABI versions to a given library, a new +section is added to that library's version map describing the impending new ABI +version, as described in the section :ref:`example_abi_macro_usage`. The +library's soname and filename however do not change, e.g. ``libacl.so.20``, as +ABI compatibility with the last major ABI version continues to be preserved for +that library. -.. note:: +.. code-block:: none - Application - \-> LibA.old - \-> LibB.new -> LibA.new + $ head ./lib/librte_acl/rte_acl_version.map + DPDK_20 { + global: + ... -That is a conflict which can be avoided by setting ``CONFIG_RTE_MAJOR_ABI``. -If set, the value of ``CONFIG_RTE_MAJOR_ABI`` overwrites all - otherwise per -library - versions defined in the libraries ``LIBABIVER``. -An example might be ``CONFIG_RTE_MAJOR_ABI=16.11`` which will make all libraries -``librte<?>.so.16.11`` instead of ``librte<?>.so.<LIBABIVER>``. + DPDK_21 { + global: + + } DPDK_20; + ... + $ head ./lib/librte_eal/rte_eal_version.map + DPDK_20 { + global: + ... + +However when a new ABI version is declared, for example DPDK ``21``, old +depreciated functions may be safely removed at this point and the entire old +major ABI version removed, see the section :ref:`deprecating_entire_abi` on +how this may be done. + +.. code-block:: none + + $ head ./lib/librte_acl/rte_acl_version.map + DPDK_21 { + global: + ... + + $ head ./lib/librte_eal/rte_eal_version.map + DPDK_21 { + global: + ... + +At the same time, the major ABI version is changed atomically across all +libraries by incrementing the major version in individual library's soname, e.g. +``libacl.so.21``. This is done by bumping the LIBABIVER number in the libraries +Makefile to indicate to dynamic linking applications that this is a later, and +possibly incompatible library version: + +.. code-block:: c + + -LIBABIVER := 20 + +LIBABIVER := 21 -ABI versioning --------------- Versioning Macros -~~~~~~~~~~~~~~~~~ +----------------- When a symbol is exported from a library to provide an API, it also provides a calling convention (ABI) that is embodied in its name, return type and arguments. Occasionally that function may need to change to accommodate new -functionality or behavior. When that occurs, it is desirable to allow for +functionality or behavior. When that occurs, it is may be required to allow for backward compatibility for a time with older binaries that are dynamically linked to the DPDK. @@ -65,8 +155,10 @@ The macros exported are: ``be`` to signal that it is being used as an implementation of a particular version of symbol ``b``. +.. _example_abi_macro_usage: + Examples of ABI Macro use -^^^^^^^^^^^^^^^^^^^^^^^^^ +~~~~~~~~~~~~~~~~~~~~~~~~~ Updating a public API _____________________ @@ -110,16 +202,16 @@ maintain previous ABI versions that are accessible only to previously compiled binaries The addition of a parameter to the function is ABI breaking as the function is -public, and existing application may use it in its current form. However, the +public, and existing application may use it in its current form. However, the compatibility macros in DPDK allow a developer to use symbol versioning so that multiple functions can be mapped to the same public symbol based on when an -application was linked to it. To see how this is done, we start with the -requisite libraries version map file. Initially the version map file for the -acl library looks like this +application was linked to it. To see how this is done, we start with the +requisite libraries version map file. Initially the version map file for the acl +library looks like this .. code-block:: none - DPDK_2.0 { + DPDK_20 { global: rte_acl_add_rules; @@ -145,7 +237,7 @@ This file needs to be modified as follows .. code-block:: none - DPDK_2.0 { + DPDK_20 { global: rte_acl_add_rules; @@ -167,16 +259,16 @@ This file needs to be modified as follows local: *; }; - DPDK_2.1 { + DPDK_21 { global: rte_acl_create; - } DPDK_2.0; + } DPDK_20; The addition of the new block tells the linker that a new version node is -available (DPDK_2.1), which contains the symbol rte_acl_create, and inherits the -symbols from the DPDK_2.0 node. This list is directly translated into a list of -exported symbols when DPDK is compiled as a shared library +available (DPDK_21), which contains the symbol rte_acl_create, and inherits +the symbols from the DPDK_20 node. This list is directly translated into a +list of exported symbols when DPDK is compiled as a shared library Next, we need to specify in the code which function map to the rte_acl_create symbol at which versions. First, at the site of the initial symbol definition, @@ -197,22 +289,22 @@ with the public symbol name Note that the base name of the symbol was kept intact, as this is conducive to the macros used for versioning symbols and we have annotated the function as an implementation of versioned symbol. That is our next step, mapping this new -symbol name to the initial symbol name at version node 2.0. Immediately after +symbol name to the initial symbol name at version node 20. Immediately after the function, we add this line of code .. code-block:: c - VERSION_SYMBOL(rte_acl_create, _v20, 2.0); + VERSION_SYMBOL(rte_acl_create, _v20, 20); -Remembering to also add the rte_function_versioning.h header to the requisite c file where -these changes are being made. The above macro instructs the linker to create a -new symbol ``rte_acl_create@DPDK_2.0``, which matches the symbol created in older -builds, but now points to the above newly named function. We have now mapped -the original rte_acl_create symbol to the original function (but with a new -name) +Remembering to also add the rte_function_versioning.h header to the requisite c +file where these changes are being made. The above macro instructs the linker to +create a new symbol ``rte_acl_create@DPDK_20``, which matches the symbol created +in older builds, but now points to the above newly named function. We have now +mapped the original rte_acl_create symbol to the original function (but with a +new name). -Next, we need to create the 2.1 version of the symbol. We create a new function -name, with a different suffix, and implement it appropriately +Next, we need to create the 21 version of the symbol. We create a new function +name, with a different suffix, and implement it appropriately .. code-block:: c @@ -226,12 +318,12 @@ name, with a different suffix, and implement it appropriately return ctx; } -This code serves as our new API call. Its the same as our old call, but adds -the new parameter in place. Next we need to map this function to the symbol -``rte_acl_create@DPDK_2.1``. To do this, we modify the public prototype of the call -in the header file, adding the macro there to inform all including applications, -that on re-link, the default rte_acl_create symbol should point to this -function. Note that we could do this by simply naming the function above +This code serves as our new API call. Its the same as our old call, but adds the +new parameter in place. Next we need to map this function to the symbol +``rte_acl_create@DPDK_21``. To do this, we modify the public prototype of the +call in the header file, adding the macro there to inform all including +applications, that on re-link, the default rte_acl_create symbol should point to +this function. Note that we could do this by simply naming the function above rte_acl_create, and the linker would chose the most recent version tag to apply in the version script, but we can also do this in the header file @@ -239,11 +331,11 @@ in the version script, but we can also do this in the header file struct rte_acl_ctx * -rte_acl_create(const struct rte_acl_param *param); - +rte_acl_create(const struct rte_acl_param *param, int debug); - +BIND_DEFAULT_SYMBOL(rte_acl_create, _v21, 2.1); + +rte_acl_create_v21(const struct rte_acl_param *param, int debug); + +BIND_DEFAULT_SYMBOL(rte_acl_create, _v21, 21); The BIND_DEFAULT_SYMBOL macro explicitly tells applications that include this -header, to link to the rte_acl_create_v21 function and apply the DPDK_2.1 +header, to link to the rte_acl_create_v21 function and apply the DPDK_21 version node to it. This method is more explicit and flexible than just re-implementing the exact symbol name, and allows for other features (such as linking to the old symbol version by default, when the new ABI is to be opt-in @@ -263,6 +355,7 @@ assumption is that the most recent version of the symbol is the one you want to map. So, back in the C file where, immediately after ``rte_acl_create_v21`` is defined, we add this + .. code-block:: c struct rte_acl_ctx * __vsym @@ -276,21 +369,22 @@ That tells the compiler that, when building a static library, any calls to the symbol ``rte_acl_create`` should be linked to ``rte_acl_create_v21`` That's it, on the next shared library rebuild, there will be two versions of -rte_acl_create, an old DPDK_2.0 version, used by previously built applications, -and a new DPDK_2.1 version, used by future built applications. +rte_acl_create, an old DPDK_20 version, used by previously built applications, +and a new DPDK_21 version, used by future built applications. Deprecating part of a public API ________________________________ -Lets assume that you've done the above update, and after a few releases have -passed you decide you would like to retire the old version of the function. -After having gone through the ABI deprecation announcement process, removal is -easy. Start by removing the symbol from the requisite version map file: +Lets assume that you've done the above update, and in preparation for the next +major ABI version you decide you would like to retire the old version of the +function. After having gone through the ABI deprecation announcement process, +removal is easy. Start by removing the symbol from the requisite version map +file: .. code-block:: none - DPDK_2.0 { + DPDK_20 { global: rte_acl_add_rules; @@ -312,48 +406,42 @@ easy. Start by removing the symbol from the requisite version map file: local: *; }; - DPDK_2.1 { + DPDK_21 { global: rte_acl_create; - } DPDK_2.0; + } DPDK_20; Next remove the corresponding versioned export. .. code-block:: c - -VERSION_SYMBOL(rte_acl_create, _v20, 2.0); + -VERSION_SYMBOL(rte_acl_create, _v20, 20); Note that the internal function definition could also be removed, but its used -in our example by the newer version _v21, so we leave it in place. This is a -coding style choice. - -Lastly, we need to bump the LIBABIVER number for this library in the Makefile to -indicate to applications doing dynamic linking that this is a later, and -possibly incompatible library version: - -.. code-block:: c +in our example by the newer version v21, so we leave it in place and declare it +as static. This is a coding style choice. - -LIBABIVER := 1 - +LIBABIVER := 2 +.. _deprecating_entire_abi: Deprecating an entire ABI version _________________________________ -While removing a symbol from and ABI may be useful, it is often more practical -to remove an entire version node at once. If a version node completely -specifies an API, then removing part of it, typically makes it incomplete. In -those cases it is better to remove the entire node +While removing a symbol from an ABI may be useful, it is more practical to +remove an entire version node at once, as is typically done at the declaration +of a major ABI version. If a version node completely specifies an API, then +removing part of it, typically makes it incomplete. In those cases it is better +to remove the entire node. To do this, start by modifying the version map file, such that all symbols from -the node to be removed are merged into the next node in the map +the node to be removed are merged into the next node in the map. In the case of our map above, it would transform to look as follows .. code-block:: none - DPDK_2.1 { + DPDK_21 { global: rte_acl_add_rules; @@ -381,8 +469,8 @@ symbols. .. code-block:: c - -BIND_DEFAULT_SYMBOL(rte_acl_create, _v20, 2.0); - +BIND_DEFAULT_SYMBOL(rte_acl_create, _v21, 2.1); + -BIND_DEFAULT_SYMBOL(rte_acl_create, _v20, 20); + +BIND_DEFAULT_SYMBOL(rte_acl_create, _v21, 21); Lastly, any VERSION_SYMBOL macros that point to the old version node should be removed, taking care to keep, where need old code in place to support newer diff --git a/doc/guides/contributing/patches.rst b/doc/guides/contributing/patches.rst index c9ec529..2140303 100644 --- a/doc/guides/contributing/patches.rst +++ b/doc/guides/contributing/patches.rst @@ -156,9 +156,9 @@ Make your planned changes in the cloned ``dpdk`` repo. Here are some guidelines * For other PMDs and more info, refer to the ``MAINTAINERS`` file. -* New external functions should be added to the local ``version.map`` file. - See the :doc:`Guidelines for ABI policy and versioning </contributing/abi_versioning>`. - New external functions should also be added in alphabetical order. +* New external functions should be added to the local ``version.map`` file. See + the :doc:`ABI policy <abi_policy>` and :ref:`ABI versioning <abi_versioning>` + guides. New external functions should also be added in alphabetical order. * Important changes will require an addition to the release notes in ``doc/guides/rel_notes/``. See the :ref:`Release Notes section of the Documentation Guidelines <doc_guidelines>` for details. diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst index 3de702a..bd0e204 100644 --- a/doc/guides/rel_notes/deprecation.rst +++ b/doc/guides/rel_notes/deprecation.rst @@ -4,9 +4,9 @@ ABI and API Deprecation ======================= -See the :doc:`guidelines document for details of the ABI policy </contributing/abi_versioning>`. -API and ABI deprecation notices are to be posted here. - +See the guidelines document for details of the :doc:`ABI policy +<../contributing/abi_policy>`. API and ABI deprecation notices are to be posted +here. Deprecation Notices ------------------- -- 2.7.4 ^ permalink raw reply [flat|nested] 20+ messages in thread
* Re: [dpdk-dev] [PATCH v11 0/3] doc: changes to abi policy introducing major abi versions 2019-11-11 11:57 ` [dpdk-dev] [PATCH v11 0/3] doc: changes to abi policy introducing major " Ray Kinsella ` (2 preceding siblings ...) 2019-11-11 11:57 ` [dpdk-dev] [PATCH v11 3/3] doc: updates to versioning guide for " Ray Kinsella @ 2019-11-12 7:55 ` Thomas Monjalon 2019-11-12 8:49 ` Ray Kinsella 3 siblings, 1 reply; 20+ messages in thread From: Thomas Monjalon @ 2019-11-12 7:55 UTC (permalink / raw) To: Ray Kinsella Cc: dev, stephen, bruce.richardson, ferruh.yigit, konstantin.ananyev, jerinj, olivier.matz, nhorman, maxime.coquelin, john.mcnamara, marko.kovacevic, hemant.agrawal, ktraynor, aconole 11/11/2019 12:57, Ray Kinsella: > TL;DR abbreviation: > A major ABI version that all DPDK releases during an agreed period support. ABI > versioning is managed at a project-level, in place of library-level management. > ABI changes to add new features are permitted, as long as ABI compatibility with > the major ABI version is maintained. > [...] > Ray Kinsella (3): > doc: separate versioning.rst into version and policy > doc: changes to abi policy introducing major abi versions > doc: updates to versioning guide for abi versions Applied, thanks ^ permalink raw reply [flat|nested] 20+ messages in thread
* Re: [dpdk-dev] [PATCH v11 0/3] doc: changes to abi policy introducing major abi versions 2019-11-12 7:55 ` [dpdk-dev] [PATCH v11 0/3] doc: changes to abi policy introducing major " Thomas Monjalon @ 2019-11-12 8:49 ` Ray Kinsella 0 siblings, 0 replies; 20+ messages in thread From: Ray Kinsella @ 2019-11-12 8:49 UTC (permalink / raw) To: Thomas Monjalon Cc: dev, stephen, bruce.richardson, ferruh.yigit, konstantin.ananyev, jerinj, olivier.matz, nhorman, maxime.coquelin, john.mcnamara, marko.kovacevic, hemant.agrawal, ktraynor, aconole On 12/11/2019 07:55, Thomas Monjalon wrote: > 11/11/2019 12:57, Ray Kinsella: >> TL;DR abbreviation: >> A major ABI version that all DPDK releases during an agreed period support. ABI >> versioning is managed at a project-level, in place of library-level management. >> ABI changes to add new features are permitted, as long as ABI compatibility with >> the major ABI version is maintained. >> > [...] >> Ray Kinsella (3): >> doc: separate versioning.rst into version and policy >> doc: changes to abi policy introducing major abi versions >> doc: updates to versioning guide for abi versions > > Applied, thanks > Thank you, Ray K ^ permalink raw reply [flat|nested] 20+ messages in thread
end of thread, other threads:[~2019-11-12 8:49 UTC | newest] Thread overview: 20+ messages (download: mbox.gz / follow: Atom feed) -- links below jump to the message on this page -- 2019-11-08 12:46 [dpdk-dev] [PATCH v9 0/4] doc: changes to abi policy introducing major abi versions Ray Kinsella 2019-11-08 12:46 ` [dpdk-dev] [PATCH v9 1/4] doc: separate versioning.rst into version and policy Ray Kinsella 2019-11-08 12:46 ` [dpdk-dev] [PATCH v9 2/4] doc: changes to abi policy introducing major abi versions Ray Kinsella 2019-11-08 17:11 ` Thomas Monjalon 2019-11-08 17:12 ` Ray Kinsella 2019-11-08 17:38 ` Thomas Monjalon 2019-11-11 11:03 ` Ray Kinsella 2019-11-08 12:46 ` [dpdk-dev] [PATCH v9 3/4] doc: updates to versioning guide for " Ray Kinsella 2019-11-08 12:46 ` [dpdk-dev] [PATCH v9 4/4] doc: add maintainer for abi policy Ray Kinsella 2019-11-08 17:18 ` Thomas Monjalon 2019-11-11 10:37 ` [dpdk-dev] [PATCH v10 0/3] doc: changes to abi policy introducing major abi versions Ray Kinsella 2019-11-11 10:37 ` [dpdk-dev] [PATCH v10 1/3] doc: separate versioning.rst into version and policy Ray Kinsella 2019-11-11 10:37 ` [dpdk-dev] [PATCH v10 2/3] doc: changes to abi policy introducing major abi versions Ray Kinsella 2019-11-11 10:37 ` [dpdk-dev] [PATCH v10 3/3] doc: updates to versioning guide for " Ray Kinsella 2019-11-11 11:57 ` [dpdk-dev] [PATCH v11 0/3] doc: changes to abi policy introducing major " Ray Kinsella 2019-11-11 11:57 ` [dpdk-dev] [PATCH v11 1/3] doc: separate versioning.rst into version and policy Ray Kinsella 2019-11-11 11:57 ` [dpdk-dev] [PATCH v11 2/3] doc: changes to abi policy introducing major abi versions Ray Kinsella 2019-11-11 11:57 ` [dpdk-dev] [PATCH v11 3/3] doc: updates to versioning guide for " Ray Kinsella 2019-11-12 7:55 ` [dpdk-dev] [PATCH v11 0/3] doc: changes to abi policy introducing major " Thomas Monjalon 2019-11-12 8:49 ` Ray Kinsella
This is a public inbox, see mirroring instructions for how to clone and mirror all data and code used for this inbox; as well as URLs for NNTP newsgroup(s).
