[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:
#    
#    PCD Name    Offset in binary
#    ========    ================\r
#\r
# Copyright (c) 2008 - 2010, 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
#

#======================================  External Libraries ========================================
import optparse
import os
import re
import array

from Common.BuildToolError import *
import Common.EdkLogger as EdkLogger
from Common.Misc import PeImageClass\r
from Common.BuildVersion import gBUILD_VERSION\r

# Version and Copyright
__version_number__ = ("0.10" + " " + gBUILD_VERSION)
__version__ = "%prog Version " + __version_number__
__copyright__ = "Copyright (c) 2008 - 2010, Intel Corporation. All rights reserved."

#======================================  Internal Libraries ========================================

#============================================== Code ===============================================
secRe = re.compile('^([\da-fA-F]+):([\da-fA-F]+) +([\da-fA-F]+)[Hh]? +([.\w\$]+) +(\w+)', re.UNICODE)
symRe = re.compile('^([\da-fA-F]+):([\da-fA-F]+) +([\.:\\\\\w\?@\$]+) +([\da-fA-F]+)', re.UNICODE)

def parsePcdInfoFromMapFile(mapfilepath, efifilepath):
    """ Parse map file to get binary patch pcd information 
    @param path    Map file absolution path
    
    @return a list which element hold (PcdName, Offset, SectionName)
    """
    lines = []
    try:
        f = open(mapfilepath, 'r')
        lines = f.readlines()
        f.close()
    except:
        return None
    
    if len(lines) == 0: return None
    if lines[0].strip().find("Archive member included because of file (symbol)") != -1:
        return _parseForGCC(lines)
    return _parseGeneral(lines, efifilepath)
    
def _parseForGCC(lines):
    """ Parse map file generated by GCC linker """
    status       = 0
    imageBase    = -1
    lastSectionName = None
    pcds         = []
    for line in lines:
        line = line.strip()
        # status machine transection
        if status == 0 and line == "Linker script and memory map":
            status = 1
            continue
        elif status == 1 and line == 'START GROUP':
            status = 2
            continue
        
        # status handler:
        if status == 1:
            m = re.match('^[\da-fA-FxhH]+ +__image_base__ += +([\da-fA-FhxH]+)', line)
            if m != None:
                imageBase = int(m.groups(0)[0], 16)
        if status == 2:
            m = re.match('^([\w_\.]+) +([\da-fA-Fx]+) +([\da-fA-Fx]+)', line)
            if m != None:
                lastSectionName = m.groups(0)[0]
        if status == 2:
            m = re.match("^([\da-fA-Fx]+) +[_]+gPcd_BinaryPatch_([\w_\d]+)", line)
            if m != None:
                assert imageBase != -1, "Fail to get Binary PCD offsest for unknown image base address"
                pcds.append((m.groups(0)[1], int(m.groups(0)[0], 16) - imageBase, lastSectionName))
    return pcds
                
def _parseGeneral(lines, efifilepath):
    """ For MSFT, ICC, EBC 
    @param lines    line array for map file
    
    @return a list which element hold (PcdName, Offset, SectionName)
    """    
    status = 0    #0 - beginning of file; 1 - PE section definition; 2 - symbol table
    secs  = []    # key = section name
    bPcds = []
    

    for line in lines:
        line = line.strip()
        if re.match("^Start[' ']+Length[' ']+Name[' ']+Class", line):
            status = 1
            continue
        if re.match("^Address[' ']+Publics by Value[' ']+Rva\+Base", line):
            status = 2
            continue
        if re.match("^entry point at", line):
            status = 3
            continue        
        if status == 1 and len(line) != 0:
            m =  secRe.match(line)
            assert m != None, "Fail to parse the section in map file , line is %s" % line
            sec_no, sec_start, sec_length, sec_name, sec_class = m.groups(0)
            secs.append([int(sec_no, 16), int(sec_start, 16), int(sec_length, 16), sec_name, sec_class])
        if status == 2 and len(line) != 0:
            m = symRe.match(line)
            assert m != None, "Fail to parse the symbol in map file, line is %s" % line
            sec_no, sym_offset, sym_name, vir_addr = m.groups(0)
            sec_no     = int(sec_no,     16)
            sym_offset = int(sym_offset, 16)
            vir_addr   = int(vir_addr,   16)
            m2 = re.match('^[_]+gPcd_BinaryPatch_([\w]+)', sym_name)
            if m2 != None:
                # fond a binary pcd entry in map file
                for sec in secs:
                    if sec[0] == sec_no and (sym_offset >= sec[1] and sym_offset < sec[1] + sec[2]):
                        bPcds.append([m2.groups(0)[0], sec[3], sym_offset, vir_addr, sec_no])

    if len(bPcds) == 0: return None

    # get section information from efi file
    efisecs = PeImageClass(efifilepath).SectionHeaderList
    if efisecs == None or len(efisecs) == 0:
        return None
    
    pcds = []
    for pcd in bPcds:
        index = 0
        for efisec in efisecs:
            index = index + 1
            if pcd[1].strip() == efisec[0].strip():
                pcds.append([pcd[0], efisec[2] + pcd[2], efisec[0]])
            elif pcd[4] == index:
                pcds.append([pcd[0], efisec[2] + pcd[2], efisec[0]])
    return pcds
    
def generatePcdTable(list, pcdpath):
    try:
        f = open(pcdpath, 'w')
    except:
        pass

    f.write('PCD Name                       Offset    Section Name\r\n')
    
    for pcditem in list:
        f.write('%-30s 0x%-08X %-6s\r\n' % (pcditem[0], pcditem[1], pcditem[2]))
    f.close()

    #print 'Success to generate Binary Patch PCD table at %s!' % pcdpath 
    
if __name__ == '__main__':
    UsageString = "%prog -m <MapFile> -e <EfiFile> -o <OutFile>"
    AdditionalNotes = "\nPCD table is generated in file name with .BinaryPcdTable.txt postfix"
    parser = optparse.OptionParser(description=__copyright__, version=__version__, usage=UsageString)
    parser.add_option('-m', '--mapfile', action='store', dest='mapfile',
                      help='Absolute path of module map file.')
    parser.add_option('-e', '--efifile', action='store', dest='efifile',
                      help='Absolute path of EFI binary file.')
    parser.add_option('-o', '--outputfile', action='store', dest='outfile',
                      help='Absolute path of output file to store the got patchable PCD table.')
  
    (options, args) = parser.parse_args()

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