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