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 StringIO
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
285 # Parse the binary dependency expression files.
287 # This function parses the binary dependency expression file and translate it
288 # to the instruction list.
290 # @param self The object pointer
291 # @param DepexFileName The file name of binary dependency expression file.
293 def ParseDepexFile(self
, DepexFileName
):
294 DepexFile
= open(DepexFileName
, "rb")
296 OpCode
= DepexFile
.read(1)
298 Statement
= gOpCodeList
[struct
.unpack("B", OpCode
)[0]]
299 if Statement
in ["BEFORE", "AFTER", "PUSH"]:
300 GuidValue
= "%08X-%04X-%04X-%02X%02X-%02X%02X%02X%02X%02X%02X" % \
301 struct
.unpack(PACK_PATTERN_GUID
, DepexFile
.read(16))
302 GuidString
= self
._GuidDb
.get(GuidValue
, GuidValue
)
303 Statement
= "%s %s" % (Statement
, GuidString
)
304 DepexStatement
.append(Statement
)
305 OpCode
= DepexFile
.read(1)
307 return DepexStatement
310 # Reports library information
312 # This class reports the module library subsection in the build report file.
314 class LibraryReport(object):
316 # Constructor function for class LibraryReport
318 # This constructor function generates LibraryReport object for
321 # @param self The object pointer
322 # @param M Module context information
324 def __init__(self
, M
):
325 self
.LibraryList
= []
326 if int(str(M
.AutoGenVersion
), 0) >= 0x00010005:
327 self
._EdkIIModule
= True
329 self
._EdkIIModule
= False
331 for Lib
in M
.DependentLibraryList
:
332 LibInfPath
= str(Lib
)
333 LibClassList
= Lib
.LibraryClass
[0].LibraryClass
334 LibConstructorList
= Lib
.ConstructorList
335 LibDesstructorList
= Lib
.DestructorList
336 LibDepexList
= Lib
.DepexExpression
[M
.Arch
, M
.ModuleType
]
337 for LibAutoGen
in M
.LibraryAutoGenList
:
338 if LibInfPath
== LibAutoGen
.MetaFile
.Path
:
339 LibTime
= LibAutoGen
.BuildTime
341 self
.LibraryList
.append((LibInfPath
, LibClassList
, LibConstructorList
, LibDesstructorList
, LibDepexList
, LibTime
))
344 # Generate report for module library information
346 # This function generates report for the module library.
347 # If the module is EDKII style one, the additional library class, library
348 # constructor/destructor and dependency expression may also be reported.
350 # @param self The object pointer
351 # @param File The file object for report
353 def GenerateReport(self
, File
):
354 if len(self
.LibraryList
) > 0:
355 FileWrite(File
, gSubSectionStart
)
356 FileWrite(File
, TAB_BRG_LIBRARY
)
357 FileWrite(File
, gSubSectionSep
)
358 for LibraryItem
in self
.LibraryList
:
359 LibInfPath
= LibraryItem
[0]
360 FileWrite(File
, LibInfPath
)
363 # Report library class, library constructor and destructor for
364 # EDKII style module.
366 if self
._EdkIIModule
:
367 LibClass
= LibraryItem
[1]
369 LibConstructor
= " ".join(LibraryItem
[2])
371 EdkIILibInfo
+= " C = " + LibConstructor
372 LibDestructor
= " ".join(LibraryItem
[3])
374 EdkIILibInfo
+= " D = " + LibDestructor
375 LibDepex
= " ".join(LibraryItem
[4])
377 EdkIILibInfo
+= " Depex = " + LibDepex
379 EdkIILibInfo
+= " Time = " + LibraryItem
[5]
381 FileWrite(File
, "{%s: %s}" % (LibClass
, EdkIILibInfo
))
383 FileWrite(File
, "{%s}" % LibClass
)
385 FileWrite(File
, gSubSectionEnd
)
388 # Reports dependency expression information
390 # This class reports the module dependency expression subsection in the build report file.
392 class DepexReport(object):
394 # Constructor function for class DepexReport
396 # This constructor function generates DepexReport object for
397 # a module. If the module source contains the DXS file (usually EDK
398 # style module), it uses the dependency in DXS file; otherwise,
399 # it uses the dependency expression from its own INF [Depex] section
400 # and then merges with the ones from its dependent library INF.
402 # @param self The object pointer
403 # @param M Module context information
405 def __init__(self
, M
):
407 self
._DepexFileName
= os
.path
.join(M
.BuildDir
, "OUTPUT", M
.Module
.BaseName
+ ".depex")
408 ModuleType
= M
.ModuleType
410 ModuleType
= COMPONENT_TO_MODULE_MAP_DICT
.get(M
.ComponentType
, "")
412 if ModuleType
in [SUP_MODULE_SEC
, SUP_MODULE_PEI_CORE
, SUP_MODULE_DXE_CORE
, SUP_MODULE_SMM_CORE
, SUP_MODULE_MM_CORE_STANDALONE
, SUP_MODULE_UEFI_APPLICATION
]:
415 for Source
in M
.SourceFileList
:
416 if os
.path
.splitext(Source
.Path
)[1].lower() == ".dxs":
417 Match
= gDxsDependencyPattern
.search(open(Source
.Path
).read())
419 self
.Depex
= Match
.group(1).strip()
423 self
.Depex
= M
.DepexExpressionList
.get(M
.ModuleType
, "")
424 self
.ModuleDepex
= " ".join(M
.Module
.DepexExpression
[M
.Arch
, M
.ModuleType
])
425 if not self
.ModuleDepex
:
426 self
.ModuleDepex
= "(None)"
429 for Lib
in M
.DependentLibraryList
:
430 LibDepex
= " ".join(Lib
.DepexExpression
[M
.Arch
, M
.ModuleType
]).strip()
432 LibDepexList
.append("(" + LibDepex
+ ")")
433 self
.LibraryDepex
= " AND ".join(LibDepexList
)
434 if not self
.LibraryDepex
:
435 self
.LibraryDepex
= "(None)"
439 # Generate report for module dependency expression information
441 # This function generates report for the module dependency expression.
443 # @param self The object pointer
444 # @param File The file object for report
445 # @param GlobalDepexParser The platform global Dependency expression parser object
447 def GenerateReport(self
, File
, GlobalDepexParser
):
450 FileWrite(File
, gSubSectionStart
)
451 if os
.path
.isfile(self
._DepexFileName
):
453 DepexStatements
= GlobalDepexParser
.ParseDepexFile(self
._DepexFileName
)
454 FileWrite(File
, "Final Dependency Expression (DEPEX) Instructions")
455 for DepexStatement
in DepexStatements
:
456 FileWrite(File
, " %s" % DepexStatement
)
457 FileWrite(File
, gSubSectionSep
)
459 EdkLogger
.warn(None, "Dependency expression file is corrupted", self
._DepexFileName
)
461 FileWrite(File
, "Dependency Expression (DEPEX) from %s" % self
.Source
)
463 if self
.Source
== "INF":
464 FileWrite(File
, "%s" % self
.Depex
, True)
465 FileWrite(File
, gSubSectionSep
)
466 FileWrite(File
, "From Module INF: %s" % self
.ModuleDepex
, True)
467 FileWrite(File
, "From Library INF: %s" % self
.LibraryDepex
, True)
469 FileWrite(File
, "%s" % self
.Depex
)
470 FileWrite(File
, gSubSectionEnd
)
473 # Reports dependency expression information
475 # This class reports the module build flags subsection in the build report file.
477 class BuildFlagsReport(object):
479 # Constructor function for class BuildFlagsReport
481 # This constructor function generates BuildFlagsReport object for
482 # a module. It reports the build tool chain tag and all relevant
483 # build flags to build the module.
485 # @param self The object pointer
486 # @param M Module context information
488 def __init__(self
, M
):
491 # Add build flags according to source file extension so that
492 # irrelevant ones can be filtered out.
494 for Source
in M
.SourceFileList
:
495 Ext
= os
.path
.splitext(Source
.File
)[1].lower()
496 if Ext
in [".c", ".cc", ".cpp"]:
497 BuildOptions
["CC"] = 1
498 elif Ext
in [".s", ".asm"]:
499 BuildOptions
["PP"] = 1
500 BuildOptions
["ASM"] = 1
501 elif Ext
in [".vfr"]:
502 BuildOptions
["VFRPP"] = 1
503 BuildOptions
["VFR"] = 1
504 elif Ext
in [".dxs"]:
505 BuildOptions
["APP"] = 1
506 BuildOptions
["CC"] = 1
507 elif Ext
in [".asl"]:
508 BuildOptions
["ASLPP"] = 1
509 BuildOptions
["ASL"] = 1
510 elif Ext
in [".aslc"]:
511 BuildOptions
["ASLCC"] = 1
512 BuildOptions
["ASLDLINK"] = 1
513 BuildOptions
["CC"] = 1
514 elif Ext
in [".asm16"]:
515 BuildOptions
["ASMLINK"] = 1
516 BuildOptions
["SLINK"] = 1
517 BuildOptions
["DLINK"] = 1
520 # Save module build flags.
522 self
.ToolChainTag
= M
.ToolChain
524 for Tool
in BuildOptions
:
525 self
.BuildFlags
[Tool
+ "_FLAGS"] = M
.BuildOption
.get(Tool
, {}).get("FLAGS", "")
528 # Generate report for module build flags information
530 # This function generates report for the module build flags expression.
532 # @param self The object pointer
533 # @param File The file object for report
535 def GenerateReport(self
, File
):
536 FileWrite(File
, gSubSectionStart
)
537 FileWrite(File
, "Build Flags")
538 FileWrite(File
, "Tool Chain Tag: %s" % self
.ToolChainTag
)
539 for Tool
in self
.BuildFlags
:
540 FileWrite(File
, gSubSectionSep
)
541 FileWrite(File
, "%s = %s" % (Tool
, self
.BuildFlags
[Tool
]), True)
543 FileWrite(File
, gSubSectionEnd
)
547 # Reports individual module information
549 # This class reports the module section in the build report file.
550 # It comprises of module summary, module PCD, library, dependency expression,
551 # build flags sections.
553 class ModuleReport(object):
555 # Constructor function for class ModuleReport
557 # This constructor function generates ModuleReport object for
558 # a separate module in a platform build.
560 # @param self The object pointer
561 # @param M Module context information
562 # @param ReportType The kind of report items in the final report file
564 def __init__(self
, M
, ReportType
):
565 self
.ModuleName
= M
.Module
.BaseName
566 self
.ModuleInfPath
= M
.MetaFile
.File
567 self
.FileGuid
= M
.Guid
569 self
.BuildTimeStamp
= None
573 ModuleType
= M
.ModuleType
575 ModuleType
= COMPONENT_TO_MODULE_MAP_DICT
.get(M
.ComponentType
, "")
577 # If a module complies to PI 1.1, promote Module type to "SMM_DRIVER"
579 if ModuleType
== SUP_MODULE_DXE_SMM_DRIVER
:
580 PiSpec
= M
.Module
.Specification
.get("PI_SPECIFICATION_VERSION", "0x00010000")
581 if int(PiSpec
, 0) >= 0x0001000A:
582 ModuleType
= "SMM_DRIVER"
583 self
.DriverType
= gDriverTypeMap
.get(ModuleType
, "0x2 (FREE_FORM)")
584 self
.UefiSpecVersion
= M
.Module
.Specification
.get("UEFI_SPECIFICATION_VERSION", "")
585 self
.PiSpecVersion
= M
.Module
.Specification
.get("PI_SPECIFICATION_VERSION", "")
586 self
.PciDeviceId
= M
.Module
.Defines
.get("PCI_DEVICE_ID", "")
587 self
.PciVendorId
= M
.Module
.Defines
.get("PCI_VENDOR_ID", "")
588 self
.PciClassCode
= M
.Module
.Defines
.get("PCI_CLASS_CODE", "")
589 self
.BuildTime
= M
.BuildTime
591 self
._BuildDir
= M
.BuildDir
592 self
.ModulePcdSet
= {}
593 if "PCD" in ReportType
:
595 # Collect all module used PCD set: module INF referenced directly or indirectly.
596 # It also saves module INF default values of them in case they exist.
598 for Pcd
in M
.ModulePcdList
+ M
.LibraryPcdList
:
599 self
.ModulePcdSet
.setdefault((Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
, Pcd
.Type
), (Pcd
.InfDefaultValue
, Pcd
.DefaultValue
))
601 self
.LibraryReport
= None
602 if "LIBRARY" in ReportType
:
603 self
.LibraryReport
= LibraryReport(M
)
605 self
.DepexReport
= None
606 if "DEPEX" in ReportType
:
607 self
.DepexReport
= DepexReport(M
)
609 if "BUILD_FLAGS" in ReportType
:
610 self
.BuildFlagsReport
= BuildFlagsReport(M
)
614 # Generate report for module information
616 # This function generates report for separate module expression
617 # in a platform build.
619 # @param self The object pointer
620 # @param File The file object for report
621 # @param GlobalPcdReport The platform global PCD report object
622 # @param GlobalPredictionReport The platform global Prediction report object
623 # @param GlobalDepexParser The platform global Dependency expression parser object
624 # @param ReportType The kind of report items in the final report file
626 def GenerateReport(self
, File
, GlobalPcdReport
, GlobalPredictionReport
, GlobalDepexParser
, ReportType
):
627 FileWrite(File
, gSectionStart
)
629 FwReportFileName
= os
.path
.join(self
._BuildDir
, "DEBUG", self
.ModuleName
+ ".txt")
630 if os
.path
.isfile(FwReportFileName
):
632 FileContents
= open(FwReportFileName
).read()
633 Match
= gModuleSizePattern
.search(FileContents
)
635 self
.Size
= int(Match
.group(1))
637 Match
= gTimeStampPattern
.search(FileContents
)
639 self
.BuildTimeStamp
= datetime
.fromtimestamp(int(Match
.group(1)))
641 EdkLogger
.warn(None, "Fail to read report file", FwReportFileName
)
643 if "HASH" in ReportType
:
644 OutputDir
= os
.path
.join(self
._BuildDir
, "OUTPUT")
645 DefaultEFIfile
= os
.path
.join(OutputDir
, self
.ModuleName
+ ".efi")
646 if os
.path
.isfile(DefaultEFIfile
):
647 Tempfile
= os
.path
.join(OutputDir
, self
.ModuleName
+ "_hash.tmp")
648 # rebase the efi image since its base address may not zero
649 cmd
= ["GenFw", "--rebase", str(0), "-o", Tempfile
, DefaultEFIfile
]
651 PopenObject
= subprocess
.Popen(' '.join(cmd
), stdout
=subprocess
.PIPE
, stderr
=subprocess
.PIPE
, shell
=True)
653 EdkLogger
.error("GenFw", COMMAND_FAILURE
, ExtraData
="%s: %s" % (str(X
), cmd
[0]))
654 EndOfProcedure
= threading
.Event()
655 EndOfProcedure
.clear()
656 if PopenObject
.stderr
:
657 StdErrThread
= threading
.Thread(target
=ReadMessage
, args
=(PopenObject
.stderr
, EdkLogger
.quiet
, EndOfProcedure
))
658 StdErrThread
.setName("STDERR-Redirector")
659 StdErrThread
.setDaemon(False)
661 # waiting for program exit
663 if PopenObject
.stderr
:
665 if PopenObject
.returncode
!= 0:
666 EdkLogger
.error("GenFw", COMMAND_FAILURE
, "Failed to generate firmware hash image for %s" % (DefaultEFIfile
))
667 if os
.path
.isfile(Tempfile
):
668 self
.Hash
= hashlib
.sha1()
669 buf
= open(Tempfile
, 'rb').read()
670 if self
.Hash
.update(buf
):
671 self
.Hash
= self
.Hash
.update(buf
)
672 self
.Hash
= self
.Hash
.hexdigest()
675 FileWrite(File
, "Module Summary")
676 FileWrite(File
, "Module Name: %s" % self
.ModuleName
)
677 FileWrite(File
, "Module INF Path: %s" % self
.ModuleInfPath
)
678 FileWrite(File
, "File GUID: %s" % self
.FileGuid
)
680 FileWrite(File
, "Size: 0x%X (%.2fK)" % (self
.Size
, self
.Size
/ 1024.0))
682 FileWrite(File
, "SHA1 HASH: %s *%s" % (self
.Hash
, self
.ModuleName
+ ".efi"))
683 if self
.BuildTimeStamp
:
684 FileWrite(File
, "Build Time Stamp: %s" % self
.BuildTimeStamp
)
686 FileWrite(File
, "Module Build Time: %s" % self
.BuildTime
)
688 FileWrite(File
, "Driver Type: %s" % self
.DriverType
)
689 if self
.UefiSpecVersion
:
690 FileWrite(File
, "UEFI Spec Version: %s" % self
.UefiSpecVersion
)
691 if self
.PiSpecVersion
:
692 FileWrite(File
, "PI Spec Version: %s" % self
.PiSpecVersion
)
694 FileWrite(File
, "PCI Device ID: %s" % self
.PciDeviceId
)
696 FileWrite(File
, "PCI Vendor ID: %s" % self
.PciVendorId
)
697 if self
.PciClassCode
:
698 FileWrite(File
, "PCI Class Code: %s" % self
.PciClassCode
)
700 FileWrite(File
, gSectionSep
)
702 if "PCD" in ReportType
:
703 GlobalPcdReport
.GenerateReport(File
, self
.ModulePcdSet
)
705 if "LIBRARY" in ReportType
:
706 self
.LibraryReport
.GenerateReport(File
)
708 if "DEPEX" in ReportType
:
709 self
.DepexReport
.GenerateReport(File
, GlobalDepexParser
)
711 if "BUILD_FLAGS" in ReportType
:
712 self
.BuildFlagsReport
.GenerateReport(File
)
714 if "FIXED_ADDRESS" in ReportType
and self
.FileGuid
:
715 GlobalPredictionReport
.GenerateReport(File
, self
.FileGuid
)
717 FileWrite(File
, gSectionEnd
)
719 def ReadMessage(From
, To
, ExitFlag
):
721 # read one line a time
722 Line
= From
.readline()
723 # empty string means "end"
724 if Line
is not None and Line
!= "":
732 # Reports platform and module PCD information
734 # This class reports the platform PCD section and module PCD subsection
735 # in the build report file.
737 class PcdReport(object):
739 # Constructor function for class PcdReport
741 # This constructor function generates PcdReport object a platform build.
742 # It collects the whole PCD database from platform DSC files, platform
743 # flash description file and package DEC files.
745 # @param self The object pointer
746 # @param Wa Workspace context information
748 def __init__(self
, Wa
):
751 self
.ConditionalPcds
= {}
755 self
.FdfPcdSet
= Wa
.FdfProfile
.PcdDict
759 self
.DefaultStoreSingle
= True
760 self
.SkuSingle
= True
761 if GlobalData
.gDefaultStores
and len(GlobalData
.gDefaultStores
) > 1:
762 self
.DefaultStoreSingle
= False
763 if GlobalData
.gSkuids
and len(GlobalData
.gSkuids
) > 1:
764 self
.SkuSingle
= False
766 self
.ModulePcdOverride
= {}
767 for Pa
in Wa
.AutoGenObjectList
:
770 # Collect all platform referenced PCDs and grouped them by PCD token space
773 for Pcd
in Pa
.AllPcdList
:
774 PcdList
= self
.AllPcds
.setdefault(Pcd
.TokenSpaceGuidCName
, {}).setdefault(Pcd
.Type
, [])
775 if Pcd
not in PcdList
:
777 if len(Pcd
.TokenCName
) > self
.MaxLen
:
778 self
.MaxLen
= len(Pcd
.TokenCName
)
780 # Collect the PCD defined in DSC/FDF file, but not used in module
782 UnusedPcdFullList
= []
783 for item
in Pa
.Platform
.Pcds
:
784 Pcd
= Pa
.Platform
.Pcds
[item
]
786 # check the Pcd in FDF file, whether it is used in module first
787 for T
in PCD_TYPE_LIST
:
788 PcdList
= self
.AllPcds
.setdefault(Pcd
.TokenSpaceGuidCName
, {}).setdefault(T
, [])
794 for package
in Pa
.PackageList
:
795 for T
in PCD_TYPE_LIST
:
796 if (Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
, T
) in package
.Pcds
:
799 if not Pcd
.DatumType
:
800 Pcd
.DatumType
= package
.Pcds
[(Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
, T
)].DatumType
804 if not Pcd
.DatumType
:
806 # Try to remove Hii and Vpd suffix
807 if PcdType
.startswith(TAB_PCDS_DYNAMIC_EX
):
808 PcdType
= TAB_PCDS_DYNAMIC_EX
809 elif PcdType
.startswith(TAB_PCDS_DYNAMIC
):
810 PcdType
= TAB_PCDS_DYNAMIC
811 for package
in Pa
.PackageList
:
812 if (Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
, PcdType
) in package
.Pcds
:
813 Pcd
.DatumType
= package
.Pcds
[(Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
, PcdType
)].DatumType
816 PcdList
= self
.AllPcds
.setdefault(Pcd
.TokenSpaceGuidCName
, {}).setdefault(Pcd
.Type
, [])
817 if Pcd
not in PcdList
and Pcd
not in UnusedPcdFullList
:
818 UnusedPcdFullList
.append(Pcd
)
819 if len(Pcd
.TokenCName
) > self
.MaxLen
:
820 self
.MaxLen
= len(Pcd
.TokenCName
)
822 if GlobalData
.gConditionalPcds
:
823 for PcdItem
in GlobalData
.gConditionalPcds
:
825 (TokenSpaceGuidCName
, TokenCName
) = PcdItem
.split('.')
826 if (TokenCName
, TokenSpaceGuidCName
) in Pa
.Platform
.Pcds
:
827 Pcd
= Pa
.Platform
.Pcds
[(TokenCName
, TokenSpaceGuidCName
)]
828 PcdList
= self
.ConditionalPcds
.setdefault(Pcd
.TokenSpaceGuidCName
, {}).setdefault(Pcd
.Type
, [])
829 if Pcd
not in PcdList
:
833 if UnusedPcdFullList
:
834 for Pcd
in UnusedPcdFullList
:
835 if Pcd
.TokenSpaceGuidCName
+ '.' + Pcd
.TokenCName
in GlobalData
.gConditionalPcds
:
837 UnusedPcdList
.append(Pcd
)
839 for Pcd
in UnusedPcdList
:
840 PcdList
= self
.UnusedPcds
.setdefault(Pcd
.TokenSpaceGuidCName
, {}).setdefault(Pcd
.Type
, [])
841 if Pcd
not in PcdList
:
844 for Module
in Pa
.Platform
.Modules
.values():
846 # Collect module override PCDs
848 for ModulePcd
in Module
.M
.ModulePcdList
+ Module
.M
.LibraryPcdList
:
849 TokenCName
= ModulePcd
.TokenCName
850 TokenSpaceGuid
= ModulePcd
.TokenSpaceGuidCName
851 ModuleDefault
= ModulePcd
.DefaultValue
852 ModulePath
= os
.path
.basename(Module
.M
.MetaFile
.File
)
853 self
.ModulePcdOverride
.setdefault((TokenCName
, TokenSpaceGuid
), {})[ModulePath
] = ModuleDefault
857 # Collect PCD DEC default value.
859 self
.DecPcdDefault
= {}
861 for Pa
in Wa
.AutoGenObjectList
:
862 for Package
in Pa
.PackageList
:
863 Guids
= Package
.Guids
864 self
._GuidDict
.update(Guids
)
865 for (TokenCName
, TokenSpaceGuidCName
, DecType
) in Package
.Pcds
:
866 DecDefaultValue
= Package
.Pcds
[TokenCName
, TokenSpaceGuidCName
, DecType
].DefaultValue
867 self
.DecPcdDefault
.setdefault((TokenCName
, TokenSpaceGuidCName
, DecType
), DecDefaultValue
)
869 # Collect PCDs defined in DSC common section
871 self
.DscPcdDefault
= {}
872 for Pa
in Wa
.AutoGenObjectList
:
873 for (TokenCName
, TokenSpaceGuidCName
) in Pa
.Platform
.Pcds
:
874 DscDefaultValue
= Pa
.Platform
.Pcds
[(TokenCName
, TokenSpaceGuidCName
)].DscDefaultValue
876 self
.DscPcdDefault
[(TokenCName
, TokenSpaceGuidCName
)] = DscDefaultValue
878 def GenerateReport(self
, File
, ModulePcdSet
):
880 if self
.ConditionalPcds
:
881 self
.GenerateReportDetail(File
, ModulePcdSet
, 1)
883 self
.GenerateReportDetail(File
, ModulePcdSet
, 2)
884 self
.GenerateReportDetail(File
, ModulePcdSet
)
887 # Generate report for PCD information
889 # This function generates report for separate module expression
890 # in a platform build.
892 # @param self The object pointer
893 # @param File The file object for report
894 # @param ModulePcdSet Set of all PCDs referenced by module or None for
895 # platform PCD report
896 # @param ReportySubType 0 means platform/module PCD report, 1 means Conditional
897 # directives section report, 2 means Unused Pcds section report
898 # @param DscOverridePcds Module DSC override PCDs set
900 def GenerateReportDetail(self
, File
, ModulePcdSet
, ReportSubType
= 0):
901 PcdDict
= self
.AllPcds
902 if ReportSubType
== 1:
903 PcdDict
= self
.ConditionalPcds
904 elif ReportSubType
== 2:
905 PcdDict
= self
.UnusedPcds
908 FileWrite(File
, gSectionStart
)
909 if ReportSubType
== 1:
910 FileWrite(File
, "Conditional Directives used by the build system")
911 elif ReportSubType
== 2:
912 FileWrite(File
, "PCDs not used by modules or in conditional directives")
914 FileWrite(File
, "Platform Configuration Database Report")
916 FileWrite(File
, " *B - PCD override in the build option")
917 FileWrite(File
, " *P - Platform scoped PCD override in DSC file")
918 FileWrite(File
, " *F - Platform scoped PCD override in FDF file")
919 if not ReportSubType
:
920 FileWrite(File
, " *M - Module scoped PCD override")
921 FileWrite(File
, gSectionSep
)
923 if not ReportSubType
and ModulePcdSet
:
925 # For module PCD sub-section
927 FileWrite(File
, gSubSectionStart
)
928 FileWrite(File
, TAB_BRG_PCD
)
929 FileWrite(File
, gSubSectionSep
)
933 # Group PCD by their token space GUID C Name
936 for Type
in PcdDict
[Key
]:
938 # Group PCD by their usage type
940 TypeName
, DecType
= gPcdTypeMap
.get(Type
, ("", Type
))
941 for Pcd
in PcdDict
[Key
][Type
]:
942 PcdTokenCName
= Pcd
.TokenCName
944 if GlobalData
.MixedPcd
:
945 for PcdKey
in GlobalData
.MixedPcd
:
946 if (Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
) in GlobalData
.MixedPcd
[PcdKey
]:
947 PcdTokenCName
= PcdKey
[0]
949 if MixedPcdFlag
and not ModulePcdSet
:
952 # Get PCD default value and their override relationship
954 DecDefaultValue
= self
.DecPcdDefault
.get((Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
, DecType
))
955 DscDefaultValue
= self
.DscPcdDefault
.get((Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
))
956 DscDefaultValBak
= DscDefaultValue
957 DscDefaultValue
= self
.FdfPcdSet
.get((Pcd
.TokenCName
, Key
), DscDefaultValue
)
958 if DscDefaultValue
!= DscDefaultValBak
:
960 DscDefaultValue
= ValueExpressionEx(DscDefaultValue
, Pcd
.DatumType
, self
._GuidDict
)(True)
961 except BadExpression
, DscDefaultValue
:
962 EdkLogger
.error('BuildReport', FORMAT_INVALID
, "PCD Value: %s, Type: %s" %(DscDefaultValue
, Pcd
.DatumType
))
964 InfDefaultValue
= None
966 PcdValue
= DecDefaultValue
968 PcdValue
= DscDefaultValue
969 if ModulePcdSet
is not None:
970 if (Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
, Type
) not in ModulePcdSet
:
972 InfDefault
, PcdValue
= ModulePcdSet
[Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
, Type
]
973 Pcd
.DefaultValue
= PcdValue
977 BuildOptionMatch
= False
978 if GlobalData
.BuildOptionPcd
:
979 for pcd
in GlobalData
.BuildOptionPcd
:
980 if (Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
) == (pcd
[0], pcd
[1]):
984 Pcd
.DefaultValue
= PcdValue
985 BuildOptionMatch
= True
989 if ModulePcdSet
is None:
995 if Pcd
.DatumType
in TAB_PCD_CLEAN_NUMERIC_TYPES
:
996 PcdValueNumber
= int(PcdValue
.strip(), 0)
997 if DecDefaultValue
is None:
1000 DecDefaultValueNumber
= int(DecDefaultValue
.strip(), 0)
1001 DecMatch
= (DecDefaultValueNumber
== PcdValueNumber
)
1003 if InfDefaultValue
is None:
1006 InfDefaultValueNumber
= int(InfDefaultValue
.strip(), 0)
1007 InfMatch
= (InfDefaultValueNumber
== PcdValueNumber
)
1009 if DscDefaultValue
is None:
1012 DscDefaultValueNumber
= int(DscDefaultValue
.strip(), 0)
1013 DscMatch
= (DscDefaultValueNumber
== PcdValueNumber
)
1015 if DecDefaultValue
is None:
1018 DecMatch
= (DecDefaultValue
.strip() == PcdValue
.strip())
1020 if InfDefaultValue
is None:
1023 InfMatch
= (InfDefaultValue
.strip() == PcdValue
.strip())
1025 if DscDefaultValue
is None:
1028 DscMatch
= (DscDefaultValue
.strip() == PcdValue
.strip())
1031 if GlobalData
.gStructurePcd
and (self
.Arch
in GlobalData
.gStructurePcd
) and ((Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
) in GlobalData
.gStructurePcd
[self
.Arch
]):
1033 if TypeName
in ('DYNVPD', 'DEXVPD'):
1034 SkuInfoList
= Pcd
.SkuInfoList
1035 Pcd
= GlobalData
.gStructurePcd
[self
.Arch
][(Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
)]
1036 Pcd
.DatumType
= Pcd
.StructName
1037 if TypeName
in ('DYNVPD', 'DEXVPD'):
1038 Pcd
.SkuInfoList
= SkuInfoList
1039 if Pcd
.PcdFieldValueFromComm
:
1040 BuildOptionMatch
= True
1042 elif Pcd
.SkuOverrideValues
:
1044 if not Pcd
.SkuInfoList
:
1045 OverrideValues
= Pcd
.SkuOverrideValues
1047 Keys
= OverrideValues
.keys()
1048 Data
= OverrideValues
[Keys
[0]]
1049 Struct
= Data
.values()[0]
1050 DscOverride
= self
.ParseStruct(Struct
)
1052 SkuList
= sorted(Pcd
.SkuInfoList
.keys())
1054 SkuInfo
= Pcd
.SkuInfoList
[Sku
]
1055 if TypeName
in ('DYNHII', 'DEXHII'):
1056 if SkuInfo
.DefaultStoreDict
:
1057 DefaultStoreList
= sorted(SkuInfo
.DefaultStoreDict
.keys())
1058 for DefaultStore
in DefaultStoreList
:
1059 OverrideValues
= Pcd
.SkuOverrideValues
[Sku
]
1060 DscOverride
= self
.ParseStruct(OverrideValues
[DefaultStore
])
1064 OverrideValues
= Pcd
.SkuOverrideValues
[Sku
]
1066 Keys
= OverrideValues
.keys()
1067 OverrideFieldStruct
= self
.OverrideFieldValue(Pcd
, OverrideValues
[Keys
[0]])
1068 DscOverride
= self
.ParseStruct(OverrideFieldStruct
)
1076 # Report PCD item according to their override relationship
1078 if DecMatch
and InfMatch
:
1079 self
.PrintPcdValue(File
, Pcd
, PcdTokenCName
, TypeName
, IsStructure
, DscMatch
, DscDefaultValBak
, InfMatch
, InfDefaultValue
, DecMatch
, DecDefaultValue
, ' ')
1080 elif BuildOptionMatch
:
1081 self
.PrintPcdValue(File
, Pcd
, PcdTokenCName
, TypeName
, IsStructure
, DscMatch
, DscDefaultValBak
, InfMatch
, InfDefaultValue
, DecMatch
, DecDefaultValue
, '*B')
1084 if (Pcd
.TokenCName
, Key
) in self
.FdfPcdSet
:
1085 self
.PrintPcdValue(File
, Pcd
, PcdTokenCName
, TypeName
, IsStructure
, DscMatch
, DscDefaultValBak
, InfMatch
, InfDefaultValue
, DecMatch
, DecDefaultValue
, '*F')
1087 self
.PrintPcdValue(File
, Pcd
, PcdTokenCName
, TypeName
, IsStructure
, DscMatch
, DscDefaultValBak
, InfMatch
, InfDefaultValue
, DecMatch
, DecDefaultValue
, '*P')
1089 self
.PrintPcdValue(File
, Pcd
, PcdTokenCName
, TypeName
, IsStructure
, DscMatch
, DscDefaultValBak
, InfMatch
, InfDefaultValue
, DecMatch
, DecDefaultValue
, '*M')
1091 if ModulePcdSet
is None:
1094 if not TypeName
in ('PATCH', 'FLAG', 'FIXED'):
1096 if not BuildOptionMatch
:
1097 ModuleOverride
= self
.ModulePcdOverride
.get((Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
), {})
1098 for ModulePath
in ModuleOverride
:
1099 ModuleDefault
= ModuleOverride
[ModulePath
]
1100 if Pcd
.DatumType
in TAB_PCD_CLEAN_NUMERIC_TYPES
:
1101 ModulePcdDefaultValueNumber
= int(ModuleDefault
.strip(), 0)
1102 Match
= (ModulePcdDefaultValueNumber
== PcdValueNumber
)
1104 Match
= (ModuleDefault
.strip() == PcdValue
.strip())
1107 IsByteArray
, ArrayList
= ByteArrayForamt(ModuleDefault
.strip())
1109 FileWrite(File
, ' *M %-*s = %s' % (self
.MaxLen
+ 19, ModulePath
, '{'))
1110 for Array
in ArrayList
:
1111 FileWrite(File
, '%s' % (Array
))
1113 FileWrite(File
, ' *M %-*s = %s' % (self
.MaxLen
+ 19, ModulePath
, ModuleDefault
.strip()))
1115 if ModulePcdSet
is None:
1116 FileWrite(File
, gSectionEnd
)
1118 if not ReportSubType
and ModulePcdSet
:
1119 FileWrite(File
, gSubSectionEnd
)
1121 def ParseStruct(self
, struct
):
1122 HasDscOverride
= False
1124 for _
, Values
in struct
.items():
1125 if Values
[1] and Values
[1].endswith('.dsc'):
1126 HasDscOverride
= True
1128 return HasDscOverride
1130 def PrintPcdDefault(self
, File
, Pcd
, IsStructure
, DscMatch
, DscDefaultValue
, InfMatch
, InfDefaultValue
, DecMatch
, DecDefaultValue
):
1131 if not DscMatch
and DscDefaultValue
is not None:
1132 Value
= DscDefaultValue
.strip()
1133 IsByteArray
, ArrayList
= ByteArrayForamt(Value
)
1135 FileWrite(File
, ' %*s = %s' % (self
.MaxLen
+ 19, 'DSC DEFAULT', "{"))
1136 for Array
in ArrayList
:
1137 FileWrite(File
, '%s' % (Array
))
1139 FileWrite(File
, ' %*s = %s' % (self
.MaxLen
+ 19, 'DSC DEFAULT', Value
))
1140 if not InfMatch
and InfDefaultValue
is not None:
1141 Value
= InfDefaultValue
.strip()
1142 IsByteArray
, ArrayList
= ByteArrayForamt(Value
)
1144 FileWrite(File
, ' %*s = %s' % (self
.MaxLen
+ 19, 'INF DEFAULT', "{"))
1145 for Array
in ArrayList
:
1146 FileWrite(File
, '%s' % (Array
))
1148 FileWrite(File
, ' %*s = %s' % (self
.MaxLen
+ 19, 'INF DEFAULT', Value
))
1150 if not DecMatch
and DecDefaultValue
is not None:
1151 Value
= DecDefaultValue
.strip()
1152 IsByteArray
, ArrayList
= ByteArrayForamt(Value
)
1154 FileWrite(File
, ' %*s = %s' % (self
.MaxLen
+ 19, 'DEC DEFAULT', "{"))
1155 for Array
in ArrayList
:
1156 FileWrite(File
, '%s' % (Array
))
1158 FileWrite(File
, ' %*s = %s' % (self
.MaxLen
+ 19, 'DEC DEFAULT', Value
))
1160 self
.PrintStructureInfo(File
, Pcd
.DefaultValues
)
1161 if DecMatch
and IsStructure
:
1162 self
.PrintStructureInfo(File
, Pcd
.DefaultValues
)
1164 def PrintPcdValue(self
, File
, Pcd
, PcdTokenCName
, TypeName
, IsStructure
, DscMatch
, DscDefaultValue
, InfMatch
, InfDefaultValue
, DecMatch
, DecDefaultValue
, Flag
= ' '):
1165 if not Pcd
.SkuInfoList
:
1166 Value
= Pcd
.DefaultValue
1167 IsByteArray
, ArrayList
= ByteArrayForamt(Value
)
1169 FileWrite(File
, ' %-*s : %6s %10s = %s' % (self
.MaxLen
, Flag
+ ' ' + PcdTokenCName
, TypeName
, '(' + Pcd
.DatumType
+ ')', '{'))
1170 for Array
in ArrayList
:
1171 FileWrite(File
, '%s' % (Array
))
1173 FileWrite(File
, ' %-*s : %6s %10s = %s' % (self
.MaxLen
, Flag
+ ' ' + PcdTokenCName
, TypeName
, '(' + Pcd
.DatumType
+ ')', Value
))
1175 OverrideValues
= Pcd
.SkuOverrideValues
1177 Keys
= OverrideValues
.keys()
1178 Data
= OverrideValues
[Keys
[0]]
1179 Struct
= Data
.values()[0]
1180 OverrideFieldStruct
= self
.OverrideFieldValue(Pcd
, Struct
)
1181 self
.PrintStructureInfo(File
, OverrideFieldStruct
)
1182 self
.PrintPcdDefault(File
, Pcd
, IsStructure
, DscMatch
, DscDefaultValue
, InfMatch
, InfDefaultValue
, DecMatch
, DecDefaultValue
)
1185 SkuList
= sorted(Pcd
.SkuInfoList
.keys())
1187 SkuInfo
= Pcd
.SkuInfoList
[Sku
]
1188 SkuIdName
= SkuInfo
.SkuIdName
1189 if TypeName
in ('DYNHII', 'DEXHII'):
1190 if SkuInfo
.DefaultStoreDict
:
1191 DefaultStoreList
= sorted(SkuInfo
.DefaultStoreDict
.keys())
1192 for DefaultStore
in DefaultStoreList
:
1193 Value
= SkuInfo
.DefaultStoreDict
[DefaultStore
]
1194 IsByteArray
, ArrayList
= ByteArrayForamt(Value
)
1198 if self
.DefaultStoreSingle
and self
.SkuSingle
:
1199 FileWrite(File
, ' %-*s : %6s %10s = %s' % (self
.MaxLen
, Flag
+ ' ' + PcdTokenCName
, TypeName
, '(' + Pcd
.DatumType
+ ')', '{'))
1200 elif self
.DefaultStoreSingle
and not self
.SkuSingle
:
1201 FileWrite(File
, ' %-*s : %6s %10s %10s = %s' % (self
.MaxLen
, Flag
+ ' ' + PcdTokenCName
, TypeName
, '(' + Pcd
.DatumType
+ ')', '(' + SkuIdName
+ ')', '{'))
1202 elif not self
.DefaultStoreSingle
and self
.SkuSingle
:
1203 FileWrite(File
, ' %-*s : %6s %10s %10s = %s' % (self
.MaxLen
, Flag
+ ' ' + PcdTokenCName
, TypeName
, '(' + Pcd
.DatumType
+ ')', '(' + DefaultStore
+ ')', '{'))
1205 FileWrite(File
, ' %-*s : %6s %10s %10s %10s = %s' % (self
.MaxLen
, Flag
+ ' ' + PcdTokenCName
, TypeName
, '(' + Pcd
.DatumType
+ ')', '(' + SkuIdName
+ ')', '(' + DefaultStore
+ ')', '{'))
1206 for Array
in ArrayList
:
1207 FileWrite(File
, '%s' % (Array
))
1209 if self
.DefaultStoreSingle
and self
.SkuSingle
:
1210 FileWrite(File
, ' %-*s : %6s %10s = %s' % (self
.MaxLen
, Flag
+ ' ' + PcdTokenCName
, TypeName
, '(' + Pcd
.DatumType
+ ')', Value
))
1211 elif self
.DefaultStoreSingle
and not self
.SkuSingle
:
1212 FileWrite(File
, ' %-*s : %6s %10s %10s = %s' % (self
.MaxLen
, Flag
+ ' ' + PcdTokenCName
, TypeName
, '(' + Pcd
.DatumType
+ ')', '(' + SkuIdName
+ ')', Value
))
1213 elif not self
.DefaultStoreSingle
and self
.SkuSingle
:
1214 FileWrite(File
, ' %-*s : %6s %10s %10s = %s' % (self
.MaxLen
, Flag
+ ' ' + PcdTokenCName
, TypeName
, '(' + Pcd
.DatumType
+ ')', '(' + DefaultStore
+ ')', Value
))
1216 FileWrite(File
, ' %-*s : %6s %10s %10s %10s = %s' % (self
.MaxLen
, Flag
+ ' ' + PcdTokenCName
, TypeName
, '(' + Pcd
.DatumType
+ ')', '(' + SkuIdName
+ ')', '(' + DefaultStore
+ ')', Value
))
1219 if self
.DefaultStoreSingle
and self
.SkuSingle
:
1220 FileWrite(File
, ' %-*s : %6s %10s = %s' % (self
.MaxLen
, ' ', TypeName
, '(' + Pcd
.DatumType
+ ')', '{'))
1221 elif self
.DefaultStoreSingle
and not self
.SkuSingle
:
1222 FileWrite(File
, ' %-*s : %6s %10s %10s = %s' % (self
.MaxLen
, ' ', TypeName
, '(' + Pcd
.DatumType
+ ')', '(' + SkuIdName
+ ')', '{'))
1223 elif not self
.DefaultStoreSingle
and self
.SkuSingle
:
1224 FileWrite(File
, ' %-*s : %6s %10s %10s = %s' % (self
.MaxLen
, ' ', TypeName
, '(' + Pcd
.DatumType
+ ')', '(' + DefaultStore
+ ')', '{'))
1226 FileWrite(File
, ' %-*s : %6s %10s %10s %10s = %s' % (self
.MaxLen
, ' ', TypeName
, '(' + Pcd
.DatumType
+ ')', '(' + SkuIdName
+ ')', '(' + DefaultStore
+ ')', '{'))
1227 for Array
in ArrayList
:
1228 FileWrite(File
, '%s' % (Array
))
1230 if self
.DefaultStoreSingle
and self
.SkuSingle
:
1231 FileWrite(File
, ' %-*s : %6s %10s = %s' % (self
.MaxLen
, ' ', TypeName
, '(' + Pcd
.DatumType
+ ')', Value
))
1232 elif self
.DefaultStoreSingle
and not self
.SkuSingle
:
1233 FileWrite(File
, ' %-*s : %6s %10s %10s = %s' % (self
.MaxLen
, ' ', TypeName
, '(' + Pcd
.DatumType
+ ')', '(' + SkuIdName
+ ')', Value
))
1234 elif not self
.DefaultStoreSingle
and self
.SkuSingle
:
1235 FileWrite(File
, ' %-*s : %6s %10s %10s = %s' % (self
.MaxLen
, ' ', TypeName
, '(' + Pcd
.DatumType
+ ')', '(' + DefaultStore
+ ')', Value
))
1237 FileWrite(File
, ' %-*s : %6s %10s %10s %10s = %s' % (self
.MaxLen
, ' ', TypeName
, '(' + Pcd
.DatumType
+ ')', '(' + SkuIdName
+ ')', '(' + DefaultStore
+ ')', Value
))
1238 FileWrite(File
, '%*s: %s: %s' % (self
.MaxLen
+ 4, SkuInfo
.VariableGuid
, SkuInfo
.VariableName
, SkuInfo
.VariableOffset
))
1240 OverrideValues
= Pcd
.SkuOverrideValues
[Sku
]
1241 OverrideFieldStruct
= self
.OverrideFieldValue(Pcd
, OverrideValues
[DefaultStore
])
1242 self
.PrintStructureInfo(File
, OverrideFieldStruct
)
1243 self
.PrintPcdDefault(File
, Pcd
, IsStructure
, DscMatch
, DscDefaultValue
, InfMatch
, InfDefaultValue
, DecMatch
, DecDefaultValue
)
1245 Value
= SkuInfo
.DefaultValue
1246 IsByteArray
, ArrayList
= ByteArrayForamt(Value
)
1251 FileWrite(File
, ' %-*s : %6s %10s = %s' % (self
.MaxLen
, Flag
+ ' ' + PcdTokenCName
, TypeName
, '(' + Pcd
.DatumType
+ ')', "{"))
1253 FileWrite(File
, ' %-*s : %6s %10s %10s = %s' % (self
.MaxLen
, Flag
+ ' ' + PcdTokenCName
, TypeName
, '(' + Pcd
.DatumType
+ ')', '(' + SkuIdName
+ ')', "{"))
1254 for Array
in ArrayList
:
1255 FileWrite(File
, '%s' % (Array
))
1258 FileWrite(File
, ' %-*s : %6s %10s = %s' % (self
.MaxLen
, Flag
+ ' ' + PcdTokenCName
, TypeName
, '(' + Pcd
.DatumType
+ ')', Value
))
1260 FileWrite(File
, ' %-*s : %6s %10s %10s = %s' % (self
.MaxLen
, Flag
+ ' ' + PcdTokenCName
, TypeName
, '(' + Pcd
.DatumType
+ ')', '(' + SkuIdName
+ ')', Value
))
1264 FileWrite(File
, ' %-*s : %6s %10s = %s' % (self
.MaxLen
, ' ' , TypeName
, '(' + Pcd
.DatumType
+ ')', "{"))
1266 FileWrite(File
, ' %-*s : %6s %10s %10s = %s' % (self
.MaxLen
, ' ' , TypeName
, '(' + Pcd
.DatumType
+ ')', '(' + SkuIdName
+ ')', "{"))
1267 for Array
in ArrayList
:
1268 FileWrite(File
, '%s' % (Array
))
1271 FileWrite(File
, ' %-*s : %6s %10s = %s' % (self
.MaxLen
, ' ' , TypeName
, '(' + Pcd
.DatumType
+ ')', Value
))
1273 FileWrite(File
, ' %-*s : %6s %10s %10s = %s' % (self
.MaxLen
, ' ' , TypeName
, '(' + Pcd
.DatumType
+ ')', '(' + SkuIdName
+ ')', Value
))
1274 if TypeName
in ('DYNVPD', 'DEXVPD'):
1275 FileWrite(File
, '%*s' % (self
.MaxLen
+ 4, SkuInfo
.VpdOffset
))
1277 OverrideValues
= Pcd
.SkuOverrideValues
[Sku
]
1279 Keys
= OverrideValues
.keys()
1280 OverrideFieldStruct
= self
.OverrideFieldValue(Pcd
, OverrideValues
[Keys
[0]])
1281 self
.PrintStructureInfo(File
, OverrideFieldStruct
)
1282 self
.PrintPcdDefault(File
, Pcd
, IsStructure
, DscMatch
, DscDefaultValue
, InfMatch
, InfDefaultValue
, DecMatch
, DecDefaultValue
)
1284 def OverrideFieldValue(self
, Pcd
, OverrideStruct
):
1285 OverrideFieldStruct
= collections
.OrderedDict()
1287 for Key
, Values
in OverrideStruct
.items():
1288 if Values
[1] and Values
[1].endswith('.dsc'):
1289 OverrideFieldStruct
[Key
] = Values
1290 if Pcd
.PcdFieldValueFromComm
:
1291 for Key
, Values
in Pcd
.PcdFieldValueFromComm
.items():
1292 OverrideFieldStruct
[Key
] = Values
1293 return OverrideFieldStruct
1295 def PrintStructureInfo(self
, File
, Struct
):
1296 for Key
, Value
in Struct
.items():
1297 if Value
[1] and 'build command options' in Value
[1]:
1298 FileWrite(File
, ' *B %-*s = %s' % (self
.MaxLen
+ 4, '.' + Key
, Value
[0]))
1300 FileWrite(File
, ' %-*s = %s' % (self
.MaxLen
+ 4, '.' + Key
, Value
[0]))
1302 def StrtoHex(self
, value
):
1304 value
= hex(int(value
))
1307 if value
.startswith("L\"") and value
.endswith("\""):
1309 for ch
in value
[2:-1]:
1310 valuelist
.append(hex(ord(ch
)))
1311 valuelist
.append('0x00')
1313 elif value
.startswith("\"") and value
.endswith("\""):
1314 return hex(ord(value
[1:-1]))
1315 elif value
.startswith("{") and value
.endswith("}"):
1317 if ',' not in value
:
1319 for ch
in value
[1:-1].split(','):
1321 if ch
.startswith('0x') or ch
.startswith('0X'):
1322 valuelist
.append(ch
)
1325 valuelist
.append(hex(int(ch
.strip())))
1333 # Reports platform and module Prediction information
1335 # This class reports the platform execution order prediction section and
1336 # module load fixed address prediction subsection in the build report file.
1338 class PredictionReport(object):
1340 # Constructor function for class PredictionReport
1342 # This constructor function generates PredictionReport object for the platform.
1344 # @param self: The object pointer
1345 # @param Wa Workspace context information
1347 def __init__(self
, Wa
):
1348 self
._MapFileName
= os
.path
.join(Wa
.BuildDir
, Wa
.Name
+ ".map")
1349 self
._MapFileParsed
= False
1350 self
._EotToolInvoked
= False
1351 self
._FvDir
= Wa
.FvDir
1352 self
._EotDir
= Wa
.BuildDir
1353 self
._FfsEntryPoint
= {}
1355 self
._SourceList
= []
1356 self
.FixedMapDict
= {}
1361 # Collect all platform reference source files and GUID C Name
1363 for Pa
in Wa
.AutoGenObjectList
:
1364 for Module
in Pa
.LibraryAutoGenList
+ Pa
.ModuleAutoGenList
:
1366 # BASE typed modules are EFI agnostic, so we need not scan
1367 # their source code to find PPI/Protocol produce or consume
1370 if Module
.ModuleType
== SUP_MODULE_BASE
:
1373 # Add module referenced source files
1375 self
._SourceList
.append(str(Module
))
1377 for Source
in Module
.SourceFileList
:
1378 if os
.path
.splitext(str(Source
))[1].lower() == ".c":
1379 self
._SourceList
.append(" " + str(Source
))
1380 FindIncludeFiles(Source
.Path
, Module
.IncludePathList
, IncludeList
)
1381 for IncludeFile
in IncludeList
.values():
1382 self
._SourceList
.append(" " + IncludeFile
)
1384 for Guid
in Module
.PpiList
:
1385 self
._GuidMap
[Guid
] = GuidStructureStringToGuidString(Module
.PpiList
[Guid
])
1386 for Guid
in Module
.ProtocolList
:
1387 self
._GuidMap
[Guid
] = GuidStructureStringToGuidString(Module
.ProtocolList
[Guid
])
1388 for Guid
in Module
.GuidList
:
1389 self
._GuidMap
[Guid
] = GuidStructureStringToGuidString(Module
.GuidList
[Guid
])
1391 if Module
.Guid
and not Module
.IsLibrary
:
1392 EntryPoint
= " ".join(Module
.Module
.ModuleEntryPointList
)
1393 if int(str(Module
.AutoGenVersion
), 0) >= 0x00010005:
1394 RealEntryPoint
= "_ModuleEntryPoint"
1396 RealEntryPoint
= EntryPoint
1397 if EntryPoint
== "_ModuleEntryPoint":
1398 CCFlags
= Module
.BuildOption
.get("CC", {}).get("FLAGS", "")
1399 Match
= gGlueLibEntryPoint
.search(CCFlags
)
1401 EntryPoint
= Match
.group(1)
1403 self
._FfsEntryPoint
[Module
.Guid
.upper()] = (EntryPoint
, RealEntryPoint
)
1407 # Collect platform firmware volume list as the input of EOT.
1411 for Fd
in Wa
.FdfProfile
.FdDict
:
1412 for FdRegion
in Wa
.FdfProfile
.FdDict
[Fd
].RegionList
:
1413 if FdRegion
.RegionType
!= BINARY_FILE_TYPE_FV
:
1415 for FvName
in FdRegion
.RegionDataList
:
1416 if FvName
in self
._FvList
:
1418 self
._FvList
.append(FvName
)
1419 for Ffs
in Wa
.FdfProfile
.FvDict
[FvName
.upper()].FfsList
:
1420 for Section
in Ffs
.SectionList
:
1422 for FvSection
in Section
.SectionList
:
1423 if FvSection
.FvName
in self
._FvList
:
1425 self
._FvList
.append(FvSection
.FvName
)
1426 except AttributeError:
1431 # Parse platform fixed address map files
1433 # This function parses the platform final fixed address map file to get
1434 # the database of predicted fixed address for module image base, entry point
1437 # @param self: The object pointer
1439 def _ParseMapFile(self
):
1440 if self
._MapFileParsed
:
1442 self
._MapFileParsed
= True
1443 if os
.path
.isfile(self
._MapFileName
):
1445 FileContents
= open(self
._MapFileName
).read()
1446 for Match
in gMapFileItemPattern
.finditer(FileContents
):
1447 AddressType
= Match
.group(1)
1448 BaseAddress
= Match
.group(2)
1449 EntryPoint
= Match
.group(3)
1450 Guid
= Match
.group(4).upper()
1451 List
= self
.FixedMapDict
.setdefault(Guid
, [])
1452 List
.append((AddressType
, BaseAddress
, "*I"))
1453 List
.append((AddressType
, EntryPoint
, "*E"))
1455 EdkLogger
.warn(None, "Cannot open file to read", self
._MapFileName
)
1458 # Invokes EOT tool to get the predicted the execution order.
1460 # This function invokes EOT tool to calculate the predicted dispatch order
1462 # @param self: The object pointer
1464 def _InvokeEotTool(self
):
1465 if self
._EotToolInvoked
:
1468 self
._EotToolInvoked
= True
1470 for FvName
in self
._FvList
:
1471 FvFile
= os
.path
.join(self
._FvDir
, FvName
+ ".Fv")
1472 if os
.path
.isfile(FvFile
):
1473 FvFileList
.append(FvFile
)
1475 if len(FvFileList
) == 0:
1478 # Write source file list and GUID file list to an intermediate file
1479 # as the input for EOT tool and dispatch List as the output file
1482 SourceList
= os
.path
.join(self
._EotDir
, "SourceFile.txt")
1483 GuidList
= os
.path
.join(self
._EotDir
, "GuidList.txt")
1484 DispatchList
= os
.path
.join(self
._EotDir
, "Dispatch.txt")
1486 TempFile
= open(SourceList
, "w+")
1487 for Item
in self
._SourceList
:
1488 FileWrite(TempFile
, Item
)
1490 TempFile
= open(GuidList
, "w+")
1491 for Key
in self
._GuidMap
:
1492 FileWrite(TempFile
, "%s %s" % (Key
, self
._GuidMap
[Key
]))
1496 from Eot
.Eot
import Eot
1499 # Invoke EOT tool and echo its runtime performance
1501 EotStartTime
= time
.time()
1502 Eot(CommandLineOption
=False, SourceFileList
=SourceList
, GuidList
=GuidList
,
1503 FvFileList
=' '.join(FvFileList
), Dispatch
=DispatchList
, IsInit
=True)
1504 EotEndTime
= time
.time()
1505 EotDuration
= time
.strftime("%H:%M:%S", time
.gmtime(int(round(EotEndTime
- EotStartTime
))))
1506 EdkLogger
.quiet("EOT run time: %s\n" % EotDuration
)
1509 # Parse the output of EOT tool
1511 for Line
in open(DispatchList
):
1512 if len(Line
.split()) < 4:
1514 (Guid
, Phase
, FfsName
, FilePath
) = Line
.split()
1515 Symbol
= self
._FfsEntryPoint
.get(Guid
, [FfsName
, ""])[0]
1516 if len(Symbol
) > self
.MaxLen
:
1517 self
.MaxLen
= len(Symbol
)
1518 self
.ItemList
.append((Phase
, Symbol
, FilePath
))
1520 EdkLogger
.quiet("(Python %s on %s\n%s)" % (platform
.python_version(), sys
.platform
, traceback
.format_exc()))
1521 EdkLogger
.warn(None, "Failed to generate execution order prediction report, for some error occurred in executing EOT.")
1525 # Generate platform execution order report
1527 # This function generates the predicted module execution order.
1529 # @param self The object pointer
1530 # @param File The file object for report
1532 def _GenerateExecutionOrderReport(self
, File
):
1533 self
._InvokeEotTool
()
1534 if len(self
.ItemList
) == 0:
1536 FileWrite(File
, gSectionStart
)
1537 FileWrite(File
, "Execution Order Prediction")
1538 FileWrite(File
, "*P PEI phase")
1539 FileWrite(File
, "*D DXE phase")
1540 FileWrite(File
, "*E Module INF entry point name")
1541 FileWrite(File
, "*N Module notification function name")
1543 FileWrite(File
, "Type %-*s %s" % (self
.MaxLen
, "Symbol", "Module INF Path"))
1544 FileWrite(File
, gSectionSep
)
1545 for Item
in self
.ItemList
:
1546 FileWrite(File
, "*%sE %-*s %s" % (Item
[0], self
.MaxLen
, Item
[1], Item
[2]))
1548 FileWrite(File
, gSectionStart
)
1551 # Generate Fixed Address report.
1553 # This function generate the predicted fixed address report for a module
1554 # specified by Guid.
1556 # @param self The object pointer
1557 # @param File The file object for report
1558 # @param Guid The module Guid value.
1559 # @param NotifyList The list of all notify function in a module
1561 def _GenerateFixedAddressReport(self
, File
, Guid
, NotifyList
):
1562 self
._ParseMapFile
()
1563 FixedAddressList
= self
.FixedMapDict
.get(Guid
)
1564 if not FixedAddressList
:
1567 FileWrite(File
, gSubSectionStart
)
1568 FileWrite(File
, "Fixed Address Prediction")
1569 FileWrite(File
, "*I Image Loading Address")
1570 FileWrite(File
, "*E Entry Point Address")
1571 FileWrite(File
, "*N Notification Function Address")
1572 FileWrite(File
, "*F Flash Address")
1573 FileWrite(File
, "*M Memory Address")
1574 FileWrite(File
, "*S SMM RAM Offset")
1575 FileWrite(File
, "TOM Top of Memory")
1577 FileWrite(File
, "Type Address Name")
1578 FileWrite(File
, gSubSectionSep
)
1579 for Item
in FixedAddressList
:
1584 Name
= "(Image Base)"
1585 elif Symbol
== "*E":
1586 Name
= self
._FfsEntryPoint
.get(Guid
, ["", "_ModuleEntryPoint"])[1]
1587 elif Symbol
in NotifyList
:
1595 elif "Memory" in Type
:
1601 Value
= "TOM" + Value
1603 FileWrite(File
, "%s %-16s %s" % (Symbol
, Value
, Name
))
1606 # Generate report for the prediction part
1608 # This function generate the predicted fixed address report for a module or
1609 # predicted module execution order for a platform.
1610 # If the input Guid is None, then, it generates the predicted module execution order;
1611 # otherwise it generated the module fixed loading address for the module specified by
1614 # @param self The object pointer
1615 # @param File The file object for report
1616 # @param Guid The module Guid value.
1618 def GenerateReport(self
, File
, Guid
):
1620 self
._GenerateFixedAddressReport
(File
, Guid
.upper(), [])
1622 self
._GenerateExecutionOrderReport
(File
)
1625 # Reports FD region information
1627 # This class reports the FD subsection in the build report file.
1628 # It collects region information of platform flash device.
1629 # If the region is a firmware volume, it lists the set of modules
1630 # and its space information; otherwise, it only lists its region name,
1631 # base address and size in its sub-section header.
1632 # If there are nesting FVs, the nested FVs will list immediate after
1633 # this FD region subsection
1635 class FdRegionReport(object):
1637 # Discover all the nested FV name list.
1639 # This is an internal worker function to discover the all the nested FV information
1640 # in the parent firmware volume. It uses deep first search algorithm recursively to
1641 # find all the FV list name and append them to the list.
1643 # @param self The object pointer
1644 # @param FvName The name of current firmware file system
1645 # @param Wa Workspace context information
1647 def _DiscoverNestedFvList(self
, FvName
, Wa
):
1648 FvDictKey
=FvName
.upper()
1649 if FvDictKey
in Wa
.FdfProfile
.FvDict
:
1650 for Ffs
in Wa
.FdfProfile
.FvDict
[FvName
.upper()].FfsList
:
1651 for Section
in Ffs
.SectionList
:
1653 for FvSection
in Section
.SectionList
:
1654 if FvSection
.FvName
in self
.FvList
:
1656 self
._GuidsDb
[Ffs
.NameGuid
.upper()] = FvSection
.FvName
1657 self
.FvList
.append(FvSection
.FvName
)
1658 self
.FvInfo
[FvSection
.FvName
] = ("Nested FV", 0, 0)
1659 self
._DiscoverNestedFvList
(FvSection
.FvName
, Wa
)
1660 except AttributeError:
1664 # Constructor function for class FdRegionReport
1666 # This constructor function generates FdRegionReport object for a specified FdRegion.
1667 # If the FdRegion is a firmware volume, it will recursively find all its nested Firmware
1668 # volume list. This function also collects GUID map in order to dump module identification
1669 # in the final report.
1671 # @param self: The object pointer
1672 # @param FdRegion The current FdRegion object
1673 # @param Wa Workspace context information
1675 def __init__(self
, FdRegion
, Wa
):
1676 self
.Type
= FdRegion
.RegionType
1677 self
.BaseAddress
= FdRegion
.Offset
1678 self
.Size
= FdRegion
.Size
1682 self
._FvDir
= Wa
.FvDir
1683 self
._WorkspaceDir
= Wa
.WorkspaceDir
1686 # If the input FdRegion is not a firmware volume,
1689 if self
.Type
!= BINARY_FILE_TYPE_FV
:
1693 # Find all nested FVs in the FdRegion
1695 for FvName
in FdRegion
.RegionDataList
:
1696 if FvName
in self
.FvList
:
1698 self
.FvList
.append(FvName
)
1699 self
.FvInfo
[FvName
] = ("Fd Region", self
.BaseAddress
, self
.Size
)
1700 self
._DiscoverNestedFvList
(FvName
, Wa
)
1704 # Collect PCDs declared in DEC files.
1706 for Pa
in Wa
.AutoGenObjectList
:
1707 for Package
in Pa
.PackageList
:
1708 for (TokenCName
, TokenSpaceGuidCName
, DecType
) in Package
.Pcds
:
1709 DecDefaultValue
= Package
.Pcds
[TokenCName
, TokenSpaceGuidCName
, DecType
].DefaultValue
1710 PlatformPcds
[(TokenCName
, TokenSpaceGuidCName
)] = DecDefaultValue
1712 # Collect PCDs defined in DSC file
1714 for Pa
in Wa
.AutoGenObjectList
:
1715 for (TokenCName
, TokenSpaceGuidCName
) in Pa
.Platform
.Pcds
:
1716 DscDefaultValue
= Pa
.Platform
.Pcds
[(TokenCName
, TokenSpaceGuidCName
)].DefaultValue
1717 PlatformPcds
[(TokenCName
, TokenSpaceGuidCName
)] = DscDefaultValue
1720 # Add PEI and DXE a priori files GUIDs defined in PI specification.
1722 self
._GuidsDb
["1B45CC0A-156A-428A-AF62-49864DA0E6E6"] = "PEI Apriori"
1723 self
._GuidsDb
["FC510EE7-FFDC-11D4-BD41-0080C73C8881"] = "DXE Apriori"
1725 # Add ACPI table storage file
1727 self
._GuidsDb
["7E374E25-8E01-4FEE-87F2-390C23C606CD"] = "ACPI table storage"
1729 for Pa
in Wa
.AutoGenObjectList
:
1730 for ModuleKey
in Pa
.Platform
.Modules
:
1731 M
= Pa
.Platform
.Modules
[ModuleKey
].M
1732 InfPath
= mws
.join(Wa
.WorkspaceDir
, M
.MetaFile
.File
)
1733 self
._GuidsDb
[M
.Guid
.upper()] = "%s (%s)" % (M
.Module
.BaseName
, InfPath
)
1736 # Collect the GUID map in the FV firmware volume
1738 for FvName
in self
.FvList
:
1739 FvDictKey
=FvName
.upper()
1740 if FvDictKey
in Wa
.FdfProfile
.FvDict
:
1741 for Ffs
in Wa
.FdfProfile
.FvDict
[FvName
.upper()].FfsList
:
1744 # collect GUID map for binary EFI file in FDF file.
1746 Guid
= Ffs
.NameGuid
.upper()
1747 Match
= gPcdGuidPattern
.match(Ffs
.NameGuid
)
1749 PcdTokenspace
= Match
.group(1)
1750 PcdToken
= Match
.group(2)
1751 if (PcdToken
, PcdTokenspace
) in PlatformPcds
:
1752 GuidValue
= PlatformPcds
[(PcdToken
, PcdTokenspace
)]
1753 Guid
= GuidStructureByteArrayToGuidString(GuidValue
).upper()
1754 for Section
in Ffs
.SectionList
:
1756 ModuleSectFile
= mws
.join(Wa
.WorkspaceDir
, Section
.SectFileName
)
1757 self
._GuidsDb
[Guid
] = ModuleSectFile
1758 except AttributeError:
1760 except AttributeError:
1765 # Internal worker function to generate report for the FD region
1767 # This internal worker function to generate report for the FD region.
1768 # It the type is firmware volume, it lists offset and module identification.
1770 # @param self The object pointer
1771 # @param File The file object for report
1772 # @param Title The title for the FD subsection
1773 # @param BaseAddress The base address for the FD region
1774 # @param Size The size of the FD region
1775 # @param FvName The FV name if the FD region is a firmware volume
1777 def _GenerateReport(self
, File
, Title
, Type
, BaseAddress
, Size
=0, FvName
=None):
1778 FileWrite(File
, gSubSectionStart
)
1779 FileWrite(File
, Title
)
1780 FileWrite(File
, "Type: %s" % Type
)
1781 FileWrite(File
, "Base Address: 0x%X" % BaseAddress
)
1783 if self
.Type
== BINARY_FILE_TYPE_FV
:
1787 if FvName
.upper().endswith('.FV'):
1788 FileExt
= FvName
+ ".txt"
1790 FileExt
= FvName
+ ".Fv.txt"
1792 if not os
.path
.isfile(FileExt
):
1793 FvReportFileName
= mws
.join(self
._WorkspaceDir
, FileExt
)
1794 if not os
.path
.isfile(FvReportFileName
):
1795 FvReportFileName
= os
.path
.join(self
._FvDir
, FileExt
)
1798 # Collect size info in the firmware volume.
1800 FvReport
= open(FvReportFileName
).read()
1801 Match
= gFvTotalSizePattern
.search(FvReport
)
1803 FvTotalSize
= int(Match
.group(1), 16)
1804 Match
= gFvTakenSizePattern
.search(FvReport
)
1806 FvTakenSize
= int(Match
.group(1), 16)
1807 FvFreeSize
= FvTotalSize
- FvTakenSize
1809 # Write size information to the report file.
1811 FileWrite(File
, "Size: 0x%X (%.0fK)" % (FvTotalSize
, FvTotalSize
/ 1024.0))
1812 FileWrite(File
, "Fv Name: %s (%.1f%% Full)" % (FvName
, FvTakenSize
* 100.0 / FvTotalSize
))
1813 FileWrite(File
, "Occupied Size: 0x%X (%.0fK)" % (FvTakenSize
, FvTakenSize
/ 1024.0))
1814 FileWrite(File
, "Free Size: 0x%X (%.0fK)" % (FvFreeSize
, FvFreeSize
/ 1024.0))
1815 FileWrite(File
, "Offset Module")
1816 FileWrite(File
, gSubSectionSep
)
1818 # Write module offset and module identification to the report file.
1821 for Match
in gOffsetGuidPattern
.finditer(FvReport
):
1822 Guid
= Match
.group(2).upper()
1823 OffsetInfo
[Match
.group(1)] = self
._GuidsDb
.get(Guid
, Guid
)
1824 OffsetList
= OffsetInfo
.keys()
1826 for Offset
in OffsetList
:
1827 FileWrite (File
, "%s %s" % (Offset
, OffsetInfo
[Offset
]))
1829 EdkLogger
.warn(None, "Fail to read report file", FvReportFileName
)
1831 FileWrite(File
, "Size: 0x%X (%.0fK)" % (Size
, Size
/ 1024.0))
1832 FileWrite(File
, gSubSectionEnd
)
1835 # Generate report for the FD region
1837 # This function generates report for the FD region.
1839 # @param self The object pointer
1840 # @param File The file object for report
1842 def GenerateReport(self
, File
):
1843 if (len(self
.FvList
) > 0):
1844 for FvItem
in self
.FvList
:
1845 Info
= self
.FvInfo
[FvItem
]
1846 self
._GenerateReport
(File
, Info
[0], TAB_FV_DIRECTORY
, Info
[1], Info
[2], FvItem
)
1848 self
._GenerateReport
(File
, "FD Region", self
.Type
, self
.BaseAddress
, self
.Size
)
1851 # Reports FD information
1853 # This class reports the FD section in the build report file.
1854 # It collects flash device information for a platform.
1856 class FdReport(object):
1858 # Constructor function for class FdReport
1860 # This constructor function generates FdReport object for a specified
1863 # @param self The object pointer
1864 # @param Fd The current Firmware device object
1865 # @param Wa Workspace context information
1867 def __init__(self
, Fd
, Wa
):
1868 self
.FdName
= Fd
.FdUiName
1869 self
.BaseAddress
= Fd
.BaseAddress
1871 self
.FdRegionList
= [FdRegionReport(FdRegion
, Wa
) for FdRegion
in Fd
.RegionList
]
1872 self
.FvPath
= os
.path
.join(Wa
.BuildDir
, TAB_FV_DIRECTORY
)
1873 self
.VpdFilePath
= os
.path
.join(self
.FvPath
, "%s.map" % Wa
.Platform
.VpdToolGuid
)
1874 self
.VPDBaseAddress
= 0
1876 self
.VPDInfoList
= []
1877 for index
, FdRegion
in enumerate(Fd
.RegionList
):
1878 if str(FdRegion
.RegionType
) is 'FILE' and Wa
.Platform
.VpdToolGuid
in str(FdRegion
.RegionDataList
):
1879 self
.VPDBaseAddress
= self
.FdRegionList
[index
].BaseAddress
1880 self
.VPDSize
= self
.FdRegionList
[index
].Size
1883 if os
.path
.isfile(self
.VpdFilePath
):
1884 fd
= open(self
.VpdFilePath
, "r")
1885 Lines
= fd
.readlines()
1888 if len(Line
) == 0 or Line
.startswith("#"):
1891 PcdName
, SkuId
, Offset
, Size
, Value
= Line
.split("#")[0].split("|")
1892 PcdName
, SkuId
, Offset
, Size
, Value
= PcdName
.strip(), SkuId
.strip(), Offset
.strip(), Size
.strip(), Value
.strip()
1893 if Offset
.lower().startswith('0x'):
1894 Offset
= '0x%08X' % (int(Offset
, 16) + self
.VPDBaseAddress
)
1896 Offset
= '0x%08X' % (int(Offset
, 10) + self
.VPDBaseAddress
)
1897 self
.VPDInfoList
.append("%s | %s | %s | %s | %s" % (PcdName
, SkuId
, Offset
, Size
, Value
))
1899 EdkLogger
.error("BuildReport", CODE_ERROR
, "Fail to parse VPD information file %s" % self
.VpdFilePath
)
1903 # Generate report for the firmware device.
1905 # This function generates report for the firmware device.
1907 # @param self The object pointer
1908 # @param File The file object for report
1910 def GenerateReport(self
, File
):
1911 FileWrite(File
, gSectionStart
)
1912 FileWrite(File
, "Firmware Device (FD)")
1913 FileWrite(File
, "FD Name: %s" % self
.FdName
)
1914 FileWrite(File
, "Base Address: %s" % self
.BaseAddress
)
1915 FileWrite(File
, "Size: 0x%X (%.0fK)" % (self
.Size
, self
.Size
/ 1024.0))
1916 if len(self
.FdRegionList
) > 0:
1917 FileWrite(File
, gSectionSep
)
1918 for FdRegionItem
in self
.FdRegionList
:
1919 FdRegionItem
.GenerateReport(File
)
1921 if len(self
.VPDInfoList
) > 0:
1922 FileWrite(File
, gSubSectionStart
)
1923 FileWrite(File
, "FD VPD Region")
1924 FileWrite(File
, "Base Address: 0x%X" % self
.VPDBaseAddress
)
1925 FileWrite(File
, "Size: 0x%X (%.0fK)" % (self
.VPDSize
, self
.VPDSize
/ 1024.0))
1926 FileWrite(File
, gSubSectionSep
)
1927 for item
in self
.VPDInfoList
:
1928 ValueList
= item
.split('|')
1929 Value
= ValueList
[-1].strip()
1930 IsByteArray
, ArrayList
= ByteArrayForamt(Value
)
1932 ValueList
[-1] = ' {'
1933 FileWrite(File
, '|'.join(ValueList
))
1934 for Array
in ArrayList
:
1935 FileWrite(File
, '%s' % (Array
))
1937 FileWrite(File
, item
)
1938 FileWrite(File
, gSubSectionEnd
)
1939 FileWrite(File
, gSectionEnd
)
1944 # Reports platform information
1946 # This class reports the whole platform information
1948 class PlatformReport(object):
1950 # Constructor function for class PlatformReport
1952 # This constructor function generates PlatformReport object a platform build.
1953 # It generates report for platform summary, flash, global PCDs and detailed
1954 # module information for modules involved in platform build.
1956 # @param self The object pointer
1957 # @param Wa Workspace context information
1958 # @param MaList The list of modules in the platform build
1960 def __init__(self
, Wa
, MaList
, ReportType
):
1961 self
._WorkspaceDir
= Wa
.WorkspaceDir
1962 self
.PlatformName
= Wa
.Name
1963 self
.PlatformDscPath
= Wa
.Platform
1964 self
.Architectures
= " ".join(Wa
.ArchList
)
1965 self
.ToolChain
= Wa
.ToolChain
1966 self
.Target
= Wa
.BuildTarget
1967 self
.OutputPath
= os
.path
.join(Wa
.WorkspaceDir
, Wa
.OutputDir
)
1968 self
.BuildEnvironment
= platform
.platform()
1970 self
.PcdReport
= None
1971 if "PCD" in ReportType
:
1972 self
.PcdReport
= PcdReport(Wa
)
1974 self
.FdReportList
= []
1975 if "FLASH" in ReportType
and Wa
.FdfProfile
and MaList
is None:
1976 for Fd
in Wa
.FdfProfile
.FdDict
:
1977 self
.FdReportList
.append(FdReport(Wa
.FdfProfile
.FdDict
[Fd
], Wa
))
1979 self
.PredictionReport
= None
1980 if "FIXED_ADDRESS" in ReportType
or "EXECUTION_ORDER" in ReportType
:
1981 self
.PredictionReport
= PredictionReport(Wa
)
1983 self
.DepexParser
= None
1984 if "DEPEX" in ReportType
:
1985 self
.DepexParser
= DepexParser(Wa
)
1987 self
.ModuleReportList
= []
1988 if MaList
is not None:
1989 self
._IsModuleBuild
= True
1991 self
.ModuleReportList
.append(ModuleReport(Ma
, ReportType
))
1993 self
._IsModuleBuild
= False
1994 for Pa
in Wa
.AutoGenObjectList
:
1995 ModuleAutoGenList
= []
1996 for ModuleKey
in Pa
.Platform
.Modules
:
1997 ModuleAutoGenList
.append(Pa
.Platform
.Modules
[ModuleKey
].M
)
1998 if GlobalData
.gFdfParser
is not None:
1999 if Pa
.Arch
in GlobalData
.gFdfParser
.Profile
.InfDict
:
2000 INFList
= GlobalData
.gFdfParser
.Profile
.InfDict
[Pa
.Arch
]
2001 for InfName
in INFList
:
2002 InfClass
= PathClass(NormPath(InfName
), Wa
.WorkspaceDir
, Pa
.Arch
)
2003 Ma
= ModuleAutoGen(Wa
, InfClass
, Pa
.BuildTarget
, Pa
.ToolChain
, Pa
.Arch
, Wa
.MetaFile
)
2006 if Ma
not in ModuleAutoGenList
:
2007 ModuleAutoGenList
.append(Ma
)
2008 for MGen
in ModuleAutoGenList
:
2009 self
.ModuleReportList
.append(ModuleReport(MGen
, ReportType
))
2014 # Generate report for the whole platform.
2016 # This function generates report for platform information.
2017 # It comprises of platform summary, global PCD, flash and
2018 # module list sections.
2020 # @param self The object pointer
2021 # @param File The file object for report
2022 # @param BuildDuration The total time to build the modules
2023 # @param AutoGenTime The total time of AutoGen Phase
2024 # @param MakeTime The total time of Make Phase
2025 # @param GenFdsTime The total time of GenFds Phase
2026 # @param ReportType The kind of report items in the final report file
2028 def GenerateReport(self
, File
, BuildDuration
, AutoGenTime
, MakeTime
, GenFdsTime
, ReportType
):
2029 FileWrite(File
, "Platform Summary")
2030 FileWrite(File
, "Platform Name: %s" % self
.PlatformName
)
2031 FileWrite(File
, "Platform DSC Path: %s" % self
.PlatformDscPath
)
2032 FileWrite(File
, "Architectures: %s" % self
.Architectures
)
2033 FileWrite(File
, "Tool Chain: %s" % self
.ToolChain
)
2034 FileWrite(File
, "Target: %s" % self
.Target
)
2035 if GlobalData
.gSkuids
:
2036 FileWrite(File
, "SKUID: %s" % " ".join(GlobalData
.gSkuids
))
2037 if GlobalData
.gDefaultStores
:
2038 FileWrite(File
, "DefaultStore: %s" % " ".join(GlobalData
.gDefaultStores
))
2039 FileWrite(File
, "Output Path: %s" % self
.OutputPath
)
2040 FileWrite(File
, "Build Environment: %s" % self
.BuildEnvironment
)
2041 FileWrite(File
, "Build Duration: %s" % BuildDuration
)
2043 FileWrite(File
, "AutoGen Duration: %s" % AutoGenTime
)
2045 FileWrite(File
, "Make Duration: %s" % MakeTime
)
2047 FileWrite(File
, "GenFds Duration: %s" % GenFdsTime
)
2048 FileWrite(File
, "Report Content: %s" % ", ".join(ReportType
))
2050 if GlobalData
.MixedPcd
:
2051 FileWrite(File
, gSectionStart
)
2052 FileWrite(File
, "The following PCDs use different access methods:")
2053 FileWrite(File
, gSectionSep
)
2054 for PcdItem
in GlobalData
.MixedPcd
:
2055 FileWrite(File
, "%s.%s" % (str(PcdItem
[1]), str(PcdItem
[0])))
2056 FileWrite(File
, gSectionEnd
)
2058 if not self
._IsModuleBuild
:
2059 if "PCD" in ReportType
:
2060 self
.PcdReport
.GenerateReport(File
, None)
2062 if "FLASH" in ReportType
:
2063 for FdReportListItem
in self
.FdReportList
:
2064 FdReportListItem
.GenerateReport(File
)
2066 for ModuleReportItem
in self
.ModuleReportList
:
2067 ModuleReportItem
.GenerateReport(File
, self
.PcdReport
, self
.PredictionReport
, self
.DepexParser
, ReportType
)
2069 if not self
._IsModuleBuild
:
2070 if "EXECUTION_ORDER" in ReportType
:
2071 self
.PredictionReport
.GenerateReport(File
, None)
2073 ## BuildReport class
2075 # This base class contain the routines to collect data and then
2076 # applies certain format to the output report
2078 class BuildReport(object):
2080 # Constructor function for class BuildReport
2082 # This constructor function generates BuildReport object a platform build.
2083 # It generates report for platform summary, flash, global PCDs and detailed
2084 # module information for modules involved in platform build.
2086 # @param self The object pointer
2087 # @param ReportFile The file name to save report file
2088 # @param ReportType The kind of report items in the final report file
2090 def __init__(self
, ReportFile
, ReportType
):
2091 self
.ReportFile
= ReportFile
2093 self
.ReportList
= []
2094 self
.ReportType
= []
2096 for ReportTypeItem
in ReportType
:
2097 if ReportTypeItem
not in self
.ReportType
:
2098 self
.ReportType
.append(ReportTypeItem
)
2100 self
.ReportType
= ["PCD", "LIBRARY", "BUILD_FLAGS", "DEPEX", "HASH", "FLASH", "FIXED_ADDRESS"]
2102 # Adds platform report to the list
2104 # This function adds a platform report to the final report list.
2106 # @param self The object pointer
2107 # @param Wa Workspace context information
2108 # @param MaList The list of modules in the platform build
2110 def AddPlatformReport(self
, Wa
, MaList
=None):
2112 self
.ReportList
.append((Wa
, MaList
))
2115 # Generates the final report.
2117 # This function generates platform build report. It invokes GenerateReport()
2118 # method for every platform report in the list.
2120 # @param self The object pointer
2121 # @param BuildDuration The total time to build the modules
2122 # @param AutoGenTime The total time of AutoGen phase
2123 # @param MakeTime The total time of Make phase
2124 # @param GenFdsTime The total time of GenFds phase
2126 def GenerateReport(self
, BuildDuration
, AutoGenTime
, MakeTime
, GenFdsTime
):
2130 for (Wa
, MaList
) in self
.ReportList
:
2131 PlatformReport(Wa
, MaList
, self
.ReportType
).GenerateReport(File
, BuildDuration
, AutoGenTime
, MakeTime
, GenFdsTime
, self
.ReportType
)
2132 Content
= FileLinesSplit(File
.getvalue(), gLineMaxLength
)
2133 SaveFileOnChange(self
.ReportFile
, Content
, True)
2134 EdkLogger
.quiet("Build report can be found at %s" % os
.path
.abspath(self
.ReportFile
))
2136 EdkLogger
.error(None, FILE_WRITE_FAILURE
, ExtraData
=self
.ReportFile
)
2138 EdkLogger
.error("BuildReport", CODE_ERROR
, "Unknown fatal error when generating build report", ExtraData
=self
.ReportFile
, RaiseError
=False)
2139 EdkLogger
.quiet("(Python %s on %s\n%s)" % (platform
.python_version(), sys
.platform
, traceback
.format_exc()))
2142 # This acts like the main() function for the script, unless it is 'import'ed into another script.
2143 if __name__
== '__main__':