xref: /dpdk/doc/guides/sample_app_ug/index.rst (revision cdea34452b09f5ce3c2f3ada6182afa0071fce47)
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    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    server_node_efd
61    service_cores
62    multi_process
63    qos_metering
64    qos_scheduler
65    quota_watermark
66    timer
67    packet_ordering
68    vmdq_dcb_forwarding
69    vhost
70    vhost_scsi
71    netmap_compatibility
72    ip_pipeline
73    test_pipeline
74    eventdev_pipeline_sw_pmd
75    dist_app
76    vm_power_management
77    tep_termination
78    ptpclient
79    performance_thread
80    ipsec_secgw
81
82**Figures**
83
84:numref:`figure_exception_path_example` :ref:`figure_exception_path_example`
85
86:numref:`figure_kernel_nic` :ref:`figure_kernel_nic`
87
88:numref:`figure_l2_fwd_benchmark_setup_jobstats` :ref:`figure_l2_fwd_benchmark_setup_jobstats`
89
90:numref:`figure_l2_fwd_virtenv_benchmark_setup_jobstats` :ref:`figure_l2_fwd_virtenv_benchmark_setup_jobstats`
91
92:numref:`figure_l2_fwd_benchmark_setup` :ref:`figure_l2_fwd_benchmark_setup`
93
94:numref:`figure_l2_fwd_virtenv_benchmark_setup` :ref:`figure_l2_fwd_virtenv_benchmark_setup`
95
96:numref:`figure_l2_fwd_encrypt_flow` :ref:`figure_l2_fwd_encrypt_flow`
97
98:numref:`figure_ipv4_acl_rule` :ref:`figure_ipv4_acl_rule`
99
100:numref:`figure_example_rules` :ref:`figure_example_rules`
101
102:numref:`figure_load_bal_app_arch` :ref:`figure_load_bal_app_arch`
103
104:numref:`figure_sym_multi_proc_app` :ref:`figure_sym_multi_proc_app`
105
106:numref:`figure_client_svr_sym_multi_proc_app` :ref:`figure_client_svr_sym_multi_proc_app`
107
108:numref:`figure_master_slave_proc` :ref:`figure_master_slave_proc`
109
110:numref:`figure_slave_proc_recov` :ref:`figure_slave_proc_recov`
111
112:numref:`figure_qos_sched_app_arch` :ref:`figure_qos_sched_app_arch`
113
114:numref:`figure_pipeline_overview` :ref:`figure_pipeline_overview`
115
116:numref:`figure_ring_pipeline_perf_setup` :ref:`figure_ring_pipeline_perf_setup`
117
118:numref:`figure_threads_pipelines` :ref:`figure_threads_pipelines`
119
120:numref:`figure_vmdq_dcb_example` :ref:`figure_vmdq_dcb_example`
121
122:numref:`figure_test_pipeline_app` :ref:`figure_test_pipeline_app`
123
124:numref:`figure_dist_perf` :ref:`figure_dist_perf`
125
126:numref:`figure_dist_app` :ref:`figure_dist_app`
127
128:numref:`figure_vm_power_mgr_highlevel` :ref:`figure_vm_power_mgr_highlevel`
129
130:numref:`figure_vm_power_mgr_vm_request_seq` :ref:`figure_vm_power_mgr_vm_request_seq`
131:numref:`figure_overlay_networking` :ref:`figure_overlay_networking`
132:numref:`figure_tep_termination_arch` :ref:`figure_tep_termination_arch`
133
134:numref:`figure_ptpclient_highlevel` :ref:`figure_ptpclient_highlevel`
135
136:numref:`figure_efd_sample_app_overview` :ref:`figure_efd_sample_app_overview`
137
138**Tables**
139
140:numref:`table_qos_metering_1` :ref:`table_qos_metering_1`
141
142:numref:`table_qos_scheduler_1` :ref:`table_qos_scheduler_1`
143
144:numref:`table_test_pipeline_1` :ref:`table_test_pipeline_1`
145