2 # Routines for generating build report.
4 # This module contains the functionality to generate build report after
5 # build all target completes successfully.
7 # Copyright (c) 2010 - 2018, Intel Corporation. All rights reserved.<BR>
8 # This program and the accompanying materials
9 # are licensed and made available under the terms and conditions of the BSD License
10 # which accompanies this distribution. The full text of the license may be found at
11 # http://opensource.org/licenses/bsd-license.php
13 # THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
14 # WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
19 import Common
.LongFilePathOs
as os
30 from datetime
import datetime
31 from io
import BytesIO
32 from Common
import EdkLogger
33 from Common
.Misc
import SaveFileOnChange
34 from Common
.Misc
import GuidStructureByteArrayToGuidString
35 from Common
.Misc
import GuidStructureStringToGuidString
36 from Common
.BuildToolError
import FILE_WRITE_FAILURE
37 from Common
.BuildToolError
import CODE_ERROR
38 from Common
.BuildToolError
import COMMAND_FAILURE
39 from Common
.BuildToolError
import FORMAT_INVALID
40 from Common
.LongFilePathSupport
import OpenLongFilePath
as open
41 from Common
.MultipleWorkspace
import MultipleWorkspace
as mws
42 import Common
.GlobalData
as GlobalData
43 from AutoGen
.AutoGen
import ModuleAutoGen
44 from Common
.Misc
import PathClass
45 from Common
.StringUtils
import NormPath
46 from Common
.DataType
import *
48 from Common
.Expression
import *
50 ## Pattern to extract contents in EDK DXS files
51 gDxsDependencyPattern
= re
.compile(r
"DEPENDENCY_START(.+)DEPENDENCY_END", re
.DOTALL
)
53 ## Pattern to find total FV total size, occupied size in flash report intermediate file
54 gFvTotalSizePattern
= re
.compile(r
"EFI_FV_TOTAL_SIZE = (0x[0-9a-fA-F]+)")
55 gFvTakenSizePattern
= re
.compile(r
"EFI_FV_TAKEN_SIZE = (0x[0-9a-fA-F]+)")
57 ## Pattern to find module size and time stamp in module summary report intermediate file
58 gModuleSizePattern
= re
.compile(r
"MODULE_SIZE = (\d+)")
59 gTimeStampPattern
= re
.compile(r
"TIME_STAMP = (\d+)")
61 ## Pattern to find GUID value in flash description files
62 gPcdGuidPattern
= re
.compile(r
"PCD\((\w+)[.](\w+)\)")
64 ## Pattern to collect offset, GUID value pair in the flash report intermediate file
65 gOffsetGuidPattern
= re
.compile(r
"(0x[0-9A-Fa-f]+) ([-A-Fa-f0-9]+)")
67 ## Pattern to find module base address and entry point in fixed flash map file
68 gModulePattern
= r
"\n[-\w]+\s*\(([^,]+),\s*BaseAddress=%(Address)s,\s*EntryPoint=%(Address)s\)\s*\(GUID=([-0-9A-Fa-f]+)[^)]*\)"
69 gMapFileItemPattern
= re
.compile(gModulePattern
% {"Address" : "(-?0[xX][0-9A-Fa-f]+)"})
71 ## Pattern to find all module referenced header files in source files
72 gIncludePattern
= re
.compile(r
'#include\s*["<]([^">]+)[">]')
73 gIncludePattern2
= re
.compile(r
"#include\s+EFI_([A-Z_]+)\s*[(]\s*(\w+)\s*[)]")
75 ## Pattern to find the entry point for EDK module using EDKII Glue library
76 gGlueLibEntryPoint
= re
.compile(r
"__EDKII_GLUE_MODULE_ENTRY_POINT__\s*=\s*(\w+)")
78 ## Tags for MaxLength of line in report
81 ## Tags for end of line in report
84 ## Tags for section start, end and separator
85 gSectionStart
= ">" + "=" * (gLineMaxLength
- 2) + "<"
86 gSectionEnd
= "<" + "=" * (gLineMaxLength
- 2) + ">" + "\n"
87 gSectionSep
= "=" * gLineMaxLength
89 ## Tags for subsection start, end and separator
90 gSubSectionStart
= ">" + "-" * (gLineMaxLength
- 2) + "<"
91 gSubSectionEnd
= "<" + "-" * (gLineMaxLength
- 2) + ">"
92 gSubSectionSep
= "-" * gLineMaxLength
95 ## The look up table to map PCD type to pair of report display type and DEC type
97 TAB_PCDS_FIXED_AT_BUILD
: ('FIXED', TAB_PCDS_FIXED_AT_BUILD
),
98 TAB_PCDS_PATCHABLE_IN_MODULE
: ('PATCH', TAB_PCDS_PATCHABLE_IN_MODULE
),
99 TAB_PCDS_FEATURE_FLAG
: ('FLAG', TAB_PCDS_FEATURE_FLAG
),
100 TAB_PCDS_DYNAMIC
: ('DYN', TAB_PCDS_DYNAMIC
),
101 TAB_PCDS_DYNAMIC_HII
: ('DYNHII', TAB_PCDS_DYNAMIC
),
102 TAB_PCDS_DYNAMIC_VPD
: ('DYNVPD', TAB_PCDS_DYNAMIC
),
103 TAB_PCDS_DYNAMIC_EX
: ('DEX', TAB_PCDS_DYNAMIC_EX
),
104 TAB_PCDS_DYNAMIC_EX_HII
: ('DEXHII', TAB_PCDS_DYNAMIC_EX
),
105 TAB_PCDS_DYNAMIC_EX_VPD
: ('DEXVPD', TAB_PCDS_DYNAMIC_EX
),
108 ## The look up table to map module type to driver type
110 SUP_MODULE_SEC
: '0x3 (SECURITY_CORE)',
111 SUP_MODULE_PEI_CORE
: '0x4 (PEI_CORE)',
112 SUP_MODULE_PEIM
: '0x6 (PEIM)',
113 SUP_MODULE_DXE_CORE
: '0x5 (DXE_CORE)',
114 SUP_MODULE_DXE_DRIVER
: '0x7 (DRIVER)',
115 SUP_MODULE_DXE_SAL_DRIVER
: '0x7 (DRIVER)',
116 SUP_MODULE_DXE_SMM_DRIVER
: '0x7 (DRIVER)',
117 SUP_MODULE_DXE_RUNTIME_DRIVER
: '0x7 (DRIVER)',
118 SUP_MODULE_UEFI_DRIVER
: '0x7 (DRIVER)',
119 SUP_MODULE_UEFI_APPLICATION
: '0x9 (APPLICATION)',
120 SUP_MODULE_SMM_CORE
: '0xD (SMM_CORE)',
121 'SMM_DRIVER' : '0xA (SMM)', # Extension of module type to support PI 1.1 SMM drivers
122 SUP_MODULE_MM_STANDALONE
: '0xE (MM_STANDALONE)',
123 SUP_MODULE_MM_CORE_STANDALONE
: '0xF (MM_CORE_STANDALONE)'
126 ## The look up table of the supported opcode in the dependency expression binaries
127 gOpCodeList
= ["BEFORE", "AFTER", "PUSH", "AND", "OR", "NOT", "TRUE", "FALSE", "END", "SOR"]
130 # Writes a string to the file object.
132 # This function writes a string to the file object and a new line is appended
133 # afterwards. It may optionally wraps the string for better readability.
135 # @File The file object to write
136 # @String The string to be written to the file
137 # @Wrapper Indicates whether to wrap the string
139 def FileWrite(File
, String
, Wrapper
=False):
141 String
= textwrap
.fill(String
, 120)
142 File
.write(String
+ gEndOfLine
)
144 def ByteArrayForamt(Value
):
148 if Value
.startswith('{') and Value
.endswith('}'):
150 ValueList
= Value
.split(',')
151 if len(ValueList
) >= SplitNum
:
155 Len
= len(ValueList
)/SplitNum
156 for i
, element
in enumerate(ValueList
):
157 ValueList
[i
] = '0x%02X' % int(element
.strip(), 16)
161 End
= min(SplitNum
*(Id
+1), len(ValueList
))
162 Str
= ','.join(ValueList
[SplitNum
*Id
: End
])
163 if End
== len(ValueList
):
165 ArrayList
.append(Str
)
169 ArrayList
.append(Str
)
172 ArrayList
= [Value
+ '}']
173 return IsByteArray
, ArrayList
176 # Find all the header file that the module source directly includes.
178 # This function scans source code to find all header files the module may
179 # include. This is not accurate but very effective to find all the header
180 # file the module might include with #include statement.
182 # @Source The source file name
183 # @IncludePathList The list of include path to find the source file.
184 # @IncludeFiles The dictionary of current found include files.
186 def FindIncludeFiles(Source
, IncludePathList
, IncludeFiles
):
187 FileContents
= open(Source
).read()
189 # Find header files with pattern #include "XXX.h" or #include <XXX.h>
191 for Match
in gIncludePattern
.finditer(FileContents
):
192 FileName
= Match
.group(1).strip()
193 for Dir
in [os
.path
.dirname(Source
)] + IncludePathList
:
194 FullFileName
= os
.path
.normpath(os
.path
.join(Dir
, FileName
))
195 if os
.path
.exists(FullFileName
):
196 IncludeFiles
[FullFileName
.lower().replace("\\", "/")] = FullFileName
200 # Find header files with pattern like #include EFI_PPI_CONSUMER(XXX)
202 for Match
in gIncludePattern2
.finditer(FileContents
):
204 Type
= Match
.group(1)
205 if "ARCH_PROTOCOL" in Type
:
206 FileName
= "ArchProtocol/%(Key)s/%(Key)s.h" % {"Key" : Key
}
207 elif "PROTOCOL" in Type
:
208 FileName
= "Protocol/%(Key)s/%(Key)s.h" % {"Key" : Key
}
210 FileName
= "Ppi/%(Key)s/%(Key)s.h" % {"Key" : Key
}
211 elif TAB_GUID
in Type
:
212 FileName
= "Guid/%(Key)s/%(Key)s.h" % {"Key" : Key
}
215 for Dir
in IncludePathList
:
216 FullFileName
= os
.path
.normpath(os
.path
.join(Dir
, FileName
))
217 if os
.path
.exists(FullFileName
):
218 IncludeFiles
[FullFileName
.lower().replace("\\", "/")] = FullFileName
221 ## Split each lines in file
223 # This method is used to split the lines in file to make the length of each line
224 # less than MaxLength.
226 # @param Content The content of file
227 # @param MaxLength The Max Length of the line
229 def FileLinesSplit(Content
=None, MaxLength
=None):
230 ContentList
= Content
.split(TAB_LINE_BREAK
)
233 for Line
in ContentList
:
234 while len(Line
.rstrip()) > MaxLength
:
235 LineSpaceIndex
= Line
.rfind(TAB_SPACE_SPLIT
, 0, MaxLength
)
236 LineSlashIndex
= Line
.rfind(TAB_SLASH
, 0, MaxLength
)
237 LineBackSlashIndex
= Line
.rfind(TAB_BACK_SLASH
, 0, MaxLength
)
238 if max(LineSpaceIndex
, LineSlashIndex
, LineBackSlashIndex
) > 0:
239 LineBreakIndex
= max(LineSpaceIndex
, LineSlashIndex
, LineBackSlashIndex
)
241 LineBreakIndex
= MaxLength
242 NewContentList
.append(Line
[:LineBreakIndex
])
243 Line
= Line
[LineBreakIndex
:]
245 NewContentList
.append(Line
)
246 for NewLine
in NewContentList
:
247 NewContent
+= NewLine
+ TAB_LINE_BREAK
249 NewContent
= NewContent
.replace(TAB_LINE_BREAK
, gEndOfLine
).replace('\r\r\n', gEndOfLine
)
255 # Parse binary dependency expression section
257 # This utility class parses the dependency expression section and translate the readable
258 # GUID name and value.
260 class DepexParser(object):
262 # Constructor function for class DepexParser
264 # This constructor function collect GUID values so that the readable
265 # GUID name can be translated.
267 # @param self The object pointer
268 # @param Wa Workspace context information
270 def __init__(self
, Wa
):
272 for Pa
in Wa
.AutoGenObjectList
:
273 for Package
in Pa
.PackageList
:
274 for Protocol
in Package
.Protocols
:
275 GuidValue
= GuidStructureStringToGuidString(Package
.Protocols
[Protocol
])
276 self
._GuidDb
[GuidValue
.upper()] = Protocol
277 for Ppi
in Package
.Ppis
:
278 GuidValue
= GuidStructureStringToGuidString(Package
.Ppis
[Ppi
])
279 self
._GuidDb
[GuidValue
.upper()] = Ppi
280 for Guid
in Package
.Guids
:
281 GuidValue
= GuidStructureStringToGuidString(Package
.Guids
[Guid
])
282 self
._GuidDb
[GuidValue
.upper()] = Guid
283 for Ma
in Pa
.ModuleAutoGenList
:
284 for Pcd
in Ma
.FixedVoidTypePcds
:
285 PcdValue
= Ma
.FixedVoidTypePcds
[Pcd
]
286 if len(PcdValue
.split(',')) == 16:
287 GuidValue
= GuidStructureByteArrayToGuidString(PcdValue
)
288 self
._GuidDb
[GuidValue
.upper()] = Pcd
290 # Parse the binary dependency expression files.
292 # This function parses the binary dependency expression file and translate it
293 # to the instruction list.
295 # @param self The object pointer
296 # @param DepexFileName The file name of binary dependency expression file.
298 def ParseDepexFile(self
, DepexFileName
):
299 DepexFile
= open(DepexFileName
, "rb")
301 OpCode
= DepexFile
.read(1)
303 Statement
= gOpCodeList
[struct
.unpack("B", OpCode
)[0]]
304 if Statement
in ["BEFORE", "AFTER", "PUSH"]:
305 GuidValue
= "%08X-%04X-%04X-%02X%02X-%02X%02X%02X%02X%02X%02X" % \
306 struct
.unpack(PACK_PATTERN_GUID
, DepexFile
.read(16))
307 GuidString
= self
._GuidDb
.get(GuidValue
, GuidValue
)
308 Statement
= "%s %s" % (Statement
, GuidString
)
309 DepexStatement
.append(Statement
)
310 OpCode
= DepexFile
.read(1)
312 return DepexStatement
315 # Reports library information
317 # This class reports the module library subsection in the build report file.
319 class LibraryReport(object):
321 # Constructor function for class LibraryReport
323 # This constructor function generates LibraryReport object for
326 # @param self The object pointer
327 # @param M Module context information
329 def __init__(self
, M
):
330 self
.LibraryList
= []
331 if int(str(M
.AutoGenVersion
), 0) >= 0x00010005:
332 self
._EdkIIModule
= True
334 self
._EdkIIModule
= False
336 for Lib
in M
.DependentLibraryList
:
337 LibInfPath
= str(Lib
)
338 LibClassList
= Lib
.LibraryClass
[0].LibraryClass
339 LibConstructorList
= Lib
.ConstructorList
340 LibDesstructorList
= Lib
.DestructorList
341 LibDepexList
= Lib
.DepexExpression
[M
.Arch
, M
.ModuleType
]
342 for LibAutoGen
in M
.LibraryAutoGenList
:
343 if LibInfPath
== LibAutoGen
.MetaFile
.Path
:
344 LibTime
= LibAutoGen
.BuildTime
346 self
.LibraryList
.append((LibInfPath
, LibClassList
, LibConstructorList
, LibDesstructorList
, LibDepexList
, LibTime
))
349 # Generate report for module library information
351 # This function generates report for the module library.
352 # If the module is EDKII style one, the additional library class, library
353 # constructor/destructor and dependency expression may also be reported.
355 # @param self The object pointer
356 # @param File The file object for report
358 def GenerateReport(self
, File
):
359 if len(self
.LibraryList
) > 0:
360 FileWrite(File
, gSubSectionStart
)
361 FileWrite(File
, TAB_BRG_LIBRARY
)
362 FileWrite(File
, gSubSectionSep
)
363 for LibraryItem
in self
.LibraryList
:
364 LibInfPath
= LibraryItem
[0]
365 FileWrite(File
, LibInfPath
)
368 # Report library class, library constructor and destructor for
369 # EDKII style module.
371 if self
._EdkIIModule
:
372 LibClass
= LibraryItem
[1]
374 LibConstructor
= " ".join(LibraryItem
[2])
376 EdkIILibInfo
+= " C = " + LibConstructor
377 LibDestructor
= " ".join(LibraryItem
[3])
379 EdkIILibInfo
+= " D = " + LibDestructor
380 LibDepex
= " ".join(LibraryItem
[4])
382 EdkIILibInfo
+= " Depex = " + LibDepex
384 EdkIILibInfo
+= " Time = " + LibraryItem
[5]
386 FileWrite(File
, "{%s: %s}" % (LibClass
, EdkIILibInfo
))
388 FileWrite(File
, "{%s}" % LibClass
)
390 FileWrite(File
, gSubSectionEnd
)
393 # Reports dependency expression information
395 # This class reports the module dependency expression subsection in the build report file.
397 class DepexReport(object):
399 # Constructor function for class DepexReport
401 # This constructor function generates DepexReport object for
402 # a module. If the module source contains the DXS file (usually EDK
403 # style module), it uses the dependency in DXS file; otherwise,
404 # it uses the dependency expression from its own INF [Depex] section
405 # and then merges with the ones from its dependent library INF.
407 # @param self The object pointer
408 # @param M Module context information
410 def __init__(self
, M
):
412 self
._DepexFileName
= os
.path
.join(M
.BuildDir
, "OUTPUT", M
.Module
.BaseName
+ ".depex")
413 ModuleType
= M
.ModuleType
415 ModuleType
= COMPONENT_TO_MODULE_MAP_DICT
.get(M
.ComponentType
, "")
417 if ModuleType
in [SUP_MODULE_SEC
, SUP_MODULE_PEI_CORE
, SUP_MODULE_DXE_CORE
, SUP_MODULE_SMM_CORE
, SUP_MODULE_MM_CORE_STANDALONE
, SUP_MODULE_UEFI_APPLICATION
]:
420 for Source
in M
.SourceFileList
:
421 if os
.path
.splitext(Source
.Path
)[1].lower() == ".dxs":
422 Match
= gDxsDependencyPattern
.search(open(Source
.Path
).read())
424 self
.Depex
= Match
.group(1).strip()
428 self
.Depex
= M
.DepexExpressionDict
.get(M
.ModuleType
, "")
429 self
.ModuleDepex
= " ".join(M
.Module
.DepexExpression
[M
.Arch
, M
.ModuleType
])
430 if not self
.ModuleDepex
:
431 self
.ModuleDepex
= "(None)"
434 for Lib
in M
.DependentLibraryList
:
435 LibDepex
= " ".join(Lib
.DepexExpression
[M
.Arch
, M
.ModuleType
]).strip()
437 LibDepexList
.append("(" + LibDepex
+ ")")
438 self
.LibraryDepex
= " AND ".join(LibDepexList
)
439 if not self
.LibraryDepex
:
440 self
.LibraryDepex
= "(None)"
444 # Generate report for module dependency expression information
446 # This function generates report for the module dependency expression.
448 # @param self The object pointer
449 # @param File The file object for report
450 # @param GlobalDepexParser The platform global Dependency expression parser object
452 def GenerateReport(self
, File
, GlobalDepexParser
):
455 FileWrite(File
, gSubSectionStart
)
456 if os
.path
.isfile(self
._DepexFileName
):
458 DepexStatements
= GlobalDepexParser
.ParseDepexFile(self
._DepexFileName
)
459 FileWrite(File
, "Final Dependency Expression (DEPEX) Instructions")
460 for DepexStatement
in DepexStatements
:
461 FileWrite(File
, " %s" % DepexStatement
)
462 FileWrite(File
, gSubSectionSep
)
464 EdkLogger
.warn(None, "Dependency expression file is corrupted", self
._DepexFileName
)
466 FileWrite(File
, "Dependency Expression (DEPEX) from %s" % self
.Source
)
468 if self
.Source
== "INF":
469 FileWrite(File
, self
.Depex
, True)
470 FileWrite(File
, gSubSectionSep
)
471 FileWrite(File
, "From Module INF: %s" % self
.ModuleDepex
, True)
472 FileWrite(File
, "From Library INF: %s" % self
.LibraryDepex
, True)
474 FileWrite(File
, self
.Depex
)
475 FileWrite(File
, gSubSectionEnd
)
478 # Reports dependency expression information
480 # This class reports the module build flags subsection in the build report file.
482 class BuildFlagsReport(object):
484 # Constructor function for class BuildFlagsReport
486 # This constructor function generates BuildFlagsReport object for
487 # a module. It reports the build tool chain tag and all relevant
488 # build flags to build the module.
490 # @param self The object pointer
491 # @param M Module context information
493 def __init__(self
, M
):
496 # Add build flags according to source file extension so that
497 # irrelevant ones can be filtered out.
499 for Source
in M
.SourceFileList
:
500 Ext
= os
.path
.splitext(Source
.File
)[1].lower()
501 if Ext
in [".c", ".cc", ".cpp"]:
502 BuildOptions
["CC"] = 1
503 elif Ext
in [".s", ".asm"]:
504 BuildOptions
["PP"] = 1
505 BuildOptions
["ASM"] = 1
506 elif Ext
in [".vfr"]:
507 BuildOptions
["VFRPP"] = 1
508 BuildOptions
["VFR"] = 1
509 elif Ext
in [".dxs"]:
510 BuildOptions
["APP"] = 1
511 BuildOptions
["CC"] = 1
512 elif Ext
in [".asl"]:
513 BuildOptions
["ASLPP"] = 1
514 BuildOptions
["ASL"] = 1
515 elif Ext
in [".aslc"]:
516 BuildOptions
["ASLCC"] = 1
517 BuildOptions
["ASLDLINK"] = 1
518 BuildOptions
["CC"] = 1
519 elif Ext
in [".asm16"]:
520 BuildOptions
["ASMLINK"] = 1
521 BuildOptions
["SLINK"] = 1
522 BuildOptions
["DLINK"] = 1
525 # Save module build flags.
527 self
.ToolChainTag
= M
.ToolChain
529 for Tool
in BuildOptions
:
530 self
.BuildFlags
[Tool
+ "_FLAGS"] = M
.BuildOption
.get(Tool
, {}).get("FLAGS", "")
533 # Generate report for module build flags information
535 # This function generates report for the module build flags expression.
537 # @param self The object pointer
538 # @param File The file object for report
540 def GenerateReport(self
, File
):
541 FileWrite(File
, gSubSectionStart
)
542 FileWrite(File
, "Build Flags")
543 FileWrite(File
, "Tool Chain Tag: %s" % self
.ToolChainTag
)
544 for Tool
in self
.BuildFlags
:
545 FileWrite(File
, gSubSectionSep
)
546 FileWrite(File
, "%s = %s" % (Tool
, self
.BuildFlags
[Tool
]), True)
548 FileWrite(File
, gSubSectionEnd
)
552 # Reports individual module information
554 # This class reports the module section in the build report file.
555 # It comprises of module summary, module PCD, library, dependency expression,
556 # build flags sections.
558 class ModuleReport(object):
560 # Constructor function for class ModuleReport
562 # This constructor function generates ModuleReport object for
563 # a separate module in a platform build.
565 # @param self The object pointer
566 # @param M Module context information
567 # @param ReportType The kind of report items in the final report file
569 def __init__(self
, M
, ReportType
):
570 self
.ModuleName
= M
.Module
.BaseName
571 self
.ModuleInfPath
= M
.MetaFile
.File
572 self
.FileGuid
= M
.Guid
574 self
.BuildTimeStamp
= None
578 ModuleType
= M
.ModuleType
580 ModuleType
= COMPONENT_TO_MODULE_MAP_DICT
.get(M
.ComponentType
, "")
582 # If a module complies to PI 1.1, promote Module type to "SMM_DRIVER"
584 if ModuleType
== SUP_MODULE_DXE_SMM_DRIVER
:
585 PiSpec
= M
.Module
.Specification
.get("PI_SPECIFICATION_VERSION", "0x00010000")
586 if int(PiSpec
, 0) >= 0x0001000A:
587 ModuleType
= "SMM_DRIVER"
588 self
.DriverType
= gDriverTypeMap
.get(ModuleType
, "0x2 (FREE_FORM)")
589 self
.UefiSpecVersion
= M
.Module
.Specification
.get("UEFI_SPECIFICATION_VERSION", "")
590 self
.PiSpecVersion
= M
.Module
.Specification
.get("PI_SPECIFICATION_VERSION", "")
591 self
.PciDeviceId
= M
.Module
.Defines
.get("PCI_DEVICE_ID", "")
592 self
.PciVendorId
= M
.Module
.Defines
.get("PCI_VENDOR_ID", "")
593 self
.PciClassCode
= M
.Module
.Defines
.get("PCI_CLASS_CODE", "")
594 self
.BuildTime
= M
.BuildTime
596 self
._BuildDir
= M
.BuildDir
597 self
.ModulePcdSet
= {}
598 if "PCD" in ReportType
:
600 # Collect all module used PCD set: module INF referenced directly or indirectly.
601 # It also saves module INF default values of them in case they exist.
603 for Pcd
in M
.ModulePcdList
+ M
.LibraryPcdList
:
604 self
.ModulePcdSet
.setdefault((Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
, Pcd
.Type
), (Pcd
.InfDefaultValue
, Pcd
.DefaultValue
))
606 self
.LibraryReport
= None
607 if "LIBRARY" in ReportType
:
608 self
.LibraryReport
= LibraryReport(M
)
610 self
.DepexReport
= None
611 if "DEPEX" in ReportType
:
612 self
.DepexReport
= DepexReport(M
)
614 if "BUILD_FLAGS" in ReportType
:
615 self
.BuildFlagsReport
= BuildFlagsReport(M
)
619 # Generate report for module information
621 # This function generates report for separate module expression
622 # in a platform build.
624 # @param self The object pointer
625 # @param File The file object for report
626 # @param GlobalPcdReport The platform global PCD report object
627 # @param GlobalPredictionReport The platform global Prediction report object
628 # @param GlobalDepexParser The platform global Dependency expression parser object
629 # @param ReportType The kind of report items in the final report file
631 def GenerateReport(self
, File
, GlobalPcdReport
, GlobalPredictionReport
, GlobalDepexParser
, ReportType
):
632 FileWrite(File
, gSectionStart
)
634 FwReportFileName
= os
.path
.join(self
._BuildDir
, "DEBUG", self
.ModuleName
+ ".txt")
635 if os
.path
.isfile(FwReportFileName
):
637 FileContents
= open(FwReportFileName
).read()
638 Match
= gModuleSizePattern
.search(FileContents
)
640 self
.Size
= int(Match
.group(1))
642 Match
= gTimeStampPattern
.search(FileContents
)
644 self
.BuildTimeStamp
= datetime
.fromtimestamp(int(Match
.group(1)))
646 EdkLogger
.warn(None, "Fail to read report file", FwReportFileName
)
648 if "HASH" in ReportType
:
649 OutputDir
= os
.path
.join(self
._BuildDir
, "OUTPUT")
650 DefaultEFIfile
= os
.path
.join(OutputDir
, self
.ModuleName
+ ".efi")
651 if os
.path
.isfile(DefaultEFIfile
):
652 Tempfile
= os
.path
.join(OutputDir
, self
.ModuleName
+ "_hash.tmp")
653 # rebase the efi image since its base address may not zero
654 cmd
= ["GenFw", "--rebase", str(0), "-o", Tempfile
, DefaultEFIfile
]
656 PopenObject
= subprocess
.Popen(' '.join(cmd
), stdout
=subprocess
.PIPE
, stderr
=subprocess
.PIPE
, shell
=True)
657 except Exception as X
:
658 EdkLogger
.error("GenFw", COMMAND_FAILURE
, ExtraData
="%s: %s" % (str(X
), cmd
[0]))
659 EndOfProcedure
= threading
.Event()
660 EndOfProcedure
.clear()
661 if PopenObject
.stderr
:
662 StdErrThread
= threading
.Thread(target
=ReadMessage
, args
=(PopenObject
.stderr
, EdkLogger
.quiet
, EndOfProcedure
))
663 StdErrThread
.setName("STDERR-Redirector")
664 StdErrThread
.setDaemon(False)
666 # waiting for program exit
668 if PopenObject
.stderr
:
670 if PopenObject
.returncode
!= 0:
671 EdkLogger
.error("GenFw", COMMAND_FAILURE
, "Failed to generate firmware hash image for %s" % (DefaultEFIfile
))
672 if os
.path
.isfile(Tempfile
):
673 self
.Hash
= hashlib
.sha1()
674 buf
= open(Tempfile
, 'rb').read()
675 if self
.Hash
.update(buf
):
676 self
.Hash
= self
.Hash
.update(buf
)
677 self
.Hash
= self
.Hash
.hexdigest()
680 FileWrite(File
, "Module Summary")
681 FileWrite(File
, "Module Name: %s" % self
.ModuleName
)
682 FileWrite(File
, "Module INF Path: %s" % self
.ModuleInfPath
)
683 FileWrite(File
, "File GUID: %s" % self
.FileGuid
)
685 FileWrite(File
, "Size: 0x%X (%.2fK)" % (self
.Size
, self
.Size
/ 1024.0))
687 FileWrite(File
, "SHA1 HASH: %s *%s" % (self
.Hash
, self
.ModuleName
+ ".efi"))
688 if self
.BuildTimeStamp
:
689 FileWrite(File
, "Build Time Stamp: %s" % self
.BuildTimeStamp
)
691 FileWrite(File
, "Module Build Time: %s" % self
.BuildTime
)
693 FileWrite(File
, "Driver Type: %s" % self
.DriverType
)
694 if self
.UefiSpecVersion
:
695 FileWrite(File
, "UEFI Spec Version: %s" % self
.UefiSpecVersion
)
696 if self
.PiSpecVersion
:
697 FileWrite(File
, "PI Spec Version: %s" % self
.PiSpecVersion
)
699 FileWrite(File
, "PCI Device ID: %s" % self
.PciDeviceId
)
701 FileWrite(File
, "PCI Vendor ID: %s" % self
.PciVendorId
)
702 if self
.PciClassCode
:
703 FileWrite(File
, "PCI Class Code: %s" % self
.PciClassCode
)
705 FileWrite(File
, gSectionSep
)
707 if "PCD" in ReportType
:
708 GlobalPcdReport
.GenerateReport(File
, self
.ModulePcdSet
)
710 if "LIBRARY" in ReportType
:
711 self
.LibraryReport
.GenerateReport(File
)
713 if "DEPEX" in ReportType
:
714 self
.DepexReport
.GenerateReport(File
, GlobalDepexParser
)
716 if "BUILD_FLAGS" in ReportType
:
717 self
.BuildFlagsReport
.GenerateReport(File
)
719 if "FIXED_ADDRESS" in ReportType
and self
.FileGuid
:
720 GlobalPredictionReport
.GenerateReport(File
, self
.FileGuid
)
722 FileWrite(File
, gSectionEnd
)
724 def ReadMessage(From
, To
, ExitFlag
):
726 # read one line a time
727 Line
= From
.readline()
728 # empty string means "end"
729 if Line
is not None and Line
!= "":
737 # Reports platform and module PCD information
739 # This class reports the platform PCD section and module PCD subsection
740 # in the build report file.
742 class PcdReport(object):
744 # Constructor function for class PcdReport
746 # This constructor function generates PcdReport object a platform build.
747 # It collects the whole PCD database from platform DSC files, platform
748 # flash description file and package DEC files.
750 # @param self The object pointer
751 # @param Wa Workspace context information
753 def __init__(self
, Wa
):
756 self
.ConditionalPcds
= {}
760 self
.FdfPcdSet
= Wa
.FdfProfile
.PcdDict
764 self
.DefaultStoreSingle
= True
765 self
.SkuSingle
= True
766 if GlobalData
.gDefaultStores
and len(GlobalData
.gDefaultStores
) > 1:
767 self
.DefaultStoreSingle
= False
768 if GlobalData
.gSkuids
and len(GlobalData
.gSkuids
) > 1:
769 self
.SkuSingle
= False
771 self
.ModulePcdOverride
= {}
772 for Pa
in Wa
.AutoGenObjectList
:
775 # Collect all platform referenced PCDs and grouped them by PCD token space
778 for Pcd
in Pa
.AllPcdList
:
779 PcdList
= self
.AllPcds
.setdefault(Pcd
.TokenSpaceGuidCName
, {}).setdefault(Pcd
.Type
, [])
780 if Pcd
not in PcdList
:
782 if len(Pcd
.TokenCName
) > self
.MaxLen
:
783 self
.MaxLen
= len(Pcd
.TokenCName
)
785 # Collect the PCD defined in DSC/FDF file, but not used in module
787 UnusedPcdFullList
= []
788 for item
in Pa
.Platform
.Pcds
:
789 Pcd
= Pa
.Platform
.Pcds
[item
]
791 # check the Pcd in FDF file, whether it is used in module first
792 for T
in PCD_TYPE_LIST
:
793 PcdList
= self
.AllPcds
.setdefault(Pcd
.TokenSpaceGuidCName
, {}).setdefault(T
, [])
799 for package
in Pa
.PackageList
:
800 for T
in PCD_TYPE_LIST
:
801 if (Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
, T
) in package
.Pcds
:
804 if not Pcd
.DatumType
:
805 Pcd
.DatumType
= package
.Pcds
[(Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
, T
)].DatumType
809 if not Pcd
.DatumType
:
811 # Try to remove Hii and Vpd suffix
812 if PcdType
.startswith(TAB_PCDS_DYNAMIC_EX
):
813 PcdType
= TAB_PCDS_DYNAMIC_EX
814 elif PcdType
.startswith(TAB_PCDS_DYNAMIC
):
815 PcdType
= TAB_PCDS_DYNAMIC
816 for package
in Pa
.PackageList
:
817 if (Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
, PcdType
) in package
.Pcds
:
818 Pcd
.DatumType
= package
.Pcds
[(Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
, PcdType
)].DatumType
821 PcdList
= self
.AllPcds
.setdefault(Pcd
.TokenSpaceGuidCName
, {}).setdefault(Pcd
.Type
, [])
822 if Pcd
not in PcdList
and Pcd
not in UnusedPcdFullList
:
823 UnusedPcdFullList
.append(Pcd
)
824 if len(Pcd
.TokenCName
) > self
.MaxLen
:
825 self
.MaxLen
= len(Pcd
.TokenCName
)
827 if GlobalData
.gConditionalPcds
:
828 for PcdItem
in GlobalData
.gConditionalPcds
:
830 (TokenSpaceGuidCName
, TokenCName
) = PcdItem
.split('.')
831 if (TokenCName
, TokenSpaceGuidCName
) in Pa
.Platform
.Pcds
:
832 Pcd
= Pa
.Platform
.Pcds
[(TokenCName
, TokenSpaceGuidCName
)]
833 PcdList
= self
.ConditionalPcds
.setdefault(Pcd
.TokenSpaceGuidCName
, {}).setdefault(Pcd
.Type
, [])
834 if Pcd
not in PcdList
:
838 if UnusedPcdFullList
:
839 for Pcd
in UnusedPcdFullList
:
840 if Pcd
.TokenSpaceGuidCName
+ '.' + Pcd
.TokenCName
in GlobalData
.gConditionalPcds
:
842 UnusedPcdList
.append(Pcd
)
844 for Pcd
in UnusedPcdList
:
845 PcdList
= self
.UnusedPcds
.setdefault(Pcd
.TokenSpaceGuidCName
, {}).setdefault(Pcd
.Type
, [])
846 if Pcd
not in PcdList
:
849 for Module
in Pa
.Platform
.Modules
.values():
851 # Collect module override PCDs
853 for ModulePcd
in Module
.M
.ModulePcdList
+ Module
.M
.LibraryPcdList
:
854 TokenCName
= ModulePcd
.TokenCName
855 TokenSpaceGuid
= ModulePcd
.TokenSpaceGuidCName
856 ModuleDefault
= ModulePcd
.DefaultValue
857 ModulePath
= os
.path
.basename(Module
.M
.MetaFile
.File
)
858 self
.ModulePcdOverride
.setdefault((TokenCName
, TokenSpaceGuid
), {})[ModulePath
] = ModuleDefault
862 # Collect PCD DEC default value.
864 self
.DecPcdDefault
= {}
866 for Pa
in Wa
.AutoGenObjectList
:
867 for Package
in Pa
.PackageList
:
868 Guids
= Package
.Guids
869 self
._GuidDict
.update(Guids
)
870 for (TokenCName
, TokenSpaceGuidCName
, DecType
) in Package
.Pcds
:
871 DecDefaultValue
= Package
.Pcds
[TokenCName
, TokenSpaceGuidCName
, DecType
].DefaultValue
872 self
.DecPcdDefault
.setdefault((TokenCName
, TokenSpaceGuidCName
, DecType
), DecDefaultValue
)
874 # Collect PCDs defined in DSC common section
876 self
.DscPcdDefault
= {}
877 for Pa
in Wa
.AutoGenObjectList
:
878 for (TokenCName
, TokenSpaceGuidCName
) in Pa
.Platform
.Pcds
:
879 DscDefaultValue
= Pa
.Platform
.Pcds
[(TokenCName
, TokenSpaceGuidCName
)].DscDefaultValue
881 self
.DscPcdDefault
[(TokenCName
, TokenSpaceGuidCName
)] = DscDefaultValue
883 def GenerateReport(self
, File
, ModulePcdSet
):
885 if self
.ConditionalPcds
:
886 self
.GenerateReportDetail(File
, ModulePcdSet
, 1)
888 self
.GenerateReportDetail(File
, ModulePcdSet
, 2)
889 self
.GenerateReportDetail(File
, ModulePcdSet
)
892 # Generate report for PCD information
894 # This function generates report for separate module expression
895 # in a platform build.
897 # @param self The object pointer
898 # @param File The file object for report
899 # @param ModulePcdSet Set of all PCDs referenced by module or None for
900 # platform PCD report
901 # @param ReportySubType 0 means platform/module PCD report, 1 means Conditional
902 # directives section report, 2 means Unused Pcds section report
903 # @param DscOverridePcds Module DSC override PCDs set
905 def GenerateReportDetail(self
, File
, ModulePcdSet
, ReportSubType
= 0):
906 PcdDict
= self
.AllPcds
907 if ReportSubType
== 1:
908 PcdDict
= self
.ConditionalPcds
909 elif ReportSubType
== 2:
910 PcdDict
= self
.UnusedPcds
913 FileWrite(File
, gSectionStart
)
914 if ReportSubType
== 1:
915 FileWrite(File
, "Conditional Directives used by the build system")
916 elif ReportSubType
== 2:
917 FileWrite(File
, "PCDs not used by modules or in conditional directives")
919 FileWrite(File
, "Platform Configuration Database Report")
921 FileWrite(File
, " *B - PCD override in the build option")
922 FileWrite(File
, " *P - Platform scoped PCD override in DSC file")
923 FileWrite(File
, " *F - Platform scoped PCD override in FDF file")
924 if not ReportSubType
:
925 FileWrite(File
, " *M - Module scoped PCD override")
926 FileWrite(File
, gSectionSep
)
928 if not ReportSubType
and ModulePcdSet
:
930 # For module PCD sub-section
932 FileWrite(File
, gSubSectionStart
)
933 FileWrite(File
, TAB_BRG_PCD
)
934 FileWrite(File
, gSubSectionSep
)
938 for Type
in PcdDict
[Key
]:
939 for Pcd
in PcdDict
[Key
][Type
]:
940 AllPcdDict
[Key
][(Pcd
.TokenCName
, Type
)] = Pcd
941 for Key
in sorted(AllPcdDict
):
943 # Group PCD by their token space GUID C Name
946 for PcdTokenCName
, Type
in sorted(AllPcdDict
[Key
]):
948 # Group PCD by their usage type
950 Pcd
= AllPcdDict
[Key
][(PcdTokenCName
, Type
)]
951 TypeName
, DecType
= gPcdTypeMap
.get(Type
, ("", Type
))
953 if GlobalData
.MixedPcd
:
954 for PcdKey
in GlobalData
.MixedPcd
:
955 if (Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
) in GlobalData
.MixedPcd
[PcdKey
]:
956 PcdTokenCName
= PcdKey
[0]
958 if MixedPcdFlag
and not ModulePcdSet
:
961 # Get PCD default value and their override relationship
963 DecDefaultValue
= self
.DecPcdDefault
.get((Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
, DecType
))
964 DscDefaultValue
= self
.DscPcdDefault
.get((Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
))
965 DscDefaultValBak
= DscDefaultValue
967 for (CName
, Guid
, Field
) in self
.FdfPcdSet
:
968 if CName
== PcdTokenCName
and Guid
== Key
:
969 DscDefaultValue
= self
.FdfPcdSet
[(CName
, Guid
, Field
)]
971 DscDefaultValue
= self
.FdfPcdSet
.get((Pcd
.TokenCName
, Key
), DscDefaultValue
)
972 if DscDefaultValue
!= DscDefaultValBak
:
974 DscDefaultValue
= ValueExpressionEx(DscDefaultValue
, Pcd
.DatumType
, self
._GuidDict
)(True)
975 except BadExpression
as DscDefaultValue
:
976 EdkLogger
.error('BuildReport', FORMAT_INVALID
, "PCD Value: %s, Type: %s" %(DscDefaultValue
, Pcd
.DatumType
))
978 InfDefaultValue
= None
980 PcdValue
= DecDefaultValue
982 PcdValue
= DscDefaultValue
983 Pcd
.DefaultValue
= PcdValue
984 if ModulePcdSet
is not None:
985 if (Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
, Type
) not in ModulePcdSet
:
987 InfDefaultValue
, PcdValue
= ModulePcdSet
[Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
, Type
]
988 Pcd
.DefaultValue
= PcdValue
989 if InfDefaultValue
== "":
990 InfDefaultValue
= None
992 BuildOptionMatch
= False
993 if GlobalData
.BuildOptionPcd
:
994 for pcd
in GlobalData
.BuildOptionPcd
:
995 if (Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
) == (pcd
[0], pcd
[1]):
999 Pcd
.DefaultValue
= PcdValue
1000 BuildOptionMatch
= True
1004 if ModulePcdSet
is None:
1006 FileWrite(File
, Key
)
1010 if Pcd
.DatumType
in TAB_PCD_CLEAN_NUMERIC_TYPES
:
1011 PcdValueNumber
= int(PcdValue
.strip(), 0)
1012 if DecDefaultValue
is None:
1015 DecDefaultValueNumber
= int(DecDefaultValue
.strip(), 0)
1016 DecMatch
= (DecDefaultValueNumber
== PcdValueNumber
)
1018 if InfDefaultValue
is None:
1021 InfDefaultValueNumber
= int(InfDefaultValue
.strip(), 0)
1022 InfMatch
= (InfDefaultValueNumber
== PcdValueNumber
)
1024 if DscDefaultValue
is None:
1027 DscDefaultValueNumber
= int(DscDefaultValue
.strip(), 0)
1028 DscMatch
= (DscDefaultValueNumber
== PcdValueNumber
)
1030 if DecDefaultValue
is None:
1033 DecMatch
= (DecDefaultValue
.strip() == PcdValue
.strip())
1035 if InfDefaultValue
is None:
1038 InfMatch
= (InfDefaultValue
.strip() == PcdValue
.strip())
1040 if DscDefaultValue
is None:
1043 DscMatch
= (DscDefaultValue
.strip() == PcdValue
.strip())
1046 if GlobalData
.gStructurePcd
and (self
.Arch
in GlobalData
.gStructurePcd
) and ((Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
) in GlobalData
.gStructurePcd
[self
.Arch
]):
1048 if TypeName
in ('DYNVPD', 'DEXVPD'):
1049 SkuInfoList
= Pcd
.SkuInfoList
1050 Pcd
= GlobalData
.gStructurePcd
[self
.Arch
][(Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
)]
1051 Pcd
.DatumType
= Pcd
.StructName
1052 if TypeName
in ('DYNVPD', 'DEXVPD'):
1053 Pcd
.SkuInfoList
= SkuInfoList
1054 if Pcd
.PcdFieldValueFromComm
:
1055 BuildOptionMatch
= True
1057 elif Pcd
.SkuOverrideValues
:
1059 if not Pcd
.SkuInfoList
:
1060 OverrideValues
= Pcd
.SkuOverrideValues
1062 Keys
= OverrideValues
.keys()
1063 Data
= OverrideValues
[Keys
[0]]
1064 Struct
= Data
.values()[0]
1065 DscOverride
= self
.ParseStruct(Struct
)
1067 SkuList
= sorted(Pcd
.SkuInfoList
.keys())
1069 SkuInfo
= Pcd
.SkuInfoList
[Sku
]
1070 if TypeName
in ('DYNHII', 'DEXHII'):
1071 if SkuInfo
.DefaultStoreDict
:
1072 DefaultStoreList
= sorted(SkuInfo
.DefaultStoreDict
.keys())
1073 for DefaultStore
in DefaultStoreList
:
1074 OverrideValues
= Pcd
.SkuOverrideValues
[Sku
]
1075 DscOverride
= self
.ParseStruct(OverrideValues
[DefaultStore
])
1079 OverrideValues
= Pcd
.SkuOverrideValues
[Sku
]
1081 Keys
= OverrideValues
.keys()
1082 OverrideFieldStruct
= self
.OverrideFieldValue(Pcd
, OverrideValues
[Keys
[0]])
1083 DscOverride
= self
.ParseStruct(OverrideFieldStruct
)
1091 # Report PCD item according to their override relationship
1094 self
.PrintPcdValue(File
, Pcd
, PcdTokenCName
, TypeName
, IsStructure
, DscMatch
, DscDefaultValBak
, InfMatch
, InfDefaultValue
, DecMatch
, DecDefaultValue
, ' ')
1095 elif InfDefaultValue
and InfMatch
:
1096 self
.PrintPcdValue(File
, Pcd
, PcdTokenCName
, TypeName
, IsStructure
, DscMatch
, DscDefaultValBak
, InfMatch
, InfDefaultValue
, DecMatch
, DecDefaultValue
, '*M')
1097 elif BuildOptionMatch
:
1098 self
.PrintPcdValue(File
, Pcd
, PcdTokenCName
, TypeName
, IsStructure
, DscMatch
, DscDefaultValBak
, InfMatch
, InfDefaultValue
, DecMatch
, DecDefaultValue
, '*B')
1100 if DscDefaultValue
and DscMatch
:
1101 if (Pcd
.TokenCName
, Key
, Field
) in self
.FdfPcdSet
:
1102 self
.PrintPcdValue(File
, Pcd
, PcdTokenCName
, TypeName
, IsStructure
, DscMatch
, DscDefaultValBak
, InfMatch
, InfDefaultValue
, DecMatch
, DecDefaultValue
, '*F')
1104 self
.PrintPcdValue(File
, Pcd
, PcdTokenCName
, TypeName
, IsStructure
, DscMatch
, DscDefaultValBak
, InfMatch
, InfDefaultValue
, DecMatch
, DecDefaultValue
, '*P')
1106 self
.PrintPcdValue(File
, Pcd
, PcdTokenCName
, TypeName
, IsStructure
, DscMatch
, DscDefaultValBak
, InfMatch
, InfDefaultValue
, DecMatch
, DecDefaultValue
, '*M')
1108 if ModulePcdSet
is None:
1111 if not TypeName
in ('PATCH', 'FLAG', 'FIXED'):
1113 if not BuildOptionMatch
:
1114 ModuleOverride
= self
.ModulePcdOverride
.get((Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
), {})
1115 for ModulePath
in ModuleOverride
:
1116 ModuleDefault
= ModuleOverride
[ModulePath
]
1117 if Pcd
.DatumType
in TAB_PCD_CLEAN_NUMERIC_TYPES
:
1118 ModulePcdDefaultValueNumber
= int(ModuleDefault
.strip(), 0)
1119 Match
= (ModulePcdDefaultValueNumber
== PcdValueNumber
)
1121 Match
= (ModuleDefault
.strip() == PcdValue
.strip())
1124 IsByteArray
, ArrayList
= ByteArrayForamt(ModuleDefault
.strip())
1126 FileWrite(File
, ' *M %-*s = %s' % (self
.MaxLen
+ 15, ModulePath
, '{'))
1127 for Array
in ArrayList
:
1128 FileWrite(File
, Array
)
1130 FileWrite(File
, ' *M %-*s = %s' % (self
.MaxLen
+ 15, ModulePath
, ModuleDefault
.strip()))
1132 if ModulePcdSet
is None:
1133 FileWrite(File
, gSectionEnd
)
1135 if not ReportSubType
and ModulePcdSet
:
1136 FileWrite(File
, gSubSectionEnd
)
1138 def ParseStruct(self
, struct
):
1139 HasDscOverride
= False
1141 for _
, Values
in struct
.items():
1142 if Values
[1] and Values
[1].endswith('.dsc'):
1143 HasDscOverride
= True
1145 return HasDscOverride
1147 def PrintPcdDefault(self
, File
, Pcd
, IsStructure
, DscMatch
, DscDefaultValue
, InfMatch
, InfDefaultValue
, DecMatch
, DecDefaultValue
):
1148 if not DscMatch
and DscDefaultValue
is not None:
1149 Value
= DscDefaultValue
.strip()
1150 IsByteArray
, ArrayList
= ByteArrayForamt(Value
)
1152 FileWrite(File
, ' %*s = %s' % (self
.MaxLen
+ 19, 'DSC DEFAULT', "{"))
1153 for Array
in ArrayList
:
1154 FileWrite(File
, Array
)
1156 if Pcd
.DatumType
in TAB_PCD_CLEAN_NUMERIC_TYPES
:
1157 if Value
.startswith(('0x', '0X')):
1158 Value
= '{} ({:d})'.format(Value
, int(Value
, 0))
1160 Value
= "0x{:X} ({})".format(int(Value
, 0), Value
)
1161 FileWrite(File
, ' %*s = %s' % (self
.MaxLen
+ 19, 'DSC DEFAULT', Value
))
1162 if not InfMatch
and InfDefaultValue
is not None:
1163 Value
= InfDefaultValue
.strip()
1164 IsByteArray
, ArrayList
= ByteArrayForamt(Value
)
1166 FileWrite(File
, ' %*s = %s' % (self
.MaxLen
+ 19, 'INF DEFAULT', "{"))
1167 for Array
in ArrayList
:
1168 FileWrite(File
, Array
)
1170 if Pcd
.DatumType
in TAB_PCD_CLEAN_NUMERIC_TYPES
:
1171 if Value
.startswith(('0x', '0X')):
1172 Value
= '{} ({:d})'.format(Value
, int(Value
, 0))
1174 Value
= "0x{:X} ({})".format(int(Value
, 0), Value
)
1175 FileWrite(File
, ' %*s = %s' % (self
.MaxLen
+ 19, 'INF DEFAULT', Value
))
1177 if not DecMatch
and DecDefaultValue
is not None:
1178 Value
= DecDefaultValue
.strip()
1179 IsByteArray
, ArrayList
= ByteArrayForamt(Value
)
1181 FileWrite(File
, ' %*s = %s' % (self
.MaxLen
+ 19, 'DEC DEFAULT', "{"))
1182 for Array
in ArrayList
:
1183 FileWrite(File
, Array
)
1185 if Pcd
.DatumType
in TAB_PCD_CLEAN_NUMERIC_TYPES
:
1186 if Value
.startswith(('0x', '0X')):
1187 Value
= '{} ({:d})'.format(Value
, int(Value
, 0))
1189 Value
= "0x{:X} ({})".format(int(Value
, 0), Value
)
1190 FileWrite(File
, ' %*s = %s' % (self
.MaxLen
+ 19, 'DEC DEFAULT', Value
))
1192 self
.PrintStructureInfo(File
, Pcd
.DefaultValues
)
1193 if DecMatch
and IsStructure
:
1194 self
.PrintStructureInfo(File
, Pcd
.DefaultValues
)
1196 def PrintPcdValue(self
, File
, Pcd
, PcdTokenCName
, TypeName
, IsStructure
, DscMatch
, DscDefaultValue
, InfMatch
, InfDefaultValue
, DecMatch
, DecDefaultValue
, Flag
= ' '):
1197 if not Pcd
.SkuInfoList
:
1198 Value
= Pcd
.DefaultValue
1199 IsByteArray
, ArrayList
= ByteArrayForamt(Value
)
1201 FileWrite(File
, ' %-*s : %6s %10s = %s' % (self
.MaxLen
, Flag
+ ' ' + PcdTokenCName
, TypeName
, '(' + Pcd
.DatumType
+ ')', '{'))
1202 for Array
in ArrayList
:
1203 FileWrite(File
, Array
)
1205 if Pcd
.DatumType
in TAB_PCD_CLEAN_NUMERIC_TYPES
:
1206 if Value
.startswith(('0x', '0X')):
1207 Value
= '{} ({:d})'.format(Value
, int(Value
, 0))
1209 Value
= "0x{:X} ({})".format(int(Value
, 0), Value
)
1210 FileWrite(File
, ' %-*s : %6s %10s = %s' % (self
.MaxLen
, Flag
+ ' ' + PcdTokenCName
, TypeName
, '(' + Pcd
.DatumType
+ ')', Value
))
1212 OverrideValues
= Pcd
.SkuOverrideValues
1214 Keys
= OverrideValues
.keys()
1215 Data
= OverrideValues
[Keys
[0]]
1216 Struct
= Data
.values()[0]
1217 OverrideFieldStruct
= self
.OverrideFieldValue(Pcd
, Struct
)
1218 self
.PrintStructureInfo(File
, OverrideFieldStruct
)
1219 self
.PrintPcdDefault(File
, Pcd
, IsStructure
, DscMatch
, DscDefaultValue
, InfMatch
, InfDefaultValue
, DecMatch
, DecDefaultValue
)
1222 SkuList
= sorted(Pcd
.SkuInfoList
.keys())
1224 SkuInfo
= Pcd
.SkuInfoList
[Sku
]
1225 SkuIdName
= SkuInfo
.SkuIdName
1226 if TypeName
in ('DYNHII', 'DEXHII'):
1227 if SkuInfo
.DefaultStoreDict
:
1228 DefaultStoreList
= sorted(SkuInfo
.DefaultStoreDict
.keys())
1229 for DefaultStore
in DefaultStoreList
:
1230 Value
= SkuInfo
.DefaultStoreDict
[DefaultStore
]
1231 IsByteArray
, ArrayList
= ByteArrayForamt(Value
)
1235 if self
.DefaultStoreSingle
and self
.SkuSingle
:
1236 FileWrite(File
, ' %-*s : %6s %10s = %s' % (self
.MaxLen
, Flag
+ ' ' + PcdTokenCName
, TypeName
, '(' + Pcd
.DatumType
+ ')', '{'))
1237 elif self
.DefaultStoreSingle
and not self
.SkuSingle
:
1238 FileWrite(File
, ' %-*s : %6s %10s %10s = %s' % (self
.MaxLen
, Flag
+ ' ' + PcdTokenCName
, TypeName
, '(' + Pcd
.DatumType
+ ')', '(' + SkuIdName
+ ')', '{'))
1239 elif not self
.DefaultStoreSingle
and self
.SkuSingle
:
1240 FileWrite(File
, ' %-*s : %6s %10s %10s = %s' % (self
.MaxLen
, Flag
+ ' ' + PcdTokenCName
, TypeName
, '(' + Pcd
.DatumType
+ ')', '(' + DefaultStore
+ ')', '{'))
1242 FileWrite(File
, ' %-*s : %6s %10s %10s %10s = %s' % (self
.MaxLen
, Flag
+ ' ' + PcdTokenCName
, TypeName
, '(' + Pcd
.DatumType
+ ')', '(' + SkuIdName
+ ')', '(' + DefaultStore
+ ')', '{'))
1243 for Array
in ArrayList
:
1244 FileWrite(File
, Array
)
1246 if Pcd
.DatumType
in TAB_PCD_CLEAN_NUMERIC_TYPES
:
1247 if Value
.startswith(('0x', '0X')):
1248 Value
= '{} ({:d})'.format(Value
, int(Value
, 0))
1250 Value
= "0x{:X} ({})".format(int(Value
, 0), Value
)
1251 if self
.DefaultStoreSingle
and self
.SkuSingle
:
1252 FileWrite(File
, ' %-*s : %6s %10s = %s' % (self
.MaxLen
, Flag
+ ' ' + PcdTokenCName
, TypeName
, '(' + Pcd
.DatumType
+ ')', Value
))
1253 elif self
.DefaultStoreSingle
and not self
.SkuSingle
:
1254 FileWrite(File
, ' %-*s : %6s %10s %10s = %s' % (self
.MaxLen
, Flag
+ ' ' + PcdTokenCName
, TypeName
, '(' + Pcd
.DatumType
+ ')', '(' + SkuIdName
+ ')', Value
))
1255 elif not self
.DefaultStoreSingle
and self
.SkuSingle
:
1256 FileWrite(File
, ' %-*s : %6s %10s %10s = %s' % (self
.MaxLen
, Flag
+ ' ' + PcdTokenCName
, TypeName
, '(' + Pcd
.DatumType
+ ')', '(' + DefaultStore
+ ')', Value
))
1258 FileWrite(File
, ' %-*s : %6s %10s %10s %10s = %s' % (self
.MaxLen
, Flag
+ ' ' + PcdTokenCName
, TypeName
, '(' + Pcd
.DatumType
+ ')', '(' + SkuIdName
+ ')', '(' + DefaultStore
+ ')', Value
))
1261 if self
.DefaultStoreSingle
and self
.SkuSingle
:
1262 FileWrite(File
, ' %-*s : %6s %10s = %s' % (self
.MaxLen
, ' ', TypeName
, '(' + Pcd
.DatumType
+ ')', '{'))
1263 elif self
.DefaultStoreSingle
and not self
.SkuSingle
:
1264 FileWrite(File
, ' %-*s : %6s %10s %10s = %s' % (self
.MaxLen
, ' ', TypeName
, '(' + Pcd
.DatumType
+ ')', '(' + SkuIdName
+ ')', '{'))
1265 elif not self
.DefaultStoreSingle
and self
.SkuSingle
:
1266 FileWrite(File
, ' %-*s : %6s %10s %10s = %s' % (self
.MaxLen
, ' ', TypeName
, '(' + Pcd
.DatumType
+ ')', '(' + DefaultStore
+ ')', '{'))
1268 FileWrite(File
, ' %-*s : %6s %10s %10s %10s = %s' % (self
.MaxLen
, ' ', TypeName
, '(' + Pcd
.DatumType
+ ')', '(' + SkuIdName
+ ')', '(' + DefaultStore
+ ')', '{'))
1269 for Array
in ArrayList
:
1270 FileWrite(File
, Array
)
1272 if Pcd
.DatumType
in TAB_PCD_CLEAN_NUMERIC_TYPES
:
1273 if Value
.startswith(('0x', '0X')):
1274 Value
= '{} ({:d})'.format(Value
, int(Value
, 0))
1276 Value
= "0x{:X} ({})".format(int(Value
, 0), Value
)
1277 if self
.DefaultStoreSingle
and self
.SkuSingle
:
1278 FileWrite(File
, ' %-*s : %6s %10s = %s' % (self
.MaxLen
, ' ', TypeName
, '(' + Pcd
.DatumType
+ ')', Value
))
1279 elif self
.DefaultStoreSingle
and not self
.SkuSingle
:
1280 FileWrite(File
, ' %-*s : %6s %10s %10s = %s' % (self
.MaxLen
, ' ', TypeName
, '(' + Pcd
.DatumType
+ ')', '(' + SkuIdName
+ ')', Value
))
1281 elif not self
.DefaultStoreSingle
and self
.SkuSingle
:
1282 FileWrite(File
, ' %-*s : %6s %10s %10s = %s' % (self
.MaxLen
, ' ', TypeName
, '(' + Pcd
.DatumType
+ ')', '(' + DefaultStore
+ ')', Value
))
1284 FileWrite(File
, ' %-*s : %6s %10s %10s %10s = %s' % (self
.MaxLen
, ' ', TypeName
, '(' + Pcd
.DatumType
+ ')', '(' + SkuIdName
+ ')', '(' + DefaultStore
+ ')', Value
))
1285 FileWrite(File
, '%*s: %s: %s' % (self
.MaxLen
+ 4, SkuInfo
.VariableGuid
, SkuInfo
.VariableName
, SkuInfo
.VariableOffset
))
1287 OverrideValues
= Pcd
.SkuOverrideValues
[Sku
]
1288 OverrideFieldStruct
= self
.OverrideFieldValue(Pcd
, OverrideValues
[DefaultStore
])
1289 self
.PrintStructureInfo(File
, OverrideFieldStruct
)
1290 self
.PrintPcdDefault(File
, Pcd
, IsStructure
, DscMatch
, DscDefaultValue
, InfMatch
, InfDefaultValue
, DecMatch
, DecDefaultValue
)
1292 Value
= SkuInfo
.DefaultValue
1293 IsByteArray
, ArrayList
= ByteArrayForamt(Value
)
1298 FileWrite(File
, ' %-*s : %6s %10s = %s' % (self
.MaxLen
, Flag
+ ' ' + PcdTokenCName
, TypeName
, '(' + Pcd
.DatumType
+ ')', "{"))
1300 FileWrite(File
, ' %-*s : %6s %10s %10s = %s' % (self
.MaxLen
, Flag
+ ' ' + PcdTokenCName
, TypeName
, '(' + Pcd
.DatumType
+ ')', '(' + SkuIdName
+ ')', "{"))
1301 for Array
in ArrayList
:
1302 FileWrite(File
, Array
)
1304 if Pcd
.DatumType
in TAB_PCD_CLEAN_NUMERIC_TYPES
:
1305 if Value
.startswith(('0x', '0X')):
1306 Value
= '{} ({:d})'.format(Value
, int(Value
, 0))
1308 Value
= "0x{:X} ({})".format(int(Value
, 0), Value
)
1310 FileWrite(File
, ' %-*s : %6s %10s = %s' % (self
.MaxLen
, Flag
+ ' ' + PcdTokenCName
, TypeName
, '(' + Pcd
.DatumType
+ ')', Value
))
1312 FileWrite(File
, ' %-*s : %6s %10s %10s = %s' % (self
.MaxLen
, Flag
+ ' ' + PcdTokenCName
, TypeName
, '(' + Pcd
.DatumType
+ ')', '(' + SkuIdName
+ ')', Value
))
1316 FileWrite(File
, ' %-*s : %6s %10s = %s' % (self
.MaxLen
, ' ', TypeName
, '(' + Pcd
.DatumType
+ ')', "{"))
1318 FileWrite(File
, ' %-*s : %6s %10s %10s = %s' % (self
.MaxLen
, ' ', TypeName
, '(' + Pcd
.DatumType
+ ')', '(' + SkuIdName
+ ')', "{"))
1319 for Array
in ArrayList
:
1320 FileWrite(File
, Array
)
1322 if Pcd
.DatumType
in TAB_PCD_CLEAN_NUMERIC_TYPES
:
1323 if Value
.startswith(('0x', '0X')):
1324 Value
= '{} ({:d})'.format(Value
, int(Value
, 0))
1326 Value
= "0x{:X} ({})".format(int(Value
, 0), Value
)
1328 FileWrite(File
, ' %-*s : %6s %10s = %s' % (self
.MaxLen
, ' ', TypeName
, '(' + Pcd
.DatumType
+ ')', Value
))
1330 FileWrite(File
, ' %-*s : %6s %10s %10s = %s' % (self
.MaxLen
, ' ', TypeName
, '(' + Pcd
.DatumType
+ ')', '(' + SkuIdName
+ ')', Value
))
1331 if TypeName
in ('DYNVPD', 'DEXVPD'):
1332 FileWrite(File
, '%*s' % (self
.MaxLen
+ 4, SkuInfo
.VpdOffset
))
1334 OverrideValues
= Pcd
.SkuOverrideValues
[Sku
]
1336 Keys
= OverrideValues
.keys()
1337 OverrideFieldStruct
= self
.OverrideFieldValue(Pcd
, OverrideValues
[Keys
[0]])
1338 self
.PrintStructureInfo(File
, OverrideFieldStruct
)
1339 self
.PrintPcdDefault(File
, Pcd
, IsStructure
, DscMatch
, DscDefaultValue
, InfMatch
, InfDefaultValue
, DecMatch
, DecDefaultValue
)
1341 def OverrideFieldValue(self
, Pcd
, OverrideStruct
):
1342 OverrideFieldStruct
= collections
.OrderedDict()
1344 for Key
, Values
in OverrideStruct
.items():
1345 if Values
[1] and Values
[1].endswith('.dsc'):
1346 OverrideFieldStruct
[Key
] = Values
1347 if Pcd
.PcdFieldValueFromFdf
:
1348 for Key
, Values
in Pcd
.PcdFieldValueFromFdf
.items():
1349 OverrideFieldStruct
[Key
] = Values
1350 if Pcd
.PcdFieldValueFromComm
:
1351 for Key
, Values
in Pcd
.PcdFieldValueFromComm
.items():
1352 OverrideFieldStruct
[Key
] = Values
1353 return OverrideFieldStruct
1355 def PrintStructureInfo(self
, File
, Struct
):
1356 for Key
, Value
in Struct
.items():
1357 if Value
[1] and 'build command options' in Value
[1]:
1358 FileWrite(File
, ' *B %-*s = %s' % (self
.MaxLen
+ 4, '.' + Key
, Value
[0]))
1360 FileWrite(File
, ' %-*s = %s' % (self
.MaxLen
+ 4, '.' + Key
, Value
[0]))
1362 def StrtoHex(self
, value
):
1364 value
= hex(int(value
))
1367 if value
.startswith("L\"") and value
.endswith("\""):
1369 for ch
in value
[2:-1]:
1370 valuelist
.append(hex(ord(ch
)))
1371 valuelist
.append('0x00')
1373 elif value
.startswith("\"") and value
.endswith("\""):
1374 return hex(ord(value
[1:-1]))
1375 elif value
.startswith("{") and value
.endswith("}"):
1377 if ',' not in value
:
1379 for ch
in value
[1:-1].split(','):
1381 if ch
.startswith('0x') or ch
.startswith('0X'):
1382 valuelist
.append(ch
)
1385 valuelist
.append(hex(int(ch
.strip())))
1393 # Reports platform and module Prediction information
1395 # This class reports the platform execution order prediction section and
1396 # module load fixed address prediction subsection in the build report file.
1398 class PredictionReport(object):
1400 # Constructor function for class PredictionReport
1402 # This constructor function generates PredictionReport object for the platform.
1404 # @param self: The object pointer
1405 # @param Wa Workspace context information
1407 def __init__(self
, Wa
):
1408 self
._MapFileName
= os
.path
.join(Wa
.BuildDir
, Wa
.Name
+ ".map")
1409 self
._MapFileParsed
= False
1410 self
._EotToolInvoked
= False
1411 self
._FvDir
= Wa
.FvDir
1412 self
._EotDir
= Wa
.BuildDir
1413 self
._FfsEntryPoint
= {}
1415 self
._SourceList
= []
1416 self
.FixedMapDict
= {}
1421 # Collect all platform reference source files and GUID C Name
1423 for Pa
in Wa
.AutoGenObjectList
:
1424 for Module
in Pa
.LibraryAutoGenList
+ Pa
.ModuleAutoGenList
:
1426 # BASE typed modules are EFI agnostic, so we need not scan
1427 # their source code to find PPI/Protocol produce or consume
1430 if Module
.ModuleType
== SUP_MODULE_BASE
:
1433 # Add module referenced source files
1435 self
._SourceList
.append(str(Module
))
1437 for Source
in Module
.SourceFileList
:
1438 if os
.path
.splitext(str(Source
))[1].lower() == ".c":
1439 self
._SourceList
.append(" " + str(Source
))
1440 FindIncludeFiles(Source
.Path
, Module
.IncludePathList
, IncludeList
)
1441 for IncludeFile
in IncludeList
.values():
1442 self
._SourceList
.append(" " + IncludeFile
)
1444 for Guid
in Module
.PpiList
:
1445 self
._GuidMap
[Guid
] = GuidStructureStringToGuidString(Module
.PpiList
[Guid
])
1446 for Guid
in Module
.ProtocolList
:
1447 self
._GuidMap
[Guid
] = GuidStructureStringToGuidString(Module
.ProtocolList
[Guid
])
1448 for Guid
in Module
.GuidList
:
1449 self
._GuidMap
[Guid
] = GuidStructureStringToGuidString(Module
.GuidList
[Guid
])
1451 if Module
.Guid
and not Module
.IsLibrary
:
1452 EntryPoint
= " ".join(Module
.Module
.ModuleEntryPointList
)
1453 if int(str(Module
.AutoGenVersion
), 0) >= 0x00010005:
1454 RealEntryPoint
= "_ModuleEntryPoint"
1456 RealEntryPoint
= EntryPoint
1457 if EntryPoint
== "_ModuleEntryPoint":
1458 CCFlags
= Module
.BuildOption
.get("CC", {}).get("FLAGS", "")
1459 Match
= gGlueLibEntryPoint
.search(CCFlags
)
1461 EntryPoint
= Match
.group(1)
1463 self
._FfsEntryPoint
[Module
.Guid
.upper()] = (EntryPoint
, RealEntryPoint
)
1467 # Collect platform firmware volume list as the input of EOT.
1471 for Fd
in Wa
.FdfProfile
.FdDict
:
1472 for FdRegion
in Wa
.FdfProfile
.FdDict
[Fd
].RegionList
:
1473 if FdRegion
.RegionType
!= BINARY_FILE_TYPE_FV
:
1475 for FvName
in FdRegion
.RegionDataList
:
1476 if FvName
in self
._FvList
:
1478 self
._FvList
.append(FvName
)
1479 for Ffs
in Wa
.FdfProfile
.FvDict
[FvName
.upper()].FfsList
:
1480 for Section
in Ffs
.SectionList
:
1482 for FvSection
in Section
.SectionList
:
1483 if FvSection
.FvName
in self
._FvList
:
1485 self
._FvList
.append(FvSection
.FvName
)
1486 except AttributeError:
1491 # Parse platform fixed address map files
1493 # This function parses the platform final fixed address map file to get
1494 # the database of predicted fixed address for module image base, entry point
1497 # @param self: The object pointer
1499 def _ParseMapFile(self
):
1500 if self
._MapFileParsed
:
1502 self
._MapFileParsed
= True
1503 if os
.path
.isfile(self
._MapFileName
):
1505 FileContents
= open(self
._MapFileName
).read()
1506 for Match
in gMapFileItemPattern
.finditer(FileContents
):
1507 AddressType
= Match
.group(1)
1508 BaseAddress
= Match
.group(2)
1509 EntryPoint
= Match
.group(3)
1510 Guid
= Match
.group(4).upper()
1511 List
= self
.FixedMapDict
.setdefault(Guid
, [])
1512 List
.append((AddressType
, BaseAddress
, "*I"))
1513 List
.append((AddressType
, EntryPoint
, "*E"))
1515 EdkLogger
.warn(None, "Cannot open file to read", self
._MapFileName
)
1518 # Invokes EOT tool to get the predicted the execution order.
1520 # This function invokes EOT tool to calculate the predicted dispatch order
1522 # @param self: The object pointer
1524 def _InvokeEotTool(self
):
1525 if self
._EotToolInvoked
:
1528 self
._EotToolInvoked
= True
1530 for FvName
in self
._FvList
:
1531 FvFile
= os
.path
.join(self
._FvDir
, FvName
+ ".Fv")
1532 if os
.path
.isfile(FvFile
):
1533 FvFileList
.append(FvFile
)
1535 if len(FvFileList
) == 0:
1538 # Write source file list and GUID file list to an intermediate file
1539 # as the input for EOT tool and dispatch List as the output file
1542 SourceList
= os
.path
.join(self
._EotDir
, "SourceFile.txt")
1543 GuidList
= os
.path
.join(self
._EotDir
, "GuidList.txt")
1544 DispatchList
= os
.path
.join(self
._EotDir
, "Dispatch.txt")
1546 TempFile
= open(SourceList
, "w+")
1547 for Item
in self
._SourceList
:
1548 FileWrite(TempFile
, Item
)
1550 TempFile
= open(GuidList
, "w+")
1551 for Key
in self
._GuidMap
:
1552 FileWrite(TempFile
, "%s %s" % (Key
, self
._GuidMap
[Key
]))
1556 from Eot
.Eot
import Eot
1559 # Invoke EOT tool and echo its runtime performance
1561 EotStartTime
= time
.time()
1562 Eot(CommandLineOption
=False, SourceFileList
=SourceList
, GuidList
=GuidList
,
1563 FvFileList
=' '.join(FvFileList
), Dispatch
=DispatchList
, IsInit
=True)
1564 EotEndTime
= time
.time()
1565 EotDuration
= time
.strftime("%H:%M:%S", time
.gmtime(int(round(EotEndTime
- EotStartTime
))))
1566 EdkLogger
.quiet("EOT run time: %s\n" % EotDuration
)
1569 # Parse the output of EOT tool
1571 for Line
in open(DispatchList
):
1572 if len(Line
.split()) < 4:
1574 (Guid
, Phase
, FfsName
, FilePath
) = Line
.split()
1575 Symbol
= self
._FfsEntryPoint
.get(Guid
, [FfsName
, ""])[0]
1576 if len(Symbol
) > self
.MaxLen
:
1577 self
.MaxLen
= len(Symbol
)
1578 self
.ItemList
.append((Phase
, Symbol
, FilePath
))
1580 EdkLogger
.quiet("(Python %s on %s\n%s)" % (platform
.python_version(), sys
.platform
, traceback
.format_exc()))
1581 EdkLogger
.warn(None, "Failed to generate execution order prediction report, for some error occurred in executing EOT.")
1585 # Generate platform execution order report
1587 # This function generates the predicted module execution order.
1589 # @param self The object pointer
1590 # @param File The file object for report
1592 def _GenerateExecutionOrderReport(self
, File
):
1593 self
._InvokeEotTool
()
1594 if len(self
.ItemList
) == 0:
1596 FileWrite(File
, gSectionStart
)
1597 FileWrite(File
, "Execution Order Prediction")
1598 FileWrite(File
, "*P PEI phase")
1599 FileWrite(File
, "*D DXE phase")
1600 FileWrite(File
, "*E Module INF entry point name")
1601 FileWrite(File
, "*N Module notification function name")
1603 FileWrite(File
, "Type %-*s %s" % (self
.MaxLen
, "Symbol", "Module INF Path"))
1604 FileWrite(File
, gSectionSep
)
1605 for Item
in self
.ItemList
:
1606 FileWrite(File
, "*%sE %-*s %s" % (Item
[0], self
.MaxLen
, Item
[1], Item
[2]))
1608 FileWrite(File
, gSectionStart
)
1611 # Generate Fixed Address report.
1613 # This function generate the predicted fixed address report for a module
1614 # specified by Guid.
1616 # @param self The object pointer
1617 # @param File The file object for report
1618 # @param Guid The module Guid value.
1619 # @param NotifyList The list of all notify function in a module
1621 def _GenerateFixedAddressReport(self
, File
, Guid
, NotifyList
):
1622 self
._ParseMapFile
()
1623 FixedAddressList
= self
.FixedMapDict
.get(Guid
)
1624 if not FixedAddressList
:
1627 FileWrite(File
, gSubSectionStart
)
1628 FileWrite(File
, "Fixed Address Prediction")
1629 FileWrite(File
, "*I Image Loading Address")
1630 FileWrite(File
, "*E Entry Point Address")
1631 FileWrite(File
, "*N Notification Function Address")
1632 FileWrite(File
, "*F Flash Address")
1633 FileWrite(File
, "*M Memory Address")
1634 FileWrite(File
, "*S SMM RAM Offset")
1635 FileWrite(File
, "TOM Top of Memory")
1637 FileWrite(File
, "Type Address Name")
1638 FileWrite(File
, gSubSectionSep
)
1639 for Item
in FixedAddressList
:
1644 Name
= "(Image Base)"
1645 elif Symbol
== "*E":
1646 Name
= self
._FfsEntryPoint
.get(Guid
, ["", "_ModuleEntryPoint"])[1]
1647 elif Symbol
in NotifyList
:
1655 elif "Memory" in Type
:
1661 Value
= "TOM" + Value
1663 FileWrite(File
, "%s %-16s %s" % (Symbol
, Value
, Name
))
1666 # Generate report for the prediction part
1668 # This function generate the predicted fixed address report for a module or
1669 # predicted module execution order for a platform.
1670 # If the input Guid is None, then, it generates the predicted module execution order;
1671 # otherwise it generated the module fixed loading address for the module specified by
1674 # @param self The object pointer
1675 # @param File The file object for report
1676 # @param Guid The module Guid value.
1678 def GenerateReport(self
, File
, Guid
):
1680 self
._GenerateFixedAddressReport
(File
, Guid
.upper(), [])
1682 self
._GenerateExecutionOrderReport
(File
)
1685 # Reports FD region information
1687 # This class reports the FD subsection in the build report file.
1688 # It collects region information of platform flash device.
1689 # If the region is a firmware volume, it lists the set of modules
1690 # and its space information; otherwise, it only lists its region name,
1691 # base address and size in its sub-section header.
1692 # If there are nesting FVs, the nested FVs will list immediate after
1693 # this FD region subsection
1695 class FdRegionReport(object):
1697 # Discover all the nested FV name list.
1699 # This is an internal worker function to discover the all the nested FV information
1700 # in the parent firmware volume. It uses deep first search algorithm recursively to
1701 # find all the FV list name and append them to the list.
1703 # @param self The object pointer
1704 # @param FvName The name of current firmware file system
1705 # @param Wa Workspace context information
1707 def _DiscoverNestedFvList(self
, FvName
, Wa
):
1708 FvDictKey
=FvName
.upper()
1709 if FvDictKey
in Wa
.FdfProfile
.FvDict
:
1710 for Ffs
in Wa
.FdfProfile
.FvDict
[FvName
.upper()].FfsList
:
1711 for Section
in Ffs
.SectionList
:
1713 for FvSection
in Section
.SectionList
:
1714 if FvSection
.FvName
in self
.FvList
:
1716 self
._GuidsDb
[Ffs
.NameGuid
.upper()] = FvSection
.FvName
1717 self
.FvList
.append(FvSection
.FvName
)
1718 self
.FvInfo
[FvSection
.FvName
] = ("Nested FV", 0, 0)
1719 self
._DiscoverNestedFvList
(FvSection
.FvName
, Wa
)
1720 except AttributeError:
1724 # Constructor function for class FdRegionReport
1726 # This constructor function generates FdRegionReport object for a specified FdRegion.
1727 # If the FdRegion is a firmware volume, it will recursively find all its nested Firmware
1728 # volume list. This function also collects GUID map in order to dump module identification
1729 # in the final report.
1731 # @param self: The object pointer
1732 # @param FdRegion The current FdRegion object
1733 # @param Wa Workspace context information
1735 def __init__(self
, FdRegion
, Wa
):
1736 self
.Type
= FdRegion
.RegionType
1737 self
.BaseAddress
= FdRegion
.Offset
1738 self
.Size
= FdRegion
.Size
1742 self
._FvDir
= Wa
.FvDir
1743 self
._WorkspaceDir
= Wa
.WorkspaceDir
1746 # If the input FdRegion is not a firmware volume,
1749 if self
.Type
!= BINARY_FILE_TYPE_FV
:
1753 # Find all nested FVs in the FdRegion
1755 for FvName
in FdRegion
.RegionDataList
:
1756 if FvName
in self
.FvList
:
1758 self
.FvList
.append(FvName
)
1759 self
.FvInfo
[FvName
] = ("Fd Region", self
.BaseAddress
, self
.Size
)
1760 self
._DiscoverNestedFvList
(FvName
, Wa
)
1764 # Collect PCDs declared in DEC files.
1766 for Pa
in Wa
.AutoGenObjectList
:
1767 for Package
in Pa
.PackageList
:
1768 for (TokenCName
, TokenSpaceGuidCName
, DecType
) in Package
.Pcds
:
1769 DecDefaultValue
= Package
.Pcds
[TokenCName
, TokenSpaceGuidCName
, DecType
].DefaultValue
1770 PlatformPcds
[(TokenCName
, TokenSpaceGuidCName
)] = DecDefaultValue
1772 # Collect PCDs defined in DSC file
1774 for Pa
in Wa
.AutoGenObjectList
:
1775 for (TokenCName
, TokenSpaceGuidCName
) in Pa
.Platform
.Pcds
:
1776 DscDefaultValue
= Pa
.Platform
.Pcds
[(TokenCName
, TokenSpaceGuidCName
)].DefaultValue
1777 PlatformPcds
[(TokenCName
, TokenSpaceGuidCName
)] = DscDefaultValue
1780 # Add PEI and DXE a priori files GUIDs defined in PI specification.
1782 self
._GuidsDb
["1B45CC0A-156A-428A-AF62-49864DA0E6E6"] = "PEI Apriori"
1783 self
._GuidsDb
["FC510EE7-FFDC-11D4-BD41-0080C73C8881"] = "DXE Apriori"
1785 # Add ACPI table storage file
1787 self
._GuidsDb
["7E374E25-8E01-4FEE-87F2-390C23C606CD"] = "ACPI table storage"
1789 for Pa
in Wa
.AutoGenObjectList
:
1790 for ModuleKey
in Pa
.Platform
.Modules
:
1791 M
= Pa
.Platform
.Modules
[ModuleKey
].M
1792 InfPath
= mws
.join(Wa
.WorkspaceDir
, M
.MetaFile
.File
)
1793 self
._GuidsDb
[M
.Guid
.upper()] = "%s (%s)" % (M
.Module
.BaseName
, InfPath
)
1796 # Collect the GUID map in the FV firmware volume
1798 for FvName
in self
.FvList
:
1799 FvDictKey
=FvName
.upper()
1800 if FvDictKey
in Wa
.FdfProfile
.FvDict
:
1801 for Ffs
in Wa
.FdfProfile
.FvDict
[FvName
.upper()].FfsList
:
1804 # collect GUID map for binary EFI file in FDF file.
1806 Guid
= Ffs
.NameGuid
.upper()
1807 Match
= gPcdGuidPattern
.match(Ffs
.NameGuid
)
1809 PcdTokenspace
= Match
.group(1)
1810 PcdToken
= Match
.group(2)
1811 if (PcdToken
, PcdTokenspace
) in PlatformPcds
:
1812 GuidValue
= PlatformPcds
[(PcdToken
, PcdTokenspace
)]
1813 Guid
= GuidStructureByteArrayToGuidString(GuidValue
).upper()
1814 for Section
in Ffs
.SectionList
:
1816 ModuleSectFile
= mws
.join(Wa
.WorkspaceDir
, Section
.SectFileName
)
1817 self
._GuidsDb
[Guid
] = ModuleSectFile
1818 except AttributeError:
1820 except AttributeError:
1825 # Internal worker function to generate report for the FD region
1827 # This internal worker function to generate report for the FD region.
1828 # It the type is firmware volume, it lists offset and module identification.
1830 # @param self The object pointer
1831 # @param File The file object for report
1832 # @param Title The title for the FD subsection
1833 # @param BaseAddress The base address for the FD region
1834 # @param Size The size of the FD region
1835 # @param FvName The FV name if the FD region is a firmware volume
1837 def _GenerateReport(self
, File
, Title
, Type
, BaseAddress
, Size
=0, FvName
=None):
1838 FileWrite(File
, gSubSectionStart
)
1839 FileWrite(File
, Title
)
1840 FileWrite(File
, "Type: %s" % Type
)
1841 FileWrite(File
, "Base Address: 0x%X" % BaseAddress
)
1843 if self
.Type
== BINARY_FILE_TYPE_FV
:
1847 if FvName
.upper().endswith('.FV'):
1848 FileExt
= FvName
+ ".txt"
1850 FileExt
= FvName
+ ".Fv.txt"
1852 if not os
.path
.isfile(FileExt
):
1853 FvReportFileName
= mws
.join(self
._WorkspaceDir
, FileExt
)
1854 if not os
.path
.isfile(FvReportFileName
):
1855 FvReportFileName
= os
.path
.join(self
._FvDir
, FileExt
)
1858 # Collect size info in the firmware volume.
1860 FvReport
= open(FvReportFileName
).read()
1861 Match
= gFvTotalSizePattern
.search(FvReport
)
1863 FvTotalSize
= int(Match
.group(1), 16)
1864 Match
= gFvTakenSizePattern
.search(FvReport
)
1866 FvTakenSize
= int(Match
.group(1), 16)
1867 FvFreeSize
= FvTotalSize
- FvTakenSize
1869 # Write size information to the report file.
1871 FileWrite(File
, "Size: 0x%X (%.0fK)" % (FvTotalSize
, FvTotalSize
/ 1024.0))
1872 FileWrite(File
, "Fv Name: %s (%.1f%% Full)" % (FvName
, FvTakenSize
* 100.0 / FvTotalSize
))
1873 FileWrite(File
, "Occupied Size: 0x%X (%.0fK)" % (FvTakenSize
, FvTakenSize
/ 1024.0))
1874 FileWrite(File
, "Free Size: 0x%X (%.0fK)" % (FvFreeSize
, FvFreeSize
/ 1024.0))
1875 FileWrite(File
, "Offset Module")
1876 FileWrite(File
, gSubSectionSep
)
1878 # Write module offset and module identification to the report file.
1881 for Match
in gOffsetGuidPattern
.finditer(FvReport
):
1882 Guid
= Match
.group(2).upper()
1883 OffsetInfo
[Match
.group(1)] = self
._GuidsDb
.get(Guid
, Guid
)
1884 OffsetList
= sorted(OffsetInfo
.keys())
1885 for Offset
in OffsetList
:
1886 FileWrite (File
, "%s %s" % (Offset
, OffsetInfo
[Offset
]))
1888 EdkLogger
.warn(None, "Fail to read report file", FvReportFileName
)
1890 FileWrite(File
, "Size: 0x%X (%.0fK)" % (Size
, Size
/ 1024.0))
1891 FileWrite(File
, gSubSectionEnd
)
1894 # Generate report for the FD region
1896 # This function generates report for the FD region.
1898 # @param self The object pointer
1899 # @param File The file object for report
1901 def GenerateReport(self
, File
):
1902 if (len(self
.FvList
) > 0):
1903 for FvItem
in self
.FvList
:
1904 Info
= self
.FvInfo
[FvItem
]
1905 self
._GenerateReport
(File
, Info
[0], TAB_FV_DIRECTORY
, Info
[1], Info
[2], FvItem
)
1907 self
._GenerateReport
(File
, "FD Region", self
.Type
, self
.BaseAddress
, self
.Size
)
1910 # Reports FD information
1912 # This class reports the FD section in the build report file.
1913 # It collects flash device information for a platform.
1915 class FdReport(object):
1917 # Constructor function for class FdReport
1919 # This constructor function generates FdReport object for a specified
1922 # @param self The object pointer
1923 # @param Fd The current Firmware device object
1924 # @param Wa Workspace context information
1926 def __init__(self
, Fd
, Wa
):
1927 self
.FdName
= Fd
.FdUiName
1928 self
.BaseAddress
= Fd
.BaseAddress
1930 self
.FdRegionList
= [FdRegionReport(FdRegion
, Wa
) for FdRegion
in Fd
.RegionList
]
1931 self
.FvPath
= os
.path
.join(Wa
.BuildDir
, TAB_FV_DIRECTORY
)
1932 self
.VpdFilePath
= os
.path
.join(self
.FvPath
, "%s.map" % Wa
.Platform
.VpdToolGuid
)
1933 self
.VPDBaseAddress
= 0
1935 self
.VPDInfoList
= []
1936 for index
, FdRegion
in enumerate(Fd
.RegionList
):
1937 if str(FdRegion
.RegionType
) is 'FILE' and Wa
.Platform
.VpdToolGuid
in str(FdRegion
.RegionDataList
):
1938 self
.VPDBaseAddress
= self
.FdRegionList
[index
].BaseAddress
1939 self
.VPDSize
= self
.FdRegionList
[index
].Size
1942 if os
.path
.isfile(self
.VpdFilePath
):
1943 fd
= open(self
.VpdFilePath
, "r")
1944 Lines
= fd
.readlines()
1947 if len(Line
) == 0 or Line
.startswith("#"):
1950 PcdName
, SkuId
, Offset
, Size
, Value
= Line
.split("#")[0].split("|")
1951 PcdName
, SkuId
, Offset
, Size
, Value
= PcdName
.strip(), SkuId
.strip(), Offset
.strip(), Size
.strip(), Value
.strip()
1952 if Offset
.lower().startswith('0x'):
1953 Offset
= '0x%08X' % (int(Offset
, 16) + self
.VPDBaseAddress
)
1955 Offset
= '0x%08X' % (int(Offset
, 10) + self
.VPDBaseAddress
)
1956 self
.VPDInfoList
.append("%s | %s | %s | %s | %s" % (PcdName
, SkuId
, Offset
, Size
, Value
))
1958 EdkLogger
.error("BuildReport", CODE_ERROR
, "Fail to parse VPD information file %s" % self
.VpdFilePath
)
1962 # Generate report for the firmware device.
1964 # This function generates report for the firmware device.
1966 # @param self The object pointer
1967 # @param File The file object for report
1969 def GenerateReport(self
, File
):
1970 FileWrite(File
, gSectionStart
)
1971 FileWrite(File
, "Firmware Device (FD)")
1972 FileWrite(File
, "FD Name: %s" % self
.FdName
)
1973 FileWrite(File
, "Base Address: %s" % self
.BaseAddress
)
1974 FileWrite(File
, "Size: 0x%X (%.0fK)" % (self
.Size
, self
.Size
/ 1024.0))
1975 if len(self
.FdRegionList
) > 0:
1976 FileWrite(File
, gSectionSep
)
1977 for FdRegionItem
in self
.FdRegionList
:
1978 FdRegionItem
.GenerateReport(File
)
1980 if len(self
.VPDInfoList
) > 0:
1981 FileWrite(File
, gSubSectionStart
)
1982 FileWrite(File
, "FD VPD Region")
1983 FileWrite(File
, "Base Address: 0x%X" % self
.VPDBaseAddress
)
1984 FileWrite(File
, "Size: 0x%X (%.0fK)" % (self
.VPDSize
, self
.VPDSize
/ 1024.0))
1985 FileWrite(File
, gSubSectionSep
)
1986 for item
in self
.VPDInfoList
:
1987 ValueList
= item
.split('|')
1988 Value
= ValueList
[-1].strip()
1989 IsByteArray
, ArrayList
= ByteArrayForamt(Value
)
1991 ValueList
[-1] = ' {'
1992 FileWrite(File
, '|'.join(ValueList
))
1993 for Array
in ArrayList
:
1994 FileWrite(File
, Array
)
1996 FileWrite(File
, item
)
1997 FileWrite(File
, gSubSectionEnd
)
1998 FileWrite(File
, gSectionEnd
)
2003 # Reports platform information
2005 # This class reports the whole platform information
2007 class PlatformReport(object):
2009 # Constructor function for class PlatformReport
2011 # This constructor function generates PlatformReport object a platform build.
2012 # It generates report for platform summary, flash, global PCDs and detailed
2013 # module information for modules involved in platform build.
2015 # @param self The object pointer
2016 # @param Wa Workspace context information
2017 # @param MaList The list of modules in the platform build
2019 def __init__(self
, Wa
, MaList
, ReportType
):
2020 self
._WorkspaceDir
= Wa
.WorkspaceDir
2021 self
.PlatformName
= Wa
.Name
2022 self
.PlatformDscPath
= Wa
.Platform
2023 self
.Architectures
= " ".join(Wa
.ArchList
)
2024 self
.ToolChain
= Wa
.ToolChain
2025 self
.Target
= Wa
.BuildTarget
2026 self
.OutputPath
= os
.path
.join(Wa
.WorkspaceDir
, Wa
.OutputDir
)
2027 self
.BuildEnvironment
= platform
.platform()
2029 self
.PcdReport
= None
2030 if "PCD" in ReportType
:
2031 self
.PcdReport
= PcdReport(Wa
)
2033 self
.FdReportList
= []
2034 if "FLASH" in ReportType
and Wa
.FdfProfile
and MaList
is None:
2035 for Fd
in Wa
.FdfProfile
.FdDict
:
2036 self
.FdReportList
.append(FdReport(Wa
.FdfProfile
.FdDict
[Fd
], Wa
))
2038 self
.PredictionReport
= None
2039 if "FIXED_ADDRESS" in ReportType
or "EXECUTION_ORDER" in ReportType
:
2040 self
.PredictionReport
= PredictionReport(Wa
)
2042 self
.DepexParser
= None
2043 if "DEPEX" in ReportType
:
2044 self
.DepexParser
= DepexParser(Wa
)
2046 self
.ModuleReportList
= []
2047 if MaList
is not None:
2048 self
._IsModuleBuild
= True
2050 self
.ModuleReportList
.append(ModuleReport(Ma
, ReportType
))
2052 self
._IsModuleBuild
= False
2053 for Pa
in Wa
.AutoGenObjectList
:
2054 ModuleAutoGenList
= []
2055 for ModuleKey
in Pa
.Platform
.Modules
:
2056 ModuleAutoGenList
.append(Pa
.Platform
.Modules
[ModuleKey
].M
)
2057 if GlobalData
.gFdfParser
is not None:
2058 if Pa
.Arch
in GlobalData
.gFdfParser
.Profile
.InfDict
:
2059 INFList
= GlobalData
.gFdfParser
.Profile
.InfDict
[Pa
.Arch
]
2060 for InfName
in INFList
:
2061 InfClass
= PathClass(NormPath(InfName
), Wa
.WorkspaceDir
, Pa
.Arch
)
2062 Ma
= ModuleAutoGen(Wa
, InfClass
, Pa
.BuildTarget
, Pa
.ToolChain
, Pa
.Arch
, Wa
.MetaFile
)
2065 if Ma
not in ModuleAutoGenList
:
2066 ModuleAutoGenList
.append(Ma
)
2067 for MGen
in ModuleAutoGenList
:
2068 self
.ModuleReportList
.append(ModuleReport(MGen
, ReportType
))
2073 # Generate report for the whole platform.
2075 # This function generates report for platform information.
2076 # It comprises of platform summary, global PCD, flash and
2077 # module list sections.
2079 # @param self The object pointer
2080 # @param File The file object for report
2081 # @param BuildDuration The total time to build the modules
2082 # @param AutoGenTime The total time of AutoGen Phase
2083 # @param MakeTime The total time of Make Phase
2084 # @param GenFdsTime The total time of GenFds Phase
2085 # @param ReportType The kind of report items in the final report file
2087 def GenerateReport(self
, File
, BuildDuration
, AutoGenTime
, MakeTime
, GenFdsTime
, ReportType
):
2088 FileWrite(File
, "Platform Summary")
2089 FileWrite(File
, "Platform Name: %s" % self
.PlatformName
)
2090 FileWrite(File
, "Platform DSC Path: %s" % self
.PlatformDscPath
)
2091 FileWrite(File
, "Architectures: %s" % self
.Architectures
)
2092 FileWrite(File
, "Tool Chain: %s" % self
.ToolChain
)
2093 FileWrite(File
, "Target: %s" % self
.Target
)
2094 if GlobalData
.gSkuids
:
2095 FileWrite(File
, "SKUID: %s" % " ".join(GlobalData
.gSkuids
))
2096 if GlobalData
.gDefaultStores
:
2097 FileWrite(File
, "DefaultStore: %s" % " ".join(GlobalData
.gDefaultStores
))
2098 FileWrite(File
, "Output Path: %s" % self
.OutputPath
)
2099 FileWrite(File
, "Build Environment: %s" % self
.BuildEnvironment
)
2100 FileWrite(File
, "Build Duration: %s" % BuildDuration
)
2102 FileWrite(File
, "AutoGen Duration: %s" % AutoGenTime
)
2104 FileWrite(File
, "Make Duration: %s" % MakeTime
)
2106 FileWrite(File
, "GenFds Duration: %s" % GenFdsTime
)
2107 FileWrite(File
, "Report Content: %s" % ", ".join(ReportType
))
2109 if GlobalData
.MixedPcd
:
2110 FileWrite(File
, gSectionStart
)
2111 FileWrite(File
, "The following PCDs use different access methods:")
2112 FileWrite(File
, gSectionSep
)
2113 for PcdItem
in GlobalData
.MixedPcd
:
2114 FileWrite(File
, "%s.%s" % (str(PcdItem
[1]), str(PcdItem
[0])))
2115 FileWrite(File
, gSectionEnd
)
2117 if not self
._IsModuleBuild
:
2118 if "PCD" in ReportType
:
2119 self
.PcdReport
.GenerateReport(File
, None)
2121 if "FLASH" in ReportType
:
2122 for FdReportListItem
in self
.FdReportList
:
2123 FdReportListItem
.GenerateReport(File
)
2125 for ModuleReportItem
in self
.ModuleReportList
:
2126 ModuleReportItem
.GenerateReport(File
, self
.PcdReport
, self
.PredictionReport
, self
.DepexParser
, ReportType
)
2128 if not self
._IsModuleBuild
:
2129 if "EXECUTION_ORDER" in ReportType
:
2130 self
.PredictionReport
.GenerateReport(File
, None)
2132 ## BuildReport class
2134 # This base class contain the routines to collect data and then
2135 # applies certain format to the output report
2137 class BuildReport(object):
2139 # Constructor function for class BuildReport
2141 # This constructor function generates BuildReport object a platform build.
2142 # It generates report for platform summary, flash, global PCDs and detailed
2143 # module information for modules involved in platform build.
2145 # @param self The object pointer
2146 # @param ReportFile The file name to save report file
2147 # @param ReportType The kind of report items in the final report file
2149 def __init__(self
, ReportFile
, ReportType
):
2150 self
.ReportFile
= ReportFile
2152 self
.ReportList
= []
2153 self
.ReportType
= []
2155 for ReportTypeItem
in ReportType
:
2156 if ReportTypeItem
not in self
.ReportType
:
2157 self
.ReportType
.append(ReportTypeItem
)
2159 self
.ReportType
= ["PCD", "LIBRARY", "BUILD_FLAGS", "DEPEX", "HASH", "FLASH", "FIXED_ADDRESS"]
2161 # Adds platform report to the list
2163 # This function adds a platform report to the final report list.
2165 # @param self The object pointer
2166 # @param Wa Workspace context information
2167 # @param MaList The list of modules in the platform build
2169 def AddPlatformReport(self
, Wa
, MaList
=None):
2171 self
.ReportList
.append((Wa
, MaList
))
2174 # Generates the final report.
2176 # This function generates platform build report. It invokes GenerateReport()
2177 # method for every platform report in the list.
2179 # @param self The object pointer
2180 # @param BuildDuration The total time to build the modules
2181 # @param AutoGenTime The total time of AutoGen phase
2182 # @param MakeTime The total time of Make phase
2183 # @param GenFdsTime The total time of GenFds phase
2185 def GenerateReport(self
, BuildDuration
, AutoGenTime
, MakeTime
, GenFdsTime
):
2189 for (Wa
, MaList
) in self
.ReportList
:
2190 PlatformReport(Wa
, MaList
, self
.ReportType
).GenerateReport(File
, BuildDuration
, AutoGenTime
, MakeTime
, GenFdsTime
, self
.ReportType
)
2191 Content
= FileLinesSplit(File
.getvalue(), gLineMaxLength
)
2192 SaveFileOnChange(self
.ReportFile
, Content
, True)
2193 EdkLogger
.quiet("Build report can be found at %s" % os
.path
.abspath(self
.ReportFile
))
2195 EdkLogger
.error(None, FILE_WRITE_FAILURE
, ExtraData
=self
.ReportFile
)
2197 EdkLogger
.error("BuildReport", CODE_ERROR
, "Unknown fatal error when generating build report", ExtraData
=self
.ReportFile
, RaiseError
=False)
2198 EdkLogger
.quiet("(Python %s on %s\n%s)" % (platform
.python_version(), sys
.platform
, traceback
.format_exc()))
2201 # This acts like the main() function for the script, unless it is 'import'ed into another script.
2202 if __name__
== '__main__':