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