Fixed EDKT482. Added support for multiple msa files in the same directory.
[mirror_edk2.git] / Tools / Java / Source / GenBuild / org / tianocore / build / GenBuildTask.java
CommitLineData
878ddf1f 1/** @file\r
ff225cbb 2 This file is ANT task GenBuild.\r
3\r
4 The file is used to parse a specified Module, and generate its build time\r
878ddf1f 5 ANT script build.xml, then call the the ANT script to build the module.\r
ff225cbb 6\r
878ddf1f 7Copyright (c) 2006, Intel Corporation\r
8All rights reserved. This program and the accompanying materials\r
9are licensed and made available under the terms and conditions of the BSD License\r
10which accompanies this distribution. The full text of the license may be found at\r
11http://opensource.org/licenses/bsd-license.php\r
12\r
13THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
14WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
15**/\r
16package org.tianocore.build;\r
17\r
18import java.io.File;\r
aca6c736 19import java.util.Hashtable;\r
878ddf1f 20import java.util.Iterator;\r
21import java.util.LinkedHashSet;\r
22import java.util.List;\r
23import java.util.Map;\r
24import java.util.Set;\r
25import java.util.Vector;\r
878ddf1f 26\r
878ddf1f 27import org.apache.tools.ant.BuildException;\r
aca6c736 28import org.apache.tools.ant.BuildListener;\r
29import org.apache.tools.ant.Project;\r
878ddf1f 30import org.apache.tools.ant.taskdefs.Ant;\r
a29c47e0 31import org.apache.tools.ant.taskdefs.Property;\r
878ddf1f 32import org.apache.xmlbeans.XmlObject;\r
878ddf1f 33\r
4a6a5026 34import org.tianocore.common.definitions.ToolDefinitions;\r
ff225cbb 35import org.tianocore.common.exception.EdkException;\r
d965d1f6 36import org.tianocore.common.logger.EdkLog;\r
136adffc 37import org.tianocore.build.autogen.AutoGen;\r
892b0e7a 38import org.tianocore.build.exception.AutoGenException;\r
39import org.tianocore.build.exception.GenBuildException;\r
40import org.tianocore.build.exception.PcdAutogenException;\r
41import org.tianocore.build.exception.PlatformPcdPreprocessBuildException;\r
878ddf1f 42import org.tianocore.build.fpd.FpdParserTask;\r
43import org.tianocore.build.global.GlobalData;\r
44import org.tianocore.build.global.OutputManager;\r
45import org.tianocore.build.global.SurfaceAreaQuery;\r
a29c47e0 46import org.tianocore.build.id.FpdModuleIdentification;\r
47import org.tianocore.build.id.ModuleIdentification;\r
48import org.tianocore.build.id.PackageIdentification;\r
49import org.tianocore.build.id.PlatformIdentification;\r
50import org.tianocore.build.tools.ModuleItem;\r
878ddf1f 51\r
52/**\r
53 <p>\r
54 <code>GenBuildTask</code> is an ANT task that can be used in ANT build\r
4a6a5026 55 system. \r
56 \r
57 <p>The main function of this task is to parse module's surface area (MSA),\r
878ddf1f 58 then generate the corresponding <em>BaseName_build.xml</em> (the real ANT\r
a29c47e0 59 build script) and call this to build the module. The whole process including:\r
4b5f5549 60 \r
2d16dcec 61 <pre>\r
4a6a5026 62 1. generate AutoGen.c and AutoGen.h; \r
63 2. build all dependent library instances;\r
64 3. build all source files inlcude AutoGen.c; \r
65 4. generate sections;\r
ff225cbb 66 5. generate FFS file if it is driver module while LIB file if it is Library module.\r
2d16dcec 67 </pre>\r
68\r
ff225cbb 69\r
878ddf1f 70 <p>\r
71 The usage is (take module <em>HelloWorld</em> for example):\r
72 </p>\r
ff225cbb 73\r
878ddf1f 74 <pre>\r
4b5f5549 75 &lt;GenBuild \r
76 msaFile="${PACKAGE_DIR}/Application/HelloWorld/HelloWorld.msa"\r
77 type="cleanall" /&gt;\r
878ddf1f 78 </pre>\r
ff225cbb 79\r
878ddf1f 80 <p>\r
81 This task calls <code>AutoGen</code> to generate <em>AutoGen.c</em> and\r
4b5f5549 82 <em>AutoGen.h</em>. \r
878ddf1f 83 </p>\r
ff225cbb 84\r
4b5f5549 85 <p>\r
86 This task will also set properties for current module, such as PACKAGE, \r
87 PACKAGE_GUID, PACKAGE_VERSION, PACKAGE_DIR, PACKAGE_RELATIVE_DIR \r
88 (relative to Workspace), MODULE or BASE_NAME, GUID, VERSION, MODULE_DIR, \r
89 MODULE_RELATIVE_DIR (relative to Package), CONFIG_DIR, BIN_DIR, \r
90 DEST_DIR_DEBUG, DEST_DIR_OUTPUT, TARGET, ARCH, TOOLCHAIN, TOOLCHAIN_FAMILY, \r
91 SUBSYSTEM, ENTRYPOINT, EBC_TOOL_LIB_PATH, all compiler command related \r
92 properties (CC, CC_FLAGS, CC_DPATH, CC_SPATH, CC_FAMILY, CC_EXT). \r
93 </p>\r
94 \r
878ddf1f 95 @since GenBuild 1.0\r
96**/\r
a29c47e0 97public class GenBuildTask extends Ant {\r
ff225cbb 98\r
878ddf1f 99 ///\r
100 /// Module surface area file.\r
101 ///\r
a29c47e0 102 File msaFile;\r
19bf6b15 103 \r
104 public ModuleIdentification parentId;\r
105 \r
82516887 106 private String type = "all"; \r
107 \r
878ddf1f 108 ///\r
a29c47e0 109 /// Module's Identification.\r
878ddf1f 110 ///\r
a29c47e0 111 private ModuleIdentification moduleId;\r
878ddf1f 112\r
a29c47e0 113 private Vector<Property> properties = new Vector<Property>();\r
de4bb9f6 114\r
de4bb9f6 115 private boolean isSingleModuleBuild = false;\r
83fba802 116 \r
117 private SurfaceAreaQuery saq = null;\r
ff225cbb 118\r
878ddf1f 119 /**\r
120 Public construct method. It is necessary for ANT task.\r
121 **/\r
122 public GenBuildTask() {\r
123 }\r
124\r
125 /**\r
ff225cbb 126\r
878ddf1f 127 @throws BuildException\r
128 From module build, exception from module surface area invalid.\r
129 **/\r
130 public void execute() throws BuildException {\r
89e1408f 131 this.setTaskName("GenBuild");\r
892b0e7a 132 try {\r
133 processGenBuild();\r
134 } catch (PcdAutogenException e) {\r
47412835 135 BuildException buildException = new BuildException(e.getMessage());\r
136 buildException.setStackTrace(e.getStackTrace());\r
137 throw buildException;\r
892b0e7a 138 } catch (AutoGenException e) {\r
47412835 139 BuildException buildException = new BuildException(e.getMessage());\r
140 buildException.setStackTrace(e.getStackTrace());\r
141 throw buildException;\r
892b0e7a 142 } catch (PlatformPcdPreprocessBuildException e) {\r
47412835 143 BuildException buildException = new BuildException(e.getMessage());\r
144 buildException.setStackTrace(e.getStackTrace());\r
145 throw buildException;\r
892b0e7a 146 } catch (GenBuildException e) {\r
47412835 147 BuildException buildException = new BuildException(e.getMessage());\r
148 buildException.setStackTrace(e.getStackTrace());\r
149 throw buildException;\r
892b0e7a 150 } catch (EdkException e) {\r
47412835 151 BuildException buildException = new BuildException(e.getMessage());\r
152 buildException.setStackTrace(e.getStackTrace());\r
153 throw buildException;\r
892b0e7a 154 }\r
155 }\r
156\r
157 private void processGenBuild() throws EdkException, BuildException, GenBuildException, AutoGenException, PcdAutogenException, PlatformPcdPreprocessBuildException {\r
aca6c736 158 if (!FrameworkBuildTask.multithread) {\r
159 cleanupProperties();\r
160 }\r
82516887 161\r
878ddf1f 162 //\r
a29c47e0 163 // Enable all specified properties\r
878ddf1f 164 //\r
a29c47e0 165 Iterator<Property> iter = properties.iterator();\r
166 while (iter.hasNext()) {\r
167 Property item = iter.next();\r
aca6c736 168 getProject().setProperty(item.getName(), item.getValue());\r
878ddf1f 169 }\r
ff225cbb 170\r
878ddf1f 171 //\r
a29c47e0 172 // GenBuild should specify either msaFile or moduleGuid & packageGuid\r
878ddf1f 173 //\r
a29c47e0 174 if (msaFile == null ) {\r
175 String moduleGuid = getProject().getProperty("MODULE_GUID");\r
176 String moduleVersion = getProject().getProperty("MODULE_VERSION");\r
177 String packageGuid = getProject().getProperty("PACKAGE_GUID");\r
178 String packageVersion = getProject().getProperty("PACKAGE_VERSION");\r
892b0e7a 179 //\r
180 // If one of module Guid or package Guid is not specified, report error\r
181 //\r
a29c47e0 182 if (moduleGuid == null || packageGuid == null) {\r
391dbbb1 183 throw new BuildException("GenBuild parameter error.");\r
878ddf1f 184 }\r
892b0e7a 185 \r
a29c47e0 186 PackageIdentification packageId = new PackageIdentification(packageGuid, packageVersion);\r
892b0e7a 187 GlobalData.refreshPackageIdentification(packageId);\r
a29c47e0 188 moduleId = new ModuleIdentification(moduleGuid, moduleVersion);\r
189 moduleId.setPackage(packageId);\r
892b0e7a 190 GlobalData.refreshModuleIdentification(moduleId);\r
a29c47e0 191 Map<String, XmlObject> doc = GlobalData.getNativeMsa(moduleId);\r
83fba802 192 saq = new SurfaceAreaQuery(doc);\r
82516887 193 } else {\r
a29c47e0 194 Map<String, XmlObject> doc = GlobalData.getNativeMsa(msaFile);\r
83fba802 195 saq = new SurfaceAreaQuery(doc);\r
196 moduleId = saq.getMsaHeader();\r
89e1408f 197 moduleId.setMsaFile(msaFile);\r
878ddf1f 198 }\r
892b0e7a 199 \r
83fba802 200 String[] producedLibraryClasses = saq.getLibraryClasses("ALWAYS_PRODUCED",null);\r
a29c47e0 201 if (producedLibraryClasses.length == 0) {\r
202 moduleId.setLibrary(false);\r
82516887 203 } else {\r
a29c47e0 204 moduleId.setLibrary(true);\r
878ddf1f 205 }\r
ff225cbb 206\r
878ddf1f 207 //\r
a29c47e0 208 // Judge whether it is single module build or not\r
878ddf1f 209 //\r
de4bb9f6 210 if (isSingleModuleBuild) {\r
878ddf1f 211 //\r
a29c47e0 212 // Single Module build\r
878ddf1f 213 //\r
a29c47e0 214 prepareSingleModuleBuild();\r
878ddf1f 215 }\r
ff225cbb 216\r
a29c47e0 217 //\r
82516887 218 // If single module : get arch from pass down, otherwise intersection MSA \r
219 // supported ARCHs and tools def\r
a29c47e0 220 //\r
ff225cbb 221 Set<String> archListSupByToolChain = new LinkedHashSet<String>();\r
222 String[] archs = GlobalData.getToolChainInfo().getArchs();\r
223\r
3c696250 224 for (int i = 0; i < archs.length; i ++) {\r
225 archListSupByToolChain.add(archs[i]);\r
226 }\r
ff225cbb 227\r
3c696250 228 Set<String> archSet = new LinkedHashSet<String>();\r
ff225cbb 229\r
3c696250 230 if ( getProject().getProperty("ARCH") != null) {\r
231 String[] fpdArchList = getProject().getProperty("ARCH").split(" ");\r
ff225cbb 232\r
3c696250 233 for (int i = 0; i < fpdArchList.length; i++) {\r
234 if (archListSupByToolChain.contains(fpdArchList[i])) {\r
235 archSet.add(fpdArchList[i]);\r
236 }\r
237 }\r
82516887 238 } else {\r
239 archSet = archListSupByToolChain; \r
3c696250 240 }\r
ff225cbb 241\r
3c696250 242 String[] archList = archSet.toArray(new String[archSet.size()]);\r
ff225cbb 243\r
a29c47e0 244 //\r
245 // Judge if arch is all supported by current module. If not, throw Exception.\r
246 //\r
83fba802 247 List moduleSupportedArchs = saq.getModuleSupportedArchs();\r
a29c47e0 248 if (moduleSupportedArchs != null) {\r
249 for (int k = 0; k < archList.length; k++) {\r
250 if ( ! moduleSupportedArchs.contains(archList[k])) {\r
391dbbb1 251 throw new BuildException("Specified architecture [" + archList[k] + "] is not supported by " + moduleId + ". The module " + moduleId + " only supports [" + moduleSupportedArchs + "] architectures.");\r
a29c47e0 252 }\r
253 }\r
878ddf1f 254 }\r
ff225cbb 255\r
c340a28e 256 if (archList.length == 0) {\r
257 EdkLog.log(this, EdkLog.EDK_WARNING, "Warning: " + moduleId + " was not found in current platform FPD file!\n");\r
258 }\r
259\r
a29c47e0 260 for (int k = 0; k < archList.length; k++) {\r
ff225cbb 261\r
aca6c736 262 getProject().setProperty("ARCH", archList[k]);\r
ff225cbb 263\r
a29c47e0 264 FpdModuleIdentification fpdModuleId = new FpdModuleIdentification(moduleId, archList[k]);\r
ff225cbb 265\r
878ddf1f 266 //\r
a29c47e0 267 // Whether the module is built before\r
878ddf1f 268 //\r
34281092 269 if (moduleId.isLibrary() == false && GlobalData.hasFpdModuleSA(fpdModuleId) == false) {\r
d965d1f6 270 EdkLog.log(this, EdkLog.EDK_WARNING, "Warning: " + moduleId + " for " + archList[k] + " was not found in current platform FPD file!\n");\r
34281092 271 continue;\r
272 } else if (GlobalData.isModuleBuilt(fpdModuleId)) {\r
1fa1cb75 273 break;\r
34281092 274 } else {\r
a29c47e0 275 GlobalData.registerBuiltModule(fpdModuleId);\r
276 }\r
ff225cbb 277\r
878ddf1f 278 //\r
a29c47e0 279 // For Every TOOLCHAIN, TARGET\r
280 //\r
281 String[] targetList = GlobalData.getToolChainInfo().getTargets();\r
282 for (int i = 0; i < targetList.length; i ++){\r
283 //\r
284 // Prepare for target related common properties\r
285 // TARGET\r
286 //\r
aca6c736 287 getProject().setProperty("TARGET", targetList[i]);\r
a29c47e0 288 String[] toolchainList = GlobalData.getToolChainInfo().getTagnames();\r
289 for(int j = 0; j < toolchainList.length; j ++){\r
c773bec0 290 //\r
291 // check if any tool is defined for current target + toolchain + arch\r
292 // don't do anything if no tools found\r
ff225cbb 293 //\r
c773bec0 294 if (GlobalData.isCommandSet(targetList[i], toolchainList[j], archList[k]) == false) {\r
fd6c41f5 295 EdkLog.log(this, EdkLog.EDK_WARNING, "Warning: No build issued. No tools found for [target=" + targetList[i] + " toolchain=" + toolchainList[j] + " arch=" + archList[k] + "]\n");\r
c773bec0 296 continue;\r
297 }\r
298\r
a29c47e0 299 //\r
300 // Prepare for toolchain related common properties\r
301 // TOOLCHAIN\r
302 //\r
aca6c736 303 getProject().setProperty("TOOLCHAIN", toolchainList[j]);\r
a29c47e0 304\r
d965d1f6 305 EdkLog.log(this, "Build " + moduleId + " start >>>");\r
306 EdkLog.log(this, "Target: " + targetList[i] + " Tagname: " + toolchainList[j] + " Arch: " + archList[k]);\r
83fba802 307 saq.push(GlobalData.getDoc(fpdModuleId));\r
ff225cbb 308\r
a29c47e0 309 //\r
310 // Prepare for all other common properties\r
311 // PACKAGE, PACKAGE_GUID, PACKAGE_VERSION, PACKAGE_DIR, PACKAGE_RELATIVE_DIR\r
312 // MODULE or BASE_NAME, GUID or FILE_GUID, VERSION, MODULE_TYPE\r
313 // MODULE_DIR, MODULE_RELATIVE_DIR\r
314 // SUBSYSTEM, ENTRYPOINT, EBC_TOOL_LIB_PATH\r
a29c47e0 315 //\r
316 setModuleCommonProperties(archList[k]);\r
ff225cbb 317\r
a29c47e0 318 //\r
ff225cbb 319 // OutputManage prepare for\r
a29c47e0 320 // BIN_DIR, DEST_DIR_DEBUG, DEST_DIR_OUTPUT, BUILD_DIR, FV_DIR\r
321 //\r
322 OutputManager.getInstance().update(getProject());\r
ff225cbb 323\r
a29c47e0 324 if (type.equalsIgnoreCase("all") || type.equalsIgnoreCase("build")) {\r
325 applyBuild(targetList[i], toolchainList[j], fpdModuleId);\r
82516887 326 } else if (type.equalsIgnoreCase("clean")) {\r
a29c47e0 327 applyClean(fpdModuleId);\r
82516887 328 } else if (type.equalsIgnoreCase("cleanall")) {\r
a29c47e0 329 applyCleanall(fpdModuleId);\r
330 }\r
331 }\r
332 }\r
878ddf1f 333 }\r
878ddf1f 334 }\r
335\r
336 /**\r
ff225cbb 337 This method is used to prepare Platform-related information.\r
338\r
a29c47e0 339 <p>In Single Module Build mode, platform-related information is not ready.\r
ff225cbb 340 The method read the system environment variable <code>ACTIVE_PLATFORM</code>\r
a29c47e0 341 and search in the Framework Database. Note that platform name in the Framework\r
342 Database must be unique. </p>\r
ff225cbb 343\r
878ddf1f 344 **/\r
892b0e7a 345 private void prepareSingleModuleBuild() throws EdkException {\r
878ddf1f 346 //\r
a29c47e0 347 // Find out the package which the module belongs to\r
878ddf1f 348 //\r
a29c47e0 349 PackageIdentification packageId = GlobalData.getPackageForModule(moduleId);\r
892b0e7a 350 GlobalData.refreshPackageIdentification(packageId);\r
a29c47e0 351 moduleId.setPackage(packageId);\r
892b0e7a 352 GlobalData.refreshModuleIdentification(moduleId);\r
ff225cbb 353\r
878ddf1f 354 //\r
82516887 355 // Read ACTIVE_PLATFORM's FPD file \r
878ddf1f 356 //\r
de4bb9f6 357 String filename = getProject().getProperty("PLATFORM_FILE");\r
ff225cbb 358\r
de4bb9f6 359 if (filename == null){\r
391dbbb1 360 throw new BuildException("Please set ACTIVE_PLATFORM in the file: Tools/Conf/target.txt if you want to build a single module!");\r
878ddf1f 361 }\r
ff225cbb 362\r
de4bb9f6 363 PlatformIdentification platformId = GlobalData.getPlatform(filename);\r
ff225cbb 364\r
878ddf1f 365 //\r
82516887 366 // Read FPD file (Call FpdParserTask's method)\r
878ddf1f 367 //\r
a29c47e0 368 FpdParserTask fpdParser = new FpdParserTask();\r
369 fpdParser.setProject(getProject());\r
07193171 370 fpdParser.parseFpdFile(platformId.getFpdFile());\r
aca6c736 371 getProject().setProperty("ARCH", fpdParser.getAllArchForModule(moduleId));\r
878ddf1f 372 }\r
373\r
aca6c736 374 private void cleanupProperties() {\r
375 Project newProject = new Project();\r
376\r
377 Hashtable<String, String> passdownProperties = FrameworkBuildTask.originalProperties;\r
378 Iterator<String> iter = passdownProperties.keySet().iterator();\r
379 while (iter.hasNext()) {\r
380 String item = iter.next();\r
381 newProject.setProperty(item, passdownProperties.get(item));\r
382 }\r
383\r
384 newProject.setInputHandler(getProject().getInputHandler());\r
385\r
386 Iterator listenerIter = getProject().getBuildListeners().iterator();\r
387 while (listenerIter.hasNext()) {\r
388 newProject.addBuildListener((BuildListener) listenerIter.next());\r
389 }\r
390\r
391 getProject().initSubProject(newProject);\r
392\r
393 setProject(newProject);\r
394 }\r
878ddf1f 395\r
396 /**\r
a29c47e0 397 Set Module-Related information to properties.\r
82516887 398 \r
399 @param arch current build ARCH\r
878ddf1f 400 **/\r
a29c47e0 401 private void setModuleCommonProperties(String arch) {\r
878ddf1f 402 //\r
a29c47e0 403 // Prepare for all other common properties\r
404 // PACKAGE, PACKAGE_GUID, PACKAGE_VERSION, PACKAGE_DIR, PACKAGE_RELATIVE_DIR\r
878ddf1f 405 //\r
a29c47e0 406 PackageIdentification packageId = moduleId.getPackage();\r
aca6c736 407 getProject().setProperty("PACKAGE", packageId.getName());\r
408 getProject().setProperty("PACKAGE_GUID", packageId.getGuid());\r
409 getProject().setProperty("PACKAGE_VERSION", packageId.getVersion());\r
410 getProject().setProperty("PACKAGE_DIR", packageId.getPackageDir().replaceAll("(\\\\)", "/"));\r
411 getProject().setProperty("PACKAGE_RELATIVE_DIR", packageId.getPackageRelativeDir().replaceAll("(\\\\)", "/"));\r
ff225cbb 412\r
a29c47e0 413 //\r
414 // MODULE or BASE_NAME, GUID or FILE_GUID, VERSION, MODULE_TYPE\r
415 // MODULE_DIR, MODULE_RELATIVE_DIR\r
416 //\r
aca6c736 417 getProject().setProperty("MODULE", moduleId.getName());\r
83fba802 418 String baseName = saq.getModuleOutputFileBasename();\r
a29c47e0 419 if (baseName == null) {\r
aca6c736 420 getProject().setProperty("BASE_NAME", moduleId.getName());\r
82516887 421 } else {\r
aca6c736 422 getProject().setProperty("BASE_NAME", baseName);\r
a29c47e0 423 }\r
aca6c736 424 getProject().setProperty("GUID", moduleId.getGuid());\r
425 getProject().setProperty("FILE_GUID", moduleId.getGuid());\r
426 getProject().setProperty("VERSION", moduleId.getVersion());\r
427 getProject().setProperty("MODULE_TYPE", moduleId.getModuleType());\r
428 getProject().setProperty("MODULE_DIR", moduleId.getMsaFile().getParent().replaceAll("(\\\\)", "/"));\r
c340a28e 429 getProject().setProperty("MODULE_RELATIVE_DIR", moduleId.getModuleRelativePath().replaceAll("(\\\\)", "/") + File.separatorChar + moduleId.getName());\r
ff225cbb 430\r
a29c47e0 431 //\r
432 // SUBSYSTEM\r
433 //\r
434 String[][] subsystemMap = { { "BASE", "EFI_BOOT_SERVICE_DRIVER"},\r
ff225cbb 435 { "SEC", "EFI_BOOT_SERVICE_DRIVER" },\r
436 { "PEI_CORE", "EFI_BOOT_SERVICE_DRIVER" },\r
437 { "PEIM", "EFI_BOOT_SERVICE_DRIVER" },\r
a29c47e0 438 { "DXE_CORE", "EFI_BOOT_SERVICE_DRIVER" },\r
ff225cbb 439 { "DXE_DRIVER", "EFI_BOOT_SERVICE_DRIVER" },\r
440 { "DXE_RUNTIME_DRIVER", "EFI_RUNTIME_DRIVER" },\r
441 { "DXE_SAL_DRIVER", "EFI_BOOT_SERVICE_DRIVER" },\r
442 { "DXE_SMM_DRIVER", "EFI_BOOT_SERVICE_DRIVER" },\r
443 { "TOOL", "EFI_BOOT_SERVICE_DRIVER" },\r
a29c47e0 444 { "UEFI_DRIVER", "EFI_BOOT_SERVICE_DRIVER" },\r
ff225cbb 445 { "UEFI_APPLICATION", "EFI_APPLICATION" },\r
446 { "USER_DEFINED", "EFI_BOOT_SERVICE_DRIVER"} };\r
447\r
a29c47e0 448 String subsystem = "EFI_BOOT_SERVICE_DRIVER";\r
449 for (int i = 0; i < subsystemMap.length; i++) {\r
450 if (moduleId.getModuleType().equalsIgnoreCase(subsystemMap[i][0])) {\r
451 subsystem = subsystemMap[i][1];\r
452 break ;\r
878ddf1f 453 }\r
454 }\r
aca6c736 455 getProject().setProperty("SUBSYSTEM", subsystem);\r
ff225cbb 456\r
a29c47e0 457 //\r
458 // ENTRYPOINT\r
459 //\r
460 if (arch.equalsIgnoreCase("EBC")) {\r
aca6c736 461 getProject().setProperty("ENTRYPOINT", "EfiStart");\r
82516887 462 } else {\r
aca6c736 463 getProject().setProperty("ENTRYPOINT", "_ModuleEntryPoint");\r
878ddf1f 464 }\r
ff225cbb 465\r
aca6c736 466 getProject().setProperty("OBJECTS", "");\r
878ddf1f 467 }\r
468\r
a29c47e0 469 private void getCompilerFlags(String target, String toolchain, FpdModuleIdentification fpdModuleId) throws EdkException {\r
470 String[] cmd = GlobalData.getToolChainInfo().getCommands();\r
471 for ( int m = 0; m < cmd.length; m++) {\r
878ddf1f 472 //\r
a29c47e0 473 // Set cmd, like CC, DLINK\r
878ddf1f 474 //\r
a29c47e0 475 String[] key = new String[]{target, toolchain, fpdModuleId.getArch(), cmd[m], null};\r
4a6a5026 476 key[4] = ToolDefinitions.TOOLS_DEF_ATTRIBUTE_PATH;\r
a29c47e0 477 String cmdPath = GlobalData.getCommandSetting(key, fpdModuleId);\r
4a6a5026 478 key[4] = ToolDefinitions.TOOLS_DEF_ATTRIBUTE_NAME;\r
a29c47e0 479 String cmdName = GlobalData.getCommandSetting(key, fpdModuleId);\r
1549f516 480 if (cmdName.length() == 0) {\r
fd6c41f5 481 EdkLog.log(this, EdkLog.EDK_VERBOSE, "Warning: " + cmd[m] + " hasn't been defined!");\r
482 getProject().setProperty(cmd[m], "");\r
1549f516 483 continue;\r
484 }\r
a29c47e0 485 File cmdFile = new File(cmdPath + File.separatorChar + cmdName);\r
aca6c736 486 getProject().setProperty(cmd[m], cmdFile.getPath().replaceAll("(\\\\)", "/"));\r
ff225cbb 487\r
878ddf1f 488 //\r
a29c47e0 489 // set CC_FLAGS\r
878ddf1f 490 //\r
4a6a5026 491 key[4] = ToolDefinitions.TOOLS_DEF_ATTRIBUTE_FLAGS;\r
a29c47e0 492 String cmdFlags = GlobalData.getCommandSetting(key, fpdModuleId);\r
e04a8a9a 493 if (cmdFlags != null) \r
494 {\r
e04a8a9a 495 getProject().setProperty(cmd[m] + "_FLAGS", cmdFlags);\r
496 } \r
497 else \r
498 {\r
499 getProject().setProperty(cmd[m] + "_FLAGS", "");\r
500 }\r
501\r
878ddf1f 502 //\r
a29c47e0 503 // Set CC_EXT\r
878ddf1f 504 //\r
4a6a5026 505 key[4] = ToolDefinitions.TOOLS_DEF_ATTRIBUTE_EXT;\r
a29c47e0 506 String extName = GlobalData.getCommandSetting(key, fpdModuleId);\r
a29c47e0 507 if ( extName != null && ! extName.equalsIgnoreCase("")) {\r
aca6c736 508 getProject().setProperty(cmd[m] + "_EXT", extName);\r
82516887 509 } else {\r
aca6c736 510 getProject().setProperty(cmd[m] + "_EXT", "");\r
878ddf1f 511 }\r
ff225cbb 512\r
878ddf1f 513 //\r
a29c47e0 514 // set CC_FAMILY\r
878ddf1f 515 //\r
4a6a5026 516 key[4] = ToolDefinitions.TOOLS_DEF_ATTRIBUTE_FAMILY;\r
a29c47e0 517 String toolChainFamily = GlobalData.getCommandSetting(key, fpdModuleId);\r
a29c47e0 518 if (toolChainFamily != null) {\r
aca6c736 519 getProject().setProperty(cmd[m] + "_FAMILY", toolChainFamily);\r
878ddf1f 520 }\r
ff225cbb 521\r
878ddf1f 522 //\r
a29c47e0 523 // set CC_SPATH\r
878ddf1f 524 //\r
4a6a5026 525 key[4] = ToolDefinitions.TOOLS_DEF_ATTRIBUTE_SPATH;\r
a29c47e0 526 String spath = GlobalData.getCommandSetting(key, fpdModuleId);\r
a29c47e0 527 if (spath != null) {\r
aca6c736 528 getProject().setProperty(cmd[m] + "_SPATH", spath.replaceAll("(\\\\)", "/"));\r
82516887 529 } else {\r
aca6c736 530 getProject().setProperty(cmd[m] + "_SPATH", "");\r
878ddf1f 531 }\r
ff225cbb 532\r
878ddf1f 533 //\r
a29c47e0 534 // set CC_DPATH\r
878ddf1f 535 //\r
4a6a5026 536 key[4] = ToolDefinitions.TOOLS_DEF_ATTRIBUTE_DPATH;\r
a29c47e0 537 String dpath = GlobalData.getCommandSetting(key, fpdModuleId);\r
a29c47e0 538 if (dpath != null) {\r
aca6c736 539 getProject().setProperty(cmd[m] + "_DPATH", dpath.replaceAll("(\\\\)", "/"));\r
82516887 540 } else {\r
aca6c736 541 getProject().setProperty(cmd[m] + "_DPATH", "");\r
878ddf1f 542 }\r
c639781e 543 \r
544 //\r
545 // Set CC_LIBPATH\r
546 //\r
547 key[4] = ToolDefinitions.TOOLS_DEF_ATTRIBUTE_LIBPATH;\r
548 String libpath = GlobalData.getCommandSetting(key, fpdModuleId);\r
549 if (libpath != null) {\r
550 getProject().setProperty(cmd[m] + "_LIBPATH", libpath.replaceAll("(\\\\)", "/"));\r
551 } else {\r
552 getProject().setProperty(cmd[m] + "_LIBPATH", "");\r
553 }\r
554 \r
555 //\r
556 // Set CC_INCLUDEPATH\r
557 //\r
558 key[4] = ToolDefinitions.TOOLS_DEF_ATTRIBUTE_INCLUDEPATH;\r
559 String includepath = GlobalData.getCommandSetting(key, fpdModuleId);\r
560 if (dpath != null) {\r
561 getProject().setProperty(cmd[m] + "_INCLUDEPATH", includepath.replaceAll("(\\\\)", "/"));\r
562 } else {\r
563 getProject().setProperty(cmd[m] + "_INCLUDEPATH", "");\r
564 }\r
878ddf1f 565 }\r
a29c47e0 566 }\r
ff225cbb 567\r
a29c47e0 568 public void setMsaFile(File msaFile) {\r
569 this.msaFile = msaFile;\r
878ddf1f 570 }\r
571\r
572 /**\r
ff225cbb 573 Method is for ANT to initialize MSA file.\r
574\r
a29c47e0 575 @param msaFilename MSA file name\r
878ddf1f 576 **/\r
a29c47e0 577 public void setMsaFile(String msaFilename) {\r
578 String moduleDir = getProject().getProperty("MODULE_DIR");\r
ff225cbb 579\r
a29c47e0 580 //\r
581 // If is Single Module Build, then use the Base Dir defined in build.xml\r
582 //\r
583 if (moduleDir == null) {\r
584 moduleDir = getProject().getBaseDir().getPath();\r
878ddf1f 585 }\r
a29c47e0 586 msaFile = new File(moduleDir + File.separatorChar + msaFilename);\r
587 }\r
ff225cbb 588\r
a29c47e0 589 public void addConfiguredModuleItem(ModuleItem moduleItem) {\r
590 PackageIdentification packageId = new PackageIdentification(moduleItem.getPackageGuid(), moduleItem.getPackageVersion());\r
591 ModuleIdentification moduleId = new ModuleIdentification(moduleItem.getModuleGuid(), moduleItem.getModuleVersion());\r
592 moduleId.setPackage(packageId);\r
593 this.moduleId = moduleId;\r
594 }\r
ff225cbb 595\r
a29c47e0 596 /**\r
ff225cbb 597 Add a property.\r
598\r
a29c47e0 599 @param p property\r
600 **/\r
601 public void addProperty(Property p) {\r
602 properties.addElement(p);\r
603 }\r
604\r
605 public void setType(String type) {\r
606 this.type = type;\r
607 }\r
ff225cbb 608\r
892b0e7a 609 private void applyBuild(String buildTarget, String buildTagname, FpdModuleIdentification fpdModuleId) throws EdkException {\r
a29c47e0 610 //\r
83fba802 611 // Call AutoGen to generate AutoGen.c and AutoGen.h\r
a29c47e0 612 //\r
2eb7d78d 613 AutoGen autogen = new AutoGen(getProject().getProperty("FV_DIR"), getProject().getProperty("DEST_DIR_DEBUG"), fpdModuleId.getModule(),fpdModuleId.getArch(), saq, parentId);\r
136adffc 614 autogen.genAutogen();\r
ff225cbb 615\r
a29c47e0 616 //\r
617 // Get compiler flags\r
618 //\r
82516887 619 try {\r
620 getCompilerFlags(buildTarget, buildTagname, fpdModuleId);\r
621 }\r
622 catch (EdkException ee) {\r
623 throw new BuildException(ee.getMessage());\r
624 }\r
625 \r
a29c47e0 626 //\r
627 // Prepare LIBS\r
628 //\r
83fba802 629 ModuleIdentification[] libinstances = saq.getLibraryInstance(fpdModuleId.getArch());\r
a29c47e0 630 String propertyLibs = "";\r
631 for (int i = 0; i < libinstances.length; i++) {\r
498e9021 632 propertyLibs += getProject().getProperty("BIN_DIR") + File.separatorChar + libinstances[i].getName() + ".lib" + " ";\r
878ddf1f 633 }\r
aca6c736 634 getProject().setProperty("LIBS", propertyLibs.replaceAll("(\\\\)", "/"));\r
ff225cbb 635\r
bf3a7173 636 //\r
637 // Get all includepath and set to INCLUDE_PATHS\r
638 //\r
639 String[] includes = prepareIncludePaths(fpdModuleId);\r
640 \r
a29c47e0 641 //\r
642 // if it is CUSTOM_BUILD\r
643 // then call the exist BaseName_build.xml directly.\r
644 //\r
645 if (moduleId.getModuleType().equalsIgnoreCase("USER_DEFINED")) {\r
d965d1f6 646 EdkLog.log(this, "Call user-defined " + moduleId.getName() + "_build.xml");\r
82516887 647 \r
648 String antFilename = getProject().getProperty("MODULE_DIR") + File.separatorChar + moduleId.getName() + "_build.xml";\r
649 antCall(antFilename, null);\r
650 \r
a29c47e0 651 return ;\r
878ddf1f 652 }\r
ff225cbb 653\r
878ddf1f 654 //\r
a29c47e0 655 // Generate ${BASE_NAME}_build.xml\r
656 // TBD\r
878ddf1f 657 //\r
83fba802 658 String ffsKeyword = saq.getModuleFfsKeyword();\r
659 ModuleBuildFileGenerator fileGenerator = new ModuleBuildFileGenerator(getProject(), ffsKeyword, fpdModuleId, includes, saq);\r
a29c47e0 660 String buildFilename = getProject().getProperty("DEST_DIR_OUTPUT") + File.separatorChar + moduleId.getName() + "_build.xml";\r
661 fileGenerator.genBuildFile(buildFilename);\r
ff225cbb 662\r
a29c47e0 663 //\r
664 // Ant call ${BASE_NAME}_build.xml\r
665 //\r
82516887 666 String antFilename = getProject().getProperty("DEST_DIR_OUTPUT") + File.separatorChar + moduleId.getName() + "_build.xml";\r
667 antCall(antFilename, null);\r
a29c47e0 668 }\r
ff225cbb 669\r
a29c47e0 670 private void applyClean(FpdModuleIdentification fpdModuleId){\r
671 //\r
672 // if it is CUSTOM_BUILD\r
673 // then call the exist BaseName_build.xml directly.\r
674 //\r
675 if (moduleId.getModuleType().equalsIgnoreCase("USER_DEFINED")) {\r
d965d1f6 676 EdkLog.log(this, "Calling user-defined " + moduleId.getName() + "_build.xml");\r
82516887 677 \r
678 String antFilename = getProject().getProperty("MODULE_DIR") + File.separatorChar + moduleId.getName() + "_build.xml";\r
679 antCall(antFilename, "clean");\r
680 \r
a29c47e0 681 return ;\r
878ddf1f 682 }\r
ff225cbb 683\r
82516887 684 String antFilename = getProject().getProperty("DEST_DIR_OUTPUT") + File.separatorChar + moduleId.getName() + "_build.xml";\r
685 antCall(antFilename, "clean");\r
a29c47e0 686 }\r
ff225cbb 687\r
a29c47e0 688 private void applyCleanall(FpdModuleIdentification fpdModuleId){\r
689 //\r
690 // if it is CUSTOM_BUILD\r
691 // then call the exist BaseName_build.xml directly.\r
692 //\r
693 if (moduleId.getModuleType().equalsIgnoreCase("USER_DEFINED")) {\r
d965d1f6 694 EdkLog.log(this, "Calling user-defined " + moduleId.getName() + "_build.xml");\r
82516887 695\r
696 String antFilename = getProject().getProperty("MODULE_DIR") + File.separatorChar + moduleId.getName() + "_build.xml";\r
697 antCall(antFilename, "cleanall");\r
698 \r
a29c47e0 699 return ;\r
878ddf1f 700 }\r
82516887 701 \r
702 String antFilename = getProject().getProperty("DEST_DIR_OUTPUT") + File.separatorChar + moduleId.getName() + "_build.xml";\r
703 antCall(antFilename, "cleanall");\r
704 }\r
ff225cbb 705\r
82516887 706 private void antCall(String antFilename, String target) {\r
a29c47e0 707 Ant ant = new Ant();\r
708 ant.setProject(getProject());\r
82516887 709 ant.setAntfile(antFilename);\r
710 if (target != null) {\r
711 ant.setTarget(target);\r
712 }\r
a29c47e0 713 ant.setInheritAll(true);\r
714 ant.init();\r
715 ant.execute();\r
878ddf1f 716 }\r
717\r
de4bb9f6 718 public void setSingleModuleBuild(boolean isSingleModuleBuild) {\r
719 this.isSingleModuleBuild = isSingleModuleBuild;\r
720 }\r
bf3a7173 721 \r
892b0e7a 722 private String[] prepareIncludePaths(FpdModuleIdentification fpdModuleId) throws EdkException{\r
bf3a7173 723 //\r
724 // Prepare the includes: PackageDependencies and Output debug direactory\r
725 //\r
726 Set<String> includes = new LinkedHashSet<String>();\r
727 String arch = fpdModuleId.getArch();\r
728 \r
729 //\r
730 // WORKSPACE\r
731 //\r
732 includes.add("${WORKSPACE_DIR}" + File.separatorChar);\r
733 \r
734 //\r
735 // Module iteself\r
736 //\r
737 includes.add("${MODULE_DIR}");\r
738 includes.add("${MODULE_DIR}" + File.separatorChar + archDir(arch));\r
739 \r
740 //\r
741 // Packages in PackageDenpendencies\r
742 //\r
83fba802 743 PackageIdentification[] packageDependencies = saq.getDependencePkg(fpdModuleId.getArch());\r
bf3a7173 744 for (int i = 0; i < packageDependencies.length; i++) {\r
745 GlobalData.refreshPackageIdentification(packageDependencies[i]);\r
746 File packageFile = packageDependencies[i].getSpdFile();\r
747 includes.add(packageFile.getParent() + File.separatorChar + "Include");\r
748 includes.add(packageFile.getParent() + File.separatorChar + "Include" + File.separatorChar + archDir(arch));\r
749 }\r
750\r
751 //\r
752 // All Dependency Library Instance's PackageDependencies\r
753 //\r
83fba802 754 ModuleIdentification[] libinstances = saq.getLibraryInstance(fpdModuleId.getArch());\r
bf3a7173 755 for (int i = 0; i < libinstances.length; i++) {\r
83fba802 756 saq.push(GlobalData.getDoc(libinstances[i], fpdModuleId.getArch()));\r
757 PackageIdentification[] libraryPackageDependencies = saq.getDependencePkg(fpdModuleId.getArch());\r
bf3a7173 758 for (int j = 0; j < libraryPackageDependencies.length; j++) {\r
759 GlobalData.refreshPackageIdentification(libraryPackageDependencies[j]);\r
760 File packageFile = libraryPackageDependencies[j].getSpdFile();\r
761 includes.add(packageFile.getParent() + File.separatorChar + "Include");\r
762 includes.add(packageFile.getParent() + File.separatorChar + "Include" + File.separatorChar + archDir(arch));\r
763 }\r
83fba802 764 saq.pop();\r
bf3a7173 765 }\r
766 \r
767 \r
768 //\r
769 // The package which the module belongs to\r
770 // TBD\r
771 includes.add(fpdModuleId.getModule().getPackage().getPackageDir() + File.separatorChar + "Include");\r
772 includes.add(fpdModuleId.getModule().getPackage().getPackageDir() + File.separatorChar + "Include" + File.separatorChar + archDir(arch));\r
773\r
774 //\r
775 // Debug files output directory\r
776 //\r
777 includes.add("${DEST_DIR_DEBUG}");\r
778 \r
779 //\r
780 // set to INCLUDE_PATHS property\r
781 //\r
782 Iterator<String> iter = includes.iterator();\r
783 StringBuffer includePaths = new StringBuffer();\r
784 while (iter.hasNext()) {\r
785 includePaths.append(iter.next());\r
786 includePaths.append("; ");\r
787 }\r
aca6c736 788 getProject().setProperty("INCLUDE_PATHS", getProject().replaceProperties(includePaths.toString()).replaceAll("(\\\\)", "/"));\r
bf3a7173 789 \r
790 return includes.toArray(new String[includes.size()]);\r
791 }\r
792 \r
793 /**\r
794 Return the name of the directory that corresponds to the architecture.\r
795 This is a translation from the XML Schema tag to a directory that\r
796 corresponds to our directory name coding convention.\r
797 \r
798 **/\r
799 private String archDir(String arch) {\r
800 return arch.replaceFirst("X64", "x64")\r
801 .replaceFirst("IPF", "Ipf")\r
802 .replaceFirst("IA32", "Ia32")\r
803 .replaceFirst("ARM", "Arm")\r
804 .replaceFirst("EBC", "Ebc");\r
19bf6b15 805 }\r
806 \r
807 \r
808 public void setExternalProperties(Vector<Property> v) {\r
809 this.properties = v;\r
810 }\r
878ddf1f 811}\r