]> git.proxmox.com Git - mirror_edk2.git/blame - BaseTools/Source/Python/build/build.py
CryptoPkg/BaseCryptLib: Wrap OpenSSL HKDF algorithm
[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
5f89bcc4
FB
776 if not os.path.exists(os.path.join(GlobalData.gConfDirectory, '.cache')):\r
777 os.makedirs(os.path.join(GlobalData.gConfDirectory, '.cache'))\r
2f818ed0 778 self.Db = WorkspaceDatabase()\r
97fa0ee9
YL
779 self.BuildDatabase = self.Db.BuildObject\r
780 self.Platform = None\r
40b4e21d 781 self.ToolChainFamily = None\r
52302d4d 782 self.LoadFixAddress = 0\r
0d2711a6 783 self.UniFlag = BuildOptions.Flag\r
a0a2cd1e 784 self.BuildModules = []\r
83397f95 785 self.HashSkipModules = []\r
f0dc69e6
YZ
786 self.Db_Flag = False\r
787 self.LaunchPrebuildFlag = False\r
ccaa7754 788 self.PlatformBuildPath = os.path.join(GlobalData.gConfDirectory, '.cache', '.PlatformBuild')\r
725cdb8f
YZ
789 if BuildOptions.CommandLength:\r
790 GlobalData.gCommandMaxLength = BuildOptions.CommandLength\r
791\r
e56468c0 792 # print dot character during doing some time-consuming work\r
52302d4d 793 self.Progress = Utils.Progressor()\r
52302d4d 794 # print current build environment and configuration\r
0d2711a6 795 EdkLogger.quiet("%-16s = %s" % ("WORKSPACE", os.environ["WORKSPACE"]))\r
f25da33d 796 if "PACKAGES_PATH" in os.environ:\r
f7496d71 797 # WORKSPACE env has been converted before. Print the same path style with WORKSPACE env.\r
f25da33d 798 EdkLogger.quiet("%-16s = %s" % ("PACKAGES_PATH", os.path.normcase(os.path.normpath(os.environ["PACKAGES_PATH"]))))\r
0d2711a6 799 EdkLogger.quiet("%-16s = %s" % ("EDK_TOOLS_PATH", os.environ["EDK_TOOLS_PATH"]))\r
f25da33d 800 if "EDK_TOOLS_BIN" in os.environ:\r
f7496d71 801 # Print the same path style with WORKSPACE env.\r
f25da33d 802 EdkLogger.quiet("%-16s = %s" % ("EDK_TOOLS_BIN", os.path.normcase(os.path.normpath(os.environ["EDK_TOOLS_BIN"]))))\r
00bcb5c2 803 EdkLogger.quiet("%-16s = %s" % ("CONF_PATH", GlobalData.gConfDirectory))\r
fd2d7400
ZF
804 if "PYTHON3_ENABLE" in os.environ:\r
805 PYTHON3_ENABLE = os.environ["PYTHON3_ENABLE"]\r
806 if PYTHON3_ENABLE != "TRUE":\r
807 PYTHON3_ENABLE = "FALSE"\r
808 EdkLogger.quiet("%-16s = %s" % ("PYTHON3_ENABLE", PYTHON3_ENABLE))\r
7aef7b7c
LG
809 if "PYTHON_COMMAND" in os.environ:\r
810 EdkLogger.quiet("%-16s = %s" % ("PYTHON_COMMAND", os.environ["PYTHON_COMMAND"]))\r
f0dc69e6
YZ
811 self.InitPreBuild()\r
812 self.InitPostBuild()\r
af9c4e5e
MK
813 if self.Prebuild:\r
814 EdkLogger.quiet("%-16s = %s" % ("PREBUILD", self.Prebuild))\r
815 if self.Postbuild:\r
816 EdkLogger.quiet("%-16s = %s" % ("POSTBUILD", self.Postbuild))\r
817 if self.Prebuild:\r
f0dc69e6 818 self.LaunchPrebuild()\r
a0c9ce31
YZ
819 self.TargetTxt = TargetTxtClassObject()\r
820 self.ToolDef = ToolDefClassObject()\r
f0dc69e6
YZ
821 if not (self.LaunchPrebuildFlag and os.path.exists(self.PlatformBuildPath)):\r
822 self.InitBuild()\r
52302d4d 823\r
f0dc69e6 824 EdkLogger.info("")\r
52302d4d 825 os.chdir(self.WorkspaceDir)\r
52302d4d
LG
826\r
827 ## Load configuration\r
828 #\r
829 # This method will parse target.txt and get the build configurations.\r
830 #\r
831 def LoadConfiguration(self):\r
832 #\r
833 # Check target.txt and tools_def.txt and Init them\r
834 #\r
97fa0ee9 835 BuildConfigurationFile = os.path.normpath(os.path.join(GlobalData.gConfDirectory, gBuildConfiguration))\r
52302d4d
LG
836 if os.path.isfile(BuildConfigurationFile) == True:\r
837 StatusCode = self.TargetTxt.LoadTargetTxtFile(BuildConfigurationFile)\r
838\r
938cf4c3 839 ToolDefinitionFile = self.TargetTxt.TargetTxtDictionary[TAB_TAT_DEFINES_TOOL_CHAIN_CONF]\r
52302d4d
LG
840 if ToolDefinitionFile == '':\r
841 ToolDefinitionFile = gToolsDefinition\r
05cc51ad 842 ToolDefinitionFile = os.path.normpath(mws.join(self.WorkspaceDir, 'Conf', ToolDefinitionFile))\r
52302d4d
LG
843 if os.path.isfile(ToolDefinitionFile) == True:\r
844 StatusCode = self.ToolDef.LoadToolDefFile(ToolDefinitionFile)\r
845 else:\r
846 EdkLogger.error("build", FILE_NOT_FOUND, ExtraData=ToolDefinitionFile)\r
847 else:\r
848 EdkLogger.error("build", FILE_NOT_FOUND, ExtraData=BuildConfigurationFile)\r
849\r
850 # if no ARCH given in command line, get it from target.txt\r
0d2711a6 851 if not self.ArchList:\r
938cf4c3 852 self.ArchList = self.TargetTxt.TargetTxtDictionary[TAB_TAT_DEFINES_TARGET_ARCH]\r
0d2711a6 853 self.ArchList = tuple(self.ArchList)\r
52302d4d
LG
854\r
855 # if no build target given in command line, get it from target.txt\r
0d2711a6 856 if not self.BuildTargetList:\r
938cf4c3 857 self.BuildTargetList = self.TargetTxt.TargetTxtDictionary[TAB_TAT_DEFINES_TARGET]\r
52302d4d
LG
858\r
859 # if no tool chain given in command line, get it from target.txt\r
0d2711a6 860 if not self.ToolChainList:\r
938cf4c3 861 self.ToolChainList = self.TargetTxt.TargetTxtDictionary[TAB_TAT_DEFINES_TOOL_CHAIN_TAG]\r
4231a819 862 if self.ToolChainList is None or len(self.ToolChainList) == 0:\r
52302d4d
LG
863 EdkLogger.error("build", RESOURCE_NOT_AVAILABLE, ExtraData="No toolchain given. Don't know how to build.\n")\r
864\r
865 # check if the tool chains are defined or not\r
866 NewToolChainList = []\r
867 for ToolChain in self.ToolChainList:\r
868 if ToolChain not in self.ToolDef.ToolsDefTxtDatabase[TAB_TOD_DEFINES_TOOL_CHAIN_TAG]:\r
869 EdkLogger.warn("build", "Tool chain [%s] is not defined" % ToolChain)\r
870 else:\r
871 NewToolChainList.append(ToolChain)\r
872 # if no tool chain available, break the build\r
873 if len(NewToolChainList) == 0:\r
874 EdkLogger.error("build", RESOURCE_NOT_AVAILABLE,\r
875 ExtraData="[%s] not defined. No toolchain available for build!\n" % ", ".join(self.ToolChainList))\r
876 else:\r
877 self.ToolChainList = NewToolChainList\r
878\r
40b4e21d
YZ
879 ToolChainFamily = []\r
880 ToolDefinition = self.ToolDef.ToolsDefTxtDatabase\r
881 for Tool in self.ToolChainList:\r
882 if TAB_TOD_DEFINES_FAMILY not in ToolDefinition or Tool not in ToolDefinition[TAB_TOD_DEFINES_FAMILY] \\r
883 or not ToolDefinition[TAB_TOD_DEFINES_FAMILY][Tool]:\r
688c7d21 884 EdkLogger.warn("build", "No tool chain family found in configuration for %s. Default to MSFT." % Tool)\r
94c04559 885 ToolChainFamily.append(TAB_COMPILER_MSFT)\r
40b4e21d
YZ
886 else:\r
887 ToolChainFamily.append(ToolDefinition[TAB_TOD_DEFINES_FAMILY][Tool])\r
888 self.ToolChainFamily = ToolChainFamily\r
889\r
4231a819 890 if self.ThreadNumber is None:\r
938cf4c3 891 self.ThreadNumber = self.TargetTxt.TargetTxtDictionary[TAB_TAT_DEFINES_MAX_CONCURRENT_THREAD_NUMBER]\r
52302d4d
LG
892 if self.ThreadNumber == '':\r
893 self.ThreadNumber = 0\r
894 else:\r
895 self.ThreadNumber = int(self.ThreadNumber, 0)\r
896\r
897 if self.ThreadNumber == 0:\r
29af38b0
YF
898 try:\r
899 self.ThreadNumber = multiprocessing.cpu_count()\r
900 except (ImportError, NotImplementedError):\r
901 self.ThreadNumber = 1\r
52302d4d
LG
902\r
903 if not self.PlatformFile:\r
938cf4c3 904 PlatformFile = self.TargetTxt.TargetTxtDictionary[TAB_TAT_DEFINES_ACTIVE_PLATFORM]\r
52302d4d
LG
905 if not PlatformFile:\r
906 # Try to find one in current directory\r
907 WorkingDirectory = os.getcwd()\r
908 FileList = glob.glob(os.path.normpath(os.path.join(WorkingDirectory, '*.dsc')))\r
909 FileNum = len(FileList)\r
910 if FileNum >= 2:\r
911 EdkLogger.error("build", OPTION_MISSING,\r
912 ExtraData="There are %d DSC files in %s. Use '-p' to specify one.\n" % (FileNum, WorkingDirectory))\r
913 elif FileNum == 1:\r
914 PlatformFile = FileList[0]\r
915 else:\r
916 EdkLogger.error("build", RESOURCE_NOT_AVAILABLE,\r
917 ExtraData="No active platform specified in target.txt or command line! Nothing can be built.\n")\r
918\r
919 self.PlatformFile = PathClass(NormFile(PlatformFile, self.WorkspaceDir), self.WorkspaceDir)\r
52302d4d
LG
920\r
921 ## Initialize build configuration\r
922 #\r
923 # This method will parse DSC file and merge the configurations from\r
924 # command line and target.txt, then get the final build configurations.\r
925 #\r
926 def InitBuild(self):\r
0d2711a6 927 # parse target.txt, tools_def.txt, and platform file\r
4afd3d04 928 self.LoadConfiguration()\r
0d2711a6
LG
929\r
930 # Allow case-insensitive for those from command line or configuration file\r
931 ErrorCode, ErrorInfo = self.PlatformFile.Validate(".dsc", False)\r
52302d4d
LG
932 if ErrorCode != 0:\r
933 EdkLogger.error("build", ErrorCode, ExtraData=ErrorInfo)\r
934\r
f0dc69e6
YZ
935\r
936 def InitPreBuild(self):\r
937 self.LoadConfiguration()\r
d429fcd0
YZ
938 ErrorCode, ErrorInfo = self.PlatformFile.Validate(".dsc", False)\r
939 if ErrorCode != 0:\r
940 EdkLogger.error("build", ErrorCode, ExtraData=ErrorInfo)\r
f0dc69e6
YZ
941 if self.BuildTargetList:\r
942 GlobalData.gGlobalDefines['TARGET'] = self.BuildTargetList[0]\r
943 if self.ArchList:\r
944 GlobalData.gGlobalDefines['ARCH'] = self.ArchList[0]\r
945 if self.ToolChainList:\r
946 GlobalData.gGlobalDefines['TOOLCHAIN'] = self.ToolChainList[0]\r
947 GlobalData.gGlobalDefines['TOOL_CHAIN_TAG'] = self.ToolChainList[0]\r
40b4e21d
YZ
948 if self.ToolChainFamily:\r
949 GlobalData.gGlobalDefines['FAMILY'] = self.ToolChainFamily[0]\r
9eb87141 950 if 'PREBUILD' in GlobalData.gCommandLineDefines:\r
f0dc69e6
YZ
951 self.Prebuild = GlobalData.gCommandLineDefines.get('PREBUILD')\r
952 else:\r
f0dc69e6 953 self.Db_Flag = True\r
71cac3f7 954 Platform = self.Db.MapPlatform(str(self.PlatformFile))\r
f0dc69e6
YZ
955 self.Prebuild = str(Platform.Prebuild)\r
956 if self.Prebuild:\r
af9c4e5e
MK
957 PrebuildList = []\r
958 #\r
959 # Evaluate all arguments and convert arguments that are WORKSPACE\r
960 # relative paths to absolute paths. Filter arguments that look like\r
961 # flags or do not follow the file/dir naming rules to avoid false\r
962 # positives on this conversion.\r
963 #\r
964 for Arg in self.Prebuild.split():\r
965 #\r
966 # Do not modify Arg if it looks like a flag or an absolute file path\r
967 #\r
968 if Arg.startswith('-') or os.path.isabs(Arg):\r
969 PrebuildList.append(Arg)\r
970 continue\r
971 #\r
972 # Do not modify Arg if it does not look like a Workspace relative\r
973 # path that starts with a valid package directory name\r
974 #\r
975 if not Arg[0].isalpha() or os.path.dirname(Arg) == '':\r
976 PrebuildList.append(Arg)\r
977 continue\r
978 #\r
979 # If Arg looks like a WORKSPACE relative path, then convert to an\r
980 # absolute path and check to see if the file exists.\r
981 #\r
982 Temp = mws.join(self.WorkspaceDir, Arg)\r
983 if os.path.isfile(Temp):\r
984 Arg = Temp\r
985 PrebuildList.append(Arg)\r
986 self.Prebuild = ' '.join(PrebuildList)\r
987 self.Prebuild += self.PassCommandOption(self.BuildTargetList, self.ArchList, self.ToolChainList, self.PlatformFile, self.Target)\r
52302d4d 988\r
f0dc69e6 989 def InitPostBuild(self):\r
9eb87141 990 if 'POSTBUILD' in GlobalData.gCommandLineDefines:\r
f0dc69e6
YZ
991 self.Postbuild = GlobalData.gCommandLineDefines.get('POSTBUILD')\r
992 else:\r
71cac3f7 993 Platform = self.Db.MapPlatform(str(self.PlatformFile))\r
f0dc69e6
YZ
994 self.Postbuild = str(Platform.Postbuild)\r
995 if self.Postbuild:\r
af9c4e5e
MK
996 PostbuildList = []\r
997 #\r
998 # Evaluate all arguments and convert arguments that are WORKSPACE\r
999 # relative paths to absolute paths. Filter arguments that look like\r
1000 # flags or do not follow the file/dir naming rules to avoid false\r
1001 # positives on this conversion.\r
1002 #\r
1003 for Arg in self.Postbuild.split():\r
1004 #\r
1005 # Do not modify Arg if it looks like a flag or an absolute file path\r
1006 #\r
1007 if Arg.startswith('-') or os.path.isabs(Arg):\r
1008 PostbuildList.append(Arg)\r
1009 continue\r
1010 #\r
1011 # Do not modify Arg if it does not look like a Workspace relative\r
1012 # path that starts with a valid package directory name\r
1013 #\r
1014 if not Arg[0].isalpha() or os.path.dirname(Arg) == '':\r
1015 PostbuildList.append(Arg)\r
1016 continue\r
1017 #\r
1018 # If Arg looks like a WORKSPACE relative path, then convert to an\r
1019 # absolute path and check to see if the file exists.\r
1020 #\r
1021 Temp = mws.join(self.WorkspaceDir, Arg)\r
1022 if os.path.isfile(Temp):\r
1023 Arg = Temp\r
1024 PostbuildList.append(Arg)\r
1025 self.Postbuild = ' '.join(PostbuildList)\r
1026 self.Postbuild += self.PassCommandOption(self.BuildTargetList, self.ArchList, self.ToolChainList, self.PlatformFile, self.Target)\r
1027\r
1028 def PassCommandOption(self, BuildTarget, TargetArch, ToolChain, PlatformFile, Target):\r
f0dc69e6
YZ
1029 BuildStr = ''\r
1030 if GlobalData.gCommand and isinstance(GlobalData.gCommand, list):\r
1031 BuildStr += ' ' + ' '.join(GlobalData.gCommand)\r
1032 TargetFlag = False\r
1033 ArchFlag = False\r
1034 ToolChainFlag = False\r
af9c4e5e 1035 PlatformFileFlag = False\r
f0dc69e6
YZ
1036\r
1037 if GlobalData.gOptions and not GlobalData.gOptions.BuildTarget:\r
1038 TargetFlag = True\r
1039 if GlobalData.gOptions and not GlobalData.gOptions.TargetArch:\r
1040 ArchFlag = True\r
1041 if GlobalData.gOptions and not GlobalData.gOptions.ToolChain:\r
1042 ToolChainFlag = True\r
af9c4e5e
MK
1043 if GlobalData.gOptions and not GlobalData.gOptions.PlatformFile:\r
1044 PlatformFileFlag = True\r
f0dc69e6
YZ
1045\r
1046 if TargetFlag and BuildTarget:\r
1047 if isinstance(BuildTarget, list) or isinstance(BuildTarget, tuple):\r
1048 BuildStr += ' -b ' + ' -b '.join(BuildTarget)\r
1049 elif isinstance(BuildTarget, str):\r
1050 BuildStr += ' -b ' + BuildTarget\r
1051 if ArchFlag and TargetArch:\r
1052 if isinstance(TargetArch, list) or isinstance(TargetArch, tuple):\r
1053 BuildStr += ' -a ' + ' -a '.join(TargetArch)\r
1054 elif isinstance(TargetArch, str):\r
1055 BuildStr += ' -a ' + TargetArch\r
1056 if ToolChainFlag and ToolChain:\r
1057 if isinstance(ToolChain, list) or isinstance(ToolChain, tuple):\r
1058 BuildStr += ' -t ' + ' -t '.join(ToolChain)\r
1059 elif isinstance(ToolChain, str):\r
1060 BuildStr += ' -t ' + ToolChain\r
af9c4e5e
MK
1061 if PlatformFileFlag and PlatformFile:\r
1062 if isinstance(PlatformFile, list) or isinstance(PlatformFile, tuple):\r
1063 BuildStr += ' -p ' + ' -p '.join(PlatformFile)\r
1064 elif isinstance(PlatformFile, str):\r
1065 BuildStr += ' -p' + PlatformFile\r
1066 BuildStr += ' --conf=' + GlobalData.gConfDirectory\r
1067 if Target:\r
1068 BuildStr += ' ' + Target\r
f0dc69e6
YZ
1069\r
1070 return BuildStr\r
1071\r
1072 def LaunchPrebuild(self):\r
1073 if self.Prebuild:\r
1074 EdkLogger.info("\n- Prebuild Start -\n")\r
1075 self.LaunchPrebuildFlag = True\r
134bbe88
YZ
1076 #\r
1077 # The purpose of .PrebuildEnv file is capture environment variable settings set by the prebuild script\r
1078 # and preserve them for the rest of the main build step, because the child process environment will\r
1079 # evaporate as soon as it exits, we cannot get it in build step.\r
1080 #\r
ccaa7754 1081 PrebuildEnvFile = os.path.join(GlobalData.gConfDirectory, '.cache', '.PrebuildEnv')\r
f0dc69e6
YZ
1082 if os.path.isfile(PrebuildEnvFile):\r
1083 os.remove(PrebuildEnvFile)\r
1084 if os.path.isfile(self.PlatformBuildPath):\r
1085 os.remove(self.PlatformBuildPath)\r
1086 if sys.platform == "win32":\r
1087 args = ' && '.join((self.Prebuild, 'set > ' + PrebuildEnvFile))\r
b926f2f2 1088 Process = Popen(args, stdout=PIPE, stderr=PIPE, shell=True)\r
f0dc69e6
YZ
1089 else:\r
1090 args = ' && '.join((self.Prebuild, 'env > ' + PrebuildEnvFile))\r
34816e7e 1091 Process = Popen(args, stdout=PIPE, stderr=PIPE, shell=True)\r
f0dc69e6
YZ
1092\r
1093 # launch two threads to read the STDOUT and STDERR\r
1094 EndOfProcedure = Event()\r
1095 EndOfProcedure.clear()\r
1096 if Process.stdout:\r
1097 StdOutThread = Thread(target=ReadMessage, args=(Process.stdout, EdkLogger.info, EndOfProcedure))\r
1098 StdOutThread.setName("STDOUT-Redirector")\r
1099 StdOutThread.setDaemon(False)\r
1100 StdOutThread.start()\r
1101\r
1102 if Process.stderr:\r
1103 StdErrThread = Thread(target=ReadMessage, args=(Process.stderr, EdkLogger.quiet, EndOfProcedure))\r
1104 StdErrThread.setName("STDERR-Redirector")\r
1105 StdErrThread.setDaemon(False)\r
1106 StdErrThread.start()\r
1107 # waiting for program exit\r
1108 Process.wait()\r
1109\r
1110 if Process.stdout:\r
1111 StdOutThread.join()\r
1112 if Process.stderr:\r
1113 StdErrThread.join()\r
1114 if Process.returncode != 0 :\r
1115 EdkLogger.error("Prebuild", PREBUILD_ERROR, 'Prebuild process is not success!')\r
1116\r
1117 if os.path.exists(PrebuildEnvFile):\r
1118 f = open(PrebuildEnvFile)\r
1119 envs = f.readlines()\r
1120 f.close()\r
2f28dca1
ZF
1121 envs = [l.split("=", 1) for l in envs ]\r
1122 envs = [[I.strip() for I in item] for item in envs if len(item) == 2]\r
f0dc69e6
YZ
1123 os.environ.update(dict(envs))\r
1124 EdkLogger.info("\n- Prebuild Done -\n")\r
1125\r
91048b0d 1126 def LaunchPostbuild(self):\r
f0dc69e6
YZ
1127 if self.Postbuild:\r
1128 EdkLogger.info("\n- Postbuild Start -\n")\r
1129 if sys.platform == "win32":\r
b926f2f2 1130 Process = Popen(self.Postbuild, stdout=PIPE, stderr=PIPE, shell=True)\r
f0dc69e6 1131 else:\r
34816e7e 1132 Process = Popen(self.Postbuild, stdout=PIPE, stderr=PIPE, shell=True)\r
f0dc69e6
YZ
1133 # launch two threads to read the STDOUT and STDERR\r
1134 EndOfProcedure = Event()\r
1135 EndOfProcedure.clear()\r
1136 if Process.stdout:\r
1137 StdOutThread = Thread(target=ReadMessage, args=(Process.stdout, EdkLogger.info, EndOfProcedure))\r
1138 StdOutThread.setName("STDOUT-Redirector")\r
1139 StdOutThread.setDaemon(False)\r
1140 StdOutThread.start()\r
1141\r
1142 if Process.stderr:\r
1143 StdErrThread = Thread(target=ReadMessage, args=(Process.stderr, EdkLogger.quiet, EndOfProcedure))\r
1144 StdErrThread.setName("STDERR-Redirector")\r
1145 StdErrThread.setDaemon(False)\r
1146 StdErrThread.start()\r
1147 # waiting for program exit\r
1148 Process.wait()\r
1149\r
1150 if Process.stdout:\r
1151 StdOutThread.join()\r
1152 if Process.stderr:\r
1153 StdErrThread.join()\r
1154 if Process.returncode != 0 :\r
1155 EdkLogger.error("Postbuild", POSTBUILD_ERROR, 'Postbuild process is not success!')\r
1156 EdkLogger.info("\n- Postbuild Done -\n")\r
0eccea3f
RC
1157\r
1158 ## Error handling for hash feature\r
1159 #\r
1160 # On BuildTask error, iterate through the Module Build tracking\r
1161 # dictionary to determine wheather a module failed to build. Invalidate\r
1162 # the hash associated with that module by removing it from storage.\r
1163 #\r
1164 #\r
1165 def invalidateHash(self):\r
48b0bf64
RC
1166 # Only for hashing feature\r
1167 if not GlobalData.gUseHashCache:\r
1168 return\r
1169\r
1170 # GlobalData.gModuleBuildTracking contains only modules or libs that cannot be skipped by hash\r
1171 for moduleAutoGenObjArch in GlobalData.gModuleBuildTracking.keys():\r
1172 for moduleAutoGenObj in GlobalData.gModuleBuildTracking[moduleAutoGenObjArch].keys():\r
1173 # Skip invalidating for Successful Module/Lib builds\r
1174 if GlobalData.gModuleBuildTracking[moduleAutoGenObjArch][moduleAutoGenObj] == 'SUCCESS':\r
1175 continue\r
0eccea3f 1176\r
48b0bf64 1177 # The module failed to build, failed to start building, or failed the header check test from this point on\r
0eccea3f 1178\r
48b0bf64
RC
1179 # Remove .hash from build\r
1180 ModuleHashFile = os.path.join(moduleAutoGenObj.BuildDir, moduleAutoGenObj.Name + ".hash")\r
0eccea3f
RC
1181 if os.path.exists(ModuleHashFile):\r
1182 os.remove(ModuleHashFile)\r
1183\r
48b0bf64
RC
1184 # Remove .hash file from cache\r
1185 if GlobalData.gBinCacheDest:\r
1186 FileDir = os.path.join(GlobalData.gBinCacheDest, moduleAutoGenObj.Arch, moduleAutoGenObj.SourceDir, moduleAutoGenObj.MetaFile.BaseName)\r
1187 HashFile = os.path.join(FileDir, moduleAutoGenObj.Name + '.hash')\r
1188 if os.path.exists(HashFile):\r
1189 os.remove(HashFile)\r
0eccea3f 1190\r
52302d4d
LG
1191 ## Build a module or platform\r
1192 #\r
08dd311f 1193 # Create autogen code and makefile for a module or platform, and the launch\r
52302d4d
LG
1194 # "make" command to build it\r
1195 #\r
1196 # @param Target The target of build command\r
1197 # @param Platform The platform file\r
1198 # @param Module The module file\r
1199 # @param BuildTarget The name of build target, one of "DEBUG", "RELEASE"\r
1200 # @param ToolChain The name of toolchain to build\r
1201 # @param Arch The arch of the module/platform\r
1202 # @param CreateDepModuleCodeFile Flag used to indicate creating code\r
1203 # for dependent modules/Libraries\r
1204 # @param CreateDepModuleMakeFile Flag used to indicate creating makefile\r
1205 # for dependent modules/Libraries\r
1206 #\r
37de70b7 1207 def _BuildPa(self, Target, AutoGenObject, CreateDepsCodeFile=True, CreateDepsMakeFile=True, BuildModule=False, FfsCommand={}):\r
4231a819 1208 if AutoGenObject is None:\r
52302d4d
LG
1209 return False\r
1210\r
1211 # skip file generation for cleanxxx targets, run and fds target\r
1212 if Target not in ['clean', 'cleanlib', 'cleanall', 'run', 'fds']:\r
1213 # for target which must generate AutoGen code and makefile\r
1214 if not self.SkipAutoGen or Target == 'genc':\r
1215 self.Progress.Start("Generating code")\r
1216 AutoGenObject.CreateCodeFile(CreateDepsCodeFile)\r
1217 self.Progress.Stop("done!")\r
1218 if Target == "genc":\r
1219 return True\r
1220\r
1221 if not self.SkipAutoGen or Target == 'genmake':\r
1222 self.Progress.Start("Generating makefile")\r
37de70b7 1223 AutoGenObject.CreateMakeFile(CreateDepsMakeFile, FfsCommand)\r
52302d4d
LG
1224 self.Progress.Stop("done!")\r
1225 if Target == "genmake":\r
1226 return True\r
1227 else:\r
1228 # always recreate top/platform makefile when clean, just in case of inconsistency\r
1229 AutoGenObject.CreateCodeFile(False)\r
1230 AutoGenObject.CreateMakeFile(False)\r
1231\r
1232 if EdkLogger.GetLevel() == EdkLogger.QUIET:\r
1233 EdkLogger.quiet("Building ... %s" % repr(AutoGenObject))\r
1234\r
1235 BuildCommand = AutoGenObject.BuildCommand\r
4231a819 1236 if BuildCommand is None or len(BuildCommand) == 0:\r
0d2711a6
LG
1237 EdkLogger.error("build", OPTION_MISSING,\r
1238 "No build command found for this module. "\r
4afd3d04 1239 "Please check your setting of %s_%s_%s_MAKE_PATH in Conf/tools_def.txt file." %\r
0d2711a6
LG
1240 (AutoGenObject.BuildTarget, AutoGenObject.ToolChain, AutoGenObject.Arch),\r
1241 ExtraData=str(AutoGenObject))\r
52302d4d 1242\r
03af2753
HC
1243 makefile = GenMake.BuildFile(AutoGenObject)._FILE_NAME_[GenMake.gMakeType]\r
1244\r
03af2753
HC
1245 # run\r
1246 if Target == 'run':\r
03af2753
HC
1247 return True\r
1248\r
1249 # build modules\r
1250 if BuildModule:\r
1251 BuildCommand = BuildCommand + [Target]\r
1252 LaunchCommand(BuildCommand, AutoGenObject.MakeFileDir)\r
a0a2cd1e 1253 self.CreateAsBuiltInf()\r
b8ac0b7f
BF
1254 if GlobalData.gBinCacheDest:\r
1255 self.UpdateBuildCache()\r
1256 self.BuildModules = []\r
03af2753
HC
1257 return True\r
1258\r
1259 # build library\r
1260 if Target == 'libraries':\r
1261 for Lib in AutoGenObject.LibraryBuildDirectoryList:\r
1262 NewBuildCommand = BuildCommand + ['-f', os.path.normpath(os.path.join(Lib, makefile)), 'pbuild']\r
1263 LaunchCommand(NewBuildCommand, AutoGenObject.MakeFileDir)\r
1264 return True\r
1265\r
1266 # build module\r
1267 if Target == 'modules':\r
1268 for Lib in AutoGenObject.LibraryBuildDirectoryList:\r
1269 NewBuildCommand = BuildCommand + ['-f', os.path.normpath(os.path.join(Lib, makefile)), 'pbuild']\r
1270 LaunchCommand(NewBuildCommand, AutoGenObject.MakeFileDir)\r
1271 for Mod in AutoGenObject.ModuleBuildDirectoryList:\r
1272 NewBuildCommand = BuildCommand + ['-f', os.path.normpath(os.path.join(Mod, makefile)), 'pbuild']\r
1273 LaunchCommand(NewBuildCommand, AutoGenObject.MakeFileDir)\r
a0a2cd1e 1274 self.CreateAsBuiltInf()\r
b8ac0b7f
BF
1275 if GlobalData.gBinCacheDest:\r
1276 self.UpdateBuildCache()\r
1277 self.BuildModules = []\r
03af2753
HC
1278 return True\r
1279\r
1280 # cleanlib\r
1281 if Target == 'cleanlib':\r
1282 for Lib in AutoGenObject.LibraryBuildDirectoryList:\r
1283 LibMakefile = os.path.normpath(os.path.join(Lib, makefile))\r
1284 if os.path.exists(LibMakefile):\r
1285 NewBuildCommand = BuildCommand + ['-f', LibMakefile, 'cleanall']\r
1286 LaunchCommand(NewBuildCommand, AutoGenObject.MakeFileDir)\r
1287 return True\r
1288\r
1289 # clean\r
1290 if Target == 'clean':\r
1291 for Mod in AutoGenObject.ModuleBuildDirectoryList:\r
1292 ModMakefile = os.path.normpath(os.path.join(Mod, makefile))\r
1293 if os.path.exists(ModMakefile):\r
1294 NewBuildCommand = BuildCommand + ['-f', ModMakefile, 'cleanall']\r
1295 LaunchCommand(NewBuildCommand, AutoGenObject.MakeFileDir)\r
1296 for Lib in AutoGenObject.LibraryBuildDirectoryList:\r
1297 LibMakefile = os.path.normpath(os.path.join(Lib, makefile))\r
1298 if os.path.exists(LibMakefile):\r
1299 NewBuildCommand = BuildCommand + ['-f', LibMakefile, 'cleanall']\r
1300 LaunchCommand(NewBuildCommand, AutoGenObject.MakeFileDir)\r
1301 return True\r
1302\r
1303 # cleanall\r
1304 if Target == 'cleanall':\r
1305 try:\r
1306 #os.rmdir(AutoGenObject.BuildDir)\r
1307 RemoveDirectory(AutoGenObject.BuildDir, True)\r
5b0671c1 1308 except WindowsError as X:\r
03af2753
HC
1309 EdkLogger.error("build", FILE_DELETE_FAILURE, ExtraData=str(X))\r
1310 return True\r
1311\r
1312 ## Build a module or platform\r
1313 #\r
1314 # Create autogen code and makefile for a module or platform, and the launch\r
1315 # "make" command to build it\r
1316 #\r
1317 # @param Target The target of build command\r
1318 # @param Platform The platform file\r
1319 # @param Module The module file\r
1320 # @param BuildTarget The name of build target, one of "DEBUG", "RELEASE"\r
1321 # @param ToolChain The name of toolchain to build\r
1322 # @param Arch The arch of the module/platform\r
1323 # @param CreateDepModuleCodeFile Flag used to indicate creating code\r
1324 # for dependent modules/Libraries\r
1325 # @param CreateDepModuleMakeFile Flag used to indicate creating makefile\r
1326 # for dependent modules/Libraries\r
1327 #\r
1328 def _Build(self, Target, AutoGenObject, CreateDepsCodeFile=True, CreateDepsMakeFile=True, BuildModule=False):\r
4231a819 1329 if AutoGenObject is None:\r
03af2753
HC
1330 return False\r
1331\r
1332 # skip file generation for cleanxxx targets, run and fds target\r
1333 if Target not in ['clean', 'cleanlib', 'cleanall', 'run', 'fds']:\r
1334 # for target which must generate AutoGen code and makefile\r
1335 if not self.SkipAutoGen or Target == 'genc':\r
1336 self.Progress.Start("Generating code")\r
1337 AutoGenObject.CreateCodeFile(CreateDepsCodeFile)\r
1338 self.Progress.Stop("done!")\r
1339 if Target == "genc":\r
1340 return True\r
1341\r
1342 if not self.SkipAutoGen or Target == 'genmake':\r
1343 self.Progress.Start("Generating makefile")\r
1344 AutoGenObject.CreateMakeFile(CreateDepsMakeFile)\r
1345 #AutoGenObject.CreateAsBuiltInf()\r
1346 self.Progress.Stop("done!")\r
1347 if Target == "genmake":\r
1348 return True\r
1349 else:\r
1350 # always recreate top/platform makefile when clean, just in case of inconsistency\r
1351 AutoGenObject.CreateCodeFile(False)\r
1352 AutoGenObject.CreateMakeFile(False)\r
1353\r
1354 if EdkLogger.GetLevel() == EdkLogger.QUIET:\r
1355 EdkLogger.quiet("Building ... %s" % repr(AutoGenObject))\r
1356\r
1357 BuildCommand = AutoGenObject.BuildCommand\r
4231a819 1358 if BuildCommand is None or len(BuildCommand) == 0:\r
03af2753
HC
1359 EdkLogger.error("build", OPTION_MISSING,\r
1360 "No build command found for this module. "\r
1361 "Please check your setting of %s_%s_%s_MAKE_PATH in Conf/tools_def.txt file." %\r
1362 (AutoGenObject.BuildTarget, AutoGenObject.ToolChain, AutoGenObject.Arch),\r
1363 ExtraData=str(AutoGenObject))\r
1364\r
b0e23cf3
YL
1365 # build modules\r
1366 if BuildModule:\r
1367 if Target != 'fds':\r
1368 BuildCommand = BuildCommand + [Target]\r
1b8eca8b 1369 AutoGenObject.BuildTime = LaunchCommand(BuildCommand, AutoGenObject.MakeFileDir)\r
b0e23cf3 1370 self.CreateAsBuiltInf()\r
b8ac0b7f
BF
1371 if GlobalData.gBinCacheDest:\r
1372 self.UpdateBuildCache()\r
1373 self.BuildModules = []\r
b0e23cf3
YL
1374 return True\r
1375\r
03af2753
HC
1376 # genfds\r
1377 if Target == 'fds':\r
370544d1
DL
1378 if GenFdsApi(AutoGenObject.GenFdsCommandDict, self.Db):\r
1379 EdkLogger.error("build", COMMAND_FAILURE)\r
03af2753
HC
1380 return True\r
1381\r
1382 # run\r
1383 if Target == 'run':\r
03af2753
HC
1384 return True\r
1385\r
03af2753
HC
1386 # build library\r
1387 if Target == 'libraries':\r
1388 pass\r
1389\r
1390 # not build modules\r
1391\r
1392\r
1393 # cleanall\r
52302d4d
LG
1394 if Target == 'cleanall':\r
1395 try:\r
1396 #os.rmdir(AutoGenObject.BuildDir)\r
1397 RemoveDirectory(AutoGenObject.BuildDir, True)\r
5b0671c1 1398 except WindowsError as X:\r
52302d4d
LG
1399 EdkLogger.error("build", FILE_DELETE_FAILURE, ExtraData=str(X))\r
1400 return True\r
1401\r
6780eef1 1402 ## Rebase module image and Get function address for the input module list.\r
52302d4d
LG
1403 #\r
1404 def _RebaseModule (self, MapBuffer, BaseAddress, ModuleList, AddrIsOffset = True, ModeIsSmm = False):\r
1405 if ModeIsSmm:\r
1406 AddrIsOffset = False\r
98120f5f 1407 for InfFile in ModuleList:\r
da92f276
LG
1408 sys.stdout.write (".")\r
1409 sys.stdout.flush()\r
52302d4d
LG
1410 ModuleInfo = ModuleList[InfFile]\r
1411 ModuleName = ModuleInfo.BaseName\r
f3decdc3
LG
1412 ModuleOutputImage = ModuleInfo.Image.FileName\r
1413 ModuleDebugImage = os.path.join(ModuleInfo.DebugDir, ModuleInfo.BaseName + '.efi')\r
52302d4d
LG
1414 ## for SMM module in SMRAM, the SMRAM will be allocated from base to top.\r
1415 if not ModeIsSmm:\r
1416 BaseAddress = BaseAddress - ModuleInfo.Image.Size\r
1417 #\r
1418 # Update Image to new BaseAddress by GenFw tool\r
1419 #\r
f3decdc3 1420 LaunchCommand(["GenFw", "--rebase", str(BaseAddress), "-r", ModuleOutputImage], ModuleInfo.OutputDir)\r
47fea6af 1421 LaunchCommand(["GenFw", "--rebase", str(BaseAddress), "-r", ModuleDebugImage], ModuleInfo.DebugDir)\r
52302d4d
LG
1422 else:\r
1423 #\r
1424 # Set new address to the section header only for SMM driver.\r
1425 #\r
f3decdc3 1426 LaunchCommand(["GenFw", "--address", str(BaseAddress), "-r", ModuleOutputImage], ModuleInfo.OutputDir)\r
47fea6af 1427 LaunchCommand(["GenFw", "--address", str(BaseAddress), "-r", ModuleDebugImage], ModuleInfo.DebugDir)\r
52302d4d 1428 #\r
fb0b35e0 1429 # Collect function address from Map file\r
52302d4d 1430 #\r
f3decdc3 1431 ImageMapTable = ModuleOutputImage.replace('.efi', '.map')\r
52302d4d
LG
1432 FunctionList = []\r
1433 if os.path.exists(ImageMapTable):\r
1434 OrigImageBaseAddress = 0\r
47fea6af 1435 ImageMap = open(ImageMapTable, 'r')\r
52302d4d
LG
1436 for LinStr in ImageMap:\r
1437 if len (LinStr.strip()) == 0:\r
1438 continue\r
1439 #\r
1440 # Get the preferred address set on link time.\r
1441 #\r
1442 if LinStr.find ('Preferred load address is') != -1:\r
1443 StrList = LinStr.split()\r
1444 OrigImageBaseAddress = int (StrList[len(StrList) - 1], 16)\r
1445\r
1446 StrList = LinStr.split()\r
1447 if len (StrList) > 4:\r
47fea6af 1448 if StrList[3] == 'f' or StrList[3] == 'F':\r
52302d4d
LG
1449 Name = StrList[1]\r
1450 RelativeAddress = int (StrList[2], 16) - OrigImageBaseAddress\r
1451 FunctionList.append ((Name, RelativeAddress))\r
39879ef2 1452\r
52302d4d
LG
1453 ImageMap.close()\r
1454 #\r
1455 # Add general information.\r
1456 #\r
1457 if ModeIsSmm:\r
d943b0c3 1458 MapBuffer.append('\n\n%s (Fixed SMRAM Offset, BaseAddress=0x%010X, EntryPoint=0x%010X)\n' % (ModuleName, BaseAddress, BaseAddress + ModuleInfo.Image.EntryPoint))\r
52302d4d 1459 elif AddrIsOffset:\r
d943b0c3 1460 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 1461 else:\r
d943b0c3 1462 MapBuffer.append('\n\n%s (Fixed Memory Address, BaseAddress=0x%010X, EntryPoint=0x%010X)\n' % (ModuleName, BaseAddress, BaseAddress + ModuleInfo.Image.EntryPoint))\r
52302d4d
LG
1463 #\r
1464 # Add guid and general seciton section.\r
1465 #\r
1466 TextSectionAddress = 0\r
1467 DataSectionAddress = 0\r
1468 for SectionHeader in ModuleInfo.Image.SectionHeaderList:\r
1469 if SectionHeader[0] == '.text':\r
1470 TextSectionAddress = SectionHeader[1]\r
1471 elif SectionHeader[0] in ['.data', '.sdata']:\r
1472 DataSectionAddress = SectionHeader[1]\r
1473 if AddrIsOffset:\r
d943b0c3 1474 MapBuffer.append('(GUID=%s, .textbaseaddress=-0x%010X, .databaseaddress=-0x%010X)\n' % (ModuleInfo.Guid, 0 - (BaseAddress + TextSectionAddress), 0 - (BaseAddress + DataSectionAddress)))\r
52302d4d 1475 else:\r
d943b0c3 1476 MapBuffer.append('(GUID=%s, .textbaseaddress=0x%010X, .databaseaddress=0x%010X)\n' % (ModuleInfo.Guid, BaseAddress + TextSectionAddress, BaseAddress + DataSectionAddress))\r
f3decdc3
LG
1477 #\r
1478 # Add debug image full path.\r
1479 #\r
d943b0c3 1480 MapBuffer.append('(IMAGE=%s)\n\n' % (ModuleDebugImage))\r
52302d4d 1481 #\r
fb0b35e0 1482 # Add function address\r
52302d4d
LG
1483 #\r
1484 for Function in FunctionList:\r
1485 if AddrIsOffset:\r
d943b0c3 1486 MapBuffer.append(' -0x%010X %s\n' % (0 - (BaseAddress + Function[1]), Function[0]))\r
52302d4d 1487 else:\r
d943b0c3 1488 MapBuffer.append(' 0x%010X %s\n' % (BaseAddress + Function[1], Function[0]))\r
52302d4d
LG
1489 ImageMap.close()\r
1490\r
1491 #\r
1492 # for SMM module in SMRAM, the SMRAM will be allocated from base to top.\r
1493 #\r
1494 if ModeIsSmm:\r
1495 BaseAddress = BaseAddress + ModuleInfo.Image.Size\r
1496\r
1497 ## Collect MAP information of all FVs\r
1498 #\r
636f2be6 1499 def _CollectFvMapBuffer (self, MapBuffer, Wa, ModuleList):\r
0d2711a6 1500 if self.Fdf:\r
52302d4d 1501 # First get the XIP base address for FV map file.\r
636f2be6 1502 GuidPattern = re.compile("[-a-fA-F0-9]+")\r
eebc135f 1503 GuidName = re.compile(r"\(GUID=[-a-fA-F0-9]+")\r
9eb87141 1504 for FvName in Wa.FdfProfile.FvDict:\r
52302d4d
LG
1505 FvMapBuffer = os.path.join(Wa.FvDir, FvName + '.Fv.map')\r
1506 if not os.path.exists(FvMapBuffer):\r
1507 continue\r
1be2ed90 1508 FvMap = open(FvMapBuffer, 'r')\r
52302d4d
LG
1509 #skip FV size information\r
1510 FvMap.readline()\r
1511 FvMap.readline()\r
1512 FvMap.readline()\r
1513 FvMap.readline()\r
636f2be6
LG
1514 for Line in FvMap:\r
1515 MatchGuid = GuidPattern.match(Line)\r
4231a819 1516 if MatchGuid is not None:\r
636f2be6
LG
1517 #\r
1518 # Replace GUID with module name\r
1519 #\r
1520 GuidString = MatchGuid.group()\r
1521 if GuidString.upper() in ModuleList:\r
1522 Line = Line.replace(GuidString, ModuleList[GuidString.upper()].Name)\r
d943b0c3 1523 MapBuffer.append(Line)\r
f3decdc3
LG
1524 #\r
1525 # Add the debug image full path.\r
1526 #\r
1527 MatchGuid = GuidName.match(Line)\r
4231a819 1528 if MatchGuid is not None:\r
f3decdc3
LG
1529 GuidString = MatchGuid.group().split("=")[1]\r
1530 if GuidString.upper() in ModuleList:\r
d943b0c3 1531 MapBuffer.append('(IMAGE=%s)\n' % (os.path.join(ModuleList[GuidString.upper()].DebugDir, ModuleList[GuidString.upper()].Name + '.efi')))\r
f3decdc3 1532\r
52302d4d
LG
1533 FvMap.close()\r
1534\r
1535 ## Collect MAP information of all modules\r
1536 #\r
1537 def _CollectModuleMapBuffer (self, MapBuffer, ModuleList):\r
da92f276
LG
1538 sys.stdout.write ("Generate Load Module At Fix Address Map")\r
1539 sys.stdout.flush()\r
52302d4d
LG
1540 PatchEfiImageList = []\r
1541 PeiModuleList = {}\r
1542 BtModuleList = {}\r
1543 RtModuleList = {}\r
1544 SmmModuleList = {}\r
1545 PeiSize = 0\r
1546 BtSize = 0\r
1547 RtSize = 0\r
1548 # reserve 4K size in SMRAM to make SMM module address not from 0.\r
1549 SmmSize = 0x1000\r
636f2be6
LG
1550 for ModuleGuid in ModuleList:\r
1551 Module = ModuleList[ModuleGuid]\r
52302d4d 1552 GlobalData.gProcessingFile = "%s [%s, %s, %s]" % (Module.MetaFile, Module.Arch, Module.ToolChain, Module.BuildTarget)\r
4afd3d04 1553\r
52302d4d
LG
1554 OutputImageFile = ''\r
1555 for ResultFile in Module.CodaTargetList:\r
1556 if str(ResultFile.Target).endswith('.efi'):\r
1557 #\r
1558 # module list for PEI, DXE, RUNTIME and SMM\r
1559 #\r
1560 OutputImageFile = os.path.join(Module.OutputDir, Module.Name + '.efi')\r
1561 ImageClass = PeImageClass (OutputImageFile)\r
1562 if not ImageClass.IsValid:\r
1563 EdkLogger.error("build", FILE_PARSE_FAILURE, ExtraData=ImageClass.ErrorInfo)\r
f3decdc3 1564 ImageInfo = PeImageInfo(Module.Name, Module.Guid, Module.Arch, Module.OutputDir, Module.DebugDir, ImageClass)\r
0c60e60b 1565 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
1566 PeiModuleList[Module.MetaFile] = ImageInfo\r
1567 PeiSize += ImageInfo.Image.Size\r
0c60e60b 1568 elif Module.ModuleType in [EDK_COMPONENT_TYPE_BS_DRIVER, SUP_MODULE_DXE_DRIVER, SUP_MODULE_UEFI_DRIVER]:\r
52302d4d
LG
1569 BtModuleList[Module.MetaFile] = ImageInfo\r
1570 BtSize += ImageInfo.Image.Size\r
0c60e60b 1571 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 1572 RtModuleList[Module.MetaFile] = ImageInfo\r
52302d4d 1573 RtSize += ImageInfo.Image.Size\r
8bb63e37 1574 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
1575 SmmModuleList[Module.MetaFile] = ImageInfo\r
1576 SmmSize += ImageInfo.Image.Size\r
8bb63e37 1577 if Module.ModuleType == SUP_MODULE_DXE_SMM_DRIVER:\r
888d7f19 1578 PiSpecVersion = Module.Module.Specification.get('PI_SPECIFICATION_VERSION', '0x00000000')\r
52302d4d 1579 # for PI specification < PI1.1, DXE_SMM_DRIVER also runs as BOOT time driver.\r
da92f276 1580 if int(PiSpecVersion, 16) < 0x0001000A:\r
52302d4d
LG
1581 BtModuleList[Module.MetaFile] = ImageInfo\r
1582 BtSize += ImageInfo.Image.Size\r
1583 break\r
1584 #\r
1585 # EFI image is final target.\r
1586 # Check EFI image contains patchable FixAddress related PCDs.\r
1587 #\r
1588 if OutputImageFile != '':\r
1589 ModuleIsPatch = False\r
1590 for Pcd in Module.ModulePcdList:\r
eece4292 1591 if Pcd.Type == TAB_PCDS_PATCHABLE_IN_MODULE and Pcd.TokenCName in TAB_PCDS_PATCHABLE_LOAD_FIX_ADDRESS_SET:\r
52302d4d
LG
1592 ModuleIsPatch = True\r
1593 break\r
1594 if not ModuleIsPatch:\r
1595 for Pcd in Module.LibraryPcdList:\r
eece4292 1596 if Pcd.Type == TAB_PCDS_PATCHABLE_IN_MODULE and Pcd.TokenCName in TAB_PCDS_PATCHABLE_LOAD_FIX_ADDRESS_SET:\r
52302d4d
LG
1597 ModuleIsPatch = True\r
1598 break\r
4afd3d04 1599\r
52302d4d
LG
1600 if not ModuleIsPatch:\r
1601 continue\r
1602 #\r
1603 # Module includes the patchable load fix address PCDs.\r
4afd3d04 1604 # It will be fixed up later.\r
52302d4d
LG
1605 #\r
1606 PatchEfiImageList.append (OutputImageFile)\r
4afd3d04 1607\r
52302d4d
LG
1608 #\r
1609 # Get Top Memory address\r
1610 #\r
1611 ReservedRuntimeMemorySize = 0\r
1612 TopMemoryAddress = 0\r
1613 if self.LoadFixAddress == 0xFFFFFFFFFFFFFFFF:\r
1614 TopMemoryAddress = 0\r
1615 else:\r
1616 TopMemoryAddress = self.LoadFixAddress\r
1617 if TopMemoryAddress < RtSize + BtSize + PeiSize:\r
1618 EdkLogger.error("build", PARAMETER_INVALID, "FIX_LOAD_TOP_MEMORY_ADDRESS is too low to load driver")\r
52302d4d
LG
1619\r
1620 #\r
1621 # Patch FixAddress related PCDs into EFI image\r
1622 #\r
4afd3d04 1623 for EfiImage in PatchEfiImageList:\r
52302d4d
LG
1624 EfiImageMap = EfiImage.replace('.efi', '.map')\r
1625 if not os.path.exists(EfiImageMap):\r
1626 continue\r
1627 #\r
1628 # Get PCD offset in EFI image by GenPatchPcdTable function\r
1629 #\r
4afd3d04 1630 PcdTable = parsePcdInfoFromMapFile(EfiImageMap, EfiImage)\r
52302d4d
LG
1631 #\r
1632 # Patch real PCD value by PatchPcdValue tool\r
1633 #\r
1634 for PcdInfo in PcdTable:\r
1635 ReturnValue = 0\r
1636 if PcdInfo[0] == TAB_PCDS_PATCHABLE_LOAD_FIX_ADDRESS_PEI_PAGE_SIZE:\r
b3e94a06 1637 ReturnValue, ErrorInfo = PatchBinaryFile (EfiImage, PcdInfo[1], TAB_PCDS_PATCHABLE_LOAD_FIX_ADDRESS_PEI_PAGE_SIZE_DATA_TYPE, str (PeiSize // 0x1000))\r
52302d4d 1638 elif PcdInfo[0] == TAB_PCDS_PATCHABLE_LOAD_FIX_ADDRESS_DXE_PAGE_SIZE:\r
b3e94a06 1639 ReturnValue, ErrorInfo = PatchBinaryFile (EfiImage, PcdInfo[1], TAB_PCDS_PATCHABLE_LOAD_FIX_ADDRESS_DXE_PAGE_SIZE_DATA_TYPE, str (BtSize // 0x1000))\r
52302d4d 1640 elif PcdInfo[0] == TAB_PCDS_PATCHABLE_LOAD_FIX_ADDRESS_RUNTIME_PAGE_SIZE:\r
b3e94a06 1641 ReturnValue, ErrorInfo = PatchBinaryFile (EfiImage, PcdInfo[1], TAB_PCDS_PATCHABLE_LOAD_FIX_ADDRESS_RUNTIME_PAGE_SIZE_DATA_TYPE, str (RtSize // 0x1000))\r
52302d4d 1642 elif PcdInfo[0] == TAB_PCDS_PATCHABLE_LOAD_FIX_ADDRESS_SMM_PAGE_SIZE and len (SmmModuleList) > 0:\r
b3e94a06 1643 ReturnValue, ErrorInfo = PatchBinaryFile (EfiImage, PcdInfo[1], TAB_PCDS_PATCHABLE_LOAD_FIX_ADDRESS_SMM_PAGE_SIZE_DATA_TYPE, str (SmmSize // 0x1000))\r
52302d4d
LG
1644 if ReturnValue != 0:\r
1645 EdkLogger.error("build", PARAMETER_INVALID, "Patch PCD value failed", ExtraData=ErrorInfo)\r
4afd3d04 1646\r
d943b0c3
FB
1647 MapBuffer.append('PEI_CODE_PAGE_NUMBER = 0x%x\n' % (PeiSize // 0x1000))\r
1648 MapBuffer.append('BOOT_CODE_PAGE_NUMBER = 0x%x\n' % (BtSize // 0x1000))\r
1649 MapBuffer.append('RUNTIME_CODE_PAGE_NUMBER = 0x%x\n' % (RtSize // 0x1000))\r
52302d4d 1650 if len (SmmModuleList) > 0:\r
d943b0c3 1651 MapBuffer.append('SMM_CODE_PAGE_NUMBER = 0x%x\n' % (SmmSize // 0x1000))\r
4afd3d04
LG
1652\r
1653 PeiBaseAddr = TopMemoryAddress - RtSize - BtSize\r
52302d4d 1654 BtBaseAddr = TopMemoryAddress - RtSize\r
4afd3d04 1655 RtBaseAddr = TopMemoryAddress - ReservedRuntimeMemorySize\r
52302d4d
LG
1656\r
1657 self._RebaseModule (MapBuffer, PeiBaseAddr, PeiModuleList, TopMemoryAddress == 0)\r
1658 self._RebaseModule (MapBuffer, BtBaseAddr, BtModuleList, TopMemoryAddress == 0)\r
1659 self._RebaseModule (MapBuffer, RtBaseAddr, RtModuleList, TopMemoryAddress == 0)\r
47fea6af 1660 self._RebaseModule (MapBuffer, 0x1000, SmmModuleList, AddrIsOffset=False, ModeIsSmm=True)\r
d943b0c3 1661 MapBuffer.append('\n\n')\r
da92f276
LG
1662 sys.stdout.write ("\n")\r
1663 sys.stdout.flush()\r
4afd3d04 1664\r
52302d4d
LG
1665 ## Save platform Map file\r
1666 #\r
1667 def _SaveMapFile (self, MapBuffer, Wa):\r
1668 #\r
1669 # Map file path is got.\r
1670 #\r
1671 MapFilePath = os.path.join(Wa.BuildDir, Wa.Name + '.map')\r
1672 #\r
1673 # Save address map into MAP file.\r
1674 #\r
d943b0c3 1675 SaveFileOnChange(MapFilePath, ''.join(MapBuffer), False)\r
da92f276 1676 if self.LoadFixAddress != 0:\r
47fea6af 1677 sys.stdout.write ("\nLoad Module At Fix Address Map file can be found at %s\n" % (MapFilePath))\r
da92f276 1678 sys.stdout.flush()\r
52302d4d
LG
1679\r
1680 ## Build active platform for different build targets and different tool chains\r
1681 #\r
1682 def _BuildPlatform(self):\r
f0dc69e6 1683 SaveFileOnChange(self.PlatformBuildPath, '# DO NOT EDIT \n# FILE auto-generated\n', False)\r
52302d4d 1684 for BuildTarget in self.BuildTargetList:\r
0d2711a6 1685 GlobalData.gGlobalDefines['TARGET'] = BuildTarget\r
40b4e21d 1686 index = 0\r
52302d4d 1687 for ToolChain in self.ToolChainList:\r
0d2711a6
LG
1688 GlobalData.gGlobalDefines['TOOLCHAIN'] = ToolChain\r
1689 GlobalData.gGlobalDefines['TOOL_CHAIN_TAG'] = ToolChain\r
40b4e21d
YZ
1690 GlobalData.gGlobalDefines['FAMILY'] = self.ToolChainFamily[index]\r
1691 index += 1\r
52302d4d
LG
1692 Wa = WorkspaceAutoGen(\r
1693 self.WorkspaceDir,\r
0d2711a6 1694 self.PlatformFile,\r
52302d4d
LG
1695 BuildTarget,\r
1696 ToolChain,\r
1697 self.ArchList,\r
1698 self.BuildDatabase,\r
1699 self.TargetTxt,\r
1700 self.ToolDef,\r
1701 self.Fdf,\r
1702 self.FdList,\r
1703 self.FvList,\r
4234283c 1704 self.CapList,\r
f3decdc3 1705 self.SkuId,\r
9508d0fa
LG
1706 self.UniFlag,\r
1707 self.Progress\r
52302d4d 1708 )\r
0d2711a6
LG
1709 self.Fdf = Wa.FdfFile\r
1710 self.LoadFixAddress = Wa.Platform.LoadFixAddress\r
52302d4d
LG
1711 self.BuildReport.AddPlatformReport(Wa)\r
1712 self.Progress.Stop("done!")\r
37de70b7
YZ
1713\r
1714 # Add ffs build to makefile\r
1715 CmdListDict = {}\r
1716 if GlobalData.gEnableGenfdsMultiThread and self.Fdf:\r
b1e27d17 1717 CmdListDict = self._GenFfsCmd(Wa.ArchList)\r
37de70b7 1718\r
03af2753
HC
1719 for Arch in Wa.ArchList:\r
1720 GlobalData.gGlobalDefines['ARCH'] = Arch\r
1721 Pa = PlatformAutoGen(Wa, self.PlatformFile, BuildTarget, ToolChain, Arch)\r
a0a2cd1e
FB
1722 for Module in Pa.Platform.Modules:\r
1723 # Get ModuleAutoGen object to generate C code file and makefile\r
1724 Ma = ModuleAutoGen(Wa, Module, BuildTarget, ToolChain, Arch, self.PlatformFile)\r
4231a819 1725 if Ma is None:\r
a0a2cd1e
FB
1726 continue\r
1727 self.BuildModules.append(Ma)\r
37de70b7 1728 self._BuildPa(self.Target, Pa, FfsCommand=CmdListDict)\r
4afd3d04 1729\r
52302d4d 1730 # Create MAP file when Load Fix Address is enabled.\r
636f2be6 1731 if self.Target in ["", "all", "fds"]:\r
0d2711a6
LG
1732 for Arch in Wa.ArchList:\r
1733 GlobalData.gGlobalDefines['ARCH'] = Arch\r
52302d4d
LG
1734 #\r
1735 # Check whether the set fix address is above 4G for 32bit image.\r
1736 #\r
1737 if (Arch == 'IA32' or Arch == 'ARM') and self.LoadFixAddress != 0xFFFFFFFFFFFFFFFF and self.LoadFixAddress >= 0x100000000:\r
0d2711a6 1738 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
1739 #\r
1740 # Get Module List\r
1741 #\r
636f2be6 1742 ModuleList = {}\r
52302d4d
LG
1743 for Pa in Wa.AutoGenObjectList:\r
1744 for Ma in Pa.ModuleAutoGenList:\r
4231a819 1745 if Ma is None:\r
52302d4d
LG
1746 continue\r
1747 if not Ma.IsLibrary:\r
636f2be6 1748 ModuleList[Ma.Guid.upper()] = Ma\r
52302d4d 1749\r
d943b0c3 1750 MapBuffer = []\r
636f2be6
LG
1751 if self.LoadFixAddress != 0:\r
1752 #\r
1753 # Rebase module to the preferred memory address before GenFds\r
1754 #\r
1755 self._CollectModuleMapBuffer(MapBuffer, ModuleList)\r
0d2711a6 1756 if self.Fdf:\r
b0e23cf3
YL
1757 #\r
1758 # create FDS again for the updated EFI image\r
1759 #\r
1760 self._Build("fds", Wa)\r
52302d4d
LG
1761 #\r
1762 # Create MAP file for all platform FVs after GenFds.\r
1763 #\r
636f2be6 1764 self._CollectFvMapBuffer(MapBuffer, Wa, ModuleList)\r
52302d4d
LG
1765 #\r
1766 # Save MAP buffer into MAP file.\r
1767 #\r
1768 self._SaveMapFile (MapBuffer, Wa)\r
1769\r
1770 ## Build active module for different build targets, different tool chains and different archs\r
1771 #\r
1772 def _BuildModule(self):\r
1773 for BuildTarget in self.BuildTargetList:\r
0d2711a6 1774 GlobalData.gGlobalDefines['TARGET'] = BuildTarget\r
40b4e21d 1775 index = 0\r
52302d4d 1776 for ToolChain in self.ToolChainList:\r
1b8eca8b 1777 WorkspaceAutoGenTime = time.time()\r
0d2711a6 1778 GlobalData.gGlobalDefines['TOOLCHAIN'] = ToolChain\r
4afd3d04 1779 GlobalData.gGlobalDefines['TOOL_CHAIN_TAG'] = ToolChain\r
40b4e21d
YZ
1780 GlobalData.gGlobalDefines['FAMILY'] = self.ToolChainFamily[index]\r
1781 index += 1\r
52302d4d
LG
1782 #\r
1783 # module build needs platform build information, so get platform\r
1784 # AutoGen first\r
1785 #\r
1786 Wa = WorkspaceAutoGen(\r
1787 self.WorkspaceDir,\r
0d2711a6 1788 self.PlatformFile,\r
52302d4d
LG
1789 BuildTarget,\r
1790 ToolChain,\r
1791 self.ArchList,\r
1792 self.BuildDatabase,\r
1793 self.TargetTxt,\r
1794 self.ToolDef,\r
1795 self.Fdf,\r
1796 self.FdList,\r
1797 self.FvList,\r
4234283c 1798 self.CapList,\r
f3decdc3 1799 self.SkuId,\r
9508d0fa
LG
1800 self.UniFlag,\r
1801 self.Progress,\r
1802 self.ModuleFile\r
52302d4d 1803 )\r
0d2711a6
LG
1804 self.Fdf = Wa.FdfFile\r
1805 self.LoadFixAddress = Wa.Platform.LoadFixAddress\r
52302d4d 1806 Wa.CreateMakeFile(False)\r
37de70b7
YZ
1807 # Add ffs build to makefile\r
1808 CmdListDict = None\r
1809 if GlobalData.gEnableGenfdsMultiThread and self.Fdf:\r
b1e27d17 1810 CmdListDict = self._GenFfsCmd(Wa.ArchList)\r
52302d4d
LG
1811 self.Progress.Stop("done!")\r
1812 MaList = []\r
1b8eca8b
YZ
1813 ExitFlag = threading.Event()\r
1814 ExitFlag.clear()\r
1815 self.AutoGenTime += int(round((time.time() - WorkspaceAutoGenTime)))\r
0d2711a6 1816 for Arch in Wa.ArchList:\r
1b8eca8b 1817 AutoGenStart = time.time()\r
0d2711a6 1818 GlobalData.gGlobalDefines['ARCH'] = Arch\r
16bad1fb
YZ
1819 Pa = PlatformAutoGen(Wa, self.PlatformFile, BuildTarget, ToolChain, Arch)\r
1820 for Module in Pa.Platform.Modules:\r
fbe53845 1821 if self.ModuleFile.Dir == Module.Dir and self.ModuleFile.Name == Module.Name:\r
16bad1fb 1822 Ma = ModuleAutoGen(Wa, Module, BuildTarget, ToolChain, Arch, self.PlatformFile)\r
db4d47fd
CR
1823 if Ma is None:\r
1824 continue\r
19bf8314
YZ
1825 MaList.append(Ma)\r
1826 if Ma.CanSkipbyHash():\r
1827 self.HashSkipModules.append(Ma)\r
04df1853
SS
1828 if GlobalData.gBinCacheSource:\r
1829 EdkLogger.quiet("cache hit: %s[%s]" % (Ma.MetaFile.Path, Ma.Arch))\r
19bf8314 1830 continue\r
04df1853
SS
1831 else:\r
1832 if GlobalData.gBinCacheSource:\r
1833 EdkLogger.quiet("cache miss: %s[%s]" % (Ma.MetaFile.Path, Ma.Arch))\r
119d8c42
YZ
1834 # Not to auto-gen for targets 'clean', 'cleanlib', 'cleanall', 'run', 'fds'\r
1835 if self.Target not in ['clean', 'cleanlib', 'cleanall', 'run', 'fds']:\r
1836 # for target which must generate AutoGen code and makefile\r
1837 if not self.SkipAutoGen or self.Target == 'genc':\r
cd498216 1838 self.Progress.Start("Generating code")\r
119d8c42 1839 Ma.CreateCodeFile(True)\r
cd498216
YZ
1840 self.Progress.Stop("done!")\r
1841 if self.Target == "genc":\r
1842 return True\r
119d8c42 1843 if not self.SkipAutoGen or self.Target == 'genmake':\r
cd498216 1844 self.Progress.Start("Generating makefile")\r
37de70b7
YZ
1845 if CmdListDict and self.Fdf and (Module.File, Arch) in CmdListDict:\r
1846 Ma.CreateMakeFile(True, CmdListDict[Module.File, Arch])\r
1847 del CmdListDict[Module.File, Arch]\r
1848 else:\r
1849 Ma.CreateMakeFile(True)\r
cd498216
YZ
1850 self.Progress.Stop("done!")\r
1851 if self.Target == "genmake":\r
1852 return True\r
16bad1fb 1853 self.BuildModules.append(Ma)\r
48b0bf64
RC
1854 # Initialize all modules in tracking to 'FAIL'\r
1855 if Ma.Arch not in GlobalData.gModuleBuildTracking:\r
1856 GlobalData.gModuleBuildTracking[Ma.Arch] = dict()\r
1857 if Ma not in GlobalData.gModuleBuildTracking[Ma.Arch]:\r
1858 GlobalData.gModuleBuildTracking[Ma.Arch][Ma] = 'FAIL'\r
1b8eca8b
YZ
1859 self.AutoGenTime += int(round((time.time() - AutoGenStart)))\r
1860 MakeStart = time.time()\r
1861 for Ma in self.BuildModules:\r
1862 if not Ma.IsBinaryModule:\r
1863 Bt = BuildTask.New(ModuleMakeUnit(Ma, self.Target))\r
1864 # Break build if any build thread has error\r
1865 if BuildTask.HasError():\r
1866 # we need a full version of makefile for platform\r
1867 ExitFlag.set()\r
1868 BuildTask.WaitForComplete()\r
0eccea3f 1869 self.invalidateHash()\r
1b8eca8b
YZ
1870 Pa.CreateMakeFile(False)\r
1871 EdkLogger.error("build", BUILD_ERROR, "Failed to build module", ExtraData=GlobalData.gBuildingModule)\r
1872 # Start task scheduler\r
1873 if not BuildTask.IsOnGoing():\r
1874 BuildTask.StartScheduler(self.ThreadNumber, ExitFlag)\r
1875\r
1876 # in case there's an interruption. we need a full version of makefile for platform\r
1877 Pa.CreateMakeFile(False)\r
1878 if BuildTask.HasError():\r
0eccea3f 1879 self.invalidateHash()\r
1b8eca8b
YZ
1880 EdkLogger.error("build", BUILD_ERROR, "Failed to build module", ExtraData=GlobalData.gBuildingModule)\r
1881 self.MakeTime += int(round((time.time() - MakeStart)))\r
1882\r
1883 MakeContiue = time.time()\r
1884 ExitFlag.set()\r
1885 BuildTask.WaitForComplete()\r
1886 self.CreateAsBuiltInf()\r
b8ac0b7f
BF
1887 if GlobalData.gBinCacheDest:\r
1888 self.UpdateBuildCache()\r
1889 self.BuildModules = []\r
1b8eca8b
YZ
1890 self.MakeTime += int(round((time.time() - MakeContiue)))\r
1891 if BuildTask.HasError():\r
0eccea3f 1892 self.invalidateHash()\r
1b8eca8b 1893 EdkLogger.error("build", BUILD_ERROR, "Failed to build module", ExtraData=GlobalData.gBuildingModule)\r
d5d56f1b
LG
1894\r
1895 self.BuildReport.AddPlatformReport(Wa, MaList)\r
52302d4d
LG
1896 if MaList == []:\r
1897 EdkLogger.error(\r
1898 'build',\r
1899 BUILD_ERROR,\r
1900 "Module for [%s] is not a component of active platform."\\r
1901 " Please make sure that the ARCH and inf file path are"\\r
47fea6af 1902 " given in the same as in [%s]" % \\r
0d2711a6 1903 (', '.join(Wa.ArchList), self.PlatformFile),\r
52302d4d
LG
1904 ExtraData=self.ModuleFile\r
1905 )\r
1906 # Create MAP file when Load Fix Address is enabled.\r
0d2711a6
LG
1907 if self.Target == "fds" and self.Fdf:\r
1908 for Arch in Wa.ArchList:\r
52302d4d
LG
1909 #\r
1910 # Check whether the set fix address is above 4G for 32bit image.\r
1911 #\r
1912 if (Arch == 'IA32' or Arch == 'ARM') and self.LoadFixAddress != 0xFFFFFFFFFFFFFFFF and self.LoadFixAddress >= 0x100000000:\r
1913 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
1914 #\r
1915 # Get Module List\r
1916 #\r
636f2be6 1917 ModuleList = {}\r
52302d4d
LG
1918 for Pa in Wa.AutoGenObjectList:\r
1919 for Ma in Pa.ModuleAutoGenList:\r
4231a819 1920 if Ma is None:\r
52302d4d
LG
1921 continue\r
1922 if not Ma.IsLibrary:\r
636f2be6 1923 ModuleList[Ma.Guid.upper()] = Ma\r
52302d4d 1924\r
d943b0c3 1925 MapBuffer = []\r
636f2be6
LG
1926 if self.LoadFixAddress != 0:\r
1927 #\r
1928 # Rebase module to the preferred memory address before GenFds\r
1929 #\r
1930 self._CollectModuleMapBuffer(MapBuffer, ModuleList)\r
b0e23cf3
YL
1931 #\r
1932 # create FDS again for the updated EFI image\r
1933 #\r
1b8eca8b 1934 GenFdsStart = time.time()\r
b0e23cf3 1935 self._Build("fds", Wa)\r
1b8eca8b 1936 self.GenFdsTime += int(round((time.time() - GenFdsStart)))\r
52302d4d
LG
1937 #\r
1938 # Create MAP file for all platform FVs after GenFds.\r
1939 #\r
636f2be6 1940 self._CollectFvMapBuffer(MapBuffer, Wa, ModuleList)\r
52302d4d
LG
1941 #\r
1942 # Save MAP buffer into MAP file.\r
1943 #\r
1944 self._SaveMapFile (MapBuffer, Wa)\r
48b0bf64 1945 self.invalidateHash()\r
52302d4d 1946\r
b1e27d17 1947 def _GenFfsCmd(self,ArchList):\r
f7496d71 1948 # convert dictionary of Cmd:(Inf,Arch)\r
9eb87141
CJ
1949 # to a new dictionary of (Inf,Arch):Cmd,Cmd,Cmd...\r
1950 CmdSetDict = defaultdict(set)\r
b1e27d17 1951 GenFfsDict = GenFds.GenFfsMakefile('', GlobalData.gFdfParser, self, ArchList, GlobalData)\r
37de70b7
YZ
1952 for Cmd in GenFfsDict:\r
1953 tmpInf, tmpArch = GenFfsDict[Cmd]\r
9eb87141
CJ
1954 CmdSetDict[tmpInf, tmpArch].add(Cmd)\r
1955 return CmdSetDict\r
37de70b7 1956\r
52302d4d
LG
1957 ## Build a platform in multi-thread mode\r
1958 #\r
1959 def _MultiThreadBuildPlatform(self):\r
f0dc69e6 1960 SaveFileOnChange(self.PlatformBuildPath, '# DO NOT EDIT \n# FILE auto-generated\n', False)\r
52302d4d 1961 for BuildTarget in self.BuildTargetList:\r
0d2711a6 1962 GlobalData.gGlobalDefines['TARGET'] = BuildTarget\r
40b4e21d 1963 index = 0\r
52302d4d 1964 for ToolChain in self.ToolChainList:\r
1b8eca8b 1965 WorkspaceAutoGenTime = time.time()\r
0d2711a6 1966 GlobalData.gGlobalDefines['TOOLCHAIN'] = ToolChain\r
4afd3d04 1967 GlobalData.gGlobalDefines['TOOL_CHAIN_TAG'] = ToolChain\r
40b4e21d
YZ
1968 GlobalData.gGlobalDefines['FAMILY'] = self.ToolChainFamily[index]\r
1969 index += 1\r
52302d4d
LG
1970 Wa = WorkspaceAutoGen(\r
1971 self.WorkspaceDir,\r
0d2711a6 1972 self.PlatformFile,\r
52302d4d
LG
1973 BuildTarget,\r
1974 ToolChain,\r
1975 self.ArchList,\r
1976 self.BuildDatabase,\r
1977 self.TargetTxt,\r
1978 self.ToolDef,\r
1979 self.Fdf,\r
1980 self.FdList,\r
1981 self.FvList,\r
4234283c 1982 self.CapList,\r
f3decdc3 1983 self.SkuId,\r
9508d0fa
LG
1984 self.UniFlag,\r
1985 self.Progress\r
52302d4d 1986 )\r
0d2711a6
LG
1987 self.Fdf = Wa.FdfFile\r
1988 self.LoadFixAddress = Wa.Platform.LoadFixAddress\r
52302d4d
LG
1989 self.BuildReport.AddPlatformReport(Wa)\r
1990 Wa.CreateMakeFile(False)\r
1991\r
37de70b7
YZ
1992 # Add ffs build to makefile\r
1993 CmdListDict = None\r
1994 if GlobalData.gEnableGenfdsMultiThread and self.Fdf:\r
b1e27d17 1995 CmdListDict = self._GenFfsCmd(Wa.ArchList)\r
37de70b7 1996\r
52302d4d
LG
1997 # multi-thread exit flag\r
1998 ExitFlag = threading.Event()\r
1999 ExitFlag.clear()\r
1b8eca8b 2000 self.AutoGenTime += int(round((time.time() - WorkspaceAutoGenTime)))\r
0d2711a6 2001 for Arch in Wa.ArchList:\r
1b8eca8b 2002 AutoGenStart = time.time()\r
0d2711a6 2003 GlobalData.gGlobalDefines['ARCH'] = Arch\r
52302d4d 2004 Pa = PlatformAutoGen(Wa, self.PlatformFile, BuildTarget, ToolChain, Arch)\r
4231a819 2005 if Pa is None:\r
52302d4d 2006 continue\r
a0a2cd1e
FB
2007 ModuleList = []\r
2008 for Inf in Pa.Platform.Modules:\r
2009 ModuleList.append(Inf)\r
2010 # Add the INF only list in FDF\r
4231a819 2011 if GlobalData.gFdfParser is not None:\r
a0a2cd1e
FB
2012 for InfName in GlobalData.gFdfParser.Profile.InfList:\r
2013 Inf = PathClass(NormPath(InfName), self.WorkspaceDir, Arch)\r
2014 if Inf in Pa.Platform.Modules:\r
2015 continue\r
2016 ModuleList.append(Inf)\r
2017 for Module in ModuleList:\r
52302d4d
LG
2018 # Get ModuleAutoGen object to generate C code file and makefile\r
2019 Ma = ModuleAutoGen(Wa, Module, BuildTarget, ToolChain, Arch, self.PlatformFile)\r
f7496d71 2020\r
4231a819 2021 if Ma is None:\r
52302d4d 2022 continue\r
36d083ef 2023 if Ma.CanSkipbyHash():\r
83397f95 2024 self.HashSkipModules.append(Ma)\r
04df1853
SS
2025 if GlobalData.gBinCacheSource:\r
2026 EdkLogger.quiet("cache hit: %s[%s]" % (Ma.MetaFile.Path, Ma.Arch))\r
36d083ef 2027 continue\r
04df1853
SS
2028 else:\r
2029 if GlobalData.gBinCacheSource:\r
2030 EdkLogger.quiet("cache miss: %s[%s]" % (Ma.MetaFile.Path, Ma.Arch))\r
36d083ef 2031\r
52302d4d
LG
2032 # Not to auto-gen for targets 'clean', 'cleanlib', 'cleanall', 'run', 'fds'\r
2033 if self.Target not in ['clean', 'cleanlib', 'cleanall', 'run', 'fds']:\r
2034 # for target which must generate AutoGen code and makefile\r
2035 if not self.SkipAutoGen or self.Target == 'genc':\r
2036 Ma.CreateCodeFile(True)\r
2037 if self.Target == "genc":\r
2038 continue\r
2039\r
2040 if not self.SkipAutoGen or self.Target == 'genmake':\r
37de70b7
YZ
2041 if CmdListDict and self.Fdf and (Module.File, Arch) in CmdListDict:\r
2042 Ma.CreateMakeFile(True, CmdListDict[Module.File, Arch])\r
2043 del CmdListDict[Module.File, Arch]\r
2044 else:\r
2045 Ma.CreateMakeFile(True)\r
52302d4d
LG
2046 if self.Target == "genmake":\r
2047 continue\r
a0a2cd1e 2048 self.BuildModules.append(Ma)\r
48b0bf64
RC
2049 # Initialize all modules in tracking to 'FAIL'\r
2050 if Ma.Arch not in GlobalData.gModuleBuildTracking:\r
2051 GlobalData.gModuleBuildTracking[Ma.Arch] = dict()\r
2052 if Ma not in GlobalData.gModuleBuildTracking[Ma.Arch]:\r
2053 GlobalData.gModuleBuildTracking[Ma.Arch][Ma] = 'FAIL'\r
e8a47801 2054 self.Progress.Stop("done!")\r
1b8eca8b
YZ
2055 self.AutoGenTime += int(round((time.time() - AutoGenStart)))\r
2056 MakeStart = time.time()\r
a0a2cd1e 2057 for Ma in self.BuildModules:\r
52302d4d 2058 # Generate build task for the module\r
a0a2cd1e
FB
2059 if not Ma.IsBinaryModule:\r
2060 Bt = BuildTask.New(ModuleMakeUnit(Ma, self.Target))\r
52302d4d
LG
2061 # Break build if any build thread has error\r
2062 if BuildTask.HasError():\r
2063 # we need a full version of makefile for platform\r
2064 ExitFlag.set()\r
2065 BuildTask.WaitForComplete()\r
0eccea3f 2066 self.invalidateHash()\r
52302d4d
LG
2067 Pa.CreateMakeFile(False)\r
2068 EdkLogger.error("build", BUILD_ERROR, "Failed to build module", ExtraData=GlobalData.gBuildingModule)\r
2069 # Start task scheduler\r
2070 if not BuildTask.IsOnGoing():\r
2071 BuildTask.StartScheduler(self.ThreadNumber, ExitFlag)\r
2072\r
2073 # in case there's an interruption. we need a full version of makefile for platform\r
2074 Pa.CreateMakeFile(False)\r
2075 if BuildTask.HasError():\r
0eccea3f 2076 self.invalidateHash()\r
52302d4d 2077 EdkLogger.error("build", BUILD_ERROR, "Failed to build module", ExtraData=GlobalData.gBuildingModule)\r
1b8eca8b 2078 self.MakeTime += int(round((time.time() - MakeStart)))\r
52302d4d 2079\r
1b8eca8b 2080 MakeContiue = time.time()\r
2f818ed0 2081\r
64b2609f 2082 #\r
52302d4d
LG
2083 #\r
2084 # All modules have been put in build tasks queue. Tell task scheduler\r
2085 # to exit if all tasks are completed\r
2086 #\r
2087 ExitFlag.set()\r
2088 BuildTask.WaitForComplete()\r
a0a2cd1e 2089 self.CreateAsBuiltInf()\r
b8ac0b7f
BF
2090 if GlobalData.gBinCacheDest:\r
2091 self.UpdateBuildCache()\r
2092 self.BuildModules = []\r
1b8eca8b 2093 self.MakeTime += int(round((time.time() - MakeContiue)))\r
52302d4d
LG
2094 #\r
2095 # Check for build error, and raise exception if one\r
2096 # has been signaled.\r
2097 #\r
2098 if BuildTask.HasError():\r
0eccea3f 2099 self.invalidateHash()\r
52302d4d
LG
2100 EdkLogger.error("build", BUILD_ERROR, "Failed to build module", ExtraData=GlobalData.gBuildingModule)\r
2101\r
2102 # Create MAP file when Load Fix Address is enabled.\r
636f2be6 2103 if self.Target in ["", "all", "fds"]:\r
0d2711a6 2104 for Arch in Wa.ArchList:\r
52302d4d
LG
2105 #\r
2106 # Check whether the set fix address is above 4G for 32bit image.\r
2107 #\r
2108 if (Arch == 'IA32' or Arch == 'ARM') and self.LoadFixAddress != 0xFFFFFFFFFFFFFFFF and self.LoadFixAddress >= 0x100000000:\r
2109 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
2110 #\r
2111 # Get Module List\r
2112 #\r
636f2be6 2113 ModuleList = {}\r
52302d4d
LG
2114 for Pa in Wa.AutoGenObjectList:\r
2115 for Ma in Pa.ModuleAutoGenList:\r
4231a819 2116 if Ma is None:\r
52302d4d
LG
2117 continue\r
2118 if not Ma.IsLibrary:\r
636f2be6 2119 ModuleList[Ma.Guid.upper()] = Ma\r
52302d4d
LG
2120 #\r
2121 # Rebase module to the preferred memory address before GenFds\r
2122 #\r
d943b0c3 2123 MapBuffer = []\r
636f2be6
LG
2124 if self.LoadFixAddress != 0:\r
2125 self._CollectModuleMapBuffer(MapBuffer, ModuleList)\r
52302d4d 2126\r
0d2711a6 2127 if self.Fdf:\r
f3decdc3
LG
2128 #\r
2129 # Generate FD image if there's a FDF file found\r
2130 #\r
1b8eca8b 2131 GenFdsStart = time.time()\r
370544d1
DL
2132 if GenFdsApi(Wa.GenFdsCommandDict, self.Db):\r
2133 EdkLogger.error("build", COMMAND_FAILURE)\r
03af2753 2134\r
52302d4d
LG
2135 #\r
2136 # Create MAP file for all platform FVs after GenFds.\r
2137 #\r
636f2be6 2138 self._CollectFvMapBuffer(MapBuffer, Wa, ModuleList)\r
1b8eca8b 2139 self.GenFdsTime += int(round((time.time() - GenFdsStart)))\r
52302d4d
LG
2140 #\r
2141 # Save MAP buffer into MAP file.\r
2142 #\r
2143 self._SaveMapFile(MapBuffer, Wa)\r
48b0bf64 2144 self.invalidateHash()\r
52302d4d
LG
2145\r
2146 ## Generate GuidedSectionTools.txt in the FV directories.\r
2147 #\r
2148 def CreateGuidedSectionToolsFile(self):\r
0d2711a6
LG
2149 for BuildTarget in self.BuildTargetList:\r
2150 for ToolChain in self.ToolChainList:\r
2151 Wa = WorkspaceAutoGen(\r
2152 self.WorkspaceDir,\r
2153 self.PlatformFile,\r
2154 BuildTarget,\r
2155 ToolChain,\r
2156 self.ArchList,\r
2157 self.BuildDatabase,\r
2158 self.TargetTxt,\r
2159 self.ToolDef,\r
2160 self.Fdf,\r
2161 self.FdList,\r
2162 self.FvList,\r
2163 self.CapList,\r
2164 self.SkuId,\r
2165 self.UniFlag\r
2166 )\r
2167 FvDir = Wa.FvDir\r
2168 if not os.path.exists(FvDir):\r
2169 continue\r
2170\r
4afd3d04 2171 for Arch in self.ArchList:\r
52302d4d
LG
2172 # Build up the list of supported architectures for this build\r
2173 prefix = '%s_%s_%s_' % (BuildTarget, ToolChain, Arch)\r
4afd3d04 2174\r
52302d4d
LG
2175 # Look through the tool definitions for GUIDed tools\r
2176 guidAttribs = []\r
3a041437 2177 for (attrib, value) in self.ToolDef.ToolsDefTxtDictionary.items():\r
52302d4d
LG
2178 if attrib.upper().endswith('_GUID'):\r
2179 split = attrib.split('_')\r
2180 thisPrefix = '_'.join(split[0:3]) + '_'\r
2181 if thisPrefix == prefix:\r
2182 guid = self.ToolDef.ToolsDefTxtDictionary[attrib]\r
2183 guid = guid.lower()\r
2184 toolName = split[3]\r
2185 path = '_'.join(split[0:4]) + '_PATH'\r
2186 path = self.ToolDef.ToolsDefTxtDictionary[path]\r
2187 path = self.GetFullPathOfTool(path)\r
2188 guidAttribs.append((guid, toolName, path))\r
4afd3d04 2189\r
52302d4d
LG
2190 # Write out GuidedSecTools.txt\r
2191 toolsFile = os.path.join(FvDir, 'GuidedSectionTools.txt')\r
2192 toolsFile = open(toolsFile, 'wt')\r
2193 for guidedSectionTool in guidAttribs:\r
72443dd2 2194 print(' '.join(guidedSectionTool), file=toolsFile)\r
52302d4d
LG
2195 toolsFile.close()\r
2196\r
2197 ## Returns the full path of the tool.\r
2198 #\r
2199 def GetFullPathOfTool (self, tool):\r
2200 if os.path.exists(tool):\r
2201 return os.path.realpath(tool)\r
2202 else:\r
2203 # We need to search for the tool using the\r
2204 # PATH environment variable.\r
2205 for dirInPath in os.environ['PATH'].split(os.pathsep):\r
2206 foundPath = os.path.join(dirInPath, tool)\r
2207 if os.path.exists(foundPath):\r
2208 return os.path.realpath(foundPath)\r
2209\r
2210 # If the tool was not found in the path then we just return\r
2211 # the input tool.\r
2212 return tool\r
2213\r
2214 ## Launch the module or platform build\r
2215 #\r
2216 def Launch(self):\r
0d2711a6 2217 if not self.ModuleFile:\r
52302d4d
LG
2218 if not self.SpawnMode or self.Target not in ["", "all"]:\r
2219 self.SpawnMode = False\r
2220 self._BuildPlatform()\r
2221 else:\r
2222 self._MultiThreadBuildPlatform()\r
2223 self.CreateGuidedSectionToolsFile()\r
2224 else:\r
2225 self.SpawnMode = False\r
2226 self._BuildModule()\r
2227\r
bcbdc755 2228 if self.Target == 'cleanall':\r
bcbdc755
YL
2229 RemoveDirectory(os.path.dirname(GlobalData.gDatabasePath), True)\r
2230\r
a0a2cd1e 2231 def CreateAsBuiltInf(self):\r
b8ac0b7f
BF
2232 for Module in self.BuildModules:\r
2233 Module.CreateAsBuiltInf()\r
2234\r
2235 def UpdateBuildCache(self):\r
db4d47fd
CR
2236 all_lib_set = set()\r
2237 all_mod_set = set()\r
a0a2cd1e 2238 for Module in self.BuildModules:\r
b8ac0b7f 2239 Module.CopyModuleToCache()\r
db4d47fd 2240 all_mod_set.add(Module)\r
83397f95 2241 for Module in self.HashSkipModules:\r
b8ac0b7f 2242 Module.CopyModuleToCache()\r
db4d47fd
CR
2243 all_mod_set.add(Module)\r
2244 for Module in all_mod_set:\r
2245 for lib in Module.LibraryAutoGenList:\r
2246 all_lib_set.add(lib)\r
2247 for lib in all_lib_set:\r
b8ac0b7f 2248 lib.CopyModuleToCache()\r
db4d47fd
CR
2249 all_lib_set.clear()\r
2250 all_mod_set.clear()\r
83397f95 2251 self.HashSkipModules = []\r
52302d4d
LG
2252 ## Do some clean-up works when error occurred\r
2253 def Relinquish(self):\r
2254 OldLogLevel = EdkLogger.GetLevel()\r
2255 EdkLogger.SetLevel(EdkLogger.ERROR)\r
52302d4d
LG
2256 Utils.Progressor.Abort()\r
2257 if self.SpawnMode == True:\r
2258 BuildTask.Abort()\r
2259 EdkLogger.SetLevel(OldLogLevel)\r
2260\r
52302d4d
LG
2261def ParseDefines(DefineList=[]):\r
2262 DefineDict = {}\r
4231a819 2263 if DefineList is not None:\r
52302d4d
LG
2264 for Define in DefineList:\r
2265 DefineTokenList = Define.split("=", 1)\r
0d2711a6
LG
2266 if not GlobalData.gMacroNamePattern.match(DefineTokenList[0]):\r
2267 EdkLogger.error('build', FORMAT_INVALID,\r
2268 "The macro name must be in the pattern [A-Z][A-Z0-9_]*",\r
2269 ExtraData=DefineTokenList[0])\r
4afd3d04 2270\r
52302d4d 2271 if len(DefineTokenList) == 1:\r
0d2711a6 2272 DefineDict[DefineTokenList[0]] = "TRUE"\r
52302d4d
LG
2273 else:\r
2274 DefineDict[DefineTokenList[0]] = DefineTokenList[1].strip()\r
2275 return DefineDict\r
2276\r
2277gParamCheck = []\r
2278def SingleCheckCallback(option, opt_str, value, parser):\r
2279 if option not in gParamCheck:\r
2280 setattr(parser.values, option.dest, value)\r
2281 gParamCheck.append(option)\r
2282 else:\r
2283 parser.error("Option %s only allows one instance in command line!" % option)\r
2284\r
1b8eca8b
YZ
2285def LogBuildTime(Time):\r
2286 if Time:\r
2287 TimeDurStr = ''\r
2288 TimeDur = time.gmtime(Time)\r
2289 if TimeDur.tm_yday > 1:\r
2290 TimeDurStr = time.strftime("%H:%M:%S", TimeDur) + ", %d day(s)" % (TimeDur.tm_yday - 1)\r
2291 else:\r
2292 TimeDurStr = time.strftime("%H:%M:%S", TimeDur)\r
2293 return TimeDurStr\r
2294 else:\r
2295 return None\r
2296\r
52302d4d
LG
2297## Parse command line options\r
2298#\r
2299# Using standard Python module optparse to parse command line option of this tool.\r
2300#\r
2301# @retval Opt A optparse.Values object containing the parsed options\r
2302# @retval Args Target of build command\r
2303#\r
2304def MyOptionParser():\r
47fea6af 2305 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
2306 Parser.add_option("-a", "--arch", action="append", type="choice", choices=['IA32', 'X64', 'EBC', 'ARM', 'AARCH64'], dest="TargetArch",\r
2307 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
2308 Parser.add_option("-p", "--platform", action="callback", type="string", dest="PlatformFile", callback=SingleCheckCallback,\r
2309 help="Build the platform specified by the DSC file name argument, overriding target.txt's ACTIVE_PLATFORM definition.")\r
2310 Parser.add_option("-m", "--module", action="callback", type="string", dest="ModuleFile", callback=SingleCheckCallback,\r
2311 help="Build the module specified by the INF file name argument.")\r
64b2609f
LG
2312 Parser.add_option("-b", "--buildtarget", type="string", dest="BuildTarget", help="Using the TARGET to build the platform, overriding target.txt's TARGET definition.",\r
2313 action="append")\r
52302d4d
LG
2314 Parser.add_option("-t", "--tagname", action="append", type="string", dest="ToolChain",\r
2315 help="Using the Tool Chain Tagname to build the platform, overriding target.txt's TOOL_CHAIN_TAG definition.")\r
2316 Parser.add_option("-x", "--sku-id", action="callback", type="string", dest="SkuId", callback=SingleCheckCallback,\r
2317 help="Using this name of SKU ID to build the platform, overriding SKUID_IDENTIFIER in DSC file.")\r
2318\r
2319 Parser.add_option("-n", action="callback", type="int", dest="ThreadNumber", callback=SingleCheckCallback,\r
2052cb67
YZ
2320 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
2321 "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
2322\r
2323 Parser.add_option("-f", "--fdf", action="callback", type="string", dest="FdfFile", callback=SingleCheckCallback,\r
2324 help="The name of the FDF file to use, which overrides the setting in the DSC file.")\r
2325 Parser.add_option("-r", "--rom-image", action="append", type="string", dest="RomImage", default=[],\r
2326 help="The name of FD to be generated. The name must be from [FD] section in FDF file.")\r
2327 Parser.add_option("-i", "--fv-image", action="append", type="string", dest="FvImage", default=[],\r
2328 help="The name of FV to be generated. The name must be from [FV] section in FDF file.")\r
4234283c
LG
2329 Parser.add_option("-C", "--capsule-image", action="append", type="string", dest="CapName", default=[],\r
2330 help="The name of Capsule to be generated. The name must be from [Capsule] section in FDF file.")\r
52302d4d
LG
2331 Parser.add_option("-u", "--skip-autogen", action="store_true", dest="SkipAutoGen", help="Skip AutoGen step.")\r
2332 Parser.add_option("-e", "--re-parse", action="store_true", dest="Reparse", help="Re-parse all meta-data files.")\r
2333\r
0d2711a6 2334 Parser.add_option("-c", "--case-insensitive", action="store_true", dest="CaseInsensitive", default=False, help="Don't check case of file name.")\r
52302d4d
LG
2335\r
2336 Parser.add_option("-w", "--warning-as-error", action="store_true", dest="WarningAsError", help="Treat warning in tools as error.")\r
2337 Parser.add_option("-j", "--log", action="store", dest="LogFile", help="Put log in specified file as well as on console.")\r
2338\r
2339 Parser.add_option("-s", "--silent", action="store_true", type=None, dest="SilentMode",\r
2340 help="Make use of silent mode of (n)make.")\r
2341 Parser.add_option("-q", "--quiet", action="store_true", type=None, help="Disable all messages except FATAL ERRORS.")\r
2342 Parser.add_option("-v", "--verbose", action="store_true", type=None, help="Turn on verbose output with informational messages printed, "\\r
2343 "including library instances selected, final dependency expression, "\\r
2344 "and warning messages, etc.")\r
2345 Parser.add_option("-d", "--debug", action="store", type="int", help="Enable debug messages at specified level.")\r
2346 Parser.add_option("-D", "--define", action="append", type="string", dest="Macros", help="Macro: \"Name [= Value]\".")\r
2347\r
2348 Parser.add_option("-y", "--report-file", action="store", dest="ReportFile", help="Create/overwrite the report to the specified filename.")\r
ccaa7754 2349 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 2350 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 2351 "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
2352 Parser.add_option("-F", "--flag", action="store", type="string", dest="Flag",\r
2353 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
2354 "This option can also be specified by setting *_*_*_BUILD_FLAGS in [BuildOptions] section of platform DSC. If they are both specified, this value "\\r
2355 "will override the setting in [BuildOptions] section of platform DSC.")\r
0d2711a6 2356 Parser.add_option("-N", "--no-cache", action="store_true", dest="DisableCache", default=False, help="Disable build cache mechanism")\r
97fa0ee9
YL
2357 Parser.add_option("--conf", action="store", type="string", dest="ConfDirectory", help="Specify the customized Conf directory.")\r
2358 Parser.add_option("--check-usage", action="store_true", dest="CheckUsage", default=False, help="Check usage content of entries listed in INF file.")\r
fae62ff2 2359 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 2360 Parser.add_option("--pcd", action="append", dest="OptionPcd", help="Set PCD value by command line. Format: \"PcdName=Value\" ")\r
725cdb8f 2361 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
2362 Parser.add_option("--hash", action="store_true", dest="UseHashCache", default=False, help="Enable hash-based caching during build process.")\r
2363 Parser.add_option("--binary-destination", action="store", type="string", dest="BinCacheDest", help="Generate a cache of binary files in the specified directory.")\r
2364 Parser.add_option("--binary-source", action="store", type="string", dest="BinCacheSource", help="Consume a cache of binary files from the specified directory.")\r
37de70b7 2365 Parser.add_option("--genfds-multi-thread", action="store_true", dest="GenfdsMultiThread", default=False, help="Enable GenFds multi thread to generate ffs file.")\r
d868846a 2366 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 2367 (Opt, Args) = Parser.parse_args()\r
52302d4d
LG
2368 return (Opt, Args)\r
2369\r
2370## Tool entrance method\r
2371#\r
2372# This method mainly dispatch specific methods per the command line options.\r
2373# If no error found, return zero value so the caller of this tool can know\r
2374# if it's executed successfully or not.\r
2375#\r
2376# @retval 0 Tool was successful\r
2377# @retval 1 Tool failed\r
2378#\r
2379def Main():\r
2380 StartTime = time.time()\r
2381\r
2382 # Initialize log system\r
2383 EdkLogger.Initialize()\r
f0dc69e6 2384 GlobalData.gCommand = sys.argv[1:]\r
52302d4d
LG
2385 #\r
2386 # Parse the options and args\r
2387 #\r
2388 (Option, Target) = MyOptionParser()\r
2389 GlobalData.gOptions = Option\r
2390 GlobalData.gCaseInsensitive = Option.CaseInsensitive\r
2391\r
2392 # Set log level\r
4231a819 2393 if Option.verbose is not None:\r
52302d4d 2394 EdkLogger.SetLevel(EdkLogger.VERBOSE)\r
4231a819 2395 elif Option.quiet is not None:\r
52302d4d 2396 EdkLogger.SetLevel(EdkLogger.QUIET)\r
4231a819 2397 elif Option.debug is not None:\r
52302d4d
LG
2398 EdkLogger.SetLevel(Option.debug + 1)\r
2399 else:\r
2400 EdkLogger.SetLevel(EdkLogger.INFO)\r
2401\r
4231a819 2402 if Option.LogFile is not None:\r
52302d4d
LG
2403 EdkLogger.SetLogFile(Option.LogFile)\r
2404\r
2405 if Option.WarningAsError == True:\r
2406 EdkLogger.SetWarningAsError()\r
2407\r
2408 if platform.platform().find("Windows") >= 0:\r
2409 GlobalData.gIsWindows = True\r
2410 else:\r
2411 GlobalData.gIsWindows = False\r
2412\r
6780eef1
LG
2413 EdkLogger.quiet("Build environment: %s" % platform.platform())\r
2414 EdkLogger.quiet(time.strftime("Build start time: %H:%M:%S, %b.%d %Y\n", time.localtime()));\r
52302d4d
LG
2415 ReturnCode = 0\r
2416 MyBuild = None\r
09ae0f11 2417 BuildError = True\r
52302d4d
LG
2418 try:\r
2419 if len(Target) == 0:\r
2420 Target = "all"\r
2421 elif len(Target) >= 2:\r
2422 EdkLogger.error("build", OPTION_NOT_SUPPORTED, "More than one targets are not supported.",\r
47fea6af 2423 ExtraData="Please select one of: %s" % (' '.join(gSupportedTarget)))\r
52302d4d
LG
2424 else:\r
2425 Target = Target[0].lower()\r
2426\r
2427 if Target not in gSupportedTarget:\r
2428 EdkLogger.error("build", OPTION_NOT_SUPPORTED, "Not supported target [%s]." % Target,\r
47fea6af 2429 ExtraData="Please select one of: %s" % (' '.join(gSupportedTarget)))\r
52302d4d 2430\r
52302d4d
LG
2431 #\r
2432 # Check environment variable: EDK_TOOLS_PATH, WORKSPACE, PATH\r
2433 #\r
2434 CheckEnvVariable()\r
0d2711a6
LG
2435 GlobalData.gCommandLineDefines.update(ParseDefines(Option.Macros))\r
2436\r
52302d4d
LG
2437 Workspace = os.getenv("WORKSPACE")\r
2438 #\r
2439 # Get files real name in workspace dir\r
2440 #\r
2441 GlobalData.gAllFiles = Utils.DirCache(Workspace)\r
2442\r
2443 WorkingDirectory = os.getcwd()\r
2444 if not Option.ModuleFile:\r
2445 FileList = glob.glob(os.path.normpath(os.path.join(WorkingDirectory, '*.inf')))\r
2446 FileNum = len(FileList)\r
2447 if FileNum >= 2:\r
2448 EdkLogger.error("build", OPTION_NOT_SUPPORTED, "There are %d INF files in %s." % (FileNum, WorkingDirectory),\r
2449 ExtraData="Please use '-m <INF_FILE_PATH>' switch to choose one.")\r
2450 elif FileNum == 1:\r
2451 Option.ModuleFile = NormFile(FileList[0], Workspace)\r
2452\r
2453 if Option.ModuleFile:\r
2454 if os.path.isabs (Option.ModuleFile):\r
2455 if os.path.normcase (os.path.normpath(Option.ModuleFile)).find (Workspace) == 0:\r
2456 Option.ModuleFile = NormFile(os.path.normpath(Option.ModuleFile), Workspace)\r
2457 Option.ModuleFile = PathClass(Option.ModuleFile, Workspace)\r
2458 ErrorCode, ErrorInfo = Option.ModuleFile.Validate(".inf", False)\r
2459 if ErrorCode != 0:\r
2460 EdkLogger.error("build", ErrorCode, ExtraData=ErrorInfo)\r
2461\r
4231a819 2462 if Option.PlatformFile is not None:\r
52302d4d
LG
2463 if os.path.isabs (Option.PlatformFile):\r
2464 if os.path.normcase (os.path.normpath(Option.PlatformFile)).find (Workspace) == 0:\r
2465 Option.PlatformFile = NormFile(os.path.normpath(Option.PlatformFile), Workspace)\r
2466 Option.PlatformFile = PathClass(Option.PlatformFile, Workspace)\r
52302d4d 2467\r
4231a819 2468 if Option.FdfFile is not None:\r
52302d4d
LG
2469 if os.path.isabs (Option.FdfFile):\r
2470 if os.path.normcase (os.path.normpath(Option.FdfFile)).find (Workspace) == 0:\r
2471 Option.FdfFile = NormFile(os.path.normpath(Option.FdfFile), Workspace)\r
2472 Option.FdfFile = PathClass(Option.FdfFile, Workspace)\r
2473 ErrorCode, ErrorInfo = Option.FdfFile.Validate(".fdf", False)\r
2474 if ErrorCode != 0:\r
2475 EdkLogger.error("build", ErrorCode, ExtraData=ErrorInfo)\r
2476\r
4231a819 2477 if Option.Flag is not None and Option.Flag not in ['-c', '-s']:\r
f3decdc3
LG
2478 EdkLogger.error("build", OPTION_VALUE_INVALID, "UNI flag must be one of -c or -s")\r
2479\r
0d2711a6 2480 MyBuild = Build(Target, Workspace, Option)\r
64b2609f 2481 GlobalData.gCommandLineDefines['ARCH'] = ' '.join(MyBuild.ArchList)\r
f0dc69e6
YZ
2482 if not (MyBuild.LaunchPrebuildFlag and os.path.exists(MyBuild.PlatformBuildPath)):\r
2483 MyBuild.Launch()\r
2f818ed0 2484\r
09ae0f11
YL
2485 #\r
2486 # All job done, no error found and no exception raised\r
2487 #\r
2488 BuildError = False\r
5b0671c1 2489 except FatalError as X:\r
4231a819 2490 if MyBuild is not None:\r
52302d4d
LG
2491 # for multi-thread build exits safely\r
2492 MyBuild.Relinquish()\r
4231a819 2493 if Option is not None and Option.debug is not None:\r
52302d4d
LG
2494 EdkLogger.quiet("(Python %s on %s) " % (platform.python_version(), sys.platform) + traceback.format_exc())\r
2495 ReturnCode = X.args[0]\r
5b0671c1 2496 except Warning as X:\r
52302d4d 2497 # error from Fdf parser\r
4231a819 2498 if MyBuild is not None:\r
52302d4d
LG
2499 # for multi-thread build exits safely\r
2500 MyBuild.Relinquish()\r
4231a819 2501 if Option is not None and Option.debug is not None:\r
52302d4d
LG
2502 EdkLogger.quiet("(Python %s on %s) " % (platform.python_version(), sys.platform) + traceback.format_exc())\r
2503 else:\r
47fea6af 2504 EdkLogger.error(X.ToolName, FORMAT_INVALID, File=X.FileName, Line=X.LineNumber, ExtraData=X.Message, RaiseError=False)\r
52302d4d
LG
2505 ReturnCode = FORMAT_INVALID\r
2506 except KeyboardInterrupt:\r
2507 ReturnCode = ABORT_ERROR\r
4231a819 2508 if Option is not None and Option.debug is not None:\r
52302d4d
LG
2509 EdkLogger.quiet("(Python %s on %s) " % (platform.python_version(), sys.platform) + traceback.format_exc())\r
2510 except:\r
4231a819 2511 if MyBuild is not None:\r
52302d4d
LG
2512 # for multi-thread build exits safely\r
2513 MyBuild.Relinquish()\r
2514\r
2515 # try to get the meta-file from the object causing exception\r
2516 Tb = sys.exc_info()[-1]\r
2517 MetaFile = GlobalData.gProcessingFile\r
4231a819 2518 while Tb is not None:\r
52302d4d
LG
2519 if 'self' in Tb.tb_frame.f_locals and hasattr(Tb.tb_frame.f_locals['self'], 'MetaFile'):\r
2520 MetaFile = Tb.tb_frame.f_locals['self'].MetaFile\r
2521 Tb = Tb.tb_next\r
2522 EdkLogger.error(\r
2523 "\nbuild",\r
2524 CODE_ERROR,\r
2525 "Unknown fatal error when processing [%s]" % MetaFile,\r
c1387446 2526 ExtraData="\n(Please send email to %s for help, attaching following call stack trace!)\n" % MSG_EDKII_MAIL_ADDR,\r
52302d4d
LG
2527 RaiseError=False\r
2528 )\r
d0acc87a 2529 EdkLogger.quiet("(Python %s on %s) " % (platform.python_version(), sys.platform) + traceback.format_exc())\r
52302d4d
LG
2530 ReturnCode = CODE_ERROR\r
2531 finally:\r
2532 Utils.Progressor.Abort()\r
97fa0ee9 2533 Utils.ClearDuplicatedInf()\r
52302d4d
LG
2534\r
2535 if ReturnCode == 0:\r
f0dc69e6 2536 try:\r
91048b0d 2537 MyBuild.LaunchPostbuild()\r
f0dc69e6
YZ
2538 Conclusion = "Done"\r
2539 except:\r
2540 Conclusion = "Failed"\r
52302d4d
LG
2541 elif ReturnCode == ABORT_ERROR:\r
2542 Conclusion = "Aborted"\r
2543 else:\r
2544 Conclusion = "Failed"\r
2545 FinishTime = time.time()\r
4234283c
LG
2546 BuildDuration = time.gmtime(int(round(FinishTime - StartTime)))\r
2547 BuildDurationStr = ""\r
2548 if BuildDuration.tm_yday > 1:\r
47fea6af 2549 BuildDurationStr = time.strftime("%H:%M:%S", BuildDuration) + ", %d day(s)" % (BuildDuration.tm_yday - 1)\r
4234283c
LG
2550 else:\r
2551 BuildDurationStr = time.strftime("%H:%M:%S", BuildDuration)\r
4231a819 2552 if MyBuild is not None:\r
09ae0f11 2553 if not BuildError:\r
1b8eca8b 2554 MyBuild.BuildReport.GenerateReport(BuildDurationStr, LogBuildTime(MyBuild.AutoGenTime), LogBuildTime(MyBuild.MakeTime), LogBuildTime(MyBuild.GenFdsTime))\r
2f818ed0 2555\r
52302d4d 2556 EdkLogger.SetLevel(EdkLogger.QUIET)\r
6780eef1
LG
2557 EdkLogger.quiet("\n- %s -" % Conclusion)\r
2558 EdkLogger.quiet(time.strftime("Build end time: %H:%M:%S, %b.%d %Y", time.localtime()))\r
4234283c 2559 EdkLogger.quiet("Build total time: %s\n" % BuildDurationStr)\r
52302d4d
LG
2560 return ReturnCode\r
2561\r
2562if __name__ == '__main__':\r
2563 r = Main()\r
2564 ## 0-127 is a safe return range, and 1 is a standard default error\r
2565 if r < 0 or r > 127: r = 1\r
2566 sys.exit(r)\r
2567\r