BaseTools: Enable Pcd Array support.

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

## @file\r
# Common routines used by workspace\r
#\r
# Copyright (c) 2012 - 2018, Intel Corporation. All rights reserved.<BR>\r
# This program and the accompanying materials\r
# are licensed and made available under the terms and conditions of the BSD License\r
# which accompanies this distribution.  The full text of the license may be found at\r
# http://opensource.org/licenses/bsd-license.php\r
#\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
\r
from __future__ import absolute_import\r
from collections import OrderedDict, defaultdict\r
from Common.DataType import SUP_MODULE_USER_DEFINED\r
from .BuildClassObject import LibraryClassObject\r
import Common.GlobalData as GlobalData\r
from Workspace.BuildClassObject import StructurePcd\r
from Common.BuildToolError import RESOURCE_NOT_AVAILABLE\r
from Common.BuildToolError import OPTION_MISSING\r
from Common.BuildToolError import BUILD_ERROR\r
\r
class OrderedListDict(OrderedDict):\r
    def __init__(self, *args, **kwargs):\r
        super(OrderedListDict, self).__init__(*args, **kwargs)\r
        self.default_factory = list\r
\r
    def __missing__(self, key):\r
        self[key] = Value = self.default_factory()\r
        return Value\r
\r
## Get all packages from platform for specified arch, target and toolchain\r
#\r
#  @param Platform: DscBuildData instance\r
#  @param BuildDatabase: The database saves all data for all metafiles\r
#  @param Arch: Current arch\r
#  @param Target: Current target\r
#  @param Toolchain: Current toolchain\r
#  @retval: List of packages which are DecBuildData instances\r
#\r
def GetPackageList(Platform, BuildDatabase, Arch, Target, Toolchain):\r
    PkgSet = set()\r
    for ModuleFile in Platform.Modules:\r
        Data = BuildDatabase[ModuleFile, Arch, Target, Toolchain]\r
        PkgSet.update(Data.Packages)\r
        for Lib in GetLiabraryInstances(Data, Platform, BuildDatabase, Arch, Target, Toolchain):\r
            PkgSet.update(Lib.Packages)\r
    return list(PkgSet)\r
\r
## Get all declared PCD from platform for specified arch, target and toolchain\r
#\r
#  @param Platform: DscBuildData instance\r
#  @param BuildDatabase: The database saves all data for all metafiles\r
#  @param Arch: Current arch\r
#  @param Target: Current target\r
#  @param Toolchain: Current toolchain\r
#  @retval: A dictionary contains instances of PcdClassObject with key (PcdCName, TokenSpaceGuid)\r
#  @retval: A dictionary contains real GUIDs of TokenSpaceGuid\r
#\r
def GetDeclaredPcd(Platform, BuildDatabase, Arch, Target, Toolchain, additionalPkgs):\r
    PkgList = GetPackageList(Platform, BuildDatabase, Arch, Target, Toolchain)\r
    PkgList = set(PkgList)\r
    PkgList |= additionalPkgs\r
    DecPcds = {}\r
    GuidDict = {}\r
    for Pkg in PkgList:\r
        Guids = Pkg.Guids\r
        GuidDict.update(Guids)\r
        for Pcd in Pkg.Pcds:\r
            PcdCName = Pcd[0]\r
            PcdTokenName = Pcd[1]\r
            if GlobalData.MixedPcd:\r
                for PcdItem in GlobalData.MixedPcd:\r
                    if (PcdCName, PcdTokenName) in GlobalData.MixedPcd[PcdItem]:\r
                        PcdCName = PcdItem[0]\r
                        break\r
            if (PcdCName, PcdTokenName) not in DecPcds:\r
                DecPcds[PcdCName, PcdTokenName] = Pkg.Pcds[Pcd]\r
    return DecPcds, GuidDict\r
\r
## Get all dependent libraries for a module\r
#\r
#  @param Module: InfBuildData instance\r
#  @param Platform: DscBuildData instance\r
#  @param BuildDatabase: The database saves all data for all metafiles\r
#  @param Arch: Current arch\r
#  @param Target: Current target\r
#  @param Toolchain: Current toolchain\r
#  @retval: List of dependent libraries which are InfBuildData instances\r
#\r
def GetLiabraryInstances(Module, Platform, BuildDatabase, Arch, Target, Toolchain):\r
    if Module.AutoGenVersion >= 0x00010005:\r
        return GetModuleLibInstances(Module, Platform, BuildDatabase, Arch, Target, Toolchain)\r
    else:\r
        return _ResolveLibraryReference(Module, Platform)\r
\r
def GetModuleLibInstances(Module, Platform, BuildDatabase, Arch, Target, Toolchain, FileName = '', EdkLogger = None):\r
    ModuleType = Module.ModuleType\r
\r
    # add forced library instances (specified under LibraryClasses sections)\r
    #\r
    # If a module has a MODULE_TYPE of USER_DEFINED,\r
    # do not link in NULL library class instances from the global [LibraryClasses.*] sections.\r
    #\r
    if Module.ModuleType != SUP_MODULE_USER_DEFINED:\r
        for LibraryClass in Platform.LibraryClasses.GetKeys():\r
            if LibraryClass.startswith("NULL") and Platform.LibraryClasses[LibraryClass, Module.ModuleType]:\r
                Module.LibraryClasses[LibraryClass] = Platform.LibraryClasses[LibraryClass, Module.ModuleType]\r
\r
    # add forced library instances (specified in module overrides)\r
    for LibraryClass in Platform.Modules[str(Module)].LibraryClasses:\r
        if LibraryClass.startswith("NULL"):\r
            Module.LibraryClasses[LibraryClass] = Platform.Modules[str(Module)].LibraryClasses[LibraryClass]\r
\r
    # EdkII module\r
    LibraryConsumerList = [Module]\r
    Constructor = []\r
    ConsumedByList = OrderedListDict()\r
    LibraryInstance = OrderedDict()\r
\r
    if FileName:\r
        EdkLogger.verbose("")\r
        EdkLogger.verbose("Library instances of module [%s] [%s]:" % (str(Module), Arch))\r
\r
    while len(LibraryConsumerList) > 0:\r
        M = LibraryConsumerList.pop()\r
        for LibraryClassName in M.LibraryClasses:\r
            if LibraryClassName not in LibraryInstance:\r
                # override library instance for this module\r
                if LibraryClassName in Platform.Modules[str(Module)].LibraryClasses:\r
                    LibraryPath = Platform.Modules[str(Module)].LibraryClasses[LibraryClassName]\r
                else:\r
                    LibraryPath = Platform.LibraryClasses[LibraryClassName, ModuleType]\r
                if LibraryPath is None or LibraryPath == "":\r
                    LibraryPath = M.LibraryClasses[LibraryClassName]\r
                    if LibraryPath is None or LibraryPath == "":\r
                        if FileName:\r
                            EdkLogger.error("build", RESOURCE_NOT_AVAILABLE,\r
                                            "Instance of library class [%s] is not found" % LibraryClassName,\r
                                            File=FileName,\r
                                            ExtraData="in [%s] [%s]\n\tconsumed by module [%s]" % (str(M), Arch, str(Module)))\r
                        else:\r
                            return []\r
\r
                LibraryModule = BuildDatabase[LibraryPath, Arch, Target, Toolchain]\r
                # for those forced library instance (NULL library), add a fake library class\r
                if LibraryClassName.startswith("NULL"):\r
                    LibraryModule.LibraryClass.append(LibraryClassObject(LibraryClassName, [ModuleType]))\r
                elif LibraryModule.LibraryClass is None \\r
                     or len(LibraryModule.LibraryClass) == 0 \\r
                     or (ModuleType != SUP_MODULE_USER_DEFINED\r
                         and ModuleType not in LibraryModule.LibraryClass[0].SupModList):\r
                    # only USER_DEFINED can link against any library instance despite of its SupModList\r
                    if FileName:\r
                        EdkLogger.error("build", OPTION_MISSING,\r
                                        "Module type [%s] is not supported by library instance [%s]" \\r
                                        % (ModuleType, LibraryPath), File=FileName,\r
                                        ExtraData="consumed by [%s]" % str(Module))\r
                    else:\r
                        return []\r
\r
                LibraryInstance[LibraryClassName] = LibraryModule\r
                LibraryConsumerList.append(LibraryModule)\r
                if FileName:\r
                    EdkLogger.verbose("\t" + str(LibraryClassName) + " : " + str(LibraryModule))\r
            else:\r
                LibraryModule = LibraryInstance[LibraryClassName]\r
\r
            if LibraryModule is None:\r
                continue\r
\r
            if LibraryModule.ConstructorList != [] and LibraryModule not in Constructor:\r
                Constructor.append(LibraryModule)\r
\r
            # don't add current module itself to consumer list\r
            if M != Module:\r
                if M in ConsumedByList[LibraryModule]:\r
                    continue\r
                ConsumedByList[LibraryModule].append(M)\r
    #\r
    # Initialize the sorted output list to the empty set\r
    #\r
    SortedLibraryList = []\r
    #\r
    # Q <- Set of all nodes with no incoming edges\r
    #\r
    LibraryList = [] #LibraryInstance.values()\r
    Q = []\r
    for LibraryClassName in LibraryInstance:\r
        M = LibraryInstance[LibraryClassName]\r
        LibraryList.append(M)\r
        if not ConsumedByList[M]:\r
            Q.append(M)\r
\r
    #\r
    # start the  DAG algorithm\r
    #\r
    while True:\r
        EdgeRemoved = True\r
        while Q == [] and EdgeRemoved:\r
            EdgeRemoved = False\r
            # for each node Item with a Constructor\r
            for Item in LibraryList:\r
                if Item not in Constructor:\r
                    continue\r
                # for each Node without a constructor with an edge e from Item to Node\r
                for Node in ConsumedByList[Item]:\r
                    if Node in Constructor:\r
                        continue\r
                    # remove edge e from the graph if Node has no constructor\r
                    ConsumedByList[Item].remove(Node)\r
                    EdgeRemoved = True\r
                    if not ConsumedByList[Item]:\r
                        # insert Item into Q\r
                        Q.insert(0, Item)\r
                        break\r
                if Q != []:\r
                    break\r
        # DAG is done if there's no more incoming edge for all nodes\r
        if Q == []:\r
            break\r
\r
        # remove node from Q\r
        Node = Q.pop()\r
        # output Node\r
        SortedLibraryList.append(Node)\r
\r
        # for each node Item with an edge e from Node to Item do\r
        for Item in LibraryList:\r
            if Node not in ConsumedByList[Item]:\r
                continue\r
            # remove edge e from the graph\r
            ConsumedByList[Item].remove(Node)\r
\r
            if ConsumedByList[Item]:\r
                continue\r
            # insert Item into Q, if Item has no other incoming edges\r
            Q.insert(0, Item)\r
\r
    #\r
    # if any remaining node Item in the graph has a constructor and an incoming edge, then the graph has a cycle\r
    #\r
    for Item in LibraryList:\r
        if ConsumedByList[Item] and Item in Constructor and len(Constructor) > 1:\r
            if FileName:\r
                ErrorMessage = "\tconsumed by " + "\n\tconsumed by ".join(str(L) for L in ConsumedByList[Item])\r
                EdkLogger.error("build", BUILD_ERROR, 'Library [%s] with constructors has a cycle' % str(Item),\r
                                ExtraData=ErrorMessage, File=FileName)\r
            else:\r
                return []\r
        if Item not in SortedLibraryList:\r
            SortedLibraryList.append(Item)\r
\r
    #\r
    # Build the list of constructor and destructir names\r
    # The DAG Topo sort produces the destructor order, so the list of constructors must generated in the reverse order\r
    #\r
    SortedLibraryList.reverse()\r
    return SortedLibraryList\r
\r
def _ResolveLibraryReference(Module, Platform):\r
    LibraryConsumerList = [Module]\r
\r
    # "CompilerStub" is a must for Edk modules\r
    if Module.Libraries:\r
        Module.Libraries.append("CompilerStub")\r
    LibraryList = []\r
    while len(LibraryConsumerList) > 0:\r
        M = LibraryConsumerList.pop()\r
        for LibraryName in M.Libraries:\r
            Library = Platform.LibraryClasses[LibraryName, ':dummy:']\r
            if Library is None:\r
                for Key in Platform.LibraryClasses.data:\r
                    if LibraryName.upper() == Key.upper():\r
                        Library = Platform.LibraryClasses[Key, ':dummy:']\r
                        break\r
                if Library is None:\r
                    continue\r
\r
            if Library not in LibraryList:\r
                LibraryList.append(Library)\r
                LibraryConsumerList.append(Library)\r
    return LibraryList\r