X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=doc%2Fguides%2Fsample_app_ug%2Findex.rst;h=affa9c574c22a8fdc4491232e89ab5a651654455;hb=0f392d91b9977fdb879ef595839806c29b150c14;hp=aaa95effdc0369738c4769e26ebe09fbd8d38e44;hpb=ccefe752cab00c89b7bb84942559d5c1c24fb3f3;p=dpdk.git diff --git a/doc/guides/sample_app_ug/index.rst b/doc/guides/sample_app_ug/index.rst index aaa95effdc..affa9c574c 100644 --- a/doc/guides/sample_app_ug/index.rst +++ b/doc/guides/sample_app_ug/index.rst @@ -1,135 +1,60 @@ -.. BSD LICENSE - Copyright(c) 2010-2015 Intel Corporation. All rights reserved. - All rights reserved. +.. SPDX-License-Identifier: BSD-3-Clause + Copyright(c) 2010-2015 Intel Corporation. - Redistribution and use in source and binary forms, with or without - modification, are permitted provided that the following conditions - are met: - - * Redistributions of source code must retain the above copyright - notice, this list of conditions and the following disclaimer. - * Redistributions in binary form must reproduce the above copyright - notice, this list of conditions and the following disclaimer in - the documentation and/or other materials provided with the - distribution. - * Neither the name of Intel Corporation nor the names of its - contributors may be used to endorse or promote products derived - from this software without specific prior written permission. - - THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS - "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT - LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR - A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT - OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, - SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT - LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, - DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY - THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT - (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE - OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - -Sample Applications User Guide -============================== - -|today| - -**Contents** +Sample Applications User Guides +=============================== .. toctree:: :maxdepth: 2 :numbered: intro + compiling cmd_line - exception_path + ethtool hello_world skeleton rxtx_callbacks + flow_classify + flow_filtering ip_frag ipv4_multicast ip_reassembly kernel_nic_interface + keep_alive + ioat + l2_forward_crypto l2_forward_job_stats l2_forward_real_virtual + l2_forward_event + l2_forward_cat l3_forward + l3_forward_graph l3_forward_power_man l3_forward_access_ctrl - l3_forward_virtual link_status_intr - load_balancer + server_node_efd + service_cores multi_process qos_metering qos_scheduler - intel_quickassist - quota_watermark timer packet_ordering vmdq_dcb_forwarding + vmdq_forwarding vhost - netmap_compatibility - internet_proto_ip_pipeline + vhost_blk + vhost_crypto + vdpa + ip_pipeline test_pipeline + eventdev_pipeline dist_app vm_power_management - -**Figures** - -:ref:`Figure 1.Packet Flow ` - -:ref:`Figure 2.Kernel NIC Application Packet Flow ` - -:ref:`Figure 3.Performance Benchmark Setup (Basic Environment) ` - -:ref:`Figure 4.Performance Benchmark Setup (Virtualized Environment) ` - -:ref:`Figure 5.Load Balancer Application Architecture ` - -:ref:`Figure 5.Example Rules File ` - -:ref:`Figure 6.Example Data Flow in a Symmetric Multi-process Application ` - -:ref:`Figure 7.Example Data Flow in a Client-Server Symmetric Multi-process Application ` - -:ref:`Figure 8.Master-slave Process Workflow ` - -:ref:`Figure 9.Slave Process Recovery Process Flow ` - -:ref:`Figure 10.QoS Scheduler Application Architecture ` - -:ref:`Figure 11.Intel®QuickAssist Technology Application Block Diagram ` - -:ref:`Figure 12.Pipeline Overview ` - -:ref:`Figure 13.Ring-based Processing Pipeline Performance Setup ` - -:ref:`Figure 14.Threads and Pipelines ` - -:ref:`Figure 15.Packet Flow Through the VMDQ and DCB Sample Application ` - -:ref:`Figure 16.QEMU Virtio-net (prior to vhost-net) ` - -:ref:`Figure 17.Virtio with Linux* Kernel Vhost ` - -:ref:`Figure 18.Vhost-net Architectural Overview ` - -:ref:`Figure 19.Packet Flow Through the vhost-net Sample Application ` - -:ref:`Figure 20.Packet Flow on TX in DPDK-testpmd ` - -:ref:`Figure 21.Test Pipeline Application ` - -:ref:`Figure 22.Performance Benchmarking Setup (Basic Environment) ` - -:ref:`Figure 23.Distributor Sample Application Layout ` - -:ref:`Figure 24.High level Solution ` - -:ref:`Figure 25.VM request to scale frequency ` - -**Tables** - -:ref:`Table 1.Output Traffic Marking ` - -:ref:`Table 2.Entity Types ` - -:ref:`Table 3.Table Types ` + tep_termination + ptpclient + performance_thread + fips_validation + ipsec_secgw + bbdev_app + ntb