X-Git-Url: https://git.proxmox.com/?p=mirror_edk2.git;a=blobdiff_plain;f=Tools%2FSource%2FGenBuild%2Forg%2Ftianocore%2Fbuild%2Fpcd%2Faction%2FCollectPCDAction.java;h=29819dd0d7cc0a64dfc53dc121021cab8fbd59e7;hp=4057c417e44783e1e10771b860ae36766d101673;hb=7629edbc44625aa7c5e99c24afe8bc2f7506fbf6;hpb=6ff7a41cb8b4e16800f70fd72e7290a418d4329e diff --git a/Tools/Source/GenBuild/org/tianocore/build/pcd/action/CollectPCDAction.java b/Tools/Source/GenBuild/org/tianocore/build/pcd/action/CollectPCDAction.java index 4057c417e4..29819dd0d7 100644 --- a/Tools/Source/GenBuild/org/tianocore/build/pcd/action/CollectPCDAction.java +++ b/Tools/Source/GenBuild/org/tianocore/build/pcd/action/CollectPCDAction.java @@ -21,29 +21,30 @@ import java.io.BufferedReader; import java.io.File; import java.io.FileReader; import java.io.IOException; +import java.math.BigInteger; import java.util.ArrayList; -import java.util.Collections; import java.util.Comparator; import java.util.HashMap; +import java.util.Iterator; 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.Pattern; import org.apache.xmlbeans.XmlException; import org.apache.xmlbeans.XmlObject; -import org.tianocore.DynamicPcdBuildDefinitionsDocument; import org.tianocore.DynamicPcdBuildDefinitionsDocument.DynamicPcdBuildDefinitions; -import org.tianocore.DynamicPcdBuildDefinitionsDocument.DynamicPcdBuildDefinitions.PcdBuildData.SkuInfo; -import org.tianocore.DynamicPcdBuildDefinitionsDocument.DynamicPcdBuildDefinitions.PcdBuildData; import org.tianocore.FrameworkModulesDocument; -import org.tianocore.FrameworkPlatformDescriptionDocument; -import org.tianocore.FrameworkPlatformDescriptionDocument.FrameworkPlatformDescription; +import org.tianocore.PlatformSurfaceAreaDocument; +import org.tianocore.PcdBuildDefinitionDocument; import org.tianocore.ModuleSADocument; -import org.tianocore.ModuleSADocument.ModuleSA; -import org.tianocore.PackageSurfaceAreaDocument; import org.tianocore.PcdBuildDefinitionDocument.PcdBuildDefinition; +import org.tianocore.build.autogen.CommonDefinition; +import org.tianocore.build.fpd.FpdParserTask; import org.tianocore.build.global.GlobalData; -import org.tianocore.build.global.SurfaceAreaQuery; +import org.tianocore.build.id.FpdModuleIdentification; import org.tianocore.build.pcd.action.ActionMessage; import org.tianocore.build.pcd.entity.DynamicTokenValue; import org.tianocore.build.pcd.entity.MemoryDatabaseManager; @@ -52,21 +53,47 @@ import org.tianocore.build.pcd.entity.Token; import org.tianocore.build.pcd.entity.UsageInstance; import org.tianocore.build.pcd.exception.EntityException; +/** + CStructTypeDeclaration + + This class is used to store the declaration string, such as + "UINT32 PcdPlatformFlashBaseAddress", of + each memember in the C structure, which is a standard C language + feature used to implement a simple and efficient database for + dynamic(ex) type PCD entry. +**/ + +class CStructTypeDeclaration { + String key; + int alignmentSize; + String cCode; + boolean initTable; + + public CStructTypeDeclaration (String key, int alignmentSize, String cCode, boolean initTable) { + this.key = key; + this.alignmentSize = alignmentSize; + this.cCode = cCode; + this.initTable = initTable; + } +} + +/** + StringTable + + This class is used to store the String in a PCD database. + +**/ class StringTable { private ArrayList al; private ArrayList alComments; private String phase; int len; - int bodyStart; - int bodyLineNum; public StringTable (String phase) { this.phase = phase; al = new ArrayList(); alComments = new ArrayList(); len = 0; - bodyStart = 0; - bodyLineNum = 0; } public String getSizeMacro () { @@ -80,70 +107,108 @@ class StringTable { return len == 0 ? 1 : len; } - public int getTableLen () { - return al.size() == 0 ? 1 : al.size(); - } - public String getExistanceMacro () { return String.format(PcdDatabase.StringTableExistenceMacro, phase, (al.size() == 0)? "TRUE":"FALSE"); } - - public String getTypeDeclaration () { - - String output; - + + public void genCode (ArrayList declaList, HashMap instTable) { final String stringTable = "StringTable"; - final String tab = "\t"; - final String newLine = ";\r\n"; - - output = "/* StringTable */\r\n"; - - if (al.size() == 0) { - output += tab + String.format("UINT16 %s[1] /* StringTable is Empty */", stringTable) + newLine; - } - - for (int i = 0; i < al.size(); i++) { - String str = al.get(i); - - if (i == 0) { - // - // StringTable is a well-known name in the PCD DXE driver - // - output += tab + String.format("UINT16 %s[%d] /* %s */", stringTable, str.length() + 1, alComments.get(i)) + newLine; - } else { - output += tab + String.format("UINT16 %s_%d[%d] /* %s */", stringTable, i, str.length() + 1, alComments.get(i)) + newLine; - } - } - - return output; - - } - - public ArrayList getInstantiation () { - ArrayList output = new ArrayList(); + final String tab = "\t"; + final String newLine = "\r\n"; + final String commaNewLine = ",\r\n"; + + CStructTypeDeclaration decl; - output.add("/* StringTable */"); + String cDeclCode = ""; + String cInstCode = ""; + // + // If we have a empty StringTable + // if (al.size() == 0) { - output.add("{ 0 }"); + cDeclCode += String.format("%-20s%s[1]; /* StringTable is empty */", "UINT16", stringTable) + newLine; + decl = new CStructTypeDeclaration ( + stringTable, + 2, + cDeclCode, + true + ); + declaList.add(decl); + + cInstCode = String.format("/* %s */", stringTable) + newLine + tab + "{ 0 }"; + instTable.put(stringTable, cInstCode); } else { - String str; + // + // If there is any String in the StringTable + // for (int i = 0; i < al.size(); i++) { - str = String.format("L\"%s\" /* %s */", al.get(i), alComments.get(i)); + String str = al.get(i); + String stringTableName; + + if (i == 0) { + // + // StringTable is a well-known name in the PCD DXE driver + // + stringTableName = stringTable; + + } else { + stringTableName = String.format("%s_%d", stringTable, i); + cDeclCode += tab; + } + cDeclCode += String.format("%-20s%s[%d]; /* %s */", "UINT16", + stringTableName, str.length() + 1, + alComments.get(i)) + + newLine; + + if (i == 0) { + cInstCode = "/* StringTable */" + newLine; + } + + cInstCode += tab + String.format("L\"%s\" /* %s */", al.get(i), alComments.get(i)); if (i != al.size() - 1) { - str += ","; + cInstCode += commaNewLine; } - output.add(str); } + + decl = new CStructTypeDeclaration ( + stringTable, + 2, + cDeclCode, + true + ); + declaList.add(decl); + + instTable.put(stringTable, cInstCode); } - - return output; } - public int add (String str, Token token) { + public int add (String inputStr, Token token) { int i; + int pos; + + String str = inputStr; + + // + // The input can be two types: + // "L\"Bootmode\"" or "Bootmode". + // We drop the L\" and \" for the first type. + if (str.startsWith("L\"") && str.endsWith("\"")) { + str = str.substring(2, str.length() - 1); + } + // + // Check if StringTable has this String already. + // If so, return the current pos. + // + for (i = 0, pos = 0; i < al.size(); i++) { + String s = al.get(i);; + if (str.equals(s)) { + return pos; + } + pos = s.length() + 1; + } + i = len; // // Include the NULL character at the end of String @@ -156,40 +221,57 @@ class StringTable { } } +/** + SizeTable + + This class is used to store the Size information for + POINTER TYPE PCD entry in a PCD database. + +**/ class SizeTable { private ArrayList al; private ArrayList alComments; private String phase; private int len; - private int bodyStart; - private int bodyLineNum; - + public SizeTable (String phase) { this.phase = phase; al = new ArrayList(); alComments = new ArrayList(); len = 0; - bodyStart = 0; - bodyLineNum = 0; } - public String getTypeDeclaration () { - return String.format(PcdDatabase.SizeTableDeclaration, phase); + public void genCode (ArrayList declaList, HashMap instTable, String phase) { + final String name = "SizeTable"; + + CStructTypeDeclaration decl; + String cCode; + + cCode = String.format(PcdDatabase.SizeTableDeclaration, phase); + decl = new CStructTypeDeclaration ( + name, + 2, + cCode, + true + ); + declaList.add(decl); + + + cCode = PcdDatabase.genInstantiationStr(getInstantiation()); + instTable.put(name, cCode); } - public ArrayList getInstantiation () { + private ArrayList getInstantiation () { ArrayList Output = new ArrayList(); Output.add("/* SizeTable */"); Output.add("{"); - bodyStart = 2; - if (al.size() == 0) { - Output.add("0"); + Output.add("\t0"); } else { for (int index = 0; index < al.size(); index++) { Integer n = al.get(index); - String str = n.toString(); + String str = "\t" + n.toString(); if (index != (al.size() - 1)) { str += ","; @@ -197,7 +279,6 @@ class SizeTable { str += " /* " + alComments.get(index) + " */"; Output.add(str); - bodyLineNum++; } } @@ -206,14 +287,6 @@ class SizeTable { return Output; } - public int getBodyStart() { - return bodyStart; - } - - public int getBodyLineNum () { - return bodyLineNum; - } - public int add (Token token) { int index = len; @@ -224,30 +297,22 @@ class SizeTable { return index; } - private int getDatumSize(Token token) { - /* - switch (token.datumType) { - case Token.DATUM_TYPE.UINT8: - return 1; - default: - return 0; - } - */ - return 0; - } - public int getTableLen () { return al.size() == 0 ? 1 : al.size(); } } +/** + GuidTable + + This class is used to store the GUIDs in a PCD database. +**/ class GuidTable { private ArrayList al; private ArrayList alComments; private String phase; private int len; - private int bodyStart; private int bodyLineNum; public GuidTable (String phase) { @@ -255,7 +320,6 @@ class GuidTable { al = new ArrayList(); alComments = new ArrayList(); len = 0; - bodyStart = 0; bodyLineNum = 0; } @@ -271,8 +335,24 @@ class GuidTable { return String.format(PcdDatabase.GuidTableExistenceMacro, phase, (al.size() == 0)? "TRUE":"FALSE"); } - public String getTypeDeclaration () { - return String.format(PcdDatabase.GuidTableDeclaration, phase); + public void genCode (ArrayList declaList, HashMap instTable, String phase) { + final String name = "GuidTable"; + + CStructTypeDeclaration decl; + String cCode = ""; + + cCode += String.format(PcdDatabase.GuidTableDeclaration, phase); + decl = new CStructTypeDeclaration ( + name, + 8, + cCode, + true + ); + declaList.add(decl); + + + cCode = PcdDatabase.genInstantiationStr(getInstantiation()); + instTable.put(name, cCode); } private String getUuidCString (UUID uuid) { @@ -280,7 +360,7 @@ class GuidTable { guidStrArray =(uuid.toString()).split("-"); - return String.format("{ 0x%s, 0x%s, 0x%s, { 0x%s, 0x%s, 0x%s, 0x%s, 0x%s, 0x%s, 0x%s, 0x%s } }", + return String.format("{0x%s, 0x%s, 0x%s, {0x%s, 0x%s, 0x%s, 0x%s, 0x%s, 0x%s, 0x%s, 0x%s}}", guidStrArray[0], guidStrArray[1], guidStrArray[2], @@ -295,22 +375,21 @@ class GuidTable { ); } - public ArrayList getInstantiation () { + private ArrayList getInstantiation () { ArrayList Output = new ArrayList(); Output.add("/* GuidTable */"); Output.add("{"); - bodyStart = 2; if (al.size() == 0) { - Output.add(getUuidCString(new UUID(0, 0))); + Output.add("\t" + getUuidCString(new UUID(0, 0))); } - for (Object u : al) { - UUID uuid = (UUID)u; - String str = getUuidCString(uuid); + for (int i = 0; i < al.size(); i++) { + String str = "\t" + getUuidCString(al.get(i)); - if (al.indexOf(u) != (al.size() - 1)) { + str += "/* " + alComments.get(i) + " */"; + if (i != (al.size() - 1)) { str += ","; } Output.add(str); @@ -322,45 +401,45 @@ class GuidTable { return Output; } - public int getBodyStart() { - return bodyStart; - } - - public int getBodyLineNum () { - return bodyLineNum; - } - public int add (UUID uuid, String name) { - int index = len; // - // Include the NULL character at the end of String + // Check if GuidTable has this entry already. + // If so, return the GuidTable index. // + for (int i = 0; i < al.size(); i++) { + if (al.get(i).equals(uuid)) { + return i; + } + } + len++; al.add(uuid); + alComments.add(name); - return index; - } - - public int getTableLen () { - return al.size() == 0 ? 0 : al.size(); + // + // Return the previous Table Index + // + return len - 1; } } +/** + SkuIdTable + + This class is used to store the SKU IDs in a PCD database. + +**/ class SkuIdTable { private ArrayList al; private ArrayList alComment; private String phase; private int len; - private int bodyStart; - private int bodyLineNum; public SkuIdTable (String phase) { this.phase = phase; al = new ArrayList(); alComment = new ArrayList(); - bodyStart = 0; - bodyLineNum = 0; len = 0; } @@ -369,26 +448,57 @@ class SkuIdTable { } private int getSize () { - return (al.size() == 0)? 1 : al.size(); + return (len == 0)? 1 : len; } public String getExistanceMacro () { return String.format(PcdDatabase.SkuTableExistenceMacro, phase, (al.size() == 0)? "TRUE":"FALSE"); } - public String getTypeDeclaration () { - return String.format(PcdDatabase.SkuIdTableDeclaration, phase); + public void genCode (ArrayList declaList, HashMap instTable, String phase) { + final String name = "SkuIdTable"; + + CStructTypeDeclaration decl; + String cCode = ""; + + cCode += String.format(PcdDatabase.SkuIdTableDeclaration, phase); + decl = new CStructTypeDeclaration ( + name, + 1, + cCode, + true + ); + declaList.add(decl); + + + cCode = PcdDatabase.genInstantiationStr(getInstantiation()); + instTable.put(name, cCode); + + // + // SystemSkuId is in PEI phase PCD Database + // + if (phase.equalsIgnoreCase("PEI")) { + decl = new CStructTypeDeclaration ( + "SystemSkuId", + 1, + String.format("%-20sSystemSkuId;\r\n", "SKU_ID"), + true + ); + declaList.add(decl); + + instTable.put("SystemSkuId", "0"); + } + } - public ArrayList getInstantiation () { + private ArrayList getInstantiation () { ArrayList Output = new ArrayList (); Output.add("/* SkuIdTable */"); Output.add("{"); - bodyStart = 2; if (al.size() == 0) { - Output.add("0"); + Output.add("\t0"); } for (int index = 0; index < al.size(); index++) { @@ -400,16 +510,15 @@ class SkuIdTable { Integer[] ia = al.get(index); - str += ia[0].toString() + ", "; + str += "\t" + ia[0].toString() + ", "; for (int index2 = 1; index2 < ia.length; index2++) { str += ia[index2].toString(); - if (index != al.size() - 1) { + if (!((index2 == ia.length - 1) && (index == al.size() - 1))) { str += ", "; } } Output.add(str); - bodyLineNum++; } @@ -421,6 +530,31 @@ class SkuIdTable { public int add (Token token) { int index; + int pos; + + // + // Check if this SKU_ID Array is already in the table + // + pos = 0; + for (Object o: al) { + Integer [] s = (Integer[]) o; + boolean different = false; + if (s[0] == token.getSkuIdCount()) { + for (index = 1; index < s.length; index++) { + if (s[index] != token.skuData.get(index-1).id) { + different = true; + break; + } + } + } else { + different = true; + } + if (different) { + pos += s[0] + 1; + } else { + return pos; + } + } Integer [] skuIds = new Integer[token.skuData.size() + 1]; skuIds[0] = new Integer(token.skuData.size()); @@ -437,10 +571,6 @@ class SkuIdTable { return index; } - public int getTableLen () { - return al.size() == 0 ? 1 : al.size(); - } - } class LocalTokenNumberTable { @@ -470,24 +600,39 @@ class LocalTokenNumberTable { return String.format(PcdDatabase.DatabaseExistenceMacro, phase, (al.size() == 0)? "TRUE":"FALSE"); } - public String getTypeDeclaration () { - return String.format(PcdDatabase.LocalTokenNumberTableDeclaration, phase); + public void genCode (ArrayList declaList, HashMap instTable, String phase) { + final String name = "LocalTokenNumberTable"; + + CStructTypeDeclaration decl; + String cCode = ""; + + cCode += String.format(PcdDatabase.LocalTokenNumberTableDeclaration, phase); + decl = new CStructTypeDeclaration ( + name, + 4, + cCode, + true + ); + declaList.add(decl); + + cCode = PcdDatabase.genInstantiationStr(getInstantiation()); + instTable.put(name, cCode); } - public ArrayList getInstantiation () { + private ArrayList getInstantiation () { ArrayList output = new ArrayList(); output.add("/* LocalTokenNumberTable */"); output.add("{"); if (al.size() == 0) { - output.add("0"); + output.add("\t0"); } for (int index = 0; index < al.size(); index++) { String str; - str = (String)al.get(index); + str = "\t" + (String)al.get(index); str += " /* " + alComment.get(index) + " */ "; @@ -513,7 +658,7 @@ class LocalTokenNumberTable { str = String.format(PcdDatabase.offsetOfStrTemplate, phase, token.hasDefaultValue() ? "Init" : "Uninit", token.getPrimaryKeyString()); - if (token.isStringType()) { + if (token.isUnicodeStringType()) { str += " | PCD_TYPE_STRING"; } @@ -536,8 +681,22 @@ class LocalTokenNumberTable { } } +/** + ExMapTable + + This class is used to store the table of mapping information + between DynamicEX ID pair(Guid, TokenNumber) and + the local token number assigned by PcdDatabase class. +**/ class ExMapTable { + /** + ExTriplet + + This class is used to store the mapping information + between DynamicEX ID pair(Guid, TokenNumber) and + the local token number assigned by PcdDatabase class. + **/ class ExTriplet { public Integer guidTableIdx; public Long exTokenNumber; @@ -554,15 +713,12 @@ class ExMapTable { private ArrayList alComment; private String phase; private int len; - private int bodyStart; private int bodyLineNum; - private int base; - + public ExMapTable (String phase) { this.phase = phase; al = new ArrayList(); alComment = new ArrayList(); - bodyStart = 0; bodyLineNum = 0; len = 0; } @@ -572,27 +728,39 @@ class ExMapTable { + String.format(PcdDatabase.ExTokenNumber, phase, al.size()); } - private int getSize () { - return (al.size() == 0)? 1 : al.size(); - } - public String getExistanceMacro () { return String.format(PcdDatabase.ExMapTableExistenceMacro, phase, (al.size() == 0)? "TRUE":"FALSE"); } - public String getTypeDeclaration () { - return String.format(PcdDatabase.ExMapTableDeclaration, phase); - } + public void genCode (ArrayList declaList, HashMap instTable, String phase) { + final String exMapTableName = "ExMapTable"; + + sortTable(); + + CStructTypeDeclaration decl; + String cCode = ""; + + cCode += String.format(PcdDatabase.ExMapTableDeclaration, phase); + decl = new CStructTypeDeclaration ( + exMapTableName, + 4, + cCode, + true + ); + declaList.add(decl); - public ArrayList getInstantiation () { + + cCode = PcdDatabase.genInstantiationStr(getInstantiation()); + instTable.put(exMapTableName, cCode); + } + + private ArrayList getInstantiation () { ArrayList Output = new ArrayList(); Output.add("/* ExMapTable */"); Output.add("{"); - bodyStart = 2; - if (al.size() == 0) { - Output.add("{0, 0, 0}"); + Output.add("\t{0, 0, 0}"); } int index; @@ -601,11 +769,11 @@ class ExMapTable { ExTriplet e = (ExTriplet)al.get(index); - str = "{ " + e.exTokenNumber.toString() + ", "; + str = "\t" + "{ " + String.format("0x%08X", e.exTokenNumber) + ", "; str += e.localTokenIdx.toString() + ", "; str += e.guidTableIdx.toString(); - str += " /* " + alComment.get(index) + " */"; + str += "}" + " /* " + alComment.get(index) + " */" ; if (index != al.size() - 1) { str += ","; @@ -631,25 +799,65 @@ class ExMapTable { return index; } - public int getTableLen () { + private int getTableLen () { return al.size() == 0 ? 1 : al.size(); } + // + // To simplify the algorithm for GetNextToken and GetNextTokenSpace in + // PCD PEIM/Driver, we need to sort the ExMapTable according to the + // following order: + // 1) ExGuid + // 2) ExTokenNumber + // + class ExTripletComp implements Comparator { + public int compare (ExTriplet a, ExTriplet b) { + if (a.guidTableIdx == b.guidTableIdx ) { + // + // exTokenNumber is long, we can't use simple substraction. + // + if (a.exTokenNumber > b.exTokenNumber) { + return 1; + } else if (a.exTokenNumber == b.exTokenNumber) { + return 0; + } else { + return -1; + } + } + + return a.guidTableIdx - b.guidTableIdx; + } + } + + private void sortTable () { + java.util.Comparator comparator = new ExTripletComp(); + java.util.Collections.sort(al, comparator); + } } +/** + PcdDatabase + + This class is used to generate C code for Autogen.h and Autogen.c of + a PCD service DXE driver and PCD service PEIM. +**/ class PcdDatabase { - public final static String ExMapTableDeclaration = "DYNAMICEX_MAPPING ExMapTable[%s_EXMAPPING_TABLE_SIZE];\r\n"; - public final static String GuidTableDeclaration = "EFI_GUID GuidTable[%s_GUID_TABLE_SIZE];\r\n"; - public final static String LocalTokenNumberTableDeclaration = "UINT32 LocalTokenNumberTable[%s_LOCAL_TOKEN_NUMBER_TABLE_SIZE];\r\n"; - public final static String StringTableDeclaration = "UINT16 StringTable[%s_STRING_TABLE_SIZE];\r\n"; - public final static String SizeTableDeclaration = "UINT16 SizeTable[%s_LOCAL_TOKEN_NUMBER_TABLE_SIZE];\r\n"; - public final static String SkuIdTableDeclaration = "UINT8 SkuIdTable[%s_SKUID_TABLE_SIZE];\r\n"; + private final static int SkuHeadAlignmentSize = 4; + private final String newLine = "\r\n"; + private final String commaNewLine = ",\r\n"; + private final String tab = "\t"; + public final static String ExMapTableDeclaration = "DYNAMICEX_MAPPING ExMapTable[%s_EXMAPPING_TABLE_SIZE];\r\n"; + public final static String GuidTableDeclaration = "EFI_GUID GuidTable[%s_GUID_TABLE_SIZE];\r\n"; + public final static String LocalTokenNumberTableDeclaration = "UINT32 LocalTokenNumberTable[%s_LOCAL_TOKEN_NUMBER_TABLE_SIZE];\r\n"; + public final static String StringTableDeclaration = "UINT16 StringTable[%s_STRING_TABLE_SIZE];\r\n"; + public final static String SizeTableDeclaration = "UINT16 SizeTable[%s_LOCAL_TOKEN_NUMBER_TABLE_SIZE];\r\n"; + public final static String SkuIdTableDeclaration = "UINT8 SkuIdTable[%s_SKUID_TABLE_SIZE];\r\n"; public final static String ExMapTableSizeMacro = "#define %s_EXMAPPING_TABLE_SIZE %d\r\n"; public final static String ExTokenNumber = "#define %s_EX_TOKEN_NUMBER %d\r\n"; - public final static String GuidTableSizeMacro = "#define %s_GUID_TABLE_SIZE %d\r\n"; + public final static String GuidTableSizeMacro = "#define %s_GUID_TABLE_SIZE %d\r\n"; public final static String LocalTokenNumberTableSizeMacro = "#define %s_LOCAL_TOKEN_NUMBER_TABLE_SIZE %d\r\n"; public final static String LocalTokenNumberSizeMacro = "#define %s_LOCAL_TOKEN_NUMBER %d\r\n"; public final static String StringTableSizeMacro = "#define %s_STRING_TABLE_SIZE %d\r\n"; @@ -663,7 +871,11 @@ class PcdDatabase { public final static String SkuTableExistenceMacro = "#define %s_SKUID_TABLE_EMPTY %s\r\n"; public final static String offsetOfSkuHeadStrTemplate = "offsetof(%s_PCD_DATABASE, %s.%s_SkuDataTable)"; + public final static String offsetOfVariableEnabledDefault = "offsetof(%s_PCD_DATABASE, %s.%s_VariableDefault_%d)"; public final static String offsetOfStrTemplate = "offsetof(%s_PCD_DATABASE, %s.%s)"; + + private final static String skuDataTableTemplate = "SkuDataTable"; + private StringTable stringTable; private GuidTable guidTable; @@ -676,6 +888,12 @@ class PcdDatabase { private String phase; private int assignedTokenNumber; + // + // Use two class global variable to store + // temperary + // + private String privateGlobalName; + private String privateGlobalCCode; // // After Major changes done to the PCD // database generation class PcdDatabase @@ -683,19 +901,26 @@ class PcdDatabase { // also update the version number in PCD // service PEIM and DXE driver accordingly. // - private final int version = 1; + private final int version = 2; private String hString; private String cString; - - class AlignmentSizeComp implements Comparator { - public int compare (Token a, Token b) { - return getAlignmentSize(b) - - getAlignmentSize(a); - } - } - + /** + Constructor for PcdDatabase class. + +

We have two PCD dynamic(ex) database for the Framework implementation. One + for PEI phase and the other for DXE phase.

+ + @param alTokens A ArrayList of Dynamic(EX) PCD entry. + @param exePhase The phase to generate PCD database for: valid input + is "PEI" or "DXE". + @param startLen The starting Local Token Number for the PCD database. For + PEI phase, the starting Local Token Number starts from 0. + For DXE phase, the starting Local Token Number starts + from the total number of PCD entry of PEI phase. + @return void + **/ public PcdDatabase (ArrayList alTokens, String exePhase, int startLen) { phase = exePhase; @@ -706,23 +931,71 @@ class PcdDatabase { sizeTable = new SizeTable(phase); exMapTable = new ExMapTable(phase); - assignedTokenNumber = startLen; + // + // Local token number 0 is reserved for INVALID_TOKEN_NUMBER. + // So we will increment 1 for the startLen passed from the + // constructor. + // + assignedTokenNumber = startLen + 1; this.alTokens = alTokens; } - private void getTwoGroupsOfTokens (ArrayList alTokens, List initTokens, List uninitTokens) { + private void getNonExAndExTokens (ArrayList alTokens, List nexTokens, List exTokens) { for (int i = 0; i < alTokens.size(); i++) { Token t = (Token)alTokens.get(i); - if (t.hasDefaultValue()) { - initTokens.add(t); + if (t.isDynamicEx()) { + exTokens.add(t); } else { - uninitTokens.add(t); + nexTokens.add(t); } } return; } + private int getDataTypeAlignmentSize (Token token) { + switch (token.datumType) { + case UINT8: + return 1; + case UINT16: + return 2; + case UINT32: + return 4; + case UINT64: + return 8; + case POINTER: + return 1; + case BOOLEAN: + return 1; + default: + return 1; + } + } + + private int getHiiPtrTypeAlignmentSize(Token token) { + switch (token.datumType) { + case UINT8: + return 1; + case UINT16: + return 2; + case UINT32: + return 4; + case UINT64: + return 8; + case POINTER: + if (token.isHiiEnable()) { + if (token.isHiiDefaultValueUnicodeStringType()) { + return 2; + } + } + return 1; + case BOOLEAN: + return 1; + default: + return 1; + } + } + private int getAlignmentSize (Token token) { if (token.getDefaultSku().type == DynamicTokenValue.VALUE_TYPE.HII_TYPE) { return 2; @@ -732,25 +1005,11 @@ class PcdDatabase { return 4; } - if (token.isStringType()) { + if (token.isUnicodeStringType()) { return 2; } - - switch (token.datumType) { - case UINT8: - return 1; - case UINT16: - return 2; - case UINT32: - return 4; - case UINT64: - return 8; - case POINTER: - return 1; - case BOOLEAN: - return 1; - } - return 1; + + return getDataTypeAlignmentSize(token); } public String getCString () { @@ -760,46 +1019,122 @@ class PcdDatabase { public String getHString () { return hString; } + + private void genCodeWorker(Token t, + ArrayList declaList, + HashMap instTable, String phase) + throws EntityException { - public void genCode () - throws EntityException { + CStructTypeDeclaration decl; - final String newLine = "\r\n"; - final String declNewLine = ";\r\n"; - final String tab = "\t"; - final String commaNewLine = ", \r\n"; + // + // Insert SKU_HEAD if isSkuEnable is true + // + if (t.isSkuEnable()) { + int tableIdx; + tableIdx = skuIdTable.add(t); + decl = new CStructTypeDeclaration(t.getPrimaryKeyString(), + SkuHeadAlignmentSize, getSkuEnabledTypeDeclaration(t), true); + declaList.add(decl); + instTable.put(t.getPrimaryKeyString(), + getSkuEnabledTypeInstantiaion(t, tableIdx)); + } - int i; - ArrayList decla; - ArrayList inst; + // + // Insert PCD_ENTRY declaration and instantiation + // + getCDeclarationString(t); - String macroStr = ""; - String initDeclStr = ""; - String initInstStr = ""; - String uninitDeclStr = ""; + decl = new CStructTypeDeclaration(privateGlobalName, + getAlignmentSize(t), privateGlobalCCode, t.hasDefaultValue()); + declaList.add(decl); + + if (t.hasDefaultValue()) { + instTable.put(privateGlobalName, + getTypeInstantiation(t, declaList, instTable, phase) + ); + } - List initTokens = new ArrayList (); - List uninitTokens = new ArrayList (); + } + + private void ProcessTokens (List tokens, + ArrayList cStructDeclList, + HashMap cStructInstTable, + String phase + ) + throws EntityException { - HashMap > initCode = new HashMap> (); - HashMap > uninitCode = new HashMap> (); + for (int idx = 0; idx < tokens.size(); idx++) { + Token t = tokens.get(idx); + + genCodeWorker (t, cStructDeclList, cStructInstTable, phase); + + sizeTable.add(t); + localTokenNumberTable.add(t); + t.tokenNumber = assignedTokenNumber++; + + // + // Add a mapping if this dynamic PCD entry is a EX type + // + if (t.isDynamicEx()) { + exMapTable.add((int)t.tokenNumber, + t.dynamicExTokenNumber, + guidTable.add(t.tokenSpaceName, t.getPrimaryKeyString()), + t.getPrimaryKeyString() + ); + } + } - getTwoGroupsOfTokens (alTokens, initTokens, uninitTokens); + } + + public void genCode () throws EntityException { + + ArrayList cStructDeclList = new ArrayList(); + HashMap cStructInstTable = new HashMap(); + + List nexTokens = new ArrayList (); + List exTokens = new ArrayList (); - // - // Generate Structure Declaration for PcdTokens without Default Value - // PEI_PCD_DATABASE_INIT - // - java.util.Comparator comparator = new AlignmentSizeComp(); - java.util.Collections.sort(initTokens, comparator); - initCode = processTokens(initTokens); + getNonExAndExTokens (alTokens, nexTokens, exTokens); // - // Generate Structure Declaration for PcdTokens without Default Value - // PEI_PCD_DATABASE_UNINIT + // We have to process Non-Ex type PCD entry first. The reason is + // that our optimization assumes that the Token Number of Non-Ex + // PCD entry start from 1 (for PEI phase) and grows continously upwards. + // + // EX type token number starts from the last Non-EX PCD entry and + // grows continously upwards. // - java.util.Collections.sort(uninitTokens, comparator); - uninitCode = processTokens(uninitTokens); + ProcessTokens (nexTokens, cStructDeclList, cStructInstTable, phase); + ProcessTokens (exTokens, cStructDeclList, cStructInstTable, phase); + + stringTable.genCode(cStructDeclList, cStructInstTable); + skuIdTable.genCode(cStructDeclList, cStructInstTable, phase); + exMapTable.genCode(cStructDeclList, cStructInstTable, phase); + localTokenNumberTable.genCode(cStructDeclList, cStructInstTable, phase); + sizeTable.genCode(cStructDeclList, cStructInstTable, phase); + guidTable.genCode(cStructDeclList, cStructInstTable, phase); + + hString = genCMacroCode (); + + HashMap result; + + result = genCStructCode(cStructDeclList, + cStructInstTable, + phase + ); + + hString += result.get("initDeclStr"); + hString += result.get("uninitDeclStr"); + + hString += String.format("#define PCD_%s_SERVICE_DRIVER_VERSION %d", phase, version); + + cString = newLine + newLine + result.get("initInstStr"); + + } + + private String genCMacroCode () { + String macroStr = ""; // // Generate size info Macro for all Tables @@ -819,105 +1154,108 @@ class PcdDatabase { macroStr += localTokenNumberTable.getExistanceMacro(); macroStr += exMapTable.getExistanceMacro(); + macroStr += newLine; + + return macroStr; + } + + private HashMap genCStructCode( + ArrayList declaList, + HashMap instTable, + String phase + ) { + + int i; + HashMap result = new HashMap(); + HashMap > alignmentInitDecl = new HashMap>(); + HashMap > alignmentUninitDecl = new HashMap>(); + HashMap > alignmentInitInst = new HashMap>(); + // - // Generate Structure Declaration for PcdTokens with Default Value - // for example PEI_PCD_DATABASE_INIT + // Initialize the storage for each alignment // - initDeclStr += "typedef struct {" + newLine; - { - initDeclStr += tab + exMapTable.getTypeDeclaration(); - initDeclStr += tab + guidTable.getTypeDeclaration(); - initDeclStr += tab + localTokenNumberTable.getTypeDeclaration(); - initDeclStr += tab + stringTable.getTypeDeclaration(); - initDeclStr += tab + sizeTable.getTypeDeclaration(); - initDeclStr += tab + skuIdTable.getTypeDeclaration(); - if (phase.equalsIgnoreCase("PEI")) { - initDeclStr += tab + "SKU_ID SystemSkuId;" + newLine; - } - - decla = initCode.get(new String("Declaration")); - for (i = 0; i < decla.size(); i++) { - initDeclStr += tab + decla.get(i) + declNewLine; - } - - // - // Generate Structure Declaration for PcdToken with SkuEnabled - // - decla = initCode.get("DeclarationForSku"); - - for (i = 0; i < decla.size(); i++) { - initDeclStr += tab + decla.get(i) + declNewLine; - } - } - initDeclStr += String.format("} %s_PCD_DATABASE_INIT;\r\n\r\n", phase); + for (i = 8; i > 0; i>>=1) { + alignmentInitDecl.put(new Integer(i), new ArrayList()); + alignmentInitInst.put(new Integer(i), new ArrayList()); + alignmentUninitDecl.put(new Integer(i), new ArrayList()); + } + + String initDeclStr = "typedef struct {" + newLine; + String initInstStr = String.format("%s_PCD_DATABASE_INIT g%sPcdDbInit = { ", phase.toUpperCase(), phase.toUpperCase()) + newLine; + String uninitDeclStr = "typedef struct {" + newLine; // - // Generate MACRO for structure intialization of PCDTokens with Default Value - // The sequence must match the sequence of declaration of the memembers in the structure - String tmp = String.format("%s_PCD_DATABASE_INIT g%sPcdDbInit = { ", phase.toUpperCase(), phase.toUpperCase()); - initInstStr += tmp + newLine; - initInstStr += tab + genInstantiationStr(exMapTable.getInstantiation()) + commaNewLine; - initInstStr += tab + genInstantiationStr(guidTable.getInstantiation()) + commaNewLine; - initInstStr += tab + genInstantiationStr(localTokenNumberTable.getInstantiation()) + commaNewLine; - initInstStr += tab + genInstantiationStr(stringTable.getInstantiation()) + commaNewLine; - initInstStr += tab + genInstantiationStr(sizeTable.getInstantiation()) + commaNewLine; - initInstStr += tab + genInstantiationStr(skuIdTable.getInstantiation()) + commaNewLine; - // - // For SystemSkuId + // Sort all C declaration and instantiation base on Alignment Size // - if (phase.equalsIgnoreCase("PEI")) { - initInstStr += tab + "0" + tab + "/* SystemSkuId */" + commaNewLine; - } - - inst = initCode.get("Instantiation"); - for (i = 0; i < inst.size(); i++) { - initInstStr += tab + inst.get(i) + commaNewLine; - } - - inst = initCode.get("InstantiationForSku"); - for (i = 0; i < inst.size(); i++) { - initInstStr += tab + inst.get(i); - if (i != inst.size() - 1) { - initInstStr += commaNewLine; + for (Object d : declaList) { + CStructTypeDeclaration decl = (CStructTypeDeclaration) d; + + if (decl.initTable) { + alignmentInitDecl.get(new Integer(decl.alignmentSize)).add(decl.cCode); + alignmentInitInst.get(new Integer(decl.alignmentSize)).add(instTable.get(decl.key)); + } else { + alignmentUninitDecl.get(new Integer(decl.alignmentSize)).add(decl.cCode); } } - initInstStr += "};"; - - uninitDeclStr += "typedef struct {" + newLine; - { - decla = uninitCode.get("Declaration"); - if (decla.size() == 0) { - uninitDeclStr += "UINT8 dummy /* The UINT struct is empty */" + declNewLine; + // + // Generate code for every alignment size + // + boolean uinitDatabaseEmpty = true; + for (int align = 8; align > 0; align >>= 1) { + ArrayList declaListBasedOnAlignment = alignmentInitDecl.get(new Integer(align)); + ArrayList instListBasedOnAlignment = alignmentInitInst.get(new Integer(align)); + for (i = 0; i < declaListBasedOnAlignment.size(); i++) { + initDeclStr += tab + declaListBasedOnAlignment.get(i); + initInstStr += tab + instListBasedOnAlignment.get(i); + + // + // We made a assumption that both PEI_PCD_DATABASE and DXE_PCD_DATABASE + // has a least one data memember with alignment size of 1. So we can + // remove the last "," in the C structure instantiation string. Luckily, + // this is true as both data structure has SKUID_TABLE anyway. + // + if ((align == 1) && (i == declaListBasedOnAlignment.size() - 1)) { + initInstStr += newLine; } else { - - for (i = 0; i < decla.size(); i++) { - uninitDeclStr += tab + decla.get(i) + declNewLine; - } - - decla = uninitCode.get("DeclarationForSku"); - - for (i = 0; i < decla.size(); i++) { - uninitDeclStr += tab + decla.get(i) + declNewLine; - } + initInstStr += commaNewLine; } } - uninitDeclStr += String.format("} %s_PCD_DATABASE_UNINIT;\r\n\r\n", phase); - - cString = initInstStr + newLine; - hString = macroStr + newLine - + initDeclStr + newLine - + uninitDeclStr + newLine - + newLine; + + declaListBasedOnAlignment = alignmentUninitDecl.get(new Integer(align)); + + if (declaListBasedOnAlignment.size() != 0) { + uinitDatabaseEmpty = false; + } + + for (Object d : declaListBasedOnAlignment) { + String s = (String)d; + uninitDeclStr += tab + s; + } + } + + if (uinitDatabaseEmpty) { + uninitDeclStr += tab + String.format("%-20sdummy; /* PCD_DATABASE_UNINIT is emptry */\r\n", "UINT8"); + } + + initDeclStr += String.format("} %s_PCD_DATABASE_INIT;", phase) + newLine + newLine; + initInstStr += "};" + newLine; + uninitDeclStr += String.format("} %s_PCD_DATABASE_UNINIT;", phase) + newLine + newLine; - hString += String.format("#define PCD_%s_SERVICE_DRIVER_VERSION %d", phase, version); + result.put("initDeclStr", initDeclStr); + result.put("initInstStr", initInstStr); + result.put("uninitDeclStr", uninitDeclStr); + return result; } - private String genInstantiationStr (ArrayList alStr) { + public static String genInstantiationStr (ArrayList alStr) { String str = ""; for (int i = 0; i< alStr.size(); i++) { - str += "\t" + alStr.get(i); + if (i != 0) { + str += "\t"; + } + str += alStr.get(i); if (i != alStr.size() - 1) { str += "\r\n"; } @@ -926,134 +1264,83 @@ class PcdDatabase { return str; } - private HashMap> processTokens (List alToken) - throws EntityException { - - HashMap > map = new HashMap>(); - - ArrayList decl = new ArrayList(); - ArrayList declForSkuEnableType = new ArrayList(); - ArrayList inst = new ArrayList(); - ArrayList instForSkuEnableType = new ArrayList(); - - for (int index = 0; index < alToken.size(); index++) { - Token token = alToken.get(index); - - if (token.isSkuEnable()) { - // - // BugBug: Schema only support Data type now - // - int tableIdx; - - tableIdx = skuIdTable.add(token); - - decl.add(getSkuEnabledTypeDeclaration(token)); - if (token.hasDefaultValue()) { - inst.add(getSkuEnabledTypeInstantiaion(token, tableIdx)); - } - - declForSkuEnableType.add(getDataTypeDeclarationForSkuEnabled(token)); - if (token.hasDefaultValue()) { - instForSkuEnableType.add(getDataTypeInstantiationForSkuEnabled(token)); - } - - } else { - if (token.getDefaultSku().type == DynamicTokenValue.VALUE_TYPE.HII_TYPE) { - decl.add(getVariableEnableTypeDeclaration(token)); - inst.add(getVariableEnableInstantiation(token)); - } else if (token.getDefaultSku().type == DynamicTokenValue.VALUE_TYPE.VPD_TYPE) { - decl.add(getVpdEnableTypeDeclaration(token)); - inst.add(getVpdEnableTypeInstantiation(token)); - } else if (token.isStringType()) { - decl.add(getStringTypeDeclaration(token)); - inst.add(getStringTypeInstantiation(stringTable.add(token.getStringTypeString(), token), token)); - } - else { - decl.add(getDataTypeDeclaration(token)); - if (token.hasDefaultValue()) { - inst.add(getDataTypeInstantiation(token)); - } - } - } - - sizeTable.add(token); - localTokenNumberTable.add(token); - token.tokenNumber = assignedTokenNumber++; - - } - - map.put("Declaration", decl); - map.put("DeclarationForSku", declForSkuEnableType); - map.put("Instantiation", inst); - map.put("InstantiationForSku", instForSkuEnableType); - - return map; - } - private String getSkuEnabledTypeDeclaration (Token token) { - return String.format("SKU_HEAD %s;\r\n", token.getPrimaryKeyString()); + return String.format("%-20s%s;\r\n", "SKU_HEAD", token.getPrimaryKeyString()); } private String getSkuEnabledTypeInstantiaion (Token token, int SkuTableIdx) { String offsetof = String.format(PcdDatabase.offsetOfSkuHeadStrTemplate, phase, token.hasDefaultValue()? "Init" : "Uninit", token.getPrimaryKeyString()); - return String.format("{ %s, %d }", offsetof, SkuTableIdx); + return String.format("{ %s, %d } /* SKU_ENABLED: %s */", offsetof, SkuTableIdx, token.getPrimaryKeyString()); } - private String getDataTypeDeclarationForSkuEnabled (Token token) { - String typeStr = ""; - - if (token.datumType == Token.DATUM_TYPE.UINT8) { - typeStr = "UINT8 %s_%s[%d];\r\n"; - } else if (token.datumType == Token.DATUM_TYPE.UINT16) { - typeStr = "UINT16 %s_%s[%d];\r\n"; - } else if (token.datumType == Token.DATUM_TYPE.UINT32) { - typeStr = "UINT32 %s_%s[%d];\r\n"; - } else if (token.datumType == Token.DATUM_TYPE.UINT64) { - typeStr = "UINT64 %s_%s[%d];\r\n"; - } else if (token.datumType == Token.DATUM_TYPE.BOOLEAN) { - typeStr = "BOOLEAN %s_%s[%d];\r\n"; - } else if (token.datumType == Token.DATUM_TYPE.POINTER) { - return String.format("UINT8 %s_%s[%d];\r\n", token.getPrimaryKeyString(), "SkuDataTable", token.datumSize * token.skuData.size()); - } - - return String.format(typeStr, token.getPrimaryKeyString(), "SkuDataTable", token.skuData.size()); - + private String getDataTypeInstantiationForVariableDefault (Token token, String cName, int skuId) { + return String.format("%s /* %s */", token.skuData.get(skuId).value.hiiDefaultValue, cName); } - private String getDataTypeInstantiationForSkuEnabled (Token token) { - String str = ""; - - if (token.datumType == Token.DATUM_TYPE.POINTER) { - return String.format("UINT8 %s_%s[%d]", token.getPrimaryKeyString(), "SkuDataTable", token.datumSize * token.skuData.size()); - } else { - str = "{ "; - for (int idx = 0; idx < token.skuData.size(); idx++) { - str += token.skuData.get(idx).toString(); - if (idx != token.skuData.size() - 1) { - str += ", "; - } - } - str += "}"; - - return str; + private String getCType (Token t) + throws EntityException { + + if (t.isHiiEnable()) { + return "VARIABLE_HEAD"; + } + + if (t.isVpdEnable()) { + return "VPD_HEAD"; + } + + if (t.isUnicodeStringType()) { + return "STRING_HEAD"; + } + + switch (t.datumType) { + case UINT64: + return "UINT64"; + case UINT32: + return "UINT32"; + case UINT16: + return "UINT16"; + case UINT8: + return "UINT8"; + case BOOLEAN: + return "BOOLEAN"; + case POINTER: + return "UINT8"; + default: + throw new EntityException("Unknown type in getDataTypeCDeclaration"); } - } + + private void getCDeclarationString(Token t) + throws EntityException { + + if (t.isSkuEnable()) { + privateGlobalName = String.format("%s_%s", t.getPrimaryKeyString(), skuDataTableTemplate); + } else { + privateGlobalName = t.getPrimaryKeyString(); + } - private String getDataTypeInstantiation (Token token) { - - if (token.datumType == Token.DATUM_TYPE.POINTER) { - return String.format("%s /* %s */", token.getDefaultSku().value, token.getPrimaryKeyString()); + String type = getCType(t); + if ((t.datumType == Token.DATUM_TYPE.POINTER) && (!t.isHiiEnable())) { + int bufferSize; + if (t.isASCIIStringType()) { + // + // Build tool will add a NULL string at the end of the ASCII string + // + bufferSize = t.datumSize + 1; + } else { + bufferSize = t.datumSize; + } + privateGlobalCCode = String.format("%-20s%s[%d][%d];\r\n", type, privateGlobalName, t.getSkuIdCount(), bufferSize); } else { - return String.format("%s /* %s */", token.getDefaultSku().value, token.getPrimaryKeyString()); + privateGlobalCCode = String.format("%-20s%s[%d];\r\n", type, privateGlobalName, t.getSkuIdCount()); } } + + private String getDataTypeDeclarationForVariableDefault (Token token, String cName, int skuId) + throws EntityException { - - private String getDataTypeDeclaration (Token token) { - - String typeStr = ""; + String typeStr; if (token.datumType == Token.DATUM_TYPE.UINT8) { typeStr = "UINT8"; @@ -1066,51 +1353,100 @@ class PcdDatabase { } else if (token.datumType == Token.DATUM_TYPE.BOOLEAN) { typeStr = "BOOLEAN"; } else if (token.datumType == Token.DATUM_TYPE.POINTER) { - return String.format("UINT8 %s[%d]", token.getPrimaryKeyString(), token.datumSize); + int size; + if (token.isHiiDefaultValueUnicodeStringType()) { + typeStr = "UINT16"; + // + // Include the NULL charactor + // + size = token.datumSize / 2 + 1; + } else { + typeStr = "UINT8"; + if (token.isHiiDefaultValueASCIIStringType()) { + // + // Include the NULL charactor + // + size = token.datumSize + 1; + } else { + size = token.datumSize; + } + } + return String.format("%-20s%s[%d];\r\n", typeStr, cName, size); } else { + throw new EntityException("Unknown DATUM_TYPE type in when generating code for VARIABLE_ENABLED PCD entry"); } - return String.format("%s %s", typeStr, token.getPrimaryKeyString()); - } - - private String getVpdEnableTypeDeclaration (Token token) { - return String.format("VPD_HEAD %s", token.getPrimaryKeyString()); - } - - private String getVpdEnableTypeInstantiation (Token token) { - return String.format("{ %s } /* %s */", token.getDefaultSku().vpdOffset, - token.getPrimaryKeyString()); - } - - private String getStringTypeDeclaration (Token token) { - return String.format("UINT16 %s", token.getPrimaryKeyString()); - } - - private String getStringTypeInstantiation (int StringTableIdx, Token token) { - return String.format ("%d /* %s */", StringTableIdx, - token.getPrimaryKeyString()); - } - - - private String getVariableEnableTypeDeclaration (Token token) { - return String.format("VARIABLE_HEAD %s", token.getPrimaryKeyString()); - } - - private String getVariableEnableInstantiation (Token token) - throws EntityException { - // - // Need scott fix - // - return String.format("{ %d, %d, %s } /* %s */", guidTable.add(token.getDefaultSku().variableGuid, token.getPrimaryKeyString()), - stringTable.add(token.getDefaultSku().getStringOfVariableName(), token), - token.getDefaultSku().variableOffset, - token.getPrimaryKeyString()); + return String.format("%-20s%s;\r\n", typeStr, cName); } + + private String getTypeInstantiation (Token t, ArrayList declaList, HashMap instTable, String phase) throws EntityException { + + int i; + + String s; + s = String.format("/* %s */", t.getPrimaryKeyString()) + newLine; + s += tab + "{" + newLine; + + for (i = 0; i < t.skuData.size(); i++) { + if (t.isUnicodeStringType()) { + s += tab + tab + String.format("{ %d }", stringTable.add(t.skuData.get(i).value.value, t)); + } else if (t.isHiiEnable()) { + /* VPD_HEAD definition + typedef struct { + UINT16 GuidTableIndex; // Offset in Guid Table in units of GUID. + UINT16 StringIndex; // Offset in String Table in units of UINT16. + UINT16 Offset; // Offset in Variable + UINT16 DefaultValueOffset; // Offset of the Default Value + } VARIABLE_HEAD ; + */ + String variableDefaultName = String.format("%s_VariableDefault_%d", t.getPrimaryKeyString(), i); + + s += tab + tab + String.format("{ %d, %d, %s, %s }", guidTable.add(t.skuData.get(i).value.variableGuid, t.getPrimaryKeyString()), + stringTable.add(t.skuData.get(i).value.getStringOfVariableName(), t), + t.skuData.get(i).value.variableOffset, + String.format("offsetof(%s_PCD_DATABASE, Init.%s)", phase, variableDefaultName) + ); + // + // We need to support the default value, so we add the declaration and + // the instantiation for the default value. + // + CStructTypeDeclaration decl = new CStructTypeDeclaration (variableDefaultName, + getHiiPtrTypeAlignmentSize(t), + getDataTypeDeclarationForVariableDefault(t, variableDefaultName, i), + true + ); + declaList.add(decl); + instTable.put(variableDefaultName, getDataTypeInstantiationForVariableDefault (t, variableDefaultName, i)); + } else if (t.isVpdEnable()) { + /* typedef struct { + UINT32 Offset; + } VPD_HEAD; + */ + s += tab + tab + String.format("{ %s }", t.skuData.get(i).value.vpdOffset); + } else { + if (t.isByteStreamType()) { + // + // Byte stream type input has their own "{" "}", so we won't help to insert. + // + s += tab + tab + String.format(" %s ", t.skuData.get(i).value.value); + } else { + s += tab + tab + String.format("{ %s }", t.skuData.get(i).value.value); + } + } + + if (i != t.skuData.size() - 1) { + s += commaNewLine; + } else { + s += newLine; + } - public int getTotalTokenNumber () { - return sizeTable.getTableLen(); + } + + s += tab + "}"; + + return s; } - + public static String getPcdDatabaseCommonDefinitions () throws EntityException { @@ -1183,12 +1519,25 @@ class PcdDatabase { } class ModuleInfo { - public ModuleSADocument.ModuleSA module; - public UsageInstance.MODULE_TYPE type; + private String type; + private FpdModuleIdentification moduleId; + private PcdBuildDefinitionDocument.PcdBuildDefinition pcdBuildDef; + + - public ModuleInfo (ModuleSADocument.ModuleSA module, UsageInstance.MODULE_TYPE type) { - this.module = module; + public ModuleInfo (FpdModuleIdentification moduleId, String type, XmlObject pcdDef) { + this.moduleId = moduleId; this.type = type; + this.pcdBuildDef = ((PcdBuildDefinitionDocument)pcdDef).getPcdBuildDefinition(); + } + public String getModuleType (){ + return this.type; + } + public FpdModuleIdentification getModuleId (){ + return this.moduleId; + } + public PcdBuildDefinitionDocument.PcdBuildDefinition getPcdBuildDef(){ + return this.pcdBuildDef; } } @@ -1210,8 +1559,11 @@ public class CollectPCDAction { private int originalMessageLevel; /// Cache the fpd docment instance for private usage. - private FrameworkPlatformDescriptionDocument fpdDocInstance; - + private PlatformSurfaceAreaDocument fpdDocInstance; + + /// xmlObject name + private static String xmlObjectName = "PcdBuildDefinition"; + /** Set WorkspacePath parameter for this action class. @@ -1278,7 +1630,7 @@ public class CollectPCDAction { @throws EntityException Exception indicate failed to execute this action. **/ - private void execute() throws EntityException { + public void execute() throws EntityException { // // Get memoryDatabaseManager instance from GlobalData. // The memoryDatabaseManager should be initialized for whatever build @@ -1320,18 +1672,18 @@ public class CollectPCDAction { dbManager.getTwoPhaseDynamicRecordArray(alPei, alDxe); PcdDatabase pcdPeiDatabase = new PcdDatabase (alPei, "PEI", 0); pcdPeiDatabase.genCode(); - dbManager.PcdPeimHString = PcdCommonHeaderString + pcdPeiDatabase.getHString() + MemoryDatabaseManager.PcdPeimHString = PcdCommonHeaderString + pcdPeiDatabase.getHString() + PcdDatabase.getPcdPeiDatabaseDefinitions(); - dbManager.PcdPeimCString = pcdPeiDatabase.getCString(); + MemoryDatabaseManager.PcdPeimCString = pcdPeiDatabase.getCString(); PcdDatabase pcdDxeDatabase = new PcdDatabase (alDxe, "DXE", alPei.size() ); pcdDxeDatabase.genCode(); - dbManager.PcdDxeHString = dbManager.PcdPeimHString + pcdDxeDatabase.getHString() + MemoryDatabaseManager.PcdDxeHString = MemoryDatabaseManager.PcdPeimHString + pcdDxeDatabase.getHString() + PcdDatabase.getPcdDxeDatabaseDefinitions(); - dbManager.PcdDxeCString = pcdDxeDatabase.getCString(); + MemoryDatabaseManager.PcdDxeCString = pcdDxeDatabase.getCString(); } /** @@ -1344,18 +1696,16 @@ public class CollectPCDAction { */ private List getComponentsFromFPD() throws EntityException { - HashMap map = new HashMap(); List allModules = new ArrayList(); ModuleInfo current = null; int index = 0; - org.tianocore.Components components = null; FrameworkModulesDocument.FrameworkModules fModules = null; - java.util.List modules = null; - + ModuleSADocument.ModuleSA[] modules = null; + HashMap map = new HashMap(); if (fpdDocInstance == null) { try { - fpdDocInstance = (FrameworkPlatformDescriptionDocument)XmlObject.Factory.parse(new File(fpdFilePath)); + 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) { @@ -1364,64 +1714,12 @@ public class CollectPCDAction { } - // - // Check whether FPD contians - // - fModules = fpdDocInstance.getFrameworkPlatformDescription().getFrameworkModules(); - if (fModules == null) { - return null; - } - - // - // BUGBUG: The following is work around code, the final component type should be get from - // GlobalData class. - // - components = fModules.getSEC(); - if (components != null) { - modules = components.getModuleSAList(); - for (index = 0; index < modules.size(); index ++) { - allModules.add(new ModuleInfo(modules.get(index), UsageInstance.MODULE_TYPE.SEC)); - } - } - - components = fModules.getPEICORE(); - if (components != null) { - modules = components.getModuleSAList(); - for (index = 0; index < modules.size(); index ++) { - allModules.add(new ModuleInfo(modules.get(index), UsageInstance.MODULE_TYPE.PEI_CORE)); - } - } - - components = fModules.getPEIM(); - if (components != null) { - modules = components.getModuleSAList(); - for (index = 0; index < modules.size(); index ++) { - allModules.add(new ModuleInfo(modules.get(index), UsageInstance.MODULE_TYPE.PEIM)); - } - } - - components = fModules.getDXECORE(); - if (components != null) { - modules = components.getModuleSAList(); - for (index = 0; index < modules.size(); index ++) { - allModules.add(new ModuleInfo(modules.get(index), UsageInstance.MODULE_TYPE.DXE_CORE)); - } - } - - components = fModules.getDXEDRIVERS(); - if (components != null) { - modules = components.getModuleSAList(); - for (index = 0; index < modules.size(); index ++) { - allModules.add(new ModuleInfo(modules.get(index), UsageInstance.MODULE_TYPE.DXE_DRIVERS)); - } - } - - components = fModules.getOTHERCOMPONENTS(); - if (components != null) { - modules = components.getModuleSAList(); - for (index = 0; index < modules.size(); index ++) { - allModules.add(new ModuleInfo(modules.get(index), UsageInstance.MODULE_TYPE.OTHER_COMPONENTS)); - } + MappcdBuildDef = GlobalData.getFpdModuleSaXmlObject(CollectPCDAction.xmlObjectName); + Set pcdBuildKeySet = pcdBuildDef.keySet(); + Iterator item = pcdBuildKeySet.iterator(); + while (item.hasNext()){ + FpdModuleIdentification id = (FpdModuleIdentification)item.next(); + allModules.add(new ModuleInfo(id, id.getModule().getModuleType(),pcdBuildDef.get(id))); } return allModules; @@ -1445,8 +1743,6 @@ public class CollectPCDAction { List pcdBuildDataArray = new ArrayList(); PcdBuildDefinition.PcdData pcdBuildData = null; Token token = null; - SkuInstance skuInstance = null; - int skuIndex = 0; List modules = null; String primaryKey = null; String exceptionString = null; @@ -1456,10 +1752,11 @@ public class CollectPCDAction { boolean isDuplicate = false; Token.PCD_TYPE pcdType = Token.PCD_TYPE.UNKNOWN; Token.DATUM_TYPE datumType = Token.DATUM_TYPE.UNKNOWN; - int tokenNumber = 0; + long tokenNumber = 0; String moduleName = null; String datum = null; int maxDatumSize = 0; + String[] tokenSpaceStrRet = null; // // ---------------------------------------------- @@ -1469,7 +1766,7 @@ public class CollectPCDAction { modules = getComponentsFromFPD(); if (modules == null) { - throw new EntityException("No modules in FPD file, Please check whether there are elements in in FPD file!"); + throw new EntityException("[FPD file error] No modules in FPD file, Please check whether there are elements in in FPD file!"); } // @@ -1484,17 +1781,17 @@ public class CollectPCDAction { // BUGBUG: For transition schema, we can *not* get module's version from // , It is work around code. // - primaryKey1 = UsageInstance.getPrimaryKey(modules.get(index).module.getModuleName(), - translateSchemaStringToUUID(modules.get(index).module.getModuleGuid()), - modules.get(index).module.getPackageName(), - translateSchemaStringToUUID(modules.get(index).module.getPackageGuid()), - modules.get(index).module.getArch().toString(), + primaryKey1 = UsageInstance.getPrimaryKey(modules.get(index).getModuleId().getModule().getName(), + null, + null, + null, + modules.get(index).getModuleId().getArch(), null); - primaryKey2 = UsageInstance.getPrimaryKey(modules.get(index2).module.getModuleName(), - translateSchemaStringToUUID(modules.get(index2).module.getModuleGuid()), - modules.get(index2).module.getPackageName(), - translateSchemaStringToUUID(modules.get(index2).module.getPackageGuid()), - modules.get(index2).module.getArch().toString(), + primaryKey2 = UsageInstance.getPrimaryKey(modules.get(index2).getModuleId().getModule().getName(), + null, + null, + null, + modules.get(index2).getModuleId().getArch(), null); if (primaryKey1.equalsIgnoreCase(primaryKey2)) { isDuplicate = true; @@ -1509,13 +1806,13 @@ public class CollectPCDAction { // // It is legal for a module does not contains ANY pcd build definitions. // - if (modules.get(index).module.getPcdBuildDefinition() == null) { + if (modules.get(index).getPcdBuildDef() == null) { continue; } - pcdBuildDataArray = modules.get(index).module.getPcdBuildDefinition().getPcdDataList(); + pcdBuildDataArray = modules.get(index).getPcdBuildDef().getPcdDataList(); - moduleName = modules.get(index).module.getModuleName(); + moduleName = modules.get(index).getModuleId().getModule().getName(); // // ---------------------------------------------------------------------- @@ -1524,14 +1821,38 @@ public class CollectPCDAction { // for (pcdIndex = 0; pcdIndex < pcdBuildDataArray.size(); pcdIndex ++) { pcdBuildData = pcdBuildDataArray.get(pcdIndex); + + try { + tokenSpaceStrRet = GlobalData.getGuidInfoFromCname(pcdBuildData.getTokenSpaceGuidCName()); + } catch ( Exception e ) { + throw new EntityException ("Faile get Guid for token " + pcdBuildData.getCName() + ":" + e.getMessage()); + } + + if (tokenSpaceStrRet == null) { + throw new EntityException ("Fail to get Token space guid for token" + pcdBuildData.getCName()); + } + primaryKey = Token.getPrimaryKeyString(pcdBuildData.getCName(), - translateSchemaStringToUUID(pcdBuildData.getTokenSpaceGuid())); + translateSchemaStringToUUID(tokenSpaceStrRet[1])); pcdType = Token.getpcdTypeFromString(pcdBuildData.getItemType().toString()); datumType = Token.getdatumTypeFromString(pcdBuildData.getDatumType().toString()); - tokenNumber = Integer.decode(pcdBuildData.getToken().toString()); - datum = pcdBuildData.getValue(); + tokenNumber = Long.decode(pcdBuildData.getToken().toString()); + if (pcdBuildData.getValue() != null) { + datum = pcdBuildData.getValue().toString(); + } else { + datum = null; + } maxDatumSize = pcdBuildData.getMaxDatumSize(); + if ((pcdType == Token.PCD_TYPE.FEATURE_FLAG) && + (datumType != Token.DATUM_TYPE.BOOLEAN)){ + exceptionString = String.format("[FPD file error] For PCD %s in module %s, the PCD type is FEATRUE_FLAG but "+ + "datum type of this PCD entry is not BOOLEAN!", + pcdBuildData.getCName(), + moduleName); + throw new EntityException(exceptionString); + } + // // ------------------------------------------------------------------------------------------- // 2.1.1), Do some necessary checking work for FixedAtBuild, FeatureFlag and PatchableInModule @@ -1542,7 +1863,7 @@ public class CollectPCDAction { // Value is required. // if (datum == null) { - exceptionString = String.format("There is no value for PCD entry %s in module %s!", + exceptionString = String.format("[FPD file error] There is no value for PCD entry %s in module %s!", pcdBuildData.getCName(), moduleName); throw new EntityException(exceptionString); @@ -1551,10 +1872,11 @@ public class CollectPCDAction { // // Check whether the datum size is matched datum type. // - if ((exceptionString = verifyDatumSize(pcdBuildData.getCName(), - moduleName, - maxDatumSize, - datumType)) != null) { + if ((exceptionString = verifyDatum(pcdBuildData.getCName(), + moduleName, + datum, + datumType, + maxDatumSize)) != null) { throw new EntityException(exceptionString); } } @@ -1576,7 +1898,7 @@ public class CollectPCDAction { // modules. // if (token.datumType != datumType) { - exceptionString = String.format("The datum type of PCD entry %s is %s, which is different with %s defined in before!", + exceptionString = String.format("[FPD file error] The datum type of PCD entry %s is %s, which is different with %s defined in before!", pcdBuildData.getCName(), pcdBuildData.getDatumType().toString(), Token.getStringOfdatumType(token.datumType)); @@ -1587,7 +1909,7 @@ public class CollectPCDAction { // Check token number is valid // if (tokenNumber != token.tokenNumber) { - exceptionString = String.format("The token number of PCD entry %s in module %s is different with same PCD entry in other modules!", + exceptionString = String.format("[FPD file error] The token number of PCD entry %s in module %s is different with same PCD entry in other modules!", pcdBuildData.getCName(), moduleName); throw new EntityException(exceptionString); @@ -1597,7 +1919,7 @@ public class CollectPCDAction { // For same PCD used in different modules, the PCD type should all be dynamic or non-dynamic. // if (token.isDynamicPCD != Token.isDynamic(pcdType)) { - exceptionString = String.format("For PCD entry %s in module %s, you define dynamic or non-dynamic PCD type which"+ + exceptionString = String.format("[FPD file error] For PCD entry %s in module %s, you define dynamic or non-dynamic PCD type which"+ "is different with others module's", token.cName, moduleName); @@ -1611,15 +1933,28 @@ public class CollectPCDAction { // But if you write, the must be same as the value in . // if (!token.isSkuEnable() && - (token.skuData.get(0).value.type == DynamicTokenValue.VALUE_TYPE.DEFAULT_TYPE)) { - if (!datum.equalsIgnoreCase(token.skuData.get(0).value.value)) { - exceptionString = String.format("For dynamic PCD %s in module %s, the datum in is "+ + (token.getDefaultSku().type == DynamicTokenValue.VALUE_TYPE.DEFAULT_TYPE) && + (datum != null)) { + if (!datum.equalsIgnoreCase(token.getDefaultSku().value)) { + exceptionString = String.format("[FPD file error] For dynamic PCD %s in module %s, the datum in is "+ "not equal to the datum in , it is "+ - "illega! You can choose no in !", + "illega! You could no set in for a dynamic PCD!", token.cName, moduleName); + throw new EntityException(exceptionString); } } + + if ((maxDatumSize != 0) && + (maxDatumSize != token.datumSize)){ + exceptionString = String.format("[FPD file error] For dynamic PCD %s in module %s, the max datum size is %d which "+ + "is different with %d defined in !", + token.cName, + moduleName, + maxDatumSize, + token.datumSize); + throw new EntityException(exceptionString); + } } } else { @@ -1627,8 +1962,18 @@ public class CollectPCDAction { // If the token is not in database, create a new token instance and add // a usage instance into this token in database. // + try { + tokenSpaceStrRet = GlobalData.getGuidInfoFromCname(pcdBuildData.getTokenSpaceGuidCName()); + } catch (Exception e) { + throw new EntityException("Fail to get token space guid for token " + token.cName); + } + + if (tokenSpaceStrRet == null) { + throw new EntityException("Fail to get token space guid for token " + token.cName); + } + token = new Token(pcdBuildData.getCName(), - translateSchemaStringToUUID(pcdBuildData.getTokenSpaceGuid())); + translateSchemaStringToUUID(tokenSpaceStrRet[1])); token.datumType = datumType; token.tokenNumber = tokenNumber; @@ -1663,12 +2008,12 @@ public class CollectPCDAction { // usageInstance = new UsageInstance(token, moduleName, - translateSchemaStringToUUID(modules.get(index).module.getModuleGuid()), - modules.get(index).module.getPackageName(), - translateSchemaStringToUUID(modules.get(index).module.getPackageGuid()), - modules.get(index).type, + null, + null, + null, + CommonDefinition.getModuleType(modules.get(index).getModuleType()), pcdType, - modules.get(index).module.getArch().toString(), + modules.get(index).getModuleId().getArch(), null, datum, maxDatumSize); @@ -1677,6 +2022,331 @@ public class CollectPCDAction { } } + /** + 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 "; + } else { + moduleName = "module " + moduleName; + } + + if (maxDatumSize == 0) { + exceptionString = String.format("[FPD file error] You maybe miss 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 : %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 : %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) { + break; + } + 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 : %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; + } + /** Get dynamic information for a dynamic PCD from seciton in FPD file. @@ -1696,23 +2366,24 @@ public class CollectPCDAction { String dynamicPrimaryKey = null; DynamicPcdBuildDefinitions dynamicPcdBuildDefinitions = null; List dynamicPcdBuildDataArray = null; + String[] tokenSpaceStrRet = null; // // If FPD document is not be opened, open and initialize it. // if (fpdDocInstance == null) { try { - fpdDocInstance = (FrameworkPlatformDescriptionDocument)XmlObject.Factory.parse(new File(fpdFilePath)); + 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.getFrameworkPlatformDescription().getDynamicPcdBuildDefinitions(); + + dynamicPcdBuildDefinitions = fpdDocInstance.getPlatformSurfaceArea().getDynamicPcdBuildDefinitions(); if (dynamicPcdBuildDefinitions == null) { - exceptionString = String.format("There are no in FPD file but contains Dynamic type "+ + exceptionString = String.format("[FPD file error] There are no in FPD file but contains Dynamic type "+ "PCD entry %s in module %s!", token.cName, moduleName); @@ -1721,8 +2392,20 @@ public class CollectPCDAction { dynamicPcdBuildDataArray = dynamicPcdBuildDefinitions.getPcdBuildDataList(); for (index = 0; index < dynamicPcdBuildDataArray.size(); index ++) { + //String tokenSpaceGuidString = GlobalData.getGuidInfoFromCname(dynamicPcdBuildDataArray.get(index).getTokenSpaceGuidCName())[1]; + String tokenSpaceGuidString = null; + 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(), - translateSchemaStringToUUID(dynamicPcdBuildDataArray.get(index).getTokenSpaceGuid())); + translateSchemaStringToUUID(tokenSpaceStrRet[1])); if (dynamicPrimaryKey.equalsIgnoreCase(token.getPrimaryKeyString())) { return dynamicPcdBuildDataArray.get(index); } @@ -1731,73 +2414,6 @@ public class CollectPCDAction { return null; } - /** - Verify the maxDatumSize for a PCD data is matched to Datum type. - - @param token The token instance - @param moduleName The module name who use this PCD data. - @param maxDatumSize The value of max datum size in FPD file - @param datumType The datum type - - @return String if is unmatched, set the exception information - as return value, otherwice is null. - **/ - private String verifyDatumSize(String cName, - String moduleName, - int maxDatumSize, - Token.DATUM_TYPE datumType) { - String exceptionString = null; - switch (datumType) { - case UINT8: - if (maxDatumSize != 1) { - exceptionString = String.format("In FPD file, the datum type of PCD data %s in module %s "+ - "is UINT8, but datum size is %d, they are not matched!", - cName, - moduleName, - maxDatumSize); - } - break; - case UINT16: - if (maxDatumSize != 2) { - exceptionString = String.format("In FPD file, the datum type of PCD data %s in module %s "+ - "is UINT16, but datum size is %d, they are not matched!", - cName, - moduleName, - maxDatumSize); - } - break; - case UINT32: - if (maxDatumSize != 4) { - exceptionString = String.format("In FPD file, the datum type of PCD data %s in module %s "+ - "is UINT32, but datum size is %d, they are not matched!", - cName, - moduleName, - maxDatumSize); - } - break; - case UINT64: - if (maxDatumSize != 8) { - exceptionString = String.format("In FPD file, the datum type of PCD data %s in module %s "+ - "is UINT64, but datum size is %d, they are not matched!", - cName, - moduleName, - maxDatumSize); - } - break; - case BOOLEAN: - if (maxDatumSize != 1) { - exceptionString = String.format("In FPD file, the datum type of PCD data %s in module %s "+ - "is BOOLEAN, but datum size is %d, they are not matched!", - cName, - moduleName, - maxDatumSize); - } - break; - } - - return exceptionString; - } - /** Update dynamic information for PCD entry. @@ -1823,13 +2439,17 @@ public class CollectPCDAction { SkuInstance skuInstance = null; String temp; boolean hasSkuId0 = false; + Token.PCD_TYPE pcdType = Token.PCD_TYPE.UNKNOWN; + long tokenNumber = 0; + String hiiDefaultValue = null; + String[] variableGuidString = null; List skuInfoList = null; DynamicPcdBuildDefinitions.PcdBuildData dynamicInfo = null; dynamicInfo = getDynamicInfoFromFPD(token, moduleName); if (dynamicInfo == null) { - exceptionString = String.format("For Dynamic PCD %s used by module %s, "+ + exceptionString = String.format("[FPD file error] For Dynamic PCD %s used by module %s, "+ "there is no dynamic information in "+ "in FPD file, but it is required!", token.cName, @@ -1837,6 +2457,43 @@ public class CollectPCDAction { throw new EntityException(exceptionString); } + token.datumSize = dynamicInfo.getMaxDatumSize(); + + exceptionString = verifyDatum(token.cName, + moduleName, + null, + token.datumType, + token.datumSize); + if (exceptionString != null) { + throw new EntityException(exceptionString); + } + + if ((maxDatumSize != 0) && + (maxDatumSize != token.datumSize)) { + exceptionString = String.format("FPD file error] For dynamic PCD %s, the datum size in module %s is %d, but "+ + "the datum size in is %d, they are not match!", + token.cName, + moduleName, + maxDatumSize, + dynamicInfo.getMaxDatumSize()); + throw new EntityException(exceptionString); + } + tokenNumber = Long.decode(dynamicInfo.getToken().toString()); + if (tokenNumber != token.tokenNumber) { + exceptionString = String.format("[FPD file error] For dynamic PCD %s, the token number in module %s is 0x%x, but"+ + "in , the token number is 0x%x, they are not match!", + token.cName, + moduleName, + token.tokenNumber, + tokenNumber); + throw new EntityException(exceptionString); + } + + pcdType = Token.getpcdTypeFromString(dynamicInfo.getItemType().toString()); + if (pcdType == Token.PCD_TYPE.DYNAMIC_EX) { + token.dynamicExTokenNumber = tokenNumber; + } + skuInfoList = dynamicInfo.getSkuInfoList(); // @@ -1849,7 +2506,6 @@ public class CollectPCDAction { // temp = skuInfoList.get(index).getSkuId().toString(); skuInstance.id = Integer.decode(temp); - if (skuInstance.id == 0) { hasSkuId0 = true; } @@ -1857,7 +2513,15 @@ public class CollectPCDAction { // Judge whether is DefaultGroup at first, because most case is DefautlGroup. // if (skuInfoList.get(index).getValue() != null) { - skuInstance.value.setValue(skuInfoList.get(index).getValue()); + skuInstance.value.setValue(skuInfoList.get(index).getValue().toString()); + if ((exceptionString = verifyDatum(token.cName, + null, + skuInfoList.get(index).getValue().toString(), + token.datumType, + token.datumSize)) != null) { + throw new EntityException(exceptionString); + } + token.skuData.add(skuInstance); // @@ -1866,12 +2530,10 @@ public class CollectPCDAction { // if (datum != null) { if ((skuInstance.id == 0) && - !datum.equalsIgnoreCase(skuInfoList.get(index).getValue())) { - exceptionString = String.format("For dynamic PCD %s, module %s give as %s which is different with "+ - "Sku 0's %s defined in ! Please sync them at first!", - token.cName, - datum, - skuInfoList.get(index).getValue()); + !datum.toString().equalsIgnoreCase(skuInfoList.get(index).getValue().toString())) { + exceptionString = "[FPD file error] For dynamic PCD " + token.cName + ", the value in module " + moduleName + " is " + datum.toString() + " but the "+ + "value of sku 0 data in is " + skuInstance.value.value + ". They are must be same!"+ + " or you could not define value for a dynamic PCD in every !"; throw new EntityException(exceptionString); } } @@ -1884,42 +2546,79 @@ public class CollectPCDAction { if (skuInfoList.get(index).getVariableName() != null) { exceptionString = null; if (skuInfoList.get(index).getVariableGuid() == null) { - exceptionString = String.format("For dynamic PCD %s in section in FPD "+ + exceptionString = String.format("[FPD file error] For dynamic PCD %s in section in FPD "+ "file, who use HII, but there is no defined for Sku %d data!", token.cName, index); - + if (exceptionString != null) { + throw new EntityException(exceptionString); + } } if (skuInfoList.get(index).getVariableOffset() == null) { - exceptionString = String.format("For dynamic PCD %s in section in FPD "+ + exceptionString = String.format("[FPD file error] For dynamic PCD %s in section in FPD "+ "file, who use HII, but there is no defined for Sku %d data!", token.cName, index); + if (exceptionString != null) { + throw new EntityException(exceptionString); + } } if (skuInfoList.get(index).getHiiDefaultValue() == null) { - exceptionString = String.format("For dynamic PCD %s in section in FPD "+ + exceptionString = String.format("[FPD file error] For dynamic PCD %s in section in FPD "+ "file, who use HII, but there is no defined for Sku %d data!", token.cName, index); + if (exceptionString != null) { + throw new EntityException(exceptionString); + } + } + + if (skuInfoList.get(index).getHiiDefaultValue() != null) { + hiiDefaultValue = skuInfoList.get(index).getHiiDefaultValue().toString(); + } else { + hiiDefaultValue = null; } - if (exceptionString != null) { + if ((exceptionString = verifyDatum(token.cName, + null, + hiiDefaultValue, + token.datumType, + token.datumSize)) != null) { throw new EntityException(exceptionString); } + offset = Integer.decode(skuInfoList.get(index).getVariableOffset()); if (offset > 0xFFFF) { - throw new EntityException(String.format("For dynamic PCD %s , the variable offset defined in sku %d data "+ + throw new EntityException(String.format("[FPD file error] For dynamic PCD %s , the variable offset defined in sku %d data "+ "exceed 64K, it is not allowed!", token.cName, index)); } - skuInstance.value.setHiiData(skuInfoList.get(index).getVariableName(), - translateSchemaStringToUUID(skuInfoList.get(index).getVariableGuid().toString()), + // + // Get variable guid string according to the name of guid which will be mapped into a GUID in SPD file. + // + variableGuidString = GlobalData.getGuidInfoFromCname(skuInfoList.get(index).getVariableGuid().toString()); + if (variableGuidString == null) { + throw new EntityException(String.format("[GUID Error] For dynamic PCD %s, the variable guid %s can be found in all SPD file!", + token.cName, + skuInfoList.get(index).getVariableGuid().toString())); + } + String variableStr = skuInfoList.get(index).getVariableName(); + Pattern pattern = Pattern.compile("0x([a-fA-F0-9]){4}"); + Matcher matcher = pattern.matcher(variableStr); + List varNameList = new ArrayList(); + while (matcher.find()){ + String str = variableStr.substring(matcher.start(),matcher.end()); + varNameList.add(str); + } + + skuInstance.value.setHiiData(varNameList, + translateSchemaStringToUUID(variableGuidString[1]), skuInfoList.get(index).getVariableOffset(), - skuInfoList.get(index).getHiiDefaultValue()); + skuInfoList.get(index).getHiiDefaultValue().toString()); token.skuData.add(skuInstance); continue; } @@ -1930,16 +2629,17 @@ public class CollectPCDAction { continue; } - exceptionString = String.format("For dynamic PCD %s, the dynamic info must "+ + exceptionString = String.format("[FPD file error] For dynamic PCD %s, the dynamic info must "+ "be one of 'DefaultGroup', 'HIIGroup', 'VpdGroup'.", token.cName); throw new EntityException(exceptionString); } if (!hasSkuId0) { - exceptionString = String.format("For dynamic PCD %s in , there are "+ + exceptionString = String.format("[FPD file error] For dynamic PCD %s in , there are "+ "no sku id = 0 data, which is required for every dynamic PCD", token.cName); + throw new EntityException(exceptionString); } return token; @@ -1982,6 +2682,9 @@ public class CollectPCDAction { return new UUID(0, 0); } + uuidString = uuidString.replaceAll("\\{", ""); + uuidString = uuidString.replaceAll("\\}", ""); + // // If the UUID schema string is GuidArrayType type then need translate // to GuidNamingConvention type at first. @@ -1989,7 +2692,7 @@ public class CollectPCDAction { if ((uuidString.charAt(0) == '0') && ((uuidString.charAt(1) == 'x') || (uuidString.charAt(1) == 'X'))) { splitStringArray = uuidString.split("," ); if (splitStringArray.length != 11) { - throw new EntityException ("Wrong format for UUID string: " + uuidString); + throw new EntityException ("[FPD file error] Wrong format for UUID string: " + uuidString); } // @@ -2066,11 +2769,14 @@ public class CollectPCDAction { **/ public static void main(String argv[]) throws EntityException { CollectPCDAction ca = new CollectPCDAction(); - ca.setWorkspacePath("m:/tianocore/edk2"); - ca.setFPDFilePath("m:/tianocore/edk2/EdkNt32Pkg/Nt32.fpd"); + ca.setWorkspacePath("f:/tianocore/edk2"); + ca.setFPDFilePath("f:/tianocore/edk2/EdkNt32Pkg/Nt32.fpd"); ca.setActionMessageLevel(ActionMessage.MAX_MESSAGE_LEVEL); GlobalData.initInfo("Tools" + File.separator + "Conf" + File.separator + "FrameworkDatabase.db", - "m:/tianocore/edk2"); + "f:/tianocore/edk2", + "tools_def.txt"); + FpdParserTask fpt = new FpdParserTask(); + fpt.parseFpdFile(new File("f:/tianocore/edk2/EdkNt32Pkg/Nt32.fpd")); ca.execute(); } }