]> git.proxmox.com Git - mirror_edk2.git/blobdiff - Tools/Source/GenBuild/org/tianocore/build/fpd/FpdParserTask.java
Add one more judgement for modulelist specified but empty.
[mirror_edk2.git] / Tools / Source / GenBuild / org / tianocore / build / fpd / FpdParserTask.java
index c044856de3674d6620973090be2004c93c8cfe78..b496e32ed5de3ea933167369a1b7573bbc15bb45 100644 (file)
@@ -18,6 +18,7 @@ package org.tianocore.build.fpd;
 import java.io.BufferedWriter;\r
 import java.io.File;\r
 import java.io.FileWriter;\r
+import java.io.IOException;\r
 import java.util.HashMap;\r
 import java.util.Iterator;\r
 import java.util.LinkedHashMap;\r
@@ -30,21 +31,28 @@ import org.apache.tools.ant.BuildException;
 import org.apache.tools.ant.Task;\r
 import org.apache.tools.ant.taskdefs.Ant;\r
 import org.apache.tools.ant.taskdefs.Property;\r
+import org.apache.xmlbeans.XmlException;\r
 import org.apache.xmlbeans.XmlObject;\r
 \r
 import org.tianocore.common.definitions.EdkDefinitions;\r
 import org.tianocore.common.exception.EdkException;\r
+import org.tianocore.common.logger.EdkLog;\r
 import org.tianocore.pcd.action.ActionMessage;\r
+import org.tianocore.build.FrameworkBuildTask;\r
 import org.tianocore.build.global.GlobalData;\r
 import org.tianocore.build.global.OutputManager;\r
 import org.tianocore.build.global.SurfaceAreaQuery;\r
 import org.tianocore.build.id.FpdModuleIdentification;\r
 import org.tianocore.build.id.ModuleIdentification;\r
+import org.tianocore.build.id.PackageIdentification;\r
 import org.tianocore.build.id.PlatformIdentification;\r
 import org.tianocore.build.pcd.action.PlatformPcdPreprocessActionForBuilding;\r
 import org.tianocore.build.toolchain.ToolChainAttribute;\r
 import org.tianocore.build.toolchain.ToolChainElement;\r
 import org.tianocore.build.toolchain.ToolChainMap;\r
+import org.w3c.dom.NamedNodeMap;\r
+import org.w3c.dom.Node;\r
+import org.w3c.dom.NodeList;\r
 \r
 /**\r
   <code>FpdParserTask</code> is an ANT task. The main function is parsing Framework\r
@@ -63,18 +71,10 @@ import org.tianocore.build.toolchain.ToolChainMap;
 \r
   <p>The method parseFpdFile is also prepared for single module build. </p>\r
 \r
-  <p>The usage is (take NT32 Platform for example):</p>\r
-\r
-  <pre>\r
-  &lt;FPDParser platformName="Nt32" /&gt;\r
-  </pre>\r
-\r
   @since GenBuild 1.0\r
 **/\r
 public class FpdParserTask extends Task {\r
 \r
-    private String platformName;\r
-\r
     private File fpdFile = null;\r
 \r
     PlatformIdentification platformId;\r
@@ -122,18 +122,8 @@ public class FpdParserTask extends Task {
      Surface area is not valid.\r
     **/\r
     public void execute() throws BuildException {\r
-        //\r
-        // If fpdFile is not specified, \r
-        // then try to get FPD file by platformName\r
-        //\r
-        if ( fpdFile == null) {\r
-            if (platformName == null) {\r
-                throw new BuildException("FpdParserTask parameter error. Please specify either the platform name or FPD file!");\r
-            }\r
-            platformId = GlobalData.getPlatformByName(platformName);\r
-            fpdFile = platformId.getFpdFile();\r
-        }\r
-\r
+        this.setTaskName("FpdParser");\r
+        \r
         //\r
         // Parse FPD file\r
         //\r
@@ -144,6 +134,7 @@ public class FpdParserTask extends Task {
         //\r
         isUnified = OutputManager.getInstance().prepareBuildDir(getProject());\r
 \r
+        String buildDir = getProject().getProperty("BUILD_DIR");\r
         //\r
         // For every Target and ToolChain\r
         //\r
@@ -154,7 +145,7 @@ public class FpdParserTask extends Task {
                 //\r
                 // Prepare FV_DIR\r
                 //\r
-                String ffsCommonDir = getProject().getProperty("BUILD_DIR") + File.separatorChar\r
+                String ffsCommonDir = buildDir + File.separatorChar\r
                                 + targetList[i] + "_"\r
                                 + toolchainList[j];\r
                 File fvDir = new File(ffsCommonDir + File.separatorChar + "FV");\r
@@ -171,16 +162,16 @@ public class FpdParserTask extends Task {
         //\r
         // Gen build.xml\r
         //\r
-        PlatformBuildFileGenerator fileGenerator = new PlatformBuildFileGenerator(getProject(), outfiles, fvs, isUnified, saq);\r
+        String platformBuildFile = buildDir + File.separatorChar + platformId.getName() + "_build.xml";\r
+        PlatformBuildFileGenerator fileGenerator = new PlatformBuildFileGenerator(getProject(), outfiles, fvs, isUnified, saq, platformBuildFile);\r
         fileGenerator.genBuildFile();\r
 \r
         //\r
         // Ant call ${PLATFORM}_build.xml\r
         //\r
-\r
         Ant ant = new Ant();\r
         ant.setProject(getProject());\r
-        ant.setAntfile(platformId.getFpdFile().getParent() + File.separatorChar + platformId.getName() + "_build.xml");\r
+        ant.setAntfile(platformBuildFile);\r
         ant.setTarget(type);\r
         ant.setInheritAll(true);\r
         ant.init();\r
@@ -209,6 +200,12 @@ public class FpdParserTask extends Task {
             getProject().setProperty("FV_FILENAME", validFv[i]);\r
 \r
             File fvFile = new File(getProject().replaceProperties( getProject().getProperty("FV_DIR") + File.separatorChar + validFv[i] + ".inf"));\r
+            if (fvFile.exists() && (fvFile.lastModified() >= fpdFile.lastModified())) {\r
+                //\r
+                // don't re-generate FV.inf if fpd has not been changed\r
+                // \r
+                continue;\r
+            }\r
             fvFile.getParentFile().mkdirs();\r
 \r
             try {\r
@@ -277,13 +274,48 @@ public class FpdParserTask extends Task {
                     }\r
                     bw.newLine();\r
                 }\r
-\r
+                \r
                 //\r
                 // Files\r
                 //\r
+                Set<FpdModuleIdentification> moduleSeqSet = getModuleSequenceForFv(validFv[i]);\r
+                \r
                 Set<FpdModuleIdentification> filesSet = fvs.get(validFv[i]);\r
-                if (filesSet != null) {\r
-                    FpdModuleIdentification[] files = filesSet.toArray(new FpdModuleIdentification[filesSet.size()]);\r
+                \r
+                FpdModuleIdentification[] files = null;\r
+                \r
+                if (moduleSeqSet == null) {\r
+                    if (filesSet != null) {\r
+                        files = filesSet.toArray(new FpdModuleIdentification[filesSet.size()]);\r
+                    }\r
+                } else if (filesSet == null) {\r
+                    if (moduleSeqSet.size() != 0) {\r
+                        throw new BuildException("Can not find any modules belongs to FV[" + validFv[i] + "], but listed some in BuildOptions.UserExtensions[@UserID='IMAGES' @Identifier='1']");\r
+                    }\r
+                } else {\r
+                    //\r
+                    // if moduleSeqSet and filesSet is inconsistent, report error\r
+                    //\r
+                    if(moduleSeqSet.size() != filesSet.size()){\r
+                        throw new BuildException("Modules for FV[" + validFv[i] + "] defined in FrameworkModules and in BuildOptions.UserExtensions[@UserID='IMAGES' @Identifier='1'] are inconsistent. ");\r
+                    } else {\r
+                        //\r
+                        // whether all modules in moduleSeqSet listed in filesSet\r
+                        //\r
+                        Iterator<FpdModuleIdentification> iter = moduleSeqSet.iterator();\r
+                        while (iter.hasNext()) {\r
+                            FpdModuleIdentification item = iter.next();\r
+                            if (!filesSet.contains(item)) {\r
+                                throw new BuildException("Can not find " + item + " belongs to FV[" + validFv[i] + "]");\r
+                            }\r
+                        }\r
+                    }\r
+                    \r
+                    files = moduleSeqSet.toArray(new FpdModuleIdentification[moduleSeqSet.size()]);\r
+                }\r
+                \r
+                \r
+                if (files != null) {\r
                     bw.write("[files]");\r
                     bw.newLine();\r
                     for (int j = 0; j < files.length; j++) {\r
@@ -295,8 +327,14 @@ public class FpdParserTask extends Task {
                 bw.flush();\r
                 bw.close();\r
                 fw.close();\r
-            } catch (Exception e) {\r
-                throw new BuildException("Generation of the FV file [" + fvFile.getPath() + "] failed!\n" + e.getMessage());\r
+            } catch (IOException ex) {\r
+                BuildException buildException = new BuildException("Generation of the FV file [" + fvFile.getPath() + "] failed!\n" + ex.getMessage());\r
+                buildException.setStackTrace(ex.getStackTrace());\r
+                throw buildException;\r
+            } catch (EdkException ex) {\r
+                BuildException buildException = new BuildException("Generation of the FV file [" + fvFile.getPath() + "] failed!\n" + ex.getMessage());\r
+                buildException.setStackTrace(ex.getStackTrace());\r
+                throw buildException;\r
             }\r
         }\r
     }\r
@@ -307,9 +345,46 @@ public class FpdParserTask extends Task {
       @throws BuildException\r
                   FPD file is not valid.\r
     **/\r
-    public void parseFpdFile(File fpdFile) throws BuildException {\r
+    public void parseFpdFile(File fpdFile) throws BuildException, EdkException {\r
         this.fpdFile = fpdFile;\r
         parseFpdFile();\r
+        \r
+        //\r
+        // Call Platform_build.xml prebuild firstly in stand-alone build\r
+        // Prepare BUILD_DIR\r
+        //\r
+        isUnified = OutputManager.getInstance().prepareBuildDir(getProject());\r
+\r
+        String buildDir = getProject().getProperty("BUILD_DIR");\r
+        //\r
+        // For every Target and ToolChain\r
+        //\r
+        String[] targetList = GlobalData.getToolChainInfo().getTargets();\r
+        for (int i = 0; i < targetList.length; i++) {\r
+            String[] toolchainList = GlobalData.getToolChainInfo().getTagnames();\r
+            for(int j = 0; j < toolchainList.length; j++) {\r
+                //\r
+                // Prepare FV_DIR\r
+                //\r
+                String ffsCommonDir = buildDir + File.separatorChar\r
+                                + targetList[i] + "_"\r
+                                + toolchainList[j];\r
+                File fvDir = new File(ffsCommonDir + File.separatorChar + "FV");\r
+                fvDir.mkdirs();\r
+            }\r
+        }\r
+\r
+        String platformBuildFile = buildDir + File.separatorChar + platformId.getName() + "_build.xml";\r
+        PlatformBuildFileGenerator fileGenerator = new PlatformBuildFileGenerator(getProject(), outfiles, fvs, isUnified, saq, platformBuildFile);\r
+        fileGenerator.genBuildFile();\r
+        \r
+        Ant ant = new Ant();\r
+        ant.setProject(getProject());\r
+        ant.setAntfile(platformBuildFile);\r
+        ant.setTarget("prebuild");\r
+        ant.setInheritAll(true);\r
+        ant.init();\r
+        ant.execute();\r
     }\r
 \r
     /**\r
@@ -339,6 +414,13 @@ public class FpdParserTask extends Task {
             getProject().setProperty("PLATFORM_FILE", platformId.getRelativeFpdFile().replaceAll("(\\\\)", "/"));\r
             getProject().setProperty("PLATFORM_DIR", platformId.getFpdFile().getParent().replaceAll("(\\\\)", "/"));\r
             getProject().setProperty("PLATFORM_RELATIVE_DIR", platformId.getPlatformRelativeDir().replaceAll("(\\\\)", "/"));\r
+            \r
+            if( !FrameworkBuildTask.multithread) {\r
+                FrameworkBuildTask.originalProperties.put("PLATFORM", platformId.getName());\r
+                FrameworkBuildTask.originalProperties.put("PLATFORM_FILE", platformId.getRelativeFpdFile().replaceAll("(\\\\)", "/"));\r
+                FrameworkBuildTask.originalProperties.put("PLATFORM_DIR", platformId.getFpdFile().getParent().replaceAll("(\\\\)", "/"));\r
+                FrameworkBuildTask.originalProperties.put("PLATFORM_RELATIVE_DIR", platformId.getPlatformRelativeDir().replaceAll("(\\\\)", "/"));\r
+            }\r
 \r
             //\r
             // Build mode. User-defined output dir.\r
@@ -373,8 +455,18 @@ public class FpdParserTask extends Task {
             //\r
             PlatformPcdPreprocessActionForBuilding ca = new PlatformPcdPreprocessActionForBuilding();\r
             ca.perform(platformId.getFpdFile().getPath(), ActionMessage.NULL_MESSAGE_LEVEL);\r
-        } catch (Exception e) {\r
-            throw new BuildException("Parsing of the FPD file [" + fpdFile.getPath() + "] failed!\n" + e.getMessage());\r
+        } catch (IOException ex) {\r
+            BuildException buildException = new BuildException("Parsing of the FPD file [" + fpdFile.getPath() + "] failed!\n" + ex.getMessage());\r
+            buildException.setStackTrace(ex.getStackTrace());\r
+            throw buildException;\r
+        } catch (XmlException ex) {\r
+            BuildException buildException = new BuildException("Parsing of the FPD file [" + fpdFile.getPath() + "] failed!\n" + ex.getMessage());\r
+            buildException.setStackTrace(ex.getStackTrace());\r
+            throw buildException;\r
+        } catch (EdkException ex) {\r
+            BuildException buildException = new BuildException("Parsing of the FPD file [" + fpdFile.getPath() + "] failed!\n" + ex.getMessage());\r
+            buildException.setStackTrace(ex.getStackTrace());\r
+            throw buildException;\r
         }\r
     }\r
 \r
@@ -546,10 +638,6 @@ public class FpdParserTask extends Task {
         properties.addElement(p);\r
     }\r
 \r
-    public void setPlatformName(String platformName) {\r
-        this.platformName = platformName;\r
-    }\r
-\r
     public void setFpdFile(File fpdFile) {\r
         this.fpdFile = fpdFile;\r
     }\r
@@ -571,4 +659,99 @@ public class FpdParserTask extends Task {
         \r
         return archs;\r
     }\r
+    \r
+    private Set<FpdModuleIdentification> getModuleSequenceForFv(String fvName) throws EdkException {\r
+        Node node = saq.getFpdModuleSequence(fvName);\r
+        Set<FpdModuleIdentification> result = new LinkedHashSet<FpdModuleIdentification>();\r
+        \r
+        if ( node == null) {\r
+            EdkLog.log(this, EdkLog.EDK_WARNING, "FV[" + fvName + "] does not specify module sequence in FPD. Assuming present sequence as default sequence in FV. ");\r
+            return null;\r
+        } else {\r
+            NodeList childNodes = node.getChildNodes();\r
+            for (int i = 0; i < childNodes.getLength(); i++) {\r
+                Node childItem = childNodes.item(i);\r
+                if (childItem.getNodeType() == Node.ELEMENT_NODE) {\r
+                    //\r
+                    // Find child elements "IncludeModules"\r
+                    //\r
+                    if (childItem.getNodeName().compareTo("IncludeModules") == 0) {\r
+                        //\r
+                        // result will be updated\r
+                        //\r
+                        processNodes(childItem, result);\r
+                    } else if (childItem.getNodeName().compareTo("FvName") == 0) {\r
+                        \r
+                    } else if (childItem.getNodeName().compareTo("InfFileName") == 0) {\r
+                        \r
+                    } else {\r
+                        //\r
+                        // Report Warning\r
+                        //\r
+                        EdkLog.log(this, EdkLog.EDK_WARNING, "Unrecognised element " + childItem.getNodeName() + " under FPD.BuildOptions.UserExtensions[UserID='IMAGES' Identifier='1']");\r
+                    }\r
+                }\r
+            }\r
+        }\r
+        \r
+        return result;\r
+    }\r
+    \r
+    private void processNodes(Node node, Set<FpdModuleIdentification> result) throws EdkException {\r
+        //\r
+        // Found out all elements "Module"\r
+        //\r
+        NodeList childNodes = node.getChildNodes();\r
+        for (int j = 0; j < childNodes.getLength(); j++) {\r
+            Node childItem = childNodes.item(j);\r
+            if (childItem.getNodeType() == Node.ELEMENT_NODE) {\r
+                if (childItem.getNodeName().compareTo("Module") == 0) {\r
+                    String moduleGuid = null;\r
+                    String moduleVersion = null;\r
+                    String packageGuid = null;\r
+                    String packageVersion = null;\r
+                    String arch = null;\r
+                    \r
+                    NamedNodeMap attr = childItem.getAttributes();\r
+                    for (int i = 0; i < attr.getLength(); i++) {\r
+                        Node attrItem = attr.item(i);\r
+                        if (attrItem.getNodeName().compareTo("ModuleGuid") == 0) {\r
+                            moduleGuid = attrItem.getNodeValue();\r
+                        } else if (attrItem.getNodeName().compareTo("ModuleVersion") == 0) {\r
+                            moduleVersion = attrItem.getNodeValue();\r
+                        } else if (attrItem.getNodeName().compareTo("PackageGuid") == 0) {\r
+                            packageGuid = attrItem.getNodeValue();\r
+                        } else if (attrItem.getNodeName().compareTo("PackageVersion") == 0) {\r
+                            packageVersion = attrItem.getNodeValue();\r
+                        } else if (attrItem.getNodeName().compareTo("Arch") == 0) {\r
+                            arch = attrItem.getNodeValue();\r
+                        } else {\r
+                            //\r
+                            // Report warning\r
+                            //\r
+                            EdkLog.log(this, EdkLog.EDK_WARNING, "Unrecognised attribute " + attrItem.getNodeName() + " under FPD.BuildOptions.UserExtensions[UserID='IMAGES' Identifier='1'].IncludeModules.Module");\r
+                        }\r
+                    }\r
+                    \r
+                    PackageIdentification packageId = new PackageIdentification(packageGuid, packageVersion);\r
+                    GlobalData.refreshPackageIdentification(packageId);\r
+                    \r
+                    ModuleIdentification moduleId = new ModuleIdentification(moduleGuid, moduleVersion);\r
+                    moduleId.setPackage(packageId);\r
+                    GlobalData.refreshModuleIdentification(moduleId);\r
+                    \r
+                    if (arch == null) {\r
+                        throw new EdkException("Attribute [Arch] is required for element FPD.BuildOptions.UserExtensions[UserID='IMAGES' Identifier='1'].IncludeModules.Module. ");\r
+                    }\r
+                    \r
+                    result.add(new FpdModuleIdentification(moduleId, arch));\r
+                } else {\r
+                    //\r
+                    // Report Warning\r
+                    //\r
+                    EdkLog.log(this, EdkLog.EDK_WARNING, "Unrecognised element " + childItem.getNodeName() + " under FPD.BuildOptions.UserExtensions[UserID='IMAGES' Identifier='1'].IncludeModules");\r
+                }\r
+            }\r
+        }\r
+    }\r
 }\r