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