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