[mirror_edk2.git] / Tools / Source / GenBuild / org / tianocore / build / fpd / FpdParserTask.java

/** @file\r
 This file is ANT task FpdParserTask.\r
\r
 FpdParserTask is used to parse FPD (Framework Platform Description) and generate\r
 build.out.xml. It is for Package or Platform build use.\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
package org.tianocore.build.fpd;\r
\r
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
import java.util.LinkedHashSet;\r
import java.util.Map;\r
import java.util.Set;\r
import java.util.Vector;\r
\r
import org.apache.tools.ant.BuildException;\r
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.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.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
\r
/**\r
  <code>FpdParserTask</code> is an ANT task. The main function is parsing Framework\r
  Platform Descritpion (FPD) XML file and generating its ANT build script for\r
  corresponding platform.\r
\r
  <p>The task sets global properties PLATFORM, PLATFORM_DIR, PLATFORM_RELATIVE_DIR\r
  and BUILD_DIR. </p>\r
\r
  <p>The task generates ${PLATFORM}_build.xml file which will be called by top level\r
  build.xml. The task also generate Fv.inf files (File is for Tool GenFvImage). </p>\r
\r
  <p>FpdParserTask task stores all FPD information to GlobalData. And parse\r
  tools definition file to set up compiler options for different Target and\r
  different ToolChainTag. </p>\r
\r
  <p>The method parseFpdFile is also prepared for single module build. </p>\r
\r
  @since GenBuild 1.0\r
**/\r
public class FpdParserTask extends Task {\r
\r
    private File fpdFile = null;\r
\r
    PlatformIdentification platformId;\r
\r
    private String type;\r
\r
    ///\r
    /// Mapping from modules identification to out put file name\r
    ///\r
    Map<FpdModuleIdentification, String> outfiles = new LinkedHashMap<FpdModuleIdentification, String>();\r
\r
    ///\r
    /// Mapping from FV name to its modules\r
    ///\r
    Map<String, Set<FpdModuleIdentification>> fvs = new HashMap<String, Set<FpdModuleIdentification>>();\r
\r
    ///\r
    /// FpdParserTask can specify some ANT properties.\r
    ///\r
    private Vector<Property> properties = new Vector<Property>();\r
\r
    SurfaceAreaQuery saq = null;\r
    \r
    boolean isUnified = true;\r
\r
    /**\r
      Public construct method. It is necessary for ANT task.\r
    **/\r
    public FpdParserTask() {\r
    }\r
\r
    /**\r
     ANT task's entry method. The main steps is described as following:\r
\r
     <ul>\r
     <li>Initialize global information (Framework DB, SPD files and all MSA files\r
     listed in SPD). This step will execute only once in whole build process;</li>\r
     <li>Parse specified FPD file; </li>\r
     <li>Generate FV.inf files; </li>\r
     <li>Generate PlatformName_build.xml file for Flatform build; </li>\r
     <li>Collect PCD information. </li>\r
     </ul>\r
\r
     @throws BuildException\r
     Surface area is not valid.\r
    **/\r
    public void execute() throws BuildException {\r
        //\r
        // Parse FPD file\r
        //\r
        parseFpdFile();\r
\r
        //\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
                getProject().setProperty("FV_DIR", fvDir.getPath().replaceAll("(\\\\)", "/"));\r
\r
                //\r
                // Gen Fv.inf files\r
                //\r
                genFvInfFiles(ffsCommonDir);\r
            }\r
        }\r
\r
        //\r
        // Gen build.xml\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
        //\r
        // Ant call ${PLATFORM}_build.xml\r
        //\r
        Ant ant = new Ant();\r
        ant.setProject(getProject());\r
        ant.setAntfile(platformBuildFile);\r
        ant.setTarget(type);\r
        ant.setInheritAll(true);\r
        ant.init();\r
        ant.execute();\r
    }\r
\r
    /**\r
      Generate Fv.inf files. The Fv.inf file is composed with four\r
      parts: Options, Attributes, Components and Files. The Fv.inf files\r
      will be under FV_DIR.\r
\r
      @throws BuildException\r
                  File write FV.inf files error.\r
    **/\r
    void genFvInfFiles(String ffsCommonDir) throws BuildException {\r
        String[] validFv = saq.getFpdValidImageNames();\r
        for (int i = 0; i < validFv.length; i++) {\r
            //\r
            // Get all global variables from FPD and set them to properties\r
            //\r
            String[][] globalVariables = saq.getFpdGlobalVariable();\r
            for (int j = 0; j < globalVariables.length; j++) {\r
                getProject().setProperty(globalVariables[j][0], globalVariables[j][1]);\r
            }\r
\r
            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
                FileWriter fw = new FileWriter(fvFile);\r
                BufferedWriter bw = new BufferedWriter(fw);\r
\r
                //\r
                // Options\r
                //\r
                String[][] options = saq.getFpdOptions(validFv[i]);\r
                if (options.length > 0) {\r
                    bw.write("[options]");\r
                    bw.newLine();\r
                    for (int j = 0; j < options.length; j++) {\r
                        StringBuffer str = new StringBuffer(100);\r
                        str.append(options[j][0]);\r
                        while (str.length() < 40) {\r
                            str.append(' ');\r
                        }\r
                        str.append("=  ");\r
                        str.append(options[j][1]);\r
                        bw.write(getProject().replaceProperties(str.toString()));\r
                        bw.newLine();\r
                    }\r
                    bw.newLine();\r
                }\r
\r
                //\r
                // Attributes;\r
                //\r
                String[][] attributes = saq.getFpdAttributes(validFv[i]);\r
                if (attributes.length > 0) {\r
                    bw.write("[attributes]");\r
                    bw.newLine();\r
                    for (int j = 0; j < attributes.length; j++) {\r
                        StringBuffer str = new StringBuffer(100);\r
                        str.append(attributes[j][0]);\r
                        while (str.length() < 40) {\r
                            str.append(' ');\r
                        }\r
                        str.append("=  ");\r
                        str.append(attributes[j][1]);\r
                        bw.write(getProject().replaceProperties(str.toString()));\r
                        bw.newLine();\r
                    }\r
                    bw.newLine();\r
                }\r
\r
                //\r
                // Components\r
                //\r
                String[][] components = saq.getFpdComponents(validFv[i]);\r
                if (components.length > 0) {\r
                    bw.write("[components]");\r
                    bw.newLine();\r
                    for (int j = 0; j < components.length; j++) {\r
                        StringBuffer str = new StringBuffer(100);\r
                        str.append(components[j][0]);\r
                        while (str.length() < 40) {\r
                            str.append(' ');\r
                        }\r
                        str.append("=  ");\r
                        str.append(components[j][1]);\r
                        bw.write(getProject().replaceProperties(str.toString()));\r
                        bw.newLine();\r
                    }\r
                    bw.newLine();\r
                }\r
\r
                //\r
                // Files\r
                //\r
                Set<FpdModuleIdentification> filesSet = fvs.get(validFv[i]);\r
                if (filesSet != null) {\r
                    FpdModuleIdentification[] files = filesSet.toArray(new FpdModuleIdentification[filesSet.size()]);\r
                    bw.write("[files]");\r
                    bw.newLine();\r
                    for (int j = 0; j < files.length; j++) {\r
                        String str = ffsCommonDir + File.separatorChar + outfiles.get(files[j]);\r
                        bw.write(getProject().replaceProperties("EFI_FILE_NAME = " + str));\r
                        bw.newLine();\r
                    }\r
                }\r
                bw.flush();\r
                bw.close();\r
                fw.close();\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
            }\r
        }\r
    }\r
    /**\r
      This method is used for Single Module Build.\r
\r
\r
      @throws BuildException\r
                  FPD file is not valid.\r
    **/\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
      Parse FPD file.\r
\r
      @throws BuildException\r
                  FPD file is not valid.\r
     **/\r
    void parseFpdFile() throws BuildException {\r
        try {\r
            XmlObject doc = XmlObject.Factory.parse(fpdFile);\r
\r
            if (!doc.validate()) {\r
                throw new BuildException("Platform Surface Area file [" + fpdFile.getPath() + "] format is invalid!");\r
            }\r
\r
            Map<String, XmlObject> map = new HashMap<String, XmlObject>();\r
            map.put("PlatformSurfaceArea", doc);\r
            saq = new SurfaceAreaQuery(map);\r
\r
            //\r
            // Initialize\r
            //\r
            platformId = saq.getFpdHeader();\r
            platformId.setFpdFile(fpdFile);\r
            getProject().setProperty("PLATFORM", platformId.getName());\r
            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
            //\r
            String buildMode = saq.getFpdIntermediateDirectories();\r
            String userDefinedOutputDir = saq.getFpdOutputDirectory();\r
\r
            OutputManager.getInstance().setup(userDefinedOutputDir, buildMode);\r
\r
            //\r
            // TBD. Deal PCD and BuildOption related Info\r
            //\r
            GlobalData.setFpdBuildOptions(saq.getFpdBuildOptions());\r
\r
            GlobalData.setToolChainPlatformInfo(saq.getFpdToolChainInfo());\r
\r
            //\r
            // Parse all list modules SA\r
            //\r
            parseModuleSAFiles();\r
\r
            //\r
            // TBD. Deal PCD and BuildOption related Info\r
            //\r
            parseToolChainFamilyOptions();\r
            parseToolChainOptions();\r
\r
            saq.push(map);\r
\r
            //\r
            // Pcd Collection. Call CollectPCDAction to collect pcd info.\r
            //\r
            PlatformPcdPreprocessActionForBuilding ca = new PlatformPcdPreprocessActionForBuilding();\r
            ca.perform(platformId.getFpdFile().getPath(), ActionMessage.NULL_MESSAGE_LEVEL);\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
    /**\r
      Parse all modules listed in FPD file.\r
    **/\r
    void parseModuleSAFiles() throws EdkException{\r
        Map<FpdModuleIdentification, Map<String, XmlObject>> moduleSAs = saq.getFpdModules();\r
\r
        //\r
        // For every Module lists in FPD file.\r
        //\r
        Set<FpdModuleIdentification> keys = moduleSAs.keySet();\r
        Iterator iter = keys.iterator();\r
        while (iter.hasNext()) {\r
            FpdModuleIdentification fpdModuleId = (FpdModuleIdentification) iter.next();\r
\r
            //\r
            // Judge if Module is existed?\r
            // TBD\r
            GlobalData.registerFpdModuleSA(fpdModuleId, moduleSAs.get(fpdModuleId));\r
\r
            //\r
            // Put fpdModuleId to the corresponding FV\r
            //\r
            saq.push(GlobalData.getDoc(fpdModuleId));\r
            String fvBinding = saq.getModuleFvBindingKeyword();\r
\r
            fpdModuleId.setFvBinding(fvBinding);\r
            updateFvs(fvBinding, fpdModuleId);\r
\r
            //\r
            // Prepare for out put file name\r
            //\r
            ModuleIdentification moduleId = fpdModuleId.getModule();\r
\r
            String baseName = saq.getModuleOutputFileBasename();\r
            \r
            if (baseName == null) {\r
                baseName = moduleId.getName();\r
            }\r
            outfiles.put(fpdModuleId, fpdModuleId.getArch() + File.separatorChar\r
                         + moduleId.getGuid() + "-" + baseName\r
                         + getSuffix(moduleId.getModuleType()));\r
\r
            //\r
            // parse module build options, if any\r
            //\r
            GlobalData.addModuleToolChainOption(fpdModuleId, parseModuleBuildOptions(false));\r
            GlobalData.addModuleToolChainFamilyOption(fpdModuleId, parseModuleBuildOptions(true));\r
            saq.pop();\r
        }\r
    }\r
\r
    ToolChainMap parseModuleBuildOptions(boolean toolChainFamilyFlag) throws EdkException {\r
        String[][] options = saq.getModuleBuildOptions(toolChainFamilyFlag);\r
        if (options == null || options.length == 0) {\r
            return new ToolChainMap();\r
        }\r
        return parseOptions(options);\r
    }\r
\r
    private ToolChainMap parsePlatformBuildOptions(boolean toolChainFamilyFlag) throws EdkException {\r
        String[][] options = saq.getPlatformBuildOptions(toolChainFamilyFlag);\r
        if (options == null || options.length == 0) {\r
            return new ToolChainMap();\r
        }\r
        return parseOptions(options);\r
    }\r
\r
    private ToolChainMap parseOptions(String[][] options) throws EdkException {\r
        ToolChainMap map = new ToolChainMap();\r
        int flagIndex = ToolChainElement.ATTRIBUTE.value;\r
\r
        for (int i = 0; i < options.length; ++i) {\r
            String flagString = options[i][flagIndex];\r
            if (flagString == null) {\r
                flagString = "";\r
            }\r
            options[i][flagIndex] = ToolChainAttribute.FLAGS + "";\r
            map.put(options[i], flagString.trim());\r
        }\r
\r
        return map;\r
    }\r
\r
    private void parseToolChainFamilyOptions() throws EdkException {\r
        GlobalData.setPlatformToolChainFamilyOption(parsePlatformBuildOptions(true));\r
    }\r
\r
    private void parseToolChainOptions() throws EdkException {\r
        GlobalData.setPlatformToolChainOption(parsePlatformBuildOptions(false));\r
    }\r
\r
    /**\r
      Add the current module to corresponding FV.\r
\r
      @param fvName current FV name\r
      @param moduleName current module identification\r
    **/\r
    void updateFvs(String fvName, FpdModuleIdentification fpdModuleId) {\r
        if (fvName == null || fvName.trim().length() == 0) {\r
            fvName = "NULL";\r
        }\r
        String[] fvNameArray = fvName.split("[, \t]+");\r
        for (int i = 0; i < fvNameArray.length; i++) {\r
            //\r
            // Put module to corresponding fvName\r
            //\r
            if (fvs.containsKey(fvNameArray[i])) {\r
                Set<FpdModuleIdentification> set = fvs.get(fvNameArray[i]);\r
                set.add(fpdModuleId);\r
            } else {\r
                Set<FpdModuleIdentification> set = new LinkedHashSet<FpdModuleIdentification>();\r
                set.add(fpdModuleId);\r
                fvs.put(fvNameArray[i], set);\r
            }\r
        }\r
    }\r
\r
    /**\r
      Get the suffix based on module type. Current relationship are listed:\r
\r
      <pre>\r
      <b>ModuleType</b>     <b>Suffix</b>\r
      BASE                 .FFS\r
      SEC                  .SEC\r
      PEI_CORE             .PEI\r
      PEIM                 .PEI\r
      DXE_CORE             .DXE\r
      DXE_DRIVER           .DXE\r
      DXE_RUNTIME_DRIVER   .DXE\r
      DXE_SAL_DRIVER       .DXE\r
      DXE_SMM_DRIVER       .DXE\r
      TOOL                 .FFS\r
      UEFI_DRIVER          .DXE\r
      UEFI_APPLICATION     .APP\r
      USER_DEFINED         .FFS\r
      </pre>\r
\r
      @param moduleType module type\r
      @return\r
      @throws BuildException\r
      If module type is null\r
    **/\r
    public static String getSuffix(String moduleType) throws BuildException {\r
        if (moduleType == null) {\r
            throw new BuildException("Module type is not specified.");\r
        }\r
\r
        String[][] suffix = EdkDefinitions.ModuleTypeExtensions;\r
\r
        for (int i = 0; i < suffix.length; i++) {\r
            if (suffix[i][0].equalsIgnoreCase(moduleType)) {\r
                return suffix[i][1];\r
            }\r
        }\r
        //\r
        // Default is '.FFS'\r
        //\r
        return ".FFS";\r
    }\r
    /**\r
     Add a property.\r
\r
     @param p property\r
     **/\r
    public void addProperty(Property p) {\r
        properties.addElement(p);\r
    }\r
\r
    public void setFpdFile(File fpdFile) {\r
        this.fpdFile = fpdFile;\r
    }\r
\r
    public void setType(String type) {\r
        this.type = type;\r
    }\r
    \r
    public String getAllArchForModule(ModuleIdentification moduleId) {\r
        String archs = "";\r
        Iterator<FpdModuleIdentification> iter = outfiles.keySet().iterator();\r
        while (iter.hasNext()) {\r
            FpdModuleIdentification fpdModuleId = iter.next();\r
            \r
            if (fpdModuleId.getModule().equals(moduleId)) {\r
                archs += fpdModuleId.getArch() + " ";\r
            }\r
        }\r
        \r
        return archs;\r
    }\r
}\r