doc/guides/prog_guide/index.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 Programmer's Guide
  32 ==================
  33
  34 .. toctree::
  35     :maxdepth: 3
  36     :numbered:
  37
  38     intro
  39     overview
  40     env_abstraction_layer
  41     ring_lib
  42     mempool_lib
  43     mbuf_lib
  44     poll_mode_drv
  45     ivshmem_lib
  46     link_bonding_poll_mode_drv_lib
  47     timer_lib
  48     hash_lib
  49     lpm_lib
  50     lpm6_lib
  51     packet_distrib_lib
  52     reorder_lib
  53     ip_fragment_reassembly_lib
  54     multi_proc_support
  55     kernel_nic_interface
  56     thread_safety_dpdk_functions
  57     qos_framework
  58     power_man
  59     packet_classif_access_ctrl
  60     packet_framework
  61     vhost_lib
  62     port_hotplug_framework
  63     source_org
  64     dev_kit_build_system
  65     dev_kit_root_make_help
  66     extend_dpdk
  67     build_app
  68     ext_app_lib_make_help
  69     perf_opt_guidelines
  70     writing_efficient_code
  71     profile_app
  72     glossary
  73
  74
  75 **Figures**
  76
  77 :numref:`figure_architecture-overview` :ref:`figure_architecture-overview`
  78
  79 :numref:`figure_linuxapp_launch` :ref:`figure_linuxapp_launch`
  80
  81 :numref:`figure_malloc_heap` :ref:`figure_malloc_heap`
  82
  83 :numref:`figure_ring1` :ref:`figure_ring1`
  84
  85 :numref:`figure_ring-enqueue1` :ref:`figure_ring-enqueue1`
  86
  87 :numref:`figure_ring-enqueue2` :ref:`figure_ring-enqueue2`
  88
  89 :numref:`figure_ring-enqueue3` :ref:`figure_ring-enqueue3`
  90
  91 :numref:`figure_ring-dequeue1` :ref:`figure_ring-dequeue1`
  92
  93 :numref:`figure_ring-dequeue2` :ref:`figure_ring-dequeue2`
  94
  95 :numref:`figure_ring-dequeue3` :ref:`figure_ring-dequeue3`
  96
  97 :numref:`figure_ring-mp-enqueue1` :ref:`figure_ring-mp-enqueue1`
  98
  99 :numref:`figure_ring-mp-enqueue2` :ref:`figure_ring-mp-enqueue2`
 100
 101 :numref:`figure_ring-mp-enqueue3` :ref:`figure_ring-mp-enqueue3`
 102
 103 :numref:`figure_ring-mp-enqueue4` :ref:`figure_ring-mp-enqueue4`
 104
 105 :numref:`figure_ring-mp-enqueue5` :ref:`figure_ring-mp-enqueue5`
 106
 107 :numref:`figure_ring-modulo1` :ref:`figure_ring-modulo1`
 108
 109 :numref:`figure_ring-modulo2` :ref:`figure_ring-modulo2`
 110
 111 :numref:`figure_memory-management` :ref:`figure_memory-management`
 112
 113 :numref:`figure_memory-management2` :ref:`figure_memory-management2`
 114
 115 :numref:`figure_mempool` :ref:`figure_mempool`
 116
 117 :numref:`figure_mbuf1` :ref:`figure_mbuf1`
 118
 119 :numref:`figure_mbuf2` :ref:`figure_mbuf2`
 120
 121 :numref:`figure_multi_process_memory` :ref:`figure_multi_process_memory`
 122
 123 :numref:`figure_kernel_nic_intf` :ref:`figure_kernel_nic_intf`
 124
 125 :numref:`figure_pkt_flow_kni` :ref:`figure_pkt_flow_kni`
 126
 127 :numref:`figure_vhost_net_arch2` :ref:`figure_vhost_net_arch2`
 128
 129 :numref:`figure_kni_traffic_flow` :ref:`figure_kni_traffic_flow`
 130
 131
 132 :numref:`figure_pkt_proc_pipeline_qos` :ref:`figure_pkt_proc_pipeline_qos`
 133
 134 :numref:`figure_hier_sched_blk` :ref:`figure_hier_sched_blk`
 135
 136 :numref:`figure_sched_hier_per_port` :ref:`figure_sched_hier_per_port`
 137
 138 :numref:`figure_data_struct_per_port` :ref:`figure_data_struct_per_port`
 139
 140 :numref:`figure_prefetch_pipeline` :ref:`figure_prefetch_pipeline`
 141
 142 :numref:`figure_pipe_prefetch_sm` :ref:`figure_pipe_prefetch_sm`
 143
 144 :numref:`figure_blk_diag_dropper` :ref:`figure_blk_diag_dropper`
 145
 146 :numref:`figure_flow_tru_droppper` :ref:`figure_flow_tru_droppper`
 147
 148 :numref:`figure_ex_data_flow_tru_dropper` :ref:`figure_ex_data_flow_tru_dropper`
 149
 150 :numref:`figure_pkt_drop_probability` :ref:`figure_pkt_drop_probability`
 151
 152 :numref:`figure_drop_probability_graph` :ref:`figure_drop_probability_graph`
 153
 154 :numref:`figure_figure32` :ref:`figure_figure32`
 155
 156 :numref:`figure_figure33` :ref:`figure_figure33`
 157
 158 :numref:`figure_figure34` :ref:`figure_figure34`
 159
 160 :numref:`figure_figure35` :ref:`figure_figure35`
 161
 162 :numref:`figure_figure37` :ref:`figure_figure37`
 163
 164 :numref:`figure_figure38` :ref:`figure_figure38`
 165
 166 :numref:`figure_figure39` :ref:`figure_figure39`
 167
 168
 169 **Tables**
 170
 171 :numref:`table_qos_1` :ref:`table_qos_1`
 172
 173 :numref:`table_qos_2` :ref:`table_qos_2`
 174
 175 :numref:`table_qos_3` :ref:`table_qos_3`
 176
 177 :numref:`table_qos_4` :ref:`table_qos_4`
 178
 179 :numref:`table_qos_5` :ref:`table_qos_5`
 180
 181 :numref:`table_qos_6` :ref:`table_qos_6`
 182
 183 :numref:`table_qos_7` :ref:`table_qos_7`
 184
 185 :numref:`table_qos_8` :ref:`table_qos_8`
 186
 187 :numref:`table_qos_9` :ref:`table_qos_9`
 188
 189 :numref:`table_qos_10` :ref:`table_qos_10`
 190
 191 :numref:`table_qos_11` :ref:`table_qos_11`
 192
 193 :numref:`table_qos_12` :ref:`table_qos_12`
 194
 195 :numref:`table_qos_13` :ref:`table_qos_13`
 196
 197 :numref:`table_qos_14` :ref:`table_qos_14`
 198
 199 :numref:`table_qos_15` :ref:`table_qos_15`
 200
 201 :numref:`table_qos_16` :ref:`table_qos_16`
 202
 203 :numref:`table_qos_17` :ref:`table_qos_17`
 204
 205 :numref:`table_qos_18` :ref:`table_qos_18`
 206
 207 :numref:`table_qos_19` :ref:`table_qos_19`
 208
 209 :numref:`table_qos_20` :ref:`table_qos_20`
 210
 211 :numref:`table_qos_21` :ref:`table_qos_21`
 212
 213 :numref:`table_qos_22` :ref:`table_qos_22`
 214
 215 :numref:`table_qos_23` :ref:`table_qos_23`
 216
 217 :numref:`table_qos_24` :ref:`table_qos_24`
 218
 219 :numref:`table_qos_25` :ref:`table_qos_25`
 220
 221 :numref:`table_qos_26` :ref:`table_qos_26`
 222
 223 :numref:`table_qos_27` :ref:`table_qos_27`
 224
 225 :numref:`table_qos_28` :ref:`table_qos_28`
 226
 227 :numref:`table_qos_29` :ref:`table_qos_29`
 228
 229 :numref:`table_qos_30` :ref:`table_qos_30`
 230
 231 :numref:`table_qos_31` :ref:`table_qos_31`
 232
 233 :numref:`table_qos_32` :ref:`table_qos_32`
 234
 235 :numref:`table_qos_33` :ref:`table_qos_33`
 236
 237 :numref:`table_qos_34` :ref:`table_qos_34`
 238
 239 :numref:`table_hash_lib_1` :ref:`table_hash_lib_1`
 240
 241 :numref:`table_hash_lib_2` :ref:`table_hash_lib_2`