[mirror_edk2.git] / BaseTools / Source / Python / AutoGen / GenMake.py

## @file\r
# Create makefile for MS nmake and GNU make\r
#\r
# Copyright (c) 2007 - 2014, 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
## Import Modules\r
#\r
import Common.LongFilePathOs as os\r
import sys\r
import string\r
import re\r
import os.path as path\r
from Common.LongFilePathSupport import OpenLongFilePath as open\r
\r
from Common.BuildToolError import *\r
from Common.Misc import *\r
from Common.String import *\r
from BuildEngine import *\r
import Common.GlobalData as GlobalData\r
\r
## Regular expression for finding header file inclusions\r
gIncludePattern = re.compile(r"^[ \t]*#?[ \t]*include(?:[ \t]*(?:\\(?:\r\n|\r|\n))*[ \t]*)*(?:\(?[\"<]?[ \t]*)([-\w.\\/() \t]+)(?:[ \t]*[\">]?\)?)", re.MULTILINE|re.UNICODE|re.IGNORECASE)\r
\r
## Regular expression for matching macro used in header file inclusion\r
gMacroPattern = re.compile("([_A-Z][_A-Z0-9]*)[ \t]*\((.+)\)", re.UNICODE)\r
\r
gIsFileMap = {}\r
\r
## pattern for include style in Edk.x code\r
gProtocolDefinition = "Protocol/%(HeaderKey)s/%(HeaderKey)s.h"\r
gGuidDefinition = "Guid/%(HeaderKey)s/%(HeaderKey)s.h"\r
gArchProtocolDefinition = "ArchProtocol/%(HeaderKey)s/%(HeaderKey)s.h"\r
gPpiDefinition = "Ppi/%(HeaderKey)s/%(HeaderKey)s.h"\r
gIncludeMacroConversion = {\r
  "EFI_PROTOCOL_DEFINITION"         :   gProtocolDefinition,\r
  "EFI_GUID_DEFINITION"             :   gGuidDefinition,\r
  "EFI_ARCH_PROTOCOL_DEFINITION"    :   gArchProtocolDefinition,\r
  "EFI_PROTOCOL_PRODUCER"           :   gProtocolDefinition,\r
  "EFI_PROTOCOL_CONSUMER"           :   gProtocolDefinition,\r
  "EFI_PROTOCOL_DEPENDENCY"         :   gProtocolDefinition,\r
  "EFI_ARCH_PROTOCOL_PRODUCER"      :   gArchProtocolDefinition,\r
  "EFI_ARCH_PROTOCOL_CONSUMER"      :   gArchProtocolDefinition,\r
  "EFI_ARCH_PROTOCOL_DEPENDENCY"    :   gArchProtocolDefinition,\r
  "EFI_PPI_DEFINITION"              :   gPpiDefinition,\r
  "EFI_PPI_PRODUCER"                :   gPpiDefinition,\r
  "EFI_PPI_CONSUMER"                :   gPpiDefinition,\r
  "EFI_PPI_DEPENDENCY"              :   gPpiDefinition,\r
}\r
\r
## default makefile type\r
gMakeType = ""\r
if sys.platform == "win32":\r
    gMakeType = "nmake"\r
else:\r
    gMakeType = "gmake"\r
\r
\r
## BuildFile class\r
#\r
#  This base class encapsules build file and its generation. It uses template to generate\r
#  the content of build file. The content of build file will be got from AutoGen objects.\r
#\r
class BuildFile(object):\r
    ## template used to generate the build file (i.e. makefile if using make)\r
    _TEMPLATE_ = TemplateString('')\r
\r
    _DEFAULT_FILE_NAME_ = "Makefile"\r
\r
    ## default file name for each type of build file\r
    _FILE_NAME_ = {\r
        "nmake" :   "Makefile",\r
        "gmake" :   "GNUmakefile"\r
    }\r
\r
    ## Fixed header string for makefile\r
    _MAKEFILE_HEADER = '''#\r
# DO NOT EDIT\r
# This file is auto-generated by build utility\r
#\r
# Module Name:\r
#\r
#   %s\r
#\r
# Abstract:\r
#\r
#   Auto-generated makefile for building modules, libraries or platform\r
#\r
    '''\r
\r
    ## Header string for each type of build file\r
    _FILE_HEADER_ = {\r
        "nmake" :   _MAKEFILE_HEADER % _FILE_NAME_["nmake"],\r
        "gmake" :   _MAKEFILE_HEADER % _FILE_NAME_["gmake"]\r
    }\r
\r
    ## shell commands which can be used in build file in the form of macro\r
    #   $(CP)     copy file command\r
    #   $(MV)     move file command\r
    #   $(RM)     remove file command\r
    #   $(MD)     create dir command\r
    #   $(RD)     remove dir command\r
    #\r
    _SHELL_CMD_ = {\r
        "nmake" : {\r
            "CP"    :   "copy /y",\r
            "MV"    :   "move /y",\r
            "RM"    :   "del /f /q",\r
            "MD"    :   "mkdir",\r
            "RD"    :   "rmdir /s /q",\r
        },\r
\r
        "gmake" : {\r
            "CP"    :   "cp -f",\r
            "MV"    :   "mv -f",\r
            "RM"    :   "rm -f",\r
            "MD"    :   "mkdir -p",\r
            "RD"    :   "rm -r -f",\r
        }\r
    }\r
\r
    ## directory separator\r
    _SEP_ = {\r
        "nmake" :   "\\",\r
        "gmake" :   "/"\r
    }\r
\r
    ## directory creation template\r
    _MD_TEMPLATE_ = {\r
        "nmake" :   'if not exist %(dir)s $(MD) %(dir)s',\r
        "gmake" :   "$(MD) %(dir)s"\r
    }\r
\r
    ## directory removal template\r
    _RD_TEMPLATE_ = {\r
        "nmake" :   'if exist %(dir)s $(RD) %(dir)s',\r
        "gmake" :   "$(RD) %(dir)s"\r
    }\r
\r
    _CD_TEMPLATE_ = {\r
        "nmake" :   'if exist %(dir)s cd %(dir)s',\r
        "gmake" :   "test -e %(dir)s && cd %(dir)s"\r
    }\r
\r
    _MAKE_TEMPLATE_ = {\r
        "nmake" :   'if exist %(file)s "$(MAKE)" $(MAKE_FLAGS) -f %(file)s',\r
        "gmake" :   'test -e %(file)s && "$(MAKE)" $(MAKE_FLAGS) -f %(file)s'\r
    }\r
\r
    _INCLUDE_CMD_ = {\r
        "nmake" :   '!INCLUDE',\r
        "gmake" :   "include"\r
    }\r
\r
    _INC_FLAG_ = {"MSFT" : "/I", "GCC" : "-I", "INTEL" : "-I", "RVCT" : "-I"}\r
\r
    ## Constructor of BuildFile\r
    #\r
    #   @param  AutoGenObject   Object of AutoGen class\r
    #\r
    def __init__(self, AutoGenObject):\r
        self._AutoGenObject = AutoGenObject\r
        self._FileType = gMakeType\r
\r
    ## Create build file\r
    #\r
    #   @param  FileType    Type of build file. Only nmake and gmake are supported now.\r
    #\r
    #   @retval TRUE        The build file is created or re-created successfully\r
    #   @retval FALSE       The build file exists and is the same as the one to be generated\r
    #\r
    def Generate(self, FileType=gMakeType):\r
        if FileType not in self._FILE_NAME_:\r
            EdkLogger.error("build", PARAMETER_INVALID, "Invalid build type [%s]" % FileType,\r
                            ExtraData="[%s]" % str(self._AutoGenObject))\r
        self._FileType = FileType\r
        FileContent = self._TEMPLATE_.Replace(self._TemplateDict)\r
        FileName = self._FILE_NAME_[FileType]\r
        return SaveFileOnChange(os.path.join(self._AutoGenObject.MakeFileDir, FileName), FileContent, False)\r
\r
    ## Return a list of directory creation command string\r
    #\r
    #   @param      DirList     The list of directory to be created\r
    #\r
    #   @retval     list        The directory creation command list\r
    #\r
    def GetCreateDirectoryCommand(self, DirList):\r
        return [self._MD_TEMPLATE_[self._FileType] % {'dir':Dir} for Dir in DirList]\r
\r
    ## Return a list of directory removal command string\r
    #\r
    #   @param      DirList     The list of directory to be removed\r
    #\r
    #   @retval     list        The directory removal command list\r
    #\r
    def GetRemoveDirectoryCommand(self, DirList):\r
        return [self._RD_TEMPLATE_[self._FileType] % {'dir':Dir} for Dir in DirList]\r
\r
    def PlaceMacro(self, Path, MacroDefinitions={}):\r
        if Path.startswith("$("):\r
            return Path\r
        else:\r
            PathLength = len(Path)\r
            for MacroName in MacroDefinitions:\r
                MacroValue = MacroDefinitions[MacroName]\r
                MacroValueLength = len(MacroValue)\r
                if MacroValueLength <= PathLength and Path.startswith(MacroValue):\r
                    Path = "$(%s)%s" % (MacroName, Path[MacroValueLength:])\r
                    break\r
            return Path\r
\r
## ModuleMakefile class\r
#\r
#  This class encapsules makefie and its generation for module. It uses template to generate\r
#  the content of makefile. The content of makefile will be got from ModuleAutoGen object.\r
#\r
class ModuleMakefile(BuildFile):\r
    ## template used to generate the makefile for module\r
    _TEMPLATE_ = TemplateString('''\\r
${makefile_header}\r
\r
#\r
# Platform Macro Definition\r
#\r
PLATFORM_NAME = ${platform_name}\r
PLATFORM_GUID = ${platform_guid}\r
PLATFORM_VERSION = ${platform_version}\r
PLATFORM_RELATIVE_DIR = ${platform_relative_directory}\r
PLATFORM_DIR = $(WORKSPACE)${separator}${platform_relative_directory}\r
PLATFORM_OUTPUT_DIR = ${platform_output_directory}\r
\r
#\r
# Module Macro Definition\r
#\r
MODULE_NAME = ${module_name}\r
MODULE_GUID = ${module_guid}\r
MODULE_VERSION = ${module_version}\r
MODULE_TYPE = ${module_type}\r
MODULE_FILE = ${module_file}\r
MODULE_FILE_BASE_NAME = ${module_file_base_name}\r
BASE_NAME = $(MODULE_NAME)\r
MODULE_RELATIVE_DIR = ${module_relative_directory}\r
PACKAGE_RELATIVE_DIR = ${package_relative_directory}\r
MODULE_DIR = $(WORKSPACE)${separator}${module_relative_directory}\r
\r
MODULE_ENTRY_POINT = ${module_entry_point}\r
ARCH_ENTRY_POINT = ${arch_entry_point}\r
IMAGE_ENTRY_POINT = ${image_entry_point}\r
\r
${BEGIN}${module_extra_defines}\r
${END}\r
#\r
# Build Configuration Macro Definition\r
#\r
ARCH = ${architecture}\r
TOOLCHAIN = ${toolchain_tag}\r
TOOLCHAIN_TAG = ${toolchain_tag}\r
TARGET = ${build_target}\r
\r
#\r
# Build Directory Macro Definition\r
#\r
# PLATFORM_BUILD_DIR = ${platform_build_directory}\r
BUILD_DIR = ${platform_build_directory}\r
BIN_DIR = $(BUILD_DIR)${separator}${architecture}\r
LIB_DIR = $(BIN_DIR)\r
MODULE_BUILD_DIR = ${module_build_directory}\r
OUTPUT_DIR = ${module_output_directory}\r
DEBUG_DIR = ${module_debug_directory}\r
DEST_DIR_OUTPUT = $(OUTPUT_DIR)\r
DEST_DIR_DEBUG = $(DEBUG_DIR)\r
\r
#\r
# Shell Command Macro\r
#\r
${BEGIN}${shell_command_code} = ${shell_command}\r
${END}\r
\r
#\r
# Tools definitions specific to this module\r
#\r
${BEGIN}${module_tool_definitions}\r
${END}\r
MAKE_FILE = ${makefile_path}\r
\r
#\r
# Build Macro\r
#\r
${BEGIN}${file_macro}\r
${END}\r
\r
COMMON_DEPS = ${BEGIN}${common_dependency_file} \\\r
              ${END}\r
\r
#\r
# Overridable Target Macro Definitions\r
#\r
FORCE_REBUILD = force_build\r
INIT_TARGET = init\r
PCH_TARGET =\r
BC_TARGET = ${BEGIN}${backward_compatible_target} ${END}\r
CODA_TARGET = ${BEGIN}${remaining_build_target} \\\r
              ${END}\r
\r
#\r
# Default target, which will build dependent libraries in addition to source files\r
#\r
\r
all: mbuild\r
\r
\r
#\r
# Target used when called from platform makefile, which will bypass the build of dependent libraries\r
#\r
\r
pbuild: $(INIT_TARGET) $(BC_TARGET) $(PCH_TARGET) $(CODA_TARGET)\r
\r
#\r
# ModuleTarget\r
#\r
\r
mbuild: $(INIT_TARGET) $(BC_TARGET) gen_libs $(PCH_TARGET) $(CODA_TARGET)\r
\r
#\r
# Build Target used in multi-thread build mode, which will bypass the init and gen_libs targets\r
#\r
\r
tbuild: $(BC_TARGET) $(PCH_TARGET) $(CODA_TARGET)\r
\r
#\r
# Phony target which is used to force executing commands for a target\r
#\r
force_build:\r
\t-@\r
\r
#\r
# Target to update the FD\r
#\r
\r
fds: mbuild gen_fds\r
\r
#\r
# Initialization target: print build information and create necessary directories\r
#\r
init: info dirs\r
\r
info:\r
\t-@echo Building ... $(MODULE_DIR)${separator}$(MODULE_FILE) [$(ARCH)]\r
\r
dirs:\r
${BEGIN}\t-@${create_directory_command}\n${END}\r
\r
strdefs:\r
\t-@$(CP) $(DEBUG_DIR)${separator}AutoGen.h $(DEBUG_DIR)${separator}$(MODULE_NAME)StrDefs.h\r
\r
#\r
# GenLibsTarget\r
#\r
gen_libs:\r
\t${BEGIN}@"$(MAKE)" $(MAKE_FLAGS) -f ${dependent_library_build_directory}${separator}${makefile_name}\r
\t${END}@cd $(MODULE_BUILD_DIR)\r
\r
#\r
# Build Flash Device Image\r
#\r
gen_fds:\r
\t@"$(MAKE)" $(MAKE_FLAGS) -f $(BUILD_DIR)${separator}${makefile_name} fds\r
\t@cd $(MODULE_BUILD_DIR)\r
\r
#\r
# Individual Object Build Targets\r
#\r
${BEGIN}${file_build_target}\r
${END}\r
\r
#\r
# clean all intermediate files\r
#\r
clean:\r
\t${BEGIN}${clean_command}\r
\t${END}\r
\r
#\r
# clean all generated files\r
#\r
cleanall:\r
${BEGIN}\t${cleanall_command}\r
${END}\t$(RM) *.pdb *.idb > NUL 2>&1\r
\t$(RM) $(BIN_DIR)${separator}$(MODULE_NAME).efi\r
\r
#\r
# clean all dependent libraries built\r
#\r
cleanlib:\r
\t${BEGIN}-@${library_build_command} cleanall\r
\t${END}@cd $(MODULE_BUILD_DIR)\n\n''')\r
\r
    _FILE_MACRO_TEMPLATE = TemplateString("${macro_name} = ${BEGIN} \\\n    ${source_file}${END}\n")\r
    _BUILD_TARGET_TEMPLATE = TemplateString("${BEGIN}${target} : ${deps}\n${END}\t${cmd}\n")\r
\r
    ## Constructor of ModuleMakefile\r
    #\r
    #   @param  ModuleAutoGen   Object of ModuleAutoGen class\r
    #\r
    def __init__(self, ModuleAutoGen):\r
        BuildFile.__init__(self, ModuleAutoGen)\r
        self.PlatformInfo = self._AutoGenObject.PlatformInfo\r
\r
        self.ResultFileList = []\r
        self.IntermediateDirectoryList = ["$(DEBUG_DIR)", "$(OUTPUT_DIR)"]\r
\r
        self.SourceFileDatabase = {}        # {file type : file path}\r
        self.DestFileDatabase = {}          # {file type : file path}\r
        self.FileBuildTargetList = []       # [(src, target string)]\r
        self.BuildTargetList = []           # [target string]\r
        self.PendingBuildTargetList = []    # [FileBuildRule objects]\r
        self.CommonFileDependency = []\r
        self.FileListMacros = {}\r
        self.ListFileMacros = {}\r
\r
        self.FileCache = {}\r
        self.FileDependency = []\r
        self.LibraryBuildCommandList = []\r
        self.LibraryFileList = []\r
        self.LibraryMakefileList = []\r
        self.LibraryBuildDirectoryList = []\r
        self.SystemLibraryList = []\r
        self.Macros = sdict()\r
        self.Macros["OUTPUT_DIR"      ] = self._AutoGenObject.Macros["OUTPUT_DIR"]\r
        self.Macros["DEBUG_DIR"       ] = self._AutoGenObject.Macros["DEBUG_DIR"]\r
        self.Macros["MODULE_BUILD_DIR"] = self._AutoGenObject.Macros["MODULE_BUILD_DIR"]\r
        self.Macros["BIN_DIR"         ] = self._AutoGenObject.Macros["BIN_DIR"]\r
        self.Macros["BUILD_DIR"       ] = self._AutoGenObject.Macros["BUILD_DIR"]\r
        self.Macros["WORKSPACE"       ] = self._AutoGenObject.Macros["WORKSPACE"]\r
\r
    # Compose a dict object containing information used to do replacement in template\r
    def _CreateTemplateDict(self):\r
        if self._FileType not in self._SEP_:\r
            EdkLogger.error("build", PARAMETER_INVALID, "Invalid Makefile type [%s]" % self._FileType,\r
                            ExtraData="[%s]" % str(self._AutoGenObject))\r
        Separator = self._SEP_[self._FileType]\r
\r
        # break build if no source files and binary files are found\r
        if len(self._AutoGenObject.SourceFileList) == 0 and len(self._AutoGenObject.BinaryFileList) == 0:\r
            EdkLogger.error("build", AUTOGEN_ERROR, "No files to be built in module [%s, %s, %s]"\r
                            % (self._AutoGenObject.BuildTarget, self._AutoGenObject.ToolChain, self._AutoGenObject.Arch),\r
                            ExtraData="[%s]" % str(self._AutoGenObject))\r
\r
        # convert dependent libraries to build command\r
        self.ProcessDependentLibrary()\r
        if len(self._AutoGenObject.Module.ModuleEntryPointList) > 0:\r
            ModuleEntryPoint = self._AutoGenObject.Module.ModuleEntryPointList[0]\r
        else:\r
            ModuleEntryPoint = "_ModuleEntryPoint"\r
\r
        # Intel EBC compiler enforces EfiMain\r
        if self._AutoGenObject.AutoGenVersion < 0x00010005 and self._AutoGenObject.Arch == "EBC":\r
            ArchEntryPoint = "EfiMain"\r
        else:\r
            ArchEntryPoint = ModuleEntryPoint\r
\r
        if self._AutoGenObject.Arch == "EBC":\r
            # EBC compiler always use "EfiStart" as entry point. Only applies to EdkII modules\r
            ImageEntryPoint = "EfiStart"\r
        elif self._AutoGenObject.AutoGenVersion < 0x00010005:\r
            # Edk modules use entry point specified in INF file\r
            ImageEntryPoint = ModuleEntryPoint\r
        else:\r
            # EdkII modules always use "_ModuleEntryPoint" as entry point\r
            ImageEntryPoint = "_ModuleEntryPoint"\r
\r
        # tools definitions\r
        ToolsDef = []\r
        IncPrefix = self._INC_FLAG_[self._AutoGenObject.ToolChainFamily]\r
        for Tool in self._AutoGenObject.BuildOption:\r
            for Attr in self._AutoGenObject.BuildOption[Tool]:\r
                Value = self._AutoGenObject.BuildOption[Tool][Attr]\r
                if Attr == "FAMILY":\r
                    continue\r
                elif Attr == "PATH":\r
                    ToolsDef.append("%s = %s" % (Tool, Value))\r
                else:\r
                    # Don't generate MAKE_FLAGS in makefile. It's put in environment variable.\r
                    if Tool == "MAKE":\r
                        continue\r
                    # Remove duplicated include path, if any\r
                    if Attr == "FLAGS":\r
                        Value = RemoveDupOption(Value, IncPrefix, self._AutoGenObject.IncludePathList)\r
                    ToolsDef.append("%s_%s = %s" % (Tool, Attr, Value))\r
            ToolsDef.append("")\r
\r
        # convert source files and binary files to build targets\r
        self.ResultFileList = [str(T.Target) for T in self._AutoGenObject.CodaTargetList]\r
        if len(self.ResultFileList) == 0 and len(self._AutoGenObject.SourceFileList) <> 0:        \r
            EdkLogger.error("build", AUTOGEN_ERROR, "Nothing to build",\r
                            ExtraData="[%s]" % str(self._AutoGenObject))\r
\r
        self.ProcessBuildTargetList()\r
\r
        # Generate macros used to represent input files\r
        FileMacroList = [] # macro name = file list\r
        for FileListMacro in self.FileListMacros:\r
            FileMacro = self._FILE_MACRO_TEMPLATE.Replace(\r
                                                    {\r
                                                        "macro_name"  : FileListMacro,\r
                                                        "source_file" : self.FileListMacros[FileListMacro]\r
                                                    }\r
                                                    )\r
            FileMacroList.append(FileMacro)\r
\r
        # INC_LIST is special\r
        FileMacro = ""\r
        IncludePathList = []\r
        for P in  self._AutoGenObject.IncludePathList:\r
            IncludePathList.append(IncPrefix+self.PlaceMacro(P, self.Macros))\r
            if FileBuildRule.INC_LIST_MACRO in self.ListFileMacros:\r
                self.ListFileMacros[FileBuildRule.INC_LIST_MACRO].append(IncPrefix+P)\r
        FileMacro += self._FILE_MACRO_TEMPLATE.Replace(\r
                                                {\r
                                                    "macro_name"   : "INC",\r
                                                    "source_file" : IncludePathList\r
                                                }\r
                                                )\r
        FileMacroList.append(FileMacro)\r
\r
        # Generate macros used to represent files containing list of input files\r
        for ListFileMacro in self.ListFileMacros:\r
            ListFileName = os.path.join(self._AutoGenObject.OutputDir, "%s.lst" % ListFileMacro.lower()[:len(ListFileMacro)-5])\r
            FileMacroList.append("%s = %s" % (ListFileMacro, ListFileName))\r
            SaveFileOnChange(\r
                ListFileName,\r
                "\n".join(self.ListFileMacros[ListFileMacro]),\r
                False\r
                )\r
\r
        # Edk modules need <BaseName>StrDefs.h for string ID\r
        #if self._AutoGenObject.AutoGenVersion < 0x00010005 and len(self._AutoGenObject.UnicodeFileList) > 0:\r
        #    BcTargetList = ['strdefs']\r
        #else:\r
        #    BcTargetList = []\r
        BcTargetList = []\r
\r
        MakefileName = self._FILE_NAME_[self._FileType]\r
        LibraryMakeCommandList = []\r
        for D in self.LibraryBuildDirectoryList:\r
            Command = self._MAKE_TEMPLATE_[self._FileType] % {"file":os.path.join(D, MakefileName)}\r
            LibraryMakeCommandList.append(Command)\r
\r
        package_rel_dir = self._AutoGenObject.SourceDir\r
        if os.sep in package_rel_dir:\r
            package_rel_dir = package_rel_dir[package_rel_dir.index(os.sep) + 1:]\r
\r
        MakefileTemplateDict = {\r
            "makefile_header"           : self._FILE_HEADER_[self._FileType],\r
            "makefile_path"             : os.path.join("$(MODULE_BUILD_DIR)", MakefileName),\r
            "makefile_name"             : MakefileName,\r
            "platform_name"             : self.PlatformInfo.Name,\r
            "platform_guid"             : self.PlatformInfo.Guid,\r
            "platform_version"          : self.PlatformInfo.Version,\r
            "platform_relative_directory": self.PlatformInfo.SourceDir,\r
            "platform_output_directory" : self.PlatformInfo.OutputDir,\r
\r
            "module_name"               : self._AutoGenObject.Name,\r
            "module_guid"               : self._AutoGenObject.Guid,\r
            "module_version"            : self._AutoGenObject.Version,\r
            "module_type"               : self._AutoGenObject.ModuleType,\r
            "module_file"               : self._AutoGenObject.MetaFile.Name,\r
            "module_file_base_name"     : self._AutoGenObject.MetaFile.BaseName,\r
            "module_relative_directory" : self._AutoGenObject.SourceDir,\r
            "package_relative_directory": package_rel_dir,\r
            "module_extra_defines"      : ["%s = %s" % (k, v) for k, v in self._AutoGenObject.Module.Defines.iteritems()],\r
\r
            "architecture"              : self._AutoGenObject.Arch,\r
            "toolchain_tag"             : self._AutoGenObject.ToolChain,\r
            "build_target"              : self._AutoGenObject.BuildTarget,\r
\r
            "platform_build_directory"  : self.PlatformInfo.BuildDir,\r
            "module_build_directory"    : self._AutoGenObject.BuildDir,\r
            "module_output_directory"   : self._AutoGenObject.OutputDir,\r
            "module_debug_directory"    : self._AutoGenObject.DebugDir,\r
\r
            "separator"                 : Separator,\r
            "module_tool_definitions"   : ToolsDef,\r
\r
            "shell_command_code"        : self._SHELL_CMD_[self._FileType].keys(),\r
            "shell_command"             : self._SHELL_CMD_[self._FileType].values(),\r
\r
            "module_entry_point"        : ModuleEntryPoint,\r
            "image_entry_point"         : ImageEntryPoint,\r
            "arch_entry_point"          : ArchEntryPoint,\r
            "remaining_build_target"    : self.ResultFileList,\r
            "common_dependency_file"    : self.CommonFileDependency,\r
            "create_directory_command"  : self.GetCreateDirectoryCommand(self.IntermediateDirectoryList),\r
            "clean_command"             : self.GetRemoveDirectoryCommand(["$(OUTPUT_DIR)"]),\r
            "cleanall_command"          : self.GetRemoveDirectoryCommand(["$(DEBUG_DIR)", "$(OUTPUT_DIR)"]),\r
            "dependent_library_build_directory" : self.LibraryBuildDirectoryList,\r
            "library_build_command"     : LibraryMakeCommandList,\r
            "file_macro"                : FileMacroList,\r
            "file_build_target"         : self.BuildTargetList,\r
            "backward_compatible_target": BcTargetList,\r
        }\r
\r
        return MakefileTemplateDict\r
\r
    def ProcessBuildTargetList(self):\r
        #\r
        # Search dependency file list for each source file\r
        #\r
        ForceIncludedFile = []\r
        for File in self._AutoGenObject.AutoGenFileList:\r
            if File.Ext == '.h':\r
                ForceIncludedFile.append(File)\r
        SourceFileList = []\r
        for Target in self._AutoGenObject.IntroTargetList:\r
            SourceFileList.extend(Target.Inputs)\r
\r
        self.FileDependency = self.GetFileDependency(\r
                                    SourceFileList,\r
                                    ForceIncludedFile,\r
                                    self._AutoGenObject.IncludePathList + self._AutoGenObject.BuildOptionIncPathList\r
                                    )\r
        DepSet = None\r
        for File in self.FileDependency:\r
            if not self.FileDependency[File]:\r
                self.FileDependency[File] = ['$(FORCE_REBUILD)']\r
                continue\r
            # skip non-C files\r
            if File.Ext not in [".c", ".C"] or File.Name == "AutoGen.c":\r
                continue\r
            elif DepSet == None:\r
                DepSet = set(self.FileDependency[File])\r
            else:\r
                DepSet &= set(self.FileDependency[File])\r
        # in case nothing in SourceFileList\r
        if DepSet == None:\r
            DepSet = set()\r
        #\r
        # Extract common files list in the dependency files\r
        #\r
        for File in DepSet:\r
            self.CommonFileDependency.append(self.PlaceMacro(File.Path, self.Macros))\r
\r
        for File in self.FileDependency:\r
            # skip non-C files\r
            if File.Ext not in [".c", ".C"] or File.Name == "AutoGen.c":\r
                continue\r
            NewDepSet = set(self.FileDependency[File])\r
            NewDepSet -= DepSet\r
            self.FileDependency[File] = ["$(COMMON_DEPS)"] + list(NewDepSet)\r
\r
        # Convert target description object to target string in makefile\r
        for Type in self._AutoGenObject.Targets:\r
            for T in self._AutoGenObject.Targets[Type]:\r
                # Generate related macros if needed\r
                if T.GenFileListMacro and T.FileListMacro not in self.FileListMacros:\r
                    self.FileListMacros[T.FileListMacro] = []\r
                if T.GenListFile and T.ListFileMacro not in self.ListFileMacros:\r
                    self.ListFileMacros[T.ListFileMacro] = []\r
                if T.GenIncListFile and T.IncListFileMacro not in self.ListFileMacros:\r
                    self.ListFileMacros[T.IncListFileMacro] = []\r
\r
                Deps = []\r
                # Add force-dependencies\r
                for Dep in T.Dependencies:\r
                    Deps.append(self.PlaceMacro(str(Dep), self.Macros))\r
                # Add inclusion-dependencies\r
                if len(T.Inputs) == 1 and T.Inputs[0] in self.FileDependency:\r
                    for F in self.FileDependency[T.Inputs[0]]:\r
                        Deps.append(self.PlaceMacro(str(F), self.Macros))\r
                # Add source-dependencies\r
                for F in T.Inputs:\r
                    NewFile = self.PlaceMacro(str(F), self.Macros)\r
                    # In order to use file list macro as dependency\r
                    if T.GenListFile:\r
                        self.ListFileMacros[T.ListFileMacro].append(str(F))\r
                        self.FileListMacros[T.FileListMacro].append(NewFile)\r
                    elif T.GenFileListMacro:\r
                        self.FileListMacros[T.FileListMacro].append(NewFile)\r
                    else:\r
                        Deps.append(NewFile)\r
\r
                # Use file list macro as dependency\r
                if T.GenFileListMacro:\r
                    Deps.append("$(%s)" % T.FileListMacro)\r
\r
                TargetDict = {\r
                    "target"    :   self.PlaceMacro(T.Target.Path, self.Macros),\r
                    "cmd"       :   "\n\t".join(T.Commands),\r
                    "deps"      :   Deps\r
                }\r
                self.BuildTargetList.append(self._BUILD_TARGET_TEMPLATE.Replace(TargetDict))\r
\r
    ## For creating makefile targets for dependent libraries\r
    def ProcessDependentLibrary(self):\r
        for LibraryAutoGen in self._AutoGenObject.LibraryAutoGenList:\r
            self.LibraryBuildDirectoryList.append(self.PlaceMacro(LibraryAutoGen.BuildDir, self.Macros))\r
\r
    ## Return a list containing source file's dependencies\r
    #\r
    #   @param      FileList        The list of source files\r
    #   @param      ForceInculeList The list of files which will be included forcely\r
    #   @param      SearchPathList  The list of search path\r
    #\r
    #   @retval     dict            The mapping between source file path and its dependencies\r
    #\r
    def GetFileDependency(self, FileList, ForceInculeList, SearchPathList):\r
        Dependency = {}\r
        for F in FileList:\r
            Dependency[F] = self.GetDependencyList(F, ForceInculeList, SearchPathList)\r
        return Dependency\r
\r
    ## Find dependencies for one source file\r
    #\r
    #  By searching recursively "#include" directive in file, find out all the\r
    #  files needed by given source file. The dependecies will be only searched\r
    #  in given search path list.\r
    #\r
    #   @param      File            The source file\r
    #   @param      ForceInculeList The list of files which will be included forcely\r
    #   @param      SearchPathList  The list of search path\r
    #\r
    #   @retval     list            The list of files the given source file depends on\r
    #\r
    def GetDependencyList(self, File, ForceList, SearchPathList):\r
        EdkLogger.debug(EdkLogger.DEBUG_1, "Try to get dependency files for %s" % File)\r
        FileStack = [File] + ForceList\r
        DependencySet = set()\r
\r
        if self._AutoGenObject.Arch not in gDependencyDatabase:\r
            gDependencyDatabase[self._AutoGenObject.Arch] = {}\r
        DepDb = gDependencyDatabase[self._AutoGenObject.Arch]\r
\r
        while len(FileStack) > 0:\r
            F = FileStack.pop()\r
\r
            FullPathDependList = []\r
            if F in self.FileCache:\r
                for CacheFile in self.FileCache[F]:\r
                    FullPathDependList.append(CacheFile)\r
                    if CacheFile not in DependencySet:\r
                        FileStack.append(CacheFile)\r
                DependencySet.update(FullPathDependList)\r
                continue\r
\r
            CurrentFileDependencyList = []\r
            if F in DepDb:\r
                CurrentFileDependencyList = DepDb[F]\r
            else:\r
                try:\r
                    Fd = open(F.Path, 'r')\r
                except BaseException, X:\r
                    EdkLogger.error("build", FILE_OPEN_FAILURE, ExtraData=F.Path+"\n\t"+str(X))\r
\r
                FileContent = Fd.read()\r
                Fd.close()\r
                if len(FileContent) == 0:\r
                    continue\r
\r
                if FileContent[0] == 0xff or FileContent[0] == 0xfe:\r
                    FileContent = unicode(FileContent, "utf-16")\r
                IncludedFileList = gIncludePattern.findall(FileContent)\r
\r
                for Inc in IncludedFileList:\r
                    Inc = Inc.strip()\r
                    # if there's macro used to reference header file, expand it\r
                    HeaderList = gMacroPattern.findall(Inc)\r
                    if len(HeaderList) == 1 and len(HeaderList[0]) == 2:\r
                        HeaderType = HeaderList[0][0]\r
                        HeaderKey = HeaderList[0][1]\r
                        if HeaderType in gIncludeMacroConversion:\r
                            Inc = gIncludeMacroConversion[HeaderType] % {"HeaderKey" : HeaderKey}\r
                        else:\r
                            # not known macro used in #include, always build the file by\r
                            # returning a empty dependency\r
                            self.FileCache[File] = []\r
                            return []\r
                    Inc = os.path.normpath(Inc)\r
                    CurrentFileDependencyList.append(Inc)\r
                DepDb[F] = CurrentFileDependencyList\r
\r
            CurrentFilePath = F.Dir\r
            PathList = [CurrentFilePath] + SearchPathList\r
            for Inc in CurrentFileDependencyList:\r
                for SearchPath in PathList:\r
                    FilePath = os.path.join(SearchPath, Inc)\r
                    if FilePath in gIsFileMap:\r
                        if not gIsFileMap[FilePath]:\r
                            continue\r
                    # If isfile is called too many times, the performance is slow down.\r
                    elif not os.path.isfile(FilePath):\r
                        gIsFileMap[FilePath] = False\r
                        continue\r
                    else:\r
                        gIsFileMap[FilePath] = True\r
                    FilePath = PathClass(FilePath)\r
                    FullPathDependList.append(FilePath)\r
                    if FilePath not in DependencySet:\r
                        FileStack.append(FilePath)\r
                    break\r
                else:\r
                    EdkLogger.debug(EdkLogger.DEBUG_9, "%s included by %s was not found "\\r
                                    "in any given path:\n\t%s" % (Inc, F, "\n\t".join(SearchPathList)))\r
\r
            self.FileCache[F] = FullPathDependList\r
            DependencySet.update(FullPathDependList)\r
\r
        DependencySet.update(ForceList)\r
        if File in DependencySet:\r
            DependencySet.remove(File)\r
        DependencyList = list(DependencySet)  # remove duplicate ones\r
\r
        return DependencyList\r
\r
    _TemplateDict = property(_CreateTemplateDict)\r
\r
## CustomMakefile class\r
#\r
#  This class encapsules makefie and its generation for module. It uses template to generate\r
#  the content of makefile. The content of makefile will be got from ModuleAutoGen object.\r
#\r
class CustomMakefile(BuildFile):\r
    ## template used to generate the makefile for module with custom makefile\r
    _TEMPLATE_ = TemplateString('''\\r
${makefile_header}\r
\r
#\r
# Platform Macro Definition\r
#\r
PLATFORM_NAME = ${platform_name}\r
PLATFORM_GUID = ${platform_guid}\r
PLATFORM_VERSION = ${platform_version}\r
PLATFORM_RELATIVE_DIR = ${platform_relative_directory}\r
PLATFORM_DIR = $(WORKSPACE)${separator}${platform_relative_directory}\r
PLATFORM_OUTPUT_DIR = ${platform_output_directory}\r
\r
#\r
# Module Macro Definition\r
#\r
MODULE_NAME = ${module_name}\r
MODULE_GUID = ${module_guid}\r
MODULE_VERSION = ${module_version}\r
MODULE_TYPE = ${module_type}\r
MODULE_FILE = ${module_file}\r
MODULE_FILE_BASE_NAME = ${module_file_base_name}\r
BASE_NAME = $(MODULE_NAME)\r
MODULE_RELATIVE_DIR = ${module_relative_directory}\r
MODULE_DIR = $(WORKSPACE)${separator}${module_relative_directory}\r
\r
#\r
# Build Configuration Macro Definition\r
#\r
ARCH = ${architecture}\r
TOOLCHAIN = ${toolchain_tag}\r
TOOLCHAIN_TAG = ${toolchain_tag}\r
TARGET = ${build_target}\r
\r
#\r
# Build Directory Macro Definition\r
#\r
# PLATFORM_BUILD_DIR = ${platform_build_directory}\r
BUILD_DIR = ${platform_build_directory}\r
BIN_DIR = $(BUILD_DIR)${separator}${architecture}\r
LIB_DIR = $(BIN_DIR)\r
MODULE_BUILD_DIR = ${module_build_directory}\r
OUTPUT_DIR = ${module_output_directory}\r
DEBUG_DIR = ${module_debug_directory}\r
DEST_DIR_OUTPUT = $(OUTPUT_DIR)\r
DEST_DIR_DEBUG = $(DEBUG_DIR)\r
\r
#\r
# Tools definitions specific to this module\r
#\r
${BEGIN}${module_tool_definitions}\r
${END}\r
MAKE_FILE = ${makefile_path}\r
\r
#\r
# Shell Command Macro\r
#\r
${BEGIN}${shell_command_code} = ${shell_command}\r
${END}\r
\r
${custom_makefile_content}\r
\r
#\r
# Target used when called from platform makefile, which will bypass the build of dependent libraries\r
#\r
\r
pbuild: init all\r
\r
\r
#\r
# ModuleTarget\r
#\r
\r
mbuild: init all\r
\r
#\r
# Build Target used in multi-thread build mode, which no init target is needed\r
#\r
\r
tbuild: all\r
\r
#\r
# Initialization target: print build information and create necessary directories\r
#\r
init:\r
\t-@echo Building ... $(MODULE_DIR)${separator}$(MODULE_FILE) [$(ARCH)]\r
${BEGIN}\t-@${create_directory_command}\n${END}\\r
\r
''')\r
\r
    ## Constructor of CustomMakefile\r
    #\r
    #   @param  ModuleAutoGen   Object of ModuleAutoGen class\r
    #\r
    def __init__(self, ModuleAutoGen):\r
        BuildFile.__init__(self, ModuleAutoGen)\r
        self.PlatformInfo = self._AutoGenObject.PlatformInfo\r
        self.IntermediateDirectoryList = ["$(DEBUG_DIR)", "$(OUTPUT_DIR)"]\r
\r
    # Compose a dict object containing information used to do replacement in template\r
    def _CreateTemplateDict(self):\r
        Separator = self._SEP_[self._FileType]\r
        if self._FileType not in self._AutoGenObject.CustomMakefile:\r
            EdkLogger.error('build', OPTION_NOT_SUPPORTED, "No custom makefile for %s" % self._FileType,\r
                            ExtraData="[%s]" % str(self._AutoGenObject))\r
        MakefilePath = os.path.join(\r
                                self._AutoGenObject.WorkspaceDir,\r
                                self._AutoGenObject.CustomMakefile[self._FileType]\r
                                )\r
        try:\r
            CustomMakefile = open(MakefilePath, 'r').read()\r
        except:\r
            EdkLogger.error('build', FILE_OPEN_FAILURE, File=str(self._AutoGenObject),\r
                            ExtraData=self._AutoGenObject.CustomMakefile[self._FileType])\r
\r
        # tools definitions\r
        ToolsDef = []\r
        for Tool in self._AutoGenObject.BuildOption:\r
            # Don't generate MAKE_FLAGS in makefile. It's put in environment variable.\r
            if Tool == "MAKE":\r
                continue\r
            for Attr in self._AutoGenObject.BuildOption[Tool]:\r
                if Attr == "FAMILY":\r
                    continue\r
                elif Attr == "PATH":\r
                    ToolsDef.append("%s = %s" % (Tool, self._AutoGenObject.BuildOption[Tool][Attr]))\r
                else:\r
                    ToolsDef.append("%s_%s = %s" % (Tool, Attr, self._AutoGenObject.BuildOption[Tool][Attr]))\r
            ToolsDef.append("")\r
\r
        MakefileName = self._FILE_NAME_[self._FileType]\r
        MakefileTemplateDict = {\r
            "makefile_header"           : self._FILE_HEADER_[self._FileType],\r
            "makefile_path"             : os.path.join("$(MODULE_BUILD_DIR)", MakefileName),\r
            "platform_name"             : self.PlatformInfo.Name,\r
            "platform_guid"             : self.PlatformInfo.Guid,\r
            "platform_version"          : self.PlatformInfo.Version,\r
            "platform_relative_directory": self.PlatformInfo.SourceDir,\r
            "platform_output_directory" : self.PlatformInfo.OutputDir,\r
\r
            "module_name"               : self._AutoGenObject.Name,\r
            "module_guid"               : self._AutoGenObject.Guid,\r
            "module_version"            : self._AutoGenObject.Version,\r
            "module_type"               : self._AutoGenObject.ModuleType,\r
            "module_file"               : self._AutoGenObject.MetaFile,\r
            "module_file_base_name"     : self._AutoGenObject.MetaFile.BaseName,\r
            "module_relative_directory" : self._AutoGenObject.SourceDir,\r
\r
            "architecture"              : self._AutoGenObject.Arch,\r
            "toolchain_tag"             : self._AutoGenObject.ToolChain,\r
            "build_target"              : self._AutoGenObject.BuildTarget,\r
\r
            "platform_build_directory"  : self.PlatformInfo.BuildDir,\r
            "module_build_directory"    : self._AutoGenObject.BuildDir,\r
            "module_output_directory"   : self._AutoGenObject.OutputDir,\r
            "module_debug_directory"    : self._AutoGenObject.DebugDir,\r
\r
            "separator"                 : Separator,\r
            "module_tool_definitions"   : ToolsDef,\r
\r
            "shell_command_code"        : self._SHELL_CMD_[self._FileType].keys(),\r
            "shell_command"             : self._SHELL_CMD_[self._FileType].values(),\r
\r
            "create_directory_command"  : self.GetCreateDirectoryCommand(self.IntermediateDirectoryList),\r
            "custom_makefile_content"   : CustomMakefile\r
        }\r
\r
        return MakefileTemplateDict\r
\r
    _TemplateDict = property(_CreateTemplateDict)\r
\r
## PlatformMakefile class\r
#\r
#  This class encapsules makefie and its generation for platform. It uses\r
# template to generate the content of makefile. The content of makefile will be\r
# got from PlatformAutoGen object.\r
#\r
class PlatformMakefile(BuildFile):\r
    ## template used to generate the makefile for platform\r
    _TEMPLATE_ = TemplateString('''\\r
${makefile_header}\r
\r
#\r
# Platform Macro Definition\r
#\r
PLATFORM_NAME = ${platform_name}\r
PLATFORM_GUID = ${platform_guid}\r
PLATFORM_VERSION = ${platform_version}\r
PLATFORM_FILE = ${platform_file}\r
PLATFORM_DIR = $(WORKSPACE)${separator}${platform_relative_directory}\r
PLATFORM_OUTPUT_DIR = ${platform_output_directory}\r
\r
#\r
# Build Configuration Macro Definition\r
#\r
TOOLCHAIN = ${toolchain_tag}\r
TOOLCHAIN_TAG = ${toolchain_tag}\r
TARGET = ${build_target}\r
\r
#\r
# Build Directory Macro Definition\r
#\r
BUILD_DIR = ${platform_build_directory}\r
FV_DIR = ${platform_build_directory}${separator}FV\r
\r
#\r
# Shell Command Macro\r
#\r
${BEGIN}${shell_command_code} = ${shell_command}\r
${END}\r
\r
MAKE = ${make_path}\r
MAKE_FILE = ${makefile_path}\r
\r
#\r
# Default target\r
#\r
all: init build_libraries build_modules\r
\r
#\r
# Initialization target: print build information and create necessary directories\r
#\r
init:\r
\t-@echo Building ... $(PLATFORM_FILE) [${build_architecture_list}]\r
\t${BEGIN}-@${create_directory_command}\r
\t${END}\r
#\r
# library build target\r
#\r
libraries: init build_libraries\r
\r
#\r
# module build target\r
#\r
modules: init build_libraries build_modules\r
\r
#\r
# Build all libraries:\r
#\r
build_libraries:\r
${BEGIN}\t@"$(MAKE)" $(MAKE_FLAGS) -f ${library_makefile_list} pbuild\r
${END}\t@cd $(BUILD_DIR)\r
\r
#\r
# Build all modules:\r
#\r
build_modules:\r
${BEGIN}\t@"$(MAKE)" $(MAKE_FLAGS) -f ${module_makefile_list} pbuild\r
${END}\t@cd $(BUILD_DIR)\r
\r
#\r
# Clean intermediate files\r
#\r
clean:\r
\t${BEGIN}-@${library_build_command} clean\r
\t${END}${BEGIN}-@${module_build_command} clean\r
\t${END}@cd $(BUILD_DIR)\r
\r
#\r
# Clean all generated files except to makefile\r
#\r
cleanall:\r
${BEGIN}\t${cleanall_command}\r
${END}\r
\r
#\r
# Clean all library files\r
#\r
cleanlib:\r
\t${BEGIN}-@${library_build_command} cleanall\r
\t${END}@cd $(BUILD_DIR)\n\r
''')\r
\r
    ## Constructor of PlatformMakefile\r
    #\r
    #   @param  ModuleAutoGen   Object of PlatformAutoGen class\r
    #\r
    def __init__(self, PlatformAutoGen):\r
        BuildFile.__init__(self, PlatformAutoGen)\r
        self.ModuleBuildCommandList = []\r
        self.ModuleMakefileList = []\r
        self.IntermediateDirectoryList = []\r
        self.ModuleBuildDirectoryList = []\r
        self.LibraryBuildDirectoryList = []\r
        self.LibraryMakeCommandList = []\r
\r
    # Compose a dict object containing information used to do replacement in template\r
    def _CreateTemplateDict(self):\r
        Separator = self._SEP_[self._FileType]\r
\r
        PlatformInfo = self._AutoGenObject\r
        if "MAKE" not in PlatformInfo.ToolDefinition or "PATH" not in PlatformInfo.ToolDefinition["MAKE"]:\r
            EdkLogger.error("build", OPTION_MISSING, "No MAKE command defined. Please check your tools_def.txt!",\r
                            ExtraData="[%s]" % str(self._AutoGenObject))\r
\r
        self.IntermediateDirectoryList = ["$(BUILD_DIR)"]\r
        self.ModuleBuildDirectoryList = self.GetModuleBuildDirectoryList()\r
        self.LibraryBuildDirectoryList = self.GetLibraryBuildDirectoryList()\r
\r
        MakefileName = self._FILE_NAME_[self._FileType]\r
        LibraryMakefileList = []\r
        LibraryMakeCommandList = []\r
        for D in self.LibraryBuildDirectoryList:\r
            D = self.PlaceMacro(D, {"BUILD_DIR":PlatformInfo.BuildDir})\r
            Makefile = os.path.join(D, MakefileName)\r
            Command = self._MAKE_TEMPLATE_[self._FileType] % {"file":Makefile}\r
            LibraryMakefileList.append(Makefile)\r
            LibraryMakeCommandList.append(Command)\r
        self.LibraryMakeCommandList = LibraryMakeCommandList\r
\r
        ModuleMakefileList = []\r
        ModuleMakeCommandList = []\r
        for D in self.ModuleBuildDirectoryList:\r
            D = self.PlaceMacro(D, {"BUILD_DIR":PlatformInfo.BuildDir})\r
            Makefile = os.path.join(D, MakefileName)\r
            Command = self._MAKE_TEMPLATE_[self._FileType] % {"file":Makefile}\r
            ModuleMakefileList.append(Makefile)\r
            ModuleMakeCommandList.append(Command)\r
\r
        MakefileTemplateDict = {\r
            "makefile_header"           : self._FILE_HEADER_[self._FileType],\r
            "makefile_path"             : os.path.join("$(BUILD_DIR)", MakefileName),\r
            "make_path"                 : PlatformInfo.ToolDefinition["MAKE"]["PATH"],\r
            "makefile_name"             : MakefileName,\r
            "platform_name"             : PlatformInfo.Name,\r
            "platform_guid"             : PlatformInfo.Guid,\r
            "platform_version"          : PlatformInfo.Version,\r
            "platform_file"             : self._AutoGenObject.MetaFile,\r
            "platform_relative_directory": PlatformInfo.SourceDir,\r
            "platform_output_directory" : PlatformInfo.OutputDir,\r
            "platform_build_directory"  : PlatformInfo.BuildDir,\r
\r
            "toolchain_tag"             : PlatformInfo.ToolChain,\r
            "build_target"              : PlatformInfo.BuildTarget,\r
            "shell_command_code"        : self._SHELL_CMD_[self._FileType].keys(),\r
            "shell_command"             : self._SHELL_CMD_[self._FileType].values(),\r
            "build_architecture_list"   : self._AutoGenObject.Arch,\r
            "architecture"              : self._AutoGenObject.Arch,\r
            "separator"                 : Separator,\r
            "create_directory_command"  : self.GetCreateDirectoryCommand(self.IntermediateDirectoryList),\r
            "cleanall_command"          : self.GetRemoveDirectoryCommand(self.IntermediateDirectoryList),\r
            "library_makefile_list"     : LibraryMakefileList,\r
            "module_makefile_list"      : ModuleMakefileList,\r
            "library_build_command"     : LibraryMakeCommandList,\r
            "module_build_command"      : ModuleMakeCommandList,\r
        }\r
\r
        return MakefileTemplateDict\r
\r
    ## Get the root directory list for intermediate files of all modules build\r
    #\r
    #   @retval     list    The list of directory\r
    #\r
    def GetModuleBuildDirectoryList(self):\r
        DirList = []\r
        for ModuleAutoGen in self._AutoGenObject.ModuleAutoGenList:\r
            if not ModuleAutoGen.IsBinaryModule:\r
                DirList.append(os.path.join(self._AutoGenObject.BuildDir, ModuleAutoGen.BuildDir))\r
        return DirList\r
\r
    ## Get the root directory list for intermediate files of all libraries build\r
    #\r
    #   @retval     list    The list of directory\r
    #\r
    def GetLibraryBuildDirectoryList(self):\r
        DirList = []\r
        for LibraryAutoGen in self._AutoGenObject.LibraryAutoGenList:\r
            if not LibraryAutoGen.IsBinaryModule:\r
                DirList.append(os.path.join(self._AutoGenObject.BuildDir, LibraryAutoGen.BuildDir))\r
        return DirList\r
\r
    _TemplateDict = property(_CreateTemplateDict)\r
\r
## TopLevelMakefile class\r
#\r
#  This class encapsules makefie and its generation for entrance makefile. It\r
# uses template to generate the content of makefile. The content of makefile\r
# will be got from WorkspaceAutoGen object.\r
#\r
class TopLevelMakefile(BuildFile):\r
    ## template used to generate toplevel makefile\r
    _TEMPLATE_ = TemplateString('''${BEGIN}\tGenFds -f ${fdf_file} --conf=${conf_directory} -o ${platform_build_directory} -t ${toolchain_tag} -b ${build_target} -p ${active_platform} -a ${build_architecture_list} ${extra_options}${END}${BEGIN} -r ${fd} ${END}${BEGIN} -i ${fv} ${END}${BEGIN} -C ${cap} ${END}${BEGIN} -D ${macro} ${END}''')\r
\r
    ## Constructor of TopLevelMakefile\r
    #\r
    #   @param  Workspace   Object of WorkspaceAutoGen class\r
    #\r
    def __init__(self, Workspace):\r
        BuildFile.__init__(self, Workspace)\r
        self.IntermediateDirectoryList = []\r
\r
    # Compose a dict object containing information used to do replacement in template\r
    def _CreateTemplateDict(self):\r
        Separator = self._SEP_[self._FileType]\r
\r
        # any platform autogen object is ok because we just need common information\r
        PlatformInfo = self._AutoGenObject\r
\r
        if "MAKE" not in PlatformInfo.ToolDefinition or "PATH" not in PlatformInfo.ToolDefinition["MAKE"]:\r
            EdkLogger.error("build", OPTION_MISSING, "No MAKE command defined. Please check your tools_def.txt!",\r
                            ExtraData="[%s]" % str(self._AutoGenObject))\r
\r
        for Arch in PlatformInfo.ArchList:\r
            self.IntermediateDirectoryList.append(Separator.join(["$(BUILD_DIR)", Arch]))\r
        self.IntermediateDirectoryList.append("$(FV_DIR)")\r
\r
        # TRICK: for not generating GenFds call in makefile if no FDF file\r
        MacroList = []\r
        if PlatformInfo.FdfFile != None and PlatformInfo.FdfFile != "":\r
            FdfFileList = [PlatformInfo.FdfFile]\r
            # macros passed to GenFds\r
            MacroList.append('"%s=%s"' % ("EFI_SOURCE", GlobalData.gEfiSource.replace('\\', '\\\\')))\r
            MacroList.append('"%s=%s"' % ("EDK_SOURCE", GlobalData.gEdkSource.replace('\\', '\\\\')))\r
            MacroDict = {}\r
            MacroDict.update(GlobalData.gGlobalDefines)\r
            MacroDict.update(GlobalData.gCommandLineDefines)\r
            MacroDict.pop("EFI_SOURCE", "dummy")\r
            MacroDict.pop("EDK_SOURCE", "dummy")\r
            for MacroName in MacroDict:\r
                if MacroDict[MacroName] != "":\r
                    MacroList.append('"%s=%s"' % (MacroName, MacroDict[MacroName].replace('\\', '\\\\')))\r
                else:\r
                    MacroList.append('"%s"' % MacroName)\r
        else:\r
            FdfFileList = []\r
\r
        # pass extra common options to external program called in makefile, currently GenFds.exe\r
        ExtraOption = ''\r
        LogLevel = EdkLogger.GetLevel()\r
        if LogLevel == EdkLogger.VERBOSE:\r
            ExtraOption += " -v"\r
        elif LogLevel <= EdkLogger.DEBUG_9:\r
            ExtraOption += " -d %d" % (LogLevel - 1)\r
        elif LogLevel == EdkLogger.QUIET:\r
            ExtraOption += " -q"\r
\r
        if GlobalData.gCaseInsensitive:\r
            ExtraOption += " -c"\r
\r
        if GlobalData.gIgnoreSource:\r
            ExtraOption += " --ignore-sources"\r
\r
        MakefileName = self._FILE_NAME_[self._FileType]\r
        SubBuildCommandList = []\r
        for A in PlatformInfo.ArchList:\r
            Command = self._MAKE_TEMPLATE_[self._FileType] % {"file":os.path.join("$(BUILD_DIR)", A, MakefileName)}\r
            SubBuildCommandList.append(Command)\r
\r
        MakefileTemplateDict = {\r
            "makefile_header"           : self._FILE_HEADER_[self._FileType],\r
            "makefile_path"             : os.path.join("$(BUILD_DIR)", MakefileName),\r
            "make_path"                 : PlatformInfo.ToolDefinition["MAKE"]["PATH"],\r
            "platform_name"             : PlatformInfo.Name,\r
            "platform_guid"             : PlatformInfo.Guid,\r
            "platform_version"          : PlatformInfo.Version,\r
            "platform_build_directory"  : PlatformInfo.BuildDir,\r
            "conf_directory"            : GlobalData.gConfDirectory,\r
\r
            "toolchain_tag"             : PlatformInfo.ToolChain,\r
            "build_target"              : PlatformInfo.BuildTarget,\r
            "shell_command_code"        : self._SHELL_CMD_[self._FileType].keys(),\r
            "shell_command"             : self._SHELL_CMD_[self._FileType].values(),\r
            'arch'                      : list(PlatformInfo.ArchList),\r
            "build_architecture_list"   : ','.join(PlatformInfo.ArchList),\r
            "separator"                 : Separator,\r
            "create_directory_command"  : self.GetCreateDirectoryCommand(self.IntermediateDirectoryList),\r
            "cleanall_command"          : self.GetRemoveDirectoryCommand(self.IntermediateDirectoryList),\r
            "sub_build_command"         : SubBuildCommandList,\r
            "fdf_file"                  : FdfFileList,\r
            "active_platform"           : str(PlatformInfo),\r
            "fd"                        : PlatformInfo.FdTargetList,\r
            "fv"                        : PlatformInfo.FvTargetList,\r
            "cap"                       : PlatformInfo.CapTargetList,\r
            "extra_options"             : ExtraOption,\r
            "macro"                     : MacroList,\r
        }\r
\r
        return MakefileTemplateDict\r
\r
    ## Get the root directory list for intermediate files of all modules build\r
    #\r
    #   @retval     list    The list of directory\r
    #\r
    def GetModuleBuildDirectoryList(self):\r
        DirList = []\r
        for ModuleAutoGen in self._AutoGenObject.ModuleAutoGenList:\r
            if not ModuleAutoGen.IsBinaryModule:\r
                DirList.append(os.path.join(self._AutoGenObject.BuildDir, ModuleAutoGen.BuildDir))\r
        return DirList\r
\r
    ## Get the root directory list for intermediate files of all libraries build\r
    #\r
    #   @retval     list    The list of directory\r
    #\r
    def GetLibraryBuildDirectoryList(self):\r
        DirList = []\r
        for LibraryAutoGen in self._AutoGenObject.LibraryAutoGenList:\r
            if not LibraryAutoGen.IsBinaryModule:\r
                DirList.append(os.path.join(self._AutoGenObject.BuildDir, LibraryAutoGen.BuildDir))\r
        return DirList\r
\r
    _TemplateDict = property(_CreateTemplateDict)\r
\r
# This acts like the main() function for the script, unless it is 'import'ed into another script.\r
if __name__ == '__main__':\r
    pass\r
\r