doc/guides/rel_notes/release_17_08.rst

   1 DPDK Release 17.08
   2 ==================
   3
   4 .. **Read this first.**
   5
   6    The text in the sections below explains how to update the release notes.
   7
   8    Use proper spelling, capitalization and punctuation in all sections.
   9
  10    Variable and config names should be quoted as fixed width text:
  11    ``LIKE_THIS``.
  12
  13    Build the docs and view the output file to ensure the changes are correct::
  14
  15       make doc-guides-html
  16
  17       xdg-open build/doc/html/guides/rel_notes/release_17_08.html
  18
  19
  20 New Features
  21 ------------
  22
  23 .. This section should contain new features added in this release. Sample
  24    format:
  25
  26    * **Add a title in the past tense with a full stop.**
  27
  28      Add a short 1-2 sentence description in the past tense. The description
  29      should be enough to allow someone scanning the release notes to
  30      understand the new feature.
  31
  32      If the feature adds a lot of sub-features you can use a bullet list like
  33      this:
  34
  35      * Added feature foo to do something.
  36      * Enhanced feature bar to do something else.
  37
  38      Refer to the previous release notes for examples.
  39
  40      This section is a comment. do not overwrite or remove it.
  41      Also, make sure to start the actual text at the margin.
  42      =========================================================
  43
  44 * **Added Service Core functionality.**
  45
  46   The service core functionality added to EAL allows DPDK to run services such
  47   as SW PMDs on lcores without the application manually running them. The
  48   service core infrastructure allows flexibility of running multiple services
  49   on the same service lcore, and provides the application with powerful APIs to
  50   configure the mapping from service lcores to services.
  51
  52 * **Added Generic Receive Offload API.**
  53
  54   Generic Receive Offload (GRO) API supports to reassemble TCP/IPv4
  55   packets. GRO API assumes all inputted packets are with correct
  56   checksums. GRO API doesn't update checksums for merged packets. If
  57   inputted packets are IP fragmented, GRO API assumes they are complete
  58   packets (i.e. with L4 headers).
  59
  60 * **Added support for generic flow API (rte_flow) on igb NIC.**
  61
  62   This API provides a generic means to configure hardware to match specific
  63   ingress or egress traffic, alter its behavior and query related counters
  64   according to any number of user-defined rules.
  65
  66   * Generic flow API support for Ethernet, IPv4, UDP, TCP and
  67     RAW pattern items with QUEUE actions. There are four
  68     type of filter support for this feature on igb.
  69
  70 * **Added Generic Flow API support to enic.**
  71
  72   Flow API support for outer Ethernet, VLAN, IPv4, IPv6, UDP, TCP, SCTP, VxLAN
  73   and inner Ethernet, VLAN, IPv4, IPv6, UDP and TCP pattern items with QUEUE,
  74   MARK, FLAG and VOID actions for ingress traffic.
  75
  76 * **Added support for Chelsio T6 family of adapters**
  77
  78   CXGBE PMD updated to run Chelsio T6 family of adapters.
  79
  80 * **Added latency and performance improvements for cxgbe**
  81
  82   TX and RX path reworked to improve performance.  Also reduced latency
  83   for slow traffic.
  84
  85 * **Updated bnxt PMD.**
  86
  87   Major enhancements include:
  88   * Support MTU modification.
  89   * Support LRO.
  90   * Support VLAN filter and strip functionality.
  91   * Other enhancements to add support for more dev_ops.
  92   * Add PMD specific APIs mainly to control VF from PF.
  93   * Update HWRM version to 1.7.7
  94
  95 * **Added support for Rx interrupts on mlx4 driver.**
  96
  97   Rx queues can be armed with an interrupt which will trigger on the
  98   next packet arrival.
  99
 100 * **Updated szedata2 PMD.**
 101
 102   Added support for firmwares with multiple Ethernet ports per physical port.
 103
 104 * **Reorganized the symmetric crypto operation structure.**
 105
 106   The crypto operation (``rte_crypto_sym_op``) has been reorganized as follows:
 107
 108   * Removed field ``rte_crypto_sym_op_sess_type``.
 109   * Replaced pointer and physical address of IV with offset from the start
 110     of the crypto operation.
 111   * Moved length and offset of cipher IV to ``rte_crypto_cipher_xform``.
 112   * Removed Additional Authentication Data (AAD) length.
 113   * Removed digest length.
 114   * Removed AAD pointer and physical address from ``auth`` structure.
 115   * Added ``aead`` structure, containing parameters for AEAD algorithms.
 116
 117 * **Reorganized the crypto operation structure.**
 118
 119   The crypto operation (``rte_crypto_op``) has been reorganized as follows:
 120
 121   * Added field ``rte_crypto_op_sess_type``.
 122   * Enumerations ``rte_crypto_op_status`` and ``rte_crypto_op_type``
 123     have been modified to be uint8_t values.
 124   * Removed the field ``opaque_data``.
 125   * Pointer to ``rte_crypto_sym_op`` has been replaced with a zero length array.
 126
 127 * **Reorganized the crypto symmetric session structure.**
 128
 129   The crypto symmetric session structure (``rte_cryptodev_sym_session``) has
 130   been reorganized as follows:
 131
 132   * ``dev_id`` field has been removed.
 133   * ``driver_id`` field has been removed.
 134   * Mempool pointer ``mp`` has been removed.
 135   * Replaced ``private`` marker with array of pointers to private data sessions
 136     ``sess_private_data``.
 137
 138 * **Updated cryptodev library.**
 139
 140   * Added AEAD algorithm specific functions and structures, so it is not
 141     necessary to use a combination of cipher and authentication
 142     structures anymore.
 143   * Added helper functions for crypto device driver identification.
 144   * Added support for multi-device sessions, so a single session can be
 145     used in multiple drivers.
 146   * Added functions to initialize and free individual driver private data
 147     with a same session.
 148
 149 * **Updated dpaa2_sec crypto PMD.**
 150
 151   Added support for AES-GCM and AES-CTR
 152
 153 * **Updated the AESNI MB PMD.**
 154
 155   The AESNI MB PMD has been updated with additional support for:
 156
 157     * 12-byte IV on AES Counter Mode, apart from the previous 16-byte IV.
 158
 159 * **Updated the AES-NI GCM PMD.**
 160
 161   The AES-NI GCM PMD was migrated from the ISA-L library to the Multi Buffer
 162   library, as the latter library has Scatter Gather List support
 163   now. The migration entailed adding additional support for:
 164
 165   * 192-bit key.
 166
 167 * **Updated the Cryptodev Scheduler PMD.**
 168
 169   Added a multicore based distribution mode, which distributes the enqueued
 170   crypto operations among several slaves, running on different logical cores.
 171
 172 * **Added NXP DPAA2 Eventdev PMD.**
 173
 174   Added the new dpaa2 eventdev driver for NXP DPAA2 devices. See the
 175   "Event Device Drivers" document for more details on this new driver.
 176
 177 * **Added dpdk-test-eventdev test application.**
 178
 179   The dpdk-test-eventdev tool is a Data Plane Development Kit (DPDK) application
 180   that allows exercising various eventdev use cases.
 181   This application has a generic framework to add new eventdev based test cases
 182   to verify functionality and measure the performance parameters of DPDK
 183   eventdev devices.
 184
 185
 186 Resolved Issues
 187 ---------------
 188
 189 .. This section should contain bug fixes added to the relevant
 190    sections. Sample format:
 191
 192    * **code/section Fixed issue in the past tense with a full stop.**
 193
 194      Add a short 1-2 sentence description of the resolved issue in the past
 195      tense.
 196
 197      The title should contain the code/lib section like a commit message.
 198
 199      Add the entries in alphabetic order in the relevant sections below.
 200
 201    This section is a comment. do not overwrite or remove it.
 202    Also, make sure to start the actual text at the margin.
 203    =========================================================
 204
 205
 206 EAL
 207 ~~~
 208
 209
 210 Drivers
 211 ~~~~~~~
 212
 213
 214 Libraries
 215 ~~~~~~~~~
 216
 217
 218 Examples
 219 ~~~~~~~~
 220
 221
 222 Other
 223 ~~~~~
 224
 225
 226 Known Issues
 227 ------------
 228
 229 .. This section should contain new known issues in this release. Sample format:
 230
 231    * **Add title in present tense with full stop.**
 232
 233      Add a short 1-2 sentence description of the known issue in the present
 234      tense. Add information on any known workarounds.
 235
 236    This section is a comment. do not overwrite or remove it.
 237    Also, make sure to start the actual text at the margin.
 238    =========================================================
 239
 240
 241 API Changes
 242 -----------
 243
 244 .. This section should contain API changes. Sample format:
 245
 246    * Add a short 1-2 sentence description of the API change. Use fixed width
 247      quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past
 248      tense.
 249
 250    This section is a comment. do not overwrite or remove it.
 251    Also, make sure to start the actual text at the margin.
 252    =========================================================
 253
 254 * **Modified the _rte_eth_dev_callback_process function in the ethdev library.**
 255
 256   The function ``_rte_eth_dev_callback_process()`` has been modified. The return
 257   value has been changed from void to int and an extra parameter ``void *ret_param``
 258   has been added.
 259
 260 * **Moved bypass functions from the rte_ethdev library to ixgbe PMD**
 261
 262   * The following rte_ethdev library functions were removed:
 263
 264     * ``rte_eth_dev_bypass_event_show``
 265     * ``rte_eth_dev_bypass_event_store``
 266     * ``rte_eth_dev_bypass_init``
 267     * ``rte_eth_dev_bypass_state_set``
 268     * ``rte_eth_dev_bypass_state_show``
 269     * ``rte_eth_dev_bypass_ver_show``
 270     * ``rte_eth_dev_bypass_wd_reset``
 271     * ``rte_eth_dev_bypass_wd_timeout_show``
 272     * ``rte_eth_dev_wd_timeout_store``
 273
 274   * The following ixgbe PMD functions were added:
 275
 276     * ``rte_pmd_ixgbe_bypass_event_show``
 277     * ``rte_pmd_ixgbe_bypass_event_store``
 278     * ``rte_pmd_ixgbe_bypass_init``
 279     * ``rte_pmd_ixgbe_bypass_state_set``
 280     * ``rte_pmd_ixgbe_bypass_state_show``
 281     * ``rte_pmd_ixgbe_bypass_ver_show``
 282     * ``rte_pmd_ixgbe_bypass_wd_reset``
 283     * ``rte_pmd_ixgbe_bypass_wd_timeout_show``
 284     * ``rte_pmd_ixgbe_bypass_wd_timeout_store``
 285
 286 * **Reworked rte_cryptodev library.**
 287
 288   The rte_cryptodev library has been reworked and updated. The following changes
 289   have been made to it:
 290
 291   * The crypto device type enumeration has been removed from cryptodev library.
 292   * The function ``rte_crypto_count_devtype()`` has been removed, and replaced
 293     by the new function ``rte_crypto_count_by_driver()``.
 294   * Moved crypto device driver names definitions to the particular PMDs.
 295     These names are not public anymore.
 296   * ``rte_cryptodev_configure()`` does not create the session mempool
 297     for the device anymore.
 298   * ``rte_cryptodev_queue_pair_attach_sym_session()`` and
 299     ``rte_cryptodev_queue_pair_dettach_sym_session()`` functions require
 300     the new parameter ``device id``.
 301   * Modified parameters of ``rte_cryptodev_sym_session_create()``, to accept
 302     ``mempool``, instead of ``device id`` and ``rte_crypto_sym_xform``.
 303   * Remove ``device id`` parameter from ``rte_cryptodev_sym_session_free()``.
 304   * Added new field ``session_pool`` to ``rte_cryptodev_queue_pair_setup()``.
 305   * Removed ``aad_size`` parameter from ``rte_cryptodev_sym_capability_check_auth()``.
 306   * Added ``iv_size`` parameter to ``rte_cryptodev_sym_capability_check_auth()``.
 307   * Removed ``RTE_CRYPTO_OP_STATUS_ENQUEUED`` from enum ``rte_crypto_op_status``.
 308
 309
 310 ABI Changes
 311 -----------
 312
 313 .. This section should contain ABI changes. Sample format:
 314
 315    * Add a short 1-2 sentence description of the ABI change that was announced
 316      in the previous releases and made in this release. Use fixed width quotes
 317      for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 318
 319    This section is a comment. do not overwrite or remove it.
 320    Also, make sure to start the actual text at the margin.
 321    =========================================================
 322
 323 * **Reorganized the crypto operation structures.**
 324
 325   Some fields have been modified in the ``rte_crypto_op`` and ``rte_crypto_sym_op``
 326   structures, as described in the `New Features`_ section.
 327
 328 * **Reorganized the crypto symmetric session structure.**
 329
 330   Some fields have been modified in the ``rte_cryptodev_sym_session``
 331   structure, as described in the `New Features`_ section.
 332
 333 * **Reorganized the ``rte_crypto_sym_cipher_xform`` structure.**
 334
 335   * Added cipher IV length and offset parameters.
 336   * Changed field size of key length from size_t to uint16_t.
 337
 338 * **Reorganized the ``rte_crypto_sym_auth_xform`` structure.**
 339
 340   * Added authentication IV length and offset parameters.
 341   * Changed field size of AAD length from uint32_t to uint16_t.
 342   * Changed field size of digest length from uint32_t to uint16_t.
 343   * Removed AAD length.
 344   * Changed field size of key length from size_t to uint16_t.
 345
 346 * Replaced ``dev_type`` enumeration with uint8_t ``driver_id`` in
 347   ``rte_cryptodev_info`` and  ``rte_cryptodev`` structures.
 348
 349 * Removed ``session_mp`` from ``rte_cryptodev_config``.
 350
 351
 352 Shared Library Versions
 353 -----------------------
 354
 355 .. Update any library version updated in this release and prepend with a ``+``
 356    sign, like this:
 357
 358      librte_acl.so.2
 359    + librte_cfgfile.so.2
 360      librte_cmdline.so.2
 361
 362    This section is a comment. do not overwrite or remove it.
 363    =========================================================
 364
 365
 366 The libraries prepended with a plus sign were incremented in this version.
 367
 368 .. code-block:: diff
 369
 370      librte_acl.so.2
 371      librte_bitratestats.so.1
 372      librte_cfgfile.so.2
 373      librte_cmdline.so.2
 374    + librte_cryptodev.so.3
 375      librte_distributor.so.1
 376      librte_eal.so.4
 377    + librte_ethdev.so.7
 378    + librte_gro.so.1
 379      librte_hash.so.2
 380      librte_ip_frag.so.1
 381      librte_jobstats.so.1
 382      librte_kni.so.2
 383      librte_kvargs.so.1
 384      librte_latencystats.so.1
 385      librte_lpm.so.2
 386      librte_mbuf.so.3
 387      librte_mempool.so.2
 388      librte_meter.so.1
 389      librte_metrics.so.1
 390      librte_net.so.1
 391      librte_pdump.so.1
 392      librte_pipeline.so.3
 393      librte_pmd_bond.so.1
 394      librte_pmd_ring.so.2
 395      librte_port.so.3
 396      librte_power.so.1
 397      librte_reorder.so.1
 398      librte_ring.so.1
 399      librte_sched.so.1
 400      librte_table.so.2
 401      librte_timer.so.1
 402      librte_vhost.so.3
 403
 404
 405 Tested Platforms
 406 ----------------
 407
 408 .. This section should contain a list of platforms that were tested with this
 409    release.
 410
 411    The format is:
 412
 413    * <vendor> platform with <vendor> <type of devices> combinations
 414
 415      * List of CPU
 416      * List of OS
 417      * List of devices
 418      * Other relevant details...
 419
 420    This section is a comment. do not overwrite or remove it.
 421    Also, make sure to start the actual text at the margin.
 422    =========================================================