BaseTools/Source/Python/AutoGen/GenMake.py

   1 ## @file
   2 # Create makefile for MS nmake and GNU make
   3 #
   4 # Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>
   5 # SPDX-License-Identifier: BSD-2-Clause-Patent
   6 #
   7
   8 ## Import Modules
   9 #
  10 from __future__ import absolute_import
  11 import Common.LongFilePathOs as os
  12 import sys
  13 import string
  14 import re
  15 import os.path as path
  16 from Common.LongFilePathSupport import OpenLongFilePath as open
  17 from Common.MultipleWorkspace import MultipleWorkspace as mws
  18 from Common.BuildToolError import *
  19 from Common.Misc import *
  20 from Common.StringUtils import *
  21 from .BuildEngine import *
  22 import Common.GlobalData as GlobalData
  23 from collections import OrderedDict
  24 from Common.DataType import TAB_COMPILER_MSFT
  25
  26 ## Regular expression for finding header file inclusions
  27 gIncludePattern = re.compile(r"^[ \t]*[#%]?[ \t]*include(?:[ \t]*(?:\\(?:\r\n|\r|\n))*[ \t]*)*(?:\(?[\"<]?[ \t]*)([-\w.\\/() \t]+)(?:[ \t]*[\">]?\)?)", re.MULTILINE | re.UNICODE | re.IGNORECASE)
  28
  29 ## Regular expression for matching macro used in header file inclusion
  30 gMacroPattern = re.compile("([_A-Z][_A-Z0-9]*)[ \t]*\((.+)\)", re.UNICODE)
  31
  32 gIsFileMap = {}
  33
  34 ## pattern for include style in Edk.x code
  35 gProtocolDefinition = "Protocol/%(HeaderKey)s/%(HeaderKey)s.h"
  36 gGuidDefinition = "Guid/%(HeaderKey)s/%(HeaderKey)s.h"
  37 gArchProtocolDefinition = "ArchProtocol/%(HeaderKey)s/%(HeaderKey)s.h"
  38 gPpiDefinition = "Ppi/%(HeaderKey)s/%(HeaderKey)s.h"
  39 gIncludeMacroConversion = {
  40   "EFI_PROTOCOL_DEFINITION"         :   gProtocolDefinition,
  41   "EFI_GUID_DEFINITION"             :   gGuidDefinition,
  42   "EFI_ARCH_PROTOCOL_DEFINITION"    :   gArchProtocolDefinition,
  43   "EFI_PROTOCOL_PRODUCER"           :   gProtocolDefinition,
  44   "EFI_PROTOCOL_CONSUMER"           :   gProtocolDefinition,
  45   "EFI_PROTOCOL_DEPENDENCY"         :   gProtocolDefinition,
  46   "EFI_ARCH_PROTOCOL_PRODUCER"      :   gArchProtocolDefinition,
  47   "EFI_ARCH_PROTOCOL_CONSUMER"      :   gArchProtocolDefinition,
  48   "EFI_ARCH_PROTOCOL_DEPENDENCY"    :   gArchProtocolDefinition,
  49   "EFI_PPI_DEFINITION"              :   gPpiDefinition,
  50   "EFI_PPI_PRODUCER"                :   gPpiDefinition,
  51   "EFI_PPI_CONSUMER"                :   gPpiDefinition,
  52   "EFI_PPI_DEPENDENCY"              :   gPpiDefinition,
  53 }
  54
  55 ## default makefile type
  56 gMakeType = ""
  57 if sys.platform == "win32":
  58     gMakeType = "nmake"
  59 else:
  60     gMakeType = "gmake"
  61
  62
  63 ## BuildFile class
  64 #
  65 #  This base class encapsules build file and its generation. It uses template to generate
  66 #  the content of build file. The content of build file will be got from AutoGen objects.
  67 #
  68 class BuildFile(object):
  69     ## template used to generate the build file (i.e. makefile if using make)
  70     _TEMPLATE_ = TemplateString('')
  71
  72     _DEFAULT_FILE_NAME_ = "Makefile"
  73
  74     ## default file name for each type of build file
  75     _FILE_NAME_ = {
  76         "nmake" :   "Makefile",
  77         "gmake" :   "GNUmakefile"
  78     }
  79
  80     ## Fixed header string for makefile
  81     _MAKEFILE_HEADER = '''#
  82 # DO NOT EDIT
  83 # This file is auto-generated by build utility
  84 #
  85 # Module Name:
  86 #
  87 #   %s
  88 #
  89 # Abstract:
  90 #
  91 #   Auto-generated makefile for building modules, libraries or platform
  92 #
  93     '''
  94
  95     ## Header string for each type of build file
  96     _FILE_HEADER_ = {
  97         "nmake" :   _MAKEFILE_HEADER % _FILE_NAME_["nmake"],
  98         "gmake" :   _MAKEFILE_HEADER % _FILE_NAME_["gmake"]
  99     }
 100
 101     ## shell commands which can be used in build file in the form of macro
 102     #   $(CP)     copy file command
 103     #   $(MV)     move file command
 104     #   $(RM)     remove file command
 105     #   $(MD)     create dir command
 106     #   $(RD)     remove dir command
 107     #
 108     _SHELL_CMD_ = {
 109         "nmake" : {
 110             "CP"    :   "copy /y",
 111             "MV"    :   "move /y",
 112             "RM"    :   "del /f /q",
 113             "MD"    :   "mkdir",
 114             "RD"    :   "rmdir /s /q",
 115         },
 116
 117         "gmake" : {
 118             "CP"    :   "cp -f",
 119             "MV"    :   "mv -f",
 120             "RM"    :   "rm -f",
 121             "MD"    :   "mkdir -p",
 122             "RD"    :   "rm -r -f",
 123         }
 124     }
 125
 126     ## directory separator
 127     _SEP_ = {
 128         "nmake" :   "\\",
 129         "gmake" :   "/"
 130     }
 131
 132     ## directory creation template
 133     _MD_TEMPLATE_ = {
 134         "nmake" :   'if not exist %(dir)s $(MD) %(dir)s',
 135         "gmake" :   "$(MD) %(dir)s"
 136     }
 137
 138     ## directory removal template
 139     _RD_TEMPLATE_ = {
 140         "nmake" :   'if exist %(dir)s $(RD) %(dir)s',
 141         "gmake" :   "$(RD) %(dir)s"
 142     }
 143     ## cp if exist
 144     _CP_TEMPLATE_ = {
 145         "nmake" :   'if exist %(Src)s $(CP) %(Src)s %(Dst)s',
 146         "gmake" :   "test -f %(Src)s && $(CP) %(Src)s %(Dst)s"
 147     }
 148
 149     _CD_TEMPLATE_ = {
 150         "nmake" :   'if exist %(dir)s cd %(dir)s',
 151         "gmake" :   "test -e %(dir)s && cd %(dir)s"
 152     }
 153
 154     _MAKE_TEMPLATE_ = {
 155         "nmake" :   'if exist %(file)s "$(MAKE)" $(MAKE_FLAGS) -f %(file)s',
 156         "gmake" :   'test -e %(file)s && "$(MAKE)" $(MAKE_FLAGS) -f %(file)s'
 157     }
 158
 159     _INCLUDE_CMD_ = {
 160         "nmake" :   '!INCLUDE',
 161         "gmake" :   "include"
 162     }
 163
 164     _INC_FLAG_ = {TAB_COMPILER_MSFT : "/I", "GCC" : "-I", "INTEL" : "-I", "RVCT" : "-I", "NASM" : "-I"}
 165
 166     ## Constructor of BuildFile
 167     #
 168     #   @param  AutoGenObject   Object of AutoGen class
 169     #
 170     def __init__(self, AutoGenObject):
 171         self._AutoGenObject = AutoGenObject
 172         self._FileType = gMakeType
 173
 174     ## Create build file
 175     #
 176     #   @param  FileType    Type of build file. Only nmake and gmake are supported now.
 177     #
 178     #   @retval TRUE        The build file is created or re-created successfully
 179     #   @retval FALSE       The build file exists and is the same as the one to be generated
 180     #
 181     def Generate(self, FileType=gMakeType):
 182         if FileType not in self._FILE_NAME_:
 183             EdkLogger.error("build", PARAMETER_INVALID, "Invalid build type [%s]" % FileType,
 184                             ExtraData="[%s]" % str(self._AutoGenObject))
 185         self._FileType = FileType
 186         FileContent = self._TEMPLATE_.Replace(self._TemplateDict)
 187         FileName = self._FILE_NAME_[FileType]
 188         return SaveFileOnChange(os.path.join(self._AutoGenObject.MakeFileDir, FileName), FileContent, False)
 189
 190     ## Return a list of directory creation command string
 191     #
 192     #   @param      DirList     The list of directory to be created
 193     #
 194     #   @retval     list        The directory creation command list
 195     #
 196     def GetCreateDirectoryCommand(self, DirList):
 197         return [self._MD_TEMPLATE_[self._FileType] % {'dir':Dir} for Dir in DirList]
 198
 199     ## Return a list of directory removal command string
 200     #
 201     #   @param      DirList     The list of directory to be removed
 202     #
 203     #   @retval     list        The directory removal command list
 204     #
 205     def GetRemoveDirectoryCommand(self, DirList):
 206         return [self._RD_TEMPLATE_[self._FileType] % {'dir':Dir} for Dir in DirList]
 207
 208     def PlaceMacro(self, Path, MacroDefinitions={}):
 209         if Path.startswith("$("):
 210             return Path
 211         else:
 212             PathLength = len(Path)
 213             for MacroName in MacroDefinitions:
 214                 MacroValue = MacroDefinitions[MacroName]
 215                 MacroValueLength = len(MacroValue)
 216                 if MacroValueLength == 0:
 217                     continue
 218                 if MacroValueLength <= PathLength and Path.startswith(MacroValue):
 219                     Path = "$(%s)%s" % (MacroName, Path[MacroValueLength:])
 220                     break
 221             return Path
 222
 223 ## ModuleMakefile class
 224 #
 225 #  This class encapsules makefie and its generation for module. It uses template to generate
 226 #  the content of makefile. The content of makefile will be got from ModuleAutoGen object.
 227 #
 228 class ModuleMakefile(BuildFile):
 229     ## template used to generate the makefile for module
 230     _TEMPLATE_ = TemplateString('''\
 231 ${makefile_header}
 232
 233 #
 234 # Platform Macro Definition
 235 #
 236 PLATFORM_NAME = ${platform_name}
 237 PLATFORM_GUID = ${platform_guid}
 238 PLATFORM_VERSION = ${platform_version}
 239 PLATFORM_RELATIVE_DIR = ${platform_relative_directory}
 240 PLATFORM_DIR = ${platform_dir}
 241 PLATFORM_OUTPUT_DIR = ${platform_output_directory}
 242
 243 #
 244 # Module Macro Definition
 245 #
 246 MODULE_NAME = ${module_name}
 247 MODULE_GUID = ${module_guid}
 248 MODULE_NAME_GUID = ${module_name_guid}
 249 MODULE_VERSION = ${module_version}
 250 MODULE_TYPE = ${module_type}
 251 MODULE_FILE = ${module_file}
 252 MODULE_FILE_BASE_NAME = ${module_file_base_name}
 253 BASE_NAME = $(MODULE_NAME)
 254 MODULE_RELATIVE_DIR = ${module_relative_directory}
 255 PACKAGE_RELATIVE_DIR = ${package_relative_directory}
 256 MODULE_DIR = ${module_dir}
 257 FFS_OUTPUT_DIR = ${ffs_output_directory}
 258
 259 MODULE_ENTRY_POINT = ${module_entry_point}
 260 ARCH_ENTRY_POINT = ${arch_entry_point}
 261 IMAGE_ENTRY_POINT = ${image_entry_point}
 262
 263 ${BEGIN}${module_extra_defines}
 264 ${END}
 265 #
 266 # Build Configuration Macro Definition
 267 #
 268 ARCH = ${architecture}
 269 TOOLCHAIN = ${toolchain_tag}
 270 TOOLCHAIN_TAG = ${toolchain_tag}
 271 TARGET = ${build_target}
 272
 273 #
 274 # Build Directory Macro Definition
 275 #
 276 # PLATFORM_BUILD_DIR = ${platform_build_directory}
 277 BUILD_DIR = ${platform_build_directory}
 278 BIN_DIR = $(BUILD_DIR)${separator}${architecture}
 279 LIB_DIR = $(BIN_DIR)
 280 MODULE_BUILD_DIR = ${module_build_directory}
 281 OUTPUT_DIR = ${module_output_directory}
 282 DEBUG_DIR = ${module_debug_directory}
 283 DEST_DIR_OUTPUT = $(OUTPUT_DIR)
 284 DEST_DIR_DEBUG = $(DEBUG_DIR)
 285
 286 #
 287 # Shell Command Macro
 288 #
 289 ${BEGIN}${shell_command_code} = ${shell_command}
 290 ${END}
 291
 292 #
 293 # Tools definitions specific to this module
 294 #
 295 ${BEGIN}${module_tool_definitions}
 296 ${END}
 297 MAKE_FILE = ${makefile_path}
 298
 299 #
 300 # Build Macro
 301 #
 302 ${BEGIN}${file_macro}
 303 ${END}
 304
 305 COMMON_DEPS = ${BEGIN}${common_dependency_file} \\
 306               ${END}
 307
 308 #
 309 # Overridable Target Macro Definitions
 310 #
 311 FORCE_REBUILD = force_build
 312 INIT_TARGET = init
 313 PCH_TARGET =
 314 BC_TARGET = ${BEGIN}${backward_compatible_target} ${END}
 315 CODA_TARGET = ${BEGIN}${remaining_build_target} \\
 316               ${END}
 317
 318 #
 319 # Default target, which will build dependent libraries in addition to source files
 320 #
 321
 322 all: mbuild
 323
 324
 325 #
 326 # Target used when called from platform makefile, which will bypass the build of dependent libraries
 327 #
 328
 329 pbuild: $(INIT_TARGET) $(BC_TARGET) $(PCH_TARGET) $(CODA_TARGET)
 330
 331 #
 332 # ModuleTarget
 333 #
 334
 335 mbuild: $(INIT_TARGET) $(BC_TARGET) gen_libs $(PCH_TARGET) $(CODA_TARGET)
 336
 337 #
 338 # Build Target used in multi-thread build mode, which will bypass the init and gen_libs targets
 339 #
 340
 341 tbuild: $(BC_TARGET) $(PCH_TARGET) $(CODA_TARGET)
 342
 343 #
 344 # Phony target which is used to force executing commands for a target
 345 #
 346 force_build:
 347 \t-@
 348
 349 #
 350 # Target to update the FD
 351 #
 352
 353 fds: mbuild gen_fds
 354
 355 #
 356 # Initialization target: print build information and create necessary directories
 357 #
 358 init: info dirs
 359
 360 info:
 361 \t-@echo Building ... $(MODULE_DIR)${separator}$(MODULE_FILE) [$(ARCH)]
 362
 363 dirs:
 364 ${BEGIN}\t-@${create_directory_command}\n${END}
 365
 366 strdefs:
 367 \t-@$(CP) $(DEBUG_DIR)${separator}AutoGen.h $(DEBUG_DIR)${separator}$(MODULE_NAME)StrDefs.h
 368
 369 #
 370 # GenLibsTarget
 371 #
 372 gen_libs:
 373 \t${BEGIN}@"$(MAKE)" $(MAKE_FLAGS) -f ${dependent_library_build_directory}${separator}${makefile_name}
 374 \t${END}@cd $(MODULE_BUILD_DIR)
 375
 376 #
 377 # Build Flash Device Image
 378 #
 379 gen_fds:
 380 \t@"$(MAKE)" $(MAKE_FLAGS) -f $(BUILD_DIR)${separator}${makefile_name} fds
 381 \t@cd $(MODULE_BUILD_DIR)
 382
 383 #
 384 # Individual Object Build Targets
 385 #
 386 ${BEGIN}${file_build_target}
 387 ${END}
 388
 389 #
 390 # clean all intermediate files
 391 #
 392 clean:
 393 \t${BEGIN}${clean_command}
 394 \t${END}\t$(RM) AutoGenTimeStamp
 395
 396 #
 397 # clean all generated files
 398 #
 399 cleanall:
 400 ${BEGIN}\t${cleanall_command}
 401 ${END}\t$(RM) *.pdb *.idb > NUL 2>&1
 402 \t$(RM) $(BIN_DIR)${separator}$(MODULE_NAME).efi
 403 \t$(RM) AutoGenTimeStamp
 404
 405 #
 406 # clean all dependent libraries built
 407 #
 408 cleanlib:
 409 \t${BEGIN}-@${library_build_command} cleanall
 410 \t${END}@cd $(MODULE_BUILD_DIR)\n\n''')
 411
 412     _FILE_MACRO_TEMPLATE = TemplateString("${macro_name} = ${BEGIN} \\\n    ${source_file}${END}\n")
 413     _BUILD_TARGET_TEMPLATE = TemplateString("${BEGIN}${target} : ${deps}\n${END}\t${cmd}\n")
 414
 415     ## Constructor of ModuleMakefile
 416     #
 417     #   @param  ModuleAutoGen   Object of ModuleAutoGen class
 418     #
 419     def __init__(self, ModuleAutoGen):
 420         BuildFile.__init__(self, ModuleAutoGen)
 421         self.PlatformInfo = self._AutoGenObject.PlatformInfo
 422
 423         self.ResultFileList = []
 424         self.IntermediateDirectoryList = ["$(DEBUG_DIR)", "$(OUTPUT_DIR)"]
 425
 426         self.FileBuildTargetList = []       # [(src, target string)]
 427         self.BuildTargetList = []           # [target string]
 428         self.PendingBuildTargetList = []    # [FileBuildRule objects]
 429         self.CommonFileDependency = []
 430         self.FileListMacros = {}
 431         self.ListFileMacros = {}
 432         self.ObjTargetDict = {}
 433         self.FileCache = {}
 434         self.LibraryBuildCommandList = []
 435         self.LibraryFileList = []
 436         self.LibraryMakefileList = []
 437         self.LibraryBuildDirectoryList = []
 438         self.SystemLibraryList = []
 439         self.Macros = OrderedDict()
 440         self.Macros["OUTPUT_DIR"      ] = self._AutoGenObject.Macros["OUTPUT_DIR"]
 441         self.Macros["DEBUG_DIR"       ] = self._AutoGenObject.Macros["DEBUG_DIR"]
 442         self.Macros["MODULE_BUILD_DIR"] = self._AutoGenObject.Macros["MODULE_BUILD_DIR"]
 443         self.Macros["BIN_DIR"         ] = self._AutoGenObject.Macros["BIN_DIR"]
 444         self.Macros["BUILD_DIR"       ] = self._AutoGenObject.Macros["BUILD_DIR"]
 445         self.Macros["WORKSPACE"       ] = self._AutoGenObject.Macros["WORKSPACE"]
 446         self.Macros["FFS_OUTPUT_DIR"  ] = self._AutoGenObject.Macros["FFS_OUTPUT_DIR"]
 447         self.GenFfsList                 = ModuleAutoGen.GenFfsList
 448         self.MacroList = ['FFS_OUTPUT_DIR', 'MODULE_GUID', 'OUTPUT_DIR']
 449         self.FfsOutputFileList = []
 450
 451     # Compose a dict object containing information used to do replacement in template
 452     @property
 453     def _TemplateDict(self):
 454         if self._FileType not in self._SEP_:
 455             EdkLogger.error("build", PARAMETER_INVALID, "Invalid Makefile type [%s]" % self._FileType,
 456                             ExtraData="[%s]" % str(self._AutoGenObject))
 457         MyAgo = self._AutoGenObject
 458         Separator = self._SEP_[self._FileType]
 459
 460         # break build if no source files and binary files are found
 461         if len(MyAgo.SourceFileList) == 0 and len(MyAgo.BinaryFileList) == 0:
 462             EdkLogger.error("build", AUTOGEN_ERROR, "No files to be built in module [%s, %s, %s]"
 463                             % (MyAgo.BuildTarget, MyAgo.ToolChain, MyAgo.Arch),
 464                             ExtraData="[%s]" % str(MyAgo))
 465
 466         # convert dependent libraries to build command
 467         self.ProcessDependentLibrary()
 468         if len(MyAgo.Module.ModuleEntryPointList) > 0:
 469             ModuleEntryPoint = MyAgo.Module.ModuleEntryPointList[0]
 470         else:
 471             ModuleEntryPoint = "_ModuleEntryPoint"
 472
 473         ArchEntryPoint = ModuleEntryPoint
 474
 475         if MyAgo.Arch == "EBC":
 476             # EBC compiler always use "EfiStart" as entry point. Only applies to EdkII modules
 477             ImageEntryPoint = "EfiStart"
 478         else:
 479             # EdkII modules always use "_ModuleEntryPoint" as entry point
 480             ImageEntryPoint = "_ModuleEntryPoint"
 481
 482         for k, v in MyAgo.Module.Defines.items():
 483             if k not in MyAgo.Macros:
 484                 MyAgo.Macros[k] = v
 485
 486         if 'MODULE_ENTRY_POINT' not in MyAgo.Macros:
 487             MyAgo.Macros['MODULE_ENTRY_POINT'] = ModuleEntryPoint
 488         if 'ARCH_ENTRY_POINT' not in MyAgo.Macros:
 489             MyAgo.Macros['ARCH_ENTRY_POINT'] = ArchEntryPoint
 490         if 'IMAGE_ENTRY_POINT' not in MyAgo.Macros:
 491             MyAgo.Macros['IMAGE_ENTRY_POINT'] = ImageEntryPoint
 492
 493         PCI_COMPRESS_Flag = False
 494         for k, v in MyAgo.Module.Defines.items():
 495             if 'PCI_COMPRESS' == k and 'TRUE' == v:
 496                 PCI_COMPRESS_Flag = True
 497
 498         # tools definitions
 499         ToolsDef = []
 500         IncPrefix = self._INC_FLAG_[MyAgo.ToolChainFamily]
 501         for Tool in MyAgo.BuildOption:
 502             for Attr in MyAgo.BuildOption[Tool]:
 503                 Value = MyAgo.BuildOption[Tool][Attr]
 504                 if Attr == "FAMILY":
 505                     continue
 506                 elif Attr == "PATH":
 507                     ToolsDef.append("%s = %s" % (Tool, Value))
 508                 else:
 509                     # Don't generate MAKE_FLAGS in makefile. It's put in environment variable.
 510                     if Tool == "MAKE":
 511                         continue
 512                     # Remove duplicated include path, if any
 513                     if Attr == "FLAGS":
 514                         Value = RemoveDupOption(Value, IncPrefix, MyAgo.IncludePathList)
 515                         if self._AutoGenObject.BuildRuleFamily == TAB_COMPILER_MSFT and Tool == 'CC' and '/GM' in Value:
 516                             Value = Value.replace(' /MP', '')
 517                             MyAgo.BuildOption[Tool][Attr] = Value
 518                         if Tool == "OPTROM" and PCI_COMPRESS_Flag:
 519                             ValueList = Value.split()
 520                             if ValueList:
 521                                 for i, v in enumerate(ValueList):
 522                                     if '-e' == v:
 523                                         ValueList[i] = '-ec'
 524                                 Value = ' '.join(ValueList)
 525
 526                     ToolsDef.append("%s_%s = %s" % (Tool, Attr, Value))
 527             ToolsDef.append("")
 528
 529         # generate the Response file and Response flag
 530         RespDict = self.CommandExceedLimit()
 531         RespFileList = os.path.join(MyAgo.OutputDir, 'respfilelist.txt')
 532         if RespDict:
 533             RespFileListContent = ''
 534             for Resp in RespDict:
 535                 RespFile = os.path.join(MyAgo.OutputDir, str(Resp).lower() + '.txt')
 536                 StrList = RespDict[Resp].split(' ')
 537                 UnexpandMacro = []
 538                 NewStr = []
 539                 for Str in StrList:
 540                     if '$' in Str:
 541                         UnexpandMacro.append(Str)
 542                     else:
 543                         NewStr.append(Str)
 544                 UnexpandMacroStr = ' '.join(UnexpandMacro)
 545                 NewRespStr = ' '.join(NewStr)
 546                 SaveFileOnChange(RespFile, NewRespStr, False)
 547                 ToolsDef.append("%s = %s" % (Resp, UnexpandMacroStr + ' @' + RespFile))
 548                 RespFileListContent += '@' + RespFile + TAB_LINE_BREAK
 549                 RespFileListContent += NewRespStr + TAB_LINE_BREAK
 550             SaveFileOnChange(RespFileList, RespFileListContent, False)
 551         else:
 552             if os.path.exists(RespFileList):
 553                 os.remove(RespFileList)
 554
 555         # convert source files and binary files to build targets
 556         self.ResultFileList = [str(T.Target) for T in MyAgo.CodaTargetList]
 557         if len(self.ResultFileList) == 0 and len(MyAgo.SourceFileList) != 0:
 558             EdkLogger.error("build", AUTOGEN_ERROR, "Nothing to build",
 559                             ExtraData="[%s]" % str(MyAgo))
 560
 561         self.ProcessBuildTargetList()
 562         self.ParserGenerateFfsCmd()
 563
 564         # Generate macros used to represent input files
 565         FileMacroList = [] # macro name = file list
 566         for FileListMacro in self.FileListMacros:
 567             FileMacro = self._FILE_MACRO_TEMPLATE.Replace(
 568                                                     {
 569                                                         "macro_name"  : FileListMacro,
 570                                                         "source_file" : self.FileListMacros[FileListMacro]
 571                                                     }
 572                                                     )
 573             FileMacroList.append(FileMacro)
 574
 575         # INC_LIST is special
 576         FileMacro = ""
 577         IncludePathList = []
 578         for P in  MyAgo.IncludePathList:
 579             IncludePathList.append(IncPrefix + self.PlaceMacro(P, self.Macros))
 580             if FileBuildRule.INC_LIST_MACRO in self.ListFileMacros:
 581                 self.ListFileMacros[FileBuildRule.INC_LIST_MACRO].append(IncPrefix + P)
 582         FileMacro += self._FILE_MACRO_TEMPLATE.Replace(
 583                                                 {
 584                                                     "macro_name"   : "INC",
 585                                                     "source_file" : IncludePathList
 586                                                 }
 587                                                 )
 588         FileMacroList.append(FileMacro)
 589         # Add support when compiling .nasm source files
 590         for File in self.FileCache.keys():
 591             if not str(File).endswith('.nasm'):
 592                 continue
 593             IncludePathList = []
 594             for P in  MyAgo.IncludePathList:
 595                 IncludePath = self._INC_FLAG_['NASM'] + self.PlaceMacro(P, self.Macros)
 596                 if IncludePath.endswith(os.sep):
 597                     IncludePath = IncludePath.rstrip(os.sep)
 598                 # When compiling .nasm files, need to add a literal backslash at each path
 599                 # To specify a literal backslash at the end of the line, precede it with a caret (^)
 600                 if P == MyAgo.IncludePathList[-1] and os.sep == '\\':
 601                     IncludePath = ''.join([IncludePath, '^', os.sep])
 602                 else:
 603                     IncludePath = os.path.join(IncludePath, '')
 604                 IncludePathList.append(IncludePath)
 605             FileMacroList.append(self._FILE_MACRO_TEMPLATE.Replace({"macro_name": "NASM_INC", "source_file": IncludePathList}))
 606             break
 607
 608         # Generate macros used to represent files containing list of input files
 609         for ListFileMacro in self.ListFileMacros:
 610             ListFileName = os.path.join(MyAgo.OutputDir, "%s.lst" % ListFileMacro.lower()[:len(ListFileMacro) - 5])
 611             FileMacroList.append("%s = %s" % (ListFileMacro, ListFileName))
 612             SaveFileOnChange(
 613                 ListFileName,
 614                 "\n".join(self.ListFileMacros[ListFileMacro]),
 615                 False
 616                 )
 617
 618         # Generate objlist used to create .obj file
 619         for Type in self.ObjTargetDict:
 620             NewLine = ' '.join(list(self.ObjTargetDict[Type]))
 621             FileMacroList.append("OBJLIST_%s = %s" % (list(self.ObjTargetDict.keys()).index(Type), NewLine))
 622
 623         BcTargetList = []
 624
 625         MakefileName = self._FILE_NAME_[self._FileType]
 626         LibraryMakeCommandList = []
 627         for D in self.LibraryBuildDirectoryList:
 628             Command = self._MAKE_TEMPLATE_[self._FileType] % {"file":os.path.join(D, MakefileName)}
 629             LibraryMakeCommandList.append(Command)
 630
 631         package_rel_dir = MyAgo.SourceDir
 632         current_dir = self.Macros["WORKSPACE"]
 633         found = False
 634         while not found and os.sep in package_rel_dir:
 635             index = package_rel_dir.index(os.sep)
 636             current_dir = mws.join(current_dir, package_rel_dir[:index])
 637             if os.path.exists(current_dir):
 638                 for fl in os.listdir(current_dir):
 639                     if fl.endswith('.dec'):
 640                         found = True
 641                         break
 642             package_rel_dir = package_rel_dir[index + 1:]
 643
 644         MakefileTemplateDict = {
 645             "makefile_header"           : self._FILE_HEADER_[self._FileType],
 646             "makefile_path"             : os.path.join("$(MODULE_BUILD_DIR)", MakefileName),
 647             "makefile_name"             : MakefileName,
 648             "platform_name"             : self.PlatformInfo.Name,
 649             "platform_guid"             : self.PlatformInfo.Guid,
 650             "platform_version"          : self.PlatformInfo.Version,
 651             "platform_relative_directory": self.PlatformInfo.SourceDir,
 652             "platform_output_directory" : self.PlatformInfo.OutputDir,
 653             "ffs_output_directory"      : MyAgo.Macros["FFS_OUTPUT_DIR"],
 654             "platform_dir"              : MyAgo.Macros["PLATFORM_DIR"],
 655
 656             "module_name"               : MyAgo.Name,
 657             "module_guid"               : MyAgo.Guid,
 658             "module_name_guid"          : MyAgo.UniqueBaseName,
 659             "module_version"            : MyAgo.Version,
 660             "module_type"               : MyAgo.ModuleType,
 661             "module_file"               : MyAgo.MetaFile.Name,
 662             "module_file_base_name"     : MyAgo.MetaFile.BaseName,
 663             "module_relative_directory" : MyAgo.SourceDir,
 664             "module_dir"                : mws.join (self.Macros["WORKSPACE"], MyAgo.SourceDir),
 665             "package_relative_directory": package_rel_dir,
 666             "module_extra_defines"      : ["%s = %s" % (k, v) for k, v in MyAgo.Module.Defines.items()],
 667
 668             "architecture"              : MyAgo.Arch,
 669             "toolchain_tag"             : MyAgo.ToolChain,
 670             "build_target"              : MyAgo.BuildTarget,
 671
 672             "platform_build_directory"  : self.PlatformInfo.BuildDir,
 673             "module_build_directory"    : MyAgo.BuildDir,
 674             "module_output_directory"   : MyAgo.OutputDir,
 675             "module_debug_directory"    : MyAgo.DebugDir,
 676
 677             "separator"                 : Separator,
 678             "module_tool_definitions"   : ToolsDef,
 679
 680             "shell_command_code"        : list(self._SHELL_CMD_[self._FileType].keys()),
 681             "shell_command"             : list(self._SHELL_CMD_[self._FileType].values()),
 682
 683             "module_entry_point"        : ModuleEntryPoint,
 684             "image_entry_point"         : ImageEntryPoint,
 685             "arch_entry_point"          : ArchEntryPoint,
 686             "remaining_build_target"    : self.ResultFileList,
 687             "common_dependency_file"    : self.CommonFileDependency,
 688             "create_directory_command"  : self.GetCreateDirectoryCommand(self.IntermediateDirectoryList),
 689             "clean_command"             : self.GetRemoveDirectoryCommand(["$(OUTPUT_DIR)"]),
 690             "cleanall_command"          : self.GetRemoveDirectoryCommand(["$(DEBUG_DIR)", "$(OUTPUT_DIR)"]),
 691             "dependent_library_build_directory" : self.LibraryBuildDirectoryList,
 692             "library_build_command"     : LibraryMakeCommandList,
 693             "file_macro"                : FileMacroList,
 694             "file_build_target"         : self.BuildTargetList,
 695             "backward_compatible_target": BcTargetList,
 696         }
 697
 698         return MakefileTemplateDict
 699
 700     def ParserGenerateFfsCmd(self):
 701         #Add Ffs cmd to self.BuildTargetList
 702         OutputFile = ''
 703         DepsFileList = []
 704
 705         for Cmd in self.GenFfsList:
 706             if Cmd[2]:
 707                 for CopyCmd in Cmd[2]:
 708                     Src, Dst = CopyCmd
 709                     Src = self.ReplaceMacro(Src)
 710                     Dst = self.ReplaceMacro(Dst)
 711                     if Dst not in self.ResultFileList:
 712                         self.ResultFileList.append(Dst)
 713                     if '%s :' %(Dst) not in self.BuildTargetList:
 714                         self.BuildTargetList.append("%s :" %(Dst))
 715                         self.BuildTargetList.append('\t' + self._CP_TEMPLATE_[self._FileType] %{'Src': Src, 'Dst': Dst})
 716
 717             FfsCmdList = Cmd[0]
 718             for index, Str in enumerate(FfsCmdList):
 719                 if '-o' == Str:
 720                     OutputFile = FfsCmdList[index + 1]
 721                 if '-i' == Str or "-oi" == Str:
 722                     if DepsFileList == []:
 723                         DepsFileList = [FfsCmdList[index + 1]]
 724                     else:
 725                         DepsFileList.append(FfsCmdList[index + 1])
 726             DepsFileString = ' '.join(DepsFileList).strip()
 727             if DepsFileString == '':
 728                 continue
 729             OutputFile = self.ReplaceMacro(OutputFile)
 730             self.ResultFileList.append(OutputFile)
 731             DepsFileString = self.ReplaceMacro(DepsFileString)
 732             self.BuildTargetList.append('%s : %s' % (OutputFile, DepsFileString))
 733             CmdString = ' '.join(FfsCmdList).strip()
 734             CmdString = self.ReplaceMacro(CmdString)
 735             self.BuildTargetList.append('\t%s' % CmdString)
 736
 737             self.ParseSecCmd(DepsFileList, Cmd[1])
 738             for SecOutputFile, SecDepsFile, SecCmd in self.FfsOutputFileList :
 739                 self.BuildTargetList.append('%s : %s' % (self.ReplaceMacro(SecOutputFile), self.ReplaceMacro(SecDepsFile)))
 740                 self.BuildTargetList.append('\t%s' % self.ReplaceMacro(SecCmd))
 741             self.FfsOutputFileList = []
 742
 743     def ParseSecCmd(self, OutputFileList, CmdTuple):
 744         for OutputFile in OutputFileList:
 745             for SecCmdStr in CmdTuple:
 746                 SecDepsFileList = []
 747                 SecCmdList = SecCmdStr.split()
 748                 CmdName = SecCmdList[0]
 749                 for index, CmdItem in enumerate(SecCmdList):
 750                     if '-o' == CmdItem and OutputFile == SecCmdList[index + 1]:
 751                         index = index + 1
 752                         while index + 1 < len(SecCmdList):
 753                             if not SecCmdList[index+1].startswith('-'):
 754                                 SecDepsFileList.append(SecCmdList[index + 1])
 755                             index = index + 1
 756                         if CmdName == 'Trim':
 757                             SecDepsFileList.append(os.path.join('$(DEBUG_DIR)', os.path.basename(OutputFile).replace('offset', 'efi')))
 758                         if OutputFile.endswith('.ui') or OutputFile.endswith('.ver'):
 759                             SecDepsFileList.append(os.path.join('$(MODULE_DIR)', '$(MODULE_FILE)'))
 760                         self.FfsOutputFileList.append((OutputFile, ' '.join(SecDepsFileList), SecCmdStr))
 761                         if len(SecDepsFileList) > 0:
 762                             self.ParseSecCmd(SecDepsFileList, CmdTuple)
 763                         break
 764                     else:
 765                         continue
 766
 767     def ReplaceMacro(self, str):
 768         for Macro in self.MacroList:
 769             if self._AutoGenObject.Macros[Macro] and self._AutoGenObject.Macros[Macro] in str:
 770                 str = str.replace(self._AutoGenObject.Macros[Macro], '$(' + Macro + ')')
 771         return str
 772
 773     def CommandExceedLimit(self):
 774         FlagDict = {
 775                     'CC'    :  { 'Macro' : '$(CC_FLAGS)',    'Value' : False},
 776                     'PP'    :  { 'Macro' : '$(PP_FLAGS)',    'Value' : False},
 777                     'APP'   :  { 'Macro' : '$(APP_FLAGS)',   'Value' : False},
 778                     'ASLPP' :  { 'Macro' : '$(ASLPP_FLAGS)', 'Value' : False},
 779                     'VFRPP' :  { 'Macro' : '$(VFRPP_FLAGS)', 'Value' : False},
 780                     'ASM'   :  { 'Macro' : '$(ASM_FLAGS)',   'Value' : False},
 781                     'ASLCC' :  { 'Macro' : '$(ASLCC_FLAGS)', 'Value' : False},
 782                    }
 783
 784         RespDict = {}
 785         FileTypeList = []
 786         IncPrefix = self._INC_FLAG_[self._AutoGenObject.ToolChainFamily]
 787
 788         # base on the source files to decide the file type
 789         for File in self._AutoGenObject.SourceFileList:
 790             for type in self._AutoGenObject.FileTypes:
 791                 if File in self._AutoGenObject.FileTypes[type]:
 792                     if type not in FileTypeList:
 793                         FileTypeList.append(type)
 794
 795         # calculate the command-line length
 796         if FileTypeList:
 797             for type in FileTypeList:
 798                 BuildTargets = self._AutoGenObject.BuildRules[type].BuildTargets
 799                 for Target in BuildTargets:
 800                     CommandList = BuildTargets[Target].Commands
 801                     for SingleCommand in CommandList:
 802                         Tool = ''
 803                         SingleCommandLength = len(SingleCommand)
 804                         SingleCommandList = SingleCommand.split()
 805                         if len(SingleCommandList) > 0:
 806                             for Flag in FlagDict:
 807                                 if '$('+ Flag +')' in SingleCommandList[0]:
 808                                     Tool = Flag
 809                                     break
 810                         if Tool:
 811                             if 'PATH' not in self._AutoGenObject.BuildOption[Tool]:
 812                                 EdkLogger.error("build", AUTOGEN_ERROR, "%s_PATH doesn't exist in %s ToolChain and %s Arch." %(Tool, self._AutoGenObject.ToolChain, self._AutoGenObject.Arch), ExtraData="[%s]" % str(self._AutoGenObject))
 813                             SingleCommandLength += len(self._AutoGenObject.BuildOption[Tool]['PATH'])
 814                             for item in SingleCommandList[1:]:
 815                                 if FlagDict[Tool]['Macro'] in item:
 816                                     if 'FLAGS' not in self._AutoGenObject.BuildOption[Tool]:
 817                                         EdkLogger.error("build", AUTOGEN_ERROR, "%s_FLAGS doesn't exist in %s ToolChain and %s Arch." %(Tool, self._AutoGenObject.ToolChain, self._AutoGenObject.Arch), ExtraData="[%s]" % str(self._AutoGenObject))
 818                                     Str = self._AutoGenObject.BuildOption[Tool]['FLAGS']
 819                                     for Option in self._AutoGenObject.BuildOption:
 820                                         for Attr in self._AutoGenObject.BuildOption[Option]:
 821                                             if Str.find(Option + '_' + Attr) != -1:
 822                                                 Str = Str.replace('$(' + Option + '_' + Attr + ')', self._AutoGenObject.BuildOption[Option][Attr])
 823                                     while(Str.find('$(') != -1):
 824                                         for macro in self._AutoGenObject.Macros:
 825                                             MacroName = '$('+ macro + ')'
 826                                             if (Str.find(MacroName) != -1):
 827                                                 Str = Str.replace(MacroName, self._AutoGenObject.Macros[macro])
 828                                                 break
 829                                         else:
 830                                             break
 831                                     SingleCommandLength += len(Str)
 832                                 elif '$(INC)' in item:
 833                                     SingleCommandLength += self._AutoGenObject.IncludePathLength + len(IncPrefix) * len(self._AutoGenObject.IncludePathList)
 834                                 elif item.find('$(') != -1:
 835                                     Str = item
 836                                     for Option in self._AutoGenObject.BuildOption:
 837                                         for Attr in self._AutoGenObject.BuildOption[Option]:
 838                                             if Str.find(Option + '_' + Attr) != -1:
 839                                                 Str = Str.replace('$(' + Option + '_' + Attr + ')', self._AutoGenObject.BuildOption[Option][Attr])
 840                                     while(Str.find('$(') != -1):
 841                                         for macro in self._AutoGenObject.Macros:
 842                                             MacroName = '$('+ macro + ')'
 843                                             if (Str.find(MacroName) != -1):
 844                                                 Str = Str.replace(MacroName, self._AutoGenObject.Macros[macro])
 845                                                 break
 846                                         else:
 847                                             break
 848                                     SingleCommandLength += len(Str)
 849
 850                             if SingleCommandLength > GlobalData.gCommandMaxLength:
 851                                 FlagDict[Tool]['Value'] = True
 852
 853                 # generate the response file content by combine the FLAGS and INC
 854                 for Flag in FlagDict:
 855                     if FlagDict[Flag]['Value']:
 856                         Key = Flag + '_RESP'
 857                         RespMacro = FlagDict[Flag]['Macro'].replace('FLAGS', 'RESP')
 858                         Value = self._AutoGenObject.BuildOption[Flag]['FLAGS']
 859                         for inc in self._AutoGenObject.IncludePathList:
 860                             Value += ' ' + IncPrefix + inc
 861                         for Option in self._AutoGenObject.BuildOption:
 862                             for Attr in self._AutoGenObject.BuildOption[Option]:
 863                                 if Value.find(Option + '_' + Attr) != -1:
 864                                     Value = Value.replace('$(' + Option + '_' + Attr + ')', self._AutoGenObject.BuildOption[Option][Attr])
 865                         while (Value.find('$(') != -1):
 866                             for macro in self._AutoGenObject.Macros:
 867                                 MacroName = '$('+ macro + ')'
 868                                 if (Value.find(MacroName) != -1):
 869                                     Value = Value.replace(MacroName, self._AutoGenObject.Macros[macro])
 870                                     break
 871                             else:
 872                                 break
 873
 874                         if self._AutoGenObject.ToolChainFamily == 'GCC':
 875                             RespDict[Key] = Value.replace('\\', '/')
 876                         else:
 877                             RespDict[Key] = Value
 878                         for Target in BuildTargets:
 879                             for i, SingleCommand in enumerate(BuildTargets[Target].Commands):
 880                                 if FlagDict[Flag]['Macro'] in SingleCommand:
 881                                     BuildTargets[Target].Commands[i] = SingleCommand.replace('$(INC)', '').replace(FlagDict[Flag]['Macro'], RespMacro)
 882         return RespDict
 883
 884     def ProcessBuildTargetList(self):
 885         #
 886         # Search dependency file list for each source file
 887         #
 888         ForceIncludedFile = []
 889         for File in self._AutoGenObject.AutoGenFileList:
 890             if File.Ext == '.h':
 891                 ForceIncludedFile.append(File)
 892         SourceFileList = []
 893         OutPutFileList = []
 894         for Target in self._AutoGenObject.IntroTargetList:
 895             SourceFileList.extend(Target.Inputs)
 896             OutPutFileList.extend(Target.Outputs)
 897
 898         if OutPutFileList:
 899             for Item in OutPutFileList:
 900                 if Item in SourceFileList:
 901                     SourceFileList.remove(Item)
 902
 903         FileDependencyDict = self.GetFileDependency(
 904                                     SourceFileList,
 905                                     ForceIncludedFile,
 906                                     self._AutoGenObject.IncludePathList + self._AutoGenObject.BuildOptionIncPathList
 907                                     )
 908         DepSet = None
 909         for File,Dependency in FileDependencyDict.items():
 910             if not Dependency:
 911                 FileDependencyDict[File] = ['$(FORCE_REBUILD)']
 912                 continue
 913
 914             self._AutoGenObject.AutoGenDepSet |= set(Dependency)
 915
 916             # skip non-C files
 917             if File.Ext not in [".c", ".C"] or File.Name == "AutoGen.c":
 918                 continue
 919             elif DepSet is None:
 920                 DepSet = set(Dependency)
 921             else:
 922                 DepSet &= set(Dependency)
 923         # in case nothing in SourceFileList
 924         if DepSet is None:
 925             DepSet = set()
 926         #
 927         # Extract common files list in the dependency files
 928         #
 929         for File in DepSet:
 930             self.CommonFileDependency.append(self.PlaceMacro(File.Path, self.Macros))
 931
 932         CmdSumDict = {}
 933         CmdTargetDict = {}
 934         CmdCppDict = {}
 935         DependencyDict = FileDependencyDict.copy()
 936         for File in FileDependencyDict:
 937             # skip non-C files
 938             if File.Ext not in [".c", ".C"] or File.Name == "AutoGen.c":
 939                 continue
 940             NewDepSet = set(FileDependencyDict[File])
 941             NewDepSet -= DepSet
 942             FileDependencyDict[File] = ["$(COMMON_DEPS)"] + list(NewDepSet)
 943             DependencyDict[File] = list(NewDepSet)
 944
 945         # Convert target description object to target string in makefile
 946         for Type in self._AutoGenObject.Targets:
 947             for T in self._AutoGenObject.Targets[Type]:
 948                 # Generate related macros if needed
 949                 if T.GenFileListMacro and T.FileListMacro not in self.FileListMacros:
 950                     self.FileListMacros[T.FileListMacro] = []
 951                 if T.GenListFile and T.ListFileMacro not in self.ListFileMacros:
 952                     self.ListFileMacros[T.ListFileMacro] = []
 953                 if T.GenIncListFile and T.IncListFileMacro not in self.ListFileMacros:
 954                     self.ListFileMacros[T.IncListFileMacro] = []
 955                 if self._AutoGenObject.BuildRuleFamily == TAB_COMPILER_MSFT and Type == TAB_C_CODE_FILE:
 956                     NewFile = self.PlaceMacro(str(T), self.Macros)
 957                     if self.ObjTargetDict.get(T.Target.SubDir):
 958                         self.ObjTargetDict[T.Target.SubDir].add(NewFile)
 959                     else:
 960                         self.ObjTargetDict[T.Target.SubDir] = set()
 961                         self.ObjTargetDict[T.Target.SubDir].add(NewFile)
 962
 963                 Deps = []
 964                 CCodeDeps = []
 965                 # Add force-dependencies
 966                 for Dep in T.Dependencies:
 967                     Deps.append(self.PlaceMacro(str(Dep), self.Macros))
 968                     if Dep != '$(MAKE_FILE)':
 969                         CCodeDeps.append(self.PlaceMacro(str(Dep), self.Macros))
 970                 # Add inclusion-dependencies
 971                 if len(T.Inputs) == 1 and T.Inputs[0] in FileDependencyDict:
 972                     for F in FileDependencyDict[T.Inputs[0]]:
 973                         Deps.append(self.PlaceMacro(str(F), self.Macros))
 974                 # Add source-dependencies
 975                 for F in T.Inputs:
 976                     NewFile = self.PlaceMacro(str(F), self.Macros)
 977                     # In order to use file list macro as dependency
 978                     if T.GenListFile:
 979                         # gnu tools need forward slash path separator, even on Windows
 980                         self.ListFileMacros[T.ListFileMacro].append(str(F).replace ('\\', '/'))
 981                         self.FileListMacros[T.FileListMacro].append(NewFile)
 982                     elif T.GenFileListMacro:
 983                         self.FileListMacros[T.FileListMacro].append(NewFile)
 984                     else:
 985                         Deps.append(NewFile)
 986
 987                 # Use file list macro as dependency
 988                 if T.GenFileListMacro:
 989                     Deps.append("$(%s)" % T.FileListMacro)
 990                     if Type in [TAB_OBJECT_FILE, TAB_STATIC_LIBRARY]:
 991                         Deps.append("$(%s)" % T.ListFileMacro)
 992
 993                 if self._AutoGenObject.BuildRuleFamily == TAB_COMPILER_MSFT and Type == TAB_C_CODE_FILE:
 994                     T, CmdTarget, CmdTargetDict, CmdCppDict = self.ParserCCodeFile(T, Type, CmdSumDict, CmdTargetDict, CmdCppDict, DependencyDict)
 995                     TargetDict = {"target": self.PlaceMacro(T.Target.Path, self.Macros), "cmd": "\n\t".join(T.Commands),"deps": CCodeDeps}
 996                     CmdLine = self._BUILD_TARGET_TEMPLATE.Replace(TargetDict).rstrip().replace('\t$(OBJLIST', '$(OBJLIST')
 997                     if T.Commands:
 998                         CmdLine = '%s%s' %(CmdLine, TAB_LINE_BREAK)
 999                     if CCodeDeps or CmdLine:
1000                         self.BuildTargetList.append(CmdLine)
1001                 else:
1002                     TargetDict = {"target": self.PlaceMacro(T.Target.Path, self.Macros), "cmd": "\n\t".join(T.Commands),"deps": Deps}
1003                     self.BuildTargetList.append(self._BUILD_TARGET_TEMPLATE.Replace(TargetDict))
1004
1005     def ParserCCodeFile(self, T, Type, CmdSumDict, CmdTargetDict, CmdCppDict, DependencyDict):
1006         if not CmdSumDict:
1007             for item in self._AutoGenObject.Targets[Type]:
1008                 CmdSumDict[item.Target.SubDir] = item.Target.BaseName
1009                 for CppPath in item.Inputs:
1010                     Path = self.PlaceMacro(CppPath.Path, self.Macros)
1011                     if CmdCppDict.get(item.Target.SubDir):
1012                         CmdCppDict[item.Target.SubDir].append(Path)
1013                     else:
1014                         CmdCppDict[item.Target.SubDir] = ['$(MAKE_FILE)', Path]
1015                     if CppPath.Path in DependencyDict:
1016                         for Temp in DependencyDict[CppPath.Path]:
1017                             try:
1018                                 Path = self.PlaceMacro(Temp.Path, self.Macros)
1019                             except:
1020                                 continue
1021                             if Path not in (self.CommonFileDependency + CmdCppDict[item.Target.SubDir]):
1022                                 CmdCppDict[item.Target.SubDir].append(Path)
1023         if T.Commands:
1024             CommandList = T.Commands[:]
1025             for Item in CommandList[:]:
1026                 SingleCommandList = Item.split()
1027                 if len(SingleCommandList) > 0 and '$(CC)' in SingleCommandList[0]:
1028                     for Temp in SingleCommandList:
1029                         if Temp.startswith('/Fo'):
1030                             CmdSign = '%s%s' % (Temp.rsplit(TAB_SLASH, 1)[0], TAB_SLASH)
1031                             break
1032                     else: continue
1033                     if CmdSign not in list(CmdTargetDict.keys()):
1034                         CmdTargetDict[CmdSign] = Item.replace(Temp, CmdSign)
1035                     else:
1036                         CmdTargetDict[CmdSign] = "%s %s" % (CmdTargetDict[CmdSign], SingleCommandList[-1])
1037                     Index = CommandList.index(Item)
1038                     CommandList.pop(Index)
1039                     if SingleCommandList[-1].endswith("%s%s.c" % (TAB_SLASH, CmdSumDict[CmdSign.lstrip('/Fo').rsplit(TAB_SLASH, 1)[0]])):
1040                         Cpplist = CmdCppDict[T.Target.SubDir]
1041                         Cpplist.insert(0, '$(OBJLIST_%d): $(COMMON_DEPS)' % list(self.ObjTargetDict.keys()).index(T.Target.SubDir))
1042                         T.Commands[Index] = '%s\n\t%s' % (' \\\n\t'.join(Cpplist), CmdTargetDict[CmdSign])
1043                     else:
1044                         T.Commands.pop(Index)
1045         return T, CmdSumDict, CmdTargetDict, CmdCppDict
1046
1047     ## For creating makefile targets for dependent libraries
1048     def ProcessDependentLibrary(self):
1049         for LibraryAutoGen in self._AutoGenObject.LibraryAutoGenList:
1050             if not LibraryAutoGen.IsBinaryModule and not LibraryAutoGen.CanSkipbyHash():
1051                 self.LibraryBuildDirectoryList.append(self.PlaceMacro(LibraryAutoGen.BuildDir, self.Macros))
1052
1053     ## Return a list containing source file's dependencies
1054     #
1055     #   @param      FileList        The list of source files
1056     #   @param      ForceInculeList The list of files which will be included forcely
1057     #   @param      SearchPathList  The list of search path
1058     #
1059     #   @retval     dict            The mapping between source file path and its dependencies
1060     #
1061     def GetFileDependency(self, FileList, ForceInculeList, SearchPathList):
1062         Dependency = {}
1063         for F in FileList:
1064             Dependency[F] = self.GetDependencyList(F, ForceInculeList, SearchPathList)
1065         return Dependency
1066
1067     ## Find dependencies for one source file
1068     #
1069     #  By searching recursively "#include" directive in file, find out all the
1070     #  files needed by given source file. The dependencies will be only searched
1071     #  in given search path list.
1072     #
1073     #   @param      File            The source file
1074     #   @param      ForceInculeList The list of files which will be included forcely
1075     #   @param      SearchPathList  The list of search path
1076     #
1077     #   @retval     list            The list of files the given source file depends on
1078     #
1079     def GetDependencyList(self, File, ForceList, SearchPathList):
1080         EdkLogger.debug(EdkLogger.DEBUG_1, "Try to get dependency files for %s" % File)
1081         FileStack = [File] + ForceList
1082         DependencySet = set()
1083
1084         if self._AutoGenObject.Arch not in gDependencyDatabase:
1085             gDependencyDatabase[self._AutoGenObject.Arch] = {}
1086         DepDb = gDependencyDatabase[self._AutoGenObject.Arch]
1087
1088         while len(FileStack) > 0:
1089             F = FileStack.pop()
1090
1091             FullPathDependList = []
1092             if F in self.FileCache:
1093                 for CacheFile in self.FileCache[F]:
1094                     FullPathDependList.append(CacheFile)
1095                     if CacheFile not in DependencySet:
1096                         FileStack.append(CacheFile)
1097                 DependencySet.update(FullPathDependList)
1098                 continue
1099
1100             CurrentFileDependencyList = []
1101             if F in DepDb:
1102                 CurrentFileDependencyList = DepDb[F]
1103             else:
1104                 try:
1105                     Fd = open(F.Path, 'rb')
1106                     FileContent = Fd.read()
1107                     Fd.close()
1108                 except BaseException as X:
1109                     EdkLogger.error("build", FILE_OPEN_FAILURE, ExtraData=F.Path + "\n\t" + str(X))
1110                 if len(FileContent) == 0:
1111                     continue
1112                 try:
1113                     if FileContent[0] == 0xff or FileContent[0] == 0xfe:
1114                         FileContent = FileContent.decode('utf-16')
1115                     else:
1116                         FileContent = FileContent.decode()
1117                 except:
1118                     # The file is not txt file. for example .mcb file
1119                     continue
1120                 IncludedFileList = gIncludePattern.findall(FileContent)
1121
1122                 for Inc in IncludedFileList:
1123                     Inc = Inc.strip()
1124                     # if there's macro used to reference header file, expand it
1125                     HeaderList = gMacroPattern.findall(Inc)
1126                     if len(HeaderList) == 1 and len(HeaderList[0]) == 2:
1127                         HeaderType = HeaderList[0][0]
1128                         HeaderKey = HeaderList[0][1]
1129                         if HeaderType in gIncludeMacroConversion:
1130                             Inc = gIncludeMacroConversion[HeaderType] % {"HeaderKey" : HeaderKey}
1131                         else:
1132                             # not known macro used in #include, always build the file by
1133                             # returning a empty dependency
1134                             self.FileCache[File] = []
1135                             return []
1136                     Inc = os.path.normpath(Inc)
1137                     CurrentFileDependencyList.append(Inc)
1138                 DepDb[F] = CurrentFileDependencyList
1139
1140             CurrentFilePath = F.Dir
1141             PathList = [CurrentFilePath] + SearchPathList
1142             for Inc in CurrentFileDependencyList:
1143                 for SearchPath in PathList:
1144                     FilePath = os.path.join(SearchPath, Inc)
1145                     if FilePath in gIsFileMap:
1146                         if not gIsFileMap[FilePath]:
1147                             continue
1148                     # If isfile is called too many times, the performance is slow down.
1149                     elif not os.path.isfile(FilePath):
1150                         gIsFileMap[FilePath] = False
1151                         continue
1152                     else:
1153                         gIsFileMap[FilePath] = True
1154                     FilePath = PathClass(FilePath)
1155                     FullPathDependList.append(FilePath)
1156                     if FilePath not in DependencySet:
1157                         FileStack.append(FilePath)
1158                     break
1159                 else:
1160                     EdkLogger.debug(EdkLogger.DEBUG_9, "%s included by %s was not found "\
1161                                     "in any given path:\n\t%s" % (Inc, F, "\n\t".join(SearchPathList)))
1162
1163             self.FileCache[F] = FullPathDependList
1164             DependencySet.update(FullPathDependList)
1165
1166         DependencySet.update(ForceList)
1167         if File in DependencySet:
1168             DependencySet.remove(File)
1169         DependencyList = list(DependencySet)  # remove duplicate ones
1170
1171         return DependencyList
1172
1173 ## CustomMakefile class
1174 #
1175 #  This class encapsules makefie and its generation for module. It uses template to generate
1176 #  the content of makefile. The content of makefile will be got from ModuleAutoGen object.
1177 #
1178 class CustomMakefile(BuildFile):
1179     ## template used to generate the makefile for module with custom makefile
1180     _TEMPLATE_ = TemplateString('''\
1181 ${makefile_header}
1182
1183 #
1184 # Platform Macro Definition
1185 #
1186 PLATFORM_NAME = ${platform_name}
1187 PLATFORM_GUID = ${platform_guid}
1188 PLATFORM_VERSION = ${platform_version}
1189 PLATFORM_RELATIVE_DIR = ${platform_relative_directory}
1190 PLATFORM_DIR = ${platform_dir}
1191 PLATFORM_OUTPUT_DIR = ${platform_output_directory}
1192
1193 #
1194 # Module Macro Definition
1195 #
1196 MODULE_NAME = ${module_name}
1197 MODULE_GUID = ${module_guid}
1198 MODULE_NAME_GUID = ${module_name_guid}
1199 MODULE_VERSION = ${module_version}
1200 MODULE_TYPE = ${module_type}
1201 MODULE_FILE = ${module_file}
1202 MODULE_FILE_BASE_NAME = ${module_file_base_name}
1203 BASE_NAME = $(MODULE_NAME)
1204 MODULE_RELATIVE_DIR = ${module_relative_directory}
1205 MODULE_DIR = ${module_dir}
1206
1207 #
1208 # Build Configuration Macro Definition
1209 #
1210 ARCH = ${architecture}
1211 TOOLCHAIN = ${toolchain_tag}
1212 TOOLCHAIN_TAG = ${toolchain_tag}
1213 TARGET = ${build_target}
1214
1215 #
1216 # Build Directory Macro Definition
1217 #
1218 # PLATFORM_BUILD_DIR = ${platform_build_directory}
1219 BUILD_DIR = ${platform_build_directory}
1220 BIN_DIR = $(BUILD_DIR)${separator}${architecture}
1221 LIB_DIR = $(BIN_DIR)
1222 MODULE_BUILD_DIR = ${module_build_directory}
1223 OUTPUT_DIR = ${module_output_directory}
1224 DEBUG_DIR = ${module_debug_directory}
1225 DEST_DIR_OUTPUT = $(OUTPUT_DIR)
1226 DEST_DIR_DEBUG = $(DEBUG_DIR)
1227
1228 #
1229 # Tools definitions specific to this module
1230 #
1231 ${BEGIN}${module_tool_definitions}
1232 ${END}
1233 MAKE_FILE = ${makefile_path}
1234
1235 #
1236 # Shell Command Macro
1237 #
1238 ${BEGIN}${shell_command_code} = ${shell_command}
1239 ${END}
1240
1241 ${custom_makefile_content}
1242
1243 #
1244 # Target used when called from platform makefile, which will bypass the build of dependent libraries
1245 #
1246
1247 pbuild: init all
1248
1249
1250 #
1251 # ModuleTarget
1252 #
1253
1254 mbuild: init all
1255
1256 #
1257 # Build Target used in multi-thread build mode, which no init target is needed
1258 #
1259
1260 tbuild: all
1261
1262 #
1263 # Initialization target: print build information and create necessary directories
1264 #
1265 init:
1266 \t-@echo Building ... $(MODULE_DIR)${separator}$(MODULE_FILE) [$(ARCH)]
1267 ${BEGIN}\t-@${create_directory_command}\n${END}\
1268
1269 ''')
1270
1271     ## Constructor of CustomMakefile
1272     #
1273     #   @param  ModuleAutoGen   Object of ModuleAutoGen class
1274     #
1275     def __init__(self, ModuleAutoGen):
1276         BuildFile.__init__(self, ModuleAutoGen)
1277         self.PlatformInfo = self._AutoGenObject.PlatformInfo
1278         self.IntermediateDirectoryList = ["$(DEBUG_DIR)", "$(OUTPUT_DIR)"]
1279
1280     # Compose a dict object containing information used to do replacement in template
1281     @property
1282     def _TemplateDict(self):
1283         Separator = self._SEP_[self._FileType]
1284         MyAgo = self._AutoGenObject
1285         if self._FileType not in MyAgo.CustomMakefile:
1286             EdkLogger.error('build', OPTION_NOT_SUPPORTED, "No custom makefile for %s" % self._FileType,
1287                             ExtraData="[%s]" % str(MyAgo))
1288         MakefilePath = mws.join(
1289                                 MyAgo.WorkspaceDir,
1290                                 MyAgo.CustomMakefile[self._FileType]
1291                                 )
1292         try:
1293             CustomMakefile = open(MakefilePath, 'r').read()
1294         except:
1295             EdkLogger.error('build', FILE_OPEN_FAILURE, File=str(MyAgo),
1296                             ExtraData=MyAgo.CustomMakefile[self._FileType])
1297
1298         # tools definitions
1299         ToolsDef = []
1300         for Tool in MyAgo.BuildOption:
1301             # Don't generate MAKE_FLAGS in makefile. It's put in environment variable.
1302             if Tool == "MAKE":
1303                 continue
1304             for Attr in MyAgo.BuildOption[Tool]:
1305                 if Attr == "FAMILY":
1306                     continue
1307                 elif Attr == "PATH":
1308                     ToolsDef.append("%s = %s" % (Tool, MyAgo.BuildOption[Tool][Attr]))
1309                 else:
1310                     ToolsDef.append("%s_%s = %s" % (Tool, Attr, MyAgo.BuildOption[Tool][Attr]))
1311             ToolsDef.append("")
1312
1313         MakefileName = self._FILE_NAME_[self._FileType]
1314         MakefileTemplateDict = {
1315             "makefile_header"           : self._FILE_HEADER_[self._FileType],
1316             "makefile_path"             : os.path.join("$(MODULE_BUILD_DIR)", MakefileName),
1317             "platform_name"             : self.PlatformInfo.Name,
1318             "platform_guid"             : self.PlatformInfo.Guid,
1319             "platform_version"          : self.PlatformInfo.Version,
1320             "platform_relative_directory": self.PlatformInfo.SourceDir,
1321             "platform_output_directory" : self.PlatformInfo.OutputDir,
1322             "platform_dir"              : MyAgo.Macros["PLATFORM_DIR"],
1323
1324             "module_name"               : MyAgo.Name,
1325             "module_guid"               : MyAgo.Guid,
1326             "module_name_guid"          : MyAgo.UniqueBaseName,
1327             "module_version"            : MyAgo.Version,
1328             "module_type"               : MyAgo.ModuleType,
1329             "module_file"               : MyAgo.MetaFile,
1330             "module_file_base_name"     : MyAgo.MetaFile.BaseName,
1331             "module_relative_directory" : MyAgo.SourceDir,
1332             "module_dir"                : mws.join (MyAgo.WorkspaceDir, MyAgo.SourceDir),
1333
1334             "architecture"              : MyAgo.Arch,
1335             "toolchain_tag"             : MyAgo.ToolChain,
1336             "build_target"              : MyAgo.BuildTarget,
1337
1338             "platform_build_directory"  : self.PlatformInfo.BuildDir,
1339             "module_build_directory"    : MyAgo.BuildDir,
1340             "module_output_directory"   : MyAgo.OutputDir,
1341             "module_debug_directory"    : MyAgo.DebugDir,
1342
1343             "separator"                 : Separator,
1344             "module_tool_definitions"   : ToolsDef,
1345
1346             "shell_command_code"        : list(self._SHELL_CMD_[self._FileType].keys()),
1347             "shell_command"             : list(self._SHELL_CMD_[self._FileType].values()),
1348
1349             "create_directory_command"  : self.GetCreateDirectoryCommand(self.IntermediateDirectoryList),
1350             "custom_makefile_content"   : CustomMakefile
1351         }
1352
1353         return MakefileTemplateDict
1354
1355 ## PlatformMakefile class
1356 #
1357 #  This class encapsules makefie and its generation for platform. It uses
1358 # template to generate the content of makefile. The content of makefile will be
1359 # got from PlatformAutoGen object.
1360 #
1361 class PlatformMakefile(BuildFile):
1362     ## template used to generate the makefile for platform
1363     _TEMPLATE_ = TemplateString('''\
1364 ${makefile_header}
1365
1366 #
1367 # Platform Macro Definition
1368 #
1369 PLATFORM_NAME = ${platform_name}
1370 PLATFORM_GUID = ${platform_guid}
1371 PLATFORM_VERSION = ${platform_version}
1372 PLATFORM_FILE = ${platform_file}
1373 PLATFORM_DIR = ${platform_dir}
1374 PLATFORM_OUTPUT_DIR = ${platform_output_directory}
1375
1376 #
1377 # Build Configuration Macro Definition
1378 #
1379 TOOLCHAIN = ${toolchain_tag}
1380 TOOLCHAIN_TAG = ${toolchain_tag}
1381 TARGET = ${build_target}
1382
1383 #
1384 # Build Directory Macro Definition
1385 #
1386 BUILD_DIR = ${platform_build_directory}
1387 FV_DIR = ${platform_build_directory}${separator}FV
1388
1389 #
1390 # Shell Command Macro
1391 #
1392 ${BEGIN}${shell_command_code} = ${shell_command}
1393 ${END}
1394
1395 MAKE = ${make_path}
1396 MAKE_FILE = ${makefile_path}
1397
1398 #
1399 # Default target
1400 #
1401 all: init build_libraries build_modules
1402
1403 #
1404 # Initialization target: print build information and create necessary directories
1405 #
1406 init:
1407 \t-@echo Building ... $(PLATFORM_FILE) [${build_architecture_list}]
1408 \t${BEGIN}-@${create_directory_command}
1409 \t${END}
1410 #
1411 # library build target
1412 #
1413 libraries: init build_libraries
1414
1415 #
1416 # module build target
1417 #
1418 modules: init build_libraries build_modules
1419
1420 #
1421 # Build all libraries:
1422 #
1423 build_libraries:
1424 ${BEGIN}\t@"$(MAKE)" $(MAKE_FLAGS) -f ${library_makefile_list} pbuild
1425 ${END}\t@cd $(BUILD_DIR)
1426
1427 #
1428 # Build all modules:
1429 #
1430 build_modules:
1431 ${BEGIN}\t@"$(MAKE)" $(MAKE_FLAGS) -f ${module_makefile_list} pbuild
1432 ${END}\t@cd $(BUILD_DIR)
1433
1434 #
1435 # Clean intermediate files
1436 #
1437 clean:
1438 \t${BEGIN}-@${library_build_command} clean
1439 \t${END}${BEGIN}-@${module_build_command} clean
1440 \t${END}@cd $(BUILD_DIR)
1441
1442 #
1443 # Clean all generated files except to makefile
1444 #
1445 cleanall:
1446 ${BEGIN}\t${cleanall_command}
1447 ${END}
1448
1449 #
1450 # Clean all library files
1451 #
1452 cleanlib:
1453 \t${BEGIN}-@${library_build_command} cleanall
1454 \t${END}@cd $(BUILD_DIR)\n
1455 ''')
1456
1457     ## Constructor of PlatformMakefile
1458     #
1459     #   @param  ModuleAutoGen   Object of PlatformAutoGen class
1460     #
1461     def __init__(self, PlatformAutoGen):
1462         BuildFile.__init__(self, PlatformAutoGen)
1463         self.ModuleBuildCommandList = []
1464         self.ModuleMakefileList = []
1465         self.IntermediateDirectoryList = []
1466         self.ModuleBuildDirectoryList = []
1467         self.LibraryBuildDirectoryList = []
1468         self.LibraryMakeCommandList = []
1469
1470     # Compose a dict object containing information used to do replacement in template
1471     @property
1472     def _TemplateDict(self):
1473         Separator = self._SEP_[self._FileType]
1474
1475         MyAgo = self._AutoGenObject
1476         if "MAKE" not in MyAgo.ToolDefinition or "PATH" not in MyAgo.ToolDefinition["MAKE"]:
1477             EdkLogger.error("build", OPTION_MISSING, "No MAKE command defined. Please check your tools_def.txt!",
1478                             ExtraData="[%s]" % str(MyAgo))
1479
1480         self.IntermediateDirectoryList = ["$(BUILD_DIR)"]
1481         self.ModuleBuildDirectoryList = self.GetModuleBuildDirectoryList()
1482         self.LibraryBuildDirectoryList = self.GetLibraryBuildDirectoryList()
1483
1484         MakefileName = self._FILE_NAME_[self._FileType]
1485         LibraryMakefileList = []
1486         LibraryMakeCommandList = []
1487         for D in self.LibraryBuildDirectoryList:
1488             D = self.PlaceMacro(D, {"BUILD_DIR":MyAgo.BuildDir})
1489             Makefile = os.path.join(D, MakefileName)
1490             Command = self._MAKE_TEMPLATE_[self._FileType] % {"file":Makefile}
1491             LibraryMakefileList.append(Makefile)
1492             LibraryMakeCommandList.append(Command)
1493         self.LibraryMakeCommandList = LibraryMakeCommandList
1494
1495         ModuleMakefileList = []
1496         ModuleMakeCommandList = []
1497         for D in self.ModuleBuildDirectoryList:
1498             D = self.PlaceMacro(D, {"BUILD_DIR":MyAgo.BuildDir})
1499             Makefile = os.path.join(D, MakefileName)
1500             Command = self._MAKE_TEMPLATE_[self._FileType] % {"file":Makefile}
1501             ModuleMakefileList.append(Makefile)
1502             ModuleMakeCommandList.append(Command)
1503
1504         MakefileTemplateDict = {
1505             "makefile_header"           : self._FILE_HEADER_[self._FileType],
1506             "makefile_path"             : os.path.join("$(BUILD_DIR)", MakefileName),
1507             "make_path"                 : MyAgo.ToolDefinition["MAKE"]["PATH"],
1508             "makefile_name"             : MakefileName,
1509             "platform_name"             : MyAgo.Name,
1510             "platform_guid"             : MyAgo.Guid,
1511             "platform_version"          : MyAgo.Version,
1512             "platform_file"             : MyAgo.MetaFile,
1513             "platform_relative_directory": MyAgo.SourceDir,
1514             "platform_output_directory" : MyAgo.OutputDir,
1515             "platform_build_directory"  : MyAgo.BuildDir,
1516             "platform_dir"              : MyAgo.Macros["PLATFORM_DIR"],
1517
1518             "toolchain_tag"             : MyAgo.ToolChain,
1519             "build_target"              : MyAgo.BuildTarget,
1520             "shell_command_code"        : list(self._SHELL_CMD_[self._FileType].keys()),
1521             "shell_command"             : list(self._SHELL_CMD_[self._FileType].values()),
1522             "build_architecture_list"   : MyAgo.Arch,
1523             "architecture"              : MyAgo.Arch,
1524             "separator"                 : Separator,
1525             "create_directory_command"  : self.GetCreateDirectoryCommand(self.IntermediateDirectoryList),
1526             "cleanall_command"          : self.GetRemoveDirectoryCommand(self.IntermediateDirectoryList),
1527             "library_makefile_list"     : LibraryMakefileList,
1528             "module_makefile_list"      : ModuleMakefileList,
1529             "library_build_command"     : LibraryMakeCommandList,
1530             "module_build_command"      : ModuleMakeCommandList,
1531         }
1532
1533         return MakefileTemplateDict
1534
1535     ## Get the root directory list for intermediate files of all modules build
1536     #
1537     #   @retval     list    The list of directory
1538     #
1539     def GetModuleBuildDirectoryList(self):
1540         DirList = []
1541         for ModuleAutoGen in self._AutoGenObject.ModuleAutoGenList:
1542             if not ModuleAutoGen.IsBinaryModule:
1543                 DirList.append(os.path.join(self._AutoGenObject.BuildDir, ModuleAutoGen.BuildDir))
1544         return DirList
1545
1546     ## Get the root directory list for intermediate files of all libraries build
1547     #
1548     #   @retval     list    The list of directory
1549     #
1550     def GetLibraryBuildDirectoryList(self):
1551         DirList = []
1552         for LibraryAutoGen in self._AutoGenObject.LibraryAutoGenList:
1553             if not LibraryAutoGen.IsBinaryModule and not LibraryAutoGen.CanSkipbyHash():
1554                 DirList.append(os.path.join(self._AutoGenObject.BuildDir, LibraryAutoGen.BuildDir))
1555         return DirList
1556
1557 ## TopLevelMakefile class
1558 #
1559 #  This class encapsules makefie and its generation for entrance makefile. It
1560 # uses template to generate the content of makefile. The content of makefile
1561 # will be got from WorkspaceAutoGen object.
1562 #
1563 class TopLevelMakefile(BuildFile):
1564     ## template used to generate toplevel makefile
1565     _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}''')
1566
1567     ## Constructor of TopLevelMakefile
1568     #
1569     #   @param  Workspace   Object of WorkspaceAutoGen class
1570     #
1571     def __init__(self, Workspace):
1572         BuildFile.__init__(self, Workspace)
1573         self.IntermediateDirectoryList = []
1574
1575     # Compose a dict object containing information used to do replacement in template
1576     @property
1577     def _TemplateDict(self):
1578         Separator = self._SEP_[self._FileType]
1579
1580         # any platform autogen object is ok because we just need common information
1581         MyAgo = self._AutoGenObject
1582
1583         if "MAKE" not in MyAgo.ToolDefinition or "PATH" not in MyAgo.ToolDefinition["MAKE"]:
1584             EdkLogger.error("build", OPTION_MISSING, "No MAKE command defined. Please check your tools_def.txt!",
1585                             ExtraData="[%s]" % str(MyAgo))
1586
1587         for Arch in MyAgo.ArchList:
1588             self.IntermediateDirectoryList.append(Separator.join(["$(BUILD_DIR)", Arch]))
1589         self.IntermediateDirectoryList.append("$(FV_DIR)")
1590
1591         # TRICK: for not generating GenFds call in makefile if no FDF file
1592         MacroList = []
1593         if MyAgo.FdfFile is not None and MyAgo.FdfFile != "":
1594             FdfFileList = [MyAgo.FdfFile]
1595             # macros passed to GenFds
1596             MacroDict = {}
1597             MacroDict.update(GlobalData.gGlobalDefines)
1598             MacroDict.update(GlobalData.gCommandLineDefines)
1599             for MacroName in MacroDict:
1600                 if MacroDict[MacroName] != "":
1601                     MacroList.append('"%s=%s"' % (MacroName, MacroDict[MacroName].replace('\\', '\\\\')))
1602                 else:
1603                     MacroList.append('"%s"' % MacroName)
1604         else:
1605             FdfFileList = []
1606
1607         # pass extra common options to external program called in makefile, currently GenFds.exe
1608         ExtraOption = ''
1609         LogLevel = EdkLogger.GetLevel()
1610         if LogLevel == EdkLogger.VERBOSE:
1611             ExtraOption += " -v"
1612         elif LogLevel <= EdkLogger.DEBUG_9:
1613             ExtraOption += " -d %d" % (LogLevel - 1)
1614         elif LogLevel == EdkLogger.QUIET:
1615             ExtraOption += " -q"
1616
1617         if GlobalData.gCaseInsensitive:
1618             ExtraOption += " -c"
1619         if GlobalData.gEnableGenfdsMultiThread:
1620             ExtraOption += " --genfds-multi-thread"
1621         if GlobalData.gIgnoreSource:
1622             ExtraOption += " --ignore-sources"
1623
1624         for pcd in GlobalData.BuildOptionPcd:
1625             if pcd[2]:
1626                 pcdname = '.'.join(pcd[0:3])
1627             else:
1628                 pcdname = '.'.join(pcd[0:2])
1629             if pcd[3].startswith('{'):
1630                 ExtraOption += " --pcd " + pcdname + '=' + 'H' + '"' + pcd[3] + '"'
1631             else:
1632                 ExtraOption += " --pcd " + pcdname + '=' + pcd[3]
1633
1634         MakefileName = self._FILE_NAME_[self._FileType]
1635         SubBuildCommandList = []
1636         for A in MyAgo.ArchList:
1637             Command = self._MAKE_TEMPLATE_[self._FileType] % {"file":os.path.join("$(BUILD_DIR)", A, MakefileName)}
1638             SubBuildCommandList.append(Command)
1639
1640         MakefileTemplateDict = {
1641             "makefile_header"           : self._FILE_HEADER_[self._FileType],
1642             "makefile_path"             : os.path.join("$(BUILD_DIR)", MakefileName),
1643             "make_path"                 : MyAgo.ToolDefinition["MAKE"]["PATH"],
1644             "platform_name"             : MyAgo.Name,
1645             "platform_guid"             : MyAgo.Guid,
1646             "platform_version"          : MyAgo.Version,
1647             "platform_build_directory"  : MyAgo.BuildDir,
1648             "conf_directory"            : GlobalData.gConfDirectory,
1649
1650             "toolchain_tag"             : MyAgo.ToolChain,
1651             "build_target"              : MyAgo.BuildTarget,
1652             "shell_command_code"        : list(self._SHELL_CMD_[self._FileType].keys()),
1653             "shell_command"             : list(self._SHELL_CMD_[self._FileType].values()),
1654             'arch'                      : list(MyAgo.ArchList),
1655             "build_architecture_list"   : ','.join(MyAgo.ArchList),
1656             "separator"                 : Separator,
1657             "create_directory_command"  : self.GetCreateDirectoryCommand(self.IntermediateDirectoryList),
1658             "cleanall_command"          : self.GetRemoveDirectoryCommand(self.IntermediateDirectoryList),
1659             "sub_build_command"         : SubBuildCommandList,
1660             "fdf_file"                  : FdfFileList,
1661             "active_platform"           : str(MyAgo),
1662             "fd"                        : MyAgo.FdTargetList,
1663             "fv"                        : MyAgo.FvTargetList,
1664             "cap"                       : MyAgo.CapTargetList,
1665             "extra_options"             : ExtraOption,
1666             "macro"                     : MacroList,
1667         }
1668
1669         return MakefileTemplateDict
1670
1671     ## Get the root directory list for intermediate files of all modules build
1672     #
1673     #   @retval     list    The list of directory
1674     #
1675     def GetModuleBuildDirectoryList(self):
1676         DirList = []
1677         for ModuleAutoGen in self._AutoGenObject.ModuleAutoGenList:
1678             if not ModuleAutoGen.IsBinaryModule:
1679                 DirList.append(os.path.join(self._AutoGenObject.BuildDir, ModuleAutoGen.BuildDir))
1680         return DirList
1681
1682     ## Get the root directory list for intermediate files of all libraries build
1683     #
1684     #   @retval     list    The list of directory
1685     #
1686     def GetLibraryBuildDirectoryList(self):
1687         DirList = []
1688         for LibraryAutoGen in self._AutoGenObject.LibraryAutoGenList:
1689             if not LibraryAutoGen.IsBinaryModule and not LibraryAutoGen.CanSkipbyHash():
1690                 DirList.append(os.path.join(self._AutoGenObject.BuildDir, LibraryAutoGen.BuildDir))
1691         return DirList
1692
1693 # This acts like the main() function for the script, unless it is 'import'ed into another script.
1694 if __name__ == '__main__':
1695     pass
1696