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