doc/guides/rel_notes/release_18_11.rst

   1 ..  SPDX-License-Identifier: BSD-3-Clause
   2     Copyright 2018 The DPDK contributors
   3
   4 DPDK Release 18.11
   5 ==================
   6
   7 .. **Read this first.**
   8
   9    The text in the sections below explains how to update the release notes.
  10
  11    Use proper spelling, capitalization and punctuation in all sections.
  12
  13    Variable and config names should be quoted as fixed width text:
  14    ``LIKE_THIS``.
  15
  16    Build the docs and view the output file to ensure the changes are correct::
  17
  18       make doc-guides-html
  19
  20       xdg-open build/doc/html/guides/rel_notes/release_18_11.html
  21
  22
  23 New Features
  24 ------------
  25
  26 .. This section should contain new features added in this release.
  27    Sample format:
  28
  29    * **Add a title in the past tense with a full stop.**
  30
  31      Add a short 1-2 sentence description in the past tense.
  32      The description should be enough to allow someone scanning
  33      the release notes to understand the new feature.
  34
  35      If the feature adds a lot of sub-features you can use a bullet list
  36      like this:
  37
  38      * Added feature foo to do something.
  39      * Enhanced feature bar to do something else.
  40
  41      Refer to the previous release notes for examples.
  42
  43      Suggested order in release notes items:
  44      * Core libs (EAL, mempool, ring, mbuf, buses)
  45      * Device abstraction libs and PMDs
  46        - ethdev (lib, PMDs)
  47        - cryptodev (lib, PMDs)
  48        - eventdev (lib, PMDs)
  49        - etc
  50      * Other libs
  51      * Apps, Examples, Tools (if significative)
  52
  53      This section is a comment. Do not overwrite or remove it.
  54      Also, make sure to start the actual text at the margin.
  55      =========================================================
  56
  57 * **Added support for using externally allocated memory in DPDK.**
  58
  59   DPDK has gained support for creating new ``rte_malloc`` heaps referencing
  60   memory that was created outside of DPDK's own page allocator, and using that
  61   memory natively with any other DPDK library or data structure.
  62
  63 * **Add support to offload more flow match and actions for CXGBE PMD**
  64
  65   Flow API support has been enhanced for CXGBE Poll Mode Driver to offload:
  66
  67   * Match items: destination MAC address.
  68   * Action items: push/pop/rewrite vlan header.
  69
  70 * **Added a devarg to use the latest supported vector path in i40e.**
  71   A new devarg ``use-latest-supported-vec`` was introduced to allow users to
  72   choose the latest vector path that the platform supported. For example, users
  73   can use AVX2 vector path on BDW/HSW to get better performance.
  74
  75 * **Added support for SR-IOV in netvsc PMD.**
  76
  77   The ``netvsc`` poll mode driver now supports the Accelerated Networking
  78   SR-IOV option in Hyper-V and Azure. This is an alternative to the previous
  79   vdev_netvsc, tap, and failsafe drivers combination.
  80
  81 * **Added a new net driver for Marvell Armada 3k device.**
  82
  83   Added the new ``mvneta`` net driver for Marvell Armada 3k device. See the
  84   :doc:`../nics/mvneta` NIC guide for more details on this new driver.
  85
  86 * **Added NXP ENETC PMD.**
  87
  88   Added the new enetc driver for NXP enetc platform. See the
  89   "ENETC Poll Mode Driver" document for more details on this new driver.
  90
  91 * **Updated Solarflare network PMD.**
  92
  93   Updated the sfc_efx driver including the following changes:
  94
  95   * Added support for Rx scatter in EF10 datapath implementation.
  96   * Added support for Rx descriptor status API in EF10 datapath implementation.
  97   * Added support for TSO in EF10 datapath implementation.
  98
  99 * **Updated failsafe driver.**
 100
 101   Updated the failsafe driver including the following changes:
 102
 103   * Support for Rx and Tx queues start and stop.
 104   * Support for Rx and Tx queues deferred start.
 105   * Support for runtime Rx and Tx queues setup.
 106   * Support multicast MAC address set.
 107
 108 * **Added Event Ethernet Tx Adapter.**
 109
 110   Added event ethernet Tx adapter library that  provides configuration and
 111   data path APIs for the ethernet transmit stage of an event driven packet
 112   processing application. These APIs abstract the implementation of the
 113   transmit stage and allow the application to use eventdev PMD support or
 114   a common implementation.
 115
 116 * **Added Distributed Software Eventdev PMD.**
 117
 118   Added the new Distributed Software Event Device (DSW), which is a
 119   pure-software eventdev driver distributing the work of scheduling
 120   among all eventdev ports and the lcores using them. DSW, compared to
 121   the SW eventdev PMD, sacrifices load balancing performance to
 122   gain better event scheduling throughput and scalability.
 123
 124 * **Added ability to switch queue deferred start flag on testpmd app.**
 125
 126   Added a console command to testpmd app, giving ability to switch
 127   ``rx_deferred_start`` or ``tx_deferred_start`` flag of the specified queue of
 128   the specified port. The port must be stopped before the command call in order
 129   to reconfigure queues.
 130
 131 * **Add a new sample for vDPA**
 132
 133   The vdpa sample application creates vhost-user sockets by using the
 134   vDPA backend. vDPA stands for vhost Data Path Acceleration which utilizes
 135   virtio ring compatible devices to serve virtio driver directly to enable
 136   datapath acceleration. As vDPA driver can help to set up vhost datapath,
 137   this application doesn't need to launch dedicated worker threads for vhost
 138   enqueue/dequeue operations.
 139
 140
 141 API Changes
 142 -----------
 143
 144 .. This section should contain API changes. Sample format:
 145
 146    * Add a short 1-2 sentence description of the API change.
 147      Use fixed width quotes for ``function_names`` or ``struct_names``.
 148      Use the past tense.
 149
 150    This section is a comment. Do not overwrite or remove it.
 151    Also, make sure to start the actual text at the margin.
 152    =========================================================
 153
 154 * eal: ``rte_memseg_list`` structure now has an additional flag indicating
 155   whether the memseg list is externally allocated. This will have implications
 156   for any users of memseg-walk-related functions, as they will now have to skip
 157   externally allocated segments in most cases if the intent is to only iterate
 158   over internal DPDK memory.
 159   ``socket_id`` parameter across the entire DPDK has gained additional meaning,
 160   as some socket ID's will now be representing externally allocated memory. No
 161   changes will be required for existing code as backwards compatibility will be
 162   kept, and those who do not use this feature will not see these extra socket
 163   ID's. Any new API's must not check socket ID parameters themselves, and must
 164   instead leave it to the memory subsystem to decide whether socket ID is a
 165   valid one.
 166
 167 * eal: The following devargs functions, which were deprecated in 18.05,
 168   were removed in 18.11:
 169   ``rte_eal_parse_devargs_str()``, ``rte_eal_devargs_add()``,
 170   ``rte_eal_devargs_type_count()``, and ``rte_eal_devargs_dump()``.
 171
 172 * eal: The parameters of the function ``rte_devargs_remove()`` have changed
 173   from bus and device names to ``struct rte_devargs``.
 174
 175 * mbuf: The ``__rte_mbuf_raw_free()`` and ``__rte_pktmbuf_prefree_seg()``
 176   functions were deprecated since 17.05 and are replaced by
 177   ``rte_mbuf_raw_free()`` and ``rte_pktmbuf_prefree_seg()``.
 178
 179 * A new device flag, RTE_ETH_DEV_NOLIVE_MAC_ADDR, changes the order of
 180   actions inside rte_eth_dev_start regarding MAC set. Some NICs do not
 181   support MAC changes once the port has started and with this new device
 182   flag the MAC can be properly configured in any case. This is particularly
 183   important for bonding.
 184
 185 * The default behaviour of CRC strip offload changed. Without any specific Rx
 186   offload flag, default behavior by PMD is now to strip CRC.
 187   DEV_RX_OFFLOAD_CRC_STRIP offload flag has been removed.
 188   To request keeping CRC, application should set ``DEV_RX_OFFLOAD_KEEP_CRC`` Rx
 189   offload.
 190
 191 * eventdev: Type of 2nd parameter to ``rte_event_eth_rx_adapter_caps_get()``
 192   has been changed from uint8_t to uint16_t.
 193
 194
 195 ABI Changes
 196 -----------
 197
 198 .. This section should contain ABI changes. Sample format:
 199
 200    * Add a short 1-2 sentence description of the ABI change
 201      that was announced in the previous releases and made in this release.
 202      Use fixed width quotes for ``function_names`` or ``struct_names``.
 203      Use the past tense.
 204
 205    This section is a comment. Do not overwrite or remove it.
 206    Also, make sure to start the actual text at the margin.
 207    =========================================================
 208
 209 * eal: added ``legacy_mem`` and ``single_file_segments`` values to
 210        ``rte_config`` structure on account of improving DPDK usability when
 211        using either ``--legacy-mem`` or ``--single-file-segments`` flags.
 212
 213 * eal: EAL library ABI version was changed due to previously announced work on
 214        supporting external memory in DPDK:
 215          - structure ``rte_memseg_list`` now has a new field indicating length
 216            of memory addressed by the segment list
 217          - structure ``rte_memseg_list`` now has a new flag indicating whether
 218            the memseg list refers to external memory
 219          - structure ``rte_malloc_heap`` now has a new field indicating socket
 220            ID the malloc heap belongs to
 221          - structure ``rte_mem_config`` has had its ``malloc_heaps`` array
 222            resized from ``RTE_MAX_NUMA_NODES`` to ``RTE_MAX_HEAPS`` value
 223          - structure ``rte_malloc_heap`` now has a ``heap_name`` member
 224          - structure ``rte_eal_memconfig`` has been extended to contain next
 225            socket ID for externally allocated segments
 226
 227 * eal: The structure ``rte_device`` got a new field to reference a ``rte_bus``.
 228   It is changing the size of the ``struct rte_device`` and the inherited
 229   device structures of all buses.
 230
 231
 232 Removed Items
 233 -------------
 234
 235 .. This section should contain removed items in this release. Sample format:
 236
 237    * Add a short 1-2 sentence description of the removed item
 238      in the past tense.
 239
 240    This section is a comment. Do not overwrite or remove it.
 241    Also, make sure to start the actual text at the margin.
 242    =========================================================
 243
 244
 245 Shared Library Versions
 246 -----------------------
 247
 248 .. Update any library version updated in this release
 249    and prepend with a ``+`` sign, like this:
 250
 251      librte_acl.so.2
 252    + librte_cfgfile.so.2
 253      librte_cmdline.so.2
 254
 255    This section is a comment. Do not overwrite or remove it.
 256    =========================================================
 257
 258 The libraries prepended with a plus sign were incremented in this version.
 259
 260 .. code-block:: diff
 261
 262      librte_acl.so.2
 263      librte_bbdev.so.1
 264      librte_bitratestats.so.2
 265      librte_bpf.so.1
 266    + librte_bus_dpaa.so.2
 267    + librte_bus_fslmc.so.2
 268    + librte_bus_ifpga.so.2
 269    + librte_bus_pci.so.2
 270    + librte_bus_vdev.so.2
 271    + librte_bus_vmbus.so.2
 272      librte_cfgfile.so.2
 273      librte_cmdline.so.2
 274      librte_common_octeontx.so.1
 275      librte_compressdev.so.1
 276      librte_cryptodev.so.5
 277      librte_distributor.so.1
 278    + librte_eal.so.9
 279      librte_ethdev.so.10
 280    + librte_eventdev.so.6
 281      librte_flow_classify.so.1
 282      librte_gro.so.1
 283      librte_gso.so.1
 284      librte_hash.so.2
 285      librte_ip_frag.so.1
 286      librte_jobstats.so.1
 287      librte_kni.so.2
 288      librte_kvargs.so.1
 289      librte_latencystats.so.1
 290      librte_lpm.so.2
 291      librte_mbuf.so.4
 292      librte_mempool.so.5
 293      librte_meter.so.2
 294      librte_metrics.so.1
 295      librte_net.so.1
 296      librte_pci.so.1
 297      librte_pdump.so.2
 298      librte_pipeline.so.3
 299      librte_pmd_bnxt.so.2
 300      librte_pmd_bond.so.2
 301      librte_pmd_i40e.so.2
 302      librte_pmd_ixgbe.so.2
 303      librte_pmd_dpaa2_cmdif.so.1
 304      librte_pmd_dpaa2_qdma.so.1
 305      librte_pmd_ring.so.2
 306      librte_pmd_softnic.so.1
 307      librte_pmd_vhost.so.2
 308    + librte_pmd_netvsc.so.1
 309      librte_port.so.3
 310      librte_power.so.1
 311      librte_rawdev.so.1
 312      librte_reorder.so.1
 313      librte_ring.so.2
 314      librte_sched.so.1
 315      librte_security.so.1
 316      librte_table.so.3
 317      librte_timer.so.1
 318      librte_vhost.so.3
 319
 320
 321 Known Issues
 322 ------------
 323
 324 .. This section should contain new known issues in this release. Sample format:
 325
 326    * **Add title in present tense with full stop.**
 327
 328      Add a short 1-2 sentence description of the known issue
 329      in the present tense. Add information on any known workarounds.
 330
 331    This section is a comment. Do not overwrite or remove it.
 332    Also, make sure to start the actual text at the margin.
 333    =========================================================
 334
 335 * When using SR-IOV (VF) support with netvsc PMD and the Mellanox mlx5 bifurcated
 336   driver; the Linux netvsc device must be brought up before the netvsc device is
 337   unbound and passed to the DPDK.
 338
 339
 340 Tested Platforms
 341 ----------------
 342
 343 .. This section should contain a list of platforms that were tested
 344    with this release.
 345
 346    The format is:
 347
 348    * <vendor> platform with <vendor> <type of devices> combinations
 349
 350      * List of CPU
 351      * List of OS
 352      * List of devices
 353      * Other relevant details...
 354
 355    This section is a comment. Do not overwrite or remove it.
 356    Also, make sure to start the actual text at the margin.
 357    =========================================================