]> git.proxmox.com Git - mirror_edk2.git/blobdiff - Tools/Java/Source/FrameworkTasks/org/tianocore/framework/tasks/GenFvImageTask.java
Restructuring for better separation of Tool packages.
[mirror_edk2.git] / Tools / Java / Source / FrameworkTasks / org / tianocore / framework / tasks / GenFvImageTask.java
diff --git a/Tools/Java/Source/FrameworkTasks/org/tianocore/framework/tasks/GenFvImageTask.java b/Tools/Java/Source/FrameworkTasks/org/tianocore/framework/tasks/GenFvImageTask.java
new file mode 100644 (file)
index 0000000..0f25032
--- /dev/null
@@ -0,0 +1,274 @@
+/** @file\r
+ GenFvImageTask class.\r
+\r
+ GenFvImageTask is to call GenFvImage.exe to generate FvImage.\r
\r
+ Copyright (c) 2006, Intel Corporation\r
+ All rights reserved. This program and the accompanying materials\r
+ are licensed and made available under the terms and conditions of the BSD License\r
+ which accompanies this distribution.  The full text of the license may be found at\r
+ http://opensource.org/licenses/bsd-license.php\r
\r
+ THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
+ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+\r
+ **/\r
+package org.tianocore.framework.tasks;\r
+\r
+import org.apache.tools.ant.BuildException;\r
+import org.apache.tools.ant.Project;\r
+import org.apache.tools.ant.Task;\r
+import org.apache.tools.ant.taskdefs.Execute;\r
+import org.apache.tools.ant.taskdefs.LogStreamHandler;\r
+import org.apache.tools.ant.types.Commandline;\r
+\r
+import java.io.File;\r
+import java.util.LinkedList;\r
+import java.util.regex.Matcher;\r
+import java.util.regex.Pattern;\r
+import java.util.List;\r
+import java.util.Iterator;\r
+import java.io.BufferedReader;\r
+import java.io.FileReader;\r
+\r
+import org.tianocore.common.logger.EdkLog;\r
+\r
+/**\r
+  GenFvImageTask\r
+  \r
+  GenFvImageTask is to call GenFvImage.exe to generate the FvImage.\r
+  \r
+**/\r
+public class GenFvImageTask extends Task implements EfiDefine{\r
+    //\r
+    // tool name\r
+    //\r
+    static final private String toolName = "GenFvImage";\r
+    //\r
+    // Pattern to match the section header (e.g. [options], [files])\r
+    // \r
+    static final private Pattern sectionHeader = Pattern.compile("\\[([^\\[\\]]+)\\]");\r
+    //\r
+    // The name of input inf file\r
+    //\r
+    private FileArg infFile = new FileArg();\r
+    //\r
+    // Output directory\r
+    //\r
+    private String outputDir = ".";\r
+\r
+    /**\r
+      execute\r
+      \r
+      GenFvImageTask execute is to assemble tool command line & execute tool\r
+      command line.\r
+    **/\r
+    public void execute() throws BuildException  {\r
+        Project project = this.getOwningTarget().getProject();\r
+        String path = project.getProperty("env.FRAMEWORK_TOOLS_PATH");\r
+\r
+        if (isUptodate()) {\r
+            EdkLog.log(this, EdkLog.EDK_VERBOSE, infFile.toFileList() + " is uptodate!");\r
+            return;\r
+        }\r
+\r
+        String command;\r
+        if (path == null) {\r
+            command = toolName;\r
+        } else {\r
+            command = path + File.separator + toolName;\r
+        }\r
+\r
+        String argument = "" + infFile;\r
+        //\r
+        // lauch the program\r
+        //\r
+        int exitCode = 0;\r
+        try {\r
+            Commandline cmdline = new Commandline();\r
+            cmdline.setExecutable(command);\r
+            cmdline.createArgument().setLine(argument);\r
+\r
+            LogStreamHandler streamHandler = new LogStreamHandler(this,\r
+                    Project.MSG_INFO, Project.MSG_WARN);\r
+            Execute runner = new Execute(streamHandler, null);\r
+\r
+            runner.setAntRun(project);\r
+            runner.setCommandline(cmdline.getCommandline());\r
+            runner.setWorkingDirectory(new File(outputDir)); \r
+            //\r
+            // log command line string.\r
+            //\r
+            EdkLog.log(this, EdkLog.EDK_VERBOSE, Commandline.toString(cmdline.getCommandline()));\r
+            EdkLog.log(this, infFile.toFileList());\r
+\r
+            exitCode = runner.execute();\r
+            if (exitCode != 0) {\r
+                EdkLog.log(this, "ERROR = " + Integer.toHexString(exitCode));\r
+            } else {\r
+                EdkLog.log(this, EdkLog.EDK_VERBOSE, "GenFvImage succeeded!");\r
+            }\r
+        } catch (Exception e) {\r
+            throw new BuildException(e.getMessage());\r
+        } finally {\r
+            if (exitCode != 0) {\r
+                throw new BuildException("GenFvImage: failed to generate FV file!");\r
+            }\r
+        }\r
+    }\r
+    /**\r
+      getInfFile\r
+      \r
+      This function is to get class member of infFile\r
+      @return String    name of infFile\r
+    **/\r
+    public String getInfFile() {\r
+        return infFile.getValue();\r
+    }\r
+    \r
+    /**\r
+      setInfFile\r
+      \r
+      This function is to set class member of infFile.\r
+      \r
+      @param infFile  name of infFile\r
+    **/\r
+    public void setInfFile(String infFile) {\r
+        this.infFile.setArg(" -I ", infFile);\r
+    }\r
+    \r
+    /**\r
+      getOutputDir\r
+      \r
+      This function is to get output directory.\r
+      \r
+      @return                Path of output directory.\r
+    **/\r
+    public String getOutputDir() {\r
+        return outputDir;\r
+    }\r
+\r
+    /**\r
+      setOutputDir\r
+      \r
+      This function is to set output directory.\r
+      \r
+      @param outputDir        The output direcotry.\r
+    **/\r
+    public void setOutputDir(String outputDir) {\r
+        this.outputDir = outputDir;\r
+    }\r
+\r
+    //\r
+    // dependency check\r
+    // \r
+    private boolean isUptodate() {\r
+        String infName = this.infFile.getValue();\r
+        String fvName = "";\r
+        List<String> ffsFiles = new LinkedList<String>();\r
+        File inf = new File(infName);\r
+\r
+        try {\r
+            FileReader reader = new FileReader(inf);\r
+            BufferedReader in = new BufferedReader(reader);\r
+            String str;\r
+\r
+            //\r
+            // Read the inf file line by line\r
+            // \r
+            boolean inFiles = false;\r
+            boolean inOptions = false;\r
+            while ((str = in.readLine()) != null) {\r
+                str = str.trim();\r
+                if (str.length() == 0) {\r
+                    continue;\r
+                }\r
+\r
+                Matcher matcher = sectionHeader.matcher(str);\r
+                if (matcher.find()) {\r
+                    //\r
+                    // We take care of only "options" and "files" section\r
+                    // \r
+                    String sectionName = str.substring(matcher.start(1), matcher.end(1));\r
+                    if (sectionName.equalsIgnoreCase("options")) {\r
+                        inOptions = true;\r
+                        inFiles = false;\r
+                    } else if (sectionName.equalsIgnoreCase("files")) {\r
+                        inFiles = true;\r
+                        inOptions = false;\r
+                    } else {\r
+                        inFiles = false;\r
+                        inOptions = false;\r
+                    }\r
+                    continue;\r
+                }\r
+\r
+                //\r
+                // skip invalid line\r
+                // \r
+                int equalMarkPos = str.indexOf("=");\r
+                if (equalMarkPos < 0) {\r
+                    continue;\r
+                }\r
+\r
+                //\r
+                // we have only interest in EFI_FILE_NAME\r
+                // \r
+                String fileNameFlag = str.substring(0, equalMarkPos).trim();\r
+                String fileName = str.substring(equalMarkPos + 1).trim();\r
+                if (!fileNameFlag.equalsIgnoreCase("EFI_FILE_NAME")\r
+                    || fileName.length() == 0) {\r
+                    continue;\r
+                }\r
+\r
+                if (inFiles) {\r
+                    //\r
+                    // files specified beneath the [files] section are source files\r
+                    // \r
+                    ffsFiles.add(fileName);\r
+                } else if (inOptions) {\r
+                    //\r
+                    // file specified beneath the [options] section is the target file\r
+                    // \r
+                    fvName = outputDir + File.separator + fileName;\r
+                }\r
+            }\r
+        } catch (Exception ex) {\r
+            throw new BuildException(ex.getMessage());\r
+        }\r
+\r
+        //\r
+        // if destionation file doesn't exist, we need to generate it.\r
+        // \r
+        File fvFile = new File(fvName);\r
+        if (!fvFile.exists()) {\r
+            EdkLog.log(this, EdkLog.EDK_VERBOSE, fvName + " doesn't exist!");\r
+            return false;\r
+        }\r
+\r
+        //\r
+        // the inf file itself will be taken as source file, check its timestamp\r
+        // against the target file\r
+        // \r
+        long fvFileTimeStamp = fvFile.lastModified();\r
+        if (inf.lastModified() > fvFileTimeStamp) {\r
+            EdkLog.log(this, EdkLog.EDK_VERBOSE, infName + " has been changed since last build!");\r
+            return false;\r
+        }\r
+\r
+        //\r
+        // no change in the inf file, we need to check each source files in it\r
+        // against the target file\r
+        // \r
+        for (Iterator it = ffsFiles.iterator(); it.hasNext(); ) {\r
+            String fileName = (String)it.next();\r
+            File file = new File(fileName);\r
+            if (file.lastModified() > fvFileTimeStamp) {\r
+                EdkLog.log(this, EdkLog.EDK_VERBOSE, fileName + " has been changed since last build!");\r
+                return false;\r
+            }\r
+        }\r
+\r
+        return true;\r
+    }\r
+}\r