1API 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 [regexdev](@ref rte_regexdev.h), 24 [mldev](@ref rte_mldev.h), 25 [dmadev](@ref rte_dmadev.h), 26 [gpudev](@ref rte_gpudev.h), 27 [eventdev](@ref rte_eventdev.h), 28 [event_eth_rx_adapter](@ref rte_event_eth_rx_adapter.h), 29 [event_eth_tx_adapter](@ref rte_event_eth_tx_adapter.h), 30 [event_timer_adapter](@ref rte_event_timer_adapter.h), 31 [event_crypto_adapter](@ref rte_event_crypto_adapter.h), 32 [event_dma_adapter](@ref rte_event_dma_adapter.h), 33 [rawdev](@ref rte_rawdev.h), 34 [metrics](@ref rte_metrics.h), 35 [bitrate](@ref rte_bitrate.h), 36 [latency](@ref rte_latencystats.h), 37 [devargs](@ref rte_devargs.h), 38 [PCI](@ref rte_pci.h), 39 [vdev](@ref rte_bus_vdev.h), 40 [vfio](@ref rte_vfio.h) 41 42- **device specific**: 43 [softnic](@ref rte_eth_softnic.h), 44 [bond](@ref rte_eth_bond.h), 45 [vhost](@ref rte_vhost.h), 46 [vdpa](@ref rte_vdpa.h), 47 [ixgbe](@ref rte_pmd_ixgbe.h), 48 [i40e](@ref rte_pmd_i40e.h), 49 [iavf](@ref rte_pmd_iavf.h), 50 [bnxt](@ref rte_pmd_bnxt.h), 51 [cnxk](@ref rte_pmd_cnxk.h), 52 [cnxk_crypto](@ref rte_pmd_cnxk_crypto.h), 53 [cnxk_eventdev](@ref rte_pmd_cnxk_eventdev.h), 54 [cnxk_mempool](@ref rte_pmd_cnxk_mempool.h), 55 [dpaa](@ref rte_pmd_dpaa.h), 56 [dpaa2](@ref rte_pmd_dpaa2.h), 57 [mlx5](@ref rte_pmd_mlx5.h), 58 [dpaa2_mempool](@ref rte_dpaa2_mempool.h), 59 [dpaa2_cmdif](@ref rte_pmd_dpaa2_cmdif.h), 60 [dpaax_qdma](@ref rte_pmd_dpaax_qdma.h), 61 [crypto_scheduler](@ref rte_cryptodev_scheduler.h), 62 [dlb2](@ref rte_pmd_dlb2.h), 63 [ifpga](@ref rte_pmd_ifpga.h) 64 65- **memory**: 66 [per-lcore](@ref rte_per_lcore.h), 67 [lcore variables](@ref rte_lcore_var.h), 68 [memseg](@ref rte_memory.h), 69 [memzone](@ref rte_memzone.h), 70 [mempool](@ref rte_mempool.h), 71 [malloc](@ref rte_malloc.h), 72 [memcpy](@ref rte_memcpy.h) 73 74- **timers**: 75 [cycles](@ref rte_cycles.h), 76 [timer](@ref rte_timer.h), 77 [alarm](@ref rte_alarm.h) 78 79- **locks**: 80 [atomic](@ref rte_atomic.h), 81 [mcslock](@ref rte_mcslock.h), 82 [pflock](@ref rte_pflock.h), 83 [rwlock](@ref rte_rwlock.h), 84 [seqcount](@ref rte_seqcount.h), 85 [seqlock](@ref rte_seqlock.h), 86 [spinlock](@ref rte_spinlock.h), 87 [ticketlock](@ref rte_ticketlock.h), 88 [RCU](@ref rte_rcu_qsbr.h) 89 90- **CPU arch**: 91 [branch prediction](@ref rte_branch_prediction.h), 92 [cache prefetch](@ref rte_prefetch.h), 93 [SIMD](@ref rte_vect.h), 94 [byte order](@ref rte_byteorder.h), 95 [CPU flags](@ref rte_cpuflags.h), 96 [CPU pause](@ref rte_pause.h), 97 [I/O access](@ref rte_io.h), 98 [power management](@ref rte_power_intrinsics.h) 99 100- **CPU multicore**: 101 [interrupts](@ref rte_interrupts.h), 102 [launch](@ref rte_launch.h), 103 [lcore](@ref rte_lcore.h), 104 [service cores](@ref rte_service.h), 105 [keepalive](@ref rte_keepalive.h), 106 [power/freq](@ref rte_power_cpufreq.h), 107 [power/uncore](@ref rte_power_uncore.h), 108 [PMD power](@ref rte_power_pmd_mgmt.h) 109 110- **layers**: 111 [ethernet](@ref rte_ether.h), 112 [MACsec](@ref rte_macsec.h), 113 [ARP](@ref rte_arp.h), 114 [HIGIG](@ref rte_higig.h), 115 [ICMP](@ref rte_icmp.h), 116 [ESP](@ref rte_esp.h), 117 [IPsec](@ref rte_ipsec.h), 118 [IPsec group](@ref rte_ipsec_group.h), 119 [IPsec SA](@ref rte_ipsec_sa.h), 120 [IPsec SAD](@ref rte_ipsec_sad.h), 121 [IPv4](@ref rte_ip4.h), 122 [IPv6](@ref rte_ip6.h), 123 [frag/reass](@ref rte_ip_frag.h), 124 [UDP](@ref rte_udp.h), 125 [SCTP](@ref rte_sctp.h), 126 [TCP](@ref rte_tcp.h), 127 [TLS](@ref rte_tls.h), 128 [DTLS](@ref rte_dtls.h), 129 [GTP](@ref rte_gtp.h), 130 [GRO](@ref rte_gro.h), 131 [GSO](@ref rte_gso.h), 132 [GRE](@ref rte_gre.h), 133 [MPLS](@ref rte_mpls.h), 134 [VXLAN](@ref rte_vxlan.h), 135 [Geneve](@ref rte_geneve.h), 136 [eCPRI](@ref rte_ecpri.h), 137 [PDCP hdr](@ref rte_pdcp_hdr.h), 138 [PDCP](@ref rte_pdcp.h), 139 [L2TPv2](@ref rte_l2tpv2.h), 140 [PPP](@ref rte_ppp.h), 141 [IB](@ref rte_ib.h) 142 143- **QoS**: 144 [metering](@ref rte_meter.h), 145 [scheduler](@ref rte_sched.h), 146 [RED congestion](@ref rte_red.h) 147 148- **routing**: 149 [LPM IPv4 route](@ref rte_lpm.h), 150 [LPM IPv6 route](@ref rte_lpm6.h), 151 [RIB IPv4](@ref rte_rib.h), 152 [RIB IPv6](@ref rte_rib6.h), 153 [FIB IPv4](@ref rte_fib.h), 154 [FIB IPv6](@ref rte_fib6.h) 155 156- **hashes**: 157 [hash](@ref rte_hash.h), 158 [jhash](@ref rte_jhash.h), 159 [thash](@ref rte_thash.h), 160 [thash_gfni](@ref rte_thash_gfni.h), 161 [FBK hash](@ref rte_fbk_hash.h), 162 [CRC hash](@ref rte_hash_crc.h) 163 164- **classification** 165 [reorder](@ref rte_reorder.h), 166 [dispatcher](@ref rte_dispatcher.h), 167 [distributor](@ref rte_distributor.h), 168 [EFD](@ref rte_efd.h), 169 [ACL](@ref rte_acl.h), 170 [member](@ref rte_member.h), 171 [BPF](@ref rte_bpf.h) 172 173- **containers**: 174 [mbuf](@ref rte_mbuf.h), 175 [mbuf pool ops](@ref rte_mbuf_pool_ops.h), 176 [ring](@ref rte_ring.h), 177 [stack](@ref rte_stack.h), 178 [tailq](@ref rte_tailq.h), 179 [bitset](@ref rte_bitset.h), 180 [bitmap](@ref rte_bitmap.h) 181 182- **packet framework**: 183 * [port](@ref rte_port.h): 184 [ethdev](@ref rte_port_ethdev.h), 185 [ring](@ref rte_port_ring.h), 186 [frag](@ref rte_port_frag.h), 187 [reass](@ref rte_port_ras.h), 188 [sched](@ref rte_port_sched.h), 189 [src/sink](@ref rte_port_source_sink.h) 190 * [table](@ref rte_table.h): 191 [lpm IPv4](@ref rte_table_lpm.h), 192 [lpm IPv6](@ref rte_table_lpm_ipv6.h), 193 [ACL](@ref rte_table_acl.h), 194 [hash](@ref rte_table_hash.h), 195 [array](@ref rte_table_array.h), 196 [stub](@ref rte_table_stub.h) 197 * [pipeline](@ref rte_pipeline.h) 198 [port_in_action](@ref rte_port_in_action.h) 199 [table_action](@ref rte_table_action.h) 200 * SWX pipeline: 201 [control](@ref rte_swx_ctl.h), 202 [extern](@ref rte_swx_extern.h), 203 [pipeline](@ref rte_swx_pipeline.h) 204 * SWX port: 205 [port](@ref rte_swx_port.h), 206 [ethdev](@ref rte_swx_port_ethdev.h), 207 [fd](@ref rte_swx_port_fd.h), 208 [ring](@ref rte_swx_port_ring.h), 209 [src/sink](@ref rte_swx_port_source_sink.h) 210 * SWX table: 211 [table](@ref rte_swx_table.h), 212 [table_em](@ref rte_swx_table_em.h) 213 [table_wm](@ref rte_swx_table_wm.h) 214 * [graph](@ref rte_graph.h): 215 [graph_worker](@ref rte_graph_worker.h) 216 * graph_nodes: 217 [eth_node](@ref rte_node_eth_api.h), 218 [ip4_node](@ref rte_node_ip4_api.h), 219 [ip6_node](@ref rte_node_ip6_api.h), 220 [udp4_input_node](@ref rte_node_udp4_input_api.h) 221 222- **basic**: 223 [bitops](@ref rte_bitops.h), 224 [approx fraction](@ref rte_approx.h), 225 [random](@ref rte_random.h), 226 [checksum](@ref rte_cksum.h), 227 [config file](@ref rte_cfgfile.h), 228 [key/value args](@ref rte_kvargs.h), 229 [argument parsing](@ref rte_argparse.h), 230 [ptr_compress](@ref rte_ptr_compress.h), 231 [string](@ref rte_string_fns.h), 232 [thread](@ref rte_thread.h) 233 234- **debug**: 235 [jobstats](@ref rte_jobstats.h), 236 [telemetry](@ref rte_telemetry.h), 237 [pcapng](@ref rte_pcapng.h), 238 [pdump](@ref rte_pdump.h), 239 [hexdump](@ref rte_hexdump.h), 240 [debug](@ref rte_debug.h), 241 [log](@ref rte_log.h), 242 [errno](@ref rte_errno.h), 243 [trace](@ref rte_trace.h), 244 [trace_point](@ref rte_trace_point.h) 245 246- **misc**: 247 [EAL config](@ref rte_eal.h), 248 [common](@ref rte_common.h), 249 [experimental APIs](@ref rte_compat.h), 250 [ABI versioning](@ref rte_function_versioning.h), 251 [version](@ref rte_version.h) 252 253- **tests**: 254 [**DTS**](@dts_api_main_page) 255