2 # build a platform or a module
4 # Copyright (c) 2007 - 2010, Intel Corporation
6 # All rights reserved. This program and the accompanying materials
7 # are licensed and made available under the terms and conditions of the BSD License
8 # which accompanies this distribution. The full text of the license may be found at
9 # http://opensource.org/licenses/bsd-license.php
11 # THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
12 # WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
28 from threading
import *
29 from optparse
import OptionParser
30 from subprocess
import *
31 from Common
import Misc
as Utils
33 from Common
.TargetTxtClassObject
import *
34 from Common
.ToolDefClassObject
import *
35 from Common
.DataType
import *
36 from AutoGen
.AutoGen
import *
37 from Common
.BuildToolError
import *
38 from Workspace
.WorkspaceDatabase
import *
40 from BuildReport
import BuildReport
41 from GenPatchPcdTable
.GenPatchPcdTable
import *
42 from PatchPcdValue
.PatchPcdValue
import *
44 import Common
.EdkLogger
45 import Common
.GlobalData
as GlobalData
47 # Version and Copyright
49 __version__
= "%prog Version " + VersionNumber
50 __copyright__
= "Copyright (c) 2007 - 2010, Intel Corporation All rights reserved."
52 ## standard targets of build command
53 gSupportedTarget
= ['all', 'genc', 'genmake', 'modules', 'libraries', 'fds', 'clean', 'cleanall', 'cleanlib', 'run']
55 ## build configuration file
56 gBuildConfiguration
= "Conf/target.txt"
57 gBuildCacheDir
= "Conf/.cache"
58 gToolsDefinition
= "Conf/tools_def.txt"
60 ## Check environment PATH variable to make sure the specified tool is found
62 # If the tool is found in the PATH, then True is returned
63 # Otherwise, False is returned
65 def IsToolInPath(tool
):
66 if os
.environ
.has_key('PATHEXT'):
67 extns
= os
.environ
['PATHEXT'].split(os
.path
.pathsep
)
70 for pathDir
in os
.environ
['PATH'].split(os
.path
.pathsep
):
72 if os
.path
.exists(os
.path
.join(pathDir
, tool
+ ext
)):
76 ## Check environment variables
78 # Check environment variables that must be set for build. Currently they are
80 # WORKSPACE The directory all packages/platforms start from
81 # EDK_TOOLS_PATH The directory contains all tools needed by the build
82 # PATH $(EDK_TOOLS_PATH)/Bin/<sys> must be set in PATH
84 # If any of above environment variable is not set or has error, the build
87 def CheckEnvVariable():
89 if "WORKSPACE" not in os
.environ
:
90 EdkLogger
.error("build", ATTRIBUTE_NOT_AVAILABLE
, "Environment variable not found",
91 ExtraData
="WORKSPACE")
93 WorkspaceDir
= os
.path
.normcase(os
.path
.normpath(os
.environ
["WORKSPACE"]))
94 if not os
.path
.exists(WorkspaceDir
):
95 EdkLogger
.error("build", FILE_NOT_FOUND
, "WORKSPACE doesn't exist", ExtraData
="%s" % WorkspaceDir
)
96 elif ' ' in WorkspaceDir
:
97 EdkLogger
.error("build", FORMAT_NOT_SUPPORTED
, "No space is allowed in WORKSPACE path",
98 ExtraData
=WorkspaceDir
)
99 os
.environ
["WORKSPACE"] = WorkspaceDir
102 # Check EFI_SOURCE (R8 build convention). EDK_SOURCE will always point to ECP
104 os
.environ
["ECP_SOURCE"] = os
.path
.join(WorkspaceDir
, GlobalData
.gEdkCompatibilityPkg
)
105 if "EFI_SOURCE" not in os
.environ
:
106 os
.environ
["EFI_SOURCE"] = os
.environ
["ECP_SOURCE"]
107 if "EDK_SOURCE" not in os
.environ
:
108 os
.environ
["EDK_SOURCE"] = os
.environ
["ECP_SOURCE"]
111 # Unify case of characters on case-insensitive systems
113 EfiSourceDir
= os
.path
.normcase(os
.path
.normpath(os
.environ
["EFI_SOURCE"]))
114 EdkSourceDir
= os
.path
.normcase(os
.path
.normpath(os
.environ
["EDK_SOURCE"]))
115 EcpSourceDir
= os
.path
.normcase(os
.path
.normpath(os
.environ
["ECP_SOURCE"]))
117 os
.environ
["EFI_SOURCE"] = EfiSourceDir
118 os
.environ
["EDK_SOURCE"] = EdkSourceDir
119 os
.environ
["ECP_SOURCE"] = EcpSourceDir
120 os
.environ
["EDK_TOOLS_PATH"] = os
.path
.normcase(os
.environ
["EDK_TOOLS_PATH"])
122 if not os
.path
.exists(EcpSourceDir
):
123 EdkLogger
.verbose("ECP_SOURCE = %s doesn't exist. R8 modules could not be built." % EcpSourceDir
)
124 elif ' ' in EcpSourceDir
:
125 EdkLogger
.error("build", FORMAT_NOT_SUPPORTED
, "No space is allowed in ECP_SOURCE path",
126 ExtraData
=EcpSourceDir
)
127 if not os
.path
.exists(EdkSourceDir
):
128 if EdkSourceDir
== EcpSourceDir
:
129 EdkLogger
.verbose("EDK_SOURCE = %s doesn't exist. R8 modules could not be built." % EdkSourceDir
)
131 EdkLogger
.error("build", PARAMETER_INVALID
, "EDK_SOURCE does not exist",
132 ExtraData
=EdkSourceDir
)
133 elif ' ' in EdkSourceDir
:
134 EdkLogger
.error("build", FORMAT_NOT_SUPPORTED
, "No space is allowed in EDK_SOURCE path",
135 ExtraData
=EdkSourceDir
)
136 if not os
.path
.exists(EfiSourceDir
):
137 if EfiSourceDir
== EcpSourceDir
:
138 EdkLogger
.verbose("EFI_SOURCE = %s doesn't exist. R8 modules could not be built." % EfiSourceDir
)
140 EdkLogger
.error("build", PARAMETER_INVALID
, "EFI_SOURCE does not exist",
141 ExtraData
=EfiSourceDir
)
142 elif ' ' in EfiSourceDir
:
143 EdkLogger
.error("build", FORMAT_NOT_SUPPORTED
, "No space is allowed in EFI_SOURCE path",
144 ExtraData
=EfiSourceDir
)
146 # change absolute path to relative path to WORKSPACE
147 if EfiSourceDir
.upper().find(WorkspaceDir
.upper()) != 0:
148 EdkLogger
.error("build", PARAMETER_INVALID
, "EFI_SOURCE is not under WORKSPACE",
149 ExtraData
="WORKSPACE = %s\n EFI_SOURCE = %s" % (WorkspaceDir
, EfiSourceDir
))
150 if EdkSourceDir
.upper().find(WorkspaceDir
.upper()) != 0:
151 EdkLogger
.error("build", PARAMETER_INVALID
, "EDK_SOURCE is not under WORKSPACE",
152 ExtraData
="WORKSPACE = %s\n EDK_SOURCE = %s" % (WorkspaceDir
, EdkSourceDir
))
153 if EcpSourceDir
.upper().find(WorkspaceDir
.upper()) != 0:
154 EdkLogger
.error("build", PARAMETER_INVALID
, "ECP_SOURCE is not under WORKSPACE",
155 ExtraData
="WORKSPACE = %s\n ECP_SOURCE = %s" % (WorkspaceDir
, EcpSourceDir
))
157 # check EDK_TOOLS_PATH
158 if "EDK_TOOLS_PATH" not in os
.environ
:
159 EdkLogger
.error("build", ATTRIBUTE_NOT_AVAILABLE
, "Environment variable not found",
160 ExtraData
="EDK_TOOLS_PATH")
163 if "PATH" not in os
.environ
:
164 EdkLogger
.error("build", ATTRIBUTE_NOT_AVAILABLE
, "Environment variable not found",
167 GlobalData
.gWorkspace
= WorkspaceDir
168 GlobalData
.gEfiSource
= EfiSourceDir
169 GlobalData
.gEdkSource
= EdkSourceDir
170 GlobalData
.gEcpSource
= EcpSourceDir
172 ## Get normalized file path
174 # Convert the path to be local format, and remove the WORKSPACE path at the
175 # beginning if the file path is given in full path.
177 # @param FilePath File path to be normalized
178 # @param Workspace Workspace path which the FilePath will be checked against
180 # @retval string The normalized file path
182 def NormFile(FilePath
, Workspace
):
183 # check if the path is absolute or relative
184 if os
.path
.isabs(FilePath
):
185 FileFullPath
= os
.path
.normpath(FilePath
)
187 FileFullPath
= os
.path
.normpath(os
.path
.join(Workspace
, FilePath
))
189 # check if the file path exists or not
190 if not os
.path
.isfile(FileFullPath
):
191 EdkLogger
.error("build", FILE_NOT_FOUND
, ExtraData
="\t%s (Please give file in absolute path or relative to WORKSPACE)" % FileFullPath
)
193 # remove workspace directory from the beginning part of the file path
194 if Workspace
[-1] in ["\\", "/"]:
195 return FileFullPath
[len(Workspace
):]
197 return FileFullPath
[(len(Workspace
) + 1):]
199 ## Get the output of an external program
201 # This is the entrance method of thread reading output of an external program and
202 # putting them in STDOUT/STDERR of current program.
204 # @param From The stream message read from
205 # @param To The stream message put on
206 # @param ExitFlag The flag used to indicate stopping reading
208 def ReadMessage(From
, To
, ExitFlag
):
210 # read one line a time
211 Line
= From
.readline()
212 # empty string means "end"
213 if Line
!= None and Line
!= "":
220 ## Launch an external program
222 # This method will call subprocess.Popen to execute an external program with
223 # given options in specified directory. Because of the dead-lock issue during
224 # redirecting output of the external program, threads are used to to do the
227 # @param Command A list or string containing the call of the program
228 # @param WorkingDir The directory in which the program will be running
230 def LaunchCommand(Command
, WorkingDir
):
231 # if working directory doesn't exist, Popen() will raise an exception
232 if not os
.path
.isdir(WorkingDir
):
233 EdkLogger
.error("build", FILE_NOT_FOUND
, ExtraData
=WorkingDir
)
236 EndOfProcedure
= None
239 Proc
= Popen(Command
, stdout
=PIPE
, stderr
=PIPE
, env
=os
.environ
, cwd
=WorkingDir
, bufsize
=-1)
241 # launch two threads to read the STDOUT and STDERR
242 EndOfProcedure
= Event()
243 EndOfProcedure
.clear()
245 StdOutThread
= Thread(target
=ReadMessage
, args
=(Proc
.stdout
, EdkLogger
.info
, EndOfProcedure
))
246 StdOutThread
.setName("STDOUT-Redirector")
247 StdOutThread
.setDaemon(False)
251 StdErrThread
= Thread(target
=ReadMessage
, args
=(Proc
.stderr
, EdkLogger
.quiet
, EndOfProcedure
))
252 StdErrThread
.setName("STDERR-Redirector")
253 StdErrThread
.setDaemon(False)
256 # waiting for program exit
258 except: # in case of aborting
259 # terminate the threads redirecting the program output
260 if EndOfProcedure
!= None:
263 if type(Command
) != type(""):
264 Command
= " ".join(Command
)
265 EdkLogger
.error("build", COMMAND_FAILURE
, "Failed to start command", ExtraData
="%s [%s]" % (Command
, WorkingDir
))
272 # check the return code of the program
273 if Proc
.returncode
!= 0:
274 if type(Command
) != type(""):
275 Command
= " ".join(Command
)
276 EdkLogger
.error("build", COMMAND_FAILURE
, ExtraData
="%s [%s]" % (Command
, WorkingDir
))
278 ## The smallest unit that can be built in multi-thread build mode
280 # This is the base class of build unit. The "Obj" parameter must provide
281 # __str__(), __eq__() and __hash__() methods. Otherwise there could be build units
284 # Currently the "Obj" should be only ModuleAutoGen or PlatformAutoGen objects.
289 # @param self The object pointer
290 # @param Obj The object the build is working on
291 # @param Target The build target name, one of gSupportedTarget
292 # @param Dependency The BuildUnit(s) which must be completed in advance
293 # @param WorkingDir The directory build command starts in
295 def __init__(self
, Obj
, BuildCommand
, Target
, Dependency
, WorkingDir
="."):
296 self
.BuildObject
= Obj
297 self
.Dependency
= Dependency
298 self
.WorkingDir
= WorkingDir
300 self
.BuildCommand
= BuildCommand
301 if BuildCommand
== None or len(BuildCommand
) == 0:
302 EdkLogger
.error("build", OPTION_MISSING
, "No build command found for",
307 # It just returns the string representaion of self.BuildObject
309 # @param self The object pointer
312 return str(self
.BuildObject
)
314 ## "==" operator method
316 # It just compares self.BuildObject with "Other". So self.BuildObject must
317 # provide its own __eq__() method.
319 # @param self The object pointer
320 # @param Other The other BuildUnit object compared to
322 def __eq__(self
, Other
):
323 return Other
!= None and self
.BuildObject
== Other
.BuildObject \
324 and self
.BuildObject
.Arch
== Other
.BuildObject
.Arch
328 # It just returns the hash value of self.BuildObject which must be hashable.
330 # @param self The object pointer
333 return hash(self
.BuildObject
) + hash(self
.BuildObject
.Arch
)
336 return repr(self
.BuildObject
)
338 ## The smallest module unit that can be built by nmake/make command in multi-thread build mode
340 # This class is for module build by nmake/make build system. The "Obj" parameter
341 # must provide __str__(), __eq__() and __hash__() methods. Otherwise there could
342 # be make units missing build.
344 # Currently the "Obj" should be only ModuleAutoGen object.
346 class ModuleMakeUnit(BuildUnit
):
349 # @param self The object pointer
350 # @param Obj The ModuleAutoGen object the build is working on
351 # @param Target The build target name, one of gSupportedTarget
353 def __init__(self
, Obj
, Target
):
354 Dependency
= [ModuleMakeUnit(La
, Target
) for La
in Obj
.LibraryAutoGenList
]
355 BuildUnit
.__init
__(self
, Obj
, Obj
.BuildCommand
, Target
, Dependency
, Obj
.MakeFileDir
)
356 if Target
in [None, "", "all"]:
357 self
.Target
= "tbuild"
359 ## The smallest platform unit that can be built by nmake/make command in multi-thread build mode
361 # This class is for platform build by nmake/make build system. The "Obj" parameter
362 # must provide __str__(), __eq__() and __hash__() methods. Otherwise there could
363 # be make units missing build.
365 # Currently the "Obj" should be only PlatformAutoGen object.
367 class PlatformMakeUnit(BuildUnit
):
370 # @param self The object pointer
371 # @param Obj The PlatformAutoGen object the build is working on
372 # @param Target The build target name, one of gSupportedTarget
374 def __init__(self
, Obj
, Target
):
375 Dependency
= [ModuleMakeUnit(Lib
, Target
) for Lib
in self
.BuildObject
.LibraryAutoGenList
]
376 Dependency
.extend([ModuleMakeUnit(Mod
, Target
) for Mod
in self
.BuildObject
.ModuleAutoGenList
])
377 BuildUnit
.__init
__(self
, Obj
, Obj
.BuildCommand
, Target
, Dependency
, Obj
.MakeFileDir
)
379 ## The class representing the task of a module build or platform build
381 # This class manages the build tasks in multi-thread build mode. Its jobs include
382 # scheduling thread running, catching thread error, monitor the thread status, etc.
385 # queue for tasks waiting for schedule
386 _PendingQueue
= sdict()
387 _PendingQueueLock
= threading
.Lock()
389 # queue for tasks ready for running
390 _ReadyQueue
= sdict()
391 _ReadyQueueLock
= threading
.Lock()
393 # queue for run tasks
394 _RunningQueue
= sdict()
395 _RunningQueueLock
= threading
.Lock()
397 # queue containing all build tasks, in case duplicate build
400 # flag indicating error occurs in a running thread
401 _ErrorFlag
= threading
.Event()
405 # BoundedSemaphore object used to control the number of running threads
408 # flag indicating if the scheduler is started or not
409 _SchedulerStopped
= threading
.Event()
410 _SchedulerStopped
.set()
412 ## Start the task scheduler thread
414 # @param MaxThreadNumber The maximum thread number
415 # @param ExitFlag Flag used to end the scheduler
418 def StartScheduler(MaxThreadNumber
, ExitFlag
):
419 SchedulerThread
= Thread(target
=BuildTask
.Scheduler
, args
=(MaxThreadNumber
, ExitFlag
))
420 SchedulerThread
.setName("Build-Task-Scheduler")
421 SchedulerThread
.setDaemon(False)
422 SchedulerThread
.start()
423 # wait for the scheduler to be started, especially useful in Linux
424 while not BuildTask
.IsOnGoing():
429 # @param MaxThreadNumber The maximum thread number
430 # @param ExitFlag Flag used to end the scheduler
433 def Scheduler(MaxThreadNumber
, ExitFlag
):
434 BuildTask
._SchedulerStopped
.clear()
436 # use BoundedSemaphore to control the maximum running threads
437 BuildTask
._Thread
= BoundedSemaphore(MaxThreadNumber
)
439 # scheduling loop, which will exits when no pending/ready task and
440 # indicated to do so, or there's error in running thread
442 while (len(BuildTask
._PendingQueue
) > 0 or len(BuildTask
._ReadyQueue
) > 0 \
443 or not ExitFlag
.isSet()) and not BuildTask
._ErrorFlag
.isSet():
444 EdkLogger
.debug(EdkLogger
.DEBUG_8
, "Pending Queue (%d), Ready Queue (%d)"
445 % (len(BuildTask
._PendingQueue
), len(BuildTask
._ReadyQueue
)))
447 # get all pending tasks
448 BuildTask
._PendingQueueLock
.acquire()
449 BuildObjectList
= BuildTask
._PendingQueue
.keys()
451 # check if their dependency is resolved, and if true, move them
454 for BuildObject
in BuildObjectList
:
455 Bt
= BuildTask
._PendingQueue
[BuildObject
]
457 BuildTask
._ReadyQueue
[BuildObject
] = BuildTask
._PendingQueue
.pop(BuildObject
)
458 BuildTask
._PendingQueueLock
.release()
460 # launch build thread until the maximum number of threads is reached
461 while not BuildTask
._ErrorFlag
.isSet():
462 # empty ready queue, do nothing further
463 if len(BuildTask
._ReadyQueue
) == 0:
466 # wait for active thread(s) exit
467 BuildTask
._Thread
.acquire(True)
469 # start a new build thread
470 Bo
= BuildTask
._ReadyQueue
.keys()[0]
471 Bt
= BuildTask
._ReadyQueue
.pop(Bo
)
473 # move into running queue
474 BuildTask
._RunningQueueLock
.acquire()
475 BuildTask
._RunningQueue
[Bo
] = Bt
476 BuildTask
._RunningQueueLock
.release()
485 # wait for all running threads exit
486 if BuildTask
._ErrorFlag
.isSet():
487 EdkLogger
.quiet("\nWaiting for all build threads exit...")
488 # while not BuildTask._ErrorFlag.isSet() and \
489 while len(BuildTask
._RunningQueue
) > 0:
490 EdkLogger
.verbose("Waiting for thread ending...(%d)" % len(BuildTask
._RunningQueue
))
491 EdkLogger
.debug(EdkLogger
.DEBUG_8
, "Threads [%s]" % ", ".join([Th
.getName() for Th
in threading
.enumerate()]))
494 except BaseException
, X
:
496 # TRICK: hide the output of threads left runing, so that the user can
497 # catch the error message easily
499 EdkLogger
.SetLevel(EdkLogger
.ERROR
)
500 BuildTask
._ErrorFlag
.set()
501 BuildTask
._ErrorMessage
= "build thread scheduler error\n\t%s" % str(X
)
503 BuildTask
._PendingQueue
.clear()
504 BuildTask
._ReadyQueue
.clear()
505 BuildTask
._RunningQueue
.clear()
506 BuildTask
._TaskQueue
.clear()
507 BuildTask
._SchedulerStopped
.set()
509 ## Wait for all running method exit
512 def WaitForComplete():
513 BuildTask
._SchedulerStopped
.wait()
515 ## Check if the scheduler is running or not
519 return not BuildTask
._SchedulerStopped
.isSet()
524 if BuildTask
.IsOnGoing():
525 BuildTask
._ErrorFlag
.set()
526 BuildTask
.WaitForComplete()
528 ## Check if there's error in running thread
530 # Since the main thread cannot catch exceptions in other thread, we have to
531 # use threading.Event to communicate this formation to main thread.
535 return BuildTask
._ErrorFlag
.isSet()
537 ## Get error message in running thread
539 # Since the main thread cannot catch exceptions in other thread, we have to
540 # use a static variable to communicate this message to main thread.
543 def GetErrorMessage():
544 return BuildTask
._ErrorMessage
546 ## Factory method to create a BuildTask object
548 # This method will check if a module is building or has been built. And if
549 # true, just return the associated BuildTask object in the _TaskQueue. If
550 # not, create and return a new BuildTask object. The new BuildTask object
551 # will be appended to the _PendingQueue for scheduling later.
553 # @param BuildItem A BuildUnit object representing a build object
554 # @param Dependency The dependent build object of BuildItem
557 def New(BuildItem
, Dependency
=None):
558 if BuildItem
in BuildTask
._TaskQueue
:
559 Bt
= BuildTask
._TaskQueue
[BuildItem
]
563 Bt
._Init
(BuildItem
, Dependency
)
564 BuildTask
._TaskQueue
[BuildItem
] = Bt
566 BuildTask
._PendingQueueLock
.acquire()
567 BuildTask
._PendingQueue
[BuildItem
] = Bt
568 BuildTask
._PendingQueueLock
.release()
572 ## The real constructor of BuildTask
574 # @param BuildItem A BuildUnit object representing a build object
575 # @param Dependency The dependent build object of BuildItem
577 def _Init(self
, BuildItem
, Dependency
=None):
578 self
.BuildItem
= BuildItem
580 self
.DependencyList
= []
581 if Dependency
== None:
582 Dependency
= BuildItem
.Dependency
584 Dependency
.extend(BuildItem
.Dependency
)
585 self
.AddDependency(Dependency
)
586 # flag indicating build completes, used to avoid unnecessary re-build
587 self
.CompleteFlag
= False
589 ## Check if all dependent build tasks are completed or not
593 for Dep
in self
.DependencyList
:
594 if Dep
.CompleteFlag
== True:
601 ## Add dependent build task
603 # @param Dependency The list of dependent build objects
605 def AddDependency(self
, Dependency
):
606 for Dep
in Dependency
:
607 self
.DependencyList
.append(BuildTask
.New(Dep
)) # BuildTask list
609 ## The thread wrapper of LaunchCommand function
611 # @param Command A list or string contains the call of the command
612 # @param WorkingDir The directory in which the program will be running
614 def _CommandThread(self
, Command
, WorkingDir
):
616 LaunchCommand(Command
, WorkingDir
)
617 self
.CompleteFlag
= True
620 # TRICK: hide the output of threads left runing, so that the user can
621 # catch the error message easily
623 if not BuildTask
._ErrorFlag
.isSet():
624 GlobalData
.gBuildingModule
= "%s [%s, %s, %s]" % (str(self
.BuildItem
.BuildObject
),
625 self
.BuildItem
.BuildObject
.Arch
,
626 self
.BuildItem
.BuildObject
.ToolChain
,
627 self
.BuildItem
.BuildObject
.BuildTarget
629 EdkLogger
.SetLevel(EdkLogger
.ERROR
)
630 BuildTask
._ErrorFlag
.set()
631 BuildTask
._ErrorMessage
= "%s broken\n %s [%s]" % \
632 (threading
.currentThread().getName(), Command
, WorkingDir
)
633 # indicate there's a thread is available for another build task
634 BuildTask
._RunningQueueLock
.acquire()
635 BuildTask
._RunningQueue
.pop(self
.BuildItem
)
636 BuildTask
._RunningQueueLock
.release()
637 BuildTask
._Thread
.release()
639 ## Start build task thread
642 EdkLogger
.quiet("Building ... %s" % repr(self
.BuildItem
))
643 Command
= self
.BuildItem
.BuildCommand
+ [self
.BuildItem
.Target
]
644 self
.BuildTread
= Thread(target
=self
._CommandThread
, args
=(Command
, self
.BuildItem
.WorkingDir
))
645 self
.BuildTread
.setName("build thread")
646 self
.BuildTread
.setDaemon(False)
647 self
.BuildTread
.start()
649 ## The class contains the information related to EFI image
654 # Constructor will load all required image information.
656 # @param BaseName The full file path of image.
657 # @param Guid The GUID for image.
658 # @param Arch Arch of this image.
659 # @param OutputDir The output directory for image.
660 # @param DebugDir The debug directory for image.
661 # @param ImageClass PeImage Information
663 def __init__(self
, BaseName
, Guid
, Arch
, OutputDir
, DebugDir
, ImageClass
):
664 self
.BaseName
= BaseName
667 self
.OutputDir
= OutputDir
668 self
.DebugDir
= DebugDir
669 self
.Image
= ImageClass
670 self
.Image
.Size
= (self
.Image
.Size
/ 0x1000 + 1) * 0x1000
672 ## The class implementing the EDK2 build process
674 # The build process includes:
675 # 1. Load configuration from target.txt and tools_def.txt in $(WORKSPACE)/Conf
676 # 2. Parse DSC file of active platform
677 # 3. Parse FDF file if any
678 # 4. Establish build database, including parse all other files (module, package)
679 # 5. Create AutoGen files (C code file, depex file, makefile) if necessary
680 # 6. Call build command
685 # Constructor will load all necessary configurations, parse platform, modules
686 # and packages and the establish a database for AutoGen.
688 # @param Target The build command target, one of gSupportedTarget
689 # @param WorkspaceDir The directory of workspace
690 # @param Platform The DSC file of active platform
691 # @param Module The INF file of active module, if any
692 # @param Arch The Arch list of platform or module
693 # @param ToolChain The name list of toolchain
694 # @param BuildTarget The "DEBUG" or "RELEASE" build
695 # @param FlashDefinition The FDF file of active platform
696 # @param FdList=[] The FD names to be individually built
697 # @param FvList=[] The FV names to be individually built
698 # @param MakefileType The type of makefile (for MSFT make or GNU make)
699 # @param SilentMode Indicate multi-thread build mode
700 # @param ThreadNumber The maximum number of thread if in multi-thread build mode
701 # @param SkipAutoGen Skip AutoGen step
702 # @param Reparse Re-parse all meta files
703 # @param SkuId SKU id from command line
705 def __init__(self
, Target
, WorkspaceDir
, Platform
, Module
, Arch
, ToolChain
,
706 BuildTarget
, FlashDefinition
, FdList
=[], FvList
=[],
707 MakefileType
="nmake", SilentMode
=False, ThreadNumber
=2,
708 SkipAutoGen
=False, Reparse
=False, SkuId
=None,
709 ReportFile
=None, ReportType
=None, UniFlag
=None):
711 self
.WorkspaceDir
= WorkspaceDir
713 self
.PlatformFile
= Platform
714 self
.ModuleFile
= Module
716 self
.ToolChainList
= ToolChain
717 self
.BuildTargetList
= BuildTarget
718 self
.Fdf
= FlashDefinition
721 self
.MakefileType
= MakefileType
722 self
.SilentMode
= SilentMode
723 self
.ThreadNumber
= ThreadNumber
724 self
.SkipAutoGen
= SkipAutoGen
725 self
.Reparse
= Reparse
727 self
.SpawnMode
= True
728 self
.BuildReport
= BuildReport(ReportFile
, ReportType
)
729 self
.TargetTxt
= TargetTxtClassObject()
730 self
.ToolDef
= ToolDefClassObject()
731 self
.Db
= WorkspaceDatabase(None, GlobalData
.gGlobalDefines
, self
.Reparse
)
732 #self.Db = WorkspaceDatabase(None, {}, self.Reparse)
733 self
.BuildDatabase
= self
.Db
.BuildObject
735 self
.LoadFixAddress
= 0
736 self
.UniFlag
= UniFlag
738 # print dot charater during doing some time-consuming work
739 self
.Progress
= Utils
.Progressor()
741 # parse target.txt, tools_def.txt, and platform file
742 #self.RestoreBuildData()
743 self
.LoadConfiguration()
746 # @attention Treat $(TARGET) in meta data files as special macro when it has only one build target.
747 # This is not a complete support for $(TARGET) macro as it can only support one build target in ONE
748 # invocation of build command. However, it should cover the frequent usage model that $(TARGET) macro
749 # is used in DSC files to specify different libraries & PCD setting for debug/release build.
751 if len(self
.BuildTargetList
) == 1:
752 self
.Db
._GlobalMacros
.setdefault("TARGET", self
.BuildTargetList
[0])
756 # print current build environment and configuration
757 EdkLogger
.quiet("%-24s = %s" % ("WORKSPACE", os
.environ
["WORKSPACE"]))
758 EdkLogger
.quiet("%-24s = %s" % ("ECP_SOURCE", os
.environ
["ECP_SOURCE"]))
759 EdkLogger
.quiet("%-24s = %s" % ("EDK_SOURCE", os
.environ
["EDK_SOURCE"]))
760 EdkLogger
.quiet("%-24s = %s" % ("EFI_SOURCE", os
.environ
["EFI_SOURCE"]))
761 EdkLogger
.quiet("%-24s = %s" % ("EDK_TOOLS_PATH", os
.environ
["EDK_TOOLS_PATH"]))
763 EdkLogger
.info('\n%-24s = %s' % ("TARGET_ARCH", ' '.join(self
.ArchList
)))
764 EdkLogger
.info('%-24s = %s' % ("TARGET", ' '.join(self
.BuildTargetList
)))
765 EdkLogger
.info('%-24s = %s' % ("TOOL_CHAIN_TAG", ' '.join(self
.ToolChainList
)))
767 EdkLogger
.info('\n%-24s = %s' % ("Active Platform", self
.PlatformFile
))
769 if self
.Fdf
!= None and self
.Fdf
!= "":
770 EdkLogger
.info('%-24s = %s' % ("Flash Image Definition", self
.Fdf
))
772 if self
.ModuleFile
!= None and self
.ModuleFile
!= "":
773 EdkLogger
.info('%-24s = %s' % ("Active Module", self
.ModuleFile
))
775 os
.chdir(self
.WorkspaceDir
)
776 self
.Progress
.Start("\nProcessing meta-data")
778 ## Load configuration
780 # This method will parse target.txt and get the build configurations.
782 def LoadConfiguration(self
):
784 # Check target.txt and tools_def.txt and Init them
786 BuildConfigurationFile
= os
.path
.normpath(os
.path
.join(self
.WorkspaceDir
, gBuildConfiguration
))
787 if os
.path
.isfile(BuildConfigurationFile
) == True:
788 StatusCode
= self
.TargetTxt
.LoadTargetTxtFile(BuildConfigurationFile
)
790 ToolDefinitionFile
= self
.TargetTxt
.TargetTxtDictionary
[DataType
.TAB_TAT_DEFINES_TOOL_CHAIN_CONF
]
791 if ToolDefinitionFile
== '':
792 ToolDefinitionFile
= gToolsDefinition
793 ToolDefinitionFile
= os
.path
.normpath(os
.path
.join(self
.WorkspaceDir
, ToolDefinitionFile
))
794 if os
.path
.isfile(ToolDefinitionFile
) == True:
795 StatusCode
= self
.ToolDef
.LoadToolDefFile(ToolDefinitionFile
)
797 EdkLogger
.error("build", FILE_NOT_FOUND
, ExtraData
=ToolDefinitionFile
)
799 EdkLogger
.error("build", FILE_NOT_FOUND
, ExtraData
=BuildConfigurationFile
)
801 # if no ARCH given in command line, get it from target.txt
802 if self
.ArchList
== None or len(self
.ArchList
) == 0:
803 self
.ArchList
= self
.TargetTxt
.TargetTxtDictionary
[DataType
.TAB_TAT_DEFINES_TARGET_ARCH
]
805 # if no build target given in command line, get it from target.txt
806 if self
.BuildTargetList
== None or len(self
.BuildTargetList
) == 0:
807 self
.BuildTargetList
= self
.TargetTxt
.TargetTxtDictionary
[DataType
.TAB_TAT_DEFINES_TARGET
]
809 # if no tool chain given in command line, get it from target.txt
810 if self
.ToolChainList
== None or len(self
.ToolChainList
) == 0:
811 self
.ToolChainList
= self
.TargetTxt
.TargetTxtDictionary
[DataType
.TAB_TAT_DEFINES_TOOL_CHAIN_TAG
]
812 if self
.ToolChainList
== None or len(self
.ToolChainList
) == 0:
813 EdkLogger
.error("build", RESOURCE_NOT_AVAILABLE
, ExtraData
="No toolchain given. Don't know how to build.\n")
815 # check if the tool chains are defined or not
816 NewToolChainList
= []
817 for ToolChain
in self
.ToolChainList
:
818 if ToolChain
not in self
.ToolDef
.ToolsDefTxtDatabase
[TAB_TOD_DEFINES_TOOL_CHAIN_TAG
]:
819 EdkLogger
.warn("build", "Tool chain [%s] is not defined" % ToolChain
)
821 NewToolChainList
.append(ToolChain
)
822 # if no tool chain available, break the build
823 if len(NewToolChainList
) == 0:
824 EdkLogger
.error("build", RESOURCE_NOT_AVAILABLE
,
825 ExtraData
="[%s] not defined. No toolchain available for build!\n" % ", ".join(self
.ToolChainList
))
827 self
.ToolChainList
= NewToolChainList
829 if self
.ThreadNumber
== None:
830 self
.ThreadNumber
= self
.TargetTxt
.TargetTxtDictionary
[DataType
.TAB_TAT_DEFINES_MAX_CONCURRENT_THREAD_NUMBER
]
831 if self
.ThreadNumber
== '':
832 self
.ThreadNumber
= 0
834 self
.ThreadNumber
= int(self
.ThreadNumber
, 0)
836 if self
.ThreadNumber
== 0:
837 self
.ThreadNumber
= 1
839 if not self
.PlatformFile
:
840 PlatformFile
= self
.TargetTxt
.TargetTxtDictionary
[DataType
.TAB_TAT_DEFINES_ACTIVE_PLATFORM
]
842 # Try to find one in current directory
843 WorkingDirectory
= os
.getcwd()
844 FileList
= glob
.glob(os
.path
.normpath(os
.path
.join(WorkingDirectory
, '*.dsc')))
845 FileNum
= len(FileList
)
847 EdkLogger
.error("build", OPTION_MISSING
,
848 ExtraData
="There are %d DSC files in %s. Use '-p' to specify one.\n" % (FileNum
, WorkingDirectory
))
850 PlatformFile
= FileList
[0]
852 EdkLogger
.error("build", RESOURCE_NOT_AVAILABLE
,
853 ExtraData
="No active platform specified in target.txt or command line! Nothing can be built.\n")
855 self
.PlatformFile
= PathClass(NormFile(PlatformFile
, self
.WorkspaceDir
), self
.WorkspaceDir
)
856 ErrorCode
, ErrorInfo
= self
.PlatformFile
.Validate(".dsc", False)
858 EdkLogger
.error("build", ErrorCode
, ExtraData
=ErrorInfo
)
860 ## Initialize build configuration
862 # This method will parse DSC file and merge the configurations from
863 # command line and target.txt, then get the final build configurations.
866 ErrorCode
, ErrorInfo
= self
.PlatformFile
.Validate(".dsc")
868 EdkLogger
.error("build", ErrorCode
, ExtraData
=ErrorInfo
)
870 # create metafile database
871 self
.Db
.InitDatabase()
873 # we need information in platform description file to determine how to build
874 self
.Platform
= self
.BuildDatabase
[self
.PlatformFile
, 'COMMON']
876 self
.Fdf
= self
.Platform
.FlashDefinition
878 LoadFixAddressString
= None
879 if TAB_FIX_LOAD_TOP_MEMORY_ADDRESS
in GlobalData
.gGlobalDefines
:
880 LoadFixAddressString
= GlobalData
.gGlobalDefines
[TAB_FIX_LOAD_TOP_MEMORY_ADDRESS
]
882 LoadFixAddressString
= self
.Platform
.LoadFixAddress
884 if LoadFixAddressString
!= None and LoadFixAddressString
!= '':
886 if LoadFixAddressString
.upper().startswith('0X'):
887 self
.LoadFixAddress
= int (LoadFixAddressString
, 16)
889 self
.LoadFixAddress
= int (LoadFixAddressString
)
891 EdkLogger
.error("build", PARAMETER_INVALID
, "FIX_LOAD_TOP_MEMORY_ADDRESS %s is not valid dec or hex string" % (LoadFixAddressString
))
892 if self
.LoadFixAddress
< 0:
893 EdkLogger
.error("build", PARAMETER_INVALID
, "FIX_LOAD_TOP_MEMORY_ADDRESS is set to the invalid negative value %s" % (LoadFixAddressString
))
894 if self
.LoadFixAddress
!= 0xFFFFFFFFFFFFFFFF and self
.LoadFixAddress
% 0x1000 != 0:
895 EdkLogger
.error("build", PARAMETER_INVALID
, "FIX_LOAD_TOP_MEMORY_ADDRESS is set to the invalid unaligned 4K value %s" % (LoadFixAddressString
))
897 if self
.SkuId
== None or self
.SkuId
== '':
898 self
.SkuId
= self
.Platform
.SkuName
900 # check FD/FV build target
901 if self
.Fdf
== None or self
.Fdf
== "":
902 if self
.FdList
!= []:
903 EdkLogger
.info("No flash definition file found. FD [%s] will be ignored." % " ".join(self
.FdList
))
905 if self
.FvList
!= []:
906 EdkLogger
.info("No flash definition file found. FV [%s] will be ignored." % " ".join(self
.FvList
))
909 FdfParserObj
= FdfParser(str(self
.Fdf
))
910 FdfParserObj
.ParseFile()
911 for fvname
in self
.FvList
:
912 if fvname
.upper() not in FdfParserObj
.Profile
.FvDict
.keys():
913 EdkLogger
.error("build", OPTION_VALUE_INVALID
,
914 "No such an FV in FDF file: %s" % fvname
)
919 if self
.ArchList
== None or len(self
.ArchList
) == 0:
920 ArchList
= set(self
.Platform
.SupArchList
)
922 ArchList
= set(self
.ArchList
) & set(self
.Platform
.SupArchList
)
923 if len(ArchList
) == 0:
924 EdkLogger
.error("build", PARAMETER_INVALID
,
925 ExtraData
= "Active platform supports [%s] only, but [%s] is given."
926 % (" ".join(self
.Platform
.SupArchList
), " ".join(self
.ArchList
)))
927 elif len(ArchList
) != len(self
.ArchList
):
928 SkippedArchList
= set(self
.ArchList
).symmetric_difference(set(self
.Platform
.SupArchList
))
929 EdkLogger
.verbose("\nArch [%s] is ignored because active platform supports [%s] but [%s] is specified !"
930 % (" ".join(SkippedArchList
), " ".join(self
.Platform
.SupArchList
), " ".join(self
.ArchList
)))
931 self
.ArchList
= tuple(ArchList
)
934 if self
.BuildTargetList
== None or len(self
.BuildTargetList
) == 0:
935 BuildTargetList
= self
.Platform
.BuildTargets
937 BuildTargetList
= list(set(self
.BuildTargetList
) & set(self
.Platform
.BuildTargets
))
938 if BuildTargetList
== []:
939 EdkLogger
.error("build", PARAMETER_INVALID
, "Active platform only supports [%s], but [%s] is given"
940 % (" ".join(self
.Platform
.BuildTargets
), " ".join(self
.BuildTargetList
)))
941 self
.BuildTargetList
= BuildTargetList
943 ## Build a module or platform
945 # Create autogen code and makfile for a module or platform, and the launch
946 # "make" command to build it
948 # @param Target The target of build command
949 # @param Platform The platform file
950 # @param Module The module file
951 # @param BuildTarget The name of build target, one of "DEBUG", "RELEASE"
952 # @param ToolChain The name of toolchain to build
953 # @param Arch The arch of the module/platform
954 # @param CreateDepModuleCodeFile Flag used to indicate creating code
955 # for dependent modules/Libraries
956 # @param CreateDepModuleMakeFile Flag used to indicate creating makefile
957 # for dependent modules/Libraries
959 def _Build(self
, Target
, AutoGenObject
, CreateDepsCodeFile
=True, CreateDepsMakeFile
=True):
960 if AutoGenObject
== None:
963 # skip file generation for cleanxxx targets, run and fds target
964 if Target
not in ['clean', 'cleanlib', 'cleanall', 'run', 'fds']:
965 # for target which must generate AutoGen code and makefile
966 if not self
.SkipAutoGen
or Target
== 'genc':
967 self
.Progress
.Start("Generating code")
968 AutoGenObject
.CreateCodeFile(CreateDepsCodeFile
)
969 self
.Progress
.Stop("done!")
973 if not self
.SkipAutoGen
or Target
== 'genmake':
974 self
.Progress
.Start("Generating makefile")
975 AutoGenObject
.CreateMakeFile(CreateDepsMakeFile
)
976 self
.Progress
.Stop("done!")
977 if Target
== "genmake":
980 # always recreate top/platform makefile when clean, just in case of inconsistency
981 AutoGenObject
.CreateCodeFile(False)
982 AutoGenObject
.CreateMakeFile(False)
984 if EdkLogger
.GetLevel() == EdkLogger
.QUIET
:
985 EdkLogger
.quiet("Building ... %s" % repr(AutoGenObject
))
987 BuildCommand
= AutoGenObject
.BuildCommand
988 if BuildCommand
== None or len(BuildCommand
) == 0:
989 EdkLogger
.error("build", OPTION_MISSING
, ExtraData
="No MAKE command found for [%s, %s, %s]" % Key
)
991 BuildCommand
= BuildCommand
+ [Target
]
992 LaunchCommand(BuildCommand
, AutoGenObject
.MakeFileDir
)
993 if Target
== 'cleanall':
995 #os.rmdir(AutoGenObject.BuildDir)
996 RemoveDirectory(AutoGenObject
.BuildDir
, True)
997 except WindowsError, X
:
998 EdkLogger
.error("build", FILE_DELETE_FAILURE
, ExtraData
=str(X
))
1001 ## Rebase module image and Get function address for the inpug module list.
1003 def _RebaseModule (self
, MapBuffer
, BaseAddress
, ModuleList
, AddrIsOffset
= True, ModeIsSmm
= False):
1005 AddrIsOffset
= False
1006 InfFileNameList
= ModuleList
.keys()
1007 #InfFileNameList.sort()
1008 for InfFile
in InfFileNameList
:
1009 sys
.stdout
.write (".")
1011 ModuleInfo
= ModuleList
[InfFile
]
1012 ModuleName
= ModuleInfo
.BaseName
1013 ModuleOutputImage
= ModuleInfo
.Image
.FileName
1014 ModuleDebugImage
= os
.path
.join(ModuleInfo
.DebugDir
, ModuleInfo
.BaseName
+ '.efi')
1015 ## for SMM module in SMRAM, the SMRAM will be allocated from base to top.
1017 BaseAddress
= BaseAddress
- ModuleInfo
.Image
.Size
1019 # Update Image to new BaseAddress by GenFw tool
1021 LaunchCommand(["GenFw", "--rebase", str(BaseAddress
), "-r", ModuleOutputImage
], ModuleInfo
.OutputDir
)
1022 LaunchCommand(["GenFw", "--rebase", str(BaseAddress
), "-r", ModuleDebugImage
], ModuleInfo
.DebugDir
)
1025 # Set new address to the section header only for SMM driver.
1027 LaunchCommand(["GenFw", "--address", str(BaseAddress
), "-r", ModuleOutputImage
], ModuleInfo
.OutputDir
)
1028 LaunchCommand(["GenFw", "--address", str(BaseAddress
), "-r", ModuleDebugImage
], ModuleInfo
.DebugDir
)
1030 # Collect funtion address from Map file
1032 ImageMapTable
= ModuleOutputImage
.replace('.efi', '.map')
1034 if os
.path
.exists(ImageMapTable
):
1035 OrigImageBaseAddress
= 0
1036 ImageMap
= open (ImageMapTable
, 'r')
1037 for LinStr
in ImageMap
:
1038 if len (LinStr
.strip()) == 0:
1041 # Get the preferred address set on link time.
1043 if LinStr
.find ('Preferred load address is') != -1:
1044 StrList
= LinStr
.split()
1045 OrigImageBaseAddress
= int (StrList
[len(StrList
) - 1], 16)
1047 StrList
= LinStr
.split()
1048 if len (StrList
) > 4:
1049 if StrList
[3] == 'f' or StrList
[3] =='F':
1051 RelativeAddress
= int (StrList
[2], 16) - OrigImageBaseAddress
1052 FunctionList
.append ((Name
, RelativeAddress
))
1053 if ModuleInfo
.Arch
== 'IPF' and Name
.endswith('_ModuleEntryPoint'):
1055 # Get the real entry point address for IPF image.
1057 ModuleInfo
.Image
.EntryPoint
= RelativeAddress
1060 # Add general information.
1063 MapBuffer
.write('\n\n%s (Fixed SMRAM Offset, BaseAddress=0x%010X, EntryPoint=0x%010X)\n' % (ModuleName
, BaseAddress
, BaseAddress
+ ModuleInfo
.Image
.EntryPoint
))
1065 MapBuffer
.write('\n\n%s (Fixed Memory Offset, BaseAddress=-0x%010X, EntryPoint=-0x%010X)\n' % (ModuleName
, 0 - BaseAddress
, 0 - (BaseAddress
+ ModuleInfo
.Image
.EntryPoint
)))
1067 MapBuffer
.write('\n\n%s (Fixed Memory Address, BaseAddress=0x%010X, EntryPoint=0x%010X)\n' % (ModuleName
, BaseAddress
, BaseAddress
+ ModuleInfo
.Image
.EntryPoint
))
1069 # Add guid and general seciton section.
1071 TextSectionAddress
= 0
1072 DataSectionAddress
= 0
1073 for SectionHeader
in ModuleInfo
.Image
.SectionHeaderList
:
1074 if SectionHeader
[0] == '.text':
1075 TextSectionAddress
= SectionHeader
[1]
1076 elif SectionHeader
[0] in ['.data', '.sdata']:
1077 DataSectionAddress
= SectionHeader
[1]
1079 MapBuffer
.write('(GUID=%s, .textbaseaddress=-0x%010X, .databaseaddress=-0x%010X)\n' % (ModuleInfo
.Guid
, 0 - (BaseAddress
+ TextSectionAddress
), 0 - (BaseAddress
+ DataSectionAddress
)))
1081 MapBuffer
.write('(GUID=%s, .textbaseaddress=0x%010X, .databaseaddress=0x%010X)\n' % (ModuleInfo
.Guid
, BaseAddress
+ TextSectionAddress
, BaseAddress
+ DataSectionAddress
))
1083 # Add debug image full path.
1085 MapBuffer
.write('(IMAGE=%s)\n\n' % (ModuleDebugImage
))
1087 # Add funtion address
1089 for Function
in FunctionList
:
1091 MapBuffer
.write(' -0x%010X %s\n' % (0 - (BaseAddress
+ Function
[1]), Function
[0]))
1093 MapBuffer
.write(' 0x%010X %s\n' % (BaseAddress
+ Function
[1], Function
[0]))
1097 # for SMM module in SMRAM, the SMRAM will be allocated from base to top.
1100 BaseAddress
= BaseAddress
+ ModuleInfo
.Image
.Size
1102 ## Collect MAP information of all FVs
1104 def _CollectFvMapBuffer (self
, MapBuffer
, Wa
, ModuleList
):
1106 # First get the XIP base address for FV map file.
1107 GuidPattern
= re
.compile("[-a-fA-F0-9]+")
1108 GuidName
= re
.compile("\(GUID=[-a-fA-F0-9]+")
1109 for FvName
in Wa
.FdfProfile
.FvDict
.keys():
1110 FvMapBuffer
= os
.path
.join(Wa
.FvDir
, FvName
+ '.Fv.map')
1111 if not os
.path
.exists(FvMapBuffer
):
1113 FvMap
= open (FvMapBuffer
, 'r')
1114 #skip FV size information
1120 MatchGuid
= GuidPattern
.match(Line
)
1121 if MatchGuid
!= None:
1123 # Replace GUID with module name
1125 GuidString
= MatchGuid
.group()
1126 if GuidString
.upper() in ModuleList
:
1127 Line
= Line
.replace(GuidString
, ModuleList
[GuidString
.upper()].Name
)
1128 MapBuffer
.write('%s' % (Line
))
1130 # Add the debug image full path.
1132 MatchGuid
= GuidName
.match(Line
)
1133 if MatchGuid
!= None:
1134 GuidString
= MatchGuid
.group().split("=")[1]
1135 if GuidString
.upper() in ModuleList
:
1136 MapBuffer
.write('(IMAGE=%s)\n' % (os
.path
.join(ModuleList
[GuidString
.upper()].DebugDir
, ModuleList
[GuidString
.upper()].Name
+ '.efi')))
1140 ## Collect MAP information of all modules
1142 def _CollectModuleMapBuffer (self
, MapBuffer
, ModuleList
):
1143 sys
.stdout
.write ("Generate Load Module At Fix Address Map")
1145 PatchEfiImageList
= []
1153 # reserve 4K size in SMRAM to make SMM module address not from 0.
1155 IsIpfPlatform
= False
1156 if 'IPF' in self
.ArchList
:
1157 IsIpfPlatform
= True
1158 for ModuleGuid
in ModuleList
:
1159 Module
= ModuleList
[ModuleGuid
]
1160 GlobalData
.gProcessingFile
= "%s [%s, %s, %s]" % (Module
.MetaFile
, Module
.Arch
, Module
.ToolChain
, Module
.BuildTarget
)
1162 OutputImageFile
= ''
1163 for ResultFile
in Module
.CodaTargetList
:
1164 if str(ResultFile
.Target
).endswith('.efi'):
1166 # module list for PEI, DXE, RUNTIME and SMM
1168 OutputImageFile
= os
.path
.join(Module
.OutputDir
, Module
.Name
+ '.efi')
1169 ImageClass
= PeImageClass (OutputImageFile
)
1170 if not ImageClass
.IsValid
:
1171 EdkLogger
.error("build", FILE_PARSE_FAILURE
, ExtraData
=ImageClass
.ErrorInfo
)
1172 ImageInfo
= PeImageInfo(Module
.Name
, Module
.Guid
, Module
.Arch
, Module
.OutputDir
, Module
.DebugDir
, ImageClass
)
1173 if Module
.ModuleType
in ['PEI_CORE', 'PEIM', 'COMBINED_PEIM_DRIVER','PIC_PEIM', 'RELOCATABLE_PEIM', 'DXE_CORE']:
1174 PeiModuleList
[Module
.MetaFile
] = ImageInfo
1175 PeiSize
+= ImageInfo
.Image
.Size
1176 elif Module
.ModuleType
in ['BS_DRIVER', 'DXE_DRIVER', 'UEFI_DRIVER']:
1177 BtModuleList
[Module
.MetaFile
] = ImageInfo
1178 BtSize
+= ImageInfo
.Image
.Size
1179 elif Module
.ModuleType
in ['DXE_RUNTIME_DRIVER', 'RT_DRIVER', 'DXE_SAL_DRIVER', 'SAL_RT_DRIVER']:
1180 RtModuleList
[Module
.MetaFile
] = ImageInfo
1181 #IPF runtime driver needs to be at 2 page alignment.
1182 if IsIpfPlatform
and ImageInfo
.Image
.Size
% 0x2000 != 0:
1183 ImageInfo
.Image
.Size
= (ImageInfo
.Image
.Size
/ 0x2000 + 1) * 0x2000
1184 RtSize
+= ImageInfo
.Image
.Size
1185 elif Module
.ModuleType
in ['SMM_CORE', 'DXE_SMM_DRIVER']:
1186 SmmModuleList
[Module
.MetaFile
] = ImageInfo
1187 SmmSize
+= ImageInfo
.Image
.Size
1188 if Module
.ModuleType
== 'DXE_SMM_DRIVER':
1190 if 'PI_SPECIFICATION_VERSION' in Module
.Module
.Specification
:
1191 PiSpecVersion
= Module
.Module
.Specification
['PI_SPECIFICATION_VERSION']
1192 # for PI specification < PI1.1, DXE_SMM_DRIVER also runs as BOOT time driver.
1193 if PiSpecVersion
< 0x0001000A:
1194 BtModuleList
[Module
.MetaFile
] = ImageInfo
1195 BtSize
+= ImageInfo
.Image
.Size
1198 # EFI image is final target.
1199 # Check EFI image contains patchable FixAddress related PCDs.
1201 if OutputImageFile
!= '':
1202 ModuleIsPatch
= False
1203 for Pcd
in Module
.ModulePcdList
:
1204 if Pcd
.Type
== TAB_PCDS_PATCHABLE_IN_MODULE
and Pcd
.TokenCName
in TAB_PCDS_PATCHABLE_LOAD_FIX_ADDRESS_LIST
:
1205 ModuleIsPatch
= True
1207 if not ModuleIsPatch
:
1208 for Pcd
in Module
.LibraryPcdList
:
1209 if Pcd
.Type
== TAB_PCDS_PATCHABLE_IN_MODULE
and Pcd
.TokenCName
in TAB_PCDS_PATCHABLE_LOAD_FIX_ADDRESS_LIST
:
1210 ModuleIsPatch
= True
1213 if not ModuleIsPatch
:
1216 # Module includes the patchable load fix address PCDs.
1217 # It will be fixed up later.
1219 PatchEfiImageList
.append (OutputImageFile
)
1222 # Get Top Memory address
1224 ReservedRuntimeMemorySize
= 0
1225 TopMemoryAddress
= 0
1226 if self
.LoadFixAddress
== 0xFFFFFFFFFFFFFFFF:
1227 TopMemoryAddress
= 0
1229 TopMemoryAddress
= self
.LoadFixAddress
1230 if TopMemoryAddress
< RtSize
+ BtSize
+ PeiSize
:
1231 EdkLogger
.error("build", PARAMETER_INVALID
, "FIX_LOAD_TOP_MEMORY_ADDRESS is too low to load driver")
1232 # Make IPF runtime driver at 2 page alignment.
1234 ReservedRuntimeMemorySize
= TopMemoryAddress
% 0x2000
1235 RtSize
= RtSize
+ ReservedRuntimeMemorySize
1238 # Patch FixAddress related PCDs into EFI image
1240 for EfiImage
in PatchEfiImageList
:
1241 EfiImageMap
= EfiImage
.replace('.efi', '.map')
1242 if not os
.path
.exists(EfiImageMap
):
1245 # Get PCD offset in EFI image by GenPatchPcdTable function
1247 PcdTable
= parsePcdInfoFromMapFile(EfiImageMap
, EfiImage
)
1249 # Patch real PCD value by PatchPcdValue tool
1251 for PcdInfo
in PcdTable
:
1253 if PcdInfo
[0] == TAB_PCDS_PATCHABLE_LOAD_FIX_ADDRESS_PEI_PAGE_SIZE
:
1254 ReturnValue
, ErrorInfo
= PatchBinaryFile (EfiImage
, PcdInfo
[1], TAB_PCDS_PATCHABLE_LOAD_FIX_ADDRESS_PEI_PAGE_SIZE_DATA_TYPE
, str (PeiSize
/0x1000))
1255 elif PcdInfo
[0] == TAB_PCDS_PATCHABLE_LOAD_FIX_ADDRESS_DXE_PAGE_SIZE
:
1256 ReturnValue
, ErrorInfo
= PatchBinaryFile (EfiImage
, PcdInfo
[1], TAB_PCDS_PATCHABLE_LOAD_FIX_ADDRESS_DXE_PAGE_SIZE_DATA_TYPE
, str (BtSize
/0x1000))
1257 elif PcdInfo
[0] == TAB_PCDS_PATCHABLE_LOAD_FIX_ADDRESS_RUNTIME_PAGE_SIZE
:
1258 ReturnValue
, ErrorInfo
= PatchBinaryFile (EfiImage
, PcdInfo
[1], TAB_PCDS_PATCHABLE_LOAD_FIX_ADDRESS_RUNTIME_PAGE_SIZE_DATA_TYPE
, str (RtSize
/0x1000))
1259 elif PcdInfo
[0] == TAB_PCDS_PATCHABLE_LOAD_FIX_ADDRESS_SMM_PAGE_SIZE
and len (SmmModuleList
) > 0:
1260 ReturnValue
, ErrorInfo
= PatchBinaryFile (EfiImage
, PcdInfo
[1], TAB_PCDS_PATCHABLE_LOAD_FIX_ADDRESS_SMM_PAGE_SIZE_DATA_TYPE
, str (SmmSize
/0x1000))
1261 if ReturnValue
!= 0:
1262 EdkLogger
.error("build", PARAMETER_INVALID
, "Patch PCD value failed", ExtraData
=ErrorInfo
)
1264 MapBuffer
.write('PEI_CODE_PAGE_NUMBER = 0x%x\n' % (PeiSize
/0x1000))
1265 MapBuffer
.write('BOOT_CODE_PAGE_NUMBER = 0x%x\n' % (BtSize
/0x1000))
1266 MapBuffer
.write('RUNTIME_CODE_PAGE_NUMBER = 0x%x\n' % (RtSize
/0x1000))
1267 if len (SmmModuleList
) > 0:
1268 MapBuffer
.write('SMM_CODE_PAGE_NUMBER = 0x%x\n' % (SmmSize
/0x1000))
1270 PeiBaseAddr
= TopMemoryAddress
- RtSize
- BtSize
1271 BtBaseAddr
= TopMemoryAddress
- RtSize
1272 RtBaseAddr
= TopMemoryAddress
- ReservedRuntimeMemorySize
1274 self
._RebaseModule
(MapBuffer
, PeiBaseAddr
, PeiModuleList
, TopMemoryAddress
== 0)
1275 self
._RebaseModule
(MapBuffer
, BtBaseAddr
, BtModuleList
, TopMemoryAddress
== 0)
1276 self
._RebaseModule
(MapBuffer
, RtBaseAddr
, RtModuleList
, TopMemoryAddress
== 0)
1277 self
._RebaseModule
(MapBuffer
, 0x1000, SmmModuleList
, AddrIsOffset
= False, ModeIsSmm
= True)
1278 MapBuffer
.write('\n\n')
1279 sys
.stdout
.write ("\n")
1282 ## Save platform Map file
1284 def _SaveMapFile (self
, MapBuffer
, Wa
):
1286 # Map file path is got.
1288 MapFilePath
= os
.path
.join(Wa
.BuildDir
, Wa
.Name
+ '.map')
1290 # Save address map into MAP file.
1292 MapFile
= open(MapFilePath
, "wb")
1293 MapFile
.write(MapBuffer
.getvalue())
1296 if self
.LoadFixAddress
!= 0:
1297 sys
.stdout
.write ("\nLoad Module At Fix Address Map file saved to %s\n" %(MapFilePath))
1300 ## Build active platform for different build targets and different tool chains
1302 def _BuildPlatform(self
):
1303 for BuildTarget
in self
.BuildTargetList
:
1304 for ToolChain
in self
.ToolChainList
:
1305 Wa
= WorkspaceAutoGen(
1320 self
.BuildReport
.AddPlatformReport(Wa
)
1321 self
.Progress
.Stop("done!")
1322 self
._Build
(self
.Target
, Wa
)
1324 # Create MAP file when Load Fix Address is enabled.
1325 if self
.Target
in ["", "all", "fds"]:
1326 for Arch
in self
.ArchList
:
1328 # Check whether the set fix address is above 4G for 32bit image.
1330 if (Arch
== 'IA32' or Arch
== 'ARM') and self
.LoadFixAddress
!= 0xFFFFFFFFFFFFFFFF and self
.LoadFixAddress
>= 0x100000000:
1331 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")
1336 for Pa
in Wa
.AutoGenObjectList
:
1337 for Ma
in Pa
.ModuleAutoGenList
:
1340 if not Ma
.IsLibrary
:
1341 ModuleList
[Ma
.Guid
.upper()] = Ma
1343 MapBuffer
= StringIO('')
1344 if self
.LoadFixAddress
!= 0:
1346 # Rebase module to the preferred memory address before GenFds
1348 self
._CollectModuleMapBuffer
(MapBuffer
, ModuleList
)
1351 # create FDS again for the updated EFI image
1353 self
._Build
("fds", Wa
)
1356 # Create MAP file for all platform FVs after GenFds.
1358 self
._CollectFvMapBuffer
(MapBuffer
, Wa
, ModuleList
)
1360 # Save MAP buffer into MAP file.
1362 self
._SaveMapFile
(MapBuffer
, Wa
)
1364 ## Build active module for different build targets, different tool chains and different archs
1366 def _BuildModule(self
):
1367 for BuildTarget
in self
.BuildTargetList
:
1368 for ToolChain
in self
.ToolChainList
:
1370 # module build needs platform build information, so get platform
1373 Wa
= WorkspaceAutoGen(
1388 Wa
.CreateMakeFile(False)
1389 self
.Progress
.Stop("done!")
1391 for Arch
in self
.ArchList
:
1392 Ma
= ModuleAutoGen(Wa
, self
.ModuleFile
, BuildTarget
, ToolChain
, Arch
, self
.PlatformFile
)
1393 if Ma
== None: continue
1395 self
._Build
(self
.Target
, Ma
)
1397 self
.BuildReport
.AddPlatformReport(Wa
, MaList
)
1402 "Module for [%s] is not a component of active platform."\
1403 " Please make sure that the ARCH and inf file path are"\
1404 " given in the same as in [%s]" %\
1405 (', '.join(self
.ArchList
), self
.Platform
),
1406 ExtraData
=self
.ModuleFile
1408 # Create MAP file when Load Fix Address is enabled.
1409 if self
.Target
== "fds" and self
.Fdf
!= '':
1410 for Arch
in self
.ArchList
:
1412 # Check whether the set fix address is above 4G for 32bit image.
1414 if (Arch
== 'IA32' or Arch
== 'ARM') and self
.LoadFixAddress
!= 0xFFFFFFFFFFFFFFFF and self
.LoadFixAddress
>= 0x100000000:
1415 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")
1420 for Pa
in Wa
.AutoGenObjectList
:
1421 for Ma
in Pa
.ModuleAutoGenList
:
1424 if not Ma
.IsLibrary
:
1425 ModuleList
[Ma
.Guid
.upper()] = Ma
1427 MapBuffer
= StringIO('')
1428 if self
.LoadFixAddress
!= 0:
1430 # Rebase module to the preferred memory address before GenFds
1432 self
._CollectModuleMapBuffer
(MapBuffer
, ModuleList
)
1434 # create FDS again for the updated EFI image
1436 self
._Build
("fds", Wa
)
1438 # Create MAP file for all platform FVs after GenFds.
1440 self
._CollectFvMapBuffer
(MapBuffer
, Wa
, ModuleList
)
1442 # Save MAP buffer into MAP file.
1444 self
._SaveMapFile
(MapBuffer
, Wa
)
1446 ## Build a platform in multi-thread mode
1448 def _MultiThreadBuildPlatform(self
):
1449 for BuildTarget
in self
.BuildTargetList
:
1450 for ToolChain
in self
.ToolChainList
:
1451 Wa
= WorkspaceAutoGen(
1466 self
.BuildReport
.AddPlatformReport(Wa
)
1467 Wa
.CreateMakeFile(False)
1469 # multi-thread exit flag
1470 ExitFlag
= threading
.Event()
1472 for Arch
in self
.ArchList
:
1473 Pa
= PlatformAutoGen(Wa
, self
.PlatformFile
, BuildTarget
, ToolChain
, Arch
)
1476 for Module
in Pa
.Platform
.Modules
:
1477 # Get ModuleAutoGen object to generate C code file and makefile
1478 Ma
= ModuleAutoGen(Wa
, Module
, BuildTarget
, ToolChain
, Arch
, self
.PlatformFile
)
1481 # Not to auto-gen for targets 'clean', 'cleanlib', 'cleanall', 'run', 'fds'
1482 if self
.Target
not in ['clean', 'cleanlib', 'cleanall', 'run', 'fds']:
1483 # for target which must generate AutoGen code and makefile
1484 if not self
.SkipAutoGen
or self
.Target
== 'genc':
1485 Ma
.CreateCodeFile(True)
1486 if self
.Target
== "genc":
1489 if not self
.SkipAutoGen
or self
.Target
== 'genmake':
1490 Ma
.CreateMakeFile(True)
1491 if self
.Target
== "genmake":
1493 self
.Progress
.Stop("done!")
1494 # Generate build task for the module
1495 Bt
= BuildTask
.New(ModuleMakeUnit(Ma
, self
.Target
))
1496 # Break build if any build thread has error
1497 if BuildTask
.HasError():
1498 # we need a full version of makefile for platform
1500 BuildTask
.WaitForComplete()
1501 Pa
.CreateMakeFile(False)
1502 EdkLogger
.error("build", BUILD_ERROR
, "Failed to build module", ExtraData
=GlobalData
.gBuildingModule
)
1503 # Start task scheduler
1504 if not BuildTask
.IsOnGoing():
1505 BuildTask
.StartScheduler(self
.ThreadNumber
, ExitFlag
)
1507 # in case there's an interruption. we need a full version of makefile for platform
1508 Pa
.CreateMakeFile(False)
1509 if BuildTask
.HasError():
1510 EdkLogger
.error("build", BUILD_ERROR
, "Failed to build module", ExtraData
=GlobalData
.gBuildingModule
)
1513 # All modules have been put in build tasks queue. Tell task scheduler
1514 # to exit if all tasks are completed
1517 BuildTask
.WaitForComplete()
1520 # Check for build error, and raise exception if one
1521 # has been signaled.
1523 if BuildTask
.HasError():
1524 EdkLogger
.error("build", BUILD_ERROR
, "Failed to build module", ExtraData
=GlobalData
.gBuildingModule
)
1526 # Create MAP file when Load Fix Address is enabled.
1527 if self
.Target
in ["", "all", "fds"]:
1528 for Arch
in self
.ArchList
:
1530 # Check whether the set fix address is above 4G for 32bit image.
1532 if (Arch
== 'IA32' or Arch
== 'ARM') and self
.LoadFixAddress
!= 0xFFFFFFFFFFFFFFFF and self
.LoadFixAddress
>= 0x100000000:
1533 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")
1538 for Pa
in Wa
.AutoGenObjectList
:
1539 for Ma
in Pa
.ModuleAutoGenList
:
1542 if not Ma
.IsLibrary
:
1543 ModuleList
[Ma
.Guid
.upper()] = Ma
1545 # Rebase module to the preferred memory address before GenFds
1547 MapBuffer
= StringIO('')
1548 if self
.LoadFixAddress
!= 0:
1549 self
._CollectModuleMapBuffer
(MapBuffer
, ModuleList
)
1553 # Generate FD image if there's a FDF file found
1555 LaunchCommand(Wa
.BuildCommand
+ ["fds"], Wa
.MakeFileDir
)
1557 # Create MAP file for all platform FVs after GenFds.
1559 self
._CollectFvMapBuffer
(MapBuffer
, Wa
, ModuleList
)
1561 # Save MAP buffer into MAP file.
1563 self
._SaveMapFile
(MapBuffer
, Wa
)
1565 ## Generate GuidedSectionTools.txt in the FV directories.
1567 def CreateGuidedSectionToolsFile(self
):
1568 for Arch
in self
.ArchList
:
1569 for BuildTarget
in self
.BuildTargetList
:
1570 for ToolChain
in self
.ToolChainList
:
1571 FvDir
= os
.path
.join(
1573 self
.Platform
.OutputDirectory
,
1574 '_'.join((BuildTarget
, ToolChain
)),
1577 if not os
.path
.exists(FvDir
):
1579 # Build up the list of supported architectures for this build
1580 prefix
= '%s_%s_%s_' % (BuildTarget
, ToolChain
, Arch
)
1582 # Look through the tool definitions for GUIDed tools
1584 for (attrib
, value
) in self
.ToolDef
.ToolsDefTxtDictionary
.iteritems():
1585 if attrib
.upper().endswith('_GUID'):
1586 split
= attrib
.split('_')
1587 thisPrefix
= '_'.join(split
[0:3]) + '_'
1588 if thisPrefix
== prefix
:
1589 guid
= self
.ToolDef
.ToolsDefTxtDictionary
[attrib
]
1592 path
= '_'.join(split
[0:4]) + '_PATH'
1593 path
= self
.ToolDef
.ToolsDefTxtDictionary
[path
]
1594 path
= self
.GetFullPathOfTool(path
)
1595 guidAttribs
.append((guid
, toolName
, path
))
1597 # Write out GuidedSecTools.txt
1598 toolsFile
= os
.path
.join(FvDir
, 'GuidedSectionTools.txt')
1599 toolsFile
= open(toolsFile
, 'wt')
1600 for guidedSectionTool
in guidAttribs
:
1601 print >> toolsFile
, ' '.join(guidedSectionTool
)
1604 ## Returns the full path of the tool.
1606 def GetFullPathOfTool (self
, tool
):
1607 if os
.path
.exists(tool
):
1608 return os
.path
.realpath(tool
)
1610 # We need to search for the tool using the
1611 # PATH environment variable.
1612 for dirInPath
in os
.environ
['PATH'].split(os
.pathsep
):
1613 foundPath
= os
.path
.join(dirInPath
, tool
)
1614 if os
.path
.exists(foundPath
):
1615 return os
.path
.realpath(foundPath
)
1617 # If the tool was not found in the path then we just return
1621 ## Launch the module or platform build
1624 if self
.ModuleFile
== None or self
.ModuleFile
== "":
1625 if not self
.SpawnMode
or self
.Target
not in ["", "all"]:
1626 self
.SpawnMode
= False
1627 self
._BuildPlatform
()
1629 self
._MultiThreadBuildPlatform
()
1630 self
.CreateGuidedSectionToolsFile()
1632 self
.SpawnMode
= False
1635 ## Do some clean-up works when error occurred
1636 def Relinquish(self
):
1637 OldLogLevel
= EdkLogger
.GetLevel()
1638 EdkLogger
.SetLevel(EdkLogger
.ERROR
)
1639 #self.DumpBuildData()
1640 Utils
.Progressor
.Abort()
1641 if self
.SpawnMode
== True:
1643 EdkLogger
.SetLevel(OldLogLevel
)
1645 def DumpBuildData(self
):
1646 CacheDirectory
= os
.path
.join(self
.WorkspaceDir
, gBuildCacheDir
)
1647 Utils
.CreateDirectory(CacheDirectory
)
1648 Utils
.DataDump(Utils
.gFileTimeStampCache
, os
.path
.join(CacheDirectory
, "gFileTimeStampCache"))
1649 Utils
.DataDump(Utils
.gDependencyDatabase
, os
.path
.join(CacheDirectory
, "gDependencyDatabase"))
1651 def RestoreBuildData(self
):
1652 FilePath
= os
.path
.join(self
.WorkspaceDir
, gBuildCacheDir
, "gFileTimeStampCache")
1653 if Utils
.gFileTimeStampCache
== {} and os
.path
.isfile(FilePath
):
1654 Utils
.gFileTimeStampCache
= Utils
.DataRestore(FilePath
)
1655 if Utils
.gFileTimeStampCache
== None:
1656 Utils
.gFileTimeStampCache
= {}
1658 FilePath
= os
.path
.join(self
.WorkspaceDir
, gBuildCacheDir
, "gDependencyDatabase")
1659 if Utils
.gDependencyDatabase
== {} and os
.path
.isfile(FilePath
):
1660 Utils
.gDependencyDatabase
= Utils
.DataRestore(FilePath
)
1661 if Utils
.gDependencyDatabase
== None:
1662 Utils
.gDependencyDatabase
= {}
1664 def ParseDefines(DefineList
=[]):
1666 if DefineList
!= None:
1667 for Define
in DefineList
:
1668 DefineTokenList
= Define
.split("=", 1)
1669 if len(DefineTokenList
) == 1:
1670 DefineDict
[DefineTokenList
[0]] = ""
1672 DefineDict
[DefineTokenList
[0]] = DefineTokenList
[1].strip()
1676 def SingleCheckCallback(option
, opt_str
, value
, parser
):
1677 if option
not in gParamCheck
:
1678 setattr(parser
.values
, option
.dest
, value
)
1679 gParamCheck
.append(option
)
1681 parser
.error("Option %s only allows one instance in command line!" % option
)
1683 ## Parse command line options
1685 # Using standard Python module optparse to parse command line option of this tool.
1687 # @retval Opt A optparse.Values object containing the parsed options
1688 # @retval Args Target of build command
1690 def MyOptionParser():
1691 Parser
= OptionParser(description
=__copyright__
,version
=__version__
,prog
="build.exe",usage
="%prog [options] [all|fds|genc|genmake|clean|cleanall|cleanlib|modules|libraries|run]")
1692 Parser
.add_option("-a", "--arch", action
="append", type="choice", choices
=['IA32','X64','IPF','EBC','ARM'], dest
="TargetArch",
1693 help="ARCHS is one of list: IA32, X64, IPF, ARM or EBC, which overrides target.txt's TARGET_ARCH definition. To specify more archs, please repeat this option.")
1694 Parser
.add_option("-p", "--platform", action
="callback", type="string", dest
="PlatformFile", callback
=SingleCheckCallback
,
1695 help="Build the platform specified by the DSC file name argument, overriding target.txt's ACTIVE_PLATFORM definition.")
1696 Parser
.add_option("-m", "--module", action
="callback", type="string", dest
="ModuleFile", callback
=SingleCheckCallback
,
1697 help="Build the module specified by the INF file name argument.")
1698 Parser
.add_option("-b", "--buildtarget", action
="append", type="choice", choices
=['DEBUG','RELEASE'], dest
="BuildTarget",
1699 help="BuildTarget is one of list: DEBUG, RELEASE, which overrides target.txt's TARGET definition. To specify more TARGET, please repeat this option.")
1700 Parser
.add_option("-t", "--tagname", action
="append", type="string", dest
="ToolChain",
1701 help="Using the Tool Chain Tagname to build the platform, overriding target.txt's TOOL_CHAIN_TAG definition.")
1702 Parser
.add_option("-x", "--sku-id", action
="callback", type="string", dest
="SkuId", callback
=SingleCheckCallback
,
1703 help="Using this name of SKU ID to build the platform, overriding SKUID_IDENTIFIER in DSC file.")
1705 Parser
.add_option("-n", action
="callback", type="int", dest
="ThreadNumber", callback
=SingleCheckCallback
,
1706 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.")
1708 Parser
.add_option("-f", "--fdf", action
="callback", type="string", dest
="FdfFile", callback
=SingleCheckCallback
,
1709 help="The name of the FDF file to use, which overrides the setting in the DSC file.")
1710 Parser
.add_option("-r", "--rom-image", action
="append", type="string", dest
="RomImage", default
=[],
1711 help="The name of FD to be generated. The name must be from [FD] section in FDF file.")
1712 Parser
.add_option("-i", "--fv-image", action
="append", type="string", dest
="FvImage", default
=[],
1713 help="The name of FV to be generated. The name must be from [FV] section in FDF file.")
1715 Parser
.add_option("-u", "--skip-autogen", action
="store_true", dest
="SkipAutoGen", help="Skip AutoGen step.")
1716 Parser
.add_option("-e", "--re-parse", action
="store_true", dest
="Reparse", help="Re-parse all meta-data files.")
1718 Parser
.add_option("-c", "--case-insensitive", action
="store_true", dest
="CaseInsensitive", help="Don't check case of file name.")
1720 # Parser.add_option("-D", "--define", action="append", dest="Defines", metavar="NAME[=[VALUE]]",
1721 # help="Define global macro which can be used in DSC/DEC/INF files.")
1723 Parser
.add_option("-w", "--warning-as-error", action
="store_true", dest
="WarningAsError", help="Treat warning in tools as error.")
1724 Parser
.add_option("-j", "--log", action
="store", dest
="LogFile", help="Put log in specified file as well as on console.")
1726 Parser
.add_option("-s", "--silent", action
="store_true", type=None, dest
="SilentMode",
1727 help="Make use of silent mode of (n)make.")
1728 Parser
.add_option("-q", "--quiet", action
="store_true", type=None, help="Disable all messages except FATAL ERRORS.")
1729 Parser
.add_option("-v", "--verbose", action
="store_true", type=None, help="Turn on verbose output with informational messages printed, "\
1730 "including library instances selected, final dependency expression, "\
1731 "and warning messages, etc.")
1732 Parser
.add_option("-d", "--debug", action
="store", type="int", help="Enable debug messages at specified level.")
1733 Parser
.add_option("-D", "--define", action
="append", type="string", dest
="Macros", help="Macro: \"Name [= Value]\".")
1735 Parser
.add_option("-y", "--report-file", action
="store", dest
="ReportFile", help="Create/overwrite the report to the specified filename.")
1736 Parser
.add_option("-Y", "--report-type", action
="append", type="choice", choices
=['PCD','LIBRARY','FLASH','DEPEX','BUILD_FLAGS','FIXED_ADDRESS', 'EXECUTION_ORDER'], dest
="ReportType", default
=[],
1737 help="Flags that control the type of build report to generate. Must be one of: [PCD, LIBRARY, FLASH, DEPEX, BUILD_FLAGS, FIXED_ADDRESS, EXECUTION_ORDER]. "\
1738 "To specify more than one flag, repeat this option on the command line and the default flag set is [PCD, LIBRARY, FLASH, DEPEX, BUILD_FLAGS, FIXED_ADDRESS]")
1739 Parser
.add_option("-F", "--flag", action
="store", type="string", dest
="Flag",
1740 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. "\
1741 "This option can also be specified by setting *_*_*_BUILD_FLAGS in [BuildOptions] section of platform DSC. If they are both specified, this value "\
1742 "will override the setting in [BuildOptions] section of platform DSC.")
1744 (Opt
, Args
)=Parser
.parse_args()
1747 ## Tool entrance method
1749 # This method mainly dispatch specific methods per the command line options.
1750 # If no error found, return zero value so the caller of this tool can know
1751 # if it's executed successfully or not.
1753 # @retval 0 Tool was successful
1754 # @retval 1 Tool failed
1757 StartTime
= time
.time()
1759 # Initialize log system
1760 EdkLogger
.Initialize()
1763 # Parse the options and args
1765 (Option
, Target
) = MyOptionParser()
1766 GlobalData
.gOptions
= Option
1767 GlobalData
.gCaseInsensitive
= Option
.CaseInsensitive
1770 if Option
.verbose
!= None:
1771 EdkLogger
.SetLevel(EdkLogger
.VERBOSE
)
1772 elif Option
.quiet
!= None:
1773 EdkLogger
.SetLevel(EdkLogger
.QUIET
)
1774 elif Option
.debug
!= None:
1775 EdkLogger
.SetLevel(Option
.debug
+ 1)
1777 EdkLogger
.SetLevel(EdkLogger
.INFO
)
1779 if Option
.LogFile
!= None:
1780 EdkLogger
.SetLogFile(Option
.LogFile
)
1782 if Option
.WarningAsError
== True:
1783 EdkLogger
.SetWarningAsError()
1785 if platform
.platform().find("Windows") >= 0:
1786 GlobalData
.gIsWindows
= True
1788 GlobalData
.gIsWindows
= False
1790 EdkLogger
.quiet(time
.strftime("%H:%M:%S, %b.%d %Y ", time
.localtime()) + "[%s]\n" % platform
.platform())
1794 if len(Target
) == 0:
1796 elif len(Target
) >= 2:
1797 EdkLogger
.error("build", OPTION_NOT_SUPPORTED
, "More than one targets are not supported.",
1798 ExtraData
="Please select one of: %s" %(' '.join(gSupportedTarget
)))
1800 Target
= Target
[0].lower()
1802 if Target
not in gSupportedTarget
:
1803 EdkLogger
.error("build", OPTION_NOT_SUPPORTED
, "Not supported target [%s]." % Target
,
1804 ExtraData
="Please select one of: %s" %(' '.join(gSupportedTarget
)))
1806 GlobalData
.gGlobalDefines
= ParseDefines(Option
.Macros
)
1808 # Check environment variable: EDK_TOOLS_PATH, WORKSPACE, PATH
1811 Workspace
= os
.getenv("WORKSPACE")
1813 # Get files real name in workspace dir
1815 GlobalData
.gAllFiles
= Utils
.DirCache(Workspace
)
1817 WorkingDirectory
= os
.getcwd()
1818 if not Option
.ModuleFile
:
1819 FileList
= glob
.glob(os
.path
.normpath(os
.path
.join(WorkingDirectory
, '*.inf')))
1820 FileNum
= len(FileList
)
1822 EdkLogger
.error("build", OPTION_NOT_SUPPORTED
, "There are %d INF files in %s." % (FileNum
, WorkingDirectory
),
1823 ExtraData
="Please use '-m <INF_FILE_PATH>' switch to choose one.")
1825 Option
.ModuleFile
= NormFile(FileList
[0], Workspace
)
1827 if Option
.ModuleFile
:
1828 if os
.path
.isabs (Option
.ModuleFile
):
1829 if os
.path
.normcase (os
.path
.normpath(Option
.ModuleFile
)).find (Workspace
) == 0:
1830 Option
.ModuleFile
= NormFile(os
.path
.normpath(Option
.ModuleFile
), Workspace
)
1831 Option
.ModuleFile
= PathClass(Option
.ModuleFile
, Workspace
)
1832 ErrorCode
, ErrorInfo
= Option
.ModuleFile
.Validate(".inf", False)
1834 EdkLogger
.error("build", ErrorCode
, ExtraData
=ErrorInfo
)
1836 if Option
.PlatformFile
!= None:
1837 if os
.path
.isabs (Option
.PlatformFile
):
1838 if os
.path
.normcase (os
.path
.normpath(Option
.PlatformFile
)).find (Workspace
) == 0:
1839 Option
.PlatformFile
= NormFile(os
.path
.normpath(Option
.PlatformFile
), Workspace
)
1840 Option
.PlatformFile
= PathClass(Option
.PlatformFile
, Workspace
)
1841 ErrorCode
, ErrorInfo
= Option
.PlatformFile
.Validate(".dsc", False)
1843 EdkLogger
.error("build", ErrorCode
, ExtraData
=ErrorInfo
)
1845 if Option
.FdfFile
!= None:
1846 if os
.path
.isabs (Option
.FdfFile
):
1847 if os
.path
.normcase (os
.path
.normpath(Option
.FdfFile
)).find (Workspace
) == 0:
1848 Option
.FdfFile
= NormFile(os
.path
.normpath(Option
.FdfFile
), Workspace
)
1849 Option
.FdfFile
= PathClass(Option
.FdfFile
, Workspace
)
1850 ErrorCode
, ErrorInfo
= Option
.FdfFile
.Validate(".fdf", False)
1852 EdkLogger
.error("build", ErrorCode
, ExtraData
=ErrorInfo
)
1854 if Option
.Flag
!= None and Option
.Flag
not in ['-c', '-s']:
1855 EdkLogger
.error("build", OPTION_VALUE_INVALID
, "UNI flag must be one of -c or -s")
1857 MyBuild
= Build(Target
, Workspace
, Option
.PlatformFile
, Option
.ModuleFile
,
1858 Option
.TargetArch
, Option
.ToolChain
, Option
.BuildTarget
,
1859 Option
.FdfFile
, Option
.RomImage
, Option
.FvImage
,
1860 None, Option
.SilentMode
, Option
.ThreadNumber
,
1861 Option
.SkipAutoGen
, Option
.Reparse
, Option
.SkuId
,
1862 Option
.ReportFile
, Option
.ReportType
, Option
.Flag
)
1864 #MyBuild.DumpBuildData()
1865 except FatalError
, X
:
1867 # for multi-thread build exits safely
1868 MyBuild
.Relinquish()
1869 if Option
!= None and Option
.debug
!= None:
1870 EdkLogger
.quiet("(Python %s on %s) " % (platform
.python_version(), sys
.platform
) + traceback
.format_exc())
1871 ReturnCode
= X
.args
[0]
1873 # error from Fdf parser
1875 # for multi-thread build exits safely
1876 MyBuild
.Relinquish()
1877 if Option
!= None and Option
.debug
!= None:
1878 EdkLogger
.quiet("(Python %s on %s) " % (platform
.python_version(), sys
.platform
) + traceback
.format_exc())
1880 EdkLogger
.error(X
.ToolName
, FORMAT_INVALID
, File
=X
.FileName
, Line
=X
.LineNumber
, ExtraData
=X
.Message
, RaiseError
= False)
1881 ReturnCode
= FORMAT_INVALID
1882 except KeyboardInterrupt:
1883 ReturnCode
= ABORT_ERROR
1884 if Option
!= None and Option
.debug
!= None:
1885 EdkLogger
.quiet("(Python %s on %s) " % (platform
.python_version(), sys
.platform
) + traceback
.format_exc())
1888 # for multi-thread build exits safely
1889 MyBuild
.Relinquish()
1891 # try to get the meta-file from the object causing exception
1892 Tb
= sys
.exc_info()[-1]
1893 MetaFile
= GlobalData
.gProcessingFile
1895 if 'self' in Tb
.tb_frame
.f_locals
and hasattr(Tb
.tb_frame
.f_locals
['self'], 'MetaFile'):
1896 MetaFile
= Tb
.tb_frame
.f_locals
['self'].MetaFile
1901 "Unknown fatal error when processing [%s]" % MetaFile
,
1902 ExtraData
="\n(Please send email to edk2-buildtools-devel@lists.sourceforge.net for help, attaching following call stack trace!)\n",
1905 EdkLogger
.quiet("(Python %s on %s) " % (platform
.python_version(), sys
.platform
) + traceback
.format_exc())
1906 ReturnCode
= CODE_ERROR
1908 Utils
.Progressor
.Abort()
1912 elif ReturnCode
== ABORT_ERROR
:
1913 Conclusion
= "Aborted"
1915 Conclusion
= "Failed"
1916 FinishTime
= time
.time()
1917 BuildDuration
= time
.strftime("%M:%S", time
.gmtime(int(round(FinishTime
- StartTime
))))
1919 MyBuild
.BuildReport
.GenerateReport(BuildDuration
)
1921 EdkLogger
.SetLevel(EdkLogger
.QUIET
)
1922 EdkLogger
.quiet("\n- %s -\n%s [%s]" % (Conclusion
, time
.strftime("%H:%M:%S, %b.%d %Y", time
.localtime()), BuildDuration
))
1926 if __name__
== '__main__':
1928 ## 0-127 is a safe return range, and 1 is a standard default error
1929 if r
< 0 or r
> 127: r
= 1