]> git.proxmox.com Git - mirror_edk2.git/blame - BaseTools/Source/Python/AutoGen/GenMake.py
BaseTools: Add mixed PCD support feature
[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
725cdb8f 4# Copyright (c) 2007 - 2016, 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
05cc51ad 22from Common.MultipleWorkspace import MultipleWorkspace as mws\r
f51461c8
LG
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
47fea6af 30gIncludePattern = re.compile(r"^[ \t]*#?[ \t]*include(?:[ \t]*(?:\\(?:\r\n|\r|\n))*[ \t]*)*(?:\(?[\"<]?[ \t]*)([-\w.\\/() \t]+)(?:[ \t]*[\">]?\)?)", re.MULTILINE | re.UNICODE | re.IGNORECASE)\r
f51461c8
LG
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
017fb1cd 236PLATFORM_DIR = ${platform_dir}\r
f51461c8
LG
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
01e418d6 252MODULE_DIR = ${module_dir}\r
f51461c8
LG
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
3570e332
YZ
480 for k, v in self._AutoGenObject.Module.Defines.iteritems():\r
481 if k not in self._AutoGenObject.Macros.keys():\r
482 self._AutoGenObject.Macros[k] = v\r
483\r
484 if 'MODULE_ENTRY_POINT' not in self._AutoGenObject.Macros.keys():\r
485 self._AutoGenObject.Macros['MODULE_ENTRY_POINT'] = ModuleEntryPoint\r
486 if 'ARCH_ENTRY_POINT' not in self._AutoGenObject.Macros.keys():\r
487 self._AutoGenObject.Macros['ARCH_ENTRY_POINT'] = ArchEntryPoint\r
488 if 'IMAGE_ENTRY_POINT' not in self._AutoGenObject.Macros.keys():\r
489 self._AutoGenObject.Macros['IMAGE_ENTRY_POINT'] = ImageEntryPoint\r
490\r
f51461c8
LG
491 # tools definitions\r
492 ToolsDef = []\r
493 IncPrefix = self._INC_FLAG_[self._AutoGenObject.ToolChainFamily]\r
494 for Tool in self._AutoGenObject.BuildOption:\r
495 for Attr in self._AutoGenObject.BuildOption[Tool]:\r
496 Value = self._AutoGenObject.BuildOption[Tool][Attr]\r
497 if Attr == "FAMILY":\r
498 continue\r
499 elif Attr == "PATH":\r
500 ToolsDef.append("%s = %s" % (Tool, Value))\r
501 else:\r
502 # Don't generate MAKE_FLAGS in makefile. It's put in environment variable.\r
503 if Tool == "MAKE":\r
504 continue\r
505 # Remove duplicated include path, if any\r
506 if Attr == "FLAGS":\r
507 Value = RemoveDupOption(Value, IncPrefix, self._AutoGenObject.IncludePathList)\r
508 ToolsDef.append("%s_%s = %s" % (Tool, Attr, Value))\r
509 ToolsDef.append("")\r
510\r
725cdb8f
YZ
511 # generate the Response file and Response flag\r
512 RespDict = self.CommandExceedLimit()\r
513 RespFileList = os.path.join(self._AutoGenObject.OutputDir, 'respfilelist.txt')\r
514 if RespDict:\r
515 RespFileListContent = ''\r
516 for Resp in RespDict.keys():\r
517 RespFile = os.path.join(self._AutoGenObject.OutputDir, str(Resp).lower() + '.txt')\r
3570e332
YZ
518 StrList = RespDict[Resp].split(' ')\r
519 UnexpandMacro = []\r
520 NewStr = []\r
521 for Str in StrList:\r
522 if '$' in Str:\r
523 UnexpandMacro.append(Str)\r
524 else:\r
525 NewStr.append(Str)\r
526 UnexpandMacroStr = ' '.join(UnexpandMacro)\r
527 NewRespStr = ' '.join(NewStr)\r
528 SaveFileOnChange(RespFile, NewRespStr, False)\r
529 ToolsDef.append("%s = %s" % (Resp, UnexpandMacroStr + ' @' + RespFile))\r
725cdb8f 530 RespFileListContent += '@' + RespFile + os.linesep\r
3570e332 531 RespFileListContent += NewRespStr + os.linesep\r
725cdb8f
YZ
532 SaveFileOnChange(RespFileList, RespFileListContent, False)\r
533 else:\r
534 if os.path.exists(RespFileList):\r
535 os.remove(RespFileList)\r
536\r
f51461c8
LG
537 # convert source files and binary files to build targets\r
538 self.ResultFileList = [str(T.Target) for T in self._AutoGenObject.CodaTargetList]\r
47fea6af 539 if len(self.ResultFileList) == 0 and len(self._AutoGenObject.SourceFileList) <> 0:\r
f51461c8
LG
540 EdkLogger.error("build", AUTOGEN_ERROR, "Nothing to build",\r
541 ExtraData="[%s]" % str(self._AutoGenObject))\r
542\r
543 self.ProcessBuildTargetList()\r
544\r
545 # Generate macros used to represent input files\r
546 FileMacroList = [] # macro name = file list\r
547 for FileListMacro in self.FileListMacros:\r
548 FileMacro = self._FILE_MACRO_TEMPLATE.Replace(\r
549 {\r
550 "macro_name" : FileListMacro,\r
551 "source_file" : self.FileListMacros[FileListMacro]\r
552 }\r
553 )\r
554 FileMacroList.append(FileMacro)\r
555\r
556 # INC_LIST is special\r
557 FileMacro = ""\r
558 IncludePathList = []\r
559 for P in self._AutoGenObject.IncludePathList:\r
47fea6af 560 IncludePathList.append(IncPrefix + self.PlaceMacro(P, self.Macros))\r
f51461c8 561 if FileBuildRule.INC_LIST_MACRO in self.ListFileMacros:\r
47fea6af 562 self.ListFileMacros[FileBuildRule.INC_LIST_MACRO].append(IncPrefix + P)\r
f51461c8
LG
563 FileMacro += self._FILE_MACRO_TEMPLATE.Replace(\r
564 {\r
565 "macro_name" : "INC",\r
566 "source_file" : IncludePathList\r
567 }\r
568 )\r
569 FileMacroList.append(FileMacro)\r
570\r
571 # Generate macros used to represent files containing list of input files\r
572 for ListFileMacro in self.ListFileMacros:\r
47fea6af 573 ListFileName = os.path.join(self._AutoGenObject.OutputDir, "%s.lst" % ListFileMacro.lower()[:len(ListFileMacro) - 5])\r
f51461c8
LG
574 FileMacroList.append("%s = %s" % (ListFileMacro, ListFileName))\r
575 SaveFileOnChange(\r
576 ListFileName,\r
577 "\n".join(self.ListFileMacros[ListFileMacro]),\r
578 False\r
579 )\r
580\r
581 # Edk modules need <BaseName>StrDefs.h for string ID\r
582 #if self._AutoGenObject.AutoGenVersion < 0x00010005 and len(self._AutoGenObject.UnicodeFileList) > 0:\r
583 # BcTargetList = ['strdefs']\r
584 #else:\r
585 # BcTargetList = []\r
586 BcTargetList = []\r
587\r
588 MakefileName = self._FILE_NAME_[self._FileType]\r
589 LibraryMakeCommandList = []\r
590 for D in self.LibraryBuildDirectoryList:\r
591 Command = self._MAKE_TEMPLATE_[self._FileType] % {"file":os.path.join(D, MakefileName)}\r
592 LibraryMakeCommandList.append(Command)\r
593\r
97fa0ee9 594 package_rel_dir = self._AutoGenObject.SourceDir\r
b442ad5c
YL
595 current_dir = self.Macros["WORKSPACE"]\r
596 found = False\r
597 while not found and os.sep in package_rel_dir:\r
598 index = package_rel_dir.index(os.sep)\r
05cc51ad 599 current_dir = mws.join(current_dir, package_rel_dir[:index])\r
b442ad5c
YL
600 for fl in os.listdir(current_dir):\r
601 if fl.endswith('.dec'):\r
602 found = True\r
603 break\r
604 package_rel_dir = package_rel_dir[index + 1:]\r
97fa0ee9 605\r
f51461c8
LG
606 MakefileTemplateDict = {\r
607 "makefile_header" : self._FILE_HEADER_[self._FileType],\r
608 "makefile_path" : os.path.join("$(MODULE_BUILD_DIR)", MakefileName),\r
609 "makefile_name" : MakefileName,\r
610 "platform_name" : self.PlatformInfo.Name,\r
611 "platform_guid" : self.PlatformInfo.Guid,\r
612 "platform_version" : self.PlatformInfo.Version,\r
613 "platform_relative_directory": self.PlatformInfo.SourceDir,\r
614 "platform_output_directory" : self.PlatformInfo.OutputDir,\r
017fb1cd 615 "platform_dir" : self._AutoGenObject.Macros["PLATFORM_DIR"],\r
f51461c8
LG
616\r
617 "module_name" : self._AutoGenObject.Name,\r
618 "module_guid" : self._AutoGenObject.Guid,\r
867d1cd4 619 "module_name_guid" : self._AutoGenObject._GetUniqueBaseName(),\r
f51461c8
LG
620 "module_version" : self._AutoGenObject.Version,\r
621 "module_type" : self._AutoGenObject.ModuleType,\r
622 "module_file" : self._AutoGenObject.MetaFile.Name,\r
623 "module_file_base_name" : self._AutoGenObject.MetaFile.BaseName,\r
624 "module_relative_directory" : self._AutoGenObject.SourceDir,\r
01e418d6 625 "module_dir" : mws.join (self.Macros["WORKSPACE"], self._AutoGenObject.SourceDir),\r
97fa0ee9
YL
626 "package_relative_directory": package_rel_dir,\r
627 "module_extra_defines" : ["%s = %s" % (k, v) for k, v in self._AutoGenObject.Module.Defines.iteritems()],\r
f51461c8
LG
628\r
629 "architecture" : self._AutoGenObject.Arch,\r
630 "toolchain_tag" : self._AutoGenObject.ToolChain,\r
631 "build_target" : self._AutoGenObject.BuildTarget,\r
632\r
633 "platform_build_directory" : self.PlatformInfo.BuildDir,\r
634 "module_build_directory" : self._AutoGenObject.BuildDir,\r
635 "module_output_directory" : self._AutoGenObject.OutputDir,\r
636 "module_debug_directory" : self._AutoGenObject.DebugDir,\r
637\r
638 "separator" : Separator,\r
639 "module_tool_definitions" : ToolsDef,\r
640\r
641 "shell_command_code" : self._SHELL_CMD_[self._FileType].keys(),\r
642 "shell_command" : self._SHELL_CMD_[self._FileType].values(),\r
643\r
644 "module_entry_point" : ModuleEntryPoint,\r
645 "image_entry_point" : ImageEntryPoint,\r
646 "arch_entry_point" : ArchEntryPoint,\r
647 "remaining_build_target" : self.ResultFileList,\r
648 "common_dependency_file" : self.CommonFileDependency,\r
649 "create_directory_command" : self.GetCreateDirectoryCommand(self.IntermediateDirectoryList),\r
650 "clean_command" : self.GetRemoveDirectoryCommand(["$(OUTPUT_DIR)"]),\r
651 "cleanall_command" : self.GetRemoveDirectoryCommand(["$(DEBUG_DIR)", "$(OUTPUT_DIR)"]),\r
652 "dependent_library_build_directory" : self.LibraryBuildDirectoryList,\r
653 "library_build_command" : LibraryMakeCommandList,\r
654 "file_macro" : FileMacroList,\r
655 "file_build_target" : self.BuildTargetList,\r
656 "backward_compatible_target": BcTargetList,\r
657 }\r
658\r
659 return MakefileTemplateDict\r
660\r
725cdb8f
YZ
661 def CommandExceedLimit(self):\r
662 FlagDict = {\r
663 'CC' : { 'Macro' : '$(CC_FLAGS)', 'Value' : False},\r
664 'PP' : { 'Macro' : '$(PP_FLAGS)', 'Value' : False},\r
665 'APP' : { 'Macro' : '$(APP_FLAGS)', 'Value' : False},\r
666 'ASLPP' : { 'Macro' : '$(ASLPP_FLAGS)', 'Value' : False},\r
667 'VFRPP' : { 'Macro' : '$(VFRPP_FLAGS)', 'Value' : False},\r
668 'ASM' : { 'Macro' : '$(ASM_FLAGS)', 'Value' : False},\r
669 'ASLCC' : { 'Macro' : '$(ASLCC_FLAGS)', 'Value' : False},\r
670 }\r
671\r
672 RespDict = {}\r
673 FileTypeList = []\r
674 IncPrefix = self._INC_FLAG_[self._AutoGenObject.ToolChainFamily]\r
675\r
676 # base on the source files to decide the file type\r
677 for File in self._AutoGenObject.SourceFileList:\r
678 for type in self._AutoGenObject.FileTypes:\r
679 if File in self._AutoGenObject.FileTypes[type]:\r
680 if type not in FileTypeList:\r
681 FileTypeList.append(type)\r
682\r
683 # calculate the command-line length\r
684 if FileTypeList:\r
685 for type in FileTypeList:\r
686 BuildTargets = self._AutoGenObject.BuildRules[type].BuildTargets\r
687 for Target in BuildTargets:\r
688 CommandList = BuildTargets[Target].Commands\r
689 for SingleCommand in CommandList:\r
690 Tool = ''\r
691 SingleCommandLength = len(SingleCommand)\r
692 SingleCommandList = SingleCommand.split()\r
693 if len(SingleCommandList) > 0:\r
694 for Flag in FlagDict.keys():\r
695 if '$('+ Flag +')' in SingleCommandList[0]:\r
696 Tool = Flag\r
697 break\r
698 if Tool:\r
699 SingleCommandLength += len(self._AutoGenObject._BuildOption[Tool]['PATH'])\r
700 for item in SingleCommandList[1:]:\r
701 if FlagDict[Tool]['Macro'] in item:\r
702 Str = self._AutoGenObject._BuildOption[Tool]['FLAGS']\r
3570e332
YZ
703 for Option in self._AutoGenObject.BuildOption.keys():\r
704 for Attr in self._AutoGenObject.BuildOption[Option]:\r
705 if Str.find(Option + '_' + Attr) != -1:\r
706 Str = Str.replace('$(' + Option + '_' + Attr + ')', self._AutoGenObject.BuildOption[Option][Attr])\r
725cdb8f
YZ
707 while(Str.find('$(') != -1):\r
708 for macro in self._AutoGenObject.Macros.keys():\r
709 MacroName = '$('+ macro + ')'\r
710 if (Str.find(MacroName) != -1):\r
711 Str = Str.replace(MacroName, self._AutoGenObject.Macros[macro])\r
712 break\r
713 else:\r
3570e332 714 break\r
725cdb8f
YZ
715 SingleCommandLength += len(Str)\r
716 elif '$(INC)' in item:\r
717 SingleCommandLength += self._AutoGenObject.IncludePathLength + len(IncPrefix) * len(self._AutoGenObject._IncludePathList)\r
718 elif item.find('$(') != -1:\r
719 Str = item\r
720 for Option in self._AutoGenObject.BuildOption.keys():\r
721 for Attr in self._AutoGenObject.BuildOption[Option]:\r
722 if Str.find(Option + '_' + Attr) != -1:\r
723 Str = Str.replace('$(' + Option + '_' + Attr + ')', self._AutoGenObject.BuildOption[Option][Attr])\r
724 while(Str.find('$(') != -1):\r
725 for macro in self._AutoGenObject.Macros.keys():\r
726 MacroName = '$('+ macro + ')'\r
727 if (Str.find(MacroName) != -1):\r
728 Str = Str.replace(MacroName, self._AutoGenObject.Macros[macro])\r
729 break\r
730 else:\r
3570e332 731 break\r
725cdb8f
YZ
732 SingleCommandLength += len(Str)\r
733\r
734 if SingleCommandLength > GlobalData.gCommandMaxLength:\r
735 FlagDict[Tool]['Value'] = True\r
736\r
737 # generate the response file content by combine the FLAGS and INC\r
738 for Flag in FlagDict.keys():\r
739 if FlagDict[Flag]['Value']:\r
740 Key = Flag + '_RESP'\r
741 RespMacro = FlagDict[Flag]['Macro'].replace('FLAGS', 'RESP')\r
742 Value = self._AutoGenObject.BuildOption[Flag]['FLAGS']\r
743 for inc in self._AutoGenObject._IncludePathList:\r
744 Value += ' ' + IncPrefix + inc\r
3570e332
YZ
745 for Option in self._AutoGenObject.BuildOption.keys():\r
746 for Attr in self._AutoGenObject.BuildOption[Option]:\r
747 if Value.find(Option + '_' + Attr) != -1:\r
748 Value = Value.replace('$(' + Option + '_' + Attr + ')', self._AutoGenObject.BuildOption[Option][Attr])\r
725cdb8f
YZ
749 while (Value.find('$(') != -1):\r
750 for macro in self._AutoGenObject.Macros.keys():\r
751 MacroName = '$('+ macro + ')'\r
752 if (Value.find(MacroName) != -1):\r
753 Value = Value.replace(MacroName, self._AutoGenObject.Macros[macro])\r
754 break\r
755 else:\r
3570e332 756 break\r
725cdb8f
YZ
757 RespDict[Key] = Value\r
758 for Target in BuildTargets:\r
759 for i, SingleCommand in enumerate(BuildTargets[Target].Commands):\r
760 if FlagDict[Flag]['Macro'] in SingleCommand:\r
761 BuildTargets[Target].Commands[i] = SingleCommand.replace('$(INC)','').replace(FlagDict[Flag]['Macro'], RespMacro)\r
762 return RespDict\r
763\r
f51461c8
LG
764 def ProcessBuildTargetList(self):\r
765 #\r
766 # Search dependency file list for each source file\r
767 #\r
768 ForceIncludedFile = []\r
769 for File in self._AutoGenObject.AutoGenFileList:\r
770 if File.Ext == '.h':\r
771 ForceIncludedFile.append(File)\r
772 SourceFileList = []\r
773 for Target in self._AutoGenObject.IntroTargetList:\r
774 SourceFileList.extend(Target.Inputs)\r
775\r
776 self.FileDependency = self.GetFileDependency(\r
777 SourceFileList,\r
778 ForceIncludedFile,\r
779 self._AutoGenObject.IncludePathList + self._AutoGenObject.BuildOptionIncPathList\r
780 )\r
781 DepSet = None\r
782 for File in self.FileDependency:\r
783 if not self.FileDependency[File]:\r
784 self.FileDependency[File] = ['$(FORCE_REBUILD)']\r
785 continue\r
786 # skip non-C files\r
787 if File.Ext not in [".c", ".C"] or File.Name == "AutoGen.c":\r
788 continue\r
789 elif DepSet == None:\r
790 DepSet = set(self.FileDependency[File])\r
791 else:\r
792 DepSet &= set(self.FileDependency[File])\r
793 # in case nothing in SourceFileList\r
794 if DepSet == None:\r
795 DepSet = set()\r
796 #\r
797 # Extract common files list in the dependency files\r
798 #\r
799 for File in DepSet:\r
800 self.CommonFileDependency.append(self.PlaceMacro(File.Path, self.Macros))\r
801\r
802 for File in self.FileDependency:\r
803 # skip non-C files\r
804 if File.Ext not in [".c", ".C"] or File.Name == "AutoGen.c":\r
805 continue\r
806 NewDepSet = set(self.FileDependency[File])\r
807 NewDepSet -= DepSet\r
808 self.FileDependency[File] = ["$(COMMON_DEPS)"] + list(NewDepSet)\r
809\r
810 # Convert target description object to target string in makefile\r
811 for Type in self._AutoGenObject.Targets:\r
812 for T in self._AutoGenObject.Targets[Type]:\r
813 # Generate related macros if needed\r
814 if T.GenFileListMacro and T.FileListMacro not in self.FileListMacros:\r
815 self.FileListMacros[T.FileListMacro] = []\r
816 if T.GenListFile and T.ListFileMacro not in self.ListFileMacros:\r
817 self.ListFileMacros[T.ListFileMacro] = []\r
818 if T.GenIncListFile and T.IncListFileMacro not in self.ListFileMacros:\r
819 self.ListFileMacros[T.IncListFileMacro] = []\r
820\r
821 Deps = []\r
822 # Add force-dependencies\r
823 for Dep in T.Dependencies:\r
824 Deps.append(self.PlaceMacro(str(Dep), self.Macros))\r
825 # Add inclusion-dependencies\r
826 if len(T.Inputs) == 1 and T.Inputs[0] in self.FileDependency:\r
827 for F in self.FileDependency[T.Inputs[0]]:\r
828 Deps.append(self.PlaceMacro(str(F), self.Macros))\r
829 # Add source-dependencies\r
830 for F in T.Inputs:\r
831 NewFile = self.PlaceMacro(str(F), self.Macros)\r
832 # In order to use file list macro as dependency\r
833 if T.GenListFile:\r
285a1754
SD
834 # gnu tools need forward slash path separater, even on Windows\r
835 self.ListFileMacros[T.ListFileMacro].append(str(F).replace ('\\', '/'))\r
f51461c8
LG
836 self.FileListMacros[T.FileListMacro].append(NewFile)\r
837 elif T.GenFileListMacro:\r
838 self.FileListMacros[T.FileListMacro].append(NewFile)\r
839 else:\r
840 Deps.append(NewFile)\r
841\r
842 # Use file list macro as dependency\r
843 if T.GenFileListMacro:\r
844 Deps.append("$(%s)" % T.FileListMacro)\r
845\r
846 TargetDict = {\r
847 "target" : self.PlaceMacro(T.Target.Path, self.Macros),\r
848 "cmd" : "\n\t".join(T.Commands),\r
849 "deps" : Deps\r
850 }\r
851 self.BuildTargetList.append(self._BUILD_TARGET_TEMPLATE.Replace(TargetDict))\r
852\r
853 ## For creating makefile targets for dependent libraries\r
854 def ProcessDependentLibrary(self):\r
855 for LibraryAutoGen in self._AutoGenObject.LibraryAutoGenList:\r
856 self.LibraryBuildDirectoryList.append(self.PlaceMacro(LibraryAutoGen.BuildDir, self.Macros))\r
857\r
858 ## Return a list containing source file's dependencies\r
859 #\r
860 # @param FileList The list of source files\r
861 # @param ForceInculeList The list of files which will be included forcely\r
862 # @param SearchPathList The list of search path\r
863 #\r
864 # @retval dict The mapping between source file path and its dependencies\r
865 #\r
866 def GetFileDependency(self, FileList, ForceInculeList, SearchPathList):\r
867 Dependency = {}\r
868 for F in FileList:\r
869 Dependency[F] = self.GetDependencyList(F, ForceInculeList, SearchPathList)\r
870 return Dependency\r
871\r
872 ## Find dependencies for one source file\r
873 #\r
874 # By searching recursively "#include" directive in file, find out all the\r
875 # files needed by given source file. The dependecies will be only searched\r
876 # in given search path list.\r
877 #\r
878 # @param File The source file\r
879 # @param ForceInculeList The list of files which will be included forcely\r
880 # @param SearchPathList The list of search path\r
881 #\r
882 # @retval list The list of files the given source file depends on\r
883 #\r
884 def GetDependencyList(self, File, ForceList, SearchPathList):\r
885 EdkLogger.debug(EdkLogger.DEBUG_1, "Try to get dependency files for %s" % File)\r
886 FileStack = [File] + ForceList\r
887 DependencySet = set()\r
888\r
889 if self._AutoGenObject.Arch not in gDependencyDatabase:\r
890 gDependencyDatabase[self._AutoGenObject.Arch] = {}\r
891 DepDb = gDependencyDatabase[self._AutoGenObject.Arch]\r
892\r
893 while len(FileStack) > 0:\r
894 F = FileStack.pop()\r
895\r
896 FullPathDependList = []\r
897 if F in self.FileCache:\r
898 for CacheFile in self.FileCache[F]:\r
899 FullPathDependList.append(CacheFile)\r
900 if CacheFile not in DependencySet:\r
901 FileStack.append(CacheFile)\r
902 DependencySet.update(FullPathDependList)\r
903 continue\r
904\r
905 CurrentFileDependencyList = []\r
906 if F in DepDb:\r
907 CurrentFileDependencyList = DepDb[F]\r
908 else:\r
909 try:\r
910 Fd = open(F.Path, 'r')\r
911 except BaseException, X:\r
47fea6af 912 EdkLogger.error("build", FILE_OPEN_FAILURE, ExtraData=F.Path + "\n\t" + str(X))\r
f51461c8
LG
913\r
914 FileContent = Fd.read()\r
915 Fd.close()\r
916 if len(FileContent) == 0:\r
917 continue\r
918\r
919 if FileContent[0] == 0xff or FileContent[0] == 0xfe:\r
920 FileContent = unicode(FileContent, "utf-16")\r
921 IncludedFileList = gIncludePattern.findall(FileContent)\r
922\r
923 for Inc in IncludedFileList:\r
924 Inc = Inc.strip()\r
925 # if there's macro used to reference header file, expand it\r
926 HeaderList = gMacroPattern.findall(Inc)\r
927 if len(HeaderList) == 1 and len(HeaderList[0]) == 2:\r
928 HeaderType = HeaderList[0][0]\r
929 HeaderKey = HeaderList[0][1]\r
930 if HeaderType in gIncludeMacroConversion:\r
931 Inc = gIncludeMacroConversion[HeaderType] % {"HeaderKey" : HeaderKey}\r
932 else:\r
933 # not known macro used in #include, always build the file by\r
934 # returning a empty dependency\r
935 self.FileCache[File] = []\r
936 return []\r
937 Inc = os.path.normpath(Inc)\r
938 CurrentFileDependencyList.append(Inc)\r
939 DepDb[F] = CurrentFileDependencyList\r
940\r
941 CurrentFilePath = F.Dir\r
942 PathList = [CurrentFilePath] + SearchPathList\r
943 for Inc in CurrentFileDependencyList:\r
944 for SearchPath in PathList:\r
945 FilePath = os.path.join(SearchPath, Inc)\r
946 if FilePath in gIsFileMap:\r
947 if not gIsFileMap[FilePath]:\r
948 continue\r
949 # If isfile is called too many times, the performance is slow down.\r
950 elif not os.path.isfile(FilePath):\r
951 gIsFileMap[FilePath] = False\r
952 continue\r
953 else:\r
954 gIsFileMap[FilePath] = True\r
955 FilePath = PathClass(FilePath)\r
956 FullPathDependList.append(FilePath)\r
957 if FilePath not in DependencySet:\r
958 FileStack.append(FilePath)\r
959 break\r
960 else:\r
961 EdkLogger.debug(EdkLogger.DEBUG_9, "%s included by %s was not found "\\r
962 "in any given path:\n\t%s" % (Inc, F, "\n\t".join(SearchPathList)))\r
963\r
964 self.FileCache[F] = FullPathDependList\r
965 DependencySet.update(FullPathDependList)\r
966\r
967 DependencySet.update(ForceList)\r
968 if File in DependencySet:\r
969 DependencySet.remove(File)\r
970 DependencyList = list(DependencySet) # remove duplicate ones\r
971\r
972 return DependencyList\r
973\r
974 _TemplateDict = property(_CreateTemplateDict)\r
975\r
976## CustomMakefile class\r
977#\r
978# This class encapsules makefie and its generation for module. It uses template to generate\r
979# the content of makefile. The content of makefile will be got from ModuleAutoGen object.\r
980#\r
981class CustomMakefile(BuildFile):\r
982 ## template used to generate the makefile for module with custom makefile\r
983 _TEMPLATE_ = TemplateString('''\\r
984${makefile_header}\r
985\r
986#\r
987# Platform Macro Definition\r
988#\r
989PLATFORM_NAME = ${platform_name}\r
990PLATFORM_GUID = ${platform_guid}\r
991PLATFORM_VERSION = ${platform_version}\r
992PLATFORM_RELATIVE_DIR = ${platform_relative_directory}\r
7a5f1426 993PLATFORM_DIR = ${platform_dir}\r
f51461c8
LG
994PLATFORM_OUTPUT_DIR = ${platform_output_directory}\r
995\r
996#\r
997# Module Macro Definition\r
998#\r
999MODULE_NAME = ${module_name}\r
1000MODULE_GUID = ${module_guid}\r
867d1cd4 1001MODULE_NAME_GUID = ${module_name_guid}\r
f51461c8
LG
1002MODULE_VERSION = ${module_version}\r
1003MODULE_TYPE = ${module_type}\r
1004MODULE_FILE = ${module_file}\r
1005MODULE_FILE_BASE_NAME = ${module_file_base_name}\r
1006BASE_NAME = $(MODULE_NAME)\r
1007MODULE_RELATIVE_DIR = ${module_relative_directory}\r
01e418d6 1008MODULE_DIR = ${module_dir}\r
f51461c8
LG
1009\r
1010#\r
1011# Build Configuration Macro Definition\r
1012#\r
1013ARCH = ${architecture}\r
1014TOOLCHAIN = ${toolchain_tag}\r
1015TOOLCHAIN_TAG = ${toolchain_tag}\r
1016TARGET = ${build_target}\r
1017\r
1018#\r
1019# Build Directory Macro Definition\r
1020#\r
1021# PLATFORM_BUILD_DIR = ${platform_build_directory}\r
1022BUILD_DIR = ${platform_build_directory}\r
1023BIN_DIR = $(BUILD_DIR)${separator}${architecture}\r
1024LIB_DIR = $(BIN_DIR)\r
1025MODULE_BUILD_DIR = ${module_build_directory}\r
1026OUTPUT_DIR = ${module_output_directory}\r
1027DEBUG_DIR = ${module_debug_directory}\r
1028DEST_DIR_OUTPUT = $(OUTPUT_DIR)\r
1029DEST_DIR_DEBUG = $(DEBUG_DIR)\r
1030\r
1031#\r
1032# Tools definitions specific to this module\r
1033#\r
1034${BEGIN}${module_tool_definitions}\r
1035${END}\r
1036MAKE_FILE = ${makefile_path}\r
1037\r
1038#\r
1039# Shell Command Macro\r
1040#\r
1041${BEGIN}${shell_command_code} = ${shell_command}\r
1042${END}\r
1043\r
1044${custom_makefile_content}\r
1045\r
1046#\r
1047# Target used when called from platform makefile, which will bypass the build of dependent libraries\r
1048#\r
1049\r
1050pbuild: init all\r
1051\r
1052\r
1053#\r
1054# ModuleTarget\r
1055#\r
1056\r
1057mbuild: init all\r
1058\r
1059#\r
1060# Build Target used in multi-thread build mode, which no init target is needed\r
1061#\r
1062\r
1063tbuild: all\r
1064\r
1065#\r
1066# Initialization target: print build information and create necessary directories\r
1067#\r
1068init:\r
1069\t-@echo Building ... $(MODULE_DIR)${separator}$(MODULE_FILE) [$(ARCH)]\r
1070${BEGIN}\t-@${create_directory_command}\n${END}\\r
1071\r
1072''')\r
1073\r
1074 ## Constructor of CustomMakefile\r
1075 #\r
1076 # @param ModuleAutoGen Object of ModuleAutoGen class\r
1077 #\r
1078 def __init__(self, ModuleAutoGen):\r
1079 BuildFile.__init__(self, ModuleAutoGen)\r
1080 self.PlatformInfo = self._AutoGenObject.PlatformInfo\r
1081 self.IntermediateDirectoryList = ["$(DEBUG_DIR)", "$(OUTPUT_DIR)"]\r
1082\r
1083 # Compose a dict object containing information used to do replacement in template\r
1084 def _CreateTemplateDict(self):\r
1085 Separator = self._SEP_[self._FileType]\r
1086 if self._FileType not in self._AutoGenObject.CustomMakefile:\r
1087 EdkLogger.error('build', OPTION_NOT_SUPPORTED, "No custom makefile for %s" % self._FileType,\r
1088 ExtraData="[%s]" % str(self._AutoGenObject))\r
01e418d6 1089 MakefilePath = mws.join(\r
f51461c8
LG
1090 self._AutoGenObject.WorkspaceDir,\r
1091 self._AutoGenObject.CustomMakefile[self._FileType]\r
1092 )\r
1093 try:\r
1094 CustomMakefile = open(MakefilePath, 'r').read()\r
1095 except:\r
1096 EdkLogger.error('build', FILE_OPEN_FAILURE, File=str(self._AutoGenObject),\r
1097 ExtraData=self._AutoGenObject.CustomMakefile[self._FileType])\r
1098\r
1099 # tools definitions\r
1100 ToolsDef = []\r
1101 for Tool in self._AutoGenObject.BuildOption:\r
1102 # Don't generate MAKE_FLAGS in makefile. It's put in environment variable.\r
1103 if Tool == "MAKE":\r
1104 continue\r
1105 for Attr in self._AutoGenObject.BuildOption[Tool]:\r
1106 if Attr == "FAMILY":\r
1107 continue\r
1108 elif Attr == "PATH":\r
1109 ToolsDef.append("%s = %s" % (Tool, self._AutoGenObject.BuildOption[Tool][Attr]))\r
1110 else:\r
1111 ToolsDef.append("%s_%s = %s" % (Tool, Attr, self._AutoGenObject.BuildOption[Tool][Attr]))\r
1112 ToolsDef.append("")\r
1113\r
1114 MakefileName = self._FILE_NAME_[self._FileType]\r
1115 MakefileTemplateDict = {\r
1116 "makefile_header" : self._FILE_HEADER_[self._FileType],\r
1117 "makefile_path" : os.path.join("$(MODULE_BUILD_DIR)", MakefileName),\r
1118 "platform_name" : self.PlatformInfo.Name,\r
1119 "platform_guid" : self.PlatformInfo.Guid,\r
1120 "platform_version" : self.PlatformInfo.Version,\r
1121 "platform_relative_directory": self.PlatformInfo.SourceDir,\r
1122 "platform_output_directory" : self.PlatformInfo.OutputDir,\r
017fb1cd 1123 "platform_dir" : self._AutoGenObject.Macros["PLATFORM_DIR"],\r
f51461c8
LG
1124\r
1125 "module_name" : self._AutoGenObject.Name,\r
1126 "module_guid" : self._AutoGenObject.Guid,\r
867d1cd4 1127 "module_name_guid" : self._AutoGenObject._GetUniqueBaseName(),\r
f51461c8
LG
1128 "module_version" : self._AutoGenObject.Version,\r
1129 "module_type" : self._AutoGenObject.ModuleType,\r
1130 "module_file" : self._AutoGenObject.MetaFile,\r
1131 "module_file_base_name" : self._AutoGenObject.MetaFile.BaseName,\r
1132 "module_relative_directory" : self._AutoGenObject.SourceDir,\r
01e418d6 1133 "module_dir" : mws.join (self._AutoGenObject.WorkspaceDir, self._AutoGenObject.SourceDir),\r
f51461c8
LG
1134\r
1135 "architecture" : self._AutoGenObject.Arch,\r
1136 "toolchain_tag" : self._AutoGenObject.ToolChain,\r
1137 "build_target" : self._AutoGenObject.BuildTarget,\r
1138\r
1139 "platform_build_directory" : self.PlatformInfo.BuildDir,\r
1140 "module_build_directory" : self._AutoGenObject.BuildDir,\r
1141 "module_output_directory" : self._AutoGenObject.OutputDir,\r
1142 "module_debug_directory" : self._AutoGenObject.DebugDir,\r
1143\r
1144 "separator" : Separator,\r
1145 "module_tool_definitions" : ToolsDef,\r
1146\r
1147 "shell_command_code" : self._SHELL_CMD_[self._FileType].keys(),\r
1148 "shell_command" : self._SHELL_CMD_[self._FileType].values(),\r
1149\r
1150 "create_directory_command" : self.GetCreateDirectoryCommand(self.IntermediateDirectoryList),\r
1151 "custom_makefile_content" : CustomMakefile\r
1152 }\r
1153\r
1154 return MakefileTemplateDict\r
1155\r
1156 _TemplateDict = property(_CreateTemplateDict)\r
1157\r
1158## PlatformMakefile class\r
1159#\r
1160# This class encapsules makefie and its generation for platform. It uses\r
1161# template to generate the content of makefile. The content of makefile will be\r
1162# got from PlatformAutoGen object.\r
1163#\r
1164class PlatformMakefile(BuildFile):\r
1165 ## template used to generate the makefile for platform\r
1166 _TEMPLATE_ = TemplateString('''\\r
1167${makefile_header}\r
1168\r
1169#\r
1170# Platform Macro Definition\r
1171#\r
1172PLATFORM_NAME = ${platform_name}\r
1173PLATFORM_GUID = ${platform_guid}\r
1174PLATFORM_VERSION = ${platform_version}\r
1175PLATFORM_FILE = ${platform_file}\r
7a5f1426 1176PLATFORM_DIR = ${platform_dir}\r
f51461c8
LG
1177PLATFORM_OUTPUT_DIR = ${platform_output_directory}\r
1178\r
1179#\r
1180# Build Configuration Macro Definition\r
1181#\r
1182TOOLCHAIN = ${toolchain_tag}\r
1183TOOLCHAIN_TAG = ${toolchain_tag}\r
1184TARGET = ${build_target}\r
1185\r
1186#\r
1187# Build Directory Macro Definition\r
1188#\r
1189BUILD_DIR = ${platform_build_directory}\r
1190FV_DIR = ${platform_build_directory}${separator}FV\r
1191\r
1192#\r
1193# Shell Command Macro\r
1194#\r
1195${BEGIN}${shell_command_code} = ${shell_command}\r
1196${END}\r
1197\r
1198MAKE = ${make_path}\r
1199MAKE_FILE = ${makefile_path}\r
1200\r
1201#\r
1202# Default target\r
1203#\r
1204all: init build_libraries build_modules\r
1205\r
1206#\r
1207# Initialization target: print build information and create necessary directories\r
1208#\r
1209init:\r
1210\t-@echo Building ... $(PLATFORM_FILE) [${build_architecture_list}]\r
1211\t${BEGIN}-@${create_directory_command}\r
1212\t${END}\r
1213#\r
1214# library build target\r
1215#\r
1216libraries: init build_libraries\r
1217\r
1218#\r
1219# module build target\r
1220#\r
1221modules: init build_libraries build_modules\r
1222\r
1223#\r
1224# Build all libraries:\r
1225#\r
1226build_libraries:\r
1227${BEGIN}\t@"$(MAKE)" $(MAKE_FLAGS) -f ${library_makefile_list} pbuild\r
1228${END}\t@cd $(BUILD_DIR)\r
1229\r
1230#\r
1231# Build all modules:\r
1232#\r
1233build_modules:\r
1234${BEGIN}\t@"$(MAKE)" $(MAKE_FLAGS) -f ${module_makefile_list} pbuild\r
1235${END}\t@cd $(BUILD_DIR)\r
1236\r
1237#\r
1238# Clean intermediate files\r
1239#\r
1240clean:\r
1241\t${BEGIN}-@${library_build_command} clean\r
1242\t${END}${BEGIN}-@${module_build_command} clean\r
1243\t${END}@cd $(BUILD_DIR)\r
1244\r
1245#\r
1246# Clean all generated files except to makefile\r
1247#\r
1248cleanall:\r
1249${BEGIN}\t${cleanall_command}\r
1250${END}\r
1251\r
1252#\r
1253# Clean all library files\r
1254#\r
1255cleanlib:\r
1256\t${BEGIN}-@${library_build_command} cleanall\r
1257\t${END}@cd $(BUILD_DIR)\n\r
1258''')\r
1259\r
1260 ## Constructor of PlatformMakefile\r
1261 #\r
1262 # @param ModuleAutoGen Object of PlatformAutoGen class\r
1263 #\r
1264 def __init__(self, PlatformAutoGen):\r
1265 BuildFile.__init__(self, PlatformAutoGen)\r
1266 self.ModuleBuildCommandList = []\r
1267 self.ModuleMakefileList = []\r
1268 self.IntermediateDirectoryList = []\r
1269 self.ModuleBuildDirectoryList = []\r
1270 self.LibraryBuildDirectoryList = []\r
03af2753 1271 self.LibraryMakeCommandList = []\r
f51461c8
LG
1272\r
1273 # Compose a dict object containing information used to do replacement in template\r
1274 def _CreateTemplateDict(self):\r
1275 Separator = self._SEP_[self._FileType]\r
1276\r
1277 PlatformInfo = self._AutoGenObject\r
1278 if "MAKE" not in PlatformInfo.ToolDefinition or "PATH" not in PlatformInfo.ToolDefinition["MAKE"]:\r
1279 EdkLogger.error("build", OPTION_MISSING, "No MAKE command defined. Please check your tools_def.txt!",\r
1280 ExtraData="[%s]" % str(self._AutoGenObject))\r
1281\r
1282 self.IntermediateDirectoryList = ["$(BUILD_DIR)"]\r
1283 self.ModuleBuildDirectoryList = self.GetModuleBuildDirectoryList()\r
1284 self.LibraryBuildDirectoryList = self.GetLibraryBuildDirectoryList()\r
1285\r
1286 MakefileName = self._FILE_NAME_[self._FileType]\r
1287 LibraryMakefileList = []\r
1288 LibraryMakeCommandList = []\r
1289 for D in self.LibraryBuildDirectoryList:\r
1290 D = self.PlaceMacro(D, {"BUILD_DIR":PlatformInfo.BuildDir})\r
1291 Makefile = os.path.join(D, MakefileName)\r
1292 Command = self._MAKE_TEMPLATE_[self._FileType] % {"file":Makefile}\r
1293 LibraryMakefileList.append(Makefile)\r
1294 LibraryMakeCommandList.append(Command)\r
03af2753 1295 self.LibraryMakeCommandList = LibraryMakeCommandList\r
f51461c8
LG
1296\r
1297 ModuleMakefileList = []\r
1298 ModuleMakeCommandList = []\r
1299 for D in self.ModuleBuildDirectoryList:\r
1300 D = self.PlaceMacro(D, {"BUILD_DIR":PlatformInfo.BuildDir})\r
1301 Makefile = os.path.join(D, MakefileName)\r
1302 Command = self._MAKE_TEMPLATE_[self._FileType] % {"file":Makefile}\r
1303 ModuleMakefileList.append(Makefile)\r
1304 ModuleMakeCommandList.append(Command)\r
1305\r
1306 MakefileTemplateDict = {\r
1307 "makefile_header" : self._FILE_HEADER_[self._FileType],\r
1308 "makefile_path" : os.path.join("$(BUILD_DIR)", MakefileName),\r
1309 "make_path" : PlatformInfo.ToolDefinition["MAKE"]["PATH"],\r
1310 "makefile_name" : MakefileName,\r
1311 "platform_name" : PlatformInfo.Name,\r
1312 "platform_guid" : PlatformInfo.Guid,\r
1313 "platform_version" : PlatformInfo.Version,\r
1314 "platform_file" : self._AutoGenObject.MetaFile,\r
1315 "platform_relative_directory": PlatformInfo.SourceDir,\r
1316 "platform_output_directory" : PlatformInfo.OutputDir,\r
1317 "platform_build_directory" : PlatformInfo.BuildDir,\r
017fb1cd 1318 "platform_dir" : self._AutoGenObject.Macros["PLATFORM_DIR"],\r
f51461c8
LG
1319\r
1320 "toolchain_tag" : PlatformInfo.ToolChain,\r
1321 "build_target" : PlatformInfo.BuildTarget,\r
1322 "shell_command_code" : self._SHELL_CMD_[self._FileType].keys(),\r
1323 "shell_command" : self._SHELL_CMD_[self._FileType].values(),\r
1324 "build_architecture_list" : self._AutoGenObject.Arch,\r
1325 "architecture" : self._AutoGenObject.Arch,\r
1326 "separator" : Separator,\r
1327 "create_directory_command" : self.GetCreateDirectoryCommand(self.IntermediateDirectoryList),\r
1328 "cleanall_command" : self.GetRemoveDirectoryCommand(self.IntermediateDirectoryList),\r
1329 "library_makefile_list" : LibraryMakefileList,\r
1330 "module_makefile_list" : ModuleMakefileList,\r
1331 "library_build_command" : LibraryMakeCommandList,\r
1332 "module_build_command" : ModuleMakeCommandList,\r
1333 }\r
1334\r
1335 return MakefileTemplateDict\r
1336\r
1337 ## Get the root directory list for intermediate files of all modules build\r
1338 #\r
1339 # @retval list The list of directory\r
1340 #\r
1341 def GetModuleBuildDirectoryList(self):\r
1342 DirList = []\r
1343 for ModuleAutoGen in self._AutoGenObject.ModuleAutoGenList:\r
97fa0ee9
YL
1344 if not ModuleAutoGen.IsBinaryModule:\r
1345 DirList.append(os.path.join(self._AutoGenObject.BuildDir, ModuleAutoGen.BuildDir))\r
f51461c8
LG
1346 return DirList\r
1347\r
1348 ## Get the root directory list for intermediate files of all libraries build\r
1349 #\r
1350 # @retval list The list of directory\r
1351 #\r
1352 def GetLibraryBuildDirectoryList(self):\r
1353 DirList = []\r
1354 for LibraryAutoGen in self._AutoGenObject.LibraryAutoGenList:\r
97fa0ee9
YL
1355 if not LibraryAutoGen.IsBinaryModule:\r
1356 DirList.append(os.path.join(self._AutoGenObject.BuildDir, LibraryAutoGen.BuildDir))\r
f51461c8
LG
1357 return DirList\r
1358\r
1359 _TemplateDict = property(_CreateTemplateDict)\r
1360\r
1361## TopLevelMakefile class\r
1362#\r
1363# This class encapsules makefie and its generation for entrance makefile. It\r
1364# uses template to generate the content of makefile. The content of makefile\r
1365# will be got from WorkspaceAutoGen object.\r
1366#\r
1367class TopLevelMakefile(BuildFile):\r
1368 ## template used to generate toplevel makefile\r
97fa0ee9 1369 _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
1370\r
1371 ## Constructor of TopLevelMakefile\r
1372 #\r
1373 # @param Workspace Object of WorkspaceAutoGen class\r
1374 #\r
1375 def __init__(self, Workspace):\r
1376 BuildFile.__init__(self, Workspace)\r
1377 self.IntermediateDirectoryList = []\r
1378\r
1379 # Compose a dict object containing information used to do replacement in template\r
1380 def _CreateTemplateDict(self):\r
1381 Separator = self._SEP_[self._FileType]\r
1382\r
1383 # any platform autogen object is ok because we just need common information\r
1384 PlatformInfo = self._AutoGenObject\r
1385\r
1386 if "MAKE" not in PlatformInfo.ToolDefinition or "PATH" not in PlatformInfo.ToolDefinition["MAKE"]:\r
1387 EdkLogger.error("build", OPTION_MISSING, "No MAKE command defined. Please check your tools_def.txt!",\r
1388 ExtraData="[%s]" % str(self._AutoGenObject))\r
1389\r
1390 for Arch in PlatformInfo.ArchList:\r
1391 self.IntermediateDirectoryList.append(Separator.join(["$(BUILD_DIR)", Arch]))\r
1392 self.IntermediateDirectoryList.append("$(FV_DIR)")\r
1393\r
1394 # TRICK: for not generating GenFds call in makefile if no FDF file\r
1395 MacroList = []\r
1396 if PlatformInfo.FdfFile != None and PlatformInfo.FdfFile != "":\r
1397 FdfFileList = [PlatformInfo.FdfFile]\r
1398 # macros passed to GenFds\r
1399 MacroList.append('"%s=%s"' % ("EFI_SOURCE", GlobalData.gEfiSource.replace('\\', '\\\\')))\r
1400 MacroList.append('"%s=%s"' % ("EDK_SOURCE", GlobalData.gEdkSource.replace('\\', '\\\\')))\r
1401 MacroDict = {}\r
1402 MacroDict.update(GlobalData.gGlobalDefines)\r
1403 MacroDict.update(GlobalData.gCommandLineDefines)\r
1404 MacroDict.pop("EFI_SOURCE", "dummy")\r
1405 MacroDict.pop("EDK_SOURCE", "dummy")\r
1406 for MacroName in MacroDict:\r
1407 if MacroDict[MacroName] != "":\r
1408 MacroList.append('"%s=%s"' % (MacroName, MacroDict[MacroName].replace('\\', '\\\\')))\r
1409 else:\r
1410 MacroList.append('"%s"' % MacroName)\r
1411 else:\r
1412 FdfFileList = []\r
1413\r
1414 # pass extra common options to external program called in makefile, currently GenFds.exe\r
1415 ExtraOption = ''\r
1416 LogLevel = EdkLogger.GetLevel()\r
1417 if LogLevel == EdkLogger.VERBOSE:\r
1418 ExtraOption += " -v"\r
1419 elif LogLevel <= EdkLogger.DEBUG_9:\r
1420 ExtraOption += " -d %d" % (LogLevel - 1)\r
1421 elif LogLevel == EdkLogger.QUIET:\r
1422 ExtraOption += " -q"\r
1423\r
1424 if GlobalData.gCaseInsensitive:\r
1425 ExtraOption += " -c"\r
1426\r
97fa0ee9
YL
1427 if GlobalData.gIgnoreSource:\r
1428 ExtraOption += " --ignore-sources"\r
1429\r
f51461c8
LG
1430 MakefileName = self._FILE_NAME_[self._FileType]\r
1431 SubBuildCommandList = []\r
1432 for A in PlatformInfo.ArchList:\r
1433 Command = self._MAKE_TEMPLATE_[self._FileType] % {"file":os.path.join("$(BUILD_DIR)", A, MakefileName)}\r
1434 SubBuildCommandList.append(Command)\r
1435\r
1436 MakefileTemplateDict = {\r
1437 "makefile_header" : self._FILE_HEADER_[self._FileType],\r
1438 "makefile_path" : os.path.join("$(BUILD_DIR)", MakefileName),\r
1439 "make_path" : PlatformInfo.ToolDefinition["MAKE"]["PATH"],\r
1440 "platform_name" : PlatformInfo.Name,\r
1441 "platform_guid" : PlatformInfo.Guid,\r
1442 "platform_version" : PlatformInfo.Version,\r
1443 "platform_build_directory" : PlatformInfo.BuildDir,\r
97fa0ee9 1444 "conf_directory" : GlobalData.gConfDirectory,\r
f51461c8
LG
1445\r
1446 "toolchain_tag" : PlatformInfo.ToolChain,\r
1447 "build_target" : PlatformInfo.BuildTarget,\r
1448 "shell_command_code" : self._SHELL_CMD_[self._FileType].keys(),\r
1449 "shell_command" : self._SHELL_CMD_[self._FileType].values(),\r
1450 'arch' : list(PlatformInfo.ArchList),\r
1451 "build_architecture_list" : ','.join(PlatformInfo.ArchList),\r
1452 "separator" : Separator,\r
1453 "create_directory_command" : self.GetCreateDirectoryCommand(self.IntermediateDirectoryList),\r
1454 "cleanall_command" : self.GetRemoveDirectoryCommand(self.IntermediateDirectoryList),\r
1455 "sub_build_command" : SubBuildCommandList,\r
1456 "fdf_file" : FdfFileList,\r
1457 "active_platform" : str(PlatformInfo),\r
1458 "fd" : PlatformInfo.FdTargetList,\r
1459 "fv" : PlatformInfo.FvTargetList,\r
1460 "cap" : PlatformInfo.CapTargetList,\r
1461 "extra_options" : ExtraOption,\r
1462 "macro" : MacroList,\r
1463 }\r
1464\r
1465 return MakefileTemplateDict\r
1466\r
1467 ## Get the root directory list for intermediate files of all modules build\r
1468 #\r
1469 # @retval list The list of directory\r
1470 #\r
1471 def GetModuleBuildDirectoryList(self):\r
1472 DirList = []\r
1473 for ModuleAutoGen in self._AutoGenObject.ModuleAutoGenList:\r
97fa0ee9
YL
1474 if not ModuleAutoGen.IsBinaryModule:\r
1475 DirList.append(os.path.join(self._AutoGenObject.BuildDir, ModuleAutoGen.BuildDir))\r
f51461c8
LG
1476 return DirList\r
1477\r
1478 ## Get the root directory list for intermediate files of all libraries build\r
1479 #\r
1480 # @retval list The list of directory\r
1481 #\r
1482 def GetLibraryBuildDirectoryList(self):\r
1483 DirList = []\r
1484 for LibraryAutoGen in self._AutoGenObject.LibraryAutoGenList:\r
97fa0ee9
YL
1485 if not LibraryAutoGen.IsBinaryModule:\r
1486 DirList.append(os.path.join(self._AutoGenObject.BuildDir, LibraryAutoGen.BuildDir))\r
f51461c8
LG
1487 return DirList\r
1488\r
1489 _TemplateDict = property(_CreateTemplateDict)\r
1490\r
1491# This acts like the main() function for the script, unless it is 'import'ed into another script.\r
1492if __name__ == '__main__':\r
1493 pass\r
1494\r