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