2020-05-20 13:33:43 +00:00
|
|
|
API
|
2013-04-19 10:34:40 +00:00
|
|
|
===
|
|
|
|
|
|
|
|
|
|
<!--
|
2018-04-04 21:51:06 +00:00
|
|
|
SPDX-License-Identifier: BSD-3-Clause
|
|
|
|
|
Copyright(c) 2013-2017 6WIND S.A.
|
2013-04-19 10:34:40 +00:00
|
|
|
-->
|
|
|
|
|
|
2017-07-14 14:45:25 +00:00
|
|
|
The public API headers are grouped by topics:
|
2013-04-19 10:34:40 +00:00
|
|
|
|
|
|
|
|
- **device**:
|
2022-04-06 17:10:11 +00:00
|
|
|
[dev](@ref rte_dev.h),
|
|
|
|
|
[ethdev](@ref rte_ethdev.h),
|
|
|
|
|
[ethctrl](@ref rte_eth_ctrl.h),
|
|
|
|
|
[rte_flow](@ref rte_flow.h),
|
|
|
|
|
[rte_tm](@ref rte_tm.h),
|
|
|
|
|
[rte_mtr](@ref rte_mtr.h),
|
|
|
|
|
[bbdev](@ref rte_bbdev.h),
|
|
|
|
|
[cryptodev](@ref rte_cryptodev.h),
|
|
|
|
|
[security](@ref rte_security.h),
|
|
|
|
|
[compressdev](@ref rte_compressdev.h),
|
|
|
|
|
[compress](@ref rte_comp.h),
|
|
|
|
|
[regexdev](@ref rte_regexdev.h),
|
|
|
|
|
[dmadev](@ref rte_dmadev.h),
|
|
|
|
|
[eventdev](@ref rte_eventdev.h),
|
|
|
|
|
[event_eth_rx_adapter](@ref rte_event_eth_rx_adapter.h),
|
|
|
|
|
[event_eth_tx_adapter](@ref rte_event_eth_tx_adapter.h),
|
|
|
|
|
[event_timer_adapter](@ref rte_event_timer_adapter.h),
|
|
|
|
|
[event_crypto_adapter](@ref rte_event_crypto_adapter.h),
|
|
|
|
|
[rawdev](@ref rte_rawdev.h),
|
|
|
|
|
[metrics](@ref rte_metrics.h),
|
|
|
|
|
[bitrate](@ref rte_bitrate.h),
|
|
|
|
|
[latency](@ref rte_latencystats.h),
|
|
|
|
|
[devargs](@ref rte_devargs.h),
|
|
|
|
|
[PCI](@ref rte_pci.h),
|
|
|
|
|
[vdev](@ref rte_bus_vdev.h),
|
|
|
|
|
[vfio](@ref rte_vfio.h)
|
2017-01-30 18:27:25 +00:00
|
|
|
|
|
|
|
|
- **device specific**:
|
2022-04-06 17:10:11 +00:00
|
|
|
[softnic](@ref rte_eth_softnic.h),
|
|
|
|
|
[bond](@ref rte_eth_bond.h),
|
|
|
|
|
[vhost](@ref rte_vhost.h),
|
|
|
|
|
[vdpa](@ref rte_vdpa.h),
|
|
|
|
|
[KNI](@ref rte_kni.h),
|
|
|
|
|
[ixgbe](@ref rte_pmd_ixgbe.h),
|
|
|
|
|
[i40e](@ref rte_pmd_i40e.h),
|
|
|
|
|
[iavf](@ref rte_pmd_iavf.h),
|
|
|
|
|
[bnxt](@ref rte_pmd_bnxt.h),
|
|
|
|
|
[cnxk](@ref rte_pmd_cnxk.h),
|
|
|
|
|
[dpaa](@ref rte_pmd_dpaa.h),
|
|
|
|
|
[dpaa2](@ref rte_pmd_dpaa2.h),
|
|
|
|
|
[mlx5](@ref rte_pmd_mlx5.h),
|
|
|
|
|
[dpaa2_mempool](@ref rte_dpaa2_mempool.h),
|
|
|
|
|
[dpaa2_cmdif](@ref rte_pmd_dpaa2_cmdif.h),
|
|
|
|
|
[dpaa2_qdma](@ref rte_pmd_dpaa2_qdma.h),
|
|
|
|
|
[crypto_scheduler](@ref rte_cryptodev_scheduler.h),
|
|
|
|
|
[dlb2](@ref rte_pmd_dlb2.h),
|
|
|
|
|
[ifpga](@ref rte_pmd_ifpga.h)
|
2013-04-19 10:34:40 +00:00
|
|
|
|
|
|
|
|
- **memory**:
|
2022-04-06 17:10:11 +00:00
|
|
|
[memseg](@ref rte_memory.h),
|
|
|
|
|
[memzone](@ref rte_memzone.h),
|
|
|
|
|
[mempool](@ref rte_mempool.h),
|
|
|
|
|
[malloc](@ref rte_malloc.h),
|
|
|
|
|
[memcpy](@ref rte_memcpy.h)
|
2013-04-19 10:34:40 +00:00
|
|
|
|
|
|
|
|
- **timers**:
|
2022-04-06 17:10:11 +00:00
|
|
|
[cycles](@ref rte_cycles.h),
|
|
|
|
|
[timer](@ref rte_timer.h),
|
|
|
|
|
[alarm](@ref rte_alarm.h)
|
2013-04-19 10:34:40 +00:00
|
|
|
|
|
|
|
|
- **locks**:
|
2022-04-06 17:10:11 +00:00
|
|
|
[atomic](@ref rte_atomic.h),
|
|
|
|
|
[mcslock](@ref rte_mcslock.h),
|
|
|
|
|
[pflock](@ref rte_pflock.h),
|
|
|
|
|
[rwlock](@ref rte_rwlock.h),
|
eal: add seqlock
A sequence lock (seqlock) is a synchronization primitive which allows
for data-race free, low-overhead, high-frequency reads, suitable for
data structures shared across many cores and which are updated
relatively infrequently.
A seqlock permits multiple parallel readers. A spinlock is used to
serialize writers. In cases where there is only a single writer, or
writer-writer synchronization is done by some external means, the
"raw" sequence counter type (and accompanying rte_seqcount_*()
functions) may be used instead.
To avoid resource reclamation and other issues, the data protected by
a seqlock is best off being self-contained (i.e., no pointers [except
to constant data]).
One way to think about seqlocks is that they provide means to perform
atomic operations on data objects larger than what the native atomic
machine instructions allow for.
DPDK seqlocks (and the underlying sequence counters) are not
preemption safe on the writer side. A thread preemption affects
performance, not correctness.
A seqlock contains a sequence number, which can be thought of as the
generation of the data it protects.
A reader will
1. Load the sequence number (sn).
2. Load, in arbitrary order, the seqlock-protected data.
3. Load the sn again.
4. Check if the first and second sn are equal, and even numbered.
If they are not, discard the loaded data, and restart from 1.
The first three steps need to be ordered using suitable memory fences.
A writer will
1. Take the spinlock, to serialize writer access.
2. Load the sn.
3. Store the original sn + 1 as the new sn.
4. Perform load and stores to the seqlock-protected data.
5. Store the original sn + 2 as the new sn.
6. Release the spinlock.
Proper memory fencing is required to make sure the first sn store, the
data stores, and the second sn store appear to the reader in the
mentioned order.
The sn loads and stores must be atomic, but the data loads and stores
need not be.
The original seqlock design and implementation was done by Stephen
Hemminger. This is an independent implementation, using C11 atomics.
For more information on seqlocks, see
https://en.wikipedia.org/wiki/Seqlock
Acked-by: Morten Brørup <mb@smartsharesystems.com>
Acked-by: Konstantin Ananyev <konstantin.ananyev@intel.com>
Reviewed-by: Ola Liljedahl <ola.liljedahl@arm.com>
Reviewed-by: Chengwen Feng <fengchengwen@huawei.com>
Signed-off-by: Mattias Rönnblom <mattias.ronnblom@ericsson.com>
2022-05-23 14:23:46 +00:00
|
|
|
[seqcount](@ref rte_seqcount.h),
|
|
|
|
|
[seqlock](@ref rte_seqlock.h),
|
2022-04-06 17:10:11 +00:00
|
|
|
[spinlock](@ref rte_spinlock.h),
|
|
|
|
|
[ticketlock](@ref rte_ticketlock.h),
|
|
|
|
|
[RCU](@ref rte_rcu_qsbr.h)
|
2013-04-19 10:34:40 +00:00
|
|
|
|
|
|
|
|
- **CPU arch**:
|
2022-04-06 17:10:11 +00:00
|
|
|
[branch prediction](@ref rte_branch_prediction.h),
|
|
|
|
|
[cache prefetch](@ref rte_prefetch.h),
|
|
|
|
|
[SIMD](@ref rte_vect.h),
|
|
|
|
|
[byte order](@ref rte_byteorder.h),
|
|
|
|
|
[CPU flags](@ref rte_cpuflags.h),
|
|
|
|
|
[CPU pause](@ref rte_pause.h),
|
|
|
|
|
[I/O access](@ref rte_io.h),
|
|
|
|
|
[power management](@ref rte_power_intrinsics.h)
|
2013-04-19 10:34:40 +00:00
|
|
|
|
|
|
|
|
- **CPU multicore**:
|
2022-04-06 17:10:11 +00:00
|
|
|
[interrupts](@ref rte_interrupts.h),
|
|
|
|
|
[launch](@ref rte_launch.h),
|
|
|
|
|
[lcore](@ref rte_lcore.h),
|
|
|
|
|
[per-lcore](@ref rte_per_lcore.h),
|
|
|
|
|
[service cores](@ref rte_service.h),
|
|
|
|
|
[keepalive](@ref rte_keepalive.h),
|
|
|
|
|
[power/freq](@ref rte_power.h),
|
|
|
|
|
[PMD power](@ref rte_power_pmd_mgmt.h)
|
2013-04-19 10:34:40 +00:00
|
|
|
|
|
|
|
|
- **layers**:
|
2022-04-06 17:10:11 +00:00
|
|
|
[ethernet](@ref rte_ether.h),
|
2022-09-28 12:22:51 +00:00
|
|
|
[MACsec](@ref rte_macsec.h),
|
2022-04-06 17:10:11 +00:00
|
|
|
[ARP](@ref rte_arp.h),
|
|
|
|
|
[HIGIG](@ref rte_higig.h),
|
|
|
|
|
[ICMP](@ref rte_icmp.h),
|
|
|
|
|
[ESP](@ref rte_esp.h),
|
|
|
|
|
[IPsec](@ref rte_ipsec.h),
|
|
|
|
|
[IPsec group](@ref rte_ipsec_group.h),
|
|
|
|
|
[IPsec SA](@ref rte_ipsec_sa.h),
|
|
|
|
|
[IPsec SAD](@ref rte_ipsec_sad.h),
|
|
|
|
|
[IP](@ref rte_ip.h),
|
|
|
|
|
[frag/reass](@ref rte_ip_frag.h),
|
|
|
|
|
[SCTP](@ref rte_sctp.h),
|
|
|
|
|
[TCP](@ref rte_tcp.h),
|
|
|
|
|
[UDP](@ref rte_udp.h),
|
|
|
|
|
[GTP](@ref rte_gtp.h),
|
|
|
|
|
[GRO](@ref rte_gro.h),
|
|
|
|
|
[GSO](@ref rte_gso.h),
|
|
|
|
|
[GRE](@ref rte_gre.h),
|
|
|
|
|
[MPLS](@ref rte_mpls.h),
|
|
|
|
|
[VXLAN](@ref rte_vxlan.h),
|
|
|
|
|
[Geneve](@ref rte_geneve.h),
|
|
|
|
|
[eCPRI](@ref rte_ecpri.h),
|
|
|
|
|
[L2TPv2](@ref rte_l2tpv2.h),
|
|
|
|
|
[PPP](@ref rte_ppp.h)
|
2013-04-19 10:34:40 +00:00
|
|
|
|
|
|
|
|
- **QoS**:
|
2022-04-06 17:10:11 +00:00
|
|
|
[metering](@ref rte_meter.h),
|
|
|
|
|
[scheduler](@ref rte_sched.h),
|
|
|
|
|
[RED congestion](@ref rte_red.h)
|
2013-04-19 10:34:40 +00:00
|
|
|
|
2020-07-08 18:31:27 +00:00
|
|
|
- **routing**:
|
2022-04-06 17:10:11 +00:00
|
|
|
[LPM IPv4 route](@ref rte_lpm.h),
|
|
|
|
|
[LPM IPv6 route](@ref rte_lpm6.h),
|
|
|
|
|
[RIB IPv4](@ref rte_rib.h),
|
|
|
|
|
[RIB IPv6](@ref rte_rib6.h),
|
|
|
|
|
[FIB IPv4](@ref rte_fib.h),
|
|
|
|
|
[FIB IPv6](@ref rte_fib6.h)
|
2020-07-08 18:31:27 +00:00
|
|
|
|
2013-04-19 10:34:40 +00:00
|
|
|
- **hashes**:
|
2022-04-06 17:10:11 +00:00
|
|
|
[hash](@ref rte_hash.h),
|
|
|
|
|
[jhash](@ref rte_jhash.h),
|
|
|
|
|
[thash](@ref rte_thash.h),
|
|
|
|
|
[thash_gfni](@ref rte_thash_gfni.h),
|
|
|
|
|
[FBK hash](@ref rte_fbk_hash.h),
|
|
|
|
|
[CRC hash](@ref rte_hash_crc.h)
|
2017-10-20 10:26:30 +00:00
|
|
|
|
|
|
|
|
- **classification**
|
2022-04-06 17:10:11 +00:00
|
|
|
[reorder](@ref rte_reorder.h),
|
|
|
|
|
[distributor](@ref rte_distributor.h),
|
|
|
|
|
[EFD](@ref rte_efd.h),
|
|
|
|
|
[ACL](@ref rte_acl.h),
|
|
|
|
|
[member](@ref rte_member.h),
|
|
|
|
|
[flow classify](@ref rte_flow_classify.h),
|
|
|
|
|
[BPF](@ref rte_bpf.h)
|
2013-04-19 10:34:40 +00:00
|
|
|
|
|
|
|
|
- **containers**:
|
2022-04-06 17:10:11 +00:00
|
|
|
[mbuf](@ref rte_mbuf.h),
|
|
|
|
|
[mbuf pool ops](@ref rte_mbuf_pool_ops.h),
|
|
|
|
|
[ring](@ref rte_ring.h),
|
|
|
|
|
[stack](@ref rte_stack.h),
|
|
|
|
|
[tailq](@ref rte_tailq.h),
|
|
|
|
|
[bitmap](@ref rte_bitmap.h)
|
2013-04-19 10:34:40 +00:00
|
|
|
|
2014-06-04 18:08:19 +00:00
|
|
|
- **packet framework**:
|
2022-04-06 17:10:11 +00:00
|
|
|
* [port](@ref rte_port.h):
|
|
|
|
|
[ethdev](@ref rte_port_ethdev.h),
|
|
|
|
|
[ring](@ref rte_port_ring.h),
|
|
|
|
|
[frag](@ref rte_port_frag.h),
|
|
|
|
|
[reass](@ref rte_port_ras.h),
|
|
|
|
|
[sched](@ref rte_port_sched.h),
|
|
|
|
|
[kni](@ref rte_port_kni.h),
|
|
|
|
|
[src/sink](@ref rte_port_source_sink.h)
|
|
|
|
|
* [table](@ref rte_table.h):
|
|
|
|
|
[lpm IPv4](@ref rte_table_lpm.h),
|
|
|
|
|
[lpm IPv6](@ref rte_table_lpm_ipv6.h),
|
|
|
|
|
[ACL](@ref rte_table_acl.h),
|
|
|
|
|
[hash](@ref rte_table_hash.h),
|
|
|
|
|
[array](@ref rte_table_array.h),
|
|
|
|
|
[stub](@ref rte_table_stub.h)
|
|
|
|
|
* [pipeline](@ref rte_pipeline.h)
|
|
|
|
|
[port_in_action](@ref rte_port_in_action.h)
|
|
|
|
|
[table_action](@ref rte_table_action.h)
|
2020-10-01 10:19:29 +00:00
|
|
|
* SWX pipeline:
|
2022-04-06 17:10:11 +00:00
|
|
|
[control](@ref rte_swx_ctl.h),
|
|
|
|
|
[extern](@ref rte_swx_extern.h),
|
|
|
|
|
[pipeline](@ref rte_swx_pipeline.h)
|
2020-10-01 10:19:30 +00:00
|
|
|
* SWX port:
|
2022-04-06 17:10:11 +00:00
|
|
|
[port](@ref rte_swx_port.h),
|
|
|
|
|
[ethdev](@ref rte_swx_port_ethdev.h),
|
|
|
|
|
[fd](@ref rte_swx_port_fd.h),
|
|
|
|
|
[ring](@ref rte_swx_port_ring.h),
|
|
|
|
|
[src/sink](@ref rte_swx_port_source_sink.h)
|
2020-10-01 10:19:35 +00:00
|
|
|
* SWX table:
|
2022-04-06 17:10:11 +00:00
|
|
|
[table](@ref rte_swx_table.h),
|
|
|
|
|
[table_em](@ref rte_swx_table_em.h)
|
|
|
|
|
[table_wm](@ref rte_swx_table_wm.h)
|
|
|
|
|
* [graph](@ref rte_graph.h):
|
|
|
|
|
[graph_worker](@ref rte_graph_worker.h)
|
2020-04-11 14:14:17 +00:00
|
|
|
* graph_nodes:
|
2022-04-06 17:10:11 +00:00
|
|
|
[eth_node](@ref rte_node_eth_api.h),
|
|
|
|
|
[ip4_node](@ref rte_node_ip4_api.h)
|
2014-06-04 18:08:19 +00:00
|
|
|
|
2014-02-04 15:11:12 +00:00
|
|
|
- **basic**:
|
2022-04-06 17:10:11 +00:00
|
|
|
[bitops](@ref rte_bitops.h),
|
|
|
|
|
[approx fraction](@ref rte_approx.h),
|
|
|
|
|
[random](@ref rte_random.h),
|
|
|
|
|
[config file](@ref rte_cfgfile.h),
|
|
|
|
|
[key/value args](@ref rte_kvargs.h),
|
|
|
|
|
[string](@ref rte_string_fns.h)
|
2014-02-04 15:11:12 +00:00
|
|
|
|
2013-04-19 10:34:40 +00:00
|
|
|
- **debug**:
|
2022-04-06 17:10:11 +00:00
|
|
|
[jobstats](@ref rte_jobstats.h),
|
|
|
|
|
[telemetry](@ref rte_telemetry.h),
|
|
|
|
|
[pcapng](@ref rte_pcapng.h),
|
|
|
|
|
[pdump](@ref rte_pdump.h),
|
|
|
|
|
[hexdump](@ref rte_hexdump.h),
|
|
|
|
|
[debug](@ref rte_debug.h),
|
|
|
|
|
[log](@ref rte_log.h),
|
|
|
|
|
[errno](@ref rte_errno.h),
|
|
|
|
|
[trace](@ref rte_trace.h),
|
|
|
|
|
[trace_point](@ref rte_trace_point.h)
|
2013-04-19 10:34:40 +00:00
|
|
|
|
|
|
|
|
- **misc**:
|
2022-04-06 17:10:11 +00:00
|
|
|
[EAL config](@ref rte_eal.h),
|
|
|
|
|
[common](@ref rte_common.h),
|
|
|
|
|
[experimental APIs](@ref rte_compat.h),
|
|
|
|
|
[ABI versioning](@ref rte_function_versioning.h),
|
|
|
|
|
[version](@ref rte_version.h)
|
