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