Restructuring for better separation of Tool packages.
[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.BufferedReader;
17 import java.io.File;
18 import java.io.IOException;
19 import java.io.InputStreamReader;
20 import java.util.Hashtable;
21 import java.util.Iterator;
22 import java.util.LinkedHashSet;
23 import java.util.Map;
24 import java.util.Set;
25
26 import org.apache.tools.ant.BuildException;
27 import org.apache.tools.ant.Task;
28 import org.tianocore.build.exception.AutoGenException;
29 import org.tianocore.build.exception.GenBuildException;
30 import org.tianocore.build.exception.PcdAutogenException;
31 import org.tianocore.build.exception.PlatformPcdPreprocessBuildException;
32 import org.tianocore.build.fpd.FpdParserForThread;
33 import org.tianocore.build.fpd.FpdParserTask;
34 import org.tianocore.build.global.GenBuildLogger;
35 import org.tianocore.build.global.GlobalData;
36 import org.tianocore.build.toolchain.ConfigReader;
37 import org.tianocore.build.toolchain.ToolChainInfo;
38 import org.tianocore.common.definitions.ToolDefinitions;
39 import org.tianocore.common.exception.EdkException;
40 import org.tianocore.common.logger.EdkLog;
41
42 /**
43 <p>
44 <code>FrameworkBuildTask</code> is an Ant task. The main function is finding
45 and processing a FPD or MSA file, then building a platform or stand-alone
46 module.
47
48 <p>
49 The task search current directory and find out all MSA and FPD files by file
50 extension. Base on ACTIVE_PLATFORM policy, decide to build a platform or a
51 stand-alone module. The ACTIVE_PLATFORM policy is:
52
53 <pre>
54 1. More than one MSA files, report error;
55 2. Only one MSA file, but ACTIVE_PLATFORM is not specified, report error;
56 3. Only one MSA file, and ACTIVE_PLATFORM is also specified, build this module;
57 4. No MSA file, and ACTIVE_PLATFORM is specified, build the active platform;
58 5. No MSA file, no ACTIVE_PLATFORM, and no FPD file, report error;
59 6. No MSA file, no ACTIVE_PLATFORM, and only one FPD file, build the platform;
60 7. No MSA file, no ACTIVE_PLATFORM, and more than one FPD files, list all platform
61 and let user choose one.
62 </pre>
63
64 <p>
65 Framework build task also parse target file [${WORKSPACE_DIR}/Tools/Conf/target.txt].
66 And load all system environment variables to Ant properties.
67
68 <p>
69 The usage for this task is :
70
71 <pre>
72 &lt;FrameworkBuild type="cleanall" /&gt;
73 </pre>
74
75 @since GenBuild 1.0
76 **/
77 public class FrameworkBuildTask extends Task{
78
79 private Set<File> buildFiles = new LinkedHashSet<File>();
80
81 private Set<File> fpdFiles = new LinkedHashSet<File>();
82
83 private Set<File> msaFiles = new LinkedHashSet<File>();
84
85 //
86 // This is only for none-multi-thread build to reduce overriding message
87 //
88 public static Hashtable<String, String> originalProperties = new Hashtable<String, String>();
89
90 String toolsDefFilename = ToolDefinitions.DEFAULT_TOOLS_DEF_FILE_PATH;
91
92 String targetFilename = ToolDefinitions.TARGET_FILE_PATH;
93
94 String dbFilename = ToolDefinitions.FRAMEWORK_DATABASE_FILE_PATH;
95
96 String activePlatform = null;
97
98 ///
99 /// The flag to present current is multi-thread enabled
100 ///
101 public static boolean multithread = false;
102
103 ///
104 /// The concurrent thread number
105 ///
106 public static int MAX_CONCURRENT_THREAD_NUMBER = 2;
107
108 ///
109 /// there are three type: all (build), clean and cleanall
110 ///
111 private String type = "all";
112
113 public void execute() throws BuildException {
114 //
115 // set Logger
116 //
117 GenBuildLogger logger = new GenBuildLogger(getProject());
118 EdkLog.setLogLevel(getProject().getProperty("env.LOGLEVEL"));
119 EdkLog.setLogger(logger);
120
121 try {
122 processFrameworkBuild();
123 } catch (PcdAutogenException e) {
124 //
125 // Add more logic process here
126 //
127 throw new BuildException(e.getMessage());
128 } catch (AutoGenException e) {
129 //
130 // Add more logic process here
131 //
132 throw new BuildException(e.getMessage());
133 } catch (PlatformPcdPreprocessBuildException e) {
134 //
135 // Add more logic process here
136 //
137 throw new BuildException(e.getMessage());
138 } catch (GenBuildException e) {
139 //
140 // Add more logic process here
141 //
142 throw new BuildException(e.getMessage());
143 } catch (EdkException e) {
144 //
145 // Add more logic process here
146 //
147 throw new BuildException(e.getMessage());
148 }
149 }
150
151 private void processFrameworkBuild() throws EdkException, GenBuildException, AutoGenException, PcdAutogenException, PlatformPcdPreprocessBuildException {
152 //
153 // Seach build.xml -> .FPD -> .MSA file
154 //
155 try {
156 //
157 // Gen Current Working Directory
158 //
159 File dummyFile = new File(".");
160 File cwd = dummyFile.getCanonicalFile();
161 File[] files = cwd.listFiles();
162 for (int i = 0; i < files.length; i++) {
163 if (files[i].isFile()) {
164 if (files[i].getName().equalsIgnoreCase("build.xml")) {
165 //
166 // First, search build.xml, if found, ANT call it
167 //
168 buildFiles.add(files[i]);
169
170 } else if (files[i].getName().endsWith(ToolDefinitions.FPD_EXTENSION)) {
171 //
172 // Second, search FPD file, if found, build it
173 //
174 fpdFiles.add(files[i]);
175 } else if (files[i].getName().endsWith(ToolDefinitions.MSA_EXTENSION)) {
176 //
177 // Third, search MSA file, if found, build it
178 //
179 msaFiles.add(files[i]);
180 }
181 }
182 }
183 } catch (IOException ex) {
184 BuildException buildException = new BuildException("Scanning current directory error. \n" + ex.getMessage());
185 buildException.setStackTrace(ex.getStackTrace());
186 throw buildException;
187 }
188
189 //
190 // Deal with all environment variable (Add them to properties)
191 //
192 backupSystemProperties();
193
194 //
195 // Read target.txt file
196 //
197 readTargetFile();
198
199 //
200 // Global Data initialization
201 //
202 File workspacePath = new File(getProject().getProperty("WORKSPACE"));
203 getProject().setProperty("WORKSPACE_DIR", workspacePath.getPath().replaceAll("(\\\\)", "/"));
204 GlobalData.initInfo(dbFilename, workspacePath.getPath(), toolsDefFilename);
205
206 //
207 // If find MSA file and ACTIVE_PLATFORM is set, build the module;
208 // else fail build.
209 // If without MSA file, and ACTIVE_PLATFORM is set, build the ACTIVE_PLATFORM.
210 // If ACTIVE_PLATFORM is not set, and only find one FPD file, build the platform;
211 // If find more than one FPD files, let user select one.
212 //
213 File buildFile = null;
214 if (msaFiles.size() > 1) {
215 throw new BuildException("Having more than one MSA file in a directory is not allowed!");
216 } else if (msaFiles.size() == 1 && activePlatform == null) {
217 throw new BuildException("If trying to build a single module, please set ACTIVE_PLATFORM in file [" + targetFilename + "]. ");
218 } else if (msaFiles.size() == 1 && activePlatform != null) {
219 //
220 // Build the single module
221 //
222 buildFile = msaFiles.toArray(new File[1])[0];
223 } else if (activePlatform != null) {
224 buildFile = new File(GlobalData.getWorkspacePath() + File.separatorChar + activePlatform);
225 } else if (fpdFiles.size() == 1) {
226 buildFile = fpdFiles.toArray(new File[1])[0];
227 } else if (fpdFiles.size() > 1) {
228 buildFile = intercommuniteWithUser();
229 }
230 //
231 // If there is no build files or FPD files or MSA files, stop build
232 //
233 else {
234 throw new BuildException("Can't find any FPD or MSA files in the current directory. ");
235 }
236
237 //
238 // Build every FPD files (PLATFORM build)
239 //
240 if (buildFile.getName().endsWith(ToolDefinitions.FPD_EXTENSION)) {
241 EdkLog.log(this, "Processing the FPD file [" + buildFile.getPath() + "] ..>> ");
242 //
243 // Iff for platform build will enable the multi-thread if set in target.txt
244 //
245 if (multithread && type.equalsIgnoreCase("all")) {
246 EdkLog.log(this, "Multi-thread build is enabled. ");
247 FpdParserForThread fpdParserForThread = new FpdParserForThread();
248 fpdParserForThread.setType(type);
249 fpdParserForThread.setProject(getProject());
250 fpdParserForThread.setFpdFile(buildFile);
251 fpdParserForThread.perform();
252 return ;
253 }
254
255 FpdParserTask fpdParserTask = new FpdParserTask();
256 fpdParserTask.setType(type);
257 fpdParserTask.setProject(getProject());
258 fpdParserTask.setFpdFile(buildFile);
259 fpdParserTask.perform();
260
261 //
262 // If cleanall delete the Platform_build.xml
263 //
264 if (type.compareTo("cleanall") == 0) {
265 File platformBuildFile =
266 new File(getProject().getProperty("BUILD_DIR")
267 + File.separatorChar
268 + getProject().getProperty("PLATFORM")
269 + "_build.xml");
270 platformBuildFile.deleteOnExit();
271 }
272 }
273
274 //
275 // Build every MSA files (SINGLE MODULE BUILD)
276 //
277 else if (buildFile.getName().endsWith(ToolDefinitions.MSA_EXTENSION)) {
278 if (multithread) {
279 EdkLog.log(this, EdkLog.EDK_WARNING, "Multi-Thead do not take effect on Stand-Alone (Single) module build. ");
280 multithread = false;
281 }
282 File tmpFile = new File(GlobalData.getWorkspacePath() + File.separatorChar + activePlatform);
283 EdkLog.log(this, "Using the FPD file [" + tmpFile.getPath() + "] for the active platform. ");
284 EdkLog.log(this, "Processing the MSA file [" + buildFile.getPath() + "] ..>> ");
285 GenBuildTask genBuildTask = new GenBuildTask();
286 genBuildTask.setSingleModuleBuild(true);
287 genBuildTask.setType(type);
288 getProject().setProperty("PLATFORM_FILE", activePlatform);
289 if( !multithread) {
290 originalProperties.put("PLATFORM_FILE", activePlatform);
291 }
292 genBuildTask.setProject(getProject());
293 genBuildTask.setMsaFile(buildFile);
294 genBuildTask.perform();
295 }
296 }
297
298 /**
299 Transfer system environment variables to ANT properties. If system variable
300 already exiests in ANT properties, skip it.
301
302 **/
303 private void backupSystemProperties() {
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 private File intercommuniteWithUser(){
326 File file = null;
327 if (fpdFiles.size() > 1) {
328 File[] allFiles = new File[fpdFiles.size()];
329 int index = 0;
330 Iterator<File> iter = fpdFiles.iterator();
331 while (iter.hasNext()) {
332 allFiles[index] = iter.next();
333 index++;
334 }
335
336 EdkLog.log(this, "Finding " + allFiles.length + " FPD files: ");
337 for (int i = 0; i < allFiles.length; i++) {
338 System.out.println("[" + (i + 1) + "]: " + allFiles[i].getName());
339 }
340
341 boolean flag = true;
342 EdkLog.log(this, "Please select one of the following FPD files to build:[1] ");
343 do{
344 BufferedReader br = new BufferedReader(new InputStreamReader(System.in));
345 try {
346 String str = br.readLine();
347 if (str.trim().length() == 0) {
348 file = allFiles[0];
349 flag = false;
350 continue ;
351 }
352 int indexSelect = Integer.parseInt(str);
353 if (indexSelect <=0 || indexSelect > allFiles.length) {
354 EdkLog.log(this, "Please enter a number between [1.." + allFiles.length + "]:[1] ");
355 continue ;
356 } else {
357 file = allFiles[indexSelect - 1];
358 flag = false;
359 continue ;
360 }
361 } catch (Exception e) {
362 EdkLog.log(this, "Please enter a valid number:[1] ");
363 flag = true;
364 }
365 } while (flag);
366 } else if (fpdFiles.size() == 1) {
367 file = fpdFiles.toArray(new File[1])[0];
368 }
369 return file;
370 }
371
372
373 public void setType(String type) {
374 if (type.equalsIgnoreCase("clean") || type.equalsIgnoreCase("cleanall")) {
375 this.type = type.toLowerCase();
376 } else {
377 this.type = "all";
378 }
379 }
380
381 private void readTargetFile() throws EdkException{
382 String targetFile = getProject().getProperty("WORKSPACE_DIR") + File.separatorChar + targetFilename;
383
384 String[][] targetFileInfo = ConfigReader.parse(targetFile);
385
386 //
387 // Get ToolChain Info from target.txt
388 //
389 ToolChainInfo envToolChainInfo = new ToolChainInfo();
390 String str = getValue(ToolDefinitions.TARGET_KEY_TARGET, targetFileInfo);
391 if (str == null || str.trim().equals("")) {
392 envToolChainInfo.addTargets("*");
393 } else {
394 envToolChainInfo.addTargets(str);
395 }
396 str = getValue(ToolDefinitions.TARGET_KEY_TOOLCHAIN, targetFileInfo);
397 if (str == null || str.trim().equals("")) {
398 envToolChainInfo.addTagnames("*");
399 } else {
400 envToolChainInfo.addTagnames(str);
401 }
402 str = getValue(ToolDefinitions.TARGET_KEY_ARCH, targetFileInfo);
403 if (str == null || str.trim().equals("")) {
404 envToolChainInfo.addArchs("*");
405 } else {
406 envToolChainInfo.addArchs(str);
407 }
408 GlobalData.setToolChainEnvInfo(envToolChainInfo);
409
410 str = getValue(ToolDefinitions.TARGET_KEY_TOOLS_DEF, targetFileInfo);
411 if (str != null && str.trim().length() > 0) {
412 toolsDefFilename = str;
413 }
414
415 str = getValue(ToolDefinitions.TARGET_KEY_ACTIVE_PLATFORM, targetFileInfo);
416 if (str != null && ! str.trim().equals("")) {
417 if ( ! str.endsWith(".fpd")) {
418 throw new BuildException("FPD file's extension must be \"" + ToolDefinitions.FPD_EXTENSION + "\"!");
419 }
420 activePlatform = str;
421 }
422
423 str = getValue(ToolDefinitions.TARGET_KEY_MULTIPLE_THREAD, targetFileInfo);
424 if (str != null && str.trim().equalsIgnoreCase("Enable")) {
425 multithread = true;
426 }
427
428 str = getValue(ToolDefinitions.TARGET_KEY_MAX_CONCURRENT_THREAD_NUMBER, targetFileInfo);
429 if (str != null ) {
430 try {
431 int threadNum = Integer.parseInt(str);
432 if (threadNum > 0) {
433 MAX_CONCURRENT_THREAD_NUMBER = threadNum;
434 }
435 } catch (Exception ex) {
436 }
437 }
438 }
439
440 private String getValue(String key, String[][] map) {
441 for (int i = 0; i < map[0].length; i++){
442 if (key.equalsIgnoreCase(map[0][i])) {
443 return map[1][i];
444 }
445 }
446 return null;
447 }
448 }