2 # Common routines used by workspace
4 # Copyright (c) 2012 - 2020, Intel Corporation. All rights reserved.<BR>
5 # SPDX-License-Identifier: BSD-2-Clause-Patent
8 from __future__
import absolute_import
9 from collections
import OrderedDict
, defaultdict
10 from Common
.DataType
import SUP_MODULE_USER_DEFINED
11 from Common
.DataType
import SUP_MODULE_HOST_APPLICATION
12 from .BuildClassObject
import LibraryClassObject
13 import Common
.GlobalData
as GlobalData
14 from Workspace
.BuildClassObject
import StructurePcd
15 from Common
.BuildToolError
import RESOURCE_NOT_AVAILABLE
16 from Common
.BuildToolError
import OPTION_MISSING
17 from Common
.BuildToolError
import BUILD_ERROR
18 import Common
.EdkLogger
as EdkLogger
20 class OrderedListDict(OrderedDict
):
21 def __init__(self
, *args
, **kwargs
):
22 super(OrderedListDict
, self
).__init
__(*args
, **kwargs
)
23 self
.default_factory
= list
25 def __missing__(self
, key
):
26 self
[key
] = Value
= self
.default_factory()
29 ## Get all packages from platform for specified arch, target and toolchain
31 # @param Platform: DscBuildData instance
32 # @param BuildDatabase: The database saves all data for all metafiles
33 # @param Arch: Current arch
34 # @param Target: Current target
35 # @param Toolchain: Current toolchain
36 # @retval: List of packages which are DecBuildData instances
38 def GetPackageList(Platform
, BuildDatabase
, Arch
, Target
, Toolchain
):
41 PkgSet
.update(Platform
.Packages
)
42 for ModuleFile
in Platform
.Modules
:
43 Data
= BuildDatabase
[ModuleFile
, Arch
, Target
, Toolchain
]
44 PkgSet
.update(Data
.Packages
)
45 for Lib
in GetLiabraryInstances(Data
, Platform
, BuildDatabase
, Arch
, Target
, Toolchain
):
46 PkgSet
.update(Lib
.Packages
)
49 ## Get all declared PCD from platform for specified arch, target and toolchain
51 # @param Platform: DscBuildData instance
52 # @param BuildDatabase: The database saves all data for all metafiles
53 # @param Arch: Current arch
54 # @param Target: Current target
55 # @param Toolchain: Current toolchain
56 # @retval: A dictionary contains instances of PcdClassObject with key (PcdCName, TokenSpaceGuid)
57 # @retval: A dictionary contains real GUIDs of TokenSpaceGuid
59 def GetDeclaredPcd(Platform
, BuildDatabase
, Arch
, Target
, Toolchain
, additionalPkgs
):
60 PkgList
= GetPackageList(Platform
, BuildDatabase
, Arch
, Target
, Toolchain
)
61 PkgList
= set(PkgList
)
62 PkgList |
= additionalPkgs
67 GuidDict
.update(Guids
)
71 if GlobalData
.MixedPcd
:
72 for PcdItem
in GlobalData
.MixedPcd
:
73 if (PcdCName
, PcdTokenName
) in GlobalData
.MixedPcd
[PcdItem
]:
76 if (PcdCName
, PcdTokenName
) not in DecPcds
:
77 DecPcds
[PcdCName
, PcdTokenName
] = Pkg
.Pcds
[Pcd
]
78 return DecPcds
, GuidDict
80 ## Get all dependent libraries for a module
82 # @param Module: InfBuildData instance
83 # @param Platform: DscBuildData instance
84 # @param BuildDatabase: The database saves all data for all metafiles
85 # @param Arch: Current arch
86 # @param Target: Current target
87 # @param Toolchain: Current toolchain
88 # @retval: List of dependent libraries which are InfBuildData instances
90 def GetLiabraryInstances(Module
, Platform
, BuildDatabase
, Arch
, Target
, Toolchain
):
91 return GetModuleLibInstances(Module
, Platform
, BuildDatabase
, Arch
, Target
, Toolchain
,Platform
.MetaFile
,EdkLogger
)
93 def GetModuleLibInstances(Module
, Platform
, BuildDatabase
, Arch
, Target
, Toolchain
, FileName
= '', EdkLogger
= None):
94 if Module
.LibInstances
:
95 return Module
.LibInstances
96 ModuleType
= Module
.ModuleType
98 # add forced library instances (specified under LibraryClasses sections)
100 # If a module has a MODULE_TYPE of USER_DEFINED,
101 # do not link in NULL library class instances from the global [LibraryClasses.*] sections.
103 if Module
.ModuleType
!= SUP_MODULE_USER_DEFINED
:
104 for LibraryClass
in Platform
.LibraryClasses
.GetKeys():
105 if LibraryClass
.startswith("NULL") and Platform
.LibraryClasses
[LibraryClass
, Module
.ModuleType
]:
106 Module
.LibraryClasses
[LibraryClass
] = Platform
.LibraryClasses
[LibraryClass
, Module
.ModuleType
]
108 # add forced library instances (specified in module overrides)
109 for LibraryClass
in Platform
.Modules
[str(Module
)].LibraryClasses
:
110 if LibraryClass
.startswith("NULL"):
111 Module
.LibraryClasses
[LibraryClass
] = Platform
.Modules
[str(Module
)].LibraryClasses
[LibraryClass
]
114 LibraryConsumerList
= [Module
]
116 ConsumedByList
= OrderedListDict()
117 LibraryInstance
= OrderedDict()
119 if not Module
.LibraryClass
:
120 EdkLogger
.verbose("")
121 EdkLogger
.verbose("Library instances of module [%s] [%s]:" % (str(Module
), Arch
))
123 while len(LibraryConsumerList
) > 0:
124 M
= LibraryConsumerList
.pop()
125 for LibraryClassName
in M
.LibraryClasses
:
126 if LibraryClassName
not in LibraryInstance
:
127 # override library instance for this module
128 LibraryPath
= Platform
.Modules
[str(Module
)].LibraryClasses
.get(LibraryClassName
,Platform
.LibraryClasses
[LibraryClassName
, ModuleType
])
129 if LibraryPath
is None:
130 LibraryPath
= M
.LibraryClasses
.get(LibraryClassName
)
131 if LibraryPath
is None:
132 if not Module
.LibraryClass
:
133 EdkLogger
.error("build", RESOURCE_NOT_AVAILABLE
,
134 "Instance of library class [%s] is not found" % LibraryClassName
,
136 ExtraData
="in [%s] [%s]\n\tconsumed by module [%s]" % (str(M
), Arch
, str(Module
)))
140 LibraryModule
= BuildDatabase
[LibraryPath
, Arch
, Target
, Toolchain
]
141 # for those forced library instance (NULL library), add a fake library class
142 if LibraryClassName
.startswith("NULL"):
143 LibraryModule
.LibraryClass
.append(LibraryClassObject(LibraryClassName
, [ModuleType
]))
144 elif LibraryModule
.LibraryClass
is None \
145 or len(LibraryModule
.LibraryClass
) == 0 \
146 or (ModuleType
!= SUP_MODULE_USER_DEFINED
and ModuleType
!= SUP_MODULE_HOST_APPLICATION
147 and ModuleType
not in LibraryModule
.LibraryClass
[0].SupModList
):
148 # only USER_DEFINED can link against any library instance despite of its SupModList
149 if not Module
.LibraryClass
:
150 EdkLogger
.error("build", OPTION_MISSING
,
151 "Module type [%s] is not supported by library instance [%s]" \
152 % (ModuleType
, LibraryPath
), File
=FileName
,
153 ExtraData
="consumed by [%s]" % str(Module
))
157 LibraryInstance
[LibraryClassName
] = LibraryModule
158 LibraryConsumerList
.append(LibraryModule
)
159 if not Module
.LibraryClass
:
160 EdkLogger
.verbose("\t" + str(LibraryClassName
) + " : " + str(LibraryModule
))
162 LibraryModule
= LibraryInstance
[LibraryClassName
]
164 if LibraryModule
is None:
167 if LibraryModule
.ConstructorList
!= [] and LibraryModule
not in Constructor
:
168 Constructor
.append(LibraryModule
)
170 # don't add current module itself to consumer list
172 if M
in ConsumedByList
[LibraryModule
]:
174 ConsumedByList
[LibraryModule
].append(M
)
176 # Initialize the sorted output list to the empty set
178 SortedLibraryList
= []
180 # Q <- Set of all nodes with no incoming edges
182 LibraryList
= [] #LibraryInstance.values()
184 for LibraryClassName
in LibraryInstance
:
185 M
= LibraryInstance
[LibraryClassName
]
186 LibraryList
.append(M
)
187 if not ConsumedByList
[M
]:
191 # start the DAG algorithm
195 while Q
== [] and EdgeRemoved
:
197 # for each node Item with a Constructor
198 for Item
in LibraryList
:
199 if Item
not in Constructor
:
201 # for each Node without a constructor with an edge e from Item to Node
202 for Node
in ConsumedByList
[Item
]:
203 if Node
in Constructor
:
205 # remove edge e from the graph if Node has no constructor
206 ConsumedByList
[Item
].remove(Node
)
208 if not ConsumedByList
[Item
]:
214 # DAG is done if there's no more incoming edge for all nodes
221 SortedLibraryList
.append(Node
)
223 # for each node Item with an edge e from Node to Item do
224 for Item
in LibraryList
:
225 if Node
not in ConsumedByList
[Item
]:
227 # remove edge e from the graph
228 ConsumedByList
[Item
].remove(Node
)
230 if ConsumedByList
[Item
]:
232 # insert Item into Q, if Item has no other incoming edges
236 # if any remaining node Item in the graph has a constructor and an incoming edge, then the graph has a cycle
238 for Item
in LibraryList
:
239 if ConsumedByList
[Item
] and Item
in Constructor
and len(Constructor
) > 1:
240 if not Module
.LibraryClass
:
241 ErrorMessage
= "\tconsumed by " + "\n\tconsumed by ".join(str(L
) for L
in ConsumedByList
[Item
])
242 EdkLogger
.error("build", BUILD_ERROR
, 'Library [%s] with constructors has a cycle' % str(Item
),
243 ExtraData
=ErrorMessage
, File
=FileName
)
246 if Item
not in SortedLibraryList
:
247 SortedLibraryList
.append(Item
)
250 # Build the list of constructor and destructor names
251 # The DAG Topo sort produces the destructor order, so the list of constructors must generated in the reverse order
253 SortedLibraryList
.reverse()
254 Module
.LibInstances
= SortedLibraryList
255 SortedLibraryList
= [lib
.SetReferenceModule(Module
) for lib
in SortedLibraryList
]
256 return SortedLibraryList