d/numam-dpdk
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
numam-dpdk/doc/guides/prog_guide/index.rst

70 lines
1.3 KiB
ReStructuredText
Raw Normal View History

doc: convert Intel license headers to SPDX tags Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com> Acked-by: Bruce Richardson <bruce.richardson@intel.com>
2018-02-01 17:18:17 +00:00
.. SPDX-License-Identifier: BSD-3-Clause
Copyright(c) 2010-2017 Intel Corporation.
doc: programmers guide The 1.7 DPDK_Prog_Guide document in MSWord has been converted to rst format for use with Sphinx. There is an rst file for each chapter and an index.rst file which contains the table of contents. The top level index file has been modified to include this guide. This document contains some png image files. If any of these png files are modified they should be replaced with an svg file. This is the sixth document from a set of 6 documents. Signed-off-by: Bernard Iremonger <bernard.iremonger@intel.com>
2014-11-14 11:53:41 +00:00
Programmer's Guide
==================
.. toctree::
:maxdepth: 3
:numbered:
intro
overview
env_abstraction_layer
service: introduce service cores concept Add header files, update .map files with new service functions, and add the service header to the doxygen for building. This service header API allows DPDK to use services as a concept of something that requires CPU cycles. An example is a PMD that runs in software to schedule events, where a hardware version exists that does not require a CPU. Signed-off-by: Harry van Haaren <harry.van.haaren@intel.com> Acked-by: Jerin Jacob <jerin.jacob@caviumnetworks.com>
2017-07-11 15:19:27 +01:00
service_cores
doc: add RCU guide Add lib RCU QSBR programmer guide documentation. Signed-off-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com> Reviewed-by: Marko Kovacevic <marko.kovacevic@intel.com> Acked-by: John McNamara <john.mcnamara@intel.com>
2019-04-30 22:54:18 -05:00
rcu_lib
doc: programmers guide The 1.7 DPDK_Prog_Guide document in MSWord has been converted to rst format for use with Sphinx. There is an rst file for each chapter and an index.rst file which contains the table of contents. The top level index file has been modified to include this guide. This document contains some png image files. If any of these png files are modified they should be replaced with an svg file. This is the sixth document from a set of 6 documents. Signed-off-by: Bernard Iremonger <bernard.iremonger@intel.com>
2014-11-14 11:53:41 +00:00
ring_lib
stack: introduce stack library The rte_stack library provides an API for configuration and use of a bounded stack of pointers. Push and pop operations are MT-safe, allowing concurrent access, and the interface supports pushing and popping multiple pointers at a time. The library's interface is modeled after another DPDK data structure, rte_ring, and its lock-based implementation is derived from the stack mempool handler. An upcoming commit will migrate the stack mempool handler to rte_stack. Signed-off-by: Gage Eads <gage.eads@intel.com> Reviewed-by: Olivier Matz <olivier.matz@6wind.com> Reviewed-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>
2019-04-03 18:20:13 -05:00
stack_lib
doc: programmers guide The 1.7 DPDK_Prog_Guide document in MSWord has been converted to rst format for use with Sphinx. There is an rst file for each chapter and an index.rst file which contains the table of contents. The top level index file has been modified to include this guide. This document contains some png image files. If any of these png files are modified they should be replaced with an svg file. This is the sixth document from a set of 6 documents. Signed-off-by: Bernard Iremonger <bernard.iremonger@intel.com>
2014-11-14 11:53:41 +00:00
mempool_lib
mbuf_lib
poll_mode_drv
doc: add generic flow API guide Signed-off-by: Adrien Mazarguil <adrien.mazarguil@6wind.com> Acked-by: Olga Shern <olgas@mellanox.com> Acked-by: John McNamara <john.mcnamara@intel.com>
2016-12-21 15:51:18 +01:00
rte_flow
doc: add switch representation documentation Add document to describe the model for representing switching capable devices in DPDK, using a general ethdev port model and through port representors. This document also details the port model and the rte_flow semantics required for flow programming, as well as listing some example use cases. Signed-off-by: Adrien Mazarguil <adrien.mazarguil@6wind.com> Signed-off-by: Declan Doherty <declan.doherty@intel.com> Reviewed-by: Marko Kovacevic <marko.kovacevic@intel.com> Reviewed-by: Ferruh Yigit <ferruh.yigit@intel.com>
2018-04-26 11:40:57 +01:00
switch_representation
doc: add ethdev traffic metering and policing guide Add new section in the Programmer Guide for the ethdev traffic metering and policing (MTR) API. Signed-off-by: Cristian Dumitrescu <cristian.dumitrescu@intel.com> Acked-by: John McNamara <john.mcnamara@intel.com>
2017-10-13 13:22:17 +01:00
traffic_metering_and_policing
doc: describe traffic management API This patch adds description of the traffic management api to dpdk programmers guide. Signed-off-by: Jasvinder Singh <jasvinder.singh@intel.com> Signed-off-by: Cristian Dumitrescu <cristian.dumitrescu@intel.com> Acked-by: John McNamara <john.mcnamara@intel.com>
2017-07-25 18:40:51 +01:00
traffic_management
bbdev: introduce wireless base band device lib - wireless baseband device (bbdev) library files - bbdev is tagged as EXPERIMENTAL - Makefiles and configuration macros definition - bbdev library is enabled by default - release notes of the initial version Signed-off-by: Amr Mokhtar <amr.mokhtar@intel.com> Acked-by: Ferruh Yigit <ferruh.yigit@intel.com>
2018-01-11 19:23:18 +00:00
bbdev
doc: add cryptodev chapter in prog guide Add a programmer's guide section for cryptodev library. Signed-off-by: Declan Doherty <declan.doherty@intel.com> Acked-by: Pablo de Lara <pablo.de.lara.guarch@intel.com> Acked-by: John McNamara <john.mcnamara@intel.com>
2016-04-08 17:17:27 +01:00
cryptodev_lib
doc: add compressdev library guide Add section in programmer’s guide for Compressdev library. Signed-off-by: Shally Verma <shally.verma@caviumnetworks.com> Signed-off-by: Sunila Sahu <sunila.sahu@caviumnetworks.com> Signed-off-by: Ashish Gupta <ashish.gupta@caviumnetworks.com>
2018-04-27 14:24:07 +01:00
compressdev
doc: add details of security library Signed-off-by: Hemant Agrawal <hemant.agrawal@nxp.com> Signed-off-by: Akhil Goyal <akhil.goyal@nxp.com> Acked-by: John McNamara <john.mcnamara@intel.com>
2017-10-25 20:37:24 +05:30
rte_security
doc: add rawdev library guide and doxygen page Signed-off-by: Shreyansh Jain <shreyansh.jain@nxp.com>
2018-01-31 14:43:18 +05:30
rawdev
doc: programmers guide The 1.7 DPDK_Prog_Guide document in MSWord has been converted to rst format for use with Sphinx. There is an rst file for each chapter and an index.rst file which contains the table of contents. The top level index file has been modified to include this guide. This document contains some png image files. If any of these png files are modified they should be replaced with an svg file. This is the sixth document from a set of 6 documents. Signed-off-by: Bernard Iremonger <bernard.iremonger@intel.com>
2014-11-14 11:53:41 +00:00
link_bonding_poll_mode_drv_lib
timer_lib
hash_lib
doc: add EFD library section in programmers guide Signed-off-by: Sameh Gobriel <sameh.gobriel@intel.com> Acked-by: Christian Maciocco <christian.maciocco@intel.com>
2017-01-17 22:23:55 +00:00
efd_lib
doc: add membership documentation This patch adds the documentation for membership library. Signed-off-by: Yipeng Wang <yipeng1.wang@intel.com> Reviewed-by: Pablo de Lara <pablo.de.lara.guarch@intel.com> Acked-by: John McNamara <john.mcnamara@intel.com>
2017-10-03 20:12:25 -07:00
member_lib
doc: programmers guide The 1.7 DPDK_Prog_Guide document in MSWord has been converted to rst format for use with Sphinx. There is an rst file for each chapter and an index.rst file which contains the table of contents. The top level index file has been modified to include this guide. This document contains some png image files. If any of these png files are modified they should be replaced with an svg file. This is the sixth document from a set of 6 documents. Signed-off-by: Bernard Iremonger <bernard.iremonger@intel.com>
2014-11-14 11:53:41 +00:00
lpm_lib
lpm6_lib
doc: add flow classify guides The Flow Classify Library Programmers Guide documents librte_flow_classify. The Flow Classify Sample Application Guide documents the flow_classify sample application which is used to demonstrate the use of the Flow Classify Library, librte_flow_classify. Signed-off-by: Bernard Iremonger <bernard.iremonger@intel.com> Acked-by: John McNamara <john.mcnamara@intel.com>
2017-11-03 11:13:55 +00:00
flow_classify_lib
doc: programmers guide The 1.7 DPDK_Prog_Guide document in MSWord has been converted to rst format for use with Sphinx. There is an rst file for each chapter and an index.rst file which contains the table of contents. The top level index file has been modified to include this guide. This document contains some png image files. If any of these png files are modified they should be replaced with an svg file. This is the sixth document from a set of 6 documents. Signed-off-by: Bernard Iremonger <bernard.iremonger@intel.com>
2014-11-14 11:53:41 +00:00
packet_distrib_lib
doc: new reorder library description This patch introduces a new section in the programmers guide describing the reorder library. Signed-off-by: Sergio Gonzalez Monroy <sergio.gonzalez.monroy@intel.com> Acked-by: Neil Horman <nhorman@tuxdriver.com> Acked-by: Declan Doherty <declan.doherty@intel.com>
2015-02-18 14:58:16 +00:00
reorder_lib
doc: programmers guide The 1.7 DPDK_Prog_Guide document in MSWord has been converted to rst format for use with Sphinx. There is an rst file for each chapter and an index.rst file which contains the table of contents. The top level index file has been modified to include this guide. This document contains some png image files. If any of these png files are modified they should be replaced with an svg file. This is the sixth document from a set of 6 documents. Signed-off-by: Bernard Iremonger <bernard.iremonger@intel.com>
2014-11-14 11:53:41 +00:00
ip_fragment_reassembly_lib
doc: add GRO guide Add prog_guide doc to explain the design of the GRO library. Signed-off-by: Jiayu Hu <jiayu.hu@intel.com> Acked-by: John McNamara <john.mcnamara@intel.com>
2017-08-04 17:59:16 +08:00
generic_receive_offload_lib
doc: add GSO programmer's guide Add programmer's guide doc to explain the design and use of the GSO library. Signed-off-by: Mark Kavanagh <mark.b.kavanagh@intel.com> Signed-off-by: Jiayu Hu <jiayu.hu@intel.com> Acked-by: John McNamara <john.mcnamara@intel.com> Acked-by: Konstantin Ananyev <konstantin.ananyev@intel.com>
2017-10-07 22:56:44 +08:00
generic_segmentation_offload_lib
pdump: add new library for packet capture The librte_pdump library provides a framework for packet capturing in dpdk. The library provides set of APIs to initialize the packet capture framework, to enable or disable the packet capture, and to uninitialize it. The librte_pdump library works on a client/server model. The server is responsible for enabling or disabling the packet capture and the clients are responsible for requesting the enabling or disabling of the packet capture. Enabling APIs are supported with port, queue, ring and mempool parameters. Applications should pass on this information to get the packets from the dpdk ports. For enabling requests from applications, library creates the client request containing the mempool, ring, port and queue information and sends the request to the server. After receiving the request, server registers the Rx and Tx callbacks for all the port and queues. After the callbacks registration, registered callbacks will get the Rx and Tx packets. Packets then will be copied to the new mbufs that are allocated from the user passed mempool. These new mbufs then will be enqueued to the application passed ring. Applications need to dequeue the mbufs from the rings and direct them to the devices like pcap vdev for viewing the packets outside of the dpdk using the packet capture tools. For disabling requests, library creates the client request containing the port and queue information and sends the request to the server. After receiving the request, server removes the Rx and Tx callback for all the port and queues. Signed-off-by: Reshma Pattan <reshma.pattan@intel.com> Acked-by: Konstantin Ananyev <konstantin.ananyev@intel.com>
2016-06-15 15:06:22 +01:00
pdump_lib
doc: programmers guide The 1.7 DPDK_Prog_Guide document in MSWord has been converted to rst format for use with Sphinx. There is an rst file for each chapter and an index.rst file which contains the table of contents. The top level index file has been modified to include this guide. This document contains some png image files. If any of these png files are modified they should be replaced with an svg file. This is the sixth document from a set of 6 documents. Signed-off-by: Bernard Iremonger <bernard.iremonger@intel.com>
2014-11-14 11:53:41 +00:00
multi_proc_support
kernel_nic_interface
doc: drop old naming of the project It was requested by Intel, more than one year ago, to replace the name "Intel DPDK" by "DPDK". Some references to the old name were still in some docs and code comments, leading to confusion. Fixes: ac8ada004c12 ("doc: remove Intel references from release notes") Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com> Acked-by: Bruce Richardson <bruce.richardson@intel.com>
2016-02-08 11:30:07 +01:00
thread_safety_dpdk_functions
doc: add eventdev library to programmers guide This commit adds an entry in the programmers guide explaining the eventdev library. The rte_event struct, queues and ports are explained. An API walktrough of a simple two stage atomic pipeline provides the reader with a step by step overview of the expected usage of the Eventdev API. Signed-off-by: Harry van Haaren <harry.van.haaren@intel.com> Signed-off-by: David Hunt <david.hunt@intel.com> Acked-by: John McNamara <john.mcnamara@intel.com> Acked-by: Jerin Jacob <jerin.jacob@caviumnetworks.com>
2017-07-06 15:35:16 +01:00
eventdev
doc: add event eth Rx adapter guide Add programmer's guide doc to explain the use of the Event Ethernet Rx Adapter library. Signed-off-by: Nikhil Rao <nikhil.rao@intel.com> Acked-by: Jerin Jacob <jerin.jacob@caviumnetworks.com>
2017-10-24 14:43:29 +05:30
event_ethernet_rx_adapter
doc: add event eth Tx adapter guide Add programmer's guide doc to explain the use of the Event Ethernet Tx Adapter library. Signed-off-by: Nikhil Rao <nikhil.rao@intel.com> Acked-by: Jerin Jacob <jerin.jacob@caviumnetworks.com>
2018-09-20 23:11:16 +05:30
event_ethernet_tx_adapter
doc: add event timer adapter guide Signed-off-by: Erik Gabriel Carrillo <erik.g.carrillo@intel.com> Signed-off-by: Jerin Jacob <jerin.jacob@caviumnetworks.com> Signed-off-by: Pavan Nikhilesh <pbhagavatula@caviumnetworks.com> Acked-by: Jerin Jacob <jerin.jacob@caviumnetworks.com>
2018-04-04 16:51:13 -05:00
event_timer_adapter
doc: add event crypto adapter guide Add entries in the programmer's guide, API index, maintainer's file and release notes for the event crypto adapter. Signed-off-by: Abhinandan Gujjar <abhinandan.gujjar@intel.com> Acked-by: Jerin Jacob <jerin.jacob@caviumnetworks.com> Acked-by: Akhil Goyal <akhil.goyal@nxp.com>
2018-05-09 13:48:01 +05:30
event_crypto_adapter
doc: programmers guide The 1.7 DPDK_Prog_Guide document in MSWord has been converted to rst format for use with Sphinx. There is an rst file for each chapter and an index.rst file which contains the table of contents. The top level index file has been modified to include this guide. This document contains some png image files. If any of these png files are modified they should be replaced with an svg file. This is the sixth document from a set of 6 documents. Signed-off-by: Bernard Iremonger <bernard.iremonger@intel.com>
2014-11-14 11:53:41 +00:00
qos_framework
power_man
packet_classif_access_ctrl
packet_framework
doc: add vhost library As Vhost will be a library in DPDK 1.8, adding a new section to Programmer's Guide to describe its use. Signed-off-by: Siobhan Butler <siobhan.a.butler@intel.com> Signed-off-by: Huawei Xie <huawei.xie@intel.com> Acked-by: Bernard Iremonger <bernard.iremonger@intel.com>
2014-12-02 21:11:42 +00:00
vhost_lib
metrics: add information metrics library This patch adds a new information metrics library. This Metrics library implements a mechanism by which producers can publish numeric information for later querying by consumers. Metrics themselves are statistics that are not generated by PMDs, and hence are not reported via ethdev extended statistics. Metric information is populated using a push model, where producers update the values contained within the metric library by calling an update function on the relevant metrics. Consumers receive metric information by querying the central metric data, which is held in shared memory. Signed-off-by: Remy Horton <remy.horton@intel.com>
2017-03-30 22:00:57 +01:00
metrics_lib
doc: add BPF library guide Signed-off-by: Konstantin Ananyev <konstantin.ananyev@intel.com> Acked-by: Ferruh Yigit <ferruh.yigit@intel.com>
2018-05-10 11:23:11 +01:00
bpf_lib
doc: add IPsec library guide Add IPsec library guide and update release notes. Signed-off-by: Bernard Iremonger <bernard.iremonger@intel.com> Signed-off-by: Konstantin Ananyev <konstantin.ananyev@intel.com> Acked-by: Akhil Goyal <akhil.goyal@nxp.com>
2019-01-10 21:06:34 +00:00
ipsec_lib
doc: programmers guide The 1.7 DPDK_Prog_Guide document in MSWord has been converted to rst format for use with Sphinx. There is an rst file for each chapter and an index.rst file which contains the table of contents. The top level index file has been modified to include this guide. This document contains some png image files. If any of these png files are modified they should be replaced with an svg file. This is the sixth document from a set of 6 documents. Signed-off-by: Bernard Iremonger <bernard.iremonger@intel.com>
2014-11-14 11:53:41 +00:00
source_org
dev_kit_build_system
dev_kit_root_make_help
doc: drop old naming of the project It was requested by Intel, more than one year ago, to replace the name "Intel DPDK" by "DPDK". Some references to the old name were still in some docs and code comments, leading to confusion. Fixes: ac8ada004c12 ("doc: remove Intel references from release notes") Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com> Acked-by: Bruce Richardson <bruce.richardson@intel.com>
2016-02-08 11:30:07 +01:00
extend_dpdk
doc: programmers guide The 1.7 DPDK_Prog_Guide document in MSWord has been converted to rst format for use with Sphinx. There is an rst file for each chapter and an index.rst file which contains the table of contents. The top level index file has been modified to include this guide. This document contains some png image files. If any of these png files are modified they should be replaced with an svg file. This is the sixth document from a set of 6 documents. Signed-off-by: Bernard Iremonger <bernard.iremonger@intel.com>
2014-11-14 11:53:41 +00:00
build_app
ext_app_lib_make_help
perf_opt_guidelines
writing_efficient_code
profile_app
glossary
Reference in New Issue Copy Permalink