From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id B7412C87FCB for ; Fri, 1 Aug 2025 18:08:40 +0000 (UTC) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1uhuB4-0001Xl-SE; Fri, 01 Aug 2025 14:08:23 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1uhsha-0003iF-Bg for qemu-devel@nongnu.org; Fri, 01 Aug 2025 12:33:56 -0400 Received: from us-smtp-delivery-124.mimecast.com ([170.10.133.124]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1uhshW-0001uW-Pp for qemu-devel@nongnu.org; Fri, 01 Aug 2025 12:33:49 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1754066023; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:autocrypt:autocrypt; bh=sCfDNfEoM7GuTS9GMPTGHA59ihBe2zpuoczmOsdZs7M=; b=icgU6AOjD1L3b9W4ktTF3Yk/dgIeZTsc5mGs6hvWtlDAkAM4wXbKx9HcBI7CKzHO5UrND9 kv9Ez3iTYYGOR5pFP4kuLZVLg7A8cKlOF3/PxHZCpn4K6kJ1xsMUoiYBDFUkuSOofHWYPS IEhjILdEoyxdEuv/38NXS5QxjYBvX1s= Received: from mail-wr1-f70.google.com (mail-wr1-f70.google.com [209.85.221.70]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-318-si_SdR6MOQi7xFLmUS5MwA-1; Fri, 01 Aug 2025 12:33:42 -0400 X-MC-Unique: si_SdR6MOQi7xFLmUS5MwA-1 X-Mimecast-MFC-AGG-ID: si_SdR6MOQi7xFLmUS5MwA_1754066021 Received: by mail-wr1-f70.google.com with SMTP id ffacd0b85a97d-3b7961b3c82so1121717f8f.0 for ; Fri, 01 Aug 2025 09:33:42 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1754066021; x=1754670821; h=content-transfer-encoding:in-reply-to:autocrypt:content-language :from:references:cc:to:subject:user-agent:mime-version:date :message-id:x-gm-message-state:from:to:cc:subject:date:message-id :reply-to; bh=sCfDNfEoM7GuTS9GMPTGHA59ihBe2zpuoczmOsdZs7M=; b=W6N+uvwBd9TZ3ihnBn9surKwUvDctRz0gj5gKKwwsO6eGhC2SLeiJ9H8CwQt7RkFoP GkIX3kxn2X3VOHhuMa/ziqVtGOYgrR8krqQ3vZ1c4q2luZVkuVIc0uYPzMDrn0HkMr0n D6aZcrh2zU5xtfV91p3EV0zrUwJ/Ggn5nD9Ik5gBL5POpukWdczD5GR4eqH3S33rM58X qPXFOBNJ+MI3QorZas/DPB+iueYqlGVblMlSv1PdJHhhMdePCzZ3bnaqwWw6ubDuJjTB fwtQogL4BHeawbuBXdS6szDbEDoPpMn+mM142a+uCdcHxJv4ghgw+1/M/LX0YmLVeX+6 3JWQ== X-Forwarded-Encrypted: i=1; AJvYcCUCjX2XcE33e1wIQ4zdFHT4jiGD97NDsexmPjQiswCY9/ToKxgrreoull/UEMC1oIJq7fw6F8Yhdd9/@nongnu.org X-Gm-Message-State: AOJu0YxFj2Wxwm3iqsxpI8NjUQq3NAGXJIgRpoyQhl3KIyouHbzT2Yr0 Z+8bOeHAwAouzAz0eo8881JHK3xcnnkzctAUbWKGB/kSA2vZruCQzr1KUPGmaeX8F8X/83dW305 76lmRFRG+K+tyyUghtBupS9EmT/PwGgsUEtjjXPqRVa701bmh3gdCS8pF X-Gm-Gg: ASbGnct18iFKDOJqcipgkum73NVsYFdTUJQZyE/AFP9iby2/0dGDPOwCtbs2COZn6qZ iCPpaEJp3Tv+ACxeL0hRpexGAF5/r4B3QDB/OpX0U7+99vnBoH64Aw3y+R73zT3UxqbrM7d2VgE dLwvm2+2wrOPILEmesYZziHMEhGgASEMEExfz9tMQ3KYEmvIsp5BSmzGTdmzqXmO5V+mZKbGzRG u1dUevMVe3DzHulTOwOCc9DrTgO/ccdADSF1U4S2oavm/f4ufVvTyUW/CtO0Vt8rsKJGrPLuz74 iPmvl1Wyqk6fzW2OY/dOzsKx9eJINTV5uy2WEpwblsEeE/TcA54CRylY9C3lh5UdTNNq4bQbr/g T/JTqjzA= X-Received: by 2002:a05:6000:2502:b0:3a4:f70e:abda with SMTP id ffacd0b85a97d-3b8d9469850mr403208f8f.10.1754066021122; Fri, 01 Aug 2025 09:33:41 -0700 (PDT) X-Google-Smtp-Source: AGHT+IGNnhUF2Uo1D3s2d3PAUr/TY89VnWZRRz5UEUdxP6W0uJ+JFHWOp957eNUiHl2dY8uk/F75cQ== X-Received: by 2002:a05:6000:2502:b0:3a4:f70e:abda with SMTP id ffacd0b85a97d-3b8d9469850mr403187f8f.10.1754066020693; Fri, 01 Aug 2025 09:33:40 -0700 (PDT) Received: from ?IPV6:2a01:cb19:9004:d500:837f:93fd:c85e:5b97? ([2a01:cb19:9004:d500:837f:93fd:c85e:5b97]) by smtp.gmail.com with ESMTPSA id ffacd0b85a97d-3b79c470102sm6387593f8f.53.2025.08.01.09.33.39 (version=TLS1_3 cipher=TLS_AES_128_GCM_SHA256 bits=128/128); Fri, 01 Aug 2025 09:33:40 -0700 (PDT) Message-ID: <2c3f3861-0a6f-49f4-902d-d1265b842795@redhat.com> Date: Fri, 1 Aug 2025 18:33:39 +0200 MIME-Version: 1.0 User-Agent: Mozilla Thunderbird Subject: Re: [PATCH v3] vfio: Introduce helper vfio_pci_from_vfio_device() To: Peter Maydell Cc: Zhenzhong Duan , qemu-devel@nongnu.org, alex.williamson@redhat.com, eric.auger@redhat.com, chao.p.peng@intel.com, =?UTF-8?Q?Philippe_Mathieu-Daud=C3=A9?= References: <20250801023533.1458644-1-zhenzhong.duan@intel.com> <8b599c19-1901-4707-a8ca-943f61c0e2f9@redhat.com> From: =?UTF-8?Q?C=C3=A9dric_Le_Goater?= Content-Language: en-US, fr Autocrypt: addr=clg@redhat.com; keydata= xsFNBFu8o3UBEADP+oJVJaWm5vzZa/iLgpBAuzxSmNYhURZH+guITvSySk30YWfLYGBWQgeo 8NzNXBY3cH7JX3/a0jzmhDc0U61qFxVgrPqs1PQOjp7yRSFuDAnjtRqNvWkvlnRWLFq4+U5t yzYe4SFMjFb6Oc0xkQmaK2flmiJNnnxPttYwKBPd98WfXMmjwAv7QfwW+OL3VlTPADgzkcqj 53bfZ4VblAQrq6Ctbtu7JuUGAxSIL3XqeQlAwwLTfFGrmpY7MroE7n9Rl+hy/kuIrb/TO8n0 ZxYXvvhT7OmRKvbYuc5Jze6o7op/bJHlufY+AquYQ4dPxjPPVUT/DLiUYJ3oVBWFYNbzfOrV RxEwNuRbycttMiZWxgflsQoHF06q/2l4ttS3zsV4TDZudMq0TbCH/uJFPFsbHUN91qwwaN/+ gy1j7o6aWMz+Ib3O9dK2M/j/O/Ube95mdCqN4N/uSnDlca3YDEWrV9jO1mUS/ndOkjxa34ia 70FjwiSQAsyIwqbRO3CGmiOJqDa9qNvd2TJgAaS2WCw/TlBALjVQ7AyoPEoBPj31K74Wc4GS Rm+FSch32ei61yFu6ACdZ12i5Edt+To+hkElzjt6db/UgRUeKfzlMB7PodK7o8NBD8outJGS tsL2GRX24QvvBuusJdMiLGpNz3uqyqwzC5w0Fd34E6G94806fwARAQABzSJDw6lkcmljIExl IEdvYXRlciA8Y2xnQHJlZGhhdC5jb20+wsGRBBMBCAA7FiEEoPZlSPBIlev+awtgUaNDx8/7 7KEFAmTLlVECGwMFCwkIBwICIgIGFQoJCAsCBBYCAwECHgcCF4AACgkQUaNDx8/77KG0eg// S0zIzTcxkrwJ/9XgdcvVTnXLVF9V4/tZPfB7sCp8rpDCEseU6O0TkOVFoGWM39sEMiQBSvyY lHrP7p7E/JYQNNLh441MfaX8RJ5Ul3btluLapm8oHp/vbHKV2IhLcpNCfAqaQKdfk8yazYhh EdxTBlzxPcu+78uE5fF4wusmtutK0JG0sAgq0mHFZX7qKG6LIbdLdaQalZ8CCFMKUhLptW71 xe+aNrn7hScBoOj2kTDRgf9CE7svmjGToJzUxgeh9mIkxAxTu7XU+8lmL28j2L5uNuDOq9vl hM30OT+pfHmyPLtLK8+GXfFDxjea5hZLF+2yolE/ATQFt9AmOmXC+YayrcO2ZvdnKExZS1o8 VUKpZgRnkwMUUReaF/mTauRQGLuS4lDcI4DrARPyLGNbvYlpmJWnGRWCDguQ/LBPpbG7djoy k3NlvoeA757c4DgCzggViqLm0Bae320qEc6z9o0X0ePqSU2f7vcuWN49Uhox5kM5L86DzjEQ RHXndoJkeL8LmHx8DM+kx4aZt0zVfCHwmKTkSTQoAQakLpLte7tWXIio9ZKhUGPv/eHxXEoS 0rOOAZ6np1U/xNR82QbF9qr9TrTVI3GtVe7Vxmff+qoSAxJiZQCo5kt0YlWwti2fFI4xvkOi V7lyhOA3+/3oRKpZYQ86Frlo61HU3r6d9wzOwU0EW7yjdQEQALyDNNMw/08/fsyWEWjfqVhW pOOrX2h+z4q0lOHkjxi/FRIRLfXeZjFfNQNLSoL8j1y2rQOs1j1g+NV3K5hrZYYcMs0xhmrZ KXAHjjDx7FW3sG3jcGjFW5Xk4olTrZwFsZVUcP8XZlArLmkAX3UyrrXEWPSBJCXxDIW1hzwp bV/nVbo/K9XBptT/wPd+RPiOTIIRptjypGY+S23HYBDND3mtfTz/uY0Jytaio9GETj+fFis6 TxFjjbZNUxKpwftu/4RimZ7qL+uM1rG1lLWc9SPtFxRQ8uLvLOUFB1AqHixBcx7LIXSKZEFU CSLB2AE4wXQkJbApye48qnZ09zc929df5gU6hjgqV9Gk1rIfHxvTsYltA1jWalySEScmr0iS YBZjw8Nbd7SxeomAxzBv2l1Fk8fPzR7M616dtb3Z3HLjyvwAwxtfGD7VnvINPbzyibbe9c6g LxYCr23c2Ry0UfFXh6UKD83d5ybqnXrEJ5n/t1+TLGCYGzF2erVYGkQrReJe8Mld3iGVldB7 JhuAU1+d88NS3aBpNF6TbGXqlXGF6Yua6n1cOY2Yb4lO/mDKgjXd3aviqlwVlodC8AwI0Sdu jWryzL5/AGEU2sIDQCHuv1QgzmKwhE58d475KdVX/3Vt5I9kTXpvEpfW18TjlFkdHGESM/Jx IqVsqvhAJkalABEBAAHCwV8EGAECAAkFAlu8o3UCGwwACgkQUaNDx8/77KEhwg//WqVopd5k 8hQb9VVdk6RQOCTfo6wHhEqgjbXQGlaxKHoXywEQBi8eULbeMQf5l4+tHJWBxswQ93IHBQjK yKyNr4FXseUI5O20XVNYDJZUrhA4yn0e/Af0IX25d94HXQ5sMTWr1qlSK6Zu79lbH3R57w9j hQm9emQEp785ui3A5U2Lqp6nWYWXz0eUZ0Tad2zC71Gg9VazU9MXyWn749s0nXbVLcLS0yop s302Gf3ZmtgfXTX/W+M25hiVRRKCH88yr6it+OMJBUndQVAA/fE9hYom6t/zqA248j0QAV/p LHH3hSirE1mv+7jpQnhMvatrwUpeXrOiEw1nHzWCqOJUZ4SY+HmGFW0YirWV2mYKoaGO2YBU wYF7O9TI3GEEgRMBIRT98fHa0NPwtlTktVISl73LpgVscdW8yg9Gc82oe8FzU1uHjU8b10lU XOMHpqDDEV9//r4ZhkKZ9C4O+YZcTFu+mvAY3GlqivBNkmYsHYSlFsbxc37E1HpTEaSWsGfA HQoPn9qrDJgsgcbBVc1gkUT6hnxShKPp4PlsZVMNjvPAnr5TEBgHkk54HQRhhwcYv1T2QumQ izDiU6iOrUzBThaMhZO3i927SG2DwWDVzZltKrCMD1aMPvb3NU8FOYRhNmIFR3fcalYr+9gD uVKe8BVz4atMOoktmt0GWTOC8P4= In-Reply-To: Content-Type: text/plain; charset=UTF-8; format=flowed Content-Transfer-Encoding: 8bit Received-SPF: pass client-ip=170.10.133.124; envelope-from=clg@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.001, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, RCVD_IN_MSPIKE_H5=0.001, RCVD_IN_MSPIKE_WL=0.001, RCVD_IN_VALIDITY_CERTIFIED_BLOCKED=0.001, RCVD_IN_VALIDITY_RPBL_BLOCKED=0.001, SPF_HELO_PASS=-0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Sender: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org On 8/1/25 17:56, Peter Maydell wrote: > On Fri, 1 Aug 2025 at 16:47, Cédric Le Goater wrote: >> I have modified your patch with : >> >> +/** >> + * vfio_pci_from_vfio_device: Transform from VFIODevice to >> + * VFIOPCIDevice >> + * >> + * This function checks if the given @vbasedev is a VFIO PCI device. >> + * If it is, it returns the containing VFIOPCIDevice. >> + * >> + * @vbasedev: The VFIODevice to transform >> + * >> + * Return: The VFIOPCIDevice on success, NULL on failure. >> + */ >> >> See https://github.com/legoater/qemu/tree/vfio-10.2. >> >> I don't think it's really necessary, as these are internal APIs and >> none are documented, but Philippe seems keen on it. I guess he plans >> to volunteer to document the rest ;) > > This is one of those cases where we have a rule in place > that we apply on code review for newly added prototypes > in header files, as an exercise in trying to at least not > make an existing problem worse :-) Sure. May be, this is something we could add to checkpatch.pl then ? This would reduce the resends for simple things. > I think Philippe's intent was just to say "put that one > line comment by the prototype in the .h file rather than > by the implementation in the .c file", rather than to > require a full-on doc-comment format comment, though > I do appreciate having one. I've tried to reorganize the VFIO code to define some software subcomponents and layers in previous versions. This to handle recent (rather significant) changes and also because vfio-pci was initially a device and is gradually evolving into a kind of library. I'd also like to address documentation, so my comment was self-interested :) as it's a pretty broad topic; any help is welcome ! I should find a way to generate some of it to start with. At least. Thanks, C.