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