From: Nicolin Chen <nicolinc@nvidia.com> To: <joro@8bytes.org>, <suravee.suthikulpanit@amd.com>, <will@kernel.org>, <robin.murphy@arm.com>, <robdclark@gmail.com>, <dwmw2@infradead.org>, <baolu.lu@linux.intel.com>, <agross@kernel.org>, <bjorn.andersson@linaro.org>, <matthias.bgg@gmail.com>, <orsonzhai@gmail.com>, <baolin.wang@linux.alibaba.com>, <zhang.lyra@gmail.com>, <jean-philippe@linaro.org>, <sricharan@codeaurora.org> Cc: <jgg@nvidia.com>, <kevin.tian@intel.com>, <konrad.dybcio@somainline.org>, <yong.wu@mediatek.com>, <thierry.reding@gmail.com>, <vdumpa@nvidia.com>, <jonathanh@nvidia.com>, <tglx@linutronix.de>, <shameerali.kolothum.thodi@huawei.com>, <christophe.jaillet@wanadoo.fr>, <thunder.leizhen@huawei.com>, <quic_saipraka@quicinc.com>, <jon@solid-run.com>, <yangyingliang@huawei.com>, <iommu@lists.linux.dev>, <linux-kernel@vger.kernel.org>, <linux-arm-kernel@lists.infradead.org>, <linux-arm-msm@vger.kernel.org>, <linux-mediatek@lists.infradead.org>, <linux-tegra@vger.kernel.org>, <virtualization@lists.linux-foundation.org> Subject: [PATCH v4 3/6] iommu: Add return value rules to attach_dev op and APIs Date: Wed, 21 Sep 2022 01:23:16 -0700 [thread overview] Message-ID: <8c3dbf153b63a3002a46bab6e707c63fd8635bb8.1663744983.git.nicolinc@nvidia.com> (raw) In-Reply-To: <cover.1663744983.git.nicolinc@nvidia.com> Cases like VFIO wish to attach a device to an existing domain that was not allocated specifically from the device. This raises a condition where the IOMMU driver can fail the domain attach because the domain and device are incompatible with each other. This is a soft failure that can be resolved by using a different domain. Provide a dedicated errno EINVAL from the IOMMU driver during attach that the reason why the attach failed is because of domain incompatibility. VFIO can use this to know that the attach is a soft failure and it should continue searching. Otherwise, the attach will be a hard failure and VFIO will return the code to userspace. Update kdocs to add rules of return value to the attach_dev op and APIs. Suggested-by: Jason Gunthorpe <jgg@nvidia.com> Signed-off-by: Nicolin Chen <nicolinc@nvidia.com> --- drivers/iommu/iommu.c | 22 ++++++++++++++++++++++ include/linux/iommu.h | 12 ++++++++++++ 2 files changed, 34 insertions(+) diff --git a/drivers/iommu/iommu.c b/drivers/iommu/iommu.c index 3a808146b50f..1d1e32aeaae6 100644 --- a/drivers/iommu/iommu.c +++ b/drivers/iommu/iommu.c @@ -1975,6 +1975,17 @@ static int __iommu_attach_device(struct iommu_domain *domain, return ret; } +/** + * iommu_attach_device - Attach a device to an IOMMU domain + * @domain: IOMMU domain to attach + * @dev: Device that will be attached + * + * Returns 0 on success and error code on failure + * + * Note that EINVAL may be returned as a soft failure if the domain and device + * are incompatible due to some previous configuration of the domain, in which + * case attaching the same device to a different domain may succeed. + */ int iommu_attach_device(struct iommu_domain *domain, struct device *dev) { struct iommu_group *group; @@ -2101,6 +2112,17 @@ static int __iommu_attach_group(struct iommu_domain *domain, return ret; } +/** + * iommu_attach_group - Attach an IOMMU group to an IOMMU domain + * @domain: IOMMU domain to attach + * @group: IOMMU group that will be attached + * + * Returns 0 on success and error code on failure + * + * Note that EINVAL may be returned as a soft failure if the domain and group + * are incompatible due to some previous configuration of the domain, in which + * case attaching the same group to a different domain may succeed. + */ int iommu_attach_group(struct iommu_domain *domain, struct iommu_group *group) { int ret; diff --git a/include/linux/iommu.h b/include/linux/iommu.h index ea30f00dc145..13a33b04e867 100644 --- a/include/linux/iommu.h +++ b/include/linux/iommu.h @@ -266,6 +266,18 @@ struct iommu_ops { /** * struct iommu_domain_ops - domain specific operations * @attach_dev: attach an iommu domain to a device + * Return: + * * 0 - success + * * EINVAL - can indicate that device and domain are incompatible due to + * some previous configuration of the domain, in which case the + * driver shouldn't log an error, since it is legitimate for a + * caller to test reuse of existing domains. Otherwise, it may + * still represent some other fundamental problem + * * ENOMEM - out of memory + * * ENOSPC - non-ENOMEM type of resource allocation failures + * * EBUSY - device is attached to a domain and cannot be changed + * * ENODEV - device specific errors, not able to be attached + * * <others> - treated as ENODEV by the caller. Use is discouraged * @detach_dev: detach an iommu domain from a device * @map: map a physically contiguous memory region to an iommu domain * @map_pages: map a physically contiguous set of pages of the same size to -- 2.17.1
WARNING: multiple messages have this Message-ID (diff)
From: Nicolin Chen <nicolinc@nvidia.com> To: <joro@8bytes.org>, <suravee.suthikulpanit@amd.com>, <will@kernel.org>, <robin.murphy@arm.com>, <robdclark@gmail.com>, <dwmw2@infradead.org>, <baolu.lu@linux.intel.com>, <agross@kernel.org>, <bjorn.andersson@linaro.org>, <matthias.bgg@gmail.com>, <orsonzhai@gmail.com>, <baolin.wang@linux.alibaba.com>, <zhang.lyra@gmail.com>, <jean-philippe@linaro.org>, <sricharan@codeaurora.org> Cc: kevin.tian@intel.com, quic_saipraka@quicinc.com, linux-kernel@vger.kernel.org, jon@solid-run.com, linux-arm-msm@vger.kernel.org, yangyingliang@huawei.com, konrad.dybcio@somainline.org, iommu@lists.linux.dev, shameerali.kolothum.thodi@huawei.com, jonathanh@nvidia.com, thierry.reding@gmail.com, christophe.jaillet@wanadoo.fr, linux-arm-kernel@lists.infradead.org, jgg@nvidia.com, thunder.leizhen@huawei.com, linux-tegra@vger.kernel.org, linux-mediatek@lists.infradead.org, tglx@linutronix.de, virtualization@lists.linux-foundation.org, yong.wu@mediatek.com Subject: [PATCH v4 3/6] iommu: Add return value rules to attach_dev op and APIs Date: Wed, 21 Sep 2022 01:23:16 -0700 [thread overview] Message-ID: <8c3dbf153b63a3002a46bab6e707c63fd8635bb8.1663744983.git.nicolinc@nvidia.com> (raw) In-Reply-To: <cover.1663744983.git.nicolinc@nvidia.com> Cases like VFIO wish to attach a device to an existing domain that was not allocated specifically from the device. This raises a condition where the IOMMU driver can fail the domain attach because the domain and device are incompatible with each other. This is a soft failure that can be resolved by using a different domain. Provide a dedicated errno EINVAL from the IOMMU driver during attach that the reason why the attach failed is because of domain incompatibility. VFIO can use this to know that the attach is a soft failure and it should continue searching. Otherwise, the attach will be a hard failure and VFIO will return the code to userspace. Update kdocs to add rules of return value to the attach_dev op and APIs. Suggested-by: Jason Gunthorpe <jgg@nvidia.com> Signed-off-by: Nicolin Chen <nicolinc@nvidia.com> --- drivers/iommu/iommu.c | 22 ++++++++++++++++++++++ include/linux/iommu.h | 12 ++++++++++++ 2 files changed, 34 insertions(+) diff --git a/drivers/iommu/iommu.c b/drivers/iommu/iommu.c index 3a808146b50f..1d1e32aeaae6 100644 --- a/drivers/iommu/iommu.c +++ b/drivers/iommu/iommu.c @@ -1975,6 +1975,17 @@ static int __iommu_attach_device(struct iommu_domain *domain, return ret; } +/** + * iommu_attach_device - Attach a device to an IOMMU domain + * @domain: IOMMU domain to attach + * @dev: Device that will be attached + * + * Returns 0 on success and error code on failure + * + * Note that EINVAL may be returned as a soft failure if the domain and device + * are incompatible due to some previous configuration of the domain, in which + * case attaching the same device to a different domain may succeed. + */ int iommu_attach_device(struct iommu_domain *domain, struct device *dev) { struct iommu_group *group; @@ -2101,6 +2112,17 @@ static int __iommu_attach_group(struct iommu_domain *domain, return ret; } +/** + * iommu_attach_group - Attach an IOMMU group to an IOMMU domain + * @domain: IOMMU domain to attach + * @group: IOMMU group that will be attached + * + * Returns 0 on success and error code on failure + * + * Note that EINVAL may be returned as a soft failure if the domain and group + * are incompatible due to some previous configuration of the domain, in which + * case attaching the same group to a different domain may succeed. + */ int iommu_attach_group(struct iommu_domain *domain, struct iommu_group *group) { int ret; diff --git a/include/linux/iommu.h b/include/linux/iommu.h index ea30f00dc145..13a33b04e867 100644 --- a/include/linux/iommu.h +++ b/include/linux/iommu.h @@ -266,6 +266,18 @@ struct iommu_ops { /** * struct iommu_domain_ops - domain specific operations * @attach_dev: attach an iommu domain to a device + * Return: + * * 0 - success + * * EINVAL - can indicate that device and domain are incompatible due to + * some previous configuration of the domain, in which case the + * driver shouldn't log an error, since it is legitimate for a + * caller to test reuse of existing domains. Otherwise, it may + * still represent some other fundamental problem + * * ENOMEM - out of memory + * * ENOSPC - non-ENOMEM type of resource allocation failures + * * EBUSY - device is attached to a domain and cannot be changed + * * ENODEV - device specific errors, not able to be attached + * * <others> - treated as ENODEV by the caller. Use is discouraged * @detach_dev: detach an iommu domain from a device * @map: map a physically contiguous memory region to an iommu domain * @map_pages: map a physically contiguous set of pages of the same size to -- 2.17.1 _______________________________________________ linux-arm-kernel mailing list linux-arm-kernel@lists.infradead.org http://lists.infradead.org/mailman/listinfo/linux-arm-kernel
next prev parent reply other threads:[~2022-09-21 8:24 UTC|newest] Thread overview: 34+ messages / expand[flat|nested] mbox.gz Atom feed top 2022-09-21 8:22 [PATCH v4 0/6] Define EINVAL as device/domain incompatibility Nicolin Chen 2022-09-21 8:22 ` Nicolin Chen 2022-09-21 8:22 ` [PATCH v4 1/6] iommu/msm: Fix error-out routine in msm_iommu_attach_dev() Nicolin Chen 2022-09-22 8:08 ` Tian, Kevin 2022-09-21 8:23 ` [PATCH v4 2/6] iommu/amd: Drop unnecessary checks in amd_iommu_attach_device() Nicolin Chen 2022-09-21 8:23 ` Nicolin Chen [this message] 2022-09-21 8:23 ` [PATCH v4 3/6] iommu: Add return value rules to attach_dev op and APIs Nicolin Chen 2022-09-22 2:02 ` Baolu Lu 2022-09-22 2:02 ` Baolu Lu 2022-09-22 5:09 ` Nicolin Chen 2022-09-22 5:09 ` Nicolin Chen 2022-09-22 8:17 ` Tian, Kevin 2022-09-22 8:17 ` Tian, Kevin 2022-09-22 8:17 ` Tian, Kevin 2022-09-22 8:38 ` Nicolin Chen 2022-09-22 8:38 ` Nicolin Chen 2022-09-21 8:23 ` [PATCH v4 4/6] iommu: Regulate EINVAL in ->attach_dev callback functions Nicolin Chen 2022-09-21 8:23 ` Nicolin Chen 2022-09-22 2:14 ` Baolu Lu 2022-09-22 2:14 ` Baolu Lu 2022-09-22 8:18 ` Tian, Kevin 2022-09-22 8:18 ` Tian, Kevin 2022-09-21 8:23 ` [PATCH v4 5/6] iommu: Use EINVAL for incompatible device/domain in ->attach_dev Nicolin Chen 2022-09-21 8:23 ` Nicolin Chen 2022-09-22 2:16 ` Baolu Lu 2022-09-22 2:16 ` Baolu Lu 2022-09-22 8:19 ` Tian, Kevin 2022-09-22 8:19 ` Tian, Kevin 2022-09-22 8:19 ` Tian, Kevin 2022-09-21 8:23 ` [PATCH v4 6/6] iommu: Propagate return value in ->attach_dev callback functions Nicolin Chen 2022-09-21 8:23 ` Nicolin Chen 2022-09-21 8:55 ` [PATCH v4 0/6] Define EINVAL as device/domain incompatibility Jean-Philippe Brucker 2022-09-21 8:55 ` Jean-Philippe Brucker 2022-09-21 8:55 ` Jean-Philippe Brucker
Reply instructions: You may reply publicly to this message via plain-text email using any one of the following methods: * Save the following mbox file, import it into your mail client, and reply-to-all from there: mbox Avoid top-posting and favor interleaved quoting: https://en.wikipedia.org/wiki/Posting_style#Interleaved_style * Reply using the --to, --cc, and --in-reply-to switches of git-send-email(1): git send-email \ --in-reply-to=8c3dbf153b63a3002a46bab6e707c63fd8635bb8.1663744983.git.nicolinc@nvidia.com \ --to=nicolinc@nvidia.com \ --cc=agross@kernel.org \ --cc=baolin.wang@linux.alibaba.com \ --cc=baolu.lu@linux.intel.com \ --cc=bjorn.andersson@linaro.org \ --cc=christophe.jaillet@wanadoo.fr \ --cc=dwmw2@infradead.org \ --cc=iommu@lists.linux.dev \ --cc=jean-philippe@linaro.org \ --cc=jgg@nvidia.com \ --cc=jon@solid-run.com \ --cc=jonathanh@nvidia.com \ --cc=joro@8bytes.org \ --cc=kevin.tian@intel.com \ --cc=konrad.dybcio@somainline.org \ --cc=linux-arm-kernel@lists.infradead.org \ --cc=linux-arm-msm@vger.kernel.org \ --cc=linux-kernel@vger.kernel.org \ --cc=linux-mediatek@lists.infradead.org \ --cc=linux-tegra@vger.kernel.org \ --cc=matthias.bgg@gmail.com \ --cc=orsonzhai@gmail.com \ --cc=quic_saipraka@quicinc.com \ --cc=robdclark@gmail.com \ --cc=robin.murphy@arm.com \ --cc=shameerali.kolothum.thodi@huawei.com \ --cc=sricharan@codeaurora.org \ --cc=suravee.suthikulpanit@amd.com \ --cc=tglx@linutronix.de \ --cc=thierry.reding@gmail.com \ --cc=thunder.leizhen@huawei.com \ --cc=vdumpa@nvidia.com \ --cc=virtualization@lists.linux-foundation.org \ --cc=will@kernel.org \ --cc=yangyingliang@huawei.com \ --cc=yong.wu@mediatek.com \ --cc=zhang.lyra@gmail.com \ /path/to/YOUR_REPLY https://kernel.org/pub/software/scm/git/docs/git-send-email.html * If your mail client supports setting the In-Reply-To header via mailto: links, try the mailto: linkBe sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes, see mirroring instructions on how to clone and mirror all data and code used by this external index.