]> git.proxmox.com Git - mirror_edk2.git/blobdiff - Tools/Source/GenBuild/org/tianocore/build/pcd/action/PCDAutoGenAction.java
Modify PCD tool according to final PCD schema modification.
[mirror_edk2.git] / Tools / Source / GenBuild / org / tianocore / build / pcd / action / PCDAutoGenAction.java
index 3d1f1baf63595cdef1c6be28648cd3073c5270e6..278e58ceaee0b76a734abe00b9237b7e03d126c5 100644 (file)
@@ -18,6 +18,7 @@ package org.tianocore.build.pcd.action;
 \r
 import java.io.File;\r
 import java.util.List;\r
+import java.util.UUID;\r
 \r
 import org.tianocore.build.global.GlobalData;\r
 import org.tianocore.build.pcd.entity.MemoryDatabaseManager;\r
@@ -39,11 +40,35 @@ public class PCDAutoGenAction extends BuildAction {
     ///\r
     private String                moduleName;\r
     ///\r
+    /// The Guid of module which is analyzed currently.\r
+    /// \r
+    private UUID                  moduleGuid;\r
+    ///\r
+    /// The name of package whose module is analysized currently.\r
+    /// \r
+    private String                packageName;\r
+    ///\r
+    /// The Guid of package whose module is analyszed curretnly.\r
+    /// \r
+    private UUID                  packageGuid;\r
+    ///\r
+    /// The arch of current module\r
+    /// \r
+    private String                arch;\r
+    ///\r
+    /// The version of current module\r
+    /// \r
+    private String                version;\r
+    ///\r
     /// Wheter current module is PCD emulated driver. It is only for \r
     /// emulated PCD driver and will be kept until PCD IMAGE tool ready.\r
     ///\r
     private boolean               isEmulatedPCDDriver;\r
     ///\r
+    /// Whether current autogen is for building library used by current module.\r
+    /// \r
+    private boolean               isBuildUsedLibrary;\r
+    ///\r
     /// The generated string for header file.\r
     ///\r
     private String                hAutoGenString;\r
@@ -61,6 +86,26 @@ public class PCDAutoGenAction extends BuildAction {
         this.moduleName = moduleName;\r
     }\r
 \r
+    public void setModuleGuid(UUID moduleGuid) {\r
+        this.moduleGuid = moduleGuid;\r
+    }\r
+\r
+    public void setPackageName(String packageName) {\r
+        this.packageName = packageName;\r
+    }\r
+\r
+    public void setPackageGuid(UUID packageGuid) {\r
+        this.packageGuid = packageGuid;\r
+    }\r
+\r
+    public void setArch(String arch) {\r
+        this.arch = arch;\r
+    }\r
+\r
+    public void setVersion(String version) {\r
+        this.version = version;\r
+    }\r
+\r
     /**\r
       Set parameter isEmulatedPCDDriver\r
   \r
@@ -70,6 +115,10 @@ public class PCDAutoGenAction extends BuildAction {
         this.isEmulatedPCDDriver = isEmulatedPCDDriver;\r
     }\r
 \r
+    public void setIsBuildUsedLibrary(boolean isBuildUsedLibrary) {\r
+        this.isBuildUsedLibrary = isBuildUsedLibrary;\r
+    }\r
+\r
     /**\r
       Get the output of generated string for header file.\r
   \r
@@ -96,10 +145,26 @@ public class PCDAutoGenAction extends BuildAction {
       @param moduleName            Parameter of this action class.\r
       @param isEmulatedPCDDriver   Parameter of this action class.\r
     **/\r
-    public PCDAutoGenAction(String moduleName, boolean isEmulatedPCDDriver) {\r
-        dbManager = null;\r
+    public PCDAutoGenAction(String  moduleName, \r
+                            UUID    moduleGuid, \r
+                            String  packageName,\r
+                            UUID    packageGuid,\r
+                            String  arch,\r
+                            String  version,\r
+                            boolean isEmulatedPCDDriver, \r
+                            boolean isBuildUsedLibrary) {\r
+        dbManager       = null;\r
+        hAutoGenString  = "";\r
+        cAutoGenString  = "";\r
+\r
         setIsEmulatedPCDDriver(isEmulatedPCDDriver);\r
         setModuleName(moduleName);\r
+        setModuleGuid(moduleGuid);\r
+        setPackageName(packageName);\r
+        setPackageGuid(packageGuid);\r
+        setArch(arch);\r
+        setVersion(version);\r
+        setIsBuildUsedLibrary(isBuildUsedLibrary);\r
     }\r
 \r
     /**\r
@@ -130,7 +195,6 @@ public class PCDAutoGenAction extends BuildAction {
     void performAction() throws BuildActionException {\r
         ActionMessage.debug(this, \r
                             "Starting PCDAutoGenAction to generate autogen.h and autogen.c!...");\r
-                            \r
         //\r
         // Check the PCD memory database manager is valid.\r
         //\r
@@ -141,20 +205,15 @@ public class PCDAutoGenAction extends BuildAction {
         dbManager = GlobalData.getPCDMemoryDBManager();\r
 \r
         if(dbManager.getDBSize() == 0) {\r
-           return; \r
+            return;\r
         }\r
 \r
         ActionMessage.debug(this,\r
                             "PCD memory database contains " + dbManager.getDBSize() + " PCD tokens");\r
 \r
-        hAutoGenString = "";\r
-        cAutoGenString = "";\r
 \r
-        if(isEmulatedPCDDriver) {\r
-            generateAutogenForPCDEmulatedDriver();\r
-        } else {\r
-            generateAutogenForModule();\r
-        }\r
+\r
+        generateAutogenForModule();\r
     }\r
 \r
     /**\r
@@ -168,7 +227,30 @@ public class PCDAutoGenAction extends BuildAction {
         int                   index;\r
         List<UsageInstance>   usageInstanceArray;\r
 \r
-        usageInstanceArray  = dbManager.getUsageInstanceArrayByModuleName(moduleName);\r
+        if (!isBuildUsedLibrary) {\r
+            usageInstanceArray  = dbManager.getUsageInstanceArrayByModuleName(moduleName,\r
+                                                                              moduleGuid,\r
+                                                                              packageName,\r
+                                                                              packageGuid,\r
+                                                                              arch,\r
+                                                                              version);\r
+            dbManager.UsageInstanceContext = usageInstanceArray;\r
+            dbManager.CurrentModuleName    = moduleName; \r
+        } else {\r
+            usageInstanceArray = dbManager.UsageInstanceContext;\r
+            //\r
+            // For building MDE package, although all module are library, but PCD entries of \r
+            // these library should be used to autogen.\r
+            // \r
+            if (usageInstanceArray == null) {\r
+                usageInstanceArray  = dbManager.getUsageInstanceArrayByModuleName(moduleName,\r
+                                                                                  moduleGuid,\r
+                                                                                  packageName,\r
+                                                                                  packageGuid,\r
+                                                                                  arch,\r
+                                                                                  version);\r
+            }\r
+        }\r
 \r
         if(usageInstanceArray.size() != 0) {\r
             //\r
@@ -182,7 +264,7 @@ public class PCDAutoGenAction extends BuildAction {
                                 "Module " + moduleName + "'s PCD [" + Integer.toHexString(index) + \r
                                 "]: " + usageInstanceArray.get(index).parentToken.cName);\r
             try {\r
-                usageInstanceArray.get(index).generateAutoGen();\r
+                usageInstanceArray.get(index).generateAutoGen(isBuildUsedLibrary);\r
                 hAutoGenString += usageInstanceArray.get(index).getHAutogenStr() + "\r\n";\r
                 cAutoGenString += usageInstanceArray.get(index).getCAutogenStr() + "\r\n";\r
             } catch(EntityException exp) {\r
@@ -190,13 +272,17 @@ public class PCDAutoGenAction extends BuildAction {
             }\r
         }\r
 \r
-                               if (moduleName.equalsIgnoreCase("PcdPeim")) {\r
-                                               hAutoGenString += dbManager.PcdPeimHString;\r
-                                               cAutoGenString += dbManager.PcdPeimCString;\r
-                               } else if (moduleName.equalsIgnoreCase("PcdDxe")) {\r
-                                               hAutoGenString += dbManager.PcdDxeHString;\r
-                                               cAutoGenString += dbManager.PcdDxeCString;\r
-                               }\r
+        //\r
+        // Work around code, In furture following code should be modified that get \r
+        // these information from Uplevel Autogen tools.\r
+        // \r
+        if (moduleName.equalsIgnoreCase("PcdPeim")) {\r
+            hAutoGenString += dbManager.PcdPeimHString;\r
+            cAutoGenString += dbManager.PcdPeimCString;\r
+        } else if (moduleName.equalsIgnoreCase("PcdDxe")) {\r
+            hAutoGenString += dbManager.PcdDxeHString;\r
+            cAutoGenString += dbManager.PcdDxeCString;\r
+        }\r
 \r
         ActionMessage.debug(this,\r
                             "Module " + moduleName + "'s PCD header file:\r\n" + hAutoGenString + "\r\n"\r
@@ -206,320 +292,6 @@ public class PCDAutoGenAction extends BuildAction {
                             );\r
     }\r
 \r
-    /**\r
-      Generate all PCD autogen string and the emulated PCD IMAGE array for emulated driver.\r
-      \r
-      Currently, we should generated all PCD information(maybe all dynamic) as array \r
-      in Pei emulated driver for simulating PCD runtime database. \r
-      \r
-    **/\r
-    private void generateAutogenForPCDEmulatedDriver() {\r
-        int           index;\r
-        Token[]       tokenArray;\r
-        UsageInstance usageInstance;\r
-\r
-        //\r
-        // Add "#include 'PcdLib.h'" for Header file\r
-        //\r
-        hAutoGenString = "#include <MdePkg/Include/Library/PcdLib.h>\r\n";\r
-\r
-        tokenArray = dbManager.getRecordArray();\r
-        for(index = 0; index < tokenArray.length; index ++) {\r
-            //\r
-            // Get one consumer instance and generate autogen for this token.\r
-            //\r
-            if(tokenArray[index].consumers != null ) {\r
-                if(tokenArray[index].consumers.size() != 0) {\r
-                    usageInstance = tokenArray[index].consumers.get(0);\r
-                    try {\r
-                        usageInstance.generateAutoGen();\r
-                    } catch(EntityException exp) {\r
-                        throw new BuildActionException(exp.getMessage());\r
-                    }\r
-    \r
-                    hAutoGenString += usageInstance.getHAutogenStr();\r
-                    cAutoGenString += usageInstance.getCAutogenStr();\r
-    \r
-                    hAutoGenString += "\r\n";\r
-                    cAutoGenString += "\r\n";\r
-                } else {\r
-                    //\r
-                    // If the PCD does *not* usded by any module, also generate \r
-                    // it into autogen.h/autogen.c in Pcd driver according the\r
-                    // information in FPD file.\r
-                    //\r
-                    generateUnReferencePcdAutogenString(tokenArray[index]);\r
-                }\r
-            }\r
-        }\r
-\r
-        generatePCDEmulatedArray(tokenArray);\r
-\r
-        ActionMessage.debug(this,\r
-                             "PCD emulated driver's header: \r\n" + hAutoGenString + "\r\n"\r
-                            );\r
-        ActionMessage.debug(this,\r
-                             "PCD emulated driver's C code: \r\n" + cAutoGenString + "\r\n"\r
-                            );\r
-\r
-    }\r
-\r
-    /**\r
-      Generate unreference token definition string for PCD emulated string. \r
-      \r
-      Maybe some PCD token definition in FPD but not used by any module or library, we \r
-      should also generate token definition in autoge.h/autogen.c, because maybe some\r
-      driver loaded in shell will use this PCD. \r
-\r
-     @param token   The token who want be generated autogen string.\r
-    \r
-    **/\r
-    private void generateUnReferencePcdAutogenString(Token token) {\r
-        hAutoGenString += String.format("#define _PCD_TOKEN_%s   0x%016x\r\n", \r
-                                        token.cName, token.tokenNumber);\r
-        switch (token.pcdType) {\r
-        case FEATURE_FLAG:\r
-            hAutoGenString += String.format(\r
-                                "#define _PCD_VALUE_%s   %s\r\n", \r
-                                token.cName, \r
-                                token.datum.toString()\r
-                                );\r
-            hAutoGenString += String.format(\r
-                                "extern const BOOLEAN _gPcd_FixedAtBuild_%s;\r\n", \r
-                                token.cName\r
-                                );\r
-            cAutoGenString += String.format(\r
-                                "GLOBAL_REMOVE_IF_UNREFERENCED const BOOLEAN _gPcd_FixedAtBuild_%s = _PCD_VALUE_%s;\r\n",\r
-                                token.cName,\r
-                                token.cName\r
-                                );\r
-            hAutoGenString += String.format(\r
-                                "#define _PCD_MODE_%s_%s  _PCD_VALUE_%s\r\n",\r
-                                Token.GetAutogenDefinedatumTypeString(token.datumType),\r
-                                token.cName,\r
-                                token.cName\r
-                                );\r
-            break;\r
-        case FIXED_AT_BUILD:\r
-            hAutoGenString += String.format(\r
-                                "#define _PCD_VALUE_%s   %s\r\n", \r
-                                token.cName, \r
-                                token.datum.toString()\r
-                                );\r
-            hAutoGenString += String.format(\r
-                                "extern const %s _gPcd_FixedAtBuild_%s;\r\n",\r
-                                Token.getAutogendatumTypeString(token.datumType),\r
-                                token.cName\r
-                                );\r
-            cAutoGenString += String.format(\r
-                                "GLOBAL_REMOVE_IF_UNREFERENCED const %s _gPcd_FixedAtBuild_%s = _PCD_VALUE_%s;\r\n",\r
-                                Token.getAutogendatumTypeString(token.datumType),\r
-                                token.cName,\r
-                                token.cName\r
-                                );\r
-            hAutoGenString += String.format(\r
-                                "#define _PCD_MODE_%s_%s  _PCD_VALUE_%s\r\n",\r
-                                Token.GetAutogenDefinedatumTypeString(token.datumType),\r
-                                token.cName,\r
-                                token.cName\r
-                                );\r
-            break;\r
-        case PATCHABLE_IN_MODULE:\r
-            hAutoGenString += String.format(\r
-                                 "#define _PCD_VALUE_%s   %s\r\n", \r
-                                 token.cName, \r
-                                 token.datum.toString()\r
-                                 );\r
-            hAutoGenString += String.format(\r
-                                 "extern %s _gPcd_BinaryPatch_%s;\r\n",\r
-                                 Token.getAutogendatumTypeString(token.datumType),\r
-                                 token.cName\r
-                                 );\r
-            cAutoGenString += String.format(\r
-                                 "GLOBAL_REMOVE_IF_UNREFERENCED %s _gPcd_BinaryPatch_%s = _PCD_VALUE_%s;\r\n",\r
-                                 Token.getAutogendatumTypeString(token.datumType),\r
-                                 token.cName,\r
-                                 token.cName\r
-                                 );\r
-            hAutoGenString += String.format(\r
-                                 "#define _PCD_MODE_%s_%s  _gPcd_BinaryPatch_%s\r\n",\r
-                                 Token.GetAutogenDefinedatumTypeString(token.datumType),\r
-                                 token.cName,\r
-                                 token.cName\r
-                                 );\r
-            break;\r
-        case DYNAMIC:\r
-            hAutoGenString += String.format(\r
-                                "#define _PCD_MODE_%s_%s  LibPcdGet%s(_PCD_TOKEN_%s)\r\n",\r
-                                Token.GetAutogenDefinedatumTypeString(token.datumType),\r
-                                token.cName,\r
-                                Token.getAutogenLibrarydatumTypeString(token.datumType),\r
-                                token.cName\r
-                                );\r
-            break;\r
-        case DYNAMIC_EX:\r
-            break;\r
-        default:\r
-            ActionMessage.warning(this, \r
-                                  "The PCD_TYPE setted by platform is unknown"\r
-                                  );\r
-        }\r
-\r
-        hAutoGenString += "\r\n";\r
-        cAutoGenString += "\r\n";\r
-    }\r
-        \r
-    /**\r
-      Generate PCDEmulated array in PCDEmulated driver for emulated runtime database.\r
-      \r
-      @param tokenArray  All PCD token in memory database.\r
-      \r
-      @throws BuildActionException  Unknown PCD_TYPE\r
-    **/\r
-    private void generatePCDEmulatedArray(Token[] tokenArray)\r
-        throws BuildActionException {\r
-        int       index;\r
-        Token     token;\r
-        String[]  guidStrArray;\r
-        String    value;\r
-\r
-        //\r
-        // The value of String type of PCD entry maybe use byte array but not string direcly\r
-        // such as {0x1, 0x2, 0x3}, and define PCD1_STRING_Value as L"string define here"\r
-        // For this case, we should generate a string array to C output and use the address\r
-        // of generated string array.\r
-        //\r
-        for(index = 0; index < tokenArray.length; index ++) {\r
-            token = tokenArray[index];\r
-\r
-            value = token.datum.toString();\r
-            if(token.datumType == Token.DATUM_TYPE.POINTER) {\r
-                if(!((value.charAt(0) == 'L' && value.charAt(1) == '"') ||(value.charAt(0) == '"'))) {\r
-                    cAutoGenString += String.format("UINT8 _mPcdArray%08x[] = %s;\r\n", \r
-                                                     index, \r
-                                                     value\r
-                                                     );\r
-                }\r
-            }\r
-        }\r
-\r
-        //\r
-        // Output emulated PCD entry array\r
-        //\r
-        cAutoGenString += "\r\nEMULATED_PCD_ENTRY gEmulatedPcdEntry[] = {\r\n";\r
-\r
-        for(index = 0; index < tokenArray.length; index ++) {\r
-            token = tokenArray[index];\r
-\r
-            if(index != 0) {\r
-                cAutoGenString += ",\r\n";\r
-            }\r
-\r
-            //\r
-            // Print Start "{" for a Token item in array\r
-            //\r
-            cAutoGenString += "  {\r\n";\r
-\r
-            //\r
-            // Print Token Name\r
-            //\r
-            cAutoGenString += String.format("    _PCD_TOKEN_%s,\r\n", token.cName);\r
-\r
-            //\r
-            // Print Hii information\r
-            //\r
-            if(token.hiiEnabled) {\r
-                cAutoGenString += String.format("    TRUE,\r\n");\r
-            } else {\r
-                cAutoGenString += String.format("    FALSE,\r\n");\r
-            }\r
-\r
-            //\r
-            // Print sku information\r
-            //\r
-            if(token.skuEnabled) {\r
-                cAutoGenString += String.format("    TRUE,\r\n");\r
-            } else {\r
-                cAutoGenString += String.format("    FALSE,\r\n");\r
-            }\r
-\r
-            //\r
-            // Print maxSkuCount\r
-            //\r
-            cAutoGenString += String.format("    %d,\r\n", token.maxSkuCount);\r
-\r
-            cAutoGenString += String.format("    %d,\r\n", token.skuId);\r
-\r
-            if(token.variableGuid == null) {\r
-                cAutoGenString += "    { 0x00000000, 0x0000, 0x0000, { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 } },\r\n";\r
-            } else {\r
-                guidStrArray =(token.variableGuid.toString()).split("-");\r
-\r
-                cAutoGenString += String.format("    { 0x%s, 0x%s, 0x%s, { 0x%s, 0x%s, 0x%s, 0x%s, 0x%s, 0x%s, 0x%s, 0x%s } },\r\n",\r
-                                                 guidStrArray[0],\r
-                                                 guidStrArray[1],\r
-                                                 guidStrArray[2],\r
-                                                (guidStrArray[3].substring(0, 2)),\r
-                                                (guidStrArray[3].substring(2, 4)),\r
-                                                (guidStrArray[4].substring(0, 2)),\r
-                                                (guidStrArray[4].substring(2, 4)),\r
-                                                (guidStrArray[4].substring(4, 6)),\r
-                                                (guidStrArray[4].substring(6, 8)),\r
-                                                (guidStrArray[4].substring(8, 10)),\r
-                                                (guidStrArray[4].substring(10, 12))\r
-                                                );\r
-\r
-            }\r
-\r
-            value = token.datum.toString();\r
-            if(token.datumType == Token.DATUM_TYPE.POINTER) {\r
-                if((value.charAt(0) == 'L' && value.charAt(1) == '"') || value.charAt(0) == '"') {\r
-                    cAutoGenString += String.format("    sizeof(_PCD_VALUE_%s),\r\n", token.cName);\r
-                    cAutoGenString += String.format("    0, %s, %s,\r\n", token.variableName, value);\r
-                } else {\r
-                    cAutoGenString += String.format("    sizeof(_mPcdArray%08x),\r\n", index);\r
-                    cAutoGenString += String.format("    0, &_mPcdArray%08x, %s,\r\n", index, token.variableName);\r
-                }\r
-            } else {\r
-                switch(token.datumType) {\r
-                case UINT8:\r
-                    cAutoGenString += "    1,\r\n";\r
-                    break;\r
-                case UINT16:\r
-                    cAutoGenString += "    2,\r\n";\r
-                    break;\r
-                case UINT32:\r
-                    cAutoGenString += "    4,\r\n";\r
-                    break;\r
-                case UINT64:\r
-                    cAutoGenString += "    8,\r\n";\r
-                    break;\r
-                case BOOLEAN:\r
-                    cAutoGenString += "    1,\r\n";\r
-                    break;\r
-                default:\r
-                    throw new BuildActionException("Unknown datum size");\r
-                }\r
-                cAutoGenString += String.format("    %s, %s, NULL,\r\n", value, token.variableName);\r
-            }\r
-\r
-            //\r
-            // Print end "}" for a token item in array\r
-            //\r
-            cAutoGenString += "  }";\r
-        }\r
-\r
-        cAutoGenString += "\r\n};\r\n";\r
-        cAutoGenString += "\r\n";\r
-        cAutoGenString += "UINTN\r\n";\r
-        cAutoGenString += "GetPcdDataBaseSize(\r\n";\r
-        cAutoGenString += "  VOID\r\n";\r
-        cAutoGenString += "  )\r\n";\r
-        cAutoGenString += "{\r\n";\r
-        cAutoGenString += "  return sizeof(gEmulatedPcdEntry);\r\n";\r
-        cAutoGenString += "}\r\n";\r
-    }\r
-\r
     /**\r
       Test case function\r
 \r
@@ -527,8 +299,8 @@ public class PCDAutoGenAction extends BuildAction {
     **/\r
     public static void main(String argv[]) {\r
 \r
-                               String WorkSpace = "G:/edk2";\r
-        String logFilePath = WorkSpace  + "/EdkNt32Pkg/Nt32.fpd";\r
+        String WorkSpace = "M:/ForPcd/edk2";\r
+        String logFilePath = WorkSpace  + "/MdePkg/MdePkg.fpd";\r
 \r
         //\r
         // At first, CollectPCDAction should be invoked to collect\r
@@ -538,8 +310,6 @@ public class PCDAutoGenAction extends BuildAction {
         GlobalData.initInfo("Tools" + File.separator + "Conf" + File.separator + "FrameworkDatabase.db",\r
                             WorkSpace);\r
 \r
-        GlobalData.getPCDMemoryDBManager().setLogFileName(logFilePath + ".PCDMemroyDatabaseLog.txt");\r
-\r
         try {\r
             collectionAction.perform(WorkSpace, \r
                                      logFilePath,\r
@@ -551,14 +321,20 @@ public class PCDAutoGenAction extends BuildAction {
         //\r
         // Then execute the PCDAuotoGenAction to get generated Autogen.h and Autogen.c\r
         //\r
-        PCDAutoGenAction autogenAction = new PCDAutoGenAction("PcdDxe",\r
-                                                                                                                                                                                                                                                       false\r
+        PCDAutoGenAction autogenAction = new PCDAutoGenAction("BaseLib",\r
+                                                              null,\r
+                                                              null,\r
+                                                              null,\r
+                                                              null,\r
+                                                              null,\r
+                                                              false,\r
+                                                              false\r
                                                               );\r
-                               autogenAction.execute();\r
+        autogenAction.execute();\r
 \r
-                               System.out.println(autogenAction.OutputH());\r
-                               System.out.println("WQWQWQWQWQ");\r
-                               System.out.println(autogenAction.OutputC());\r
+        System.out.println(autogenAction.OutputH());\r
+        System.out.println("WQWQWQWQWQ");\r
+        System.out.println(autogenAction.OutputC());\r
 \r
 \r
         System.out.println (autogenAction.hAutoGenString);\r