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             newvaluestr = "{" + ",".join(reduce(lambda x,y: x+y, [newvalue[k] for k in sorted(newvalue.keys())] )) +"}"
 108             n = sku_var_info_offset_list[0]
 109             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*")]
 110         self.VarInfo = [item[0] for item in indexedvarinfo.values()]
 111     def process_variable_data(self):
 112
 113         var_data = dict()
 114
 115         indexedvarinfo = collections.OrderedDict()
 116         for item in self.VarInfo:
 117             if item.pcdindex not in indexedvarinfo:
 118                 indexedvarinfo[item.pcdindex] = dict()
 119             indexedvarinfo[item.pcdindex][(item.skuname,item.defaultstoragename)] = item
 120
 121         for index in indexedvarinfo:
 122             sku_var_info = indexedvarinfo[index]
 123
 124             default_data_buffer = ""
 125             others_data_buffer = ""
 126             tail = None
 127             default_sku_default = indexedvarinfo.get(index).get(("DEFAULT","STANDARD"))
 128
 129             if default_sku_default.data_type not in ["UINT8","UINT16","UINT32","UINT64","BOOLEAN"]:
 130                 var_max_len = max([len(var_item.default_value.split(",")) for var_item in sku_var_info.values()])
 131                 if len(default_sku_default.default_value.split(",")) < var_max_len:
 132                     tail = ",".join([ "0x00" for i in range(var_max_len-len(default_sku_default.default_value.split(",")))])
 133
 134             default_data_buffer = self.PACK_VARIABLES_DATA(default_sku_default.default_value,default_sku_default.data_type,tail)
 135
 136             default_data_array = ()
 137             for item in default_data_buffer:
 138                 default_data_array += unpack("B",item)
 139
 140             if ("DEFAULT","STANDARD") not in var_data:
 141                 var_data[("DEFAULT","STANDARD")] = collections.OrderedDict()
 142             var_data[("DEFAULT","STANDARD")][index] = (default_data_buffer,sku_var_info[("DEFAULT","STANDARD")])
 143
 144             for (skuid,defaultstoragename) in indexedvarinfo.get(index):
 145                 tail = None
 146                 if (skuid,defaultstoragename) == ("DEFAULT","STANDARD"):
 147                     continue
 148                 other_sku_other = indexedvarinfo.get(index).get((skuid,defaultstoragename))
 149
 150                 if default_sku_default.data_type not in ["UINT8","UINT16","UINT32","UINT64","BOOLEAN"]:
 151                     if len(other_sku_other.default_value.split(",")) < var_max_len:
 152                         tail = ",".join([ "0x00" for i in range(var_max_len-len(other_sku_other.default_value.split(",")))])
 153
 154                 others_data_buffer = self.PACK_VARIABLES_DATA(other_sku_other.default_value,other_sku_other.data_type,tail)
 155
 156                 others_data_array = ()
 157                 for item in others_data_buffer:
 158                     others_data_array += unpack("B",item)
 159
 160                 data_delta = self.calculate_delta(default_data_array, others_data_array)
 161
 162                 if (skuid,defaultstoragename) not in var_data:
 163                     var_data[(skuid,defaultstoragename)] = collections.OrderedDict()
 164                 var_data[(skuid,defaultstoragename)][index] = (data_delta,sku_var_info[(skuid,defaultstoragename)])
 165         return var_data
 166
 167     def new_process_varinfo(self):
 168         self.combine_variable()
 169
 170         var_data = self.process_variable_data()
 171
 172         if not var_data:
 173             return []
 174
 175         pcds_default_data = var_data.get(("DEFAULT","STANDARD"),{})
 176         NvStoreDataBuffer = ""
 177         var_data_offset = collections.OrderedDict()
 178         offset = NvStorageHeaderSize
 179         for default_data,default_info in pcds_default_data.values():
 180             var_name_buffer = self.PACK_VARIABLE_NAME(default_info.var_name)
 181
 182             vendorguid = default_info.var_guid.split('-')
 183
 184             if default_info.var_attribute:
 185                 var_attr_value,_ = VariableAttributes.GetVarAttributes(default_info.var_attribute)
 186             else:
 187                 var_attr_value = 0x07
 188
 189             DataBuffer = self.AlignData(var_name_buffer + default_data)
 190
 191             data_size = len(DataBuffer)
 192             offset += VariableHeaderSize + len(default_info.var_name.split(","))
 193             var_data_offset[default_info.pcdindex] = offset
 194             offset += data_size - len(default_info.var_name.split(","))
 195
 196             var_header_buffer = self.PACK_VARIABLE_HEADER(var_attr_value, len(default_info.var_name.split(",")), len (default_data), vendorguid)
 197             NvStoreDataBuffer += (var_header_buffer + DataBuffer)
 198
 199         variable_storage_header_buffer = self.PACK_VARIABLE_STORE_HEADER(len(NvStoreDataBuffer) + 28)
 200
 201         nv_default_part = self.AlignData(self.PACK_DEFAULT_DATA(0, 0, self.unpack_data(variable_storage_header_buffer+NvStoreDataBuffer)), 8)
 202
 203         data_delta_structure_buffer = ""
 204         for skuname,defaultstore in var_data:
 205             if (skuname,defaultstore) == ("DEFAULT","STANDARD"):
 206                 continue
 207             pcds_sku_data = var_data.get((skuname,defaultstore))
 208             delta_data_set = []
 209             for pcdindex in pcds_sku_data:
 210                 offset = var_data_offset[pcdindex]
 211                 delta_data,_ = pcds_sku_data[pcdindex]
 212                 delta_data = [(item[0] + offset, item[1]) for item in delta_data]
 213                 delta_data_set.extend(delta_data)
 214
 215             data_delta_structure_buffer += self.AlignData(self.PACK_DELTA_DATA(skuname,defaultstore,delta_data_set), 8)
 216
 217         size = len(nv_default_part + data_delta_structure_buffer) + 16
 218         maxsize = self.VpdRegionSize if self.VpdRegionSize else size
 219         NV_Store_Default_Header = self.PACK_NV_STORE_DEFAULT_HEADER(size,maxsize)
 220
 221         self.NVHeaderBuff =  NV_Store_Default_Header
 222         self.VarDefaultBuff =nv_default_part
 223         self.VarDeltaBuff =  data_delta_structure_buffer
 224         return self.format_data(NV_Store_Default_Header + nv_default_part + data_delta_structure_buffer)
 225
 226
 227     def format_data(self,data):
 228
 229         return  [hex(item) for item in self.unpack_data(data)]
 230
 231     def unpack_data(self,data):
 232         final_data = ()
 233         for item in data:
 234             final_data += unpack("B",item)
 235         return final_data
 236
 237     def calculate_delta(self, default, theother):
 238         if len(default) - len(theother) != 0:
 239             EdkLogger.error("build", FORMAT_INVALID, 'The variable data length is not the same for the same PCD.')
 240         data_delta = []
 241         for i in range(len(default)):
 242             if default[i] != theother[i]:
 243                 data_delta.append((i,theother[i]))
 244         return data_delta
 245
 246     def dump(self):
 247
 248         default_var_bin = self.new_process_varinfo()
 249         if default_var_bin:
 250             value_str = "{"
 251             default_var_bin_strip = [ data.strip("""'""") for data in default_var_bin]
 252             value_str += ",".join(default_var_bin_strip)
 253             value_str += "}"
 254             return value_str
 255         return ""
 256
 257     def PACK_VARIABLE_STORE_HEADER(self,size):
 258         #Signature: gEfiVariableGuid
 259         Guid = "{ 0xddcf3616, 0x3275, 0x4164, { 0x98, 0xb6, 0xfe, 0x85, 0x70, 0x7f, 0xfe, 0x7d }}"
 260         Guid = GuidStructureStringToGuidString(Guid)
 261         GuidBuffer = PackGUID(Guid.split('-'))
 262
 263         SizeBuffer = pack('=L',size)
 264         FormatBuffer = pack('=B',0x5A)
 265         StateBuffer = pack('=B',0xFE)
 266         reservedBuffer = pack('=H',0)
 267         reservedBuffer += pack('=L',0)
 268
 269         return GuidBuffer + SizeBuffer + FormatBuffer + StateBuffer + reservedBuffer
 270
 271     def PACK_NV_STORE_DEFAULT_HEADER(self,size,maxsize):
 272         Signature = pack('=B',ord('N'))
 273         Signature += pack("=B",ord('S'))
 274         Signature += pack("=B",ord('D'))
 275         Signature += pack("=B",ord('B'))
 276
 277         SizeBuffer = pack("=L",size)
 278         MaxSizeBuffer = pack("=Q",maxsize)
 279
 280         return Signature + SizeBuffer + MaxSizeBuffer
 281
 282     def PACK_VARIABLE_HEADER(self,attribute,namesize,datasize,vendorguid):
 283
 284         Buffer = pack('=H',0x55AA) # pack StartID
 285         Buffer += pack('=B',0x3F)  # pack State
 286         Buffer += pack('=B',0)     # pack reserved
 287
 288         Buffer += pack('=L',attribute)
 289         Buffer += pack('=L',namesize)
 290         Buffer += pack('=L',datasize)
 291
 292         Buffer += PackGUID(vendorguid)
 293
 294         return Buffer
 295
 296     def PACK_VARIABLES_DATA(self, var_value,data_type, tail = None):
 297         Buffer = ""
 298         data_len = 0
 299         if data_type == "VOID*":
 300             for value_char in var_value.strip("{").strip("}").split(","):
 301                 Buffer += pack("=B",int(value_char,16))
 302             data_len += len(var_value.split(","))
 303             if tail:
 304                 for value_char in tail.split(","):
 305                     Buffer += pack("=B",int(value_char,16))
 306                 data_len += len(tail.split(","))
 307         elif data_type == "BOOLEAN":
 308             Buffer += pack("=B",True) if var_value.upper() == "TRUE" else pack("=B",False)
 309             data_len += 1
 310         elif data_type  == "UINT8":
 311             Buffer += pack("=B",GetIntegerValue(var_value))
 312             data_len += 1
 313         elif data_type == "UINT16":
 314             Buffer += pack("=H",GetIntegerValue(var_value))
 315             data_len += 2
 316         elif data_type == "UINT32":
 317             Buffer += pack("=L",GetIntegerValue(var_value))
 318             data_len += 4
 319         elif data_type == "UINT64":
 320             Buffer += pack("=Q",GetIntegerValue(var_value))
 321             data_len += 8
 322
 323         return Buffer
 324
 325     def PACK_DEFAULT_DATA(self, defaultstoragename,skuid,var_value):
 326         Buffer = ""
 327         Buffer += pack("=L",4+8+8)
 328         Buffer += pack("=Q",int(skuid))
 329         Buffer += pack("=Q",int(defaultstoragename))
 330
 331         for item in var_value:
 332             Buffer += pack("=B",item)
 333
 334         Buffer = pack("=L",len(Buffer)+4) + Buffer
 335
 336         return Buffer
 337
 338     def GetSkuId(self,skuname):
 339         if skuname not in self.SkuIdMap:
 340             return None
 341         return self.SkuIdMap.get(skuname)[0]
 342     def GetDefaultStoreId(self,dname):
 343         if dname not in self.DefaultStoreMap:
 344             return None
 345         return self.DefaultStoreMap.get(dname)[0]
 346     def PACK_DELTA_DATA(self,skuname,defaultstoragename,delta_list):
 347         skuid = self.GetSkuId(skuname)
 348         defaultstorageid = self.GetDefaultStoreId(defaultstoragename)
 349         Buffer = ""
 350         Buffer += pack("=L",4+8+8)
 351         Buffer += pack("=Q",int(skuid))
 352         Buffer += pack("=Q",int(defaultstorageid))
 353         for (delta_offset,value) in delta_list:
 354             Buffer += pack("=L",delta_offset)
 355             Buffer = Buffer[:-1] + pack("=B",value)
 356
 357         Buffer = pack("=L",len(Buffer) + 4) + Buffer
 358
 359         return Buffer
 360
 361     def AlignData(self,data, align = 4):
 362         mybuffer = data
 363         if (len(data) % align) > 0:
 364             for i in range(align - (len(data) % align)):
 365                 mybuffer += pack("=B",0)
 366
 367         return mybuffer
 368
 369     def PACK_VARIABLE_NAME(self, var_name):
 370         Buffer = ""
 371         for name_char in var_name.strip("{").strip("}").split(","):
 372             Buffer += pack("=B",int(name_char,16))
 373
 374         return Buffer