BaseTools/Source/Python/AutoGen/GenPcdDb.py

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