numam-dpdk/doc/guides/prog_guide
Shahaf Shuler c33a675b62 bus: introduce device level DMA memory mapping
The DPDK APIs expose 3 different modes to work with memory used for DMA:

1. Use the DPDK owned memory (backed by the DPDK provided hugepages).
This memory is allocated by the DPDK libraries, included in the DPDK
memory system (memseg lists) and automatically DMA mapped by the DPDK
layers.

2. Use memory allocated by the user and register to the DPDK memory
systems. Upon registration of memory, the DPDK layers will DMA map it
to all needed devices. After registration, allocation of this memory
will be done with rte_*malloc APIs.

3. Use memory allocated by the user and not registered to the DPDK memory
system. This is for users who wants to have tight control on this
memory (e.g. avoid the rte_malloc header).
The user should create a memory, register it through rte_extmem_register
API, and call DMA map function in order to register such memory to
the different devices.

The scope of the patch focus on #3 above.

Currently the only way to map external memory is through VFIO
(rte_vfio_dma_map). While VFIO is common, there are other vendors
which use different ways to map memory (e.g. Mellanox and NXP).

The work in this patch moves the DMA mapping to vendor agnostic APIs.
Device level DMA map and unmap APIs were added. Implementation of those
APIs was done currently only for PCI devices.

For PCI bus devices, the pci driver can expose its own map and unmap
functions to be used for the mapping. In case the driver doesn't provide
any, the memory will be mapped, if possible, to IOMMU through VFIO APIs.

Application usage with those APIs is quite simple:
* allocate memory
* call rte_extmem_register on the memory chunk.
* take a device, and query its rte_device.
* call the device specific mapping function for this device.

Future work will deprecate the rte_vfio_dma_map and rte_vfio_dma_unmap
APIs, leaving the rte device APIs as the preferred option for the user.

Signed-off-by: Shahaf Shuler <shahafs@mellanox.com>
Acked-by: Anatoly Burakov <anatoly.burakov@intel.com>
Acked-by: Gaetan Rivet <gaetan.rivet@6wind.com>
2019-03-30 16:48:56 +01:00
..
img mk: use linux and freebsd in config names 2019-03-12 23:05:06 +01:00
bbdev.rst doc: fix PDF build 2018-08-09 01:03:14 +02:00
bpf_lib.rst
build_app.rst mk: use linux and freebsd in config names 2019-03-12 23:05:06 +01:00
compressdev.rst test: move to app directory 2019-02-26 15:29:27 +01:00
cryptodev_lib.rst cryptodev: add user data size to symmetric session 2019-01-10 16:57:22 +01:00
dev_kit_build_system.rst mk: use linux and freebsd in config names 2019-03-12 23:05:06 +01:00
dev_kit_root_make_help.rst mk: use linux and freebsd in config names 2019-03-12 23:05:06 +01:00
efd_lib.rst
env_abstraction_layer.rst bus: introduce device level DMA memory mapping 2019-03-30 16:48:56 +01:00
event_crypto_adapter.rst doc: add notes about eventdev producer/consumer dependency 2019-03-15 06:46:50 +01:00
event_ethernet_rx_adapter.rst doc: add notes about eventdev producer/consumer dependency 2019-03-15 06:46:50 +01:00
event_ethernet_tx_adapter.rst doc: add event eth Tx adapter guide 2018-10-01 16:51:54 +02:00
event_timer_adapter.rst doc: add notes about eventdev producer/consumer dependency 2019-03-15 06:46:50 +01:00
eventdev.rst doc: add notes about eventdev producer/consumer dependency 2019-03-15 06:46:50 +01:00
ext_app_lib_make_help.rst mk: use linux and freebsd in config names 2019-03-12 23:05:06 +01:00
extend_dpdk.rst mk: use linux and freebsd in config names 2019-03-12 23:05:06 +01:00
flow_classify_lib.rst
generic_receive_offload_lib.rst doc: add GRO limitations in programmers guide 2019-01-17 22:44:06 +01:00
generic_segmentation_offload_lib.rst
glossary.rst mk: use linux and freebsd in config names 2019-03-12 23:05:06 +01:00
hash_lib.rst doc: improve hash library guide 2018-11-25 11:09:03 +01:00
index.rst doc: add IPsec library guide 2019-01-10 16:57:22 +01:00
intro.rst mk: use linux and freebsd in config names 2019-03-12 23:05:06 +01:00
ip_fragment_reassembly_lib.rst
ipsec_lib.rst doc: add IPsec library guide 2019-01-10 16:57:22 +01:00
kernel_nic_interface.rst kni: calculate MTU from mbuf size 2019-03-30 00:59:59 +01:00
link_bonding_poll_mode_drv_lib.rst doc: fix examples in bonding guide 2019-03-21 21:09:16 +01:00
lpm6_lib.rst
lpm_lib.rst
mbuf_lib.rst
member_lib.rst
mempool_lib.rst
metrics_lib.rst doc: update timestamp validity for latency measurement 2018-11-19 01:35:17 +01:00
multi_proc_support.rst doc: add IPC callback limitations 2018-07-13 12:42:05 +02:00
overview.rst mk: use linux and freebsd in config names 2019-03-12 23:05:06 +01:00
packet_classif_access_ctrl.rst
packet_distrib_lib.rst
packet_framework.rst port: add symmetric crypto 2018-10-12 19:33:02 +02:00
pdump_lib.rst pdump: remove deprecated APIs 2018-12-19 01:25:56 +01:00
perf_opt_guidelines.rst
poll_mode_drv.rst doc: fix PCI whitelist typo in prog guide 2019-03-05 11:57:33 +00:00
power_man.rst doc: fix references in power management guide 2019-01-20 13:17:48 +01:00
profile_app.rst mk: use linux and freebsd in config names 2019-03-12 23:05:06 +01:00
qos_framework.rst mk: use linux and freebsd in config names 2019-03-12 23:05:06 +01:00
rawdev.rst
reorder_lib.rst
ring_lib.rst
rte_flow.rst doc: add references to flow isolated mode in NICs guide 2019-01-31 18:41:07 +01:00
rte_security.rst security: support PDCP 2018-10-24 15:12:33 +02:00
service_cores.rst
source_org.rst doc: remove file listings 2019-01-20 13:08:50 +01:00
switch_representation.rst fix dpdk.org URLs 2018-11-26 20:19:24 +01:00
thread_safety_dpdk_functions.rst
timer_lib.rst
traffic_management.rst
traffic_metering_and_policing.rst
vhost_lib.rst doc: improve vhost zero copy guide 2019-03-01 18:17:36 +01:00
writing_efficient_code.rst