BaseTools/Source/Python/AutoGen/GenPcdDb.py

   1 ## @file
   2 # Routines for generating Pcd Database
   3 #
   4 # Copyright (c) 2013 - 2015, Intel Corporation. All rights reserved.<BR>
   5 # This program and the accompanying materials
   6 # are licensed and made available under the terms and conditions of the BSD License
   7 # which accompanies this distribution.  The full text of the license may be found at
   8 # http://opensource.org/licenses/bsd-license.php
   9 #
  10 # THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11 # WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12 #
  13 from StringIO import StringIO
  14 from Common.Misc import *
  15 from Common.String import StringToArray
  16 from struct import pack
  17 from ValidCheckingInfoObject import VAR_CHECK_PCD_VARIABLE_TAB_CONTAINER
  18 from ValidCheckingInfoObject import VAR_CHECK_PCD_VARIABLE_TAB
  19 from ValidCheckingInfoObject import VAR_VALID_OBJECT_FACTORY
  20 from Common.VariableAttributes import VariableAttributes
  21
  22 DATABASE_VERSION = 5
  23
  24 gPcdDatabaseAutoGenC = TemplateString("""
  25 //
  26 // External PCD database debug information
  27 //
  28 #if 0
  29 ${PHASE}_PCD_DATABASE_INIT g${PHASE}PcdDbInit = {
  30 ${BEGIN}  { ${INIT_VALUE_UINT64} }, /*  ${INIT_CNAME_DECL_UINT64}_${INIT_GUID_DECL_UINT64}[${INIT_NUMSKUS_DECL_UINT64}] */
  31 ${END}
  32 ${BEGIN}  ${VARDEF_VALUE_UINT64}, /* ${VARDEF_CNAME_UINT64}_${VARDEF_GUID_UINT64}_VariableDefault_${VARDEF_SKUID_UINT64} */
  33 ${END}
  34 ${BEGIN}  { ${INIT_VALUE_UINT32} }, /*  ${INIT_CNAME_DECL_UINT32}_${INIT_GUID_DECL_UINT32}[${INIT_NUMSKUS_DECL_UINT32}] */
  35 ${END}
  36 ${BEGIN}  ${VARDEF_VALUE_UINT32}, /* ${VARDEF_CNAME_UINT32}_${VARDEF_GUID_UINT32}_VariableDefault_${VARDEF_SKUID_UINT32} */
  37 ${END}
  38   /* VPD */
  39 ${BEGIN}  { ${VPD_HEAD_VALUE} }, /* ${VPD_HEAD_CNAME_DECL}_${VPD_HEAD_GUID_DECL}[${VPD_HEAD_NUMSKUS_DECL}] */
  40 ${END}
  41   /* ExMapTable */
  42   {
  43 ${BEGIN}    { ${EXMAPPING_TABLE_EXTOKEN}, ${EXMAPPING_TABLE_LOCAL_TOKEN}, ${EXMAPPING_TABLE_GUID_INDEX} },
  44 ${END}
  45   },
  46   /* LocalTokenNumberTable */
  47   {
  48 ${BEGIN}    offsetof(${PHASE}_PCD_DATABASE, ${TOKEN_INIT}.${TOKEN_CNAME}_${TOKEN_GUID}${VARDEF_HEADER}) | ${TOKEN_TYPE},
  49 ${END}
  50   },
  51   /* GuidTable */
  52   {
  53 ${BEGIN}    ${GUID_STRUCTURE},
  54 ${END}
  55   },
  56 ${BEGIN}  { ${STRING_HEAD_VALUE} }, /* ${STRING_HEAD_CNAME_DECL}_${STRING_HEAD_GUID_DECL}[${STRING_HEAD_NUMSKUS_DECL}] */
  57 ${END}
  58 ${BEGIN}  /* ${VARIABLE_HEAD_CNAME_DECL}_${VARIABLE_HEAD_GUID_DECL}_Variable_Header[${VARIABLE_HEAD_NUMSKUS_DECL}] */
  59   {
  60     ${VARIABLE_HEAD_VALUE}
  61   },
  62 ${END}
  63 /* SkuHead */
  64   {
  65   ${BEGIN} offsetof (${PHASE}_PCD_DATABASE, ${TOKEN_INIT}.${TOKEN_CNAME}_${TOKEN_GUID}${VARDEF_HEADER}) | ${TOKEN_TYPE}, /* */
  66            offsetof (${PHASE}_PCD_DATABASE, ${TOKEN_INIT}.SkuHead)  /* */
  67   ${END}
  68   },
  69  /* StringTable */
  70 ${BEGIN}  ${STRING_TABLE_VALUE}, /* ${STRING_TABLE_CNAME}_${STRING_TABLE_GUID} */
  71 ${END}
  72   /* SizeTable */
  73   {
  74 ${BEGIN}    ${SIZE_TABLE_MAXIMUM_LENGTH}, ${SIZE_TABLE_CURRENT_LENGTH}, /* ${SIZE_TABLE_CNAME}_${SIZE_TABLE_GUID} */
  75 ${END}
  76   },
  77 ${BEGIN}  { ${INIT_VALUE_UINT16} }, /*  ${INIT_CNAME_DECL_UINT16}_${INIT_GUID_DECL_UINT16}[${INIT_NUMSKUS_DECL_UINT16}] */
  78 ${END}
  79 ${BEGIN}  ${VARDEF_VALUE_UINT16}, /* ${VARDEF_CNAME_UINT16}_${VARDEF_GUID_UINT16}_VariableDefault_${VARDEF_SKUID_UINT16} */
  80 ${END}
  81 ${BEGIN}  { ${INIT_VALUE_UINT8} }, /*  ${INIT_CNAME_DECL_UINT8}_${INIT_GUID_DECL_UINT8}[${INIT_NUMSKUS_DECL_UINT8}] */
  82 ${END}
  83 ${BEGIN}  ${VARDEF_VALUE_UINT8}, /* ${VARDEF_CNAME_UINT8}_${VARDEF_GUID_UINT8}_VariableDefault_${VARDEF_SKUID_UINT8} */
  84 ${END}
  85 ${BEGIN}  { ${INIT_VALUE_BOOLEAN} }, /*  ${INIT_CNAME_DECL_BOOLEAN}_${INIT_GUID_DECL_BOOLEAN}[${INIT_NUMSKUS_DECL_BOOLEAN}] */
  86 ${END}
  87 ${BEGIN}  ${VARDEF_VALUE_BOOLEAN}, /* ${VARDEF_CNAME_BOOLEAN}_${VARDEF_GUID_BOOLEAN}_VariableDefault_${VARDEF_SKUID_BOOLEAN} */
  88 ${END}
  89   /* SkuIdTable */
  90   { ${BEGIN}${SKUID_VALUE}, ${END} },
  91   ${SYSTEM_SKU_ID_VALUE}
  92 };
  93 #endif
  94 """)
  95
  96 ## Mapping between PCD driver type and EFI phase
  97 gPcdPhaseMap = {
  98     "PEI_PCD_DRIVER"    :   "PEI",
  99     "DXE_PCD_DRIVER"    :   "DXE"
 100 }
 101
 102 gPcdDatabaseAutoGenH = TemplateString("""
 103 #define PCD_${PHASE}_SERVICE_DRIVER_VERSION         ${SERVICE_DRIVER_VERSION}
 104
 105 //
 106 // External PCD database debug information
 107 //
 108 #if 0
 109 #define ${PHASE}_GUID_TABLE_SIZE                ${GUID_TABLE_SIZE}
 110 #define ${PHASE}_STRING_TABLE_SIZE              ${STRING_TABLE_SIZE}
 111 #define ${PHASE}_SKUID_TABLE_SIZE               ${SKUID_TABLE_SIZE}
 112 #define ${PHASE}_LOCAL_TOKEN_NUMBER_TABLE_SIZE  ${LOCAL_TOKEN_NUMBER_TABLE_SIZE}
 113 #define ${PHASE}_LOCAL_TOKEN_NUMBER             ${LOCAL_TOKEN_NUMBER}
 114 #define ${PHASE}_EXMAPPING_TABLE_SIZE           ${EXMAPPING_TABLE_SIZE}
 115 #define ${PHASE}_EX_TOKEN_NUMBER                ${EX_TOKEN_NUMBER}
 116 #define ${PHASE}_SIZE_TABLE_SIZE                ${SIZE_TABLE_SIZE}
 117 #define ${PHASE}_SKU_HEAD_SIZE                  ${SKU_HEAD_SIZE}
 118 #define ${PHASE}_GUID_TABLE_EMPTY               ${GUID_TABLE_EMPTY}
 119 #define ${PHASE}_STRING_TABLE_EMPTY             ${STRING_TABLE_EMPTY}
 120 #define ${PHASE}_SKUID_TABLE_EMPTY              ${SKUID_TABLE_EMPTY}
 121 #define ${PHASE}_DATABASE_EMPTY                 ${DATABASE_EMPTY}
 122 #define ${PHASE}_EXMAP_TABLE_EMPTY              ${EXMAP_TABLE_EMPTY}
 123
 124 typedef struct {
 125 ${BEGIN}  UINT64             ${INIT_CNAME_DECL_UINT64}_${INIT_GUID_DECL_UINT64}[${INIT_NUMSKUS_DECL_UINT64}];
 126 ${END}
 127 ${BEGIN}  UINT64             ${VARDEF_CNAME_UINT64}_${VARDEF_GUID_UINT64}_VariableDefault_${VARDEF_SKUID_UINT64};
 128 ${END}
 129 ${BEGIN}  UINT32             ${INIT_CNAME_DECL_UINT32}_${INIT_GUID_DECL_UINT32}[${INIT_NUMSKUS_DECL_UINT32}];
 130 ${END}
 131 ${BEGIN}  UINT32             ${VARDEF_CNAME_UINT32}_${VARDEF_GUID_UINT32}_VariableDefault_${VARDEF_SKUID_UINT32};
 132 ${END}
 133 ${BEGIN}  VPD_HEAD           ${VPD_HEAD_CNAME_DECL}_${VPD_HEAD_GUID_DECL}[${VPD_HEAD_NUMSKUS_DECL}];
 134 ${END}
 135   DYNAMICEX_MAPPING  ExMapTable[${PHASE}_EXMAPPING_TABLE_SIZE];
 136   UINT32             LocalTokenNumberTable[${PHASE}_LOCAL_TOKEN_NUMBER_TABLE_SIZE];
 137   GUID               GuidTable[${PHASE}_GUID_TABLE_SIZE];
 138 ${BEGIN}  STRING_HEAD        ${STRING_HEAD_CNAME_DECL}_${STRING_HEAD_GUID_DECL}[${STRING_HEAD_NUMSKUS_DECL}];
 139 ${END}
 140 ${BEGIN}  VARIABLE_HEAD      ${VARIABLE_HEAD_CNAME_DECL}_${VARIABLE_HEAD_GUID_DECL}_Variable_Header[${VARIABLE_HEAD_NUMSKUS_DECL}];
 141 ${END}
 142 ${BEGIN}  SKU_HEAD           SkuHead[${PHASE}_SKU_HEAD_SIZE];
 143 ${END}
 144 ${BEGIN}  UINT8              StringTable${STRING_TABLE_INDEX}[${STRING_TABLE_LENGTH}]; /* ${STRING_TABLE_CNAME}_${STRING_TABLE_GUID} */
 145 ${END}
 146   SIZE_INFO          SizeTable[${PHASE}_SIZE_TABLE_SIZE];
 147 ${BEGIN}  UINT16             ${INIT_CNAME_DECL_UINT16}_${INIT_GUID_DECL_UINT16}[${INIT_NUMSKUS_DECL_UINT16}];
 148 ${END}
 149 ${BEGIN}  UINT16             ${VARDEF_CNAME_UINT16}_${VARDEF_GUID_UINT16}_VariableDefault_${VARDEF_SKUID_UINT16};
 150 ${END}
 151 ${BEGIN}  UINT8              ${INIT_CNAME_DECL_UINT8}_${INIT_GUID_DECL_UINT8}[${INIT_NUMSKUS_DECL_UINT8}];
 152 ${END}
 153 ${BEGIN}  UINT8              ${VARDEF_CNAME_UINT8}_${VARDEF_GUID_UINT8}_VariableDefault_${VARDEF_SKUID_UINT8};
 154 ${END}
 155 ${BEGIN}  BOOLEAN            ${INIT_CNAME_DECL_BOOLEAN}_${INIT_GUID_DECL_BOOLEAN}[${INIT_NUMSKUS_DECL_BOOLEAN}];
 156 ${END}
 157 ${BEGIN}  BOOLEAN            ${VARDEF_CNAME_BOOLEAN}_${VARDEF_GUID_BOOLEAN}_VariableDefault_${VARDEF_SKUID_BOOLEAN};
 158 ${END}
 159   UINT8              SkuIdTable[${PHASE}_SKUID_TABLE_SIZE];
 160 ${SYSTEM_SKU_ID}
 161 } ${PHASE}_PCD_DATABASE_INIT;
 162
 163 typedef struct {
 164 ${PCD_DATABASE_UNINIT_EMPTY}
 165 ${BEGIN}  UINT64   ${UNINIT_CNAME_DECL_UINT64}_${UNINIT_GUID_DECL_UINT64}[${UNINIT_NUMSKUS_DECL_UINT64}];
 166 ${END}
 167 ${BEGIN}  UINT32   ${UNINIT_CNAME_DECL_UINT32}_${UNINIT_GUID_DECL_UINT32}[${UNINIT_NUMSKUS_DECL_UINT32}];
 168 ${END}
 169 ${BEGIN}  UINT16   ${UNINIT_CNAME_DECL_UINT16}_${UNINIT_GUID_DECL_UINT16}[${UNINIT_NUMSKUS_DECL_UINT16}];
 170 ${END}
 171 ${BEGIN}  UINT8    ${UNINIT_CNAME_DECL_UINT8}_${UNINIT_GUID_DECL_UINT8}[${UNINIT_NUMSKUS_DECL_UINT8}];
 172 ${END}
 173 ${BEGIN}  BOOLEAN  ${UNINIT_CNAME_DECL_BOOLEAN}_${UNINIT_GUID_DECL_BOOLEAN}[${UNINIT_NUMSKUS_DECL_BOOLEAN}];
 174 ${END}
 175 } ${PHASE}_PCD_DATABASE_UNINIT;
 176
 177 typedef struct {
 178   //GUID                  Signature;  // PcdDataBaseGuid
 179   //UINT32                Length;
 180   //UINT32                UninitDataBaseSize;// Total size for PCD those default value with 0.
 181   //TABLE_OFFSET          LocalTokenNumberTableOffset;
 182   //TABLE_OFFSET          ExMapTableOffset;
 183   //TABLE_OFFSET          GuidTableOffset;
 184   //TABLE_OFFSET          StringTableOffset;
 185   //TABLE_OFFSET          SizeTableOffset;
 186   //TABLE_OFFSET          SkuIdTableOffset;
 187   //UINT16                LocalTokenCount;  // LOCAL_TOKEN_NUMBER for all
 188   //UINT16                ExTokenCount;     // EX_TOKEN_NUMBER for DynamicEx
 189   //UINT16                GuidTableCount;   // The Number of Guid in GuidTable
 190   //SKU_ID                SystemSkuId;      // Current SkuId value.
 191   //UINT8                 Pad;
 192   ${PHASE}_PCD_DATABASE_INIT    Init;
 193   ${PHASE}_PCD_DATABASE_UNINIT  Uninit;
 194 } ${PHASE}_PCD_DATABASE;
 195
 196 #define ${PHASE}_NEX_TOKEN_NUMBER (${PHASE}_LOCAL_TOKEN_NUMBER - ${PHASE}_EX_TOKEN_NUMBER)
 197 #endif
 198 """)
 199
 200
 201 gEmptyPcdDatabaseAutoGenC = TemplateString("""
 202 //
 203 // External PCD database debug information
 204 //
 205 #if 0
 206 ${PHASE}_PCD_DATABASE_INIT g${PHASE}PcdDbInit = {
 207   /* ExMapTable */
 208   {
 209     {0, 0, 0}
 210   },
 211   /* LocalTokenNumberTable */
 212   {
 213     0
 214   },
 215   /* GuidTable */
 216   {
 217     {0x00000000, 0x0000, 0x0000, {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}}
 218   },
 219   /* StringTable */
 220   { 0 },
 221   /* SkuHead */
 222   {
 223     0, 0
 224   },
 225   /* SizeTable */
 226   {
 227     0, 0
 228   },
 229   /* SkuIdTable */
 230   { 0 },
 231   ${SYSTEM_SKU_ID_VALUE}
 232 };
 233 #endif
 234 """)
 235
 236 ## PackGuid
 237 #
 238 # Pack the GUID value in C structure format into data array
 239 #
 240 # @param GuidStructureValue:   The GUID value in C structure format
 241 #
 242 # @retval Buffer:  a data array contains the Guid
 243 #
 244 def PackGuid(GuidStructureValue):
 245     GuidString = GuidStructureStringToGuidString(GuidStructureValue)
 246     Guid = GuidString.split('-')
 247     Buffer = pack('=LHHBBBBBBBB',
 248                 int(Guid[0], 16),
 249                 int(Guid[1], 16),
 250                 int(Guid[2], 16),
 251                 int(Guid[3][-4:-2], 16),
 252                 int(Guid[3][-2:], 16),
 253                 int(Guid[4][-12:-10], 16),
 254                 int(Guid[4][-10:-8], 16),
 255                 int(Guid[4][-8:-6], 16),
 256                 int(Guid[4][-6:-4], 16),
 257                 int(Guid[4][-4:-2], 16),
 258                 int(Guid[4][-2:], 16)
 259                 )
 260     return Buffer
 261
 262 def toHex(s):
 263     lst = []
 264     for ch in s:
 265         hv = hex(ord(ch)).replace('0x', ' ')
 266         if len(hv) == 1:
 267             hv = '0'+hv
 268         lst.append(hv)
 269     if lst:
 270         return reduce(lambda x,y:x+y, lst)
 271     else:
 272         return 'empty'
 273 ## DbItemList
 274 #
 275 #  The class holds the Pcd database items. ItemSize if not zero should match the item datum type in the C structure.
 276 #  When the structure is changed, remember to check the ItemSize and the related  PackStr in PackData()
 277 #  RawDataList is the RawData that may need some kind of calculation or transformation,
 278 #  the DataList corresponds to the data that need to be written to database. If DataList is not present, then RawDataList
 279 #  will be written to the database.
 280 #
 281 class DbItemList:
 282     def __init__(self, ItemSize, DataList=None, RawDataList=None):
 283         if DataList is None:
 284             DataList = []
 285         if RawDataList is None:
 286             RawDataList = []
 287         self.ItemSize = ItemSize
 288         self.DataList = DataList
 289         self.RawDataList = RawDataList
 290         self.ListSize = 0
 291
 292     def GetInterOffset(self, Index):
 293         Offset = 0
 294         if self.ItemSize == 0:
 295             #
 296             # Variable length, need to calculate one by one
 297             #
 298             assert(Index < len(self.RawDataList))
 299             for ItemIndex in xrange(Index):
 300                 Offset += len(self.RawDataList[ItemIndex])
 301         else:
 302             for Datas in self.RawDataList:
 303                 Offset = self.ItemSize * Index
 304
 305         return Offset
 306
 307     def GetListSize(self):
 308         if self.ListSize:
 309             return self.ListSize
 310         if len(self.RawDataList) == 0:
 311             self.ListSize = 0
 312             return self.ListSize
 313         if self.ItemSize == 0:
 314             self.ListSize = self.GetInterOffset(len(self.RawDataList) - 1) + len(self.RawDataList[len(self.RawDataList)-1])
 315         else:
 316             self.ListSize = self.ItemSize * len(self.RawDataList)
 317         return self.ListSize
 318
 319     def PackData(self):
 320         if self.ItemSize == 8:
 321             PackStr = "=Q"
 322         elif self.ItemSize == 4:
 323             PackStr = "=L"
 324         elif self.ItemSize == 2:
 325             PackStr = "=H"
 326         elif self.ItemSize == 1:
 327             PackStr = "=B"
 328         elif self.ItemSize == 0:
 329             PackStr = "=B"
 330         elif self.ItemSize == 16:
 331             # pack Guid
 332             PackStr = ''
 333         else:
 334             # should not reach here
 335             assert(False)
 336
 337         Buffer = ''
 338         for Datas in self.RawDataList:
 339             if type(Datas) in (list, tuple):
 340                 for Data in Datas:
 341                     if PackStr:
 342                         Buffer += pack(PackStr, GetIntegerValue(Data))
 343                     else:
 344                         Buffer += PackGuid(Data)
 345             else:
 346                 if PackStr:
 347                     Buffer += pack(PackStr, GetIntegerValue(Datas))
 348                 else:
 349                     Buffer += PackGuid(Datas)
 350
 351         return Buffer
 352
 353 ## DbExMapTblItemList
 354 #
 355 #  The class holds the ExMap table
 356 #
 357 class DbExMapTblItemList (DbItemList):
 358     def __init__(self, ItemSize, DataList=None, RawDataList=None):
 359         if DataList is None:
 360             DataList = []
 361         if RawDataList is None:
 362             RawDataList = []
 363         DbItemList.__init__(self, ItemSize, DataList, RawDataList)
 364     def PackData(self):
 365         Buffer = ''
 366         PackStr = "=LHH"
 367         for Datas in self.RawDataList:
 368             Buffer += pack(PackStr,
 369                            GetIntegerValue(Datas[0]),
 370                            GetIntegerValue(Datas[1]),
 371                            GetIntegerValue(Datas[2]))
 372         return Buffer
 373
 374 ## DbComItemList
 375 #
 376 # The DbComItemList is a special kind of DbItemList in case that the size of the List can not be computed by the
 377 # ItemSize multiply the ItemCount.
 378 #
 379 class DbComItemList (DbItemList):
 380     def __init__(self, ItemSize, DataList=None, RawDataList=None):
 381         if DataList is None:
 382             DataList = []
 383         if RawDataList is None:
 384             RawDataList = []
 385         DbItemList.__init__(self, ItemSize, DataList, RawDataList)
 386     def GetInterOffset(self, Index):
 387         Offset = 0
 388         if self.ItemSize == 0:
 389             #
 390             # Variable length, need to calculte one by one
 391             # The only variable table is stringtable, it is not Composite item, should not reach here
 392             #
 393             assert(False)
 394         else:
 395             assert(Index < len(self.RawDataList))
 396             for ItemIndex in xrange(Index):
 397                 Offset += len(self.RawDataList[ItemIndex]) * self.ItemSize
 398
 399         return Offset
 400
 401     def GetListSize(self):
 402         if self.ListSize:
 403             return self.ListSize
 404         if self.ItemSize == 0:
 405             assert(False)
 406         else:
 407             if len(self.RawDataList) == 0:
 408                 self.ListSize = 0
 409             else:
 410                 self.ListSize = self.GetInterOffset(len(self.RawDataList) - 1) + len(self.RawDataList[len(self.RawDataList)-1]) * self.ItemSize
 411
 412         return self.ListSize
 413
 414     def PackData(self):
 415         if self.ItemSize == 8:
 416             PackStr = "=Q"
 417         elif self.ItemSize == 4:
 418             PackStr = "=L"
 419         elif self.ItemSize == 2:
 420             PackStr = "=H"
 421         elif self.ItemSize == 1:
 422             PackStr = "=B"
 423         elif self.ItemSize == 0:
 424             PackStr = "=B"
 425         else:
 426             assert(False)
 427
 428         Buffer = ''
 429         for DataList in self.RawDataList:
 430             for Data in DataList:
 431                 if type(Data) in (list, tuple):
 432                     for SingleData in Data:
 433                         Buffer += pack(PackStr, GetIntegerValue(SingleData))
 434                 else:
 435                     Buffer += pack(PackStr, GetIntegerValue(Data))
 436
 437         return Buffer
 438
 439 ## DbVariableTableItemList
 440 #
 441 #  The class holds the Variable header value table
 442 #
 443 class DbVariableTableItemList (DbComItemList):
 444     def __init__(self, ItemSize, DataList=None, RawDataList=None):
 445         if DataList is None:
 446             DataList = []
 447         if RawDataList is None:
 448             RawDataList = []
 449         DbComItemList.__init__(self, ItemSize, DataList, RawDataList)
 450     def PackData(self):
 451         PackStr = "=LLHHLHH"
 452         Buffer = ''
 453         for DataList in self.RawDataList:
 454             for Data in DataList:
 455                 Buffer += pack(PackStr,
 456                                GetIntegerValue(Data[0]),
 457                                GetIntegerValue(Data[1]),
 458                                GetIntegerValue(Data[2]),
 459                                GetIntegerValue(Data[3]),
 460                                GetIntegerValue(Data[4]),
 461                                GetIntegerValue(Data[5]),
 462                                GetIntegerValue(0))
 463         return Buffer
 464
 465 class DbStringHeadTableItemList(DbItemList):
 466     def __init__(self,ItemSize,DataList=None,RawDataList=None):
 467         if DataList is None:
 468             DataList = []
 469         if RawDataList is None:
 470             RawDataList = []
 471         DbItemList.__init__(self, ItemSize, DataList, RawDataList)
 472
 473     def GetInterOffset(self, Index):
 474         Offset = 0
 475         if self.ItemSize == 0:
 476             #
 477             # Variable length, need to calculate one by one
 478             #
 479             assert(Index < len(self.RawDataList))
 480             for ItemIndex in xrange(Index):
 481                 Offset += len(self.RawDataList[ItemIndex])
 482         else:
 483             for innerIndex in range(Index):
 484                 if type(self.RawDataList[innerIndex]) in (list, tuple):
 485                     Offset += len(self.RawDataList[innerIndex]) * self.ItemSize
 486                 else:
 487                     Offset += self.ItemSize
 488
 489         return Offset
 490
 491     def GetListSize(self):
 492         if self.ListSize:
 493             return self.ListSize
 494         if len(self.RawDataList) == 0:
 495             self.ListSize = 0
 496             return self.ListSize
 497         if self.ItemSize == 0:
 498             self.ListSize = self.GetInterOffset(len(self.RawDataList) - 1) + len(self.RawDataList[len(self.RawDataList)-1])
 499         else:
 500             for Datas in self.RawDataList:
 501                 if type(Datas) in (list, tuple):
 502                     self.ListSize += len(Datas) * self.ItemSize
 503                 else:
 504                     self.ListSize += self.ItemSize
 505         return self.ListSize
 506
 507 ## DbSkuHeadTableItemList
 508 #
 509 #  The class holds the Sku header value table
 510 #
 511 class DbSkuHeadTableItemList (DbItemList):
 512     def __init__(self, ItemSize, DataList=None, RawDataList=None):
 513         if DataList is None:
 514             DataList = []
 515         if RawDataList is None:
 516             RawDataList = []
 517         DbItemList.__init__(self, ItemSize, DataList, RawDataList)
 518     def PackData(self):
 519         PackStr = "=LL"
 520         Buffer = ''
 521         for Data in self.RawDataList:
 522             Buffer += pack(PackStr,
 523                            GetIntegerValue(Data[0]),
 524                            GetIntegerValue(Data[1]))
 525         return Buffer
 526
 527 ## DbSizeTableItemList
 528 #
 529 #  The class holds the size table
 530 #
 531 class DbSizeTableItemList (DbItemList):
 532     def __init__(self, ItemSize, DataList=None, RawDataList=None):
 533         if DataList is None:
 534             DataList = []
 535         if RawDataList is None:
 536             RawDataList = []
 537         DbItemList.__init__(self, ItemSize, DataList, RawDataList)
 538     def GetListSize(self):
 539         length = 0
 540         for Data in self.RawDataList:
 541             length += (1 + len(Data[1]))
 542         return length * self.ItemSize
 543     def PackData(self):
 544         PackStr = "=H"
 545         Buffer = ''
 546         for Data in self.RawDataList:
 547             Buffer += pack(PackStr,
 548                            GetIntegerValue(Data[0]))
 549             for subData in Data[1]:
 550                 Buffer += pack(PackStr,
 551                            GetIntegerValue(subData))
 552         return Buffer
 553
 554 ## DbStringItemList
 555 #
 556 #  The class holds the string table
 557 #
 558 class DbStringItemList (DbComItemList):
 559     def __init__(self, ItemSize, DataList=None, RawDataList=None, LenList=None):
 560         if DataList is None:
 561             DataList = []
 562         if RawDataList is None:
 563             RawDataList = []
 564         if LenList is None:
 565             LenList = []
 566
 567         assert(len(RawDataList) == len(LenList))
 568         DataList = []
 569         # adjust DataList according to the LenList
 570         for Index in xrange(len(RawDataList)):
 571             Len = LenList[Index]
 572             RawDatas = RawDataList[Index]
 573             assert(Len >= len(RawDatas))
 574             ActualDatas = []
 575             for i in xrange(len(RawDatas)):
 576                 ActualDatas.append(RawDatas[i])
 577             for i in xrange(len(RawDatas), Len):
 578                 ActualDatas.append(0)
 579             DataList.append(ActualDatas)
 580         self.LenList = LenList
 581         DbComItemList.__init__(self, ItemSize, DataList, RawDataList)
 582     def GetInterOffset(self, Index):
 583         Offset = 0
 584
 585         assert(Index < len(self.LenList))
 586         for ItemIndex in xrange(Index):
 587             Offset += self.LenList[ItemIndex]
 588
 589         return Offset
 590
 591     def GetListSize(self):
 592         if self.ListSize:
 593             return self.ListSize
 594
 595         if len(self.LenList) == 0:
 596             self.ListSize = 0
 597         else:
 598             self.ListSize = self.GetInterOffset(len(self.LenList) - 1) + self.LenList[len(self.LenList)-1]
 599
 600         return self.ListSize
 601
 602     def PackData(self):
 603         self.RawDataList = self.DataList
 604         return DbComItemList.PackData(self)
 605
 606
 607
 608 ##  Find the index in two list where the item matches the key separately
 609 #
 610 #   @param      Key1   The key used to search the List1
 611 #   @param      List1  The list that Key1 will be searched
 612 #   @param      Key2   The key used to search the List2
 613 #   @param      List2  The list that Key2 will be searched
 614 #
 615 #   @retval     Index  The position inside the list where list1[Index] == Key1 and list2[Index] == Key2
 616 #
 617 def GetMatchedIndex(Key1, List1, Key2, List2):
 618     StartPos = 0
 619     while StartPos < len(List1):
 620         Index = List1.index(Key1, StartPos)
 621         if List2[Index] == Key2:
 622             return Index
 623         else:
 624             StartPos = Index + 1
 625
 626     return -1
 627
 628
 629 ##  Get the integer value from string like "14U" or integer like 2
 630 #
 631 #   @param      Input   The object that may be either a integer value or a string
 632 #
 633 #   @retval     Value    The integer value that the input represents
 634 #
 635 def GetIntegerValue(Input):
 636     if type(Input) in (int, long):
 637         return Input
 638     String = Input
 639     if String.endswith("U"):
 640         String = String[:-1]
 641     if String.endswith("ULL"):
 642         String = String[:-3]
 643     if String.endswith("LL"):
 644         String = String[:-2]
 645
 646     if String.startswith("0x") or String.startswith("0X"):
 647         return int(String, 16)
 648     elif String == '':
 649         return 0
 650     else:
 651         return int(String)
 652
 653
 654 ## convert StringArray like {0x36, 0x00, 0x34, 0x00, 0x21, 0x00, 0x36, 0x00, 0x34, 0x00, 0x00, 0x00}
 655 # to List like [0x36, 0x00, 0x34, 0x00, 0x21, 0x00, 0x36, 0x00, 0x34, 0x00, 0x00, 0x00]
 656 #
 657 #   @param      StringArray A string array like {0x36, 0x00, 0x34, 0x00, 0x21, 0x00, 0x36, 0x00, 0x34, 0x00, 0x00, 0x00}
 658 #
 659 #   @retval                 A list object of integer items
 660 #
 661 def StringArrayToList(StringArray):
 662     StringArray = StringArray[1:-1]
 663     StringArray = '[' + StringArray + ']'
 664     return eval(StringArray)
 665
 666
 667 ## Convert TokenType String like  "PCD_DATUM_TYPE_UINT32 | PCD_TYPE_HII" to TokenType value
 668 #
 669 #   @param      TokenType  A TokenType string like "PCD_DATUM_TYPE_UINT32 | PCD_TYPE_HII"
 670 #
 671 #   @retval                A integer representation of the TokenType
 672 #
 673 def GetTokenTypeValue(TokenType):
 674     TokenTypeDict = {
 675         "PCD_TYPE_SHIFT":28,
 676         "PCD_TYPE_DATA":(0x0 << 28),
 677         "PCD_TYPE_HII":(0x8 << 28),
 678         "PCD_TYPE_VPD":(0x4 << 28),
 679         "PCD_TYPE_SKU_ENABLED":(0x2 << 28),
 680         "PCD_TYPE_STRING":(0x1 << 28),
 681
 682         "PCD_DATUM_TYPE_SHIFT":24,
 683         "PCD_DATUM_TYPE_POINTER":(0x0 << 24),
 684         "PCD_DATUM_TYPE_UINT8":(0x1 << 24),
 685         "PCD_DATUM_TYPE_UINT16":(0x2 << 24),
 686         "PCD_DATUM_TYPE_UINT32":(0x4 << 24),
 687         "PCD_DATUM_TYPE_UINT64":(0x8 << 24),
 688
 689         "PCD_DATUM_TYPE_SHIFT2":20,
 690         "PCD_DATUM_TYPE_UINT8_BOOLEAN":(0x1 << 20 | 0x1 << 24),
 691         }
 692     return eval(TokenType, TokenTypeDict)
 693
 694 ## construct the external Pcd database using data from Dict
 695 #
 696 #   @param      Dict  A dictionary contains Pcd related tables
 697 #
 698 #   @retval     Buffer A byte stream of the Pcd database
 699 #
 700 def BuildExDataBase(Dict):
 701     # init Db items
 702     InitValueUint64 = Dict['INIT_DB_VALUE_UINT64']
 703     DbInitValueUint64 = DbComItemList(8, RawDataList = InitValueUint64)
 704     VardefValueUint64 = Dict['VARDEF_DB_VALUE_UINT64']
 705     DbVardefValueUint64 = DbItemList(8, RawDataList = VardefValueUint64)
 706     InitValueUint32 = Dict['INIT_DB_VALUE_UINT32']
 707     DbInitValueUint32 = DbComItemList(4, RawDataList = InitValueUint32)
 708     VardefValueUint32 = Dict['VARDEF_DB_VALUE_UINT32']
 709     DbVardefValueUint32 = DbItemList(4, RawDataList = VardefValueUint32)
 710     VpdHeadValue = Dict['VPD_DB_VALUE']
 711     DbVpdHeadValue = DbComItemList(4, RawDataList = VpdHeadValue)
 712     ExMapTable = zip(Dict['EXMAPPING_TABLE_EXTOKEN'], Dict['EXMAPPING_TABLE_LOCAL_TOKEN'], Dict['EXMAPPING_TABLE_GUID_INDEX'])
 713     DbExMapTable = DbExMapTblItemList(8, RawDataList = ExMapTable)
 714     LocalTokenNumberTable = Dict['LOCAL_TOKEN_NUMBER_DB_VALUE']
 715     DbLocalTokenNumberTable = DbItemList(4, RawDataList = LocalTokenNumberTable)
 716     GuidTable = Dict['GUID_STRUCTURE']
 717     DbGuidTable = DbItemList(16, RawDataList = GuidTable)
 718     StringHeadValue = Dict['STRING_DB_VALUE']
 719     # DbItemList to DbStringHeadTableItemList
 720     DbStringHeadValue = DbStringHeadTableItemList(4, RawDataList = StringHeadValue)
 721     VariableTable = Dict['VARIABLE_DB_VALUE']
 722     DbVariableTable = DbVariableTableItemList(20, RawDataList = VariableTable)
 723     NumberOfSkuEnabledPcd = GetIntegerValue(Dict['SKU_HEAD_SIZE'])
 724     Dict['SKUHEAD_TABLE_VALUE'] = [(0,0) for i in xrange(NumberOfSkuEnabledPcd)]
 725     SkuTable = Dict['SKUHEAD_TABLE_VALUE']  # Generated later
 726     DbSkuTable = DbSkuHeadTableItemList(8, RawDataList = SkuTable)
 727     Dict['STRING_TABLE_DB_VALUE'] = [StringArrayToList(x) for x in Dict['STRING_TABLE_VALUE']]
 728
 729     StringTableValue = Dict['STRING_TABLE_DB_VALUE']
 730     # when calcute the offset, should use StringTableLen instead of StringTableValue, as string maxium len may be different with actual len
 731     StringTableLen = Dict['STRING_TABLE_LENGTH']
 732     DbStringTableLen = DbStringItemList(0, RawDataList = StringTableValue, LenList = StringTableLen)
 733
 734
 735     PcdTokenTable = Dict['PCD_TOKENSPACE']
 736     PcdTokenLen = Dict['PCD_TOKENSPACE_LENGTH']
 737     PcdTokenTableValue = [StringArrayToList(x) for x in Dict['PCD_TOKENSPACE']]
 738     DbPcdTokenTable = DbStringItemList(0, RawDataList = PcdTokenTableValue, LenList = PcdTokenLen)
 739
 740     PcdCNameTable = Dict['PCD_CNAME']
 741     PcdCNameLen = Dict['PCD_CNAME_LENGTH']
 742     PcdCNameTableValue = [StringArrayToList(x) for x in Dict['PCD_CNAME']]
 743     DbPcdCNameTable = DbStringItemList(0, RawDataList = PcdCNameTableValue, LenList = PcdCNameLen)
 744
 745     PcdNameOffsetTable = Dict['PCD_NAME_OFFSET']
 746     DbPcdNameOffsetTable = DbItemList(4,RawDataList = PcdNameOffsetTable)
 747
 748     SizeTableValue = zip(Dict['SIZE_TABLE_MAXIMUM_LENGTH'], Dict['SIZE_TABLE_CURRENT_LENGTH'])
 749     DbSizeTableValue = DbSizeTableItemList(2, RawDataList = SizeTableValue)
 750     InitValueUint16 = Dict['INIT_DB_VALUE_UINT16']
 751     DbInitValueUint16 = DbComItemList(2, RawDataList = InitValueUint16)
 752     VardefValueUint16 = Dict['VARDEF_DB_VALUE_UINT16']
 753     DbVardefValueUint16 = DbItemList(2, RawDataList = VardefValueUint16)
 754     InitValueUint8 = Dict['INIT_DB_VALUE_UINT8']
 755     DbInitValueUint8 = DbComItemList(1, RawDataList = InitValueUint8)
 756     VardefValueUint8 = Dict['VARDEF_DB_VALUE_UINT8']
 757     DbVardefValueUint8 = DbItemList(1, RawDataList = VardefValueUint8)
 758     InitValueBoolean = Dict['INIT_DB_VALUE_BOOLEAN']
 759     DbInitValueBoolean = DbComItemList(1, RawDataList = InitValueBoolean)
 760     VardefValueBoolean = Dict['VARDEF_DB_VALUE_BOOLEAN']
 761     DbVardefValueBoolean = DbItemList(1, RawDataList = VardefValueBoolean)
 762     SkuidValue = Dict['SKUID_VALUE']
 763     DbSkuidValue = DbItemList(1, RawDataList = SkuidValue)
 764     SkuIndexValue = Dict['SKU_INDEX_VALUE']
 765     DbSkuIndexValue = DbItemList(0,RawDataList = SkuIndexValue)
 766
 767     # Unit Db Items
 768     UnInitValueUint64 = Dict['UNINIT_GUID_DECL_UINT64']
 769     DbUnInitValueUint64 = DbItemList(8, RawDataList = UnInitValueUint64)
 770     UnInitValueUint32 = Dict['UNINIT_GUID_DECL_UINT32']
 771     DbUnInitValueUint32 = DbItemList(4, RawDataList = UnInitValueUint32)
 772     UnInitValueUint16 = Dict['UNINIT_GUID_DECL_UINT16']
 773     DbUnInitValueUint16 = DbItemList(2, RawDataList = UnInitValueUint16)
 774     UnInitValueUint8 = Dict['UNINIT_GUID_DECL_UINT8']
 775     DbUnInitValueUint8 = DbItemList(1, RawDataList = UnInitValueUint8)
 776     UnInitValueBoolean = Dict['UNINIT_GUID_DECL_BOOLEAN']
 777     DbUnInitValueBoolean = DbItemList(1, RawDataList = UnInitValueBoolean)
 778     PcdTokenNumberMap = Dict['PCD_ORDER_TOKEN_NUMBER_MAP']
 779
 780     DbNameTotle = ["InitValueUint64", "VardefValueUint64", "InitValueUint32", "VardefValueUint32", "VpdHeadValue", "ExMapTable",
 781                "LocalTokenNumberTable", "GuidTable", "StringHeadValue",  "PcdNameOffsetTable","VariableTable","SkuTable", "StringTableLen", "PcdTokenTable", "PcdCNameTable",
 782                "SizeTableValue", "InitValueUint16", "VardefValueUint16", "InitValueUint8", "VardefValueUint8", "InitValueBoolean",
 783                "VardefValueBoolean", "SkuidValue", "SkuIndexValue","UnInitValueUint64", "UnInitValueUint32", "UnInitValueUint16", "UnInitValueUint8", "UnInitValueBoolean"]
 784
 785     DbTotal = [InitValueUint64, VardefValueUint64, InitValueUint32, VardefValueUint32, VpdHeadValue, ExMapTable,
 786                LocalTokenNumberTable, GuidTable, StringHeadValue,  PcdNameOffsetTable,VariableTable,SkuTable, StringTableLen, PcdTokenTable,PcdCNameTable,
 787                SizeTableValue, InitValueUint16, VardefValueUint16,InitValueUint8, VardefValueUint8, InitValueBoolean,
 788                VardefValueBoolean, SkuidValue, SkuIndexValue, UnInitValueUint64, UnInitValueUint32, UnInitValueUint16, UnInitValueUint8, UnInitValueBoolean]
 789     DbItemTotal = [DbInitValueUint64, DbVardefValueUint64, DbInitValueUint32, DbVardefValueUint32, DbVpdHeadValue, DbExMapTable,
 790                DbLocalTokenNumberTable, DbGuidTable, DbStringHeadValue,  DbPcdNameOffsetTable,DbVariableTable,DbSkuTable, DbStringTableLen, DbPcdTokenTable, DbPcdCNameTable,
 791                DbSizeTableValue, DbInitValueUint16, DbVardefValueUint16,DbInitValueUint8, DbVardefValueUint8, DbInitValueBoolean,
 792                DbVardefValueBoolean, DbSkuidValue, DbSkuIndexValue, DbUnInitValueUint64, DbUnInitValueUint32, DbUnInitValueUint16, DbUnInitValueUint8, DbUnInitValueBoolean]
 793
 794     # SkuidValue is the last table in the init table items
 795     InitTableNum = DbTotal.index(SkuidValue) + 1 + 1 # +1 is for SkuIndexValue table
 796     # The FixedHeader length of the PCD_DATABASE_INIT, from Signature to Pad
 797     FixedHeaderLen = 64
 798
 799     # Get offset of SkuId table in the database
 800     SkuIdTableOffset = FixedHeaderLen
 801     for DbIndex in xrange(len(DbTotal)):
 802         if DbTotal[DbIndex] is SkuidValue:
 803             break
 804         SkuIdTableOffset += DbItemTotal[DbIndex].GetListSize()
 805
 806
 807     # Get offset of SkuValue table in the database
 808     SkuTableOffset = FixedHeaderLen
 809     for DbIndex in xrange(len(DbTotal)):
 810         if DbTotal[DbIndex] is SkuTable:
 811             break
 812         SkuTableOffset += DbItemTotal[DbIndex].GetListSize()
 813     PcdTokenTableDbOffset = FixedHeaderLen
 814     for DbIndex in xrange(len(DbTotal)):
 815         if DbTotal[DbIndex] is PcdTokenTable:
 816             break
 817         PcdTokenTableDbOffset += DbItemTotal[DbIndex].GetListSize()
 818
 819     PcdCNameTableDbOffset = FixedHeaderLen
 820     for DbIndex in xrange(len(DbTotal)):
 821         if DbTotal[DbIndex] is PcdCNameTable:
 822             break
 823         PcdCNameTableDbOffset += DbItemTotal[DbIndex].GetListSize()
 824     # Fix up the LocalTokenNumberTable, SkuHeader table
 825     SkuHeaderIndex = 0
 826     if len(Dict['SKU_INDEX_VALUE']) > 0:
 827         SkuIndexIndexTable = [(0) for i in xrange(len(Dict['SKU_INDEX_VALUE']))]
 828         SkuIndexIndexTable[0] = 0  #Dict['SKU_INDEX_VALUE'][0][0]
 829         for i in range(1,len(Dict['SKU_INDEX_VALUE'])):
 830             SkuIndexIndexTable[i] = SkuIndexIndexTable[i-1]+Dict['SKU_INDEX_VALUE'][i-1][0] + 1
 831     for (LocalTokenNumberTableIndex, (Offset, Table)) in enumerate(LocalTokenNumberTable):
 832         DbIndex = 0
 833         DbOffset = FixedHeaderLen
 834         for DbIndex in xrange(len(DbTotal)):
 835             if DbTotal[DbIndex] is Table:
 836                 DbOffset += DbItemTotal[DbIndex].GetInterOffset(Offset)
 837                 break
 838             DbOffset += DbItemTotal[DbIndex].GetListSize()
 839         else:
 840             assert(False)
 841
 842         TokenTypeValue = Dict['TOKEN_TYPE'][LocalTokenNumberTableIndex]
 843         TokenTypeValue = GetTokenTypeValue(TokenTypeValue)
 844         LocalTokenNumberTable[LocalTokenNumberTableIndex] = DbOffset|int(TokenTypeValue)
 845         # if PCD_TYPE_SKU_ENABLED, then we need to fix up the SkuTable
 846
 847         SkuIndexTabalOffset = SkuIdTableOffset + Dict['SKUID_VALUE'][0] + 1
 848         if (TokenTypeValue & (0x2 << 28)):
 849             SkuTable[SkuHeaderIndex] = (DbOffset|int(TokenTypeValue & ~(0x2<<28)), SkuIndexTabalOffset + SkuIndexIndexTable[PcdTokenNumberMap[LocalTokenNumberTableIndex]])
 850             LocalTokenNumberTable[LocalTokenNumberTableIndex] = (SkuTableOffset + SkuHeaderIndex * 8) | int(TokenTypeValue)
 851             SkuHeaderIndex += 1
 852
 853
 854     if SkuHeaderIndex == 0:
 855         SkuHeaderIndex = 1
 856     assert(SkuHeaderIndex == NumberOfSkuEnabledPcd)
 857
 858     # resolve variable table offset
 859     for VariableEntries in VariableTable:
 860         skuindex = 0
 861         for VariableEntryPerSku in VariableEntries:
 862             (VariableHeadGuidIndex, VariableHeadStringIndex, SKUVariableOffset, VariableOffset, VariableRefTable, VariableAttribute) = VariableEntryPerSku[:]
 863             DbIndex = 0
 864             DbOffset = FixedHeaderLen
 865             for DbIndex in xrange(len(DbTotal)):
 866                 if DbTotal[DbIndex] is VariableRefTable:
 867                     DbOffset += DbItemTotal[DbIndex].GetInterOffset(VariableOffset)
 868                     break
 869                 DbOffset += DbItemTotal[DbIndex].GetListSize()
 870             else:
 871                 assert(False)
 872             if isinstance(VariableRefTable[0],list):
 873                 DbOffset += skuindex * 4
 874             skuindex += 1
 875             if DbIndex >= InitTableNum:
 876                 assert(False)
 877             VarAttr, VarProp = VariableAttributes.GetVarAttributes(VariableAttribute)
 878             VariableEntryPerSku[:] = (VariableHeadStringIndex, DbOffset, VariableHeadGuidIndex, SKUVariableOffset, VarAttr, VarProp)
 879
 880     # calculate various table offset now
 881     DbTotalLength = FixedHeaderLen
 882     for DbIndex in xrange(len(DbItemTotal)):
 883         if DbItemTotal[DbIndex] is DbLocalTokenNumberTable:
 884             LocalTokenNumberTableOffset = DbTotalLength
 885         elif DbItemTotal[DbIndex] is DbExMapTable:
 886             ExMapTableOffset = DbTotalLength
 887         elif DbItemTotal[DbIndex] is DbGuidTable:
 888             GuidTableOffset = DbTotalLength
 889         elif DbItemTotal[DbIndex] is DbStringTableLen:
 890             StringTableOffset = DbTotalLength
 891         elif DbItemTotal[DbIndex] is DbSizeTableValue:
 892             SizeTableOffset = DbTotalLength
 893         elif DbItemTotal[DbIndex] is DbSkuidValue:
 894             SkuIdTableOffset = DbTotalLength
 895         elif DbItemTotal[DbIndex] is DbPcdNameOffsetTable:
 896             DbPcdNameOffset = DbTotalLength
 897
 898         DbTotalLength += DbItemTotal[DbIndex].GetListSize()
 899     if not Dict['PCD_INFO_FLAG']:
 900         DbPcdNameOffset  = 0
 901     LocalTokenCount = GetIntegerValue(Dict['LOCAL_TOKEN_NUMBER'])
 902     ExTokenCount = GetIntegerValue(Dict['EX_TOKEN_NUMBER'])
 903     GuidTableCount = GetIntegerValue(Dict['GUID_TABLE_SIZE'])
 904     SystemSkuId = GetIntegerValue(Dict['SYSTEM_SKU_ID_VALUE'])
 905     Pad = 0xDA
 906
 907     UninitDataBaseSize  = 0
 908     for Item in (DbUnInitValueUint64, DbUnInitValueUint32, DbUnInitValueUint16, DbUnInitValueUint8, DbUnInitValueBoolean):
 909         UninitDataBaseSize += Item.GetListSize()
 910
 911     # Construct the database buffer
 912     Guid = "{0x3c7d193c, 0x682c, 0x4c14, 0xa6, 0x8f, 0x55, 0x2d, 0xea, 0x4f, 0x43, 0x7e}"
 913     Guid = StringArrayToList(Guid)
 914     Buffer = pack('=LHHBBBBBBBB',
 915                 Guid[0],
 916                 Guid[1],
 917                 Guid[2],
 918                 Guid[3],
 919                 Guid[4],
 920                 Guid[5],
 921                 Guid[6],
 922                 Guid[7],
 923                 Guid[8],
 924                 Guid[9],
 925                 Guid[10],
 926                 )
 927
 928     b = pack("=L", DATABASE_VERSION)
 929     Buffer += b
 930
 931     b = pack('=L', DbTotalLength - UninitDataBaseSize)
 932
 933     Buffer += b
 934     b = pack('=L', UninitDataBaseSize)
 935
 936     Buffer += b
 937     b = pack('=L', LocalTokenNumberTableOffset)
 938
 939     Buffer += b
 940     b = pack('=L', ExMapTableOffset)
 941
 942     Buffer += b
 943     b = pack('=L', GuidTableOffset)
 944
 945     Buffer += b
 946     b = pack('=L', StringTableOffset)
 947
 948     Buffer += b
 949     b = pack('=L', SizeTableOffset)
 950
 951     Buffer += b
 952     b = pack('=L', SkuIdTableOffset)
 953
 954     Buffer += b
 955     b = pack('=L', DbPcdNameOffset)
 956
 957     Buffer += b
 958     b = pack('=H', LocalTokenCount)
 959
 960     Buffer += b
 961     b = pack('=H', ExTokenCount)
 962
 963     Buffer += b
 964     b = pack('=H', GuidTableCount)
 965
 966     Buffer += b
 967     b = pack('=B', SystemSkuId)
 968
 969     Buffer += b
 970     b = pack('=B', Pad)
 971
 972     Buffer += b
 973
 974     Index = 0
 975     for Item in DbItemTotal:
 976         Index +=1
 977         b = Item.PackData()
 978         Buffer += b
 979         if Index == InitTableNum:
 980             break
 981     return Buffer
 982
 983 ## Create code for PCD database
 984 #
 985 #   @param      Info        The ModuleAutoGen object
 986 #   @param      AutoGenC    The TemplateString object for C code
 987 #   @param      AutoGenH    The TemplateString object for header file
 988 #
 989 def CreatePcdDatabaseCode (Info, AutoGenC, AutoGenH):
 990     if Info.PcdIsDriver == "":
 991         return
 992     if Info.PcdIsDriver not in gPcdPhaseMap:
 993         EdkLogger.error("build", AUTOGEN_ERROR, "Not supported PcdIsDriver type:%s" % Info.PcdIsDriver,
 994                         ExtraData="[%s]" % str(Info))
 995
 996     AdditionalAutoGenH, AdditionalAutoGenC, PcdDbBuffer = CreatePcdDatabasePhaseSpecificAutoGen (Info.PlatformInfo, 'PEI')
 997     AutoGenH.Append(AdditionalAutoGenH.String)
 998
 999     Phase = gPcdPhaseMap[Info.PcdIsDriver]
1000     if Phase == 'PEI':
1001         AutoGenC.Append(AdditionalAutoGenC.String)
1002
1003     if Phase == 'DXE':
1004         AdditionalAutoGenH, AdditionalAutoGenC, PcdDbBuffer = CreatePcdDatabasePhaseSpecificAutoGen (Info.PlatformInfo, Phase)
1005         AutoGenH.Append(AdditionalAutoGenH.String)
1006         AutoGenC.Append(AdditionalAutoGenC.String)
1007
1008     if Info.IsBinaryModule:
1009         DbFileName = os.path.join(Info.PlatformInfo.BuildDir, "FV", Phase + "PcdDataBase.raw")
1010     else:
1011         DbFileName = os.path.join(Info.OutputDir, Phase + "PcdDataBase.raw")
1012     DbFile = StringIO()
1013     DbFile.write(PcdDbBuffer)
1014     Changed = SaveFileOnChange(DbFileName, DbFile.getvalue(), True)
1015
1016 ## Create PCD database in DXE or PEI phase
1017 #
1018 #   @param      Platform    The platform object
1019 #   @retval     tuple       Two TemplateString objects for C code and header file,
1020 #                           respectively
1021 #
1022 def CreatePcdDatabasePhaseSpecificAutoGen (Platform, Phase):
1023     AutoGenC = TemplateString()
1024     AutoGenH = TemplateString()
1025
1026     Dict = {
1027         'PHASE'                         : Phase,
1028         'SERVICE_DRIVER_VERSION'        : DATABASE_VERSION,
1029         'GUID_TABLE_SIZE'               : '1U',
1030         'STRING_TABLE_SIZE'             : '1U',
1031         'SKUID_TABLE_SIZE'              : '1U',
1032         'LOCAL_TOKEN_NUMBER_TABLE_SIZE' : '0U',
1033         'LOCAL_TOKEN_NUMBER'            : '0U',
1034         'EXMAPPING_TABLE_SIZE'          : '1U',
1035         'EX_TOKEN_NUMBER'               : '0U',
1036         'SIZE_TABLE_SIZE'               : '2U',
1037         'SKU_HEAD_SIZE'                 : '1U',
1038         'GUID_TABLE_EMPTY'              : 'TRUE',
1039         'STRING_TABLE_EMPTY'            : 'TRUE',
1040         'SKUID_TABLE_EMPTY'             : 'TRUE',
1041         'DATABASE_EMPTY'                : 'TRUE',
1042         'EXMAP_TABLE_EMPTY'             : 'TRUE',
1043         'PCD_DATABASE_UNINIT_EMPTY'     : '  UINT8  dummy; /* PCD_DATABASE_UNINIT is emptry */',
1044         'SYSTEM_SKU_ID'                 : '  SKU_ID             SystemSkuId;',
1045         'SYSTEM_SKU_ID_VALUE'           : '0U'
1046     }
1047
1048
1049     SkuObj = SkuClass(Platform.Platform.SkuName,Platform.Platform.SkuIds)
1050     Dict['SYSTEM_SKU_ID_VALUE'] = Platform.Platform.SkuIds[SkuObj.SystemSkuId]
1051
1052     Dict['PCD_INFO_FLAG'] = Platform.Platform.PcdInfoFlag
1053
1054     for DatumType in ['UINT64','UINT32','UINT16','UINT8','BOOLEAN', "VOID*"]:
1055         Dict['VARDEF_CNAME_' + DatumType] = []
1056         Dict['VARDEF_GUID_' + DatumType]  = []
1057         Dict['VARDEF_SKUID_' + DatumType] = []
1058         Dict['VARDEF_VALUE_' + DatumType] = []
1059         Dict['VARDEF_DB_VALUE_' + DatumType] = []
1060         for Init in ['INIT','UNINIT']:
1061             Dict[Init+'_CNAME_DECL_' + DatumType]   = []
1062             Dict[Init+'_GUID_DECL_' + DatumType]    = []
1063             Dict[Init+'_NUMSKUS_DECL_' + DatumType] = []
1064             Dict[Init+'_VALUE_' + DatumType]        = []
1065             Dict[Init+'_DB_VALUE_'+DatumType] = []
1066
1067     for Type in ['STRING_HEAD','VPD_HEAD','VARIABLE_HEAD']:
1068         Dict[Type + '_CNAME_DECL']   = []
1069         Dict[Type + '_GUID_DECL']    = []
1070         Dict[Type + '_NUMSKUS_DECL'] = []
1071         Dict[Type + '_VALUE'] = []
1072
1073     Dict['STRING_DB_VALUE'] = []
1074     Dict['VPD_DB_VALUE'] = []
1075     Dict['VARIABLE_DB_VALUE'] = []
1076
1077     Dict['STRING_TABLE_INDEX'] = []
1078     Dict['STRING_TABLE_LENGTH']  = []
1079     Dict['STRING_TABLE_CNAME'] = []
1080     Dict['STRING_TABLE_GUID']  = []
1081     Dict['STRING_TABLE_VALUE'] = []
1082     Dict['STRING_TABLE_DB_VALUE'] = []
1083
1084     Dict['SIZE_TABLE_CNAME'] = []
1085     Dict['SIZE_TABLE_GUID']  = []
1086     Dict['SIZE_TABLE_CURRENT_LENGTH']  = []
1087     Dict['SIZE_TABLE_MAXIMUM_LENGTH']  = []
1088
1089     Dict['EXMAPPING_TABLE_EXTOKEN'] = []
1090     Dict['EXMAPPING_TABLE_LOCAL_TOKEN'] = []
1091     Dict['EXMAPPING_TABLE_GUID_INDEX'] = []
1092
1093     Dict['GUID_STRUCTURE'] = []
1094     Dict['SKUID_VALUE'] = [0] # init Dict length
1095     Dict['VARDEF_HEADER'] = []
1096
1097     Dict['LOCAL_TOKEN_NUMBER_DB_VALUE'] = []
1098     Dict['VARIABLE_DB_VALUE'] = []
1099     Dict['SKUHEAD_TABLE_VALUE'] = []
1100     Dict['SKU_INDEX_VALUE'] = []
1101
1102     Dict['PCD_TOKENSPACE'] = []
1103     Dict['PCD_CNAME'] = []
1104     Dict['PCD_TOKENSPACE_LENGTH'] = []
1105     Dict['PCD_CNAME_LENGTH'] = []
1106     Dict['PCD_TOKENSPACE_OFFSET'] = []
1107     Dict['PCD_CNAME_OFFSET'] = []
1108     Dict['PCD_TOKENSPACE_MAP'] = []
1109     Dict['PCD_NAME_OFFSET'] = []
1110
1111     Dict['PCD_ORDER_TOKEN_NUMBER_MAP'] = {}
1112     PCD_STRING_INDEX_MAP = {}
1113
1114     StringTableIndex = 0
1115     StringTableSize = 0
1116     NumberOfLocalTokens = 0
1117     NumberOfPeiLocalTokens = 0
1118     NumberOfDxeLocalTokens = 0
1119     NumberOfExTokens = 0
1120     NumberOfSizeItems = 0
1121     NumberOfSkuEnabledPcd = 0
1122     GuidList = []
1123     VarCheckTab = VAR_CHECK_PCD_VARIABLE_TAB_CONTAINER()
1124     i = 0
1125     ReorderedDynPcdList = GetOrderedDynamicPcdList(Platform.DynamicPcdList, Platform.PcdTokenNumber)
1126     for Pcd in ReorderedDynPcdList:
1127         VoidStarTypeCurrSize = []
1128         i += 1
1129         CName = Pcd.TokenCName
1130         TokenSpaceGuidCName = Pcd.TokenSpaceGuidCName
1131
1132         EdkLogger.debug(EdkLogger.DEBUG_3, "PCD: %s %s (%s : %s)" % (CName, TokenSpaceGuidCName, Pcd.Phase, Phase))
1133
1134         if Pcd.Phase == 'PEI':
1135             NumberOfPeiLocalTokens += 1
1136         if Pcd.Phase == 'DXE':
1137             NumberOfDxeLocalTokens += 1
1138         if Pcd.Phase != Phase:
1139             continue
1140
1141         #
1142         # TODO: need GetGuidValue() definition
1143         #
1144         TokenSpaceGuidStructure = Pcd.TokenSpaceGuidValue
1145         TokenSpaceGuid = GuidStructureStringToGuidValueName(TokenSpaceGuidStructure)
1146         if Pcd.Type in gDynamicExPcd:
1147             if TokenSpaceGuid not in GuidList:
1148                 GuidList += [TokenSpaceGuid]
1149                 Dict['GUID_STRUCTURE'].append(TokenSpaceGuidStructure)
1150             NumberOfExTokens += 1
1151
1152         ValueList = []
1153         DbValueList = []
1154         StringHeadOffsetList = []
1155         StringDbOffsetList = []
1156         VpdHeadOffsetList = []
1157         VpdDbOffsetList = []
1158         VariableHeadValueList = []
1159         VariableDbValueList = []
1160         Pcd.InitString = 'UNINIT'
1161
1162         if Pcd.DatumType == 'VOID*':
1163             if Pcd.Type not in ["DynamicVpd", "DynamicExVpd"]:
1164                 Pcd.TokenTypeList = ['PCD_TYPE_STRING']
1165             else:
1166                 Pcd.TokenTypeList = []
1167         elif Pcd.DatumType == 'BOOLEAN':
1168             Pcd.TokenTypeList = ['PCD_DATUM_TYPE_UINT8_BOOLEAN']
1169         else:
1170             Pcd.TokenTypeList = ['PCD_DATUM_TYPE_' + Pcd.DatumType]
1171
1172         if len(Pcd.SkuInfoList) > 1:
1173             Pcd.TokenTypeList += ['PCD_TYPE_SKU_ENABLED']
1174             NumberOfSkuEnabledPcd += 1
1175
1176         SkuIndexTableTmp = []
1177         SkuIndexTableTmp.append(0)
1178         SkuIdIndex = 1
1179         VariableHeadList = []
1180         for SkuName in Pcd.SkuInfoList:
1181             Sku = Pcd.SkuInfoList[SkuName]
1182             SkuId = Sku.SkuId
1183             if SkuId == None or SkuId == '':
1184                 continue
1185
1186             if (SkuId + 'U') not in Dict['SKUID_VALUE']:
1187                 Dict['SKUID_VALUE'].append(SkuId + 'U')
1188
1189             SkuIndexTableTmp.append(SkuId+'U')
1190             SkuIdIndex += 1
1191
1192             if len(Sku.VariableName) > 0:
1193                 VariableGuidStructure = Sku.VariableGuidValue
1194                 VariableGuid = GuidStructureStringToGuidValueName(VariableGuidStructure)
1195                 if Platform.Platform.VarCheckFlag:
1196                     var_check_obj = VAR_CHECK_PCD_VARIABLE_TAB(VariableGuidStructure, StringToArray(Sku.VariableName))
1197                     try:
1198                         var_check_obj.push_back(VAR_VALID_OBJECT_FACTORY.Get_valid_object(Pcd, Sku.VariableOffset))
1199                         VarAttr, _ = VariableAttributes.GetVarAttributes(Sku.VariableAttribute)
1200                         var_check_obj.SetAttributes(VarAttr)
1201                         var_check_obj.UpdateSize()
1202                         VarCheckTab.push_back(var_check_obj)
1203                     except Exception:
1204                         ValidInfo = ''
1205                         if Pcd.validateranges:
1206                             ValidInfo = Pcd.validateranges[0]
1207                         if Pcd.validlists:
1208                             ValidInfo = Pcd.validlists[0]
1209                         if ValidInfo:
1210                             EdkLogger.error("build", PCD_VALIDATION_INFO_ERROR,
1211                                                 "The PCD '%s.%s' Validation information defined in DEC file has incorrect format." % (Pcd.TokenSpaceGuidCName, Pcd.TokenCName),
1212                                                 ExtraData = "[%s]" % str(ValidInfo))
1213                         else:
1214                             EdkLogger.error("build", PCD_VALIDATION_INFO_ERROR,
1215                                                 "The PCD '%s.%s' Validation information defined in DEC file has incorrect format." % (Pcd.TokenSpaceGuidCName, Pcd.TokenCName))
1216                 Pcd.TokenTypeList += ['PCD_TYPE_HII']
1217                 Pcd.InitString = 'INIT'
1218                 # Store all variable names of one HII PCD under different SKU to stringTable
1219                 # and calculate the VariableHeadStringIndex
1220                 if SkuIdIndex - 2 == 0:
1221                     for SkuName2 in Pcd.SkuInfoList:
1222                         SkuInfo = Pcd.SkuInfoList[SkuName2]
1223                         if SkuInfo.SkuId == None or SkuInfo.SkuId == '':
1224                             continue
1225                         VariableNameStructure = StringToArray(SkuInfo.VariableName)
1226                         if VariableNameStructure not in Dict['STRING_TABLE_VALUE']:
1227                             Dict['STRING_TABLE_CNAME'].append(CName)
1228                             Dict['STRING_TABLE_GUID'].append(TokenSpaceGuid)
1229                             if StringTableIndex == 0:
1230                                 Dict['STRING_TABLE_INDEX'].append('')
1231                             else:
1232                                 Dict['STRING_TABLE_INDEX'].append('_%d' % StringTableIndex)
1233                             VarNameSize = len(VariableNameStructure.replace(',',' ').split())
1234                             Dict['STRING_TABLE_LENGTH'].append(VarNameSize )
1235                             Dict['STRING_TABLE_VALUE'].append(VariableNameStructure)
1236                             StringHeadOffsetList.append(str(StringTableSize) + 'U')
1237                             VarStringDbOffsetList = []
1238                             VarStringDbOffsetList.append(StringTableSize)
1239                             Dict['STRING_DB_VALUE'].append(VarStringDbOffsetList)
1240                             StringTableIndex += 1
1241                             StringTableSize += len(VariableNameStructure.replace(',',' ').split())
1242                         VariableHeadStringIndex = 0
1243                         for Index in range(Dict['STRING_TABLE_VALUE'].index(VariableNameStructure)):
1244                             VariableHeadStringIndex += Dict['STRING_TABLE_LENGTH'][Index]
1245                         VariableHeadList.append(VariableHeadStringIndex)
1246
1247                 VariableHeadStringIndex = VariableHeadList[SkuIdIndex - 2]
1248                 # store VariableGuid to GuidTable and get the VariableHeadGuidIndex
1249
1250                 if VariableGuid not in GuidList:
1251                     GuidList += [VariableGuid]
1252                     Dict['GUID_STRUCTURE'].append(VariableGuidStructure)
1253                 VariableHeadGuidIndex = GuidList.index(VariableGuid)
1254
1255                 if "PCD_TYPE_STRING" in Pcd.TokenTypeList:
1256                     VariableHeadValueList.append('%dU, offsetof(%s_PCD_DATABASE, Init.%s_%s), %dU, %sU' %
1257                                                  (VariableHeadStringIndex, Phase, CName, TokenSpaceGuid,
1258                                                  VariableHeadGuidIndex, Sku.VariableOffset))
1259                 else:
1260                     VariableHeadValueList.append('%dU, offsetof(%s_PCD_DATABASE, Init.%s_%s_VariableDefault_%s), %dU, %sU' %
1261                                                  (VariableHeadStringIndex, Phase, CName, TokenSpaceGuid, SkuIdIndex,
1262                                                  VariableHeadGuidIndex, Sku.VariableOffset))
1263                 Dict['VARDEF_CNAME_'+Pcd.DatumType].append(CName)
1264                 Dict['VARDEF_GUID_'+Pcd.DatumType].append(TokenSpaceGuid)
1265                 Dict['VARDEF_SKUID_'+Pcd.DatumType].append(SkuIdIndex)
1266                 if "PCD_TYPE_STRING" in  Pcd.TokenTypeList:
1267                     Dict['VARDEF_VALUE_' + Pcd.DatumType].append("%s_%s[%d]" % (Pcd.TokenCName, TokenSpaceGuid, SkuIdIndex))
1268                 else:
1269                     #
1270                     # ULL (for UINT64) or U(other integer type) should be append to avoid
1271                     # warning under linux building environment.
1272                     #
1273                     Dict['VARDEF_DB_VALUE_'+Pcd.DatumType].append(Sku.HiiDefaultValue)
1274
1275                     if Pcd.DatumType == "UINT64":
1276                         Dict['VARDEF_VALUE_'+Pcd.DatumType].append(Sku.HiiDefaultValue + "ULL")
1277                     elif Pcd.DatumType in ("UINT32", "UINT16", "UINT8"):
1278                         Dict['VARDEF_VALUE_'+Pcd.DatumType].append(Sku.HiiDefaultValue + "U")
1279                     elif Pcd.DatumType == "BOOLEAN":
1280                         if eval(Sku.HiiDefaultValue) in [1,0]:
1281                             Dict['VARDEF_VALUE_'+Pcd.DatumType].append(str(eval(Sku.HiiDefaultValue)) + "U")
1282                     else:
1283                         Dict['VARDEF_VALUE_'+Pcd.DatumType].append(Sku.HiiDefaultValue)
1284
1285                 # construct the VariableHeader value
1286                 if "PCD_TYPE_STRING" in Pcd.TokenTypeList:
1287                     VariableHeadValueList.append('%dU, %dU, %sU, offsetof(%s_PCD_DATABASE, Init.%s_%s)' %
1288                                                  (VariableHeadGuidIndex, VariableHeadStringIndex, Sku.VariableOffset,
1289                                                   Phase, CName, TokenSpaceGuid))
1290                     # the Pcd default value will be filled later on
1291                     VariableOffset = len(Dict['STRING_DB_VALUE'])
1292                     VariableRefTable = Dict['STRING_DB_VALUE']
1293                 else:
1294                     VariableHeadValueList.append('%dU, %dU, %sU, offsetof(%s_PCD_DATABASE, Init.%s_%s_VariableDefault_%s)' %
1295                                                  (VariableHeadGuidIndex, VariableHeadStringIndex, Sku.VariableOffset,
1296                                                   Phase, CName, TokenSpaceGuid, SkuIdIndex))
1297                     # the Pcd default value was filled before
1298                     VariableOffset = len(Dict['VARDEF_DB_VALUE_' + Pcd.DatumType]) - 1
1299                     VariableRefTable = Dict['VARDEF_DB_VALUE_' + Pcd.DatumType]
1300                 VariableDbValueList.append([VariableHeadGuidIndex, VariableHeadStringIndex, Sku.VariableOffset, VariableOffset, VariableRefTable, Sku.VariableAttribute])
1301
1302             elif Sku.VpdOffset != '':
1303                 Pcd.TokenTypeList += ['PCD_TYPE_VPD']
1304                 Pcd.InitString = 'INIT'
1305                 VpdHeadOffsetList.append(str(Sku.VpdOffset) + 'U')
1306                 VpdDbOffsetList.append(Sku.VpdOffset)
1307                 # Also add the VOID* string of VPD PCD to SizeTable
1308                 if Pcd.DatumType == 'VOID*':
1309                     NumberOfSizeItems += 1
1310                     # For VPD type of PCD, its current size is equal to its MAX size.
1311                     VoidStarTypeCurrSize = [str(Pcd.MaxDatumSize) + 'U']
1312                 continue
1313
1314             if Pcd.DatumType == 'VOID*':
1315                 Pcd.TokenTypeList += ['PCD_TYPE_STRING']
1316                 Pcd.InitString = 'INIT'
1317                 if Sku.HiiDefaultValue != '' and Sku.DefaultValue == '':
1318                     Sku.DefaultValue = Sku.HiiDefaultValue
1319                 if Sku.DefaultValue != '':
1320                     NumberOfSizeItems += 1
1321                     Dict['STRING_TABLE_CNAME'].append(CName)
1322                     Dict['STRING_TABLE_GUID'].append(TokenSpaceGuid)
1323
1324                     if StringTableIndex == 0:
1325                         Dict['STRING_TABLE_INDEX'].append('')
1326                     else:
1327                         Dict['STRING_TABLE_INDEX'].append('_%d' % StringTableIndex)
1328                     if Sku.DefaultValue[0] == 'L':
1329                         DefaultValueBinStructure = StringToArray(Sku.DefaultValue)
1330                         Size = len(DefaultValueBinStructure.replace(',',' ').split())
1331                         Dict['STRING_TABLE_VALUE'].append(DefaultValueBinStructure)
1332                     elif Sku.DefaultValue[0] == '"':
1333                         DefaultValueBinStructure = StringToArray(Sku.DefaultValue)
1334                         Size = len(Sku.DefaultValue) -2 + 1
1335                         Dict['STRING_TABLE_VALUE'].append(DefaultValueBinStructure)
1336                     elif Sku.DefaultValue[0] == '{':
1337                         DefaultValueBinStructure = StringToArray(Sku.DefaultValue)
1338                         Size = len(Sku.DefaultValue.split(","))
1339                         Dict['STRING_TABLE_VALUE'].append(DefaultValueBinStructure)
1340
1341                     StringHeadOffsetList.append(str(StringTableSize) + 'U')
1342                     StringDbOffsetList.append(StringTableSize)
1343                     if Pcd.MaxDatumSize != '':
1344                         MaxDatumSize = int(Pcd.MaxDatumSize, 0)
1345                         if MaxDatumSize < Size:
1346                             EdkLogger.error("build", AUTOGEN_ERROR,
1347                                             "The maximum size of VOID* type PCD '%s.%s' is less than its actual size occupied." % (Pcd.TokenSpaceGuidCName, Pcd.TokenCName),
1348                                             ExtraData="[%s]" % str(Platform))
1349                     else:
1350                         MaxDatumSize = Size
1351                     StringTabLen = MaxDatumSize
1352                     if StringTabLen % 2:
1353                         StringTabLen += 1
1354                     if Sku.VpdOffset == '':
1355                         VoidStarTypeCurrSize.append(str(Size) + 'U')
1356                     Dict['STRING_TABLE_LENGTH'].append(StringTabLen)
1357                     StringTableIndex += 1
1358                     StringTableSize += (StringTabLen)
1359             else:
1360                 if "PCD_TYPE_HII" not in Pcd.TokenTypeList:
1361                     Pcd.TokenTypeList += ['PCD_TYPE_DATA']
1362                     if Sku.DefaultValue == 'TRUE':
1363                         Pcd.InitString = 'INIT'
1364                     else:
1365                         if int(Sku.DefaultValue, 0) != 0:
1366                             Pcd.InitString = 'INIT'
1367                 #
1368                 # For UNIT64 type PCD's value, ULL should be append to avoid
1369                 # warning under linux building environment.
1370                 #
1371                 if Pcd.DatumType == "UINT64":
1372                     ValueList.append(Sku.DefaultValue + "ULL")
1373                 elif Pcd.DatumType in ("UINT32", "UINT16", "UINT8"):
1374                     ValueList.append(Sku.DefaultValue + "U")
1375                 elif Pcd.DatumType == "BOOLEAN":
1376                     if Sku.DefaultValue in ["1", "0"]:
1377                         ValueList.append(Sku.DefaultValue + "U")
1378                 else:
1379                     ValueList.append(Sku.DefaultValue)
1380
1381                 DbValueList.append(Sku.DefaultValue)
1382
1383         Pcd.TokenTypeList = list(set(Pcd.TokenTypeList))
1384         if Pcd.DatumType == 'VOID*':
1385             Dict['SIZE_TABLE_CNAME'].append(CName)
1386             Dict['SIZE_TABLE_GUID'].append(TokenSpaceGuid)
1387             Dict['SIZE_TABLE_MAXIMUM_LENGTH'].append(str(Pcd.MaxDatumSize) + 'U')
1388             Dict['SIZE_TABLE_CURRENT_LENGTH'].append(VoidStarTypeCurrSize)
1389
1390
1391         SkuIndexTableTmp[0] = len(SkuIndexTableTmp) - 1
1392         if len(Pcd.SkuInfoList) > 1:
1393             Dict['SKU_INDEX_VALUE'].append(SkuIndexTableTmp)
1394
1395         if 'PCD_TYPE_HII' in Pcd.TokenTypeList:
1396             Dict['VARIABLE_HEAD_CNAME_DECL'].append(CName)
1397             Dict['VARIABLE_HEAD_GUID_DECL'].append(TokenSpaceGuid)
1398             Dict['VARIABLE_HEAD_NUMSKUS_DECL'].append(len(Pcd.SkuInfoList))
1399             Dict['VARIABLE_HEAD_VALUE'].append('{ %s }\n' % ' },\n    { '.join(VariableHeadValueList))
1400             Dict['VARDEF_HEADER'].append('_Variable_Header')
1401             Dict['VARIABLE_DB_VALUE'].append(VariableDbValueList)
1402         else:
1403             Dict['VARDEF_HEADER'].append('')
1404         if 'PCD_TYPE_VPD' in Pcd.TokenTypeList:
1405             Dict['VPD_HEAD_CNAME_DECL'].append(CName)
1406             Dict['VPD_HEAD_GUID_DECL'].append(TokenSpaceGuid)
1407             Dict['VPD_HEAD_NUMSKUS_DECL'].append(len(Pcd.SkuInfoList))
1408             Dict['VPD_HEAD_VALUE'].append('{ %s }' % ' }, { '.join(VpdHeadOffsetList))
1409             Dict['VPD_DB_VALUE'].append(VpdDbOffsetList)
1410         if 'PCD_TYPE_STRING' in Pcd.TokenTypeList:
1411             Dict['STRING_HEAD_CNAME_DECL'].append(CName)
1412             Dict['STRING_HEAD_GUID_DECL'].append(TokenSpaceGuid)
1413             Dict['STRING_HEAD_NUMSKUS_DECL'].append(len(Pcd.SkuInfoList))
1414             Dict['STRING_HEAD_VALUE'].append(', '.join(StringHeadOffsetList))
1415             Dict['STRING_DB_VALUE'].append(StringDbOffsetList)
1416             PCD_STRING_INDEX_MAP[len(Dict['STRING_HEAD_CNAME_DECL']) -1 ] = len(Dict['STRING_DB_VALUE']) -1
1417         if 'PCD_TYPE_DATA' in Pcd.TokenTypeList:
1418             Dict[Pcd.InitString+'_CNAME_DECL_'+Pcd.DatumType].append(CName)
1419             Dict[Pcd.InitString+'_GUID_DECL_'+Pcd.DatumType].append(TokenSpaceGuid)
1420             Dict[Pcd.InitString+'_NUMSKUS_DECL_'+Pcd.DatumType].append(len(Pcd.SkuInfoList))
1421             if Pcd.InitString == 'UNINIT':
1422                 Dict['PCD_DATABASE_UNINIT_EMPTY'] = ''
1423             else:
1424                 Dict[Pcd.InitString+'_VALUE_'+Pcd.DatumType].append(', '.join(ValueList))
1425                 Dict[Pcd.InitString+'_DB_VALUE_'+Pcd.DatumType].append(DbValueList)
1426
1427     if Phase == 'PEI':
1428         NumberOfLocalTokens = NumberOfPeiLocalTokens
1429     if Phase == 'DXE':
1430         NumberOfLocalTokens = NumberOfDxeLocalTokens
1431
1432     Dict['TOKEN_INIT']       = ['' for x in range(NumberOfLocalTokens)]
1433     Dict['TOKEN_CNAME']      = ['' for x in range(NumberOfLocalTokens)]
1434     Dict['TOKEN_GUID']       = ['' for x in range(NumberOfLocalTokens)]
1435     Dict['TOKEN_TYPE']       = ['' for x in range(NumberOfLocalTokens)]
1436     Dict['LOCAL_TOKEN_NUMBER_DB_VALUE'] = ['' for x in range(NumberOfLocalTokens)]
1437     Dict['PCD_CNAME']        = ['' for x in range(NumberOfLocalTokens)]
1438     Dict['PCD_TOKENSPACE_MAP'] = ['' for x in range(NumberOfLocalTokens)]
1439     Dict['PCD_CNAME_LENGTH'] = [0 for x in range(NumberOfLocalTokens)]
1440     SkuEnablePcdIndex = 0
1441     for Pcd in ReorderedDynPcdList:
1442         CName = Pcd.TokenCName
1443         TokenSpaceGuidCName = Pcd.TokenSpaceGuidCName
1444         if Pcd.Phase != Phase:
1445             continue
1446
1447         TokenSpaceGuid = GuidStructureStringToGuidValueName(Pcd.TokenSpaceGuidValue) #(Platform.PackageList, TokenSpaceGuidCName))
1448         GeneratedTokenNumber = Platform.PcdTokenNumber[CName, TokenSpaceGuidCName] - 1
1449         if Phase == 'DXE':
1450             GeneratedTokenNumber -= NumberOfPeiLocalTokens
1451
1452         if len(Pcd.SkuInfoList) > 1:
1453             Dict['PCD_ORDER_TOKEN_NUMBER_MAP'][GeneratedTokenNumber] = SkuEnablePcdIndex
1454             SkuEnablePcdIndex += 1
1455         EdkLogger.debug(EdkLogger.DEBUG_1, "PCD = %s.%s" % (CName, TokenSpaceGuidCName))
1456         EdkLogger.debug(EdkLogger.DEBUG_1, "phase = %s" % Phase)
1457         EdkLogger.debug(EdkLogger.DEBUG_1, "GeneratedTokenNumber = %s" % str(GeneratedTokenNumber))
1458
1459         #
1460         # following four Dict items hold the information for LocalTokenNumberTable
1461         #
1462         Dict['TOKEN_INIT'][GeneratedTokenNumber] = 'Init'
1463         if Pcd.InitString == 'UNINIT':
1464             Dict['TOKEN_INIT'][GeneratedTokenNumber] = 'Uninit'
1465
1466         Dict['TOKEN_CNAME'][GeneratedTokenNumber] = CName
1467         Dict['TOKEN_GUID'][GeneratedTokenNumber] = TokenSpaceGuid
1468         Dict['TOKEN_TYPE'][GeneratedTokenNumber] = ' | '.join(Pcd.TokenTypeList)
1469
1470         if Platform.Platform.PcdInfoFlag:
1471             TokenSpaceGuidCNameArray = StringToArray('"' + TokenSpaceGuidCName + '"' )
1472             if TokenSpaceGuidCNameArray not in Dict['PCD_TOKENSPACE']:
1473                 Dict['PCD_TOKENSPACE'].append(TokenSpaceGuidCNameArray)
1474                 Dict['PCD_TOKENSPACE_LENGTH'].append( len(TokenSpaceGuidCNameArray.split(",")) )
1475             Dict['PCD_TOKENSPACE_MAP'][GeneratedTokenNumber] = Dict['PCD_TOKENSPACE'].index(TokenSpaceGuidCNameArray)
1476             CNameBinArray = StringToArray('"' + CName + '"' )
1477             Dict['PCD_CNAME'][GeneratedTokenNumber] = CNameBinArray
1478
1479             Dict['PCD_CNAME_LENGTH'][GeneratedTokenNumber] = len(CNameBinArray.split(","))
1480
1481
1482         Pcd.TokenTypeList = list(set(Pcd.TokenTypeList))
1483
1484         # search the Offset and Table, used by LocalTokenNumberTableOffset
1485         if 'PCD_TYPE_HII' in Pcd.TokenTypeList:
1486             # Find index by CName, TokenSpaceGuid
1487             Offset = GetMatchedIndex(CName, Dict['VARIABLE_HEAD_CNAME_DECL'], TokenSpaceGuid, Dict['VARIABLE_HEAD_GUID_DECL'])
1488             assert(Offset != -1)
1489             Table = Dict['VARIABLE_DB_VALUE']
1490         if 'PCD_TYPE_VPD' in Pcd.TokenTypeList:
1491             Offset = GetMatchedIndex(CName, Dict['VPD_HEAD_CNAME_DECL'], TokenSpaceGuid, Dict['VPD_HEAD_GUID_DECL'])
1492             assert(Offset != -1)
1493             Table = Dict['VPD_DB_VALUE']
1494         if 'PCD_TYPE_STRING' in Pcd.TokenTypeList and 'PCD_TYPE_HII' not in Pcd.TokenTypeList:
1495             # Find index by CName, TokenSpaceGuid
1496             Offset = GetMatchedIndex(CName, Dict['STRING_HEAD_CNAME_DECL'], TokenSpaceGuid, Dict['STRING_HEAD_GUID_DECL'])
1497             Offset = PCD_STRING_INDEX_MAP[Offset]
1498             assert(Offset != -1)
1499             Table = Dict['STRING_DB_VALUE']
1500         if 'PCD_TYPE_DATA' in Pcd.TokenTypeList:
1501             # need to store whether it is in init table or not
1502             Offset = GetMatchedIndex(CName, Dict[Pcd.InitString+'_CNAME_DECL_'+Pcd.DatumType], TokenSpaceGuid, Dict[Pcd.InitString+'_GUID_DECL_'+Pcd.DatumType])
1503             assert(Offset != -1)
1504             if Pcd.InitString == 'UNINIT':
1505                 Table =  Dict[Pcd.InitString+'_GUID_DECL_'+Pcd.DatumType]
1506             else:
1507                 Table = Dict[Pcd.InitString+'_DB_VALUE_'+Pcd.DatumType]
1508         Dict['LOCAL_TOKEN_NUMBER_DB_VALUE'][GeneratedTokenNumber] = (Offset, Table)
1509
1510         #
1511         # Update VARDEF_HEADER
1512         #
1513         if 'PCD_TYPE_HII' in Pcd.TokenTypeList:
1514             Dict['VARDEF_HEADER'][GeneratedTokenNumber] = '_Variable_Header'
1515         else:
1516             Dict['VARDEF_HEADER'][GeneratedTokenNumber] = ''
1517
1518
1519         if Pcd.Type in gDynamicExPcd:
1520
1521             if Phase == 'DXE':
1522                 GeneratedTokenNumber += NumberOfPeiLocalTokens
1523             #
1524             # Per, PCD architecture specification, PCD Token Number is 1 based and 0 is defined as invalid token number.
1525             # For each EX type PCD, a PCD Token Number is assigned. When the
1526             # PCD Driver/PEIM map EX_GUID and EX_TOKEN_NUMBER to the PCD Token Number,
1527             # the non-EX Protocol/PPI interface can be called to get/set the value. This assumption is made by
1528             # Pcd Driver/PEIM in MdeModulePkg.
1529             # Therefore, 1 is added to GeneratedTokenNumber to generate a PCD Token Number before being inserted
1530             # to the EXMAPPING_TABLE.
1531             #
1532
1533
1534             Dict['EXMAPPING_TABLE_EXTOKEN'].append(str(Pcd.TokenValue) + 'U')
1535             Dict['EXMAPPING_TABLE_LOCAL_TOKEN'].append(str(GeneratedTokenNumber + 1) + 'U')
1536             Dict['EXMAPPING_TABLE_GUID_INDEX'].append(str(GuidList.index(TokenSpaceGuid)) + 'U')
1537
1538     if Platform.Platform.PcdInfoFlag:
1539         for index in range(len(Dict['PCD_TOKENSPACE_MAP'])):
1540             TokenSpaceIndex = StringTableSize
1541             for i in range(Dict['PCD_TOKENSPACE_MAP'][index]):
1542                 TokenSpaceIndex += Dict['PCD_TOKENSPACE_LENGTH'][i]
1543             Dict['PCD_TOKENSPACE_OFFSET'].append(TokenSpaceIndex)
1544         for index in range(len(Dict['PCD_TOKENSPACE'])):
1545             StringTableSize += Dict['PCD_TOKENSPACE_LENGTH'][index]
1546             StringTableIndex += 1
1547         for index in range(len(Dict['PCD_CNAME'])):
1548             Dict['PCD_CNAME_OFFSET'].append(StringTableSize)
1549             Dict['PCD_NAME_OFFSET'].append(Dict['PCD_TOKENSPACE_OFFSET'][index])
1550             Dict['PCD_NAME_OFFSET'].append(StringTableSize)
1551             StringTableSize += Dict['PCD_CNAME_LENGTH'][index]
1552             StringTableIndex += 1
1553     if GuidList != []:
1554         Dict['GUID_TABLE_EMPTY'] = 'FALSE'
1555         Dict['GUID_TABLE_SIZE'] = str(len(GuidList)) + 'U'
1556     else:
1557         Dict['GUID_STRUCTURE'] = [GuidStringToGuidStructureString('00000000-0000-0000-0000-000000000000')]
1558
1559     if StringTableIndex == 0:
1560         Dict['STRING_TABLE_INDEX'].append('')
1561         Dict['STRING_TABLE_LENGTH'].append(1)
1562         Dict['STRING_TABLE_CNAME'].append('')
1563         Dict['STRING_TABLE_GUID'].append('')
1564         Dict['STRING_TABLE_VALUE'].append('{ 0 }')
1565     else:
1566         Dict['STRING_TABLE_EMPTY'] = 'FALSE'
1567         Dict['STRING_TABLE_SIZE'] = str(StringTableSize) + 'U'
1568
1569     if Dict['SIZE_TABLE_CNAME'] == []:
1570         Dict['SIZE_TABLE_CNAME'].append('')
1571         Dict['SIZE_TABLE_GUID'].append('')
1572         Dict['SIZE_TABLE_CURRENT_LENGTH'].append(['0U'])
1573         Dict['SIZE_TABLE_MAXIMUM_LENGTH'].append('0U')
1574
1575     if NumberOfLocalTokens != 0:
1576         Dict['DATABASE_EMPTY']                = 'FALSE'
1577         Dict['LOCAL_TOKEN_NUMBER_TABLE_SIZE'] = NumberOfLocalTokens
1578         Dict['LOCAL_TOKEN_NUMBER']            = NumberOfLocalTokens
1579
1580     if NumberOfExTokens != 0:
1581         Dict['EXMAP_TABLE_EMPTY']    = 'FALSE'
1582         Dict['EXMAPPING_TABLE_SIZE'] = str(NumberOfExTokens) + 'U'
1583         Dict['EX_TOKEN_NUMBER']      = str(NumberOfExTokens) + 'U'
1584     else:
1585         Dict['EXMAPPING_TABLE_EXTOKEN'].append('0U')
1586         Dict['EXMAPPING_TABLE_LOCAL_TOKEN'].append('0U')
1587         Dict['EXMAPPING_TABLE_GUID_INDEX'].append('0U')
1588
1589     if NumberOfSizeItems != 0:
1590         Dict['SIZE_TABLE_SIZE'] = str(NumberOfSizeItems * 2) + 'U'
1591
1592     if NumberOfSkuEnabledPcd != 0:
1593         Dict['SKU_HEAD_SIZE'] = str(NumberOfSkuEnabledPcd) + 'U'
1594
1595     Dict['SKUID_VALUE'][0] = len(Dict['SKUID_VALUE']) - 1
1596
1597     AutoGenH.Append(gPcdDatabaseAutoGenH.Replace(Dict))
1598     if NumberOfLocalTokens == 0:
1599         AutoGenC.Append(gEmptyPcdDatabaseAutoGenC.Replace(Dict))
1600     else:
1601         #
1602         # Update Size Table to the right order, it should be same with LocalTokenNumberTable
1603         #
1604         SizeCNameTempList = []
1605         SizeGuidTempList = []
1606         SizeCurLenTempList = []
1607         SizeMaxLenTempList = []
1608         ReOrderFlag = True
1609
1610         if len(Dict['SIZE_TABLE_CNAME']) == 1:
1611             if not (Dict['SIZE_TABLE_CNAME'][0] and Dict['SIZE_TABLE_GUID'][0]):
1612                 ReOrderFlag = False
1613
1614         if ReOrderFlag:
1615             for Count in range(len(Dict['TOKEN_CNAME'])):
1616                 for Count1 in range(len(Dict['SIZE_TABLE_CNAME'])):
1617                     if Dict['TOKEN_CNAME'][Count] == Dict['SIZE_TABLE_CNAME'][Count1] and \
1618                         Dict['TOKEN_GUID'][Count] == Dict['SIZE_TABLE_GUID'][Count1]:
1619                         SizeCNameTempList.append(Dict['SIZE_TABLE_CNAME'][Count1])
1620                         SizeGuidTempList.append(Dict['SIZE_TABLE_GUID'][Count1])
1621                         SizeCurLenTempList.append(Dict['SIZE_TABLE_CURRENT_LENGTH'][Count1])
1622                         SizeMaxLenTempList.append(Dict['SIZE_TABLE_MAXIMUM_LENGTH'][Count1])
1623
1624             for Count in range(len(Dict['SIZE_TABLE_CNAME'])):
1625                 Dict['SIZE_TABLE_CNAME'][Count] = SizeCNameTempList[Count]
1626                 Dict['SIZE_TABLE_GUID'][Count] = SizeGuidTempList[Count]
1627                 Dict['SIZE_TABLE_CURRENT_LENGTH'][Count] = SizeCurLenTempList[Count]
1628                 Dict['SIZE_TABLE_MAXIMUM_LENGTH'][Count] = SizeMaxLenTempList[Count]
1629
1630         AutoGenC.Append(gPcdDatabaseAutoGenC.Replace(Dict))
1631
1632     if Platform.Platform.VarCheckFlag:
1633         dest = os.path.join(Platform.BuildDir, 'FV')
1634         VarCheckTab.dump(dest, Phase)
1635     Buffer = BuildExDataBase(Dict)
1636     return AutoGenH, AutoGenC, Buffer
1637
1638 def GetOrderedDynamicPcdList(DynamicPcdList, PcdTokenNumberList):
1639     ReorderedDyPcdList = [None for i in range(len(DynamicPcdList))]
1640     for Pcd in DynamicPcdList:
1641         if (Pcd.TokenCName, Pcd.TokenSpaceGuidCName) in PcdTokenNumberList:
1642             ReorderedDyPcdList[PcdTokenNumberList[Pcd.TokenCName, Pcd.TokenSpaceGuidCName]-1] = Pcd
1643     return ReorderedDyPcdList
1644