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