]>
Commit | Line | Data |
---|---|---|
52302d4d LG |
1 | ## @file\r |
2 | # Routines for generating build report.\r | |
3 | #\r | |
4 | # This module contains the functionality to generate build report after\r | |
5 | # build all target completes successfully.\r | |
6 | #\r | |
779ddcdf | 7 | # Copyright (c) 2010 - 2018, Intel Corporation. All rights reserved.<BR>\r |
40d841f6 | 8 | # This program and the accompanying materials\r |
52302d4d LG |
9 | # are licensed and made available under the terms and conditions of the BSD License\r |
10 | # which accompanies this distribution. The full text of the license may be found at\r | |
11 | # http://opensource.org/licenses/bsd-license.php\r | |
12 | #\r | |
13 | # THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
14 | # WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
15 | #\r | |
16 | \r | |
17 | ## Import Modules\r | |
18 | #\r | |
1be2ed90 | 19 | import Common.LongFilePathOs as os\r |
52302d4d LG |
20 | import re\r |
21 | import platform\r | |
22 | import textwrap\r | |
23 | import traceback\r | |
24 | import sys\r | |
40d841f6 | 25 | import time\r |
e56468c0 | 26 | import struct\r |
eca5be7a YZ |
27 | import hashlib\r |
28 | import subprocess\r | |
29 | import threading\r | |
52302d4d | 30 | from datetime import datetime\r |
86379ac4 | 31 | from io import BytesIO\r |
52302d4d | 32 | from Common import EdkLogger\r |
40d841f6 | 33 | from Common.Misc import SaveFileOnChange\r |
52302d4d LG |
34 | from Common.Misc import GuidStructureByteArrayToGuidString\r |
35 | from Common.Misc import GuidStructureStringToGuidString\r | |
52302d4d LG |
36 | from Common.BuildToolError import FILE_WRITE_FAILURE\r |
37 | from Common.BuildToolError import CODE_ERROR\r | |
eca5be7a | 38 | from Common.BuildToolError import COMMAND_FAILURE\r |
35f613d9 | 39 | from Common.BuildToolError import FORMAT_INVALID\r |
1be2ed90 | 40 | from Common.LongFilePathSupport import OpenLongFilePath as open\r |
05cc51ad | 41 | from Common.MultipleWorkspace import MultipleWorkspace as mws\r |
763e8edf | 42 | import Common.GlobalData as GlobalData\r |
25193a33 YZ |
43 | from AutoGen.AutoGen import ModuleAutoGen\r |
44 | from Common.Misc import PathClass\r | |
5a57246e | 45 | from Common.StringUtils import NormPath\r |
e651d06c LG |
46 | from Common.DataType import *\r |
47 | import collections\r | |
35f613d9 | 48 | from Common.Expression import *\r |
52302d4d LG |
49 | \r |
50 | ## Pattern to extract contents in EDK DXS files\r | |
51 | gDxsDependencyPattern = re.compile(r"DEPENDENCY_START(.+)DEPENDENCY_END", re.DOTALL)\r | |
52 | \r | |
53 | ## Pattern to find total FV total size, occupied size in flash report intermediate file\r | |
54 | gFvTotalSizePattern = re.compile(r"EFI_FV_TOTAL_SIZE = (0x[0-9a-fA-F]+)")\r | |
55 | gFvTakenSizePattern = re.compile(r"EFI_FV_TAKEN_SIZE = (0x[0-9a-fA-F]+)")\r | |
56 | \r | |
57 | ## Pattern to find module size and time stamp in module summary report intermediate file\r | |
58 | gModuleSizePattern = re.compile(r"MODULE_SIZE = (\d+)")\r | |
59 | gTimeStampPattern = re.compile(r"TIME_STAMP = (\d+)")\r | |
60 | \r | |
61 | ## Pattern to find GUID value in flash description files\r | |
62 | gPcdGuidPattern = re.compile(r"PCD\((\w+)[.](\w+)\)")\r | |
63 | \r | |
64 | ## Pattern to collect offset, GUID value pair in the flash report intermediate file\r | |
65 | gOffsetGuidPattern = re.compile(r"(0x[0-9A-Fa-f]+) ([-A-Fa-f0-9]+)")\r | |
66 | \r | |
67 | ## Pattern to find module base address and entry point in fixed flash map file\r | |
68 | gModulePattern = r"\n[-\w]+\s*\(([^,]+),\s*BaseAddress=%(Address)s,\s*EntryPoint=%(Address)s\)\s*\(GUID=([-0-9A-Fa-f]+)[^)]*\)"\r | |
69 | gMapFileItemPattern = re.compile(gModulePattern % {"Address" : "(-?0[xX][0-9A-Fa-f]+)"})\r | |
70 | \r | |
71 | ## Pattern to find all module referenced header files in source files\r | |
72 | gIncludePattern = re.compile(r'#include\s*["<]([^">]+)[">]')\r | |
73 | gIncludePattern2 = re.compile(r"#include\s+EFI_([A-Z_]+)\s*[(]\s*(\w+)\s*[)]")\r | |
74 | \r | |
75 | ## Pattern to find the entry point for EDK module using EDKII Glue library\r | |
76 | gGlueLibEntryPoint = re.compile(r"__EDKII_GLUE_MODULE_ENTRY_POINT__\s*=\s*(\w+)")\r | |
77 | \r | |
64b2609f LG |
78 | ## Tags for MaxLength of line in report\r |
79 | gLineMaxLength = 120\r | |
80 | \r | |
4afd3d04 LG |
81 | ## Tags for end of line in report\r |
82 | gEndOfLine = "\r\n"\r | |
83 | \r | |
52302d4d | 84 | ## Tags for section start, end and separator\r |
47fea6af YZ |
85 | gSectionStart = ">" + "=" * (gLineMaxLength - 2) + "<"\r |
86 | gSectionEnd = "<" + "=" * (gLineMaxLength - 2) + ">" + "\n"\r | |
64b2609f | 87 | gSectionSep = "=" * gLineMaxLength\r |
52302d4d LG |
88 | \r |
89 | ## Tags for subsection start, end and separator\r | |
47fea6af YZ |
90 | gSubSectionStart = ">" + "-" * (gLineMaxLength - 2) + "<"\r |
91 | gSubSectionEnd = "<" + "-" * (gLineMaxLength - 2) + ">"\r | |
64b2609f LG |
92 | gSubSectionSep = "-" * gLineMaxLength\r |
93 | \r | |
52302d4d LG |
94 | \r |
95 | ## The look up table to map PCD type to pair of report display type and DEC type\r | |
96 | gPcdTypeMap = {\r | |
be409b67 CJ |
97 | TAB_PCDS_FIXED_AT_BUILD : ('FIXED', TAB_PCDS_FIXED_AT_BUILD),\r |
98 | TAB_PCDS_PATCHABLE_IN_MODULE: ('PATCH', TAB_PCDS_PATCHABLE_IN_MODULE),\r | |
99 | TAB_PCDS_FEATURE_FLAG : ('FLAG', TAB_PCDS_FEATURE_FLAG),\r | |
100 | TAB_PCDS_DYNAMIC : ('DYN', TAB_PCDS_DYNAMIC),\r | |
101 | TAB_PCDS_DYNAMIC_HII : ('DYNHII', TAB_PCDS_DYNAMIC),\r | |
102 | TAB_PCDS_DYNAMIC_VPD : ('DYNVPD', TAB_PCDS_DYNAMIC),\r | |
103 | TAB_PCDS_DYNAMIC_EX : ('DEX', TAB_PCDS_DYNAMIC_EX),\r | |
104 | TAB_PCDS_DYNAMIC_EX_HII : ('DEXHII', TAB_PCDS_DYNAMIC_EX),\r | |
105 | TAB_PCDS_DYNAMIC_EX_VPD : ('DEXVPD', TAB_PCDS_DYNAMIC_EX),\r | |
52302d4d LG |
106 | }\r |
107 | \r | |
108 | ## The look up table to map module type to driver type\r | |
109 | gDriverTypeMap = {\r | |
8bb63e37 CJ |
110 | SUP_MODULE_SEC : '0x3 (SECURITY_CORE)',\r |
111 | SUP_MODULE_PEI_CORE : '0x4 (PEI_CORE)',\r | |
112 | SUP_MODULE_PEIM : '0x6 (PEIM)',\r | |
113 | SUP_MODULE_DXE_CORE : '0x5 (DXE_CORE)',\r | |
114 | SUP_MODULE_DXE_DRIVER : '0x7 (DRIVER)',\r | |
115 | SUP_MODULE_DXE_SAL_DRIVER : '0x7 (DRIVER)',\r | |
116 | SUP_MODULE_DXE_SMM_DRIVER : '0x7 (DRIVER)',\r | |
117 | SUP_MODULE_DXE_RUNTIME_DRIVER: '0x7 (DRIVER)',\r | |
118 | SUP_MODULE_UEFI_DRIVER : '0x7 (DRIVER)',\r | |
119 | SUP_MODULE_UEFI_APPLICATION : '0x9 (APPLICATION)',\r | |
120 | SUP_MODULE_SMM_CORE : '0xD (SMM_CORE)',\r | |
52302d4d | 121 | 'SMM_DRIVER' : '0xA (SMM)', # Extension of module type to support PI 1.1 SMM drivers\r |
8bb63e37 CJ |
122 | SUP_MODULE_MM_STANDALONE : '0xE (MM_STANDALONE)',\r |
123 | SUP_MODULE_MM_CORE_STANDALONE : '0xF (MM_CORE_STANDALONE)'\r | |
52302d4d LG |
124 | }\r |
125 | \r | |
e56468c0 | 126 | ## The look up table of the supported opcode in the dependency expression binaries\r |
127 | gOpCodeList = ["BEFORE", "AFTER", "PUSH", "AND", "OR", "NOT", "TRUE", "FALSE", "END", "SOR"]\r | |
128 | \r | |
52302d4d LG |
129 | ##\r |
130 | # Writes a string to the file object.\r | |
131 | #\r | |
132 | # This function writes a string to the file object and a new line is appended\r | |
133 | # afterwards. It may optionally wraps the string for better readability.\r | |
134 | #\r | |
135 | # @File The file object to write\r | |
136 | # @String The string to be written to the file\r | |
137 | # @Wrapper Indicates whether to wrap the string\r | |
138 | #\r | |
139 | def FileWrite(File, String, Wrapper=False):\r | |
140 | if Wrapper:\r | |
141 | String = textwrap.fill(String, 120)\r | |
4afd3d04 | 142 | File.write(String + gEndOfLine)\r |
52302d4d | 143 | \r |
e651d06c LG |
144 | def ByteArrayForamt(Value):\r |
145 | IsByteArray = False\r | |
146 | SplitNum = 16\r | |
147 | ArrayList = []\r | |
148 | if Value.startswith('{') and Value.endswith('}'):\r | |
149 | Value = Value[1:-1]\r | |
150 | ValueList = Value.split(',')\r | |
151 | if len(ValueList) >= SplitNum:\r | |
152 | IsByteArray = True\r | |
153 | if IsByteArray:\r | |
154 | if ValueList:\r | |
155 | Len = len(ValueList)/SplitNum\r | |
156 | for i, element in enumerate(ValueList):\r | |
157 | ValueList[i] = '0x%02X' % int(element.strip(), 16)\r | |
158 | if Len:\r | |
159 | Id = 0\r | |
160 | while (Id <= Len):\r | |
161 | End = min(SplitNum*(Id+1), len(ValueList))\r | |
162 | Str = ','.join(ValueList[SplitNum*Id : End])\r | |
163 | if End == len(ValueList):\r | |
164 | Str += '}'\r | |
165 | ArrayList.append(Str)\r | |
166 | break\r | |
167 | else:\r | |
168 | Str += ','\r | |
169 | ArrayList.append(Str)\r | |
170 | Id += 1\r | |
171 | else:\r | |
172 | ArrayList = [Value + '}']\r | |
173 | return IsByteArray, ArrayList\r | |
174 | \r | |
52302d4d LG |
175 | ##\r |
176 | # Find all the header file that the module source directly includes.\r | |
177 | #\r | |
178 | # This function scans source code to find all header files the module may\r | |
179 | # include. This is not accurate but very effective to find all the header\r | |
180 | # file the module might include with #include statement.\r | |
181 | #\r | |
182 | # @Source The source file name\r | |
183 | # @IncludePathList The list of include path to find the source file.\r | |
184 | # @IncludeFiles The dictionary of current found include files.\r | |
185 | #\r | |
186 | def FindIncludeFiles(Source, IncludePathList, IncludeFiles):\r | |
187 | FileContents = open(Source).read()\r | |
188 | #\r | |
189 | # Find header files with pattern #include "XXX.h" or #include <XXX.h>\r | |
190 | #\r | |
191 | for Match in gIncludePattern.finditer(FileContents):\r | |
192 | FileName = Match.group(1).strip()\r | |
193 | for Dir in [os.path.dirname(Source)] + IncludePathList:\r | |
194 | FullFileName = os.path.normpath(os.path.join(Dir, FileName))\r | |
195 | if os.path.exists(FullFileName):\r | |
196 | IncludeFiles[FullFileName.lower().replace("\\", "/")] = FullFileName\r | |
197 | break\r | |
198 | \r | |
199 | #\r | |
200 | # Find header files with pattern like #include EFI_PPI_CONSUMER(XXX)\r | |
201 | #\r | |
202 | for Match in gIncludePattern2.finditer(FileContents):\r | |
203 | Key = Match.group(2)\r | |
204 | Type = Match.group(1)\r | |
205 | if "ARCH_PROTOCOL" in Type:\r | |
206 | FileName = "ArchProtocol/%(Key)s/%(Key)s.h" % {"Key" : Key}\r | |
207 | elif "PROTOCOL" in Type:\r | |
208 | FileName = "Protocol/%(Key)s/%(Key)s.h" % {"Key" : Key}\r | |
209 | elif "PPI" in Type:\r | |
210 | FileName = "Ppi/%(Key)s/%(Key)s.h" % {"Key" : Key}\r | |
91fa33ee | 211 | elif TAB_GUID in Type:\r |
52302d4d LG |
212 | FileName = "Guid/%(Key)s/%(Key)s.h" % {"Key" : Key}\r |
213 | else:\r | |
214 | continue\r | |
215 | for Dir in IncludePathList:\r | |
216 | FullFileName = os.path.normpath(os.path.join(Dir, FileName))\r | |
217 | if os.path.exists(FullFileName):\r | |
218 | IncludeFiles[FullFileName.lower().replace("\\", "/")] = FullFileName\r | |
219 | break\r | |
220 | \r | |
64b2609f LG |
221 | ## Split each lines in file\r |
222 | #\r | |
f7496d71 | 223 | # This method is used to split the lines in file to make the length of each line\r |
64b2609f LG |
224 | # less than MaxLength.\r |
225 | #\r | |
226 | # @param Content The content of file\r | |
227 | # @param MaxLength The Max Length of the line\r | |
228 | #\r | |
229 | def FileLinesSplit(Content=None, MaxLength=None):\r | |
230 | ContentList = Content.split(TAB_LINE_BREAK)\r | |
231 | NewContent = ''\r | |
232 | NewContentList = []\r | |
233 | for Line in ContentList:\r | |
234 | while len(Line.rstrip()) > MaxLength:\r | |
235 | LineSpaceIndex = Line.rfind(TAB_SPACE_SPLIT, 0, MaxLength)\r | |
236 | LineSlashIndex = Line.rfind(TAB_SLASH, 0, MaxLength)\r | |
25918452 LG |
237 | LineBackSlashIndex = Line.rfind(TAB_BACK_SLASH, 0, MaxLength)\r |
238 | if max(LineSpaceIndex, LineSlashIndex, LineBackSlashIndex) > 0:\r | |
239 | LineBreakIndex = max(LineSpaceIndex, LineSlashIndex, LineBackSlashIndex)\r | |
240 | else:\r | |
241 | LineBreakIndex = MaxLength\r | |
64b2609f LG |
242 | NewContentList.append(Line[:LineBreakIndex])\r |
243 | Line = Line[LineBreakIndex:]\r | |
244 | if Line:\r | |
245 | NewContentList.append(Line)\r | |
246 | for NewLine in NewContentList:\r | |
247 | NewContent += NewLine + TAB_LINE_BREAK\r | |
f7496d71 | 248 | \r |
4afd3d04 | 249 | NewContent = NewContent.replace(TAB_LINE_BREAK, gEndOfLine).replace('\r\r\n', gEndOfLine)\r |
64b2609f | 250 | return NewContent\r |
f7496d71 LG |
251 | \r |
252 | \r | |
253 | \r | |
e56468c0 | 254 | ##\r |
255 | # Parse binary dependency expression section\r | |
256 | #\r | |
257 | # This utility class parses the dependency expression section and translate the readable\r | |
258 | # GUID name and value.\r | |
259 | #\r | |
260 | class DepexParser(object):\r | |
261 | ##\r | |
262 | # Constructor function for class DepexParser\r | |
263 | #\r | |
264 | # This constructor function collect GUID values so that the readable\r | |
265 | # GUID name can be translated.\r | |
266 | #\r | |
267 | # @param self The object pointer\r | |
268 | # @param Wa Workspace context information\r | |
269 | #\r | |
270 | def __init__(self, Wa):\r | |
271 | self._GuidDb = {}\r | |
0d2711a6 | 272 | for Pa in Wa.AutoGenObjectList:\r |
47fea6af | 273 | for Package in Pa.PackageList:\r |
0d2711a6 LG |
274 | for Protocol in Package.Protocols:\r |
275 | GuidValue = GuidStructureStringToGuidString(Package.Protocols[Protocol])\r | |
276 | self._GuidDb[GuidValue.upper()] = Protocol\r | |
277 | for Ppi in Package.Ppis:\r | |
278 | GuidValue = GuidStructureStringToGuidString(Package.Ppis[Ppi])\r | |
279 | self._GuidDb[GuidValue.upper()] = Ppi\r | |
280 | for Guid in Package.Guids:\r | |
281 | GuidValue = GuidStructureStringToGuidString(Package.Guids[Guid])\r | |
282 | self._GuidDb[GuidValue.upper()] = Guid\r | |
a10def91 YF |
283 | for Ma in Pa.ModuleAutoGenList:\r |
284 | for Pcd in Ma.FixedVoidTypePcds:\r | |
285 | PcdValue = Ma.FixedVoidTypePcds[Pcd]\r | |
286 | if len(PcdValue.split(',')) == 16:\r | |
287 | GuidValue = GuidStructureByteArrayToGuidString(PcdValue)\r | |
288 | self._GuidDb[GuidValue.upper()] = Pcd\r | |
e56468c0 | 289 | ##\r |
290 | # Parse the binary dependency expression files.\r | |
f7496d71 | 291 | #\r |
e56468c0 | 292 | # This function parses the binary dependency expression file and translate it\r |
293 | # to the instruction list.\r | |
294 | #\r | |
295 | # @param self The object pointer\r | |
296 | # @param DepexFileName The file name of binary dependency expression file.\r | |
297 | #\r | |
298 | def ParseDepexFile(self, DepexFileName):\r | |
299 | DepexFile = open(DepexFileName, "rb")\r | |
300 | DepexStatement = []\r | |
301 | OpCode = DepexFile.read(1)\r | |
302 | while OpCode:\r | |
303 | Statement = gOpCodeList[struct.unpack("B", OpCode)[0]]\r | |
304 | if Statement in ["BEFORE", "AFTER", "PUSH"]:\r | |
305 | GuidValue = "%08X-%04X-%04X-%02X%02X-%02X%02X%02X%02X%02X%02X" % \\r | |
d0a0c52c | 306 | struct.unpack(PACK_PATTERN_GUID, DepexFile.read(16))\r |
e56468c0 | 307 | GuidString = self._GuidDb.get(GuidValue, GuidValue)\r |
308 | Statement = "%s %s" % (Statement, GuidString)\r | |
309 | DepexStatement.append(Statement)\r | |
47fea6af YZ |
310 | OpCode = DepexFile.read(1)\r |
311 | \r | |
e56468c0 | 312 | return DepexStatement\r |
f7496d71 | 313 | \r |
52302d4d LG |
314 | ##\r |
315 | # Reports library information\r | |
316 | #\r | |
317 | # This class reports the module library subsection in the build report file.\r | |
318 | #\r | |
319 | class LibraryReport(object):\r | |
320 | ##\r | |
321 | # Constructor function for class LibraryReport\r | |
322 | #\r | |
323 | # This constructor function generates LibraryReport object for\r | |
324 | # a module.\r | |
325 | #\r | |
326 | # @param self The object pointer\r | |
327 | # @param M Module context information\r | |
328 | #\r | |
329 | def __init__(self, M):\r | |
330 | self.LibraryList = []\r | |
331 | if int(str(M.AutoGenVersion), 0) >= 0x00010005:\r | |
332 | self._EdkIIModule = True\r | |
333 | else:\r | |
334 | self._EdkIIModule = False\r | |
335 | \r | |
336 | for Lib in M.DependentLibraryList:\r | |
337 | LibInfPath = str(Lib)\r | |
338 | LibClassList = Lib.LibraryClass[0].LibraryClass\r | |
339 | LibConstructorList = Lib.ConstructorList\r | |
340 | LibDesstructorList = Lib.DestructorList\r | |
341 | LibDepexList = Lib.DepexExpression[M.Arch, M.ModuleType]\r | |
1b8eca8b YZ |
342 | for LibAutoGen in M.LibraryAutoGenList:\r |
343 | if LibInfPath == LibAutoGen.MetaFile.Path:\r | |
344 | LibTime = LibAutoGen.BuildTime\r | |
345 | break\r | |
346 | self.LibraryList.append((LibInfPath, LibClassList, LibConstructorList, LibDesstructorList, LibDepexList, LibTime))\r | |
52302d4d LG |
347 | \r |
348 | ##\r | |
349 | # Generate report for module library information\r | |
350 | #\r | |
351 | # This function generates report for the module library.\r | |
352 | # If the module is EDKII style one, the additional library class, library\r | |
353 | # constructor/destructor and dependency expression may also be reported.\r | |
354 | #\r | |
355 | # @param self The object pointer\r | |
356 | # @param File The file object for report\r | |
357 | #\r | |
358 | def GenerateReport(self, File):\r | |
52302d4d | 359 | if len(self.LibraryList) > 0:\r |
c2d0a1f6 YZ |
360 | FileWrite(File, gSubSectionStart)\r |
361 | FileWrite(File, TAB_BRG_LIBRARY)\r | |
52302d4d LG |
362 | FileWrite(File, gSubSectionSep)\r |
363 | for LibraryItem in self.LibraryList:\r | |
364 | LibInfPath = LibraryItem[0]\r | |
365 | FileWrite(File, LibInfPath)\r | |
366 | \r | |
367 | #\r | |
368 | # Report library class, library constructor and destructor for\r | |
369 | # EDKII style module.\r | |
370 | #\r | |
371 | if self._EdkIIModule:\r | |
372 | LibClass = LibraryItem[1]\r | |
373 | EdkIILibInfo = ""\r | |
374 | LibConstructor = " ".join(LibraryItem[2])\r | |
375 | if LibConstructor:\r | |
376 | EdkIILibInfo += " C = " + LibConstructor\r | |
377 | LibDestructor = " ".join(LibraryItem[3])\r | |
378 | if LibDestructor:\r | |
636f2be6 | 379 | EdkIILibInfo += " D = " + LibDestructor\r |
52302d4d LG |
380 | LibDepex = " ".join(LibraryItem[4])\r |
381 | if LibDepex:\r | |
382 | EdkIILibInfo += " Depex = " + LibDepex\r | |
1b8eca8b YZ |
383 | if LibraryItem[5]:\r |
384 | EdkIILibInfo += " Time = " + LibraryItem[5]\r | |
52302d4d LG |
385 | if EdkIILibInfo:\r |
386 | FileWrite(File, "{%s: %s}" % (LibClass, EdkIILibInfo))\r | |
387 | else:\r | |
388 | FileWrite(File, "{%s}" % LibClass)\r | |
389 | \r | |
c2d0a1f6 | 390 | FileWrite(File, gSubSectionEnd)\r |
52302d4d LG |
391 | \r |
392 | ##\r | |
393 | # Reports dependency expression information\r | |
394 | #\r | |
395 | # This class reports the module dependency expression subsection in the build report file.\r | |
396 | #\r | |
397 | class DepexReport(object):\r | |
398 | ##\r | |
399 | # Constructor function for class DepexReport\r | |
400 | #\r | |
401 | # This constructor function generates DepexReport object for\r | |
402 | # a module. If the module source contains the DXS file (usually EDK\r | |
403 | # style module), it uses the dependency in DXS file; otherwise,\r | |
404 | # it uses the dependency expression from its own INF [Depex] section\r | |
405 | # and then merges with the ones from its dependent library INF.\r | |
406 | #\r | |
407 | # @param self The object pointer\r | |
408 | # @param M Module context information\r | |
409 | #\r | |
410 | def __init__(self, M):\r | |
411 | self.Depex = ""\r | |
47fea6af | 412 | self._DepexFileName = os.path.join(M.BuildDir, "OUTPUT", M.Module.BaseName + ".depex")\r |
52302d4d LG |
413 | ModuleType = M.ModuleType\r |
414 | if not ModuleType:\r | |
ee1ca53d | 415 | ModuleType = COMPONENT_TO_MODULE_MAP_DICT.get(M.ComponentType, "")\r |
636f2be6 | 416 | \r |
8bb63e37 | 417 | if ModuleType in [SUP_MODULE_SEC, SUP_MODULE_PEI_CORE, SUP_MODULE_DXE_CORE, SUP_MODULE_SMM_CORE, SUP_MODULE_MM_CORE_STANDALONE, SUP_MODULE_UEFI_APPLICATION]:\r |
52302d4d | 418 | return\r |
f7496d71 | 419 | \r |
52302d4d LG |
420 | for Source in M.SourceFileList:\r |
421 | if os.path.splitext(Source.Path)[1].lower() == ".dxs":\r | |
422 | Match = gDxsDependencyPattern.search(open(Source.Path).read())\r | |
423 | if Match:\r | |
424 | self.Depex = Match.group(1).strip()\r | |
425 | self.Source = "DXS"\r | |
426 | break\r | |
427 | else:\r | |
caf74495 | 428 | self.Depex = M.DepexExpressionDict.get(M.ModuleType, "")\r |
52302d4d LG |
429 | self.ModuleDepex = " ".join(M.Module.DepexExpression[M.Arch, M.ModuleType])\r |
430 | if not self.ModuleDepex:\r | |
431 | self.ModuleDepex = "(None)"\r | |
432 | \r | |
433 | LibDepexList = []\r | |
434 | for Lib in M.DependentLibraryList:\r | |
435 | LibDepex = " ".join(Lib.DepexExpression[M.Arch, M.ModuleType]).strip()\r | |
436 | if LibDepex != "":\r | |
437 | LibDepexList.append("(" + LibDepex + ")")\r | |
438 | self.LibraryDepex = " AND ".join(LibDepexList)\r | |
439 | if not self.LibraryDepex:\r | |
440 | self.LibraryDepex = "(None)"\r | |
441 | self.Source = "INF"\r | |
442 | \r | |
443 | ##\r | |
444 | # Generate report for module dependency expression information\r | |
445 | #\r | |
446 | # This function generates report for the module dependency expression.\r | |
447 | #\r | |
e56468c0 | 448 | # @param self The object pointer\r |
449 | # @param File The file object for report\r | |
450 | # @param GlobalDepexParser The platform global Dependency expression parser object\r | |
52302d4d | 451 | #\r |
e56468c0 | 452 | def GenerateReport(self, File, GlobalDepexParser):\r |
52302d4d LG |
453 | if not self.Depex:\r |
454 | return\r | |
52302d4d | 455 | FileWrite(File, gSubSectionStart)\r |
e56468c0 | 456 | if os.path.isfile(self._DepexFileName):\r |
457 | try:\r | |
458 | DepexStatements = GlobalDepexParser.ParseDepexFile(self._DepexFileName)\r | |
459 | FileWrite(File, "Final Dependency Expression (DEPEX) Instructions")\r | |
460 | for DepexStatement in DepexStatements:\r | |
461 | FileWrite(File, " %s" % DepexStatement)\r | |
462 | FileWrite(File, gSubSectionSep)\r | |
463 | except:\r | |
464 | EdkLogger.warn(None, "Dependency expression file is corrupted", self._DepexFileName)\r | |
f7496d71 | 465 | \r |
52302d4d LG |
466 | FileWrite(File, "Dependency Expression (DEPEX) from %s" % self.Source)\r |
467 | \r | |
468 | if self.Source == "INF":\r | |
caf74495 | 469 | FileWrite(File, self.Depex, True)\r |
52302d4d LG |
470 | FileWrite(File, gSubSectionSep)\r |
471 | FileWrite(File, "From Module INF: %s" % self.ModuleDepex, True)\r | |
472 | FileWrite(File, "From Library INF: %s" % self.LibraryDepex, True)\r | |
473 | else:\r | |
caf74495 | 474 | FileWrite(File, self.Depex)\r |
52302d4d LG |
475 | FileWrite(File, gSubSectionEnd)\r |
476 | \r | |
477 | ##\r | |
478 | # Reports dependency expression information\r | |
479 | #\r | |
480 | # This class reports the module build flags subsection in the build report file.\r | |
481 | #\r | |
482 | class BuildFlagsReport(object):\r | |
483 | ##\r | |
484 | # Constructor function for class BuildFlagsReport\r | |
485 | #\r | |
486 | # This constructor function generates BuildFlagsReport object for\r | |
487 | # a module. It reports the build tool chain tag and all relevant\r | |
488 | # build flags to build the module.\r | |
489 | #\r | |
490 | # @param self The object pointer\r | |
491 | # @param M Module context information\r | |
492 | #\r | |
493 | def __init__(self, M):\r | |
494 | BuildOptions = {}\r | |
495 | #\r | |
496 | # Add build flags according to source file extension so that\r | |
497 | # irrelevant ones can be filtered out.\r | |
498 | #\r | |
499 | for Source in M.SourceFileList:\r | |
500 | Ext = os.path.splitext(Source.File)[1].lower()\r | |
501 | if Ext in [".c", ".cc", ".cpp"]:\r | |
502 | BuildOptions["CC"] = 1\r | |
503 | elif Ext in [".s", ".asm"]:\r | |
504 | BuildOptions["PP"] = 1\r | |
505 | BuildOptions["ASM"] = 1\r | |
506 | elif Ext in [".vfr"]:\r | |
507 | BuildOptions["VFRPP"] = 1\r | |
508 | BuildOptions["VFR"] = 1\r | |
509 | elif Ext in [".dxs"]:\r | |
510 | BuildOptions["APP"] = 1\r | |
511 | BuildOptions["CC"] = 1\r | |
512 | elif Ext in [".asl"]:\r | |
513 | BuildOptions["ASLPP"] = 1\r | |
514 | BuildOptions["ASL"] = 1\r | |
515 | elif Ext in [".aslc"]:\r | |
516 | BuildOptions["ASLCC"] = 1\r | |
517 | BuildOptions["ASLDLINK"] = 1\r | |
518 | BuildOptions["CC"] = 1\r | |
519 | elif Ext in [".asm16"]:\r | |
520 | BuildOptions["ASMLINK"] = 1\r | |
521 | BuildOptions["SLINK"] = 1\r | |
522 | BuildOptions["DLINK"] = 1\r | |
523 | \r | |
524 | #\r | |
525 | # Save module build flags.\r | |
526 | #\r | |
527 | self.ToolChainTag = M.ToolChain\r | |
528 | self.BuildFlags = {}\r | |
529 | for Tool in BuildOptions:\r | |
530 | self.BuildFlags[Tool + "_FLAGS"] = M.BuildOption.get(Tool, {}).get("FLAGS", "")\r | |
531 | \r | |
532 | ##\r | |
533 | # Generate report for module build flags information\r | |
534 | #\r | |
535 | # This function generates report for the module build flags expression.\r | |
536 | #\r | |
537 | # @param self The object pointer\r | |
538 | # @param File The file object for report\r | |
539 | #\r | |
540 | def GenerateReport(self, File):\r | |
541 | FileWrite(File, gSubSectionStart)\r | |
542 | FileWrite(File, "Build Flags")\r | |
543 | FileWrite(File, "Tool Chain Tag: %s" % self.ToolChainTag)\r | |
544 | for Tool in self.BuildFlags:\r | |
545 | FileWrite(File, gSubSectionSep)\r | |
546 | FileWrite(File, "%s = %s" % (Tool, self.BuildFlags[Tool]), True)\r | |
547 | \r | |
548 | FileWrite(File, gSubSectionEnd)\r | |
549 | \r | |
550 | \r | |
551 | ##\r | |
552 | # Reports individual module information\r | |
553 | #\r | |
554 | # This class reports the module section in the build report file.\r | |
555 | # It comprises of module summary, module PCD, library, dependency expression,\r | |
556 | # build flags sections.\r | |
557 | #\r | |
558 | class ModuleReport(object):\r | |
559 | ##\r | |
560 | # Constructor function for class ModuleReport\r | |
561 | #\r | |
562 | # This constructor function generates ModuleReport object for\r | |
563 | # a separate module in a platform build.\r | |
564 | #\r | |
565 | # @param self The object pointer\r | |
566 | # @param M Module context information\r | |
567 | # @param ReportType The kind of report items in the final report file\r | |
568 | #\r | |
569 | def __init__(self, M, ReportType):\r | |
570 | self.ModuleName = M.Module.BaseName\r | |
571 | self.ModuleInfPath = M.MetaFile.File\r | |
572 | self.FileGuid = M.Guid\r | |
573 | self.Size = 0\r | |
574 | self.BuildTimeStamp = None\r | |
eca5be7a | 575 | self.Hash = 0\r |
52302d4d | 576 | self.DriverType = ""\r |
636f2be6 LG |
577 | if not M.IsLibrary:\r |
578 | ModuleType = M.ModuleType\r | |
579 | if not ModuleType:\r | |
ee1ca53d | 580 | ModuleType = COMPONENT_TO_MODULE_MAP_DICT.get(M.ComponentType, "")\r |
636f2be6 LG |
581 | #\r |
582 | # If a module complies to PI 1.1, promote Module type to "SMM_DRIVER"\r | |
583 | #\r | |
8bb63e37 | 584 | if ModuleType == SUP_MODULE_DXE_SMM_DRIVER:\r |
47fea6af | 585 | PiSpec = M.Module.Specification.get("PI_SPECIFICATION_VERSION", "0x00010000")\r |
0d2711a6 | 586 | if int(PiSpec, 0) >= 0x0001000A:\r |
636f2be6 LG |
587 | ModuleType = "SMM_DRIVER"\r |
588 | self.DriverType = gDriverTypeMap.get(ModuleType, "0x2 (FREE_FORM)")\r | |
52302d4d LG |
589 | self.UefiSpecVersion = M.Module.Specification.get("UEFI_SPECIFICATION_VERSION", "")\r |
590 | self.PiSpecVersion = M.Module.Specification.get("PI_SPECIFICATION_VERSION", "")\r | |
591 | self.PciDeviceId = M.Module.Defines.get("PCI_DEVICE_ID", "")\r | |
592 | self.PciVendorId = M.Module.Defines.get("PCI_VENDOR_ID", "")\r | |
593 | self.PciClassCode = M.Module.Defines.get("PCI_CLASS_CODE", "")\r | |
1b8eca8b | 594 | self.BuildTime = M.BuildTime\r |
52302d4d LG |
595 | \r |
596 | self._BuildDir = M.BuildDir\r | |
597 | self.ModulePcdSet = {}\r | |
598 | if "PCD" in ReportType:\r | |
599 | #\r | |
600 | # Collect all module used PCD set: module INF referenced directly or indirectly.\r | |
601 | # It also saves module INF default values of them in case they exist.\r | |
602 | #\r | |
603 | for Pcd in M.ModulePcdList + M.LibraryPcdList:\r | |
604 | self.ModulePcdSet.setdefault((Pcd.TokenCName, Pcd.TokenSpaceGuidCName, Pcd.Type), (Pcd.InfDefaultValue, Pcd.DefaultValue))\r | |
605 | \r | |
606 | self.LibraryReport = None\r | |
607 | if "LIBRARY" in ReportType:\r | |
608 | self.LibraryReport = LibraryReport(M)\r | |
609 | \r | |
610 | self.DepexReport = None\r | |
611 | if "DEPEX" in ReportType:\r | |
612 | self.DepexReport = DepexReport(M)\r | |
613 | \r | |
614 | if "BUILD_FLAGS" in ReportType:\r | |
615 | self.BuildFlagsReport = BuildFlagsReport(M)\r | |
616 | \r | |
617 | \r | |
618 | ##\r | |
619 | # Generate report for module information\r | |
620 | #\r | |
621 | # This function generates report for separate module expression\r | |
622 | # in a platform build.\r | |
623 | #\r | |
e56468c0 | 624 | # @param self The object pointer\r |
625 | # @param File The file object for report\r | |
626 | # @param GlobalPcdReport The platform global PCD report object\r | |
627 | # @param GlobalPredictionReport The platform global Prediction report object\r | |
628 | # @param GlobalDepexParser The platform global Dependency expression parser object\r | |
629 | # @param ReportType The kind of report items in the final report file\r | |
52302d4d | 630 | #\r |
e56468c0 | 631 | def GenerateReport(self, File, GlobalPcdReport, GlobalPredictionReport, GlobalDepexParser, ReportType):\r |
52302d4d LG |
632 | FileWrite(File, gSectionStart)\r |
633 | \r | |
634 | FwReportFileName = os.path.join(self._BuildDir, "DEBUG", self.ModuleName + ".txt")\r | |
635 | if os.path.isfile(FwReportFileName):\r | |
636 | try:\r | |
637 | FileContents = open(FwReportFileName).read()\r | |
638 | Match = gModuleSizePattern.search(FileContents)\r | |
639 | if Match:\r | |
640 | self.Size = int(Match.group(1))\r | |
641 | \r | |
642 | Match = gTimeStampPattern.search(FileContents)\r | |
643 | if Match:\r | |
644 | self.BuildTimeStamp = datetime.fromtimestamp(int(Match.group(1)))\r | |
645 | except IOError:\r | |
646 | EdkLogger.warn(None, "Fail to read report file", FwReportFileName)\r | |
647 | \r | |
eca5be7a YZ |
648 | if "HASH" in ReportType:\r |
649 | OutputDir = os.path.join(self._BuildDir, "OUTPUT")\r | |
650 | DefaultEFIfile = os.path.join(OutputDir, self.ModuleName + ".efi")\r | |
651 | if os.path.isfile(DefaultEFIfile):\r | |
652 | Tempfile = os.path.join(OutputDir, self.ModuleName + "_hash.tmp")\r | |
653 | # rebase the efi image since its base address may not zero\r | |
654 | cmd = ["GenFw", "--rebase", str(0), "-o", Tempfile, DefaultEFIfile]\r | |
655 | try:\r | |
656 | PopenObject = subprocess.Popen(' '.join(cmd), stdout=subprocess.PIPE, stderr=subprocess.PIPE, shell=True)\r | |
5b0671c1 | 657 | except Exception as X:\r |
eca5be7a YZ |
658 | EdkLogger.error("GenFw", COMMAND_FAILURE, ExtraData="%s: %s" % (str(X), cmd[0]))\r |
659 | EndOfProcedure = threading.Event()\r | |
660 | EndOfProcedure.clear()\r | |
661 | if PopenObject.stderr:\r | |
662 | StdErrThread = threading.Thread(target=ReadMessage, args=(PopenObject.stderr, EdkLogger.quiet, EndOfProcedure))\r | |
663 | StdErrThread.setName("STDERR-Redirector")\r | |
664 | StdErrThread.setDaemon(False)\r | |
665 | StdErrThread.start()\r | |
666 | # waiting for program exit\r | |
667 | PopenObject.wait()\r | |
668 | if PopenObject.stderr:\r | |
669 | StdErrThread.join()\r | |
670 | if PopenObject.returncode != 0:\r | |
671 | EdkLogger.error("GenFw", COMMAND_FAILURE, "Failed to generate firmware hash image for %s" % (DefaultEFIfile))\r | |
672 | if os.path.isfile(Tempfile):\r | |
673 | self.Hash = hashlib.sha1()\r | |
674 | buf = open(Tempfile, 'rb').read()\r | |
675 | if self.Hash.update(buf):\r | |
676 | self.Hash = self.Hash.update(buf)\r | |
677 | self.Hash = self.Hash.hexdigest()\r | |
678 | os.remove(Tempfile)\r | |
679 | \r | |
52302d4d LG |
680 | FileWrite(File, "Module Summary")\r |
681 | FileWrite(File, "Module Name: %s" % self.ModuleName)\r | |
682 | FileWrite(File, "Module INF Path: %s" % self.ModuleInfPath)\r | |
683 | FileWrite(File, "File GUID: %s" % self.FileGuid)\r | |
684 | if self.Size:\r | |
685 | FileWrite(File, "Size: 0x%X (%.2fK)" % (self.Size, self.Size / 1024.0))\r | |
eca5be7a YZ |
686 | if self.Hash:\r |
687 | FileWrite(File, "SHA1 HASH: %s *%s" % (self.Hash, self.ModuleName + ".efi"))\r | |
52302d4d LG |
688 | if self.BuildTimeStamp:\r |
689 | FileWrite(File, "Build Time Stamp: %s" % self.BuildTimeStamp)\r | |
1b8eca8b YZ |
690 | if self.BuildTime:\r |
691 | FileWrite(File, "Module Build Time: %s" % self.BuildTime)\r | |
52302d4d LG |
692 | if self.DriverType:\r |
693 | FileWrite(File, "Driver Type: %s" % self.DriverType)\r | |
694 | if self.UefiSpecVersion:\r | |
695 | FileWrite(File, "UEFI Spec Version: %s" % self.UefiSpecVersion)\r | |
696 | if self.PiSpecVersion:\r | |
697 | FileWrite(File, "PI Spec Version: %s" % self.PiSpecVersion)\r | |
698 | if self.PciDeviceId:\r | |
699 | FileWrite(File, "PCI Device ID: %s" % self.PciDeviceId)\r | |
700 | if self.PciVendorId:\r | |
701 | FileWrite(File, "PCI Vendor ID: %s" % self.PciVendorId)\r | |
702 | if self.PciClassCode:\r | |
703 | FileWrite(File, "PCI Class Code: %s" % self.PciClassCode)\r | |
704 | \r | |
705 | FileWrite(File, gSectionSep)\r | |
706 | \r | |
707 | if "PCD" in ReportType:\r | |
708 | GlobalPcdReport.GenerateReport(File, self.ModulePcdSet)\r | |
709 | \r | |
710 | if "LIBRARY" in ReportType:\r | |
711 | self.LibraryReport.GenerateReport(File)\r | |
712 | \r | |
713 | if "DEPEX" in ReportType:\r | |
e56468c0 | 714 | self.DepexReport.GenerateReport(File, GlobalDepexParser)\r |
52302d4d LG |
715 | \r |
716 | if "BUILD_FLAGS" in ReportType:\r | |
717 | self.BuildFlagsReport.GenerateReport(File)\r | |
718 | \r | |
719 | if "FIXED_ADDRESS" in ReportType and self.FileGuid:\r | |
720 | GlobalPredictionReport.GenerateReport(File, self.FileGuid)\r | |
721 | \r | |
722 | FileWrite(File, gSectionEnd)\r | |
723 | \r | |
eca5be7a YZ |
724 | def ReadMessage(From, To, ExitFlag):\r |
725 | while True:\r | |
726 | # read one line a time\r | |
727 | Line = From.readline()\r | |
728 | # empty string means "end"\r | |
4231a819 | 729 | if Line is not None and Line != "":\r |
eca5be7a YZ |
730 | To(Line.rstrip())\r |
731 | else:\r | |
732 | break\r | |
733 | if ExitFlag.isSet():\r | |
734 | break\r | |
735 | \r | |
52302d4d LG |
736 | ##\r |
737 | # Reports platform and module PCD information\r | |
738 | #\r | |
739 | # This class reports the platform PCD section and module PCD subsection\r | |
740 | # in the build report file.\r | |
741 | #\r | |
742 | class PcdReport(object):\r | |
743 | ##\r | |
744 | # Constructor function for class PcdReport\r | |
745 | #\r | |
746 | # This constructor function generates PcdReport object a platform build.\r | |
747 | # It collects the whole PCD database from platform DSC files, platform\r | |
748 | # flash description file and package DEC files.\r | |
749 | #\r | |
750 | # @param self The object pointer\r | |
751 | # @param Wa Workspace context information\r | |
752 | #\r | |
753 | def __init__(self, Wa):\r | |
754 | self.AllPcds = {}\r | |
c8d07c5e YZ |
755 | self.UnusedPcds = {}\r |
756 | self.ConditionalPcds = {}\r | |
52302d4d | 757 | self.MaxLen = 0\r |
e651d06c | 758 | self.Arch = None\r |
52302d4d LG |
759 | if Wa.FdfProfile:\r |
760 | self.FdfPcdSet = Wa.FdfProfile.PcdDict\r | |
761 | else:\r | |
762 | self.FdfPcdSet = {}\r | |
763 | \r | |
779ddcdf YZ |
764 | self.DefaultStoreSingle = True\r |
765 | self.SkuSingle = True\r | |
766 | if GlobalData.gDefaultStores and len(GlobalData.gDefaultStores) > 1:\r | |
767 | self.DefaultStoreSingle = False\r | |
768 | if GlobalData.gSkuids and len(GlobalData.gSkuids) > 1:\r | |
769 | self.SkuSingle = False\r | |
770 | \r | |
52302d4d LG |
771 | self.ModulePcdOverride = {}\r |
772 | for Pa in Wa.AutoGenObjectList:\r | |
e651d06c | 773 | self.Arch = Pa.Arch\r |
52302d4d LG |
774 | #\r |
775 | # Collect all platform referenced PCDs and grouped them by PCD token space\r | |
776 | # GUID C Names\r | |
777 | #\r | |
778 | for Pcd in Pa.AllPcdList:\r | |
779 | PcdList = self.AllPcds.setdefault(Pcd.TokenSpaceGuidCName, {}).setdefault(Pcd.Type, [])\r | |
780 | if Pcd not in PcdList:\r | |
781 | PcdList.append(Pcd)\r | |
782 | if len(Pcd.TokenCName) > self.MaxLen:\r | |
783 | self.MaxLen = len(Pcd.TokenCName)\r | |
c8d07c5e YZ |
784 | #\r |
785 | # Collect the PCD defined in DSC/FDF file, but not used in module\r | |
786 | #\r | |
787 | UnusedPcdFullList = []\r | |
788 | for item in Pa.Platform.Pcds:\r | |
789 | Pcd = Pa.Platform.Pcds[item]\r | |
c65df5d9 YZ |
790 | if not Pcd.Type:\r |
791 | # check the Pcd in FDF file, whether it is used in module first\r | |
be409b67 | 792 | for T in PCD_TYPE_LIST:\r |
c65df5d9 YZ |
793 | PcdList = self.AllPcds.setdefault(Pcd.TokenSpaceGuidCName, {}).setdefault(T, [])\r |
794 | if Pcd in PcdList:\r | |
795 | Pcd.Type = T\r | |
796 | break\r | |
c8d07c5e YZ |
797 | if not Pcd.Type:\r |
798 | PcdTypeFlag = False\r | |
799 | for package in Pa.PackageList:\r | |
be409b67 | 800 | for T in PCD_TYPE_LIST:\r |
c8d07c5e YZ |
801 | if (Pcd.TokenCName, Pcd.TokenSpaceGuidCName, T) in package.Pcds:\r |
802 | Pcd.Type = T\r | |
803 | PcdTypeFlag = True\r | |
804 | if not Pcd.DatumType:\r | |
805 | Pcd.DatumType = package.Pcds[(Pcd.TokenCName, Pcd.TokenSpaceGuidCName, T)].DatumType\r | |
806 | break\r | |
807 | if PcdTypeFlag:\r | |
808 | break\r | |
809 | if not Pcd.DatumType:\r | |
810 | PcdType = Pcd.Type\r | |
811 | # Try to remove Hii and Vpd suffix\r | |
be409b67 CJ |
812 | if PcdType.startswith(TAB_PCDS_DYNAMIC_EX):\r |
813 | PcdType = TAB_PCDS_DYNAMIC_EX\r | |
814 | elif PcdType.startswith(TAB_PCDS_DYNAMIC):\r | |
815 | PcdType = TAB_PCDS_DYNAMIC\r | |
c8d07c5e YZ |
816 | for package in Pa.PackageList:\r |
817 | if (Pcd.TokenCName, Pcd.TokenSpaceGuidCName, PcdType) in package.Pcds:\r | |
818 | Pcd.DatumType = package.Pcds[(Pcd.TokenCName, Pcd.TokenSpaceGuidCName, PcdType)].DatumType\r | |
819 | break\r | |
820 | \r | |
821 | PcdList = self.AllPcds.setdefault(Pcd.TokenSpaceGuidCName, {}).setdefault(Pcd.Type, [])\r | |
822 | if Pcd not in PcdList and Pcd not in UnusedPcdFullList:\r | |
823 | UnusedPcdFullList.append(Pcd)\r | |
824 | if len(Pcd.TokenCName) > self.MaxLen:\r | |
825 | self.MaxLen = len(Pcd.TokenCName)\r | |
826 | \r | |
827 | if GlobalData.gConditionalPcds:\r | |
828 | for PcdItem in GlobalData.gConditionalPcds:\r | |
829 | if '.' in PcdItem:\r | |
830 | (TokenSpaceGuidCName, TokenCName) = PcdItem.split('.')\r | |
9eb87141 | 831 | if (TokenCName, TokenSpaceGuidCName) in Pa.Platform.Pcds:\r |
c8d07c5e YZ |
832 | Pcd = Pa.Platform.Pcds[(TokenCName, TokenSpaceGuidCName)]\r |
833 | PcdList = self.ConditionalPcds.setdefault(Pcd.TokenSpaceGuidCName, {}).setdefault(Pcd.Type, [])\r | |
834 | if Pcd not in PcdList:\r | |
835 | PcdList.append(Pcd)\r | |
836 | \r | |
837 | UnusedPcdList = []\r | |
838 | if UnusedPcdFullList:\r | |
839 | for Pcd in UnusedPcdFullList:\r | |
840 | if Pcd.TokenSpaceGuidCName + '.' + Pcd.TokenCName in GlobalData.gConditionalPcds:\r | |
841 | continue\r | |
842 | UnusedPcdList.append(Pcd)\r | |
843 | \r | |
844 | for Pcd in UnusedPcdList:\r | |
845 | PcdList = self.UnusedPcds.setdefault(Pcd.TokenSpaceGuidCName, {}).setdefault(Pcd.Type, [])\r | |
846 | if Pcd not in PcdList:\r | |
847 | PcdList.append(Pcd)\r | |
52302d4d LG |
848 | \r |
849 | for Module in Pa.Platform.Modules.values():\r | |
850 | #\r | |
851 | # Collect module override PCDs\r | |
852 | #\r | |
853 | for ModulePcd in Module.M.ModulePcdList + Module.M.LibraryPcdList:\r | |
854 | TokenCName = ModulePcd.TokenCName\r | |
855 | TokenSpaceGuid = ModulePcd.TokenSpaceGuidCName\r | |
856 | ModuleDefault = ModulePcd.DefaultValue\r | |
857 | ModulePath = os.path.basename(Module.M.MetaFile.File)\r | |
858 | self.ModulePcdOverride.setdefault((TokenCName, TokenSpaceGuid), {})[ModulePath] = ModuleDefault\r | |
859 | \r | |
860 | \r | |
861 | #\r | |
862 | # Collect PCD DEC default value.\r | |
863 | #\r | |
864 | self.DecPcdDefault = {}\r | |
726c501c | 865 | self._GuidDict = {}\r |
0d2711a6 LG |
866 | for Pa in Wa.AutoGenObjectList:\r |
867 | for Package in Pa.PackageList:\r | |
726c501c YZ |
868 | Guids = Package.Guids\r |
869 | self._GuidDict.update(Guids)\r | |
0d2711a6 LG |
870 | for (TokenCName, TokenSpaceGuidCName, DecType) in Package.Pcds:\r |
871 | DecDefaultValue = Package.Pcds[TokenCName, TokenSpaceGuidCName, DecType].DefaultValue\r | |
872 | self.DecPcdDefault.setdefault((TokenCName, TokenSpaceGuidCName, DecType), DecDefaultValue)\r | |
52302d4d LG |
873 | #\r |
874 | # Collect PCDs defined in DSC common section\r | |
875 | #\r | |
876 | self.DscPcdDefault = {}\r | |
e651d06c LG |
877 | for Pa in Wa.AutoGenObjectList:\r |
878 | for (TokenCName, TokenSpaceGuidCName) in Pa.Platform.Pcds:\r | |
643e8e4b | 879 | DscDefaultValue = Pa.Platform.Pcds[(TokenCName, TokenSpaceGuidCName)].DscDefaultValue\r |
40d841f6 LG |
880 | if DscDefaultValue:\r |
881 | self.DscPcdDefault[(TokenCName, TokenSpaceGuidCName)] = DscDefaultValue\r | |
52302d4d | 882 | \r |
c8d07c5e | 883 | def GenerateReport(self, File, ModulePcdSet):\r |
b91b8ee4 YZ |
884 | if not ModulePcdSet:\r |
885 | if self.ConditionalPcds:\r | |
886 | self.GenerateReportDetail(File, ModulePcdSet, 1)\r | |
887 | if self.UnusedPcds:\r | |
888 | self.GenerateReportDetail(File, ModulePcdSet, 2)\r | |
c8d07c5e YZ |
889 | self.GenerateReportDetail(File, ModulePcdSet)\r |
890 | \r | |
52302d4d LG |
891 | ##\r |
892 | # Generate report for PCD information\r | |
893 | #\r | |
894 | # This function generates report for separate module expression\r | |
895 | # in a platform build.\r | |
896 | #\r | |
897 | # @param self The object pointer\r | |
898 | # @param File The file object for report\r | |
899 | # @param ModulePcdSet Set of all PCDs referenced by module or None for\r | |
900 | # platform PCD report\r | |
c8d07c5e YZ |
901 | # @param ReportySubType 0 means platform/module PCD report, 1 means Conditional\r |
902 | # directives section report, 2 means Unused Pcds section report\r | |
52302d4d LG |
903 | # @param DscOverridePcds Module DSC override PCDs set\r |
904 | #\r | |
c8d07c5e YZ |
905 | def GenerateReportDetail(self, File, ModulePcdSet, ReportSubType = 0):\r |
906 | PcdDict = self.AllPcds\r | |
907 | if ReportSubType == 1:\r | |
908 | PcdDict = self.ConditionalPcds\r | |
909 | elif ReportSubType == 2:\r | |
910 | PcdDict = self.UnusedPcds\r | |
911 | \r | |
b91b8ee4 | 912 | if not ModulePcdSet:\r |
52302d4d | 913 | FileWrite(File, gSectionStart)\r |
c8d07c5e YZ |
914 | if ReportSubType == 1:\r |
915 | FileWrite(File, "Conditional Directives used by the build system")\r | |
916 | elif ReportSubType == 2:\r | |
917 | FileWrite(File, "PCDs not used by modules or in conditional directives")\r | |
918 | else:\r | |
919 | FileWrite(File, "Platform Configuration Database Report")\r | |
920 | \r | |
763e8edf | 921 | FileWrite(File, " *B - PCD override in the build option")\r |
52302d4d LG |
922 | FileWrite(File, " *P - Platform scoped PCD override in DSC file")\r |
923 | FileWrite(File, " *F - Platform scoped PCD override in FDF file")\r | |
c8d07c5e YZ |
924 | if not ReportSubType:\r |
925 | FileWrite(File, " *M - Module scoped PCD override")\r | |
52302d4d LG |
926 | FileWrite(File, gSectionSep)\r |
927 | else:\r | |
c2d0a1f6 | 928 | if not ReportSubType and ModulePcdSet:\r |
c8d07c5e YZ |
929 | #\r |
930 | # For module PCD sub-section\r | |
931 | #\r | |
932 | FileWrite(File, gSubSectionStart)\r | |
933 | FileWrite(File, TAB_BRG_PCD)\r | |
934 | FileWrite(File, gSubSectionSep)\r | |
238d9b5c | 935 | AllPcdDict = {}\r |
c8d07c5e | 936 | for Key in PcdDict:\r |
238d9b5c YF |
937 | AllPcdDict[Key] = {}\r |
938 | for Type in PcdDict[Key]:\r | |
939 | for Pcd in PcdDict[Key][Type]:\r | |
940 | AllPcdDict[Key][(Pcd.TokenCName, Type)] = Pcd\r | |
941 | for Key in sorted(AllPcdDict):\r | |
52302d4d LG |
942 | #\r |
943 | # Group PCD by their token space GUID C Name\r | |
944 | #\r | |
945 | First = True\r | |
238d9b5c | 946 | for PcdTokenCName, Type in sorted(AllPcdDict[Key]):\r |
52302d4d LG |
947 | #\r |
948 | # Group PCD by their usage type\r | |
949 | #\r | |
238d9b5c | 950 | Pcd = AllPcdDict[Key][(PcdTokenCName, Type)]\r |
52302d4d | 951 | TypeName, DecType = gPcdTypeMap.get(Type, ("", Type))\r |
238d9b5c YF |
952 | MixedPcdFlag = False\r |
953 | if GlobalData.MixedPcd:\r | |
954 | for PcdKey in GlobalData.MixedPcd:\r | |
955 | if (Pcd.TokenCName, Pcd.TokenSpaceGuidCName) in GlobalData.MixedPcd[PcdKey]:\r | |
956 | PcdTokenCName = PcdKey[0]\r | |
957 | MixedPcdFlag = True\r | |
958 | if MixedPcdFlag and not ModulePcdSet:\r | |
959 | continue\r | |
960 | #\r | |
961 | # Get PCD default value and their override relationship\r | |
962 | #\r | |
963 | DecDefaultValue = self.DecPcdDefault.get((Pcd.TokenCName, Pcd.TokenSpaceGuidCName, DecType))\r | |
964 | DscDefaultValue = self.DscPcdDefault.get((Pcd.TokenCName, Pcd.TokenSpaceGuidCName))\r | |
965 | DscDefaultValBak = DscDefaultValue\r | |
5df16ecb YF |
966 | Field = ''\r |
967 | for (CName, Guid, Field) in self.FdfPcdSet:\r | |
968 | if CName == PcdTokenCName and Guid == Key:\r | |
969 | DscDefaultValue = self.FdfPcdSet[(CName, Guid, Field)]\r | |
970 | break\r | |
238d9b5c YF |
971 | if DscDefaultValue != DscDefaultValBak:\r |
972 | try:\r | |
973 | DscDefaultValue = ValueExpressionEx(DscDefaultValue, Pcd.DatumType, self._GuidDict)(True)\r | |
5b0671c1 | 974 | except BadExpression as DscDefaultValue:\r |
238d9b5c YF |
975 | EdkLogger.error('BuildReport', FORMAT_INVALID, "PCD Value: %s, Type: %s" %(DscDefaultValue, Pcd.DatumType))\r |
976 | \r | |
977 | InfDefaultValue = None\r | |
978 | \r | |
979 | PcdValue = DecDefaultValue\r | |
980 | if DscDefaultValue:\r | |
981 | PcdValue = DscDefaultValue\r | |
5df16ecb | 982 | Pcd.DefaultValue = PcdValue\r |
238d9b5c YF |
983 | if ModulePcdSet is not None:\r |
984 | if (Pcd.TokenCName, Pcd.TokenSpaceGuidCName, Type) not in ModulePcdSet:\r | |
985 | continue\r | |
5df16ecb | 986 | InfDefaultValue, PcdValue = ModulePcdSet[Pcd.TokenCName, Pcd.TokenSpaceGuidCName, Type]\r |
238d9b5c | 987 | Pcd.DefaultValue = PcdValue\r |
5df16ecb YF |
988 | if InfDefaultValue == "":\r |
989 | InfDefaultValue = None\r | |
238d9b5c YF |
990 | \r |
991 | BuildOptionMatch = False\r | |
992 | if GlobalData.BuildOptionPcd:\r | |
993 | for pcd in GlobalData.BuildOptionPcd:\r | |
994 | if (Pcd.TokenSpaceGuidCName, Pcd.TokenCName) == (pcd[0], pcd[1]):\r | |
995 | if pcd[2]:\r | |
996 | continue\r | |
997 | PcdValue = pcd[3]\r | |
998 | Pcd.DefaultValue = PcdValue\r | |
999 | BuildOptionMatch = True\r | |
1000 | break\r | |
763e8edf | 1001 | \r |
238d9b5c YF |
1002 | if First:\r |
1003 | if ModulePcdSet is None:\r | |
1004 | FileWrite(File, "")\r | |
1005 | FileWrite(File, Key)\r | |
1006 | First = False\r | |
52302d4d LG |
1007 | \r |
1008 | \r | |
238d9b5c YF |
1009 | if Pcd.DatumType in TAB_PCD_CLEAN_NUMERIC_TYPES:\r |
1010 | PcdValueNumber = int(PcdValue.strip(), 0)\r | |
1011 | if DecDefaultValue is None:\r | |
1012 | DecMatch = True\r | |
1013 | else:\r | |
1014 | DecDefaultValueNumber = int(DecDefaultValue.strip(), 0)\r | |
1015 | DecMatch = (DecDefaultValueNumber == PcdValueNumber)\r | |
52302d4d | 1016 | \r |
238d9b5c YF |
1017 | if InfDefaultValue is None:\r |
1018 | InfMatch = True\r | |
1019 | else:\r | |
1020 | InfDefaultValueNumber = int(InfDefaultValue.strip(), 0)\r | |
1021 | InfMatch = (InfDefaultValueNumber == PcdValueNumber)\r | |
52302d4d | 1022 | \r |
238d9b5c YF |
1023 | if DscDefaultValue is None:\r |
1024 | DscMatch = True\r | |
52302d4d | 1025 | else:\r |
238d9b5c YF |
1026 | DscDefaultValueNumber = int(DscDefaultValue.strip(), 0)\r |
1027 | DscMatch = (DscDefaultValueNumber == PcdValueNumber)\r | |
1028 | else:\r | |
1029 | if DecDefaultValue is None:\r | |
1030 | DecMatch = True\r | |
1031 | else:\r | |
1032 | DecMatch = (DecDefaultValue.strip() == PcdValue.strip())\r | |
52302d4d | 1033 | \r |
238d9b5c YF |
1034 | if InfDefaultValue is None:\r |
1035 | InfMatch = True\r | |
1036 | else:\r | |
1037 | InfMatch = (InfDefaultValue.strip() == PcdValue.strip())\r | |
52302d4d | 1038 | \r |
238d9b5c YF |
1039 | if DscDefaultValue is None:\r |
1040 | DscMatch = True\r | |
1041 | else:\r | |
1042 | DscMatch = (DscDefaultValue.strip() == PcdValue.strip())\r | |
1043 | \r | |
1044 | IsStructure = False\r | |
1045 | if GlobalData.gStructurePcd and (self.Arch in GlobalData.gStructurePcd) and ((Pcd.TokenCName, Pcd.TokenSpaceGuidCName) in GlobalData.gStructurePcd[self.Arch]):\r | |
1046 | IsStructure = True\r | |
1047 | if TypeName in ('DYNVPD', 'DEXVPD'):\r | |
1048 | SkuInfoList = Pcd.SkuInfoList\r | |
1049 | Pcd = GlobalData.gStructurePcd[self.Arch][(Pcd.TokenCName, Pcd.TokenSpaceGuidCName)]\r | |
1050 | Pcd.DatumType = Pcd.StructName\r | |
1051 | if TypeName in ('DYNVPD', 'DEXVPD'):\r | |
1052 | Pcd.SkuInfoList = SkuInfoList\r | |
1053 | if Pcd.PcdFieldValueFromComm:\r | |
1054 | BuildOptionMatch = True\r | |
1055 | DecMatch = False\r | |
1056 | elif Pcd.SkuOverrideValues:\r | |
1057 | DscOverride = False\r | |
1058 | if not Pcd.SkuInfoList:\r | |
1059 | OverrideValues = Pcd.SkuOverrideValues\r | |
1060 | if OverrideValues:\r | |
1061 | Keys = OverrideValues.keys()\r | |
1062 | Data = OverrideValues[Keys[0]]\r | |
1063 | Struct = Data.values()[0]\r | |
1064 | DscOverride = self.ParseStruct(Struct)\r | |
52302d4d | 1065 | else:\r |
238d9b5c YF |
1066 | SkuList = sorted(Pcd.SkuInfoList.keys())\r |
1067 | for Sku in SkuList:\r | |
1068 | SkuInfo = Pcd.SkuInfoList[Sku]\r | |
1069 | if TypeName in ('DYNHII', 'DEXHII'):\r | |
1070 | if SkuInfo.DefaultStoreDict:\r | |
1071 | DefaultStoreList = sorted(SkuInfo.DefaultStoreDict.keys())\r | |
1072 | for DefaultStore in DefaultStoreList:\r | |
1073 | OverrideValues = Pcd.SkuOverrideValues[Sku]\r | |
1074 | DscOverride = self.ParseStruct(OverrideValues[DefaultStore])\r | |
1075 | if DscOverride:\r | |
1076 | break\r | |
1077 | else:\r | |
1078 | OverrideValues = Pcd.SkuOverrideValues[Sku]\r | |
1079 | if OverrideValues:\r | |
1080 | Keys = OverrideValues.keys()\r | |
1081 | OverrideFieldStruct = self.OverrideFieldValue(Pcd, OverrideValues[Keys[0]])\r | |
1082 | DscOverride = self.ParseStruct(OverrideFieldStruct)\r | |
1083 | if DscOverride:\r | |
1084 | break\r | |
1085 | if DscOverride:\r | |
39f0156f | 1086 | DscDefaultValue = True\r |
238d9b5c | 1087 | DscMatch = True\r |
e651d06c | 1088 | DecMatch = False\r |
39f0156f YF |
1089 | else:\r |
1090 | DscDefaultValue = True\r | |
1091 | DscMatch = True\r | |
1092 | DecMatch = False\r | |
238d9b5c YF |
1093 | \r |
1094 | #\r | |
1095 | # Report PCD item according to their override relationship\r | |
1096 | #\r | |
5df16ecb | 1097 | if DecMatch:\r |
238d9b5c | 1098 | self.PrintPcdValue(File, Pcd, PcdTokenCName, TypeName, IsStructure, DscMatch, DscDefaultValBak, InfMatch, InfDefaultValue, DecMatch, DecDefaultValue, ' ')\r |
5df16ecb YF |
1099 | elif InfDefaultValue and InfMatch:\r |
1100 | self.PrintPcdValue(File, Pcd, PcdTokenCName, TypeName, IsStructure, DscMatch, DscDefaultValBak, InfMatch, InfDefaultValue, DecMatch, DecDefaultValue, '*M')\r | |
238d9b5c YF |
1101 | elif BuildOptionMatch:\r |
1102 | self.PrintPcdValue(File, Pcd, PcdTokenCName, TypeName, IsStructure, DscMatch, DscDefaultValBak, InfMatch, InfDefaultValue, DecMatch, DecDefaultValue, '*B')\r | |
1103 | else:\r | |
5df16ecb YF |
1104 | if DscDefaultValue and DscMatch:\r |
1105 | if (Pcd.TokenCName, Key, Field) in self.FdfPcdSet:\r | |
238d9b5c | 1106 | self.PrintPcdValue(File, Pcd, PcdTokenCName, TypeName, IsStructure, DscMatch, DscDefaultValBak, InfMatch, InfDefaultValue, DecMatch, DecDefaultValue, '*F')\r |
52302d4d | 1107 | else:\r |
238d9b5c YF |
1108 | self.PrintPcdValue(File, Pcd, PcdTokenCName, TypeName, IsStructure, DscMatch, DscDefaultValBak, InfMatch, InfDefaultValue, DecMatch, DecDefaultValue, '*P')\r |
1109 | else:\r | |
1110 | self.PrintPcdValue(File, Pcd, PcdTokenCName, TypeName, IsStructure, DscMatch, DscDefaultValBak, InfMatch, InfDefaultValue, DecMatch, DecDefaultValue, '*M')\r | |
52302d4d | 1111 | \r |
238d9b5c YF |
1112 | if ModulePcdSet is None:\r |
1113 | if IsStructure:\r | |
1114 | continue\r | |
1115 | if not TypeName in ('PATCH', 'FLAG', 'FIXED'):\r | |
1116 | continue\r | |
1117 | if not BuildOptionMatch:\r | |
1118 | ModuleOverride = self.ModulePcdOverride.get((Pcd.TokenCName, Pcd.TokenSpaceGuidCName), {})\r | |
1119 | for ModulePath in ModuleOverride:\r | |
1120 | ModuleDefault = ModuleOverride[ModulePath]\r | |
1121 | if Pcd.DatumType in TAB_PCD_CLEAN_NUMERIC_TYPES:\r | |
1122 | ModulePcdDefaultValueNumber = int(ModuleDefault.strip(), 0)\r | |
1123 | Match = (ModulePcdDefaultValueNumber == PcdValueNumber)\r | |
1124 | else:\r | |
1125 | Match = (ModuleDefault.strip() == PcdValue.strip())\r | |
1126 | if Match:\r | |
1127 | continue\r | |
1128 | IsByteArray, ArrayList = ByteArrayForamt(ModuleDefault.strip())\r | |
1129 | if IsByteArray:\r | |
1130 | FileWrite(File, ' *M %-*s = %s' % (self.MaxLen + 15, ModulePath, '{'))\r | |
1131 | for Array in ArrayList:\r | |
caf74495 | 1132 | FileWrite(File, Array)\r |
238d9b5c | 1133 | else:\r |
cef7ecf6 YF |
1134 | Value = ModuleDefault.strip()\r |
1135 | if Pcd.DatumType in TAB_PCD_CLEAN_NUMERIC_TYPES:\r | |
1136 | if Value.startswith(('0x', '0X')):\r | |
1137 | Value = '{} ({:d})'.format(Value, int(Value, 0))\r | |
1138 | else:\r | |
1139 | Value = "0x{:X} ({})".format(int(Value, 0), Value)\r | |
1140 | FileWrite(File, ' *M %-*s = %s' % (self.MaxLen + 15, ModulePath, Value))\r | |
52302d4d | 1141 | \r |
4231a819 | 1142 | if ModulePcdSet is None:\r |
52302d4d LG |
1143 | FileWrite(File, gSectionEnd)\r |
1144 | else:\r | |
c2d0a1f6 | 1145 | if not ReportSubType and ModulePcdSet:\r |
c8d07c5e | 1146 | FileWrite(File, gSubSectionEnd)\r |
52302d4d | 1147 | \r |
24326f38 YZ |
1148 | def ParseStruct(self, struct):\r |
1149 | HasDscOverride = False\r | |
1150 | if struct:\r | |
1151 | for _, Values in struct.items():\r | |
1152 | if Values[1] and Values[1].endswith('.dsc'):\r | |
1153 | HasDscOverride = True\r | |
1154 | break\r | |
1155 | return HasDscOverride\r | |
52302d4d | 1156 | \r |
e651d06c | 1157 | def PrintPcdDefault(self, File, Pcd, IsStructure, DscMatch, DscDefaultValue, InfMatch, InfDefaultValue, DecMatch, DecDefaultValue):\r |
4231a819 | 1158 | if not DscMatch and DscDefaultValue is not None:\r |
e651d06c LG |
1159 | Value = DscDefaultValue.strip()\r |
1160 | IsByteArray, ArrayList = ByteArrayForamt(Value)\r | |
1161 | if IsByteArray:\r | |
1162 | FileWrite(File, ' %*s = %s' % (self.MaxLen + 19, 'DSC DEFAULT', "{"))\r | |
1163 | for Array in ArrayList:\r | |
caf74495 | 1164 | FileWrite(File, Array)\r |
e651d06c | 1165 | else:\r |
179c2f97 YF |
1166 | if Pcd.DatumType in TAB_PCD_CLEAN_NUMERIC_TYPES:\r |
1167 | if Value.startswith(('0x', '0X')):\r | |
1168 | Value = '{} ({:d})'.format(Value, int(Value, 0))\r | |
1169 | else:\r | |
1170 | Value = "0x{:X} ({})".format(int(Value, 0), Value)\r | |
e651d06c | 1171 | FileWrite(File, ' %*s = %s' % (self.MaxLen + 19, 'DSC DEFAULT', Value))\r |
4231a819 | 1172 | if not InfMatch and InfDefaultValue is not None:\r |
e651d06c LG |
1173 | Value = InfDefaultValue.strip()\r |
1174 | IsByteArray, ArrayList = ByteArrayForamt(Value)\r | |
1175 | if IsByteArray:\r | |
1176 | FileWrite(File, ' %*s = %s' % (self.MaxLen + 19, 'INF DEFAULT', "{"))\r | |
1177 | for Array in ArrayList:\r | |
caf74495 | 1178 | FileWrite(File, Array)\r |
e651d06c | 1179 | else:\r |
179c2f97 YF |
1180 | if Pcd.DatumType in TAB_PCD_CLEAN_NUMERIC_TYPES:\r |
1181 | if Value.startswith(('0x', '0X')):\r | |
1182 | Value = '{} ({:d})'.format(Value, int(Value, 0))\r | |
1183 | else:\r | |
1184 | Value = "0x{:X} ({})".format(int(Value, 0), Value)\r | |
e651d06c LG |
1185 | FileWrite(File, ' %*s = %s' % (self.MaxLen + 19, 'INF DEFAULT', Value))\r |
1186 | \r | |
4231a819 | 1187 | if not DecMatch and DecDefaultValue is not None:\r |
e651d06c LG |
1188 | Value = DecDefaultValue.strip()\r |
1189 | IsByteArray, ArrayList = ByteArrayForamt(Value)\r | |
1190 | if IsByteArray:\r | |
1191 | FileWrite(File, ' %*s = %s' % (self.MaxLen + 19, 'DEC DEFAULT', "{"))\r | |
1192 | for Array in ArrayList:\r | |
caf74495 | 1193 | FileWrite(File, Array)\r |
e651d06c | 1194 | else:\r |
179c2f97 YF |
1195 | if Pcd.DatumType in TAB_PCD_CLEAN_NUMERIC_TYPES:\r |
1196 | if Value.startswith(('0x', '0X')):\r | |
1197 | Value = '{} ({:d})'.format(Value, int(Value, 0))\r | |
1198 | else:\r | |
1199 | Value = "0x{:X} ({})".format(int(Value, 0), Value)\r | |
e651d06c LG |
1200 | FileWrite(File, ' %*s = %s' % (self.MaxLen + 19, 'DEC DEFAULT', Value))\r |
1201 | if IsStructure:\r | |
1202 | self.PrintStructureInfo(File, Pcd.DefaultValues)\r | |
24326f38 YZ |
1203 | if DecMatch and IsStructure:\r |
1204 | self.PrintStructureInfo(File, Pcd.DefaultValues)\r | |
e651d06c LG |
1205 | \r |
1206 | def PrintPcdValue(self, File, Pcd, PcdTokenCName, TypeName, IsStructure, DscMatch, DscDefaultValue, InfMatch, InfDefaultValue, DecMatch, DecDefaultValue, Flag = ' '):\r | |
1207 | if not Pcd.SkuInfoList:\r | |
1208 | Value = Pcd.DefaultValue\r | |
1209 | IsByteArray, ArrayList = ByteArrayForamt(Value)\r | |
1210 | if IsByteArray:\r | |
1211 | FileWrite(File, ' %-*s : %6s %10s = %s' % (self.MaxLen, Flag + ' ' + PcdTokenCName, TypeName, '(' + Pcd.DatumType + ')', '{'))\r | |
1212 | for Array in ArrayList:\r | |
caf74495 | 1213 | FileWrite(File, Array)\r |
e651d06c | 1214 | else:\r |
179c2f97 | 1215 | if Pcd.DatumType in TAB_PCD_CLEAN_NUMERIC_TYPES:\r |
ccaa7754 | 1216 | if Value.startswith(('0x', '0X')):\r |
179c2f97 YF |
1217 | Value = '{} ({:d})'.format(Value, int(Value, 0))\r |
1218 | else:\r | |
1219 | Value = "0x{:X} ({})".format(int(Value, 0), Value)\r | |
e651d06c LG |
1220 | FileWrite(File, ' %-*s : %6s %10s = %s' % (self.MaxLen, Flag + ' ' + PcdTokenCName, TypeName, '(' + Pcd.DatumType + ')', Value))\r |
1221 | if IsStructure:\r | |
65eff519 | 1222 | OverrideValues = Pcd.SkuOverrideValues\r |
e651d06c LG |
1223 | if OverrideValues:\r |
1224 | Keys = OverrideValues.keys()\r | |
1225 | Data = OverrideValues[Keys[0]]\r | |
1226 | Struct = Data.values()[0]\r | |
24326f38 YZ |
1227 | OverrideFieldStruct = self.OverrideFieldValue(Pcd, Struct)\r |
1228 | self.PrintStructureInfo(File, OverrideFieldStruct)\r | |
e651d06c LG |
1229 | self.PrintPcdDefault(File, Pcd, IsStructure, DscMatch, DscDefaultValue, InfMatch, InfDefaultValue, DecMatch, DecDefaultValue)\r |
1230 | else:\r | |
1231 | FirstPrint = True\r | |
1232 | SkuList = sorted(Pcd.SkuInfoList.keys())\r | |
1233 | for Sku in SkuList:\r | |
1234 | SkuInfo = Pcd.SkuInfoList[Sku]\r | |
779ddcdf | 1235 | SkuIdName = SkuInfo.SkuIdName\r |
e651d06c LG |
1236 | if TypeName in ('DYNHII', 'DEXHII'):\r |
1237 | if SkuInfo.DefaultStoreDict:\r | |
1238 | DefaultStoreList = sorted(SkuInfo.DefaultStoreDict.keys())\r | |
1239 | for DefaultStore in DefaultStoreList:\r | |
1240 | Value = SkuInfo.DefaultStoreDict[DefaultStore]\r | |
1241 | IsByteArray, ArrayList = ByteArrayForamt(Value)\r | |
1242 | if FirstPrint:\r | |
1243 | FirstPrint = False\r | |
1244 | if IsByteArray:\r | |
779ddcdf YZ |
1245 | if self.DefaultStoreSingle and self.SkuSingle:\r |
1246 | FileWrite(File, ' %-*s : %6s %10s = %s' % (self.MaxLen, Flag + ' ' + PcdTokenCName, TypeName, '(' + Pcd.DatumType + ')', '{'))\r | |
1247 | elif self.DefaultStoreSingle and not self.SkuSingle:\r | |
1248 | FileWrite(File, ' %-*s : %6s %10s %10s = %s' % (self.MaxLen, Flag + ' ' + PcdTokenCName, TypeName, '(' + Pcd.DatumType + ')', '(' + SkuIdName + ')', '{'))\r | |
1249 | elif not self.DefaultStoreSingle and self.SkuSingle:\r | |
1250 | FileWrite(File, ' %-*s : %6s %10s %10s = %s' % (self.MaxLen, Flag + ' ' + PcdTokenCName, TypeName, '(' + Pcd.DatumType + ')', '(' + DefaultStore + ')', '{'))\r | |
1251 | else:\r | |
1252 | FileWrite(File, ' %-*s : %6s %10s %10s %10s = %s' % (self.MaxLen, Flag + ' ' + PcdTokenCName, TypeName, '(' + Pcd.DatumType + ')', '(' + SkuIdName + ')', '(' + DefaultStore + ')', '{'))\r | |
e651d06c | 1253 | for Array in ArrayList:\r |
caf74495 | 1254 | FileWrite(File, Array)\r |
e651d06c | 1255 | else:\r |
179c2f97 YF |
1256 | if Pcd.DatumType in TAB_PCD_CLEAN_NUMERIC_TYPES:\r |
1257 | if Value.startswith(('0x', '0X')):\r | |
1258 | Value = '{} ({:d})'.format(Value, int(Value, 0))\r | |
1259 | else:\r | |
1260 | Value = "0x{:X} ({})".format(int(Value, 0), Value)\r | |
779ddcdf YZ |
1261 | if self.DefaultStoreSingle and self.SkuSingle:\r |
1262 | FileWrite(File, ' %-*s : %6s %10s = %s' % (self.MaxLen, Flag + ' ' + PcdTokenCName, TypeName, '(' + Pcd.DatumType + ')', Value))\r | |
1263 | elif self.DefaultStoreSingle and not self.SkuSingle:\r | |
1264 | FileWrite(File, ' %-*s : %6s %10s %10s = %s' % (self.MaxLen, Flag + ' ' + PcdTokenCName, TypeName, '(' + Pcd.DatumType + ')', '(' + SkuIdName + ')', Value))\r | |
1265 | elif not self.DefaultStoreSingle and self.SkuSingle:\r | |
1266 | FileWrite(File, ' %-*s : %6s %10s %10s = %s' % (self.MaxLen, Flag + ' ' + PcdTokenCName, TypeName, '(' + Pcd.DatumType + ')', '(' + DefaultStore + ')', Value))\r | |
1267 | else:\r | |
1268 | FileWrite(File, ' %-*s : %6s %10s %10s %10s = %s' % (self.MaxLen, Flag + ' ' + PcdTokenCName, TypeName, '(' + Pcd.DatumType + ')', '(' + SkuIdName + ')', '(' + DefaultStore + ')', Value))\r | |
e651d06c LG |
1269 | else:\r |
1270 | if IsByteArray:\r | |
779ddcdf YZ |
1271 | if self.DefaultStoreSingle and self.SkuSingle:\r |
1272 | FileWrite(File, ' %-*s : %6s %10s = %s' % (self.MaxLen, ' ', TypeName, '(' + Pcd.DatumType + ')', '{'))\r | |
1273 | elif self.DefaultStoreSingle and not self.SkuSingle:\r | |
1274 | FileWrite(File, ' %-*s : %6s %10s %10s = %s' % (self.MaxLen, ' ', TypeName, '(' + Pcd.DatumType + ')', '(' + SkuIdName + ')', '{'))\r | |
1275 | elif not self.DefaultStoreSingle and self.SkuSingle:\r | |
1276 | FileWrite(File, ' %-*s : %6s %10s %10s = %s' % (self.MaxLen, ' ', TypeName, '(' + Pcd.DatumType + ')', '(' + DefaultStore + ')', '{'))\r | |
1277 | else:\r | |
1278 | FileWrite(File, ' %-*s : %6s %10s %10s %10s = %s' % (self.MaxLen, ' ', TypeName, '(' + Pcd.DatumType + ')', '(' + SkuIdName + ')', '(' + DefaultStore + ')', '{'))\r | |
e651d06c | 1279 | for Array in ArrayList:\r |
caf74495 | 1280 | FileWrite(File, Array)\r |
e651d06c | 1281 | else:\r |
179c2f97 YF |
1282 | if Pcd.DatumType in TAB_PCD_CLEAN_NUMERIC_TYPES:\r |
1283 | if Value.startswith(('0x', '0X')):\r | |
1284 | Value = '{} ({:d})'.format(Value, int(Value, 0))\r | |
1285 | else:\r | |
1286 | Value = "0x{:X} ({})".format(int(Value, 0), Value)\r | |
779ddcdf YZ |
1287 | if self.DefaultStoreSingle and self.SkuSingle:\r |
1288 | FileWrite(File, ' %-*s : %6s %10s = %s' % (self.MaxLen, ' ', TypeName, '(' + Pcd.DatumType + ')', Value))\r | |
1289 | elif self.DefaultStoreSingle and not self.SkuSingle:\r | |
1290 | FileWrite(File, ' %-*s : %6s %10s %10s = %s' % (self.MaxLen, ' ', TypeName, '(' + Pcd.DatumType + ')', '(' + SkuIdName + ')', Value))\r | |
1291 | elif not self.DefaultStoreSingle and self.SkuSingle:\r | |
1292 | FileWrite(File, ' %-*s : %6s %10s %10s = %s' % (self.MaxLen, ' ', TypeName, '(' + Pcd.DatumType + ')', '(' + DefaultStore + ')', Value))\r | |
1293 | else:\r | |
1294 | FileWrite(File, ' %-*s : %6s %10s %10s %10s = %s' % (self.MaxLen, ' ', TypeName, '(' + Pcd.DatumType + ')', '(' + SkuIdName + ')', '(' + DefaultStore + ')', Value))\r | |
e651d06c LG |
1295 | FileWrite(File, '%*s: %s: %s' % (self.MaxLen + 4, SkuInfo.VariableGuid, SkuInfo.VariableName, SkuInfo.VariableOffset))\r |
1296 | if IsStructure:\r | |
65eff519 | 1297 | OverrideValues = Pcd.SkuOverrideValues[Sku]\r |
24326f38 YZ |
1298 | OverrideFieldStruct = self.OverrideFieldValue(Pcd, OverrideValues[DefaultStore])\r |
1299 | self.PrintStructureInfo(File, OverrideFieldStruct)\r | |
e651d06c | 1300 | self.PrintPcdDefault(File, Pcd, IsStructure, DscMatch, DscDefaultValue, InfMatch, InfDefaultValue, DecMatch, DecDefaultValue)\r |
e651d06c LG |
1301 | else:\r |
1302 | Value = SkuInfo.DefaultValue\r | |
1303 | IsByteArray, ArrayList = ByteArrayForamt(Value)\r | |
1304 | if FirstPrint:\r | |
1305 | FirstPrint = False\r | |
1306 | if IsByteArray:\r | |
779ddcdf YZ |
1307 | if self.SkuSingle:\r |
1308 | FileWrite(File, ' %-*s : %6s %10s = %s' % (self.MaxLen, Flag + ' ' + PcdTokenCName, TypeName, '(' + Pcd.DatumType + ')', "{"))\r | |
1309 | else:\r | |
1310 | FileWrite(File, ' %-*s : %6s %10s %10s = %s' % (self.MaxLen, Flag + ' ' + PcdTokenCName, TypeName, '(' + Pcd.DatumType + ')', '(' + SkuIdName + ')', "{"))\r | |
e651d06c | 1311 | for Array in ArrayList:\r |
caf74495 | 1312 | FileWrite(File, Array)\r |
e651d06c | 1313 | else:\r |
179c2f97 YF |
1314 | if Pcd.DatumType in TAB_PCD_CLEAN_NUMERIC_TYPES:\r |
1315 | if Value.startswith(('0x', '0X')):\r | |
1316 | Value = '{} ({:d})'.format(Value, int(Value, 0))\r | |
1317 | else:\r | |
1318 | Value = "0x{:X} ({})".format(int(Value, 0), Value)\r | |
779ddcdf YZ |
1319 | if self.SkuSingle:\r |
1320 | FileWrite(File, ' %-*s : %6s %10s = %s' % (self.MaxLen, Flag + ' ' + PcdTokenCName, TypeName, '(' + Pcd.DatumType + ')', Value))\r | |
1321 | else:\r | |
1322 | FileWrite(File, ' %-*s : %6s %10s %10s = %s' % (self.MaxLen, Flag + ' ' + PcdTokenCName, TypeName, '(' + Pcd.DatumType + ')', '(' + SkuIdName + ')', Value))\r | |
e651d06c LG |
1323 | else:\r |
1324 | if IsByteArray:\r | |
779ddcdf | 1325 | if self.SkuSingle:\r |
ccaa7754 | 1326 | FileWrite(File, ' %-*s : %6s %10s = %s' % (self.MaxLen, ' ', TypeName, '(' + Pcd.DatumType + ')', "{"))\r |
779ddcdf | 1327 | else:\r |
ccaa7754 | 1328 | FileWrite(File, ' %-*s : %6s %10s %10s = %s' % (self.MaxLen, ' ', TypeName, '(' + Pcd.DatumType + ')', '(' + SkuIdName + ')', "{"))\r |
e651d06c | 1329 | for Array in ArrayList:\r |
caf74495 | 1330 | FileWrite(File, Array)\r |
e651d06c | 1331 | else:\r |
179c2f97 YF |
1332 | if Pcd.DatumType in TAB_PCD_CLEAN_NUMERIC_TYPES:\r |
1333 | if Value.startswith(('0x', '0X')):\r | |
1334 | Value = '{} ({:d})'.format(Value, int(Value, 0))\r | |
1335 | else:\r | |
1336 | Value = "0x{:X} ({})".format(int(Value, 0), Value)\r | |
779ddcdf | 1337 | if self.SkuSingle:\r |
ccaa7754 | 1338 | FileWrite(File, ' %-*s : %6s %10s = %s' % (self.MaxLen, ' ', TypeName, '(' + Pcd.DatumType + ')', Value))\r |
779ddcdf | 1339 | else:\r |
ccaa7754 | 1340 | FileWrite(File, ' %-*s : %6s %10s %10s = %s' % (self.MaxLen, ' ', TypeName, '(' + Pcd.DatumType + ')', '(' + SkuIdName + ')', Value))\r |
779ddcdf YZ |
1341 | if TypeName in ('DYNVPD', 'DEXVPD'):\r |
1342 | FileWrite(File, '%*s' % (self.MaxLen + 4, SkuInfo.VpdOffset))\r | |
e651d06c | 1343 | if IsStructure:\r |
65eff519 | 1344 | OverrideValues = Pcd.SkuOverrideValues[Sku]\r |
e651d06c LG |
1345 | if OverrideValues:\r |
1346 | Keys = OverrideValues.keys()\r | |
24326f38 YZ |
1347 | OverrideFieldStruct = self.OverrideFieldValue(Pcd, OverrideValues[Keys[0]])\r |
1348 | self.PrintStructureInfo(File, OverrideFieldStruct)\r | |
e651d06c LG |
1349 | self.PrintPcdDefault(File, Pcd, IsStructure, DscMatch, DscDefaultValue, InfMatch, InfDefaultValue, DecMatch, DecDefaultValue)\r |
1350 | \r | |
24326f38 YZ |
1351 | def OverrideFieldValue(self, Pcd, OverrideStruct):\r |
1352 | OverrideFieldStruct = collections.OrderedDict()\r | |
1353 | if OverrideStruct:\r | |
1354 | for Key, Values in OverrideStruct.items():\r | |
1355 | if Values[1] and Values[1].endswith('.dsc'):\r | |
1356 | OverrideFieldStruct[Key] = Values\r | |
543f5ac3 B |
1357 | if Pcd.PcdFieldValueFromFdf:\r |
1358 | for Key, Values in Pcd.PcdFieldValueFromFdf.items():\r | |
39f0156f YF |
1359 | if Key in OverrideFieldStruct and Values[0] == OverrideFieldStruct[Key][0]:\r |
1360 | continue\r | |
543f5ac3 | 1361 | OverrideFieldStruct[Key] = Values\r |
24326f38 YZ |
1362 | if Pcd.PcdFieldValueFromComm:\r |
1363 | for Key, Values in Pcd.PcdFieldValueFromComm.items():\r | |
39f0156f YF |
1364 | if Key in OverrideFieldStruct and Values[0] == OverrideFieldStruct[Key][0]:\r |
1365 | continue\r | |
24326f38 YZ |
1366 | OverrideFieldStruct[Key] = Values\r |
1367 | return OverrideFieldStruct\r | |
1368 | \r | |
e651d06c | 1369 | def PrintStructureInfo(self, File, Struct):\r |
39f0156f | 1370 | for Key, Value in sorted(Struct.items(), key=lambda x: x[0]):\r |
f440f7e3 YZ |
1371 | if Value[1] and 'build command options' in Value[1]:\r |
1372 | FileWrite(File, ' *B %-*s = %s' % (self.MaxLen + 4, '.' + Key, Value[0]))\r | |
39f0156f YF |
1373 | elif Value[1] and Value[1].endswith('.fdf'):\r |
1374 | FileWrite(File, ' *F %-*s = %s' % (self.MaxLen + 4, '.' + Key, Value[0]))\r | |
e651d06c | 1375 | else:\r |
f440f7e3 | 1376 | FileWrite(File, ' %-*s = %s' % (self.MaxLen + 4, '.' + Key, Value[0]))\r |
e651d06c LG |
1377 | \r |
1378 | def StrtoHex(self, value):\r | |
1379 | try:\r | |
1380 | value = hex(int(value))\r | |
1381 | return value\r | |
1382 | except:\r | |
1383 | if value.startswith("L\"") and value.endswith("\""):\r | |
1384 | valuelist = []\r | |
1385 | for ch in value[2:-1]:\r | |
1386 | valuelist.append(hex(ord(ch)))\r | |
1387 | valuelist.append('0x00')\r | |
1388 | return valuelist\r | |
1389 | elif value.startswith("\"") and value.endswith("\""):\r | |
1390 | return hex(ord(value[1:-1]))\r | |
1391 | elif value.startswith("{") and value.endswith("}"):\r | |
1392 | valuelist = []\r | |
1393 | if ',' not in value:\r | |
1394 | return value[1:-1]\r | |
1395 | for ch in value[1:-1].split(','):\r | |
1396 | ch = ch.strip()\r | |
1397 | if ch.startswith('0x') or ch.startswith('0X'):\r | |
1398 | valuelist.append(ch)\r | |
1399 | continue\r | |
1400 | try:\r | |
1401 | valuelist.append(hex(int(ch.strip())))\r | |
1402 | except:\r | |
1403 | pass\r | |
1404 | return valuelist\r | |
1405 | else:\r | |
1406 | return value\r | |
52302d4d LG |
1407 | \r |
1408 | ##\r | |
1409 | # Reports platform and module Prediction information\r | |
1410 | #\r | |
1411 | # This class reports the platform execution order prediction section and\r | |
1412 | # module load fixed address prediction subsection in the build report file.\r | |
1413 | #\r | |
1414 | class PredictionReport(object):\r | |
1415 | ##\r | |
1416 | # Constructor function for class PredictionReport\r | |
1417 | #\r | |
1418 | # This constructor function generates PredictionReport object for the platform.\r | |
1419 | #\r | |
1420 | # @param self: The object pointer\r | |
1421 | # @param Wa Workspace context information\r | |
1422 | #\r | |
1423 | def __init__(self, Wa):\r | |
1424 | self._MapFileName = os.path.join(Wa.BuildDir, Wa.Name + ".map")\r | |
1425 | self._MapFileParsed = False\r | |
1426 | self._EotToolInvoked = False\r | |
1427 | self._FvDir = Wa.FvDir\r | |
1428 | self._EotDir = Wa.BuildDir\r | |
1429 | self._FfsEntryPoint = {}\r | |
1430 | self._GuidMap = {}\r | |
1431 | self._SourceList = []\r | |
1432 | self.FixedMapDict = {}\r | |
1433 | self.ItemList = []\r | |
1434 | self.MaxLen = 0\r | |
1435 | \r | |
1436 | #\r | |
1437 | # Collect all platform reference source files and GUID C Name\r | |
1438 | #\r | |
1439 | for Pa in Wa.AutoGenObjectList:\r | |
1440 | for Module in Pa.LibraryAutoGenList + Pa.ModuleAutoGenList:\r | |
1441 | #\r | |
40d841f6 LG |
1442 | # BASE typed modules are EFI agnostic, so we need not scan\r |
1443 | # their source code to find PPI/Protocol produce or consume\r | |
1444 | # information.\r | |
1445 | #\r | |
8bb63e37 | 1446 | if Module.ModuleType == SUP_MODULE_BASE:\r |
40d841f6 LG |
1447 | continue\r |
1448 | #\r | |
52302d4d LG |
1449 | # Add module referenced source files\r |
1450 | #\r | |
1451 | self._SourceList.append(str(Module))\r | |
1452 | IncludeList = {}\r | |
1453 | for Source in Module.SourceFileList:\r | |
1454 | if os.path.splitext(str(Source))[1].lower() == ".c":\r | |
1455 | self._SourceList.append(" " + str(Source))\r | |
1456 | FindIncludeFiles(Source.Path, Module.IncludePathList, IncludeList)\r | |
1457 | for IncludeFile in IncludeList.values():\r | |
1458 | self._SourceList.append(" " + IncludeFile)\r | |
1459 | \r | |
1460 | for Guid in Module.PpiList:\r | |
1461 | self._GuidMap[Guid] = GuidStructureStringToGuidString(Module.PpiList[Guid])\r | |
1462 | for Guid in Module.ProtocolList:\r | |
1463 | self._GuidMap[Guid] = GuidStructureStringToGuidString(Module.ProtocolList[Guid])\r | |
1464 | for Guid in Module.GuidList:\r | |
1465 | self._GuidMap[Guid] = GuidStructureStringToGuidString(Module.GuidList[Guid])\r | |
1466 | \r | |
1467 | if Module.Guid and not Module.IsLibrary:\r | |
1468 | EntryPoint = " ".join(Module.Module.ModuleEntryPointList)\r | |
1469 | if int(str(Module.AutoGenVersion), 0) >= 0x00010005:\r | |
1470 | RealEntryPoint = "_ModuleEntryPoint"\r | |
1471 | else:\r | |
1472 | RealEntryPoint = EntryPoint\r | |
1473 | if EntryPoint == "_ModuleEntryPoint":\r | |
1474 | CCFlags = Module.BuildOption.get("CC", {}).get("FLAGS", "")\r | |
1475 | Match = gGlueLibEntryPoint.search(CCFlags)\r | |
1476 | if Match:\r | |
1477 | EntryPoint = Match.group(1)\r | |
1478 | \r | |
1479 | self._FfsEntryPoint[Module.Guid.upper()] = (EntryPoint, RealEntryPoint)\r | |
1480 | \r | |
1481 | \r | |
1482 | #\r | |
1483 | # Collect platform firmware volume list as the input of EOT.\r | |
1484 | #\r | |
1485 | self._FvList = []\r | |
1486 | if Wa.FdfProfile:\r | |
1487 | for Fd in Wa.FdfProfile.FdDict:\r | |
1488 | for FdRegion in Wa.FdfProfile.FdDict[Fd].RegionList:\r | |
91fa33ee | 1489 | if FdRegion.RegionType != BINARY_FILE_TYPE_FV:\r |
52302d4d LG |
1490 | continue\r |
1491 | for FvName in FdRegion.RegionDataList:\r | |
1492 | if FvName in self._FvList:\r | |
1493 | continue\r | |
1494 | self._FvList.append(FvName)\r | |
1495 | for Ffs in Wa.FdfProfile.FvDict[FvName.upper()].FfsList:\r | |
1496 | for Section in Ffs.SectionList:\r | |
1497 | try:\r | |
1498 | for FvSection in Section.SectionList:\r | |
1499 | if FvSection.FvName in self._FvList:\r | |
1500 | continue\r | |
1501 | self._FvList.append(FvSection.FvName)\r | |
1502 | except AttributeError:\r | |
1503 | pass\r | |
1504 | \r | |
1505 | \r | |
1506 | ##\r | |
1507 | # Parse platform fixed address map files\r | |
1508 | #\r | |
1509 | # This function parses the platform final fixed address map file to get\r | |
1510 | # the database of predicted fixed address for module image base, entry point\r | |
1511 | # etc.\r | |
1512 | #\r | |
1513 | # @param self: The object pointer\r | |
1514 | #\r | |
1515 | def _ParseMapFile(self):\r | |
1516 | if self._MapFileParsed:\r | |
1517 | return\r | |
1518 | self._MapFileParsed = True\r | |
1519 | if os.path.isfile(self._MapFileName):\r | |
1520 | try:\r | |
1521 | FileContents = open(self._MapFileName).read()\r | |
1522 | for Match in gMapFileItemPattern.finditer(FileContents):\r | |
1523 | AddressType = Match.group(1)\r | |
1524 | BaseAddress = Match.group(2)\r | |
1525 | EntryPoint = Match.group(3)\r | |
1526 | Guid = Match.group(4).upper()\r | |
1527 | List = self.FixedMapDict.setdefault(Guid, [])\r | |
1528 | List.append((AddressType, BaseAddress, "*I"))\r | |
1529 | List.append((AddressType, EntryPoint, "*E"))\r | |
1530 | except:\r | |
1531 | EdkLogger.warn(None, "Cannot open file to read", self._MapFileName)\r | |
1532 | \r | |
1533 | ##\r | |
1534 | # Invokes EOT tool to get the predicted the execution order.\r | |
1535 | #\r | |
1536 | # This function invokes EOT tool to calculate the predicted dispatch order\r | |
1537 | #\r | |
1538 | # @param self: The object pointer\r | |
1539 | #\r | |
1540 | def _InvokeEotTool(self):\r | |
1541 | if self._EotToolInvoked:\r | |
1542 | return\r | |
1543 | \r | |
1544 | self._EotToolInvoked = True\r | |
1545 | FvFileList = []\r | |
1546 | for FvName in self._FvList:\r | |
1547 | FvFile = os.path.join(self._FvDir, FvName + ".Fv")\r | |
1548 | if os.path.isfile(FvFile):\r | |
1549 | FvFileList.append(FvFile)\r | |
1550 | \r | |
1551 | if len(FvFileList) == 0:\r | |
1552 | return\r | |
1553 | #\r | |
1554 | # Write source file list and GUID file list to an intermediate file\r | |
1555 | # as the input for EOT tool and dispatch List as the output file\r | |
1556 | # from EOT tool.\r | |
1557 | #\r | |
1558 | SourceList = os.path.join(self._EotDir, "SourceFile.txt")\r | |
1559 | GuidList = os.path.join(self._EotDir, "GuidList.txt")\r | |
1560 | DispatchList = os.path.join(self._EotDir, "Dispatch.txt")\r | |
1561 | \r | |
1562 | TempFile = open(SourceList, "w+")\r | |
1563 | for Item in self._SourceList:\r | |
1564 | FileWrite(TempFile, Item)\r | |
1565 | TempFile.close()\r | |
1566 | TempFile = open(GuidList, "w+")\r | |
1567 | for Key in self._GuidMap:\r | |
1568 | FileWrite(TempFile, "%s %s" % (Key, self._GuidMap[Key]))\r | |
1569 | TempFile.close()\r | |
1570 | \r | |
1571 | try:\r | |
1572 | from Eot.Eot import Eot\r | |
40d841f6 | 1573 | \r |
52302d4d | 1574 | #\r |
40d841f6 | 1575 | # Invoke EOT tool and echo its runtime performance\r |
52302d4d | 1576 | #\r |
40d841f6 | 1577 | EotStartTime = time.time()\r |
52302d4d LG |
1578 | Eot(CommandLineOption=False, SourceFileList=SourceList, GuidList=GuidList,\r |
1579 | FvFileList=' '.join(FvFileList), Dispatch=DispatchList, IsInit=True)\r | |
40d841f6 LG |
1580 | EotEndTime = time.time()\r |
1581 | EotDuration = time.strftime("%H:%M:%S", time.gmtime(int(round(EotEndTime - EotStartTime))))\r | |
1582 | EdkLogger.quiet("EOT run time: %s\n" % EotDuration)\r | |
f7496d71 | 1583 | \r |
52302d4d LG |
1584 | #\r |
1585 | # Parse the output of EOT tool\r | |
1586 | #\r | |
1587 | for Line in open(DispatchList):\r | |
1588 | if len(Line.split()) < 4:\r | |
1589 | continue\r | |
1590 | (Guid, Phase, FfsName, FilePath) = Line.split()\r | |
1591 | Symbol = self._FfsEntryPoint.get(Guid, [FfsName, ""])[0]\r | |
1592 | if len(Symbol) > self.MaxLen:\r | |
1593 | self.MaxLen = len(Symbol)\r | |
1594 | self.ItemList.append((Phase, Symbol, FilePath))\r | |
1595 | except:\r | |
1596 | EdkLogger.quiet("(Python %s on %s\n%s)" % (platform.python_version(), sys.platform, traceback.format_exc()))\r | |
1597 | EdkLogger.warn(None, "Failed to generate execution order prediction report, for some error occurred in executing EOT.")\r | |
1598 | \r | |
1599 | \r | |
1600 | ##\r | |
1601 | # Generate platform execution order report\r | |
1602 | #\r | |
1603 | # This function generates the predicted module execution order.\r | |
1604 | #\r | |
1605 | # @param self The object pointer\r | |
1606 | # @param File The file object for report\r | |
1607 | #\r | |
1608 | def _GenerateExecutionOrderReport(self, File):\r | |
1609 | self._InvokeEotTool()\r | |
1610 | if len(self.ItemList) == 0:\r | |
1611 | return\r | |
1612 | FileWrite(File, gSectionStart)\r | |
1613 | FileWrite(File, "Execution Order Prediction")\r | |
1614 | FileWrite(File, "*P PEI phase")\r | |
1615 | FileWrite(File, "*D DXE phase")\r | |
1616 | FileWrite(File, "*E Module INF entry point name")\r | |
1617 | FileWrite(File, "*N Module notification function name")\r | |
1618 | \r | |
1619 | FileWrite(File, "Type %-*s %s" % (self.MaxLen, "Symbol", "Module INF Path"))\r | |
1620 | FileWrite(File, gSectionSep)\r | |
1621 | for Item in self.ItemList:\r | |
1622 | FileWrite(File, "*%sE %-*s %s" % (Item[0], self.MaxLen, Item[1], Item[2]))\r | |
1623 | \r | |
1624 | FileWrite(File, gSectionStart)\r | |
1625 | \r | |
1626 | ##\r | |
1627 | # Generate Fixed Address report.\r | |
1628 | #\r | |
1629 | # This function generate the predicted fixed address report for a module\r | |
1630 | # specified by Guid.\r | |
1631 | #\r | |
1632 | # @param self The object pointer\r | |
1633 | # @param File The file object for report\r | |
1634 | # @param Guid The module Guid value.\r | |
1635 | # @param NotifyList The list of all notify function in a module\r | |
1636 | #\r | |
1637 | def _GenerateFixedAddressReport(self, File, Guid, NotifyList):\r | |
1638 | self._ParseMapFile()\r | |
1639 | FixedAddressList = self.FixedMapDict.get(Guid)\r | |
1640 | if not FixedAddressList:\r | |
1641 | return\r | |
1642 | \r | |
1643 | FileWrite(File, gSubSectionStart)\r | |
1644 | FileWrite(File, "Fixed Address Prediction")\r | |
1645 | FileWrite(File, "*I Image Loading Address")\r | |
1646 | FileWrite(File, "*E Entry Point Address")\r | |
1647 | FileWrite(File, "*N Notification Function Address")\r | |
1648 | FileWrite(File, "*F Flash Address")\r | |
1649 | FileWrite(File, "*M Memory Address")\r | |
1650 | FileWrite(File, "*S SMM RAM Offset")\r | |
1651 | FileWrite(File, "TOM Top of Memory")\r | |
1652 | \r | |
1653 | FileWrite(File, "Type Address Name")\r | |
1654 | FileWrite(File, gSubSectionSep)\r | |
1655 | for Item in FixedAddressList:\r | |
1656 | Type = Item[0]\r | |
1657 | Value = Item[1]\r | |
1658 | Symbol = Item[2]\r | |
1659 | if Symbol == "*I":\r | |
1660 | Name = "(Image Base)"\r | |
1661 | elif Symbol == "*E":\r | |
1662 | Name = self._FfsEntryPoint.get(Guid, ["", "_ModuleEntryPoint"])[1]\r | |
1663 | elif Symbol in NotifyList:\r | |
1664 | Name = Symbol\r | |
1665 | Symbol = "*N"\r | |
1666 | else:\r | |
1667 | continue\r | |
1668 | \r | |
1669 | if "Flash" in Type:\r | |
1670 | Symbol += "F"\r | |
1671 | elif "Memory" in Type:\r | |
1672 | Symbol += "M"\r | |
1673 | else:\r | |
1674 | Symbol += "S"\r | |
1675 | \r | |
1676 | if Value[0] == "-":\r | |
1677 | Value = "TOM" + Value\r | |
1678 | \r | |
1679 | FileWrite(File, "%s %-16s %s" % (Symbol, Value, Name))\r | |
1680 | \r | |
1681 | ##\r | |
1682 | # Generate report for the prediction part\r | |
1683 | #\r | |
1684 | # This function generate the predicted fixed address report for a module or\r | |
1685 | # predicted module execution order for a platform.\r | |
1686 | # If the input Guid is None, then, it generates the predicted module execution order;\r | |
1687 | # otherwise it generated the module fixed loading address for the module specified by\r | |
1688 | # Guid.\r | |
1689 | #\r | |
1690 | # @param self The object pointer\r | |
1691 | # @param File The file object for report\r | |
1692 | # @param Guid The module Guid value.\r | |
1693 | #\r | |
1694 | def GenerateReport(self, File, Guid):\r | |
1695 | if Guid:\r | |
1696 | self._GenerateFixedAddressReport(File, Guid.upper(), [])\r | |
1697 | else:\r | |
1698 | self._GenerateExecutionOrderReport(File)\r | |
1699 | \r | |
1700 | ##\r | |
1701 | # Reports FD region information\r | |
1702 | #\r | |
1703 | # This class reports the FD subsection in the build report file.\r | |
1704 | # It collects region information of platform flash device.\r | |
1705 | # If the region is a firmware volume, it lists the set of modules\r | |
1706 | # and its space information; otherwise, it only lists its region name,\r | |
1707 | # base address and size in its sub-section header.\r | |
1708 | # If there are nesting FVs, the nested FVs will list immediate after\r | |
1709 | # this FD region subsection\r | |
1710 | #\r | |
1711 | class FdRegionReport(object):\r | |
1712 | ##\r | |
1713 | # Discover all the nested FV name list.\r | |
1714 | #\r | |
1715 | # This is an internal worker function to discover the all the nested FV information\r | |
1716 | # in the parent firmware volume. It uses deep first search algorithm recursively to\r | |
1717 | # find all the FV list name and append them to the list.\r | |
1718 | #\r | |
1719 | # @param self The object pointer\r | |
1720 | # @param FvName The name of current firmware file system\r | |
1721 | # @param Wa Workspace context information\r | |
1722 | #\r | |
1723 | def _DiscoverNestedFvList(self, FvName, Wa):\r | |
a2432972 EC |
1724 | FvDictKey=FvName.upper()\r |
1725 | if FvDictKey in Wa.FdfProfile.FvDict:\r | |
1726 | for Ffs in Wa.FdfProfile.FvDict[FvName.upper()].FfsList:\r | |
1727 | for Section in Ffs.SectionList:\r | |
1728 | try:\r | |
1729 | for FvSection in Section.SectionList:\r | |
1730 | if FvSection.FvName in self.FvList:\r | |
1731 | continue\r | |
1732 | self._GuidsDb[Ffs.NameGuid.upper()] = FvSection.FvName\r | |
1733 | self.FvList.append(FvSection.FvName)\r | |
1734 | self.FvInfo[FvSection.FvName] = ("Nested FV", 0, 0)\r | |
1735 | self._DiscoverNestedFvList(FvSection.FvName, Wa)\r | |
1736 | except AttributeError:\r | |
1737 | pass\r | |
52302d4d LG |
1738 | \r |
1739 | ##\r | |
1740 | # Constructor function for class FdRegionReport\r | |
1741 | #\r | |
1742 | # This constructor function generates FdRegionReport object for a specified FdRegion.\r | |
1743 | # If the FdRegion is a firmware volume, it will recursively find all its nested Firmware\r | |
1744 | # volume list. This function also collects GUID map in order to dump module identification\r | |
1745 | # in the final report.\r | |
1746 | #\r | |
1747 | # @param self: The object pointer\r | |
1748 | # @param FdRegion The current FdRegion object\r | |
1749 | # @param Wa Workspace context information\r | |
1750 | #\r | |
1751 | def __init__(self, FdRegion, Wa):\r | |
1752 | self.Type = FdRegion.RegionType\r | |
1753 | self.BaseAddress = FdRegion.Offset\r | |
1754 | self.Size = FdRegion.Size\r | |
1755 | self.FvList = []\r | |
1756 | self.FvInfo = {}\r | |
1757 | self._GuidsDb = {}\r | |
1758 | self._FvDir = Wa.FvDir\r | |
aebe5a36 | 1759 | self._WorkspaceDir = Wa.WorkspaceDir\r |
52302d4d LG |
1760 | \r |
1761 | #\r | |
1762 | # If the input FdRegion is not a firmware volume,\r | |
1763 | # we are done.\r | |
1764 | #\r | |
91fa33ee | 1765 | if self.Type != BINARY_FILE_TYPE_FV:\r |
52302d4d LG |
1766 | return\r |
1767 | \r | |
1768 | #\r | |
1769 | # Find all nested FVs in the FdRegion\r | |
1770 | #\r | |
1771 | for FvName in FdRegion.RegionDataList:\r | |
1772 | if FvName in self.FvList:\r | |
1773 | continue\r | |
1774 | self.FvList.append(FvName)\r | |
1775 | self.FvInfo[FvName] = ("Fd Region", self.BaseAddress, self.Size)\r | |
1776 | self._DiscoverNestedFvList(FvName, Wa)\r | |
1777 | \r | |
1778 | PlatformPcds = {}\r | |
52302d4d LG |
1779 | #\r |
1780 | # Collect PCDs declared in DEC files.\r | |
f7496d71 | 1781 | #\r |
0d2711a6 LG |
1782 | for Pa in Wa.AutoGenObjectList:\r |
1783 | for Package in Pa.PackageList:\r | |
1784 | for (TokenCName, TokenSpaceGuidCName, DecType) in Package.Pcds:\r | |
1785 | DecDefaultValue = Package.Pcds[TokenCName, TokenSpaceGuidCName, DecType].DefaultValue\r | |
1786 | PlatformPcds[(TokenCName, TokenSpaceGuidCName)] = DecDefaultValue\r | |
52302d4d | 1787 | #\r |
af9785a9 | 1788 | # Collect PCDs defined in DSC file\r |
52302d4d | 1789 | #\r |
e651d06c LG |
1790 | for Pa in Wa.AutoGenObjectList:\r |
1791 | for (TokenCName, TokenSpaceGuidCName) in Pa.Platform.Pcds:\r | |
1792 | DscDefaultValue = Pa.Platform.Pcds[(TokenCName, TokenSpaceGuidCName)].DefaultValue\r | |
af9785a9 | 1793 | PlatformPcds[(TokenCName, TokenSpaceGuidCName)] = DscDefaultValue\r |
52302d4d LG |
1794 | \r |
1795 | #\r | |
1796 | # Add PEI and DXE a priori files GUIDs defined in PI specification.\r | |
1797 | #\r | |
1798 | self._GuidsDb["1B45CC0A-156A-428A-AF62-49864DA0E6E6"] = "PEI Apriori"\r | |
1799 | self._GuidsDb["FC510EE7-FFDC-11D4-BD41-0080C73C8881"] = "DXE Apriori"\r | |
1800 | #\r | |
1801 | # Add ACPI table storage file\r | |
1802 | #\r | |
1803 | self._GuidsDb["7E374E25-8E01-4FEE-87F2-390C23C606CD"] = "ACPI table storage"\r | |
1804 | \r | |
1805 | for Pa in Wa.AutoGenObjectList:\r | |
1806 | for ModuleKey in Pa.Platform.Modules:\r | |
1807 | M = Pa.Platform.Modules[ModuleKey].M\r | |
05cc51ad | 1808 | InfPath = mws.join(Wa.WorkspaceDir, M.MetaFile.File)\r |
52302d4d LG |
1809 | self._GuidsDb[M.Guid.upper()] = "%s (%s)" % (M.Module.BaseName, InfPath)\r |
1810 | \r | |
1811 | #\r | |
1812 | # Collect the GUID map in the FV firmware volume\r | |
1813 | #\r | |
1814 | for FvName in self.FvList:\r | |
a2432972 EC |
1815 | FvDictKey=FvName.upper()\r |
1816 | if FvDictKey in Wa.FdfProfile.FvDict:\r | |
1817 | for Ffs in Wa.FdfProfile.FvDict[FvName.upper()].FfsList:\r | |
1818 | try:\r | |
1819 | #\r | |
1820 | # collect GUID map for binary EFI file in FDF file.\r | |
1821 | #\r | |
1822 | Guid = Ffs.NameGuid.upper()\r | |
1823 | Match = gPcdGuidPattern.match(Ffs.NameGuid)\r | |
1824 | if Match:\r | |
1825 | PcdTokenspace = Match.group(1)\r | |
1826 | PcdToken = Match.group(2)\r | |
1827 | if (PcdToken, PcdTokenspace) in PlatformPcds:\r | |
1828 | GuidValue = PlatformPcds[(PcdToken, PcdTokenspace)]\r | |
1829 | Guid = GuidStructureByteArrayToGuidString(GuidValue).upper()\r | |
1830 | for Section in Ffs.SectionList:\r | |
1831 | try:\r | |
1832 | ModuleSectFile = mws.join(Wa.WorkspaceDir, Section.SectFileName)\r | |
1833 | self._GuidsDb[Guid] = ModuleSectFile\r | |
1834 | except AttributeError:\r | |
1835 | pass\r | |
1836 | except AttributeError:\r | |
1837 | pass\r | |
52302d4d LG |
1838 | \r |
1839 | \r | |
1840 | ##\r | |
1841 | # Internal worker function to generate report for the FD region\r | |
1842 | #\r | |
1843 | # This internal worker function to generate report for the FD region.\r | |
1844 | # It the type is firmware volume, it lists offset and module identification.\r | |
1845 | #\r | |
1846 | # @param self The object pointer\r | |
1847 | # @param File The file object for report\r | |
1848 | # @param Title The title for the FD subsection\r | |
1849 | # @param BaseAddress The base address for the FD region\r | |
1850 | # @param Size The size of the FD region\r | |
1851 | # @param FvName The FV name if the FD region is a firmware volume\r | |
1852 | #\r | |
1853 | def _GenerateReport(self, File, Title, Type, BaseAddress, Size=0, FvName=None):\r | |
1854 | FileWrite(File, gSubSectionStart)\r | |
1855 | FileWrite(File, Title)\r | |
1856 | FileWrite(File, "Type: %s" % Type)\r | |
1857 | FileWrite(File, "Base Address: 0x%X" % BaseAddress)\r | |
1858 | \r | |
91fa33ee | 1859 | if self.Type == BINARY_FILE_TYPE_FV:\r |
52302d4d LG |
1860 | FvTotalSize = 0\r |
1861 | FvTakenSize = 0\r | |
1862 | FvFreeSize = 0\r | |
aebe5a36 YZ |
1863 | if FvName.upper().endswith('.FV'):\r |
1864 | FileExt = FvName + ".txt"\r | |
2157bc9c | 1865 | else:\r |
aebe5a36 YZ |
1866 | FileExt = FvName + ".Fv.txt"\r |
1867 | \r | |
1868 | if not os.path.isfile(FileExt):\r | |
1869 | FvReportFileName = mws.join(self._WorkspaceDir, FileExt)\r | |
1870 | if not os.path.isfile(FvReportFileName):\r | |
1871 | FvReportFileName = os.path.join(self._FvDir, FileExt)\r | |
52302d4d LG |
1872 | try:\r |
1873 | #\r | |
1874 | # Collect size info in the firmware volume.\r | |
1875 | #\r | |
1876 | FvReport = open(FvReportFileName).read()\r | |
1877 | Match = gFvTotalSizePattern.search(FvReport)\r | |
1878 | if Match:\r | |
1879 | FvTotalSize = int(Match.group(1), 16)\r | |
1880 | Match = gFvTakenSizePattern.search(FvReport)\r | |
1881 | if Match:\r | |
1882 | FvTakenSize = int(Match.group(1), 16)\r | |
1883 | FvFreeSize = FvTotalSize - FvTakenSize\r | |
1884 | #\r | |
1885 | # Write size information to the report file.\r | |
1886 | #\r | |
1887 | FileWrite(File, "Size: 0x%X (%.0fK)" % (FvTotalSize, FvTotalSize / 1024.0))\r | |
1888 | FileWrite(File, "Fv Name: %s (%.1f%% Full)" % (FvName, FvTakenSize * 100.0 / FvTotalSize))\r | |
1889 | FileWrite(File, "Occupied Size: 0x%X (%.0fK)" % (FvTakenSize, FvTakenSize / 1024.0))\r | |
1890 | FileWrite(File, "Free Size: 0x%X (%.0fK)" % (FvFreeSize, FvFreeSize / 1024.0))\r | |
1891 | FileWrite(File, "Offset Module")\r | |
1892 | FileWrite(File, gSubSectionSep)\r | |
1893 | #\r | |
1894 | # Write module offset and module identification to the report file.\r | |
1895 | #\r | |
1896 | OffsetInfo = {}\r | |
1897 | for Match in gOffsetGuidPattern.finditer(FvReport):\r | |
1898 | Guid = Match.group(2).upper()\r | |
1899 | OffsetInfo[Match.group(1)] = self._GuidsDb.get(Guid, Guid)\r | |
0d1f5b2b | 1900 | OffsetList = sorted(OffsetInfo.keys())\r |
52302d4d LG |
1901 | for Offset in OffsetList:\r |
1902 | FileWrite (File, "%s %s" % (Offset, OffsetInfo[Offset]))\r | |
1903 | except IOError:\r | |
1904 | EdkLogger.warn(None, "Fail to read report file", FvReportFileName)\r | |
1905 | else:\r | |
1906 | FileWrite(File, "Size: 0x%X (%.0fK)" % (Size, Size / 1024.0))\r | |
1907 | FileWrite(File, gSubSectionEnd)\r | |
1908 | \r | |
1909 | ##\r | |
1910 | # Generate report for the FD region\r | |
1911 | #\r | |
1912 | # This function generates report for the FD region.\r | |
1913 | #\r | |
1914 | # @param self The object pointer\r | |
1915 | # @param File The file object for report\r | |
1916 | #\r | |
1917 | def GenerateReport(self, File):\r | |
1918 | if (len(self.FvList) > 0):\r | |
1919 | for FvItem in self.FvList:\r | |
1920 | Info = self.FvInfo[FvItem]\r | |
91fa33ee | 1921 | self._GenerateReport(File, Info[0], TAB_FV_DIRECTORY, Info[1], Info[2], FvItem)\r |
52302d4d LG |
1922 | else:\r |
1923 | self._GenerateReport(File, "FD Region", self.Type, self.BaseAddress, self.Size)\r | |
1924 | \r | |
1925 | ##\r | |
1926 | # Reports FD information\r | |
1927 | #\r | |
1928 | # This class reports the FD section in the build report file.\r | |
1929 | # It collects flash device information for a platform.\r | |
1930 | #\r | |
1931 | class FdReport(object):\r | |
1932 | ##\r | |
1933 | # Constructor function for class FdReport\r | |
1934 | #\r | |
1935 | # This constructor function generates FdReport object for a specified\r | |
1936 | # firmware device.\r | |
1937 | #\r | |
1938 | # @param self The object pointer\r | |
1939 | # @param Fd The current Firmware device object\r | |
1940 | # @param Wa Workspace context information\r | |
1941 | #\r | |
1942 | def __init__(self, Fd, Wa):\r | |
1943 | self.FdName = Fd.FdUiName\r | |
1944 | self.BaseAddress = Fd.BaseAddress\r | |
1945 | self.Size = Fd.Size\r | |
1946 | self.FdRegionList = [FdRegionReport(FdRegion, Wa) for FdRegion in Fd.RegionList]\r | |
91fa33ee | 1947 | self.FvPath = os.path.join(Wa.BuildDir, TAB_FV_DIRECTORY)\r |
fb3d2279 | 1948 | self.VpdFilePath = os.path.join(self.FvPath, "%s.map" % Wa.Platform.VpdToolGuid)\r |
043928da YZ |
1949 | self.VPDBaseAddress = 0\r |
1950 | self.VPDSize = 0\r | |
fb3d2279 YZ |
1951 | self.VPDInfoList = []\r |
1952 | for index, FdRegion in enumerate(Fd.RegionList):\r | |
043928da | 1953 | if str(FdRegion.RegionType) is 'FILE' and Wa.Platform.VpdToolGuid in str(FdRegion.RegionDataList):\r |
fb3d2279 YZ |
1954 | self.VPDBaseAddress = self.FdRegionList[index].BaseAddress\r |
1955 | self.VPDSize = self.FdRegionList[index].Size\r | |
1956 | break\r | |
1957 | \r | |
1958 | if os.path.isfile(self.VpdFilePath):\r | |
1959 | fd = open(self.VpdFilePath, "r")\r | |
1960 | Lines = fd.readlines()\r | |
1961 | for Line in Lines:\r | |
1962 | Line = Line.strip()\r | |
1963 | if len(Line) == 0 or Line.startswith("#"):\r | |
1964 | continue\r | |
1965 | try:\r | |
1966 | PcdName, SkuId, Offset, Size, Value = Line.split("#")[0].split("|")\r | |
1967 | PcdName, SkuId, Offset, Size, Value = PcdName.strip(), SkuId.strip(), Offset.strip(), Size.strip(), Value.strip()\r | |
8401d398 YZ |
1968 | if Offset.lower().startswith('0x'):\r |
1969 | Offset = '0x%08X' % (int(Offset, 16) + self.VPDBaseAddress)\r | |
1970 | else:\r | |
1971 | Offset = '0x%08X' % (int(Offset, 10) + self.VPDBaseAddress)\r | |
fb3d2279 YZ |
1972 | self.VPDInfoList.append("%s | %s | %s | %s | %s" % (PcdName, SkuId, Offset, Size, Value))\r |
1973 | except:\r | |
1974 | EdkLogger.error("BuildReport", CODE_ERROR, "Fail to parse VPD information file %s" % self.VpdFilePath)\r | |
1975 | fd.close()\r | |
52302d4d LG |
1976 | \r |
1977 | ##\r | |
1978 | # Generate report for the firmware device.\r | |
1979 | #\r | |
1980 | # This function generates report for the firmware device.\r | |
1981 | #\r | |
1982 | # @param self The object pointer\r | |
1983 | # @param File The file object for report\r | |
1984 | #\r | |
1985 | def GenerateReport(self, File):\r | |
1986 | FileWrite(File, gSectionStart)\r | |
1987 | FileWrite(File, "Firmware Device (FD)")\r | |
1988 | FileWrite(File, "FD Name: %s" % self.FdName)\r | |
1989 | FileWrite(File, "Base Address: %s" % self.BaseAddress)\r | |
1990 | FileWrite(File, "Size: 0x%X (%.0fK)" % (self.Size, self.Size / 1024.0))\r | |
1991 | if len(self.FdRegionList) > 0:\r | |
1992 | FileWrite(File, gSectionSep)\r | |
1993 | for FdRegionItem in self.FdRegionList:\r | |
1994 | FdRegionItem.GenerateReport(File)\r | |
1995 | \r | |
fb3d2279 YZ |
1996 | if len(self.VPDInfoList) > 0:\r |
1997 | FileWrite(File, gSubSectionStart)\r | |
1998 | FileWrite(File, "FD VPD Region")\r | |
1999 | FileWrite(File, "Base Address: 0x%X" % self.VPDBaseAddress)\r | |
2000 | FileWrite(File, "Size: 0x%X (%.0fK)" % (self.VPDSize, self.VPDSize / 1024.0))\r | |
2001 | FileWrite(File, gSubSectionSep)\r | |
2002 | for item in self.VPDInfoList:\r | |
e651d06c LG |
2003 | ValueList = item.split('|')\r |
2004 | Value = ValueList[-1].strip()\r | |
2005 | IsByteArray, ArrayList = ByteArrayForamt(Value)\r | |
2006 | if IsByteArray:\r | |
2007 | ValueList[-1] = ' {'\r | |
2008 | FileWrite(File, '|'.join(ValueList))\r | |
2009 | for Array in ArrayList:\r | |
caf74495 | 2010 | FileWrite(File, Array)\r |
e651d06c LG |
2011 | else:\r |
2012 | FileWrite(File, item)\r | |
fb3d2279 | 2013 | FileWrite(File, gSubSectionEnd)\r |
52302d4d LG |
2014 | FileWrite(File, gSectionEnd)\r |
2015 | \r | |
2016 | \r | |
2017 | \r | |
2018 | ##\r | |
2019 | # Reports platform information\r | |
2020 | #\r | |
2021 | # This class reports the whole platform information\r | |
2022 | #\r | |
2023 | class PlatformReport(object):\r | |
2024 | ##\r | |
2025 | # Constructor function for class PlatformReport\r | |
2026 | #\r | |
2027 | # This constructor function generates PlatformReport object a platform build.\r | |
2028 | # It generates report for platform summary, flash, global PCDs and detailed\r | |
2029 | # module information for modules involved in platform build.\r | |
2030 | #\r | |
2031 | # @param self The object pointer\r | |
2032 | # @param Wa Workspace context information\r | |
d5d56f1b | 2033 | # @param MaList The list of modules in the platform build\r |
52302d4d | 2034 | #\r |
d5d56f1b | 2035 | def __init__(self, Wa, MaList, ReportType):\r |
52302d4d LG |
2036 | self._WorkspaceDir = Wa.WorkspaceDir\r |
2037 | self.PlatformName = Wa.Name\r | |
2038 | self.PlatformDscPath = Wa.Platform\r | |
2039 | self.Architectures = " ".join(Wa.ArchList)\r | |
2040 | self.ToolChain = Wa.ToolChain\r | |
2041 | self.Target = Wa.BuildTarget\r | |
2042 | self.OutputPath = os.path.join(Wa.WorkspaceDir, Wa.OutputDir)\r | |
2043 | self.BuildEnvironment = platform.platform()\r | |
2044 | \r | |
2045 | self.PcdReport = None\r | |
2046 | if "PCD" in ReportType:\r | |
2047 | self.PcdReport = PcdReport(Wa)\r | |
2048 | \r | |
2049 | self.FdReportList = []\r | |
4231a819 | 2050 | if "FLASH" in ReportType and Wa.FdfProfile and MaList is None:\r |
52302d4d LG |
2051 | for Fd in Wa.FdfProfile.FdDict:\r |
2052 | self.FdReportList.append(FdReport(Wa.FdfProfile.FdDict[Fd], Wa))\r | |
2053 | \r | |
2054 | self.PredictionReport = None\r | |
2055 | if "FIXED_ADDRESS" in ReportType or "EXECUTION_ORDER" in ReportType:\r | |
2056 | self.PredictionReport = PredictionReport(Wa)\r | |
2057 | \r | |
e56468c0 | 2058 | self.DepexParser = None\r |
2059 | if "DEPEX" in ReportType:\r | |
2060 | self.DepexParser = DepexParser(Wa)\r | |
f7496d71 | 2061 | \r |
52302d4d | 2062 | self.ModuleReportList = []\r |
4231a819 | 2063 | if MaList is not None:\r |
636f2be6 | 2064 | self._IsModuleBuild = True\r |
d5d56f1b LG |
2065 | for Ma in MaList:\r |
2066 | self.ModuleReportList.append(ModuleReport(Ma, ReportType))\r | |
2067 | else:\r | |
636f2be6 | 2068 | self._IsModuleBuild = False\r |
d5d56f1b | 2069 | for Pa in Wa.AutoGenObjectList:\r |
25193a33 | 2070 | ModuleAutoGenList = []\r |
d5d56f1b | 2071 | for ModuleKey in Pa.Platform.Modules:\r |
25193a33 | 2072 | ModuleAutoGenList.append(Pa.Platform.Modules[ModuleKey].M)\r |
4231a819 | 2073 | if GlobalData.gFdfParser is not None:\r |
25193a33 YZ |
2074 | if Pa.Arch in GlobalData.gFdfParser.Profile.InfDict:\r |
2075 | INFList = GlobalData.gFdfParser.Profile.InfDict[Pa.Arch]\r | |
2076 | for InfName in INFList:\r | |
2077 | InfClass = PathClass(NormPath(InfName), Wa.WorkspaceDir, Pa.Arch)\r | |
2078 | Ma = ModuleAutoGen(Wa, InfClass, Pa.BuildTarget, Pa.ToolChain, Pa.Arch, Wa.MetaFile)\r | |
4231a819 | 2079 | if Ma is None:\r |
25193a33 YZ |
2080 | continue\r |
2081 | if Ma not in ModuleAutoGenList:\r | |
2082 | ModuleAutoGenList.append(Ma)\r | |
2083 | for MGen in ModuleAutoGenList:\r | |
2084 | self.ModuleReportList.append(ModuleReport(MGen, ReportType))\r | |
52302d4d LG |
2085 | \r |
2086 | \r | |
2087 | \r | |
2088 | ##\r | |
2089 | # Generate report for the whole platform.\r | |
2090 | #\r | |
2091 | # This function generates report for platform information.\r | |
2092 | # It comprises of platform summary, global PCD, flash and\r | |
2093 | # module list sections.\r | |
2094 | #\r | |
2095 | # @param self The object pointer\r | |
2096 | # @param File The file object for report\r | |
2097 | # @param BuildDuration The total time to build the modules\r | |
1b8eca8b YZ |
2098 | # @param AutoGenTime The total time of AutoGen Phase\r |
2099 | # @param MakeTime The total time of Make Phase\r | |
2100 | # @param GenFdsTime The total time of GenFds Phase\r | |
52302d4d LG |
2101 | # @param ReportType The kind of report items in the final report file\r |
2102 | #\r | |
1b8eca8b | 2103 | def GenerateReport(self, File, BuildDuration, AutoGenTime, MakeTime, GenFdsTime, ReportType):\r |
52302d4d LG |
2104 | FileWrite(File, "Platform Summary")\r |
2105 | FileWrite(File, "Platform Name: %s" % self.PlatformName)\r | |
2106 | FileWrite(File, "Platform DSC Path: %s" % self.PlatformDscPath)\r | |
2107 | FileWrite(File, "Architectures: %s" % self.Architectures)\r | |
2108 | FileWrite(File, "Tool Chain: %s" % self.ToolChain)\r | |
2109 | FileWrite(File, "Target: %s" % self.Target)\r | |
e651d06c LG |
2110 | if GlobalData.gSkuids:\r |
2111 | FileWrite(File, "SKUID: %s" % " ".join(GlobalData.gSkuids))\r | |
2112 | if GlobalData.gDefaultStores:\r | |
2113 | FileWrite(File, "DefaultStore: %s" % " ".join(GlobalData.gDefaultStores))\r | |
52302d4d LG |
2114 | FileWrite(File, "Output Path: %s" % self.OutputPath)\r |
2115 | FileWrite(File, "Build Environment: %s" % self.BuildEnvironment)\r | |
2116 | FileWrite(File, "Build Duration: %s" % BuildDuration)\r | |
1b8eca8b YZ |
2117 | if AutoGenTime:\r |
2118 | FileWrite(File, "AutoGen Duration: %s" % AutoGenTime)\r | |
2119 | if MakeTime:\r | |
2120 | FileWrite(File, "Make Duration: %s" % MakeTime)\r | |
2121 | if GenFdsTime:\r | |
2122 | FileWrite(File, "GenFds Duration: %s" % GenFdsTime)\r | |
52302d4d LG |
2123 | FileWrite(File, "Report Content: %s" % ", ".join(ReportType))\r |
2124 | \r | |
2a29017e YZ |
2125 | if GlobalData.MixedPcd:\r |
2126 | FileWrite(File, gSectionStart)\r | |
2127 | FileWrite(File, "The following PCDs use different access methods:")\r | |
2128 | FileWrite(File, gSectionSep)\r | |
2129 | for PcdItem in GlobalData.MixedPcd:\r | |
2130 | FileWrite(File, "%s.%s" % (str(PcdItem[1]), str(PcdItem[0])))\r | |
2131 | FileWrite(File, gSectionEnd)\r | |
2132 | \r | |
636f2be6 LG |
2133 | if not self._IsModuleBuild:\r |
2134 | if "PCD" in ReportType:\r | |
2135 | self.PcdReport.GenerateReport(File, None)\r | |
f7496d71 | 2136 | \r |
636f2be6 LG |
2137 | if "FLASH" in ReportType:\r |
2138 | for FdReportListItem in self.FdReportList:\r | |
2139 | FdReportListItem.GenerateReport(File)\r | |
52302d4d LG |
2140 | \r |
2141 | for ModuleReportItem in self.ModuleReportList:\r | |
e56468c0 | 2142 | ModuleReportItem.GenerateReport(File, self.PcdReport, self.PredictionReport, self.DepexParser, ReportType)\r |
52302d4d | 2143 | \r |
636f2be6 LG |
2144 | if not self._IsModuleBuild:\r |
2145 | if "EXECUTION_ORDER" in ReportType:\r | |
2146 | self.PredictionReport.GenerateReport(File, None)\r | |
52302d4d LG |
2147 | \r |
2148 | ## BuildReport class\r | |
2149 | #\r | |
2150 | # This base class contain the routines to collect data and then\r | |
2151 | # applies certain format to the output report\r | |
2152 | #\r | |
2153 | class BuildReport(object):\r | |
2154 | ##\r | |
2155 | # Constructor function for class BuildReport\r | |
2156 | #\r | |
2157 | # This constructor function generates BuildReport object a platform build.\r | |
2158 | # It generates report for platform summary, flash, global PCDs and detailed\r | |
2159 | # module information for modules involved in platform build.\r | |
2160 | #\r | |
2161 | # @param self The object pointer\r | |
2162 | # @param ReportFile The file name to save report file\r | |
2163 | # @param ReportType The kind of report items in the final report file\r | |
2164 | #\r | |
2165 | def __init__(self, ReportFile, ReportType):\r | |
2166 | self.ReportFile = ReportFile\r | |
2167 | if ReportFile:\r | |
2168 | self.ReportList = []\r | |
2169 | self.ReportType = []\r | |
f7496d71 | 2170 | if ReportType:\r |
52302d4d LG |
2171 | for ReportTypeItem in ReportType:\r |
2172 | if ReportTypeItem not in self.ReportType:\r | |
2173 | self.ReportType.append(ReportTypeItem)\r | |
2174 | else:\r | |
eca5be7a | 2175 | self.ReportType = ["PCD", "LIBRARY", "BUILD_FLAGS", "DEPEX", "HASH", "FLASH", "FIXED_ADDRESS"]\r |
52302d4d LG |
2176 | ##\r |
2177 | # Adds platform report to the list\r | |
2178 | #\r | |
2179 | # This function adds a platform report to the final report list.\r | |
2180 | #\r | |
2181 | # @param self The object pointer\r | |
2182 | # @param Wa Workspace context information\r | |
d5d56f1b | 2183 | # @param MaList The list of modules in the platform build\r |
52302d4d | 2184 | #\r |
d5d56f1b | 2185 | def AddPlatformReport(self, Wa, MaList=None):\r |
52302d4d | 2186 | if self.ReportFile:\r |
d5d56f1b | 2187 | self.ReportList.append((Wa, MaList))\r |
52302d4d LG |
2188 | \r |
2189 | ##\r | |
2190 | # Generates the final report.\r | |
2191 | #\r | |
2192 | # This function generates platform build report. It invokes GenerateReport()\r | |
2193 | # method for every platform report in the list.\r | |
2194 | #\r | |
2195 | # @param self The object pointer\r | |
2196 | # @param BuildDuration The total time to build the modules\r | |
1b8eca8b YZ |
2197 | # @param AutoGenTime The total time of AutoGen phase\r |
2198 | # @param MakeTime The total time of Make phase\r | |
2199 | # @param GenFdsTime The total time of GenFds phase\r | |
52302d4d | 2200 | #\r |
1b8eca8b | 2201 | def GenerateReport(self, BuildDuration, AutoGenTime, MakeTime, GenFdsTime):\r |
52302d4d LG |
2202 | if self.ReportFile:\r |
2203 | try:\r | |
86379ac4 | 2204 | File = BytesIO('')\r |
d5d56f1b | 2205 | for (Wa, MaList) in self.ReportList:\r |
1b8eca8b | 2206 | PlatformReport(Wa, MaList, self.ReportType).GenerateReport(File, BuildDuration, AutoGenTime, MakeTime, GenFdsTime, self.ReportType)\r |
64b2609f LG |
2207 | Content = FileLinesSplit(File.getvalue(), gLineMaxLength)\r |
2208 | SaveFileOnChange(self.ReportFile, Content, True)\r | |
40d841f6 | 2209 | EdkLogger.quiet("Build report can be found at %s" % os.path.abspath(self.ReportFile))\r |
52302d4d LG |
2210 | except IOError:\r |
2211 | EdkLogger.error(None, FILE_WRITE_FAILURE, ExtraData=self.ReportFile)\r | |
2212 | except:\r | |
2213 | EdkLogger.error("BuildReport", CODE_ERROR, "Unknown fatal error when generating build report", ExtraData=self.ReportFile, RaiseError=False)\r | |
2214 | EdkLogger.quiet("(Python %s on %s\n%s)" % (platform.python_version(), sys.platform, traceback.format_exc()))\r | |
2215 | File.close()\r | |
f7496d71 | 2216 | \r |
52302d4d LG |
2217 | # This acts like the main() function for the script, unless it is 'import'ed into another script.\r |
2218 | if __name__ == '__main__':\r | |
2219 | pass\r | |
2220 | \r |