5 SPDX-License-Identifier: BSD-3-Clause
6 Copyright(c) 2013-2017 6WIND S.A.
9 The public API headers are grouped by topics:
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)
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)
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)
69 [cycles] (@ref rte_cycles.h),
70 [timer] (@ref rte_timer.h),
71 [alarm] (@ref rte_alarm.h)
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)
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)
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)
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 [SCTP] (@ref rte_sctp.h),
111 [TCP] (@ref rte_tcp.h),
112 [UDP] (@ref rte_udp.h),
113 [GTP] (@ref rte_gtp.h),
114 [GRO] (@ref rte_gro.h),
115 [GSO] (@ref rte_gso.h),
116 [frag/reass] (@ref rte_ip_frag.h),
117 [VXLAN] (@ref rte_vxlan.h)
120 [metering] (@ref rte_meter.h),
121 [scheduler] (@ref rte_sched.h),
122 [RED congestion] (@ref rte_red.h)
125 [LPM IPv4 route] (@ref rte_lpm.h),
126 [LPM IPv6 route] (@ref rte_lpm6.h),
127 [RIB IPv4] (@ref rte_rib.h),
128 [RIB IPv6] (@ref rte_rib6.h),
129 [FIB IPv4] (@ref rte_fib.h),
130 [FIB IPv6] (@ref rte_fib6.h)
133 [hash] (@ref rte_hash.h),
134 [jhash] (@ref rte_jhash.h),
135 [thash] (@ref rte_thash.h),
136 [FBK hash] (@ref rte_fbk_hash.h),
137 [CRC hash] (@ref rte_hash_crc.h)
140 [reorder] (@ref rte_reorder.h),
141 [distributor] (@ref rte_distributor.h),
142 [EFD] (@ref rte_efd.h),
143 [ACL] (@ref rte_acl.h),
144 [member] (@ref rte_member.h),
145 [flow classify] (@ref rte_flow_classify.h),
146 [BPF] (@ref rte_bpf.h)
149 [mbuf] (@ref rte_mbuf.h),
150 [mbuf pool ops] (@ref rte_mbuf_pool_ops.h),
151 [ring] (@ref rte_ring.h),
152 [stack] (@ref rte_stack.h),
153 [tailq] (@ref rte_tailq.h),
154 [bitmap] (@ref rte_bitmap.h)
156 - **packet framework**:
157 * [port] (@ref rte_port.h):
158 [ethdev] (@ref rte_port_ethdev.h),
159 [ring] (@ref rte_port_ring.h),
160 [frag] (@ref rte_port_frag.h),
161 [reass] (@ref rte_port_ras.h),
162 [sched] (@ref rte_port_sched.h),
163 [kni] (@ref rte_port_kni.h),
164 [src/sink] (@ref rte_port_source_sink.h)
165 * [table] (@ref rte_table.h):
166 [lpm IPv4] (@ref rte_table_lpm.h),
167 [lpm IPv6] (@ref rte_table_lpm_ipv6.h),
168 [ACL] (@ref rte_table_acl.h),
169 [hash] (@ref rte_table_hash.h),
170 [array] (@ref rte_table_array.h),
171 [stub] (@ref rte_table_stub.h)
172 * [pipeline] (@ref rte_pipeline.h)
173 [port_in_action] (@ref rte_port_in_action.h)
174 [table_action] (@ref rte_table_action.h)
176 [control] (@ref rte_swx_ctl.h),
177 [extern] (@ref rte_swx_extern.h),
178 [pipeline] (@ref rte_swx_pipeline.h)
180 [port] (@ref rte_swx_port.h),
181 [ethdev] (@ref rte_swx_port_ethdev.h),
182 [src/sink] (@ref rte_swx_port_source_sink.h)
184 [table] (@ref rte_swx_table.h),
185 [table_em] (@ref rte_swx_table_em.h)
186 * [graph] (@ref rte_graph.h):
187 [graph_worker] (@ref rte_graph_worker.h)
189 [eth_node] (@ref rte_node_eth_api.h),
190 [ip4_node] (@ref rte_node_ip4_api.h)
193 [bitops] (@ref rte_bitops.h),
194 [approx fraction] (@ref rte_approx.h),
195 [random] (@ref rte_random.h),
196 [config file] (@ref rte_cfgfile.h),
197 [key/value args] (@ref rte_kvargs.h),
198 [string] (@ref rte_string_fns.h)
201 [jobstats] (@ref rte_jobstats.h),
202 [telemetry] (@ref rte_telemetry.h),
203 [pdump] (@ref rte_pdump.h),
204 [hexdump] (@ref rte_hexdump.h),
205 [debug] (@ref rte_debug.h),
206 [log] (@ref rte_log.h),
207 [errno] (@ref rte_errno.h),
208 [trace] (@ref rte_trace.h),
209 [trace_point] (@ref rte_trace_point.h)
212 [EAL config] (@ref rte_eal.h),
213 [common] (@ref rte_common.h),
214 [experimental APIs] (@ref rte_compat.h),
215 [ABI versioning] (@ref rte_function_versioning.h),
216 [version] (@ref rte_version.h)