4 This module contains all classes releted to PCD token.
6 Copyright (c) 2006, Intel Corporation
7 All rights reserved. This program and the accompanying materials
8 are licensed and made available under the terms and conditions of the BSD License
9 which accompanies this distribution. The full text of the license may be found at
10 http://opensource.org/licenses/bsd-license.php
12 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
13 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
16 package org
.tianocore
.build
.pcd
.entity
;
18 import java
.math
.BigInteger
;
19 import java
.util
.ArrayList
;
20 import java
.util
.HashMap
;
21 import java
.util
.List
;
23 import java
.util
.UUID
;
25 import org
.tianocore
.build
.pcd
.exception
.EntityException
;
27 /** This class is to descript a PCD token object. The information of a token mainly
28 comes from MSA, SPD and setting produced by platform developer.
32 /// Enumeration macro defintion for PCD type.
33 /// BUGBUG: Not use upcase charater is to facility for reading. It may be changed
35 public enum PCD_TYPE
{FEATURE_FLAG
, FIXED_AT_BUILD
, PATCHABLE_IN_MODULE
, DYNAMIC
,
39 /// Enumeration macro definition for datum type. All type mainly comes from ProcessBind.h.
40 /// Wizard maybe expand this type as "int, unsigned int, short, unsigned short etc" in
43 public enum DATUM_TYPE
{UINT8
, UINT16
, UINT32
, UINT64
, BOOLEAN
, POINTER
, UNKNOWN
}
46 /// Enumeration macor defintion for usage of PCD
48 public enum PCD_USAGE
{ALWAYS_PRODUCED
, ALWAYS_CONSUMED
, SOMETIMES_PRODUCED
,
49 SOMETIMES_CONSUMED
, UNKNOWN
}
52 /// cName is to identify a PCD entry and will be used for generating autogen.h/autogen.c.
53 /// cName will be defined in MSA, SPD and FPD, can be regarded as primary key with token space guid.
58 /// Token space name is the guid defined by token itself in package or module level. This
59 /// name mainly for DynamicEx type. For other PCD type token, his token space name is the
60 /// assignedtokenSpaceName as follows.
61 /// tokenSpaceName is defined in MSA, SPD, FPD, can be regarded as primary key with cName.
63 public UUID tokenSpaceName
;
66 /// tokenNumber is allocated by platform. tokenNumber indicate an index for this token in
67 /// platform token space. For Dynamic, dynamicEx type, this number will be re-adjust by
68 /// PCD run-time database autogen tools.
70 public long tokenNumber
;
73 /// This token number is retrieved from FPD file for DynamicEx type.
75 public long dynamicExTokenNumber
;
78 /// All supported PCD type, this value can be retrieved from SPD
79 /// Currently, only record all PCD type for this token in FPD file.
81 public List
<PCD_TYPE
> supportedPcdType
;
84 /// If the token's item type is Dynamic or DynamicEx type, isDynamicPCD
87 public boolean isDynamicPCD
;
90 /// datumSize is to descript the fix size or max size for this token.
91 /// datumSize is defined in SPD.
96 /// datum type is to descript what type can be expressed by a PCD token.
97 /// For same PCD used in different module, the datum type should be unique.
98 /// So it belong memeber to Token class.
100 public DATUM_TYPE datumType
;
103 /// skuData contains all value for SkuNumber of token.
104 /// This field is for Dynamic or DynamicEx type PCD,
106 public List
<SkuInstance
> skuData
;
109 /// consumers array record all module private information who consume this PCD token.
111 public Map
<String
, UsageInstance
> consumers
;
113 public Token(String cName
, UUID tokenSpaceName
) {
114 UUID nullUUID
= new UUID(0, 0);
117 this.tokenSpaceName
= (tokenSpaceName
== null) ? nullUUID
: tokenSpaceName
;
118 this.tokenNumber
= 0;
119 this.datumType
= DATUM_TYPE
.UNKNOWN
;
121 this.skuData
= new ArrayList
<SkuInstance
>();
123 this.consumers
= new HashMap
<String
, UsageInstance
>();
124 this.supportedPcdType
= new ArrayList
<PCD_TYPE
>();
130 SupportPcdType should be gotten from SPD file actually, but now it just
131 record all PCD type for this token in FPD file.
133 @param pcdType new PCD type found in FPD file for this token.
135 public void updateSupportPcdType(PCD_TYPE pcdType
) {
137 boolean found
= false;
138 for (index
= 0; index
< this.supportedPcdType
.size(); index
++) {
139 if (this.supportedPcdType
.get(index
) == pcdType
) {
145 this.supportedPcdType
.add(pcdType
);
150 Judge whether pcdType is belong to dynamic type. Dynamic type includes
151 DYNAMIC and DYNAMIC_EX.
157 public static boolean isDynamic(PCD_TYPE pcdType
) {
158 if ((pcdType
== PCD_TYPE
.DYNAMIC
) ||
159 (pcdType
== PCD_TYPE
.DYNAMIC_EX
)) {
166 public boolean isDynamicEx() {
168 for (int i
= 0; i
< supportedPcdType
.size(); i
++) {
169 if (supportedPcdType
.get(i
) == PCD_TYPE
.DYNAMIC_EX
) {
178 Use "TokencName + "-" + SpaceTokenName" as primary key when adding token into database
180 @param cName Token name.
181 @param tokenSpaceName The token space guid defined in MSA or SPD
182 @param platformtokenSpaceName The token space guid for current platform token space,
184 @return primary key for this token in token database.
186 public static String
getPrimaryKeyString(String cName
, UUID tokenSpaceName
) {
187 UUID nullUUID
= new UUID(0, 0);
189 if (tokenSpaceName
== null) {
190 return cName
+ "_" + nullUUID
.toString().replace('-', '_');
192 return cName
+ "_" + tokenSpaceName
.toString().replace('-', '_');
197 If skudata list contains more than one data, then Sku mechanism is enable.
201 public boolean isSkuEnable() {
202 if (this.skuData
.size() > 1) {
208 public boolean isHiiEnable() {
209 if (getDefaultSku().type
== DynamicTokenValue
.VALUE_TYPE
.HII_TYPE
) {
215 public boolean isVpdEnable() {
216 if (getDefaultSku().type
== DynamicTokenValue
.VALUE_TYPE
.VPD_TYPE
) {
223 Get the token primary key in token database.
227 public String
getPrimaryKeyString () {
228 return Token
.getPrimaryKeyString(cName
, tokenSpaceName
);
232 Judge datumType is valid
234 @param type The datumType want to be judged.
236 @retval TRUE - The type is valid.
237 @retval FALSE - The type is invalid.
239 public static boolean isValiddatumType(DATUM_TYPE type
) {
240 if ((type
.ordinal() < DATUM_TYPE
.UINT8
.ordinal() ) ||
241 (type
.ordinal() > DATUM_TYPE
.POINTER
.ordinal())) {
248 Judge pcdType is valid
250 @param type The PCdType want to be judged.
252 @retval TRUE - The type is valid.
253 @retval FALSE - The type is invalid.
255 public static boolean isValidpcdType(PCD_TYPE type
) {
256 if ((type
.ordinal() < PCD_TYPE
.FEATURE_FLAG
.ordinal() ) ||
257 (type
.ordinal() > PCD_TYPE
.DYNAMIC_EX
.ordinal())) {
264 Add an usage instance for token
266 @param usageInstance The usage instance
268 @retval TRUE - Success to add usage instance.
269 @retval FALSE - Fail to add usage instance
271 public boolean addUsageInstance(UsageInstance usageInstance
)
272 throws EntityException
{
275 if (isUsageInstanceExist(usageInstance
.moduleName
,
276 usageInstance
.moduleGUID
,
277 usageInstance
.packageName
,
278 usageInstance
.packageGUID
,
280 usageInstance
.version
)) {
281 exceptionStr
= String
.format("PCD %s for module %s has already exist in database, Please check all PCD build entries "+
282 "in modules PcdPeim in <ModuleSA> to make sure no duplicated definitions!",
283 usageInstance
.parentToken
.cName
,
284 usageInstance
.moduleName
);
285 throw new EntityException(exceptionStr
);
288 consumers
.put(usageInstance
.getPrimaryKey(), usageInstance
);
293 Judge whether exist an usage instance for this token
295 @param moduleName the name of module
296 @param moduleGuid the GUID name of modules
297 @param packageName the name of package contains this module
298 @param packageGuid the GUID name of package contains this module
299 @param arch the architecture string
300 @param version the version string
302 @return boolean whether exist an usage instance for this token.
304 public boolean isUsageInstanceExist(String moduleName
,
310 String keyStr
= UsageInstance
.getPrimaryKey(moduleName
,
316 return (consumers
.get(keyStr
) != null);
320 Get the PCD_TYPE according to the string of PCD_TYPE
322 @param pcdTypeStr The string of PCD_TYPE
326 public static PCD_TYPE
getpcdTypeFromString(String pcdTypeStr
) {
327 if (pcdTypeStr
== null) {
328 return PCD_TYPE
.UNKNOWN
;
331 if (pcdTypeStr
.equalsIgnoreCase("FEATURE_FLAG")) {
332 return PCD_TYPE
.FEATURE_FLAG
;
333 } else if (pcdTypeStr
.equalsIgnoreCase("FIXED_AT_BUILD")) {
334 return PCD_TYPE
.FIXED_AT_BUILD
;
335 } else if (pcdTypeStr
.equalsIgnoreCase("PATCHABLE_IN_MODULE")) {
336 return PCD_TYPE
.PATCHABLE_IN_MODULE
;
337 } else if (pcdTypeStr
.equalsIgnoreCase("DYNAMIC")) {
338 return PCD_TYPE
.DYNAMIC
;
339 } else if (pcdTypeStr
.equalsIgnoreCase("DYNAMIC_EX")) {
340 return PCD_TYPE
.DYNAMIC_EX
;
342 return PCD_TYPE
.UNKNOWN
;
347 Get the string of given datumType. This string will be used for generating autogen files
349 @param datumType Given datumType
351 @return The string of datum type.
353 public static String
getStringOfdatumType(DATUM_TYPE datumType
) {
372 Get the datumType according to a string.
374 @param datumTypeStr The string of datumType
378 public static DATUM_TYPE
getdatumTypeFromString(String datumTypeStr
) {
379 if (datumTypeStr
.equalsIgnoreCase("UINT8")) {
380 return DATUM_TYPE
.UINT8
;
381 } else if (datumTypeStr
.equalsIgnoreCase("UINT16")) {
382 return DATUM_TYPE
.UINT16
;
383 } else if (datumTypeStr
.equalsIgnoreCase("UINT32")) {
384 return DATUM_TYPE
.UINT32
;
385 } else if (datumTypeStr
.equalsIgnoreCase("UINT64")) {
386 return DATUM_TYPE
.UINT64
;
387 } else if (datumTypeStr
.equalsIgnoreCase("VOID*")) {
388 return DATUM_TYPE
.POINTER
;
389 } else if (datumTypeStr
.equalsIgnoreCase("BOOLEAN")) {
390 return DATUM_TYPE
.BOOLEAN
;
392 return DATUM_TYPE
.UNKNOWN
;
396 Get string of given pcdType
398 @param pcdType The given PcdType
400 @return The string of PCD_TYPE.
402 public static String
getStringOfpcdType(PCD_TYPE pcdType
) {
405 return "FEATURE_FLAG";
407 return "FIXED_AT_BUILD";
408 case PATCHABLE_IN_MODULE
:
409 return "PATCHABLE_IN_MODULE";
419 Get the PCD_USAGE according to a string
421 @param usageStr The string of PCD_USAGE
423 @return The PCD_USAGE
425 public static PCD_USAGE
getUsageFromString(String usageStr
) {
426 if (usageStr
== null) {
427 return PCD_USAGE
.UNKNOWN
;
430 if (usageStr
.equalsIgnoreCase("ALWAYS_PRODUCED")) {
431 return PCD_USAGE
.ALWAYS_PRODUCED
;
432 } else if (usageStr
.equalsIgnoreCase("SOMETIMES_PRODUCED")) {
433 return PCD_USAGE
.SOMETIMES_PRODUCED
;
434 } else if (usageStr
.equalsIgnoreCase("ALWAYS_CONSUMED")) {
435 return PCD_USAGE
.ALWAYS_CONSUMED
;
436 } else if (usageStr
.equalsIgnoreCase("SOMETIMES_CONSUMED")) {
437 return PCD_USAGE
.SOMETIMES_CONSUMED
;
440 return PCD_USAGE
.UNKNOWN
;
444 Get the string of given PCD_USAGE
446 @param usage The given PCD_USAGE
448 @return The string of PDC_USAGE.
450 public static String
getStringOfUsage(PCD_USAGE usage
) {
452 case ALWAYS_PRODUCED
:
453 return "ALWAYS_PRODUCED";
454 case ALWAYS_CONSUMED
:
455 return "ALWAYS_CONSUMED";
456 case SOMETIMES_PRODUCED
:
457 return "SOMETIMES_PRODUCED";
458 case SOMETIMES_CONSUMED
:
459 return "SOMETIMES_CONSUMED";
465 Get the Defined datumType string for autogen. The string is for generating some MACROs in Autogen.h
467 @param datumType The given datumType
469 @return string of datum type for autogen.
471 public static String
GetAutogenDefinedatumTypeString(DATUM_TYPE datumType
) {
492 Get the datumType String for Autogen. This string will be used for generating defintions of PCD token in autogen
494 @param datumType The given datumType
496 @return string of datum type.
499 public static String
getAutogendatumTypeString(DATUM_TYPE datumType
) {
518 Get the datumType string for generating some MACROs in autogen file of Library
520 @param datumType The given datumType
522 @return String of datum for genrating bit charater.
524 public static String
getAutogenLibrarydatumTypeString(DATUM_TYPE datumType
) {
544 UUID defined in Schems is object, this function is to tranlate this object
547 @param uuidObj The object comes from schema.
549 @return The traslated UUID instance.
551 public static UUID
getGUIDFromSchemaObject(Object uuidObj
) {
553 if (uuidObj
.toString().equalsIgnoreCase("0")) {
554 uuid
= new UUID(0,0);
556 uuid
= UUID
.fromString(uuidObj
.toString());
562 public DynamicTokenValue
getDefaultSku() {
563 DynamicTokenValue dynamicData
;
565 for (index
= 0; index
< this.skuData
.size(); index
++) {
566 if (skuData
.get(index
).id
== 0) {
567 return skuData
.get(index
).value
;
574 public int getSkuIdCount () {
575 return this.skuData
.size();
578 private void getCurrentSizeFromDefaultValue (String str
, ArrayList
<Integer
> al
) {
579 if (isValidNullValue(str
)) {
580 al
.add(new Integer(0));
583 // isValidNullValue has already make sure that str here
584 // always contain a valid default value of the following 3
586 // 1) "Hello world" //Assci string
587 // 2) L"Hello" //Unicode string
588 // 3) {0x01, 0x02, 0x03} //Byte stream
590 if (str
.startsWith("\"")) {
591 al
.add(new Integer(str
.length() - 2));
592 } else if (str
.startsWith("L\"")){
594 // Unicode is 2 bytes each.
596 al
.add(new Integer((str
.length() - 3) * 2));
597 } else if (str
.startsWith("{")) {
599 // We count the number of "," in the string.
600 // The number of byte is one plus the number of
607 pos
= str2
.indexOf(",", 0);
611 pos
= str2
.indexOf(",", pos
);
614 al
.add(new Integer(cnt
));
619 // This method can be used to get the MAX and current size
620 // for pointer type dynamic(ex) PCD entry
622 public ArrayList
<Integer
> getPointerTypeSize () {
623 ArrayList
<Integer
> al
= new ArrayList
<Integer
>();
626 // For VPD_enabled and HII_enabled, we can only return the MAX size.
627 // For the default DATA type dynamic PCD entry, we will return
628 // the MAX size and current size for each SKU_ID.
630 al
.add(new Integer(this.datumSize
));
632 if (!this.isVpdEnable()) {
634 if (this.isHiiEnable()){
635 for (idx
= 0; idx
< this.skuData
.size(); idx
++) {
636 String str
= this.skuData
.get(idx
).value
.hiiDefaultValue
;
637 getCurrentSizeFromDefaultValue(str
, al
);
640 for (idx
= 0; idx
< this.skuData
.size(); idx
++) {
641 String str
= this.skuData
.get(idx
).value
.value
;
642 getCurrentSizeFromDefaultValue(str
, al
);
651 Get default value for a token, For HII type, HiiDefaultValue of default
652 SKU 0 will be returned; For Default type, the defaultvalue of default SKU
657 public String
getDynamicDefaultValue() {
658 DynamicTokenValue dynamicData
= getDefaultSku();
659 if (hasDefaultValue()) {
660 switch (dynamicData
.type
) {
662 return dynamicData
.value
;
670 // BugBug: We need change this algorithm accordingly when schema is updated
671 // to support no default value.
673 public boolean hasDefaultValue () {
675 boolean isInteger
= true;
676 DynamicTokenValue dynamicValue
= null;
682 if (this.isDynamicPCD
) {
683 dynamicValue
= getDefaultSku();
684 switch (dynamicValue
.type
) {
690 return !isValidNullValue(dynamicValue
.value
);
697 public boolean isValidNullValue(String judgedValue
) {
699 BigInteger bigIntValue
;
705 if (judgedValue
.length() > 2) {
706 if ((judgedValue
.charAt(0) == '0') &&
707 ((judgedValue
.charAt(1) == 'x') || (judgedValue
.charAt(1) == 'X'))){
708 subStr
= judgedValue
.substring(2, judgedValue
.length());
709 bigIntValue
= new BigInteger(subStr
, 16);
711 bigIntValue
= new BigInteger(judgedValue
);
714 bigIntValue
= new BigInteger(judgedValue
);
716 if (bigIntValue
.bitCount() == 0) {
721 if (judgedValue
.length() > 2){
722 if ((judgedValue
.charAt(0) == '0') &&
723 ((judgedValue
.charAt(1) == 'x') ||
724 (judgedValue
.charAt(1) == 'X'))) {
725 bigIntValue
= new BigInteger(judgedValue
.substring(2, judgedValue
.length()), 16);
726 if (bigIntValue
.bitCount() == 0) {
730 bigIntValue
= new BigInteger(judgedValue
);
731 if (bigIntValue
.bitCount() == 0) {
736 bigIntValue
= new BigInteger(judgedValue
);
737 if (bigIntValue
.bitCount() == 0) {
743 if (judgedValue
.equalsIgnoreCase("false")) {
748 if (judgedValue
.equalsIgnoreCase("") ||
749 judgedValue
.equalsIgnoreCase("\"\"") ||
750 judgedValue
.equalsIgnoreCase("L\"\"") ||
751 (judgedValue
.length() == 0) ||
752 judgedValue
.equalsIgnoreCase("{}")) {
759 public boolean isHiiDefaultValueUnicodeStringType() {
760 DynamicTokenValue dynamicData
= getDefaultSku();
762 if (dynamicData
== null)
765 return dynamicData
.hiiDefaultValue
.startsWith("L\"")
766 && dynamicData
.hiiDefaultValue
.endsWith("\"");
769 public boolean isHiiDefaultValueASCIIStringType() {
770 DynamicTokenValue dynamicData
= getDefaultSku();
772 if (dynamicData
== null)
775 return dynamicData
.hiiDefaultValue
.startsWith("\"")
776 && dynamicData
.hiiDefaultValue
.endsWith("\"");
780 Judege whether current value is UNICODE string type.
783 public boolean isUnicodeStringType () {
784 String str
= getDynamicDefaultValue();
790 if (datumType
== Token
.DATUM_TYPE
.POINTER
&&
791 str
.startsWith("L\"") &&
792 str
.endsWith("\"")) {
799 public boolean isASCIIStringType () {
800 String str
= getDynamicDefaultValue();
806 if (datumType
== Token
.DATUM_TYPE
.POINTER
&&
807 str
.startsWith("\"") &&
808 str
.endsWith("\"")) {
815 public boolean isByteStreamType () {
816 String str
= getDynamicDefaultValue();
822 if (datumType
== Token
.DATUM_TYPE
.POINTER
&&
823 str
.startsWith("{") &&
832 public String
getStringTypeString () {
833 return getDefaultSku().value
.substring(2, getDefaultSku().value
.length() - 1);