doc/guides/rel_notes/release_18_05.rst

   1 DPDK Release 18.05
   2 ==================
   3
   4 .. **Read this first.**
   5
   6    The text in the sections 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:
  11    ``LIKE_THIS``.
  12
  13    Build the docs and view the output file to ensure the changes are correct::
  14
  15       make doc-guides-html
  16
  17       xdg-open build/doc/html/guides/rel_notes/release_18_05.html
  18
  19
  20 New Features
  21 ------------
  22
  23 .. This section should contain new features added in this release. Sample
  24    format:
  25
  26    * **Add a title in the past tense with a full stop.**
  27
  28      Add a short 1-2 sentence description in the past tense. The description
  29      should be enough to allow someone scanning the release notes to
  30      understand the new feature.
  31
  32      If the feature adds a lot of sub-features you can use a bullet list like
  33      this:
  34
  35      * Added feature foo to do something.
  36      * Enhanced feature bar to do something else.
  37
  38      Refer to the previous release notes for examples.
  39
  40      This section is a comment. Do not overwrite or remove it.
  41      Also, make sure to start the actual text at the margin.
  42      =========================================================
  43
  44 * **Added bucket mempool driver.**
  45
  46   Added bucket mempool driver which provides a way to allocate contiguous
  47   block of objects.
  48   Number of objects in the block depends on how many objects fit in
  49   RTE_DRIVER_MEMPOOL_BUCKET_SIZE_KB memory chunk which is build time option.
  50   The number may be obtained using rte_mempool_ops_get_info() API.
  51   Contiguous blocks may be allocated using rte_mempool_get_contig_blocks() API.
  52
  53 * **Added PMD-recommended Tx and Rx parameters**
  54
  55   Applications can now query drivers for device-tuned values of
  56   ring sizes, burst sizes, and number of queues.
  57
  58 * **Added RSS hash and key update to CXGBE PMD.**
  59
  60   Support to update RSS hash and key has been added to CXGBE PMD.
  61
  62 * **Added CXGBE VF PMD.**
  63
  64   CXGBE VF Poll Mode Driver has been added to run DPDK over Chelsio
  65   T5/T6 NIC VF instances.
  66
  67 * **Updated Solarflare network PMD.**
  68
  69   Updated the sfc_efx driver including the following changes:
  70
  71   * Added support for Solarflare XtremeScale X2xxx family adapters.
  72   * Added support for NVGRE, VXLAN and GENEVE filters in flow API.
  73   * Added support for DROP action in flow API.
  74   * Added support for equal stride super-buffer Rx mode (X2xxx only).
  75   * Added support for MARK and FLAG actions in flow API (X2xxx only).
  76
  77 * **Added Ethernet poll mode driver for AMD XGBE devices.**
  78
  79   Added the new ``axgbe`` ethernet poll mode driver for AMD XGBE devices.
  80   See the :doc:`../nics/axgbe` nic driver guide for more details on this
  81   new driver.
  82
  83 * **Updated szedata2 PMD.**
  84
  85   Added support for new NFB-200G2QL card.
  86   New API was introduced in the libsze2 library which the szedata2 PMD depends
  87   on thus the new version of the library was needed.
  88   New versions of the packages are available and the minimum required version
  89   is 4.4.1.
  90
  91 * **Added support for Broadcom NetXtreme-S (BCM58800) family of controllers (aka Stingray)**
  92
  93   The BCM58800 devices feature a NetXtreme E-Series advanced network controller, a high-performance
  94   ARM CPU block, PCI Express (PCIe) Gen3 interfaces, key accelerators for compute offload and a high-
  95   speed memory subsystem including L3 cache and DDR4 interfaces, all interconnected by a coherent
  96   Network-on-chip (NOC) fabric.
  97
  98   The ARM CPU subsystem features eight ARMv8 Cortex-A72 CPUs at 3.0 GHz, arranged in a multi-cluster
  99   configuration.
 100
 101 * **Added IFCVF vDPA driver.**
 102
 103   Added IFCVF vDPA driver to support Intel FPGA 100G VF device. IFCVF works
 104   as a HW vhost data path accelerator, it supports live migration and is
 105   compatible with virtio 0.95 and 1.0. This driver registers ifcvf vDPA driver
 106   to vhost lib, when virtio connected, with the help of the registered vDPA
 107   driver the assigned VF gets configured to Rx/Tx directly to VM's virtio
 108   vrings.
 109
 110 * **Added support for virtio-user server mode.**
 111   In a container environment if the vhost-user backend restarts, there's no way
 112   for it to reconnect to virtio-user. To address this, support for server mode
 113   is added. In this mode the socket file is created by virtio-user, which the
 114   backend connects to. This means that if the backend restarts, it can reconnect
 115   to virtio-user and continue communications.
 116
 117 * **Added crypto workload support to vhost library.**
 118
 119   New APIs are introduced in vhost library to enable virtio crypto support
 120   including session creation/deletion handling and translating virtio-crypto
 121   request into DPDK crypto operations. A sample application is also introduced.
 122
 123 * **Added virtio crypto PMD.**
 124
 125   Added a new poll mode driver for virtio crypto devices, which provides
 126   AES-CBC ciphering and AES-CBC with HMAC-SHA1 algorithm-chaining. See the
 127   :doc:`../cryptodevs/virtio` crypto driver guide for more details on
 128   this new driver.
 129
 130 * **Added AMD CCP Crypto PMD.**
 131
 132   Added the new ``ccp`` crypto driver for AMD CCP devices. See the
 133   :doc:`../cryptodevs/ccp` crypto driver guide for more details on
 134   this new driver.
 135
 136 * **Updated AESNI MB PMD.**
 137
 138   The AESNI MB PMD has been updated with additional support for:
 139
 140   * AES-CMAC (128-bit key).
 141
 142 * **Added the Event Timer Adapter Library.**
 143
 144   The Event Timer Adapter Library extends the event-based model by introducing
 145   APIs that allow applications to arm/cancel event timers that generate
 146   timer expiry events. This new type of event is scheduled by an event device
 147   along with existing types of events.
 148
 149 * **Added device event monitor framework.**
 150
 151   Added a general device event monitor framework at EAL, for device dynamic management.
 152   Such as device hotplug awareness and actions adopted accordingly. The list of new APIs:
 153
 154   * ``rte_dev_event_monitor_start`` and ``rte_dev_event_monitor_stop`` are for
 155     the event monitor enable and disable.
 156   * ``rte_dev_event_callback_register`` and ``rte_dev_event_callback_unregister``
 157     are for the user's callbacks register and unregister.
 158
 159   Linux uevent is supported as backend of this device event notification framework.
 160
 161 * **Added support for procinfo and pdump on eth vdev.**
 162
 163   For ethernet virtual devices (like tap, pcap, etc), with this feature, we can get
 164   stats/xstats on shared memory from secondary process, and also pdump packets on
 165   those virtual devices.
 166
 167
 168 API Changes
 169 -----------
 170
 171 .. This section should contain API changes. Sample format:
 172
 173    * Add a short 1-2 sentence description of the API change. Use fixed width
 174      quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past
 175      tense.
 176
 177    This section is a comment. Do not overwrite or remove it.
 178    Also, make sure to start the actual text at the margin.
 179    =========================================================
 180
 181 * service cores: no longer marked as experimental.
 182
 183   The service cores functions are no longer marked as experimental, and have
 184   become part of the normal DPDK API and ABI. Any future ABI changes will be
 185   announced at least one release before the ABI change is made. There are no
 186   ABI breaking changes planned.
 187
 188 * eal: ``rte_lcore_has_role()`` return value changed.
 189
 190   This function now returns true or false, respectively,
 191   rather than 0 or <0 for success or failure.
 192   It makes use of the function more intuitive.
 193
 194 * mempool: capability flags and related functions have been removed.
 195
 196   Flags ``MEMPOOL_F_CAPA_PHYS_CONTIG`` and
 197   ``MEMPOOL_F_CAPA_BLK_ALIGNED_OBJECTS`` were used by octeontx mempool
 198   driver to customize generic mempool library behaviour.
 199   Now the new driver callbacks ``calc_mem_size`` and ``populate`` may be
 200   used to achieve it without specific knowledge in the generic code.
 201
 202 * mempool: xmem functions have been deprecated:
 203
 204   - ``rte_mempool_xmem_create``
 205   - ``rte_mempool_xmem_size``
 206   - ``rte_mempool_xmem_usage``
 207   - ``rte_mempool_populate_iova_tab``
 208
 209 * mbuf: The control mbuf API has been removed in v18.05. The impacted
 210   functions and macros are:
 211
 212   - ``rte_ctrlmbuf_init()``
 213   - ``rte_ctrlmbuf_alloc()``
 214   - ``rte_ctrlmbuf_free()``
 215   - ``rte_ctrlmbuf_data()``
 216   - ``rte_ctrlmbuf_len()``
 217   - ``rte_is_ctrlmbuf()``
 218   - ``CTRL_MBUF_FLAG``
 219
 220   The packet mbuf API should be used as a replacement.
 221
 222 * meter: updated to accommodate configuration profiles.
 223
 224   The meter API is changed to support meter configuration profiles. The
 225   configuration profile represents the set of configuration parameters
 226   for a given meter object, such as the rates and sizes for the token
 227   buckets. These configuration parameters were previously the part of meter
 228   object internal data strcuture. The separation of the configuration
 229   parameters from meter object data structure results in reducing its
 230   memory footprint which helps in better cache utilization when large number
 231   of meter objects are used.
 232
 233 * ethdev: The function ``rte_eth_dev_count``, often mis-used to iterate
 234   over ports, is deprecated and replaced by ``rte_eth_dev_count_avail``.
 235   There is also a new function ``rte_eth_dev_count_total`` to get the
 236   total number of allocated ports, available or not.
 237   The hotplug-proof applications should use ``RTE_ETH_FOREACH_DEV`` or
 238   ``RTE_ETH_FOREACH_DEV_OWNED_BY`` as port iterators.
 239
 240 * ethdev, in struct ``struct rte_eth_dev_info``, field ``rte_pci_device *pci_dev``
 241   replaced with field ``struct rte_device *device``.
 242
 243 * **Changes to semantics of rte_eth_dev_configure() parameters.**
 244
 245    If both the ``nb_rx_q`` and ``nb_tx_q`` parameters are zero,
 246    ``rte_eth_dev_configure`` will now use PMD-recommended queue sizes, or if
 247    recommendations are not provided by the PMD the function will use ethdev
 248    fall-back values. Previously setting both of the parameters to zero would
 249    have resulted in ``-EINVAL`` being returned.
 250
 251 * **Changes to semantics of rte_eth_rx_queue_setup() parameters.**
 252
 253    If the ``nb_rx_desc`` parameter is zero, ``rte_eth_rx_queue_setup`` will
 254    now use the PMD-recommended Rx ring size, or in the case where the PMD
 255    does not provide a recommendation, will use an ethdev-provided
 256    fall-back value. Previously, setting ``nb_rx_desc`` to zero would have
 257    resulted in an error.
 258
 259 * **Changes to semantics of rte_eth_tx_queue_setup() parameters.**
 260
 261    If the ``nb_tx_desc`` parameter is zero, ``rte_eth_tx_queue_setup`` will
 262    now use the PMD-recommended Tx ring size, or in the case where the PMD
 263    does not provide a recoomendation, will use an ethdev-provided
 264    fall-back value. Previously, setting ``nb_tx_desc`` to zero would have
 265    resulted in an error.
 266
 267 * ethdev: several changes were made to the flow API.
 268
 269   * Unused DUP action was removed.
 270   * Actions semantics in flow rules: list order now matters ("first
 271     to last" instead of "all simultaneously"), repeated actions are now
 272     all performed, and they do not individually have (non-)terminating
 273     properties anymore.
 274   * Flow rules are now always terminating unless a PASSTHRU action is
 275     present.
 276   * C99-style flexible arrays were replaced with standard pointers in RSS
 277     action and in RAW pattern item structures due to compatibility issues.
 278   * The RSS action was modified to not rely on external
 279     ``struct rte_eth_rss_conf`` anymore to instead expose its own and more
 280     appropriately named configuration fields directly
 281     (``rss_conf->rss_key`` => ``key``,
 282     ``rss_conf->rss_key_len`` => ``key_len``,
 283     ``rss_conf->rss_hf`` => ``types``,
 284     ``num`` => ``queue_num``), and the addition of missing RSS parameters
 285     (``func`` for RSS hash function to apply and ``level`` for the
 286     encapsulation level).
 287   * The VLAN pattern item (``struct rte_flow_item_vlan``) was modified to
 288     include inner EtherType instead of outer TPID. Its default mask was also
 289     modified to cover the VID part (lower 12 bits) of TCI only.
 290   * A new transfer attribute was added to ``struct rte_flow_attr`` in order
 291     to clarify the behavior of some pattern items.
 292   * PF and VF pattern items are now only accepted by PMDs that implement
 293     them (bnxt and i40e) when the transfer attribute is also present for
 294     consistency.
 295   * Pattern item PORT was renamed PHY_PORT to avoid confusion with DPDK port
 296     IDs.
 297   * An action counterpart to the PHY_PORT pattern item was added in order to
 298     redirect matching traffic to a specific physical port.
 299   * PORT_ID pattern item and actions were added to match and target DPDK
 300     port IDs at a higher level than PHY_PORT.
 301
 302 * ethdev: change flow APIs regarding count action:
 303   * ``rte_flow_create()`` API count action now requires the ``struct rte_flow_action_count``.
 304   * ``rte_flow_query()`` API parameter changed from action type to action structure.
 305
 306
 307 ABI Changes
 308 -----------
 309
 310 .. This section should contain ABI changes. Sample format:
 311
 312    * Add a short 1-2 sentence description of the ABI change that was announced
 313      in the previous releases and made in this release. Use fixed width quotes
 314      for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 315
 316    This section is a comment. Do not overwrite or remove it.
 317    Also, make sure to start the actual text at the margin.
 318    =========================================================
 319
 320 * ring: the alignment constraints on the ring structure has been relaxed
 321   to one cache line instead of two, and an empty cache line padding is
 322   added between the producer and consumer structures. The size of the
 323   structure and the offset of the fields remains the same on platforms
 324   with 64B cache line, but change on other platforms.
 325
 326 * mempool: ops have changed.
 327
 328   A new callback ``calc_mem_size`` has been added to ``rte_mempool_ops``
 329   to allow to customize required memory size calculation.
 330   A new callback ``populate`` has been added to ``rte_mempool_ops``
 331   to allow to customize objects population.
 332   Callback ``get_capabilities`` has been removed from ``rte_mempool_ops``
 333   since its features are covered by ``calc_mem_size`` and ``populate``
 334   callbacks.
 335   Callback ``register_memory_area`` has been removed from ``rte_mempool_ops``
 336   since the new callback ``populate`` may be used instead of it.
 337
 338 * **Additional fields in rte_eth_dev_info.**
 339
 340   The ``rte_eth_dev_info`` structure has had two extra entries appended to the
 341   end of it: ``default_rxportconf`` and ``default_txportconf``. Each of these
 342   in turn are ``rte_eth_dev_portconf`` structures containing three fields of
 343   type ``uint16_t``: ``burst_size``, ``ring_size``, and ``nb_queues``. These
 344   are parameter values recommended for use by the PMD.
 345
 346 * ethdev: ABI for all flow API functions was updated.
 347
 348   This includes functions ``rte_flow_copy``, ``rte_flow_create``,
 349   ``rte_flow_destroy``, ``rte_flow_error_set``, ``rte_flow_flush``,
 350   ``rte_flow_isolate``, ``rte_flow_query`` and ``rte_flow_validate``, due to
 351   changes in error type definitions (``enum rte_flow_error_type``), removal
 352   of the unused DUP action (``enum rte_flow_action_type``), modified
 353   behavior for flow rule actions (see API changes), removal of C99 flexible
 354   array from RAW pattern item (``struct rte_flow_item_raw``), complete
 355   rework of the RSS action definition (``struct rte_flow_action_rss``),
 356   sanity fix in the VLAN pattern item (``struct rte_flow_item_vlan``) and
 357   new transfer attribute (``struct rte_flow_attr``).
 358
 359
 360 Removed Items
 361 -------------
 362
 363 .. This section should contain removed items in this release. Sample format:
 364
 365    * Add a short 1-2 sentence description of the removed item in the past
 366      tense.
 367
 368    This section is a comment. Do not overwrite or remove it.
 369    Also, make sure to start the actual text at the margin.
 370    =========================================================
 371
 372
 373 Known Issues
 374 ------------
 375
 376 .. This section should contain new known issues in this release. Sample format:
 377
 378    * **Add title in present tense with full stop.**
 379
 380      Add a short 1-2 sentence description of the known issue in the present
 381      tense. Add information on any known workarounds.
 382
 383    This section is a comment. Do not overwrite or remove it.
 384    Also, make sure to start the actual text at the margin.
 385    =========================================================
 386
 387 * **pdump is not compatible with old applications.**
 388
 389   As we changed to use generic multi-process communication for pdump negotiation
 390   instead of previous dedicated unix socket way, pdump applications, including
 391   dpdk-pdump example and any other applications using librte_pdump, cannot work
 392   with older version DPDK primary applications.
 393
 394
 395 Shared Library Versions
 396 -----------------------
 397
 398 .. Update any library version updated in this release and prepend with a ``+``
 399    sign, like this:
 400
 401      librte_acl.so.2
 402    + librte_cfgfile.so.2
 403      librte_cmdline.so.2
 404
 405    This section is a comment. Do not overwrite or remove it.
 406    =========================================================
 407
 408
 409 The libraries prepended with a plus sign were incremented in this version.
 410
 411 .. code-block:: diff
 412
 413      librte_acl.so.2
 414      librte_bbdev.so.1
 415      librte_bitratestats.so.2
 416      librte_bus_dpaa.so.1
 417      librte_bus_fslmc.so.1
 418      librte_bus_pci.so.1
 419      librte_bus_vdev.so.1
 420      librte_cfgfile.so.2
 421      librte_cmdline.so.2
 422    + librte_common_octeontx.so.1
 423      librte_cryptodev.so.4
 424      librte_distributor.so.1
 425    + librte_eal.so.7
 426    + librte_ethdev.so.9
 427      librte_eventdev.so.3
 428      librte_flow_classify.so.1
 429      librte_gro.so.1
 430      librte_gso.so.1
 431      librte_hash.so.2
 432      librte_ip_frag.so.1
 433      librte_jobstats.so.1
 434      librte_kni.so.2
 435      librte_kvargs.so.1
 436      librte_latencystats.so.1
 437      librte_lpm.so.2
 438    + librte_mbuf.so.4
 439    + librte_mempool.so.4
 440    + librte_meter.so.2
 441      librte_metrics.so.1
 442      librte_net.so.1
 443      librte_pci.so.1
 444      librte_pdump.so.2
 445      librte_pipeline.so.3
 446      librte_pmd_bnxt.so.2
 447      librte_pmd_bond.so.2
 448      librte_pmd_i40e.so.2
 449      librte_pmd_ixgbe.so.2
 450      librte_pmd_ring.so.2
 451      librte_pmd_softnic.so.1
 452      librte_pmd_vhost.so.2
 453      librte_port.so.3
 454      librte_power.so.1
 455      librte_rawdev.so.1
 456      librte_reorder.so.1
 457    + librte_ring.so.2
 458      librte_sched.so.1
 459      librte_security.so.1
 460      librte_table.so.3
 461      librte_timer.so.1
 462      librte_vhost.so.3
 463
 464
 465 Tested Platforms
 466 ----------------
 467
 468 .. This section should contain a list of platforms that were tested with this
 469    release.
 470
 471    The format is:
 472
 473    * <vendor> platform with <vendor> <type of devices> combinations
 474
 475      * List of CPU
 476      * List of OS
 477      * List of devices
 478      * Other relevant details...
 479
 480    This section is a comment. Do not overwrite or remove it.
 481    Also, make sure to start the actual text at the margin.
 482    =========================================================