xref: /dpdk/doc/guides/prog_guide/index.rst (revision a584d3bea902cf52a7d07b8a5a6cd1318dfcf88b)
15630257fSFerruh Yigit..  SPDX-License-Identifier: BSD-3-Clause
25630257fSFerruh Yigit    Copyright(c) 2010-2017 Intel Corporation.
3fc1f2750SBernard Iremonger
4fc1f2750SBernard IremongerProgrammer's Guide
5fc1f2750SBernard Iremonger==================
6fc1f2750SBernard Iremonger
7fc1f2750SBernard Iremonger.. toctree::
8fc1f2750SBernard Iremonger    :maxdepth: 3
9fc1f2750SBernard Iremonger    :numbered:
10fc1f2750SBernard Iremonger
11fc1f2750SBernard Iremonger    intro
12fc1f2750SBernard Iremonger    overview
13fc1f2750SBernard Iremonger    env_abstraction_layer
1421698354SHarry van Haaren    service_cores
15fc1f2750SBernard Iremonger    ring_lib
16fc1f2750SBernard Iremonger    mempool_lib
17fc1f2750SBernard Iremonger    mbuf_lib
18fc1f2750SBernard Iremonger    poll_mode_drv
194d73b6fbSAdrien Mazarguil    rte_flow
20b7f859c9SDeclan Doherty    switch_representation
215bf4bebbSCristian Dumitrescu    traffic_metering_and_policing
22e660897dSJasvinder Singh    traffic_management
234935e1e9SAmr Mokhtar    bbdev
240318c02bSDeclan Doherty    cryptodev_lib
25*a584d3beSAshish Gupta    compressdev
2640ff8c99SAkhil Goyal    rte_security
27a9bb0c44SShreyansh Jain    rawdev
28fc1f2750SBernard Iremonger    link_bonding_poll_mode_drv_lib
29fc1f2750SBernard Iremonger    timer_lib
30fc1f2750SBernard Iremonger    hash_lib
310dd62a01SPablo de Lara    efd_lib
3255694b2aSYipeng Wang    member_lib
33fc1f2750SBernard Iremonger    lpm_lib
34fc1f2750SBernard Iremonger    lpm6_lib
35fdec9301SBernard Iremonger    flow_classify_lib
36fc1f2750SBernard Iremonger    packet_distrib_lib
3734287c69SSergio Gonzalez Monroy    reorder_lib
38fc1f2750SBernard Iremonger    ip_fragment_reassembly_lib
392c900d09SJiayu Hu    generic_receive_offload_lib
40f6010c76SMark Kavanagh    generic_segmentation_offload_lib
41278f9454SReshma Pattan    pdump_lib
42fc1f2750SBernard Iremonger    multi_proc_support
43fc1f2750SBernard Iremonger    kernel_nic_interface
444b152471SThomas Monjalon    thread_safety_dpdk_functions
457358c91fSHarry van Haaren    eventdev
463ffa6809SNikhil Rao    event_ethernet_rx_adapter
4730e7fbd6SErik Gabriel Carrillo    event_timer_adapter
487b51fc96SAbhinandan Gujjar    event_crypto_adapter
49fc1f2750SBernard Iremonger    qos_framework
50fc1f2750SBernard Iremonger    power_man
51fc1f2750SBernard Iremonger    packet_classif_access_ctrl
52fc1f2750SBernard Iremonger    packet_framework
530ee5e7fbSSiobhan Butler    vhost_lib
54349950ddSRemy Horton    metrics_lib
550cf92e62STetsuya Mukawa    port_hotplug_framework
56fc1f2750SBernard Iremonger    source_org
57fc1f2750SBernard Iremonger    dev_kit_build_system
58fc1f2750SBernard Iremonger    dev_kit_root_make_help
594b152471SThomas Monjalon    extend_dpdk
60fc1f2750SBernard Iremonger    build_app
61fc1f2750SBernard Iremonger    ext_app_lib_make_help
62fc1f2750SBernard Iremonger    perf_opt_guidelines
63fc1f2750SBernard Iremonger    writing_efficient_code
64fc1f2750SBernard Iremonger    profile_app
65fc1f2750SBernard Iremonger    glossary
66fc1f2750SBernard Iremonger
67fc1f2750SBernard Iremonger
68fc1f2750SBernard Iremonger**Figures**
69fc1f2750SBernard Iremonger
704a22e6eeSJohn McNamara:numref:`figure_architecture-overview` :ref:`figure_architecture-overview`
71fc1f2750SBernard Iremonger
724a22e6eeSJohn McNamara:numref:`figure_linuxapp_launch` :ref:`figure_linuxapp_launch`
73fc1f2750SBernard Iremonger
744a22e6eeSJohn McNamara:numref:`figure_malloc_heap` :ref:`figure_malloc_heap`
75fc1f2750SBernard Iremonger
764a22e6eeSJohn McNamara:numref:`figure_ring1` :ref:`figure_ring1`
77fc1f2750SBernard Iremonger
784a22e6eeSJohn McNamara:numref:`figure_ring-enqueue1` :ref:`figure_ring-enqueue1`
79fc1f2750SBernard Iremonger
804a22e6eeSJohn McNamara:numref:`figure_ring-enqueue2` :ref:`figure_ring-enqueue2`
81fc1f2750SBernard Iremonger
824a22e6eeSJohn McNamara:numref:`figure_ring-enqueue3` :ref:`figure_ring-enqueue3`
83fc1f2750SBernard Iremonger
844a22e6eeSJohn McNamara:numref:`figure_ring-dequeue1` :ref:`figure_ring-dequeue1`
85fc1f2750SBernard Iremonger
864a22e6eeSJohn McNamara:numref:`figure_ring-dequeue2` :ref:`figure_ring-dequeue2`
87fc1f2750SBernard Iremonger
884a22e6eeSJohn McNamara:numref:`figure_ring-dequeue3` :ref:`figure_ring-dequeue3`
89fc1f2750SBernard Iremonger
904a22e6eeSJohn McNamara:numref:`figure_ring-mp-enqueue1` :ref:`figure_ring-mp-enqueue1`
91fc1f2750SBernard Iremonger
924a22e6eeSJohn McNamara:numref:`figure_ring-mp-enqueue2` :ref:`figure_ring-mp-enqueue2`
93fc1f2750SBernard Iremonger
944a22e6eeSJohn McNamara:numref:`figure_ring-mp-enqueue3` :ref:`figure_ring-mp-enqueue3`
95fc1f2750SBernard Iremonger
964a22e6eeSJohn McNamara:numref:`figure_ring-mp-enqueue4` :ref:`figure_ring-mp-enqueue4`
97fc1f2750SBernard Iremonger
984a22e6eeSJohn McNamara:numref:`figure_ring-mp-enqueue5` :ref:`figure_ring-mp-enqueue5`
99fc1f2750SBernard Iremonger
1004a22e6eeSJohn McNamara:numref:`figure_ring-modulo1` :ref:`figure_ring-modulo1`
101fc1f2750SBernard Iremonger
1024a22e6eeSJohn McNamara:numref:`figure_ring-modulo2` :ref:`figure_ring-modulo2`
103fc1f2750SBernard Iremonger
1044a22e6eeSJohn McNamara:numref:`figure_memory-management` :ref:`figure_memory-management`
105fc1f2750SBernard Iremonger
1064a22e6eeSJohn McNamara:numref:`figure_memory-management2` :ref:`figure_memory-management2`
107fc1f2750SBernard Iremonger
1084a22e6eeSJohn McNamara:numref:`figure_mempool` :ref:`figure_mempool`
109fc1f2750SBernard Iremonger
1104a22e6eeSJohn McNamara:numref:`figure_mbuf1` :ref:`figure_mbuf1`
111fc1f2750SBernard Iremonger
1124a22e6eeSJohn McNamara:numref:`figure_mbuf2` :ref:`figure_mbuf2`
113fc1f2750SBernard Iremonger
1144a22e6eeSJohn McNamara:numref:`figure_multi_process_memory` :ref:`figure_multi_process_memory`
115fc1f2750SBernard Iremonger
1164a22e6eeSJohn McNamara:numref:`figure_kernel_nic_intf` :ref:`figure_kernel_nic_intf`
117fc1f2750SBernard Iremonger
1184a22e6eeSJohn McNamara:numref:`figure_pkt_flow_kni` :ref:`figure_pkt_flow_kni`
119fc1f2750SBernard Iremonger
120fc1f2750SBernard Iremonger
1214a22e6eeSJohn McNamara:numref:`figure_pkt_proc_pipeline_qos` :ref:`figure_pkt_proc_pipeline_qos`
122fc1f2750SBernard Iremonger
1234a22e6eeSJohn McNamara:numref:`figure_hier_sched_blk` :ref:`figure_hier_sched_blk`
124fc1f2750SBernard Iremonger
1254a22e6eeSJohn McNamara:numref:`figure_sched_hier_per_port` :ref:`figure_sched_hier_per_port`
126fc1f2750SBernard Iremonger
1274a22e6eeSJohn McNamara:numref:`figure_data_struct_per_port` :ref:`figure_data_struct_per_port`
128fc1f2750SBernard Iremonger
1294a22e6eeSJohn McNamara:numref:`figure_prefetch_pipeline` :ref:`figure_prefetch_pipeline`
1304a22e6eeSJohn McNamara
1314a22e6eeSJohn McNamara:numref:`figure_pipe_prefetch_sm` :ref:`figure_pipe_prefetch_sm`
1324a22e6eeSJohn McNamara
1334a22e6eeSJohn McNamara:numref:`figure_blk_diag_dropper` :ref:`figure_blk_diag_dropper`
1344a22e6eeSJohn McNamara
1354a22e6eeSJohn McNamara:numref:`figure_flow_tru_droppper` :ref:`figure_flow_tru_droppper`
1364a22e6eeSJohn McNamara
1374a22e6eeSJohn McNamara:numref:`figure_ex_data_flow_tru_dropper` :ref:`figure_ex_data_flow_tru_dropper`
1384a22e6eeSJohn McNamara
1394a22e6eeSJohn McNamara:numref:`figure_pkt_drop_probability` :ref:`figure_pkt_drop_probability`
1404a22e6eeSJohn McNamara
1414a22e6eeSJohn McNamara:numref:`figure_drop_probability_graph` :ref:`figure_drop_probability_graph`
1424a22e6eeSJohn McNamara
1434a22e6eeSJohn McNamara:numref:`figure_figure32` :ref:`figure_figure32`
1444a22e6eeSJohn McNamara
1454a22e6eeSJohn McNamara:numref:`figure_figure33` :ref:`figure_figure33`
1464a22e6eeSJohn McNamara
1474a22e6eeSJohn McNamara:numref:`figure_figure34` :ref:`figure_figure34`
1484a22e6eeSJohn McNamara
1494a22e6eeSJohn McNamara:numref:`figure_figure35` :ref:`figure_figure35`
1504a22e6eeSJohn McNamara
1514a22e6eeSJohn McNamara:numref:`figure_figure37` :ref:`figure_figure37`
1524a22e6eeSJohn McNamara
1534a22e6eeSJohn McNamara:numref:`figure_figure38` :ref:`figure_figure38`
1544a22e6eeSJohn McNamara
1554a22e6eeSJohn McNamara:numref:`figure_figure39` :ref:`figure_figure39`
1564a22e6eeSJohn McNamara
1570dd62a01SPablo de Lara:numref:`figure_efd1` :ref:`figure_efd1`
1580dd62a01SPablo de Lara
1590dd62a01SPablo de Lara:numref:`figure_efd2` :ref:`figure_efd2`
1600dd62a01SPablo de Lara
1610dd62a01SPablo de Lara:numref:`figure_efd3` :ref:`figure_efd3`
1620dd62a01SPablo de Lara
1630dd62a01SPablo de Lara:numref:`figure_efd4` :ref:`figure_efd4`
1640dd62a01SPablo de Lara
1650dd62a01SPablo de Lara:numref:`figure_efd5` :ref:`figure_efd5`
1660dd62a01SPablo de Lara
1670dd62a01SPablo de Lara:numref:`figure_efd6` :ref:`figure_efd6`
1680dd62a01SPablo de Lara
1690dd62a01SPablo de Lara:numref:`figure_efd7` :ref:`figure_efd7`
1700dd62a01SPablo de Lara
1710dd62a01SPablo de Lara:numref:`figure_efd8` :ref:`figure_efd8`
1720dd62a01SPablo de Lara
1730dd62a01SPablo de Lara:numref:`figure_efd9` :ref:`figure_efd9`
1740dd62a01SPablo de Lara
1750dd62a01SPablo de Lara:numref:`figure_efd10` :ref:`figure_efd10`
1760dd62a01SPablo de Lara
1770dd62a01SPablo de Lara:numref:`figure_efd11` :ref:`figure_efd11`
1780dd62a01SPablo de Lara
17955694b2aSYipeng Wang:numref:`figure_membership1` :ref:`figure_membership1`
18055694b2aSYipeng Wang
18155694b2aSYipeng Wang:numref:`figure_membership2` :ref:`figure_membership2`
18255694b2aSYipeng Wang
18355694b2aSYipeng Wang:numref:`figure_membership3` :ref:`figure_membership3`
18455694b2aSYipeng Wang
18555694b2aSYipeng Wang:numref:`figure_membership4` :ref:`figure_membership4`
18655694b2aSYipeng Wang
18755694b2aSYipeng Wang:numref:`figure_membership5` :ref:`figure_membership5`
18855694b2aSYipeng Wang
18955694b2aSYipeng Wang:numref:`figure_membership6` :ref:`figure_membership6`
19055694b2aSYipeng Wang
19155694b2aSYipeng Wang:numref:`figure_membership7` :ref:`figure_membership7`
192fc1f2750SBernard Iremonger
193fc1f2750SBernard Iremonger**Tables**
194fc1f2750SBernard Iremonger
1958c9a3374SJohn McNamara:numref:`table_qos_1` :ref:`table_qos_1`
196fc1f2750SBernard Iremonger
1978c9a3374SJohn McNamara:numref:`table_qos_2` :ref:`table_qos_2`
198fc1f2750SBernard Iremonger
1998c9a3374SJohn McNamara:numref:`table_qos_3` :ref:`table_qos_3`
200fc1f2750SBernard Iremonger
2018c9a3374SJohn McNamara:numref:`table_qos_4` :ref:`table_qos_4`
202fc1f2750SBernard Iremonger
2038c9a3374SJohn McNamara:numref:`table_qos_5` :ref:`table_qos_5`
204fc1f2750SBernard Iremonger
2058c9a3374SJohn McNamara:numref:`table_qos_6` :ref:`table_qos_6`
206fc1f2750SBernard Iremonger
2078c9a3374SJohn McNamara:numref:`table_qos_7` :ref:`table_qos_7`
208fc1f2750SBernard Iremonger
2098c9a3374SJohn McNamara:numref:`table_qos_8` :ref:`table_qos_8`
210fc1f2750SBernard Iremonger
2118c9a3374SJohn McNamara:numref:`table_qos_9` :ref:`table_qos_9`
212fc1f2750SBernard Iremonger
2138c9a3374SJohn McNamara:numref:`table_qos_10` :ref:`table_qos_10`
214fc1f2750SBernard Iremonger
2158c9a3374SJohn McNamara:numref:`table_qos_11` :ref:`table_qos_11`
216fc1f2750SBernard Iremonger
2178c9a3374SJohn McNamara:numref:`table_qos_12` :ref:`table_qos_12`
218fc1f2750SBernard Iremonger
2198c9a3374SJohn McNamara:numref:`table_qos_13` :ref:`table_qos_13`
220fc1f2750SBernard Iremonger
2218c9a3374SJohn McNamara:numref:`table_qos_14` :ref:`table_qos_14`
222fc1f2750SBernard Iremonger
2238c9a3374SJohn McNamara:numref:`table_qos_15` :ref:`table_qos_15`
224fc1f2750SBernard Iremonger
2258c9a3374SJohn McNamara:numref:`table_qos_16` :ref:`table_qos_16`
226fc1f2750SBernard Iremonger
2278c9a3374SJohn McNamara:numref:`table_qos_17` :ref:`table_qos_17`
228fc1f2750SBernard Iremonger
2298c9a3374SJohn McNamara:numref:`table_qos_18` :ref:`table_qos_18`
230fc1f2750SBernard Iremonger
2318c9a3374SJohn McNamara:numref:`table_qos_19` :ref:`table_qos_19`
232fc1f2750SBernard Iremonger
2338c9a3374SJohn McNamara:numref:`table_qos_20` :ref:`table_qos_20`
234fc1f2750SBernard Iremonger
2358c9a3374SJohn McNamara:numref:`table_qos_21` :ref:`table_qos_21`
236fc1f2750SBernard Iremonger
2378c9a3374SJohn McNamara:numref:`table_qos_22` :ref:`table_qos_22`
238fc1f2750SBernard Iremonger
2398c9a3374SJohn McNamara:numref:`table_qos_23` :ref:`table_qos_23`
240fc1f2750SBernard Iremonger
2418c9a3374SJohn McNamara:numref:`table_qos_24` :ref:`table_qos_24`
242fc1f2750SBernard Iremonger
2438c9a3374SJohn McNamara:numref:`table_qos_25` :ref:`table_qos_25`
244fc1f2750SBernard Iremonger
2458c9a3374SJohn McNamara:numref:`table_qos_26` :ref:`table_qos_26`
246fc1f2750SBernard Iremonger
2478c9a3374SJohn McNamara:numref:`table_qos_27` :ref:`table_qos_27`
248fc1f2750SBernard Iremonger
2498c9a3374SJohn McNamara:numref:`table_qos_28` :ref:`table_qos_28`
250fc1f2750SBernard Iremonger
2518c9a3374SJohn McNamara:numref:`table_qos_29` :ref:`table_qos_29`
252fc1f2750SBernard Iremonger
2538c9a3374SJohn McNamara:numref:`table_qos_30` :ref:`table_qos_30`
254fc1f2750SBernard Iremonger
2558c9a3374SJohn McNamara:numref:`table_qos_31` :ref:`table_qos_31`
256fc1f2750SBernard Iremonger
2578c9a3374SJohn McNamara:numref:`table_qos_32` :ref:`table_qos_32`
258fc1f2750SBernard Iremonger
2598c9a3374SJohn McNamara:numref:`table_qos_33` :ref:`table_qos_33`
260fc1f2750SBernard Iremonger
2618c9a3374SJohn McNamara:numref:`table_qos_34` :ref:`table_qos_34`
26227bd48ffSPablo de Lara
26327bd48ffSPablo de Lara:numref:`table_hash_lib_1` :ref:`table_hash_lib_1`
26427bd48ffSPablo de Lara
26527bd48ffSPablo de Lara:numref:`table_hash_lib_2` :ref:`table_hash_lib_2`
266