2 # build a platform or a module
4 # Copyright (c) 2014, Hewlett-Packard Development Company, L.P.<BR>
5 # Copyright (c) 2007 - 2017, Intel Corporation. All rights reserved.<BR>
7 # This program and the accompanying materials
8 # are licensed and made available under the terms and conditions of the BSD License
9 # which accompanies this distribution. The full text of the license may be found at
10 # http://opensource.org/licenses/bsd-license.php
12 # THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
13 # WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
19 import Common
.LongFilePathOs
as os
27 import encodings
.ascii
31 from threading
import *
32 from optparse
import OptionParser
33 from subprocess
import *
34 from Common
import Misc
as Utils
36 from Common
.LongFilePathSupport
import OpenLongFilePath
as open
37 from Common
.LongFilePathSupport
import LongFilePath
38 from Common
.TargetTxtClassObject
import *
39 from Common
.ToolDefClassObject
import *
40 from Common
.DataType
import *
41 from Common
.BuildVersion
import gBUILD_VERSION
42 from AutoGen
.AutoGen
import *
43 from Common
.BuildToolError
import *
44 from Workspace
.WorkspaceDatabase
import *
45 from Common
.MultipleWorkspace
import MultipleWorkspace
as mws
47 from BuildReport
import BuildReport
48 from GenPatchPcdTable
.GenPatchPcdTable
import *
49 from PatchPcdValue
.PatchPcdValue
import *
51 import Common
.EdkLogger
52 import Common
.GlobalData
as GlobalData
54 # Version and Copyright
55 VersionNumber
= "0.60" + ' ' + gBUILD_VERSION
56 __version__
= "%prog Version " + VersionNumber
57 __copyright__
= "Copyright (c) 2007 - 2017, Intel Corporation All rights reserved."
59 ## standard targets of build command
60 gSupportedTarget
= ['all', 'genc', 'genmake', 'modules', 'libraries', 'fds', 'clean', 'cleanall', 'cleanlib', 'run']
62 ## build configuration file
63 gBuildConfiguration
= "target.txt"
64 gToolsDefinition
= "tools_def.txt"
66 TemporaryTablePattern
= re
.compile(r
'^_\d+_\d+_[a-fA-F0-9]+$')
69 ## Check environment PATH variable to make sure the specified tool is found
71 # If the tool is found in the PATH, then True is returned
72 # Otherwise, False is returned
74 def IsToolInPath(tool
):
75 if os
.environ
.has_key('PATHEXT'):
76 extns
= os
.environ
['PATHEXT'].split(os
.path
.pathsep
)
79 for pathDir
in os
.environ
['PATH'].split(os
.path
.pathsep
):
81 if os
.path
.exists(os
.path
.join(pathDir
, tool
+ ext
)):
85 ## Check environment variables
87 # Check environment variables that must be set for build. Currently they are
89 # WORKSPACE The directory all packages/platforms start from
90 # EDK_TOOLS_PATH The directory contains all tools needed by the build
91 # PATH $(EDK_TOOLS_PATH)/Bin/<sys> must be set in PATH
93 # If any of above environment variable is not set or has error, the build
96 def CheckEnvVariable():
98 if "WORKSPACE" not in os
.environ
:
99 EdkLogger
.error("build", ATTRIBUTE_NOT_AVAILABLE
, "Environment variable not found",
100 ExtraData
="WORKSPACE")
102 WorkspaceDir
= os
.path
.normcase(os
.path
.normpath(os
.environ
["WORKSPACE"]))
103 if not os
.path
.exists(WorkspaceDir
):
104 EdkLogger
.error("build", FILE_NOT_FOUND
, "WORKSPACE doesn't exist", ExtraData
="%s" % WorkspaceDir
)
105 elif ' ' in WorkspaceDir
:
106 EdkLogger
.error("build", FORMAT_NOT_SUPPORTED
, "No space is allowed in WORKSPACE path",
107 ExtraData
=WorkspaceDir
)
108 os
.environ
["WORKSPACE"] = WorkspaceDir
110 # set multiple workspace
111 PackagesPath
= os
.getenv("PACKAGES_PATH")
112 mws
.setWs(WorkspaceDir
, PackagesPath
)
113 if mws
.PACKAGES_PATH
:
114 for Path
in mws
.PACKAGES_PATH
:
115 if not os
.path
.exists(Path
):
116 EdkLogger
.error("build", FILE_NOT_FOUND
, "One Path in PACKAGES_PATH doesn't exist", ExtraData
="%s" % Path
)
118 EdkLogger
.error("build", FORMAT_NOT_SUPPORTED
, "No space is allowed in PACKAGES_PATH", ExtraData
=Path
)
121 # Check EFI_SOURCE (Edk build convention). EDK_SOURCE will always point to ECP
123 if "ECP_SOURCE" not in os
.environ
:
124 os
.environ
["ECP_SOURCE"] = mws
.join(WorkspaceDir
, GlobalData
.gEdkCompatibilityPkg
)
125 if "EFI_SOURCE" not in os
.environ
:
126 os
.environ
["EFI_SOURCE"] = os
.environ
["ECP_SOURCE"]
127 if "EDK_SOURCE" not in os
.environ
:
128 os
.environ
["EDK_SOURCE"] = os
.environ
["ECP_SOURCE"]
131 # Unify case of characters on case-insensitive systems
133 EfiSourceDir
= os
.path
.normcase(os
.path
.normpath(os
.environ
["EFI_SOURCE"]))
134 EdkSourceDir
= os
.path
.normcase(os
.path
.normpath(os
.environ
["EDK_SOURCE"]))
135 EcpSourceDir
= os
.path
.normcase(os
.path
.normpath(os
.environ
["ECP_SOURCE"]))
137 os
.environ
["EFI_SOURCE"] = EfiSourceDir
138 os
.environ
["EDK_SOURCE"] = EdkSourceDir
139 os
.environ
["ECP_SOURCE"] = EcpSourceDir
140 os
.environ
["EDK_TOOLS_PATH"] = os
.path
.normcase(os
.environ
["EDK_TOOLS_PATH"])
142 if not os
.path
.exists(EcpSourceDir
):
143 EdkLogger
.verbose("ECP_SOURCE = %s doesn't exist. Edk modules could not be built." % EcpSourceDir
)
144 elif ' ' in EcpSourceDir
:
145 EdkLogger
.error("build", FORMAT_NOT_SUPPORTED
, "No space is allowed in ECP_SOURCE path",
146 ExtraData
=EcpSourceDir
)
147 if not os
.path
.exists(EdkSourceDir
):
148 if EdkSourceDir
== EcpSourceDir
:
149 EdkLogger
.verbose("EDK_SOURCE = %s doesn't exist. Edk modules could not be built." % EdkSourceDir
)
151 EdkLogger
.error("build", PARAMETER_INVALID
, "EDK_SOURCE does not exist",
152 ExtraData
=EdkSourceDir
)
153 elif ' ' in EdkSourceDir
:
154 EdkLogger
.error("build", FORMAT_NOT_SUPPORTED
, "No space is allowed in EDK_SOURCE path",
155 ExtraData
=EdkSourceDir
)
156 if not os
.path
.exists(EfiSourceDir
):
157 if EfiSourceDir
== EcpSourceDir
:
158 EdkLogger
.verbose("EFI_SOURCE = %s doesn't exist. Edk modules could not be built." % EfiSourceDir
)
160 EdkLogger
.error("build", PARAMETER_INVALID
, "EFI_SOURCE does not exist",
161 ExtraData
=EfiSourceDir
)
162 elif ' ' in EfiSourceDir
:
163 EdkLogger
.error("build", FORMAT_NOT_SUPPORTED
, "No space is allowed in EFI_SOURCE path",
164 ExtraData
=EfiSourceDir
)
166 # check those variables on single workspace case
168 # change absolute path to relative path to WORKSPACE
169 if EfiSourceDir
.upper().find(WorkspaceDir
.upper()) != 0:
170 EdkLogger
.error("build", PARAMETER_INVALID
, "EFI_SOURCE is not under WORKSPACE",
171 ExtraData
="WORKSPACE = %s\n EFI_SOURCE = %s" % (WorkspaceDir
, EfiSourceDir
))
172 if EdkSourceDir
.upper().find(WorkspaceDir
.upper()) != 0:
173 EdkLogger
.error("build", PARAMETER_INVALID
, "EDK_SOURCE is not under WORKSPACE",
174 ExtraData
="WORKSPACE = %s\n EDK_SOURCE = %s" % (WorkspaceDir
, EdkSourceDir
))
175 if EcpSourceDir
.upper().find(WorkspaceDir
.upper()) != 0:
176 EdkLogger
.error("build", PARAMETER_INVALID
, "ECP_SOURCE is not under WORKSPACE",
177 ExtraData
="WORKSPACE = %s\n ECP_SOURCE = %s" % (WorkspaceDir
, EcpSourceDir
))
179 # check EDK_TOOLS_PATH
180 if "EDK_TOOLS_PATH" not in os
.environ
:
181 EdkLogger
.error("build", ATTRIBUTE_NOT_AVAILABLE
, "Environment variable not found",
182 ExtraData
="EDK_TOOLS_PATH")
185 if "PATH" not in os
.environ
:
186 EdkLogger
.error("build", ATTRIBUTE_NOT_AVAILABLE
, "Environment variable not found",
189 GlobalData
.gWorkspace
= WorkspaceDir
190 GlobalData
.gEfiSource
= EfiSourceDir
191 GlobalData
.gEdkSource
= EdkSourceDir
192 GlobalData
.gEcpSource
= EcpSourceDir
194 GlobalData
.gGlobalDefines
["WORKSPACE"] = WorkspaceDir
195 GlobalData
.gGlobalDefines
["EFI_SOURCE"] = EfiSourceDir
196 GlobalData
.gGlobalDefines
["EDK_SOURCE"] = EdkSourceDir
197 GlobalData
.gGlobalDefines
["ECP_SOURCE"] = EcpSourceDir
198 GlobalData
.gGlobalDefines
["EDK_TOOLS_PATH"] = os
.environ
["EDK_TOOLS_PATH"]
200 ## Get normalized file path
202 # Convert the path to be local format, and remove the WORKSPACE path at the
203 # beginning if the file path is given in full path.
205 # @param FilePath File path to be normalized
206 # @param Workspace Workspace path which the FilePath will be checked against
208 # @retval string The normalized file path
210 def NormFile(FilePath
, Workspace
):
211 # check if the path is absolute or relative
212 if os
.path
.isabs(FilePath
):
213 FileFullPath
= os
.path
.normpath(FilePath
)
215 FileFullPath
= os
.path
.normpath(mws
.join(Workspace
, FilePath
))
216 Workspace
= mws
.getWs(Workspace
, FilePath
)
218 # check if the file path exists or not
219 if not os
.path
.isfile(FileFullPath
):
220 EdkLogger
.error("build", FILE_NOT_FOUND
, ExtraData
="\t%s (Please give file in absolute path or relative to WORKSPACE)" % FileFullPath
)
222 # remove workspace directory from the beginning part of the file path
223 if Workspace
[-1] in ["\\", "/"]:
224 return FileFullPath
[len(Workspace
):]
226 return FileFullPath
[(len(Workspace
) + 1):]
228 ## Get the output of an external program
230 # This is the entrance method of thread reading output of an external program and
231 # putting them in STDOUT/STDERR of current program.
233 # @param From The stream message read from
234 # @param To The stream message put on
235 # @param ExitFlag The flag used to indicate stopping reading
237 def ReadMessage(From
, To
, ExitFlag
):
239 # read one line a time
240 Line
= From
.readline()
241 # empty string means "end"
242 if Line
!= None and Line
!= "":
249 ## Launch an external program
251 # This method will call subprocess.Popen to execute an external program with
252 # given options in specified directory. Because of the dead-lock issue during
253 # redirecting output of the external program, threads are used to to do the
256 # @param Command A list or string containing the call of the program
257 # @param WorkingDir The directory in which the program will be running
259 def LaunchCommand(Command
, WorkingDir
):
260 BeginTime
= time
.time()
261 # if working directory doesn't exist, Popen() will raise an exception
262 if not os
.path
.isdir(WorkingDir
):
263 EdkLogger
.error("build", FILE_NOT_FOUND
, ExtraData
=WorkingDir
)
265 # Command is used as the first Argument in following Popen().
266 # It could be a string or sequence. We find that if command is a string in following Popen(),
267 # ubuntu may fail with an error message that the command is not found.
268 # So here we may need convert command from string to list instance.
269 if platform
.system() != 'Windows':
270 if not isinstance(Command
, list):
271 Command
= Command
.split()
272 Command
= ' '.join(Command
)
275 EndOfProcedure
= None
278 Proc
= Popen(Command
, stdout
=PIPE
, stderr
=PIPE
, env
=os
.environ
, cwd
=WorkingDir
, bufsize
=-1, shell
=True)
280 # launch two threads to read the STDOUT and STDERR
281 EndOfProcedure
= Event()
282 EndOfProcedure
.clear()
284 StdOutThread
= Thread(target
=ReadMessage
, args
=(Proc
.stdout
, EdkLogger
.info
, EndOfProcedure
))
285 StdOutThread
.setName("STDOUT-Redirector")
286 StdOutThread
.setDaemon(False)
290 StdErrThread
= Thread(target
=ReadMessage
, args
=(Proc
.stderr
, EdkLogger
.quiet
, EndOfProcedure
))
291 StdErrThread
.setName("STDERR-Redirector")
292 StdErrThread
.setDaemon(False)
295 # waiting for program exit
297 except: # in case of aborting
298 # terminate the threads redirecting the program output
299 EdkLogger
.quiet("(Python %s on %s) " % (platform
.python_version(), sys
.platform
) + traceback
.format_exc())
300 if EndOfProcedure
!= None:
303 if type(Command
) != type(""):
304 Command
= " ".join(Command
)
305 EdkLogger
.error("build", COMMAND_FAILURE
, "Failed to start command", ExtraData
="%s [%s]" % (Command
, WorkingDir
))
312 # check the return code of the program
313 if Proc
.returncode
!= 0:
314 if type(Command
) != type(""):
315 Command
= " ".join(Command
)
316 # print out the Response file and its content when make failure
317 RespFile
= os
.path
.join(WorkingDir
, 'OUTPUT', 'respfilelist.txt')
318 if os
.path
.isfile(RespFile
):
320 RespContent
= f
.read()
322 EdkLogger
.info(RespContent
)
324 EdkLogger
.error("build", COMMAND_FAILURE
, ExtraData
="%s [%s]" % (Command
, WorkingDir
))
325 return "%dms" % (int(round((time
.time() - BeginTime
) * 1000)))
327 ## The smallest unit that can be built in multi-thread build mode
329 # This is the base class of build unit. The "Obj" parameter must provide
330 # __str__(), __eq__() and __hash__() methods. Otherwise there could be build units
333 # Currently the "Obj" should be only ModuleAutoGen or PlatformAutoGen objects.
338 # @param self The object pointer
339 # @param Obj The object the build is working on
340 # @param Target The build target name, one of gSupportedTarget
341 # @param Dependency The BuildUnit(s) which must be completed in advance
342 # @param WorkingDir The directory build command starts in
344 def __init__(self
, Obj
, BuildCommand
, Target
, Dependency
, WorkingDir
="."):
345 self
.BuildObject
= Obj
346 self
.Dependency
= Dependency
347 self
.WorkingDir
= WorkingDir
349 self
.BuildCommand
= BuildCommand
351 EdkLogger
.error("build", OPTION_MISSING
,
352 "No build command found for this module. "
353 "Please check your setting of %s_%s_%s_MAKE_PATH in Conf/tools_def.txt file." %
354 (Obj
.BuildTarget
, Obj
.ToolChain
, Obj
.Arch
),
360 # It just returns the string representation of self.BuildObject
362 # @param self The object pointer
365 return str(self
.BuildObject
)
367 ## "==" operator method
369 # It just compares self.BuildObject with "Other". So self.BuildObject must
370 # provide its own __eq__() method.
372 # @param self The object pointer
373 # @param Other The other BuildUnit object compared to
375 def __eq__(self
, Other
):
376 return Other
!= None and self
.BuildObject
== Other
.BuildObject \
377 and self
.BuildObject
.Arch
== Other
.BuildObject
.Arch
381 # It just returns the hash value of self.BuildObject which must be hashable.
383 # @param self The object pointer
386 return hash(self
.BuildObject
) + hash(self
.BuildObject
.Arch
)
389 return repr(self
.BuildObject
)
391 ## The smallest module unit that can be built by nmake/make command in multi-thread build mode
393 # This class is for module build by nmake/make build system. The "Obj" parameter
394 # must provide __str__(), __eq__() and __hash__() methods. Otherwise there could
395 # be make units missing build.
397 # Currently the "Obj" should be only ModuleAutoGen object.
399 class ModuleMakeUnit(BuildUnit
):
402 # @param self The object pointer
403 # @param Obj The ModuleAutoGen object the build is working on
404 # @param Target The build target name, one of gSupportedTarget
406 def __init__(self
, Obj
, Target
):
407 Dependency
= [ModuleMakeUnit(La
, Target
) for La
in Obj
.LibraryAutoGenList
]
408 BuildUnit
.__init
__(self
, Obj
, Obj
.BuildCommand
, Target
, Dependency
, Obj
.MakeFileDir
)
409 if Target
in [None, "", "all"]:
410 self
.Target
= "tbuild"
412 ## The smallest platform unit that can be built by nmake/make command in multi-thread build mode
414 # This class is for platform build by nmake/make build system. The "Obj" parameter
415 # must provide __str__(), __eq__() and __hash__() methods. Otherwise there could
416 # be make units missing build.
418 # Currently the "Obj" should be only PlatformAutoGen object.
420 class PlatformMakeUnit(BuildUnit
):
423 # @param self The object pointer
424 # @param Obj The PlatformAutoGen object the build is working on
425 # @param Target The build target name, one of gSupportedTarget
427 def __init__(self
, Obj
, Target
):
428 Dependency
= [ModuleMakeUnit(Lib
, Target
) for Lib
in self
.BuildObject
.LibraryAutoGenList
]
429 Dependency
.extend([ModuleMakeUnit(Mod
, Target
) for Mod
in self
.BuildObject
.ModuleAutoGenList
])
430 BuildUnit
.__init
__(self
, Obj
, Obj
.BuildCommand
, Target
, Dependency
, Obj
.MakeFileDir
)
432 ## The class representing the task of a module build or platform build
434 # This class manages the build tasks in multi-thread build mode. Its jobs include
435 # scheduling thread running, catching thread error, monitor the thread status, etc.
438 # queue for tasks waiting for schedule
439 _PendingQueue
= sdict()
440 _PendingQueueLock
= threading
.Lock()
442 # queue for tasks ready for running
443 _ReadyQueue
= sdict()
444 _ReadyQueueLock
= threading
.Lock()
446 # queue for run tasks
447 _RunningQueue
= sdict()
448 _RunningQueueLock
= threading
.Lock()
450 # queue containing all build tasks, in case duplicate build
453 # flag indicating error occurs in a running thread
454 _ErrorFlag
= threading
.Event()
458 # BoundedSemaphore object used to control the number of running threads
461 # flag indicating if the scheduler is started or not
462 _SchedulerStopped
= threading
.Event()
463 _SchedulerStopped
.set()
465 ## Start the task scheduler thread
467 # @param MaxThreadNumber The maximum thread number
468 # @param ExitFlag Flag used to end the scheduler
471 def StartScheduler(MaxThreadNumber
, ExitFlag
):
472 SchedulerThread
= Thread(target
=BuildTask
.Scheduler
, args
=(MaxThreadNumber
, ExitFlag
))
473 SchedulerThread
.setName("Build-Task-Scheduler")
474 SchedulerThread
.setDaemon(False)
475 SchedulerThread
.start()
476 # wait for the scheduler to be started, especially useful in Linux
477 while not BuildTask
.IsOnGoing():
482 # @param MaxThreadNumber The maximum thread number
483 # @param ExitFlag Flag used to end the scheduler
486 def Scheduler(MaxThreadNumber
, ExitFlag
):
487 BuildTask
._SchedulerStopped
.clear()
489 # use BoundedSemaphore to control the maximum running threads
490 BuildTask
._Thread
= BoundedSemaphore(MaxThreadNumber
)
492 # scheduling loop, which will exits when no pending/ready task and
493 # indicated to do so, or there's error in running thread
495 while (len(BuildTask
._PendingQueue
) > 0 or len(BuildTask
._ReadyQueue
) > 0 \
496 or not ExitFlag
.isSet()) and not BuildTask
._ErrorFlag
.isSet():
497 EdkLogger
.debug(EdkLogger
.DEBUG_8
, "Pending Queue (%d), Ready Queue (%d)"
498 % (len(BuildTask
._PendingQueue
), len(BuildTask
._ReadyQueue
)))
500 # get all pending tasks
501 BuildTask
._PendingQueueLock
.acquire()
502 BuildObjectList
= BuildTask
._PendingQueue
.keys()
504 # check if their dependency is resolved, and if true, move them
507 for BuildObject
in BuildObjectList
:
508 Bt
= BuildTask
._PendingQueue
[BuildObject
]
510 BuildTask
._ReadyQueue
[BuildObject
] = BuildTask
._PendingQueue
.pop(BuildObject
)
511 BuildTask
._PendingQueueLock
.release()
513 # launch build thread until the maximum number of threads is reached
514 while not BuildTask
._ErrorFlag
.isSet():
515 # empty ready queue, do nothing further
516 if len(BuildTask
._ReadyQueue
) == 0:
519 # wait for active thread(s) exit
520 BuildTask
._Thread
.acquire(True)
522 # start a new build thread
523 Bo
= BuildTask
._ReadyQueue
.keys()[0]
524 Bt
= BuildTask
._ReadyQueue
.pop(Bo
)
526 # move into running queue
527 BuildTask
._RunningQueueLock
.acquire()
528 BuildTask
._RunningQueue
[Bo
] = Bt
529 BuildTask
._RunningQueueLock
.release()
538 # wait for all running threads exit
539 if BuildTask
._ErrorFlag
.isSet():
540 EdkLogger
.quiet("\nWaiting for all build threads exit...")
541 # while not BuildTask._ErrorFlag.isSet() and \
542 while len(BuildTask
._RunningQueue
) > 0:
543 EdkLogger
.verbose("Waiting for thread ending...(%d)" % len(BuildTask
._RunningQueue
))
544 EdkLogger
.debug(EdkLogger
.DEBUG_8
, "Threads [%s]" % ", ".join([Th
.getName() for Th
in threading
.enumerate()]))
547 except BaseException
, X
:
549 # TRICK: hide the output of threads left runing, so that the user can
550 # catch the error message easily
552 EdkLogger
.SetLevel(EdkLogger
.ERROR
)
553 BuildTask
._ErrorFlag
.set()
554 BuildTask
._ErrorMessage
= "build thread scheduler error\n\t%s" % str(X
)
556 BuildTask
._PendingQueue
.clear()
557 BuildTask
._ReadyQueue
.clear()
558 BuildTask
._RunningQueue
.clear()
559 BuildTask
._TaskQueue
.clear()
560 BuildTask
._SchedulerStopped
.set()
562 ## Wait for all running method exit
565 def WaitForComplete():
566 BuildTask
._SchedulerStopped
.wait()
568 ## Check if the scheduler is running or not
572 return not BuildTask
._SchedulerStopped
.isSet()
577 if BuildTask
.IsOnGoing():
578 BuildTask
._ErrorFlag
.set()
579 BuildTask
.WaitForComplete()
581 ## Check if there's error in running thread
583 # Since the main thread cannot catch exceptions in other thread, we have to
584 # use threading.Event to communicate this formation to main thread.
588 return BuildTask
._ErrorFlag
.isSet()
590 ## Get error message in running thread
592 # Since the main thread cannot catch exceptions in other thread, we have to
593 # use a static variable to communicate this message to main thread.
596 def GetErrorMessage():
597 return BuildTask
._ErrorMessage
599 ## Factory method to create a BuildTask object
601 # This method will check if a module is building or has been built. And if
602 # true, just return the associated BuildTask object in the _TaskQueue. If
603 # not, create and return a new BuildTask object. The new BuildTask object
604 # will be appended to the _PendingQueue for scheduling later.
606 # @param BuildItem A BuildUnit object representing a build object
607 # @param Dependency The dependent build object of BuildItem
610 def New(BuildItem
, Dependency
=None):
611 if BuildItem
in BuildTask
._TaskQueue
:
612 Bt
= BuildTask
._TaskQueue
[BuildItem
]
616 Bt
._Init
(BuildItem
, Dependency
)
617 BuildTask
._TaskQueue
[BuildItem
] = Bt
619 BuildTask
._PendingQueueLock
.acquire()
620 BuildTask
._PendingQueue
[BuildItem
] = Bt
621 BuildTask
._PendingQueueLock
.release()
625 ## The real constructor of BuildTask
627 # @param BuildItem A BuildUnit object representing a build object
628 # @param Dependency The dependent build object of BuildItem
630 def _Init(self
, BuildItem
, Dependency
=None):
631 self
.BuildItem
= BuildItem
633 self
.DependencyList
= []
634 if Dependency
== None:
635 Dependency
= BuildItem
.Dependency
637 Dependency
.extend(BuildItem
.Dependency
)
638 self
.AddDependency(Dependency
)
639 # flag indicating build completes, used to avoid unnecessary re-build
640 self
.CompleteFlag
= False
642 ## Check if all dependent build tasks are completed or not
646 for Dep
in self
.DependencyList
:
647 if Dep
.CompleteFlag
== True:
654 ## Add dependent build task
656 # @param Dependency The list of dependent build objects
658 def AddDependency(self
, Dependency
):
659 for Dep
in Dependency
:
660 if not Dep
.BuildObject
.IsBinaryModule
:
661 self
.DependencyList
.append(BuildTask
.New(Dep
)) # BuildTask list
663 ## The thread wrapper of LaunchCommand function
665 # @param Command A list or string contains the call of the command
666 # @param WorkingDir The directory in which the program will be running
668 def _CommandThread(self
, Command
, WorkingDir
):
670 self
.BuildItem
.BuildObject
.BuildTime
= LaunchCommand(Command
, WorkingDir
)
671 self
.CompleteFlag
= True
674 # TRICK: hide the output of threads left runing, so that the user can
675 # catch the error message easily
677 if not BuildTask
._ErrorFlag
.isSet():
678 GlobalData
.gBuildingModule
= "%s [%s, %s, %s]" % (str(self
.BuildItem
.BuildObject
),
679 self
.BuildItem
.BuildObject
.Arch
,
680 self
.BuildItem
.BuildObject
.ToolChain
,
681 self
.BuildItem
.BuildObject
.BuildTarget
683 EdkLogger
.SetLevel(EdkLogger
.ERROR
)
684 BuildTask
._ErrorFlag
.set()
685 BuildTask
._ErrorMessage
= "%s broken\n %s [%s]" % \
686 (threading
.currentThread().getName(), Command
, WorkingDir
)
687 # indicate there's a thread is available for another build task
688 BuildTask
._RunningQueueLock
.acquire()
689 BuildTask
._RunningQueue
.pop(self
.BuildItem
)
690 BuildTask
._RunningQueueLock
.release()
691 BuildTask
._Thread
.release()
693 ## Start build task thread
696 EdkLogger
.quiet("Building ... %s" % repr(self
.BuildItem
))
697 Command
= self
.BuildItem
.BuildCommand
+ [self
.BuildItem
.Target
]
698 self
.BuildTread
= Thread(target
=self
._CommandThread
, args
=(Command
, self
.BuildItem
.WorkingDir
))
699 self
.BuildTread
.setName("build thread")
700 self
.BuildTread
.setDaemon(False)
701 self
.BuildTread
.start()
703 ## The class contains the information related to EFI image
708 # Constructor will load all required image information.
710 # @param BaseName The full file path of image.
711 # @param Guid The GUID for image.
712 # @param Arch Arch of this image.
713 # @param OutputDir The output directory for image.
714 # @param DebugDir The debug directory for image.
715 # @param ImageClass PeImage Information
717 def __init__(self
, BaseName
, Guid
, Arch
, OutputDir
, DebugDir
, ImageClass
):
718 self
.BaseName
= BaseName
721 self
.OutputDir
= OutputDir
722 self
.DebugDir
= DebugDir
723 self
.Image
= ImageClass
724 self
.Image
.Size
= (self
.Image
.Size
/ 0x1000 + 1) * 0x1000
726 ## The class implementing the EDK2 build process
728 # The build process includes:
729 # 1. Load configuration from target.txt and tools_def.txt in $(WORKSPACE)/Conf
730 # 2. Parse DSC file of active platform
731 # 3. Parse FDF file if any
732 # 4. Establish build database, including parse all other files (module, package)
733 # 5. Create AutoGen files (C code file, depex file, makefile) if necessary
734 # 6. Call build command
739 # Constructor will load all necessary configurations, parse platform, modules
740 # and packages and the establish a database for AutoGen.
742 # @param Target The build command target, one of gSupportedTarget
743 # @param WorkspaceDir The directory of workspace
744 # @param BuildOptions Build options passed from command line
746 def __init__(self
, Target
, WorkspaceDir
, BuildOptions
):
747 self
.WorkspaceDir
= WorkspaceDir
749 self
.PlatformFile
= BuildOptions
.PlatformFile
750 self
.ModuleFile
= BuildOptions
.ModuleFile
751 self
.ArchList
= BuildOptions
.TargetArch
752 self
.ToolChainList
= BuildOptions
.ToolChain
753 self
.BuildTargetList
= BuildOptions
.BuildTarget
754 self
.Fdf
= BuildOptions
.FdfFile
755 self
.FdList
= BuildOptions
.RomImage
756 self
.FvList
= BuildOptions
.FvImage
757 self
.CapList
= BuildOptions
.CapName
758 self
.SilentMode
= BuildOptions
.SilentMode
759 self
.ThreadNumber
= BuildOptions
.ThreadNumber
760 self
.SkipAutoGen
= BuildOptions
.SkipAutoGen
761 self
.Reparse
= BuildOptions
.Reparse
762 self
.SkuId
= BuildOptions
.SkuId
763 self
.ConfDirectory
= BuildOptions
.ConfDirectory
764 self
.SpawnMode
= True
765 self
.BuildReport
= BuildReport(BuildOptions
.ReportFile
, BuildOptions
.ReportType
)
766 self
.TargetTxt
= TargetTxtClassObject()
767 self
.ToolDef
= ToolDefClassObject()
771 GlobalData
.BuildOptionPcd
= BuildOptions
.OptionPcd
772 #Set global flag for build mode
773 GlobalData
.gIgnoreSource
= BuildOptions
.IgnoreSources
774 GlobalData
.gUseHashCache
= BuildOptions
.UseHashCache
775 GlobalData
.gBinCacheDest
= BuildOptions
.BinCacheDest
776 GlobalData
.gBinCacheSource
= BuildOptions
.BinCacheSource
778 if GlobalData
.gBinCacheDest
and not GlobalData
.gUseHashCache
:
779 EdkLogger
.error("build", OPTION_NOT_SUPPORTED
, ExtraData
="--binary-destination must be used together with --hash.")
781 if GlobalData
.gBinCacheSource
and not GlobalData
.gUseHashCache
:
782 EdkLogger
.error("build", OPTION_NOT_SUPPORTED
, ExtraData
="--binary-source must be used together with --hash.")
784 if GlobalData
.gBinCacheDest
and GlobalData
.gBinCacheSource
:
785 EdkLogger
.error("build", OPTION_NOT_SUPPORTED
, ExtraData
="--binary-destination can not be used together with --binary-source.")
787 if GlobalData
.gBinCacheSource
:
788 BinCacheSource
= os
.path
.normpath(GlobalData
.gBinCacheSource
)
789 if not os
.path
.isabs(BinCacheSource
):
790 BinCacheSource
= mws
.join(self
.WorkspaceDir
, BinCacheSource
)
791 GlobalData
.gBinCacheSource
= BinCacheSource
793 if GlobalData
.gBinCacheDest
:
794 BinCacheDest
= os
.path
.normpath(GlobalData
.gBinCacheDest
)
795 if not os
.path
.isabs(BinCacheDest
):
796 BinCacheDest
= mws
.join(self
.WorkspaceDir
, BinCacheDest
)
797 GlobalData
.gBinCacheDest
= BinCacheDest
799 if self
.ConfDirectory
:
800 # Get alternate Conf location, if it is absolute, then just use the absolute directory name
801 ConfDirectoryPath
= os
.path
.normpath(self
.ConfDirectory
)
803 if not os
.path
.isabs(ConfDirectoryPath
):
804 # Since alternate directory name is not absolute, the alternate directory is located within the WORKSPACE
805 # This also handles someone specifying the Conf directory in the workspace. Using --conf=Conf
806 ConfDirectoryPath
= mws
.join(self
.WorkspaceDir
, ConfDirectoryPath
)
808 if "CONF_PATH" in os
.environ
:
809 ConfDirectoryPath
= os
.path
.normcase(os
.path
.normpath(os
.environ
["CONF_PATH"]))
811 # Get standard WORKSPACE/Conf use the absolute path to the WORKSPACE/Conf
812 ConfDirectoryPath
= mws
.join(self
.WorkspaceDir
, 'Conf')
813 GlobalData
.gConfDirectory
= ConfDirectoryPath
814 GlobalData
.gDatabasePath
= os
.path
.normpath(os
.path
.join(ConfDirectoryPath
, GlobalData
.gDatabasePath
))
816 if BuildOptions
.DisableCache
:
817 self
.Db
= WorkspaceDatabase(":memory:")
819 self
.Db
= WorkspaceDatabase(GlobalData
.gDatabasePath
, self
.Reparse
)
820 self
.BuildDatabase
= self
.Db
.BuildObject
822 self
.ToolChainFamily
= None
823 self
.LoadFixAddress
= 0
824 self
.UniFlag
= BuildOptions
.Flag
825 self
.BuildModules
= []
827 self
.LaunchPrebuildFlag
= False
828 self
.PlatformBuildPath
= os
.path
.join(GlobalData
.gConfDirectory
,'.cache', '.PlatformBuild')
829 if BuildOptions
.CommandLength
:
830 GlobalData
.gCommandMaxLength
= BuildOptions
.CommandLength
832 # print dot character during doing some time-consuming work
833 self
.Progress
= Utils
.Progressor()
834 # print current build environment and configuration
835 EdkLogger
.quiet("%-16s = %s" % ("WORKSPACE", os
.environ
["WORKSPACE"]))
836 if "PACKAGES_PATH" in os
.environ
:
837 # WORKSPACE env has been converted before. Print the same path style with WORKSPACE env.
838 EdkLogger
.quiet("%-16s = %s" % ("PACKAGES_PATH", os
.path
.normcase(os
.path
.normpath(os
.environ
["PACKAGES_PATH"]))))
839 EdkLogger
.quiet("%-16s = %s" % ("ECP_SOURCE", os
.environ
["ECP_SOURCE"]))
840 EdkLogger
.quiet("%-16s = %s" % ("EDK_SOURCE", os
.environ
["EDK_SOURCE"]))
841 EdkLogger
.quiet("%-16s = %s" % ("EFI_SOURCE", os
.environ
["EFI_SOURCE"]))
842 EdkLogger
.quiet("%-16s = %s" % ("EDK_TOOLS_PATH", os
.environ
["EDK_TOOLS_PATH"]))
843 if "EDK_TOOLS_BIN" in os
.environ
:
844 # Print the same path style with WORKSPACE env.
845 EdkLogger
.quiet("%-16s = %s" % ("EDK_TOOLS_BIN", os
.path
.normcase(os
.path
.normpath(os
.environ
["EDK_TOOLS_BIN"]))))
846 EdkLogger
.quiet("%-16s = %s" % ("CONF_PATH", GlobalData
.gConfDirectory
))
850 EdkLogger
.quiet("%-16s = %s" % ("PREBUILD", self
.Prebuild
))
852 EdkLogger
.quiet("%-16s = %s" % ("POSTBUILD", self
.Postbuild
))
854 self
.LaunchPrebuild()
855 self
.TargetTxt
= TargetTxtClassObject()
856 self
.ToolDef
= ToolDefClassObject()
857 if not (self
.LaunchPrebuildFlag
and os
.path
.exists(self
.PlatformBuildPath
)):
861 os
.chdir(self
.WorkspaceDir
)
863 ## Load configuration
865 # This method will parse target.txt and get the build configurations.
867 def LoadConfiguration(self
):
869 # Check target.txt and tools_def.txt and Init them
871 BuildConfigurationFile
= os
.path
.normpath(os
.path
.join(GlobalData
.gConfDirectory
, gBuildConfiguration
))
872 if os
.path
.isfile(BuildConfigurationFile
) == True:
873 StatusCode
= self
.TargetTxt
.LoadTargetTxtFile(BuildConfigurationFile
)
875 ToolDefinitionFile
= self
.TargetTxt
.TargetTxtDictionary
[DataType
.TAB_TAT_DEFINES_TOOL_CHAIN_CONF
]
876 if ToolDefinitionFile
== '':
877 ToolDefinitionFile
= gToolsDefinition
878 ToolDefinitionFile
= os
.path
.normpath(mws
.join(self
.WorkspaceDir
, 'Conf', ToolDefinitionFile
))
879 if os
.path
.isfile(ToolDefinitionFile
) == True:
880 StatusCode
= self
.ToolDef
.LoadToolDefFile(ToolDefinitionFile
)
882 EdkLogger
.error("build", FILE_NOT_FOUND
, ExtraData
=ToolDefinitionFile
)
884 EdkLogger
.error("build", FILE_NOT_FOUND
, ExtraData
=BuildConfigurationFile
)
886 # if no ARCH given in command line, get it from target.txt
887 if not self
.ArchList
:
888 self
.ArchList
= self
.TargetTxt
.TargetTxtDictionary
[DataType
.TAB_TAT_DEFINES_TARGET_ARCH
]
889 self
.ArchList
= tuple(self
.ArchList
)
891 # if no build target given in command line, get it from target.txt
892 if not self
.BuildTargetList
:
893 self
.BuildTargetList
= self
.TargetTxt
.TargetTxtDictionary
[DataType
.TAB_TAT_DEFINES_TARGET
]
895 # if no tool chain given in command line, get it from target.txt
896 if not self
.ToolChainList
:
897 self
.ToolChainList
= self
.TargetTxt
.TargetTxtDictionary
[DataType
.TAB_TAT_DEFINES_TOOL_CHAIN_TAG
]
898 if self
.ToolChainList
== None or len(self
.ToolChainList
) == 0:
899 EdkLogger
.error("build", RESOURCE_NOT_AVAILABLE
, ExtraData
="No toolchain given. Don't know how to build.\n")
901 # check if the tool chains are defined or not
902 NewToolChainList
= []
903 for ToolChain
in self
.ToolChainList
:
904 if ToolChain
not in self
.ToolDef
.ToolsDefTxtDatabase
[TAB_TOD_DEFINES_TOOL_CHAIN_TAG
]:
905 EdkLogger
.warn("build", "Tool chain [%s] is not defined" % ToolChain
)
907 NewToolChainList
.append(ToolChain
)
908 # if no tool chain available, break the build
909 if len(NewToolChainList
) == 0:
910 EdkLogger
.error("build", RESOURCE_NOT_AVAILABLE
,
911 ExtraData
="[%s] not defined. No toolchain available for build!\n" % ", ".join(self
.ToolChainList
))
913 self
.ToolChainList
= NewToolChainList
916 ToolDefinition
= self
.ToolDef
.ToolsDefTxtDatabase
917 for Tool
in self
.ToolChainList
:
918 if TAB_TOD_DEFINES_FAMILY
not in ToolDefinition
or Tool
not in ToolDefinition
[TAB_TOD_DEFINES_FAMILY
] \
919 or not ToolDefinition
[TAB_TOD_DEFINES_FAMILY
][Tool
]:
920 EdkLogger
.warn("build", "No tool chain family found in configuration for %s. Default to MSFT." % Tool
)
921 ToolChainFamily
.append("MSFT")
923 ToolChainFamily
.append(ToolDefinition
[TAB_TOD_DEFINES_FAMILY
][Tool
])
924 self
.ToolChainFamily
= ToolChainFamily
926 if self
.ThreadNumber
== None:
927 self
.ThreadNumber
= self
.TargetTxt
.TargetTxtDictionary
[DataType
.TAB_TAT_DEFINES_MAX_CONCURRENT_THREAD_NUMBER
]
928 if self
.ThreadNumber
== '':
929 self
.ThreadNumber
= 0
931 self
.ThreadNumber
= int(self
.ThreadNumber
, 0)
933 if self
.ThreadNumber
== 0:
934 self
.ThreadNumber
= 1
936 if not self
.PlatformFile
:
937 PlatformFile
= self
.TargetTxt
.TargetTxtDictionary
[DataType
.TAB_TAT_DEFINES_ACTIVE_PLATFORM
]
939 # Try to find one in current directory
940 WorkingDirectory
= os
.getcwd()
941 FileList
= glob
.glob(os
.path
.normpath(os
.path
.join(WorkingDirectory
, '*.dsc')))
942 FileNum
= len(FileList
)
944 EdkLogger
.error("build", OPTION_MISSING
,
945 ExtraData
="There are %d DSC files in %s. Use '-p' to specify one.\n" % (FileNum
, WorkingDirectory
))
947 PlatformFile
= FileList
[0]
949 EdkLogger
.error("build", RESOURCE_NOT_AVAILABLE
,
950 ExtraData
="No active platform specified in target.txt or command line! Nothing can be built.\n")
952 self
.PlatformFile
= PathClass(NormFile(PlatformFile
, self
.WorkspaceDir
), self
.WorkspaceDir
)
954 ## Initialize build configuration
956 # This method will parse DSC file and merge the configurations from
957 # command line and target.txt, then get the final build configurations.
960 # parse target.txt, tools_def.txt, and platform file
961 self
.LoadConfiguration()
963 # Allow case-insensitive for those from command line or configuration file
964 ErrorCode
, ErrorInfo
= self
.PlatformFile
.Validate(".dsc", False)
966 EdkLogger
.error("build", ErrorCode
, ExtraData
=ErrorInfo
)
968 # create metafile database
970 self
.Db
.InitDatabase()
972 def InitPreBuild(self
):
973 self
.LoadConfiguration()
974 ErrorCode
, ErrorInfo
= self
.PlatformFile
.Validate(".dsc", False)
976 EdkLogger
.error("build", ErrorCode
, ExtraData
=ErrorInfo
)
977 if self
.BuildTargetList
:
978 GlobalData
.gGlobalDefines
['TARGET'] = self
.BuildTargetList
[0]
980 GlobalData
.gGlobalDefines
['ARCH'] = self
.ArchList
[0]
981 if self
.ToolChainList
:
982 GlobalData
.gGlobalDefines
['TOOLCHAIN'] = self
.ToolChainList
[0]
983 GlobalData
.gGlobalDefines
['TOOL_CHAIN_TAG'] = self
.ToolChainList
[0]
984 if self
.ToolChainFamily
:
985 GlobalData
.gGlobalDefines
['FAMILY'] = self
.ToolChainFamily
[0]
986 if 'PREBUILD' in GlobalData
.gCommandLineDefines
.keys():
987 self
.Prebuild
= GlobalData
.gCommandLineDefines
.get('PREBUILD')
989 self
.Db
.InitDatabase()
991 Platform
= self
.Db
._MapPlatform
(str(self
.PlatformFile
))
992 self
.Prebuild
= str(Platform
.Prebuild
)
996 # Evaluate all arguments and convert arguments that are WORKSPACE
997 # relative paths to absolute paths. Filter arguments that look like
998 # flags or do not follow the file/dir naming rules to avoid false
999 # positives on this conversion.
1001 for Arg
in self
.Prebuild
.split():
1003 # Do not modify Arg if it looks like a flag or an absolute file path
1005 if Arg
.startswith('-') or os
.path
.isabs(Arg
):
1006 PrebuildList
.append(Arg
)
1009 # Do not modify Arg if it does not look like a Workspace relative
1010 # path that starts with a valid package directory name
1012 if not Arg
[0].isalpha() or os
.path
.dirname(Arg
) == '':
1013 PrebuildList
.append(Arg
)
1016 # If Arg looks like a WORKSPACE relative path, then convert to an
1017 # absolute path and check to see if the file exists.
1019 Temp
= mws
.join(self
.WorkspaceDir
, Arg
)
1020 if os
.path
.isfile(Temp
):
1022 PrebuildList
.append(Arg
)
1023 self
.Prebuild
= ' '.join(PrebuildList
)
1024 self
.Prebuild
+= self
.PassCommandOption(self
.BuildTargetList
, self
.ArchList
, self
.ToolChainList
, self
.PlatformFile
, self
.Target
)
1026 def InitPostBuild(self
):
1027 if 'POSTBUILD' in GlobalData
.gCommandLineDefines
.keys():
1028 self
.Postbuild
= GlobalData
.gCommandLineDefines
.get('POSTBUILD')
1030 Platform
= self
.Db
._MapPlatform
(str(self
.PlatformFile
))
1031 self
.Postbuild
= str(Platform
.Postbuild
)
1035 # Evaluate all arguments and convert arguments that are WORKSPACE
1036 # relative paths to absolute paths. Filter arguments that look like
1037 # flags or do not follow the file/dir naming rules to avoid false
1038 # positives on this conversion.
1040 for Arg
in self
.Postbuild
.split():
1042 # Do not modify Arg if it looks like a flag or an absolute file path
1044 if Arg
.startswith('-') or os
.path
.isabs(Arg
):
1045 PostbuildList
.append(Arg
)
1048 # Do not modify Arg if it does not look like a Workspace relative
1049 # path that starts with a valid package directory name
1051 if not Arg
[0].isalpha() or os
.path
.dirname(Arg
) == '':
1052 PostbuildList
.append(Arg
)
1055 # If Arg looks like a WORKSPACE relative path, then convert to an
1056 # absolute path and check to see if the file exists.
1058 Temp
= mws
.join(self
.WorkspaceDir
, Arg
)
1059 if os
.path
.isfile(Temp
):
1061 PostbuildList
.append(Arg
)
1062 self
.Postbuild
= ' '.join(PostbuildList
)
1063 self
.Postbuild
+= self
.PassCommandOption(self
.BuildTargetList
, self
.ArchList
, self
.ToolChainList
, self
.PlatformFile
, self
.Target
)
1065 def PassCommandOption(self
, BuildTarget
, TargetArch
, ToolChain
, PlatformFile
, Target
):
1067 if GlobalData
.gCommand
and isinstance(GlobalData
.gCommand
, list):
1068 BuildStr
+= ' ' + ' '.join(GlobalData
.gCommand
)
1071 ToolChainFlag
= False
1072 PlatformFileFlag
= False
1074 if GlobalData
.gOptions
and not GlobalData
.gOptions
.BuildTarget
:
1076 if GlobalData
.gOptions
and not GlobalData
.gOptions
.TargetArch
:
1078 if GlobalData
.gOptions
and not GlobalData
.gOptions
.ToolChain
:
1079 ToolChainFlag
= True
1080 if GlobalData
.gOptions
and not GlobalData
.gOptions
.PlatformFile
:
1081 PlatformFileFlag
= True
1083 if TargetFlag
and BuildTarget
:
1084 if isinstance(BuildTarget
, list) or isinstance(BuildTarget
, tuple):
1085 BuildStr
+= ' -b ' + ' -b '.join(BuildTarget
)
1086 elif isinstance(BuildTarget
, str):
1087 BuildStr
+= ' -b ' + BuildTarget
1088 if ArchFlag
and TargetArch
:
1089 if isinstance(TargetArch
, list) or isinstance(TargetArch
, tuple):
1090 BuildStr
+= ' -a ' + ' -a '.join(TargetArch
)
1091 elif isinstance(TargetArch
, str):
1092 BuildStr
+= ' -a ' + TargetArch
1093 if ToolChainFlag
and ToolChain
:
1094 if isinstance(ToolChain
, list) or isinstance(ToolChain
, tuple):
1095 BuildStr
+= ' -t ' + ' -t '.join(ToolChain
)
1096 elif isinstance(ToolChain
, str):
1097 BuildStr
+= ' -t ' + ToolChain
1098 if PlatformFileFlag
and PlatformFile
:
1099 if isinstance(PlatformFile
, list) or isinstance(PlatformFile
, tuple):
1100 BuildStr
+= ' -p ' + ' -p '.join(PlatformFile
)
1101 elif isinstance(PlatformFile
, str):
1102 BuildStr
+= ' -p' + PlatformFile
1103 BuildStr
+= ' --conf=' + GlobalData
.gConfDirectory
1105 BuildStr
+= ' ' + Target
1109 def LaunchPrebuild(self
):
1111 EdkLogger
.info("\n- Prebuild Start -\n")
1112 self
.LaunchPrebuildFlag
= True
1114 # The purpose of .PrebuildEnv file is capture environment variable settings set by the prebuild script
1115 # and preserve them for the rest of the main build step, because the child process environment will
1116 # evaporate as soon as it exits, we cannot get it in build step.
1118 PrebuildEnvFile
= os
.path
.join(GlobalData
.gConfDirectory
,'.cache','.PrebuildEnv')
1119 if os
.path
.isfile(PrebuildEnvFile
):
1120 os
.remove(PrebuildEnvFile
)
1121 if os
.path
.isfile(self
.PlatformBuildPath
):
1122 os
.remove(self
.PlatformBuildPath
)
1123 if sys
.platform
== "win32":
1124 args
= ' && '.join((self
.Prebuild
, 'set > ' + PrebuildEnvFile
))
1125 Process
= Popen(args
, stdout
=PIPE
, stderr
=PIPE
, shell
=True)
1127 args
= ' && '.join((self
.Prebuild
, 'env > ' + PrebuildEnvFile
))
1128 Process
= Popen(args
, stdout
=PIPE
, stderr
=PIPE
, shell
=True)
1130 # launch two threads to read the STDOUT and STDERR
1131 EndOfProcedure
= Event()
1132 EndOfProcedure
.clear()
1134 StdOutThread
= Thread(target
=ReadMessage
, args
=(Process
.stdout
, EdkLogger
.info
, EndOfProcedure
))
1135 StdOutThread
.setName("STDOUT-Redirector")
1136 StdOutThread
.setDaemon(False)
1137 StdOutThread
.start()
1140 StdErrThread
= Thread(target
=ReadMessage
, args
=(Process
.stderr
, EdkLogger
.quiet
, EndOfProcedure
))
1141 StdErrThread
.setName("STDERR-Redirector")
1142 StdErrThread
.setDaemon(False)
1143 StdErrThread
.start()
1144 # waiting for program exit
1151 if Process
.returncode
!= 0 :
1152 EdkLogger
.error("Prebuild", PREBUILD_ERROR
, 'Prebuild process is not success!')
1154 if os
.path
.exists(PrebuildEnvFile
):
1155 f
= open(PrebuildEnvFile
)
1156 envs
= f
.readlines()
1158 envs
= itertools
.imap(lambda l
: l
.split('=',1), envs
)
1159 envs
= itertools
.ifilter(lambda l
: len(l
) == 2, envs
)
1160 envs
= itertools
.imap(lambda l
: [i
.strip() for i
in l
], envs
)
1161 os
.environ
.update(dict(envs
))
1162 EdkLogger
.info("\n- Prebuild Done -\n")
1164 def LaunchPostbuild(self
):
1166 EdkLogger
.info("\n- Postbuild Start -\n")
1167 if sys
.platform
== "win32":
1168 Process
= Popen(self
.Postbuild
, stdout
=PIPE
, stderr
=PIPE
, shell
=True)
1170 Process
= Popen(self
.Postbuild
, stdout
=PIPE
, stderr
=PIPE
, shell
=True)
1171 # launch two threads to read the STDOUT and STDERR
1172 EndOfProcedure
= Event()
1173 EndOfProcedure
.clear()
1175 StdOutThread
= Thread(target
=ReadMessage
, args
=(Process
.stdout
, EdkLogger
.info
, EndOfProcedure
))
1176 StdOutThread
.setName("STDOUT-Redirector")
1177 StdOutThread
.setDaemon(False)
1178 StdOutThread
.start()
1181 StdErrThread
= Thread(target
=ReadMessage
, args
=(Process
.stderr
, EdkLogger
.quiet
, EndOfProcedure
))
1182 StdErrThread
.setName("STDERR-Redirector")
1183 StdErrThread
.setDaemon(False)
1184 StdErrThread
.start()
1185 # waiting for program exit
1192 if Process
.returncode
!= 0 :
1193 EdkLogger
.error("Postbuild", POSTBUILD_ERROR
, 'Postbuild process is not success!')
1194 EdkLogger
.info("\n- Postbuild Done -\n")
1195 ## Build a module or platform
1197 # Create autogen code and makefile for a module or platform, and the launch
1198 # "make" command to build it
1200 # @param Target The target of build command
1201 # @param Platform The platform file
1202 # @param Module The module file
1203 # @param BuildTarget The name of build target, one of "DEBUG", "RELEASE"
1204 # @param ToolChain The name of toolchain to build
1205 # @param Arch The arch of the module/platform
1206 # @param CreateDepModuleCodeFile Flag used to indicate creating code
1207 # for dependent modules/Libraries
1208 # @param CreateDepModuleMakeFile Flag used to indicate creating makefile
1209 # for dependent modules/Libraries
1211 def _BuildPa(self
, Target
, AutoGenObject
, CreateDepsCodeFile
=True, CreateDepsMakeFile
=True, BuildModule
=False):
1212 if AutoGenObject
== None:
1215 # skip file generation for cleanxxx targets, run and fds target
1216 if Target
not in ['clean', 'cleanlib', 'cleanall', 'run', 'fds']:
1217 # for target which must generate AutoGen code and makefile
1218 if not self
.SkipAutoGen
or Target
== 'genc':
1219 self
.Progress
.Start("Generating code")
1220 AutoGenObject
.CreateCodeFile(CreateDepsCodeFile
)
1221 self
.Progress
.Stop("done!")
1222 if Target
== "genc":
1225 if not self
.SkipAutoGen
or Target
== 'genmake':
1226 self
.Progress
.Start("Generating makefile")
1227 AutoGenObject
.CreateMakeFile(CreateDepsMakeFile
)
1228 self
.Progress
.Stop("done!")
1229 if Target
== "genmake":
1232 # always recreate top/platform makefile when clean, just in case of inconsistency
1233 AutoGenObject
.CreateCodeFile(False)
1234 AutoGenObject
.CreateMakeFile(False)
1236 if EdkLogger
.GetLevel() == EdkLogger
.QUIET
:
1237 EdkLogger
.quiet("Building ... %s" % repr(AutoGenObject
))
1239 BuildCommand
= AutoGenObject
.BuildCommand
1240 if BuildCommand
== None or len(BuildCommand
) == 0:
1241 EdkLogger
.error("build", OPTION_MISSING
,
1242 "No build command found for this module. "
1243 "Please check your setting of %s_%s_%s_MAKE_PATH in Conf/tools_def.txt file." %
1244 (AutoGenObject
.BuildTarget
, AutoGenObject
.ToolChain
, AutoGenObject
.Arch
),
1245 ExtraData
=str(AutoGenObject
))
1247 makefile
= GenMake
.BuildFile(AutoGenObject
)._FILE
_NAME
_[GenMake
.gMakeType
]
1251 RunDir
= os
.path
.normpath(os
.path
.join(AutoGenObject
.BuildDir
, GlobalData
.gGlobalDefines
['ARCH']))
1252 Command
= '.\SecMain'
1254 LaunchCommand(Command
, RunDir
)
1259 BuildCommand
= BuildCommand
+ [Target
]
1260 LaunchCommand(BuildCommand
, AutoGenObject
.MakeFileDir
)
1261 self
.CreateAsBuiltInf()
1265 if Target
== 'libraries':
1266 for Lib
in AutoGenObject
.LibraryBuildDirectoryList
:
1267 NewBuildCommand
= BuildCommand
+ ['-f', os
.path
.normpath(os
.path
.join(Lib
, makefile
)), 'pbuild']
1268 LaunchCommand(NewBuildCommand
, AutoGenObject
.MakeFileDir
)
1272 if Target
== 'modules':
1273 for Lib
in AutoGenObject
.LibraryBuildDirectoryList
:
1274 NewBuildCommand
= BuildCommand
+ ['-f', os
.path
.normpath(os
.path
.join(Lib
, makefile
)), 'pbuild']
1275 LaunchCommand(NewBuildCommand
, AutoGenObject
.MakeFileDir
)
1276 for Mod
in AutoGenObject
.ModuleBuildDirectoryList
:
1277 NewBuildCommand
= BuildCommand
+ ['-f', os
.path
.normpath(os
.path
.join(Mod
, makefile
)), 'pbuild']
1278 LaunchCommand(NewBuildCommand
, AutoGenObject
.MakeFileDir
)
1279 self
.CreateAsBuiltInf()
1283 if Target
== 'cleanlib':
1284 for Lib
in AutoGenObject
.LibraryBuildDirectoryList
:
1285 LibMakefile
= os
.path
.normpath(os
.path
.join(Lib
, makefile
))
1286 if os
.path
.exists(LibMakefile
):
1287 NewBuildCommand
= BuildCommand
+ ['-f', LibMakefile
, 'cleanall']
1288 LaunchCommand(NewBuildCommand
, AutoGenObject
.MakeFileDir
)
1292 if Target
== 'clean':
1293 for Mod
in AutoGenObject
.ModuleBuildDirectoryList
:
1294 ModMakefile
= os
.path
.normpath(os
.path
.join(Mod
, makefile
))
1295 if os
.path
.exists(ModMakefile
):
1296 NewBuildCommand
= BuildCommand
+ ['-f', ModMakefile
, 'cleanall']
1297 LaunchCommand(NewBuildCommand
, AutoGenObject
.MakeFileDir
)
1298 for Lib
in AutoGenObject
.LibraryBuildDirectoryList
:
1299 LibMakefile
= os
.path
.normpath(os
.path
.join(Lib
, makefile
))
1300 if os
.path
.exists(LibMakefile
):
1301 NewBuildCommand
= BuildCommand
+ ['-f', LibMakefile
, 'cleanall']
1302 LaunchCommand(NewBuildCommand
, AutoGenObject
.MakeFileDir
)
1306 if Target
== 'cleanall':
1308 #os.rmdir(AutoGenObject.BuildDir)
1309 RemoveDirectory(AutoGenObject
.BuildDir
, True)
1310 except WindowsError, X
:
1311 EdkLogger
.error("build", FILE_DELETE_FAILURE
, ExtraData
=str(X
))
1314 ## Build a module or platform
1316 # Create autogen code and makefile for a module or platform, and the launch
1317 # "make" command to build it
1319 # @param Target The target of build command
1320 # @param Platform The platform file
1321 # @param Module The module file
1322 # @param BuildTarget The name of build target, one of "DEBUG", "RELEASE"
1323 # @param ToolChain The name of toolchain to build
1324 # @param Arch The arch of the module/platform
1325 # @param CreateDepModuleCodeFile Flag used to indicate creating code
1326 # for dependent modules/Libraries
1327 # @param CreateDepModuleMakeFile Flag used to indicate creating makefile
1328 # for dependent modules/Libraries
1330 def _Build(self
, Target
, AutoGenObject
, CreateDepsCodeFile
=True, CreateDepsMakeFile
=True, BuildModule
=False):
1331 if AutoGenObject
== None:
1334 # skip file generation for cleanxxx targets, run and fds target
1335 if Target
not in ['clean', 'cleanlib', 'cleanall', 'run', 'fds']:
1336 # for target which must generate AutoGen code and makefile
1337 if not self
.SkipAutoGen
or Target
== 'genc':
1338 self
.Progress
.Start("Generating code")
1339 AutoGenObject
.CreateCodeFile(CreateDepsCodeFile
)
1340 self
.Progress
.Stop("done!")
1341 if Target
== "genc":
1344 if not self
.SkipAutoGen
or Target
== 'genmake':
1345 self
.Progress
.Start("Generating makefile")
1346 AutoGenObject
.CreateMakeFile(CreateDepsMakeFile
)
1347 #AutoGenObject.CreateAsBuiltInf()
1348 self
.Progress
.Stop("done!")
1349 if Target
== "genmake":
1352 # always recreate top/platform makefile when clean, just in case of inconsistency
1353 AutoGenObject
.CreateCodeFile(False)
1354 AutoGenObject
.CreateMakeFile(False)
1356 if EdkLogger
.GetLevel() == EdkLogger
.QUIET
:
1357 EdkLogger
.quiet("Building ... %s" % repr(AutoGenObject
))
1359 BuildCommand
= AutoGenObject
.BuildCommand
1360 if BuildCommand
== None or len(BuildCommand
) == 0:
1361 EdkLogger
.error("build", OPTION_MISSING
,
1362 "No build command found for this module. "
1363 "Please check your setting of %s_%s_%s_MAKE_PATH in Conf/tools_def.txt file." %
1364 (AutoGenObject
.BuildTarget
, AutoGenObject
.ToolChain
, AutoGenObject
.Arch
),
1365 ExtraData
=str(AutoGenObject
))
1370 BuildCommand
= BuildCommand
+ [Target
]
1371 AutoGenObject
.BuildTime
= LaunchCommand(BuildCommand
, AutoGenObject
.MakeFileDir
)
1372 self
.CreateAsBuiltInf()
1377 LaunchCommand(AutoGenObject
.GenFdsCommand
, AutoGenObject
.MakeFileDir
)
1382 RunDir
= os
.path
.normpath(os
.path
.join(AutoGenObject
.BuildDir
, GlobalData
.gGlobalDefines
['ARCH']))
1383 Command
= '.\SecMain'
1385 LaunchCommand(Command
, RunDir
)
1389 if Target
== 'libraries':
1396 if Target
== 'cleanall':
1398 #os.rmdir(AutoGenObject.BuildDir)
1399 RemoveDirectory(AutoGenObject
.BuildDir
, True)
1400 except WindowsError, X
:
1401 EdkLogger
.error("build", FILE_DELETE_FAILURE
, ExtraData
=str(X
))
1404 ## Rebase module image and Get function address for the input module list.
1406 def _RebaseModule (self
, MapBuffer
, BaseAddress
, ModuleList
, AddrIsOffset
= True, ModeIsSmm
= False):
1408 AddrIsOffset
= False
1409 InfFileNameList
= ModuleList
.keys()
1410 #InfFileNameList.sort()
1411 for InfFile
in InfFileNameList
:
1412 sys
.stdout
.write (".")
1414 ModuleInfo
= ModuleList
[InfFile
]
1415 ModuleName
= ModuleInfo
.BaseName
1416 ModuleOutputImage
= ModuleInfo
.Image
.FileName
1417 ModuleDebugImage
= os
.path
.join(ModuleInfo
.DebugDir
, ModuleInfo
.BaseName
+ '.efi')
1418 ## for SMM module in SMRAM, the SMRAM will be allocated from base to top.
1420 BaseAddress
= BaseAddress
- ModuleInfo
.Image
.Size
1422 # Update Image to new BaseAddress by GenFw tool
1424 LaunchCommand(["GenFw", "--rebase", str(BaseAddress
), "-r", ModuleOutputImage
], ModuleInfo
.OutputDir
)
1425 LaunchCommand(["GenFw", "--rebase", str(BaseAddress
), "-r", ModuleDebugImage
], ModuleInfo
.DebugDir
)
1428 # Set new address to the section header only for SMM driver.
1430 LaunchCommand(["GenFw", "--address", str(BaseAddress
), "-r", ModuleOutputImage
], ModuleInfo
.OutputDir
)
1431 LaunchCommand(["GenFw", "--address", str(BaseAddress
), "-r", ModuleDebugImage
], ModuleInfo
.DebugDir
)
1433 # Collect funtion address from Map file
1435 ImageMapTable
= ModuleOutputImage
.replace('.efi', '.map')
1437 if os
.path
.exists(ImageMapTable
):
1438 OrigImageBaseAddress
= 0
1439 ImageMap
= open(ImageMapTable
, 'r')
1440 for LinStr
in ImageMap
:
1441 if len (LinStr
.strip()) == 0:
1444 # Get the preferred address set on link time.
1446 if LinStr
.find ('Preferred load address is') != -1:
1447 StrList
= LinStr
.split()
1448 OrigImageBaseAddress
= int (StrList
[len(StrList
) - 1], 16)
1450 StrList
= LinStr
.split()
1451 if len (StrList
) > 4:
1452 if StrList
[3] == 'f' or StrList
[3] == 'F':
1454 RelativeAddress
= int (StrList
[2], 16) - OrigImageBaseAddress
1455 FunctionList
.append ((Name
, RelativeAddress
))
1456 if ModuleInfo
.Arch
== 'IPF' and Name
.endswith('_ModuleEntryPoint'):
1458 # Get the real entry point address for IPF image.
1460 ModuleInfo
.Image
.EntryPoint
= RelativeAddress
1463 # Add general information.
1466 MapBuffer
.write('\n\n%s (Fixed SMRAM Offset, BaseAddress=0x%010X, EntryPoint=0x%010X)\n' % (ModuleName
, BaseAddress
, BaseAddress
+ ModuleInfo
.Image
.EntryPoint
))
1468 MapBuffer
.write('\n\n%s (Fixed Memory Offset, BaseAddress=-0x%010X, EntryPoint=-0x%010X)\n' % (ModuleName
, 0 - BaseAddress
, 0 - (BaseAddress
+ ModuleInfo
.Image
.EntryPoint
)))
1470 MapBuffer
.write('\n\n%s (Fixed Memory Address, BaseAddress=0x%010X, EntryPoint=0x%010X)\n' % (ModuleName
, BaseAddress
, BaseAddress
+ ModuleInfo
.Image
.EntryPoint
))
1472 # Add guid and general seciton section.
1474 TextSectionAddress
= 0
1475 DataSectionAddress
= 0
1476 for SectionHeader
in ModuleInfo
.Image
.SectionHeaderList
:
1477 if SectionHeader
[0] == '.text':
1478 TextSectionAddress
= SectionHeader
[1]
1479 elif SectionHeader
[0] in ['.data', '.sdata']:
1480 DataSectionAddress
= SectionHeader
[1]
1482 MapBuffer
.write('(GUID=%s, .textbaseaddress=-0x%010X, .databaseaddress=-0x%010X)\n' % (ModuleInfo
.Guid
, 0 - (BaseAddress
+ TextSectionAddress
), 0 - (BaseAddress
+ DataSectionAddress
)))
1484 MapBuffer
.write('(GUID=%s, .textbaseaddress=0x%010X, .databaseaddress=0x%010X)\n' % (ModuleInfo
.Guid
, BaseAddress
+ TextSectionAddress
, BaseAddress
+ DataSectionAddress
))
1486 # Add debug image full path.
1488 MapBuffer
.write('(IMAGE=%s)\n\n' % (ModuleDebugImage
))
1490 # Add funtion address
1492 for Function
in FunctionList
:
1494 MapBuffer
.write(' -0x%010X %s\n' % (0 - (BaseAddress
+ Function
[1]), Function
[0]))
1496 MapBuffer
.write(' 0x%010X %s\n' % (BaseAddress
+ Function
[1], Function
[0]))
1500 # for SMM module in SMRAM, the SMRAM will be allocated from base to top.
1503 BaseAddress
= BaseAddress
+ ModuleInfo
.Image
.Size
1505 ## Collect MAP information of all FVs
1507 def _CollectFvMapBuffer (self
, MapBuffer
, Wa
, ModuleList
):
1509 # First get the XIP base address for FV map file.
1510 GuidPattern
= re
.compile("[-a-fA-F0-9]+")
1511 GuidName
= re
.compile("\(GUID=[-a-fA-F0-9]+")
1512 for FvName
in Wa
.FdfProfile
.FvDict
.keys():
1513 FvMapBuffer
= os
.path
.join(Wa
.FvDir
, FvName
+ '.Fv.map')
1514 if not os
.path
.exists(FvMapBuffer
):
1516 FvMap
= open(FvMapBuffer
, 'r')
1517 #skip FV size information
1523 MatchGuid
= GuidPattern
.match(Line
)
1524 if MatchGuid
!= None:
1526 # Replace GUID with module name
1528 GuidString
= MatchGuid
.group()
1529 if GuidString
.upper() in ModuleList
:
1530 Line
= Line
.replace(GuidString
, ModuleList
[GuidString
.upper()].Name
)
1531 MapBuffer
.write('%s' % (Line
))
1533 # Add the debug image full path.
1535 MatchGuid
= GuidName
.match(Line
)
1536 if MatchGuid
!= None:
1537 GuidString
= MatchGuid
.group().split("=")[1]
1538 if GuidString
.upper() in ModuleList
:
1539 MapBuffer
.write('(IMAGE=%s)\n' % (os
.path
.join(ModuleList
[GuidString
.upper()].DebugDir
, ModuleList
[GuidString
.upper()].Name
+ '.efi')))
1543 ## Collect MAP information of all modules
1545 def _CollectModuleMapBuffer (self
, MapBuffer
, ModuleList
):
1546 sys
.stdout
.write ("Generate Load Module At Fix Address Map")
1548 PatchEfiImageList
= []
1556 # reserve 4K size in SMRAM to make SMM module address not from 0.
1558 IsIpfPlatform
= False
1559 if 'IPF' in self
.ArchList
:
1560 IsIpfPlatform
= True
1561 for ModuleGuid
in ModuleList
:
1562 Module
= ModuleList
[ModuleGuid
]
1563 GlobalData
.gProcessingFile
= "%s [%s, %s, %s]" % (Module
.MetaFile
, Module
.Arch
, Module
.ToolChain
, Module
.BuildTarget
)
1565 OutputImageFile
= ''
1566 for ResultFile
in Module
.CodaTargetList
:
1567 if str(ResultFile
.Target
).endswith('.efi'):
1569 # module list for PEI, DXE, RUNTIME and SMM
1571 OutputImageFile
= os
.path
.join(Module
.OutputDir
, Module
.Name
+ '.efi')
1572 ImageClass
= PeImageClass (OutputImageFile
)
1573 if not ImageClass
.IsValid
:
1574 EdkLogger
.error("build", FILE_PARSE_FAILURE
, ExtraData
=ImageClass
.ErrorInfo
)
1575 ImageInfo
= PeImageInfo(Module
.Name
, Module
.Guid
, Module
.Arch
, Module
.OutputDir
, Module
.DebugDir
, ImageClass
)
1576 if Module
.ModuleType
in ['PEI_CORE', 'PEIM', 'COMBINED_PEIM_DRIVER', 'PIC_PEIM', 'RELOCATABLE_PEIM', 'DXE_CORE']:
1577 PeiModuleList
[Module
.MetaFile
] = ImageInfo
1578 PeiSize
+= ImageInfo
.Image
.Size
1579 elif Module
.ModuleType
in ['BS_DRIVER', 'DXE_DRIVER', 'UEFI_DRIVER']:
1580 BtModuleList
[Module
.MetaFile
] = ImageInfo
1581 BtSize
+= ImageInfo
.Image
.Size
1582 elif Module
.ModuleType
in ['DXE_RUNTIME_DRIVER', 'RT_DRIVER', 'DXE_SAL_DRIVER', 'SAL_RT_DRIVER']:
1583 RtModuleList
[Module
.MetaFile
] = ImageInfo
1584 #IPF runtime driver needs to be at 2 page alignment.
1585 if IsIpfPlatform
and ImageInfo
.Image
.Size
% 0x2000 != 0:
1586 ImageInfo
.Image
.Size
= (ImageInfo
.Image
.Size
/ 0x2000 + 1) * 0x2000
1587 RtSize
+= ImageInfo
.Image
.Size
1588 elif Module
.ModuleType
in ['SMM_CORE', 'DXE_SMM_DRIVER', 'MM_STANDALONE', 'MM_CORE_STANDALONE']:
1589 SmmModuleList
[Module
.MetaFile
] = ImageInfo
1590 SmmSize
+= ImageInfo
.Image
.Size
1591 if Module
.ModuleType
== 'DXE_SMM_DRIVER':
1592 PiSpecVersion
= '0x00000000'
1593 if 'PI_SPECIFICATION_VERSION' in Module
.Module
.Specification
:
1594 PiSpecVersion
= Module
.Module
.Specification
['PI_SPECIFICATION_VERSION']
1595 # for PI specification < PI1.1, DXE_SMM_DRIVER also runs as BOOT time driver.
1596 if int(PiSpecVersion
, 16) < 0x0001000A:
1597 BtModuleList
[Module
.MetaFile
] = ImageInfo
1598 BtSize
+= ImageInfo
.Image
.Size
1601 # EFI image is final target.
1602 # Check EFI image contains patchable FixAddress related PCDs.
1604 if OutputImageFile
!= '':
1605 ModuleIsPatch
= False
1606 for Pcd
in Module
.ModulePcdList
:
1607 if Pcd
.Type
== TAB_PCDS_PATCHABLE_IN_MODULE
and Pcd
.TokenCName
in TAB_PCDS_PATCHABLE_LOAD_FIX_ADDRESS_LIST
:
1608 ModuleIsPatch
= True
1610 if not ModuleIsPatch
:
1611 for Pcd
in Module
.LibraryPcdList
:
1612 if Pcd
.Type
== TAB_PCDS_PATCHABLE_IN_MODULE
and Pcd
.TokenCName
in TAB_PCDS_PATCHABLE_LOAD_FIX_ADDRESS_LIST
:
1613 ModuleIsPatch
= True
1616 if not ModuleIsPatch
:
1619 # Module includes the patchable load fix address PCDs.
1620 # It will be fixed up later.
1622 PatchEfiImageList
.append (OutputImageFile
)
1625 # Get Top Memory address
1627 ReservedRuntimeMemorySize
= 0
1628 TopMemoryAddress
= 0
1629 if self
.LoadFixAddress
== 0xFFFFFFFFFFFFFFFF:
1630 TopMemoryAddress
= 0
1632 TopMemoryAddress
= self
.LoadFixAddress
1633 if TopMemoryAddress
< RtSize
+ BtSize
+ PeiSize
:
1634 EdkLogger
.error("build", PARAMETER_INVALID
, "FIX_LOAD_TOP_MEMORY_ADDRESS is too low to load driver")
1635 # Make IPF runtime driver at 2 page alignment.
1637 ReservedRuntimeMemorySize
= TopMemoryAddress
% 0x2000
1638 RtSize
= RtSize
+ ReservedRuntimeMemorySize
1641 # Patch FixAddress related PCDs into EFI image
1643 for EfiImage
in PatchEfiImageList
:
1644 EfiImageMap
= EfiImage
.replace('.efi', '.map')
1645 if not os
.path
.exists(EfiImageMap
):
1648 # Get PCD offset in EFI image by GenPatchPcdTable function
1650 PcdTable
= parsePcdInfoFromMapFile(EfiImageMap
, EfiImage
)
1652 # Patch real PCD value by PatchPcdValue tool
1654 for PcdInfo
in PcdTable
:
1656 if PcdInfo
[0] == TAB_PCDS_PATCHABLE_LOAD_FIX_ADDRESS_PEI_PAGE_SIZE
:
1657 ReturnValue
, ErrorInfo
= PatchBinaryFile (EfiImage
, PcdInfo
[1], TAB_PCDS_PATCHABLE_LOAD_FIX_ADDRESS_PEI_PAGE_SIZE_DATA_TYPE
, str (PeiSize
/ 0x1000))
1658 elif PcdInfo
[0] == TAB_PCDS_PATCHABLE_LOAD_FIX_ADDRESS_DXE_PAGE_SIZE
:
1659 ReturnValue
, ErrorInfo
= PatchBinaryFile (EfiImage
, PcdInfo
[1], TAB_PCDS_PATCHABLE_LOAD_FIX_ADDRESS_DXE_PAGE_SIZE_DATA_TYPE
, str (BtSize
/ 0x1000))
1660 elif PcdInfo
[0] == TAB_PCDS_PATCHABLE_LOAD_FIX_ADDRESS_RUNTIME_PAGE_SIZE
:
1661 ReturnValue
, ErrorInfo
= PatchBinaryFile (EfiImage
, PcdInfo
[1], TAB_PCDS_PATCHABLE_LOAD_FIX_ADDRESS_RUNTIME_PAGE_SIZE_DATA_TYPE
, str (RtSize
/ 0x1000))
1662 elif PcdInfo
[0] == TAB_PCDS_PATCHABLE_LOAD_FIX_ADDRESS_SMM_PAGE_SIZE
and len (SmmModuleList
) > 0:
1663 ReturnValue
, ErrorInfo
= PatchBinaryFile (EfiImage
, PcdInfo
[1], TAB_PCDS_PATCHABLE_LOAD_FIX_ADDRESS_SMM_PAGE_SIZE_DATA_TYPE
, str (SmmSize
/ 0x1000))
1664 if ReturnValue
!= 0:
1665 EdkLogger
.error("build", PARAMETER_INVALID
, "Patch PCD value failed", ExtraData
=ErrorInfo
)
1667 MapBuffer
.write('PEI_CODE_PAGE_NUMBER = 0x%x\n' % (PeiSize
/ 0x1000))
1668 MapBuffer
.write('BOOT_CODE_PAGE_NUMBER = 0x%x\n' % (BtSize
/ 0x1000))
1669 MapBuffer
.write('RUNTIME_CODE_PAGE_NUMBER = 0x%x\n' % (RtSize
/ 0x1000))
1670 if len (SmmModuleList
) > 0:
1671 MapBuffer
.write('SMM_CODE_PAGE_NUMBER = 0x%x\n' % (SmmSize
/ 0x1000))
1673 PeiBaseAddr
= TopMemoryAddress
- RtSize
- BtSize
1674 BtBaseAddr
= TopMemoryAddress
- RtSize
1675 RtBaseAddr
= TopMemoryAddress
- ReservedRuntimeMemorySize
1677 self
._RebaseModule
(MapBuffer
, PeiBaseAddr
, PeiModuleList
, TopMemoryAddress
== 0)
1678 self
._RebaseModule
(MapBuffer
, BtBaseAddr
, BtModuleList
, TopMemoryAddress
== 0)
1679 self
._RebaseModule
(MapBuffer
, RtBaseAddr
, RtModuleList
, TopMemoryAddress
== 0)
1680 self
._RebaseModule
(MapBuffer
, 0x1000, SmmModuleList
, AddrIsOffset
=False, ModeIsSmm
=True)
1681 MapBuffer
.write('\n\n')
1682 sys
.stdout
.write ("\n")
1685 ## Save platform Map file
1687 def _SaveMapFile (self
, MapBuffer
, Wa
):
1689 # Map file path is got.
1691 MapFilePath
= os
.path
.join(Wa
.BuildDir
, Wa
.Name
+ '.map')
1693 # Save address map into MAP file.
1695 SaveFileOnChange(MapFilePath
, MapBuffer
.getvalue(), False)
1697 if self
.LoadFixAddress
!= 0:
1698 sys
.stdout
.write ("\nLoad Module At Fix Address Map file can be found at %s\n" % (MapFilePath
))
1701 ## Build active platform for different build targets and different tool chains
1703 def _BuildPlatform(self
):
1704 SaveFileOnChange(self
.PlatformBuildPath
, '# DO NOT EDIT \n# FILE auto-generated\n', False)
1705 for BuildTarget
in self
.BuildTargetList
:
1706 GlobalData
.gGlobalDefines
['TARGET'] = BuildTarget
1708 for ToolChain
in self
.ToolChainList
:
1709 GlobalData
.gGlobalDefines
['TOOLCHAIN'] = ToolChain
1710 GlobalData
.gGlobalDefines
['TOOL_CHAIN_TAG'] = ToolChain
1711 GlobalData
.gGlobalDefines
['FAMILY'] = self
.ToolChainFamily
[index
]
1713 Wa
= WorkspaceAutoGen(
1730 self
.Fdf
= Wa
.FdfFile
1731 self
.LoadFixAddress
= Wa
.Platform
.LoadFixAddress
1732 self
.BuildReport
.AddPlatformReport(Wa
)
1733 self
.Progress
.Stop("done!")
1734 for Arch
in Wa
.ArchList
:
1735 GlobalData
.gGlobalDefines
['ARCH'] = Arch
1736 Pa
= PlatformAutoGen(Wa
, self
.PlatformFile
, BuildTarget
, ToolChain
, Arch
)
1737 for Module
in Pa
.Platform
.Modules
:
1738 # Get ModuleAutoGen object to generate C code file and makefile
1739 Ma
= ModuleAutoGen(Wa
, Module
, BuildTarget
, ToolChain
, Arch
, self
.PlatformFile
)
1742 self
.BuildModules
.append(Ma
)
1743 self
._BuildPa
(self
.Target
, Pa
)
1745 # Create MAP file when Load Fix Address is enabled.
1746 if self
.Target
in ["", "all", "fds"]:
1747 for Arch
in Wa
.ArchList
:
1748 GlobalData
.gGlobalDefines
['ARCH'] = Arch
1750 # Check whether the set fix address is above 4G for 32bit image.
1752 if (Arch
== 'IA32' or Arch
== 'ARM') and self
.LoadFixAddress
!= 0xFFFFFFFFFFFFFFFF and self
.LoadFixAddress
>= 0x100000000:
1753 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")
1758 for Pa
in Wa
.AutoGenObjectList
:
1759 for Ma
in Pa
.ModuleAutoGenList
:
1762 if not Ma
.IsLibrary
:
1763 ModuleList
[Ma
.Guid
.upper()] = Ma
1765 MapBuffer
= StringIO('')
1766 if self
.LoadFixAddress
!= 0:
1768 # Rebase module to the preferred memory address before GenFds
1770 self
._CollectModuleMapBuffer
(MapBuffer
, ModuleList
)
1773 # create FDS again for the updated EFI image
1775 self
._Build
("fds", Wa
)
1777 # Create MAP file for all platform FVs after GenFds.
1779 self
._CollectFvMapBuffer
(MapBuffer
, Wa
, ModuleList
)
1781 # Save MAP buffer into MAP file.
1783 self
._SaveMapFile
(MapBuffer
, Wa
)
1785 ## Build active module for different build targets, different tool chains and different archs
1787 def _BuildModule(self
):
1788 for BuildTarget
in self
.BuildTargetList
:
1789 GlobalData
.gGlobalDefines
['TARGET'] = BuildTarget
1791 for ToolChain
in self
.ToolChainList
:
1792 WorkspaceAutoGenTime
= time
.time()
1793 GlobalData
.gGlobalDefines
['TOOLCHAIN'] = ToolChain
1794 GlobalData
.gGlobalDefines
['TOOL_CHAIN_TAG'] = ToolChain
1795 GlobalData
.gGlobalDefines
['FAMILY'] = self
.ToolChainFamily
[index
]
1798 # module build needs platform build information, so get platform
1801 Wa
= WorkspaceAutoGen(
1819 self
.Fdf
= Wa
.FdfFile
1820 self
.LoadFixAddress
= Wa
.Platform
.LoadFixAddress
1821 Wa
.CreateMakeFile(False)
1822 self
.Progress
.Stop("done!")
1824 ExitFlag
= threading
.Event()
1826 self
.AutoGenTime
+= int(round((time
.time() - WorkspaceAutoGenTime
)))
1827 for Arch
in Wa
.ArchList
:
1828 AutoGenStart
= time
.time()
1829 GlobalData
.gGlobalDefines
['ARCH'] = Arch
1830 Pa
= PlatformAutoGen(Wa
, self
.PlatformFile
, BuildTarget
, ToolChain
, Arch
)
1831 for Module
in Pa
.Platform
.Modules
:
1832 if self
.ModuleFile
.Dir
== Module
.Dir
and self
.ModuleFile
.Name
== Module
.Name
:
1833 Ma
= ModuleAutoGen(Wa
, Module
, BuildTarget
, ToolChain
, Arch
, self
.PlatformFile
)
1834 if Ma
== None: continue
1835 # Not to auto-gen for targets 'clean', 'cleanlib', 'cleanall', 'run', 'fds'
1836 if self
.Target
not in ['clean', 'cleanlib', 'cleanall', 'run', 'fds']:
1837 # for target which must generate AutoGen code and makefile
1838 if not self
.SkipAutoGen
or self
.Target
== 'genc':
1839 Ma
.CreateCodeFile(True)
1840 if not self
.SkipAutoGen
or self
.Target
== 'genmake':
1841 Ma
.CreateMakeFile(True)
1843 self
.BuildModules
.append(Ma
)
1844 self
.AutoGenTime
+= int(round((time
.time() - AutoGenStart
)))
1845 MakeStart
= time
.time()
1846 for Ma
in self
.BuildModules
:
1847 if not Ma
.IsBinaryModule
:
1848 Bt
= BuildTask
.New(ModuleMakeUnit(Ma
, self
.Target
))
1849 # Break build if any build thread has error
1850 if BuildTask
.HasError():
1851 # we need a full version of makefile for platform
1853 BuildTask
.WaitForComplete()
1854 Pa
.CreateMakeFile(False)
1855 EdkLogger
.error("build", BUILD_ERROR
, "Failed to build module", ExtraData
=GlobalData
.gBuildingModule
)
1856 # Start task scheduler
1857 if not BuildTask
.IsOnGoing():
1858 BuildTask
.StartScheduler(self
.ThreadNumber
, ExitFlag
)
1860 # in case there's an interruption. we need a full version of makefile for platform
1861 Pa
.CreateMakeFile(False)
1862 if BuildTask
.HasError():
1863 EdkLogger
.error("build", BUILD_ERROR
, "Failed to build module", ExtraData
=GlobalData
.gBuildingModule
)
1864 self
.MakeTime
+= int(round((time
.time() - MakeStart
)))
1866 MakeContiue
= time
.time()
1868 BuildTask
.WaitForComplete()
1869 self
.CreateAsBuiltInf()
1870 self
.MakeTime
+= int(round((time
.time() - MakeContiue
)))
1871 if BuildTask
.HasError():
1872 EdkLogger
.error("build", BUILD_ERROR
, "Failed to build module", ExtraData
=GlobalData
.gBuildingModule
)
1874 self
.BuildReport
.AddPlatformReport(Wa
, MaList
)
1879 "Module for [%s] is not a component of active platform."\
1880 " Please make sure that the ARCH and inf file path are"\
1881 " given in the same as in [%s]" % \
1882 (', '.join(Wa
.ArchList
), self
.PlatformFile
),
1883 ExtraData
=self
.ModuleFile
1885 # Create MAP file when Load Fix Address is enabled.
1886 if self
.Target
== "fds" and self
.Fdf
:
1887 for Arch
in Wa
.ArchList
:
1889 # Check whether the set fix address is above 4G for 32bit image.
1891 if (Arch
== 'IA32' or Arch
== 'ARM') and self
.LoadFixAddress
!= 0xFFFFFFFFFFFFFFFF and self
.LoadFixAddress
>= 0x100000000:
1892 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")
1897 for Pa
in Wa
.AutoGenObjectList
:
1898 for Ma
in Pa
.ModuleAutoGenList
:
1901 if not Ma
.IsLibrary
:
1902 ModuleList
[Ma
.Guid
.upper()] = Ma
1904 MapBuffer
= StringIO('')
1905 if self
.LoadFixAddress
!= 0:
1907 # Rebase module to the preferred memory address before GenFds
1909 self
._CollectModuleMapBuffer
(MapBuffer
, ModuleList
)
1911 # create FDS again for the updated EFI image
1913 GenFdsStart
= time
.time()
1914 self
._Build
("fds", Wa
)
1915 self
.GenFdsTime
+= int(round((time
.time() - GenFdsStart
)))
1917 # Create MAP file for all platform FVs after GenFds.
1919 self
._CollectFvMapBuffer
(MapBuffer
, Wa
, ModuleList
)
1921 # Save MAP buffer into MAP file.
1923 self
._SaveMapFile
(MapBuffer
, Wa
)
1925 ## Build a platform in multi-thread mode
1927 def _MultiThreadBuildPlatform(self
):
1928 SaveFileOnChange(self
.PlatformBuildPath
, '# DO NOT EDIT \n# FILE auto-generated\n', False)
1929 for BuildTarget
in self
.BuildTargetList
:
1930 GlobalData
.gGlobalDefines
['TARGET'] = BuildTarget
1932 for ToolChain
in self
.ToolChainList
:
1933 WorkspaceAutoGenTime
= time
.time()
1934 GlobalData
.gGlobalDefines
['TOOLCHAIN'] = ToolChain
1935 GlobalData
.gGlobalDefines
['TOOL_CHAIN_TAG'] = ToolChain
1936 GlobalData
.gGlobalDefines
['FAMILY'] = self
.ToolChainFamily
[index
]
1938 Wa
= WorkspaceAutoGen(
1955 self
.Fdf
= Wa
.FdfFile
1956 self
.LoadFixAddress
= Wa
.Platform
.LoadFixAddress
1957 self
.BuildReport
.AddPlatformReport(Wa
)
1958 Wa
.CreateMakeFile(False)
1960 # multi-thread exit flag
1961 ExitFlag
= threading
.Event()
1963 self
.AutoGenTime
+= int(round((time
.time() - WorkspaceAutoGenTime
)))
1964 for Arch
in Wa
.ArchList
:
1965 AutoGenStart
= time
.time()
1966 GlobalData
.gGlobalDefines
['ARCH'] = Arch
1967 Pa
= PlatformAutoGen(Wa
, self
.PlatformFile
, BuildTarget
, ToolChain
, Arch
)
1971 for Inf
in Pa
.Platform
.Modules
:
1972 ModuleList
.append(Inf
)
1973 # Add the INF only list in FDF
1974 if GlobalData
.gFdfParser
!= None:
1975 for InfName
in GlobalData
.gFdfParser
.Profile
.InfList
:
1976 Inf
= PathClass(NormPath(InfName
), self
.WorkspaceDir
, Arch
)
1977 if Inf
in Pa
.Platform
.Modules
:
1979 ModuleList
.append(Inf
)
1980 for Module
in ModuleList
:
1981 # Get ModuleAutoGen object to generate C code file and makefile
1982 Ma
= ModuleAutoGen(Wa
, Module
, BuildTarget
, ToolChain
, Arch
, self
.PlatformFile
)
1986 if Ma
.CanSkipbyHash():
1989 # Not to auto-gen for targets 'clean', 'cleanlib', 'cleanall', 'run', 'fds'
1990 if self
.Target
not in ['clean', 'cleanlib', 'cleanall', 'run', 'fds']:
1991 # for target which must generate AutoGen code and makefile
1992 if not self
.SkipAutoGen
or self
.Target
== 'genc':
1993 Ma
.CreateCodeFile(True)
1994 if self
.Target
== "genc":
1997 if not self
.SkipAutoGen
or self
.Target
== 'genmake':
1998 Ma
.CreateMakeFile(True)
1999 if self
.Target
== "genmake":
2001 self
.BuildModules
.append(Ma
)
2002 self
.Progress
.Stop("done!")
2003 self
.AutoGenTime
+= int(round((time
.time() - AutoGenStart
)))
2004 MakeStart
= time
.time()
2005 for Ma
in self
.BuildModules
:
2006 # Generate build task for the module
2007 if not Ma
.IsBinaryModule
:
2008 Bt
= BuildTask
.New(ModuleMakeUnit(Ma
, self
.Target
))
2009 # Break build if any build thread has error
2010 if BuildTask
.HasError():
2011 # we need a full version of makefile for platform
2013 BuildTask
.WaitForComplete()
2014 Pa
.CreateMakeFile(False)
2015 EdkLogger
.error("build", BUILD_ERROR
, "Failed to build module", ExtraData
=GlobalData
.gBuildingModule
)
2016 # Start task scheduler
2017 if not BuildTask
.IsOnGoing():
2018 BuildTask
.StartScheduler(self
.ThreadNumber
, ExitFlag
)
2020 # in case there's an interruption. we need a full version of makefile for platform
2021 Pa
.CreateMakeFile(False)
2022 if BuildTask
.HasError():
2023 EdkLogger
.error("build", BUILD_ERROR
, "Failed to build module", ExtraData
=GlobalData
.gBuildingModule
)
2024 self
.MakeTime
+= int(round((time
.time() - MakeStart
)))
2026 MakeContiue
= time
.time()
2028 # Save temp tables to a TmpTableDict.
2030 for Key
in Wa
.BuildDatabase
._CACHE
_:
2031 if Wa
.BuildDatabase
._CACHE
_[Key
]._RawData
and Wa
.BuildDatabase
._CACHE
_[Key
]._RawData
._Table
and Wa
.BuildDatabase
._CACHE
_[Key
]._RawData
._Table
.Table
:
2032 if TemporaryTablePattern
.match(Wa
.BuildDatabase
._CACHE
_[Key
]._RawData
._Table
.Table
):
2033 TmpTableDict
[Wa
.BuildDatabase
._CACHE
_[Key
]._RawData
._Table
.Table
] = Wa
.BuildDatabase
._CACHE
_[Key
]._RawData
._Table
.Cur
2036 # All modules have been put in build tasks queue. Tell task scheduler
2037 # to exit if all tasks are completed
2040 BuildTask
.WaitForComplete()
2041 self
.CreateAsBuiltInf()
2042 self
.MakeTime
+= int(round((time
.time() - MakeContiue
)))
2044 # Check for build error, and raise exception if one
2045 # has been signaled.
2047 if BuildTask
.HasError():
2048 EdkLogger
.error("build", BUILD_ERROR
, "Failed to build module", ExtraData
=GlobalData
.gBuildingModule
)
2050 # Create MAP file when Load Fix Address is enabled.
2051 if self
.Target
in ["", "all", "fds"]:
2052 for Arch
in Wa
.ArchList
:
2054 # Check whether the set fix address is above 4G for 32bit image.
2056 if (Arch
== 'IA32' or Arch
== 'ARM') and self
.LoadFixAddress
!= 0xFFFFFFFFFFFFFFFF and self
.LoadFixAddress
>= 0x100000000:
2057 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")
2062 for Pa
in Wa
.AutoGenObjectList
:
2063 for Ma
in Pa
.ModuleAutoGenList
:
2066 if not Ma
.IsLibrary
:
2067 ModuleList
[Ma
.Guid
.upper()] = Ma
2069 # Rebase module to the preferred memory address before GenFds
2071 MapBuffer
= StringIO('')
2072 if self
.LoadFixAddress
!= 0:
2073 self
._CollectModuleMapBuffer
(MapBuffer
, ModuleList
)
2077 # Generate FD image if there's a FDF file found
2079 GenFdsStart
= time
.time()
2080 LaunchCommand(Wa
.GenFdsCommand
, os
.getcwd())
2083 # Create MAP file for all platform FVs after GenFds.
2085 self
._CollectFvMapBuffer
(MapBuffer
, Wa
, ModuleList
)
2086 self
.GenFdsTime
+= int(round((time
.time() - GenFdsStart
)))
2088 # Save MAP buffer into MAP file.
2090 self
._SaveMapFile
(MapBuffer
, Wa
)
2092 ## Generate GuidedSectionTools.txt in the FV directories.
2094 def CreateGuidedSectionToolsFile(self
):
2095 for BuildTarget
in self
.BuildTargetList
:
2096 for ToolChain
in self
.ToolChainList
:
2097 Wa
= WorkspaceAutoGen(
2114 if not os
.path
.exists(FvDir
):
2117 for Arch
in self
.ArchList
:
2118 # Build up the list of supported architectures for this build
2119 prefix
= '%s_%s_%s_' % (BuildTarget
, ToolChain
, Arch
)
2121 # Look through the tool definitions for GUIDed tools
2123 for (attrib
, value
) in self
.ToolDef
.ToolsDefTxtDictionary
.iteritems():
2124 if attrib
.upper().endswith('_GUID'):
2125 split
= attrib
.split('_')
2126 thisPrefix
= '_'.join(split
[0:3]) + '_'
2127 if thisPrefix
== prefix
:
2128 guid
= self
.ToolDef
.ToolsDefTxtDictionary
[attrib
]
2131 path
= '_'.join(split
[0:4]) + '_PATH'
2132 path
= self
.ToolDef
.ToolsDefTxtDictionary
[path
]
2133 path
= self
.GetFullPathOfTool(path
)
2134 guidAttribs
.append((guid
, toolName
, path
))
2136 # Write out GuidedSecTools.txt
2137 toolsFile
= os
.path
.join(FvDir
, 'GuidedSectionTools.txt')
2138 toolsFile
= open(toolsFile
, 'wt')
2139 for guidedSectionTool
in guidAttribs
:
2140 print >> toolsFile
, ' '.join(guidedSectionTool
)
2143 ## Returns the full path of the tool.
2145 def GetFullPathOfTool (self
, tool
):
2146 if os
.path
.exists(tool
):
2147 return os
.path
.realpath(tool
)
2149 # We need to search for the tool using the
2150 # PATH environment variable.
2151 for dirInPath
in os
.environ
['PATH'].split(os
.pathsep
):
2152 foundPath
= os
.path
.join(dirInPath
, tool
)
2153 if os
.path
.exists(foundPath
):
2154 return os
.path
.realpath(foundPath
)
2156 # If the tool was not found in the path then we just return
2160 ## Launch the module or platform build
2163 if not self
.ModuleFile
:
2164 if not self
.SpawnMode
or self
.Target
not in ["", "all"]:
2165 self
.SpawnMode
= False
2166 self
._BuildPlatform
()
2168 self
._MultiThreadBuildPlatform
()
2169 self
.CreateGuidedSectionToolsFile()
2171 self
.SpawnMode
= False
2174 if self
.Target
== 'cleanall':
2176 RemoveDirectory(os
.path
.dirname(GlobalData
.gDatabasePath
), True)
2178 def CreateAsBuiltInf(self
):
2179 for Module
in self
.BuildModules
:
2180 Module
.CreateAsBuiltInf()
2181 self
.BuildModules
= []
2182 ## Do some clean-up works when error occurred
2183 def Relinquish(self
):
2184 OldLogLevel
= EdkLogger
.GetLevel()
2185 EdkLogger
.SetLevel(EdkLogger
.ERROR
)
2186 #self.DumpBuildData()
2187 Utils
.Progressor
.Abort()
2188 if self
.SpawnMode
== True:
2190 EdkLogger
.SetLevel(OldLogLevel
)
2192 def DumpBuildData(self
):
2193 CacheDirectory
= os
.path
.dirname(GlobalData
.gDatabasePath
)
2194 Utils
.CreateDirectory(CacheDirectory
)
2195 Utils
.DataDump(Utils
.gFileTimeStampCache
, os
.path
.join(CacheDirectory
, "gFileTimeStampCache"))
2196 Utils
.DataDump(Utils
.gDependencyDatabase
, os
.path
.join(CacheDirectory
, "gDependencyDatabase"))
2198 def RestoreBuildData(self
):
2199 FilePath
= os
.path
.join(os
.path
.dirname(GlobalData
.gDatabasePath
), "gFileTimeStampCache")
2200 if Utils
.gFileTimeStampCache
== {} and os
.path
.isfile(FilePath
):
2201 Utils
.gFileTimeStampCache
= Utils
.DataRestore(FilePath
)
2202 if Utils
.gFileTimeStampCache
== None:
2203 Utils
.gFileTimeStampCache
= {}
2205 FilePath
= os
.path
.join(os
.path
.dirname(GlobalData
.gDatabasePath
), "gDependencyDatabase")
2206 if Utils
.gDependencyDatabase
== {} and os
.path
.isfile(FilePath
):
2207 Utils
.gDependencyDatabase
= Utils
.DataRestore(FilePath
)
2208 if Utils
.gDependencyDatabase
== None:
2209 Utils
.gDependencyDatabase
= {}
2211 def ParseDefines(DefineList
=[]):
2213 if DefineList
!= None:
2214 for Define
in DefineList
:
2215 DefineTokenList
= Define
.split("=", 1)
2216 if not GlobalData
.gMacroNamePattern
.match(DefineTokenList
[0]):
2217 EdkLogger
.error('build', FORMAT_INVALID
,
2218 "The macro name must be in the pattern [A-Z][A-Z0-9_]*",
2219 ExtraData
=DefineTokenList
[0])
2221 if len(DefineTokenList
) == 1:
2222 DefineDict
[DefineTokenList
[0]] = "TRUE"
2224 DefineDict
[DefineTokenList
[0]] = DefineTokenList
[1].strip()
2228 def SingleCheckCallback(option
, opt_str
, value
, parser
):
2229 if option
not in gParamCheck
:
2230 setattr(parser
.values
, option
.dest
, value
)
2231 gParamCheck
.append(option
)
2233 parser
.error("Option %s only allows one instance in command line!" % option
)
2235 def LogBuildTime(Time
):
2238 TimeDur
= time
.gmtime(Time
)
2239 if TimeDur
.tm_yday
> 1:
2240 TimeDurStr
= time
.strftime("%H:%M:%S", TimeDur
) + ", %d day(s)" % (TimeDur
.tm_yday
- 1)
2242 TimeDurStr
= time
.strftime("%H:%M:%S", TimeDur
)
2247 ## Parse command line options
2249 # Using standard Python module optparse to parse command line option of this tool.
2251 # @retval Opt A optparse.Values object containing the parsed options
2252 # @retval Args Target of build command
2254 def MyOptionParser():
2255 Parser
= OptionParser(description
=__copyright__
, version
=__version__
, prog
="build.exe", usage
="%prog [options] [all|fds|genc|genmake|clean|cleanall|cleanlib|modules|libraries|run]")
2256 Parser
.add_option("-a", "--arch", action
="append", type="choice", choices
=['IA32', 'X64', 'IPF', 'EBC', 'ARM', 'AARCH64'], dest
="TargetArch",
2257 help="ARCHS is one of list: IA32, X64, IPF, ARM, AARCH64 or EBC, which overrides target.txt's TARGET_ARCH definition. To specify more archs, please repeat this option.")
2258 Parser
.add_option("-p", "--platform", action
="callback", type="string", dest
="PlatformFile", callback
=SingleCheckCallback
,
2259 help="Build the platform specified by the DSC file name argument, overriding target.txt's ACTIVE_PLATFORM definition.")
2260 Parser
.add_option("-m", "--module", action
="callback", type="string", dest
="ModuleFile", callback
=SingleCheckCallback
,
2261 help="Build the module specified by the INF file name argument.")
2262 Parser
.add_option("-b", "--buildtarget", type="string", dest
="BuildTarget", help="Using the TARGET to build the platform, overriding target.txt's TARGET definition.",
2264 Parser
.add_option("-t", "--tagname", action
="append", type="string", dest
="ToolChain",
2265 help="Using the Tool Chain Tagname to build the platform, overriding target.txt's TOOL_CHAIN_TAG definition.")
2266 Parser
.add_option("-x", "--sku-id", action
="callback", type="string", dest
="SkuId", callback
=SingleCheckCallback
,
2267 help="Using this name of SKU ID to build the platform, overriding SKUID_IDENTIFIER in DSC file.")
2269 Parser
.add_option("-n", action
="callback", type="int", dest
="ThreadNumber", callback
=SingleCheckCallback
,
2270 help="Build the platform using multi-threaded compiler. The value overrides target.txt's MAX_CONCURRENT_THREAD_NUMBER. Less than 2 will disable multi-thread builds.")
2272 Parser
.add_option("-f", "--fdf", action
="callback", type="string", dest
="FdfFile", callback
=SingleCheckCallback
,
2273 help="The name of the FDF file to use, which overrides the setting in the DSC file.")
2274 Parser
.add_option("-r", "--rom-image", action
="append", type="string", dest
="RomImage", default
=[],
2275 help="The name of FD to be generated. The name must be from [FD] section in FDF file.")
2276 Parser
.add_option("-i", "--fv-image", action
="append", type="string", dest
="FvImage", default
=[],
2277 help="The name of FV to be generated. The name must be from [FV] section in FDF file.")
2278 Parser
.add_option("-C", "--capsule-image", action
="append", type="string", dest
="CapName", default
=[],
2279 help="The name of Capsule to be generated. The name must be from [Capsule] section in FDF file.")
2280 Parser
.add_option("-u", "--skip-autogen", action
="store_true", dest
="SkipAutoGen", help="Skip AutoGen step.")
2281 Parser
.add_option("-e", "--re-parse", action
="store_true", dest
="Reparse", help="Re-parse all meta-data files.")
2283 Parser
.add_option("-c", "--case-insensitive", action
="store_true", dest
="CaseInsensitive", default
=False, help="Don't check case of file name.")
2285 Parser
.add_option("-w", "--warning-as-error", action
="store_true", dest
="WarningAsError", help="Treat warning in tools as error.")
2286 Parser
.add_option("-j", "--log", action
="store", dest
="LogFile", help="Put log in specified file as well as on console.")
2288 Parser
.add_option("-s", "--silent", action
="store_true", type=None, dest
="SilentMode",
2289 help="Make use of silent mode of (n)make.")
2290 Parser
.add_option("-q", "--quiet", action
="store_true", type=None, help="Disable all messages except FATAL ERRORS.")
2291 Parser
.add_option("-v", "--verbose", action
="store_true", type=None, help="Turn on verbose output with informational messages printed, "\
2292 "including library instances selected, final dependency expression, "\
2293 "and warning messages, etc.")
2294 Parser
.add_option("-d", "--debug", action
="store", type="int", help="Enable debug messages at specified level.")
2295 Parser
.add_option("-D", "--define", action
="append", type="string", dest
="Macros", help="Macro: \"Name [= Value]\".")
2297 Parser
.add_option("-y", "--report-file", action
="store", dest
="ReportFile", help="Create/overwrite the report to the specified filename.")
2298 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
=[],
2299 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]. "\
2300 "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]")
2301 Parser
.add_option("-F", "--flag", action
="store", type="string", dest
="Flag",
2302 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. "\
2303 "This option can also be specified by setting *_*_*_BUILD_FLAGS in [BuildOptions] section of platform DSC. If they are both specified, this value "\
2304 "will override the setting in [BuildOptions] section of platform DSC.")
2305 Parser
.add_option("-N", "--no-cache", action
="store_true", dest
="DisableCache", default
=False, help="Disable build cache mechanism")
2306 Parser
.add_option("--conf", action
="store", type="string", dest
="ConfDirectory", help="Specify the customized Conf directory.")
2307 Parser
.add_option("--check-usage", action
="store_true", dest
="CheckUsage", default
=False, help="Check usage content of entries listed in INF file.")
2308 Parser
.add_option("--ignore-sources", action
="store_true", dest
="IgnoreSources", default
=False, help="Focus to a binary build and ignore all source files")
2309 Parser
.add_option("--pcd", action
="append", dest
="OptionPcd", help="Set PCD value by command line. Format: \"PcdName=Value\" ")
2310 Parser
.add_option("-l", "--cmd-len", action
="store", type="int", dest
="CommandLength", help="Specify the maximum line length of build command. Default is 4096.")
2311 Parser
.add_option("--hash", action
="store_true", dest
="UseHashCache", default
=False, help="Enable hash-based caching during build process.")
2312 Parser
.add_option("--binary-destination", action
="store", type="string", dest
="BinCacheDest", help="Generate a cache of binary files in the specified directory.")
2313 Parser
.add_option("--binary-source", action
="store", type="string", dest
="BinCacheSource", help="Consume a cache of binary files from the specified directory.")
2315 (Opt
, Args
) = Parser
.parse_args()
2318 ## Tool entrance method
2320 # This method mainly dispatch specific methods per the command line options.
2321 # If no error found, return zero value so the caller of this tool can know
2322 # if it's executed successfully or not.
2324 # @retval 0 Tool was successful
2325 # @retval 1 Tool failed
2328 StartTime
= time
.time()
2330 # Initialize log system
2331 EdkLogger
.Initialize()
2332 GlobalData
.gCommand
= sys
.argv
[1:]
2334 # Parse the options and args
2336 (Option
, Target
) = MyOptionParser()
2337 GlobalData
.gOptions
= Option
2338 GlobalData
.gCaseInsensitive
= Option
.CaseInsensitive
2341 if Option
.verbose
!= None:
2342 EdkLogger
.SetLevel(EdkLogger
.VERBOSE
)
2343 elif Option
.quiet
!= None:
2344 EdkLogger
.SetLevel(EdkLogger
.QUIET
)
2345 elif Option
.debug
!= None:
2346 EdkLogger
.SetLevel(Option
.debug
+ 1)
2348 EdkLogger
.SetLevel(EdkLogger
.INFO
)
2350 if Option
.LogFile
!= None:
2351 EdkLogger
.SetLogFile(Option
.LogFile
)
2353 if Option
.WarningAsError
== True:
2354 EdkLogger
.SetWarningAsError()
2356 if platform
.platform().find("Windows") >= 0:
2357 GlobalData
.gIsWindows
= True
2359 GlobalData
.gIsWindows
= False
2361 EdkLogger
.quiet("Build environment: %s" % platform
.platform())
2362 EdkLogger
.quiet(time
.strftime("Build start time: %H:%M:%S, %b.%d %Y\n", time
.localtime()));
2367 if len(Target
) == 0:
2369 elif len(Target
) >= 2:
2370 EdkLogger
.error("build", OPTION_NOT_SUPPORTED
, "More than one targets are not supported.",
2371 ExtraData
="Please select one of: %s" % (' '.join(gSupportedTarget
)))
2373 Target
= Target
[0].lower()
2375 if Target
not in gSupportedTarget
:
2376 EdkLogger
.error("build", OPTION_NOT_SUPPORTED
, "Not supported target [%s]." % Target
,
2377 ExtraData
="Please select one of: %s" % (' '.join(gSupportedTarget
)))
2380 # Check environment variable: EDK_TOOLS_PATH, WORKSPACE, PATH
2383 GlobalData
.gCommandLineDefines
.update(ParseDefines(Option
.Macros
))
2385 Workspace
= os
.getenv("WORKSPACE")
2387 # Get files real name in workspace dir
2389 GlobalData
.gAllFiles
= Utils
.DirCache(Workspace
)
2391 WorkingDirectory
= os
.getcwd()
2392 if not Option
.ModuleFile
:
2393 FileList
= glob
.glob(os
.path
.normpath(os
.path
.join(WorkingDirectory
, '*.inf')))
2394 FileNum
= len(FileList
)
2396 EdkLogger
.error("build", OPTION_NOT_SUPPORTED
, "There are %d INF files in %s." % (FileNum
, WorkingDirectory
),
2397 ExtraData
="Please use '-m <INF_FILE_PATH>' switch to choose one.")
2399 Option
.ModuleFile
= NormFile(FileList
[0], Workspace
)
2401 if Option
.ModuleFile
:
2402 if os
.path
.isabs (Option
.ModuleFile
):
2403 if os
.path
.normcase (os
.path
.normpath(Option
.ModuleFile
)).find (Workspace
) == 0:
2404 Option
.ModuleFile
= NormFile(os
.path
.normpath(Option
.ModuleFile
), Workspace
)
2405 Option
.ModuleFile
= PathClass(Option
.ModuleFile
, Workspace
)
2406 ErrorCode
, ErrorInfo
= Option
.ModuleFile
.Validate(".inf", False)
2408 EdkLogger
.error("build", ErrorCode
, ExtraData
=ErrorInfo
)
2410 if Option
.PlatformFile
!= None:
2411 if os
.path
.isabs (Option
.PlatformFile
):
2412 if os
.path
.normcase (os
.path
.normpath(Option
.PlatformFile
)).find (Workspace
) == 0:
2413 Option
.PlatformFile
= NormFile(os
.path
.normpath(Option
.PlatformFile
), Workspace
)
2414 Option
.PlatformFile
= PathClass(Option
.PlatformFile
, Workspace
)
2416 if Option
.FdfFile
!= None:
2417 if os
.path
.isabs (Option
.FdfFile
):
2418 if os
.path
.normcase (os
.path
.normpath(Option
.FdfFile
)).find (Workspace
) == 0:
2419 Option
.FdfFile
= NormFile(os
.path
.normpath(Option
.FdfFile
), Workspace
)
2420 Option
.FdfFile
= PathClass(Option
.FdfFile
, Workspace
)
2421 ErrorCode
, ErrorInfo
= Option
.FdfFile
.Validate(".fdf", False)
2423 EdkLogger
.error("build", ErrorCode
, ExtraData
=ErrorInfo
)
2425 if Option
.Flag
!= None and Option
.Flag
not in ['-c', '-s']:
2426 EdkLogger
.error("build", OPTION_VALUE_INVALID
, "UNI flag must be one of -c or -s")
2428 MyBuild
= Build(Target
, Workspace
, Option
)
2429 GlobalData
.gCommandLineDefines
['ARCH'] = ' '.join(MyBuild
.ArchList
)
2430 if not (MyBuild
.LaunchPrebuildFlag
and os
.path
.exists(MyBuild
.PlatformBuildPath
)):
2432 # Drop temp tables to avoid database locked.
2433 for TmpTableName
in TmpTableDict
:
2434 SqlCommand
= """drop table IF EXISTS %s""" % TmpTableName
2435 TmpTableDict
[TmpTableName
].execute(SqlCommand
)
2436 #MyBuild.DumpBuildData()
2438 # All job done, no error found and no exception raised
2441 except FatalError
, X
:
2443 # for multi-thread build exits safely
2444 MyBuild
.Relinquish()
2445 if Option
!= None and Option
.debug
!= None:
2446 EdkLogger
.quiet("(Python %s on %s) " % (platform
.python_version(), sys
.platform
) + traceback
.format_exc())
2447 ReturnCode
= X
.args
[0]
2449 # error from Fdf parser
2451 # for multi-thread build exits safely
2452 MyBuild
.Relinquish()
2453 if Option
!= None and Option
.debug
!= None:
2454 EdkLogger
.quiet("(Python %s on %s) " % (platform
.python_version(), sys
.platform
) + traceback
.format_exc())
2456 EdkLogger
.error(X
.ToolName
, FORMAT_INVALID
, File
=X
.FileName
, Line
=X
.LineNumber
, ExtraData
=X
.Message
, RaiseError
=False)
2457 ReturnCode
= FORMAT_INVALID
2458 except KeyboardInterrupt:
2459 ReturnCode
= ABORT_ERROR
2460 if Option
!= None and Option
.debug
!= None:
2461 EdkLogger
.quiet("(Python %s on %s) " % (platform
.python_version(), sys
.platform
) + traceback
.format_exc())
2464 # for multi-thread build exits safely
2465 MyBuild
.Relinquish()
2467 # try to get the meta-file from the object causing exception
2468 Tb
= sys
.exc_info()[-1]
2469 MetaFile
= GlobalData
.gProcessingFile
2471 if 'self' in Tb
.tb_frame
.f_locals
and hasattr(Tb
.tb_frame
.f_locals
['self'], 'MetaFile'):
2472 MetaFile
= Tb
.tb_frame
.f_locals
['self'].MetaFile
2477 "Unknown fatal error when processing [%s]" % MetaFile
,
2478 ExtraData
="\n(Please send email to edk2-devel@lists.01.org for help, attaching following call stack trace!)\n",
2481 EdkLogger
.quiet("(Python %s on %s) " % (platform
.python_version(), sys
.platform
) + traceback
.format_exc())
2482 ReturnCode
= CODE_ERROR
2484 Utils
.Progressor
.Abort()
2485 Utils
.ClearDuplicatedInf()
2489 MyBuild
.LaunchPostbuild()
2492 Conclusion
= "Failed"
2493 elif ReturnCode
== ABORT_ERROR
:
2494 Conclusion
= "Aborted"
2496 Conclusion
= "Failed"
2497 FinishTime
= time
.time()
2498 BuildDuration
= time
.gmtime(int(round(FinishTime
- StartTime
)))
2499 BuildDurationStr
= ""
2500 if BuildDuration
.tm_yday
> 1:
2501 BuildDurationStr
= time
.strftime("%H:%M:%S", BuildDuration
) + ", %d day(s)" % (BuildDuration
.tm_yday
- 1)
2503 BuildDurationStr
= time
.strftime("%H:%M:%S", BuildDuration
)
2506 MyBuild
.BuildReport
.GenerateReport(BuildDurationStr
, LogBuildTime(MyBuild
.AutoGenTime
), LogBuildTime(MyBuild
.MakeTime
), LogBuildTime(MyBuild
.GenFdsTime
))
2508 EdkLogger
.SetLevel(EdkLogger
.QUIET
)
2509 EdkLogger
.quiet("\n- %s -" % Conclusion
)
2510 EdkLogger
.quiet(time
.strftime("Build end time: %H:%M:%S, %b.%d %Y", time
.localtime()))
2511 EdkLogger
.quiet("Build total time: %s\n" % BuildDurationStr
)
2514 if __name__
== '__main__':
2516 ## 0-127 is a safe return range, and 1 is a standard default error
2517 if r
< 0 or r
> 127: r
= 1