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