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 RSS hash and key update to CXGBE PMD.**
  45
  46   Support to update RSS hash and key has been added to CXGBE PMD.
  47
  48 * **Added CXGBE VF PMD.**
  49
  50   CXGBE VF Poll Mode Driver has been added to run DPDK over Chelsio
  51   T5/T6 NIC VF instances.
  52
  53 * **Updated Solarflare network PMD.**
  54
  55   Updated the sfc_efx driver including the following changes:
  56
  57   * Added support for Solarflare XtremeScale X2xxx family adapters.
  58   * Added support for NVGRE, VXLAN and GENEVE filters in flow API.
  59   * Added support for DROP action in flow API.
  60
  61 * **Added device event monitor framework.**
  62
  63   Added a general device event monitor framework at EAL, for device dynamic management.
  64   Such as device hotplug awareness and actions adopted accordingly. The list of new APIs:
  65
  66   * ``rte_dev_event_monitor_start`` and ``rte_dev_event_monitor_stop`` are for
  67     the event monitor enable and disable.
  68   * ``rte_dev_event_callback_register`` and ``rte_dev_event_callback_unregister``
  69     are for the user's callbacks register and unregister.
  70
  71
  72 API Changes
  73 -----------
  74
  75 .. This section should contain API changes. Sample format:
  76
  77    * Add a short 1-2 sentence description of the API change. Use fixed width
  78      quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past
  79      tense.
  80
  81    This section is a comment. Do not overwrite or remove it.
  82    Also, make sure to start the actual text at the margin.
  83    =========================================================
  84
  85 * mbuf: The control mbuf API has been removed in v18.05. The impacted
  86   functions and macros are:
  87
  88   - ``rte_ctrlmbuf_init()``
  89   - ``rte_ctrlmbuf_alloc()``
  90   - ``rte_ctrlmbuf_free()``
  91   - ``rte_ctrlmbuf_data()``
  92   - ``rte_ctrlmbuf_len()``
  93   - ``rte_is_ctrlmbuf()``
  94   - ``CTRL_MBUF_FLAG``
  95
  96   The packet mbuf API should be used as a replacement.
  97
  98 * meter: updated to accommodate configuration profiles.
  99
 100   The meter API is changed to support meter configuration profiles. The
 101   configuration profile represents the set of configuration parameters
 102   for a given meter object, such as the rates and sizes for the token
 103   buckets. These configuration parameters were previously the part of meter
 104   object internal data strcuture. The separation of the configuration
 105   parameters from meter object data structure results in reducing its
 106   memory footprint which helps in better cache utilization when large number
 107   of meter objects are used.
 108
 109
 110 ABI Changes
 111 -----------
 112
 113 .. This section should contain ABI changes. Sample format:
 114
 115    * Add a short 1-2 sentence description of the ABI change that was announced
 116      in the previous releases and made in this release. Use fixed width quotes
 117      for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 118
 119    This section is a comment. Do not overwrite or remove it.
 120    Also, make sure to start the actual text at the margin.
 121    =========================================================
 122
 123
 124 Removed Items
 125 -------------
 126
 127 .. This section should contain removed items in this release. Sample format:
 128
 129    * Add a short 1-2 sentence description of the removed item in the past
 130      tense.
 131
 132    This section is a comment. Do not overwrite or remove it.
 133    Also, make sure to start the actual text at the margin.
 134    =========================================================
 135
 136
 137 Known Issues
 138 ------------
 139
 140 .. This section should contain new known issues in this release. Sample format:
 141
 142    * **Add title in present tense with full stop.**
 143
 144      Add a short 1-2 sentence description of the known issue in the present
 145      tense. Add information on any known workarounds.
 146
 147    This section is a comment. Do not overwrite or remove it.
 148    Also, make sure to start the actual text at the margin.
 149    =========================================================
 150
 151
 152 Shared Library Versions
 153 -----------------------
 154
 155 .. Update any library version updated in this release and prepend with a ``+``
 156    sign, like this:
 157
 158      librte_acl.so.2
 159    + librte_cfgfile.so.2
 160      librte_cmdline.so.2
 161
 162    This section is a comment. Do not overwrite or remove it.
 163    =========================================================
 164
 165
 166 The libraries prepended with a plus sign were incremented in this version.
 167
 168 .. code-block:: diff
 169
 170      librte_acl.so.2
 171      librte_bbdev.so.1
 172      librte_bitratestats.so.2
 173      librte_bus_dpaa.so.1
 174      librte_bus_fslmc.so.1
 175      librte_bus_pci.so.1
 176      librte_bus_vdev.so.1
 177      librte_cfgfile.so.2
 178      librte_cmdline.so.2
 179    + librte_common_octeontx.so.1
 180      librte_cryptodev.so.4
 181      librte_distributor.so.1
 182    + librte_eal.so.7
 183    + librte_ethdev.so.9
 184      librte_eventdev.so.3
 185      librte_flow_classify.so.1
 186      librte_gro.so.1
 187      librte_gso.so.1
 188      librte_hash.so.2
 189      librte_ip_frag.so.1
 190      librte_jobstats.so.1
 191      librte_kni.so.2
 192      librte_kvargs.so.1
 193      librte_latencystats.so.1
 194      librte_lpm.so.2
 195    + librte_mbuf.so.4
 196      librte_mempool.so.3
 197    + librte_meter.so.2
 198      librte_metrics.so.1
 199      librte_net.so.1
 200      librte_pci.so.1
 201      librte_pdump.so.2
 202      librte_pipeline.so.3
 203      librte_pmd_bnxt.so.2
 204      librte_pmd_bond.so.2
 205      librte_pmd_i40e.so.2
 206      librte_pmd_ixgbe.so.2
 207      librte_pmd_ring.so.2
 208      librte_pmd_softnic.so.1
 209      librte_pmd_vhost.so.2
 210      librte_port.so.3
 211      librte_power.so.1
 212      librte_rawdev.so.1
 213      librte_reorder.so.1
 214      librte_ring.so.1
 215      librte_sched.so.1
 216      librte_security.so.1
 217      librte_table.so.3
 218      librte_timer.so.1
 219      librte_vhost.so.3
 220
 221
 222 Tested Platforms
 223 ----------------
 224
 225 .. This section should contain a list of platforms that were tested with this
 226    release.
 227
 228    The format is:
 229
 230    * <vendor> platform with <vendor> <type of devices> combinations
 231
 232      * List of CPU
 233      * List of OS
 234      * List of devices
 235      * Other relevant details...
 236
 237    This section is a comment. Do not overwrite or remove it.
 238    Also, make sure to start the actual text at the margin.
 239    =========================================================