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

## @file\r
# generate flash image\r
#\r
#  Copyright (c) 2007 - 2019, Intel Corporation. All rights reserved.<BR>\r
#\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
# Import Modules\r
#\r
from __future__ import print_function\r
from __future__ import absolute_import\r
from re import compile\r
from optparse import OptionParser\r
from sys import exit\r
from glob import glob\r
from struct import unpack\r
from linecache import getlines\r
from io import BytesIO\r
\r
import Common.LongFilePathOs as os\r
from Common.TargetTxtClassObject import TargetTxtClassObject\r
from Common.DataType import *\r
import Common.GlobalData as GlobalData\r
from Common import EdkLogger\r
from Common.StringUtils import NormPath\r
from Common.Misc import DirCache, PathClass, GuidStructureStringToGuidString\r
from Common.Misc import SaveFileOnChange, ClearDuplicatedInf\r
from Common.BuildVersion import gBUILD_VERSION\r
from Common.MultipleWorkspace import MultipleWorkspace as mws\r
from Common.BuildToolError import FatalError, GENFDS_ERROR, CODE_ERROR, FORMAT_INVALID, RESOURCE_NOT_AVAILABLE, FILE_NOT_FOUND, OPTION_MISSING, FORMAT_NOT_SUPPORTED, OPTION_VALUE_INVALID, PARAMETER_INVALID\r
from Workspace.WorkspaceDatabase import WorkspaceDatabase\r
\r
from .FdfParser import FdfParser, Warning\r
from .GenFdsGlobalVariable import GenFdsGlobalVariable\r
from .FfsFileStatement import FileStatement\r
import Common.DataType as DataType\r
from struct import Struct\r
\r
## Version and Copyright\r
versionNumber = "1.0" + ' ' + gBUILD_VERSION\r
__version__ = "%prog Version " + versionNumber\r
__copyright__ = "Copyright (c) 2007 - 2018, Intel Corporation  All rights reserved."\r
\r
## Tool entrance method\r
#\r
# This method mainly dispatch specific methods per the command line options.\r
# If no error found, return zero value so the caller of this tool can know\r
# if it's executed successfully or not.\r
#\r
#   @retval 0     Tool was successful\r
#   @retval 1     Tool failed\r
#\r
def main():\r
    global Options\r
    Options = myOptionParser()\r
    EdkLogger.Initialize()\r
    return GenFdsApi(OptionsToCommandDict(Options))\r
\r
def resetFdsGlobalVariable():\r
    GenFdsGlobalVariable.FvDir = ''\r
    GenFdsGlobalVariable.OutputDirDict = {}\r
    GenFdsGlobalVariable.BinDir = ''\r
    # will be FvDir + os.sep + 'Ffs'\r
    GenFdsGlobalVariable.FfsDir = ''\r
    GenFdsGlobalVariable.FdfParser = None\r
    GenFdsGlobalVariable.LibDir = ''\r
    GenFdsGlobalVariable.WorkSpace = None\r
    GenFdsGlobalVariable.WorkSpaceDir = ''\r
    GenFdsGlobalVariable.ConfDir = ''\r
    GenFdsGlobalVariable.OutputDirFromDscDict = {}\r
    GenFdsGlobalVariable.TargetName = ''\r
    GenFdsGlobalVariable.ToolChainTag = ''\r
    GenFdsGlobalVariable.RuleDict = {}\r
    GenFdsGlobalVariable.ArchList = None\r
    GenFdsGlobalVariable.ActivePlatform = None\r
    GenFdsGlobalVariable.FvAddressFileName = ''\r
    GenFdsGlobalVariable.VerboseMode = False\r
    GenFdsGlobalVariable.DebugLevel = -1\r
    GenFdsGlobalVariable.SharpCounter = 0\r
    GenFdsGlobalVariable.SharpNumberPerLine = 40\r
    GenFdsGlobalVariable.FdfFile = ''\r
    GenFdsGlobalVariable.FdfFileTimeStamp = 0\r
    GenFdsGlobalVariable.FixedLoadAddress = False\r
    GenFdsGlobalVariable.PlatformName = ''\r
\r
    GenFdsGlobalVariable.BuildRuleFamily = DataType.TAB_COMPILER_MSFT\r
    GenFdsGlobalVariable.ToolChainFamily = DataType.TAB_COMPILER_MSFT\r
    GenFdsGlobalVariable.__BuildRuleDatabase = None\r
    GenFdsGlobalVariable.GuidToolDefinition = {}\r
    GenFdsGlobalVariable.FfsCmdDict = {}\r
    GenFdsGlobalVariable.SecCmdList = []\r
    GenFdsGlobalVariable.CopyList   = []\r
    GenFdsGlobalVariable.ModuleFile = ''\r
    GenFdsGlobalVariable.EnableGenfdsMultiThread = False\r
\r
    GenFdsGlobalVariable.LargeFileInFvFlags = []\r
    GenFdsGlobalVariable.EFI_FIRMWARE_FILE_SYSTEM3_GUID = '5473C07A-3DCB-4dca-BD6F-1E9689E7349A'\r
    GenFdsGlobalVariable.LARGE_FILE_SIZE = 0x1000000\r
\r
    GenFdsGlobalVariable.SectionHeader = Struct("3B 1B")\r
\r
    # FvName, FdName, CapName in FDF, Image file name\r
    GenFdsGlobalVariable.ImageBinDict = {}\r
\r
def GenFdsApi(FdsCommandDict, WorkSpaceDataBase=None):\r
    global Workspace\r
    Workspace = ""\r
    ArchList = None\r
    ReturnCode = 0\r
    resetFdsGlobalVariable()\r
\r
    try:\r
        if FdsCommandDict.get("verbose"):\r
            EdkLogger.SetLevel(EdkLogger.VERBOSE)\r
            GenFdsGlobalVariable.VerboseMode = True\r
\r
        if FdsCommandDict.get("FixedAddress"):\r
            GenFdsGlobalVariable.FixedLoadAddress = True\r
\r
        if FdsCommandDict.get("quiet"):\r
            EdkLogger.SetLevel(EdkLogger.QUIET)\r
        if FdsCommandDict.get("debug"):\r
            EdkLogger.SetLevel(FdsCommandDict.get("debug") + 1)\r
            GenFdsGlobalVariable.DebugLevel = FdsCommandDict.get("debug")\r
        else:\r
            EdkLogger.SetLevel(EdkLogger.INFO)\r
\r
        if not FdsCommandDict.get("Workspace",os.environ.get('WORKSPACE')):\r
            EdkLogger.error("GenFds", OPTION_MISSING, "WORKSPACE not defined",\r
                            ExtraData="Please use '-w' switch to pass it or set the WORKSPACE environment variable.")\r
        elif not os.path.exists(FdsCommandDict.get("Workspace",os.environ.get('WORKSPACE'))):\r
            EdkLogger.error("GenFds", PARAMETER_INVALID, "WORKSPACE is invalid",\r
                            ExtraData="Please use '-w' switch to pass it or set the WORKSPACE environment variable.")\r
        else:\r
            Workspace = os.path.normcase(FdsCommandDict.get("Workspace",os.environ.get('WORKSPACE')))\r
            GenFdsGlobalVariable.WorkSpaceDir = Workspace\r
            if FdsCommandDict.get("debug"):\r
                GenFdsGlobalVariable.VerboseLogger("Using Workspace:" + Workspace)\r
            if FdsCommandDict.get("GenfdsMultiThread"):\r
                GenFdsGlobalVariable.EnableGenfdsMultiThread = True\r
        os.chdir(GenFdsGlobalVariable.WorkSpaceDir)\r
\r
        # set multiple workspace\r
        PackagesPath = os.getenv("PACKAGES_PATH")\r
        mws.setWs(GenFdsGlobalVariable.WorkSpaceDir, PackagesPath)\r
\r
        if FdsCommandDict.get("fdf_file"):\r
            FdfFilename = FdsCommandDict.get("fdf_file")[0].Path\r
            FdfFilename = GenFdsGlobalVariable.ReplaceWorkspaceMacro(FdfFilename)\r
\r
            if FdfFilename[0:2] == '..':\r
                FdfFilename = os.path.realpath(FdfFilename)\r
            if not os.path.isabs(FdfFilename):\r
                FdfFilename = mws.join(GenFdsGlobalVariable.WorkSpaceDir, FdfFilename)\r
            if not os.path.exists(FdfFilename):\r
                EdkLogger.error("GenFds", FILE_NOT_FOUND, ExtraData=FdfFilename)\r
\r
            GenFdsGlobalVariable.FdfFile = FdfFilename\r
            GenFdsGlobalVariable.FdfFileTimeStamp = os.path.getmtime(FdfFilename)\r
        else:\r
            EdkLogger.error("GenFds", OPTION_MISSING, "Missing FDF filename")\r
\r
        if FdsCommandDict.get("build_target"):\r
            GenFdsGlobalVariable.TargetName = FdsCommandDict.get("build_target")\r
\r
        if FdsCommandDict.get("toolchain_tag"):\r
            GenFdsGlobalVariable.ToolChainTag = FdsCommandDict.get("toolchain_tag")\r
\r
        if FdsCommandDict.get("active_platform"):\r
            ActivePlatform = FdsCommandDict.get("active_platform")\r
            ActivePlatform = GenFdsGlobalVariable.ReplaceWorkspaceMacro(ActivePlatform)\r
\r
            if ActivePlatform[0:2] == '..':\r
                ActivePlatform = os.path.realpath(ActivePlatform)\r
\r
            if not os.path.isabs (ActivePlatform):\r
                ActivePlatform = mws.join(GenFdsGlobalVariable.WorkSpaceDir, ActivePlatform)\r
\r
            if not os.path.exists(ActivePlatform):\r
                EdkLogger.error("GenFds", FILE_NOT_FOUND, "ActivePlatform doesn't exist!")\r
        else:\r
            EdkLogger.error("GenFds", OPTION_MISSING, "Missing active platform")\r
\r
        GenFdsGlobalVariable.ActivePlatform = PathClass(NormPath(ActivePlatform))\r
\r
        if FdsCommandDict.get("conf_directory"):\r
            # Get alternate Conf location, if it is absolute, then just use the absolute directory name\r
            ConfDirectoryPath = os.path.normpath(FdsCommandDict.get("conf_directory"))\r
            if ConfDirectoryPath.startswith('"'):\r
                ConfDirectoryPath = ConfDirectoryPath[1:]\r
            if ConfDirectoryPath.endswith('"'):\r
                ConfDirectoryPath = ConfDirectoryPath[:-1]\r
            if not os.path.isabs(ConfDirectoryPath):\r
                # Since alternate directory name is not absolute, the alternate directory is located within the WORKSPACE\r
                # This also handles someone specifying the Conf directory in the workspace. Using --conf=Conf\r
                ConfDirectoryPath = os.path.join(GenFdsGlobalVariable.WorkSpaceDir, ConfDirectoryPath)\r
        else:\r
            if "CONF_PATH" in os.environ:\r
                ConfDirectoryPath = os.path.normcase(os.environ["CONF_PATH"])\r
            else:\r
                # Get standard WORKSPACE/Conf, use the absolute path to the WORKSPACE/Conf\r
                ConfDirectoryPath = mws.join(GenFdsGlobalVariable.WorkSpaceDir, 'Conf')\r
        GenFdsGlobalVariable.ConfDir = ConfDirectoryPath\r
        if not GlobalData.gConfDirectory:\r
            GlobalData.gConfDirectory = GenFdsGlobalVariable.ConfDir\r
        BuildConfigurationFile = os.path.normpath(os.path.join(ConfDirectoryPath, "target.txt"))\r
        if os.path.isfile(BuildConfigurationFile) == True:\r
            TargetTxt = TargetTxtClassObject()\r
            TargetTxt.LoadTargetTxtFile(BuildConfigurationFile)\r
            # if no build target given in command line, get it from target.txt\r
            if not GenFdsGlobalVariable.TargetName:\r
                BuildTargetList = TargetTxt.TargetTxtDictionary[TAB_TAT_DEFINES_TARGET]\r
                if len(BuildTargetList) != 1:\r
                    EdkLogger.error("GenFds", OPTION_VALUE_INVALID, ExtraData="Only allows one instance for Target.")\r
                GenFdsGlobalVariable.TargetName = BuildTargetList[0]\r
\r
            # if no tool chain given in command line, get it from target.txt\r
            if not GenFdsGlobalVariable.ToolChainTag:\r
                ToolChainList = TargetTxt.TargetTxtDictionary[TAB_TAT_DEFINES_TOOL_CHAIN_TAG]\r
                if ToolChainList is None or len(ToolChainList) == 0:\r
                    EdkLogger.error("GenFds", RESOURCE_NOT_AVAILABLE, ExtraData="No toolchain given. Don't know how to build.")\r
                if len(ToolChainList) != 1:\r
                    EdkLogger.error("GenFds", OPTION_VALUE_INVALID, ExtraData="Only allows one instance for ToolChain.")\r
                GenFdsGlobalVariable.ToolChainTag = ToolChainList[0]\r
        else:\r
            EdkLogger.error("GenFds", FILE_NOT_FOUND, ExtraData=BuildConfigurationFile)\r
\r
        #Set global flag for build mode\r
        GlobalData.gIgnoreSource = FdsCommandDict.get("IgnoreSources")\r
\r
        if FdsCommandDict.get("macro"):\r
            for Pair in FdsCommandDict.get("macro"):\r
                if Pair.startswith('"'):\r
                    Pair = Pair[1:]\r
                if Pair.endswith('"'):\r
                    Pair = Pair[:-1]\r
                List = Pair.split('=')\r
                if len(List) == 2:\r
                    if not List[1].strip():\r
                        EdkLogger.error("GenFds", OPTION_VALUE_INVALID, ExtraData="No Value given for Macro %s" %List[0])\r
                    if List[0].strip() in ["WORKSPACE", "TARGET", "TOOLCHAIN"]:\r
                        GlobalData.gGlobalDefines[List[0].strip()] = List[1].strip()\r
                    else:\r
                        GlobalData.gCommandLineDefines[List[0].strip()] = List[1].strip()\r
                else:\r
                    GlobalData.gCommandLineDefines[List[0].strip()] = "TRUE"\r
        os.environ["WORKSPACE"] = Workspace\r
\r
        # Use the -t and -b option as gGlobalDefines's TOOLCHAIN and TARGET if they are not defined\r
        if "TARGET" not in GlobalData.gGlobalDefines:\r
            GlobalData.gGlobalDefines["TARGET"] = GenFdsGlobalVariable.TargetName\r
        if "TOOLCHAIN" not in GlobalData.gGlobalDefines:\r
            GlobalData.gGlobalDefines["TOOLCHAIN"] = GenFdsGlobalVariable.ToolChainTag\r
        if "TOOL_CHAIN_TAG" not in GlobalData.gGlobalDefines:\r
            GlobalData.gGlobalDefines['TOOL_CHAIN_TAG'] = GenFdsGlobalVariable.ToolChainTag\r
\r
        """call Workspace build create database"""\r
        GlobalData.gDatabasePath = os.path.normpath(os.path.join(ConfDirectoryPath, GlobalData.gDatabasePath))\r
\r
        if WorkSpaceDataBase:\r
            BuildWorkSpace = WorkSpaceDataBase\r
        else:\r
            BuildWorkSpace = WorkspaceDatabase()\r
        #\r
        # Get files real name in workspace dir\r
        #\r
        GlobalData.gAllFiles = DirCache(Workspace)\r
        GlobalData.gWorkspace = Workspace\r
\r
        if FdsCommandDict.get("build_architecture_list"):\r
            ArchList = FdsCommandDict.get("build_architecture_list").split(',')\r
        else:\r
            ArchList = BuildWorkSpace.BuildObject[GenFdsGlobalVariable.ActivePlatform, TAB_COMMON, FdsCommandDict.get("build_target"), FdsCommandDict.get("toolchain_tag")].SupArchList\r
\r
        TargetArchList = set(BuildWorkSpace.BuildObject[GenFdsGlobalVariable.ActivePlatform, TAB_COMMON, FdsCommandDict.get("build_target"), FdsCommandDict.get("toolchain_tag")].SupArchList) & set(ArchList)\r
        if len(TargetArchList) == 0:\r
            EdkLogger.error("GenFds", GENFDS_ERROR, "Target ARCH %s not in platform supported ARCH %s" % (str(ArchList), str(BuildWorkSpace.BuildObject[GenFdsGlobalVariable.ActivePlatform, TAB_COMMON].SupArchList)))\r
\r
        for Arch in ArchList:\r
            GenFdsGlobalVariable.OutputDirFromDscDict[Arch] = NormPath(BuildWorkSpace.BuildObject[GenFdsGlobalVariable.ActivePlatform, Arch, FdsCommandDict.get("build_target"), FdsCommandDict.get("toolchain_tag")].OutputDirectory)\r
\r
        # assign platform name based on last entry in ArchList\r
        GenFdsGlobalVariable.PlatformName = BuildWorkSpace.BuildObject[GenFdsGlobalVariable.ActivePlatform, ArchList[-1], FdsCommandDict.get("build_target"), FdsCommandDict.get("toolchain_tag")].PlatformName\r
\r
        if FdsCommandDict.get("platform_build_directory"):\r
            OutputDirFromCommandLine = GenFdsGlobalVariable.ReplaceWorkspaceMacro(FdsCommandDict.get("platform_build_directory"))\r
            if not os.path.isabs (OutputDirFromCommandLine):\r
                OutputDirFromCommandLine = os.path.join(GenFdsGlobalVariable.WorkSpaceDir, OutputDirFromCommandLine)\r
            for Arch in ArchList:\r
                GenFdsGlobalVariable.OutputDirDict[Arch] = OutputDirFromCommandLine\r
        else:\r
            for Arch in ArchList:\r
                GenFdsGlobalVariable.OutputDirDict[Arch] = os.path.join(GenFdsGlobalVariable.OutputDirFromDscDict[Arch], GenFdsGlobalVariable.TargetName + '_' + GenFdsGlobalVariable.ToolChainTag)\r
\r
        for Key in GenFdsGlobalVariable.OutputDirDict:\r
            OutputDir = GenFdsGlobalVariable.OutputDirDict[Key]\r
            if OutputDir[0:2] == '..':\r
                OutputDir = os.path.realpath(OutputDir)\r
\r
            if OutputDir[1] != ':':\r
                OutputDir = os.path.join (GenFdsGlobalVariable.WorkSpaceDir, OutputDir)\r
\r
            if not os.path.exists(OutputDir):\r
                EdkLogger.error("GenFds", FILE_NOT_FOUND, ExtraData=OutputDir)\r
            GenFdsGlobalVariable.OutputDirDict[Key] = OutputDir\r
\r
        """ Parse Fdf file, has to place after build Workspace as FDF may contain macros from DSC file """\r
        if WorkSpaceDataBase:\r
            FdfParserObj = GlobalData.gFdfParser\r
        else:\r
            FdfParserObj = FdfParser(FdfFilename)\r
            FdfParserObj.ParseFile()\r
\r
        if FdfParserObj.CycleReferenceCheck():\r
            EdkLogger.error("GenFds", FORMAT_NOT_SUPPORTED, "Cycle Reference Detected in FDF file")\r
\r
        if FdsCommandDict.get("fd"):\r
            if FdsCommandDict.get("fd")[0].upper() in FdfParserObj.Profile.FdDict:\r
                GenFds.OnlyGenerateThisFd = FdsCommandDict.get("fd")[0]\r
            else:\r
                EdkLogger.error("GenFds", OPTION_VALUE_INVALID,\r
                                "No such an FD in FDF file: %s" % FdsCommandDict.get("fd")[0])\r
\r
        if FdsCommandDict.get("fv"):\r
            if FdsCommandDict.get("fv")[0].upper() in FdfParserObj.Profile.FvDict:\r
                GenFds.OnlyGenerateThisFv = FdsCommandDict.get("fv")[0]\r
            else:\r
                EdkLogger.error("GenFds", OPTION_VALUE_INVALID,\r
                                "No such an FV in FDF file: %s" % FdsCommandDict.get("fv")[0])\r
\r
        if FdsCommandDict.get("cap"):\r
            if FdsCommandDict.get("cap")[0].upper() in FdfParserObj.Profile.CapsuleDict:\r
                GenFds.OnlyGenerateThisCap = FdsCommandDict.get("cap")[0]\r
            else:\r
                EdkLogger.error("GenFds", OPTION_VALUE_INVALID,\r
                                "No such a Capsule in FDF file: %s" % FdsCommandDict.get("cap")[0])\r
\r
        GenFdsGlobalVariable.WorkSpace = BuildWorkSpace\r
        if ArchList:\r
            GenFdsGlobalVariable.ArchList = ArchList\r
\r
        # Dsc Build Data will handle Pcd Settings from CommandLine.\r
\r
        """Modify images from build output if the feature of loading driver at fixed address is on."""\r
        if GenFdsGlobalVariable.FixedLoadAddress:\r
            GenFds.PreprocessImage(BuildWorkSpace, GenFdsGlobalVariable.ActivePlatform)\r
\r
        # Record the FV Region info that may specific in the FD\r
        if FdfParserObj.Profile.FvDict and FdfParserObj.Profile.FdDict:\r
            for FvObj in FdfParserObj.Profile.FvDict.values():\r
                for FdObj in FdfParserObj.Profile.FdDict.values():\r
                    for RegionObj in FdObj.RegionList:\r
                        if RegionObj.RegionType != BINARY_FILE_TYPE_FV:\r
                            continue\r
                        for RegionData in RegionObj.RegionDataList:\r
                            if FvObj.UiFvName.upper() == RegionData.upper():\r
                                if FvObj.FvRegionInFD:\r
                                    if FvObj.FvRegionInFD != RegionObj.Size:\r
                                        EdkLogger.error("GenFds", FORMAT_INVALID, "The FV %s's region is specified in multiple FD with different value." %FvObj.UiFvName)\r
                                else:\r
                                    FvObj.FvRegionInFD = RegionObj.Size\r
                                    RegionObj.BlockInfoOfRegion(FdObj.BlockSizeList, FvObj)\r
\r
        """Call GenFds"""\r
        GenFds.GenFd('', FdfParserObj, BuildWorkSpace, ArchList)\r
\r
        """Generate GUID cross reference file"""\r
        GenFds.GenerateGuidXRefFile(BuildWorkSpace, ArchList, FdfParserObj)\r
\r
        """Display FV space info."""\r
        GenFds.DisplayFvSpaceInfo(FdfParserObj)\r
\r
    except Warning as X:\r
        EdkLogger.error(X.ToolName, FORMAT_INVALID, File=X.FileName, Line=X.LineNumber, ExtraData=X.Message, RaiseError=False)\r
        ReturnCode = FORMAT_INVALID\r
    except FatalError as X:\r
        if FdsCommandDict.get("debug") is not None:\r
            import traceback\r
            EdkLogger.quiet(traceback.format_exc())\r
        ReturnCode = X.args[0]\r
    except:\r
        import traceback\r
        EdkLogger.error(\r
                    "\nPython",\r
                    CODE_ERROR,\r
                    "Tools code failure",\r
                    ExtraData="Please send email to edk2-devel@lists.01.org for help, attaching following call stack trace!\n",\r
                    RaiseError=False\r
                    )\r
        EdkLogger.quiet(traceback.format_exc())\r
        ReturnCode = CODE_ERROR\r
    finally:\r
        ClearDuplicatedInf()\r
    return ReturnCode\r
\r
def OptionsToCommandDict(Options):\r
    FdsCommandDict = {}\r
    FdsCommandDict["verbose"] = Options.verbose\r
    FdsCommandDict["FixedAddress"] = Options.FixedAddress\r
    FdsCommandDict["quiet"] = Options.quiet\r
    FdsCommandDict["debug"] = Options.debug\r
    FdsCommandDict["Workspace"] = Options.Workspace\r
    FdsCommandDict["GenfdsMultiThread"] = Options.GenfdsMultiThread\r
    FdsCommandDict["fdf_file"] = [PathClass(Options.filename)] if Options.filename else []\r
    FdsCommandDict["build_target"] = Options.BuildTarget\r
    FdsCommandDict["toolchain_tag"] = Options.ToolChain\r
    FdsCommandDict["active_platform"] = Options.activePlatform\r
    FdsCommandDict["OptionPcd"] = Options.OptionPcd\r
    FdsCommandDict["conf_directory"] = Options.ConfDirectory\r
    FdsCommandDict["IgnoreSources"] = Options.IgnoreSources\r
    FdsCommandDict["macro"] = Options.Macros\r
    FdsCommandDict["build_architecture_list"] = Options.archList\r
    FdsCommandDict["platform_build_directory"] = Options.outputDir\r
    FdsCommandDict["fd"] = [Options.uiFdName] if Options.uiFdName else []\r
    FdsCommandDict["fv"] = [Options.uiFvName] if Options.uiFvName else []\r
    FdsCommandDict["cap"] = [Options.uiCapName] if Options.uiCapName else []\r
    return FdsCommandDict\r
\r
\r
gParamCheck = []\r
def SingleCheckCallback(option, opt_str, value, parser):\r
    if option not in gParamCheck:\r
        setattr(parser.values, option.dest, value)\r
        gParamCheck.append(option)\r
    else:\r
        parser.error("Option %s only allows one instance in command line!" % option)\r
\r
## Parse command line options\r
#\r
# Using standard Python module optparse to parse command line option of this tool.\r
#\r
#   @retval Opt   A optparse.Values object containing the parsed options\r
#\r
def myOptionParser():\r
    usage = "%prog [options] -f input_file -a arch_list -b build_target -p active_platform -t tool_chain_tag -D \"MacroName [= MacroValue]\""\r
    Parser = OptionParser(usage=usage, description=__copyright__, version="%prog " + str(versionNumber))\r
    Parser.add_option("-f", "--file", dest="filename", type="string", help="Name of FDF file to convert", action="callback", callback=SingleCheckCallback)\r
    Parser.add_option("-a", "--arch", dest="archList", help="comma separated list containing one or more of: IA32, X64, IPF, ARM, AARCH64 or EBC which should be built, overrides target.txt?s TARGET_ARCH")\r
    Parser.add_option("-q", "--quiet", action="store_true", type=None, help="Disable all messages except FATAL ERRORS.")\r
    Parser.add_option("-v", "--verbose", action="store_true", type=None, help="Turn on verbose output with informational messages printed.")\r
    Parser.add_option("-d", "--debug", action="store", type="int", help="Enable debug messages at specified level.")\r
    Parser.add_option("-p", "--platform", type="string", dest="activePlatform", help="Set the ACTIVE_PLATFORM, overrides target.txt ACTIVE_PLATFORM setting.",\r
                      action="callback", callback=SingleCheckCallback)\r
    Parser.add_option("-w", "--workspace", type="string", dest="Workspace", default=os.environ.get('WORKSPACE'), help="Set the WORKSPACE",\r
                      action="callback", callback=SingleCheckCallback)\r
    Parser.add_option("-o", "--outputDir", type="string", dest="outputDir", help="Name of Build Output directory",\r
                      action="callback", callback=SingleCheckCallback)\r
    Parser.add_option("-r", "--rom_image", dest="uiFdName", help="Build the image using the [FD] section named by FdUiName.")\r
    Parser.add_option("-i", "--FvImage", dest="uiFvName", help="Build the FV image using the [FV] section named by UiFvName")\r
    Parser.add_option("-C", "--CapsuleImage", dest="uiCapName", help="Build the Capsule image using the [Capsule] section named by UiCapName")\r
    Parser.add_option("-b", "--buildtarget", type="string", dest="BuildTarget", help="Set the build TARGET, overrides target.txt TARGET setting.",\r
                      action="callback", callback=SingleCheckCallback)\r
    Parser.add_option("-t", "--tagname", type="string", dest="ToolChain", help="Using the tools: TOOL_CHAIN_TAG name to build the platform.",\r
                      action="callback", callback=SingleCheckCallback)\r
    Parser.add_option("-D", "--define", action="append", type="string", dest="Macros", help="Macro: \"Name [= Value]\".")\r
    Parser.add_option("-s", "--specifyaddress", dest="FixedAddress", action="store_true", type=None, help="Specify driver load address.")\r
    Parser.add_option("--conf", action="store", type="string", dest="ConfDirectory", help="Specify the customized Conf directory.")\r
    Parser.add_option("--ignore-sources", action="store_true", dest="IgnoreSources", default=False, help="Focus to a binary build and ignore all source files")\r
    Parser.add_option("--pcd", action="append", dest="OptionPcd", help="Set PCD value by command line. Format: \"PcdName=Value\" ")\r
    Parser.add_option("--genfds-multi-thread", action="store_true", dest="GenfdsMultiThread", default=False, help="Enable GenFds multi thread to generate ffs file.")\r
\r
    Options, _ = Parser.parse_args()\r
    return Options\r
\r
## The class implementing the EDK2 flash image generation process\r
#\r
#   This process includes:\r
#       1. Collect workspace information, includes platform and module information\r
#       2. Call methods of Fd class to generate FD\r
#       3. Call methods of Fv class to generate FV that not belong to FD\r
#\r
class GenFds(object):\r
    FdfParsef = None\r
    OnlyGenerateThisFd = None\r
    OnlyGenerateThisFv = None\r
    OnlyGenerateThisCap = None\r
\r
    ## GenFd()\r
    #\r
    #   @param  OutputDir           Output directory\r
    #   @param  FdfParserObject     FDF contents parser\r
    #   @param  Workspace           The directory of workspace\r
    #   @param  ArchList            The Arch list of platform\r
    #\r
    @staticmethod\r
    def GenFd (OutputDir, FdfParserObject, WorkSpace, ArchList):\r
        GenFdsGlobalVariable.SetDir ('', FdfParserObject, WorkSpace, ArchList)\r
\r
        GenFdsGlobalVariable.VerboseLogger(" Generate all Fd images and their required FV and Capsule images!")\r
        if GenFds.OnlyGenerateThisCap is not None and GenFds.OnlyGenerateThisCap.upper() in GenFdsGlobalVariable.FdfParser.Profile.CapsuleDict:\r
            CapsuleObj = GenFdsGlobalVariable.FdfParser.Profile.CapsuleDict[GenFds.OnlyGenerateThisCap.upper()]\r
            if CapsuleObj is not None:\r
                CapsuleObj.GenCapsule()\r
                return\r
\r
        if GenFds.OnlyGenerateThisFd is not None and GenFds.OnlyGenerateThisFd.upper() in GenFdsGlobalVariable.FdfParser.Profile.FdDict:\r
            FdObj = GenFdsGlobalVariable.FdfParser.Profile.FdDict[GenFds.OnlyGenerateThisFd.upper()]\r
            if FdObj is not None:\r
                FdObj.GenFd()\r
                return\r
        elif GenFds.OnlyGenerateThisFd is None and GenFds.OnlyGenerateThisFv is None:\r
            for FdObj in GenFdsGlobalVariable.FdfParser.Profile.FdDict.values():\r
                FdObj.GenFd()\r
\r
        GenFdsGlobalVariable.VerboseLogger("\n Generate other FV images! ")\r
        if GenFds.OnlyGenerateThisFv is not None and GenFds.OnlyGenerateThisFv.upper() in GenFdsGlobalVariable.FdfParser.Profile.FvDict:\r
            FvObj = GenFdsGlobalVariable.FdfParser.Profile.FvDict[GenFds.OnlyGenerateThisFv.upper()]\r
            if FvObj is not None:\r
                Buffer = BytesIO()\r
                FvObj.AddToBuffer(Buffer)\r
                Buffer.close()\r
                return\r
        elif GenFds.OnlyGenerateThisFv is None:\r
            for FvObj in GenFdsGlobalVariable.FdfParser.Profile.FvDict.values():\r
                Buffer = BytesIO('')\r
                FvObj.AddToBuffer(Buffer)\r
                Buffer.close()\r
\r
        if GenFds.OnlyGenerateThisFv is None and GenFds.OnlyGenerateThisFd is None and GenFds.OnlyGenerateThisCap is None:\r
            if GenFdsGlobalVariable.FdfParser.Profile.CapsuleDict != {}:\r
                GenFdsGlobalVariable.VerboseLogger("\n Generate other Capsule images!")\r
                for CapsuleObj in GenFdsGlobalVariable.FdfParser.Profile.CapsuleDict.values():\r
                    CapsuleObj.GenCapsule()\r
\r
            if GenFdsGlobalVariable.FdfParser.Profile.OptRomDict != {}:\r
                GenFdsGlobalVariable.VerboseLogger("\n Generate all Option ROM!")\r
                for OptRomObj in GenFdsGlobalVariable.FdfParser.Profile.OptRomDict.values():\r
                    OptRomObj.AddToBuffer(None)\r
\r
    @staticmethod\r
    def GenFfsMakefile(OutputDir, FdfParserObject, WorkSpace, ArchList, GlobalData):\r
        GenFdsGlobalVariable.SetEnv(FdfParserObject, WorkSpace, ArchList, GlobalData)\r
        for FdObj in GenFdsGlobalVariable.FdfParser.Profile.FdDict.values():\r
            FdObj.GenFd(Flag=True)\r
\r
        for FvObj in GenFdsGlobalVariable.FdfParser.Profile.FvDict.values():\r
            FvObj.AddToBuffer(Buffer=None, Flag=True)\r
\r
        if GenFdsGlobalVariable.FdfParser.Profile.OptRomDict != {}:\r
            for OptRomObj in GenFdsGlobalVariable.FdfParser.Profile.OptRomDict.values():\r
                OptRomObj.AddToBuffer(Buffer=None, Flag=True)\r
\r
        return GenFdsGlobalVariable.FfsCmdDict\r
\r
    ## GetFvBlockSize()\r
    #\r
    #   @param  FvObj           Whose block size to get\r
    #   @retval int             Block size value\r
    #\r
    @staticmethod\r
    def GetFvBlockSize(FvObj):\r
        DefaultBlockSize = 0x1\r
        FdObj = None\r
        if GenFds.OnlyGenerateThisFd is not None and GenFds.OnlyGenerateThisFd.upper() in GenFdsGlobalVariable.FdfParser.Profile.FdDict:\r
            FdObj = GenFdsGlobalVariable.FdfParser.Profile.FdDict[GenFds.OnlyGenerateThisFd.upper()]\r
        if FdObj is None:\r
            for ElementFd in GenFdsGlobalVariable.FdfParser.Profile.FdDict.values():\r
                for ElementRegion in ElementFd.RegionList:\r
                    if ElementRegion.RegionType == BINARY_FILE_TYPE_FV:\r
                        for ElementRegionData in ElementRegion.RegionDataList:\r
                            if ElementRegionData is not None and ElementRegionData.upper() == FvObj.UiFvName:\r
                                if FvObj.BlockSizeList != []:\r
                                    return FvObj.BlockSizeList[0][0]\r
                                else:\r
                                    return ElementRegion.BlockSizeOfRegion(ElementFd.BlockSizeList)\r
            if FvObj.BlockSizeList != []:\r
                return FvObj.BlockSizeList[0][0]\r
            return DefaultBlockSize\r
        else:\r
            for ElementRegion in FdObj.RegionList:\r
                    if ElementRegion.RegionType == BINARY_FILE_TYPE_FV:\r
                        for ElementRegionData in ElementRegion.RegionDataList:\r
                            if ElementRegionData is not None and ElementRegionData.upper() == FvObj.UiFvName:\r
                                if FvObj.BlockSizeList != []:\r
                                    return FvObj.BlockSizeList[0][0]\r
                                else:\r
                                    return ElementRegion.BlockSizeOfRegion(ElementFd.BlockSizeList)\r
            return DefaultBlockSize\r
\r
    ## DisplayFvSpaceInfo()\r
    #\r
    #   @param  FvObj           Whose block size to get\r
    #   @retval None\r
    #\r
    @staticmethod\r
    def DisplayFvSpaceInfo(FdfParserObject):\r
\r
        FvSpaceInfoList = []\r
        MaxFvNameLength = 0\r
        for FvName in FdfParserObject.Profile.FvDict:\r
            if len(FvName) > MaxFvNameLength:\r
                MaxFvNameLength = len(FvName)\r
            FvSpaceInfoFileName = os.path.join(GenFdsGlobalVariable.FvDir, FvName.upper() + '.Fv.map')\r
            if os.path.exists(FvSpaceInfoFileName):\r
                FileLinesList = getlines(FvSpaceInfoFileName)\r
                TotalFound = False\r
                Total = ''\r
                UsedFound = False\r
                Used = ''\r
                FreeFound = False\r
                Free = ''\r
                for Line in FileLinesList:\r
                    NameValue = Line.split('=')\r
                    if len(NameValue) == 2:\r
                        if NameValue[0].strip() == 'EFI_FV_TOTAL_SIZE':\r
                            TotalFound = True\r
                            Total = NameValue[1].strip()\r
                        if NameValue[0].strip() == 'EFI_FV_TAKEN_SIZE':\r
                            UsedFound = True\r
                            Used = NameValue[1].strip()\r
                        if NameValue[0].strip() == 'EFI_FV_SPACE_SIZE':\r
                            FreeFound = True\r
                            Free = NameValue[1].strip()\r
\r
                if TotalFound and UsedFound and FreeFound:\r
                    FvSpaceInfoList.append((FvName, Total, Used, Free))\r
\r
        GenFdsGlobalVariable.InfLogger('\nFV Space Information')\r
        for FvSpaceInfo in FvSpaceInfoList:\r
            Name = FvSpaceInfo[0]\r
            TotalSizeValue = int(FvSpaceInfo[1], 0)\r
            UsedSizeValue = int(FvSpaceInfo[2], 0)\r
            FreeSizeValue = int(FvSpaceInfo[3], 0)\r
            if UsedSizeValue == TotalSizeValue:\r
                Percentage = '100'\r
            else:\r
                Percentage = str((UsedSizeValue + 0.0) / TotalSizeValue)[0:4].lstrip('0.')\r
\r
            GenFdsGlobalVariable.InfLogger(Name + ' ' + '[' + Percentage + '%Full] ' + str(TotalSizeValue) + ' total, ' + str(UsedSizeValue) + ' used, ' + str(FreeSizeValue) + ' free')\r
\r
    ## PreprocessImage()\r
    #\r
    #   @param  BuildDb         Database from build meta data files\r
    #   @param  DscFile         modules from dsc file will be preprocessed\r
    #   @retval None\r
    #\r
    @staticmethod\r
    def PreprocessImage(BuildDb, DscFile):\r
        PcdDict = BuildDb.BuildObject[DscFile, TAB_COMMON, GenFdsGlobalVariable.TargetName, GenFdsGlobalVariable.ToolChainTag].Pcds\r
        PcdValue = ''\r
        for Key in PcdDict:\r
            PcdObj = PcdDict[Key]\r
            if PcdObj.TokenCName == 'PcdBsBaseAddress':\r
                PcdValue = PcdObj.DefaultValue\r
                break\r
\r
        if PcdValue == '':\r
            return\r
\r
        Int64PcdValue = int(PcdValue, 0)\r
        if Int64PcdValue == 0 or Int64PcdValue < -1:\r
            return\r
\r
        TopAddress = 0\r
        if Int64PcdValue > 0:\r
            TopAddress = Int64PcdValue\r
\r
        ModuleDict = BuildDb.BuildObject[DscFile, TAB_COMMON, GenFdsGlobalVariable.TargetName, GenFdsGlobalVariable.ToolChainTag].Modules\r
        for Key in ModuleDict:\r
            ModuleObj = BuildDb.BuildObject[Key, TAB_COMMON, GenFdsGlobalVariable.TargetName, GenFdsGlobalVariable.ToolChainTag]\r
            print(ModuleObj.BaseName + ' ' + ModuleObj.ModuleType)\r
\r
    @staticmethod\r
    def GenerateGuidXRefFile(BuildDb, ArchList, FdfParserObj):\r
        GuidXRefFileName = os.path.join(GenFdsGlobalVariable.FvDir, "Guid.xref")\r
        GuidXRefFile = BytesIO('')\r
        PkgGuidDict = {}\r
        GuidDict = {}\r
        ModuleList = []\r
        FileGuidList = []\r
        for Arch in ArchList:\r
            PlatformDataBase = BuildDb.BuildObject[GenFdsGlobalVariable.ActivePlatform, Arch, GenFdsGlobalVariable.TargetName, GenFdsGlobalVariable.ToolChainTag]\r
            PkgList = GenFdsGlobalVariable.WorkSpace.GetPackageList(GenFdsGlobalVariable.ActivePlatform, Arch, GenFdsGlobalVariable.TargetName, GenFdsGlobalVariable.ToolChainTag)\r
            for P in PkgList:\r
                PkgGuidDict.update(P.Guids)\r
            for Name, Guid in PlatformDataBase.Pcds:\r
                Pcd = PlatformDataBase.Pcds[Name, Guid]\r
                if Pcd.Type in [TAB_PCDS_DYNAMIC_HII, TAB_PCDS_DYNAMIC_EX_HII]:\r
                    for SkuId in Pcd.SkuInfoList:\r
                        Sku = Pcd.SkuInfoList[SkuId]\r
                        if Sku.VariableGuid and Sku.VariableGuid in PkgGuidDict.keys():\r
                            GuidDict[Sku.VariableGuid] = PkgGuidDict[Sku.VariableGuid]\r
            for ModuleFile in PlatformDataBase.Modules:\r
                Module = BuildDb.BuildObject[ModuleFile, Arch, GenFdsGlobalVariable.TargetName, GenFdsGlobalVariable.ToolChainTag]\r
                if Module in ModuleList:\r
                    continue\r
                else:\r
                    ModuleList.append(Module)\r
                if GlobalData.gGuidPattern.match(ModuleFile.BaseName):\r
                    GuidXRefFile.write("%s %s\n" % (ModuleFile.BaseName, Module.BaseName))\r
                else:\r
                    GuidXRefFile.write("%s %s\n" % (Module.Guid, Module.BaseName))\r
                GuidDict.update(Module.Protocols)\r
                GuidDict.update(Module.Guids)\r
                GuidDict.update(Module.Ppis)\r
            for FvName in FdfParserObj.Profile.FvDict:\r
                for FfsObj in FdfParserObj.Profile.FvDict[FvName].FfsList:\r
                    if not isinstance(FfsObj, FileStatement):\r
                        InfPath = PathClass(NormPath(mws.join(GenFdsGlobalVariable.WorkSpaceDir, FfsObj.InfFileName)))\r
                        FdfModule = BuildDb.BuildObject[InfPath, Arch, GenFdsGlobalVariable.TargetName, GenFdsGlobalVariable.ToolChainTag]\r
                        if FdfModule in ModuleList:\r
                            continue\r
                        else:\r
                            ModuleList.append(FdfModule)\r
                        GuidXRefFile.write("%s %s\n" % (FdfModule.Guid, FdfModule.BaseName))\r
                        GuidDict.update(FdfModule.Protocols)\r
                        GuidDict.update(FdfModule.Guids)\r
                        GuidDict.update(FdfModule.Ppis)\r
                    else:\r
                        FileStatementGuid = FfsObj.NameGuid\r
                        if FileStatementGuid in FileGuidList:\r
                            continue\r
                        else:\r
                            FileGuidList.append(FileStatementGuid)\r
                        Name = []\r
                        FfsPath = os.path.join(GenFdsGlobalVariable.FvDir, 'Ffs')\r
                        FfsPath = glob(os.path.join(FfsPath, FileStatementGuid) + TAB_STAR)\r
                        if not FfsPath:\r
                            continue\r
                        if not os.path.exists(FfsPath[0]):\r
                            continue\r
                        MatchDict = {}\r
                        ReFileEnds = compile('\S+(.ui)$|\S+(fv.sec.txt)$|\S+(.pe32.txt)$|\S+(.te.txt)$|\S+(.pic.txt)$|\S+(.raw.txt)$|\S+(.ffs.txt)$')\r
                        FileList = os.listdir(FfsPath[0])\r
                        for File in FileList:\r
                            Match = ReFileEnds.search(File)\r
                            if Match:\r
                                for Index in range(1, 8):\r
                                    if Match.group(Index) and Match.group(Index) in MatchDict:\r
                                        MatchDict[Match.group(Index)].append(File)\r
                                    elif Match.group(Index):\r
                                        MatchDict[Match.group(Index)] = [File]\r
                        if not MatchDict:\r
                            continue\r
                        if '.ui' in MatchDict:\r
                            for File in MatchDict['.ui']:\r
                                with open(os.path.join(FfsPath[0], File), 'rb') as F:\r
                                    F.read()\r
                                    length = F.tell()\r
                                    F.seek(4)\r
                                    TmpStr = unpack('%dh' % ((length - 4) / 2), F.read())\r
                                    Name = ''.join(chr(c) for c in TmpStr[:-1])\r
                        else:\r
                            FileList = []\r
                            if 'fv.sec.txt' in MatchDict:\r
                                FileList = MatchDict['fv.sec.txt']\r
                            elif '.pe32.txt' in MatchDict:\r
                                FileList = MatchDict['.pe32.txt']\r
                            elif '.te.txt' in MatchDict:\r
                                FileList = MatchDict['.te.txt']\r
                            elif '.pic.txt' in MatchDict:\r
                                FileList = MatchDict['.pic.txt']\r
                            elif '.raw.txt' in MatchDict:\r
                                FileList = MatchDict['.raw.txt']\r
                            elif '.ffs.txt' in MatchDict:\r
                                FileList = MatchDict['.ffs.txt']\r
                            else:\r
                                pass\r
                            for File in FileList:\r
                                with open(os.path.join(FfsPath[0], File), 'r') as F:\r
                                    Name.append((F.read().split()[-1]))\r
                        if not Name:\r
                            continue\r
\r
                        Name = ' '.join(Name) if isinstance(Name, type([])) else Name\r
                        GuidXRefFile.write("%s %s\n" %(FileStatementGuid, Name))\r
\r
       # Append GUIDs, Protocols, and PPIs to the Xref file\r
        GuidXRefFile.write("\n")\r
        for key, item in GuidDict.items():\r
            GuidXRefFile.write("%s %s\n" % (GuidStructureStringToGuidString(item).upper(), key))\r
\r
        if GuidXRefFile.getvalue():\r
            SaveFileOnChange(GuidXRefFileName, GuidXRefFile.getvalue(), False)\r
            GenFdsGlobalVariable.InfLogger("\nGUID cross reference file can be found at %s" % GuidXRefFileName)\r
        elif os.path.exists(GuidXRefFileName):\r
            os.remove(GuidXRefFileName)\r
        GuidXRefFile.close()\r
\r
\r
if __name__ == '__main__':\r
    r = main()\r
    ## 0-127 is a safe return range, and 1 is a standard default error\r
    if r < 0 or r > 127:\r
        r = 1\r
    exit(r)\r
\r