linux-kernel - Re: device_def_domain_type documentation header does not match implementation

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <1333039e-ec61-467e-a0ee-d3cb86e769f5@linux.intel.com>
Date: Fri, 31 May 2024 09:19:37 +0800
From: Baolu Lu <baolu.lu@...ux.intel.com>
To: Robin Murphy <robin.murphy@....com>,
 Diederik de Haas <didi.debian@...ow.org>,
 David Woodhouse <dwmw2@...radead.org>, Joerg Roedel <joro@...tes.org>,
 Will Deacon <will@...nel.org>
Cc: baolu.lu@...ux.intel.com, iommu@...ts.linux.dev,
 linux-kernel@...r.kernel.org
Subject: Re: device_def_domain_type documentation header does not match
 implementation

On 5/30/24 11:49 PM, Robin Murphy wrote:
> On 30/05/2024 2:57 pm, Diederik de Haas wrote:
>> Hi,
>>
>> While looking into 
>> ``drivers/iommu/intel/iommu.c::device_def_domain_type``
>> function I noticed a discrepancy between the documentation header and the
>> implementation.
>>
>> ``@...rtup: true if this is during early boot``
>> 0e31a7266508 ("iommu/vt-d: Remove startup parameter from
>> device_def_domain_type()")
>> removed the ``startup`` function parameter
>>
>> returns ``IOMMU_DOMAIN_DMA: device requires a dynamic mapping domain``
>> 28b41e2c6aeb ("iommu: Move def_domain type check for untrusted device 
>> into
>> core")
>> moved the possible return of ``IOMMU_DOMAIN_DMA`` to 
>> ``drivers/iommu/iommu.c``
>>
>> But neither updated the documentation header.
> 
> TBH it could probably just be deleted now, since the 
> iommu_ops::def_domain_type callback is properly documented in iommu.h, 
> so individual implementations shouldn't need to repeat that. It's also 
> never been actual kerneldoc either, since it's a regular "/*" comment. 
> Feel free to send a patch 🙂

Agreed. I will make a patch to remove it later.

Best regards,
baolu