public inbox for devel@edk2.groups.io
 help / color / mirror / Atom feed
From: "yi1 li" <yi1.li@intel.com>
To: devel@edk2.groups.io
Cc: yi1 li <yi1.li@intel.com>, Bob Feng <bob.c.feng@intel.com>,
	Liming Gao <gaoliming@byosoft.com.cn>,
	"Zhiju . Fan" <zhijux.fan@intel.com>
Subject: [PATCH V2 1/2] BaseTools:Add the FeatureFlagExpression usage to the InfBuildData
Date: Tue,  8 Mar 2022 21:42:06 +0800	[thread overview]
Message-ID: <7420ff3ad3ee0fad8c588d8031602a992a9d0d73.1646746598.git.yi1.li@intel.com> (raw)
In-Reply-To: <cover.1646746598.git.yi1.li@intel.com>

REF:https://bugzilla.tianocore.org/show_bug.cgi?id=1446

FeatureFlagExpression Support in LibraryClasses/Guids/Ppi/Protocols
section of INF file. The Pcd value in the expression is from INF or DEC
When a FeatureFlagExpression is present,if the expression evaluates
to TRUE,then the entry is valid. If the expression evaluates to FALSE,
then the EDK II build tools must ignore the entry.

This patch is going to add this feature.

Cc: Bob Feng <bob.c.feng@intel.com>
Cc: Liming Gao <gaoliming@byosoft.com.cn>
Signed-off-by: yi1 li <yi1.li@intel.com>
Signed-off-by: Zhiju.Fan <zhijux.fan@intel.com>
---
 BaseTools/Source/Python/Common/Expression.py  |  2 +-
 BaseTools/Source/Python/Common/GlobalData.py  |  1 +
 .../Source/Python/Workspace/InfBuildData.py   | 67 +++++++++++++++++--
 .../Python/Workspace/WorkspaceCommon.py       | 10 ++-
 4 files changed, 72 insertions(+), 8 deletions(-)

diff --git a/BaseTools/Source/Python/Common/Expression.py b/BaseTools/Source/Python/Common/Expression.py
index 07ca039a9cf3..31bf0e4b6cf7 100644
--- a/BaseTools/Source/Python/Common/Expression.py
+++ b/BaseTools/Source/Python/Common/Expression.py
@@ -43,7 +43,7 @@ ERR_IN_OPERAND          = 'Macro after IN operator can only be: $(FAMILY), $(ARC
 __ValidString = re.compile(r'[_a-zA-Z][_0-9a-zA-Z]*$')
 _ReLabel = re.compile('LABEL\((\w+)\)')
 _ReOffset = re.compile('OFFSET_OF\((\w+)\)')
-PcdPattern = re.compile(r'[_a-zA-Z][0-9A-Za-z_]*\.[_a-zA-Z][0-9A-Za-z_]*$')
+PcdPattern = re.compile(r'^[_a-zA-Z][0-9A-Za-z_]*\.[_a-zA-Z][0-9A-Za-z_]*$')
 
 ## SplitString
 #  Split string to list according double quote
diff --git a/BaseTools/Source/Python/Common/GlobalData.py b/BaseTools/Source/Python/Common/GlobalData.py
index 61ab3f7e24cd..197bd8366682 100755
--- a/BaseTools/Source/Python/Common/GlobalData.py
+++ b/BaseTools/Source/Python/Common/GlobalData.py
@@ -18,6 +18,7 @@ gGlobalDefines = {}
 gPlatformDefines = {}
 # PCD name and value pair for fixed at build and feature flag
 gPlatformPcds = {}
+gPlatformFinalPcds = {}
 # PCDs with type that are not fixed at build and feature flag
 gPlatformOtherPcds = {}
 gActivePlatform = None
diff --git a/BaseTools/Source/Python/Workspace/InfBuildData.py b/BaseTools/Source/Python/Workspace/InfBuildData.py
index 45b8ef4716dd..91d986d8cb1b 100644
--- a/BaseTools/Source/Python/Workspace/InfBuildData.py
+++ b/BaseTools/Source/Python/Workspace/InfBuildData.py
@@ -14,6 +14,7 @@ from types import *
 from .MetaFileParser import *
 from collections import OrderedDict
 from Workspace.BuildClassObject import ModuleBuildClassObject, LibraryClassObject, PcdClassObject
+from Common.Expression import ValueExpressionEx, PcdPattern
 
 ## Get Protocol value from given packages
 #
@@ -554,6 +555,9 @@ class InfBuildData(ModuleBuildClassObject):
             Instance = Record[1]
             if Instance:
                 Instance = NormPath(Instance, self._Macros)
+                FeaturePcdExpression = self.CheckFeatureFlagPcd(Instance)
+                if not FeaturePcdExpression:
+                    continue
                 RetVal[Lib] = Instance
             else:
                 RetVal[Lib] = None
@@ -584,6 +588,10 @@ class InfBuildData(ModuleBuildClassObject):
         self._ProtocolComments = OrderedDict()
         RecordList = self._RawData[MODEL_EFI_PROTOCOL, self._Arch, self._Platform]
         for Record in RecordList:
+            if Record[1]:
+                FeaturePcdExpression = self.CheckFeatureFlagPcd(Record[1])
+                if not FeaturePcdExpression:
+                    continue
             CName = Record[0]
             Value = _ProtocolValue(CName, self.Packages, self.MetaFile.Path)
             if Value is None:
@@ -608,6 +616,10 @@ class InfBuildData(ModuleBuildClassObject):
         self._PpiComments = OrderedDict()
         RecordList = self._RawData[MODEL_EFI_PPI, self._Arch, self._Platform]
         for Record in RecordList:
+            if Record[1]:
+                FeaturePcdExpression = self.CheckFeatureFlagPcd(Record[1])
+                if not FeaturePcdExpression:
+                    continue
             CName = Record[0]
             Value = _PpiValue(CName, self.Packages, self.MetaFile.Path)
             if Value is None:
@@ -631,7 +643,12 @@ class InfBuildData(ModuleBuildClassObject):
         RetVal = OrderedDict()
         self._GuidComments = OrderedDict()
         RecordList = self._RawData[MODEL_EFI_GUID, self._Arch, self._Platform]
+        RetVal.update(self.GetGuidsUsedByPcd())
         for Record in RecordList:
+            if Record[1]:
+                FeaturePcdExpression = self.CheckFeatureFlagPcd(Record[1])
+                if not FeaturePcdExpression:
+                    continue
             CName = Record[0]
             Value = GuidValue(CName, self.Packages, self.MetaFile.Path)
             if Value is None:
@@ -860,7 +877,12 @@ class InfBuildData(ModuleBuildClassObject):
     def GetGuidsUsedByPcd(self):
         self.Guid
         return self._GuidsUsedByPcd
-
+    @cached_class_function
+    def GetGuidDict(self):
+        GuidDict = OrderedDict()
+        for Package in self.Packages:
+            GuidDict.update(Package.Guids)
+        return GuidDict
     ## Retrieve PCD for given type
     def _GetPcd(self, Type):
         Pcds = OrderedDict()
@@ -877,7 +899,6 @@ class InfBuildData(ModuleBuildClassObject):
             self._PcdComments[TokenSpaceGuid, PcdCName] = Comments
 
         # resolve PCD type, value, datum info, etc. by getting its definition from package
-        _GuidDict = self.Guids.copy()
         for PcdCName, TokenSpaceGuid in PcdList:
             PcdRealName = PcdCName
             Setting, LineNo = PcdDict[self._Arch, self.Platform, PcdCName, TokenSpaceGuid]
@@ -895,7 +916,7 @@ class InfBuildData(ModuleBuildClassObject):
                     '',
                     {},
                     False,
-                    self.Guids[TokenSpaceGuid]
+                    self.GetGuidDict()[TokenSpaceGuid]
                     )
             if Type == MODEL_PCD_PATCHABLE_IN_MODULE and ValueList[1]:
                 # Patch PCD: TokenSpace.PcdCName|Value|Offset
@@ -931,7 +952,6 @@ class InfBuildData(ModuleBuildClassObject):
                 #
                 #   TAB_PCDS_FIXED_AT_BUILD, TAB_PCDS_PATCHABLE_IN_MODULE, TAB_PCDS_FEATURE_FLAG, TAB_PCDS_DYNAMIC, TAB_PCDS_DYNAMIC_EX
                 #
-                _GuidDict.update(Package.Guids)
                 PcdType = self._PCD_TYPE_STRING_[Type]
                 if Type == MODEL_PCD_DYNAMIC:
                     Pcd.Pending = True
@@ -1023,7 +1043,7 @@ class InfBuildData(ModuleBuildClassObject):
                         Pcd.DefaultValue = PcdInPackage.DefaultValue
                     else:
                         try:
-                            Pcd.DefaultValue = ValueExpressionEx(Pcd.DefaultValue, Pcd.DatumType, _GuidDict)(True)
+                            Pcd.DefaultValue = ValueExpressionEx(Pcd.DefaultValue, Pcd.DatumType, self.GetGuidDict())(True)
                         except BadExpression as Value:
                             EdkLogger.error('Parser', FORMAT_INVALID, 'PCD [%s.%s] Value "%s", %s' %(TokenSpaceGuid, PcdRealName, Pcd.DefaultValue, Value),
                                             File=self.MetaFile, Line=LineNo)
@@ -1046,6 +1066,43 @@ class InfBuildData(ModuleBuildClassObject):
         if (self.Binaries and not self.Sources) or GlobalData.gIgnoreSource:
             return True
         return False
+    def CheckFeatureFlagPcd(self,Instance):
+        Pcds = {}
+        if GlobalData.gPlatformFinalPcds.get(self.Arch):
+            Pcds = GlobalData.gPlatformFinalPcds[self.Arch].copy()
+        if PcdPattern.search(Instance):
+            PcdTuple = tuple(Instance.split('.')[::-1])
+            if PcdTuple in self.Pcds:
+                if not (self.Pcds[PcdTuple].Type == 'FeatureFlag' or self.Pcds[PcdTuple].Type == 'FixedAtBuild') and Instance not in Pcds:
+                    EdkLogger.error('build', FORMAT_INVALID,
+                                    "\nit must be defined in a [PcdsFeatureFlag] or [PcdsFixedAtBuild] section of Dsc or Dec file or [FeaturePcd] or [FixedPcd] of Inf file",
+                                    File=str(self), ExtraData=Instance)
+                Pcds[Instance] = self.Pcds[PcdTuple].DefaultValue
+            if Instance in Pcds:
+                if Pcds[Instance] == '0':
+                    return False
+                elif Pcds[Instance] == '1':
+                    return True
+            try:
+                Value = ValueExpression(Instance, Pcds)()
+                if Value == True:
+                    return True
+                return False
+            except:
+                EdkLogger.warn('build', FORMAT_INVALID,"The FeatureFlagExpression cannot be evaluated", File=str(self), ExtraData=Instance)
+                return False
+        else:
+            for Name, Guid in self.Pcds:
+                if self.Pcds[(Name, Guid)].Type == 'FeatureFlag' or self.Pcds[(Name, Guid)].Type == 'FixedAtBuild':
+                    Pcds['%s.%s' % (Guid, Name)] = self.Pcds[(Name, Guid)].DefaultValue
+            try:
+                Value = ValueExpression(Instance, Pcds)()
+                if Value == True:
+                    return True
+                return False
+            except:
+                EdkLogger.warn('build', FORMAT_INVALID, "The FeatureFlagExpression cannot be evaluated", File=str(self), ExtraData=Instance)
+                return False
 def ExtendCopyDictionaryLists(CopyToDict, CopyFromDict):
     for Key in CopyFromDict:
         CopyToDict[Key].extend(CopyFromDict[Key])
diff --git a/BaseTools/Source/Python/Workspace/WorkspaceCommon.py b/BaseTools/Source/Python/Workspace/WorkspaceCommon.py
index 53027a0e30f5..03e31bacfb51 100644
--- a/BaseTools/Source/Python/Workspace/WorkspaceCommon.py
+++ b/BaseTools/Source/Python/Workspace/WorkspaceCommon.py
@@ -42,8 +42,9 @@ def GetPackageList(Platform, BuildDatabase, Arch, Target, Toolchain):
     for ModuleFile in Platform.Modules:
         Data = BuildDatabase[ModuleFile, Arch, Target, Toolchain]
         PkgSet.update(Data.Packages)
-        for Lib in GetLiabraryInstances(Data, Platform, BuildDatabase, Arch, Target, Toolchain):
-            PkgSet.update(Lib.Packages)
+    for ModuleFile in Platform.LibraryInstances:
+        Data = BuildDatabase[ModuleFile, Arch, Target, Toolchain]
+        PkgSet.update(Data.Packages)
     return list(PkgSet)
 
 ## Get all declared PCD from platform for specified arch, target and toolchain
@@ -75,6 +76,11 @@ def GetDeclaredPcd(Platform, BuildDatabase, Arch, Target, Toolchain, additionalP
                         break
             if (PcdCName, PcdTokenName) not in DecPcds:
                 DecPcds[PcdCName, PcdTokenName] = Pkg.Pcds[Pcd]
+    if not GlobalData.gPlatformFinalPcds.get(Arch):
+        GlobalData.gPlatformFinalPcds[Arch] = OrderedDict()
+    for Name,Guid in DecPcds:
+        if DecPcds[Name,Guid].Type == 'FeatureFlag' or DecPcds[Name,Guid].Type == 'FixedAtBuild':
+            GlobalData.gPlatformFinalPcds[Arch]['%s.%s'%(Guid,Name)]=DecPcds[Name,Guid].DefaultValue
     return DecPcds, GuidDict
 
 ## Get all dependent libraries for a module
-- 
2.33.0.windows.2


  reply	other threads:[~2022-03-08 13:42 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-03-08 13:42 [PATCH V2 0/2] BaseTools:Add the FeatureFlagExpression usage to the InfBuildData yi1 li
2022-03-08 13:42 ` yi1 li [this message]
2022-03-08 13:42 ` [PATCH V2 2/2] BaseTools:Add the FeatureFlagExpression usage to the Source Section yi1 li
2022-03-08 13:44   ` yi1 li

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-list from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=7420ff3ad3ee0fad8c588d8031602a992a9d0d73.1646746598.git.yi1.li@intel.com \
    --to=devel@edk2.groups.io \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox