# This module contains the functionality to generate build report after\r
# build all target completes successfully.\r
#\r
-# Copyright (c) 2010, Intel Corporation. All rights reserved.<BR>\r
+# Copyright (c) 2010 - 2012, Intel Corporation. All rights reserved.<BR>\r
# This program and the accompanying materials\r
# are licensed and made available under the terms and conditions of the BSD License\r
# which accompanies this distribution. The full text of the license may be found at\r
import traceback\r
import sys\r
import time\r
+import struct\r
from datetime import datetime\r
from StringIO import StringIO\r
from Common import EdkLogger\r
from Common.InfClassObject import gComponentType2ModuleType\r
from Common.BuildToolError import FILE_WRITE_FAILURE\r
from Common.BuildToolError import CODE_ERROR\r
-\r
+from Common.DataType import TAB_LINE_BREAK\r
+from Common.DataType import TAB_DEPEX\r
+from Common.DataType import TAB_SLASH\r
+from Common.DataType import TAB_SPACE_SPLIT\r
+from Common.DataType import TAB_BRG_PCD\r
+from Common.DataType import TAB_BRG_LIBRARY\r
+from Common.DataType import TAB_BACK_SLASH\r
\r
## Pattern to extract contents in EDK DXS files\r
gDxsDependencyPattern = re.compile(r"DEPENDENCY_START(.+)DEPENDENCY_END", re.DOTALL)\r
## Pattern to find the entry point for EDK module using EDKII Glue library\r
gGlueLibEntryPoint = re.compile(r"__EDKII_GLUE_MODULE_ENTRY_POINT__\s*=\s*(\w+)")\r
\r
+## Tags for MaxLength of line in report\r
+gLineMaxLength = 120\r
+\r
+## Tags for end of line in report\r
+gEndOfLine = "\r\n"\r
+\r
## Tags for section start, end and separator\r
-gSectionStart = ">" + "=" * 118 + "<"\r
-gSectionEnd = "<" + "=" * 118 + ">" + "\n"\r
-gSectionSep = "=" * 120\r
+gSectionStart = ">" + "=" * (gLineMaxLength-2) + "<"\r
+gSectionEnd = "<" + "=" * (gLineMaxLength-2) + ">" + "\n"\r
+gSectionSep = "=" * gLineMaxLength\r
\r
## Tags for subsection start, end and separator\r
-gSubSectionStart = ">" + "-" * 118 + "<"\r
-gSubSectionEnd = "<" + "-" * 118 + ">"\r
-gSubSectionSep = "-" * 120\r
+gSubSectionStart = ">" + "-" * (gLineMaxLength-2) + "<"\r
+gSubSectionEnd = "<" + "-" * (gLineMaxLength-2) + ">"\r
+gSubSectionSep = "-" * gLineMaxLength\r
+\r
\r
## The look up table to map PCD type to pair of report display type and DEC type\r
gPcdTypeMap = {\r
'Dynamic' : ('DYN', 'Dynamic'),\r
'DynamicHii' : ('DYNHII', 'Dynamic'),\r
'DynamicVpd' : ('DYNVPD', 'Dynamic'),\r
- 'DynamicEx' : ('DEX', 'Dynamic'),\r
- 'DynamicExHii' : ('DEXHII', 'Dynamic'),\r
- 'DynamicExVpd' : ('DEXVPD', 'Dynamic'),\r
+ 'DynamicEx' : ('DEX', 'DynamicEx'),\r
+ 'DynamicExHii' : ('DEXHII', 'DynamicEx'),\r
+ 'DynamicExVpd' : ('DEXVPD', 'DynamicEx'),\r
}\r
\r
## The look up table to map module type to driver type\r
'SMM_DRIVER' : '0xA (SMM)', # Extension of module type to support PI 1.1 SMM drivers\r
}\r
\r
+## The look up table of the supported opcode in the dependency expression binaries\r
+gOpCodeList = ["BEFORE", "AFTER", "PUSH", "AND", "OR", "NOT", "TRUE", "FALSE", "END", "SOR"]\r
+\r
##\r
# Writes a string to the file object.\r
#\r
def FileWrite(File, String, Wrapper=False):\r
if Wrapper:\r
String = textwrap.fill(String, 120)\r
- File.write(String + "\r\n")\r
+ File.write(String + gEndOfLine)\r
\r
##\r
# Find all the header file that the module source directly includes.\r
IncludeFiles[FullFileName.lower().replace("\\", "/")] = FullFileName\r
break\r
\r
+## Split each lines in file\r
+#\r
+# This method is used to split the lines in file to make the length of each line \r
+# less than MaxLength.\r
+#\r
+# @param Content The content of file\r
+# @param MaxLength The Max Length of the line\r
+#\r
+def FileLinesSplit(Content=None, MaxLength=None):\r
+ ContentList = Content.split(TAB_LINE_BREAK)\r
+ NewContent = ''\r
+ NewContentList = []\r
+ for Line in ContentList:\r
+ while len(Line.rstrip()) > MaxLength:\r
+ LineSpaceIndex = Line.rfind(TAB_SPACE_SPLIT, 0, MaxLength)\r
+ LineSlashIndex = Line.rfind(TAB_SLASH, 0, MaxLength)\r
+ LineBackSlashIndex = Line.rfind(TAB_BACK_SLASH, 0, MaxLength)\r
+ if max(LineSpaceIndex, LineSlashIndex, LineBackSlashIndex) > 0:\r
+ LineBreakIndex = max(LineSpaceIndex, LineSlashIndex, LineBackSlashIndex)\r
+ else:\r
+ LineBreakIndex = MaxLength\r
+ NewContentList.append(Line[:LineBreakIndex])\r
+ Line = Line[LineBreakIndex:]\r
+ if Line:\r
+ NewContentList.append(Line)\r
+ for NewLine in NewContentList:\r
+ NewContent += NewLine + TAB_LINE_BREAK\r
+ \r
+ NewContent = NewContent.replace(TAB_LINE_BREAK, gEndOfLine).replace('\r\r\n', gEndOfLine)\r
+ return NewContent\r
+ \r
+ \r
+ \r
+##\r
+# Parse binary dependency expression section\r
+#\r
+# This utility class parses the dependency expression section and translate the readable\r
+# GUID name and value.\r
+#\r
+class DepexParser(object):\r
+ ##\r
+ # Constructor function for class DepexParser\r
+ #\r
+ # This constructor function collect GUID values so that the readable\r
+ # GUID name can be translated.\r
+ #\r
+ # @param self The object pointer\r
+ # @param Wa Workspace context information\r
+ #\r
+ def __init__(self, Wa):\r
+ self._GuidDb = {}\r
+ for Pa in Wa.AutoGenObjectList:\r
+ for Package in Pa.PackageList: \r
+ for Protocol in Package.Protocols:\r
+ GuidValue = GuidStructureStringToGuidString(Package.Protocols[Protocol])\r
+ self._GuidDb[GuidValue.upper()] = Protocol\r
+ for Ppi in Package.Ppis:\r
+ GuidValue = GuidStructureStringToGuidString(Package.Ppis[Ppi])\r
+ self._GuidDb[GuidValue.upper()] = Ppi\r
+ for Guid in Package.Guids:\r
+ GuidValue = GuidStructureStringToGuidString(Package.Guids[Guid])\r
+ self._GuidDb[GuidValue.upper()] = Guid\r
+ \r
+ ##\r
+ # Parse the binary dependency expression files.\r
+ # \r
+ # This function parses the binary dependency expression file and translate it\r
+ # to the instruction list.\r
+ #\r
+ # @param self The object pointer\r
+ # @param DepexFileName The file name of binary dependency expression file.\r
+ #\r
+ def ParseDepexFile(self, DepexFileName):\r
+ DepexFile = open(DepexFileName, "rb")\r
+ DepexStatement = []\r
+ OpCode = DepexFile.read(1)\r
+ while OpCode:\r
+ Statement = gOpCodeList[struct.unpack("B", OpCode)[0]]\r
+ if Statement in ["BEFORE", "AFTER", "PUSH"]:\r
+ GuidValue = "%08X-%04X-%04X-%02X%02X-%02X%02X%02X%02X%02X%02X" % \\r
+ struct.unpack("LHHBBBBBBBB", DepexFile.read(16))\r
+ GuidString = self._GuidDb.get(GuidValue, GuidValue)\r
+ Statement = "%s %s" % (Statement, GuidString)\r
+ DepexStatement.append(Statement)\r
+ OpCode = DepexFile.read(1) \r
+ \r
+ return DepexStatement\r
+ \r
##\r
# Reports library information\r
#\r
#\r
def GenerateReport(self, File):\r
FileWrite(File, gSubSectionStart)\r
- FileWrite(File, "Library")\r
+ FileWrite(File, TAB_BRG_LIBRARY)\r
if len(self.LibraryList) > 0:\r
FileWrite(File, gSubSectionSep)\r
for LibraryItem in self.LibraryList:\r
#\r
def __init__(self, M):\r
self.Depex = ""\r
+ self._DepexFileName = os.path.join(M.BuildDir, "OUTPUT", M.Module.BaseName + ".depex") \r
ModuleType = M.ModuleType\r
if not ModuleType:\r
ModuleType = gComponentType2ModuleType.get(M.ComponentType, "")\r
#\r
# This function generates report for the module dependency expression.\r
#\r
- # @param self The object pointer\r
- # @param File The file object for report\r
+ # @param self The object pointer\r
+ # @param File The file object for report\r
+ # @param GlobalDepexParser The platform global Dependency expression parser object\r
#\r
- def GenerateReport(self, File):\r
+ def GenerateReport(self, File, GlobalDepexParser):\r
if not self.Depex:\r
+ FileWrite(File, gSubSectionStart)\r
+ FileWrite(File, TAB_DEPEX)\r
+ FileWrite(File, gSubSectionEnd)\r
return\r
- \r
FileWrite(File, gSubSectionStart)\r
+ if os.path.isfile(self._DepexFileName):\r
+ try:\r
+ DepexStatements = GlobalDepexParser.ParseDepexFile(self._DepexFileName)\r
+ FileWrite(File, "Final Dependency Expression (DEPEX) Instructions")\r
+ for DepexStatement in DepexStatements:\r
+ FileWrite(File, " %s" % DepexStatement)\r
+ FileWrite(File, gSubSectionSep)\r
+ except:\r
+ EdkLogger.warn(None, "Dependency expression file is corrupted", self._DepexFileName)\r
+ \r
FileWrite(File, "Dependency Expression (DEPEX) from %s" % self.Source)\r
\r
if self.Source == "INF":\r
# This function generates report for separate module expression\r
# in a platform build.\r
#\r
- # @param self The object pointer\r
- # @param File The file object for report\r
- # @param GlobalPcdReport The platform global PCD class object\r
- # @param ReportType The kind of report items in the final report file\r
+ # @param self The object pointer\r
+ # @param File The file object for report\r
+ # @param GlobalPcdReport The platform global PCD report object\r
+ # @param GlobalPredictionReport The platform global Prediction report object\r
+ # @param GlobalDepexParser The platform global Dependency expression parser object\r
+ # @param ReportType The kind of report items in the final report file\r
#\r
- def GenerateReport(self, File, GlobalPcdReport, GlobalPredictionReport, ReportType):\r
+ def GenerateReport(self, File, GlobalPcdReport, GlobalPredictionReport, GlobalDepexParser, ReportType):\r
FileWrite(File, gSectionStart)\r
\r
FwReportFileName = os.path.join(self._BuildDir, "DEBUG", self.ModuleName + ".txt")\r
self.LibraryReport.GenerateReport(File)\r
\r
if "DEPEX" in ReportType:\r
- self.DepexReport.GenerateReport(File)\r
+ self.DepexReport.GenerateReport(File, GlobalDepexParser)\r
\r
if "BUILD_FLAGS" in ReportType:\r
self.BuildFlagsReport.GenerateReport(File)\r
# Collect PCD DEC default value.\r
#\r
self.DecPcdDefault = {}\r
- for Package in Wa.BuildDatabase.WorkspaceDb.PackageList:\r
- for (TokenCName, TokenSpaceGuidCName, DecType) in Package.Pcds:\r
- DecDefaultValue = Package.Pcds[TokenCName, TokenSpaceGuidCName, DecType].DefaultValue\r
- self.DecPcdDefault.setdefault((TokenCName, TokenSpaceGuidCName, DecType), DecDefaultValue)\r
+ for Pa in Wa.AutoGenObjectList:\r
+ for Package in Pa.PackageList:\r
+ for (TokenCName, TokenSpaceGuidCName, DecType) in Package.Pcds:\r
+ DecDefaultValue = Package.Pcds[TokenCName, TokenSpaceGuidCName, DecType].DefaultValue\r
+ self.DecPcdDefault.setdefault((TokenCName, TokenSpaceGuidCName, DecType), DecDefaultValue)\r
#\r
# Collect PCDs defined in DSC common section\r
#\r
self.DscPcdDefault = {}\r
- for Platform in Wa.BuildDatabase.WorkspaceDb.PlatformList:\r
+ for Arch in Wa.ArchList:\r
+ Platform = Wa.BuildDatabase[Wa.MetaFile, Arch, Wa.BuildTarget, Wa.ToolChain]\r
for (TokenCName, TokenSpaceGuidCName) in Platform.Pcds:\r
DscDefaultValue = Platform.Pcds[(TokenCName, TokenSpaceGuidCName)].DefaultValue\r
if DscDefaultValue:\r
# For module PCD sub-section\r
#\r
FileWrite(File, gSubSectionStart)\r
- FileWrite(File, "PCD")\r
+ FileWrite(File, TAB_BRG_PCD)\r
FileWrite(File, gSubSectionSep)\r
\r
for Key in self.AllPcds:\r
self._DiscoverNestedFvList(FvName, Wa)\r
\r
PlatformPcds = {}\r
- \r
#\r
# Collect PCDs declared in DEC files.\r
- #\r
- for Package in Wa.BuildDatabase.WorkspaceDb.PackageList:\r
- for (TokenCName, TokenSpaceGuidCName, DecType) in Package.Pcds:\r
- DecDefaultValue = Package.Pcds[TokenCName, TokenSpaceGuidCName, DecType].DefaultValue\r
- PlatformPcds[(TokenCName, TokenSpaceGuidCName)] = DecDefaultValue\r
+ # \r
+ for Pa in Wa.AutoGenObjectList:\r
+ for Package in Pa.PackageList:\r
+ for (TokenCName, TokenSpaceGuidCName, DecType) in Package.Pcds:\r
+ DecDefaultValue = Package.Pcds[TokenCName, TokenSpaceGuidCName, DecType].DefaultValue\r
+ PlatformPcds[(TokenCName, TokenSpaceGuidCName)] = DecDefaultValue\r
#\r
# Collect PCDs defined in DSC common section\r
#\r
FvTotalSize = 0\r
FvTakenSize = 0\r
FvFreeSize = 0\r
- FvReportFileName = os.path.join(self._FvDir, FvName + ".fv.txt")\r
+ FvReportFileName = os.path.join(self._FvDir, FvName + ".Fv.txt")\r
try:\r
#\r
# Collect size info in the firmware volume.\r
if "FIXED_ADDRESS" in ReportType or "EXECUTION_ORDER" in ReportType:\r
self.PredictionReport = PredictionReport(Wa)\r
\r
+ self.DepexParser = None\r
+ if "DEPEX" in ReportType:\r
+ self.DepexParser = DepexParser(Wa)\r
+ \r
self.ModuleReportList = []\r
if MaList != None:\r
self._IsModuleBuild = True\r
FdReportListItem.GenerateReport(File)\r
\r
for ModuleReportItem in self.ModuleReportList:\r
- ModuleReportItem.GenerateReport(File, self.PcdReport, self.PredictionReport, ReportType)\r
+ ModuleReportItem.GenerateReport(File, self.PcdReport, self.PredictionReport, self.DepexParser, ReportType)\r
\r
if not self._IsModuleBuild:\r
if "EXECUTION_ORDER" in ReportType:\r
File = StringIO('')\r
for (Wa, MaList) in self.ReportList:\r
PlatformReport(Wa, MaList, self.ReportType).GenerateReport(File, BuildDuration, self.ReportType)\r
- SaveFileOnChange(self.ReportFile, File.getvalue(), False)\r
+ Content = FileLinesSplit(File.getvalue(), gLineMaxLength)\r
+ SaveFileOnChange(self.ReportFile, Content, True)\r
EdkLogger.quiet("Build report can be found at %s" % os.path.abspath(self.ReportFile))\r
except IOError:\r
EdkLogger.error(None, FILE_WRITE_FAILURE, ExtraData=self.ReportFile)\r