Enhance ECC tools:
[efi/basetools/.git] / Source / Python / Ecc / Check.py
1 ## @file\r
2 # This file is used to define checkpoints used by ECC tool\r
3 #\r
4 # Copyright (c) 2008 - 2010, Intel Corporation\r
5 # All rights reserved. This program and the accompanying materials\r
6 # are licensed and made available under the terms and conditions of the BSD License\r
7 # which accompanies this distribution.  The full text of the license may be found at\r
8 # http://opensource.org/licenses/bsd-license.php\r
9 #\r
10 # THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
11 # WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
12 #\r
13 import os\r
14 import re\r
15 from CommonDataClass.DataClass import *\r
16 from Common.DataType import SUP_MODULE_LIST_STRING, TAB_VALUE_SPLIT\r
17 from EccToolError import *\r
18 import EccGlobalData\r
19 import c\r
20 \r
21 ## Check\r
22 #\r
23 # This class is to define checkpoints used by ECC tool\r
24 #\r
25 # @param object:          Inherited from object class\r
26 #\r
27 class Check(object):\r
28     def __init__(self):\r
29         pass\r
30 \r
31     # Check all required checkpoints\r
32     def Check(self):\r
33         self.MetaDataFileCheck()\r
34         self.DoxygenCheck()\r
35         self.IncludeFileCheck()\r
36         self.PredicateExpressionCheck()\r
37         self.DeclAndDataTypeCheck()\r
38         self.FunctionLayoutCheck()\r
39         self.NamingConventionCheck()\r
40 \r
41     # C Function Layout Checking\r
42     def FunctionLayoutCheck(self):\r
43         self.FunctionLayoutCheckReturnType()\r
44         self.FunctionLayoutCheckModifier()\r
45         self.FunctionLayoutCheckName()\r
46         self.FunctionLayoutCheckPrototype()\r
47         self.FunctionLayoutCheckBody()\r
48         self.FunctionLayoutCheckLocalVariable()\r
49 \r
50     def WalkTree(self):\r
51         IgnoredPattern = c.GetIgnoredDirListPattern()\r
52         for Dirpath, Dirnames, Filenames in os.walk(EccGlobalData.gTarget):\r
53             for Dir in Dirnames:\r
54                 Dirname = os.path.join(Dirpath, Dir)\r
55                 if os.path.islink(Dirname):\r
56                     Dirname = os.path.realpath(Dirname)\r
57                     if os.path.isdir(Dirname):\r
58                         # symlinks to directories are treated as directories\r
59                         Dirnames.remove(Dir)\r
60                         Dirnames.append(Dirname)\r
61             if IgnoredPattern.match(Dirpath.upper()):\r
62                 continue\r
63             yield (Dirpath, Dirnames, Filenames)\r
64 \r
65     # Check whether return type exists and in the first line\r
66     def FunctionLayoutCheckReturnType(self):\r
67         if EccGlobalData.gConfig.CFunctionLayoutCheckReturnType == '1' or EccGlobalData.gConfig.CFunctionLayoutCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
68             EdkLogger.quiet("Checking function layout return type ...")\r
69 \r
70             for Dirpath, Dirnames, Filenames in self.WalkTree():\r
71                 for F in Filenames:\r
72                     if os.path.splitext(F)[1] in ('.c', '.h'):\r
73                         FullName = os.path.join(Dirpath, F)\r
74                         c.CheckFuncLayoutReturnType(FullName)\r
75 \r
76     # Check whether any optional functional modifiers exist and next to the return type\r
77     def FunctionLayoutCheckModifier(self):\r
78         if EccGlobalData.gConfig.CFunctionLayoutCheckOptionalFunctionalModifier == '1' or EccGlobalData.gConfig.CFunctionLayoutCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
79             EdkLogger.quiet("Checking function layout modifier ...")\r
80 \r
81             for Dirpath, Dirnames, Filenames in self.WalkTree():\r
82                 for F in Filenames:\r
83                     if os.path.splitext(F)[1] in ('.c', '.h'):\r
84                         FullName = os.path.join(Dirpath, F)\r
85                         c.CheckFuncLayoutModifier(FullName)\r
86 \r
87     # Check whether the next line contains the function name, left justified, followed by the beginning of the parameter list\r
88     # Check whether the closing parenthesis is on its own line and also indented two spaces\r
89     def FunctionLayoutCheckName(self):\r
90         if EccGlobalData.gConfig.CFunctionLayoutCheckFunctionName == '1' or EccGlobalData.gConfig.CFunctionLayoutCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
91             EdkLogger.quiet("Checking function layout function name ...")\r
92 \r
93             for Dirpath, Dirnames, Filenames in self.WalkTree():\r
94                 for F in Filenames:\r
95                     if os.path.splitext(F)[1] in ('.c', '.h'):\r
96                         FullName = os.path.join(Dirpath, F)\r
97                         c.CheckFuncLayoutName(FullName)\r
98     # Check whether the function prototypes in include files have the same form as function definitions\r
99     def FunctionLayoutCheckPrototype(self):\r
100         if EccGlobalData.gConfig.CFunctionLayoutCheckFunctionPrototype == '1' or EccGlobalData.gConfig.CFunctionLayoutCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
101             EdkLogger.quiet("Checking function layout function prototype ...")\r
102 \r
103             for Dirpath, Dirnames, Filenames in self.WalkTree():\r
104                 for F in Filenames:\r
105                     if os.path.splitext(F)[1] in ('.c'):\r
106                         FullName = os.path.join(Dirpath, F)\r
107                         EdkLogger.quiet("[PROTOTYPE]" + FullName)\r
108                         c.CheckFuncLayoutPrototype(FullName)\r
109 \r
110     # Check whether the body of a function is contained by open and close braces that must be in the first column\r
111     def FunctionLayoutCheckBody(self):\r
112         if EccGlobalData.gConfig.CFunctionLayoutCheckFunctionBody == '1' or EccGlobalData.gConfig.CFunctionLayoutCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
113             EdkLogger.quiet("Checking function layout function body ...")\r
114 \r
115             for Dirpath, Dirnames, Filenames in self.WalkTree():\r
116                 for F in Filenames:\r
117                     if os.path.splitext(F)[1] in ('.c'):\r
118                         FullName = os.path.join(Dirpath, F)\r
119                         c.CheckFuncLayoutBody(FullName)\r
120 \r
121     # Check whether the data declarations is the first code in a module.\r
122     # self.CFunctionLayoutCheckDataDeclaration = 1\r
123     # Check whether no initialization of a variable as part of its declaration\r
124     def FunctionLayoutCheckLocalVariable(self):\r
125         if EccGlobalData.gConfig.CFunctionLayoutCheckNoInitOfVariable == '1' or EccGlobalData.gConfig.CFunctionLayoutCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
126             EdkLogger.quiet("Checking function layout local variables ...")\r
127 \r
128             for Dirpath, Dirnames, Filenames in self.WalkTree():\r
129                 for F in Filenames:\r
130                     if os.path.splitext(F)[1] in ('.c'):\r
131                         FullName = os.path.join(Dirpath, F)\r
132                         c.CheckFuncLayoutLocalVariable(FullName)\r
133 \r
134     # Check whether no use of STATIC for functions\r
135     # self.CFunctionLayoutCheckNoStatic = 1\r
136 \r
137     # Declarations and Data Types Checking\r
138     def DeclAndDataTypeCheck(self):\r
139         self.DeclCheckNoUseCType()\r
140         self.DeclCheckInOutModifier()\r
141         self.DeclCheckEFIAPIModifier()\r
142         self.DeclCheckEnumeratedType()\r
143         self.DeclCheckStructureDeclaration()\r
144         self.DeclCheckSameStructure()\r
145         self.DeclCheckUnionType()\r
146 \r
147 \r
148     # Check whether no use of int, unsigned, char, void, static, long in any .c, .h or .asl files.\r
149     def DeclCheckNoUseCType(self):\r
150         if EccGlobalData.gConfig.DeclarationDataTypeCheckNoUseCType == '1' or EccGlobalData.gConfig.DeclarationDataTypeCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
151             EdkLogger.quiet("Checking Declaration No use C type ...")\r
152 \r
153             for Dirpath, Dirnames, Filenames in self.WalkTree():\r
154                 for F in Filenames:\r
155                     if os.path.splitext(F)[1] in ('.h', '.c'):\r
156                         FullName = os.path.join(Dirpath, F)\r
157                         c.CheckDeclNoUseCType(FullName)\r
158 \r
159     # Check whether the modifiers IN, OUT, OPTIONAL, and UNALIGNED are used only to qualify arguments to a function and should not appear in a data type declaration\r
160     def DeclCheckInOutModifier(self):\r
161         if EccGlobalData.gConfig.DeclarationDataTypeCheckInOutModifier == '1' or EccGlobalData.gConfig.DeclarationDataTypeCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
162             EdkLogger.quiet("Checking Declaration argument modifier ...")\r
163 \r
164             for Dirpath, Dirnames, Filenames in self.WalkTree():\r
165                 for F in Filenames:\r
166                     if os.path.splitext(F)[1] in ('.h', '.c'):\r
167                         FullName = os.path.join(Dirpath, F)\r
168                         c.CheckDeclArgModifier(FullName)\r
169 \r
170     # Check whether the EFIAPI modifier should be used at the entry of drivers, events, and member functions of protocols\r
171     def DeclCheckEFIAPIModifier(self):\r
172         if EccGlobalData.gConfig.DeclarationDataTypeCheckEFIAPIModifier == '1' or EccGlobalData.gConfig.DeclarationDataTypeCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
173             pass\r
174 \r
175     # Check whether Enumerated Type has a 'typedef' and the name is capital\r
176     def DeclCheckEnumeratedType(self):\r
177         if EccGlobalData.gConfig.DeclarationDataTypeCheckEnumeratedType == '1' or EccGlobalData.gConfig.DeclarationDataTypeCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
178             EdkLogger.quiet("Checking Declaration enum typedef ...")\r
179 \r
180             for Dirpath, Dirnames, Filenames in self.WalkTree():\r
181                 for F in Filenames:\r
182                     if os.path.splitext(F)[1] in ('.h', '.c'):\r
183                         FullName = os.path.join(Dirpath, F)\r
184                         EdkLogger.quiet("[ENUM]" + FullName)\r
185                         c.CheckDeclEnumTypedef(FullName)\r
186 \r
187     # Check whether Structure Type has a 'typedef' and the name is capital\r
188     def DeclCheckStructureDeclaration(self):\r
189         if EccGlobalData.gConfig.DeclarationDataTypeCheckStructureDeclaration == '1' or EccGlobalData.gConfig.DeclarationDataTypeCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
190             EdkLogger.quiet("Checking Declaration struct typedef ...")\r
191 \r
192             for Dirpath, Dirnames, Filenames in self.WalkTree():\r
193                 for F in Filenames:\r
194                     if os.path.splitext(F)[1] in ('.h', '.c'):\r
195                         FullName = os.path.join(Dirpath, F)\r
196                         EdkLogger.quiet("[STRUCT]" + FullName)\r
197                         c.CheckDeclStructTypedef(FullName)\r
198 \r
199     # Check whether having same Structure\r
200     def DeclCheckSameStructure(self):\r
201         if EccGlobalData.gConfig.DeclarationDataTypeCheckSameStructure == '1' or EccGlobalData.gConfig.DeclarationDataTypeCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
202             EdkLogger.quiet("Checking same struct ...")\r
203             AllStructure = {}\r
204             for IdentifierTable in EccGlobalData.gIdentifierTableList:\r
205                 SqlCommand = """select ID, Name, BelongsToFile from %s where Model = %s""" %(IdentifierTable, MODEL_IDENTIFIER_STRUCTURE)\r
206                 RecordSet = EccGlobalData.gDb.TblFile.Exec(SqlCommand)\r
207                 for Record in RecordSet:\r
208                     if Record[1] != '':\r
209                         if Record[1] not in AllStructure.keys():\r
210                             AllStructure[Record[1]] = Record[2]\r
211                         else:\r
212                             ID = AllStructure[Record[1]]\r
213                             SqlCommand = """select FullPath from File where ID = %s """ % ID\r
214                             NewRecordSet = EccGlobalData.gDb.TblFile.Exec(SqlCommand)\r
215                             OtherMsg = "The structure name '%s' is duplicate" % Record[1]\r
216                             if NewRecordSet != []:\r
217                                 OtherMsg = "The structure name [%s] is duplicate with the one defined in %s, maybe struct NOT typedefed or the typedef new type NOT used to qualify variables" % (Record[1], NewRecordSet[0][0])\r
218                             if not EccGlobalData.gException.IsException(ERROR_DECLARATION_DATA_TYPE_CHECK_SAME_STRUCTURE, Record[1]):\r
219                                 EccGlobalData.gDb.TblReport.Insert(ERROR_DECLARATION_DATA_TYPE_CHECK_SAME_STRUCTURE, OtherMsg = OtherMsg, BelongsToTable = IdentifierTable, BelongsToItem = Record[0])\r
220 \r
221     # Check whether Union Type has a 'typedef' and the name is capital\r
222     def DeclCheckUnionType(self):\r
223         if EccGlobalData.gConfig.DeclarationDataTypeCheckUnionType == '1' or EccGlobalData.gConfig.DeclarationDataTypeCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
224             EdkLogger.quiet("Checking Declaration union typedef ...")\r
225 \r
226             for Dirpath, Dirnames, Filenames in self.WalkTree():\r
227                 for F in Filenames:\r
228                     if os.path.splitext(F)[1] in ('.h', '.c'):\r
229                         FullName = os.path.join(Dirpath, F)\r
230                         EdkLogger.quiet("[UNION]" + FullName)\r
231                         c.CheckDeclUnionTypedef(FullName)\r
232 \r
233     # Predicate Expression Checking\r
234     def PredicateExpressionCheck(self):\r
235         self.PredicateExpressionCheckBooleanValue()\r
236         self.PredicateExpressionCheckNonBooleanOperator()\r
237         self.PredicateExpressionCheckComparisonNullType()\r
238 \r
239     # Check whether Boolean values, variable type BOOLEAN not use explicit comparisons to TRUE or FALSE\r
240     def PredicateExpressionCheckBooleanValue(self):\r
241         if EccGlobalData.gConfig.PredicateExpressionCheckBooleanValue == '1' or EccGlobalData.gConfig.PredicateExpressionCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
242             EdkLogger.quiet("Checking predicate expression Boolean value ...")\r
243 \r
244             for Dirpath, Dirnames, Filenames in self.WalkTree():\r
245                 for F in Filenames:\r
246                     if os.path.splitext(F)[1] in ('.c'):\r
247                         FullName = os.path.join(Dirpath, F)\r
248                         EdkLogger.quiet("[BOOLEAN]" + FullName)\r
249                         c.CheckBooleanValueComparison(FullName)\r
250 \r
251     # Check whether Non-Boolean comparisons use a compare operator (==, !=, >, < >=, <=).\r
252     def PredicateExpressionCheckNonBooleanOperator(self):\r
253         if EccGlobalData.gConfig.PredicateExpressionCheckNonBooleanOperator == '1' or EccGlobalData.gConfig.PredicateExpressionCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
254             EdkLogger.quiet("Checking predicate expression Non-Boolean variable...")\r
255 \r
256             for Dirpath, Dirnames, Filenames in self.WalkTree():\r
257                 for F in Filenames:\r
258                     if os.path.splitext(F)[1] in ('.c'):\r
259                         FullName = os.path.join(Dirpath, F)\r
260                         EdkLogger.quiet("[NON-BOOLEAN]" + FullName)\r
261                         c.CheckNonBooleanValueComparison(FullName)\r
262     # Check whether a comparison of any pointer to zero must be done via the NULL type\r
263     def PredicateExpressionCheckComparisonNullType(self):\r
264         if EccGlobalData.gConfig.PredicateExpressionCheckComparisonNullType == '1' or EccGlobalData.gConfig.PredicateExpressionCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
265             EdkLogger.quiet("Checking predicate expression NULL pointer ...")\r
266 \r
267             for Dirpath, Dirnames, Filenames in self.WalkTree():\r
268                 for F in Filenames:\r
269                     if os.path.splitext(F)[1] in ('.c'):\r
270                         FullName = os.path.join(Dirpath, F)\r
271                         EdkLogger.quiet("[POINTER]" + FullName)\r
272                         c.CheckPointerNullComparison(FullName)\r
273     # Include file checking\r
274     def IncludeFileCheck(self):\r
275         self.IncludeFileCheckIfndef()\r
276         self.IncludeFileCheckData()\r
277         self.IncludeFileCheckSameName()\r
278 \r
279     # Check whether having include files with same name\r
280     def IncludeFileCheckSameName(self):\r
281         if EccGlobalData.gConfig.IncludeFileCheckSameName == '1' or EccGlobalData.gConfig.IncludeFileCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
282             EdkLogger.quiet("Checking same header file name ...")\r
283             SqlCommand = """select ID, FullPath from File\r
284                             where Model = 1002 order by Name """\r
285             RecordDict = {}\r
286             RecordSet = EccGlobalData.gDb.TblFile.Exec(SqlCommand)\r
287             for Record in RecordSet:\r
288                 List = Record[1].replace('/', '\\').split('\\')\r
289                 if len(List) >= 2:\r
290                     Key = List[-2] + '\\' + List[-1]\r
291                 else:\r
292                     Key = List[0]\r
293                 if Key not in RecordDict:\r
294                     RecordDict[Key] = [Record]\r
295                 else:\r
296                     RecordDict[Key].append(Record)\r
297 \r
298             for Key in RecordDict:\r
299                 if len(RecordDict[Key]) > 1:\r
300                     for Item in RecordDict[Key]:\r
301                         if not EccGlobalData.gException.IsException(ERROR_INCLUDE_FILE_CHECK_NAME, Item[1]):\r
302                             EccGlobalData.gDb.TblReport.Insert(ERROR_INCLUDE_FILE_CHECK_NAME, OtherMsg = "The file name for [%s] is duplicate" % (Item[1]), BelongsToTable = 'File', BelongsToItem = Item[0])\r
303 \r
304     # Check whether all include file contents is guarded by a #ifndef statement.\r
305     def IncludeFileCheckIfndef(self):\r
306         if EccGlobalData.gConfig.IncludeFileCheckIfndefStatement == '1' or EccGlobalData.gConfig.IncludeFileCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
307             EdkLogger.quiet("Checking header file ifndef ...")\r
308 \r
309             for Dirpath, Dirnames, Filenames in self.WalkTree():\r
310                 for F in Filenames:\r
311                     if os.path.splitext(F)[1] in ('.h'):\r
312                         FullName = os.path.join(Dirpath, F)\r
313                         MsgList = c.CheckHeaderFileIfndef(FullName)\r
314 \r
315     # Check whether include files NOT contain code or define data variables\r
316     def IncludeFileCheckData(self):\r
317         if EccGlobalData.gConfig.IncludeFileCheckData == '1' or EccGlobalData.gConfig.IncludeFileCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
318             EdkLogger.quiet("Checking header file data ...")\r
319 \r
320             for Dirpath, Dirnames, Filenames in self.WalkTree():\r
321                 for F in Filenames:\r
322                     if os.path.splitext(F)[1] in ('.h'):\r
323                         FullName = os.path.join(Dirpath, F)\r
324                         MsgList = c.CheckHeaderFileData(FullName)\r
325 \r
326     # Doxygen document checking\r
327     def DoxygenCheck(self):\r
328         self.DoxygenCheckFileHeader()\r
329         self.DoxygenCheckFunctionHeader()\r
330         self.DoxygenCheckCommentDescription()\r
331         self.DoxygenCheckCommentFormat()\r
332         self.DoxygenCheckCommand()\r
333 \r
334     # Check whether the file headers are followed Doxygen special documentation blocks in section 2.3.5\r
335     def DoxygenCheckFileHeader(self):\r
336         if EccGlobalData.gConfig.DoxygenCheckFileHeader == '1' or EccGlobalData.gConfig.DoxygenCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
337             EdkLogger.quiet("Checking Doxygen file header ...")\r
338 \r
339             for Dirpath, Dirnames, Filenames in self.WalkTree():\r
340                 for F in Filenames:\r
341                     if os.path.splitext(F)[1] in ('.h', '.c'):\r
342                         FullName = os.path.join(Dirpath, F)\r
343                         MsgList = c.CheckFileHeaderDoxygenComments(FullName)\r
344 \r
345     # Check whether the function headers are followed Doxygen special documentation blocks in section 2.3.5\r
346     def DoxygenCheckFunctionHeader(self):\r
347         if EccGlobalData.gConfig.DoxygenCheckFunctionHeader == '1' or EccGlobalData.gConfig.DoxygenCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
348             EdkLogger.quiet("Checking Doxygen function header ...")\r
349 \r
350             for Dirpath, Dirnames, Filenames in self.WalkTree():\r
351                 for F in Filenames:\r
352                     if os.path.splitext(F)[1] in ('.h', '.c'):\r
353                         FullName = os.path.join(Dirpath, F)\r
354                         MsgList = c.CheckFuncHeaderDoxygenComments(FullName)\r
355 \r
356     # Check whether the first line of text in a comment block is a brief description of the element being documented.\r
357     # The brief description must end with a period.\r
358     def DoxygenCheckCommentDescription(self):\r
359         if EccGlobalData.gConfig.DoxygenCheckCommentDescription == '1' or EccGlobalData.gConfig.DoxygenCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
360             pass\r
361 \r
362     # Check whether comment lines with '///< ... text ...' format, if it is used, it should be after the code section.\r
363     def DoxygenCheckCommentFormat(self):\r
364         if EccGlobalData.gConfig.DoxygenCheckCommentFormat == '1' or EccGlobalData.gConfig.DoxygenCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
365             EdkLogger.quiet("Checking Doxygen comment ///< ...")\r
366 \r
367             for Dirpath, Dirnames, Filenames in self.WalkTree():\r
368                 for F in Filenames:\r
369                     if os.path.splitext(F)[1] in ('.h', '.c'):\r
370                         FullName = os.path.join(Dirpath, F)\r
371                         MsgList = c.CheckDoxygenTripleForwardSlash(FullName)\r
372 \r
373     # Check whether only Doxygen commands allowed to mark the code are @bug and @todo.\r
374     def DoxygenCheckCommand(self):\r
375         if EccGlobalData.gConfig.DoxygenCheckCommand == '1' or EccGlobalData.gConfig.DoxygenCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
376             EdkLogger.quiet("Checking Doxygen command ...")\r
377 \r
378             for Dirpath, Dirnames, Filenames in self.WalkTree():\r
379                 for F in Filenames:\r
380                     if os.path.splitext(F)[1] in ('.h', '.c'):\r
381                         FullName = os.path.join(Dirpath, F)\r
382                         MsgList = c.CheckDoxygenCommand(FullName)\r
383 \r
384     # Meta-Data File Processing Checking\r
385     def MetaDataFileCheck(self):\r
386         self.MetaDataFileCheckPathName()\r
387         self.MetaDataFileCheckGenerateFileList()\r
388         self.MetaDataFileCheckLibraryInstance()\r
389         self.MetaDataFileCheckLibraryInstanceDependent()\r
390         self.MetaDataFileCheckLibraryInstanceOrder()\r
391         self.MetaDataFileCheckLibraryNoUse()\r
392         self.MetaDataFileCheckBinaryInfInFdf()\r
393         self.MetaDataFileCheckPcdDuplicate()\r
394         self.MetaDataFileCheckPcdFlash()\r
395         self.MetaDataFileCheckPcdNoUse()\r
396         self.MetaDataFileCheckGuidDuplicate()\r
397         self.MetaDataFileCheckModuleFileNoUse()\r
398         self.MetaDataFileCheckPcdType()\r
399 \r
400     # Check whether each file defined in meta-data exists\r
401     def MetaDataFileCheckPathName(self):\r
402         if EccGlobalData.gConfig.MetaDataFileCheckPathName == '1' or EccGlobalData.gConfig.MetaDataFileCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
403             # This item is covered when parsing Inf/Dec/Dsc files\r
404             pass\r
405 \r
406     # Generate a list for all files defined in meta-data files\r
407     def MetaDataFileCheckGenerateFileList(self):\r
408         if EccGlobalData.gConfig.MetaDataFileCheckGenerateFileList == '1' or EccGlobalData.gConfig.MetaDataFileCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
409             # This item is covered when parsing Inf/Dec/Dsc files\r
410             pass\r
411 \r
412     # Check whether all Library Instances defined for a given module (or dependent library instance) match the module's type.\r
413     # Each Library Instance must specify the Supported Module Types in its Inf file,\r
414     # and any module specifying the library instance must be one of the supported types.\r
415     def MetaDataFileCheckLibraryInstance(self):\r
416         if EccGlobalData.gConfig.MetaDataFileCheckLibraryInstance == '1' or EccGlobalData.gConfig.MetaDataFileCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
417             EdkLogger.quiet("Checking for library instance type issue ...")\r
418             SqlCommand = """select A.ID, A.Value2, B.Value2 from Inf as A left join Inf as B\r
419                             where A.Value1 = 'LIBRARY_CLASS' and A.Model = %s\r
420                             and B.Value1 = 'MODULE_TYPE' and B.Model = %s and A.BelongsToFile = B.BelongsToFile\r
421                             group by A.BelongsToFile""" % (MODEL_META_DATA_HEADER, MODEL_META_DATA_HEADER)\r
422             RecordSet = EccGlobalData.gDb.TblInf.Exec(SqlCommand)\r
423             LibraryClasses = {}\r
424             for Record in RecordSet:\r
425                 List = Record[1].split('|', 1)\r
426                 SupModType = []\r
427                 if len(List) == 1:\r
428                     SupModType = SUP_MODULE_LIST_STRING.split(TAB_VALUE_SPLIT)\r
429                 elif len(List) == 2:\r
430                     SupModType = List[1].split()\r
431 \r
432                 if List[0] not in LibraryClasses:\r
433                     LibraryClasses[List[0]] = SupModType\r
434                 else:\r
435                     for Item in SupModType:\r
436                         if Item not in LibraryClasses[List[0]]:\r
437                             LibraryClasses[List[0]].append(Item)\r
438 \r
439                 if Record[2] != 'BASE' and Record[2] not in SupModType:\r
440                     EccGlobalData.gDb.TblReport.Insert(ERROR_META_DATA_FILE_CHECK_LIBRARY_INSTANCE_2, OtherMsg = "The Library Class '%s' does not specify its supported module types" % (List[0]), BelongsToTable = 'Inf', BelongsToItem = Record[0])\r
441 \r
442             SqlCommand = """select A.ID, A.Value1, B.Value2 from Inf as A left join Inf as B\r
443                             where A.Model = %s and B.Value1 = '%s' and B.Model = %s\r
444                             and B.BelongsToFile = A.BelongsToFile""" \\r
445                             % (MODEL_EFI_LIBRARY_CLASS, 'MODULE_TYPE', MODEL_META_DATA_HEADER)\r
446             RecordSet = EccGlobalData.gDb.TblInf.Exec(SqlCommand)\r
447             # Merge all LibraryClasses' supmodlist\r
448             RecordDict = {}\r
449             for Record in RecordSet:\r
450                 if Record[1] not in RecordDict:\r
451                     RecordDict[Record[1]] = [str(Record[2])]\r
452                 else:\r
453                     if Record[2] not in RecordDict[Record[1]]:\r
454                         RecordDict[Record[1]].append(Record[2])\r
455 \r
456             for Record in RecordSet:\r
457                 if Record[1] in LibraryClasses:\r
458                     if Record[2] not in LibraryClasses[Record[1]] and 'BASE' not in RecordDict[Record[1]]:\r
459                         if not EccGlobalData.gException.IsException(ERROR_META_DATA_FILE_CHECK_LIBRARY_INSTANCE_1, Record[1]):\r
460                             EccGlobalData.gDb.TblReport.Insert(ERROR_META_DATA_FILE_CHECK_LIBRARY_INSTANCE_1, OtherMsg = "The type of Library Class [%s] defined in Inf file does not match the type of the module" % (Record[1]), BelongsToTable = 'Inf', BelongsToItem = Record[0])\r
461                 else:\r
462                     if not EccGlobalData.gException.IsException(ERROR_META_DATA_FILE_CHECK_LIBRARY_INSTANCE_1, Record[1]):\r
463                         EccGlobalData.gDb.TblReport.Insert(ERROR_META_DATA_FILE_CHECK_LIBRARY_INSTANCE_1, OtherMsg = "The type of Library Class [%s] defined in Inf file does not match the type of the module" % (Record[1]), BelongsToTable = 'Inf', BelongsToItem = Record[0])\r
464 \r
465     # Check whether a Library Instance has been defined for all dependent library classes\r
466     def MetaDataFileCheckLibraryInstanceDependent(self):\r
467         if EccGlobalData.gConfig.MetaDataFileCheckLibraryInstanceDependent == '1' or EccGlobalData.gConfig.MetaDataFileCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
468             EdkLogger.quiet("Checking for library instance dependent issue ...")\r
469             SqlCommand = """select ID, Value1, Value2 from Dsc where Model = %s""" % MODEL_EFI_LIBRARY_CLASS\r
470             LibraryClasses = EccGlobalData.gDb.TblDsc.Exec(SqlCommand)\r
471             for LibraryClass in LibraryClasses:\r
472                 if LibraryClass[1].upper() != 'NULL':\r
473                     LibraryIns = os.path.normpath(os.path.join(EccGlobalData.gWorkspace, LibraryClass[2]))\r
474                     SqlCommand = """select Value2 from Inf where BelongsToFile =\r
475                                     (select ID from File where lower(FullPath) = lower('%s'))\r
476                                     and Value1 = '%s'""" % (LibraryIns, 'LIBRARY_CLASS')\r
477                     RecordSet = EccGlobalData.gDb.TblInf.Exec(SqlCommand)\r
478                     IsFound = False\r
479                     for Record in RecordSet:\r
480                         LibName = Record[0].split('|', 1)[0]\r
481                         if LibraryClass[1] == LibName:\r
482                             IsFound = True\r
483                     if not IsFound:\r
484                         if not EccGlobalData.gException.IsException(ERROR_META_DATA_FILE_CHECK_LIBRARY_INSTANCE_DEPENDENT, LibraryClass[1]):\r
485                             EccGlobalData.gDb.TblReport.Insert(ERROR_META_DATA_FILE_CHECK_LIBRARY_INSTANCE_DEPENDENT, OtherMsg = "The Library Class [%s] is not specified in '%s'" % (LibraryClass[1], LibraryClass[2]), BelongsToTable = 'Dsc', BelongsToItem = LibraryClass[0])\r
486 \r
487     # Check whether the Library Instances specified by the LibraryClasses sections are listed in order of dependencies\r
488     def MetaDataFileCheckLibraryInstanceOrder(self):\r
489         if EccGlobalData.gConfig.MetaDataFileCheckLibraryInstanceOrder == '1' or EccGlobalData.gConfig.MetaDataFileCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
490             # This checkpoint is not necessary for Ecc check\r
491             pass\r
492 \r
493     # Check whether the unnecessary inclusion of library classes in the Inf file\r
494     def MetaDataFileCheckLibraryNoUse(self):\r
495         if EccGlobalData.gConfig.MetaDataFileCheckLibraryNoUse == '1' or EccGlobalData.gConfig.MetaDataFileCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
496             EdkLogger.quiet("Checking for library instance not used ...")\r
497             SqlCommand = """select ID, Value1 from Inf as A where A.Model = %s and A.Value1 not in (select B.Value1 from Dsc as B where Model = %s)""" % (MODEL_EFI_LIBRARY_CLASS, MODEL_EFI_LIBRARY_CLASS)\r
498             RecordSet = EccGlobalData.gDb.TblInf.Exec(SqlCommand)\r
499             for Record in RecordSet:\r
500                 if not EccGlobalData.gException.IsException(ERROR_META_DATA_FILE_CHECK_LIBRARY_NO_USE, Record[1]):\r
501                     EccGlobalData.gDb.TblReport.Insert(ERROR_META_DATA_FILE_CHECK_LIBRARY_NO_USE, OtherMsg = "The Library Class [%s] is not used in any platform" % (Record[1]), BelongsToTable = 'Inf', BelongsToItem = Record[0])\r
502 \r
503     # Check whether an Inf file is specified in the FDF file, but not in the Dsc file, then the Inf file must be for a Binary module only\r
504     def MetaDataFileCheckBinaryInfInFdf(self):\r
505         if EccGlobalData.gConfig.MetaDataFileCheckBinaryInfInFdf == '1' or EccGlobalData.gConfig.MetaDataFileCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
506             EdkLogger.quiet("Checking for non-binary modules defined in FDF files ...")\r
507             SqlCommand = """select A.ID, A.Value1 from Fdf as A\r
508                          where A.Model = %s\r
509                          and A.Enabled > -1\r
510                          and A.Value1 not in\r
511                          (select B.Value1 from Dsc as B\r
512                          where B.Model = %s\r
513                          and B.Enabled > -1)""" % (MODEL_META_DATA_COMPONENT, MODEL_META_DATA_COMPONENT)\r
514             RecordSet = EccGlobalData.gDb.TblFdf.Exec(SqlCommand)\r
515             for Record in RecordSet:\r
516                 FdfID = Record[0]\r
517                 FilePath = Record[1]\r
518                 FilePath = os.path.normpath(os.path.join(EccGlobalData.gWorkspace, FilePath))\r
519                 SqlCommand = """select ID from Inf where Model = %s and BelongsToFile = (select ID from File where FullPath like '%s')\r
520                                 """ % (MODEL_EFI_SOURCE_FILE, FilePath)\r
521                 NewRecordSet = EccGlobalData.gDb.TblFile.Exec(SqlCommand)\r
522                 if NewRecordSet!= []:\r
523                     if not EccGlobalData.gException.IsException(ERROR_META_DATA_FILE_CHECK_BINARY_INF_IN_FDF, FilePath):\r
524                         EccGlobalData.gDb.TblReport.Insert(ERROR_META_DATA_FILE_CHECK_BINARY_INF_IN_FDF, OtherMsg = "File [%s] defined in FDF file and not in DSC file must be a binary module" % (FilePath), BelongsToTable = 'Fdf', BelongsToItem = FdfID)\r
525 \r
526     # Check whether a PCD is set in a Dsc file or the FDF file, but not in both.\r
527     def MetaDataFileCheckPcdDuplicate(self):\r
528         if EccGlobalData.gConfig.MetaDataFileCheckPcdDuplicate == '1' or EccGlobalData.gConfig.MetaDataFileCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
529             EdkLogger.quiet("Checking for duplicate PCDs defined in both DSC and FDF files ...")\r
530             SqlCommand = """\r
531                          select A.ID, A.Value2, B.ID, B.Value2 from Dsc as A, Fdf as B\r
532                          where A.Model >= %s and A.Model < %s\r
533                          and B.Model >= %s and B.Model < %s\r
534                          and A.Value2 = B.Value2\r
535                          and A.Enabled > -1\r
536                          and B.Enabled > -1\r
537                          group by A.ID\r
538                          """% (MODEL_PCD, MODEL_META_DATA_HEADER, MODEL_PCD, MODEL_META_DATA_HEADER)\r
539             RecordSet = EccGlobalData.gDb.TblDsc.Exec(SqlCommand)\r
540             for Record in RecordSet:\r
541                 if not EccGlobalData.gException.IsException(ERROR_META_DATA_FILE_CHECK_PCD_DUPLICATE, Record[1]):\r
542                     EccGlobalData.gDb.TblReport.Insert(ERROR_META_DATA_FILE_CHECK_PCD_DUPLICATE, OtherMsg = "The PCD [%s] is defined in both FDF file and DSC file" % (Record[1]), BelongsToTable = 'Dsc', BelongsToItem = Record[0])\r
543                 if not EccGlobalData.gException.IsException(ERROR_META_DATA_FILE_CHECK_PCD_DUPLICATE, Record[3]):\r
544                     EccGlobalData.gDb.TblReport.Insert(ERROR_META_DATA_FILE_CHECK_PCD_DUPLICATE, OtherMsg = "The PCD [%s] is defined in both FDF file and DSC file" % (Record[3]), BelongsToTable = 'Fdf', BelongsToItem = Record[2])\r
545 \r
546             EdkLogger.quiet("Checking for duplicate PCDs defined in DEC files ...")\r
547             SqlCommand = """\r
548                          select A.ID, A.Value2 from Dec as A, Dec as B\r
549                          where A.Model >= %s and A.Model < %s\r
550                          and B.Model >= %s and B.Model < %s\r
551                          and A.Value2 = B.Value2\r
552                          and ((A.Arch = B.Arch) and (A.Arch != 'COMMON' or B.Arch != 'COMMON'))\r
553                          and A.ID != B.ID\r
554                          and A.Enabled > -1\r
555                          and B.Enabled > -1\r
556                          and A.BelongsToFile = B.BelongsToFile\r
557                          group by A.ID\r
558                          """% (MODEL_PCD, MODEL_META_DATA_HEADER, MODEL_PCD, MODEL_META_DATA_HEADER)\r
559             RecordSet = EccGlobalData.gDb.TblDsc.Exec(SqlCommand)\r
560             for Record in RecordSet:\r
561                 if not EccGlobalData.gException.IsException(ERROR_META_DATA_FILE_CHECK_PCD_DUPLICATE, Record[1]):\r
562                     EccGlobalData.gDb.TblReport.Insert(ERROR_META_DATA_FILE_CHECK_PCD_DUPLICATE, OtherMsg = "The PCD [%s] is defined duplicated in DEC file" % (Record[1]), BelongsToTable = 'Dec', BelongsToItem = Record[0])\r
563 \r
564     # Check whether PCD settings in the FDF file can only be related to flash.\r
565     def MetaDataFileCheckPcdFlash(self):\r
566         if EccGlobalData.gConfig.MetaDataFileCheckPcdFlash == '1' or EccGlobalData.gConfig.MetaDataFileCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
567             EdkLogger.quiet("Checking only Flash related PCDs are used in FDF ...")\r
568             SqlCommand = """\r
569                          select ID, Value2, BelongsToFile from Fdf as A\r
570                          where A.Model >= %s and Model < %s\r
571                          and A.Enabled > -1\r
572                          and A.Value2 not like '%%Flash%%'\r
573                          """% (MODEL_PCD, MODEL_META_DATA_HEADER)\r
574             RecordSet = EccGlobalData.gDb.TblFdf.Exec(SqlCommand)\r
575             for Record in RecordSet:\r
576                 if not EccGlobalData.gException.IsException(ERROR_META_DATA_FILE_CHECK_PCD_FLASH, Record[1]):\r
577                     EccGlobalData.gDb.TblReport.Insert(ERROR_META_DATA_FILE_CHECK_PCD_FLASH, OtherMsg = "The PCD [%s] defined in FDF file is not related to Flash" % (Record[1]), BelongsToTable = 'Fdf', BelongsToItem = Record[0])\r
578 \r
579     # Check whether PCDs used in Inf files but not specified in Dsc or FDF files\r
580     def MetaDataFileCheckPcdNoUse(self):\r
581         if EccGlobalData.gConfig.MetaDataFileCheckPcdNoUse == '1' or EccGlobalData.gConfig.MetaDataFileCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
582             EdkLogger.quiet("Checking for non-specified PCDs ...")\r
583             SqlCommand = """\r
584                          select ID, Value2, BelongsToFile from Inf as A\r
585                          where A.Model >= %s and Model < %s\r
586                          and A.Enabled > -1\r
587                          and A.Value2 not in\r
588                              (select Value2 from Dsc as B\r
589                               where B.Model >= %s and B.Model < %s\r
590                               and B.Enabled > -1)\r
591                          and A.Value2 not in\r
592                              (select Value2 from Fdf as C\r
593                               where C.Model >= %s and C.Model < %s\r
594                               and C.Enabled > -1)\r
595                          """% (MODEL_PCD, MODEL_META_DATA_HEADER, MODEL_PCD, MODEL_META_DATA_HEADER, MODEL_PCD, MODEL_META_DATA_HEADER)\r
596             RecordSet = EccGlobalData.gDb.TblInf.Exec(SqlCommand)\r
597             for Record in RecordSet:\r
598                 if not EccGlobalData.gException.IsException(ERROR_META_DATA_FILE_CHECK_PCD_NO_USE, Record[1]):\r
599                     EccGlobalData.gDb.TblReport.Insert(ERROR_META_DATA_FILE_CHECK_PCD_NO_USE, OtherMsg = "The PCD [%s] defined in INF file is not specified in either DSC or FDF files" % (Record[1]), BelongsToTable = 'Inf', BelongsToItem = Record[0])\r
600 \r
601     # Check whether having duplicate guids defined for Guid/Protocol/Ppi\r
602     def MetaDataFileCheckGuidDuplicate(self):\r
603         if EccGlobalData.gConfig.MetaDataFileCheckGuidDuplicate == '1' or EccGlobalData.gConfig.MetaDataFileCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
604             EdkLogger.quiet("Checking for duplicate GUID/PPI/PROTOCOL ...")\r
605             # Check Guid\r
606             self.CheckGuidProtocolPpi(ERROR_META_DATA_FILE_CHECK_DUPLICATE_GUID, MODEL_EFI_GUID, EccGlobalData.gDb.TblDec)\r
607             self.CheckGuidProtocolPpi(ERROR_META_DATA_FILE_CHECK_DUPLICATE_GUID, MODEL_EFI_GUID, EccGlobalData.gDb.TblDsc)\r
608             self.CheckGuidProtocolPpiValue(ERROR_META_DATA_FILE_CHECK_DUPLICATE_GUID, MODEL_EFI_GUID)\r
609             # Check protocol\r
610             self.CheckGuidProtocolPpi(ERROR_META_DATA_FILE_CHECK_DUPLICATE_PROTOCOL, MODEL_EFI_PROTOCOL, EccGlobalData.gDb.TblDec)\r
611             self.CheckGuidProtocolPpi(ERROR_META_DATA_FILE_CHECK_DUPLICATE_PROTOCOL, MODEL_EFI_PROTOCOL, EccGlobalData.gDb.TblDsc)\r
612             self.CheckGuidProtocolPpiValue(ERROR_META_DATA_FILE_CHECK_DUPLICATE_PROTOCOL, MODEL_EFI_PROTOCOL)\r
613             # Check ppi\r
614             self.CheckGuidProtocolPpi(ERROR_META_DATA_FILE_CHECK_DUPLICATE_PPI, MODEL_EFI_PPI, EccGlobalData.gDb.TblDec)\r
615             self.CheckGuidProtocolPpi(ERROR_META_DATA_FILE_CHECK_DUPLICATE_PPI, MODEL_EFI_PPI, EccGlobalData.gDb.TblDsc)\r
616             self.CheckGuidProtocolPpiValue(ERROR_META_DATA_FILE_CHECK_DUPLICATE_PPI, MODEL_EFI_PPI)\r
617 \r
618     # Check whether all files under module directory are described in INF files\r
619     def MetaDataFileCheckModuleFileNoUse(self):\r
620         if EccGlobalData.gConfig.MetaDataFileCheckModuleFileNoUse == '1' or EccGlobalData.gConfig.MetaDataFileCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
621             EdkLogger.quiet("Checking for no used module files ...")\r
622             SqlCommand = """\r
623                          select upper(Path) from File where ID in (select BelongsToFile from INF where BelongsToFile != -1)\r
624                          """\r
625             InfPathSet = EccGlobalData.gDb.TblInf.Exec(SqlCommand)\r
626             InfPathList = []\r
627             for Item in InfPathSet:\r
628                 if Item[0] not in InfPathList:\r
629                     InfPathList.append(Item[0])\r
630             SqlCommand = """\r
631                          select ID, Path, FullPath from File where upper(FullPath) not in\r
632                             (select upper(A.Path) || '\\' || upper(B.Value1) from File as A, INF as B\r
633                             where A.ID in (select BelongsToFile from INF where Model = %s group by BelongsToFile) and\r
634                             B.BelongsToFile = A.ID and B.Model = %s)\r
635                             and (Model = %s or Model = %s)\r
636                         """ % (MODEL_EFI_SOURCE_FILE, MODEL_EFI_SOURCE_FILE, MODEL_FILE_C, MODEL_FILE_H)\r
637             RecordSet = EccGlobalData.gDb.TblInf.Exec(SqlCommand)\r
638             for Record in RecordSet:\r
639                 Path = Record[1]\r
640                 Path = Path.upper().replace('\X64', '').replace('\IA32', '').replace('\EBC', '').replace('\IPF', '').replace('\ARM', '')\r
641                 if Path in InfPathList:\r
642                     if not EccGlobalData.gException.IsException(ERROR_META_DATA_FILE_CHECK_MODULE_FILE_NO_USE, Record[2]):\r
643                         EccGlobalData.gDb.TblReport.Insert(ERROR_META_DATA_FILE_CHECK_MODULE_FILE_NO_USE, OtherMsg = "The source file [%s] is existing in module directory but it is not described in INF file." % (Record[2]), BelongsToTable = 'File', BelongsToItem = Record[0])\r
644 \r
645     # Check whether the PCD is correctly used in C function via its type\r
646     def MetaDataFileCheckPcdType(self):\r
647         if EccGlobalData.gConfig.MetaDataFileCheckPcdType == '1' or EccGlobalData.gConfig.MetaDataFileCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
648             EdkLogger.quiet("Checking for pcd type in c code function usage ...")\r
649             SqlCommand = """\r
650                          select ID, Model, Value1, BelongsToFile from INF where Model > %s and Model < %s\r
651                          """ % (MODEL_PCD, MODEL_META_DATA_HEADER)\r
652             PcdSet = EccGlobalData.gDb.TblInf.Exec(SqlCommand)\r
653             for Pcd in PcdSet:\r
654                 Model = Pcd[1]\r
655                 PcdName = Pcd[2]\r
656                 if len(Pcd[2].split(".")) > 1:\r
657                     PcdName = Pcd[2].split(".")[1]\r
658                 BelongsToFile = Pcd[3]\r
659                 SqlCommand = """\r
660                              select ID from File where FullPath in\r
661                             (select B.Path || '\\' || A.Value1 from INF as A, File as B where A.Model = %s and A.BelongsToFile = %s\r
662                              and B.ID = %s)\r
663                              """ %(MODEL_EFI_SOURCE_FILE, BelongsToFile, BelongsToFile)\r
664                 TableSet = EccGlobalData.gDb.TblFile.Exec(SqlCommand)\r
665                 for Tbl in TableSet:\r
666                     TblName = 'Identifier' + str(Tbl[0])\r
667                     SqlCommand = """\r
668                                  select Name, ID from %s where value like '%%%s%%' and Model = %s\r
669                                  """ % (TblName, PcdName, MODEL_IDENTIFIER_FUNCTION_CALLING)\r
670                     RecordSet = EccGlobalData.gDb.TblInf.Exec(SqlCommand)\r
671                     TblNumber = TblName.replace('Identifier', '')\r
672                     for Record in RecordSet:\r
673                         FunName = Record[0]\r
674                         if not EccGlobalData.gException.IsException(ERROR_META_DATA_FILE_CHECK_PCD_TYPE, FunName):\r
675                             if Model in [MODEL_PCD_FIXED_AT_BUILD] and not FunName.startswith('FixedPcdGet'):\r
676                                 EccGlobalData.gDb.TblReport.Insert(ERROR_META_DATA_FILE_CHECK_PCD_TYPE, OtherMsg = "The pcd '%s' is defined as a FixPcd but now it is called by c function [%s]" % (PcdName, FunName), BelongsToTable = TblName, BelongsToItem = Record[1])\r
677                             if Model in [MODEL_PCD_FEATURE_FLAG] and (not FunName.startswith('FeaturePcdGet') and not FunName.startswith('FeaturePcdSet')):\r
678                                 EccGlobalData.gDb.TblReport.Insert(ERROR_META_DATA_FILE_CHECK_PCD_TYPE, OtherMsg = "The pcd '%s' is defined as a FeaturePcd but now it is called by c function [%s]" % (PcdName, FunName), BelongsToTable = TblName, BelongsToItem = Record[1])\r
679                             if Model in [MODEL_PCD_PATCHABLE_IN_MODULE] and (not FunName.startswith('PatchablePcdGet') and not FunName.startswith('PatchablePcdSet')):\r
680                                 EccGlobalData.gDb.TblReport.Insert(ERROR_META_DATA_FILE_CHECK_PCD_TYPE, OtherMsg = "The pcd '%s' is defined as a PatchablePcd but now it is called by c function [%s]" % (PcdName, FunName), BelongsToTable = TblName, BelongsToItem = Record[1])\r
681 \r
682             #ERROR_META_DATA_FILE_CHECK_PCD_TYPE\r
683         pass\r
684 \r
685     # Check whether these is duplicate Guid/Ppi/Protocol name\r
686     def CheckGuidProtocolPpi(self, ErrorID, Model, Table):\r
687         Name = ''\r
688         if Model == MODEL_EFI_GUID:\r
689             Name = 'guid'\r
690         if Model == MODEL_EFI_PROTOCOL:\r
691             Name = 'protocol'\r
692         if Model == MODEL_EFI_PPI:\r
693             Name = 'ppi'\r
694         SqlCommand = """\r
695                      select A.ID, A.Value1 from %s as A, %s as B\r
696                      where A.Model = %s and B.Model = %s\r
697                      and A.Value1 = B.Value1 and A.ID <> B.ID\r
698                      and A.Enabled > -1\r
699                      and B.Enabled > -1\r
700                      group by A.ID\r
701                      """ % (Table.Table, Table.Table, Model, Model)\r
702         RecordSet = Table.Exec(SqlCommand)\r
703         for Record in RecordSet:\r
704             if not EccGlobalData.gException.IsException(ErrorID, Record[1]):\r
705                 EccGlobalData.gDb.TblReport.Insert(ErrorID, OtherMsg = "The %s name [%s] is defined more than one time" % (Name.upper(), Record[1]), BelongsToTable = Table.Table, BelongsToItem = Record[0])\r
706 \r
707     # Check whether these is duplicate Guid/Ppi/Protocol value\r
708     def CheckGuidProtocolPpiValue(self, ErrorID, Model):\r
709         Name = ''\r
710         Table = EccGlobalData.gDb.TblDec\r
711         if Model == MODEL_EFI_GUID:\r
712             Name = 'guid'\r
713         if Model == MODEL_EFI_PROTOCOL:\r
714             Name = 'protocol'\r
715         if Model == MODEL_EFI_PPI:\r
716             Name = 'ppi'\r
717         SqlCommand = """\r
718                      select A.ID, A.Value2 from %s as A, %s as B\r
719                      where A.Model = %s and B.Model = %s\r
720                      and A.Value2 = B.Value2 and A.ID <> B.ID\r
721                      group by A.ID\r
722                      """ % (Table.Table, Table.Table, Model, Model)\r
723         RecordSet = Table.Exec(SqlCommand)\r
724         for Record in RecordSet:\r
725             if not EccGlobalData.gException.IsException(ErrorID, Record[1]):\r
726                 EccGlobalData.gDb.TblReport.Insert(ErrorID, OtherMsg = "The %s value [%s] is used more than one time" % (Name.upper(), Record[1]), BelongsToTable = Table.Table, BelongsToItem = Record[0])\r
727 \r
728     # Naming Convention Check\r
729     def NamingConventionCheck(self):\r
730 \r
731         for Dirpath, Dirnames, Filenames in self.WalkTree():\r
732             for F in Filenames:\r
733                 if os.path.splitext(F)[1] in ('.h', '.c'):\r
734                     FullName = os.path.join(Dirpath, F)\r
735                     Id = c.GetTableID(FullName)\r
736                     if Id < 0:\r
737                         continue\r
738                     FileTable = 'Identifier' + str(Id)\r
739                     self.NamingConventionCheckDefineStatement(FileTable)\r
740                     self.NamingConventionCheckTypedefStatement(FileTable)\r
741                     self.NamingConventionCheckIfndefStatement(FileTable)\r
742                     self.NamingConventionCheckVariableName(FileTable)\r
743                     self.NamingConventionCheckSingleCharacterVariable(FileTable)\r
744 \r
745         self.NamingConventionCheckPathName()\r
746         self.NamingConventionCheckFunctionName()\r
747 \r
748     # Check whether only capital letters are used for #define declarations\r
749     def NamingConventionCheckDefineStatement(self, FileTable):\r
750         if EccGlobalData.gConfig.NamingConventionCheckDefineStatement == '1' or EccGlobalData.gConfig.NamingConventionCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
751             EdkLogger.quiet("Checking naming covention of #define statement ...")\r
752 \r
753             SqlCommand = """select ID, Value from %s where Model = %s""" %(FileTable, MODEL_IDENTIFIER_MACRO_DEFINE)\r
754             RecordSet = EccGlobalData.gDb.TblFile.Exec(SqlCommand)\r
755             for Record in RecordSet:\r
756                 Name = Record[1].strip().split()[1]\r
757                 if Name.find('(') != -1:\r
758                     Name = Name[0:Name.find('(')]\r
759                 if Name.upper() != Name:\r
760                     if not EccGlobalData.gException.IsException(ERROR_NAMING_CONVENTION_CHECK_DEFINE_STATEMENT, Name):\r
761                         EccGlobalData.gDb.TblReport.Insert(ERROR_NAMING_CONVENTION_CHECK_DEFINE_STATEMENT, OtherMsg = "The #define name [%s] does not follow the rules" % (Name), BelongsToTable = FileTable, BelongsToItem = Record[0])\r
762 \r
763     # Check whether only capital letters are used for typedef declarations\r
764     def NamingConventionCheckTypedefStatement(self, FileTable):\r
765         if EccGlobalData.gConfig.NamingConventionCheckTypedefStatement == '1' or EccGlobalData.gConfig.NamingConventionCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
766             EdkLogger.quiet("Checking naming covention of #typedef statement ...")\r
767 \r
768             SqlCommand = """select ID, Name from %s where Model = %s""" %(FileTable, MODEL_IDENTIFIER_TYPEDEF)\r
769             RecordSet = EccGlobalData.gDb.TblFile.Exec(SqlCommand)\r
770             for Record in RecordSet:\r
771                 Name = Record[1].strip()\r
772                 if Name != '' and Name != None:\r
773                     if Name[0] == '(':\r
774                         Name = Name[1:Name.find(')')]\r
775                     if Name.find('(') > -1:\r
776                         Name = Name[Name.find('(') + 1 : Name.find(')')]\r
777                     Name = Name.replace('WINAPI', '')\r
778                     Name = Name.replace('*', '').strip()\r
779                     if Name.upper() != Name:\r
780                         if not EccGlobalData.gException.IsException(ERROR_NAMING_CONVENTION_CHECK_TYPEDEF_STATEMENT, Name):\r
781                             EccGlobalData.gDb.TblReport.Insert(ERROR_NAMING_CONVENTION_CHECK_TYPEDEF_STATEMENT, OtherMsg = "The #typedef name [%s] does not follow the rules" % (Name), BelongsToTable = FileTable, BelongsToItem = Record[0])\r
782 \r
783     # Check whether the #ifndef at the start of an include file uses both prefix and postfix underscore characters, '_'.\r
784     def NamingConventionCheckIfndefStatement(self, FileTable):\r
785         if EccGlobalData.gConfig.NamingConventionCheckTypedefStatement == '1' or EccGlobalData.gConfig.NamingConventionCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
786             EdkLogger.quiet("Checking naming covention of #ifndef statement ...")\r
787 \r
788             SqlCommand = """select ID, Value from %s where Model = %s""" %(FileTable, MODEL_IDENTIFIER_MACRO_IFNDEF)\r
789             RecordSet = EccGlobalData.gDb.TblFile.Exec(SqlCommand)\r
790             for Record in RecordSet:\r
791                 Name = Record[1].replace('#ifndef', '').strip()\r
792                 if Name[0] != '_' or Name[-1] != '_':\r
793                     if not EccGlobalData.gException.IsException(ERROR_NAMING_CONVENTION_CHECK_IFNDEF_STATEMENT, Name):\r
794                         EccGlobalData.gDb.TblReport.Insert(ERROR_NAMING_CONVENTION_CHECK_IFNDEF_STATEMENT, OtherMsg = "The #ifndef name [%s] does not follow the rules" % (Name), BelongsToTable = FileTable, BelongsToItem = Record[0])\r
795 \r
796     # Rule for path name, variable name and function name\r
797     # 1. First character should be upper case\r
798     # 2. Existing lower case in a word\r
799     # 3. No space existence\r
800     # Check whether the path name followed the rule\r
801     def NamingConventionCheckPathName(self):\r
802         if EccGlobalData.gConfig.NamingConventionCheckPathName == '1' or EccGlobalData.gConfig.NamingConventionCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
803             EdkLogger.quiet("Checking naming covention of file path name ...")\r
804             Pattern = re.compile(r'^[A-Z]+\S*[a-z]\S*$')\r
805             SqlCommand = """select ID, Name from File"""\r
806             RecordSet = EccGlobalData.gDb.TblFile.Exec(SqlCommand)\r
807             for Record in RecordSet:\r
808                 if not Pattern.match(Record[1]):\r
809                     if not EccGlobalData.gException.IsException(ERROR_NAMING_CONVENTION_CHECK_PATH_NAME, Record[1]):\r
810                         EccGlobalData.gDb.TblReport.Insert(ERROR_NAMING_CONVENTION_CHECK_PATH_NAME, OtherMsg = "The file path [%s] does not follow the rules" % (Record[1]), BelongsToTable = 'File', BelongsToItem = Record[0])\r
811 \r
812     # Rule for path name, variable name and function name\r
813     # 1. First character should be upper case\r
814     # 2. Existing lower case in a word\r
815     # 3. No space existence\r
816     # 4. Global variable name must start with a 'g'\r
817     # Check whether the variable name followed the rule\r
818     def NamingConventionCheckVariableName(self, FileTable):\r
819         if EccGlobalData.gConfig.NamingConventionCheckVariableName == '1' or EccGlobalData.gConfig.NamingConventionCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
820             EdkLogger.quiet("Checking naming covention of variable name ...")\r
821             Pattern = re.compile(r'^[A-Zgm]+\S*[a-z]\S*$')\r
822 \r
823             SqlCommand = """select ID, Name from %s where Model = %s""" %(FileTable, MODEL_IDENTIFIER_VARIABLE)\r
824             RecordSet = EccGlobalData.gDb.TblFile.Exec(SqlCommand)\r
825             for Record in RecordSet:\r
826                 if not Pattern.match(Record[1]):\r
827                     if not EccGlobalData.gException.IsException(ERROR_NAMING_CONVENTION_CHECK_VARIABLE_NAME, Record[1]):\r
828                         EccGlobalData.gDb.TblReport.Insert(ERROR_NAMING_CONVENTION_CHECK_VARIABLE_NAME, OtherMsg = "The variable name [%s] does not follow the rules" % (Record[1]), BelongsToTable = FileTable, BelongsToItem = Record[0])\r
829 \r
830     # Rule for path name, variable name and function name\r
831     # 1. First character should be upper case\r
832     # 2. Existing lower case in a word\r
833     # 3. No space existence\r
834     # Check whether the function name followed the rule\r
835     def NamingConventionCheckFunctionName(self):\r
836         if EccGlobalData.gConfig.NamingConventionCheckFunctionName == '1' or EccGlobalData.gConfig.NamingConventionCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
837             EdkLogger.quiet("Checking naming covention of function name ...")\r
838             Pattern = re.compile(r'^[A-Z]+\S*[a-z]\S*$')\r
839             SqlCommand = """select ID, Name from Function"""\r
840             RecordSet = EccGlobalData.gDb.TblFile.Exec(SqlCommand)\r
841             for Record in RecordSet:\r
842                 if not Pattern.match(Record[1]):\r
843                     if not EccGlobalData.gException.IsException(ERROR_NAMING_CONVENTION_CHECK_FUNCTION_NAME, Record[1]):\r
844                         EccGlobalData.gDb.TblReport.Insert(ERROR_NAMING_CONVENTION_CHECK_FUNCTION_NAME, OtherMsg = "The function name [%s] does not follow the rules" % (Record[1]), BelongsToTable = 'Function', BelongsToItem = Record[0])\r
845 \r
846     # Check whether NO use short variable name with single character\r
847     def NamingConventionCheckSingleCharacterVariable(self, FileTable):\r
848         if EccGlobalData.gConfig.NamingConventionCheckSingleCharacterVariable == '1' or EccGlobalData.gConfig.NamingConventionCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
849             EdkLogger.quiet("Checking naming covention of single character variable name ...")\r
850 \r
851             SqlCommand = """select ID, Name from %s where Model = %s""" %(FileTable, MODEL_IDENTIFIER_VARIABLE)\r
852             RecordSet = EccGlobalData.gDb.TblFile.Exec(SqlCommand)\r
853             for Record in RecordSet:\r
854                 Variable = Record[1].replace('*', '')\r
855                 if len(Variable) == 1:\r
856                     if not EccGlobalData.gException.IsException(ERROR_NAMING_CONVENTION_CHECK_SINGLE_CHARACTER_VARIABLE, Record[1]):\r
857                         EccGlobalData.gDb.TblReport.Insert(ERROR_NAMING_CONVENTION_CHECK_SINGLE_CHARACTER_VARIABLE, OtherMsg = "The variable name [%s] does not follow the rules" % (Record[1]), BelongsToTable = FileTable, BelongsToItem = Record[0])\r
858 \r
859 ##\r
860 #\r
861 # This acts like the main() function for the script, unless it is 'import'ed into another\r
862 # script.\r
863 #\r
864 if __name__ == '__main__':\r
865     Check = Check()\r
866     Check.Check()\r