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   - ``rte_cryptodev_queue_pair_attach_sym_session``
  95   - ``rte_cryptodev_queue_pair_detach_sym_session``
  96
  97 * cryptodev: Following functions were deprecated and are replaced by
  98   other functions in 18.08:
  99
 100   - ``rte_cryptodev_get_header_session_size`` is replaced with
 101     ``rte_cryptodev_sym_get_header_session_size``
 102   - ``rte_cryptodev_get_private_session_size`` is replaced with
 103     ``rte_cryptodev_sym_get_private_session_size``
 104
 105 * cryptodev: Feature flag ``RTE_CRYPTODEV_FF_MBUF_SCATTER_GATHER`` is
 106   replaced with the following more explicit flags:
 107   - ``RTE_CRYPTODEV_FF_IN_PLACE_SGL``
 108   - ``RTE_CRYPTODEV_FF_OOP_SGL_IN_SGL_OUT``
 109   - ``RTE_CRYPTODEV_FF_OOP_SGL_IN_LB_OUT``
 110   - ``RTE_CRYPTODEV_FF_OOP_LB_IN_SGL_OUT``
 111   - ``RTE_CRYPTODEV_FF_OOP_LB_IN_LB_OUT``
 112
 113 * cryptodev: Renamed cryptodev experimental APIs:
 114
 115   Used user_data instead of private_data in following APIs to avoid confusion
 116   with the existing session parameter ``sess_private_data[]`` and related APIs.
 117   ``rte_cryptodev_sym_session_set_private_data()`` changed to
 118   ``rte_cryptodev_sym_session_set_user_data()``
 119   ``rte_cryptodev_sym_session_get_private_data()`` changed to
 120   ``rte_cryptodev_sym_session_get_user_data()``
 121
 122 * compressdev: Feature flag ``RTE_COMP_FF_MBUF_SCATTER_GATHER`` is
 123   replaced with the following more explicit flags:
 124   - ``RTE_COMP_FF_OOP_SGL_IN_SGL_OUT``
 125   - ``RTE_COMP_FF_OOP_SGL_IN_LB_OUT``
 126   - ``RTE_COMP_FF_OOP_LB_IN_SGL_OUT``
 127
 128
 129 ABI Changes
 130 -----------
 131
 132 .. This section should contain ABI changes. Sample format:
 133
 134    * Add a short 1-2 sentence description of the ABI change
 135      that was announced in the previous releases and made in this release.
 136      Use fixed width quotes for ``function_names`` or ``struct_names``.
 137      Use the past tense.
 138
 139    This section is a comment. Do not overwrite or remove it.
 140    Also, make sure to start the actual text at the margin.
 141    =========================================================
 142
 143
 144 Removed Items
 145 -------------
 146
 147 .. This section should contain removed items in this release. Sample format:
 148
 149    * Add a short 1-2 sentence description of the removed item
 150      in the past tense.
 151
 152    This section is a comment. Do not overwrite or remove it.
 153    Also, make sure to start the actual text at the margin.
 154    =========================================================
 155
 156
 157 Shared Library Versions
 158 -----------------------
 159
 160 .. Update any library version updated in this release
 161    and prepend with a ``+`` sign, like this:
 162
 163      librte_acl.so.2
 164    + librte_cfgfile.so.2
 165      librte_cmdline.so.2
 166
 167    This section is a comment. Do not overwrite or remove it.
 168    =========================================================
 169
 170 The libraries prepended with a plus sign were incremented in this version.
 171
 172 .. code-block:: diff
 173
 174      librte_acl.so.2
 175      librte_bbdev.so.1
 176      librte_bitratestats.so.2
 177      librte_bpf.so.1
 178      librte_bus_dpaa.so.1
 179      librte_bus_fslmc.so.1
 180      librte_bus_pci.so.1
 181      librte_bus_vdev.so.1
 182      librte_cfgfile.so.2
 183      librte_cmdline.so.2
 184      librte_common_octeontx.so.1
 185      librte_compressdev.so.1
 186    + librte_cryptodev.so.5
 187      librte_distributor.so.1
 188      librte_eal.so.7
 189      librte_ethdev.so.9
 190      librte_eventdev.so.4
 191      librte_flow_classify.so.1
 192      librte_gro.so.1
 193      librte_gso.so.1
 194      librte_hash.so.2
 195      librte_ip_frag.so.1
 196      librte_jobstats.so.1
 197      librte_kni.so.2
 198      librte_kvargs.so.1
 199      librte_latencystats.so.1
 200      librte_lpm.so.2
 201      librte_mbuf.so.4
 202      librte_mempool.so.4
 203      librte_meter.so.2
 204      librte_metrics.so.1
 205      librte_net.so.1
 206      librte_pci.so.1
 207      librte_pdump.so.2
 208      librte_pipeline.so.3
 209      librte_pmd_bnxt.so.2
 210      librte_pmd_bond.so.2
 211      librte_pmd_i40e.so.2
 212      librte_pmd_ixgbe.so.2
 213      librte_pmd_dpaa2_cmdif.so.1
 214      librte_pmd_dpaa2_qdma.so.1
 215      librte_pmd_ring.so.2
 216      librte_pmd_softnic.so.1
 217      librte_pmd_vhost.so.2
 218      librte_port.so.3
 219      librte_power.so.1
 220      librte_rawdev.so.1
 221      librte_reorder.so.1
 222      librte_ring.so.2
 223      librte_sched.so.1
 224      librte_security.so.1
 225      librte_table.so.3
 226      librte_timer.so.1
 227      librte_vhost.so.3
 228
 229
 230 Known Issues
 231 ------------
 232
 233 .. This section should contain new known issues in this release. Sample format:
 234
 235    * **Add title in present tense with full stop.**
 236
 237      Add a short 1-2 sentence description of the known issue
 238      in the present tense. Add information on any known workarounds.
 239
 240    This section is a comment. Do not overwrite or remove it.
 241    Also, make sure to start the actual text at the margin.
 242    =========================================================
 243
 244
 245 Tested Platforms
 246 ----------------
 247
 248 .. This section should contain a list of platforms that were tested
 249    with this release.
 250
 251    The format is:
 252
 253    * <vendor> platform with <vendor> <type of devices> combinations
 254
 255      * List of CPU
 256      * List of OS
 257      * List of devices
 258      * Other relevant details...
 259
 260    This section is a comment. Do not overwrite or remove it.
 261    Also, make sure to start the actual text at the margin.
 262    =========================================================