]> git.proxmox.com Git - mirror_edk2.git/blame - BaseTools/Source/Python/AutoGen/GenVar.py
BaseTools: PcdDataBase Optimization for multiple SkuIds
[mirror_edk2.git] / BaseTools / Source / Python / AutoGen / GenVar.py
CommitLineData
34952f49
LG
1# Copyright (c) 2017, Intel Corporation. All rights reserved.<BR>\r
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
17from struct import pack,unpack\r
18import collections\r
19import copy\r
20from Common.VariableAttributes import VariableAttributes\r
21from Common.Misc import *\r
22import collections\r
23\r
24var_info = collections.namedtuple("uefi_var", "pcdindex,pcdname,defaultstoragename,skuname,var_name, var_guid, var_attribute,pcd_default_value, default_value, data_type")\r
25NvStorageHeaderSize = 28\r
26VariableHeaderSize = 32\r
27\r
28def StringArrayToList(StringArray):\r
29 StringArray = StringArray[1:-1]\r
30 StringArray = '[' + StringArray + ']'\r
31 return eval(StringArray)\r
32\r
33def PackGUID(Guid):\r
34 GuidBuffer = pack('=LHHBBBBBBBB',\r
35 int(Guid[0], 16),\r
36 int(Guid[1], 16),\r
37 int(Guid[2], 16),\r
38 int(Guid[3][-4:-2], 16),\r
39 int(Guid[3][-2:], 16),\r
40 int(Guid[4][-12:-10], 16),\r
41 int(Guid[4][-10:-8], 16),\r
42 int(Guid[4][-8:-6], 16),\r
43 int(Guid[4][-6:-4], 16),\r
44 int(Guid[4][-4:-2], 16),\r
45 int(Guid[4][-2:], 16)\r
46 )\r
47 return GuidBuffer\r
48\r
8518bf0b
LG
49class VariableMgr(object):\r
50 def __init__(self, DefaultStoreMap,SkuIdMap):\r
34952f49 51 self.VarInfo = []\r
8518bf0b
LG
52 self.DefaultStoreMap = DefaultStoreMap\r
53 self.SkuIdMap = SkuIdMap\r
34952f49
LG
54\r
55 def append_variable(self,uefi_var):\r
56 self.VarInfo.append(uefi_var)\r
57\r
58 def process_variable_data(self):\r
59\r
60 var_data = dict()\r
61\r
62 indexedvarinfo = collections.OrderedDict()\r
63 for item in self.VarInfo:\r
64 if item.pcdindex not in indexedvarinfo:\r
65 indexedvarinfo[item.pcdindex] = dict()\r
8518bf0b 66 indexedvarinfo[item.pcdindex][(item.skuname,item.defaultstoragename)] = item\r
34952f49
LG
67\r
68 for index in indexedvarinfo:\r
69 sku_var_info = indexedvarinfo[index]\r
70\r
71 default_data_buffer = ""\r
72 others_data_buffer = ""\r
73 tail = None\r
8518bf0b 74 default_sku_default = indexedvarinfo.get(index).get(("DEFAULT","STANDARD"))\r
34952f49
LG
75\r
76 if default_sku_default.data_type not in ["UINT8","UINT16","UINT32","UINT64","BOOLEAN"]:\r
77 var_max_len = max([len(var_item.default_value.split(",")) for var_item in sku_var_info.values()])\r
78 if len(default_sku_default.default_value.split(",")) < var_max_len:\r
79 tail = ",".join([ "0x00" for i in range(var_max_len-len(default_sku_default.default_value.split(",")))])\r
80\r
81 default_data_buffer = self.PACK_VARIABLES_DATA(default_sku_default.default_value,default_sku_default.data_type,tail)\r
82\r
83 default_data_array = ()\r
84 for item in default_data_buffer:\r
85 default_data_array += unpack("B",item)\r
86\r
8518bf0b
LG
87 if ("DEFAULT","STANDARD") not in var_data:\r
88 var_data[("DEFAULT","STANDARD")] = collections.OrderedDict()\r
89 var_data[("DEFAULT","STANDARD")][index] = (default_data_buffer,sku_var_info[("DEFAULT","STANDARD")])\r
34952f49
LG
90\r
91 for (skuid,defaultstoragename) in indexedvarinfo.get(index):\r
92 tail = None\r
8518bf0b 93 if (skuid,defaultstoragename) == ("DEFAULT","STANDARD"):\r
34952f49
LG
94 continue\r
95 other_sku_other = indexedvarinfo.get(index).get((skuid,defaultstoragename))\r
96\r
97 if default_sku_default.data_type not in ["UINT8","UINT16","UINT32","UINT64","BOOLEAN"]:\r
98 if len(other_sku_other.default_value.split(",")) < var_max_len:\r
99 tail = ",".join([ "0x00" for i in range(var_max_len-len(other_sku_other.default_value.split(",")))])\r
100\r
101 others_data_buffer = self.PACK_VARIABLES_DATA(other_sku_other.default_value,other_sku_other.data_type,tail)\r
102\r
103 others_data_array = ()\r
104 for item in others_data_buffer:\r
105 others_data_array += unpack("B",item)\r
106\r
107 data_delta = self.calculate_delta(default_data_array, others_data_array)\r
108\r
109 if (skuid,defaultstoragename) not in var_data:\r
110 var_data[(skuid,defaultstoragename)] = collections.OrderedDict()\r
111 var_data[(skuid,defaultstoragename)][index] = (data_delta,sku_var_info[(skuid,defaultstoragename)])\r
112 return var_data\r
113\r
114 def new_process_varinfo(self):\r
115\r
116 var_data = self.process_variable_data()\r
117\r
2b8a6c44
LG
118 if not var_data:\r
119 return []\r
120\r
8518bf0b 121 pcds_default_data = var_data.get(("DEFAULT","STANDARD"))\r
34952f49
LG
122 NvStoreDataBuffer = ""\r
123 var_data_offset = collections.OrderedDict()\r
124 offset = NvStorageHeaderSize\r
125 for default_data,default_info in pcds_default_data.values():\r
126 var_name_buffer = self.PACK_VARIABLE_NAME(default_info.var_name)\r
127\r
128 vendorguid = default_info.var_guid.split('-')\r
129\r
130 if default_info.var_attribute:\r
131 var_attr_value,_ = VariableAttributes.GetVarAttributes(default_info.var_attribute)\r
132 else:\r
133 var_attr_value = 0x07\r
134\r
2b8a6c44
LG
135# print "default var_name_buffer"\r
136# print self.format_data(var_name_buffer)\r
137# print "default var_buffer"\r
138# print self.format_data(default_data)\r
139\r
34952f49
LG
140 DataBuffer = self.AlignData(var_name_buffer + default_data)\r
141\r
142 data_size = len(DataBuffer)\r
143 offset += VariableHeaderSize + len(default_info.var_name.split(","))\r
144 var_data_offset[default_info.pcdindex] = offset\r
145 offset += data_size - len(default_info.var_name.split(","))\r
146\r
8518bf0b 147 var_header_buffer = self.PACK_VARIABLE_HEADER(var_attr_value, len(default_info.var_name.split(",")), len (default_data), vendorguid)\r
34952f49
LG
148 NvStoreDataBuffer += (var_header_buffer + DataBuffer)\r
149\r
150 variable_storage_header_buffer = self.PACK_VARIABLE_STORE_HEADER(len(NvStoreDataBuffer) + 28)\r
151\r
152 nv_default_part = self.AlignData(self.PACK_DEFAULT_DATA(0, 0, self.unpack_data(variable_storage_header_buffer+NvStoreDataBuffer)))\r
153\r
2b8a6c44
LG
154# print "default whole data \n",self.format_data(nv_default_part)\r
155\r
34952f49 156 data_delta_structure_buffer = ""\r
8518bf0b
LG
157 for skuname,defaultstore in var_data:\r
158 if (skuname,defaultstore) == ("DEFAULT","STANDARD"):\r
34952f49 159 continue\r
8518bf0b 160 pcds_sku_data = var_data.get((skuname,defaultstore))\r
34952f49
LG
161 delta_data_set = []\r
162 for pcdindex in pcds_sku_data:\r
163 offset = var_data_offset[pcdindex]\r
164 delta_data,_ = pcds_sku_data[pcdindex]\r
165 delta_data = [(item[0] + offset, item[1]) for item in delta_data]\r
166 delta_data_set.extend(delta_data)\r
167\r
8518bf0b 168 data_delta_structure_buffer += self.AlignData(self.PACK_DELTA_DATA(skuname,defaultstore,delta_data_set))\r
2b8a6c44
LG
169# print "delta data"\r
170# print delta_data_set\r
171# print self.format_data(self.AlignData(self.PACK_DELTA_DATA(skuname,defaultstore,delta_data_set)))\r
34952f49
LG
172\r
173 return self.format_data(nv_default_part + data_delta_structure_buffer)\r
174\r
175\r
176 def format_data(self,data):\r
177\r
178 return [hex(item) for item in self.unpack_data(data)]\r
179\r
180 def unpack_data(self,data):\r
181 final_data = ()\r
182 for item in data:\r
183 final_data += unpack("B",item)\r
184 return final_data\r
185\r
186 def calculate_delta(self, default, theother):\r
2b8a6c44
LG
187# print "default data \n", default\r
188# print "other data \n",theother\r
34952f49
LG
189 if len(default) - len(theother) != 0:\r
190 EdkLogger.error("build", FORMAT_INVALID, 'The variable data length is not the same for the same PCD.')\r
191 data_delta = []\r
192 for i in range(len(default)):\r
193 if default[i] != theother[i]:\r
194 data_delta.append((i,theother[i]))\r
195 return data_delta\r
196\r
197 def dump(self):\r
198\r
199 default_var_bin = self.new_process_varinfo()\r
2b8a6c44
LG
200 if default_var_bin:\r
201 value_str = "{"\r
202 default_var_bin_strip = [ data.strip("""'""") for data in default_var_bin]\r
203 value_str += ",".join(default_var_bin_strip)\r
204 value_str += "}"\r
205 return value_str\r
206 return ""\r
34952f49
LG
207\r
208 def PACK_VARIABLE_STORE_HEADER(self,size):\r
209 #Signature: gEfiVariableGuid\r
210 Guid = "{ 0xddcf3616, 0x3275, 0x4164, { 0x98, 0xb6, 0xfe, 0x85, 0x70, 0x7f, 0xfe, 0x7d }}"\r
211 Guid = GuidStructureStringToGuidString(Guid)\r
212 GuidBuffer = PackGUID(Guid.split('-'))\r
213\r
214 SizeBuffer = pack('=L',size)\r
215 FormatBuffer = pack('=B',0x5A)\r
216 StateBuffer = pack('=B',0xFE)\r
217 reservedBuffer = pack('=H',0)\r
218 reservedBuffer += pack('=L',0)\r
219\r
220 return GuidBuffer + SizeBuffer + FormatBuffer + StateBuffer + reservedBuffer\r
221\r
222\r
223 def PACK_VARIABLE_HEADER(self,attribute,namesize,datasize,vendorguid):\r
224\r
225 Buffer = pack('=H',0x55AA) # pack StartID\r
226 Buffer += pack('=B',0x3F) # pack State\r
227 Buffer += pack('=B',0) # pack reserved\r
228\r
229 Buffer += pack('=L',attribute)\r
230 Buffer += pack('=L',namesize)\r
231 Buffer += pack('=L',datasize)\r
232\r
233 Buffer += PackGUID(vendorguid)\r
234\r
235 return Buffer\r
236\r
237 def PACK_VARIABLES_DATA(self, var_value,data_type, tail = None):\r
238 Buffer = ""\r
239 data_len = 0\r
240 if data_type == "VOID*":\r
241 for value_char in var_value.strip("{").strip("}").split(","):\r
242 Buffer += pack("=B",int(value_char,16))\r
243 data_len += len(var_value.split(","))\r
244 if tail:\r
245 for value_char in tail.split(","):\r
246 Buffer += pack("=B",int(value_char,16))\r
247 data_len += len(tail.split(","))\r
248 elif data_type == "BOOLEAN":\r
249 Buffer += pack("=B",True) if var_value.upper() == "TRUE" else pack("=B",False)\r
250 data_len += 1\r
251 elif data_type == "UINT8":\r
252 Buffer += pack("=B",GetIntegerValue(var_value))\r
253 data_len += 1\r
254 elif data_type == "UINT16":\r
255 Buffer += pack("=H",GetIntegerValue(var_value))\r
256 data_len += 2\r
257 elif data_type == "UINT32":\r
258 Buffer += pack("=L",GetIntegerValue(var_value))\r
259 data_len += 4\r
260 elif data_type == "UINT64":\r
261 Buffer += pack("=Q",GetIntegerValue(var_value))\r
262 data_len += 8\r
263\r
264 return Buffer\r
265\r
266 def PACK_DEFAULT_DATA(self, defaultstoragename,skuid,var_value):\r
267 Buffer = ""\r
8518bf0b 268 Buffer += pack("=L",8)\r
34952f49
LG
269 Buffer += pack("=H",int(defaultstoragename))\r
270 Buffer += pack("=H",int(skuid))\r
271\r
272 for item in var_value:\r
273 Buffer += pack("=B",item)\r
274\r
275 Buffer = pack("=L",len(Buffer)+4) + Buffer\r
276\r
277 return Buffer\r
278\r
8518bf0b
LG
279 def GetSkuId(self,skuname):\r
280 if skuname not in self.SkuIdMap:\r
281 return None\r
282 return self.SkuIdMap.get(skuname)[0]\r
283 def GetDefaultStoreId(self,dname):\r
284 if dname not in self.DefaultStoreMap:\r
285 return None\r
286 return self.DefaultStoreMap.get(dname)[0]\r
287 def PACK_DELTA_DATA(self,skuname,defaultstoragename,delta_list):\r
288 skuid = self.GetSkuId(skuname)\r
289 defaultstorageid = self.GetDefaultStoreId(defaultstoragename)\r
34952f49 290 Buffer = ""\r
8518bf0b 291 Buffer += pack("=L",8)\r
34952f49 292 Buffer += pack("=H",int(skuid))\r
8518bf0b 293 Buffer += pack("=H",int(defaultstorageid))\r
34952f49
LG
294 for (delta_offset,value) in delta_list:\r
295 Buffer += pack("=L",delta_offset)\r
296 Buffer = Buffer[:-1] + pack("=B",value)\r
297\r
298 Buffer = pack("=L",len(Buffer) + 4) + Buffer\r
299\r
300 return Buffer\r
301\r
302 def AlignData(self,data, align = 4):\r
303 mybuffer = data\r
304 for i in range(len(data) % align):\r
305 mybuffer += pack("=B",0)\r
306\r
307 return mybuffer\r
308\r
309 def PACK_VARIABLE_NAME(self, var_name):\r
310 Buffer = ""\r
311 for name_char in var_name.strip("{").strip("}").split(","):\r
312 Buffer += pack("=B",int(name_char,16))\r
313\r
8518bf0b 314 return Buffer\r