1.. BSD LICENSE 2 Copyright(c) 2010-2015 Intel Corporation. All rights reserved. 3 All rights reserved. 4 5 Redistribution and use in source and binary forms, with or without 6 modification, are permitted provided that the following conditions 7 are met: 8 9 * Redistributions of source code must retain the above copyright 10 notice, this list of conditions and the following disclaimer. 11 * Redistributions in binary form must reproduce the above copyright 12 notice, this list of conditions and the following disclaimer in 13 the documentation and/or other materials provided with the 14 distribution. 15 * Neither the name of Intel Corporation nor the names of its 16 contributors may be used to endorse or promote products derived 17 from this software without specific prior written permission. 18 19 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 20 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 21 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 22 A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 23 OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 24 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 25 LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 26 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 27 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 28 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 29 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 30 31Sample Applications User Guide 32============================== 33 34|today| 35 36**Contents** 37 38.. toctree:: 39 :maxdepth: 2 40 :numbered: 41 42 intro 43 cmd_line 44 exception_path 45 hello_world 46 skeleton 47 rxtx_callbacks 48 ip_frag 49 ipv4_multicast 50 ip_reassembly 51 kernel_nic_interface 52 keep_alive 53 l2_forward_job_stats 54 l2_forward_real_virtual 55 l3_forward 56 l3_forward_power_man 57 l3_forward_access_ctrl 58 l3_forward_virtual 59 link_status_intr 60 load_balancer 61 multi_process 62 qos_metering 63 qos_scheduler 64 intel_quickassist 65 quota_watermark 66 timer 67 packet_ordering 68 vmdq_dcb_forwarding 69 vhost 70 netmap_compatibility 71 ip_pipeline 72 test_pipeline 73 dist_app 74 vm_power_management 75 tep_termination 76 proc_info 77 ptpclient 78 79**Figures** 80 81:numref:`figure_exception_path_example` :ref:`figure_exception_path_example` 82 83:numref:`figure_kernel_nic` :ref:`figure_kernel_nic` 84 85:numref:`figure_l2_fwd_benchmark_setup_jobstats` :ref:`figure_l2_fwd_benchmark_setup_jobstats` 86 87:numref:`figure_l2_fwd_virtenv_benchmark_setup_jobstats` :ref:`figure_l2_fwd_virtenv_benchmark_setup_jobstats` 88 89:numref:`figure_l2_fwd_benchmark_setup` :ref:`figure_l2_fwd_benchmark_setup` 90 91:numref:`figure_l2_fwd_virtenv_benchmark_setup` :ref:`figure_l2_fwd_virtenv_benchmark_setup` 92 93:numref:`figure_ipv4_acl_rule` :ref:`figure_ipv4_acl_rule` 94 95:numref:`figure_example_rules` :ref:`figure_example_rules` 96 97:numref:`figure_load_bal_app_arch` :ref:`figure_load_bal_app_arch` 98 99:numref:`figure_sym_multi_proc_app` :ref:`figure_sym_multi_proc_app` 100 101:numref:`figure_client_svr_sym_multi_proc_app` :ref:`figure_client_svr_sym_multi_proc_app` 102 103:numref:`figure_master_slave_proc` :ref:`figure_master_slave_proc` 104 105:numref:`figure_slave_proc_recov` :ref:`figure_slave_proc_recov` 106 107:numref:`figure_qos_sched_app_arch` :ref:`figure_qos_sched_app_arch` 108 109:numref:`figure_quickassist_block_diagram` :ref:`figure_quickassist_block_diagram` 110 111:numref:`figure_pipeline_overview` :ref:`figure_pipeline_overview` 112 113:numref:`figure_ring_pipeline_perf_setup` :ref:`figure_ring_pipeline_perf_setup` 114 115:numref:`figure_threads_pipelines` :ref:`figure_threads_pipelines` 116 117:numref:`figure_vmdq_dcb_example` :ref:`figure_vmdq_dcb_example` 118 119:numref:`figure_qemu_virtio_net` :ref:`figure_qemu_virtio_net` 120 121:numref:`figure_virtio_linux_vhost` :ref:`figure_virtio_linux_vhost` 122 123:numref:`figure_vhost_net_arch` :ref:`figure_vhost_net_arch` 124 125:numref:`figure_vhost_net_sample_app` :ref:`figure_vhost_net_sample_app` 126 127:numref:`figure_tx_dpdk_testpmd` :ref:`figure_tx_dpdk_testpmd` 128 129:numref:`figure_test_pipeline_app` :ref:`figure_test_pipeline_app` 130 131:numref:`figure_dist_perf` :ref:`figure_dist_perf` 132 133:numref:`figure_dist_app` :ref:`figure_dist_app` 134 135:numref:`figure_vm_power_mgr_highlevel` :ref:`figure_vm_power_mgr_highlevel` 136 137:numref:`figure_vm_power_mgr_vm_request_seq` :ref:`figure_vm_power_mgr_vm_request_seq` 138:numref:`figure_overlay_networking` :ref:`figure_overlay_networking` 139:numref:`figure_tep_termination_arch` :ref:`figure_tep_termination_arch` 140 141:numref:`figure_ptpclient_highlevel` :ref:`figure_ptpclient_highlevel` 142 143**Tables** 144 145:numref:`table_qos_metering_1` :ref:`table_qos_metering_1` 146 147:numref:`table_qos_scheduler_1` :ref:`table_qos_scheduler_1` 148 149:numref:`table_test_pipeline_1` :ref:`table_test_pipeline_1` 150