xref: /dpdk/doc/api/doxy-api-index.md (revision 5a441543615a6893db7862bbc7d224795ed9ac5e)
1API {#index}
2===
3
4<!--
5  SPDX-License-Identifier: BSD-3-Clause
6  Copyright(c) 2013-2017 6WIND S.A.
7-->
8
9The 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  [eventdev]           (@ref rte_eventdev.h),
24  [event_eth_rx_adapter]   (@ref rte_event_eth_rx_adapter.h),
25  [event_timer_adapter]    (@ref rte_event_timer_adapter.h),
26  [event_crypto_adapter]   (@ref rte_event_crypto_adapter.h),
27  [rawdev]             (@ref rte_rawdev.h),
28  [metrics]            (@ref rte_metrics.h),
29  [bitrate]            (@ref rte_bitrate.h),
30  [latency]            (@ref rte_latencystats.h),
31  [devargs]            (@ref rte_devargs.h),
32  [PCI]                (@ref rte_pci.h),
33  [vfio]               (@ref rte_vfio.h)
34
35- **device specific**:
36  [softnic]            (@ref rte_eth_softnic.h),
37  [bond]               (@ref rte_eth_bond.h),
38  [vhost]              (@ref rte_vhost.h),
39  [KNI]                (@ref rte_kni.h),
40  [ixgbe]              (@ref rte_pmd_ixgbe.h),
41  [i40e]               (@ref rte_pmd_i40e.h),
42  [bnxt]               (@ref rte_pmd_bnxt.h),
43  [dpaa]               (@ref rte_pmd_dpaa.h),
44  [dpaa2_mempool]      (@ref rte_dpaa2_mempool.h),
45  [dpaa2_cmdif]        (@ref rte_pmd_dpaa2_cmdif.h),
46  [dpaa2_qdma]         (@ref rte_pmd_dpaa2_qdma.h),
47  [crypto_scheduler]   (@ref rte_cryptodev_scheduler.h)
48
49- **memory**:
50  [memseg]             (@ref rte_memory.h),
51  [memzone]            (@ref rte_memzone.h),
52  [mempool]            (@ref rte_mempool.h),
53  [malloc]             (@ref rte_malloc.h),
54  [memcpy]             (@ref rte_memcpy.h)
55
56- **timers**:
57  [cycles]             (@ref rte_cycles.h),
58  [timer]              (@ref rte_timer.h),
59  [alarm]              (@ref rte_alarm.h)
60
61- **locks**:
62  [atomic]             (@ref rte_atomic.h),
63  [rwlock]             (@ref rte_rwlock.h),
64  [spinlock]           (@ref rte_spinlock.h)
65
66- **CPU arch**:
67  [branch prediction]  (@ref rte_branch_prediction.h),
68  [cache prefetch]     (@ref rte_prefetch.h),
69  [SIMD]               (@ref rte_vect.h),
70  [byte order]         (@ref rte_byteorder.h),
71  [CPU flags]          (@ref rte_cpuflags.h),
72  [CPU pause]          (@ref rte_pause.h),
73  [I/O access]         (@ref rte_io.h)
74
75- **CPU multicore**:
76  [interrupts]         (@ref rte_interrupts.h),
77  [launch]             (@ref rte_launch.h),
78  [lcore]              (@ref rte_lcore.h),
79  [per-lcore]          (@ref rte_per_lcore.h),
80  [service cores]      (@ref rte_service.h),
81  [keepalive]          (@ref rte_keepalive.h),
82  [power/freq]         (@ref rte_power.h)
83
84- **layers**:
85  [ethernet]           (@ref rte_ether.h),
86  [ARP]                (@ref rte_arp.h),
87  [ICMP]               (@ref rte_icmp.h),
88  [ESP]                (@ref rte_esp.h),
89  [IP]                 (@ref rte_ip.h),
90  [SCTP]               (@ref rte_sctp.h),
91  [TCP]                (@ref rte_tcp.h),
92  [UDP]                (@ref rte_udp.h),
93  [GRO]                (@ref rte_gro.h),
94  [GSO]                (@ref rte_gso.h),
95  [frag/reass]         (@ref rte_ip_frag.h),
96  [LPM IPv4 route]     (@ref rte_lpm.h),
97  [LPM IPv6 route]     (@ref rte_lpm6.h)
98
99- **QoS**:
100  [metering]           (@ref rte_meter.h),
101  [scheduler]          (@ref rte_sched.h),
102  [RED congestion]     (@ref rte_red.h)
103
104- **hashes**:
105  [hash]               (@ref rte_hash.h),
106  [jhash]              (@ref rte_jhash.h),
107  [thash]              (@ref rte_thash.h),
108  [FBK hash]           (@ref rte_fbk_hash.h),
109  [CRC hash]           (@ref rte_hash_crc.h)
110
111- **classification**
112  [reorder]            (@ref rte_reorder.h),
113  [distributor]        (@ref rte_distributor.h),
114  [EFD]                (@ref rte_efd.h),
115  [ACL]                (@ref rte_acl.h),
116  [member]             (@ref rte_member.h),
117  [flow classify]      (@ref rte_flow_classify.h)
118
119- **containers**:
120  [mbuf]               (@ref rte_mbuf.h),
121  [mbuf pool ops]      (@ref rte_mbuf_pool_ops.h),
122  [ring]               (@ref rte_ring.h),
123  [tailq]              (@ref rte_tailq.h),
124  [bitmap]             (@ref rte_bitmap.h)
125
126- **packet framework**:
127  * [port]             (@ref rte_port.h):
128    [ethdev]           (@ref rte_port_ethdev.h),
129    [ring]             (@ref rte_port_ring.h),
130    [frag]             (@ref rte_port_frag.h),
131    [reass]            (@ref rte_port_ras.h),
132    [sched]            (@ref rte_port_sched.h),
133    [kni]              (@ref rte_port_kni.h),
134    [src/sink]         (@ref rte_port_source_sink.h)
135  * [table]            (@ref rte_table.h):
136    [lpm IPv4]         (@ref rte_table_lpm.h),
137    [lpm IPv6]         (@ref rte_table_lpm_ipv6.h),
138    [ACL]              (@ref rte_table_acl.h),
139    [hash]             (@ref rte_table_hash.h),
140    [array]            (@ref rte_table_array.h),
141    [stub]             (@ref rte_table_stub.h)
142  * [pipeline]         (@ref rte_pipeline.h)
143    [port_in_action]   (@ref rte_port_in_action.h)
144    [table_action]     (@ref rte_table_action.h)
145
146- **basic**:
147  [approx fraction]    (@ref rte_approx.h),
148  [random]             (@ref rte_random.h),
149  [config file]        (@ref rte_cfgfile.h),
150  [key/value args]     (@ref rte_kvargs.h),
151  [string]             (@ref rte_string_fns.h)
152
153- **debug**:
154  [jobstats]           (@ref rte_jobstats.h),
155  [pdump]              (@ref rte_pdump.h),
156  [hexdump]            (@ref rte_hexdump.h),
157  [debug]              (@ref rte_debug.h),
158  [log]                (@ref rte_log.h),
159  [errno]              (@ref rte_errno.h)
160
161- **misc**:
162  [EAL config]         (@ref rte_eal.h),
163  [common]             (@ref rte_common.h),
164  [ABI compat]         (@ref rte_compat.h),
165  [version]            (@ref rte_version.h)
166