doxy-api-index.md revision 3d9b7210
1API {#index}
2===
3
4<!--
5  BSD LICENSE
6
7  Copyright 2013 6WIND S.A.
8
9  Redistribution and use in source and binary forms, with or without
10  modification, are permitted provided that the following conditions
11  are met:
12
13    * Redistributions of source code must retain the above copyright
14      notice, this list of conditions and the following disclaimer.
15    * Redistributions in binary form must reproduce the above copyright
16      notice, this list of conditions and the following disclaimer in
17      the documentation and/or other materials provided with the
18      distribution.
19    * Neither the name of 6WIND S.A. nor the names of its
20      contributors may be used to endorse or promote products derived
21      from this software without specific prior written permission.
22
23  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
25  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
26  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
27  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
28  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
29  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
30  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
31  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
32  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
33  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34-->
35
36There are many libraries, so their headers may be grouped by topics:
37
38- **device**:
39  [dev]                (@ref rte_dev.h),
40  [ethdev]             (@ref rte_ethdev.h),
41  [ethctrl]            (@ref rte_eth_ctrl.h),
42  [cryptodev]          (@ref rte_cryptodev.h),
43  [devargs]            (@ref rte_devargs.h),
44  [bond]               (@ref rte_eth_bond.h),
45  [vhost]              (@ref rte_virtio_net.h),
46  [KNI]                (@ref rte_kni.h),
47  [PCI]                (@ref rte_pci.h),
48
49- **memory**:
50  [memseg]             (@ref rte_memory.h),
51  [memzone]            (@ref rte_memzone.h),
52  [mempool]            (@ref rte_mempool.h),
53  [malloc]             (@ref rte_malloc.h),
54  [memcpy]             (@ref rte_memcpy.h)
55
56- **timers**:
57  [cycles]             (@ref rte_cycles.h),
58  [timer]              (@ref rte_timer.h),
59  [alarm]              (@ref rte_alarm.h)
60
61- **locks**:
62  [atomic]             (@ref rte_atomic.h),
63  [rwlock]             (@ref rte_rwlock.h),
64  [spinlock]           (@ref rte_spinlock.h)
65
66- **CPU arch**:
67  [branch prediction]  (@ref rte_branch_prediction.h),
68  [cache prefetch]     (@ref rte_prefetch.h),
69  [byte order]         (@ref rte_byteorder.h),
70  [CPU flags]          (@ref rte_cpuflags.h)
71
72- **CPU multicore**:
73  [interrupts]         (@ref rte_interrupts.h),
74  [launch]             (@ref rte_launch.h),
75  [lcore]              (@ref rte_lcore.h),
76  [per-lcore]          (@ref rte_per_lcore.h),
77  [power/freq]         (@ref rte_power.h)
78
79- **layers**:
80  [ethernet]           (@ref rte_ether.h),
81  [ARP]                (@ref rte_arp.h),
82  [ICMP]               (@ref rte_icmp.h),
83  [IP]                 (@ref rte_ip.h),
84  [SCTP]               (@ref rte_sctp.h),
85  [TCP]                (@ref rte_tcp.h),
86  [UDP]                (@ref rte_udp.h),
87  [frag/reass]         (@ref rte_ip_frag.h),
88  [LPM IPv4 route]     (@ref rte_lpm.h),
89  [LPM IPv6 route]     (@ref rte_lpm6.h),
90  [ACL]                (@ref rte_acl.h)
91
92- **QoS**:
93  [metering]           (@ref rte_meter.h),
94  [scheduler]          (@ref rte_sched.h),
95  [RED congestion]     (@ref rte_red.h)
96
97- **hashes**:
98  [hash]               (@ref rte_hash.h),
99  [jhash]              (@ref rte_jhash.h),
100  [thash]              (@ref rte_thash.h),
101  [FBK hash]           (@ref rte_fbk_hash.h),
102  [CRC hash]           (@ref rte_hash_crc.h)
103
104- **containers**:
105  [mbuf]               (@ref rte_mbuf.h),
106  [ring]               (@ref rte_ring.h),
107  [distributor]        (@ref rte_distributor.h),
108  [reorder]            (@ref rte_reorder.h),
109  [tailq]              (@ref rte_tailq.h),
110  [bitmap]             (@ref rte_bitmap.h),
111
112- **packet framework**:
113  * [port]             (@ref rte_port.h):
114    [ethdev]           (@ref rte_port_ethdev.h),
115    [ring]             (@ref rte_port_ring.h),
116    [frag]             (@ref rte_port_frag.h),
117    [reass]            (@ref rte_port_ras.h),
118    [sched]            (@ref rte_port_sched.h),
119    [kni]              (@ref rte_port_kni.h),
120    [src/sink]         (@ref rte_port_source_sink.h)
121  * [table]            (@ref rte_table.h):
122    [lpm IPv4]         (@ref rte_table_lpm.h),
123    [lpm IPv6]         (@ref rte_table_lpm_ipv6.h),
124    [ACL]              (@ref rte_table_acl.h),
125    [hash]             (@ref rte_table_hash.h),
126    [array]            (@ref rte_table_array.h),
127    [stub]             (@ref rte_table_stub.h)
128  * [pipeline]         (@ref rte_pipeline.h)
129
130- **basic**:
131  [approx fraction]    (@ref rte_approx.h),
132  [random]             (@ref rte_random.h),
133  [config file]        (@ref rte_cfgfile.h),
134  [key/value args]     (@ref rte_kvargs.h),
135  [string]             (@ref rte_string_fns.h)
136
137- **debug**:
138  [jobstats]           (@ref rte_jobstats.h),
139  [hexdump]            (@ref rte_hexdump.h),
140  [debug]              (@ref rte_debug.h),
141  [log]                (@ref rte_log.h),
142  [warnings]           (@ref rte_warnings.h),
143  [errno]              (@ref rte_errno.h)
144
145- **misc**:
146  [EAL config]         (@ref rte_eal.h),
147  [common]             (@ref rte_common.h),
148  [ABI compat]         (@ref rte_compat.h),
149  [keepalive]          (@ref rte_keepalive.h),
150  [version]            (@ref rte_version.h)
151