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