xref: /dpdk/doc/guides/sample_app_ug/index.rst (revision 4c00cfdc0ea225f2518a35db928ad1ab02b2a724)
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 Guides
32===============================
33
34.. toctree::
35    :maxdepth: 2
36    :numbered:
37
38    intro
39    compiling
40    cmd_line
41    ethtool
42    exception_path
43    hello_world
44    skeleton
45    rxtx_callbacks
46    ip_frag
47    ipv4_multicast
48    ip_reassembly
49    kernel_nic_interface
50    keep_alive
51    l2_forward_crypto
52    l2_forward_job_stats
53    l2_forward_real_virtual
54    l2_forward_cat
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    server_node_efd
62    service_cores
63    multi_process
64    qos_metering
65    qos_scheduler
66    quota_watermark
67    timer
68    packet_ordering
69    vmdq_dcb_forwarding
70    vhost
71    vhost_scsi
72    netmap_compatibility
73    ip_pipeline
74    test_pipeline
75    eventdev_pipeline_sw_pmd
76    dist_app
77    vm_power_management
78    tep_termination
79    ptpclient
80    performance_thread
81    ipsec_secgw
82
83**Figures**
84
85:numref:`figure_exception_path_example` :ref:`figure_exception_path_example`
86
87:numref:`figure_kernel_nic` :ref:`figure_kernel_nic`
88
89:numref:`figure_l2_fwd_benchmark_setup_jobstats` :ref:`figure_l2_fwd_benchmark_setup_jobstats`
90
91:numref:`figure_l2_fwd_virtenv_benchmark_setup_jobstats` :ref:`figure_l2_fwd_virtenv_benchmark_setup_jobstats`
92
93:numref:`figure_l2_fwd_benchmark_setup` :ref:`figure_l2_fwd_benchmark_setup`
94
95:numref:`figure_l2_fwd_virtenv_benchmark_setup` :ref:`figure_l2_fwd_virtenv_benchmark_setup`
96
97:numref:`figure_l2_fwd_encrypt_flow` :ref:`figure_l2_fwd_encrypt_flow`
98
99:numref:`figure_ipv4_acl_rule` :ref:`figure_ipv4_acl_rule`
100
101:numref:`figure_example_rules` :ref:`figure_example_rules`
102
103:numref:`figure_load_bal_app_arch` :ref:`figure_load_bal_app_arch`
104
105:numref:`figure_sym_multi_proc_app` :ref:`figure_sym_multi_proc_app`
106
107:numref:`figure_client_svr_sym_multi_proc_app` :ref:`figure_client_svr_sym_multi_proc_app`
108
109:numref:`figure_master_slave_proc` :ref:`figure_master_slave_proc`
110
111:numref:`figure_slave_proc_recov` :ref:`figure_slave_proc_recov`
112
113:numref:`figure_qos_sched_app_arch` :ref:`figure_qos_sched_app_arch`
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_test_pipeline_app` :ref:`figure_test_pipeline_app`
124
125:numref:`figure_dist_perf` :ref:`figure_dist_perf`
126
127:numref:`figure_dist_app` :ref:`figure_dist_app`
128
129:numref:`figure_vm_power_mgr_highlevel` :ref:`figure_vm_power_mgr_highlevel`
130
131:numref:`figure_vm_power_mgr_vm_request_seq` :ref:`figure_vm_power_mgr_vm_request_seq`
132:numref:`figure_overlay_networking` :ref:`figure_overlay_networking`
133:numref:`figure_tep_termination_arch` :ref:`figure_tep_termination_arch`
134
135:numref:`figure_ptpclient_highlevel` :ref:`figure_ptpclient_highlevel`
136
137:numref:`figure_efd_sample_app_overview` :ref:`figure_efd_sample_app_overview`
138
139**Tables**
140
141:numref:`table_qos_metering_1` :ref:`table_qos_metering_1`
142
143:numref:`table_qos_scheduler_1` :ref:`table_qos_scheduler_1`
144
145:numref:`table_test_pipeline_1` :ref:`table_test_pipeline_1`
146