]> git.proxmox.com Git - mirror_edk2.git/blame - BaseTools/Source/Python/build/build.py
EmulatorPkg/Unix: Convert timezone from seconds to minutes
[mirror_edk2.git] / BaseTools / Source / Python / build / build.py
CommitLineData
52302d4d
LG
1## @file\r
2# build a platform or a module\r
3#\r
997a5d1b 4# Copyright (c) 2014, Hewlett-Packard Development Company, L.P.<BR>\r
f30e4aed 5# Copyright (c) 2007 - 2019, Intel Corporation. All rights reserved.<BR>\r
370544d1 6# Copyright (c) 2018, Hewlett Packard Enterprise Development, L.P.<BR>\r
52302d4d 7#\r
2e351cbe 8# SPDX-License-Identifier: BSD-2-Clause-Patent\r
52302d4d
LG
9#\r
10\r
11##\r
12# Import Modules\r
13#\r
1ccc4d89 14from __future__ import print_function\r
1be2ed90 15import Common.LongFilePathOs as os\r
52302d4d 16import re\r
52302d4d
LG
17import sys\r
18import glob\r
19import time\r
20import platform\r
21import traceback\r
4afd3d04 22import encodings.ascii\r
29af38b0 23import multiprocessing\r
52302d4d
LG
24\r
25from struct import *\r
26from threading import *\r
b2985672 27import threading\r
52302d4d
LG
28from optparse import OptionParser\r
29from subprocess import *\r
30from Common import Misc as Utils\r
31\r
1be2ed90 32from Common.LongFilePathSupport import OpenLongFilePath as open\r
938cf4c3
CJ
33from Common.TargetTxtClassObject import TargetTxtClassObject\r
34from Common.ToolDefClassObject import ToolDefClassObject\r
52302d4d 35from Common.DataType import *\r
b36d134f 36from Common.BuildVersion import gBUILD_VERSION\r
52302d4d
LG
37from AutoGen.AutoGen import *\r
38from Common.BuildToolError import *\r
2f818ed0 39from Workspace.WorkspaceDatabase import WorkspaceDatabase\r
05cc51ad 40from Common.MultipleWorkspace import MultipleWorkspace as mws\r
52302d4d
LG
41\r
42from BuildReport import BuildReport\r
43from GenPatchPcdTable.GenPatchPcdTable import *\r
44from PatchPcdValue.PatchPcdValue import *\r
45\r
46import Common.EdkLogger\r
47import Common.GlobalData as GlobalData\r
b3497bad 48from GenFds.GenFds import GenFds, GenFdsApi\r
52302d4d 49\r
ccaa7754 50from collections import OrderedDict, defaultdict\r
6e6d767e 51\r
52302d4d 52# Version and Copyright\r
4d10d18d 53VersionNumber = "0.60" + ' ' + gBUILD_VERSION\r
52302d4d 54__version__ = "%prog Version " + VersionNumber\r
f7496d71 55__copyright__ = "Copyright (c) 2007 - 2018, Intel Corporation All rights reserved."\r
52302d4d
LG
56\r
57## standard targets of build command\r
58gSupportedTarget = ['all', 'genc', 'genmake', 'modules', 'libraries', 'fds', 'clean', 'cleanall', 'cleanlib', 'run']\r
59\r
60## build configuration file\r
97fa0ee9
YL
61gBuildConfiguration = "target.txt"\r
62gToolsDefinition = "tools_def.txt"\r
52302d4d 63\r
64b2609f
LG
64TemporaryTablePattern = re.compile(r'^_\d+_\d+_[a-fA-F0-9]+$')\r
65TmpTableDict = {}\r
66\r
52302d4d
LG
67## Check environment PATH variable to make sure the specified tool is found\r
68#\r
69# If the tool is found in the PATH, then True is returned\r
70# Otherwise, False is returned\r
71#\r
72def IsToolInPath(tool):\r
27c4ceb4 73 if 'PATHEXT' in os.environ:\r
52302d4d
LG
74 extns = os.environ['PATHEXT'].split(os.path.pathsep)\r
75 else:\r
76 extns = ('',)\r
77 for pathDir in os.environ['PATH'].split(os.path.pathsep):\r
78 for ext in extns:\r
79 if os.path.exists(os.path.join(pathDir, tool + ext)):\r
80 return True\r
81 return False\r
82\r
83## Check environment variables\r
84#\r
85# Check environment variables that must be set for build. Currently they are\r
86#\r
87# WORKSPACE The directory all packages/platforms start from\r
88# EDK_TOOLS_PATH The directory contains all tools needed by the build\r
89# PATH $(EDK_TOOLS_PATH)/Bin/<sys> must be set in PATH\r
90#\r
91# If any of above environment variable is not set or has error, the build\r
92# will be broken.\r
93#\r
94def CheckEnvVariable():\r
95 # check WORKSPACE\r
96 if "WORKSPACE" not in os.environ:\r
97 EdkLogger.error("build", ATTRIBUTE_NOT_AVAILABLE, "Environment variable not found",\r
98 ExtraData="WORKSPACE")\r
99\r
100 WorkspaceDir = os.path.normcase(os.path.normpath(os.environ["WORKSPACE"]))\r
101 if not os.path.exists(WorkspaceDir):\r
caf74495 102 EdkLogger.error("build", FILE_NOT_FOUND, "WORKSPACE doesn't exist", ExtraData=WorkspaceDir)\r
52302d4d
LG
103 elif ' ' in WorkspaceDir:\r
104 EdkLogger.error("build", FORMAT_NOT_SUPPORTED, "No space is allowed in WORKSPACE path",\r
105 ExtraData=WorkspaceDir)\r
106 os.environ["WORKSPACE"] = WorkspaceDir\r
f7496d71 107\r
05cc51ad
LY
108 # set multiple workspace\r
109 PackagesPath = os.getenv("PACKAGES_PATH")\r
110 mws.setWs(WorkspaceDir, PackagesPath)\r
f6190a01
YZ
111 if mws.PACKAGES_PATH:\r
112 for Path in mws.PACKAGES_PATH:\r
113 if not os.path.exists(Path):\r
caf74495 114 EdkLogger.error("build", FILE_NOT_FOUND, "One Path in PACKAGES_PATH doesn't exist", ExtraData=Path)\r
f6190a01
YZ
115 elif ' ' in Path:\r
116 EdkLogger.error("build", FORMAT_NOT_SUPPORTED, "No space is allowed in PACKAGES_PATH", ExtraData=Path)\r
52302d4d 117\r
4afd3d04 118\r
52302d4d 119 os.environ["EDK_TOOLS_PATH"] = os.path.normcase(os.environ["EDK_TOOLS_PATH"])\r
4afd3d04 120\r
52302d4d
LG
121 # check EDK_TOOLS_PATH\r
122 if "EDK_TOOLS_PATH" not in os.environ:\r
123 EdkLogger.error("build", ATTRIBUTE_NOT_AVAILABLE, "Environment variable not found",\r
124 ExtraData="EDK_TOOLS_PATH")\r
125\r
126 # check PATH\r
127 if "PATH" not in os.environ:\r
128 EdkLogger.error("build", ATTRIBUTE_NOT_AVAILABLE, "Environment variable not found",\r
129 ExtraData="PATH")\r
130\r
131 GlobalData.gWorkspace = WorkspaceDir\r
52302d4d 132\r
0d2711a6 133 GlobalData.gGlobalDefines["WORKSPACE"] = WorkspaceDir\r
0d2711a6 134 GlobalData.gGlobalDefines["EDK_TOOLS_PATH"] = os.environ["EDK_TOOLS_PATH"]\r
f7496d71 135\r
52302d4d
LG
136## Get normalized file path\r
137#\r
138# Convert the path to be local format, and remove the WORKSPACE path at the\r
139# beginning if the file path is given in full path.\r
140#\r
141# @param FilePath File path to be normalized\r
142# @param Workspace Workspace path which the FilePath will be checked against\r
143#\r
144# @retval string The normalized file path\r
145#\r
146def NormFile(FilePath, Workspace):\r
147 # check if the path is absolute or relative\r
148 if os.path.isabs(FilePath):\r
149 FileFullPath = os.path.normpath(FilePath)\r
150 else:\r
05cc51ad
LY
151 FileFullPath = os.path.normpath(mws.join(Workspace, FilePath))\r
152 Workspace = mws.getWs(Workspace, FilePath)\r
52302d4d
LG
153\r
154 # check if the file path exists or not\r
155 if not os.path.isfile(FileFullPath):\r
47fea6af 156 EdkLogger.error("build", FILE_NOT_FOUND, ExtraData="\t%s (Please give file in absolute path or relative to WORKSPACE)" % FileFullPath)\r
52302d4d
LG
157\r
158 # remove workspace directory from the beginning part of the file path\r
159 if Workspace[-1] in ["\\", "/"]:\r
160 return FileFullPath[len(Workspace):]\r
161 else:\r
162 return FileFullPath[(len(Workspace) + 1):]\r
163\r
164## Get the output of an external program\r
165#\r
166# This is the entrance method of thread reading output of an external program and\r
167# putting them in STDOUT/STDERR of current program.\r
168#\r
169# @param From The stream message read from\r
170# @param To The stream message put on\r
171# @param ExitFlag The flag used to indicate stopping reading\r
172#\r
173def ReadMessage(From, To, ExitFlag):\r
174 while True:\r
175 # read one line a time\r
176 Line = From.readline()\r
177 # empty string means "end"\r
d943b0c3
FB
178 if Line is not None and Line != b"":\r
179 To(Line.rstrip().decode(encoding='utf-8', errors='ignore'))\r
52302d4d
LG
180 else:\r
181 break\r
182 if ExitFlag.isSet():\r
183 break\r
184\r
185## Launch an external program\r
186#\r
187# This method will call subprocess.Popen to execute an external program with\r
188# given options in specified directory. Because of the dead-lock issue during\r
189# redirecting output of the external program, threads are used to to do the\r
190# redirection work.\r
191#\r
192# @param Command A list or string containing the call of the program\r
193# @param WorkingDir The directory in which the program will be running\r
194#\r
195def LaunchCommand(Command, WorkingDir):\r
1b8eca8b 196 BeginTime = time.time()\r
52302d4d
LG
197 # if working directory doesn't exist, Popen() will raise an exception\r
198 if not os.path.isdir(WorkingDir):\r
199 EdkLogger.error("build", FILE_NOT_FOUND, ExtraData=WorkingDir)\r
f7496d71 200\r
01ce3538
HC
201 # Command is used as the first Argument in following Popen().\r
202 # It could be a string or sequence. We find that if command is a string in following Popen(),\r
203 # ubuntu may fail with an error message that the command is not found.\r
204 # So here we may need convert command from string to list instance.\r
ed728046
HW
205 if platform.system() != 'Windows':\r
206 if not isinstance(Command, list):\r
df0cee8d 207 Command = Command.split()\r
ed728046 208 Command = ' '.join(Command)\r
df0cee8d 209\r
52302d4d
LG
210 Proc = None\r
211 EndOfProcedure = None\r
212 try:\r
213 # launch the command\r
71f5913e 214 Proc = Popen(Command, stdout=PIPE, stderr=PIPE, env=os.environ, cwd=WorkingDir, bufsize=-1, shell=True)\r
52302d4d
LG
215\r
216 # launch two threads to read the STDOUT and STDERR\r
217 EndOfProcedure = Event()\r
218 EndOfProcedure.clear()\r
219 if Proc.stdout:\r
220 StdOutThread = Thread(target=ReadMessage, args=(Proc.stdout, EdkLogger.info, EndOfProcedure))\r
221 StdOutThread.setName("STDOUT-Redirector")\r
222 StdOutThread.setDaemon(False)\r
223 StdOutThread.start()\r
224\r
225 if Proc.stderr:\r
226 StdErrThread = Thread(target=ReadMessage, args=(Proc.stderr, EdkLogger.quiet, EndOfProcedure))\r
227 StdErrThread.setName("STDERR-Redirector")\r
228 StdErrThread.setDaemon(False)\r
229 StdErrThread.start()\r
230\r
231 # waiting for program exit\r
232 Proc.wait()\r
233 except: # in case of aborting\r
234 # terminate the threads redirecting the program output\r
790f60f2 235 EdkLogger.quiet("(Python %s on %s) " % (platform.python_version(), sys.platform) + traceback.format_exc())\r
4231a819 236 if EndOfProcedure is not None:\r
52302d4d 237 EndOfProcedure.set()\r
4231a819 238 if Proc is None:\r
0d1f5b2b 239 if not isinstance(Command, type("")):\r
52302d4d
LG
240 Command = " ".join(Command)\r
241 EdkLogger.error("build", COMMAND_FAILURE, "Failed to start command", ExtraData="%s [%s]" % (Command, WorkingDir))\r
242\r
243 if Proc.stdout:\r
244 StdOutThread.join()\r
245 if Proc.stderr:\r
246 StdErrThread.join()\r
247\r
248 # check the return code of the program\r
249 if Proc.returncode != 0:\r
0d1f5b2b 250 if not isinstance(Command, type("")):\r
52302d4d 251 Command = " ".join(Command)\r
725cdb8f
YZ
252 # print out the Response file and its content when make failure\r
253 RespFile = os.path.join(WorkingDir, 'OUTPUT', 'respfilelist.txt')\r
254 if os.path.isfile(RespFile):\r
255 f = open(RespFile)\r
256 RespContent = f.read()\r
257 f.close()\r
258 EdkLogger.info(RespContent)\r
259\r
52302d4d 260 EdkLogger.error("build", COMMAND_FAILURE, ExtraData="%s [%s]" % (Command, WorkingDir))\r
1b8eca8b 261 return "%dms" % (int(round((time.time() - BeginTime) * 1000)))\r
52302d4d
LG
262\r
263## The smallest unit that can be built in multi-thread build mode\r
264#\r
265# This is the base class of build unit. The "Obj" parameter must provide\r
266# __str__(), __eq__() and __hash__() methods. Otherwise there could be build units\r
267# missing build.\r
268#\r
269# Currently the "Obj" should be only ModuleAutoGen or PlatformAutoGen objects.\r
270#\r
271class BuildUnit:\r
272 ## The constructor\r
273 #\r
274 # @param self The object pointer\r
275 # @param Obj The object the build is working on\r
276 # @param Target The build target name, one of gSupportedTarget\r
277 # @param Dependency The BuildUnit(s) which must be completed in advance\r
278 # @param WorkingDir The directory build command starts in\r
279 #\r
280 def __init__(self, Obj, BuildCommand, Target, Dependency, WorkingDir="."):\r
281 self.BuildObject = Obj\r
282 self.Dependency = Dependency\r
283 self.WorkingDir = WorkingDir\r
284 self.Target = Target\r
285 self.BuildCommand = BuildCommand\r
0d2711a6
LG
286 if not BuildCommand:\r
287 EdkLogger.error("build", OPTION_MISSING,\r
288 "No build command found for this module. "\r
4afd3d04 289 "Please check your setting of %s_%s_%s_MAKE_PATH in Conf/tools_def.txt file." %\r
0d2711a6 290 (Obj.BuildTarget, Obj.ToolChain, Obj.Arch),\r
52302d4d
LG
291 ExtraData=str(Obj))\r
292\r
0d2711a6 293\r
52302d4d
LG
294 ## str() method\r
295 #\r
08dd311f 296 # It just returns the string representation of self.BuildObject\r
52302d4d
LG
297 #\r
298 # @param self The object pointer\r
299 #\r
300 def __str__(self):\r
301 return str(self.BuildObject)\r
302\r
303 ## "==" operator method\r
304 #\r
305 # It just compares self.BuildObject with "Other". So self.BuildObject must\r
306 # provide its own __eq__() method.\r
307 #\r
308 # @param self The object pointer\r
309 # @param Other The other BuildUnit object compared to\r
310 #\r
311 def __eq__(self, Other):\r
b7b51025
CJ
312 return Other and self.BuildObject == Other.BuildObject \\r
313 and Other.BuildObject \\r
52302d4d
LG
314 and self.BuildObject.Arch == Other.BuildObject.Arch\r
315\r
316 ## hash() method\r
317 #\r
318 # It just returns the hash value of self.BuildObject which must be hashable.\r
319 #\r
320 # @param self The object pointer\r
321 #\r
322 def __hash__(self):\r
323 return hash(self.BuildObject) + hash(self.BuildObject.Arch)\r
324\r
325 def __repr__(self):\r
326 return repr(self.BuildObject)\r
327\r
328## The smallest module unit that can be built by nmake/make command in multi-thread build mode\r
329#\r
330# This class is for module build by nmake/make build system. The "Obj" parameter\r
331# must provide __str__(), __eq__() and __hash__() methods. Otherwise there could\r
332# be make units missing build.\r
333#\r
334# Currently the "Obj" should be only ModuleAutoGen object.\r
335#\r
336class ModuleMakeUnit(BuildUnit):\r
337 ## The constructor\r
338 #\r
339 # @param self The object pointer\r
340 # @param Obj The ModuleAutoGen object the build is working on\r
341 # @param Target The build target name, one of gSupportedTarget\r
342 #\r
343 def __init__(self, Obj, Target):\r
344 Dependency = [ModuleMakeUnit(La, Target) for La in Obj.LibraryAutoGenList]\r
345 BuildUnit.__init__(self, Obj, Obj.BuildCommand, Target, Dependency, Obj.MakeFileDir)\r
346 if Target in [None, "", "all"]:\r
347 self.Target = "tbuild"\r
348\r
349## The smallest platform unit that can be built by nmake/make command in multi-thread build mode\r
350#\r
351# This class is for platform build by nmake/make build system. The "Obj" parameter\r
352# must provide __str__(), __eq__() and __hash__() methods. Otherwise there could\r
353# be make units missing build.\r
354#\r
355# Currently the "Obj" should be only PlatformAutoGen object.\r
356#\r
357class PlatformMakeUnit(BuildUnit):\r
358 ## The constructor\r
359 #\r
360 # @param self The object pointer\r
361 # @param Obj The PlatformAutoGen object the build is working on\r
362 # @param Target The build target name, one of gSupportedTarget\r
363 #\r
364 def __init__(self, Obj, Target):\r
365 Dependency = [ModuleMakeUnit(Lib, Target) for Lib in self.BuildObject.LibraryAutoGenList]\r
366 Dependency.extend([ModuleMakeUnit(Mod, Target) for Mod in self.BuildObject.ModuleAutoGenList])\r
367 BuildUnit.__init__(self, Obj, Obj.BuildCommand, Target, Dependency, Obj.MakeFileDir)\r
368\r
369## The class representing the task of a module build or platform build\r
370#\r
371# This class manages the build tasks in multi-thread build mode. Its jobs include\r
372# scheduling thread running, catching thread error, monitor the thread status, etc.\r
373#\r
374class BuildTask:\r
375 # queue for tasks waiting for schedule\r
6e6d767e 376 _PendingQueue = OrderedDict()\r
52302d4d
LG
377 _PendingQueueLock = threading.Lock()\r
378\r
379 # queue for tasks ready for running\r
6e6d767e 380 _ReadyQueue = OrderedDict()\r
52302d4d
LG
381 _ReadyQueueLock = threading.Lock()\r
382\r
383 # queue for run tasks\r
6e6d767e 384 _RunningQueue = OrderedDict()\r
52302d4d
LG
385 _RunningQueueLock = threading.Lock()\r
386\r
387 # queue containing all build tasks, in case duplicate build\r
6e6d767e 388 _TaskQueue = OrderedDict()\r
52302d4d
LG
389\r
390 # flag indicating error occurs in a running thread\r
391 _ErrorFlag = threading.Event()\r
392 _ErrorFlag.clear()\r
393 _ErrorMessage = ""\r
394\r
395 # BoundedSemaphore object used to control the number of running threads\r
396 _Thread = None\r
397\r
398 # flag indicating if the scheduler is started or not\r
399 _SchedulerStopped = threading.Event()\r
400 _SchedulerStopped.set()\r
401\r
402 ## Start the task scheduler thread\r
403 #\r
404 # @param MaxThreadNumber The maximum thread number\r
405 # @param ExitFlag Flag used to end the scheduler\r
406 #\r
407 @staticmethod\r
408 def StartScheduler(MaxThreadNumber, ExitFlag):\r
409 SchedulerThread = Thread(target=BuildTask.Scheduler, args=(MaxThreadNumber, ExitFlag))\r
410 SchedulerThread.setName("Build-Task-Scheduler")\r
411 SchedulerThread.setDaemon(False)\r
412 SchedulerThread.start()\r
413 # wait for the scheduler to be started, especially useful in Linux\r
414 while not BuildTask.IsOnGoing():\r
415 time.sleep(0.01)\r
416\r
417 ## Scheduler method\r
418 #\r
419 # @param MaxThreadNumber The maximum thread number\r
420 # @param ExitFlag Flag used to end the scheduler\r
421 #\r
422 @staticmethod\r
423 def Scheduler(MaxThreadNumber, ExitFlag):\r
424 BuildTask._SchedulerStopped.clear()\r
425 try:\r
426 # use BoundedSemaphore to control the maximum running threads\r
427 BuildTask._Thread = BoundedSemaphore(MaxThreadNumber)\r
428 #\r
429 # scheduling loop, which will exits when no pending/ready task and\r
430 # indicated to do so, or there's error in running thread\r
431 #\r
432 while (len(BuildTask._PendingQueue) > 0 or len(BuildTask._ReadyQueue) > 0 \\r
433 or not ExitFlag.isSet()) and not BuildTask._ErrorFlag.isSet():\r
434 EdkLogger.debug(EdkLogger.DEBUG_8, "Pending Queue (%d), Ready Queue (%d)"\r
435 % (len(BuildTask._PendingQueue), len(BuildTask._ReadyQueue)))\r
436\r
437 # get all pending tasks\r
438 BuildTask._PendingQueueLock.acquire()\r
f8d11e5a 439 BuildObjectList = list(BuildTask._PendingQueue.keys())\r
52302d4d
LG
440 #\r
441 # check if their dependency is resolved, and if true, move them\r
442 # into ready queue\r
443 #\r
444 for BuildObject in BuildObjectList:\r
445 Bt = BuildTask._PendingQueue[BuildObject]\r
446 if Bt.IsReady():\r
447 BuildTask._ReadyQueue[BuildObject] = BuildTask._PendingQueue.pop(BuildObject)\r
448 BuildTask._PendingQueueLock.release()\r
449\r
450 # launch build thread until the maximum number of threads is reached\r
451 while not BuildTask._ErrorFlag.isSet():\r
452 # empty ready queue, do nothing further\r
453 if len(BuildTask._ReadyQueue) == 0:\r
454 break\r
455\r
456 # wait for active thread(s) exit\r
457 BuildTask._Thread.acquire(True)\r
458\r
459 # start a new build thread\r
ccaa7754 460 Bo, Bt = BuildTask._ReadyQueue.popitem()\r
52302d4d
LG
461\r
462 # move into running queue\r
463 BuildTask._RunningQueueLock.acquire()\r
464 BuildTask._RunningQueue[Bo] = Bt\r
465 BuildTask._RunningQueueLock.release()\r
466\r
467 Bt.Start()\r
468 # avoid tense loop\r
469 time.sleep(0.01)\r
470\r
471 # avoid tense loop\r
472 time.sleep(0.01)\r
473\r
474 # wait for all running threads exit\r
475 if BuildTask._ErrorFlag.isSet():\r
476 EdkLogger.quiet("\nWaiting for all build threads exit...")\r
477 # while not BuildTask._ErrorFlag.isSet() and \\r
478 while len(BuildTask._RunningQueue) > 0:\r
479 EdkLogger.verbose("Waiting for thread ending...(%d)" % len(BuildTask._RunningQueue))\r
8252e6bf 480 EdkLogger.debug(EdkLogger.DEBUG_8, "Threads [%s]" % ", ".join(Th.getName() for Th in threading.enumerate()))\r
52302d4d
LG
481 # avoid tense loop\r
482 time.sleep(0.1)\r
5b0671c1 483 except BaseException as X:\r
52302d4d 484 #\r
fb0b35e0 485 # TRICK: hide the output of threads left running, so that the user can\r
52302d4d
LG
486 # catch the error message easily\r
487 #\r
488 EdkLogger.SetLevel(EdkLogger.ERROR)\r
489 BuildTask._ErrorFlag.set()\r
490 BuildTask._ErrorMessage = "build thread scheduler error\n\t%s" % str(X)\r
491\r
492 BuildTask._PendingQueue.clear()\r
493 BuildTask._ReadyQueue.clear()\r
494 BuildTask._RunningQueue.clear()\r
495 BuildTask._TaskQueue.clear()\r
496 BuildTask._SchedulerStopped.set()\r
497\r
498 ## Wait for all running method exit\r
499 #\r
500 @staticmethod\r
501 def WaitForComplete():\r
502 BuildTask._SchedulerStopped.wait()\r
503\r
504 ## Check if the scheduler is running or not\r
505 #\r
506 @staticmethod\r
507 def IsOnGoing():\r
508 return not BuildTask._SchedulerStopped.isSet()\r
509\r
510 ## Abort the build\r
511 @staticmethod\r
512 def Abort():\r
513 if BuildTask.IsOnGoing():\r
514 BuildTask._ErrorFlag.set()\r
515 BuildTask.WaitForComplete()\r
516\r
517 ## Check if there's error in running thread\r
518 #\r
519 # Since the main thread cannot catch exceptions in other thread, we have to\r
520 # use threading.Event to communicate this formation to main thread.\r
521 #\r
522 @staticmethod\r
523 def HasError():\r
524 return BuildTask._ErrorFlag.isSet()\r
525\r
526 ## Get error message in running thread\r
527 #\r
528 # Since the main thread cannot catch exceptions in other thread, we have to\r
529 # use a static variable to communicate this message to main thread.\r
530 #\r
531 @staticmethod\r
532 def GetErrorMessage():\r
533 return BuildTask._ErrorMessage\r
534\r
535 ## Factory method to create a BuildTask object\r
536 #\r
537 # This method will check if a module is building or has been built. And if\r
538 # true, just return the associated BuildTask object in the _TaskQueue. If\r
539 # not, create and return a new BuildTask object. The new BuildTask object\r
540 # will be appended to the _PendingQueue for scheduling later.\r
541 #\r
542 # @param BuildItem A BuildUnit object representing a build object\r
543 # @param Dependency The dependent build object of BuildItem\r
544 #\r
545 @staticmethod\r
546 def New(BuildItem, Dependency=None):\r
547 if BuildItem in BuildTask._TaskQueue:\r
548 Bt = BuildTask._TaskQueue[BuildItem]\r
549 return Bt\r
550\r
551 Bt = BuildTask()\r
552 Bt._Init(BuildItem, Dependency)\r
553 BuildTask._TaskQueue[BuildItem] = Bt\r
554\r
555 BuildTask._PendingQueueLock.acquire()\r
556 BuildTask._PendingQueue[BuildItem] = Bt\r
557 BuildTask._PendingQueueLock.release()\r
558\r
559 return Bt\r
560\r
561 ## The real constructor of BuildTask\r
562 #\r
563 # @param BuildItem A BuildUnit object representing a build object\r
564 # @param Dependency The dependent build object of BuildItem\r
565 #\r
566 def _Init(self, BuildItem, Dependency=None):\r
567 self.BuildItem = BuildItem\r
568\r
569 self.DependencyList = []\r
4231a819 570 if Dependency is None:\r
52302d4d
LG
571 Dependency = BuildItem.Dependency\r
572 else:\r
573 Dependency.extend(BuildItem.Dependency)\r
574 self.AddDependency(Dependency)\r
575 # flag indicating build completes, used to avoid unnecessary re-build\r
576 self.CompleteFlag = False\r
577\r
578 ## Check if all dependent build tasks are completed or not\r
579 #\r
580 def IsReady(self):\r
581 ReadyFlag = True\r
582 for Dep in self.DependencyList:\r
583 if Dep.CompleteFlag == True:\r
584 continue\r
585 ReadyFlag = False\r
586 break\r
587\r
588 return ReadyFlag\r
589\r
590 ## Add dependent build task\r
591 #\r
592 # @param Dependency The list of dependent build objects\r
593 #\r
594 def AddDependency(self, Dependency):\r
595 for Dep in Dependency:\r
a7ef158b 596 if not Dep.BuildObject.IsBinaryModule and not Dep.BuildObject.CanSkipbyHash():\r
97fa0ee9 597 self.DependencyList.append(BuildTask.New(Dep)) # BuildTask list\r
52302d4d
LG
598\r
599 ## The thread wrapper of LaunchCommand function\r
600 #\r
601 # @param Command A list or string contains the call of the command\r
602 # @param WorkingDir The directory in which the program will be running\r
603 #\r
604 def _CommandThread(self, Command, WorkingDir):\r
605 try:\r
1b8eca8b 606 self.BuildItem.BuildObject.BuildTime = LaunchCommand(Command, WorkingDir)\r
52302d4d 607 self.CompleteFlag = True\r
a7ef158b
RC
608\r
609 # Run hash operation post dependency, to account for libs\r
610 if GlobalData.gUseHashCache and self.BuildItem.BuildObject.IsLibrary:\r
611 HashFile = path.join(self.BuildItem.BuildObject.BuildDir, self.BuildItem.BuildObject.Name + ".hash")\r
612 SaveFileOnChange(HashFile, self.BuildItem.BuildObject.GenModuleHash(), True)\r
52302d4d
LG
613 except:\r
614 #\r
fb0b35e0 615 # TRICK: hide the output of threads left running, so that the user can\r
52302d4d
LG
616 # catch the error message easily\r
617 #\r
618 if not BuildTask._ErrorFlag.isSet():\r
619 GlobalData.gBuildingModule = "%s [%s, %s, %s]" % (str(self.BuildItem.BuildObject),\r
620 self.BuildItem.BuildObject.Arch,\r
621 self.BuildItem.BuildObject.ToolChain,\r
622 self.BuildItem.BuildObject.BuildTarget\r
623 )\r
624 EdkLogger.SetLevel(EdkLogger.ERROR)\r
625 BuildTask._ErrorFlag.set()\r
626 BuildTask._ErrorMessage = "%s broken\n %s [%s]" % \\r
627 (threading.currentThread().getName(), Command, WorkingDir)\r
48b0bf64
RC
628\r
629 # Set the value used by hash invalidation flow in GlobalData.gModuleBuildTracking to 'SUCCESS'\r
630 # If Module or Lib is being tracked, it did not fail header check test, and built successfully\r
631 if (self.BuildItem.BuildObject.Arch in GlobalData.gModuleBuildTracking and\r
632 self.BuildItem.BuildObject in GlobalData.gModuleBuildTracking[self.BuildItem.BuildObject.Arch] and\r
633 GlobalData.gModuleBuildTracking[self.BuildItem.BuildObject.Arch][self.BuildItem.BuildObject] != 'FAIL_METAFILE' and\r
634 not BuildTask._ErrorFlag.isSet()\r
635 ):\r
636 GlobalData.gModuleBuildTracking[self.BuildItem.BuildObject.Arch][self.BuildItem.BuildObject] = 'SUCCESS'\r
637\r
52302d4d
LG
638 # indicate there's a thread is available for another build task\r
639 BuildTask._RunningQueueLock.acquire()\r
640 BuildTask._RunningQueue.pop(self.BuildItem)\r
641 BuildTask._RunningQueueLock.release()\r
642 BuildTask._Thread.release()\r
643\r
644 ## Start build task thread\r
645 #\r
646 def Start(self):\r
647 EdkLogger.quiet("Building ... %s" % repr(self.BuildItem))\r
648 Command = self.BuildItem.BuildCommand + [self.BuildItem.Target]\r
649 self.BuildTread = Thread(target=self._CommandThread, args=(Command, self.BuildItem.WorkingDir))\r
650 self.BuildTread.setName("build thread")\r
651 self.BuildTread.setDaemon(False)\r
652 self.BuildTread.start()\r
653\r
654## The class contains the information related to EFI image\r
655#\r
656class PeImageInfo():\r
657 ## Constructor\r
658 #\r
659 # Constructor will load all required image information.\r
660 #\r
4afd3d04 661 # @param BaseName The full file path of image.\r
52302d4d
LG
662 # @param Guid The GUID for image.\r
663 # @param Arch Arch of this image.\r
f3decdc3
LG
664 # @param OutputDir The output directory for image.\r
665 # @param DebugDir The debug directory for image.\r
52302d4d
LG
666 # @param ImageClass PeImage Information\r
667 #\r
f3decdc3 668 def __init__(self, BaseName, Guid, Arch, OutputDir, DebugDir, ImageClass):\r
52302d4d
LG
669 self.BaseName = BaseName\r
670 self.Guid = Guid\r
671 self.Arch = Arch\r
f3decdc3
LG
672 self.OutputDir = OutputDir\r
673 self.DebugDir = DebugDir\r
52302d4d 674 self.Image = ImageClass\r
b3e94a06 675 self.Image.Size = (self.Image.Size // 0x1000 + 1) * 0x1000\r
52302d4d
LG
676\r
677## The class implementing the EDK2 build process\r
678#\r
679# The build process includes:\r
680# 1. Load configuration from target.txt and tools_def.txt in $(WORKSPACE)/Conf\r
681# 2. Parse DSC file of active platform\r
682# 3. Parse FDF file if any\r
683# 4. Establish build database, including parse all other files (module, package)\r
684# 5. Create AutoGen files (C code file, depex file, makefile) if necessary\r
685# 6. Call build command\r
686#\r
687class Build():\r
688 ## Constructor\r
689 #\r
690 # Constructor will load all necessary configurations, parse platform, modules\r
691 # and packages and the establish a database for AutoGen.\r
692 #\r
693 # @param Target The build command target, one of gSupportedTarget\r
694 # @param WorkspaceDir The directory of workspace\r
0d2711a6
LG
695 # @param BuildOptions Build options passed from command line\r
696 #\r
697 def __init__(self, Target, WorkspaceDir, BuildOptions):\r
698 self.WorkspaceDir = WorkspaceDir\r
52302d4d 699 self.Target = Target\r
0d2711a6
LG
700 self.PlatformFile = BuildOptions.PlatformFile\r
701 self.ModuleFile = BuildOptions.ModuleFile\r
702 self.ArchList = BuildOptions.TargetArch\r
703 self.ToolChainList = BuildOptions.ToolChain\r
704 self.BuildTargetList= BuildOptions.BuildTarget\r
705 self.Fdf = BuildOptions.FdfFile\r
706 self.FdList = BuildOptions.RomImage\r
707 self.FvList = BuildOptions.FvImage\r
708 self.CapList = BuildOptions.CapName\r
709 self.SilentMode = BuildOptions.SilentMode\r
710 self.ThreadNumber = BuildOptions.ThreadNumber\r
711 self.SkipAutoGen = BuildOptions.SkipAutoGen\r
712 self.Reparse = BuildOptions.Reparse\r
713 self.SkuId = BuildOptions.SkuId\r
e651d06c
LG
714 if self.SkuId:\r
715 GlobalData.gSKUID_CMD = self.SkuId\r
97fa0ee9 716 self.ConfDirectory = BuildOptions.ConfDirectory\r
52302d4d 717 self.SpawnMode = True\r
0d2711a6 718 self.BuildReport = BuildReport(BuildOptions.ReportFile, BuildOptions.ReportType)\r
52302d4d
LG
719 self.TargetTxt = TargetTxtClassObject()\r
720 self.ToolDef = ToolDefClassObject()\r
1b8eca8b
YZ
721 self.AutoGenTime = 0\r
722 self.MakeTime = 0\r
723 self.GenFdsTime = 0\r
b854e2bf 724 GlobalData.BuildOptionPcd = BuildOptions.OptionPcd if BuildOptions.OptionPcd else []\r
fae62ff2
HC
725 #Set global flag for build mode\r
726 GlobalData.gIgnoreSource = BuildOptions.IgnoreSources\r
36d083ef
YZ
727 GlobalData.gUseHashCache = BuildOptions.UseHashCache\r
728 GlobalData.gBinCacheDest = BuildOptions.BinCacheDest\r
729 GlobalData.gBinCacheSource = BuildOptions.BinCacheSource\r
37de70b7 730 GlobalData.gEnableGenfdsMultiThread = BuildOptions.GenfdsMultiThread\r
d868846a 731 GlobalData.gDisableIncludePathCheck = BuildOptions.DisableIncludePathCheck\r
36d083ef
YZ
732\r
733 if GlobalData.gBinCacheDest and not GlobalData.gUseHashCache:\r
734 EdkLogger.error("build", OPTION_NOT_SUPPORTED, ExtraData="--binary-destination must be used together with --hash.")\r
735\r
736 if GlobalData.gBinCacheSource and not GlobalData.gUseHashCache:\r
737 EdkLogger.error("build", OPTION_NOT_SUPPORTED, ExtraData="--binary-source must be used together with --hash.")\r
738\r
739 if GlobalData.gBinCacheDest and GlobalData.gBinCacheSource:\r
740 EdkLogger.error("build", OPTION_NOT_SUPPORTED, ExtraData="--binary-destination can not be used together with --binary-source.")\r
741\r
742 if GlobalData.gBinCacheSource:\r
743 BinCacheSource = os.path.normpath(GlobalData.gBinCacheSource)\r
744 if not os.path.isabs(BinCacheSource):\r
745 BinCacheSource = mws.join(self.WorkspaceDir, BinCacheSource)\r
746 GlobalData.gBinCacheSource = BinCacheSource\r
f21547ff 747 else:\r
4231a819 748 if GlobalData.gBinCacheSource is not None:\r
f21547ff 749 EdkLogger.error("build", OPTION_VALUE_INVALID, ExtraData="Invalid value of option --binary-source.")\r
36d083ef
YZ
750\r
751 if GlobalData.gBinCacheDest:\r
752 BinCacheDest = os.path.normpath(GlobalData.gBinCacheDest)\r
753 if not os.path.isabs(BinCacheDest):\r
754 BinCacheDest = mws.join(self.WorkspaceDir, BinCacheDest)\r
755 GlobalData.gBinCacheDest = BinCacheDest\r
f21547ff 756 else:\r
4231a819 757 if GlobalData.gBinCacheDest is not None:\r
f21547ff 758 EdkLogger.error("build", OPTION_VALUE_INVALID, ExtraData="Invalid value of option --binary-destination.")\r
97fa0ee9
YL
759\r
760 if self.ConfDirectory:\r
761 # Get alternate Conf location, if it is absolute, then just use the absolute directory name\r
762 ConfDirectoryPath = os.path.normpath(self.ConfDirectory)\r
763\r
764 if not os.path.isabs(ConfDirectoryPath):\r
765 # Since alternate directory name is not absolute, the alternate directory is located within the WORKSPACE\r
766 # This also handles someone specifying the Conf directory in the workspace. Using --conf=Conf\r
05cc51ad 767 ConfDirectoryPath = mws.join(self.WorkspaceDir, ConfDirectoryPath)\r
97fa0ee9 768 else:\r
00bcb5c2
YZ
769 if "CONF_PATH" in os.environ:\r
770 ConfDirectoryPath = os.path.normcase(os.path.normpath(os.environ["CONF_PATH"]))\r
771 else:\r
772 # Get standard WORKSPACE/Conf use the absolute path to the WORKSPACE/Conf\r
773 ConfDirectoryPath = mws.join(self.WorkspaceDir, 'Conf')\r
97fa0ee9
YL
774 GlobalData.gConfDirectory = ConfDirectoryPath\r
775 GlobalData.gDatabasePath = os.path.normpath(os.path.join(ConfDirectoryPath, GlobalData.gDatabasePath))\r
776\r
2f818ed0 777 self.Db = WorkspaceDatabase()\r
97fa0ee9
YL
778 self.BuildDatabase = self.Db.BuildObject\r
779 self.Platform = None\r
40b4e21d 780 self.ToolChainFamily = None\r
52302d4d 781 self.LoadFixAddress = 0\r
0d2711a6 782 self.UniFlag = BuildOptions.Flag\r
a0a2cd1e 783 self.BuildModules = []\r
83397f95 784 self.HashSkipModules = []\r
f0dc69e6
YZ
785 self.Db_Flag = False\r
786 self.LaunchPrebuildFlag = False\r
ccaa7754 787 self.PlatformBuildPath = os.path.join(GlobalData.gConfDirectory, '.cache', '.PlatformBuild')\r
725cdb8f
YZ
788 if BuildOptions.CommandLength:\r
789 GlobalData.gCommandMaxLength = BuildOptions.CommandLength\r
790\r
e56468c0 791 # print dot character during doing some time-consuming work\r
52302d4d 792 self.Progress = Utils.Progressor()\r
52302d4d 793 # print current build environment and configuration\r
0d2711a6 794 EdkLogger.quiet("%-16s = %s" % ("WORKSPACE", os.environ["WORKSPACE"]))\r
f25da33d 795 if "PACKAGES_PATH" in os.environ:\r
f7496d71 796 # WORKSPACE env has been converted before. Print the same path style with WORKSPACE env.\r
f25da33d 797 EdkLogger.quiet("%-16s = %s" % ("PACKAGES_PATH", os.path.normcase(os.path.normpath(os.environ["PACKAGES_PATH"]))))\r
0d2711a6 798 EdkLogger.quiet("%-16s = %s" % ("EDK_TOOLS_PATH", os.environ["EDK_TOOLS_PATH"]))\r
f25da33d 799 if "EDK_TOOLS_BIN" in os.environ:\r
f7496d71 800 # Print the same path style with WORKSPACE env.\r
f25da33d 801 EdkLogger.quiet("%-16s = %s" % ("EDK_TOOLS_BIN", os.path.normcase(os.path.normpath(os.environ["EDK_TOOLS_BIN"]))))\r
00bcb5c2 802 EdkLogger.quiet("%-16s = %s" % ("CONF_PATH", GlobalData.gConfDirectory))\r
fd2d7400
ZF
803 if "PYTHON3_ENABLE" in os.environ:\r
804 PYTHON3_ENABLE = os.environ["PYTHON3_ENABLE"]\r
805 if PYTHON3_ENABLE != "TRUE":\r
806 PYTHON3_ENABLE = "FALSE"\r
807 EdkLogger.quiet("%-16s = %s" % ("PYTHON3_ENABLE", PYTHON3_ENABLE))\r
7aef7b7c
LG
808 if "PYTHON_COMMAND" in os.environ:\r
809 EdkLogger.quiet("%-16s = %s" % ("PYTHON_COMMAND", os.environ["PYTHON_COMMAND"]))\r
f0dc69e6
YZ
810 self.InitPreBuild()\r
811 self.InitPostBuild()\r
af9c4e5e
MK
812 if self.Prebuild:\r
813 EdkLogger.quiet("%-16s = %s" % ("PREBUILD", self.Prebuild))\r
814 if self.Postbuild:\r
815 EdkLogger.quiet("%-16s = %s" % ("POSTBUILD", self.Postbuild))\r
816 if self.Prebuild:\r
f0dc69e6 817 self.LaunchPrebuild()\r
a0c9ce31
YZ
818 self.TargetTxt = TargetTxtClassObject()\r
819 self.ToolDef = ToolDefClassObject()\r
f0dc69e6
YZ
820 if not (self.LaunchPrebuildFlag and os.path.exists(self.PlatformBuildPath)):\r
821 self.InitBuild()\r
52302d4d 822\r
f0dc69e6 823 EdkLogger.info("")\r
52302d4d 824 os.chdir(self.WorkspaceDir)\r
52302d4d
LG
825\r
826 ## Load configuration\r
827 #\r
828 # This method will parse target.txt and get the build configurations.\r
829 #\r
830 def LoadConfiguration(self):\r
831 #\r
832 # Check target.txt and tools_def.txt and Init them\r
833 #\r
97fa0ee9 834 BuildConfigurationFile = os.path.normpath(os.path.join(GlobalData.gConfDirectory, gBuildConfiguration))\r
52302d4d
LG
835 if os.path.isfile(BuildConfigurationFile) == True:\r
836 StatusCode = self.TargetTxt.LoadTargetTxtFile(BuildConfigurationFile)\r
837\r
938cf4c3 838 ToolDefinitionFile = self.TargetTxt.TargetTxtDictionary[TAB_TAT_DEFINES_TOOL_CHAIN_CONF]\r
52302d4d
LG
839 if ToolDefinitionFile == '':\r
840 ToolDefinitionFile = gToolsDefinition\r
05cc51ad 841 ToolDefinitionFile = os.path.normpath(mws.join(self.WorkspaceDir, 'Conf', ToolDefinitionFile))\r
52302d4d
LG
842 if os.path.isfile(ToolDefinitionFile) == True:\r
843 StatusCode = self.ToolDef.LoadToolDefFile(ToolDefinitionFile)\r
844 else:\r
845 EdkLogger.error("build", FILE_NOT_FOUND, ExtraData=ToolDefinitionFile)\r
846 else:\r
847 EdkLogger.error("build", FILE_NOT_FOUND, ExtraData=BuildConfigurationFile)\r
848\r
849 # if no ARCH given in command line, get it from target.txt\r
0d2711a6 850 if not self.ArchList:\r
938cf4c3 851 self.ArchList = self.TargetTxt.TargetTxtDictionary[TAB_TAT_DEFINES_TARGET_ARCH]\r
0d2711a6 852 self.ArchList = tuple(self.ArchList)\r
52302d4d
LG
853\r
854 # if no build target given in command line, get it from target.txt\r
0d2711a6 855 if not self.BuildTargetList:\r
938cf4c3 856 self.BuildTargetList = self.TargetTxt.TargetTxtDictionary[TAB_TAT_DEFINES_TARGET]\r
52302d4d
LG
857\r
858 # if no tool chain given in command line, get it from target.txt\r
0d2711a6 859 if not self.ToolChainList:\r
938cf4c3 860 self.ToolChainList = self.TargetTxt.TargetTxtDictionary[TAB_TAT_DEFINES_TOOL_CHAIN_TAG]\r
4231a819 861 if self.ToolChainList is None or len(self.ToolChainList) == 0:\r
52302d4d
LG
862 EdkLogger.error("build", RESOURCE_NOT_AVAILABLE, ExtraData="No toolchain given. Don't know how to build.\n")\r
863\r
864 # check if the tool chains are defined or not\r
865 NewToolChainList = []\r
866 for ToolChain in self.ToolChainList:\r
867 if ToolChain not in self.ToolDef.ToolsDefTxtDatabase[TAB_TOD_DEFINES_TOOL_CHAIN_TAG]:\r
868 EdkLogger.warn("build", "Tool chain [%s] is not defined" % ToolChain)\r
869 else:\r
870 NewToolChainList.append(ToolChain)\r
871 # if no tool chain available, break the build\r
872 if len(NewToolChainList) == 0:\r
873 EdkLogger.error("build", RESOURCE_NOT_AVAILABLE,\r
874 ExtraData="[%s] not defined. No toolchain available for build!\n" % ", ".join(self.ToolChainList))\r
875 else:\r
876 self.ToolChainList = NewToolChainList\r
877\r
40b4e21d
YZ
878 ToolChainFamily = []\r
879 ToolDefinition = self.ToolDef.ToolsDefTxtDatabase\r
880 for Tool in self.ToolChainList:\r
881 if TAB_TOD_DEFINES_FAMILY not in ToolDefinition or Tool not in ToolDefinition[TAB_TOD_DEFINES_FAMILY] \\r
882 or not ToolDefinition[TAB_TOD_DEFINES_FAMILY][Tool]:\r
688c7d21 883 EdkLogger.warn("build", "No tool chain family found in configuration for %s. Default to MSFT." % Tool)\r
94c04559 884 ToolChainFamily.append(TAB_COMPILER_MSFT)\r
40b4e21d
YZ
885 else:\r
886 ToolChainFamily.append(ToolDefinition[TAB_TOD_DEFINES_FAMILY][Tool])\r
887 self.ToolChainFamily = ToolChainFamily\r
888\r
4231a819 889 if self.ThreadNumber is None:\r
938cf4c3 890 self.ThreadNumber = self.TargetTxt.TargetTxtDictionary[TAB_TAT_DEFINES_MAX_CONCURRENT_THREAD_NUMBER]\r
52302d4d
LG
891 if self.ThreadNumber == '':\r
892 self.ThreadNumber = 0\r
893 else:\r
894 self.ThreadNumber = int(self.ThreadNumber, 0)\r
895\r
896 if self.ThreadNumber == 0:\r
29af38b0
YF
897 try:\r
898 self.ThreadNumber = multiprocessing.cpu_count()\r
899 except (ImportError, NotImplementedError):\r
900 self.ThreadNumber = 1\r
52302d4d
LG
901\r
902 if not self.PlatformFile:\r
938cf4c3 903 PlatformFile = self.TargetTxt.TargetTxtDictionary[TAB_TAT_DEFINES_ACTIVE_PLATFORM]\r
52302d4d
LG
904 if not PlatformFile:\r
905 # Try to find one in current directory\r
906 WorkingDirectory = os.getcwd()\r
907 FileList = glob.glob(os.path.normpath(os.path.join(WorkingDirectory, '*.dsc')))\r
908 FileNum = len(FileList)\r
909 if FileNum >= 2:\r
910 EdkLogger.error("build", OPTION_MISSING,\r
911 ExtraData="There are %d DSC files in %s. Use '-p' to specify one.\n" % (FileNum, WorkingDirectory))\r
912 elif FileNum == 1:\r
913 PlatformFile = FileList[0]\r
914 else:\r
915 EdkLogger.error("build", RESOURCE_NOT_AVAILABLE,\r
916 ExtraData="No active platform specified in target.txt or command line! Nothing can be built.\n")\r
917\r
918 self.PlatformFile = PathClass(NormFile(PlatformFile, self.WorkspaceDir), self.WorkspaceDir)\r
52302d4d
LG
919\r
920 ## Initialize build configuration\r
921 #\r
922 # This method will parse DSC file and merge the configurations from\r
923 # command line and target.txt, then get the final build configurations.\r
924 #\r
925 def InitBuild(self):\r
0d2711a6 926 # parse target.txt, tools_def.txt, and platform file\r
4afd3d04 927 self.LoadConfiguration()\r
0d2711a6
LG
928\r
929 # Allow case-insensitive for those from command line or configuration file\r
930 ErrorCode, ErrorInfo = self.PlatformFile.Validate(".dsc", False)\r
52302d4d
LG
931 if ErrorCode != 0:\r
932 EdkLogger.error("build", ErrorCode, ExtraData=ErrorInfo)\r
933\r
f0dc69e6
YZ
934\r
935 def InitPreBuild(self):\r
936 self.LoadConfiguration()\r
d429fcd0
YZ
937 ErrorCode, ErrorInfo = self.PlatformFile.Validate(".dsc", False)\r
938 if ErrorCode != 0:\r
939 EdkLogger.error("build", ErrorCode, ExtraData=ErrorInfo)\r
f0dc69e6
YZ
940 if self.BuildTargetList:\r
941 GlobalData.gGlobalDefines['TARGET'] = self.BuildTargetList[0]\r
942 if self.ArchList:\r
943 GlobalData.gGlobalDefines['ARCH'] = self.ArchList[0]\r
944 if self.ToolChainList:\r
945 GlobalData.gGlobalDefines['TOOLCHAIN'] = self.ToolChainList[0]\r
946 GlobalData.gGlobalDefines['TOOL_CHAIN_TAG'] = self.ToolChainList[0]\r
40b4e21d
YZ
947 if self.ToolChainFamily:\r
948 GlobalData.gGlobalDefines['FAMILY'] = self.ToolChainFamily[0]\r
9eb87141 949 if 'PREBUILD' in GlobalData.gCommandLineDefines:\r
f0dc69e6
YZ
950 self.Prebuild = GlobalData.gCommandLineDefines.get('PREBUILD')\r
951 else:\r
f0dc69e6 952 self.Db_Flag = True\r
71cac3f7 953 Platform = self.Db.MapPlatform(str(self.PlatformFile))\r
f0dc69e6
YZ
954 self.Prebuild = str(Platform.Prebuild)\r
955 if self.Prebuild:\r
af9c4e5e
MK
956 PrebuildList = []\r
957 #\r
958 # Evaluate all arguments and convert arguments that are WORKSPACE\r
959 # relative paths to absolute paths. Filter arguments that look like\r
960 # flags or do not follow the file/dir naming rules to avoid false\r
961 # positives on this conversion.\r
962 #\r
963 for Arg in self.Prebuild.split():\r
964 #\r
965 # Do not modify Arg if it looks like a flag or an absolute file path\r
966 #\r
967 if Arg.startswith('-') or os.path.isabs(Arg):\r
968 PrebuildList.append(Arg)\r
969 continue\r
970 #\r
971 # Do not modify Arg if it does not look like a Workspace relative\r
972 # path that starts with a valid package directory name\r
973 #\r
974 if not Arg[0].isalpha() or os.path.dirname(Arg) == '':\r
975 PrebuildList.append(Arg)\r
976 continue\r
977 #\r
978 # If Arg looks like a WORKSPACE relative path, then convert to an\r
979 # absolute path and check to see if the file exists.\r
980 #\r
981 Temp = mws.join(self.WorkspaceDir, Arg)\r
982 if os.path.isfile(Temp):\r
983 Arg = Temp\r
984 PrebuildList.append(Arg)\r
985 self.Prebuild = ' '.join(PrebuildList)\r
986 self.Prebuild += self.PassCommandOption(self.BuildTargetList, self.ArchList, self.ToolChainList, self.PlatformFile, self.Target)\r
52302d4d 987\r
f0dc69e6 988 def InitPostBuild(self):\r
9eb87141 989 if 'POSTBUILD' in GlobalData.gCommandLineDefines:\r
f0dc69e6
YZ
990 self.Postbuild = GlobalData.gCommandLineDefines.get('POSTBUILD')\r
991 else:\r
71cac3f7 992 Platform = self.Db.MapPlatform(str(self.PlatformFile))\r
f0dc69e6
YZ
993 self.Postbuild = str(Platform.Postbuild)\r
994 if self.Postbuild:\r
af9c4e5e
MK
995 PostbuildList = []\r
996 #\r
997 # Evaluate all arguments and convert arguments that are WORKSPACE\r
998 # relative paths to absolute paths. Filter arguments that look like\r
999 # flags or do not follow the file/dir naming rules to avoid false\r
1000 # positives on this conversion.\r
1001 #\r
1002 for Arg in self.Postbuild.split():\r
1003 #\r
1004 # Do not modify Arg if it looks like a flag or an absolute file path\r
1005 #\r
1006 if Arg.startswith('-') or os.path.isabs(Arg):\r
1007 PostbuildList.append(Arg)\r
1008 continue\r
1009 #\r
1010 # Do not modify Arg if it does not look like a Workspace relative\r
1011 # path that starts with a valid package directory name\r
1012 #\r
1013 if not Arg[0].isalpha() or os.path.dirname(Arg) == '':\r
1014 PostbuildList.append(Arg)\r
1015 continue\r
1016 #\r
1017 # If Arg looks like a WORKSPACE relative path, then convert to an\r
1018 # absolute path and check to see if the file exists.\r
1019 #\r
1020 Temp = mws.join(self.WorkspaceDir, Arg)\r
1021 if os.path.isfile(Temp):\r
1022 Arg = Temp\r
1023 PostbuildList.append(Arg)\r
1024 self.Postbuild = ' '.join(PostbuildList)\r
1025 self.Postbuild += self.PassCommandOption(self.BuildTargetList, self.ArchList, self.ToolChainList, self.PlatformFile, self.Target)\r
1026\r
1027 def PassCommandOption(self, BuildTarget, TargetArch, ToolChain, PlatformFile, Target):\r
f0dc69e6
YZ
1028 BuildStr = ''\r
1029 if GlobalData.gCommand and isinstance(GlobalData.gCommand, list):\r
1030 BuildStr += ' ' + ' '.join(GlobalData.gCommand)\r
1031 TargetFlag = False\r
1032 ArchFlag = False\r
1033 ToolChainFlag = False\r
af9c4e5e 1034 PlatformFileFlag = False\r
f0dc69e6
YZ
1035\r
1036 if GlobalData.gOptions and not GlobalData.gOptions.BuildTarget:\r
1037 TargetFlag = True\r
1038 if GlobalData.gOptions and not GlobalData.gOptions.TargetArch:\r
1039 ArchFlag = True\r
1040 if GlobalData.gOptions and not GlobalData.gOptions.ToolChain:\r
1041 ToolChainFlag = True\r
af9c4e5e
MK
1042 if GlobalData.gOptions and not GlobalData.gOptions.PlatformFile:\r
1043 PlatformFileFlag = True\r
f0dc69e6
YZ
1044\r
1045 if TargetFlag and BuildTarget:\r
1046 if isinstance(BuildTarget, list) or isinstance(BuildTarget, tuple):\r
1047 BuildStr += ' -b ' + ' -b '.join(BuildTarget)\r
1048 elif isinstance(BuildTarget, str):\r
1049 BuildStr += ' -b ' + BuildTarget\r
1050 if ArchFlag and TargetArch:\r
1051 if isinstance(TargetArch, list) or isinstance(TargetArch, tuple):\r
1052 BuildStr += ' -a ' + ' -a '.join(TargetArch)\r
1053 elif isinstance(TargetArch, str):\r
1054 BuildStr += ' -a ' + TargetArch\r
1055 if ToolChainFlag and ToolChain:\r
1056 if isinstance(ToolChain, list) or isinstance(ToolChain, tuple):\r
1057 BuildStr += ' -t ' + ' -t '.join(ToolChain)\r
1058 elif isinstance(ToolChain, str):\r
1059 BuildStr += ' -t ' + ToolChain\r
af9c4e5e
MK
1060 if PlatformFileFlag and PlatformFile:\r
1061 if isinstance(PlatformFile, list) or isinstance(PlatformFile, tuple):\r
1062 BuildStr += ' -p ' + ' -p '.join(PlatformFile)\r
1063 elif isinstance(PlatformFile, str):\r
1064 BuildStr += ' -p' + PlatformFile\r
1065 BuildStr += ' --conf=' + GlobalData.gConfDirectory\r
1066 if Target:\r
1067 BuildStr += ' ' + Target\r
f0dc69e6
YZ
1068\r
1069 return BuildStr\r
1070\r
1071 def LaunchPrebuild(self):\r
1072 if self.Prebuild:\r
1073 EdkLogger.info("\n- Prebuild Start -\n")\r
1074 self.LaunchPrebuildFlag = True\r
134bbe88
YZ
1075 #\r
1076 # The purpose of .PrebuildEnv file is capture environment variable settings set by the prebuild script\r
1077 # and preserve them for the rest of the main build step, because the child process environment will\r
1078 # evaporate as soon as it exits, we cannot get it in build step.\r
1079 #\r
ccaa7754 1080 PrebuildEnvFile = os.path.join(GlobalData.gConfDirectory, '.cache', '.PrebuildEnv')\r
f0dc69e6
YZ
1081 if os.path.isfile(PrebuildEnvFile):\r
1082 os.remove(PrebuildEnvFile)\r
1083 if os.path.isfile(self.PlatformBuildPath):\r
1084 os.remove(self.PlatformBuildPath)\r
1085 if sys.platform == "win32":\r
1086 args = ' && '.join((self.Prebuild, 'set > ' + PrebuildEnvFile))\r
b926f2f2 1087 Process = Popen(args, stdout=PIPE, stderr=PIPE, shell=True)\r
f0dc69e6
YZ
1088 else:\r
1089 args = ' && '.join((self.Prebuild, 'env > ' + PrebuildEnvFile))\r
34816e7e 1090 Process = Popen(args, stdout=PIPE, stderr=PIPE, shell=True)\r
f0dc69e6
YZ
1091\r
1092 # launch two threads to read the STDOUT and STDERR\r
1093 EndOfProcedure = Event()\r
1094 EndOfProcedure.clear()\r
1095 if Process.stdout:\r
1096 StdOutThread = Thread(target=ReadMessage, args=(Process.stdout, EdkLogger.info, EndOfProcedure))\r
1097 StdOutThread.setName("STDOUT-Redirector")\r
1098 StdOutThread.setDaemon(False)\r
1099 StdOutThread.start()\r
1100\r
1101 if Process.stderr:\r
1102 StdErrThread = Thread(target=ReadMessage, args=(Process.stderr, EdkLogger.quiet, EndOfProcedure))\r
1103 StdErrThread.setName("STDERR-Redirector")\r
1104 StdErrThread.setDaemon(False)\r
1105 StdErrThread.start()\r
1106 # waiting for program exit\r
1107 Process.wait()\r
1108\r
1109 if Process.stdout:\r
1110 StdOutThread.join()\r
1111 if Process.stderr:\r
1112 StdErrThread.join()\r
1113 if Process.returncode != 0 :\r
1114 EdkLogger.error("Prebuild", PREBUILD_ERROR, 'Prebuild process is not success!')\r
1115\r
1116 if os.path.exists(PrebuildEnvFile):\r
1117 f = open(PrebuildEnvFile)\r
1118 envs = f.readlines()\r
1119 f.close()\r
2f28dca1
ZF
1120 envs = [l.split("=", 1) for l in envs ]\r
1121 envs = [[I.strip() for I in item] for item in envs if len(item) == 2]\r
f0dc69e6
YZ
1122 os.environ.update(dict(envs))\r
1123 EdkLogger.info("\n- Prebuild Done -\n")\r
1124\r
91048b0d 1125 def LaunchPostbuild(self):\r
f0dc69e6
YZ
1126 if self.Postbuild:\r
1127 EdkLogger.info("\n- Postbuild Start -\n")\r
1128 if sys.platform == "win32":\r
b926f2f2 1129 Process = Popen(self.Postbuild, stdout=PIPE, stderr=PIPE, shell=True)\r
f0dc69e6 1130 else:\r
34816e7e 1131 Process = Popen(self.Postbuild, stdout=PIPE, stderr=PIPE, shell=True)\r
f0dc69e6
YZ
1132 # launch two threads to read the STDOUT and STDERR\r
1133 EndOfProcedure = Event()\r
1134 EndOfProcedure.clear()\r
1135 if Process.stdout:\r
1136 StdOutThread = Thread(target=ReadMessage, args=(Process.stdout, EdkLogger.info, EndOfProcedure))\r
1137 StdOutThread.setName("STDOUT-Redirector")\r
1138 StdOutThread.setDaemon(False)\r
1139 StdOutThread.start()\r
1140\r
1141 if Process.stderr:\r
1142 StdErrThread = Thread(target=ReadMessage, args=(Process.stderr, EdkLogger.quiet, EndOfProcedure))\r
1143 StdErrThread.setName("STDERR-Redirector")\r
1144 StdErrThread.setDaemon(False)\r
1145 StdErrThread.start()\r
1146 # waiting for program exit\r
1147 Process.wait()\r
1148\r
1149 if Process.stdout:\r
1150 StdOutThread.join()\r
1151 if Process.stderr:\r
1152 StdErrThread.join()\r
1153 if Process.returncode != 0 :\r
1154 EdkLogger.error("Postbuild", POSTBUILD_ERROR, 'Postbuild process is not success!')\r
1155 EdkLogger.info("\n- Postbuild Done -\n")\r
0eccea3f
RC
1156\r
1157 ## Error handling for hash feature\r
1158 #\r
1159 # On BuildTask error, iterate through the Module Build tracking\r
1160 # dictionary to determine wheather a module failed to build. Invalidate\r
1161 # the hash associated with that module by removing it from storage.\r
1162 #\r
1163 #\r
1164 def invalidateHash(self):\r
48b0bf64
RC
1165 # Only for hashing feature\r
1166 if not GlobalData.gUseHashCache:\r
1167 return\r
1168\r
1169 # GlobalData.gModuleBuildTracking contains only modules or libs that cannot be skipped by hash\r
1170 for moduleAutoGenObjArch in GlobalData.gModuleBuildTracking.keys():\r
1171 for moduleAutoGenObj in GlobalData.gModuleBuildTracking[moduleAutoGenObjArch].keys():\r
1172 # Skip invalidating for Successful Module/Lib builds\r
1173 if GlobalData.gModuleBuildTracking[moduleAutoGenObjArch][moduleAutoGenObj] == 'SUCCESS':\r
1174 continue\r
0eccea3f 1175\r
48b0bf64 1176 # The module failed to build, failed to start building, or failed the header check test from this point on\r
0eccea3f 1177\r
48b0bf64
RC
1178 # Remove .hash from build\r
1179 ModuleHashFile = os.path.join(moduleAutoGenObj.BuildDir, moduleAutoGenObj.Name + ".hash")\r
0eccea3f
RC
1180 if os.path.exists(ModuleHashFile):\r
1181 os.remove(ModuleHashFile)\r
1182\r
48b0bf64
RC
1183 # Remove .hash file from cache\r
1184 if GlobalData.gBinCacheDest:\r
1185 FileDir = os.path.join(GlobalData.gBinCacheDest, moduleAutoGenObj.Arch, moduleAutoGenObj.SourceDir, moduleAutoGenObj.MetaFile.BaseName)\r
1186 HashFile = os.path.join(FileDir, moduleAutoGenObj.Name + '.hash')\r
1187 if os.path.exists(HashFile):\r
1188 os.remove(HashFile)\r
0eccea3f 1189\r
52302d4d
LG
1190 ## Build a module or platform\r
1191 #\r
08dd311f 1192 # Create autogen code and makefile for a module or platform, and the launch\r
52302d4d
LG
1193 # "make" command to build it\r
1194 #\r
1195 # @param Target The target of build command\r
1196 # @param Platform The platform file\r
1197 # @param Module The module file\r
1198 # @param BuildTarget The name of build target, one of "DEBUG", "RELEASE"\r
1199 # @param ToolChain The name of toolchain to build\r
1200 # @param Arch The arch of the module/platform\r
1201 # @param CreateDepModuleCodeFile Flag used to indicate creating code\r
1202 # for dependent modules/Libraries\r
1203 # @param CreateDepModuleMakeFile Flag used to indicate creating makefile\r
1204 # for dependent modules/Libraries\r
1205 #\r
37de70b7 1206 def _BuildPa(self, Target, AutoGenObject, CreateDepsCodeFile=True, CreateDepsMakeFile=True, BuildModule=False, FfsCommand={}):\r
4231a819 1207 if AutoGenObject is None:\r
52302d4d
LG
1208 return False\r
1209\r
1210 # skip file generation for cleanxxx targets, run and fds target\r
1211 if Target not in ['clean', 'cleanlib', 'cleanall', 'run', 'fds']:\r
1212 # for target which must generate AutoGen code and makefile\r
1213 if not self.SkipAutoGen or Target == 'genc':\r
1214 self.Progress.Start("Generating code")\r
1215 AutoGenObject.CreateCodeFile(CreateDepsCodeFile)\r
1216 self.Progress.Stop("done!")\r
1217 if Target == "genc":\r
1218 return True\r
1219\r
1220 if not self.SkipAutoGen or Target == 'genmake':\r
1221 self.Progress.Start("Generating makefile")\r
37de70b7 1222 AutoGenObject.CreateMakeFile(CreateDepsMakeFile, FfsCommand)\r
52302d4d
LG
1223 self.Progress.Stop("done!")\r
1224 if Target == "genmake":\r
1225 return True\r
1226 else:\r
1227 # always recreate top/platform makefile when clean, just in case of inconsistency\r
1228 AutoGenObject.CreateCodeFile(False)\r
1229 AutoGenObject.CreateMakeFile(False)\r
1230\r
1231 if EdkLogger.GetLevel() == EdkLogger.QUIET:\r
1232 EdkLogger.quiet("Building ... %s" % repr(AutoGenObject))\r
1233\r
1234 BuildCommand = AutoGenObject.BuildCommand\r
4231a819 1235 if BuildCommand is None or len(BuildCommand) == 0:\r
0d2711a6
LG
1236 EdkLogger.error("build", OPTION_MISSING,\r
1237 "No build command found for this module. "\r
4afd3d04 1238 "Please check your setting of %s_%s_%s_MAKE_PATH in Conf/tools_def.txt file." %\r
0d2711a6
LG
1239 (AutoGenObject.BuildTarget, AutoGenObject.ToolChain, AutoGenObject.Arch),\r
1240 ExtraData=str(AutoGenObject))\r
52302d4d 1241\r
03af2753
HC
1242 makefile = GenMake.BuildFile(AutoGenObject)._FILE_NAME_[GenMake.gMakeType]\r
1243\r
03af2753
HC
1244 # run\r
1245 if Target == 'run':\r
03af2753
HC
1246 return True\r
1247\r
1248 # build modules\r
1249 if BuildModule:\r
1250 BuildCommand = BuildCommand + [Target]\r
1251 LaunchCommand(BuildCommand, AutoGenObject.MakeFileDir)\r
a0a2cd1e 1252 self.CreateAsBuiltInf()\r
b8ac0b7f
BF
1253 if GlobalData.gBinCacheDest:\r
1254 self.UpdateBuildCache()\r
1255 self.BuildModules = []\r
03af2753
HC
1256 return True\r
1257\r
1258 # build library\r
1259 if Target == 'libraries':\r
1260 for Lib in AutoGenObject.LibraryBuildDirectoryList:\r
1261 NewBuildCommand = BuildCommand + ['-f', os.path.normpath(os.path.join(Lib, makefile)), 'pbuild']\r
1262 LaunchCommand(NewBuildCommand, AutoGenObject.MakeFileDir)\r
1263 return True\r
1264\r
1265 # build module\r
1266 if Target == 'modules':\r
1267 for Lib in AutoGenObject.LibraryBuildDirectoryList:\r
1268 NewBuildCommand = BuildCommand + ['-f', os.path.normpath(os.path.join(Lib, makefile)), 'pbuild']\r
1269 LaunchCommand(NewBuildCommand, AutoGenObject.MakeFileDir)\r
1270 for Mod in AutoGenObject.ModuleBuildDirectoryList:\r
1271 NewBuildCommand = BuildCommand + ['-f', os.path.normpath(os.path.join(Mod, makefile)), 'pbuild']\r
1272 LaunchCommand(NewBuildCommand, AutoGenObject.MakeFileDir)\r
a0a2cd1e 1273 self.CreateAsBuiltInf()\r
b8ac0b7f
BF
1274 if GlobalData.gBinCacheDest:\r
1275 self.UpdateBuildCache()\r
1276 self.BuildModules = []\r
03af2753
HC
1277 return True\r
1278\r
1279 # cleanlib\r
1280 if Target == 'cleanlib':\r
1281 for Lib in AutoGenObject.LibraryBuildDirectoryList:\r
1282 LibMakefile = os.path.normpath(os.path.join(Lib, makefile))\r
1283 if os.path.exists(LibMakefile):\r
1284 NewBuildCommand = BuildCommand + ['-f', LibMakefile, 'cleanall']\r
1285 LaunchCommand(NewBuildCommand, AutoGenObject.MakeFileDir)\r
1286 return True\r
1287\r
1288 # clean\r
1289 if Target == 'clean':\r
1290 for Mod in AutoGenObject.ModuleBuildDirectoryList:\r
1291 ModMakefile = os.path.normpath(os.path.join(Mod, makefile))\r
1292 if os.path.exists(ModMakefile):\r
1293 NewBuildCommand = BuildCommand + ['-f', ModMakefile, 'cleanall']\r
1294 LaunchCommand(NewBuildCommand, AutoGenObject.MakeFileDir)\r
1295 for Lib in AutoGenObject.LibraryBuildDirectoryList:\r
1296 LibMakefile = os.path.normpath(os.path.join(Lib, makefile))\r
1297 if os.path.exists(LibMakefile):\r
1298 NewBuildCommand = BuildCommand + ['-f', LibMakefile, 'cleanall']\r
1299 LaunchCommand(NewBuildCommand, AutoGenObject.MakeFileDir)\r
1300 return True\r
1301\r
1302 # cleanall\r
1303 if Target == 'cleanall':\r
1304 try:\r
1305 #os.rmdir(AutoGenObject.BuildDir)\r
1306 RemoveDirectory(AutoGenObject.BuildDir, True)\r
5b0671c1 1307 except WindowsError as X:\r
03af2753
HC
1308 EdkLogger.error("build", FILE_DELETE_FAILURE, ExtraData=str(X))\r
1309 return True\r
1310\r
1311 ## Build a module or platform\r
1312 #\r
1313 # Create autogen code and makefile for a module or platform, and the launch\r
1314 # "make" command to build it\r
1315 #\r
1316 # @param Target The target of build command\r
1317 # @param Platform The platform file\r
1318 # @param Module The module file\r
1319 # @param BuildTarget The name of build target, one of "DEBUG", "RELEASE"\r
1320 # @param ToolChain The name of toolchain to build\r
1321 # @param Arch The arch of the module/platform\r
1322 # @param CreateDepModuleCodeFile Flag used to indicate creating code\r
1323 # for dependent modules/Libraries\r
1324 # @param CreateDepModuleMakeFile Flag used to indicate creating makefile\r
1325 # for dependent modules/Libraries\r
1326 #\r
1327 def _Build(self, Target, AutoGenObject, CreateDepsCodeFile=True, CreateDepsMakeFile=True, BuildModule=False):\r
4231a819 1328 if AutoGenObject is None:\r
03af2753
HC
1329 return False\r
1330\r
1331 # skip file generation for cleanxxx targets, run and fds target\r
1332 if Target not in ['clean', 'cleanlib', 'cleanall', 'run', 'fds']:\r
1333 # for target which must generate AutoGen code and makefile\r
1334 if not self.SkipAutoGen or Target == 'genc':\r
1335 self.Progress.Start("Generating code")\r
1336 AutoGenObject.CreateCodeFile(CreateDepsCodeFile)\r
1337 self.Progress.Stop("done!")\r
1338 if Target == "genc":\r
1339 return True\r
1340\r
1341 if not self.SkipAutoGen or Target == 'genmake':\r
1342 self.Progress.Start("Generating makefile")\r
1343 AutoGenObject.CreateMakeFile(CreateDepsMakeFile)\r
1344 #AutoGenObject.CreateAsBuiltInf()\r
1345 self.Progress.Stop("done!")\r
1346 if Target == "genmake":\r
1347 return True\r
1348 else:\r
1349 # always recreate top/platform makefile when clean, just in case of inconsistency\r
1350 AutoGenObject.CreateCodeFile(False)\r
1351 AutoGenObject.CreateMakeFile(False)\r
1352\r
1353 if EdkLogger.GetLevel() == EdkLogger.QUIET:\r
1354 EdkLogger.quiet("Building ... %s" % repr(AutoGenObject))\r
1355\r
1356 BuildCommand = AutoGenObject.BuildCommand\r
4231a819 1357 if BuildCommand is None or len(BuildCommand) == 0:\r
03af2753
HC
1358 EdkLogger.error("build", OPTION_MISSING,\r
1359 "No build command found for this module. "\r
1360 "Please check your setting of %s_%s_%s_MAKE_PATH in Conf/tools_def.txt file." %\r
1361 (AutoGenObject.BuildTarget, AutoGenObject.ToolChain, AutoGenObject.Arch),\r
1362 ExtraData=str(AutoGenObject))\r
1363\r
b0e23cf3
YL
1364 # build modules\r
1365 if BuildModule:\r
1366 if Target != 'fds':\r
1367 BuildCommand = BuildCommand + [Target]\r
1b8eca8b 1368 AutoGenObject.BuildTime = LaunchCommand(BuildCommand, AutoGenObject.MakeFileDir)\r
b0e23cf3 1369 self.CreateAsBuiltInf()\r
b8ac0b7f
BF
1370 if GlobalData.gBinCacheDest:\r
1371 self.UpdateBuildCache()\r
1372 self.BuildModules = []\r
b0e23cf3
YL
1373 return True\r
1374\r
03af2753
HC
1375 # genfds\r
1376 if Target == 'fds':\r
370544d1
DL
1377 if GenFdsApi(AutoGenObject.GenFdsCommandDict, self.Db):\r
1378 EdkLogger.error("build", COMMAND_FAILURE)\r
03af2753
HC
1379 return True\r
1380\r
1381 # run\r
1382 if Target == 'run':\r
03af2753
HC
1383 return True\r
1384\r
03af2753
HC
1385 # build library\r
1386 if Target == 'libraries':\r
1387 pass\r
1388\r
1389 # not build modules\r
1390\r
1391\r
1392 # cleanall\r
52302d4d
LG
1393 if Target == 'cleanall':\r
1394 try:\r
1395 #os.rmdir(AutoGenObject.BuildDir)\r
1396 RemoveDirectory(AutoGenObject.BuildDir, True)\r
5b0671c1 1397 except WindowsError as X:\r
52302d4d
LG
1398 EdkLogger.error("build", FILE_DELETE_FAILURE, ExtraData=str(X))\r
1399 return True\r
1400\r
6780eef1 1401 ## Rebase module image and Get function address for the input module list.\r
52302d4d
LG
1402 #\r
1403 def _RebaseModule (self, MapBuffer, BaseAddress, ModuleList, AddrIsOffset = True, ModeIsSmm = False):\r
1404 if ModeIsSmm:\r
1405 AddrIsOffset = False\r
98120f5f 1406 for InfFile in ModuleList:\r
da92f276
LG
1407 sys.stdout.write (".")\r
1408 sys.stdout.flush()\r
52302d4d
LG
1409 ModuleInfo = ModuleList[InfFile]\r
1410 ModuleName = ModuleInfo.BaseName\r
f3decdc3
LG
1411 ModuleOutputImage = ModuleInfo.Image.FileName\r
1412 ModuleDebugImage = os.path.join(ModuleInfo.DebugDir, ModuleInfo.BaseName + '.efi')\r
52302d4d
LG
1413 ## for SMM module in SMRAM, the SMRAM will be allocated from base to top.\r
1414 if not ModeIsSmm:\r
1415 BaseAddress = BaseAddress - ModuleInfo.Image.Size\r
1416 #\r
1417 # Update Image to new BaseAddress by GenFw tool\r
1418 #\r
f3decdc3 1419 LaunchCommand(["GenFw", "--rebase", str(BaseAddress), "-r", ModuleOutputImage], ModuleInfo.OutputDir)\r
47fea6af 1420 LaunchCommand(["GenFw", "--rebase", str(BaseAddress), "-r", ModuleDebugImage], ModuleInfo.DebugDir)\r
52302d4d
LG
1421 else:\r
1422 #\r
1423 # Set new address to the section header only for SMM driver.\r
1424 #\r
f3decdc3 1425 LaunchCommand(["GenFw", "--address", str(BaseAddress), "-r", ModuleOutputImage], ModuleInfo.OutputDir)\r
47fea6af 1426 LaunchCommand(["GenFw", "--address", str(BaseAddress), "-r", ModuleDebugImage], ModuleInfo.DebugDir)\r
52302d4d 1427 #\r
fb0b35e0 1428 # Collect function address from Map file\r
52302d4d 1429 #\r
f3decdc3 1430 ImageMapTable = ModuleOutputImage.replace('.efi', '.map')\r
52302d4d
LG
1431 FunctionList = []\r
1432 if os.path.exists(ImageMapTable):\r
1433 OrigImageBaseAddress = 0\r
47fea6af 1434 ImageMap = open(ImageMapTable, 'r')\r
52302d4d
LG
1435 for LinStr in ImageMap:\r
1436 if len (LinStr.strip()) == 0:\r
1437 continue\r
1438 #\r
1439 # Get the preferred address set on link time.\r
1440 #\r
1441 if LinStr.find ('Preferred load address is') != -1:\r
1442 StrList = LinStr.split()\r
1443 OrigImageBaseAddress = int (StrList[len(StrList) - 1], 16)\r
1444\r
1445 StrList = LinStr.split()\r
1446 if len (StrList) > 4:\r
47fea6af 1447 if StrList[3] == 'f' or StrList[3] == 'F':\r
52302d4d
LG
1448 Name = StrList[1]\r
1449 RelativeAddress = int (StrList[2], 16) - OrigImageBaseAddress\r
1450 FunctionList.append ((Name, RelativeAddress))\r
39879ef2 1451\r
52302d4d
LG
1452 ImageMap.close()\r
1453 #\r
1454 # Add general information.\r
1455 #\r
1456 if ModeIsSmm:\r
d943b0c3 1457 MapBuffer.append('\n\n%s (Fixed SMRAM Offset, BaseAddress=0x%010X, EntryPoint=0x%010X)\n' % (ModuleName, BaseAddress, BaseAddress + ModuleInfo.Image.EntryPoint))\r
52302d4d 1458 elif AddrIsOffset:\r
d943b0c3 1459 MapBuffer.append('\n\n%s (Fixed Memory Offset, BaseAddress=-0x%010X, EntryPoint=-0x%010X)\n' % (ModuleName, 0 - BaseAddress, 0 - (BaseAddress + ModuleInfo.Image.EntryPoint)))\r
52302d4d 1460 else:\r
d943b0c3 1461 MapBuffer.append('\n\n%s (Fixed Memory Address, BaseAddress=0x%010X, EntryPoint=0x%010X)\n' % (ModuleName, BaseAddress, BaseAddress + ModuleInfo.Image.EntryPoint))\r
52302d4d
LG
1462 #\r
1463 # Add guid and general seciton section.\r
1464 #\r
1465 TextSectionAddress = 0\r
1466 DataSectionAddress = 0\r
1467 for SectionHeader in ModuleInfo.Image.SectionHeaderList:\r
1468 if SectionHeader[0] == '.text':\r
1469 TextSectionAddress = SectionHeader[1]\r
1470 elif SectionHeader[0] in ['.data', '.sdata']:\r
1471 DataSectionAddress = SectionHeader[1]\r
1472 if AddrIsOffset:\r
d943b0c3 1473 MapBuffer.append('(GUID=%s, .textbaseaddress=-0x%010X, .databaseaddress=-0x%010X)\n' % (ModuleInfo.Guid, 0 - (BaseAddress + TextSectionAddress), 0 - (BaseAddress + DataSectionAddress)))\r
52302d4d 1474 else:\r
d943b0c3 1475 MapBuffer.append('(GUID=%s, .textbaseaddress=0x%010X, .databaseaddress=0x%010X)\n' % (ModuleInfo.Guid, BaseAddress + TextSectionAddress, BaseAddress + DataSectionAddress))\r
f3decdc3
LG
1476 #\r
1477 # Add debug image full path.\r
1478 #\r
d943b0c3 1479 MapBuffer.append('(IMAGE=%s)\n\n' % (ModuleDebugImage))\r
52302d4d 1480 #\r
fb0b35e0 1481 # Add function address\r
52302d4d
LG
1482 #\r
1483 for Function in FunctionList:\r
1484 if AddrIsOffset:\r
d943b0c3 1485 MapBuffer.append(' -0x%010X %s\n' % (0 - (BaseAddress + Function[1]), Function[0]))\r
52302d4d 1486 else:\r
d943b0c3 1487 MapBuffer.append(' 0x%010X %s\n' % (BaseAddress + Function[1], Function[0]))\r
52302d4d
LG
1488 ImageMap.close()\r
1489\r
1490 #\r
1491 # for SMM module in SMRAM, the SMRAM will be allocated from base to top.\r
1492 #\r
1493 if ModeIsSmm:\r
1494 BaseAddress = BaseAddress + ModuleInfo.Image.Size\r
1495\r
1496 ## Collect MAP information of all FVs\r
1497 #\r
636f2be6 1498 def _CollectFvMapBuffer (self, MapBuffer, Wa, ModuleList):\r
0d2711a6 1499 if self.Fdf:\r
52302d4d 1500 # First get the XIP base address for FV map file.\r
636f2be6 1501 GuidPattern = re.compile("[-a-fA-F0-9]+")\r
f3decdc3 1502 GuidName = re.compile("\(GUID=[-a-fA-F0-9]+")\r
9eb87141 1503 for FvName in Wa.FdfProfile.FvDict:\r
52302d4d
LG
1504 FvMapBuffer = os.path.join(Wa.FvDir, FvName + '.Fv.map')\r
1505 if not os.path.exists(FvMapBuffer):\r
1506 continue\r
1be2ed90 1507 FvMap = open(FvMapBuffer, 'r')\r
52302d4d
LG
1508 #skip FV size information\r
1509 FvMap.readline()\r
1510 FvMap.readline()\r
1511 FvMap.readline()\r
1512 FvMap.readline()\r
636f2be6
LG
1513 for Line in FvMap:\r
1514 MatchGuid = GuidPattern.match(Line)\r
4231a819 1515 if MatchGuid is not None:\r
636f2be6
LG
1516 #\r
1517 # Replace GUID with module name\r
1518 #\r
1519 GuidString = MatchGuid.group()\r
1520 if GuidString.upper() in ModuleList:\r
1521 Line = Line.replace(GuidString, ModuleList[GuidString.upper()].Name)\r
d943b0c3 1522 MapBuffer.append(Line)\r
f3decdc3
LG
1523 #\r
1524 # Add the debug image full path.\r
1525 #\r
1526 MatchGuid = GuidName.match(Line)\r
4231a819 1527 if MatchGuid is not None:\r
f3decdc3
LG
1528 GuidString = MatchGuid.group().split("=")[1]\r
1529 if GuidString.upper() in ModuleList:\r
d943b0c3 1530 MapBuffer.append('(IMAGE=%s)\n' % (os.path.join(ModuleList[GuidString.upper()].DebugDir, ModuleList[GuidString.upper()].Name + '.efi')))\r
f3decdc3 1531\r
52302d4d
LG
1532 FvMap.close()\r
1533\r
1534 ## Collect MAP information of all modules\r
1535 #\r
1536 def _CollectModuleMapBuffer (self, MapBuffer, ModuleList):\r
da92f276
LG
1537 sys.stdout.write ("Generate Load Module At Fix Address Map")\r
1538 sys.stdout.flush()\r
52302d4d
LG
1539 PatchEfiImageList = []\r
1540 PeiModuleList = {}\r
1541 BtModuleList = {}\r
1542 RtModuleList = {}\r
1543 SmmModuleList = {}\r
1544 PeiSize = 0\r
1545 BtSize = 0\r
1546 RtSize = 0\r
1547 # reserve 4K size in SMRAM to make SMM module address not from 0.\r
1548 SmmSize = 0x1000\r
636f2be6
LG
1549 for ModuleGuid in ModuleList:\r
1550 Module = ModuleList[ModuleGuid]\r
52302d4d 1551 GlobalData.gProcessingFile = "%s [%s, %s, %s]" % (Module.MetaFile, Module.Arch, Module.ToolChain, Module.BuildTarget)\r
4afd3d04 1552\r
52302d4d
LG
1553 OutputImageFile = ''\r
1554 for ResultFile in Module.CodaTargetList:\r
1555 if str(ResultFile.Target).endswith('.efi'):\r
1556 #\r
1557 # module list for PEI, DXE, RUNTIME and SMM\r
1558 #\r
1559 OutputImageFile = os.path.join(Module.OutputDir, Module.Name + '.efi')\r
1560 ImageClass = PeImageClass (OutputImageFile)\r
1561 if not ImageClass.IsValid:\r
1562 EdkLogger.error("build", FILE_PARSE_FAILURE, ExtraData=ImageClass.ErrorInfo)\r
f3decdc3 1563 ImageInfo = PeImageInfo(Module.Name, Module.Guid, Module.Arch, Module.OutputDir, Module.DebugDir, ImageClass)\r
0c60e60b 1564 if Module.ModuleType in [SUP_MODULE_PEI_CORE, SUP_MODULE_PEIM, EDK_COMPONENT_TYPE_COMBINED_PEIM_DRIVER, EDK_COMPONENT_TYPE_PIC_PEIM, EDK_COMPONENT_TYPE_RELOCATABLE_PEIM, SUP_MODULE_DXE_CORE]:\r
52302d4d
LG
1565 PeiModuleList[Module.MetaFile] = ImageInfo\r
1566 PeiSize += ImageInfo.Image.Size\r
0c60e60b 1567 elif Module.ModuleType in [EDK_COMPONENT_TYPE_BS_DRIVER, SUP_MODULE_DXE_DRIVER, SUP_MODULE_UEFI_DRIVER]:\r
52302d4d
LG
1568 BtModuleList[Module.MetaFile] = ImageInfo\r
1569 BtSize += ImageInfo.Image.Size\r
0c60e60b 1570 elif Module.ModuleType in [SUP_MODULE_DXE_RUNTIME_DRIVER, EDK_COMPONENT_TYPE_RT_DRIVER, SUP_MODULE_DXE_SAL_DRIVER, EDK_COMPONENT_TYPE_SAL_RT_DRIVER]:\r
52302d4d 1571 RtModuleList[Module.MetaFile] = ImageInfo\r
52302d4d 1572 RtSize += ImageInfo.Image.Size\r
8bb63e37 1573 elif Module.ModuleType in [SUP_MODULE_SMM_CORE, SUP_MODULE_DXE_SMM_DRIVER, SUP_MODULE_MM_STANDALONE, SUP_MODULE_MM_CORE_STANDALONE]:\r
52302d4d
LG
1574 SmmModuleList[Module.MetaFile] = ImageInfo\r
1575 SmmSize += ImageInfo.Image.Size\r
8bb63e37 1576 if Module.ModuleType == SUP_MODULE_DXE_SMM_DRIVER:\r
888d7f19 1577 PiSpecVersion = Module.Module.Specification.get('PI_SPECIFICATION_VERSION', '0x00000000')\r
52302d4d 1578 # for PI specification < PI1.1, DXE_SMM_DRIVER also runs as BOOT time driver.\r
da92f276 1579 if int(PiSpecVersion, 16) < 0x0001000A:\r
52302d4d
LG
1580 BtModuleList[Module.MetaFile] = ImageInfo\r
1581 BtSize += ImageInfo.Image.Size\r
1582 break\r
1583 #\r
1584 # EFI image is final target.\r
1585 # Check EFI image contains patchable FixAddress related PCDs.\r
1586 #\r
1587 if OutputImageFile != '':\r
1588 ModuleIsPatch = False\r
1589 for Pcd in Module.ModulePcdList:\r
eece4292 1590 if Pcd.Type == TAB_PCDS_PATCHABLE_IN_MODULE and Pcd.TokenCName in TAB_PCDS_PATCHABLE_LOAD_FIX_ADDRESS_SET:\r
52302d4d
LG
1591 ModuleIsPatch = True\r
1592 break\r
1593 if not ModuleIsPatch:\r
1594 for Pcd in Module.LibraryPcdList:\r
eece4292 1595 if Pcd.Type == TAB_PCDS_PATCHABLE_IN_MODULE and Pcd.TokenCName in TAB_PCDS_PATCHABLE_LOAD_FIX_ADDRESS_SET:\r
52302d4d
LG
1596 ModuleIsPatch = True\r
1597 break\r
4afd3d04 1598\r
52302d4d
LG
1599 if not ModuleIsPatch:\r
1600 continue\r
1601 #\r
1602 # Module includes the patchable load fix address PCDs.\r
4afd3d04 1603 # It will be fixed up later.\r
52302d4d
LG
1604 #\r
1605 PatchEfiImageList.append (OutputImageFile)\r
4afd3d04 1606\r
52302d4d
LG
1607 #\r
1608 # Get Top Memory address\r
1609 #\r
1610 ReservedRuntimeMemorySize = 0\r
1611 TopMemoryAddress = 0\r
1612 if self.LoadFixAddress == 0xFFFFFFFFFFFFFFFF:\r
1613 TopMemoryAddress = 0\r
1614 else:\r
1615 TopMemoryAddress = self.LoadFixAddress\r
1616 if TopMemoryAddress < RtSize + BtSize + PeiSize:\r
1617 EdkLogger.error("build", PARAMETER_INVALID, "FIX_LOAD_TOP_MEMORY_ADDRESS is too low to load driver")\r
52302d4d
LG
1618\r
1619 #\r
1620 # Patch FixAddress related PCDs into EFI image\r
1621 #\r
4afd3d04 1622 for EfiImage in PatchEfiImageList:\r
52302d4d
LG
1623 EfiImageMap = EfiImage.replace('.efi', '.map')\r
1624 if not os.path.exists(EfiImageMap):\r
1625 continue\r
1626 #\r
1627 # Get PCD offset in EFI image by GenPatchPcdTable function\r
1628 #\r
4afd3d04 1629 PcdTable = parsePcdInfoFromMapFile(EfiImageMap, EfiImage)\r
52302d4d
LG
1630 #\r
1631 # Patch real PCD value by PatchPcdValue tool\r
1632 #\r
1633 for PcdInfo in PcdTable:\r
1634 ReturnValue = 0\r
1635 if PcdInfo[0] == TAB_PCDS_PATCHABLE_LOAD_FIX_ADDRESS_PEI_PAGE_SIZE:\r
b3e94a06 1636 ReturnValue, ErrorInfo = PatchBinaryFile (EfiImage, PcdInfo[1], TAB_PCDS_PATCHABLE_LOAD_FIX_ADDRESS_PEI_PAGE_SIZE_DATA_TYPE, str (PeiSize // 0x1000))\r
52302d4d 1637 elif PcdInfo[0] == TAB_PCDS_PATCHABLE_LOAD_FIX_ADDRESS_DXE_PAGE_SIZE:\r
b3e94a06 1638 ReturnValue, ErrorInfo = PatchBinaryFile (EfiImage, PcdInfo[1], TAB_PCDS_PATCHABLE_LOAD_FIX_ADDRESS_DXE_PAGE_SIZE_DATA_TYPE, str (BtSize // 0x1000))\r
52302d4d 1639 elif PcdInfo[0] == TAB_PCDS_PATCHABLE_LOAD_FIX_ADDRESS_RUNTIME_PAGE_SIZE:\r
b3e94a06 1640 ReturnValue, ErrorInfo = PatchBinaryFile (EfiImage, PcdInfo[1], TAB_PCDS_PATCHABLE_LOAD_FIX_ADDRESS_RUNTIME_PAGE_SIZE_DATA_TYPE, str (RtSize // 0x1000))\r
52302d4d 1641 elif PcdInfo[0] == TAB_PCDS_PATCHABLE_LOAD_FIX_ADDRESS_SMM_PAGE_SIZE and len (SmmModuleList) > 0:\r
b3e94a06 1642 ReturnValue, ErrorInfo = PatchBinaryFile (EfiImage, PcdInfo[1], TAB_PCDS_PATCHABLE_LOAD_FIX_ADDRESS_SMM_PAGE_SIZE_DATA_TYPE, str (SmmSize // 0x1000))\r
52302d4d
LG
1643 if ReturnValue != 0:\r
1644 EdkLogger.error("build", PARAMETER_INVALID, "Patch PCD value failed", ExtraData=ErrorInfo)\r
4afd3d04 1645\r
d943b0c3
FB
1646 MapBuffer.append('PEI_CODE_PAGE_NUMBER = 0x%x\n' % (PeiSize // 0x1000))\r
1647 MapBuffer.append('BOOT_CODE_PAGE_NUMBER = 0x%x\n' % (BtSize // 0x1000))\r
1648 MapBuffer.append('RUNTIME_CODE_PAGE_NUMBER = 0x%x\n' % (RtSize // 0x1000))\r
52302d4d 1649 if len (SmmModuleList) > 0:\r
d943b0c3 1650 MapBuffer.append('SMM_CODE_PAGE_NUMBER = 0x%x\n' % (SmmSize // 0x1000))\r
4afd3d04
LG
1651\r
1652 PeiBaseAddr = TopMemoryAddress - RtSize - BtSize\r
52302d4d 1653 BtBaseAddr = TopMemoryAddress - RtSize\r
4afd3d04 1654 RtBaseAddr = TopMemoryAddress - ReservedRuntimeMemorySize\r
52302d4d
LG
1655\r
1656 self._RebaseModule (MapBuffer, PeiBaseAddr, PeiModuleList, TopMemoryAddress == 0)\r
1657 self._RebaseModule (MapBuffer, BtBaseAddr, BtModuleList, TopMemoryAddress == 0)\r
1658 self._RebaseModule (MapBuffer, RtBaseAddr, RtModuleList, TopMemoryAddress == 0)\r
47fea6af 1659 self._RebaseModule (MapBuffer, 0x1000, SmmModuleList, AddrIsOffset=False, ModeIsSmm=True)\r
d943b0c3 1660 MapBuffer.append('\n\n')\r
da92f276
LG
1661 sys.stdout.write ("\n")\r
1662 sys.stdout.flush()\r
4afd3d04 1663\r
52302d4d
LG
1664 ## Save platform Map file\r
1665 #\r
1666 def _SaveMapFile (self, MapBuffer, Wa):\r
1667 #\r
1668 # Map file path is got.\r
1669 #\r
1670 MapFilePath = os.path.join(Wa.BuildDir, Wa.Name + '.map')\r
1671 #\r
1672 # Save address map into MAP file.\r
1673 #\r
d943b0c3 1674 SaveFileOnChange(MapFilePath, ''.join(MapBuffer), False)\r
da92f276 1675 if self.LoadFixAddress != 0:\r
47fea6af 1676 sys.stdout.write ("\nLoad Module At Fix Address Map file can be found at %s\n" % (MapFilePath))\r
da92f276 1677 sys.stdout.flush()\r
52302d4d
LG
1678\r
1679 ## Build active platform for different build targets and different tool chains\r
1680 #\r
1681 def _BuildPlatform(self):\r
f0dc69e6 1682 SaveFileOnChange(self.PlatformBuildPath, '# DO NOT EDIT \n# FILE auto-generated\n', False)\r
52302d4d 1683 for BuildTarget in self.BuildTargetList:\r
0d2711a6 1684 GlobalData.gGlobalDefines['TARGET'] = BuildTarget\r
40b4e21d 1685 index = 0\r
52302d4d 1686 for ToolChain in self.ToolChainList:\r
0d2711a6
LG
1687 GlobalData.gGlobalDefines['TOOLCHAIN'] = ToolChain\r
1688 GlobalData.gGlobalDefines['TOOL_CHAIN_TAG'] = ToolChain\r
40b4e21d
YZ
1689 GlobalData.gGlobalDefines['FAMILY'] = self.ToolChainFamily[index]\r
1690 index += 1\r
52302d4d
LG
1691 Wa = WorkspaceAutoGen(\r
1692 self.WorkspaceDir,\r
0d2711a6 1693 self.PlatformFile,\r
52302d4d
LG
1694 BuildTarget,\r
1695 ToolChain,\r
1696 self.ArchList,\r
1697 self.BuildDatabase,\r
1698 self.TargetTxt,\r
1699 self.ToolDef,\r
1700 self.Fdf,\r
1701 self.FdList,\r
1702 self.FvList,\r
4234283c 1703 self.CapList,\r
f3decdc3 1704 self.SkuId,\r
9508d0fa
LG
1705 self.UniFlag,\r
1706 self.Progress\r
52302d4d 1707 )\r
0d2711a6
LG
1708 self.Fdf = Wa.FdfFile\r
1709 self.LoadFixAddress = Wa.Platform.LoadFixAddress\r
52302d4d
LG
1710 self.BuildReport.AddPlatformReport(Wa)\r
1711 self.Progress.Stop("done!")\r
37de70b7
YZ
1712\r
1713 # Add ffs build to makefile\r
1714 CmdListDict = {}\r
1715 if GlobalData.gEnableGenfdsMultiThread and self.Fdf:\r
b1e27d17 1716 CmdListDict = self._GenFfsCmd(Wa.ArchList)\r
37de70b7 1717\r
03af2753
HC
1718 for Arch in Wa.ArchList:\r
1719 GlobalData.gGlobalDefines['ARCH'] = Arch\r
1720 Pa = PlatformAutoGen(Wa, self.PlatformFile, BuildTarget, ToolChain, Arch)\r
a0a2cd1e
FB
1721 for Module in Pa.Platform.Modules:\r
1722 # Get ModuleAutoGen object to generate C code file and makefile\r
1723 Ma = ModuleAutoGen(Wa, Module, BuildTarget, ToolChain, Arch, self.PlatformFile)\r
4231a819 1724 if Ma is None:\r
a0a2cd1e
FB
1725 continue\r
1726 self.BuildModules.append(Ma)\r
37de70b7 1727 self._BuildPa(self.Target, Pa, FfsCommand=CmdListDict)\r
4afd3d04 1728\r
52302d4d 1729 # Create MAP file when Load Fix Address is enabled.\r
636f2be6 1730 if self.Target in ["", "all", "fds"]:\r
0d2711a6
LG
1731 for Arch in Wa.ArchList:\r
1732 GlobalData.gGlobalDefines['ARCH'] = Arch\r
52302d4d
LG
1733 #\r
1734 # Check whether the set fix address is above 4G for 32bit image.\r
1735 #\r
1736 if (Arch == 'IA32' or Arch == 'ARM') and self.LoadFixAddress != 0xFFFFFFFFFFFFFFFF and self.LoadFixAddress >= 0x100000000:\r
0d2711a6 1737 EdkLogger.error("build", PARAMETER_INVALID, "FIX_LOAD_TOP_MEMORY_ADDRESS can't be set to larger than or equal to 4G for the platform with IA32 or ARM arch modules")\r
52302d4d
LG
1738 #\r
1739 # Get Module List\r
1740 #\r
636f2be6 1741 ModuleList = {}\r
52302d4d
LG
1742 for Pa in Wa.AutoGenObjectList:\r
1743 for Ma in Pa.ModuleAutoGenList:\r
4231a819 1744 if Ma is None:\r
52302d4d
LG
1745 continue\r
1746 if not Ma.IsLibrary:\r
636f2be6 1747 ModuleList[Ma.Guid.upper()] = Ma\r
52302d4d 1748\r
d943b0c3 1749 MapBuffer = []\r
636f2be6
LG
1750 if self.LoadFixAddress != 0:\r
1751 #\r
1752 # Rebase module to the preferred memory address before GenFds\r
1753 #\r
1754 self._CollectModuleMapBuffer(MapBuffer, ModuleList)\r
0d2711a6 1755 if self.Fdf:\r
b0e23cf3
YL
1756 #\r
1757 # create FDS again for the updated EFI image\r
1758 #\r
1759 self._Build("fds", Wa)\r
52302d4d
LG
1760 #\r
1761 # Create MAP file for all platform FVs after GenFds.\r
1762 #\r
636f2be6 1763 self._CollectFvMapBuffer(MapBuffer, Wa, ModuleList)\r
52302d4d
LG
1764 #\r
1765 # Save MAP buffer into MAP file.\r
1766 #\r
1767 self._SaveMapFile (MapBuffer, Wa)\r
1768\r
1769 ## Build active module for different build targets, different tool chains and different archs\r
1770 #\r
1771 def _BuildModule(self):\r
1772 for BuildTarget in self.BuildTargetList:\r
0d2711a6 1773 GlobalData.gGlobalDefines['TARGET'] = BuildTarget\r
40b4e21d 1774 index = 0\r
52302d4d 1775 for ToolChain in self.ToolChainList:\r
1b8eca8b 1776 WorkspaceAutoGenTime = time.time()\r
0d2711a6 1777 GlobalData.gGlobalDefines['TOOLCHAIN'] = ToolChain\r
4afd3d04 1778 GlobalData.gGlobalDefines['TOOL_CHAIN_TAG'] = ToolChain\r
40b4e21d
YZ
1779 GlobalData.gGlobalDefines['FAMILY'] = self.ToolChainFamily[index]\r
1780 index += 1\r
52302d4d
LG
1781 #\r
1782 # module build needs platform build information, so get platform\r
1783 # AutoGen first\r
1784 #\r
1785 Wa = WorkspaceAutoGen(\r
1786 self.WorkspaceDir,\r
0d2711a6 1787 self.PlatformFile,\r
52302d4d
LG
1788 BuildTarget,\r
1789 ToolChain,\r
1790 self.ArchList,\r
1791 self.BuildDatabase,\r
1792 self.TargetTxt,\r
1793 self.ToolDef,\r
1794 self.Fdf,\r
1795 self.FdList,\r
1796 self.FvList,\r
4234283c 1797 self.CapList,\r
f3decdc3 1798 self.SkuId,\r
9508d0fa
LG
1799 self.UniFlag,\r
1800 self.Progress,\r
1801 self.ModuleFile\r
52302d4d 1802 )\r
0d2711a6
LG
1803 self.Fdf = Wa.FdfFile\r
1804 self.LoadFixAddress = Wa.Platform.LoadFixAddress\r
52302d4d 1805 Wa.CreateMakeFile(False)\r
37de70b7
YZ
1806 # Add ffs build to makefile\r
1807 CmdListDict = None\r
1808 if GlobalData.gEnableGenfdsMultiThread and self.Fdf:\r
b1e27d17 1809 CmdListDict = self._GenFfsCmd(Wa.ArchList)\r
52302d4d
LG
1810 self.Progress.Stop("done!")\r
1811 MaList = []\r
1b8eca8b
YZ
1812 ExitFlag = threading.Event()\r
1813 ExitFlag.clear()\r
1814 self.AutoGenTime += int(round((time.time() - WorkspaceAutoGenTime)))\r
0d2711a6 1815 for Arch in Wa.ArchList:\r
1b8eca8b 1816 AutoGenStart = time.time()\r
0d2711a6 1817 GlobalData.gGlobalDefines['ARCH'] = Arch\r
16bad1fb
YZ
1818 Pa = PlatformAutoGen(Wa, self.PlatformFile, BuildTarget, ToolChain, Arch)\r
1819 for Module in Pa.Platform.Modules:\r
fbe53845 1820 if self.ModuleFile.Dir == Module.Dir and self.ModuleFile.Name == Module.Name:\r
16bad1fb 1821 Ma = ModuleAutoGen(Wa, Module, BuildTarget, ToolChain, Arch, self.PlatformFile)\r
db4d47fd
CR
1822 if Ma is None:\r
1823 continue\r
19bf8314
YZ
1824 MaList.append(Ma)\r
1825 if Ma.CanSkipbyHash():\r
1826 self.HashSkipModules.append(Ma)\r
04df1853
SS
1827 if GlobalData.gBinCacheSource:\r
1828 EdkLogger.quiet("cache hit: %s[%s]" % (Ma.MetaFile.Path, Ma.Arch))\r
19bf8314 1829 continue\r
04df1853
SS
1830 else:\r
1831 if GlobalData.gBinCacheSource:\r
1832 EdkLogger.quiet("cache miss: %s[%s]" % (Ma.MetaFile.Path, Ma.Arch))\r
119d8c42
YZ
1833 # Not to auto-gen for targets 'clean', 'cleanlib', 'cleanall', 'run', 'fds'\r
1834 if self.Target not in ['clean', 'cleanlib', 'cleanall', 'run', 'fds']:\r
1835 # for target which must generate AutoGen code and makefile\r
1836 if not self.SkipAutoGen or self.Target == 'genc':\r
cd498216 1837 self.Progress.Start("Generating code")\r
119d8c42 1838 Ma.CreateCodeFile(True)\r
cd498216
YZ
1839 self.Progress.Stop("done!")\r
1840 if self.Target == "genc":\r
1841 return True\r
119d8c42 1842 if not self.SkipAutoGen or self.Target == 'genmake':\r
cd498216 1843 self.Progress.Start("Generating makefile")\r
37de70b7
YZ
1844 if CmdListDict and self.Fdf and (Module.File, Arch) in CmdListDict:\r
1845 Ma.CreateMakeFile(True, CmdListDict[Module.File, Arch])\r
1846 del CmdListDict[Module.File, Arch]\r
1847 else:\r
1848 Ma.CreateMakeFile(True)\r
cd498216
YZ
1849 self.Progress.Stop("done!")\r
1850 if self.Target == "genmake":\r
1851 return True\r
16bad1fb 1852 self.BuildModules.append(Ma)\r
48b0bf64
RC
1853 # Initialize all modules in tracking to 'FAIL'\r
1854 if Ma.Arch not in GlobalData.gModuleBuildTracking:\r
1855 GlobalData.gModuleBuildTracking[Ma.Arch] = dict()\r
1856 if Ma not in GlobalData.gModuleBuildTracking[Ma.Arch]:\r
1857 GlobalData.gModuleBuildTracking[Ma.Arch][Ma] = 'FAIL'\r
1b8eca8b
YZ
1858 self.AutoGenTime += int(round((time.time() - AutoGenStart)))\r
1859 MakeStart = time.time()\r
1860 for Ma in self.BuildModules:\r
1861 if not Ma.IsBinaryModule:\r
1862 Bt = BuildTask.New(ModuleMakeUnit(Ma, self.Target))\r
1863 # Break build if any build thread has error\r
1864 if BuildTask.HasError():\r
1865 # we need a full version of makefile for platform\r
1866 ExitFlag.set()\r
1867 BuildTask.WaitForComplete()\r
0eccea3f 1868 self.invalidateHash()\r
1b8eca8b
YZ
1869 Pa.CreateMakeFile(False)\r
1870 EdkLogger.error("build", BUILD_ERROR, "Failed to build module", ExtraData=GlobalData.gBuildingModule)\r
1871 # Start task scheduler\r
1872 if not BuildTask.IsOnGoing():\r
1873 BuildTask.StartScheduler(self.ThreadNumber, ExitFlag)\r
1874\r
1875 # in case there's an interruption. we need a full version of makefile for platform\r
1876 Pa.CreateMakeFile(False)\r
1877 if BuildTask.HasError():\r
0eccea3f 1878 self.invalidateHash()\r
1b8eca8b
YZ
1879 EdkLogger.error("build", BUILD_ERROR, "Failed to build module", ExtraData=GlobalData.gBuildingModule)\r
1880 self.MakeTime += int(round((time.time() - MakeStart)))\r
1881\r
1882 MakeContiue = time.time()\r
1883 ExitFlag.set()\r
1884 BuildTask.WaitForComplete()\r
1885 self.CreateAsBuiltInf()\r
b8ac0b7f
BF
1886 if GlobalData.gBinCacheDest:\r
1887 self.UpdateBuildCache()\r
1888 self.BuildModules = []\r
1b8eca8b
YZ
1889 self.MakeTime += int(round((time.time() - MakeContiue)))\r
1890 if BuildTask.HasError():\r
0eccea3f 1891 self.invalidateHash()\r
1b8eca8b 1892 EdkLogger.error("build", BUILD_ERROR, "Failed to build module", ExtraData=GlobalData.gBuildingModule)\r
d5d56f1b
LG
1893\r
1894 self.BuildReport.AddPlatformReport(Wa, MaList)\r
52302d4d
LG
1895 if MaList == []:\r
1896 EdkLogger.error(\r
1897 'build',\r
1898 BUILD_ERROR,\r
1899 "Module for [%s] is not a component of active platform."\\r
1900 " Please make sure that the ARCH and inf file path are"\\r
47fea6af 1901 " given in the same as in [%s]" % \\r
0d2711a6 1902 (', '.join(Wa.ArchList), self.PlatformFile),\r
52302d4d
LG
1903 ExtraData=self.ModuleFile\r
1904 )\r
1905 # Create MAP file when Load Fix Address is enabled.\r
0d2711a6
LG
1906 if self.Target == "fds" and self.Fdf:\r
1907 for Arch in Wa.ArchList:\r
52302d4d
LG
1908 #\r
1909 # Check whether the set fix address is above 4G for 32bit image.\r
1910 #\r
1911 if (Arch == 'IA32' or Arch == 'ARM') and self.LoadFixAddress != 0xFFFFFFFFFFFFFFFF and self.LoadFixAddress >= 0x100000000:\r
1912 EdkLogger.error("build", PARAMETER_INVALID, "FIX_LOAD_TOP_MEMORY_ADDRESS can't be set to larger than or equal to 4G for the platorm with IA32 or ARM arch modules")\r
1913 #\r
1914 # Get Module List\r
1915 #\r
636f2be6 1916 ModuleList = {}\r
52302d4d
LG
1917 for Pa in Wa.AutoGenObjectList:\r
1918 for Ma in Pa.ModuleAutoGenList:\r
4231a819 1919 if Ma is None:\r
52302d4d
LG
1920 continue\r
1921 if not Ma.IsLibrary:\r
636f2be6 1922 ModuleList[Ma.Guid.upper()] = Ma\r
52302d4d 1923\r
d943b0c3 1924 MapBuffer = []\r
636f2be6
LG
1925 if self.LoadFixAddress != 0:\r
1926 #\r
1927 # Rebase module to the preferred memory address before GenFds\r
1928 #\r
1929 self._CollectModuleMapBuffer(MapBuffer, ModuleList)\r
b0e23cf3
YL
1930 #\r
1931 # create FDS again for the updated EFI image\r
1932 #\r
1b8eca8b 1933 GenFdsStart = time.time()\r
b0e23cf3 1934 self._Build("fds", Wa)\r
1b8eca8b 1935 self.GenFdsTime += int(round((time.time() - GenFdsStart)))\r
52302d4d
LG
1936 #\r
1937 # Create MAP file for all platform FVs after GenFds.\r
1938 #\r
636f2be6 1939 self._CollectFvMapBuffer(MapBuffer, Wa, ModuleList)\r
52302d4d
LG
1940 #\r
1941 # Save MAP buffer into MAP file.\r
1942 #\r
1943 self._SaveMapFile (MapBuffer, Wa)\r
48b0bf64 1944 self.invalidateHash()\r
52302d4d 1945\r
b1e27d17 1946 def _GenFfsCmd(self,ArchList):\r
f7496d71 1947 # convert dictionary of Cmd:(Inf,Arch)\r
9eb87141
CJ
1948 # to a new dictionary of (Inf,Arch):Cmd,Cmd,Cmd...\r
1949 CmdSetDict = defaultdict(set)\r
b1e27d17 1950 GenFfsDict = GenFds.GenFfsMakefile('', GlobalData.gFdfParser, self, ArchList, GlobalData)\r
37de70b7
YZ
1951 for Cmd in GenFfsDict:\r
1952 tmpInf, tmpArch = GenFfsDict[Cmd]\r
9eb87141
CJ
1953 CmdSetDict[tmpInf, tmpArch].add(Cmd)\r
1954 return CmdSetDict\r
37de70b7 1955\r
52302d4d
LG
1956 ## Build a platform in multi-thread mode\r
1957 #\r
1958 def _MultiThreadBuildPlatform(self):\r
f0dc69e6 1959 SaveFileOnChange(self.PlatformBuildPath, '# DO NOT EDIT \n# FILE auto-generated\n', False)\r
52302d4d 1960 for BuildTarget in self.BuildTargetList:\r
0d2711a6 1961 GlobalData.gGlobalDefines['TARGET'] = BuildTarget\r
40b4e21d 1962 index = 0\r
52302d4d 1963 for ToolChain in self.ToolChainList:\r
1b8eca8b 1964 WorkspaceAutoGenTime = time.time()\r
0d2711a6 1965 GlobalData.gGlobalDefines['TOOLCHAIN'] = ToolChain\r
4afd3d04 1966 GlobalData.gGlobalDefines['TOOL_CHAIN_TAG'] = ToolChain\r
40b4e21d
YZ
1967 GlobalData.gGlobalDefines['FAMILY'] = self.ToolChainFamily[index]\r
1968 index += 1\r
52302d4d
LG
1969 Wa = WorkspaceAutoGen(\r
1970 self.WorkspaceDir,\r
0d2711a6 1971 self.PlatformFile,\r
52302d4d
LG
1972 BuildTarget,\r
1973 ToolChain,\r
1974 self.ArchList,\r
1975 self.BuildDatabase,\r
1976 self.TargetTxt,\r
1977 self.ToolDef,\r
1978 self.Fdf,\r
1979 self.FdList,\r
1980 self.FvList,\r
4234283c 1981 self.CapList,\r
f3decdc3 1982 self.SkuId,\r
9508d0fa
LG
1983 self.UniFlag,\r
1984 self.Progress\r
52302d4d 1985 )\r
0d2711a6
LG
1986 self.Fdf = Wa.FdfFile\r
1987 self.LoadFixAddress = Wa.Platform.LoadFixAddress\r
52302d4d
LG
1988 self.BuildReport.AddPlatformReport(Wa)\r
1989 Wa.CreateMakeFile(False)\r
1990\r
37de70b7
YZ
1991 # Add ffs build to makefile\r
1992 CmdListDict = None\r
1993 if GlobalData.gEnableGenfdsMultiThread and self.Fdf:\r
b1e27d17 1994 CmdListDict = self._GenFfsCmd(Wa.ArchList)\r
37de70b7 1995\r
52302d4d
LG
1996 # multi-thread exit flag\r
1997 ExitFlag = threading.Event()\r
1998 ExitFlag.clear()\r
1b8eca8b 1999 self.AutoGenTime += int(round((time.time() - WorkspaceAutoGenTime)))\r
0d2711a6 2000 for Arch in Wa.ArchList:\r
1b8eca8b 2001 AutoGenStart = time.time()\r
0d2711a6 2002 GlobalData.gGlobalDefines['ARCH'] = Arch\r
52302d4d 2003 Pa = PlatformAutoGen(Wa, self.PlatformFile, BuildTarget, ToolChain, Arch)\r
4231a819 2004 if Pa is None:\r
52302d4d 2005 continue\r
a0a2cd1e
FB
2006 ModuleList = []\r
2007 for Inf in Pa.Platform.Modules:\r
2008 ModuleList.append(Inf)\r
2009 # Add the INF only list in FDF\r
4231a819 2010 if GlobalData.gFdfParser is not None:\r
a0a2cd1e
FB
2011 for InfName in GlobalData.gFdfParser.Profile.InfList:\r
2012 Inf = PathClass(NormPath(InfName), self.WorkspaceDir, Arch)\r
2013 if Inf in Pa.Platform.Modules:\r
2014 continue\r
2015 ModuleList.append(Inf)\r
2016 for Module in ModuleList:\r
52302d4d
LG
2017 # Get ModuleAutoGen object to generate C code file and makefile\r
2018 Ma = ModuleAutoGen(Wa, Module, BuildTarget, ToolChain, Arch, self.PlatformFile)\r
f7496d71 2019\r
4231a819 2020 if Ma is None:\r
52302d4d 2021 continue\r
36d083ef 2022 if Ma.CanSkipbyHash():\r
83397f95 2023 self.HashSkipModules.append(Ma)\r
04df1853
SS
2024 if GlobalData.gBinCacheSource:\r
2025 EdkLogger.quiet("cache hit: %s[%s]" % (Ma.MetaFile.Path, Ma.Arch))\r
36d083ef 2026 continue\r
04df1853
SS
2027 else:\r
2028 if GlobalData.gBinCacheSource:\r
2029 EdkLogger.quiet("cache miss: %s[%s]" % (Ma.MetaFile.Path, Ma.Arch))\r
36d083ef 2030\r
52302d4d
LG
2031 # Not to auto-gen for targets 'clean', 'cleanlib', 'cleanall', 'run', 'fds'\r
2032 if self.Target not in ['clean', 'cleanlib', 'cleanall', 'run', 'fds']:\r
2033 # for target which must generate AutoGen code and makefile\r
2034 if not self.SkipAutoGen or self.Target == 'genc':\r
2035 Ma.CreateCodeFile(True)\r
2036 if self.Target == "genc":\r
2037 continue\r
2038\r
2039 if not self.SkipAutoGen or self.Target == 'genmake':\r
37de70b7
YZ
2040 if CmdListDict and self.Fdf and (Module.File, Arch) in CmdListDict:\r
2041 Ma.CreateMakeFile(True, CmdListDict[Module.File, Arch])\r
2042 del CmdListDict[Module.File, Arch]\r
2043 else:\r
2044 Ma.CreateMakeFile(True)\r
52302d4d
LG
2045 if self.Target == "genmake":\r
2046 continue\r
a0a2cd1e 2047 self.BuildModules.append(Ma)\r
48b0bf64
RC
2048 # Initialize all modules in tracking to 'FAIL'\r
2049 if Ma.Arch not in GlobalData.gModuleBuildTracking:\r
2050 GlobalData.gModuleBuildTracking[Ma.Arch] = dict()\r
2051 if Ma not in GlobalData.gModuleBuildTracking[Ma.Arch]:\r
2052 GlobalData.gModuleBuildTracking[Ma.Arch][Ma] = 'FAIL'\r
e8a47801 2053 self.Progress.Stop("done!")\r
1b8eca8b
YZ
2054 self.AutoGenTime += int(round((time.time() - AutoGenStart)))\r
2055 MakeStart = time.time()\r
a0a2cd1e 2056 for Ma in self.BuildModules:\r
52302d4d 2057 # Generate build task for the module\r
a0a2cd1e
FB
2058 if not Ma.IsBinaryModule:\r
2059 Bt = BuildTask.New(ModuleMakeUnit(Ma, self.Target))\r
52302d4d
LG
2060 # Break build if any build thread has error\r
2061 if BuildTask.HasError():\r
2062 # we need a full version of makefile for platform\r
2063 ExitFlag.set()\r
2064 BuildTask.WaitForComplete()\r
0eccea3f 2065 self.invalidateHash()\r
52302d4d
LG
2066 Pa.CreateMakeFile(False)\r
2067 EdkLogger.error("build", BUILD_ERROR, "Failed to build module", ExtraData=GlobalData.gBuildingModule)\r
2068 # Start task scheduler\r
2069 if not BuildTask.IsOnGoing():\r
2070 BuildTask.StartScheduler(self.ThreadNumber, ExitFlag)\r
2071\r
2072 # in case there's an interruption. we need a full version of makefile for platform\r
2073 Pa.CreateMakeFile(False)\r
2074 if BuildTask.HasError():\r
0eccea3f 2075 self.invalidateHash()\r
52302d4d 2076 EdkLogger.error("build", BUILD_ERROR, "Failed to build module", ExtraData=GlobalData.gBuildingModule)\r
1b8eca8b 2077 self.MakeTime += int(round((time.time() - MakeStart)))\r
52302d4d 2078\r
1b8eca8b 2079 MakeContiue = time.time()\r
2f818ed0 2080\r
64b2609f 2081 #\r
52302d4d
LG
2082 #\r
2083 # All modules have been put in build tasks queue. Tell task scheduler\r
2084 # to exit if all tasks are completed\r
2085 #\r
2086 ExitFlag.set()\r
2087 BuildTask.WaitForComplete()\r
a0a2cd1e 2088 self.CreateAsBuiltInf()\r
b8ac0b7f
BF
2089 if GlobalData.gBinCacheDest:\r
2090 self.UpdateBuildCache()\r
2091 self.BuildModules = []\r
1b8eca8b 2092 self.MakeTime += int(round((time.time() - MakeContiue)))\r
52302d4d
LG
2093 #\r
2094 # Check for build error, and raise exception if one\r
2095 # has been signaled.\r
2096 #\r
2097 if BuildTask.HasError():\r
0eccea3f 2098 self.invalidateHash()\r
52302d4d
LG
2099 EdkLogger.error("build", BUILD_ERROR, "Failed to build module", ExtraData=GlobalData.gBuildingModule)\r
2100\r
2101 # Create MAP file when Load Fix Address is enabled.\r
636f2be6 2102 if self.Target in ["", "all", "fds"]:\r
0d2711a6 2103 for Arch in Wa.ArchList:\r
52302d4d
LG
2104 #\r
2105 # Check whether the set fix address is above 4G for 32bit image.\r
2106 #\r
2107 if (Arch == 'IA32' or Arch == 'ARM') and self.LoadFixAddress != 0xFFFFFFFFFFFFFFFF and self.LoadFixAddress >= 0x100000000:\r
2108 EdkLogger.error("build", PARAMETER_INVALID, "FIX_LOAD_TOP_MEMORY_ADDRESS can't be set to larger than or equal to 4G for the platorm with IA32 or ARM arch modules")\r
2109 #\r
2110 # Get Module List\r
2111 #\r
636f2be6 2112 ModuleList = {}\r
52302d4d
LG
2113 for Pa in Wa.AutoGenObjectList:\r
2114 for Ma in Pa.ModuleAutoGenList:\r
4231a819 2115 if Ma is None:\r
52302d4d
LG
2116 continue\r
2117 if not Ma.IsLibrary:\r
636f2be6 2118 ModuleList[Ma.Guid.upper()] = Ma\r
52302d4d
LG
2119 #\r
2120 # Rebase module to the preferred memory address before GenFds\r
2121 #\r
d943b0c3 2122 MapBuffer = []\r
636f2be6
LG
2123 if self.LoadFixAddress != 0:\r
2124 self._CollectModuleMapBuffer(MapBuffer, ModuleList)\r
52302d4d 2125\r
0d2711a6 2126 if self.Fdf:\r
f3decdc3
LG
2127 #\r
2128 # Generate FD image if there's a FDF file found\r
2129 #\r
1b8eca8b 2130 GenFdsStart = time.time()\r
370544d1
DL
2131 if GenFdsApi(Wa.GenFdsCommandDict, self.Db):\r
2132 EdkLogger.error("build", COMMAND_FAILURE)\r
03af2753 2133\r
52302d4d
LG
2134 #\r
2135 # Create MAP file for all platform FVs after GenFds.\r
2136 #\r
636f2be6 2137 self._CollectFvMapBuffer(MapBuffer, Wa, ModuleList)\r
1b8eca8b 2138 self.GenFdsTime += int(round((time.time() - GenFdsStart)))\r
52302d4d
LG
2139 #\r
2140 # Save MAP buffer into MAP file.\r
2141 #\r
2142 self._SaveMapFile(MapBuffer, Wa)\r
48b0bf64 2143 self.invalidateHash()\r
52302d4d
LG
2144\r
2145 ## Generate GuidedSectionTools.txt in the FV directories.\r
2146 #\r
2147 def CreateGuidedSectionToolsFile(self):\r
0d2711a6
LG
2148 for BuildTarget in self.BuildTargetList:\r
2149 for ToolChain in self.ToolChainList:\r
2150 Wa = WorkspaceAutoGen(\r
2151 self.WorkspaceDir,\r
2152 self.PlatformFile,\r
2153 BuildTarget,\r
2154 ToolChain,\r
2155 self.ArchList,\r
2156 self.BuildDatabase,\r
2157 self.TargetTxt,\r
2158 self.ToolDef,\r
2159 self.Fdf,\r
2160 self.FdList,\r
2161 self.FvList,\r
2162 self.CapList,\r
2163 self.SkuId,\r
2164 self.UniFlag\r
2165 )\r
2166 FvDir = Wa.FvDir\r
2167 if not os.path.exists(FvDir):\r
2168 continue\r
2169\r
4afd3d04 2170 for Arch in self.ArchList:\r
52302d4d
LG
2171 # Build up the list of supported architectures for this build\r
2172 prefix = '%s_%s_%s_' % (BuildTarget, ToolChain, Arch)\r
4afd3d04 2173\r
52302d4d
LG
2174 # Look through the tool definitions for GUIDed tools\r
2175 guidAttribs = []\r
3a041437 2176 for (attrib, value) in self.ToolDef.ToolsDefTxtDictionary.items():\r
52302d4d
LG
2177 if attrib.upper().endswith('_GUID'):\r
2178 split = attrib.split('_')\r
2179 thisPrefix = '_'.join(split[0:3]) + '_'\r
2180 if thisPrefix == prefix:\r
2181 guid = self.ToolDef.ToolsDefTxtDictionary[attrib]\r
2182 guid = guid.lower()\r
2183 toolName = split[3]\r
2184 path = '_'.join(split[0:4]) + '_PATH'\r
2185 path = self.ToolDef.ToolsDefTxtDictionary[path]\r
2186 path = self.GetFullPathOfTool(path)\r
2187 guidAttribs.append((guid, toolName, path))\r
4afd3d04 2188\r
52302d4d
LG
2189 # Write out GuidedSecTools.txt\r
2190 toolsFile = os.path.join(FvDir, 'GuidedSectionTools.txt')\r
2191 toolsFile = open(toolsFile, 'wt')\r
2192 for guidedSectionTool in guidAttribs:\r
72443dd2 2193 print(' '.join(guidedSectionTool), file=toolsFile)\r
52302d4d
LG
2194 toolsFile.close()\r
2195\r
2196 ## Returns the full path of the tool.\r
2197 #\r
2198 def GetFullPathOfTool (self, tool):\r
2199 if os.path.exists(tool):\r
2200 return os.path.realpath(tool)\r
2201 else:\r
2202 # We need to search for the tool using the\r
2203 # PATH environment variable.\r
2204 for dirInPath in os.environ['PATH'].split(os.pathsep):\r
2205 foundPath = os.path.join(dirInPath, tool)\r
2206 if os.path.exists(foundPath):\r
2207 return os.path.realpath(foundPath)\r
2208\r
2209 # If the tool was not found in the path then we just return\r
2210 # the input tool.\r
2211 return tool\r
2212\r
2213 ## Launch the module or platform build\r
2214 #\r
2215 def Launch(self):\r
0d2711a6 2216 if not self.ModuleFile:\r
52302d4d
LG
2217 if not self.SpawnMode or self.Target not in ["", "all"]:\r
2218 self.SpawnMode = False\r
2219 self._BuildPlatform()\r
2220 else:\r
2221 self._MultiThreadBuildPlatform()\r
2222 self.CreateGuidedSectionToolsFile()\r
2223 else:\r
2224 self.SpawnMode = False\r
2225 self._BuildModule()\r
2226\r
bcbdc755 2227 if self.Target == 'cleanall':\r
bcbdc755
YL
2228 RemoveDirectory(os.path.dirname(GlobalData.gDatabasePath), True)\r
2229\r
a0a2cd1e 2230 def CreateAsBuiltInf(self):\r
b8ac0b7f
BF
2231 for Module in self.BuildModules:\r
2232 Module.CreateAsBuiltInf()\r
2233\r
2234 def UpdateBuildCache(self):\r
db4d47fd
CR
2235 all_lib_set = set()\r
2236 all_mod_set = set()\r
a0a2cd1e 2237 for Module in self.BuildModules:\r
b8ac0b7f 2238 Module.CopyModuleToCache()\r
db4d47fd 2239 all_mod_set.add(Module)\r
83397f95 2240 for Module in self.HashSkipModules:\r
b8ac0b7f 2241 Module.CopyModuleToCache()\r
db4d47fd
CR
2242 all_mod_set.add(Module)\r
2243 for Module in all_mod_set:\r
2244 for lib in Module.LibraryAutoGenList:\r
2245 all_lib_set.add(lib)\r
2246 for lib in all_lib_set:\r
b8ac0b7f 2247 lib.CopyModuleToCache()\r
db4d47fd
CR
2248 all_lib_set.clear()\r
2249 all_mod_set.clear()\r
83397f95 2250 self.HashSkipModules = []\r
52302d4d
LG
2251 ## Do some clean-up works when error occurred\r
2252 def Relinquish(self):\r
2253 OldLogLevel = EdkLogger.GetLevel()\r
2254 EdkLogger.SetLevel(EdkLogger.ERROR)\r
52302d4d
LG
2255 Utils.Progressor.Abort()\r
2256 if self.SpawnMode == True:\r
2257 BuildTask.Abort()\r
2258 EdkLogger.SetLevel(OldLogLevel)\r
2259\r
52302d4d
LG
2260def ParseDefines(DefineList=[]):\r
2261 DefineDict = {}\r
4231a819 2262 if DefineList is not None:\r
52302d4d
LG
2263 for Define in DefineList:\r
2264 DefineTokenList = Define.split("=", 1)\r
0d2711a6
LG
2265 if not GlobalData.gMacroNamePattern.match(DefineTokenList[0]):\r
2266 EdkLogger.error('build', FORMAT_INVALID,\r
2267 "The macro name must be in the pattern [A-Z][A-Z0-9_]*",\r
2268 ExtraData=DefineTokenList[0])\r
4afd3d04 2269\r
52302d4d 2270 if len(DefineTokenList) == 1:\r
0d2711a6 2271 DefineDict[DefineTokenList[0]] = "TRUE"\r
52302d4d
LG
2272 else:\r
2273 DefineDict[DefineTokenList[0]] = DefineTokenList[1].strip()\r
2274 return DefineDict\r
2275\r
2276gParamCheck = []\r
2277def SingleCheckCallback(option, opt_str, value, parser):\r
2278 if option not in gParamCheck:\r
2279 setattr(parser.values, option.dest, value)\r
2280 gParamCheck.append(option)\r
2281 else:\r
2282 parser.error("Option %s only allows one instance in command line!" % option)\r
2283\r
1b8eca8b
YZ
2284def LogBuildTime(Time):\r
2285 if Time:\r
2286 TimeDurStr = ''\r
2287 TimeDur = time.gmtime(Time)\r
2288 if TimeDur.tm_yday > 1:\r
2289 TimeDurStr = time.strftime("%H:%M:%S", TimeDur) + ", %d day(s)" % (TimeDur.tm_yday - 1)\r
2290 else:\r
2291 TimeDurStr = time.strftime("%H:%M:%S", TimeDur)\r
2292 return TimeDurStr\r
2293 else:\r
2294 return None\r
2295\r
52302d4d
LG
2296## Parse command line options\r
2297#\r
2298# Using standard Python module optparse to parse command line option of this tool.\r
2299#\r
2300# @retval Opt A optparse.Values object containing the parsed options\r
2301# @retval Args Target of build command\r
2302#\r
2303def MyOptionParser():\r
47fea6af 2304 Parser = OptionParser(description=__copyright__, version=__version__, prog="build.exe", usage="%prog [options] [all|fds|genc|genmake|clean|cleanall|cleanlib|modules|libraries|run]")\r
39879ef2
FB
2305 Parser.add_option("-a", "--arch", action="append", type="choice", choices=['IA32', 'X64', 'EBC', 'ARM', 'AARCH64'], dest="TargetArch",\r
2306 help="ARCHS is one of list: IA32, X64, ARM, AARCH64 or EBC, which overrides target.txt's TARGET_ARCH definition. To specify more archs, please repeat this option.")\r
52302d4d
LG
2307 Parser.add_option("-p", "--platform", action="callback", type="string", dest="PlatformFile", callback=SingleCheckCallback,\r
2308 help="Build the platform specified by the DSC file name argument, overriding target.txt's ACTIVE_PLATFORM definition.")\r
2309 Parser.add_option("-m", "--module", action="callback", type="string", dest="ModuleFile", callback=SingleCheckCallback,\r
2310 help="Build the module specified by the INF file name argument.")\r
64b2609f
LG
2311 Parser.add_option("-b", "--buildtarget", type="string", dest="BuildTarget", help="Using the TARGET to build the platform, overriding target.txt's TARGET definition.",\r
2312 action="append")\r
52302d4d
LG
2313 Parser.add_option("-t", "--tagname", action="append", type="string", dest="ToolChain",\r
2314 help="Using the Tool Chain Tagname to build the platform, overriding target.txt's TOOL_CHAIN_TAG definition.")\r
2315 Parser.add_option("-x", "--sku-id", action="callback", type="string", dest="SkuId", callback=SingleCheckCallback,\r
2316 help="Using this name of SKU ID to build the platform, overriding SKUID_IDENTIFIER in DSC file.")\r
2317\r
2318 Parser.add_option("-n", action="callback", type="int", dest="ThreadNumber", callback=SingleCheckCallback,\r
2052cb67
YZ
2319 help="Build the platform using multi-threaded compiler. The value overrides target.txt's MAX_CONCURRENT_THREAD_NUMBER. When value is set to 0, tool automatically detect number of "\\r
2320 "processor threads, set value to 1 means disable multi-thread build, and set value to more than 1 means user specify the threads number to build.")\r
52302d4d
LG
2321\r
2322 Parser.add_option("-f", "--fdf", action="callback", type="string", dest="FdfFile", callback=SingleCheckCallback,\r
2323 help="The name of the FDF file to use, which overrides the setting in the DSC file.")\r
2324 Parser.add_option("-r", "--rom-image", action="append", type="string", dest="RomImage", default=[],\r
2325 help="The name of FD to be generated. The name must be from [FD] section in FDF file.")\r
2326 Parser.add_option("-i", "--fv-image", action="append", type="string", dest="FvImage", default=[],\r
2327 help="The name of FV to be generated. The name must be from [FV] section in FDF file.")\r
4234283c
LG
2328 Parser.add_option("-C", "--capsule-image", action="append", type="string", dest="CapName", default=[],\r
2329 help="The name of Capsule to be generated. The name must be from [Capsule] section in FDF file.")\r
52302d4d
LG
2330 Parser.add_option("-u", "--skip-autogen", action="store_true", dest="SkipAutoGen", help="Skip AutoGen step.")\r
2331 Parser.add_option("-e", "--re-parse", action="store_true", dest="Reparse", help="Re-parse all meta-data files.")\r
2332\r
0d2711a6 2333 Parser.add_option("-c", "--case-insensitive", action="store_true", dest="CaseInsensitive", default=False, help="Don't check case of file name.")\r
52302d4d
LG
2334\r
2335 Parser.add_option("-w", "--warning-as-error", action="store_true", dest="WarningAsError", help="Treat warning in tools as error.")\r
2336 Parser.add_option("-j", "--log", action="store", dest="LogFile", help="Put log in specified file as well as on console.")\r
2337\r
2338 Parser.add_option("-s", "--silent", action="store_true", type=None, dest="SilentMode",\r
2339 help="Make use of silent mode of (n)make.")\r
2340 Parser.add_option("-q", "--quiet", action="store_true", type=None, help="Disable all messages except FATAL ERRORS.")\r
2341 Parser.add_option("-v", "--verbose", action="store_true", type=None, help="Turn on verbose output with informational messages printed, "\\r
2342 "including library instances selected, final dependency expression, "\\r
2343 "and warning messages, etc.")\r
2344 Parser.add_option("-d", "--debug", action="store", type="int", help="Enable debug messages at specified level.")\r
2345 Parser.add_option("-D", "--define", action="append", type="string", dest="Macros", help="Macro: \"Name [= Value]\".")\r
2346\r
2347 Parser.add_option("-y", "--report-file", action="store", dest="ReportFile", help="Create/overwrite the report to the specified filename.")\r
ccaa7754 2348 Parser.add_option("-Y", "--report-type", action="append", type="choice", choices=['PCD', 'LIBRARY', 'FLASH', 'DEPEX', 'BUILD_FLAGS', 'FIXED_ADDRESS', 'HASH', 'EXECUTION_ORDER'], dest="ReportType", default=[],\r
eca5be7a 2349 help="Flags that control the type of build report to generate. Must be one of: [PCD, LIBRARY, FLASH, DEPEX, BUILD_FLAGS, FIXED_ADDRESS, HASH, EXECUTION_ORDER]. "\\r
302860bf 2350 "To specify more than one flag, repeat this option on the command line and the default flag set is [PCD, LIBRARY, FLASH, DEPEX, HASH, BUILD_FLAGS, FIXED_ADDRESS]")\r
f3decdc3
LG
2351 Parser.add_option("-F", "--flag", action="store", type="string", dest="Flag",\r
2352 help="Specify the specific option to parse EDK UNI file. Must be one of: [-c, -s]. -c is for EDK framework UNI file, and -s is for EDK UEFI UNI file. "\\r
2353 "This option can also be specified by setting *_*_*_BUILD_FLAGS in [BuildOptions] section of platform DSC. If they are both specified, this value "\\r
2354 "will override the setting in [BuildOptions] section of platform DSC.")\r
0d2711a6 2355 Parser.add_option("-N", "--no-cache", action="store_true", dest="DisableCache", default=False, help="Disable build cache mechanism")\r
97fa0ee9
YL
2356 Parser.add_option("--conf", action="store", type="string", dest="ConfDirectory", help="Specify the customized Conf directory.")\r
2357 Parser.add_option("--check-usage", action="store_true", dest="CheckUsage", default=False, help="Check usage content of entries listed in INF file.")\r
fae62ff2 2358 Parser.add_option("--ignore-sources", action="store_true", dest="IgnoreSources", default=False, help="Focus to a binary build and ignore all source files")\r
d7cd3356 2359 Parser.add_option("--pcd", action="append", dest="OptionPcd", help="Set PCD value by command line. Format: \"PcdName=Value\" ")\r
725cdb8f 2360 Parser.add_option("-l", "--cmd-len", action="store", type="int", dest="CommandLength", help="Specify the maximum line length of build command. Default is 4096.")\r
36d083ef
YZ
2361 Parser.add_option("--hash", action="store_true", dest="UseHashCache", default=False, help="Enable hash-based caching during build process.")\r
2362 Parser.add_option("--binary-destination", action="store", type="string", dest="BinCacheDest", help="Generate a cache of binary files in the specified directory.")\r
2363 Parser.add_option("--binary-source", action="store", type="string", dest="BinCacheSource", help="Consume a cache of binary files from the specified directory.")\r
37de70b7 2364 Parser.add_option("--genfds-multi-thread", action="store_true", dest="GenfdsMultiThread", default=False, help="Enable GenFds multi thread to generate ffs file.")\r
d868846a 2365 Parser.add_option("--disable-include-path-check", action="store_true", dest="DisableIncludePathCheck", default=False, help="Disable the include path check for outside of package.")\r
47fea6af 2366 (Opt, Args) = Parser.parse_args()\r
52302d4d
LG
2367 return (Opt, Args)\r
2368\r
2369## Tool entrance method\r
2370#\r
2371# This method mainly dispatch specific methods per the command line options.\r
2372# If no error found, return zero value so the caller of this tool can know\r
2373# if it's executed successfully or not.\r
2374#\r
2375# @retval 0 Tool was successful\r
2376# @retval 1 Tool failed\r
2377#\r
2378def Main():\r
2379 StartTime = time.time()\r
2380\r
2381 # Initialize log system\r
2382 EdkLogger.Initialize()\r
f0dc69e6 2383 GlobalData.gCommand = sys.argv[1:]\r
52302d4d
LG
2384 #\r
2385 # Parse the options and args\r
2386 #\r
2387 (Option, Target) = MyOptionParser()\r
2388 GlobalData.gOptions = Option\r
2389 GlobalData.gCaseInsensitive = Option.CaseInsensitive\r
2390\r
2391 # Set log level\r
4231a819 2392 if Option.verbose is not None:\r
52302d4d 2393 EdkLogger.SetLevel(EdkLogger.VERBOSE)\r
4231a819 2394 elif Option.quiet is not None:\r
52302d4d 2395 EdkLogger.SetLevel(EdkLogger.QUIET)\r
4231a819 2396 elif Option.debug is not None:\r
52302d4d
LG
2397 EdkLogger.SetLevel(Option.debug + 1)\r
2398 else:\r
2399 EdkLogger.SetLevel(EdkLogger.INFO)\r
2400\r
4231a819 2401 if Option.LogFile is not None:\r
52302d4d
LG
2402 EdkLogger.SetLogFile(Option.LogFile)\r
2403\r
2404 if Option.WarningAsError == True:\r
2405 EdkLogger.SetWarningAsError()\r
2406\r
2407 if platform.platform().find("Windows") >= 0:\r
2408 GlobalData.gIsWindows = True\r
2409 else:\r
2410 GlobalData.gIsWindows = False\r
2411\r
6780eef1
LG
2412 EdkLogger.quiet("Build environment: %s" % platform.platform())\r
2413 EdkLogger.quiet(time.strftime("Build start time: %H:%M:%S, %b.%d %Y\n", time.localtime()));\r
52302d4d
LG
2414 ReturnCode = 0\r
2415 MyBuild = None\r
09ae0f11 2416 BuildError = True\r
52302d4d
LG
2417 try:\r
2418 if len(Target) == 0:\r
2419 Target = "all"\r
2420 elif len(Target) >= 2:\r
2421 EdkLogger.error("build", OPTION_NOT_SUPPORTED, "More than one targets are not supported.",\r
47fea6af 2422 ExtraData="Please select one of: %s" % (' '.join(gSupportedTarget)))\r
52302d4d
LG
2423 else:\r
2424 Target = Target[0].lower()\r
2425\r
2426 if Target not in gSupportedTarget:\r
2427 EdkLogger.error("build", OPTION_NOT_SUPPORTED, "Not supported target [%s]." % Target,\r
47fea6af 2428 ExtraData="Please select one of: %s" % (' '.join(gSupportedTarget)))\r
52302d4d 2429\r
52302d4d
LG
2430 #\r
2431 # Check environment variable: EDK_TOOLS_PATH, WORKSPACE, PATH\r
2432 #\r
2433 CheckEnvVariable()\r
0d2711a6
LG
2434 GlobalData.gCommandLineDefines.update(ParseDefines(Option.Macros))\r
2435\r
52302d4d
LG
2436 Workspace = os.getenv("WORKSPACE")\r
2437 #\r
2438 # Get files real name in workspace dir\r
2439 #\r
2440 GlobalData.gAllFiles = Utils.DirCache(Workspace)\r
2441\r
2442 WorkingDirectory = os.getcwd()\r
2443 if not Option.ModuleFile:\r
2444 FileList = glob.glob(os.path.normpath(os.path.join(WorkingDirectory, '*.inf')))\r
2445 FileNum = len(FileList)\r
2446 if FileNum >= 2:\r
2447 EdkLogger.error("build", OPTION_NOT_SUPPORTED, "There are %d INF files in %s." % (FileNum, WorkingDirectory),\r
2448 ExtraData="Please use '-m <INF_FILE_PATH>' switch to choose one.")\r
2449 elif FileNum == 1:\r
2450 Option.ModuleFile = NormFile(FileList[0], Workspace)\r
2451\r
2452 if Option.ModuleFile:\r
2453 if os.path.isabs (Option.ModuleFile):\r
2454 if os.path.normcase (os.path.normpath(Option.ModuleFile)).find (Workspace) == 0:\r
2455 Option.ModuleFile = NormFile(os.path.normpath(Option.ModuleFile), Workspace)\r
2456 Option.ModuleFile = PathClass(Option.ModuleFile, Workspace)\r
2457 ErrorCode, ErrorInfo = Option.ModuleFile.Validate(".inf", False)\r
2458 if ErrorCode != 0:\r
2459 EdkLogger.error("build", ErrorCode, ExtraData=ErrorInfo)\r
2460\r
4231a819 2461 if Option.PlatformFile is not None:\r
52302d4d
LG
2462 if os.path.isabs (Option.PlatformFile):\r
2463 if os.path.normcase (os.path.normpath(Option.PlatformFile)).find (Workspace) == 0:\r
2464 Option.PlatformFile = NormFile(os.path.normpath(Option.PlatformFile), Workspace)\r
2465 Option.PlatformFile = PathClass(Option.PlatformFile, Workspace)\r
52302d4d 2466\r
4231a819 2467 if Option.FdfFile is not None:\r
52302d4d
LG
2468 if os.path.isabs (Option.FdfFile):\r
2469 if os.path.normcase (os.path.normpath(Option.FdfFile)).find (Workspace) == 0:\r
2470 Option.FdfFile = NormFile(os.path.normpath(Option.FdfFile), Workspace)\r
2471 Option.FdfFile = PathClass(Option.FdfFile, Workspace)\r
2472 ErrorCode, ErrorInfo = Option.FdfFile.Validate(".fdf", False)\r
2473 if ErrorCode != 0:\r
2474 EdkLogger.error("build", ErrorCode, ExtraData=ErrorInfo)\r
2475\r
4231a819 2476 if Option.Flag is not None and Option.Flag not in ['-c', '-s']:\r
f3decdc3
LG
2477 EdkLogger.error("build", OPTION_VALUE_INVALID, "UNI flag must be one of -c or -s")\r
2478\r
0d2711a6 2479 MyBuild = Build(Target, Workspace, Option)\r
64b2609f 2480 GlobalData.gCommandLineDefines['ARCH'] = ' '.join(MyBuild.ArchList)\r
f0dc69e6
YZ
2481 if not (MyBuild.LaunchPrebuildFlag and os.path.exists(MyBuild.PlatformBuildPath)):\r
2482 MyBuild.Launch()\r
2f818ed0 2483\r
09ae0f11
YL
2484 #\r
2485 # All job done, no error found and no exception raised\r
2486 #\r
2487 BuildError = False\r
5b0671c1 2488 except FatalError as X:\r
4231a819 2489 if MyBuild is not None:\r
52302d4d
LG
2490 # for multi-thread build exits safely\r
2491 MyBuild.Relinquish()\r
4231a819 2492 if Option is not None and Option.debug is not None:\r
52302d4d
LG
2493 EdkLogger.quiet("(Python %s on %s) " % (platform.python_version(), sys.platform) + traceback.format_exc())\r
2494 ReturnCode = X.args[0]\r
5b0671c1 2495 except Warning as X:\r
52302d4d 2496 # error from Fdf parser\r
4231a819 2497 if MyBuild is not None:\r
52302d4d
LG
2498 # for multi-thread build exits safely\r
2499 MyBuild.Relinquish()\r
4231a819 2500 if Option is not None and Option.debug is not None:\r
52302d4d
LG
2501 EdkLogger.quiet("(Python %s on %s) " % (platform.python_version(), sys.platform) + traceback.format_exc())\r
2502 else:\r
47fea6af 2503 EdkLogger.error(X.ToolName, FORMAT_INVALID, File=X.FileName, Line=X.LineNumber, ExtraData=X.Message, RaiseError=False)\r
52302d4d
LG
2504 ReturnCode = FORMAT_INVALID\r
2505 except KeyboardInterrupt:\r
2506 ReturnCode = ABORT_ERROR\r
4231a819 2507 if Option is not None and Option.debug is not None:\r
52302d4d
LG
2508 EdkLogger.quiet("(Python %s on %s) " % (platform.python_version(), sys.platform) + traceback.format_exc())\r
2509 except:\r
4231a819 2510 if MyBuild is not None:\r
52302d4d
LG
2511 # for multi-thread build exits safely\r
2512 MyBuild.Relinquish()\r
2513\r
2514 # try to get the meta-file from the object causing exception\r
2515 Tb = sys.exc_info()[-1]\r
2516 MetaFile = GlobalData.gProcessingFile\r
4231a819 2517 while Tb is not None:\r
52302d4d
LG
2518 if 'self' in Tb.tb_frame.f_locals and hasattr(Tb.tb_frame.f_locals['self'], 'MetaFile'):\r
2519 MetaFile = Tb.tb_frame.f_locals['self'].MetaFile\r
2520 Tb = Tb.tb_next\r
2521 EdkLogger.error(\r
2522 "\nbuild",\r
2523 CODE_ERROR,\r
2524 "Unknown fatal error when processing [%s]" % MetaFile,\r
c1387446 2525 ExtraData="\n(Please send email to %s for help, attaching following call stack trace!)\n" % MSG_EDKII_MAIL_ADDR,\r
52302d4d
LG
2526 RaiseError=False\r
2527 )\r
d0acc87a 2528 EdkLogger.quiet("(Python %s on %s) " % (platform.python_version(), sys.platform) + traceback.format_exc())\r
52302d4d
LG
2529 ReturnCode = CODE_ERROR\r
2530 finally:\r
2531 Utils.Progressor.Abort()\r
97fa0ee9 2532 Utils.ClearDuplicatedInf()\r
52302d4d
LG
2533\r
2534 if ReturnCode == 0:\r
f0dc69e6 2535 try:\r
91048b0d 2536 MyBuild.LaunchPostbuild()\r
f0dc69e6
YZ
2537 Conclusion = "Done"\r
2538 except:\r
2539 Conclusion = "Failed"\r
52302d4d
LG
2540 elif ReturnCode == ABORT_ERROR:\r
2541 Conclusion = "Aborted"\r
2542 else:\r
2543 Conclusion = "Failed"\r
2544 FinishTime = time.time()\r
4234283c
LG
2545 BuildDuration = time.gmtime(int(round(FinishTime - StartTime)))\r
2546 BuildDurationStr = ""\r
2547 if BuildDuration.tm_yday > 1:\r
47fea6af 2548 BuildDurationStr = time.strftime("%H:%M:%S", BuildDuration) + ", %d day(s)" % (BuildDuration.tm_yday - 1)\r
4234283c
LG
2549 else:\r
2550 BuildDurationStr = time.strftime("%H:%M:%S", BuildDuration)\r
4231a819 2551 if MyBuild is not None:\r
09ae0f11 2552 if not BuildError:\r
1b8eca8b 2553 MyBuild.BuildReport.GenerateReport(BuildDurationStr, LogBuildTime(MyBuild.AutoGenTime), LogBuildTime(MyBuild.MakeTime), LogBuildTime(MyBuild.GenFdsTime))\r
2f818ed0 2554\r
52302d4d 2555 EdkLogger.SetLevel(EdkLogger.QUIET)\r
6780eef1
LG
2556 EdkLogger.quiet("\n- %s -" % Conclusion)\r
2557 EdkLogger.quiet(time.strftime("Build end time: %H:%M:%S, %b.%d %Y", time.localtime()))\r
4234283c 2558 EdkLogger.quiet("Build total time: %s\n" % BuildDurationStr)\r
52302d4d
LG
2559 return ReturnCode\r
2560\r
2561if __name__ == '__main__':\r
2562 r = Main()\r
2563 ## 0-127 is a safe return range, and 1 is a standard default error\r
2564 if r < 0 or r > 127: r = 1\r
2565 sys.exit(r)\r
2566\r