]> git.proxmox.com Git - mirror_edk2.git/blame - BaseTools/Source/Python/AutoGen/GenMake.py
Sync EDKII BaseTools to BaseTools project r1971
[mirror_edk2.git] / BaseTools / Source / Python / AutoGen / GenMake.py
CommitLineData
30fdf114
LG
1## @file
2# Create makefile for MS nmake and GNU make
3#
40d841f6
LG
4# Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved.<BR>
5# This program and the accompanying materials
30fdf114
LG
6# are licensed and made available under the terms and conditions of the BSD License
7# which accompanies this distribution. The full text of the license may be found at
8# http://opensource.org/licenses/bsd-license.php
9#
10# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
12#
13
14## Import Modules
15#
16import os
17import sys
18import string
19import re
20import os.path as path
21
22from Common.BuildToolError import *
23from Common.Misc import *
24from Common.String import *
25from BuildEngine import *
26import Common.GlobalData as GlobalData
27
28## Regular expression for finding header file inclusions
636f2be6 29gIncludePattern = re.compile(r"^[ \t]*#?[ \t]*include(?:[ \t]*(?:\\(?:\r\n|\r|\n))*[ \t]*)*(?:[\"<]?[ \t]*)([\w.\\/]+)(?:[ \t]*[\">]?)", re.MULTILINE|re.UNICODE)
30fdf114
LG
30
31## Regular expression for matching macro used in header file inclusion
32gMacroPattern = re.compile("([_A-Z][_A-Z0-9]*)[ \t]*\((.+)\)", re.UNICODE)
33
34## pattern for include style in R8.x code
35gProtocolDefinition = "Protocol/%(HeaderKey)s/%(HeaderKey)s.h"
36gGuidDefinition = "Guid/%(HeaderKey)s/%(HeaderKey)s.h"
37gArchProtocolDefinition = "ArchProtocol/%(HeaderKey)s/%(HeaderKey)s.h"
38gPpiDefinition = "Ppi/%(HeaderKey)s/%(HeaderKey)s.h"
39gIncludeMacroConversion = {
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
56gMakeType = ""
57if sys.platform == "win32":
58 gMakeType = "nmake"
59else:
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#
68class 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
144 _CD_TEMPLATE_ = {
145 "nmake" : 'if exist %(dir)s cd %(dir)s',
146 "gmake" : "test -e %(dir)s && cd %(dir)s"
147 }
148
149 _MAKE_TEMPLATE_ = {
150 "nmake" : 'if exist %(file)s "$(MAKE)" $(MAKE_FLAGS) -f %(file)s',
151 "gmake" : 'test -e %(file)s && "$(MAKE)" $(MAKE_FLAGS) -f %(file)s'
152 }
153
154 _INCLUDE_CMD_ = {
155 "nmake" : '!INCLUDE',
156 "gmake" : "include"
157 }
158
159 _INC_FLAG_ = {"MSFT" : "/I", "GCC" : "-I", "INTEL" : "-I", "RVCT" : "-I"}
160
161 ## Constructor of BuildFile
162 #
163 # @param AutoGenObject Object of AutoGen class
164 #
165 def __init__(self, AutoGenObject):
166 self._AutoGenObject = AutoGenObject
167 self._FileType = gMakeType
168
169 ## Create build file
170 #
171 # @param FileType Type of build file. Only nmake and gmake are supported now.
172 #
173 # @retval TRUE The build file is created or re-created successfully
174 # @retval FALSE The build file exists and is the same as the one to be generated
175 #
176 def Generate(self, FileType=gMakeType):
177 if FileType not in self._FILE_NAME_:
178 EdkLogger.error("build", PARAMETER_INVALID, "Invalid build type [%s]" % FileType,
179 ExtraData="[%s]" % str(self._AutoGenObject))
180 self._FileType = FileType
181 FileContent = self._TEMPLATE_.Replace(self._TemplateDict)
182 FileName = self._FILE_NAME_[FileType]
183 return SaveFileOnChange(os.path.join(self._AutoGenObject.MakeFileDir, FileName), FileContent, False)
184
185 ## Return a list of directory creation command string
186 #
187 # @param DirList The list of directory to be created
188 #
189 # @retval list The directory creation command list
190 #
191 def GetCreateDirectoryCommand(self, DirList):
192 return [self._MD_TEMPLATE_[self._FileType] % {'dir':Dir} for Dir in DirList]
193
194 ## Return a list of directory removal command string
195 #
196 # @param DirList The list of directory to be removed
197 #
198 # @retval list The directory removal command list
199 #
200 def GetRemoveDirectoryCommand(self, DirList):
201 return [self._RD_TEMPLATE_[self._FileType] % {'dir':Dir} for Dir in DirList]
202
203 def PlaceMacro(self, Path, MacroDefinitions={}):
204 if Path.startswith("$("):
205 return Path
206 else:
207 PathLength = len(Path)
208 for MacroName in MacroDefinitions:
209 MacroValue = MacroDefinitions[MacroName]
210 MacroValueLength = len(MacroValue)
211 if MacroValueLength <= PathLength and Path.startswith(MacroValue):
212 Path = "$(%s)%s" % (MacroName, Path[MacroValueLength:])
213 break
214 return Path
215
216## ModuleMakefile class
217#
218# This class encapsules makefie and its generation for module. It uses template to generate
219# the content of makefile. The content of makefile will be got from ModuleAutoGen object.
220#
221class ModuleMakefile(BuildFile):
222 ## template used to generate the makefile for module
223 _TEMPLATE_ = TemplateString('''\
224${makefile_header}
225
226#
227# Platform Macro Definition
228#
229PLATFORM_NAME = ${platform_name}
230PLATFORM_GUID = ${platform_guid}
231PLATFORM_VERSION = ${platform_version}
232PLATFORM_RELATIVE_DIR = ${platform_relative_directory}
233PLATFORM_DIR = $(WORKSPACE)${separator}${platform_relative_directory}
234PLATFORM_OUTPUT_DIR = ${platform_output_directory}
235
236#
237# Module Macro Definition
238#
239MODULE_NAME = ${module_name}
240MODULE_GUID = ${module_guid}
241MODULE_VERSION = ${module_version}
242MODULE_TYPE = ${module_type}
243MODULE_FILE = ${module_file}
244MODULE_FILE_BASE_NAME = ${module_file_base_name}
245BASE_NAME = $(MODULE_NAME)
246MODULE_RELATIVE_DIR = ${module_relative_directory}
247MODULE_DIR = $(WORKSPACE)${separator}${module_relative_directory}
248
249MODULE_ENTRY_POINT = ${module_entry_point}
250ARCH_ENTRY_POINT = ${arch_entry_point}
251IMAGE_ENTRY_POINT = ${image_entry_point}
252
253${BEGIN}${module_extra_defines}
254${END}
255#
256# Build Configuration Macro Definition
257#
258ARCH = ${architecture}
259TOOLCHAIN = ${toolchain_tag}
260TOOLCHAIN_TAG = ${toolchain_tag}
261TARGET = ${build_target}
262
263#
264# Build Directory Macro Definition
265#
266# PLATFORM_BUILD_DIR = ${platform_build_directory}
267BUILD_DIR = ${platform_build_directory}
268BIN_DIR = $(BUILD_DIR)${separator}${architecture}
269LIB_DIR = $(BIN_DIR)
270MODULE_BUILD_DIR = ${module_build_directory}
271OUTPUT_DIR = ${module_output_directory}
272DEBUG_DIR = ${module_debug_directory}
273DEST_DIR_OUTPUT = $(OUTPUT_DIR)
274DEST_DIR_DEBUG = $(DEBUG_DIR)
275
276#
277# Shell Command Macro
278#
279${BEGIN}${shell_command_code} = ${shell_command}
280${END}
281
282#
283# Tools definitions specific to this module
284#
285${BEGIN}${module_tool_definitions}
286${END}
287MAKE_FILE = ${makefile_path}
288
289#
290# Build Macro
291#
292${BEGIN}${file_macro}
293${END}
294
295COMMON_DEPS = ${BEGIN}${common_dependency_file} \\
296 ${END}
297
298#
299# Overridable Target Macro Definitions
300#
301FORCE_REBUILD = force_build
302INIT_TARGET = init
303PCH_TARGET =
304BC_TARGET = ${BEGIN}${backward_compatible_target} ${END}
305CODA_TARGET = ${BEGIN}${remaining_build_target} \\
306 ${END}
307
308#
309# Default target, which will build dependent libraries in addition to source files
310#
311
312all: mbuild
313
314
315#
316# Target used when called from platform makefile, which will bypass the build of dependent libraries
317#
318
319pbuild: $(INIT_TARGET) $(BC_TARGET) $(PCH_TARGET) $(CODA_TARGET)
320
321#
322# ModuleTarget
323#
324
325mbuild: $(INIT_TARGET) $(BC_TARGET) gen_libs $(PCH_TARGET) $(CODA_TARGET)
326
327#
328# Build Target used in multi-thread build mode, which will bypass the init and gen_libs targets
329#
330
331tbuild: $(BC_TARGET) $(PCH_TARGET) $(CODA_TARGET)
332
333#
334# Phony target which is used to force executing commands for a target
335#
336force_build:
337\t-@
338
339#
340# Target to update the FD
341#
342
343fds: mbuild gen_fds
344
345#
346# Initialization target: print build information and create necessary directories
347#
348init: info dirs
349
350info:
351\t-@echo Building ... $(MODULE_DIR)${separator}$(MODULE_FILE) [$(ARCH)]
352
353dirs:
354${BEGIN}\t-@${create_directory_command}\n${END}
355
356strdefs:
357\t-@$(CP) $(DEBUG_DIR)${separator}AutoGen.h $(DEBUG_DIR)${separator}$(MODULE_NAME)StrDefs.h
358
359#
360# GenLibsTarget
361#
362gen_libs:
363\t${BEGIN}@"$(MAKE)" $(MAKE_FLAGS) -f ${dependent_library_build_directory}${separator}${makefile_name}
364\t${END}@cd $(MODULE_BUILD_DIR)
365
366#
367# Build Flash Device Image
368#
369gen_fds:
370\t@"$(MAKE)" $(MAKE_FLAGS) -f $(BUILD_DIR)${separator}${makefile_name} fds
371\t@cd $(MODULE_BUILD_DIR)
372
373#
374# Individual Object Build Targets
375#
376${BEGIN}${file_build_target}
377${END}
378
379#
380# clean all intermediate files
381#
382clean:
383\t${BEGIN}${clean_command}
384\t${END}
385
386#
387# clean all generated files
388#
389cleanall:
390${BEGIN}\t${cleanall_command}
391${END}\t$(RM) *.pdb *.idb > NUL 2>&1
392\t$(RM) $(BIN_DIR)${separator}$(MODULE_NAME).efi
393
394#
395# clean all dependent libraries built
396#
397cleanlib:
398\t${BEGIN}-@${library_build_command} cleanall
399\t${END}@cd $(MODULE_BUILD_DIR)\n\n''')
400
401 _FILE_MACRO_TEMPLATE = TemplateString("${macro_name} = ${BEGIN} \\\n ${source_file}${END}\n")
402 _BUILD_TARGET_TEMPLATE = TemplateString("${BEGIN}${target} : ${deps}\n${END}\t${cmd}\n")
403
404 ## Constructor of ModuleMakefile
405 #
406 # @param ModuleAutoGen Object of ModuleAutoGen class
407 #
408 def __init__(self, ModuleAutoGen):
409 BuildFile.__init__(self, ModuleAutoGen)
410 self.PlatformInfo = self._AutoGenObject.PlatformInfo
411
412 self.ResultFileList = []
413 self.IntermediateDirectoryList = ["$(DEBUG_DIR)", "$(OUTPUT_DIR)"]
414
415 self.SourceFileDatabase = {} # {file type : file path}
416 self.DestFileDatabase = {} # {file type : file path}
417 self.FileBuildTargetList = [] # [(src, target string)]
418 self.BuildTargetList = [] # [target string]
419 self.PendingBuildTargetList = [] # [FileBuildRule objects]
420 self.CommonFileDependency = []
421 self.FileListMacros = {}
422 self.ListFileMacros = {}
423
424 self.FileDependency = []
425 self.LibraryBuildCommandList = []
426 self.LibraryFileList = []
427 self.LibraryMakefileList = []
428 self.LibraryBuildDirectoryList = []
429 self.SystemLibraryList = []
430 self.Macros = sdict()
431 self.Macros["OUTPUT_DIR" ] = self._AutoGenObject.Macros["OUTPUT_DIR"]
432 self.Macros["DEBUG_DIR" ] = self._AutoGenObject.Macros["DEBUG_DIR"]
433 self.Macros["MODULE_BUILD_DIR"] = self._AutoGenObject.Macros["MODULE_BUILD_DIR"]
434 self.Macros["BIN_DIR" ] = self._AutoGenObject.Macros["BIN_DIR"]
435 self.Macros["BUILD_DIR" ] = self._AutoGenObject.Macros["BUILD_DIR"]
436 self.Macros["WORKSPACE" ] = self._AutoGenObject.Macros["WORKSPACE"]
437
438 # Compose a dict object containing information used to do replacement in template
439 def _CreateTemplateDict(self):
440 if self._FileType not in self._SEP_:
441 EdkLogger.error("build", PARAMETER_INVALID, "Invalid Makefile type [%s]" % self._FileType,
442 ExtraData="[%s]" % str(self._AutoGenObject))
443 Separator = self._SEP_[self._FileType]
444
445 # break build if no source files and binary files are found
446 if len(self._AutoGenObject.SourceFileList) == 0 and len(self._AutoGenObject.BinaryFileList) == 0:
447 EdkLogger.error("build", AUTOGEN_ERROR, "No files to be built in module [%s, %s, %s]"
448 % (self._AutoGenObject.BuildTarget, self._AutoGenObject.ToolChain, self._AutoGenObject.Arch),
449 ExtraData="[%s]" % str(self._AutoGenObject))
450
451 # convert dependent libaries to build command
452 self.ProcessDependentLibrary()
453 if len(self._AutoGenObject.Module.ModuleEntryPointList) > 0:
454 ModuleEntryPoint = self._AutoGenObject.Module.ModuleEntryPointList[0]
455 else:
456 ModuleEntryPoint = "_ModuleEntryPoint"
457
458 # Intel EBC compiler enforces EfiMain
459 if self._AutoGenObject.AutoGenVersion < 0x00010005 and self._AutoGenObject.Arch == "EBC":
460 ArchEntryPoint = "EfiMain"
461 else:
462 ArchEntryPoint = ModuleEntryPoint
463
464 if self._AutoGenObject.Arch == "EBC":
465 # EBC compiler always use "EfiStart" as entry point. Only applies to R9 modules
466 ImageEntryPoint = "EfiStart"
467 elif self._AutoGenObject.AutoGenVersion < 0x00010005:
468 # R8 modules use entry point specified in INF file
469 ImageEntryPoint = ModuleEntryPoint
470 else:
471 # R9 modules always use "_ModuleEntryPoint" as entry point
472 ImageEntryPoint = "_ModuleEntryPoint"
473
474 # tools definitions
475 ToolsDef = []
476 IncPrefix = self._INC_FLAG_[self._AutoGenObject.ToolChainFamily]
477 for Tool in self._AutoGenObject.BuildOption:
478 for Attr in self._AutoGenObject.BuildOption[Tool]:
479 Value = self._AutoGenObject.BuildOption[Tool][Attr]
480 if Attr == "FAMILY":
481 continue
482 elif Attr == "PATH":
483 ToolsDef.append("%s = %s" % (Tool, Value))
484 else:
485 # Don't generate MAKE_FLAGS in makefile. It's put in environment variable.
486 if Tool == "MAKE":
487 continue
488 # Remove duplicated include path, if any
489 if Attr == "FLAGS":
490 Value = RemoveDupOption(Value, IncPrefix, self._AutoGenObject.IncludePathList)
491 ToolsDef.append("%s_%s = %s" % (Tool, Attr, Value))
492 ToolsDef.append("")
493
494 # convert source files and binary files to build targets
495 self.ResultFileList = [str(T.Target) for T in self._AutoGenObject.CodaTargetList]
496 if len(self.ResultFileList) == 0:
497 EdkLogger.error("build", AUTOGEN_ERROR, "Nothing to build",
498 ExtraData="[%s]" % str(self._AutoGenObject))
499
500 self.ProcessBuildTargetList()
501
502 # Generate macros used to represent input files
503 FileMacroList = [] # macro name = file list
504 for FileListMacro in self.FileListMacros:
505 FileMacro = self._FILE_MACRO_TEMPLATE.Replace(
506 {
507 "macro_name" : FileListMacro,
508 "source_file" : self.FileListMacros[FileListMacro]
509 }
510 )
511 FileMacroList.append(FileMacro)
512
513 # INC_LIST is special
514 FileMacro = ""
515 IncludePathList = []
516 for P in self._AutoGenObject.IncludePathList:
517 IncludePathList.append(IncPrefix+self.PlaceMacro(P, self.Macros))
518 if FileBuildRule.INC_LIST_MACRO in self.ListFileMacros:
519 self.ListFileMacros[FileBuildRule.INC_LIST_MACRO].append(IncPrefix+P)
520 FileMacro += self._FILE_MACRO_TEMPLATE.Replace(
521 {
522 "macro_name" : "INC",
523 "source_file" : IncludePathList
524 }
525 )
526 FileMacroList.append(FileMacro)
527
528 # Generate macros used to represent files containing list of input files
529 for ListFileMacro in self.ListFileMacros:
530 ListFileName = os.path.join(self._AutoGenObject.OutputDir, "%s.lst" % ListFileMacro.lower()[:len(ListFileMacro)-5])
531 FileMacroList.append("%s = %s" % (ListFileMacro, ListFileName))
532 SaveFileOnChange(
533 ListFileName,
534 "\n".join(self.ListFileMacros[ListFileMacro]),
535 False
536 )
537
538 # R8 modules need <BaseName>StrDefs.h for string ID
539 #if self._AutoGenObject.AutoGenVersion < 0x00010005 and len(self._AutoGenObject.UnicodeFileList) > 0:
540 # BcTargetList = ['strdefs']
541 #else:
542 # BcTargetList = []
543 BcTargetList = []
544
545 MakefileName = self._FILE_NAME_[self._FileType]
546 LibraryMakeCommandList = []
547 for D in self.LibraryBuildDirectoryList:
548 Command = self._MAKE_TEMPLATE_[self._FileType] % {"file":os.path.join(D, MakefileName)}
549 LibraryMakeCommandList.append(Command)
550
551 MakefileTemplateDict = {
552 "makefile_header" : self._FILE_HEADER_[self._FileType],
553 "makefile_path" : os.path.join("$(MODULE_BUILD_DIR)", MakefileName),
554 "makefile_name" : MakefileName,
555 "platform_name" : self.PlatformInfo.Name,
556 "platform_guid" : self.PlatformInfo.Guid,
557 "platform_version" : self.PlatformInfo.Version,
558 "platform_relative_directory": self.PlatformInfo.SourceDir,
559 "platform_output_directory" : self.PlatformInfo.OutputDir,
560
561 "module_name" : self._AutoGenObject.Name,
562 "module_guid" : self._AutoGenObject.Guid,
563 "module_version" : self._AutoGenObject.Version,
564 "module_type" : self._AutoGenObject.ModuleType,
565 "module_file" : self._AutoGenObject.MetaFile.Name,
566 "module_file_base_name" : self._AutoGenObject.MetaFile.BaseName,
567 "module_relative_directory" : self._AutoGenObject.SourceDir,
568 "module_extra_defines" : ["%s = %s" % (k, v) for k,v in self._AutoGenObject.Module.Defines.iteritems()],
569
570 "architecture" : self._AutoGenObject.Arch,
571 "toolchain_tag" : self._AutoGenObject.ToolChain,
572 "build_target" : self._AutoGenObject.BuildTarget,
573
574 "platform_build_directory" : self.PlatformInfo.BuildDir,
575 "module_build_directory" : self._AutoGenObject.BuildDir,
576 "module_output_directory" : self._AutoGenObject.OutputDir,
577 "module_debug_directory" : self._AutoGenObject.DebugDir,
578
579 "separator" : Separator,
580 "module_tool_definitions" : ToolsDef,
581
582 "shell_command_code" : self._SHELL_CMD_[self._FileType].keys(),
583 "shell_command" : self._SHELL_CMD_[self._FileType].values(),
584
585 "module_entry_point" : ModuleEntryPoint,
586 "image_entry_point" : ImageEntryPoint,
587 "arch_entry_point" : ArchEntryPoint,
588 "remaining_build_target" : self.ResultFileList,
589 "common_dependency_file" : self.CommonFileDependency,
590 "create_directory_command" : self.GetCreateDirectoryCommand(self.IntermediateDirectoryList),
591 "clean_command" : self.GetRemoveDirectoryCommand(["$(OUTPUT_DIR)"]),
592 "cleanall_command" : self.GetRemoveDirectoryCommand(["$(DEBUG_DIR)", "$(OUTPUT_DIR)"]),
593 "dependent_library_build_directory" : self.LibraryBuildDirectoryList,
594 "library_build_command" : LibraryMakeCommandList,
595 "file_macro" : FileMacroList,
596 "file_build_target" : self.BuildTargetList,
597 "backward_compatible_target": BcTargetList,
598 }
599
600 return MakefileTemplateDict
601
602 def ProcessBuildTargetList(self):
603 #
604 # Search dependency file list for each source file
605 #
606 ForceIncludedFile = []
607 for File in self._AutoGenObject.AutoGenFileList:
608 if File.Ext == '.h':
609 ForceIncludedFile.append(File)
610 SourceFileList = []
611 for Target in self._AutoGenObject.IntroTargetList:
612 SourceFileList.extend(Target.Inputs)
613
614 self.FileDependency = self.GetFileDependency(
615 SourceFileList,
616 ForceIncludedFile,
617 self._AutoGenObject.IncludePathList
618 )
619 DepSet = None
620 for File in self.FileDependency:
621 if not self.FileDependency[File]:
622 self.FileDependency[File] = ['$(FORCE_REBUILD)']
623 continue
624 # skip non-C files
625 if File.Ext not in [".c", ".C"] or File.Name == "AutoGen.c":
626 continue
627 elif DepSet == None:
628 DepSet = set(self.FileDependency[File])
629 else:
630 DepSet &= set(self.FileDependency[File])
631 # in case nothing in SourceFileList
632 if DepSet == None:
633 DepSet = set()
634 #
635 # Extract comman files list in the dependency files
636 #
637 for File in DepSet:
638 self.CommonFileDependency.append(self.PlaceMacro(File.Path, self.Macros))
639
640 for File in self.FileDependency:
641 # skip non-C files
642 if File.Ext not in [".c", ".C"] or File.Name == "AutoGen.c":
643 continue
644 NewDepSet = set(self.FileDependency[File])
645 NewDepSet -= DepSet
646 self.FileDependency[File] = ["$(COMMON_DEPS)"] + list(NewDepSet)
647
648 # Convert target description object to target string in makefile
649 for Type in self._AutoGenObject.Targets:
650 for T in self._AutoGenObject.Targets[Type]:
651 # Generate related macros if needed
652 if T.GenFileListMacro and T.FileListMacro not in self.FileListMacros:
653 self.FileListMacros[T.FileListMacro] = []
654 if T.GenListFile and T.ListFileMacro not in self.ListFileMacros:
655 self.ListFileMacros[T.ListFileMacro] = []
656 if T.GenIncListFile and T.IncListFileMacro not in self.ListFileMacros:
657 self.ListFileMacros[T.IncListFileMacro] = []
658
659 Deps = []
660 # Add force-dependencies
661 for Dep in T.Dependencies:
662 Deps.append(self.PlaceMacro(str(Dep), self.Macros))
663 # Add inclusion-dependencies
664 if len(T.Inputs) == 1 and T.Inputs[0] in self.FileDependency:
665 for F in self.FileDependency[T.Inputs[0]]:
666 Deps.append(self.PlaceMacro(str(F), self.Macros))
667 # Add source-dependencies
668 for F in T.Inputs:
669 NewFile = self.PlaceMacro(str(F), self.Macros)
670 # In order to use file list macro as dependency
671 if T.GenListFile:
672 self.ListFileMacros[T.ListFileMacro].append(str(F))
673 self.FileListMacros[T.FileListMacro].append(NewFile)
674 elif T.GenFileListMacro:
675 self.FileListMacros[T.FileListMacro].append(NewFile)
676 else:
677 Deps.append(NewFile)
678
679 # Use file list macro as dependency
680 if T.GenFileListMacro:
681 Deps.append("$(%s)" % T.FileListMacro)
682
683 TargetDict = {
684 "target" : self.PlaceMacro(T.Target.Path, self.Macros),
685 "cmd" : "\n\t".join(T.Commands),
686 "deps" : Deps
687 }
688 self.BuildTargetList.append(self._BUILD_TARGET_TEMPLATE.Replace(TargetDict))
689
690 ## For creating makefile targets for dependent libraries
691 def ProcessDependentLibrary(self):
692 for LibraryAutoGen in self._AutoGenObject.LibraryAutoGenList:
693 self.LibraryBuildDirectoryList.append(self.PlaceMacro(LibraryAutoGen.BuildDir, self.Macros))
694
695 ## Return a list containing source file's dependencies
696 #
697 # @param FileList The list of source files
698 # @param ForceInculeList The list of files which will be included forcely
699 # @param SearchPathList The list of search path
700 #
701 # @retval dict The mapping between source file path and its dependencies
702 #
703 def GetFileDependency(self, FileList, ForceInculeList, SearchPathList):
704 Dependency = {}
705 for F in FileList:
706 Dependency[F] = self.GetDependencyList(F, ForceInculeList, SearchPathList)
707 return Dependency
708
709 ## Find dependencies for one source file
710 #
711 # By searching recursively "#include" directive in file, find out all the
712 # files needed by given source file. The dependecies will be only searched
713 # in given search path list.
714 #
715 # @param File The source file
716 # @param ForceInculeList The list of files which will be included forcely
717 # @param SearchPathList The list of search path
718 #
719 # @retval list The list of files the given source file depends on
720 #
721 def GetDependencyList(self, File, ForceList, SearchPathList):
722 EdkLogger.debug(EdkLogger.DEBUG_1, "Try to get dependency files for %s" % File)
723 FileStack = [File] + ForceList
724 DependencySet = set()
725 MacroUsedByIncludedFile = False
726
727 if self._AutoGenObject.Arch not in gDependencyDatabase:
728 gDependencyDatabase[self._AutoGenObject.Arch] = {}
729 DepDb = gDependencyDatabase[self._AutoGenObject.Arch]
730
731 while len(FileStack) > 0:
732 F = FileStack.pop()
733
734 CurrentFileDependencyList = []
735 if F in DepDb:
736 CurrentFileDependencyList = DepDb[F]
737 for Dep in CurrentFileDependencyList:
738 if Dep not in FileStack and Dep not in DependencySet:
739 FileStack.append(Dep)
740 else:
741 try:
742 Fd = open(F.Path, 'r')
743 except BaseException, X:
744 EdkLogger.error("build", FILE_OPEN_FAILURE, ExtraData=F.Path+"\n\t"+str(X))
745
746 FileContent = Fd.read()
747 Fd.close()
748 if len(FileContent) == 0:
749 continue
750
751 if FileContent[0] == 0xff or FileContent[0] == 0xfe:
752 FileContent = unicode(FileContent, "utf-16")
753 IncludedFileList = gIncludePattern.findall(FileContent)
754
755 CurrentFilePath = F.Dir
756 for Inc in IncludedFileList:
757 # if there's macro used to reference header file, expand it
758 HeaderList = gMacroPattern.findall(Inc)
759 if len(HeaderList) == 1 and len(HeaderList[0]) == 2:
760 HeaderType = HeaderList[0][0]
761 HeaderKey = HeaderList[0][1]
762 if HeaderType in gIncludeMacroConversion:
763 Inc = gIncludeMacroConversion[HeaderType] % {"HeaderKey" : HeaderKey}
764 else:
765 # not known macro used in #include
766 MacroUsedByIncludedFile = True
767 continue
768 Inc = os.path.normpath(Inc)
769 for SearchPath in [CurrentFilePath] + SearchPathList:
770 FilePath = os.path.join(SearchPath, Inc)
771 if not os.path.exists(FilePath) or FilePath in CurrentFileDependencyList:
772 continue
773 FilePath = PathClass(FilePath)
774 CurrentFileDependencyList.append(FilePath)
775 if FilePath not in FileStack and FilePath not in DependencySet:
776 FileStack.append(FilePath)
777 break
778 else:
779 EdkLogger.debug(EdkLogger.DEBUG_9, "%s included by %s was not found"\
780 "in any given path:\n\t%s" % (Inc, F, "\n\t".join(SearchPathList)))
781
782 if not MacroUsedByIncludedFile:
783 if F == File:
784 CurrentFileDependencyList += ForceList
785 #
786 # Don't keep the file in cache if it uses macro in included file.
787 # So it will be scanned again if another file includes this file.
788 #
789 DepDb[F] = CurrentFileDependencyList
790 DependencySet.update(CurrentFileDependencyList)
791
792 #
793 # If there's macro used in included file, always build the file by
794 # returning a empty dependency
795 #
796 if MacroUsedByIncludedFile:
797 DependencyList = []
798 else:
799 DependencyList = list(DependencySet) # remove duplicate ones
800
801 return DependencyList
802
803 _TemplateDict = property(_CreateTemplateDict)
804
805## CustomMakefile class
806#
807# This class encapsules makefie and its generation for module. It uses template to generate
808# the content of makefile. The content of makefile will be got from ModuleAutoGen object.
809#
810class CustomMakefile(BuildFile):
811 ## template used to generate the makefile for module with custom makefile
812 _TEMPLATE_ = TemplateString('''\
813${makefile_header}
814
815#
816# Platform Macro Definition
817#
818PLATFORM_NAME = ${platform_name}
819PLATFORM_GUID = ${platform_guid}
820PLATFORM_VERSION = ${platform_version}
821PLATFORM_RELATIVE_DIR = ${platform_relative_directory}
822PLATFORM_DIR = $(WORKSPACE)${separator}${platform_relative_directory}
823PLATFORM_OUTPUT_DIR = ${platform_output_directory}
824
825#
826# Module Macro Definition
827#
828MODULE_NAME = ${module_name}
829MODULE_GUID = ${module_guid}
830MODULE_VERSION = ${module_version}
831MODULE_TYPE = ${module_type}
832MODULE_FILE = ${module_file}
833MODULE_FILE_BASE_NAME = ${module_file_base_name}
834BASE_NAME = $(MODULE_NAME)
835MODULE_RELATIVE_DIR = ${module_relative_directory}
836MODULE_DIR = $(WORKSPACE)${separator}${module_relative_directory}
837
838#
839# Build Configuration Macro Definition
840#
841ARCH = ${architecture}
842TOOLCHAIN = ${toolchain_tag}
843TOOLCHAIN_TAG = ${toolchain_tag}
844TARGET = ${build_target}
845
846#
847# Build Directory Macro Definition
848#
849# PLATFORM_BUILD_DIR = ${platform_build_directory}
850BUILD_DIR = ${platform_build_directory}
851BIN_DIR = $(BUILD_DIR)${separator}${architecture}
852LIB_DIR = $(BIN_DIR)
853MODULE_BUILD_DIR = ${module_build_directory}
854OUTPUT_DIR = ${module_output_directory}
855DEBUG_DIR = ${module_debug_directory}
856DEST_DIR_OUTPUT = $(OUTPUT_DIR)
857DEST_DIR_DEBUG = $(DEBUG_DIR)
858
859#
860# Tools definitions specific to this module
861#
862${BEGIN}${module_tool_definitions}
863${END}
864MAKE_FILE = ${makefile_path}
865
866#
867# Shell Command Macro
868#
869${BEGIN}${shell_command_code} = ${shell_command}
870${END}
871
872${custom_makefile_content}
873
874#
875# Target used when called from platform makefile, which will bypass the build of dependent libraries
876#
877
878pbuild: init all
879
880
881#
882# ModuleTarget
883#
884
885mbuild: init all
886
887#
888# Build Target used in multi-thread build mode, which no init target is needed
889#
890
891tbuild: all
892
893#
894# Initialization target: print build information and create necessary directories
895#
896init:
897\t-@echo Building ... $(MODULE_DIR)${separator}$(MODULE_FILE) [$(ARCH)]
898${BEGIN}\t-@${create_directory_command}\n${END}\
899
900''')
901
902 ## Constructor of CustomMakefile
903 #
904 # @param ModuleAutoGen Object of ModuleAutoGen class
905 #
906 def __init__(self, ModuleAutoGen):
907 BuildFile.__init__(self, ModuleAutoGen)
908 self.PlatformInfo = self._AutoGenObject.PlatformInfo
909 self.IntermediateDirectoryList = ["$(DEBUG_DIR)", "$(OUTPUT_DIR)"]
910
911 # Compose a dict object containing information used to do replacement in template
912 def _CreateTemplateDict(self):
913 Separator = self._SEP_[self._FileType]
914 if self._FileType not in self._AutoGenObject.CustomMakefile:
915 EdkLogger.error('build', OPTION_NOT_SUPPORTED, "No custom makefile for %s" % self._FileType,
916 ExtraData="[%s]" % str(self._AutoGenObject))
917 MakefilePath = os.path.join(
918 self._AutoGenObject.WorkspaceDir,
919 self._AutoGenObject.CustomMakefile[self._FileType]
920 )
921 try:
922 CustomMakefile = open(MakefilePath, 'r').read()
923 except:
924 EdkLogger.error('build', FILE_OPEN_FAILURE, File=str(self._AutoGenObject),
925 ExtraData=self._AutoGenObject.CustomMakefile[self._FileType])
926
927 # tools definitions
928 ToolsDef = []
929 for Tool in self._AutoGenObject.BuildOption:
930 # Don't generate MAKE_FLAGS in makefile. It's put in environment variable.
931 if Tool == "MAKE":
932 continue
933 for Attr in self._AutoGenObject.BuildOption[Tool]:
934 if Attr == "FAMILY":
935 continue
936 elif Attr == "PATH":
937 ToolsDef.append("%s = %s" % (Tool, self._AutoGenObject.BuildOption[Tool][Attr]))
938 else:
939 ToolsDef.append("%s_%s = %s" % (Tool, Attr, self._AutoGenObject.BuildOption[Tool][Attr]))
940 ToolsDef.append("")
941
942 MakefileName = self._FILE_NAME_[self._FileType]
943 MakefileTemplateDict = {
944 "makefile_header" : self._FILE_HEADER_[self._FileType],
945 "makefile_path" : os.path.join("$(MODULE_BUILD_DIR)", MakefileName),
946 "platform_name" : self.PlatformInfo.Name,
947 "platform_guid" : self.PlatformInfo.Guid,
948 "platform_version" : self.PlatformInfo.Version,
949 "platform_relative_directory": self.PlatformInfo.SourceDir,
950 "platform_output_directory" : self.PlatformInfo.OutputDir,
951
952 "module_name" : self._AutoGenObject.Name,
953 "module_guid" : self._AutoGenObject.Guid,
954 "module_version" : self._AutoGenObject.Version,
955 "module_type" : self._AutoGenObject.ModuleType,
956 "module_file" : self._AutoGenObject.MetaFile,
957 "module_file_base_name" : self._AutoGenObject.MetaFile.BaseName,
958 "module_relative_directory" : self._AutoGenObject.SourceDir,
959
960 "architecture" : self._AutoGenObject.Arch,
961 "toolchain_tag" : self._AutoGenObject.ToolChain,
962 "build_target" : self._AutoGenObject.BuildTarget,
963
964 "platform_build_directory" : self.PlatformInfo.BuildDir,
965 "module_build_directory" : self._AutoGenObject.BuildDir,
966 "module_output_directory" : self._AutoGenObject.OutputDir,
967 "module_debug_directory" : self._AutoGenObject.DebugDir,
968
969 "separator" : Separator,
970 "module_tool_definitions" : ToolsDef,
971
972 "shell_command_code" : self._SHELL_CMD_[self._FileType].keys(),
973 "shell_command" : self._SHELL_CMD_[self._FileType].values(),
974
975 "create_directory_command" : self.GetCreateDirectoryCommand(self.IntermediateDirectoryList),
976 "custom_makefile_content" : CustomMakefile
977 }
978
979 return MakefileTemplateDict
980
981 _TemplateDict = property(_CreateTemplateDict)
982
983## PlatformMakefile class
984#
985# This class encapsules makefie and its generation for platform. It uses
986# template to generate the content of makefile. The content of makefile will be
987# got from PlatformAutoGen object.
988#
989class PlatformMakefile(BuildFile):
990 ## template used to generate the makefile for platform
991 _TEMPLATE_ = TemplateString('''\
992${makefile_header}
993
994#
995# Platform Macro Definition
996#
997PLATFORM_NAME = ${platform_name}
998PLATFORM_GUID = ${platform_guid}
999PLATFORM_VERSION = ${platform_version}
1000PLATFORM_FILE = ${platform_file}
1001PLATFORM_DIR = $(WORKSPACE)${separator}${platform_relative_directory}
1002PLATFORM_OUTPUT_DIR = ${platform_output_directory}
1003
1004#
1005# Build Configuration Macro Definition
1006#
1007TOOLCHAIN = ${toolchain_tag}
1008TOOLCHAIN_TAG = ${toolchain_tag}
1009TARGET = ${build_target}
1010
1011#
1012# Build Directory Macro Definition
1013#
1014BUILD_DIR = ${platform_build_directory}
1015FV_DIR = ${platform_build_directory}${separator}FV
1016
1017#
1018# Shell Command Macro
1019#
1020${BEGIN}${shell_command_code} = ${shell_command}
1021${END}
1022
1023MAKE = ${make_path}
1024MAKE_FILE = ${makefile_path}
1025
1026#
1027# Default target
1028#
1029all: init build_libraries build_modules
1030
1031#
1032# Initialization target: print build information and create necessary directories
1033#
1034init:
1035\t-@echo Building ... $(PLATFORM_FILE) [${build_architecture_list}]
1036\t${BEGIN}-@${create_directory_command}
1037\t${END}
1038#
1039# library build target
1040#
1041libraries: init build_libraries
1042
1043#
1044# module build target
1045#
1046modules: init build_libraries build_modules
1047
1048#
1049# Build all libraries:
1050#
1051build_libraries:
1052${BEGIN}\t@"$(MAKE)" $(MAKE_FLAGS) -f ${library_makefile_list} pbuild
1053${END}\t@cd $(BUILD_DIR)
1054
1055#
1056# Build all modules:
1057#
1058build_modules:
1059${BEGIN}\t@"$(MAKE)" $(MAKE_FLAGS) -f ${module_makefile_list} pbuild
1060${END}\t@cd $(BUILD_DIR)
1061
1062#
1063# Clean intermediate files
1064#
1065clean:
1066\t${BEGIN}-@${library_build_command} clean
1067\t${END}${BEGIN}-@${module_build_command} clean
1068\t${END}@cd $(BUILD_DIR)
1069
1070#
1071# Clean all generated files except to makefile
1072#
1073cleanall:
1074${BEGIN}\t${cleanall_command}
1075${END}
1076
1077#
1078# Clean all library files
1079#
1080cleanlib:
1081\t${BEGIN}-@${library_build_command} cleanall
1082\t${END}@cd $(BUILD_DIR)\n
1083''')
1084
1085 ## Constructor of PlatformMakefile
1086 #
1087 # @param ModuleAutoGen Object of PlatformAutoGen class
1088 #
1089 def __init__(self, PlatformAutoGen):
1090 BuildFile.__init__(self, PlatformAutoGen)
1091 self.ModuleBuildCommandList = []
1092 self.ModuleMakefileList = []
1093 self.IntermediateDirectoryList = []
1094 self.ModuleBuildDirectoryList = []
1095 self.LibraryBuildDirectoryList = []
1096
1097 # Compose a dict object containing information used to do replacement in template
1098 def _CreateTemplateDict(self):
1099 Separator = self._SEP_[self._FileType]
1100
1101 PlatformInfo = self._AutoGenObject
1102 if "MAKE" not in PlatformInfo.ToolDefinition or "PATH" not in PlatformInfo.ToolDefinition["MAKE"]:
1103 EdkLogger.error("build", OPTION_MISSING, "No MAKE command defined. Please check your tools_def.txt!",
1104 ExtraData="[%s]" % str(self._AutoGenObject))
1105
1106 self.IntermediateDirectoryList = ["$(BUILD_DIR)"]
1107 self.ModuleBuildDirectoryList = self.GetModuleBuildDirectoryList()
1108 self.LibraryBuildDirectoryList = self.GetLibraryBuildDirectoryList()
1109
1110 MakefileName = self._FILE_NAME_[self._FileType]
1111 LibraryMakefileList = []
1112 LibraryMakeCommandList = []
1113 for D in self.LibraryBuildDirectoryList:
1114 D = self.PlaceMacro(D, {"BUILD_DIR":PlatformInfo.BuildDir})
1115 Makefile = os.path.join(D, MakefileName)
1116 Command = self._MAKE_TEMPLATE_[self._FileType] % {"file":Makefile}
1117 LibraryMakefileList.append(Makefile)
1118 LibraryMakeCommandList.append(Command)
1119
1120 ModuleMakefileList = []
1121 ModuleMakeCommandList = []
1122 for D in self.ModuleBuildDirectoryList:
1123 D = self.PlaceMacro(D, {"BUILD_DIR":PlatformInfo.BuildDir})
1124 Makefile = os.path.join(D, MakefileName)
1125 Command = self._MAKE_TEMPLATE_[self._FileType] % {"file":Makefile}
1126 ModuleMakefileList.append(Makefile)
1127 ModuleMakeCommandList.append(Command)
1128
1129 MakefileTemplateDict = {
1130 "makefile_header" : self._FILE_HEADER_[self._FileType],
1131 "makefile_path" : os.path.join("$(BUILD_DIR)", MakefileName),
1132 "make_path" : PlatformInfo.ToolDefinition["MAKE"]["PATH"],
1133 "makefile_name" : MakefileName,
1134 "platform_name" : PlatformInfo.Name,
1135 "platform_guid" : PlatformInfo.Guid,
1136 "platform_version" : PlatformInfo.Version,
1137 "platform_file" : self._AutoGenObject.MetaFile,
1138 "platform_relative_directory": PlatformInfo.SourceDir,
1139 "platform_output_directory" : PlatformInfo.OutputDir,
1140 "platform_build_directory" : PlatformInfo.BuildDir,
1141
1142 "toolchain_tag" : PlatformInfo.ToolChain,
1143 "build_target" : PlatformInfo.BuildTarget,
1144 "shell_command_code" : self._SHELL_CMD_[self._FileType].keys(),
1145 "shell_command" : self._SHELL_CMD_[self._FileType].values(),
1146 "build_architecture_list" : self._AutoGenObject.Arch,
1147 "architecture" : self._AutoGenObject.Arch,
1148 "separator" : Separator,
1149 "create_directory_command" : self.GetCreateDirectoryCommand(self.IntermediateDirectoryList),
1150 "cleanall_command" : self.GetRemoveDirectoryCommand(self.IntermediateDirectoryList),
1151 "library_makefile_list" : LibraryMakefileList,
1152 "module_makefile_list" : ModuleMakefileList,
1153 "library_build_command" : LibraryMakeCommandList,
1154 "module_build_command" : ModuleMakeCommandList,
1155 }
1156
1157 return MakefileTemplateDict
1158
1159 ## Get the root directory list for intermediate files of all modules build
1160 #
1161 # @retval list The list of directory
1162 #
1163 def GetModuleBuildDirectoryList(self):
1164 DirList = []
1165 for ModuleAutoGen in self._AutoGenObject.ModuleAutoGenList:
1166 DirList.append(os.path.join(self._AutoGenObject.BuildDir, ModuleAutoGen.BuildDir))
1167 return DirList
1168
1169 ## Get the root directory list for intermediate files of all libraries build
1170 #
1171 # @retval list The list of directory
1172 #
1173 def GetLibraryBuildDirectoryList(self):
1174 DirList = []
1175 for LibraryAutoGen in self._AutoGenObject.LibraryAutoGenList:
1176 DirList.append(os.path.join(self._AutoGenObject.BuildDir, LibraryAutoGen.BuildDir))
1177 return DirList
1178
1179 _TemplateDict = property(_CreateTemplateDict)
1180
1181## TopLevelMakefile class
1182#
1183# This class encapsules makefie and its generation for entrance makefile. It
1184# uses template to generate the content of makefile. The content of makefile
1185# will be got from WorkspaceAutoGen object.
1186#
1187class TopLevelMakefile(BuildFile):
1188 ## template used to generate toplevel makefile
1189 _TEMPLATE_ = TemplateString('''\
1190${makefile_header}
1191
1192#
1193# Platform Macro Definition
1194#
1195PLATFORM_NAME = ${platform_name}
1196PLATFORM_GUID = ${platform_guid}
1197PLATFORM_VERSION = ${platform_version}
1198
1199#
1200# Build Configuration Macro Definition
1201#
1202TOOLCHAIN = ${toolchain_tag}
1203TOOLCHAIN_TAG = ${toolchain_tag}
1204TARGET = ${build_target}
1205
1206#
1207# Build Directory Macro Definition
1208#
1209BUILD_DIR = ${platform_build_directory}
1210FV_DIR = ${platform_build_directory}${separator}FV
1211
1212#
1213# Shell Command Macro
1214#
1215${BEGIN}${shell_command_code} = ${shell_command}
1216${END}
1217
1218MAKE = ${make_path}
1219MAKE_FILE = ${makefile_path}
1220
1221#
1222# Default target
1223#
1224all: modules fds
1225
1226#
1227# Initialization target: print build information and create necessary directories
1228#
1229init:
1230\t-@
1231\t${BEGIN}-@${create_directory_command}
1232\t${END}
1233#
1234# library build target
1235#
1236libraries: init
1237${BEGIN}\t@cd $(BUILD_DIR)${separator}${arch} && "$(MAKE)" $(MAKE_FLAGS) libraries
1238${END}\t@cd $(BUILD_DIR)
1239
1240#
1241# module build target
1242#
1243modules: init
1244${BEGIN}\t@cd $(BUILD_DIR)${separator}${arch} && "$(MAKE)" $(MAKE_FLAGS) modules
1245${END}\t@cd $(BUILD_DIR)
1246
1247#
1248# Flash Device Image Target
1249#
1250fds: init
1251\t-@cd $(FV_DIR)
1252${BEGIN}\tGenFds -f ${fdf_file} -o $(BUILD_DIR) -t $(TOOLCHAIN) -b $(TARGET) -p ${active_platform} -a ${build_architecture_list} ${extra_options}${END}${BEGIN} -r ${fd} ${END}${BEGIN} -i ${fv} ${END}${BEGIN} -D ${macro} ${END}
1253
1254#
1255# run command for emulator platform only
1256#
1257run:
1258\tcd $(BUILD_DIR)${separator}IA32 && ".${separator}SecMain"
1259\tcd $(BUILD_DIR)
1260
1261#
1262# Clean intermediate files
1263#
1264clean:
1265${BEGIN}\t-@${sub_build_command} clean
1266${END}\t@cd $(BUILD_DIR)
1267
1268#
1269# Clean all generated files except to makefile
1270#
1271cleanall:
1272${BEGIN}\t${cleanall_command}
1273${END}
1274
1275#
1276# Clean all library files
1277#
1278cleanlib:
1279${BEGIN}\t-@${sub_build_command} cleanlib
1280${END}\t@cd $(BUILD_DIR)\n
1281''')
1282
1283 ## Constructor of TopLevelMakefile
1284 #
1285 # @param Workspace Object of WorkspaceAutoGen class
1286 #
1287 def __init__(self, Workspace):
1288 BuildFile.__init__(self, Workspace)
1289 self.IntermediateDirectoryList = []
1290
1291 # Compose a dict object containing information used to do replacement in template
1292 def _CreateTemplateDict(self):
1293 Separator = self._SEP_[self._FileType]
1294
1295 # any platform autogen object is ok because we just need common information
1296 PlatformInfo = self._AutoGenObject
1297
1298 if "MAKE" not in PlatformInfo.ToolDefinition or "PATH" not in PlatformInfo.ToolDefinition["MAKE"]:
1299 EdkLogger.error("build", OPTION_MISSING, "No MAKE command defined. Please check your tools_def.txt!",
1300 ExtraData="[%s]" % str(self._AutoGenObject))
1301
1302 for Arch in PlatformInfo.ArchList:
1303 self.IntermediateDirectoryList.append(Separator.join(["$(BUILD_DIR)", Arch]))
1304 self.IntermediateDirectoryList.append("$(FV_DIR)")
1305
1306 # TRICK: for not generating GenFds call in makefile if no FDF file
1307 MacroList = []
1308 if PlatformInfo.FdfFile != None and PlatformInfo.FdfFile != "":
1309 FdfFileList = [PlatformInfo.FdfFile]
1310 # macros passed to GenFds
fd171542 1311 # MacroList.append('"%s=%s"' % ("WORKSPACE", GlobalData.gWorkspace))
1312 MacroList.append('"%s=%s"' % ("EFI_SOURCE", GlobalData.gEfiSource))
1313 MacroList.append('"%s=%s"' % ("EDK_SOURCE", GlobalData.gEdkSource))
30fdf114 1314 for MacroName in GlobalData.gGlobalDefines:
fd171542 1315 if GlobalData.gGlobalDefines[MacroName] != "":
1316 MacroList.append('"%s=%s"' % (MacroName, GlobalData.gGlobalDefines[MacroName]))
1317 else:
1318 MacroList.append('"%s"' % MacroName)
30fdf114
LG
1319 else:
1320 FdfFileList = []
1321
1322 # pass extra common options to external program called in makefile, currently GenFds.exe
1323 ExtraOption = ''
1324 LogLevel = EdkLogger.GetLevel()
1325 if LogLevel == EdkLogger.VERBOSE:
1326 ExtraOption += " -v"
1327 elif LogLevel <= EdkLogger.DEBUG_9:
1328 ExtraOption += " -d %d" % (LogLevel - 1)
1329 elif LogLevel == EdkLogger.QUIET:
1330 ExtraOption += " -q"
1331
1332 if GlobalData.gCaseInsensitive:
1333 ExtraOption += " -c"
1334
1335 MakefileName = self._FILE_NAME_[self._FileType]
1336 SubBuildCommandList = []
1337 for A in PlatformInfo.ArchList:
1338 Command = self._MAKE_TEMPLATE_[self._FileType] % {"file":os.path.join("$(BUILD_DIR)", A, MakefileName)}
1339 SubBuildCommandList.append(Command)
1340
1341 MakefileTemplateDict = {
1342 "makefile_header" : self._FILE_HEADER_[self._FileType],
1343 "makefile_path" : os.path.join("$(BUILD_DIR)", MakefileName),
1344 "make_path" : PlatformInfo.ToolDefinition["MAKE"]["PATH"],
1345 "platform_name" : PlatformInfo.Name,
1346 "platform_guid" : PlatformInfo.Guid,
1347 "platform_version" : PlatformInfo.Version,
1348 "platform_build_directory" : PlatformInfo.BuildDir,
1349
1350 "toolchain_tag" : PlatformInfo.ToolChain,
1351 "build_target" : PlatformInfo.BuildTarget,
1352 "shell_command_code" : self._SHELL_CMD_[self._FileType].keys(),
1353 "shell_command" : self._SHELL_CMD_[self._FileType].values(),
1354 'arch' : list(PlatformInfo.ArchList),
1355 "build_architecture_list" : ','.join(PlatformInfo.ArchList),
1356 "separator" : Separator,
1357 "create_directory_command" : self.GetCreateDirectoryCommand(self.IntermediateDirectoryList),
1358 "cleanall_command" : self.GetRemoveDirectoryCommand(self.IntermediateDirectoryList),
1359 "sub_build_command" : SubBuildCommandList,
1360 "fdf_file" : FdfFileList,
1361 "active_platform" : str(PlatformInfo),
1362 "fd" : PlatformInfo.FdTargetList,
1363 "fv" : PlatformInfo.FvTargetList,
1364 "extra_options" : ExtraOption,
1365 "macro" : MacroList,
1366 }
1367
1368 return MakefileTemplateDict
1369
1370 ## Get the root directory list for intermediate files of all modules build
1371 #
1372 # @retval list The list of directory
1373 #
1374 def GetModuleBuildDirectoryList(self):
1375 DirList = []
1376 for ModuleAutoGen in self._AutoGenObject.ModuleAutoGenList:
1377 DirList.append(os.path.join(self._AutoGenObject.BuildDir, ModuleAutoGen.BuildDir))
1378 return DirList
1379
1380 ## Get the root directory list for intermediate files of all libraries build
1381 #
1382 # @retval list The list of directory
1383 #
1384 def GetLibraryBuildDirectoryList(self):
1385 DirList = []
1386 for LibraryAutoGen in self._AutoGenObject.LibraryAutoGenList:
1387 DirList.append(os.path.join(self._AutoGenObject.BuildDir, LibraryAutoGen.BuildDir))
1388 return DirList
1389
1390 _TemplateDict = property(_CreateTemplateDict)
1391
1392# This acts like the main() function for the script, unless it is 'import'ed into another script.
1393if __name__ == '__main__':
1394 pass
1395