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