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