License header updated to match correct format.

Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Yingke Liu <yingke.d.liu@intel.com>
Reviewed-by: Liming Gao <liming.gao@intel.com>

git-svn-id: https://svn.code.sf.net/p/edk2/code/trunk/edk2@15971 6f19259b-4bc3-4df7-8a09-765794883524

3 files changed, 112 insertions, 19 deletions

diff --git a/BaseTools/Source/Python/Workspace/MetaFileCommentParser.py b/BaseTools/Source/Python/Workspace/MetaFileCommentParser.py
index ee6f5ac2b8..df1e90faf5 100644
--- a/BaseTools/Source/Python/Workspace/MetaFileCommentParser.py
+++ b/BaseTools/Source/Python/Workspace/MetaFileCommentParser.py
@@ -25,4 +25,27 @@ import Common.EdkLogger as EdkLogger
 UsageList = ("PRODUCES", "PRODUCED", "ALWAYS_PRODUCES", "ALWAYS_PRODUCED", "SOMETIMES_PRODUCES",

              "SOMETIMES_PRODUCED", "CONSUMES", "CONSUMED", "ALWAYS_CONSUMES", "ALWAYS_CONSUMED",

              "SOMETIMES_CONSUMES", "SOMETIMES_CONSUMED", "SOMETIME_CONSUMES")

+ErrorMsgMap = {

+    MODEL_EFI_GUID      : "The usage for this GUID is not listed in this INF: %s[%d]:%s",

+    MODEL_EFI_PPI       : "The usage for this PPI is not listed in this INF: %s[%d]:%s.",

+    MODEL_EFI_PROTOCOL  : "The usage for this Protocol is not listed in this INF: %s[%d]:%s.",

+    MODEL_PCD_DYNAMIC   : "The usage for this PCD is not listed in this INF: %s[%d]:%s."

+}

 

+def CheckInfComment(SectionType, Comments, InfFile, LineNo, ValueList):

+    if SectionType in [MODEL_PCD_PATCHABLE_IN_MODULE, MODEL_PCD_DYNAMIC_EX, MODEL_PCD_DYNAMIC]:

+        CheckUsage(Comments, UsageList, InfFile, LineNo, ValueList[0]+'.'+ValueList[1], ErrorMsgMap[MODEL_PCD_DYNAMIC])

+    elif SectionType in [MODEL_EFI_GUID, MODEL_EFI_PPI]:

+        CheckUsage(Comments, UsageList, InfFile, LineNo, ValueList[0], ErrorMsgMap[SectionType])

+    elif SectionType == MODEL_EFI_PROTOCOL:

+        CheckUsage(Comments, UsageList + ("TO_START", "BY_START"), InfFile, LineNo, ValueList[0], ErrorMsgMap[SectionType])

+

+def CheckUsage(Comments, Usages, InfFile, LineNo, Value, ErrorMsg):

+    for Comment in Comments:

+        for Word in Comment[0].replace('#', ' ').split():

+            if Word in Usages:

+                return

+    EdkLogger.error(

+        "Parser", FORMAT_INVALID,

+        ErrorMsg % (InfFile, LineNo, Value)

+    )

diff --git a/BaseTools/Source/Python/Workspace/MetaFileParser.py b/BaseTools/Source/Python/Workspace/MetaFileParser.py
index 98939093d3..53b44f4403 100644
--- a/BaseTools/Source/Python/Workspace/MetaFileParser.py
+++ b/BaseTools/Source/Python/Workspace/MetaFileParser.py
@@ -31,6 +31,7 @@ from CommonDataClass.Exceptions import *
 from Common.LongFilePathSupport import OpenLongFilePath as open

 

 from MetaFileTable import MetaFileStorage

+from MetaFileCommentParser import CheckInfComment

 

 ## A decorator used to parse macro definition

 def ParseMacro(Parser):

@@ -595,6 +596,8 @@ class InfParser(MetaFileParser):
                 continue

             if Comment:

                 Comments.append((Comment, Index + 1))

+            if GlobalData.gOptions and GlobalData.gOptions.CheckUsage:

+                CheckInfComment(self._SectionType, Comments, str(self.MetaFile), Index + 1, self._ValueList)

             #

             # Model, Value1, Value2, Value3, Arch, Platform, BelongsToItem=-1,

             # LineBegin=-1, ColumnBegin=-1, LineEnd=-1, ColumnEnd=-1, Enabled=-1

@@ -823,6 +826,10 @@ class DscParser(MetaFileParser):
         "FIX_LOAD_TOP_MEMORY_ADDRESS"

     ]

 

+    SubSectionDefineKeywords = [

+        "FILE_GUID"

+    ]

+

     SymbolPattern = ValueExpression.SymbolPattern

 

     ## Constructor of DscParser

@@ -1041,13 +1048,15 @@ class DscParser(MetaFileParser):
         if not self._ValueList[2]:

             EdkLogger.error('Parser', FORMAT_INVALID, "No value specified",

                             ExtraData=self._CurrentLine, File=self.MetaFile, Line=self._LineIndex + 1)

-        if not self._ValueList[1] in self.DefineKeywords:

+        if (not self._ValueList[1] in self.DefineKeywords and

+            (self._InSubsection and self._ValueList[1] not in self.SubSectionDefineKeywords)):

             EdkLogger.error('Parser', FORMAT_INVALID,

                             "Unknown keyword found: %s. "

                             "If this is a macro you must "

                             "add it as a DEFINE in the DSC" % self._ValueList[1],

                             ExtraData=self._CurrentLine, File=self.MetaFile, Line=self._LineIndex + 1)

-        self._Defines[self._ValueList[1]] = self._ValueList[2]

+        if not self._InSubsection:

+            self._Defines[self._ValueList[1]] = self._ValueList[2]

         self._ItemType = self.DataType[TAB_DSC_DEFINES.upper()]

 

     @ParseMacro

@@ -1226,6 +1235,7 @@ class DscParser(MetaFileParser):
         self.__RetrievePcdValue()

         self._Content = self._RawTable.GetAll()

         self._ContentIndex = 0

+        self._InSubsection = False

         while self._ContentIndex < len(self._Content) :

             Id, self._ItemType, V1, V2, V3, S1, S2, Owner, self._From, \

                 LineStart, ColStart, LineEnd, ColEnd, Enabled = self._Content[self._ContentIndex]

@@ -1254,6 +1264,10 @@ class DscParser(MetaFileParser):
             self._LineIndex = LineStart - 1

             self._ValueList = [V1, V2, V3]

 

+            if Owner > 0 and Owner in self._IdMapping:

+                self._InSubsection = True

+            else:

+                self._InSubsection = False

             try:

                 Processer[self._ItemType]()

             except EvaluationException, Excpt:

@@ -1356,6 +1370,13 @@ class DscParser(MetaFileParser):
 

         Type, Name, Value = self._ValueList

         Value = ReplaceMacro(Value, self._Macros, False)

+        #

+        # If it is <Defines>, return

+        #

+        if self._InSubsection:

+            self._ValueList = [Type, Name, Value]

+            return

+

         if self._ItemType == MODEL_META_DATA_DEFINE:

             if self._SectionType == MODEL_META_DATA_HEADER:

                 self._FileLocalMacros[Name] = Value

diff --git a/BaseTools/Source/Python/Workspace/WorkspaceDatabase.py b/BaseTools/Source/Python/Workspace/WorkspaceDatabase.py
index 638df1f6ed..83f730e629 100644
--- a/BaseTools/Source/Python/Workspace/WorkspaceDatabase.py
+++ b/BaseTools/Source/Python/Workspace/WorkspaceDatabase.py
@@ -35,9 +35,12 @@ from MetaFileParser import *
 from BuildClassObject import *

 from WorkspaceCommon import GetDeclaredPcd

 from Common.Misc import AnalyzeDscPcd

+from Common.Misc import ProcessDuplicatedInf

 import re

 from Common.Parsing import IsValidWord

 

+import Common.GlobalData as GlobalData

+

 ## Platform build information from DSC file

 #

 #  This class is used to retrieve information stored in database and convert them

@@ -103,6 +106,7 @@ class DscBuildData(PlatformBuildClassObject):
         self._Target = Target

         self._Toolchain = Toolchain

         self._Clear()

+        self._HandleOverridePath()

 

     ## XXX[key] = value

     def __setitem__(self, key, value):

@@ -147,6 +151,27 @@ class DscBuildData(PlatformBuildClassObject):
         self._VpdToolGuid       = None

         self.__Macros            = None

 

+

+    ## handle Override Path of Module

+    def _HandleOverridePath(self):

+        RecordList = self._RawData[MODEL_META_DATA_COMPONENT, self._Arch]

+        Macros = self._Macros

+        Macros["EDK_SOURCE"] = GlobalData.gEcpSource

+        for Record in RecordList:

+            ModuleId = Record[5]

+            LineNo = Record[6]

+            ModuleFile = PathClass(NormPath(Record[0]), GlobalData.gWorkspace, Arch=self._Arch)

+            RecordList = self._RawData[MODEL_META_DATA_COMPONENT_SOURCE_OVERRIDE_PATH, self._Arch, None, ModuleId]

+            if RecordList != []:

+                SourceOverridePath = os.path.join(GlobalData.gWorkspace, NormPath(RecordList[0][0]))

+

+                # Check if the source override path exists

+                if not os.path.isdir(SourceOverridePath):

+                    EdkLogger.error('build', FILE_NOT_FOUND, Message='Source override path does not exist:', File=self.MetaFile, ExtraData=SourceOverridePath, Line=LineNo)

+

+                #Add to GlobalData Variables

+                GlobalData.gOverrideDir[ModuleFile.Key] = SourceOverridePath

+

     ## Get current effective macros

     def _GetMacros(self):

         if self.__Macros == None:

@@ -478,6 +503,7 @@ class DscBuildData(PlatformBuildClassObject):
         Macros = self._Macros

         Macros["EDK_SOURCE"] = GlobalData.gEcpSource

         for Record in RecordList:

+            DuplicatedFile = False

             ModuleFile = PathClass(NormPath(Record[0], Macros), GlobalData.gWorkspace, Arch=self._Arch)

             ModuleId = Record[5]

             LineNo = Record[6]

@@ -490,23 +516,11 @@ class DscBuildData(PlatformBuildClassObject):
             # Check duplication

             # If arch is COMMON, no duplicate module is checked since all modules in all component sections are selected

             if self._Arch != 'COMMON' and ModuleFile in self._Modules:

-                EdkLogger.error('build', FILE_DUPLICATED, File=self.MetaFile, ExtraData=str(ModuleFile), Line=LineNo)

+                DuplicatedFile = True

 

             Module = ModuleBuildClassObject()

             Module.MetaFile = ModuleFile

 

-            # get module override path

-            RecordList = self._RawData[MODEL_META_DATA_COMPONENT_SOURCE_OVERRIDE_PATH, self._Arch, None, ModuleId]

-            if RecordList != []:

-                Module.SourceOverridePath = os.path.join(GlobalData.gWorkspace, NormPath(RecordList[0][0], Macros))

-

-                # Check if the source override path exists

-                if not os.path.isdir(Module.SourceOverridePath):

-                    EdkLogger.error('build', FILE_NOT_FOUND, Message = 'Source override path does not exist:', File=self.MetaFile, ExtraData=Module.SourceOverridePath, Line=LineNo)

-                

-                #Add to GlobalData Variables

-                GlobalData.gOverrideDir[ModuleFile.Key] = Module.SourceOverridePath

-

             # get module private library instance

             RecordList = self._RawData[MODEL_EFI_LIBRARY_CLASS, self._Arch, None, ModuleId]

             for Record in RecordList:

@@ -563,6 +577,16 @@ class DscBuildData(PlatformBuildClassObject):
                     OptionString = Module.BuildOptions[ToolChainFamily, ToolChain]

                     Module.BuildOptions[ToolChainFamily, ToolChain] = OptionString + " " + Option

 

+            RecordList = self._RawData[MODEL_META_DATA_HEADER, self._Arch, None, ModuleId]

+            if DuplicatedFile and not RecordList:

+                EdkLogger.error('build', FILE_DUPLICATED, File=self.MetaFile, ExtraData=str(ModuleFile), Line=LineNo)

+            if RecordList:

+                if len(RecordList) != 1:

+                    EdkLogger.error('build', OPTION_UNKNOWN, 'Only FILE_GUID can be listed in <Defines> section.',

+                                    File=self.MetaFile, ExtraData=str(ModuleFile), Line=LineNo)

+                ModuleFile = ProcessDuplicatedInf(ModuleFile, RecordList[0][2], GlobalData.gWorkspace)

+                ModuleFile.Arch = self._Arch

+

             self._Modules[ModuleFile] = Module

         return self._Modules

 

@@ -641,9 +665,26 @@ class DscBuildData(PlatformBuildClassObject):
     def _ValidatePcd(self, PcdCName, TokenSpaceGuid, Setting, PcdType, LineNo):

         if self._DecPcds == None:

             self._DecPcds = GetDeclaredPcd(self, self._Bdb, self._Arch, self._Target, self._Toolchain)

+            FdfInfList = []

+            if GlobalData.gFdfParser:

+                FdfInfList = GlobalData.gFdfParser.Profile.InfList

+

+            PkgSet = set()

+            for Inf in FdfInfList:

+                ModuleFile = PathClass(NormPath(Inf), GlobalData.gWorkspace, Arch=self._Arch)

+                if ModuleFile in self._Modules:

+                    continue

+                ModuleData = self._Bdb[ModuleFile, self._Arch, self._Target, self._Toolchain]

+                PkgSet.update(ModuleData.Packages)

+            DecPcds = {}

+            for Pkg in PkgSet:

+                for Pcd in Pkg.Pcds:

+                    DecPcds[Pcd[0], Pcd[1]] = Pkg.Pcds[Pcd]

+            self._DecPcds.update(DecPcds)

+

         if (PcdCName, TokenSpaceGuid) not in self._DecPcds:

             EdkLogger.error('build', PARSER_ERROR,

-                            "Pcd (%s.%s) defined in DSC is not declared in DEC files." % (TokenSpaceGuid, PcdCName),

+                            "Pcd (%s.%s) defined in DSC is not declared in DEC files. Arch: ['%s']" % (TokenSpaceGuid, PcdCName, self._Arch),

                             File=self.MetaFile, Line=LineNo)

         ValueList, IsValid, Index = AnalyzeDscPcd(Setting, PcdType, self._DecPcds[PcdCName, TokenSpaceGuid].DatumType)

         if not IsValid and PcdType not in [MODEL_PCD_FEATURE_FLAG, MODEL_PCD_FIXED_AT_BUILD]:

@@ -1676,6 +1717,9 @@ class InfBuildData(ModuleBuildClassObject):
             # items defined _PROPERTY_ don't need additional processing

             if Name in self:

                 self[Name] = Value

+                if self._Defs == None:

+                    self._Defs = sdict()

+                self._Defs[Name] = Value

             # some special items in [Defines] section need special treatment

             elif Name in ('EFI_SPECIFICATION_VERSION', 'UEFI_SPECIFICATION_VERSION', 'EDK_RELEASE_VERSION', 'PI_SPECIFICATION_VERSION'):

                 if Name in ('EFI_SPECIFICATION_VERSION', 'UEFI_SPECIFICATION_VERSION'):

@@ -2309,6 +2353,13 @@ class InfBuildData(ModuleBuildClassObject):
                     EdkLogger.error('build', RESOURCE_NOT_AVAILABLE, "No [Depex] section or no valid expression in [Depex] section for [%s] module" \

                                     % self.ModuleType, File=self.MetaFile)

 

+            if len(RecordList) != 0 and self.ModuleType == 'USER_DEFINED':

+                for Record in RecordList:

+                    if Record[4] not in ['PEIM', 'DXE_DRIVER', 'DXE_SMM_DRIVER']:

+                        EdkLogger.error('build', FORMAT_INVALID,

+                                        "'%s' module must specify the type of [Depex] section" % self.ModuleType,

+                                        File=self.MetaFile)

+

             Depex = sdict()

             for Record in RecordList:

                 DepexStr = ReplaceMacro(Record[0], self._Macros, False)

@@ -2570,8 +2621,6 @@ class InfBuildData(ModuleBuildClassObject):
 #

 class WorkspaceDatabase(object):

 

-    # default database file path

-    _DB_PATH_ = "Conf/.cache/build.db"

 

     #

     # internal class used for call corresponding file parser and caching the result

@@ -2682,7 +2731,7 @@ class WorkspaceDatabase(object):
     def __init__(self, DbPath, RenewDb=False):

         self._DbClosedFlag = False

         if not DbPath:

-            DbPath = os.path.normpath(os.path.join(GlobalData.gWorkspace, self._DB_PATH_))

+            DbPath = os.path.normpath(os.path.join(GlobalData.gWorkspace, 'Conf', GlobalData.gDatabasePath))

 

         # don't create necessary path for db in memory

         if DbPath != ':memory:':