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
  51 * **Added PMD-recommended Tx and Rx parameters**
  52
  53   Applications can now query drivers for device-tuned values of
  54   ring sizes, burst sizes, and number of queues.
  55
  56 * **Added RSS hash and key update to CXGBE PMD.**
  57
  58   Support to update RSS hash and key has been added to CXGBE PMD.
  59
  60 * **Added CXGBE VF PMD.**
  61
  62   CXGBE VF Poll Mode Driver has been added to run DPDK over Chelsio
  63   T5/T6 NIC VF instances.
  64
  65 * **Updated Solarflare network PMD.**
  66
  67   Updated the sfc_efx driver including the following changes:
  68
  69   * Added support for Solarflare XtremeScale X2xxx family adapters.
  70   * Added support for NVGRE, VXLAN and GENEVE filters in flow API.
  71   * Added support for DROP action in flow API.
  72
  73 * **Added Ethernet poll mode driver for AMD XGBE devices.**
  74
  75   Added the new ``axgbe`` ethernet poll mode driver for AMD XGBE devices.
  76   See the :doc:`../nics/axgbe` nic driver guide for more details on this
  77   new driver.
  78
  79 * **Updated szedata2 PMD.**
  80
  81   Added support for new NFB-200G2QL card.
  82
  83 * **Added support for Broadcom NetXtreme-S (BCM58800) family of controllers (aka Stingray)**
  84
  85   The BCM58800 devices feature a NetXtreme E-Series advanced network controller, a high-performance
  86   ARM CPU block, PCI Express (PCIe) Gen3 interfaces, key accelerators for compute offload and a high-
  87   speed memory subsystem including L3 cache and DDR4 interfaces, all interconnected by a coherent
  88   Network-on-chip (NOC) fabric.
  89
  90   The ARM CPU subsystem features eight ARMv8 Cortex-A72 CPUs at 3.0 GHz, arranged in a multi-cluster
  91   configuration.
  92
  93 * **Added support for virtio-user server mode.**
  94   In a container environment if the vhost-user backend restarts, there's no way
  95   for it to reconnect to virtio-user. To address this, support for server mode
  96   is added. In this mode the socket file is created by virtio-user, which the
  97   backend connects to. This means that if the backend restarts, it can reconnect
  98   to virtio-user and continue communications.
  99
 100 * **Added crypto workload support to vhost library.**
 101
 102   New APIs are introduced in vhost library to enable virtio crypto support
 103   including session creation/deletion handling and translating virtio-crypto
 104   request into DPDK crypto operations. A sample application is also introduced.
 105
 106 * **Added virtio crypto PMD.**
 107
 108   Added a new poll mode driver for virtio crypto devices, which provides
 109   AES-CBC ciphering and AES-CBC with HMAC-SHA1 algorithm-chaining. See the
 110   :doc:`../cryptodevs/virtio` crypto driver guide for more details on
 111   this new driver.
 112
 113 * **Added AMD CCP Crypto PMD.**
 114
 115   Added the new ``ccp`` crypto driver for AMD CCP devices. See the
 116   :doc:`../cryptodevs/ccp` crypto driver guide for more details on
 117   this new driver.
 118
 119 * **Updated AESNI MB PMD.**
 120
 121   The AESNI MB PMD has been updated with additional support for:
 122
 123   * AES-CMAC (128-bit key).
 124
 125 * **Added the Event Timer Adapter Library.**
 126
 127   The Event Timer Adapter Library extends the event-based model by introducing
 128   APIs that allow applications to arm/cancel event timers that generate
 129   timer expiry events. This new type of event is scheduled by an event device
 130   along with existing types of events.
 131
 132 * **Added device event monitor framework.**
 133
 134   Added a general device event monitor framework at EAL, for device dynamic management.
 135   Such as device hotplug awareness and actions adopted accordingly. The list of new APIs:
 136
 137   * ``rte_dev_event_monitor_start`` and ``rte_dev_event_monitor_stop`` are for
 138     the event monitor enable and disable.
 139   * ``rte_dev_event_callback_register`` and ``rte_dev_event_callback_unregister``
 140     are for the user's callbacks register and unregister.
 141
 142   Linux uevent is supported as backend of this device event notification framework.
 143
 144 * **Added support for procinfo and pdump on eth vdev.**
 145
 146   For ethernet virtual devices (like tap, pcap, etc), with this feature, we can get
 147   stats/xstats on shared memory from secondary process, and also pdump packets on
 148   those virtual devices.
 149
 150
 151 API Changes
 152 -----------
 153
 154 .. This section should contain API changes. Sample format:
 155
 156    * Add a short 1-2 sentence description of the API change. Use fixed width
 157      quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past
 158      tense.
 159
 160    This section is a comment. Do not overwrite or remove it.
 161    Also, make sure to start the actual text at the margin.
 162    =========================================================
 163
 164 * service cores: no longer marked as experimental.
 165
 166   The service cores functions are no longer marked as experimental, and have
 167   become part of the normal DPDK API and ABI. Any future ABI changes will be
 168   announced at least one release before the ABI change is made. There are no
 169   ABI breaking changes planned.
 170
 171 * eal: ``rte_lcore_has_role()`` return value changed.
 172
 173   This function now returns true or false, respectively,
 174   rather than 0 or <0 for success or failure.
 175   It makes use of the function more intuitive.
 176
 177 * mempool: capability flags and related functions have been removed.
 178
 179   Flags ``MEMPOOL_F_CAPA_PHYS_CONTIG`` and
 180   ``MEMPOOL_F_CAPA_BLK_ALIGNED_OBJECTS`` were used by octeontx mempool
 181   driver to customize generic mempool library behaviour.
 182   Now the new driver callbacks ``calc_mem_size`` and ``populate`` may be
 183   used to achieve it without specific knowledge in the generic code.
 184
 185 * mempool: xmem functions have been deprecated:
 186
 187   - ``rte_mempool_xmem_create``
 188   - ``rte_mempool_xmem_size``
 189   - ``rte_mempool_xmem_usage``
 190   - ``rte_mempool_populate_iova_tab``
 191
 192 * mbuf: The control mbuf API has been removed in v18.05. The impacted
 193   functions and macros are:
 194
 195   - ``rte_ctrlmbuf_init()``
 196   - ``rte_ctrlmbuf_alloc()``
 197   - ``rte_ctrlmbuf_free()``
 198   - ``rte_ctrlmbuf_data()``
 199   - ``rte_ctrlmbuf_len()``
 200   - ``rte_is_ctrlmbuf()``
 201   - ``CTRL_MBUF_FLAG``
 202
 203   The packet mbuf API should be used as a replacement.
 204
 205 * meter: updated to accommodate configuration profiles.
 206
 207   The meter API is changed to support meter configuration profiles. The
 208   configuration profile represents the set of configuration parameters
 209   for a given meter object, such as the rates and sizes for the token
 210   buckets. These configuration parameters were previously the part of meter
 211   object internal data strcuture. The separation of the configuration
 212   parameters from meter object data structure results in reducing its
 213   memory footprint which helps in better cache utilization when large number
 214   of meter objects are used.
 215
 216 * ethdev: The function ``rte_eth_dev_count``, often mis-used to iterate
 217   over ports, is deprecated and replaced by ``rte_eth_dev_count_avail``.
 218   There is also a new function ``rte_eth_dev_count_total`` to get the
 219   total number of allocated ports, available or not.
 220   The hotplug-proof applications should use ``RTE_ETH_FOREACH_DEV`` or
 221   ``RTE_ETH_FOREACH_DEV_OWNED_BY`` as port iterators.
 222
 223 * ethdev, in struct ``struct rte_eth_dev_info``, field ``rte_pci_device *pci_dev``
 224   replaced with field ``struct rte_device *device``.
 225
 226 * **Changes to semantics of rte_eth_dev_configure() parameters.**
 227
 228    If both the ``nb_rx_q`` and ``nb_tx_q`` parameters are zero,
 229    ``rte_eth_dev_configure`` will now use PMD-recommended queue sizes, or if
 230    recommendations are not provided by the PMD the function will use ethdev
 231    fall-back values. Previously setting both of the parameters to zero would
 232    have resulted in ``-EINVAL`` being returned.
 233
 234 * **Changes to semantics of rte_eth_rx_queue_setup() parameters.**
 235
 236    If the ``nb_rx_desc`` parameter is zero, ``rte_eth_rx_queue_setup`` will
 237    now use the PMD-recommended Rx ring size, or in the case where the PMD
 238    does not provide a recommendation, will use an ethdev-provided
 239    fall-back value. Previously, setting ``nb_rx_desc`` to zero would have
 240    resulted in an error.
 241
 242 * **Changes to semantics of rte_eth_tx_queue_setup() parameters.**
 243
 244    If the ``nb_tx_desc`` parameter is zero, ``rte_eth_tx_queue_setup`` will
 245    now use the PMD-recommended Tx ring size, or in the case where the PMD
 246    does not provide a recoomendation, will use an ethdev-provided
 247    fall-back value. Previously, setting ``nb_tx_desc`` to zero would have
 248    resulted in an error.
 249
 250
 251 ABI Changes
 252 -----------
 253
 254 .. This section should contain ABI changes. Sample format:
 255
 256    * Add a short 1-2 sentence description of the ABI change that was announced
 257      in the previous releases and made in this release. Use fixed width quotes
 258      for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 259
 260    This section is a comment. Do not overwrite or remove it.
 261    Also, make sure to start the actual text at the margin.
 262    =========================================================
 263
 264 * ring: the alignment constraints on the ring structure has been relaxed
 265   to one cache line instead of two, and an empty cache line padding is
 266   added between the producer and consumer structures. The size of the
 267   structure and the offset of the fields remains the same on platforms
 268   with 64B cache line, but change on other platforms.
 269
 270 * mempool: ops have changed.
 271
 272   A new callback ``calc_mem_size`` has been added to ``rte_mempool_ops``
 273   to allow to customize required memory size calculation.
 274   A new callback ``populate`` has been added to ``rte_mempool_ops``
 275   to allow to customize objects population.
 276   Callback ``get_capabilities`` has been removed from ``rte_mempool_ops``
 277   since its features are covered by ``calc_mem_size`` and ``populate``
 278   callbacks.
 279   Callback ``register_memory_area`` has been removed from ``rte_mempool_ops``
 280   since the new callback ``populate`` may be used instead of it.
 281
 282 * **Additional fields in rte_eth_dev_info.**
 283
 284   The ``rte_eth_dev_info`` structure has had two extra entries appended to the
 285   end of it: ``default_rxportconf`` and ``default_txportconf``. Each of these
 286   in turn are ``rte_eth_dev_portconf`` structures containing three fields of
 287   type ``uint16_t``: ``burst_size``, ``ring_size``, and ``nb_queues``. These
 288   are parameter values recommended for use by the PMD.
 289
 290
 291 Removed Items
 292 -------------
 293
 294 .. This section should contain removed items in this release. Sample format:
 295
 296    * Add a short 1-2 sentence description of the removed item in the past
 297      tense.
 298
 299    This section is a comment. Do not overwrite or remove it.
 300    Also, make sure to start the actual text at the margin.
 301    =========================================================
 302
 303
 304 Known Issues
 305 ------------
 306
 307 .. This section should contain new known issues in this release. Sample format:
 308
 309    * **Add title in present tense with full stop.**
 310
 311      Add a short 1-2 sentence description of the known issue in the present
 312      tense. Add information on any known workarounds.
 313
 314    This section is a comment. Do not overwrite or remove it.
 315    Also, make sure to start the actual text at the margin.
 316    =========================================================
 317
 318 * **pdump is not compatible with old applications.**
 319
 320   As we changed to use generic multi-process communication for pdump negotiation
 321   instead of previous dedicated unix socket way, pdump applications, including
 322   dpdk-pdump example and any other applications using librte_pdump, cannot work
 323   with older version DPDK primary applications.
 324
 325
 326 Shared Library Versions
 327 -----------------------
 328
 329 .. Update any library version updated in this release and prepend with a ``+``
 330    sign, like this:
 331
 332      librte_acl.so.2
 333    + librte_cfgfile.so.2
 334      librte_cmdline.so.2
 335
 336    This section is a comment. Do not overwrite or remove it.
 337    =========================================================
 338
 339
 340 The libraries prepended with a plus sign were incremented in this version.
 341
 342 .. code-block:: diff
 343
 344      librte_acl.so.2
 345      librte_bbdev.so.1
 346      librte_bitratestats.so.2
 347      librte_bus_dpaa.so.1
 348      librte_bus_fslmc.so.1
 349      librte_bus_pci.so.1
 350      librte_bus_vdev.so.1
 351      librte_cfgfile.so.2
 352      librte_cmdline.so.2
 353    + librte_common_octeontx.so.1
 354      librte_cryptodev.so.4
 355      librte_distributor.so.1
 356    + librte_eal.so.7
 357    + librte_ethdev.so.9
 358      librte_eventdev.so.3
 359      librte_flow_classify.so.1
 360      librte_gro.so.1
 361      librte_gso.so.1
 362      librte_hash.so.2
 363      librte_ip_frag.so.1
 364      librte_jobstats.so.1
 365      librte_kni.so.2
 366      librte_kvargs.so.1
 367      librte_latencystats.so.1
 368      librte_lpm.so.2
 369    + librte_mbuf.so.4
 370    + librte_mempool.so.4
 371    + librte_meter.so.2
 372      librte_metrics.so.1
 373      librte_net.so.1
 374      librte_pci.so.1
 375      librte_pdump.so.2
 376      librte_pipeline.so.3
 377      librte_pmd_bnxt.so.2
 378      librte_pmd_bond.so.2
 379      librte_pmd_i40e.so.2
 380      librte_pmd_ixgbe.so.2
 381      librte_pmd_ring.so.2
 382      librte_pmd_softnic.so.1
 383      librte_pmd_vhost.so.2
 384      librte_port.so.3
 385      librte_power.so.1
 386      librte_rawdev.so.1
 387      librte_reorder.so.1
 388    + librte_ring.so.2
 389      librte_sched.so.1
 390      librte_security.so.1
 391      librte_table.so.3
 392      librte_timer.so.1
 393      librte_vhost.so.3
 394
 395
 396 Tested Platforms
 397 ----------------
 398
 399 .. This section should contain a list of platforms that were tested with this
 400    release.
 401
 402    The format is:
 403
 404    * <vendor> platform with <vendor> <type of devices> combinations
 405
 406      * List of CPU
 407      * List of OS
 408      * List of devices
 409      * Other relevant details...
 410
 411    This section is a comment. Do not overwrite or remove it.
 412    Also, make sure to start the actual text at the margin.
 413    =========================================================