BaseTools/Source/Python/AutoGen/GenVar.py

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