BaseTools/Source/Python/AutoGen/GenVar.py

   1 # Copyright (c) 2017 - 2018, Intel Corporation. All rights reserved.<BR>
   2 # This program and the accompanying materials
   3 # are licensed and made available under the terms and conditions of the BSD License
   4 # which accompanies this distribution.  The full text of the license may be found at
   5 # http://opensource.org/licenses/bsd-license.php
   6 #
   7 # THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
   8 # WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
   9
  10 #
  11 # This file is used to collect the Variable checking information
  12 #
  13
  14 # #
  15 # Import Modules
  16 #
  17 from struct import pack,unpack
  18 import collections
  19 import copy
  20 from Common.VariableAttributes import VariableAttributes
  21 from Common.Misc import *
  22 import collections
  23 import Common.DataType as DataType
  24
  25 var_info = collections.namedtuple("uefi_var", "pcdindex,pcdname,defaultstoragename,skuname,var_name, var_guid, var_offset,var_attribute,pcd_default_value, default_value, data_type")
  26 NvStorageHeaderSize = 28
  27 VariableHeaderSize = 32
  28
  29 def PackGUID(Guid):
  30     GuidBuffer = pack('=LHHBBBBBBBB',
  31                 int(Guid[0], 16),
  32                 int(Guid[1], 16),
  33                 int(Guid[2], 16),
  34                 int(Guid[3][-4:-2], 16),
  35                 int(Guid[3][-2:], 16),
  36                 int(Guid[4][-12:-10], 16),
  37                 int(Guid[4][-10:-8], 16),
  38                 int(Guid[4][-8:-6], 16),
  39                 int(Guid[4][-6:-4], 16),
  40                 int(Guid[4][-4:-2], 16),
  41                 int(Guid[4][-2:], 16)
  42                 )
  43     return GuidBuffer
  44
  45 class VariableMgr(object):
  46     def __init__(self, DefaultStoreMap,SkuIdMap):
  47         self.VarInfo = []
  48         self.DefaultStoreMap = DefaultStoreMap
  49         self.SkuIdMap = SkuIdMap
  50         self.VpdRegionSize = 0
  51         self.VpdRegionOffset = 0
  52         self.NVHeaderBuff = None
  53         self.VarDefaultBuff = None
  54         self.VarDeltaBuff = None
  55
  56     def append_variable(self,uefi_var):
  57         self.VarInfo.append(uefi_var)
  58
  59     def SetVpdRegionMaxSize(self,maxsize):
  60         self.VpdRegionSize = maxsize
  61
  62     def SetVpdRegionOffset(self,vpdoffset):
  63         self.VpdRegionOffset = vpdoffset
  64
  65     def PatchNVStoreDefaultMaxSize(self,maxsize):
  66         if not self.NVHeaderBuff:
  67             return ""
  68         self.NVHeaderBuff = self.NVHeaderBuff[:8] + pack("=Q",maxsize)
  69         default_var_bin = VariableMgr.format_data(self.NVHeaderBuff + self.VarDefaultBuff + self.VarDeltaBuff)
  70         value_str = "{"
  71         default_var_bin_strip = [ data.strip("""'""") for data in default_var_bin]
  72         value_str += ",".join(default_var_bin_strip)
  73         value_str += "}"
  74         return value_str
  75     def combine_variable(self):
  76         indexedvarinfo = collections.OrderedDict()
  77         for item in self.VarInfo:
  78             if (item.skuname,item.defaultstoragename, item.var_name,item.var_guid) not in indexedvarinfo:
  79                 indexedvarinfo[(item.skuname,item.defaultstoragename, item.var_name,item.var_guid) ] = []
  80             indexedvarinfo[(item.skuname,item.defaultstoragename, item.var_name,item.var_guid)].append(item)
  81         for key in indexedvarinfo:
  82             sku_var_info_offset_list = indexedvarinfo[key]
  83             if len(sku_var_info_offset_list) == 1:
  84                 continue
  85             newvalue = {}
  86             for item in sku_var_info_offset_list:
  87                 data_type = item.data_type
  88                 value_list = item.default_value.strip("{").strip("}").split(",")
  89                 if data_type in DataType.TAB_PCD_NUMERIC_TYPES:
  90                     if data_type == ["BOOLEAN", DataType.TAB_UINT8]:
  91                         data_flag = "=B"
  92                     elif data_type == DataType.TAB_UINT16:
  93                         data_flag = "=H"
  94                     elif data_type == DataType.TAB_UINT32:
  95                         data_flag = "=L"
  96                     elif data_type == DataType.TAB_UINT64:
  97                         data_flag = "=Q"
  98                     data = value_list[0]
  99                     value_list = []
 100                     for data_byte in pack(data_flag,int(data,16) if data.upper().startswith('0X') else int(data)):
 101                         value_list += [hex(unpack("B",data_byte)[0])]
 102                 newvalue[int(item.var_offset,16) if item.var_offset.upper().startswith("0X") else int(item.var_offset)] = value_list
 103             try:
 104                 newvaluestr = "{" + ",".join(VariableMgr.assemble_variable(newvalue)) +"}"
 105             except:
 106                 EdkLogger.error("build", AUTOGEN_ERROR, "Variable offset conflict in PCDs: %s \n" % (" and ".join([item.pcdname for item in sku_var_info_offset_list])))
 107             n = sku_var_info_offset_list[0]
 108             indexedvarinfo[key] =  [var_info(n.pcdindex,n.pcdname,n.defaultstoragename,n.skuname,n.var_name, n.var_guid, "0x00",n.var_attribute,newvaluestr  , newvaluestr , DataType.TAB_VOID)]
 109         self.VarInfo = [item[0] for item in indexedvarinfo.values()]
 110
 111     @staticmethod
 112     def assemble_variable(valuedict):
 113         ordered_offset = sorted(valuedict.keys())
 114         ordered_value = [valuedict[k] for k in ordered_offset]
 115         var_value = []
 116         num = 0
 117         for offset in ordered_offset:
 118             if offset < len(var_value):
 119                 raise
 120             for _ in xrange(offset - len(var_value)):
 121                 var_value.append('0x00')
 122             var_value += ordered_value[num]
 123             num +=1
 124         return var_value
 125
 126     def process_variable_data(self):
 127
 128         var_data = collections.defaultdict(collections.OrderedDict)
 129
 130         indexedvarinfo = collections.OrderedDict()
 131         for item in self.VarInfo:
 132             if item.pcdindex not in indexedvarinfo:
 133                 indexedvarinfo[item.pcdindex] = dict()
 134             indexedvarinfo[item.pcdindex][(item.skuname,item.defaultstoragename)] = item
 135
 136         for index in indexedvarinfo:
 137             sku_var_info = indexedvarinfo[index]
 138
 139             default_data_buffer = ""
 140             others_data_buffer = ""
 141             tail = None
 142             default_sku_default = indexedvarinfo[index].get((DataType.TAB_DEFAULT,DataType.TAB_DEFAULT_STORES_DEFAULT))
 143
 144             if default_sku_default.data_type not in DataType.TAB_PCD_NUMERIC_TYPES:
 145                 var_max_len = max([len(var_item.default_value.split(",")) for var_item in sku_var_info.values()])
 146                 if len(default_sku_default.default_value.split(",")) < var_max_len:
 147                     tail = ",".join([ "0x00" for i in range(var_max_len-len(default_sku_default.default_value.split(",")))])
 148
 149             default_data_buffer = VariableMgr.PACK_VARIABLES_DATA(default_sku_default.default_value,default_sku_default.data_type,tail)
 150
 151             default_data_array = ()
 152             for item in default_data_buffer:
 153                 default_data_array += unpack("B",item)
 154
 155             var_data[(DataType.TAB_DEFAULT,DataType.TAB_DEFAULT_STORES_DEFAULT)][index] = (default_data_buffer,sku_var_info[(DataType.TAB_DEFAULT,DataType.TAB_DEFAULT_STORES_DEFAULT)])
 156
 157             for (skuid,defaultstoragename) in indexedvarinfo[index]:
 158                 tail = None
 159                 if (skuid,defaultstoragename) == (DataType.TAB_DEFAULT,DataType.TAB_DEFAULT_STORES_DEFAULT):
 160                     continue
 161                 other_sku_other = indexedvarinfo[index][(skuid,defaultstoragename)]
 162
 163                 if default_sku_default.data_type not in DataType.TAB_PCD_NUMERIC_TYPES:
 164                     if len(other_sku_other.default_value.split(",")) < var_max_len:
 165                         tail = ",".join([ "0x00" for i in range(var_max_len-len(other_sku_other.default_value.split(",")))])
 166
 167                 others_data_buffer = VariableMgr.PACK_VARIABLES_DATA(other_sku_other.default_value,other_sku_other.data_type,tail)
 168
 169                 others_data_array = ()
 170                 for item in others_data_buffer:
 171                     others_data_array += unpack("B",item)
 172
 173                 data_delta = VariableMgr.calculate_delta(default_data_array, others_data_array)
 174
 175                 var_data[(skuid,defaultstoragename)][index] = (data_delta,sku_var_info[(skuid,defaultstoragename)])
 176         return var_data
 177
 178     def new_process_varinfo(self):
 179         self.combine_variable()
 180
 181         var_data = self.process_variable_data()
 182
 183         if not var_data:
 184             return []
 185
 186         pcds_default_data = var_data.get((DataType.TAB_DEFAULT,DataType.TAB_DEFAULT_STORES_DEFAULT),{})
 187         NvStoreDataBuffer = ""
 188         var_data_offset = collections.OrderedDict()
 189         offset = NvStorageHeaderSize
 190         for default_data,default_info in pcds_default_data.values():
 191             var_name_buffer = VariableMgr.PACK_VARIABLE_NAME(default_info.var_name)
 192
 193             vendorguid = default_info.var_guid.split('-')
 194
 195             if default_info.var_attribute:
 196                 var_attr_value,_ = VariableAttributes.GetVarAttributes(default_info.var_attribute)
 197             else:
 198                 var_attr_value = 0x07
 199
 200             DataBuffer = VariableMgr.AlignData(var_name_buffer + default_data)
 201
 202             data_size = len(DataBuffer)
 203             offset += VariableHeaderSize + len(default_info.var_name.split(","))
 204             var_data_offset[default_info.pcdindex] = offset
 205             offset += data_size - len(default_info.var_name.split(","))
 206
 207             var_header_buffer = VariableMgr.PACK_VARIABLE_HEADER(var_attr_value, len(default_info.var_name.split(",")), len (default_data), vendorguid)
 208             NvStoreDataBuffer += (var_header_buffer + DataBuffer)
 209
 210         variable_storage_header_buffer = VariableMgr.PACK_VARIABLE_STORE_HEADER(len(NvStoreDataBuffer) + 28)
 211
 212         nv_default_part = VariableMgr.AlignData(VariableMgr.PACK_DEFAULT_DATA(0, 0, VariableMgr.unpack_data(variable_storage_header_buffer+NvStoreDataBuffer)), 8)
 213
 214         data_delta_structure_buffer = ""
 215         for skuname,defaultstore in var_data:
 216             if (skuname,defaultstore) == (DataType.TAB_DEFAULT,DataType.TAB_DEFAULT_STORES_DEFAULT):
 217                 continue
 218             pcds_sku_data = var_data[(skuname,defaultstore)]
 219             delta_data_set = []
 220             for pcdindex in pcds_sku_data:
 221                 offset = var_data_offset[pcdindex]
 222                 delta_data,_ = pcds_sku_data[pcdindex]
 223                 delta_data = [(item[0] + offset, item[1]) for item in delta_data]
 224                 delta_data_set.extend(delta_data)
 225
 226             data_delta_structure_buffer += VariableMgr.AlignData(self.PACK_DELTA_DATA(skuname,defaultstore,delta_data_set), 8)
 227
 228         size = len(nv_default_part + data_delta_structure_buffer) + 16
 229         maxsize = self.VpdRegionSize if self.VpdRegionSize else size
 230         NV_Store_Default_Header = VariableMgr.PACK_NV_STORE_DEFAULT_HEADER(size,maxsize)
 231
 232         self.NVHeaderBuff =  NV_Store_Default_Header
 233         self.VarDefaultBuff =nv_default_part
 234         self.VarDeltaBuff =  data_delta_structure_buffer
 235         return VariableMgr.format_data(NV_Store_Default_Header + nv_default_part + data_delta_structure_buffer)
 236
 237
 238     @staticmethod
 239     def format_data(data):
 240         return  [hex(item) for item in VariableMgr.unpack_data(data)]
 241
 242     @staticmethod
 243     def unpack_data(data):
 244         final_data = ()
 245         for item in data:
 246             final_data += unpack("B",item)
 247         return final_data
 248
 249     @staticmethod
 250     def calculate_delta(default, theother):
 251         if len(default) - len(theother) != 0:
 252             EdkLogger.error("build", FORMAT_INVALID, 'The variable data length is not the same for the same PCD.')
 253         data_delta = []
 254         for i in range(len(default)):
 255             if default[i] != theother[i]:
 256                 data_delta.append((i,theother[i]))
 257         return data_delta
 258
 259     def dump(self):
 260
 261         default_var_bin = self.new_process_varinfo()
 262         if default_var_bin:
 263             value_str = "{"
 264             default_var_bin_strip = [ data.strip("""'""") for data in default_var_bin]
 265             value_str += ",".join(default_var_bin_strip)
 266             value_str += "}"
 267             return value_str
 268         return ""
 269
 270     @staticmethod
 271     def PACK_VARIABLE_STORE_HEADER(size):
 272         #Signature: gEfiVariableGuid
 273         Guid = "{ 0xddcf3616, 0x3275, 0x4164, { 0x98, 0xb6, 0xfe, 0x85, 0x70, 0x7f, 0xfe, 0x7d }}"
 274         Guid = GuidStructureStringToGuidString(Guid)
 275         GuidBuffer = PackGUID(Guid.split('-'))
 276
 277         SizeBuffer = pack('=L',size)
 278         FormatBuffer = pack('=B',0x5A)
 279         StateBuffer = pack('=B',0xFE)
 280         reservedBuffer = pack('=H',0)
 281         reservedBuffer += pack('=L',0)
 282
 283         return GuidBuffer + SizeBuffer + FormatBuffer + StateBuffer + reservedBuffer
 284
 285     @staticmethod
 286     def PACK_NV_STORE_DEFAULT_HEADER(size,maxsize):
 287         Signature = pack('=B',ord('N'))
 288         Signature += pack("=B",ord('S'))
 289         Signature += pack("=B",ord('D'))
 290         Signature += pack("=B",ord('B'))
 291
 292         SizeBuffer = pack("=L",size)
 293         MaxSizeBuffer = pack("=Q",maxsize)
 294
 295         return Signature + SizeBuffer + MaxSizeBuffer
 296
 297     @staticmethod
 298     def PACK_VARIABLE_HEADER(attribute,namesize,datasize,vendorguid):
 299
 300         Buffer = pack('=H',0x55AA) # pack StartID
 301         Buffer += pack('=B',0x3F)  # pack State
 302         Buffer += pack('=B',0)     # pack reserved
 303
 304         Buffer += pack('=L',attribute)
 305         Buffer += pack('=L',namesize)
 306         Buffer += pack('=L',datasize)
 307
 308         Buffer += PackGUID(vendorguid)
 309
 310         return Buffer
 311
 312     @staticmethod
 313     def PACK_VARIABLES_DATA(var_value,data_type, tail = None):
 314         Buffer = ""
 315         data_len = 0
 316         if data_type == DataType.TAB_VOID:
 317             for value_char in var_value.strip("{").strip("}").split(","):
 318                 Buffer += pack("=B",int(value_char,16))
 319             data_len += len(var_value.split(","))
 320             if tail:
 321                 for value_char in tail.split(","):
 322                     Buffer += pack("=B",int(value_char,16))
 323                 data_len += len(tail.split(","))
 324         elif data_type == "BOOLEAN":
 325             Buffer += pack("=B",True) if var_value.upper() == "TRUE" else pack("=B",False)
 326             data_len += 1
 327         elif data_type  == DataType.TAB_UINT8:
 328             Buffer += pack("=B",GetIntegerValue(var_value))
 329             data_len += 1
 330         elif data_type == DataType.TAB_UINT16:
 331             Buffer += pack("=H",GetIntegerValue(var_value))
 332             data_len += 2
 333         elif data_type == DataType.TAB_UINT32:
 334             Buffer += pack("=L",GetIntegerValue(var_value))
 335             data_len += 4
 336         elif data_type == DataType.TAB_UINT64:
 337             Buffer += pack("=Q",GetIntegerValue(var_value))
 338             data_len += 8
 339
 340         return Buffer
 341
 342     @staticmethod
 343     def PACK_DEFAULT_DATA(defaultstoragename,skuid,var_value):
 344         Buffer = ""
 345         Buffer += pack("=L",4+8+8)
 346         Buffer += pack("=Q",int(skuid))
 347         Buffer += pack("=Q",int(defaultstoragename))
 348
 349         for item in var_value:
 350             Buffer += pack("=B",item)
 351
 352         Buffer = pack("=L",len(Buffer)+4) + Buffer
 353
 354         return Buffer
 355
 356     def GetSkuId(self,skuname):
 357         if skuname not in self.SkuIdMap:
 358             return None
 359         return self.SkuIdMap.get(skuname)[0]
 360
 361     def GetDefaultStoreId(self,dname):
 362         if dname not in self.DefaultStoreMap:
 363             return None
 364         return self.DefaultStoreMap.get(dname)[0]
 365
 366     def PACK_DELTA_DATA(self,skuname,defaultstoragename,delta_list):
 367         skuid = self.GetSkuId(skuname)
 368         defaultstorageid = self.GetDefaultStoreId(defaultstoragename)
 369         Buffer = ""
 370         Buffer += pack("=L",4+8+8)
 371         Buffer += pack("=Q",int(skuid))
 372         Buffer += pack("=Q",int(defaultstorageid))
 373         for (delta_offset,value) in delta_list:
 374             Buffer += pack("=L",delta_offset)
 375             Buffer = Buffer[:-1] + pack("=B",value)
 376
 377         Buffer = pack("=L",len(Buffer) + 4) + Buffer
 378
 379         return Buffer
 380
 381     @staticmethod
 382     def AlignData(data, align = 4):
 383         mybuffer = data
 384         if (len(data) % align) > 0:
 385             for i in range(align - (len(data) % align)):
 386                 mybuffer += pack("=B",0)
 387
 388         return mybuffer
 389
 390     @staticmethod
 391     def PACK_VARIABLE_NAME(var_name):
 392         Buffer = ""
 393         for name_char in var_name.strip("{").strip("}").split(","):
 394             Buffer += pack("=B",int(name_char,16))
 395
 396         return Buffer