[mirror_edk2.git] / BaseTools / Source / Python / Workspace / WorkspaceDatabase.py

## @file\r
# This file is used to create a database used by build tool\r
#\r
# Copyright (c) 2008 - 2018, Intel Corporation. All rights reserved.<BR>\r
# (C) Copyright 2016 Hewlett Packard Enterprise Development LP<BR>\r
# SPDX-License-Identifier: BSD-2-Clause-Patent\r
#\r
\r
##\r
# Import Modules\r
#\r
from __future__ import absolute_import\r
from Common.StringUtils import *\r
from Common.DataType import *\r
from Common.Misc import *\r
from types import *\r
\r
from .MetaDataTable import *\r
from .MetaFileTable import *\r
from .MetaFileParser import *\r
\r
from Workspace.DecBuildData import DecBuildData\r
from Workspace.DscBuildData import DscBuildData\r
from Workspace.InfBuildData import InfBuildData\r
\r
## Database\r
#\r
#   This class defined the build database for all modules, packages and platform.\r
# It will call corresponding parser for the given file if it cannot find it in\r
# the database.\r
#\r
# @param DbPath             Path of database file\r
# @param GlobalMacros       Global macros used for replacement during file parsing\r
# @param RenewDb=False      Create new database file if it's already there\r
#\r
class WorkspaceDatabase(object):\r
\r
    #\r
    # internal class used for call corresponding file parser and caching the result\r
    # to avoid unnecessary re-parsing\r
    #\r
    class BuildObjectFactory(object):\r
\r
        _FILE_TYPE_ = {\r
            ".inf"  : MODEL_FILE_INF,\r
            ".dec"  : MODEL_FILE_DEC,\r
            ".dsc"  : MODEL_FILE_DSC,\r
        }\r
\r
        # file parser\r
        _FILE_PARSER_ = {\r
            MODEL_FILE_INF  :   InfParser,\r
            MODEL_FILE_DEC  :   DecParser,\r
            MODEL_FILE_DSC  :   DscParser,\r
        }\r
\r
        # convert to xxxBuildData object\r
        _GENERATOR_ = {\r
            MODEL_FILE_INF  :   InfBuildData,\r
            MODEL_FILE_DEC  :   DecBuildData,\r
            MODEL_FILE_DSC  :   DscBuildData,\r
        }\r
\r
        _CACHE_ = {}    # (FilePath, Arch)  : <object>\r
\r
        # constructor\r
        def __init__(self, WorkspaceDb):\r
            self.WorkspaceDb = WorkspaceDb\r
\r
        # key = (FilePath, Arch=None)\r
        def __contains__(self, Key):\r
            FilePath = Key[0]\r
            if len(Key) > 1:\r
                Arch = Key[1]\r
            else:\r
                Arch = None\r
            return (FilePath, Arch) in self._CACHE_\r
\r
        # key = (FilePath, Arch=None, Target=None, Toolchain=None)\r
        def __getitem__(self, Key):\r
            FilePath = Key[0]\r
            KeyLength = len(Key)\r
            if KeyLength > 1:\r
                Arch = Key[1]\r
            else:\r
                Arch = None\r
            if KeyLength > 2:\r
                Target = Key[2]\r
            else:\r
                Target = None\r
            if KeyLength > 3:\r
                Toolchain = Key[3]\r
            else:\r
                Toolchain = None\r
\r
            # if it's generated before, just return the cached one\r
            Key = (FilePath, Arch, Target, Toolchain)\r
            if Key in self._CACHE_:\r
                return self._CACHE_[Key]\r
\r
            # check file type\r
            BuildObject = self.CreateBuildObject(FilePath, Arch, Target, Toolchain)\r
            self._CACHE_[Key] = BuildObject\r
            return BuildObject\r
        def CreateBuildObject(self,FilePath, Arch, Target, Toolchain):\r
            Ext = FilePath.Type\r
            if Ext not in self._FILE_TYPE_:\r
                return None\r
            FileType = self._FILE_TYPE_[Ext]\r
            if FileType not in self._GENERATOR_:\r
                return None\r
\r
            # get the parser ready for this file\r
            MetaFile = self._FILE_PARSER_[FileType](\r
                                FilePath,\r
                                FileType,\r
                                Arch,\r
                                MetaFileStorage(self.WorkspaceDb, FilePath, FileType)\r
                                )\r
            # always do post-process, in case of macros change\r
            MetaFile.DoPostProcess()\r
            # object the build is based on\r
            BuildObject = self._GENERATOR_[FileType](\r
                                    FilePath,\r
                                    MetaFile,\r
                                    self,\r
                                    Arch,\r
                                    Target,\r
                                    Toolchain\r
                                    )\r
            return BuildObject\r
\r
    # placeholder for file format conversion\r
    class TransformObjectFactory:\r
        def __init__(self, WorkspaceDb):\r
            self.WorkspaceDb = WorkspaceDb\r
\r
        # key = FilePath, Arch\r
        def __getitem__(self, Key):\r
            pass\r
\r
    ## Constructor of WorkspaceDatabase\r
    #\r
    # @param DbPath             Path of database file\r
    # @param GlobalMacros       Global macros used for replacement during file parsing\r
    # @param RenewDb=False      Create new database file if it's already there\r
    #\r
    def __init__(self):\r
        self.DB = dict()\r
        # create table for internal uses\r
        self.TblDataModel = DataClass.MODEL_LIST\r
        self.TblFile = []\r
        self.Platform = None\r
\r
        # conversion object for build or file format conversion purpose\r
        self.BuildObject = WorkspaceDatabase.BuildObjectFactory(self)\r
        self.TransformObject = WorkspaceDatabase.TransformObjectFactory(self)\r
\r
    def SetFileTimeStamp(self,FileId,TimeStamp):\r
        self.TblFile[FileId-1][6] = TimeStamp\r
\r
    def GetFileTimeStamp(self,FileId):\r
        return self.TblFile[FileId-1][6]\r
\r
\r
    ## Summarize all packages in the database\r
    def GetPackageList(self, Platform, Arch, TargetName, ToolChainTag):\r
        self.Platform = Platform\r
        PackageList = []\r
        Pa = self.BuildObject[self.Platform, Arch, TargetName, ToolChainTag]\r
        #\r
        # Get Package related to Modules\r
        #\r
        for Module in Pa.Modules:\r
            ModuleObj = self.BuildObject[Module, Arch, TargetName, ToolChainTag]\r
            for Package in ModuleObj.Packages:\r
                if Package not in PackageList:\r
                    PackageList.append(Package)\r
        #\r
        # Get Packages related to Libraries\r
        #\r
        for Lib in Pa.LibraryInstances:\r
            LibObj = self.BuildObject[Lib, Arch, TargetName, ToolChainTag]\r
            for Package in LibObj.Packages:\r
                if Package not in PackageList:\r
                    PackageList.append(Package)\r
\r
        return PackageList\r
\r
    ## Summarize all platforms in the database\r
    def PlatformList(self):\r
        RetVal = []\r
        for PlatformFile in [item[3] for item in self.TblFile if item[5] == MODEL_FILE_DSC]:\r
            try:\r
                RetVal.append(self.BuildObject[PathClass(PlatformFile), TAB_COMMON])\r
            except:\r
                pass\r
        return RetVal\r
\r
    def MapPlatform(self, Dscfile):\r
        Platform = self.BuildObject[PathClass(Dscfile), TAB_COMMON]\r
        if Platform is None:\r
            EdkLogger.error('build', PARSER_ERROR, "Failed to parser DSC file: %s" % Dscfile)\r
        return Platform\r
\r
##\r
#\r
# This acts like the main() function for the script, unless it is 'import'ed into another\r
# script.\r
#\r
if __name__ == '__main__':\r
    pass\r
\r
Commit	Line	Data
	1	## @file\r
	2	# This file is used to create a database used by build tool\r
	3	#\r
	4	# Copyright (c) 2008 - 2018, Intel Corporation. All rights reserved.<BR>\r
	5	# (C) Copyright 2016 Hewlett Packard Enterprise Development LP<BR>\r
	6	# SPDX-License-Identifier: BSD-2-Clause-Patent\r
	7	#\r
	8	\r
	9	##\r
	10	# Import Modules\r
	11	#\r
	12	from __future__ import absolute_import\r
	13	from Common.StringUtils import *\r
	14	from Common.DataType import *\r
	15	from Common.Misc import *\r
	16	from types import *\r
	17	\r
	18	from .MetaDataTable import *\r
	19	from .MetaFileTable import *\r
	20	from .MetaFileParser import *\r
	21	\r
	22	from Workspace.DecBuildData import DecBuildData\r
	23	from Workspace.DscBuildData import DscBuildData\r
	24	from Workspace.InfBuildData import InfBuildData\r
	25	\r
	26	## Database\r
	27	#\r
	28	# This class defined the build database for all modules, packages and platform.\r
	29	# It will call corresponding parser for the given file if it cannot find it in\r
	30	# the database.\r
	31	#\r
	32	# @param DbPath Path of database file\r
	33	# @param GlobalMacros Global macros used for replacement during file parsing\r
	34	# @param RenewDb=False Create new database file if it's already there\r
	35	#\r
	36	class WorkspaceDatabase(object):\r
	37	\r
	38	#\r
	39	# internal class used for call corresponding file parser and caching the result\r
	40	# to avoid unnecessary re-parsing\r
	41	#\r
	42	class BuildObjectFactory(object):\r
	43	\r
	44	_FILE_TYPE_ = {\r
	45	".inf" : MODEL_FILE_INF,\r
	46	".dec" : MODEL_FILE_DEC,\r
	47	".dsc" : MODEL_FILE_DSC,\r
	48	}\r
	49	\r
	50	# file parser\r
	51	_FILE_PARSER_ = {\r
	52	MODEL_FILE_INF : InfParser,\r
	53	MODEL_FILE_DEC : DecParser,\r
	54	MODEL_FILE_DSC : DscParser,\r
	55	}\r
	56	\r
	57	# convert to xxxBuildData object\r
	58	_GENERATOR_ = {\r
	59	MODEL_FILE_INF : InfBuildData,\r
	60	MODEL_FILE_DEC : DecBuildData,\r
	61	MODEL_FILE_DSC : DscBuildData,\r
	62	}\r
	63	\r
	64	_CACHE_ = {} # (FilePath, Arch) : <object>\r
	65	\r
	66	# constructor\r
	67	def __init__(self, WorkspaceDb):\r
	68	self.WorkspaceDb = WorkspaceDb\r
	69	\r
	70	# key = (FilePath, Arch=None)\r
	71	def __contains__(self, Key):\r
	72	FilePath = Key[0]\r
	73	if len(Key) > 1:\r
	74	Arch = Key[1]\r
	75	else:\r
	76	Arch = None\r
	77	return (FilePath, Arch) in self._CACHE_\r
	78	\r
	79	# key = (FilePath, Arch=None, Target=None, Toolchain=None)\r
	80	def __getitem__(self, Key):\r
	81	FilePath = Key[0]\r
	82	KeyLength = len(Key)\r
	83	if KeyLength > 1:\r
	84	Arch = Key[1]\r
	85	else:\r
	86	Arch = None\r
	87	if KeyLength > 2:\r
	88	Target = Key[2]\r
	89	else:\r
	90	Target = None\r
	91	if KeyLength > 3:\r
	92	Toolchain = Key[3]\r
	93	else:\r
	94	Toolchain = None\r
	95	\r
	96	# if it's generated before, just return the cached one\r
	97	Key = (FilePath, Arch, Target, Toolchain)\r
	98	if Key in self._CACHE_:\r
	99	return self._CACHE_[Key]\r
	100	\r
	101	# check file type\r
	102	BuildObject = self.CreateBuildObject(FilePath, Arch, Target, Toolchain)\r
	103	self._CACHE_[Key] = BuildObject\r
	104	return BuildObject\r
	105	def CreateBuildObject(self,FilePath, Arch, Target, Toolchain):\r
	106	Ext = FilePath.Type\r
	107	if Ext not in self._FILE_TYPE_:\r
	108	return None\r
	109	FileType = self._FILE_TYPE_[Ext]\r
	110	if FileType not in self._GENERATOR_:\r
	111	return None\r
	112	\r
	113	# get the parser ready for this file\r
	114	MetaFile = self._FILE_PARSER_[FileType](\r
	115	FilePath,\r
	116	FileType,\r
	117	Arch,\r
	118	MetaFileStorage(self.WorkspaceDb, FilePath, FileType)\r
	119	)\r
	120	# always do post-process, in case of macros change\r
	121	MetaFile.DoPostProcess()\r
	122	# object the build is based on\r
	123	BuildObject = self._GENERATOR_[FileType](\r
	124	FilePath,\r
	125	MetaFile,\r
	126	self,\r
	127	Arch,\r
	128	Target,\r
	129	Toolchain\r
	130	)\r
	131	return BuildObject\r
	132	\r
	133	# placeholder for file format conversion\r
	134	class TransformObjectFactory:\r
	135	def __init__(self, WorkspaceDb):\r
	136	self.WorkspaceDb = WorkspaceDb\r
	137	\r
	138	# key = FilePath, Arch\r
	139	def __getitem__(self, Key):\r
	140	pass\r
	141	\r
	142	## Constructor of WorkspaceDatabase\r
	143	#\r
	144	# @param DbPath Path of database file\r
	145	# @param GlobalMacros Global macros used for replacement during file parsing\r
	146	# @param RenewDb=False Create new database file if it's already there\r
	147	#\r
	148	def __init__(self):\r
	149	self.DB = dict()\r
	150	# create table for internal uses\r
	151	self.TblDataModel = DataClass.MODEL_LIST\r
	152	self.TblFile = []\r
	153	self.Platform = None\r
	154	\r
	155	# conversion object for build or file format conversion purpose\r
	156	self.BuildObject = WorkspaceDatabase.BuildObjectFactory(self)\r
	157	self.TransformObject = WorkspaceDatabase.TransformObjectFactory(self)\r
	158	\r
	159	def SetFileTimeStamp(self,FileId,TimeStamp):\r
	160	self.TblFile[FileId-1][6] = TimeStamp\r
	161	\r
	162	def GetFileTimeStamp(self,FileId):\r
	163	return self.TblFile[FileId-1][6]\r
	164	\r
	165	\r
	166	## Summarize all packages in the database\r
	167	def GetPackageList(self, Platform, Arch, TargetName, ToolChainTag):\r
	168	self.Platform = Platform\r
	169	PackageList = []\r
	170	Pa = self.BuildObject[self.Platform, Arch, TargetName, ToolChainTag]\r
	171	#\r
	172	# Get Package related to Modules\r
	173	#\r
	174	for Module in Pa.Modules:\r
	175	ModuleObj = self.BuildObject[Module, Arch, TargetName, ToolChainTag]\r
	176	for Package in ModuleObj.Packages:\r
	177	if Package not in PackageList:\r
	178	PackageList.append(Package)\r
	179	#\r
	180	# Get Packages related to Libraries\r
	181	#\r
	182	for Lib in Pa.LibraryInstances:\r
	183	LibObj = self.BuildObject[Lib, Arch, TargetName, ToolChainTag]\r
	184	for Package in LibObj.Packages:\r
	185	if Package not in PackageList:\r
	186	PackageList.append(Package)\r
	187	\r
	188	return PackageList\r
	189	\r
	190	## Summarize all platforms in the database\r
	191	def PlatformList(self):\r
	192	RetVal = []\r
	193	for PlatformFile in [item[3] for item in self.TblFile if item[5] == MODEL_FILE_DSC]:\r
	194	try:\r
	195	RetVal.append(self.BuildObject[PathClass(PlatformFile), TAB_COMMON])\r
	196	except:\r
	197	pass\r
	198	return RetVal\r
	199	\r
	200	def MapPlatform(self, Dscfile):\r
	201	Platform = self.BuildObject[PathClass(Dscfile), TAB_COMMON]\r
	202	if Platform is None:\r
	203	EdkLogger.error('build', PARSER_ERROR, "Failed to parser DSC file: %s" % Dscfile)\r
	204	return Platform\r
	205	\r
	206	##\r
	207	#\r
	208	# This acts like the main() function for the script, unless it is 'import'ed into another\r
	209	# script.\r
	210	#\r
	211	if __name__ == '__main__':\r
	212	pass\r
	213	\r