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