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