BaseTools/Source/Python/Ecc/Check.py

   1 ## @file
   2 # This file is used to define checkpoints used by ECC tool
   3 #
   4 # Copyright (c) 2008 - 2018, Intel Corporation. All rights reserved.<BR>
   5 # This program and the accompanying materials
   6 # are licensed and made available under the terms and conditions of the BSD License
   7 # which accompanies this distribution.  The full text of the license may be found at
   8 # http://opensource.org/licenses/bsd-license.php
   9 #
  10 # THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11 # WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12 #
  13 from __future__ import absolute_import
  14 import Common.LongFilePathOs as os
  15 import re
  16 from CommonDataClass.DataClass import *
  17 import Common.DataType as DT
  18 from Ecc.EccToolError import *
  19 from Ecc.MetaDataParser import ParseHeaderCommentSection
  20 from Ecc import EccGlobalData
  21 from Ecc import c
  22 from Common.LongFilePathSupport import OpenLongFilePath as open
  23 from Common.MultipleWorkspace import MultipleWorkspace as mws
  24
  25 ## Check
  26 #
  27 # This class is to define checkpoints used by ECC tool
  28 #
  29 # @param object:          Inherited from object class
  30 #
  31 class Check(object):
  32     def __init__(self):
  33         pass
  34
  35     # Check all required checkpoints
  36     def Check(self):
  37         self.GeneralCheck()
  38         self.MetaDataFileCheck()
  39         self.DoxygenCheck()
  40         self.IncludeFileCheck()
  41         self.PredicateExpressionCheck()
  42         self.DeclAndDataTypeCheck()
  43         self.FunctionLayoutCheck()
  44         self.NamingConventionCheck()
  45         self.SmmCommParaCheck()
  46
  47     def SmmCommParaCheck(self):
  48         self.SmmCommParaCheckBufferType()
  49
  50
  51     # Check if SMM communication function has correct parameter type
  52     # 1. Get function calling with instance./->Communicate() interface
  53     # and make sure the protocol instance is of type EFI_SMM_COMMUNICATION_PROTOCOL.
  54     # 2. Find the origin of the 2nd parameter of Communicate() interface, if -
  55     #    a. it is a local buffer on stack
  56     #       report error.
  57     #    b. it is a global buffer, check the driver that holds the global buffer is of type DXE_RUNTIME_DRIVER
  58     #       report success.
  59     #    c. it is a buffer by AllocatePage/AllocatePool (may be wrapped by nested function calls),
  60     #       check the EFI_MEMORY_TYPE to be EfiRuntimeServicesCode,EfiRuntimeServicesData,
  61     #       EfiACPIMemoryNVS or EfiReservedMemoryType
  62     #       report success.
  63     #    d. it is a buffer located via EFI_SYSTEM_TABLE.ConfigurationTable (may be wrapped by nested function calls)
  64     #       report warning to indicate human code review.
  65     #    e. it is a buffer from other kind of pointers (may need to trace into nested function calls to locate),
  66     #       repeat checks in a.b.c and d.
  67     def SmmCommParaCheckBufferType(self):
  68         if EccGlobalData.gConfig.SmmCommParaCheckBufferType == '1' or EccGlobalData.gConfig.SmmCommParaCheckAll == '1':
  69             EdkLogger.quiet("Checking SMM communication parameter type ...")
  70             # Get all EFI_SMM_COMMUNICATION_PROTOCOL interface
  71             CommApiList = []
  72             for IdentifierTable in EccGlobalData.gIdentifierTableList:
  73                 SqlCommand = """select ID, Name, BelongsToFile from %s
  74                                 where Modifier = 'EFI_SMM_COMMUNICATION_PROTOCOL*' """ % (IdentifierTable)
  75                 RecordSet = EccGlobalData.gDb.TblFile.Exec(SqlCommand)
  76                 if RecordSet:
  77                     for Record in RecordSet:
  78                         if Record[1] not in CommApiList:
  79                             CommApiList.append(Record[1])
  80             # For each interface, check the second parameter
  81             for CommApi in CommApiList:
  82                 for IdentifierTable in EccGlobalData.gIdentifierTableList:
  83                     SqlCommand = """select ID, Name, Value, BelongsToFile, StartLine from %s
  84                     where Name = '%s->Communicate' and Model = %s""" \
  85                     % (IdentifierTable, CommApi, MODEL_IDENTIFIER_FUNCTION_CALLING)
  86                     RecordSet = EccGlobalData.gDb.TblFile.Exec(SqlCommand)
  87                     if RecordSet:
  88                         # print IdentifierTable
  89                         for Record in RecordSet:
  90                             # Get the second parameter for Communicate function
  91                             SecondPara = Record[2].split(',')[1].strip()
  92                             SecondParaIndex = None
  93                             if SecondPara.startswith('&'):
  94                                 SecondPara = SecondPara[1:]
  95                             if SecondPara.endswith(']'):
  96                                 SecondParaIndex = SecondPara[SecondPara.find('[') + 1:-1]
  97                                 SecondPara = SecondPara[:SecondPara.find('[')]
  98                             # Get the ID
  99                             Id = Record[0]
 100                             # Get the BelongsToFile
 101                             BelongsToFile = Record[3]
 102                             # Get the source file path
 103                             SqlCommand = """select FullPath from File where ID = %s""" % BelongsToFile
 104                             NewRecordSet = EccGlobalData.gDb.TblFile.Exec(SqlCommand)
 105                             FullPath = NewRecordSet[0][0]
 106                             # Get the line no of function calling
 107                             StartLine = Record[4]
 108                             # Get the module type
 109                             SqlCommand = """select Value3 from INF where BelongsToFile = (select ID from File
 110                                             where Path = (select Path from File where ID = %s) and Model = 1011)
 111                                             and Value2 = 'MODULE_TYPE'""" % BelongsToFile
 112                             NewRecordSet = EccGlobalData.gDb.TblFile.Exec(SqlCommand)
 113                             ModuleType = NewRecordSet[0][0] if NewRecordSet else None
 114
 115                             # print BelongsToFile, FullPath, StartLine, ModuleType, SecondPara
 116
 117                             Value = FindPara(FullPath, SecondPara, StartLine)
 118                             # Find the value of the parameter
 119                             if Value:
 120                                 if 'AllocatePage' in Value \
 121                                     or 'AllocatePool' in Value \
 122                                     or 'AllocateRuntimePool' in Value \
 123                                     or 'AllocateZeroPool' in Value:
 124                                     pass
 125                                 else:
 126                                     if '->' in Value:
 127                                         if not EccGlobalData.gException.IsException(
 128                                                ERROR_SMM_COMM_PARA_CHECK_BUFFER_TYPE, Value):
 129                                             EccGlobalData.gDb.TblReport.Insert(ERROR_SMM_COMM_PARA_CHECK_BUFFER_TYPE,
 130                                                                                OtherMsg="Please review the buffer type"
 131                                                                                + "is correct or not. If it is correct" +
 132                                                                                " please add [%s] to exception list"
 133                                                                                % Value,
 134                                                                                BelongsToTable=IdentifierTable,
 135                                                                                BelongsToItem=Id)
 136                                     else:
 137                                         if not EccGlobalData.gException.IsException(
 138                                                ERROR_SMM_COMM_PARA_CHECK_BUFFER_TYPE, Value):
 139                                             EccGlobalData.gDb.TblReport.Insert(ERROR_SMM_COMM_PARA_CHECK_BUFFER_TYPE,
 140                                                                                OtherMsg="Please review the buffer type"
 141                                                                                + "is correct or not. If it is correct" +
 142                                                                                " please add [%s] to exception list"
 143                                                                                % Value,
 144                                                                                BelongsToTable=IdentifierTable,
 145                                                                                BelongsToItem=Id)
 146
 147
 148                             # Not find the value of the parameter
 149                             else:
 150                                 SqlCommand = """select ID, Modifier, Name, Value, Model, BelongsToFunction from %s
 151                                                 where Name = '%s' and StartLine < %s order by StartLine DESC""" \
 152                                                 % (IdentifierTable, SecondPara, StartLine)
 153                                 NewRecordSet = EccGlobalData.gDb.TblFile.Exec(SqlCommand)
 154                                 if NewRecordSet:
 155                                     Value = NewRecordSet[0][1]
 156                                     if 'AllocatePage' in Value \
 157                                         or 'AllocatePool' in Value \
 158                                         or 'AllocateRuntimePool' in Value \
 159                                         or 'AllocateZeroPool' in Value:
 160                                         pass
 161                                     else:
 162                                         if not EccGlobalData.gException.IsException(
 163                                             ERROR_SMM_COMM_PARA_CHECK_BUFFER_TYPE, Value):
 164                                             EccGlobalData.gDb.TblReport.Insert(ERROR_SMM_COMM_PARA_CHECK_BUFFER_TYPE,
 165                                                                                OtherMsg="Please review the buffer type"
 166                                                                                + "is correct or not. If it is correct" +
 167                                                                                " please add [%s] to exception list"
 168                                                                                % Value,
 169                                                                                BelongsToTable=IdentifierTable,
 170                                                                                BelongsToItem=Id)
 171                                 else:
 172                                     pass
 173
 174     # Check UNI files
 175     def UniCheck(self):
 176         if EccGlobalData.gConfig.GeneralCheckUni == '1' or EccGlobalData.gConfig.GeneralCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':
 177             EdkLogger.quiet("Checking whether UNI file is UTF-16 ...")
 178             SqlCommand = """select ID, FullPath, ExtName from File where ExtName like 'uni'"""
 179             RecordSet = EccGlobalData.gDb.TblFile.Exec(SqlCommand)
 180             for Record in RecordSet:
 181                 File = Record[1]
 182                 FileIn = open(File, 'rb').read(2)
 183                 if FileIn != '\xff\xfe':
 184                     OtherMsg = "File %s is not a valid UTF-16 UNI file" % Record[1]
 185                     EccGlobalData.gDb.TblReport.Insert(ERROR_GENERAL_CHECK_UNI, OtherMsg=OtherMsg, BelongsToTable='File', BelongsToItem=Record[0])
 186
 187     # General Checking
 188     def GeneralCheck(self):
 189         self.GeneralCheckNonAcsii()
 190         self.UniCheck()
 191         self.GeneralCheckNoTab()
 192         self.GeneralCheckLineEnding()
 193         self.GeneralCheckTrailingWhiteSpaceLine()
 194
 195     # Check whether NO Tab is used, replaced with spaces
 196     def GeneralCheckNoTab(self):
 197         if EccGlobalData.gConfig.GeneralCheckNoTab == '1' or EccGlobalData.gConfig.GeneralCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':
 198             EdkLogger.quiet("Checking No TAB used in file ...")
 199             SqlCommand = """select ID, FullPath, ExtName from File where ExtName in ('.dec', '.inf', '.dsc', 'c', 'h')"""
 200             RecordSet = EccGlobalData.gDb.TblFile.Exec(SqlCommand)
 201             for Record in RecordSet:
 202                 if Record[2].upper() not in EccGlobalData.gConfig.BinaryExtList:
 203                     op = open(Record[1]).readlines()
 204                     IndexOfLine = 0
 205                     for Line in op:
 206                         IndexOfLine += 1
 207                         IndexOfChar = 0
 208                         for Char in Line:
 209                             IndexOfChar += 1
 210                             if Char == '\t':
 211                                 OtherMsg = "File %s has TAB char at line %s column %s" % (Record[1], IndexOfLine, IndexOfChar)
 212                                 EccGlobalData.gDb.TblReport.Insert(ERROR_GENERAL_CHECK_NO_TAB, OtherMsg=OtherMsg, BelongsToTable='File', BelongsToItem=Record[0])
 213
 214     # Check Only use CRLF (Carriage Return Line Feed) line endings.
 215     def GeneralCheckLineEnding(self):
 216         if EccGlobalData.gConfig.GeneralCheckLineEnding == '1' or EccGlobalData.gConfig.GeneralCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':
 217             EdkLogger.quiet("Checking line ending in file ...")
 218             SqlCommand = """select ID, FullPath, ExtName from File where ExtName in ('.dec', '.inf', '.dsc', 'c', 'h')"""
 219             RecordSet = EccGlobalData.gDb.TblFile.Exec(SqlCommand)
 220             for Record in RecordSet:
 221                 if Record[2].upper() not in EccGlobalData.gConfig.BinaryExtList:
 222                     op = open(Record[1], 'rb').readlines()
 223                     IndexOfLine = 0
 224                     for Line in op:
 225                         IndexOfLine += 1
 226                         if not Line.endswith('\r\n'):
 227                             OtherMsg = "File %s has invalid line ending at line %s" % (Record[1], IndexOfLine)
 228                             EccGlobalData.gDb.TblReport.Insert(ERROR_GENERAL_CHECK_INVALID_LINE_ENDING, OtherMsg=OtherMsg, BelongsToTable='File', BelongsToItem=Record[0])
 229
 230     # Check if there is no trailing white space in one line.
 231     def GeneralCheckTrailingWhiteSpaceLine(self):
 232         if EccGlobalData.gConfig.GeneralCheckTrailingWhiteSpaceLine == '1' or EccGlobalData.gConfig.GeneralCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':
 233             EdkLogger.quiet("Checking trailing white space line in file ...")
 234             SqlCommand = """select ID, FullPath, ExtName from File where ExtName in ('.dec', '.inf', '.dsc', 'c', 'h')"""
 235             RecordSet = EccGlobalData.gDb.TblFile.Exec(SqlCommand)
 236             for Record in RecordSet:
 237                 if Record[2].upper() not in EccGlobalData.gConfig.BinaryExtList:
 238                     op = open(Record[1], 'rb').readlines()
 239                     IndexOfLine = 0
 240                     for Line in op:
 241                         IndexOfLine += 1
 242                         if Line.replace('\r', '').replace('\n', '').endswith(' '):
 243                             OtherMsg = "File %s has trailing white spaces at line %s" % (Record[1], IndexOfLine)
 244                             EccGlobalData.gDb.TblReport.Insert(ERROR_GENERAL_CHECK_TRAILING_WHITE_SPACE_LINE, OtherMsg=OtherMsg, BelongsToTable='File', BelongsToItem=Record[0])
 245
 246     # Check whether file has non ACSII char
 247     def GeneralCheckNonAcsii(self):
 248         if EccGlobalData.gConfig.GeneralCheckNonAcsii == '1' or EccGlobalData.gConfig.GeneralCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':
 249             EdkLogger.quiet("Checking Non-ACSII char in file ...")
 250             SqlCommand = """select ID, FullPath, ExtName from File where ExtName in ('.dec', '.inf', '.dsc', 'c', 'h')"""
 251             RecordSet = EccGlobalData.gDb.TblFile.Exec(SqlCommand)
 252             for Record in RecordSet:
 253                 if Record[2].upper() not in EccGlobalData.gConfig.BinaryExtList:
 254                     op = open(Record[1]).readlines()
 255                     IndexOfLine = 0
 256                     for Line in op:
 257                         IndexOfLine += 1
 258                         IndexOfChar = 0
 259                         for Char in Line:
 260                             IndexOfChar += 1
 261                             if ord(Char) > 126:
 262                                 OtherMsg = "File %s has Non-ASCII char at line %s column %s" % (Record[1], IndexOfLine, IndexOfChar)
 263                                 EccGlobalData.gDb.TblReport.Insert(ERROR_GENERAL_CHECK_NON_ACSII, OtherMsg=OtherMsg, BelongsToTable='File', BelongsToItem=Record[0])
 264
 265     # C Function Layout Checking
 266     def FunctionLayoutCheck(self):
 267         self.FunctionLayoutCheckReturnType()
 268         self.FunctionLayoutCheckModifier()
 269         self.FunctionLayoutCheckName()
 270         self.FunctionLayoutCheckPrototype()
 271         self.FunctionLayoutCheckBody()
 272         self.FunctionLayoutCheckLocalVariable()
 273         self.FunctionLayoutCheckDeprecated()
 274
 275     # To check if the deprecated functions are used
 276     def FunctionLayoutCheckDeprecated(self):
 277         if EccGlobalData.gConfig.CFunctionLayoutCheckNoDeprecated == '1' or EccGlobalData.gConfig.CFunctionLayoutCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':
 278             EdkLogger.quiet("Checking function no deprecated one being used ...")
 279
 280             DeprecatedFunctionSet = ('UnicodeValueToString',
 281                                      'AsciiValueToString',
 282                                      'StrCpy',
 283                                      'StrnCpy',
 284                                      'StrCat',
 285                                      'StrnCat',
 286                                      'UnicodeStrToAsciiStr',
 287                                      'AsciiStrCpy',
 288                                      'AsciiStrnCpy',
 289                                      'AsciiStrCat',
 290                                      'AsciiStrnCat',
 291                                      'AsciiStrToUnicodeStr',
 292                                      'PcdSet8',
 293                                      'PcdSet16',
 294                                      'PcdSet32',
 295                                      'PcdSet64',
 296                                      'PcdSetPtr',
 297                                      'PcdSetBool',
 298                                      'PcdSetEx8',
 299                                      'PcdSetEx16',
 300                                      'PcdSetEx32',
 301                                      'PcdSetEx64',
 302                                      'PcdSetExPtr',
 303                                      'PcdSetExBool',
 304                                      'LibPcdSet8',
 305                                      'LibPcdSet16',
 306                                      'LibPcdSet32',
 307                                      'LibPcdSet64',
 308                                      'LibPcdSetPtr',
 309                                      'LibPcdSetBool',
 310                                      'LibPcdSetEx8',
 311                                      'LibPcdSetEx16',
 312                                      'LibPcdSetEx32',
 313                                      'LibPcdSetEx64',
 314                                      'LibPcdSetExPtr',
 315                                      'LibPcdSetExBool',
 316                                      'GetVariable',
 317                                      'GetEfiGlobalVariable',
 318                                      )
 319
 320             for IdentifierTable in EccGlobalData.gIdentifierTableList:
 321                 SqlCommand = """select ID, Name, BelongsToFile from %s
 322                                 where Model = %s """ % (IdentifierTable, MODEL_IDENTIFIER_FUNCTION_CALLING)
 323                 RecordSet = EccGlobalData.gDb.TblFile.Exec(SqlCommand)
 324                 for Record in RecordSet:
 325                     for Key in DeprecatedFunctionSet:
 326                         if Key == Record[1]:
 327                             if not EccGlobalData.gException.IsException(ERROR_C_FUNCTION_LAYOUT_CHECK_NO_DEPRECATE, Key):
 328                                 OtherMsg = 'The function [%s] is deprecated which should NOT be used' % Key
 329                                 EccGlobalData.gDb.TblReport.Insert(ERROR_C_FUNCTION_LAYOUT_CHECK_NO_DEPRECATE,
 330                                                                    OtherMsg=OtherMsg,
 331                                                                    BelongsToTable=IdentifierTable,
 332                                                                    BelongsToItem=Record[0])
 333
 334     def WalkTree(self):
 335         IgnoredPattern = c.GetIgnoredDirListPattern()
 336         for Dirpath, Dirnames, Filenames in os.walk(EccGlobalData.gTarget):
 337             for Dir in Dirnames:
 338                 Dirname = os.path.join(Dirpath, Dir)
 339                 if os.path.islink(Dirname):
 340                     Dirname = os.path.realpath(Dirname)
 341                     if os.path.isdir(Dirname):
 342                         # symlinks to directories are treated as directories
 343                         Dirnames.remove(Dir)
 344                         Dirnames.append(Dirname)
 345             if IgnoredPattern.match(Dirpath.upper()):
 346                 continue
 347             for f in Filenames[:]:
 348                 if f.lower() in EccGlobalData.gConfig.SkipFileList:
 349                     Filenames.remove(f)
 350             yield (Dirpath, Dirnames, Filenames)
 351
 352     # Check whether return type exists and in the first line
 353     def FunctionLayoutCheckReturnType(self):
 354         if EccGlobalData.gConfig.CFunctionLayoutCheckReturnType == '1' or EccGlobalData.gConfig.CFunctionLayoutCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':
 355             EdkLogger.quiet("Checking function layout return type ...")
 356
 357 #            for Dirpath, Dirnames, Filenames in self.WalkTree():
 358 #                for F in Filenames:
 359 #                    if os.path.splitext(F)[1] in ('.c', '.h'):
 360 #                        FullName = os.path.join(Dirpath, F)
 361 #                        c.CheckFuncLayoutReturnType(FullName)
 362             for FullName in EccGlobalData.gCFileList + EccGlobalData.gHFileList:
 363                 c.CheckFuncLayoutReturnType(FullName)
 364
 365     # Check whether any optional functional modifiers exist and next to the return type
 366     def FunctionLayoutCheckModifier(self):
 367         if EccGlobalData.gConfig.CFunctionLayoutCheckOptionalFunctionalModifier == '1' or EccGlobalData.gConfig.CFunctionLayoutCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':
 368             EdkLogger.quiet("Checking function layout modifier ...")
 369
 370 #            for Dirpath, Dirnames, Filenames in self.WalkTree():
 371 #                for F in Filenames:
 372 #                    if os.path.splitext(F)[1] in ('.c', '.h'):
 373 #                        FullName = os.path.join(Dirpath, F)
 374 #                        c.CheckFuncLayoutModifier(FullName)
 375             for FullName in EccGlobalData.gCFileList + EccGlobalData.gHFileList:
 376                 c.CheckFuncLayoutModifier(FullName)
 377
 378     # Check whether the next line contains the function name, left justified, followed by the beginning of the parameter list
 379     # Check whether the closing parenthesis is on its own line and also indented two spaces
 380     def FunctionLayoutCheckName(self):
 381         if EccGlobalData.gConfig.CFunctionLayoutCheckFunctionName == '1' or EccGlobalData.gConfig.CFunctionLayoutCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':
 382             EdkLogger.quiet("Checking function layout function name ...")
 383
 384 #            for Dirpath, Dirnames, Filenames in self.WalkTree():
 385 #                for F in Filenames:
 386 #                    if os.path.splitext(F)[1] in ('.c', '.h'):
 387 #                        FullName = os.path.join(Dirpath, F)
 388 #                        c.CheckFuncLayoutName(FullName)
 389             for FullName in EccGlobalData.gCFileList + EccGlobalData.gHFileList:
 390                 c.CheckFuncLayoutName(FullName)
 391
 392     # Check whether the function prototypes in include files have the same form as function definitions
 393     def FunctionLayoutCheckPrototype(self):
 394         if EccGlobalData.gConfig.CFunctionLayoutCheckFunctionPrototype == '1' or EccGlobalData.gConfig.CFunctionLayoutCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':
 395             EdkLogger.quiet("Checking function layout function prototype ...")
 396
 397 #            for Dirpath, Dirnames, Filenames in self.WalkTree():
 398 #                for F in Filenames:
 399 #                    if os.path.splitext(F)[1] in ('.c'):
 400 #                        FullName = os.path.join(Dirpath, F)
 401 #                        EdkLogger.quiet("[PROTOTYPE]" + FullName)
 402 #                        c.CheckFuncLayoutPrototype(FullName)
 403             for FullName in EccGlobalData.gCFileList:
 404                 EdkLogger.quiet("[PROTOTYPE]" + FullName)
 405                 c.CheckFuncLayoutPrototype(FullName)
 406
 407     # Check whether the body of a function is contained by open and close braces that must be in the first column
 408     def FunctionLayoutCheckBody(self):
 409         if EccGlobalData.gConfig.CFunctionLayoutCheckFunctionBody == '1' or EccGlobalData.gConfig.CFunctionLayoutCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':
 410             EdkLogger.quiet("Checking function layout function body ...")
 411
 412 #            for Dirpath, Dirnames, Filenames in self.WalkTree():
 413 #                for F in Filenames:
 414 #                    if os.path.splitext(F)[1] in ('.c'):
 415 #                        FullName = os.path.join(Dirpath, F)
 416 #                        c.CheckFuncLayoutBody(FullName)
 417             for FullName in EccGlobalData.gCFileList:
 418                 c.CheckFuncLayoutBody(FullName)
 419
 420     # Check whether the data declarations is the first code in a module.
 421     # self.CFunctionLayoutCheckDataDeclaration = 1
 422     # Check whether no initialization of a variable as part of its declaration
 423     def FunctionLayoutCheckLocalVariable(self):
 424         if EccGlobalData.gConfig.CFunctionLayoutCheckNoInitOfVariable == '1' or EccGlobalData.gConfig.CFunctionLayoutCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':
 425             EdkLogger.quiet("Checking function layout local variables ...")
 426
 427 #            for Dirpath, Dirnames, Filenames in self.WalkTree():
 428 #                for F in Filenames:
 429 #                    if os.path.splitext(F)[1] in ('.c'):
 430 #                        FullName = os.path.join(Dirpath, F)
 431 #                        c.CheckFuncLayoutLocalVariable(FullName)
 432
 433             for FullName in EccGlobalData.gCFileList:
 434                 c.CheckFuncLayoutLocalVariable(FullName)
 435
 436     # Check whether no use of STATIC for functions
 437     # self.CFunctionLayoutCheckNoStatic = 1
 438
 439     # Declarations and Data Types Checking
 440     def DeclAndDataTypeCheck(self):
 441         self.DeclCheckNoUseCType()
 442         self.DeclCheckInOutModifier()
 443         self.DeclCheckEFIAPIModifier()
 444         self.DeclCheckEnumeratedType()
 445         self.DeclCheckStructureDeclaration()
 446         self.DeclCheckSameStructure()
 447         self.DeclCheckUnionType()
 448
 449
 450     # Check whether no use of int, unsigned, char, void, static, long in any .c, .h or .asl files.
 451     def DeclCheckNoUseCType(self):
 452         if EccGlobalData.gConfig.DeclarationDataTypeCheckNoUseCType == '1' or EccGlobalData.gConfig.DeclarationDataTypeCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':
 453             EdkLogger.quiet("Checking Declaration No use C type ...")
 454
 455 #            for Dirpath, Dirnames, Filenames in self.WalkTree():
 456 #                for F in Filenames:
 457 #                    if os.path.splitext(F)[1] in ('.h', '.c'):
 458 #                        FullName = os.path.join(Dirpath, F)
 459 #                        c.CheckDeclNoUseCType(FullName)
 460             for FullName in EccGlobalData.gCFileList + EccGlobalData.gHFileList:
 461                 c.CheckDeclNoUseCType(FullName)
 462
 463     # 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
 464     def DeclCheckInOutModifier(self):
 465         if EccGlobalData.gConfig.DeclarationDataTypeCheckInOutModifier == '1' or EccGlobalData.gConfig.DeclarationDataTypeCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':
 466             EdkLogger.quiet("Checking Declaration argument modifier ...")
 467
 468 #            for Dirpath, Dirnames, Filenames in self.WalkTree():
 469 #                for F in Filenames:
 470 #                    if os.path.splitext(F)[1] in ('.h', '.c'):
 471 #                        FullName = os.path.join(Dirpath, F)
 472 #                        c.CheckDeclArgModifier(FullName)
 473             for FullName in EccGlobalData.gCFileList + EccGlobalData.gHFileList:
 474                 c.CheckDeclArgModifier(FullName)
 475
 476     # Check whether the EFIAPI modifier should be used at the entry of drivers, events, and member functions of protocols
 477     def DeclCheckEFIAPIModifier(self):
 478         if EccGlobalData.gConfig.DeclarationDataTypeCheckEFIAPIModifier == '1' or EccGlobalData.gConfig.DeclarationDataTypeCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':
 479             pass
 480
 481     # Check whether Enumerated Type has a 'typedef' and the name is capital
 482     def DeclCheckEnumeratedType(self):
 483         if EccGlobalData.gConfig.DeclarationDataTypeCheckEnumeratedType == '1' or EccGlobalData.gConfig.DeclarationDataTypeCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':
 484             EdkLogger.quiet("Checking Declaration enum typedef ...")
 485
 486 #            for Dirpath, Dirnames, Filenames in self.WalkTree():
 487 #                for F in Filenames:
 488 #                    if os.path.splitext(F)[1] in ('.h', '.c'):
 489 #                        FullName = os.path.join(Dirpath, F)
 490 #                        EdkLogger.quiet("[ENUM]" + FullName)
 491 #                        c.CheckDeclEnumTypedef(FullName)
 492             for FullName in EccGlobalData.gCFileList + EccGlobalData.gHFileList:
 493                 EdkLogger.quiet("[ENUM]" + FullName)
 494                 c.CheckDeclEnumTypedef(FullName)
 495
 496     # Check whether Structure Type has a 'typedef' and the name is capital
 497     def DeclCheckStructureDeclaration(self):
 498         if EccGlobalData.gConfig.DeclarationDataTypeCheckStructureDeclaration == '1' or EccGlobalData.gConfig.DeclarationDataTypeCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':
 499             EdkLogger.quiet("Checking Declaration struct typedef ...")
 500
 501 #            for Dirpath, Dirnames, Filenames in self.WalkTree():
 502 #                for F in Filenames:
 503 #                    if os.path.splitext(F)[1] in ('.h', '.c'):
 504 #                        FullName = os.path.join(Dirpath, F)
 505 #                        EdkLogger.quiet("[STRUCT]" + FullName)
 506 #                        c.CheckDeclStructTypedef(FullName)
 507             for FullName in EccGlobalData.gCFileList + EccGlobalData.gHFileList:
 508                 EdkLogger.quiet("[STRUCT]" + FullName)
 509                 c.CheckDeclStructTypedef(FullName)
 510
 511     # Check whether having same Structure
 512     def DeclCheckSameStructure(self):
 513         if EccGlobalData.gConfig.DeclarationDataTypeCheckSameStructure == '1' or EccGlobalData.gConfig.DeclarationDataTypeCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':
 514             EdkLogger.quiet("Checking same struct ...")
 515             AllStructure = {}
 516             for IdentifierTable in EccGlobalData.gIdentifierTableList:
 517                 SqlCommand = """select ID, Name, BelongsToFile from %s where Model = %s""" % (IdentifierTable, MODEL_IDENTIFIER_STRUCTURE)
 518                 RecordSet = EccGlobalData.gDb.TblFile.Exec(SqlCommand)
 519                 for Record in RecordSet:
 520                     if Record[1] != '':
 521                         if Record[1] not in AllStructure.keys():
 522                             AllStructure[Record[1]] = Record[2]
 523                         else:
 524                             ID = AllStructure[Record[1]]
 525                             SqlCommand = """select FullPath from File where ID = %s """ % ID
 526                             NewRecordSet = EccGlobalData.gDb.TblFile.Exec(SqlCommand)
 527                             OtherMsg = "The structure name '%s' is duplicate" % Record[1]
 528                             if NewRecordSet != []:
 529                                 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])
 530                             if not EccGlobalData.gException.IsException(ERROR_DECLARATION_DATA_TYPE_CHECK_SAME_STRUCTURE, Record[1]):
 531                                 EccGlobalData.gDb.TblReport.Insert(ERROR_DECLARATION_DATA_TYPE_CHECK_SAME_STRUCTURE, OtherMsg=OtherMsg, BelongsToTable=IdentifierTable, BelongsToItem=Record[0])
 532
 533     # Check whether Union Type has a 'typedef' and the name is capital
 534     def DeclCheckUnionType(self):
 535         if EccGlobalData.gConfig.DeclarationDataTypeCheckUnionType == '1' or EccGlobalData.gConfig.DeclarationDataTypeCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':
 536             EdkLogger.quiet("Checking Declaration union typedef ...")
 537
 538 #            for Dirpath, Dirnames, Filenames in self.WalkTree():
 539 #                for F in Filenames:
 540 #                    if os.path.splitext(F)[1] in ('.h', '.c'):
 541 #                        FullName = os.path.join(Dirpath, F)
 542 #                        EdkLogger.quiet("[UNION]" + FullName)
 543 #                        c.CheckDeclUnionTypedef(FullName)
 544             for FullName in EccGlobalData.gCFileList + EccGlobalData.gHFileList:
 545                 EdkLogger.quiet("[UNION]" + FullName)
 546                 c.CheckDeclUnionTypedef(FullName)
 547
 548     # Predicate Expression Checking
 549     def PredicateExpressionCheck(self):
 550         self.PredicateExpressionCheckBooleanValue()
 551         self.PredicateExpressionCheckNonBooleanOperator()
 552         self.PredicateExpressionCheckComparisonNullType()
 553
 554     # Check whether Boolean values, variable type BOOLEAN not use explicit comparisons to TRUE or FALSE
 555     def PredicateExpressionCheckBooleanValue(self):
 556         if EccGlobalData.gConfig.PredicateExpressionCheckBooleanValue == '1' or EccGlobalData.gConfig.PredicateExpressionCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':
 557             EdkLogger.quiet("Checking predicate expression Boolean value ...")
 558
 559 #            for Dirpath, Dirnames, Filenames in self.WalkTree():
 560 #                for F in Filenames:
 561 #                    if os.path.splitext(F)[1] in ('.c'):
 562 #                        FullName = os.path.join(Dirpath, F)
 563 #                        EdkLogger.quiet("[BOOLEAN]" + FullName)
 564 #                        c.CheckBooleanValueComparison(FullName)
 565             for FullName in EccGlobalData.gCFileList:
 566                 EdkLogger.quiet("[BOOLEAN]" + FullName)
 567                 c.CheckBooleanValueComparison(FullName)
 568
 569     # Check whether Non-Boolean comparisons use a compare operator (==, !=, >, < >=, <=).
 570     def PredicateExpressionCheckNonBooleanOperator(self):
 571         if EccGlobalData.gConfig.PredicateExpressionCheckNonBooleanOperator == '1' or EccGlobalData.gConfig.PredicateExpressionCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':
 572             EdkLogger.quiet("Checking predicate expression Non-Boolean variable...")
 573
 574 #            for Dirpath, Dirnames, Filenames in self.WalkTree():
 575 #                for F in Filenames:
 576 #                    if os.path.splitext(F)[1] in ('.c'):
 577 #                        FullName = os.path.join(Dirpath, F)
 578 #                        EdkLogger.quiet("[NON-BOOLEAN]" + FullName)
 579 #                        c.CheckNonBooleanValueComparison(FullName)
 580             for FullName in EccGlobalData.gCFileList:
 581                 EdkLogger.quiet("[NON-BOOLEAN]" + FullName)
 582                 c.CheckNonBooleanValueComparison(FullName)
 583
 584     # Check whether a comparison of any pointer to zero must be done via the NULL type
 585     def PredicateExpressionCheckComparisonNullType(self):
 586         if EccGlobalData.gConfig.PredicateExpressionCheckComparisonNullType == '1' or EccGlobalData.gConfig.PredicateExpressionCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':
 587             EdkLogger.quiet("Checking predicate expression NULL pointer ...")
 588
 589 #            for Dirpath, Dirnames, Filenames in self.WalkTree():
 590 #                for F in Filenames:
 591 #                    if os.path.splitext(F)[1] in ('.c'):
 592 #                        FullName = os.path.join(Dirpath, F)
 593 #                        EdkLogger.quiet("[POINTER]" + FullName)
 594 #                        c.CheckPointerNullComparison(FullName)
 595             for FullName in EccGlobalData.gCFileList:
 596                 EdkLogger.quiet("[POINTER]" + FullName)
 597                 c.CheckPointerNullComparison(FullName)
 598
 599     # Include file checking
 600     def IncludeFileCheck(self):
 601         self.IncludeFileCheckIfndef()
 602         self.IncludeFileCheckData()
 603         self.IncludeFileCheckSameName()
 604
 605     # Check whether having include files with same name
 606     def IncludeFileCheckSameName(self):
 607         if EccGlobalData.gConfig.IncludeFileCheckSameName == '1' or EccGlobalData.gConfig.IncludeFileCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':
 608             EdkLogger.quiet("Checking same header file name ...")
 609             SqlCommand = """select ID, FullPath from File
 610                             where Model = 1002 order by Name """
 611             RecordDict = {}
 612             RecordSet = EccGlobalData.gDb.TblFile.Exec(SqlCommand)
 613             for Record in RecordSet:
 614                 List = Record[1].replace('/', '\\').split('\\')
 615                 if len(List) >= 2:
 616                     Key = List[-2] + '\\' + List[-1]
 617                 else:
 618                     Key = List[0]
 619                 if Key not in RecordDict:
 620                     RecordDict[Key] = [Record]
 621                 else:
 622                     RecordDict[Key].append(Record)
 623
 624             for Key in RecordDict:
 625                 if len(RecordDict[Key]) > 1:
 626                     for Item in RecordDict[Key]:
 627                         Path = mws.relpath(Item[1], EccGlobalData.gWorkspace)
 628                         if not EccGlobalData.gException.IsException(ERROR_INCLUDE_FILE_CHECK_NAME, Path):
 629                             EccGlobalData.gDb.TblReport.Insert(ERROR_INCLUDE_FILE_CHECK_NAME, OtherMsg="The file name for [%s] is duplicate" % Path, BelongsToTable='File', BelongsToItem=Item[0])
 630
 631     # Check whether all include file contents is guarded by a #ifndef statement.
 632     def IncludeFileCheckIfndef(self):
 633         if EccGlobalData.gConfig.IncludeFileCheckIfndefStatement == '1' or EccGlobalData.gConfig.IncludeFileCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':
 634             EdkLogger.quiet("Checking header file ifndef ...")
 635
 636 #            for Dirpath, Dirnames, Filenames in self.WalkTree():
 637 #                for F in Filenames:
 638 #                    if os.path.splitext(F)[1] in ('.h'):
 639 #                        FullName = os.path.join(Dirpath, F)
 640 #                        MsgList = c.CheckHeaderFileIfndef(FullName)
 641             for FullName in EccGlobalData.gHFileList:
 642                 MsgList = c.CheckHeaderFileIfndef(FullName)
 643
 644     # Check whether include files NOT contain code or define data variables
 645     def IncludeFileCheckData(self):
 646         if EccGlobalData.gConfig.IncludeFileCheckData == '1' or EccGlobalData.gConfig.IncludeFileCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':
 647             EdkLogger.quiet("Checking header file data ...")
 648
 649 #            for Dirpath, Dirnames, Filenames in self.WalkTree():
 650 #                for F in Filenames:
 651 #                    if os.path.splitext(F)[1] in ('.h'):
 652 #                        FullName = os.path.join(Dirpath, F)
 653 #                        MsgList = c.CheckHeaderFileData(FullName)
 654             for FullName in EccGlobalData.gHFileList:
 655                 MsgList = c.CheckHeaderFileData(FullName)
 656
 657     # Doxygen document checking
 658     def DoxygenCheck(self):
 659         self.DoxygenCheckFileHeader()
 660         self.DoxygenCheckFunctionHeader()
 661         self.DoxygenCheckCommentDescription()
 662         self.DoxygenCheckCommentFormat()
 663         self.DoxygenCheckCommand()
 664
 665     # Check whether the file headers are followed Doxygen special documentation blocks in section 2.3.5
 666     def DoxygenCheckFileHeader(self):
 667         if EccGlobalData.gConfig.DoxygenCheckFileHeader == '1' or EccGlobalData.gConfig.DoxygenCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':
 668             EdkLogger.quiet("Checking Doxygen file header ...")
 669
 670             for Dirpath, Dirnames, Filenames in self.WalkTree():
 671                 for F in Filenames:
 672                     Ext = os.path.splitext(F)[1]
 673                     if Ext in ('.h', '.c'):
 674                         FullName = os.path.join(Dirpath, F)
 675                         MsgList = c.CheckFileHeaderDoxygenComments(FullName)
 676                     elif Ext in ('.inf', '.dec', '.dsc', '.fdf'):
 677                         FullName = os.path.join(Dirpath, F)
 678                         op = open(FullName).readlines()
 679                         FileLinesList = op
 680                         LineNo             = 0
 681                         CurrentSection     = MODEL_UNKNOWN
 682                         HeaderSectionLines       = []
 683                         HeaderCommentStart = False
 684                         HeaderCommentEnd   = False
 685
 686                         for Line in FileLinesList:
 687                             LineNo   = LineNo + 1
 688                             Line     = Line.strip()
 689                             if (LineNo < len(FileLinesList) - 1):
 690                                 NextLine = FileLinesList[LineNo].strip()
 691
 692                             #
 693                             # blank line
 694                             #
 695                             if (Line == '' or not Line) and LineNo == len(FileLinesList):
 696                                 LastSectionFalg = True
 697
 698                             #
 699                             # check whether file header comment section started
 700                             #
 701                             if Line.startswith('#') and \
 702                                 (Line.find('@file') > -1) and \
 703                                 not HeaderCommentStart:
 704                                 if CurrentSection != MODEL_UNKNOWN:
 705                                     SqlStatement = """ select ID from File where FullPath like '%s'""" % FullName
 706                                     ResultSet = EccGlobalData.gDb.TblFile.Exec(SqlStatement)
 707                                     for Result in ResultSet:
 708                                         Msg = 'INF/DEC/DSC/FDF file header comment should begin with ""## @file"" or ""# @file""at the very top file'
 709                                         EccGlobalData.gDb.TblReport.Insert(ERROR_DOXYGEN_CHECK_FILE_HEADER, Msg, "File", Result[0])
 710
 711                                 else:
 712                                     CurrentSection = MODEL_IDENTIFIER_FILE_HEADER
 713                                     #
 714                                     # Append the first line to section lines.
 715                                     #
 716                                     HeaderSectionLines.append((Line, LineNo))
 717                                     HeaderCommentStart = True
 718                                     continue
 719
 720                             #
 721                             # Collect Header content.
 722                             #
 723                             if (Line.startswith('#') and CurrentSection == MODEL_IDENTIFIER_FILE_HEADER) and\
 724                                 HeaderCommentStart and not Line.startswith('##') and not\
 725                                 HeaderCommentEnd and NextLine != '':
 726                                 HeaderSectionLines.append((Line, LineNo))
 727                                 continue
 728                             #
 729                             # Header content end
 730                             #
 731                             if (Line.startswith('##') or not Line.strip().startswith("#")) and HeaderCommentStart \
 732                                 and not HeaderCommentEnd:
 733                                 if Line.startswith('##'):
 734                                     HeaderCommentEnd = True
 735                                 HeaderSectionLines.append((Line, LineNo))
 736                                 ParseHeaderCommentSection(HeaderSectionLines, FullName)
 737                                 break
 738                         if HeaderCommentStart == False:
 739                             SqlStatement = """ select ID from File where FullPath like '%s'""" % FullName
 740                             ResultSet = EccGlobalData.gDb.TblFile.Exec(SqlStatement)
 741                             for Result in ResultSet:
 742                                 Msg = 'INF/DEC/DSC/FDF file header comment should begin with ""## @file"" or ""# @file"" at the very top file'
 743                                 EccGlobalData.gDb.TblReport.Insert(ERROR_DOXYGEN_CHECK_FILE_HEADER, Msg, "File", Result[0])
 744                         if HeaderCommentEnd == False:
 745                             SqlStatement = """ select ID from File where FullPath like '%s'""" % FullName
 746                             ResultSet = EccGlobalData.gDb.TblFile.Exec(SqlStatement)
 747                             for Result in ResultSet:
 748                                 Msg = 'INF/DEC/DSC/FDF file header comment should end with ""##"" at the end of file header comment block'
 749                                 # Check whether File header Comment End with '##'
 750                                 if EccGlobalData.gConfig.HeaderCheckFileCommentEnd == '1' or EccGlobalData.gConfig.HeaderCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':
 751                                     EccGlobalData.gDb.TblReport.Insert(ERROR_DOXYGEN_CHECK_FILE_HEADER, Msg, "File", Result[0])
 752
 753
 754
 755     # Check whether the function headers are followed Doxygen special documentation blocks in section 2.3.5
 756     def DoxygenCheckFunctionHeader(self):
 757         if EccGlobalData.gConfig.DoxygenCheckFunctionHeader == '1' or EccGlobalData.gConfig.DoxygenCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':
 758             EdkLogger.quiet("Checking Doxygen function header ...")
 759
 760 #            for Dirpath, Dirnames, Filenames in self.WalkTree():
 761 #                for F in Filenames:
 762 #                    if os.path.splitext(F)[1] in ('.h', '.c'):
 763 #                        FullName = os.path.join(Dirpath, F)
 764 #                        MsgList = c.CheckFuncHeaderDoxygenComments(FullName)
 765             for FullName in EccGlobalData.gCFileList + EccGlobalData.gHFileList:
 766                 MsgList = c.CheckFuncHeaderDoxygenComments(FullName)
 767
 768
 769     # Check whether the first line of text in a comment block is a brief description of the element being documented.
 770     # The brief description must end with a period.
 771     def DoxygenCheckCommentDescription(self):
 772         if EccGlobalData.gConfig.DoxygenCheckCommentDescription == '1' or EccGlobalData.gConfig.DoxygenCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':
 773             pass
 774
 775     # Check whether comment lines with '///< ... text ...' format, if it is used, it should be after the code section.
 776     def DoxygenCheckCommentFormat(self):
 777         if EccGlobalData.gConfig.DoxygenCheckCommentFormat == '1' or EccGlobalData.gConfig.DoxygenCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':
 778             EdkLogger.quiet("Checking Doxygen comment ///< ...")
 779
 780 #            for Dirpath, Dirnames, Filenames in self.WalkTree():
 781 #                for F in Filenames:
 782 #                    if os.path.splitext(F)[1] in ('.h', '.c'):
 783 #                        FullName = os.path.join(Dirpath, F)
 784 #                        MsgList = c.CheckDoxygenTripleForwardSlash(FullName)
 785             for FullName in EccGlobalData.gCFileList + EccGlobalData.gHFileList:
 786                 MsgList = c.CheckDoxygenTripleForwardSlash(FullName)
 787
 788     # Check whether only Doxygen commands allowed to mark the code are @bug and @todo.
 789     def DoxygenCheckCommand(self):
 790         if EccGlobalData.gConfig.DoxygenCheckCommand == '1' or EccGlobalData.gConfig.DoxygenCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':
 791             EdkLogger.quiet("Checking Doxygen command ...")
 792
 793 #            for Dirpath, Dirnames, Filenames in self.WalkTree():
 794 #                for F in Filenames:
 795 #                    if os.path.splitext(F)[1] in ('.h', '.c'):
 796 #                        FullName = os.path.join(Dirpath, F)
 797 #                        MsgList = c.CheckDoxygenCommand(FullName)
 798             for FullName in EccGlobalData.gCFileList + EccGlobalData.gHFileList:
 799                 MsgList = c.CheckDoxygenCommand(FullName)
 800
 801     # Meta-Data File Processing Checking
 802     def MetaDataFileCheck(self):
 803         self.MetaDataFileCheckPathName()
 804         self.MetaDataFileCheckGenerateFileList()
 805         self.MetaDataFileCheckLibraryInstance()
 806         self.MetaDataFileCheckLibraryInstanceDependent()
 807         self.MetaDataFileCheckLibraryInstanceOrder()
 808         self.MetaDataFileCheckLibraryNoUse()
 809         self.MetaDataFileCheckLibraryDefinedInDec()
 810         self.MetaDataFileCheckBinaryInfInFdf()
 811         self.MetaDataFileCheckPcdDuplicate()
 812         self.MetaDataFileCheckPcdFlash()
 813         self.MetaDataFileCheckPcdNoUse()
 814         self.MetaDataFileCheckGuidDuplicate()
 815         self.MetaDataFileCheckModuleFileNoUse()
 816         self.MetaDataFileCheckPcdType()
 817         self.MetaDataFileCheckModuleFileGuidDuplication()
 818         self.MetaDataFileCheckModuleFileGuidFormat()
 819         self.MetaDataFileCheckModuleFileProtocolFormat()
 820         self.MetaDataFileCheckModuleFilePpiFormat()
 821         self.MetaDataFileCheckModuleFilePcdFormat()
 822
 823     # Check whether each file defined in meta-data exists
 824     def MetaDataFileCheckPathName(self):
 825         if EccGlobalData.gConfig.MetaDataFileCheckPathName == '1' or EccGlobalData.gConfig.MetaDataFileCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':
 826             # This item is covered when parsing Inf/Dec/Dsc files
 827             pass
 828
 829     # Generate a list for all files defined in meta-data files
 830     def MetaDataFileCheckGenerateFileList(self):
 831         if EccGlobalData.gConfig.MetaDataFileCheckGenerateFileList == '1' or EccGlobalData.gConfig.MetaDataFileCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':
 832             # This item is covered when parsing Inf/Dec/Dsc files
 833             pass
 834
 835     # Check whether all Library Instances defined for a given module (or dependent library instance) match the module's type.
 836     # Each Library Instance must specify the Supported Module Types in its Inf file,
 837     # and any module specifying the library instance must be one of the supported types.
 838     def MetaDataFileCheckLibraryInstance(self):
 839         if EccGlobalData.gConfig.MetaDataFileCheckLibraryInstance == '1' or EccGlobalData.gConfig.MetaDataFileCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':
 840             EdkLogger.quiet("Checking for library instance type issue ...")
 841             SqlCommand = """select A.ID, A.Value3, B.Value3 from Inf as A left join Inf as B
 842                             where A.Value2 = 'LIBRARY_CLASS' and A.Model = %s
 843                             and B.Value2 = 'MODULE_TYPE' and B.Model = %s and A.BelongsToFile = B.BelongsToFile
 844                             group by A.BelongsToFile""" % (MODEL_META_DATA_HEADER, MODEL_META_DATA_HEADER)
 845             RecordSet = EccGlobalData.gDb.TblInf.Exec(SqlCommand)
 846             LibraryClasses = {}
 847             for Record in RecordSet:
 848                 List = Record[1].split('|', 1)
 849                 SupModType = []
 850                 if len(List) == 1:
 851                     SupModType = DT.SUP_MODULE_LIST_STRING.split(DT.TAB_VALUE_SPLIT)
 852                 elif len(List) == 2:
 853                     SupModType = List[1].split()
 854
 855                 if List[0] not in LibraryClasses:
 856                     LibraryClasses[List[0]] = SupModType
 857                 else:
 858                     for Item in SupModType:
 859                         if Item not in LibraryClasses[List[0]]:
 860                             LibraryClasses[List[0]].append(Item)
 861
 862                 if Record[2] != DT.SUP_MODULE_BASE and Record[2] not in SupModType:
 863                     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])
 864
 865             SqlCommand = """select A.ID, A.Value1, B.Value3 from Inf as A left join Inf as B
 866                             where A.Model = %s and B.Value2 = '%s' and B.Model = %s
 867                             and B.BelongsToFile = A.BelongsToFile""" \
 868                             % (MODEL_EFI_LIBRARY_CLASS, 'MODULE_TYPE', MODEL_META_DATA_HEADER)
 869             RecordSet = EccGlobalData.gDb.TblInf.Exec(SqlCommand)
 870             # Merge all LibraryClasses' supmodlist
 871             RecordDict = {}
 872             for Record in RecordSet:
 873                 if Record[1] not in RecordDict:
 874                     RecordDict[Record[1]] = [str(Record[2])]
 875                 else:
 876                     if Record[2] not in RecordDict[Record[1]]:
 877                         RecordDict[Record[1]].append(Record[2])
 878
 879             for Record in RecordSet:
 880                 if Record[1] in LibraryClasses:
 881                     if Record[2] not in LibraryClasses[Record[1]] and DT.SUP_MODULE_BASE not in RecordDict[Record[1]]:
 882                         if not EccGlobalData.gException.IsException(ERROR_META_DATA_FILE_CHECK_LIBRARY_INSTANCE_1, Record[1]):
 883                             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])
 884                 else:
 885                     if not EccGlobalData.gException.IsException(ERROR_META_DATA_FILE_CHECK_LIBRARY_INSTANCE_1, Record[1]):
 886                         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])
 887
 888     # Check whether a Library Instance has been defined for all dependent library classes
 889     def MetaDataFileCheckLibraryInstanceDependent(self):
 890         if EccGlobalData.gConfig.MetaDataFileCheckLibraryInstanceDependent == '1' or EccGlobalData.gConfig.MetaDataFileCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':
 891             EdkLogger.quiet("Checking for library instance dependent issue ...")
 892             SqlCommand = """select ID, Value1, Value2 from Dsc where Model = %s""" % MODEL_EFI_LIBRARY_CLASS
 893             LibraryClasses = EccGlobalData.gDb.TblDsc.Exec(SqlCommand)
 894             for LibraryClass in LibraryClasses:
 895                 if LibraryClass[1].upper() == 'NULL' or LibraryClass[1].startswith('!ifdef') or LibraryClass[1].startswith('!ifndef') or LibraryClass[1].endswith('!endif'):
 896                     continue
 897                 else:
 898                     LibraryIns = os.path.normpath(mws.join(EccGlobalData.gWorkspace, LibraryClass[2]))
 899                     SkipDirString = '|'.join(EccGlobalData.gConfig.SkipDirList)
 900                     p = re.compile(r'.*[\\/](?:%s^\S)[\\/]?.*' % SkipDirString)
 901                     if p.match(os.path.split(LibraryIns)[0].upper()):
 902                         continue
 903                     SqlCommand = """select Value3 from Inf where BelongsToFile =
 904                                     (select ID from File where lower(FullPath) = lower('%s'))
 905                                     and Value2 = '%s'""" % (LibraryIns, DT.PLATFORM_COMPONENT_TYPE_LIBRARY_CLASS)
 906                     RecordSet = EccGlobalData.gDb.TblInf.Exec(SqlCommand)
 907                     IsFound = False
 908                     for Record in RecordSet:
 909                         LibName = Record[0].split('|', 1)[0]
 910                         if LibraryClass[1] == LibName:
 911                             IsFound = True
 912                     if not IsFound:
 913                         if not EccGlobalData.gException.IsException(ERROR_META_DATA_FILE_CHECK_LIBRARY_INSTANCE_DEPENDENT, LibraryClass[1]):
 914                             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])
 915
 916     # Check whether the Library Instances specified by the LibraryClasses sections are listed in order of dependencies
 917     def MetaDataFileCheckLibraryInstanceOrder(self):
 918         if EccGlobalData.gConfig.MetaDataFileCheckLibraryInstanceOrder == '1' or EccGlobalData.gConfig.MetaDataFileCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':
 919             # This checkpoint is not necessary for Ecc check
 920             pass
 921
 922     # Check whether the unnecessary inclusion of library classes in the Inf file
 923     # Check whether the unnecessary duplication of library classe names in the DSC file
 924     def MetaDataFileCheckLibraryNoUse(self):
 925         if EccGlobalData.gConfig.MetaDataFileCheckLibraryNoUse == '1' or EccGlobalData.gConfig.MetaDataFileCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':
 926             EdkLogger.quiet("Checking for library instance not used ...")
 927             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)
 928             RecordSet = EccGlobalData.gDb.TblInf.Exec(SqlCommand)
 929             for Record in RecordSet:
 930                 if not EccGlobalData.gException.IsException(ERROR_META_DATA_FILE_CHECK_LIBRARY_NO_USE, Record[1]):
 931                     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])
 932             SqlCommand = """
 933                          select A.ID, A.Value1, A.BelongsToFile, A.StartLine, B.StartLine from Dsc as A left join Dsc as B
 934                          where A.Model = %s and B.Model = %s and A.Scope1 = B.Scope1 and A.Scope2 = B.Scope2 and A.ID != B.ID
 935                          and A.Value1 = B.Value1 and A.Value2 != B.Value2 and A.BelongsToItem = -1 and B.BelongsToItem = -1 and A.StartLine != B.StartLine and B.BelongsToFile = A.BelongsToFile""" \
 936                             % (MODEL_EFI_LIBRARY_CLASS, MODEL_EFI_LIBRARY_CLASS)
 937             RecordSet = EccGlobalData.gDb.TblDsc.Exec(SqlCommand)
 938             for Record in RecordSet:
 939                 if Record[3] and Record[4] and Record[3] != Record[4] and Record[1] != 'NULL':
 940                     SqlCommand = """select FullPath from File where ID = %s""" % (Record[2])
 941                     FilePathList = EccGlobalData.gDb.TblFile.Exec(SqlCommand)
 942                     for FilePath in FilePathList:
 943                         if not EccGlobalData.gException.IsException(ERROR_META_DATA_FILE_CHECK_LIBRARY_NAME_DUPLICATE, Record[1]):
 944                             EccGlobalData.gDb.TblReport.Insert(ERROR_META_DATA_FILE_CHECK_LIBRARY_NAME_DUPLICATE, OtherMsg="The Library Class [%s] is duplicated in '%s' line %s and line %s." % (Record[1], FilePath, Record[3], Record[4]), BelongsToTable='Dsc', BelongsToItem=Record[0])
 945
 946     # Check the header file in Include\Library directory whether be defined in the package DEC file.
 947     def MetaDataFileCheckLibraryDefinedInDec(self):
 948         if EccGlobalData.gConfig.MetaDataFileCheckLibraryDefinedInDec == '1' or EccGlobalData.gConfig.MetaDataFileCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':
 949             EdkLogger.quiet("Checking for library instance whether be defined in the package dec file ...")
 950             SqlCommand = """
 951                     select A.Value1, A.StartLine, A.ID, B.Value1 from Inf as A left join Dec as B
 952                     on A.Model = B.Model and A.Value1 = B.Value1 where A.Model=%s
 953                     """ % MODEL_EFI_LIBRARY_CLASS
 954             RecordSet = EccGlobalData.gDb.TblDsc.Exec(SqlCommand)
 955             for Record in RecordSet:
 956                 LibraryInInf, Line, ID, LibraryDec = Record
 957                 if not LibraryDec:
 958                     if not EccGlobalData.gException.IsException(ERROR_META_DATA_FILE_CHECK_LIBRARY_NOT_DEFINED, LibraryInInf):
 959                         EccGlobalData.gDb.TblReport.Insert(ERROR_META_DATA_FILE_CHECK_LIBRARY_NOT_DEFINED, \
 960                                             OtherMsg="The Library Class [%s] in %s line is not defined in the associated package file." % (LibraryInInf, Line),
 961                                             BelongsToTable='Inf', BelongsToItem=ID)
 962
 963     # 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
 964     def MetaDataFileCheckBinaryInfInFdf(self):
 965         if EccGlobalData.gConfig.MetaDataFileCheckBinaryInfInFdf == '1' or EccGlobalData.gConfig.MetaDataFileCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':
 966             EdkLogger.quiet("Checking for non-binary modules defined in FDF files ...")
 967             SqlCommand = """select A.ID, A.Value1 from Fdf as A
 968                          where A.Model = %s
 969                          and A.Enabled > -1
 970                          and A.Value1 not in
 971                          (select B.Value1 from Dsc as B
 972                          where B.Model = %s
 973                          and B.Enabled > -1)""" % (MODEL_META_DATA_COMPONENT, MODEL_META_DATA_COMPONENT)
 974             RecordSet = EccGlobalData.gDb.TblFdf.Exec(SqlCommand)
 975             for Record in RecordSet:
 976                 FdfID = Record[0]
 977                 FilePath = Record[1]
 978                 FilePath = os.path.normpath(mws.join(EccGlobalData.gWorkspace, FilePath))
 979                 SqlCommand = """select ID from Inf where Model = %s and BelongsToFile = (select ID from File where FullPath like '%s')
 980                                 """ % (MODEL_EFI_SOURCE_FILE, FilePath)
 981                 NewRecordSet = EccGlobalData.gDb.TblFile.Exec(SqlCommand)
 982                 if NewRecordSet != []:
 983                     if not EccGlobalData.gException.IsException(ERROR_META_DATA_FILE_CHECK_BINARY_INF_IN_FDF, FilePath):
 984                         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)
 985
 986     # Check whether a PCD is set in a Dsc file or the FDF file, but not in both.
 987     def MetaDataFileCheckPcdDuplicate(self):
 988         if EccGlobalData.gConfig.MetaDataFileCheckPcdDuplicate == '1' or EccGlobalData.gConfig.MetaDataFileCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':
 989             EdkLogger.quiet("Checking for duplicate PCDs defined in both DSC and FDF files ...")
 990             SqlCommand = """
 991                          select A.ID, A.Value1, A.Value2, A.BelongsToFile, B.ID, B.Value1, B.Value2, B.BelongsToFile from Dsc as A, Fdf as B
 992                          where A.Model >= %s and A.Model < %s
 993                          and B.Model >= %s and B.Model < %s
 994                          and A.Value1 = B.Value1
 995                          and A.Value2 = B.Value2
 996                          and A.Enabled > -1
 997                          and B.Enabled > -1
 998                          group by A.ID
 999                          """ % (MODEL_PCD, MODEL_META_DATA_HEADER, MODEL_PCD, MODEL_META_DATA_HEADER)
1000             RecordSet = EccGlobalData.gDb.TblDsc.Exec(SqlCommand)
1001             for Record in RecordSet:
1002                 SqlCommand1 = """select Name from File where ID = %s""" % Record[3]
1003                 SqlCommand2 = """select Name from File where ID = %s""" % Record[7]
1004                 DscFileName = os.path.splitext(EccGlobalData.gDb.TblDsc.Exec(SqlCommand1)[0][0])[0]
1005                 FdfFileName = os.path.splitext(EccGlobalData.gDb.TblDsc.Exec(SqlCommand2)[0][0])[0]
1006                 if DscFileName != FdfFileName:
1007                     continue
1008                 if not EccGlobalData.gException.IsException(ERROR_META_DATA_FILE_CHECK_PCD_DUPLICATE, Record[1] + '.' + Record[2]):
1009                     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] + '.' + Record[2]), BelongsToTable='Dsc', BelongsToItem=Record[0])
1010                 if not EccGlobalData.gException.IsException(ERROR_META_DATA_FILE_CHECK_PCD_DUPLICATE, Record[5] + '.' + Record[6]):
1011                     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[5] + '.' + Record[6]), BelongsToTable='Fdf', BelongsToItem=Record[4])
1012
1013             EdkLogger.quiet("Checking for duplicate PCDs defined in DEC files ...")
1014             SqlCommand = """
1015                          select A.ID, A.Value1, A.Value2, A.Model, B.Model from Dec as A left join Dec as B
1016                          where A.Model >= %s and A.Model < %s
1017                          and B.Model >= %s and B.Model < %s
1018                          and A.Value1 = B.Value1
1019                          and A.Value2 = B.Value2
1020                          and A.Scope1 = B.Scope1
1021                          and A.ID != B.ID
1022                          and A.Model = B.Model
1023                          and A.Enabled > -1
1024                          and B.Enabled > -1
1025                          and A.BelongsToFile = B.BelongsToFile
1026                          group by A.ID
1027                          """ % (MODEL_PCD, MODEL_META_DATA_HEADER, MODEL_PCD, MODEL_META_DATA_HEADER)
1028             RecordSet = EccGlobalData.gDb.TblDec.Exec(SqlCommand)
1029             for Record in RecordSet:
1030                 RecordCat = Record[1] + '.' + Record[2]
1031                 if not EccGlobalData.gException.IsException(ERROR_META_DATA_FILE_CHECK_PCD_DUPLICATE, RecordCat):
1032                     EccGlobalData.gDb.TblReport.Insert(ERROR_META_DATA_FILE_CHECK_PCD_DUPLICATE, OtherMsg="The PCD [%s] is defined duplicated in DEC file" % RecordCat, BelongsToTable='Dec', BelongsToItem=Record[0])
1033
1034     # Check whether PCD settings in the FDF file can only be related to flash.
1035     def MetaDataFileCheckPcdFlash(self):
1036         if EccGlobalData.gConfig.MetaDataFileCheckPcdFlash == '1' or EccGlobalData.gConfig.MetaDataFileCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':
1037             EdkLogger.quiet("Checking only Flash related PCDs are used in FDF ...")
1038             SqlCommand = """
1039                          select ID, Value1, Value2, BelongsToFile from Fdf as A
1040                          where A.Model >= %s and Model < %s
1041                          and A.Enabled > -1
1042                          and A.Value2 not like '%%Flash%%'
1043                          """ % (MODEL_PCD, MODEL_META_DATA_HEADER)
1044             RecordSet = EccGlobalData.gDb.TblFdf.Exec(SqlCommand)
1045             for Record in RecordSet:
1046                 if not EccGlobalData.gException.IsException(ERROR_META_DATA_FILE_CHECK_PCD_FLASH, Record[1] + '.' + Record[2]):
1047                     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] + '.' + Record[2]), BelongsToTable='Fdf', BelongsToItem=Record[0])
1048
1049     # Check whether PCDs used in Inf files but not specified in Dsc or FDF files
1050     def MetaDataFileCheckPcdNoUse(self):
1051         if EccGlobalData.gConfig.MetaDataFileCheckPcdNoUse == '1' or EccGlobalData.gConfig.MetaDataFileCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':
1052             EdkLogger.quiet("Checking for non-specified PCDs ...")
1053             SqlCommand = """
1054                          select ID, Value1, Value2, BelongsToFile from Inf as A
1055                          where A.Model >= %s and Model < %s
1056                          and A.Enabled > -1
1057                          and (A.Value1, A.Value2) not in
1058                              (select Value1, Value2 from Dsc as B
1059                               where B.Model >= %s and B.Model < %s
1060                               and B.Enabled > -1)
1061                          and (A.Value1, A.Value2) not in
1062                              (select Value1, Value2 from Fdf as C
1063                               where C.Model >= %s and C.Model < %s
1064                               and C.Enabled > -1)
1065                          """ % (MODEL_PCD, MODEL_META_DATA_HEADER, MODEL_PCD, MODEL_META_DATA_HEADER, MODEL_PCD, MODEL_META_DATA_HEADER)
1066             RecordSet = EccGlobalData.gDb.TblInf.Exec(SqlCommand)
1067             for Record in RecordSet:
1068                 if not EccGlobalData.gException.IsException(ERROR_META_DATA_FILE_CHECK_PCD_NO_USE, Record[1] + '.' + Record[2]):
1069                     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] + '.' + Record[2]), BelongsToTable='Inf', BelongsToItem=Record[0])
1070
1071     # Check whether having duplicate guids defined for Guid/Protocol/Ppi
1072     def MetaDataFileCheckGuidDuplicate(self):
1073         if EccGlobalData.gConfig.MetaDataFileCheckGuidDuplicate == '1' or EccGlobalData.gConfig.MetaDataFileCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':
1074             EdkLogger.quiet("Checking for duplicate GUID/PPI/PROTOCOL ...")
1075             # Check Guid
1076             self.CheckGuidProtocolPpi(ERROR_META_DATA_FILE_CHECK_DUPLICATE_GUID, MODEL_EFI_GUID, EccGlobalData.gDb.TblDec)
1077             self.CheckGuidProtocolPpi(ERROR_META_DATA_FILE_CHECK_DUPLICATE_GUID, MODEL_EFI_GUID, EccGlobalData.gDb.TblDsc)
1078             self.CheckGuidProtocolPpiValue(ERROR_META_DATA_FILE_CHECK_DUPLICATE_GUID, MODEL_EFI_GUID)
1079             # Check protocol
1080             self.CheckGuidProtocolPpi(ERROR_META_DATA_FILE_CHECK_DUPLICATE_PROTOCOL, MODEL_EFI_PROTOCOL, EccGlobalData.gDb.TblDec)
1081             self.CheckGuidProtocolPpi(ERROR_META_DATA_FILE_CHECK_DUPLICATE_PROTOCOL, MODEL_EFI_PROTOCOL, EccGlobalData.gDb.TblDsc)
1082             self.CheckGuidProtocolPpiValue(ERROR_META_DATA_FILE_CHECK_DUPLICATE_PROTOCOL, MODEL_EFI_PROTOCOL)
1083             # Check ppi
1084             self.CheckGuidProtocolPpi(ERROR_META_DATA_FILE_CHECK_DUPLICATE_PPI, MODEL_EFI_PPI, EccGlobalData.gDb.TblDec)
1085             self.CheckGuidProtocolPpi(ERROR_META_DATA_FILE_CHECK_DUPLICATE_PPI, MODEL_EFI_PPI, EccGlobalData.gDb.TblDsc)
1086             self.CheckGuidProtocolPpiValue(ERROR_META_DATA_FILE_CHECK_DUPLICATE_PPI, MODEL_EFI_PPI)
1087
1088     # Check whether all files under module directory are described in INF files
1089     def MetaDataFileCheckModuleFileNoUse(self):
1090         if EccGlobalData.gConfig.MetaDataFileCheckModuleFileNoUse == '1' or EccGlobalData.gConfig.MetaDataFileCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':
1091             EdkLogger.quiet("Checking for no used module files ...")
1092             SqlCommand = """
1093                          select upper(Path) from File where ID in (select BelongsToFile from Inf where BelongsToFile != -1)
1094                          """
1095             InfPathSet = EccGlobalData.gDb.TblInf.Exec(SqlCommand)
1096             InfPathList = []
1097             for Item in InfPathSet:
1098                 if Item[0] not in InfPathList:
1099                     InfPathList.append(Item[0])
1100             SqlCommand = """
1101                          select ID, Path, FullPath from File where upper(FullPath) not in
1102                             (select upper(A.Path) || '\\' || upper(B.Value1) from File as A, INF as B
1103                             where A.ID in (select BelongsToFile from INF where Model = %s group by BelongsToFile) and
1104                             B.BelongsToFile = A.ID and B.Model = %s)
1105                             and (Model = %s or Model = %s)
1106                         """ % (MODEL_EFI_SOURCE_FILE, MODEL_EFI_SOURCE_FILE, MODEL_FILE_C, MODEL_FILE_H)
1107             RecordSet = EccGlobalData.gDb.TblInf.Exec(SqlCommand)
1108             for Record in RecordSet:
1109                 Path = Record[1]
1110                 Path = Path.upper().replace('\X64', '').replace('\IA32', '').replace('\EBC', '').replace('\IPF', '').replace('\ARM', '')
1111                 if Path in InfPathList:
1112                     if not EccGlobalData.gException.IsException(ERROR_META_DATA_FILE_CHECK_MODULE_FILE_NO_USE, Record[2]):
1113                         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])
1114
1115     # Check whether the PCD is correctly used in C function via its type
1116     def MetaDataFileCheckPcdType(self):
1117         if EccGlobalData.gConfig.MetaDataFileCheckPcdType == '1' or EccGlobalData.gConfig.MetaDataFileCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':
1118             EdkLogger.quiet("Checking for pcd type in c code function usage ...")
1119             SqlCommand = """
1120                          select ID, Model, Value1, Value2, BelongsToFile from INF where Model > %s and Model < %s
1121                          """ % (MODEL_PCD, MODEL_META_DATA_HEADER)
1122             PcdSet = EccGlobalData.gDb.TblInf.Exec(SqlCommand)
1123             for Pcd in PcdSet:
1124                 Model = Pcd[1]
1125                 PcdName = Pcd[2]
1126                 if Pcd[3]:
1127                     PcdName = Pcd[3]
1128                 BelongsToFile = Pcd[4]
1129                 SqlCommand = """
1130                              select ID from File where FullPath in
1131                             (select B.Path || '\\' || A.Value1 from INF as A, File as B where A.Model = %s and A.BelongsToFile = %s
1132                              and B.ID = %s and (B.Model = %s or B.Model = %s))
1133                              """ % (MODEL_EFI_SOURCE_FILE, BelongsToFile, BelongsToFile, MODEL_FILE_C, MODEL_FILE_H)
1134                 TableSet = EccGlobalData.gDb.TblFile.Exec(SqlCommand)
1135                 for Tbl in TableSet:
1136                     TblName = 'Identifier' + str(Tbl[0])
1137                     SqlCommand = """
1138                                  select Name, ID from %s where value like '%s' and Model = %s
1139                                  """ % (TblName, PcdName, MODEL_IDENTIFIER_FUNCTION_CALLING)
1140                     RecordSet = EccGlobalData.gDb.TblInf.Exec(SqlCommand)
1141                     TblNumber = TblName.replace('Identifier', '')
1142                     for Record in RecordSet:
1143                         FunName = Record[0]
1144                         if not EccGlobalData.gException.IsException(ERROR_META_DATA_FILE_CHECK_PCD_TYPE, FunName):
1145                             if Model in [MODEL_PCD_FIXED_AT_BUILD] and not FunName.startswith('FixedPcdGet'):
1146                                 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])
1147                             if Model in [MODEL_PCD_FEATURE_FLAG] and (not FunName.startswith('FeaturePcdGet') and not FunName.startswith('FeaturePcdSet')):
1148                                 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])
1149                             if Model in [MODEL_PCD_PATCHABLE_IN_MODULE] and (not FunName.startswith('PatchablePcdGet') and not FunName.startswith('PatchablePcdSet')):
1150                                 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])
1151
1152             #ERROR_META_DATA_FILE_CHECK_PCD_TYPE
1153         pass
1154
1155     # Internal worker function to get the INF workspace relative path from FileID
1156     def GetInfFilePathFromID(self, FileID):
1157         Table = EccGlobalData.gDb.TblFile
1158         SqlCommand = """select A.FullPath from %s as A where A.ID = %s""" % (Table.Table, FileID)
1159         RecordSet = Table.Exec(SqlCommand)
1160         Path = ""
1161         for Record in RecordSet:
1162             Path = mws.relpath(Record[0], EccGlobalData.gWorkspace)
1163         return Path
1164
1165     # Check whether two module INFs under one workspace has the same FILE_GUID value
1166     def MetaDataFileCheckModuleFileGuidDuplication(self):
1167         if EccGlobalData.gConfig.MetaDataFileCheckModuleFileGuidDuplication == '1' or EccGlobalData.gConfig.MetaDataFileCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':
1168             EdkLogger.quiet("Checking for pcd type in c code function usage ...")
1169             Table = EccGlobalData.gDb.TblInf
1170             SqlCommand = """
1171                          select A.ID, A.Value3, A.BelongsToFile, B.BelongsToFile from %s as A, %s as B
1172                          where A.Value2 = 'FILE_GUID' and B.Value2 = 'FILE_GUID' and
1173                          A.Value3 = B.Value3 and A.ID != B.ID group by A.ID
1174                          """ % (Table.Table, Table.Table)
1175             RecordSet = Table.Exec(SqlCommand)
1176             for Record in RecordSet:
1177                 InfPath1 = self.GetInfFilePathFromID(Record[2])
1178                 InfPath2 = self.GetInfFilePathFromID(Record[3])
1179                 if InfPath1 and InfPath2:
1180                     if not EccGlobalData.gException.IsException(ERROR_META_DATA_FILE_CHECK_MODULE_FILE_GUID_DUPLICATION, InfPath1):
1181                         Msg = "The FILE_GUID of INF file [%s] is duplicated with that of %s" % (InfPath1, InfPath2)
1182                         EccGlobalData.gDb.TblReport.Insert(ERROR_META_DATA_FILE_CHECK_MODULE_FILE_GUID_DUPLICATION, OtherMsg=Msg, BelongsToTable=Table.Table, BelongsToItem=Record[0])
1183
1184
1185     # Check Guid Format in module INF
1186     def MetaDataFileCheckModuleFileGuidFormat(self):
1187         if EccGlobalData.gConfig.MetaDataFileCheckModuleFileGuidFormat == '1' or EccGlobalData.gConfig.MetaDataFileCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':
1188             EdkLogger.quiet("Check Guid Format in module INF ...")
1189             Table = EccGlobalData.gDb.TblInf
1190             SqlCommand = """
1191                          select ID, Value1, Usage, BelongsToFile from %s where Model = %s group by ID
1192                          """ % (Table.Table, MODEL_EFI_GUID)
1193             RecordSet = Table.Exec(SqlCommand)
1194             for Record in RecordSet:
1195                 Value1 = Record[1]
1196                 Value2 = Record[2]
1197                 GuidCommentList = []
1198                 InfPath = self.GetInfFilePathFromID(Record[3])
1199                 Msg = "The GUID format of %s in INF file [%s] does not follow rules" % (Value1, InfPath)
1200                 if Value2.startswith(DT.TAB_SPECIAL_COMMENT):
1201                     GuidCommentList = Value2[2:].split(DT.TAB_SPECIAL_COMMENT)
1202                     if GuidCommentList[0].strip().startswith(DT.TAB_INF_USAGE_UNDEFINED):
1203                         continue
1204                     elif len(GuidCommentList) > 1:
1205                         if not GuidCommentList[0].strip().startswith((DT.TAB_INF_USAGE_PRO,
1206                                                                       DT.TAB_INF_USAGE_SOME_PRO,
1207                                                                       DT.TAB_INF_USAGE_CON,
1208                                                                       DT.TAB_INF_USAGE_SOME_CON)):
1209                             EccGlobalData.gDb.TblReport.Insert(ERROR_META_DATA_FILE_CHECK_FORMAT_GUID, OtherMsg=Msg, BelongsToTable=Table.Table, BelongsToItem=Record[0])
1210                         if not (GuidCommentList[1].strip()).startswith(DT.TAB_INF_GUIDTYPE_VAR) and \
1211                             not GuidCommentList[1].strip().startswith((DT.TAB_INF_GUIDTYPE_EVENT,
1212                                                                        DT.TAB_INF_GUIDTYPE_HII,
1213                                                                        DT.TAB_INF_GUIDTYPE_FILE,
1214                                                                        DT.TAB_INF_GUIDTYPE_HOB,
1215                                                                        DT.TAB_INF_GUIDTYPE_FV,
1216                                                                        DT.TAB_INF_GUIDTYPE_ST,
1217                                                                        DT.TAB_INF_GUIDTYPE_TSG,
1218                                                                        DT.TAB_INF_GUIDTYPE_GUID,
1219                                                                        DT.TAB_INF_GUIDTYPE_PROTOCOL,
1220                                                                        DT.TAB_INF_GUIDTYPE_PPI,
1221                                                                        DT.TAB_INF_USAGE_UNDEFINED)):
1222                                 EccGlobalData.gDb.TblReport.Insert(ERROR_META_DATA_FILE_CHECK_FORMAT_GUID, OtherMsg=Msg, BelongsToTable=Table.Table, BelongsToItem=Record[0])
1223                     else:
1224                         EccGlobalData.gDb.TblReport.Insert(ERROR_META_DATA_FILE_CHECK_FORMAT_GUID, OtherMsg=Msg, BelongsToTable=Table.Table, BelongsToItem=Record[0])
1225                 else:
1226                     EccGlobalData.gDb.TblReport.Insert(ERROR_META_DATA_FILE_CHECK_FORMAT_GUID, OtherMsg=Msg, BelongsToTable=Table.Table, BelongsToItem=Record[0])
1227
1228     # Check Protocol Format in module INF
1229     def MetaDataFileCheckModuleFileProtocolFormat(self):
1230         if EccGlobalData.gConfig.MetaDataFileCheckModuleFileProtocolFormat == '1' or EccGlobalData.gConfig.MetaDataFileCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':
1231             EdkLogger.quiet("Check Protocol Format in module INF ...")
1232             Table = EccGlobalData.gDb.TblInf
1233             SqlCommand = """
1234                          select ID, Value1, Usage, BelongsToFile from %s where Model = %s group by ID
1235                          """ % (Table.Table, MODEL_EFI_PROTOCOL)
1236             RecordSet = Table.Exec(SqlCommand)
1237             for Record in RecordSet:
1238                 Value1 = Record[1]
1239                 Value2 = Record[2]
1240                 GuidCommentList = []
1241                 InfPath = self.GetInfFilePathFromID(Record[3])
1242                 Msg = "The Protocol format of %s in INF file [%s] does not follow rules" % (Value1, InfPath)
1243                 if Value2.startswith(DT.TAB_SPECIAL_COMMENT):
1244                     GuidCommentList = Value2[2:].split(DT.TAB_SPECIAL_COMMENT)
1245                     if len(GuidCommentList) >= 1:
1246                         if not GuidCommentList[0].strip().startswith((DT.TAB_INF_USAGE_PRO,
1247                                                                       DT.TAB_INF_USAGE_SOME_PRO,
1248                                                                       DT.TAB_INF_USAGE_CON,
1249                                                                       DT.TAB_INF_USAGE_SOME_CON,
1250                                                                       DT.TAB_INF_USAGE_NOTIFY,
1251                                                                       DT.TAB_INF_USAGE_TO_START,
1252                                                                       DT.TAB_INF_USAGE_BY_START,
1253                                                                       DT.TAB_INF_USAGE_UNDEFINED)):
1254                             EccGlobalData.gDb.TblReport.Insert(ERROR_META_DATA_FILE_CHECK_FORMAT_PROTOCOL, OtherMsg=Msg, BelongsToTable=Table.Table, BelongsToItem=Record[0])
1255                 else:
1256                     EccGlobalData.gDb.TblReport.Insert(ERROR_META_DATA_FILE_CHECK_FORMAT_PROTOCOL, OtherMsg=Msg, BelongsToTable=Table.Table, BelongsToItem=Record[0])
1257
1258
1259     # Check Ppi Format in module INF
1260     def MetaDataFileCheckModuleFilePpiFormat(self):
1261         if EccGlobalData.gConfig.MetaDataFileCheckModuleFilePpiFormat == '1' or EccGlobalData.gConfig.MetaDataFileCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':
1262             EdkLogger.quiet("Check Ppi Format in module INF ...")
1263             Table = EccGlobalData.gDb.TblInf
1264             SqlCommand = """
1265                          select ID, Value1, Usage, BelongsToFile from %s where Model = %s group by ID
1266                          """ % (Table.Table, MODEL_EFI_PPI)
1267             RecordSet = Table.Exec(SqlCommand)
1268             for Record in RecordSet:
1269                 Value1 = Record[1]
1270                 Value2 = Record[2]
1271                 GuidCommentList = []
1272                 InfPath = self.GetInfFilePathFromID(Record[3])
1273                 Msg = "The Ppi format of %s in INF file [%s] does not follow rules" % (Value1, InfPath)
1274                 if Value2.startswith(DT.TAB_SPECIAL_COMMENT):
1275                     GuidCommentList = Value2[2:].split(DT.TAB_SPECIAL_COMMENT)
1276                     if len(GuidCommentList) >= 1:
1277                         if not GuidCommentList[0].strip().startswith((DT.TAB_INF_USAGE_PRO,
1278                                                                       DT.TAB_INF_USAGE_SOME_PRO,
1279                                                                       DT.TAB_INF_USAGE_CON,
1280                                                                       DT.TAB_INF_USAGE_SOME_CON,
1281                                                                       DT.TAB_INF_USAGE_NOTIFY,
1282                                                                       DT.TAB_INF_USAGE_UNDEFINED)):
1283                             EccGlobalData.gDb.TblReport.Insert(ERROR_META_DATA_FILE_CHECK_FORMAT_PPI, OtherMsg=Msg, BelongsToTable=Table.Table, BelongsToItem=Record[0])
1284                 else:
1285                     EccGlobalData.gDb.TblReport.Insert(ERROR_META_DATA_FILE_CHECK_FORMAT_PPI, OtherMsg=Msg, BelongsToTable=Table.Table, BelongsToItem=Record[0])
1286
1287     # Check Pcd Format in module INF
1288     def MetaDataFileCheckModuleFilePcdFormat(self):
1289         if EccGlobalData.gConfig.MetaDataFileCheckModuleFilePcdFormat == '1' or EccGlobalData.gConfig.MetaDataFileCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':
1290             EdkLogger.quiet("Check Pcd Format in module INF ...")
1291             Table = EccGlobalData.gDb.TblInf
1292             SqlCommand = """
1293                          select ID, Model, Value1, Value2, Usage, BelongsToFile from %s where Model >= %s and Model < %s group by ID
1294                          """ % (Table.Table, MODEL_PCD, MODEL_META_DATA_HEADER)
1295             RecordSet = Table.Exec(SqlCommand)
1296             for Record in RecordSet:
1297                 Model = Record[1]
1298                 PcdName = Record[2] + '.' + Record[3]
1299                 Usage = Record[4]
1300                 PcdCommentList = []
1301                 InfPath = self.GetInfFilePathFromID(Record[5])
1302                 Msg = "The Pcd format of %s in INF file [%s] does not follow rules" % (PcdName, InfPath)
1303                 if Usage.startswith(DT.TAB_SPECIAL_COMMENT):
1304                     PcdCommentList = Usage[2:].split(DT.TAB_SPECIAL_COMMENT)
1305                     if len(PcdCommentList) >= 1:
1306                         if Model in [MODEL_PCD_FIXED_AT_BUILD, MODEL_PCD_FEATURE_FLAG] \
1307                             and not PcdCommentList[0].strip().startswith((DT.TAB_INF_USAGE_SOME_PRO,
1308                                                                           DT.TAB_INF_USAGE_CON,
1309                                                                           DT.TAB_INF_USAGE_UNDEFINED)):
1310                             EccGlobalData.gDb.TblReport.Insert(ERROR_META_DATA_FILE_CHECK_FORMAT_PCD, OtherMsg=Msg, BelongsToTable=Table.Table, BelongsToItem=Record[0])
1311                         if Model in [MODEL_PCD_PATCHABLE_IN_MODULE, MODEL_PCD_DYNAMIC, MODEL_PCD_DYNAMIC_EX] \
1312                             and not PcdCommentList[0].strip().startswith((DT.TAB_INF_USAGE_PRO,
1313                                                                           DT.TAB_INF_USAGE_SOME_PRO,
1314                                                                           DT.TAB_INF_USAGE_CON,
1315                                                                           DT.TAB_INF_USAGE_SOME_CON,
1316                                                                           DT.TAB_INF_USAGE_UNDEFINED)):
1317                             EccGlobalData.gDb.TblReport.Insert(ERROR_META_DATA_FILE_CHECK_FORMAT_PCD, OtherMsg=Msg, BelongsToTable=Table.Table, BelongsToItem=Record[0])
1318                 else:
1319                     EccGlobalData.gDb.TblReport.Insert(ERROR_META_DATA_FILE_CHECK_FORMAT_PCD, OtherMsg=Msg, BelongsToTable=Table.Table, BelongsToItem=Record[0])
1320
1321     # Check whether these is duplicate Guid/Ppi/Protocol name
1322     def CheckGuidProtocolPpi(self, ErrorID, Model, Table):
1323         Name = ''
1324         if Model == MODEL_EFI_GUID:
1325             Name = 'guid'
1326         if Model == MODEL_EFI_PROTOCOL:
1327             Name = 'protocol'
1328         if Model == MODEL_EFI_PPI:
1329             Name = 'ppi'
1330         SqlCommand = """
1331                      select A.ID, A.Value1 from %s as A, %s as B
1332                      where A.Model = %s and B.Model = %s
1333                      and A.Value1 like B.Value1 and A.ID != B.ID
1334                      and A.Scope1 = B.Scope1
1335                      and A.Enabled > -1
1336                      and B.Enabled > -1
1337                      group by A.ID
1338                      """ % (Table.Table, Table.Table, Model, Model)
1339         RecordSet = Table.Exec(SqlCommand)
1340         for Record in RecordSet:
1341             if not EccGlobalData.gException.IsException(ErrorID, Record[1]):
1342                 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])
1343
1344     # Check whether these is duplicate Guid/Ppi/Protocol value
1345     def CheckGuidProtocolPpiValue(self, ErrorID, Model):
1346         Name = ''
1347         Table = EccGlobalData.gDb.TblDec
1348         if Model == MODEL_EFI_GUID:
1349             Name = 'guid'
1350         if Model == MODEL_EFI_PROTOCOL:
1351             Name = 'protocol'
1352         if Model == MODEL_EFI_PPI:
1353             Name = 'ppi'
1354         SqlCommand = """
1355                      select A.ID, A.Value1, A.Value2 from %s as A, %s as B
1356                      where A.Model = %s and B.Model = %s
1357                      and A.Value2 like B.Value2 and A.ID != B.ID
1358                      and A.Scope1 = B.Scope1 and A.Value1 != B.Value1
1359                      group by A.ID
1360                      """ % (Table.Table, Table.Table, Model, Model)
1361         RecordSet = Table.Exec(SqlCommand)
1362         for Record in RecordSet:
1363             if not EccGlobalData.gException.IsException(ErrorID, Record[2]):
1364                 EccGlobalData.gDb.TblReport.Insert(ErrorID, OtherMsg="The %s value [%s] is used more than one time" % (Name.upper(), Record[2]), BelongsToTable=Table.Table, BelongsToItem=Record[0])
1365
1366     # Naming Convention Check
1367     def NamingConventionCheck(self):
1368         if EccGlobalData.gConfig.NamingConventionCheckDefineStatement == '1' \
1369         or EccGlobalData.gConfig.NamingConventionCheckTypedefStatement == '1' \
1370         or EccGlobalData.gConfig.NamingConventionCheckIfndefStatement == '1' \
1371         or EccGlobalData.gConfig.NamingConventionCheckVariableName == '1' \
1372         or EccGlobalData.gConfig.NamingConventionCheckSingleCharacterVariable == '1' \
1373         or EccGlobalData.gConfig.NamingConventionCheckAll == '1'\
1374         or EccGlobalData.gConfig.CheckAll == '1':
1375             for Dirpath, Dirnames, Filenames in self.WalkTree():
1376                 for F in Filenames:
1377                     if os.path.splitext(F)[1] in ('.h', '.c'):
1378                         FullName = os.path.join(Dirpath, F)
1379                         Id = c.GetTableID(FullName)
1380                         if Id < 0:
1381                             continue
1382                         FileTable = 'Identifier' + str(Id)
1383                         self.NamingConventionCheckDefineStatement(FileTable)
1384                         self.NamingConventionCheckTypedefStatement(FileTable)
1385                         self.NamingConventionCheckVariableName(FileTable)
1386                         self.NamingConventionCheckSingleCharacterVariable(FileTable)
1387                         if os.path.splitext(F)[1] in ('.h'):
1388                             self.NamingConventionCheckIfndefStatement(FileTable)
1389
1390         self.NamingConventionCheckPathName()
1391         self.NamingConventionCheckFunctionName()
1392
1393     # Check whether only capital letters are used for #define declarations
1394     def NamingConventionCheckDefineStatement(self, FileTable):
1395         if EccGlobalData.gConfig.NamingConventionCheckDefineStatement == '1' or EccGlobalData.gConfig.NamingConventionCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':
1396             EdkLogger.quiet("Checking naming covention of #define statement ...")
1397
1398             SqlCommand = """select ID, Value from %s where Model = %s""" % (FileTable, MODEL_IDENTIFIER_MACRO_DEFINE)
1399             RecordSet = EccGlobalData.gDb.TblFile.Exec(SqlCommand)
1400             for Record in RecordSet:
1401                 Name = Record[1].strip().split()[1]
1402                 if Name.find('(') != -1:
1403                     Name = Name[0:Name.find('(')]
1404                 if Name.upper() != Name:
1405                     if not EccGlobalData.gException.IsException(ERROR_NAMING_CONVENTION_CHECK_DEFINE_STATEMENT, Name):
1406                         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])
1407
1408     # Check whether only capital letters are used for typedef declarations
1409     def NamingConventionCheckTypedefStatement(self, FileTable):
1410         if EccGlobalData.gConfig.NamingConventionCheckTypedefStatement == '1' or EccGlobalData.gConfig.NamingConventionCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':
1411             EdkLogger.quiet("Checking naming covention of #typedef statement ...")
1412
1413             SqlCommand = """select ID, Name from %s where Model = %s""" % (FileTable, MODEL_IDENTIFIER_TYPEDEF)
1414             RecordSet = EccGlobalData.gDb.TblFile.Exec(SqlCommand)
1415             for Record in RecordSet:
1416                 Name = Record[1].strip()
1417                 if Name != '' and Name is not None:
1418                     if Name[0] == '(':
1419                         Name = Name[1:Name.find(')')]
1420                     if Name.find('(') > -1:
1421                         Name = Name[Name.find('(') + 1 : Name.find(')')]
1422                     Name = Name.replace('WINAPI', '')
1423                     Name = Name.replace('*', '').strip()
1424                     if Name.upper() != Name:
1425                         if not EccGlobalData.gException.IsException(ERROR_NAMING_CONVENTION_CHECK_TYPEDEF_STATEMENT, Name):
1426                             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])
1427
1428     # Check whether the #ifndef at the start of an include file uses both prefix and postfix underscore characters, '_'.
1429     def NamingConventionCheckIfndefStatement(self, FileTable):
1430         if EccGlobalData.gConfig.NamingConventionCheckIfndefStatement == '1' or EccGlobalData.gConfig.NamingConventionCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':
1431             EdkLogger.quiet("Checking naming covention of #ifndef statement ...")
1432
1433             SqlCommand = """select ID, Value from %s where Model = %s""" % (FileTable, MODEL_IDENTIFIER_MACRO_IFNDEF)
1434             RecordSet = EccGlobalData.gDb.TblFile.Exec(SqlCommand)
1435             for Record in RecordSet:
1436                 Name = Record[1].replace('#ifndef', '').strip()
1437                 if Name[0] != '_' or Name[-1] != '_':
1438                     if not EccGlobalData.gException.IsException(ERROR_NAMING_CONVENTION_CHECK_IFNDEF_STATEMENT, Name):
1439                         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])
1440
1441     # Rule for path name, variable name and function name
1442     # 1. First character should be upper case
1443     # 2. Existing lower case in a word
1444     # 3. No space existence
1445     # Check whether the path name followed the rule
1446     def NamingConventionCheckPathName(self):
1447         if EccGlobalData.gConfig.NamingConventionCheckPathName == '1' or EccGlobalData.gConfig.NamingConventionCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':
1448             EdkLogger.quiet("Checking naming covention of file path name ...")
1449             Pattern = re.compile(r'^[A-Z]+\S*[a-z]\S*$')
1450             SqlCommand = """select ID, Name from File"""
1451             RecordSet = EccGlobalData.gDb.TblFile.Exec(SqlCommand)
1452             for Record in RecordSet:
1453                 if not Pattern.match(Record[1]):
1454                     if not EccGlobalData.gException.IsException(ERROR_NAMING_CONVENTION_CHECK_PATH_NAME, Record[1]):
1455                         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])
1456
1457     # Rule for path name, variable name and function name
1458     # 1. First character should be upper case
1459     # 2. Existing lower case in a word
1460     # 3. No space existence
1461     # 4. Global variable name must start with a 'g'
1462     # Check whether the variable name followed the rule
1463     def NamingConventionCheckVariableName(self, FileTable):
1464         if EccGlobalData.gConfig.NamingConventionCheckVariableName == '1' or EccGlobalData.gConfig.NamingConventionCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':
1465             EdkLogger.quiet("Checking naming covention of variable name ...")
1466             Pattern = re.compile(r'^[A-Zgm]+\S*[a-z]\S*$')
1467
1468             SqlCommand = """select ID, Name from %s where Model = %s""" % (FileTable, MODEL_IDENTIFIER_VARIABLE)
1469             RecordSet = EccGlobalData.gDb.TblFile.Exec(SqlCommand)
1470             for Record in RecordSet:
1471                 Var = Record[1]
1472                 if Var.startswith('CONST'):
1473                     Var = Var[5:].lstrip()
1474                 if not Pattern.match(Var):
1475                     if not EccGlobalData.gException.IsException(ERROR_NAMING_CONVENTION_CHECK_VARIABLE_NAME, Record[1]):
1476                         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])
1477
1478     # Rule for path name, variable name and function name
1479     # 1. First character should be upper case
1480     # 2. Existing lower case in a word
1481     # 3. No space existence
1482     # Check whether the function name followed the rule
1483     def NamingConventionCheckFunctionName(self):
1484         if EccGlobalData.gConfig.NamingConventionCheckFunctionName == '1' or EccGlobalData.gConfig.NamingConventionCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':
1485             EdkLogger.quiet("Checking naming covention of function name ...")
1486             Pattern = re.compile(r'^[A-Z]+\S*[a-z]\S*$')
1487             SqlCommand = """select ID, Name from Function"""
1488             RecordSet = EccGlobalData.gDb.TblFile.Exec(SqlCommand)
1489             for Record in RecordSet:
1490                 if not Pattern.match(Record[1]):
1491                     if not EccGlobalData.gException.IsException(ERROR_NAMING_CONVENTION_CHECK_FUNCTION_NAME, Record[1]):
1492                         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])
1493
1494     # Check whether NO use short variable name with single character
1495     def NamingConventionCheckSingleCharacterVariable(self, FileTable):
1496         if EccGlobalData.gConfig.NamingConventionCheckSingleCharacterVariable == '1' or EccGlobalData.gConfig.NamingConventionCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':
1497             EdkLogger.quiet("Checking naming covention of single character variable name ...")
1498
1499             SqlCommand = """select ID, Name from %s where Model = %s""" % (FileTable, MODEL_IDENTIFIER_VARIABLE)
1500             RecordSet = EccGlobalData.gDb.TblFile.Exec(SqlCommand)
1501             for Record in RecordSet:
1502                 Variable = Record[1].replace('*', '')
1503                 if len(Variable) == 1:
1504                     if not EccGlobalData.gException.IsException(ERROR_NAMING_CONVENTION_CHECK_SINGLE_CHARACTER_VARIABLE, Record[1]):
1505                         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])
1506
1507 def FindPara(FilePath, Para, CallingLine):
1508     Lines = open(FilePath).readlines()
1509     Line = ''
1510     for Index in range(CallingLine - 1, 0, -1):
1511         # Find the nearest statement for Para
1512         Line = Lines[Index].strip()
1513         if Line.startswith('%s = ' % Para):
1514             Line = Line.strip()
1515             return Line
1516             break
1517
1518     return ''
1519
1520 ##
1521 #
1522 # This acts like the main() function for the script, unless it is 'import'ed into another
1523 # script.
1524 #
1525 if __name__ == '__main__':
1526     Check = Check()
1527     Check.Check()