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