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