BaseTools/Source/Python/AutoGen/GenPcdDb.py

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