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 virtio-user server mode.**
  77   In a container environment if the vhost-user backend restarts, there's no way
  78   for it to reconnect to virtio-user. To address this, support for server mode
  79   is added. In this mode the socket file is created by virtio-user, which the
  80   backend connects to. This means that if the backend restarts, it can reconnect
  81   to virtio-user and continue communications.
  82
  83 * **Added crypto workload support to vhost library.**
  84
  85   New APIs are introduced in vhost library to enable virtio crypto support
  86   including session creation/deletion handling and translating virtio-crypto
  87   request into DPDK crypto operations. A sample application is also introduced.
  88
  89 * **Added device event monitor framework.**
  90
  91   Added a general device event monitor framework at EAL, for device dynamic management.
  92   Such as device hotplug awareness and actions adopted accordingly. The list of new APIs:
  93
  94   * ``rte_dev_event_monitor_start`` and ``rte_dev_event_monitor_stop`` are for
  95     the event monitor enable and disable.
  96   * ``rte_dev_event_callback_register`` and ``rte_dev_event_callback_unregister``
  97     are for the user's callbacks register and unregister.
  98
  99   Linux uevent is supported as backend of this device event notification framework.
 100
 101
 102 API Changes
 103 -----------
 104
 105 .. This section should contain API changes. Sample format:
 106
 107    * Add a short 1-2 sentence description of the API change. Use fixed width
 108      quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past
 109      tense.
 110
 111    This section is a comment. Do not overwrite or remove it.
 112    Also, make sure to start the actual text at the margin.
 113    =========================================================
 114
 115 * mbuf: The control mbuf API has been removed in v18.05. The impacted
 116   functions and macros are:
 117
 118   - ``rte_ctrlmbuf_init()``
 119   - ``rte_ctrlmbuf_alloc()``
 120   - ``rte_ctrlmbuf_free()``
 121   - ``rte_ctrlmbuf_data()``
 122   - ``rte_ctrlmbuf_len()``
 123   - ``rte_is_ctrlmbuf()``
 124   - ``CTRL_MBUF_FLAG``
 125
 126   The packet mbuf API should be used as a replacement.
 127
 128 * meter: updated to accommodate configuration profiles.
 129
 130   The meter API is changed to support meter configuration profiles. The
 131   configuration profile represents the set of configuration parameters
 132   for a given meter object, such as the rates and sizes for the token
 133   buckets. These configuration parameters were previously the part of meter
 134   object internal data strcuture. The separation of the configuration
 135   parameters from meter object data structure results in reducing its
 136   memory footprint which helps in better cache utilization when large number
 137   of meter objects are used.
 138
 139 * ethdev, in struct ``struct rte_eth_dev_info``, field ``rte_pci_device *pci_dev``
 140   replaced with field ``struct rte_device *device``.
 141
 142 * **Changes to semantics of rte_eth_dev_configure() parameters.**
 143
 144    If both the ``nb_rx_q`` and ``nb_tx_q`` parameters are zero,
 145    ``rte_eth_dev_configure`` will now use PMD-recommended queue sizes, or if
 146    recommendations are not provided by the PMD the function will use ethdev
 147    fall-back values. Previously setting both of the parameters to zero would
 148    have resulted in ``-EINVAL`` being returned.
 149
 150 * **Changes to semantics of rte_eth_rx_queue_setup() parameters.**
 151
 152    If the ``nb_rx_desc`` parameter is zero, ``rte_eth_rx_queue_setup`` will
 153    now use the PMD-recommended Rx ring size, or in the case where the PMD
 154    does not provide a recommendation, will use an ethdev-provided
 155    fall-back value. Previously, setting ``nb_rx_desc`` to zero would have
 156    resulted in an error.
 157
 158 * **Changes to semantics of rte_eth_tx_queue_setup() parameters.**
 159
 160    If the ``nb_tx_desc`` parameter is zero, ``rte_eth_tx_queue_setup`` will
 161    now use the PMD-recommended Tx ring size, or in the case where the PMD
 162    does not provide a recoomendation, will use an ethdev-provided
 163    fall-back value. Previously, setting ``nb_tx_desc`` to zero would have
 164    resulted in an error.
 165
 166
 167 ABI Changes
 168 -----------
 169
 170 .. This section should contain ABI changes. Sample format:
 171
 172    * Add a short 1-2 sentence description of the ABI change that was announced
 173      in the previous releases and made in this release. Use fixed width quotes
 174      for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 175
 176    This section is a comment. Do not overwrite or remove it.
 177    Also, make sure to start the actual text at the margin.
 178    =========================================================
 179
 180 * **Additional fields in rte_eth_dev_info.**
 181
 182   The ``rte_eth_dev_info`` structure has had two extra entries appended to the
 183   end of it: ``default_rxportconf`` and ``default_txportconf``. Each of these
 184   in turn are ``rte_eth_dev_portconf`` structures containing three fields of
 185   type ``uint16_t``: ``burst_size``, ``ring_size``, and ``nb_queues``. These
 186   are parameter values recommended for use by the PMD.
 187
 188 Removed Items
 189 -------------
 190
 191 .. This section should contain removed items in this release. Sample format:
 192
 193    * Add a short 1-2 sentence description of the removed item in the past
 194      tense.
 195
 196    This section is a comment. Do not overwrite or remove it.
 197    Also, make sure to start the actual text at the margin.
 198    =========================================================
 199
 200
 201 Known Issues
 202 ------------
 203
 204 .. This section should contain new known issues in this release. Sample format:
 205
 206    * **Add title in present tense with full stop.**
 207
 208      Add a short 1-2 sentence description of the known issue in the present
 209      tense. Add information on any known workarounds.
 210
 211    This section is a comment. Do not overwrite or remove it.
 212    Also, make sure to start the actual text at the margin.
 213    =========================================================
 214
 215
 216 Shared Library Versions
 217 -----------------------
 218
 219 .. Update any library version updated in this release and prepend with a ``+``
 220    sign, like this:
 221
 222      librte_acl.so.2
 223    + librte_cfgfile.so.2
 224      librte_cmdline.so.2
 225
 226    This section is a comment. Do not overwrite or remove it.
 227    =========================================================
 228
 229
 230 The libraries prepended with a plus sign were incremented in this version.
 231
 232 .. code-block:: diff
 233
 234      librte_acl.so.2
 235      librte_bbdev.so.1
 236      librte_bitratestats.so.2
 237      librte_bus_dpaa.so.1
 238      librte_bus_fslmc.so.1
 239      librte_bus_pci.so.1
 240      librte_bus_vdev.so.1
 241      librte_cfgfile.so.2
 242      librte_cmdline.so.2
 243    + librte_common_octeontx.so.1
 244      librte_cryptodev.so.4
 245      librte_distributor.so.1
 246    + librte_eal.so.7
 247    + librte_ethdev.so.9
 248      librte_eventdev.so.3
 249      librte_flow_classify.so.1
 250      librte_gro.so.1
 251      librte_gso.so.1
 252      librte_hash.so.2
 253      librte_ip_frag.so.1
 254      librte_jobstats.so.1
 255      librte_kni.so.2
 256      librte_kvargs.so.1
 257      librte_latencystats.so.1
 258      librte_lpm.so.2
 259    + librte_mbuf.so.4
 260      librte_mempool.so.3
 261    + librte_meter.so.2
 262      librte_metrics.so.1
 263      librte_net.so.1
 264      librte_pci.so.1
 265      librte_pdump.so.2
 266      librte_pipeline.so.3
 267      librte_pmd_bnxt.so.2
 268      librte_pmd_bond.so.2
 269      librte_pmd_i40e.so.2
 270      librte_pmd_ixgbe.so.2
 271      librte_pmd_ring.so.2
 272      librte_pmd_softnic.so.1
 273      librte_pmd_vhost.so.2
 274      librte_port.so.3
 275      librte_power.so.1
 276      librte_rawdev.so.1
 277      librte_reorder.so.1
 278      librte_ring.so.1
 279      librte_sched.so.1
 280      librte_security.so.1
 281      librte_table.so.3
 282      librte_timer.so.1
 283      librte_vhost.so.3
 284
 285
 286 Tested Platforms
 287 ----------------
 288
 289 .. This section should contain a list of platforms that were tested with this
 290    release.
 291
 292    The format is:
 293
 294    * <vendor> platform with <vendor> <type of devices> combinations
 295
 296      * List of CPU
 297      * List of OS
 298      * List of devices
 299      * Other relevant details...
 300
 301    This section is a comment. Do not overwrite or remove it.
 302    Also, make sure to start the actual text at the margin.
 303    =========================================================