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