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