[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[RFC] docs/misra: List files in Xen originated from external sources


  • To: <xen-devel@xxxxxxxxxxxxxxxxxxxx>
  • From: Michal Orzel <michal.orzel@xxxxxxx>
  • Date: Wed, 16 Nov 2022 10:20:32 +0100
  • Arc-authentication-results: i=1; mx.microsoft.com 1; spf=pass (sender ip is 165.204.84.17) smtp.rcpttodomain=lists.xenproject.org smtp.mailfrom=amd.com; dmarc=pass (p=quarantine sp=quarantine pct=100) action=none header.from=amd.com; dkim=none (message not signed); arc=none
  • Arc-message-signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector9901; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-AntiSpam-MessageData-ChunkCount:X-MS-Exchange-AntiSpam-MessageData-0:X-MS-Exchange-AntiSpam-MessageData-1; bh=yOwDmJvCjiDYiJNfQiLc7IvHjVQ6McFOol/qyIJ4h+E=; b=MG0Eoq7nLamc19thMXIh64YoVrnqMNhRw1rc6Q5Vzc/9VBYdKTSoKXjTWpBfdQJMa7+TVOmjdtIyHIqEaGH7UZW/Eiyw7BkRMmTt9gdCrv/aIrzISbmUyFlOIPH1uMMJf7P4y5g32V+6flb5h3Hci8/jdceagY0M8vqMdA4p9gjKiqDy4BcMKXiuDlwxJpPstV6W5HRy75ECgpiDiQBl24vxhKgefYWQf4Gq96GOEDWXMyCJwLstjuimyfnqq9GBAPebR3vTkSu3Tda5Ps6YMdBeZMNw2DtvfuWIKxPRzrK3/ZQCW+B82SKqRfUqi5dFFPDqSpCPTW8rS6YKvcc3oA==
  • Arc-seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=mTNkVwe4HgFYv3qipJJbk6BUjQOXudIDzI0uaf1Pcpu6nORoQnVfuHLNsEGpL01Xp52uC/Udx76CnSijSm/ou39ce3PG4xb10SqYQg36raGy2VDVgDatTDHlNqNlH6sVxPvKoQZlihScPqPvOoQyf4nrJ8Qer8JSU0Vob0MfNNih1LHuIqPAfxov4Y0lgzdujeeRTe5+pkAI3j9z3qWbnYQJQpchiJoXol2PSNcCjVkdp9q1OWlDF+0eaSsyxFaPnUP8E3VSpdy7nL5eA0+Tl2jwz+MRIhiEcbx+ECCZK+Je7DsBSBDyndor7mhhMqsQ58A7V2bROn+t8NsdGEaB2w==
  • Cc: Michal Orzel <michal.orzel@xxxxxxx>, Andrew Cooper <andrew.cooper3@xxxxxxxxxx>, George Dunlap <george.dunlap@xxxxxxxxxx>, "Jan Beulich" <jbeulich@xxxxxxxx>, Julien Grall <julien@xxxxxxx>, "Stefano Stabellini" <sstabellini@xxxxxxxxxx>, Wei Liu <wl@xxxxxxx>
  • Delivery-date: Wed, 16 Nov 2022 09:21:32 +0000
  • List-id: Xen developer discussion <xen-devel.lists.xenproject.org>

Add a file with a table listing files in the Xen codebase that originated
from external sources (e.g. Linux kernel). This is done in order to
improve traceability, help with the review process and act as a base for
listing files to exclude from MISRA checkers.

Signed-off-by: Michal Orzel <michal.orzel@xxxxxxx>
---
Some time ago, together with Stefano, we shared a spreadsheet [1] to gather
a feedback about external files in Xen. This RFC patch is moving this
discussion to the mailing list to gather some more comments. The main request
for the maintainers is to check if there are any files missing, check for the
correctness of the already populated entries and decide what to do with the
entries with a question mark.

[1] https://cryptpad.fr/sheet/#/2/sheet/edit/G5WWo5TI71n58OLEG9TCu95j/
---
 docs/misra/external-files.txt | 70 +++++++++++++++++++++++++++++++++++
 1 file changed, 70 insertions(+)
 create mode 100644 docs/misra/external-files.txt

diff --git a/docs/misra/external-files.txt b/docs/misra/external-files.txt
new file mode 100644
index 000000000000..69ff233da456
--- /dev/null
+++ b/docs/misra/external-files.txt
@@ -0,0 +1,70 @@
+External files in Xen
+=====================
+
+The following table lists files present in the Xen codebase that originated
+from external sources e.g. Linux kernel. The purpose of this table is to:
+ - keep track of the external files in the Xen codebase,
+ - help with the review process (e.g. changes done to the files that did not
+   diverge, shall be first submitted to the external projects and then
+   backported to Xen),
+ - act as a base for listing files to exclude from MISRA checkers.
+
+NOTES:
+1) The files shall be listed in alphabetical order.
+2) The origin of the files derived from the projects other than Linux, shall
+   be specified within the () placed next to the path.
+3) The table shall be updated when importing new files from external projects.
+4) At the moment, only the source files are listed in the table.
+
+| Relative path to xen/                     | Diverged from | Subject to       
|
+|                                           | origin? [Y/N] | backports? [Y/N] 
|
++-------------------------------------------+---------------+------------------+
+| arch/arm/arm64/cpufeature.c               | N             | Y                
|
+| arch/arm/arm64/insn.c                     | N             | Y                
|
+| arch/arm/arm64/lib/find_next_bit.c        | N             | Y                
|
+| arch/x86/acpi/boot.c                      | Y             | ?                
|
+| arch/x86/acpi/lib.c                       | ?             | ?                
|
+| arch/x86/cpu/mcheck/mce-apei.c            | N             | Y                
|
+| arch/x86/cpu/mcheck/non-fatal.c           | ?             | Y                
|
+| arch/x86/cpu/mtrr/*                       | Y             | N                
|
+| arch/x86/cpu/amd.c                        | Y             | N                
|
+| arch/x86/cpu/centaur.c                    | Y             | N                
|
+| arch/x86/cpu/common.c                     | Y             | N                
|
+| arch/x86/cpu/hygon.c                      | Y             | N                
|
+| arch/x86/cpu/intel_cacheinfo.c            | Y             | Y                
|
+| arch/x86/cpu/intel.c                      | Y             | N                
|
+| arch/x86/cpu/mwait-idle.c                 | Y             | Y                
|
+| arch/x86/genapic/*                        | Y             | N                
|
+| arch/x86/x86_64/mmconf-fam10h.c           | N             | Y                
|
+| arch/x86/dmi_scan.c                       | Y             | ?                
|
+| arch/x86/mpparse.c                        | Y             | ?                
|
+| arch/x86/srat.c                           | Y             | N                
|
+| common/libfdt/* (libfdt)                  | N             | Y                
|
+| common/lz4/decompress.c                   | N             | Y                
|
+| common/ubsan/ubsan.c                      | Y             | Y                
|
+| common/xz/*                               | N             | Y                
|
+| common/zstd/*                             | N             | Y                
|
+| common/bitmap.c                           | N             | Y                
|
+| common/bunzip2.c                          | N             | Y                
|
+| common/earlycpio.c                        | N             | Y                
|
+| common/inflate.c                          | N             | Y                
|
+| common/radix-tree.c                       | N             | Y                
|
+| common/un*.c                              | N             | Y                
|
+| crypto/rijndael.c (OpenBSD)               | N             | Y                
|
+| crypto/vmac.c (public domain)             | N             | Y                
|
+| drivers/acpi/apei/*                       | N             | Y                
|
+| drivers/acpi/tables/*                     | N             | Y                
|
+| drivers/acpi/utilities/*                  | N             | Y                
|
+| drivers/acpi/hwregs.c                     | N             | Y                
|
+| drivers/acpi/numa.c                       | ?             | Y                
|
+| drivers/acpi/osl.c                        | Y             | Y                
|
+| drivers/acpi/reboot.c                     | N             | Y                
|
+| drivers/acpi/tables.c                     | ?             | Y                
|
+| drivers/passthrough/arm/smmu.c            | Y             | N                
|
+| drivers/passthrough/arm/smmu-v3.c         | Y             | N                
|
+| lib/list-sort.c                           | N             | Y                
|
+| lib/mem*.c                                | N             | Y                
|
+| lib/rbtree.c                              | N             | Y                
|
+| lib/str*.c                                | N             | Y                
|
+| lib/xxhash32.c                            | N             | Y                
|
+| lib/xxhash64.c                            | N             | Y                
|
-- 
2.25.1




 


Rackspace

Lists.xenproject.org is hosted with RackSpace, monitoring our
servers 24x7x365 and backed by RackSpace's Fanatical Support®.