1. Fix absolute path issue in duplicate include file checkpoint
[mirror/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                         Path = Item[1].replace(EccGlobalData.gWorkspace, '')\r
302                         if not EccGlobalData.gException.IsException(ERROR_INCLUDE_FILE_CHECK_NAME, Path):\r
303                             EccGlobalData.gDb.TblReport.Insert(ERROR_INCLUDE_FILE_CHECK_NAME, OtherMsg = "The file name for [%s] is duplicate" % Path, BelongsToTable = 'File', BelongsToItem = Item[0])\r
304 \r
305     # Check whether all include file contents is guarded by a #ifndef statement.\r
306     def IncludeFileCheckIfndef(self):\r
307         if EccGlobalData.gConfig.IncludeFileCheckIfndefStatement == '1' or EccGlobalData.gConfig.IncludeFileCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
308             EdkLogger.quiet("Checking header file ifndef ...")\r
309 \r
310             for Dirpath, Dirnames, Filenames in self.WalkTree():\r
311                 for F in Filenames:\r
312                     if os.path.splitext(F)[1] in ('.h'):\r
313                         FullName = os.path.join(Dirpath, F)\r
314                         MsgList = c.CheckHeaderFileIfndef(FullName)\r
315 \r
316     # Check whether include files NOT contain code or define data variables\r
317     def IncludeFileCheckData(self):\r
318         if EccGlobalData.gConfig.IncludeFileCheckData == '1' or EccGlobalData.gConfig.IncludeFileCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
319             EdkLogger.quiet("Checking header file data ...")\r
320 \r
321             for Dirpath, Dirnames, Filenames in self.WalkTree():\r
322                 for F in Filenames:\r
323                     if os.path.splitext(F)[1] in ('.h'):\r
324                         FullName = os.path.join(Dirpath, F)\r
325                         MsgList = c.CheckHeaderFileData(FullName)\r
326 \r
327     # Doxygen document checking\r
328     def DoxygenCheck(self):\r
329         self.DoxygenCheckFileHeader()\r
330         self.DoxygenCheckFunctionHeader()\r
331         self.DoxygenCheckCommentDescription()\r
332         self.DoxygenCheckCommentFormat()\r
333         self.DoxygenCheckCommand()\r
334 \r
335     # Check whether the file headers are followed Doxygen special documentation blocks in section 2.3.5\r
336     def DoxygenCheckFileHeader(self):\r
337         if EccGlobalData.gConfig.DoxygenCheckFileHeader == '1' or EccGlobalData.gConfig.DoxygenCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
338             EdkLogger.quiet("Checking Doxygen file header ...")\r
339 \r
340             for Dirpath, Dirnames, Filenames in self.WalkTree():\r
341                 for F in Filenames:\r
342                     if os.path.splitext(F)[1] in ('.h', '.c'):\r
343                         FullName = os.path.join(Dirpath, F)\r
344                         MsgList = c.CheckFileHeaderDoxygenComments(FullName)\r
345 \r
346     # Check whether the function headers are followed Doxygen special documentation blocks in section 2.3.5\r
347     def DoxygenCheckFunctionHeader(self):\r
348         if EccGlobalData.gConfig.DoxygenCheckFunctionHeader == '1' or EccGlobalData.gConfig.DoxygenCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
349             EdkLogger.quiet("Checking Doxygen function header ...")\r
350 \r
351             for Dirpath, Dirnames, Filenames in self.WalkTree():\r
352                 for F in Filenames:\r
353                     if os.path.splitext(F)[1] in ('.h', '.c'):\r
354                         FullName = os.path.join(Dirpath, F)\r
355                         MsgList = c.CheckFuncHeaderDoxygenComments(FullName)\r
356 \r
357     # Check whether the first line of text in a comment block is a brief description of the element being documented.\r
358     # The brief description must end with a period.\r
359     def DoxygenCheckCommentDescription(self):\r
360         if EccGlobalData.gConfig.DoxygenCheckCommentDescription == '1' or EccGlobalData.gConfig.DoxygenCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
361             pass\r
362 \r
363     # Check whether comment lines with '///< ... text ...' format, if it is used, it should be after the code section.\r
364     def DoxygenCheckCommentFormat(self):\r
365         if EccGlobalData.gConfig.DoxygenCheckCommentFormat == '1' or EccGlobalData.gConfig.DoxygenCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
366             EdkLogger.quiet("Checking Doxygen comment ///< ...")\r
367 \r
368             for Dirpath, Dirnames, Filenames in self.WalkTree():\r
369                 for F in Filenames:\r
370                     if os.path.splitext(F)[1] in ('.h', '.c'):\r
371                         FullName = os.path.join(Dirpath, F)\r
372                         MsgList = c.CheckDoxygenTripleForwardSlash(FullName)\r
373 \r
374     # Check whether only Doxygen commands allowed to mark the code are @bug and @todo.\r
375     def DoxygenCheckCommand(self):\r
376         if EccGlobalData.gConfig.DoxygenCheckCommand == '1' or EccGlobalData.gConfig.DoxygenCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
377             EdkLogger.quiet("Checking Doxygen command ...")\r
378 \r
379             for Dirpath, Dirnames, Filenames in self.WalkTree():\r
380                 for F in Filenames:\r
381                     if os.path.splitext(F)[1] in ('.h', '.c'):\r
382                         FullName = os.path.join(Dirpath, F)\r
383                         MsgList = c.CheckDoxygenCommand(FullName)\r
384 \r
385     # Meta-Data File Processing Checking\r
386     def MetaDataFileCheck(self):\r
387         self.MetaDataFileCheckPathName()\r
388         self.MetaDataFileCheckGenerateFileList()\r
389         self.MetaDataFileCheckLibraryInstance()\r
390         self.MetaDataFileCheckLibraryInstanceDependent()\r
391         self.MetaDataFileCheckLibraryInstanceOrder()\r
392         self.MetaDataFileCheckLibraryNoUse()\r
393         self.MetaDataFileCheckBinaryInfInFdf()\r
394         self.MetaDataFileCheckPcdDuplicate()\r
395         self.MetaDataFileCheckPcdFlash()\r
396         self.MetaDataFileCheckPcdNoUse()\r
397         self.MetaDataFileCheckGuidDuplicate()\r
398         self.MetaDataFileCheckModuleFileNoUse()\r
399         self.MetaDataFileCheckPcdType()\r
400 \r
401     # Check whether each file defined in meta-data exists\r
402     def MetaDataFileCheckPathName(self):\r
403         if EccGlobalData.gConfig.MetaDataFileCheckPathName == '1' or EccGlobalData.gConfig.MetaDataFileCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
404             # This item is covered when parsing Inf/Dec/Dsc files\r
405             pass\r
406 \r
407     # Generate a list for all files defined in meta-data files\r
408     def MetaDataFileCheckGenerateFileList(self):\r
409         if EccGlobalData.gConfig.MetaDataFileCheckGenerateFileList == '1' or EccGlobalData.gConfig.MetaDataFileCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
410             # This item is covered when parsing Inf/Dec/Dsc files\r
411             pass\r
412 \r
413     # Check whether all Library Instances defined for a given module (or dependent library instance) match the module's type.\r
414     # Each Library Instance must specify the Supported Module Types in its Inf file,\r
415     # and any module specifying the library instance must be one of the supported types.\r
416     def MetaDataFileCheckLibraryInstance(self):\r
417         if EccGlobalData.gConfig.MetaDataFileCheckLibraryInstance == '1' or EccGlobalData.gConfig.MetaDataFileCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
418             EdkLogger.quiet("Checking for library instance type issue ...")\r
419             SqlCommand = """select A.ID, A.Value2, B.Value2 from Inf as A left join Inf as B\r
420                             where A.Value1 = 'LIBRARY_CLASS' and A.Model = %s\r
421                             and B.Value1 = 'MODULE_TYPE' and B.Model = %s and A.BelongsToFile = B.BelongsToFile\r
422                             group by A.BelongsToFile""" % (MODEL_META_DATA_HEADER, MODEL_META_DATA_HEADER)\r
423             RecordSet = EccGlobalData.gDb.TblInf.Exec(SqlCommand)\r
424             LibraryClasses = {}\r
425             for Record in RecordSet:\r
426                 List = Record[1].split('|', 1)\r
427                 SupModType = []\r
428                 if len(List) == 1:\r
429                     SupModType = SUP_MODULE_LIST_STRING.split(TAB_VALUE_SPLIT)\r
430                 elif len(List) == 2:\r
431                     SupModType = List[1].split()\r
432 \r
433                 if List[0] not in LibraryClasses:\r
434                     LibraryClasses[List[0]] = SupModType\r
435                 else:\r
436                     for Item in SupModType:\r
437                         if Item not in LibraryClasses[List[0]]:\r
438                             LibraryClasses[List[0]].append(Item)\r
439 \r
440                 if Record[2] != 'BASE' and Record[2] not in SupModType:\r
441                     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
442 \r
443             SqlCommand = """select A.ID, A.Value1, B.Value2 from Inf as A left join Inf as B\r
444                             where A.Model = %s and B.Value1 = '%s' and B.Model = %s\r
445                             and B.BelongsToFile = A.BelongsToFile""" \\r
446                             % (MODEL_EFI_LIBRARY_CLASS, 'MODULE_TYPE', MODEL_META_DATA_HEADER)\r
447             RecordSet = EccGlobalData.gDb.TblInf.Exec(SqlCommand)\r
448             # Merge all LibraryClasses' supmodlist\r
449             RecordDict = {}\r
450             for Record in RecordSet:\r
451                 if Record[1] not in RecordDict:\r
452                     RecordDict[Record[1]] = [str(Record[2])]\r
453                 else:\r
454                     if Record[2] not in RecordDict[Record[1]]:\r
455                         RecordDict[Record[1]].append(Record[2])\r
456 \r
457             for Record in RecordSet:\r
458                 if Record[1] in LibraryClasses:\r
459                     if Record[2] not in LibraryClasses[Record[1]] and 'BASE' not in RecordDict[Record[1]]:\r
460                         if not EccGlobalData.gException.IsException(ERROR_META_DATA_FILE_CHECK_LIBRARY_INSTANCE_1, Record[1]):\r
461                             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
462                 else:\r
463                     if not EccGlobalData.gException.IsException(ERROR_META_DATA_FILE_CHECK_LIBRARY_INSTANCE_1, Record[1]):\r
464                         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
465 \r
466     # Check whether a Library Instance has been defined for all dependent library classes\r
467     def MetaDataFileCheckLibraryInstanceDependent(self):\r
468         if EccGlobalData.gConfig.MetaDataFileCheckLibraryInstanceDependent == '1' or EccGlobalData.gConfig.MetaDataFileCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
469             EdkLogger.quiet("Checking for library instance dependent issue ...")\r
470             SqlCommand = """select ID, Value1, Value2 from Dsc where Model = %s""" % MODEL_EFI_LIBRARY_CLASS\r
471             LibraryClasses = EccGlobalData.gDb.TblDsc.Exec(SqlCommand)\r
472             for LibraryClass in LibraryClasses:\r
473                 if LibraryClass[1].upper() != 'NULL':\r
474                     LibraryIns = os.path.normpath(os.path.join(EccGlobalData.gWorkspace, LibraryClass[2]))\r
475                     SqlCommand = """select Value2 from Inf where BelongsToFile =\r
476                                     (select ID from File where lower(FullPath) = lower('%s'))\r
477                                     and Value1 = '%s'""" % (LibraryIns, 'LIBRARY_CLASS')\r
478                     RecordSet = EccGlobalData.gDb.TblInf.Exec(SqlCommand)\r
479                     IsFound = False\r
480                     for Record in RecordSet:\r
481                         LibName = Record[0].split('|', 1)[0]\r
482                         if LibraryClass[1] == LibName:\r
483                             IsFound = True\r
484                     if not IsFound:\r
485                         if not EccGlobalData.gException.IsException(ERROR_META_DATA_FILE_CHECK_LIBRARY_INSTANCE_DEPENDENT, LibraryClass[1]):\r
486                             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
487 \r
488     # Check whether the Library Instances specified by the LibraryClasses sections are listed in order of dependencies\r
489     def MetaDataFileCheckLibraryInstanceOrder(self):\r
490         if EccGlobalData.gConfig.MetaDataFileCheckLibraryInstanceOrder == '1' or EccGlobalData.gConfig.MetaDataFileCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
491             # This checkpoint is not necessary for Ecc check\r
492             pass\r
493 \r
494     # Check whether the unnecessary inclusion of library classes in the Inf file\r
495     def MetaDataFileCheckLibraryNoUse(self):\r
496         if EccGlobalData.gConfig.MetaDataFileCheckLibraryNoUse == '1' or EccGlobalData.gConfig.MetaDataFileCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
497             EdkLogger.quiet("Checking for library instance not used ...")\r
498             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
499             RecordSet = EccGlobalData.gDb.TblInf.Exec(SqlCommand)\r
500             for Record in RecordSet:\r
501                 if not EccGlobalData.gException.IsException(ERROR_META_DATA_FILE_CHECK_LIBRARY_NO_USE, Record[1]):\r
502                     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
503 \r
504     # 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
505     def MetaDataFileCheckBinaryInfInFdf(self):\r
506         if EccGlobalData.gConfig.MetaDataFileCheckBinaryInfInFdf == '1' or EccGlobalData.gConfig.MetaDataFileCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
507             EdkLogger.quiet("Checking for non-binary modules defined in FDF files ...")\r
508             SqlCommand = """select A.ID, A.Value1 from Fdf as A\r
509                          where A.Model = %s\r
510                          and A.Enabled > -1\r
511                          and A.Value1 not in\r
512                          (select B.Value1 from Dsc as B\r
513                          where B.Model = %s\r
514                          and B.Enabled > -1)""" % (MODEL_META_DATA_COMPONENT, MODEL_META_DATA_COMPONENT)\r
515             RecordSet = EccGlobalData.gDb.TblFdf.Exec(SqlCommand)\r
516             for Record in RecordSet:\r
517                 FdfID = Record[0]\r
518                 FilePath = Record[1]\r
519                 FilePath = os.path.normpath(os.path.join(EccGlobalData.gWorkspace, FilePath))\r
520                 SqlCommand = """select ID from Inf where Model = %s and BelongsToFile = (select ID from File where FullPath like '%s')\r
521                                 """ % (MODEL_EFI_SOURCE_FILE, FilePath)\r
522                 NewRecordSet = EccGlobalData.gDb.TblFile.Exec(SqlCommand)\r
523                 if NewRecordSet!= []:\r
524                     if not EccGlobalData.gException.IsException(ERROR_META_DATA_FILE_CHECK_BINARY_INF_IN_FDF, FilePath):\r
525                         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
526 \r
527     # Check whether a PCD is set in a Dsc file or the FDF file, but not in both.\r
528     def MetaDataFileCheckPcdDuplicate(self):\r
529         if EccGlobalData.gConfig.MetaDataFileCheckPcdDuplicate == '1' or EccGlobalData.gConfig.MetaDataFileCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
530             EdkLogger.quiet("Checking for duplicate PCDs defined in both DSC and FDF files ...")\r
531             SqlCommand = """\r
532                          select A.ID, A.Value2, B.ID, B.Value2 from Dsc as A, Fdf as B\r
533                          where A.Model >= %s and A.Model < %s\r
534                          and B.Model >= %s and B.Model < %s\r
535                          and A.Value2 = B.Value2\r
536                          and A.Enabled > -1\r
537                          and B.Enabled > -1\r
538                          group by A.ID\r
539                          """% (MODEL_PCD, MODEL_META_DATA_HEADER, MODEL_PCD, MODEL_META_DATA_HEADER)\r
540             RecordSet = EccGlobalData.gDb.TblDsc.Exec(SqlCommand)\r
541             for Record in RecordSet:\r
542                 if not EccGlobalData.gException.IsException(ERROR_META_DATA_FILE_CHECK_PCD_DUPLICATE, Record[1]):\r
543                     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
544                 if not EccGlobalData.gException.IsException(ERROR_META_DATA_FILE_CHECK_PCD_DUPLICATE, Record[3]):\r
545                     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
546 \r
547             EdkLogger.quiet("Checking for duplicate PCDs defined in DEC files ...")\r
548             SqlCommand = """\r
549                          select A.ID, A.Value2 from Dec as A, Dec as B\r
550                          where A.Model >= %s and A.Model < %s\r
551                          and B.Model >= %s and B.Model < %s\r
552                          and A.Value2 = B.Value2\r
553                          and ((A.Arch = B.Arch) and (A.Arch != 'COMMON' or B.Arch != 'COMMON'))\r
554                          and A.ID != B.ID\r
555                          and A.Enabled > -1\r
556                          and B.Enabled > -1\r
557                          and A.BelongsToFile = B.BelongsToFile\r
558                          group by A.ID\r
559                          """% (MODEL_PCD, MODEL_META_DATA_HEADER, MODEL_PCD, MODEL_META_DATA_HEADER)\r
560             RecordSet = EccGlobalData.gDb.TblDsc.Exec(SqlCommand)\r
561             for Record in RecordSet:\r
562                 if not EccGlobalData.gException.IsException(ERROR_META_DATA_FILE_CHECK_PCD_DUPLICATE, Record[1]):\r
563                     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
564 \r
565     # Check whether PCD settings in the FDF file can only be related to flash.\r
566     def MetaDataFileCheckPcdFlash(self):\r
567         if EccGlobalData.gConfig.MetaDataFileCheckPcdFlash == '1' or EccGlobalData.gConfig.MetaDataFileCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
568             EdkLogger.quiet("Checking only Flash related PCDs are used in FDF ...")\r
569             SqlCommand = """\r
570                          select ID, Value2, BelongsToFile from Fdf as A\r
571                          where A.Model >= %s and Model < %s\r
572                          and A.Enabled > -1\r
573                          and A.Value2 not like '%%Flash%%'\r
574                          """% (MODEL_PCD, MODEL_META_DATA_HEADER)\r
575             RecordSet = EccGlobalData.gDb.TblFdf.Exec(SqlCommand)\r
576             for Record in RecordSet:\r
577                 if not EccGlobalData.gException.IsException(ERROR_META_DATA_FILE_CHECK_PCD_FLASH, Record[1]):\r
578                     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
579 \r
580     # Check whether PCDs used in Inf files but not specified in Dsc or FDF files\r
581     def MetaDataFileCheckPcdNoUse(self):\r
582         if EccGlobalData.gConfig.MetaDataFileCheckPcdNoUse == '1' or EccGlobalData.gConfig.MetaDataFileCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
583             EdkLogger.quiet("Checking for non-specified PCDs ...")\r
584             SqlCommand = """\r
585                          select ID, Value2, BelongsToFile from Inf as A\r
586                          where A.Model >= %s and Model < %s\r
587                          and A.Enabled > -1\r
588                          and A.Value2 not in\r
589                              (select Value2 from Dsc as B\r
590                               where B.Model >= %s and B.Model < %s\r
591                               and B.Enabled > -1)\r
592                          and A.Value2 not in\r
593                              (select Value2 from Fdf as C\r
594                               where C.Model >= %s and C.Model < %s\r
595                               and C.Enabled > -1)\r
596                          """% (MODEL_PCD, MODEL_META_DATA_HEADER, MODEL_PCD, MODEL_META_DATA_HEADER, MODEL_PCD, MODEL_META_DATA_HEADER)\r
597             RecordSet = EccGlobalData.gDb.TblInf.Exec(SqlCommand)\r
598             for Record in RecordSet:\r
599                 if not EccGlobalData.gException.IsException(ERROR_META_DATA_FILE_CHECK_PCD_NO_USE, Record[1]):\r
600                     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
601 \r
602     # Check whether having duplicate guids defined for Guid/Protocol/Ppi\r
603     def MetaDataFileCheckGuidDuplicate(self):\r
604         if EccGlobalData.gConfig.MetaDataFileCheckGuidDuplicate == '1' or EccGlobalData.gConfig.MetaDataFileCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
605             EdkLogger.quiet("Checking for duplicate GUID/PPI/PROTOCOL ...")\r
606             # Check Guid\r
607             self.CheckGuidProtocolPpi(ERROR_META_DATA_FILE_CHECK_DUPLICATE_GUID, MODEL_EFI_GUID, EccGlobalData.gDb.TblDec)\r
608             self.CheckGuidProtocolPpi(ERROR_META_DATA_FILE_CHECK_DUPLICATE_GUID, MODEL_EFI_GUID, EccGlobalData.gDb.TblDsc)\r
609             self.CheckGuidProtocolPpiValue(ERROR_META_DATA_FILE_CHECK_DUPLICATE_GUID, MODEL_EFI_GUID)\r
610             # Check protocol\r
611             self.CheckGuidProtocolPpi(ERROR_META_DATA_FILE_CHECK_DUPLICATE_PROTOCOL, MODEL_EFI_PROTOCOL, EccGlobalData.gDb.TblDec)\r
612             self.CheckGuidProtocolPpi(ERROR_META_DATA_FILE_CHECK_DUPLICATE_PROTOCOL, MODEL_EFI_PROTOCOL, EccGlobalData.gDb.TblDsc)\r
613             self.CheckGuidProtocolPpiValue(ERROR_META_DATA_FILE_CHECK_DUPLICATE_PROTOCOL, MODEL_EFI_PROTOCOL)\r
614             # Check ppi\r
615             self.CheckGuidProtocolPpi(ERROR_META_DATA_FILE_CHECK_DUPLICATE_PPI, MODEL_EFI_PPI, EccGlobalData.gDb.TblDec)\r
616             self.CheckGuidProtocolPpi(ERROR_META_DATA_FILE_CHECK_DUPLICATE_PPI, MODEL_EFI_PPI, EccGlobalData.gDb.TblDsc)\r
617             self.CheckGuidProtocolPpiValue(ERROR_META_DATA_FILE_CHECK_DUPLICATE_PPI, MODEL_EFI_PPI)\r
618 \r
619     # Check whether all files under module directory are described in INF files\r
620     def MetaDataFileCheckModuleFileNoUse(self):\r
621         if EccGlobalData.gConfig.MetaDataFileCheckModuleFileNoUse == '1' or EccGlobalData.gConfig.MetaDataFileCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
622             EdkLogger.quiet("Checking for no used module files ...")\r
623             SqlCommand = """\r
624                          select upper(Path) from File where ID in (select BelongsToFile from INF where BelongsToFile != -1)\r
625                          """\r
626             InfPathSet = EccGlobalData.gDb.TblInf.Exec(SqlCommand)\r
627             InfPathList = []\r
628             for Item in InfPathSet:\r
629                 if Item[0] not in InfPathList:\r
630                     InfPathList.append(Item[0])\r
631             SqlCommand = """\r
632                          select ID, Path, FullPath from File where upper(FullPath) not in\r
633                             (select upper(A.Path) || '\\' || upper(B.Value1) from File as A, INF as B\r
634                             where A.ID in (select BelongsToFile from INF where Model = %s group by BelongsToFile) and\r
635                             B.BelongsToFile = A.ID and B.Model = %s)\r
636                             and (Model = %s or Model = %s)\r
637                         """ % (MODEL_EFI_SOURCE_FILE, MODEL_EFI_SOURCE_FILE, MODEL_FILE_C, MODEL_FILE_H)\r
638             RecordSet = EccGlobalData.gDb.TblInf.Exec(SqlCommand)\r
639             for Record in RecordSet:\r
640                 Path = Record[1]\r
641                 Path = Path.upper().replace('\X64', '').replace('\IA32', '').replace('\EBC', '').replace('\IPF', '').replace('\ARM', '')\r
642                 if Path in InfPathList:\r
643                     if not EccGlobalData.gException.IsException(ERROR_META_DATA_FILE_CHECK_MODULE_FILE_NO_USE, Record[2]):\r
644                         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
645 \r
646     # Check whether the PCD is correctly used in C function via its type\r
647     def MetaDataFileCheckPcdType(self):\r
648         if EccGlobalData.gConfig.MetaDataFileCheckPcdType == '1' or EccGlobalData.gConfig.MetaDataFileCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
649             EdkLogger.quiet("Checking for pcd type in c code function usage ...")\r
650             SqlCommand = """\r
651                          select ID, Model, Value1, BelongsToFile from INF where Model > %s and Model < %s\r
652                          """ % (MODEL_PCD, MODEL_META_DATA_HEADER)\r
653             PcdSet = EccGlobalData.gDb.TblInf.Exec(SqlCommand)\r
654             for Pcd in PcdSet:\r
655                 Model = Pcd[1]\r
656                 PcdName = Pcd[2]\r
657                 if len(Pcd[2].split(".")) > 1:\r
658                     PcdName = Pcd[2].split(".")[1]\r
659                 BelongsToFile = Pcd[3]\r
660                 SqlCommand = """\r
661                              select ID from File where FullPath in\r
662                             (select B.Path || '\\' || A.Value1 from INF as A, File as B where A.Model = %s and A.BelongsToFile = %s\r
663                              and B.ID = %s)\r
664                              """ %(MODEL_EFI_SOURCE_FILE, BelongsToFile, BelongsToFile)\r
665                 TableSet = EccGlobalData.gDb.TblFile.Exec(SqlCommand)\r
666                 for Tbl in TableSet:\r
667                     TblName = 'Identifier' + str(Tbl[0])\r
668                     SqlCommand = """\r
669                                  select Name, ID from %s where value like '%s' and Model = %s\r
670                                  """ % (TblName, PcdName, MODEL_IDENTIFIER_FUNCTION_CALLING)\r
671                     RecordSet = EccGlobalData.gDb.TblInf.Exec(SqlCommand)\r
672                     TblNumber = TblName.replace('Identifier', '')\r
673                     for Record in RecordSet:\r
674                         FunName = Record[0]\r
675                         if not EccGlobalData.gException.IsException(ERROR_META_DATA_FILE_CHECK_PCD_TYPE, FunName):\r
676                             if Model in [MODEL_PCD_FIXED_AT_BUILD] and not FunName.startswith('FixedPcdGet'):\r
677                                 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
678                             if Model in [MODEL_PCD_FEATURE_FLAG] and (not FunName.startswith('FeaturePcdGet') and not FunName.startswith('FeaturePcdSet')):\r
679                                 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
680                             if Model in [MODEL_PCD_PATCHABLE_IN_MODULE] and (not FunName.startswith('PatchablePcdGet') and not FunName.startswith('PatchablePcdSet')):\r
681                                 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
682 \r
683             #ERROR_META_DATA_FILE_CHECK_PCD_TYPE\r
684         pass\r
685 \r
686     # Check whether these is duplicate Guid/Ppi/Protocol name\r
687     def CheckGuidProtocolPpi(self, ErrorID, Model, Table):\r
688         Name = ''\r
689         if Model == MODEL_EFI_GUID:\r
690             Name = 'guid'\r
691         if Model == MODEL_EFI_PROTOCOL:\r
692             Name = 'protocol'\r
693         if Model == MODEL_EFI_PPI:\r
694             Name = 'ppi'\r
695         SqlCommand = """\r
696                      select A.ID, A.Value1 from %s as A, %s as B\r
697                      where A.Model = %s and B.Model = %s\r
698                      and A.Value1 = B.Value1 and A.ID <> B.ID\r
699                      and A.Enabled > -1\r
700                      and B.Enabled > -1\r
701                      group by A.ID\r
702                      """ % (Table.Table, Table.Table, Model, Model)\r
703         RecordSet = Table.Exec(SqlCommand)\r
704         for Record in RecordSet:\r
705             if not EccGlobalData.gException.IsException(ErrorID, Record[1]):\r
706                 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
707 \r
708     # Check whether these is duplicate Guid/Ppi/Protocol value\r
709     def CheckGuidProtocolPpiValue(self, ErrorID, Model):\r
710         Name = ''\r
711         Table = EccGlobalData.gDb.TblDec\r
712         if Model == MODEL_EFI_GUID:\r
713             Name = 'guid'\r
714         if Model == MODEL_EFI_PROTOCOL:\r
715             Name = 'protocol'\r
716         if Model == MODEL_EFI_PPI:\r
717             Name = 'ppi'\r
718         SqlCommand = """\r
719                      select A.ID, A.Value2 from %s as A, %s as B\r
720                      where A.Model = %s and B.Model = %s\r
721                      and A.Value2 = B.Value2 and A.ID <> B.ID\r
722                      group by A.ID\r
723                      """ % (Table.Table, Table.Table, Model, Model)\r
724         RecordSet = Table.Exec(SqlCommand)\r
725         for Record in RecordSet:\r
726             if not EccGlobalData.gException.IsException(ErrorID, Record[1]):\r
727                 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
728 \r
729     # Naming Convention Check\r
730     def NamingConventionCheck(self):\r
731 \r
732         for Dirpath, Dirnames, Filenames in self.WalkTree():\r
733             for F in Filenames:\r
734                 if os.path.splitext(F)[1] in ('.h', '.c'):\r
735                     FullName = os.path.join(Dirpath, F)\r
736                     Id = c.GetTableID(FullName)\r
737                     if Id < 0:\r
738                         continue\r
739                     FileTable = 'Identifier' + str(Id)\r
740                     self.NamingConventionCheckDefineStatement(FileTable)\r
741                     self.NamingConventionCheckTypedefStatement(FileTable)\r
742                     self.NamingConventionCheckIfndefStatement(FileTable)\r
743                     self.NamingConventionCheckVariableName(FileTable)\r
744                     self.NamingConventionCheckSingleCharacterVariable(FileTable)\r
745 \r
746         self.NamingConventionCheckPathName()\r
747         self.NamingConventionCheckFunctionName()\r
748 \r
749     # Check whether only capital letters are used for #define declarations\r
750     def NamingConventionCheckDefineStatement(self, FileTable):\r
751         if EccGlobalData.gConfig.NamingConventionCheckDefineStatement == '1' or EccGlobalData.gConfig.NamingConventionCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
752             EdkLogger.quiet("Checking naming covention of #define statement ...")\r
753 \r
754             SqlCommand = """select ID, Value from %s where Model = %s""" %(FileTable, MODEL_IDENTIFIER_MACRO_DEFINE)\r
755             RecordSet = EccGlobalData.gDb.TblFile.Exec(SqlCommand)\r
756             for Record in RecordSet:\r
757                 Name = Record[1].strip().split()[1]\r
758                 if Name.find('(') != -1:\r
759                     Name = Name[0:Name.find('(')]\r
760                 if Name.upper() != Name:\r
761                     if not EccGlobalData.gException.IsException(ERROR_NAMING_CONVENTION_CHECK_DEFINE_STATEMENT, Name):\r
762                         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
763 \r
764     # Check whether only capital letters are used for typedef declarations\r
765     def NamingConventionCheckTypedefStatement(self, FileTable):\r
766         if EccGlobalData.gConfig.NamingConventionCheckTypedefStatement == '1' or EccGlobalData.gConfig.NamingConventionCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
767             EdkLogger.quiet("Checking naming covention of #typedef statement ...")\r
768 \r
769             SqlCommand = """select ID, Name from %s where Model = %s""" %(FileTable, MODEL_IDENTIFIER_TYPEDEF)\r
770             RecordSet = EccGlobalData.gDb.TblFile.Exec(SqlCommand)\r
771             for Record in RecordSet:\r
772                 Name = Record[1].strip()\r
773                 if Name != '' and Name != None:\r
774                     if Name[0] == '(':\r
775                         Name = Name[1:Name.find(')')]\r
776                     if Name.find('(') > -1:\r
777                         Name = Name[Name.find('(') + 1 : Name.find(')')]\r
778                     Name = Name.replace('WINAPI', '')\r
779                     Name = Name.replace('*', '').strip()\r
780                     if Name.upper() != Name:\r
781                         if not EccGlobalData.gException.IsException(ERROR_NAMING_CONVENTION_CHECK_TYPEDEF_STATEMENT, Name):\r
782                             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
783 \r
784     # Check whether the #ifndef at the start of an include file uses both prefix and postfix underscore characters, '_'.\r
785     def NamingConventionCheckIfndefStatement(self, FileTable):\r
786         if EccGlobalData.gConfig.NamingConventionCheckTypedefStatement == '1' or EccGlobalData.gConfig.NamingConventionCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
787             EdkLogger.quiet("Checking naming covention of #ifndef statement ...")\r
788 \r
789             SqlCommand = """select ID, Value from %s where Model = %s""" %(FileTable, MODEL_IDENTIFIER_MACRO_IFNDEF)\r
790             RecordSet = EccGlobalData.gDb.TblFile.Exec(SqlCommand)\r
791             for Record in RecordSet:\r
792                 Name = Record[1].replace('#ifndef', '').strip()\r
793                 if Name[0] != '_' or Name[-1] != '_':\r
794                     if not EccGlobalData.gException.IsException(ERROR_NAMING_CONVENTION_CHECK_IFNDEF_STATEMENT, Name):\r
795                         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
796 \r
797     # Rule for path name, variable name and function name\r
798     # 1. First character should be upper case\r
799     # 2. Existing lower case in a word\r
800     # 3. No space existence\r
801     # Check whether the path name followed the rule\r
802     def NamingConventionCheckPathName(self):\r
803         if EccGlobalData.gConfig.NamingConventionCheckPathName == '1' or EccGlobalData.gConfig.NamingConventionCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
804             EdkLogger.quiet("Checking naming covention of file path name ...")\r
805             Pattern = re.compile(r'^[A-Z]+\S*[a-z]\S*$')\r
806             SqlCommand = """select ID, Name from File"""\r
807             RecordSet = EccGlobalData.gDb.TblFile.Exec(SqlCommand)\r
808             for Record in RecordSet:\r
809                 if not Pattern.match(Record[1]):\r
810                     if not EccGlobalData.gException.IsException(ERROR_NAMING_CONVENTION_CHECK_PATH_NAME, Record[1]):\r
811                         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
812 \r
813     # Rule for path name, variable name and function name\r
814     # 1. First character should be upper case\r
815     # 2. Existing lower case in a word\r
816     # 3. No space existence\r
817     # 4. Global variable name must start with a 'g'\r
818     # Check whether the variable name followed the rule\r
819     def NamingConventionCheckVariableName(self, FileTable):\r
820         if EccGlobalData.gConfig.NamingConventionCheckVariableName == '1' or EccGlobalData.gConfig.NamingConventionCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
821             EdkLogger.quiet("Checking naming covention of variable name ...")\r
822             Pattern = re.compile(r'^[A-Zgm]+\S*[a-z]\S*$')\r
823 \r
824             SqlCommand = """select ID, Name from %s where Model = %s""" %(FileTable, MODEL_IDENTIFIER_VARIABLE)\r
825             RecordSet = EccGlobalData.gDb.TblFile.Exec(SqlCommand)\r
826             for Record in RecordSet:\r
827                 if not Pattern.match(Record[1]):\r
828                     if not EccGlobalData.gException.IsException(ERROR_NAMING_CONVENTION_CHECK_VARIABLE_NAME, Record[1]):\r
829                         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
830 \r
831     # Rule for path name, variable name and function name\r
832     # 1. First character should be upper case\r
833     # 2. Existing lower case in a word\r
834     # 3. No space existence\r
835     # Check whether the function name followed the rule\r
836     def NamingConventionCheckFunctionName(self):\r
837         if EccGlobalData.gConfig.NamingConventionCheckFunctionName == '1' or EccGlobalData.gConfig.NamingConventionCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
838             EdkLogger.quiet("Checking naming covention of function name ...")\r
839             Pattern = re.compile(r'^[A-Z]+\S*[a-z]\S*$')\r
840             SqlCommand = """select ID, Name from Function"""\r
841             RecordSet = EccGlobalData.gDb.TblFile.Exec(SqlCommand)\r
842             for Record in RecordSet:\r
843                 if not Pattern.match(Record[1]):\r
844                     if not EccGlobalData.gException.IsException(ERROR_NAMING_CONVENTION_CHECK_FUNCTION_NAME, Record[1]):\r
845                         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
846 \r
847     # Check whether NO use short variable name with single character\r
848     def NamingConventionCheckSingleCharacterVariable(self, FileTable):\r
849         if EccGlobalData.gConfig.NamingConventionCheckSingleCharacterVariable == '1' or EccGlobalData.gConfig.NamingConventionCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
850             EdkLogger.quiet("Checking naming covention of single character variable name ...")\r
851 \r
852             SqlCommand = """select ID, Name from %s where Model = %s""" %(FileTable, MODEL_IDENTIFIER_VARIABLE)\r
853             RecordSet = EccGlobalData.gDb.TblFile.Exec(SqlCommand)\r
854             for Record in RecordSet:\r
855                 Variable = Record[1].replace('*', '')\r
856                 if len(Variable) == 1:\r
857                     if not EccGlobalData.gException.IsException(ERROR_NAMING_CONVENTION_CHECK_SINGLE_CHARACTER_VARIABLE, Record[1]):\r
858                         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
859 \r
860 ##\r
861 #\r
862 # This acts like the main() function for the script, unless it is 'import'ed into another\r
863 # script.\r
864 #\r
865 if __name__ == '__main__':\r
866     Check = Check()\r
867     Check.Check()\r