doc/guides/prog_guide/index.rst

   1 ..  BSD LICENSE
   2     Copyright(c) 2010-2017 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     service_cores
  42     ring_lib
  43     mempool_lib
  44     mbuf_lib
  45     poll_mode_drv
  46     rte_flow
  47     traffic_management
  48     cryptodev_lib
  49     link_bonding_poll_mode_drv_lib
  50     timer_lib
  51     hash_lib
  52     efd_lib
  53     lpm_lib
  54     lpm6_lib
  55     packet_distrib_lib
  56     reorder_lib
  57     ip_fragment_reassembly_lib
  58     generic_receive_offload_lib
  59     pdump_lib
  60     multi_proc_support
  61     kernel_nic_interface
  62     thread_safety_dpdk_functions
  63     eventdev
  64     qos_framework
  65     power_man
  66     packet_classif_access_ctrl
  67     packet_framework
  68     vhost_lib
  69     metrics_lib
  70     port_hotplug_framework
  71     source_org
  72     dev_kit_build_system
  73     dev_kit_root_make_help
  74     extend_dpdk
  75     build_app
  76     ext_app_lib_make_help
  77     perf_opt_guidelines
  78     writing_efficient_code
  79     profile_app
  80     glossary
  81
  82
  83 **Figures**
  84
  85 :numref:`figure_architecture-overview` :ref:`figure_architecture-overview`
  86
  87 :numref:`figure_linuxapp_launch` :ref:`figure_linuxapp_launch`
  88
  89 :numref:`figure_malloc_heap` :ref:`figure_malloc_heap`
  90
  91 :numref:`figure_ring1` :ref:`figure_ring1`
  92
  93 :numref:`figure_ring-enqueue1` :ref:`figure_ring-enqueue1`
  94
  95 :numref:`figure_ring-enqueue2` :ref:`figure_ring-enqueue2`
  96
  97 :numref:`figure_ring-enqueue3` :ref:`figure_ring-enqueue3`
  98
  99 :numref:`figure_ring-dequeue1` :ref:`figure_ring-dequeue1`
 100
 101 :numref:`figure_ring-dequeue2` :ref:`figure_ring-dequeue2`
 102
 103 :numref:`figure_ring-dequeue3` :ref:`figure_ring-dequeue3`
 104
 105 :numref:`figure_ring-mp-enqueue1` :ref:`figure_ring-mp-enqueue1`
 106
 107 :numref:`figure_ring-mp-enqueue2` :ref:`figure_ring-mp-enqueue2`
 108
 109 :numref:`figure_ring-mp-enqueue3` :ref:`figure_ring-mp-enqueue3`
 110
 111 :numref:`figure_ring-mp-enqueue4` :ref:`figure_ring-mp-enqueue4`
 112
 113 :numref:`figure_ring-mp-enqueue5` :ref:`figure_ring-mp-enqueue5`
 114
 115 :numref:`figure_ring-modulo1` :ref:`figure_ring-modulo1`
 116
 117 :numref:`figure_ring-modulo2` :ref:`figure_ring-modulo2`
 118
 119 :numref:`figure_memory-management` :ref:`figure_memory-management`
 120
 121 :numref:`figure_memory-management2` :ref:`figure_memory-management2`
 122
 123 :numref:`figure_mempool` :ref:`figure_mempool`
 124
 125 :numref:`figure_mbuf1` :ref:`figure_mbuf1`
 126
 127 :numref:`figure_mbuf2` :ref:`figure_mbuf2`
 128
 129 :numref:`figure_multi_process_memory` :ref:`figure_multi_process_memory`
 130
 131 :numref:`figure_kernel_nic_intf` :ref:`figure_kernel_nic_intf`
 132
 133 :numref:`figure_pkt_flow_kni` :ref:`figure_pkt_flow_kni`
 134
 135
 136 :numref:`figure_pkt_proc_pipeline_qos` :ref:`figure_pkt_proc_pipeline_qos`
 137
 138 :numref:`figure_hier_sched_blk` :ref:`figure_hier_sched_blk`
 139
 140 :numref:`figure_sched_hier_per_port` :ref:`figure_sched_hier_per_port`
 141
 142 :numref:`figure_data_struct_per_port` :ref:`figure_data_struct_per_port`
 143
 144 :numref:`figure_prefetch_pipeline` :ref:`figure_prefetch_pipeline`
 145
 146 :numref:`figure_pipe_prefetch_sm` :ref:`figure_pipe_prefetch_sm`
 147
 148 :numref:`figure_blk_diag_dropper` :ref:`figure_blk_diag_dropper`
 149
 150 :numref:`figure_flow_tru_droppper` :ref:`figure_flow_tru_droppper`
 151
 152 :numref:`figure_ex_data_flow_tru_dropper` :ref:`figure_ex_data_flow_tru_dropper`
 153
 154 :numref:`figure_pkt_drop_probability` :ref:`figure_pkt_drop_probability`
 155
 156 :numref:`figure_drop_probability_graph` :ref:`figure_drop_probability_graph`
 157
 158 :numref:`figure_figure32` :ref:`figure_figure32`
 159
 160 :numref:`figure_figure33` :ref:`figure_figure33`
 161
 162 :numref:`figure_figure34` :ref:`figure_figure34`
 163
 164 :numref:`figure_figure35` :ref:`figure_figure35`
 165
 166 :numref:`figure_figure37` :ref:`figure_figure37`
 167
 168 :numref:`figure_figure38` :ref:`figure_figure38`
 169
 170 :numref:`figure_figure39` :ref:`figure_figure39`
 171
 172 :numref:`figure_efd1` :ref:`figure_efd1`
 173
 174 :numref:`figure_efd2` :ref:`figure_efd2`
 175
 176 :numref:`figure_efd3` :ref:`figure_efd3`
 177
 178 :numref:`figure_efd4` :ref:`figure_efd4`
 179
 180 :numref:`figure_efd5` :ref:`figure_efd5`
 181
 182 :numref:`figure_efd6` :ref:`figure_efd6`
 183
 184 :numref:`figure_efd7` :ref:`figure_efd7`
 185
 186 :numref:`figure_efd8` :ref:`figure_efd8`
 187
 188 :numref:`figure_efd9` :ref:`figure_efd9`
 189
 190 :numref:`figure_efd10` :ref:`figure_efd10`
 191
 192 :numref:`figure_efd11` :ref:`figure_efd11`
 193
 194
 195 **Tables**
 196
 197 :numref:`table_qos_1` :ref:`table_qos_1`
 198
 199 :numref:`table_qos_2` :ref:`table_qos_2`
 200
 201 :numref:`table_qos_3` :ref:`table_qos_3`
 202
 203 :numref:`table_qos_4` :ref:`table_qos_4`
 204
 205 :numref:`table_qos_5` :ref:`table_qos_5`
 206
 207 :numref:`table_qos_6` :ref:`table_qos_6`
 208
 209 :numref:`table_qos_7` :ref:`table_qos_7`
 210
 211 :numref:`table_qos_8` :ref:`table_qos_8`
 212
 213 :numref:`table_qos_9` :ref:`table_qos_9`
 214
 215 :numref:`table_qos_10` :ref:`table_qos_10`
 216
 217 :numref:`table_qos_11` :ref:`table_qos_11`
 218
 219 :numref:`table_qos_12` :ref:`table_qos_12`
 220
 221 :numref:`table_qos_13` :ref:`table_qos_13`
 222
 223 :numref:`table_qos_14` :ref:`table_qos_14`
 224
 225 :numref:`table_qos_15` :ref:`table_qos_15`
 226
 227 :numref:`table_qos_16` :ref:`table_qos_16`
 228
 229 :numref:`table_qos_17` :ref:`table_qos_17`
 230
 231 :numref:`table_qos_18` :ref:`table_qos_18`
 232
 233 :numref:`table_qos_19` :ref:`table_qos_19`
 234
 235 :numref:`table_qos_20` :ref:`table_qos_20`
 236
 237 :numref:`table_qos_21` :ref:`table_qos_21`
 238
 239 :numref:`table_qos_22` :ref:`table_qos_22`
 240
 241 :numref:`table_qos_23` :ref:`table_qos_23`
 242
 243 :numref:`table_qos_24` :ref:`table_qos_24`
 244
 245 :numref:`table_qos_25` :ref:`table_qos_25`
 246
 247 :numref:`table_qos_26` :ref:`table_qos_26`
 248
 249 :numref:`table_qos_27` :ref:`table_qos_27`
 250
 251 :numref:`table_qos_28` :ref:`table_qos_28`
 252
 253 :numref:`table_qos_29` :ref:`table_qos_29`
 254
 255 :numref:`table_qos_30` :ref:`table_qos_30`
 256
 257 :numref:`table_qos_31` :ref:`table_qos_31`
 258
 259 :numref:`table_qos_32` :ref:`table_qos_32`
 260
 261 :numref:`table_qos_33` :ref:`table_qos_33`
 262
 263 :numref:`table_qos_34` :ref:`table_qos_34`
 264
 265 :numref:`table_hash_lib_1` :ref:`table_hash_lib_1`
 266
 267 :numref:`table_hash_lib_2` :ref:`table_hash_lib_2`