doc/doxy-api-index.md

   1 API {#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
  36 There are many libraries, so their headers may be grouped by topics:
  37
  38 - **device**:
  39   [ethdev]             (@ref rte_ethdev.h),
  40   [devargs]            (@ref rte_devargs.h),
  41   [KNI]                (@ref rte_kni.h),
  42   [PCI]                (@ref rte_pci.h),
  43   [PCI IDs]            (@ref rte_pci_dev_ids.h)
  44
  45 - **memory**:
  46   [memseg]             (@ref rte_memory.h),
  47   [memzone]            (@ref rte_memzone.h),
  48   [mempool]            (@ref rte_mempool.h),
  49   [malloc]             (@ref rte_malloc.h),
  50   [memcpy]             (@ref rte_memcpy.h)
  51
  52 - **timers**:
  53   [cycles]             (@ref rte_cycles.h),
  54   [timer]              (@ref rte_timer.h),
  55   [alarm]              (@ref rte_alarm.h)
  56
  57 - **locks**:
  58   [atomic]             (@ref rte_atomic.h),
  59   [rwlock]             (@ref rte_rwlock.h),
  60   [spinlock]           (@ref rte_spinlock.h)
  61
  62 - **CPU arch**:
  63   [branch prediction]  (@ref rte_branch_prediction.h),
  64   [cache prefetch]     (@ref rte_prefetch.h),
  65   [byte order]         (@ref rte_byteorder.h),
  66   [CPU flags]          (@ref rte_cpuflags.h)
  67
  68 - **CPU multicore**:
  69   [interrupts]         (@ref rte_interrupts.h),
  70   [launch]             (@ref rte_launch.h),
  71   [lcore]              (@ref rte_lcore.h),
  72   [per-lcore]          (@ref rte_per_lcore.h),
  73   [power/freq]         (@ref rte_power.h)
  74
  75 - **layers**:
  76   [ethernet]           (@ref rte_ether.h),
  77   [IP]                 (@ref rte_ip.h),
  78   [SCTP]               (@ref rte_sctp.h),
  79   [TCP]                (@ref rte_tcp.h),
  80   [UDP]                (@ref rte_udp.h),
  81   [frag/reass]         (@ref rte_ip_frag.h),
  82   [LPM route]          (@ref rte_lpm.h),
  83   [ACL]                (@ref rte_acl.h)
  84
  85 - **QoS**:
  86   [metering]           (@ref rte_meter.h),
  87   [scheduler]          (@ref rte_sched.h),
  88   [RED congestion]     (@ref rte_red.h)
  89
  90 - **hashes**:
  91   [hash]               (@ref rte_hash.h),
  92   [jhash]              (@ref rte_jhash.h),
  93   [FBK hash]           (@ref rte_fbk_hash.h),
  94   [CRC hash]           (@ref rte_hash_crc.h)
  95
  96 - **containers**:
  97   [mbuf]               (@ref rte_mbuf.h),
  98   [ring]               (@ref rte_ring.h),
  99   [distributor]        (@ref rte_distributor.h),
 100   [tailq]              (@ref rte_tailq.h),
 101   [bitmap]             (@ref rte_bitmap.h)
 102
 103 - **packet framework**:
 104   * [port]             (@ref rte_port.h):
 105     [ethdev]           (@ref rte_port_ethdev.h),
 106     [ring]             (@ref rte_port_ring.h),
 107
 108 - **basic**:
 109   [approx fraction]    (@ref rte_approx.h),
 110   [random]             (@ref rte_random.h),
 111   [key/value args]     (@ref rte_kvargs.h),
 112   [string]             (@ref rte_string_fns.h),
 113
 114 - **debug**:
 115   [debug]              (@ref rte_debug.h),
 116   [log]                (@ref rte_log.h),
 117   [warnings]           (@ref rte_warnings.h),
 118   [errno]              (@ref rte_errno.h)
 119
 120 - **misc**:
 121   [EAL config]         (@ref rte_eal.h),
 122   [common]             (@ref rte_common.h),
 123   [version]            (@ref rte_version.h)