[ceph.git] / ceph / src / dpdk / doc / guides / sample_app_ug / index.rst

..  BSD LICENSE
    Copyright(c) 2010-2015 Intel Corporation. All rights reserved.
    All rights reserved.

    Redistribution and use in source and binary forms, with or without
    modification, are permitted provided that the following conditions
    are met:

    * Redistributions of source code must retain the above copyright
    notice, this list of conditions and the following disclaimer.
    * Redistributions in binary form must reproduce the above copyright
    notice, this list of conditions and the following disclaimer in
    the documentation and/or other materials provided with the
    distribution.
    * Neither the name of Intel Corporation nor the names of its
    contributors may be used to endorse or promote products derived
    from this software without specific prior written permission.

    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
    "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
    A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
    OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
    SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
    LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
    DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
    THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
    (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
    OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Sample Applications User Guides
===============================

.. toctree::
    :maxdepth: 2
    :numbered:

    intro
    cmd_line
    ethtool
    exception_path
    hello_world
    skeleton
    rxtx_callbacks
    ip_frag
    ipv4_multicast
    ip_reassembly
    kernel_nic_interface
    keep_alive
    l2_forward_crypto
    l2_forward_job_stats
    l2_forward_real_virtual
    l2_forward_cat
    l3_forward
    l3_forward_power_man
    l3_forward_access_ctrl
    l3_forward_virtual
    link_status_intr
    load_balancer
    multi_process
    qos_metering
    qos_scheduler
    intel_quickassist
    quota_watermark
    timer
    packet_ordering
    vmdq_dcb_forwarding
    vhost
    netmap_compatibility
    ip_pipeline
    test_pipeline
    dist_app
    vm_power_management
    tep_termination
    ptpclient
    performance_thread
    ipsec_secgw

**Figures**

:numref:`figure_exception_path_example` :ref:`figure_exception_path_example`

:numref:`figure_kernel_nic` :ref:`figure_kernel_nic`

:numref:`figure_l2_fwd_benchmark_setup_jobstats` :ref:`figure_l2_fwd_benchmark_setup_jobstats`

:numref:`figure_l2_fwd_virtenv_benchmark_setup_jobstats` :ref:`figure_l2_fwd_virtenv_benchmark_setup_jobstats`

:numref:`figure_l2_fwd_benchmark_setup` :ref:`figure_l2_fwd_benchmark_setup`

:numref:`figure_l2_fwd_virtenv_benchmark_setup` :ref:`figure_l2_fwd_virtenv_benchmark_setup`

:numref:`figure_l2_fwd_encrypt_flow` :ref:`figure_l2_fwd_encrypt_flow`

:numref:`figure_ipv4_acl_rule` :ref:`figure_ipv4_acl_rule`

:numref:`figure_example_rules` :ref:`figure_example_rules`

:numref:`figure_load_bal_app_arch` :ref:`figure_load_bal_app_arch`

:numref:`figure_sym_multi_proc_app` :ref:`figure_sym_multi_proc_app`

:numref:`figure_client_svr_sym_multi_proc_app` :ref:`figure_client_svr_sym_multi_proc_app`

:numref:`figure_master_slave_proc` :ref:`figure_master_slave_proc`

:numref:`figure_slave_proc_recov` :ref:`figure_slave_proc_recov`

:numref:`figure_qos_sched_app_arch` :ref:`figure_qos_sched_app_arch`

:numref:`figure_quickassist_block_diagram` :ref:`figure_quickassist_block_diagram`

:numref:`figure_pipeline_overview` :ref:`figure_pipeline_overview`

:numref:`figure_ring_pipeline_perf_setup` :ref:`figure_ring_pipeline_perf_setup`

:numref:`figure_threads_pipelines` :ref:`figure_threads_pipelines`

:numref:`figure_vmdq_dcb_example` :ref:`figure_vmdq_dcb_example`

:numref:`figure_test_pipeline_app` :ref:`figure_test_pipeline_app`

:numref:`figure_dist_perf` :ref:`figure_dist_perf`

:numref:`figure_dist_app` :ref:`figure_dist_app`

:numref:`figure_vm_power_mgr_highlevel` :ref:`figure_vm_power_mgr_highlevel`

:numref:`figure_vm_power_mgr_vm_request_seq` :ref:`figure_vm_power_mgr_vm_request_seq`
:numref:`figure_overlay_networking` :ref:`figure_overlay_networking`
:numref:`figure_tep_termination_arch` :ref:`figure_tep_termination_arch`

:numref:`figure_ptpclient_highlevel` :ref:`figure_ptpclient_highlevel`

**Tables**

:numref:`table_qos_metering_1` :ref:`table_qos_metering_1`

:numref:`table_qos_scheduler_1` :ref:`table_qos_scheduler_1`

:numref:`table_test_pipeline_1` :ref:`table_test_pipeline_1`
Commit	Line	Data
7c673cae FG	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	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	ptpclient
76	performance_thread
77	ipsec_secgw
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_l2_fwd_encrypt_flow` :ref:`figure_l2_fwd_encrypt_flow`
94
95	:numref:`figure_ipv4_acl_rule` :ref:`figure_ipv4_acl_rule`
96
97	:numref:`figure_example_rules` :ref:`figure_example_rules`
98
99	:numref:`figure_load_bal_app_arch` :ref:`figure_load_bal_app_arch`
100
101	:numref:`figure_sym_multi_proc_app` :ref:`figure_sym_multi_proc_app`
102
103	:numref:`figure_client_svr_sym_multi_proc_app` :ref:`figure_client_svr_sym_multi_proc_app`
104
105	:numref:`figure_master_slave_proc` :ref:`figure_master_slave_proc`
106
107	:numref:`figure_slave_proc_recov` :ref:`figure_slave_proc_recov`
108
109	:numref:`figure_qos_sched_app_arch` :ref:`figure_qos_sched_app_arch`
110
111	:numref:`figure_quickassist_block_diagram` :ref:`figure_quickassist_block_diagram`
112
113	:numref:`figure_pipeline_overview` :ref:`figure_pipeline_overview`
114
115	:numref:`figure_ring_pipeline_perf_setup` :ref:`figure_ring_pipeline_perf_setup`
116
117	:numref:`figure_threads_pipelines` :ref:`figure_threads_pipelines`
118
119	:numref:`figure_vmdq_dcb_example` :ref:`figure_vmdq_dcb_example`
120
121	:numref:`figure_test_pipeline_app` :ref:`figure_test_pipeline_app`
122
123	:numref:`figure_dist_perf` :ref:`figure_dist_perf`
124
125	:numref:`figure_dist_app` :ref:`figure_dist_app`
126
127	:numref:`figure_vm_power_mgr_highlevel` :ref:`figure_vm_power_mgr_highlevel`
128
129	:numref:`figure_vm_power_mgr_vm_request_seq` :ref:`figure_vm_power_mgr_vm_request_seq`
130	:numref:`figure_overlay_networking` :ref:`figure_overlay_networking`
131	:numref:`figure_tep_termination_arch` :ref:`figure_tep_termination_arch`
132
133	:numref:`figure_ptpclient_highlevel` :ref:`figure_ptpclient_highlevel`
134
135	Tables
136
137	:numref:`table_qos_metering_1` :ref:`table_qos_metering_1`
138
139	:numref:`table_qos_scheduler_1` :ref:`table_qos_scheduler_1`
140
141	:numref:`table_test_pipeline_1` :ref:`table_test_pipeline_1`