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