package org.tianocore.build;\r
\r
import java.io.File;\r
-import java.util.Hashtable;\r
import java.util.Iterator;\r
import java.util.LinkedHashSet;\r
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
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.PropertyManager;\r
import org.tianocore.build.global.SurfaceAreaQuery;\r
import org.tianocore.build.id.FpdModuleIdentification;\r
import org.tianocore.build.id.ModuleIdentification;\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
\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
/**\r
EdkLog.setLogLevel(getProject().getProperty("env.LOGLEVEL"));\r
EdkLog.setLogger(logger);\r
\r
- pushProperties();\r
+ PropertyManager.setProject(getProject());\r
+ PropertyManager.save();\r
//\r
// Enable all specified properties\r
//\r
Iterator<Property> iter = properties.iterator();\r
while (iter.hasNext()) {\r
Property item = iter.next();\r
- getProject().setProperty(item.getName(), item.getValue());\r
+ PropertyManager.setProperty(item.getName(), item.getValue());\r
}\r
\r
//\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
+ PropertyManager.setProperty("PLATFORM_DIR", platformId.getFpdFile().getParent().replaceAll("(\\\\)", "/"));\r
+ PropertyManager.setProperty("PLATFORM_RELATIVE_DIR", platformId.getPlatformRelativeDir().replaceAll("(\\\\)", "/"));\r
\r
String packageGuid = getProject().getProperty("PACKAGE_GUID");\r
String packageVersion = getProject().getProperty("PACKAGE_VERSION");\r
\r
for (int k = 0; k < archList.length; k++) {\r
\r
- getProject().setProperty("ARCH", archList[k]);\r
+ PropertyManager.setProperty("ARCH", archList[k]);\r
\r
FpdModuleIdentification fpdModuleId = new FpdModuleIdentification(moduleId, archList[k]);\r
\r
System.out.println("\nWARNING: " + 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
// Prepare for target related common properties\r
// TARGET\r
//\r
- getProject().setProperty("TARGET", targetList[i]);\r
+ PropertyManager.setProperty("TARGET", targetList[i]);\r
String[] toolchainList = GlobalData.getToolChainInfo().getTagnames();\r
for(int j = 0; j < toolchainList.length; j ++){\r
//\r
// Prepare for toolchain related common properties\r
// TOOLCHAIN\r
//\r
- getProject().setProperty("TOOLCHAIN", toolchainList[j]);\r
+ PropertyManager.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
}\r
}\r
\r
- popProperties();\r
+ PropertyManager.restore();\r
}\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
+ PropertyManager.setProperty("PLATFORM", platformId.getName());\r
+ PropertyManager.setProperty("PLATFORM_DIR", platformId.getFpdFile().getParent().replaceAll("(\\\\)", "/"));\r
+ PropertyManager.setProperty("PLATFORM_RELATIVE_DIR", platformId.getPlatformRelativeDir().replaceAll("(\\\\)", "/"));\r
}\r
\r
\r
// PACKAGE, PACKAGE_GUID, PACKAGE_VERSION, PACKAGE_DIR, PACKAGE_RELATIVE_DIR\r
//\r
PackageIdentification packageId = moduleId.getPackage();\r
- getProject().setProperty("PACKAGE", packageId.getName());\r
- getProject().setProperty("PACKAGE_GUID", packageId.getGuid());\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
+ PropertyManager.setProperty("PACKAGE", packageId.getName());\r
+ PropertyManager.setProperty("PACKAGE_GUID", packageId.getGuid());\r
+ PropertyManager.setProperty("PACKAGE_VERSION", packageId.getVersion());\r
+ PropertyManager.setProperty("PACKAGE_DIR", packageId.getPackageDir().replaceAll("(\\\\)", "/"));\r
+ PropertyManager.setProperty("PACKAGE_RELATIVE_DIR", packageId.getPackageRelativeDir().replaceAll("(\\\\)", "/"));\r
\r
//\r
// MODULE or BASE_NAME, GUID or FILE_GUID, VERSION, MODULE_TYPE\r
// MODULE_DIR, MODULE_RELATIVE_DIR\r
//\r
- getProject().setProperty("MODULE", moduleId.getName());\r
+ PropertyManager.setProperty("MODULE", moduleId.getName());\r
String baseName = SurfaceAreaQuery.getModuleOutputFileBasename();\r
if (baseName == null) {\r
- getProject().setProperty("BASE_NAME", moduleId.getName());\r
+ PropertyManager.setProperty("BASE_NAME", moduleId.getName());\r
} else {\r
- getProject().setProperty("BASE_NAME", baseName);\r
+ PropertyManager.setProperty("BASE_NAME", baseName);\r
}\r
- getProject().setProperty("GUID", moduleId.getGuid());\r
- getProject().setProperty("FILE_GUID", moduleId.getGuid());\r
- getProject().setProperty("VERSION", moduleId.getVersion());\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
+ PropertyManager.setProperty("GUID", moduleId.getGuid());\r
+ PropertyManager.setProperty("FILE_GUID", moduleId.getGuid());\r
+ PropertyManager.setProperty("VERSION", moduleId.getVersion());\r
+ PropertyManager.setProperty("MODULE_TYPE", moduleId.getModuleType());\r
+ PropertyManager.setProperty("MODULE_DIR", moduleId.getMsaFile().getParent().replaceAll("(\\\\)", "/"));\r
+ PropertyManager.setProperty("MODULE_RELATIVE_DIR", moduleId.getModuleRelativePath().replaceAll("(\\\\)", "/"));\r
\r
//\r
// SUBSYSTEM\r
break ;\r
}\r
}\r
- getProject().setProperty("SUBSYSTEM", subsystem);\r
+ PropertyManager.setProperty("SUBSYSTEM", subsystem);\r
\r
//\r
// ENTRYPOINT\r
//\r
if (arch.equalsIgnoreCase("EBC")) {\r
- getProject().setProperty("ENTRYPOINT", "EfiStart");\r
+ PropertyManager.setProperty("ENTRYPOINT", "EfiStart");\r
} else {\r
- getProject().setProperty("ENTRYPOINT", "_ModuleEntryPoint");\r
+ PropertyManager.setProperty("ENTRYPOINT", "_ModuleEntryPoint");\r
}\r
\r
- getProject().setProperty("OBJECTS", "");\r
+ PropertyManager.setProperty("OBJECTS", "");\r
}\r
\r
private void getCompilerFlags(String target, String toolchain, FpdModuleIdentification fpdModuleId) throws EdkException {\r
key[4] = ToolDefinitions.TOOLS_DEF_ATTRIBUTE_NAME;\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
+ PropertyManager.setProperty(cmd[m], cmdFile.getPath().replaceAll("(\\\\)", "/"));\r
\r
//\r
// set CC_FLAGS\r
Set<String> addset = new LinkedHashSet<String>();\r
Set<String> subset = new LinkedHashSet<String>();\r
putFlagsToSet(addset, cmdFlags);\r
- getProject().setProperty(cmd[m] + "_FLAGS", getProject().replaceProperties(getFlags(addset, subset)));\r
+ PropertyManager.setProperty(cmd[m] + "_FLAGS", getProject().replaceProperties(getFlags(addset, subset)));\r
\r
//\r
// Set CC_EXT\r
key[4] = ToolDefinitions.TOOLS_DEF_ATTRIBUTE_EXT;\r
String extName = GlobalData.getCommandSetting(key, fpdModuleId);\r
if ( extName != null && ! extName.equalsIgnoreCase("")) {\r
- getProject().setProperty(cmd[m] + "_EXT", extName);\r
+ PropertyManager.setProperty(cmd[m] + "_EXT", extName);\r
} else {\r
- getProject().setProperty(cmd[m] + "_EXT", "");\r
+ PropertyManager.setProperty(cmd[m] + "_EXT", "");\r
}\r
\r
//\r
key[4] = ToolDefinitions.TOOLS_DEF_ATTRIBUTE_FAMILY;\r
String toolChainFamily = GlobalData.getCommandSetting(key, fpdModuleId);\r
if (toolChainFamily != null) {\r
- getProject().setProperty(cmd[m] + "_FAMILY", toolChainFamily);\r
+ PropertyManager.setProperty(cmd[m] + "_FAMILY", toolChainFamily);\r
}\r
\r
//\r
key[4] = ToolDefinitions.TOOLS_DEF_ATTRIBUTE_SPATH;\r
String spath = GlobalData.getCommandSetting(key, fpdModuleId);\r
if (spath != null) {\r
- getProject().setProperty(cmd[m] + "_SPATH", spath.replaceAll("(\\\\)", "/"));\r
+ PropertyManager.setProperty(cmd[m] + "_SPATH", spath.replaceAll("(\\\\)", "/"));\r
} else {\r
- getProject().setProperty(cmd[m] + "_SPATH", "");\r
+ PropertyManager.setProperty(cmd[m] + "_SPATH", "");\r
}\r
\r
//\r
key[4] = ToolDefinitions.TOOLS_DEF_ATTRIBUTE_DPATH;\r
String dpath = GlobalData.getCommandSetting(key, fpdModuleId);\r
if (dpath != null) {\r
- getProject().setProperty(cmd[m] + "_DPATH", dpath.replaceAll("(\\\\)", "/"));\r
+ PropertyManager.setProperty(cmd[m] + "_DPATH", dpath.replaceAll("(\\\\)", "/"));\r
} else {\r
- getProject().setProperty(cmd[m] + "_DPATH", "");\r
+ PropertyManager.setProperty(cmd[m] + "_DPATH", "");\r
}\r
}\r
}\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
+ PropertyManager.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
+ System.out.println("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
// TBD\r
//\r
String ffsKeyword = SurfaceAreaQuery.getModuleFfsKeyword();\r
- ModuleBuildFileGenerator fileGenerator = new ModuleBuildFileGenerator(getProject(), ffsKeyword, fpdModuleId);\r
+ ModuleBuildFileGenerator fileGenerator = new ModuleBuildFileGenerator(getProject(), ffsKeyword, fpdModuleId, includes);\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
+ System.out.println("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
+ System.out.println("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 = SurfaceAreaQuery.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 = SurfaceAreaQuery.getLibraryInstance(fpdModuleId.getArch());\r
+ for (int i = 0; i < libinstances.length; i++) {\r
+ SurfaceAreaQuery.push(GlobalData.getDoc(libinstances[i], fpdModuleId.getArch()));\r
+ PackageIdentification[] libraryPackageDependencies = SurfaceAreaQuery.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
+ SurfaceAreaQuery.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
+ PropertyManager.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
projects / mirror_edk2.git / blobdiff