BaseTools: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / BaseTools / Source / Python / GenFds / DataSection.py

## @file\r
# process data section generation\r
#\r
#  Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r
#\r
#  SPDX-License-Identifier: BSD-2-Clause-Patent\r
#\r
\r
##\r
# Import Modules\r
#\r
from __future__ import absolute_import\r
from . import Section\r
from .GenFdsGlobalVariable import GenFdsGlobalVariable\r
import subprocess\r
from .Ffs import SectionSuffix\r
import Common.LongFilePathOs as os\r
from CommonDataClass.FdfClass import DataSectionClassObject\r
from Common.Misc import PeImageClass\r
from Common.LongFilePathSupport import CopyLongFilePath\r
from Common.DataType import *\r
\r
## generate data section\r
#\r
#\r
class DataSection (DataSectionClassObject):\r
    ## The constructor\r
    #\r
    #   @param  self        The object pointer\r
    #\r
    def __init__(self):\r
        DataSectionClassObject.__init__(self)\r
\r
    ## GenSection() method\r
    #\r
    #   Generate compressed section\r
    #\r
    #   @param  self        The object pointer\r
    #   @param  OutputPath  Where to place output file\r
    #   @param  ModuleName  Which module this section belongs to\r
    #   @param  SecNum      Index of section\r
    #   @param  KeyStringList  Filter for inputs of section generation\r
    #   @param  FfsInf      FfsInfStatement object that contains this section data\r
    #   @param  Dict        dictionary contains macro and its value\r
    #   @retval tuple       (Generated file name list, section alignment)\r
    #\r
    def GenSection(self, OutputPath, ModuleName, SecNum, keyStringList, FfsFile = None, Dict = {}, IsMakefile = False):\r
        #\r
        # Prepare the parameter of GenSection\r
        #\r
        if FfsFile is not None:\r
            self.SectFileName = GenFdsGlobalVariable.ReplaceWorkspaceMacro(self.SectFileName)\r
            self.SectFileName = GenFdsGlobalVariable.MacroExtend(self.SectFileName, Dict, FfsFile.CurrentArch)\r
        else:\r
            self.SectFileName = GenFdsGlobalVariable.ReplaceWorkspaceMacro(self.SectFileName)\r
            self.SectFileName = GenFdsGlobalVariable.MacroExtend(self.SectFileName, Dict)\r
\r
        """Check Section file exist or not !"""\r
\r
        if not os.path.exists(self.SectFileName):\r
            self.SectFileName = os.path.join (GenFdsGlobalVariable.WorkSpaceDir,\r
                                              self.SectFileName)\r
\r
        """Copy Map file to Ffs output"""\r
        Filename = GenFdsGlobalVariable.MacroExtend(self.SectFileName)\r
        if Filename[(len(Filename)-4):] == '.efi':\r
            MapFile = Filename.replace('.efi', '.map')\r
            CopyMapFile = os.path.join(OutputPath, ModuleName + '.map')\r
            if IsMakefile:\r
                if GenFdsGlobalVariable.CopyList == []:\r
                    GenFdsGlobalVariable.CopyList = [(MapFile, CopyMapFile)]\r
                else:\r
                    GenFdsGlobalVariable.CopyList.append((MapFile, CopyMapFile))\r
            else:\r
                if os.path.exists(MapFile):\r
                    if not os.path.exists(CopyMapFile) or (os.path.getmtime(MapFile) > os.path.getmtime(CopyMapFile)):\r
                        CopyLongFilePath(MapFile, CopyMapFile)\r
\r
        #Get PE Section alignment when align is set to AUTO\r
        if self.Alignment == 'Auto' and self.SecType in (BINARY_FILE_TYPE_TE, BINARY_FILE_TYPE_PE32):\r
            ImageObj = PeImageClass (Filename)\r
            if ImageObj.SectionAlignment < 0x400:\r
                self.Alignment = str (ImageObj.SectionAlignment)\r
            elif ImageObj.SectionAlignment < 0x100000:\r
                self.Alignment = str (ImageObj.SectionAlignment // 0x400) + 'K'\r
            else:\r
                self.Alignment = str (ImageObj.SectionAlignment // 0x100000) + 'M'\r
\r
        NoStrip = True\r
        if self.SecType in (BINARY_FILE_TYPE_TE, BINARY_FILE_TYPE_PE32):\r
            if self.KeepReloc is not None:\r
                NoStrip = self.KeepReloc\r
\r
        if not NoStrip:\r
            FileBeforeStrip = os.path.join(OutputPath, ModuleName + '.efi')\r
            if not os.path.exists(FileBeforeStrip) or \\r
                (os.path.getmtime(self.SectFileName) > os.path.getmtime(FileBeforeStrip)):\r
                CopyLongFilePath(self.SectFileName, FileBeforeStrip)\r
            StrippedFile = os.path.join(OutputPath, ModuleName + '.stripped')\r
            GenFdsGlobalVariable.GenerateFirmwareImage(\r
                    StrippedFile,\r
                    [GenFdsGlobalVariable.MacroExtend(self.SectFileName, Dict)],\r
                    Strip=True,\r
                    IsMakefile = IsMakefile\r
                )\r
            self.SectFileName = StrippedFile\r
\r
        if self.SecType == BINARY_FILE_TYPE_TE:\r
            TeFile = os.path.join( OutputPath, ModuleName + 'Te.raw')\r
            GenFdsGlobalVariable.GenerateFirmwareImage(\r
                    TeFile,\r
                    [GenFdsGlobalVariable.MacroExtend(self.SectFileName, Dict)],\r
                    Type='te',\r
                    IsMakefile = IsMakefile\r
                )\r
            self.SectFileName = TeFile\r
\r
        OutputFile = os.path.join (OutputPath, ModuleName + SUP_MODULE_SEC + SecNum + SectionSuffix.get(self.SecType))\r
        OutputFile = os.path.normpath(OutputFile)\r
        GenFdsGlobalVariable.GenerateSection(OutputFile, [self.SectFileName], Section.Section.SectionType.get(self.SecType), IsMakefile = IsMakefile)\r
        FileList = [OutputFile]\r
        return FileList, self.Alignment\r