]>
git.proxmox.com Git - mirror_edk2.git/blob - BaseTools/Source/Python/GenPatchPcdTable/GenPatchPcdTable.py
2 # Generate PCD table for 'Patchable In Module' type PCD with given .map file.
3 # The Patch PCD table like:
5 # PCD Name Offset in binary
6 # ======== ================
8 # Copyright (c) 2008 - 2010, Intel Corporation. All rights reserved.<BR>
9 # This program and the accompanying materials
10 # are licensed and made available under the terms and conditions of the BSD License
11 # which accompanies this distribution. The full text of the license may be found at
12 # http://opensource.org/licenses/bsd-license.php
14 # THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
15 # WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
19 #====================================== External Libraries ========================================
25 from Common
.BuildToolError
import *
26 import Common
.EdkLogger
as EdkLogger
27 from Common
.Misc
import PeImageClass
29 # Version and Copyright
30 __version_number__
= "0.10"
31 __version__
= "%prog Version " + __version_number__
32 __copyright__
= "Copyright (c) 2008 - 2010, Intel Corporation. All rights reserved."
34 #====================================== Internal Libraries ========================================
36 #============================================== Code ===============================================
37 secRe
= re
.compile('^([\da-fA-F]+):([\da-fA-F]+) +([\da-fA-F]+)[Hh]? +([.\w\$]+) +(\w+)', re
.UNICODE
)
38 symRe
= re
.compile('^([\da-fA-F]+):([\da-fA-F]+) +([\.:\\\\\w\?@\$]+) +([\da-fA-F]+)', re
.UNICODE
)
40 def parsePcdInfoFromMapFile(mapfilepath
, efifilepath
):
41 """ Parse map file to get binary patch pcd information
42 @param path Map file absolution path
44 @return a list which element hold (PcdName, Offset, SectionName)
48 f
= open(mapfilepath
, 'r')
54 if len(lines
) == 0: return None
55 if lines
[0].strip().find("Archive member included because of file (symbol)") != -1:
56 return _parseForGCC(lines
)
57 return _parseGeneral(lines
, efifilepath
)
59 def _parseForGCC(lines
):
60 """ Parse map file generated by GCC linker """
63 lastSectionName
= None
67 # status machine transection
68 if status
== 0 and line
== "Linker script and memory map":
71 elif status
== 1 and line
== 'START GROUP':
77 m
= re
.match('^[\da-fA-FxhH]+ +__image_base__ += +([\da-fA-FhxH]+)', line
)
79 imageBase
= int(m
.groups(0)[0], 16)
81 m
= re
.match('^([\w_\.]+) +([\da-fA-Fx]+) +([\da-fA-Fx]+)', line
)
83 lastSectionName
= m
.groups(0)[0]
85 m
= re
.match("^([\da-fA-Fx]+) +[_]+gPcd_BinaryPatch_([\w_\d]+)", line
)
87 assert imageBase
!= -1, "Fail to get Binary PCD offsest for unknown image base address"
88 pcds
.append((m
.groups(0)[1], int(m
.groups(0)[0], 16) - imageBase
, lastSectionName
))
91 def _parseGeneral(lines
, efifilepath
):
92 """ For MSFT, ICC, EBC
93 @param lines line array for map file
95 @return a list which element hold (PcdName, Offset, SectionName)
97 status
= 0 #0 - beginning of file; 1 - PE section definition; 2 - symbol table
98 secs
= [] # key = section name
104 if re
.match("^Start[' ']+Length[' ']+Name[' ']+Class", line
):
107 if re
.match("^Address[' ']+Publics by Value[' ']+Rva\+Base", line
):
110 if re
.match("^entry point at", line
):
113 if status
== 1 and len(line
) != 0:
114 m
= secRe
.match(line
)
115 assert m
!= None, "Fail to parse the section in map file , line is %s" % line
116 sec_no
, sec_start
, sec_length
, sec_name
, sec_class
= m
.groups(0)
117 secs
.append([int(sec_no
, 16), int(sec_start
, 16), int(sec_length
, 16), sec_name
, sec_class
])
118 if status
== 2 and len(line
) != 0:
119 m
= symRe
.match(line
)
120 assert m
!= None, "Fail to parse the symbol in map file, line is %s" % line
121 sec_no
, sym_offset
, sym_name
, vir_addr
= m
.groups(0)
122 sec_no
= int(sec_no
, 16)
123 sym_offset
= int(sym_offset
, 16)
124 vir_addr
= int(vir_addr
, 16)
125 m2
= re
.match('^[_]+gPcd_BinaryPatch_([\w]+)', sym_name
)
127 # fond a binary pcd entry in map file
129 if sec
[0] == sec_no
and (sym_offset
>= sec
[1] and sym_offset
< sec
[1] + sec
[2]):
130 bPcds
.append([m2
.groups(0)[0], sec
[3], sym_offset
, vir_addr
, sec_no
])
132 if len(bPcds
) == 0: return None
134 # get section information from efi file
135 efisecs
= PeImageClass(efifilepath
).SectionHeaderList
136 if efisecs
== None or len(efisecs
) == 0:
142 for efisec
in efisecs
:
144 if pcd
[1].strip() == efisec
[0].strip():
145 pcds
.append([pcd
[0], efisec
[2] + pcd
[2], efisec
[0]])
146 elif pcd
[4] == index
:
147 pcds
.append([pcd
[0], efisec
[2] + pcd
[2], efisec
[0]])
150 def generatePcdTable(list, pcdpath
):
152 f
= open(pcdpath
, 'w')
156 f
.write('PCD Name Offset Section Name\r\n')
159 f
.write('%-30s 0x%-08X %-6s\r\n' % (pcditem
[0], pcditem
[1], pcditem
[2]))
162 #print 'Success to generate Binary Patch PCD table at %s!' % pcdpath
164 if __name__
== '__main__':
165 UsageString
= "%prog -m <MapFile> -e <EfiFile> -o <OutFile>"
166 AdditionalNotes
= "\nPCD table is generated in file name with .BinaryPcdTable.txt postfix"
167 parser
= optparse
.OptionParser(description
=__copyright__
, version
=__version__
, usage
=UsageString
)
168 parser
.add_option('-m', '--mapfile', action
='store', dest
='mapfile',
169 help='Absolute path of module map file.')
170 parser
.add_option('-e', '--efifile', action
='store', dest
='efifile',
171 help='Absolute path of EFI binary file.')
172 parser
.add_option('-o', '--outputfile', action
='store', dest
='outfile',
173 help='Absolute path of output file to store the got patchable PCD table.')
175 (options
, args
) = parser
.parse_args()
177 if options
.mapfile
== None or options
.efifile
== None:
178 print parser
.get_usage()
179 elif os
.path
.exists(options
.mapfile
) and os
.path
.exists(options
.efifile
):
180 list = parsePcdInfoFromMapFile(options
.mapfile
, options
.efifile
)
182 if options
.outfile
!= None:
183 generatePcdTable(list, options
.outfile
)
185 generatePcdTable(list, options
.mapfile
.replace('.map', '.BinaryPcdTable.txt'))
187 print 'Fail to generate Patch PCD Table based on map file and efi file'
189 print 'Fail to generate Patch PCD Table for fail to find map file or efi file!'