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