xref: /dpdk/doc/guides/prog_guide/index.rst (revision 1e472b5746aeb6189fa254ab82ce4cd27999f868)
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    mempool_lib
28    mbuf_lib
29    multi_proc_support
30
31
32CPU Management
33--------------
34
35.. toctree::
36    :maxdepth: 1
37    :numbered:
38
39    env_abstraction_layer
40    power_man
41    thread_safety
42    service_cores
43
44
45CPU Packet Processing
46---------------------
47
48.. toctree::
49    :maxdepth: 1
50    :numbered:
51
52    toeplitz_hash_lib
53    hash_lib
54    member_lib
55    ip_fragment_reassembly_lib
56    generic_receive_offload_lib
57    generic_segmentation_offload_lib
58    packet_classif_access_ctrl
59    packet_distrib_lib
60    efd_lib
61    reorder_lib
62    lpm_lib
63    lpm6_lib
64    rib_lib
65    fib_lib
66
67
68Device Libraries
69----------------
70
71.. toctree::
72    :maxdepth: 1
73    :numbered:
74
75    ethdev/index
76    link_bonding_poll_mode_drv_lib
77    vhost_lib
78    cryptodev_lib
79    rte_security
80    compressdev
81    regexdev
82    bbdev
83    mldev
84    dmadev
85    gpudev
86    rawdev
87    eventdev/index
88
89
90Protocol Processing Libraries
91-----------------------------
92
93.. toctree::
94    :maxdepth: 1
95    :numbered:
96
97    pdcp_lib
98    ipsec_lib
99
100
101High-Level Libraries
102--------------------
103
104.. toctree::
105    :maxdepth: 1
106    :numbered:
107
108    packet_framework
109    graph_lib
110
111
112Utility Libraries
113-----------------
114
115.. toctree::
116    :maxdepth: 1
117    :numbered:
118
119    argparse_lib
120    cmdline
121    ptr_compress_lib
122    timer_lib
123    rcu_lib
124    ring_lib
125    stack_lib
126    log_lib
127    metrics_lib
128    telemetry_lib
129    pdump_lib
130    pcapng_lib
131    bpf_lib
132    trace_lib
133
134
135Howto Guides
136-------------
137
138.. toctree::
139    :maxdepth: 1
140    :numbered:
141
142    build-sdk-meson
143    meson_ut
144    build_app
145
146
147Tips & Tricks
148-------------
149
150.. toctree::
151    :maxdepth: 1
152    :numbered:
153
154    perf_opt_guidelines
155    writing_efficient_code
156    lto
157    profile_app
158    asan
159