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 * **Supported offloads with virtio.**
  87
  88   * Rx/Tx checksums
  89   * LRO
  90   * TSO
  91
  92 * **Added virtio NEON support for ARM.**
  93
  94 * **Updated the ixgbe base driver.**
  95
  96   Updated the ixgbe base driver, including the following changes:
  97
  98   * add X550em_a 10G PHY support
  99   * support flow control auto negotiation for X550em_a 1G PHY
 100   * add X550em_a FW ALEF support
 101   * increase mailbox version to ixgbe_mbox_api_13
 102   * add two MAC ops for Hyper-V support
 103
 104 * **Added API's for VF management to the ixgbe PMD.**
 105
 106   Eight new API's have been added to the ixgbe PMD for VF management from the PF.
 107   The declarations for the API's can be found in ``rte_pmd_ixgbe.h``.
 108
 109 * **Updated the QAT PMD.**
 110
 111   The QAT PMD was updated with following support:
 112
 113   * MD5_HMAC algorithm
 114   * SHA224-HMAC algorithm
 115   * SHA384-HMAC algorithm
 116   * GMAC algorithm
 117   * KASUMI (F8 and F9) algorithm
 118   * 3DES algorithm
 119   * NULL algorithm
 120   * C3XXX device
 121   * C62XX device
 122
 123 * **Added openssl PMD.**
 124
 125   A new crypto PMD has been added, which provides several ciphering and hashing.
 126   All cryptography operations are using Openssl library crypto API.
 127
 128 * **Updated the IPsec example with following support:**
 129
 130   * configuration file
 131   * AES CBC IV generation with cipher forward function
 132   * AES GCM/CTR mode
 133
 134 * **Added support for new gcc -march option.**
 135
 136   The GCC 4.9 ``-march`` option supports the Intel processor code names.
 137   The config option ``RTE_MACHINE`` can be used to pass code names to the compiler as ``-march`` flag.
 138
 139
 140 Resolved Issues
 141 ---------------
 142
 143 .. This section should contain bug fixes added to the relevant sections. Sample format:
 144
 145    * **code/section Fixed issue in the past tense with a full stop.**
 146
 147      Add a short 1-2 sentence description of the resolved issue in the past tense.
 148      The title should contain the code/lib section like a commit message.
 149      Add the entries in alphabetic order in the relevant sections below.
 150
 151    This section is a comment. Make sure to start the actual text at the margin.
 152
 153
 154 EAL
 155 ~~~
 156
 157
 158 Drivers
 159 ~~~~~~~
 160
 161
 162 Libraries
 163 ~~~~~~~~~
 164
 165
 166 Examples
 167 ~~~~~~~~
 168
 169
 170 Other
 171 ~~~~~
 172
 173
 174 Known Issues
 175 ------------
 176
 177 .. This section should contain new known issues in this release. Sample format:
 178
 179    * **Add title in present tense with full stop.**
 180
 181      Add a short 1-2 sentence description of the known issue in the present
 182      tense. Add information on any known workarounds.
 183
 184    This section is a comment. Make sure to start the actual text at the margin.
 185
 186
 187 API Changes
 188 -----------
 189
 190 .. This section should contain API changes. Sample format:
 191
 192    * Add a short 1-2 sentence description of the API change. Use fixed width
 193      quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 194
 195    This section is a comment. Make sure to start the actual text at the margin.
 196
 197 * The driver names have been changed. It especially impacts ``--vdev`` arguments.
 198   Examples: ``eth_pcap`` becomes ``net_pcap``
 199   and ``cryptodev_aesni_mb_pmd`` becomes ``crypto_aesni_mb``.
 200
 201 * The log history is removed.
 202
 203 * The ``rte_ivshmem`` feature (including library and EAL code) has been removed
 204   in 16.11 because it had some design issues which were not planned to be fixed.
 205
 206 * The ``file_name`` data type of ``struct rte_port_source_params`` and
 207   ``struct rte_port_sink_params`` is changed from `char *`` to ``const char *``.
 208
 209 * **Improved device/driver hierarchy and generalized hotplugging**
 210
 211   Device and driver relationship has been restructured by introducing generic
 212   classes. This paves way for having PCI, VDEV and other device types as
 213   just instantiated objects rather than classes in themselves. Hotplugging too
 214   has been generalized into EAL so that ethernet or crypto devices can use the
 215   common infrastructure.
 216
 217   * removed ``pmd_type`` as way of segregation of devices
 218   * moved ``numa_node`` and ``devargs`` into ``rte_driver`` from
 219     ``rte_pci_driver``. These can now be used by any instantiated object of
 220     ``rte_driver``.
 221   * added ``rte_device`` class and all PCI and VDEV devices inherit from it
 222   * renamed devinit/devuninit handlers to probe/remove to make it more
 223     semantically correct with respect to device<=>driver relationship
 224   * moved hotplugging support to EAL. Hereafter, PCI and vdev can use the
 225     APIs ``rte_eal_dev_attach`` and ``rte_eal_dev_detach``.
 226   * helpers and support macros have been renamed to make them more synonymous
 227     with their device types
 228     (e.g. ``PMD_REGISTER_DRIVER`` => ``RTE_PMD_REGISTER_PCI``)
 229   * Device naming functions have been generalized from ethdev and cryptodev
 230     to EAL. ``rte_eal_pci_device_name`` has been introduced for obtaining
 231     unique device name from PCI Domain-BDF description.
 232   * Virtual device registration APIs have been added: ``rte_eal_vdrv_register``
 233     and ``rte_eal_vdrv_unregister``.
 234
 235
 236 ABI Changes
 237 -----------
 238
 239 .. This section should contain ABI changes. Sample format:
 240
 241    * Add a short 1-2 sentence description of the ABI change that was announced in
 242      the previous releases and made in this release. Use fixed width quotes for
 243      ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 244
 245    This section is a comment. Make sure to start the actual text at the margin.
 246
 247
 248
 249 Shared Library Versions
 250 -----------------------
 251
 252 .. Update any library version updated in this release and prepend with a ``+``
 253    sign, like this:
 254
 255      libethdev.so.4
 256      librte_acl.so.2
 257    + librte_cfgfile.so.2
 258      librte_cmdline.so.2
 259
 260
 261
 262 The libraries prepended with a plus sign were incremented in this version.
 263
 264 .. code-block:: diff
 265
 266      librte_acl.so.2
 267      librte_cfgfile.so.2
 268      librte_cmdline.so.2
 269    + librte_cryptodev.so.2
 270      librte_distributor.so.1
 271    + librte_eal.so.3
 272    + librte_ethdev.so.5
 273      librte_hash.so.2
 274      librte_ip_frag.so.1
 275      librte_jobstats.so.1
 276      librte_kni.so.2
 277      librte_kvargs.so.1
 278      librte_lpm.so.2
 279      librte_mbuf.so.2
 280      librte_mempool.so.2
 281      librte_meter.so.1
 282      librte_net.so.1
 283      librte_pdump.so.1
 284      librte_pipeline.so.3
 285      librte_pmd_bond.so.1
 286      librte_pmd_ring.so.2
 287      librte_port.so.3
 288      librte_power.so.1
 289      librte_reorder.so.1
 290      librte_ring.so.1
 291      librte_sched.so.1
 292      librte_table.so.2
 293      librte_timer.so.1
 294      librte_vhost.so.3
 295
 296
 297 Tested Platforms
 298 ----------------
 299
 300 .. This section should contain a list of platforms that were tested with this release.
 301
 302    The format is:
 303
 304    #. Platform name.
 305
 306       * Platform details.
 307       * Platform details.
 308
 309    This section is a comment. Make sure to start the actual text at the margin.
 310
 311
 312 Tested NICs
 313 -----------
 314
 315 .. This section should contain a list of NICs that were tested with this release.
 316
 317    The format is:
 318
 319    #. NIC name.
 320
 321       * NIC details.
 322       * NIC details.
 323
 324    This section is a comment. Make sure to start the actual text at the margin.
 325
 326
 327 Tested OSes
 328 -----------
 329
 330 .. This section should contain a list of OSes that were tested with this release.
 331    The format is as follows, in alphabetical order:
 332
 333    * CentOS 7.0
 334    * Fedora 23
 335    * Fedora 24
 336    * FreeBSD 10.3
 337    * Red Hat Enterprise Linux 7.2
 338    * SUSE Enterprise Linux 12
 339    * Ubuntu 15.10
 340    * Ubuntu 16.04 LTS
 341    * Wind River Linux 8
 342
 343    This section is a comment. Make sure to start the actual text at the margin.