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