0fe538354e2bee5cd63ee8b420032120a582cdcf
[people/mcb30/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, 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 EccToolError import *\r
17 import EccGlobalData\r
18 import c\r
19 \r
20 ## Check\r
21 #\r
22 # This class is to define checkpoints used by ECC tool\r
23 #\r
24 # @param object:          Inherited from object class\r
25 #\r
26 class Check(object):\r
27     def __init__(self):\r
28         pass\r
29      \r
30     #\r
31     # Check all required checkpoints\r
32     #   \r
33     def Check(self):\r
34         self.MetaDataFileCheck()\r
35         self.DoxygenCheck()\r
36         self.IncludeFileCheck()\r
37         self.PredicateExpressionCheck()\r
38         self.DeclAndDataTypeCheck()\r
39         self.NamingConventionCheck()\r
40     \r
41     #\r
42     # Declarations and Data Types Checking\r
43     #\r
44     def DeclAndDataTypeCheck(self):\r
45         self.DeclCheckNoUseCType()\r
46         self.DeclCheckInOutModifier()\r
47         self.DeclCheckEFIAPIModifier()\r
48         self.DeclCheckEnumeratedType()\r
49         self.DeclCheckStructureDeclaration()\r
50         self.DeclCheckUnionType()\r
51     \r
52     \r
53     # Check whether no use of int, unsigned, char, void, static, long in any .c, .h or .asl files.\r
54     def DeclCheckNoUseCType(self):\r
55         if EccGlobalData.gConfig.DeclarationDataTypeCheckNoUseCType == '1' or EccGlobalData.gConfig.DeclarationDataTypeCheckAll == '1':\r
56             EdkLogger.quiet("Checking Declaration No use C type ...")\r
57             Tuple = os.walk(EccGlobalData.gTarget)\r
58             IgnoredPattern = re.compile(r'.*[\\/](?:BUILD|CVS|\.SVN|INTELRESTRICTEDTOOLS|INTELRESTRICTEDPKG)[\\/].*')\r
59         \r
60             for Dirpath, Dirnames, Filenames in Tuple:\r
61                 if IgnoredPattern.match(Dirpath.upper()) or Dirpath.find('.svn') != -1:\r
62                     continue\r
63                 for F in Filenames:\r
64                     if os.path.splitext(F)[1] in ('.h', '.c'):\r
65                         FullName = os.path.join(Dirpath, F)\r
66                         c.CheckDeclNoUseCType(FullName)\r
67     \r
68     # 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
69     def DeclCheckInOutModifier(self):\r
70         if EccGlobalData.gConfig.DeclarationDataTypeCheckInOutModifier == '1' or EccGlobalData.gConfig.DeclarationDataTypeCheckAll == '1':\r
71             EdkLogger.quiet("Checking Declaration argument modifier ...")\r
72             Tuple = os.walk(EccGlobalData.gTarget)\r
73             IgnoredPattern = re.compile(r'.*[\\/](?:BUILD|CVS|\.SVN|INTELRESTRICTEDTOOLS|INTELRESTRICTEDPKG)[\\/].*')\r
74         \r
75             for Dirpath, Dirnames, Filenames in Tuple:\r
76                 if IgnoredPattern.match(Dirpath.upper()) or Dirpath.find('.svn') != -1:\r
77                     continue\r
78                 for F in Filenames:\r
79                     if os.path.splitext(F)[1] in ('.h', '.c'):\r
80                         FullName = os.path.join(Dirpath, F)\r
81                         c.CheckDeclArgModifier(FullName)\r
82     \r
83     # Check whether the EFIAPI modifier should be used at the entry of drivers, events, and member functions of protocols\r
84     def DeclCheckEFIAPIModifier(self):\r
85         if EccGlobalData.gConfig.DeclarationDataTypeCheckEFIAPIModifier == '1' or EccGlobalData.gConfig.DeclarationDataTypeCheckAll == '1':\r
86             pass\r
87     \r
88     # Check whether Enumerated Type has a 'typedef' and the name is capital\r
89     def DeclCheckEnumeratedType(self):\r
90         if EccGlobalData.gConfig.DeclarationDataTypeCheckEnumeratedType == '1' or EccGlobalData.gConfig.DeclarationDataTypeCheckAll == '1':\r
91             pass\r
92     \r
93     # Check whether Structure Type has a 'typedef' and the name is capital\r
94     def DeclCheckStructureDeclaration(self):\r
95         if EccGlobalData.gConfig.DeclarationDataTypeCheckStructureDeclaration == '1' or EccGlobalData.gConfig.DeclarationDataTypeCheckAll == '1':\r
96             pass\r
97     \r
98     # Check whether Union Type has a 'typedef' and the name is capital\r
99     def DeclCheckUnionType(self):\r
100         if EccGlobalData.gConfig.DeclarationDataTypeCheckUnionType == '1' or EccGlobalData.gConfig.DeclarationDataTypeCheckAll == '1':\r
101             pass\r
102     \r
103     #\r
104     # Predicate Expression Checking\r
105     #\r
106     def PredicateExpressionCheck(self):\r
107         self.PredicateExpressionCheckBooleanValue()\r
108         self.PredicateExpressionCheckNonBooleanOperator()\r
109         self.PredicateExpressionCheckComparisonNullType()\r
110     \r
111     # Check whether Boolean values, variable type BOOLEAN not use explicit comparisons to TRUE or FALSE\r
112     def PredicateExpressionCheckBooleanValue(self):\r
113         if EccGlobalData.gConfig.PredicateExpressionCheckBooleanValue == '1' or EccGlobalData.gConfig.PredicateExpressionCheckAll == '1':\r
114             EdkLogger.quiet("Checking predicate expression Boolean value ...")\r
115             Tuple = os.walk(EccGlobalData.gTarget)\r
116             IgnoredPattern = re.compile(r'.*[\\/](?:BUILD|CVS|\.SVN|INTELRESTRICTEDTOOLS|INTELRESTRICTEDPKG)[\\/].*')\r
117         \r
118             for Dirpath, Dirnames, Filenames in Tuple:\r
119                 if IgnoredPattern.match(Dirpath.upper()) or Dirpath.find('.svn') != -1:\r
120                     continue\r
121                 for F in Filenames:\r
122                     if os.path.splitext(F)[1] in ('.c'):\r
123                         FullName = os.path.join(Dirpath, F)\r
124                         c.CheckBooleanValueComparison(FullName)\r
125     # Check whether Non-Boolean comparisons use a compare operator (==, !=, >, < >=, <=). \r
126     def PredicateExpressionCheckNonBooleanOperator(self):\r
127         if EccGlobalData.gConfig.PredicateExpressionCheckNonBooleanOperator == '1' or EccGlobalData.gConfig.PredicateExpressionCheckAll == '1':\r
128             EdkLogger.quiet("Checking predicate expression Non-Boolean variable...")\r
129             Tuple = os.walk(EccGlobalData.gTarget)\r
130             IgnoredPattern = re.compile(r'.*[\\/](?:BUILD|CVS|\.SVN|INTELRESTRICTEDTOOLS|INTELRESTRICTEDPKG)[\\/].*')\r
131         \r
132             for Dirpath, Dirnames, Filenames in Tuple:\r
133                 if IgnoredPattern.match(Dirpath.upper()) or Dirpath.find('.svn') != -1:\r
134                     continue\r
135                 for F in Filenames:\r
136                     if os.path.splitext(F)[1] in ('.c'):\r
137                         FullName = os.path.join(Dirpath, F)\r
138                         c.CheckNonBooleanValueComparison(FullName)\r
139     # Check whether a comparison of any pointer to zero must be done via the NULL type\r
140     def PredicateExpressionCheckComparisonNullType(self):\r
141         if EccGlobalData.gConfig.PredicateExpressionCheckComparisonNullType == '1' or EccGlobalData.gConfig.PredicateExpressionCheckAll == '1':\r
142             EdkLogger.quiet("Checking predicate expression NULL pointer ...")\r
143             Tuple = os.walk(EccGlobalData.gTarget)\r
144             IgnoredPattern = re.compile(r'.*[\\/](?:BUILD|CVS|\.SVN|INTELRESTRICTEDTOOLS|INTELRESTRICTEDPKG)[\\/].*')\r
145         \r
146             for Dirpath, Dirnames, Filenames in Tuple:\r
147                 if IgnoredPattern.match(Dirpath.upper()) or Dirpath.find('.svn') != -1:\r
148                     continue\r
149                 for F in Filenames:\r
150                     if os.path.splitext(F)[1] in ('.c'):\r
151                         FullName = os.path.join(Dirpath, F)\r
152                         c.CheckPointerNullComparison(FullName)\r
153     #\r
154     # Include file checking\r
155     #\r
156     def IncludeFileCheck(self):\r
157         self.IncludeFileCheckIfndef()\r
158         self.IncludeFileCheckData()\r
159     \r
160     #\r
161     # Check whether all include file contents is guarded by a #ifndef statement.\r
162     #\r
163     def IncludeFileCheckIfndef(self):\r
164         if EccGlobalData.gConfig.IncludeFileCheckIfndefStatement == '1' or EccGlobalData.gConfig.IncludeFileCheckAll == '1':\r
165             EdkLogger.quiet("Checking header file ifndef ...")\r
166             Tuple = os.walk(EccGlobalData.gTarget)\r
167             IgnoredPattern = re.compile(r'.*[\\/](?:BUILD|CVS|\.SVN|INTELRESTRICTEDTOOLS|INTELRESTRICTEDPKG)[\\/].*')\r
168         \r
169             for Dirpath, Dirnames, Filenames in Tuple:\r
170                 if IgnoredPattern.match(Dirpath.upper()) or Dirpath.find('.svn') != -1:\r
171                     continue\r
172                 for F in Filenames:\r
173                     if os.path.splitext(F)[1] in ('.h'):\r
174                         FullName = os.path.join(Dirpath, F)\r
175                         MsgList = c.CheckHeaderFileIfndef(FullName)\r
176     \r
177     #\r
178     # Check whether include files NOT contain code or define data variables\r
179     #\r
180     def IncludeFileCheckData(self):\r
181         if EccGlobalData.gConfig.IncludeFileCheckData == '1' or EccGlobalData.gConfig.IncludeFileCheckAll == '1':\r
182             EdkLogger.quiet("Checking header file data ...")\r
183             Tuple = os.walk(EccGlobalData.gTarget)\r
184             IgnoredPattern = re.compile(r'.*[\\/](?:BUILD|CVS|\.SVN|INTELRESTRICTEDTOOLS|INTELRESTRICTEDPKG)[\\/].*')\r
185         \r
186             for Dirpath, Dirnames, Filenames in Tuple:\r
187                 if IgnoredPattern.match(Dirpath.upper()) or Dirpath.find('.svn') != -1:\r
188                     continue\r
189                 for F in Filenames:\r
190                     if os.path.splitext(F)[1] in ('.h'):\r
191                         FullName = os.path.join(Dirpath, F)\r
192                         MsgList = c.CheckHeaderFileData(FullName)\r
193         \r
194     #\r
195     # Doxygen document checking\r
196     #\r
197     def DoxygenCheck(self):\r
198         self.DoxygenCheckFileHeader()\r
199         self.DoxygenCheckFunctionHeader()\r
200         self.DoxygenCheckCommentDescription()\r
201         self.DoxygenCheckCommentFormat()\r
202         self.DoxygenCheckCommand()\r
203     \r
204     #\r
205     # Check whether the file headers are followed Doxygen special documentation blocks in section 2.3.5\r
206     #\r
207     def DoxygenCheckFileHeader(self):\r
208         if EccGlobalData.gConfig.DoxygenCheckFileHeader == '1' or EccGlobalData.gConfig.DoxygenCheckAll == '1':\r
209             EdkLogger.quiet("Checking Doxygen file header ...")\r
210             Tuple = os.walk(EccGlobalData.gTarget)\r
211             IgnoredPattern = re.compile(r'.*[\\/](?:BUILD|CVS|\.SVN|INTELRESTRICTEDTOOLS|INTELRESTRICTEDPKG)[\\/].*')\r
212         \r
213             for Dirpath, Dirnames, Filenames in Tuple:\r
214                 if IgnoredPattern.match(Dirpath.upper()) or Dirpath.find('.svn') != -1:\r
215                     continue\r
216                 for F in Filenames:\r
217                     if os.path.splitext(F)[1] in ('.h', '.c'):\r
218                         FullName = os.path.join(Dirpath, F)\r
219                         MsgList = c.CheckFileHeaderDoxygenComments(FullName)\r
220     \r
221     #\r
222     # Check whether the function headers are followed Doxygen special documentation blocks in section 2.3.5\r
223     #\r
224     def DoxygenCheckFunctionHeader(self):\r
225         if EccGlobalData.gConfig.DoxygenCheckFunctionHeader == '1' or EccGlobalData.gConfig.DoxygenCheckAll == '1':\r
226             EdkLogger.quiet("Checking Doxygen function header ...")\r
227             Tuple = os.walk(EccGlobalData.gTarget)\r
228             IgnoredPattern = re.compile(r'.*[\\/](?:BUILD|CVS|\.SVN|INTELRESTRICTEDTOOLS|INTELRESTRICTEDPKG)[\\/].*')\r
229 #            ParseErrorFileList = []\r
230         \r
231             for Dirpath, Dirnames, Filenames in Tuple:\r
232                 if IgnoredPattern.match(Dirpath.upper()) or Dirpath.find('.svn') != -1:\r
233                     continue\r
234                 for F in Filenames:\r
235                     if os.path.splitext(F)[1] in ('.h', '.c'):\r
236                         FullName = os.path.join(Dirpath, F)\r
237                         MsgList = c.CheckFuncHeaderDoxygenComments(FullName)\r
238 #                        for Msg in MsgList:\r
239 #                            print Msg                \r
240                             \r
241     #\r
242     # Check whether the first line of text in a comment block is a brief description of the element being documented. \r
243     # The brief description must end with a period.\r
244     #\r
245     def DoxygenCheckCommentDescription(self):\r
246         if EccGlobalData.gConfig.DoxygenCheckCommentDescription == '1' or EccGlobalData.gConfig.DoxygenCheckAll == '1':\r
247             pass\r
248 \r
249     #\r
250     # Check whether comment lines with '///< ... text ...' format, if it is used, it should be after the code section.\r
251     #\r
252     def DoxygenCheckCommentFormat(self):\r
253         if EccGlobalData.gConfig.DoxygenCheckCommentFormat == '1' or EccGlobalData.gConfig.DoxygenCheckAll == '1':\r
254             EdkLogger.quiet("Checking Doxygen comment ///< ...")\r
255             Tuple = os.walk(EccGlobalData.gTarget)\r
256             IgnoredPattern = re.compile(r'.*[\\/](?:BUILD|CVS|\.SVN|INTELRESTRICTEDTOOLS|INTELRESTRICTEDPKG)[\\/].*')\r
257         \r
258             for Dirpath, Dirnames, Filenames in Tuple:\r
259                 if IgnoredPattern.match(Dirpath.upper()) or Dirpath.find('.svn') != -1:\r
260                     continue\r
261                 for F in Filenames:\r
262                     if os.path.splitext(F)[1] in ('.h', '.c'):\r
263                         FullName = os.path.join(Dirpath, F)\r
264                         MsgList = c.CheckDoxygenTripleForwardSlash(FullName)\r
265         \r
266     #\r
267     # Check whether only Doxygen commands allowed to mark the code are @bug and @todo.\r
268     #\r
269     def DoxygenCheckCommand(self):\r
270         if EccGlobalData.gConfig.DoxygenCheckCommand == '1' or EccGlobalData.gConfig.DoxygenCheckAll == '1':\r
271             EdkLogger.quiet("Checking Doxygen command ...")\r
272             Tuple = os.walk(EccGlobalData.gTarget)\r
273             IgnoredPattern = re.compile(r'.*[\\/](?:BUILD|CVS|\.SVN|INTELRESTRICTEDTOOLS|INTELRESTRICTEDPKG)[\\/].*')\r
274         \r
275             for Dirpath, Dirnames, Filenames in Tuple:\r
276                 if IgnoredPattern.match(Dirpath.upper()) or Dirpath.find('.svn') != -1:\r
277                     continue\r
278                 for F in Filenames:\r
279                     if os.path.splitext(F)[1] in ('.h', '.c'):\r
280                         FullName = os.path.join(Dirpath, F)\r
281                         MsgList = c.CheckDoxygenCommand(FullName)\r
282     \r
283     #\r
284     # Meta-Data File Processing Checking\r
285     #\r
286     def MetaDataFileCheck(self):\r
287         self.MetaDataFileCheckPathName()\r
288         self.MetaDataFileCheckGenerateFileList()\r
289         self.MetaDataFileCheckLibraryInstance()\r
290         self.MetaDataFileCheckLibraryInstanceDependent()\r
291         self.MetaDataFileCheckLibraryInstanceOrder()\r
292         self.MetaDataFileCheckLibraryNoUse()\r
293         self.MetaDataFileCheckBinaryInfInFdf()\r
294         self.MetaDataFileCheckPcdDuplicate()\r
295         self.MetaDataFileCheckPcdFlash()\r
296         self.MetaDataFileCheckPcdNoUse()\r
297         self.MetaDataFileCheckGuidDuplicate()\r
298 \r
299     #\r
300     # Check whether each file defined in meta-data exists\r
301     #\r
302     def MetaDataFileCheckPathName(self):\r
303         if EccGlobalData.gConfig.MetaDataFileCheckPathName == '1' or EccGlobalData.gConfig.MetaDataFileCheckAll == '1':\r
304             # This item is covered when parsing Inf/Dec/Dsc files\r
305             pass\r
306     \r
307     #\r
308     # Generate a list for all files defined in meta-data files\r
309     #\r
310     def MetaDataFileCheckGenerateFileList(self):\r
311         if EccGlobalData.gConfig.MetaDataFileCheckGenerateFileList == '1' or EccGlobalData.gConfig.MetaDataFileCheckAll == '1':\r
312             # This item is covered when parsing Inf/Dec/Dsc files\r
313             pass\r
314     \r
315     #\r
316     # Check whether all Library Instances defined for a given module (or dependent library instance) match the module's type.  \r
317     # Each Library Instance must specify the Supported Module Types in its Inf file, \r
318     # and any module specifying the library instance must be one of the supported types.\r
319     #\r
320     def MetaDataFileCheckLibraryInstance(self):\r
321         if EccGlobalData.gConfig.MetaDataFileCheckLibraryInstance == '1' or EccGlobalData.gConfig.MetaDataFileCheckAll == '1':\r
322             pass\r
323 \r
324     #\r
325     # Check whether a Library Instance has been defined for all dependent library classes\r
326     #\r
327     def MetaDataFileCheckLibraryInstanceDependent(self):\r
328         if EccGlobalData.gConfig.MetaDataFileCheckLibraryInstanceDependent == '1' or EccGlobalData.gConfig.MetaDataFileCheckAll == '1':\r
329             pass\r
330 \r
331     #\r
332     # Check whether the Library Instances specified by the LibraryClasses sections are listed in order of dependencies\r
333     #\r
334     def MetaDataFileCheckLibraryInstanceOrder(self):\r
335         if EccGlobalData.gConfig.MetaDataFileCheckLibraryInstanceOrder == '1' or EccGlobalData.gConfig.MetaDataFileCheckAll == '1':\r
336             pass\r
337 \r
338     #\r
339     # Check whether the unnecessary inclusion of library classes in the Inf file\r
340     #\r
341     def MetaDataFileCheckLibraryNoUse(self):\r
342         if EccGlobalData.gConfig.MetaDataFileCheckLibraryNoUse == '1' or EccGlobalData.gConfig.MetaDataFileCheckAll == '1':\r
343             pass\r
344 \r
345     #\r
346     # 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
347     #\r
348     def MetaDataFileCheckBinaryInfInFdf(self):\r
349         if EccGlobalData.gConfig.MetaDataFileCheckBinaryInfInFdf == '1' or EccGlobalData.gConfig.MetaDataFileCheckAll == '1':\r
350             EdkLogger.quiet("Checking for non-binary modules defined in FDF files ...")\r
351             SqlCommand = """select A.ID, A.Value1 from Fdf as A\r
352                          where A.Model = %s\r
353                          and A.Enabled > -1\r
354                          and A.Value1 not in \r
355                          (select B.Value1 from Dsc as B\r
356                          where B.Model = %s\r
357                          and B.Enabled > -1)""" % (MODEL_META_DATA_COMPONENT, MODEL_META_DATA_COMPONENT)\r
358             RecordSet = EccGlobalData.gDb.TblFdf.Exec(SqlCommand)\r
359             for Record in RecordSet:\r
360                 FdfID = Record[0]\r
361                 FilePath = Record[1]\r
362                 FilePath = os.path.normpath(os.path.join(EccGlobalData.gWorkspace, FilePath))\r
363                 SqlCommand = """select ID from Inf where Model = %s and BelongsToFile = (select ID from File where FullPath like '%s')\r
364                                 """ % (MODEL_EFI_SOURCE_FILE, FilePath)\r
365                 NewRecordSet = EccGlobalData.gDb.TblFile.Exec(SqlCommand)\r
366                 if NewRecordSet!= []:\r
367                     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
368 \r
369     #\r
370     # Check whether a PCD is set in a Dsc file or the FDF file, but not in both.\r
371     #\r
372     def MetaDataFileCheckPcdDuplicate(self):\r
373         if EccGlobalData.gConfig.MetaDataFileCheckPcdDuplicate == '1' or EccGlobalData.gConfig.MetaDataFileCheckAll == '1':\r
374             EdkLogger.quiet("Checking for duplicate PCDs defined in both DSC and FDF files ...")\r
375             SqlCommand = """\r
376                          select A.ID, A.Value2, B.ID, B.Value2 from Dsc as A, Fdf as B \r
377                          where A.Model >= %s and A.Model < %s \r
378                          and B.Model >= %s and B.Model < %s \r
379                          and A.Value2 = B.Value2\r
380                          and A.Enabled > -1\r
381                          and B.Enabled > -1\r
382                          """% (MODEL_PCD, MODEL_META_DATA_HEADER, MODEL_PCD, MODEL_META_DATA_HEADER)\r
383             RecordSet = EccGlobalData.gDb.TblDsc.Exec(SqlCommand)\r
384             for Record in RecordSet:\r
385                 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
386                 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
387 \r
388     #\r
389     # Check whether PCD settings in the FDF file can only be related to flash.\r
390     #\r
391     def MetaDataFileCheckPcdFlash(self):\r
392         if EccGlobalData.gConfig.MetaDataFileCheckPcdFlash == '1' or EccGlobalData.gConfig.MetaDataFileCheckAll == '1':\r
393             EdkLogger.quiet("Checking only Flash related PCDs are used in FDF ...")\r
394             SqlCommand = """\r
395                          select ID, Value2, BelongsToFile from Fdf as A\r
396                          where A.Model >= %s and Model < %s\r
397                          and A.Enabled > -1\r
398                          and A.Value2 not like '%%Flash%%'\r
399                          """% (MODEL_PCD, MODEL_META_DATA_HEADER)\r
400             RecordSet = EccGlobalData.gDb.TblFdf.Exec(SqlCommand)\r
401             for Record in RecordSet:\r
402                 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
403         \r
404     #\r
405     # Check whether PCDs used in Inf files but not specified in Dsc or FDF files\r
406     #\r
407     def MetaDataFileCheckPcdNoUse(self):\r
408         if EccGlobalData.gConfig.MetaDataFileCheckPcdNoUse == '1' or EccGlobalData.gConfig.MetaDataFileCheckAll == '1':\r
409             EdkLogger.quiet("Checking for non-specified PCDs ...")\r
410             SqlCommand = """\r
411                          select ID, Value2, BelongsToFile from Inf as A \r
412                          where A.Model >= %s and Model < %s\r
413                          and A.Enabled > -1\r
414                          and A.Value2 not in \r
415                              (select Value2 from Dsc as B \r
416                               where B.Model >= %s and B.Model < %s\r
417                               and B.Enabled > -1)\r
418                          and A.Value2 not in\r
419                              (select Value2 from Fdf as C \r
420                               where C.Model >= %s and C.Model < %s\r
421                               and C.Enabled > -1)\r
422                          """% (MODEL_PCD, MODEL_META_DATA_HEADER, MODEL_PCD, MODEL_META_DATA_HEADER, MODEL_PCD, MODEL_META_DATA_HEADER)\r
423             RecordSet = EccGlobalData.gDb.TblInf.Exec(SqlCommand)\r
424             for Record in RecordSet:\r
425                 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
426         \r
427     #\r
428     # Check whether having duplicate guids defined for Guid/Protocol/Ppi\r
429     #\r
430     def MetaDataFileCheckGuidDuplicate(self):\r
431         if EccGlobalData.gConfig.MetaDataFileCheckGuidDuplicate == '1' or EccGlobalData.gConfig.MetaDataFileCheckAll == '1':\r
432             EdkLogger.quiet("Checking for duplicate GUID/PPI/PROTOCOL ...")\r
433             #\r
434             # Check Guid\r
435             #\r
436             self.CheckGuidProtocolPpi(ERROR_META_DATA_FILE_CHECK_DUPLICATE_GUID, MODEL_EFI_GUID, EccGlobalData.gDb.TblDec)\r
437             self.CheckGuidProtocolPpi(ERROR_META_DATA_FILE_CHECK_DUPLICATE_GUID, MODEL_EFI_GUID, EccGlobalData.gDb.TblDsc)\r
438             self.CheckGuidProtocolPpiValue(ERROR_META_DATA_FILE_CHECK_DUPLICATE_GUID, MODEL_EFI_GUID)\r
439             #\r
440             # Check protocol\r
441             #\r
442             self.CheckGuidProtocolPpi(ERROR_META_DATA_FILE_CHECK_DUPLICATE_PROTOCOL, MODEL_EFI_PROTOCOL, EccGlobalData.gDb.TblDec)\r
443             self.CheckGuidProtocolPpi(ERROR_META_DATA_FILE_CHECK_DUPLICATE_PROTOCOL, MODEL_EFI_PROTOCOL, EccGlobalData.gDb.TblDsc)\r
444             self.CheckGuidProtocolPpiValue(ERROR_META_DATA_FILE_CHECK_DUPLICATE_PROTOCOL, MODEL_EFI_PROTOCOL)\r
445             #\r
446             # Check ppi\r
447             #\r
448             self.CheckGuidProtocolPpi(ERROR_META_DATA_FILE_CHECK_DUPLICATE_PPI, MODEL_EFI_PPI, EccGlobalData.gDb.TblDec)\r
449             self.CheckGuidProtocolPpi(ERROR_META_DATA_FILE_CHECK_DUPLICATE_PPI, MODEL_EFI_PPI, EccGlobalData.gDb.TblDsc)\r
450             self.CheckGuidProtocolPpiValue(ERROR_META_DATA_FILE_CHECK_DUPLICATE_PPI, MODEL_EFI_PPI)\r
451 \r
452             #EdkLogger.quiet("Checking duplicate guid/ppi/protocol done!")\r
453     \r
454     #\r
455     # Check whether these is duplicate Guid/Ppi/Protocol name\r
456     #\r
457     def CheckGuidProtocolPpi(self, ErrorID, Model, Table):\r
458         Name = ''\r
459         if Model == MODEL_EFI_GUID:\r
460             Name = 'guid'\r
461         if Model == MODEL_EFI_PROTOCOL:\r
462             Name = 'protocol'\r
463         if Model == MODEL_EFI_PPI:\r
464             Name = 'ppi'\r
465         SqlCommand = """\r
466                      select A.ID, A.Value1 from %s as A, %s as B \r
467                      where A.Model = %s and B.Model = %s \r
468                      and A.Value1 = B.Value1 and A.ID <> B.ID \r
469                      and A.Enabled > -1\r
470                      and B.Enabled > -1\r
471                      group by A.ID\r
472                      """ % (Table.Table, Table.Table, Model, Model)\r
473         RecordSet = Table.Exec(SqlCommand)\r
474         for Record in RecordSet:\r
475             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
476 \r
477     #\r
478     # Check whether these is duplicate Guid/Ppi/Protocol value\r
479     #\r
480     def CheckGuidProtocolPpiValue(self, ErrorID, Model):\r
481         Name = ''\r
482         Table = EccGlobalData.gDb.TblDec\r
483         if Model == MODEL_EFI_GUID:\r
484             Name = 'guid'\r
485         if Model == MODEL_EFI_PROTOCOL:\r
486             Name = 'protocol'\r
487         if Model == MODEL_EFI_PPI:\r
488             Name = 'ppi'\r
489         SqlCommand = """\r
490                      select A.ID, A.Value2 from %s as A, %s as B \r
491                      where A.Model = %s and B.Model = %s \r
492                      and A.Value2 = B.Value2 and A.ID <> B.ID \r
493                      group by A.ID\r
494                      """ % (Table.Table, Table.Table, Model, Model)\r
495         RecordSet = Table.Exec(SqlCommand)\r
496         for Record in RecordSet:\r
497             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
498 \r
499     #\r
500     # Naming Convention Check\r
501     #\r
502     def NamingConventionCheck(self):\r
503         self.NamingConventionCheckDefineStatement()\r
504         self.NamingConventionCheckTypedefStatement()\r
505         self.NamingConventionCheckIfndefStatement()\r
506         self.NamingConventionCheckPathName()\r
507         self.NamingConventionCheckVariableName()\r
508         self.NamingConventionCheckFunctionName()\r
509         self.NamingConventionCheckSingleCharacterVariable()\r
510         \r
511     #\r
512     # Check whether only capital letters are used for #define declarations\r
513     #\r
514     def NamingConventionCheckDefineStatement(self):\r
515         if EccGlobalData.gConfig.NamingConventionCheckDefineStatement == '1' or EccGlobalData.gConfig.NamingConventionCheckAll == '1':\r
516             EdkLogger.quiet("Checking naming covention of #define statement ...")\r
517             for IdentifierTable in EccGlobalData.gIdentifierTableList:\r
518                 SqlCommand = """select ID, Value from %s where Model = %s""" %(IdentifierTable, MODEL_IDENTIFIER_MACRO_DEFINE)\r
519                 RecordSet = EccGlobalData.gDb.TblFile.Exec(SqlCommand)\r
520                 for Record in RecordSet:\r
521                     Name = Record[1].strip().split()[1]\r
522                     Name = Name[0:Name.find('(')]\r
523                     if Name.upper() != Name:\r
524                         EccGlobalData.gDb.TblReport.Insert(ERROR_NAMING_CONVENTION_CHECK_DEFINE_STATEMENT, OtherMsg = "The #define name '%s' does not follow the rules" % (Name), BelongsToTable = IdentifierTable, BelongsToItem = Record[0])\r
525     \r
526     #\r
527     # Check whether only capital letters are used for typedef declarations\r
528     #\r
529     def NamingConventionCheckTypedefStatement(self):\r
530         if EccGlobalData.gConfig.NamingConventionCheckTypedefStatement == '1' or EccGlobalData.gConfig.NamingConventionCheckAll == '1':\r
531             EdkLogger.quiet("Checking naming covention of #typedef statement ...")\r
532             for IdentifierTable in EccGlobalData.gIdentifierTableList:\r
533                 SqlCommand = """select ID, Name from %s where Model = %s""" %(IdentifierTable, MODEL_IDENTIFIER_TYPEDEF)\r
534                 RecordSet = EccGlobalData.gDb.TblFile.Exec(SqlCommand)\r
535                 for Record in RecordSet:\r
536                     Name = Record[1].strip()\r
537                     if Name[0] == '(':\r
538                         Name = Name[1:Name.find(')')]\r
539                     if Name.upper() != Name:\r
540                         EccGlobalData.gDb.TblReport.Insert(ERROR_NAMING_CONVENTION_CHECK_TYPEDEF_STATEMENT, OtherMsg = "The #typedef name '%s' does not follow the rules" % (Name), BelongsToTable = IdentifierTable, BelongsToItem = Record[0])\r
541     \r
542     #\r
543     # Check whether the #ifndef at the start of an include file uses both prefix and postfix underscore characters, '_'.\r
544     #\r
545     def NamingConventionCheckIfndefStatement(self):\r
546         if EccGlobalData.gConfig.NamingConventionCheckTypedefStatement == '1' or EccGlobalData.gConfig.NamingConventionCheckAll == '1':\r
547             EdkLogger.quiet("Checking naming covention of #ifndef statement ...")\r
548             for IdentifierTable in EccGlobalData.gIdentifierTableList:\r
549                 SqlCommand = """select ID, Value from %s where Model = %s""" %(IdentifierTable, MODEL_IDENTIFIER_MACRO_IFNDEF)\r
550                 RecordSet = EccGlobalData.gDb.TblFile.Exec(SqlCommand)\r
551                 for Record in RecordSet:\r
552                     Name = Record[1].replace('#ifndef', '').strip()\r
553                     if Name[0] != '_' or Name[-1] != '_':\r
554                         EccGlobalData.gDb.TblReport.Insert(ERROR_NAMING_CONVENTION_CHECK_IFNDEF_STATEMENT, OtherMsg = "The #ifndef name '%s' does not follow the rules" % (Name), BelongsToTable = IdentifierTable, BelongsToItem = Record[0])\r
555     \r
556     #\r
557     # Rule for path name, variable name and function name\r
558     # 1. First character should be upper case\r
559     # 2. Existing lower case in a word\r
560     # 3. No space existence\r
561     # Check whether the path name followed the rule\r
562     #\r
563     def NamingConventionCheckPathName(self):\r
564         if EccGlobalData.gConfig.NamingConventionCheckPathName == '1' or EccGlobalData.gConfig.NamingConventionCheckAll == '1':\r
565             EdkLogger.quiet("Checking naming covention of file path name ...")\r
566             Pattern = re.compile(r'^[A-Z]+\S*[a-z]\S*$')\r
567             SqlCommand = """select ID, Name from File"""\r
568             RecordSet = EccGlobalData.gDb.TblFile.Exec(SqlCommand)\r
569             for Record in RecordSet:\r
570                 if not Pattern.match(Record[1]):\r
571                     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
572     \r
573     #\r
574     # Rule for path name, variable name and function name\r
575     # 1. First character should be upper case\r
576     # 2. Existing lower case in a word\r
577     # 3. No space existence\r
578     # 4. Global variable name must start with a 'g'\r
579     # Check whether the variable name followed the rule\r
580     #\r
581     def NamingConventionCheckVariableName(self):\r
582         if EccGlobalData.gConfig.NamingConventionCheckVariableName == '1' or EccGlobalData.gConfig.NamingConventionCheckAll == '1':\r
583             EdkLogger.quiet("Checking naming covention of variable name ...")\r
584             Pattern = re.compile(r'^[A-Zgm]+\S*[a-z]\S*$')\r
585             for IdentifierTable in EccGlobalData.gIdentifierTableList:\r
586                 SqlCommand = """select ID, Name from %s where Model = %s""" %(IdentifierTable, MODEL_IDENTIFIER_VARIABLE)\r
587                 RecordSet = EccGlobalData.gDb.TblFile.Exec(SqlCommand)\r
588                 for Record in RecordSet:\r
589                     if not Pattern.match(Record[1]):\r
590                         EccGlobalData.gDb.TblReport.Insert(ERROR_NAMING_CONVENTION_CHECK_VARIABLE_NAME, OtherMsg = "The variable name '%s' does not follow the rules" % (Record[1]), BelongsToTable = IdentifierTable, BelongsToItem = Record[0])\r
591 \r
592     #\r
593     # Rule for path name, variable name and function name\r
594     # 1. First character should be upper case\r
595     # 2. Existing lower case in a word\r
596     # 3. No space existence\r
597     # Check whether the function name followed the rule\r
598     #\r
599     def NamingConventionCheckFunctionName(self):\r
600         if EccGlobalData.gConfig.NamingConventionCheckFunctionName == '1' or EccGlobalData.gConfig.NamingConventionCheckAll == '1':\r
601             EdkLogger.quiet("Checking naming covention of function name ...")\r
602             Pattern = re.compile(r'^[A-Z]+\S*[a-z]\S*$')\r
603             SqlCommand = """select ID, Name from Function"""\r
604             RecordSet = EccGlobalData.gDb.TblFile.Exec(SqlCommand)\r
605             for Record in RecordSet:\r
606                 if not Pattern.match(Record[1]):\r
607                     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
608 \r
609     #\r
610     # Check whether NO use short variable name with single character\r
611     #\r
612     def NamingConventionCheckSingleCharacterVariable(self):\r
613         if EccGlobalData.gConfig.NamingConventionCheckSingleCharacterVariable == '1' or EccGlobalData.gConfig.NamingConventionCheckAll == '1':\r
614             EdkLogger.quiet("Checking naming covention of single character variable name ...")\r
615             for IdentifierTable in EccGlobalData.gIdentifierTableList:\r
616                 SqlCommand = """select ID, Name from %s where Model = %s""" %(IdentifierTable, MODEL_IDENTIFIER_VARIABLE)\r
617                 RecordSet = EccGlobalData.gDb.TblFile.Exec(SqlCommand)\r
618                 for Record in RecordSet:\r
619                     Variable = Record[1].replace('*', '')\r
620                     if len(Variable) == 1:\r
621                         EccGlobalData.gDb.TblReport.Insert(ERROR_NAMING_CONVENTION_CHECK_SINGLE_CHARACTER_VARIABLE, OtherMsg = "The variable name '%s' does not follow the rules" % (Record[1]), BelongsToTable = IdentifierTable, BelongsToItem = Record[0])\r
622 \r
623 ##\r
624 #\r
625 # This acts like the main() function for the script, unless it is 'import'ed into another\r
626 # script.\r
627 #\r
628 if __name__ == '__main__':\r
629     Check = Check()\r
630     Check.Check()\r