tyler.durden/audk
1
0
Fork 0
mirror of https://github.com/acidanthera/audk.git synced 2025-07-25 06:34:30 +02:00
Code Issues Packages Projects Releases Wiki Activity

Abstract the logic of Platform pcd preprocess according to FPD file to a class. And add a new class for building process extend this abstract class.

Browse Source 
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@1169 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
klu2 2006-08-01 14:51:46 +00:00
parent af8eab8443
commit af98370ea4
5 changed files with 965 additions and 1813 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Tools/Source/GenBuild/org/tianocore/build/fpd/FpdParserTask.java
View File

@ -40,7 +40,7 @@ import org.tianocore.build.id.FpdModuleIdentification;
import org.tianocore.build.id.ModuleIdentification; import org.tianocore.build.id.ModuleIdentification;
import org.tianocore.build.id.PlatformIdentification; import org.tianocore.build.id.PlatformIdentification;
import org.tianocore.pcd.action.ActionMessage; import org.tianocore.pcd.action.ActionMessage;
import org.tianocore.build.pcd.action.CollectPCDAction; import org.tianocore.build.pcd.action.PlatformPcdPreprocessActionForBuilding;
import org.tianocore.build.toolchain.ToolChainAttribute; import org.tianocore.build.toolchain.ToolChainAttribute;
import org.tianocore.build.toolchain.ToolChainElement; import org.tianocore.build.toolchain.ToolChainElement;
import org.tianocore.build.toolchain.ToolChainMap; import org.tianocore.build.toolchain.ToolChainMap;
@ -386,7 +386,7 @@ public class FpdParserTask extends Task {
// Pcd Collection. Call CollectPCDAction to collect pcd info. // Pcd Collection. Call CollectPCDAction to collect pcd info.
// //
try { try {
CollectPCDAction ca = new CollectPCDAction(); PlatformPcdPreprocessActionForBuilding ca = new PlatformPcdPreprocessActionForBuilding();
ca.perform(GlobalData.getWorkspacePath(),platformId.getFpdFile().getPath(),ActionMessage.NULL_MESSAGE_LEVEL); ca.perform(GlobalData.getWorkspacePath(),platformId.getFpdFile().getPath(),ActionMessage.NULL_MESSAGE_LEVEL);
} catch (Exception e){ } catch (Exception e){
throw new BuildException(e.getMessage()); throw new BuildException(e.getMessage());

1535
Tools/Source/GenBuild/org/tianocore/build/pcd/action/CollectPCDAction.java
View File

File diff suppressed because it is too large Load Diff

132
Tools/Source/GenBuild/org/tianocore/build/pcd/action/PCDAutoGenAction.java
View File

@ -3,13 +3,13 @@
This class is to manage how to generate the PCD information into Autogen.c and This class is to manage how to generate the PCD information into Autogen.c and
Autogen.h. Autogen.h.
Copyright (c) 2006, Intel Corporation Copyright (c) 2006, Intel Corporation
All rights reserved. This program and the accompanying materials All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at which accompanies this distribution. The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php http://opensource.org/licenses/bsd-license.php
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
@ -19,21 +19,15 @@ package org.tianocore.build.pcd.action;
import java.io.File; import java.io.File;
import java.util.ArrayList; import java.util.ArrayList;
import java.util.List; import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.UUID;
import java.util.regex.Matcher; import java.util.regex.Matcher;
import java.util.regex.Pattern; import java.util.regex.Pattern;
import org.apache.xmlbeans.XmlObject;
import org.tianocore.build.global.GlobalData; import org.tianocore.build.global.GlobalData;
import org.tianocore.build.global.SurfaceAreaQuery;
import org.tianocore.build.id.ModuleIdentification; import org.tianocore.build.id.ModuleIdentification;
import org.tianocore.pcd.entity.MemoryDatabaseManager; import org.tianocore.pcd.entity.MemoryDatabaseManager;
import org.tianocore.pcd.entity.Token; import org.tianocore.pcd.entity.Token;
import org.tianocore.pcd.entity.UsageInstance; import org.tianocore.pcd.entity.UsageInstance;
import org.tianocore.pcd.exception.BuildActionException; import org.tianocore.pcd.exception.BuildActionException;
import org.tianocore.pcd.exception.EntityException;
import org.tianocore.pcd.entity.UsageIdentification; import org.tianocore.pcd.entity.UsageIdentification;
import org.tianocore.pcd.action.BuildAction; import org.tianocore.pcd.action.BuildAction;
import org.tianocore.pcd.action.ActionMessage; import org.tianocore.pcd.action.ActionMessage;
@ -46,33 +40,35 @@ public class PCDAutoGenAction extends BuildAction {
/// The reference of DBManager in GlobalData class. /// The reference of DBManager in GlobalData class.
/// ///
private MemoryDatabaseManager dbManager; private MemoryDatabaseManager dbManager;
/// ///
/// The identification for a UsageInstance. /// The identification for a UsageInstance.
///
private UsageIdentification usageId;
/// ///
/// The arch of current module private UsageIdentification usageId;
///
private String arch;
/// ///
/// Whether current autogen is for building library used by current module. /// Whether current autogen is for building library used by current module.
/// ///
private boolean isBuildUsedLibrary; private boolean isBuildUsedLibrary;
/// ///
/// The generated string for header file. /// The generated string for header file.
/// ///
private String hAutoGenString; private String hAutoGenString;
/// ///
/// The generated string for C code file. /// The generated string for C code file.
/// ///
private String cAutoGenString; private String cAutoGenString;
/// ///
/// The name array of <PcdCoded> in a module. /// The name array of <PcdCoded> in a module.
/// ///
private String[] pcdNameArrayInMsa; private String[] pcdNameArrayInMsa;
/** /**
Set parameter moduleId Set parameter moduleId
@param moduleName the module name parameter. @param moduleName the module name parameter.
**/ **/
public void setUsageId(UsageIdentification usageId) { public void setUsageId(UsageIdentification usageId) {
@ -81,7 +77,7 @@ public class PCDAutoGenAction extends BuildAction {
/** /**
set isBuildUsedLibrary parameter. set isBuildUsedLibrary parameter.
@param isBuildUsedLibrary @param isBuildUsedLibrary
**/ **/
public void setIsBuildUsedLibrary(boolean isBuildUsedLibrary) { public void setIsBuildUsedLibrary(boolean isBuildUsedLibrary) {
@ -90,7 +86,7 @@ public class PCDAutoGenAction extends BuildAction {
/** /**
set pcdNameArrayInMsa parameter. set pcdNameArrayInMsa parameter.
@param pcdNameArrayInMsa @param pcdNameArrayInMsa
*/ */
public void setPcdNameArrayInMsa(String[] pcdNameArrayInMsa) { public void setPcdNameArrayInMsa(String[] pcdNameArrayInMsa) {
@ -99,7 +95,7 @@ public class PCDAutoGenAction extends BuildAction {
/** /**
Get the output of generated string for header file. Get the output of generated string for header file.
@return the string of header file for PCD @return the string of header file for PCD
**/ **/
public String OutputH() { public String OutputH() {
@ -108,65 +104,63 @@ public class PCDAutoGenAction extends BuildAction {
/** /**
Get the output of generated string for C Code file. Get the output of generated string for C Code file.
@return the string of C code file for PCD @return the string of C code file for PCD
**/ **/
public String OutputC() { public String OutputC() {
return cAutoGenString; return cAutoGenString;
} }
/** /**
Construct function Construct function
This function mainly initialize some member variable. This function mainly initialize some member variable.
@param moduleId the identification for module @param moduleId the identification for module
@param arch the architecture for module @param arch the architecture for module
@param isBuildUsedLibary Is the current module library. @param isBuildUsedLibary Is the current module library.
@param pcdNameArrayInMsa the pcd name array got from MSA file. @param pcdNameArrayInMsa the pcd name array got from MSA file.
**/ **/
public PCDAutoGenAction(ModuleIdentification moduleId, public PCDAutoGenAction(ModuleIdentification moduleId,
String arch, String arch,
boolean isBuildUsedLibrary, boolean isBuildUsedLibrary,
String[] pcdNameArrayInMsa) { String[] pcdNameArrayInMsa) {
UsageIdentification usageId = new UsageIdentification(moduleId.getName(),
moduleId.getGuid(),
moduleId.getPackage().getName(),
moduleId.getPackage().getGuid(),
arch,
moduleId.getVersion(),
moduleId.getModuleType());
dbManager = null; dbManager = null;
hAutoGenString = ""; hAutoGenString = "";
cAutoGenString = ""; cAutoGenString = "";
setUsageId(usageId); setUsageId(new UsageIdentification(moduleId.getName(),
moduleId.getGuid(),
moduleId.getPackage().getName(),
moduleId.getPackage().getGuid(),
arch,
moduleId.getVersion(),
moduleId.getModuleType()));
setIsBuildUsedLibrary(isBuildUsedLibrary); setIsBuildUsedLibrary(isBuildUsedLibrary);
setPcdNameArrayInMsa(pcdNameArrayInMsa); setPcdNameArrayInMsa(pcdNameArrayInMsa);
} }
/** /**
check the parameter for action class. check the parameter for action class.
@throws BuildActionException Bad parameter. @throws BuildActionException Bad parameter.
**/ **/
public void checkParameter() throws BuildActionException { public void checkParameter() {
} }
/** /**
Core execution function for this action class. Core execution function for this action class.
All PCD information of this module comes from memory dabase. The collection All PCD information of this module comes from memory dabase. The collection
work should be done before this action execution. work should be done before this action execution.
Currently, we should generated all PCD information(maybe all dynamic) as array Currently, we should generated all PCD information(maybe all dynamic) as array
in Pei emulated driver for simulating PCD runtime database. in Pei emulated driver for simulating PCD runtime database.
@throws BuildActionException Failed to execute this aciton class. @throws BuildActionException Failed to execute this aciton class.
**/ **/
public void performAction() throws BuildActionException { public void performAction() {
ActionMessage.debug(this, ActionMessage.debug(this,
"Starting PCDAutoGenAction to generate autogen.h and autogen.c!..."); "Starting PCDAutoGenAction to generate autogen.h and autogen.c!...");
// //
// Check the PCD memory database manager is valid. // Check the PCD memory database manager is valid.
@ -189,7 +183,7 @@ public class PCDAutoGenAction extends BuildAction {
/** /**
Generate the autogen string for a common module. Generate the autogen string for a common module.
All PCD information of this module comes from memory dabase. The collection All PCD information of this module comes from memory dabase. The collection
work should be done before this action execution. work should be done before this action execution.
**/ **/
@ -207,23 +201,23 @@ public class PCDAutoGenAction extends BuildAction {
usageInstanceArray = null; usageInstanceArray = null;
if (!isBuildUsedLibrary) { if (!isBuildUsedLibrary) {
usageInstanceArray = dbManager.getUsageInstanceArrayByModuleName(usageId); usageInstanceArray = dbManager.getUsageInstanceArrayByModuleName(usageId);
dbManager.UsageInstanceContext = usageInstanceArray; MemoryDatabaseManager.UsageInstanceContext = usageInstanceArray;
dbManager.CurrentModuleName = moduleName; MemoryDatabaseManager.CurrentModuleName = moduleName;
} else if ((pcdNameArrayInMsa != null) && (pcdNameArrayInMsa.length > 0)) { } else if ((pcdNameArrayInMsa != null) && (pcdNameArrayInMsa.length > 0)) {
usageContext = dbManager.UsageInstanceContext; usageContext = MemoryDatabaseManager.UsageInstanceContext;
// //
// For building library package, although all module are library, but PCD entries of // For building library package, although all module are library, but PCD entries of
// these library should be used to autogen. // these library should be used to autogen.
// //
if (usageContext == null) { if (usageContext == null) {
usageInstanceArray = dbManager.getUsageInstanceArrayByModuleName(usageId); usageInstanceArray = dbManager.getUsageInstanceArrayByModuleName(usageId);
} else { } else {
usageInstanceArray = new ArrayList<UsageInstance>(); usageInstanceArray = new ArrayList<UsageInstance>();
// //
// Try to find all PCD defined in library's PCD in all <PcdEntry> in module's // Try to find all PCD defined in library's PCD in all <PcdEntry> in module's
// <ModuleSA> in FPD file. // <ModuleSA> in FPD file.
// //
for (index = 0; index < pcdNameArrayInMsa.length; index++) { for (index = 0; index < pcdNameArrayInMsa.length; index++) {
found = false; found = false;
for (index2 = 0; index2 < usageContext.size(); index2 ++) { for (index2 = 0; index2 < usageContext.size(); index2 ++) {
@ -238,14 +232,14 @@ public class PCDAutoGenAction extends BuildAction {
// //
// All library's PCD should instanted in module's <ModuleSA> who // All library's PCD should instanted in module's <ModuleSA> who
// use this library instance. If not, give errors. // use this library instance. If not, give errors.
// //
throw new BuildActionException (String.format("[PCD Autogen Error] Module %s use library instance %s, the PCD %s " + throw new BuildActionException (String.format("[PCD Autogen Error] Module %s use library instance %s, the PCD %s " +
"is required by this library instance, but can not find " + "is required by this library instance, but can not find " +
"it in the %s's <ModuleSA> in FPD file!", "it in the %s's <ModuleSA> in FPD file!",
dbManager.CurrentModuleName, MemoryDatabaseManager.CurrentModuleName,
moduleName, moduleName,
pcdNameArrayInMsa[index], pcdNameArrayInMsa[index],
dbManager.CurrentModuleName MemoryDatabaseManager.CurrentModuleName
)); ));
} }
} }
@ -258,18 +252,18 @@ public class PCDAutoGenAction extends BuildAction {
// //
// Generate all PCD entry for a module. // Generate all PCD entry for a module.
// //
for(index = 0; index < usageInstanceArray.size(); index ++) { for(index = 0; index < usageInstanceArray.size(); index ++) {
usageInstance = usageInstanceArray.get(index); usageInstance = usageInstanceArray.get(index);
// //
// Before generate any PCD information into autogen.h/autogen.c for a module, // Before generate any PCD information into autogen.h/autogen.c for a module,
// generate TokenSpaceGuid array variable firstly. For every dynamicEx type // generate TokenSpaceGuid array variable firstly. For every dynamicEx type
// PCD in this module the token, they are all reference to TokenSpaceGuid // PCD in this module the token, they are all reference to TokenSpaceGuid
// array. // array.
// //
if (usageInstanceArray.get(index).modulePcdType == Token.PCD_TYPE.DYNAMIC_EX) { if (usageInstanceArray.get(index).modulePcdType == Token.PCD_TYPE.DYNAMIC_EX) {
guidStringArray = usageInstance.parentToken.tokenSpaceName.split("-"); guidStringArray = usageInstance.parentToken.tokenSpaceName.split("-");
guidStringCName = "_gPcd_TokenSpaceGuid_" + guidStringCName = "_gPcd_TokenSpaceGuid_" +
usageInstance.parentToken.tokenSpaceName.replaceAll("-", "_"); usageInstance.parentToken.tokenSpaceName.replaceAll("-", "_");
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}}", 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}}",
guidStringArray[0], guidStringArray[0],
@ -283,22 +277,21 @@ public class PCDAutoGenAction extends BuildAction {
(guidStringArray[4].substring(6, 8)), (guidStringArray[4].substring(6, 8)),
(guidStringArray[4].substring(8, 10)), (guidStringArray[4].substring(8, 10)),
(guidStringArray[4].substring(10, 12))); (guidStringArray[4].substring(10, 12)));
Pattern pattern = Pattern.compile("(" + guidStringCName + ")+?"); Pattern pattern = Pattern.compile("(" + guidStringCName + ")+?");
Matcher matcher = pattern.matcher(cAutoGenString + " "); Matcher matcher = pattern.matcher(cAutoGenString + " ");
// //
// Find whether this guid array variable has been generated into autogen.c // Find whether this guid array variable has been generated into autogen.c
// For different DyanmicEx pcd token who use same token space guid, the token space // For different DyanmicEx pcd token who use same token space guid, the token space
// guid array should be only generated once. // guid array should be only generated once.
// //
if (!matcher.find()) { if (!matcher.find()) {
hAutoGenString += String.format("extern EFI_GUID %s;\r\n", hAutoGenString += String.format("extern EFI_GUID %s;\r\n", guidStringCName);
guidStringCName);
if (!isBuildUsedLibrary) { if (!isBuildUsedLibrary) {
cAutoGenString += String.format("GLOBAL_REMOVE_IF_UNREFERENCED EFI_GUID %s = %s;\r\n", cAutoGenString += String.format("GLOBAL_REMOVE_IF_UNREFERENCED EFI_GUID %s = %s;\r\n",
guidStringCName, guidStringCName,
guidString); guidString);
} }
} }
} }
@ -306,21 +299,21 @@ public class PCDAutoGenAction extends BuildAction {
// //
// For every PCD entry for this module(usage instance), autogen string would // For every PCD entry for this module(usage instance), autogen string would
// be appand. // be appand.
// //
hAutoGenString += usageInstance.getHAutogenStr() + "\r\n"; hAutoGenString += usageInstance.getHAutogenStr() + "\r\n";
cAutoGenString += usageInstance.getCAutogenStr(); cAutoGenString += usageInstance.getCAutogenStr();
} }
// //
// Work around code, In furture following code should be modified that get // Work around code, In furture following code should be modified that get
// these information from Uplevel Autogen tools. // these information from Uplevel Autogen tools.
// //
if (moduleName.equalsIgnoreCase("PcdPeim")) { if (moduleName.equalsIgnoreCase("PcdPeim")) {
hAutoGenString += dbManager.PcdPeimHString; hAutoGenString += MemoryDatabaseManager.PcdPeimHString;
cAutoGenString += dbManager.PcdPeimCString; cAutoGenString += MemoryDatabaseManager.PcdPeimCString;
} else if (moduleName.equalsIgnoreCase("PcdDxe")) { } else if (moduleName.equalsIgnoreCase("PcdDxe")) {
hAutoGenString += dbManager.PcdDxeHString; hAutoGenString += MemoryDatabaseManager.PcdDxeHString;
cAutoGenString += dbManager.PcdDxeCString; cAutoGenString += MemoryDatabaseManager.PcdDxeCString;
} }
} }
@ -333,18 +326,17 @@ public class PCDAutoGenAction extends BuildAction {
String WorkSpace = "X:/edk2"; String WorkSpace = "X:/edk2";
String logFilePath = WorkSpace + "/EdkNt32Pkg/Nt32.fpd"; String logFilePath = WorkSpace + "/EdkNt32Pkg/Nt32.fpd";
String[] nameArray = null;
// //
// At first, CollectPCDAction should be invoked to collect // At first, CollectPCDAction should be invoked to collect
// all PCD information from SPD, MSA, FPD. // all PCD information from SPD, MSA, FPD.
// //
CollectPCDAction collectionAction = new CollectPCDAction(); PlatformPcdPreprocessActionForBuilding collectionAction = new PlatformPcdPreprocessActionForBuilding();
GlobalData.initInfo("Tools" + File.separator + "Conf" + File.separator + "FrameworkDatabase.db", GlobalData.initInfo("Tools" + File.separator + "Conf" + File.separator + "FrameworkDatabase.db",
WorkSpace,null); WorkSpace,null);
try { try {
collectionAction.perform(WorkSpace, collectionAction.perform(WorkSpace,
logFilePath, logFilePath,
ActionMessage.MAX_MESSAGE_LEVEL); ActionMessage.MAX_MESSAGE_LEVEL);
} catch(Exception e) { } catch(Exception e) {

388
Tools/Source/GenBuild/org/tianocore/build/pcd/action/PcdDatabase.java
View File

File diff suppressed because it is too large Load Diff

719
Tools/Source/GenBuild/org/tianocore/build/pcd/action/PlatformPcdPreprocessActionForBuilding.java Normal file
View File

@ -0,0 +1,719 @@
/** @file
PlatformPcdPreprocessActionForBuilding class.
This action class is to collect PCD information from MSA, SPD, FPD xml file.
This class will be used for wizard and build tools, So it can *not* inherit
from buildAction or wizardAction.
Copyright (c) 2006, Intel Corporation
All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
package org.tianocore.build.pcd.action;
import java.io.File;
import java.io.IOException;
import java.math.BigInteger;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import org.apache.xmlbeans.XmlException;
import org.apache.xmlbeans.XmlObject;
import org.tianocore.DynamicPcdBuildDefinitionsDocument.DynamicPcdBuildDefinitions;
import org.tianocore.PlatformSurfaceAreaDocument;
import org.tianocore.build.fpd.FpdParserTask;
import org.tianocore.build.global.GlobalData;
import org.tianocore.build.id.FpdModuleIdentification;
import org.tianocore.pcd.action.ActionMessage;
import org.tianocore.pcd.entity.ModulePcdInfoFromFpd;
import org.tianocore.pcd.entity.MemoryDatabaseManager;
import org.tianocore.pcd.entity.Token;
import org.tianocore.pcd.entity.UsageIdentification;
import org.tianocore.pcd.exception.EntityException;
import org.tianocore.pcd.action.PlatformPcdPreprocessAction;
/**
This action class is to collect PCD information from MSA, SPD, FPD xml file.
This class will be used for wizard and build tools, So it can *not* inherit
from buildAction or UIAction.
**/
public class PlatformPcdPreprocessActionForBuilding extends PlatformPcdPreprocessAction {
///
/// Workspacepath hold the workspace information.
///
private String workspacePath;
///
/// FPD file is the root file.
///
private String fpdFilePath;
///
/// Message level for CollectPCDAction.
///
private int originalMessageLevel;
///
/// Cache the fpd docment instance for private usage.
///
private PlatformSurfaceAreaDocument fpdDocInstance;
/**
Set WorkspacePath parameter for this action class.
@param workspacePath parameter for this action
**/
public void setWorkspacePath(String workspacePath) {
this.workspacePath = workspacePath;
}
/**
Set action message level for CollectPcdAction tool.
The message should be restored when this action exit.
@param actionMessageLevel parameter for this action
**/
public void setActionMessageLevel(int actionMessageLevel) {
originalMessageLevel = ActionMessage.messageLevel;
ActionMessage.messageLevel = actionMessageLevel;
}
/**
Set FPDFileName parameter for this action class.
@param fpdFilePath fpd file path
**/
public void setFPDFilePath(String fpdFilePath) {
this.fpdFilePath = fpdFilePath;
}
/**
Common function interface for outer.
@param workspacePath The path of workspace of current build or analysis.
@param fpdFilePath The fpd file path of current build or analysis.
@param messageLevel The message level for this Action.
@throws Exception The exception of this function. Because it can *not* be predict
where the action class will be used. So only Exception can be throw.
**/
public void perform(String workspacePath, String fpdFilePath,
int messageLevel) throws Exception {
setWorkspacePath(workspacePath);
setFPDFilePath(fpdFilePath);
setActionMessageLevel(messageLevel);
checkParameter();
execute();
ActionMessage.messageLevel = originalMessageLevel;
}
/**
Core execution function for this action class.
This function work flows will be:
1) Collect and prepocess PCD information from FPD file, all PCD
information will be stored into memory database.
2) Generate 3 strings for
a) All modules using Dynamic(Ex) PCD entry.(Token Number)
b) PEI PCDDatabase (C Structure) for PCD Service PEIM.
c) DXE PCD Database (C structure) for PCD Service DXE.
@throws EntityException Exception indicate failed to execute this action.
**/
public void execute() throws EntityException {
MemoryDatabaseManager pcdDbManager = null;
//
// Get memoryDatabaseManager instance from GlobalData.
// The memoryDatabaseManager should be initialized for whatever build
// tools or wizard tools
//
if((pcdDbManager = GlobalData.getPCDMemoryDBManager()) == null) {
throw new EntityException("The instance of PCD memory database manager is null");
}
this.setPcdDbManager(pcdDbManager);
//
// Collect all PCD information defined in FPD file.
// Evenry token defind in FPD will be created as an token into
// memory database.
//
initPcdMemoryDbWithPlatformInfo();
//
// Generate for PEI, DXE PCD DATABASE's definition and initialization.
//
genPcdDatabaseSourceCode ();
}
/**
Override function: implementate the method of get Guid string information from SPD file.
@param guidCName Guid CName string.
@return String[] Guid information from SPD file.
**/
public String[] getGuidInfoFromSpd(String guidCName) throws EntityException {
String[] tokenSpaceStrRet = null;
try {
tokenSpaceStrRet = GlobalData.getGuidInfoFromCname(guidCName);
} catch ( Exception e ) {
throw new EntityException ("Failed get Guid CName " + guidCName + "from SPD file!");
}
return tokenSpaceStrRet;
}
/**
This function generates source code for PCD Database.
@param void
@throws EntityException If the token does *not* exist in memory database.
**/
private void genPcdDatabaseSourceCode()
throws EntityException {
String PcdCommonHeaderString = PcdDatabase.getPcdDatabaseCommonDefinitions();
ArrayList<Token> alPei = new ArrayList<Token> ();
ArrayList<Token> alDxe = new ArrayList<Token> ();
getPcdDbManager().getTwoPhaseDynamicRecordArray(alPei, alDxe);
PcdDatabase pcdPeiDatabase = new PcdDatabase (alPei, "PEI", 0);
pcdPeiDatabase.genCode();
MemoryDatabaseManager.PcdPeimHString = PcdCommonHeaderString + pcdPeiDatabase.getHString() +
PcdDatabase.getPcdPeiDatabaseDefinitions();
MemoryDatabaseManager.PcdPeimCString = pcdPeiDatabase.getCString();
PcdDatabase pcdDxeDatabase = new PcdDatabase(alDxe, "DXE", alPei.size());
pcdDxeDatabase.genCode();
MemoryDatabaseManager.PcdDxeHString = MemoryDatabaseManager.PcdPeimHString + pcdDxeDatabase.getHString() +
PcdDatabase.getPcdDxeDatabaseDefinitions();
MemoryDatabaseManager.PcdDxeCString = pcdDxeDatabase.getCString();
}
/**
Override function: Get component array from FPD.
This function maybe provided by some Global class.
@return List<ModuleInfo> the component array.
*/
public List<ModulePcdInfoFromFpd> getComponentsFromFpd()
throws EntityException {
List<ModulePcdInfoFromFpd> allModules = new ArrayList<ModulePcdInfoFromFpd>();
Map<FpdModuleIdentification, XmlObject> pcdBuildDefinitions = null;
UsageIdentification usageId = null;
pcdBuildDefinitions = GlobalData.getFpdPcdBuildDefinitions();
if (pcdBuildDefinitions == null) {
return null;
}
//
// Loop map to retrieve all PCD build definition and Module id
//
Iterator item = pcdBuildDefinitions.keySet().iterator();
while (item.hasNext()){
FpdModuleIdentification id = (FpdModuleIdentification) item.next();
usageId = new UsageIdentification(id.getModule().getName(),
id.getModule().getGuid(),
id.getModule().getPackage().getName(),
id.getModule().getPackage().getGuid(),
id.getArch(),
id.getModule().getVersion(),
id.getModule().getModuleType());
allModules.add(new ModulePcdInfoFromFpd(usageId, pcdBuildDefinitions.get(id)));
}
return allModules;
}
/**
Override function: Verify the datum value according its datum size and datum type, this
function maybe moved to FPD verification tools in future.
@param cName
@param moduleName
@param datum
@param datumType
@param maxDatumSize
@return String
*/
/***/
public String verifyDatum(String cName,
String moduleName,
String datum,
Token.DATUM_TYPE datumType,
int maxDatumSize) {
String exceptionString = null;
int value;
BigInteger value64;
String subStr;
int index;
if (moduleName == null) {
moduleName = "section <DynamicPcdBuildDefinitions>";
} else {
moduleName = "module " + moduleName;
}
if (maxDatumSize == 0) {
exceptionString = String.format("[FPD file error] You maybe miss <MaxDatumSize> for PCD %s in %s",
cName,
moduleName);
return exceptionString;
}
switch (datumType) {
case UINT8:
if (maxDatumSize != 1) {
exceptionString = String.format("[FPD file error] The datum type of PCD data %s in %s "+
"is UINT8, but datum size is %d, they are not matched!",
cName,
moduleName,
maxDatumSize);
return exceptionString;
}
if (datum != null) {
try {
value = Integer.decode(datum);
} catch (NumberFormatException nfeExp) {
exceptionString = String.format("[FPD file error] The datum for PCD %s in %s is not valid "+
"digital format of UINT8",
cName,
moduleName);
return exceptionString;
}
if (value > 0xFF) {
exceptionString = String.format("[FPD file error] The datum for PCD %s in %s is %s exceed"+
" the max size of UINT8 - 0xFF",
cName,
moduleName,
datum);
return exceptionString;
}
}
break;
case UINT16:
if (maxDatumSize != 2) {
exceptionString = String.format("[FPD file error] The datum type of PCD data %s in %s "+
"is UINT16, but datum size is %d, they are not matched!",
cName,
moduleName,
maxDatumSize);
return exceptionString;
}
if (datum != null) {
try {
value = Integer.decode(datum);
} catch (NumberFormatException nfeExp) {
exceptionString = String.format("[FPD file error] The datum for PCD %s in %s is "+
"not valid digital of UINT16",
cName,
moduleName);
return exceptionString;
}
if (value > 0xFFFF) {
exceptionString = String.format("[FPD file error] The datum for PCD %s in %s is %s "+
"which exceed the range of UINT16 - 0xFFFF",
cName,
moduleName,
datum);
return exceptionString;
}
}
break;
case UINT32:
if (maxDatumSize != 4) {
exceptionString = String.format("[FPD file error] The datum type of PCD data %s in %s "+
"is UINT32, but datum size is %d, they are not matched!",
cName,
moduleName,
maxDatumSize);
return exceptionString;
}
if (datum != null) {
try {
if (datum.length() > 2) {
if ((datum.charAt(0) == '0') &&
((datum.charAt(1) == 'x') || (datum.charAt(1) == 'X'))){
subStr = datum.substring(2, datum.length());
value64 = new BigInteger(subStr, 16);
} else {
value64 = new BigInteger(datum);
}
} else {
value64 = new BigInteger(datum);
}
} catch (NumberFormatException nfeExp) {
exceptionString = String.format("[FPD file error] The datum for PCD %s in %s is not "+
"valid digital of UINT32",
cName,
moduleName);
return exceptionString;
}
if (value64.bitLength() > 32) {
exceptionString = String.format("[FPD file error] The datum for PCD %s in %s is %s which "+
"exceed the range of UINT32 - 0xFFFFFFFF",
cName,
moduleName,
datum);
return exceptionString;
}
}
break;
case UINT64:
if (maxDatumSize != 8) {
exceptionString = String.format("[FPD file error] The datum type of PCD data %s in %s "+
"is UINT64, but datum size is %d, they are not matched!",
cName,
moduleName,
maxDatumSize);
return exceptionString;
}
if (datum != null) {
try {
if (datum.length() > 2) {
if ((datum.charAt(0) == '0') &&
((datum.charAt(1) == 'x') || (datum.charAt(1) == 'X'))){
subStr = datum.substring(2, datum.length());
value64 = new BigInteger(subStr, 16);
} else {
value64 = new BigInteger(datum);
}
} else {
value64 = new BigInteger(datum);
}
} catch (NumberFormatException nfeExp) {
exceptionString = String.format("[FPD file error] The datum for PCD %s in %s is not valid"+
" digital of UINT64",
cName,
moduleName);
return exceptionString;
}
if (value64.bitLength() > 64) {
exceptionString = String.format("[FPD file error] The datum for PCD %s in %s is %s "+
"exceed the range of UINT64 - 0xFFFFFFFFFFFFFFFF",
cName,
moduleName,
datum);
return exceptionString;
}
}
break;
case BOOLEAN:
if (maxDatumSize != 1) {
exceptionString = String.format("[FPD file error] The datum type of PCD data %s in %s "+
"is BOOLEAN, but datum size is %d, they are not matched!",
cName,
moduleName,
maxDatumSize);
return exceptionString;
}
if (datum != null) {
if (!(datum.equalsIgnoreCase("TRUE") ||
datum.equalsIgnoreCase("FALSE"))) {
exceptionString = String.format("[FPD file error] The datum type of PCD data %s in %s "+
"is BOOELAN, but value is not 'true'/'TRUE' or 'FALSE'/'false'",
cName,
moduleName);
return exceptionString;
}
}
break;
case POINTER:
if (datum == null) {
break;
}
char ch = datum.charAt(0);
int start, end;
String strValue;
//
// For void* type PCD, only three datum is support:
// 1) Unicode: string with start char is "L"
// 2) Ansci: String start char is ""
// 3) byte array: String start char "{"
//
if (ch == 'L') {
start = datum.indexOf('\"');
end = datum.lastIndexOf('\"');
if ((start > end) ||
(end > datum.length())||
((start == end) && (datum.length() > 0))) {
exceptionString = String.format("[FPD file error] The datum type of PCD %s in %s is VOID* and datum is "+
"a UNICODE string because start with L\", but format maybe"+
"is not right, correct UNICODE string is L\"...\"!",
cName,
moduleName);
return exceptionString;
}
strValue = datum.substring(start + 1, end);
if ((strValue.length() * 2) > maxDatumSize) {
exceptionString = String.format("[FPD file error] The datum type of PCD %s in %s is VOID*, and datum is "+
"a UNICODE string, but the datum size is %d exceed to <MaxDatumSize> : %d",
cName,
moduleName,
strValue.length() * 2,
maxDatumSize);
return exceptionString;
}
} else if (ch == '\"'){
start = datum.indexOf('\"');
end = datum.lastIndexOf('\"');
if ((start > end) ||
(end > datum.length())||
((start == end) && (datum.length() > 0))) {
exceptionString = String.format("[FPD file error] The datum type of PCD %s in %s is VOID* and datum is "+
"a ANSCII string because start with \", but format maybe"+
"is not right, correct ANSIC string is \"...\"!",
cName,
moduleName);
return exceptionString;
}
strValue = datum.substring(start + 1, end);
if ((strValue.length()) > maxDatumSize) {
exceptionString = String.format("[FPD file error] The datum type of PCD %s in %s is VOID*, and datum is "+
"a ANSCI string, but the datum size is %d which exceed to <MaxDatumSize> : %d",
cName,
moduleName,
strValue.length(),
maxDatumSize);
return exceptionString;
}
} else if (ch =='{') {
String[] strValueArray;
start = datum.indexOf('{');
end = datum.lastIndexOf('}');
strValue = datum.substring(start + 1, end);
strValue = strValue.trim();
if (strValue.length() == 0) {
exceptionString = String.format ("[FPD file error] The datum type of PCD %s in %s is VOID*, and "+
"it is byte array in fact, but '{}' is not valid for NULL datam but"+
" need use '{0}'",
cName,
moduleName);
return exceptionString;
}
strValueArray = strValue.split(",");
for (index = 0; index < strValueArray.length; index ++) {
try{
value = Integer.decode(strValueArray[index].trim());
} catch (NumberFormatException nfeEx) {
exceptionString = String.format("[FPD file error] The datum type of PCD %s in %s is VOID*, and "+
"it is byte array in fact. For every byte in array should be a valid"+
"byte digital, but element %s is not a valid byte digital!",
cName,
moduleName,
strValueArray[index]);
return exceptionString;
}
if (value > 0xFF) {
exceptionString = String.format("[FPD file error] The datum type of PCD %s in %s is VOID*, "+
"it is byte array in fact. But the element of %s exceed the byte range",
cName,
moduleName,
strValueArray[index]);
return exceptionString;
}
}
if (strValueArray.length > maxDatumSize) {
exceptionString = String.format("[FPD file error] The datum type of PCD %s in %s is VOID*, and datum is byte"+
"array, but the number of bytes is %d which exceed to <MaxDatumSzie> : %d!",
cName,
moduleName,
strValueArray.length,
maxDatumSize);
return exceptionString;
}
} else {
exceptionString = String.format("[FPD file error] The datum type of PCD %s in %s is VOID*. For VOID* type, you have three format choise:\n "+
"1) UNICODE string: like L\"xxxx\";\r\n"+
"2) ANSIC string: like \"xxx\";\r\n"+
"3) Byte array: like {0x2, 0x45, 0x23}\r\n"+
"But the datum in seems does not following above format!",
cName,
moduleName);
return exceptionString;
}
break;
default:
exceptionString = String.format("[FPD file error] For PCD entry %s in %s, datum type is unknown, it should be one of "+
"UINT8, UINT16, UINT32, UINT64, VOID*, BOOLEAN",
cName,
moduleName);
return exceptionString;
}
return null;
}
/**
Override function: Get dynamic information for a dynamic PCD from <DynamicPcdBuildDefinition> seciton in FPD file.
This function should be implemented in GlobalData in future.
@param token The token instance which has hold module's PCD information
@param moduleName The name of module who will use this Dynamic PCD.
@return DynamicPcdBuildDefinitions.PcdBuildData
**/
public DynamicPcdBuildDefinitions.PcdBuildData getDynamicInfoFromFpd(Token token,
String moduleName)
throws EntityException {
int index = 0;
String exceptionString = null;
String dynamicPrimaryKey = null;
DynamicPcdBuildDefinitions dynamicPcdBuildDefinitions = null;
List<DynamicPcdBuildDefinitions.PcdBuildData> dynamicPcdBuildDataArray = null;
String[] tokenSpaceStrRet = null;
//
// If FPD document is not be opened, open and initialize it.
// BUGBUG: The code should be moved into GlobalData in future.
//
if (fpdDocInstance == null) {
try {
fpdDocInstance = (PlatformSurfaceAreaDocument)XmlObject.Factory.parse(new File(fpdFilePath));
} catch(IOException ioE) {
throw new EntityException("File IO error for xml file:" + fpdFilePath + "\n" + ioE.getMessage());
} catch(XmlException xmlE) {
throw new EntityException("Can't parse the FPD xml fle:" + fpdFilePath + "\n" + xmlE.getMessage());
}
}
dynamicPcdBuildDefinitions = fpdDocInstance.getPlatformSurfaceArea().getDynamicPcdBuildDefinitions();
if (dynamicPcdBuildDefinitions == null) {
exceptionString = String.format("[FPD file error] There are no <PcdDynamicBuildDescriptions> in FPD file but contains Dynamic type "+
"PCD entry %s in module %s!",
token.cName,
moduleName);
throw new EntityException(exceptionString);
}
dynamicPcdBuildDataArray = dynamicPcdBuildDefinitions.getPcdBuildDataList();
for (index = 0; index < dynamicPcdBuildDataArray.size(); index ++) {
try {
tokenSpaceStrRet = GlobalData.getGuidInfoFromCname(dynamicPcdBuildDataArray.get(index).getTokenSpaceGuidCName());
} catch (Exception e) {
throw new EntityException ("Fail to get token space guid for token " + dynamicPcdBuildDataArray.get(index).getCName());
}
if (tokenSpaceStrRet == null) {
throw new EntityException ("Fail to get token space guid for token " + dynamicPcdBuildDataArray.get(index).getCName());
}
dynamicPrimaryKey = Token.getPrimaryKeyString(dynamicPcdBuildDataArray.get(index).getCName(),
tokenSpaceStrRet[1]);
if (dynamicPrimaryKey.equalsIgnoreCase(token.getPrimaryKeyString())) {
return dynamicPcdBuildDataArray.get(index);
}
}
return null;
}
/**
Override function: get all <DynamicPcdBuildDefinition> from FPD file.
@return List<DynamicPcdBuildDefinitions.PcdBuildData>
**/
public List<DynamicPcdBuildDefinitions.PcdBuildData>
getAllDynamicPcdInfoFromFpd()
throws EntityException {
DynamicPcdBuildDefinitions dynamicPcdBuildDefinitions = null;
//
// Open fpd document to get <DynamicPcdBuildDefinition> Section.
// BUGBUG: the function should be move GlobalData in furture.
//
if (fpdDocInstance == null) {
try {
fpdDocInstance = (PlatformSurfaceAreaDocument)XmlObject.Factory.parse(new File(fpdFilePath));
} catch(IOException ioE) {
throw new EntityException("File IO error for xml file:" + fpdFilePath + "\n" + ioE.getMessage());
} catch(XmlException xmlE) {
throw new EntityException("Can't parse the FPD xml fle:" + fpdFilePath + "\n" + xmlE.getMessage());
}
}
dynamicPcdBuildDefinitions = fpdDocInstance.getPlatformSurfaceArea().getDynamicPcdBuildDefinitions();
if (dynamicPcdBuildDefinitions == null) {
return null;
}
return dynamicPcdBuildDefinitions.getPcdBuildDataList();
}
/**
check parameter for this action.
@throws EntityException Bad parameter.
**/
private void checkParameter() throws EntityException {
File file = null;
if((fpdFilePath == null) ||(workspacePath == null)) {
throw new EntityException("WorkspacePath and FPDFileName should be blank for CollectPCDAtion!");
}
if(fpdFilePath.length() == 0 || workspacePath.length() == 0) {
throw new EntityException("WorkspacePath and FPDFileName should be blank for CollectPCDAtion!");
}
file = new File(workspacePath);
if(!file.exists()) {
throw new EntityException("WorkpacePath " + workspacePath + " does not exist!");
}
file = new File(fpdFilePath);
if(!file.exists()) {
throw new EntityException("FPD File " + fpdFilePath + " does not exist!");
}
}
/**
Test case function
@param argv parameter from command line
**/
public static void main(String argv[]) throws EntityException {
PlatformPcdPreprocessActionForBuilding ca = new PlatformPcdPreprocessActionForBuilding();
String projectDir = "x:/edk2";
ca.setWorkspacePath(projectDir);
ca.setFPDFilePath(projectDir + "/EdkNt32Pkg/Nt32.fpd");
ca.setActionMessageLevel(ActionMessage.MAX_MESSAGE_LEVEL);
GlobalData.initInfo("Tools" + File.separator + "Conf" + File.separator + "FrameworkDatabase.db",
projectDir,
"tools_def.txt");
System.out.println("After initInfo!");
FpdParserTask fpt = new FpdParserTask();
fpt.parseFpdFile(new File(projectDir + "/EdkNt32Pkg/Nt32.fpd"));
ca.execute();
}
}