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 * **Updated dpaa2 PMD.**
 105
 106   Major enhancements include:
 107   * Support MAC Filter configuration
 108   * Support Segmented Buffers
 109   * Support VLAN filter and strip functionality.
 110   * Other enhancements to add support for more dev_ops.
 111   * Optimized the packet receive path
 112
 113 * **Reorganized the symmetric crypto operation structure.**
 114
 115   The crypto operation (``rte_crypto_sym_op``) has been reorganized as follows:
 116
 117   * Removed field ``rte_crypto_sym_op_sess_type``.
 118   * Replaced pointer and physical address of IV with offset from the start
 119     of the crypto operation.
 120   * Moved length and offset of cipher IV to ``rte_crypto_cipher_xform``.
 121   * Removed Additional Authentication Data (AAD) length.
 122   * Removed digest length.
 123   * Removed AAD pointer and physical address from ``auth`` structure.
 124   * Added ``aead`` structure, containing parameters for AEAD algorithms.
 125
 126 * **Reorganized the crypto operation structure.**
 127
 128   The crypto operation (``rte_crypto_op``) has been reorganized as follows:
 129
 130   * Added field ``rte_crypto_op_sess_type``.
 131   * Enumerations ``rte_crypto_op_status`` and ``rte_crypto_op_type``
 132     have been modified to be uint8_t values.
 133   * Removed the field ``opaque_data``.
 134   * Pointer to ``rte_crypto_sym_op`` has been replaced with a zero length array.
 135
 136 * **Reorganized the crypto symmetric session structure.**
 137
 138   The crypto symmetric session structure (``rte_cryptodev_sym_session``) has
 139   been reorganized as follows:
 140
 141   * ``dev_id`` field has been removed.
 142   * ``driver_id`` field has been removed.
 143   * Mempool pointer ``mp`` has been removed.
 144   * Replaced ``private`` marker with array of pointers to private data sessions
 145     ``sess_private_data``.
 146
 147 * **Updated cryptodev library.**
 148
 149   * Added AEAD algorithm specific functions and structures, so it is not
 150     necessary to use a combination of cipher and authentication
 151     structures anymore.
 152   * Added helper functions for crypto device driver identification.
 153   * Added support for multi-device sessions, so a single session can be
 154     used in multiple drivers.
 155   * Added functions to initialize and free individual driver private data
 156     with a same session.
 157
 158 * **Updated dpaa2_sec crypto PMD.**
 159
 160   Added support for AES-GCM and AES-CTR
 161
 162 * **Updated the AESNI MB PMD.**
 163
 164   The AESNI MB PMD has been updated with additional support for:
 165
 166     * 12-byte IV on AES Counter Mode, apart from the previous 16-byte IV.
 167
 168 * **Updated the AES-NI GCM PMD.**
 169
 170   The AES-NI GCM PMD was migrated from the ISA-L library to the Multi Buffer
 171   library, as the latter library has Scatter Gather List support
 172   now. The migration entailed adding additional support for:
 173
 174   * 192-bit key.
 175
 176 * **Updated the Cryptodev Scheduler PMD.**
 177
 178   Added a multicore based distribution mode, which distributes the enqueued
 179   crypto operations among several slaves, running on different logical cores.
 180
 181 * **Added NXP DPAA2 Eventdev PMD.**
 182
 183   Added the new dpaa2 eventdev driver for NXP DPAA2 devices. See the
 184   "Event Device Drivers" document for more details on this new driver.
 185
 186 * **Added dpdk-test-eventdev test application.**
 187
 188   The dpdk-test-eventdev tool is a Data Plane Development Kit (DPDK) application
 189   that allows exercising various eventdev use cases.
 190   This application has a generic framework to add new eventdev based test cases
 191   to verify functionality and measure the performance parameters of DPDK
 192   eventdev devices.
 193
 194
 195 Resolved Issues
 196 ---------------
 197
 198 .. This section should contain bug fixes added to the relevant
 199    sections. Sample format:
 200
 201    * **code/section Fixed issue in the past tense with a full stop.**
 202
 203      Add a short 1-2 sentence description of the resolved issue in the past
 204      tense.
 205
 206      The title should contain the code/lib section like a commit message.
 207
 208      Add the entries in alphabetic order in the relevant sections below.
 209
 210    This section is a comment. do not overwrite or remove it.
 211    Also, make sure to start the actual text at the margin.
 212    =========================================================
 213
 214
 215 EAL
 216 ~~~
 217
 218
 219 Drivers
 220 ~~~~~~~
 221
 222
 223 Libraries
 224 ~~~~~~~~~
 225
 226
 227 Examples
 228 ~~~~~~~~
 229
 230
 231 Other
 232 ~~~~~
 233
 234
 235 Known Issues
 236 ------------
 237
 238 .. This section should contain new known issues in this release. Sample format:
 239
 240    * **Add title in present tense with full stop.**
 241
 242      Add a short 1-2 sentence description of the known issue in the present
 243      tense. Add information on any known workarounds.
 244
 245    This section is a comment. do not overwrite or remove it.
 246    Also, make sure to start the actual text at the margin.
 247    =========================================================
 248
 249
 250 API Changes
 251 -----------
 252
 253 .. This section should contain API changes. Sample format:
 254
 255    * Add a short 1-2 sentence description of the API change. Use fixed width
 256      quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past
 257      tense.
 258
 259    This section is a comment. do not overwrite or remove it.
 260    Also, make sure to start the actual text at the margin.
 261    =========================================================
 262
 263 * **Modified the _rte_eth_dev_callback_process function in the ethdev library.**
 264
 265   The function ``_rte_eth_dev_callback_process()`` has been modified. The return
 266   value has been changed from void to int and an extra parameter ``void *ret_param``
 267   has been added.
 268
 269 * **Moved bypass functions from the rte_ethdev library to ixgbe PMD**
 270
 271   * The following rte_ethdev library functions were removed:
 272
 273     * ``rte_eth_dev_bypass_event_show``
 274     * ``rte_eth_dev_bypass_event_store``
 275     * ``rte_eth_dev_bypass_init``
 276     * ``rte_eth_dev_bypass_state_set``
 277     * ``rte_eth_dev_bypass_state_show``
 278     * ``rte_eth_dev_bypass_ver_show``
 279     * ``rte_eth_dev_bypass_wd_reset``
 280     * ``rte_eth_dev_bypass_wd_timeout_show``
 281     * ``rte_eth_dev_wd_timeout_store``
 282
 283   * The following ixgbe PMD functions were added:
 284
 285     * ``rte_pmd_ixgbe_bypass_event_show``
 286     * ``rte_pmd_ixgbe_bypass_event_store``
 287     * ``rte_pmd_ixgbe_bypass_init``
 288     * ``rte_pmd_ixgbe_bypass_state_set``
 289     * ``rte_pmd_ixgbe_bypass_state_show``
 290     * ``rte_pmd_ixgbe_bypass_ver_show``
 291     * ``rte_pmd_ixgbe_bypass_wd_reset``
 292     * ``rte_pmd_ixgbe_bypass_wd_timeout_show``
 293     * ``rte_pmd_ixgbe_bypass_wd_timeout_store``
 294
 295 * **Reworked rte_cryptodev library.**
 296
 297   The rte_cryptodev library has been reworked and updated. The following changes
 298   have been made to it:
 299
 300   * The crypto device type enumeration has been removed from cryptodev library.
 301   * The function ``rte_crypto_count_devtype()`` has been removed, and replaced
 302     by the new function ``rte_crypto_count_by_driver()``.
 303   * Moved crypto device driver names definitions to the particular PMDs.
 304     These names are not public anymore.
 305   * ``rte_cryptodev_configure()`` does not create the session mempool
 306     for the device anymore.
 307   * ``rte_cryptodev_queue_pair_attach_sym_session()`` and
 308     ``rte_cryptodev_queue_pair_dettach_sym_session()`` functions require
 309     the new parameter ``device id``.
 310   * Modified parameters of ``rte_cryptodev_sym_session_create()``, to accept
 311     ``mempool``, instead of ``device id`` and ``rte_crypto_sym_xform``.
 312   * Remove ``device id`` parameter from ``rte_cryptodev_sym_session_free()``.
 313   * Added new field ``session_pool`` to ``rte_cryptodev_queue_pair_setup()``.
 314   * Removed ``aad_size`` parameter from ``rte_cryptodev_sym_capability_check_auth()``.
 315   * Added ``iv_size`` parameter to ``rte_cryptodev_sym_capability_check_auth()``.
 316   * Removed ``RTE_CRYPTO_OP_STATUS_ENQUEUED`` from enum ``rte_crypto_op_status``.
 317
 318
 319 ABI Changes
 320 -----------
 321
 322 .. This section should contain ABI changes. Sample format:
 323
 324    * Add a short 1-2 sentence description of the ABI change that was announced
 325      in the previous releases and made in this release. Use fixed width quotes
 326      for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 327
 328    This section is a comment. do not overwrite or remove it.
 329    Also, make sure to start the actual text at the margin.
 330    =========================================================
 331
 332 * **Reorganized the crypto operation structures.**
 333
 334   Some fields have been modified in the ``rte_crypto_op`` and ``rte_crypto_sym_op``
 335   structures, as described in the `New Features`_ section.
 336
 337 * **Reorganized the crypto symmetric session structure.**
 338
 339   Some fields have been modified in the ``rte_cryptodev_sym_session``
 340   structure, as described in the `New Features`_ section.
 341
 342 * **Reorganized the ``rte_crypto_sym_cipher_xform`` structure.**
 343
 344   * Added cipher IV length and offset parameters.
 345   * Changed field size of key length from size_t to uint16_t.
 346
 347 * **Reorganized the ``rte_crypto_sym_auth_xform`` structure.**
 348
 349   * Added authentication IV length and offset parameters.
 350   * Changed field size of AAD length from uint32_t to uint16_t.
 351   * Changed field size of digest length from uint32_t to uint16_t.
 352   * Removed AAD length.
 353   * Changed field size of key length from size_t to uint16_t.
 354
 355 * Replaced ``dev_type`` enumeration with uint8_t ``driver_id`` in
 356   ``rte_cryptodev_info`` and  ``rte_cryptodev`` structures.
 357
 358 * Removed ``session_mp`` from ``rte_cryptodev_config``.
 359
 360
 361 Shared Library Versions
 362 -----------------------
 363
 364 .. Update any library version updated in this release and prepend with a ``+``
 365    sign, like this:
 366
 367      librte_acl.so.2
 368    + librte_cfgfile.so.2
 369      librte_cmdline.so.2
 370
 371    This section is a comment. do not overwrite or remove it.
 372    =========================================================
 373
 374
 375 The libraries prepended with a plus sign were incremented in this version.
 376
 377 .. code-block:: diff
 378
 379      librte_acl.so.2
 380      librte_bitratestats.so.1
 381      librte_cfgfile.so.2
 382      librte_cmdline.so.2
 383    + librte_cryptodev.so.3
 384      librte_distributor.so.1
 385      librte_eal.so.4
 386    + librte_ethdev.so.7
 387    + librte_gro.so.1
 388      librte_hash.so.2
 389      librte_ip_frag.so.1
 390      librte_jobstats.so.1
 391      librte_kni.so.2
 392      librte_kvargs.so.1
 393      librte_latencystats.so.1
 394      librte_lpm.so.2
 395      librte_mbuf.so.3
 396      librte_mempool.so.2
 397      librte_meter.so.1
 398      librte_metrics.so.1
 399      librte_net.so.1
 400      librte_pdump.so.1
 401      librte_pipeline.so.3
 402      librte_pmd_bond.so.1
 403      librte_pmd_ring.so.2
 404      librte_port.so.3
 405      librte_power.so.1
 406      librte_reorder.so.1
 407      librte_ring.so.1
 408      librte_sched.so.1
 409      librte_table.so.2
 410      librte_timer.so.1
 411      librte_vhost.so.3
 412
 413
 414 Tested Platforms
 415 ----------------
 416
 417 .. This section should contain a list of platforms that were tested with this
 418    release.
 419
 420    The format is:
 421
 422    * <vendor> platform with <vendor> <type of devices> combinations
 423
 424      * List of CPU
 425      * List of OS
 426      * List of devices
 427      * Other relevant details...
 428
 429    This section is a comment. do not overwrite or remove it.
 430    Also, make sure to start the actual text at the margin.
 431    =========================================================