2 This file is ANT task FpdParserTask.
4 FpdParserTask is used to parse FPD (Framework Platform Description) and generate
5 build.out.xml. It is for Package or Platform build use.
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
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.
16 package org
.tianocore
.build
.fpd
;
18 import java
.io
.BufferedWriter
;
20 import java
.io
.FileWriter
;
21 import java
.util
.HashMap
;
22 import java
.util
.Iterator
;
23 import java
.util
.LinkedHashMap
;
24 import java
.util
.LinkedHashSet
;
27 import java
.util
.Vector
;
29 import org
.apache
.tools
.ant
.BuildException
;
30 import org
.apache
.tools
.ant
.Task
;
31 import org
.apache
.tools
.ant
.taskdefs
.Ant
;
32 import org
.apache
.tools
.ant
.taskdefs
.Property
;
33 import org
.apache
.xmlbeans
.XmlObject
;
35 import org
.tianocore
.common
.definitions
.EdkDefinitions
;
36 import org
.tianocore
.common
.exception
.EdkException
;
37 import org
.tianocore
.pcd
.action
.ActionMessage
;
38 import org
.tianocore
.build
.global
.GlobalData
;
39 import org
.tianocore
.build
.global
.OutputManager
;
40 import org
.tianocore
.build
.global
.SurfaceAreaQuery
;
41 import org
.tianocore
.build
.id
.FpdModuleIdentification
;
42 import org
.tianocore
.build
.id
.ModuleIdentification
;
43 import org
.tianocore
.build
.id
.PlatformIdentification
;
44 import org
.tianocore
.build
.pcd
.action
.PlatformPcdPreprocessActionForBuilding
;
45 import org
.tianocore
.build
.toolchain
.ToolChainAttribute
;
46 import org
.tianocore
.build
.toolchain
.ToolChainElement
;
47 import org
.tianocore
.build
.toolchain
.ToolChainMap
;
50 <code>FpdParserTask</code> is an ANT task. The main function is parsing Framework
51 Platform Descritpion (FPD) XML file and generating its ANT build script for
52 corresponding platform.
54 <p>The task sets global properties PLATFORM, PLATFORM_DIR, PLATFORM_RELATIVE_DIR
57 <p>The task generates ${PLATFORM}_build.xml file which will be called by top level
58 build.xml. The task also generate Fv.inf files (File is for Tool GenFvImage). </p>
60 <p>FpdParserTask task stores all FPD information to GlobalData. And parse
61 tools definition file to set up compiler options for different Target and
62 different ToolChainTag. </p>
64 <p>The method parseFpdFile is also prepared for single module build. </p>
66 <p>The usage is (take NT32 Platform for example):</p>
69 <FPDParser platformName="Nt32" />
74 public class FpdParserTask
extends Task
{
76 private String platformName
;
78 private File fpdFile
= null;
80 PlatformIdentification platformId
;
85 /// Mapping from modules identification to out put file name
87 Map
<FpdModuleIdentification
, String
> outfiles
= new LinkedHashMap
<FpdModuleIdentification
, String
>();
90 /// Mapping from FV name to its modules
92 Map
<String
, Set
<FpdModuleIdentification
>> fvs
= new HashMap
<String
, Set
<FpdModuleIdentification
>>();
95 /// FpdParserTask can specify some ANT properties.
97 private Vector
<Property
> properties
= new Vector
<Property
>();
99 SurfaceAreaQuery saq
= null;
101 boolean isUnified
= true;
104 Public construct method. It is necessary for ANT task.
106 public FpdParserTask() {
110 ANT task's entry method. The main steps is described as following:
113 <li>Initialize global information (Framework DB, SPD files and all MSA files
114 listed in SPD). This step will execute only once in whole build process;</li>
115 <li>Parse specified FPD file; </li>
116 <li>Generate FV.inf files; </li>
117 <li>Generate PlatformName_build.xml file for Flatform build; </li>
118 <li>Collect PCD information. </li>
121 @throws BuildException
122 Surface area is not valid.
124 public void execute() throws BuildException
{
126 // If fpdFile is not specified,
127 // then try to get FPD file by platformName
129 if ( fpdFile
== null) {
130 if (platformName
== null) {
131 throw new BuildException("FpdParserTask parameter error. Please specify either the platform name or FPD file!");
133 platformId
= GlobalData
.getPlatformByName(platformName
);
134 fpdFile
= platformId
.getFpdFile();
145 isUnified
= OutputManager
.getInstance().prepareBuildDir(getProject());
148 // For every Target and ToolChain
150 String
[] targetList
= GlobalData
.getToolChainInfo().getTargets();
151 for (int i
= 0; i
< targetList
.length
; i
++) {
152 String
[] toolchainList
= GlobalData
.getToolChainInfo().getTagnames();
153 for(int j
= 0; j
< toolchainList
.length
; j
++) {
157 String ffsCommonDir
= getProject().getProperty("BUILD_DIR") + File
.separatorChar
158 + targetList
[i
] + "_"
160 File fvDir
= new File(ffsCommonDir
+ File
.separatorChar
+ "FV");
162 getProject().setProperty("FV_DIR", fvDir
.getPath().replaceAll("(\\\\)", "/"));
167 genFvInfFiles(ffsCommonDir
);
174 PlatformBuildFileGenerator fileGenerator
= new PlatformBuildFileGenerator(getProject(), outfiles
, fvs
, isUnified
, saq
);
175 fileGenerator
.genBuildFile();
178 // Ant call ${PLATFORM}_build.xml
182 ant
.setProject(getProject());
183 ant
.setAntfile(platformId
.getFpdFile().getParent() + File
.separatorChar
+ platformId
.getName() + "_build.xml");
185 ant
.setInheritAll(true);
191 Generate Fv.inf files. The Fv.inf file is composed with four
192 parts: Options, Attributes, Components and Files. The Fv.inf files
193 will be under FV_DIR.
195 @throws BuildException
196 File write FV.inf files error.
198 void genFvInfFiles(String ffsCommonDir
) throws BuildException
{
199 String
[] validFv
= saq
.getFpdValidImageNames();
200 for (int i
= 0; i
< validFv
.length
; i
++) {
202 // Get all global variables from FPD and set them to properties
204 String
[][] globalVariables
= saq
.getFpdGlobalVariable();
205 for (int j
= 0; j
< globalVariables
.length
; j
++) {
206 getProject().setProperty(globalVariables
[j
][0], globalVariables
[j
][1]);
209 getProject().setProperty("FV_FILENAME", validFv
[i
]);
211 File fvFile
= new File(getProject().replaceProperties( getProject().getProperty("FV_DIR") + File
.separatorChar
+ validFv
[i
] + ".inf"));
212 fvFile
.getParentFile().mkdirs();
215 FileWriter fw
= new FileWriter(fvFile
);
216 BufferedWriter bw
= new BufferedWriter(fw
);
221 String
[][] options
= saq
.getFpdOptions(validFv
[i
]);
222 if (options
.length
> 0) {
223 bw
.write("[options]");
225 for (int j
= 0; j
< options
.length
; j
++) {
226 StringBuffer str
= new StringBuffer(100);
227 str
.append(options
[j
][0]);
228 while (str
.length() < 40) {
232 str
.append(options
[j
][1]);
233 bw
.write(getProject().replaceProperties(str
.toString()));
242 String
[][] attributes
= saq
.getFpdAttributes(validFv
[i
]);
243 if (attributes
.length
> 0) {
244 bw
.write("[attributes]");
246 for (int j
= 0; j
< attributes
.length
; j
++) {
247 StringBuffer str
= new StringBuffer(100);
248 str
.append(attributes
[j
][0]);
249 while (str
.length() < 40) {
253 str
.append(attributes
[j
][1]);
254 bw
.write(getProject().replaceProperties(str
.toString()));
263 String
[][] components
= saq
.getFpdComponents(validFv
[i
]);
264 if (components
.length
> 0) {
265 bw
.write("[components]");
267 for (int j
= 0; j
< components
.length
; j
++) {
268 StringBuffer str
= new StringBuffer(100);
269 str
.append(components
[j
][0]);
270 while (str
.length() < 40) {
274 str
.append(components
[j
][1]);
275 bw
.write(getProject().replaceProperties(str
.toString()));
284 Set
<FpdModuleIdentification
> filesSet
= fvs
.get(validFv
[i
]);
285 if (filesSet
!= null) {
286 FpdModuleIdentification
[] files
= filesSet
.toArray(new FpdModuleIdentification
[filesSet
.size()]);
289 for (int j
= 0; j
< files
.length
; j
++) {
290 String str
= ffsCommonDir
+ File
.separatorChar
+ outfiles
.get(files
[j
]);
291 bw
.write(getProject().replaceProperties("EFI_FILE_NAME = " + str
));
298 } catch (Exception e
) {
299 throw new BuildException("Generation of the FV file [" + fvFile
.getPath() + "] failed!\n" + e
.getMessage());
304 This method is used for Single Module Build.
307 @throws BuildException
308 FPD file is not valid.
310 public void parseFpdFile(File fpdFile
) throws BuildException
{
311 this.fpdFile
= fpdFile
;
318 @throws BuildException
319 FPD file is not valid.
321 void parseFpdFile() throws BuildException
{
323 XmlObject doc
= XmlObject
.Factory
.parse(fpdFile
);
325 if (!doc
.validate()) {
326 throw new BuildException("Platform Surface Area file [" + fpdFile
.getPath() + "] format is invalid!");
329 Map
<String
, XmlObject
> map
= new HashMap
<String
, XmlObject
>();
330 map
.put("PlatformSurfaceArea", doc
);
331 saq
= new SurfaceAreaQuery(map
);
336 platformId
= saq
.getFpdHeader();
337 platformId
.setFpdFile(fpdFile
);
338 getProject().setProperty("PLATFORM", platformId
.getName());
339 getProject().setProperty("PLATFORM_FILE", platformId
.getRelativeFpdFile().replaceAll("(\\\\)", "/"));
340 getProject().setProperty("PLATFORM_DIR", platformId
.getFpdFile().getParent().replaceAll("(\\\\)", "/"));
341 getProject().setProperty("PLATFORM_RELATIVE_DIR", platformId
.getPlatformRelativeDir().replaceAll("(\\\\)", "/"));
344 // Build mode. User-defined output dir.
346 String buildMode
= saq
.getFpdIntermediateDirectories();
347 String userDefinedOutputDir
= saq
.getFpdOutputDirectory();
349 OutputManager
.getInstance().setup(userDefinedOutputDir
, buildMode
);
352 // TBD. Deal PCD and BuildOption related Info
354 GlobalData
.setFpdBuildOptions(saq
.getFpdBuildOptions());
356 GlobalData
.setToolChainPlatformInfo(saq
.getFpdToolChainInfo());
359 // Parse all list modules SA
361 parseModuleSAFiles();
364 // TBD. Deal PCD and BuildOption related Info
366 parseToolChainFamilyOptions();
367 parseToolChainOptions();
372 // Pcd Collection. Call CollectPCDAction to collect pcd info.
374 PlatformPcdPreprocessActionForBuilding ca
= new PlatformPcdPreprocessActionForBuilding();
375 ca
.perform(platformId
.getFpdFile().getPath(), ActionMessage
.NULL_MESSAGE_LEVEL
);
376 } catch (Exception e
) {
377 throw new BuildException("Parsing of the FPD file [" + fpdFile
.getPath() + "] failed!\n" + e
.getMessage());
382 Parse all modules listed in FPD file.
384 void parseModuleSAFiles() throws EdkException
{
385 Map
<FpdModuleIdentification
, Map
<String
, XmlObject
>> moduleSAs
= saq
.getFpdModules();
388 // For every Module lists in FPD file.
390 Set
<FpdModuleIdentification
> keys
= moduleSAs
.keySet();
391 Iterator iter
= keys
.iterator();
392 while (iter
.hasNext()) {
393 FpdModuleIdentification fpdModuleId
= (FpdModuleIdentification
) iter
.next();
396 // Judge if Module is existed?
398 GlobalData
.registerFpdModuleSA(fpdModuleId
, moduleSAs
.get(fpdModuleId
));
401 // Put fpdModuleId to the corresponding FV
403 saq
.push(GlobalData
.getDoc(fpdModuleId
));
404 String fvBinding
= saq
.getModuleFvBindingKeyword();
406 fpdModuleId
.setFvBinding(fvBinding
);
407 updateFvs(fvBinding
, fpdModuleId
);
410 // Prepare for out put file name
412 ModuleIdentification moduleId
= fpdModuleId
.getModule();
414 String baseName
= saq
.getModuleOutputFileBasename();
416 if (baseName
== null) {
417 baseName
= moduleId
.getName();
419 outfiles
.put(fpdModuleId
, fpdModuleId
.getArch() + File
.separatorChar
420 + moduleId
.getGuid() + "-" + baseName
421 + getSuffix(moduleId
.getModuleType()));
424 // parse module build options, if any
426 GlobalData
.addModuleToolChainOption(fpdModuleId
, parseModuleBuildOptions(false));
427 GlobalData
.addModuleToolChainFamilyOption(fpdModuleId
, parseModuleBuildOptions(true));
432 ToolChainMap
parseModuleBuildOptions(boolean toolChainFamilyFlag
) throws EdkException
{
433 String
[][] options
= saq
.getModuleBuildOptions(toolChainFamilyFlag
);
434 if (options
== null || options
.length
== 0) {
435 return new ToolChainMap();
437 return parseOptions(options
);
440 private ToolChainMap
parsePlatformBuildOptions(boolean toolChainFamilyFlag
) throws EdkException
{
441 String
[][] options
= saq
.getPlatformBuildOptions(toolChainFamilyFlag
);
442 if (options
== null || options
.length
== 0) {
443 return new ToolChainMap();
445 return parseOptions(options
);
448 private ToolChainMap
parseOptions(String
[][] options
) throws EdkException
{
449 ToolChainMap map
= new ToolChainMap();
450 int flagIndex
= ToolChainElement
.ATTRIBUTE
.value
;
452 for (int i
= 0; i
< options
.length
; ++i
) {
453 String flagString
= options
[i
][flagIndex
];
454 if (flagString
== null) {
457 options
[i
][flagIndex
] = ToolChainAttribute
.FLAGS
+ "";
458 map
.put(options
[i
], flagString
.trim());
464 private void parseToolChainFamilyOptions() throws EdkException
{
465 GlobalData
.setPlatformToolChainFamilyOption(parsePlatformBuildOptions(true));
468 private void parseToolChainOptions() throws EdkException
{
469 GlobalData
.setPlatformToolChainOption(parsePlatformBuildOptions(false));
473 Add the current module to corresponding FV.
475 @param fvName current FV name
476 @param moduleName current module identification
478 void updateFvs(String fvName
, FpdModuleIdentification fpdModuleId
) {
479 if (fvName
== null || fvName
.trim().length() == 0) {
482 String
[] fvNameArray
= fvName
.split("[, \t]+");
483 for (int i
= 0; i
< fvNameArray
.length
; i
++) {
485 // Put module to corresponding fvName
487 if (fvs
.containsKey(fvNameArray
[i
])) {
488 Set
<FpdModuleIdentification
> set
= fvs
.get(fvNameArray
[i
]);
489 set
.add(fpdModuleId
);
491 Set
<FpdModuleIdentification
> set
= new LinkedHashSet
<FpdModuleIdentification
>();
492 set
.add(fpdModuleId
);
493 fvs
.put(fvNameArray
[i
], set
);
499 Get the suffix based on module type. Current relationship are listed:
502 <b>ModuleType</b> <b>Suffix</b>
509 DXE_RUNTIME_DRIVER .DXE
514 UEFI_APPLICATION .APP
518 @param moduleType module type
520 @throws BuildException
521 If module type is null
523 public static String
getSuffix(String moduleType
) throws BuildException
{
524 if (moduleType
== null) {
525 throw new BuildException("Module type is not specified.");
528 String
[][] suffix
= EdkDefinitions
.ModuleTypeExtensions
;
530 for (int i
= 0; i
< suffix
.length
; i
++) {
531 if (suffix
[i
][0].equalsIgnoreCase(moduleType
)) {
545 public void addProperty(Property p
) {
546 properties
.addElement(p
);
549 public void setPlatformName(String platformName
) {
550 this.platformName
= platformName
;
553 public void setFpdFile(File fpdFile
) {
554 this.fpdFile
= fpdFile
;
557 public void setType(String type
) {
561 public String
getAllArchForModule(ModuleIdentification moduleId
) {
563 Iterator
<FpdModuleIdentification
> iter
= outfiles
.keySet().iterator();
564 while (iter
.hasNext()) {
565 FpdModuleIdentification fpdModuleId
= iter
.next();
567 if (fpdModuleId
.getModule().equals(moduleId
)) {
568 archs
+= fpdModuleId
.getArch() + " ";