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
  91
  92 Resolved Issues
  93 ---------------
  94
  95 .. This section should contain bug fixes added to the relevant sections. Sample format:
  96
  97    * **code/section Fixed issue in the past tense with a full stop.**
  98
  99      Add a short 1-2 sentence description of the resolved issue in the past tense.
 100      The title should contain the code/lib section like a commit message.
 101      Add the entries in alphabetic order in the relevant sections below.
 102
 103    This section is a comment. Make sure to start the actual text at the margin.
 104
 105
 106 EAL
 107 ~~~
 108
 109
 110 Drivers
 111 ~~~~~~~
 112
 113
 114 Libraries
 115 ~~~~~~~~~
 116
 117
 118 Examples
 119 ~~~~~~~~
 120
 121
 122 Other
 123 ~~~~~
 124
 125
 126 Known Issues
 127 ------------
 128
 129 .. This section should contain new known issues in this release. Sample format:
 130
 131    * **Add title in present tense with full stop.**
 132
 133      Add a short 1-2 sentence description of the known issue in the present
 134      tense. Add information on any known workarounds.
 135
 136    This section is a comment. Make sure to start the actual text at the margin.
 137
 138
 139 API Changes
 140 -----------
 141
 142 .. This section should contain API changes. Sample format:
 143
 144    * Add a short 1-2 sentence description of the API change. Use fixed width
 145      quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 146
 147    This section is a comment. Make sure to start the actual text at the margin.
 148
 149 * The driver names have been changed. It especially impacts ``--vdev`` arguments.
 150   Examples: ``eth_pcap`` becomes ``net_pcap``
 151   and ``cryptodev_aesni_mb_pmd`` becomes ``crypto_aesni_mb``.
 152
 153 * The log history is removed.
 154
 155 * The ``rte_ivshmem`` feature (including library and EAL code) has been removed
 156   in 16.11 because it had some design issues which were not planned to be fixed.
 157
 158
 159 ABI Changes
 160 -----------
 161
 162 .. This section should contain ABI changes. Sample format:
 163
 164    * Add a short 1-2 sentence description of the ABI change that was announced in
 165      the previous releases and made in this release. Use fixed width quotes for
 166      ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 167
 168    This section is a comment. Make sure to start the actual text at the margin.
 169
 170
 171
 172 Shared Library Versions
 173 -----------------------
 174
 175 .. Update any library version updated in this release and prepend with a ``+``
 176    sign, like this:
 177
 178      libethdev.so.4
 179      librte_acl.so.2
 180    + librte_cfgfile.so.2
 181      librte_cmdline.so.2
 182
 183
 184
 185 The libraries prepended with a plus sign were incremented in this version.
 186
 187 .. code-block:: diff
 188
 189      libethdev.so.4
 190      librte_acl.so.2
 191      librte_cfgfile.so.2
 192      librte_cmdline.so.2
 193      librte_cryptodev.so.1
 194      librte_distributor.so.1
 195    + librte_eal.so.3
 196      librte_hash.so.2
 197      librte_ip_frag.so.1
 198      librte_jobstats.so.1
 199      librte_kni.so.2
 200      librte_kvargs.so.1
 201      librte_lpm.so.2
 202      librte_mbuf.so.2
 203      librte_mempool.so.2
 204      librte_meter.so.1
 205      librte_pdump.so.1
 206      librte_pipeline.so.3
 207      librte_pmd_bond.so.1
 208      librte_pmd_ring.so.2
 209      librte_port.so.3
 210      librte_power.so.1
 211      librte_reorder.so.1
 212      librte_ring.so.1
 213      librte_sched.so.1
 214      librte_table.so.2
 215      librte_timer.so.1
 216      librte_vhost.so.3
 217
 218
 219 Tested Platforms
 220 ----------------
 221
 222 .. This section should contain a list of platforms that were tested with this release.
 223
 224    The format is:
 225
 226    #. Platform name.
 227
 228       * Platform details.
 229       * Platform details.
 230
 231    This section is a comment. Make sure to start the actual text at the margin.
 232
 233
 234 Tested NICs
 235 -----------
 236
 237 .. This section should contain a list of NICs that were tested with this release.
 238
 239    The format is:
 240
 241    #. NIC name.
 242
 243       * NIC details.
 244       * NIC details.
 245
 246    This section is a comment. Make sure to start the actual text at the margin.
 247
 248
 249 Tested OSes
 250 -----------
 251
 252 .. This section should contain a list of OSes that were tested with this release.
 253    The format is as follows, in alphabetical order:
 254
 255    * CentOS 7.0
 256    * Fedora 23
 257    * Fedora 24
 258    * FreeBSD 10.3
 259    * Red Hat Enterprise Linux 7.2
 260    * SUSE Enterprise Linux 12
 261    * Ubuntu 15.10
 262    * Ubuntu 16.04 LTS
 263    * Wind River Linux 8
 264
 265    This section is a comment. Make sure to start the actual text at the margin.