doc/guides/rel_notes/release_19_02.rst

   1 ..  SPDX-License-Identifier: BSD-3-Clause
   2     Copyright 2018 The DPDK contributors
   3
   4 DPDK Release 19.02
   5 ==================
   6
   7 .. **Read this first.**
   8
   9    The text in the sections below explains how to update the release notes.
  10
  11    Use proper spelling, capitalization and punctuation in all sections.
  12
  13    Variable and config names should be quoted as fixed width text:
  14    ``LIKE_THIS``.
  15
  16    Build the docs and view the output file to ensure the changes are correct::
  17
  18       make doc-guides-html
  19
  20       xdg-open build/doc/html/guides/rel_notes/release_19_02.html
  21
  22
  23 New Features
  24 ------------
  25
  26 .. This section should contain new features added in this release.
  27    Sample format:
  28
  29    * **Add a title in the past tense with a full stop.**
  30
  31      Add a short 1-2 sentence description in the past tense.
  32      The description should be enough to allow someone scanning
  33      the release notes to understand the new feature.
  34
  35      If the feature adds a lot of sub-features you can use a bullet list
  36      like this:
  37
  38      * Added feature foo to do something.
  39      * Enhanced feature bar to do something else.
  40
  41      Refer to the previous release notes for examples.
  42
  43      Suggested order in release notes items:
  44      * Core libs (EAL, mempool, ring, mbuf, buses)
  45      * Device abstraction libs and PMDs
  46        - ethdev (lib, PMDs)
  47        - cryptodev (lib, PMDs)
  48        - eventdev (lib, PMDs)
  49        - etc
  50      * Other libs
  51      * Apps, Examples, Tools (if significant)
  52
  53      This section is a comment. Do not overwrite or remove it.
  54      Also, make sure to start the actual text at the margin.
  55      =========================================================
  56
  57 * **Added support to free hugepages exactly as originally allocated.**
  58
  59   Some applications using memory event callbacks (especially for managing
  60   RDMA memory regions) require that memory be freed back to the system
  61   exactly as it was originally allocated. These applications typically
  62   also require that a malloc allocation not span across two separate
  63   hugepage allocations.  A new ``--match-allocations`` EAL init flag has
  64   been added to fulfill both of these requirements.
  65
  66 * **Added API to register external memory in DPDK.**
  67
  68   A new ``rte_extmem_register``/``rte_extmem_unregister`` API was added to allow
  69   chunks of external memory to be registered with DPDK without adding them to
  70   the malloc heap.
  71
  72 * **Updated the enic driver.**
  73
  74   * Added support for ``RTE_ETH_DEV_CLOSE_REMOVE`` flag.
  75   * Added the handler to get firmware version string.
  76   * Added support for multicast filtering.
  77
  78 * **Added a compression performance test tool.**
  79
  80   Added a new performance test tool to test the compressdev PMD. The tool tests
  81   compression ratio and compression throughput.
  82
  83
  84 Removed Items
  85 -------------
  86
  87 .. This section should contain removed items in this release. Sample format:
  88
  89    * Add a short 1-2 sentence description of the removed item
  90      in the past tense.
  91
  92    This section is a comment. Do not overwrite or remove it.
  93    Also, make sure to start the actual text at the margin.
  94    =========================================================
  95
  96
  97 API Changes
  98 -----------
  99
 100 .. This section should contain API changes. Sample format:
 101
 102    * sample: Add a short 1-2 sentence description of the API change
 103      which was announced in the previous releases and made in this release.
 104      Start with a scope label like "ethdev:".
 105      Use fixed width quotes for ``function_names`` or ``struct_names``.
 106      Use the past tense.
 107
 108    This section is a comment. Do not overwrite or remove it.
 109    Also, make sure to start the actual text at the margin.
 110    =========================================================
 111
 112 * eal: Segment fd API on Linux now sets error code to ``ENOTSUP`` in more cases
 113   where segment fd API is not expected to be supported:
 114
 115   - On attempt to get segment fd for an externally allocated memory segment
 116
 117 * pdump: The ``rte_pdump_set_socket_dir()``, the parameter ``path`` of
 118   ``rte_pdump_init()`` and enum ``rte_pdump_socktype`` were deprecated
 119   since 18.05 and are removed in this release.
 120
 121
 122 ABI Changes
 123 -----------
 124
 125 .. This section should contain ABI changes. Sample format:
 126
 127    * sample: Add a short 1-2 sentence description of the ABI change
 128      which was announced in the previous releases and made in this release.
 129      Start with a scope label like "ethdev:".
 130      Use fixed width quotes for ``function_names`` or ``struct_names``.
 131      Use 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      libfoo.so.1
 145    + libupdated.so.2
 146      libbar.so.1
 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.2
 160      librte_bus_fslmc.so.2
 161      librte_bus_ifpga.so.2
 162      librte_bus_pci.so.2
 163      librte_bus_vdev.so.2
 164      librte_bus_vmbus.so.2
 165      librte_cfgfile.so.2
 166      librte_cmdline.so.2
 167      librte_compressdev.so.1
 168      librte_cryptodev.so.5
 169      librte_distributor.so.1
 170      librte_eal.so.9
 171      librte_efd.so.1
 172      librte_ethdev.so.11
 173      librte_eventdev.so.6
 174      librte_flow_classify.so.1
 175      librte_gro.so.1
 176      librte_gso.so.1
 177      librte_hash.so.2
 178      librte_ip_frag.so.1
 179      librte_jobstats.so.1
 180      librte_kni.so.2
 181      librte_kvargs.so.1
 182      librte_latencystats.so.1
 183      librte_lpm.so.2
 184      librte_mbuf.so.4
 185      librte_member.so.1
 186      librte_mempool.so.5
 187      librte_meter.so.2
 188      librte_metrics.so.1
 189      librte_net.so.1
 190      librte_pci.so.1
 191    + librte_pdump.so.3
 192      librte_pipeline.so.3
 193      librte_pmd_bnxt.so.2
 194      librte_pmd_bond.so.2
 195      librte_pmd_i40e.so.2
 196      librte_pmd_ixgbe.so.2
 197      librte_pmd_dpaa2_qdma.so.1
 198      librte_pmd_ring.so.2
 199      librte_pmd_softnic.so.1
 200      librte_pmd_vhost.so.2
 201      librte_port.so.3
 202      librte_power.so.1
 203      librte_rawdev.so.1
 204      librte_reorder.so.1
 205      librte_ring.so.2
 206      librte_sched.so.1
 207      librte_security.so.1
 208      librte_table.so.3
 209      librte_timer.so.1
 210      librte_vhost.so.4
 211
 212
 213 Known Issues
 214 ------------
 215
 216 .. This section should contain new known issues in this release. Sample format:
 217
 218    * **Add title in present tense with full stop.**
 219
 220      Add a short 1-2 sentence description of the known issue
 221      in the present tense. Add information on any known workarounds.
 222
 223    This section is a comment. Do not overwrite or remove it.
 224    Also, make sure to start the actual text at the margin.
 225    =========================================================
 226
 227
 228 Tested Platforms
 229 ----------------
 230
 231 .. This section should contain a list of platforms that were tested
 232    with this release.
 233
 234    The format is:
 235
 236    * <vendor> platform with <vendor> <type of devices> combinations
 237
 238      * List of CPU
 239      * List of OS
 240      * List of devices
 241      * Other relevant details...
 242
 243    This section is a comment. Do not overwrite or remove it.
 244    Also, make sure to start the actual text at the margin.
 245    =========================================================