]> git.proxmox.com Git - mirror_edk2.git/blobdiff - BaseTools/Source/Python/Workspace/DecBuildData.py
BaseTools: Various typo
[mirror_edk2.git] / BaseTools / Source / Python / Workspace / DecBuildData.py
index 01f716bfab70da6c94f87946e2dfb9e5b03a08fa..149c057b7023049eb2ab74f0dabbdf8f5e84c5ee 100644 (file)
@@ -1,7 +1,7 @@
 ## @file\r
 # This file is used to create a database used by build tool\r
 #\r
-# Copyright (c) 2008 - 2017, Intel Corporation. All rights reserved.<BR>\r
+# Copyright (c) 2008 - 2018, Intel Corporation. All rights reserved.<BR>\r
 # (C) Copyright 2016 Hewlett Packard Enterprise Development LP<BR>\r
 # This program and the accompanying materials\r
 # are licensed and made available under the terms and conditions of the BSD License\r
 # THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
 # WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
 #\r
-from Common.String import *\r
+from Common.StringUtils import *\r
 from Common.DataType import *\r
 from Common.Misc import *\r
 from types import *\r
-\r
+from collections import OrderedDict\r
+from CommonDataClass.DataClass import *\r
 from Workspace.BuildClassObject import PackageBuildClassObject, StructurePcd, PcdClassObject\r
+from Common.GlobalData import gGlobalDefines\r
+from re import compile\r
 \r
 ## Platform build information from DEC file\r
 #\r
@@ -26,17 +29,17 @@ from Workspace.BuildClassObject import PackageBuildClassObject, StructurePcd, Pc
 class DecBuildData(PackageBuildClassObject):\r
     # dict used to convert PCD type in database to string used by build tool\r
     _PCD_TYPE_STRING_ = {\r
-        MODEL_PCD_FIXED_AT_BUILD        :   "FixedAtBuild",\r
-        MODEL_PCD_PATCHABLE_IN_MODULE   :   "PatchableInModule",\r
-        MODEL_PCD_FEATURE_FLAG          :   "FeatureFlag",\r
-        MODEL_PCD_DYNAMIC               :   "Dynamic",\r
-        MODEL_PCD_DYNAMIC_DEFAULT       :   "Dynamic",\r
-        MODEL_PCD_DYNAMIC_HII           :   "DynamicHii",\r
-        MODEL_PCD_DYNAMIC_VPD           :   "DynamicVpd",\r
-        MODEL_PCD_DYNAMIC_EX            :   "DynamicEx",\r
-        MODEL_PCD_DYNAMIC_EX_DEFAULT    :   "DynamicEx",\r
-        MODEL_PCD_DYNAMIC_EX_HII        :   "DynamicExHii",\r
-        MODEL_PCD_DYNAMIC_EX_VPD        :   "DynamicExVpd",\r
+        MODEL_PCD_FIXED_AT_BUILD        :   TAB_PCDS_FIXED_AT_BUILD,\r
+        MODEL_PCD_PATCHABLE_IN_MODULE   :   TAB_PCDS_PATCHABLE_IN_MODULE,\r
+        MODEL_PCD_FEATURE_FLAG          :   TAB_PCDS_FEATURE_FLAG,\r
+        MODEL_PCD_DYNAMIC               :   TAB_PCDS_DYNAMIC,\r
+        MODEL_PCD_DYNAMIC_DEFAULT       :   TAB_PCDS_DYNAMIC,\r
+        MODEL_PCD_DYNAMIC_HII           :   TAB_PCDS_DYNAMIC_HII,\r
+        MODEL_PCD_DYNAMIC_VPD           :   TAB_PCDS_DYNAMIC_VPD,\r
+        MODEL_PCD_DYNAMIC_EX            :   TAB_PCDS_DYNAMIC_EX,\r
+        MODEL_PCD_DYNAMIC_EX_DEFAULT    :   TAB_PCDS_DYNAMIC_EX,\r
+        MODEL_PCD_DYNAMIC_EX_HII        :   TAB_PCDS_DYNAMIC_EX_HII,\r
+        MODEL_PCD_DYNAMIC_EX_VPD        :   TAB_PCDS_DYNAMIC_EX_VPD,\r
     }\r
 \r
     # dict used to convert part of [Defines] to members of DecBuildData directly\r
@@ -62,7 +65,7 @@ class DecBuildData(PackageBuildClassObject):
     #   @param      Platform        (not used for DecBuildData)\r
     #   @param      Macros          Macros used for replacement in DSC file\r
     #\r
-    def __init__(self, File, RawData, BuildDataBase, Arch='COMMON', Target=None, Toolchain=None):\r
+    def __init__(self, File, RawData, BuildDataBase, Arch=TAB_ARCH_COMMON, Target=None, Toolchain=None):\r
         self.MetaFile = File\r
         self._PackageDir = File.Dir\r
         self._RawData = RawData\r
@@ -95,43 +98,30 @@ class DecBuildData(PackageBuildClassObject):
         self._Ppis              = None\r
         self._Guids             = None\r
         self._Includes          = None\r
+        self._CommonIncludes    = None\r
         self._LibraryClasses    = None\r
         self._Pcds              = None\r
-        self.__Macros           = None\r
+        self._MacroDict         = None\r
         self._PrivateProtocols  = None\r
         self._PrivatePpis       = None\r
         self._PrivateGuids      = None\r
         self._PrivateIncludes   = None\r
 \r
     ## Get current effective macros\r
-    def _GetMacros(self):\r
-        if self.__Macros == None:\r
-            self.__Macros = {}\r
-            self.__Macros.update(GlobalData.gGlobalDefines)\r
-        return self.__Macros\r
+    @property\r
+    def _Macros(self):\r
+        if self._MacroDict is None:\r
+            self._MacroDict = dict(gGlobalDefines)\r
+        return self._MacroDict\r
 \r
     ## Get architecture\r
-    def _GetArch(self):\r
+    @property\r
+    def Arch(self):\r
         return self._Arch\r
 \r
-    ## Set architecture\r
-    #\r
-    #   Changing the default ARCH to another may affect all other information\r
-    # because all information in a platform may be ARCH-related. That's\r
-    # why we need to clear all internal used members, in order to cause all\r
-    # information to be re-retrieved.\r
-    #\r
-    #   @param  Value   The value of ARCH\r
-    #\r
-    def _SetArch(self, Value):\r
-        if self._Arch == Value:\r
-            return\r
-        self._Arch = Value\r
-        self._Clear()\r
-\r
     ## Retrieve all information in [Defines] section\r
     #\r
-    #   (Retriving all [Defines] information in one-shot is just to save time.)\r
+    #   (Retrieving all [Defines] information in one-shot is just to save time.)\r
     #\r
     def _GetHeaderInfo(self):\r
         RecordList = self._RawData[MODEL_META_DATA_HEADER, self._Arch]\r
@@ -142,38 +132,42 @@ class DecBuildData(PackageBuildClassObject):
         self._Header = 'DUMMY'\r
 \r
     ## Retrieve package name\r
-    def _GetPackageName(self):\r
-        if self._PackageName == None:\r
-            if self._Header == None:\r
+    @property\r
+    def PackageName(self):\r
+        if self._PackageName is None:\r
+            if self._Header is None:\r
                 self._GetHeaderInfo()\r
-            if self._PackageName == None:\r
+            if self._PackageName is None:\r
                 EdkLogger.error("build", ATTRIBUTE_NOT_AVAILABLE, "No PACKAGE_NAME", File=self.MetaFile)\r
         return self._PackageName\r
 \r
     ## Retrieve file guid\r
-    def _GetFileGuid(self):\r
-        if self._Guid == None:\r
-            if self._Header == None:\r
+    @property\r
+    def PackageName(self):\r
+        if self._Guid is None:\r
+            if self._Header is None:\r
                 self._GetHeaderInfo()\r
-            if self._Guid == None:\r
+            if self._Guid is None:\r
                 EdkLogger.error("build", ATTRIBUTE_NOT_AVAILABLE, "No PACKAGE_GUID", File=self.MetaFile)\r
         return self._Guid\r
 \r
     ## Retrieve package version\r
-    def _GetVersion(self):\r
-        if self._Version == None:\r
-            if self._Header == None:\r
+    @property\r
+    def Version(self):\r
+        if self._Version is None:\r
+            if self._Header is None:\r
                 self._GetHeaderInfo()\r
-            if self._Version == None:\r
+            if self._Version is None:\r
                 self._Version = ''\r
         return self._Version\r
 \r
     ## Retrieve protocol definitions (name/value pairs)\r
-    def _GetProtocol(self):\r
-        if self._Protocols == None:\r
+    @property\r
+    def Protocols(self):\r
+        if self._Protocols is None:\r
             #\r
             # tdict is a special kind of dict, used for selecting correct\r
-            # protocol defition for given ARCH\r
+            # protocol definition for given ARCH\r
             #\r
             ProtocolDict = tdict(True)\r
             PrivateProtocolDict = tdict(True)\r
@@ -197,9 +191,9 @@ class DecBuildData(PackageBuildClassObject):
                 if Name not in NameList:\r
                     NameList.append(Name)\r
                 ProtocolDict[Arch, Name] = Guid\r
-            # use sdict to keep the order\r
-            self._Protocols = sdict()\r
-            self._PrivateProtocols = sdict()\r
+            # use OrderedDict to keep the order\r
+            self._Protocols = OrderedDict()\r
+            self._PrivateProtocols = OrderedDict()\r
             for Name in NameList:\r
                 #\r
                 # limit the ARCH to self._Arch, if no self._Arch found, tdict\r
@@ -211,11 +205,12 @@ class DecBuildData(PackageBuildClassObject):
         return self._Protocols\r
 \r
     ## Retrieve PPI definitions (name/value pairs)\r
-    def _GetPpi(self):\r
-        if self._Ppis == None:\r
+    @property\r
+    def Ppis(self):\r
+        if self._Ppis is None:\r
             #\r
             # tdict is a special kind of dict, used for selecting correct\r
-            # PPI defition for given ARCH\r
+            # PPI definition for given ARCH\r
             #\r
             PpiDict = tdict(True)\r
             PrivatePpiDict = tdict(True)\r
@@ -239,9 +234,9 @@ class DecBuildData(PackageBuildClassObject):
                 if Name not in NameList:\r
                     NameList.append(Name)\r
                 PpiDict[Arch, Name] = Guid\r
-            # use sdict to keep the order\r
-            self._Ppis = sdict()\r
-            self._PrivatePpis = sdict()\r
+            # use OrderedDict to keep the order\r
+            self._Ppis = OrderedDict()\r
+            self._PrivatePpis = OrderedDict()\r
             for Name in NameList:\r
                 #\r
                 # limit the ARCH to self._Arch, if no self._Arch found, tdict\r
@@ -253,11 +248,12 @@ class DecBuildData(PackageBuildClassObject):
         return self._Ppis\r
 \r
     ## Retrieve GUID definitions (name/value pairs)\r
-    def _GetGuid(self):\r
-        if self._Guids == None:\r
+    @property\r
+    def Guids(self):\r
+        if self._Guids is None:\r
             #\r
             # tdict is a special kind of dict, used for selecting correct\r
-            # GUID defition for given ARCH\r
+            # GUID definition for given ARCH\r
             #\r
             GuidDict = tdict(True)\r
             PrivateGuidDict = tdict(True)\r
@@ -281,9 +277,9 @@ class DecBuildData(PackageBuildClassObject):
                 if Name not in NameList:\r
                     NameList.append(Name)\r
                 GuidDict[Arch, Name] = Guid\r
-            # use sdict to keep the order\r
-            self._Guids = sdict()\r
-            self._PrivateGuids = sdict()\r
+            # use OrderedDict to keep the order\r
+            self._Guids = OrderedDict()\r
+            self._PrivateGuids = OrderedDict()\r
             for Name in NameList:\r
                 #\r
                 # limit the ARCH to self._Arch, if no self._Arch found, tdict\r
@@ -295,14 +291,15 @@ class DecBuildData(PackageBuildClassObject):
         return self._Guids\r
 \r
     ## Retrieve public include paths declared in this package\r
-    def _GetInclude(self):\r
-        if self._Includes == None:\r
+    @property\r
+    def Includes(self):\r
+        if self._Includes is None or self._CommonIncludes is None:\r
+            self._CommonIncludes = []\r
             self._Includes = []\r
             self._PrivateIncludes = []\r
             PublicInclues = []\r
             RecordList = self._RawData[MODEL_EFI_INCLUDE, self._Arch]\r
             Macros = self._Macros\r
-            Macros["EDK_SOURCE"] = GlobalData.gEcpSource\r
             for Record in RecordList:\r
                 File = PathClass(NormPath(Record[0], Macros), self._PackageDir, Arch=self._Arch)\r
                 LineNo = Record[-1]\r
@@ -324,12 +321,14 @@ class DecBuildData(PackageBuildClassObject):
                         PublicInclues.append(File)\r
                     if File in self._PrivateIncludes:\r
                         EdkLogger.error('build', OPTION_CONFLICT, "Can't determine %s's attribute, it is both defined as Private and non-Private attribute in DEC file." % File, File=self.MetaFile, Line=LineNo)\r
-\r
+                if Record[3] == TAB_COMMON:\r
+                    self._CommonIncludes.append(File)\r
         return self._Includes\r
 \r
     ## Retrieve library class declarations (not used in build at present)\r
-    def _GetLibraryClass(self):\r
-        if self._LibraryClasses == None:\r
+    @property\r
+    def LibraryClasses(self):\r
+        if self._LibraryClasses is None:\r
             #\r
             # tdict is a special kind of dict, used for selecting correct\r
             # library class declaration for given ARCH\r
@@ -346,15 +345,16 @@ class DecBuildData(PackageBuildClassObject):
                     EdkLogger.error('build', ErrorCode, ExtraData=ErrorInfo, File=self.MetaFile, Line=LineNo)\r
                 LibraryClassSet.add(LibraryClass)\r
                 LibraryClassDict[Arch, LibraryClass] = File\r
-            self._LibraryClasses = sdict()\r
+            self._LibraryClasses = OrderedDict()\r
             for LibraryClass in LibraryClassSet:\r
                 self._LibraryClasses[LibraryClass] = LibraryClassDict[self._Arch, LibraryClass]\r
         return self._LibraryClasses\r
 \r
     ## Retrieve PCD declarations\r
-    def _GetPcds(self):\r
-        if self._Pcds == None:\r
-            self._Pcds = sdict()\r
+    @property\r
+    def Pcds(self):\r
+        if self._Pcds is None:\r
+            self._Pcds = OrderedDict()\r
             self._Pcds.update(self._GetPcd(MODEL_PCD_FIXED_AT_BUILD))\r
             self._Pcds.update(self._GetPcd(MODEL_PCD_PATCHABLE_IN_MODULE))\r
             self._Pcds.update(self._GetPcd(MODEL_PCD_FEATURE_FLAG))\r
@@ -362,39 +362,57 @@ class DecBuildData(PackageBuildClassObject):
             self._Pcds.update(self._GetPcd(MODEL_PCD_DYNAMIC_EX))\r
         return self._Pcds\r
 \r
+    def ParsePcdName(self,TokenCName):\r
+        TokenCName = TokenCName.strip()\r
+        if TokenCName.startswith("["):\r
+            if "." in TokenCName:\r
+                Demesionattr = TokenCName[:TokenCName.index(".")]\r
+                Fields = TokenCName[TokenCName.index(".")+1:]\r
+            else:\r
+                Demesionattr = TokenCName\r
+                Fields = ""\r
+        else:\r
+            Demesionattr = ""\r
+            Fields = TokenCName\r
+\r
+        return Demesionattr,Fields\r
 \r
     def ProcessStructurePcd(self, StructurePcdRawDataSet):\r
-        s_pcd_set = dict()\r
-        for s_pcd,LineNo in StructurePcdRawDataSet:\r
+        s_pcd_set = OrderedDict()\r
+        for s_pcd, LineNo in StructurePcdRawDataSet:\r
             if s_pcd.TokenSpaceGuidCName not in s_pcd_set:\r
                 s_pcd_set[s_pcd.TokenSpaceGuidCName] = []\r
-            s_pcd_set[s_pcd.TokenSpaceGuidCName].append((s_pcd,LineNo))\r
+            s_pcd_set[s_pcd.TokenSpaceGuidCName].append((s_pcd, LineNo))\r
 \r
         str_pcd_set = []\r
         for pcdname in s_pcd_set:\r
             dep_pkgs = []\r
             struct_pcd = StructurePcd()\r
-            for item,LineNo in s_pcd_set[pcdname]:\r
+            for item, LineNo in s_pcd_set[pcdname]:\r
+                if not item.TokenCName:\r
+                    continue\r
                 if "<HeaderFiles>" in item.TokenCName:\r
-                    struct_pcd.StructuredPcdIncludeFile = item.DefaultValue\r
+                    struct_pcd.StructuredPcdIncludeFile.append(item.DefaultValue)\r
                 elif "<Packages>" in item.TokenCName:\r
                     dep_pkgs.append(item.DefaultValue)\r
                 elif item.DatumType == item.TokenCName:\r
                     struct_pcd.copy(item)\r
                     struct_pcd.TokenValue = struct_pcd.TokenValue.strip("{").strip()\r
                     struct_pcd.TokenSpaceGuidCName, struct_pcd.TokenCName = pcdname.split(".")\r
+                    struct_pcd.PcdDefineLineNo = LineNo\r
+                    struct_pcd.PkgPath = self.MetaFile.File\r
+                    struct_pcd.SetDecDefaultValue(item.DefaultValue)\r
                 else:\r
-                    struct_pcd.AddDefaultValue(item.TokenCName, item.DefaultValue,self.MetaFile.File,LineNo)\r
+                    DemesionAttr, Fields = self.ParsePcdName(item.TokenCName)\r
+                    struct_pcd.AddDefaultValue(Fields, item.DefaultValue, self.MetaFile.File, LineNo,DemesionAttr)\r
 \r
             struct_pcd.PackageDecs = dep_pkgs\r
-\r
             str_pcd_set.append(struct_pcd)\r
-\r
         return str_pcd_set\r
 \r
     ## Retrieve PCD declarations for given type\r
     def _GetPcd(self, Type):\r
-        Pcds = sdict()\r
+        Pcds = OrderedDict()\r
         #\r
         # tdict is a special kind of dict, used for selecting correct\r
         # PCD declaration for given ARCH\r
@@ -407,17 +425,18 @@ class DecBuildData(PackageBuildClassObject):
         StrPcdSet = []\r
         RecordList = self._RawData[Type, self._Arch]\r
         for TokenSpaceGuid, PcdCName, Setting, Arch, PrivateFlag, Dummy1, Dummy2 in RecordList:\r
-            PcdDict[Arch, PcdCName, TokenSpaceGuid] = (Setting,Dummy2)\r
+            PcdDict[Arch, PcdCName, TokenSpaceGuid] = (Setting, Dummy2)\r
             if not (PcdCName, TokenSpaceGuid) in PcdSet:\r
                 PcdSet.append((PcdCName, TokenSpaceGuid))\r
 \r
+        DefinitionPosition = {}\r
         for PcdCName, TokenSpaceGuid in PcdSet:\r
             #\r
             # limit the ARCH to self._Arch, if no self._Arch found, tdict\r
             # will automatically turn to 'common' ARCH and try again\r
             #\r
-            Setting,LineNo = PcdDict[self._Arch, PcdCName, TokenSpaceGuid]\r
-            if Setting == None:\r
+            Setting, LineNo = PcdDict[self._Arch, PcdCName, TokenSpaceGuid]\r
+            if Setting is None:\r
                 continue\r
 \r
             DefaultValue, DatumType, TokenNumber = AnalyzePcdData(Setting)\r
@@ -437,27 +456,26 @@ class DecBuildData(PackageBuildClassObject):
                                         list(validlists),\r
                                         list(expressions)\r
                                         )\r
+            DefinitionPosition[PcdObj] = (self.MetaFile.File, LineNo)\r
             if "." in TokenSpaceGuid:\r
-                StrPcdSet.append((PcdObj,LineNo))\r
+                StrPcdSet.append((PcdObj, LineNo))\r
             else:\r
                 Pcds[PcdCName, TokenSpaceGuid, self._PCD_TYPE_STRING_[Type]] = PcdObj\r
 \r
         StructurePcds = self.ProcessStructurePcd(StrPcdSet)\r
         for pcd in StructurePcds:\r
             Pcds[pcd.TokenCName, pcd.TokenSpaceGuidCName, self._PCD_TYPE_STRING_[Type]] = pcd\r
-\r
+        StructPattern = compile(r'[_a-zA-Z][0-9A-Za-z_]*$')\r
+        for pcd in Pcds.values():\r
+            if pcd.DatumType not in [TAB_UINT8, TAB_UINT16, TAB_UINT32, TAB_UINT64, TAB_VOID, "BOOLEAN"]:\r
+                if not pcd.IsAggregateDatumType():\r
+                    EdkLogger.error('build', FORMAT_INVALID, "DatumType only support BOOLEAN, UINT8, UINT16, UINT32, UINT64, VOID* or a valid struct name.", DefinitionPosition[pcd][0], DefinitionPosition[pcd][1])\r
+                elif not pcd.IsArray() and not pcd.StructuredPcdIncludeFile:\r
+                    EdkLogger.error("build", PCD_STRUCTURE_PCD_ERROR, "The structure Pcd %s.%s header file is not found in %s line %s \n" % (pcd.TokenSpaceGuidCName, pcd.TokenCName, pcd.DefinitionPosition[0], pcd.DefinitionPosition[1] ))\r
         return Pcds\r
 \r
-\r
-    _Macros = property(_GetMacros)\r
-    Arch = property(_GetArch, _SetArch)\r
-    PackageName = property(_GetPackageName)\r
-    Guid = property(_GetFileGuid)\r
-    Version = property(_GetVersion)\r
-\r
-    Protocols = property(_GetProtocol)\r
-    Ppis = property(_GetPpi)\r
-    Guids = property(_GetGuid)\r
-    Includes = property(_GetInclude)\r
-    LibraryClasses = property(_GetLibraryClass)\r
-    Pcds = property(_GetPcds)\r
+    @property\r
+    def CommonIncludes(self):\r
+        if self._CommonIncludes is None:\r
+            self.Includes\r
+        return self._CommonIncludes\r