examples/l2fwd: fix build warning with system wide install
[dpdk.git] / doc / api / doxy-api-index.md
1 API {#index}
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   [eventdev]           (@ref rte_eventdev.h),
24   [event_eth_rx_adapter]   (@ref rte_event_eth_rx_adapter.h),
25   [event_eth_tx_adapter]   (@ref rte_event_eth_tx_adapter.h),
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),
32   [devargs]            (@ref rte_devargs.h),
33   [PCI]                (@ref rte_pci.h),
34   [vdev]               (@ref rte_bus_vdev.h),
35   [vfio]               (@ref rte_vfio.h)
36
37 - **device specific**:
38   [softnic]            (@ref rte_eth_softnic.h),
39   [bond]               (@ref rte_eth_bond.h),
40   [vhost]              (@ref rte_vhost.h),
41   [vdpa]               (@ref rte_vdpa.h),
42   [KNI]                (@ref rte_kni.h),
43   [ixgbe]              (@ref rte_pmd_ixgbe.h),
44   [i40e]               (@ref rte_pmd_i40e.h),
45   [ice]                (@ref rte_pmd_ice.h),
46   [bnxt]               (@ref rte_pmd_bnxt.h),
47   [dpaa]               (@ref rte_pmd_dpaa.h),
48   [dpaa2]              (@ref rte_pmd_dpaa2.h),
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)
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),
68   [mcslock]            (@ref rte_mcslock.h),
69   [rwlock]             (@ref rte_rwlock.h),
70   [spinlock]           (@ref rte_spinlock.h),
71   [ticketlock]         (@ref rte_ticketlock.h),
72   [RCU]                (@ref rte_rcu_qsbr.h)
73
74 - **CPU arch**:
75   [branch prediction]  (@ref rte_branch_prediction.h),
76   [cache prefetch]     (@ref rte_prefetch.h),
77   [SIMD]               (@ref rte_vect.h),
78   [byte order]         (@ref rte_byteorder.h),
79   [CPU flags]          (@ref rte_cpuflags.h),
80   [CPU pause]          (@ref rte_pause.h),
81   [I/O access]         (@ref rte_io.h)
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),
88   [service cores]      (@ref rte_service.h),
89   [keepalive]          (@ref rte_keepalive.h),
90   [power/freq]         (@ref rte_power.h)
91
92 - **layers**:
93   [ethernet]           (@ref rte_ether.h),
94   [ARP]                (@ref rte_arp.h),
95   [HIGIG]              (@ref rte_higig.h),
96   [ICMP]               (@ref rte_icmp.h),
97   [ESP]                (@ref rte_esp.h),
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),
102   [IP]                 (@ref rte_ip.h),
103   [SCTP]               (@ref rte_sctp.h),
104   [TCP]                (@ref rte_tcp.h),
105   [UDP]                (@ref rte_udp.h),
106   [GTP]                (@ref rte_gtp.h),
107   [GRO]                (@ref rte_gro.h),
108   [GSO]                (@ref rte_gso.h),
109   [frag/reass]         (@ref rte_ip_frag.h),
110   [LPM IPv4 route]     (@ref rte_lpm.h),
111   [LPM IPv6 route]     (@ref rte_lpm6.h),
112   [VXLAN]              (@ref rte_vxlan.h)
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
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
135 - **containers**:
136   [mbuf]               (@ref rte_mbuf.h),
137   [mbuf pool ops]      (@ref rte_mbuf_pool_ops.h),
138   [ring]               (@ref rte_ring.h),
139   [stack]              (@ref rte_stack.h),
140   [tailq]              (@ref rte_tailq.h),
141   [bitmap]             (@ref rte_bitmap.h)
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)
160     [port_in_action]   (@ref rte_port_in_action.h)
161     [table_action]     (@ref rte_table_action.h)
162
163 - **basic**:
164   [approx fraction]    (@ref rte_approx.h),
165   [random]             (@ref rte_random.h),
166   [config file]        (@ref rte_cfgfile.h),
167   [key/value args]     (@ref rte_kvargs.h),
168   [string]             (@ref rte_string_fns.h)
169
170 - **debug**:
171   [jobstats]           (@ref rte_jobstats.h),
172   [telemetry]          (@ref rte_telemetry.h),
173   [pdump]              (@ref rte_pdump.h),
174   [hexdump]            (@ref rte_hexdump.h),
175   [debug]              (@ref rte_debug.h),
176   [log]                (@ref rte_log.h),
177   [errno]              (@ref rte_errno.h)
178
179 - **misc**:
180   [EAL config]         (@ref rte_eal.h),
181   [common]             (@ref rte_common.h),
182   [experimental APIs]  (@ref rte_compat.h),
183   [ABI versioning]     (@ref rte_function_versioning.h),
184   [version]            (@ref rte_version.h)