From patchwork Tue Oct 4 16:50:51 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Kevin Laatz X-Patchwork-Id: 117327 X-Patchwork-Delegate: david.marchand@redhat.com Return-Path: X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 25C0AA0542; Tue, 4 Oct 2022 18:47:27 +0200 (CEST) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id F1CF940DDC; Tue, 4 Oct 2022 18:47:26 +0200 (CEST) Received: from mga14.intel.com (mga14.intel.com [192.55.52.115]) by mails.dpdk.org (Postfix) with ESMTP id 53E5640A79 for ; Tue, 4 Oct 2022 18:47:25 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1664902045; x=1696438045; h=from:to:cc:subject:date:message-id:in-reply-to: references:mime-version:content-transfer-encoding; bh=4aca5mpIVkwVdeN1iUFpezez//TGitMz0frGFuYH6lg=; b=DLZ0Lpk0MdmK3Kj6rvQ8vtVV4RC8UBYZSgkM11bHbAxspj1U/1OP6Tyn S9+ZlHhJajyRpTHXGA40PpB45nRDZYObtdZ/RjQsQ8viZMdSnf7047DHg ZLlHlPQlNSSzXnx6p6LDCzGaNYSxsJc7zJZRyx57C5dME3biblpZK/DU5 Z+VGGQtVIbNRSv1rVNBAgby26NU7a62twOAMPyQQPxjHHPy/cJz7vSY8g v5N/rM2uN0fQfeD3enmByockHNXvAFJJvxCo2QPuh8kPAgAE879zyHV6C 50HoGL07+oDrFT4Fx+mqbGPcdkzxnOg8tjmgTNLpV6wB/aXdnTtUYhEdh A==; X-IronPort-AV: E=McAfee;i="6500,9779,10490"; a="302941536" X-IronPort-AV: E=Sophos;i="5.95,158,1661842800"; d="scan'208";a="302941536" Received: from orsmga002.jf.intel.com ([10.7.209.21]) by fmsmga103.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 04 Oct 2022 09:47:24 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=McAfee;i="6500,9779,10490"; a="623995845" X-IronPort-AV: E=Sophos;i="5.95,158,1661842800"; d="scan'208";a="623995845" Received: from silpixa00401122.ir.intel.com ([10.243.22.75]) by orsmga002.jf.intel.com with ESMTP; 04 Oct 2022 09:47:21 -0700 From: Kevin Laatz To: dev@dpdk.org Cc: david.marchand@redhat.com, bruce.richardson@intel.com, mb@smartsharesystems.com, lizh@nvidia.com, matan@nvidia.com, stephen@networkplumber.org, lihuisong@huawei.com, Kevin Laatz Subject: [PATCH v9] eal: add bus cleanup to eal cleanup Date: Tue, 4 Oct 2022 17:50:51 +0100 Message-Id: <20221004165051.153751-1-kevin.laatz@intel.com> X-Mailer: git-send-email 2.31.1 In-Reply-To: <20220419161438.1837860-1-kevin.laatz@intel.com> References: <20220419161438.1837860-1-kevin.laatz@intel.com> MIME-Version: 1.0 X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org During EAL init, all buses are probed and the devices found are initialized. On eal_cleanup(), the inverse does not happen, meaning any allocated memory and other configuration will not be cleaned up appropriately on exit. Currently, in order for device cleanup to take place, applications must call the driver-relevant functions to ensure proper cleanup is done before the application exits. Since initialization occurs for all devices on the bus, not just the devices used by an application, it requires a) application awareness of all bus devices that could have been probed on the system, and b) code duplication across applications to ensure cleanup is performed. An example of this is rte_eth_dev_close() which is commonly used across the example applications. This patch proposes adding bus cleanup to the eal_cleanup() to make EAL's init/exit more symmetrical, ensuring all bus devices are cleaned up appropriately without the application needing to be aware of all bus types that may have been probed during initialization. Contained in this patch are the changes required to perform cleanup for devices on the PCI bus and VDEV bus during eal_cleanup(). There would be an ask for bus maintainers to add the relevant cleanup for their buses since they have the domain expertise. Signed-off-by: Kevin Laatz Acked-by: Morten Brørup Reviewed-by: Bruce Richardson --- v9: * move bus cleanup before trace save and uninitialize v8: * rebase v7: * free rte_pci_device structs during cleanup * free rte_vdev_device structs during cleanup v6: * add bus_cleanup to eal_cleanup for FreeBSD * add bus_cleanup to eal_cleanup for Windows * remove bus cleanup function to remove rte_ prefix * other minor fixes v5: * remove unnecessary logs * move rte_bus_cleanup() definition to eal_private.h * fix return values for vdev_cleanup and pci_cleanup v4: * rebase v3: * add vdev bus cleanup v2: * change log level from INFO to DEBUG for PCI cleanup * add abignore entries for rte_bus related false positives --- drivers/bus/pci/pci_common.c | 28 ++++++++++++++++++++++++++++ drivers/bus/vdev/vdev.c | 27 +++++++++++++++++++++++++++ lib/eal/common/eal_common_bus.c | 17 +++++++++++++++++ lib/eal/common/eal_private.h | 10 ++++++++++ lib/eal/freebsd/eal.c | 1 + lib/eal/include/bus_driver.h | 13 +++++++++++++ lib/eal/linux/eal.c | 1 + lib/eal/windows/eal.c | 1 + 8 files changed, 98 insertions(+) diff --git a/drivers/bus/pci/pci_common.c b/drivers/bus/pci/pci_common.c index 5ea72bcf23..fb754e0e0a 100644 --- a/drivers/bus/pci/pci_common.c +++ b/drivers/bus/pci/pci_common.c @@ -25,6 +25,7 @@ #include #include #include +#include #include "private.h" @@ -439,6 +440,32 @@ pci_probe(void) return (probed && probed == failed) ? -1 : 0; } +static int +pci_cleanup(void) +{ + struct rte_pci_device *dev, *tmp_dev; + int error = 0; + + RTE_TAILQ_FOREACH_SAFE(dev, &rte_pci_bus.device_list, next, tmp_dev) { + struct rte_pci_driver *drv = dev->driver; + int ret = 0; + + if (drv == NULL || drv->remove == NULL) + continue; + + ret = drv->remove(dev); + if (ret < 0) { + rte_errno = errno; + error = -1; + } + dev->driver = NULL; + dev->device.driver = NULL; + free(dev); + } + + return error; +} + /* dump one device */ static int pci_dump_one_device(FILE *f, struct rte_pci_device *dev) @@ -856,6 +883,7 @@ struct rte_pci_bus rte_pci_bus = { .bus = { .scan = rte_pci_scan, .probe = pci_probe, + .cleanup = pci_cleanup, .find_device = pci_find_device, .plug = pci_plug, .unplug = pci_unplug, diff --git a/drivers/bus/vdev/vdev.c b/drivers/bus/vdev/vdev.c index b176b658fc..f5b43f1930 100644 --- a/drivers/bus/vdev/vdev.c +++ b/drivers/bus/vdev/vdev.c @@ -567,6 +567,32 @@ vdev_probe(void) return ret; } +static int +vdev_cleanup(void) +{ + struct rte_vdev_device *dev, *tmp_dev; + int error = 0; + + RTE_TAILQ_FOREACH_SAFE(dev, &vdev_device_list, next, tmp_dev) { + const struct rte_vdev_driver *drv; + int ret = 0; + + drv = container_of(dev->device.driver, const struct rte_vdev_driver, driver); + + if (drv == NULL || drv->remove == NULL) + continue; + + ret = drv->remove(dev); + if (ret < 0) + error = -1; + + dev->device.driver = NULL; + free(dev); + } + + return error; +} + struct rte_device * rte_vdev_find_device(const struct rte_device *start, rte_dev_cmp_t cmp, const void *data) @@ -625,6 +651,7 @@ vdev_get_iommu_class(void) static struct rte_bus rte_vdev_bus = { .scan = vdev_scan, .probe = vdev_probe, + .cleanup = vdev_cleanup, .find_device = rte_vdev_find_device, .plug = vdev_plug, .unplug = vdev_unplug, diff --git a/lib/eal/common/eal_common_bus.c b/lib/eal/common/eal_common_bus.c index be64d31b0f..deb9fb8a12 100644 --- a/lib/eal/common/eal_common_bus.c +++ b/lib/eal/common/eal_common_bus.c @@ -91,6 +91,23 @@ rte_bus_probe(void) return 0; } +/* Clean up all devices of all buses */ +int +eal_bus_cleanup(void) +{ + int ret = 0; + struct rte_bus *bus; + + TAILQ_FOREACH(bus, &rte_bus_list, next) { + if (bus->cleanup == NULL) + continue; + if (bus->cleanup() != 0) + ret = -1; + } + + return ret; +} + /* Dump information of a single bus */ static int bus_dump_one(FILE *f, struct rte_bus *bus) diff --git a/lib/eal/common/eal_private.h b/lib/eal/common/eal_private.h index 3ca9ce2ffc..0f4d75bb89 100644 --- a/lib/eal/common/eal_private.h +++ b/lib/eal/common/eal_private.h @@ -441,6 +441,16 @@ int rte_eal_memory_detach(void); */ struct rte_bus *rte_bus_find_by_device_name(const char *str); +/** + * For each device on the buses, call the driver-specific function for + * device cleanup. + * + * @return + * 0 for successful cleanup + * !0 otherwise + */ +int eal_bus_cleanup(void); + /** * Create the unix channel for primary/secondary communication. * diff --git a/lib/eal/freebsd/eal.c b/lib/eal/freebsd/eal.c index a1bb5363b1..1b58cd3da6 100644 --- a/lib/eal/freebsd/eal.c +++ b/lib/eal/freebsd/eal.c @@ -894,6 +894,7 @@ rte_eal_cleanup(void) eal_get_internal_configuration(); rte_service_finalize(); rte_mp_channel_cleanup(); + eal_bus_cleanup(); rte_trace_save(); eal_trace_fini(); /* after this point, any DPDK pointers will become dangling */ diff --git a/lib/eal/include/bus_driver.h b/lib/eal/include/bus_driver.h index d2e615a736..7b85a17a09 100644 --- a/lib/eal/include/bus_driver.h +++ b/lib/eal/include/bus_driver.h @@ -205,6 +205,18 @@ typedef int (*rte_bus_hot_unplug_handler_t)(struct rte_device *dev); */ typedef int (*rte_bus_sigbus_handler_t)(const void *failure_addr); +/** + * Implementation specific cleanup function which is responsible for cleaning up + * devices on that bus with applicable drivers. + * + * This is called while iterating over each registered bus. + * + * @return + * 0 for successful cleanup + * !0 for any error during cleanup + */ +typedef int (*rte_bus_cleanup_t)(void); + /** * Bus scan policies */ @@ -256,6 +268,7 @@ struct rte_bus { /**< handle hot-unplug failure on the bus */ rte_bus_sigbus_handler_t sigbus_handler; /**< handle sigbus error on the bus */ + rte_bus_cleanup_t cleanup; /**< Cleanup devices on bus */ }; /** diff --git a/lib/eal/linux/eal.c b/lib/eal/linux/eal.c index 9a168b7773..e74542fc71 100644 --- a/lib/eal/linux/eal.c +++ b/lib/eal/linux/eal.c @@ -1363,6 +1363,7 @@ rte_eal_cleanup(void) vfio_mp_sync_cleanup(); #endif rte_mp_channel_cleanup(); + eal_bus_cleanup(); rte_trace_save(); eal_trace_fini(); /* after this point, any DPDK pointers will become dangling */ diff --git a/lib/eal/windows/eal.c b/lib/eal/windows/eal.c index 79322d2ce9..adb929a014 100644 --- a/lib/eal/windows/eal.c +++ b/lib/eal/windows/eal.c @@ -263,6 +263,7 @@ rte_eal_cleanup(void) eal_intr_thread_cancel(); eal_mem_virt2iova_cleanup(); + eal_bus_cleanup(); /* after this point, any DPDK pointers will become dangling */ rte_eal_memory_detach(); eal_cleanup_config(internal_conf);