edk2: Replace BSD License with BSD+Patent License

[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 - 2018, 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
from __future__ import print_function\r
import optparse\r
import Common.LongFilePathOs as 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, startPatternGeneral, addressPatternGeneral, valuePatternGcc, pcdPatternGcc, secReGeneral\r
from Common.BuildVersion import gBUILD_VERSION\r
from Common.LongFilePathSupport import OpenLongFilePath as open\r
\r
# Version and Copyright\r
__version_number__ = ("0.10" + " " + gBUILD_VERSION)\r
__version__ = "%prog Version " + __version_number__\r
__copyright__ = "Copyright (c) 2008 - 2018, Intel Corporation. All rights reserved."\r
\r
#======================================  Internal Libraries ========================================\r
\r
#============================================== Code ===============================================\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
    firstline = lines[0].strip()\r
    if (firstline.startswith("Archive member included ") and\r
        firstline.endswith(" file (symbol)")):\r
        return _parseForGCC(lines, efifilepath)\r
    if firstline.startswith("# Path:"):\r
        return _parseForXcode(lines, efifilepath)\r
    return _parseGeneral(lines, efifilepath)\r
\r
def _parseForXcode(lines, efifilepath):\r
    valuePattern = re.compile('^([\da-fA-FxX]+)([\s\S]*)([_]*_gPcd_BinaryPatch_([\w]+))')\r
    status = 0\r
    pcds = []\r
    for line in lines:\r
        line = line.strip()\r
        if status == 0 and line == "# Symbols:":\r
            status = 1\r
            continue\r
        if status == 1 and len(line) != 0:\r
            if '_gPcd_BinaryPatch_' in line:\r
                m = valuePattern.match(line)\r
                if m is not None:\r
                    pcds.append((m.groups(0)[3], int(m.groups(0)[0], 16)))\r
    return pcds\r
\r
def _parseForGCC(lines, efifilepath):\r
    """ Parse map file generated by GCC linker """\r
    dataPattern = re.compile('^.data._gPcd_BinaryPatch_([\w_\d]+)$')\r
    status = 0\r
    imageBase = -1\r
    sections = []\r
    bpcds = []\r
    for index, line in enumerate(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 == 3:\r
            m = valuePatternGcc.match(line)\r
            if m is not None:\r
                sections.append(m.groups(0))\r
        if status == 3:\r
            m = dataPattern.match(line)\r
            if m is not None:\r
                if lines[index + 1]:\r
                    PcdName = m.groups(0)[0]\r
                    m = pcdPatternGcc.match(lines[index + 1].strip())\r
                    if m is not None:\r
                        bpcds.append((PcdName, 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 is 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
    symPattern = re.compile('^[_]+gPcd_BinaryPatch_([\w]+)')\r
\r
    for line in lines:\r
        line = line.strip()\r
        if startPatternGeneral.match(line):\r
            status = 1\r
            continue\r
        if addressPatternGeneral.match(line):\r
            status = 2\r
            continue\r
        if line.startswith("entry point at"):\r
            status = 3\r
            continue\r
        if status == 1 and len(line) != 0:\r
            m = secReGeneral.match(line)\r
            assert m is not 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 is not 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 = symPattern.match(sym_name)\r
            if m2 is not 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 is 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 is None or options.efifile is 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 is not None:\r
            if options.outfile is not 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