examples/bbdev: add sample app
[dpdk.git] / doc / guides / sample_app_ug / index.rst
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
31 Sample 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     flow_classify
47     flow_filtering
48     ip_frag
49     ipv4_multicast
50     ip_reassembly
51     kernel_nic_interface
52     keep_alive
53     l2_forward_crypto
54     l2_forward_job_stats
55     l2_forward_real_virtual
56     l2_forward_cat
57     l3_forward
58     l3_forward_power_man
59     l3_forward_access_ctrl
60     l3_forward_virtual
61     link_status_intr
62     load_balancer
63     server_node_efd
64     service_cores
65     multi_process
66     qos_metering
67     qos_scheduler
68     quota_watermark
69     timer
70     packet_ordering
71     vmdq_dcb_forwarding
72     vhost
73     vhost_scsi
74     netmap_compatibility
75     ip_pipeline
76     test_pipeline
77     eventdev_pipeline_sw_pmd
78     dist_app
79     vm_power_management
80     tep_termination
81     ptpclient
82     performance_thread
83     ipsec_secgw
84     bbdev_app
85
86 **Figures**
87
88 :numref:`figure_exception_path_example` :ref:`figure_exception_path_example`
89
90 :numref:`figure_kernel_nic` :ref:`figure_kernel_nic`
91
92 :numref:`figure_l2_fwd_benchmark_setup_jobstats` :ref:`figure_l2_fwd_benchmark_setup_jobstats`
93
94 :numref:`figure_l2_fwd_virtenv_benchmark_setup_jobstats` :ref:`figure_l2_fwd_virtenv_benchmark_setup_jobstats`
95
96 :numref:`figure_l2_fwd_benchmark_setup` :ref:`figure_l2_fwd_benchmark_setup`
97
98 :numref:`figure_l2_fwd_virtenv_benchmark_setup` :ref:`figure_l2_fwd_virtenv_benchmark_setup`
99
100 :numref:`figure_l2_fwd_encrypt_flow` :ref:`figure_l2_fwd_encrypt_flow`
101
102 :numref:`figure_ipv4_acl_rule` :ref:`figure_ipv4_acl_rule`
103
104 :numref:`figure_example_rules` :ref:`figure_example_rules`
105
106 :numref:`figure_load_bal_app_arch` :ref:`figure_load_bal_app_arch`
107
108 :numref:`figure_sym_multi_proc_app` :ref:`figure_sym_multi_proc_app`
109
110 :numref:`figure_client_svr_sym_multi_proc_app` :ref:`figure_client_svr_sym_multi_proc_app`
111
112 :numref:`figure_master_slave_proc` :ref:`figure_master_slave_proc`
113
114 :numref:`figure_slave_proc_recov` :ref:`figure_slave_proc_recov`
115
116 :numref:`figure_qos_sched_app_arch` :ref:`figure_qos_sched_app_arch`
117
118 :numref:`figure_pipeline_overview` :ref:`figure_pipeline_overview`
119
120 :numref:`figure_ring_pipeline_perf_setup` :ref:`figure_ring_pipeline_perf_setup`
121
122 :numref:`figure_threads_pipelines` :ref:`figure_threads_pipelines`
123
124 :numref:`figure_vmdq_dcb_example` :ref:`figure_vmdq_dcb_example`
125
126 :numref:`figure_test_pipeline_app` :ref:`figure_test_pipeline_app`
127
128 :numref:`figure_dist_perf` :ref:`figure_dist_perf`
129
130 :numref:`figure_dist_app` :ref:`figure_dist_app`
131
132 :numref:`figure_vm_power_mgr_highlevel` :ref:`figure_vm_power_mgr_highlevel`
133
134 :numref:`figure_vm_power_mgr_vm_request_seq` :ref:`figure_vm_power_mgr_vm_request_seq`
135 :numref:`figure_overlay_networking` :ref:`figure_overlay_networking`
136 :numref:`figure_tep_termination_arch` :ref:`figure_tep_termination_arch`
137
138 :numref:`figure_ptpclient_highlevel` :ref:`figure_ptpclient_highlevel`
139
140 :numref:`figure_efd_sample_app_overview` :ref:`figure_efd_sample_app_overview`
141
142 **Tables**
143
144 :numref:`table_qos_metering_1` :ref:`table_qos_metering_1`
145
146 :numref:`table_qos_scheduler_1` :ref:`table_qos_scheduler_1`
147
148 :numref:`table_test_pipeline_1` :ref:`table_test_pipeline_1`