]> git.proxmox.com Git - mirror_edk2.git/blob - BaseTools/Source/Python/AutoGen/AutoGen.py
projects / mirror_edk2.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
BaseTools: The token values cannot be numeric same with different PCDs.
[mirror_edk2.git] / BaseTools / Source / Python / AutoGen / AutoGen.py
1 ## @file
2 # Generate AutoGen.h, AutoGen.c and *.depex files
3 #
4 # Copyright (c) 2007 - 2015, Intel Corporation. All rights reserved.<BR>
5 # This program and the accompanying materials
6 # are licensed and made available under the terms and conditions of the BSD License
7 # which accompanies this distribution. The full text of the license may be found at
8 # http://opensource.org/licenses/bsd-license.php
9 #
10 # THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 # WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
12 #
13
14 ## Import Modules
15 #
16 import Common.LongFilePathOs as os
17 import re
18 import os.path as path
19 import copy
20 import uuid
21
22 import GenC
23 import GenMake
24 import GenDepex
25 from StringIO import StringIO
26
27 from StrGather import *
28 from BuildEngine import BuildRule
29
30 from Common.LongFilePathSupport import CopyLongFilePath
31 from Common.BuildToolError import *
32 from Common.DataType import *
33 from Common.Misc import *
34 from Common.String import *
35 import Common.GlobalData as GlobalData
36 from GenFds.FdfParser import *
37 from CommonDataClass.CommonClass import SkuInfoClass
38 from Workspace.BuildClassObject import *
39 from GenPatchPcdTable.GenPatchPcdTable import parsePcdInfoFromMapFile
40 import Common.VpdInfoFile as VpdInfoFile
41 from GenPcdDb import CreatePcdDatabaseCode
42 from Workspace.MetaFileCommentParser import UsageList
43
44 import InfSectionParser
45
46 ## Regular expression for splitting Dependency Expression string into tokens
47 gDepexTokenPattern = re.compile("(\(|\)|\w+| \S+\.inf)")
48
49 #
50 # Match name = variable
51 #
52 gEfiVarStoreNamePattern = re.compile("\s*name\s*=\s*(\w+)")
53 #
54 # The format of guid in efivarstore statement likes following and must be correct:
55 # guid = {0xA04A27f4, 0xDF00, 0x4D42, {0xB5, 0x52, 0x39, 0x51, 0x13, 0x02, 0x11, 0x3D}}
56 #
57 gEfiVarStoreGuidPattern = re.compile("\s*guid\s*=\s*({.*?{.*?}\s*})")
58
59 ## Mapping Makefile type
60 gMakeTypeMap = {"MSFT":"nmake", "GCC":"gmake"}
61
62
63 ## Build rule configuration file
64 gDefaultBuildRuleFile = 'Conf/build_rule.txt'
65
66 ## Build rule default version
67 AutoGenReqBuildRuleVerNum = "0.1"
68
69 ## default file name for AutoGen
70 gAutoGenCodeFileName = "AutoGen.c"
71 gAutoGenHeaderFileName = "AutoGen.h"
72 gAutoGenStringFileName = "%(module_name)sStrDefs.h"
73 gAutoGenStringFormFileName = "%(module_name)sStrDefs.hpk"
74 gAutoGenDepexFileName = "%(module_name)s.depex"
75
76 gInfSpecVersion = "0x00010017"
77
78 #
79 # Template string to generic AsBuilt INF
80 #
81 gAsBuiltInfHeaderString = TemplateString("""${header_comments}
82
83 # DO NOT EDIT
84 # FILE auto-generated
85
86 [Defines]
87 INF_VERSION = ${module_inf_version}
88 BASE_NAME = ${module_name}
89 FILE_GUID = ${module_guid}
90 MODULE_TYPE = ${module_module_type}${BEGIN}
91 VERSION_STRING = ${module_version_string}${END}${BEGIN}
92 PCD_IS_DRIVER = ${pcd_is_driver_string}${END}${BEGIN}
93 UEFI_SPECIFICATION_VERSION = ${module_uefi_specification_version}${END}${BEGIN}
94 PI_SPECIFICATION_VERSION = ${module_pi_specification_version}${END}${BEGIN}
95 ENTRY_POINT = ${module_entry_point}${END}${BEGIN}
96 UNLOAD_IMAGE = ${module_unload_image}${END}${BEGIN}
97 CONSTRUCTOR = ${module_constructor}${END}${BEGIN}
98 DESTRUCTOR = ${module_destructor}${END}${BEGIN}
99 SHADOW = ${module_shadow}${END}${BEGIN}
100 PCI_VENDOR_ID = ${module_pci_vendor_id}${END}${BEGIN}
101 PCI_DEVICE_ID = ${module_pci_device_id}${END}${BEGIN}
102 PCI_CLASS_CODE = ${module_pci_class_code}${END}${BEGIN}
103 PCI_REVISION = ${module_pci_revision}${END}${BEGIN}
104 BUILD_NUMBER = ${module_build_number}${END}${BEGIN}
105 SPEC = ${module_spec}${END}${BEGIN}
106 UEFI_HII_RESOURCE_SECTION = ${module_uefi_hii_resource_section}${END}${BEGIN}
107 MODULE_UNI_FILE = ${module_uni_file}${END}
108
109 [Packages.${module_arch}]${BEGIN}
110 ${package_item}${END}
111
112 [Binaries.${module_arch}]${BEGIN}
113 ${binary_item}${END}
114
115 [PatchPcd.${module_arch}]${BEGIN}
116 ${patchablepcd_item}
117 ${END}
118
119 [Protocols.${module_arch}]${BEGIN}
120 ${protocol_item}
121 ${END}
122
123 [Ppis.${module_arch}]${BEGIN}
124 ${ppi_item}
125 ${END}
126
127 [Guids.${module_arch}]${BEGIN}
128 ${guid_item}
129 ${END}
130
131 [PcdEx.${module_arch}]${BEGIN}
132 ${pcd_item}
133 ${END}
134
135 [LibraryClasses.${module_arch}]
136 ## @LIB_INSTANCES${BEGIN}
137 # ${libraryclasses_item}${END}
138
139 ${depexsection_item}
140
141 ${tail_comments}
142
143 [BuildOptions.${module_arch}]
144 ## @AsBuilt${BEGIN}
145 ## ${flags_item}${END}
146 """)
147
148 ## Base class for AutoGen
149 #
150 # This class just implements the cache mechanism of AutoGen objects.
151 #
152 class AutoGen(object):
153 # database to maintain the objects of xxxAutoGen
154 _CACHE_ = {} # (BuildTarget, ToolChain) : {ARCH : {platform file: AutoGen object}}}
155
156 ## Factory method
157 #
158 # @param Class class object of real AutoGen class
159 # (WorkspaceAutoGen, ModuleAutoGen or PlatformAutoGen)
160 # @param Workspace Workspace directory or WorkspaceAutoGen object
161 # @param MetaFile The path of meta file
162 # @param Target Build target
163 # @param Toolchain Tool chain name
164 # @param Arch Target arch
165 # @param *args The specific class related parameters
166 # @param **kwargs The specific class related dict parameters
167 #
168 def __new__(Class, Workspace, MetaFile, Target, Toolchain, Arch, *args, **kwargs):
169 # check if the object has been created
170 Key = (Target, Toolchain)
171 if Key not in Class._CACHE_ or Arch not in Class._CACHE_[Key] \
172 or MetaFile not in Class._CACHE_[Key][Arch]:
173 AutoGenObject = super(AutoGen, Class).__new__(Class)
174 # call real constructor
175 if not AutoGenObject._Init(Workspace, MetaFile, Target, Toolchain, Arch, *args, **kwargs):
176 return None
177 if Key not in Class._CACHE_:
178 Class._CACHE_[Key] = {}
179 if Arch not in Class._CACHE_[Key]:
180 Class._CACHE_[Key][Arch] = {}
181 Class._CACHE_[Key][Arch][MetaFile] = AutoGenObject
182 else:
183 AutoGenObject = Class._CACHE_[Key][Arch][MetaFile]
184
185 return AutoGenObject
186
187 ## hash() operator
188 #
189 # The file path of platform file will be used to represent hash value of this object
190 #
191 # @retval int Hash value of the file path of platform file
192 #
193 def __hash__(self):
194 return hash(self.MetaFile)
195
196 ## str() operator
197 #
198 # The file path of platform file will be used to represent this object
199 #
200 # @retval string String of platform file path
201 #
202 def __str__(self):
203 return str(self.MetaFile)
204
205 ## "==" operator
206 def __eq__(self, Other):
207 return Other and self.MetaFile == Other
208
209 ## Workspace AutoGen class
210 #
211 # This class is used mainly to control the whole platform build for different
212 # architecture. This class will generate top level makefile.
213 #
214 class WorkspaceAutoGen(AutoGen):
215 ## Real constructor of WorkspaceAutoGen
216 #
217 # This method behaves the same as __init__ except that it needs explicit invoke
218 # (in super class's __new__ method)
219 #
220 # @param WorkspaceDir Root directory of workspace
221 # @param ActivePlatform Meta-file of active platform
222 # @param Target Build target
223 # @param Toolchain Tool chain name
224 # @param ArchList List of architecture of current build
225 # @param MetaFileDb Database containing meta-files
226 # @param BuildConfig Configuration of build
227 # @param ToolDefinition Tool chain definitions
228 # @param FlashDefinitionFile File of flash definition
229 # @param Fds FD list to be generated
230 # @param Fvs FV list to be generated
231 # @param Caps Capsule list to be generated
232 # @param SkuId SKU id from command line
233 #
234 def _Init(self, WorkspaceDir, ActivePlatform, Target, Toolchain, ArchList, MetaFileDb,
235 BuildConfig, ToolDefinition, FlashDefinitionFile='', Fds=None, Fvs=None, Caps=None, SkuId='', UniFlag=None,
236 Progress=None, BuildModule=None):
237 if Fds is None:
238 Fds = []
239 if Fvs is None:
240 Fvs = []
241 if Caps is None:
242 Caps = []
243 self.BuildDatabase = MetaFileDb
244 self.MetaFile = ActivePlatform
245 self.WorkspaceDir = WorkspaceDir
246 self.Platform = self.BuildDatabase[self.MetaFile, 'COMMON', Target, Toolchain]
247 GlobalData.gActivePlatform = self.Platform
248 self.BuildTarget = Target
249 self.ToolChain = Toolchain
250 self.ArchList = ArchList
251 self.SkuId = SkuId
252 self.UniFlag = UniFlag
253
254 self.TargetTxt = BuildConfig
255 self.ToolDef = ToolDefinition
256 self.FdfFile = FlashDefinitionFile
257 self.FdTargetList = Fds
258 self.FvTargetList = Fvs
259 self.CapTargetList = Caps
260 self.AutoGenObjectList = []
261
262 # there's many relative directory operations, so ...
263 os.chdir(self.WorkspaceDir)
264
265 #
266 # Merge Arch
267 #
268 if not self.ArchList:
269 ArchList = set(self.Platform.SupArchList)
270 else:
271 ArchList = set(self.ArchList) & set(self.Platform.SupArchList)
272 if not ArchList:
273 EdkLogger.error("build", PARAMETER_INVALID,
274 ExtraData = "Invalid ARCH specified. [Valid ARCH: %s]" % (" ".join(self.Platform.SupArchList)))
275 elif self.ArchList and len(ArchList) != len(self.ArchList):
276 SkippedArchList = set(self.ArchList).symmetric_difference(set(self.Platform.SupArchList))
277 EdkLogger.verbose("\nArch [%s] is ignored because the platform supports [%s] only!"
278 % (" ".join(SkippedArchList), " ".join(self.Platform.SupArchList)))
279 self.ArchList = tuple(ArchList)
280
281 # Validate build target
282 if self.BuildTarget not in self.Platform.BuildTargets:
283 EdkLogger.error("build", PARAMETER_INVALID,
284 ExtraData="Build target [%s] is not supported by the platform. [Valid target: %s]"
285 % (self.BuildTarget, " ".join(self.Platform.BuildTargets)))
286
287
288 # parse FDF file to get PCDs in it, if any
289 if not self.FdfFile:
290 self.FdfFile = self.Platform.FlashDefinition
291
292 EdkLogger.info("")
293 if self.ArchList:
294 EdkLogger.info('%-16s = %s' % ("Architecture(s)", ' '.join(self.ArchList)))
295 EdkLogger.info('%-16s = %s' % ("Build target", self.BuildTarget))
296 EdkLogger.info('%-16s = %s' % ("Toolchain",self.ToolChain))
297
298 EdkLogger.info('\n%-24s = %s' % ("Active Platform", self.Platform))
299 if BuildModule:
300 EdkLogger.info('%-24s = %s' % ("Active Module", BuildModule))
301
302 if self.FdfFile:
303 EdkLogger.info('%-24s = %s' % ("Flash Image Definition", self.FdfFile))
304
305 EdkLogger.verbose("\nFLASH_DEFINITION = %s" % self.FdfFile)
306
307 if Progress:
308 Progress.Start("\nProcessing meta-data")
309
310 if self.FdfFile:
311 #
312 # Mark now build in AutoGen Phase
313 #
314 GlobalData.gAutoGenPhase = True
315 Fdf = FdfParser(self.FdfFile.Path)
316 Fdf.ParseFile()
317 GlobalData.gFdfParser = Fdf
318 GlobalData.gAutoGenPhase = False
319 PcdSet = Fdf.Profile.PcdDict
320 ModuleList = Fdf.Profile.InfList
321 self.FdfProfile = Fdf.Profile
322 for fvname in self.FvTargetList:
323 if fvname.upper() not in self.FdfProfile.FvDict:
324 EdkLogger.error("build", OPTION_VALUE_INVALID,
325 "No such an FV in FDF file: %s" % fvname)
326 else:
327 PcdSet = {}
328 ModuleList = []
329 self.FdfProfile = None
330 if self.FdTargetList:
331 EdkLogger.info("No flash definition file found. FD [%s] will be ignored." % " ".join(self.FdTargetList))
332 self.FdTargetList = []
333 if self.FvTargetList:
334 EdkLogger.info("No flash definition file found. FV [%s] will be ignored." % " ".join(self.FvTargetList))
335 self.FvTargetList = []
336 if self.CapTargetList:
337 EdkLogger.info("No flash definition file found. Capsule [%s] will be ignored." % " ".join(self.CapTargetList))
338 self.CapTargetList = []
339
340 # apply SKU and inject PCDs from Flash Definition file
341 for Arch in self.ArchList:
342 Platform = self.BuildDatabase[self.MetaFile, Arch, Target, Toolchain]
343
344 DecPcds = {}
345 DecPcdsKey = set()
346 PGen = PlatformAutoGen(self, self.MetaFile, Target, Toolchain, Arch)
347 #Collect package set information from INF of FDF
348 PkgSet = set()
349 for Inf in ModuleList:
350 ModuleFile = PathClass(NormPath(Inf), GlobalData.gWorkspace, Arch)
351 if ModuleFile in Platform.Modules:
352 continue
353 ModuleData = self.BuildDatabase[ModuleFile, Arch, Target, Toolchain]
354 PkgSet.update(ModuleData.Packages)
355 Pkgs = list(PkgSet) + list(PGen.PackageList)
356 for Pkg in Pkgs:
357 for Pcd in Pkg.Pcds:
358 DecPcds[Pcd[0], Pcd[1]] = Pkg.Pcds[Pcd]
359 DecPcdsKey.add((Pcd[0], Pcd[1], Pcd[2]))
360
361 Platform.SkuName = self.SkuId
362 for Name, Guid in PcdSet:
363 if (Name, Guid) not in DecPcds:
364 EdkLogger.error(
365 'build',
366 PARSER_ERROR,
367 "PCD (%s.%s) used in FDF is not declared in DEC files." % (Guid, Name),
368 File = self.FdfProfile.PcdFileLineDict[Name, Guid][0],
369 Line = self.FdfProfile.PcdFileLineDict[Name, Guid][1]
370 )
371 else:
372 # Check whether Dynamic or DynamicEx PCD used in FDF file. If used, build break and give a error message.
373 if (Name, Guid, TAB_PCDS_FIXED_AT_BUILD) in DecPcdsKey \
374 or (Name, Guid, TAB_PCDS_PATCHABLE_IN_MODULE) in DecPcdsKey \
375 or (Name, Guid, TAB_PCDS_FEATURE_FLAG) in DecPcdsKey:
376 Platform.AddPcd(Name, Guid, PcdSet[Name, Guid])
377 continue
378 elif (Name, Guid, TAB_PCDS_DYNAMIC) in DecPcdsKey or (Name, Guid, TAB_PCDS_DYNAMIC_EX) in DecPcdsKey:
379 EdkLogger.error(
380 'build',
381 PARSER_ERROR,
382 "Using Dynamic or DynamicEx type of PCD [%s.%s] in FDF file is not allowed." % (Guid, Name),
383 File = self.FdfProfile.PcdFileLineDict[Name, Guid][0],
384 Line = self.FdfProfile.PcdFileLineDict[Name, Guid][1]
385 )
386
387 Pa = PlatformAutoGen(self, self.MetaFile, Target, Toolchain, Arch)
388 #
389 # Explicitly collect platform's dynamic PCDs
390 #
391 Pa.CollectPlatformDynamicPcds()
392 Pa.CollectFixedAtBuildPcds()
393 self.AutoGenObjectList.append(Pa)
394
395 #
396 # Check PCDs token value conflict in each DEC file.
397 #
398 self._CheckAllPcdsTokenValueConflict()
399
400 #
401 # Check PCD type and definition between DSC and DEC
402 #
403 self._CheckPcdDefineAndType()
404
405 # if self.FdfFile:
406 # self._CheckDuplicateInFV(Fdf)
407
408 self._BuildDir = None
409 self._FvDir = None
410 self._MakeFileDir = None
411 self._BuildCommand = None
412
413 return True
414
415 ## _CheckDuplicateInFV() method
416 #
417 # Check whether there is duplicate modules/files exist in FV section.
418 # The check base on the file GUID;
419 #
420 def _CheckDuplicateInFV(self, Fdf):
421 for Fv in Fdf.Profile.FvDict:
422 _GuidDict = {}
423 for FfsFile in Fdf.Profile.FvDict[Fv].FfsList:
424 if FfsFile.InfFileName and FfsFile.NameGuid == None:
425 #
426 # Get INF file GUID
427 #
428 InfFoundFlag = False
429 for Pa in self.AutoGenObjectList:
430 if InfFoundFlag:
431 break
432 for Module in Pa.ModuleAutoGenList:
433 if path.normpath(Module.MetaFile.File) == path.normpath(FfsFile.InfFileName):
434 InfFoundFlag = True
435 if not Module.Guid.upper() in _GuidDict.keys():
436 _GuidDict[Module.Guid.upper()] = FfsFile
437 break
438 else:
439 EdkLogger.error("build",
440 FORMAT_INVALID,
441 "Duplicate GUID found for these lines: Line %d: %s and Line %d: %s. GUID: %s"%(FfsFile.CurrentLineNum,
442 FfsFile.CurrentLineContent,
443 _GuidDict[Module.Guid.upper()].CurrentLineNum,
444 _GuidDict[Module.Guid.upper()].CurrentLineContent,
445 Module.Guid.upper()),
446 ExtraData=self.FdfFile)
447 #
448 # Some INF files not have entity in DSC file.
449 #
450 if not InfFoundFlag:
451 if FfsFile.InfFileName.find('$') == -1:
452 InfPath = NormPath(FfsFile.InfFileName)
453 if not os.path.exists(InfPath):
454 EdkLogger.error('build', GENFDS_ERROR, "Non-existant Module %s !" % (FfsFile.InfFileName))
455
456 PathClassObj = PathClass(FfsFile.InfFileName, self.WorkspaceDir)
457 #
458 # Here we just need to get FILE_GUID from INF file, use 'COMMON' as ARCH attribute. and use
459 # BuildObject from one of AutoGenObjectList is enough.
460 #
461 InfObj = self.AutoGenObjectList[0].BuildDatabase.WorkspaceDb.BuildObject[PathClassObj, 'COMMON', self.BuildTarget, self.ToolChain]
462 if not InfObj.Guid.upper() in _GuidDict.keys():
463 _GuidDict[InfObj.Guid.upper()] = FfsFile
464 else:
465 EdkLogger.error("build",
466 FORMAT_INVALID,
467 "Duplicate GUID found for these lines: Line %d: %s and Line %d: %s. GUID: %s"%(FfsFile.CurrentLineNum,
468 FfsFile.CurrentLineContent,
469 _GuidDict[InfObj.Guid.upper()].CurrentLineNum,
470 _GuidDict[InfObj.Guid.upper()].CurrentLineContent,
471 InfObj.Guid.upper()),
472 ExtraData=self.FdfFile)
473 InfFoundFlag = False
474
475 if FfsFile.NameGuid != None:
476 _CheckPCDAsGuidPattern = re.compile("^PCD\(.+\..+\)$")
477
478 #
479 # If the NameGuid reference a PCD name.
480 # The style must match: PCD(xxxx.yyy)
481 #
482 if _CheckPCDAsGuidPattern.match(FfsFile.NameGuid):
483 #
484 # Replace the PCD value.
485 #
486 _PcdName = FfsFile.NameGuid.lstrip("PCD(").rstrip(")")
487 PcdFoundFlag = False
488 for Pa in self.AutoGenObjectList:
489 if not PcdFoundFlag:
490 for PcdItem in Pa.AllPcdList:
491 if (PcdItem.TokenSpaceGuidCName + "." + PcdItem.TokenCName) == _PcdName:
492 #
493 # First convert from CFormatGuid to GUID string
494 #
495 _PcdGuidString = GuidStructureStringToGuidString(PcdItem.DefaultValue)
496
497 if not _PcdGuidString:
498 #
499 # Then try Byte array.
500 #
501 _PcdGuidString = GuidStructureByteArrayToGuidString(PcdItem.DefaultValue)
502
503 if not _PcdGuidString:
504 #
505 # Not Byte array or CFormat GUID, raise error.
506 #
507 EdkLogger.error("build",
508 FORMAT_INVALID,
509 "The format of PCD value is incorrect. PCD: %s , Value: %s\n"%(_PcdName, PcdItem.DefaultValue),
510 ExtraData=self.FdfFile)
511
512 if not _PcdGuidString.upper() in _GuidDict.keys():
513 _GuidDict[_PcdGuidString.upper()] = FfsFile
514 PcdFoundFlag = True
515 break
516 else:
517 EdkLogger.error("build",
518 FORMAT_INVALID,
519 "Duplicate GUID found for these lines: Line %d: %s and Line %d: %s. GUID: %s"%(FfsFile.CurrentLineNum,
520 FfsFile.CurrentLineContent,
521 _GuidDict[_PcdGuidString.upper()].CurrentLineNum,
522 _GuidDict[_PcdGuidString.upper()].CurrentLineContent,
523 FfsFile.NameGuid.upper()),
524 ExtraData=self.FdfFile)
525
526 if not FfsFile.NameGuid.upper() in _GuidDict.keys():
527 _GuidDict[FfsFile.NameGuid.upper()] = FfsFile
528 else:
529 #
530 # Two raw file GUID conflict.
531 #
532 EdkLogger.error("build",
533 FORMAT_INVALID,
534 "Duplicate GUID found for these lines: Line %d: %s and Line %d: %s. GUID: %s"%(FfsFile.CurrentLineNum,
535 FfsFile.CurrentLineContent,
536 _GuidDict[FfsFile.NameGuid.upper()].CurrentLineNum,
537 _GuidDict[FfsFile.NameGuid.upper()].CurrentLineContent,
538 FfsFile.NameGuid.upper()),
539 ExtraData=self.FdfFile)
540
541
542 def _CheckPcdDefineAndType(self):
543 PcdTypeList = [
544 "FixedAtBuild", "PatchableInModule", "FeatureFlag",
545 "Dynamic", #"DynamicHii", "DynamicVpd",
546 "DynamicEx", # "DynamicExHii", "DynamicExVpd"
547 ]
548
549 # This dict store PCDs which are not used by any modules with specified arches
550 UnusedPcd = sdict()
551 for Pa in self.AutoGenObjectList:
552 # Key of DSC's Pcds dictionary is PcdCName, TokenSpaceGuid
553 for Pcd in Pa.Platform.Pcds:
554 PcdType = Pa.Platform.Pcds[Pcd].Type
555
556 # If no PCD type, this PCD comes from FDF
557 if not PcdType:
558 continue
559
560 # Try to remove Hii and Vpd suffix
561 if PcdType.startswith("DynamicEx"):
562 PcdType = "DynamicEx"
563 elif PcdType.startswith("Dynamic"):
564 PcdType = "Dynamic"
565
566 for Package in Pa.PackageList:
567 # Key of DEC's Pcds dictionary is PcdCName, TokenSpaceGuid, PcdType
568 if (Pcd[0], Pcd[1], PcdType) in Package.Pcds:
569 break
570 for Type in PcdTypeList:
571 if (Pcd[0], Pcd[1], Type) in Package.Pcds:
572 EdkLogger.error(
573 'build',
574 FORMAT_INVALID,
575 "Type [%s] of PCD [%s.%s] in DSC file doesn't match the type [%s] defined in DEC file." \
576 % (Pa.Platform.Pcds[Pcd].Type, Pcd[1], Pcd[0], Type),
577 ExtraData=None
578 )
579 return
580 else:
581 UnusedPcd.setdefault(Pcd, []).append(Pa.Arch)
582
583 for Pcd in UnusedPcd:
584 EdkLogger.warn(
585 'build',
586 "The PCD was not specified by any INF module in the platform for the given architecture.\n"
587 "\tPCD: [%s.%s]\n\tPlatform: [%s]\n\tArch: %s"
588 % (Pcd[1], Pcd[0], os.path.basename(str(self.MetaFile)), str(UnusedPcd[Pcd])),
589 ExtraData=None
590 )
591
592 def __repr__(self):
593 return "%s [%s]" % (self.MetaFile, ", ".join(self.ArchList))
594
595 ## Return the directory to store FV files
596 def _GetFvDir(self):
597 if self._FvDir == None:
598 self._FvDir = path.join(self.BuildDir, 'FV')
599 return self._FvDir
600
601 ## Return the directory to store all intermediate and final files built
602 def _GetBuildDir(self):
603 return self.AutoGenObjectList[0].BuildDir
604
605 ## Return the build output directory platform specifies
606 def _GetOutputDir(self):
607 return self.Platform.OutputDirectory
608
609 ## Return platform name
610 def _GetName(self):
611 return self.Platform.PlatformName
612
613 ## Return meta-file GUID
614 def _GetGuid(self):
615 return self.Platform.Guid
616
617 ## Return platform version
618 def _GetVersion(self):
619 return self.Platform.Version
620
621 ## Return paths of tools
622 def _GetToolDefinition(self):
623 return self.AutoGenObjectList[0].ToolDefinition
624
625 ## Return directory of platform makefile
626 #
627 # @retval string Makefile directory
628 #
629 def _GetMakeFileDir(self):
630 if self._MakeFileDir == None:
631 self._MakeFileDir = self.BuildDir
632 return self._MakeFileDir
633
634 ## Return build command string
635 #
636 # @retval string Build command string
637 #
638 def _GetBuildCommand(self):
639 if self._BuildCommand == None:
640 # BuildCommand should be all the same. So just get one from platform AutoGen
641 self._BuildCommand = self.AutoGenObjectList[0].BuildCommand
642 return self._BuildCommand
643
644 ## Check the PCDs token value conflict in each DEC file.
645 #
646 # Will cause build break and raise error message while two PCDs conflict.
647 #
648 # @return None
649 #
650 def _CheckAllPcdsTokenValueConflict(self):
651 for Pa in self.AutoGenObjectList:
652 for Package in Pa.PackageList:
653 PcdList = Package.Pcds.values()
654 PcdList.sort(lambda x, y: cmp(int(x.TokenValue, 0), int(y.TokenValue, 0)))
655 Count = 0
656 while (Count < len(PcdList) - 1) :
657 Item = PcdList[Count]
658 ItemNext = PcdList[Count + 1]
659 #
660 # Make sure in the same token space the TokenValue should be unique
661 #
662 if (int(Item.TokenValue, 0) == int(ItemNext.TokenValue, 0)):
663 SameTokenValuePcdList = []
664 SameTokenValuePcdList.append(Item)
665 SameTokenValuePcdList.append(ItemNext)
666 RemainPcdListLength = len(PcdList) - Count - 2
667 for ValueSameCount in range(RemainPcdListLength):
668 if int(PcdList[len(PcdList) - RemainPcdListLength + ValueSameCount].TokenValue, 0) == int(Item.TokenValue, 0):
669 SameTokenValuePcdList.append(PcdList[len(PcdList) - RemainPcdListLength + ValueSameCount])
670 else:
671 break;
672 #
673 # Sort same token value PCD list with TokenGuid and TokenCName
674 #
675 SameTokenValuePcdList.sort(lambda x, y: cmp("%s.%s"%(x.TokenSpaceGuidCName, x.TokenCName), "%s.%s"%(y.TokenSpaceGuidCName, y.TokenCName)))
676 SameTokenValuePcdListCount = 0
677 while (SameTokenValuePcdListCount < len(SameTokenValuePcdList) - 1):
678 TemListItem = SameTokenValuePcdList[SameTokenValuePcdListCount]
679 TemListItemNext = SameTokenValuePcdList[SameTokenValuePcdListCount + 1]
680
681 if (TemListItem.TokenSpaceGuidCName == TemListItemNext.TokenSpaceGuidCName) and (TemListItem.TokenCName != TemListItemNext.TokenCName):
682 EdkLogger.error(
683 'build',
684 FORMAT_INVALID,
685 "The TokenValue [%s] of PCD [%s.%s] is conflict with: [%s.%s] in %s"\
686 % (TemListItem.TokenValue, TemListItem.TokenSpaceGuidCName, TemListItem.TokenCName, TemListItemNext.TokenSpaceGuidCName, TemListItemNext.TokenCName, Package),
687 ExtraData=None
688 )
689 SameTokenValuePcdListCount += 1
690 Count += SameTokenValuePcdListCount
691 Count += 1
692
693 PcdList = Package.Pcds.values()
694 PcdList.sort(lambda x, y: cmp("%s.%s"%(x.TokenSpaceGuidCName, x.TokenCName), "%s.%s"%(y.TokenSpaceGuidCName, y.TokenCName)))
695 Count = 0
696 while (Count < len(PcdList) - 1) :
697 Item = PcdList[Count]
698 ItemNext = PcdList[Count + 1]
699 #
700 # Check PCDs with same TokenSpaceGuidCName.TokenCName have same token value as well.
701 #
702 if (Item.TokenSpaceGuidCName == ItemNext.TokenSpaceGuidCName) and (Item.TokenCName == ItemNext.TokenCName) and (int(Item.TokenValue, 0) != int(ItemNext.TokenValue, 0)):
703 EdkLogger.error(
704 'build',
705 FORMAT_INVALID,
706 "The TokenValue [%s] of PCD [%s.%s] in %s defined in two places should be same as well."\
707 % (Item.TokenValue, Item.TokenSpaceGuidCName, Item.TokenCName, Package),
708 ExtraData=None
709 )
710 Count += 1
711 ## Generate fds command
712 def _GenFdsCommand(self):
713 return (GenMake.TopLevelMakefile(self)._TEMPLATE_.Replace(GenMake.TopLevelMakefile(self)._TemplateDict)).strip()
714
715 ## Create makefile for the platform and modules in it
716 #
717 # @param CreateDepsMakeFile Flag indicating if the makefile for
718 # modules will be created as well
719 #
720 def CreateMakeFile(self, CreateDepsMakeFile=False):
721 if CreateDepsMakeFile:
722 for Pa in self.AutoGenObjectList:
723 Pa.CreateMakeFile(CreateDepsMakeFile)
724
725 ## Create autogen code for platform and modules
726 #
727 # Since there's no autogen code for platform, this method will do nothing
728 # if CreateModuleCodeFile is set to False.
729 #
730 # @param CreateDepsCodeFile Flag indicating if creating module's
731 # autogen code file or not
732 #
733 def CreateCodeFile(self, CreateDepsCodeFile=False):
734 if not CreateDepsCodeFile:
735 return
736 for Pa in self.AutoGenObjectList:
737 Pa.CreateCodeFile(CreateDepsCodeFile)
738
739 ## Create AsBuilt INF file the platform
740 #
741 def CreateAsBuiltInf(self):
742 return
743
744 Name = property(_GetName)
745 Guid = property(_GetGuid)
746 Version = property(_GetVersion)
747 OutputDir = property(_GetOutputDir)
748
749 ToolDefinition = property(_GetToolDefinition) # toolcode : tool path
750
751 BuildDir = property(_GetBuildDir)
752 FvDir = property(_GetFvDir)
753 MakeFileDir = property(_GetMakeFileDir)
754 BuildCommand = property(_GetBuildCommand)
755 GenFdsCommand = property(_GenFdsCommand)
756
757 ## AutoGen class for platform
758 #
759 # PlatformAutoGen class will process the original information in platform
760 # file in order to generate makefile for platform.
761 #
762 class PlatformAutoGen(AutoGen):
763 #
764 # Used to store all PCDs for both PEI and DXE phase, in order to generate
765 # correct PCD database
766 #
767 _DynaPcdList_ = []
768 _NonDynaPcdList_ = []
769
770 #
771 # The priority list while override build option
772 #
773 PrioList = {"0x11111" : 16, # TARGET_TOOLCHAIN_ARCH_COMMANDTYPE_ATTRIBUTE (Highest)
774 "0x01111" : 15, # ******_TOOLCHAIN_ARCH_COMMANDTYPE_ATTRIBUTE
775 "0x10111" : 14, # TARGET_*********_ARCH_COMMANDTYPE_ATTRIBUTE
776 "0x00111" : 13, # ******_*********_ARCH_COMMANDTYPE_ATTRIBUTE
777 "0x11011" : 12, # TARGET_TOOLCHAIN_****_COMMANDTYPE_ATTRIBUTE
778 "0x01011" : 11, # ******_TOOLCHAIN_****_COMMANDTYPE_ATTRIBUTE
779 "0x10011" : 10, # TARGET_*********_****_COMMANDTYPE_ATTRIBUTE
780 "0x00011" : 9, # ******_*********_****_COMMANDTYPE_ATTRIBUTE
781 "0x11101" : 8, # TARGET_TOOLCHAIN_ARCH_***********_ATTRIBUTE
782 "0x01101" : 7, # ******_TOOLCHAIN_ARCH_***********_ATTRIBUTE
783 "0x10101" : 6, # TARGET_*********_ARCH_***********_ATTRIBUTE
784 "0x00101" : 5, # ******_*********_ARCH_***********_ATTRIBUTE
785 "0x11001" : 4, # TARGET_TOOLCHAIN_****_***********_ATTRIBUTE
786 "0x01001" : 3, # ******_TOOLCHAIN_****_***********_ATTRIBUTE
787 "0x10001" : 2, # TARGET_*********_****_***********_ATTRIBUTE
788 "0x00001" : 1} # ******_*********_****_***********_ATTRIBUTE (Lowest)
789
790 ## The real constructor of PlatformAutoGen
791 #
792 # This method is not supposed to be called by users of PlatformAutoGen. It's
793 # only used by factory method __new__() to do real initialization work for an
794 # object of PlatformAutoGen
795 #
796 # @param Workspace WorkspaceAutoGen object
797 # @param PlatformFile Platform file (DSC file)
798 # @param Target Build target (DEBUG, RELEASE)
799 # @param Toolchain Name of tool chain
800 # @param Arch arch of the platform supports
801 #
802 def _Init(self, Workspace, PlatformFile, Target, Toolchain, Arch):
803 EdkLogger.debug(EdkLogger.DEBUG_9, "AutoGen platform [%s] [%s]" % (PlatformFile, Arch))
804 GlobalData.gProcessingFile = "%s [%s, %s, %s]" % (PlatformFile, Arch, Toolchain, Target)
805
806 self.MetaFile = PlatformFile
807 self.Workspace = Workspace
808 self.WorkspaceDir = Workspace.WorkspaceDir
809 self.ToolChain = Toolchain
810 self.BuildTarget = Target
811 self.Arch = Arch
812 self.SourceDir = PlatformFile.SubDir
813 self.SourceOverrideDir = None
814 self.FdTargetList = self.Workspace.FdTargetList
815 self.FvTargetList = self.Workspace.FvTargetList
816 self.AllPcdList = []
817 # get the original module/package/platform objects
818 self.BuildDatabase = Workspace.BuildDatabase
819
820 # flag indicating if the makefile/C-code file has been created or not
821 self.IsMakeFileCreated = False
822 self.IsCodeFileCreated = False
823
824 self._Platform = None
825 self._Name = None
826 self._Guid = None
827 self._Version = None
828
829 self._BuildRule = None
830 self._SourceDir = None
831 self._BuildDir = None
832 self._OutputDir = None
833 self._FvDir = None
834 self._MakeFileDir = None
835 self._FdfFile = None
836
837 self._PcdTokenNumber = None # (TokenCName, TokenSpaceGuidCName) : GeneratedTokenNumber
838 self._DynamicPcdList = None # [(TokenCName1, TokenSpaceGuidCName1), (TokenCName2, TokenSpaceGuidCName2), ...]
839 self._NonDynamicPcdList = None # [(TokenCName1, TokenSpaceGuidCName1), (TokenCName2, TokenSpaceGuidCName2), ...]
840 self._NonDynamicPcdDict = {}
841
842 self._ToolDefinitions = None
843 self._ToolDefFile = None # toolcode : tool path
844 self._ToolChainFamily = None
845 self._BuildRuleFamily = None
846 self._BuildOption = None # toolcode : option
847 self._EdkBuildOption = None # edktoolcode : option
848 self._EdkIIBuildOption = None # edkiitoolcode : option
849 self._PackageList = None
850 self._ModuleAutoGenList = None
851 self._LibraryAutoGenList = None
852 self._BuildCommand = None
853 self._AsBuildInfList = []
854 self._AsBuildModuleList = []
855 if GlobalData.gFdfParser != None:
856 self._AsBuildInfList = GlobalData.gFdfParser.Profile.InfList
857 for Inf in self._AsBuildInfList:
858 InfClass = PathClass(NormPath(Inf), GlobalData.gWorkspace, self.Arch)
859 M = self.BuildDatabase[InfClass, self.Arch, self.BuildTarget, self.ToolChain]
860 if not M.IsSupportedArch:
861 continue
862 self._AsBuildModuleList.append(InfClass)
863 # get library/modules for build
864 self.LibraryBuildDirectoryList = []
865 self.ModuleBuildDirectoryList = []
866 return True
867
868 def __repr__(self):
869 return "%s [%s]" % (self.MetaFile, self.Arch)
870
871 ## Create autogen code for platform and modules
872 #
873 # Since there's no autogen code for platform, this method will do nothing
874 # if CreateModuleCodeFile is set to False.
875 #
876 # @param CreateModuleCodeFile Flag indicating if creating module's
877 # autogen code file or not
878 #
879 def CreateCodeFile(self, CreateModuleCodeFile=False):
880 # only module has code to be greated, so do nothing if CreateModuleCodeFile is False
881 if self.IsCodeFileCreated or not CreateModuleCodeFile:
882 return
883
884 for Ma in self.ModuleAutoGenList:
885 Ma.CreateCodeFile(True)
886
887 # don't do this twice
888 self.IsCodeFileCreated = True
889
890 ## Generate Fds Command
891 def _GenFdsCommand(self):
892 return self.Workspace.GenFdsCommand
893
894 ## Create makefile for the platform and mdoules in it
895 #
896 # @param CreateModuleMakeFile Flag indicating if the makefile for
897 # modules will be created as well
898 #
899 def CreateMakeFile(self, CreateModuleMakeFile=False):
900 if CreateModuleMakeFile:
901 for ModuleFile in self.Platform.Modules:
902 Ma = ModuleAutoGen(self.Workspace, ModuleFile, self.BuildTarget,
903 self.ToolChain, self.Arch, self.MetaFile)
904 Ma.CreateMakeFile(True)
905 #Ma.CreateAsBuiltInf()
906
907 # no need to create makefile for the platform more than once
908 if self.IsMakeFileCreated:
909 return
910
911 # create library/module build dirs for platform
912 Makefile = GenMake.PlatformMakefile(self)
913 self.LibraryBuildDirectoryList = Makefile.GetLibraryBuildDirectoryList()
914 self.ModuleBuildDirectoryList = Makefile.GetModuleBuildDirectoryList()
915
916 self.IsMakeFileCreated = True
917
918 ## Deal with Shared FixedAtBuild Pcds
919 #
920 def CollectFixedAtBuildPcds(self):
921 for LibAuto in self.LibraryAutoGenList:
922 FixedAtBuildPcds = {}
923 ShareFixedAtBuildPcdsSameValue = {}
924 for Module in LibAuto._ReferenceModules:
925 for Pcd in Module.FixedAtBuildPcds + LibAuto.FixedAtBuildPcds:
926 key = ".".join((Pcd.TokenSpaceGuidCName,Pcd.TokenCName))
927 if key not in FixedAtBuildPcds:
928 ShareFixedAtBuildPcdsSameValue[key] = True
929 FixedAtBuildPcds[key] = Pcd.DefaultValue
930 else:
931 if FixedAtBuildPcds[key] != Pcd.DefaultValue:
932 ShareFixedAtBuildPcdsSameValue[key] = False
933 for Pcd in LibAuto.FixedAtBuildPcds:
934 key = ".".join((Pcd.TokenSpaceGuidCName,Pcd.TokenCName))
935 if (Pcd.TokenCName,Pcd.TokenSpaceGuidCName) not in self.NonDynamicPcdDict:
936 continue
937 else:
938 DscPcd = self.NonDynamicPcdDict[(Pcd.TokenCName,Pcd.TokenSpaceGuidCName)]
939 if DscPcd.Type != "FixedAtBuild":
940 continue
941 if key in ShareFixedAtBuildPcdsSameValue and ShareFixedAtBuildPcdsSameValue[key]:
942 LibAuto.ConstPcd[key] = Pcd.DefaultValue
943
944 ## Collect dynamic PCDs
945 #
946 # Gather dynamic PCDs list from each module and their settings from platform
947 # This interface should be invoked explicitly when platform action is created.
948 #
949 def CollectPlatformDynamicPcds(self):
950 # for gathering error information
951 NoDatumTypePcdList = set()
952 PcdNotInDb = []
953 self._GuidValue = {}
954 FdfModuleList = []
955 for InfName in self._AsBuildInfList:
956 InfName = os.path.join(self.WorkspaceDir, InfName)
957 FdfModuleList.append(os.path.normpath(InfName))
958 for F in self.Platform.Modules.keys():
959 M = ModuleAutoGen(self.Workspace, F, self.BuildTarget, self.ToolChain, self.Arch, self.MetaFile)
960 #GuidValue.update(M.Guids)
961
962 self.Platform.Modules[F].M = M
963
964 for PcdFromModule in M.ModulePcdList+M.LibraryPcdList:
965 # make sure that the "VOID*" kind of datum has MaxDatumSize set
966 if PcdFromModule.DatumType == "VOID*" and PcdFromModule.MaxDatumSize in [None, '']:
967 NoDatumTypePcdList.add("%s.%s [%s]" % (PcdFromModule.TokenSpaceGuidCName, PcdFromModule.TokenCName, F))
968
969 # Check the PCD from Binary INF or Source INF
970 if M.IsBinaryModule == True:
971 PcdFromModule.IsFromBinaryInf = True
972
973 # Check the PCD from DSC or not
974 if (PcdFromModule.TokenCName, PcdFromModule.TokenSpaceGuidCName) in self.Platform.Pcds.keys():
975 PcdFromModule.IsFromDsc = True
976 else:
977 PcdFromModule.IsFromDsc = False
978 if PcdFromModule.Type in GenC.gDynamicPcd or PcdFromModule.Type in GenC.gDynamicExPcd:
979 if F.Path not in FdfModuleList:
980 # If one of the Source built modules listed in the DSC is not listed
981 # in FDF modules, and the INF lists a PCD can only use the PcdsDynamic
982 # access method (it is only listed in the DEC file that declares the
983 # PCD as PcdsDynamic), then build tool will report warning message
984 # notify the PI that they are attempting to build a module that must
985 # be included in a flash image in order to be functional. These Dynamic
986 # PCD will not be added into the Database unless it is used by other
987 # modules that are included in the FDF file.
988 if PcdFromModule.Type in GenC.gDynamicPcd and \
989 PcdFromModule.IsFromBinaryInf == False:
990 # Print warning message to let the developer make a determine.
991 if PcdFromModule not in PcdNotInDb:
992 PcdNotInDb.append(PcdFromModule)
993 continue
994 # If one of the Source built modules listed in the DSC is not listed in
995 # FDF modules, and the INF lists a PCD can only use the PcdsDynamicEx
996 # access method (it is only listed in the DEC file that declares the
997 # PCD as PcdsDynamicEx), then DO NOT break the build; DO NOT add the
998 # PCD to the Platform's PCD Database.
999 if PcdFromModule.Type in GenC.gDynamicExPcd:
1000 if PcdFromModule not in PcdNotInDb:
1001 PcdNotInDb.append(PcdFromModule)
1002 continue
1003 #
1004 # If a dynamic PCD used by a PEM module/PEI module & DXE module,
1005 # it should be stored in Pcd PEI database, If a dynamic only
1006 # used by DXE module, it should be stored in DXE PCD database.
1007 # The default Phase is DXE
1008 #
1009 if M.ModuleType in ["PEIM", "PEI_CORE"]:
1010 PcdFromModule.Phase = "PEI"
1011 if PcdFromModule not in self._DynaPcdList_:
1012 self._DynaPcdList_.append(PcdFromModule)
1013 elif PcdFromModule.Phase == 'PEI':
1014 # overwrite any the same PCD existing, if Phase is PEI
1015 Index = self._DynaPcdList_.index(PcdFromModule)
1016 self._DynaPcdList_[Index] = PcdFromModule
1017 elif PcdFromModule not in self._NonDynaPcdList_:
1018 self._NonDynaPcdList_.append(PcdFromModule)
1019 elif PcdFromModule in self._NonDynaPcdList_ and PcdFromModule.IsFromBinaryInf == True:
1020 Index = self._NonDynaPcdList_.index(PcdFromModule)
1021 if self._NonDynaPcdList_[Index].IsFromBinaryInf == False:
1022 #The PCD from Binary INF will override the same one from source INF
1023 self._NonDynaPcdList_.remove (self._NonDynaPcdList_[Index])
1024 PcdFromModule.Pending = False
1025 self._NonDynaPcdList_.append (PcdFromModule)
1026 # Parse the DynamicEx PCD from the AsBuild INF module list of FDF.
1027 DscModuleList = []
1028 for ModuleInf in self.Platform.Modules.keys():
1029 DscModuleList.append (os.path.normpath(ModuleInf.Path))
1030 # add the PCD from modules that listed in FDF but not in DSC to Database
1031 for InfName in FdfModuleList:
1032 if InfName not in DscModuleList:
1033 InfClass = PathClass(InfName)
1034 M = self.BuildDatabase[InfClass, self.Arch, self.BuildTarget, self.ToolChain]
1035 # If a module INF in FDF but not in current arch's DSC module list, it must be module (either binary or source)
1036 # for different Arch. PCDs in source module for different Arch is already added before, so skip the source module here.
1037 # For binary module, if in current arch, we need to list the PCDs into database.
1038 if not M.IsSupportedArch:
1039 continue
1040 # Override the module PCD setting by platform setting
1041 ModulePcdList = self.ApplyPcdSetting(M, M.Pcds)
1042 for PcdFromModule in ModulePcdList:
1043 PcdFromModule.IsFromBinaryInf = True
1044 PcdFromModule.IsFromDsc = False
1045 # Only allow the DynamicEx and Patchable PCD in AsBuild INF
1046 if PcdFromModule.Type not in GenC.gDynamicExPcd and PcdFromModule.Type not in TAB_PCDS_PATCHABLE_IN_MODULE:
1047 EdkLogger.error("build", AUTOGEN_ERROR, "PCD setting error",
1048 File=self.MetaFile,
1049 ExtraData="\n\tExisted %s PCD %s in:\n\t\t%s\n"
1050 % (PcdFromModule.Type, PcdFromModule.TokenCName, InfName))
1051 # make sure that the "VOID*" kind of datum has MaxDatumSize set
1052 if PcdFromModule.DatumType == "VOID*" and PcdFromModule.MaxDatumSize in [None, '']:
1053 NoDatumTypePcdList.add("%s.%s [%s]" % (PcdFromModule.TokenSpaceGuidCName, PcdFromModule.TokenCName, InfName))
1054 if M.ModuleType in ["PEIM", "PEI_CORE"]:
1055 PcdFromModule.Phase = "PEI"
1056 if PcdFromModule not in self._DynaPcdList_ and PcdFromModule.Type in GenC.gDynamicExPcd:
1057 self._DynaPcdList_.append(PcdFromModule)
1058 elif PcdFromModule not in self._NonDynaPcdList_ and PcdFromModule.Type in TAB_PCDS_PATCHABLE_IN_MODULE:
1059 self._NonDynaPcdList_.append(PcdFromModule)
1060 if PcdFromModule in self._DynaPcdList_ and PcdFromModule.Phase == 'PEI' and PcdFromModule.Type in GenC.gDynamicExPcd:
1061 # Overwrite the phase of any the same PCD existing, if Phase is PEI.
1062 # It is to solve the case that a dynamic PCD used by a PEM module/PEI
1063 # module & DXE module at a same time.
1064 # Overwrite the type of the PCDs in source INF by the type of AsBuild
1065 # INF file as DynamicEx.
1066 Index = self._DynaPcdList_.index(PcdFromModule)
1067 self._DynaPcdList_[Index].Phase = PcdFromModule.Phase
1068 self._DynaPcdList_[Index].Type = PcdFromModule.Type
1069 for PcdFromModule in self._NonDynaPcdList_:
1070 # If a PCD is not listed in the DSC file, but binary INF files used by
1071 # this platform all (that use this PCD) list the PCD in a [PatchPcds]
1072 # section, AND all source INF files used by this platform the build
1073 # that use the PCD list the PCD in either a [Pcds] or [PatchPcds]
1074 # section, then the tools must NOT add the PCD to the Platform's PCD
1075 # Database; the build must assign the access method for this PCD as
1076 # PcdsPatchableInModule.
1077 if PcdFromModule not in self._DynaPcdList_:
1078 continue
1079 Index = self._DynaPcdList_.index(PcdFromModule)
1080 if PcdFromModule.IsFromDsc == False and \
1081 PcdFromModule.Type in TAB_PCDS_PATCHABLE_IN_MODULE and \
1082 PcdFromModule.IsFromBinaryInf == True and \
1083 self._DynaPcdList_[Index].IsFromBinaryInf == False:
1084 Index = self._DynaPcdList_.index(PcdFromModule)
1085 self._DynaPcdList_.remove (self._DynaPcdList_[Index])
1086
1087 # print out error information and break the build, if error found
1088 if len(NoDatumTypePcdList) > 0:
1089 NoDatumTypePcdListString = "\n\t\t".join(NoDatumTypePcdList)
1090 EdkLogger.error("build", AUTOGEN_ERROR, "PCD setting error",
1091 File=self.MetaFile,
1092 ExtraData="\n\tPCD(s) without MaxDatumSize:\n\t\t%s\n"
1093 % NoDatumTypePcdListString)
1094 self._NonDynamicPcdList = self._NonDynaPcdList_
1095 self._DynamicPcdList = self._DynaPcdList_
1096 #
1097 # Sort dynamic PCD list to:
1098 # 1) If PCD's datum type is VOID* and value is unicode string which starts with L, the PCD item should
1099 # try to be put header of dynamicd List
1100 # 2) If PCD is HII type, the PCD item should be put after unicode type PCD
1101 #
1102 # The reason of sorting is make sure the unicode string is in double-byte alignment in string table.
1103 #
1104 UnicodePcdArray = []
1105 HiiPcdArray = []
1106 OtherPcdArray = []
1107 VpdPcdDict = {}
1108 VpdFile = VpdInfoFile.VpdInfoFile()
1109 NeedProcessVpdMapFile = False
1110
1111 if (self.Workspace.ArchList[-1] == self.Arch):
1112 for Pcd in self._DynamicPcdList:
1113 # just pick the a value to determine whether is unicode string type
1114 Sku = Pcd.SkuInfoList[Pcd.SkuInfoList.keys()[0]]
1115 Sku.VpdOffset = Sku.VpdOffset.strip()
1116
1117 PcdValue = Sku.DefaultValue
1118 if Pcd.DatumType == 'VOID*' and PcdValue.startswith("L"):
1119 # if found PCD which datum value is unicode string the insert to left size of UnicodeIndex
1120 UnicodePcdArray.append(Pcd)
1121 elif len(Sku.VariableName) > 0:
1122 # if found HII type PCD then insert to right of UnicodeIndex
1123 HiiPcdArray.append(Pcd)
1124 else:
1125 OtherPcdArray.append(Pcd)
1126 if Pcd.Type in [TAB_PCDS_DYNAMIC_VPD, TAB_PCDS_DYNAMIC_EX_VPD]:
1127 VpdPcdDict[(Pcd.TokenCName, Pcd.TokenSpaceGuidCName)] = Pcd
1128
1129 PlatformPcds = self.Platform.Pcds.keys()
1130 PlatformPcds.sort()
1131 #
1132 # Add VPD type PCD into VpdFile and determine whether the VPD PCD need to be fixed up.
1133 #
1134 for PcdKey in PlatformPcds:
1135 Pcd = self.Platform.Pcds[PcdKey]
1136 if Pcd.Type in [TAB_PCDS_DYNAMIC_VPD, TAB_PCDS_DYNAMIC_EX_VPD] and \
1137 PcdKey in VpdPcdDict:
1138 Pcd = VpdPcdDict[PcdKey]
1139 for (SkuName,Sku) in Pcd.SkuInfoList.items():
1140 Sku.VpdOffset = Sku.VpdOffset.strip()
1141 VpdFile.Add(Pcd, Sku.VpdOffset)
1142 # if the offset of a VPD is *, then it need to be fixed up by third party tool.
1143 if not NeedProcessVpdMapFile and Sku.VpdOffset == "*":
1144 NeedProcessVpdMapFile = True
1145 if self.Platform.VpdToolGuid == None or self.Platform.VpdToolGuid == '':
1146 EdkLogger.error("Build", FILE_NOT_FOUND, \
1147 "Fail to find third-party BPDG tool to process VPD PCDs. BPDG Guid tool need to be defined in tools_def.txt and VPD_TOOL_GUID need to be provided in DSC file.")
1148
1149
1150 #
1151 # Fix the PCDs define in VPD PCD section that never referenced by module.
1152 # An example is PCD for signature usage.
1153 #
1154 for DscPcd in PlatformPcds:
1155 DscPcdEntry = self.Platform.Pcds[DscPcd]
1156 if DscPcdEntry.Type in [TAB_PCDS_DYNAMIC_VPD, TAB_PCDS_DYNAMIC_EX_VPD]:
1157 if not (self.Platform.VpdToolGuid == None or self.Platform.VpdToolGuid == ''):
1158 FoundFlag = False
1159 for VpdPcd in VpdFile._VpdArray.keys():
1160 # This PCD has been referenced by module
1161 if (VpdPcd.TokenSpaceGuidCName == DscPcdEntry.TokenSpaceGuidCName) and \
1162 (VpdPcd.TokenCName == DscPcdEntry.TokenCName):
1163 FoundFlag = True
1164
1165 # Not found, it should be signature
1166 if not FoundFlag :
1167 # just pick the a value to determine whether is unicode string type
1168 for (SkuName,Sku) in DscPcdEntry.SkuInfoList.items():
1169 Sku.VpdOffset = Sku.VpdOffset.strip()
1170
1171 # Need to iterate DEC pcd information to get the value & datumtype
1172 for eachDec in self.PackageList:
1173 for DecPcd in eachDec.Pcds:
1174 DecPcdEntry = eachDec.Pcds[DecPcd]
1175 if (DecPcdEntry.TokenSpaceGuidCName == DscPcdEntry.TokenSpaceGuidCName) and \
1176 (DecPcdEntry.TokenCName == DscPcdEntry.TokenCName):
1177 # Print warning message to let the developer make a determine.
1178 EdkLogger.warn("build", "Unreferenced vpd pcd used!",
1179 File=self.MetaFile, \
1180 ExtraData = "PCD: %s.%s used in the DSC file %s is unreferenced." \
1181 %(DscPcdEntry.TokenSpaceGuidCName, DscPcdEntry.TokenCName, self.Platform.MetaFile.Path))
1182
1183 DscPcdEntry.DatumType = DecPcdEntry.DatumType
1184 DscPcdEntry.DefaultValue = DecPcdEntry.DefaultValue
1185 DscPcdEntry.TokenValue = DecPcdEntry.TokenValue
1186 DscPcdEntry.TokenSpaceGuidValue = eachDec.Guids[DecPcdEntry.TokenSpaceGuidCName]
1187 # Only fix the value while no value provided in DSC file.
1188 if (Sku.DefaultValue == "" or Sku.DefaultValue==None):
1189 DscPcdEntry.SkuInfoList[DscPcdEntry.SkuInfoList.keys()[0]].DefaultValue = DecPcdEntry.DefaultValue
1190
1191 if DscPcdEntry not in self._DynamicPcdList:
1192 self._DynamicPcdList.append(DscPcdEntry)
1193 # Sku = DscPcdEntry.SkuInfoList[DscPcdEntry.SkuInfoList.keys()[0]]
1194 Sku.VpdOffset = Sku.VpdOffset.strip()
1195 PcdValue = Sku.DefaultValue
1196 VpdFile.Add(DscPcdEntry, Sku.VpdOffset)
1197 if not NeedProcessVpdMapFile and Sku.VpdOffset == "*":
1198 NeedProcessVpdMapFile = True
1199 if DscPcdEntry.DatumType == 'VOID*' and PcdValue.startswith("L"):
1200 UnicodePcdArray.append(DscPcdEntry)
1201 elif len(Sku.VariableName) > 0:
1202 HiiPcdArray.append(DscPcdEntry)
1203 else:
1204 OtherPcdArray.append(DscPcdEntry)
1205
1206 # if the offset of a VPD is *, then it need to be fixed up by third party tool.
1207
1208
1209
1210 if (self.Platform.FlashDefinition == None or self.Platform.FlashDefinition == '') and \
1211 VpdFile.GetCount() != 0:
1212 EdkLogger.error("build", ATTRIBUTE_NOT_AVAILABLE,
1213 "Fail to get FLASH_DEFINITION definition in DSC file %s which is required when DSC contains VPD PCD." % str(self.Platform.MetaFile))
1214
1215 if VpdFile.GetCount() != 0:
1216 DscTimeStamp = self.Platform.MetaFile.TimeStamp
1217 FvPath = os.path.join(self.BuildDir, "FV")
1218 if not os.path.exists(FvPath):
1219 try:
1220 os.makedirs(FvPath)
1221 except:
1222 EdkLogger.error("build", FILE_WRITE_FAILURE, "Fail to create FV folder under %s" % self.BuildDir)
1223
1224
1225 VpdFilePath = os.path.join(FvPath, "%s.txt" % self.Platform.VpdToolGuid)
1226
1227
1228 if not os.path.exists(VpdFilePath) or os.path.getmtime(VpdFilePath) < DscTimeStamp:
1229 VpdFile.Write(VpdFilePath)
1230
1231 # retrieve BPDG tool's path from tool_def.txt according to VPD_TOOL_GUID defined in DSC file.
1232 BPDGToolName = None
1233 for ToolDef in self.ToolDefinition.values():
1234 if ToolDef.has_key("GUID") and ToolDef["GUID"] == self.Platform.VpdToolGuid:
1235 if not ToolDef.has_key("PATH"):
1236 EdkLogger.error("build", ATTRIBUTE_NOT_AVAILABLE, "PATH attribute was not provided for BPDG guid tool %s in tools_def.txt" % self.Platform.VpdToolGuid)
1237 BPDGToolName = ToolDef["PATH"]
1238 break
1239 # Call third party GUID BPDG tool.
1240 if BPDGToolName != None:
1241 VpdInfoFile.CallExtenalBPDGTool(BPDGToolName, VpdFilePath)
1242 else:
1243 EdkLogger.error("Build", FILE_NOT_FOUND, "Fail to find third-party BPDG tool to process VPD PCDs. BPDG Guid tool need to be defined in tools_def.txt and VPD_TOOL_GUID need to be provided in DSC file.")
1244
1245 # Process VPD map file generated by third party BPDG tool
1246 if NeedProcessVpdMapFile:
1247 VpdMapFilePath = os.path.join(self.BuildDir, "FV", "%s.map" % self.Platform.VpdToolGuid)
1248 if os.path.exists(VpdMapFilePath):
1249 VpdFile.Read(VpdMapFilePath)
1250
1251 # Fixup "*" offset
1252 for Pcd in self._DynamicPcdList:
1253 # just pick the a value to determine whether is unicode string type
1254 i = 0
1255 for (SkuName,Sku) in Pcd.SkuInfoList.items():
1256 if Sku.VpdOffset == "*":
1257 Sku.VpdOffset = VpdFile.GetOffset(Pcd)[i].strip()
1258 i += 1
1259 else:
1260 EdkLogger.error("build", FILE_READ_FAILURE, "Can not find VPD map file %s to fix up VPD offset." % VpdMapFilePath)
1261
1262 # Delete the DynamicPcdList At the last time enter into this function
1263 del self._DynamicPcdList[:]
1264 self._DynamicPcdList.extend(UnicodePcdArray)
1265 self._DynamicPcdList.extend(HiiPcdArray)
1266 self._DynamicPcdList.extend(OtherPcdArray)
1267 self.AllPcdList = self._NonDynamicPcdList + self._DynamicPcdList
1268
1269 ## Return the platform build data object
1270 def _GetPlatform(self):
1271 if self._Platform == None:
1272 self._Platform = self.BuildDatabase[self.MetaFile, self.Arch, self.BuildTarget, self.ToolChain]
1273 return self._Platform
1274
1275 ## Return platform name
1276 def _GetName(self):
1277 return self.Platform.PlatformName
1278
1279 ## Return the meta file GUID
1280 def _GetGuid(self):
1281 return self.Platform.Guid
1282
1283 ## Return the platform version
1284 def _GetVersion(self):
1285 return self.Platform.Version
1286
1287 ## Return the FDF file name
1288 def _GetFdfFile(self):
1289 if self._FdfFile == None:
1290 if self.Workspace.FdfFile != "":
1291 self._FdfFile= path.join(self.WorkspaceDir, self.Workspace.FdfFile)
1292 else:
1293 self._FdfFile = ''
1294 return self._FdfFile
1295
1296 ## Return the build output directory platform specifies
1297 def _GetOutputDir(self):
1298 return self.Platform.OutputDirectory
1299
1300 ## Return the directory to store all intermediate and final files built
1301 def _GetBuildDir(self):
1302 if self._BuildDir == None:
1303 if os.path.isabs(self.OutputDir):
1304 self._BuildDir = path.join(
1305 path.abspath(self.OutputDir),
1306 self.BuildTarget + "_" + self.ToolChain,
1307 )
1308 else:
1309 self._BuildDir = path.join(
1310 self.WorkspaceDir,
1311 self.OutputDir,
1312 self.BuildTarget + "_" + self.ToolChain,
1313 )
1314 return self._BuildDir
1315
1316 ## Return directory of platform makefile
1317 #
1318 # @retval string Makefile directory
1319 #
1320 def _GetMakeFileDir(self):
1321 if self._MakeFileDir == None:
1322 self._MakeFileDir = path.join(self.BuildDir, self.Arch)
1323 return self._MakeFileDir
1324
1325 ## Return build command string
1326 #
1327 # @retval string Build command string
1328 #
1329 def _GetBuildCommand(self):
1330 if self._BuildCommand == None:
1331 self._BuildCommand = []
1332 if "MAKE" in self.ToolDefinition and "PATH" in self.ToolDefinition["MAKE"]:
1333 self._BuildCommand += SplitOption(self.ToolDefinition["MAKE"]["PATH"])
1334 if "FLAGS" in self.ToolDefinition["MAKE"]:
1335 NewOption = self.ToolDefinition["MAKE"]["FLAGS"].strip()
1336 if NewOption != '':
1337 self._BuildCommand += SplitOption(NewOption)
1338 return self._BuildCommand
1339
1340 ## Get tool chain definition
1341 #
1342 # Get each tool defition for given tool chain from tools_def.txt and platform
1343 #
1344 def _GetToolDefinition(self):
1345 if self._ToolDefinitions == None:
1346 ToolDefinition = self.Workspace.ToolDef.ToolsDefTxtDictionary
1347 if TAB_TOD_DEFINES_COMMAND_TYPE not in self.Workspace.ToolDef.ToolsDefTxtDatabase:
1348 EdkLogger.error('build', RESOURCE_NOT_AVAILABLE, "No tools found in configuration",
1349 ExtraData="[%s]" % self.MetaFile)
1350 self._ToolDefinitions = {}
1351 DllPathList = set()
1352 for Def in ToolDefinition:
1353 Target, Tag, Arch, Tool, Attr = Def.split("_")
1354 if Target != self.BuildTarget or Tag != self.ToolChain or Arch != self.Arch:
1355 continue
1356
1357 Value = ToolDefinition[Def]
1358 # don't record the DLL
1359 if Attr == "DLL":
1360 DllPathList.add(Value)
1361 continue
1362
1363 if Tool not in self._ToolDefinitions:
1364 self._ToolDefinitions[Tool] = {}
1365 self._ToolDefinitions[Tool][Attr] = Value
1366
1367 ToolsDef = ''
1368 MakePath = ''
1369 if GlobalData.gOptions.SilentMode and "MAKE" in self._ToolDefinitions:
1370 if "FLAGS" not in self._ToolDefinitions["MAKE"]:
1371 self._ToolDefinitions["MAKE"]["FLAGS"] = ""
1372 self._ToolDefinitions["MAKE"]["FLAGS"] += " -s"
1373 MakeFlags = ''
1374 for Tool in self._ToolDefinitions:
1375 for Attr in self._ToolDefinitions[Tool]:
1376 Value = self._ToolDefinitions[Tool][Attr]
1377 if Tool in self.BuildOption and Attr in self.BuildOption[Tool]:
1378 # check if override is indicated
1379 if self.BuildOption[Tool][Attr].startswith('='):
1380 Value = self.BuildOption[Tool][Attr][1:]
1381 else:
1382 Value += " " + self.BuildOption[Tool][Attr]
1383
1384 if Attr == "PATH":
1385 # Don't put MAKE definition in the file
1386 if Tool == "MAKE":
1387 MakePath = Value
1388 else:
1389 ToolsDef += "%s = %s\n" % (Tool, Value)
1390 elif Attr != "DLL":
1391 # Don't put MAKE definition in the file
1392 if Tool == "MAKE":
1393 if Attr == "FLAGS":
1394 MakeFlags = Value
1395 else:
1396 ToolsDef += "%s_%s = %s\n" % (Tool, Attr, Value)
1397 ToolsDef += "\n"
1398
1399 SaveFileOnChange(self.ToolDefinitionFile, ToolsDef)
1400 for DllPath in DllPathList:
1401 os.environ["PATH"] = DllPath + os.pathsep + os.environ["PATH"]
1402 os.environ["MAKE_FLAGS"] = MakeFlags
1403
1404 return self._ToolDefinitions
1405
1406 ## Return the paths of tools
1407 def _GetToolDefFile(self):
1408 if self._ToolDefFile == None:
1409 self._ToolDefFile = os.path.join(self.MakeFileDir, "TOOLS_DEF." + self.Arch)
1410 return self._ToolDefFile
1411
1412 ## Retrieve the toolchain family of given toolchain tag. Default to 'MSFT'.
1413 def _GetToolChainFamily(self):
1414 if self._ToolChainFamily == None:
1415 ToolDefinition = self.Workspace.ToolDef.ToolsDefTxtDatabase
1416 if TAB_TOD_DEFINES_FAMILY not in ToolDefinition \
1417 or self.ToolChain not in ToolDefinition[TAB_TOD_DEFINES_FAMILY] \
1418 or not ToolDefinition[TAB_TOD_DEFINES_FAMILY][self.ToolChain]:
1419 EdkLogger.verbose("No tool chain family found in configuration for %s. Default to MSFT." \
1420 % self.ToolChain)
1421 self._ToolChainFamily = "MSFT"
1422 else:
1423 self._ToolChainFamily = ToolDefinition[TAB_TOD_DEFINES_FAMILY][self.ToolChain]
1424 return self._ToolChainFamily
1425
1426 def _GetBuildRuleFamily(self):
1427 if self._BuildRuleFamily == None:
1428 ToolDefinition = self.Workspace.ToolDef.ToolsDefTxtDatabase
1429 if TAB_TOD_DEFINES_BUILDRULEFAMILY not in ToolDefinition \
1430 or self.ToolChain not in ToolDefinition[TAB_TOD_DEFINES_BUILDRULEFAMILY] \
1431 or not ToolDefinition[TAB_TOD_DEFINES_BUILDRULEFAMILY][self.ToolChain]:
1432 EdkLogger.verbose("No tool chain family found in configuration for %s. Default to MSFT." \
1433 % self.ToolChain)
1434 self._BuildRuleFamily = "MSFT"
1435 else:
1436 self._BuildRuleFamily = ToolDefinition[TAB_TOD_DEFINES_BUILDRULEFAMILY][self.ToolChain]
1437 return self._BuildRuleFamily
1438
1439 ## Return the build options specific for all modules in this platform
1440 def _GetBuildOptions(self):
1441 if self._BuildOption == None:
1442 self._BuildOption = self._ExpandBuildOption(self.Platform.BuildOptions)
1443 return self._BuildOption
1444
1445 ## Return the build options specific for EDK modules in this platform
1446 def _GetEdkBuildOptions(self):
1447 if self._EdkBuildOption == None:
1448 self._EdkBuildOption = self._ExpandBuildOption(self.Platform.BuildOptions, EDK_NAME)
1449 return self._EdkBuildOption
1450
1451 ## Return the build options specific for EDKII modules in this platform
1452 def _GetEdkIIBuildOptions(self):
1453 if self._EdkIIBuildOption == None:
1454 self._EdkIIBuildOption = self._ExpandBuildOption(self.Platform.BuildOptions, EDKII_NAME)
1455 return self._EdkIIBuildOption
1456
1457 ## Parse build_rule.txt in Conf Directory.
1458 #
1459 # @retval BuildRule object
1460 #
1461 def _GetBuildRule(self):
1462 if self._BuildRule == None:
1463 BuildRuleFile = None
1464 if TAB_TAT_DEFINES_BUILD_RULE_CONF in self.Workspace.TargetTxt.TargetTxtDictionary:
1465 BuildRuleFile = self.Workspace.TargetTxt.TargetTxtDictionary[TAB_TAT_DEFINES_BUILD_RULE_CONF]
1466 if BuildRuleFile in [None, '']:
1467 BuildRuleFile = gDefaultBuildRuleFile
1468 self._BuildRule = BuildRule(BuildRuleFile)
1469 if self._BuildRule._FileVersion == "":
1470 self._BuildRule._FileVersion = AutoGenReqBuildRuleVerNum
1471 else:
1472 if self._BuildRule._FileVersion < AutoGenReqBuildRuleVerNum :
1473 # If Build Rule's version is less than the version number required by the tools, halting the build.
1474 EdkLogger.error("build", AUTOGEN_ERROR,
1475 ExtraData="The version number [%s] of build_rule.txt is less than the version number required by the AutoGen.(the minimum required version number is [%s])"\
1476 % (self._BuildRule._FileVersion, AutoGenReqBuildRuleVerNum))
1477
1478 return self._BuildRule
1479
1480 ## Summarize the packages used by modules in this platform
1481 def _GetPackageList(self):
1482 if self._PackageList == None:
1483 self._PackageList = set()
1484 for La in self.LibraryAutoGenList:
1485 self._PackageList.update(La.DependentPackageList)
1486 for Ma in self.ModuleAutoGenList:
1487 self._PackageList.update(Ma.DependentPackageList)
1488 #Collect package set information from INF of FDF
1489 PkgSet = set()
1490 for ModuleFile in self._AsBuildModuleList:
1491 if ModuleFile in self.Platform.Modules:
1492 continue
1493 ModuleData = self.BuildDatabase[ModuleFile, self.Arch, self.BuildTarget, self.ToolChain]
1494 PkgSet.update(ModuleData.Packages)
1495 self._PackageList = list(self._PackageList) + list (PkgSet)
1496 return self._PackageList
1497
1498 def _GetNonDynamicPcdDict(self):
1499 if self._NonDynamicPcdDict:
1500 return self._NonDynamicPcdDict
1501 for Pcd in self.NonDynamicPcdList:
1502 self._NonDynamicPcdDict[(Pcd.TokenCName,Pcd.TokenSpaceGuidCName)] = Pcd
1503 return self._NonDynamicPcdDict
1504
1505 ## Get list of non-dynamic PCDs
1506 def _GetNonDynamicPcdList(self):
1507 if self._NonDynamicPcdList == None:
1508 self.CollectPlatformDynamicPcds()
1509 return self._NonDynamicPcdList
1510
1511 ## Get list of dynamic PCDs
1512 def _GetDynamicPcdList(self):
1513 if self._DynamicPcdList == None:
1514 self.CollectPlatformDynamicPcds()
1515 return self._DynamicPcdList
1516
1517 ## Generate Token Number for all PCD
1518 def _GetPcdTokenNumbers(self):
1519 if self._PcdTokenNumber == None:
1520 self._PcdTokenNumber = sdict()
1521 TokenNumber = 1
1522 #
1523 # Make the Dynamic and DynamicEx PCD use within different TokenNumber area.
1524 # Such as:
1525 #
1526 # Dynamic PCD:
1527 # TokenNumber 0 ~ 10
1528 # DynamicEx PCD:
1529 # TokeNumber 11 ~ 20
1530 #
1531 for Pcd in self.DynamicPcdList:
1532 if Pcd.Phase == "PEI":
1533 if Pcd.Type in ["Dynamic", "DynamicDefault", "DynamicVpd", "DynamicHii"]:
1534 EdkLogger.debug(EdkLogger.DEBUG_5, "%s %s (%s) -> %d" % (Pcd.TokenCName, Pcd.TokenSpaceGuidCName, Pcd.Phase, TokenNumber))
1535 self._PcdTokenNumber[Pcd.TokenCName, Pcd.TokenSpaceGuidCName] = TokenNumber
1536 TokenNumber += 1
1537
1538 for Pcd in self.DynamicPcdList:
1539 if Pcd.Phase == "PEI":
1540 if Pcd.Type in ["DynamicEx", "DynamicExDefault", "DynamicExVpd", "DynamicExHii"]:
1541 EdkLogger.debug(EdkLogger.DEBUG_5, "%s %s (%s) -> %d" % (Pcd.TokenCName, Pcd.TokenSpaceGuidCName, Pcd.Phase, TokenNumber))
1542 self._PcdTokenNumber[Pcd.TokenCName, Pcd.TokenSpaceGuidCName] = TokenNumber
1543 TokenNumber += 1
1544
1545 for Pcd in self.DynamicPcdList:
1546 if Pcd.Phase == "DXE":
1547 if Pcd.Type in ["Dynamic", "DynamicDefault", "DynamicVpd", "DynamicHii"]:
1548 EdkLogger.debug(EdkLogger.DEBUG_5, "%s %s (%s) -> %d" % (Pcd.TokenCName, Pcd.TokenSpaceGuidCName, Pcd.Phase, TokenNumber))
1549 self._PcdTokenNumber[Pcd.TokenCName, Pcd.TokenSpaceGuidCName] = TokenNumber
1550 TokenNumber += 1
1551
1552 for Pcd in self.DynamicPcdList:
1553 if Pcd.Phase == "DXE":
1554 if Pcd.Type in ["DynamicEx", "DynamicExDefault", "DynamicExVpd", "DynamicExHii"]:
1555 EdkLogger.debug(EdkLogger.DEBUG_5, "%s %s (%s) -> %d" % (Pcd.TokenCName, Pcd.TokenSpaceGuidCName, Pcd.Phase, TokenNumber))
1556 self._PcdTokenNumber[Pcd.TokenCName, Pcd.TokenSpaceGuidCName] = TokenNumber
1557 TokenNumber += 1
1558
1559 for Pcd in self.NonDynamicPcdList:
1560 self._PcdTokenNumber[Pcd.TokenCName, Pcd.TokenSpaceGuidCName] = TokenNumber
1561 TokenNumber += 1
1562 return self._PcdTokenNumber
1563
1564 ## Summarize ModuleAutoGen objects of all modules/libraries to be built for this platform
1565 def _GetAutoGenObjectList(self):
1566 self._ModuleAutoGenList = []
1567 self._LibraryAutoGenList = []
1568 for ModuleFile in self.Platform.Modules:
1569 Ma = ModuleAutoGen(
1570 self.Workspace,
1571 ModuleFile,
1572 self.BuildTarget,
1573 self.ToolChain,
1574 self.Arch,
1575 self.MetaFile
1576 )
1577 if Ma not in self._ModuleAutoGenList:
1578 self._ModuleAutoGenList.append(Ma)
1579 for La in Ma.LibraryAutoGenList:
1580 if La not in self._LibraryAutoGenList:
1581 self._LibraryAutoGenList.append(La)
1582 if Ma not in La._ReferenceModules:
1583 La._ReferenceModules.append(Ma)
1584
1585 ## Summarize ModuleAutoGen objects of all modules to be built for this platform
1586 def _GetModuleAutoGenList(self):
1587 if self._ModuleAutoGenList == None:
1588 self._GetAutoGenObjectList()
1589 return self._ModuleAutoGenList
1590
1591 ## Summarize ModuleAutoGen objects of all libraries to be built for this platform
1592 def _GetLibraryAutoGenList(self):
1593 if self._LibraryAutoGenList == None:
1594 self._GetAutoGenObjectList()
1595 return self._LibraryAutoGenList
1596
1597 ## Test if a module is supported by the platform
1598 #
1599 # An error will be raised directly if the module or its arch is not supported
1600 # by the platform or current configuration
1601 #
1602 def ValidModule(self, Module):
1603 return Module in self.Platform.Modules or Module in self.Platform.LibraryInstances \
1604 or Module in self._AsBuildModuleList
1605
1606 ## Resolve the library classes in a module to library instances
1607 #
1608 # This method will not only resolve library classes but also sort the library
1609 # instances according to the dependency-ship.
1610 #
1611 # @param Module The module from which the library classes will be resolved
1612 #
1613 # @retval library_list List of library instances sorted
1614 #
1615 def ApplyLibraryInstance(self, Module):
1616 ModuleType = Module.ModuleType
1617
1618 # for overridding library instances with module specific setting
1619 PlatformModule = self.Platform.Modules[str(Module)]
1620
1621 # add forced library instances (specified under LibraryClasses sections)
1622 #
1623 # If a module has a MODULE_TYPE of USER_DEFINED,
1624 # do not link in NULL library class instances from the global [LibraryClasses.*] sections.
1625 #
1626 if Module.ModuleType != SUP_MODULE_USER_DEFINED:
1627 for LibraryClass in self.Platform.LibraryClasses.GetKeys():
1628 if LibraryClass.startswith("NULL") and self.Platform.LibraryClasses[LibraryClass, Module.ModuleType]:
1629 Module.LibraryClasses[LibraryClass] = self.Platform.LibraryClasses[LibraryClass, Module.ModuleType]
1630
1631 # add forced library instances (specified in module overrides)
1632 for LibraryClass in PlatformModule.LibraryClasses:
1633 if LibraryClass.startswith("NULL"):
1634 Module.LibraryClasses[LibraryClass] = PlatformModule.LibraryClasses[LibraryClass]
1635
1636 # EdkII module
1637 LibraryConsumerList = [Module]
1638 Constructor = []
1639 ConsumedByList = sdict()
1640 LibraryInstance = sdict()
1641
1642 EdkLogger.verbose("")
1643 EdkLogger.verbose("Library instances of module [%s] [%s]:" % (str(Module), self.Arch))
1644 while len(LibraryConsumerList) > 0:
1645 M = LibraryConsumerList.pop()
1646 for LibraryClassName in M.LibraryClasses:
1647 if LibraryClassName not in LibraryInstance:
1648 # override library instance for this module
1649 if LibraryClassName in PlatformModule.LibraryClasses:
1650 LibraryPath = PlatformModule.LibraryClasses[LibraryClassName]
1651 else:
1652 LibraryPath = self.Platform.LibraryClasses[LibraryClassName, ModuleType]
1653 if LibraryPath == None or LibraryPath == "":
1654 LibraryPath = M.LibraryClasses[LibraryClassName]
1655 if LibraryPath == None or LibraryPath == "":
1656 EdkLogger.error("build", RESOURCE_NOT_AVAILABLE,
1657 "Instance of library class [%s] is not found" % LibraryClassName,
1658 File=self.MetaFile,
1659 ExtraData="in [%s] [%s]\n\tconsumed by module [%s]" % (str(M), self.Arch, str(Module)))
1660
1661 LibraryModule = self.BuildDatabase[LibraryPath, self.Arch, self.BuildTarget, self.ToolChain]
1662 # for those forced library instance (NULL library), add a fake library class
1663 if LibraryClassName.startswith("NULL"):
1664 LibraryModule.LibraryClass.append(LibraryClassObject(LibraryClassName, [ModuleType]))
1665 elif LibraryModule.LibraryClass == None \
1666 or len(LibraryModule.LibraryClass) == 0 \
1667 or (ModuleType != 'USER_DEFINED'
1668 and ModuleType not in LibraryModule.LibraryClass[0].SupModList):
1669 # only USER_DEFINED can link against any library instance despite of its SupModList
1670 EdkLogger.error("build", OPTION_MISSING,
1671 "Module type [%s] is not supported by library instance [%s]" \
1672 % (ModuleType, LibraryPath), File=self.MetaFile,
1673 ExtraData="consumed by [%s]" % str(Module))
1674
1675 LibraryInstance[LibraryClassName] = LibraryModule
1676 LibraryConsumerList.append(LibraryModule)
1677 EdkLogger.verbose("\t" + str(LibraryClassName) + " : " + str(LibraryModule))
1678 else:
1679 LibraryModule = LibraryInstance[LibraryClassName]
1680
1681 if LibraryModule == None:
1682 continue
1683
1684 if LibraryModule.ConstructorList != [] and LibraryModule not in Constructor:
1685 Constructor.append(LibraryModule)
1686
1687 if LibraryModule not in ConsumedByList:
1688 ConsumedByList[LibraryModule] = []
1689 # don't add current module itself to consumer list
1690 if M != Module:
1691 if M in ConsumedByList[LibraryModule]:
1692 continue
1693 ConsumedByList[LibraryModule].append(M)
1694 #
1695 # Initialize the sorted output list to the empty set
1696 #
1697 SortedLibraryList = []
1698 #
1699 # Q <- Set of all nodes with no incoming edges
1700 #
1701 LibraryList = [] #LibraryInstance.values()
1702 Q = []
1703 for LibraryClassName in LibraryInstance:
1704 M = LibraryInstance[LibraryClassName]
1705 LibraryList.append(M)
1706 if ConsumedByList[M] == []:
1707 Q.append(M)
1708
1709 #
1710 # start the DAG algorithm
1711 #
1712 while True:
1713 EdgeRemoved = True
1714 while Q == [] and EdgeRemoved:
1715 EdgeRemoved = False
1716 # for each node Item with a Constructor
1717 for Item in LibraryList:
1718 if Item not in Constructor:
1719 continue
1720 # for each Node without a constructor with an edge e from Item to Node
1721 for Node in ConsumedByList[Item]:
1722 if Node in Constructor:
1723 continue
1724 # remove edge e from the graph if Node has no constructor
1725 ConsumedByList[Item].remove(Node)
1726 EdgeRemoved = True
1727 if ConsumedByList[Item] == []:
1728 # insert Item into Q
1729 Q.insert(0, Item)
1730 break
1731 if Q != []:
1732 break
1733 # DAG is done if there's no more incoming edge for all nodes
1734 if Q == []:
1735 break
1736
1737 # remove node from Q
1738 Node = Q.pop()
1739 # output Node
1740 SortedLibraryList.append(Node)
1741
1742 # for each node Item with an edge e from Node to Item do
1743 for Item in LibraryList:
1744 if Node not in ConsumedByList[Item]:
1745 continue
1746 # remove edge e from the graph
1747 ConsumedByList[Item].remove(Node)
1748
1749 if ConsumedByList[Item] != []:
1750 continue
1751 # insert Item into Q, if Item has no other incoming edges
1752 Q.insert(0, Item)
1753
1754 #
1755 # if any remaining node Item in the graph has a constructor and an incoming edge, then the graph has a cycle
1756 #
1757 for Item in LibraryList:
1758 if ConsumedByList[Item] != [] and Item in Constructor and len(Constructor) > 1:
1759 ErrorMessage = "\tconsumed by " + "\n\tconsumed by ".join([str(L) for L in ConsumedByList[Item]])
1760 EdkLogger.error("build", BUILD_ERROR, 'Library [%s] with constructors has a cycle' % str(Item),
1761 ExtraData=ErrorMessage, File=self.MetaFile)
1762 if Item not in SortedLibraryList:
1763 SortedLibraryList.append(Item)
1764
1765 #
1766 # Build the list of constructor and destructir names
1767 # The DAG Topo sort produces the destructor order, so the list of constructors must generated in the reverse order
1768 #
1769 SortedLibraryList.reverse()
1770 return SortedLibraryList
1771
1772
1773 ## Override PCD setting (type, value, ...)
1774 #
1775 # @param ToPcd The PCD to be overrided
1776 # @param FromPcd The PCD overrideing from
1777 #
1778 def _OverridePcd(self, ToPcd, FromPcd, Module=""):
1779 #
1780 # in case there's PCDs coming from FDF file, which have no type given.
1781 # at this point, ToPcd.Type has the type found from dependent
1782 # package
1783 #
1784 if FromPcd != None:
1785 if ToPcd.Pending and FromPcd.Type not in [None, '']:
1786 ToPcd.Type = FromPcd.Type
1787 elif (ToPcd.Type not in [None, '']) and (FromPcd.Type not in [None, ''])\
1788 and (ToPcd.Type != FromPcd.Type) and (ToPcd.Type in FromPcd.Type):
1789 if ToPcd.Type.strip() == "DynamicEx":
1790 ToPcd.Type = FromPcd.Type
1791 elif ToPcd.Type not in [None, ''] and FromPcd.Type not in [None, ''] \
1792 and ToPcd.Type != FromPcd.Type:
1793 EdkLogger.error("build", OPTION_CONFLICT, "Mismatched PCD type",
1794 ExtraData="%s.%s is defined as [%s] in module %s, but as [%s] in platform."\
1795 % (ToPcd.TokenSpaceGuidCName, ToPcd.TokenCName,
1796 ToPcd.Type, Module, FromPcd.Type),
1797 File=self.MetaFile)
1798
1799 if FromPcd.MaxDatumSize not in [None, '']:
1800 ToPcd.MaxDatumSize = FromPcd.MaxDatumSize
1801 if FromPcd.DefaultValue not in [None, '']:
1802 ToPcd.DefaultValue = FromPcd.DefaultValue
1803 if FromPcd.TokenValue not in [None, '']:
1804 ToPcd.TokenValue = FromPcd.TokenValue
1805 if FromPcd.MaxDatumSize not in [None, '']:
1806 ToPcd.MaxDatumSize = FromPcd.MaxDatumSize
1807 if FromPcd.DatumType not in [None, '']:
1808 ToPcd.DatumType = FromPcd.DatumType
1809 if FromPcd.SkuInfoList not in [None, '', []]:
1810 ToPcd.SkuInfoList = FromPcd.SkuInfoList
1811
1812 # check the validation of datum
1813 IsValid, Cause = CheckPcdDatum(ToPcd.DatumType, ToPcd.DefaultValue)
1814 if not IsValid:
1815 EdkLogger.error('build', FORMAT_INVALID, Cause, File=self.MetaFile,
1816 ExtraData="%s.%s" % (ToPcd.TokenSpaceGuidCName, ToPcd.TokenCName))
1817 ToPcd.validateranges = FromPcd.validateranges
1818 ToPcd.validlists = FromPcd.validlists
1819 ToPcd.expressions = FromPcd.expressions
1820
1821 if ToPcd.DatumType == "VOID*" and ToPcd.MaxDatumSize in ['', None]:
1822 EdkLogger.debug(EdkLogger.DEBUG_9, "No MaxDatumSize specified for PCD %s.%s" \
1823 % (ToPcd.TokenSpaceGuidCName, ToPcd.TokenCName))
1824 Value = ToPcd.DefaultValue
1825 if Value in [None, '']:
1826 ToPcd.MaxDatumSize = '1'
1827 elif Value[0] == 'L':
1828 ToPcd.MaxDatumSize = str((len(Value) - 2) * 2)
1829 elif Value[0] == '{':
1830 ToPcd.MaxDatumSize = str(len(Value.split(',')))
1831 else:
1832 ToPcd.MaxDatumSize = str(len(Value) - 1)
1833
1834 # apply default SKU for dynamic PCDS if specified one is not available
1835 if (ToPcd.Type in PCD_DYNAMIC_TYPE_LIST or ToPcd.Type in PCD_DYNAMIC_EX_TYPE_LIST) \
1836 and ToPcd.SkuInfoList in [None, {}, '']:
1837 if self.Platform.SkuName in self.Platform.SkuIds:
1838 SkuName = self.Platform.SkuName
1839 else:
1840 SkuName = 'DEFAULT'
1841 ToPcd.SkuInfoList = {
1842 SkuName : SkuInfoClass(SkuName, self.Platform.SkuIds[SkuName], '', '', '', '', '', ToPcd.DefaultValue)
1843 }
1844
1845 ## Apply PCD setting defined platform to a module
1846 #
1847 # @param Module The module from which the PCD setting will be overrided
1848 #
1849 # @retval PCD_list The list PCDs with settings from platform
1850 #
1851 def ApplyPcdSetting(self, Module, Pcds):
1852 # for each PCD in module
1853 for Name,Guid in Pcds:
1854 PcdInModule = Pcds[Name,Guid]
1855 # find out the PCD setting in platform
1856 if (Name,Guid) in self.Platform.Pcds:
1857 PcdInPlatform = self.Platform.Pcds[Name,Guid]
1858 else:
1859 PcdInPlatform = None
1860 # then override the settings if any
1861 self._OverridePcd(PcdInModule, PcdInPlatform, Module)
1862 # resolve the VariableGuid value
1863 for SkuId in PcdInModule.SkuInfoList:
1864 Sku = PcdInModule.SkuInfoList[SkuId]
1865 if Sku.VariableGuid == '': continue
1866 Sku.VariableGuidValue = GuidValue(Sku.VariableGuid, self.PackageList)
1867 if Sku.VariableGuidValue == None:
1868 PackageList = "\n\t".join([str(P) for P in self.PackageList])
1869 EdkLogger.error(
1870 'build',
1871 RESOURCE_NOT_AVAILABLE,
1872 "Value of GUID [%s] is not found in" % Sku.VariableGuid,
1873 ExtraData=PackageList + "\n\t(used with %s.%s from module %s)" \
1874 % (Guid, Name, str(Module)),
1875 File=self.MetaFile
1876 )
1877
1878 # override PCD settings with module specific setting
1879 if Module in self.Platform.Modules:
1880 PlatformModule = self.Platform.Modules[str(Module)]
1881 for Key in PlatformModule.Pcds:
1882 if Key in Pcds:
1883 self._OverridePcd(Pcds[Key], PlatformModule.Pcds[Key], Module)
1884 return Pcds.values()
1885
1886 ## Resolve library names to library modules
1887 #
1888 # (for Edk.x modules)
1889 #
1890 # @param Module The module from which the library names will be resolved
1891 #
1892 # @retval library_list The list of library modules
1893 #
1894 def ResolveLibraryReference(self, Module):
1895 EdkLogger.verbose("")
1896 EdkLogger.verbose("Library instances of module [%s] [%s]:" % (str(Module), self.Arch))
1897 LibraryConsumerList = [Module]
1898
1899 # "CompilerStub" is a must for Edk modules
1900 if Module.Libraries:
1901 Module.Libraries.append("CompilerStub")
1902 LibraryList = []
1903 while len(LibraryConsumerList) > 0:
1904 M = LibraryConsumerList.pop()
1905 for LibraryName in M.Libraries:
1906 Library = self.Platform.LibraryClasses[LibraryName, ':dummy:']
1907 if Library == None:
1908 for Key in self.Platform.LibraryClasses.data.keys():
1909 if LibraryName.upper() == Key.upper():
1910 Library = self.Platform.LibraryClasses[Key, ':dummy:']
1911 break
1912 if Library == None:
1913 EdkLogger.warn("build", "Library [%s] is not found" % LibraryName, File=str(M),
1914 ExtraData="\t%s [%s]" % (str(Module), self.Arch))
1915 continue
1916
1917 if Library not in LibraryList:
1918 LibraryList.append(Library)
1919 LibraryConsumerList.append(Library)
1920 EdkLogger.verbose("\t" + LibraryName + " : " + str(Library) + ' ' + str(type(Library)))
1921 return LibraryList
1922
1923 ## Calculate the priority value of the build option
1924 #
1925 # @param Key Build option definition contain: TARGET_TOOLCHAIN_ARCH_COMMANDTYPE_ATTRIBUTE
1926 #
1927 # @retval Value Priority value based on the priority list.
1928 #
1929 def CalculatePriorityValue(self, Key):
1930 Target, ToolChain, Arch, CommandType, Attr = Key.split('_')
1931 PriorityValue = 0x11111
1932 if Target == "*":
1933 PriorityValue &= 0x01111
1934 if ToolChain == "*":
1935 PriorityValue &= 0x10111
1936 if Arch == "*":
1937 PriorityValue &= 0x11011
1938 if CommandType == "*":
1939 PriorityValue &= 0x11101
1940 if Attr == "*":
1941 PriorityValue &= 0x11110
1942
1943 return self.PrioList["0x%0.5x"%PriorityValue]
1944
1945
1946 ## Expand * in build option key
1947 #
1948 # @param Options Options to be expanded
1949 #
1950 # @retval options Options expanded
1951 #
1952 def _ExpandBuildOption(self, Options, ModuleStyle=None):
1953 BuildOptions = {}
1954 FamilyMatch = False
1955 FamilyIsNull = True
1956
1957 OverrideList = {}
1958 #
1959 # Construct a list contain the build options which need override.
1960 #
1961 for Key in Options:
1962 #
1963 # Key[0] -- tool family
1964 # Key[1] -- TARGET_TOOLCHAIN_ARCH_COMMANDTYPE_ATTRIBUTE
1965 #
1966 if (Key[0] == self.BuildRuleFamily and
1967 (ModuleStyle == None or len(Key) < 3 or (len(Key) > 2 and Key[2] == ModuleStyle))):
1968 Target, ToolChain, Arch, CommandType, Attr = Key[1].split('_')
1969 if Target == self.BuildTarget or Target == "*":
1970 if ToolChain == self.ToolChain or ToolChain == "*":
1971 if Arch == self.Arch or Arch == "*":
1972 if Options[Key].startswith("="):
1973 if OverrideList.get(Key[1]) != None:
1974 OverrideList.pop(Key[1])
1975 OverrideList[Key[1]] = Options[Key]
1976
1977 #
1978 # Use the highest priority value.
1979 #
1980 if (len(OverrideList) >= 2):
1981 KeyList = OverrideList.keys()
1982 for Index in range(len(KeyList)):
1983 NowKey = KeyList[Index]
1984 Target1, ToolChain1, Arch1, CommandType1, Attr1 = NowKey.split("_")
1985 for Index1 in range(len(KeyList) - Index - 1):
1986 NextKey = KeyList[Index1 + Index + 1]
1987 #
1988 # Compare two Key, if one is included by another, choose the higher priority one
1989 #
1990 Target2, ToolChain2, Arch2, CommandType2, Attr2 = NextKey.split("_")
1991 if Target1 == Target2 or Target1 == "*" or Target2 == "*":
1992 if ToolChain1 == ToolChain2 or ToolChain1 == "*" or ToolChain2 == "*":
1993 if Arch1 == Arch2 or Arch1 == "*" or Arch2 == "*":
1994 if CommandType1 == CommandType2 or CommandType1 == "*" or CommandType2 == "*":
1995 if Attr1 == Attr2 or Attr1 == "*" or Attr2 == "*":
1996 if self.CalculatePriorityValue(NowKey) > self.CalculatePriorityValue(NextKey):
1997 if Options.get((self.BuildRuleFamily, NextKey)) != None:
1998 Options.pop((self.BuildRuleFamily, NextKey))
1999 else:
2000 if Options.get((self.BuildRuleFamily, NowKey)) != None:
2001 Options.pop((self.BuildRuleFamily, NowKey))
2002
2003 OverrideOpt = set()
2004 for Key in Options:
2005 if ModuleStyle != None and len (Key) > 2:
2006 # Check Module style is EDK or EDKII.
2007 # Only append build option for the matched style module.
2008 if ModuleStyle == EDK_NAME and Key[2] != EDK_NAME:
2009 continue
2010 elif ModuleStyle == EDKII_NAME and Key[2] != EDKII_NAME:
2011 continue
2012 Family = Key[0]
2013 Target, Tag, Arch, Tool, Attr = Key[1].split("_")
2014 # if tool chain family doesn't match, skip it
2015 if Tool in self.ToolDefinition and Family != "":
2016 FamilyIsNull = False
2017 if self.ToolDefinition[Tool].get(TAB_TOD_DEFINES_BUILDRULEFAMILY, "") != "":
2018 if Family != self.ToolDefinition[Tool][TAB_TOD_DEFINES_BUILDRULEFAMILY]:
2019 continue
2020 elif Family != self.ToolDefinition[Tool][TAB_TOD_DEFINES_FAMILY]:
2021 continue
2022 FamilyMatch = True
2023 # expand any wildcard
2024 if Target == "*" or Target == self.BuildTarget:
2025 if Tag == "*" or Tag == self.ToolChain:
2026 if Arch == "*" or Arch == self.Arch:
2027 if Tool not in BuildOptions:
2028 BuildOptions[Tool] = {}
2029 if Options[Key].startswith('='):
2030 OverrideOpt.add((Tool, Attr))
2031 if Attr != "FLAGS" or Attr not in BuildOptions[Tool] or (Tool, Attr) in OverrideOpt:
2032 BuildOptions[Tool][Attr] = Options[Key]
2033 else:
2034 # append options for the same tool
2035 BuildOptions[Tool][Attr] += " " + Options[Key]
2036 # Build Option Family has been checked, which need't to be checked again for family.
2037 if FamilyMatch or FamilyIsNull:
2038 return BuildOptions
2039
2040 OverrideOpt = set()
2041 for Key in Options:
2042 if ModuleStyle != None and len (Key) > 2:
2043 # Check Module style is EDK or EDKII.
2044 # Only append build option for the matched style module.
2045 if ModuleStyle == EDK_NAME and Key[2] != EDK_NAME:
2046 continue
2047 elif ModuleStyle == EDKII_NAME and Key[2] != EDKII_NAME:
2048 continue
2049 Family = Key[0]
2050 Target, Tag, Arch, Tool, Attr = Key[1].split("_")
2051 # if tool chain family doesn't match, skip it
2052 if Tool not in self.ToolDefinition or Family =="":
2053 continue
2054 # option has been added before
2055 if Family != self.ToolDefinition[Tool][TAB_TOD_DEFINES_FAMILY]:
2056 continue
2057
2058 # expand any wildcard
2059 if Target == "*" or Target == self.BuildTarget:
2060 if Tag == "*" or Tag == self.ToolChain:
2061 if Arch == "*" or Arch == self.Arch:
2062 if Tool not in BuildOptions:
2063 BuildOptions[Tool] = {}
2064 if Options[Key].startswith('='):
2065 OverrideOpt.add((Tool, Attr))
2066 if Attr != "FLAGS" or Attr not in BuildOptions[Tool] or (Tool, Attr) in OverrideOpt:
2067 BuildOptions[Tool][Attr] = Options[Key]
2068 else:
2069 # append options for the same tool
2070 BuildOptions[Tool][Attr] += " " + Options[Key]
2071 return BuildOptions
2072
2073 ## Append build options in platform to a module
2074 #
2075 # @param Module The module to which the build options will be appened
2076 #
2077 # @retval options The options appended with build options in platform
2078 #
2079 def ApplyBuildOption(self, Module):
2080 # Get the different options for the different style module
2081 if Module.AutoGenVersion < 0x00010005:
2082 PlatformOptions = self.EdkBuildOption
2083 ModuleTypeOptions = self.Platform.GetBuildOptionsByModuleType(EDK_NAME, Module.ModuleType)
2084 else:
2085 PlatformOptions = self.EdkIIBuildOption
2086 ModuleTypeOptions = self.Platform.GetBuildOptionsByModuleType(EDKII_NAME, Module.ModuleType)
2087 ModuleTypeOptions = self._ExpandBuildOption(ModuleTypeOptions)
2088 ModuleOptions = self._ExpandBuildOption(Module.BuildOptions)
2089 if Module in self.Platform.Modules:
2090 PlatformModule = self.Platform.Modules[str(Module)]
2091 PlatformModuleOptions = self._ExpandBuildOption(PlatformModule.BuildOptions)
2092 else:
2093 PlatformModuleOptions = {}
2094
2095 BuildRuleOrder = None
2096 for Options in [self.ToolDefinition, ModuleOptions, PlatformOptions, ModuleTypeOptions, PlatformModuleOptions]:
2097 for Tool in Options:
2098 for Attr in Options[Tool]:
2099 if Attr == TAB_TOD_DEFINES_BUILDRULEORDER:
2100 BuildRuleOrder = Options[Tool][Attr]
2101
2102 AllTools = set(ModuleOptions.keys() + PlatformOptions.keys() +
2103 PlatformModuleOptions.keys() + ModuleTypeOptions.keys() +
2104 self.ToolDefinition.keys())
2105 BuildOptions = {}
2106 OverrideTool = set()
2107 for Tool in AllTools:
2108 if Tool not in BuildOptions:
2109 BuildOptions[Tool] = {}
2110
2111 for Options in [self.ToolDefinition, ModuleOptions, PlatformOptions, ModuleTypeOptions, PlatformModuleOptions]:
2112 if Tool not in Options:
2113 continue
2114 for Attr in Options[Tool]:
2115 Value = Options[Tool][Attr]
2116 #
2117 # Do not generate it in Makefile
2118 #
2119 if Attr == TAB_TOD_DEFINES_BUILDRULEORDER:
2120 continue
2121 if Attr not in BuildOptions[Tool]:
2122 BuildOptions[Tool][Attr] = ""
2123 # check if override is indicated
2124 if Value.startswith('='):
2125 OverrideTool.add((Tool, Attr))
2126 BuildOptions[Tool][Attr] = Value[1:]
2127 elif (Tool, Attr) not in OverrideTool:
2128 BuildOptions[Tool][Attr] += " " + Value
2129 if Module.AutoGenVersion < 0x00010005 and self.Workspace.UniFlag != None:
2130 #
2131 # Override UNI flag only for EDK module.
2132 #
2133 if 'BUILD' not in BuildOptions:
2134 BuildOptions['BUILD'] = {}
2135 BuildOptions['BUILD']['FLAGS'] = self.Workspace.UniFlag
2136 return BuildOptions, BuildRuleOrder
2137
2138 Platform = property(_GetPlatform)
2139 Name = property(_GetName)
2140 Guid = property(_GetGuid)
2141 Version = property(_GetVersion)
2142
2143 OutputDir = property(_GetOutputDir)
2144 BuildDir = property(_GetBuildDir)
2145 MakeFileDir = property(_GetMakeFileDir)
2146 FdfFile = property(_GetFdfFile)
2147
2148 PcdTokenNumber = property(_GetPcdTokenNumbers) # (TokenCName, TokenSpaceGuidCName) : GeneratedTokenNumber
2149 DynamicPcdList = property(_GetDynamicPcdList) # [(TokenCName1, TokenSpaceGuidCName1), (TokenCName2, TokenSpaceGuidCName2), ...]
2150 NonDynamicPcdList = property(_GetNonDynamicPcdList) # [(TokenCName1, TokenSpaceGuidCName1), (TokenCName2, TokenSpaceGuidCName2), ...]
2151 NonDynamicPcdDict = property(_GetNonDynamicPcdDict)
2152 PackageList = property(_GetPackageList)
2153
2154 ToolDefinition = property(_GetToolDefinition) # toolcode : tool path
2155 ToolDefinitionFile = property(_GetToolDefFile) # toolcode : lib path
2156 ToolChainFamily = property(_GetToolChainFamily)
2157 BuildRuleFamily = property(_GetBuildRuleFamily)
2158 BuildOption = property(_GetBuildOptions) # toolcode : option
2159 EdkBuildOption = property(_GetEdkBuildOptions) # edktoolcode : option
2160 EdkIIBuildOption = property(_GetEdkIIBuildOptions) # edkiitoolcode : option
2161
2162 BuildCommand = property(_GetBuildCommand)
2163 BuildRule = property(_GetBuildRule)
2164 ModuleAutoGenList = property(_GetModuleAutoGenList)
2165 LibraryAutoGenList = property(_GetLibraryAutoGenList)
2166 GenFdsCommand = property(_GenFdsCommand)
2167
2168 ## ModuleAutoGen class
2169 #
2170 # This class encapsules the AutoGen behaviors for the build tools. In addition to
2171 # the generation of AutoGen.h and AutoGen.c, it will generate *.depex file according
2172 # to the [depex] section in module's inf file.
2173 #
2174 class ModuleAutoGen(AutoGen):
2175 ## The real constructor of ModuleAutoGen
2176 #
2177 # This method is not supposed to be called by users of ModuleAutoGen. It's
2178 # only used by factory method __new__() to do real initialization work for an
2179 # object of ModuleAutoGen
2180 #
2181 # @param Workspace EdkIIWorkspaceBuild object
2182 # @param ModuleFile The path of module file
2183 # @param Target Build target (DEBUG, RELEASE)
2184 # @param Toolchain Name of tool chain
2185 # @param Arch The arch the module supports
2186 # @param PlatformFile Platform meta-file
2187 #
2188 def _Init(self, Workspace, ModuleFile, Target, Toolchain, Arch, PlatformFile):
2189 EdkLogger.debug(EdkLogger.DEBUG_9, "AutoGen module [%s] [%s]" % (ModuleFile, Arch))
2190 GlobalData.gProcessingFile = "%s [%s, %s, %s]" % (ModuleFile, Arch, Toolchain, Target)
2191
2192 self.Workspace = Workspace
2193 self.WorkspaceDir = Workspace.WorkspaceDir
2194
2195 self.MetaFile = ModuleFile
2196 self.PlatformInfo = PlatformAutoGen(Workspace, PlatformFile, Target, Toolchain, Arch)
2197 # check if this module is employed by active platform
2198 if not self.PlatformInfo.ValidModule(self.MetaFile):
2199 EdkLogger.verbose("Module [%s] for [%s] is not employed by active platform\n" \
2200 % (self.MetaFile, Arch))
2201 return False
2202
2203 self.SourceDir = self.MetaFile.SubDir
2204 if self.SourceDir.upper().find(self.WorkspaceDir.upper()) == 0:
2205 self.SourceDir = self.SourceDir[len(self.WorkspaceDir) + 1:]
2206
2207 self.SourceOverrideDir = None
2208 # use overrided path defined in DSC file
2209 if self.MetaFile.Key in GlobalData.gOverrideDir:
2210 self.SourceOverrideDir = GlobalData.gOverrideDir[self.MetaFile.Key]
2211
2212 self.ToolChain = Toolchain
2213 self.BuildTarget = Target
2214 self.Arch = Arch
2215 self.ToolChainFamily = self.PlatformInfo.ToolChainFamily
2216 self.BuildRuleFamily = self.PlatformInfo.BuildRuleFamily
2217
2218 self.IsMakeFileCreated = False
2219 self.IsCodeFileCreated = False
2220 self.IsAsBuiltInfCreated = False
2221 self.DepexGenerated = False
2222
2223 self.BuildDatabase = self.Workspace.BuildDatabase
2224 self.BuildRuleOrder = None
2225
2226 self._Module = None
2227 self._Name = None
2228 self._Guid = None
2229 self._Version = None
2230 self._ModuleType = None
2231 self._ComponentType = None
2232 self._PcdIsDriver = None
2233 self._AutoGenVersion = None
2234 self._LibraryFlag = None
2235 self._CustomMakefile = None
2236 self._Macro = None
2237
2238 self._BuildDir = None
2239 self._OutputDir = None
2240 self._DebugDir = None
2241 self._MakeFileDir = None
2242
2243 self._IncludePathList = None
2244 self._AutoGenFileList = None
2245 self._UnicodeFileList = None
2246 self._SourceFileList = None
2247 self._ObjectFileList = None
2248 self._BinaryFileList = None
2249
2250 self._DependentPackageList = None
2251 self._DependentLibraryList = None
2252 self._LibraryAutoGenList = None
2253 self._DerivedPackageList = None
2254 self._ModulePcdList = None
2255 self._LibraryPcdList = None
2256 self._PcdComments = sdict()
2257 self._GuidList = None
2258 self._GuidsUsedByPcd = None
2259 self._GuidComments = sdict()
2260 self._ProtocolList = None
2261 self._ProtocolComments = sdict()
2262 self._PpiList = None
2263 self._PpiComments = sdict()
2264 self._DepexList = None
2265 self._DepexExpressionList = None
2266 self._BuildOption = None
2267 self._BuildOptionIncPathList = None
2268 self._BuildTargets = None
2269 self._IntroBuildTargetList = None
2270 self._FinalBuildTargetList = None
2271 self._FileTypes = None
2272 self._BuildRules = None
2273
2274 ## The Modules referenced to this Library
2275 # Only Library has this attribute
2276 self._ReferenceModules = []
2277
2278 ## Store the FixedAtBuild Pcds
2279 #
2280 self._FixedAtBuildPcds = []
2281 self.ConstPcd = {}
2282 return True
2283
2284 def __repr__(self):
2285 return "%s [%s]" % (self.MetaFile, self.Arch)
2286
2287 # Get FixedAtBuild Pcds of this Module
2288 def _GetFixedAtBuildPcds(self):
2289 if self._FixedAtBuildPcds:
2290 return self._FixedAtBuildPcds
2291 for Pcd in self.ModulePcdList:
2292 if self.IsLibrary:
2293 if not (Pcd.Pending == False and Pcd.Type == "FixedAtBuild"):
2294 continue
2295 elif Pcd.Type != "FixedAtBuild":
2296 continue
2297 if Pcd not in self._FixedAtBuildPcds:
2298 self._FixedAtBuildPcds.append(Pcd)
2299
2300 return self._FixedAtBuildPcds
2301
2302 def _GetUniqueBaseName(self):
2303 BaseName = self.Name
2304 for Module in self.PlatformInfo.ModuleAutoGenList:
2305 if Module.MetaFile == self.MetaFile:
2306 continue
2307 if Module.Name == self.Name:
2308 if uuid.UUID(Module.Guid) == uuid.UUID(self.Guid):
2309 EdkLogger.error("build", FILE_DUPLICATED, 'Modules have same BaseName and FILE_GUID:\n'
2310 ' %s\n %s' % (Module.MetaFile, self.MetaFile))
2311 BaseName = '%s_%s' % (self.Name, self.Guid)
2312 return BaseName
2313
2314 # Macros could be used in build_rule.txt (also Makefile)
2315 def _GetMacros(self):
2316 if self._Macro == None:
2317 self._Macro = sdict()
2318 self._Macro["WORKSPACE" ] = self.WorkspaceDir
2319 self._Macro["MODULE_NAME" ] = self.Name
2320 self._Macro["MODULE_NAME_GUID" ] = self._GetUniqueBaseName()
2321 self._Macro["MODULE_GUID" ] = self.Guid
2322 self._Macro["MODULE_VERSION" ] = self.Version
2323 self._Macro["MODULE_TYPE" ] = self.ModuleType
2324 self._Macro["MODULE_FILE" ] = str(self.MetaFile)
2325 self._Macro["MODULE_FILE_BASE_NAME" ] = self.MetaFile.BaseName
2326 self._Macro["MODULE_RELATIVE_DIR" ] = self.SourceDir
2327 self._Macro["MODULE_DIR" ] = self.SourceDir
2328
2329 self._Macro["BASE_NAME" ] = self.Name
2330
2331 self._Macro["ARCH" ] = self.Arch
2332 self._Macro["TOOLCHAIN" ] = self.ToolChain
2333 self._Macro["TOOLCHAIN_TAG" ] = self.ToolChain
2334 self._Macro["TOOL_CHAIN_TAG" ] = self.ToolChain
2335 self._Macro["TARGET" ] = self.BuildTarget
2336
2337 self._Macro["BUILD_DIR" ] = self.PlatformInfo.BuildDir
2338 self._Macro["BIN_DIR" ] = os.path.join(self.PlatformInfo.BuildDir, self.Arch)
2339 self._Macro["LIB_DIR" ] = os.path.join(self.PlatformInfo.BuildDir, self.Arch)
2340 self._Macro["MODULE_BUILD_DIR" ] = self.BuildDir
2341 self._Macro["OUTPUT_DIR" ] = self.OutputDir
2342 self._Macro["DEBUG_DIR" ] = self.DebugDir
2343 return self._Macro
2344
2345 ## Return the module build data object
2346 def _GetModule(self):
2347 if self._Module == None:
2348 self._Module = self.Workspace.BuildDatabase[self.MetaFile, self.Arch, self.BuildTarget, self.ToolChain]
2349 return self._Module
2350
2351 ## Return the module name
2352 def _GetBaseName(self):
2353 return self.Module.BaseName
2354
2355 ## Return the module DxsFile if exist
2356 def _GetDxsFile(self):
2357 return self.Module.DxsFile
2358
2359 ## Return the module SourceOverridePath
2360 def _GetSourceOverridePath(self):
2361 return self.Module.SourceOverridePath
2362
2363 ## Return the module meta-file GUID
2364 def _GetGuid(self):
2365 #
2366 # To build same module more than once, the module path with FILE_GUID overridden has
2367 # the file name FILE_GUIDmodule.inf, but the relative path (self.MetaFile.File) is the realy path
2368 # in DSC. The overridden GUID can be retrieved from file name
2369 #
2370 if os.path.basename(self.MetaFile.File) != os.path.basename(self.MetaFile.Path):
2371 #
2372 # Length of GUID is 36
2373 #
2374 return os.path.basename(self.MetaFile.Path)[:36]
2375 return self.Module.Guid
2376
2377 ## Return the module version
2378 def _GetVersion(self):
2379 return self.Module.Version
2380
2381 ## Return the module type
2382 def _GetModuleType(self):
2383 return self.Module.ModuleType
2384
2385 ## Return the component type (for Edk.x style of module)
2386 def _GetComponentType(self):
2387 return self.Module.ComponentType
2388
2389 ## Return the build type
2390 def _GetBuildType(self):
2391 return self.Module.BuildType
2392
2393 ## Return the PCD_IS_DRIVER setting
2394 def _GetPcdIsDriver(self):
2395 return self.Module.PcdIsDriver
2396
2397 ## Return the autogen version, i.e. module meta-file version
2398 def _GetAutoGenVersion(self):
2399 return self.Module.AutoGenVersion
2400
2401 ## Check if the module is library or not
2402 def _IsLibrary(self):
2403 if self._LibraryFlag == None:
2404 if self.Module.LibraryClass != None and self.Module.LibraryClass != []:
2405 self._LibraryFlag = True
2406 else:
2407 self._LibraryFlag = False
2408 return self._LibraryFlag
2409
2410 ## Check if the module is binary module or not
2411 def _IsBinaryModule(self):
2412 return self.Module.IsBinaryModule
2413
2414 ## Return the directory to store intermediate files of the module
2415 def _GetBuildDir(self):
2416 if self._BuildDir == None:
2417 self._BuildDir = path.join(
2418 self.PlatformInfo.BuildDir,
2419 self.Arch,
2420 self.SourceDir,
2421 self.MetaFile.BaseName
2422 )
2423 CreateDirectory(self._BuildDir)
2424 return self._BuildDir
2425
2426 ## Return the directory to store the intermediate object files of the mdoule
2427 def _GetOutputDir(self):
2428 if self._OutputDir == None:
2429 self._OutputDir = path.join(self.BuildDir, "OUTPUT")
2430 CreateDirectory(self._OutputDir)
2431 return self._OutputDir
2432
2433 ## Return the directory to store auto-gened source files of the mdoule
2434 def _GetDebugDir(self):
2435 if self._DebugDir == None:
2436 self._DebugDir = path.join(self.BuildDir, "DEBUG")
2437 CreateDirectory(self._DebugDir)
2438 return self._DebugDir
2439
2440 ## Return the path of custom file
2441 def _GetCustomMakefile(self):
2442 if self._CustomMakefile == None:
2443 self._CustomMakefile = {}
2444 for Type in self.Module.CustomMakefile:
2445 if Type in gMakeTypeMap:
2446 MakeType = gMakeTypeMap[Type]
2447 else:
2448 MakeType = 'nmake'
2449 if self.SourceOverrideDir != None:
2450 File = os.path.join(self.SourceOverrideDir, self.Module.CustomMakefile[Type])
2451 if not os.path.exists(File):
2452 File = os.path.join(self.SourceDir, self.Module.CustomMakefile[Type])
2453 else:
2454 File = os.path.join(self.SourceDir, self.Module.CustomMakefile[Type])
2455 self._CustomMakefile[MakeType] = File
2456 return self._CustomMakefile
2457
2458 ## Return the directory of the makefile
2459 #
2460 # @retval string The directory string of module's makefile
2461 #
2462 def _GetMakeFileDir(self):
2463 return self.BuildDir
2464
2465 ## Return build command string
2466 #
2467 # @retval string Build command string
2468 #
2469 def _GetBuildCommand(self):
2470 return self.PlatformInfo.BuildCommand
2471
2472 ## Get object list of all packages the module and its dependent libraries belong to
2473 #
2474 # @retval list The list of package object
2475 #
2476 def _GetDerivedPackageList(self):
2477 PackageList = []
2478 for M in [self.Module] + self.DependentLibraryList:
2479 for Package in M.Packages:
2480 if Package in PackageList:
2481 continue
2482 PackageList.append(Package)
2483 return PackageList
2484
2485 ## Get the depex string
2486 #
2487 # @return : a string contain all depex expresion.
2488 def _GetDepexExpresionString(self):
2489 DepexStr = ''
2490 DepexList = []
2491 ## DPX_SOURCE IN Define section.
2492 if self.Module.DxsFile:
2493 return DepexStr
2494 for M in [self.Module] + self.DependentLibraryList:
2495 Filename = M.MetaFile.Path
2496 InfObj = InfSectionParser.InfSectionParser(Filename)
2497 DepexExpresionList = InfObj.GetDepexExpresionList()
2498 for DepexExpresion in DepexExpresionList:
2499 for key in DepexExpresion.keys():
2500 Arch, ModuleType = key
2501 # the type of build module is USER_DEFINED.
2502 # All different DEPEX section tags would be copied into the As Built INF file
2503 # and there would be separate DEPEX section tags
2504 if self.ModuleType.upper() == SUP_MODULE_USER_DEFINED:
2505 if (Arch.upper() == self.Arch.upper()) and (ModuleType.upper() != TAB_ARCH_COMMON):
2506 DepexList.append({(Arch, ModuleType): DepexExpresion[key][:]})
2507 else:
2508 if Arch.upper() == TAB_ARCH_COMMON or \
2509 (Arch.upper() == self.Arch.upper() and \
2510 ModuleType.upper() in [TAB_ARCH_COMMON, self.ModuleType.upper()]):
2511 DepexList.append({(Arch, ModuleType): DepexExpresion[key][:]})
2512
2513 #the type of build module is USER_DEFINED.
2514 if self.ModuleType.upper() == SUP_MODULE_USER_DEFINED:
2515 for Depex in DepexList:
2516 for key in Depex.keys():
2517 DepexStr += '[Depex.%s.%s]\n' % key
2518 DepexStr += '\n'.join(['# '+ val for val in Depex[key]])
2519 DepexStr += '\n\n'
2520 if not DepexStr:
2521 return '[Depex.%s]\n' % self.Arch
2522 return DepexStr
2523
2524 #the type of build module not is USER_DEFINED.
2525 Count = 0
2526 for Depex in DepexList:
2527 Count += 1
2528 if DepexStr != '':
2529 DepexStr += ' AND '
2530 DepexStr += '('
2531 for D in Depex.values():
2532 DepexStr += ' '.join([val for val in D])
2533 Index = DepexStr.find('END')
2534 if Index > -1 and Index == len(DepexStr) - 3:
2535 DepexStr = DepexStr[:-3]
2536 DepexStr = DepexStr.strip()
2537 DepexStr += ')'
2538 if Count == 1:
2539 DepexStr = DepexStr.lstrip('(').rstrip(')').strip()
2540 if not DepexStr:
2541 return '[Depex.%s]\n' % self.Arch
2542 return '[Depex.%s]\n# ' % self.Arch + DepexStr
2543
2544 ## Merge dependency expression
2545 #
2546 # @retval list The token list of the dependency expression after parsed
2547 #
2548 def _GetDepexTokenList(self):
2549 if self._DepexList == None:
2550 self._DepexList = {}
2551 if self.DxsFile or self.IsLibrary or TAB_DEPENDENCY_EXPRESSION_FILE in self.FileTypes:
2552 return self._DepexList
2553
2554 self._DepexList[self.ModuleType] = []
2555
2556 for ModuleType in self._DepexList:
2557 DepexList = self._DepexList[ModuleType]
2558 #
2559 # Append depex from dependent libraries, if not "BEFORE", "AFTER" expresion
2560 #
2561 for M in [self.Module] + self.DependentLibraryList:
2562 Inherited = False
2563 for D in M.Depex[self.Arch, ModuleType]:
2564 if DepexList != []:
2565 DepexList.append('AND')
2566 DepexList.append('(')
2567 DepexList.extend(D)
2568 if DepexList[-1] == 'END': # no need of a END at this time
2569 DepexList.pop()
2570 DepexList.append(')')
2571 Inherited = True
2572 if Inherited:
2573 EdkLogger.verbose("DEPEX[%s] (+%s) = %s" % (self.Name, M.BaseName, DepexList))
2574 if 'BEFORE' in DepexList or 'AFTER' in DepexList:
2575 break
2576 if len(DepexList) > 0:
2577 EdkLogger.verbose('')
2578 return self._DepexList
2579
2580 ## Merge dependency expression
2581 #
2582 # @retval list The token list of the dependency expression after parsed
2583 #
2584 def _GetDepexExpressionTokenList(self):
2585 if self._DepexExpressionList == None:
2586 self._DepexExpressionList = {}
2587 if self.DxsFile or self.IsLibrary or TAB_DEPENDENCY_EXPRESSION_FILE in self.FileTypes:
2588 return self._DepexExpressionList
2589
2590 self._DepexExpressionList[self.ModuleType] = ''
2591
2592 for ModuleType in self._DepexExpressionList:
2593 DepexExpressionList = self._DepexExpressionList[ModuleType]
2594 #
2595 # Append depex from dependent libraries, if not "BEFORE", "AFTER" expresion
2596 #
2597 for M in [self.Module] + self.DependentLibraryList:
2598 Inherited = False
2599 for D in M.DepexExpression[self.Arch, ModuleType]:
2600 if DepexExpressionList != '':
2601 DepexExpressionList += ' AND '
2602 DepexExpressionList += '('
2603 DepexExpressionList += D
2604 DepexExpressionList = DepexExpressionList.rstrip('END').strip()
2605 DepexExpressionList += ')'
2606 Inherited = True
2607 if Inherited:
2608 EdkLogger.verbose("DEPEX[%s] (+%s) = %s" % (self.Name, M.BaseName, DepexExpressionList))
2609 if 'BEFORE' in DepexExpressionList or 'AFTER' in DepexExpressionList:
2610 break
2611 if len(DepexExpressionList) > 0:
2612 EdkLogger.verbose('')
2613 self._DepexExpressionList[ModuleType] = DepexExpressionList
2614 return self._DepexExpressionList
2615
2616 ## Return the list of specification version required for the module
2617 #
2618 # @retval list The list of specification defined in module file
2619 #
2620 def _GetSpecification(self):
2621 return self.Module.Specification
2622
2623 ## Tool option for the module build
2624 #
2625 # @param PlatformInfo The object of PlatformBuildInfo
2626 # @retval dict The dict containing valid options
2627 #
2628 def _GetModuleBuildOption(self):
2629 if self._BuildOption == None:
2630 self._BuildOption, self.BuildRuleOrder = self.PlatformInfo.ApplyBuildOption(self.Module)
2631 if self.BuildRuleOrder:
2632 self.BuildRuleOrder = ['.%s' % Ext for Ext in self.BuildRuleOrder.split()]
2633 return self._BuildOption
2634
2635 ## Get include path list from tool option for the module build
2636 #
2637 # @retval list The include path list
2638 #
2639 def _GetBuildOptionIncPathList(self):
2640 if self._BuildOptionIncPathList == None:
2641 #
2642 # Regular expression for finding Include Directories, the difference between MSFT and INTEL/GCC/RVCT
2643 # is the former use /I , the Latter used -I to specify include directories
2644 #
2645 if self.PlatformInfo.ToolChainFamily in ('MSFT'):
2646 gBuildOptIncludePattern = re.compile(r"(?:.*?)/I[ \t]*([^ ]*)", re.MULTILINE|re.DOTALL)
2647 elif self.PlatformInfo.ToolChainFamily in ('INTEL', 'GCC', 'RVCT'):
2648 gBuildOptIncludePattern = re.compile(r"(?:.*?)-I[ \t]*([^ ]*)", re.MULTILINE|re.DOTALL)
2649 else:
2650 #
2651 # New ToolChainFamily, don't known whether there is option to specify include directories
2652 #
2653 self._BuildOptionIncPathList = []
2654 return self._BuildOptionIncPathList
2655
2656 BuildOptionIncPathList = []
2657 for Tool in ('CC', 'PP', 'VFRPP', 'ASLPP', 'ASLCC', 'APP', 'ASM'):
2658 Attr = 'FLAGS'
2659 try:
2660 FlagOption = self.BuildOption[Tool][Attr]
2661 except KeyError:
2662 FlagOption = ''
2663
2664 if self.PlatformInfo.ToolChainFamily != 'RVCT':
2665 IncPathList = [NormPath(Path, self.Macros) for Path in gBuildOptIncludePattern.findall(FlagOption)]
2666 else:
2667 #
2668 # RVCT may specify a list of directory seperated by commas
2669 #
2670 IncPathList = []
2671 for Path in gBuildOptIncludePattern.findall(FlagOption):
2672 PathList = GetSplitList(Path, TAB_COMMA_SPLIT)
2673 IncPathList += [NormPath(PathEntry, self.Macros) for PathEntry in PathList]
2674
2675 #
2676 # EDK II modules must not reference header files outside of the packages they depend on or
2677 # within the module's directory tree. Report error if violation.
2678 #
2679 if self.AutoGenVersion >= 0x00010005 and len(IncPathList) > 0:
2680 for Path in IncPathList:
2681 if (Path not in self.IncludePathList) and (CommonPath([Path, self.MetaFile.Dir]) != self.MetaFile.Dir):
2682 ErrMsg = "The include directory for the EDK II module in this line is invalid %s specified in %s FLAGS '%s'" % (Path, Tool, FlagOption)
2683 EdkLogger.error("build",
2684 PARAMETER_INVALID,
2685 ExtraData = ErrMsg,
2686 File = str(self.MetaFile))
2687
2688
2689 BuildOptionIncPathList += IncPathList
2690
2691 self._BuildOptionIncPathList = BuildOptionIncPathList
2692
2693 return self._BuildOptionIncPathList
2694
2695 ## Return a list of files which can be built from source
2696 #
2697 # What kind of files can be built is determined by build rules in
2698 # $(CONF_DIRECTORY)/build_rule.txt and toolchain family.
2699 #
2700 def _GetSourceFileList(self):
2701 if self._SourceFileList == None:
2702 self._SourceFileList = []
2703 for F in self.Module.Sources:
2704 # match tool chain
2705 if F.TagName not in ("", "*", self.ToolChain):
2706 EdkLogger.debug(EdkLogger.DEBUG_9, "The toolchain [%s] for processing file [%s] is found, "
2707 "but [%s] is needed" % (F.TagName, str(F), self.ToolChain))
2708 continue
2709 # match tool chain family
2710 if F.ToolChainFamily not in ("", "*", self.ToolChainFamily):
2711 EdkLogger.debug(
2712 EdkLogger.DEBUG_0,
2713 "The file [%s] must be built by tools of [%s], " \
2714 "but current toolchain family is [%s]" \
2715 % (str(F), F.ToolChainFamily, self.ToolChainFamily))
2716 continue
2717
2718 # add the file path into search path list for file including
2719 if F.Dir not in self.IncludePathList and self.AutoGenVersion >= 0x00010005:
2720 self.IncludePathList.insert(0, F.Dir)
2721 self._SourceFileList.append(F)
2722 self._ApplyBuildRule(F, TAB_UNKNOWN_FILE)
2723 return self._SourceFileList
2724
2725 ## Return the list of unicode files
2726 def _GetUnicodeFileList(self):
2727 if self._UnicodeFileList == None:
2728 if TAB_UNICODE_FILE in self.FileTypes:
2729 self._UnicodeFileList = self.FileTypes[TAB_UNICODE_FILE]
2730 else:
2731 self._UnicodeFileList = []
2732 return self._UnicodeFileList
2733
2734 ## Return a list of files which can be built from binary
2735 #
2736 # "Build" binary files are just to copy them to build directory.
2737 #
2738 # @retval list The list of files which can be built later
2739 #
2740 def _GetBinaryFiles(self):
2741 if self._BinaryFileList == None:
2742 self._BinaryFileList = []
2743 for F in self.Module.Binaries:
2744 if F.Target not in ['COMMON', '*'] and F.Target != self.BuildTarget:
2745 continue
2746 self._BinaryFileList.append(F)
2747 self._ApplyBuildRule(F, F.Type)
2748 return self._BinaryFileList
2749
2750 def _GetBuildRules(self):
2751 if self._BuildRules == None:
2752 BuildRules = {}
2753 BuildRuleDatabase = self.PlatformInfo.BuildRule
2754 for Type in BuildRuleDatabase.FileTypeList:
2755 #first try getting build rule by BuildRuleFamily
2756 RuleObject = BuildRuleDatabase[Type, self.BuildType, self.Arch, self.BuildRuleFamily]
2757 if not RuleObject:
2758 # build type is always module type, but ...
2759 if self.ModuleType != self.BuildType:
2760 RuleObject = BuildRuleDatabase[Type, self.ModuleType, self.Arch, self.BuildRuleFamily]
2761 #second try getting build rule by ToolChainFamily
2762 if not RuleObject:
2763 RuleObject = BuildRuleDatabase[Type, self.BuildType, self.Arch, self.ToolChainFamily]
2764 if not RuleObject:
2765 # build type is always module type, but ...
2766 if self.ModuleType != self.BuildType:
2767 RuleObject = BuildRuleDatabase[Type, self.ModuleType, self.Arch, self.ToolChainFamily]
2768 if not RuleObject:
2769 continue
2770 RuleObject = RuleObject.Instantiate(self.Macros)
2771 BuildRules[Type] = RuleObject
2772 for Ext in RuleObject.SourceFileExtList:
2773 BuildRules[Ext] = RuleObject
2774 self._BuildRules = BuildRules
2775 return self._BuildRules
2776
2777 def _ApplyBuildRule(self, File, FileType):
2778 if self._BuildTargets == None:
2779 self._IntroBuildTargetList = set()
2780 self._FinalBuildTargetList = set()
2781 self._BuildTargets = {}
2782 self._FileTypes = {}
2783
2784 SubDirectory = os.path.join(self.OutputDir, File.SubDir)
2785 if not os.path.exists(SubDirectory):
2786 CreateDirectory(SubDirectory)
2787 LastTarget = None
2788 RuleChain = []
2789 SourceList = [File]
2790 Index = 0
2791 #
2792 # Make sure to get build rule order value
2793 #
2794 self._GetModuleBuildOption()
2795
2796 while Index < len(SourceList):
2797 Source = SourceList[Index]
2798 Index = Index + 1
2799
2800 if Source != File:
2801 CreateDirectory(Source.Dir)
2802
2803 if File.IsBinary and File == Source and self._BinaryFileList != None and File in self._BinaryFileList:
2804 # Skip all files that are not binary libraries
2805 if not self.IsLibrary:
2806 continue
2807 RuleObject = self.BuildRules[TAB_DEFAULT_BINARY_FILE]
2808 elif FileType in self.BuildRules:
2809 RuleObject = self.BuildRules[FileType]
2810 elif Source.Ext in self.BuildRules:
2811 RuleObject = self.BuildRules[Source.Ext]
2812 else:
2813 # stop at no more rules
2814 if LastTarget:
2815 self._FinalBuildTargetList.add(LastTarget)
2816 break
2817
2818 FileType = RuleObject.SourceFileType
2819 if FileType not in self._FileTypes:
2820 self._FileTypes[FileType] = set()
2821 self._FileTypes[FileType].add(Source)
2822
2823 # stop at STATIC_LIBRARY for library
2824 if self.IsLibrary and FileType == TAB_STATIC_LIBRARY:
2825 if LastTarget:
2826 self._FinalBuildTargetList.add(LastTarget)
2827 break
2828
2829 Target = RuleObject.Apply(Source, self.BuildRuleOrder)
2830 if not Target:
2831 if LastTarget:
2832 self._FinalBuildTargetList.add(LastTarget)
2833 break
2834 elif not Target.Outputs:
2835 # Only do build for target with outputs
2836 self._FinalBuildTargetList.add(Target)
2837
2838 if FileType not in self._BuildTargets:
2839 self._BuildTargets[FileType] = set()
2840 self._BuildTargets[FileType].add(Target)
2841
2842 if not Source.IsBinary and Source == File:
2843 self._IntroBuildTargetList.add(Target)
2844
2845 # to avoid cyclic rule
2846 if FileType in RuleChain:
2847 break
2848
2849 RuleChain.append(FileType)
2850 SourceList.extend(Target.Outputs)
2851 LastTarget = Target
2852 FileType = TAB_UNKNOWN_FILE
2853
2854 def _GetTargets(self):
2855 if self._BuildTargets == None:
2856 self._IntroBuildTargetList = set()
2857 self._FinalBuildTargetList = set()
2858 self._BuildTargets = {}
2859 self._FileTypes = {}
2860
2861 #TRICK: call _GetSourceFileList to apply build rule for source files
2862 if self.SourceFileList:
2863 pass
2864
2865 #TRICK: call _GetBinaryFileList to apply build rule for binary files
2866 if self.BinaryFileList:
2867 pass
2868
2869 return self._BuildTargets
2870
2871 def _GetIntroTargetList(self):
2872 self._GetTargets()
2873 return self._IntroBuildTargetList
2874
2875 def _GetFinalTargetList(self):
2876 self._GetTargets()
2877 return self._FinalBuildTargetList
2878
2879 def _GetFileTypes(self):
2880 self._GetTargets()
2881 return self._FileTypes
2882
2883 ## Get the list of package object the module depends on
2884 #
2885 # @retval list The package object list
2886 #
2887 def _GetDependentPackageList(self):
2888 return self.Module.Packages
2889
2890 ## Return the list of auto-generated code file
2891 #
2892 # @retval list The list of auto-generated file
2893 #
2894 def _GetAutoGenFileList(self):
2895 UniStringAutoGenC = True
2896 UniStringBinBuffer = StringIO()
2897 if self.BuildType == 'UEFI_HII':
2898 UniStringAutoGenC = False
2899 if self._AutoGenFileList == None:
2900 self._AutoGenFileList = {}
2901 AutoGenC = TemplateString()
2902 AutoGenH = TemplateString()
2903 StringH = TemplateString()
2904 GenC.CreateCode(self, AutoGenC, AutoGenH, StringH, UniStringAutoGenC, UniStringBinBuffer)
2905 #
2906 # AutoGen.c is generated if there are library classes in inf, or there are object files
2907 #
2908 if str(AutoGenC) != "" and (len(self.Module.LibraryClasses) > 0
2909 or TAB_OBJECT_FILE in self.FileTypes):
2910 AutoFile = PathClass(gAutoGenCodeFileName, self.DebugDir)
2911 self._AutoGenFileList[AutoFile] = str(AutoGenC)
2912 self._ApplyBuildRule(AutoFile, TAB_UNKNOWN_FILE)
2913 if str(AutoGenH) != "":
2914 AutoFile = PathClass(gAutoGenHeaderFileName, self.DebugDir)
2915 self._AutoGenFileList[AutoFile] = str(AutoGenH)
2916 self._ApplyBuildRule(AutoFile, TAB_UNKNOWN_FILE)
2917 if str(StringH) != "":
2918 AutoFile = PathClass(gAutoGenStringFileName % {"module_name":self.Name}, self.DebugDir)
2919 self._AutoGenFileList[AutoFile] = str(StringH)
2920 self._ApplyBuildRule(AutoFile, TAB_UNKNOWN_FILE)
2921 if UniStringBinBuffer != None and UniStringBinBuffer.getvalue() != "":
2922 AutoFile = PathClass(gAutoGenStringFormFileName % {"module_name":self.Name}, self.OutputDir)
2923 self._AutoGenFileList[AutoFile] = UniStringBinBuffer.getvalue()
2924 AutoFile.IsBinary = True
2925 self._ApplyBuildRule(AutoFile, TAB_UNKNOWN_FILE)
2926 if UniStringBinBuffer != None:
2927 UniStringBinBuffer.close()
2928 return self._AutoGenFileList
2929
2930 ## Return the list of library modules explicitly or implicityly used by this module
2931 def _GetLibraryList(self):
2932 if self._DependentLibraryList == None:
2933 # only merge library classes and PCD for non-library module
2934 if self.IsLibrary:
2935 self._DependentLibraryList = []
2936 else:
2937 if self.AutoGenVersion < 0x00010005:
2938 self._DependentLibraryList = self.PlatformInfo.ResolveLibraryReference(self.Module)
2939 else:
2940 self._DependentLibraryList = self.PlatformInfo.ApplyLibraryInstance(self.Module)
2941 return self._DependentLibraryList
2942
2943 @staticmethod
2944 def UpdateComments(Recver, Src):
2945 for Key in Src:
2946 if Key not in Recver:
2947 Recver[Key] = []
2948 Recver[Key].extend(Src[Key])
2949 ## Get the list of PCDs from current module
2950 #
2951 # @retval list The list of PCD
2952 #
2953 def _GetModulePcdList(self):
2954 if self._ModulePcdList == None:
2955 # apply PCD settings from platform
2956 self._ModulePcdList = self.PlatformInfo.ApplyPcdSetting(self.Module, self.Module.Pcds)
2957 self.UpdateComments(self._PcdComments, self.Module.PcdComments)
2958 return self._ModulePcdList
2959
2960 ## Get the list of PCDs from dependent libraries
2961 #
2962 # @retval list The list of PCD
2963 #
2964 def _GetLibraryPcdList(self):
2965 if self._LibraryPcdList == None:
2966 Pcds = sdict()
2967 if not self.IsLibrary:
2968 # get PCDs from dependent libraries
2969 for Library in self.DependentLibraryList:
2970 self.UpdateComments(self._PcdComments, Library.PcdComments)
2971 for Key in Library.Pcds:
2972 # skip duplicated PCDs
2973 if Key in self.Module.Pcds or Key in Pcds:
2974 continue
2975 Pcds[Key] = copy.copy(Library.Pcds[Key])
2976 # apply PCD settings from platform
2977 self._LibraryPcdList = self.PlatformInfo.ApplyPcdSetting(self.Module, Pcds)
2978 else:
2979 self._LibraryPcdList = []
2980 return self._LibraryPcdList
2981
2982 ## Get the GUID value mapping
2983 #
2984 # @retval dict The mapping between GUID cname and its value
2985 #
2986 def _GetGuidList(self):
2987 if self._GuidList == None:
2988 self._GuidList = sdict()
2989 self._GuidList.update(self.Module.Guids)
2990 for Library in self.DependentLibraryList:
2991 self._GuidList.update(Library.Guids)
2992 self.UpdateComments(self._GuidComments, Library.GuidComments)
2993 self.UpdateComments(self._GuidComments, self.Module.GuidComments)
2994 return self._GuidList
2995
2996 def GetGuidsUsedByPcd(self):
2997 if self._GuidsUsedByPcd == None:
2998 self._GuidsUsedByPcd = sdict()
2999 self._GuidsUsedByPcd.update(self.Module.GetGuidsUsedByPcd())
3000 for Library in self.DependentLibraryList:
3001 self._GuidsUsedByPcd.update(Library.GetGuidsUsedByPcd())
3002 return self._GuidsUsedByPcd
3003 ## Get the protocol value mapping
3004 #
3005 # @retval dict The mapping between protocol cname and its value
3006 #
3007 def _GetProtocolList(self):
3008 if self._ProtocolList == None:
3009 self._ProtocolList = sdict()
3010 self._ProtocolList.update(self.Module.Protocols)
3011 for Library in self.DependentLibraryList:
3012 self._ProtocolList.update(Library.Protocols)
3013 self.UpdateComments(self._ProtocolComments, Library.ProtocolComments)
3014 self.UpdateComments(self._ProtocolComments, self.Module.ProtocolComments)
3015 return self._ProtocolList
3016
3017 ## Get the PPI value mapping
3018 #
3019 # @retval dict The mapping between PPI cname and its value
3020 #
3021 def _GetPpiList(self):
3022 if self._PpiList == None:
3023 self._PpiList = sdict()
3024 self._PpiList.update(self.Module.Ppis)
3025 for Library in self.DependentLibraryList:
3026 self._PpiList.update(Library.Ppis)
3027 self.UpdateComments(self._PpiComments, Library.PpiComments)
3028 self.UpdateComments(self._PpiComments, self.Module.PpiComments)
3029 return self._PpiList
3030
3031 ## Get the list of include search path
3032 #
3033 # @retval list The list path
3034 #
3035 def _GetIncludePathList(self):
3036 if self._IncludePathList == None:
3037 self._IncludePathList = []
3038 if self.AutoGenVersion < 0x00010005:
3039 for Inc in self.Module.Includes:
3040 if Inc not in self._IncludePathList:
3041 self._IncludePathList.append(Inc)
3042 # for Edk modules
3043 Inc = path.join(Inc, self.Arch.capitalize())
3044 if os.path.exists(Inc) and Inc not in self._IncludePathList:
3045 self._IncludePathList.append(Inc)
3046 # Edk module needs to put DEBUG_DIR at the end of search path and not to use SOURCE_DIR all the time
3047 self._IncludePathList.append(self.DebugDir)
3048 else:
3049 self._IncludePathList.append(self.MetaFile.Dir)
3050 self._IncludePathList.append(self.DebugDir)
3051
3052 for Package in self.Module.Packages:
3053 PackageDir = path.join(self.WorkspaceDir, Package.MetaFile.Dir)
3054 if PackageDir not in self._IncludePathList:
3055 self._IncludePathList.append(PackageDir)
3056 for Inc in Package.Includes:
3057 if Inc not in self._IncludePathList:
3058 self._IncludePathList.append(str(Inc))
3059 return self._IncludePathList
3060
3061 ## Get HII EX PCDs which maybe used by VFR
3062 #
3063 # efivarstore used by VFR may relate with HII EX PCDs
3064 # Get the variable name and GUID from efivarstore and HII EX PCD
3065 # List the HII EX PCDs in As Built INF if both name and GUID match.
3066 #
3067 # @retval list HII EX PCDs
3068 #
3069 def _GetPcdsMaybeUsedByVfr(self):
3070 if not self.SourceFileList:
3071 return []
3072
3073 NameGuids = []
3074 for SrcFile in self.SourceFileList:
3075 if SrcFile.Ext.lower() != '.vfr':
3076 continue
3077 Vfri = os.path.join(self.OutputDir, SrcFile.BaseName + '.i')
3078 if not os.path.exists(Vfri):
3079 continue
3080 VfriFile = open(Vfri, 'r')
3081 Content = VfriFile.read()
3082 VfriFile.close()
3083 Pos = Content.find('efivarstore')
3084 while Pos != -1:
3085 #
3086 # Make sure 'efivarstore' is the start of efivarstore statement
3087 # In case of the value of 'name' (name = efivarstore) is equal to 'efivarstore'
3088 #
3089 Index = Pos - 1
3090 while Index >= 0 and Content[Index] in ' \t\r\n':
3091 Index -= 1
3092 if Index >= 0 and Content[Index] != ';':
3093 Pos = Content.find('efivarstore', Pos + len('efivarstore'))
3094 continue
3095 #
3096 # 'efivarstore' must be followed by name and guid
3097 #
3098 Name = gEfiVarStoreNamePattern.search(Content, Pos)
3099 if not Name:
3100 break
3101 Guid = gEfiVarStoreGuidPattern.search(Content, Pos)
3102 if not Guid:
3103 break
3104 NameArray = ConvertStringToByteArray('L"' + Name.group(1) + '"')
3105 NameGuids.append((NameArray, GuidStructureStringToGuidString(Guid.group(1))))
3106 Pos = Content.find('efivarstore', Name.end())
3107 if not NameGuids:
3108 return []
3109 HiiExPcds = []
3110 for Pcd in self.PlatformInfo.Platform.Pcds.values():
3111 if Pcd.Type != TAB_PCDS_DYNAMIC_EX_HII:
3112 continue
3113 for SkuName in Pcd.SkuInfoList:
3114 SkuInfo = Pcd.SkuInfoList[SkuName]
3115 Name = ConvertStringToByteArray(SkuInfo.VariableName)
3116 Value = GuidValue(SkuInfo.VariableGuid, self.PlatformInfo.PackageList)
3117 if not Value:
3118 continue
3119 Guid = GuidStructureStringToGuidString(Value)
3120 if (Name, Guid) in NameGuids and Pcd not in HiiExPcds:
3121 HiiExPcds.append(Pcd)
3122 break
3123
3124 return HiiExPcds
3125
3126 def _GenOffsetBin(self):
3127 VfrUniBaseName = {}
3128 for SourceFile in self.Module.Sources:
3129 if SourceFile.Type.upper() == ".VFR" :
3130 #
3131 # search the .map file to find the offset of vfr binary in the PE32+/TE file.
3132 #
3133 VfrUniBaseName[SourceFile.BaseName] = (SourceFile.BaseName + "Bin")
3134 if SourceFile.Type.upper() == ".UNI" :
3135 #
3136 # search the .map file to find the offset of Uni strings binary in the PE32+/TE file.
3137 #
3138 VfrUniBaseName["UniOffsetName"] = (self.Name + "Strings")
3139
3140 if len(VfrUniBaseName) == 0:
3141 return None
3142 MapFileName = os.path.join(self.OutputDir, self.Name + ".map")
3143 EfiFileName = os.path.join(self.OutputDir, self.Name + ".efi")
3144 VfrUniOffsetList = GetVariableOffset(MapFileName, EfiFileName, VfrUniBaseName.values())
3145 if not VfrUniOffsetList:
3146 return None
3147
3148 OutputName = '%sOffset.bin' % self.Name
3149 UniVfrOffsetFileName = os.path.join( self.OutputDir, OutputName)
3150
3151 try:
3152 fInputfile = open(UniVfrOffsetFileName, "wb+", 0)
3153 except:
3154 EdkLogger.error("build", FILE_OPEN_FAILURE, "File open failed for %s" % UniVfrOffsetFileName,None)
3155
3156 # Use a instance of StringIO to cache data
3157 fStringIO = StringIO('')
3158
3159 for Item in VfrUniOffsetList:
3160 if (Item[0].find("Strings") != -1):
3161 #
3162 # UNI offset in image.
3163 # GUID + Offset
3164 # { 0x8913c5e0, 0x33f6, 0x4d86, { 0x9b, 0xf1, 0x43, 0xef, 0x89, 0xfc, 0x6, 0x66 } }
3165 #
3166 UniGuid = [0xe0, 0xc5, 0x13, 0x89, 0xf6, 0x33, 0x86, 0x4d, 0x9b, 0xf1, 0x43, 0xef, 0x89, 0xfc, 0x6, 0x66]
3167 UniGuid = [chr(ItemGuid) for ItemGuid in UniGuid]
3168 fStringIO.write(''.join(UniGuid))
3169 UniValue = pack ('Q', int (Item[1], 16))
3170 fStringIO.write (UniValue)
3171 else:
3172 #
3173 # VFR binary offset in image.
3174 # GUID + Offset
3175 # { 0xd0bc7cb4, 0x6a47, 0x495f, { 0xaa, 0x11, 0x71, 0x7, 0x46, 0xda, 0x6, 0xa2 } };
3176 #
3177 VfrGuid = [0xb4, 0x7c, 0xbc, 0xd0, 0x47, 0x6a, 0x5f, 0x49, 0xaa, 0x11, 0x71, 0x7, 0x46, 0xda, 0x6, 0xa2]
3178 VfrGuid = [chr(ItemGuid) for ItemGuid in VfrGuid]
3179 fStringIO.write(''.join(VfrGuid))
3180 type (Item[1])
3181 VfrValue = pack ('Q', int (Item[1], 16))
3182 fStringIO.write (VfrValue)
3183 #
3184 # write data into file.
3185 #
3186 try :
3187 fInputfile.write (fStringIO.getvalue())
3188 except:
3189 EdkLogger.error("build", FILE_WRITE_FAILURE, "Write data to file %s failed, please check whether the "
3190 "file been locked or using by other applications." %UniVfrOffsetFileName,None)
3191
3192 fStringIO.close ()
3193 fInputfile.close ()
3194 return OutputName
3195
3196 ## Create AsBuilt INF file the module
3197 #
3198 def CreateAsBuiltInf(self):
3199 if self.IsAsBuiltInfCreated:
3200 return
3201
3202 # Skip the following code for EDK I inf
3203 if self.AutoGenVersion < 0x00010005:
3204 return
3205
3206 # Skip the following code for libraries
3207 if self.IsLibrary:
3208 return
3209
3210 # Skip the following code for modules with no source files
3211 if self.SourceFileList == None or self.SourceFileList == []:
3212 return
3213
3214 # Skip the following code for modules without any binary files
3215 if self.BinaryFileList <> None and self.BinaryFileList <> []:
3216 return
3217
3218 ### TODO: How to handles mixed source and binary modules
3219
3220 # Find all DynamicEx and PatchableInModule PCDs used by this module and dependent libraries
3221 # Also find all packages that the DynamicEx PCDs depend on
3222 Pcds = []
3223 PatchablePcds = {}
3224 Packages = []
3225 PcdCheckList = []
3226 PcdTokenSpaceList = []
3227 for Pcd in self.ModulePcdList + self.LibraryPcdList:
3228 if Pcd.Type == TAB_PCDS_PATCHABLE_IN_MODULE:
3229 PatchablePcds[Pcd.TokenCName] = Pcd
3230 PcdCheckList.append((Pcd.TokenCName, Pcd.TokenSpaceGuidCName, 'PatchableInModule'))
3231 elif Pcd.Type in GenC.gDynamicExPcd:
3232 if Pcd not in Pcds:
3233 Pcds += [Pcd]
3234 PcdCheckList.append((Pcd.TokenCName, Pcd.TokenSpaceGuidCName, 'DynamicEx'))
3235 PcdCheckList.append((Pcd.TokenCName, Pcd.TokenSpaceGuidCName, 'Dynamic'))
3236 PcdTokenSpaceList.append(Pcd.TokenSpaceGuidCName)
3237 GuidList = sdict()
3238 GuidList.update(self.GuidList)
3239 for TokenSpace in self.GetGuidsUsedByPcd():
3240 # If token space is not referred by patch PCD or Ex PCD, remove the GUID from GUID list
3241 # The GUIDs in GUIDs section should really be the GUIDs in source INF or referred by Ex an patch PCDs
3242 if TokenSpace not in PcdTokenSpaceList and TokenSpace in GuidList:
3243 GuidList.pop(TokenSpace)
3244 CheckList = (GuidList, self.PpiList, self.ProtocolList, PcdCheckList)
3245 for Package in self.DerivedPackageList:
3246 if Package in Packages:
3247 continue
3248 BeChecked = (Package.Guids, Package.Ppis, Package.Protocols, Package.Pcds)
3249 Found = False
3250 for Index in range(len(BeChecked)):
3251 for Item in CheckList[Index]:
3252 if Item in BeChecked[Index]:
3253 Packages += [Package]
3254 Found = True
3255 break
3256 if Found: break
3257
3258 VfrPcds = self._GetPcdsMaybeUsedByVfr()
3259 for Pkg in self.PlatformInfo.PackageList:
3260 if Pkg in Packages:
3261 continue
3262 for VfrPcd in VfrPcds:
3263 if ((VfrPcd.TokenCName, VfrPcd.TokenSpaceGuidCName, 'DynamicEx') in Pkg.Pcds or
3264 (VfrPcd.TokenCName, VfrPcd.TokenSpaceGuidCName, 'Dynamic') in Pkg.Pcds):
3265 Packages += [Pkg]
3266 break
3267
3268 ModuleType = self.ModuleType
3269 if ModuleType == 'UEFI_DRIVER' and self.DepexGenerated:
3270 ModuleType = 'DXE_DRIVER'
3271
3272 DriverType = ''
3273 if self.PcdIsDriver != '':
3274 DriverType = self.PcdIsDriver
3275
3276 Guid = self.Guid
3277 MDefs = self.Module.Defines
3278
3279 AsBuiltInfDict = {
3280 'module_name' : self.Name,
3281 'module_guid' : Guid,
3282 'module_module_type' : ModuleType,
3283 'module_version_string' : [MDefs['VERSION_STRING']] if 'VERSION_STRING' in MDefs else [],
3284 'pcd_is_driver_string' : [],
3285 'module_uefi_specification_version' : [],
3286 'module_pi_specification_version' : [],
3287 'module_entry_point' : self.Module.ModuleEntryPointList,
3288 'module_unload_image' : self.Module.ModuleUnloadImageList,
3289 'module_constructor' : self.Module.ConstructorList,
3290 'module_destructor' : self.Module.DestructorList,
3291 'module_shadow' : [MDefs['SHADOW']] if 'SHADOW' in MDefs else [],
3292 'module_pci_vendor_id' : [MDefs['PCI_VENDOR_ID']] if 'PCI_VENDOR_ID' in MDefs else [],
3293 'module_pci_device_id' : [MDefs['PCI_DEVICE_ID']] if 'PCI_DEVICE_ID' in MDefs else [],
3294 'module_pci_class_code' : [MDefs['PCI_CLASS_CODE']] if 'PCI_CLASS_CODE' in MDefs else [],
3295 'module_pci_revision' : [MDefs['PCI_REVISION']] if 'PCI_REVISION' in MDefs else [],
3296 'module_build_number' : [MDefs['BUILD_NUMBER']] if 'BUILD_NUMBER' in MDefs else [],
3297 'module_spec' : [MDefs['SPEC']] if 'SPEC' in MDefs else [],
3298 'module_uefi_hii_resource_section' : [MDefs['UEFI_HII_RESOURCE_SECTION']] if 'UEFI_HII_RESOURCE_SECTION' in MDefs else [],
3299 'module_uni_file' : [MDefs['MODULE_UNI_FILE']] if 'MODULE_UNI_FILE' in MDefs else [],
3300 'module_arch' : self.Arch,
3301 'package_item' : ['%s' % (Package.MetaFile.File.replace('\\','/')) for Package in Packages],
3302 'binary_item' : [],
3303 'patchablepcd_item' : [],
3304 'pcd_item' : [],
3305 'protocol_item' : [],
3306 'ppi_item' : [],
3307 'guid_item' : [],
3308 'flags_item' : [],
3309 'libraryclasses_item' : []
3310 }
3311
3312 if self.AutoGenVersion > int(gInfSpecVersion, 0):
3313 AsBuiltInfDict['module_inf_version'] = '0x%08x' % self.AutoGenVersion
3314 else:
3315 AsBuiltInfDict['module_inf_version'] = gInfSpecVersion
3316
3317 if DriverType:
3318 AsBuiltInfDict['pcd_is_driver_string'] += [DriverType]
3319
3320 if 'UEFI_SPECIFICATION_VERSION' in self.Specification:
3321 AsBuiltInfDict['module_uefi_specification_version'] += [self.Specification['UEFI_SPECIFICATION_VERSION']]
3322 if 'PI_SPECIFICATION_VERSION' in self.Specification:
3323 AsBuiltInfDict['module_pi_specification_version'] += [self.Specification['PI_SPECIFICATION_VERSION']]
3324
3325 OutputDir = self.OutputDir.replace('\\','/').strip('/')
3326 if self.ModuleType in ['BASE', 'USER_DEFINED']:
3327 for Item in self.CodaTargetList:
3328 File = Item.Target.Path.replace('\\','/').strip('/').replace(OutputDir,'').strip('/')
3329 if Item.Target.Ext.lower() == '.aml':
3330 AsBuiltInfDict['binary_item'] += ['ASL|' + File]
3331 elif Item.Target.Ext.lower() == '.acpi':
3332 AsBuiltInfDict['binary_item'] += ['ACPI|' + File]
3333 else:
3334 AsBuiltInfDict['binary_item'] += ['BIN|' + File]
3335 else:
3336 for Item in self.CodaTargetList:
3337 File = Item.Target.Path.replace('\\','/').strip('/').replace(OutputDir,'').strip('/')
3338 if Item.Target.Ext.lower() == '.efi':
3339 AsBuiltInfDict['binary_item'] += ['PE32|' + self.Name + '.efi']
3340 else:
3341 AsBuiltInfDict['binary_item'] += ['BIN|' + File]
3342 if self.DepexGenerated:
3343 if self.ModuleType in ['PEIM']:
3344 AsBuiltInfDict['binary_item'] += ['PEI_DEPEX|' + self.Name + '.depex']
3345 if self.ModuleType in ['DXE_DRIVER','DXE_RUNTIME_DRIVER','DXE_SAL_DRIVER','UEFI_DRIVER']:
3346 AsBuiltInfDict['binary_item'] += ['DXE_DEPEX|' + self.Name + '.depex']
3347 if self.ModuleType in ['DXE_SMM_DRIVER']:
3348 AsBuiltInfDict['binary_item'] += ['SMM_DEPEX|' + self.Name + '.depex']
3349
3350 Bin = self._GenOffsetBin()
3351 if Bin:
3352 AsBuiltInfDict['binary_item'] += ['BIN|%s' % Bin]
3353
3354 for Root, Dirs, Files in os.walk(OutputDir):
3355 for File in Files:
3356 if File.lower().endswith('.pdb'):
3357 AsBuiltInfDict['binary_item'] += ['DISPOSABLE|' + File]
3358 HeaderComments = self.Module.HeaderComments
3359 StartPos = 0
3360 for Index in range(len(HeaderComments)):
3361 if HeaderComments[Index].find('@BinaryHeader') != -1:
3362 HeaderComments[Index] = HeaderComments[Index].replace('@BinaryHeader', '@file')
3363 StartPos = Index
3364 break
3365 AsBuiltInfDict['header_comments'] = '\n'.join(HeaderComments[StartPos:]).replace(':#', '://')
3366 AsBuiltInfDict['tail_comments'] = '\n'.join(self.Module.TailComments)
3367
3368 GenList = [
3369 (self.ProtocolList, self._ProtocolComments, 'protocol_item'),
3370 (self.PpiList, self._PpiComments, 'ppi_item'),
3371 (GuidList, self._GuidComments, 'guid_item')
3372 ]
3373 for Item in GenList:
3374 for CName in Item[0]:
3375 Comments = ''
3376 if CName in Item[1]:
3377 Comments = '\n '.join(Item[1][CName])
3378 Entry = CName
3379 if Comments:
3380 Entry = Comments + '\n ' + CName
3381 AsBuiltInfDict[Item[2]].append(Entry)
3382 PatchList = parsePcdInfoFromMapFile(
3383 os.path.join(self.OutputDir, self.Name + '.map'),
3384 os.path.join(self.OutputDir, self.Name + '.efi')
3385 )
3386 if PatchList:
3387 for PatchPcd in PatchList:
3388 if PatchPcd[0] not in PatchablePcds:
3389 continue
3390 Pcd = PatchablePcds[PatchPcd[0]]
3391 PcdValue = ''
3392 if Pcd.DatumType != 'VOID*':
3393 HexFormat = '0x%02x'
3394 if Pcd.DatumType == 'UINT16':
3395 HexFormat = '0x%04x'
3396 elif Pcd.DatumType == 'UINT32':
3397 HexFormat = '0x%08x'
3398 elif Pcd.DatumType == 'UINT64':
3399 HexFormat = '0x%016x'
3400 PcdValue = HexFormat % int(Pcd.DefaultValue, 0)
3401 else:
3402 if Pcd.MaxDatumSize == None or Pcd.MaxDatumSize == '':
3403 EdkLogger.error("build", AUTOGEN_ERROR,
3404 "Unknown [MaxDatumSize] of PCD [%s.%s]" % (Pcd.TokenSpaceGuidCName, Pcd.TokenCName)
3405 )
3406 ArraySize = int(Pcd.MaxDatumSize, 0)
3407 PcdValue = Pcd.DefaultValue
3408 if PcdValue[0] != '{':
3409 Unicode = False
3410 if PcdValue[0] == 'L':
3411 Unicode = True
3412 PcdValue = PcdValue.lstrip('L')
3413 PcdValue = eval(PcdValue)
3414 NewValue = '{'
3415 for Index in range(0, len(PcdValue)):
3416 if Unicode:
3417 CharVal = ord(PcdValue[Index])
3418 NewValue = NewValue + '0x%02x' % (CharVal & 0x00FF) + ', ' \
3419 + '0x%02x' % (CharVal >> 8) + ', '
3420 else:
3421 NewValue = NewValue + '0x%02x' % (ord(PcdValue[Index]) % 0x100) + ', '
3422 Padding = '0x00, '
3423 if Unicode:
3424 Padding = Padding * 2
3425 ArraySize = ArraySize / 2
3426 if ArraySize < (len(PcdValue) + 1):
3427 EdkLogger.error("build", AUTOGEN_ERROR,
3428 "The maximum size of VOID* type PCD '%s.%s' is less than its actual size occupied." % (Pcd.TokenSpaceGuidCName, Pcd.TokenCName)
3429 )
3430 if ArraySize > len(PcdValue) + 1:
3431 NewValue = NewValue + Padding * (ArraySize - len(PcdValue) - 1)
3432 PcdValue = NewValue + Padding.strip().rstrip(',') + '}'
3433 elif len(PcdValue.split(',')) <= ArraySize:
3434 PcdValue = PcdValue.rstrip('}') + ', 0x00' * (ArraySize - len(PcdValue.split(',')))
3435 PcdValue += '}'
3436 else:
3437 EdkLogger.error("build", AUTOGEN_ERROR,
3438 "The maximum size of VOID* type PCD '%s.%s' is less than its actual size occupied." % (Pcd.TokenSpaceGuidCName, Pcd.TokenCName)
3439 )
3440 PcdItem = '%s.%s|%s|0x%X' % \
3441 (Pcd.TokenSpaceGuidCName, Pcd.TokenCName, PcdValue, PatchPcd[1])
3442 PcdComments = ''
3443 if (Pcd.TokenSpaceGuidCName, Pcd.TokenCName) in self._PcdComments:
3444 PcdComments = '\n '.join(self._PcdComments[Pcd.TokenSpaceGuidCName, Pcd.TokenCName])
3445 if PcdComments:
3446 PcdItem = PcdComments + '\n ' + PcdItem
3447 AsBuiltInfDict['patchablepcd_item'].append(PcdItem)
3448
3449 HiiPcds = []
3450 for Pcd in Pcds + VfrPcds:
3451 PcdComments = ''
3452 PcdCommentList = []
3453 HiiInfo = ''
3454 SkuId = ''
3455 if Pcd.Type == TAB_PCDS_DYNAMIC_EX_HII:
3456 for SkuName in Pcd.SkuInfoList:
3457 SkuInfo = Pcd.SkuInfoList[SkuName]
3458 SkuId = SkuInfo.SkuId
3459 HiiInfo = '## %s|%s|%s' % (SkuInfo.VariableName, SkuInfo.VariableGuid, SkuInfo.VariableOffset)
3460 break
3461 if SkuId:
3462 #
3463 # Don't generate duplicated HII PCD
3464 #
3465 if (SkuId, Pcd.TokenSpaceGuidCName, Pcd.TokenCName) in HiiPcds:
3466 continue
3467 else:
3468 HiiPcds.append((SkuId, Pcd.TokenSpaceGuidCName, Pcd.TokenCName))
3469 if (Pcd.TokenSpaceGuidCName, Pcd.TokenCName) in self._PcdComments:
3470 PcdCommentList = self._PcdComments[Pcd.TokenSpaceGuidCName, Pcd.TokenCName][:]
3471 if HiiInfo:
3472 UsageIndex = -1
3473 UsageStr = ''
3474 for Index, Comment in enumerate(PcdCommentList):
3475 for Usage in UsageList:
3476 if Comment.find(Usage) != -1:
3477 UsageStr = Usage
3478 UsageIndex = Index
3479 break
3480 if UsageIndex != -1:
3481 PcdCommentList[UsageIndex] = '## %s %s %s' % (UsageStr, HiiInfo, PcdCommentList[UsageIndex].replace(UsageStr, ''))
3482 else:
3483 PcdCommentList.append('## UNDEFINED ' + HiiInfo)
3484 PcdComments = '\n '.join(PcdCommentList)
3485 PcdEntry = Pcd.TokenSpaceGuidCName + '.' + Pcd.TokenCName
3486 if PcdComments:
3487 PcdEntry = PcdComments + '\n ' + PcdEntry
3488 AsBuiltInfDict['pcd_item'] += [PcdEntry]
3489 for Item in self.BuildOption:
3490 if 'FLAGS' in self.BuildOption[Item]:
3491 AsBuiltInfDict['flags_item'] += ['%s:%s_%s_%s_%s_FLAGS = %s' % (self.ToolChainFamily, self.BuildTarget, self.ToolChain, self.Arch, Item, self.BuildOption[Item]['FLAGS'].strip())]
3492
3493 # Generated LibraryClasses section in comments.
3494 for Library in self.LibraryAutoGenList:
3495 AsBuiltInfDict['libraryclasses_item'] += [Library.MetaFile.File.replace('\\', '/')]
3496
3497 # Generated depex expression section in comments.
3498 AsBuiltInfDict['depexsection_item'] = ''
3499 DepexExpresion = self._GetDepexExpresionString()
3500 if DepexExpresion:
3501 AsBuiltInfDict['depexsection_item'] = DepexExpresion
3502
3503 AsBuiltInf = TemplateString()
3504 AsBuiltInf.Append(gAsBuiltInfHeaderString.Replace(AsBuiltInfDict))
3505
3506 SaveFileOnChange(os.path.join(self.OutputDir, self.Name + '.inf'), str(AsBuiltInf), False)
3507
3508 self.IsAsBuiltInfCreated = True
3509
3510 ## Create makefile for the module and its dependent libraries
3511 #
3512 # @param CreateLibraryMakeFile Flag indicating if or not the makefiles of
3513 # dependent libraries will be created
3514 #
3515 def CreateMakeFile(self, CreateLibraryMakeFile=True):
3516 # Ignore generating makefile when it is a binary module
3517 if self.IsBinaryModule:
3518 return
3519
3520 if self.IsMakeFileCreated:
3521 return
3522
3523 if not self.IsLibrary and CreateLibraryMakeFile:
3524 for LibraryAutoGen in self.LibraryAutoGenList:
3525 LibraryAutoGen.CreateMakeFile()
3526
3527 if len(self.CustomMakefile) == 0:
3528 Makefile = GenMake.ModuleMakefile(self)
3529 else:
3530 Makefile = GenMake.CustomMakefile(self)
3531 if Makefile.Generate():
3532 EdkLogger.debug(EdkLogger.DEBUG_9, "Generated makefile for module %s [%s]" %
3533 (self.Name, self.Arch))
3534 else:
3535 EdkLogger.debug(EdkLogger.DEBUG_9, "Skipped the generation of makefile for module %s [%s]" %
3536 (self.Name, self.Arch))
3537
3538 self.IsMakeFileCreated = True
3539
3540 def CopyBinaryFiles(self):
3541 for File in self.Module.Binaries:
3542 SrcPath = File.Path
3543 DstPath = os.path.join(self.OutputDir , os.path.basename(SrcPath))
3544 CopyLongFilePath(SrcPath, DstPath)
3545 ## Create autogen code for the module and its dependent libraries
3546 #
3547 # @param CreateLibraryCodeFile Flag indicating if or not the code of
3548 # dependent libraries will be created
3549 #
3550 def CreateCodeFile(self, CreateLibraryCodeFile=True):
3551 if self.IsCodeFileCreated:
3552 return
3553
3554 # Need to generate PcdDatabase even PcdDriver is binarymodule
3555 if self.IsBinaryModule and self.PcdIsDriver != '':
3556 CreatePcdDatabaseCode(self, TemplateString(), TemplateString())
3557 return
3558 if self.IsBinaryModule:
3559 if self.IsLibrary:
3560 self.CopyBinaryFiles()
3561 return
3562
3563 if not self.IsLibrary and CreateLibraryCodeFile:
3564 for LibraryAutoGen in self.LibraryAutoGenList:
3565 LibraryAutoGen.CreateCodeFile()
3566
3567 AutoGenList = []
3568 IgoredAutoGenList = []
3569
3570 for File in self.AutoGenFileList:
3571 if GenC.Generate(File.Path, self.AutoGenFileList[File], File.IsBinary):
3572 #Ignore Edk AutoGen.c
3573 if self.AutoGenVersion < 0x00010005 and File.Name == 'AutoGen.c':
3574 continue
3575
3576 AutoGenList.append(str(File))
3577 else:
3578 IgoredAutoGenList.append(str(File))
3579
3580 # Skip the following code for EDK I inf
3581 if self.AutoGenVersion < 0x00010005:
3582 return
3583
3584 for ModuleType in self.DepexList:
3585 # Ignore empty [depex] section or [depex] section for "USER_DEFINED" module
3586 if len(self.DepexList[ModuleType]) == 0 or ModuleType == "USER_DEFINED":
3587 continue
3588
3589 Dpx = GenDepex.DependencyExpression(self.DepexList[ModuleType], ModuleType, True)
3590 DpxFile = gAutoGenDepexFileName % {"module_name" : self.Name}
3591
3592 if len(Dpx.PostfixNotation) <> 0:
3593 self.DepexGenerated = True
3594
3595 if Dpx.Generate(path.join(self.OutputDir, DpxFile)):
3596 AutoGenList.append(str(DpxFile))
3597 else:
3598 IgoredAutoGenList.append(str(DpxFile))
3599
3600 if IgoredAutoGenList == []:
3601 EdkLogger.debug(EdkLogger.DEBUG_9, "Generated [%s] files for module %s [%s]" %
3602 (" ".join(AutoGenList), self.Name, self.Arch))
3603 elif AutoGenList == []:
3604 EdkLogger.debug(EdkLogger.DEBUG_9, "Skipped the generation of [%s] files for module %s [%s]" %
3605 (" ".join(IgoredAutoGenList), self.Name, self.Arch))
3606 else:
3607 EdkLogger.debug(EdkLogger.DEBUG_9, "Generated [%s] (skipped %s) files for module %s [%s]" %
3608 (" ".join(AutoGenList), " ".join(IgoredAutoGenList), self.Name, self.Arch))
3609
3610 self.IsCodeFileCreated = True
3611 return AutoGenList
3612
3613 ## Summarize the ModuleAutoGen objects of all libraries used by this module
3614 def _GetLibraryAutoGenList(self):
3615 if self._LibraryAutoGenList == None:
3616 self._LibraryAutoGenList = []
3617 for Library in self.DependentLibraryList:
3618 La = ModuleAutoGen(
3619 self.Workspace,
3620 Library.MetaFile,
3621 self.BuildTarget,
3622 self.ToolChain,
3623 self.Arch,
3624 self.PlatformInfo.MetaFile
3625 )
3626 if La not in self._LibraryAutoGenList:
3627 self._LibraryAutoGenList.append(La)
3628 for Lib in La.CodaTargetList:
3629 self._ApplyBuildRule(Lib.Target, TAB_UNKNOWN_FILE)
3630 return self._LibraryAutoGenList
3631
3632 Module = property(_GetModule)
3633 Name = property(_GetBaseName)
3634 Guid = property(_GetGuid)
3635 Version = property(_GetVersion)
3636 ModuleType = property(_GetModuleType)
3637 ComponentType = property(_GetComponentType)
3638 BuildType = property(_GetBuildType)
3639 PcdIsDriver = property(_GetPcdIsDriver)
3640 AutoGenVersion = property(_GetAutoGenVersion)
3641 Macros = property(_GetMacros)
3642 Specification = property(_GetSpecification)
3643
3644 IsLibrary = property(_IsLibrary)
3645 IsBinaryModule = property(_IsBinaryModule)
3646 BuildDir = property(_GetBuildDir)
3647 OutputDir = property(_GetOutputDir)
3648 DebugDir = property(_GetDebugDir)
3649 MakeFileDir = property(_GetMakeFileDir)
3650 CustomMakefile = property(_GetCustomMakefile)
3651
3652 IncludePathList = property(_GetIncludePathList)
3653 AutoGenFileList = property(_GetAutoGenFileList)
3654 UnicodeFileList = property(_GetUnicodeFileList)
3655 SourceFileList = property(_GetSourceFileList)
3656 BinaryFileList = property(_GetBinaryFiles) # FileType : [File List]
3657 Targets = property(_GetTargets)
3658 IntroTargetList = property(_GetIntroTargetList)
3659 CodaTargetList = property(_GetFinalTargetList)
3660 FileTypes = property(_GetFileTypes)
3661 BuildRules = property(_GetBuildRules)
3662
3663 DependentPackageList = property(_GetDependentPackageList)
3664 DependentLibraryList = property(_GetLibraryList)
3665 LibraryAutoGenList = property(_GetLibraryAutoGenList)
3666 DerivedPackageList = property(_GetDerivedPackageList)
3667
3668 ModulePcdList = property(_GetModulePcdList)
3669 LibraryPcdList = property(_GetLibraryPcdList)
3670 GuidList = property(_GetGuidList)
3671 ProtocolList = property(_GetProtocolList)
3672 PpiList = property(_GetPpiList)
3673 DepexList = property(_GetDepexTokenList)
3674 DxsFile = property(_GetDxsFile)
3675 DepexExpressionList = property(_GetDepexExpressionTokenList)
3676 BuildOption = property(_GetModuleBuildOption)
3677 BuildOptionIncPathList = property(_GetBuildOptionIncPathList)
3678 BuildCommand = property(_GetBuildCommand)
3679
3680 FixedAtBuildPcds = property(_GetFixedAtBuildPcds)
3681
3682 # This acts like the main() function for the script, unless it is 'import'ed into another script.
3683 if __name__ == '__main__':
3684 pass
3685
EFI Development Kit II mirror for PVE