DPDK  20.11.0
doc/api/doxy-api-index.md
1 API
2 ===
3 
4 <!--
5  SPDX-License-Identifier: BSD-3-Clause
6  Copyright(c) 2013-2017 6WIND S.A.
7 -->
8 
9 The public API headers are grouped by topics:
10 
11 - **device**:
12  [dev] (@ref rte_dev.h),
13  [ethdev] (@ref rte_ethdev.h),
14  [ethctrl] (@ref rte_eth_ctrl.h),
15  [rte_flow] (@ref rte_flow.h),
16  [rte_tm] (@ref rte_tm.h),
17  [rte_mtr] (@ref rte_mtr.h),
18  [bbdev] (@ref rte_bbdev.h),
19  [cryptodev] (@ref rte_cryptodev.h),
20  [security] (@ref rte_security.h),
21  [compressdev] (@ref rte_compressdev.h),
22  [compress] (@ref rte_comp.h),
23  [regexdev] (@ref rte_regexdev.h),
24  [eventdev] (@ref rte_eventdev.h),
25  [event_eth_rx_adapter] (@ref rte_event_eth_rx_adapter.h),
26  [event_eth_tx_adapter] (@ref rte_event_eth_tx_adapter.h),
27  [event_timer_adapter] (@ref rte_event_timer_adapter.h),
28  [event_crypto_adapter] (@ref rte_event_crypto_adapter.h),
29  [rawdev] (@ref rte_rawdev.h),
30  [metrics] (@ref rte_metrics.h),
31  [bitrate] (@ref rte_bitrate.h),
32  [latency] (@ref rte_latencystats.h),
33  [devargs] (@ref rte_devargs.h),
34  [PCI] (@ref rte_pci.h),
35  [vdev] (@ref rte_bus_vdev.h),
36  [vfio] (@ref rte_vfio.h)
37 
38 - **device specific**:
39  [softnic] (@ref rte_eth_softnic.h),
40  [bond] (@ref rte_eth_bond.h),
41  [vhost] (@ref rte_vhost.h),
42  [vdpa] (@ref rte_vdpa.h),
43  [KNI] (@ref rte_kni.h),
44  [ark] (@ref rte_pmd_ark.h),
45  [ixgbe] (@ref rte_pmd_ixgbe.h),
46  [i40e] (@ref rte_pmd_i40e.h),
47  [ice] (@ref rte_pmd_ice.h),
48  [iavf] (@ref rte_pmd_iavf.h),
49  [ioat] (@ref rte_ioat_rawdev.h),
50  [bnxt] (@ref rte_pmd_bnxt.h),
51  [dpaa] (@ref rte_pmd_dpaa.h),
52  [dpaa2] (@ref rte_pmd_dpaa2.h),
53  [mlx5] (@ref rte_pmd_mlx5.h),
54  [dpaa2_mempool] (@ref rte_dpaa2_mempool.h),
55  [dpaa2_cmdif] (@ref rte_pmd_dpaa2_cmdif.h),
56  [dpaa2_qdma] (@ref rte_pmd_dpaa2_qdma.h),
57  [crypto_scheduler] (@ref rte_cryptodev_scheduler.h),
58  [dlb] (@ref rte_pmd_dlb.h),
59  [dlb2] (@ref rte_pmd_dlb2.h)
60 
61 - **memory**:
62  [memseg] (@ref rte_memory.h),
63  [memzone] (@ref rte_memzone.h),
64  [mempool] (@ref rte_mempool.h),
65  [malloc] (@ref rte_malloc.h),
66  [memcpy] (@ref rte_memcpy.h)
67 
68 - **timers**:
69  [cycles] (@ref rte_cycles.h),
70  [timer] (@ref rte_timer.h),
71  [alarm] (@ref rte_alarm.h)
72 
73 - **locks**:
74  [atomic] (@ref rte_atomic.h),
75  [mcslock] (@ref rte_mcslock.h),
76  [rwlock] (@ref rte_rwlock.h),
77  [spinlock] (@ref rte_spinlock.h),
78  [ticketlock] (@ref rte_ticketlock.h),
79  [RCU] (@ref rte_rcu_qsbr.h)
80 
81 - **CPU arch**:
82  [branch prediction] (@ref rte_branch_prediction.h),
83  [cache prefetch] (@ref rte_prefetch.h),
84  [SIMD] (@ref rte_vect.h),
85  [byte order] (@ref rte_byteorder.h),
86  [CPU flags] (@ref rte_cpuflags.h),
87  [CPU pause] (@ref rte_pause.h),
88  [I/O access] (@ref rte_io.h)
89 
90 - **CPU multicore**:
91  [interrupts] (@ref rte_interrupts.h),
92  [launch] (@ref rte_launch.h),
93  [lcore] (@ref rte_lcore.h),
94  [per-lcore] (@ref rte_per_lcore.h),
95  [service cores] (@ref rte_service.h),
96  [keepalive] (@ref rte_keepalive.h),
97  [power/freq] (@ref rte_power.h)
98 
99 - **layers**:
100  [ethernet] (@ref rte_ether.h),
101  [ARP] (@ref rte_arp.h),
102  [HIGIG] (@ref rte_higig.h),
103  [ICMP] (@ref rte_icmp.h),
104  [ESP] (@ref rte_esp.h),
105  [IPsec] (@ref rte_ipsec.h),
106  [IPsec group] (@ref rte_ipsec_group.h),
107  [IPsec SA] (@ref rte_ipsec_sa.h),
108  [IPsec SAD] (@ref rte_ipsec_sad.h),
109  [IP] (@ref rte_ip.h),
110  [frag/reass] (@ref rte_ip_frag.h),
111  [SCTP] (@ref rte_sctp.h),
112  [TCP] (@ref rte_tcp.h),
113  [UDP] (@ref rte_udp.h),
114  [GTP] (@ref rte_gtp.h),
115  [GRO] (@ref rte_gro.h),
116  [GSO] (@ref rte_gso.h),
117  [GRE] (@ref rte_gre.h),
118  [MPLS] (@ref rte_mpls.h),
119  [VXLAN] (@ref rte_vxlan.h),
120  [Geneve] (@ref rte_geneve.h),
121  [eCPRI] (@ref rte_ecpri.h)
122 
123 - **QoS**:
124  [metering] (@ref rte_meter.h),
125  [scheduler] (@ref rte_sched.h),
126  [RED congestion] (@ref rte_red.h)
127 
128 - **routing**:
129  [LPM IPv4 route] (@ref rte_lpm.h),
130  [LPM IPv6 route] (@ref rte_lpm6.h),
131  [RIB IPv4] (@ref rte_rib.h),
132  [RIB IPv6] (@ref rte_rib6.h),
133  [FIB IPv4] (@ref rte_fib.h),
134  [FIB IPv6] (@ref rte_fib6.h)
135 
136 - **hashes**:
137  [hash] (@ref rte_hash.h),
138  [jhash] (@ref rte_jhash.h),
139  [thash] (@ref rte_thash.h),
140  [FBK hash] (@ref rte_fbk_hash.h),
141  [CRC hash] (@ref rte_hash_crc.h)
142 
143 - **classification**
144  [reorder] (@ref rte_reorder.h),
145  [distributor] (@ref rte_distributor.h),
146  [EFD] (@ref rte_efd.h),
147  [ACL] (@ref rte_acl.h),
148  [member] (@ref rte_member.h),
149  [flow classify] (@ref rte_flow_classify.h),
150  [BPF] (@ref rte_bpf.h)
151 
152 - **containers**:
153  [mbuf] (@ref rte_mbuf.h),
154  [mbuf pool ops] (@ref rte_mbuf_pool_ops.h),
155  [ring] (@ref rte_ring.h),
156  [stack] (@ref rte_stack.h),
157  [tailq] (@ref rte_tailq.h),
158  [bitmap] (@ref rte_bitmap.h)
159 
160 - **packet framework**:
161  * [port] (@ref rte_port.h):
162  [ethdev] (@ref rte_port_ethdev.h),
163  [ring] (@ref rte_port_ring.h),
164  [frag] (@ref rte_port_frag.h),
165  [reass] (@ref rte_port_ras.h),
166  [sched] (@ref rte_port_sched.h),
167  [kni] (@ref rte_port_kni.h),
168  [src/sink] (@ref rte_port_source_sink.h)
169  * [table] (@ref rte_table.h):
170  [lpm IPv4] (@ref rte_table_lpm.h),
171  [lpm IPv6] (@ref rte_table_lpm_ipv6.h),
172  [ACL] (@ref rte_table_acl.h),
173  [hash] (@ref rte_table_hash.h),
174  [array] (@ref rte_table_array.h),
175  [stub] (@ref rte_table_stub.h)
176  * [pipeline] (@ref rte_pipeline.h)
177  [port_in_action] (@ref rte_port_in_action.h)
178  [table_action] (@ref rte_table_action.h)
179  * SWX pipeline:
180  [control] (@ref rte_swx_ctl.h),
181  [extern] (@ref rte_swx_extern.h),
182  [pipeline] (@ref rte_swx_pipeline.h)
183  * SWX port:
184  [port] (@ref rte_swx_port.h),
185  [ethdev] (@ref rte_swx_port_ethdev.h),
186  [src/sink] (@ref rte_swx_port_source_sink.h)
187  * SWX table:
188  [table] (@ref rte_swx_table.h),
189  [table_em] (@ref rte_swx_table_em.h)
190  * [graph] (@ref rte_graph.h):
191  [graph_worker] (@ref rte_graph_worker.h)
192  * graph_nodes:
193  [eth_node] (@ref rte_node_eth_api.h),
194  [ip4_node] (@ref rte_node_ip4_api.h)
195 
196 - **basic**:
197  [bitops] (@ref rte_bitops.h),
198  [approx fraction] (@ref rte_approx.h),
199  [random] (@ref rte_random.h),
200  [config file] (@ref rte_cfgfile.h),
201  [key/value args] (@ref rte_kvargs.h),
202  [string] (@ref rte_string_fns.h)
203 
204 - **debug**:
205  [jobstats] (@ref rte_jobstats.h),
206  [telemetry] (@ref rte_telemetry.h),
207  [pdump] (@ref rte_pdump.h),
208  [hexdump] (@ref rte_hexdump.h),
209  [debug] (@ref rte_debug.h),
210  [log] (@ref rte_log.h),
211  [errno] (@ref rte_errno.h),
212  [trace] (@ref rte_trace.h),
213  [trace_point] (@ref rte_trace_point.h)
214 
215 - **misc**:
216  [EAL config] (@ref rte_eal.h),
217  [common] (@ref rte_common.h),
218  [experimental APIs] (@ref rte_compat.h),
219  [ABI versioning] (@ref rte_function_versioning.h),
220  [version] (@ref rte_version.h)