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