[packchk] Add validation that a source module cannot be concurrently added to a project by multiple components #1499 (#1158) (#1991)

* [packchk] Add validation that a source module cannot be concurrently
added to a project by multiple components #1499

Co-authored-by: Thorsten de Buhr <[email protected]>

Author: grasci-arm

tools/packchk/include/CheckComponents.h

@@ -21,10 +21,12 @@ class CheckComponent
   bool CheckComp(RteItem* item);
   bool ConditionRefToDevice(RteItem* item);
   bool TestSubConditions(RteCondition* cond);
+  bool CheckAllCompFiles(RteItem* item);
 
 private:
   std::string m_packagePath;
   RteGlobalModel& m_rteModel;
+    std::map<std::string, RteItem*> m_allFiles;
 };
 
 class ComponentsVisitor : public RteVisitor

tools/packchk/src/CheckComponents.cpp

@@ -6,6 +6,7 @@
 #include "CheckComponents.h"
 #include "CheckFiles.h"
 
+#include "RteComponent.h"
 #include "RteModel.h"
 #include "RteUtils.h"
 #include "ErrLog.h"
@@ -21,10 +22,60 @@ using namespace std;
 VISIT_RESULT ComponentsVisitor::Visit(RteItem* item)
 {
   m_checkComponent.CheckComp(item);
+  m_checkComponent.CheckAllCompFiles(item);
 
   return VISIT_RESULT::CONTINUE_VISIT;
 }
 
+/**
+ * @brief Check all files of all component. Physically the same files should not be referenced by multiple components.
+ * @param item element to test
+ * @return passed / failed
+*/
+bool CheckComponent::CheckAllCompFiles(RteItem* component)
+{
+    bool ok = true;
+  if(!component) {
+    return ok;
+  }
+
+  int lineNo = component->GetLineNumber();
+  string tag = component->GetTag();
+  if(tag != "component") {
+    return true;
+  }
+
+  const auto& compName = component->GetID();
+  const auto files = component->GetGrandChildren("files");
+  for(const auto file : files) {
+    const auto& category = file->GetAttribute("category");
+    if(category == "library" ||
+       category == "object" ||
+       category == "source" ||
+       category == "sourceC" ||
+       category == "sourceCpp" ||
+       category == "sourceAsm" ||
+       category == "genSource") {
+      const auto key = file->GetName()
+        + ':' + file->GetConditionID()
+        + ':' + component->GetCvariantName()
+        + ':' + component->GetCbundleName()
+        + ':' + component->GetConditionID();
+
+      const auto foundIt = m_allFiles.find(key);
+      if(foundIt != m_allFiles.end()) {
+        const auto& foundFilename = foundIt->first;
+        const auto foundItem = foundIt->second;
+        LogMsg("M610", VAL("CAT", category), NAME(foundFilename), NAME2(compName), LINE(lineNo), foundItem->GetLineNumber());
+        continue;
+      }
+      m_allFiles[key] = file;
+    }
+  }
+
+  return ok;
+}
+
 /**
  * @brief Check a component. Iterate over all tests.
  * @param item element to test

tools/packchk/src/PackChk_Msgs.cpp

@@ -242,7 +242,7 @@ const MsgTable PackChk::msgTable = {
   { "M607", { MsgLevel::LEVEL_WARNING,  CRLF_B, "Tag '%TAG%' does not allow wildcard specification: '%NAME%'" } },
   { "M608", { MsgLevel::LEVEL_WARNING,  CRLF_B, "Memory '%NAME%' with '%ATTR%'='%VALUE%' must have '%ATTR2%'='%VALUE2%'" } },
   { "M609", { MsgLevel::LEVEL_WARNING,  CRLF_B, "Processor '%NAME%': Exact one memory with attribute \"startup=1\" must be configured, but found %NUM%" } },
-  { "M610", { MsgLevel::LEVEL_WARNING,  CRLF_B, "" } },
+  { "M610", { MsgLevel::LEVEL_WARNING,  CRLF_B, "File category '%CAT%': '%NAME%' redefined in component '%NAME2%', see Line %LINE%" } },
 
 };
 

tools/packchk/test/data/ConcurrentComponentFiles/ARM.ConcurrentComponentFiles.pdsc

@@ -0,0 +1,93 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<package schemaVersion="1.4.9" xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="PACK.xsd">
+  <vendor>ARM</vendor>
+  <url>https://www.keil.com/pack/</url>
+  <name>ConcurrentComponentFiles</name>
+  <description>[packchk] Add validation that a source module cannot be concurrently added to a project by multiple components #1499</description>
+  <license>TestLicense.txt</license>
+
+  <releases>
+    <release version="1.0.0" date="2025-02-24">
+      Added test
+    </release>
+  </releases>
+
+  <conditions>
+    <condition id="TestDevices">
+      <description>Test devices</description>
+      <require Dvendor="ARM:82" Dname="Test*"/>
+    </condition>
+    <condition id="TestDevices2">
+      <description>Test devices</description>
+      <require Dvendor="ARM:82" Dname="Test2*"/>
+    </condition>
+    <condition id="Test ARMCC">
+      <description>filter for Test Device and the ARM compiler</description>
+      <require condition="TestDevices"/>
+      <require Tcompiler="ARMCC"/>
+    </condition>
+  </conditions>
+
+  <devices>
+    <family Dfamily="TestFamily" Dvendor="ARM:82">
+      <algorithm name="Flash/ARMCMx_512.FLM"  start="0x00000000" size="0x00040000" default="1"/>
+
+      <!-- ******************************  TestSubFamily  ****************************** -->
+      <subFamily DsubFamily="TestSubFamily">
+        <compile header="Files/TestDevices.h"  define="TESTDEVICES"/>
+
+        <description>
+The TestSubFamily is ...
+        </description>
+
+        <!-- ******************************  TestDeviceOk  ***************************** -->
+        <device Dname="TestDeviceOk">
+          <processor Dcore="Cortex-M4"  DcoreVersion="r0p1" Dfpu="SP_FPU" Dmpu="MPU" Ddsp="NO_DSP" Dendian="Little-endian" Dclock="204000000"/>
+          <memory    name="Flash"      access="rx"           start="0x08000000" size="0x00080000" default="1" startup="1" />
+          <memory    name="IRAM1"      access="rwx"          start="0x10000000" size="0x00010000" default="1" />
+          <memory    name="IRAM2"      access="rwx"          start="0x20000000" size="0x00010000" default="0" />
+        </device>
+
+        <!-- ******************************  TestDeviceOk  ***************************** -->
+        <device Dname="Test2DeviceOk">
+          <processor Dcore="Cortex-M4"  DcoreVersion="r0p1" Dfpu="SP_FPU" Dmpu="MPU" Ddsp="NO_DSP" Dendian="Little-endian" Dclock="204000000"/>
+          <memory    name="Flash"      access="rx"           start="0x08000000" size="0x00080000" default="1" startup="1" />
+          <memory    name="IRAM1"      access="rwx"          start="0x10000000" size="0x00010000" default="1" />
+          <memory    name="IRAM2"      access="rwx"          start="0x20000000" size="0x00010000" default="0" />
+        </device>
+
+      </subFamily>
+    </family>
+  </devices>
+
+  <components>
+    <component Cclass="Device" Cgroup="Startup" Cversion="1.0.0" condition="TestDevices">
+      <description>System Startup for STMicroelectronics STM32F1xx device series</description>
+      <files>
+        <file category="include" name="Files/"/>
+        <file category="source"  name="Files/startup_Test.s"     attr="config" version="1.0.0" condition="Test ARMCC"/>
+        <file category="source"  name="Files/system_Test.c"      attr="config" version="1.0.0" />
+      </files>
+    </component>
+
+    <component Cclass="Device" Cgroup="TestComponent1" Cversion="1.0.0" condition="TestDevices">
+      <description>Test Component 1</description>
+      <files>
+        <file category="source"  name="Files/startup_Test.s"       condition="Test ARMCC" />
+        <file category="source"  name="Files/system_Test.c"        condition="Test ARMCC" />
+      </files>
+    </component>
+
+    <component Cclass="Device" Cgroup="TestComponent2" Cversion="1.0.0" condition="TestDevices2">
+      <description>Test Component 1</description>
+      <files>
+        <file category="source"  name="Files/startup_Test.s"       condition="Test ARMCC" />
+        <file category="source"  name="Files/system_Test.c"        condition="Test ARMCC" />
+      </files>
+    </component>
+
+  </components>
+
+
+</package>