[mirror_edk2.git] / BaseTools / Source / Python / GenPatchPcdTable / GenPatchPcdTable.py

## @file\r
# Generate PCD table for 'Patchable In Module' type PCD with given .map file.\r
#    The Patch PCD table like:\r
#    \r
#    PCD Name    Offset in binary\r
#    ========    ================\r
#\r
# Copyright (c) 2008 - 2013, Intel Corporation. All rights reserved.<BR>\r
# This program and the accompanying materials\r
# are licensed and made available under the terms and conditions of the BSD License\r
# which accompanies this distribution.  The full text of the license may be found at\r
# 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
#======================================  External Libraries ========================================\r
import optparse\r
import os\r
import re\r
import array\r
\r
from Common.BuildToolError import *\r
import Common.EdkLogger as EdkLogger\r
from Common.Misc import PeImageClass\r
from Common.BuildVersion import gBUILD_VERSION\r
\r
# Version and Copyright\r
__version_number__ = ("0.10" + " " + gBUILD_VERSION)\r
__version__ = "%prog Version " + __version_number__\r
__copyright__ = "Copyright (c) 2008 - 2010, Intel Corporation. All rights reserved."\r
\r
#======================================  Internal Libraries ========================================\r
\r
#============================================== Code ===============================================\r
secRe = re.compile('^([\da-fA-F]+):([\da-fA-F]+) +([\da-fA-F]+)[Hh]? +([.\w\$]+) +(\w+)', re.UNICODE)\r
symRe = re.compile('^([\da-fA-F]+):([\da-fA-F]+) +([\.:\\\\\w\?@\$]+) +([\da-fA-F]+)', re.UNICODE)\r
\r
def parsePcdInfoFromMapFile(mapfilepath, efifilepath):\r
    """ Parse map file to get binary patch pcd information \r
    @param path    Map file absolution path\r
    \r
    @return a list which element hold (PcdName, Offset, SectionName)\r
    """\r
    lines = []\r
    try:\r
        f = open(mapfilepath, 'r')\r
        lines = f.readlines()\r
        f.close()\r
    except:\r
        return None\r
    \r
    if len(lines) == 0: return None\r
    if lines[0].strip().find("Archive member included because of file (symbol)") != -1:\r
        return _parseForGCC(lines, efifilepath)\r
    return _parseGeneral(lines, efifilepath)\r
\r
def _parseForGCC(lines, efifilepath):\r
    """ Parse map file generated by GCC linker """\r
    status = 0\r
    imageBase = -1\r
    sections = []\r
    bpcds = []\r
    for line in lines:\r
        line = line.strip()\r
        # status machine transection\r
        if status == 0 and line == "Memory Configuration":\r
            status = 1\r
            continue\r
        elif status == 1 and line == 'Linker script and memory map':\r
            status = 2\r
            continue\r
        elif status ==2 and line == 'START GROUP':\r
            status = 3\r
            continue\r
\r
        # status handler\r
        if status == 2:\r
            m = re.match('^([\w_\.]+) +([\da-fA-Fx]+) +([\da-fA-Fx]+)$', line)\r
            if m != None:\r
                sections.append(m.groups(0))\r
        if status == 2:\r
            m = re.match("^([\da-fA-Fx]+) +[_]+gPcd_BinaryPatch_([\w_\d]+)$", line)\r
            if m != None:\r
                bpcds.append((m.groups(0)[1], int(m.groups(0)[0], 16) , int(sections[-1][1], 16), sections[-1][0]))\r
                \r
    # get section information from efi file\r
    efisecs = PeImageClass(efifilepath).SectionHeaderList\r
    if efisecs == None or len(efisecs) == 0:\r
        return None\r
    #redirection\r
    redirection = 0\r
    for efisec in efisecs:\r
        for section in sections:\r
            if section[0].strip() == efisec[0].strip() and section[0].strip() == '.text':\r
                redirection = int(section[1], 16) - efisec[1]\r
    pcds = []\r
    for pcd in bpcds:\r
        for efisec in efisecs:\r
            if pcd[1] >= efisec[1] and pcd[1] < efisec[1]+efisec[3]:\r
                #assert efisec[0].strip() == pcd[3].strip() and efisec[1] + redirection == pcd[2], "There are some differences between map file and efi file"\r
                pcds.append([pcd[0], efisec[2] + pcd[1] - efisec[1] - redirection, efisec[0]])\r
    return pcds\r
                \r
def _parseGeneral(lines, efifilepath):\r
    """ For MSFT, ICC, EBC \r
    @param lines    line array for map file\r
    \r
    @return a list which element hold (PcdName, Offset, SectionName)\r
    """    \r
    status = 0    #0 - beginning of file; 1 - PE section definition; 2 - symbol table\r
    secs  = []    # key = section name\r
    bPcds = []\r
    \r
\r
    for line in lines:\r
        line = line.strip()\r
        if re.match("^Start[' ']+Length[' ']+Name[' ']+Class", line):\r
            status = 1\r
            continue\r
        if re.match("^Address[' ']+Publics by Value[' ']+Rva\+Base", line):\r
            status = 2\r
            continue\r
        if re.match("^entry point at", line):\r
            status = 3\r
            continue        \r
        if status == 1 and len(line) != 0:\r
            m =  secRe.match(line)\r
            assert m != None, "Fail to parse the section in map file , line is %s" % line\r
            sec_no, sec_start, sec_length, sec_name, sec_class = m.groups(0)\r
            secs.append([int(sec_no, 16), int(sec_start, 16), int(sec_length, 16), sec_name, sec_class])\r
        if status == 2 and len(line) != 0:\r
            m = symRe.match(line)\r
            assert m != None, "Fail to parse the symbol in map file, line is %s" % line\r
            sec_no, sym_offset, sym_name, vir_addr = m.groups(0)\r
            sec_no     = int(sec_no,     16)\r
            sym_offset = int(sym_offset, 16)\r
            vir_addr   = int(vir_addr,   16)\r
            m2 = re.match('^[_]+gPcd_BinaryPatch_([\w]+)', sym_name)\r
            if m2 != None:\r
                # fond a binary pcd entry in map file\r
                for sec in secs:\r
                    if sec[0] == sec_no and (sym_offset >= sec[1] and sym_offset < sec[1] + sec[2]):\r
                        bPcds.append([m2.groups(0)[0], sec[3], sym_offset, vir_addr, sec_no])\r
\r
    if len(bPcds) == 0: return None\r
\r
    # get section information from efi file\r
    efisecs = PeImageClass(efifilepath).SectionHeaderList\r
    if efisecs == None or len(efisecs) == 0:\r
        return None\r
    \r
    pcds = []\r
    for pcd in bPcds:\r
        index = 0\r
        for efisec in efisecs:\r
            index = index + 1\r
            if pcd[1].strip() == efisec[0].strip():\r
                pcds.append([pcd[0], efisec[2] + pcd[2], efisec[0]])\r
            elif pcd[4] == index:\r
                pcds.append([pcd[0], efisec[2] + pcd[2], efisec[0]])\r
    return pcds\r
    \r
def generatePcdTable(list, pcdpath):\r
    try:\r
        f = open(pcdpath, 'w')\r
    except:\r
        pass\r
\r
    f.write('PCD Name                       Offset    Section Name\r\n')\r
    \r
    for pcditem in list:\r
        f.write('%-30s 0x%-08X %-6s\r\n' % (pcditem[0], pcditem[1], pcditem[2]))\r
    f.close()\r
\r
    #print 'Success to generate Binary Patch PCD table at %s!' % pcdpath \r
    \r
if __name__ == '__main__':\r
    UsageString = "%prog -m <MapFile> -e <EfiFile> -o <OutFile>"\r
    AdditionalNotes = "\nPCD table is generated in file name with .BinaryPcdTable.txt postfix"\r
    parser = optparse.OptionParser(description=__copyright__, version=__version__, usage=UsageString)\r
    parser.add_option('-m', '--mapfile', action='store', dest='mapfile',\r
                      help='Absolute path of module map file.')\r
    parser.add_option('-e', '--efifile', action='store', dest='efifile',\r
                      help='Absolute path of EFI binary file.')\r
    parser.add_option('-o', '--outputfile', action='store', dest='outfile',\r
                      help='Absolute path of output file to store the got patchable PCD table.')\r
  \r
    (options, args) = parser.parse_args()\r
\r
    if options.mapfile == None or options.efifile == None:\r
        print parser.get_usage()\r
    elif os.path.exists(options.mapfile) and os.path.exists(options.efifile):\r
        list = parsePcdInfoFromMapFile(options.mapfile, options.efifile) \r
        if list != None:\r
            if options.outfile != None:\r
                generatePcdTable(list, options.outfile)\r
            else:\r
                generatePcdTable(list, options.mapfile.replace('.map', '.BinaryPcdTable.txt')) \r
        else:\r
            print 'Fail to generate Patch PCD Table based on map file and efi file'\r
    else:\r
        print 'Fail to generate Patch PCD Table for fail to find map file or efi file!'\r
Commit	Line	Data
52302d4d LG	1	## @file\r
52302d4d LG	2	# Generate PCD table for 'Patchable In Module' type PCD with given .map file.\r
f51461c8 LG	3	# The Patch PCD table like:\r
	4	# \r
	5	# PCD Name Offset in binary\r
52302d4d LG	6	# ======== ================\r
52302d4d LG	7	#\r
e8a47801	8	# Copyright (c) 2008 - 2013, Intel Corporation. All rights reserved.<BR>\r
40d841f6	9	# This program and the accompanying materials\r
52302d4d LG	10	# are licensed and made available under the terms and conditions of the BSD License\r
	11	# which accompanies this distribution. The full text of the license may be found at\r
	12	# http://opensource.org/licenses/bsd-license.php\r
	13	#\r
	14	# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	15	# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	16	#\r
f51461c8 LG	17	#\r
	18	\r
	19	#====================================== External Libraries ========================================\r
	20	import optparse\r
	21	import os\r
	22	import re\r
	23	import array\r
	24	\r
	25	from Common.BuildToolError import *\r
	26	import Common.EdkLogger as EdkLogger\r
52302d4d	27	from Common.Misc import PeImageClass\r
b36d134f	28	from Common.BuildVersion import gBUILD_VERSION\r
f51461c8 LG	29	\r
	30	# Version and Copyright\r
	31	__version_number__ = ("0.10" + " " + gBUILD_VERSION)\r
	32	__version__ = "%prog Version " + __version_number__\r
	33	__copyright__ = "Copyright (c) 2008 - 2010, Intel Corporation. All rights reserved."\r
	34	\r
	35	#====================================== Internal Libraries ========================================\r
	36	\r
	37	#============================================== Code ===============================================\r
	38	secRe = re.compile('^([\da-fA-F]+):([\da-fA-F]+) +([\da-fA-F]+)[Hh]? +([.\w\$]+) +(\w+)', re.UNICODE)\r
	39	symRe = re.compile('^([\da-fA-F]+):([\da-fA-F]+) +([\.:\\\\\w\?@\$]+) +([\da-fA-F]+)', re.UNICODE)\r
	40	\r
	41	def parsePcdInfoFromMapFile(mapfilepath, efifilepath):\r
	42	""" Parse map file to get binary patch pcd information \r
	43	@param path Map file absolution path\r
	44	\r
	45	@return a list which element hold (PcdName, Offset, SectionName)\r
	46	"""\r
	47	lines = []\r
	48	try:\r
	49	f = open(mapfilepath, 'r')\r
	50	lines = f.readlines()\r
	51	f.close()\r
	52	except:\r
	53	return None\r
	54	\r
	55	if len(lines) == 0: return None\r
	56	if lines[0].strip().find("Archive member included because of file (symbol)") != -1:\r
	57	return _parseForGCC(lines, efifilepath)\r
	58	return _parseGeneral(lines, efifilepath)\r
	59	\r
	60	def _parseForGCC(lines, efifilepath):\r
	61	""" Parse map file generated by GCC linker """\r
	62	status = 0\r
	63	imageBase = -1\r
	64	sections = []\r
	65	bpcds = []\r
	66	for line in lines:\r
	67	line = line.strip()\r
	68	# status machine transection\r
	69	if status == 0 and line == "Memory Configuration":\r
	70	status = 1\r
	71	continue\r
	72	elif status == 1 and line == 'Linker script and memory map':\r
	73	status = 2\r
	74	continue\r
	75	elif status ==2 and line == 'START GROUP':\r
	76	status = 3\r
	77	continue\r
	78	\r
e8a47801	79	# status handler\r
f51461c8 LG	80	if status == 2:\r
	81	m = re.match('^([\w_\.]+) +([\da-fA-Fx]+) +([\da-fA-Fx]+)$', line)\r
	82	if m != None:\r
	83	sections.append(m.groups(0))\r
	84	if status == 2:\r
	85	m = re.match("^([\da-fA-Fx]+) +[_]+gPcd_BinaryPatch_([\w_\d]+)$", line)\r
	86	if m != None:\r
	87	bpcds.append((m.groups(0)[1], int(m.groups(0)[0], 16) , int(sections[-1][1], 16), sections[-1][0]))\r
e8a47801 LG	88	\r
	89	# get section information from efi file\r
	90	efisecs = PeImageClass(efifilepath).SectionHeaderList\r
	91	if efisecs == None or len(efisecs) == 0:\r
	92	return None\r
	93	#redirection\r
	94	redirection = 0\r
	95	for efisec in efisecs:\r
	96	for section in sections:\r
	97	if section[0].strip() == efisec[0].strip() and section[0].strip() == '.text':\r
	98	redirection = int(section[1], 16) - efisec[1]\r
	99	pcds = []\r
	100	for pcd in bpcds:\r
	101	for efisec in efisecs:\r
	102	if pcd[1] >= efisec[1] and pcd[1] < efisec[1]+efisec[3]:\r
	103	#assert efisec[0].strip() == pcd[3].strip() and efisec[1] + redirection == pcd[2], "There are some differences between map file and efi file"\r
	104	pcds.append([pcd[0], efisec[2] + pcd[1] - efisec[1] - redirection, efisec[0]])\r
f51461c8 LG	105	return pcds\r
	106	\r
	107	def _parseGeneral(lines, efifilepath):\r
	108	""" For MSFT, ICC, EBC \r
	109	@param lines line array for map file\r
	110	\r
	111	@return a list which element hold (PcdName, Offset, SectionName)\r
	112	""" \r
	113	status = 0 #0 - beginning of file; 1 - PE section definition; 2 - symbol table\r
	114	secs = [] # key = section name\r
	115	bPcds = []\r
	116	\r
	117	\r
	118	for line in lines:\r
	119	line = line.strip()\r
	120	if re.match("^Start[' ']+Length[' ']+Name[' ']+Class", line):\r
	121	status = 1\r
	122	continue\r
	123	if re.match("^Address[' ']+Publics by Value[' ']+Rva\+Base", line):\r
	124	status = 2\r
	125	continue\r
	126	if re.match("^entry point at", line):\r
	127	status = 3\r
	128	continue \r
	129	if status == 1 and len(line) != 0:\r
	130	m = secRe.match(line)\r
	131	assert m != None, "Fail to parse the section in map file , line is %s" % line\r
	132	sec_no, sec_start, sec_length, sec_name, sec_class = m.groups(0)\r
	133	secs.append([int(sec_no, 16), int(sec_start, 16), int(sec_length, 16), sec_name, sec_class])\r
	134	if status == 2 and len(line) != 0:\r
	135	m = symRe.match(line)\r
	136	assert m != None, "Fail to parse the symbol in map file, line is %s" % line\r
	137	sec_no, sym_offset, sym_name, vir_addr = m.groups(0)\r
	138	sec_no = int(sec_no, 16)\r
	139	sym_offset = int(sym_offset, 16)\r
	140	vir_addr = int(vir_addr, 16)\r
	141	m2 = re.match('^[_]+gPcd_BinaryPatch_([\w]+)', sym_name)\r
	142	if m2 != None:\r
	143	# fond a binary pcd entry in map file\r
	144	for sec in secs:\r
	145	if sec[0] == sec_no and (sym_offset >= sec[1] and sym_offset < sec[1] + sec[2]):\r
	146	bPcds.append([m2.groups(0)[0], sec[3], sym_offset, vir_addr, sec_no])\r
	147	\r
	148	if len(bPcds) == 0: return None\r
	149	\r
	150	# get section information from efi file\r
	151	efisecs = PeImageClass(efifilepath).SectionHeaderList\r
	152	if efisecs == None or len(efisecs) == 0:\r
	153	return None\r
	154	\r
	155	pcds = []\r
	156	for pcd in bPcds:\r
	157	index = 0\r
	158	for efisec in efisecs:\r
	159	index = index + 1\r
	160	if pcd[1].strip() == efisec[0].strip():\r
	161	pcds.append([pcd[0], efisec[2] + pcd[2], efisec[0]])\r
	162	elif pcd[4] == index:\r
	163	pcds.append([pcd[0], efisec[2] + pcd[2], efisec[0]])\r
	164	return pcds\r
	165	\r
	166	def generatePcdTable(list, pcdpath):\r
	167	try:\r
	168	f = open(pcdpath, 'w')\r
169	except:\r
170	pass\r
171	\r
172	f.write('PCD Name Offset Section Name\r\n')\r
173	\r
174	for pcditem in list:\r
175	f.write('%-30s 0x%-08X %-6s\r\n' % (pcditem[0], pcditem[1], pcditem[2]))\r
176	f.close()\r
177	\r
178	#print 'Success to generate Binary Patch PCD table at %s!' % pcdpath \r
179	\r
180	if __name__ == '__main__':\r
181	UsageString = "%prog -m <MapFile> -e <EfiFile> -o <OutFile>"\r
182	AdditionalNotes = "\nPCD table is generated in file name with .BinaryPcdTable.txt postfix"\r
183	parser = optparse.OptionParser(description=__copyright__, version=__version__, usage=UsageString)\r
184	parser.add_option('-m', '--mapfile', action='store', dest='mapfile',\r
185	help='Absolute path of module map file.')\r
186	parser.add_option('-e', '--efifile', action='store', dest='efifile',\r
187	help='Absolute path of EFI binary file.')\r
188	parser.add_option('-o', '--outputfile', action='store', dest='outfile',\r
189	help='Absolute path of output file to store the got patchable PCD table.')\r
190	\r
191	(options, args) = parser.parse_args()\r
192	\r
193	if options.mapfile == None or options.efifile == None:\r
194	print parser.get_usage()\r
195	elif os.path.exists(options.mapfile) and os.path.exists(options.efifile):\r
196	list = parsePcdInfoFromMapFile(options.mapfile, options.efifile) \r
197	if list != None:\r
198	if options.outfile != None:\r
199	generatePcdTable(list, options.outfile)\r
200	else:\r
201	generatePcdTable(list, options.mapfile.replace('.map', '.BinaryPcdTable.txt')) \r
202	else:\r
203	print 'Fail to generate Patch PCD Table based on map file and efi file'\r
204	else:\r
205	print 'Fail to generate Patch PCD Table for fail to find map file or efi file!'\r