index.rst revision 809f0800
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.. toctree::
35    :maxdepth: 2
36    :numbered:
37
38    intro
39    cmd_line
40    ethtool
41    exception_path
42    hello_world
43    skeleton
44    rxtx_callbacks
45    ip_frag
46    ipv4_multicast
47    ip_reassembly
48    kernel_nic_interface
49    keep_alive
50    l2_forward_crypto
51    l2_forward_job_stats
52    l2_forward_real_virtual
53    l2_forward_cat
54    l3_forward
55    l3_forward_power_man
56    l3_forward_access_ctrl
57    l3_forward_virtual
58    link_status_intr
59    load_balancer
60    multi_process
61    qos_metering
62    qos_scheduler
63    intel_quickassist
64    quota_watermark
65    timer
66    packet_ordering
67    vmdq_dcb_forwarding
68    vhost
69    netmap_compatibility
70    ip_pipeline
71    test_pipeline
72    dist_app
73    vm_power_management
74    tep_termination
75    proc_info
76    ptpclient
77    performance_thread
78    ipsec_secgw
79    pdump
80
81**Figures**
82
83:numref:`figure_exception_path_example` :ref:`figure_exception_path_example`
84
85:numref:`figure_kernel_nic` :ref:`figure_kernel_nic`
86
87:numref:`figure_l2_fwd_benchmark_setup_jobstats` :ref:`figure_l2_fwd_benchmark_setup_jobstats`
88
89:numref:`figure_l2_fwd_virtenv_benchmark_setup_jobstats` :ref:`figure_l2_fwd_virtenv_benchmark_setup_jobstats`
90
91:numref:`figure_l2_fwd_benchmark_setup` :ref:`figure_l2_fwd_benchmark_setup`
92
93:numref:`figure_l2_fwd_virtenv_benchmark_setup` :ref:`figure_l2_fwd_virtenv_benchmark_setup`
94
95:numref:`figure_l2_fwd_encrypt_flow` :ref:`figure_l2_fwd_encrypt_flow`
96
97:numref:`figure_ipv4_acl_rule` :ref:`figure_ipv4_acl_rule`
98
99:numref:`figure_example_rules` :ref:`figure_example_rules`
100
101:numref:`figure_load_bal_app_arch` :ref:`figure_load_bal_app_arch`
102
103:numref:`figure_sym_multi_proc_app` :ref:`figure_sym_multi_proc_app`
104
105:numref:`figure_client_svr_sym_multi_proc_app` :ref:`figure_client_svr_sym_multi_proc_app`
106
107:numref:`figure_master_slave_proc` :ref:`figure_master_slave_proc`
108
109:numref:`figure_slave_proc_recov` :ref:`figure_slave_proc_recov`
110
111:numref:`figure_qos_sched_app_arch` :ref:`figure_qos_sched_app_arch`
112
113:numref:`figure_quickassist_block_diagram` :ref:`figure_quickassist_block_diagram`
114
115:numref:`figure_pipeline_overview` :ref:`figure_pipeline_overview`
116
117:numref:`figure_ring_pipeline_perf_setup` :ref:`figure_ring_pipeline_perf_setup`
118
119:numref:`figure_threads_pipelines` :ref:`figure_threads_pipelines`
120
121:numref:`figure_vmdq_dcb_example` :ref:`figure_vmdq_dcb_example`
122
123:numref:`figure_qemu_virtio_net` :ref:`figure_qemu_virtio_net`
124
125:numref:`figure_virtio_linux_vhost` :ref:`figure_virtio_linux_vhost`
126
127:numref:`figure_vhost_net_arch` :ref:`figure_vhost_net_arch`
128
129:numref:`figure_vhost_net_sample_app` :ref:`figure_vhost_net_sample_app`
130
131:numref:`figure_tx_dpdk_testpmd` :ref:`figure_tx_dpdk_testpmd`
132
133:numref:`figure_test_pipeline_app` :ref:`figure_test_pipeline_app`
134
135:numref:`figure_dist_perf` :ref:`figure_dist_perf`
136
137:numref:`figure_dist_app` :ref:`figure_dist_app`
138
139:numref:`figure_vm_power_mgr_highlevel` :ref:`figure_vm_power_mgr_highlevel`
140
141:numref:`figure_vm_power_mgr_vm_request_seq` :ref:`figure_vm_power_mgr_vm_request_seq`
142:numref:`figure_overlay_networking` :ref:`figure_overlay_networking`
143:numref:`figure_tep_termination_arch` :ref:`figure_tep_termination_arch`
144
145:numref:`figure_ptpclient_highlevel` :ref:`figure_ptpclient_highlevel`
146
147**Tables**
148
149:numref:`table_qos_metering_1` :ref:`table_qos_metering_1`
150
151:numref:`table_qos_scheduler_1` :ref:`table_qos_scheduler_1`
152
153:numref:`table_test_pipeline_1` :ref:`table_test_pipeline_1`
154