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