diff options
Diffstat (limited to 'doc/guides/sample_app_ug')
| -rw-r--r-- | doc/guides/sample_app_ug/ip_pipeline.rst | 2 | ||||
| -rw-r--r-- | doc/guides/sample_app_ug/l2_forward_real_virtual.rst | 2 | ||||
| -rw-r--r-- | doc/guides/sample_app_ug/l3_forward.rst | 2 | ||||
| -rw-r--r-- | doc/guides/sample_app_ug/pdump.rst | 14 | ||||
| -rw-r--r-- | doc/guides/sample_app_ug/proc_info.rst | 8 | ||||
| -rw-r--r-- | doc/guides/sample_app_ug/tep_termination.rst | 8 | ||||
| -rw-r--r-- | doc/guides/sample_app_ug/vhost.rst | 12 | ||||
| -rw-r--r-- | doc/guides/sample_app_ug/vm_power_management.rst | 2 |
8 files changed, 25 insertions, 25 deletions
diff --git a/doc/guides/sample_app_ug/ip_pipeline.rst b/doc/guides/sample_app_ug/ip_pipeline.rst index 09cbc174..693d813c 100644 --- a/doc/guides/sample_app_ug/ip_pipeline.rst +++ b/doc/guides/sample_app_ug/ip_pipeline.rst @@ -337,7 +337,7 @@ Generic example of configuration file section: <variable_name_1> = <value_1> - ... + ; ... <variable_name_N> = <value_N> diff --git a/doc/guides/sample_app_ug/l2_forward_real_virtual.rst b/doc/guides/sample_app_ug/l2_forward_real_virtual.rst index b51b2dc9..a1c10c04 100644 --- a/doc/guides/sample_app_ug/l2_forward_real_virtual.rst +++ b/doc/guides/sample_app_ug/l2_forward_real_virtual.rst @@ -472,7 +472,7 @@ If the table is full, the whole packets table is transmitted using the l2fwd_sen l2fwd_send_packet(struct rte_mbuf *m, uint8_t port) { unsigned lcore_id, len; - struct lcore_queue_conf \*qconf; + struct lcore_queue_conf *qconf; lcore_id = rte_lcore_id(); qconf = &lcore_queue_conf[lcore_id]; diff --git a/doc/guides/sample_app_ug/l3_forward.rst b/doc/guides/sample_app_ug/l3_forward.rst index c885cdb7..e2e62236 100644 --- a/doc/guides/sample_app_ug/l3_forward.rst +++ b/doc/guides/sample_app_ug/l3_forward.rst @@ -298,7 +298,7 @@ The get_ipv4_dst_port() function is shown below: int ret = 0; union ipv4_5tuple_host key; - ipv4_hdr = (uint8_t \*)ipv4_hdr + offsetof(struct ipv4_hdr, time_to_live); + ipv4_hdr = (uint8_t *)ipv4_hdr + offsetof(struct ipv4_hdr, time_to_live); m128i data = _mm_loadu_si128(( m128i*)(ipv4_hdr)); diff --git a/doc/guides/sample_app_ug/pdump.rst b/doc/guides/sample_app_ug/pdump.rst index ceb038ec..ac0e7c96 100644 --- a/doc/guides/sample_app_ug/pdump.rst +++ b/doc/guides/sample_app_ug/pdump.rst @@ -30,15 +30,15 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. -dpdk_pdump Application +dpdk-pdump Application ====================== -The ``dpdk_pdump`` tool is a Data Plane Development Kit (DPDK) tool that runs as +The ``dpdk-pdump`` tool is a Data Plane Development Kit (DPDK) tool that runs as a DPDK secondary process and is capable of enabling packet capture on dpdk ports. .. Note:: - * The ``dpdk_pdump`` tool depends on libpcap based PMD which is disabled + * The ``dpdk-pdump`` tool depends on libpcap based PMD which is disabled by default in the build configuration files, owing to an external dependency on the libpcap development files which must be installed on the board. @@ -53,7 +53,7 @@ The tool has a number of command line options: .. code-block:: console - ./build/app/dpdk_pdump -- + ./build/app/dpdk-pdump -- --pdump '(port=<port id> | device_id=<pci id or vdev name>), (queue=<queue_id>), (rx-dev=<iface or pcap file> | @@ -95,10 +95,10 @@ PCI address (or) name of the eth device on which packets should be captured. .. Note:: - * As of now the ``dpdk_pdump`` tool cannot capture the packets of virtual devices + * As of now the ``dpdk-pdump`` tool cannot capture the packets of virtual devices in the primary process due to a bug in the ethdev library. Due to this bug, in a multi process context, when the primary and secondary have different ports set, then the secondary process - (here the ``dpdk_pdump`` tool) overwrites the ``rte_eth_devices[]`` entries of the primary process. + (here the ``dpdk-pdump`` tool) overwrites the ``rte_eth_devices[]`` entries of the primary process. ``queue``: Queue id of the eth device on which packets should be captured. The user can pass a queue value of ``*`` to enable @@ -141,4 +141,4 @@ Example .. code-block:: console - $ sudo ./build/app/dpdk_pdump -- --pdump 'port=0,queue=*,rx-dev=/tmp/rx.pcap' + $ sudo ./build/app/dpdk-pdump -- --pdump 'port=0,queue=*,rx-dev=/tmp/rx.pcap' diff --git a/doc/guides/sample_app_ug/proc_info.rst b/doc/guides/sample_app_ug/proc_info.rst index 542950b3..73f21958 100644 --- a/doc/guides/sample_app_ug/proc_info.rst +++ b/doc/guides/sample_app_ug/proc_info.rst @@ -30,10 +30,10 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. -dpdk_proc_info Application -========================== +dpdk-procinfo Application +========================= -The dpdk_proc_info application is a Data Plane Development Kit (DPDK) application +The dpdk-procinfo application is a Data Plane Development Kit (DPDK) application that runs as a DPDK secondary process and is capable of retrieving port statistics, resetting port statistics and printing DPDK memory information. This application extends the original functionality that was supported by @@ -45,7 +45,7 @@ The application has a number of command line options: .. code-block:: console - ./$(RTE_TARGET)/app/dpdk_proc_info -- -m | [-p PORTMASK] [--stats | --xstats | + ./$(RTE_TARGET)/app/dpdk-procinfo -- -m | [-p PORTMASK] [--stats | --xstats | --stats-reset | --xstats-reset] Parameters diff --git a/doc/guides/sample_app_ug/tep_termination.rst b/doc/guides/sample_app_ug/tep_termination.rst index 2d86a03a..c3d1e97c 100644 --- a/doc/guides/sample_app_ug/tep_termination.rst +++ b/doc/guides/sample_app_ug/tep_termination.rst @@ -59,8 +59,8 @@ This allows network isolation, QOS, etc to be provided on a per client basis. In a typical setup, the network overlay tunnel is terminated at the Virtual/Tunnel End Point (VEP/TEP). The TEP is normally located at the physical host level ideally in the software switch. Due to processing constraints and the inevitable bottleneck that the switch -becomes the ability to offload overlay support features becomes an important requirement. -Intel® XL710 10/40 G Ethernet network card provides hardware filtering +becomes, the ability to offload overlay support features becomes an important requirement. +Intel® XL710 10/40 Gigabit Ethernet network card provides hardware filtering and offload capabilities to support overlay networks implementations such as MAC in UDP and MAC in GRE. Sample Code Overview @@ -131,14 +131,14 @@ Compiling the Sample Code .. code-block:: console - CONFIG_RTE_LIBRTE_VHOST=n + CONFIG_RTE_LIBRTE_VHOST=y vhost user is turned on by default in the configure file config/common_linuxapp. To enable vhost cuse, disable vhost user. .. code-block:: console - CONFIG_RTE_LIBRTE_VHOST_USER=y + CONFIG_RTE_LIBRTE_VHOST_USER=n After vhost is enabled and the implementation is selected, build the vhost library. diff --git a/doc/guides/sample_app_ug/vhost.rst b/doc/guides/sample_app_ug/vhost.rst index a93e54d8..2b7defc8 100644 --- a/doc/guides/sample_app_ug/vhost.rst +++ b/doc/guides/sample_app_ug/vhost.rst @@ -834,19 +834,19 @@ The above message indicates that device 0 has been registered with MAC address c Any packets received on the NIC with these values is placed on the devices receive queue. When a virtio-net device transmits packets, the VLAN tag is added to the packet by the DPDK vhost sample code. -Running virtio-user with vhost-switch +Running virtio_user with vhost-switch ------------------------------------- -We can also use virtio-user with vhost-switch now. -Virtio-user is a virtual device that can be run in a application (container) parallelly with vhost in the same OS, +We can also use virtio_user with vhost-switch now. +Virtio_user is a virtual device that can be run in a application (container) parallelly with vhost in the same OS, aka, there is no need to start a VM. We just run it with a different --file-prefix to avoid startup failure. .. code-block:: console cd ${RTE_SDK}/x86_64-native-linuxapp-gcc/app - ./testpmd -c 0x3 -n 4 --socket-mem 1024 --no-pci --file-prefix=virtio-user-testpmd \ - --vdev=virtio-user0,mac=00:01:02:03:04:05,path=$path_vhost \ + ./testpmd -c 0x3 -n 4 --socket-mem 1024 --no-pci --file-prefix=virtio_user-testpmd \ + --vdev=virtio_user0,mac=00:01:02:03:04:05,path=$path_vhost \ -- -i --txqflags=0xf01 --disable-hw-vlan There is no difference on the vhost side. -Pleae note that there are some limitations (see release note for more information) in the usage of virtio-user. +Pleae note that there are some limitations (see release note for more information) in the usage of virtio_user. diff --git a/doc/guides/sample_app_ug/vm_power_management.rst b/doc/guides/sample_app_ug/vm_power_management.rst index 7f299e03..aa02c156 100644 --- a/doc/guides/sample_app_ug/vm_power_management.rst +++ b/doc/guides/sample_app_ug/vm_power_management.rst @@ -167,7 +167,7 @@ Virtio-Serial channels are configured via libvirt XML: </controller> <channel type='unix'> <source mode='bind' path='/tmp/powermonitor/{vm_name}.{channel_num}'/> - <target type='virtio' name='virtio.serial.port.poweragent.{vm_channel_num}/> + <target type='virtio' name='virtio.serial.port.poweragent.{vm_channel_num}'/> <address type='virtio-serial' controller='0' bus='0' port='{N}'/> </channel> |