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 * **Updated cryptodev library.**
 112
 113   * Added AEAD algorithm specific functions and structures, so it is not
 114     necessary to use a combination of cipher and authentication
 115     structures anymore.
 116   * Added helper functions for crypto device driver identification.
 117
 118 * **Updated dpaa2_sec crypto PMD.**
 119
 120   Added support for AES-GCM and AES-CTR
 121
 122 * **Updated the AESNI MB PMD.**
 123
 124   The AESNI MB PMD has been updated with additional support for:
 125
 126     * 12-byte IV on AES Counter Mode, apart from the previous 16-byte IV.
 127
 128 * **Updated the AES-NI GCM PMD.**
 129
 130   The AES-NI GCM PMD was migrated from the ISA-L library to the Multi Buffer
 131   library, as the latter library has Scatter Gather List support
 132   now. The migration entailed adding additional support for:
 133
 134   * 192-bit key.
 135
 136 * **Updated the Cryptodev Scheduler PMD.**
 137
 138   Added a multicore based distribution mode, which distributes the enqueued
 139   crypto operations among several slaves, running on different logical cores.
 140
 141
 142 Resolved Issues
 143 ---------------
 144
 145 .. This section should contain bug fixes added to the relevant
 146    sections. Sample format:
 147
 148    * **code/section Fixed issue in the past tense with a full stop.**
 149
 150      Add a short 1-2 sentence description of the resolved issue in the past
 151      tense.
 152
 153      The title should contain the code/lib section like a commit message.
 154
 155      Add the entries in alphabetic order in the relevant sections below.
 156
 157    This section is a comment. do not overwrite or remove it.
 158    Also, make sure to start the actual text at the margin.
 159    =========================================================
 160
 161
 162 EAL
 163 ~~~
 164
 165
 166 Drivers
 167 ~~~~~~~
 168
 169
 170 Libraries
 171 ~~~~~~~~~
 172
 173
 174 Examples
 175 ~~~~~~~~
 176
 177
 178 Other
 179 ~~~~~
 180
 181
 182 Known Issues
 183 ------------
 184
 185 .. This section should contain new known issues in this release. Sample format:
 186
 187    * **Add title in present tense with full stop.**
 188
 189      Add a short 1-2 sentence description of the known issue in the present
 190      tense. Add information on any known workarounds.
 191
 192    This section is a comment. do not overwrite or remove it.
 193    Also, make sure to start the actual text at the margin.
 194    =========================================================
 195
 196
 197 API Changes
 198 -----------
 199
 200 .. This section should contain API changes. Sample format:
 201
 202    * Add a short 1-2 sentence description of the API change. Use fixed width
 203      quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past
 204      tense.
 205
 206    This section is a comment. do not overwrite or remove it.
 207    Also, make sure to start the actual text at the margin.
 208    =========================================================
 209
 210 * **Reworked rte_cryptodev library.**
 211
 212   The rte_cryptodev library has been reworked and updated. The following changes
 213   have been made to it:
 214
 215   * The crypto device type enumeration has been removed from cryptodev library.
 216   * The function ``rte_crypto_count_devtype()`` has been removed, and replaced
 217     by the new function ``rte_crypto_count_by_driver()``.
 218   * Moved crypto device driver names definitions to the particular PMDs.
 219     These names are not public anymore.
 220   * ``rte_cryptodev_configure()`` does not create the session mempool
 221     for the device anymore.
 222
 223
 224 ABI Changes
 225 -----------
 226
 227 .. This section should contain ABI changes. Sample format:
 228
 229    * Add a short 1-2 sentence description of the ABI change that was announced
 230      in the previous releases and made in this release. Use fixed width quotes
 231      for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 232
 233    This section is a comment. do not overwrite or remove it.
 234    Also, make sure to start the actual text at the margin.
 235    =========================================================
 236
 237 * **Reorganized the crypto operation structures.**
 238
 239   Some fields have been modified in the ``rte_crypto_op`` and ``rte_crypto_sym_op``
 240   structures, as described in the `New Features`_ section.
 241
 242 * **Reorganized the ``rte_crypto_sym_cipher_xform`` structure.**
 243
 244   * Added cipher IV length and offset parameters.
 245
 246 * **Reorganized the ``rte_crypto_sym_auth_xform`` structure.**
 247
 248   * Added authentication IV length and offset parameters.
 249   * Changed field size of AAD length from uint32_t to uint16_t.
 250   * Changed field size of digest length from uint32_t to uint16_t.
 251   * Removed AAD length.
 252
 253 * Replaced ``dev_type`` enumeration with uint8_t ``driver_id`` in
 254   ``rte_cryptodev_info``, ``rte_cryptodev`` and ``rte_cryptodev_sym_session``
 255   structures.
 256
 257 * Removed ``session_mp`` from ``rte_cryptodev_config``.
 258
 259
 260 Shared Library Versions
 261 -----------------------
 262
 263 .. Update any library version updated in this release and prepend with a ``+``
 264    sign, like this:
 265
 266      librte_acl.so.2
 267    + librte_cfgfile.so.2
 268      librte_cmdline.so.2
 269
 270    This section is a comment. do not overwrite or remove it.
 271    =========================================================
 272
 273
 274 The libraries prepended with a plus sign were incremented in this version.
 275
 276 .. code-block:: diff
 277
 278      librte_acl.so.2
 279      librte_bitratestats.so.1
 280      librte_cfgfile.so.2
 281      librte_cmdline.so.2
 282    + librte_cryptodev.so.3
 283      librte_distributor.so.1
 284      librte_eal.so.4
 285      librte_ethdev.so.6
 286      librte_hash.so.2
 287      librte_ip_frag.so.1
 288      librte_jobstats.so.1
 289      librte_kni.so.2
 290      librte_kvargs.so.1
 291      librte_latencystats.so.1
 292      librte_lpm.so.2
 293      librte_mbuf.so.3
 294      librte_mempool.so.2
 295      librte_meter.so.1
 296      librte_metrics.so.1
 297      librte_net.so.1
 298      librte_pdump.so.1
 299      librte_pipeline.so.3
 300      librte_pmd_bond.so.1
 301      librte_pmd_ring.so.2
 302      librte_port.so.3
 303      librte_power.so.1
 304      librte_reorder.so.1
 305      librte_ring.so.1
 306      librte_sched.so.1
 307      librte_table.so.2
 308      librte_timer.so.1
 309      librte_vhost.so.3
 310
 311
 312 Tested Platforms
 313 ----------------
 314
 315 .. This section should contain a list of platforms that were tested with this
 316    release.
 317
 318    The format is:
 319
 320    * <vendor> platform with <vendor> <type of devices> combinations
 321
 322      * List of CPU
 323      * List of OS
 324      * List of devices
 325      * Other relevant details...
 326
 327    This section is a comment. do not overwrite or remove it.
 328    Also, make sure to start the actual text at the margin.
 329    =========================================================