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