import java.util.List;\r
import java.util.Map;\r
import java.util.Set;\r
-import java.util.Stack;\r
import java.util.Vector;\r
import java.util.regex.Matcher;\r
import java.util.regex.Pattern;\r
\r
import org.apache.tools.ant.BuildException;\r
+import org.apache.tools.ant.BuildListener;\r
+import org.apache.tools.ant.Project;\r
import org.apache.tools.ant.taskdefs.Ant;\r
import org.apache.tools.ant.taskdefs.Property;\r
import org.apache.xmlbeans.XmlObject;\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.global.GlobalData;\r
import org.tianocore.build.global.OutputManager;\r
import org.tianocore.build.global.SurfaceAreaQuery;\r
<p>The main function of this task is to parse module's surface area (MSA),\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
+ \r
<pre>\r
1. generate AutoGen.c and AutoGen.h; \r
2. build all dependent library instances;\r
</p>\r
\r
<pre>\r
- <GenBuild\r
- msaFilename="HelloWorld.msa"/>\r
- processTo="ALL"/>\r
+ <GenBuild \r
+ msaFile="${PACKAGE_DIR}/Application/HelloWorld/HelloWorld.msa"\r
+ type="cleanall" />\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
- </p>\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
+ <em>AutoGen.h</em>. \r
</p>\r
\r
-\r
+ <p>\r
+ This task will also set properties for current module, such as PACKAGE, \r
+ PACKAGE_GUID, PACKAGE_VERSION, PACKAGE_DIR, PACKAGE_RELATIVE_DIR \r
+ (relative to Workspace), MODULE or BASE_NAME, GUID, VERSION, MODULE_DIR, \r
+ MODULE_RELATIVE_DIR (relative to Package), CONFIG_DIR, BIN_DIR, \r
+ DEST_DIR_DEBUG, DEST_DIR_OUTPUT, TARGET, ARCH, TOOLCHAIN, TOOLCHAIN_FAMILY, \r
+ SUBSYSTEM, ENTRYPOINT, EBC_TOOL_LIB_PATH, all compiler command related \r
+ properties (CC, CC_FLAGS, CC_DPATH, CC_SPATH, CC_FAMILY, CC_EXT). \r
+ </p>\r
+ \r
@since GenBuild 1.0\r
**/\r
public class GenBuildTask extends Ant {\r
/// Module surface area file.\r
///\r
File msaFile;\r
-\r
+ \r
+ public ModuleIdentification parentId;\r
+ \r
private String type = "all"; \r
\r
///\r
\r
private Vector<Property> properties = new Vector<Property>();\r
\r
- private static Stack<Hashtable> backupPropertiesStack = new Stack<Hashtable>();\r
-\r
private boolean isSingleModuleBuild = false;\r
+ \r
+ private SurfaceAreaQuery saq = null;\r
\r
/**\r
Public construct method. It is necessary for ANT task.\r
From module build, exception from module surface area invalid.\r
**/\r
public void execute() throws BuildException {\r
- //\r
- // set Logger\r
- //\r
- GenBuildLogger logger = new GenBuildLogger(getProject());\r
- EdkLog.setLogLevel(getProject().getProperty("env.LOGLEVEL"));\r
- EdkLog.setLogger(logger);\r
+ if (!FrameworkBuildTask.multithread) {\r
+ cleanupProperties();\r
+ }\r
\r
- pushProperties();\r
//\r
// Enable all specified properties\r
//\r
moduleId = new ModuleIdentification(moduleGuid, moduleVersion);\r
moduleId.setPackage(packageId);\r
Map<String, XmlObject> doc = GlobalData.getNativeMsa(moduleId);\r
- SurfaceAreaQuery.setDoc(doc);\r
- moduleId = SurfaceAreaQuery.getMsaHeader();\r
+ saq = new SurfaceAreaQuery(doc);\r
+ moduleId = saq.getMsaHeader();\r
} else {\r
Map<String, XmlObject> doc = GlobalData.getNativeMsa(msaFile);\r
- SurfaceAreaQuery.setDoc(doc);\r
- moduleId = SurfaceAreaQuery.getMsaHeader();\r
+ saq = new SurfaceAreaQuery(doc);\r
+ moduleId = saq.getMsaHeader();\r
}\r
- String[] producedLibraryClasses = SurfaceAreaQuery.getLibraryClasses("ALWAYS_PRODUCED",null);\r
+ String[] producedLibraryClasses = saq.getLibraryClasses("ALWAYS_PRODUCED",null);\r
if (producedLibraryClasses.length == 0) {\r
moduleId.setLibrary(false);\r
} else {\r
//\r
prepareSingleModuleBuild();\r
} else {\r
- //\r
- // Platform build. Restore the platform related info\r
- //\r
- String filename = getProject().getProperty("PLATFORM_FILE");\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
String packageGuid = getProject().getProperty("PACKAGE_GUID");\r
String packageVersion = getProject().getProperty("PACKAGE_VERSION");\r
PackageIdentification packageId = new PackageIdentification(packageGuid, packageVersion);\r
//\r
// Judge if arch is all supported by current module. If not, throw Exception.\r
//\r
- List moduleSupportedArchs = SurfaceAreaQuery.getModuleSupportedArchs();\r
+ List moduleSupportedArchs = saq.getModuleSupportedArchs();\r
if (moduleSupportedArchs != null) {\r
for (int k = 0; k < archList.length; k++) {\r
if ( ! moduleSupportedArchs.contains(archList[k])) {\r
// Whether the module is built before\r
//\r
if (moduleId.isLibrary() == false && GlobalData.hasFpdModuleSA(fpdModuleId) == false) {\r
- System.out.println("\nWARNING: " + moduleId + " for " + archList[k] + " was not found in current platform FPD file!\n");\r
+ EdkLog.log(this, EdkLog.EDK_WARNING, "Warning: " + moduleId + " for " + archList[k] + " was not found in current platform FPD file!\n");\r
continue;\r
} else if (GlobalData.isModuleBuilt(fpdModuleId)) {\r
- return;\r
+ break;\r
} else {\r
GlobalData.registerBuiltModule(fpdModuleId);\r
}\r
// don't do anything if no tools found\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
+ EdkLog.log(this, EdkLog.EDK_WARNING, "Warning: No build issued. No tools were found for [target=" + targetList[i] + " toolchain=" + toolchainList[j] + " arch=" + archList[k] + "]\n");\r
continue;\r
}\r
\r
//\r
getProject().setProperty("TOOLCHAIN", toolchainList[j]);\r
\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
+ EdkLog.log(this, "Build " + moduleId + " start >>>");\r
+ EdkLog.log(this, "Target: " + targetList[i] + " Tagname: " + toolchainList[j] + " Arch: " + archList[k]);\r
+ saq.push(GlobalData.getDoc(fpdModuleId));\r
\r
//\r
// Prepare for all other common properties\r
}\r
}\r
}\r
- \r
- popProperties();\r
}\r
\r
/**\r
FpdParserTask fpdParser = new FpdParserTask();\r
fpdParser.setProject(getProject());\r
fpdParser.parseFpdFile(platformId.getFpdFile());\r
-\r
- //\r
- // Prepare for Platform related common properties\r
- // PLATFORM, PLATFORM_DIR, PLATFORM_RELATIVE_DIR\r
- //\r
- getProject().setProperty("PLATFORM", platformId.getName());\r
- getProject().setProperty("PLATFORM_DIR", platformId.getFpdFile().getParent().replaceAll("(\\\\)", "/"));\r
- getProject().setProperty("PLATFORM_RELATIVE_DIR", platformId.getPlatformRelativeDir().replaceAll("(\\\\)", "/"));\r
+ getProject().setProperty("ARCH", fpdParser.getAllArchForModule(moduleId));\r
}\r
\r
+ private void cleanupProperties() {\r
+ Project newProject = new Project();\r
+\r
+ Hashtable<String, String> passdownProperties = FrameworkBuildTask.originalProperties;\r
+ Iterator<String> iter = passdownProperties.keySet().iterator();\r
+ while (iter.hasNext()) {\r
+ String item = iter.next();\r
+ newProject.setProperty(item, passdownProperties.get(item));\r
+ }\r
+\r
+ newProject.setInputHandler(getProject().getInputHandler());\r
+\r
+ Iterator listenerIter = getProject().getBuildListeners().iterator();\r
+ while (listenerIter.hasNext()) {\r
+ newProject.addBuildListener((BuildListener) listenerIter.next());\r
+ }\r
+\r
+ getProject().initSubProject(newProject);\r
+\r
+ setProject(newProject);\r
+ }\r
\r
/**\r
Set Module-Related information to properties.\r
// MODULE_DIR, MODULE_RELATIVE_DIR\r
//\r
getProject().setProperty("MODULE", moduleId.getName());\r
- String baseName = SurfaceAreaQuery.getModuleOutputFileBasename();\r
+ String baseName = saq.getModuleOutputFileBasename();\r
if (baseName == null) {\r
getProject().setProperty("BASE_NAME", moduleId.getName());\r
} else {\r
\r
private void applyBuild(String buildTarget, String buildTagname, FpdModuleIdentification fpdModuleId) throws BuildException{\r
//\r
- // AutoGen\r
+ // Call AutoGen to generate AutoGen.c and AutoGen.h\r
//\r
-\r
- AutoGen autogen = new AutoGen(getProject().getProperty("FV_DIR"), getProject().getProperty("DEST_DIR_DEBUG"), fpdModuleId.getModule(),fpdModuleId.getArch());\r
+ AutoGen autogen = new AutoGen(getProject().getProperty("FV_DIR"), getProject().getProperty("DEST_DIR_DEBUG"), fpdModuleId.getModule(),fpdModuleId.getArch(), saq);\r
autogen.genAutogen();\r
\r
-\r
//\r
// Get compiler flags\r
//\r
//\r
// Prepare LIBS\r
//\r
- ModuleIdentification[] libinstances = SurfaceAreaQuery.getLibraryInstance(fpdModuleId.getArch());\r
+ ModuleIdentification[] libinstances = saq.getLibraryInstance(fpdModuleId.getArch());\r
String propertyLibs = "";\r
for (int i = 0; i < libinstances.length; i++) {\r
propertyLibs += " " + getProject().getProperty("BIN_DIR") + File.separatorChar + libinstances[i].getName() + ".lib";\r
}\r
getProject().setProperty("LIBS", propertyLibs.replaceAll("(\\\\)", "/"));\r
\r
+ //\r
+ // Get all includepath and set to INCLUDE_PATHS\r
+ //\r
+ String[] includes = prepareIncludePaths(fpdModuleId);\r
+ \r
//\r
// if it is CUSTOM_BUILD\r
// then call the exist BaseName_build.xml directly.\r
//\r
if (moduleId.getModuleType().equalsIgnoreCase("USER_DEFINED")) {\r
- GlobalData.log.info("Call user-defined " + moduleId.getName() + "_build.xml");\r
+ EdkLog.log(this, "Call user-defined " + moduleId.getName() + "_build.xml");\r
\r
String antFilename = getProject().getProperty("MODULE_DIR") + File.separatorChar + moduleId.getName() + "_build.xml";\r
antCall(antFilename, null);\r
// Generate ${BASE_NAME}_build.xml\r
// TBD\r
//\r
- String ffsKeyword = SurfaceAreaQuery.getModuleFfsKeyword();\r
- ModuleBuildFileGenerator fileGenerator = new ModuleBuildFileGenerator(getProject(), ffsKeyword, fpdModuleId);\r
+ String ffsKeyword = saq.getModuleFfsKeyword();\r
+ ModuleBuildFileGenerator fileGenerator = new ModuleBuildFileGenerator(getProject(), ffsKeyword, fpdModuleId, includes, saq);\r
String buildFilename = getProject().getProperty("DEST_DIR_OUTPUT") + File.separatorChar + moduleId.getName() + "_build.xml";\r
fileGenerator.genBuildFile(buildFilename);\r
\r
// then call the exist BaseName_build.xml directly.\r
//\r
if (moduleId.getModuleType().equalsIgnoreCase("USER_DEFINED")) {\r
- GlobalData.log.info("Calling user-defined " + moduleId.getName() + "_build.xml");\r
+ EdkLog.log(this, "Calling user-defined " + moduleId.getName() + "_build.xml");\r
\r
String antFilename = getProject().getProperty("MODULE_DIR") + File.separatorChar + moduleId.getName() + "_build.xml";\r
antCall(antFilename, "clean");\r
// then call the exist BaseName_build.xml directly.\r
//\r
if (moduleId.getModuleType().equalsIgnoreCase("USER_DEFINED")) {\r
- GlobalData.log.info("Calling user-defined " + moduleId.getName() + "_build.xml");\r
+ EdkLog.log(this, "Calling user-defined " + moduleId.getName() + "_build.xml");\r
\r
String antFilename = getProject().getProperty("MODULE_DIR") + File.separatorChar + moduleId.getName() + "_build.xml";\r
antCall(antFilename, "cleanall");\r
return result;\r
}\r
\r
- private void pushProperties() {\r
- backupPropertiesStack.push(getProject().getProperties());\r
+ public void setSingleModuleBuild(boolean isSingleModuleBuild) {\r
+ this.isSingleModuleBuild = isSingleModuleBuild;\r
}\r
+ \r
+ private String[] prepareIncludePaths(FpdModuleIdentification fpdModuleId) {\r
+ //\r
+ // Prepare the includes: PackageDependencies and Output debug direactory\r
+ //\r
+ Set<String> includes = new LinkedHashSet<String>();\r
+ String arch = fpdModuleId.getArch();\r
+ \r
+ //\r
+ // WORKSPACE\r
+ //\r
+ includes.add("${WORKSPACE_DIR}" + File.separatorChar);\r
+ \r
+ //\r
+ // Module iteself\r
+ //\r
+ includes.add("${MODULE_DIR}");\r
+ includes.add("${MODULE_DIR}" + File.separatorChar + archDir(arch));\r
+ \r
+ //\r
+ // Packages in PackageDenpendencies\r
+ //\r
+ PackageIdentification[] packageDependencies = saq.getDependencePkg(fpdModuleId.getArch());\r
+ for (int i = 0; i < packageDependencies.length; i++) {\r
+ GlobalData.refreshPackageIdentification(packageDependencies[i]);\r
+ File packageFile = packageDependencies[i].getSpdFile();\r
+ includes.add(packageFile.getParent() + File.separatorChar + "Include");\r
+ includes.add(packageFile.getParent() + File.separatorChar + "Include" + File.separatorChar + archDir(arch));\r
+ }\r
\r
- private void popProperties() {\r
- Hashtable backupProperties = backupPropertiesStack.pop();\r
- Set keys = backupProperties.keySet();\r
- Iterator iter = keys.iterator();\r
- while (iter.hasNext()) {\r
- String item = (String)iter.next();\r
- getProject().setProperty(item, (String)backupProperties.get(item));\r
+ //\r
+ // All Dependency Library Instance's PackageDependencies\r
+ //\r
+ ModuleIdentification[] libinstances = saq.getLibraryInstance(fpdModuleId.getArch());\r
+ for (int i = 0; i < libinstances.length; i++) {\r
+ saq.push(GlobalData.getDoc(libinstances[i], fpdModuleId.getArch()));\r
+ PackageIdentification[] libraryPackageDependencies = saq.getDependencePkg(fpdModuleId.getArch());\r
+ for (int j = 0; j < libraryPackageDependencies.length; j++) {\r
+ GlobalData.refreshPackageIdentification(libraryPackageDependencies[j]);\r
+ File packageFile = libraryPackageDependencies[j].getSpdFile();\r
+ includes.add(packageFile.getParent() + File.separatorChar + "Include");\r
+ includes.add(packageFile.getParent() + File.separatorChar + "Include" + File.separatorChar + archDir(arch));\r
+ }\r
+ saq.pop();\r
}\r
- }\r
+ \r
+ \r
+ //\r
+ // The package which the module belongs to\r
+ // TBD\r
+ includes.add(fpdModuleId.getModule().getPackage().getPackageDir() + File.separatorChar + "Include");\r
+ includes.add(fpdModuleId.getModule().getPackage().getPackageDir() + File.separatorChar + "Include" + File.separatorChar + archDir(arch));\r
\r
- public void setSingleModuleBuild(boolean isSingleModuleBuild) {\r
- this.isSingleModuleBuild = isSingleModuleBuild;\r
+ //\r
+ // Debug files output directory\r
+ //\r
+ includes.add("${DEST_DIR_DEBUG}");\r
+ \r
+ //\r
+ // set to INCLUDE_PATHS property\r
+ //\r
+ Iterator<String> iter = includes.iterator();\r
+ StringBuffer includePaths = new StringBuffer();\r
+ while (iter.hasNext()) {\r
+ includePaths.append(iter.next());\r
+ includePaths.append("; ");\r
+ }\r
+ getProject().setProperty("INCLUDE_PATHS", getProject().replaceProperties(includePaths.toString()).replaceAll("(\\\\)", "/"));\r
+ \r
+ return includes.toArray(new String[includes.size()]);\r
}\r
+ \r
+ /**\r
+ Return the name of the directory that corresponds to the architecture.\r
+ This is a translation from the XML Schema tag to a directory that\r
+ corresponds to our directory name coding convention.\r
+ \r
+ **/\r
+ private String archDir(String arch) {\r
+ return arch.replaceFirst("X64", "x64")\r
+ .replaceFirst("IPF", "Ipf")\r
+ .replaceFirst("IA32", "Ia32")\r
+ .replaceFirst("ARM", "Arm")\r
+ .replaceFirst("EBC", "Ebc");\r
+ }\r
+ \r
+ \r
+ public void setExternalProperties(Vector<Property> v) {\r
+ this.properties = v;\r
+ }\r
}\r