\r
This class is to manage how to generate the PCD information into Autogen.c and\r
Autogen.h.\r
- \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
+\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
import java.io.File;\r
import java.util.ArrayList;\r
import java.util.List;\r
-import java.util.Map;\r
-import java.util.Set;\r
-import java.util.UUID;\r
import java.util.regex.Matcher;\r
import java.util.regex.Pattern;\r
\r
-import org.apache.xmlbeans.XmlObject;\r
+import org.tianocore.build.autogen.CommonDefinition;\r
+import org.tianocore.build.exception.PcdAutogenException;\r
import org.tianocore.build.global.GlobalData;\r
-import org.tianocore.build.global.SurfaceAreaQuery;\r
-import org.tianocore.build.pcd.entity.MemoryDatabaseManager;\r
-import org.tianocore.build.pcd.entity.Token;\r
-import org.tianocore.build.pcd.entity.UsageInstance;\r
-import org.tianocore.build.pcd.exception.BuildActionException;\r
-import org.tianocore.build.pcd.exception.EntityException;\r
-\r
-/** This class is to manage how to generate the PCD information into Autogen.c and\r
- Autogen.h.\r
+import org.tianocore.build.id.ModuleIdentification;\r
+import org.tianocore.pcd.action.ActionMessage;\r
+import org.tianocore.pcd.action.BuildAction;\r
+import org.tianocore.pcd.entity.MemoryDatabaseManager;\r
+import org.tianocore.pcd.entity.Token;\r
+import org.tianocore.pcd.entity.UsageIdentification;\r
+import org.tianocore.pcd.entity.UsageInstance;\r
+import org.tianocore.pcd.exception.BuildActionException;\r
+\r
+/**\r
+ This class is to manage how to generate the PCD information into Autogen.c\r
+ and Autogen.h.\r
**/\r
public class PCDAutoGenAction extends BuildAction {\r
///\r
/// The reference of DBManager in GlobalData class.\r
///\r
private MemoryDatabaseManager dbManager;\r
+\r
///\r
- /// The name of module which is analysised currently.\r
- ///\r
- private String moduleName;\r
- ///\r
- /// The Guid of module which is analyzed currently.\r
- /// \r
- private UUID moduleGuid;\r
+ /// The identification for a UsageInstance.\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
+ private UsageIdentification usageId;\r
+\r
///\r
- /// The arch of current module\r
- /// \r
- private String arch;\r
+ /// Whether current autogen is for building library used by current module.\r
///\r
- /// The version of current module\r
- /// \r
- private String version;\r
+ private boolean isBuildUsedLibrary;\r
+\r
///\r
- /// Whether current autogen is for building library used by current module.\r
+ /// One of PEI_PCD_DRIVER, DXE_PCD_DRIVER, NOT_PCD_DRIVER \r
/// \r
- private boolean isBuildUsedLibrary;\r
+ private CommonDefinition.PCD_DRIVER_TYPE pcdDriverType;\r
+\r
///\r
/// The generated string for header file.\r
///\r
private String hAutoGenString;\r
+\r
///\r
/// The generated string for C code file.\r
///\r
private String cAutoGenString;\r
+\r
///\r
/// The name array of <PcdCoded> in a module.\r
- /// \r
- private String[] pcdNameArray;\r
- /**\r
- Set parameter ModuleName\r
- \r
- @param moduleName the module name parameter.\r
- **/\r
- public void setModuleName(String moduleName) {\r
- this.moduleName = moduleName;\r
- }\r
-\r
- /**\r
- set the moduleGuid parameter.\r
- \r
- @param moduleGuid\r
- **/\r
- public void setModuleGuid(UUID moduleGuid) {\r
- this.moduleGuid = moduleGuid;\r
- }\r
+ ///\r
+ private String[] pcdNameArrayInMsa;\r
\r
/**\r
- set packageName parameter.\r
- \r
- @param packageName\r
- **/\r
- public void setPackageName(String packageName) {\r
- this.packageName = packageName;\r
- }\r
+ Set parameter moduleId\r
\r
- /**\r
- set packageGuid parameter.\r
- \r
- @param packageGuid\r
+ @param moduleName the module name parameter.\r
**/\r
- public void setPackageGuid(UUID packageGuid) {\r
- this.packageGuid = packageGuid;\r
+ public void setUsageId(UsageIdentification usageId) {\r
+ this.usageId = usageId;\r
}\r
\r
/**\r
- set Arch parameter.\r
+ Set paramter pcdDriverType\r
\r
- @param arch\r
+ @param pcdDriverType the driver type for PCD\r
**/\r
- public void setArch(String arch) {\r
- this.arch = arch;\r
- }\r
-\r
- /**\r
- set version parameter\r
- \r
- @param version\r
- */\r
- public void setVersion(String version) {\r
- this.version = version;\r
+ public void setPcdDriverType(CommonDefinition.PCD_DRIVER_TYPE pcdDriverType) {\r
+ this.pcdDriverType = pcdDriverType;\r
}\r
-\r
/**\r
set isBuildUsedLibrary parameter.\r
- \r
+\r
@param isBuildUsedLibrary\r
- */\r
+ **/\r
public void setIsBuildUsedLibrary(boolean isBuildUsedLibrary) {\r
this.isBuildUsedLibrary = isBuildUsedLibrary;\r
}\r
+\r
/**\r
- set pcdNameArray parameter.\r
- \r
- @param pcdNameArray\r
+ set pcdNameArrayInMsa parameter.\r
+\r
+ @param pcdNameArrayInMsa\r
*/\r
- public void setPcdNameArray(String[] pcdNameArray) {\r
- this.pcdNameArray = pcdNameArray;\r
+ public void setPcdNameArrayInMsa(String[] pcdNameArrayInMsa) {\r
+ this.pcdNameArrayInMsa = pcdNameArrayInMsa;\r
}\r
\r
/**\r
Get the output of generated string for header file.\r
- \r
+\r
@return the string of header file for PCD\r
**/\r
- public String OutputH() {\r
+ public String getHAutoGenString() {\r
return hAutoGenString;\r
}\r
\r
/**\r
Get the output of generated string for C Code file.\r
- \r
+\r
@return the string of C code file for PCD\r
**/\r
- public String OutputC() {\r
+ public String getCAutoGenString() {\r
return cAutoGenString;\r
}\r
\r
+\r
/**\r
- Construct function\r
- \r
- This function mainly initialize some member variable.\r
- \r
- @param moduleName Parameter of this action class.\r
- @param isEmulatedPCDDriver Parameter of this action class.\r
+ Construct function\r
+\r
+ This function mainly initialize some member variable.\r
+\r
+ @param moduleId the identification for module\r
+ @param arch the architecture for module\r
+ @param isBuildUsedLibary Is the current module library.\r
+ @param pcdNameArrayInMsa the pcd name array got from MSA file.\r
+ @param pcdDriverType one of PEI_PCD_DRIVER, DXE_PCD_DRIVER,\r
+ NOT_PCD_DRIVER\r
**/\r
- public PCDAutoGenAction(String moduleName, \r
- UUID moduleGuid, \r
- String packageName,\r
- UUID packageGuid,\r
- String arch,\r
- String version,\r
- boolean isBuildUsedLibrary,\r
- String[] pcdNameArray) {\r
+ public PCDAutoGenAction(ModuleIdentification moduleId,\r
+ String arch,\r
+ boolean isBuildUsedLibrary,\r
+ String[] pcdNameArrayInMsa,\r
+ CommonDefinition.PCD_DRIVER_TYPE pcdDriverType) {\r
dbManager = null;\r
hAutoGenString = "";\r
cAutoGenString = "";\r
\r
- setModuleName(moduleName);\r
- setModuleGuid(moduleGuid);\r
- setPackageName(packageName);\r
- setPackageGuid(packageGuid);\r
- setPcdNameArray(pcdNameArray);\r
- setArch(arch);\r
- setVersion(version);\r
+ setUsageId(new UsageIdentification(moduleId.getName(),\r
+ moduleId.getGuid(),\r
+ moduleId.getPackage().getName(),\r
+ moduleId.getPackage().getGuid(),\r
+ arch,\r
+ moduleId.getVersion(),\r
+ moduleId.getModuleType()));\r
setIsBuildUsedLibrary(isBuildUsedLibrary);\r
+ setPcdNameArrayInMsa(pcdNameArrayInMsa);\r
+ setPcdDriverType(pcdDriverType);\r
}\r
\r
/**\r
- check the parameter for action class.\r
- \r
+ Override function: check the parameter for action class.\r
+\r
@throws BuildActionException Bad parameter.\r
**/\r
- void checkParameter() throws BuildActionException {\r
- \r
+ public void checkParameter() {\r
}\r
\r
/**\r
Core execution function for this action class.\r
- \r
+\r
All PCD information of this module comes from memory dabase. The collection\r
work should be done before this action execution.\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
+ Currently, we should generated all PCD information(maybe all dynamic) as array\r
+ in Pei emulated driver for simulating PCD runtime database.\r
+\r
@throws BuildActionException Failed to execute this aciton class.\r
**/\r
- void performAction() throws BuildActionException {\r
- ActionMessage.debug(this, \r
+ public void performAction() {\r
+ ActionMessage.debug(this,\r
"Starting PCDAutoGenAction to generate autogen.h and autogen.c!...");\r
- //\r
- // Check the PCD memory database manager is valid.\r
- //\r
- if(GlobalData.getPCDMemoryDBManager() == null) {\r
- throw new BuildActionException("Memory database has not been initlizated!");\r
- }\r
\r
dbManager = GlobalData.getPCDMemoryDBManager();\r
\r
}\r
\r
ActionMessage.debug(this,\r
- "PCD memory database contains " + dbManager.getDBSize() + " PCD tokens");\r
-\r
-\r
+ "PCD memory database contains " + dbManager.getDBSize() + " PCD tokens.");\r
\r
generateAutogenForModule();\r
}\r
\r
/**\r
Generate the autogen string for a common module.\r
- \r
+\r
All PCD information of this module comes from memory dabase. The collection\r
work should be done before this action execution.\r
**/\r
String[] guidStringArray = null;\r
String guidStringCName = null;\r
String guidString = null;\r
+ String moduleName = usageId.moduleName;\r
UsageInstance usageInstance = null;\r
+ boolean found = false;\r
\r
+ usageInstanceArray = null;\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
- usageContext = dbManager.UsageInstanceContext;\r
+ usageInstanceArray = dbManager.getUsageInstanceArrayById(usageId);\r
+ MemoryDatabaseManager.UsageInstanceContext = usageInstanceArray;\r
+ MemoryDatabaseManager.CurrentModuleName = moduleName;\r
+ } else if ((pcdNameArrayInMsa != null) && (pcdNameArrayInMsa.length > 0)) {\r
+ usageContext = MemoryDatabaseManager.UsageInstanceContext;\r
//\r
- // For building MDE package, although all module are library, but PCD entries of \r
+ // For building library package, although all module are library, but PCD entries of\r
// these library should be used to autogen.\r
- // \r
+ //\r
if (usageContext == null) {\r
- usageInstanceArray = dbManager.getUsageInstanceArrayByModuleName(moduleName,\r
- moduleGuid,\r
- packageName,\r
- packageGuid,\r
- arch,\r
- version);\r
+ usageInstanceArray = dbManager.getUsageInstanceArrayById(usageId);\r
} else {\r
usageInstanceArray = new ArrayList<UsageInstance>();\r
- //\r
- // Remove PCD entries which are not belong to this library.\r
- // \r
- for (index = 0; index < usageContext.size(); index++) {\r
- if ((pcdNameArray == null) || (pcdNameArray.length == 0)){\r
- break;\r
- }\r
\r
- for (index2 = 0; index2 < pcdNameArray.length; index2 ++) {\r
- if (pcdNameArray[index2].equalsIgnoreCase(usageContext.get(index).parentToken.cName)) {\r
- usageInstanceArray.add(usageContext.get(index));\r
+ //\r
+ // Try to find all PCD defined in library's PCD in all <PcdEntry> in module's\r
+ // <ModuleSA> in FPD file.\r
+ //\r
+ for (index = 0; index < pcdNameArrayInMsa.length; index++) {\r
+ found = false;\r
+ for (index2 = 0; index2 < usageContext.size(); index2 ++) {\r
+ if (pcdNameArrayInMsa[index].equalsIgnoreCase(usageContext.get(index2).parentToken.cName)) {\r
+ usageInstanceArray.add(usageContext.get(index2));\r
+ found = true;\r
break;\r
}\r
}\r
+\r
+ if (!found) {\r
+ //\r
+ // All library's PCD should instanted in module's <ModuleSA> who\r
+ // use this library instance. If not, give errors.\r
+ //\r
+ throw new BuildActionException (String.format("Module %s using library instance %s; the PCD %s " +\r
+ "is required by this library instance, but can not be found " +\r
+ "in the %s's <ModuleSA> in the FPD file!",\r
+ MemoryDatabaseManager.CurrentModuleName,\r
+ moduleName,\r
+ pcdNameArrayInMsa[index],\r
+ MemoryDatabaseManager.CurrentModuleName\r
+ ));\r
+ }\r
}\r
}\r
}\r
\r
- if(usageInstanceArray.size() != 0) {\r
- //\r
- // Add "#include 'PcdLib.h'" for Header file\r
- //\r
- hAutoGenString = "#include <MdePkg/Include/Library/PcdLib.h>\r\n";\r
+ if (usageInstanceArray == null) {\r
+ return;\r
}\r
\r
//\r
// Generate all PCD entry for a module.\r
- // \r
+ //\r
for(index = 0; index < usageInstanceArray.size(); index ++) {\r
- ActionMessage.debug(this,\r
- "Module " + moduleName + "'s PCD [" + Integer.toHexString(index) + \r
- "]: " + usageInstanceArray.get(index).parentToken.cName);\r
- try {\r
- usageInstance = usageInstanceArray.get(index);\r
+ usageInstance = usageInstanceArray.get(index);\r
+ //\r
+ // Before generate any PCD information into autogen.h/autogen.c for a module,\r
+ // generate TokenSpaceGuid array variable firstly. For every dynamicEx type\r
+ // PCD in this module the token, they are all reference to TokenSpaceGuid\r
+ // array.\r
+ //\r
+ if (usageInstanceArray.get(index).modulePcdType == Token.PCD_TYPE.DYNAMIC_EX) {\r
+ guidStringArray = usageInstance.parentToken.tokenSpaceName.split("-");\r
+ guidStringCName = "_gPcd_TokenSpaceGuid_" +\r
+ usageInstance.parentToken.tokenSpaceName.replaceAll("-", "_");\r
+ guidString = 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
+ guidStringArray[0],\r
+ guidStringArray[1],\r
+ guidStringArray[2],\r
+ (guidStringArray[3].substring(0, 2)),\r
+ (guidStringArray[3].substring(2, 4)),\r
+ (guidStringArray[4].substring(0, 2)),\r
+ (guidStringArray[4].substring(2, 4)),\r
+ (guidStringArray[4].substring(4, 6)),\r
+ (guidStringArray[4].substring(6, 8)),\r
+ (guidStringArray[4].substring(8, 10)),\r
+ (guidStringArray[4].substring(10, 12)));\r
+\r
+ Pattern pattern = Pattern.compile("(" + guidStringCName + ")+?");\r
+ Matcher matcher = pattern.matcher(cAutoGenString + " ");\r
//\r
- // Before generate any PCD information into autogen.h/autogen.c for a module,\r
- // generate TokenSpaceGuid array variable firstly. For every dynamicEx type\r
- // PCD in this module the token, they are all reference to TokenSpaceGuid \r
- // array.\r
- // \r
- if (usageInstanceArray.get(index).modulePcdType == Token.PCD_TYPE.DYNAMIC_EX) {\r
- guidStringArray = usageInstance.parentToken.tokenSpaceName.toString().split("-");\r
- guidStringCName = "_gPcd_TokenSpaceGuid_" + \r
- usageInstance.parentToken.tokenSpaceName.toString().replaceAll("-", "_");\r
- guidString = 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
- guidStringArray[0],\r
- guidStringArray[1],\r
- guidStringArray[2],\r
- (guidStringArray[3].substring(0, 2)),\r
- (guidStringArray[3].substring(2, 4)),\r
- (guidStringArray[4].substring(0, 2)),\r
- (guidStringArray[4].substring(2, 4)),\r
- (guidStringArray[4].substring(4, 6)),\r
- (guidStringArray[4].substring(6, 8)),\r
- (guidStringArray[4].substring(8, 10)),\r
- (guidStringArray[4].substring(10, 12)));\r
+ // Find whether this guid array variable has been generated into autogen.c\r
+ // For different DyanmicEx pcd token who use same token space guid, the token space\r
+ // guid array should be only generated once.\r
+ //\r
+ if (!matcher.find()) {\r
+ hAutoGenString += String.format("extern EFI_GUID %s;\r\n", guidStringCName);\r
if (!isBuildUsedLibrary) {\r
- Pattern pattern = Pattern.compile("(" + guidStringCName + ")+?");\r
- Matcher matcher = pattern.matcher(cAutoGenString + " ");\r
- //\r
- // Find whether this guid array variable has been generated into autogen.c\r
- // For different DyanmicEx pcd token who use same token space guid, the token space\r
- // guid array should be only generated once.\r
- // \r
- if (!matcher.find()) {\r
- cAutoGenString += String.format("GLOBAL_REMOVE_IF_UNREFERENCED EFI_GUID %s = %s;\r\n",\r
- guidStringCName,\r
- guidString);\r
- }\r
+ cAutoGenString += String.format("GLOBAL_REMOVE_IF_UNREFERENCED EFI_GUID %s = %s;\r\n",\r
+ guidStringCName,\r
+ guidString);\r
}\r
}\r
-\r
- usageInstance.generateAutoGen(isBuildUsedLibrary);\r
- //\r
- // For every PCD entry for this module(usage instance), autogen string would\r
- // be appand.\r
- // \r
- hAutoGenString += usageInstance.getHAutogenStr() + "\r\n";\r
- cAutoGenString += usageInstance.getCAutogenStr();\r
-\r
- } catch(EntityException exp) {\r
- throw new BuildActionException("[PCD Autogen Error]: " + exp.getMessage());\r
}\r
- }\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
+ usageInstance.generateAutoGen(isBuildUsedLibrary);\r
+ //\r
+ // For every PCD entry for this module(usage instance), autogen string would\r
+ // be appand.\r
+ //\r
+ hAutoGenString += usageInstance.getHAutogenStr() + "\r\n";\r
+ cAutoGenString += usageInstance.getCAutogenStr();\r
}\r
\r
- ActionMessage.debug(this,\r
- "Module " + moduleName + "'s PCD header file:\r\n" + hAutoGenString + "\r\n"\r
- );\r
- ActionMessage.debug(this,\r
- "Module " + moduleName + "'s PCD C file:\r\n" + cAutoGenString + "\r\n"\r
- );\r
- }\r
-\r
- /**\r
- Test case function\r
-\r
- @param argv paramter from command line\r
- **/\r
- public static void main(String argv[]) {\r
-\r
- String WorkSpace = "M:/tianocore/edk2";\r
- String logFilePath = WorkSpace + "/EdkNt32Pkg/Nt32.fpd";\r
- String[] nameArray = null;\r
-\r
- //\r
- // At first, CollectPCDAction should be invoked to collect\r
- // all PCD information from SPD, MSA, FPD.\r
- //\r
- CollectPCDAction collectionAction = new CollectPCDAction();\r
- GlobalData.initInfo("Tools" + File.separator + "Conf" + File.separator + "FrameworkDatabase.db",\r
- WorkSpace);\r
-\r
- try {\r
- collectionAction.perform(WorkSpace, \r
- logFilePath,\r
- ActionMessage.MAX_MESSAGE_LEVEL);\r
- } catch(Exception e) {\r
- e.printStackTrace();\r
+ if (pcdDriverType == CommonDefinition.PCD_DRIVER_TYPE.PEI_PCD_DRIVER) {\r
+ hAutoGenString += MemoryDatabaseManager.PcdPeimHString;\r
+ cAutoGenString += MemoryDatabaseManager.PcdPeimCString;\r
+ } else if (pcdDriverType == CommonDefinition.PCD_DRIVER_TYPE.DXE_PCD_DRIVER) {\r
+ hAutoGenString += MemoryDatabaseManager.PcdDxeHString;\r
+ cAutoGenString += MemoryDatabaseManager.PcdDxeCString;\r
}\r
-\r
- //\r
- // Then execute the PCDAuotoGenAction to get generated Autogen.h and Autogen.c\r
- //\r
- PCDAutoGenAction autogenAction = new PCDAutoGenAction("MonoStatusCode",\r
- null,\r
- null,\r
- null,\r
- "IA32",\r
- null,\r
- false,\r
- nameArray);\r
- autogenAction.execute();\r
-\r
- System.out.println(autogenAction.OutputH());\r
- System.out.println("WQWQWQWQWQ");\r
- System.out.println(autogenAction.OutputC());\r
}\r
}\r
projects / mirror_edk2.git / blobdiff