/** @file\r
- This file is ANT task GenBuild. \r
- \r
- The file is used to parse a specified Module, and generate its build time \r
+ This file is ANT task GenBuild.\r
+\r
+ The file is used to parse a specified Module, and generate its build time\r
ANT script build.xml, then call the the ANT script to build the module.\r
- \r
+\r
Copyright (c) 2006, Intel Corporation\r
All rights reserved. This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
import org.apache.tools.ant.taskdefs.Property;\r
import org.apache.xmlbeans.XmlObject;\r
\r
+import org.tianocore.common.exception.EdkException;\r
+import org.tianocore.common.logger.EdkLog;\r
import org.tianocore.build.autogen.AutoGen;\r
import org.tianocore.build.fpd.FpdParserTask;\r
import org.tianocore.build.global.GenBuildLogger;\r
import org.tianocore.build.id.PackageIdentification;\r
import org.tianocore.build.id.PlatformIdentification;\r
import org.tianocore.build.tools.ModuleItem;\r
-import org.tianocore.exception.EdkException;\r
-import org.tianocore.logger.EdkLog;\r
\r
/**\r
<p>\r
system. The main function of this task is to parse module's surface area,\r
then generate the corresponding <em>BaseName_build.xml</em> (the real ANT\r
build script) and call this to build the module. The whole process including:\r
- 1. generate AutoGen.c and AutoGen.h; 2. build all dependent library instances; \r
+ 1. generate AutoGen.c and AutoGen.h; 2. build all dependent library instances;\r
3. build all source files inlcude AutoGen.c; 4. generate sections;\r
- 5. generate FFS file if it is driver module while LIB file if it is Library module. \r
+ 5. generate FFS file if it is driver module while LIB file if it is Library module.\r
</p>\r
- \r
+\r
<p>\r
The usage is (take module <em>HelloWorld</em> for example):\r
</p>\r
- \r
+\r
<pre>\r
- <GenBuild \r
- msaFilename="HelloWorld.msa"/> \r
+ <GenBuild\r
+ msaFilename="HelloWorld.msa"/>\r
processTo="ALL"/>\r
</pre>\r
- \r
- <p><code>processTo</code> provides a way to customize the whole build process. \r
- processTo can be one value of ALL, AUTOGEN, FILES, LIBRARYINSTANCES, SECTIONS, NONE. \r
- Default is ALL, means whole \r
+\r
+ <p><code>processTo</code> provides a way to customize the whole build process.\r
+ processTo can be one value of ALL, AUTOGEN, FILES, LIBRARYINSTANCES, SECTIONS, NONE.\r
+ Default is ALL, means whole\r
</p>\r
- \r
+\r
<p>\r
This task calls <code>AutoGen</code> to generate <em>AutoGen.c</em> and\r
<em>AutoGen.h</em>. The task also parses the development environment\r
configuration files, such as collecting package information, setting compiler\r
flags and so on.\r
</p>\r
- \r
- \r
+\r
+\r
@since GenBuild 1.0\r
**/\r
public class GenBuildTask extends Ant {\r
- \r
+\r
///\r
/// Module surface area file.\r
///\r
File msaFile;\r
\r
///\r
- /// \r
+ ///\r
///\r
private String type = "all"; // = "build";\r
- \r
+\r
///\r
/// Module's Identification.\r
///\r
private Vector<Property> properties = new Vector<Property>();\r
\r
private static Stack<Hashtable> backupPropertiesStack = new Stack<Hashtable>();\r
- \r
+\r
private boolean isSingleModuleBuild = false;\r
- \r
+\r
/**\r
Public construct method. It is necessary for ANT task.\r
**/\r
}\r
\r
/**\r
- \r
+\r
@throws BuildException\r
From module build, exception from module surface area invalid.\r
**/\r
Property item = iter.next();\r
getProject().setProperty(item.getName(), item.getValue());\r
}\r
- \r
+\r
//\r
// GenBuild should specify either msaFile or moduleGuid & packageGuid\r
//\r
else {\r
moduleId.setLibrary(true);\r
}\r
- \r
+\r
//\r
// Judge whether it is single module build or not\r
//\r
PlatformIdentification platformId = GlobalData.getPlatform(filename);\r
getProject().setProperty("PLATFORM_DIR", platformId.getFpdFile().getParent().replaceAll("(\\\\)", "/"));\r
getProject().setProperty("PLATFORM_RELATIVE_DIR", platformId.getPlatformRelativeDir().replaceAll("(\\\\)", "/"));\r
- \r
+\r
String packageGuid = getProject().getProperty("PACKAGE_GUID");\r
String packageVersion = getProject().getProperty("PACKAGE_VERSION");\r
PackageIdentification packageId = new PackageIdentification(packageGuid, packageVersion);\r
moduleId.setPackage(packageId);\r
}\r
- \r
+\r
//\r
// If single module : intersection MSA supported ARCHs and tools def!!\r
// else, get arch from pass down\r
//\r
- Set<String> archListSupByToolChain = new LinkedHashSet<String>(); \r
- String[] archs = GlobalData.getToolChainInfo().getArchs(); \r
- \r
+ Set<String> archListSupByToolChain = new LinkedHashSet<String>();\r
+ String[] archs = GlobalData.getToolChainInfo().getArchs();\r
+\r
for (int i = 0; i < archs.length; i ++) {\r
archListSupByToolChain.add(archs[i]);\r
}\r
- \r
+\r
Set<String> archSet = new LinkedHashSet<String>();\r
- \r
+\r
if ( getProject().getProperty("ARCH") != null) {\r
String[] fpdArchList = getProject().getProperty("ARCH").split(" ");\r
- \r
+\r
for (int i = 0; i < fpdArchList.length; i++) {\r
if (archListSupByToolChain.contains(fpdArchList[i])) {\r
archSet.add(fpdArchList[i]);\r
}\r
}\r
else {\r
- archSet = archListSupByToolChain; \r
+ archSet = archListSupByToolChain;\r
}\r
- \r
+\r
String[] archList = archSet.toArray(new String[archSet.size()]);\r
- \r
+\r
//\r
// Judge if arch is all supported by current module. If not, throw Exception.\r
//\r
}\r
}\r
}\r
- \r
+\r
for (int k = 0; k < archList.length; k++) {\r
- \r
+\r
getProject().setProperty("ARCH", archList[k]);\r
- \r
+\r
FpdModuleIdentification fpdModuleId = new FpdModuleIdentification(moduleId, archList[k]);\r
- \r
+\r
//\r
// Whether the module is built before\r
//\r
} else {\r
GlobalData.registerBuiltModule(fpdModuleId);\r
}\r
- \r
+\r
//\r
// For Every TOOLCHAIN, TARGET\r
//\r
//\r
// check if any tool is defined for current target + toolchain + arch\r
// don't do anything if no tools found\r
- // \r
+ //\r
if (GlobalData.isCommandSet(targetList[i], toolchainList[j], archList[k]) == false) {\r
System.out.println("Warning: No build issued. No tools were found for [target=" + targetList[i] + " toolchain=" + toolchainList[j] + " arch=" + archList[k] + "]\n");\r
continue;\r
System.out.println("Build " + moduleId + " start >>>");\r
System.out.println("Target: " + targetList[i] + " Tagname: " + toolchainList[j] + " Arch: " + archList[k]);\r
SurfaceAreaQuery.setDoc(GlobalData.getDoc(fpdModuleId));\r
- \r
+\r
//\r
// Prepare for all other common properties\r
// PACKAGE, PACKAGE_GUID, PACKAGE_VERSION, PACKAGE_DIR, PACKAGE_RELATIVE_DIR\r
// SUBSYSTEM, ENTRYPOINT, EBC_TOOL_LIB_PATH\r
//\r
setModuleCommonProperties(archList[k]);\r
- \r
+\r
//\r
- // OutputManage prepare for \r
+ // OutputManage prepare for\r
// BIN_DIR, DEST_DIR_DEBUG, DEST_DIR_OUTPUT, BUILD_DIR, FV_DIR\r
//\r
OutputManager.getInstance().update(getProject());\r
- \r
+\r
if (type.equalsIgnoreCase("all") || type.equalsIgnoreCase("build")) {\r
applyBuild(targetList[i], toolchainList[j], fpdModuleId);\r
}\r
}\r
\r
/**\r
- This method is used to prepare Platform-related information. \r
- \r
+ This method is used to prepare Platform-related information.\r
+\r
<p>In Single Module Build mode, platform-related information is not ready.\r
- The method read the system environment variable <code>ACTIVE_PLATFORM</code> \r
+ The method read the system environment variable <code>ACTIVE_PLATFORM</code>\r
and search in the Framework Database. Note that platform name in the Framework\r
Database must be unique. </p>\r
- \r
+\r
**/\r
private void prepareSingleModuleBuild(){\r
//\r
// TBD: Enhance it!!!!\r
//\r
PackageIdentification packageId = GlobalData.getPackageForModule(moduleId);\r
- \r
+\r
moduleId.setPackage(packageId);\r
- \r
+\r
//\r
// Read ACTIVE_PLATFORM's FPD file (Call FpdParserTask's method)\r
//\r
String filename = getProject().getProperty("PLATFORM_FILE");\r
- \r
+\r
if (filename == null){\r
throw new BuildException("Please set ACTIVE_PLATFORM in the file: Tools/Conf/target.txt if you want to build a single module!");\r
}\r
- \r
+\r
PlatformIdentification platformId = GlobalData.getPlatform(filename);\r
- \r
+\r
//\r
// Read FPD file\r
//\r
FpdParserTask fpdParser = new FpdParserTask();\r
fpdParser.setProject(getProject());\r
fpdParser.parseFpdFile(platformId.getFpdFile());\r
- \r
+\r
//\r
// Prepare for Platform related common properties\r
// PLATFORM, PLATFORM_DIR, PLATFORM_RELATIVE_DIR\r
getProject().setProperty("PACKAGE_VERSION", packageId.getVersion());\r
getProject().setProperty("PACKAGE_DIR", packageId.getPackageDir().replaceAll("(\\\\)", "/"));\r
getProject().setProperty("PACKAGE_RELATIVE_DIR", packageId.getPackageRelativeDir().replaceAll("(\\\\)", "/"));\r
- \r
+\r
//\r
// MODULE or BASE_NAME, GUID or FILE_GUID, VERSION, MODULE_TYPE\r
// MODULE_DIR, MODULE_RELATIVE_DIR\r
getProject().setProperty("MODULE_TYPE", moduleId.getModuleType());\r
getProject().setProperty("MODULE_DIR", moduleId.getMsaFile().getParent().replaceAll("(\\\\)", "/"));\r
getProject().setProperty("MODULE_RELATIVE_DIR", moduleId.getModuleRelativePath().replaceAll("(\\\\)", "/"));\r
- \r
+\r
//\r
// SUBSYSTEM\r
//\r
String[][] subsystemMap = { { "BASE", "EFI_BOOT_SERVICE_DRIVER"},\r
- { "SEC", "EFI_BOOT_SERVICE_DRIVER" }, \r
- { "PEI_CORE", "EFI_BOOT_SERVICE_DRIVER" }, \r
- { "PEIM", "EFI_BOOT_SERVICE_DRIVER" }, \r
+ { "SEC", "EFI_BOOT_SERVICE_DRIVER" },\r
+ { "PEI_CORE", "EFI_BOOT_SERVICE_DRIVER" },\r
+ { "PEIM", "EFI_BOOT_SERVICE_DRIVER" },\r
{ "DXE_CORE", "EFI_BOOT_SERVICE_DRIVER" },\r
- { "DXE_DRIVER", "EFI_BOOT_SERVICE_DRIVER" }, \r
- { "DXE_RUNTIME_DRIVER", "EFI_RUNTIME_DRIVER" }, \r
- { "DXE_SAL_DRIVER", "EFI_BOOT_SERVICE_DRIVER" }, \r
- { "DXE_SMM_DRIVER", "EFI_BOOT_SERVICE_DRIVER" }, \r
- { "TOOL", "EFI_BOOT_SERVICE_DRIVER" }, \r
+ { "DXE_DRIVER", "EFI_BOOT_SERVICE_DRIVER" },\r
+ { "DXE_RUNTIME_DRIVER", "EFI_RUNTIME_DRIVER" },\r
+ { "DXE_SAL_DRIVER", "EFI_BOOT_SERVICE_DRIVER" },\r
+ { "DXE_SMM_DRIVER", "EFI_BOOT_SERVICE_DRIVER" },\r
+ { "TOOL", "EFI_BOOT_SERVICE_DRIVER" },\r
{ "UEFI_DRIVER", "EFI_BOOT_SERVICE_DRIVER" },\r
- { "UEFI_APPLICATION", "EFI_APPLICATION" }, \r
- { "USER_DEFINED", "EFI_BOOT_SERVICE_DRIVER"} }; \r
- \r
+ { "UEFI_APPLICATION", "EFI_APPLICATION" },\r
+ { "USER_DEFINED", "EFI_BOOT_SERVICE_DRIVER"} };\r
+\r
String subsystem = "EFI_BOOT_SERVICE_DRIVER";\r
for (int i = 0; i < subsystemMap.length; i++) {\r
if (moduleId.getModuleType().equalsIgnoreCase(subsystemMap[i][0])) {\r
}\r
}\r
getProject().setProperty("SUBSYSTEM", subsystem);\r
- \r
+\r
//\r
// ENTRYPOINT\r
//\r
else {\r
getProject().setProperty("ENTRYPOINT", "_ModuleEntryPoint");\r
}\r
- \r
+\r
getProject().setProperty("OBJECTS", "");\r
}\r
\r
String cmdName = GlobalData.getCommandSetting(key, fpdModuleId);\r
File cmdFile = new File(cmdPath + File.separatorChar + cmdName);\r
getProject().setProperty(cmd[m], cmdFile.getPath().replaceAll("(\\\\)", "/"));\r
- \r
+\r
//\r
// set CC_FLAGS\r
//\r
Set<String> subset = new LinkedHashSet<String>();\r
putFlagsToSet(addset, cmdFlags);\r
getProject().setProperty(cmd[m] + "_FLAGS", getProject().replaceProperties(getFlags(addset, subset)));\r
- \r
+\r
//\r
// Set CC_EXT\r
//\r
else {\r
getProject().setProperty(cmd[m] + "_EXT", "");\r
}\r
- \r
+\r
//\r
// set CC_FAMILY\r
//\r
if (toolChainFamily != null) {\r
getProject().setProperty(cmd[m] + "_FAMILY", toolChainFamily);\r
}\r
- \r
+\r
//\r
// set CC_SPATH\r
//\r
else {\r
getProject().setProperty(cmd[m] + "_SPATH", "");\r
}\r
- \r
+\r
//\r
// set CC_DPATH\r
//\r
}\r
}\r
}\r
- \r
+\r
public void setMsaFile(File msaFile) {\r
this.msaFile = msaFile;\r
}\r
\r
/**\r
- Method is for ANT to initialize MSA file. \r
- \r
+ Method is for ANT to initialize MSA file.\r
+\r
@param msaFilename MSA file name\r
**/\r
public void setMsaFile(String msaFilename) {\r
String moduleDir = getProject().getProperty("MODULE_DIR");\r
- \r
+\r
//\r
// If is Single Module Build, then use the Base Dir defined in build.xml\r
//\r
}\r
msaFile = new File(moduleDir + File.separatorChar + msaFilename);\r
}\r
- \r
+\r
public void addConfiguredModuleItem(ModuleItem moduleItem) {\r
PackageIdentification packageId = new PackageIdentification(moduleItem.getPackageGuid(), moduleItem.getPackageVersion());\r
ModuleIdentification moduleId = new ModuleIdentification(moduleItem.getModuleGuid(), moduleItem.getModuleVersion());\r
moduleId.setPackage(packageId);\r
this.moduleId = moduleId;\r
}\r
- \r
+\r
/**\r
- Add a property. \r
- \r
+ Add a property.\r
+\r
@param p property\r
**/\r
public void addProperty(Property p) {\r
public void setType(String type) {\r
this.type = type;\r
}\r
- \r
+\r
private void applyBuild(String buildTarget, String buildTagname, FpdModuleIdentification fpdModuleId) throws EdkException{\r
//\r
// AutoGen\r
//\r
- \r
+\r
AutoGen autogen = new AutoGen(getProject().getProperty("FV_DIR"), getProject().getProperty("DEST_DIR_DEBUG"), fpdModuleId.getModule(),fpdModuleId.getArch());\r
autogen.genAutogen();\r
- \r
- \r
+\r
+\r
//\r
// Get compiler flags\r
//\r
getCompilerFlags(buildTarget, buildTagname, fpdModuleId);\r
- \r
+\r
//\r
// Prepare LIBS\r
//\r
propertyLibs += " " + getProject().getProperty("BIN_DIR") + File.separatorChar + libinstances[i].getName() + ".lib";\r
}\r
getProject().setProperty("LIBS", propertyLibs.replaceAll("(\\\\)", "/"));\r
- \r
+\r
//\r
// if it is CUSTOM_BUILD\r
// then call the exist BaseName_build.xml directly.\r
ant.execute();\r
return ;\r
}\r
- \r
+\r
//\r
// Generate ${BASE_NAME}_build.xml\r
// TBD\r
ModuleBuildFileGenerator fileGenerator = new ModuleBuildFileGenerator(getProject(), ffsKeyword, fpdModuleId);\r
String buildFilename = getProject().getProperty("DEST_DIR_OUTPUT") + File.separatorChar + moduleId.getName() + "_build.xml";\r
fileGenerator.genBuildFile(buildFilename);\r
- \r
+\r
//\r
// Ant call ${BASE_NAME}_build.xml\r
//\r
ant.init();\r
ant.execute();\r
}\r
- \r
+\r
private void applyClean(FpdModuleIdentification fpdModuleId){\r
//\r
// if it is CUSTOM_BUILD\r
ant.execute();\r
return ;\r
}\r
- \r
+\r
Ant ant = new Ant();\r
ant.setProject(getProject());\r
ant.setAntfile(getProject().getProperty("DEST_DIR_OUTPUT") + File.separatorChar + moduleId.getName() + "_build.xml");\r
ant.setInheritAll(true);\r
ant.init();\r
ant.execute();\r
- \r
+\r
//\r
// Delete current module's DEST_DIR_OUTPUT\r
// TBD\r
}\r
- \r
+\r
private void applyCleanall(FpdModuleIdentification fpdModuleId){\r
//\r
// if it is CUSTOM_BUILD\r
ant.execute();\r
return ;\r
}\r
- \r
+\r
Ant ant = new Ant();\r
ant.setProject(getProject());\r
ant.setAntfile(getProject().getProperty("DEST_DIR_OUTPUT") + File.separatorChar + moduleId.getName() + "_build.xml");\r
ant.setInheritAll(true);\r
ant.init();\r
ant.execute();\r
- \r
+\r
//\r
// Delete current module's DEST_DIR_OUTPUT\r
// TBD\r
\r
/**\r
Separate the string and instore in set.\r
- \r
- <p> String is separated by Java Regulation Expression \r
+\r
+ <p> String is separated by Java Regulation Expression\r
"[^\\\\]?(\".*?[^\\\\]\")[ \t,]+". </p>\r
- \r
+\r
<p>For example: </p>\r
- \r
+\r
<pre>\r
"/nologo", "/W3", "/WX"\r
"/C", "/DSTRING_DEFINES_FILE=\"BdsStrDefs.h\""\r
</pre>\r
- \r
+\r
@param set store the separated string\r
@param str string to separate\r
**/\r
set.add(item);\r
}\r
}\r
- \r
+\r
/**\r
- Generate the final flags string will be used by compile command. \r
- \r
+ Generate the final flags string will be used by compile command.\r
+\r
@param add the add flags set\r
@param sub the sub flags set\r
@return final flags after add set substract sub set\r
private void pushProperties() {\r
backupPropertiesStack.push(getProject().getProperties());\r
}\r
- \r
+\r
private void popProperties() {\r
Hashtable backupProperties = backupPropertiesStack.pop();\r
Set keys = backupProperties.keySet();\r