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