index.rst revision 97f17497
1..  BSD LICENSE
2    Copyright(c) 2010-2014 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
31Programmer's Guide
32==================
33
34.. toctree::
35    :maxdepth: 3
36    :numbered:
37
38    intro
39    overview
40    env_abstraction_layer
41    ring_lib
42    mempool_lib
43    mbuf_lib
44    poll_mode_drv
45    cryptodev_lib
46    ivshmem_lib
47    link_bonding_poll_mode_drv_lib
48    timer_lib
49    hash_lib
50    lpm_lib
51    lpm6_lib
52    packet_distrib_lib
53    reorder_lib
54    ip_fragment_reassembly_lib
55    multi_proc_support
56    kernel_nic_interface
57    thread_safety_dpdk_functions
58    qos_framework
59    power_man
60    packet_classif_access_ctrl
61    packet_framework
62    vhost_lib
63    port_hotplug_framework
64    source_org
65    dev_kit_build_system
66    dev_kit_root_make_help
67    extend_dpdk
68    build_app
69    ext_app_lib_make_help
70    perf_opt_guidelines
71    writing_efficient_code
72    profile_app
73    glossary
74
75
76**Figures**
77
78:numref:`figure_architecture-overview` :ref:`figure_architecture-overview`
79
80:numref:`figure_linuxapp_launch` :ref:`figure_linuxapp_launch`
81
82:numref:`figure_malloc_heap` :ref:`figure_malloc_heap`
83
84:numref:`figure_ring1` :ref:`figure_ring1`
85
86:numref:`figure_ring-enqueue1` :ref:`figure_ring-enqueue1`
87
88:numref:`figure_ring-enqueue2` :ref:`figure_ring-enqueue2`
89
90:numref:`figure_ring-enqueue3` :ref:`figure_ring-enqueue3`
91
92:numref:`figure_ring-dequeue1` :ref:`figure_ring-dequeue1`
93
94:numref:`figure_ring-dequeue2` :ref:`figure_ring-dequeue2`
95
96:numref:`figure_ring-dequeue3` :ref:`figure_ring-dequeue3`
97
98:numref:`figure_ring-mp-enqueue1` :ref:`figure_ring-mp-enqueue1`
99
100:numref:`figure_ring-mp-enqueue2` :ref:`figure_ring-mp-enqueue2`
101
102:numref:`figure_ring-mp-enqueue3` :ref:`figure_ring-mp-enqueue3`
103
104:numref:`figure_ring-mp-enqueue4` :ref:`figure_ring-mp-enqueue4`
105
106:numref:`figure_ring-mp-enqueue5` :ref:`figure_ring-mp-enqueue5`
107
108:numref:`figure_ring-modulo1` :ref:`figure_ring-modulo1`
109
110:numref:`figure_ring-modulo2` :ref:`figure_ring-modulo2`
111
112:numref:`figure_memory-management` :ref:`figure_memory-management`
113
114:numref:`figure_memory-management2` :ref:`figure_memory-management2`
115
116:numref:`figure_mempool` :ref:`figure_mempool`
117
118:numref:`figure_mbuf1` :ref:`figure_mbuf1`
119
120:numref:`figure_mbuf2` :ref:`figure_mbuf2`
121
122:numref:`figure_multi_process_memory` :ref:`figure_multi_process_memory`
123
124:numref:`figure_kernel_nic_intf` :ref:`figure_kernel_nic_intf`
125
126:numref:`figure_pkt_flow_kni` :ref:`figure_pkt_flow_kni`
127
128:numref:`figure_vhost_net_arch2` :ref:`figure_vhost_net_arch2`
129
130:numref:`figure_kni_traffic_flow` :ref:`figure_kni_traffic_flow`
131
132
133:numref:`figure_pkt_proc_pipeline_qos` :ref:`figure_pkt_proc_pipeline_qos`
134
135:numref:`figure_hier_sched_blk` :ref:`figure_hier_sched_blk`
136
137:numref:`figure_sched_hier_per_port` :ref:`figure_sched_hier_per_port`
138
139:numref:`figure_data_struct_per_port` :ref:`figure_data_struct_per_port`
140
141:numref:`figure_prefetch_pipeline` :ref:`figure_prefetch_pipeline`
142
143:numref:`figure_pipe_prefetch_sm` :ref:`figure_pipe_prefetch_sm`
144
145:numref:`figure_blk_diag_dropper` :ref:`figure_blk_diag_dropper`
146
147:numref:`figure_flow_tru_droppper` :ref:`figure_flow_tru_droppper`
148
149:numref:`figure_ex_data_flow_tru_dropper` :ref:`figure_ex_data_flow_tru_dropper`
150
151:numref:`figure_pkt_drop_probability` :ref:`figure_pkt_drop_probability`
152
153:numref:`figure_drop_probability_graph` :ref:`figure_drop_probability_graph`
154
155:numref:`figure_figure32` :ref:`figure_figure32`
156
157:numref:`figure_figure33` :ref:`figure_figure33`
158
159:numref:`figure_figure34` :ref:`figure_figure34`
160
161:numref:`figure_figure35` :ref:`figure_figure35`
162
163:numref:`figure_figure37` :ref:`figure_figure37`
164
165:numref:`figure_figure38` :ref:`figure_figure38`
166
167:numref:`figure_figure39` :ref:`figure_figure39`
168
169
170**Tables**
171
172:numref:`table_qos_1` :ref:`table_qos_1`
173
174:numref:`table_qos_2` :ref:`table_qos_2`
175
176:numref:`table_qos_3` :ref:`table_qos_3`
177
178:numref:`table_qos_4` :ref:`table_qos_4`
179
180:numref:`table_qos_5` :ref:`table_qos_5`
181
182:numref:`table_qos_6` :ref:`table_qos_6`
183
184:numref:`table_qos_7` :ref:`table_qos_7`
185
186:numref:`table_qos_8` :ref:`table_qos_8`
187
188:numref:`table_qos_9` :ref:`table_qos_9`
189
190:numref:`table_qos_10` :ref:`table_qos_10`
191
192:numref:`table_qos_11` :ref:`table_qos_11`
193
194:numref:`table_qos_12` :ref:`table_qos_12`
195
196:numref:`table_qos_13` :ref:`table_qos_13`
197
198:numref:`table_qos_14` :ref:`table_qos_14`
199
200:numref:`table_qos_15` :ref:`table_qos_15`
201
202:numref:`table_qos_16` :ref:`table_qos_16`
203
204:numref:`table_qos_17` :ref:`table_qos_17`
205
206:numref:`table_qos_18` :ref:`table_qos_18`
207
208:numref:`table_qos_19` :ref:`table_qos_19`
209
210:numref:`table_qos_20` :ref:`table_qos_20`
211
212:numref:`table_qos_21` :ref:`table_qos_21`
213
214:numref:`table_qos_22` :ref:`table_qos_22`
215
216:numref:`table_qos_23` :ref:`table_qos_23`
217
218:numref:`table_qos_24` :ref:`table_qos_24`
219
220:numref:`table_qos_25` :ref:`table_qos_25`
221
222:numref:`table_qos_26` :ref:`table_qos_26`
223
224:numref:`table_qos_27` :ref:`table_qos_27`
225
226:numref:`table_qos_28` :ref:`table_qos_28`
227
228:numref:`table_qos_29` :ref:`table_qos_29`
229
230:numref:`table_qos_30` :ref:`table_qos_30`
231
232:numref:`table_qos_31` :ref:`table_qos_31`
233
234:numref:`table_qos_32` :ref:`table_qos_32`
235
236:numref:`table_qos_33` :ref:`table_qos_33`
237
238:numref:`table_qos_34` :ref:`table_qos_34`
239
240:numref:`table_hash_lib_1` :ref:`table_hash_lib_1`
241
242:numref:`table_hash_lib_2` :ref:`table_hash_lib_2`
243