Fixed EDKT482. Added support for multiple msa files in the same directory.
[mirror_edk2.git] / Tools / Java / Source / GenBuild / org / tianocore / build / FrameworkBuildTask.java
1 /** @file FrameworkBuildTask.java
2
3 The file is ANT task to find MSA or FPD file and build them.
4
5 Copyright (c) 2006, Intel Corporation
6 All rights reserved. This program and the accompanying materials
7 are licensed and made available under the terms and conditions of the BSD License
8 which accompanies this distribution. The full text of the license may be found at
9 http://opensource.org/licenses/bsd-license.php
10
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
13 **/
14 package org.tianocore.build;
15
16 import java.io.File;
17 import java.io.IOException;
18 import java.util.Hashtable;
19 import java.util.Iterator;
20 import java.util.LinkedHashSet;
21 import java.util.Map;
22 import java.util.Set;
23
24 import org.apache.tools.ant.BuildException;
25 import org.apache.tools.ant.Task;
26 import org.tianocore.build.exception.AutoGenException;
27 import org.tianocore.build.exception.GenBuildException;
28 import org.tianocore.build.exception.PcdAutogenException;
29 import org.tianocore.build.exception.PlatformPcdPreprocessBuildException;
30 import org.tianocore.build.fpd.FpdParserForThread;
31 import org.tianocore.build.fpd.FpdParserTask;
32 import org.tianocore.build.global.GenBuildLogger;
33 import org.tianocore.build.global.GlobalData;
34 import org.tianocore.build.toolchain.ConfigReader;
35 import org.tianocore.build.toolchain.ToolChainInfo;
36 import org.tianocore.common.definitions.ToolDefinitions;
37 import org.tianocore.common.exception.EdkException;
38 import org.tianocore.common.logger.EdkLog;
39
40 /**
41 <p>
42 <code>FrameworkBuildTask</code> is an Ant task. The main function is finding
43 and processing a FPD or MSA file, then building a platform or stand-alone
44 module.
45
46 <p>
47 The task search current directory and find out all MSA and FPD files by file
48 extension. Base on ACTIVE_PLATFORM policy, decide to build a platform or a
49 stand-alone module. The ACTIVE_PLATFORM policy is:
50
51 <pre>
52 1. More than one MSA files, report error;
53 2. Only one MSA file, but ACTIVE_PLATFORM is not specified, report error;
54 3. Only one MSA file, and ACTIVE_PLATFORM is also specified, build this module;
55 4. No MSA file, and ACTIVE_PLATFORM is specified, build the active platform;
56 5. No MSA file, no ACTIVE_PLATFORM, and no FPD file, report error;
57 6. No MSA file, no ACTIVE_PLATFORM, and only one FPD file, build the platform;
58 7. No MSA file, no ACTIVE_PLATFORM, and more than one FPD files, Report Error!
59 </pre>
60
61 <p>
62 Framework build task also parse target file [${WORKSPACE_DIR}/Tools/Conf/target.txt].
63 And load all system environment variables to Ant properties.
64
65 <p>
66 The usage for this task is :
67
68 <pre>
69 &lt;FrameworkBuild type="cleanall" /&gt;
70 </pre>
71
72 @since GenBuild 1.0
73 **/
74 public class FrameworkBuildTask extends Task{
75
76 private Set<File> fpdFiles = new LinkedHashSet<File>();
77
78 private Set<File> msaFiles = new LinkedHashSet<File>();
79
80 ///
81 /// This is only for none-multi-thread build to reduce overriding message
82 ///
83 public static Hashtable<String, String> originalProperties = new Hashtable<String, String>();
84
85 String toolsDefFilename = ToolDefinitions.DEFAULT_TOOLS_DEF_FILE_PATH;
86
87 String targetFilename = ToolDefinitions.TARGET_FILE_PATH;
88
89 String dbFilename = ToolDefinitions.FRAMEWORK_DATABASE_FILE_PATH;
90
91 String activePlatform = null;
92
93 ///
94 /// The flag to present current is multi-thread enabled
95 ///
96 public static boolean multithread = false;
97
98 ///
99 /// The concurrent thread number
100 ///
101 public static int MAX_CONCURRENT_THREAD_NUMBER = 2;
102
103 ///
104 /// there are three type: all (build), clean and cleanall
105 ///
106 private String type = "all";
107
108 public void execute() throws BuildException {
109 //
110 // set Logger
111 //
112 GenBuildLogger logger = new GenBuildLogger(getProject());
113 EdkLog.setLogLevel(EdkLog.EDK_DEBUG);
114 EdkLog.setLogLevel(getProject().getProperty("env.LOGLEVEL"));
115 EdkLog.setLogger(logger);
116
117 try {
118 processFrameworkBuild();
119 }catch (BuildException e) {
120 //
121 // Add more logic process here
122 //
123 throw new BuildException(e.getMessage());
124 } catch (PcdAutogenException e) {
125 //
126 // Add more logic process here
127 //
128 throw new BuildException(e.getMessage());
129 } catch (AutoGenException e) {
130 //
131 // Add more logic process here
132 //
133 throw new BuildException(e.getMessage());
134 } catch (PlatformPcdPreprocessBuildException e) {
135 //
136 // Add more logic process here
137 //
138 throw new BuildException(e.getMessage());
139 } catch (GenBuildException e) {
140 //
141 // Add more logic process here
142 //
143 throw new BuildException(e.getMessage());
144 } catch (EdkException e) {
145 //
146 // Add more logic process here
147 //
148 throw new BuildException(e.getMessage());
149 }
150 }
151
152 private void processFrameworkBuild() throws EdkException, GenBuildException, AutoGenException, PcdAutogenException, PlatformPcdPreprocessBuildException {
153 try {
154 //
155 // Get current working dir
156 //
157 File dummyFile = new File(".");
158 File cwd = dummyFile.getCanonicalFile();
159 File[] files = cwd.listFiles();
160
161 //
162 // Scan current dir, and find out all .FPD and .MSA files
163 //
164 for (int i = 0; i < files.length; i++) {
165 if (files[i].isFile()) {
166 if (files[i].getName().endsWith(ToolDefinitions.FPD_EXTENSION)) {
167 //
168 // Found FPD file
169 //
170 fpdFiles.add(files[i]);
171 } else if (files[i].getName().endsWith(ToolDefinitions.MSA_EXTENSION)) {
172 //
173 // Found MSA file
174 //
175 msaFiles.add(files[i]);
176 }
177 }
178 }
179 } catch (IOException ex) {
180 BuildException buildException = new BuildException("Scanning current directory error. \n" + ex.getMessage());
181 buildException.setStackTrace(ex.getStackTrace());
182 throw buildException;
183 }
184
185 //
186 // Import all system environment variables to ANT properties
187 //
188 importSystemEnvVariables();
189
190 //
191 // Read target.txt file
192 //
193 readTargetFile();
194
195 //
196 // Global Data initialization
197 //
198 File workspacePath = new File(getProject().getProperty("WORKSPACE"));
199 getProject().setProperty("WORKSPACE_DIR", workspacePath.getPath().replaceAll("(\\\\)", "/"));
200 GlobalData.initInfo(dbFilename, workspacePath.getPath(), toolsDefFilename);
201
202 //
203 // If find MSA file and ACTIVE_PLATFORM is set, build the module;
204 // else fail build.
205 // If without MSA file, and ACTIVE_PLATFORM is set, build the ACTIVE_PLATFORM.
206 // If ACTIVE_PLATFORM is not set, and only find one FPD file, build the platform;
207 // If find more than one FPD files, report error.
208 //
209 File buildFile = null;
210 if (msaFiles.size() > 0) {
211 if (activePlatform == null) {
212 throw new BuildException("If trying to build a single module, please set ACTIVE_PLATFORM in file [" + targetFilename + "]. ");
213 }
214 //
215 // Build the single module
216 //
217 buildFile = msaFiles.toArray(new File[1])[0];
218 } else if (activePlatform != null) {
219 buildFile = new File(GlobalData.getWorkspacePath() + File.separatorChar + activePlatform);
220 } else if (fpdFiles.size() == 1) {
221 buildFile = fpdFiles.toArray(new File[1])[0];
222 } else if (fpdFiles.size() > 1) {
223 throw new BuildException("Found " + fpdFiles.size() + " FPD files in current dir. ");
224 }
225
226 //
227 // If there is no build files or FPD files or MSA files, stop build
228 //
229 else {
230 throw new BuildException("Can't find any FPD or MSA files in the current directory. ");
231 }
232
233 //
234 // Build every FPD files (PLATFORM build)
235 //
236 if (buildFile.getName().endsWith(ToolDefinitions.FPD_EXTENSION)) {
237 EdkLog.log(this, "Processing the FPD file [" + buildFile.getPath() + "] ..>> ");
238 //
239 // Iff for platform build will enable the multi-thread if set in target.txt
240 //
241 if (multithread && type.equalsIgnoreCase("all")) {
242 EdkLog.log(this, "Multi-thread build is enabled. ");
243 FpdParserForThread fpdParserForThread = new FpdParserForThread();
244 fpdParserForThread.setType(type);
245 fpdParserForThread.setProject(getProject());
246 fpdParserForThread.setFpdFile(buildFile);
247 fpdParserForThread.perform();
248 return ;
249 }
250
251 FpdParserTask fpdParserTask = new FpdParserTask();
252 fpdParserTask.setType(type);
253 fpdParserTask.setProject(getProject());
254 fpdParserTask.setFpdFile(buildFile);
255 fpdParserTask.perform();
256
257 //
258 // If cleanall delete the Platform_build.xml
259 //
260 if (type.compareTo("cleanall") == 0) {
261 File platformBuildFile =
262 new File(getProject().getProperty("BUILD_DIR")
263 + File.separatorChar
264 + getProject().getProperty("PLATFORM")
265 + "_build.xml");
266 platformBuildFile.deleteOnExit();
267 }
268 }
269
270 //
271 // Build every MSA files (SINGLE MODULE BUILD)
272 //
273 else if (buildFile.getName().endsWith(ToolDefinitions.MSA_EXTENSION)) {
274 if (multithread) {
275 EdkLog.log(this, EdkLog.EDK_WARNING, "Multi-Thead do not take effect on Stand-Alone (Single) module build. ");
276 multithread = false;
277 }
278 File tmpFile = new File(GlobalData.getWorkspacePath() + File.separatorChar + activePlatform);
279 EdkLog.log(this, "Using the FPD file [" + tmpFile.getPath() + "] for the active platform. ");
280
281 File[] moduleFiles = msaFiles.toArray(new File[msaFiles.size()]);
282 for (int i = 0; i < moduleFiles.length; ++i) {
283 EdkLog.log(this, "Processing the MSA file [" + moduleFiles[i].getPath() + "] ..>> ");
284 GenBuildTask genBuildTask = new GenBuildTask();
285 genBuildTask.setSingleModuleBuild(true);
286 genBuildTask.setType(type);
287 getProject().setProperty("PLATFORM_FILE", activePlatform);
288 if( !multithread) {
289 originalProperties.put("PLATFORM_FILE", activePlatform);
290 }
291 genBuildTask.setProject(getProject());
292 genBuildTask.setMsaFile(moduleFiles[i]);
293 genBuildTask.perform();
294 }
295 }
296 }
297
298 /**
299 Import system environment variables to ANT properties. If system variable
300 already exiests in ANT properties, skip it.
301
302 **/
303 private void importSystemEnvVariables() {
304 Map<String, String> sysProperties = System.getenv();
305 Iterator<String> iter = sysProperties.keySet().iterator();
306 while (iter.hasNext()) {
307 String name = iter.next();
308
309 //
310 // If system environment variable is not in ANT properties, add it
311 //
312 if (getProject().getProperty(name) == null) {
313 getProject().setProperty(name, sysProperties.get(name));
314 }
315 }
316
317 Hashtable allProperties = getProject().getProperties();
318 Iterator piter = allProperties.keySet().iterator();
319 while (piter.hasNext()) {
320 String name = (String)piter.next();
321 originalProperties.put(new String(name), new String((String)allProperties.get(name)));
322 }
323 }
324
325 public void setType(String type) {
326 if (type.equalsIgnoreCase("clean") || type.equalsIgnoreCase("cleanall")) {
327 this.type = type.toLowerCase();
328 } else {
329 this.type = "all";
330 }
331 }
332
333 private void readTargetFile() throws EdkException{
334 String targetFile = getProject().getProperty("WORKSPACE_DIR") + File.separatorChar + targetFilename;
335
336 String[][] targetFileInfo = ConfigReader.parse(targetFile);
337
338 //
339 // Get ToolChain Info from target.txt
340 //
341 ToolChainInfo envToolChainInfo = new ToolChainInfo();
342 String str = getValue(ToolDefinitions.TARGET_KEY_TARGET, targetFileInfo);
343 if (str == null || str.trim().equals("")) {
344 envToolChainInfo.addTargets("*");
345 } else {
346 envToolChainInfo.addTargets(str);
347 }
348 str = getValue(ToolDefinitions.TARGET_KEY_TOOLCHAIN, targetFileInfo);
349 if (str == null || str.trim().equals("")) {
350 envToolChainInfo.addTagnames("*");
351 } else {
352 envToolChainInfo.addTagnames(str);
353 }
354 str = getValue(ToolDefinitions.TARGET_KEY_ARCH, targetFileInfo);
355 if (str == null || str.trim().equals("")) {
356 envToolChainInfo.addArchs("*");
357 } else {
358 envToolChainInfo.addArchs(str);
359 }
360 GlobalData.setToolChainEnvInfo(envToolChainInfo);
361
362 str = getValue(ToolDefinitions.TARGET_KEY_TOOLS_DEF, targetFileInfo);
363 if (str != null && str.trim().length() > 0) {
364 toolsDefFilename = str;
365 }
366
367 str = getValue(ToolDefinitions.TARGET_KEY_ACTIVE_PLATFORM, targetFileInfo);
368 if (str != null && ! str.trim().equals("")) {
369 if ( ! str.endsWith(".fpd")) {
370 throw new BuildException("FPD file's extension must be \"" + ToolDefinitions.FPD_EXTENSION + "\"!");
371 }
372 activePlatform = str;
373 }
374
375 str = getValue(ToolDefinitions.TARGET_KEY_MULTIPLE_THREAD, targetFileInfo);
376 if (str != null && str.trim().equalsIgnoreCase("Enable")) {
377 multithread = true;
378 }
379
380 str = getValue(ToolDefinitions.TARGET_KEY_MAX_CONCURRENT_THREAD_NUMBER, targetFileInfo);
381 //
382 // Need to check the # of threads iff multithread is enabled.
383 //
384 if ((multithread) && (str != null )) {
385 try {
386 int threadNum = Integer.parseInt(str);
387 if (threadNum > 0) {
388 MAX_CONCURRENT_THREAD_NUMBER = threadNum;
389 }
390 } catch (Exception ex) {
391 //
392 // Give a warning message, and keep the default value
393 //
394 EdkLog.log(this, EdkLog.EDK_WARNING, "Incorrent number specified for MAX_CONCURRENT_THREAD_NUMBER in file [" + targetFilename + "]");
395 }
396 }
397 }
398
399 private String getValue(String key, String[][] map) {
400 for (int i = 0; i < map[0].length; i++){
401 if (key.equalsIgnoreCase(map[0][i])) {
402 return map[1][i];
403 }
404 }
405 return null;
406 }
407 }