doc/guides/rel_notes/release_16_11.rst

   1 DPDK Release 16.11
   2 ==================
   3
   4 .. **Read this first.**
   5
   6    The text 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: ``LIKE_THIS``.
  11
  12    Build the docs and view the output file to ensure the changes are correct::
  13
  14       make doc-guides-html
  15
  16       firefox build/doc/html/guides/rel_notes/release_16_11.html
  17
  18
  19 New Features
  20 ------------
  21
  22 .. This section should contain new features added in this release. Sample format:
  23
  24    * **Add a title in the past tense with a full stop.**
  25
  26      Add a short 1-2 sentence description in the past tense. The description
  27      should be enough to allow someone scanning the release notes to understand
  28      the new feature.
  29
  30      If the feature adds a lot of sub-features you can use a bullet list like this.
  31
  32      * Added feature foo to do something.
  33      * Enhanced feature bar to do something else.
  34
  35      Refer to the previous release notes for examples.
  36
  37      This section is a comment. Make sure to start the actual text at the margin.
  38
  39 * **Added vhost-user indirect descriptors support.**
  40
  41   If indirect descriptor feature is negotiated, each packet sent by the guest
  42   will take exactly one slot in the enqueue virtqueue. Without the feature, in
  43   current version, even 64 bytes packets take two slots with Virtio PMD on guest
  44   side.
  45
  46   The main impact is better performance for 0% packet loss use-cases, as it
  47   behaves as if the virtqueue size was enlarged, so more packets can be buffered
  48   in case of system perturbations. On the downside, small performance degradation
  49   is measured when running micro-benchmarks.
  50
  51 * **Added vhost PMD xstats.**
  52
  53   Added extended statistics to vhost PMD from per port perspective.
  54
  55 * **Added virtio NEON support for ARM.**
  56
  57 * **Updated the ixgbe base driver.**
  58
  59   Updated the ixgbe base driver, including the following changes:
  60
  61   * add X550em_a 10G PHY support
  62   * support flow control auto negotiation for X550em_a 1G PHY
  63   * add X550em_a FW ALEF support
  64   * increase mailbox version to ixgbe_mbox_api_13
  65   * add two MAC ops for Hyper-V support
  66
  67 * **Updated the QAT PMD.**
  68
  69   The QAT PMD was updated with following support:
  70
  71   * MD5_HMAC algorithm
  72   * SHA224-HMAC algorithm
  73   * SHA384-HMAC algorithm
  74   * GMAC algorithm
  75   * KASUMI (F8 and F9) algorithm
  76   * 3DES algorithm
  77   * NULL algorithm
  78   * C3XXX device
  79   * C62XX device
  80
  81 * **Added libcrypto PMD.**
  82
  83   A new crypto PMD has been added, which provides several ciphering and hashing.
  84   All cryptography operations are using Openssl library crypto API.
  85
  86 * **Updated the IPsec example with following support:**
  87
  88   * configuration file
  89   * AES CBC IV generation with cipher forward function
  90   * AES GCM/CTR mode
  91
  92
  93 Resolved Issues
  94 ---------------
  95
  96 .. This section should contain bug fixes added to the relevant sections. Sample format:
  97
  98    * **code/section Fixed issue in the past tense with a full stop.**
  99
 100      Add a short 1-2 sentence description of the resolved issue in the past tense.
 101      The title should contain the code/lib section like a commit message.
 102      Add the entries in alphabetic order in the relevant sections below.
 103
 104    This section is a comment. Make sure to start the actual text at the margin.
 105
 106
 107 EAL
 108 ~~~
 109
 110
 111 Drivers
 112 ~~~~~~~
 113
 114
 115 Libraries
 116 ~~~~~~~~~
 117
 118
 119 Examples
 120 ~~~~~~~~
 121
 122
 123 Other
 124 ~~~~~
 125
 126
 127 Known Issues
 128 ------------
 129
 130 .. This section should contain new known issues in this release. Sample format:
 131
 132    * **Add title in present tense with full stop.**
 133
 134      Add a short 1-2 sentence description of the known issue in the present
 135      tense. Add information on any known workarounds.
 136
 137    This section is a comment. Make sure to start the actual text at the margin.
 138
 139
 140 API Changes
 141 -----------
 142
 143 .. This section should contain API changes. Sample format:
 144
 145    * Add a short 1-2 sentence description of the API change. Use fixed width
 146      quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 147
 148    This section is a comment. Make sure to start the actual text at the margin.
 149
 150 * The driver names have been changed. It especially impacts ``--vdev`` arguments.
 151   Examples: ``eth_pcap`` becomes ``net_pcap``
 152   and ``cryptodev_aesni_mb_pmd`` becomes ``crypto_aesni_mb``.
 153
 154 * The log history is removed.
 155
 156 * The ``rte_ivshmem`` feature (including library and EAL code) has been removed
 157   in 16.11 because it had some design issues which were not planned to be fixed.
 158
 159
 160 ABI Changes
 161 -----------
 162
 163 .. This section should contain ABI changes. Sample format:
 164
 165    * Add a short 1-2 sentence description of the ABI change that was announced in
 166      the previous releases and made in this release. Use fixed width quotes for
 167      ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 168
 169    This section is a comment. Make sure to start the actual text at the margin.
 170
 171
 172
 173 Shared Library Versions
 174 -----------------------
 175
 176 .. Update any library version updated in this release and prepend with a ``+``
 177    sign, like this:
 178
 179      libethdev.so.4
 180      librte_acl.so.2
 181    + librte_cfgfile.so.2
 182      librte_cmdline.so.2
 183
 184
 185
 186 The libraries prepended with a plus sign were incremented in this version.
 187
 188 .. code-block:: diff
 189
 190      libethdev.so.4
 191      librte_acl.so.2
 192      librte_cfgfile.so.2
 193      librte_cmdline.so.2
 194      librte_cryptodev.so.1
 195      librte_distributor.so.1
 196    + librte_eal.so.3
 197      librte_hash.so.2
 198      librte_ip_frag.so.1
 199      librte_jobstats.so.1
 200      librte_kni.so.2
 201      librte_kvargs.so.1
 202      librte_lpm.so.2
 203      librte_mbuf.so.2
 204      librte_mempool.so.2
 205      librte_meter.so.1
 206      librte_pdump.so.1
 207      librte_pipeline.so.3
 208      librte_pmd_bond.so.1
 209      librte_pmd_ring.so.2
 210      librte_port.so.3
 211      librte_power.so.1
 212      librte_reorder.so.1
 213      librte_ring.so.1
 214      librte_sched.so.1
 215      librte_table.so.2
 216      librte_timer.so.1
 217      librte_vhost.so.3
 218
 219
 220 Tested Platforms
 221 ----------------
 222
 223 .. This section should contain a list of platforms that were tested with this release.
 224
 225    The format is:
 226
 227    #. Platform name.
 228
 229       * Platform details.
 230       * Platform details.
 231
 232    This section is a comment. Make sure to start the actual text at the margin.
 233
 234
 235 Tested NICs
 236 -----------
 237
 238 .. This section should contain a list of NICs that were tested with this release.
 239
 240    The format is:
 241
 242    #. NIC name.
 243
 244       * NIC details.
 245       * NIC details.
 246
 247    This section is a comment. Make sure to start the actual text at the margin.
 248
 249
 250 Tested OSes
 251 -----------
 252
 253 .. This section should contain a list of OSes that were tested with this release.
 254    The format is as follows, in alphabetical order:
 255
 256    * CentOS 7.0
 257    * Fedora 23
 258    * Fedora 24
 259    * FreeBSD 10.3
 260    * Red Hat Enterprise Linux 7.2
 261    * SUSE Enterprise Linux 12
 262    * Ubuntu 15.10
 263    * Ubuntu 16.04 LTS
 264    * Wind River Linux 8
 265
 266    This section is a comment. Make sure to start the actual text at the margin.