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 StringIO
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 list(M
.ModulePcdList
) + list(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
, 'r').read()
638 Match
= gModuleSizePattern
.search(FileContents
)
640 self
.Size
= int(Match
.group(1))
642 Match
= gTimeStampPattern
.search(FileContents
)
644 self
.BuildTimeStamp
= datetime
.utcfromtimestamp(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
!= b
"":
730 To(Line
.rstrip().decode(encoding
='utf-8', errors
='ignore'))
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 list(Module
.M
.ModulePcdList
) + list(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 #The DefaultValue of StructurePcd already be the latest, no need to update.
996 if not self
.IsStructurePcd(Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
):
997 Pcd
.DefaultValue
= PcdValue
998 if ModulePcdSet
is not None:
999 if (Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
, Type
) not in ModulePcdSet
:
1001 InfDefaultValue
, PcdValue
= ModulePcdSet
[Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
, Type
]
1002 #The DefaultValue of StructurePcd already be the latest, no need to update.
1003 if not self
.IsStructurePcd(Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
):
1004 Pcd
.DefaultValue
= PcdValue
1007 InfDefaultValue
= ValueExpressionEx(InfDefaultValue
, Pcd
.DatumType
, self
._GuidDict
)(True)
1008 except BadExpression
as InfDefaultValue
:
1009 EdkLogger
.error('BuildReport', FORMAT_INVALID
, "PCD Value: %s, Type: %s" % (InfDefaultValue
, Pcd
.DatumType
))
1010 if InfDefaultValue
== "":
1011 InfDefaultValue
= None
1013 BuildOptionMatch
= False
1014 if GlobalData
.BuildOptionPcd
:
1015 for pcd
in GlobalData
.BuildOptionPcd
:
1016 if (Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
) == (pcd
[0], pcd
[1]):
1020 #The DefaultValue of StructurePcd already be the latest, no need to update.
1021 if not self
.IsStructurePcd(Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
):
1022 Pcd
.DefaultValue
= PcdValue
1023 BuildOptionMatch
= True
1027 if ModulePcdSet
is None:
1029 FileWrite(File
, Key
)
1033 if Pcd
.DatumType
in TAB_PCD_NUMERIC_TYPES
:
1035 PcdValueNumber
= int(PcdValue
.strip(), 0)
1037 PcdValueNumber
= int(PcdValue
.lstrip('0'))
1038 if DecDefaultValue
is None:
1041 DecDefaultValueNumber
= int(DecDefaultValue
.strip(), 0)
1042 DecMatch
= (DecDefaultValueNumber
== PcdValueNumber
)
1044 if InfDefaultValue
is None:
1047 InfDefaultValueNumber
= int(InfDefaultValue
.strip(), 0)
1048 InfMatch
= (InfDefaultValueNumber
== PcdValueNumber
)
1050 if DscDefaultValue
is None:
1054 DscDefaultValueNumber
= int(DscDefaultValue
.strip(), 0)
1056 DscDefaultValueNumber
= int(DscDefaultValue
.lstrip('0'))
1057 DscMatch
= (DscDefaultValueNumber
== PcdValueNumber
)
1059 if DecDefaultValue
is None:
1062 DecMatch
= (DecDefaultValue
.strip() == PcdValue
.strip())
1064 if InfDefaultValue
is None:
1067 InfMatch
= (InfDefaultValue
.strip() == PcdValue
.strip())
1069 if DscDefaultValue
is None:
1072 DscMatch
= (DscDefaultValue
.strip() == PcdValue
.strip())
1075 if self
.IsStructurePcd(Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
):
1077 if TypeName
in ('DYNVPD', 'DEXVPD'):
1078 SkuInfoList
= Pcd
.SkuInfoList
1079 Pcd
= GlobalData
.gStructurePcd
[self
.Arch
][(Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
)]
1080 Pcd
.DatumType
= Pcd
.StructName
1081 if TypeName
in ('DYNVPD', 'DEXVPD'):
1082 Pcd
.SkuInfoList
= SkuInfoList
1083 if Pcd
.PcdFieldValueFromComm
:
1084 BuildOptionMatch
= True
1086 elif Pcd
.SkuOverrideValues
:
1088 if Pcd
.DefaultFromDSC
:
1092 for item
in Pcd
.SkuOverrideValues
:
1093 DictLen
+= len(Pcd
.SkuOverrideValues
[item
])
1097 if not Pcd
.SkuInfoList
:
1098 OverrideValues
= Pcd
.SkuOverrideValues
1100 Keys
= list(OverrideValues
.keys())
1101 Data
= OverrideValues
[Keys
[0]]
1102 Struct
= list(Data
.values())
1103 DscOverride
= self
.ParseStruct(Struct
[0])
1105 SkuList
= sorted(Pcd
.SkuInfoList
.keys())
1107 SkuInfo
= Pcd
.SkuInfoList
[Sku
]
1108 if TypeName
in ('DYNHII', 'DEXHII'):
1109 if SkuInfo
.DefaultStoreDict
:
1110 DefaultStoreList
= sorted(SkuInfo
.DefaultStoreDict
.keys())
1111 for DefaultStore
in DefaultStoreList
:
1112 OverrideValues
= Pcd
.SkuOverrideValues
[Sku
]
1113 DscOverride
= self
.ParseStruct(OverrideValues
[DefaultStore
])
1117 OverrideValues
= Pcd
.SkuOverrideValues
[Sku
]
1119 Keys
= list(OverrideValues
.keys())
1120 OverrideFieldStruct
= self
.OverrideFieldValue(Pcd
, OverrideValues
[Keys
[0]])
1121 DscOverride
= self
.ParseStruct(OverrideFieldStruct
)
1125 DscDefaultValue
= True
1131 DscDefaultValue
= True
1136 # Report PCD item according to their override relationship
1138 if Pcd
.DatumType
== 'BOOLEAN':
1140 DscDefaultValue
= str(int(DscDefaultValue
, 0))
1142 DecDefaultValue
= str(int(DecDefaultValue
, 0))
1144 InfDefaultValue
= str(int(InfDefaultValue
, 0))
1145 if Pcd
.DefaultValue
:
1146 Pcd
.DefaultValue
= str(int(Pcd
.DefaultValue
, 0))
1148 self
.PrintPcdValue(File
, Pcd
, PcdTokenCName
, TypeName
, IsStructure
, DscMatch
, DscDefaultValBak
, InfMatch
, InfDefaultValue
, DecMatch
, DecDefaultValue
, ' ')
1149 elif InfDefaultValue
and InfMatch
:
1150 self
.PrintPcdValue(File
, Pcd
, PcdTokenCName
, TypeName
, IsStructure
, DscMatch
, DscDefaultValBak
, InfMatch
, InfDefaultValue
, DecMatch
, DecDefaultValue
, '*M')
1151 elif BuildOptionMatch
:
1152 self
.PrintPcdValue(File
, Pcd
, PcdTokenCName
, TypeName
, IsStructure
, DscMatch
, DscDefaultValBak
, InfMatch
, InfDefaultValue
, DecMatch
, DecDefaultValue
, '*B')
1154 if DscDefaultValue
and DscMatch
:
1155 if (Pcd
.TokenCName
, Key
, Field
) in self
.FdfPcdSet
:
1156 self
.PrintPcdValue(File
, Pcd
, PcdTokenCName
, TypeName
, IsStructure
, DscMatch
, DscDefaultValBak
, InfMatch
, InfDefaultValue
, DecMatch
, DecDefaultValue
, '*F')
1158 self
.PrintPcdValue(File
, Pcd
, PcdTokenCName
, TypeName
, IsStructure
, DscMatch
, DscDefaultValBak
, InfMatch
, InfDefaultValue
, DecMatch
, DecDefaultValue
, '*P')
1160 self
.PrintPcdValue(File
, Pcd
, PcdTokenCName
, TypeName
, IsStructure
, DscMatch
, DscDefaultValBak
, InfMatch
, InfDefaultValue
, DecMatch
, DecDefaultValue
, '*M')
1162 if ModulePcdSet
is None:
1165 if not TypeName
in ('PATCH', 'FLAG', 'FIXED'):
1167 if not BuildOptionMatch
:
1168 ModuleOverride
= self
.ModulePcdOverride
.get((Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
), {})
1169 for ModulePath
in ModuleOverride
:
1170 ModuleDefault
= ModuleOverride
[ModulePath
]
1171 if Pcd
.DatumType
in TAB_PCD_NUMERIC_TYPES
:
1173 ModulePcdDefaultValueNumber
= int(ModuleDefault
.strip(), 0)
1175 ModulePcdDefaultValueNumber
= int(ModuleDefault
.lstrip('0'))
1176 Match
= (ModulePcdDefaultValueNumber
== PcdValueNumber
)
1177 if Pcd
.DatumType
== 'BOOLEAN':
1178 ModuleDefault
= str(ModulePcdDefaultValueNumber
)
1180 Match
= (ModuleDefault
.strip() == PcdValue
.strip())
1183 IsByteArray
, ArrayList
= ByteArrayForamt(ModuleDefault
.strip())
1185 FileWrite(File
, ' *M %-*s = %s' % (self
.MaxLen
+ 15, ModulePath
, '{'))
1186 for Array
in ArrayList
:
1187 FileWrite(File
, Array
)
1189 Value
= ModuleDefault
.strip()
1190 if Pcd
.DatumType
in TAB_PCD_CLEAN_NUMERIC_TYPES
:
1191 if Value
.startswith(('0x', '0X')):
1192 Value
= '{} ({:d})'.format(Value
, int(Value
, 0))
1194 Value
= "0x{:X} ({})".format(int(Value
, 0), Value
)
1195 FileWrite(File
, ' *M %-*s = %s' % (self
.MaxLen
+ 15, ModulePath
, Value
))
1197 if ModulePcdSet
is None:
1198 FileWrite(File
, gSectionEnd
)
1200 if not ReportSubType
and ModulePcdSet
:
1201 FileWrite(File
, gSubSectionEnd
)
1203 def ParseStruct(self
, struct
):
1204 HasDscOverride
= False
1206 for _
, Values
in struct
.items():
1207 if Values
[1] and Values
[1].endswith('.dsc'):
1208 HasDscOverride
= True
1210 return HasDscOverride
1212 def PrintPcdDefault(self
, File
, Pcd
, IsStructure
, DscMatch
, DscDefaultValue
, InfMatch
, InfDefaultValue
, DecMatch
, DecDefaultValue
):
1213 if not DscMatch
and DscDefaultValue
is not None:
1214 Value
= DscDefaultValue
.strip()
1215 IsByteArray
, ArrayList
= ByteArrayForamt(Value
)
1217 FileWrite(File
, ' %*s = %s' % (self
.MaxLen
+ 19, 'DSC DEFAULT', "{"))
1218 for Array
in ArrayList
:
1219 FileWrite(File
, Array
)
1221 if Pcd
.DatumType
in TAB_PCD_CLEAN_NUMERIC_TYPES
:
1222 if Value
.startswith(('0x', '0X')):
1223 Value
= '{} ({:d})'.format(Value
, int(Value
, 0))
1225 Value
= "0x{:X} ({})".format(int(Value
, 0), Value
)
1226 FileWrite(File
, ' %*s = %s' % (self
.MaxLen
+ 19, 'DSC DEFAULT', Value
))
1227 if not InfMatch
and InfDefaultValue
is not None:
1228 Value
= InfDefaultValue
.strip()
1229 IsByteArray
, ArrayList
= ByteArrayForamt(Value
)
1231 FileWrite(File
, ' %*s = %s' % (self
.MaxLen
+ 19, 'INF DEFAULT', "{"))
1232 for Array
in ArrayList
:
1233 FileWrite(File
, Array
)
1235 if Pcd
.DatumType
in TAB_PCD_CLEAN_NUMERIC_TYPES
:
1236 if Value
.startswith(('0x', '0X')):
1237 Value
= '{} ({:d})'.format(Value
, int(Value
, 0))
1239 Value
= "0x{:X} ({})".format(int(Value
, 0), Value
)
1240 FileWrite(File
, ' %*s = %s' % (self
.MaxLen
+ 19, 'INF DEFAULT', Value
))
1242 if not DecMatch
and DecDefaultValue
is not None:
1243 Value
= DecDefaultValue
.strip()
1244 IsByteArray
, ArrayList
= ByteArrayForamt(Value
)
1246 FileWrite(File
, ' %*s = %s' % (self
.MaxLen
+ 19, 'DEC DEFAULT', "{"))
1247 for Array
in ArrayList
:
1248 FileWrite(File
, Array
)
1250 if Pcd
.DatumType
in TAB_PCD_CLEAN_NUMERIC_TYPES
:
1251 if Value
.startswith(('0x', '0X')):
1252 Value
= '{} ({:d})'.format(Value
, int(Value
, 0))
1255 Value
= "0x{:X} ({})".format(int(Value
, 0), Value
)
1257 Value
= "0x{:X} ({})".format(int(Value
.lstrip('0')), Value
)
1258 FileWrite(File
, ' %*s = %s' % (self
.MaxLen
+ 19, 'DEC DEFAULT', Value
))
1260 self
.PrintStructureInfo(File
, Pcd
.DefaultValues
)
1261 if DecMatch
and IsStructure
:
1262 self
.PrintStructureInfo(File
, Pcd
.DefaultValues
)
1264 def PrintPcdValue(self
, File
, Pcd
, PcdTokenCName
, TypeName
, IsStructure
, DscMatch
, DscDefaultValue
, InfMatch
, InfDefaultValue
, DecMatch
, DecDefaultValue
, Flag
= ' '):
1265 if not Pcd
.SkuInfoList
:
1266 Value
= Pcd
.DefaultValue
1267 IsByteArray
, ArrayList
= ByteArrayForamt(Value
)
1269 FileWrite(File
, ' %-*s : %6s %10s = %s' % (self
.MaxLen
, Flag
+ ' ' + PcdTokenCName
, TypeName
, '(' + Pcd
.DatumType
+ ')', '{'))
1270 for Array
in ArrayList
:
1271 FileWrite(File
, Array
)
1273 if Pcd
.DatumType
in TAB_PCD_CLEAN_NUMERIC_TYPES
:
1274 if Value
.startswith(('0x', '0X')):
1275 Value
= '{} ({:d})'.format(Value
, int(Value
, 0))
1277 Value
= "0x{:X} ({})".format(int(Value
, 0), Value
)
1278 FileWrite(File
, ' %-*s : %6s %10s = %s' % (self
.MaxLen
, Flag
+ ' ' + PcdTokenCName
, TypeName
, '(' + Pcd
.DatumType
+ ')', Value
))
1280 OverrideValues
= Pcd
.SkuOverrideValues
1282 Keys
= list(OverrideValues
.keys())
1283 Data
= OverrideValues
[Keys
[0]]
1284 Struct
= list(Data
.values())
1286 OverrideFieldStruct
= self
.OverrideFieldValue(Pcd
, Struct
[0])
1287 self
.PrintStructureInfo(File
, OverrideFieldStruct
)
1288 self
.PrintPcdDefault(File
, Pcd
, IsStructure
, DscMatch
, DscDefaultValue
, InfMatch
, InfDefaultValue
, DecMatch
, DecDefaultValue
)
1291 SkuList
= sorted(Pcd
.SkuInfoList
.keys())
1293 SkuInfo
= Pcd
.SkuInfoList
[Sku
]
1294 SkuIdName
= SkuInfo
.SkuIdName
1295 if TypeName
in ('DYNHII', 'DEXHII'):
1296 if SkuInfo
.DefaultStoreDict
:
1297 DefaultStoreList
= sorted(SkuInfo
.DefaultStoreDict
.keys())
1298 for DefaultStore
in DefaultStoreList
:
1299 Value
= SkuInfo
.DefaultStoreDict
[DefaultStore
]
1300 IsByteArray
, ArrayList
= ByteArrayForamt(Value
)
1301 if Pcd
.DatumType
== 'BOOLEAN':
1302 Value
= str(int(Value
, 0))
1306 if self
.DefaultStoreSingle
and self
.SkuSingle
:
1307 FileWrite(File
, ' %-*s : %6s %10s = %s' % (self
.MaxLen
, Flag
+ ' ' + PcdTokenCName
, TypeName
, '(' + Pcd
.DatumType
+ ')', '{'))
1308 elif self
.DefaultStoreSingle
and not self
.SkuSingle
:
1309 FileWrite(File
, ' %-*s : %6s %10s %10s = %s' % (self
.MaxLen
, Flag
+ ' ' + PcdTokenCName
, TypeName
, '(' + Pcd
.DatumType
+ ')', '(' + SkuIdName
+ ')', '{'))
1310 elif not self
.DefaultStoreSingle
and self
.SkuSingle
:
1311 FileWrite(File
, ' %-*s : %6s %10s %10s = %s' % (self
.MaxLen
, Flag
+ ' ' + PcdTokenCName
, TypeName
, '(' + Pcd
.DatumType
+ ')', '(' + DefaultStore
+ ')', '{'))
1313 FileWrite(File
, ' %-*s : %6s %10s %10s %10s = %s' % (self
.MaxLen
, Flag
+ ' ' + PcdTokenCName
, TypeName
, '(' + Pcd
.DatumType
+ ')', '(' + SkuIdName
+ ')', '(' + DefaultStore
+ ')', '{'))
1314 for Array
in ArrayList
:
1315 FileWrite(File
, Array
)
1317 if Pcd
.DatumType
in TAB_PCD_CLEAN_NUMERIC_TYPES
:
1318 if Value
.startswith(('0x', '0X')):
1319 Value
= '{} ({:d})'.format(Value
, int(Value
, 0))
1321 Value
= "0x{:X} ({})".format(int(Value
, 0), Value
)
1322 if self
.DefaultStoreSingle
and self
.SkuSingle
:
1323 FileWrite(File
, ' %-*s : %6s %10s = %s' % (self
.MaxLen
, Flag
+ ' ' + PcdTokenCName
, TypeName
, '(' + Pcd
.DatumType
+ ')', Value
))
1324 elif self
.DefaultStoreSingle
and not self
.SkuSingle
:
1325 FileWrite(File
, ' %-*s : %6s %10s %10s = %s' % (self
.MaxLen
, Flag
+ ' ' + PcdTokenCName
, TypeName
, '(' + Pcd
.DatumType
+ ')', '(' + SkuIdName
+ ')', Value
))
1326 elif not self
.DefaultStoreSingle
and self
.SkuSingle
:
1327 FileWrite(File
, ' %-*s : %6s %10s %10s = %s' % (self
.MaxLen
, Flag
+ ' ' + PcdTokenCName
, TypeName
, '(' + Pcd
.DatumType
+ ')', '(' + DefaultStore
+ ')', Value
))
1329 FileWrite(File
, ' %-*s : %6s %10s %10s %10s = %s' % (self
.MaxLen
, Flag
+ ' ' + PcdTokenCName
, TypeName
, '(' + Pcd
.DatumType
+ ')', '(' + SkuIdName
+ ')', '(' + DefaultStore
+ ')', Value
))
1332 if self
.DefaultStoreSingle
and self
.SkuSingle
:
1333 FileWrite(File
, ' %-*s : %6s %10s = %s' % (self
.MaxLen
, ' ', TypeName
, '(' + Pcd
.DatumType
+ ')', '{'))
1334 elif self
.DefaultStoreSingle
and not self
.SkuSingle
:
1335 FileWrite(File
, ' %-*s : %6s %10s %10s = %s' % (self
.MaxLen
, ' ', TypeName
, '(' + Pcd
.DatumType
+ ')', '(' + SkuIdName
+ ')', '{'))
1336 elif not self
.DefaultStoreSingle
and self
.SkuSingle
:
1337 FileWrite(File
, ' %-*s : %6s %10s %10s = %s' % (self
.MaxLen
, ' ', TypeName
, '(' + Pcd
.DatumType
+ ')', '(' + DefaultStore
+ ')', '{'))
1339 FileWrite(File
, ' %-*s : %6s %10s %10s %10s = %s' % (self
.MaxLen
, ' ', TypeName
, '(' + Pcd
.DatumType
+ ')', '(' + SkuIdName
+ ')', '(' + DefaultStore
+ ')', '{'))
1340 for Array
in ArrayList
:
1341 FileWrite(File
, Array
)
1343 if Pcd
.DatumType
in TAB_PCD_CLEAN_NUMERIC_TYPES
:
1344 if Value
.startswith(('0x', '0X')):
1345 Value
= '{} ({:d})'.format(Value
, int(Value
, 0))
1347 Value
= "0x{:X} ({})".format(int(Value
, 0), Value
)
1348 if self
.DefaultStoreSingle
and self
.SkuSingle
:
1349 FileWrite(File
, ' %-*s : %6s %10s = %s' % (self
.MaxLen
, ' ', TypeName
, '(' + Pcd
.DatumType
+ ')', Value
))
1350 elif self
.DefaultStoreSingle
and not self
.SkuSingle
:
1351 FileWrite(File
, ' %-*s : %6s %10s %10s = %s' % (self
.MaxLen
, ' ', TypeName
, '(' + Pcd
.DatumType
+ ')', '(' + SkuIdName
+ ')', Value
))
1352 elif not self
.DefaultStoreSingle
and self
.SkuSingle
:
1353 FileWrite(File
, ' %-*s : %6s %10s %10s = %s' % (self
.MaxLen
, ' ', TypeName
, '(' + Pcd
.DatumType
+ ')', '(' + DefaultStore
+ ')', Value
))
1355 FileWrite(File
, ' %-*s : %6s %10s %10s %10s = %s' % (self
.MaxLen
, ' ', TypeName
, '(' + Pcd
.DatumType
+ ')', '(' + SkuIdName
+ ')', '(' + DefaultStore
+ ')', Value
))
1356 FileWrite(File
, '%*s: %s: %s' % (self
.MaxLen
+ 4, SkuInfo
.VariableGuid
, SkuInfo
.VariableName
, SkuInfo
.VariableOffset
))
1358 OverrideValues
= Pcd
.SkuOverrideValues
[Sku
]
1359 OverrideFieldStruct
= self
.OverrideFieldValue(Pcd
, OverrideValues
[DefaultStore
])
1360 self
.PrintStructureInfo(File
, OverrideFieldStruct
)
1361 self
.PrintPcdDefault(File
, Pcd
, IsStructure
, DscMatch
, DscDefaultValue
, InfMatch
, InfDefaultValue
, DecMatch
, DecDefaultValue
)
1363 Value
= SkuInfo
.DefaultValue
1364 IsByteArray
, ArrayList
= ByteArrayForamt(Value
)
1365 if Pcd
.DatumType
== 'BOOLEAN':
1366 Value
= str(int(Value
, 0))
1371 FileWrite(File
, ' %-*s : %6s %10s = %s' % (self
.MaxLen
, Flag
+ ' ' + PcdTokenCName
, TypeName
, '(' + Pcd
.DatumType
+ ')', "{"))
1373 FileWrite(File
, ' %-*s : %6s %10s %10s = %s' % (self
.MaxLen
, Flag
+ ' ' + PcdTokenCName
, TypeName
, '(' + Pcd
.DatumType
+ ')', '(' + SkuIdName
+ ')', "{"))
1374 for Array
in ArrayList
:
1375 FileWrite(File
, Array
)
1377 if Pcd
.DatumType
in TAB_PCD_CLEAN_NUMERIC_TYPES
:
1378 if Value
.startswith(('0x', '0X')):
1379 Value
= '{} ({:d})'.format(Value
, int(Value
, 0))
1381 Value
= "0x{:X} ({})".format(int(Value
, 0), Value
)
1383 FileWrite(File
, ' %-*s : %6s %10s = %s' % (self
.MaxLen
, Flag
+ ' ' + PcdTokenCName
, TypeName
, '(' + Pcd
.DatumType
+ ')', Value
))
1385 FileWrite(File
, ' %-*s : %6s %10s %10s = %s' % (self
.MaxLen
, Flag
+ ' ' + PcdTokenCName
, TypeName
, '(' + Pcd
.DatumType
+ ')', '(' + SkuIdName
+ ')', Value
))
1389 FileWrite(File
, ' %-*s : %6s %10s = %s' % (self
.MaxLen
, ' ', TypeName
, '(' + Pcd
.DatumType
+ ')', "{"))
1391 FileWrite(File
, ' %-*s : %6s %10s %10s = %s' % (self
.MaxLen
, ' ', TypeName
, '(' + Pcd
.DatumType
+ ')', '(' + SkuIdName
+ ')', "{"))
1392 for Array
in ArrayList
:
1393 FileWrite(File
, Array
)
1395 if Pcd
.DatumType
in TAB_PCD_CLEAN_NUMERIC_TYPES
:
1396 if Value
.startswith(('0x', '0X')):
1397 Value
= '{} ({:d})'.format(Value
, int(Value
, 0))
1399 Value
= "0x{:X} ({})".format(int(Value
, 0), Value
)
1401 FileWrite(File
, ' %-*s : %6s %10s = %s' % (self
.MaxLen
, ' ', TypeName
, '(' + Pcd
.DatumType
+ ')', Value
))
1403 FileWrite(File
, ' %-*s : %6s %10s %10s = %s' % (self
.MaxLen
, ' ', TypeName
, '(' + Pcd
.DatumType
+ ')', '(' + SkuIdName
+ ')', Value
))
1404 if TypeName
in ('DYNVPD', 'DEXVPD'):
1405 FileWrite(File
, '%*s' % (self
.MaxLen
+ 4, SkuInfo
.VpdOffset
))
1407 OverrideValues
= Pcd
.SkuOverrideValues
[Sku
]
1409 Keys
= list(OverrideValues
.keys())
1410 OverrideFieldStruct
= self
.OverrideFieldValue(Pcd
, OverrideValues
[Keys
[0]])
1411 self
.PrintStructureInfo(File
, OverrideFieldStruct
)
1412 self
.PrintPcdDefault(File
, Pcd
, IsStructure
, DscMatch
, DscDefaultValue
, InfMatch
, InfDefaultValue
, DecMatch
, DecDefaultValue
)
1414 def OverrideFieldValue(self
, Pcd
, OverrideStruct
):
1415 OverrideFieldStruct
= collections
.OrderedDict()
1417 for Key
, Values
in OverrideStruct
.items():
1418 if Values
[1] and Values
[1].endswith('.dsc'):
1419 OverrideFieldStruct
[Key
] = Values
1420 if Pcd
.PcdFieldValueFromFdf
:
1421 for Key
, Values
in Pcd
.PcdFieldValueFromFdf
.items():
1422 if Key
in OverrideFieldStruct
and Values
[0] == OverrideFieldStruct
[Key
][0]:
1424 OverrideFieldStruct
[Key
] = Values
1425 if Pcd
.PcdFieldValueFromComm
:
1426 for Key
, Values
in Pcd
.PcdFieldValueFromComm
.items():
1427 if Key
in OverrideFieldStruct
and Values
[0] == OverrideFieldStruct
[Key
][0]:
1429 OverrideFieldStruct
[Key
] = Values
1430 return OverrideFieldStruct
1432 def PrintStructureInfo(self
, File
, Struct
):
1433 for Key
, Value
in sorted(Struct
.items(), key
=lambda x
: x
[0]):
1434 if Value
[1] and 'build command options' in Value
[1]:
1435 FileWrite(File
, ' *B %-*s = %s' % (self
.MaxLen
+ 4, '.' + Key
, Value
[0]))
1436 elif Value
[1] and Value
[1].endswith('.fdf'):
1437 FileWrite(File
, ' *F %-*s = %s' % (self
.MaxLen
+ 4, '.' + Key
, Value
[0]))
1439 FileWrite(File
, ' %-*s = %s' % (self
.MaxLen
+ 4, '.' + Key
, Value
[0]))
1441 def StrtoHex(self
, value
):
1443 value
= hex(int(value
))
1446 if value
.startswith("L\"") and value
.endswith("\""):
1448 for ch
in value
[2:-1]:
1449 valuelist
.append(hex(ord(ch
)))
1450 valuelist
.append('0x00')
1452 elif value
.startswith("\"") and value
.endswith("\""):
1453 return hex(ord(value
[1:-1]))
1454 elif value
.startswith("{") and value
.endswith("}"):
1456 if ',' not in value
:
1458 for ch
in value
[1:-1].split(','):
1460 if ch
.startswith('0x') or ch
.startswith('0X'):
1461 valuelist
.append(ch
)
1464 valuelist
.append(hex(int(ch
.strip())))
1471 def IsStructurePcd(self
, PcdToken
, PcdTokenSpaceGuid
):
1472 if GlobalData
.gStructurePcd
and (self
.Arch
in GlobalData
.gStructurePcd
) and ((PcdToken
, PcdTokenSpaceGuid
) in GlobalData
.gStructurePcd
[self
.Arch
]):
1478 # Reports platform and module Prediction information
1480 # This class reports the platform execution order prediction section and
1481 # module load fixed address prediction subsection in the build report file.
1483 class PredictionReport(object):
1485 # Constructor function for class PredictionReport
1487 # This constructor function generates PredictionReport object for the platform.
1489 # @param self: The object pointer
1490 # @param Wa Workspace context information
1492 def __init__(self
, Wa
):
1493 self
._MapFileName
= os
.path
.join(Wa
.BuildDir
, Wa
.Name
+ ".map")
1494 self
._MapFileParsed
= False
1495 self
._EotToolInvoked
= False
1496 self
._FvDir
= Wa
.FvDir
1497 self
._EotDir
= Wa
.BuildDir
1498 self
._FfsEntryPoint
= {}
1500 self
._SourceList
= []
1501 self
.FixedMapDict
= {}
1506 # Collect all platform reference source files and GUID C Name
1508 for Pa
in Wa
.AutoGenObjectList
:
1509 for Module
in Pa
.LibraryAutoGenList
+ Pa
.ModuleAutoGenList
:
1511 # BASE typed modules are EFI agnostic, so we need not scan
1512 # their source code to find PPI/Protocol produce or consume
1515 if Module
.ModuleType
== SUP_MODULE_BASE
:
1518 # Add module referenced source files
1520 self
._SourceList
.append(str(Module
))
1522 for Source
in Module
.SourceFileList
:
1523 if os
.path
.splitext(str(Source
))[1].lower() == ".c":
1524 self
._SourceList
.append(" " + str(Source
))
1525 FindIncludeFiles(Source
.Path
, Module
.IncludePathList
, IncludeList
)
1526 for IncludeFile
in IncludeList
.values():
1527 self
._SourceList
.append(" " + IncludeFile
)
1529 for Guid
in Module
.PpiList
:
1530 self
._GuidMap
[Guid
] = GuidStructureStringToGuidString(Module
.PpiList
[Guid
])
1531 for Guid
in Module
.ProtocolList
:
1532 self
._GuidMap
[Guid
] = GuidStructureStringToGuidString(Module
.ProtocolList
[Guid
])
1533 for Guid
in Module
.GuidList
:
1534 self
._GuidMap
[Guid
] = GuidStructureStringToGuidString(Module
.GuidList
[Guid
])
1536 if Module
.Guid
and not Module
.IsLibrary
:
1537 EntryPoint
= " ".join(Module
.Module
.ModuleEntryPointList
)
1538 if int(str(Module
.AutoGenVersion
), 0) >= 0x00010005:
1539 RealEntryPoint
= "_ModuleEntryPoint"
1541 RealEntryPoint
= EntryPoint
1542 if EntryPoint
== "_ModuleEntryPoint":
1543 CCFlags
= Module
.BuildOption
.get("CC", {}).get("FLAGS", "")
1544 Match
= gGlueLibEntryPoint
.search(CCFlags
)
1546 EntryPoint
= Match
.group(1)
1548 self
._FfsEntryPoint
[Module
.Guid
.upper()] = (EntryPoint
, RealEntryPoint
)
1552 # Collect platform firmware volume list as the input of EOT.
1556 for Fd
in Wa
.FdfProfile
.FdDict
:
1557 for FdRegion
in Wa
.FdfProfile
.FdDict
[Fd
].RegionList
:
1558 if FdRegion
.RegionType
!= BINARY_FILE_TYPE_FV
:
1560 for FvName
in FdRegion
.RegionDataList
:
1561 if FvName
in self
._FvList
:
1563 self
._FvList
.append(FvName
)
1564 for Ffs
in Wa
.FdfProfile
.FvDict
[FvName
.upper()].FfsList
:
1565 for Section
in Ffs
.SectionList
:
1567 for FvSection
in Section
.SectionList
:
1568 if FvSection
.FvName
in self
._FvList
:
1570 self
._FvList
.append(FvSection
.FvName
)
1571 except AttributeError:
1576 # Parse platform fixed address map files
1578 # This function parses the platform final fixed address map file to get
1579 # the database of predicted fixed address for module image base, entry point
1582 # @param self: The object pointer
1584 def _ParseMapFile(self
):
1585 if self
._MapFileParsed
:
1587 self
._MapFileParsed
= True
1588 if os
.path
.isfile(self
._MapFileName
):
1590 FileContents
= open(self
._MapFileName
).read()
1591 for Match
in gMapFileItemPattern
.finditer(FileContents
):
1592 AddressType
= Match
.group(1)
1593 BaseAddress
= Match
.group(2)
1594 EntryPoint
= Match
.group(3)
1595 Guid
= Match
.group(4).upper()
1596 List
= self
.FixedMapDict
.setdefault(Guid
, [])
1597 List
.append((AddressType
, BaseAddress
, "*I"))
1598 List
.append((AddressType
, EntryPoint
, "*E"))
1600 EdkLogger
.warn(None, "Cannot open file to read", self
._MapFileName
)
1603 # Invokes EOT tool to get the predicted the execution order.
1605 # This function invokes EOT tool to calculate the predicted dispatch order
1607 # @param self: The object pointer
1609 def _InvokeEotTool(self
):
1610 if self
._EotToolInvoked
:
1613 self
._EotToolInvoked
= True
1615 for FvName
in self
._FvList
:
1616 FvFile
= os
.path
.join(self
._FvDir
, FvName
+ ".Fv")
1617 if os
.path
.isfile(FvFile
):
1618 FvFileList
.append(FvFile
)
1620 if len(FvFileList
) == 0:
1623 # Write source file list and GUID file list to an intermediate file
1624 # as the input for EOT tool and dispatch List as the output file
1627 SourceList
= os
.path
.join(self
._EotDir
, "SourceFile.txt")
1628 GuidList
= os
.path
.join(self
._EotDir
, "GuidList.txt")
1629 DispatchList
= os
.path
.join(self
._EotDir
, "Dispatch.txt")
1631 TempFile
= open(SourceList
, "w+")
1632 for Item
in self
._SourceList
:
1633 FileWrite(TempFile
, Item
)
1635 TempFile
= open(GuidList
, "w+")
1636 for Key
in self
._GuidMap
:
1637 FileWrite(TempFile
, "%s %s" % (Key
, self
._GuidMap
[Key
]))
1641 from Eot
.EotMain
import Eot
1644 # Invoke EOT tool and echo its runtime performance
1646 EotStartTime
= time
.time()
1647 Eot(CommandLineOption
=False, SourceFileList
=SourceList
, GuidList
=GuidList
,
1648 FvFileList
=' '.join(FvFileList
), Dispatch
=DispatchList
, IsInit
=True)
1649 EotEndTime
= time
.time()
1650 EotDuration
= time
.strftime("%H:%M:%S", time
.gmtime(int(round(EotEndTime
- EotStartTime
))))
1651 EdkLogger
.quiet("EOT run time: %s\n" % EotDuration
)
1654 # Parse the output of EOT tool
1656 for Line
in open(DispatchList
):
1657 if len(Line
.split()) < 4:
1659 (Guid
, Phase
, FfsName
, FilePath
) = Line
.split()
1660 Symbol
= self
._FfsEntryPoint
.get(Guid
, [FfsName
, ""])[0]
1661 if len(Symbol
) > self
.MaxLen
:
1662 self
.MaxLen
= len(Symbol
)
1663 self
.ItemList
.append((Phase
, Symbol
, FilePath
))
1665 EdkLogger
.quiet("(Python %s on %s\n%s)" % (platform
.python_version(), sys
.platform
, traceback
.format_exc()))
1666 EdkLogger
.warn(None, "Failed to generate execution order prediction report, for some error occurred in executing EOT.")
1670 # Generate platform execution order report
1672 # This function generates the predicted module execution order.
1674 # @param self The object pointer
1675 # @param File The file object for report
1677 def _GenerateExecutionOrderReport(self
, File
):
1678 self
._InvokeEotTool
()
1679 if len(self
.ItemList
) == 0:
1681 FileWrite(File
, gSectionStart
)
1682 FileWrite(File
, "Execution Order Prediction")
1683 FileWrite(File
, "*P PEI phase")
1684 FileWrite(File
, "*D DXE phase")
1685 FileWrite(File
, "*E Module INF entry point name")
1686 FileWrite(File
, "*N Module notification function name")
1688 FileWrite(File
, "Type %-*s %s" % (self
.MaxLen
, "Symbol", "Module INF Path"))
1689 FileWrite(File
, gSectionSep
)
1690 for Item
in self
.ItemList
:
1691 FileWrite(File
, "*%sE %-*s %s" % (Item
[0], self
.MaxLen
, Item
[1], Item
[2]))
1693 FileWrite(File
, gSectionStart
)
1696 # Generate Fixed Address report.
1698 # This function generate the predicted fixed address report for a module
1699 # specified by Guid.
1701 # @param self The object pointer
1702 # @param File The file object for report
1703 # @param Guid The module Guid value.
1704 # @param NotifyList The list of all notify function in a module
1706 def _GenerateFixedAddressReport(self
, File
, Guid
, NotifyList
):
1707 self
._ParseMapFile
()
1708 FixedAddressList
= self
.FixedMapDict
.get(Guid
)
1709 if not FixedAddressList
:
1712 FileWrite(File
, gSubSectionStart
)
1713 FileWrite(File
, "Fixed Address Prediction")
1714 FileWrite(File
, "*I Image Loading Address")
1715 FileWrite(File
, "*E Entry Point Address")
1716 FileWrite(File
, "*N Notification Function Address")
1717 FileWrite(File
, "*F Flash Address")
1718 FileWrite(File
, "*M Memory Address")
1719 FileWrite(File
, "*S SMM RAM Offset")
1720 FileWrite(File
, "TOM Top of Memory")
1722 FileWrite(File
, "Type Address Name")
1723 FileWrite(File
, gSubSectionSep
)
1724 for Item
in FixedAddressList
:
1729 Name
= "(Image Base)"
1730 elif Symbol
== "*E":
1731 Name
= self
._FfsEntryPoint
.get(Guid
, ["", "_ModuleEntryPoint"])[1]
1732 elif Symbol
in NotifyList
:
1740 elif "Memory" in Type
:
1746 Value
= "TOM" + Value
1748 FileWrite(File
, "%s %-16s %s" % (Symbol
, Value
, Name
))
1751 # Generate report for the prediction part
1753 # This function generate the predicted fixed address report for a module or
1754 # predicted module execution order for a platform.
1755 # If the input Guid is None, then, it generates the predicted module execution order;
1756 # otherwise it generated the module fixed loading address for the module specified by
1759 # @param self The object pointer
1760 # @param File The file object for report
1761 # @param Guid The module Guid value.
1763 def GenerateReport(self
, File
, Guid
):
1765 self
._GenerateFixedAddressReport
(File
, Guid
.upper(), [])
1767 self
._GenerateExecutionOrderReport
(File
)
1770 # Reports FD region information
1772 # This class reports the FD subsection in the build report file.
1773 # It collects region information of platform flash device.
1774 # If the region is a firmware volume, it lists the set of modules
1775 # and its space information; otherwise, it only lists its region name,
1776 # base address and size in its sub-section header.
1777 # If there are nesting FVs, the nested FVs will list immediate after
1778 # this FD region subsection
1780 class FdRegionReport(object):
1782 # Discover all the nested FV name list.
1784 # This is an internal worker function to discover the all the nested FV information
1785 # in the parent firmware volume. It uses deep first search algorithm recursively to
1786 # find all the FV list name and append them to the list.
1788 # @param self The object pointer
1789 # @param FvName The name of current firmware file system
1790 # @param Wa Workspace context information
1792 def _DiscoverNestedFvList(self
, FvName
, Wa
):
1793 FvDictKey
=FvName
.upper()
1794 if FvDictKey
in Wa
.FdfProfile
.FvDict
:
1795 for Ffs
in Wa
.FdfProfile
.FvDict
[FvName
.upper()].FfsList
:
1796 for Section
in Ffs
.SectionList
:
1798 for FvSection
in Section
.SectionList
:
1799 if FvSection
.FvName
in self
.FvList
:
1801 self
._GuidsDb
[Ffs
.NameGuid
.upper()] = FvSection
.FvName
1802 self
.FvList
.append(FvSection
.FvName
)
1803 self
.FvInfo
[FvSection
.FvName
] = ("Nested FV", 0, 0)
1804 self
._DiscoverNestedFvList
(FvSection
.FvName
, Wa
)
1805 except AttributeError:
1809 # Constructor function for class FdRegionReport
1811 # This constructor function generates FdRegionReport object for a specified FdRegion.
1812 # If the FdRegion is a firmware volume, it will recursively find all its nested Firmware
1813 # volume list. This function also collects GUID map in order to dump module identification
1814 # in the final report.
1816 # @param self: The object pointer
1817 # @param FdRegion The current FdRegion object
1818 # @param Wa Workspace context information
1820 def __init__(self
, FdRegion
, Wa
):
1821 self
.Type
= FdRegion
.RegionType
1822 self
.BaseAddress
= FdRegion
.Offset
1823 self
.Size
= FdRegion
.Size
1827 self
._FvDir
= Wa
.FvDir
1828 self
._WorkspaceDir
= Wa
.WorkspaceDir
1831 # If the input FdRegion is not a firmware volume,
1834 if self
.Type
!= BINARY_FILE_TYPE_FV
:
1838 # Find all nested FVs in the FdRegion
1840 for FvName
in FdRegion
.RegionDataList
:
1841 if FvName
in self
.FvList
:
1843 self
.FvList
.append(FvName
)
1844 self
.FvInfo
[FvName
] = ("Fd Region", self
.BaseAddress
, self
.Size
)
1845 self
._DiscoverNestedFvList
(FvName
, Wa
)
1849 # Collect PCDs declared in DEC files.
1851 for Pa
in Wa
.AutoGenObjectList
:
1852 for Package
in Pa
.PackageList
:
1853 for (TokenCName
, TokenSpaceGuidCName
, DecType
) in Package
.Pcds
:
1854 DecDefaultValue
= Package
.Pcds
[TokenCName
, TokenSpaceGuidCName
, DecType
].DefaultValue
1855 PlatformPcds
[(TokenCName
, TokenSpaceGuidCName
)] = DecDefaultValue
1857 # Collect PCDs defined in DSC file
1859 for Pa
in Wa
.AutoGenObjectList
:
1860 for (TokenCName
, TokenSpaceGuidCName
) in Pa
.Platform
.Pcds
:
1861 DscDefaultValue
= Pa
.Platform
.Pcds
[(TokenCName
, TokenSpaceGuidCName
)].DefaultValue
1862 PlatformPcds
[(TokenCName
, TokenSpaceGuidCName
)] = DscDefaultValue
1865 # Add PEI and DXE a priori files GUIDs defined in PI specification.
1867 self
._GuidsDb
["1B45CC0A-156A-428A-AF62-49864DA0E6E6"] = "PEI Apriori"
1868 self
._GuidsDb
["FC510EE7-FFDC-11D4-BD41-0080C73C8881"] = "DXE Apriori"
1870 # Add ACPI table storage file
1872 self
._GuidsDb
["7E374E25-8E01-4FEE-87F2-390C23C606CD"] = "ACPI table storage"
1874 for Pa
in Wa
.AutoGenObjectList
:
1875 for ModuleKey
in Pa
.Platform
.Modules
:
1876 M
= Pa
.Platform
.Modules
[ModuleKey
].M
1877 InfPath
= mws
.join(Wa
.WorkspaceDir
, M
.MetaFile
.File
)
1878 self
._GuidsDb
[M
.Guid
.upper()] = "%s (%s)" % (M
.Module
.BaseName
, InfPath
)
1881 # Collect the GUID map in the FV firmware volume
1883 for FvName
in self
.FvList
:
1884 FvDictKey
=FvName
.upper()
1885 if FvDictKey
in Wa
.FdfProfile
.FvDict
:
1886 for Ffs
in Wa
.FdfProfile
.FvDict
[FvName
.upper()].FfsList
:
1889 # collect GUID map for binary EFI file in FDF file.
1891 Guid
= Ffs
.NameGuid
.upper()
1892 Match
= gPcdGuidPattern
.match(Ffs
.NameGuid
)
1894 PcdTokenspace
= Match
.group(1)
1895 PcdToken
= Match
.group(2)
1896 if (PcdToken
, PcdTokenspace
) in PlatformPcds
:
1897 GuidValue
= PlatformPcds
[(PcdToken
, PcdTokenspace
)]
1898 Guid
= GuidStructureByteArrayToGuidString(GuidValue
).upper()
1899 for Section
in Ffs
.SectionList
:
1901 ModuleSectFile
= mws
.join(Wa
.WorkspaceDir
, Section
.SectFileName
)
1902 self
._GuidsDb
[Guid
] = ModuleSectFile
1903 except AttributeError:
1905 except AttributeError:
1910 # Internal worker function to generate report for the FD region
1912 # This internal worker function to generate report for the FD region.
1913 # It the type is firmware volume, it lists offset and module identification.
1915 # @param self The object pointer
1916 # @param File The file object for report
1917 # @param Title The title for the FD subsection
1918 # @param BaseAddress The base address for the FD region
1919 # @param Size The size of the FD region
1920 # @param FvName The FV name if the FD region is a firmware volume
1922 def _GenerateReport(self
, File
, Title
, Type
, BaseAddress
, Size
=0, FvName
=None):
1923 FileWrite(File
, gSubSectionStart
)
1924 FileWrite(File
, Title
)
1925 FileWrite(File
, "Type: %s" % Type
)
1926 FileWrite(File
, "Base Address: 0x%X" % BaseAddress
)
1928 if self
.Type
== BINARY_FILE_TYPE_FV
:
1932 if FvName
.upper().endswith('.FV'):
1933 FileExt
= FvName
+ ".txt"
1935 FileExt
= FvName
+ ".Fv.txt"
1937 if not os
.path
.isfile(FileExt
):
1938 FvReportFileName
= mws
.join(self
._WorkspaceDir
, FileExt
)
1939 if not os
.path
.isfile(FvReportFileName
):
1940 FvReportFileName
= os
.path
.join(self
._FvDir
, FileExt
)
1943 # Collect size info in the firmware volume.
1945 FvReport
= open(FvReportFileName
).read()
1946 Match
= gFvTotalSizePattern
.search(FvReport
)
1948 FvTotalSize
= int(Match
.group(1), 16)
1949 Match
= gFvTakenSizePattern
.search(FvReport
)
1951 FvTakenSize
= int(Match
.group(1), 16)
1952 FvFreeSize
= FvTotalSize
- FvTakenSize
1954 # Write size information to the report file.
1956 FileWrite(File
, "Size: 0x%X (%.0fK)" % (FvTotalSize
, FvTotalSize
/ 1024.0))
1957 FileWrite(File
, "Fv Name: %s (%.1f%% Full)" % (FvName
, FvTakenSize
* 100.0 / FvTotalSize
))
1958 FileWrite(File
, "Occupied Size: 0x%X (%.0fK)" % (FvTakenSize
, FvTakenSize
/ 1024.0))
1959 FileWrite(File
, "Free Size: 0x%X (%.0fK)" % (FvFreeSize
, FvFreeSize
/ 1024.0))
1960 FileWrite(File
, "Offset Module")
1961 FileWrite(File
, gSubSectionSep
)
1963 # Write module offset and module identification to the report file.
1966 for Match
in gOffsetGuidPattern
.finditer(FvReport
):
1967 Guid
= Match
.group(2).upper()
1968 OffsetInfo
[Match
.group(1)] = self
._GuidsDb
.get(Guid
, Guid
)
1969 OffsetList
= sorted(OffsetInfo
.keys())
1970 for Offset
in OffsetList
:
1971 FileWrite (File
, "%s %s" % (Offset
, OffsetInfo
[Offset
]))
1973 EdkLogger
.warn(None, "Fail to read report file", FvReportFileName
)
1975 FileWrite(File
, "Size: 0x%X (%.0fK)" % (Size
, Size
/ 1024.0))
1976 FileWrite(File
, gSubSectionEnd
)
1979 # Generate report for the FD region
1981 # This function generates report for the FD region.
1983 # @param self The object pointer
1984 # @param File The file object for report
1986 def GenerateReport(self
, File
):
1987 if (len(self
.FvList
) > 0):
1988 for FvItem
in self
.FvList
:
1989 Info
= self
.FvInfo
[FvItem
]
1990 self
._GenerateReport
(File
, Info
[0], TAB_FV_DIRECTORY
, Info
[1], Info
[2], FvItem
)
1992 self
._GenerateReport
(File
, "FD Region", self
.Type
, self
.BaseAddress
, self
.Size
)
1995 # Reports FD information
1997 # This class reports the FD section in the build report file.
1998 # It collects flash device information for a platform.
2000 class FdReport(object):
2002 # Constructor function for class FdReport
2004 # This constructor function generates FdReport object for a specified
2007 # @param self The object pointer
2008 # @param Fd The current Firmware device object
2009 # @param Wa Workspace context information
2011 def __init__(self
, Fd
, Wa
):
2012 self
.FdName
= Fd
.FdUiName
2013 self
.BaseAddress
= Fd
.BaseAddress
2015 self
.FdRegionList
= [FdRegionReport(FdRegion
, Wa
) for FdRegion
in Fd
.RegionList
]
2016 self
.FvPath
= os
.path
.join(Wa
.BuildDir
, TAB_FV_DIRECTORY
)
2017 self
.VpdFilePath
= os
.path
.join(self
.FvPath
, "%s.map" % Wa
.Platform
.VpdToolGuid
)
2018 self
.VPDBaseAddress
= 0
2020 self
.VPDInfoList
= []
2021 for index
, FdRegion
in enumerate(Fd
.RegionList
):
2022 if str(FdRegion
.RegionType
) is 'FILE' and Wa
.Platform
.VpdToolGuid
in str(FdRegion
.RegionDataList
):
2023 self
.VPDBaseAddress
= self
.FdRegionList
[index
].BaseAddress
2024 self
.VPDSize
= self
.FdRegionList
[index
].Size
2027 if os
.path
.isfile(self
.VpdFilePath
):
2028 fd
= open(self
.VpdFilePath
, "r")
2029 Lines
= fd
.readlines()
2032 if len(Line
) == 0 or Line
.startswith("#"):
2035 PcdName
, SkuId
, Offset
, Size
, Value
= Line
.split("#")[0].split("|")
2036 PcdName
, SkuId
, Offset
, Size
, Value
= PcdName
.strip(), SkuId
.strip(), Offset
.strip(), Size
.strip(), Value
.strip()
2037 if Offset
.lower().startswith('0x'):
2038 Offset
= '0x%08X' % (int(Offset
, 16) + self
.VPDBaseAddress
)
2040 Offset
= '0x%08X' % (int(Offset
, 10) + self
.VPDBaseAddress
)
2041 self
.VPDInfoList
.append("%s | %s | %s | %s | %s" % (PcdName
, SkuId
, Offset
, Size
, Value
))
2043 EdkLogger
.error("BuildReport", CODE_ERROR
, "Fail to parse VPD information file %s" % self
.VpdFilePath
)
2047 # Generate report for the firmware device.
2049 # This function generates report for the firmware device.
2051 # @param self The object pointer
2052 # @param File The file object for report
2054 def GenerateReport(self
, File
):
2055 FileWrite(File
, gSectionStart
)
2056 FileWrite(File
, "Firmware Device (FD)")
2057 FileWrite(File
, "FD Name: %s" % self
.FdName
)
2058 FileWrite(File
, "Base Address: %s" % self
.BaseAddress
)
2059 FileWrite(File
, "Size: 0x%X (%.0fK)" % (self
.Size
, self
.Size
/ 1024.0))
2060 if len(self
.FdRegionList
) > 0:
2061 FileWrite(File
, gSectionSep
)
2062 for FdRegionItem
in self
.FdRegionList
:
2063 FdRegionItem
.GenerateReport(File
)
2065 if len(self
.VPDInfoList
) > 0:
2066 FileWrite(File
, gSubSectionStart
)
2067 FileWrite(File
, "FD VPD Region")
2068 FileWrite(File
, "Base Address: 0x%X" % self
.VPDBaseAddress
)
2069 FileWrite(File
, "Size: 0x%X (%.0fK)" % (self
.VPDSize
, self
.VPDSize
/ 1024.0))
2070 FileWrite(File
, gSubSectionSep
)
2071 for item
in self
.VPDInfoList
:
2072 ValueList
= item
.split('|')
2073 Value
= ValueList
[-1].strip()
2074 IsByteArray
, ArrayList
= ByteArrayForamt(Value
)
2076 ValueList
[-1] = ' {'
2077 FileWrite(File
, '|'.join(ValueList
))
2078 for Array
in ArrayList
:
2079 FileWrite(File
, Array
)
2081 FileWrite(File
, item
)
2082 FileWrite(File
, gSubSectionEnd
)
2083 FileWrite(File
, gSectionEnd
)
2088 # Reports platform information
2090 # This class reports the whole platform information
2092 class PlatformReport(object):
2094 # Constructor function for class PlatformReport
2096 # This constructor function generates PlatformReport object a platform build.
2097 # It generates report for platform summary, flash, global PCDs and detailed
2098 # module information for modules involved in platform build.
2100 # @param self The object pointer
2101 # @param Wa Workspace context information
2102 # @param MaList The list of modules in the platform build
2104 def __init__(self
, Wa
, MaList
, ReportType
):
2105 self
._WorkspaceDir
= Wa
.WorkspaceDir
2106 self
.PlatformName
= Wa
.Name
2107 self
.PlatformDscPath
= Wa
.Platform
2108 self
.Architectures
= " ".join(Wa
.ArchList
)
2109 self
.ToolChain
= Wa
.ToolChain
2110 self
.Target
= Wa
.BuildTarget
2111 self
.OutputPath
= os
.path
.join(Wa
.WorkspaceDir
, Wa
.OutputDir
)
2112 self
.BuildEnvironment
= platform
.platform()
2114 self
.PcdReport
= None
2115 if "PCD" in ReportType
:
2116 self
.PcdReport
= PcdReport(Wa
)
2118 self
.FdReportList
= []
2119 if "FLASH" in ReportType
and Wa
.FdfProfile
and MaList
is None:
2120 for Fd
in Wa
.FdfProfile
.FdDict
:
2121 self
.FdReportList
.append(FdReport(Wa
.FdfProfile
.FdDict
[Fd
], Wa
))
2123 self
.PredictionReport
= None
2124 if "FIXED_ADDRESS" in ReportType
or "EXECUTION_ORDER" in ReportType
:
2125 self
.PredictionReport
= PredictionReport(Wa
)
2127 self
.DepexParser
= None
2128 if "DEPEX" in ReportType
:
2129 self
.DepexParser
= DepexParser(Wa
)
2131 self
.ModuleReportList
= []
2132 if MaList
is not None:
2133 self
._IsModuleBuild
= True
2135 self
.ModuleReportList
.append(ModuleReport(Ma
, ReportType
))
2137 self
._IsModuleBuild
= False
2138 for Pa
in Wa
.AutoGenObjectList
:
2139 ModuleAutoGenList
= []
2140 for ModuleKey
in Pa
.Platform
.Modules
:
2141 ModuleAutoGenList
.append(Pa
.Platform
.Modules
[ModuleKey
].M
)
2142 if GlobalData
.gFdfParser
is not None:
2143 if Pa
.Arch
in GlobalData
.gFdfParser
.Profile
.InfDict
:
2144 INFList
= GlobalData
.gFdfParser
.Profile
.InfDict
[Pa
.Arch
]
2145 for InfName
in INFList
:
2146 InfClass
= PathClass(NormPath(InfName
), Wa
.WorkspaceDir
, Pa
.Arch
)
2147 Ma
= ModuleAutoGen(Wa
, InfClass
, Pa
.BuildTarget
, Pa
.ToolChain
, Pa
.Arch
, Wa
.MetaFile
)
2150 if Ma
not in ModuleAutoGenList
:
2151 ModuleAutoGenList
.append(Ma
)
2152 for MGen
in ModuleAutoGenList
:
2153 self
.ModuleReportList
.append(ModuleReport(MGen
, ReportType
))
2158 # Generate report for the whole platform.
2160 # This function generates report for platform information.
2161 # It comprises of platform summary, global PCD, flash and
2162 # module list sections.
2164 # @param self The object pointer
2165 # @param File The file object for report
2166 # @param BuildDuration The total time to build the modules
2167 # @param AutoGenTime The total time of AutoGen Phase
2168 # @param MakeTime The total time of Make Phase
2169 # @param GenFdsTime The total time of GenFds Phase
2170 # @param ReportType The kind of report items in the final report file
2172 def GenerateReport(self
, File
, BuildDuration
, AutoGenTime
, MakeTime
, GenFdsTime
, ReportType
):
2173 FileWrite(File
, "Platform Summary")
2174 FileWrite(File
, "Platform Name: %s" % self
.PlatformName
)
2175 FileWrite(File
, "Platform DSC Path: %s" % self
.PlatformDscPath
)
2176 FileWrite(File
, "Architectures: %s" % self
.Architectures
)
2177 FileWrite(File
, "Tool Chain: %s" % self
.ToolChain
)
2178 FileWrite(File
, "Target: %s" % self
.Target
)
2179 if GlobalData
.gSkuids
:
2180 FileWrite(File
, "SKUID: %s" % " ".join(GlobalData
.gSkuids
))
2181 if GlobalData
.gDefaultStores
:
2182 FileWrite(File
, "DefaultStore: %s" % " ".join(GlobalData
.gDefaultStores
))
2183 FileWrite(File
, "Output Path: %s" % self
.OutputPath
)
2184 FileWrite(File
, "Build Environment: %s" % self
.BuildEnvironment
)
2185 FileWrite(File
, "Build Duration: %s" % BuildDuration
)
2187 FileWrite(File
, "AutoGen Duration: %s" % AutoGenTime
)
2189 FileWrite(File
, "Make Duration: %s" % MakeTime
)
2191 FileWrite(File
, "GenFds Duration: %s" % GenFdsTime
)
2192 FileWrite(File
, "Report Content: %s" % ", ".join(ReportType
))
2194 if GlobalData
.MixedPcd
:
2195 FileWrite(File
, gSectionStart
)
2196 FileWrite(File
, "The following PCDs use different access methods:")
2197 FileWrite(File
, gSectionSep
)
2198 for PcdItem
in GlobalData
.MixedPcd
:
2199 FileWrite(File
, "%s.%s" % (str(PcdItem
[1]), str(PcdItem
[0])))
2200 FileWrite(File
, gSectionEnd
)
2202 if not self
._IsModuleBuild
:
2203 if "PCD" in ReportType
:
2204 self
.PcdReport
.GenerateReport(File
, None)
2206 if "FLASH" in ReportType
:
2207 for FdReportListItem
in self
.FdReportList
:
2208 FdReportListItem
.GenerateReport(File
)
2210 for ModuleReportItem
in self
.ModuleReportList
:
2211 ModuleReportItem
.GenerateReport(File
, self
.PcdReport
, self
.PredictionReport
, self
.DepexParser
, ReportType
)
2213 if not self
._IsModuleBuild
:
2214 if "EXECUTION_ORDER" in ReportType
:
2215 self
.PredictionReport
.GenerateReport(File
, None)
2217 ## BuildReport class
2219 # This base class contain the routines to collect data and then
2220 # applies certain format to the output report
2222 class BuildReport(object):
2224 # Constructor function for class BuildReport
2226 # This constructor function generates BuildReport object a platform build.
2227 # It generates report for platform summary, flash, global PCDs and detailed
2228 # module information for modules involved in platform build.
2230 # @param self The object pointer
2231 # @param ReportFile The file name to save report file
2232 # @param ReportType The kind of report items in the final report file
2234 def __init__(self
, ReportFile
, ReportType
):
2235 self
.ReportFile
= ReportFile
2237 self
.ReportList
= []
2238 self
.ReportType
= []
2240 for ReportTypeItem
in ReportType
:
2241 if ReportTypeItem
not in self
.ReportType
:
2242 self
.ReportType
.append(ReportTypeItem
)
2244 self
.ReportType
= ["PCD", "LIBRARY", "BUILD_FLAGS", "DEPEX", "HASH", "FLASH", "FIXED_ADDRESS"]
2246 # Adds platform report to the list
2248 # This function adds a platform report to the final report list.
2250 # @param self The object pointer
2251 # @param Wa Workspace context information
2252 # @param MaList The list of modules in the platform build
2254 def AddPlatformReport(self
, Wa
, MaList
=None):
2256 self
.ReportList
.append((Wa
, MaList
))
2259 # Generates the final report.
2261 # This function generates platform build report. It invokes GenerateReport()
2262 # method for every platform report in the list.
2264 # @param self The object pointer
2265 # @param BuildDuration The total time to build the modules
2266 # @param AutoGenTime The total time of AutoGen phase
2267 # @param MakeTime The total time of Make phase
2268 # @param GenFdsTime The total time of GenFds phase
2270 def GenerateReport(self
, BuildDuration
, AutoGenTime
, MakeTime
, GenFdsTime
):
2274 for (Wa
, MaList
) in self
.ReportList
:
2275 PlatformReport(Wa
, MaList
, self
.ReportType
).GenerateReport(File
, BuildDuration
, AutoGenTime
, MakeTime
, GenFdsTime
, self
.ReportType
)
2276 Content
= FileLinesSplit(File
.getvalue(), gLineMaxLength
)
2277 SaveFileOnChange(self
.ReportFile
, Content
, True)
2278 EdkLogger
.quiet("Build report can be found at %s" % os
.path
.abspath(self
.ReportFile
))
2280 EdkLogger
.error(None, FILE_WRITE_FAILURE
, ExtraData
=self
.ReportFile
)
2282 EdkLogger
.error("BuildReport", CODE_ERROR
, "Unknown fatal error when generating build report", ExtraData
=self
.ReportFile
, RaiseError
=False)
2283 EdkLogger
.quiet("(Python %s on %s\n%s)" % (platform
.python_version(), sys
.platform
, traceback
.format_exc()))
2286 # This acts like the main() function for the script, unless it is 'import'ed into another script.
2287 if __name__
== '__main__':