2 # The engine for building files
4 # Copyright (c) 2007 - 2018, 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
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.
17 import Common
.LongFilePathOs
as os
21 from Common
.LongFilePathSupport
import OpenLongFilePath
as open
23 from Common
.GlobalData
import *
24 from Common
.BuildToolError
import *
25 from Common
.Misc
import tdict
, PathClass
26 from Common
.String
import NormPath
27 from Common
.DataType
import *
29 import Common
.EdkLogger
as EdkLogger
31 ## Convert file type to file list macro name
33 # @param FileType The name of file type
35 # @retval string The name of macro
37 def FileListMacro(FileType
):
38 return "%sS" % FileType
.replace("-", "_").upper()
40 ## Convert file type to list file macro name
42 # @param FileType The name of file type
44 # @retval string The name of macro
46 def ListFileMacro(FileType
):
47 return "%s_LIST" % FileListMacro(FileType
)
49 class TargetDescBlock(object):
50 def __init__(self
, Inputs
, Outputs
, Commands
, Dependencies
):
51 self
.InitWorker(Inputs
, Outputs
, Commands
, Dependencies
)
53 def InitWorker(self
, Inputs
, Outputs
, Commands
, Dependencies
):
55 self
.Outputs
= Outputs
56 self
.Commands
= Commands
57 self
.Dependencies
= Dependencies
59 self
.Target
= self
.Outputs
[0]
64 return self
.Target
.Path
67 return hash(self
.Target
.Path
)
69 def __eq__(self
, Other
):
70 if type(Other
) == type(self
):
71 return Other
.Target
.Path
== self
.Target
.Path
73 return str(Other
) == self
.Target
.Path
75 def AddInput(self
, Input
):
76 if Input
not in self
.Inputs
:
77 self
.Inputs
.append(Input
)
79 def IsMultipleInput(self
):
80 return len(self
.Inputs
) > 1
82 ## Class for one build rule
84 # This represents a build rule which can give out corresponding command list for
85 # building the given source file(s). The result can be used for generating the
86 # target for makefile.
89 INC_LIST_MACRO
= "INC_LIST"
94 # @param Input The dictionary represeting input file(s) for a rule
95 # @param Output The list represeting output file(s) for a rule
96 # @param Command The list containing commands to generate the output from input
98 def __init__(self
, Type
, Input
, Output
, Command
, ExtraDependency
=None):
99 # The Input should not be empty
107 self
.FileListMacro
= FileListMacro(Type
)
108 self
.ListFileMacro
= ListFileMacro(Type
)
109 self
.IncListFileMacro
= self
.INC_LIST_MACRO
111 self
.SourceFileType
= Type
112 # source files listed not in "*" or "?" pattern format
113 if not ExtraDependency
:
114 self
.ExtraSourceFileList
= []
116 self
.ExtraSourceFileList
= ExtraDependency
119 # Search macros used in command lines for <FILE_TYPE>_LIST and INC_LIST.
120 # If found, generate a file to keep the input files used to get over the
121 # limitation of command line length
124 self
.CommandList
= []
125 for CmdLine
in Command
:
126 self
.MacroList
.extend(gMacroRefPattern
.findall(CmdLine
))
127 # replace path separator with native one
128 self
.CommandList
.append(CmdLine
)
130 # Indicate what should be generated
131 if self
.FileListMacro
in self
.MacroList
:
132 self
.GenFileListMacro
= True
134 self
.GenFileListMacro
= False
136 if self
.ListFileMacro
in self
.MacroList
:
137 self
.GenListFile
= True
138 self
.GenFileListMacro
= True
140 self
.GenListFile
= False
142 if self
.INC_LIST_MACRO
in self
.MacroList
:
143 self
.GenIncListFile
= True
145 self
.GenIncListFile
= False
148 self
.IsMultipleInput
= False
149 self
.SourceFileExtList
= set()
151 Base
, Ext
= os
.path
.splitext(File
)
152 if Base
.find("*") >= 0:
153 # There's "*" in the file name
154 self
.IsMultipleInput
= True
155 self
.GenFileListMacro
= True
156 elif Base
.find("?") < 0:
157 # There's no "*" and "?" in file name
158 self
.ExtraSourceFileList
.append(File
)
160 self
.SourceFileExtList
.add(Ext
)
163 self
.DestFileList
= []
165 self
.DestFileList
.append(File
)
167 # All build targets generated by this rule for a module
168 self
.BuildTargets
= {}
170 ## str() function support
176 SourceString
+= " %s %s %s" % (self
.SourceFileType
, " ".join(self
.SourceFileExtList
), self
.ExtraSourceFileList
)
177 DestString
= ", ".join(self
.DestFileList
)
178 CommandString
= "\n\t".join(self
.CommandList
)
179 return "%s : %s\n\t%s" % (DestString
, SourceString
, CommandString
)
181 def Instantiate(self
, Macros
={}):
182 NewRuleObject
= copy
.copy(self
)
183 NewRuleObject
.BuildTargets
= {}
184 NewRuleObject
.DestFileList
= []
185 for File
in self
.DestFileList
:
186 NewRuleObject
.DestFileList
.append(PathClass(NormPath(File
, Macros
)))
189 ## Apply the rule to given source file(s)
191 # @param SourceFile One file or a list of files to be built
192 # @param RelativeToDir The relative path of the source file
193 # @param PathSeparator Path separator
195 # @retval tuple (Source file in full path, List of individual sourcefiles, Destionation file, List of build commands)
197 def Apply(self
, SourceFile
, BuildRuleOrder
=None):
198 if not self
.CommandList
or not self
.DestFileList
:
202 if self
.IsMultipleInput
:
208 # SourceFile must be a list
209 SrcFile
= "$(%s)" % self
.FileListMacro
211 SrcFileName
, SrcFileBase
, SrcFileExt
= SourceFile
.Name
, SourceFile
.BaseName
, SourceFile
.Ext
213 SrcFileDir
= SourceFile
.SubDir
218 SrcFile
= SourceFile
.Path
219 SrcPath
= SourceFile
.Dir
221 # destination file (the first one)
222 if self
.DestFileList
:
223 DestFile
= self
.DestFileList
[0].Path
224 DestPath
= self
.DestFileList
[0].Dir
225 DestFileName
= self
.DestFileList
[0].Name
226 DestFileBase
, DestFileExt
= self
.DestFileList
[0].BaseName
, self
.DestFileList
[0].Ext
234 BuildRulePlaceholderDict
= {
238 "s_dir" : SrcFileDir
,
239 "s_name" : SrcFileName
,
240 "s_base" : SrcFileBase
,
241 "s_ext" : SrcFileExt
,
245 "d_name" : DestFileName
,
246 "d_base" : DestFileBase
,
247 "d_ext" : DestFileExt
,
251 for File
in self
.DestFileList
:
252 File
= string
.Template(str(File
)).safe_substitute(BuildRulePlaceholderDict
)
253 File
= string
.Template(str(File
)).safe_substitute(BuildRulePlaceholderDict
)
254 DstFile
.append(PathClass(File
, IsBinary
=True))
256 if DstFile
[0] in self
.BuildTargets
:
257 TargetDesc
= self
.BuildTargets
[DstFile
[0]]
258 if BuildRuleOrder
and SourceFile
.Ext
in BuildRuleOrder
:
259 Index
= BuildRuleOrder
.index(SourceFile
.Ext
)
260 for Input
in TargetDesc
.Inputs
:
261 if Input
.Ext
not in BuildRuleOrder
or BuildRuleOrder
.index(Input
.Ext
) > Index
:
263 # Command line should be regenerated since some macros are different
265 CommandList
= self
._BuildCommand
(BuildRulePlaceholderDict
)
266 TargetDesc
.InitWorker([SourceFile
], DstFile
, CommandList
, self
.ExtraSourceFileList
)
269 TargetDesc
.AddInput(SourceFile
)
271 CommandList
= self
._BuildCommand
(BuildRulePlaceholderDict
)
272 TargetDesc
= TargetDescBlock([SourceFile
], DstFile
, CommandList
, self
.ExtraSourceFileList
)
273 TargetDesc
.ListFileMacro
= self
.ListFileMacro
274 TargetDesc
.FileListMacro
= self
.FileListMacro
275 TargetDesc
.IncListFileMacro
= self
.IncListFileMacro
276 TargetDesc
.GenFileListMacro
= self
.GenFileListMacro
277 TargetDesc
.GenListFile
= self
.GenListFile
278 TargetDesc
.GenIncListFile
= self
.GenIncListFile
279 self
.BuildTargets
[DstFile
[0]] = TargetDesc
282 def _BuildCommand(self
, Macros
):
284 for CommandString
in self
.CommandList
:
285 CommandString
= string
.Template(CommandString
).safe_substitute(Macros
)
286 CommandString
= string
.Template(CommandString
).safe_substitute(Macros
)
287 CommandList
.append(CommandString
)
290 ## Class for build rules
292 # BuildRule class parses rules defined in a file or passed by caller, and converts
293 # the rule into FileBuildRule object.
296 _SectionHeader
= "SECTIONHEADER"
298 _SubSectionHeader
= "SUBSECTIONHEADER"
299 _SubSection
= "SUBSECTION"
300 _InputFile
= "INPUTFILE"
301 _OutputFile
= "OUTPUTFILE"
302 _ExtraDependency
= "EXTRADEPENDENCY"
304 _UnknownSection
= "UNKNOWNSECTION"
306 _SubSectionList
= [_InputFile
, _OutputFile
, _Command
]
309 _FileTypePattern
= re
.compile("^[_a-zA-Z][_\-0-9a-zA-Z]*$")
310 _BinaryFileRule
= FileBuildRule(TAB_DEFAULT_BINARY_FILE
, [], [os
.path
.join("$(OUTPUT_DIR)", "${s_name}")],
311 ["$(CP) ${src} ${dst}"], [])
315 # @param File The file containing build rules in a well defined format
316 # @param Content The string list of build rules in a well defined format
317 # @param LineIndex The line number from which the parsing will begin
318 # @param SupportedFamily The list of supported tool chain families
320 def __init__(self
, File
=None, Content
=None, LineIndex
=0, SupportedFamily
=["MSFT", "INTEL", "GCC", "RVCT"]):
322 # Read build rules from file if it's not none
325 self
.RuleContent
= open(File
, 'r').readlines()
327 EdkLogger
.error("build", FILE_OPEN_FAILURE
, ExtraData
=File
)
328 elif Content
is not None:
329 self
.RuleContent
= Content
331 EdkLogger
.error("build", PARAMETER_MISSING
, ExtraData
="No rule file or string given")
333 self
.SupportedToolChainFamilyList
= SupportedFamily
334 self
.RuleDatabase
= tdict(True, 4) # {FileExt, ModuleType, Arch, Family : FileBuildRule object}
335 self
.Ext2FileType
= {} # {ext : file-type}
336 self
.FileTypeList
= set()
338 self
._LineIndex
= LineIndex
340 self
._RuleInfo
= tdict(True, 2) # {toolchain family : {"InputFile": {}, "OutputFile" : [], "Command" : []}}
342 self
._BuildTypeList
= set()
343 self
._ArchList
= set()
344 self
._FamilyList
= []
345 self
._TotalToolChainFamilySet
= set()
346 self
._RuleObjectList
= [] # FileBuildRule object list
347 self
._FileVersion
= ""
351 # some intrinsic rules
352 self
.RuleDatabase
[TAB_DEFAULT_BINARY_FILE
, TAB_COMMON
, TAB_COMMON
, TAB_COMMON
] = self
._BinaryFileRule
353 self
.FileTypeList
.add(TAB_DEFAULT_BINARY_FILE
)
355 ## Parse the build rule strings
357 self
._State
= self
._Section
358 for Index
in range(self
._LineIndex
, len(self
.RuleContent
)):
359 # Clean up the line and replace path separator with native one
360 Line
= self
.RuleContent
[Index
].strip().replace(self
._PATH
_SEP
, os
.path
.sep
)
361 self
.RuleContent
[Index
] = Line
363 # find the build_rule_version
364 if Line
and Line
[0] == "#" and Line
.find(TAB_BUILD_RULE_VERSION
) <> -1:
365 if Line
.find("=") <> -1 and Line
.find("=") < (len(Line
) - 1) and (Line
[(Line
.find("=") + 1):]).split():
366 self
._FileVersion
= (Line
[(Line
.find("=") + 1):]).split()[0]
367 # skip empty or comment line
368 if Line
== "" or Line
[0] == "#":
371 # find out section header, enclosed by []
372 if Line
[0] == '[' and Line
[-1] == ']':
373 # merge last section information into rule database
375 self
._State
= self
._SectionHeader
376 # find out sub-section header, enclosed by <>
377 elif Line
[0] == '<' and Line
[-1] == '>':
378 if self
._State
!= self
._UnknownSection
:
379 self
._State
= self
._SubSectionHeader
381 # call section handler to parse each (sub)section
382 self
._StateHandler
[self
._State
](self
, Index
)
383 # merge last section information into rule database
386 ## Parse definitions under a section
388 # @param LineIndex The line index of build rule text
390 def ParseSection(self
, LineIndex
):
393 ## Parse definitions under a subsection
395 # @param LineIndex The line index of build rule text
397 def ParseSubSection(self
, LineIndex
):
398 # currenly nothing here
401 ## Placeholder for not supported sections
403 # @param LineIndex The line index of build rule text
405 def SkipSection(self
, LineIndex
):
408 ## Merge section information just got into rule database
409 def EndOfSection(self
):
410 Database
= self
.RuleDatabase
411 # if there's specific toochain family, 'COMMON' doesn't make sense any more
412 if len(self
._TotalToolChainFamilySet
) > 1 and TAB_COMMON
in self
._TotalToolChainFamilySet
:
413 self
._TotalToolChainFamilySet
.remove(TAB_COMMON
)
414 for Family
in self
._TotalToolChainFamilySet
:
415 Input
= self
._RuleInfo
[Family
, self
._InputFile
]
416 Output
= self
._RuleInfo
[Family
, self
._OutputFile
]
417 Command
= self
._RuleInfo
[Family
, self
._Command
]
418 ExtraDependency
= self
._RuleInfo
[Family
, self
._ExtraDependency
]
420 BuildRule
= FileBuildRule(self
._FileType
, Input
, Output
, Command
, ExtraDependency
)
421 for BuildType
in self
._BuildTypeList
:
422 for Arch
in self
._ArchList
:
423 Database
[self
._FileType
, BuildType
, Arch
, Family
] = BuildRule
424 for FileExt
in BuildRule
.SourceFileExtList
:
425 self
.Ext2FileType
[FileExt
] = self
._FileType
427 ## Parse section header
429 # @param LineIndex The line index of build rule text
431 def ParseSectionHeader(self
, LineIndex
):
432 self
._RuleInfo
= tdict(True, 2)
433 self
._BuildTypeList
= set()
434 self
._ArchList
= set()
435 self
._FamilyList
= []
436 self
._TotalToolChainFamilySet
= set()
438 RuleNameList
= self
.RuleContent
[LineIndex
][1:-1].split(',')
439 for RuleName
in RuleNameList
:
441 BuildType
= TAB_COMMON
442 TokenList
= [Token
.strip().upper() for Token
in RuleName
.split('.')]
443 # old format: Build.File-Type
444 if TokenList
[0] == "BUILD":
445 if len(TokenList
) == 1:
446 EdkLogger
.error("build", FORMAT_INVALID
, "Invalid rule section",
447 File
=self
.RuleFile
, Line
=LineIndex
+ 1,
448 ExtraData
=self
.RuleContent
[LineIndex
])
450 FileType
= TokenList
[1]
452 EdkLogger
.error("build", FORMAT_INVALID
, "No file type given",
453 File
=self
.RuleFile
, Line
=LineIndex
+ 1,
454 ExtraData
=self
.RuleContent
[LineIndex
])
455 if self
._FileTypePattern
.match(FileType
) is None:
456 EdkLogger
.error("build", FORMAT_INVALID
, File
=self
.RuleFile
, Line
=LineIndex
+ 1,
457 ExtraData
="Only character, number (non-first character), '_' and '-' are allowed in file type")
458 # new format: File-Type.Build-Type.Arch
461 FileType
= TokenList
[0]
462 elif FileType
!= TokenList
[0]:
463 EdkLogger
.error("build", FORMAT_INVALID
,
464 "Different file types are not allowed in the same rule section",
465 File
=self
.RuleFile
, Line
=LineIndex
+ 1,
466 ExtraData
=self
.RuleContent
[LineIndex
])
467 if len(TokenList
) > 1:
468 BuildType
= TokenList
[1]
469 if len(TokenList
) > 2:
471 self
._BuildTypeList
.add(BuildType
)
472 self
._ArchList
.add(Arch
)
474 if TAB_COMMON
in self
._BuildTypeList
and len(self
._BuildTypeList
) > 1:
475 EdkLogger
.error("build", FORMAT_INVALID
,
476 "Specific build types must not be mixed with common one",
477 File
=self
.RuleFile
, Line
=LineIndex
+ 1,
478 ExtraData
=self
.RuleContent
[LineIndex
])
479 if TAB_COMMON
in self
._ArchList
and len(self
._ArchList
) > 1:
480 EdkLogger
.error("build", FORMAT_INVALID
,
481 "Specific ARCH must not be mixed with common one",
482 File
=self
.RuleFile
, Line
=LineIndex
+ 1,
483 ExtraData
=self
.RuleContent
[LineIndex
])
485 self
._FileType
= FileType
486 self
._State
= self
._Section
487 self
.FileTypeList
.add(FileType
)
489 ## Parse sub-section header
491 # @param LineIndex The line index of build rule text
493 def ParseSubSectionHeader(self
, LineIndex
):
495 List
= self
.RuleContent
[LineIndex
][1:-1].split(',')
498 TokenList
= Section
.split('.')
499 Type
= TokenList
[0].strip().upper()
501 if SectionType
== "":
503 elif SectionType
!= Type
:
504 EdkLogger
.error("build", FORMAT_INVALID
,
505 "Two different section types are not allowed in the same sub-section",
506 File
=self
.RuleFile
, Line
=LineIndex
+ 1,
507 ExtraData
=self
.RuleContent
[LineIndex
])
509 if len(TokenList
) > 1:
510 Family
= TokenList
[1].strip().upper()
514 if Family
not in FamilyList
:
515 FamilyList
.append(Family
)
517 self
._FamilyList
= FamilyList
518 self
._TotalToolChainFamilySet
.update(FamilyList
)
519 self
._State
= SectionType
.upper()
520 if TAB_COMMON
in FamilyList
and len(FamilyList
) > 1:
521 EdkLogger
.error("build", FORMAT_INVALID
,
522 "Specific tool chain family should not be mixed with general one",
523 File
=self
.RuleFile
, Line
=LineIndex
+ 1,
524 ExtraData
=self
.RuleContent
[LineIndex
])
525 if self
._State
not in self
._StateHandler
:
526 EdkLogger
.error("build", FORMAT_INVALID
, File
=self
.RuleFile
, Line
=LineIndex
+ 1,
527 ExtraData
="Unknown subsection: %s" % self
.RuleContent
[LineIndex
])
528 ## Parse <InputFile> sub-section
530 # @param LineIndex The line index of build rule text
532 def ParseInputFile(self
, LineIndex
):
533 FileList
= [File
.strip() for File
in self
.RuleContent
[LineIndex
].split(",")]
534 for ToolChainFamily
in self
._FamilyList
:
535 InputFiles
= self
._RuleInfo
[ToolChainFamily
, self
._State
]
536 if InputFiles
is None:
538 self
._RuleInfo
[ToolChainFamily
, self
._State
] = InputFiles
539 InputFiles
.extend(FileList
)
541 ## Parse <ExtraDependency> sub-section
543 # @param LineIndex The line index of build rule text
545 def ParseCommon(self
, LineIndex
):
546 for ToolChainFamily
in self
._FamilyList
:
547 Items
= self
._RuleInfo
[ToolChainFamily
, self
._State
]
550 self
._RuleInfo
[ToolChainFamily
, self
._State
] = Items
551 Items
.append(self
.RuleContent
[LineIndex
])
553 ## Get a build rule via [] operator
555 # @param FileExt The extension of a file
556 # @param ToolChainFamily The tool chain family name
557 # @param BuildVersion The build version number. "*" means any rule
560 # @retval FileType The file type string
561 # @retval FileBuildRule The object of FileBuildRule
563 # Key = (FileExt, ModuleType, Arch, ToolChainFamily)
564 def __getitem__(self
, Key
):
568 if Key
[0] in self
.Ext2FileType
:
569 Type
= self
.Ext2FileType
[Key
[0]]
570 elif Key
[0].upper() in self
.FileTypeList
:
571 Type
= Key
[0].upper()
576 Key
= (Type
,) + Key
[1:]
579 return self
.RuleDatabase
[Key
]
582 _SectionHeader
: ParseSectionHeader
,
583 _Section
: ParseSection
,
584 _SubSectionHeader
: ParseSubSectionHeader
,
585 _SubSection
: ParseSubSection
,
586 _InputFile
: ParseInputFile
,
587 _OutputFile
: ParseCommon
,
588 _ExtraDependency
: ParseCommon
,
589 _Command
: ParseCommon
,
590 _UnknownSection
: SkipSection
,
593 # This acts like the main() function for the script, unless it is 'import'ed into another
595 if __name__
== '__main__':
597 EdkLogger
.Initialize()
598 if len(sys
.argv
) > 1:
599 Br
= BuildRule(sys
.argv
[1])
600 print str(Br
[".c", SUP_MODULE_DXE_DRIVER
, "IA32", "MSFT"][1])
602 print str(Br
[".c", SUP_MODULE_DXE_DRIVER
, "IA32", "INTEL"][1])
604 print str(Br
[".c", SUP_MODULE_DXE_DRIVER
, "IA32", "GCC"][1])
606 print str(Br
[".ac", "ACPI_TABLE", "IA32", "MSFT"][1])
608 print str(Br
[".h", "ACPI_TABLE", "IA32", "INTEL"][1])
610 print str(Br
[".ac", "ACPI_TABLE", "IA32", "MSFT"][1])
612 print str(Br
[".s", SUP_MODULE_SEC
, "IPF", "COMMON"][1])
614 print str(Br
[".s", SUP_MODULE_SEC
][1])