numam-dpdk/doc/guides/rel_notes/release_16_11.rst
Zhiyong Yang 4d6cf2ac93 net/vhost: add extended statistics
This feature adds vhost pmd extended statistics from per port perspective
in order to meet the requirements of the applications such as OVS etc.
RX/TX xstats count the bytes without CRC. This is different from physical
NIC stats with CRC.

The statistics counters are based on RFC 2819 and RFC 2863 as follows:

rx/tx_good_packets
rx/tx_total_bytes
rx/tx_missed_pkts
rx/tx_broadcast_packets
rx/tx_multicast_packets
rx/tx_unicast_packets
rx/tx_undersize_errors
rx/tx_size_64_packets
rx/tx_size_65_to_127_packets;
rx/tx_size_128_to_255_packets;
rx/tx_size_256_to_511_packets;
rx/tx_size_512_to_1023_packets;
rx/tx_size_1024_to_1522_packets;
rx/tx_1523_to_max_packets;
rx/tx_errors
rx_fragmented_errors
rx_jabber_errors
rx_unknown_protos_packets;

No API is changed or added.
rte_eth_xstats_get_names() to retrieve what kinds of vhost xstats are
supported,
rte_eth_xstats_get() to retrieve vhost extended statistics,
rte_eth_xstats_reset() to reset vhost extended statistics.

The usage of vhost pmd xstats is the same as virtio pmd xstats.
for example, when test-pmd application is running in interactive mode
vhost pmd xstats will support the two following commands:

show port xstats all | port_id will show vhost xstats
clear port xstats all | port_id will reset vhost xstats

net/virtio pmd xstats(the function virtio_update_packet_stats) is used
as reference when implementing the feature.

Tested-by: Ciara Loftus <ciara.loftus@intel.com>
Signed-off-by: Zhiyong Yang <zhiyong.yang@intel.com>
Acked-by: Yuanhan Liu <yuanhan.liu@linux.intel.com>
2016-09-29 15:08:08 +02:00

232 lines
5.8 KiB
ReStructuredText

DPDK Release 16.11
==================
.. **Read this first.**
The text below explains how to update the release notes.
Use proper spelling, capitalization and punctuation in all sections.
Variable and config names should be quoted as fixed width text: ``LIKE_THIS``.
Build the docs and view the output file to ensure the changes are correct::
make doc-guides-html
firefox build/doc/html/guides/rel_notes/release_16_11.html
New Features
------------
.. This section should contain new features added in this release. Sample format:
* **Add a title in the past tense with a full stop.**
Add a short 1-2 sentence description in the past tense. The description
should be enough to allow someone scanning the release notes to understand
the new feature.
If the feature adds a lot of sub-features you can use a bullet list like this.
* Added feature foo to do something.
* Enhanced feature bar to do something else.
Refer to the previous release notes for examples.
This section is a comment. Make sure to start the actual text at the margin.
* **Added vhost-user indirect descriptors support.**
If indirect descriptor feature is negotiated, each packet sent by the guest
will take exactly one slot in the enqueue virtqueue. Without the feature, in
current version, even 64 bytes packets take two slots with Virtio PMD on guest
side.
The main impact is better performance for 0% packet loss use-cases, as it
behaves as if the virtqueue size was enlarged, so more packets can be buffered
in case of system perturbations. On the downside, small performance degradation
is measured when running micro-benchmarks.
* **Added vhost PMD xstats.**
Added extended statistics to vhost PMD from per port perspective.
* **Added virtio NEON support for ARM.**
Resolved Issues
---------------
.. This section should contain bug fixes added to the relevant sections. Sample format:
* **code/section Fixed issue in the past tense with a full stop.**
Add a short 1-2 sentence description of the resolved issue in the past tense.
The title should contain the code/lib section like a commit message.
Add the entries in alphabetic order in the relevant sections below.
This section is a comment. Make sure to start the actual text at the margin.
EAL
~~~
Drivers
~~~~~~~
Libraries
~~~~~~~~~
Examples
~~~~~~~~
Other
~~~~~
Known Issues
------------
.. This section should contain new known issues in this release. Sample format:
* **Add title in present tense with full stop.**
Add a short 1-2 sentence description of the known issue in the present
tense. Add information on any known workarounds.
This section is a comment. Make sure to start the actual text at the margin.
API Changes
-----------
.. This section should contain API changes. Sample format:
* Add a short 1-2 sentence description of the API change. Use fixed width
quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
This section is a comment. Make sure to start the actual text at the margin.
* The driver names have been changed. It especially impacts ``--vdev`` arguments.
Examples: ``eth_pcap`` becomes ``net_pcap``
and ``cryptodev_aesni_mb_pmd`` becomes ``crypto_aesni_mb``.
* The log history is removed.
* The ``rte_ivshmem`` feature (including library and EAL code) has been removed
in 16.11 because it had some design issues which were not planned to be fixed.
ABI Changes
-----------
.. This section should contain ABI changes. Sample format:
* Add a short 1-2 sentence description of the ABI change that was announced in
the previous releases and made in this release. Use fixed width quotes for
``rte_function_names`` or ``rte_struct_names``. Use the past tense.
This section is a comment. Make sure to start the actual text at the margin.
Shared Library Versions
-----------------------
.. Update any library version updated in this release and prepend with a ``+``
sign, like this:
libethdev.so.4
librte_acl.so.2
+ librte_cfgfile.so.2
librte_cmdline.so.2
The libraries prepended with a plus sign were incremented in this version.
.. code-block:: diff
libethdev.so.4
librte_acl.so.2
librte_cfgfile.so.2
librte_cmdline.so.2
librte_cryptodev.so.1
librte_distributor.so.1
+ librte_eal.so.3
librte_hash.so.2
librte_ip_frag.so.1
librte_jobstats.so.1
librte_kni.so.2
librte_kvargs.so.1
librte_lpm.so.2
librte_mbuf.so.2
librte_mempool.so.2
librte_meter.so.1
librte_pdump.so.1
librte_pipeline.so.3
librte_pmd_bond.so.1
librte_pmd_ring.so.2
librte_port.so.3
librte_power.so.1
librte_reorder.so.1
librte_ring.so.1
librte_sched.so.1
librte_table.so.2
librte_timer.so.1
librte_vhost.so.3
Tested Platforms
----------------
.. This section should contain a list of platforms that were tested with this release.
The format is:
#. Platform name.
* Platform details.
* Platform details.
This section is a comment. Make sure to start the actual text at the margin.
Tested NICs
-----------
.. This section should contain a list of NICs that were tested with this release.
The format is:
#. NIC name.
* NIC details.
* NIC details.
This section is a comment. Make sure to start the actual text at the margin.
Tested OSes
-----------
.. This section should contain a list of OSes that were tested with this release.
The format is as follows, in alphabetical order:
* CentOS 7.0
* Fedora 23
* Fedora 24
* FreeBSD 10.3
* Red Hat Enterprise Linux 7.2
* SUSE Enterprise Linux 12
* Ubuntu 15.10
* Ubuntu 16.04 LTS
* Wind River Linux 8
This section is a comment. Make sure to start the actual text at the margin.