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 |
14 | package org.tianocore.build;\r |
15 | \r |
a29c47e0 |
16 | import java.io.File;\r |
91f7d582 |
17 | import java.io.IOException;\r |
aca6c736 |
18 | import java.util.Hashtable;\r |
a29c47e0 |
19 | import java.util.Iterator;\r |
20 | import java.util.LinkedHashSet;\r |
21 | import java.util.Map;\r |
22 | import java.util.Set;\r |
23 | \r |
24 | import org.apache.tools.ant.BuildException;\r |
25 | import org.apache.tools.ant.Task;\r |
91f7d582 |
26 | import org.tianocore.build.exception.AutoGenException;\r |
27 | import org.tianocore.build.exception.GenBuildException;\r |
28 | import org.tianocore.build.exception.PcdAutogenException;\r |
29 | import org.tianocore.build.exception.PlatformPcdPreprocessBuildException;\r |
19bf6b15 |
30 | import org.tianocore.build.fpd.FpdParserForThread;\r |
a29c47e0 |
31 | import org.tianocore.build.fpd.FpdParserTask;\r |
c8df018e |
32 | import org.tianocore.build.global.GenBuildLogger;\r |
a29c47e0 |
33 | import org.tianocore.build.global.GlobalData;\r |
de4bb9f6 |
34 | import org.tianocore.build.toolchain.ConfigReader;\r |
a29c47e0 |
35 | import org.tianocore.build.toolchain.ToolChainInfo;\r |
4a6a5026 |
36 | import org.tianocore.common.definitions.ToolDefinitions;\r |
91f7d582 |
37 | import org.tianocore.common.exception.EdkException;\r |
c8df018e |
38 | import 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 | <FrameworkBuild type="cleanall" />\r |
70 | </pre>\r |
71 | \r |
72 | @since GenBuild 1.0\r |
73 | **/\r |
a29c47e0 |
74 | public 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 |
aca6c736 |
80 | //\r |
81 | // This is only for none-multi-thread build to reduce overriding message\r |
82 | //\r |
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 |
113 | EdkLog.setLogLevel(getProject().getProperty("env.LOGLEVEL"));\r |
114 | EdkLog.setLogger(logger);\r |
115 | \r |
91f7d582 |
116 | try {\r |
117 | processFrameworkBuild();\r |
47412835 |
118 | }catch (BuildException e) {\r |
119 | //\r |
120 | // Add more logic process here\r |
121 | //\r |
122 | throw new BuildException(e.getMessage());\r |
91f7d582 |
123 | } catch (PcdAutogenException e) {\r |
124 | //\r |
125 | // Add more logic process here\r |
126 | //\r |
127 | throw new BuildException(e.getMessage());\r |
128 | } catch (AutoGenException e) {\r |
129 | //\r |
130 | // Add more logic process here\r |
131 | //\r |
132 | throw new BuildException(e.getMessage());\r |
133 | } catch (PlatformPcdPreprocessBuildException e) {\r |
134 | //\r |
135 | // Add more logic process here\r |
136 | //\r |
137 | throw new BuildException(e.getMessage());\r |
138 | } catch (GenBuildException e) {\r |
139 | //\r |
140 | // Add more logic process here\r |
141 | //\r |
142 | throw new BuildException(e.getMessage());\r |
143 | } catch (EdkException e) {\r |
144 | //\r |
145 | // Add more logic process here\r |
146 | //\r |
147 | throw new BuildException(e.getMessage());\r |
148 | }\r |
149 | }\r |
150 | \r |
151 | private void processFrameworkBuild() throws EdkException, GenBuildException, AutoGenException, PcdAutogenException, PlatformPcdPreprocessBuildException {\r |
a29c47e0 |
152 | try {\r |
153 | //\r |
0f769af1 |
154 | // Get current working dir\r |
a29c47e0 |
155 | //\r |
156 | File dummyFile = new File(".");\r |
157 | File cwd = dummyFile.getCanonicalFile();\r |
158 | File[] files = cwd.listFiles();\r |
0f769af1 |
159 | \r |
160 | //\r |
161 | // Scan current dir, and find out all .FPD and .MSA files\r |
162 | //\r |
a29c47e0 |
163 | for (int i = 0; i < files.length; i++) {\r |
164 | if (files[i].isFile()) {\r |
0f769af1 |
165 | if (files[i].getName().endsWith(ToolDefinitions.FPD_EXTENSION)) {\r |
a29c47e0 |
166 | //\r |
0f769af1 |
167 | // Found FPD file\r |
a29c47e0 |
168 | //\r |
169 | fpdFiles.add(files[i]);\r |
4a6a5026 |
170 | } else if (files[i].getName().endsWith(ToolDefinitions.MSA_EXTENSION)) {\r |
a29c47e0 |
171 | //\r |
0f769af1 |
172 | // Found MSA file\r |
a29c47e0 |
173 | //\r |
174 | msaFiles.add(files[i]);\r |
175 | }\r |
176 | }\r |
177 | }\r |
892b0e7a |
178 | } catch (IOException ex) {\r |
179 | BuildException buildException = new BuildException("Scanning current directory error. \n" + ex.getMessage());\r |
180 | buildException.setStackTrace(ex.getStackTrace());\r |
181 | throw buildException;\r |
a29c47e0 |
182 | }\r |
183 | \r |
a29c47e0 |
184 | //\r |
0f769af1 |
185 | // Import all system environment variables to ANT properties\r |
a29c47e0 |
186 | //\r |
0f769af1 |
187 | importSystemEnvVariables();\r |
a29c47e0 |
188 | \r |
189 | //\r |
de4bb9f6 |
190 | // Read target.txt file\r |
a29c47e0 |
191 | //\r |
de4bb9f6 |
192 | readTargetFile();\r |
193 | \r |
a29c47e0 |
194 | //\r |
195 | // Global Data initialization\r |
196 | //\r |
9cf435c2 |
197 | File workspacePath = new File(getProject().getProperty("WORKSPACE"));\r |
aca6c736 |
198 | getProject().setProperty("WORKSPACE_DIR", workspacePath.getPath().replaceAll("(\\\\)", "/"));\r |
4a6a5026 |
199 | GlobalData.initInfo(dbFilename, workspacePath.getPath(), toolsDefFilename);\r |
a29c47e0 |
200 | \r |
de4bb9f6 |
201 | //\r |
202 | // If find MSA file and ACTIVE_PLATFORM is set, build the module; \r |
203 | // else fail build. \r |
204 | // If without MSA file, and ACTIVE_PLATFORM is set, build the ACTIVE_PLATFORM. \r |
205 | // If ACTIVE_PLATFORM is not set, and only find one FPD file, build the platform; \r |
0f769af1 |
206 | // If find more than one FPD files, report error. \r |
de4bb9f6 |
207 | //\r |
208 | File buildFile = null;\r |
209 | if (msaFiles.size() > 1) {\r |
0f769af1 |
210 | throw new BuildException("Found " + msaFiles.size() + " MSA files in current dir. ");\r |
4a6a5026 |
211 | } else if (msaFiles.size() == 1 && activePlatform == null) {\r |
212 | throw new BuildException("If trying to build a single module, please set ACTIVE_PLATFORM in file [" + targetFilename + "]. ");\r |
213 | } else if (msaFiles.size() == 1 && activePlatform != null) {\r |
de4bb9f6 |
214 | //\r |
215 | // Build the single module\r |
216 | //\r |
217 | buildFile = msaFiles.toArray(new File[1])[0];\r |
4a6a5026 |
218 | } else if (activePlatform != null) {\r |
de4bb9f6 |
219 | buildFile = new File(GlobalData.getWorkspacePath() + File.separatorChar + activePlatform);\r |
4a6a5026 |
220 | } else if (fpdFiles.size() == 1) {\r |
de4bb9f6 |
221 | buildFile = fpdFiles.toArray(new File[1])[0];\r |
4a6a5026 |
222 | } else if (fpdFiles.size() > 1) {\r |
0f769af1 |
223 | throw new BuildException("Found " + fpdFiles.size() + " FPD files in current dir. ");\r |
de4bb9f6 |
224 | }\r |
0f769af1 |
225 | \r |
de4bb9f6 |
226 | //\r |
227 | // If there is no build files or FPD files or MSA files, stop build\r |
228 | //\r |
229 | else {\r |
4a6a5026 |
230 | throw new BuildException("Can't find any FPD or MSA files in the current directory. ");\r |
de4bb9f6 |
231 | }\r |
232 | \r |
a29c47e0 |
233 | //\r |
234 | // Build every FPD files (PLATFORM build)\r |
235 | //\r |
4a6a5026 |
236 | if (buildFile.getName().endsWith(ToolDefinitions.FPD_EXTENSION)) {\r |
91f7d582 |
237 | EdkLog.log(this, "Processing the FPD file [" + buildFile.getPath() + "] ..>> ");\r |
19bf6b15 |
238 | //\r |
239 | // Iff for platform build will enable the multi-thread if set in target.txt\r |
240 | //\r |
241 | if (multithread && type.equalsIgnoreCase("all")) {\r |
91f7d582 |
242 | EdkLog.log(this, "Multi-thread build is enabled. ");\r |
19bf6b15 |
243 | FpdParserForThread fpdParserForThread = new FpdParserForThread();\r |
244 | fpdParserForThread.setType(type);\r |
245 | fpdParserForThread.setProject(getProject());\r |
246 | fpdParserForThread.setFpdFile(buildFile);\r |
c8df018e |
247 | fpdParserForThread.perform();\r |
19bf6b15 |
248 | return ;\r |
249 | }\r |
250 | \r |
a29c47e0 |
251 | FpdParserTask fpdParserTask = new FpdParserTask();\r |
252 | fpdParserTask.setType(type);\r |
253 | fpdParserTask.setProject(getProject());\r |
254 | fpdParserTask.setFpdFile(buildFile);\r |
c8df018e |
255 | fpdParserTask.perform();\r |
caa44816 |
256 | \r |
257 | //\r |
258 | // If cleanall delete the Platform_build.xml\r |
259 | //\r |
260 | if (type.compareTo("cleanall") == 0) {\r |
261 | File platformBuildFile = \r |
02c768ee |
262 | new File(getProject().getProperty("BUILD_DIR") \r |
caa44816 |
263 | + File.separatorChar \r |
264 | + getProject().getProperty("PLATFORM") \r |
265 | + "_build.xml");\r |
266 | platformBuildFile.deleteOnExit();\r |
267 | }\r |
a29c47e0 |
268 | }\r |
269 | \r |
270 | //\r |
271 | // Build every MSA files (SINGLE MODULE BUILD)\r |
272 | //\r |
4a6a5026 |
273 | else if (buildFile.getName().endsWith(ToolDefinitions.MSA_EXTENSION)) {\r |
d8956f14 |
274 | if (multithread) {\r |
275 | EdkLog.log(this, EdkLog.EDK_WARNING, "Multi-Thead do not take effect on Stand-Alone (Single) module build. ");\r |
276 | multithread = false;\r |
277 | }\r |
fa2da5b1 |
278 | File tmpFile = new File(GlobalData.getWorkspacePath() + File.separatorChar + activePlatform);\r |
91f7d582 |
279 | EdkLog.log(this, "Using the FPD file [" + tmpFile.getPath() + "] for the active platform. ");\r |
280 | EdkLog.log(this, "Processing the MSA file [" + buildFile.getPath() + "] ..>> ");\r |
a29c47e0 |
281 | GenBuildTask genBuildTask = new GenBuildTask();\r |
de4bb9f6 |
282 | genBuildTask.setSingleModuleBuild(true);\r |
a29c47e0 |
283 | genBuildTask.setType(type);\r |
aca6c736 |
284 | getProject().setProperty("PLATFORM_FILE", activePlatform);\r |
285 | if( !multithread) {\r |
286 | originalProperties.put("PLATFORM_FILE", activePlatform);\r |
287 | }\r |
a29c47e0 |
288 | genBuildTask.setProject(getProject());\r |
289 | genBuildTask.setMsaFile(buildFile);\r |
c8df018e |
290 | genBuildTask.perform();\r |
a29c47e0 |
291 | }\r |
292 | }\r |
293 | \r |
294 | /**\r |
0f769af1 |
295 | Import system environment variables to ANT properties. If system variable \r |
a29c47e0 |
296 | already exiests in ANT properties, skip it.\r |
297 | \r |
298 | **/\r |
0f769af1 |
299 | private void importSystemEnvVariables() {\r |
a29c47e0 |
300 | Map<String, String> sysProperties = System.getenv();\r |
aca6c736 |
301 | Iterator<String> iter = sysProperties.keySet().iterator();\r |
a29c47e0 |
302 | while (iter.hasNext()) {\r |
303 | String name = iter.next();\r |
304 | \r |
305 | //\r |
306 | // If system environment variable is not in ANT properties, add it\r |
307 | //\r |
308 | if (getProject().getProperty(name) == null) {\r |
aca6c736 |
309 | getProject().setProperty(name, sysProperties.get(name));\r |
a29c47e0 |
310 | }\r |
311 | }\r |
aca6c736 |
312 | \r |
313 | Hashtable allProperties = getProject().getProperties();\r |
314 | Iterator piter = allProperties.keySet().iterator();\r |
315 | while (piter.hasNext()) {\r |
316 | String name = (String)piter.next();\r |
317 | originalProperties.put(new String(name), new String((String)allProperties.get(name)));\r |
318 | }\r |
a29c47e0 |
319 | }\r |
320 | \r |
a29c47e0 |
321 | public void setType(String type) {\r |
322 | if (type.equalsIgnoreCase("clean") || type.equalsIgnoreCase("cleanall")) {\r |
323 | this.type = type.toLowerCase();\r |
4a6a5026 |
324 | } else {\r |
a29c47e0 |
325 | this.type = "all";\r |
326 | }\r |
327 | }\r |
de4bb9f6 |
328 | \r |
91f7d582 |
329 | private void readTargetFile() throws EdkException{\r |
330 | String targetFile = getProject().getProperty("WORKSPACE_DIR") + File.separatorChar + targetFilename;\r |
331 | \r |
332 | String[][] targetFileInfo = ConfigReader.parse(targetFile);\r |
333 | \r |
334 | //\r |
335 | // Get ToolChain Info from target.txt\r |
336 | //\r |
337 | ToolChainInfo envToolChainInfo = new ToolChainInfo(); \r |
338 | String str = getValue(ToolDefinitions.TARGET_KEY_TARGET, targetFileInfo);\r |
339 | if (str == null || str.trim().equals("")) {\r |
340 | envToolChainInfo.addTargets("*");\r |
341 | } else {\r |
342 | envToolChainInfo.addTargets(str);\r |
343 | }\r |
344 | str = getValue(ToolDefinitions.TARGET_KEY_TOOLCHAIN, targetFileInfo);\r |
345 | if (str == null || str.trim().equals("")) {\r |
346 | envToolChainInfo.addTagnames("*");\r |
347 | } else {\r |
348 | envToolChainInfo.addTagnames(str);\r |
349 | }\r |
350 | str = getValue(ToolDefinitions.TARGET_KEY_ARCH, targetFileInfo);\r |
351 | if (str == null || str.trim().equals("")) {\r |
352 | envToolChainInfo.addArchs("*");\r |
353 | } else {\r |
354 | envToolChainInfo.addArchs(str);\r |
355 | }\r |
356 | GlobalData.setToolChainEnvInfo(envToolChainInfo);\r |
357 | \r |
358 | str = getValue(ToolDefinitions.TARGET_KEY_TOOLS_DEF, targetFileInfo);\r |
359 | if (str != null && str.trim().length() > 0) {\r |
360 | toolsDefFilename = str;\r |
361 | }\r |
362 | \r |
363 | str = getValue(ToolDefinitions.TARGET_KEY_ACTIVE_PLATFORM, targetFileInfo);\r |
364 | if (str != null && ! str.trim().equals("")) {\r |
365 | if ( ! str.endsWith(".fpd")) {\r |
366 | throw new BuildException("FPD file's extension must be \"" + ToolDefinitions.FPD_EXTENSION + "\"!");\r |
19bf6b15 |
367 | }\r |
91f7d582 |
368 | activePlatform = str;\r |
369 | }\r |
370 | \r |
371 | str = getValue(ToolDefinitions.TARGET_KEY_MULTIPLE_THREAD, targetFileInfo);\r |
372 | if (str != null && str.trim().equalsIgnoreCase("Enable")) {\r |
373 | multithread = true;\r |
374 | }\r |
2eb7d78d |
375 | \r |
91f7d582 |
376 | str = getValue(ToolDefinitions.TARGET_KEY_MAX_CONCURRENT_THREAD_NUMBER, targetFileInfo);\r |
377 | if (str != null ) {\r |
378 | try {\r |
379 | int threadNum = Integer.parseInt(str);\r |
380 | if (threadNum > 0) {\r |
381 | MAX_CONCURRENT_THREAD_NUMBER = threadNum;\r |
19bf6b15 |
382 | }\r |
892b0e7a |
383 | } catch (Exception ex) {\r |
0f769af1 |
384 | //\r |
385 | // Give a warning message, and keep the default value\r |
386 | //\r |
387 | EdkLog.log(this, EdkLog.EDK_WARNING, "Incorrent number specified for MAX_CONCURRENT_THREAD_NUMBER in file [" + targetFilename + "]");\r |
19bf6b15 |
388 | }\r |
de4bb9f6 |
389 | }\r |
de4bb9f6 |
390 | }\r |
391 | \r |
392 | private String getValue(String key, String[][] map) {\r |
393 | for (int i = 0; i < map[0].length; i++){\r |
394 | if (key.equalsIgnoreCase(map[0][i])) {\r |
395 | return map[1][i];\r |
396 | }\r |
397 | }\r |
398 | return null;\r |
399 | }\r |
a29c47e0 |
400 | }\r |