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