vfio: document multiprocess limitation for container API

[dpdk.git] / lib / librte_eal / common / include / rte_vfio.h

diff --git a/lib/librte_eal/common/include/rte_vfio.h b/lib/librte_eal/common/include/rte_vfio.h
index 7d66438b59bf5ea8fc4f58b164468b422675faac..4b3a91e91e8eb425068a8d0a7757b8e185514c68 100644 (file)
--- a/lib/librte_eal/common/include/rte_vfio.h
+++ b/lib/librte_eal/common/include/rte_vfio.h
@@ -256,7 +256,7 @@ rte_vfio_get_group_num(const char *sysfs_base,
                      const char *dev_addr, int *iommu_group_num);
 
 /**
- * Open VFIO container fd or get an existing one
+ * Open a new VFIO container fd
  *
  * This function is only relevant to linux and will return
  * an error on BSD.
@@ -291,6 +291,10 @@ rte_vfio_get_group_fd(int iommu_group_num);
  *       containers by default, user needs to manage DMA mappings for
  *       any container created by this API.
  *
+ * @note When creating containers using this API, the container will only be
+ *       available in the process that has created it. Sharing containers and
+ *       devices between multiple processes is not supported.
+ *
  * @return
  *   the container fd if successful
  *   <0 if failed