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
 117 * **Updated dpaa2_sec crypto PMD.**
 118
 119   Added support for AES-GCM and AES-CTR
 120
 121 * **Updated the AESNI MB PMD.**
 122
 123   The AESNI MB PMD has been updated with additional support for:
 124
 125     * 12-byte IV on AES Counter Mode, apart from the previous 16-byte IV.
 126
 127
 128 Resolved Issues
 129 ---------------
 130
 131 .. This section should contain bug fixes added to the relevant
 132    sections. Sample format:
 133
 134    * **code/section Fixed issue in the past tense with a full stop.**
 135
 136      Add a short 1-2 sentence description of the resolved issue in the past
 137      tense.
 138
 139      The title should contain the code/lib section like a commit message.
 140
 141      Add the entries in alphabetic order in the relevant sections below.
 142
 143    This section is a comment. do not overwrite or remove it.
 144    Also, make sure to start the actual text at the margin.
 145    =========================================================
 146
 147
 148 EAL
 149 ~~~
 150
 151
 152 Drivers
 153 ~~~~~~~
 154
 155
 156 Libraries
 157 ~~~~~~~~~
 158
 159
 160 Examples
 161 ~~~~~~~~
 162
 163
 164 Other
 165 ~~~~~
 166
 167
 168 Known Issues
 169 ------------
 170
 171 .. This section should contain new known issues in this release. Sample format:
 172
 173    * **Add title in present tense with full stop.**
 174
 175      Add a short 1-2 sentence description of the known issue in the present
 176      tense. Add information on any known workarounds.
 177
 178    This section is a comment. do not overwrite or remove it.
 179    Also, make sure to start the actual text at the margin.
 180    =========================================================
 181
 182
 183 API Changes
 184 -----------
 185
 186 .. This section should contain API changes. Sample format:
 187
 188    * Add a short 1-2 sentence description of the API change. Use fixed width
 189      quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past
 190      tense.
 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 ABI Changes
 198 -----------
 199
 200 .. This section should contain ABI changes. Sample format:
 201
 202    * Add a short 1-2 sentence description of the ABI change that was announced
 203      in the previous releases and made in this release. Use fixed width quotes
 204      for ``rte_function_names`` or ``rte_struct_names``. Use the past 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 * **Reorganized the crypto operation structures.**
 211
 212   Some fields have been modified in the ``rte_crypto_op`` and ``rte_crypto_sym_op``
 213   structures, as described in the `New Features`_ section.
 214
 215 * **Reorganized the ``rte_crypto_sym_cipher_xform`` structure.**
 216
 217   * Added cipher IV length and offset parameters.
 218
 219 * **Reorganized the ``rte_crypto_sym_auth_xform`` structure.**
 220
 221   * Added authentication IV length and offset parameters.
 222   * Changed field size of AAD length from uint32_t to uint16_t.
 223   * Changed field size of digest length from uint32_t to uint16_t.
 224   * Removed AAD length.
 225
 226
 227 Shared Library Versions
 228 -----------------------
 229
 230 .. Update any library version updated in this release and prepend with a ``+``
 231    sign, like this:
 232
 233      librte_acl.so.2
 234    + librte_cfgfile.so.2
 235      librte_cmdline.so.2
 236
 237    This section is a comment. do not overwrite or remove it.
 238    =========================================================
 239
 240
 241 The libraries prepended with a plus sign were incremented in this version.
 242
 243 .. code-block:: diff
 244
 245      librte_acl.so.2
 246      librte_bitratestats.so.1
 247      librte_cfgfile.so.2
 248      librte_cmdline.so.2
 249    + librte_cryptodev.so.3
 250      librte_distributor.so.1
 251      librte_eal.so.4
 252      librte_ethdev.so.6
 253      librte_hash.so.2
 254      librte_ip_frag.so.1
 255      librte_jobstats.so.1
 256      librte_kni.so.2
 257      librte_kvargs.so.1
 258      librte_latencystats.so.1
 259      librte_lpm.so.2
 260      librte_mbuf.so.3
 261      librte_mempool.so.2
 262      librte_meter.so.1
 263      librte_metrics.so.1
 264      librte_net.so.1
 265      librte_pdump.so.1
 266      librte_pipeline.so.3
 267      librte_pmd_bond.so.1
 268      librte_pmd_ring.so.2
 269      librte_port.so.3
 270      librte_power.so.1
 271      librte_reorder.so.1
 272      librte_ring.so.1
 273      librte_sched.so.1
 274      librte_table.so.2
 275      librte_timer.so.1
 276      librte_vhost.so.3
 277
 278
 279 Tested Platforms
 280 ----------------
 281
 282 .. This section should contain a list of platforms that were tested with this
 283    release.
 284
 285    The format is:
 286
 287    * <vendor> platform with <vendor> <type of devices> combinations
 288
 289      * List of CPU
 290      * List of OS
 291      * List of devices
 292      * Other relevant details...
 293
 294    This section is a comment. do not overwrite or remove it.
 295    Also, make sure to start the actual text at the margin.
 296    =========================================================