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