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