diff --git a/EdkModulePkg/Universal/PCD/Dxe/Service.c b/EdkModulePkg/Universal/PCD/Dxe/Service.c index 717a4345ea..771c4db54d 100644 --- a/EdkModulePkg/Universal/PCD/Dxe/Service.c +++ b/EdkModulePkg/Universal/PCD/Dxe/Service.c @@ -102,7 +102,6 @@ GetWorker ( Status = GetHiiVariable (Guid, Name, &Data, &DataSize); if (Status == EFI_SUCCESS) { - ASSERT (DataSize >= (UINTN) (VariableHead->Offset + Size)); return (UINT8 *) Data + VariableHead->Offset; } else { // diff --git a/EdkModulePkg/Universal/PCD/Pei/Service.c b/EdkModulePkg/Universal/PCD/Pei/Service.c index 011e3aa36e..a85d1d1786 100644 --- a/EdkModulePkg/Universal/PCD/Pei/Service.c +++ b/EdkModulePkg/Universal/PCD/Pei/Service.c @@ -16,7 +16,6 @@ Module Name: Service.c **/ #include "Service.h" - /** The function registers the CallBackOnSet fucntion according to TokenNumber and EFI_GUID space. @@ -496,7 +495,6 @@ GetWorker ( Status = GetHiiVariable (Guid, Name, &Data, &DataSize); if (Status == EFI_SUCCESS) { - ASSERT (DataSize >= (UINTN) (VariableHead->Offset + Size)); return (VOID *) ((UINT8 *) Data + VariableHead->Offset); } else { // diff --git a/MdePkg/Include/Library/PcdLib.h b/MdePkg/Include/Library/PcdLib.h index fe8a1e6939..37d435596e 100644 --- a/MdePkg/Include/Library/PcdLib.h +++ b/MdePkg/Include/Library/PcdLib.h @@ -725,17 +725,45 @@ LibPcdGetNextToken ( - @param[in] Pointer to a 128-bit unique value that designates from which namespace + @param[in] Guid Pointer to a 128-bit unique value that designates from which namespace to start the search. @retval CONST GUID * The next valid token namespace. **/ - GUID * EFIAPI LibPcdGetNextTokenSpace ( IN CONST GUID *Guid ); + +/** + Sets the PCD entry specified by PatchVariable to the value specified by Buffer + and SizeOfValue. Buffer is returned. If SizeOfValue is greater than + MaximumDatumSize, then set SizeOfValue to MaximumDatumSize and return + NULL to indicate that the set operation was not actually performed. + If SizeOfValue is set to MAX_ADDRESS, then SizeOfValue must be set to + MaximumDatumSize and NULL must be returned. + + If PatchVariable is NULL, then ASSERT(). + If SizeOfValue is NULL, then ASSERT(). + If SizeOfValue > 0 and Buffer is NULL, then ASSERT(). + + @param[in] PatchVariable A pointer to the global variable in a module that is + the target of the set operation. + @param[in] MaximumDatumSize The maximum size allowed for the PCD entry specified by PatchVariable. + @param[in, out] SizeOfBuffer A pointer to the size, in bytes, of Buffer. + @param[in] Buffer A pointer to the buffer to used to set the target variable. + +**/ +VOID * +EFIAPI +LibPatchPcdSetPtr ( + IN VOID *PatchVariable, + IN UINTN MaximumDatumSize, + IN OUT UINTN *SizeOfBuffer, + IN CONST VOID *Buffer + ); + #endif diff --git a/MdePkg/Library/BasePcdLibNull/BasePcdLibNull.msa b/MdePkg/Library/BasePcdLibNull/BasePcdLibNull.msa index 26d6609b51..564ccc1e28 100644 --- a/MdePkg/Library/BasePcdLibNull/BasePcdLibNull.msa +++ b/MdePkg/Library/BasePcdLibNull/BasePcdLibNull.msa @@ -8,11 +8,11 @@ NULL PCD Library FIX ME! 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, + 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. FRAMEWORK_BUILD_PACKAGING_SPECIFICATION 0x00000052 @@ -28,6 +28,9 @@ DebugLib + + BaseMemoryLib + PcdLib.c @@ -39,4 +42,4 @@ EFI_SPECIFICATION_VERSION 0x00020000 EDK_RELEASE_VERSION 0x00090000 - \ No newline at end of file + diff --git a/MdePkg/Library/BasePcdLibNull/PcdLib.c b/MdePkg/Library/BasePcdLibNull/PcdLib.c index a2e46b05b2..e58965cc68 100644 --- a/MdePkg/Library/BasePcdLibNull/PcdLib.c +++ b/MdePkg/Library/BasePcdLibNull/PcdLib.c @@ -780,3 +780,52 @@ LibPcdGetNextTokenSpace ( { return NULL; } + + + +/** + Sets the PCD entry specified by PatchVariable to the value specified by Buffer + and SizeOfValue. Buffer is returned. If SizeOfValue is greater than + MaximumDatumSize, then set SizeOfValue to MaximumDatumSize and return + NULL to indicate that the set operation was not actually performed. + If SizeOfValue is set to MAX_ADDRESS, then SizeOfValue must be set to + MaximumDatumSize and NULL must be returned. + + If PatchVariable is NULL, then ASSERT(). + If SizeOfValue is NULL, then ASSERT(). + If SizeOfValue > 0 and Buffer is NULL, then ASSERT(). + + @param[in] PatchVariable A pointer to the global variable in a module that is + the target of the set operation. + @param[in] MaximumDatumSize The maximum size allowed for the PCD entry specified by PatchVariable. + @param[in, out] SizeOfBuffer A pointer to the size, in bytes, of Buffer. + @param[in] Buffer A pointer to the buffer to used to set the target variable. + +**/ +VOID * +EFIAPI +LibPatchPcdSetPtr ( + IN VOID *PatchVariable, + IN UINTN MaximumDatumSize, + IN OUT UINTN *SizeOfBuffer, + IN CONST VOID *Buffer + ) +{ + ASSERT (PatchVariable != NULL); + ASSERT (SizeOfBuffer != NULL); + + if (*SizeOfBuffer > 0) { + ASSERT (Buffer != NULL); + } + + if ((*SizeOfBuffer > MaximumDatumSize) || + (*SizeOfBuffer == MAX_ADDRESS)) { + *SizeOfBuffer = MaximumDatumSize; + return NULL; + } + + CopyMem (PatchVariable, Buffer, *SizeOfBuffer); + + return (VOID *) Buffer; +} + diff --git a/MdePkg/Library/DxePcdLib/DxePcdLib.c b/MdePkg/Library/DxePcdLib/DxePcdLib.c index b746614d5b..f0b0cbd8f6 100644 --- a/MdePkg/Library/DxePcdLib/DxePcdLib.c +++ b/MdePkg/Library/DxePcdLib/DxePcdLib.c @@ -923,3 +923,52 @@ LibPcdGetNextTokenSpace ( return (GUID *) Guid; } + +/** + Sets the PCD entry specified by PatchVariable to the value specified by Buffer + and SizeOfValue. Buffer is returned. If SizeOfValue is greater than + MaximumDatumSize, then set SizeOfValue to MaximumDatumSize and return + NULL to indicate that the set operation was not actually performed. + If SizeOfValue is set to MAX_ADDRESS, then SizeOfValue must be set to + MaximumDatumSize and NULL must be returned. + + If PatchVariable is NULL, then ASSERT(). + If SizeOfValue is NULL, then ASSERT(). + If SizeOfValue > 0 and Buffer is NULL, then ASSERT(). + + @param[in] PatchVariable A pointer to the global variable in a module that is + the target of the set operation. + @param[in] MaximumDatumSize The maximum size allowed for the PCD entry specified by PatchVariable. + @param[in, out] SizeOfBuffer A pointer to the size, in bytes, of Buffer. + @param[in] Buffer A pointer to the buffer to used to set the target variable. + +**/ +VOID * +EFIAPI +LibPatchPcdSetPtr ( + IN VOID *PatchVariable, + IN UINTN MaximumDatumSize, + IN OUT UINTN *SizeOfBuffer, + IN CONST VOID *Buffer + ) +{ + ASSERT (PatchVariable != NULL); + ASSERT (SizeOfBuffer != NULL); + + if (*SizeOfBuffer > 0) { + ASSERT (Buffer != NULL); + } + + if ((*SizeOfBuffer > MaximumDatumSize) || + (*SizeOfBuffer == MAX_ADDRESS)) { + *SizeOfBuffer = MaximumDatumSize; + return NULL; + } + + CopyMem (PatchVariable, Buffer, *SizeOfBuffer); + + return (VOID *) Buffer; +} + + + diff --git a/MdePkg/Library/DxePcdLib/DxePcdLib.msa b/MdePkg/Library/DxePcdLib/DxePcdLib.msa index c250fbeb3a..c50ac45220 100644 --- a/MdePkg/Library/DxePcdLib/DxePcdLib.msa +++ b/MdePkg/Library/DxePcdLib/DxePcdLib.msa @@ -8,11 +8,11 @@ IO Library implemented with Framework CPU IO Protocol FIX ME! Copyright (c) 2004-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, + 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. FRAMEWORK_BUILD_PACKAGING_SPECIFICATION 0x00000052 @@ -31,6 +31,9 @@ UefiBootServicesTableLib + + BaseMemoryLib + DxePcdLib.c @@ -50,4 +53,4 @@ PcdLibConstructor - \ No newline at end of file + diff --git a/MdePkg/Library/PeiPcdLib/PeiPcdLib.c b/MdePkg/Library/PeiPcdLib/PeiPcdLib.c index 57fa821156..bee5386097 100644 --- a/MdePkg/Library/PeiPcdLib/PeiPcdLib.c +++ b/MdePkg/Library/PeiPcdLib/PeiPcdLib.c @@ -1022,3 +1022,52 @@ LibPcdGetNextTokenSpace ( return (GUID *)Guid; } + + +/** + Sets the PCD entry specified by PatchVariable to the value specified by Buffer + and SizeOfValue. Buffer is returned. If SizeOfValue is greater than + MaximumDatumSize, then set SizeOfValue to MaximumDatumSize and return + NULL to indicate that the set operation was not actually performed. + If SizeOfValue is set to MAX_ADDRESS, then SizeOfValue must be set to + MaximumDatumSize and NULL must be returned. + + If PatchVariable is NULL, then ASSERT(). + If SizeOfValue is NULL, then ASSERT(). + If SizeOfValue > 0 and Buffer is NULL, then ASSERT(). + + @param[in] PatchVariable A pointer to the global variable in a module that is + the target of the set operation. + @param[in] MaximumDatumSize The maximum size allowed for the PCD entry specified by PatchVariable. + @param[in, out] SizeOfBuffer A pointer to the size, in bytes, of Buffer. + @param[in] Buffer A pointer to the buffer to used to set the target variable. + +**/ +VOID * +EFIAPI +LibPatchPcdSetPtr ( + IN VOID *PatchVariable, + IN UINTN MaximumDatumSize, + IN OUT UINTN *SizeOfBuffer, + IN CONST VOID *Buffer + ) +{ + ASSERT (PatchVariable != NULL); + ASSERT (SizeOfBuffer != NULL); + + if (*SizeOfBuffer > 0) { + ASSERT (Buffer != NULL); + } + + if ((*SizeOfBuffer > MaximumDatumSize) || + (*SizeOfBuffer == MAX_ADDRESS)) { + *SizeOfBuffer = MaximumDatumSize; + return NULL; + } + + CopyMem (PatchVariable, Buffer, *SizeOfBuffer); + + return (VOID *) Buffer; +} + + diff --git a/MdePkg/Library/PeiPcdLib/PeiPcdLib.msa b/MdePkg/Library/PeiPcdLib/PeiPcdLib.msa index 8c3c1e73f8..e4923679c8 100644 --- a/MdePkg/Library/PeiPcdLib/PeiPcdLib.msa +++ b/MdePkg/Library/PeiPcdLib/PeiPcdLib.msa @@ -1,4 +1,4 @@ - + PeiPcdLib @@ -8,11 +8,11 @@ PCD Library Instance implemented with PCD PPI. FIX ME! 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, + 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. FRAMEWORK_BUILD_PACKAGING_SPECIFICATION 0x00000052 @@ -34,6 +34,9 @@ PeiServicesTablePointerLib + + BaseMemoryLib + PeiPcdLib.c @@ -41,8 +44,13 @@ + + + PcdPpi + + EFI_SPECIFICATION_VERSION 0x00020000 EDK_RELEASE_VERSION 0x00090000 - \ No newline at end of file + 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 6686de9f1d..c576363074 100644 --- a/Tools/Source/GenBuild/org/tianocore/build/pcd/action/CollectPCDAction.java +++ b/Tools/Source/GenBuild/org/tianocore/build/pcd/action/CollectPCDAction.java @@ -23,7 +23,6 @@ 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; @@ -36,22 +35,14 @@ 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; -import org.tianocore.DynamicPcdBuildDefinitionsDocument.DynamicPcdBuildDefinitions.PcdBuildData.SkuInfo; import org.tianocore.FrameworkModulesDocument; -import org.tianocore.PcdDeclarationsDocument; import org.tianocore.PlatformSurfaceAreaDocument; import org.tianocore.PcdBuildDefinitionDocument; -import org.tianocore.PlatformSurfaceAreaDocument.PlatformSurfaceArea; 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.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; @@ -60,8 +51,16 @@ import org.tianocore.build.pcd.entity.SkuInstance; import org.tianocore.build.pcd.entity.Token; import org.tianocore.build.pcd.entity.UsageInstance; import org.tianocore.build.pcd.exception.EntityException; -import org.tianocore.logger.EdkLog; -import org.tianocore.ModuleTypeDef; + +/** + 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; @@ -77,6 +76,12 @@ class CStructTypeDeclaration { } } +/** + StringTable + + This class is used to store the String in a PCD database. + +**/ class StringTable { private ArrayList al; private ArrayList alComments; @@ -101,15 +106,11 @@ 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 void genCodeNew (ArrayList declaList, HashMap instTable) { + public void genCode (ArrayList declaList, HashMap instTable) { final String stringTable = "StringTable"; final String tab = "\t"; final String newLine = "\r\n"; @@ -154,11 +155,15 @@ class StringTable { 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; + 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) { cInstCode += commaNewLine; @@ -177,59 +182,6 @@ class StringTable { } } - public String getTypeDeclaration () { - - String output; - - 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(); - - output.add("/* StringTable */"); - - if (al.size() == 0) { - output.add("{ 0 }"); - } else { - String str; - - for (int i = 0; i < al.size(); i++) { - str = String.format("L\"%s\" /* %s */", al.get(i), alComments.get(i)); - if (i != al.size() - 1) { - str += ","; - } - output.add(str); - } - } - - return output; - } - public int add (String inputStr, Token token) { int i; int pos; @@ -254,7 +206,6 @@ class StringTable { return pos; } pos = s.length() + 1; - } i = len; @@ -269,6 +220,13 @@ 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; @@ -282,7 +240,7 @@ class SizeTable { len = 0; } - public void genCodeNew (ArrayList declaList, HashMap instTable, String phase) { + public void genCode (ArrayList declaList, HashMap instTable, String phase) { final String name = "SizeTable"; CStructTypeDeclaration decl; @@ -302,11 +260,7 @@ class SizeTable { instTable.put(name, cCode); } - public String getTypeDeclaration () { - return String.format(PcdDatabase.SizeTableDeclaration, phase); - } - - public ArrayList getInstantiation () { + private ArrayList getInstantiation () { ArrayList Output = new ArrayList(); Output.add("/* SizeTable */"); @@ -348,6 +302,11 @@ class SizeTable { } +/** + GuidTable + + This class is used to store the GUIDs in a PCD database. +**/ class GuidTable { private ArrayList al; private ArrayList alComments; @@ -375,7 +334,7 @@ class GuidTable { return String.format(PcdDatabase.GuidTableExistenceMacro, phase, (al.size() == 0)? "TRUE":"FALSE"); } - public void genCodeNew (ArrayList declaList, HashMap instTable, String phase) { + public void genCode (ArrayList declaList, HashMap instTable, String phase) { final String name = "GuidTable"; CStructTypeDeclaration decl; @@ -395,10 +354,6 @@ class GuidTable { instTable.put(name, cCode); } - public String getTypeDeclaration () { - return String.format(PcdDatabase.GuidTableDeclaration, phase); - } - private String getUuidCString (UUID uuid) { String[] guidStrArray; @@ -419,7 +374,7 @@ class GuidTable { ); } - public ArrayList getInstantiation () { + private ArrayList getInstantiation () { ArrayList Output = new ArrayList(); Output.add("/* GuidTable */"); @@ -466,12 +421,14 @@ class GuidTable { return len - 1; } - public int getTableLen () { - return al.size() == 0 ? 0 : al.size(); - } - } +/** + SkuIdTable + + This class is used to store the SKU IDs in a PCD database. + +**/ class SkuIdTable { private ArrayList al; private ArrayList alComment; @@ -497,7 +454,7 @@ class SkuIdTable { return String.format(PcdDatabase.SkuTableExistenceMacro, phase, (al.size() == 0)? "TRUE":"FALSE"); } - public void genCodeNew (ArrayList declaList, HashMap instTable, String phase) { + public void genCode (ArrayList declaList, HashMap instTable, String phase) { final String name = "SkuIdTable"; CStructTypeDeclaration decl; @@ -533,11 +490,7 @@ class SkuIdTable { } - public String getTypeDeclaration () { - return String.format(PcdDatabase.SkuIdTableDeclaration, phase); - } - - public ArrayList getInstantiation () { + private ArrayList getInstantiation () { ArrayList Output = new ArrayList (); Output.add("/* SkuIdTable */"); @@ -617,10 +570,6 @@ class SkuIdTable { return index; } - public int getTableLen () { - return al.size() == 0 ? 1 : al.size(); - } - } class LocalTokenNumberTable { @@ -650,7 +599,7 @@ class LocalTokenNumberTable { return String.format(PcdDatabase.DatabaseExistenceMacro, phase, (al.size() == 0)? "TRUE":"FALSE"); } - public void genCodeNew (ArrayList declaList, HashMap instTable, String phase) { + public void genCode (ArrayList declaList, HashMap instTable, String phase) { final String name = "LocalTokenNumberTable"; CStructTypeDeclaration decl; @@ -669,11 +618,7 @@ class LocalTokenNumberTable { instTable.put(name, cCode); } - public String getTypeDeclaration () { - return String.format(PcdDatabase.LocalTokenNumberTableDeclaration, phase); - } - - public ArrayList getInstantiation () { + private ArrayList getInstantiation () { ArrayList output = new ArrayList(); output.add("/* LocalTokenNumberTable */"); @@ -735,8 +680,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; @@ -772,7 +731,7 @@ class ExMapTable { return String.format(PcdDatabase.ExMapTableExistenceMacro, phase, (al.size() == 0)? "TRUE":"FALSE"); } - public void genCodeNew (ArrayList declaList, HashMap instTable, String phase) { + public void genCode (ArrayList declaList, HashMap instTable, String phase) { final String exMapTableName = "ExMapTable"; sortTable(); @@ -794,11 +753,7 @@ class ExMapTable { instTable.put(exMapTableName, cCode); } - public String getTypeDeclaration () { - return String.format(PcdDatabase.ExMapTableDeclaration, phase); - } - - public ArrayList getInstantiation () { + private ArrayList getInstantiation () { ArrayList Output = new ArrayList(); Output.add("/* ExMapTable */"); @@ -843,7 +798,7 @@ class ExMapTable { return index; } - public int getTableLen () { + private int getTableLen () { return al.size() == 0 ? 1 : al.size(); } @@ -857,12 +812,15 @@ class ExMapTable { 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 1; - } else { + } else if (a.exTokenNumber == b.exTokenNumber) { return 0; + } else { + return -1; } } @@ -876,6 +834,12 @@ class ExMapTable { } } +/** + 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 { private final static int SkuHeadAlignmentSize = 4; @@ -941,14 +905,21 @@ class PcdDatabase { 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; @@ -959,6 +930,11 @@ class PcdDatabase { sizeTable = new SizeTable(phase); exMapTable = new ExMapTable(phase); + // + // 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; } @@ -976,19 +952,6 @@ class PcdDatabase { return; } - private void getTwoGroupsOfTokens (ArrayList alTokens, List initTokens, List uninitTokens) { - for (int i = 0; i < alTokens.size(); i++) { - Token t = (Token)alTokens.get(i); - if (t.hasDefaultValue()) { - initTokens.add(t); - } else { - uninitTokens.add(t); - } - } - - return; - } - private int getDataTypeAlignmentSize (Token token) { switch (token.datumType) { case UINT8: @@ -1093,7 +1056,7 @@ class PcdDatabase { } - private void ProcessTokensNew (List tokens, + private void ProcessTokens (List tokens, ArrayList cStructDeclList, HashMap cStructInstTable, String phase @@ -1123,7 +1086,7 @@ class PcdDatabase { } - public void genCodeNew () throws EntityException { + public void genCode () throws EntityException { ArrayList cStructDeclList = new ArrayList(); HashMap cStructInstTable = new HashMap(); @@ -1141,15 +1104,15 @@ class PcdDatabase { // EX type token number starts from the last Non-EX PCD entry and // grows continously upwards. // - ProcessTokensNew (nexTokens, cStructDeclList, cStructInstTable, phase); - ProcessTokensNew (exTokens, cStructDeclList, cStructInstTable, phase); + ProcessTokens (nexTokens, cStructDeclList, cStructInstTable, phase); + ProcessTokens (exTokens, cStructDeclList, cStructInstTable, phase); - stringTable.genCodeNew(cStructDeclList, cStructInstTable); - skuIdTable.genCodeNew(cStructDeclList, cStructInstTable, phase); - exMapTable.genCodeNew(cStructDeclList, cStructInstTable, phase); - localTokenNumberTable.genCodeNew(cStructDeclList, cStructInstTable, phase); - sizeTable.genCodeNew(cStructDeclList, cStructInstTable, phase); - guidTable.genCodeNew(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 (); @@ -1285,159 +1248,6 @@ class PcdDatabase { return result; } - public void genCode () - throws EntityException { - - final String newLine = "\r\n"; - final String declNewLine = ";\r\n"; - final String tab = "\t"; - final String commaNewLine = ", \r\n"; - - int i; - ArrayList decla; - ArrayList inst; - - String macroStr = ""; - String initDeclStr = ""; - String initInstStr = ""; - String uninitDeclStr = ""; - - List initTokens = new ArrayList (); - List uninitTokens = new ArrayList (); - - HashMap > initCode = new HashMap> (); - HashMap > uninitCode = new HashMap> (); - - getTwoGroupsOfTokens (alTokens, initTokens, uninitTokens); - - // - // 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); - - // - // Generate Structure Declaration for PcdTokens without Default Value - // PEI_PCD_DATABASE_UNINIT - // - java.util.Collections.sort(uninitTokens, comparator); - uninitCode = processTokens(uninitTokens); - - // - // Generate size info Macro for all Tables - // - macroStr += guidTable.getSizeMacro(); - macroStr += stringTable.getSizeMacro(); - macroStr += skuIdTable.getSizeMacro(); - macroStr += localTokenNumberTable.getSizeMacro(); - macroStr += exMapTable.getSizeMacro(); - - // - // Generate existance info Macro for all Tables - // - macroStr += guidTable.getExistanceMacro(); - macroStr += stringTable.getExistanceMacro(); - macroStr += skuIdTable.getExistanceMacro(); - macroStr += localTokenNumberTable.getExistanceMacro(); - macroStr += exMapTable.getExistanceMacro(); - - // - // Generate Structure Declaration for PcdTokens with Default Value - // for example PEI_PCD_DATABASE_INIT - // - 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); - - // - // 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 - // - 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; - } - } - - initInstStr += "};"; - - uninitDeclStr += "typedef struct {" + newLine; - { - decla = uninitCode.get("Declaration"); - if (decla.size() == 0) { - uninitDeclStr += "UINT8 dummy /* The UINT struct is empty */" + declNewLine; - } 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; - } - } - } - uninitDeclStr += String.format("} %s_PCD_DATABASE_UNINIT;\r\n\r\n", phase); - - cString = initInstStr + newLine; - hString = macroStr + newLine - + initDeclStr + newLine - + uninitDeclStr + newLine - + newLine; - - hString += String.format("#define PCD_%s_SERVICE_DRIVER_VERSION %d", phase, version); - - } - public static String genInstantiationStr (ArrayList alStr) { String str = ""; for (int i = 0; i< alStr.size(); i++) { @@ -1453,70 +1263,6 @@ 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.isUnicodeStringType()) { - 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("%-20s%s;\r\n", "SKU_HEAD", token.getPrimaryKeyString()); } @@ -1527,60 +1273,10 @@ class PcdDatabase { 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 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 getDataTypeInstantiationForVariableDefault_new (Token token, String cName, int skuId) { + private String getDataTypeInstantiationForVariableDefault (Token token, String cName, int skuId) { return String.format("%s /* %s */", token.skuData.get(skuId).value.hiiDefaultValue, cName); } - private String getDataTypeInstantiation (Token token) { - - if (token.datumType == Token.DATUM_TYPE.POINTER) { - return String.format("%s /* %s */", token.getDefaultSku().value, token.getPrimaryKeyString()); - } else { - return String.format("%s /* %s */", token.getDefaultSku().value, token.getPrimaryKeyString()); - } - } - private String getCType (Token t) throws EntityException { @@ -1640,7 +1336,7 @@ class PcdDatabase { } } - private String getDataTypeDeclarationForVariableDefault_new (Token token, String cName, int skuId) + private String getDataTypeDeclarationForVariableDefault (Token token, String cName, int skuId) throws EntityException { String typeStr; @@ -1682,32 +1378,6 @@ class PcdDatabase { return String.format("%-20s%s;\r\n", typeStr, cName); } - private String getDataTypeDeclaration (Token token) { - - String typeStr = ""; - - if (token.datumType == Token.DATUM_TYPE.UINT8) { - typeStr = "UINT8"; - } else if (token.datumType == Token.DATUM_TYPE.UINT16) { - typeStr = "UINT16"; - } else if (token.datumType == Token.DATUM_TYPE.UINT32) { - typeStr = "UINT32"; - } else if (token.datumType == Token.DATUM_TYPE.UINT64) { - typeStr = "UINT64"; - } 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); - } else { - } - - return String.format("%s %s", typeStr, token.getPrimaryKeyString()); - } - - private String getVpdEnableTypeDeclaration (Token token) { - return String.format("VPD_HEAD %s", token.getPrimaryKeyString()); - } - private String getTypeInstantiation (Token t, ArrayList declaList, HashMap instTable, String phase) throws EntityException { int i; @@ -1741,11 +1411,11 @@ class PcdDatabase { // CStructTypeDeclaration decl = new CStructTypeDeclaration (variableDefaultName, getHiiPtrTypeAlignmentSize(t), - getDataTypeDeclarationForVariableDefault_new(t, variableDefaultName, i), + getDataTypeDeclarationForVariableDefault(t, variableDefaultName, i), true ); declaList.add(decl); - instTable.put(variableDefaultName, getDataTypeInstantiationForVariableDefault_new (t, variableDefaultName, i)); + instTable.put(variableDefaultName, getDataTypeInstantiationForVariableDefault (t, variableDefaultName, i)); } else if (t.isVpdEnable()) { /* typedef struct { UINT32 Offset; @@ -1776,40 +1446,6 @@ class PcdDatabase { return s; } - 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()); - } - - public int getTotalTokenNumber () { - return sizeTable.getTableLen(); - } - public static String getPcdDatabaseCommonDefinitions () throws EntityException { @@ -2034,7 +1670,7 @@ public class CollectPCDAction { dbManager.getTwoPhaseDynamicRecordArray(alPei, alDxe); PcdDatabase pcdPeiDatabase = new PcdDatabase (alPei, "PEI", 0); - pcdPeiDatabase.genCodeNew(); + pcdPeiDatabase.genCode(); MemoryDatabaseManager.PcdPeimHString = PcdCommonHeaderString + pcdPeiDatabase.getHString() + PcdDatabase.getPcdPeiDatabaseDefinitions(); MemoryDatabaseManager.PcdPeimCString = pcdPeiDatabase.getCString(); @@ -2043,7 +1679,7 @@ public class CollectPCDAction { "DXE", alPei.size() ); - pcdDxeDatabase.genCodeNew(); + pcdDxeDatabase.genCode(); MemoryDatabaseManager.PcdDxeHString = MemoryDatabaseManager.PcdPeimHString + pcdDxeDatabase.getHString() + PcdDatabase.getPcdDxeDatabaseDefinitions(); MemoryDatabaseManager.PcdDxeCString = pcdDxeDatabase.getCString(); @@ -2106,8 +1742,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;