New upstream version 18.11-rc1
[deb_dpdk.git] / doc / guides / sample_app_ug / index.rst
1 ..  SPDX-License-Identifier: BSD-3-Clause
2     Copyright(c) 2010-2015 Intel Corporation.
3
4 Sample Applications User Guides
5 ===============================
6
7 .. toctree::
8     :maxdepth: 2
9     :numbered:
10
11     intro
12     compiling
13     cmd_line
14     ethtool
15     exception_path
16     hello_world
17     skeleton
18     rxtx_callbacks
19     flow_classify
20     flow_filtering
21     ip_frag
22     ipv4_multicast
23     ip_reassembly
24     kernel_nic_interface
25     keep_alive
26     l2_forward_crypto
27     l2_forward_job_stats
28     l2_forward_real_virtual
29     l2_forward_cat
30     l3_forward
31     l3_forward_power_man
32     l3_forward_access_ctrl
33     l3_forward_virtual
34     link_status_intr
35     load_balancer
36     server_node_efd
37     service_cores
38     multi_process
39     qos_metering
40     qos_scheduler
41     quota_watermark
42     timer
43     packet_ordering
44     vmdq_dcb_forwarding
45     vhost
46     vhost_scsi
47     vhost_crypto
48     vdpa
49     netmap_compatibility
50     ip_pipeline
51     test_pipeline
52     eventdev_pipeline
53     dist_app
54     vm_power_management
55     tep_termination
56     ptpclient
57     performance_thread
58     ipsec_secgw
59     bbdev_app
60
61 **Figures**
62
63 :numref:`figure_exception_path_example` :ref:`figure_exception_path_example`
64
65 :numref:`figure_kernel_nic` :ref:`figure_kernel_nic`
66
67 :numref:`figure_l2_fwd_benchmark_setup_jobstats` :ref:`figure_l2_fwd_benchmark_setup_jobstats`
68
69 :numref:`figure_l2_fwd_virtenv_benchmark_setup_jobstats` :ref:`figure_l2_fwd_virtenv_benchmark_setup_jobstats`
70
71 :numref:`figure_l2_fwd_benchmark_setup` :ref:`figure_l2_fwd_benchmark_setup`
72
73 :numref:`figure_l2_fwd_virtenv_benchmark_setup` :ref:`figure_l2_fwd_virtenv_benchmark_setup`
74
75 :numref:`figure_l2_fwd_encrypt_flow` :ref:`figure_l2_fwd_encrypt_flow`
76
77 :numref:`figure_ipv4_acl_rule` :ref:`figure_ipv4_acl_rule`
78
79 :numref:`figure_example_rules` :ref:`figure_example_rules`
80
81 :numref:`figure_load_bal_app_arch` :ref:`figure_load_bal_app_arch`
82
83 :numref:`figure_sym_multi_proc_app` :ref:`figure_sym_multi_proc_app`
84
85 :numref:`figure_client_svr_sym_multi_proc_app` :ref:`figure_client_svr_sym_multi_proc_app`
86
87 :numref:`figure_qos_sched_app_arch` :ref:`figure_qos_sched_app_arch`
88
89 :numref:`figure_pipeline_overview` :ref:`figure_pipeline_overview`
90
91 :numref:`figure_ring_pipeline_perf_setup` :ref:`figure_ring_pipeline_perf_setup`
92
93 :numref:`figure_threads_pipelines` :ref:`figure_threads_pipelines`
94
95 :numref:`figure_vmdq_dcb_example` :ref:`figure_vmdq_dcb_example`
96
97 :numref:`figure_test_pipeline_app` :ref:`figure_test_pipeline_app`
98
99 :numref:`figure_dist_perf` :ref:`figure_dist_perf`
100
101 :numref:`figure_dist_app` :ref:`figure_dist_app`
102
103 :numref:`figure_vm_power_mgr_highlevel` :ref:`figure_vm_power_mgr_highlevel`
104
105 :numref:`figure_vm_power_mgr_vm_request_seq` :ref:`figure_vm_power_mgr_vm_request_seq`
106 :numref:`figure_overlay_networking` :ref:`figure_overlay_networking`
107 :numref:`figure_tep_termination_arch` :ref:`figure_tep_termination_arch`
108
109 :numref:`figure_ptpclient_highlevel` :ref:`figure_ptpclient_highlevel`
110
111 :numref:`figure_efd_sample_app_overview` :ref:`figure_efd_sample_app_overview`
112
113 **Tables**
114
115 :numref:`table_qos_metering_1` :ref:`table_qos_metering_1`
116
117 :numref:`table_qos_scheduler_1` :ref:`table_qos_scheduler_1`
118
119 :numref:`table_test_pipeline_1` :ref:`table_test_pipeline_1`