doc/guides/rel_notes/release_18_08.rst

   1 DPDK Release 18.08
   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_08.html
  18
  19
  20 New Features
  21 ------------
  22
  23 .. This section should contain new features added in this release.
  24    Sample 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.
  29      The description should be enough to allow someone scanning
  30      the release notes to understand the new feature.
  31
  32      If the feature adds a lot of sub-features you can use a bullet list
  33      like 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 Flow API support for CXGBE PMD.**
  45
  46   Flow API support has been added to CXGBE Poll Mode Driver to offload
  47   flows to Chelsio T5/T6 NICs.
  48
  49 * **Added ixgbe preferred Rx/Tx parameters.**
  50
  51   Rather than applications providing explicit Rx and Tx parameters such as
  52   queue and burst sizes, they can request that the EAL instead uses preferred
  53   values provided by the PMD, falling back to defaults within the EAL if the
  54   PMD does not provide any. The provision of such tuned values now includes
  55   the ixgbe PMD.
  56
  57 * **Added descriptor status check support for fm10k.**
  58
  59   ``rte_eth_rx_descritpr_status`` and ``rte_eth_tx_descriptor_status``
  60   are supported by fm10K.
  61
  62 * **Updated the enic driver.**
  63
  64   * Add support for mbuf fast free offload.
  65   * Add low cycle count Tx handler for no-offload Tx (except mbuf fast free).
  66   * Add low cycle count Rx handler for non-scattered Rx.
  67   * Minor performance improvements to scattered Rx handler.
  68   * Add handlers to add/delete VxLAN port number.
  69   * Add devarg to specify ingress VLAN rewrite mode.
  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.
  78      Use fixed width quotes for ``function_names`` or ``struct_names``.
  79      Use the past 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 * cryptodev: In struct ``struct rte_cryptodev_info``, field ``rte_pci_device *pci_dev``
  86   has been replaced with field ``struct rte_device *device``.
  87   Value 0 is accepted in ``sym.max_nb_sessions``, meaning that a device
  88   supports an unlimited number of sessions.
  89
  90 * cryptodev: Following functions were deprecated and are removed in 18.08:
  91
  92   - ``rte_cryptodev_queue_pair_start``
  93   - ``rte_cryptodev_queue_pair_stop``
  94
  95 * cryptodev: Following functions were deprecated and are replaced by
  96   other functions in 18.08:
  97
  98   - ``rte_cryptodev_get_header_session_size`` is replaced with
  99     ``rte_cryptodev_sym_get_header_session_size``
 100   - ``rte_cryptodev_get_private_session_size`` is replaced with
 101     ``rte_cryptodev_sym_get_private_session_size``
 102
 103 * compressdev: Feature flag ``RTE_COMP_FF_MBUF_SCATTER_GATHER`` is
 104   replaced with the following more explicit flags:
 105   - ``RTE_COMP_FF_OOP_SGL_IN_SGL_OUT``
 106   - ``RTE_COMP_FF_OOP_SGL_IN_LB_OUT``
 107   - ``RTE_COMP_FF_OOP_LB_IN_SGL_OUT``
 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
 116      that was announced in the previous releases and made in this release.
 117      Use fixed width quotes for ``function_names`` or ``struct_names``.
 118      Use the past tense.
 119
 120    This section is a comment. Do not overwrite or remove it.
 121    Also, make sure to start the actual text at the margin.
 122    =========================================================
 123
 124
 125 Removed Items
 126 -------------
 127
 128 .. This section should contain removed items in this release. Sample format:
 129
 130    * Add a short 1-2 sentence description of the removed item
 131      in the past tense.
 132
 133    This section is a comment. Do not overwrite or remove it.
 134    Also, make sure to start the actual text at the margin.
 135    =========================================================
 136
 137
 138 Shared Library Versions
 139 -----------------------
 140
 141 .. Update any library version updated in this release
 142    and prepend with a ``+`` sign, like this:
 143
 144      librte_acl.so.2
 145    + librte_cfgfile.so.2
 146      librte_cmdline.so.2
 147
 148    This section is a comment. Do not overwrite or remove it.
 149    =========================================================
 150
 151 The libraries prepended with a plus sign were incremented in this version.
 152
 153 .. code-block:: diff
 154
 155      librte_acl.so.2
 156      librte_bbdev.so.1
 157      librte_bitratestats.so.2
 158      librte_bpf.so.1
 159      librte_bus_dpaa.so.1
 160      librte_bus_fslmc.so.1
 161      librte_bus_pci.so.1
 162      librte_bus_vdev.so.1
 163      librte_cfgfile.so.2
 164      librte_cmdline.so.2
 165      librte_common_octeontx.so.1
 166      librte_compressdev.so.1
 167    + librte_cryptodev.so.5
 168      librte_distributor.so.1
 169      librte_eal.so.7
 170      librte_ethdev.so.9
 171      librte_eventdev.so.4
 172      librte_flow_classify.so.1
 173      librte_gro.so.1
 174      librte_gso.so.1
 175      librte_hash.so.2
 176      librte_ip_frag.so.1
 177      librte_jobstats.so.1
 178      librte_kni.so.2
 179      librte_kvargs.so.1
 180      librte_latencystats.so.1
 181      librte_lpm.so.2
 182      librte_mbuf.so.4
 183      librte_mempool.so.4
 184      librte_meter.so.2
 185      librte_metrics.so.1
 186      librte_net.so.1
 187      librte_pci.so.1
 188      librte_pdump.so.2
 189      librte_pipeline.so.3
 190      librte_pmd_bnxt.so.2
 191      librte_pmd_bond.so.2
 192      librte_pmd_i40e.so.2
 193      librte_pmd_ixgbe.so.2
 194      librte_pmd_dpaa2_cmdif.so.1
 195      librte_pmd_dpaa2_qdma.so.1
 196      librte_pmd_ring.so.2
 197      librte_pmd_softnic.so.1
 198      librte_pmd_vhost.so.2
 199      librte_port.so.3
 200      librte_power.so.1
 201      librte_rawdev.so.1
 202      librte_reorder.so.1
 203      librte_ring.so.2
 204      librte_sched.so.1
 205      librte_security.so.1
 206      librte_table.so.3
 207      librte_timer.so.1
 208      librte_vhost.so.3
 209
 210
 211 Known Issues
 212 ------------
 213
 214 .. This section should contain new known issues in this release. Sample format:
 215
 216    * **Add title in present tense with full stop.**
 217
 218      Add a short 1-2 sentence description of the known issue
 219      in the present tense. Add information on any known workarounds.
 220
 221    This section is a comment. Do not overwrite or remove it.
 222    Also, make sure to start the actual text at the margin.
 223    =========================================================
 224
 225
 226 Tested Platforms
 227 ----------------
 228
 229 .. This section should contain a list of platforms that were tested
 230    with this release.
 231
 232    The format is:
 233
 234    * <vendor> platform with <vendor> <type of devices> combinations
 235
 236      * List of CPU
 237      * List of OS
 238      * List of devices
 239      * Other relevant details...
 240
 241    This section is a comment. Do not overwrite or remove it.
 242    Also, make sure to start the actual text at the margin.
 243    =========================================================