xref: /dpdk/doc/guides/prog_guide/index.rst (revision 776d4753893335d43011f97b08d422b84a54b16c)
1..  SPDX-License-Identifier: BSD-3-Clause
2    Copyright(c) 2010-2017 Intel Corporation.
3
4Programmer's Guide
5==================
6
7Foundation Principles
8---------------------
9
10.. toctree::
11    :maxdepth: 1
12    :numbered:
13
14    intro
15    overview
16    source_org
17    glossary
18
19
20Memory Management
21-----------------
22
23.. toctree::
24    :maxdepth: 1
25    :numbered:
26
27    lcore_var
28    mempool_lib
29    mbuf_lib
30    multi_proc_support
31
32
33CPU Management
34--------------
35
36.. toctree::
37    :maxdepth: 1
38    :numbered:
39
40    env_abstraction_layer
41    power_man
42    thread_safety
43    service_cores
44
45
46CPU Packet Processing
47---------------------
48
49.. toctree::
50    :maxdepth: 1
51    :numbered:
52
53    toeplitz_hash_lib
54    hash_lib
55    member_lib
56    ip_fragment_reassembly_lib
57    generic_receive_offload_lib
58    generic_segmentation_offload_lib
59    packet_classif_access_ctrl
60    packet_distrib_lib
61    efd_lib
62    reorder_lib
63    lpm_lib
64    lpm6_lib
65    rib_lib
66    fib_lib
67
68
69Device Libraries
70----------------
71
72.. toctree::
73    :maxdepth: 1
74    :numbered:
75
76    ethdev/index
77    link_bonding_poll_mode_drv_lib
78    vhost_lib
79    cryptodev_lib
80    rte_security
81    compressdev
82    regexdev
83    bbdev
84    mldev
85    dmadev
86    gpudev
87    rawdev
88    eventdev/index
89
90
91Protocol Processing Libraries
92-----------------------------
93
94.. toctree::
95    :maxdepth: 1
96    :numbered:
97
98    pdcp_lib
99    ipsec_lib
100
101
102High-Level Libraries
103--------------------
104
105.. toctree::
106    :maxdepth: 1
107    :numbered:
108
109    packet_framework
110    graph_lib
111
112
113Utility Libraries
114-----------------
115
116.. toctree::
117    :maxdepth: 1
118    :numbered:
119
120    argparse_lib
121    cmdline
122    ptr_compress_lib
123    timer_lib
124    rcu_lib
125    ring_lib
126    stack_lib
127    log_lib
128    metrics_lib
129    telemetry_lib
130    pdump_lib
131    pcapng_lib
132    bpf_lib
133    trace_lib
134
135
136Howto Guides
137-------------
138
139.. toctree::
140    :maxdepth: 1
141    :numbered:
142
143    build-sdk-meson
144    meson_ut
145    build_app
146
147
148Tips & Tricks
149-------------
150
151.. toctree::
152    :maxdepth: 1
153    :numbered:
154
155    perf_opt_guidelines
156    writing_efficient_code
157    lto
158    profile_app
159    asan
160