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