doc/guides/contributing/abi_policy.rst

   1 ..  SPDX-License-Identifier: BSD-3-Clause
   2     Copyright 2019 The DPDK contributors
   3
   4 ABI Policy
   5 ==========
   6
   7 Description
   8 -----------
   9
  10 This document details the management policy that ensures the long-term stability
  11 of the DPDK ABI and API.
  12
  13 General Guidelines
  14 ------------------
  15
  16 #. Major ABI versions are declared no more frequently than yearly. Compatibility
  17    with the major ABI version is mandatory in subsequent releases until a new
  18    major ABI version is declared.
  19 #. Major ABI versions are usually but not always declared aligned with a
  20    :ref:`LTS release <stable_lts_releases>`.
  21 #. The ABI version is managed at a project level in DPDK, and is reflected in
  22    all non-experimental library's soname.
  23 #. The ABI should be preserved and not changed lightly. ABI changes must follow
  24    the outlined :ref:`deprecation process <abi_changes>`.
  25 #. The addition of symbols is generally not problematic. The modification of
  26    symbols is managed with ABI Versioning.
  27 #. The removal of symbols is considered an :ref:`ABI breakage <abi_breakages>`,
  28    once approved these will form part of the next ABI version.
  29 #. Libraries or APIs marked as :ref:`experimental <experimental_apis>` may
  30    change without constraint, as they are not considered part of an ABI version.
  31    Experimental libraries have the major ABI version ``0``.
  32 #. Updates to the :ref:`minimum hardware requirements <hw_rqmts>`, which drop
  33    support for hardware which was previously supported, should be treated as an
  34    ABI change.
  35
  36 .. note::
  37
  38    In 2019, the DPDK community stated its intention to move to ABI stable
  39    releases, over a number of release cycles. This change begins with
  40    maintaining ABI stability through one year of DPDK releases starting from
  41    DPDK 19.11. This policy will be reviewed in 2020, with intention of
  42    lengthening the stability period.
  43
  44 What is an ABI?
  45 ~~~~~~~~~~~~~~~
  46
  47 An ABI (Application Binary Interface) is the set of runtime interfaces exposed
  48 by a library. It is similar to an API (Application Programming Interface) but
  49 is the result of compilation.  It is also effectively cloned when applications
  50 link to dynamic libraries.  That is to say when an application is compiled to
  51 link against dynamic libraries, it is assumed that the ABI remains constant
  52 between the time the application is compiled/linked, and the time that it runs.
  53 Therefore, in the case of dynamic linking, it is critical that an ABI is
  54 preserved, or (when modified), done in such a way that the application is unable
  55 to behave improperly or in an unexpected fashion.
  56
  57 .. _figure_what_is_an_abi:
  58
  59 .. figure:: img/what_is_an_abi.*
  60
  61             Illustration of DPDK API and ABI.
  62
  63
  64 What is an ABI version?
  65 ~~~~~~~~~~~~~~~~~~~~~~~
  66
  67 An ABI version is an instance of a library's ABI at a specific release. Certain
  68 releases are considered to be milestone releases, the yearly LTS release for
  69 example. The ABI of a milestone release may be declared as a 'major ABI
  70 version', where this ABI version is then supported for some number of subsequent
  71 releases and is annotated in the library's soname.
  72
  73 ABI version support in subsequent releases facilitates application upgrades, by
  74 enabling applications built against the milestone release to upgrade to
  75 subsequent releases of a library without a rebuild.
  76
  77 More details on major ABI version can be found in the ABI Versioning guide.
  78
  79 The DPDK ABI policy
  80 -------------------
  81
  82 A new major ABI version is declared no more frequently than yearly, with
  83 declarations usually aligning with a LTS release, e.g. ABI 20 for DPDK 19.11.
  84 Compatibility with the major ABI version is then mandatory in subsequent
  85 releases until the next major ABI version is declared, e.g. ABI 21 for DPDK
  86 20.11.
  87
  88 At the declaration of a major ABI version, major version numbers encoded in
  89 libraries' sonames are bumped to indicate the new version, with the minor
  90 version reset to ``0``. An example would be ``librte_eal.so.20.3`` would become
  91 ``librte_eal.so.21.0``.
  92
  93 The ABI may then change multiple times, without warning, between the last major
  94 ABI version increment and the HEAD label of the git tree, with the condition
  95 that ABI compatibility with the major ABI version is preserved and therefore
  96 sonames do not change.
  97
  98 Minor versions are incremented to indicate the release of a new ABI compatible
  99 DPDK release, typically the DPDK quarterly releases. An example of this, might
 100 be that ``librte_eal.so.20.1`` would indicate the first ABI compatible DPDK
 101 release, following the declaration of the new major ABI version ``20``.
 102
 103 An ABI version is supported in all new releases until the next major ABI version
 104 is declared. When changing the major ABI version, the release notes will detail
 105 all ABI changes.
 106
 107 .. _figure_abi_stability_policy:
 108
 109 .. figure:: img/abi_stability_policy.*
 110
 111             Mapping of new ABI versions and ABI version compatibility to DPDK
 112             releases.
 113
 114 .. _abi_changes:
 115
 116 ABI Changes
 117 ~~~~~~~~~~~
 118
 119 The ABI may still change after the declaration of a major ABI version, that is
 120 new APIs may be still added or existing APIs may be modified.
 121
 122 .. Warning::
 123
 124    Note that, this policy details the method by which the ABI may be changed,
 125    with due regard to preserving compatibility and observing deprecation
 126    notices. This process however should not be undertaken lightly, as a general
 127    rule ABI stability is extremely important for downstream consumers of DPDK.
 128    The API should only be changed for significant reasons, such as performance
 129    enhancements. API breakages due to changes such as reorganizing public
 130    structure fields for aesthetic or readability purposes should be avoided.
 131
 132 The requirements for changing the ABI are:
 133
 134 #. At least 3 acknowledgments of the need to do so must be made on the
 135    dpdk.org mailing list.
 136
 137    - The acknowledgment of the maintainer of the component is mandatory, or if
 138      no maintainer is available for the component, the tree/sub-tree maintainer
 139      for that component must acknowledge the ABI change instead.
 140
 141    - The acknowledgment of three members of the technical board, as delegates
 142      of the `technical board <https://core.dpdk.org/techboard/>`_ acknowledging
 143      the need for the ABI change, is also mandatory.
 144
 145    - It is also recommended that acknowledgments from different "areas of
 146      interest" be sought for each deprecation, for example: from NIC vendors,
 147      CPU vendors, end-users, etc.
 148
 149 #. Backward compatibility with the major ABI version must be maintained through
 150    ABI Versioning, with :ref:`forward-only <forward-only>` compatibility
 151    offered for any ABI changes that are indicated to be part of the next ABI
 152    version.
 153
 154    - In situations where backward compatibility is not possible, read the
 155      section on :ref:`abi_breakages`.
 156
 157    - No backward or forward compatibility is offered for API changes marked as
 158      ``experimental``, as described in the section on :ref:`Experimental APIs
 159      and Libraries <experimental_apis>`.
 160
 161 #. If a newly proposed API functionally replaces an existing one, when the new
 162    API becomes non-experimental, then the old one is marked with
 163    ``__rte_deprecated``.
 164
 165     - The depreciated API should follow the notification process to be removed,
 166       see  :ref:`deprecation_notices`.
 167
 168     - At the declaration of the next major ABI version, those ABI changes then
 169       become a formal part of the new ABI and the requirement to preserve ABI
 170       compatibility with the last major ABI version is then dropped.
 171
 172     - The responsibility for removing redundant ABI compatibility code rests
 173       with the original contributor of the ABI changes, failing that, then with
 174       the contributor's company and then finally with the maintainer.
 175
 176 .. _forward-only:
 177
 178 .. Note::
 179
 180    Note that forward-only compatibility is offered for those changes made
 181    between major ABI versions. As a library's soname can only describe
 182    compatibility with the last major ABI version, until the next major ABI
 183    version is declared, these changes therefore cannot be resolved as a runtime
 184    dependency through the soname. Therefore any application wishing to make use
 185    of these ABI changes can only ensure that its runtime dependencies are met
 186    through Operating System package versioning.
 187
 188 .. _hw_rqmts:
 189
 190 .. Note::
 191
 192    Updates to the minimum hardware requirements, which drop support for hardware
 193    which was previously supported, should be treated as an ABI change, and
 194    follow the relevant deprecation policy procedures as above: 3 acks, technical
 195    board approval and announcement at least one release in advance.
 196
 197 .. _abi_breakages:
 198
 199 ABI Breakages
 200 ~~~~~~~~~~~~~
 201
 202 For those ABI changes that are too significant to reasonably maintain multiple
 203 symbol versions, there is an amended process. In these cases, ABIs may be
 204 updated without the requirement of backward compatibility being provided. These
 205 changes must follow the same process :ref:`described above <abi_changes>` as non-breaking
 206 changes, however with the following additional requirements:
 207
 208 #. ABI breaking changes (including an alternative map file) can be included with
 209    deprecation notice, in wrapped way by the ``RTE_NEXT_ABI`` option, to provide
 210    more details about oncoming changes. ``RTE_NEXT_ABI`` wrapper will be removed
 211    at the declaration of the next major ABI version.
 212
 213 #. Once approved, and after the deprecation notice has been observed these
 214    changes will form part of the next declared major ABI version.
 215
 216 Examples of ABI Changes
 217 ~~~~~~~~~~~~~~~~~~~~~~~
 218
 219 The following are examples of allowable ABI changes occurring between
 220 declarations of major ABI versions.
 221
 222 * DPDK 19.11 release, defines the function ``rte_foo()``, and ``rte_foo()``
 223   as part of the major ABI version ``20``.
 224
 225 * DPDK 20.02 release defines a new function ``rte_foo(uint8_t bar)``, and
 226   this is not a problem as long as the symbol ``rte_foo@DPDK20`` is
 227   preserved through ABI Versioning.
 228
 229   - The new function may be marked with the ``__rte_experimental`` tag for a
 230     number of releases, as described in the section :ref:`experimental_apis`.
 231
 232   - Once ``rte_foo(uint8_t bar)`` becomes non-experimental ``rte_foo()`` is then
 233     declared as ``__rte_depreciated``, with an associated deprecation notice
 234     provided.
 235
 236 * DPDK 19.11 is not re-released to include ``rte_foo(uint8_t bar)``, the new
 237   version of ``rte_foo`` only exists from DPDK 20.02 onwards as described in the
 238   :ref:`note on forward-only compatibility<forward-only>`.
 239
 240 * DPDK 20.02 release defines the experimental function ``__rte_experimental
 241   rte_baz()``. This function may or may not exist in the DPDK 20.05 release.
 242
 243 * An application ``dPacket`` wishes to use ``rte_foo(uint8_t bar)``, before the
 244   declaration of the DPDK ``21`` major API version. The application can only
 245   ensure its runtime dependencies are met by specifying ``DPDK (>= 20.2)`` as
 246   an explicit package dependency, as the soname only may only indicate the
 247   supported major ABI version.
 248
 249 * At the release of DPDK 20.11, the function ``rte_foo(uint8_t bar)`` becomes
 250   formally part of then new major ABI version DPDK 21.0 and ``rte_foo()`` may be
 251   removed.
 252
 253 .. _deprecation_notices:
 254
 255 Examples of Deprecation Notices
 256 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 257
 258 The following are some examples of ABI deprecation notices which would be
 259 added to the Release Notes:
 260
 261 * The Macro ``#RTE_FOO`` is deprecated and will be removed with ABI version
 262   21, to be replaced with the inline function ``rte_foo()``.
 263
 264 * The function ``rte_mbuf_grok()`` has been updated to include a new parameter
 265   in version 20.2. Backwards compatibility will be maintained for this function
 266   until the release of the new DPDK major ABI version 21, in DPDK version
 267   20.11.
 268
 269 * The members of ``struct rte_foo`` have been reorganized in DPDK 20.02 for
 270   performance reasons. Existing binary applications will have backwards
 271   compatibility in release 20.02, while newly built binaries will need to
 272   reference the new structure variant ``struct rte_foo2``. Compatibility will be
 273   removed in release 20.11, and all applications will require updating and
 274   rebuilding to the new structure at that time, which will be renamed to the
 275   original ``struct rte_foo``.
 276
 277 * Significant ABI changes are planned for the ``librte_dostuff`` library. The
 278   upcoming release 20.02 will not contain these changes, but release 20.11 will,
 279   and no backwards compatibility is planned due to the extensive nature of
 280   these changes. Binaries using this library built prior to ABI version 21 will
 281   require updating and recompilation.
 282
 283 .. _experimental_apis:
 284
 285 Experimental
 286 ------------
 287
 288 APIs
 289 ~~~~
 290
 291 APIs marked as ``experimental`` are not considered part of an ABI version and
 292 may change without warning at any time. Since changes to APIs are most likely
 293 immediately after their introduction, as users begin to take advantage of those
 294 new APIs and start finding issues with them, new DPDK APIs will be automatically
 295 marked as ``experimental`` to allow for a period of stabilization before they
 296 become part of a tracked ABI version.
 297
 298 Note that marking an API as experimental is a multi step process.
 299 To mark an API as experimental, the symbols which are desired to be exported
 300 must be placed in an EXPERIMENTAL version block in the corresponding libraries'
 301 version map script.
 302 Secondly, the corresponding prototypes of those exported functions (in the
 303 development header files), must be marked with the ``__rte_experimental`` tag
 304 (see ``rte_compat.h``).
 305 The DPDK build makefiles perform a check to ensure that the map file and the
 306 C code reflect the same list of symbols.
 307 This check can be circumvented by defining ``ALLOW_EXPERIMENTAL_API``
 308 during compilation in the corresponding library Makefile.
 309
 310 In addition to tagging the code with ``__rte_experimental``,
 311 the doxygen markup must also contain the EXPERIMENTAL string,
 312 and the MAINTAINERS file should note the EXPERIMENTAL libraries.
 313
 314 For removing the experimental tag associated with an API, deprecation notice is
 315 not required. Though, an API should remain in experimental state for at least
 316 one release. Thereafter, the normal process of posting patch for review to
 317 mailing list can be followed.
 318
 319 Libraries
 320 ~~~~~~~~~
 321
 322 Libraries marked as ``experimental`` are entirely not considered part of an ABI
 323 version, and may change without warning at any time. Experimental libraries
 324 always have a major version of ``0`` to indicate they exist outside of
 325 ABI Versioning, with the minor version incremented with each ABI change
 326 to library.