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