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