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 UnusedPcdList
= self
.UnusedPcds
.setdefault(Pcd
.TokenSpaceGuidCName
, {}).setdefault(Pcd
.Type
, [])
823 if Pcd
in UnusedPcdList
:
824 UnusedPcdList
.remove(Pcd
)
825 if Pcd
not in PcdList
and Pcd
not in UnusedPcdFullList
:
826 UnusedPcdFullList
.append(Pcd
)
827 if len(Pcd
.TokenCName
) > self
.MaxLen
:
828 self
.MaxLen
= len(Pcd
.TokenCName
)
830 if GlobalData
.gConditionalPcds
:
831 for PcdItem
in GlobalData
.gConditionalPcds
:
833 (TokenSpaceGuidCName
, TokenCName
) = PcdItem
.split('.')
834 if (TokenCName
, TokenSpaceGuidCName
) in Pa
.Platform
.Pcds
:
835 Pcd
= Pa
.Platform
.Pcds
[(TokenCName
, TokenSpaceGuidCName
)]
836 PcdList
= self
.ConditionalPcds
.setdefault(Pcd
.TokenSpaceGuidCName
, {}).setdefault(Pcd
.Type
, [])
837 if Pcd
not in PcdList
:
841 if UnusedPcdFullList
:
842 for Pcd
in UnusedPcdFullList
:
843 if Pcd
.TokenSpaceGuidCName
+ '.' + Pcd
.TokenCName
in GlobalData
.gConditionalPcds
:
845 UnusedPcdList
.append(Pcd
)
847 for Pcd
in UnusedPcdList
:
848 PcdList
= self
.UnusedPcds
.setdefault(Pcd
.TokenSpaceGuidCName
, {}).setdefault(Pcd
.Type
, [])
849 if Pcd
not in PcdList
:
852 for Module
in Pa
.Platform
.Modules
.values():
854 # Collect module override PCDs
856 for ModulePcd
in Module
.M
.ModulePcdList
+ Module
.M
.LibraryPcdList
:
857 TokenCName
= ModulePcd
.TokenCName
858 TokenSpaceGuid
= ModulePcd
.TokenSpaceGuidCName
859 ModuleDefault
= ModulePcd
.DefaultValue
860 ModulePath
= os
.path
.basename(Module
.M
.MetaFile
.File
)
861 self
.ModulePcdOverride
.setdefault((TokenCName
, TokenSpaceGuid
), {})[ModulePath
] = ModuleDefault
865 # Collect PCD DEC default value.
867 self
.DecPcdDefault
= {}
869 for Pa
in Wa
.AutoGenObjectList
:
870 for Package
in Pa
.PackageList
:
871 Guids
= Package
.Guids
872 self
._GuidDict
.update(Guids
)
873 for (TokenCName
, TokenSpaceGuidCName
, DecType
) in Package
.Pcds
:
874 DecDefaultValue
= Package
.Pcds
[TokenCName
, TokenSpaceGuidCName
, DecType
].DefaultValue
875 self
.DecPcdDefault
.setdefault((TokenCName
, TokenSpaceGuidCName
, DecType
), DecDefaultValue
)
877 # Collect PCDs defined in DSC common section
879 self
.DscPcdDefault
= {}
880 for Pa
in Wa
.AutoGenObjectList
:
881 for (TokenCName
, TokenSpaceGuidCName
) in Pa
.Platform
.Pcds
:
882 DscDefaultValue
= Pa
.Platform
.Pcds
[(TokenCName
, TokenSpaceGuidCName
)].DscDefaultValue
884 self
.DscPcdDefault
[(TokenCName
, TokenSpaceGuidCName
)] = DscDefaultValue
886 def GenerateReport(self
, File
, ModulePcdSet
):
888 if self
.ConditionalPcds
:
889 self
.GenerateReportDetail(File
, ModulePcdSet
, 1)
892 for Token
in self
.UnusedPcds
:
893 TokenDict
= self
.UnusedPcds
[Token
]
894 for Type
in TokenDict
:
901 self
.GenerateReportDetail(File
, ModulePcdSet
, 2)
902 self
.GenerateReportDetail(File
, ModulePcdSet
)
905 # Generate report for PCD information
907 # This function generates report for separate module expression
908 # in a platform build.
910 # @param self The object pointer
911 # @param File The file object for report
912 # @param ModulePcdSet Set of all PCDs referenced by module or None for
913 # platform PCD report
914 # @param ReportySubType 0 means platform/module PCD report, 1 means Conditional
915 # directives section report, 2 means Unused Pcds section report
916 # @param DscOverridePcds Module DSC override PCDs set
918 def GenerateReportDetail(self
, File
, ModulePcdSet
, ReportSubType
= 0):
919 PcdDict
= self
.AllPcds
920 if ReportSubType
== 1:
921 PcdDict
= self
.ConditionalPcds
922 elif ReportSubType
== 2:
923 PcdDict
= self
.UnusedPcds
926 FileWrite(File
, gSectionStart
)
927 if ReportSubType
== 1:
928 FileWrite(File
, "Conditional Directives used by the build system")
929 elif ReportSubType
== 2:
930 FileWrite(File
, "PCDs not used by modules or in conditional directives")
932 FileWrite(File
, "Platform Configuration Database Report")
934 FileWrite(File
, " *B - PCD override in the build option")
935 FileWrite(File
, " *P - Platform scoped PCD override in DSC file")
936 FileWrite(File
, " *F - Platform scoped PCD override in FDF file")
937 if not ReportSubType
:
938 FileWrite(File
, " *M - Module scoped PCD override")
939 FileWrite(File
, gSectionSep
)
941 if not ReportSubType
and ModulePcdSet
:
943 # For module PCD sub-section
945 FileWrite(File
, gSubSectionStart
)
946 FileWrite(File
, TAB_BRG_PCD
)
947 FileWrite(File
, gSubSectionSep
)
951 for Type
in PcdDict
[Key
]:
952 for Pcd
in PcdDict
[Key
][Type
]:
953 AllPcdDict
[Key
][(Pcd
.TokenCName
, Type
)] = Pcd
954 for Key
in sorted(AllPcdDict
):
956 # Group PCD by their token space GUID C Name
959 for PcdTokenCName
, Type
in sorted(AllPcdDict
[Key
]):
961 # Group PCD by their usage type
963 Pcd
= AllPcdDict
[Key
][(PcdTokenCName
, Type
)]
964 TypeName
, DecType
= gPcdTypeMap
.get(Type
, ("", Type
))
966 if GlobalData
.MixedPcd
:
967 for PcdKey
in GlobalData
.MixedPcd
:
968 if (Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
) in GlobalData
.MixedPcd
[PcdKey
]:
969 PcdTokenCName
= PcdKey
[0]
971 if MixedPcdFlag
and not ModulePcdSet
:
974 # Get PCD default value and their override relationship
976 DecDefaultValue
= self
.DecPcdDefault
.get((Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
, DecType
))
977 DscDefaultValue
= self
.DscPcdDefault
.get((Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
))
978 DscDefaultValBak
= DscDefaultValue
980 for (CName
, Guid
, Field
) in self
.FdfPcdSet
:
981 if CName
== PcdTokenCName
and Guid
== Key
:
982 DscDefaultValue
= self
.FdfPcdSet
[(CName
, Guid
, Field
)]
984 if DscDefaultValue
!= DscDefaultValBak
:
986 DscDefaultValue
= ValueExpressionEx(DscDefaultValue
, Pcd
.DatumType
, self
._GuidDict
)(True)
987 except BadExpression
as DscDefaultValue
:
988 EdkLogger
.error('BuildReport', FORMAT_INVALID
, "PCD Value: %s, Type: %s" %(DscDefaultValue
, Pcd
.DatumType
))
990 InfDefaultValue
= None
992 PcdValue
= DecDefaultValue
994 PcdValue
= DscDefaultValue
995 Pcd
.DefaultValue
= PcdValue
996 if ModulePcdSet
is not None:
997 if (Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
, Type
) not in ModulePcdSet
:
999 InfDefaultValue
, PcdValue
= ModulePcdSet
[Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
, Type
]
1000 Pcd
.DefaultValue
= PcdValue
1003 InfDefaultValue
= ValueExpressionEx(InfDefaultValue
, Pcd
.DatumType
, self
._GuidDict
)(True)
1004 except BadExpression
as InfDefaultValue
:
1005 EdkLogger
.error('BuildReport', FORMAT_INVALID
, "PCD Value: %s, Type: %s" % (InfDefaultValue
, Pcd
.DatumType
))
1006 if InfDefaultValue
== "":
1007 InfDefaultValue
= None
1009 BuildOptionMatch
= False
1010 if GlobalData
.BuildOptionPcd
:
1011 for pcd
in GlobalData
.BuildOptionPcd
:
1012 if (Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
) == (pcd
[0], pcd
[1]):
1016 Pcd
.DefaultValue
= PcdValue
1017 BuildOptionMatch
= True
1021 if ModulePcdSet
is None:
1023 FileWrite(File
, Key
)
1027 if Pcd
.DatumType
in TAB_PCD_NUMERIC_TYPES
:
1028 PcdValueNumber
= int(PcdValue
.strip(), 0)
1029 if DecDefaultValue
is None:
1032 DecDefaultValueNumber
= int(DecDefaultValue
.strip(), 0)
1033 DecMatch
= (DecDefaultValueNumber
== PcdValueNumber
)
1035 if InfDefaultValue
is None:
1038 InfDefaultValueNumber
= int(InfDefaultValue
.strip(), 0)
1039 InfMatch
= (InfDefaultValueNumber
== PcdValueNumber
)
1041 if DscDefaultValue
is None:
1044 DscDefaultValueNumber
= int(DscDefaultValue
.strip(), 0)
1045 DscMatch
= (DscDefaultValueNumber
== PcdValueNumber
)
1047 if DecDefaultValue
is None:
1050 DecMatch
= (DecDefaultValue
.strip() == PcdValue
.strip())
1052 if InfDefaultValue
is None:
1055 InfMatch
= (InfDefaultValue
.strip() == PcdValue
.strip())
1057 if DscDefaultValue
is None:
1060 DscMatch
= (DscDefaultValue
.strip() == PcdValue
.strip())
1063 if GlobalData
.gStructurePcd
and (self
.Arch
in GlobalData
.gStructurePcd
) and ((Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
) in GlobalData
.gStructurePcd
[self
.Arch
]):
1065 if TypeName
in ('DYNVPD', 'DEXVPD'):
1066 SkuInfoList
= Pcd
.SkuInfoList
1067 Pcd
= GlobalData
.gStructurePcd
[self
.Arch
][(Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
)]
1068 Pcd
.DatumType
= Pcd
.StructName
1069 if TypeName
in ('DYNVPD', 'DEXVPD'):
1070 Pcd
.SkuInfoList
= SkuInfoList
1071 if Pcd
.PcdFieldValueFromComm
:
1072 BuildOptionMatch
= True
1074 elif Pcd
.SkuOverrideValues
:
1076 if not Pcd
.SkuInfoList
:
1077 OverrideValues
= Pcd
.SkuOverrideValues
1079 Keys
= OverrideValues
.keys()
1080 Data
= OverrideValues
[Keys
[0]]
1081 Struct
= Data
.values()[0]
1082 DscOverride
= self
.ParseStruct(Struct
)
1084 SkuList
= sorted(Pcd
.SkuInfoList
.keys())
1086 SkuInfo
= Pcd
.SkuInfoList
[Sku
]
1087 if TypeName
in ('DYNHII', 'DEXHII'):
1088 if SkuInfo
.DefaultStoreDict
:
1089 DefaultStoreList
= sorted(SkuInfo
.DefaultStoreDict
.keys())
1090 for DefaultStore
in DefaultStoreList
:
1091 OverrideValues
= Pcd
.SkuOverrideValues
[Sku
]
1092 DscOverride
= self
.ParseStruct(OverrideValues
[DefaultStore
])
1096 OverrideValues
= Pcd
.SkuOverrideValues
[Sku
]
1098 Keys
= OverrideValues
.keys()
1099 OverrideFieldStruct
= self
.OverrideFieldValue(Pcd
, OverrideValues
[Keys
[0]])
1100 DscOverride
= self
.ParseStruct(OverrideFieldStruct
)
1104 DscDefaultValue
= True
1108 DscDefaultValue
= True
1113 # Report PCD item according to their override relationship
1115 if Pcd
.DatumType
== 'BOOLEAN':
1117 DscDefaultValue
= str(int(DscDefaultValue
, 0))
1119 DecDefaultValue
= str(int(DecDefaultValue
, 0))
1121 InfDefaultValue
= str(int(InfDefaultValue
, 0))
1122 if Pcd
.DefaultValue
:
1123 Pcd
.DefaultValue
= str(int(Pcd
.DefaultValue
, 0))
1125 self
.PrintPcdValue(File
, Pcd
, PcdTokenCName
, TypeName
, IsStructure
, DscMatch
, DscDefaultValBak
, InfMatch
, InfDefaultValue
, DecMatch
, DecDefaultValue
, ' ')
1126 elif InfDefaultValue
and InfMatch
:
1127 self
.PrintPcdValue(File
, Pcd
, PcdTokenCName
, TypeName
, IsStructure
, DscMatch
, DscDefaultValBak
, InfMatch
, InfDefaultValue
, DecMatch
, DecDefaultValue
, '*M')
1128 elif BuildOptionMatch
:
1129 self
.PrintPcdValue(File
, Pcd
, PcdTokenCName
, TypeName
, IsStructure
, DscMatch
, DscDefaultValBak
, InfMatch
, InfDefaultValue
, DecMatch
, DecDefaultValue
, '*B')
1131 if DscDefaultValue
and DscMatch
:
1132 if (Pcd
.TokenCName
, Key
, Field
) in self
.FdfPcdSet
:
1133 self
.PrintPcdValue(File
, Pcd
, PcdTokenCName
, TypeName
, IsStructure
, DscMatch
, DscDefaultValBak
, InfMatch
, InfDefaultValue
, DecMatch
, DecDefaultValue
, '*F')
1135 self
.PrintPcdValue(File
, Pcd
, PcdTokenCName
, TypeName
, IsStructure
, DscMatch
, DscDefaultValBak
, InfMatch
, InfDefaultValue
, DecMatch
, DecDefaultValue
, '*P')
1137 self
.PrintPcdValue(File
, Pcd
, PcdTokenCName
, TypeName
, IsStructure
, DscMatch
, DscDefaultValBak
, InfMatch
, InfDefaultValue
, DecMatch
, DecDefaultValue
, '*M')
1139 if ModulePcdSet
is None:
1142 if not TypeName
in ('PATCH', 'FLAG', 'FIXED'):
1144 if not BuildOptionMatch
:
1145 ModuleOverride
= self
.ModulePcdOverride
.get((Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
), {})
1146 for ModulePath
in ModuleOverride
:
1147 ModuleDefault
= ModuleOverride
[ModulePath
]
1148 if Pcd
.DatumType
in TAB_PCD_NUMERIC_TYPES
:
1149 ModulePcdDefaultValueNumber
= int(ModuleDefault
.strip(), 0)
1150 Match
= (ModulePcdDefaultValueNumber
== PcdValueNumber
)
1151 if Pcd
.DatumType
== 'BOOLEAN':
1152 ModuleDefault
= str(ModulePcdDefaultValueNumber
)
1154 Match
= (ModuleDefault
.strip() == PcdValue
.strip())
1157 IsByteArray
, ArrayList
= ByteArrayForamt(ModuleDefault
.strip())
1159 FileWrite(File
, ' *M %-*s = %s' % (self
.MaxLen
+ 15, ModulePath
, '{'))
1160 for Array
in ArrayList
:
1161 FileWrite(File
, Array
)
1163 Value
= ModuleDefault
.strip()
1164 if Pcd
.DatumType
in TAB_PCD_CLEAN_NUMERIC_TYPES
:
1165 if Value
.startswith(('0x', '0X')):
1166 Value
= '{} ({:d})'.format(Value
, int(Value
, 0))
1168 Value
= "0x{:X} ({})".format(int(Value
, 0), Value
)
1169 FileWrite(File
, ' *M %-*s = %s' % (self
.MaxLen
+ 15, ModulePath
, Value
))
1171 if ModulePcdSet
is None:
1172 FileWrite(File
, gSectionEnd
)
1174 if not ReportSubType
and ModulePcdSet
:
1175 FileWrite(File
, gSubSectionEnd
)
1177 def ParseStruct(self
, struct
):
1178 HasDscOverride
= False
1180 for _
, Values
in struct
.items():
1181 if Values
[1] and Values
[1].endswith('.dsc'):
1182 HasDscOverride
= True
1184 return HasDscOverride
1186 def PrintPcdDefault(self
, File
, Pcd
, IsStructure
, DscMatch
, DscDefaultValue
, InfMatch
, InfDefaultValue
, DecMatch
, DecDefaultValue
):
1187 if not DscMatch
and DscDefaultValue
is not None:
1188 Value
= DscDefaultValue
.strip()
1189 IsByteArray
, ArrayList
= ByteArrayForamt(Value
)
1191 FileWrite(File
, ' %*s = %s' % (self
.MaxLen
+ 19, 'DSC DEFAULT', "{"))
1192 for Array
in ArrayList
:
1193 FileWrite(File
, Array
)
1195 if Pcd
.DatumType
in TAB_PCD_CLEAN_NUMERIC_TYPES
:
1196 if Value
.startswith(('0x', '0X')):
1197 Value
= '{} ({:d})'.format(Value
, int(Value
, 0))
1199 Value
= "0x{:X} ({})".format(int(Value
, 0), Value
)
1200 FileWrite(File
, ' %*s = %s' % (self
.MaxLen
+ 19, 'DSC DEFAULT', Value
))
1201 if not InfMatch
and InfDefaultValue
is not None:
1202 Value
= InfDefaultValue
.strip()
1203 IsByteArray
, ArrayList
= ByteArrayForamt(Value
)
1205 FileWrite(File
, ' %*s = %s' % (self
.MaxLen
+ 19, 'INF DEFAULT', "{"))
1206 for Array
in ArrayList
:
1207 FileWrite(File
, Array
)
1209 if Pcd
.DatumType
in TAB_PCD_CLEAN_NUMERIC_TYPES
:
1210 if Value
.startswith(('0x', '0X')):
1211 Value
= '{} ({:d})'.format(Value
, int(Value
, 0))
1213 Value
= "0x{:X} ({})".format(int(Value
, 0), Value
)
1214 FileWrite(File
, ' %*s = %s' % (self
.MaxLen
+ 19, 'INF DEFAULT', Value
))
1216 if not DecMatch
and DecDefaultValue
is not None:
1217 Value
= DecDefaultValue
.strip()
1218 IsByteArray
, ArrayList
= ByteArrayForamt(Value
)
1220 FileWrite(File
, ' %*s = %s' % (self
.MaxLen
+ 19, 'DEC DEFAULT', "{"))
1221 for Array
in ArrayList
:
1222 FileWrite(File
, Array
)
1224 if Pcd
.DatumType
in TAB_PCD_CLEAN_NUMERIC_TYPES
:
1225 if Value
.startswith(('0x', '0X')):
1226 Value
= '{} ({:d})'.format(Value
, int(Value
, 0))
1228 Value
= "0x{:X} ({})".format(int(Value
, 0), Value
)
1229 FileWrite(File
, ' %*s = %s' % (self
.MaxLen
+ 19, 'DEC DEFAULT', Value
))
1231 self
.PrintStructureInfo(File
, Pcd
.DefaultValues
)
1232 if DecMatch
and IsStructure
:
1233 self
.PrintStructureInfo(File
, Pcd
.DefaultValues
)
1235 def PrintPcdValue(self
, File
, Pcd
, PcdTokenCName
, TypeName
, IsStructure
, DscMatch
, DscDefaultValue
, InfMatch
, InfDefaultValue
, DecMatch
, DecDefaultValue
, Flag
= ' '):
1236 if not Pcd
.SkuInfoList
:
1237 Value
= Pcd
.DefaultValue
1238 IsByteArray
, ArrayList
= ByteArrayForamt(Value
)
1240 FileWrite(File
, ' %-*s : %6s %10s = %s' % (self
.MaxLen
, Flag
+ ' ' + PcdTokenCName
, TypeName
, '(' + Pcd
.DatumType
+ ')', '{'))
1241 for Array
in ArrayList
:
1242 FileWrite(File
, Array
)
1244 if Pcd
.DatumType
in TAB_PCD_CLEAN_NUMERIC_TYPES
:
1245 if Value
.startswith(('0x', '0X')):
1246 Value
= '{} ({:d})'.format(Value
, int(Value
, 0))
1248 Value
= "0x{:X} ({})".format(int(Value
, 0), Value
)
1249 FileWrite(File
, ' %-*s : %6s %10s = %s' % (self
.MaxLen
, Flag
+ ' ' + PcdTokenCName
, TypeName
, '(' + Pcd
.DatumType
+ ')', Value
))
1251 OverrideValues
= Pcd
.SkuOverrideValues
1253 Keys
= OverrideValues
.keys()
1254 Data
= OverrideValues
[Keys
[0]]
1255 Struct
= Data
.values()[0]
1256 OverrideFieldStruct
= self
.OverrideFieldValue(Pcd
, Struct
)
1257 self
.PrintStructureInfo(File
, OverrideFieldStruct
)
1258 self
.PrintPcdDefault(File
, Pcd
, IsStructure
, DscMatch
, DscDefaultValue
, InfMatch
, InfDefaultValue
, DecMatch
, DecDefaultValue
)
1261 SkuList
= sorted(Pcd
.SkuInfoList
.keys())
1263 SkuInfo
= Pcd
.SkuInfoList
[Sku
]
1264 SkuIdName
= SkuInfo
.SkuIdName
1265 if TypeName
in ('DYNHII', 'DEXHII'):
1266 if SkuInfo
.DefaultStoreDict
:
1267 DefaultStoreList
= sorted(SkuInfo
.DefaultStoreDict
.keys())
1268 for DefaultStore
in DefaultStoreList
:
1269 Value
= SkuInfo
.DefaultStoreDict
[DefaultStore
]
1270 IsByteArray
, ArrayList
= ByteArrayForamt(Value
)
1271 if Pcd
.DatumType
== 'BOOLEAN':
1272 Value
= str(int(Value
, 0))
1276 if self
.DefaultStoreSingle
and self
.SkuSingle
:
1277 FileWrite(File
, ' %-*s : %6s %10s = %s' % (self
.MaxLen
, Flag
+ ' ' + PcdTokenCName
, TypeName
, '(' + Pcd
.DatumType
+ ')', '{'))
1278 elif self
.DefaultStoreSingle
and not self
.SkuSingle
:
1279 FileWrite(File
, ' %-*s : %6s %10s %10s = %s' % (self
.MaxLen
, Flag
+ ' ' + PcdTokenCName
, TypeName
, '(' + Pcd
.DatumType
+ ')', '(' + SkuIdName
+ ')', '{'))
1280 elif not self
.DefaultStoreSingle
and self
.SkuSingle
:
1281 FileWrite(File
, ' %-*s : %6s %10s %10s = %s' % (self
.MaxLen
, Flag
+ ' ' + PcdTokenCName
, TypeName
, '(' + Pcd
.DatumType
+ ')', '(' + DefaultStore
+ ')', '{'))
1283 FileWrite(File
, ' %-*s : %6s %10s %10s %10s = %s' % (self
.MaxLen
, Flag
+ ' ' + PcdTokenCName
, TypeName
, '(' + Pcd
.DatumType
+ ')', '(' + SkuIdName
+ ')', '(' + DefaultStore
+ ')', '{'))
1284 for Array
in ArrayList
:
1285 FileWrite(File
, Array
)
1287 if Pcd
.DatumType
in TAB_PCD_CLEAN_NUMERIC_TYPES
:
1288 if Value
.startswith(('0x', '0X')):
1289 Value
= '{} ({:d})'.format(Value
, int(Value
, 0))
1291 Value
= "0x{:X} ({})".format(int(Value
, 0), Value
)
1292 if self
.DefaultStoreSingle
and self
.SkuSingle
:
1293 FileWrite(File
, ' %-*s : %6s %10s = %s' % (self
.MaxLen
, Flag
+ ' ' + PcdTokenCName
, TypeName
, '(' + Pcd
.DatumType
+ ')', Value
))
1294 elif self
.DefaultStoreSingle
and not self
.SkuSingle
:
1295 FileWrite(File
, ' %-*s : %6s %10s %10s = %s' % (self
.MaxLen
, Flag
+ ' ' + PcdTokenCName
, TypeName
, '(' + Pcd
.DatumType
+ ')', '(' + SkuIdName
+ ')', Value
))
1296 elif not self
.DefaultStoreSingle
and self
.SkuSingle
:
1297 FileWrite(File
, ' %-*s : %6s %10s %10s = %s' % (self
.MaxLen
, Flag
+ ' ' + PcdTokenCName
, TypeName
, '(' + Pcd
.DatumType
+ ')', '(' + DefaultStore
+ ')', Value
))
1299 FileWrite(File
, ' %-*s : %6s %10s %10s %10s = %s' % (self
.MaxLen
, Flag
+ ' ' + PcdTokenCName
, TypeName
, '(' + Pcd
.DatumType
+ ')', '(' + SkuIdName
+ ')', '(' + DefaultStore
+ ')', Value
))
1302 if self
.DefaultStoreSingle
and self
.SkuSingle
:
1303 FileWrite(File
, ' %-*s : %6s %10s = %s' % (self
.MaxLen
, ' ', TypeName
, '(' + Pcd
.DatumType
+ ')', '{'))
1304 elif self
.DefaultStoreSingle
and not self
.SkuSingle
:
1305 FileWrite(File
, ' %-*s : %6s %10s %10s = %s' % (self
.MaxLen
, ' ', TypeName
, '(' + Pcd
.DatumType
+ ')', '(' + SkuIdName
+ ')', '{'))
1306 elif not self
.DefaultStoreSingle
and self
.SkuSingle
:
1307 FileWrite(File
, ' %-*s : %6s %10s %10s = %s' % (self
.MaxLen
, ' ', TypeName
, '(' + Pcd
.DatumType
+ ')', '(' + DefaultStore
+ ')', '{'))
1309 FileWrite(File
, ' %-*s : %6s %10s %10s %10s = %s' % (self
.MaxLen
, ' ', TypeName
, '(' + Pcd
.DatumType
+ ')', '(' + SkuIdName
+ ')', '(' + DefaultStore
+ ')', '{'))
1310 for Array
in ArrayList
:
1311 FileWrite(File
, Array
)
1313 if Pcd
.DatumType
in TAB_PCD_CLEAN_NUMERIC_TYPES
:
1314 if Value
.startswith(('0x', '0X')):
1315 Value
= '{} ({:d})'.format(Value
, int(Value
, 0))
1317 Value
= "0x{:X} ({})".format(int(Value
, 0), Value
)
1318 if self
.DefaultStoreSingle
and self
.SkuSingle
:
1319 FileWrite(File
, ' %-*s : %6s %10s = %s' % (self
.MaxLen
, ' ', TypeName
, '(' + Pcd
.DatumType
+ ')', Value
))
1320 elif self
.DefaultStoreSingle
and not self
.SkuSingle
:
1321 FileWrite(File
, ' %-*s : %6s %10s %10s = %s' % (self
.MaxLen
, ' ', TypeName
, '(' + Pcd
.DatumType
+ ')', '(' + SkuIdName
+ ')', Value
))
1322 elif not self
.DefaultStoreSingle
and self
.SkuSingle
:
1323 FileWrite(File
, ' %-*s : %6s %10s %10s = %s' % (self
.MaxLen
, ' ', TypeName
, '(' + Pcd
.DatumType
+ ')', '(' + DefaultStore
+ ')', Value
))
1325 FileWrite(File
, ' %-*s : %6s %10s %10s %10s = %s' % (self
.MaxLen
, ' ', TypeName
, '(' + Pcd
.DatumType
+ ')', '(' + SkuIdName
+ ')', '(' + DefaultStore
+ ')', Value
))
1326 FileWrite(File
, '%*s: %s: %s' % (self
.MaxLen
+ 4, SkuInfo
.VariableGuid
, SkuInfo
.VariableName
, SkuInfo
.VariableOffset
))
1328 OverrideValues
= Pcd
.SkuOverrideValues
[Sku
]
1329 OverrideFieldStruct
= self
.OverrideFieldValue(Pcd
, OverrideValues
[DefaultStore
])
1330 self
.PrintStructureInfo(File
, OverrideFieldStruct
)
1331 self
.PrintPcdDefault(File
, Pcd
, IsStructure
, DscMatch
, DscDefaultValue
, InfMatch
, InfDefaultValue
, DecMatch
, DecDefaultValue
)
1333 Value
= SkuInfo
.DefaultValue
1334 IsByteArray
, ArrayList
= ByteArrayForamt(Value
)
1335 if Pcd
.DatumType
== 'BOOLEAN':
1336 Value
= str(int(Value
, 0))
1341 FileWrite(File
, ' %-*s : %6s %10s = %s' % (self
.MaxLen
, Flag
+ ' ' + PcdTokenCName
, TypeName
, '(' + Pcd
.DatumType
+ ')', "{"))
1343 FileWrite(File
, ' %-*s : %6s %10s %10s = %s' % (self
.MaxLen
, Flag
+ ' ' + PcdTokenCName
, TypeName
, '(' + Pcd
.DatumType
+ ')', '(' + SkuIdName
+ ')', "{"))
1344 for Array
in ArrayList
:
1345 FileWrite(File
, Array
)
1347 if Pcd
.DatumType
in TAB_PCD_CLEAN_NUMERIC_TYPES
:
1348 if Value
.startswith(('0x', '0X')):
1349 Value
= '{} ({:d})'.format(Value
, int(Value
, 0))
1351 Value
= "0x{:X} ({})".format(int(Value
, 0), Value
)
1353 FileWrite(File
, ' %-*s : %6s %10s = %s' % (self
.MaxLen
, Flag
+ ' ' + PcdTokenCName
, TypeName
, '(' + Pcd
.DatumType
+ ')', Value
))
1355 FileWrite(File
, ' %-*s : %6s %10s %10s = %s' % (self
.MaxLen
, Flag
+ ' ' + PcdTokenCName
, TypeName
, '(' + Pcd
.DatumType
+ ')', '(' + SkuIdName
+ ')', Value
))
1359 FileWrite(File
, ' %-*s : %6s %10s = %s' % (self
.MaxLen
, ' ', TypeName
, '(' + Pcd
.DatumType
+ ')', "{"))
1361 FileWrite(File
, ' %-*s : %6s %10s %10s = %s' % (self
.MaxLen
, ' ', TypeName
, '(' + Pcd
.DatumType
+ ')', '(' + SkuIdName
+ ')', "{"))
1362 for Array
in ArrayList
:
1363 FileWrite(File
, Array
)
1365 if Pcd
.DatumType
in TAB_PCD_CLEAN_NUMERIC_TYPES
:
1366 if Value
.startswith(('0x', '0X')):
1367 Value
= '{} ({:d})'.format(Value
, int(Value
, 0))
1369 Value
= "0x{:X} ({})".format(int(Value
, 0), Value
)
1371 FileWrite(File
, ' %-*s : %6s %10s = %s' % (self
.MaxLen
, ' ', TypeName
, '(' + Pcd
.DatumType
+ ')', Value
))
1373 FileWrite(File
, ' %-*s : %6s %10s %10s = %s' % (self
.MaxLen
, ' ', TypeName
, '(' + Pcd
.DatumType
+ ')', '(' + SkuIdName
+ ')', Value
))
1374 if TypeName
in ('DYNVPD', 'DEXVPD'):
1375 FileWrite(File
, '%*s' % (self
.MaxLen
+ 4, SkuInfo
.VpdOffset
))
1377 OverrideValues
= Pcd
.SkuOverrideValues
[Sku
]
1379 Keys
= OverrideValues
.keys()
1380 OverrideFieldStruct
= self
.OverrideFieldValue(Pcd
, OverrideValues
[Keys
[0]])
1381 self
.PrintStructureInfo(File
, OverrideFieldStruct
)
1382 self
.PrintPcdDefault(File
, Pcd
, IsStructure
, DscMatch
, DscDefaultValue
, InfMatch
, InfDefaultValue
, DecMatch
, DecDefaultValue
)
1384 def OverrideFieldValue(self
, Pcd
, OverrideStruct
):
1385 OverrideFieldStruct
= collections
.OrderedDict()
1387 for Key
, Values
in OverrideStruct
.items():
1388 if Values
[1] and Values
[1].endswith('.dsc'):
1389 OverrideFieldStruct
[Key
] = Values
1390 if Pcd
.PcdFieldValueFromFdf
:
1391 for Key
, Values
in Pcd
.PcdFieldValueFromFdf
.items():
1392 if Key
in OverrideFieldStruct
and Values
[0] == OverrideFieldStruct
[Key
][0]:
1394 OverrideFieldStruct
[Key
] = Values
1395 if Pcd
.PcdFieldValueFromComm
:
1396 for Key
, Values
in Pcd
.PcdFieldValueFromComm
.items():
1397 if Key
in OverrideFieldStruct
and Values
[0] == OverrideFieldStruct
[Key
][0]:
1399 OverrideFieldStruct
[Key
] = Values
1400 return OverrideFieldStruct
1402 def PrintStructureInfo(self
, File
, Struct
):
1403 for Key
, Value
in sorted(Struct
.items(), key
=lambda x
: x
[0]):
1404 if Value
[1] and 'build command options' in Value
[1]:
1405 FileWrite(File
, ' *B %-*s = %s' % (self
.MaxLen
+ 4, '.' + Key
, Value
[0]))
1406 elif Value
[1] and Value
[1].endswith('.fdf'):
1407 FileWrite(File
, ' *F %-*s = %s' % (self
.MaxLen
+ 4, '.' + Key
, Value
[0]))
1409 FileWrite(File
, ' %-*s = %s' % (self
.MaxLen
+ 4, '.' + Key
, Value
[0]))
1411 def StrtoHex(self
, value
):
1413 value
= hex(int(value
))
1416 if value
.startswith("L\"") and value
.endswith("\""):
1418 for ch
in value
[2:-1]:
1419 valuelist
.append(hex(ord(ch
)))
1420 valuelist
.append('0x00')
1422 elif value
.startswith("\"") and value
.endswith("\""):
1423 return hex(ord(value
[1:-1]))
1424 elif value
.startswith("{") and value
.endswith("}"):
1426 if ',' not in value
:
1428 for ch
in value
[1:-1].split(','):
1430 if ch
.startswith('0x') or ch
.startswith('0X'):
1431 valuelist
.append(ch
)
1434 valuelist
.append(hex(int(ch
.strip())))
1442 # Reports platform and module Prediction information
1444 # This class reports the platform execution order prediction section and
1445 # module load fixed address prediction subsection in the build report file.
1447 class PredictionReport(object):
1449 # Constructor function for class PredictionReport
1451 # This constructor function generates PredictionReport object for the platform.
1453 # @param self: The object pointer
1454 # @param Wa Workspace context information
1456 def __init__(self
, Wa
):
1457 self
._MapFileName
= os
.path
.join(Wa
.BuildDir
, Wa
.Name
+ ".map")
1458 self
._MapFileParsed
= False
1459 self
._EotToolInvoked
= False
1460 self
._FvDir
= Wa
.FvDir
1461 self
._EotDir
= Wa
.BuildDir
1462 self
._FfsEntryPoint
= {}
1464 self
._SourceList
= []
1465 self
.FixedMapDict
= {}
1470 # Collect all platform reference source files and GUID C Name
1472 for Pa
in Wa
.AutoGenObjectList
:
1473 for Module
in Pa
.LibraryAutoGenList
+ Pa
.ModuleAutoGenList
:
1475 # BASE typed modules are EFI agnostic, so we need not scan
1476 # their source code to find PPI/Protocol produce or consume
1479 if Module
.ModuleType
== SUP_MODULE_BASE
:
1482 # Add module referenced source files
1484 self
._SourceList
.append(str(Module
))
1486 for Source
in Module
.SourceFileList
:
1487 if os
.path
.splitext(str(Source
))[1].lower() == ".c":
1488 self
._SourceList
.append(" " + str(Source
))
1489 FindIncludeFiles(Source
.Path
, Module
.IncludePathList
, IncludeList
)
1490 for IncludeFile
in IncludeList
.values():
1491 self
._SourceList
.append(" " + IncludeFile
)
1493 for Guid
in Module
.PpiList
:
1494 self
._GuidMap
[Guid
] = GuidStructureStringToGuidString(Module
.PpiList
[Guid
])
1495 for Guid
in Module
.ProtocolList
:
1496 self
._GuidMap
[Guid
] = GuidStructureStringToGuidString(Module
.ProtocolList
[Guid
])
1497 for Guid
in Module
.GuidList
:
1498 self
._GuidMap
[Guid
] = GuidStructureStringToGuidString(Module
.GuidList
[Guid
])
1500 if Module
.Guid
and not Module
.IsLibrary
:
1501 EntryPoint
= " ".join(Module
.Module
.ModuleEntryPointList
)
1502 if int(str(Module
.AutoGenVersion
), 0) >= 0x00010005:
1503 RealEntryPoint
= "_ModuleEntryPoint"
1505 RealEntryPoint
= EntryPoint
1506 if EntryPoint
== "_ModuleEntryPoint":
1507 CCFlags
= Module
.BuildOption
.get("CC", {}).get("FLAGS", "")
1508 Match
= gGlueLibEntryPoint
.search(CCFlags
)
1510 EntryPoint
= Match
.group(1)
1512 self
._FfsEntryPoint
[Module
.Guid
.upper()] = (EntryPoint
, RealEntryPoint
)
1516 # Collect platform firmware volume list as the input of EOT.
1520 for Fd
in Wa
.FdfProfile
.FdDict
:
1521 for FdRegion
in Wa
.FdfProfile
.FdDict
[Fd
].RegionList
:
1522 if FdRegion
.RegionType
!= BINARY_FILE_TYPE_FV
:
1524 for FvName
in FdRegion
.RegionDataList
:
1525 if FvName
in self
._FvList
:
1527 self
._FvList
.append(FvName
)
1528 for Ffs
in Wa
.FdfProfile
.FvDict
[FvName
.upper()].FfsList
:
1529 for Section
in Ffs
.SectionList
:
1531 for FvSection
in Section
.SectionList
:
1532 if FvSection
.FvName
in self
._FvList
:
1534 self
._FvList
.append(FvSection
.FvName
)
1535 except AttributeError:
1540 # Parse platform fixed address map files
1542 # This function parses the platform final fixed address map file to get
1543 # the database of predicted fixed address for module image base, entry point
1546 # @param self: The object pointer
1548 def _ParseMapFile(self
):
1549 if self
._MapFileParsed
:
1551 self
._MapFileParsed
= True
1552 if os
.path
.isfile(self
._MapFileName
):
1554 FileContents
= open(self
._MapFileName
).read()
1555 for Match
in gMapFileItemPattern
.finditer(FileContents
):
1556 AddressType
= Match
.group(1)
1557 BaseAddress
= Match
.group(2)
1558 EntryPoint
= Match
.group(3)
1559 Guid
= Match
.group(4).upper()
1560 List
= self
.FixedMapDict
.setdefault(Guid
, [])
1561 List
.append((AddressType
, BaseAddress
, "*I"))
1562 List
.append((AddressType
, EntryPoint
, "*E"))
1564 EdkLogger
.warn(None, "Cannot open file to read", self
._MapFileName
)
1567 # Invokes EOT tool to get the predicted the execution order.
1569 # This function invokes EOT tool to calculate the predicted dispatch order
1571 # @param self: The object pointer
1573 def _InvokeEotTool(self
):
1574 if self
._EotToolInvoked
:
1577 self
._EotToolInvoked
= True
1579 for FvName
in self
._FvList
:
1580 FvFile
= os
.path
.join(self
._FvDir
, FvName
+ ".Fv")
1581 if os
.path
.isfile(FvFile
):
1582 FvFileList
.append(FvFile
)
1584 if len(FvFileList
) == 0:
1587 # Write source file list and GUID file list to an intermediate file
1588 # as the input for EOT tool and dispatch List as the output file
1591 SourceList
= os
.path
.join(self
._EotDir
, "SourceFile.txt")
1592 GuidList
= os
.path
.join(self
._EotDir
, "GuidList.txt")
1593 DispatchList
= os
.path
.join(self
._EotDir
, "Dispatch.txt")
1595 TempFile
= open(SourceList
, "w+")
1596 for Item
in self
._SourceList
:
1597 FileWrite(TempFile
, Item
)
1599 TempFile
= open(GuidList
, "w+")
1600 for Key
in self
._GuidMap
:
1601 FileWrite(TempFile
, "%s %s" % (Key
, self
._GuidMap
[Key
]))
1605 from Eot
.Eot
import Eot
1608 # Invoke EOT tool and echo its runtime performance
1610 EotStartTime
= time
.time()
1611 Eot(CommandLineOption
=False, SourceFileList
=SourceList
, GuidList
=GuidList
,
1612 FvFileList
=' '.join(FvFileList
), Dispatch
=DispatchList
, IsInit
=True)
1613 EotEndTime
= time
.time()
1614 EotDuration
= time
.strftime("%H:%M:%S", time
.gmtime(int(round(EotEndTime
- EotStartTime
))))
1615 EdkLogger
.quiet("EOT run time: %s\n" % EotDuration
)
1618 # Parse the output of EOT tool
1620 for Line
in open(DispatchList
):
1621 if len(Line
.split()) < 4:
1623 (Guid
, Phase
, FfsName
, FilePath
) = Line
.split()
1624 Symbol
= self
._FfsEntryPoint
.get(Guid
, [FfsName
, ""])[0]
1625 if len(Symbol
) > self
.MaxLen
:
1626 self
.MaxLen
= len(Symbol
)
1627 self
.ItemList
.append((Phase
, Symbol
, FilePath
))
1629 EdkLogger
.quiet("(Python %s on %s\n%s)" % (platform
.python_version(), sys
.platform
, traceback
.format_exc()))
1630 EdkLogger
.warn(None, "Failed to generate execution order prediction report, for some error occurred in executing EOT.")
1634 # Generate platform execution order report
1636 # This function generates the predicted module execution order.
1638 # @param self The object pointer
1639 # @param File The file object for report
1641 def _GenerateExecutionOrderReport(self
, File
):
1642 self
._InvokeEotTool
()
1643 if len(self
.ItemList
) == 0:
1645 FileWrite(File
, gSectionStart
)
1646 FileWrite(File
, "Execution Order Prediction")
1647 FileWrite(File
, "*P PEI phase")
1648 FileWrite(File
, "*D DXE phase")
1649 FileWrite(File
, "*E Module INF entry point name")
1650 FileWrite(File
, "*N Module notification function name")
1652 FileWrite(File
, "Type %-*s %s" % (self
.MaxLen
, "Symbol", "Module INF Path"))
1653 FileWrite(File
, gSectionSep
)
1654 for Item
in self
.ItemList
:
1655 FileWrite(File
, "*%sE %-*s %s" % (Item
[0], self
.MaxLen
, Item
[1], Item
[2]))
1657 FileWrite(File
, gSectionStart
)
1660 # Generate Fixed Address report.
1662 # This function generate the predicted fixed address report for a module
1663 # specified by Guid.
1665 # @param self The object pointer
1666 # @param File The file object for report
1667 # @param Guid The module Guid value.
1668 # @param NotifyList The list of all notify function in a module
1670 def _GenerateFixedAddressReport(self
, File
, Guid
, NotifyList
):
1671 self
._ParseMapFile
()
1672 FixedAddressList
= self
.FixedMapDict
.get(Guid
)
1673 if not FixedAddressList
:
1676 FileWrite(File
, gSubSectionStart
)
1677 FileWrite(File
, "Fixed Address Prediction")
1678 FileWrite(File
, "*I Image Loading Address")
1679 FileWrite(File
, "*E Entry Point Address")
1680 FileWrite(File
, "*N Notification Function Address")
1681 FileWrite(File
, "*F Flash Address")
1682 FileWrite(File
, "*M Memory Address")
1683 FileWrite(File
, "*S SMM RAM Offset")
1684 FileWrite(File
, "TOM Top of Memory")
1686 FileWrite(File
, "Type Address Name")
1687 FileWrite(File
, gSubSectionSep
)
1688 for Item
in FixedAddressList
:
1693 Name
= "(Image Base)"
1694 elif Symbol
== "*E":
1695 Name
= self
._FfsEntryPoint
.get(Guid
, ["", "_ModuleEntryPoint"])[1]
1696 elif Symbol
in NotifyList
:
1704 elif "Memory" in Type
:
1710 Value
= "TOM" + Value
1712 FileWrite(File
, "%s %-16s %s" % (Symbol
, Value
, Name
))
1715 # Generate report for the prediction part
1717 # This function generate the predicted fixed address report for a module or
1718 # predicted module execution order for a platform.
1719 # If the input Guid is None, then, it generates the predicted module execution order;
1720 # otherwise it generated the module fixed loading address for the module specified by
1723 # @param self The object pointer
1724 # @param File The file object for report
1725 # @param Guid The module Guid value.
1727 def GenerateReport(self
, File
, Guid
):
1729 self
._GenerateFixedAddressReport
(File
, Guid
.upper(), [])
1731 self
._GenerateExecutionOrderReport
(File
)
1734 # Reports FD region information
1736 # This class reports the FD subsection in the build report file.
1737 # It collects region information of platform flash device.
1738 # If the region is a firmware volume, it lists the set of modules
1739 # and its space information; otherwise, it only lists its region name,
1740 # base address and size in its sub-section header.
1741 # If there are nesting FVs, the nested FVs will list immediate after
1742 # this FD region subsection
1744 class FdRegionReport(object):
1746 # Discover all the nested FV name list.
1748 # This is an internal worker function to discover the all the nested FV information
1749 # in the parent firmware volume. It uses deep first search algorithm recursively to
1750 # find all the FV list name and append them to the list.
1752 # @param self The object pointer
1753 # @param FvName The name of current firmware file system
1754 # @param Wa Workspace context information
1756 def _DiscoverNestedFvList(self
, FvName
, Wa
):
1757 FvDictKey
=FvName
.upper()
1758 if FvDictKey
in Wa
.FdfProfile
.FvDict
:
1759 for Ffs
in Wa
.FdfProfile
.FvDict
[FvName
.upper()].FfsList
:
1760 for Section
in Ffs
.SectionList
:
1762 for FvSection
in Section
.SectionList
:
1763 if FvSection
.FvName
in self
.FvList
:
1765 self
._GuidsDb
[Ffs
.NameGuid
.upper()] = FvSection
.FvName
1766 self
.FvList
.append(FvSection
.FvName
)
1767 self
.FvInfo
[FvSection
.FvName
] = ("Nested FV", 0, 0)
1768 self
._DiscoverNestedFvList
(FvSection
.FvName
, Wa
)
1769 except AttributeError:
1773 # Constructor function for class FdRegionReport
1775 # This constructor function generates FdRegionReport object for a specified FdRegion.
1776 # If the FdRegion is a firmware volume, it will recursively find all its nested Firmware
1777 # volume list. This function also collects GUID map in order to dump module identification
1778 # in the final report.
1780 # @param self: The object pointer
1781 # @param FdRegion The current FdRegion object
1782 # @param Wa Workspace context information
1784 def __init__(self
, FdRegion
, Wa
):
1785 self
.Type
= FdRegion
.RegionType
1786 self
.BaseAddress
= FdRegion
.Offset
1787 self
.Size
= FdRegion
.Size
1791 self
._FvDir
= Wa
.FvDir
1792 self
._WorkspaceDir
= Wa
.WorkspaceDir
1795 # If the input FdRegion is not a firmware volume,
1798 if self
.Type
!= BINARY_FILE_TYPE_FV
:
1802 # Find all nested FVs in the FdRegion
1804 for FvName
in FdRegion
.RegionDataList
:
1805 if FvName
in self
.FvList
:
1807 self
.FvList
.append(FvName
)
1808 self
.FvInfo
[FvName
] = ("Fd Region", self
.BaseAddress
, self
.Size
)
1809 self
._DiscoverNestedFvList
(FvName
, Wa
)
1813 # Collect PCDs declared in DEC files.
1815 for Pa
in Wa
.AutoGenObjectList
:
1816 for Package
in Pa
.PackageList
:
1817 for (TokenCName
, TokenSpaceGuidCName
, DecType
) in Package
.Pcds
:
1818 DecDefaultValue
= Package
.Pcds
[TokenCName
, TokenSpaceGuidCName
, DecType
].DefaultValue
1819 PlatformPcds
[(TokenCName
, TokenSpaceGuidCName
)] = DecDefaultValue
1821 # Collect PCDs defined in DSC file
1823 for Pa
in Wa
.AutoGenObjectList
:
1824 for (TokenCName
, TokenSpaceGuidCName
) in Pa
.Platform
.Pcds
:
1825 DscDefaultValue
= Pa
.Platform
.Pcds
[(TokenCName
, TokenSpaceGuidCName
)].DefaultValue
1826 PlatformPcds
[(TokenCName
, TokenSpaceGuidCName
)] = DscDefaultValue
1829 # Add PEI and DXE a priori files GUIDs defined in PI specification.
1831 self
._GuidsDb
["1B45CC0A-156A-428A-AF62-49864DA0E6E6"] = "PEI Apriori"
1832 self
._GuidsDb
["FC510EE7-FFDC-11D4-BD41-0080C73C8881"] = "DXE Apriori"
1834 # Add ACPI table storage file
1836 self
._GuidsDb
["7E374E25-8E01-4FEE-87F2-390C23C606CD"] = "ACPI table storage"
1838 for Pa
in Wa
.AutoGenObjectList
:
1839 for ModuleKey
in Pa
.Platform
.Modules
:
1840 M
= Pa
.Platform
.Modules
[ModuleKey
].M
1841 InfPath
= mws
.join(Wa
.WorkspaceDir
, M
.MetaFile
.File
)
1842 self
._GuidsDb
[M
.Guid
.upper()] = "%s (%s)" % (M
.Module
.BaseName
, InfPath
)
1845 # Collect the GUID map in the FV firmware volume
1847 for FvName
in self
.FvList
:
1848 FvDictKey
=FvName
.upper()
1849 if FvDictKey
in Wa
.FdfProfile
.FvDict
:
1850 for Ffs
in Wa
.FdfProfile
.FvDict
[FvName
.upper()].FfsList
:
1853 # collect GUID map for binary EFI file in FDF file.
1855 Guid
= Ffs
.NameGuid
.upper()
1856 Match
= gPcdGuidPattern
.match(Ffs
.NameGuid
)
1858 PcdTokenspace
= Match
.group(1)
1859 PcdToken
= Match
.group(2)
1860 if (PcdToken
, PcdTokenspace
) in PlatformPcds
:
1861 GuidValue
= PlatformPcds
[(PcdToken
, PcdTokenspace
)]
1862 Guid
= GuidStructureByteArrayToGuidString(GuidValue
).upper()
1863 for Section
in Ffs
.SectionList
:
1865 ModuleSectFile
= mws
.join(Wa
.WorkspaceDir
, Section
.SectFileName
)
1866 self
._GuidsDb
[Guid
] = ModuleSectFile
1867 except AttributeError:
1869 except AttributeError:
1874 # Internal worker function to generate report for the FD region
1876 # This internal worker function to generate report for the FD region.
1877 # It the type is firmware volume, it lists offset and module identification.
1879 # @param self The object pointer
1880 # @param File The file object for report
1881 # @param Title The title for the FD subsection
1882 # @param BaseAddress The base address for the FD region
1883 # @param Size The size of the FD region
1884 # @param FvName The FV name if the FD region is a firmware volume
1886 def _GenerateReport(self
, File
, Title
, Type
, BaseAddress
, Size
=0, FvName
=None):
1887 FileWrite(File
, gSubSectionStart
)
1888 FileWrite(File
, Title
)
1889 FileWrite(File
, "Type: %s" % Type
)
1890 FileWrite(File
, "Base Address: 0x%X" % BaseAddress
)
1892 if self
.Type
== BINARY_FILE_TYPE_FV
:
1896 if FvName
.upper().endswith('.FV'):
1897 FileExt
= FvName
+ ".txt"
1899 FileExt
= FvName
+ ".Fv.txt"
1901 if not os
.path
.isfile(FileExt
):
1902 FvReportFileName
= mws
.join(self
._WorkspaceDir
, FileExt
)
1903 if not os
.path
.isfile(FvReportFileName
):
1904 FvReportFileName
= os
.path
.join(self
._FvDir
, FileExt
)
1907 # Collect size info in the firmware volume.
1909 FvReport
= open(FvReportFileName
).read()
1910 Match
= gFvTotalSizePattern
.search(FvReport
)
1912 FvTotalSize
= int(Match
.group(1), 16)
1913 Match
= gFvTakenSizePattern
.search(FvReport
)
1915 FvTakenSize
= int(Match
.group(1), 16)
1916 FvFreeSize
= FvTotalSize
- FvTakenSize
1918 # Write size information to the report file.
1920 FileWrite(File
, "Size: 0x%X (%.0fK)" % (FvTotalSize
, FvTotalSize
/ 1024.0))
1921 FileWrite(File
, "Fv Name: %s (%.1f%% Full)" % (FvName
, FvTakenSize
* 100.0 / FvTotalSize
))
1922 FileWrite(File
, "Occupied Size: 0x%X (%.0fK)" % (FvTakenSize
, FvTakenSize
/ 1024.0))
1923 FileWrite(File
, "Free Size: 0x%X (%.0fK)" % (FvFreeSize
, FvFreeSize
/ 1024.0))
1924 FileWrite(File
, "Offset Module")
1925 FileWrite(File
, gSubSectionSep
)
1927 # Write module offset and module identification to the report file.
1930 for Match
in gOffsetGuidPattern
.finditer(FvReport
):
1931 Guid
= Match
.group(2).upper()
1932 OffsetInfo
[Match
.group(1)] = self
._GuidsDb
.get(Guid
, Guid
)
1933 OffsetList
= sorted(OffsetInfo
.keys())
1934 for Offset
in OffsetList
:
1935 FileWrite (File
, "%s %s" % (Offset
, OffsetInfo
[Offset
]))
1937 EdkLogger
.warn(None, "Fail to read report file", FvReportFileName
)
1939 FileWrite(File
, "Size: 0x%X (%.0fK)" % (Size
, Size
/ 1024.0))
1940 FileWrite(File
, gSubSectionEnd
)
1943 # Generate report for the FD region
1945 # This function generates report for the FD region.
1947 # @param self The object pointer
1948 # @param File The file object for report
1950 def GenerateReport(self
, File
):
1951 if (len(self
.FvList
) > 0):
1952 for FvItem
in self
.FvList
:
1953 Info
= self
.FvInfo
[FvItem
]
1954 self
._GenerateReport
(File
, Info
[0], TAB_FV_DIRECTORY
, Info
[1], Info
[2], FvItem
)
1956 self
._GenerateReport
(File
, "FD Region", self
.Type
, self
.BaseAddress
, self
.Size
)
1959 # Reports FD information
1961 # This class reports the FD section in the build report file.
1962 # It collects flash device information for a platform.
1964 class FdReport(object):
1966 # Constructor function for class FdReport
1968 # This constructor function generates FdReport object for a specified
1971 # @param self The object pointer
1972 # @param Fd The current Firmware device object
1973 # @param Wa Workspace context information
1975 def __init__(self
, Fd
, Wa
):
1976 self
.FdName
= Fd
.FdUiName
1977 self
.BaseAddress
= Fd
.BaseAddress
1979 self
.FdRegionList
= [FdRegionReport(FdRegion
, Wa
) for FdRegion
in Fd
.RegionList
]
1980 self
.FvPath
= os
.path
.join(Wa
.BuildDir
, TAB_FV_DIRECTORY
)
1981 self
.VpdFilePath
= os
.path
.join(self
.FvPath
, "%s.map" % Wa
.Platform
.VpdToolGuid
)
1982 self
.VPDBaseAddress
= 0
1984 self
.VPDInfoList
= []
1985 for index
, FdRegion
in enumerate(Fd
.RegionList
):
1986 if str(FdRegion
.RegionType
) is 'FILE' and Wa
.Platform
.VpdToolGuid
in str(FdRegion
.RegionDataList
):
1987 self
.VPDBaseAddress
= self
.FdRegionList
[index
].BaseAddress
1988 self
.VPDSize
= self
.FdRegionList
[index
].Size
1991 if os
.path
.isfile(self
.VpdFilePath
):
1992 fd
= open(self
.VpdFilePath
, "r")
1993 Lines
= fd
.readlines()
1996 if len(Line
) == 0 or Line
.startswith("#"):
1999 PcdName
, SkuId
, Offset
, Size
, Value
= Line
.split("#")[0].split("|")
2000 PcdName
, SkuId
, Offset
, Size
, Value
= PcdName
.strip(), SkuId
.strip(), Offset
.strip(), Size
.strip(), Value
.strip()
2001 if Offset
.lower().startswith('0x'):
2002 Offset
= '0x%08X' % (int(Offset
, 16) + self
.VPDBaseAddress
)
2004 Offset
= '0x%08X' % (int(Offset
, 10) + self
.VPDBaseAddress
)
2005 self
.VPDInfoList
.append("%s | %s | %s | %s | %s" % (PcdName
, SkuId
, Offset
, Size
, Value
))
2007 EdkLogger
.error("BuildReport", CODE_ERROR
, "Fail to parse VPD information file %s" % self
.VpdFilePath
)
2011 # Generate report for the firmware device.
2013 # This function generates report for the firmware device.
2015 # @param self The object pointer
2016 # @param File The file object for report
2018 def GenerateReport(self
, File
):
2019 FileWrite(File
, gSectionStart
)
2020 FileWrite(File
, "Firmware Device (FD)")
2021 FileWrite(File
, "FD Name: %s" % self
.FdName
)
2022 FileWrite(File
, "Base Address: %s" % self
.BaseAddress
)
2023 FileWrite(File
, "Size: 0x%X (%.0fK)" % (self
.Size
, self
.Size
/ 1024.0))
2024 if len(self
.FdRegionList
) > 0:
2025 FileWrite(File
, gSectionSep
)
2026 for FdRegionItem
in self
.FdRegionList
:
2027 FdRegionItem
.GenerateReport(File
)
2029 if len(self
.VPDInfoList
) > 0:
2030 FileWrite(File
, gSubSectionStart
)
2031 FileWrite(File
, "FD VPD Region")
2032 FileWrite(File
, "Base Address: 0x%X" % self
.VPDBaseAddress
)
2033 FileWrite(File
, "Size: 0x%X (%.0fK)" % (self
.VPDSize
, self
.VPDSize
/ 1024.0))
2034 FileWrite(File
, gSubSectionSep
)
2035 for item
in self
.VPDInfoList
:
2036 ValueList
= item
.split('|')
2037 Value
= ValueList
[-1].strip()
2038 IsByteArray
, ArrayList
= ByteArrayForamt(Value
)
2040 ValueList
[-1] = ' {'
2041 FileWrite(File
, '|'.join(ValueList
))
2042 for Array
in ArrayList
:
2043 FileWrite(File
, Array
)
2045 FileWrite(File
, item
)
2046 FileWrite(File
, gSubSectionEnd
)
2047 FileWrite(File
, gSectionEnd
)
2052 # Reports platform information
2054 # This class reports the whole platform information
2056 class PlatformReport(object):
2058 # Constructor function for class PlatformReport
2060 # This constructor function generates PlatformReport object a platform build.
2061 # It generates report for platform summary, flash, global PCDs and detailed
2062 # module information for modules involved in platform build.
2064 # @param self The object pointer
2065 # @param Wa Workspace context information
2066 # @param MaList The list of modules in the platform build
2068 def __init__(self
, Wa
, MaList
, ReportType
):
2069 self
._WorkspaceDir
= Wa
.WorkspaceDir
2070 self
.PlatformName
= Wa
.Name
2071 self
.PlatformDscPath
= Wa
.Platform
2072 self
.Architectures
= " ".join(Wa
.ArchList
)
2073 self
.ToolChain
= Wa
.ToolChain
2074 self
.Target
= Wa
.BuildTarget
2075 self
.OutputPath
= os
.path
.join(Wa
.WorkspaceDir
, Wa
.OutputDir
)
2076 self
.BuildEnvironment
= platform
.platform()
2078 self
.PcdReport
= None
2079 if "PCD" in ReportType
:
2080 self
.PcdReport
= PcdReport(Wa
)
2082 self
.FdReportList
= []
2083 if "FLASH" in ReportType
and Wa
.FdfProfile
and MaList
is None:
2084 for Fd
in Wa
.FdfProfile
.FdDict
:
2085 self
.FdReportList
.append(FdReport(Wa
.FdfProfile
.FdDict
[Fd
], Wa
))
2087 self
.PredictionReport
= None
2088 if "FIXED_ADDRESS" in ReportType
or "EXECUTION_ORDER" in ReportType
:
2089 self
.PredictionReport
= PredictionReport(Wa
)
2091 self
.DepexParser
= None
2092 if "DEPEX" in ReportType
:
2093 self
.DepexParser
= DepexParser(Wa
)
2095 self
.ModuleReportList
= []
2096 if MaList
is not None:
2097 self
._IsModuleBuild
= True
2099 self
.ModuleReportList
.append(ModuleReport(Ma
, ReportType
))
2101 self
._IsModuleBuild
= False
2102 for Pa
in Wa
.AutoGenObjectList
:
2103 ModuleAutoGenList
= []
2104 for ModuleKey
in Pa
.Platform
.Modules
:
2105 ModuleAutoGenList
.append(Pa
.Platform
.Modules
[ModuleKey
].M
)
2106 if GlobalData
.gFdfParser
is not None:
2107 if Pa
.Arch
in GlobalData
.gFdfParser
.Profile
.InfDict
:
2108 INFList
= GlobalData
.gFdfParser
.Profile
.InfDict
[Pa
.Arch
]
2109 for InfName
in INFList
:
2110 InfClass
= PathClass(NormPath(InfName
), Wa
.WorkspaceDir
, Pa
.Arch
)
2111 Ma
= ModuleAutoGen(Wa
, InfClass
, Pa
.BuildTarget
, Pa
.ToolChain
, Pa
.Arch
, Wa
.MetaFile
)
2114 if Ma
not in ModuleAutoGenList
:
2115 ModuleAutoGenList
.append(Ma
)
2116 for MGen
in ModuleAutoGenList
:
2117 self
.ModuleReportList
.append(ModuleReport(MGen
, ReportType
))
2122 # Generate report for the whole platform.
2124 # This function generates report for platform information.
2125 # It comprises of platform summary, global PCD, flash and
2126 # module list sections.
2128 # @param self The object pointer
2129 # @param File The file object for report
2130 # @param BuildDuration The total time to build the modules
2131 # @param AutoGenTime The total time of AutoGen Phase
2132 # @param MakeTime The total time of Make Phase
2133 # @param GenFdsTime The total time of GenFds Phase
2134 # @param ReportType The kind of report items in the final report file
2136 def GenerateReport(self
, File
, BuildDuration
, AutoGenTime
, MakeTime
, GenFdsTime
, ReportType
):
2137 FileWrite(File
, "Platform Summary")
2138 FileWrite(File
, "Platform Name: %s" % self
.PlatformName
)
2139 FileWrite(File
, "Platform DSC Path: %s" % self
.PlatformDscPath
)
2140 FileWrite(File
, "Architectures: %s" % self
.Architectures
)
2141 FileWrite(File
, "Tool Chain: %s" % self
.ToolChain
)
2142 FileWrite(File
, "Target: %s" % self
.Target
)
2143 if GlobalData
.gSkuids
:
2144 FileWrite(File
, "SKUID: %s" % " ".join(GlobalData
.gSkuids
))
2145 if GlobalData
.gDefaultStores
:
2146 FileWrite(File
, "DefaultStore: %s" % " ".join(GlobalData
.gDefaultStores
))
2147 FileWrite(File
, "Output Path: %s" % self
.OutputPath
)
2148 FileWrite(File
, "Build Environment: %s" % self
.BuildEnvironment
)
2149 FileWrite(File
, "Build Duration: %s" % BuildDuration
)
2151 FileWrite(File
, "AutoGen Duration: %s" % AutoGenTime
)
2153 FileWrite(File
, "Make Duration: %s" % MakeTime
)
2155 FileWrite(File
, "GenFds Duration: %s" % GenFdsTime
)
2156 FileWrite(File
, "Report Content: %s" % ", ".join(ReportType
))
2158 if GlobalData
.MixedPcd
:
2159 FileWrite(File
, gSectionStart
)
2160 FileWrite(File
, "The following PCDs use different access methods:")
2161 FileWrite(File
, gSectionSep
)
2162 for PcdItem
in GlobalData
.MixedPcd
:
2163 FileWrite(File
, "%s.%s" % (str(PcdItem
[1]), str(PcdItem
[0])))
2164 FileWrite(File
, gSectionEnd
)
2166 if not self
._IsModuleBuild
:
2167 if "PCD" in ReportType
:
2168 self
.PcdReport
.GenerateReport(File
, None)
2170 if "FLASH" in ReportType
:
2171 for FdReportListItem
in self
.FdReportList
:
2172 FdReportListItem
.GenerateReport(File
)
2174 for ModuleReportItem
in self
.ModuleReportList
:
2175 ModuleReportItem
.GenerateReport(File
, self
.PcdReport
, self
.PredictionReport
, self
.DepexParser
, ReportType
)
2177 if not self
._IsModuleBuild
:
2178 if "EXECUTION_ORDER" in ReportType
:
2179 self
.PredictionReport
.GenerateReport(File
, None)
2181 ## BuildReport class
2183 # This base class contain the routines to collect data and then
2184 # applies certain format to the output report
2186 class BuildReport(object):
2188 # Constructor function for class BuildReport
2190 # This constructor function generates BuildReport object a platform build.
2191 # It generates report for platform summary, flash, global PCDs and detailed
2192 # module information for modules involved in platform build.
2194 # @param self The object pointer
2195 # @param ReportFile The file name to save report file
2196 # @param ReportType The kind of report items in the final report file
2198 def __init__(self
, ReportFile
, ReportType
):
2199 self
.ReportFile
= ReportFile
2201 self
.ReportList
= []
2202 self
.ReportType
= []
2204 for ReportTypeItem
in ReportType
:
2205 if ReportTypeItem
not in self
.ReportType
:
2206 self
.ReportType
.append(ReportTypeItem
)
2208 self
.ReportType
= ["PCD", "LIBRARY", "BUILD_FLAGS", "DEPEX", "HASH", "FLASH", "FIXED_ADDRESS"]
2210 # Adds platform report to the list
2212 # This function adds a platform report to the final report list.
2214 # @param self The object pointer
2215 # @param Wa Workspace context information
2216 # @param MaList The list of modules in the platform build
2218 def AddPlatformReport(self
, Wa
, MaList
=None):
2220 self
.ReportList
.append((Wa
, MaList
))
2223 # Generates the final report.
2225 # This function generates platform build report. It invokes GenerateReport()
2226 # method for every platform report in the list.
2228 # @param self The object pointer
2229 # @param BuildDuration The total time to build the modules
2230 # @param AutoGenTime The total time of AutoGen phase
2231 # @param MakeTime The total time of Make phase
2232 # @param GenFdsTime The total time of GenFds phase
2234 def GenerateReport(self
, BuildDuration
, AutoGenTime
, MakeTime
, GenFdsTime
):
2238 for (Wa
, MaList
) in self
.ReportList
:
2239 PlatformReport(Wa
, MaList
, self
.ReportType
).GenerateReport(File
, BuildDuration
, AutoGenTime
, MakeTime
, GenFdsTime
, self
.ReportType
)
2240 Content
= FileLinesSplit(File
.getvalue(), gLineMaxLength
)
2241 SaveFileOnChange(self
.ReportFile
, Content
, True)
2242 EdkLogger
.quiet("Build report can be found at %s" % os
.path
.abspath(self
.ReportFile
))
2244 EdkLogger
.error(None, FILE_WRITE_FAILURE
, ExtraData
=self
.ReportFile
)
2246 EdkLogger
.error("BuildReport", CODE_ERROR
, "Unknown fatal error when generating build report", ExtraData
=self
.ReportFile
, RaiseError
=False)
2247 EdkLogger
.quiet("(Python %s on %s\n%s)" % (platform
.python_version(), sys
.platform
, traceback
.format_exc()))
2250 # This acts like the main() function for the script, unless it is 'import'ed into another script.
2251 if __name__
== '__main__':