X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=doc%2Fguides%2Fsample_app_ug%2Findex.rst;h=e87afda8071df8074379f90917e2ad5556837959;hb=5630257fcc30397e7217139ec55da4f301f59fb7;hp=d07dec35acaa9457a2c2ebf5c5bae14f1e02f3d4;hpb=ee39993f7f932a2a1b4a5b2dbc4caa4de793963e;p=dpdk.git diff --git a/doc/guides/sample_app_ug/index.rst b/doc/guides/sample_app_ug/index.rst index d07dec35ac..e87afda807 100644 --- a/doc/guides/sample_app_ug/index.rst +++ b/doc/guides/sample_app_ug/index.rst @@ -1,131 +1,121 @@ -.. BSD LICENSE - Copyright(c) 2010-2014 Intel Corporation. All rights reserved. - All rights reserved. - - 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** +.. SPDX-License-Identifier: BSD-3-Clause + Copyright(c) 2010-2015 Intel Corporation. + +Sample Applications User Guides +=============================== .. toctree:: :maxdepth: 2 :numbered: intro + compiling cmd_line + ethtool exception_path hello_world + skeleton + rxtx_callbacks + flow_classify + flow_filtering ip_frag ipv4_multicast ip_reassembly kernel_nic_interface + keep_alive + l2_forward_crypto + l2_forward_job_stats l2_forward_real_virtual + l2_forward_cat l3_forward 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 vhost + vhost_scsi netmap_compatibility - internet_proto_ip_pipeline + ip_pipeline test_pipeline + eventdev_pipeline dist_app vm_power_management + tep_termination + ptpclient + performance_thread + ipsec_secgw + bbdev_app **Figures** -:ref:`Figure 1.Packet Flow ` +:numref:`figure_exception_path_example` :ref:`figure_exception_path_example` -:ref:`Figure 2.Kernel NIC Application Packet Flow ` +:numref:`figure_kernel_nic` :ref:`figure_kernel_nic` -:ref:`Figure 3.Performance Benchmark Setup (Basic Environment) ` +:numref:`figure_l2_fwd_benchmark_setup_jobstats` :ref:`figure_l2_fwd_benchmark_setup_jobstats` -:ref:`Figure 4.Performance Benchmark Setup (Virtualized Environment) ` +:numref:`figure_l2_fwd_virtenv_benchmark_setup_jobstats` :ref:`figure_l2_fwd_virtenv_benchmark_setup_jobstats` -:ref:`Figure 5.Load Balancer Application Architecture ` +:numref:`figure_l2_fwd_benchmark_setup` :ref:`figure_l2_fwd_benchmark_setup` -:ref:`Figure 5.Example Rules File ` +:numref:`figure_l2_fwd_virtenv_benchmark_setup` :ref:`figure_l2_fwd_virtenv_benchmark_setup` -:ref:`Figure 6.Example Data Flow in a Symmetric Multi-process Application ` +:numref:`figure_l2_fwd_encrypt_flow` :ref:`figure_l2_fwd_encrypt_flow` -:ref:`Figure 7.Example Data Flow in a Client-Server Symmetric Multi-process Application ` +:numref:`figure_ipv4_acl_rule` :ref:`figure_ipv4_acl_rule` -:ref:`Figure 8.Master-slave Process Workflow ` +:numref:`figure_example_rules` :ref:`figure_example_rules` -:ref:`Figure 9.Slave Process Recovery Process Flow ` +:numref:`figure_load_bal_app_arch` :ref:`figure_load_bal_app_arch` -:ref:`Figure 10.QoS Scheduler Application Architecture ` +:numref:`figure_sym_multi_proc_app` :ref:`figure_sym_multi_proc_app` -:ref:`Figure 11.Intel®QuickAssist Technology Application Block Diagram ` +:numref:`figure_client_svr_sym_multi_proc_app` :ref:`figure_client_svr_sym_multi_proc_app` -:ref:`Figure 12.Pipeline Overview ` +:numref:`figure_master_slave_proc` :ref:`figure_master_slave_proc` -:ref:`Figure 13.Ring-based Processing Pipeline Performance Setup ` +:numref:`figure_slave_proc_recov` :ref:`figure_slave_proc_recov` -:ref:`Figure 14.Threads and Pipelines ` +:numref:`figure_qos_sched_app_arch` :ref:`figure_qos_sched_app_arch` -:ref:`Figure 15.Packet Flow Through the VMDQ and DCB Sample Application ` +:numref:`figure_pipeline_overview` :ref:`figure_pipeline_overview` -:ref:`Figure 16.QEMU Virtio-net (prior to vhost-net) ` +:numref:`figure_ring_pipeline_perf_setup` :ref:`figure_ring_pipeline_perf_setup` -:ref:`Figure 17.Virtio with Linux* Kernel Vhost ` +:numref:`figure_threads_pipelines` :ref:`figure_threads_pipelines` -:ref:`Figure 18.Vhost-net Architectural Overview ` +:numref:`figure_vmdq_dcb_example` :ref:`figure_vmdq_dcb_example` -:ref:`Figure 19.Packet Flow Through the vhost-net Sample Application ` +:numref:`figure_test_pipeline_app` :ref:`figure_test_pipeline_app` -:ref:`Figure 20.Packet Flow on TX in DPDK-testpmd ` +:numref:`figure_dist_perf` :ref:`figure_dist_perf` -:ref:`Figure 21.Test Pipeline Application ` +:numref:`figure_dist_app` :ref:`figure_dist_app` -:ref:`Figure 22.Performance Benchmarking Setup (Basic Environment) ` +:numref:`figure_vm_power_mgr_highlevel` :ref:`figure_vm_power_mgr_highlevel` -:ref:`Figure 23.Distributor Sample Application Layout ` +:numref:`figure_vm_power_mgr_vm_request_seq` :ref:`figure_vm_power_mgr_vm_request_seq` +:numref:`figure_overlay_networking` :ref:`figure_overlay_networking` +:numref:`figure_tep_termination_arch` :ref:`figure_tep_termination_arch` -:ref:`Figure 24.High level Solution ` +:numref:`figure_ptpclient_highlevel` :ref:`figure_ptpclient_highlevel` -:ref:`Figure 25.VM request to scale frequency ` +:numref:`figure_efd_sample_app_overview` :ref:`figure_efd_sample_app_overview` **Tables** -:ref:`Table 1.Output Traffic Marking ` +:numref:`table_qos_metering_1` :ref:`table_qos_metering_1` -:ref:`Table 2.Entity Types ` +:numref:`table_qos_scheduler_1` :ref:`table_qos_scheduler_1` -:ref:`Table 3.Table Types ` +:numref:`table_test_pipeline_1` :ref:`table_test_pipeline_1`