| | 1 | ## @file\r |
| | 2 | # Routines for generating build report.\r |
| | 3 | #\r |
| | 4 | # This module contains the functionality to generate build report after\r |
| | 5 | # build all target completes successfully.\r |
| | 6 | #\r |
| | 7 | # Copyright (c) 2010 - 2017, Intel Corporation. All rights reserved.<BR>\r |
| | 8 | # This program and the accompanying materials\r |
| | 9 | # are licensed and made available under the terms and conditions of the BSD License\r |
| | 10 | # which accompanies this distribution. The full text of the license may be found at\r |
| | 11 | # http://opensource.org/licenses/bsd-license.php\r |
| | 12 | #\r |
| | 13 | # THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r |
| | 14 | # WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r |
| | 15 | #\r |
| | 16 | \r |
| | 17 | ## Import Modules\r |
| | 18 | #\r |
| | 19 | import Common.LongFilePathOs as os\r |
| | 20 | import re\r |
| | 21 | import platform\r |
| | 22 | import textwrap\r |
| | 23 | import traceback\r |
| | 24 | import sys\r |
| | 25 | import time\r |
| | 26 | import struct\r |
| | 27 | import hashlib\r |
| | 28 | import subprocess\r |
| | 29 | import threading\r |
| | 30 | from datetime import datetime\r |
| | 31 | from StringIO import StringIO\r |
| | 32 | from Common import EdkLogger\r |
| | 33 | from Common.Misc import SaveFileOnChange\r |
| | 34 | from Common.Misc import GuidStructureByteArrayToGuidString\r |
| | 35 | from Common.Misc import GuidStructureStringToGuidString\r |
| | 36 | from Common.InfClassObject import gComponentType2ModuleType\r |
| | 37 | from Common.BuildToolError import FILE_WRITE_FAILURE\r |
| | 38 | from Common.BuildToolError import CODE_ERROR\r |
| | 39 | from Common.BuildToolError import COMMAND_FAILURE\r |
| | 40 | from Common.DataType import TAB_LINE_BREAK\r |
| | 41 | from Common.DataType import TAB_DEPEX\r |
| | 42 | from Common.DataType import TAB_SLASH\r |
| | 43 | from Common.DataType import TAB_SPACE_SPLIT\r |
| | 44 | from Common.DataType import TAB_BRG_PCD\r |
| | 45 | from Common.DataType import TAB_BRG_LIBRARY\r |
| | 46 | from Common.DataType import TAB_BACK_SLASH\r |
| | 47 | from Common.LongFilePathSupport import OpenLongFilePath as open\r |
| | 48 | from Common.MultipleWorkspace import MultipleWorkspace as mws\r |
| | 49 | import Common.GlobalData as GlobalData\r |
| | 50 | from AutoGen.AutoGen import ModuleAutoGen\r |
| | 51 | from Common.Misc import PathClass\r |
| | 52 | from Common.String import NormPath\r |
| | 53 | \r |
| | 54 | ## Pattern to extract contents in EDK DXS files\r |
| | 55 | gDxsDependencyPattern = re.compile(r"DEPENDENCY_START(.+)DEPENDENCY_END", re.DOTALL)\r |
| | 56 | \r |
| | 57 | ## Pattern to find total FV total size, occupied size in flash report intermediate file\r |
| | 58 | gFvTotalSizePattern = re.compile(r"EFI_FV_TOTAL_SIZE = (0x[0-9a-fA-F]+)")\r |
| | 59 | gFvTakenSizePattern = re.compile(r"EFI_FV_TAKEN_SIZE = (0x[0-9a-fA-F]+)")\r |
| | 60 | \r |
| | 61 | ## Pattern to find module size and time stamp in module summary report intermediate file\r |
| | 62 | gModuleSizePattern = re.compile(r"MODULE_SIZE = (\d+)")\r |
| | 63 | gTimeStampPattern = re.compile(r"TIME_STAMP = (\d+)")\r |
| | 64 | \r |
| | 65 | ## Pattern to find GUID value in flash description files\r |
| | 66 | gPcdGuidPattern = re.compile(r"PCD\((\w+)[.](\w+)\)")\r |
| | 67 | \r |
| | 68 | ## Pattern to collect offset, GUID value pair in the flash report intermediate file\r |
| | 69 | gOffsetGuidPattern = re.compile(r"(0x[0-9A-Fa-f]+) ([-A-Fa-f0-9]+)")\r |
| | 70 | \r |
| | 71 | ## Pattern to find module base address and entry point in fixed flash map file\r |
| | 72 | gModulePattern = r"\n[-\w]+\s*\(([^,]+),\s*BaseAddress=%(Address)s,\s*EntryPoint=%(Address)s\)\s*\(GUID=([-0-9A-Fa-f]+)[^)]*\)"\r |
| | 73 | gMapFileItemPattern = re.compile(gModulePattern % {"Address" : "(-?0[xX][0-9A-Fa-f]+)"})\r |
| | 74 | \r |
| | 75 | ## Pattern to find all module referenced header files in source files\r |
| | 76 | gIncludePattern = re.compile(r'#include\s*["<]([^">]+)[">]')\r |
| | 77 | gIncludePattern2 = re.compile(r"#include\s+EFI_([A-Z_]+)\s*[(]\s*(\w+)\s*[)]")\r |
| | 78 | \r |
| | 79 | ## Pattern to find the entry point for EDK module using EDKII Glue library\r |
| | 80 | gGlueLibEntryPoint = re.compile(r"__EDKII_GLUE_MODULE_ENTRY_POINT__\s*=\s*(\w+)")\r |
| | 81 | \r |
| | 82 | ## Tags for MaxLength of line in report\r |
| | 83 | gLineMaxLength = 120\r |
| | 84 | \r |
| | 85 | ## Tags for end of line in report\r |
| | 86 | gEndOfLine = "\r\n"\r |
| | 87 | \r |
| | 88 | ## Tags for section start, end and separator\r |
| | 89 | gSectionStart = ">" + "=" * (gLineMaxLength - 2) + "<"\r |
| | 90 | gSectionEnd = "<" + "=" * (gLineMaxLength - 2) + ">" + "\n"\r |
| | 91 | gSectionSep = "=" * gLineMaxLength\r |
| | 92 | \r |
| | 93 | ## Tags for subsection start, end and separator\r |
| | 94 | gSubSectionStart = ">" + "-" * (gLineMaxLength - 2) + "<"\r |
| | 95 | gSubSectionEnd = "<" + "-" * (gLineMaxLength - 2) + ">"\r |
| | 96 | gSubSectionSep = "-" * gLineMaxLength\r |
| | 97 | \r |
| | 98 | \r |
| | 99 | ## The look up table to map PCD type to pair of report display type and DEC type\r |
| | 100 | gPcdTypeMap = {\r |
| | 101 | 'FixedAtBuild' : ('FIXED', 'FixedAtBuild'),\r |
| | 102 | 'PatchableInModule': ('PATCH', 'PatchableInModule'),\r |
| | 103 | 'FeatureFlag' : ('FLAG', 'FeatureFlag'),\r |
| | 104 | 'Dynamic' : ('DYN', 'Dynamic'),\r |
| | 105 | 'DynamicHii' : ('DYNHII', 'Dynamic'),\r |
| | 106 | 'DynamicVpd' : ('DYNVPD', 'Dynamic'),\r |
| | 107 | 'DynamicEx' : ('DEX', 'DynamicEx'),\r |
| | 108 | 'DynamicExHii' : ('DEXHII', 'DynamicEx'),\r |
| | 109 | 'DynamicExVpd' : ('DEXVPD', 'DynamicEx'),\r |
| | 110 | }\r |
| | 111 | \r |
| | 112 | ## The look up table to map module type to driver type\r |
| | 113 | gDriverTypeMap = {\r |
| | 114 | 'SEC' : '0x3 (SECURITY_CORE)',\r |
| | 115 | 'PEI_CORE' : '0x4 (PEI_CORE)',\r |
| | 116 | 'PEIM' : '0x6 (PEIM)',\r |
| | 117 | 'DXE_CORE' : '0x5 (DXE_CORE)',\r |
| | 118 | 'DXE_DRIVER' : '0x7 (DRIVER)',\r |
| | 119 | 'DXE_SAL_DRIVER' : '0x7 (DRIVER)',\r |
| | 120 | 'DXE_SMM_DRIVER' : '0x7 (DRIVER)',\r |
| | 121 | 'DXE_RUNTIME_DRIVER': '0x7 (DRIVER)',\r |
| | 122 | 'UEFI_DRIVER' : '0x7 (DRIVER)',\r |
| | 123 | 'UEFI_APPLICATION' : '0x9 (APPLICATION)',\r |
| | 124 | 'SMM_CORE' : '0xD (SMM_CORE)',\r |
| | 125 | 'SMM_DRIVER' : '0xA (SMM)', # Extension of module type to support PI 1.1 SMM drivers\r |
| | 126 | 'MM_STANDALONE' : '0xE (MM_STANDALONE)',\r |
| | 127 | 'MM_CORE_STANDALONE' : '0xF (MM_CORE_STANDALONE)'\r |
| | 128 | }\r |
| | 129 | \r |
| | 130 | ## The look up table of the supported opcode in the dependency expression binaries\r |
| | 131 | gOpCodeList = ["BEFORE", "AFTER", "PUSH", "AND", "OR", "NOT", "TRUE", "FALSE", "END", "SOR"]\r |
| | 132 | \r |
| | 133 | ##\r |
| | 134 | # Writes a string to the file object.\r |
| | 135 | #\r |
| | 136 | # This function writes a string to the file object and a new line is appended\r |
| | 137 | # afterwards. It may optionally wraps the string for better readability.\r |
| | 138 | #\r |
| | 139 | # @File The file object to write\r |
| | 140 | # @String The string to be written to the file\r |
| | 141 | # @Wrapper Indicates whether to wrap the string\r |
| | 142 | #\r |
| | 143 | def FileWrite(File, String, Wrapper=False):\r |
| | 144 | if Wrapper:\r |
| | 145 | String = textwrap.fill(String, 120)\r |
| | 146 | File.write(String + gEndOfLine)\r |
| | 147 | \r |
| | 148 | ##\r |
| | 149 | # Find all the header file that the module source directly includes.\r |
| | 150 | #\r |
| | 151 | # This function scans source code to find all header files the module may\r |
| | 152 | # include. This is not accurate but very effective to find all the header\r |
| | 153 | # file the module might include with #include statement.\r |
| | 154 | #\r |
| | 155 | # @Source The source file name\r |
| | 156 | # @IncludePathList The list of include path to find the source file.\r |
| | 157 | # @IncludeFiles The dictionary of current found include files.\r |
| | 158 | #\r |
| | 159 | def FindIncludeFiles(Source, IncludePathList, IncludeFiles):\r |
| | 160 | FileContents = open(Source).read()\r |
| | 161 | #\r |
| | 162 | # Find header files with pattern #include "XXX.h" or #include <XXX.h>\r |
| | 163 | #\r |
| | 164 | for Match in gIncludePattern.finditer(FileContents):\r |
| | 165 | FileName = Match.group(1).strip()\r |
| | 166 | for Dir in [os.path.dirname(Source)] + IncludePathList:\r |
| | 167 | FullFileName = os.path.normpath(os.path.join(Dir, FileName))\r |
| | 168 | if os.path.exists(FullFileName):\r |
| | 169 | IncludeFiles[FullFileName.lower().replace("\\", "/")] = FullFileName\r |
| | 170 | break\r |
| | 171 | \r |
| | 172 | #\r |
| | 173 | # Find header files with pattern like #include EFI_PPI_CONSUMER(XXX)\r |
| | 174 | #\r |
| | 175 | for Match in gIncludePattern2.finditer(FileContents):\r |
| | 176 | Key = Match.group(2)\r |
| | 177 | Type = Match.group(1)\r |
| | 178 | if "ARCH_PROTOCOL" in Type:\r |
| | 179 | FileName = "ArchProtocol/%(Key)s/%(Key)s.h" % {"Key" : Key}\r |
| | 180 | elif "PROTOCOL" in Type:\r |
| | 181 | FileName = "Protocol/%(Key)s/%(Key)s.h" % {"Key" : Key}\r |
| | 182 | elif "PPI" in Type:\r |
| | 183 | FileName = "Ppi/%(Key)s/%(Key)s.h" % {"Key" : Key}\r |
| | 184 | elif "GUID" in Type:\r |
| | 185 | FileName = "Guid/%(Key)s/%(Key)s.h" % {"Key" : Key}\r |
| | 186 | else:\r |
| | 187 | continue\r |
| | 188 | for Dir in IncludePathList:\r |
| | 189 | FullFileName = os.path.normpath(os.path.join(Dir, FileName))\r |
| | 190 | if os.path.exists(FullFileName):\r |
| | 191 | IncludeFiles[FullFileName.lower().replace("\\", "/")] = FullFileName\r |
| | 192 | break\r |
| | 193 | \r |
| | 194 | ## Split each lines in file\r |
| | 195 | #\r |
| | 196 | # This method is used to split the lines in file to make the length of each line \r |
| | 197 | # less than MaxLength.\r |
| | 198 | #\r |
| | 199 | # @param Content The content of file\r |
| | 200 | # @param MaxLength The Max Length of the line\r |
| | 201 | #\r |
| | 202 | def FileLinesSplit(Content=None, MaxLength=None):\r |
| | 203 | ContentList = Content.split(TAB_LINE_BREAK)\r |
| | 204 | NewContent = ''\r |
| | 205 | NewContentList = []\r |
| | 206 | for Line in ContentList:\r |
| | 207 | while len(Line.rstrip()) > MaxLength:\r |
| | 208 | LineSpaceIndex = Line.rfind(TAB_SPACE_SPLIT, 0, MaxLength)\r |
| | 209 | LineSlashIndex = Line.rfind(TAB_SLASH, 0, MaxLength)\r |
| | 210 | LineBackSlashIndex = Line.rfind(TAB_BACK_SLASH, 0, MaxLength)\r |
| | 211 | if max(LineSpaceIndex, LineSlashIndex, LineBackSlashIndex) > 0:\r |
| | 212 | LineBreakIndex = max(LineSpaceIndex, LineSlashIndex, LineBackSlashIndex)\r |
| | 213 | else:\r |
| | 214 | LineBreakIndex = MaxLength\r |
| | 215 | NewContentList.append(Line[:LineBreakIndex])\r |
| | 216 | Line = Line[LineBreakIndex:]\r |
| | 217 | if Line:\r |
| | 218 | NewContentList.append(Line)\r |
| | 219 | for NewLine in NewContentList:\r |
| | 220 | NewContent += NewLine + TAB_LINE_BREAK\r |
| | 221 | \r |
| | 222 | NewContent = NewContent.replace(TAB_LINE_BREAK, gEndOfLine).replace('\r\r\n', gEndOfLine)\r |
| | 223 | return NewContent\r |
| | 224 | \r |
| | 225 | \r |
| | 226 | \r |
| | 227 | ##\r |
| | 228 | # Parse binary dependency expression section\r |
| | 229 | #\r |
| | 230 | # This utility class parses the dependency expression section and translate the readable\r |
| | 231 | # GUID name and value.\r |
| | 232 | #\r |
| | 233 | class DepexParser(object):\r |
| | 234 | ##\r |
| | 235 | # Constructor function for class DepexParser\r |
| | 236 | #\r |
| | 237 | # This constructor function collect GUID values so that the readable\r |
| | 238 | # GUID name can be translated.\r |
| | 239 | #\r |
| | 240 | # @param self The object pointer\r |
| | 241 | # @param Wa Workspace context information\r |
| | 242 | #\r |
| | 243 | def __init__(self, Wa):\r |
| | 244 | self._GuidDb = {}\r |
| | 245 | for Pa in Wa.AutoGenObjectList:\r |
| | 246 | for Package in Pa.PackageList:\r |
| | 247 | for Protocol in Package.Protocols:\r |
| | 248 | GuidValue = GuidStructureStringToGuidString(Package.Protocols[Protocol])\r |
| | 249 | self._GuidDb[GuidValue.upper()] = Protocol\r |
| | 250 | for Ppi in Package.Ppis:\r |
| | 251 | GuidValue = GuidStructureStringToGuidString(Package.Ppis[Ppi])\r |
| | 252 | self._GuidDb[GuidValue.upper()] = Ppi\r |
| | 253 | for Guid in Package.Guids:\r |
| | 254 | GuidValue = GuidStructureStringToGuidString(Package.Guids[Guid])\r |
| | 255 | self._GuidDb[GuidValue.upper()] = Guid\r |
| | 256 | \r |
| | 257 | ##\r |
| | 258 | # Parse the binary dependency expression files.\r |
| | 259 | # \r |
| | 260 | # This function parses the binary dependency expression file and translate it\r |
| | 261 | # to the instruction list.\r |
| | 262 | #\r |
| | 263 | # @param self The object pointer\r |
| | 264 | # @param DepexFileName The file name of binary dependency expression file.\r |
| | 265 | #\r |
| | 266 | def ParseDepexFile(self, DepexFileName):\r |
| | 267 | DepexFile = open(DepexFileName, "rb")\r |
| | 268 | DepexStatement = []\r |
| | 269 | OpCode = DepexFile.read(1)\r |
| | 270 | while OpCode:\r |
| | 271 | Statement = gOpCodeList[struct.unpack("B", OpCode)[0]]\r |
| | 272 | if Statement in ["BEFORE", "AFTER", "PUSH"]:\r |
| | 273 | GuidValue = "%08X-%04X-%04X-%02X%02X-%02X%02X%02X%02X%02X%02X" % \\r |
| | 274 | struct.unpack("=LHHBBBBBBBB", DepexFile.read(16))\r |
| | 275 | GuidString = self._GuidDb.get(GuidValue, GuidValue)\r |
| | 276 | Statement = "%s %s" % (Statement, GuidString)\r |
| | 277 | DepexStatement.append(Statement)\r |
| | 278 | OpCode = DepexFile.read(1)\r |
| | 279 | \r |
| | 280 | return DepexStatement\r |
| | 281 | \r |
| | 282 | ##\r |
| | 283 | # Reports library information\r |
| | 284 | #\r |
| | 285 | # This class reports the module library subsection in the build report file.\r |
| | 286 | #\r |
| | 287 | class LibraryReport(object):\r |
| | 288 | ##\r |
| | 289 | # Constructor function for class LibraryReport\r |
| | 290 | #\r |
| | 291 | # This constructor function generates LibraryReport object for\r |
| | 292 | # a module.\r |
| | 293 | #\r |
| | 294 | # @param self The object pointer\r |
| | 295 | # @param M Module context information\r |
| | 296 | #\r |
| | 297 | def __init__(self, M):\r |
| | 298 | self.LibraryList = []\r |
| | 299 | if int(str(M.AutoGenVersion), 0) >= 0x00010005:\r |
| | 300 | self._EdkIIModule = True\r |
| | 301 | else:\r |
| | 302 | self._EdkIIModule = False\r |
| | 303 | \r |
| | 304 | for Lib in M.DependentLibraryList:\r |
| | 305 | LibInfPath = str(Lib)\r |
| | 306 | LibClassList = Lib.LibraryClass[0].LibraryClass\r |
| | 307 | LibConstructorList = Lib.ConstructorList\r |
| | 308 | LibDesstructorList = Lib.DestructorList\r |
| | 309 | LibDepexList = Lib.DepexExpression[M.Arch, M.ModuleType]\r |
| | 310 | self.LibraryList.append((LibInfPath, LibClassList, LibConstructorList, LibDesstructorList, LibDepexList))\r |
| | 311 | \r |
| | 312 | ##\r |
| | 313 | # Generate report for module library information\r |
| | 314 | #\r |
| | 315 | # This function generates report for the module library.\r |
| | 316 | # If the module is EDKII style one, the additional library class, library\r |
| | 317 | # constructor/destructor and dependency expression may also be reported.\r |
| | 318 | #\r |
| | 319 | # @param self The object pointer\r |
| | 320 | # @param File The file object for report\r |
| | 321 | #\r |
| | 322 | def GenerateReport(self, File):\r |
| | 323 | if len(self.LibraryList) > 0:\r |
| | 324 | FileWrite(File, gSubSectionStart)\r |
| | 325 | FileWrite(File, TAB_BRG_LIBRARY)\r |
| | 326 | FileWrite(File, gSubSectionSep)\r |
| | 327 | for LibraryItem in self.LibraryList:\r |
| | 328 | LibInfPath = LibraryItem[0]\r |
| | 329 | FileWrite(File, LibInfPath)\r |
| | 330 | \r |
| | 331 | #\r |
| | 332 | # Report library class, library constructor and destructor for\r |
| | 333 | # EDKII style module.\r |
| | 334 | #\r |
| | 335 | if self._EdkIIModule:\r |
| | 336 | LibClass = LibraryItem[1]\r |
| | 337 | EdkIILibInfo = ""\r |
| | 338 | LibConstructor = " ".join(LibraryItem[2])\r |
| | 339 | if LibConstructor:\r |
| | 340 | EdkIILibInfo += " C = " + LibConstructor\r |
| | 341 | LibDestructor = " ".join(LibraryItem[3])\r |
| | 342 | if LibDestructor:\r |
| | 343 | EdkIILibInfo += " D = " + LibDestructor\r |
| | 344 | LibDepex = " ".join(LibraryItem[4])\r |
| | 345 | if LibDepex:\r |
| | 346 | EdkIILibInfo += " Depex = " + LibDepex\r |
| | 347 | if EdkIILibInfo:\r |
| | 348 | FileWrite(File, "{%s: %s}" % (LibClass, EdkIILibInfo))\r |
| | 349 | else:\r |
| | 350 | FileWrite(File, "{%s}" % LibClass)\r |
| | 351 | \r |
| | 352 | FileWrite(File, gSubSectionEnd)\r |
| | 353 | \r |
| | 354 | ##\r |
| | 355 | # Reports dependency expression information\r |
| | 356 | #\r |
| | 357 | # This class reports the module dependency expression subsection in the build report file.\r |
| | 358 | #\r |
| | 359 | class DepexReport(object):\r |
| | 360 | ##\r |
| | 361 | # Constructor function for class DepexReport\r |
| | 362 | #\r |
| | 363 | # This constructor function generates DepexReport object for\r |
| | 364 | # a module. If the module source contains the DXS file (usually EDK\r |
| | 365 | # style module), it uses the dependency in DXS file; otherwise,\r |
| | 366 | # it uses the dependency expression from its own INF [Depex] section\r |
| | 367 | # and then merges with the ones from its dependent library INF.\r |
| | 368 | #\r |
| | 369 | # @param self The object pointer\r |
| | 370 | # @param M Module context information\r |
| | 371 | #\r |
| | 372 | def __init__(self, M):\r |
| | 373 | self.Depex = ""\r |
| | 374 | self._DepexFileName = os.path.join(M.BuildDir, "OUTPUT", M.Module.BaseName + ".depex")\r |
| | 375 | ModuleType = M.ModuleType\r |
| | 376 | if not ModuleType:\r |
| | 377 | ModuleType = gComponentType2ModuleType.get(M.ComponentType, "")\r |
| | 378 | \r |
| | 379 | if ModuleType in ["SEC", "PEI_CORE", "DXE_CORE", "SMM_CORE", "MM_CORE_STANDALONE", "UEFI_APPLICATION"]:\r |
| | 380 | return\r |
| | 381 | \r |
| | 382 | for Source in M.SourceFileList:\r |
| | 383 | if os.path.splitext(Source.Path)[1].lower() == ".dxs":\r |
| | 384 | Match = gDxsDependencyPattern.search(open(Source.Path).read())\r |
| | 385 | if Match:\r |
| | 386 | self.Depex = Match.group(1).strip()\r |
| | 387 | self.Source = "DXS"\r |
| | 388 | break\r |
| | 389 | else:\r |
| | 390 | self.Depex = M.DepexExpressionList.get(M.ModuleType, "")\r |
| | 391 | self.ModuleDepex = " ".join(M.Module.DepexExpression[M.Arch, M.ModuleType])\r |
| | 392 | if not self.ModuleDepex:\r |
| | 393 | self.ModuleDepex = "(None)"\r |
| | 394 | \r |
| | 395 | LibDepexList = []\r |
| | 396 | for Lib in M.DependentLibraryList:\r |
| | 397 | LibDepex = " ".join(Lib.DepexExpression[M.Arch, M.ModuleType]).strip()\r |
| | 398 | if LibDepex != "":\r |
| | 399 | LibDepexList.append("(" + LibDepex + ")")\r |
| | 400 | self.LibraryDepex = " AND ".join(LibDepexList)\r |
| | 401 | if not self.LibraryDepex:\r |
| | 402 | self.LibraryDepex = "(None)"\r |
| | 403 | self.Source = "INF"\r |
| | 404 | \r |
| | 405 | ##\r |
| | 406 | # Generate report for module dependency expression information\r |
| | 407 | #\r |
| | 408 | # This function generates report for the module dependency expression.\r |
| | 409 | #\r |
| | 410 | # @param self The object pointer\r |
| | 411 | # @param File The file object for report\r |
| | 412 | # @param GlobalDepexParser The platform global Dependency expression parser object\r |
| | 413 | #\r |
| | 414 | def GenerateReport(self, File, GlobalDepexParser):\r |
| | 415 | if not self.Depex:\r |
| | 416 | return\r |
| | 417 | FileWrite(File, gSubSectionStart)\r |
| | 418 | if os.path.isfile(self._DepexFileName):\r |
| | 419 | try:\r |
| | 420 | DepexStatements = GlobalDepexParser.ParseDepexFile(self._DepexFileName)\r |
| | 421 | FileWrite(File, "Final Dependency Expression (DEPEX) Instructions")\r |
| | 422 | for DepexStatement in DepexStatements:\r |
| | 423 | FileWrite(File, " %s" % DepexStatement)\r |
| | 424 | FileWrite(File, gSubSectionSep)\r |
| | 425 | except:\r |
| | 426 | EdkLogger.warn(None, "Dependency expression file is corrupted", self._DepexFileName)\r |
| | 427 | \r |
| | 428 | FileWrite(File, "Dependency Expression (DEPEX) from %s" % self.Source)\r |
| | 429 | \r |
| | 430 | if self.Source == "INF":\r |
| | 431 | FileWrite(File, "%s" % self.Depex, True)\r |
| | 432 | FileWrite(File, gSubSectionSep)\r |
| | 433 | FileWrite(File, "From Module INF: %s" % self.ModuleDepex, True)\r |
| | 434 | FileWrite(File, "From Library INF: %s" % self.LibraryDepex, True)\r |
| | 435 | else:\r |
| | 436 | FileWrite(File, "%s" % self.Depex)\r |
| | 437 | FileWrite(File, gSubSectionEnd)\r |
| | 438 | \r |
| | 439 | ##\r |
| | 440 | # Reports dependency expression information\r |
| | 441 | #\r |
| | 442 | # This class reports the module build flags subsection in the build report file.\r |
| | 443 | #\r |
| | 444 | class BuildFlagsReport(object):\r |
| | 445 | ##\r |
| | 446 | # Constructor function for class BuildFlagsReport\r |
| | 447 | #\r |
| | 448 | # This constructor function generates BuildFlagsReport object for\r |
| | 449 | # a module. It reports the build tool chain tag and all relevant\r |
| | 450 | # build flags to build the module.\r |
| | 451 | #\r |
| | 452 | # @param self The object pointer\r |
| | 453 | # @param M Module context information\r |
| | 454 | #\r |
| | 455 | def __init__(self, M):\r |
| | 456 | BuildOptions = {}\r |
| | 457 | #\r |
| | 458 | # Add build flags according to source file extension so that\r |
| | 459 | # irrelevant ones can be filtered out.\r |
| | 460 | #\r |
| | 461 | for Source in M.SourceFileList:\r |
| | 462 | Ext = os.path.splitext(Source.File)[1].lower()\r |
| | 463 | if Ext in [".c", ".cc", ".cpp"]:\r |
| | 464 | BuildOptions["CC"] = 1\r |
| | 465 | elif Ext in [".s", ".asm"]:\r |
| | 466 | BuildOptions["PP"] = 1\r |
| | 467 | BuildOptions["ASM"] = 1\r |
| | 468 | elif Ext in [".vfr"]:\r |
| | 469 | BuildOptions["VFRPP"] = 1\r |
| | 470 | BuildOptions["VFR"] = 1\r |
| | 471 | elif Ext in [".dxs"]:\r |
| | 472 | BuildOptions["APP"] = 1\r |
| | 473 | BuildOptions["CC"] = 1\r |
| | 474 | elif Ext in [".asl"]:\r |
| | 475 | BuildOptions["ASLPP"] = 1\r |
| | 476 | BuildOptions["ASL"] = 1\r |
| | 477 | elif Ext in [".aslc"]:\r |
| | 478 | BuildOptions["ASLCC"] = 1\r |
| | 479 | BuildOptions["ASLDLINK"] = 1\r |
| | 480 | BuildOptions["CC"] = 1\r |
| | 481 | elif Ext in [".asm16"]:\r |
| | 482 | BuildOptions["ASMLINK"] = 1\r |
| | 483 | BuildOptions["SLINK"] = 1\r |
| | 484 | BuildOptions["DLINK"] = 1\r |
| | 485 | \r |
| | 486 | #\r |
| | 487 | # Save module build flags.\r |
| | 488 | #\r |
| | 489 | self.ToolChainTag = M.ToolChain\r |
| | 490 | self.BuildFlags = {}\r |
| | 491 | for Tool in BuildOptions:\r |
| | 492 | self.BuildFlags[Tool + "_FLAGS"] = M.BuildOption.get(Tool, {}).get("FLAGS", "")\r |
| | 493 | \r |
| | 494 | ##\r |
| | 495 | # Generate report for module build flags information\r |
| | 496 | #\r |
| | 497 | # This function generates report for the module build flags expression.\r |
| | 498 | #\r |
| | 499 | # @param self The object pointer\r |
| | 500 | # @param File The file object for report\r |
| | 501 | #\r |
| | 502 | def GenerateReport(self, File):\r |
| | 503 | FileWrite(File, gSubSectionStart)\r |
| | 504 | FileWrite(File, "Build Flags")\r |
| | 505 | FileWrite(File, "Tool Chain Tag: %s" % self.ToolChainTag)\r |
| | 506 | for Tool in self.BuildFlags:\r |
| | 507 | FileWrite(File, gSubSectionSep)\r |
| | 508 | FileWrite(File, "%s = %s" % (Tool, self.BuildFlags[Tool]), True)\r |
| | 509 | \r |
| | 510 | FileWrite(File, gSubSectionEnd)\r |
| | 511 | \r |
| | 512 | \r |
| | 513 | ##\r |
| | 514 | # Reports individual module information\r |
| | 515 | #\r |
| | 516 | # This class reports the module section in the build report file.\r |
| | 517 | # It comprises of module summary, module PCD, library, dependency expression,\r |
| | 518 | # build flags sections.\r |
| | 519 | #\r |
| | 520 | class ModuleReport(object):\r |
| | 521 | ##\r |
| | 522 | # Constructor function for class ModuleReport\r |
| | 523 | #\r |
| | 524 | # This constructor function generates ModuleReport object for\r |
| | 525 | # a separate module in a platform build.\r |
| | 526 | #\r |
| | 527 | # @param self The object pointer\r |
| | 528 | # @param M Module context information\r |
| | 529 | # @param ReportType The kind of report items in the final report file\r |
| | 530 | #\r |
| | 531 | def __init__(self, M, ReportType):\r |
| | 532 | self.ModuleName = M.Module.BaseName\r |
| | 533 | self.ModuleInfPath = M.MetaFile.File\r |
| | 534 | self.FileGuid = M.Guid\r |
| | 535 | self.Size = 0\r |
| | 536 | self.BuildTimeStamp = None\r |
| | 537 | self.Hash = 0\r |
| | 538 | self.DriverType = ""\r |
| | 539 | if not M.IsLibrary:\r |
| | 540 | ModuleType = M.ModuleType\r |
| | 541 | if not ModuleType:\r |
| | 542 | ModuleType = gComponentType2ModuleType.get(M.ComponentType, "")\r |
| | 543 | #\r |
| | 544 | # If a module complies to PI 1.1, promote Module type to "SMM_DRIVER"\r |
| | 545 | #\r |
| | 546 | if ModuleType == "DXE_SMM_DRIVER":\r |
| | 547 | PiSpec = M.Module.Specification.get("PI_SPECIFICATION_VERSION", "0x00010000")\r |
| | 548 | if int(PiSpec, 0) >= 0x0001000A:\r |
| | 549 | ModuleType = "SMM_DRIVER"\r |
| | 550 | self.DriverType = gDriverTypeMap.get(ModuleType, "0x2 (FREE_FORM)")\r |
| | 551 | self.UefiSpecVersion = M.Module.Specification.get("UEFI_SPECIFICATION_VERSION", "")\r |
| | 552 | self.PiSpecVersion = M.Module.Specification.get("PI_SPECIFICATION_VERSION", "")\r |
| | 553 | self.PciDeviceId = M.Module.Defines.get("PCI_DEVICE_ID", "")\r |
| | 554 | self.PciVendorId = M.Module.Defines.get("PCI_VENDOR_ID", "")\r |
| | 555 | self.PciClassCode = M.Module.Defines.get("PCI_CLASS_CODE", "")\r |
| | 556 | \r |
| | 557 | self._BuildDir = M.BuildDir\r |
| | 558 | self.ModulePcdSet = {}\r |
| | 559 | if "PCD" in ReportType:\r |
| | 560 | #\r |
| | 561 | # Collect all module used PCD set: module INF referenced directly or indirectly.\r |
| | 562 | # It also saves module INF default values of them in case they exist.\r |
| | 563 | #\r |
| | 564 | for Pcd in M.ModulePcdList + M.LibraryPcdList:\r |
| | 565 | self.ModulePcdSet.setdefault((Pcd.TokenCName, Pcd.TokenSpaceGuidCName, Pcd.Type), (Pcd.InfDefaultValue, Pcd.DefaultValue))\r |
| | 566 | \r |
| | 567 | self.LibraryReport = None\r |
| | 568 | if "LIBRARY" in ReportType:\r |
| | 569 | self.LibraryReport = LibraryReport(M)\r |
| | 570 | \r |
| | 571 | self.DepexReport = None\r |
| | 572 | if "DEPEX" in ReportType:\r |
| | 573 | self.DepexReport = DepexReport(M)\r |
| | 574 | \r |
| | 575 | if "BUILD_FLAGS" in ReportType:\r |
| | 576 | self.BuildFlagsReport = BuildFlagsReport(M)\r |
| | 577 | \r |
| | 578 | \r |
| | 579 | ##\r |
| | 580 | # Generate report for module information\r |
| | 581 | #\r |
| | 582 | # This function generates report for separate module expression\r |
| | 583 | # in a platform build.\r |
| | 584 | #\r |
| | 585 | # @param self The object pointer\r |
| | 586 | # @param File The file object for report\r |
| | 587 | # @param GlobalPcdReport The platform global PCD report object\r |
| | 588 | # @param GlobalPredictionReport The platform global Prediction report object\r |
| | 589 | # @param GlobalDepexParser The platform global Dependency expression parser object\r |
| | 590 | # @param ReportType The kind of report items in the final report file\r |
| | 591 | #\r |
| | 592 | def GenerateReport(self, File, GlobalPcdReport, GlobalPredictionReport, GlobalDepexParser, ReportType):\r |
| | 593 | FileWrite(File, gSectionStart)\r |
| | 594 | \r |
| | 595 | FwReportFileName = os.path.join(self._BuildDir, "DEBUG", self.ModuleName + ".txt")\r |
| | 596 | if os.path.isfile(FwReportFileName):\r |
| | 597 | try:\r |
| | 598 | FileContents = open(FwReportFileName).read()\r |
| | 599 | Match = gModuleSizePattern.search(FileContents)\r |
| | 600 | if Match:\r |
| | 601 | self.Size = int(Match.group(1))\r |
| | 602 | \r |
| | 603 | Match = gTimeStampPattern.search(FileContents)\r |
| | 604 | if Match:\r |
| | 605 | self.BuildTimeStamp = datetime.fromtimestamp(int(Match.group(1)))\r |
| | 606 | except IOError:\r |
| | 607 | EdkLogger.warn(None, "Fail to read report file", FwReportFileName)\r |
| | 608 | \r |
| | 609 | if "HASH" in ReportType:\r |
| | 610 | OutputDir = os.path.join(self._BuildDir, "OUTPUT")\r |
| | 611 | DefaultEFIfile = os.path.join(OutputDir, self.ModuleName + ".efi")\r |
| | 612 | if os.path.isfile(DefaultEFIfile):\r |
| | 613 | Tempfile = os.path.join(OutputDir, self.ModuleName + "_hash.tmp")\r |
| | 614 | # rebase the efi image since its base address may not zero\r |
| | 615 | cmd = ["GenFw", "--rebase", str(0), "-o", Tempfile, DefaultEFIfile]\r |
| | 616 | try:\r |
| | 617 | PopenObject = subprocess.Popen(' '.join(cmd), stdout=subprocess.PIPE, stderr=subprocess.PIPE, shell=True)\r |
| | 618 | except Exception, X:\r |
| | 619 | EdkLogger.error("GenFw", COMMAND_FAILURE, ExtraData="%s: %s" % (str(X), cmd[0]))\r |
| | 620 | EndOfProcedure = threading.Event()\r |
| | 621 | EndOfProcedure.clear()\r |
| | 622 | if PopenObject.stderr:\r |
| | 623 | StdErrThread = threading.Thread(target=ReadMessage, args=(PopenObject.stderr, EdkLogger.quiet, EndOfProcedure))\r |
| | 624 | StdErrThread.setName("STDERR-Redirector")\r |
| | 625 | StdErrThread.setDaemon(False)\r |
| | 626 | StdErrThread.start()\r |
| | 627 | # waiting for program exit\r |
| | 628 | PopenObject.wait()\r |
| | 629 | if PopenObject.stderr:\r |
| | 630 | StdErrThread.join()\r |
| | 631 | if PopenObject.returncode != 0:\r |
| | 632 | EdkLogger.error("GenFw", COMMAND_FAILURE, "Failed to generate firmware hash image for %s" % (DefaultEFIfile))\r |
| | 633 | if os.path.isfile(Tempfile):\r |
| | 634 | self.Hash = hashlib.sha1()\r |
| | 635 | buf = open(Tempfile, 'rb').read()\r |
| | 636 | if self.Hash.update(buf):\r |
| | 637 | self.Hash = self.Hash.update(buf)\r |
| | 638 | self.Hash = self.Hash.hexdigest()\r |
| | 639 | os.remove(Tempfile)\r |
| | 640 | \r |
| | 641 | FileWrite(File, "Module Summary")\r |
| | 642 | FileWrite(File, "Module Name: %s" % self.ModuleName)\r |
| | 643 | FileWrite(File, "Module INF Path: %s" % self.ModuleInfPath)\r |
| | 644 | FileWrite(File, "File GUID: %s" % self.FileGuid)\r |
| | 645 | if self.Size:\r |
| | 646 | FileWrite(File, "Size: 0x%X (%.2fK)" % (self.Size, self.Size / 1024.0))\r |
| | 647 | if self.Hash:\r |
| | 648 | FileWrite(File, "SHA1 HASH: %s *%s" % (self.Hash, self.ModuleName + ".efi"))\r |
| | 649 | if self.BuildTimeStamp:\r |
| | 650 | FileWrite(File, "Build Time Stamp: %s" % self.BuildTimeStamp)\r |
| | 651 | if self.DriverType:\r |
| | 652 | FileWrite(File, "Driver Type: %s" % self.DriverType)\r |
| | 653 | if self.UefiSpecVersion:\r |
| | 654 | FileWrite(File, "UEFI Spec Version: %s" % self.UefiSpecVersion)\r |
| | 655 | if self.PiSpecVersion:\r |
| | 656 | FileWrite(File, "PI Spec Version: %s" % self.PiSpecVersion)\r |
| | 657 | if self.PciDeviceId:\r |
| | 658 | FileWrite(File, "PCI Device ID: %s" % self.PciDeviceId)\r |
| | 659 | if self.PciVendorId:\r |
| | 660 | FileWrite(File, "PCI Vendor ID: %s" % self.PciVendorId)\r |
| | 661 | if self.PciClassCode:\r |
| | 662 | FileWrite(File, "PCI Class Code: %s" % self.PciClassCode)\r |
| | 663 | \r |
| | 664 | FileWrite(File, gSectionSep)\r |
| | 665 | \r |
| | 666 | if "PCD" in ReportType:\r |
| | 667 | GlobalPcdReport.GenerateReport(File, self.ModulePcdSet)\r |
| | 668 | \r |
| | 669 | if "LIBRARY" in ReportType:\r |
| | 670 | self.LibraryReport.GenerateReport(File)\r |
| | 671 | \r |
| | 672 | if "DEPEX" in ReportType:\r |
| | 673 | self.DepexReport.GenerateReport(File, GlobalDepexParser)\r |
| | 674 | \r |
| | 675 | if "BUILD_FLAGS" in ReportType:\r |
| | 676 | self.BuildFlagsReport.GenerateReport(File)\r |
| | 677 | \r |
| | 678 | if "FIXED_ADDRESS" in ReportType and self.FileGuid:\r |
| | 679 | GlobalPredictionReport.GenerateReport(File, self.FileGuid)\r |
| | 680 | \r |
| | 681 | FileWrite(File, gSectionEnd)\r |
| | 682 | \r |
| | 683 | def ReadMessage(From, To, ExitFlag):\r |
| | 684 | while True:\r |
| | 685 | # read one line a time\r |
| | 686 | Line = From.readline()\r |
| | 687 | # empty string means "end"\r |
| | 688 | if Line != None and Line != "":\r |
| | 689 | To(Line.rstrip())\r |
| | 690 | else:\r |
| | 691 | break\r |
| | 692 | if ExitFlag.isSet():\r |
| | 693 | break\r |
| | 694 | \r |
| | 695 | ##\r |
| | 696 | # Reports platform and module PCD information\r |
| | 697 | #\r |
| | 698 | # This class reports the platform PCD section and module PCD subsection\r |
| | 699 | # in the build report file.\r |
| | 700 | #\r |
| | 701 | class PcdReport(object):\r |
| | 702 | ##\r |
| | 703 | # Constructor function for class PcdReport\r |
| | 704 | #\r |
| | 705 | # This constructor function generates PcdReport object a platform build.\r |
| | 706 | # It collects the whole PCD database from platform DSC files, platform\r |
| | 707 | # flash description file and package DEC files.\r |
| | 708 | #\r |
| | 709 | # @param self The object pointer\r |
| | 710 | # @param Wa Workspace context information\r |
| | 711 | #\r |
| | 712 | def __init__(self, Wa):\r |
| | 713 | self.AllPcds = {}\r |
| | 714 | self.UnusedPcds = {}\r |
| | 715 | self.ConditionalPcds = {}\r |
| | 716 | self.MaxLen = 0\r |
| | 717 | if Wa.FdfProfile:\r |
| | 718 | self.FdfPcdSet = Wa.FdfProfile.PcdDict\r |
| | 719 | else:\r |
| | 720 | self.FdfPcdSet = {}\r |
| | 721 | \r |
| | 722 | self.ModulePcdOverride = {}\r |
| | 723 | for Pa in Wa.AutoGenObjectList:\r |
| | 724 | #\r |
| | 725 | # Collect all platform referenced PCDs and grouped them by PCD token space\r |
| | 726 | # GUID C Names\r |
| | 727 | #\r |
| | 728 | for Pcd in Pa.AllPcdList:\r |
| | 729 | PcdList = self.AllPcds.setdefault(Pcd.TokenSpaceGuidCName, {}).setdefault(Pcd.Type, [])\r |
| | 730 | if Pcd not in PcdList:\r |
| | 731 | PcdList.append(Pcd)\r |
| | 732 | if len(Pcd.TokenCName) > self.MaxLen:\r |
| | 733 | self.MaxLen = len(Pcd.TokenCName)\r |
| | 734 | #\r |
| | 735 | # Collect the PCD defined in DSC/FDF file, but not used in module\r |
| | 736 | #\r |
| | 737 | UnusedPcdFullList = []\r |
| | 738 | for item in Pa.Platform.Pcds:\r |
| | 739 | Pcd = Pa.Platform.Pcds[item]\r |
| | 740 | if not Pcd.Type:\r |
| | 741 | PcdTypeFlag = False\r |
| | 742 | for package in Pa.PackageList:\r |
| | 743 | for T in ["FixedAtBuild", "PatchableInModule", "FeatureFlag", "Dynamic", "DynamicEx"]:\r |
| | 744 | if (Pcd.TokenCName, Pcd.TokenSpaceGuidCName, T) in package.Pcds:\r |
| | 745 | Pcd.Type = T\r |
| | 746 | PcdTypeFlag = True\r |
| | 747 | if not Pcd.DatumType:\r |
| | 748 | Pcd.DatumType = package.Pcds[(Pcd.TokenCName, Pcd.TokenSpaceGuidCName, T)].DatumType\r |
| | 749 | break\r |
| | 750 | if PcdTypeFlag:\r |
| | 751 | break\r |
| | 752 | if not Pcd.DatumType:\r |
| | 753 | PcdType = Pcd.Type\r |
| | 754 | # Try to remove Hii and Vpd suffix\r |
| | 755 | if PcdType.startswith("DynamicEx"):\r |
| | 756 | PcdType = "DynamicEx"\r |
| | 757 | elif PcdType.startswith("Dynamic"):\r |
| | 758 | PcdType = "Dynamic"\r |
| | 759 | for package in Pa.PackageList:\r |
| | 760 | if (Pcd.TokenCName, Pcd.TokenSpaceGuidCName, PcdType) in package.Pcds:\r |
| | 761 | Pcd.DatumType = package.Pcds[(Pcd.TokenCName, Pcd.TokenSpaceGuidCName, PcdType)].DatumType\r |
| | 762 | break\r |
| | 763 | \r |
| | 764 | PcdList = self.AllPcds.setdefault(Pcd.TokenSpaceGuidCName, {}).setdefault(Pcd.Type, [])\r |
| | 765 | if Pcd not in PcdList and Pcd not in UnusedPcdFullList:\r |
| | 766 | UnusedPcdFullList.append(Pcd)\r |
| | 767 | if len(Pcd.TokenCName) > self.MaxLen:\r |
| | 768 | self.MaxLen = len(Pcd.TokenCName)\r |
| | 769 | \r |
| | 770 | if GlobalData.gConditionalPcds:\r |
| | 771 | for PcdItem in GlobalData.gConditionalPcds:\r |
| | 772 | if '.' in PcdItem:\r |
| | 773 | (TokenSpaceGuidCName, TokenCName) = PcdItem.split('.')\r |
| | 774 | if (TokenCName, TokenSpaceGuidCName) in Pa.Platform.Pcds.keys():\r |
| | 775 | Pcd = Pa.Platform.Pcds[(TokenCName, TokenSpaceGuidCName)]\r |
| | 776 | PcdList = self.ConditionalPcds.setdefault(Pcd.TokenSpaceGuidCName, {}).setdefault(Pcd.Type, [])\r |
| | 777 | if Pcd not in PcdList:\r |
| | 778 | PcdList.append(Pcd)\r |
| | 779 | \r |
| | 780 | UnusedPcdList = []\r |
| | 781 | if UnusedPcdFullList:\r |
| | 782 | for Pcd in UnusedPcdFullList:\r |
| | 783 | if Pcd.TokenSpaceGuidCName + '.' + Pcd.TokenCName in GlobalData.gConditionalPcds:\r |
| | 784 | continue\r |
| | 785 | UnusedPcdList.append(Pcd)\r |
| | 786 | \r |
| | 787 | for Pcd in UnusedPcdList:\r |
| | 788 | PcdList = self.UnusedPcds.setdefault(Pcd.TokenSpaceGuidCName, {}).setdefault(Pcd.Type, [])\r |
| | 789 | if Pcd not in PcdList:\r |
| | 790 | PcdList.append(Pcd)\r |
| | 791 | \r |
| | 792 | for Module in Pa.Platform.Modules.values():\r |
| | 793 | #\r |
| | 794 | # Collect module override PCDs\r |
| | 795 | #\r |
| | 796 | for ModulePcd in Module.M.ModulePcdList + Module.M.LibraryPcdList:\r |
| | 797 | TokenCName = ModulePcd.TokenCName\r |
| | 798 | TokenSpaceGuid = ModulePcd.TokenSpaceGuidCName\r |
| | 799 | ModuleDefault = ModulePcd.DefaultValue\r |
| | 800 | ModulePath = os.path.basename(Module.M.MetaFile.File)\r |
| | 801 | self.ModulePcdOverride.setdefault((TokenCName, TokenSpaceGuid), {})[ModulePath] = ModuleDefault\r |
| | 802 | \r |
| | 803 | \r |
| | 804 | #\r |
| | 805 | # Collect PCD DEC default value.\r |
| | 806 | #\r |
| | 807 | self.DecPcdDefault = {}\r |
| | 808 | for Pa in Wa.AutoGenObjectList:\r |
| | 809 | for Package in Pa.PackageList:\r |
| | 810 | for (TokenCName, TokenSpaceGuidCName, DecType) in Package.Pcds:\r |
| | 811 | DecDefaultValue = Package.Pcds[TokenCName, TokenSpaceGuidCName, DecType].DefaultValue\r |
| | 812 | self.DecPcdDefault.setdefault((TokenCName, TokenSpaceGuidCName, DecType), DecDefaultValue)\r |
| | 813 | #\r |
| | 814 | # Collect PCDs defined in DSC common section\r |
| | 815 | #\r |
| | 816 | self.DscPcdDefault = {}\r |
| | 817 | for Arch in Wa.ArchList:\r |
| | 818 | Platform = Wa.BuildDatabase[Wa.MetaFile, Arch, Wa.BuildTarget, Wa.ToolChain]\r |
| | 819 | for (TokenCName, TokenSpaceGuidCName) in Platform.Pcds:\r |
| | 820 | DscDefaultValue = Platform.Pcds[(TokenCName, TokenSpaceGuidCName)].DefaultValue\r |
| | 821 | if DscDefaultValue:\r |
| | 822 | self.DscPcdDefault[(TokenCName, TokenSpaceGuidCName)] = DscDefaultValue\r |
| | 823 | \r |
| | 824 | def GenerateReport(self, File, ModulePcdSet):\r |
| | 825 | if self.ConditionalPcds:\r |
| | 826 | self.GenerateReportDetail(File, ModulePcdSet, 1)\r |
| | 827 | if self.UnusedPcds:\r |
| | 828 | self.GenerateReportDetail(File, ModulePcdSet, 2)\r |
| | 829 | self.GenerateReportDetail(File, ModulePcdSet)\r |
| | 830 | \r |
| | 831 | ##\r |
| | 832 | # Generate report for PCD information\r |
| | 833 | #\r |
| | 834 | # This function generates report for separate module expression\r |
| | 835 | # in a platform build.\r |
| | 836 | #\r |
| | 837 | # @param self The object pointer\r |
| | 838 | # @param File The file object for report\r |
| | 839 | # @param ModulePcdSet Set of all PCDs referenced by module or None for\r |
| | 840 | # platform PCD report\r |
| | 841 | # @param ReportySubType 0 means platform/module PCD report, 1 means Conditional\r |
| | 842 | # directives section report, 2 means Unused Pcds section report\r |
| | 843 | # @param DscOverridePcds Module DSC override PCDs set\r |
| | 844 | #\r |
| | 845 | def GenerateReportDetail(self, File, ModulePcdSet, ReportSubType = 0):\r |
| | 846 | PcdDict = self.AllPcds\r |
| | 847 | if ReportSubType == 1:\r |
| | 848 | PcdDict = self.ConditionalPcds\r |
| | 849 | elif ReportSubType == 2:\r |
| | 850 | PcdDict = self.UnusedPcds\r |
| | 851 | \r |
| | 852 | if ModulePcdSet == None:\r |
| | 853 | FileWrite(File, gSectionStart)\r |
| | 854 | if ReportSubType == 1:\r |
| | 855 | FileWrite(File, "Conditional Directives used by the build system")\r |
| | 856 | elif ReportSubType == 2:\r |
| | 857 | FileWrite(File, "PCDs not used by modules or in conditional directives")\r |
| | 858 | else:\r |
| | 859 | FileWrite(File, "Platform Configuration Database Report")\r |
| | 860 | \r |
| | 861 | FileWrite(File, " *B - PCD override in the build option")\r |
| | 862 | FileWrite(File, " *P - Platform scoped PCD override in DSC file")\r |
| | 863 | FileWrite(File, " *F - Platform scoped PCD override in FDF file")\r |
| | 864 | if not ReportSubType:\r |
| | 865 | FileWrite(File, " *M - Module scoped PCD override")\r |
| | 866 | FileWrite(File, gSectionSep)\r |
| | 867 | else:\r |
| | 868 | if not ReportSubType and ModulePcdSet:\r |
| | 869 | #\r |
| | 870 | # For module PCD sub-section\r |
| | 871 | #\r |
| | 872 | FileWrite(File, gSubSectionStart)\r |
| | 873 | FileWrite(File, TAB_BRG_PCD)\r |
| | 874 | FileWrite(File, gSubSectionSep)\r |
| | 875 | \r |
| | 876 | for Key in PcdDict:\r |
| | 877 | #\r |
| | 878 | # Group PCD by their token space GUID C Name\r |
| | 879 | #\r |
| | 880 | First = True\r |
| | 881 | for Type in PcdDict[Key]:\r |
| | 882 | #\r |
| | 883 | # Group PCD by their usage type\r |
| | 884 | #\r |
| | 885 | TypeName, DecType = gPcdTypeMap.get(Type, ("", Type))\r |
| | 886 | for Pcd in PcdDict[Key][Type]:\r |
| | 887 | PcdTokenCName = Pcd.TokenCName\r |
| | 888 | MixedPcdFlag = False\r |
| | 889 | if GlobalData.MixedPcd:\r |
| | 890 | for PcdKey in GlobalData.MixedPcd:\r |
| | 891 | if (Pcd.TokenCName, Pcd.TokenSpaceGuidCName) in GlobalData.MixedPcd[PcdKey]:\r |
| | 892 | PcdTokenCName = PcdKey[0]\r |
| | 893 | MixedPcdFlag = True\r |
| | 894 | if MixedPcdFlag and not ModulePcdSet:\r |
| | 895 | continue\r |
| | 896 | #\r |
| | 897 | # Get PCD default value and their override relationship\r |
| | 898 | #\r |
| | 899 | DecDefaultValue = self.DecPcdDefault.get((Pcd.TokenCName, Pcd.TokenSpaceGuidCName, DecType))\r |
| | 900 | DscDefaultValue = self.DscPcdDefault.get((Pcd.TokenCName, Pcd.TokenSpaceGuidCName))\r |
| | 901 | DscDefaultValue = self.FdfPcdSet.get((Pcd.TokenCName, Key), DscDefaultValue)\r |
| | 902 | InfDefaultValue = None\r |
| | 903 | \r |
| | 904 | PcdValue = DecDefaultValue\r |
| | 905 | if DscDefaultValue:\r |
| | 906 | PcdValue = DscDefaultValue\r |
| | 907 | if ModulePcdSet != None:\r |
| | 908 | if (Pcd.TokenCName, Pcd.TokenSpaceGuidCName, Type) not in ModulePcdSet:\r |
| | 909 | continue\r |
| | 910 | InfDefault, PcdValue = ModulePcdSet[Pcd.TokenCName, Pcd.TokenSpaceGuidCName, Type]\r |
| | 911 | if InfDefault == "":\r |
| | 912 | InfDefault = None\r |
| | 913 | \r |
| | 914 | BuildOptionMatch = False\r |
| | 915 | if GlobalData.BuildOptionPcd:\r |
| | 916 | for pcd in GlobalData.BuildOptionPcd:\r |
| | 917 | if (Pcd.TokenSpaceGuidCName, Pcd.TokenCName) == (pcd[0], pcd[1]):\r |
| | 918 | PcdValue = pcd[2]\r |
| | 919 | BuildOptionMatch = True\r |
| | 920 | break\r |
| | 921 | \r |
| | 922 | if First:\r |
| | 923 | if ModulePcdSet == None:\r |
| | 924 | FileWrite(File, "")\r |
| | 925 | FileWrite(File, Key)\r |
| | 926 | First = False\r |
| | 927 | \r |
| | 928 | \r |
| | 929 | if Pcd.DatumType in ('UINT8', 'UINT16', 'UINT32', 'UINT64'):\r |
| | 930 | PcdValueNumber = int(PcdValue.strip(), 0)\r |
| | 931 | if DecDefaultValue == None:\r |
| | 932 | DecMatch = True\r |
| | 933 | else:\r |
| | 934 | DecDefaultValueNumber = int(DecDefaultValue.strip(), 0)\r |
| | 935 | DecMatch = (DecDefaultValueNumber == PcdValueNumber)\r |
| | 936 | \r |
| | 937 | if InfDefaultValue == None:\r |
| | 938 | InfMatch = True\r |
| | 939 | else:\r |
| | 940 | InfDefaultValueNumber = int(InfDefaultValue.strip(), 0)\r |
| | 941 | InfMatch = (InfDefaultValueNumber == PcdValueNumber)\r |
| | 942 | \r |
| | 943 | if DscDefaultValue == None:\r |
| | 944 | DscMatch = True\r |
| | 945 | else:\r |
| | 946 | DscDefaultValueNumber = int(DscDefaultValue.strip(), 0)\r |
| | 947 | DscMatch = (DscDefaultValueNumber == PcdValueNumber)\r |
| | 948 | else:\r |
| | 949 | if DecDefaultValue == None:\r |
| | 950 | DecMatch = True\r |
| | 951 | else:\r |
| | 952 | DecMatch = (DecDefaultValue.strip() == PcdValue.strip())\r |
| | 953 | \r |
| | 954 | if InfDefaultValue == None:\r |
| | 955 | InfMatch = True\r |
| | 956 | else:\r |
| | 957 | InfMatch = (InfDefaultValue.strip() == PcdValue.strip())\r |
| | 958 | \r |
| | 959 | if DscDefaultValue == None:\r |
| | 960 | DscMatch = True\r |
| | 961 | else:\r |
| | 962 | DscMatch = (DscDefaultValue.strip() == PcdValue.strip())\r |
| | 963 | \r |
| | 964 | #\r |
| | 965 | # Report PCD item according to their override relationship\r |
| | 966 | #\r |
| | 967 | if BuildOptionMatch:\r |
| | 968 | FileWrite(File, ' *B %-*s: %6s %10s = %-22s' % (self.MaxLen, PcdTokenCName, TypeName, '(' + Pcd.DatumType + ')', PcdValue.strip()))\r |
| | 969 | elif DecMatch and InfMatch:\r |
| | 970 | FileWrite(File, ' %-*s: %6s %10s = %-22s' % (self.MaxLen, PcdTokenCName, TypeName, '(' + Pcd.DatumType + ')', PcdValue.strip()))\r |
| | 971 | else:\r |
| | 972 | if DscMatch:\r |
| | 973 | if (Pcd.TokenCName, Key) in self.FdfPcdSet:\r |
| | 974 | FileWrite(File, ' *F %-*s: %6s %10s = %-22s' % (self.MaxLen, PcdTokenCName, TypeName, '(' + Pcd.DatumType + ')', PcdValue.strip()))\r |
| | 975 | else:\r |
| | 976 | FileWrite(File, ' *P %-*s: %6s %10s = %-22s' % (self.MaxLen, PcdTokenCName, TypeName, '(' + Pcd.DatumType + ')', PcdValue.strip()))\r |
| | 977 | else:\r |
| | 978 | FileWrite(File, ' *M %-*s: %6s %10s = %-22s' % (self.MaxLen, PcdTokenCName, TypeName, '(' + Pcd.DatumType + ')', PcdValue.strip()))\r |
| | 979 | \r |
| | 980 | if TypeName in ('DYNHII', 'DEXHII', 'DYNVPD', 'DEXVPD'):\r |
| | 981 | for SkuInfo in Pcd.SkuInfoList.values():\r |
| | 982 | if TypeName in ('DYNHII', 'DEXHII'):\r |
| | 983 | FileWrite(File, '%*s: %s: %s' % (self.MaxLen + 4, SkuInfo.VariableGuid, SkuInfo.VariableName, SkuInfo.VariableOffset))\r |
| | 984 | else:\r |
| | 985 | FileWrite(File, '%*s' % (self.MaxLen + 4, SkuInfo.VpdOffset))\r |
| | 986 | \r |
| | 987 | if not DscMatch and DscDefaultValue != None:\r |
| | 988 | FileWrite(File, ' %*s = %s' % (self.MaxLen + 19, 'DSC DEFAULT', DscDefaultValue.strip()))\r |
| | 989 | \r |
| | 990 | if not InfMatch and InfDefaultValue != None:\r |
| | 991 | FileWrite(File, ' %*s = %s' % (self.MaxLen + 19, 'INF DEFAULT', InfDefaultValue.strip()))\r |
| | 992 | \r |
| | 993 | if not DecMatch and DecDefaultValue != None:\r |
| | 994 | FileWrite(File, ' %*s = %s' % (self.MaxLen + 19, 'DEC DEFAULT', DecDefaultValue.strip()))\r |
| | 995 | \r |
| | 996 | if ModulePcdSet == None:\r |
| | 997 | if not BuildOptionMatch:\r |
| | 998 | ModuleOverride = self.ModulePcdOverride.get((Pcd.TokenCName, Pcd.TokenSpaceGuidCName), {})\r |
| | 999 | for ModulePath in ModuleOverride:\r |
| | 1000 | ModuleDefault = ModuleOverride[ModulePath]\r |
| | 1001 | if Pcd.DatumType in ('UINT8', 'UINT16', 'UINT32', 'UINT64'):\r |
| | 1002 | ModulePcdDefaultValueNumber = int(ModuleDefault.strip(), 0)\r |
| | 1003 | Match = (ModulePcdDefaultValueNumber == PcdValueNumber)\r |
| | 1004 | else:\r |
| | 1005 | Match = (ModuleDefault.strip() == PcdValue.strip())\r |
| | 1006 | if Match:\r |
| | 1007 | continue\r |
| | 1008 | FileWrite(File, ' *M %-*s = %s' % (self.MaxLen + 19, ModulePath, ModuleDefault.strip()))\r |
| | 1009 | \r |
| | 1010 | if ModulePcdSet == None:\r |
| | 1011 | FileWrite(File, gSectionEnd)\r |
| | 1012 | else:\r |
| | 1013 | if not ReportSubType and ModulePcdSet:\r |
| | 1014 | FileWrite(File, gSubSectionEnd)\r |
| | 1015 | \r |
| | 1016 | \r |
| | 1017 | \r |
| | 1018 | ##\r |
| | 1019 | # Reports platform and module Prediction information\r |
| | 1020 | #\r |
| | 1021 | # This class reports the platform execution order prediction section and\r |
| | 1022 | # module load fixed address prediction subsection in the build report file.\r |
| | 1023 | #\r |
| | 1024 | class PredictionReport(object):\r |
| | 1025 | ##\r |
| | 1026 | # Constructor function for class PredictionReport\r |
| | 1027 | #\r |
| | 1028 | # This constructor function generates PredictionReport object for the platform.\r |
| | 1029 | #\r |
| | 1030 | # @param self: The object pointer\r |
| | 1031 | # @param Wa Workspace context information\r |
| | 1032 | #\r |
| | 1033 | def __init__(self, Wa):\r |
| | 1034 | self._MapFileName = os.path.join(Wa.BuildDir, Wa.Name + ".map")\r |
| | 1035 | self._MapFileParsed = False\r |
| | 1036 | self._EotToolInvoked = False\r |
| | 1037 | self._FvDir = Wa.FvDir\r |
| | 1038 | self._EotDir = Wa.BuildDir\r |
| | 1039 | self._FfsEntryPoint = {}\r |
| | 1040 | self._GuidMap = {}\r |
| | 1041 | self._SourceList = []\r |
| | 1042 | self.FixedMapDict = {}\r |
| | 1043 | self.ItemList = []\r |
| | 1044 | self.MaxLen = 0\r |
| | 1045 | \r |
| | 1046 | #\r |
| | 1047 | # Collect all platform reference source files and GUID C Name\r |
| | 1048 | #\r |
| | 1049 | for Pa in Wa.AutoGenObjectList:\r |
| | 1050 | for Module in Pa.LibraryAutoGenList + Pa.ModuleAutoGenList:\r |
| | 1051 | #\r |
| | 1052 | # BASE typed modules are EFI agnostic, so we need not scan\r |
| | 1053 | # their source code to find PPI/Protocol produce or consume\r |
| | 1054 | # information.\r |
| | 1055 | #\r |
| | 1056 | if Module.ModuleType == "BASE":\r |
| | 1057 | continue\r |
| | 1058 | #\r |
| | 1059 | # Add module referenced source files\r |
| | 1060 | #\r |
| | 1061 | self._SourceList.append(str(Module))\r |
| | 1062 | IncludeList = {}\r |
| | 1063 | for Source in Module.SourceFileList:\r |
| | 1064 | if os.path.splitext(str(Source))[1].lower() == ".c":\r |
| | 1065 | self._SourceList.append(" " + str(Source))\r |
| | 1066 | FindIncludeFiles(Source.Path, Module.IncludePathList, IncludeList)\r |
| | 1067 | for IncludeFile in IncludeList.values():\r |
| | 1068 | self._SourceList.append(" " + IncludeFile)\r |
| | 1069 | \r |
| | 1070 | for Guid in Module.PpiList:\r |
| | 1071 | self._GuidMap[Guid] = GuidStructureStringToGuidString(Module.PpiList[Guid])\r |
| | 1072 | for Guid in Module.ProtocolList:\r |
| | 1073 | self._GuidMap[Guid] = GuidStructureStringToGuidString(Module.ProtocolList[Guid])\r |
| | 1074 | for Guid in Module.GuidList:\r |
| | 1075 | self._GuidMap[Guid] = GuidStructureStringToGuidString(Module.GuidList[Guid])\r |
| | 1076 | \r |
| | 1077 | if Module.Guid and not Module.IsLibrary:\r |
| | 1078 | EntryPoint = " ".join(Module.Module.ModuleEntryPointList)\r |
| | 1079 | if int(str(Module.AutoGenVersion), 0) >= 0x00010005:\r |
| | 1080 | RealEntryPoint = "_ModuleEntryPoint"\r |
| | 1081 | else:\r |
| | 1082 | RealEntryPoint = EntryPoint\r |
| | 1083 | if EntryPoint == "_ModuleEntryPoint":\r |
| | 1084 | CCFlags = Module.BuildOption.get("CC", {}).get("FLAGS", "")\r |
| | 1085 | Match = gGlueLibEntryPoint.search(CCFlags)\r |
| | 1086 | if Match:\r |
| | 1087 | EntryPoint = Match.group(1)\r |
| | 1088 | \r |
| | 1089 | self._FfsEntryPoint[Module.Guid.upper()] = (EntryPoint, RealEntryPoint)\r |
| | 1090 | \r |
| | 1091 | \r |
| | 1092 | #\r |
| | 1093 | # Collect platform firmware volume list as the input of EOT.\r |
| | 1094 | #\r |
| | 1095 | self._FvList = []\r |
| | 1096 | if Wa.FdfProfile:\r |
| | 1097 | for Fd in Wa.FdfProfile.FdDict:\r |
| | 1098 | for FdRegion in Wa.FdfProfile.FdDict[Fd].RegionList:\r |
| | 1099 | if FdRegion.RegionType != "FV":\r |
| | 1100 | continue\r |
| | 1101 | for FvName in FdRegion.RegionDataList:\r |
| | 1102 | if FvName in self._FvList:\r |
| | 1103 | continue\r |
| | 1104 | self._FvList.append(FvName)\r |
| | 1105 | for Ffs in Wa.FdfProfile.FvDict[FvName.upper()].FfsList:\r |
| | 1106 | for Section in Ffs.SectionList:\r |
| | 1107 | try:\r |
| | 1108 | for FvSection in Section.SectionList:\r |
| | 1109 | if FvSection.FvName in self._FvList:\r |
| | 1110 | continue\r |
| | 1111 | self._FvList.append(FvSection.FvName)\r |
| | 1112 | except AttributeError:\r |
| | 1113 | pass\r |
| | 1114 | \r |
| | 1115 | \r |
| | 1116 | ##\r |
| | 1117 | # Parse platform fixed address map files\r |
| | 1118 | #\r |
| | 1119 | # This function parses the platform final fixed address map file to get\r |
| | 1120 | # the database of predicted fixed address for module image base, entry point\r |
| | 1121 | # etc.\r |
| | 1122 | #\r |
| | 1123 | # @param self: The object pointer\r |
| | 1124 | #\r |
| | 1125 | def _ParseMapFile(self):\r |
| | 1126 | if self._MapFileParsed:\r |
| | 1127 | return\r |
| | 1128 | self._MapFileParsed = True\r |
| | 1129 | if os.path.isfile(self._MapFileName):\r |
| | 1130 | try:\r |
| | 1131 | FileContents = open(self._MapFileName).read()\r |
| | 1132 | for Match in gMapFileItemPattern.finditer(FileContents):\r |
| | 1133 | AddressType = Match.group(1)\r |
| | 1134 | BaseAddress = Match.group(2)\r |
| | 1135 | EntryPoint = Match.group(3)\r |
| | 1136 | Guid = Match.group(4).upper()\r |
| | 1137 | List = self.FixedMapDict.setdefault(Guid, [])\r |
| | 1138 | List.append((AddressType, BaseAddress, "*I"))\r |
| | 1139 | List.append((AddressType, EntryPoint, "*E"))\r |
| | 1140 | except:\r |
| | 1141 | EdkLogger.warn(None, "Cannot open file to read", self._MapFileName)\r |
| | 1142 | \r |
| | 1143 | ##\r |
| | 1144 | # Invokes EOT tool to get the predicted the execution order.\r |
| | 1145 | #\r |
| | 1146 | # This function invokes EOT tool to calculate the predicted dispatch order\r |
| | 1147 | #\r |
| | 1148 | # @param self: The object pointer\r |
| | 1149 | #\r |
| | 1150 | def _InvokeEotTool(self):\r |
| | 1151 | if self._EotToolInvoked:\r |
| | 1152 | return\r |
| | 1153 | \r |
| | 1154 | self._EotToolInvoked = True\r |
| | 1155 | FvFileList = []\r |
| | 1156 | for FvName in self._FvList:\r |
| | 1157 | FvFile = os.path.join(self._FvDir, FvName + ".Fv")\r |
| | 1158 | if os.path.isfile(FvFile):\r |
| | 1159 | FvFileList.append(FvFile)\r |
| | 1160 | \r |
| | 1161 | if len(FvFileList) == 0:\r |
| | 1162 | return\r |
| | 1163 | #\r |
| | 1164 | # Write source file list and GUID file list to an intermediate file\r |
| | 1165 | # as the input for EOT tool and dispatch List as the output file\r |
| | 1166 | # from EOT tool.\r |
| | 1167 | #\r |
| | 1168 | SourceList = os.path.join(self._EotDir, "SourceFile.txt")\r |
| | 1169 | GuidList = os.path.join(self._EotDir, "GuidList.txt")\r |
| | 1170 | DispatchList = os.path.join(self._EotDir, "Dispatch.txt")\r |
| | 1171 | \r |
| | 1172 | TempFile = open(SourceList, "w+")\r |
| | 1173 | for Item in self._SourceList:\r |
| | 1174 | FileWrite(TempFile, Item)\r |
| | 1175 | TempFile.close()\r |
| | 1176 | TempFile = open(GuidList, "w+")\r |
| | 1177 | for Key in self._GuidMap:\r |
| | 1178 | FileWrite(TempFile, "%s %s" % (Key, self._GuidMap[Key]))\r |
| | 1179 | TempFile.close()\r |
| | 1180 | \r |
| | 1181 | try:\r |
| | 1182 | from Eot.Eot import Eot\r |
| | 1183 | \r |
| | 1184 | #\r |
| | 1185 | # Invoke EOT tool and echo its runtime performance\r |
| | 1186 | #\r |
| | 1187 | EotStartTime = time.time()\r |
| | 1188 | Eot(CommandLineOption=False, SourceFileList=SourceList, GuidList=GuidList,\r |
| | 1189 | FvFileList=' '.join(FvFileList), Dispatch=DispatchList, IsInit=True)\r |
| | 1190 | EotEndTime = time.time()\r |
| | 1191 | EotDuration = time.strftime("%H:%M:%S", time.gmtime(int(round(EotEndTime - EotStartTime))))\r |
| | 1192 | EdkLogger.quiet("EOT run time: %s\n" % EotDuration)\r |
| | 1193 | \r |
| | 1194 | #\r |
| | 1195 | # Parse the output of EOT tool\r |
| | 1196 | #\r |
| | 1197 | for Line in open(DispatchList):\r |
| | 1198 | if len(Line.split()) < 4:\r |
| | 1199 | continue\r |
| | 1200 | (Guid, Phase, FfsName, FilePath) = Line.split()\r |
| | 1201 | Symbol = self._FfsEntryPoint.get(Guid, [FfsName, ""])[0]\r |
| | 1202 | if len(Symbol) > self.MaxLen:\r |
| | 1203 | self.MaxLen = len(Symbol)\r |
| | 1204 | self.ItemList.append((Phase, Symbol, FilePath))\r |
| | 1205 | except:\r |
| | 1206 | EdkLogger.quiet("(Python %s on %s\n%s)" % (platform.python_version(), sys.platform, traceback.format_exc()))\r |
| | 1207 | EdkLogger.warn(None, "Failed to generate execution order prediction report, for some error occurred in executing EOT.")\r |
| | 1208 | \r |
| | 1209 | \r |
| | 1210 | ##\r |
| | 1211 | # Generate platform execution order report\r |
| | 1212 | #\r |
| | 1213 | # This function generates the predicted module execution order.\r |
| | 1214 | #\r |
| | 1215 | # @param self The object pointer\r |
| | 1216 | # @param File The file object for report\r |
| | 1217 | #\r |
| | 1218 | def _GenerateExecutionOrderReport(self, File):\r |
| | 1219 | self._InvokeEotTool()\r |
| | 1220 | if len(self.ItemList) == 0:\r |
| | 1221 | return\r |
| | 1222 | FileWrite(File, gSectionStart)\r |
| | 1223 | FileWrite(File, "Execution Order Prediction")\r |
| | 1224 | FileWrite(File, "*P PEI phase")\r |
| | 1225 | FileWrite(File, "*D DXE phase")\r |
| | 1226 | FileWrite(File, "*E Module INF entry point name")\r |
| | 1227 | FileWrite(File, "*N Module notification function name")\r |
| | 1228 | \r |
| | 1229 | FileWrite(File, "Type %-*s %s" % (self.MaxLen, "Symbol", "Module INF Path"))\r |
| | 1230 | FileWrite(File, gSectionSep)\r |
| | 1231 | for Item in self.ItemList:\r |
| | 1232 | FileWrite(File, "*%sE %-*s %s" % (Item[0], self.MaxLen, Item[1], Item[2]))\r |
| | 1233 | \r |
| | 1234 | FileWrite(File, gSectionStart)\r |
| | 1235 | \r |
| | 1236 | ##\r |
| | 1237 | # Generate Fixed Address report.\r |
| | 1238 | #\r |
| | 1239 | # This function generate the predicted fixed address report for a module\r |
| | 1240 | # specified by Guid.\r |
| | 1241 | #\r |
| | 1242 | # @param self The object pointer\r |
| | 1243 | # @param File The file object for report\r |
| | 1244 | # @param Guid The module Guid value.\r |
| | 1245 | # @param NotifyList The list of all notify function in a module\r |
| | 1246 | #\r |
| | 1247 | def _GenerateFixedAddressReport(self, File, Guid, NotifyList):\r |
| | 1248 | self._ParseMapFile()\r |
| | 1249 | FixedAddressList = self.FixedMapDict.get(Guid)\r |
| | 1250 | if not FixedAddressList:\r |
| | 1251 | return\r |
| | 1252 | \r |
| | 1253 | FileWrite(File, gSubSectionStart)\r |
| | 1254 | FileWrite(File, "Fixed Address Prediction")\r |
| | 1255 | FileWrite(File, "*I Image Loading Address")\r |
| | 1256 | FileWrite(File, "*E Entry Point Address")\r |
| | 1257 | FileWrite(File, "*N Notification Function Address")\r |
| | 1258 | FileWrite(File, "*F Flash Address")\r |
| | 1259 | FileWrite(File, "*M Memory Address")\r |
| | 1260 | FileWrite(File, "*S SMM RAM Offset")\r |
| | 1261 | FileWrite(File, "TOM Top of Memory")\r |
| | 1262 | \r |
| | 1263 | FileWrite(File, "Type Address Name")\r |
| | 1264 | FileWrite(File, gSubSectionSep)\r |
| | 1265 | for Item in FixedAddressList:\r |
| | 1266 | Type = Item[0]\r |
| | 1267 | Value = Item[1]\r |
| | 1268 | Symbol = Item[2]\r |
| | 1269 | if Symbol == "*I":\r |
| | 1270 | Name = "(Image Base)"\r |
| | 1271 | elif Symbol == "*E":\r |
| | 1272 | Name = self._FfsEntryPoint.get(Guid, ["", "_ModuleEntryPoint"])[1]\r |
| | 1273 | elif Symbol in NotifyList:\r |
| | 1274 | Name = Symbol\r |
| | 1275 | Symbol = "*N"\r |
| | 1276 | else:\r |
| | 1277 | continue\r |
| | 1278 | \r |
| | 1279 | if "Flash" in Type:\r |
| | 1280 | Symbol += "F"\r |
| | 1281 | elif "Memory" in Type:\r |
| | 1282 | Symbol += "M"\r |
| | 1283 | else:\r |
| | 1284 | Symbol += "S"\r |
| | 1285 | \r |
| | 1286 | if Value[0] == "-":\r |
| | 1287 | Value = "TOM" + Value\r |
| | 1288 | \r |
| | 1289 | FileWrite(File, "%s %-16s %s" % (Symbol, Value, Name))\r |
| | 1290 | \r |
| | 1291 | ##\r |
| | 1292 | # Generate report for the prediction part\r |
| | 1293 | #\r |
| | 1294 | # This function generate the predicted fixed address report for a module or\r |
| | 1295 | # predicted module execution order for a platform.\r |
| | 1296 | # If the input Guid is None, then, it generates the predicted module execution order;\r |
| | 1297 | # otherwise it generated the module fixed loading address for the module specified by\r |
| | 1298 | # Guid.\r |
| | 1299 | #\r |
| | 1300 | # @param self The object pointer\r |
| | 1301 | # @param File The file object for report\r |
| | 1302 | # @param Guid The module Guid value.\r |
| | 1303 | #\r |
| | 1304 | def GenerateReport(self, File, Guid):\r |
| | 1305 | if Guid:\r |
| | 1306 | self._GenerateFixedAddressReport(File, Guid.upper(), [])\r |
| | 1307 | else:\r |
| | 1308 | self._GenerateExecutionOrderReport(File)\r |
| | 1309 | \r |
| | 1310 | ##\r |
| | 1311 | # Reports FD region information\r |
| | 1312 | #\r |
| | 1313 | # This class reports the FD subsection in the build report file.\r |
| | 1314 | # It collects region information of platform flash device.\r |
| | 1315 | # If the region is a firmware volume, it lists the set of modules\r |
| | 1316 | # and its space information; otherwise, it only lists its region name,\r |
| | 1317 | # base address and size in its sub-section header.\r |
| | 1318 | # If there are nesting FVs, the nested FVs will list immediate after\r |
| | 1319 | # this FD region subsection\r |
| | 1320 | #\r |
| | 1321 | class FdRegionReport(object):\r |
| | 1322 | ##\r |
| | 1323 | # Discover all the nested FV name list.\r |
| | 1324 | #\r |
| | 1325 | # This is an internal worker function to discover the all the nested FV information\r |
| | 1326 | # in the parent firmware volume. It uses deep first search algorithm recursively to\r |
| | 1327 | # find all the FV list name and append them to the list.\r |
| | 1328 | #\r |
| | 1329 | # @param self The object pointer\r |
| | 1330 | # @param FvName The name of current firmware file system\r |
| | 1331 | # @param Wa Workspace context information\r |
| | 1332 | #\r |
| | 1333 | def _DiscoverNestedFvList(self, FvName, Wa):\r |
| | 1334 | FvDictKey=FvName.upper()\r |
| | 1335 | if FvDictKey in Wa.FdfProfile.FvDict:\r |
| | 1336 | for Ffs in Wa.FdfProfile.FvDict[FvName.upper()].FfsList:\r |
| | 1337 | for Section in Ffs.SectionList:\r |
| | 1338 | try:\r |
| | 1339 | for FvSection in Section.SectionList:\r |
| | 1340 | if FvSection.FvName in self.FvList:\r |
| | 1341 | continue\r |
| | 1342 | self._GuidsDb[Ffs.NameGuid.upper()] = FvSection.FvName\r |
| | 1343 | self.FvList.append(FvSection.FvName)\r |
| | 1344 | self.FvInfo[FvSection.FvName] = ("Nested FV", 0, 0)\r |
| | 1345 | self._DiscoverNestedFvList(FvSection.FvName, Wa)\r |
| | 1346 | except AttributeError:\r |
| | 1347 | pass\r |
| | 1348 | \r |
| | 1349 | ##\r |
| | 1350 | # Constructor function for class FdRegionReport\r |
| | 1351 | #\r |
| | 1352 | # This constructor function generates FdRegionReport object for a specified FdRegion.\r |
| | 1353 | # If the FdRegion is a firmware volume, it will recursively find all its nested Firmware\r |
| | 1354 | # volume list. This function also collects GUID map in order to dump module identification\r |
| | 1355 | # in the final report.\r |
| | 1356 | #\r |
| | 1357 | # @param self: The object pointer\r |
| | 1358 | # @param FdRegion The current FdRegion object\r |
| | 1359 | # @param Wa Workspace context information\r |
| | 1360 | #\r |
| | 1361 | def __init__(self, FdRegion, Wa):\r |
| | 1362 | self.Type = FdRegion.RegionType\r |
| | 1363 | self.BaseAddress = FdRegion.Offset\r |
| | 1364 | self.Size = FdRegion.Size\r |
| | 1365 | self.FvList = []\r |
| | 1366 | self.FvInfo = {}\r |
| | 1367 | self._GuidsDb = {}\r |
| | 1368 | self._FvDir = Wa.FvDir\r |
| | 1369 | \r |
| | 1370 | #\r |
| | 1371 | # If the input FdRegion is not a firmware volume,\r |
| | 1372 | # we are done.\r |
| | 1373 | #\r |
| | 1374 | if self.Type != "FV":\r |
| | 1375 | return\r |
| | 1376 | \r |
| | 1377 | #\r |
| | 1378 | # Find all nested FVs in the FdRegion\r |
| | 1379 | #\r |
| | 1380 | for FvName in FdRegion.RegionDataList:\r |
| | 1381 | if FvName in self.FvList:\r |
| | 1382 | continue\r |
| | 1383 | self.FvList.append(FvName)\r |
| | 1384 | self.FvInfo[FvName] = ("Fd Region", self.BaseAddress, self.Size)\r |
| | 1385 | self._DiscoverNestedFvList(FvName, Wa)\r |
| | 1386 | \r |
| | 1387 | PlatformPcds = {}\r |
| | 1388 | #\r |
| | 1389 | # Collect PCDs declared in DEC files.\r |
| | 1390 | # \r |
| | 1391 | for Pa in Wa.AutoGenObjectList:\r |
| | 1392 | for Package in Pa.PackageList:\r |
| | 1393 | for (TokenCName, TokenSpaceGuidCName, DecType) in Package.Pcds:\r |
| | 1394 | DecDefaultValue = Package.Pcds[TokenCName, TokenSpaceGuidCName, DecType].DefaultValue\r |
| | 1395 | PlatformPcds[(TokenCName, TokenSpaceGuidCName)] = DecDefaultValue\r |
| | 1396 | #\r |
| | 1397 | # Collect PCDs defined in DSC file\r |
| | 1398 | #\r |
| | 1399 | for arch in Wa.ArchList:\r |
| | 1400 | Platform = Wa.BuildDatabase[Wa.MetaFile, arch]\r |
| | 1401 | for (TokenCName, TokenSpaceGuidCName) in Platform.Pcds:\r |
| | 1402 | DscDefaultValue = Platform.Pcds[(TokenCName, TokenSpaceGuidCName)].DefaultValue\r |
| | 1403 | PlatformPcds[(TokenCName, TokenSpaceGuidCName)] = DscDefaultValue\r |
| | 1404 | \r |
| | 1405 | #\r |
| | 1406 | # Add PEI and DXE a priori files GUIDs defined in PI specification.\r |
| | 1407 | #\r |
| | 1408 | self._GuidsDb["1B45CC0A-156A-428A-AF62-49864DA0E6E6"] = "PEI Apriori"\r |
| | 1409 | self._GuidsDb["FC510EE7-FFDC-11D4-BD41-0080C73C8881"] = "DXE Apriori"\r |
| | 1410 | #\r |
| | 1411 | # Add ACPI table storage file\r |
| | 1412 | #\r |
| | 1413 | self._GuidsDb["7E374E25-8E01-4FEE-87F2-390C23C606CD"] = "ACPI table storage"\r |
| | 1414 | \r |
| | 1415 | for Pa in Wa.AutoGenObjectList:\r |
| | 1416 | for ModuleKey in Pa.Platform.Modules:\r |
| | 1417 | M = Pa.Platform.Modules[ModuleKey].M\r |
| | 1418 | InfPath = mws.join(Wa.WorkspaceDir, M.MetaFile.File)\r |
| | 1419 | self._GuidsDb[M.Guid.upper()] = "%s (%s)" % (M.Module.BaseName, InfPath)\r |
| | 1420 | \r |
| | 1421 | #\r |
| | 1422 | # Collect the GUID map in the FV firmware volume\r |
| | 1423 | #\r |
| | 1424 | for FvName in self.FvList:\r |
| | 1425 | FvDictKey=FvName.upper()\r |
| | 1426 | if FvDictKey in Wa.FdfProfile.FvDict:\r |
| | 1427 | for Ffs in Wa.FdfProfile.FvDict[FvName.upper()].FfsList:\r |
| | 1428 | try:\r |
| | 1429 | #\r |
| | 1430 | # collect GUID map for binary EFI file in FDF file.\r |
| | 1431 | #\r |
| | 1432 | Guid = Ffs.NameGuid.upper()\r |
| | 1433 | Match = gPcdGuidPattern.match(Ffs.NameGuid)\r |
| | 1434 | if Match:\r |
| | 1435 | PcdTokenspace = Match.group(1)\r |
| | 1436 | PcdToken = Match.group(2)\r |
| | 1437 | if (PcdToken, PcdTokenspace) in PlatformPcds:\r |
| | 1438 | GuidValue = PlatformPcds[(PcdToken, PcdTokenspace)]\r |
| | 1439 | Guid = GuidStructureByteArrayToGuidString(GuidValue).upper()\r |
| | 1440 | for Section in Ffs.SectionList:\r |
| | 1441 | try:\r |
| | 1442 | ModuleSectFile = mws.join(Wa.WorkspaceDir, Section.SectFileName)\r |
| | 1443 | self._GuidsDb[Guid] = ModuleSectFile\r |
| | 1444 | except AttributeError:\r |
| | 1445 | pass\r |
| | 1446 | except AttributeError:\r |
| | 1447 | pass\r |
| | 1448 | \r |
| | 1449 | \r |
| | 1450 | ##\r |
| | 1451 | # Internal worker function to generate report for the FD region\r |
| | 1452 | #\r |
| | 1453 | # This internal worker function to generate report for the FD region.\r |
| | 1454 | # It the type is firmware volume, it lists offset and module identification.\r |
| | 1455 | #\r |
| | 1456 | # @param self The object pointer\r |
| | 1457 | # @param File The file object for report\r |
| | 1458 | # @param Title The title for the FD subsection\r |
| | 1459 | # @param BaseAddress The base address for the FD region\r |
| | 1460 | # @param Size The size of the FD region\r |
| | 1461 | # @param FvName The FV name if the FD region is a firmware volume\r |
| | 1462 | #\r |
| | 1463 | def _GenerateReport(self, File, Title, Type, BaseAddress, Size=0, FvName=None):\r |
| | 1464 | FileWrite(File, gSubSectionStart)\r |
| | 1465 | FileWrite(File, Title)\r |
| | 1466 | FileWrite(File, "Type: %s" % Type)\r |
| | 1467 | FileWrite(File, "Base Address: 0x%X" % BaseAddress)\r |
| | 1468 | \r |
| | 1469 | if self.Type == "FV":\r |
| | 1470 | FvTotalSize = 0\r |
| | 1471 | FvTakenSize = 0\r |
| | 1472 | FvFreeSize = 0\r |
| | 1473 | FvReportFileName = os.path.join(self._FvDir, FvName + ".Fv.txt")\r |
| | 1474 | try:\r |
| | 1475 | #\r |
| | 1476 | # Collect size info in the firmware volume.\r |
| | 1477 | #\r |
| | 1478 | FvReport = open(FvReportFileName).read()\r |
| | 1479 | Match = gFvTotalSizePattern.search(FvReport)\r |
| | 1480 | if Match:\r |
| | 1481 | FvTotalSize = int(Match.group(1), 16)\r |
| | 1482 | Match = gFvTakenSizePattern.search(FvReport)\r |
| | 1483 | if Match:\r |
| | 1484 | FvTakenSize = int(Match.group(1), 16)\r |
| | 1485 | FvFreeSize = FvTotalSize - FvTakenSize\r |
| | 1486 | #\r |
| | 1487 | # Write size information to the report file.\r |
| | 1488 | #\r |
| | 1489 | FileWrite(File, "Size: 0x%X (%.0fK)" % (FvTotalSize, FvTotalSize / 1024.0))\r |
| | 1490 | FileWrite(File, "Fv Name: %s (%.1f%% Full)" % (FvName, FvTakenSize * 100.0 / FvTotalSize))\r |
| | 1491 | FileWrite(File, "Occupied Size: 0x%X (%.0fK)" % (FvTakenSize, FvTakenSize / 1024.0))\r |
| | 1492 | FileWrite(File, "Free Size: 0x%X (%.0fK)" % (FvFreeSize, FvFreeSize / 1024.0))\r |
| | 1493 | FileWrite(File, "Offset Module")\r |
| | 1494 | FileWrite(File, gSubSectionSep)\r |
| | 1495 | #\r |
| | 1496 | # Write module offset and module identification to the report file.\r |
| | 1497 | #\r |
| | 1498 | OffsetInfo = {}\r |
| | 1499 | for Match in gOffsetGuidPattern.finditer(FvReport):\r |
| | 1500 | Guid = Match.group(2).upper()\r |
| | 1501 | OffsetInfo[Match.group(1)] = self._GuidsDb.get(Guid, Guid)\r |
| | 1502 | OffsetList = OffsetInfo.keys()\r |
| | 1503 | OffsetList.sort()\r |
| | 1504 | for Offset in OffsetList:\r |
| | 1505 | FileWrite (File, "%s %s" % (Offset, OffsetInfo[Offset]))\r |
| | 1506 | except IOError:\r |
| | 1507 | EdkLogger.warn(None, "Fail to read report file", FvReportFileName)\r |
| | 1508 | else:\r |
| | 1509 | FileWrite(File, "Size: 0x%X (%.0fK)" % (Size, Size / 1024.0))\r |
| | 1510 | FileWrite(File, gSubSectionEnd)\r |
| | 1511 | \r |
| | 1512 | ##\r |
| | 1513 | # Generate report for the FD region\r |
| | 1514 | #\r |
| | 1515 | # This function generates report for the FD region.\r |
| | 1516 | #\r |
| | 1517 | # @param self The object pointer\r |
| | 1518 | # @param File The file object for report\r |
| | 1519 | #\r |
| | 1520 | def GenerateReport(self, File):\r |
| | 1521 | if (len(self.FvList) > 0):\r |
| | 1522 | for FvItem in self.FvList:\r |
| | 1523 | Info = self.FvInfo[FvItem]\r |
| | 1524 | self._GenerateReport(File, Info[0], "FV", Info[1], Info[2], FvItem)\r |
| | 1525 | else:\r |
| | 1526 | self._GenerateReport(File, "FD Region", self.Type, self.BaseAddress, self.Size)\r |
| | 1527 | \r |
| | 1528 | ##\r |
| | 1529 | # Reports FD information\r |
| | 1530 | #\r |
| | 1531 | # This class reports the FD section in the build report file.\r |
| | 1532 | # It collects flash device information for a platform.\r |
| | 1533 | #\r |
| | 1534 | class FdReport(object):\r |
| | 1535 | ##\r |
| | 1536 | # Constructor function for class FdReport\r |
| | 1537 | #\r |
| | 1538 | # This constructor function generates FdReport object for a specified\r |
| | 1539 | # firmware device.\r |
| | 1540 | #\r |
| | 1541 | # @param self The object pointer\r |
| | 1542 | # @param Fd The current Firmware device object\r |
| | 1543 | # @param Wa Workspace context information\r |
| | 1544 | #\r |
| | 1545 | def __init__(self, Fd, Wa):\r |
| | 1546 | self.FdName = Fd.FdUiName\r |
| | 1547 | self.BaseAddress = Fd.BaseAddress\r |
| | 1548 | self.Size = Fd.Size\r |
| | 1549 | self.FdRegionList = [FdRegionReport(FdRegion, Wa) for FdRegion in Fd.RegionList]\r |
| | 1550 | self.FvPath = os.path.join(Wa.BuildDir, "FV")\r |
| | 1551 | self.VpdFilePath = os.path.join(self.FvPath, "%s.map" % Wa.Platform.VpdToolGuid)\r |
| | 1552 | self.VPDBaseAddress = 0\r |
| | 1553 | self.VPDSize = 0\r |
| | 1554 | self.VPDInfoList = []\r |
| | 1555 | for index, FdRegion in enumerate(Fd.RegionList):\r |
| | 1556 | if str(FdRegion.RegionType) is 'FILE' and Wa.Platform.VpdToolGuid in str(FdRegion.RegionDataList):\r |
| | 1557 | self.VPDBaseAddress = self.FdRegionList[index].BaseAddress\r |
| | 1558 | self.VPDSize = self.FdRegionList[index].Size\r |
| | 1559 | break\r |
| | 1560 | \r |
| | 1561 | if os.path.isfile(self.VpdFilePath):\r |
| | 1562 | fd = open(self.VpdFilePath, "r")\r |
| | 1563 | Lines = fd.readlines()\r |
| | 1564 | for Line in Lines:\r |
| | 1565 | Line = Line.strip()\r |
| | 1566 | if len(Line) == 0 or Line.startswith("#"):\r |
| | 1567 | continue\r |
| | 1568 | try:\r |
| | 1569 | PcdName, SkuId, Offset, Size, Value = Line.split("#")[0].split("|")\r |
| | 1570 | PcdName, SkuId, Offset, Size, Value = PcdName.strip(), SkuId.strip(), Offset.strip(), Size.strip(), Value.strip()\r |
| | 1571 | if Offset.lower().startswith('0x'):\r |
| | 1572 | Offset = '0x%08X' % (int(Offset, 16) + self.VPDBaseAddress)\r |
| | 1573 | else:\r |
| | 1574 | Offset = '0x%08X' % (int(Offset, 10) + self.VPDBaseAddress)\r |
| | 1575 | self.VPDInfoList.append("%s | %s | %s | %s | %s" % (PcdName, SkuId, Offset, Size, Value))\r |
| | 1576 | except:\r |
| | 1577 | EdkLogger.error("BuildReport", CODE_ERROR, "Fail to parse VPD information file %s" % self.VpdFilePath)\r |
| | 1578 | fd.close()\r |
| | 1579 | \r |
| | 1580 | ##\r |
| | 1581 | # Generate report for the firmware device.\r |
| | 1582 | #\r |
| | 1583 | # This function generates report for the firmware device.\r |
| | 1584 | #\r |
| | 1585 | # @param self The object pointer\r |
| | 1586 | # @param File The file object for report\r |
| | 1587 | #\r |
| | 1588 | def GenerateReport(self, File):\r |
| | 1589 | FileWrite(File, gSectionStart)\r |
| | 1590 | FileWrite(File, "Firmware Device (FD)")\r |
| | 1591 | FileWrite(File, "FD Name: %s" % self.FdName)\r |
| | 1592 | FileWrite(File, "Base Address: %s" % self.BaseAddress)\r |
| | 1593 | FileWrite(File, "Size: 0x%X (%.0fK)" % (self.Size, self.Size / 1024.0))\r |
| | 1594 | if len(self.FdRegionList) > 0:\r |
| | 1595 | FileWrite(File, gSectionSep)\r |
| | 1596 | for FdRegionItem in self.FdRegionList:\r |
| | 1597 | FdRegionItem.GenerateReport(File)\r |
| | 1598 | \r |
| | 1599 | if len(self.VPDInfoList) > 0:\r |
| | 1600 | FileWrite(File, gSubSectionStart)\r |
| | 1601 | FileWrite(File, "FD VPD Region")\r |
| | 1602 | FileWrite(File, "Base Address: 0x%X" % self.VPDBaseAddress)\r |
| | 1603 | FileWrite(File, "Size: 0x%X (%.0fK)" % (self.VPDSize, self.VPDSize / 1024.0))\r |
| | 1604 | FileWrite(File, gSubSectionSep)\r |
| | 1605 | for item in self.VPDInfoList:\r |
| | 1606 | FileWrite(File, item)\r |
| | 1607 | FileWrite(File, gSubSectionEnd)\r |
| | 1608 | FileWrite(File, gSectionEnd)\r |
| | 1609 | \r |
| | 1610 | \r |
| | 1611 | \r |
| | 1612 | ##\r |
| | 1613 | # Reports platform information\r |
| | 1614 | #\r |
| | 1615 | # This class reports the whole platform information\r |
| | 1616 | #\r |
| | 1617 | class PlatformReport(object):\r |
| | 1618 | ##\r |
| | 1619 | # Constructor function for class PlatformReport\r |
| | 1620 | #\r |
| | 1621 | # This constructor function generates PlatformReport object a platform build.\r |
| | 1622 | # It generates report for platform summary, flash, global PCDs and detailed\r |
| | 1623 | # module information for modules involved in platform build.\r |
| | 1624 | #\r |
| | 1625 | # @param self The object pointer\r |
| | 1626 | # @param Wa Workspace context information\r |
| | 1627 | # @param MaList The list of modules in the platform build\r |
| | 1628 | #\r |
| | 1629 | def __init__(self, Wa, MaList, ReportType):\r |
| | 1630 | self._WorkspaceDir = Wa.WorkspaceDir\r |
| | 1631 | self.PlatformName = Wa.Name\r |
| | 1632 | self.PlatformDscPath = Wa.Platform\r |
| | 1633 | self.Architectures = " ".join(Wa.ArchList)\r |
| | 1634 | self.ToolChain = Wa.ToolChain\r |
| | 1635 | self.Target = Wa.BuildTarget\r |
| | 1636 | self.OutputPath = os.path.join(Wa.WorkspaceDir, Wa.OutputDir)\r |
| | 1637 | self.BuildEnvironment = platform.platform()\r |
| | 1638 | \r |
| | 1639 | self.PcdReport = None\r |
| | 1640 | if "PCD" in ReportType:\r |
| | 1641 | self.PcdReport = PcdReport(Wa)\r |
| | 1642 | \r |
| | 1643 | self.FdReportList = []\r |
| | 1644 | if "FLASH" in ReportType and Wa.FdfProfile and MaList == None:\r |
| | 1645 | for Fd in Wa.FdfProfile.FdDict:\r |
| | 1646 | self.FdReportList.append(FdReport(Wa.FdfProfile.FdDict[Fd], Wa))\r |
| | 1647 | \r |
| | 1648 | self.PredictionReport = None\r |
| | 1649 | if "FIXED_ADDRESS" in ReportType or "EXECUTION_ORDER" in ReportType:\r |
| | 1650 | self.PredictionReport = PredictionReport(Wa)\r |
| | 1651 | \r |
| | 1652 | self.DepexParser = None\r |
| | 1653 | if "DEPEX" in ReportType:\r |
| | 1654 | self.DepexParser = DepexParser(Wa)\r |
| | 1655 | \r |
| | 1656 | self.ModuleReportList = []\r |
| | 1657 | if MaList != None:\r |
| | 1658 | self._IsModuleBuild = True\r |
| | 1659 | for Ma in MaList:\r |
| | 1660 | self.ModuleReportList.append(ModuleReport(Ma, ReportType))\r |
| | 1661 | else:\r |
| | 1662 | self._IsModuleBuild = False\r |
| | 1663 | for Pa in Wa.AutoGenObjectList:\r |
| | 1664 | ModuleAutoGenList = []\r |
| | 1665 | for ModuleKey in Pa.Platform.Modules:\r |
| | 1666 | ModuleAutoGenList.append(Pa.Platform.Modules[ModuleKey].M)\r |
| | 1667 | if GlobalData.gFdfParser != None:\r |
| | 1668 | if Pa.Arch in GlobalData.gFdfParser.Profile.InfDict:\r |
| | 1669 | INFList = GlobalData.gFdfParser.Profile.InfDict[Pa.Arch]\r |
| | 1670 | for InfName in INFList:\r |
| | 1671 | InfClass = PathClass(NormPath(InfName), Wa.WorkspaceDir, Pa.Arch)\r |
| | 1672 | Ma = ModuleAutoGen(Wa, InfClass, Pa.BuildTarget, Pa.ToolChain, Pa.Arch, Wa.MetaFile)\r |
| | 1673 | if Ma == None:\r |
| | 1674 | continue\r |
| | 1675 | if Ma not in ModuleAutoGenList:\r |
| | 1676 | ModuleAutoGenList.append(Ma)\r |
| | 1677 | for MGen in ModuleAutoGenList:\r |
| | 1678 | self.ModuleReportList.append(ModuleReport(MGen, ReportType))\r |
| | 1679 | \r |
| | 1680 | \r |
| | 1681 | \r |
| | 1682 | ##\r |
| | 1683 | # Generate report for the whole platform.\r |
| | 1684 | #\r |
| | 1685 | # This function generates report for platform information.\r |
| | 1686 | # It comprises of platform summary, global PCD, flash and\r |
| | 1687 | # module list sections.\r |
| | 1688 | #\r |
| | 1689 | # @param self The object pointer\r |
| | 1690 | # @param File The file object for report\r |
| | 1691 | # @param BuildDuration The total time to build the modules\r |
| | 1692 | # @param ReportType The kind of report items in the final report file\r |
| | 1693 | #\r |
| | 1694 | def GenerateReport(self, File, BuildDuration, ReportType):\r |
| | 1695 | FileWrite(File, "Platform Summary")\r |
| | 1696 | FileWrite(File, "Platform Name: %s" % self.PlatformName)\r |
| | 1697 | FileWrite(File, "Platform DSC Path: %s" % self.PlatformDscPath)\r |
| | 1698 | FileWrite(File, "Architectures: %s" % self.Architectures)\r |
| | 1699 | FileWrite(File, "Tool Chain: %s" % self.ToolChain)\r |
| | 1700 | FileWrite(File, "Target: %s" % self.Target)\r |
| | 1701 | FileWrite(File, "Output Path: %s" % self.OutputPath)\r |
| | 1702 | FileWrite(File, "Build Environment: %s" % self.BuildEnvironment)\r |
| | 1703 | FileWrite(File, "Build Duration: %s" % BuildDuration)\r |
| | 1704 | FileWrite(File, "Report Content: %s" % ", ".join(ReportType))\r |
| | 1705 | \r |
| | 1706 | if GlobalData.MixedPcd:\r |
| | 1707 | FileWrite(File, gSectionStart)\r |
| | 1708 | FileWrite(File, "The following PCDs use different access methods:")\r |
| | 1709 | FileWrite(File, gSectionSep)\r |
| | 1710 | for PcdItem in GlobalData.MixedPcd:\r |
| | 1711 | FileWrite(File, "%s.%s" % (str(PcdItem[1]), str(PcdItem[0])))\r |
| | 1712 | FileWrite(File, gSectionEnd)\r |
| | 1713 | \r |
| | 1714 | if not self._IsModuleBuild:\r |
| | 1715 | if "PCD" in ReportType:\r |
| | 1716 | self.PcdReport.GenerateReport(File, None)\r |
| | 1717 | \r |
| | 1718 | if "FLASH" in ReportType:\r |
| | 1719 | for FdReportListItem in self.FdReportList:\r |
| | 1720 | FdReportListItem.GenerateReport(File)\r |
| | 1721 | \r |
| | 1722 | for ModuleReportItem in self.ModuleReportList:\r |
| | 1723 | ModuleReportItem.GenerateReport(File, self.PcdReport, self.PredictionReport, self.DepexParser, ReportType)\r |
| | 1724 | \r |
| | 1725 | if not self._IsModuleBuild:\r |
| | 1726 | if "EXECUTION_ORDER" in ReportType:\r |
| | 1727 | self.PredictionReport.GenerateReport(File, None)\r |
| | 1728 | \r |
| | 1729 | ## BuildReport class\r |
| | 1730 | #\r |
| | 1731 | # This base class contain the routines to collect data and then\r |
| | 1732 | # applies certain format to the output report\r |
| | 1733 | #\r |
| | 1734 | class BuildReport(object):\r |
| | 1735 | ##\r |
| | 1736 | # Constructor function for class BuildReport\r |
| | 1737 | #\r |
| | 1738 | # This constructor function generates BuildReport object a platform build.\r |
| | 1739 | # It generates report for platform summary, flash, global PCDs and detailed\r |
| | 1740 | # module information for modules involved in platform build.\r |
| | 1741 | #\r |
| | 1742 | # @param self The object pointer\r |
| | 1743 | # @param ReportFile The file name to save report file\r |
| | 1744 | # @param ReportType The kind of report items in the final report file\r |
| | 1745 | #\r |
| | 1746 | def __init__(self, ReportFile, ReportType):\r |
| | 1747 | self.ReportFile = ReportFile\r |
| | 1748 | if ReportFile:\r |
| | 1749 | self.ReportList = []\r |
| | 1750 | self.ReportType = []\r |
| | 1751 | if ReportType: \r |
| | 1752 | for ReportTypeItem in ReportType:\r |
| | 1753 | if ReportTypeItem not in self.ReportType:\r |
| | 1754 | self.ReportType.append(ReportTypeItem)\r |
| | 1755 | else:\r |
| | 1756 | self.ReportType = ["PCD", "LIBRARY", "BUILD_FLAGS", "DEPEX", "HASH", "FLASH", "FIXED_ADDRESS"]\r |
| | 1757 | ##\r |
| | 1758 | # Adds platform report to the list\r |
| | 1759 | #\r |
| | 1760 | # This function adds a platform report to the final report list.\r |
| | 1761 | #\r |
| | 1762 | # @param self The object pointer\r |
| | 1763 | # @param Wa Workspace context information\r |
| | 1764 | # @param MaList The list of modules in the platform build\r |
| | 1765 | #\r |
| | 1766 | def AddPlatformReport(self, Wa, MaList=None):\r |
| | 1767 | if self.ReportFile:\r |
| | 1768 | self.ReportList.append((Wa, MaList))\r |
| | 1769 | \r |
| | 1770 | ##\r |
| | 1771 | # Generates the final report.\r |
| | 1772 | #\r |
| | 1773 | # This function generates platform build report. It invokes GenerateReport()\r |
| | 1774 | # method for every platform report in the list.\r |
| | 1775 | #\r |
| | 1776 | # @param self The object pointer\r |
| | 1777 | # @param BuildDuration The total time to build the modules\r |
| | 1778 | #\r |
| | 1779 | def GenerateReport(self, BuildDuration):\r |
| | 1780 | if self.ReportFile:\r |
| | 1781 | try:\r |
| | 1782 | File = StringIO('')\r |
| | 1783 | for (Wa, MaList) in self.ReportList:\r |
| | 1784 | PlatformReport(Wa, MaList, self.ReportType).GenerateReport(File, BuildDuration, self.ReportType)\r |
| | 1785 | Content = FileLinesSplit(File.getvalue(), gLineMaxLength)\r |
| | 1786 | SaveFileOnChange(self.ReportFile, Content, True)\r |
| | 1787 | EdkLogger.quiet("Build report can be found at %s" % os.path.abspath(self.ReportFile))\r |
| | 1788 | except IOError:\r |
| | 1789 | EdkLogger.error(None, FILE_WRITE_FAILURE, ExtraData=self.ReportFile)\r |
| | 1790 | except:\r |
| | 1791 | EdkLogger.error("BuildReport", CODE_ERROR, "Unknown fatal error when generating build report", ExtraData=self.ReportFile, RaiseError=False)\r |
| | 1792 | EdkLogger.quiet("(Python %s on %s\n%s)" % (platform.python_version(), sys.platform, traceback.format_exc()))\r |
| | 1793 | File.close()\r |
| | 1794 | \r |
| | 1795 | # This acts like the main() function for the script, unless it is 'import'ed into another script.\r |
| | 1796 | if __name__ == '__main__':\r |
| | 1797 | pass\r |
| | 1798 | \r |
projects / mirror_edk2.git / blame_incremental