doc/guides/prog_guide/source_org.rst

   1 ..  BSD LICENSE
   2     Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
   3     All rights reserved.
   4
   5     Redistribution and use in source and binary forms, with or without
   6     modification, are permitted provided that the following conditions
   7     are met:
   8
   9     * Redistributions of source code must retain the above copyright
  10     notice, this list of conditions and the following disclaimer.
  11     * Redistributions in binary form must reproduce the above copyright
  12     notice, this list of conditions and the following disclaimer in
  13     the documentation and/or other materials provided with the
  14     distribution.
  15     * Neither the name of Intel Corporation nor the names of its
  16     contributors may be used to endorse or promote products derived
  17     from this software without specific prior written permission.
  18
  19     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  20     "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  21     LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  22     A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  23     OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  24     SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  25     LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  26     DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  27     THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  28     (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  29     OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  30
  31 **Part 2: Development Environment**
  32
  33 Source Organization
  34 ===================
  35
  36 This section describes the organization of sources in the DPDK framework.
  37
  38 Makefiles and Config
  39 --------------------
  40
  41 .. note::
  42
  43     In the following descriptions,
  44     RTE_SDK is the environment variable that points to the base directory into which the tarball was extracted.
  45     See
  46     :ref:`Useful Variables Provided by the Build System <Useful_Variables_Provided_by_the_Build_System>`
  47     for descriptions of other variables.
  48
  49 Makefiles that are provided by the DPDK libraries and applications are located in $(RTE_SDK)/mk.
  50
  51 Config templates are located in $(RTE_SDK)/config. The templates describe the options that are enabled for each target.
  52 The config file also contains items that can be enabled and disabled for many of the DPDK libraries,
  53 including debug options.
  54 The user should look at the config file and become familiar with the options.
  55 The config file is also used to create a header file, which will be located in the new build directory.
  56
  57 Libraries
  58 ---------
  59
  60 Libraries are located in subdirectories of $(RTE_SDK)/lib.
  61 By convention, we call a library any code that provides an API to an application.
  62 Typically, it generates an archive file (.a), but a kernel module should also go in the same directory.
  63
  64 The lib directory contains::
  65
  66     lib
  67     +-- librte_cmdline      # command line interface helper
  68     +-- librte_distributor  # packet distributor
  69     +-- librte_eal          # environment abstraction layer
  70     +-- librte_ether        # generic interface to poll mode driver
  71     +-- librte_hash         # hash library
  72     +-- librte_ip_frag      # IP fragmentation library
  73     +-- librte_ivshmem      # QEMU IVSHMEM library
  74     +-- librte_kni          # kernel NIC interface
  75     +-- librte_kvargs       # argument parsing library
  76     +-- librte_lpm          # longest prefix match library
  77     +-- librte_malloc       # malloc-like functions
  78     +-- librte_mbuf         # packet and control mbuf manipulation library
  79     +-- librte_mempool      # memory pool manager (fixedsized objects)
  80     +-- librte_meter        # QoS metering library
  81     +-- librte_net          # various IP-related headers
  82     +-- librte_pmd_vmxnet3  # VMXNET3 poll mode driver
  83     +-- librte_pmd_xenvirt  # Xen virtio poll mode driver
  84     +-- librte_power        # power management library
  85     +-- librte_ring         # software rings (act as lockless FIFOs)
  86     +-- librte_sched        # QoS scheduler and dropper library
  87     +-- librte_timer        # timer library
  88
  89 Drivers
  90 -------
  91
  92 Drivers are special libraries which provide poll-mode driver implementations for
  93 devices - either hardware devices or pseudo/virtual devices. They are contained
  94 in the "drivers" subdirectory, classified by type, and each compiles to a
  95 library with the format "librte_pmd_X.a" where "X" is the driver name.
  96
  97 The drivers directory has a net subdirectory which contains::
  98
  99     drivers/net
 100     +-- af_packet          # poll mode driver based on linux af_packet
 101     +-- bonding            # bonding poll mode driver
 102     +-- e1000              # 1GbE poll mode drivers (igb and em)
 103     +-- enic               # Cisco VIC Ethernet NIC Poll-mode Driver
 104     +-- fm10k              # Host interface PMD driver for FM10000 Series
 105     +-- i40e               # 40GbE poll mode driver
 106     +-- ixgbe              # 10GbE poll mode driver
 107     +-- mlx4               # Mellanox ConnectX-3 poll mode driver
 108     +-- null               # NULL poll mode driver for testing
 109     +-- pcap               # PCAP poll mode driver
 110     +-- ring               # ring poll mode driver
 111     +-- virtio             # virtio poll mode driver
 112
 113 Applications
 114 ------------
 115
 116 Applications are sources that contain a main() function.
 117 They are located in the $(RTE_SDK)/app and $(RTE_SDK)/examples directories.
 118
 119 The app directory contains sample applications that are used to test the DPDK (autotests).
 120 The examples directory contains sample applications that show how libraries can be used.
 121
 122 ::
 123
 124     app
 125     +-- chkincs            # test prog to check include depends
 126     +-- test               # autotests, to validate DPDK features
 127     `-- test-pmd           # test and bench poll mode driver examples
 128
 129     examples
 130     +-- cmdline            # Example of using cmdline library
 131     +-- dpdk_qat           # Example showing integration with Intel QuickAssist
 132     +-- exception_path     # Sending packets to and from Linux Ethernet device (TAP)
 133     +-- helloworld         # Helloworld basic example
 134     +-- ip_reassembly      # Example showing IP Reassembly
 135     +-- ip_fragmentation   # Example showing IPv4 Fragmentation
 136     +-- ipv4_multicast     # Example showing IPv4 Multicast
 137     +-- kni                # Kernel NIC Interface example
 138     +-- l2fwd              # L2 Forwarding example with and without SR-IOV
 139     +-- l3fwd              # L3 Forwarding example
 140     +-- l3fwd-power        # L3 Forwarding example with power management
 141     +-- l3fwd-vf           # L3 Forwarding example with SR-IOV
 142     +-- link_status_interrupt # Link status change interrupt example
 143     +-- load_balancer      # Load balancing across multiple cores/sockets
 144     +-- multi_process      # Example applications with multiple DPDK processes
 145     +-- qos_meter          # QoS metering example
 146     +-- qos_sched          # QoS scheduler and dropper example
 147     +-- timer              # Example of using librte_timer library
 148     +-- vmdq_dcb           # Intel 82599 Ethernet Controller VMDQ and DCB receiving
 149     +-- vmdq               # Example of VMDQ receiving for both Intel 10G (82599) and 1G (82576, 82580 and I350) Ethernet Controllers
 150     `-- vhost              # Example of userspace vhost and switch
 151
 152 .. note::
 153
 154     The actual examples directory may contain additional sample applications to those shown above.
 155     Check the latest DPDK source files for details.