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