15129044dSC.J. CollierAPI {#index}
25129044dSC.J. Collier===
35129044dSC.J. Collier
45129044dSC.J. Collier<!--
55129044dSC.J. Collier  BSD LICENSE
65129044dSC.J. Collier
75129044dSC.J. Collier  Copyright 2013 6WIND S.A.
85129044dSC.J. Collier
95129044dSC.J. Collier  Redistribution and use in source and binary forms, with or without
105129044dSC.J. Collier  modification, are permitted provided that the following conditions
115129044dSC.J. Collier  are met:
125129044dSC.J. Collier
135129044dSC.J. Collier    * Redistributions of source code must retain the above copyright
145129044dSC.J. Collier      notice, this list of conditions and the following disclaimer.
155129044dSC.J. Collier    * Redistributions in binary form must reproduce the above copyright
165129044dSC.J. Collier      notice, this list of conditions and the following disclaimer in
175129044dSC.J. Collier      the documentation and/or other materials provided with the
185129044dSC.J. Collier      distribution.
195129044dSC.J. Collier    * Neither the name of 6WIND S.A. nor the names of its
205129044dSC.J. Collier      contributors may be used to endorse or promote products derived
215129044dSC.J. Collier      from this software without specific prior written permission.
225129044dSC.J. Collier
235129044dSC.J. Collier  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
245129044dSC.J. Collier  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
255129044dSC.J. Collier  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
265129044dSC.J. Collier  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
275129044dSC.J. Collier  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
285129044dSC.J. Collier  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
295129044dSC.J. Collier  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
305129044dSC.J. Collier  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
315129044dSC.J. Collier  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
325129044dSC.J. Collier  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
335129044dSC.J. Collier  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
345129044dSC.J. Collier-->
355129044dSC.J. Collier
365129044dSC.J. CollierThere are many libraries, so their headers may be grouped by topics:
375129044dSC.J. Collier
385129044dSC.J. Collier- **device**:
395129044dSC.J. Collier  [dev]                (@ref rte_dev.h),
405129044dSC.J. Collier  [ethdev]             (@ref rte_ethdev.h),
415129044dSC.J. Collier  [ethctrl]            (@ref rte_eth_ctrl.h),
425129044dSC.J. Collier  [cryptodev]          (@ref rte_cryptodev.h),
435129044dSC.J. Collier  [devargs]            (@ref rte_devargs.h),
445129044dSC.J. Collier  [bond]               (@ref rte_eth_bond.h),
455129044dSC.J. Collier  [vhost]              (@ref rte_virtio_net.h),
465129044dSC.J. Collier  [KNI]                (@ref rte_kni.h),
475129044dSC.J. Collier  [PCI]                (@ref rte_pci.h),
485129044dSC.J. Collier
495129044dSC.J. Collier- **memory**:
505129044dSC.J. Collier  [memseg]             (@ref rte_memory.h),
515129044dSC.J. Collier  [memzone]            (@ref rte_memzone.h),
525129044dSC.J. Collier  [mempool]            (@ref rte_mempool.h),
535129044dSC.J. Collier  [malloc]             (@ref rte_malloc.h),
545129044dSC.J. Collier  [memcpy]             (@ref rte_memcpy.h)
555129044dSC.J. Collier
565129044dSC.J. Collier- **timers**:
575129044dSC.J. Collier  [cycles]             (@ref rte_cycles.h),
585129044dSC.J. Collier  [timer]              (@ref rte_timer.h),
595129044dSC.J. Collier  [alarm]              (@ref rte_alarm.h)
605129044dSC.J. Collier
615129044dSC.J. Collier- **locks**:
625129044dSC.J. Collier  [atomic]             (@ref rte_atomic.h),
635129044dSC.J. Collier  [rwlock]             (@ref rte_rwlock.h),
645129044dSC.J. Collier  [spinlock]           (@ref rte_spinlock.h)
655129044dSC.J. Collier
665129044dSC.J. Collier- **CPU arch**:
675129044dSC.J. Collier  [branch prediction]  (@ref rte_branch_prediction.h),
685129044dSC.J. Collier  [cache prefetch]     (@ref rte_prefetch.h),
695129044dSC.J. Collier  [byte order]         (@ref rte_byteorder.h),
705129044dSC.J. Collier  [CPU flags]          (@ref rte_cpuflags.h)
715129044dSC.J. Collier
725129044dSC.J. Collier- **CPU multicore**:
735129044dSC.J. Collier  [interrupts]         (@ref rte_interrupts.h),
745129044dSC.J. Collier  [launch]             (@ref rte_launch.h),
755129044dSC.J. Collier  [lcore]              (@ref rte_lcore.h),
765129044dSC.J. Collier  [per-lcore]          (@ref rte_per_lcore.h),
775129044dSC.J. Collier  [power/freq]         (@ref rte_power.h)
785129044dSC.J. Collier
795129044dSC.J. Collier- **layers**:
805129044dSC.J. Collier  [ethernet]           (@ref rte_ether.h),
815129044dSC.J. Collier  [ARP]                (@ref rte_arp.h),
825129044dSC.J. Collier  [ICMP]               (@ref rte_icmp.h),
835129044dSC.J. Collier  [IP]                 (@ref rte_ip.h),
845129044dSC.J. Collier  [SCTP]               (@ref rte_sctp.h),
855129044dSC.J. Collier  [TCP]                (@ref rte_tcp.h),
865129044dSC.J. Collier  [UDP]                (@ref rte_udp.h),
875129044dSC.J. Collier  [frag/reass]         (@ref rte_ip_frag.h),
885129044dSC.J. Collier  [LPM IPv4 route]     (@ref rte_lpm.h),
895129044dSC.J. Collier  [LPM IPv6 route]     (@ref rte_lpm6.h),
905129044dSC.J. Collier  [ACL]                (@ref rte_acl.h)
915129044dSC.J. Collier
925129044dSC.J. Collier- **QoS**:
935129044dSC.J. Collier  [metering]           (@ref rte_meter.h),
945129044dSC.J. Collier  [scheduler]          (@ref rte_sched.h),
955129044dSC.J. Collier  [RED congestion]     (@ref rte_red.h)
965129044dSC.J. Collier
975129044dSC.J. Collier- **hashes**:
985129044dSC.J. Collier  [hash]               (@ref rte_hash.h),
995129044dSC.J. Collier  [jhash]              (@ref rte_jhash.h),
1005129044dSC.J. Collier  [thash]              (@ref rte_thash.h),
1015129044dSC.J. Collier  [FBK hash]           (@ref rte_fbk_hash.h),
1025129044dSC.J. Collier  [CRC hash]           (@ref rte_hash_crc.h)
1035129044dSC.J. Collier
1045129044dSC.J. Collier- **containers**:
1055129044dSC.J. Collier  [mbuf]               (@ref rte_mbuf.h),
1065129044dSC.J. Collier  [ring]               (@ref rte_ring.h),
1075129044dSC.J. Collier  [distributor]        (@ref rte_distributor.h),
1085129044dSC.J. Collier  [reorder]            (@ref rte_reorder.h),
1095129044dSC.J. Collier  [tailq]              (@ref rte_tailq.h),
1105129044dSC.J. Collier  [bitmap]             (@ref rte_bitmap.h),
1115129044dSC.J. Collier
1125129044dSC.J. Collier- **packet framework**:
1135129044dSC.J. Collier  * [port]             (@ref rte_port.h):
1145129044dSC.J. Collier    [ethdev]           (@ref rte_port_ethdev.h),
1155129044dSC.J. Collier    [ring]             (@ref rte_port_ring.h),
1165129044dSC.J. Collier    [frag]             (@ref rte_port_frag.h),
1175129044dSC.J. Collier    [reass]            (@ref rte_port_ras.h),
1185129044dSC.J. Collier    [sched]            (@ref rte_port_sched.h),
119809f0800SChristian Ehrhardt    [kni]              (@ref rte_port_kni.h),
1205129044dSC.J. Collier    [src/sink]         (@ref rte_port_source_sink.h)
1215129044dSC.J. Collier  * [table]            (@ref rte_table.h):
1225129044dSC.J. Collier    [lpm IPv4]         (@ref rte_table_lpm.h),
1235129044dSC.J. Collier    [lpm IPv6]         (@ref rte_table_lpm_ipv6.h),
1245129044dSC.J. Collier    [ACL]              (@ref rte_table_acl.h),
1255129044dSC.J. Collier    [hash]             (@ref rte_table_hash.h),
1265129044dSC.J. Collier    [array]            (@ref rte_table_array.h),
1275129044dSC.J. Collier    [stub]             (@ref rte_table_stub.h)
1285129044dSC.J. Collier  * [pipeline]         (@ref rte_pipeline.h)
1295129044dSC.J. Collier
1305129044dSC.J. Collier- **basic**:
1315129044dSC.J. Collier  [approx fraction]    (@ref rte_approx.h),
1325129044dSC.J. Collier  [random]             (@ref rte_random.h),
1335129044dSC.J. Collier  [config file]        (@ref rte_cfgfile.h),
1345129044dSC.J. Collier  [key/value args]     (@ref rte_kvargs.h),
1355129044dSC.J. Collier  [string]             (@ref rte_string_fns.h)
1365129044dSC.J. Collier
1375129044dSC.J. Collier- **debug**:
1385129044dSC.J. Collier  [jobstats]           (@ref rte_jobstats.h),
1395129044dSC.J. Collier  [hexdump]            (@ref rte_hexdump.h),
1405129044dSC.J. Collier  [debug]              (@ref rte_debug.h),
1415129044dSC.J. Collier  [log]                (@ref rte_log.h),
1425129044dSC.J. Collier  [warnings]           (@ref rte_warnings.h),
1435129044dSC.J. Collier  [errno]              (@ref rte_errno.h)
1445129044dSC.J. Collier
1455129044dSC.J. Collier- **misc**:
1465129044dSC.J. Collier  [EAL config]         (@ref rte_eal.h),
1475129044dSC.J. Collier  [common]             (@ref rte_common.h),
1485129044dSC.J. Collier  [ABI compat]         (@ref rte_compat.h),
1495129044dSC.J. Collier  [keepalive]          (@ref rte_keepalive.h),
1505129044dSC.J. Collier  [version]            (@ref rte_version.h)
151