2 # Create makefile for MS nmake and GNU make
4 # Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>
5 # SPDX-License-Identifier: BSD-2-Clause-Patent
10 from __future__
import absolute_import
11 import Common
.LongFilePathOs
as os
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
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)
29 ## Regular expression for matching macro used in header file inclusion
30 gMacroPattern = re.compile("([_A
-Z
][_A
-Z0
-9]*)[ \t]*\
((.+)\
)", re.UNICODE)
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,
55 ## default makefile type
57 if sys.platform == "win32
":
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.
68 class BuildFile(object):
69 ## template used to generate the build file (i.e. makefile if using make)
70 _TEMPLATE_ = TemplateString('')
72 _DEFAULT_FILE_NAME_ = "Makefile
"
74 ## default file name for each type of build file
77 "gmake
" : "GNUmakefile
"
80 ## Fixed header string for makefile
81 _MAKEFILE_HEADER = '''#
83 # This file is auto-generated by build utility
91 # Auto-generated makefile for building modules, libraries or platform
95 ## Header string for each type of build file
97 "nmake
" : _MAKEFILE_HEADER % _FILE_NAME_["nmake
"],
98 "gmake
" : _MAKEFILE_HEADER % _FILE_NAME_["gmake
"]
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
114 "RD
" : "rmdir
/s
/q
",
126 ## directory separator
132 ## directory creation template
134 "nmake
" : 'if not exist %(dir)s $(MD) %(dir)s',
135 "gmake
" : "$
(MD
) %(dir)s"
138 ## directory removal template
140 "nmake
" : 'if exist %(dir)s $(RD) %(dir)s',
141 "gmake
" : "$
(RD
) %(dir)s"
145 "nmake
" : 'if exist %(Src)s $(CP) %(Src)s %(Dst)s',
146 "gmake
" : "test
-f
%(Src)s && $
(CP
) %(Src)s %(Dst)s"
150 "nmake
" : 'if exist %(dir)s cd %(dir)s',
151 "gmake
" : "test
-e
%(dir)s && cd
%(dir)s"
155 "nmake
" : 'if exist %(file)s "$
(MAKE
)" $(MAKE_FLAGS) -f %(file)s',
156 "gmake
" : 'test -e %(file)s && "$
(MAKE
)" $(MAKE_FLAGS) -f %(file)s'
160 "nmake
" : '!INCLUDE',
164 _INC_FLAG_ = {TAB_COMPILER_MSFT : "/I
", "GCC
" : "-I
", "INTEL
" : "-I
", "RVCT
" : "-I
", "NASM
" : "-I
"}
166 ## Constructor of BuildFile
168 # @param AutoGenObject Object of AutoGen class
170 def __init__(self, AutoGenObject):
171 self._AutoGenObject = AutoGenObject
172 self._FileType = gMakeType
176 # @param FileType Type of build file. Only nmake and gmake are supported now.
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
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)
190 ## Return a list of directory creation command string
192 # @param DirList The list of directory to be created
194 # @retval list The directory creation command list
196 def GetCreateDirectoryCommand(self, DirList):
197 return [self._MD_TEMPLATE_[self._FileType] % {'dir':Dir} for Dir in DirList]
199 ## Return a list of directory removal command string
201 # @param DirList The list of directory to be removed
203 # @retval list The directory removal command list
205 def GetRemoveDirectoryCommand(self, DirList):
206 return [self._RD_TEMPLATE_[self._FileType] % {'dir':Dir} for Dir in DirList]
208 def PlaceMacro(self, Path, MacroDefinitions={}):
209 if Path.startswith("$
("):
212 PathLength = len(Path)
213 for MacroName in MacroDefinitions:
214 MacroValue = MacroDefinitions[MacroName]
215 MacroValueLength = len(MacroValue)
216 if MacroValueLength == 0:
218 if MacroValueLength <= PathLength and Path.startswith(MacroValue):
219 Path = "$
(%s)%s" % (MacroName, Path[MacroValueLength:])
223 ## ModuleMakefile class
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.
228 class ModuleMakefile(BuildFile):
229 ## template used to generate the makefile for module
230 _TEMPLATE_ = TemplateString('''\
234 # Platform Macro Definition
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}
244 # Module Macro Definition
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}
259 MODULE_ENTRY_POINT = ${module_entry_point}
260 ARCH_ENTRY_POINT = ${arch_entry_point}
261 IMAGE_ENTRY_POINT = ${image_entry_point}
263 ${BEGIN}${module_extra_defines}
266 # Build Configuration Macro Definition
268 ARCH = ${architecture}
269 TOOLCHAIN = ${toolchain_tag}
270 TOOLCHAIN_TAG = ${toolchain_tag}
271 TARGET = ${build_target}
274 # Build Directory Macro Definition
276 # PLATFORM_BUILD_DIR = ${platform_build_directory}
277 BUILD_DIR = ${platform_build_directory}
278 BIN_DIR = $(BUILD_DIR)${separator}${architecture}
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)
287 # Shell Command Macro
289 ${BEGIN}${shell_command_code} = ${shell_command}
293 # Tools definitions specific to this module
295 ${BEGIN}${module_tool_definitions}
297 MAKE_FILE = ${makefile_path}
302 ${BEGIN}${file_macro}
305 COMMON_DEPS = ${BEGIN}${common_dependency_file} \\
309 # Overridable Target Macro Definitions
311 FORCE_REBUILD = force_build
314 BC_TARGET = ${BEGIN}${backward_compatible_target} ${END}
315 CODA_TARGET = ${BEGIN}${remaining_build_target} \\
319 # Default target, which will build dependent libraries in addition to source files
326 # Target used when called from platform makefile, which will bypass the build of dependent libraries
329 pbuild: $(INIT_TARGET) $(BC_TARGET) $(PCH_TARGET) $(CODA_TARGET)
335 mbuild: $(INIT_TARGET) $(BC_TARGET) gen_libs $(PCH_TARGET) $(CODA_TARGET)
338 # Build Target used in multi-thread build mode, which will bypass the init and gen_libs targets
341 tbuild: $(BC_TARGET) $(PCH_TARGET) $(CODA_TARGET)
344 # Phony target which is used to force executing commands for a target
350 # Target to update the FD
356 # Initialization target: print build information and create necessary directories
361 \t-@echo Building ... $(MODULE_DIR)${separator}$(MODULE_FILE) [$(ARCH)]
364 ${BEGIN}\t-@${create_directory_command}\n${END}
367 \t-@$(CP) $(DEBUG_DIR)${separator}AutoGen.h $(DEBUG_DIR)${separator}$(MODULE_NAME)StrDefs.h
373 \t${BEGIN}@"$
(MAKE
)" $(MAKE_FLAGS) -f ${dependent_library_build_directory}${separator}${makefile_name}
374 \t${END}@cd $(MODULE_BUILD_DIR)
377 # Build Flash Device Image
380 \t@"$
(MAKE
)" $(MAKE_FLAGS) -f $(BUILD_DIR)${separator}${makefile_name} fds
381 \t@cd $(MODULE_BUILD_DIR)
384 # Individual Object Build Targets
386 ${BEGIN}${file_build_target}
390 # clean all intermediate files
393 \t${BEGIN}${clean_command}
394 \t${END}\t$(RM) AutoGenTimeStamp
397 # clean all generated files
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
406 # clean all dependent libraries built
409 \t${BEGIN}-@${library_build_command} cleanall
410 \t${END}@cd $(MODULE_BUILD_DIR)\n\n''')
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")
415 ## Constructor of ModuleMakefile
417 # @param ModuleAutoGen Object of ModuleAutoGen class
419 def __init__(self, ModuleAutoGen):
420 BuildFile.__init__(self, ModuleAutoGen)
421 self.PlatformInfo = self._AutoGenObject.PlatformInfo
423 self.ResultFileList = []
424 self.IntermediateDirectoryList = ["$
(DEBUG_DIR
)", "$
(OUTPUT_DIR
)"]
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 = OrderedDict()
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 = []
451 # Compose a dict object containing information used to do replacement in template
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]
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))
466 # convert dependent libraries to build command
467 self.ProcessDependentLibrary()
468 if len(MyAgo.Module.ModuleEntryPointList) > 0:
469 ModuleEntryPoint = MyAgo.Module.ModuleEntryPointList[0]
471 ModuleEntryPoint = "_ModuleEntryPoint
"
473 ArchEntryPoint = ModuleEntryPoint
475 if MyAgo.Arch == "EBC
":
476 # EBC compiler always use "EfiStart
" as entry point. Only applies to EdkII modules
477 ImageEntryPoint = "EfiStart
"
479 # EdkII modules always use "_ModuleEntryPoint
" as entry point
480 ImageEntryPoint = "_ModuleEntryPoint
"
482 for k, v in MyAgo.Module.Defines.items():
483 if k not in MyAgo.Macros:
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
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
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]
507 ToolsDef.append("%s = %s" % (Tool, Value))
509 # Don't generate MAKE_FLAGS in makefile. It's put in environment variable.
512 # Remove duplicated include path, if any
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()
521 for i, v in enumerate(ValueList):
524 Value = ' '.join(ValueList)
526 ToolsDef.append("%s_%s = %s" % (Tool, Attr, Value))
529 # generate the Response file and Response flag
530 RespDict = self.CommandExceedLimit()
531 RespFileList = os.path.join(MyAgo.OutputDir, 'respfilelist.txt')
533 RespFileListContent = ''
534 for Resp in RespDict:
535 RespFile = os.path.join(MyAgo.OutputDir, str(Resp).lower() + '.txt')
536 StrList = RespDict[Resp].split(' ')
541 UnexpandMacro.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)
552 if os.path.exists(RespFileList):
553 os.remove(RespFileList)
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))
561 self.ProcessBuildTargetList()
562 self.ParserGenerateFfsCmd()
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(
569 "macro_name
" : FileListMacro,
570 "source_file
" : self.FileListMacros[FileListMacro]
573 FileMacroList.append(FileMacro)
575 # INC_LIST is special
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(
584 "macro_name
" : "INC
",
585 "source_file
" : IncludePathList
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'):
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])
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}))
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))
614 "\n".join(self.ListFileMacros[ListFileMacro]),
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))
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)
631 package_rel_dir = MyAgo.SourceDir
632 current_dir = self.Macros["WORKSPACE
"]
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'):
642 package_rel_dir = package_rel_dir[index + 1:]
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
"],
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()],
668 "architecture
" : MyAgo.Arch,
669 "toolchain_tag
" : MyAgo.ToolChain,
670 "build_target
" : MyAgo.BuildTarget,
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,
677 "separator
" : Separator,
678 "module_tool_definitions
" : ToolsDef,
680 "shell_command_code
" : list(self._SHELL_CMD_[self._FileType].keys()),
681 "shell_command
" : list(self._SHELL_CMD_[self._FileType].values()),
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,
698 return MakefileTemplateDict
700 def ParserGenerateFfsCmd(self):
701 #Add Ffs cmd to self.BuildTargetList
705 for Cmd in self.GenFfsList:
707 for CopyCmd in Cmd[2]:
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})
718 for index, Str in enumerate(FfsCmdList):
720 OutputFile = FfsCmdList[index + 1]
721 if '-i' == Str or "-oi
" == Str:
722 if DepsFileList == []:
723 DepsFileList = [FfsCmdList[index + 1]]
725 DepsFileList.append(FfsCmdList[index + 1])
726 DepsFileString = ' '.join(DepsFileList).strip()
727 if DepsFileString == '':
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)
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 = []
743 def ParseSecCmd(self, OutputFileList, CmdTuple):
744 for OutputFile in OutputFileList:
745 for SecCmdStr in CmdTuple:
747 SecCmdList = SecCmdStr.split()
748 CmdName = SecCmdList[0]
749 for index, CmdItem in enumerate(SecCmdList):
750 if '-o' == CmdItem and OutputFile == SecCmdList[index + 1]:
752 while index + 1 < len(SecCmdList):
753 if not SecCmdList[index+1].startswith('-'):
754 SecDepsFileList.append(SecCmdList[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)
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 + ')')
773 def CommandExceedLimit(self):
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},
786 IncPrefix = self._INC_FLAG_[self._AutoGenObject.ToolChainFamily]
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)
795 # calculate the command-line length
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:
803 SingleCommandLength = len(SingleCommand)
804 SingleCommandList = SingleCommand.split()
805 if len(SingleCommandList) > 0:
806 for Flag in FlagDict:
807 if '$('+ Flag +')' in SingleCommandList[0]:
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])
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:
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])
848 SingleCommandLength += len(Str)
850 if SingleCommandLength > GlobalData.gCommandMaxLength:
851 FlagDict[Tool]['Value'] = True
853 # generate the response file content by combine the FLAGS and INC
854 for Flag in FlagDict:
855 if FlagDict[Flag]['Value']:
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])
874 if self._AutoGenObject.ToolChainFamily == 'GCC':
875 RespDict[Key] = Value.replace('\\', '/')
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)
884 def ProcessBuildTargetList(self):
886 # Search dependency file list for each source file
888 ForceIncludedFile = []
889 for File in self._AutoGenObject.AutoGenFileList:
891 ForceIncludedFile.append(File)
894 for Target in self._AutoGenObject.IntroTargetList:
895 SourceFileList.extend(Target.Inputs)
896 OutPutFileList.extend(Target.Outputs)
899 for Item in OutPutFileList:
900 if Item in SourceFileList:
901 SourceFileList.remove(Item)
903 FileDependencyDict = self.GetFileDependency(
906 self._AutoGenObject.IncludePathList + self._AutoGenObject.BuildOptionIncPathList
909 for File,Dependency in FileDependencyDict.items():
911 FileDependencyDict[File] = ['$(FORCE_REBUILD)']
914 self._AutoGenObject.AutoGenDepSet |= set(Dependency)
917 if File.Ext not in [".c
", ".C
"] or File.Name == "AutoGen
.c
":
920 DepSet = set(Dependency)
922 DepSet &= set(Dependency)
923 # in case nothing in SourceFileList
927 # Extract common files list in the dependency files
930 self.CommonFileDependency.append(self.PlaceMacro(File.Path, self.Macros))
935 DependencyDict = FileDependencyDict.copy()
936 for File in FileDependencyDict:
938 if File.Ext not in [".c
", ".C
"] or File.Name == "AutoGen
.c
":
940 NewDepSet = set(FileDependencyDict[File])
942 FileDependencyDict[File] = ["$
(COMMON_DEPS
)"] + list(NewDepSet)
943 DependencyDict[File] = list(NewDepSet)
945 # Convert target description object to target string in makefile
946 if self._AutoGenObject.BuildRuleFamily == TAB_COMPILER_MSFT and TAB_C_CODE_FILE in self._AutoGenObject.Targets:
947 for T in self._AutoGenObject.Targets[TAB_C_CODE_FILE]:
948 NewFile = self.PlaceMacro(str(T), self.Macros)
949 if not self.ObjTargetDict.get(T.Target.SubDir):
950 self.ObjTargetDict[T.Target.SubDir] = set()
951 self.ObjTargetDict[T.Target.SubDir].add(NewFile)
952 for Type in self._AutoGenObject.Targets:
953 for T in self._AutoGenObject.Targets[Type]:
954 # Generate related macros if needed
955 if T.GenFileListMacro and T.FileListMacro not in self.FileListMacros:
956 self.FileListMacros[T.FileListMacro] = []
957 if T.GenListFile and T.ListFileMacro not in self.ListFileMacros:
958 self.ListFileMacros[T.ListFileMacro] = []
959 if T.GenIncListFile and T.IncListFileMacro not in self.ListFileMacros:
960 self.ListFileMacros[T.IncListFileMacro] = []
964 # Add force-dependencies
965 for Dep in T.Dependencies:
966 Deps.append(self.PlaceMacro(str(Dep), self.Macros))
967 if Dep != '$(MAKE_FILE)':
968 CCodeDeps.append(self.PlaceMacro(str(Dep), self.Macros))
969 # Add inclusion-dependencies
970 if len(T.Inputs) == 1 and T.Inputs[0] in FileDependencyDict:
971 for F in FileDependencyDict[T.Inputs[0]]:
972 Deps.append(self.PlaceMacro(str(F), self.Macros))
973 # Add source-dependencies
975 NewFile = self.PlaceMacro(str(F), self.Macros)
976 # In order to use file list macro as dependency
978 # gnu tools need forward slash path separator, even on Windows
979 self.ListFileMacros[T.ListFileMacro].append(str(F).replace ('\\', '/'))
980 self.FileListMacros[T.FileListMacro].append(NewFile)
981 elif T.GenFileListMacro:
982 self.FileListMacros[T.FileListMacro].append(NewFile)
986 # Use file list macro as dependency
987 if T.GenFileListMacro:
988 Deps.append("$
(%s)" % T.FileListMacro)
989 if Type in [TAB_OBJECT_FILE, TAB_STATIC_LIBRARY]:
990 Deps.append("$
(%s)" % T.ListFileMacro)
992 if self._AutoGenObject.BuildRuleFamily == TAB_COMPILER_MSFT and Type == TAB_C_CODE_FILE:
993 T, CmdTarget, CmdTargetDict, CmdCppDict = self.ParserCCodeFile(T, Type, CmdSumDict, CmdTargetDict, CmdCppDict, DependencyDict)
994 TargetDict = {"target
": self.PlaceMacro(T.Target.Path, self.Macros), "cmd
": "\n\t".join(T.Commands),"deps
": CCodeDeps}
995 CmdLine = self._BUILD_TARGET_TEMPLATE.Replace(TargetDict).rstrip().replace('\t$(OBJLIST', '$(OBJLIST')
997 CmdLine = '%s%s' %(CmdLine, TAB_LINE_BREAK)
998 if CCodeDeps or CmdLine:
999 self.BuildTargetList.append(CmdLine)
1001 TargetDict = {"target
": self.PlaceMacro(T.Target.Path, self.Macros), "cmd
": "\n\t".join(T.Commands),"deps
": Deps}
1002 self.BuildTargetList.append(self._BUILD_TARGET_TEMPLATE.Replace(TargetDict))
1004 def ParserCCodeFile(self, T, Type, CmdSumDict, CmdTargetDict, CmdCppDict, DependencyDict):
1006 for item in self._AutoGenObject.Targets[Type]:
1007 CmdSumDict[item.Target.SubDir] = item.Target.BaseName
1008 for CppPath in item.Inputs:
1009 Path = self.PlaceMacro(CppPath.Path, self.Macros)
1010 if CmdCppDict.get(item.Target.SubDir):
1011 CmdCppDict[item.Target.SubDir].append(Path)
1013 CmdCppDict[item.Target.SubDir] = ['$(MAKE_FILE)', Path]
1014 if CppPath.Path in DependencyDict:
1015 for Temp in DependencyDict[CppPath.Path]:
1017 Path = self.PlaceMacro(Temp.Path, self.Macros)
1020 if Path not in (self.CommonFileDependency + CmdCppDict[item.Target.SubDir]):
1021 CmdCppDict[item.Target.SubDir].append(Path)
1023 CommandList = T.Commands[:]
1024 for Item in CommandList[:]:
1025 SingleCommandList = Item.split()
1026 if len(SingleCommandList) > 0 and self.CheckCCCmd(SingleCommandList):
1027 for Temp in SingleCommandList:
1028 if Temp.startswith('/Fo'):
1029 CmdSign = '%s%s' % (Temp.rsplit(TAB_SLASH, 1)[0], TAB_SLASH)
1032 if CmdSign not in list(CmdTargetDict.keys()):
1033 CmdTargetDict[CmdSign] = Item.replace(Temp, CmdSign)
1035 CmdTargetDict[CmdSign] = "%s %s" % (CmdTargetDict[CmdSign], SingleCommandList[-1])
1036 Index = CommandList.index(Item)
1037 CommandList.pop(Index)
1038 if SingleCommandList[-1].endswith("%s%s.c
" % (TAB_SLASH, CmdSumDict[CmdSign.lstrip('/Fo').rsplit(TAB_SLASH, 1)[0]])):
1039 Cpplist = CmdCppDict[T.Target.SubDir]
1040 Cpplist.insert(0, '$(OBJLIST_%d): $(COMMON_DEPS)' % list(self.ObjTargetDict.keys()).index(T.Target.SubDir))
1041 T.Commands[Index] = '%s\n\t%s' % (' \\\n\t'.join(Cpplist), CmdTargetDict[CmdSign])
1043 T.Commands.pop(Index)
1044 return T, CmdSumDict, CmdTargetDict, CmdCppDict
1046 def CheckCCCmd(self, CommandList):
1047 for cmd in CommandList:
1051 ## For creating makefile targets for dependent libraries
1052 def ProcessDependentLibrary(self):
1053 for LibraryAutoGen in self._AutoGenObject.LibraryAutoGenList:
1054 if not LibraryAutoGen.IsBinaryModule and not LibraryAutoGen.CanSkipbyHash():
1055 self.LibraryBuildDirectoryList.append(self.PlaceMacro(LibraryAutoGen.BuildDir, self.Macros))
1057 ## Return a list containing source file's dependencies
1059 # @param FileList The list of source files
1060 # @param ForceInculeList The list of files which will be included forcely
1061 # @param SearchPathList The list of search path
1063 # @retval dict The mapping between source file path and its dependencies
1065 def GetFileDependency(self, FileList, ForceInculeList, SearchPathList):
1068 Dependency[F] = self.GetDependencyList(F, ForceInculeList, SearchPathList)
1071 ## Find dependencies for one source file
1073 # By searching recursively "#include" directive in file, find out all the
1074 # files needed by given source file. The dependencies will be only searched
1075 # in given search path list.
1077 # @param File The source file
1078 # @param ForceInculeList The list of files which will be included forcely
1079 # @param SearchPathList The list of search path
1081 # @retval list The list of files the given source file depends on
1083 def GetDependencyList(self
, File
, ForceList
, SearchPathList
):
1084 EdkLogger
.debug(EdkLogger
.DEBUG_1
, "Try to get dependency files for %s" % File
)
1085 FileStack
= [File
] + ForceList
1086 DependencySet
= set()
1088 if self
._AutoGenObject
.Arch
not in gDependencyDatabase
:
1089 gDependencyDatabase
[self
._AutoGenObject
.Arch
] = {}
1090 DepDb
= gDependencyDatabase
[self
._AutoGenObject
.Arch
]
1092 while len(FileStack
) > 0:
1095 FullPathDependList
= []
1096 if F
in self
.FileCache
:
1097 for CacheFile
in self
.FileCache
[F
]:
1098 FullPathDependList
.append(CacheFile
)
1099 if CacheFile
not in DependencySet
:
1100 FileStack
.append(CacheFile
)
1101 DependencySet
.update(FullPathDependList
)
1104 CurrentFileDependencyList
= []
1106 CurrentFileDependencyList
= DepDb
[F
]
1109 Fd
= open(F
.Path
, 'rb')
1110 FileContent
= Fd
.read()
1112 except BaseException
as X
:
1113 EdkLogger
.error("build", FILE_OPEN_FAILURE
, ExtraData
=F
.Path
+ "\n\t" + str(X
))
1114 if len(FileContent
) == 0:
1117 if FileContent
[0] == 0xff or FileContent
[0] == 0xfe:
1118 FileContent
= FileContent
.decode('utf-16')
1120 FileContent
= FileContent
.decode()
1122 # The file is not txt file. for example .mcb file
1124 IncludedFileList
= gIncludePattern
.findall(FileContent
)
1126 for Inc
in IncludedFileList
:
1128 # if there's macro used to reference header file, expand it
1129 HeaderList
= gMacroPattern
.findall(Inc
)
1130 if len(HeaderList
) == 1 and len(HeaderList
[0]) == 2:
1131 HeaderType
= HeaderList
[0][0]
1132 HeaderKey
= HeaderList
[0][1]
1133 if HeaderType
in gIncludeMacroConversion
:
1134 Inc
= gIncludeMacroConversion
[HeaderType
] % {"HeaderKey" : HeaderKey
}
1136 # not known macro used in #include, always build the file by
1137 # returning a empty dependency
1138 self
.FileCache
[File
] = []
1140 Inc
= os
.path
.normpath(Inc
)
1141 CurrentFileDependencyList
.append(Inc
)
1142 DepDb
[F
] = CurrentFileDependencyList
1144 CurrentFilePath
= F
.Dir
1145 PathList
= [CurrentFilePath
] + SearchPathList
1146 for Inc
in CurrentFileDependencyList
:
1147 for SearchPath
in PathList
:
1148 FilePath
= os
.path
.join(SearchPath
, Inc
)
1149 if FilePath
in gIsFileMap
:
1150 if not gIsFileMap
[FilePath
]:
1152 # If isfile is called too many times, the performance is slow down.
1153 elif not os
.path
.isfile(FilePath
):
1154 gIsFileMap
[FilePath
] = False
1157 gIsFileMap
[FilePath
] = True
1158 FilePath
= PathClass(FilePath
)
1159 FullPathDependList
.append(FilePath
)
1160 if FilePath
not in DependencySet
:
1161 FileStack
.append(FilePath
)
1164 EdkLogger
.debug(EdkLogger
.DEBUG_9
, "%s included by %s was not found "\
1165 "in any given path:\n\t%s" % (Inc
, F
, "\n\t".join(SearchPathList
)))
1167 self
.FileCache
[F
] = FullPathDependList
1168 DependencySet
.update(FullPathDependList
)
1170 DependencySet
.update(ForceList
)
1171 if File
in DependencySet
:
1172 DependencySet
.remove(File
)
1173 DependencyList
= list(DependencySet
) # remove duplicate ones
1175 return DependencyList
1177 ## CustomMakefile class
1179 # This class encapsules makefie and its generation for module. It uses template to generate
1180 # the content of makefile. The content of makefile will be got from ModuleAutoGen object.
1182 class CustomMakefile(BuildFile
):
1183 ## template used to generate the makefile for module with custom makefile
1184 _TEMPLATE_
= TemplateString('''\
1188 # Platform Macro Definition
1190 PLATFORM_NAME = ${platform_name}
1191 PLATFORM_GUID = ${platform_guid}
1192 PLATFORM_VERSION = ${platform_version}
1193 PLATFORM_RELATIVE_DIR = ${platform_relative_directory}
1194 PLATFORM_DIR = ${platform_dir}
1195 PLATFORM_OUTPUT_DIR = ${platform_output_directory}
1198 # Module Macro Definition
1200 MODULE_NAME = ${module_name}
1201 MODULE_GUID = ${module_guid}
1202 MODULE_NAME_GUID = ${module_name_guid}
1203 MODULE_VERSION = ${module_version}
1204 MODULE_TYPE = ${module_type}
1205 MODULE_FILE = ${module_file}
1206 MODULE_FILE_BASE_NAME = ${module_file_base_name}
1207 BASE_NAME = $(MODULE_NAME)
1208 MODULE_RELATIVE_DIR = ${module_relative_directory}
1209 MODULE_DIR = ${module_dir}
1212 # Build Configuration Macro Definition
1214 ARCH = ${architecture}
1215 TOOLCHAIN = ${toolchain_tag}
1216 TOOLCHAIN_TAG = ${toolchain_tag}
1217 TARGET = ${build_target}
1220 # Build Directory Macro Definition
1222 # PLATFORM_BUILD_DIR = ${platform_build_directory}
1223 BUILD_DIR = ${platform_build_directory}
1224 BIN_DIR = $(BUILD_DIR)${separator}${architecture}
1225 LIB_DIR = $(BIN_DIR)
1226 MODULE_BUILD_DIR = ${module_build_directory}
1227 OUTPUT_DIR = ${module_output_directory}
1228 DEBUG_DIR = ${module_debug_directory}
1229 DEST_DIR_OUTPUT = $(OUTPUT_DIR)
1230 DEST_DIR_DEBUG = $(DEBUG_DIR)
1233 # Tools definitions specific to this module
1235 ${BEGIN}${module_tool_definitions}
1237 MAKE_FILE = ${makefile_path}
1240 # Shell Command Macro
1242 ${BEGIN}${shell_command_code} = ${shell_command}
1245 ${custom_makefile_content}
1248 # Target used when called from platform makefile, which will bypass the build of dependent libraries
1261 # Build Target used in multi-thread build mode, which no init target is needed
1267 # Initialization target: print build information and create necessary directories
1270 \t-@echo Building ... $(MODULE_DIR)${separator}$(MODULE_FILE) [$(ARCH)]
1271 ${BEGIN}\t-@${create_directory_command}\n${END}\
1275 ## Constructor of CustomMakefile
1277 # @param ModuleAutoGen Object of ModuleAutoGen class
1279 def __init__(self
, ModuleAutoGen
):
1280 BuildFile
.__init
__(self
, ModuleAutoGen
)
1281 self
.PlatformInfo
= self
._AutoGenObject
.PlatformInfo
1282 self
.IntermediateDirectoryList
= ["$(DEBUG_DIR)", "$(OUTPUT_DIR)"]
1284 # Compose a dict object containing information used to do replacement in template
1286 def _TemplateDict(self
):
1287 Separator
= self
._SEP
_[self
._FileType
]
1288 MyAgo
= self
._AutoGenObject
1289 if self
._FileType
not in MyAgo
.CustomMakefile
:
1290 EdkLogger
.error('build', OPTION_NOT_SUPPORTED
, "No custom makefile for %s" % self
._FileType
,
1291 ExtraData
="[%s]" % str(MyAgo
))
1292 MakefilePath
= mws
.join(
1294 MyAgo
.CustomMakefile
[self
._FileType
]
1297 CustomMakefile
= open(MakefilePath
, 'r').read()
1299 EdkLogger
.error('build', FILE_OPEN_FAILURE
, File
=str(MyAgo
),
1300 ExtraData
=MyAgo
.CustomMakefile
[self
._FileType
])
1304 for Tool
in MyAgo
.BuildOption
:
1305 # Don't generate MAKE_FLAGS in makefile. It's put in environment variable.
1308 for Attr
in MyAgo
.BuildOption
[Tool
]:
1309 if Attr
== "FAMILY":
1311 elif Attr
== "PATH":
1312 ToolsDef
.append("%s = %s" % (Tool
, MyAgo
.BuildOption
[Tool
][Attr
]))
1314 ToolsDef
.append("%s_%s = %s" % (Tool
, Attr
, MyAgo
.BuildOption
[Tool
][Attr
]))
1317 MakefileName
= self
._FILE
_NAME
_[self
._FileType
]
1318 MakefileTemplateDict
= {
1319 "makefile_header" : self
._FILE
_HEADER
_[self
._FileType
],
1320 "makefile_path" : os
.path
.join("$(MODULE_BUILD_DIR)", MakefileName
),
1321 "platform_name" : self
.PlatformInfo
.Name
,
1322 "platform_guid" : self
.PlatformInfo
.Guid
,
1323 "platform_version" : self
.PlatformInfo
.Version
,
1324 "platform_relative_directory": self
.PlatformInfo
.SourceDir
,
1325 "platform_output_directory" : self
.PlatformInfo
.OutputDir
,
1326 "platform_dir" : MyAgo
.Macros
["PLATFORM_DIR"],
1328 "module_name" : MyAgo
.Name
,
1329 "module_guid" : MyAgo
.Guid
,
1330 "module_name_guid" : MyAgo
.UniqueBaseName
,
1331 "module_version" : MyAgo
.Version
,
1332 "module_type" : MyAgo
.ModuleType
,
1333 "module_file" : MyAgo
.MetaFile
,
1334 "module_file_base_name" : MyAgo
.MetaFile
.BaseName
,
1335 "module_relative_directory" : MyAgo
.SourceDir
,
1336 "module_dir" : mws
.join (MyAgo
.WorkspaceDir
, MyAgo
.SourceDir
),
1338 "architecture" : MyAgo
.Arch
,
1339 "toolchain_tag" : MyAgo
.ToolChain
,
1340 "build_target" : MyAgo
.BuildTarget
,
1342 "platform_build_directory" : self
.PlatformInfo
.BuildDir
,
1343 "module_build_directory" : MyAgo
.BuildDir
,
1344 "module_output_directory" : MyAgo
.OutputDir
,
1345 "module_debug_directory" : MyAgo
.DebugDir
,
1347 "separator" : Separator
,
1348 "module_tool_definitions" : ToolsDef
,
1350 "shell_command_code" : list(self
._SHELL
_CMD
_[self
._FileType
].keys()),
1351 "shell_command" : list(self
._SHELL
_CMD
_[self
._FileType
].values()),
1353 "create_directory_command" : self
.GetCreateDirectoryCommand(self
.IntermediateDirectoryList
),
1354 "custom_makefile_content" : CustomMakefile
1357 return MakefileTemplateDict
1359 ## PlatformMakefile class
1361 # This class encapsules makefie and its generation for platform. It uses
1362 # template to generate the content of makefile. The content of makefile will be
1363 # got from PlatformAutoGen object.
1365 class PlatformMakefile(BuildFile
):
1366 ## template used to generate the makefile for platform
1367 _TEMPLATE_
= TemplateString('''\
1371 # Platform Macro Definition
1373 PLATFORM_NAME = ${platform_name}
1374 PLATFORM_GUID = ${platform_guid}
1375 PLATFORM_VERSION = ${platform_version}
1376 PLATFORM_FILE = ${platform_file}
1377 PLATFORM_DIR = ${platform_dir}
1378 PLATFORM_OUTPUT_DIR = ${platform_output_directory}
1381 # Build Configuration Macro Definition
1383 TOOLCHAIN = ${toolchain_tag}
1384 TOOLCHAIN_TAG = ${toolchain_tag}
1385 TARGET = ${build_target}
1388 # Build Directory Macro Definition
1390 BUILD_DIR = ${platform_build_directory}
1391 FV_DIR = ${platform_build_directory}${separator}FV
1394 # Shell Command Macro
1396 ${BEGIN}${shell_command_code} = ${shell_command}
1400 MAKE_FILE = ${makefile_path}
1405 all: init build_libraries build_modules
1408 # Initialization target: print build information and create necessary directories
1411 \t-@echo Building ... $(PLATFORM_FILE) [${build_architecture_list}]
1412 \t${BEGIN}-@${create_directory_command}
1415 # library build target
1417 libraries: init build_libraries
1420 # module build target
1422 modules: init build_libraries build_modules
1425 # Build all libraries:
1428 ${BEGIN}\t@"$(MAKE)" $(MAKE_FLAGS) -f ${library_makefile_list} pbuild
1429 ${END}\t@cd $(BUILD_DIR)
1432 # Build all modules:
1435 ${BEGIN}\t@"$(MAKE)" $(MAKE_FLAGS) -f ${module_makefile_list} pbuild
1436 ${END}\t@cd $(BUILD_DIR)
1439 # Clean intermediate files
1442 \t${BEGIN}-@${library_build_command} clean
1443 \t${END}${BEGIN}-@${module_build_command} clean
1444 \t${END}@cd $(BUILD_DIR)
1447 # Clean all generated files except to makefile
1450 ${BEGIN}\t${cleanall_command}
1454 # Clean all library files
1457 \t${BEGIN}-@${library_build_command} cleanall
1458 \t${END}@cd $(BUILD_DIR)\n
1461 ## Constructor of PlatformMakefile
1463 # @param ModuleAutoGen Object of PlatformAutoGen class
1465 def __init__(self
, PlatformAutoGen
):
1466 BuildFile
.__init
__(self
, PlatformAutoGen
)
1467 self
.ModuleBuildCommandList
= []
1468 self
.ModuleMakefileList
= []
1469 self
.IntermediateDirectoryList
= []
1470 self
.ModuleBuildDirectoryList
= []
1471 self
.LibraryBuildDirectoryList
= []
1472 self
.LibraryMakeCommandList
= []
1474 # Compose a dict object containing information used to do replacement in template
1476 def _TemplateDict(self
):
1477 Separator
= self
._SEP
_[self
._FileType
]
1479 MyAgo
= self
._AutoGenObject
1480 if "MAKE" not in MyAgo
.ToolDefinition
or "PATH" not in MyAgo
.ToolDefinition
["MAKE"]:
1481 EdkLogger
.error("build", OPTION_MISSING
, "No MAKE command defined. Please check your tools_def.txt!",
1482 ExtraData
="[%s]" % str(MyAgo
))
1484 self
.IntermediateDirectoryList
= ["$(BUILD_DIR)"]
1485 self
.ModuleBuildDirectoryList
= self
.GetModuleBuildDirectoryList()
1486 self
.LibraryBuildDirectoryList
= self
.GetLibraryBuildDirectoryList()
1488 MakefileName
= self
._FILE
_NAME
_[self
._FileType
]
1489 LibraryMakefileList
= []
1490 LibraryMakeCommandList
= []
1491 for D
in self
.LibraryBuildDirectoryList
:
1492 D
= self
.PlaceMacro(D
, {"BUILD_DIR":MyAgo
.BuildDir
})
1493 Makefile
= os
.path
.join(D
, MakefileName
)
1494 Command
= self
._MAKE
_TEMPLATE
_[self
._FileType
] % {"file":Makefile
}
1495 LibraryMakefileList
.append(Makefile
)
1496 LibraryMakeCommandList
.append(Command
)
1497 self
.LibraryMakeCommandList
= LibraryMakeCommandList
1499 ModuleMakefileList
= []
1500 ModuleMakeCommandList
= []
1501 for D
in self
.ModuleBuildDirectoryList
:
1502 D
= self
.PlaceMacro(D
, {"BUILD_DIR":MyAgo
.BuildDir
})
1503 Makefile
= os
.path
.join(D
, MakefileName
)
1504 Command
= self
._MAKE
_TEMPLATE
_[self
._FileType
] % {"file":Makefile
}
1505 ModuleMakefileList
.append(Makefile
)
1506 ModuleMakeCommandList
.append(Command
)
1508 MakefileTemplateDict
= {
1509 "makefile_header" : self
._FILE
_HEADER
_[self
._FileType
],
1510 "makefile_path" : os
.path
.join("$(BUILD_DIR)", MakefileName
),
1511 "make_path" : MyAgo
.ToolDefinition
["MAKE"]["PATH"],
1512 "makefile_name" : MakefileName
,
1513 "platform_name" : MyAgo
.Name
,
1514 "platform_guid" : MyAgo
.Guid
,
1515 "platform_version" : MyAgo
.Version
,
1516 "platform_file" : MyAgo
.MetaFile
,
1517 "platform_relative_directory": MyAgo
.SourceDir
,
1518 "platform_output_directory" : MyAgo
.OutputDir
,
1519 "platform_build_directory" : MyAgo
.BuildDir
,
1520 "platform_dir" : MyAgo
.Macros
["PLATFORM_DIR"],
1522 "toolchain_tag" : MyAgo
.ToolChain
,
1523 "build_target" : MyAgo
.BuildTarget
,
1524 "shell_command_code" : list(self
._SHELL
_CMD
_[self
._FileType
].keys()),
1525 "shell_command" : list(self
._SHELL
_CMD
_[self
._FileType
].values()),
1526 "build_architecture_list" : MyAgo
.Arch
,
1527 "architecture" : MyAgo
.Arch
,
1528 "separator" : Separator
,
1529 "create_directory_command" : self
.GetCreateDirectoryCommand(self
.IntermediateDirectoryList
),
1530 "cleanall_command" : self
.GetRemoveDirectoryCommand(self
.IntermediateDirectoryList
),
1531 "library_makefile_list" : LibraryMakefileList
,
1532 "module_makefile_list" : ModuleMakefileList
,
1533 "library_build_command" : LibraryMakeCommandList
,
1534 "module_build_command" : ModuleMakeCommandList
,
1537 return MakefileTemplateDict
1539 ## Get the root directory list for intermediate files of all modules build
1541 # @retval list The list of directory
1543 def GetModuleBuildDirectoryList(self
):
1545 for ModuleAutoGen
in self
._AutoGenObject
.ModuleAutoGenList
:
1546 if not ModuleAutoGen
.IsBinaryModule
:
1547 DirList
.append(os
.path
.join(self
._AutoGenObject
.BuildDir
, ModuleAutoGen
.BuildDir
))
1550 ## Get the root directory list for intermediate files of all libraries build
1552 # @retval list The list of directory
1554 def GetLibraryBuildDirectoryList(self
):
1556 for LibraryAutoGen
in self
._AutoGenObject
.LibraryAutoGenList
:
1557 if not LibraryAutoGen
.IsBinaryModule
and not LibraryAutoGen
.CanSkipbyHash():
1558 DirList
.append(os
.path
.join(self
._AutoGenObject
.BuildDir
, LibraryAutoGen
.BuildDir
))
1561 ## TopLevelMakefile class
1563 # This class encapsules makefie and its generation for entrance makefile. It
1564 # uses template to generate the content of makefile. The content of makefile
1565 # will be got from WorkspaceAutoGen object.
1567 class TopLevelMakefile(BuildFile
):
1568 ## template used to generate toplevel makefile
1569 _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}''')
1571 ## Constructor of TopLevelMakefile
1573 # @param Workspace Object of WorkspaceAutoGen class
1575 def __init__(self
, Workspace
):
1576 BuildFile
.__init
__(self
, Workspace
)
1577 self
.IntermediateDirectoryList
= []
1579 # Compose a dict object containing information used to do replacement in template
1581 def _TemplateDict(self
):
1582 Separator
= self
._SEP
_[self
._FileType
]
1584 # any platform autogen object is ok because we just need common information
1585 MyAgo
= self
._AutoGenObject
1587 if "MAKE" not in MyAgo
.ToolDefinition
or "PATH" not in MyAgo
.ToolDefinition
["MAKE"]:
1588 EdkLogger
.error("build", OPTION_MISSING
, "No MAKE command defined. Please check your tools_def.txt!",
1589 ExtraData
="[%s]" % str(MyAgo
))
1591 for Arch
in MyAgo
.ArchList
:
1592 self
.IntermediateDirectoryList
.append(Separator
.join(["$(BUILD_DIR)", Arch
]))
1593 self
.IntermediateDirectoryList
.append("$(FV_DIR)")
1595 # TRICK: for not generating GenFds call in makefile if no FDF file
1597 if MyAgo
.FdfFile
is not None and MyAgo
.FdfFile
!= "":
1598 FdfFileList
= [MyAgo
.FdfFile
]
1599 # macros passed to GenFds
1601 MacroDict
.update(GlobalData
.gGlobalDefines
)
1602 MacroDict
.update(GlobalData
.gCommandLineDefines
)
1603 for MacroName
in MacroDict
:
1604 if MacroDict
[MacroName
] != "":
1605 MacroList
.append('"%s=%s"' % (MacroName
, MacroDict
[MacroName
].replace('\\', '\\\\')))
1607 MacroList
.append('"%s"' % MacroName
)
1611 # pass extra common options to external program called in makefile, currently GenFds.exe
1613 LogLevel
= EdkLogger
.GetLevel()
1614 if LogLevel
== EdkLogger
.VERBOSE
:
1615 ExtraOption
+= " -v"
1616 elif LogLevel
<= EdkLogger
.DEBUG_9
:
1617 ExtraOption
+= " -d %d" % (LogLevel
- 1)
1618 elif LogLevel
== EdkLogger
.QUIET
:
1619 ExtraOption
+= " -q"
1621 if GlobalData
.gCaseInsensitive
:
1622 ExtraOption
+= " -c"
1623 if GlobalData
.gEnableGenfdsMultiThread
:
1624 ExtraOption
+= " --genfds-multi-thread"
1625 if GlobalData
.gIgnoreSource
:
1626 ExtraOption
+= " --ignore-sources"
1628 for pcd
in GlobalData
.BuildOptionPcd
:
1630 pcdname
= '.'.join(pcd
[0:3])
1632 pcdname
= '.'.join(pcd
[0:2])
1633 if pcd
[3].startswith('{'):
1634 ExtraOption
+= " --pcd " + pcdname
+ '=' + 'H' + '"' + pcd
[3] + '"'
1636 ExtraOption
+= " --pcd " + pcdname
+ '=' + pcd
[3]
1638 MakefileName
= self
._FILE
_NAME
_[self
._FileType
]
1639 SubBuildCommandList
= []
1640 for A
in MyAgo
.ArchList
:
1641 Command
= self
._MAKE
_TEMPLATE
_[self
._FileType
] % {"file":os
.path
.join("$(BUILD_DIR)", A
, MakefileName
)}
1642 SubBuildCommandList
.append(Command
)
1644 MakefileTemplateDict
= {
1645 "makefile_header" : self
._FILE
_HEADER
_[self
._FileType
],
1646 "makefile_path" : os
.path
.join("$(BUILD_DIR)", MakefileName
),
1647 "make_path" : MyAgo
.ToolDefinition
["MAKE"]["PATH"],
1648 "platform_name" : MyAgo
.Name
,
1649 "platform_guid" : MyAgo
.Guid
,
1650 "platform_version" : MyAgo
.Version
,
1651 "platform_build_directory" : MyAgo
.BuildDir
,
1652 "conf_directory" : GlobalData
.gConfDirectory
,
1654 "toolchain_tag" : MyAgo
.ToolChain
,
1655 "build_target" : MyAgo
.BuildTarget
,
1656 "shell_command_code" : list(self
._SHELL
_CMD
_[self
._FileType
].keys()),
1657 "shell_command" : list(self
._SHELL
_CMD
_[self
._FileType
].values()),
1658 'arch' : list(MyAgo
.ArchList
),
1659 "build_architecture_list" : ','.join(MyAgo
.ArchList
),
1660 "separator" : Separator
,
1661 "create_directory_command" : self
.GetCreateDirectoryCommand(self
.IntermediateDirectoryList
),
1662 "cleanall_command" : self
.GetRemoveDirectoryCommand(self
.IntermediateDirectoryList
),
1663 "sub_build_command" : SubBuildCommandList
,
1664 "fdf_file" : FdfFileList
,
1665 "active_platform" : str(MyAgo
),
1666 "fd" : MyAgo
.FdTargetList
,
1667 "fv" : MyAgo
.FvTargetList
,
1668 "cap" : MyAgo
.CapTargetList
,
1669 "extra_options" : ExtraOption
,
1670 "macro" : MacroList
,
1673 return MakefileTemplateDict
1675 ## Get the root directory list for intermediate files of all modules build
1677 # @retval list The list of directory
1679 def GetModuleBuildDirectoryList(self
):
1681 for ModuleAutoGen
in self
._AutoGenObject
.ModuleAutoGenList
:
1682 if not ModuleAutoGen
.IsBinaryModule
:
1683 DirList
.append(os
.path
.join(self
._AutoGenObject
.BuildDir
, ModuleAutoGen
.BuildDir
))
1686 ## Get the root directory list for intermediate files of all libraries build
1688 # @retval list The list of directory
1690 def GetLibraryBuildDirectoryList(self
):
1692 for LibraryAutoGen
in self
._AutoGenObject
.LibraryAutoGenList
:
1693 if not LibraryAutoGen
.IsBinaryModule
and not LibraryAutoGen
.CanSkipbyHash():
1694 DirList
.append(os
.path
.join(self
._AutoGenObject
.BuildDir
, LibraryAutoGen
.BuildDir
))
1697 # This acts like the main() function for the script, unless it is 'import'ed into another script.
1698 if __name__
== '__main__':