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