From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 0681FA04FF; Tue, 24 May 2022 11:23:39 +0200 (CEST) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id E121A4067B; Tue, 24 May 2022 11:23:38 +0200 (CEST) Received: from mga01.intel.com (mga01.intel.com [192.55.52.88]) by mails.dpdk.org (Postfix) with ESMTP id DEE28400D6 for ; Tue, 24 May 2022 11:23:36 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1653384217; x=1684920217; h=from:to:cc:subject:date:message-id:in-reply-to: references:mime-version:content-transfer-encoding; bh=SoHrG1003omsxZKIFz9YtEGS6ZXS/87YG1QdI8D/058=; b=ZbtZ0jWye71l5cxcuwsoP3bWOlQeDZSOMeLMsRh+p00gtLoldDQCHYHh 9Q+4ZZb2ckdPBHgOOLqKZblIUDwNk9P0eegLwEqmv1QxkNNrmyjdJikDT 5JufN1Q0XX5IWO1ComDlqCeo9h2ZE5lvmcLFKdeo6eZ/Ooptxg8nfVRME rVOOka8/MIve9Ap7vUzXE8Q93lPmicN2+ccJ+yBPsmf7doTYRQL0hVUY7 +03d+HA8AnQg3vmxO3yxEMieh5/ovP84DCRF8Rl8Nbx+hoHhxTi1CVAos af1zjdZ2bH8TH8WPdDpKlTJgZl4mWeemzd+dmIvldjYiGyEFqYMHaTG1n Q==; X-IronPort-AV: E=McAfee;i="6400,9594,10356"; a="298797328" X-IronPort-AV: E=Sophos;i="5.91,248,1647327600"; d="scan'208";a="298797328" Received: from orsmga004.jf.intel.com ([10.7.209.38]) by fmsmga101.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 24 May 2022 02:23:35 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.91,248,1647327600"; d="scan'208";a="703393820" Received: from silpixa00401122.ir.intel.com ([10.237.213.29]) by orsmga004.jf.intel.com with ESMTP; 24 May 2022 02:23:34 -0700 From: Kevin Laatz To: dev@dpdk.org Cc: Kevin Laatz , =?UTF-8?q?Morten=20Br=C3=B8rup?= Subject: [PATCH v4] eal: add bus cleanup to eal cleanup Date: Tue, 24 May 2022 10:25:01 +0100 Message-Id: <20220524092501.419761-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 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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 --- v2: * change log level from INFO to DEBUG for PCI cleanup * add abignore entries for rte_bus related false positives v3: * add vdev bus cleanup --- devtools/libabigail.abignore | 9 +++++++++ drivers/bus/pci/pci_common.c | 32 ++++++++++++++++++++++++++++++++ drivers/bus/vdev/vdev.c | 23 +++++++++++++++++++++++ lib/eal/common/eal_common_bus.c | 18 ++++++++++++++++++ lib/eal/include/rte_bus.h | 23 +++++++++++++++++++++++ lib/eal/linux/eal.c | 1 + 6 files changed, 106 insertions(+) diff --git a/devtools/libabigail.abignore b/devtools/libabigail.abignore index 79ff15dc4e..3e519ee42a 100644 --- a/devtools/libabigail.abignore +++ b/devtools/libabigail.abignore @@ -56,3 +56,12 @@ ; Ignore libabigail false-positive in clang builds, after moving code. [suppress_function] name = rte_eal_remote_launch + +; Ignore field inserted to rte_bus, adding cleanup function +[suppress_type] + name = rte_bus + has_data_member_inserted_at = end + +; Ignore changes to internally used structs containing rte_bus +[suppress_type] + name = rte_pci_bus, rte_vmbus_bus, rte_vdev_bus diff --git a/drivers/bus/pci/pci_common.c b/drivers/bus/pci/pci_common.c index 37ab879779..7d0c49f073 100644 --- a/drivers/bus/pci/pci_common.c +++ b/drivers/bus/pci/pci_common.c @@ -394,6 +394,37 @@ pci_probe(void) return (probed && probed == failed) ? -1 : 0; } +static int +pci_cleanup(void) +{ + struct rte_pci_device *dev = NULL; + int ret = 0; + + FOREACH_DEVICE_ON_PCIBUS(dev) { + struct rte_pci_addr *loc = &dev->addr; + struct rte_pci_driver *drv = dev->driver; + + if (loc == NULL || drv == NULL) + continue; + + RTE_LOG(DEBUG, EAL, + "Clean up PCI driver: %s (%x:%x) device: "PCI_PRI_FMT" (socket %i)\n", + drv->driver.name, dev->id.vendor_id, dev->id.device_id, + loc->domain, loc->bus, loc->devid, loc->function, + dev->device.numa_node); + + ret = drv->remove(dev); + if (ret < 0) { + RTE_LOG(ERR, EAL, "Cleanup for device "PCI_PRI_FMT" failed\n", + dev->addr.domain, dev->addr.bus, dev->addr.devid, + dev->addr.function); + rte_errno = errno; + } + } + + return ret; +} + /* dump one device */ static int pci_dump_one_device(FILE *f, struct rte_pci_device *dev) @@ -813,6 +844,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 a8d8b2327e..eca1a3d536 100644 --- a/drivers/bus/vdev/vdev.c +++ b/drivers/bus/vdev/vdev.c @@ -569,6 +569,28 @@ vdev_probe(void) return ret; } +static int +vdev_cleanup(void) +{ + struct rte_vdev_device *dev; + int ret = 0; + + TAILQ_FOREACH(dev, &vdev_device_list, next) { + const char *name; + struct rte_vdev_driver *drv; + + name = rte_vdev_device_name(dev); + if (vdev_parse(name, &drv)) + continue; + + ret = drv->remove(dev); + if (ret < 0) + VDEV_LOG(ERR, "Cleanup for device %s failed\n", rte_vdev_device_name(dev)); + } + + return ret; +} + struct rte_device * rte_vdev_find_device(const struct rte_device *start, rte_dev_cmp_t cmp, const void *data) @@ -627,6 +649,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 baa5b532af..046a06a2bf 100644 --- a/lib/eal/common/eal_common_bus.c +++ b/lib/eal/common/eal_common_bus.c @@ -85,6 +85,24 @@ rte_bus_probe(void) return 0; } +/* Clean up all devices of all buses */ +int +rte_bus_cleanup(void) +{ + int ret; + struct rte_bus *bus; + + TAILQ_FOREACH(bus, &rte_bus_list, next) { + if (bus->cleanup == NULL) + continue; + ret = bus->cleanup(); + if (ret) + RTE_LOG(ERR, EAL, "Bus (%s) cleanup failed.\n", bus->name); + } + + return 0; +} + /* Dump information of a single bus */ static int bus_dump_one(FILE *f, struct rte_bus *bus) diff --git a/lib/eal/include/rte_bus.h b/lib/eal/include/rte_bus.h index bbbb6efd28..42da38730f 100644 --- a/lib/eal/include/rte_bus.h +++ b/lib/eal/include/rte_bus.h @@ -66,6 +66,18 @@ typedef int (*rte_bus_scan_t)(void); */ typedef int (*rte_bus_probe_t)(void); +/** + * 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); + /** * Device iterator to find a device on a bus. * @@ -277,6 +289,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 */ }; @@ -317,6 +330,16 @@ int rte_bus_scan(void); */ int rte_bus_probe(void); +/** + * For each device on the buses, perform a driver 'match' and call the + * driver-specific function for device cleanup. + * + * @return + * 0 for successful match/cleanup + * !0 otherwise + */ +int rte_bus_cleanup(void); + /** * Dump information of all the buses registered with EAL. * diff --git a/lib/eal/linux/eal.c b/lib/eal/linux/eal.c index 1ef263434a..27014fdc27 100644 --- a/lib/eal/linux/eal.c +++ b/lib/eal/linux/eal.c @@ -1266,6 +1266,7 @@ rte_eal_cleanup(void) vfio_mp_sync_cleanup(); #endif rte_mp_channel_cleanup(); + rte_bus_cleanup(); /* after this point, any DPDK pointers will become dangling */ rte_eal_memory_detach(); eal_mp_dev_hotplug_cleanup(); -- 2.31.1