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   [bnxt]               (@ref rte_pmd_bnxt.h),
  46   [dpaa]               (@ref rte_pmd_dpaa.h),
  47   [dpaa2]              (@ref rte_pmd_dpaa2.h),
  48   [dpaa2_mempool]      (@ref rte_dpaa2_mempool.h),
  49   [dpaa2_cmdif]        (@ref rte_pmd_dpaa2_cmdif.h),
  50   [dpaa2_qdma]         (@ref rte_pmd_dpaa2_qdma.h),
  51   [crypto_scheduler]   (@ref rte_cryptodev_scheduler.h)
  52
  53 - **memory**:
  54   [memseg]             (@ref rte_memory.h),
  55   [memzone]            (@ref rte_memzone.h),
  56   [mempool]            (@ref rte_mempool.h),
  57   [malloc]             (@ref rte_malloc.h),
  58   [memcpy]             (@ref rte_memcpy.h)
  59
  60 - **timers**:
  61   [cycles]             (@ref rte_cycles.h),
  62   [timer]              (@ref rte_timer.h),
  63   [alarm]              (@ref rte_alarm.h)
  64
  65 - **locks**:
  66   [atomic]             (@ref rte_atomic.h),
  67   [mcslock]            (@ref rte_mcslock.h),
  68   [rwlock]             (@ref rte_rwlock.h),
  69   [spinlock]           (@ref rte_spinlock.h),
  70   [ticketlock]         (@ref rte_ticketlock.h),
  71   [RCU]                (@ref rte_rcu_qsbr.h)
  72
  73 - **CPU arch**:
  74   [branch prediction]  (@ref rte_branch_prediction.h),
  75   [cache prefetch]     (@ref rte_prefetch.h),
  76   [SIMD]               (@ref rte_vect.h),
  77   [byte order]         (@ref rte_byteorder.h),
  78   [CPU flags]          (@ref rte_cpuflags.h),
  79   [CPU pause]          (@ref rte_pause.h),
  80   [I/O access]         (@ref rte_io.h)
  81
  82 - **CPU multicore**:
  83   [interrupts]         (@ref rte_interrupts.h),
  84   [launch]             (@ref rte_launch.h),
  85   [lcore]              (@ref rte_lcore.h),
  86   [per-lcore]          (@ref rte_per_lcore.h),
  87   [service cores]      (@ref rte_service.h),
  88   [keepalive]          (@ref rte_keepalive.h),
  89   [power/freq]         (@ref rte_power.h)
  90
  91 - **layers**:
  92   [ethernet]           (@ref rte_ether.h),
  93   [ARP]                (@ref rte_arp.h),
  94   [ICMP]               (@ref rte_icmp.h),
  95   [ESP]                (@ref rte_esp.h),
  96   [IPsec]              (@ref rte_ipsec.h),
  97   [IPsec group]        (@ref rte_ipsec_group.h),
  98   [IPsec SA]           (@ref rte_ipsec_sa.h),
  99   [IPsec SAD]          (@ref rte_ipsec_sad.h),
 100   [IP]                 (@ref rte_ip.h),
 101   [SCTP]               (@ref rte_sctp.h),
 102   [TCP]                (@ref rte_tcp.h),
 103   [UDP]                (@ref rte_udp.h),
 104   [GRO]                (@ref rte_gro.h),
 105   [GSO]                (@ref rte_gso.h),
 106   [frag/reass]         (@ref rte_ip_frag.h),
 107   [LPM IPv4 route]     (@ref rte_lpm.h),
 108   [LPM IPv6 route]     (@ref rte_lpm6.h)
 109
 110 - **QoS**:
 111   [metering]           (@ref rte_meter.h),
 112   [scheduler]          (@ref rte_sched.h),
 113   [RED congestion]     (@ref rte_red.h)
 114
 115 - **hashes**:
 116   [hash]               (@ref rte_hash.h),
 117   [jhash]              (@ref rte_jhash.h),
 118   [thash]              (@ref rte_thash.h),
 119   [FBK hash]           (@ref rte_fbk_hash.h),
 120   [CRC hash]           (@ref rte_hash_crc.h)
 121
 122 - **classification**
 123   [reorder]            (@ref rte_reorder.h),
 124   [distributor]        (@ref rte_distributor.h),
 125   [EFD]                (@ref rte_efd.h),
 126   [ACL]                (@ref rte_acl.h),
 127   [member]             (@ref rte_member.h),
 128   [flow classify]      (@ref rte_flow_classify.h),
 129   [BPF]                (@ref rte_bpf.h)
 130
 131 - **containers**:
 132   [mbuf]               (@ref rte_mbuf.h),
 133   [mbuf pool ops]      (@ref rte_mbuf_pool_ops.h),
 134   [ring]               (@ref rte_ring.h),
 135   [stack]              (@ref rte_stack.h),
 136   [tailq]              (@ref rte_tailq.h),
 137   [bitmap]             (@ref rte_bitmap.h)
 138
 139 - **packet framework**:
 140   * [port]             (@ref rte_port.h):
 141     [ethdev]           (@ref rte_port_ethdev.h),
 142     [ring]             (@ref rte_port_ring.h),
 143     [frag]             (@ref rte_port_frag.h),
 144     [reass]            (@ref rte_port_ras.h),
 145     [sched]            (@ref rte_port_sched.h),
 146     [kni]              (@ref rte_port_kni.h),
 147     [src/sink]         (@ref rte_port_source_sink.h)
 148   * [table]            (@ref rte_table.h):
 149     [lpm IPv4]         (@ref rte_table_lpm.h),
 150     [lpm IPv6]         (@ref rte_table_lpm_ipv6.h),
 151     [ACL]              (@ref rte_table_acl.h),
 152     [hash]             (@ref rte_table_hash.h),
 153     [array]            (@ref rte_table_array.h),
 154     [stub]             (@ref rte_table_stub.h)
 155   * [pipeline]         (@ref rte_pipeline.h)
 156     [port_in_action]   (@ref rte_port_in_action.h)
 157     [table_action]     (@ref rte_table_action.h)
 158
 159 - **basic**:
 160   [approx fraction]    (@ref rte_approx.h),
 161   [random]             (@ref rte_random.h),
 162   [config file]        (@ref rte_cfgfile.h),
 163   [key/value args]     (@ref rte_kvargs.h),
 164   [string]             (@ref rte_string_fns.h)
 165
 166 - **debug**:
 167   [jobstats]           (@ref rte_jobstats.h),
 168   [telemetry]          (@ref rte_telemetry.h),
 169   [pdump]              (@ref rte_pdump.h),
 170   [hexdump]            (@ref rte_hexdump.h),
 171   [debug]              (@ref rte_debug.h),
 172   [log]                (@ref rte_log.h),
 173   [errno]              (@ref rte_errno.h)
 174
 175 - **misc**:
 176   [EAL config]         (@ref rte_eal.h),
 177   [common]             (@ref rte_common.h),
 178   [ABI compat]         (@ref rte_compat.h),
 179   [version]            (@ref rte_version.h)