2 This file is ANT task GenBuild.
4 The file is used to parse a specified Module, and generate its build time
5 ANT script build.xml, then call the the ANT script to build the module.
7 Copyright (c) 2006, Intel Corporation
8 All rights reserved. This program and the accompanying materials
9 are licensed and made available under the terms and conditions of the BSD License
10 which accompanies this distribution. The full text of the license may be found at
11 http://opensource.org/licenses/bsd-license.php
13 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
14 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
16 package org
.tianocore
.build
;
19 import java
.util
.Hashtable
;
20 import java
.util
.Iterator
;
21 import java
.util
.LinkedHashSet
;
22 import java
.util
.List
;
25 import java
.util
.Vector
;
27 import org
.apache
.tools
.ant
.BuildException
;
28 import org
.apache
.tools
.ant
.BuildListener
;
29 import org
.apache
.tools
.ant
.Location
;
30 import org
.apache
.tools
.ant
.Project
;
31 import org
.apache
.tools
.ant
.taskdefs
.Ant
;
32 import org
.apache
.tools
.ant
.taskdefs
.Property
;
33 import org
.apache
.xmlbeans
.XmlObject
;
34 import org
.tianocore
.build
.autogen
.AutoGen
;
35 import org
.tianocore
.build
.exception
.AutoGenException
;
36 import org
.tianocore
.build
.exception
.GenBuildException
;
37 import org
.tianocore
.build
.exception
.PcdAutogenException
;
38 import org
.tianocore
.build
.exception
.PlatformPcdPreprocessBuildException
;
39 import org
.tianocore
.build
.fpd
.FpdParserTask
;
40 import org
.tianocore
.build
.global
.GlobalData
;
41 import org
.tianocore
.build
.global
.OutputManager
;
42 import org
.tianocore
.build
.global
.SurfaceAreaQuery
;
43 import org
.tianocore
.build
.id
.FpdModuleIdentification
;
44 import org
.tianocore
.build
.id
.ModuleIdentification
;
45 import org
.tianocore
.build
.id
.PackageIdentification
;
46 import org
.tianocore
.build
.id
.PlatformIdentification
;
47 import org
.tianocore
.build
.tools
.ModuleItem
;
48 import org
.tianocore
.common
.definitions
.ToolDefinitions
;
49 import org
.tianocore
.common
.exception
.EdkException
;
50 import org
.tianocore
.common
.logger
.EdkLog
;
54 <code>GenBuildTask</code> is an ANT task that can be used in ANT build
57 <p>The main function of this task is to parse module's surface area (MSA),
58 then generate the corresponding <em>BaseName_build.xml</em> (the real ANT
59 build script) and call this to build the module. The whole process including:
62 1. generate AutoGen.c and AutoGen.h;
63 2. build all dependent library instances;
64 3. build all source files inlcude AutoGen.c;
66 5. generate FFS file if it is driver module while LIB file if it is Library module.
71 The usage is (take module <em>HelloWorld</em> for example):
76 msaFile="${PACKAGE_DIR}/Application/HelloWorld/HelloWorld.msa"
81 This task calls <code>AutoGen</code> to generate <em>AutoGen.c</em> and
86 This task will also set properties for current module, such as PACKAGE,
87 PACKAGE_GUID, PACKAGE_VERSION, PACKAGE_DIR, PACKAGE_RELATIVE_DIR
88 (relative to Workspace), MODULE or BASE_NAME, GUID, VERSION, MODULE_DIR,
89 MODULE_RELATIVE_DIR (relative to Package), CONFIG_DIR, BIN_DIR,
90 DEST_DIR_DEBUG, DEST_DIR_OUTPUT, TARGET, ARCH, TOOLCHAIN, TOOLCHAIN_FAMILY,
91 SUBSYSTEM, ENTRYPOINT, EBC_TOOL_LIB_PATH, all compiler command related
92 properties (CC, CC_FLAGS, CC_DPATH, CC_SPATH, CC_FAMILY, CC_EXT).
97 public class GenBuildTask
extends Ant
{
100 /// Module surface area file.
104 public ModuleIdentification parentId
;
106 private String type
= "all";
109 /// Module's Identification.
111 private ModuleIdentification moduleId
;
113 private Vector
<Property
> properties
= new Vector
<Property
>();
115 private boolean isSingleModuleBuild
= false;
117 private SurfaceAreaQuery saq
= null;
120 Public construct method. It is necessary for ANT task.
122 public GenBuildTask() {
127 @throws BuildException
128 From module build, exception from module surface area invalid.
130 public void execute() throws BuildException
{
131 this.setTaskName("GenBuild");
134 } catch (PcdAutogenException e
) {
135 BuildException buildException
= new BuildException(e
.getMessage());
136 buildException
.setStackTrace(e
.getStackTrace());
137 throw buildException
;
138 } catch (AutoGenException e
) {
139 BuildException buildException
= new BuildException(e
.getMessage());
140 buildException
.setStackTrace(e
.getStackTrace());
141 throw buildException
;
142 } catch (PlatformPcdPreprocessBuildException e
) {
143 BuildException buildException
= new BuildException(e
.getMessage());
144 buildException
.setStackTrace(e
.getStackTrace());
145 throw buildException
;
146 } catch (GenBuildException e
) {
147 BuildException buildException
= new BuildException(e
.getMessage());
148 buildException
.setStackTrace(e
.getStackTrace());
149 throw buildException
;
150 } catch (EdkException e
) {
151 BuildException buildException
= new BuildException(e
.getMessage());
152 buildException
.setStackTrace(e
.getStackTrace());
153 throw buildException
;
154 } catch (Exception e
) {
155 BuildException buildException
= new BuildException(e
.getMessage());
156 buildException
.setStackTrace(e
.getStackTrace());
157 throw buildException
;
161 private void processGenBuild() throws EdkException
, BuildException
, GenBuildException
, AutoGenException
, PcdAutogenException
, PlatformPcdPreprocessBuildException
{
162 if (!FrameworkBuildTask
.multithread
) {
167 // Enable all specified properties
169 Iterator
<Property
> iter
= properties
.iterator();
170 while (iter
.hasNext()) {
171 Property item
= iter
.next();
172 getProject().setProperty(item
.getName(), item
.getValue());
176 // GenBuild should specify either msaFile or moduleGuid & packageGuid
178 if (msaFile
== null ) {
179 String moduleGuid
= getProject().getProperty("MODULE_GUID");
180 String moduleVersion
= getProject().getProperty("MODULE_VERSION");
181 String packageGuid
= getProject().getProperty("PACKAGE_GUID");
182 String packageVersion
= getProject().getProperty("PACKAGE_VERSION");
184 // If one of module Guid or package Guid is not specified, report error
186 if (moduleGuid
== null || packageGuid
== null) {
187 throw new BuildException("GenBuild parameter error.");
190 PackageIdentification packageId
= new PackageIdentification(packageGuid
, packageVersion
);
191 GlobalData
.refreshPackageIdentification(packageId
);
192 moduleId
= new ModuleIdentification(moduleGuid
, moduleVersion
);
193 moduleId
.setPackage(packageId
);
194 GlobalData
.refreshModuleIdentification(moduleId
);
195 Map
<String
, XmlObject
> doc
= GlobalData
.getNativeMsa(moduleId
);
196 saq
= new SurfaceAreaQuery(doc
);
198 Map
<String
, XmlObject
> doc
= GlobalData
.getNativeMsa(msaFile
);
199 saq
= new SurfaceAreaQuery(doc
);
200 moduleId
= saq
.getMsaHeader();
201 moduleId
.setMsaFile(msaFile
);
204 String
[] producedLibraryClasses
= saq
.getLibraryClasses("ALWAYS_PRODUCED", null, null);
205 if (producedLibraryClasses
.length
== 0) {
206 moduleId
.setLibrary(false);
208 moduleId
.setLibrary(true);
210 moduleId
.setBinary(saq
.getBinaryModule());
213 // Judge whether it is single module build or not
215 if (isSingleModuleBuild
) {
217 // Single Module build
219 prepareSingleModuleBuild();
223 // If single module : get arch from pass down, otherwise intersection MSA
224 // supported ARCHs and tools def
226 Set
<String
> archListSupByToolChain
= new LinkedHashSet
<String
>();
227 String
[] archs
= GlobalData
.getToolChainInfo().getArchs();
229 for (int i
= 0; i
< archs
.length
; i
++) {
230 archListSupByToolChain
.add(archs
[i
]);
233 Set
<String
> archSet
= new LinkedHashSet
<String
>();
234 String archString
= getProject().getProperty("ARCH");
235 if (archString
!= null && archString
.length() > 0) {
236 String
[] fpdArchList
= archString
.split(" ");
238 for (int i
= 0; i
< fpdArchList
.length
; i
++) {
239 if (archListSupByToolChain
.contains(fpdArchList
[i
])) {
240 archSet
.add(fpdArchList
[i
]);
244 archSet
= archListSupByToolChain
;
247 String
[] archList
= archSet
.toArray(new String
[archSet
.size()]);
250 // Judge if arch is all supported by current module. If not, throw Exception.
252 List moduleSupportedArchs
= saq
.getModuleSupportedArchs();
253 if (moduleSupportedArchs
!= null) {
254 for (int k
= 0; k
< archList
.length
; k
++) {
255 if (!moduleSupportedArchs
.contains(archList
[k
])) {
256 EdkLog
.log(this, EdkLog
.EDK_WARNING
, "Specified architecture [" + archList
[k
] + "] is not supported by " + moduleId
+ ". The module " + moduleId
+ " only supports [" + moduleSupportedArchs
+ "] architectures.");
262 if (archList
.length
== 0) {
263 EdkLog
.log(this, EdkLog
.EDK_WARNING
, "Warning: " + "[" + archString
+ "] is not supported for " + moduleId
+ " in this build!\n");
266 for (int k
= 0; k
< archList
.length
; k
++) {
267 if (archList
[k
] == "") {
271 getProject().setProperty("ARCH", archList
[k
]);
273 FpdModuleIdentification fpdModuleId
= new FpdModuleIdentification(moduleId
, archList
[k
]);
276 // Whether the module is built before
278 if (moduleId
.isLibrary() == false && GlobalData
.hasFpdModuleSA(fpdModuleId
) == false) {
279 EdkLog
.log(this, EdkLog
.EDK_WARNING
, "Warning: " + moduleId
+ " for " + archList
[k
] + " was not found in current platform FPD file!\n");
281 } else if (GlobalData
.isModuleBuilt(fpdModuleId
)) {
284 GlobalData
.registerBuiltModule(fpdModuleId
);
288 // For Every TOOLCHAIN, TARGET
290 String
[] targetList
= GlobalData
.getToolChainInfo().getTargets();
291 for (int i
= 0; i
< targetList
.length
; i
++){
293 // Prepare for target related common properties
296 getProject().setProperty("TARGET", targetList
[i
]);
297 String
[] toolchainList
= GlobalData
.getToolChainInfo().getTagnames();
298 for(int j
= 0; j
< toolchainList
.length
; j
++){
300 // check if any tool is defined for current target + toolchain + arch
301 // don't do anything if no tools found
303 if (GlobalData
.isCommandSet(targetList
[i
], toolchainList
[j
], archList
[k
]) == false) {
304 EdkLog
.log(this, EdkLog
.EDK_WARNING
, "Warning: No build issued. No tools found for [target=" + targetList
[i
] + " toolchain=" + toolchainList
[j
] + " arch=" + archList
[k
] + "]\n");
309 // Prepare for toolchain related common properties
312 getProject().setProperty("TOOLCHAIN", toolchainList
[j
]);
314 EdkLog
.log(this, "Build " + moduleId
+ " start >>>");
315 EdkLog
.log(this, "Target: " + targetList
[i
] + " Tagname: " + toolchainList
[j
] + " Arch: " + archList
[k
]);
316 saq
.push(GlobalData
.getDoc(fpdModuleId
));
319 // Prepare for all other common properties
320 // PACKAGE, PACKAGE_GUID, PACKAGE_VERSION, PACKAGE_DIR, PACKAGE_RELATIVE_DIR
321 // MODULE or BASE_NAME, GUID or FILE_GUID, VERSION, MODULE_TYPE
322 // MODULE_DIR, MODULE_RELATIVE_DIR
323 // SUBSYSTEM, ENTRYPOINT, EBC_TOOL_LIB_PATH
325 setModuleCommonProperties(archList
[k
]);
328 // OutputManage prepare for
329 // BIN_DIR, DEST_DIR_DEBUG, DEST_DIR_OUTPUT, BUILD_DIR, FV_DIR
331 OutputManager
.getInstance().update(getProject());
333 if (type
.equalsIgnoreCase("all") || type
.equalsIgnoreCase("build")) {
334 applyBuild(targetList
[i
], toolchainList
[j
], fpdModuleId
);
336 applyNonBuildTarget(fpdModuleId
);
344 This method is used to prepare Platform-related information.
346 <p>In Single Module Build mode, platform-related information is not ready.
347 The method read the system environment variable <code>ACTIVE_PLATFORM</code>
348 and search in the Framework Database. Note that platform name in the Framework
349 Database must be unique. </p>
352 private void prepareSingleModuleBuild() throws EdkException
{
354 // Find out the package which the module belongs to
356 PackageIdentification packageId
= GlobalData
.getPackageForModule(moduleId
);
357 GlobalData
.refreshPackageIdentification(packageId
);
358 moduleId
.setPackage(packageId
);
359 GlobalData
.refreshModuleIdentification(moduleId
);
362 // Read ACTIVE_PLATFORM's FPD file
364 String filename
= getProject().getProperty("PLATFORM_FILE");
366 if (filename
== null){
367 throw new BuildException("Please set ACTIVE_PLATFORM in the file: Tools/Conf/target.txt if you want to build a single module!");
370 PlatformIdentification platformId
= GlobalData
.getPlatform(filename
);
373 // Read FPD file (Call FpdParserTask's method)
375 FpdParserTask fpdParser
= new FpdParserTask();
376 fpdParser
.setProject(getProject());
377 fpdParser
.parseFpdFile(platformId
.getFpdFile());
378 getProject().setProperty("ARCH", fpdParser
.getAllArchForModule(moduleId
));
381 private void cleanupProperties() {
382 Project newProject
= new Project();
384 Hashtable
<String
, String
> passdownProperties
= FrameworkBuildTask
.originalProperties
;
385 Iterator
<String
> iter
= passdownProperties
.keySet().iterator();
386 while (iter
.hasNext()) {
387 String item
= iter
.next();
388 newProject
.setProperty(item
, passdownProperties
.get(item
));
391 newProject
.setInputHandler(getProject().getInputHandler());
393 Iterator listenerIter
= getProject().getBuildListeners().iterator();
394 while (listenerIter
.hasNext()) {
395 newProject
.addBuildListener((BuildListener
) listenerIter
.next());
398 getProject().initSubProject(newProject
);
400 setProject(newProject
);
404 Set Module-Related information to properties.
406 @param arch current build ARCH
408 private void setModuleCommonProperties(String arch
) {
410 // Prepare for all other common properties
411 // PACKAGE, PACKAGE_GUID, PACKAGE_VERSION, PACKAGE_DIR, PACKAGE_RELATIVE_DIR
413 PackageIdentification packageId
= moduleId
.getPackage();
414 getProject().setProperty("PACKAGE", packageId
.getName());
415 getProject().setProperty("PACKAGE_GUID", packageId
.getGuid());
416 getProject().setProperty("PACKAGE_VERSION", packageId
.getVersion());
417 getProject().setProperty("PACKAGE_DIR", packageId
.getPackageDir().replaceAll("(\\\\)", "/"));
418 getProject().setProperty("PACKAGE_RELATIVE_DIR", packageId
.getPackageRelativeDir().replaceAll("(\\\\)", "/"));
421 // MODULE or BASE_NAME, GUID or FILE_GUID, VERSION, MODULE_TYPE
422 // MODULE_DIR, MODULE_RELATIVE_DIR
424 getProject().setProperty("MODULE", moduleId
.getName());
425 String baseName
= saq
.getModuleOutputFileBasename();
426 if (baseName
== null) {
427 getProject().setProperty("BASE_NAME", moduleId
.getName());
429 getProject().setProperty("BASE_NAME", baseName
);
431 getProject().setProperty("GUID", moduleId
.getGuid());
432 getProject().setProperty("FILE_GUID", moduleId
.getGuid());
433 getProject().setProperty("VERSION", moduleId
.getVersion());
434 getProject().setProperty("MODULE_TYPE", moduleId
.getModuleType());
435 File msaFile
= moduleId
.getMsaFile();
436 String msaFileName
= msaFile
.getName();
437 getProject().setProperty("MODULE_DIR", msaFile
.getParent().replaceAll("(\\\\)", "/"));
438 getProject().setProperty("MODULE_RELATIVE_DIR", moduleId
.getModuleRelativePath().replaceAll("(\\\\)", "/")
439 + File
.separatorChar
+ msaFileName
.substring(0, msaFileName
.lastIndexOf('.')));
444 String
[][] subsystemMap
= { { "BASE", "EFI_BOOT_SERVICE_DRIVER"},
445 { "SEC", "EFI_BOOT_SERVICE_DRIVER" },
446 { "PEI_CORE", "EFI_BOOT_SERVICE_DRIVER" },
447 { "PEIM", "EFI_BOOT_SERVICE_DRIVER" },
448 { "DXE_CORE", "EFI_BOOT_SERVICE_DRIVER" },
449 { "DXE_DRIVER", "EFI_BOOT_SERVICE_DRIVER" },
450 { "DXE_RUNTIME_DRIVER", "EFI_RUNTIME_DRIVER" },
451 { "DXE_SAL_DRIVER", "EFI_BOOT_SERVICE_DRIVER" },
452 { "DXE_SMM_DRIVER", "EFI_BOOT_SERVICE_DRIVER" },
453 { "TOOL", "EFI_BOOT_SERVICE_DRIVER" },
454 { "UEFI_DRIVER", "EFI_BOOT_SERVICE_DRIVER" },
455 { "UEFI_APPLICATION", "EFI_APPLICATION" },
456 { "USER_DEFINED", "EFI_BOOT_SERVICE_DRIVER"} };
458 String subsystem
= "EFI_BOOT_SERVICE_DRIVER";
459 for (int i
= 0; i
< subsystemMap
.length
; i
++) {
460 if (moduleId
.getModuleType().equalsIgnoreCase(subsystemMap
[i
][0])) {
461 subsystem
= subsystemMap
[i
][1];
465 getProject().setProperty("SUBSYSTEM", subsystem
);
470 if (arch
.equalsIgnoreCase("EBC")) {
471 getProject().setProperty("ENTRYPOINT", "EfiStart");
473 getProject().setProperty("ENTRYPOINT", "_ModuleEntryPoint");
476 getProject().setProperty("OBJECTS", "");
479 private void getCompilerFlags(String target
, String toolchain
, FpdModuleIdentification fpdModuleId
) throws EdkException
{
480 String
[] cmd
= GlobalData
.getToolChainInfo().getCommands();
481 for ( int m
= 0; m
< cmd
.length
; m
++) {
483 // Set cmd, like CC, DLINK
485 String
[] key
= new String
[]{target
, toolchain
, fpdModuleId
.getArch(), cmd
[m
], null};
486 key
[4] = ToolDefinitions
.TOOLS_DEF_ATTRIBUTE_PATH
;
487 String cmdPath
= GlobalData
.getCommandSetting(key
, fpdModuleId
);
488 key
[4] = ToolDefinitions
.TOOLS_DEF_ATTRIBUTE_NAME
;
489 String cmdName
= GlobalData
.getCommandSetting(key
, fpdModuleId
);
490 if (cmdName
.length() == 0) {
491 EdkLog
.log(this, EdkLog
.EDK_VERBOSE
, "Warning: " + cmd
[m
] + " hasn't been defined!");
492 getProject().setProperty(cmd
[m
], "");
495 File cmdFile
= new File(cmdPath
+ File
.separatorChar
+ cmdName
);
496 getProject().setProperty(cmd
[m
], cmdFile
.getPath().replaceAll("(\\\\)", "/"));
501 key
[4] = ToolDefinitions
.TOOLS_DEF_ATTRIBUTE_FLAGS
;
502 String cmdFlags
= GlobalData
.getCommandSetting(key
, fpdModuleId
);
503 if (cmdFlags
!= null)
505 getProject().setProperty(cmd
[m
] + "_FLAGS", cmdFlags
);
509 getProject().setProperty(cmd
[m
] + "_FLAGS", "");
515 key
[4] = ToolDefinitions
.TOOLS_DEF_ATTRIBUTE_EXT
;
516 String extName
= GlobalData
.getCommandSetting(key
, fpdModuleId
);
517 if ( extName
!= null && ! extName
.equalsIgnoreCase("")) {
518 getProject().setProperty(cmd
[m
] + "_EXT", extName
);
520 getProject().setProperty(cmd
[m
] + "_EXT", "");
526 key
[4] = ToolDefinitions
.TOOLS_DEF_ATTRIBUTE_FAMILY
;
527 String toolChainFamily
= GlobalData
.getCommandSetting(key
, fpdModuleId
);
528 if (toolChainFamily
!= null) {
529 getProject().setProperty(cmd
[m
] + "_FAMILY", toolChainFamily
);
535 key
[4] = ToolDefinitions
.TOOLS_DEF_ATTRIBUTE_SPATH
;
536 String spath
= GlobalData
.getCommandSetting(key
, fpdModuleId
);
538 getProject().setProperty(cmd
[m
] + "_SPATH", spath
.replaceAll("(\\\\)", "/"));
540 getProject().setProperty(cmd
[m
] + "_SPATH", "");
546 key
[4] = ToolDefinitions
.TOOLS_DEF_ATTRIBUTE_DPATH
;
547 String dpath
= GlobalData
.getCommandSetting(key
, fpdModuleId
);
549 getProject().setProperty(cmd
[m
] + "_DPATH", dpath
.replaceAll("(\\\\)", "/"));
551 getProject().setProperty(cmd
[m
] + "_DPATH", "");
557 key
[4] = ToolDefinitions
.TOOLS_DEF_ATTRIBUTE_LIBPATH
;
558 String libpath
= GlobalData
.getCommandSetting(key
, fpdModuleId
);
559 if (libpath
!= null) {
560 getProject().setProperty(cmd
[m
] + "_LIBPATH", libpath
.replaceAll("(\\\\)", "/"));
562 getProject().setProperty(cmd
[m
] + "_LIBPATH", "");
566 // Set CC_INCLUDEPATH
568 key
[4] = ToolDefinitions
.TOOLS_DEF_ATTRIBUTE_INCLUDEPATH
;
569 String includepath
= GlobalData
.getCommandSetting(key
, fpdModuleId
);
571 getProject().setProperty(cmd
[m
] + "_INCLUDEPATH", includepath
.replaceAll("(\\\\)", "/"));
573 getProject().setProperty(cmd
[m
] + "_INCLUDEPATH", "");
578 public void setMsaFile(File msaFile
) {
579 this.msaFile
= msaFile
;
583 Method is for ANT to initialize MSA file.
585 @param msaFilename MSA file name
587 public void setMsaFile(String msaFilename
) {
588 String moduleDir
= getProject().getProperty("MODULE_DIR");
591 // If is Single Module Build, then use the Base Dir defined in build.xml
593 if (moduleDir
== null) {
594 moduleDir
= getProject().getBaseDir().getPath();
596 msaFile
= new File(moduleDir
+ File
.separatorChar
+ msaFilename
);
599 public void addConfiguredModuleItem(ModuleItem moduleItem
) {
600 PackageIdentification packageId
= new PackageIdentification(moduleItem
.getPackageGuid(), moduleItem
.getPackageVersion());
601 ModuleIdentification moduleId
= new ModuleIdentification(moduleItem
.getModuleGuid(), moduleItem
.getModuleVersion());
602 moduleId
.setPackage(packageId
);
603 this.moduleId
= moduleId
;
611 public void addProperty(Property p
) {
612 properties
.addElement(p
);
615 public void setType(String type
) {
619 private void applyBuild(String buildTarget
, String buildTagname
, FpdModuleIdentification fpdModuleId
) throws EdkException
{
621 // Call AutoGen to generate AutoGen.c and AutoGen.h
623 AutoGen autogen
= new AutoGen(getProject().getProperty("FV_DIR"), getProject().getProperty("DEST_DIR_DEBUG"), fpdModuleId
.getModule(),fpdModuleId
.getArch(), saq
, parentId
);
624 autogen
.genAutogen();
627 // Get compiler flags
630 getCompilerFlags(buildTarget
, buildTagname
, fpdModuleId
);
632 catch (EdkException ee
) {
633 throw new BuildException(ee
.getMessage());
639 ModuleIdentification
[] libinstances
= saq
.getLibraryInstance(fpdModuleId
.getArch());
640 String propertyLibs
= "";
641 for (int i
= 0; i
< libinstances
.length
; i
++) {
642 propertyLibs
+= getProject().getProperty("BIN_DIR") + File
.separatorChar
+ libinstances
[i
].getName() + ".lib" + " ";
644 getProject().setProperty("LIBS", propertyLibs
.replaceAll("(\\\\)", "/"));
647 // Get all includepath and set to INCLUDE_PATHS
649 String
[] includes
= prepareIncludePaths(fpdModuleId
);
652 // if it is CUSTOM_BUILD
653 // then call the exist BaseName_build.xml directly.
655 String buildFilename
= "";
656 if ((buildFilename
= GetCustomizedBuildFile(fpdModuleId
.getArch())) != "") {
657 EdkLog
.log(this, "Call user-defined " + buildFilename
);
659 String antFilename
= getProject().getProperty("MODULE_DIR") + File
.separatorChar
+ buildFilename
;
660 antCall(antFilename
, null);
666 // Generate ${BASE_NAME}_build.xml
669 String ffsKeyword
= saq
.getModuleFfsKeyword();
670 ModuleBuildFileGenerator fileGenerator
= new ModuleBuildFileGenerator(getProject(), ffsKeyword
, fpdModuleId
, includes
, saq
);
671 buildFilename
= getProject().getProperty("DEST_DIR_OUTPUT") + File
.separatorChar
+ moduleId
.getName() + "_build.xml";
672 fileGenerator
.genBuildFile(buildFilename
);
675 // Ant call ${BASE_NAME}_build.xml
677 String antFilename
= getProject().getProperty("DEST_DIR_OUTPUT") + File
.separatorChar
+ moduleId
.getName() + "_build.xml";
678 antCall(antFilename
, null);
681 private void applyNonBuildTarget(FpdModuleIdentification fpdModuleId
){
683 // if it is CUSTOM_BUILD
684 // then call the exist BaseName_build.xml directly.
686 if (moduleId
.getModuleType().equalsIgnoreCase("USER_DEFINED")) {
687 EdkLog
.log(this, "Calling user-defined " + moduleId
.getName() + "_build.xml");
689 String antFilename
= getProject().getProperty("MODULE_DIR") + File
.separatorChar
+ moduleId
.getName() + "_build.xml";
690 antCall(antFilename
, this.type
);
695 String antFilename
= getProject().getProperty("DEST_DIR_OUTPUT") + File
.separatorChar
+ moduleId
.getName() + "_build.xml";
696 antCall(antFilename
, this.type
);
699 private void applyClean(FpdModuleIdentification fpdModuleId
){
701 // if it is CUSTOM_BUILD
702 // then call the exist BaseName_build.xml directly.
704 if (moduleId
.getModuleType().equalsIgnoreCase("USER_DEFINED")) {
705 EdkLog
.log(this, "Calling user-defined " + moduleId
.getName() + "_build.xml");
707 String antFilename
= getProject().getProperty("MODULE_DIR") + File
.separatorChar
+ moduleId
.getName() + "_build.xml";
708 antCall(antFilename
, "clean");
713 String antFilename
= getProject().getProperty("DEST_DIR_OUTPUT") + File
.separatorChar
+ moduleId
.getName() + "_build.xml";
714 antCall(antFilename
, "clean");
717 private void applyCleanall(FpdModuleIdentification fpdModuleId
){
719 // if it is CUSTOM_BUILD
720 // then call the exist BaseName_build.xml directly.
722 if (moduleId
.getModuleType().equalsIgnoreCase("USER_DEFINED")) {
723 EdkLog
.log(this, "Calling user-defined " + moduleId
.getName() + "_build.xml");
725 String antFilename
= getProject().getProperty("MODULE_DIR") + File
.separatorChar
+ moduleId
.getName() + "_build.xml";
726 antCall(antFilename
, "cleanall");
731 String antFilename
= getProject().getProperty("DEST_DIR_OUTPUT") + File
.separatorChar
+ moduleId
.getName() + "_build.xml";
732 antCall(antFilename
, "cleanall");
735 private void antCall(String antFilename
, String target
) {
737 ant
.setProject(getProject());
738 ant
.setAntfile(antFilename
);
739 if (target
!= null) {
740 ant
.setTarget(target
);
742 ant
.setInheritAll(true);
747 public void setSingleModuleBuild(boolean isSingleModuleBuild
) {
748 this.isSingleModuleBuild
= isSingleModuleBuild
;
751 private String
[] prepareIncludePaths(FpdModuleIdentification fpdModuleId
) throws EdkException
{
753 // Prepare the includes: PackageDependencies and Output debug direactory
755 Set
<String
> includes
= new LinkedHashSet
<String
>();
756 String arch
= fpdModuleId
.getArch();
761 includes
.add("${WORKSPACE_DIR}" + File
.separatorChar
);
766 includes
.add("${MODULE_DIR}");
767 includes
.add("${MODULE_DIR}" + File
.separatorChar
+ archDir(arch
));
770 // Packages in PackageDenpendencies
772 PackageIdentification
[] packageDependencies
= saq
.getDependencePkg(fpdModuleId
.getArch());
773 for (int i
= 0; i
< packageDependencies
.length
; i
++) {
774 GlobalData
.refreshPackageIdentification(packageDependencies
[i
]);
775 File packageFile
= packageDependencies
[i
].getSpdFile();
776 includes
.add(packageFile
.getParent() + File
.separatorChar
+ "Include");
777 includes
.add(packageFile
.getParent() + File
.separatorChar
+ "Include" + File
.separatorChar
+ archDir(arch
));
781 // All Dependency Library Instance's PackageDependencies
783 ModuleIdentification
[] libinstances
= saq
.getLibraryInstance(fpdModuleId
.getArch());
784 for (int i
= 0; i
< libinstances
.length
; i
++) {
785 saq
.push(GlobalData
.getDoc(libinstances
[i
], fpdModuleId
.getArch()));
786 PackageIdentification
[] libraryPackageDependencies
= saq
.getDependencePkg(fpdModuleId
.getArch());
787 for (int j
= 0; j
< libraryPackageDependencies
.length
; j
++) {
788 GlobalData
.refreshPackageIdentification(libraryPackageDependencies
[j
]);
789 File packageFile
= libraryPackageDependencies
[j
].getSpdFile();
790 includes
.add(packageFile
.getParent() + File
.separatorChar
+ "Include");
791 includes
.add(packageFile
.getParent() + File
.separatorChar
+ "Include" + File
.separatorChar
+ archDir(arch
));
798 // The package which the module belongs to
800 includes
.add(fpdModuleId
.getModule().getPackage().getPackageDir() + File
.separatorChar
+ "Include");
801 includes
.add(fpdModuleId
.getModule().getPackage().getPackageDir() + File
.separatorChar
+ "Include" + File
.separatorChar
+ archDir(arch
));
804 // Debug files output directory
806 includes
.add("${DEST_DIR_DEBUG}");
809 // set to INCLUDE_PATHS property
811 Iterator
<String
> iter
= includes
.iterator();
812 StringBuffer includePaths
= new StringBuffer();
813 while (iter
.hasNext()) {
814 includePaths
.append(iter
.next());
815 includePaths
.append("; ");
817 getProject().setProperty("INCLUDE_PATHS", getProject().replaceProperties(includePaths
.toString()).replaceAll("(\\\\)", "/"));
819 return includes
.toArray(new String
[includes
.size()]);
823 Return the name of the directory that corresponds to the architecture.
824 This is a translation from the XML Schema tag to a directory that
825 corresponds to our directory name coding convention.
828 private String
archDir(String arch
) {
829 return arch
.replaceFirst("X64", "x64")
830 .replaceFirst("IPF", "Ipf")
831 .replaceFirst("IA32", "Ia32")
832 .replaceFirst("ARM", "Arm")
833 .replaceFirst("EBC", "Ebc");
837 public void setExternalProperties(Vector
<Property
> v
) {
841 private String
GetCustomizedBuildFile(String arch
) {
842 String
[][] files
= saq
.getSourceFiles(arch
);
843 for (int i
= 0; i
< files
.length
; ++i
) {
844 if (files
[i
][1].endsWith("build.xml")) {