2 # This file is used to define common parsing related functions used in parsing
3 # Inf/Dsc/Makefile process
5 # Copyright (c) 2008 - 2010, Intel Corporation. All rights reserved.<BR>
6 # This program and the accompanying materials
7 # are licensed and made available under the terms and conditions of the BSD License
8 # which accompanies this distribution. The full text of the license may be found at
9 # http://opensource.org/licenses/bsd-license.php
11 # THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
12 # WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
19 import Common
.EdkLogger
as EdkLogger
20 from Common
.DataType
import *
21 from CommonDataClass
.DataClass
import *
22 from Common
.String
import CleanString
, GetSplitValueList
, ReplaceMacro
24 from Common
.Misc
import sdict
26 ## PreProcess() method
30 # 1. Remove all comments
31 # 2. Merge multiple lines code to one line
33 # @param Filename: Name of the file to be parsed
34 # @param MergeMultipleLines: Switch for if merge multiple lines
35 # @param LineNo: Default line no
37 # @return Lines: The file contents after remvoing comments
39 def PreProcess(Filename
, MergeMultipleLines
= True, LineNo
= -1):
41 Filename
= os
.path
.normpath(Filename
)
42 if not os
.path
.isfile(Filename
):
43 EdkLogger
.error("Eot", EdkLogger
.FILE_NOT_FOUND
, ExtraData
=Filename
)
45 IsFindBlockComment
= False
46 IsFindBlockCode
= False
48 ReservedLineLength
= 0
49 for Line
in open(Filename
, 'r'):
51 # Remove comment block
52 if Line
.find(TAB_COMMENT_EDK_START
) > -1:
53 ReservedLine
= GetSplitValueList(Line
, TAB_COMMENT_EDK_START
, 1)[0]
54 IsFindBlockComment
= True
55 if Line
.find(TAB_COMMENT_EDK_END
) > -1:
56 Line
= ReservedLine
+ GetSplitValueList(Line
, TAB_COMMENT_EDK_END
, 1)[1]
58 IsFindBlockComment
= False
59 if IsFindBlockComment
:
63 # Remove comments at tail and remove spaces again
64 Line
= CleanString(Line
)
69 if MergeMultipleLines
:
70 # Add multiple lines to one line
71 if IsFindBlockCode
and Line
[-1] != TAB_SLASH
:
72 ReservedLine
= (ReservedLine
+ TAB_SPACE_SPLIT
+ Line
).strip()
73 Lines
.append(ReservedLine
)
74 for Index
in (0, ReservedLineLength
):
77 ReservedLineLength
= 0
78 IsFindBlockCode
= False
80 if Line
[-1] == TAB_SLASH
:
81 ReservedLine
= ReservedLine
+ TAB_SPACE_SPLIT
+ Line
[0:-1].strip()
82 ReservedLineLength
= ReservedLineLength
+ 1
83 IsFindBlockCode
= True
90 ## AddToGlobalMacro() method
92 # Add a macro to EotGlobalData.gMACRO
94 # @param Name: Name of the macro
95 # @param Value: Value of the macro
97 def AddToGlobalMacro(Name
, Value
):
98 Value
= ReplaceMacro(Value
, EotGlobalData
.gMACRO
, True)
99 EotGlobalData
.gMACRO
[Name
] = Value
101 ## AddToSelfMacro() method
103 # Parse a line of macro definition and add it to a macro set
105 # @param SelfMacro: The self macro set
106 # @param Line: The line of a macro definition
108 # @return Name: Name of macro
109 # @return Value: Value of macro
111 def AddToSelfMacro(SelfMacro
, Line
):
113 List
= GetSplitValueList(Line
, TAB_EQUAL_SPLIT
, 1)
117 Value
= ReplaceMacro(Value
, EotGlobalData
.gMACRO
, True)
118 Value
= ReplaceMacro(Value
, SelfMacro
, True)
119 SelfMacro
[Name
] = Value
123 ## GetIncludeListOfFile() method
125 # Get the include path list for a source file
127 # 1. Find the source file belongs to which INF file
128 # 2. Find the inf's package
129 # 3. Return the include path list of the package
131 # @param WorkSpace: WORKSPACE path
132 # @param Filepath: File path
133 # @param Db: Eot database
135 # @return IncludeList: A list of include directories
137 def GetIncludeListOfFile(WorkSpace
, Filepath
, Db
):
139 Filepath
= os
.path
.normpath(Filepath
)
141 select Value1 from Inf where Model = %s and BelongsToFile in(
142 select distinct B.BelongsToFile from File as A left join Inf as B
143 where A.ID = B.BelongsToFile and B.Model = %s and (A.Path || '%s' || B.Value1) = '%s')""" \
144 % (MODEL_META_DATA_PACKAGE
, MODEL_EFI_SOURCE_FILE
, '\\', Filepath
)
145 RecordSet
= Db
.TblFile
.Exec(SqlCommand
)
146 for Record
in RecordSet
:
147 DecFullPath
= os
.path
.normpath(os
.path
.join(WorkSpace
, Record
[0]))
148 (DecPath
, DecName
) = os
.path
.split(DecFullPath
)
149 SqlCommand
= """select Value1 from Dec where BelongsToFile =
150 (select ID from File where FullPath = '%s') and Model = %s""" \
151 % (DecFullPath
, MODEL_EFI_INCLUDE
)
152 NewRecordSet
= Db
.TblDec
.Exec(SqlCommand
)
153 for NewRecord
in NewRecordSet
:
154 IncludePath
= os
.path
.normpath(os
.path
.join(DecPath
, NewRecord
[0]))
155 if IncludePath
not in IncludeList
:
156 IncludeList
.append(IncludePath
)
160 ## GetTableList() method
162 # Search table file and find all small tables
164 # @param FileModelList: Model code for the file list
165 # @param Table: Table to insert records
166 # @param Db: Eot database
168 # @return TableList: A list of tables
170 def GetTableList(FileModelList
, Table
, Db
):
172 SqlCommand
= """select ID, FullPath from File where Model in %s""" % str(FileModelList
)
173 RecordSet
= Db
.TblFile
.Exec(SqlCommand
)
174 for Record
in RecordSet
:
175 TableName
= Table
+ str(Record
[0])
176 TableList
.append([TableName
, Record
[1]])
180 ## GetAllIncludeDir() method
182 # Find all Include directories
184 # @param Db: Eot database
186 # @return IncludeList: A list of include directories
188 def GetAllIncludeDirs(Db
):
190 SqlCommand
= """select distinct Value1 from Inf where Model = %s order by Value1""" % MODEL_EFI_INCLUDE
191 RecordSet
= Db
.TblInf
.Exec(SqlCommand
)
193 for Record
in RecordSet
:
194 IncludeList
.append(Record
[0])
198 ## GetAllIncludeFiles() method
200 # Find all Include files
202 # @param Db: Eot database
204 # @return IncludeFileList: A list of include files
206 def GetAllIncludeFiles(Db
):
207 IncludeList
= GetAllIncludeDirs(Db
)
210 for Dir
in IncludeList
:
211 if os
.path
.isdir(Dir
):
212 SubDir
= os
.listdir(Dir
)
214 if os
.path
.isfile(Item
):
215 IncludeFileList
.append(Item
)
217 return IncludeFileList
219 ## GetAllSourceFiles() method
221 # Find all source files
223 # @param Db: Eot database
225 # @return SourceFileList: A list of source files
227 def GetAllSourceFiles(Db
):
229 SqlCommand
= """select distinct Value1 from Inf where Model = %s order by Value1""" % MODEL_EFI_SOURCE_FILE
230 RecordSet
= Db
.TblInf
.Exec(SqlCommand
)
232 for Record
in RecordSet
:
233 SourceFileList
.append(Record
[0])
235 return SourceFileList
237 ## GetAllFiles() method
239 # Find all files, both source files and include files
241 # @param Db: Eot database
243 # @return FileList: A list of files
247 IncludeFileList
= GetAllIncludeFiles(Db
)
248 SourceFileList
= GetAllSourceFiles(Db
)
249 for Item
in IncludeFileList
:
250 if os
.path
.isfile(Item
) and Item
not in FileList
:
251 FileList
.append(Item
)
252 for Item
in SourceFileList
:
253 if os
.path
.isfile(Item
) and Item
not in FileList
:
254 FileList
.append(Item
)
258 ## ParseConditionalStatement() method
260 # Parse conditional statement
262 # @param Line: One line to be parsed
263 # @param Macros: A set of all macro
264 # @param StatusSet: A set of all status
266 # @retval True: Find keyword of conditional statement
267 # @retval False: Not find keyword of conditional statement
269 def ParseConditionalStatement(Line
, Macros
, StatusSet
):
270 NewLine
= Line
.upper()
271 if NewLine
.find(TAB_IF_EXIST
.upper()) > -1:
272 IfLine
= Line
[NewLine
.find(TAB_IF_EXIST
) + len(TAB_IF_EXIST
) + 1:].strip()
273 IfLine
= ReplaceMacro(IfLine
, EotGlobalData
.gMACRO
, True)
274 IfLine
= ReplaceMacro(IfLine
, Macros
, True)
275 IfLine
= IfLine
.replace("\"", '')
276 IfLine
= IfLine
.replace("(", '')
277 IfLine
= IfLine
.replace(")", '')
278 Status
= os
.path
.exists(os
.path
.normpath(IfLine
))
279 StatusSet
.append([Status
])
281 if NewLine
.find(TAB_IF_DEF
.upper()) > -1:
282 IfLine
= Line
[NewLine
.find(TAB_IF_DEF
) + len(TAB_IF_DEF
) + 1:].strip()
284 if IfLine
in Macros
or IfLine
in EotGlobalData
.gMACRO
:
286 StatusSet
.append([Status
])
288 if NewLine
.find(TAB_IF_N_DEF
.upper()) > -1:
289 IfLine
= Line
[NewLine
.find(TAB_IF_N_DEF
) + len(TAB_IF_N_DEF
) + 1:].strip()
291 if IfLine
not in Macros
and IfLine
not in EotGlobalData
.gMACRO
:
293 StatusSet
.append([Status
])
295 if NewLine
.find(TAB_IF
.upper()) > -1:
296 IfLine
= Line
[NewLine
.find(TAB_IF
) + len(TAB_IF
) + 1:].strip()
297 Status
= ParseConditionalStatementMacros(IfLine
, Macros
)
298 StatusSet
.append([Status
])
300 if NewLine
.find(TAB_ELSE_IF
.upper()) > -1:
301 IfLine
= Line
[NewLine
.find(TAB_ELSE_IF
) + len(TAB_ELSE_IF
) + 1:].strip()
302 Status
= ParseConditionalStatementMacros(IfLine
, Macros
)
303 StatusSet
[-1].append(Status
)
305 if NewLine
.find(TAB_ELSE
.upper()) > -1:
307 for Item
in StatusSet
[-1]:
308 Status
= Status
or Item
309 StatusSet
[-1].append(not Status
)
311 if NewLine
.find(TAB_END_IF
.upper()) > -1:
317 ## ParseConditionalStatement() method
319 # Parse conditional statement with Macros
321 # @param Line: One line to be parsed
322 # @param Macros: A set of macros
324 # @return Line: New line after replacing macros
326 def ParseConditionalStatementMacros(Line
, Macros
):
327 if Line
.upper().find('DEFINED(') > -1 or Line
.upper().find('EXIST') > -1:
329 Line
= ReplaceMacro(Line
, EotGlobalData
.gMACRO
, True)
330 Line
= ReplaceMacro(Line
, Macros
, True)
331 Line
= Line
.replace("&&", "and")
332 Line
= Line
.replace("||", "or")
335 ## GetConditionalStatementStatus() method
337 # 1. Assume the latest status as True
338 # 2. Pop the top status of status set, previous status
339 # 3. Compare the latest one and the previous one and get new status
341 # @param StatusSet: A set of all status
343 # @return Status: The final status
345 def GetConditionalStatementStatus(StatusSet
):
347 for Item
in StatusSet
:
348 Status
= Status
and Item
[-1]
352 ## SearchBelongsToFunction() method
354 # Search all functions belong to the file
356 # @param BelongsToFile: File id
357 # @param StartLine: Start line of search scope
358 # @param EndLine: End line of search scope
360 # @return: The found function
362 def SearchBelongsToFunction(BelongsToFile
, StartLine
, EndLine
):
363 SqlCommand
= """select ID, Name from Function where BelongsToFile = %s and StartLine <= %s and EndLine >= %s""" %(BelongsToFile
, StartLine
, EndLine
)
364 RecordSet
= EotGlobalData
.gDb
.TblFunction
.Exec(SqlCommand
)
366 return RecordSet
[0][0], RecordSet
[0][1]
370 ## SearchPpiCallFunction() method
372 # Search all used PPI calling function 'PeiServicesReInstallPpi' and 'PeiServicesInstallPpi'
373 # Store the result to database
375 # @param Identifier: Table id
376 # @param SourceFileID: Source file id
377 # @param SourceFileFullPath: Source file full path
378 # @param ItemMode: Mode of the item
380 def SearchPpiCallFunction(Identifier
, SourceFileID
, SourceFileFullPath
, ItemMode
):
381 ItemName
, ItemType
, GuidName
, GuidMacro
, GuidValue
= '', 'Ppi', '', '', ''
382 SqlCommand
= """select Value, Name, BelongsToFile, StartLine, EndLine from %s
383 where (Name like '%%%s%%' and Model = %s)""" \
384 % (Identifier
, 'PeiServicesReInstallPpi', MODEL_IDENTIFIER_FUNCTION_CALLING
)
385 BelongsToFunctionID
, BelongsToFunction
= -1, ''
386 Db
= EotGlobalData
.gDb
.TblReport
387 RecordSet
= Db
.Exec(SqlCommand
)
388 for Record
in RecordSet
:
390 BelongsToFile
, StartLine
, EndLine
= Record
[2], Record
[3], Record
[4]
391 BelongsToFunctionID
, BelongsToFunction
= SearchBelongsToFunction(BelongsToFile
, StartLine
, EndLine
)
392 VariableList
= Record
[0].split(',')
393 for Variable
in VariableList
:
394 Variable
= Variable
.strip()
395 # Get index of the variable
396 if Variable
.find('[') > -1:
397 Index
= int(Variable
[Variable
.find('[') + 1 : Variable
.find(']')])
398 Variable
= Variable
[:Variable
.find('[')]
400 if Variable
.startswith('&'):
401 Variable
= Variable
[1:]
403 SqlCommand
= """select Value from %s where (Name like '%%%s%%') and Model = %s""" \
404 % (Identifier
, Variable
, MODEL_IDENTIFIER_VARIABLE
)
405 NewRecordSet
= Db
.Exec(SqlCommand
)
407 NewRecord
= NewRecordSet
[0][0]
408 VariableValueList
= NewRecord
.split('},')
409 if len(VariableValueList
) > Index
:
410 VariableValue
= VariableValueList
[Index
]
411 NewVariableValueList
= VariableValue
.split(',')
412 if len(NewVariableValueList
) > 1:
413 NewVariableValue
= NewVariableValueList
[1].strip()
414 if NewVariableValue
.startswith('&'):
415 Db
.Insert(-1, '', '', SourceFileID
, SourceFileFullPath
, ItemName
, ItemType
, ItemMode
, NewVariableValue
[1:], GuidMacro
, GuidValue
, BelongsToFunction
, 0)
418 EotGlobalData
.gOP_UN_MATCHED
.write('%s, %s, %s, %s, %s, %s\n' % (ItemType
, ItemMode
, SourceFileID
, SourceFileFullPath
, StartLine
, NewParameter
))
420 ItemName
, ItemType
, GuidName
, GuidMacro
, GuidValue
= '', 'Ppi', '', '', ''
421 SqlCommand
= """select Value, Name, BelongsToFile, StartLine, EndLine from %s
422 where (Value like '%%%s%%' and Model = %s)""" \
423 % (Identifier
, 'PeiServicesInstallPpi', MODEL_IDENTIFIER_ASSIGNMENT_EXPRESSION
)
424 BelongsToFunctionID
, BelongsToFunction
= -1, ''
425 Db
= EotGlobalData
.gDb
.TblReport
426 RecordSet
= Db
.Exec(SqlCommand
)
428 SqlCommand
= """select Value, Name, BelongsToFile, StartLine, EndLine from %s
429 where (Name like '%%%s%%' and Model = %s)""" \
430 % (Identifier
, 'PeiServicesInstallPpi', MODEL_IDENTIFIER_FUNCTION_CALLING
)
431 Db
= EotGlobalData
.gDb
.TblReport
432 RecordSet2
= Db
.Exec(SqlCommand
)
434 for Record
in RecordSet
+ RecordSet2
:
438 BelongsToFile
, StartLine
, EndLine
= Record
[2], Record
[3], Record
[4]
439 BelongsToFunctionID
, BelongsToFunction
= SearchBelongsToFunction(BelongsToFile
, StartLine
, EndLine
)
440 Variable
= Record
[0].replace('PeiServicesInstallPpi', '').replace('(', '').replace(')', '').replace('&', '').strip()
441 Variable
= Variable
[Variable
.find(',') + 1:].strip()
442 # Get index of the variable
443 if Variable
.find('[') > -1:
444 Index
= int(Variable
[Variable
.find('[') + 1 : Variable
.find(']')])
445 Variable
= Variable
[:Variable
.find('[')]
447 if Variable
.startswith('&'):
448 Variable
= Variable
[1:]
450 SqlCommand
= """select Value from %s where (Name like '%%%s%%') and Model = %s""" \
451 % (Identifier
, Variable
, MODEL_IDENTIFIER_VARIABLE
)
452 NewRecordSet
= Db
.Exec(SqlCommand
)
454 NewRecord
= NewRecordSet
[0][0]
455 VariableValueList
= NewRecord
.split('},')
456 for VariableValue
in VariableValueList
[Index
:]:
457 NewVariableValueList
= VariableValue
.split(',')
458 if len(NewVariableValueList
) > 1:
459 NewVariableValue
= NewVariableValueList
[1].strip()
460 if NewVariableValue
.startswith('&'):
461 Db
.Insert(-1, '', '', SourceFileID
, SourceFileFullPath
, ItemName
, ItemType
, ItemMode
, NewVariableValue
[1:], GuidMacro
, GuidValue
, BelongsToFunction
, 0)
464 EotGlobalData
.gOP_UN_MATCHED
.write('%s, %s, %s, %s, %s, %s\n' % (ItemType
, ItemMode
, SourceFileID
, SourceFileFullPath
, StartLine
, NewParameter
))
466 ## SearchPpis() method
468 # Search all used PPI calling function
469 # Store the result to database
471 # @param SqlCommand: SQL command statement
472 # @param Table: Table id
473 # @param SourceFileID: Source file id
474 # @param SourceFileFullPath: Source file full path
475 # @param ItemMode: Mode of the item
476 # @param PpiMode: Mode of PPI
478 def SearchPpi(SqlCommand
, Table
, SourceFileID
, SourceFileFullPath
, ItemMode
, PpiMode
= 1):
479 ItemName
, ItemType
, GuidName
, GuidMacro
, GuidValue
= '', 'Ppi', '', '', ''
480 BelongsToFunctionID
, BelongsToFunction
= -1, ''
481 Db
= EotGlobalData
.gDb
.TblReport
482 RecordSet
= Db
.Exec(SqlCommand
)
483 for Record
in RecordSet
:
484 Parameter
= GetPpiParameter(Record
[0], PpiMode
)
485 BelongsToFile
, StartLine
, EndLine
= Record
[2], Record
[3], Record
[4]
486 # Get BelongsToFunction
487 BelongsToFunctionID
, BelongsToFunction
= SearchBelongsToFunction(BelongsToFile
, StartLine
, EndLine
)
489 # Default is Not Found
493 if ItemMode
== 'Consumed':
494 if Parameter
.startswith('g'):
495 Db
.Insert(-1, '', '', SourceFileID
, SourceFileFullPath
, ItemName
, ItemType
, ItemMode
, Parameter
, GuidMacro
, GuidValue
, BelongsToFunction
, 0)
497 EotGlobalData
.gOP_UN_MATCHED
.write('%s, %s, %s, %s, %s, %s\n' % (ItemType
, ItemMode
, SourceFileID
, SourceFileFullPath
, StartLine
, Parameter
))
500 # Direct Parameter.Guid
501 SqlCommand
= """select Value from %s where (Name like '%%%s.Guid%%' or Name like '%%%s->Guid%%') and Model = %s""" % (Table
, Parameter
, Parameter
, MODEL_IDENTIFIER_ASSIGNMENT_EXPRESSION
)
502 NewRecordSet
= Db
.Exec(SqlCommand
)
503 for NewRecord
in NewRecordSet
:
504 GuidName
= GetParameterName(NewRecord
[0])
505 Db
.Insert(-1, '', '', SourceFileID
, SourceFileFullPath
, ItemName
, ItemType
, ItemMode
, GuidName
, GuidMacro
, GuidValue
, BelongsToFunction
, 0)
511 if Key
.rfind(' ') > -1:
512 Key
= Key
[Key
.rfind(' ') : ].strip().replace('&', '')
513 Value
= FindKeyValue(EotGlobalData
.gDb
.TblFile
, Table
, Key
)
514 List
= GetSplitValueList(Value
.replace('\n', ''), TAB_COMMA_SPLIT
)
516 GuidName
= GetParameterName(List
[1])
517 Db
.Insert(-1, '', '', SourceFileID
, SourceFileFullPath
, ItemName
, ItemType
, ItemMode
, GuidName
, GuidMacro
, GuidValue
, BelongsToFunction
, 0)
522 Start
= Parameter
.find('[')
523 End
= Parameter
.find(']')
524 if Start
> -1 and End
> -1 and Start
< End
:
526 Index
= int(Parameter
[Start
+ 1 : End
])
527 Parameter
= Parameter
[0 : Start
]
528 SqlCommand
= """select Value from %s where Name = '%s' and Model = %s""" % (Table
, Parameter
, MODEL_IDENTIFIER_VARIABLE
)
529 NewRecordSet
= Db
.Exec(SqlCommand
)
530 for NewRecord
in NewRecordSet
:
531 NewParameter
= GetSplitValueList(NewRecord
[0], '}')[Index
]
532 GuidName
= GetPpiParameter(NewParameter
[NewParameter
.find('{') : ])
533 Db
.Insert(-1, '', '', SourceFileID
, SourceFileFullPath
, ItemName
, ItemType
, ItemMode
, GuidName
, GuidMacro
, GuidValue
, BelongsToFunction
, 0)
538 # A External Parameter
540 SqlCommand
= """select File.ID from Inf, File
541 where BelongsToFile = (select BelongsToFile from Inf where Value1 = '%s')
542 and Inf.Model = %s and Inf.Value1 = File.FullPath and File.Model = %s""" % (SourceFileFullPath
, MODEL_EFI_SOURCE_FILE
, MODEL_FILE_C
)
543 NewRecordSet
= Db
.Exec(SqlCommand
)
544 for NewRecord
in NewRecordSet
:
545 Table
= 'Identifier' + str(NewRecord
[0])
546 SqlCommand
= """select Value from %s where Name = '%s' and Modifier = 'EFI_PEI_PPI_DESCRIPTOR' and Model = %s""" % (Table
, Parameter
, MODEL_IDENTIFIER_VARIABLE
)
547 PpiSet
= Db
.Exec(SqlCommand
)
549 GuidName
= GetPpiParameter(PpiSet
[0][0])
551 Db
.Insert(-1, '', '', SourceFileID
, SourceFileFullPath
, ItemName
, ItemType
, ItemMode
, GuidName
, GuidMacro
, GuidValue
, BelongsToFunction
, 0)
556 EotGlobalData
.gOP_UN_MATCHED
.write('%s, %s, %s, %s, %s, %s\n' % (ItemType
, ItemMode
, SourceFileID
, SourceFileFullPath
, StartLine
, Parameter
))
558 ## SearchProtocols() method
560 # Search all used PROTOCOL calling function
561 # Store the result to database
563 # @param SqlCommand: SQL command statement
564 # @param Table: Table id
565 # @param SourceFileID: Source file id
566 # @param SourceFileFullPath: Source file full path
567 # @param ItemMode: Mode of the item
568 # @param ProtocolMode: Mode of PROTOCOL
570 def SearchProtocols(SqlCommand
, Table
, SourceFileID
, SourceFileFullPath
, ItemMode
, ProtocolMode
):
571 ItemName
, ItemType
, GuidName
, GuidMacro
, GuidValue
= '', 'Protocol', '', '', ''
572 BelongsToFunctionID
, BelongsToFunction
= -1, ''
573 Db
= EotGlobalData
.gDb
.TblReport
574 RecordSet
= Db
.Exec(SqlCommand
)
575 for Record
in RecordSet
:
577 BelongsToFile
, StartLine
, EndLine
= Record
[2], Record
[3], Record
[4]
578 # Get BelongsToFunction
579 BelongsToFunctionID
, BelongsToFunction
= SearchBelongsToFunction(BelongsToFile
, StartLine
, EndLine
)
581 # Default is Not Found
584 if ProtocolMode
== 0 or ProtocolMode
== 1:
585 Parameter
= GetProtocolParameter(Record
[0], ProtocolMode
)
586 if Parameter
.startswith('g') or Parameter
.endswith('Guid') or Parameter
== 'ShellEnvProtocol' or Parameter
== 'ShellInterfaceProtocol':
587 GuidName
= GetParameterName(Parameter
)
588 Db
.Insert(-1, '', '', SourceFileID
, SourceFileFullPath
, ItemName
, ItemType
, ItemMode
, GuidName
, GuidMacro
, GuidValue
, BelongsToFunction
, 0)
591 if ProtocolMode
== 2:
592 Protocols
= GetSplitValueList(Record
[0], TAB_COMMA_SPLIT
)
593 for Protocol
in Protocols
:
594 if Protocol
.startswith('&') and Protocol
.endswith('Guid'):
595 GuidName
= GetParameterName(Protocol
)
596 Db
.Insert(-1, '', '', SourceFileID
, SourceFileFullPath
, ItemName
, ItemType
, ItemMode
, GuidName
, GuidMacro
, GuidValue
, BelongsToFunction
, 0)
599 NewValue
= FindKeyValue(EotGlobalData
.gDb
.TblFile
, Table
, Protocol
)
600 if Protocol
!= NewValue
and NewValue
.endswith('Guid'):
601 GuidName
= GetParameterName(NewValue
)
602 Db
.Insert(-1, '', '', SourceFileID
, SourceFileFullPath
, ItemName
, ItemType
, ItemMode
, GuidName
, GuidMacro
, GuidValue
, BelongsToFunction
, 0)
606 if BelongsToFunction
in EotGlobalData
.gProducedProtocolLibrary
or BelongsToFunction
in EotGlobalData
.gConsumedProtocolLibrary
:
607 EotGlobalData
.gOP_UN_MATCHED_IN_LIBRARY_CALLING
.write('%s, %s, %s, %s, %s, %s, %s\n' % (ItemType
, ItemMode
, SourceFileID
, SourceFileFullPath
, StartLine
, Parameter
, BelongsToFunction
))
609 EotGlobalData
.gOP_UN_MATCHED
.write('%s, %s, %s, %s, %s, %s\n' % (ItemType
, ItemMode
, SourceFileID
, SourceFileFullPath
, StartLine
, Parameter
))
611 ## SearchFunctionCalling() method
613 # Search all used PPI/PROTOCOL calling function by library
614 # Store the result to database
616 # @param SqlCommand: SQL command statement
617 # @param Table: Table id
618 # @param SourceFileID: Source file id
619 # @param SourceFileFullPath: Source file full path
620 # @param ItemType: Type of the item, PPI or PROTOCOL
621 # @param ItemMode: Mode of item
623 def SearchFunctionCalling(Table
, SourceFileID
, SourceFileFullPath
, ItemType
, ItemMode
):
624 LibraryList
= sdict()
625 Db
= EotGlobalData
.gDb
.TblReport
626 Parameters
, ItemName
, GuidName
, GuidMacro
, GuidValue
, BelongsToFunction
= [], '', '', '', '', ''
627 if ItemType
== 'Protocol' and ItemMode
== 'Produced':
628 LibraryList
= EotGlobalData
.gProducedProtocolLibrary
629 elif ItemType
== 'Protocol' and ItemMode
== 'Consumed':
630 LibraryList
= EotGlobalData
.gConsumedProtocolLibrary
631 elif ItemType
== 'Protocol' and ItemMode
== 'Callback':
632 LibraryList
= EotGlobalData
.gCallbackProtocolLibrary
633 elif ItemType
== 'Ppi' and ItemMode
== 'Produced':
634 LibraryList
= EotGlobalData
.gProducedPpiLibrary
635 elif ItemType
== 'Ppi' and ItemMode
== 'Consumed':
636 LibraryList
= EotGlobalData
.gConsumedPpiLibrary
638 for Library
in LibraryList
:
639 Index
= LibraryList
[Library
]
640 SqlCommand
= """select Value, StartLine from %s
641 where Name like '%%%s%%' and Model = %s""" \
642 % (Table
, Library
, MODEL_IDENTIFIER_FUNCTION_CALLING
)
643 RecordSet
= Db
.Exec(SqlCommand
)
644 for Record
in RecordSet
:
647 ParameterList
= GetSplitValueList(Record
[0], TAB_COMMA_SPLIT
)
648 for Parameter
in ParameterList
:
649 Parameters
.append(GetParameterName(Parameter
))
651 Parameters
= [GetProtocolParameter(Record
[0], Index
)]
652 StartLine
= Record
[1]
653 for Parameter
in Parameters
:
654 if Parameter
.startswith('g') or Parameter
.endswith('Guid') or Parameter
== 'ShellEnvProtocol' or Parameter
== 'ShellInterfaceProtocol':
655 GuidName
= GetParameterName(Parameter
)
656 Db
.Insert(-1, '', '', SourceFileID
, SourceFileFullPath
, ItemName
, ItemType
, ItemMode
, GuidName
, GuidMacro
, GuidValue
, BelongsToFunction
, 0)
660 EotGlobalData
.gOP_UN_MATCHED
.write('%s, %s, %s, %s, %s, %s\n' % (ItemType
, ItemMode
, SourceFileID
, SourceFileFullPath
, StartLine
, Parameter
))
662 ## FindProtocols() method
664 # Find defined protocols
666 # @param SqlCommand: SQL command statement
667 # @param Table: Table id
668 # @param SourceFileID: Source file id
669 # @param SourceFileFullPath: Source file full path
670 # @param ItemName: String of protocol definition
671 # @param ItemType: Type of the item, PPI or PROTOCOL
672 # @param ItemMode: Mode of item
674 #def FindProtocols(Db, SqlCommand, Table, SourceFileID, SourceFileFullPath, ItemName, ItemType, ItemMode, GuidName, GuidMacro, GuidValue):
675 # BelongsToFunction = ''
676 # RecordSet = Db.Exec(SqlCommand)
677 # for Record in RecordSet:
679 # Parameter = GetProtocolParameter(Record[0])
681 ## GetProtocolParameter() method
683 # Parse string of protocol and find parameters
685 # @param Parameter: Parameter to be parsed
686 # @param Index: The index of the parameter
688 # @return: call common GetParameter
690 def GetProtocolParameter(Parameter
, Index
= 1):
691 return GetParameter(Parameter
, Index
)
693 ## GetPpiParameter() method
695 # Parse string of ppi and find parameters
697 # @param Parameter: Parameter to be parsed
698 # @param Index: The index of the parameter
700 # @return: call common GetParameter
702 def GetPpiParameter(Parameter
, Index
= 1):
703 return GetParameter(Parameter
, Index
)
705 ## GetParameter() method
707 # Get a parameter by index
709 # @param Parameter: Parameter to be parsed
710 # @param Index: The index of the parameter
712 # @return Parameter: The found parameter
714 def GetParameter(Parameter
, Index
= 1):
715 ParameterList
= GetSplitValueList(Parameter
, TAB_COMMA_SPLIT
)
716 if len(ParameterList
) > Index
:
717 Parameter
= GetParameterName(ParameterList
[Index
])
723 ## GetParameterName() method
725 # Get a parameter name
727 # @param Parameter: Parameter to be parsed
729 # @return: The name of parameter
731 def GetParameterName(Parameter
):
732 if type(Parameter
) == type('') and Parameter
.startswith('&'):
733 return Parameter
[1:].replace('{', '').replace('}', '').replace('\r', '').replace('\n', '').strip()
735 return Parameter
.strip()
737 ## FindKeyValue() method
739 # Find key value of a variable
741 # @param Db: Database to be searched
742 # @param Table: Table to be searched
743 # @param Key: The keyword
745 # @return Value: The value of the the keyword
747 def FindKeyValue(Db
, Table
, Key
):
748 SqlCommand
= """select Value from %s where Name = '%s' and (Model = %s or Model = %s)""" % (Table
, Key
, MODEL_IDENTIFIER_VARIABLE
, MODEL_IDENTIFIER_ASSIGNMENT_EXPRESSION
)
749 RecordSet
= Db
.Exec(SqlCommand
)
751 for Record
in RecordSet
:
752 if Record
[0] != 'NULL':
753 Value
= FindKeyValue(Db
, Table
, GetParameterName(Record
[0]))
760 ## ParseMapFile() method
762 # Parse map files to get a dict of 'ModuleName' : {FunName : FunAddress}
764 # @param Files: A list of map files
766 # @return AllMaps: An object of all map files
768 def ParseMapFile(Files
):
773 Content
= open(File
, 'r').readlines()
775 Line
= CleanString(Line
)
780 if Line
.find('(') > -1 and Line
.find(')') > -1:
781 if CurrentModule
!= '' and CurrentMaps
!= {}:
782 AllMaps
[CurrentModule
] = CurrentMaps
783 CurrentModule
= Line
[:Line
.find('(')]
791 if List
[1] == 'F' or List
[1] == 'FS':
795 CurrentMaps
[Name
] = Address
802 # Convert a GUID to a GUID with all upper letters
804 # @param guid: The GUID to be converted
806 # @param newGuid: The GUID with all upper letters.
808 def ConvertGuid(guid
):
809 numList
= ['0', '1', '2', '3', '4', '5', '6', '7', '8', '9']
811 if guid
.startswith('g'):
814 if i
.upper() == i
and i
not in numList
:
815 newGuid
= newGuid
+ ('_' + i
)
817 newGuid
= newGuid
+ i
.upper()
818 if newGuid
.startswith('_'):
819 newGuid
= newGuid
[1:]
820 if newGuid
.endswith('_'):
821 newGuid
= newGuid
[:-1]
825 ## ConvertGuid2() method
827 # Convert a GUID to a GUID with new string instead of old string
829 # @param guid: The GUID to be converted
830 # @param old: Old string to be replaced
831 # @param new: New string to replace the old one
833 # @param newGuid: The GUID after replacement
835 def ConvertGuid2(guid
, old
, new
):
836 newGuid
= ConvertGuid(guid
)
837 newGuid
= newGuid
.replace(old
, new
)
843 # This acts like the main() function for the script, unless it is 'import'ed into another
846 if __name__
== '__main__':