-from CommonDataClass.CommonClass import SkuInfoClass\r
-\r
-from MetaDataTable import *\r
-from MetaFileTable import *\r
-from MetaFileParser import *\r
-from BuildClassObject import *\r
-\r
-## Platform build information from DSC file\r
-#\r
-# This class is used to retrieve information stored in database and convert them\r
-# into PlatformBuildClassObject form for easier use for AutoGen.\r
-#\r
-class DscBuildData(PlatformBuildClassObject):\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
- }\r
-\r
- # dict used to convert part of [Defines] to members of DscBuildData directly\r
- _PROPERTY_ = {\r
- #\r
- # Required Fields\r
- #\r
- TAB_DSC_DEFINES_PLATFORM_NAME : "_PlatformName",\r
- TAB_DSC_DEFINES_PLATFORM_GUID : "_Guid",\r
- TAB_DSC_DEFINES_PLATFORM_VERSION : "_Version",\r
- TAB_DSC_DEFINES_DSC_SPECIFICATION : "_DscSpecification",\r
- #TAB_DSC_DEFINES_OUTPUT_DIRECTORY : "_OutputDirectory",\r
- #TAB_DSC_DEFINES_SUPPORTED_ARCHITECTURES : "_SupArchList",\r
- #TAB_DSC_DEFINES_BUILD_TARGETS : "_BuildTargets",\r
- #TAB_DSC_DEFINES_SKUID_IDENTIFIER : "_SkuName",\r
- #TAB_DSC_DEFINES_FLASH_DEFINITION : "_FlashDefinition",\r
- TAB_DSC_DEFINES_BUILD_NUMBER : "_BuildNumber",\r
- TAB_DSC_DEFINES_MAKEFILE_NAME : "_MakefileName",\r
- TAB_DSC_DEFINES_BS_BASE_ADDRESS : "_BsBaseAddress",\r
- TAB_DSC_DEFINES_RT_BASE_ADDRESS : "_RtBaseAddress",\r
- }\r
-\r
- # used to compose dummy library class name for those forced library instances\r
- _NullLibraryNumber = 0\r
-\r
- ## Constructor of DscBuildData\r
- #\r
- # Initialize object of DscBuildData\r
- #\r
- # @param FilePath The path of platform description file\r
- # @param RawData The raw data of DSC file\r
- # @param BuildDataBase Database used to retrieve module/package information\r
- # @param Arch The target architecture\r
- # @param Platform (not used for DscBuildData)\r
- # @param Macros Macros used for replacement in DSC file\r
- #\r
- def __init__(self, FilePath, RawData, BuildDataBase, Arch='COMMON', Platform='DUMMY', Macros={}):\r
- self.MetaFile = FilePath\r
- self._RawData = RawData\r
- self._Bdb = BuildDataBase\r
- self._Arch = Arch\r
- self._Macros = Macros\r
- self._Clear()\r
- RecordList = self._RawData[MODEL_META_DATA_DEFINE, self._Arch]\r
- for Record in RecordList:\r
- GlobalData.gEdkGlobal[Record[0]] = Record[1]\r
-\r
- ## XXX[key] = value\r
- def __setitem__(self, key, value):\r
- self.__dict__[self._PROPERTY_[key]] = value\r
-\r
- ## value = XXX[key]\r
- def __getitem__(self, key):\r
- return self.__dict__[self._PROPERTY_[key]]\r
-\r
- ## "in" test support\r
- def __contains__(self, key):\r
- return key in self._PROPERTY_\r
-\r
- ## Set all internal used members of DscBuildData to None\r
- def _Clear(self):\r
- self._Header = None\r
- self._PlatformName = None\r
- self._Guid = None\r
- self._Version = None\r
- self._DscSpecification = None\r
- self._OutputDirectory = None\r
- self._SupArchList = None\r
- self._BuildTargets = None\r
- self._SkuName = None\r
- self._FlashDefinition = None\r
- self._BuildNumber = None\r
- self._MakefileName = None\r
- self._BsBaseAddress = None\r
- self._RtBaseAddress = None\r
- self._SkuIds = None\r
- self._Modules = None\r
- self._LibraryInstances = None\r
- self._LibraryClasses = None\r
- self._Pcds = None\r
- self._BuildOptions = None\r
- self._LoadFixAddress = None\r
-\r
- ## Get architecture\r
- def _GetArch(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
- #\r
- def _GetHeaderInfo(self):\r
- RecordList = self._RawData[MODEL_META_DATA_HEADER, self._Arch]\r
- for Record in RecordList:\r
- Name = Record[0]\r
- # items defined _PROPERTY_ don't need additional processing\r
- if Name in self:\r
- self[Name] = Record[1]\r
- # some special items in [Defines] section need special treatment\r
- elif Name == TAB_DSC_DEFINES_OUTPUT_DIRECTORY:\r
- self._OutputDirectory = NormPath(Record[1], self._Macros)\r
- if ' ' in self._OutputDirectory:\r
- EdkLogger.error("build", FORMAT_NOT_SUPPORTED, "No space is allowed in OUTPUT_DIRECTORY",\r
- File=self.MetaFile, Line=Record[-1],\r
- ExtraData=self._OutputDirectory)\r
- elif Name == TAB_DSC_DEFINES_FLASH_DEFINITION:\r
- self._FlashDefinition = PathClass(NormPath(Record[1], self._Macros), GlobalData.gWorkspace)\r
- ErrorCode, ErrorInfo = self._FlashDefinition.Validate('.fdf')\r
- if ErrorCode != 0:\r
- EdkLogger.error('build', ErrorCode, File=self.MetaFile, Line=Record[-1],\r
- ExtraData=ErrorInfo)\r
- elif Name == TAB_DSC_DEFINES_SUPPORTED_ARCHITECTURES:\r
- self._SupArchList = GetSplitValueList(Record[1], TAB_VALUE_SPLIT)\r
- elif Name == TAB_DSC_DEFINES_BUILD_TARGETS:\r
- self._BuildTargets = GetSplitValueList(Record[1])\r
- elif Name == TAB_DSC_DEFINES_SKUID_IDENTIFIER:\r
- if self._SkuName == None:\r
- self._SkuName = Record[1]\r
- elif Name == TAB_FIX_LOAD_TOP_MEMORY_ADDRESS:\r
- self._LoadFixAddress = Record[1]\r
- # set _Header to non-None in order to avoid database re-querying\r
- self._Header = 'DUMMY'\r
-\r
- ## Retrieve platform name\r
- def _GetPlatformName(self):\r
- if self._PlatformName == None:\r
- if self._Header == None:\r
- self._GetHeaderInfo()\r
- if self._PlatformName == None:\r
- EdkLogger.error('build', ATTRIBUTE_NOT_AVAILABLE, "No PLATFORM_NAME", File=self.MetaFile)\r
- return self._PlatformName\r
-\r
- ## Retrieve file guid\r
- def _GetFileGuid(self):\r
- if self._Guid == None:\r
- if self._Header == None:\r
- self._GetHeaderInfo()\r
- if self._Guid == None:\r
- EdkLogger.error('build', ATTRIBUTE_NOT_AVAILABLE, "No FILE_GUID", File=self.MetaFile)\r
- return self._Guid\r
-\r
- ## Retrieve platform version\r
- def _GetVersion(self):\r
- if self._Version == None:\r
- if self._Header == None:\r
- self._GetHeaderInfo()\r
- if self._Version == None:\r
- self._Version = ''\r
- return self._Version\r
-\r
- ## Retrieve platform description file version\r
- def _GetDscSpec(self):\r
- if self._DscSpecification == None:\r
- if self._Header == None:\r
- self._GetHeaderInfo()\r
- if self._DscSpecification == None:\r
- self._DscSpecification = ''\r
- return self._DscSpecification\r
-\r
- ## Retrieve OUTPUT_DIRECTORY\r
- def _GetOutpuDir(self):\r
- if self._OutputDirectory == None:\r
- if self._Header == None:\r
- self._GetHeaderInfo()\r
- if self._OutputDirectory == None:\r
- self._OutputDirectory = os.path.join("Build", self._PlatformName)\r
- return self._OutputDirectory\r
-\r
- ## Retrieve SUPPORTED_ARCHITECTURES\r
- def _GetSupArch(self):\r
- if self._SupArchList == None:\r
- if self._Header == None:\r
- self._GetHeaderInfo()\r
- if self._SupArchList == None:\r
- self._SupArchList = ARCH_LIST\r
- return self._SupArchList\r
-\r
- ## Retrieve BUILD_TARGETS\r
- def _GetBuildTarget(self):\r
- if self._BuildTargets == None:\r
- if self._Header == None:\r
- self._GetHeaderInfo()\r
- if self._BuildTargets == None:\r
- self._BuildTargets = ['DEBUG', 'RELEASE']\r
- return self._BuildTargets\r
-\r
- ## Retrieve SKUID_IDENTIFIER\r
- def _GetSkuName(self):\r
- if self._SkuName == None:\r
- if self._Header == None:\r
- self._GetHeaderInfo()\r
- if self._SkuName == None or self._SkuName not in self.SkuIds:\r
- self._SkuName = 'DEFAULT'\r
- return self._SkuName\r
-\r
- ## Override SKUID_IDENTIFIER\r
- def _SetSkuName(self, Value):\r
- if Value in self.SkuIds:\r
- self._SkuName = Value\r
-\r
- def _GetFdfFile(self):\r
- if self._FlashDefinition == None:\r
- if self._Header == None:\r
- self._GetHeaderInfo()\r
- if self._FlashDefinition == None:\r
- self._FlashDefinition = ''\r
- return self._FlashDefinition\r
-\r
- ## Retrieve FLASH_DEFINITION\r
- def _GetBuildNumber(self):\r
- if self._BuildNumber == None:\r
- if self._Header == None:\r
- self._GetHeaderInfo()\r
- if self._BuildNumber == None:\r
- self._BuildNumber = ''\r
- return self._BuildNumber\r
-\r
- ## Retrieve MAKEFILE_NAME\r
- def _GetMakefileName(self):\r
- if self._MakefileName == None:\r
- if self._Header == None:\r
- self._GetHeaderInfo()\r
- if self._MakefileName == None:\r
- self._MakefileName = ''\r
- return self._MakefileName\r
-\r
- ## Retrieve BsBaseAddress\r
- def _GetBsBaseAddress(self):\r
- if self._BsBaseAddress == None:\r
- if self._Header == None:\r
- self._GetHeaderInfo()\r
- if self._BsBaseAddress == None:\r
- self._BsBaseAddress = ''\r
- return self._BsBaseAddress\r
-\r
- ## Retrieve RtBaseAddress\r
- def _GetRtBaseAddress(self):\r
- if self._RtBaseAddress == None:\r
- if self._Header == None:\r
- self._GetHeaderInfo()\r
- if self._RtBaseAddress == None:\r
- self._RtBaseAddress = ''\r
- return self._RtBaseAddress\r
-\r
- ## Retrieve the top address for the load fix address\r
- def _GetLoadFixAddress(self):\r
- if self._LoadFixAddress == None:\r
- if self._Header == None:\r
- self._GetHeaderInfo()\r
- if self._LoadFixAddress == None:\r
- self._LoadFixAddress = ''\r
- return self._LoadFixAddress\r
-\r
- ## Retrieve [SkuIds] section information\r
- def _GetSkuIds(self):\r
- if self._SkuIds == None:\r
- self._SkuIds = {}\r
- RecordList = self._RawData[MODEL_EFI_SKU_ID]\r
- for Record in RecordList:\r
- if Record[0] in [None, '']:\r
- EdkLogger.error('build', FORMAT_INVALID, 'No Sku ID number',\r
- File=self.MetaFile, Line=Record[-1])\r
- if Record[1] in [None, '']:\r
- EdkLogger.error('build', FORMAT_INVALID, 'No Sku ID name',\r
- File=self.MetaFile, Line=Record[-1])\r
- self._SkuIds[Record[1]] = Record[0]\r
- if 'DEFAULT' not in self._SkuIds:\r
- self._SkuIds['DEFAULT'] = 0\r
- return self._SkuIds\r
-\r
- ## Retrieve [Components] section information\r
- def _GetModules(self):\r
- if self._Modules != None:\r
- return self._Modules\r
-\r
- self._Modules = sdict()\r
- RecordList = self._RawData[MODEL_META_DATA_COMPONENT, self._Arch]\r
- Macros = {"EDK_SOURCE":GlobalData.gEcpSource, "EFI_SOURCE":GlobalData.gEfiSource}\r
- Macros.update(self._Macros)\r
- for Record in RecordList:\r
- ModuleFile = PathClass(NormPath(Record[0], Macros), GlobalData.gWorkspace, Arch=self._Arch)\r
- ModuleId = Record[5]\r
- LineNo = Record[6]\r
-\r
- # check the file validation\r
- ErrorCode, ErrorInfo = ModuleFile.Validate('.inf')\r
- if ErrorCode != 0:\r
- EdkLogger.error('build', ErrorCode, File=self.MetaFile, Line=LineNo,\r
- ExtraData=ErrorInfo)\r
- # Check duplication\r
- if ModuleFile in self._Modules:\r
- EdkLogger.error('build', FILE_DUPLICATED, File=self.MetaFile, ExtraData=str(ModuleFile), Line=LineNo)\r
-\r
- Module = ModuleBuildClassObject()\r
- Module.MetaFile = ModuleFile\r
-\r
- # get module override path\r
- RecordList = self._RawData[MODEL_META_DATA_COMPONENT_SOURCE_OVERRIDE_PATH, self._Arch, None, ModuleId]\r
- if RecordList != []:\r
- Module.SourceOverridePath = os.path.join(GlobalData.gWorkspace, NormPath(RecordList[0][0], Macros))\r
-\r
- # Check if the source override path exists\r
- if not os.path.isdir(Module.SourceOverridePath):\r
- EdkLogger.error('build', FILE_NOT_FOUND, Message = 'Source override path does not exist:', File=self.MetaFile, ExtraData=Module.SourceOverridePath, Line=LineNo)\r
- \r
- #Add to GlobalData Variables\r
- GlobalData.gOverrideDir[ModuleFile.Key] = Module.SourceOverridePath\r
-\r
- # get module private library instance\r
- RecordList = self._RawData[MODEL_EFI_LIBRARY_CLASS, self._Arch, None, ModuleId]\r
- for Record in RecordList:\r
- LibraryClass = Record[0]\r
- LibraryPath = PathClass(NormPath(Record[1], Macros), GlobalData.gWorkspace, Arch=self._Arch)\r
- LineNo = Record[-1]\r
-\r
- # check the file validation\r
- ErrorCode, ErrorInfo = LibraryPath.Validate('.inf')\r
- if ErrorCode != 0:\r
- EdkLogger.error('build', ErrorCode, File=self.MetaFile, Line=LineNo,\r
- ExtraData=ErrorInfo)\r
-\r
- if LibraryClass == '' or LibraryClass == 'NULL':\r
- self._NullLibraryNumber += 1\r
- LibraryClass = 'NULL%d' % self._NullLibraryNumber\r
- EdkLogger.verbose("Found forced library for %s\n\t%s [%s]" % (ModuleFile, LibraryPath, LibraryClass))\r
- Module.LibraryClasses[LibraryClass] = LibraryPath\r
- if LibraryPath not in self.LibraryInstances:\r
- self.LibraryInstances.append(LibraryPath)\r
-\r
- # get module private PCD setting\r
- for Type in [MODEL_PCD_FIXED_AT_BUILD, MODEL_PCD_PATCHABLE_IN_MODULE, \\r
- MODEL_PCD_FEATURE_FLAG, MODEL_PCD_DYNAMIC, MODEL_PCD_DYNAMIC_EX]:\r
- RecordList = self._RawData[Type, self._Arch, None, ModuleId]\r
- for TokenSpaceGuid, PcdCName, Setting, Dummy1, Dummy2, Dummy3, Dummy4 in RecordList:\r
- TokenList = GetSplitValueList(Setting)\r
- DefaultValue = TokenList[0]\r
- if len(TokenList) > 1:\r
- MaxDatumSize = TokenList[1]\r
- else:\r
- MaxDatumSize = ''\r
- TypeString = self._PCD_TYPE_STRING_[Type]\r
- Pcd = PcdClassObject(\r
- PcdCName,\r
- TokenSpaceGuid,\r
- TypeString,\r
- '',\r
- DefaultValue,\r
- '',\r
- MaxDatumSize,\r
- {},\r
- None\r
- )\r
- Module.Pcds[PcdCName, TokenSpaceGuid] = Pcd\r
-\r
- # get module private build options\r
- RecordList = self._RawData[MODEL_META_DATA_BUILD_OPTION, self._Arch, None, ModuleId]\r
- for ToolChainFamily, ToolChain, Option, Dummy1, Dummy2, Dummy3, Dummy4 in RecordList:\r
- if (ToolChainFamily, ToolChain) not in Module.BuildOptions:\r
- Module.BuildOptions[ToolChainFamily, ToolChain] = Option\r
- else:\r
- OptionString = Module.BuildOptions[ToolChainFamily, ToolChain]\r
- Module.BuildOptions[ToolChainFamily, ToolChain] = OptionString + " " + Option\r
-\r
- self._Modules[ModuleFile] = Module\r
- return self._Modules\r
-\r
- ## Retrieve all possible library instances used in this platform\r
- def _GetLibraryInstances(self):\r
- if self._LibraryInstances == None:\r
- self._GetLibraryClasses()\r
- return self._LibraryInstances\r
-\r
- ## Retrieve [LibraryClasses] information\r
- def _GetLibraryClasses(self):\r
- if self._LibraryClasses == None:\r
- self._LibraryInstances = []\r
- #\r
- # tdict is a special dict kind of type, used for selecting correct\r
- # library instance for given library class and module type\r
- #\r
- LibraryClassDict = tdict(True, 3)\r
- # track all library class names\r
- LibraryClassSet = set()\r
- RecordList = self._RawData[MODEL_EFI_LIBRARY_CLASS, self._Arch]\r
- Macros = {"EDK_SOURCE":GlobalData.gEcpSource, "EFI_SOURCE":GlobalData.gEfiSource}\r
- Macros.update(self._Macros)\r
- for Record in RecordList:\r
- LibraryClass, LibraryInstance, Dummy, Arch, ModuleType, Dummy, LineNo = Record\r
- if LibraryClass == '' or LibraryClass == 'NULL':\r
- self._NullLibraryNumber += 1\r
- LibraryClass = 'NULL%d' % self._NullLibraryNumber\r
- EdkLogger.verbose("Found forced library for arch=%s\n\t%s [%s]" % (Arch, LibraryInstance, LibraryClass))\r
- LibraryClassSet.add(LibraryClass)\r
- LibraryInstance = PathClass(NormPath(LibraryInstance, Macros), GlobalData.gWorkspace, Arch=self._Arch)\r
- # check the file validation\r
- ErrorCode, ErrorInfo = LibraryInstance.Validate('.inf')\r
- if ErrorCode != 0:\r
- EdkLogger.error('build', ErrorCode, File=self.MetaFile, Line=LineNo,\r
- ExtraData=ErrorInfo)\r
-\r
- if ModuleType != 'COMMON' and ModuleType not in SUP_MODULE_LIST:\r
- EdkLogger.error('build', OPTION_UNKNOWN, "Unknown module type [%s]" % ModuleType,\r
- File=self.MetaFile, ExtraData=LibraryInstance, Line=LineNo)\r
- LibraryClassDict[Arch, ModuleType, LibraryClass] = LibraryInstance\r
- if LibraryInstance not in self._LibraryInstances:\r
- self._LibraryInstances.append(LibraryInstance)\r
-\r
- # resolve the specific library instance for each class and each module type\r
- self._LibraryClasses = tdict(True)\r
- for LibraryClass in LibraryClassSet:\r
- # try all possible module types\r
- for ModuleType in SUP_MODULE_LIST:\r
- LibraryInstance = LibraryClassDict[self._Arch, ModuleType, LibraryClass]\r
- if LibraryInstance == None:\r
- continue\r
- self._LibraryClasses[LibraryClass, ModuleType] = LibraryInstance\r
-\r
- # for R8 style library instances, which are listed in different section\r
- RecordList = self._RawData[MODEL_EFI_LIBRARY_INSTANCE, self._Arch]\r
- for Record in RecordList:\r
- File = PathClass(NormPath(Record[0], Macros), GlobalData.gWorkspace, Arch=self._Arch)\r
- LineNo = Record[-1]\r
- # check the file validation\r
- ErrorCode, ErrorInfo = File.Validate('.inf')\r
- if ErrorCode != 0:\r
- EdkLogger.error('build', ErrorCode, File=self.MetaFile, Line=LineNo,\r
- ExtraData=ErrorInfo)\r
- if File not in self._LibraryInstances:\r
- self._LibraryInstances.append(File)\r
- #\r
- # we need the module name as the library class name, so we have\r
- # to parse it here. (self._Bdb[] will trigger a file parse if it\r
- # hasn't been parsed)\r
- #\r
- Library = self._Bdb[File, self._Arch]\r
- self._LibraryClasses[Library.BaseName, ':dummy:'] = Library\r
- return self._LibraryClasses\r
-\r
- ## Retrieve all PCD settings in platform\r
- def _GetPcds(self):\r
- if self._Pcds == None:\r
- self._Pcds = {}\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
- self._Pcds.update(self._GetDynamicPcd(MODEL_PCD_DYNAMIC_DEFAULT))\r
- self._Pcds.update(self._GetDynamicHiiPcd(MODEL_PCD_DYNAMIC_HII))\r
- self._Pcds.update(self._GetDynamicVpdPcd(MODEL_PCD_DYNAMIC_VPD))\r
- self._Pcds.update(self._GetDynamicPcd(MODEL_PCD_DYNAMIC_EX_DEFAULT))\r
- self._Pcds.update(self._GetDynamicHiiPcd(MODEL_PCD_DYNAMIC_EX_HII))\r
- self._Pcds.update(self._GetDynamicVpdPcd(MODEL_PCD_DYNAMIC_EX_VPD))\r
- return self._Pcds\r
-\r
- ## Retrieve [BuildOptions]\r
- def _GetBuildOptions(self):\r
- if self._BuildOptions == None:\r
- self._BuildOptions = {}\r
- #\r
- # Retrieve build option for EDKII style module\r
- #\r
- RecordList = self._RawData[MODEL_META_DATA_BUILD_OPTION, 'COMMON', EDKII_NAME]\r
- for ToolChainFamily, ToolChain, Option, Dummy1, Dummy2, Dummy3, Dummy4 in RecordList:\r
- self._BuildOptions[ToolChainFamily, ToolChain, EDKII_NAME] = Option\r
- #\r
- # Retrieve build option for EDK style module\r
- #\r
- RecordList = self._RawData[MODEL_META_DATA_BUILD_OPTION, 'COMMON', EDK_NAME] \r
- for ToolChainFamily, ToolChain, Option, Dummy1, Dummy2, Dummy3, Dummy4 in RecordList:\r
- self._BuildOptions[ToolChainFamily, ToolChain, EDK_NAME] = Option\r
- return self._BuildOptions\r
-\r
- ## Retrieve non-dynamic PCD settings\r
- #\r
- # @param Type PCD type\r
- #\r
- # @retval a dict object contains settings of given PCD type\r
- #\r
- def _GetPcd(self, Type):\r
- Pcds = {}\r
- #\r
- # tdict is a special dict kind of type, used for selecting correct\r
- # PCD settings for certain ARCH\r
- #\r
- PcdDict = tdict(True, 3)\r
- PcdSet = set()\r
- # Find out all possible PCD candidates for self._Arch\r
- RecordList = self._RawData[Type, self._Arch]\r
- for TokenSpaceGuid, PcdCName, Setting, Arch, SkuName, Dummy3, Dummy4 in RecordList:\r
- PcdSet.add((PcdCName, TokenSpaceGuid))\r
- PcdDict[Arch, PcdCName, TokenSpaceGuid] = Setting\r
- # Remove redundant PCD candidates\r
- for PcdCName, TokenSpaceGuid in PcdSet:\r
- ValueList = ['', '', '']\r
- Setting = PcdDict[self._Arch, PcdCName, TokenSpaceGuid]\r
- if Setting == None:\r
- continue\r
- TokenList = Setting.split(TAB_VALUE_SPLIT)\r
- ValueList[0:len(TokenList)] = TokenList\r
- PcdValue, DatumType, MaxDatumSize = ValueList\r
- Pcds[PcdCName, TokenSpaceGuid] = PcdClassObject(\r
- PcdCName,\r
- TokenSpaceGuid,\r
- self._PCD_TYPE_STRING_[Type],\r
- DatumType,\r
- PcdValue,\r
- '',\r
- MaxDatumSize,\r
- {},\r
- None\r
- )\r
- return Pcds\r
-\r
- ## Retrieve dynamic PCD settings\r
- #\r
- # @param Type PCD type\r
- #\r
- # @retval a dict object contains settings of given PCD type\r
- #\r
- def _GetDynamicPcd(self, Type):\r
- Pcds = {}\r
- #\r
- # tdict is a special dict kind of type, used for selecting correct\r
- # PCD settings for certain ARCH and SKU\r
- #\r
- PcdDict = tdict(True, 4)\r
- PcdSet = set()\r
- # Find out all possible PCD candidates for self._Arch\r
- RecordList = self._RawData[Type, self._Arch]\r
- for TokenSpaceGuid, PcdCName, Setting, Arch, SkuName, Dummy3, Dummy4 in RecordList:\r
- PcdSet.add((PcdCName, TokenSpaceGuid))\r
- PcdDict[Arch, SkuName, PcdCName, TokenSpaceGuid] = Setting\r
- # Remove redundant PCD candidates, per the ARCH and SKU\r
- for PcdCName, TokenSpaceGuid in PcdSet:\r
- ValueList = ['', '', '']\r
- Setting = PcdDict[self._Arch, self.SkuName, PcdCName, TokenSpaceGuid]\r
- if Setting == None:\r
- continue\r
- TokenList = Setting.split(TAB_VALUE_SPLIT)\r
- ValueList[0:len(TokenList)] = TokenList\r
- PcdValue, DatumType, MaxDatumSize = ValueList\r
-\r
- SkuInfo = SkuInfoClass(self.SkuName, self.SkuIds[self.SkuName], '', '', '', '', '', PcdValue)\r
- Pcds[PcdCName, TokenSpaceGuid] = PcdClassObject(\r
- PcdCName,\r
- TokenSpaceGuid,\r
- self._PCD_TYPE_STRING_[Type],\r
- DatumType,\r
- PcdValue,\r
- '',\r
- MaxDatumSize,\r
- {self.SkuName : SkuInfo},\r
- None\r
- )\r
- return Pcds\r
-\r
- ## Retrieve dynamic HII PCD settings\r
- #\r
- # @param Type PCD type\r
- #\r
- # @retval a dict object contains settings of given PCD type\r
- #\r
- def _GetDynamicHiiPcd(self, Type):\r
- Pcds = {}\r
- #\r
- # tdict is a special dict kind of type, used for selecting correct\r
- # PCD settings for certain ARCH and SKU\r
- #\r
- PcdDict = tdict(True, 4)\r
- PcdSet = set()\r
- RecordList = self._RawData[Type, self._Arch]\r
- # Find out all possible PCD candidates for self._Arch\r
- for TokenSpaceGuid, PcdCName, Setting, Arch, SkuName, Dummy3, Dummy4 in RecordList:\r
- PcdSet.add((PcdCName, TokenSpaceGuid))\r
- PcdDict[Arch, SkuName, PcdCName, TokenSpaceGuid] = Setting\r
- # Remove redundant PCD candidates, per the ARCH and SKU\r
- for PcdCName, TokenSpaceGuid in PcdSet:\r
- ValueList = ['', '', '', '']\r
- Setting = PcdDict[self._Arch, self.SkuName, PcdCName, TokenSpaceGuid]\r
- if Setting == None:\r
- continue\r
- TokenList = Setting.split(TAB_VALUE_SPLIT)\r
- ValueList[0:len(TokenList)] = TokenList\r
- VariableName, VariableGuid, VariableOffset, DefaultValue = ValueList\r
- SkuInfo = SkuInfoClass(self.SkuName, self.SkuIds[self.SkuName], VariableName, VariableGuid, VariableOffset, DefaultValue)\r
- Pcds[PcdCName, TokenSpaceGuid] = PcdClassObject(\r
- PcdCName,\r
- TokenSpaceGuid,\r
- self._PCD_TYPE_STRING_[Type],\r
- '',\r
- DefaultValue,\r
- '',\r
- '',\r
- {self.SkuName : SkuInfo},\r
- None\r
- )\r
- return Pcds\r
-\r
- ## Retrieve dynamic VPD PCD settings\r
- #\r
- # @param Type PCD type\r
- #\r
- # @retval a dict object contains settings of given PCD type\r
- #\r
- def _GetDynamicVpdPcd(self, Type):\r
- Pcds = {}\r
- #\r
- # tdict is a special dict kind of type, used for selecting correct\r
- # PCD settings for certain ARCH and SKU\r
- #\r
- PcdDict = tdict(True, 4)\r
- PcdSet = set()\r
- # Find out all possible PCD candidates for self._Arch\r
- RecordList = self._RawData[Type, self._Arch]\r
- for TokenSpaceGuid, PcdCName, Setting, Arch, SkuName, Dummy3, Dummy4 in RecordList:\r
- PcdSet.add((PcdCName, TokenSpaceGuid))\r
- PcdDict[Arch, SkuName, PcdCName, TokenSpaceGuid] = Setting\r
- # Remove redundant PCD candidates, per the ARCH and SKU\r
- for PcdCName, TokenSpaceGuid in PcdSet:\r
- ValueList = ['', '']\r
- Setting = PcdDict[self._Arch, self.SkuName, PcdCName, TokenSpaceGuid]\r
- if Setting == None:\r
- continue\r
- TokenList = Setting.split(TAB_VALUE_SPLIT)\r
- ValueList[0:len(TokenList)] = TokenList\r
- VpdOffset, MaxDatumSize = ValueList\r
-\r
- SkuInfo = SkuInfoClass(self.SkuName, self.SkuIds[self.SkuName], '', '', '', '', VpdOffset)\r
- Pcds[PcdCName, TokenSpaceGuid] = PcdClassObject(\r
- PcdCName,\r
- TokenSpaceGuid,\r
- self._PCD_TYPE_STRING_[Type],\r
- '',\r
- '',\r
- '',\r
- MaxDatumSize,\r
- {self.SkuName : SkuInfo},\r
- None\r
- )\r
- return Pcds\r
-\r
- ## Add external modules\r
- #\r
- # The external modules are mostly those listed in FDF file, which don't\r
- # need "build".\r
- #\r
- # @param FilePath The path of module description file\r
- #\r
- def AddModule(self, FilePath):\r
- FilePath = NormPath(FilePath)\r
- if FilePath not in self.Modules:\r
- Module = ModuleBuildClassObject()\r
- Module.MetaFile = FilePath\r
- self.Modules.append(Module)\r
-\r
- ## Add external PCDs\r
- #\r
- # The external PCDs are mostly those listed in FDF file to specify address\r
- # or offset information.\r
- #\r
- # @param Name Name of the PCD\r
- # @param Guid Token space guid of the PCD\r
- # @param Value Value of the PCD\r
- #\r
- def AddPcd(self, Name, Guid, Value):\r
- if (Name, Guid) not in self.Pcds:\r
- self.Pcds[Name, Guid] = PcdClassObject(Name, Guid, '', '', '', '', '', {}, None)\r
- self.Pcds[Name, Guid].DefaultValue = Value\r
-\r
- Arch = property(_GetArch, _SetArch)\r
- Platform = property(_GetPlatformName)\r
- PlatformName = property(_GetPlatformName)\r
- Guid = property(_GetFileGuid)\r
- Version = property(_GetVersion)\r
- DscSpecification = property(_GetDscSpec)\r
- OutputDirectory = property(_GetOutpuDir)\r
- SupArchList = property(_GetSupArch)\r
- BuildTargets = property(_GetBuildTarget)\r
- SkuName = property(_GetSkuName, _SetSkuName)\r
- FlashDefinition = property(_GetFdfFile)\r
- BuildNumber = property(_GetBuildNumber)\r
- MakefileName = property(_GetMakefileName)\r
- BsBaseAddress = property(_GetBsBaseAddress)\r
- RtBaseAddress = property(_GetRtBaseAddress)\r
- LoadFixAddress = property(_GetLoadFixAddress)\r
-\r
- SkuIds = property(_GetSkuIds)\r
- Modules = property(_GetModules)\r
- LibraryInstances = property(_GetLibraryInstances)\r
- LibraryClasses = property(_GetLibraryClasses)\r
- Pcds = property(_GetPcds)\r
- BuildOptions = property(_GetBuildOptions)\r
-\r
-## Platform build information from DSC file\r
-#\r
-# This class is used to retrieve information stored in database and convert them\r
-# into PackageBuildClassObject form for easier use for AutoGen.\r
-#\r
-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
- }\r
-\r
- # dict used to convert part of [Defines] to members of DecBuildData directly\r
- _PROPERTY_ = {\r
- #\r
- # Required Fields\r
- #\r
- TAB_DEC_DEFINES_PACKAGE_NAME : "_PackageName",\r
- TAB_DEC_DEFINES_PACKAGE_GUID : "_Guid",\r
- TAB_DEC_DEFINES_PACKAGE_VERSION : "_Version",\r
- }\r
-\r
-\r
- ## Constructor of DecBuildData\r
- #\r
- # Initialize object of DecBuildData\r
- #\r
- # @param FilePath The path of package description file\r
- # @param RawData The raw data of DEC file\r
- # @param BuildDataBase Database used to retrieve module information\r
- # @param Arch The target architecture\r
- # @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', Platform='DUMMY', Macros={}):\r
- self.MetaFile = File\r
- self._PackageDir = File.Dir\r
- self._RawData = RawData\r
- self._Bdb = BuildDataBase\r
- self._Arch = Arch\r
- self._Macros = Macros\r
- self._Clear()\r
-\r
- ## XXX[key] = value\r
- def __setitem__(self, key, value):\r
- self.__dict__[self._PROPERTY_[key]] = value\r
-\r
- ## value = XXX[key]\r
- def __getitem__(self, key):\r
- return self.__dict__[self._PROPERTY_[key]]\r
-\r
- ## "in" test support\r
- def __contains__(self, key):\r
- return key in self._PROPERTY_\r
-\r
- ## Set all internal used members of DecBuildData to None\r
- def _Clear(self):\r
- self._Header = None\r
- self._PackageName = None\r
- self._Guid = None\r
- self._Version = None\r
- self._Protocols = None\r
- self._Ppis = None\r
- self._Guids = None\r
- self._Includes = None\r
- self._LibraryClasses = None\r
- self._Pcds = None\r
-\r
- ## Get architecture\r
- def _GetArch(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
- #\r
- def _GetHeaderInfo(self):\r
- RecordList = self._RawData[MODEL_META_DATA_HEADER]\r
- for Record in RecordList:\r
- Name = Record[0]\r
- if Name in self:\r
- self[Name] = Record[1]\r
- self._Header = 'DUMMY'\r
-\r
- ## Retrieve package name\r
- def _GetPackageName(self):\r
- if self._PackageName == None:\r
- if self._Header == None:\r
- self._GetHeaderInfo()\r
- if self._PackageName == 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
- self._GetHeaderInfo()\r
- if self._Guid == 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
- self._GetHeaderInfo()\r
- if self._Version == 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
- #\r
- # tdict is a special kind of dict, used for selecting correct\r
- # protocol defition for given ARCH\r
- #\r
- ProtocolDict = tdict(True)\r
- NameList = []\r
- # find out all protocol definitions for specific and 'common' arch\r
- RecordList = self._RawData[MODEL_EFI_PROTOCOL, self._Arch]\r
- for Name, Guid, Dummy, Arch, ID, LineNo in RecordList:\r
- 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
- for Name in NameList:\r
- #\r
- # limit the ARCH to self._Arch, if no self._Arch found, tdict\r
- # will automatically turn to 'common' ARCH for trying\r
- #\r
- self._Protocols[Name] = ProtocolDict[self._Arch, Name]\r
- return self._Protocols\r
-\r
- ## Retrieve PPI definitions (name/value pairs)\r
- def _GetPpi(self):\r
- if self._Ppis == None:\r
- #\r
- # tdict is a special kind of dict, used for selecting correct\r
- # PPI defition for given ARCH\r
- #\r
- PpiDict = tdict(True)\r
- NameList = []\r
- # find out all PPI definitions for specific arch and 'common' arch\r
- RecordList = self._RawData[MODEL_EFI_PPI, self._Arch]\r
- for Name, Guid, Dummy, Arch, ID, LineNo in RecordList:\r
- 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
- for Name in NameList:\r
- #\r
- # limit the ARCH to self._Arch, if no self._Arch found, tdict\r
- # will automatically turn to 'common' ARCH for trying\r
- #\r
- self._Ppis[Name] = PpiDict[self._Arch, Name]\r
- return self._Ppis\r
-\r
- ## Retrieve GUID definitions (name/value pairs)\r
- def _GetGuid(self):\r
- if self._Guids == None:\r
- #\r
- # tdict is a special kind of dict, used for selecting correct\r
- # GUID defition for given ARCH\r
- #\r
- GuidDict = tdict(True)\r
- NameList = []\r
- # find out all protocol definitions for specific and 'common' arch\r
- RecordList = self._RawData[MODEL_EFI_GUID, self._Arch]\r
- for Name, Guid, Dummy, Arch, ID, LineNo in RecordList:\r
- 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
- for Name in NameList:\r
- #\r
- # limit the ARCH to self._Arch, if no self._Arch found, tdict\r
- # will automatically turn to 'common' ARCH for trying\r
- #\r
- self._Guids[Name] = GuidDict[self._Arch, Name]\r
- return self._Guids\r
-\r
- ## Retrieve public include paths declared in this package\r
- def _GetInclude(self):\r
- if self._Includes == None:\r
- self._Includes = []\r
- RecordList = self._RawData[MODEL_EFI_INCLUDE, self._Arch]\r
- Macros = {"EDK_SOURCE":GlobalData.gEcpSource, "EFI_SOURCE":GlobalData.gEfiSource}\r
- Macros.update(self._Macros)\r
- for Record in RecordList:\r
- File = PathClass(NormPath(Record[0], Macros), self._PackageDir, Arch=self._Arch)\r
- LineNo = Record[-1]\r
- # validate the path\r
- ErrorCode, ErrorInfo = File.Validate()\r
- if ErrorCode != 0:\r
- EdkLogger.error('build', ErrorCode, ExtraData=ErrorInfo, File=self.MetaFile, Line=LineNo)\r
-\r
- # avoid duplicate include path\r
- if File not in self._Includes:\r
- self._Includes.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
- #\r
- # tdict is a special kind of dict, used for selecting correct\r
- # library class declaration for given ARCH\r
- #\r
- LibraryClassDict = tdict(True)\r
- LibraryClassSet = set()\r
- RecordList = self._RawData[MODEL_EFI_LIBRARY_CLASS, self._Arch]\r
- Macros = {"EDK_SOURCE":GlobalData.gEcpSource, "EFI_SOURCE":GlobalData.gEfiSource}\r
- Macros.update(self._Macros)\r
- for LibraryClass, File, Dummy, Arch, ID, LineNo in RecordList:\r
- File = PathClass(NormPath(File, Macros), self._PackageDir, Arch=self._Arch)\r
- # check the file validation\r
- ErrorCode, ErrorInfo = File.Validate()\r
- if ErrorCode != 0:\r
- 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
- 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 = {}\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
- self._Pcds.update(self._GetPcd(MODEL_PCD_DYNAMIC))\r
- self._Pcds.update(self._GetPcd(MODEL_PCD_DYNAMIC_EX))\r
- return self._Pcds\r
-\r
- ## Retrieve PCD declarations for given type\r
- def _GetPcd(self, Type):\r
- Pcds = {}\r
- #\r
- # tdict is a special kind of dict, used for selecting correct\r
- # PCD declaration for given ARCH\r
- #\r
- PcdDict = tdict(True, 3)\r
- # for summarizing PCD\r
- PcdSet = set()\r
- # find out all PCDs of the 'type'\r
- RecordList = self._RawData[Type, self._Arch]\r
- for TokenSpaceGuid, PcdCName, Setting, Arch, Dummy1, Dummy2 in RecordList:\r
- PcdDict[Arch, PcdCName, TokenSpaceGuid] = Setting\r
- PcdSet.add((PcdCName, TokenSpaceGuid))\r
-\r
- for PcdCName, TokenSpaceGuid in PcdSet:\r
- ValueList = ['', '', '']\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 = PcdDict[self._Arch, PcdCName, TokenSpaceGuid]\r
- if Setting == None:\r
- continue\r
- TokenList = Setting.split(TAB_VALUE_SPLIT)\r
- ValueList[0:len(TokenList)] = TokenList\r
- DefaultValue, DatumType, TokenNumber = ValueList\r
- Pcds[PcdCName, TokenSpaceGuid, self._PCD_TYPE_STRING_[Type]] = PcdClassObject(\r
- PcdCName,\r
- TokenSpaceGuid,\r
- self._PCD_TYPE_STRING_[Type],\r
- DatumType,\r
- DefaultValue,\r
- TokenNumber,\r
- '',\r
- {},\r
- None\r
- )\r
- return Pcds\r
-\r