[mirror_edk2.git] / BaseTools / Scripts / SmiHandlerProfileSymbolGen.py

##\r
# Generate symbal for SMI handler profile info.\r
#\r
# This tool depends on DIA2Dump.exe (VS) or nm (gcc) to parse debug entry.\r
#\r
# Copyright (c) 2017, Intel Corporation. All rights reserved.<BR>\r
# This program and the accompanying materials are licensed and made available under\r
# the terms and conditions of the BSD License that accompanies this distribution.\r
# The full text of the license may be found at\r
# http://opensource.org/licenses/bsd-license.php.\r
#\r
# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
#\r
##\r
\r
from __future__ import print_function\r
import os\r
import re\r
import sys\r
from optparse import OptionParser\r
\r
from xml.dom.minidom import parse\r
import xml.dom.minidom\r
\r
versionNumber = "1.1"\r
__copyright__ = "Copyright (c) 2016, Intel Corporation. All rights reserved."\r
\r
class Symbols:\r
    def __init__(self):\r
        self.listLineAddress = []\r
        self.pdbName = ""\r
        # Cache for function\r
        self.functionName = ""\r
        # Cache for line\r
        self.sourceName = ""\r
\r
\r
    def getSymbol (self, rva):\r
        index = 0\r
        lineName  = 0\r
        sourceName = "??"\r
        while index + 1 < self.lineCount :\r
            if self.listLineAddress[index][0] <= rva and self.listLineAddress[index + 1][0] > rva :\r
                offset = rva - self.listLineAddress[index][0]\r
                functionName = self.listLineAddress[index][1]\r
                lineName = self.listLineAddress[index][2]\r
                sourceName = self.listLineAddress[index][3]\r
                if lineName == 0 :\r
                  return [functionName]\r
                else :\r
                  return [functionName, sourceName, lineName]\r
            index += 1\r
\r
        return []\r
\r
    def parse_debug_file(self, driverName, pdbName):\r
        if cmp (pdbName, "") == 0 :\r
            return\r
        self.pdbName = pdbName;\r
\r
        try:\r
            nmCommand = "nm"\r
            nmLineOption = "-l"\r
            print("parsing (debug) - " + pdbName)\r
            os.system ('%s %s %s > nmDump.line.log' % (nmCommand, nmLineOption, pdbName))\r
        except :\r
            print('ERROR: nm command not available.  Please verify PATH')\r
            return\r
\r
        #\r
        # parse line\r
        #\r
        linefile = open("nmDump.line.log")\r
        reportLines = linefile.readlines()\r
        linefile.close()\r
\r
        # 000113ca T AllocatePool c:\home\edk-ii\MdePkg\Library\UefiMemoryAllocationLib\MemoryAllocationLib.c:399\r
        patchLineFileMatchString = "([0-9a-fA-F]*)\s+[T|D|t|d]\s+(\w+)\s*((?:[a-zA-Z]:)?[\w+\-./_a-zA-Z0-9\\\\]*):?([0-9]*)"\r
\r
        for reportLine in reportLines:\r
            match = re.match(patchLineFileMatchString, reportLine)\r
            if match is not None:\r
                rva = int (match.group(1), 16)\r
                functionName = match.group(2)\r
                sourceName = match.group(3)\r
                if cmp (match.group(4), "") != 0 :\r
                    lineName = int (match.group(4))\r
                else :\r
                    lineName = 0\r
                self.listLineAddress.append ([rva, functionName, lineName, sourceName])\r
\r
        self.lineCount = len (self.listLineAddress)\r
\r
        self.listLineAddress = sorted(self.listLineAddress, key=lambda symbolAddress:symbolAddress[0])\r
\r
    def parse_pdb_file(self, driverName, pdbName):\r
        if cmp (pdbName, "") == 0 :\r
            return\r
        self.pdbName = pdbName;\r
\r
        try:\r
            #DIA2DumpCommand = "\"C:\\Program Files (x86)\Microsoft Visual Studio 14.0\\DIA SDK\\Samples\\DIA2Dump\\x64\\Debug\\Dia2Dump.exe\""\r
            DIA2DumpCommand = "Dia2Dump.exe"\r
            #DIA2SymbolOption = "-p"\r
            DIA2LinesOption = "-l"\r
            print("parsing (pdb) - " + pdbName)\r
            #os.system ('%s %s %s > DIA2Dump.symbol.log' % (DIA2DumpCommand, DIA2SymbolOption, pdbName))\r
            os.system ('%s %s %s > DIA2Dump.line.log' % (DIA2DumpCommand, DIA2LinesOption, pdbName))\r
        except :\r
            print('ERROR: DIA2Dump command not available.  Please verify PATH')\r
            return\r
\r
        #\r
        # parse line\r
        #\r
        linefile = open("DIA2Dump.line.log")\r
        reportLines = linefile.readlines()\r
        linefile.close()\r
\r
        #   ** GetDebugPrintErrorLevel\r
        # line 32 at [0000C790][0001:0000B790], len = 0x3 c:\home\edk-ii\mdepkg\library\basedebugprinterrorlevellib\basedebugprinterrorlevellib.c (MD5: 687C0AE564079D35D56ED5D84A6164CC)\r
        # line 36 at [0000C793][0001:0000B793], len = 0x5\r
        # line 37 at [0000C798][0001:0000B798], len = 0x2\r
\r
        patchLineFileMatchString = "\s+line ([0-9]+) at \[([0-9a-fA-F]{8})\]\[[0-9a-fA-F]{4}\:[0-9a-fA-F]{8}\], len = 0x[0-9a-fA-F]+\s*([\w+\-\:./_a-zA-Z0-9\\\\]*)\s*"\r
        patchLineFileMatchStringFunc = "\*\*\s+(\w+)\s*"\r
\r
        for reportLine in reportLines:\r
            match = re.match(patchLineFileMatchString, reportLine)\r
            if match is not None:\r
                if cmp (match.group(3), "") != 0 :\r
                    self.sourceName = match.group(3)\r
                sourceName = self.sourceName\r
                functionName = self.functionName\r
\r
                rva = int (match.group(2), 16)\r
                lineName = int (match.group(1))\r
                self.listLineAddress.append ([rva, functionName, lineName, sourceName])\r
            else :\r
                match = re.match(patchLineFileMatchStringFunc, reportLine)\r
                if match is not None:\r
                    self.functionName = match.group(1)\r
\r
        self.lineCount = len (self.listLineAddress)\r
        self.listLineAddress = sorted(self.listLineAddress, key=lambda symbolAddress:symbolAddress[0])\r
\r
class SymbolsFile:\r
    def __init__(self):\r
        self.symbolsTable = {}\r
\r
symbolsFile = ""\r
\r
driverName = ""\r
rvaName = ""\r
symbolName = ""\r
\r
def getSymbolName(driverName, rva):\r
    global symbolsFile\r
\r
    try :\r
        symbolList = symbolsFile.symbolsTable[driverName]\r
        if symbolList is not None:\r
            return symbolList.getSymbol (rva)\r
        else:\r
            return []\r
    except Exception:\r
        return []\r
\r
def myOptionParser():\r
    usage = "%prog [--version] [-h] [--help] [-i inputfile [-o outputfile] [-g guidreffile]]"\r
    Parser = OptionParser(usage=usage, description=__copyright__, version="%prog " + str(versionNumber))\r
    Parser.add_option("-i", "--inputfile", dest="inputfilename", type="string", help="The input memory profile info file output from MemoryProfileInfo application in MdeModulePkg")\r
    Parser.add_option("-o", "--outputfile", dest="outputfilename", type="string", help="The output memory profile info file with symbol, MemoryProfileInfoSymbol.txt will be used if it is not specified")\r
    Parser.add_option("-g", "--guidref", dest="guidreffilename", type="string", help="The input guid ref file output from build")\r
\r
    (Options, args) = Parser.parse_args()\r
    if Options.inputfilename is None:\r
        Parser.error("no input file specified")\r
    if Options.outputfilename is None:\r
        Options.outputfilename = "SmiHandlerProfileInfoSymbol.xml"\r
    return Options\r
\r
dictGuid = {\r
  '00000000-0000-0000-0000-000000000000':'gZeroGuid',\r
  '2A571201-4966-47F6-8B86-F31E41F32F10':'gEfiEventLegacyBootGuid',\r
  '27ABF055-B1B8-4C26-8048-748F37BAA2DF':'gEfiEventExitBootServicesGuid',\r
  '7CE88FB3-4BD7-4679-87A8-A8D8DEE50D2B':'gEfiEventReadyToBootGuid',\r
  '02CE967A-DD7E-4FFC-9EE7-810CF0470880':'gEfiEndOfDxeEventGroupGuid',\r
  '60FF8964-E906-41D0-AFED-F241E974E08E':'gEfiDxeSmmReadyToLockProtocolGuid',\r
  '18A3C6DC-5EEA-48C8-A1C1-B53389F98999':'gEfiSmmSwDispatch2ProtocolGuid',\r
  '456D2859-A84B-4E47-A2EE-3276D886997D':'gEfiSmmSxDispatch2ProtocolGuid',\r
  '4CEC368E-8E8E-4D71-8BE1-958C45FC8A53':'gEfiSmmPeriodicTimerDispatch2ProtocolGuid',\r
  'EE9B8D90-C5A6-40A2-BDE2-52558D33CCA1':'gEfiSmmUsbDispatch2ProtocolGuid',\r
  '25566B03-B577-4CBF-958C-ED663EA24380':'gEfiSmmGpiDispatch2ProtocolGuid',\r
  '7300C4A1-43F2-4017-A51B-C81A7F40585B':'gEfiSmmStandbyButtonDispatch2ProtocolGuid',\r
  '1B1183FA-1823-46A7-8872-9C578755409D':'gEfiSmmPowerButtonDispatch2ProtocolGuid',\r
  '58DC368D-7BFA-4E77-ABBC-0E29418DF930':'gEfiSmmIoTrapDispatch2ProtocolGuid',\r
  }\r
\r
def genGuidString(guidreffile):\r
    guidLines = guidreffile.readlines()\r
    for guidLine in guidLines:\r
        guidLineList = guidLine.split(" ")\r
        if len(guidLineList) == 2:\r
            guid = guidLineList[0]\r
            guidName = guidLineList[1]\r
            if guid not in dictGuid :\r
                dictGuid[guid] = guidName\r
\r
def createSym(symbolName):\r
    SymbolNode = xml.dom.minidom.Document().createElement("Symbol")\r
    SymbolFunction = xml.dom.minidom.Document().createElement("Function")\r
    SymbolFunctionData = xml.dom.minidom.Document().createTextNode(symbolName[0])\r
    SymbolFunction.appendChild(SymbolFunctionData)\r
    SymbolNode.appendChild(SymbolFunction)\r
    if (len(symbolName)) >= 2:\r
        SymbolSourceFile = xml.dom.minidom.Document().createElement("SourceFile")\r
        SymbolSourceFileData = xml.dom.minidom.Document().createTextNode(symbolName[1])\r
        SymbolSourceFile.appendChild(SymbolSourceFileData)\r
        SymbolNode.appendChild(SymbolSourceFile)\r
        if (len(symbolName)) >= 3:\r
            SymbolLineNumber = xml.dom.minidom.Document().createElement("LineNumber")\r
            SymbolLineNumberData = xml.dom.minidom.Document().createTextNode(str(symbolName[2]))\r
            SymbolLineNumber.appendChild(SymbolLineNumberData)\r
            SymbolNode.appendChild(SymbolLineNumber)\r
    return SymbolNode\r
\r
def main():\r
    global symbolsFile\r
    global Options\r
    Options = myOptionParser()\r
\r
    symbolsFile = SymbolsFile()\r
\r
    try :\r
        DOMTree = xml.dom.minidom.parse(Options.inputfilename)\r
    except Exception:\r
        print("fail to open input " + Options.inputfilename)\r
        return 1\r
\r
    if Options.guidreffilename is not None:\r
        try :\r
            guidreffile = open(Options.guidreffilename)\r
        except Exception:\r
            print("fail to open guidref" + Options.guidreffilename)\r
            return 1\r
        genGuidString(guidreffile)\r
        guidreffile.close()\r
\r
    SmiHandlerProfile = DOMTree.documentElement\r
\r
    SmiHandlerDatabase = SmiHandlerProfile.getElementsByTagName("SmiHandlerDatabase")\r
    SmiHandlerCategory = SmiHandlerDatabase[0].getElementsByTagName("SmiHandlerCategory")\r
    for smiHandlerCategory in SmiHandlerCategory:\r
        SmiEntry = smiHandlerCategory.getElementsByTagName("SmiEntry")\r
        for smiEntry in SmiEntry:\r
            if smiEntry.hasAttribute("HandlerType"):\r
                guidValue = smiEntry.getAttribute("HandlerType")\r
                if guidValue in dictGuid:\r
                    smiEntry.setAttribute("HandlerType", dictGuid[guidValue])\r
            SmiHandler = smiEntry.getElementsByTagName("SmiHandler")\r
            for smiHandler in SmiHandler:\r
                Module = smiHandler.getElementsByTagName("Module")\r
                Pdb = Module[0].getElementsByTagName("Pdb")\r
                if (len(Pdb)) >= 1:\r
                    driverName = Module[0].getAttribute("Name")\r
                    pdbName = Pdb[0].childNodes[0].data\r
\r
                    Module[0].removeChild(Pdb[0])\r
\r
                    symbolsFile.symbolsTable[driverName] = Symbols()\r
\r
                    if cmp (pdbName[-3:], "pdb") == 0 :\r
                        symbolsFile.symbolsTable[driverName].parse_pdb_file (driverName, pdbName)\r
                    else :\r
                        symbolsFile.symbolsTable[driverName].parse_debug_file (driverName, pdbName)\r
\r
                    Handler = smiHandler.getElementsByTagName("Handler")\r
                    RVA = Handler[0].getElementsByTagName("RVA")\r
                    print("    Handler RVA: %s" % RVA[0].childNodes[0].data)\r
\r
                    if (len(RVA)) >= 1:\r
                        rvaName = RVA[0].childNodes[0].data\r
                        symbolName = getSymbolName (driverName, int(rvaName, 16))\r
\r
                        if (len(symbolName)) >= 1:\r
                            SymbolNode = createSym(symbolName)\r
                            Handler[0].appendChild(SymbolNode)\r
\r
                    Caller = smiHandler.getElementsByTagName("Caller")\r
                    RVA = Caller[0].getElementsByTagName("RVA")\r
                    print("    Caller RVA: %s" % RVA[0].childNodes[0].data)\r
\r
                    if (len(RVA)) >= 1:\r
                        rvaName = RVA[0].childNodes[0].data\r
                        symbolName = getSymbolName (driverName, int(rvaName, 16))\r
\r
                        if (len(symbolName)) >= 1:\r
                            SymbolNode = createSym(symbolName)\r
                            Caller[0].appendChild(SymbolNode)\r
\r
    try :\r
        newfile = open(Options.outputfilename, "w")\r
    except Exception:\r
        print("fail to open output" + Options.outputfilename)\r
        return 1\r
\r
    newfile.write(DOMTree.toprettyxml(indent = "\t", newl = "\n", encoding = "utf-8"))\r
    newfile.close()\r
\r
if __name__ == '__main__':\r
    sys.exit(main())\r
Commit	Line	Data
88dab294 JY	1	##\r
	2	# Generate symbal for SMI handler profile info.\r
	3	#\r
	4	# This tool depends on DIA2Dump.exe (VS) or nm (gcc) to parse debug entry.\r
	5	#\r
	6	# Copyright (c) 2017, Intel Corporation. All rights reserved.<BR>\r
	7	# This program and the accompanying materials are licensed and made available under\r
	8	# the terms and conditions of the BSD License that accompanies this distribution.\r
	9	# The full text of the license may be found at\r
	10	# http://opensource.org/licenses/bsd-license.php.\r
	11	#\r
	12	# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	13	# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	14	#\r
	15	##\r
	16	\r
72443dd2	17	from __future__ import print_function\r
88dab294 JY	18	import os\r
	19	import re\r
	20	import sys\r
	21	from optparse import OptionParser\r
	22	\r
	23	from xml.dom.minidom import parse\r
	24	import xml.dom.minidom\r
	25	\r
	26	versionNumber = "1.1"\r
	27	__copyright__ = "Copyright (c) 2016, Intel Corporation. All rights reserved."\r
	28	\r
	29	class Symbols:\r
	30	def __init__(self):\r
	31	self.listLineAddress = []\r
	32	self.pdbName = ""\r
	33	# Cache for function\r
	34	self.functionName = ""\r
	35	# Cache for line\r
	36	self.sourceName = ""\r
	37	\r
	38	\r
	39	def getSymbol (self, rva):\r
	40	index = 0\r
	41	lineName = 0\r
	42	sourceName = "??"\r
	43	while index + 1 < self.lineCount :\r
	44	if self.listLineAddress[index][0] <= rva and self.listLineAddress[index + 1][0] > rva :\r
	45	offset = rva - self.listLineAddress[index][0]\r
	46	functionName = self.listLineAddress[index][1]\r
	47	lineName = self.listLineAddress[index][2]\r
	48	sourceName = self.listLineAddress[index][3]\r
	49	if lineName == 0 :\r
	50	return [functionName]\r
	51	else :\r
	52	return [functionName, sourceName, lineName]\r
	53	index += 1\r
	54	\r
	55	return []\r
	56	\r
	57	def parse_debug_file(self, driverName, pdbName):\r
	58	if cmp (pdbName, "") == 0 :\r
	59	return\r
	60	self.pdbName = pdbName;\r
	61	\r
	62	try:\r
	63	nmCommand = "nm"\r
	64	nmLineOption = "-l"\r
72443dd2	65	print("parsing (debug) - " + pdbName)\r
88dab294 JY	66	os.system ('%s %s %s > nmDump.line.log' % (nmCommand, nmLineOption, pdbName))\r
88dab294 JY	67	except :\r
72443dd2	68	print('ERROR: nm command not available. Please verify PATH')\r
88dab294 JY	69	return\r
	70	\r
	71	#\r
	72	# parse line\r
	73	#\r
	74	linefile = open("nmDump.line.log")\r
	75	reportLines = linefile.readlines()\r
	76	linefile.close()\r
	77	\r
	78	# 000113ca T AllocatePool c:\home\edk-ii\MdePkg\Library\UefiMemoryAllocationLib\MemoryAllocationLib.c:399\r
	79	patchLineFileMatchString = "([0-9a-fA-F])\s+[T\|D\|t\|d]\s+(\w+)\s((?:[a-zA-Z]:)?[\w+\-./_a-zA-Z0-9\\\\]):?([0-9])"\r
	80	\r
	81	for reportLine in reportLines:\r
	82	match = re.match(patchLineFileMatchString, reportLine)\r
	83	if match is not None:\r
	84	rva = int (match.group(1), 16)\r
	85	functionName = match.group(2)\r
	86	sourceName = match.group(3)\r
	87	if cmp (match.group(4), "") != 0 :\r
	88	lineName = int (match.group(4))\r
	89	else :\r
	90	lineName = 0\r
	91	self.listLineAddress.append ([rva, functionName, lineName, sourceName])\r
	92	\r
	93	self.lineCount = len (self.listLineAddress)\r
	94	\r
	95	self.listLineAddress = sorted(self.listLineAddress, key=lambda symbolAddress:symbolAddress[0])\r
	96	\r
	97	def parse_pdb_file(self, driverName, pdbName):\r
	98	if cmp (pdbName, "") == 0 :\r
	99	return\r
	100	self.pdbName = pdbName;\r
	101	\r
	102	try:\r
	103	#DIA2DumpCommand = "\"C:\\Program Files (x86)\Microsoft Visual Studio 14.0\\DIA SDK\\Samples\\DIA2Dump\\x64\\Debug\\Dia2Dump.exe\""\r
	104	DIA2DumpCommand = "Dia2Dump.exe"\r
	105	#DIA2SymbolOption = "-p"\r
	106	DIA2LinesOption = "-l"\r
72443dd2	107	print("parsing (pdb) - " + pdbName)\r
88dab294 JY	108	#os.system ('%s %s %s > DIA2Dump.symbol.log' % (DIA2DumpCommand, DIA2SymbolOption, pdbName))\r
	109	os.system ('%s %s %s > DIA2Dump.line.log' % (DIA2DumpCommand, DIA2LinesOption, pdbName))\r
	110	except :\r
72443dd2	111	print('ERROR: DIA2Dump command not available. Please verify PATH')\r
88dab294 JY	112	return\r
	113	\r
	114	#\r
	115	# parse line\r
	116	#\r
	117	linefile = open("DIA2Dump.line.log")\r
	118	reportLines = linefile.readlines()\r
	119	linefile.close()\r
	120	\r
	121	# ** GetDebugPrintErrorLevel\r
	122	# line 32 at [0000C790][0001:0000B790], len = 0x3 c:\home\edk-ii\mdepkg\library\basedebugprinterrorlevellib\basedebugprinterrorlevellib.c (MD5: 687C0AE564079D35D56ED5D84A6164CC)\r
	123	# line 36 at [0000C793][0001:0000B793], len = 0x5\r
	124	# line 37 at [0000C798][0001:0000B798], len = 0x2\r
	125	\r
	126	patchLineFileMatchString = "\s+line ([0-9]+) at \[([0-9a-fA-F]{8})\]\[[0-9a-fA-F]{4}\:[0-9a-fA-F]{8}\], len = 0x[0-9a-fA-F]+\s([\w+\-\:./_a-zA-Z0-9\\\\])\s*"\r
	127	patchLineFileMatchStringFunc = "\\\s+(\w+)\s*"\r
	128	\r
	129	for reportLine in reportLines:\r
	130	match = re.match(patchLineFileMatchString, reportLine)\r
	131	if match is not None:\r
	132	if cmp (match.group(3), "") != 0 :\r
	133	self.sourceName = match.group(3)\r
	134	sourceName = self.sourceName\r
	135	functionName = self.functionName\r
	136	\r
	137	rva = int (match.group(2), 16)\r
	138	lineName = int (match.group(1))\r
	139	self.listLineAddress.append ([rva, functionName, lineName, sourceName])\r
	140	else :\r
	141	match = re.match(patchLineFileMatchStringFunc, reportLine)\r
	142	if match is not None:\r
	143	self.functionName = match.group(1)\r
	144	\r
	145	self.lineCount = len (self.listLineAddress)\r
	146	self.listLineAddress = sorted(self.listLineAddress, key=lambda symbolAddress:symbolAddress[0])\r
	147	\r
	148	class SymbolsFile:\r
	149	def __init__(self):\r
	150	self.symbolsTable = {}\r
	151	\r
	152	symbolsFile = ""\r
	153	\r
	154	driverName = ""\r
	155	rvaName = ""\r
	156	symbolName = ""\r
	157	\r
	158	def getSymbolName(driverName, rva):\r
	159	global symbolsFile\r
	160	\r
	161	try :\r
	162	symbolList = symbolsFile.symbolsTable[driverName]\r
	163	if symbolList is not None:\r
	164	return symbolList.getSymbol (rva)\r
	165	else:\r
	166	return []\r
	167	except Exception:\r
	168	return []\r
	169	\r
	170	def myOptionParser():\r
	171	usage = "%prog [--version] [-h] [--help] [-i inputfile [-o outputfile] [-g guidreffile]]"\r
	172	Parser = OptionParser(usage=usage, description=__copyright__, version="%prog " + str(versionNumber))\r
	173	Parser.add_option("-i", "--inputfile", dest="inputfilename", type="string", help="The input memory profile info file output from MemoryProfileInfo application in MdeModulePkg")\r
	174	Parser.add_option("-o", "--outputfile", dest="outputfilename", type="string", help="The output memory profile info file with symbol, MemoryProfileInfoSymbol.txt will be used if it is not specified")\r
	175	Parser.add_option("-g", "--guidref", dest="guidreffilename", type="string", help="The input guid ref file output from build")\r
176	\r
177	(Options, args) = Parser.parse_args()\r
178	if Options.inputfilename is None:\r
179	Parser.error("no input file specified")\r
180	if Options.outputfilename is None:\r
181	Options.outputfilename = "SmiHandlerProfileInfoSymbol.xml"\r
182	return Options\r
183	\r
184	dictGuid = {\r
185	'00000000-0000-0000-0000-000000000000':'gZeroGuid',\r
186	'2A571201-4966-47F6-8B86-F31E41F32F10':'gEfiEventLegacyBootGuid',\r
187	'27ABF055-B1B8-4C26-8048-748F37BAA2DF':'gEfiEventExitBootServicesGuid',\r
188	'7CE88FB3-4BD7-4679-87A8-A8D8DEE50D2B':'gEfiEventReadyToBootGuid',\r
189	'02CE967A-DD7E-4FFC-9EE7-810CF0470880':'gEfiEndOfDxeEventGroupGuid',\r
190	'60FF8964-E906-41D0-AFED-F241E974E08E':'gEfiDxeSmmReadyToLockProtocolGuid',\r
191	'18A3C6DC-5EEA-48C8-A1C1-B53389F98999':'gEfiSmmSwDispatch2ProtocolGuid',\r
192	'456D2859-A84B-4E47-A2EE-3276D886997D':'gEfiSmmSxDispatch2ProtocolGuid',\r
193	'4CEC368E-8E8E-4D71-8BE1-958C45FC8A53':'gEfiSmmPeriodicTimerDispatch2ProtocolGuid',\r
194	'EE9B8D90-C5A6-40A2-BDE2-52558D33CCA1':'gEfiSmmUsbDispatch2ProtocolGuid',\r
195	'25566B03-B577-4CBF-958C-ED663EA24380':'gEfiSmmGpiDispatch2ProtocolGuid',\r
196	'7300C4A1-43F2-4017-A51B-C81A7F40585B':'gEfiSmmStandbyButtonDispatch2ProtocolGuid',\r
197	'1B1183FA-1823-46A7-8872-9C578755409D':'gEfiSmmPowerButtonDispatch2ProtocolGuid',\r
198	'58DC368D-7BFA-4E77-ABBC-0E29418DF930':'gEfiSmmIoTrapDispatch2ProtocolGuid',\r
199	}\r
200	\r
201	def genGuidString(guidreffile):\r
202	guidLines = guidreffile.readlines()\r
203	for guidLine in guidLines:\r
204	guidLineList = guidLine.split(" ")\r
205	if len(guidLineList) == 2:\r
206	guid = guidLineList[0]\r
207	guidName = guidLineList[1]\r
98120f5f	208	if guid not in dictGuid :\r
88dab294 JY	209	dictGuid[guid] = guidName\r
	210	\r
	211	def createSym(symbolName):\r
	212	SymbolNode = xml.dom.minidom.Document().createElement("Symbol")\r
	213	SymbolFunction = xml.dom.minidom.Document().createElement("Function")\r
	214	SymbolFunctionData = xml.dom.minidom.Document().createTextNode(symbolName[0])\r
	215	SymbolFunction.appendChild(SymbolFunctionData)\r
	216	SymbolNode.appendChild(SymbolFunction)\r
	217	if (len(symbolName)) >= 2:\r
	218	SymbolSourceFile = xml.dom.minidom.Document().createElement("SourceFile")\r
	219	SymbolSourceFileData = xml.dom.minidom.Document().createTextNode(symbolName[1])\r
	220	SymbolSourceFile.appendChild(SymbolSourceFileData)\r
	221	SymbolNode.appendChild(SymbolSourceFile)\r
	222	if (len(symbolName)) >= 3:\r
	223	SymbolLineNumber = xml.dom.minidom.Document().createElement("LineNumber")\r
	224	SymbolLineNumberData = xml.dom.minidom.Document().createTextNode(str(symbolName[2]))\r
	225	SymbolLineNumber.appendChild(SymbolLineNumberData)\r
	226	SymbolNode.appendChild(SymbolLineNumber)\r
	227	return SymbolNode\r
	228	\r
	229	def main():\r
	230	global symbolsFile\r
	231	global Options\r
	232	Options = myOptionParser()\r
	233	\r
	234	symbolsFile = SymbolsFile()\r
	235	\r
	236	try :\r
	237	DOMTree = xml.dom.minidom.parse(Options.inputfilename)\r
	238	except Exception:\r
72443dd2	239	print("fail to open input " + Options.inputfilename)\r
88dab294 JY	240	return 1\r
	241	\r
	242	if Options.guidreffilename is not None:\r
	243	try :\r
	244	guidreffile = open(Options.guidreffilename)\r
	245	except Exception:\r
72443dd2	246	print("fail to open guidref" + Options.guidreffilename)\r
88dab294 JY	247	return 1\r
	248	genGuidString(guidreffile)\r
	249	guidreffile.close()\r
	250	\r
	251	SmiHandlerProfile = DOMTree.documentElement\r
	252	\r
	253	SmiHandlerDatabase = SmiHandlerProfile.getElementsByTagName("SmiHandlerDatabase")\r
	254	SmiHandlerCategory = SmiHandlerDatabase[0].getElementsByTagName("SmiHandlerCategory")\r
	255	for smiHandlerCategory in SmiHandlerCategory:\r
	256	SmiEntry = smiHandlerCategory.getElementsByTagName("SmiEntry")\r
	257	for smiEntry in SmiEntry:\r
	258	if smiEntry.hasAttribute("HandlerType"):\r
	259	guidValue = smiEntry.getAttribute("HandlerType")\r
98120f5f	260	if guidValue in dictGuid:\r
88dab294 JY	261	smiEntry.setAttribute("HandlerType", dictGuid[guidValue])\r
	262	SmiHandler = smiEntry.getElementsByTagName("SmiHandler")\r
	263	for smiHandler in SmiHandler:\r
	264	Module = smiHandler.getElementsByTagName("Module")\r
	265	Pdb = Module[0].getElementsByTagName("Pdb")\r
	266	if (len(Pdb)) >= 1:\r
	267	driverName = Module[0].getAttribute("Name")\r
	268	pdbName = Pdb[0].childNodes[0].data\r
	269	\r
	270	Module[0].removeChild(Pdb[0])\r
	271	\r
	272	symbolsFile.symbolsTable[driverName] = Symbols()\r
	273	\r
	274	if cmp (pdbName[-3:], "pdb") == 0 :\r
	275	symbolsFile.symbolsTable[driverName].parse_pdb_file (driverName, pdbName)\r
	276	else :\r
	277	symbolsFile.symbolsTable[driverName].parse_debug_file (driverName, pdbName)\r
	278	\r
	279	Handler = smiHandler.getElementsByTagName("Handler")\r
	280	RVA = Handler[0].getElementsByTagName("RVA")\r
72443dd2	281	print(" Handler RVA: %s" % RVA[0].childNodes[0].data)\r
88dab294 JY	282	\r
	283	if (len(RVA)) >= 1:\r
	284	rvaName = RVA[0].childNodes[0].data\r
	285	symbolName = getSymbolName (driverName, int(rvaName, 16))\r
	286	\r
	287	if (len(symbolName)) >= 1:\r
	288	SymbolNode = createSym(symbolName)\r
	289	Handler[0].appendChild(SymbolNode)\r
	290	\r
	291	Caller = smiHandler.getElementsByTagName("Caller")\r
	292	RVA = Caller[0].getElementsByTagName("RVA")\r
72443dd2	293	print(" Caller RVA: %s" % RVA[0].childNodes[0].data)\r
88dab294 JY	294	\r
	295	if (len(RVA)) >= 1:\r
	296	rvaName = RVA[0].childNodes[0].data\r
	297	symbolName = getSymbolName (driverName, int(rvaName, 16))\r
	298	\r
	299	if (len(symbolName)) >= 1:\r
	300	SymbolNode = createSym(symbolName)\r
	301	Caller[0].appendChild(SymbolNode)\r
	302	\r
	303	try :\r
	304	newfile = open(Options.outputfilename, "w")\r
	305	except Exception:\r
72443dd2	306	print("fail to open output" + Options.outputfilename)\r
88dab294 JY	307	return 1\r
	308	\r
	309	newfile.write(DOMTree.toprettyxml(indent = "\t", newl = "\n", encoding = "utf-8"))\r
	310	newfile.close()\r
	311	\r
	312	if __name__ == '__main__':\r
	313	sys.exit(main())\r