BaseTools: Enable the flag to treat dynamic pcd as dynamicEx

[mirror_edk2.git] / BaseTools / Source / Python / Workspace / DecBuildData.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
from Common.StringUtils import *\r
from Common.DataType import *\r
from Common.Misc import *\r
from types import *\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
#  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
\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
        TAB_DEC_DEFINES_PKG_UNI_FILE                : "_PkgUniFile",\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=TAB_ARCH_COMMON, Target=None, Toolchain=None):\r
        self.MetaFile = File\r
        self._PackageDir = File.Dir\r
        self._RawData = RawData\r
        self._Bdb = BuildDataBase\r
        self._Arch = Arch\r
        self._Target = Target\r
        self._Toolchain = Toolchain\r
        self._Clear()\r
        self.UpdatePcdTypeDict()\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._PkgUniFile        = None\r
        self._Protocols         = None\r
        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._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
    @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
    @property\r
    def Arch(self):\r
        return self._Arch\r
\r
    ## Retrieve all information in [Defines] section\r
    #\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
        for Record in RecordList:\r
            Name = Record[1]\r
            if Name in self:\r
                self[Name] = Record[2]\r
        self._Header = 'DUMMY'\r
\r
    ## Retrieve package name\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 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
    @property\r
    def PackageName(self):\r
        if self._Guid is None:\r
            if self._Header is None:\r
                self._GetHeaderInfo()\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
    @property\r
    def Version(self):\r
        if self._Version is None:\r
            if self._Header is None:\r
                self._GetHeaderInfo()\r
            if self._Version is None:\r
                self._Version = ''\r
        return self._Version\r
\r
    ## Retrieve protocol definitions (name/value pairs)\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 definition for given ARCH\r
            #\r
            ProtocolDict = tdict(True)\r
            PrivateProtocolDict = tdict(True)\r
            NameList = []\r
            PrivateNameList = []\r
            PublicNameList = []\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, PrivateFlag, ID, LineNo in RecordList:\r
                if PrivateFlag == 'PRIVATE':\r
                    if Name not in PrivateNameList:\r
                        PrivateNameList.append(Name)\r
                        PrivateProtocolDict[Arch, Name] = Guid\r
                    if Name in PublicNameList:\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." % Name, File=self.MetaFile, Line=LineNo)\r
                else:\r
                    if Name not in PublicNameList:\r
                        PublicNameList.append(Name)\r
                    if Name in PrivateNameList:\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." % Name, File=self.MetaFile, Line=LineNo)\r
                if Name not in NameList:\r
                    NameList.append(Name)\r
                ProtocolDict[Arch, Name] = Guid\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
                # will automatically turn to 'common' ARCH for trying\r
                #\r
                self._Protocols[Name] = ProtocolDict[self._Arch, Name]\r
            for Name in PrivateNameList:\r
                self._PrivateProtocols[Name] = PrivateProtocolDict[self._Arch, Name]\r
        return self._Protocols\r
\r
    ## Retrieve PPI definitions (name/value pairs)\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 definition for given ARCH\r
            #\r
            PpiDict = tdict(True)\r
            PrivatePpiDict = tdict(True)\r
            NameList = []\r
            PrivateNameList = []\r
            PublicNameList = []\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, PrivateFlag, ID, LineNo in RecordList:\r
                if PrivateFlag == 'PRIVATE':\r
                    if Name not in PrivateNameList:\r
                        PrivateNameList.append(Name)\r
                        PrivatePpiDict[Arch, Name] = Guid\r
                    if Name in PublicNameList:\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." % Name, File=self.MetaFile, Line=LineNo)\r
                else:\r
                    if Name not in PublicNameList:\r
                        PublicNameList.append(Name)\r
                    if Name in PrivateNameList:\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." % Name, File=self.MetaFile, Line=LineNo)\r
                if Name not in NameList:\r
                    NameList.append(Name)\r
                PpiDict[Arch, Name] = Guid\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
                # will automatically turn to 'common' ARCH for trying\r
                #\r
                self._Ppis[Name] = PpiDict[self._Arch, Name]\r
            for Name in PrivateNameList:\r
                self._PrivatePpis[Name] = PrivatePpiDict[self._Arch, Name]\r
        return self._Ppis\r
\r
    ## Retrieve GUID definitions (name/value pairs)\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 definition for given ARCH\r
            #\r
            GuidDict = tdict(True)\r
            PrivateGuidDict = tdict(True)\r
            NameList = []\r
            PrivateNameList = []\r
            PublicNameList = []\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, PrivateFlag, ID, LineNo in RecordList:\r
                if PrivateFlag == 'PRIVATE':\r
                    if Name not in PrivateNameList:\r
                        PrivateNameList.append(Name)\r
                        PrivateGuidDict[Arch, Name] = Guid\r
                    if Name in PublicNameList:\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." % Name, File=self.MetaFile, Line=LineNo)\r
                else:\r
                    if Name not in PublicNameList:\r
                        PublicNameList.append(Name)\r
                    if Name in PrivateNameList:\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." % Name, File=self.MetaFile, Line=LineNo)\r
                if Name not in NameList:\r
                    NameList.append(Name)\r
                GuidDict[Arch, Name] = Guid\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
                # will automatically turn to 'common' ARCH for trying\r
                #\r
                self._Guids[Name] = GuidDict[self._Arch, Name]\r
            for Name in PrivateNameList:\r
                self._PrivateGuids[Name] = PrivateGuidDict[self._Arch, Name]\r
        return self._Guids\r
\r
    ## Retrieve public include paths declared in this package\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
            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
                if Record[4] == 'PRIVATE':\r
                    if File not in self._PrivateIncludes:\r
                        self._PrivateIncludes.append(File)\r
                    if File in PublicInclues:\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
                else:\r
                    if File not in PublicInclues:\r
                        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
                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
    @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
            #\r
            LibraryClassDict = tdict(True)\r
            LibraryClassSet = set()\r
            RecordList = self._RawData[MODEL_EFI_LIBRARY_CLASS, self._Arch]\r
            Macros = self._Macros\r
            for LibraryClass, File, Dummy, Arch, PrivateFlag, 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 = OrderedDict()\r
            for LibraryClass in LibraryClassSet:\r
                self._LibraryClasses[LibraryClass] = LibraryClassDict[self._Arch, LibraryClass]\r
        return self._LibraryClasses\r
\r
    ## Retrieve PCD declarations\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
            self._Pcds.update(self._GetPcd(MODEL_PCD_DYNAMIC))\r
            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 = 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
\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
                if not item.TokenCName:\r
                    continue\r
                if "<HeaderFiles>" in item.TokenCName:\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,self.MetaFile.File,LineNo)\r
                else:\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
            str_pcd_set.append(struct_pcd)\r
        return str_pcd_set\r
\r
    ## Retrieve PCD declarations for given type\r
    def _GetPcd(self, Type):\r
        Pcds = OrderedDict()\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 = []\r
        # find out all PCDs of the 'type'\r
\r
        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
            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 is None:\r
                continue\r
\r
            DefaultValue, DatumType, TokenNumber = AnalyzePcdData(Setting)\r
            validateranges, validlists, expressions = self._RawData.GetValidExpression(TokenSpaceGuid, PcdCName)\r
            PcdObj = PcdClassObject(\r
                                        PcdCName,\r
                                        TokenSpaceGuid,\r
                                        self._PCD_TYPE_STRING_[Type],\r
                                        DatumType,\r
                                        DefaultValue,\r
                                        TokenNumber,\r
                                        '',\r
                                        {},\r
                                        False,\r
                                        None,\r
                                        list(validateranges),\r
                                        list(validlists),\r
                                        list(expressions)\r
                                        )\r
            DefinitionPosition[PcdObj] = (self.MetaFile.File, LineNo)\r
            if "." in TokenSpaceGuid:\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
        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
    @property\r
    def CommonIncludes(self):\r
        if self._CommonIncludes is None:\r
            self.Includes\r
        return self._CommonIncludes\r