projects / mirror_edk2.git / blame
| Commit | Line | Data |
|---|---|---|
| f51461c8 LG |
1 | ## @file\r |
| 2 | # The engine for building files\r | |
| 3 | #\r | |
| 55c84777 | 4 | # Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r |
| 2e351cbe | 5 | # SPDX-License-Identifier: BSD-2-Clause-Patent\r |
| f51461c8 LG |
6 | #\r |
| 7 | \r | |
| 8 | ##\r | |
| 9 | # Import Modules\r | |
| 10 | #\r | |
| 1ccc4d89 | 11 | from __future__ import print_function\r |
| 1be2ed90 | 12 | import Common.LongFilePathOs as os\r |
| f51461c8 LG |
13 | import re\r |
| 14 | import copy\r | |
| 15 | import string\r | |
| 1be2ed90 | 16 | from Common.LongFilePathSupport import OpenLongFilePath as open\r |
| f51461c8 LG |
17 | \r |
| 18 | from Common.GlobalData import *\r | |
| 19 | from Common.BuildToolError import *\r | |
| 20 | from Common.Misc import tdict, PathClass\r | |
| 5a57246e | 21 | from Common.StringUtils import NormPath\r |
| f51461c8 | 22 | from Common.DataType import *\r |
| 4465cd12 | 23 | from Common.TargetTxtClassObject import TargetTxtDict\r |
| db01c8e3 FB |
24 | gDefaultBuildRuleFile = 'build_rule.txt'\r |
| 25 | AutoGenReqBuildRuleVerNum = '0.1'\r | |
| f51461c8 LG |
26 | \r |
| 27 | import Common.EdkLogger as EdkLogger\r | |
| 28 | \r | |
| 29 | ## Convert file type to file list macro name\r | |
| 30 | #\r | |
| 31 | # @param FileType The name of file type\r | |
| 32 | #\r | |
| 33 | # @retval string The name of macro\r | |
| 34 | #\r | |
| 35 | def FileListMacro(FileType):\r | |
| 36 | return "%sS" % FileType.replace("-", "_").upper()\r | |
| 37 | \r | |
| 38 | ## Convert file type to list file macro name\r | |
| 39 | #\r | |
| 40 | # @param FileType The name of file type\r | |
| 41 | #\r | |
| 42 | # @retval string The name of macro\r | |
| 43 | #\r | |
| 44 | def ListFileMacro(FileType):\r | |
| 45 | return "%s_LIST" % FileListMacro(FileType)\r | |
| 46 | \r | |
| 47 | class TargetDescBlock(object):\r | |
| aaa5a23c CJ |
48 | def __init__(self, Inputs, Outputs, Commands, Dependencies):\r |
| 49 | self.InitWorker(Inputs, Outputs, Commands, Dependencies)\r | |
| f51461c8 | 50 | \r |
| aaa5a23c | 51 | def InitWorker(self, Inputs, Outputs, Commands, Dependencies):\r |
| f51461c8 LG |
52 | self.Inputs = Inputs\r |
| 53 | self.Outputs = Outputs\r | |
| 54 | self.Commands = Commands\r | |
| 55 | self.Dependencies = Dependencies\r | |
| 56 | if self.Outputs:\r | |
| 57 | self.Target = self.Outputs[0]\r | |
| 58 | else:\r | |
| 59 | self.Target = None\r | |
| 60 | \r | |
| 61 | def __str__(self):\r | |
| 62 | return self.Target.Path\r | |
| 63 | \r | |
| 64 | def __hash__(self):\r | |
| 65 | return hash(self.Target.Path)\r | |
| 66 | \r | |
| 67 | def __eq__(self, Other):\r | |
| 0d1f5b2b | 68 | if isinstance(Other, type(self)):\r |
| f51461c8 LG |
69 | return Other.Target.Path == self.Target.Path\r |
| 70 | else:\r | |
| 71 | return str(Other) == self.Target.Path\r | |
| 72 | \r | |
| 73 | def AddInput(self, Input):\r | |
| 74 | if Input not in self.Inputs:\r | |
| 75 | self.Inputs.append(Input)\r | |
| 76 | \r | |
| 77 | def IsMultipleInput(self):\r | |
| 78 | return len(self.Inputs) > 1\r | |
| 79 | \r | |
| f51461c8 LG |
80 | ## Class for one build rule\r |
| 81 | #\r | |
| 82 | # This represents a build rule which can give out corresponding command list for\r | |
| 83 | # building the given source file(s). The result can be used for generating the\r | |
| 84 | # target for makefile.\r | |
| 85 | #\r | |
| 86 | class FileBuildRule:\r | |
| 87 | INC_LIST_MACRO = "INC_LIST"\r | |
| 88 | INC_MACRO = "INC"\r | |
| 89 | \r | |
| 90 | ## constructor\r | |
| 91 | #\r | |
| fb0b35e0 AC |
92 | # @param Input The dictionary representing input file(s) for a rule\r |
| 93 | # @param Output The list representing output file(s) for a rule\r | |
| f51461c8 LG |
94 | # @param Command The list containing commands to generate the output from input\r |
| 95 | #\r | |
| 96 | def __init__(self, Type, Input, Output, Command, ExtraDependency=None):\r | |
| 97 | # The Input should not be empty\r | |
| 98 | if not Input:\r | |
| 99 | Input = []\r | |
| 100 | if not Output:\r | |
| 101 | Output = []\r | |
| 102 | if not Command:\r | |
| 103 | Command = []\r | |
| 104 | \r | |
| 105 | self.FileListMacro = FileListMacro(Type)\r | |
| 106 | self.ListFileMacro = ListFileMacro(Type)\r | |
| 107 | self.IncListFileMacro = self.INC_LIST_MACRO\r | |
| 108 | \r | |
| 109 | self.SourceFileType = Type\r | |
| bc39c5cb | 110 | # source files listed not in TAB_STAR or "?" pattern format\r |
| f51461c8 LG |
111 | if not ExtraDependency:\r |
| 112 | self.ExtraSourceFileList = []\r | |
| 113 | else:\r | |
| 114 | self.ExtraSourceFileList = ExtraDependency\r | |
| 115 | \r | |
| 116 | #\r | |
| 117 | # Search macros used in command lines for <FILE_TYPE>_LIST and INC_LIST.\r | |
| 118 | # If found, generate a file to keep the input files used to get over the\r | |
| 119 | # limitation of command line length\r | |
| 120 | #\r | |
| 121 | self.MacroList = []\r | |
| 122 | self.CommandList = []\r | |
| 123 | for CmdLine in Command:\r | |
| 124 | self.MacroList.extend(gMacroRefPattern.findall(CmdLine))\r | |
| 125 | # replace path separator with native one\r | |
| 126 | self.CommandList.append(CmdLine)\r | |
| 127 | \r | |
| 128 | # Indicate what should be generated\r | |
| 129 | if self.FileListMacro in self.MacroList:\r | |
| 130 | self.GenFileListMacro = True\r | |
| 131 | else:\r | |
| 132 | self.GenFileListMacro = False\r | |
| 133 | \r | |
| 134 | if self.ListFileMacro in self.MacroList:\r | |
| 135 | self.GenListFile = True\r | |
| 136 | self.GenFileListMacro = True\r | |
| 137 | else:\r | |
| 138 | self.GenListFile = False\r | |
| 139 | \r | |
| 140 | if self.INC_LIST_MACRO in self.MacroList:\r | |
| 141 | self.GenIncListFile = True\r | |
| 142 | else:\r | |
| 143 | self.GenIncListFile = False\r | |
| 144 | \r | |
| 145 | # Check input files\r | |
| 146 | self.IsMultipleInput = False\r | |
| d0ef841c | 147 | self.SourceFileExtList = set()\r |
| f51461c8 LG |
148 | for File in Input:\r |
| 149 | Base, Ext = os.path.splitext(File)\r | |
| bc39c5cb JC |
150 | if Base.find(TAB_STAR) >= 0:\r |
| 151 | # There's TAB_STAR in the file name\r | |
| f51461c8 LG |
152 | self.IsMultipleInput = True\r |
| 153 | self.GenFileListMacro = True\r | |
| 154 | elif Base.find("?") < 0:\r | |
| bc39c5cb | 155 | # There's no TAB_STAR and "?" in file name\r |
| f51461c8 LG |
156 | self.ExtraSourceFileList.append(File)\r |
| 157 | continue\r | |
| d0ef841c | 158 | self.SourceFileExtList.add(Ext)\r |
| f51461c8 LG |
159 | \r |
| 160 | # Check output files\r | |
| 161 | self.DestFileList = []\r | |
| 162 | for File in Output:\r | |
| 163 | self.DestFileList.append(File)\r | |
| 164 | \r | |
| 165 | # All build targets generated by this rule for a module\r | |
| 166 | self.BuildTargets = {}\r | |
| 167 | \r | |
| 168 | ## str() function support\r | |
| 169 | #\r | |
| 170 | # @retval string\r | |
| 171 | #\r | |
| 172 | def __str__(self):\r | |
| 173 | SourceString = ""\r | |
| 174 | SourceString += " %s %s %s" % (self.SourceFileType, " ".join(self.SourceFileExtList), self.ExtraSourceFileList)\r | |
| 0622a7b1 | 175 | DestString = ", ".join([str(i) for i in self.DestFileList])\r |
| f51461c8 LG |
176 | CommandString = "\n\t".join(self.CommandList)\r |
| 177 | return "%s : %s\n\t%s" % (DestString, SourceString, CommandString)\r | |
| 178 | \r | |
| e32f7bc9 FZ |
179 | def Instantiate(self, Macros = None):\r |
| 180 | if Macros is None:\r | |
| 181 | Macros = {}\r | |
| f51461c8 LG |
182 | NewRuleObject = copy.copy(self)\r |
| 183 | NewRuleObject.BuildTargets = {}\r | |
| 184 | NewRuleObject.DestFileList = []\r | |
| 185 | for File in self.DestFileList:\r | |
| 186 | NewRuleObject.DestFileList.append(PathClass(NormPath(File, Macros)))\r | |
| 187 | return NewRuleObject\r | |
| 188 | \r | |
| 189 | ## Apply the rule to given source file(s)\r | |
| 190 | #\r | |
| 191 | # @param SourceFile One file or a list of files to be built\r | |
| 192 | # @param RelativeToDir The relative path of the source file\r | |
| 193 | # @param PathSeparator Path separator\r | |
| 194 | #\r | |
| fb0b35e0 | 195 | # @retval tuple (Source file in full path, List of individual sourcefiles, Destination file, List of build commands)\r |
| f51461c8 | 196 | #\r |
| fe4bf2f9 | 197 | def Apply(self, SourceFile, BuildRuleOrder=None):\r |
| f51461c8 LG |
198 | if not self.CommandList or not self.DestFileList:\r |
| 199 | return None\r | |
| 200 | \r | |
| 201 | # source file\r | |
| 202 | if self.IsMultipleInput:\r | |
| 203 | SrcFileName = ""\r | |
| 204 | SrcFileBase = ""\r | |
| 205 | SrcFileExt = ""\r | |
| 206 | SrcFileDir = ""\r | |
| 207 | SrcPath = ""\r | |
| 208 | # SourceFile must be a list\r | |
| 209 | SrcFile = "$(%s)" % self.FileListMacro\r | |
| 210 | else:\r | |
| 211 | SrcFileName, SrcFileBase, SrcFileExt = SourceFile.Name, SourceFile.BaseName, SourceFile.Ext\r | |
| 212 | if SourceFile.Root:\r | |
| 213 | SrcFileDir = SourceFile.SubDir\r | |
| 214 | if SrcFileDir == "":\r | |
| 215 | SrcFileDir = "."\r | |
| 216 | else:\r | |
| 217 | SrcFileDir = "."\r | |
| 218 | SrcFile = SourceFile.Path\r | |
| 219 | SrcPath = SourceFile.Dir\r | |
| 220 | \r | |
| 221 | # destination file (the first one)\r | |
| 222 | if self.DestFileList:\r | |
| 223 | DestFile = self.DestFileList[0].Path\r | |
| 224 | DestPath = self.DestFileList[0].Dir\r | |
| 225 | DestFileName = self.DestFileList[0].Name\r | |
| 226 | DestFileBase, DestFileExt = self.DestFileList[0].BaseName, self.DestFileList[0].Ext\r | |
| 227 | else:\r | |
| 228 | DestFile = ""\r | |
| 229 | DestPath = ""\r | |
| 230 | DestFileName = ""\r | |
| 231 | DestFileBase = ""\r | |
| 232 | DestFileExt = ""\r | |
| 233 | \r | |
| 234 | BuildRulePlaceholderDict = {\r | |
| 235 | # source file\r | |
| 236 | "src" : SrcFile,\r | |
| 237 | "s_path" : SrcPath,\r | |
| 238 | "s_dir" : SrcFileDir,\r | |
| 239 | "s_name" : SrcFileName,\r | |
| 240 | "s_base" : SrcFileBase,\r | |
| 241 | "s_ext" : SrcFileExt,\r | |
| 242 | # destination file\r | |
| 243 | "dst" : DestFile,\r | |
| 244 | "d_path" : DestPath,\r | |
| 245 | "d_name" : DestFileName,\r | |
| 246 | "d_base" : DestFileBase,\r | |
| 247 | "d_ext" : DestFileExt,\r | |
| 248 | }\r | |
| 249 | \r | |
| 250 | DstFile = []\r | |
| 251 | for File in self.DestFileList:\r | |
| 252 | File = string.Template(str(File)).safe_substitute(BuildRulePlaceholderDict)\r | |
| 253 | File = string.Template(str(File)).safe_substitute(BuildRulePlaceholderDict)\r | |
| 254 | DstFile.append(PathClass(File, IsBinary=True))\r | |
| 255 | \r | |
| 256 | if DstFile[0] in self.BuildTargets:\r | |
| 257 | TargetDesc = self.BuildTargets[DstFile[0]]\r | |
| fe4bf2f9 YL |
258 | if BuildRuleOrder and SourceFile.Ext in BuildRuleOrder:\r |
| 259 | Index = BuildRuleOrder.index(SourceFile.Ext)\r | |
| 260 | for Input in TargetDesc.Inputs:\r | |
| 261 | if Input.Ext not in BuildRuleOrder or BuildRuleOrder.index(Input.Ext) > Index:\r | |
| 262 | #\r | |
| 263 | # Command line should be regenerated since some macros are different\r | |
| 264 | #\r | |
| 265 | CommandList = self._BuildCommand(BuildRulePlaceholderDict)\r | |
| aaa5a23c | 266 | TargetDesc.InitWorker([SourceFile], DstFile, CommandList, self.ExtraSourceFileList)\r |
| fe4bf2f9 YL |
267 | break\r |
| 268 | else:\r | |
| 269 | TargetDesc.AddInput(SourceFile)\r | |
| f51461c8 | 270 | else:\r |
| fe4bf2f9 | 271 | CommandList = self._BuildCommand(BuildRulePlaceholderDict)\r |
| f51461c8 LG |
272 | TargetDesc = TargetDescBlock([SourceFile], DstFile, CommandList, self.ExtraSourceFileList)\r |
| 273 | TargetDesc.ListFileMacro = self.ListFileMacro\r | |
| 274 | TargetDesc.FileListMacro = self.FileListMacro\r | |
| 275 | TargetDesc.IncListFileMacro = self.IncListFileMacro\r | |
| 276 | TargetDesc.GenFileListMacro = self.GenFileListMacro\r | |
| 277 | TargetDesc.GenListFile = self.GenListFile\r | |
| 278 | TargetDesc.GenIncListFile = self.GenIncListFile\r | |
| 279 | self.BuildTargets[DstFile[0]] = TargetDesc\r | |
| 280 | return TargetDesc\r | |
| 281 | \r | |
| fe4bf2f9 YL |
282 | def _BuildCommand(self, Macros):\r |
| 283 | CommandList = []\r | |
| 284 | for CommandString in self.CommandList:\r | |
| 285 | CommandString = string.Template(CommandString).safe_substitute(Macros)\r | |
| 286 | CommandString = string.Template(CommandString).safe_substitute(Macros)\r | |
| 287 | CommandList.append(CommandString)\r | |
| 288 | return CommandList\r | |
| 289 | \r | |
| f51461c8 LG |
290 | ## Class for build rules\r |
| 291 | #\r | |
| 292 | # BuildRule class parses rules defined in a file or passed by caller, and converts\r | |
| 293 | # the rule into FileBuildRule object.\r | |
| 294 | #\r | |
| 295 | class BuildRule:\r | |
| 296 | _SectionHeader = "SECTIONHEADER"\r | |
| 297 | _Section = "SECTION"\r | |
| 298 | _SubSectionHeader = "SUBSECTIONHEADER"\r | |
| 299 | _SubSection = "SUBSECTION"\r | |
| 300 | _InputFile = "INPUTFILE"\r | |
| 301 | _OutputFile = "OUTPUTFILE"\r | |
| 302 | _ExtraDependency = "EXTRADEPENDENCY"\r | |
| 303 | _Command = "COMMAND"\r | |
| 304 | _UnknownSection = "UNKNOWNSECTION"\r | |
| 305 | \r | |
| 306 | _SubSectionList = [_InputFile, _OutputFile, _Command]\r | |
| 307 | \r | |
| 308 | _PATH_SEP = "(+)"\r | |
| 309 | _FileTypePattern = re.compile("^[_a-zA-Z][_\-0-9a-zA-Z]*$")\r | |
| 310 | _BinaryFileRule = FileBuildRule(TAB_DEFAULT_BINARY_FILE, [], [os.path.join("$(OUTPUT_DIR)", "${s_name}")],\r | |
| 311 | ["$(CP) ${src} ${dst}"], [])\r | |
| 312 | \r | |
| 313 | ## Constructor\r | |
| 314 | #\r | |
| 315 | # @param File The file containing build rules in a well defined format\r | |
| 316 | # @param Content The string list of build rules in a well defined format\r | |
| 317 | # @param LineIndex The line number from which the parsing will begin\r | |
| 318 | # @param SupportedFamily The list of supported tool chain families\r | |
| 319 | #\r | |
| 708620d2 | 320 | def __init__(self, File=None, Content=None, LineIndex=0, SupportedFamily=[TAB_COMPILER_MSFT, "INTEL", "GCC"]):\r |
| f51461c8 LG |
321 | self.RuleFile = File\r |
| 322 | # Read build rules from file if it's not none\r | |
| 4231a819 | 323 | if File is not None:\r |
| f51461c8 LG |
324 | try:\r |
| 325 | self.RuleContent = open(File, 'r').readlines()\r | |
| 326 | except:\r | |
| 327 | EdkLogger.error("build", FILE_OPEN_FAILURE, ExtraData=File)\r | |
| 4231a819 | 328 | elif Content is not None:\r |
| f51461c8 LG |
329 | self.RuleContent = Content\r |
| 330 | else:\r | |
| 331 | EdkLogger.error("build", PARAMETER_MISSING, ExtraData="No rule file or string given")\r | |
| 332 | \r | |
| 333 | self.SupportedToolChainFamilyList = SupportedFamily\r | |
| 334 | self.RuleDatabase = tdict(True, 4) # {FileExt, ModuleType, Arch, Family : FileBuildRule object}\r | |
| 335 | self.Ext2FileType = {} # {ext : file-type}\r | |
| 336 | self.FileTypeList = set()\r | |
| 337 | \r | |
| 338 | self._LineIndex = LineIndex\r | |
| 339 | self._State = ""\r | |
| 340 | self._RuleInfo = tdict(True, 2) # {toolchain family : {"InputFile": {}, "OutputFile" : [], "Command" : []}}\r | |
| 341 | self._FileType = ''\r | |
| d0ef841c CJ |
342 | self._BuildTypeList = set()\r |
| 343 | self._ArchList = set()\r | |
| f51461c8 LG |
344 | self._FamilyList = []\r |
| 345 | self._TotalToolChainFamilySet = set()\r | |
| 346 | self._RuleObjectList = [] # FileBuildRule object list\r | |
| 347 | self._FileVersion = ""\r | |
| 348 | \r | |
| 349 | self.Parse()\r | |
| 350 | \r | |
| 351 | # some intrinsic rules\r | |
| 55c84777 | 352 | self.RuleDatabase[TAB_DEFAULT_BINARY_FILE, TAB_COMMON, TAB_COMMON, TAB_COMMON] = self._BinaryFileRule\r |
| f51461c8 LG |
353 | self.FileTypeList.add(TAB_DEFAULT_BINARY_FILE)\r |
| 354 | \r | |
| 355 | ## Parse the build rule strings\r | |
| 356 | def Parse(self):\r | |
| 357 | self._State = self._Section\r | |
| 358 | for Index in range(self._LineIndex, len(self.RuleContent)):\r | |
| 359 | # Clean up the line and replace path separator with native one\r | |
| 360 | Line = self.RuleContent[Index].strip().replace(self._PATH_SEP, os.path.sep)\r | |
| 361 | self.RuleContent[Index] = Line\r | |
| f7496d71 | 362 | \r |
| f51461c8 | 363 | # find the build_rule_version\r |
| 87d2afd0 GL |
364 | if Line and Line[0] == "#" and Line.find(TAB_BUILD_RULE_VERSION) != -1:\r |
| 365 | if Line.find("=") != -1 and Line.find("=") < (len(Line) - 1) and (Line[(Line.find("=") + 1):]).split():\r | |
| f51461c8 LG |
366 | self._FileVersion = (Line[(Line.find("=") + 1):]).split()[0]\r |
| 367 | # skip empty or comment line\r | |
| 368 | if Line == "" or Line[0] == "#":\r | |
| 369 | continue\r | |
| 370 | \r | |
| 371 | # find out section header, enclosed by []\r | |
| 372 | if Line[0] == '[' and Line[-1] == ']':\r | |
| 373 | # merge last section information into rule database\r | |
| 374 | self.EndOfSection()\r | |
| 375 | self._State = self._SectionHeader\r | |
| 376 | # find out sub-section header, enclosed by <>\r | |
| 377 | elif Line[0] == '<' and Line[-1] == '>':\r | |
| 378 | if self._State != self._UnknownSection:\r | |
| 379 | self._State = self._SubSectionHeader\r | |
| 380 | \r | |
| 381 | # call section handler to parse each (sub)section\r | |
| 382 | self._StateHandler[self._State](self, Index)\r | |
| 383 | # merge last section information into rule database\r | |
| 384 | self.EndOfSection()\r | |
| 385 | \r | |
| 386 | ## Parse definitions under a section\r | |
| 387 | #\r | |
| 388 | # @param LineIndex The line index of build rule text\r | |
| 389 | #\r | |
| 390 | def ParseSection(self, LineIndex):\r | |
| 391 | pass\r | |
| 392 | \r | |
| 393 | ## Parse definitions under a subsection\r | |
| 394 | #\r | |
| 395 | # @param LineIndex The line index of build rule text\r | |
| 396 | #\r | |
| 397 | def ParseSubSection(self, LineIndex):\r | |
| fb0b35e0 | 398 | # currently nothing here\r |
| f51461c8 LG |
399 | pass\r |
| 400 | \r | |
| 401 | ## Placeholder for not supported sections\r | |
| 402 | #\r | |
| 403 | # @param LineIndex The line index of build rule text\r | |
| 404 | #\r | |
| 405 | def SkipSection(self, LineIndex):\r | |
| 406 | pass\r | |
| 407 | \r | |
| 408 | ## Merge section information just got into rule database\r | |
| 409 | def EndOfSection(self):\r | |
| 410 | Database = self.RuleDatabase\r | |
| fb0b35e0 | 411 | # if there's specific toolchain family, 'COMMON' doesn't make sense any more\r |
| 55c84777 CJ |
412 | if len(self._TotalToolChainFamilySet) > 1 and TAB_COMMON in self._TotalToolChainFamilySet:\r |
| 413 | self._TotalToolChainFamilySet.remove(TAB_COMMON)\r | |
| f51461c8 LG |
414 | for Family in self._TotalToolChainFamilySet:\r |
| 415 | Input = self._RuleInfo[Family, self._InputFile]\r | |
| 416 | Output = self._RuleInfo[Family, self._OutputFile]\r | |
| 417 | Command = self._RuleInfo[Family, self._Command]\r | |
| 418 | ExtraDependency = self._RuleInfo[Family, self._ExtraDependency]\r | |
| 419 | \r | |
| 420 | BuildRule = FileBuildRule(self._FileType, Input, Output, Command, ExtraDependency)\r | |
| 421 | for BuildType in self._BuildTypeList:\r | |
| 422 | for Arch in self._ArchList:\r | |
| 423 | Database[self._FileType, BuildType, Arch, Family] = BuildRule\r | |
| 424 | for FileExt in BuildRule.SourceFileExtList:\r | |
| 425 | self.Ext2FileType[FileExt] = self._FileType\r | |
| 426 | \r | |
| 427 | ## Parse section header\r | |
| 428 | #\r | |
| 429 | # @param LineIndex The line index of build rule text\r | |
| 430 | #\r | |
| 431 | def ParseSectionHeader(self, LineIndex):\r | |
| 432 | self._RuleInfo = tdict(True, 2)\r | |
| d0ef841c CJ |
433 | self._BuildTypeList = set()\r |
| 434 | self._ArchList = set()\r | |
| f51461c8 LG |
435 | self._FamilyList = []\r |
| 436 | self._TotalToolChainFamilySet = set()\r | |
| 437 | FileType = ''\r | |
| 438 | RuleNameList = self.RuleContent[LineIndex][1:-1].split(',')\r | |
| 439 | for RuleName in RuleNameList:\r | |
| 55c84777 CJ |
440 | Arch = TAB_COMMON\r |
| 441 | BuildType = TAB_COMMON\r | |
| f51461c8 LG |
442 | TokenList = [Token.strip().upper() for Token in RuleName.split('.')]\r |
| 443 | # old format: Build.File-Type\r | |
| 444 | if TokenList[0] == "BUILD":\r | |
| 445 | if len(TokenList) == 1:\r | |
| 446 | EdkLogger.error("build", FORMAT_INVALID, "Invalid rule section",\r | |
| 47fea6af | 447 | File=self.RuleFile, Line=LineIndex + 1,\r |
| f51461c8 LG |
448 | ExtraData=self.RuleContent[LineIndex])\r |
| 449 | \r | |
| 450 | FileType = TokenList[1]\r | |
| 451 | if FileType == '':\r | |
| 452 | EdkLogger.error("build", FORMAT_INVALID, "No file type given",\r | |
| 47fea6af | 453 | File=self.RuleFile, Line=LineIndex + 1,\r |
| f51461c8 | 454 | ExtraData=self.RuleContent[LineIndex])\r |
| 4231a819 | 455 | if self._FileTypePattern.match(FileType) is None:\r |
| 47fea6af | 456 | EdkLogger.error("build", FORMAT_INVALID, File=self.RuleFile, Line=LineIndex + 1,\r |
| f51461c8 LG |
457 | ExtraData="Only character, number (non-first character), '_' and '-' are allowed in file type")\r |
| 458 | # new format: File-Type.Build-Type.Arch\r | |
| 459 | else:\r | |
| 460 | if FileType == '':\r | |
| 461 | FileType = TokenList[0]\r | |
| 462 | elif FileType != TokenList[0]:\r | |
| 463 | EdkLogger.error("build", FORMAT_INVALID,\r | |
| 464 | "Different file types are not allowed in the same rule section",\r | |
| 47fea6af | 465 | File=self.RuleFile, Line=LineIndex + 1,\r |
| f51461c8 LG |
466 | ExtraData=self.RuleContent[LineIndex])\r |
| 467 | if len(TokenList) > 1:\r | |
| 468 | BuildType = TokenList[1]\r | |
| 469 | if len(TokenList) > 2:\r | |
| 470 | Arch = TokenList[2]\r | |
| d0ef841c CJ |
471 | self._BuildTypeList.add(BuildType)\r |
| 472 | self._ArchList.add(Arch)\r | |
| f51461c8 | 473 | \r |
| 55c84777 | 474 | if TAB_COMMON in self._BuildTypeList and len(self._BuildTypeList) > 1:\r |
| f51461c8 LG |
475 | EdkLogger.error("build", FORMAT_INVALID,\r |
| 476 | "Specific build types must not be mixed with common one",\r | |
| 47fea6af | 477 | File=self.RuleFile, Line=LineIndex + 1,\r |
| f51461c8 | 478 | ExtraData=self.RuleContent[LineIndex])\r |
| 55c84777 | 479 | if TAB_COMMON in self._ArchList and len(self._ArchList) > 1:\r |
| f51461c8 LG |
480 | EdkLogger.error("build", FORMAT_INVALID,\r |
| 481 | "Specific ARCH must not be mixed with common one",\r | |
| 47fea6af | 482 | File=self.RuleFile, Line=LineIndex + 1,\r |
| f51461c8 LG |
483 | ExtraData=self.RuleContent[LineIndex])\r |
| 484 | \r | |
| 485 | self._FileType = FileType\r | |
| 486 | self._State = self._Section\r | |
| 487 | self.FileTypeList.add(FileType)\r | |
| 488 | \r | |
| 489 | ## Parse sub-section header\r | |
| 490 | #\r | |
| 491 | # @param LineIndex The line index of build rule text\r | |
| 492 | #\r | |
| 493 | def ParseSubSectionHeader(self, LineIndex):\r | |
| 494 | SectionType = ""\r | |
| 495 | List = self.RuleContent[LineIndex][1:-1].split(',')\r | |
| 496 | FamilyList = []\r | |
| 497 | for Section in List:\r | |
| 498 | TokenList = Section.split('.')\r | |
| 499 | Type = TokenList[0].strip().upper()\r | |
| 500 | \r | |
| 501 | if SectionType == "":\r | |
| 502 | SectionType = Type\r | |
| 503 | elif SectionType != Type:\r | |
| 504 | EdkLogger.error("build", FORMAT_INVALID,\r | |
| 505 | "Two different section types are not allowed in the same sub-section",\r | |
| 47fea6af | 506 | File=self.RuleFile, Line=LineIndex + 1,\r |
| f51461c8 LG |
507 | ExtraData=self.RuleContent[LineIndex])\r |
| 508 | \r | |
| 509 | if len(TokenList) > 1:\r | |
| 510 | Family = TokenList[1].strip().upper()\r | |
| 511 | else:\r | |
| 55c84777 | 512 | Family = TAB_COMMON\r |
| f51461c8 LG |
513 | \r |
| 514 | if Family not in FamilyList:\r | |
| 515 | FamilyList.append(Family)\r | |
| 516 | \r | |
| 517 | self._FamilyList = FamilyList\r | |
| 518 | self._TotalToolChainFamilySet.update(FamilyList)\r | |
| 519 | self._State = SectionType.upper()\r | |
| 55c84777 | 520 | if TAB_COMMON in FamilyList and len(FamilyList) > 1:\r |
| f51461c8 LG |
521 | EdkLogger.error("build", FORMAT_INVALID,\r |
| 522 | "Specific tool chain family should not be mixed with general one",\r | |
| 47fea6af | 523 | File=self.RuleFile, Line=LineIndex + 1,\r |
| f51461c8 LG |
524 | ExtraData=self.RuleContent[LineIndex])\r |
| 525 | if self._State not in self._StateHandler:\r | |
| 47fea6af | 526 | EdkLogger.error("build", FORMAT_INVALID, File=self.RuleFile, Line=LineIndex + 1,\r |
| f51461c8 LG |
527 | ExtraData="Unknown subsection: %s" % self.RuleContent[LineIndex])\r |
| 528 | ## Parse <InputFile> sub-section\r | |
| 529 | #\r | |
| 530 | # @param LineIndex The line index of build rule text\r | |
| 531 | #\r | |
| 7b85a1af | 532 | def ParseInputFileSubSection(self, LineIndex):\r |
| f51461c8 LG |
533 | FileList = [File.strip() for File in self.RuleContent[LineIndex].split(",")]\r |
| 534 | for ToolChainFamily in self._FamilyList:\r | |
| 7b85a1af YF |
535 | if self._RuleInfo[ToolChainFamily, self._State] is None:\r |
| 536 | self._RuleInfo[ToolChainFamily, self._State] = []\r | |
| 537 | self._RuleInfo[ToolChainFamily, self._State].extend(FileList)\r | |
| f51461c8 LG |
538 | \r |
| 539 | ## Parse <ExtraDependency> sub-section\r | |
| 7b85a1af YF |
540 | ## Parse <OutputFile> sub-section\r |
| 541 | ## Parse <Command> sub-section\r | |
| f51461c8 LG |
542 | #\r |
| 543 | # @param LineIndex The line index of build rule text\r | |
| 544 | #\r | |
| 7b85a1af | 545 | def ParseCommonSubSection(self, LineIndex):\r |
| f51461c8 | 546 | for ToolChainFamily in self._FamilyList:\r |
| 7b85a1af YF |
547 | if self._RuleInfo[ToolChainFamily, self._State] is None:\r |
| 548 | self._RuleInfo[ToolChainFamily, self._State] = []\r | |
| 549 | self._RuleInfo[ToolChainFamily, self._State].append(self.RuleContent[LineIndex])\r | |
| f51461c8 LG |
550 | \r |
| 551 | ## Get a build rule via [] operator\r | |
| 552 | #\r | |
| 553 | # @param FileExt The extension of a file\r | |
| 554 | # @param ToolChainFamily The tool chain family name\r | |
| bc39c5cb | 555 | # @param BuildVersion The build version number. TAB_STAR means any rule\r |
| fb0b35e0 | 556 | # is applicable.\r |
| f51461c8 LG |
557 | #\r |
| 558 | # @retval FileType The file type string\r | |
| 559 | # @retval FileBuildRule The object of FileBuildRule\r | |
| 560 | #\r | |
| 561 | # Key = (FileExt, ModuleType, Arch, ToolChainFamily)\r | |
| 562 | def __getitem__(self, Key):\r | |
| 563 | if not Key:\r | |
| 564 | return None\r | |
| 565 | \r | |
| 566 | if Key[0] in self.Ext2FileType:\r | |
| 567 | Type = self.Ext2FileType[Key[0]]\r | |
| 568 | elif Key[0].upper() in self.FileTypeList:\r | |
| 569 | Type = Key[0].upper()\r | |
| 570 | else:\r | |
| 571 | return None\r | |
| 572 | \r | |
| 573 | if len(Key) > 1:\r | |
| 574 | Key = (Type,) + Key[1:]\r | |
| 575 | else:\r | |
| 576 | Key = (Type,)\r | |
| 577 | return self.RuleDatabase[Key]\r | |
| 578 | \r | |
| 579 | _StateHandler = {\r | |
| 580 | _SectionHeader : ParseSectionHeader,\r | |
| 581 | _Section : ParseSection,\r | |
| 582 | _SubSectionHeader : ParseSubSectionHeader,\r | |
| 583 | _SubSection : ParseSubSection,\r | |
| 7b85a1af YF |
584 | _InputFile : ParseInputFileSubSection,\r |
| 585 | _OutputFile : ParseCommonSubSection,\r | |
| 586 | _ExtraDependency : ParseCommonSubSection,\r | |
| 587 | _Command : ParseCommonSubSection,\r | |
| f51461c8 LG |
588 | _UnknownSection : SkipSection,\r |
| 589 | }\r | |
| 590 | \r | |
| 4465cd12 FZ |
591 | class ToolBuildRule():\r |
| 592 | \r | |
| 593 | def __new__(cls, *args, **kw):\r | |
| 594 | if not hasattr(cls, '_instance'):\r | |
| 595 | orig = super(ToolBuildRule, cls)\r | |
| 596 | cls._instance = orig.__new__(cls, *args, **kw)\r | |
| 597 | return cls._instance\r | |
| 598 | \r | |
| 599 | def __init__(self):\r | |
| 600 | if not hasattr(self, 'ToolBuildRule'):\r | |
| 601 | self._ToolBuildRule = None\r | |
| 602 | \r | |
| 603 | @property\r | |
| 604 | def ToolBuildRule(self):\r | |
| 605 | if not self._ToolBuildRule:\r | |
| 606 | self._GetBuildRule()\r | |
| 607 | return self._ToolBuildRule\r | |
| 608 | \r | |
| 609 | def _GetBuildRule(self):\r | |
| 610 | BuildRuleFile = None\r | |
| 611 | TargetObj = TargetTxtDict()\r | |
| 612 | TargetTxt = TargetObj.Target\r | |
| 613 | if TAB_TAT_DEFINES_BUILD_RULE_CONF in TargetTxt.TargetTxtDictionary:\r | |
| 614 | BuildRuleFile = TargetTxt.TargetTxtDictionary[TAB_TAT_DEFINES_BUILD_RULE_CONF]\r | |
| 615 | if not BuildRuleFile:\r | |
| 616 | BuildRuleFile = gDefaultBuildRuleFile\r | |
| 617 | RetVal = BuildRule(BuildRuleFile)\r | |
| 618 | if RetVal._FileVersion == "":\r | |
| 619 | RetVal._FileVersion = AutoGenReqBuildRuleVerNum\r | |
| 620 | else:\r | |
| 621 | if RetVal._FileVersion < AutoGenReqBuildRuleVerNum :\r | |
| 622 | # If Build Rule's version is less than the version number required by the tools, halting the build.\r | |
| 623 | EdkLogger.error("build", AUTOGEN_ERROR,\r | |
| 624 | 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])"\\r | |
| 625 | % (RetVal._FileVersion, AutoGenReqBuildRuleVerNum))\r | |
| 626 | self._ToolBuildRule = RetVal\r | |
| db01c8e3 | 627 | \r |
| f51461c8 LG |
628 | # This acts like the main() function for the script, unless it is 'import'ed into another\r |
| 629 | # script.\r | |
| 630 | if __name__ == '__main__':\r | |
| 631 | import sys\r | |
| 632 | EdkLogger.Initialize()\r | |
| 633 | if len(sys.argv) > 1:\r | |
| 634 | Br = BuildRule(sys.argv[1])\r | |
| 94c04559 | 635 | print(str(Br[".c", SUP_MODULE_DXE_DRIVER, "IA32", TAB_COMPILER_MSFT][1]))\r |
| 72443dd2 GL |
636 | print()\r |
| 637 | print(str(Br[".c", SUP_MODULE_DXE_DRIVER, "IA32", "INTEL"][1]))\r | |
| 638 | print()\r | |
| 639 | print(str(Br[".c", SUP_MODULE_DXE_DRIVER, "IA32", "GCC"][1]))\r | |
| 640 | print()\r | |
| 94c04559 | 641 | print(str(Br[".ac", "ACPI_TABLE", "IA32", TAB_COMPILER_MSFT][1]))\r |
| 72443dd2 GL |
642 | print()\r |
| 643 | print(str(Br[".h", "ACPI_TABLE", "IA32", "INTEL"][1]))\r | |
| 644 | print()\r | |
| 94c04559 | 645 | print(str(Br[".ac", "ACPI_TABLE", "IA32", TAB_COMPILER_MSFT][1]))\r |
| 72443dd2 GL |
646 | print()\r |
| 647 | print(str(Br[".s", SUP_MODULE_SEC, "IPF", "COMMON"][1]))\r | |
| 648 | print()\r | |
| 649 | print(str(Br[".s", SUP_MODULE_SEC][1]))\r | |
| f51461c8 | 650 | \r |