]>
Commit | Line | Data |
---|---|---|
4afd3d04 LG |
1 | ## @file\r |
2 | # Common routines used by workspace\r | |
3 | #\r | |
5b86bbf8 | 4 | # Copyright (c) 2012 - 2020, Intel Corporation. All rights reserved.<BR>\r |
2e351cbe | 5 | # SPDX-License-Identifier: BSD-2-Clause-Patent\r |
4afd3d04 LG |
6 | #\r |
7 | \r | |
1ccc4d89 | 8 | from __future__ import absolute_import\r |
1f1c6712 | 9 | from collections import OrderedDict, defaultdict\r |
4afd3d04 | 10 | from Common.DataType import SUP_MODULE_USER_DEFINED\r |
a79841a0 | 11 | from Common.DataType import SUP_MODULE_HOST_APPLICATION\r |
1100bc5a | 12 | from .BuildClassObject import LibraryClassObject\r |
2a29017e | 13 | import Common.GlobalData as GlobalData\r |
ae7b6df8 | 14 | from Workspace.BuildClassObject import StructurePcd\r |
87a46244 MH |
15 | from Common.BuildToolError import RESOURCE_NOT_AVAILABLE\r |
16 | from Common.BuildToolError import OPTION_MISSING\r | |
17 | from Common.BuildToolError import BUILD_ERROR\r | |
abc0155b | 18 | import Common.EdkLogger as EdkLogger\r |
4afd3d04 | 19 | \r |
abb8e6e9 | 20 | class OrderedListDict(OrderedDict):\r |
1f1c6712 | 21 | def __init__(self, *args, **kwargs):\r |
1ccc4d89 | 22 | super(OrderedListDict, self).__init__(*args, **kwargs)\r |
1f1c6712 CJ |
23 | self.default_factory = list\r |
24 | \r | |
abb8e6e9 FY |
25 | def __missing__(self, key):\r |
26 | self[key] = Value = self.default_factory()\r | |
27 | return Value\r | |
28 | \r | |
4afd3d04 LG |
29 | ## Get all packages from platform for specified arch, target and toolchain\r |
30 | #\r | |
31 | # @param Platform: DscBuildData instance\r | |
32 | # @param BuildDatabase: The database saves all data for all metafiles\r | |
33 | # @param Arch: Current arch\r | |
34 | # @param Target: Current target\r | |
35 | # @param Toolchain: Current toolchain\r | |
36 | # @retval: List of packages which are DecBuildData instances\r | |
37 | #\r | |
38 | def GetPackageList(Platform, BuildDatabase, Arch, Target, Toolchain):\r | |
39 | PkgSet = set()\r | |
bf1ea933 FZ |
40 | if Platform.Packages:\r |
41 | PkgSet.update(Platform.Packages)\r | |
4afd3d04 LG |
42 | for ModuleFile in Platform.Modules:\r |
43 | Data = BuildDatabase[ModuleFile, Arch, Target, Toolchain]\r | |
44 | PkgSet.update(Data.Packages)\r | |
45 | for Lib in GetLiabraryInstances(Data, Platform, BuildDatabase, Arch, Target, Toolchain):\r | |
46 | PkgSet.update(Lib.Packages)\r | |
47 | return list(PkgSet)\r | |
48 | \r | |
49 | ## Get all declared PCD from platform for specified arch, target and toolchain\r | |
50 | #\r | |
51 | # @param Platform: DscBuildData instance\r | |
52 | # @param BuildDatabase: The database saves all data for all metafiles\r | |
53 | # @param Arch: Current arch\r | |
54 | # @param Target: Current target\r | |
55 | # @param Toolchain: Current toolchain\r | |
56 | # @retval: A dictionary contains instances of PcdClassObject with key (PcdCName, TokenSpaceGuid)\r | |
726c501c | 57 | # @retval: A dictionary contains real GUIDs of TokenSpaceGuid\r |
4afd3d04 | 58 | #\r |
ccaa7754 | 59 | def GetDeclaredPcd(Platform, BuildDatabase, Arch, Target, Toolchain, additionalPkgs):\r |
4afd3d04 | 60 | PkgList = GetPackageList(Platform, BuildDatabase, Arch, Target, Toolchain)\r |
2b8a6c44 LG |
61 | PkgList = set(PkgList)\r |
62 | PkgList |= additionalPkgs\r | |
4afd3d04 | 63 | DecPcds = {}\r |
726c501c | 64 | GuidDict = {}\r |
4afd3d04 | 65 | for Pkg in PkgList:\r |
726c501c YZ |
66 | Guids = Pkg.Guids\r |
67 | GuidDict.update(Guids)\r | |
4afd3d04 | 68 | for Pcd in Pkg.Pcds:\r |
2a29017e YZ |
69 | PcdCName = Pcd[0]\r |
70 | PcdTokenName = Pcd[1]\r | |
71 | if GlobalData.MixedPcd:\r | |
9eb87141 | 72 | for PcdItem in GlobalData.MixedPcd:\r |
2a29017e YZ |
73 | if (PcdCName, PcdTokenName) in GlobalData.MixedPcd[PcdItem]:\r |
74 | PcdCName = PcdItem[0]\r | |
75 | break\r | |
9eb87141 | 76 | if (PcdCName, PcdTokenName) not in DecPcds:\r |
2a29017e | 77 | DecPcds[PcdCName, PcdTokenName] = Pkg.Pcds[Pcd]\r |
726c501c | 78 | return DecPcds, GuidDict\r |
4afd3d04 LG |
79 | \r |
80 | ## Get all dependent libraries for a module\r | |
81 | #\r | |
82 | # @param Module: InfBuildData instance\r | |
83 | # @param Platform: DscBuildData instance\r | |
84 | # @param BuildDatabase: The database saves all data for all metafiles\r | |
85 | # @param Arch: Current arch\r | |
86 | # @param Target: Current target\r | |
87 | # @param Toolchain: Current toolchain\r | |
88 | # @retval: List of dependent libraries which are InfBuildData instances\r | |
89 | #\r | |
90 | def GetLiabraryInstances(Module, Platform, BuildDatabase, Arch, Target, Toolchain):\r | |
abc0155b | 91 | return GetModuleLibInstances(Module, Platform, BuildDatabase, Arch, Target, Toolchain,Platform.MetaFile,EdkLogger)\r |
4afd3d04 | 92 | \r |
c14b5861 | 93 | def GetModuleLibInstances(Module, Platform, BuildDatabase, Arch, Target, Toolchain, FileName = '', EdkLogger = None):\r |
e8449e1d FB |
94 | if Module.LibInstances:\r |
95 | return Module.LibInstances\r | |
4afd3d04 LG |
96 | ModuleType = Module.ModuleType\r |
97 | \r | |
4afd3d04 LG |
98 | # add forced library instances (specified under LibraryClasses sections)\r |
99 | #\r | |
100 | # If a module has a MODULE_TYPE of USER_DEFINED,\r | |
101 | # do not link in NULL library class instances from the global [LibraryClasses.*] sections.\r | |
102 | #\r | |
5b86bbf8 | 103 | if Module.ModuleType != SUP_MODULE_USER_DEFINED:\r |
4afd3d04 LG |
104 | for LibraryClass in Platform.LibraryClasses.GetKeys():\r |
105 | if LibraryClass.startswith("NULL") and Platform.LibraryClasses[LibraryClass, Module.ModuleType]:\r | |
106 | Module.LibraryClasses[LibraryClass] = Platform.LibraryClasses[LibraryClass, Module.ModuleType]\r | |
107 | \r | |
108 | # add forced library instances (specified in module overrides)\r | |
c14b5861 | 109 | for LibraryClass in Platform.Modules[str(Module)].LibraryClasses:\r |
4afd3d04 | 110 | if LibraryClass.startswith("NULL"):\r |
c14b5861 | 111 | Module.LibraryClasses[LibraryClass] = Platform.Modules[str(Module)].LibraryClasses[LibraryClass]\r |
4afd3d04 LG |
112 | \r |
113 | # EdkII module\r | |
114 | LibraryConsumerList = [Module]\r | |
115 | Constructor = []\r | |
1f1c6712 | 116 | ConsumedByList = OrderedListDict()\r |
a0767bae | 117 | LibraryInstance = OrderedDict()\r |
4afd3d04 | 118 | \r |
abc0155b | 119 | if not Module.LibraryClass:\r |
c14b5861 JC |
120 | EdkLogger.verbose("")\r |
121 | EdkLogger.verbose("Library instances of module [%s] [%s]:" % (str(Module), Arch))\r | |
122 | \r | |
4afd3d04 LG |
123 | while len(LibraryConsumerList) > 0:\r |
124 | M = LibraryConsumerList.pop()\r | |
125 | for LibraryClassName in M.LibraryClasses:\r | |
126 | if LibraryClassName not in LibraryInstance:\r | |
127 | # override library instance for this module\r | |
4e375707 B |
128 | LibraryPath = Platform.Modules[str(Module)].LibraryClasses.get(LibraryClassName,Platform.LibraryClasses[LibraryClassName, ModuleType])\r |
129 | if LibraryPath is None:\r | |
130 | LibraryPath = M.LibraryClasses.get(LibraryClassName)\r | |
131 | if LibraryPath is None:\r | |
abc0155b | 132 | if not Module.LibraryClass:\r |
c14b5861 JC |
133 | EdkLogger.error("build", RESOURCE_NOT_AVAILABLE,\r |
134 | "Instance of library class [%s] is not found" % LibraryClassName,\r | |
135 | File=FileName,\r | |
136 | ExtraData="in [%s] [%s]\n\tconsumed by module [%s]" % (str(M), Arch, str(Module)))\r | |
137 | else:\r | |
138 | return []\r | |
4afd3d04 LG |
139 | \r |
140 | LibraryModule = BuildDatabase[LibraryPath, Arch, Target, Toolchain]\r | |
141 | # for those forced library instance (NULL library), add a fake library class\r | |
142 | if LibraryClassName.startswith("NULL"):\r | |
143 | LibraryModule.LibraryClass.append(LibraryClassObject(LibraryClassName, [ModuleType]))\r | |
4231a819 | 144 | elif LibraryModule.LibraryClass is None \\r |
4afd3d04 | 145 | or len(LibraryModule.LibraryClass) == 0 \\r |
a79841a0 | 146 | or (ModuleType != SUP_MODULE_USER_DEFINED and ModuleType != SUP_MODULE_HOST_APPLICATION\r |
4afd3d04 LG |
147 | and ModuleType not in LibraryModule.LibraryClass[0].SupModList):\r |
148 | # only USER_DEFINED can link against any library instance despite of its SupModList\r | |
abc0155b | 149 | if not Module.LibraryClass:\r |
c14b5861 JC |
150 | EdkLogger.error("build", OPTION_MISSING,\r |
151 | "Module type [%s] is not supported by library instance [%s]" \\r | |
152 | % (ModuleType, LibraryPath), File=FileName,\r | |
92ab0497 RN |
153 | ExtraData="consumed by library instance [%s] which is consumed by module [%s]" \\r |
154 | % (str(M), str(Module))\r | |
155 | )\r | |
c14b5861 JC |
156 | else:\r |
157 | return []\r | |
4afd3d04 LG |
158 | \r |
159 | LibraryInstance[LibraryClassName] = LibraryModule\r | |
160 | LibraryConsumerList.append(LibraryModule)\r | |
abc0155b | 161 | if not Module.LibraryClass:\r |
c14b5861 | 162 | EdkLogger.verbose("\t" + str(LibraryClassName) + " : " + str(LibraryModule))\r |
4afd3d04 LG |
163 | else:\r |
164 | LibraryModule = LibraryInstance[LibraryClassName]\r | |
165 | \r | |
4231a819 | 166 | if LibraryModule is None:\r |
4afd3d04 LG |
167 | continue\r |
168 | \r | |
169 | if LibraryModule.ConstructorList != [] and LibraryModule not in Constructor:\r | |
170 | Constructor.append(LibraryModule)\r | |
171 | \r | |
4afd3d04 LG |
172 | # don't add current module itself to consumer list\r |
173 | if M != Module:\r | |
174 | if M in ConsumedByList[LibraryModule]:\r | |
175 | continue\r | |
176 | ConsumedByList[LibraryModule].append(M)\r | |
177 | #\r | |
178 | # Initialize the sorted output list to the empty set\r | |
179 | #\r | |
180 | SortedLibraryList = []\r | |
181 | #\r | |
182 | # Q <- Set of all nodes with no incoming edges\r | |
183 | #\r | |
184 | LibraryList = [] #LibraryInstance.values()\r | |
185 | Q = []\r | |
186 | for LibraryClassName in LibraryInstance:\r | |
187 | M = LibraryInstance[LibraryClassName]\r | |
188 | LibraryList.append(M)\r | |
c14b5861 | 189 | if not ConsumedByList[M]:\r |
4afd3d04 LG |
190 | Q.append(M)\r |
191 | \r | |
192 | #\r | |
193 | # start the DAG algorithm\r | |
194 | #\r | |
195 | while True:\r | |
196 | EdgeRemoved = True\r | |
197 | while Q == [] and EdgeRemoved:\r | |
198 | EdgeRemoved = False\r | |
199 | # for each node Item with a Constructor\r | |
200 | for Item in LibraryList:\r | |
201 | if Item not in Constructor:\r | |
202 | continue\r | |
203 | # for each Node without a constructor with an edge e from Item to Node\r | |
204 | for Node in ConsumedByList[Item]:\r | |
205 | if Node in Constructor:\r | |
206 | continue\r | |
207 | # remove edge e from the graph if Node has no constructor\r | |
208 | ConsumedByList[Item].remove(Node)\r | |
209 | EdgeRemoved = True\r | |
c14b5861 | 210 | if not ConsumedByList[Item]:\r |
4afd3d04 LG |
211 | # insert Item into Q\r |
212 | Q.insert(0, Item)\r | |
213 | break\r | |
214 | if Q != []:\r | |
215 | break\r | |
216 | # DAG is done if there's no more incoming edge for all nodes\r | |
217 | if Q == []:\r | |
218 | break\r | |
219 | \r | |
220 | # remove node from Q\r | |
221 | Node = Q.pop()\r | |
222 | # output Node\r | |
223 | SortedLibraryList.append(Node)\r | |
224 | \r | |
225 | # for each node Item with an edge e from Node to Item do\r | |
226 | for Item in LibraryList:\r | |
227 | if Node not in ConsumedByList[Item]:\r | |
228 | continue\r | |
229 | # remove edge e from the graph\r | |
230 | ConsumedByList[Item].remove(Node)\r | |
231 | \r | |
c14b5861 | 232 | if ConsumedByList[Item]:\r |
4afd3d04 LG |
233 | continue\r |
234 | # insert Item into Q, if Item has no other incoming edges\r | |
235 | Q.insert(0, Item)\r | |
236 | \r | |
237 | #\r | |
238 | # if any remaining node Item in the graph has a constructor and an incoming edge, then the graph has a cycle\r | |
239 | #\r | |
240 | for Item in LibraryList:\r | |
c14b5861 | 241 | if ConsumedByList[Item] and Item in Constructor and len(Constructor) > 1:\r |
abc0155b | 242 | if not Module.LibraryClass:\r |
c14b5861 JC |
243 | ErrorMessage = "\tconsumed by " + "\n\tconsumed by ".join(str(L) for L in ConsumedByList[Item])\r |
244 | EdkLogger.error("build", BUILD_ERROR, 'Library [%s] with constructors has a cycle' % str(Item),\r | |
245 | ExtraData=ErrorMessage, File=FileName)\r | |
246 | else:\r | |
247 | return []\r | |
4afd3d04 LG |
248 | if Item not in SortedLibraryList:\r |
249 | SortedLibraryList.append(Item)\r | |
250 | \r | |
251 | #\r | |
fb0b35e0 | 252 | # Build the list of constructor and destructor names\r |
4afd3d04 LG |
253 | # The DAG Topo sort produces the destructor order, so the list of constructors must generated in the reverse order\r |
254 | #\r | |
255 | SortedLibraryList.reverse()\r | |
e8449e1d FB |
256 | Module.LibInstances = SortedLibraryList\r |
257 | SortedLibraryList = [lib.SetReferenceModule(Module) for lib in SortedLibraryList]\r | |
4afd3d04 | 258 | return SortedLibraryList\r |