doc/guides/rel_notes/release_17_02.rst

   1 DPDK Release 17.02
   2 ==================
   3
   4 .. **Read this first.**
   5
   6    The text 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: ``LIKE_THIS``.
  11
  12    Build the docs and view the output file to ensure the changes are correct::
  13
  14       make doc-guides-html
  15
  16       firefox build/doc/html/guides/rel_notes/release_17_02.html
  17
  18
  19 New Features
  20 ------------
  21
  22 .. This section should contain new features added in this release. Sample format:
  23
  24    * **Add a title in the past tense with a full stop.**
  25
  26      Add a short 1-2 sentence description in the past tense. The description
  27      should be enough to allow someone scanning the release notes to understand
  28      the new feature.
  29
  30      If the feature adds a lot of sub-features you can use a bullet list like this.
  31
  32      * Added feature foo to do something.
  33      * Enhanced feature bar to do something else.
  34
  35      Refer to the previous release notes for examples.
  36
  37      This section is a comment. do not overwrite or remove it.
  38      Also, make sure to start the actual text at the margin.
  39      =========================================================
  40
  41 * **Added generic flow API (rte_flow).**
  42
  43   This API provides a generic means to configure hardware to match specific
  44   ingress or egress traffic, alter its fate and query related counters
  45   according to any number of user-defined rules.
  46
  47   It is slightly higher-level than the legacy filtering framework which it
  48   encompasses and supersedes (including all functions and filter types) in
  49   order to expose a single interface with an unambiguous behavior that is
  50   common to all poll-mode drivers (PMDs).
  51
  52   See the :ref:`Generic flow API <Generic_flow_API>` documentation for more
  53   information.
  54
  55 * **Added APIs for MACsec offload support to the ixgbe PMD.**
  56
  57   Six new APIs have been added to the ixgbe PMD for MACsec offload support.
  58   The declarations for the APIs can be found in ``rte_pmd_ixgbe.h``.
  59
  60 * **virtio-user with vhost-kernel as another exceptional path.**
  61
  62   Previously, we upstreamed a virtual device, virtio-user with vhost-user
  63   as the backend, as a way for IPC (Inter-Process Communication) and user
  64   space container networking.
  65
  66   Virtio-user with vhost-kernel as the backend is a solution for exceptional
  67   path, such as KNI, which exchanges packets with kernel networking stack.
  68   This solution is very promising in:
  69
  70   * maintenance: vhost and vhost-net (kernel) is upstreamed and extensively
  71     used kernel module.
  72   * features: vhost-net is born to be a networking solution, which has
  73     lots of networking related features, like multi-queue, TSO, multi-seg
  74     mbuf, etc.
  75   * performance: similar to KNI, this solution would use one or more
  76     kthreads to send/receive packets from user space DPDK applications,
  77     which has little impact on user space polling thread (except that
  78     it might enter into kernel space to wake up those kthreads if
  79     necessary).
  80
  81
  82 Resolved Issues
  83 ---------------
  84
  85 .. This section should contain bug fixes added to the relevant sections. Sample format:
  86
  87    * **code/section Fixed issue in the past tense with a full stop.**
  88
  89      Add a short 1-2 sentence description of the resolved issue in the past tense.
  90      The title should contain the code/lib section like a commit message.
  91      Add the entries in alphabetic order in the relevant sections below.
  92
  93    This section is a comment. do not overwrite or remove it.
  94    Also, make sure to start the actual text at the margin.
  95    =========================================================
  96
  97
  98 EAL
  99 ~~~
 100
 101
 102 Drivers
 103 ~~~~~~~
 104
 105 * **net/virtio: Fixed multiple process support.**
 106
 107   Fixed few regressions introduced in recent releases that break the virtio
 108   multiple process support.
 109
 110
 111 Libraries
 112 ~~~~~~~~~
 113
 114
 115 Examples
 116 ~~~~~~~~
 117
 118 * **examples/ethtool: Fixed crash with non-PCI devices.**
 119
 120   Querying a non-PCI device was dereferencing non-existent PCI data
 121   resulting in a segmentation fault.
 122
 123
 124 Other
 125 ~~~~~
 126
 127
 128 Known Issues
 129 ------------
 130
 131 .. This section should contain new known issues in this release. Sample format:
 132
 133    * **Add title in present tense with full stop.**
 134
 135      Add a short 1-2 sentence description of the known issue in the present
 136      tense. Add information on any known workarounds.
 137
 138    This section is a comment. do not overwrite or remove it.
 139    Also, make sure to start the actual text at the margin.
 140    =========================================================
 141
 142
 143 API Changes
 144 -----------
 145
 146 .. This section should contain API changes. Sample format:
 147
 148    * Add a short 1-2 sentence description of the API change. Use fixed width
 149      quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 150
 151    This section is a comment. do not overwrite or remove it.
 152    Also, make sure to start the actual text at the margin.
 153    =========================================================
 154
 155
 156 ABI Changes
 157 -----------
 158
 159 .. This section should contain ABI changes. Sample format:
 160
 161    * Add a short 1-2 sentence description of the ABI change that was announced in
 162      the previous releases and made in this release. Use fixed width quotes for
 163      ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 164
 165    This section is a comment. do not overwrite or remove it.
 166    Also, make sure to start the actual text at the margin.
 167    =========================================================
 168
 169
 170
 171 Shared Library Versions
 172 -----------------------
 173
 174 .. Update any library version updated in this release and prepend with a ``+``
 175    sign, like this:
 176
 177      librte_acl.so.2
 178    + librte_cfgfile.so.2
 179      librte_cmdline.so.2
 180
 181    This section is a comment. do not overwrite or remove it.
 182    =========================================================
 183
 184
 185 The libraries prepended with a plus sign were incremented in this version.
 186
 187 .. code-block:: diff
 188
 189      librte_acl.so.2
 190      librte_cfgfile.so.2
 191      librte_cmdline.so.2
 192      librte_cryptodev.so.2
 193      librte_distributor.so.1
 194      librte_eal.so.3
 195      librte_ethdev.so.5
 196      librte_hash.so.2
 197      librte_ip_frag.so.1
 198      librte_jobstats.so.1
 199      librte_kni.so.2
 200      librte_kvargs.so.1
 201      librte_lpm.so.2
 202      librte_mbuf.so.2
 203      librte_mempool.so.2
 204      librte_meter.so.1
 205      librte_net.so.1
 206      librte_pdump.so.1
 207      librte_pipeline.so.3
 208      librte_pmd_bond.so.1
 209      librte_pmd_ring.so.2
 210      librte_port.so.3
 211      librte_power.so.1
 212      librte_reorder.so.1
 213      librte_ring.so.1
 214      librte_sched.so.1
 215      librte_table.so.2
 216      librte_timer.so.1
 217      librte_vhost.so.3
 218
 219
 220 Tested Platforms
 221 ----------------
 222
 223 .. This section should contain a list of platforms that were tested with this release.
 224
 225    The format is:
 226
 227    #. Platform name.
 228
 229       * Platform details.
 230       * Platform details.
 231
 232    This section is a comment. do not overwrite or remove it.
 233    Also, make sure to start the actual text at the margin.
 234    =========================================================
 235
 236
 237 Tested NICs
 238 -----------
 239
 240 .. This section should contain a list of NICs that were tested with this release.
 241
 242    The format is:
 243
 244    #. NIC name.
 245
 246       * NIC details.
 247       * NIC details.
 248
 249    This section is a comment. do not overwrite or remove it.
 250    Also, make sure to start the actual text at the margin.
 251    =========================================================
 252
 253
 254 Tested OSes
 255 -----------
 256
 257 .. This section should contain a list of OSes that were tested with this release.
 258    The format is as follows, in alphabetical order:
 259
 260    * CentOS 7.0
 261    * Fedora 23
 262    * Fedora 24
 263    * FreeBSD 10.3
 264    * Red Hat Enterprise Linux 7.2
 265    * SUSE Enterprise Linux 12
 266    * Ubuntu 15.10
 267    * Ubuntu 16.04 LTS
 268    * Wind River Linux 8
 269
 270    This section is a comment. do not overwrite or remove it.
 271    Also, make sure to start the actual text at the margin.
 272    =========================================================