[mirror_edk2.git] / BaseTools / Source / Python / Ecc / Check.py

## @file\r
# This file is used to define checkpoints used by ECC tool\r
#\r
# Copyright (c) 2008 - 2010, Intel Corporation. All rights reserved.<BR>\r
# This program and the accompanying materials\r
# are licensed and made available under the terms and conditions of the BSD License\r
# which accompanies this distribution.  The full text of the license may be found at\r
# http://opensource.org/licenses/bsd-license.php\r
#\r
# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
#\r
import os\r
import re\r
from CommonDataClass.DataClass import *\r
from Common.DataType import SUP_MODULE_LIST_STRING, TAB_VALUE_SPLIT\r
from EccToolError import *\r
import EccGlobalData\r
import c\r
\r
## Check\r
#\r
# This class is to define checkpoints used by ECC tool\r
#\r
# @param object:          Inherited from object class\r
#\r
class Check(object):\r
    def __init__(self):\r
        pass\r
\r
    # Check all required checkpoints\r
    def Check(self):\r
        self.GeneralCheck()\r
        self.MetaDataFileCheck()\r
        self.DoxygenCheck()\r
        self.IncludeFileCheck()\r
        self.PredicateExpressionCheck()\r
        self.DeclAndDataTypeCheck()\r
        self.FunctionLayoutCheck()\r
        self.NamingConventionCheck()\r
\r
    # General Checking\r
    def GeneralCheck(self):\r
        self.GeneralCheckNonAcsii()\r
\r
    # Check whether file has non ACSII char\r
    def GeneralCheckNonAcsii(self):\r
        if EccGlobalData.gConfig.GeneralCheckNonAcsii == '1' or EccGlobalData.gConfig.GeneralCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
            EdkLogger.quiet("Checking Non-ACSII char in file ...")\r
            SqlCommand = """select ID, FullPath, ExtName from File"""\r
            RecordSet = EccGlobalData.gDb.TblInf.Exec(SqlCommand)\r
            for Record in RecordSet:\r
                if Record[2].upper() not in EccGlobalData.gConfig.BinaryExtList:\r
                    op = open(Record[1]).readlines()\r
                    IndexOfLine = 0\r
                    for Line in op:\r
                        IndexOfLine += 1\r
                        IndexOfChar = 0\r
                        for Char in Line:\r
                            IndexOfChar += 1\r
                            if ord(Char) > 126:\r
                                OtherMsg = "File %s has Non-ASCII char at line %s column %s" % (Record[1], IndexOfLine, IndexOfChar)\r
                                EccGlobalData.gDb.TblReport.Insert(ERROR_GENERAL_CHECK_NON_ACSII, OtherMsg=OtherMsg, BelongsToTable='File', BelongsToItem=Record[0])\r
\r
    # C Function Layout Checking\r
    def FunctionLayoutCheck(self):\r
        self.FunctionLayoutCheckReturnType()\r
        self.FunctionLayoutCheckModifier()\r
        self.FunctionLayoutCheckName()\r
        self.FunctionLayoutCheckPrototype()\r
        self.FunctionLayoutCheckBody()\r
        self.FunctionLayoutCheckLocalVariable()\r
\r
    def WalkTree(self):\r
        IgnoredPattern = c.GetIgnoredDirListPattern()\r
        for Dirpath, Dirnames, Filenames in os.walk(EccGlobalData.gTarget):\r
            for Dir in Dirnames:\r
                Dirname = os.path.join(Dirpath, Dir)\r
                if os.path.islink(Dirname):\r
                    Dirname = os.path.realpath(Dirname)\r
                    if os.path.isdir(Dirname):\r
                        # symlinks to directories are treated as directories\r
                        Dirnames.remove(Dir)\r
                        Dirnames.append(Dirname)\r
            if IgnoredPattern.match(Dirpath.upper()):\r
                continue\r
            yield (Dirpath, Dirnames, Filenames)\r
\r
    # Check whether return type exists and in the first line\r
    def FunctionLayoutCheckReturnType(self):\r
        if EccGlobalData.gConfig.CFunctionLayoutCheckReturnType == '1' or EccGlobalData.gConfig.CFunctionLayoutCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
            EdkLogger.quiet("Checking function layout return type ...")\r
\r
#            for Dirpath, Dirnames, Filenames in self.WalkTree():\r
#                for F in Filenames:\r
#                    if os.path.splitext(F)[1] in ('.c', '.h'):\r
#                        FullName = os.path.join(Dirpath, F)\r
#                        c.CheckFuncLayoutReturnType(FullName)\r
            for FullName in EccGlobalData.gCFileList + EccGlobalData.gHFileList:\r
                c.CheckFuncLayoutReturnType(FullName)\r
\r
    # Check whether any optional functional modifiers exist and next to the return type\r
    def FunctionLayoutCheckModifier(self):\r
        if EccGlobalData.gConfig.CFunctionLayoutCheckOptionalFunctionalModifier == '1' or EccGlobalData.gConfig.CFunctionLayoutCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
            EdkLogger.quiet("Checking function layout modifier ...")\r
\r
#            for Dirpath, Dirnames, Filenames in self.WalkTree():\r
#                for F in Filenames:\r
#                    if os.path.splitext(F)[1] in ('.c', '.h'):\r
#                        FullName = os.path.join(Dirpath, F)\r
#                        c.CheckFuncLayoutModifier(FullName)\r
            for FullName in EccGlobalData.gCFileList + EccGlobalData.gHFileList:\r
                c.CheckFuncLayoutModifier(FullName)\r
\r
    # Check whether the next line contains the function name, left justified, followed by the beginning of the parameter list\r
    # Check whether the closing parenthesis is on its own line and also indented two spaces\r
    def FunctionLayoutCheckName(self):\r
        if EccGlobalData.gConfig.CFunctionLayoutCheckFunctionName == '1' or EccGlobalData.gConfig.CFunctionLayoutCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
            EdkLogger.quiet("Checking function layout function name ...")\r
\r
#            for Dirpath, Dirnames, Filenames in self.WalkTree():\r
#                for F in Filenames:\r
#                    if os.path.splitext(F)[1] in ('.c', '.h'):\r
#                        FullName = os.path.join(Dirpath, F)\r
#                        c.CheckFuncLayoutName(FullName)\r
            for FullName in EccGlobalData.gCFileList + EccGlobalData.gHFileList:\r
                c.CheckFuncLayoutName(FullName)\r
\r
    # Check whether the function prototypes in include files have the same form as function definitions\r
    def FunctionLayoutCheckPrototype(self):\r
        if EccGlobalData.gConfig.CFunctionLayoutCheckFunctionPrototype == '1' or EccGlobalData.gConfig.CFunctionLayoutCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
            EdkLogger.quiet("Checking function layout function prototype ...")\r
\r
#            for Dirpath, Dirnames, Filenames in self.WalkTree():\r
#                for F in Filenames:\r
#                    if os.path.splitext(F)[1] in ('.c'):\r
#                        FullName = os.path.join(Dirpath, F)\r
#                        EdkLogger.quiet("[PROTOTYPE]" + FullName)\r
#                        c.CheckFuncLayoutPrototype(FullName)\r
            for FullName in EccGlobalData.gCFileList:\r
                EdkLogger.quiet("[PROTOTYPE]" + FullName)\r
                c.CheckFuncLayoutPrototype(FullName)\r
\r
    # Check whether the body of a function is contained by open and close braces that must be in the first column\r
    def FunctionLayoutCheckBody(self):\r
        if EccGlobalData.gConfig.CFunctionLayoutCheckFunctionBody == '1' or EccGlobalData.gConfig.CFunctionLayoutCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
            EdkLogger.quiet("Checking function layout function body ...")\r
\r
#            for Dirpath, Dirnames, Filenames in self.WalkTree():\r
#                for F in Filenames:\r
#                    if os.path.splitext(F)[1] in ('.c'):\r
#                        FullName = os.path.join(Dirpath, F)\r
#                        c.CheckFuncLayoutBody(FullName)\r
            for FullName in EccGlobalData.gCFileList:\r
                c.CheckFuncLayoutBody(FullName)\r
\r
    # Check whether the data declarations is the first code in a module.\r
    # self.CFunctionLayoutCheckDataDeclaration = 1\r
    # Check whether no initialization of a variable as part of its declaration\r
    def FunctionLayoutCheckLocalVariable(self):\r
        if EccGlobalData.gConfig.CFunctionLayoutCheckNoInitOfVariable == '1' or EccGlobalData.gConfig.CFunctionLayoutCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
            EdkLogger.quiet("Checking function layout local variables ...")\r
\r
#            for Dirpath, Dirnames, Filenames in self.WalkTree():\r
#                for F in Filenames:\r
#                    if os.path.splitext(F)[1] in ('.c'):\r
#                        FullName = os.path.join(Dirpath, F)\r
#                        c.CheckFuncLayoutLocalVariable(FullName)\r
\r
            for FullName in EccGlobalData.gCFileList:\r
                c.CheckFuncLayoutLocalVariable(FullName)\r
\r
    # Check whether no use of STATIC for functions\r
    # self.CFunctionLayoutCheckNoStatic = 1\r
\r
    # Declarations and Data Types Checking\r
    def DeclAndDataTypeCheck(self):\r
        self.DeclCheckNoUseCType()\r
        self.DeclCheckInOutModifier()\r
        self.DeclCheckEFIAPIModifier()\r
        self.DeclCheckEnumeratedType()\r
        self.DeclCheckStructureDeclaration()\r
        self.DeclCheckSameStructure()\r
        self.DeclCheckUnionType()\r
\r
\r
    # Check whether no use of int, unsigned, char, void, static, long in any .c, .h or .asl files.\r
    def DeclCheckNoUseCType(self):\r
        if EccGlobalData.gConfig.DeclarationDataTypeCheckNoUseCType == '1' or EccGlobalData.gConfig.DeclarationDataTypeCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
            EdkLogger.quiet("Checking Declaration No use C type ...")\r
\r
#            for Dirpath, Dirnames, Filenames in self.WalkTree():\r
#                for F in Filenames:\r
#                    if os.path.splitext(F)[1] in ('.h', '.c'):\r
#                        FullName = os.path.join(Dirpath, F)\r
#                        c.CheckDeclNoUseCType(FullName)\r
            for FullName in EccGlobalData.gCFileList + EccGlobalData.gHFileList:\r
                c.CheckDeclNoUseCType(FullName)\r
\r
    # Check whether the modifiers IN, OUT, OPTIONAL, and UNALIGNED are used only to qualify arguments to a function and should not appear in a data type declaration\r
    def DeclCheckInOutModifier(self):\r
        if EccGlobalData.gConfig.DeclarationDataTypeCheckInOutModifier == '1' or EccGlobalData.gConfig.DeclarationDataTypeCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
            EdkLogger.quiet("Checking Declaration argument modifier ...")\r
\r
#            for Dirpath, Dirnames, Filenames in self.WalkTree():\r
#                for F in Filenames:\r
#                    if os.path.splitext(F)[1] in ('.h', '.c'):\r
#                        FullName = os.path.join(Dirpath, F)\r
#                        c.CheckDeclArgModifier(FullName)\r
            for FullName in EccGlobalData.gCFileList + EccGlobalData.gHFileList:\r
                c.CheckDeclArgModifier(FullName)\r
\r
    # Check whether the EFIAPI modifier should be used at the entry of drivers, events, and member functions of protocols\r
    def DeclCheckEFIAPIModifier(self):\r
        if EccGlobalData.gConfig.DeclarationDataTypeCheckEFIAPIModifier == '1' or EccGlobalData.gConfig.DeclarationDataTypeCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
            pass\r
\r
    # Check whether Enumerated Type has a 'typedef' and the name is capital\r
    def DeclCheckEnumeratedType(self):\r
        if EccGlobalData.gConfig.DeclarationDataTypeCheckEnumeratedType == '1' or EccGlobalData.gConfig.DeclarationDataTypeCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
            EdkLogger.quiet("Checking Declaration enum typedef ...")\r
\r
#            for Dirpath, Dirnames, Filenames in self.WalkTree():\r
#                for F in Filenames:\r
#                    if os.path.splitext(F)[1] in ('.h', '.c'):\r
#                        FullName = os.path.join(Dirpath, F)\r
#                        EdkLogger.quiet("[ENUM]" + FullName)\r
#                        c.CheckDeclEnumTypedef(FullName)\r
            for FullName in EccGlobalData.gCFileList + EccGlobalData.gHFileList:\r
                EdkLogger.quiet("[ENUM]" + FullName)\r
                c.CheckDeclEnumTypedef(FullName)\r
\r
    # Check whether Structure Type has a 'typedef' and the name is capital\r
    def DeclCheckStructureDeclaration(self):\r
        if EccGlobalData.gConfig.DeclarationDataTypeCheckStructureDeclaration == '1' or EccGlobalData.gConfig.DeclarationDataTypeCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
            EdkLogger.quiet("Checking Declaration struct typedef ...")\r
\r
#            for Dirpath, Dirnames, Filenames in self.WalkTree():\r
#                for F in Filenames:\r
#                    if os.path.splitext(F)[1] in ('.h', '.c'):\r
#                        FullName = os.path.join(Dirpath, F)\r
#                        EdkLogger.quiet("[STRUCT]" + FullName)\r
#                        c.CheckDeclStructTypedef(FullName)\r
            for FullName in EccGlobalData.gCFileList + EccGlobalData.gHFileList:\r
                EdkLogger.quiet("[STRUCT]" + FullName)\r
                c.CheckDeclStructTypedef(FullName)\r
\r
    # Check whether having same Structure\r
    def DeclCheckSameStructure(self):\r
        if EccGlobalData.gConfig.DeclarationDataTypeCheckSameStructure == '1' or EccGlobalData.gConfig.DeclarationDataTypeCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
            EdkLogger.quiet("Checking same struct ...")\r
            AllStructure = {}\r
            for IdentifierTable in EccGlobalData.gIdentifierTableList:\r
                SqlCommand = """select ID, Name, BelongsToFile from %s where Model = %s""" % (IdentifierTable, MODEL_IDENTIFIER_STRUCTURE)\r
                RecordSet = EccGlobalData.gDb.TblFile.Exec(SqlCommand)\r
                for Record in RecordSet:\r
                    if Record[1] != '':\r
                        if Record[1] not in AllStructure.keys():\r
                            AllStructure[Record[1]] = Record[2]\r
                        else:\r
                            ID = AllStructure[Record[1]]\r
                            SqlCommand = """select FullPath from File where ID = %s """ % ID\r
                            NewRecordSet = EccGlobalData.gDb.TblFile.Exec(SqlCommand)\r
                            OtherMsg = "The structure name '%s' is duplicate" % Record[1]\r
                            if NewRecordSet != []:\r
                                OtherMsg = "The structure name [%s] is duplicate with the one defined in %s, maybe struct NOT typedefed or the typedef new type NOT used to qualify variables" % (Record[1], NewRecordSet[0][0])\r
                            if not EccGlobalData.gException.IsException(ERROR_DECLARATION_DATA_TYPE_CHECK_SAME_STRUCTURE, Record[1]):\r
                                EccGlobalData.gDb.TblReport.Insert(ERROR_DECLARATION_DATA_TYPE_CHECK_SAME_STRUCTURE, OtherMsg=OtherMsg, BelongsToTable=IdentifierTable, BelongsToItem=Record[0])\r
\r
    # Check whether Union Type has a 'typedef' and the name is capital\r
    def DeclCheckUnionType(self):\r
        if EccGlobalData.gConfig.DeclarationDataTypeCheckUnionType == '1' or EccGlobalData.gConfig.DeclarationDataTypeCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
            EdkLogger.quiet("Checking Declaration union typedef ...")\r
\r
#            for Dirpath, Dirnames, Filenames in self.WalkTree():\r
#                for F in Filenames:\r
#                    if os.path.splitext(F)[1] in ('.h', '.c'):\r
#                        FullName = os.path.join(Dirpath, F)\r
#                        EdkLogger.quiet("[UNION]" + FullName)\r
#                        c.CheckDeclUnionTypedef(FullName)\r
            for FullName in EccGlobalData.gCFileList + EccGlobalData.gHFileList:\r
                EdkLogger.quiet("[UNION]" + FullName)\r
                c.CheckDeclUnionTypedef(FullName)\r
\r
    # Predicate Expression Checking\r
    def PredicateExpressionCheck(self):\r
        self.PredicateExpressionCheckBooleanValue()\r
        self.PredicateExpressionCheckNonBooleanOperator()\r
        self.PredicateExpressionCheckComparisonNullType()\r
\r
    # Check whether Boolean values, variable type BOOLEAN not use explicit comparisons to TRUE or FALSE\r
    def PredicateExpressionCheckBooleanValue(self):\r
        if EccGlobalData.gConfig.PredicateExpressionCheckBooleanValue == '1' or EccGlobalData.gConfig.PredicateExpressionCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
            EdkLogger.quiet("Checking predicate expression Boolean value ...")\r
\r
#            for Dirpath, Dirnames, Filenames in self.WalkTree():\r
#                for F in Filenames:\r
#                    if os.path.splitext(F)[1] in ('.c'):\r
#                        FullName = os.path.join(Dirpath, F)\r
#                        EdkLogger.quiet("[BOOLEAN]" + FullName)\r
#                        c.CheckBooleanValueComparison(FullName)\r
            for FullName in EccGlobalData.gCFileList:\r
                EdkLogger.quiet("[BOOLEAN]" + FullName)\r
                c.CheckBooleanValueComparison(FullName)\r
\r
    # Check whether Non-Boolean comparisons use a compare operator (==, !=, >, < >=, <=).\r
    def PredicateExpressionCheckNonBooleanOperator(self):\r
        if EccGlobalData.gConfig.PredicateExpressionCheckNonBooleanOperator == '1' or EccGlobalData.gConfig.PredicateExpressionCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
            EdkLogger.quiet("Checking predicate expression Non-Boolean variable...")\r
\r
#            for Dirpath, Dirnames, Filenames in self.WalkTree():\r
#                for F in Filenames:\r
#                    if os.path.splitext(F)[1] in ('.c'):\r
#                        FullName = os.path.join(Dirpath, F)\r
#                        EdkLogger.quiet("[NON-BOOLEAN]" + FullName)\r
#                        c.CheckNonBooleanValueComparison(FullName)\r
            for FullName in EccGlobalData.gCFileList:\r
                EdkLogger.quiet("[NON-BOOLEAN]" + FullName)\r
                c.CheckNonBooleanValueComparison(FullName)\r
\r
    # Check whether a comparison of any pointer to zero must be done via the NULL type\r
    def PredicateExpressionCheckComparisonNullType(self):\r
        if EccGlobalData.gConfig.PredicateExpressionCheckComparisonNullType == '1' or EccGlobalData.gConfig.PredicateExpressionCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
            EdkLogger.quiet("Checking predicate expression NULL pointer ...")\r
\r
#            for Dirpath, Dirnames, Filenames in self.WalkTree():\r
#                for F in Filenames:\r
#                    if os.path.splitext(F)[1] in ('.c'):\r
#                        FullName = os.path.join(Dirpath, F)\r
#                        EdkLogger.quiet("[POINTER]" + FullName)\r
#                        c.CheckPointerNullComparison(FullName)\r
            for FullName in EccGlobalData.gCFileList:\r
                EdkLogger.quiet("[POINTER]" + FullName)\r
                c.CheckPointerNullComparison(FullName)\r
\r
    # Include file checking\r
    def IncludeFileCheck(self):\r
        self.IncludeFileCheckIfndef()\r
        self.IncludeFileCheckData()\r
        self.IncludeFileCheckSameName()\r
\r
    # Check whether having include files with same name\r
    def IncludeFileCheckSameName(self):\r
        if EccGlobalData.gConfig.IncludeFileCheckSameName == '1' or EccGlobalData.gConfig.IncludeFileCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
            EdkLogger.quiet("Checking same header file name ...")\r
            SqlCommand = """select ID, FullPath from File\r
                            where Model = 1002 order by Name """\r
            RecordDict = {}\r
            RecordSet = EccGlobalData.gDb.TblFile.Exec(SqlCommand)\r
            for Record in RecordSet:\r
                List = Record[1].replace('/', '\\').split('\\')\r
                if len(List) >= 2:\r
                    Key = List[-2] + '\\' + List[-1]\r
                else:\r
                    Key = List[0]\r
                if Key not in RecordDict:\r
                    RecordDict[Key] = [Record]\r
                else:\r
                    RecordDict[Key].append(Record)\r
\r
            for Key in RecordDict:\r
                if len(RecordDict[Key]) > 1:\r
                    for Item in RecordDict[Key]:\r
                        Path = Item[1].replace(EccGlobalData.gWorkspace, '')\r
                        if Path.startswith('\\') or Path.startswith('/'):\r
                            Path = Path[1:]\r
                        if not EccGlobalData.gException.IsException(ERROR_INCLUDE_FILE_CHECK_NAME, Path):\r
                            EccGlobalData.gDb.TblReport.Insert(ERROR_INCLUDE_FILE_CHECK_NAME, OtherMsg="The file name for [%s] is duplicate" % Path, BelongsToTable='File', BelongsToItem=Item[0])\r
\r
    # Check whether all include file contents is guarded by a #ifndef statement.\r
    def IncludeFileCheckIfndef(self):\r
        if EccGlobalData.gConfig.IncludeFileCheckIfndefStatement == '1' or EccGlobalData.gConfig.IncludeFileCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
            EdkLogger.quiet("Checking header file ifndef ...")\r
\r
#            for Dirpath, Dirnames, Filenames in self.WalkTree():\r
#                for F in Filenames:\r
#                    if os.path.splitext(F)[1] in ('.h'):\r
#                        FullName = os.path.join(Dirpath, F)\r
#                        MsgList = c.CheckHeaderFileIfndef(FullName)\r
            for FullName in EccGlobalData.gHFileList:\r
                MsgList = c.CheckHeaderFileIfndef(FullName)\r
\r
    # Check whether include files NOT contain code or define data variables\r
    def IncludeFileCheckData(self):\r
        if EccGlobalData.gConfig.IncludeFileCheckData == '1' or EccGlobalData.gConfig.IncludeFileCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
            EdkLogger.quiet("Checking header file data ...")\r
\r
#            for Dirpath, Dirnames, Filenames in self.WalkTree():\r
#                for F in Filenames:\r
#                    if os.path.splitext(F)[1] in ('.h'):\r
#                        FullName = os.path.join(Dirpath, F)\r
#                        MsgList = c.CheckHeaderFileData(FullName)\r
            for FullName in EccGlobalData.gHFileList:\r
                MsgList = c.CheckHeaderFileData(FullName)\r
\r
    # Doxygen document checking\r
    def DoxygenCheck(self):\r
        self.DoxygenCheckFileHeader()\r
        self.DoxygenCheckFunctionHeader()\r
        self.DoxygenCheckCommentDescription()\r
        self.DoxygenCheckCommentFormat()\r
        self.DoxygenCheckCommand()\r
\r
    # Check whether the file headers are followed Doxygen special documentation blocks in section 2.3.5\r
    def DoxygenCheckFileHeader(self):\r
        if EccGlobalData.gConfig.DoxygenCheckFileHeader == '1' or EccGlobalData.gConfig.DoxygenCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
            EdkLogger.quiet("Checking Doxygen file header ...")\r
\r
            for Dirpath, Dirnames, Filenames in self.WalkTree():\r
                for F in Filenames:\r
                    Ext = os.path.splitext(F)[1]\r
                    if Ext in ('.h', '.c'):\r
                        FullName = os.path.join(Dirpath, F)\r
                        MsgList = c.CheckFileHeaderDoxygenComments(FullName)\r
                    elif Ext in ('.inf', '.dec', '.dsc', '.fdf'):\r
                        FullName = os.path.join(Dirpath, F)\r
                        op = open(FullName).readlines()\r
                        if not op[0].startswith('## @file') and op[6].startswith('## @file') and op[7].startswith('## @file'):\r
                            SqlStatement = """ select ID from File where FullPath like '%s'""" % FullName\r
                            ResultSet = EccGlobalData.gDb.TblFile.Exec(SqlStatement)\r
                            for Result in ResultSet:\r
                                Msg = 'INF/DEC/DSC/FDF file header comment should begin with ""## @file""'\r
                                EccGlobalData.gDb.TblReport.Insert(ERROR_DOXYGEN_CHECK_FILE_HEADER, Msg, "File", Result[0])\r
\r
\r
    # Check whether the function headers are followed Doxygen special documentation blocks in section 2.3.5\r
    def DoxygenCheckFunctionHeader(self):\r
        if EccGlobalData.gConfig.DoxygenCheckFunctionHeader == '1' or EccGlobalData.gConfig.DoxygenCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
            EdkLogger.quiet("Checking Doxygen function header ...")\r
\r
#            for Dirpath, Dirnames, Filenames in self.WalkTree():\r
#                for F in Filenames:\r
#                    if os.path.splitext(F)[1] in ('.h', '.c'):\r
#                        FullName = os.path.join(Dirpath, F)\r
#                        MsgList = c.CheckFuncHeaderDoxygenComments(FullName)\r
            for FullName in EccGlobalData.gCFileList + EccGlobalData.gHFileList:\r
                MsgList = c.CheckFuncHeaderDoxygenComments(FullName)\r
\r
\r
    # Check whether the first line of text in a comment block is a brief description of the element being documented.\r
    # The brief description must end with a period.\r
    def DoxygenCheckCommentDescription(self):\r
        if EccGlobalData.gConfig.DoxygenCheckCommentDescription == '1' or EccGlobalData.gConfig.DoxygenCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
            pass\r
\r
    # Check whether comment lines with '///< ... text ...' format, if it is used, it should be after the code section.\r
    def DoxygenCheckCommentFormat(self):\r
        if EccGlobalData.gConfig.DoxygenCheckCommentFormat == '1' or EccGlobalData.gConfig.DoxygenCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
            EdkLogger.quiet("Checking Doxygen comment ///< ...")\r
\r
#            for Dirpath, Dirnames, Filenames in self.WalkTree():\r
#                for F in Filenames:\r
#                    if os.path.splitext(F)[1] in ('.h', '.c'):\r
#                        FullName = os.path.join(Dirpath, F)\r
#                        MsgList = c.CheckDoxygenTripleForwardSlash(FullName)\r
            for FullName in EccGlobalData.gCFileList + EccGlobalData.gHFileList:\r
                MsgList = c.CheckDoxygenTripleForwardSlash(FullName)\r
\r
    # Check whether only Doxygen commands allowed to mark the code are @bug and @todo.\r
    def DoxygenCheckCommand(self):\r
        if EccGlobalData.gConfig.DoxygenCheckCommand == '1' or EccGlobalData.gConfig.DoxygenCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
            EdkLogger.quiet("Checking Doxygen command ...")\r
\r
#            for Dirpath, Dirnames, Filenames in self.WalkTree():\r
#                for F in Filenames:\r
#                    if os.path.splitext(F)[1] in ('.h', '.c'):\r
#                        FullName = os.path.join(Dirpath, F)\r
#                        MsgList = c.CheckDoxygenCommand(FullName)\r
            for FullName in EccGlobalData.gCFileList + EccGlobalData.gHFileList:\r
                MsgList = c.CheckDoxygenCommand(FullName)\r
\r
    # Meta-Data File Processing Checking\r
    def MetaDataFileCheck(self):\r
        self.MetaDataFileCheckPathName()\r
        self.MetaDataFileCheckGenerateFileList()\r
        self.MetaDataFileCheckLibraryInstance()\r
        self.MetaDataFileCheckLibraryInstanceDependent()\r
        self.MetaDataFileCheckLibraryInstanceOrder()\r
        self.MetaDataFileCheckLibraryNoUse()\r
        self.MetaDataFileCheckBinaryInfInFdf()\r
        self.MetaDataFileCheckPcdDuplicate()\r
        self.MetaDataFileCheckPcdFlash()\r
        self.MetaDataFileCheckPcdNoUse()\r
        self.MetaDataFileCheckGuidDuplicate()\r
        self.MetaDataFileCheckModuleFileNoUse()\r
        self.MetaDataFileCheckPcdType()\r
        self.MetaDataFileCheckModuleFileGuidDuplication()\r
\r
    # Check whether each file defined in meta-data exists\r
    def MetaDataFileCheckPathName(self):\r
        if EccGlobalData.gConfig.MetaDataFileCheckPathName == '1' or EccGlobalData.gConfig.MetaDataFileCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
            # This item is covered when parsing Inf/Dec/Dsc files\r
            pass\r
\r
    # Generate a list for all files defined in meta-data files\r
    def MetaDataFileCheckGenerateFileList(self):\r
        if EccGlobalData.gConfig.MetaDataFileCheckGenerateFileList == '1' or EccGlobalData.gConfig.MetaDataFileCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
            # This item is covered when parsing Inf/Dec/Dsc files\r
            pass\r
\r
    # Check whether all Library Instances defined for a given module (or dependent library instance) match the module's type.\r
    # Each Library Instance must specify the Supported Module Types in its Inf file,\r
    # and any module specifying the library instance must be one of the supported types.\r
    def MetaDataFileCheckLibraryInstance(self):\r
        if EccGlobalData.gConfig.MetaDataFileCheckLibraryInstance == '1' or EccGlobalData.gConfig.MetaDataFileCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
            EdkLogger.quiet("Checking for library instance type issue ...")\r
            SqlCommand = """select A.ID, A.Value2, B.Value2 from Inf as A left join Inf as B\r
                            where A.Value1 = 'LIBRARY_CLASS' and A.Model = %s\r
                            and B.Value1 = 'MODULE_TYPE' and B.Model = %s and A.BelongsToFile = B.BelongsToFile\r
                            group by A.BelongsToFile""" % (MODEL_META_DATA_HEADER, MODEL_META_DATA_HEADER)\r
            RecordSet = EccGlobalData.gDb.TblInf.Exec(SqlCommand)\r
            LibraryClasses = {}\r
            for Record in RecordSet:\r
                List = Record[1].split('|', 1)\r
                SupModType = []\r
                if len(List) == 1:\r
                    SupModType = SUP_MODULE_LIST_STRING.split(TAB_VALUE_SPLIT)\r
                elif len(List) == 2:\r
                    SupModType = List[1].split()\r
\r
                if List[0] not in LibraryClasses:\r
                    LibraryClasses[List[0]] = SupModType\r
                else:\r
                    for Item in SupModType:\r
                        if Item not in LibraryClasses[List[0]]:\r
                            LibraryClasses[List[0]].append(Item)\r
\r
                if Record[2] != 'BASE' and Record[2] not in SupModType:\r
                    EccGlobalData.gDb.TblReport.Insert(ERROR_META_DATA_FILE_CHECK_LIBRARY_INSTANCE_2, OtherMsg="The Library Class '%s' does not specify its supported module types" % (List[0]), BelongsToTable='Inf', BelongsToItem=Record[0])\r
\r
            SqlCommand = """select A.ID, A.Value1, B.Value2 from Inf as A left join Inf as B\r
                            where A.Model = %s and B.Value1 = '%s' and B.Model = %s\r
                            and B.BelongsToFile = A.BelongsToFile""" \\r
                            % (MODEL_EFI_LIBRARY_CLASS, 'MODULE_TYPE', MODEL_META_DATA_HEADER)\r
            RecordSet = EccGlobalData.gDb.TblInf.Exec(SqlCommand)\r
            # Merge all LibraryClasses' supmodlist\r
            RecordDict = {}\r
            for Record in RecordSet:\r
                if Record[1] not in RecordDict:\r
                    RecordDict[Record[1]] = [str(Record[2])]\r
                else:\r
                    if Record[2] not in RecordDict[Record[1]]:\r
                        RecordDict[Record[1]].append(Record[2])\r
\r
            for Record in RecordSet:\r
                if Record[1] in LibraryClasses:\r
                    if Record[2] not in LibraryClasses[Record[1]] and 'BASE' not in RecordDict[Record[1]]:\r
                        if not EccGlobalData.gException.IsException(ERROR_META_DATA_FILE_CHECK_LIBRARY_INSTANCE_1, Record[1]):\r
                            EccGlobalData.gDb.TblReport.Insert(ERROR_META_DATA_FILE_CHECK_LIBRARY_INSTANCE_1, OtherMsg="The type of Library Class [%s] defined in Inf file does not match the type of the module" % (Record[1]), BelongsToTable='Inf', BelongsToItem=Record[0])\r
                else:\r
                    if not EccGlobalData.gException.IsException(ERROR_META_DATA_FILE_CHECK_LIBRARY_INSTANCE_1, Record[1]):\r
                        EccGlobalData.gDb.TblReport.Insert(ERROR_META_DATA_FILE_CHECK_LIBRARY_INSTANCE_1, OtherMsg="The type of Library Class [%s] defined in Inf file does not match the type of the module" % (Record[1]), BelongsToTable='Inf', BelongsToItem=Record[0])\r
\r
    # Check whether a Library Instance has been defined for all dependent library classes\r
    def MetaDataFileCheckLibraryInstanceDependent(self):\r
        if EccGlobalData.gConfig.MetaDataFileCheckLibraryInstanceDependent == '1' or EccGlobalData.gConfig.MetaDataFileCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
            EdkLogger.quiet("Checking for library instance dependent issue ...")\r
            SqlCommand = """select ID, Value1, Value2 from Dsc where Model = %s""" % MODEL_EFI_LIBRARY_CLASS\r
            LibraryClasses = EccGlobalData.gDb.TblDsc.Exec(SqlCommand)\r
            for LibraryClass in LibraryClasses:\r
                if LibraryClass[1].upper() != 'NULL':\r
                    LibraryIns = os.path.normpath(os.path.join(EccGlobalData.gWorkspace, LibraryClass[2]))\r
                    SqlCommand = """select Value2 from Inf where BelongsToFile =\r
                                    (select ID from File where lower(FullPath) = lower('%s'))\r
                                    and Value1 = '%s'""" % (LibraryIns, 'LIBRARY_CLASS')\r
                    RecordSet = EccGlobalData.gDb.TblInf.Exec(SqlCommand)\r
                    IsFound = False\r
                    for Record in RecordSet:\r
                        LibName = Record[0].split('|', 1)[0]\r
                        if LibraryClass[1] == LibName:\r
                            IsFound = True\r
                    if not IsFound:\r
                        if not EccGlobalData.gException.IsException(ERROR_META_DATA_FILE_CHECK_LIBRARY_INSTANCE_DEPENDENT, LibraryClass[1]):\r
                            EccGlobalData.gDb.TblReport.Insert(ERROR_META_DATA_FILE_CHECK_LIBRARY_INSTANCE_DEPENDENT, OtherMsg="The Library Class [%s] is not specified in '%s'" % (LibraryClass[1], LibraryClass[2]), BelongsToTable='Dsc', BelongsToItem=LibraryClass[0])\r
\r
    # Check whether the Library Instances specified by the LibraryClasses sections are listed in order of dependencies\r
    def MetaDataFileCheckLibraryInstanceOrder(self):\r
        if EccGlobalData.gConfig.MetaDataFileCheckLibraryInstanceOrder == '1' or EccGlobalData.gConfig.MetaDataFileCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
            # This checkpoint is not necessary for Ecc check\r
            pass\r
\r
    # Check whether the unnecessary inclusion of library classes in the Inf file\r
    # Check whether the unnecessary duplication of library classe names in the DSC file\r
    def MetaDataFileCheckLibraryNoUse(self):\r
        if EccGlobalData.gConfig.MetaDataFileCheckLibraryNoUse == '1' or EccGlobalData.gConfig.MetaDataFileCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
            EdkLogger.quiet("Checking for library instance not used ...")\r
            SqlCommand = """select ID, Value1 from Inf as A where A.Model = %s and A.Value1 not in (select B.Value1 from Dsc as B where Model = %s)""" % (MODEL_EFI_LIBRARY_CLASS, MODEL_EFI_LIBRARY_CLASS)\r
            RecordSet = EccGlobalData.gDb.TblInf.Exec(SqlCommand)\r
            for Record in RecordSet:\r
                if not EccGlobalData.gException.IsException(ERROR_META_DATA_FILE_CHECK_LIBRARY_NO_USE, Record[1]):\r
                    EccGlobalData.gDb.TblReport.Insert(ERROR_META_DATA_FILE_CHECK_LIBRARY_NO_USE, OtherMsg="The Library Class [%s] is not used in any platform" % (Record[1]), BelongsToTable='Inf', BelongsToItem=Record[0])\r
            SqlCommand = """\r
                         select A.ID, A.Value1, A.BelongsToFile, A.StartLine, B.StartLine from Dsc as A left join Dsc as B\r
                         where A.Model = %s and B.Model = %s and A.Value3 = B.Value3 and A.Arch = B.Arch and A.ID <> B.ID\r
                         and A.Value1 = B.Value1 and A.StartLine <> B.StartLine and B.BelongsToFile = A.BelongsToFile""" \\r
                            % (MODEL_EFI_LIBRARY_CLASS, MODEL_EFI_LIBRARY_CLASS)\r
            RecordSet = EccGlobalData.gDb.TblDsc.Exec(SqlCommand)\r
            for Record in RecordSet:\r
                if Record[3] and Record[4] and Record[3] != Record[4]:\r
                    SqlCommand = """select FullPath from File where ID = %s""" % (Record[2])\r
                    FilePathList = EccGlobalData.gDb.TblFile.Exec(SqlCommand)\r
                    for FilePath in FilePathList:\r
                        if not EccGlobalData.gException.IsException(ERROR_META_DATA_FILE_CHECK_LIBRARY_NAME_DUPLICATE, Record[1]):\r
                            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])\r
                                                \r
    # Check whether an Inf file is specified in the FDF file, but not in the Dsc file, then the Inf file must be for a Binary module only\r
    def MetaDataFileCheckBinaryInfInFdf(self):\r
        if EccGlobalData.gConfig.MetaDataFileCheckBinaryInfInFdf == '1' or EccGlobalData.gConfig.MetaDataFileCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
            EdkLogger.quiet("Checking for non-binary modules defined in FDF files ...")\r
            SqlCommand = """select A.ID, A.Value1 from Fdf as A\r
                         where A.Model = %s\r
                         and A.Enabled > -1\r
                         and A.Value1 not in\r
                         (select B.Value1 from Dsc as B\r
                         where B.Model = %s\r
                         and B.Enabled > -1)""" % (MODEL_META_DATA_COMPONENT, MODEL_META_DATA_COMPONENT)\r
            RecordSet = EccGlobalData.gDb.TblFdf.Exec(SqlCommand)\r
            for Record in RecordSet:\r
                FdfID = Record[0]\r
                FilePath = Record[1]\r
                FilePath = os.path.normpath(os.path.join(EccGlobalData.gWorkspace, FilePath))\r
                SqlCommand = """select ID from Inf where Model = %s and BelongsToFile = (select ID from File where FullPath like '%s')\r
                                """ % (MODEL_EFI_SOURCE_FILE, FilePath)\r
                NewRecordSet = EccGlobalData.gDb.TblFile.Exec(SqlCommand)\r
                if NewRecordSet != []:\r
                    if not EccGlobalData.gException.IsException(ERROR_META_DATA_FILE_CHECK_BINARY_INF_IN_FDF, FilePath):\r
                        EccGlobalData.gDb.TblReport.Insert(ERROR_META_DATA_FILE_CHECK_BINARY_INF_IN_FDF, OtherMsg="File [%s] defined in FDF file and not in DSC file must be a binary module" % (FilePath), BelongsToTable='Fdf', BelongsToItem=FdfID)\r
\r
    # Check whether a PCD is set in a Dsc file or the FDF file, but not in both.\r
    def MetaDataFileCheckPcdDuplicate(self):\r
        if EccGlobalData.gConfig.MetaDataFileCheckPcdDuplicate == '1' or EccGlobalData.gConfig.MetaDataFileCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
            EdkLogger.quiet("Checking for duplicate PCDs defined in both DSC and FDF files ...")\r
            SqlCommand = """\r
                         select A.ID, A.Value2, A.BelongsToFile, B.ID, B.Value2, B.BelongsToFile from Dsc as A, Fdf as B\r
                         where A.Model >= %s and A.Model < %s\r
                         and B.Model >= %s and B.Model < %s\r
                         and A.Value2 = B.Value2\r
                         and A.Enabled > -1\r
                         and B.Enabled > -1\r
                         group by A.ID\r
                         """ % (MODEL_PCD, MODEL_META_DATA_HEADER, MODEL_PCD, MODEL_META_DATA_HEADER)\r
            RecordSet = EccGlobalData.gDb.TblDsc.Exec(SqlCommand)\r
            for Record in RecordSet:\r
                SqlCommand1 = """select Name from File where ID = %s""" % Record[2]\r
                SqlCommand2 = """select Name from File where ID = %s""" % Record[5]\r
                DscFileName = os.path.splitext(EccGlobalData.gDb.TblDsc.Exec(SqlCommand1)[0][0])[0]\r
                FdfFileName = os.path.splitext(EccGlobalData.gDb.TblDsc.Exec(SqlCommand2)[0][0])[0]\r
                if DscFileName != FdfFileName:\r
                    continue\r
                if not EccGlobalData.gException.IsException(ERROR_META_DATA_FILE_CHECK_PCD_DUPLICATE, Record[1]):\r
                    EccGlobalData.gDb.TblReport.Insert(ERROR_META_DATA_FILE_CHECK_PCD_DUPLICATE, OtherMsg="The PCD [%s] is defined in both FDF file and DSC file" % (Record[1]), BelongsToTable='Dsc', BelongsToItem=Record[0])\r
                if not EccGlobalData.gException.IsException(ERROR_META_DATA_FILE_CHECK_PCD_DUPLICATE, Record[3]):\r
                    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[4]), BelongsToTable='Fdf', BelongsToItem=Record[3])\r
\r
            EdkLogger.quiet("Checking for duplicate PCDs defined in DEC files ...")\r
            SqlCommand = """\r
                         select A.ID, A.Value2 from Dec as A, Dec as B\r
                         where A.Model >= %s and A.Model < %s\r
                         and B.Model >= %s and B.Model < %s\r
                         and A.Value2 = B.Value2\r
                         and ((A.Arch = B.Arch) and (A.Arch != 'COMMON' or B.Arch != 'COMMON'))\r
                         and A.ID != B.ID\r
                         and A.Enabled > -1\r
                         and B.Enabled > -1\r
                         and A.BelongsToFile = B.BelongsToFile\r
                         group by A.ID\r
                         """ % (MODEL_PCD, MODEL_META_DATA_HEADER, MODEL_PCD, MODEL_META_DATA_HEADER)\r
            RecordSet = EccGlobalData.gDb.TblDsc.Exec(SqlCommand)\r
            for Record in RecordSet:\r
                if not EccGlobalData.gException.IsException(ERROR_META_DATA_FILE_CHECK_PCD_DUPLICATE, Record[1]):\r
                    EccGlobalData.gDb.TblReport.Insert(ERROR_META_DATA_FILE_CHECK_PCD_DUPLICATE, OtherMsg="The PCD [%s] is defined duplicated in DEC file" % (Record[1]), BelongsToTable='Dec', BelongsToItem=Record[0])\r
\r
    # Check whether PCD settings in the FDF file can only be related to flash.\r
    def MetaDataFileCheckPcdFlash(self):\r
        if EccGlobalData.gConfig.MetaDataFileCheckPcdFlash == '1' or EccGlobalData.gConfig.MetaDataFileCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
            EdkLogger.quiet("Checking only Flash related PCDs are used in FDF ...")\r
            SqlCommand = """\r
                         select ID, Value2, BelongsToFile from Fdf as A\r
                         where A.Model >= %s and Model < %s\r
                         and A.Enabled > -1\r
                         and A.Value2 not like '%%Flash%%'\r
                         """ % (MODEL_PCD, MODEL_META_DATA_HEADER)\r
            RecordSet = EccGlobalData.gDb.TblFdf.Exec(SqlCommand)\r
            for Record in RecordSet:\r
                if not EccGlobalData.gException.IsException(ERROR_META_DATA_FILE_CHECK_PCD_FLASH, Record[1]):\r
                    EccGlobalData.gDb.TblReport.Insert(ERROR_META_DATA_FILE_CHECK_PCD_FLASH, OtherMsg="The PCD [%s] defined in FDF file is not related to Flash" % (Record[1]), BelongsToTable='Fdf', BelongsToItem=Record[0])\r
\r
    # Check whether PCDs used in Inf files but not specified in Dsc or FDF files\r
    def MetaDataFileCheckPcdNoUse(self):\r
        if EccGlobalData.gConfig.MetaDataFileCheckPcdNoUse == '1' or EccGlobalData.gConfig.MetaDataFileCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
            EdkLogger.quiet("Checking for non-specified PCDs ...")\r
            SqlCommand = """\r
                         select ID, Value2, BelongsToFile from Inf as A\r
                         where A.Model >= %s and Model < %s\r
                         and A.Enabled > -1\r
                         and A.Value2 not in\r
                             (select Value2 from Dsc as B\r
                              where B.Model >= %s and B.Model < %s\r
                              and B.Enabled > -1)\r
                         and A.Value2 not in\r
                             (select Value2 from Fdf as C\r
                              where C.Model >= %s and C.Model < %s\r
                              and C.Enabled > -1)\r
                         """ % (MODEL_PCD, MODEL_META_DATA_HEADER, MODEL_PCD, MODEL_META_DATA_HEADER, MODEL_PCD, MODEL_META_DATA_HEADER)\r
            RecordSet = EccGlobalData.gDb.TblInf.Exec(SqlCommand)\r
            for Record in RecordSet:\r
                if not EccGlobalData.gException.IsException(ERROR_META_DATA_FILE_CHECK_PCD_NO_USE, Record[1]):\r
                    EccGlobalData.gDb.TblReport.Insert(ERROR_META_DATA_FILE_CHECK_PCD_NO_USE, OtherMsg="The PCD [%s] defined in INF file is not specified in either DSC or FDF files" % (Record[1]), BelongsToTable='Inf', BelongsToItem=Record[0])\r
\r
    # Check whether having duplicate guids defined for Guid/Protocol/Ppi\r
    def MetaDataFileCheckGuidDuplicate(self):\r
        if EccGlobalData.gConfig.MetaDataFileCheckGuidDuplicate == '1' or EccGlobalData.gConfig.MetaDataFileCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
            EdkLogger.quiet("Checking for duplicate GUID/PPI/PROTOCOL ...")\r
            # Check Guid\r
            self.CheckGuidProtocolPpi(ERROR_META_DATA_FILE_CHECK_DUPLICATE_GUID, MODEL_EFI_GUID, EccGlobalData.gDb.TblDec)\r
            self.CheckGuidProtocolPpi(ERROR_META_DATA_FILE_CHECK_DUPLICATE_GUID, MODEL_EFI_GUID, EccGlobalData.gDb.TblDsc)\r
            self.CheckGuidProtocolPpiValue(ERROR_META_DATA_FILE_CHECK_DUPLICATE_GUID, MODEL_EFI_GUID)\r
            # Check protocol\r
            self.CheckGuidProtocolPpi(ERROR_META_DATA_FILE_CHECK_DUPLICATE_PROTOCOL, MODEL_EFI_PROTOCOL, EccGlobalData.gDb.TblDec)\r
            self.CheckGuidProtocolPpi(ERROR_META_DATA_FILE_CHECK_DUPLICATE_PROTOCOL, MODEL_EFI_PROTOCOL, EccGlobalData.gDb.TblDsc)\r
            self.CheckGuidProtocolPpiValue(ERROR_META_DATA_FILE_CHECK_DUPLICATE_PROTOCOL, MODEL_EFI_PROTOCOL)\r
            # Check ppi\r
            self.CheckGuidProtocolPpi(ERROR_META_DATA_FILE_CHECK_DUPLICATE_PPI, MODEL_EFI_PPI, EccGlobalData.gDb.TblDec)\r
            self.CheckGuidProtocolPpi(ERROR_META_DATA_FILE_CHECK_DUPLICATE_PPI, MODEL_EFI_PPI, EccGlobalData.gDb.TblDsc)\r
            self.CheckGuidProtocolPpiValue(ERROR_META_DATA_FILE_CHECK_DUPLICATE_PPI, MODEL_EFI_PPI)\r
\r
    # Check whether all files under module directory are described in INF files\r
    def MetaDataFileCheckModuleFileNoUse(self):\r
        if EccGlobalData.gConfig.MetaDataFileCheckModuleFileNoUse == '1' or EccGlobalData.gConfig.MetaDataFileCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
            EdkLogger.quiet("Checking for no used module files ...")\r
            SqlCommand = """\r
                         select upper(Path) from File where ID in (select BelongsToFile from INF where BelongsToFile != -1)\r
                         """\r
            InfPathSet = EccGlobalData.gDb.TblInf.Exec(SqlCommand)\r
            InfPathList = []\r
            for Item in InfPathSet:\r
                if Item[0] not in InfPathList:\r
                    InfPathList.append(Item[0])\r
            SqlCommand = """\r
                         select ID, Path, FullPath from File where upper(FullPath) not in\r
                            (select upper(A.Path) || '\\' || upper(B.Value1) from File as A, INF as B\r
                            where A.ID in (select BelongsToFile from INF where Model = %s group by BelongsToFile) and\r
                            B.BelongsToFile = A.ID and B.Model = %s)\r
                            and (Model = %s or Model = %s)\r
                        """ % (MODEL_EFI_SOURCE_FILE, MODEL_EFI_SOURCE_FILE, MODEL_FILE_C, MODEL_FILE_H)\r
            RecordSet = EccGlobalData.gDb.TblInf.Exec(SqlCommand)\r
            for Record in RecordSet:\r
                Path = Record[1]\r
                Path = Path.upper().replace('\X64', '').replace('\IA32', '').replace('\EBC', '').replace('\IPF', '').replace('\ARM', '')\r
                if Path in InfPathList:\r
                    if not EccGlobalData.gException.IsException(ERROR_META_DATA_FILE_CHECK_MODULE_FILE_NO_USE, Record[2]):\r
                        EccGlobalData.gDb.TblReport.Insert(ERROR_META_DATA_FILE_CHECK_MODULE_FILE_NO_USE, OtherMsg="The source file [%s] is existing in module directory but it is not described in INF file." % (Record[2]), BelongsToTable='File', BelongsToItem=Record[0])\r
\r
    # Check whether the PCD is correctly used in C function via its type\r
    def MetaDataFileCheckPcdType(self):\r
        if EccGlobalData.gConfig.MetaDataFileCheckPcdType == '1' or EccGlobalData.gConfig.MetaDataFileCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
            EdkLogger.quiet("Checking for pcd type in c code function usage ...")\r
            SqlCommand = """\r
                         select ID, Model, Value1, BelongsToFile from INF where Model > %s and Model < %s\r
                         """ % (MODEL_PCD, MODEL_META_DATA_HEADER)\r
            PcdSet = EccGlobalData.gDb.TblInf.Exec(SqlCommand)\r
            for Pcd in PcdSet:\r
                Model = Pcd[1]\r
                PcdName = Pcd[2]\r
                if len(Pcd[2].split(".")) > 1:\r
                    PcdName = Pcd[2].split(".")[1]\r
                BelongsToFile = Pcd[3]\r
                SqlCommand = """\r
                             select ID from File where FullPath in\r
                            (select B.Path || '\\' || A.Value1 from INF as A, File as B where A.Model = %s and A.BelongsToFile = %s\r
                             and B.ID = %s and (B.Model = %s or B.Model = %s))\r
                             """ % (MODEL_EFI_SOURCE_FILE, BelongsToFile, BelongsToFile, MODEL_FILE_C, MODEL_FILE_H)\r
                TableSet = EccGlobalData.gDb.TblFile.Exec(SqlCommand)\r
                for Tbl in TableSet:\r
                    TblName = 'Identifier' + str(Tbl[0])\r
                    SqlCommand = """\r
                                 select Name, ID from %s where value like '%s' and Model = %s\r
                                 """ % (TblName, PcdName, MODEL_IDENTIFIER_FUNCTION_CALLING)\r
                    RecordSet = EccGlobalData.gDb.TblInf.Exec(SqlCommand)\r
                    TblNumber = TblName.replace('Identifier', '')\r
                    for Record in RecordSet:\r
                        FunName = Record[0]\r
                        if not EccGlobalData.gException.IsException(ERROR_META_DATA_FILE_CHECK_PCD_TYPE, FunName):\r
                            if Model in [MODEL_PCD_FIXED_AT_BUILD] and not FunName.startswith('FixedPcdGet'):\r
                                EccGlobalData.gDb.TblReport.Insert(ERROR_META_DATA_FILE_CHECK_PCD_TYPE, OtherMsg="The pcd '%s' is defined as a FixPcd but now it is called by c function [%s]" % (PcdName, FunName), BelongsToTable=TblName, BelongsToItem=Record[1])\r
                            if Model in [MODEL_PCD_FEATURE_FLAG] and (not FunName.startswith('FeaturePcdGet') and not FunName.startswith('FeaturePcdSet')):\r
                                EccGlobalData.gDb.TblReport.Insert(ERROR_META_DATA_FILE_CHECK_PCD_TYPE, OtherMsg="The pcd '%s' is defined as a FeaturePcd but now it is called by c function [%s]" % (PcdName, FunName), BelongsToTable=TblName, BelongsToItem=Record[1])\r
                            if Model in [MODEL_PCD_PATCHABLE_IN_MODULE] and (not FunName.startswith('PatchablePcdGet') and not FunName.startswith('PatchablePcdSet')):\r
                                EccGlobalData.gDb.TblReport.Insert(ERROR_META_DATA_FILE_CHECK_PCD_TYPE, OtherMsg="The pcd '%s' is defined as a PatchablePcd but now it is called by c function [%s]" % (PcdName, FunName), BelongsToTable=TblName, BelongsToItem=Record[1])\r
\r
            #ERROR_META_DATA_FILE_CHECK_PCD_TYPE\r
        pass\r
\r
    # Internal worker function to get the INF workspace relative path from FileID\r
    def GetInfFilePathFromID(self, FileID):\r
        Table = EccGlobalData.gDb.TblFile\r
        SqlCommand = """select A.FullPath from %s as A where A.ID = %s""" % (Table.Table, FileID)\r
        RecordSet = Table.Exec(SqlCommand)\r
        Path = ""\r
        for Record in RecordSet:\r
            Path = Record[0].replace(EccGlobalData.gWorkspace, '')\r
            if Path.startswith('\\') or Path.startswith('/'):\r
                Path = Path[1:]\r
        return Path\r
\r
    # Check whether two module INFs under one workspace has the same FILE_GUID value\r
    def MetaDataFileCheckModuleFileGuidDuplication(self):\r
        if EccGlobalData.gConfig.MetaDataFileCheckModuleFileGuidDuplication == '1' or EccGlobalData.gConfig.MetaDataFileCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
            EdkLogger.quiet("Checking for pcd type in c code function usage ...")\r
            Table = EccGlobalData.gDb.TblInf\r
            SqlCommand = """\r
                         select A.ID, A.Value2, A.BelongsToFile, B.BelongsToFile from %s as A, %s as B\r
                         where A.Value1 = 'FILE_GUID' and B.Value1 = 'FILE_GUID' and\r
                         A.Value2 = B.Value2 and A.ID <> B.ID group by A.ID\r
                         """ % (Table.Table, Table.Table)\r
            RecordSet = Table.Exec(SqlCommand)\r
            for Record in RecordSet:\r
                InfPath1 = self.GetInfFilePathFromID(Record[2])\r
                InfPath2 = self.GetInfFilePathFromID(Record[3])\r
                if InfPath1 and InfPath2:\r
                    if not EccGlobalData.gException.IsException(ERROR_META_DATA_FILE_CHECK_MODULE_FILE_GUID_DUPLICATION, InfPath1):\r
                        Msg = "The FILE_GUID of INF file [%s] is duplicated with that of %s" % (InfPath1, InfPath2)\r
                        EccGlobalData.gDb.TblReport.Insert(ERROR_META_DATA_FILE_CHECK_MODULE_FILE_GUID_DUPLICATION, OtherMsg=Msg, BelongsToTable=Table.Table, BelongsToItem=Record[0])\r
\r
\r
    # Check whether these is duplicate Guid/Ppi/Protocol name\r
    def CheckGuidProtocolPpi(self, ErrorID, Model, Table):\r
        Name = ''\r
        if Model == MODEL_EFI_GUID:\r
            Name = 'guid'\r
        if Model == MODEL_EFI_PROTOCOL:\r
            Name = 'protocol'\r
        if Model == MODEL_EFI_PPI:\r
            Name = 'ppi'\r
        SqlCommand = """\r
                     select A.ID, A.Value1 from %s as A, %s as B\r
                     where A.Model = %s and B.Model = %s\r
                     and A.Value1 = B.Value1 and A.ID <> B.ID\r
                     and A.Arch = B.Arch\r
                     and A.Enabled > -1\r
                     and B.Enabled > -1\r
                     group by A.ID\r
                     """ % (Table.Table, Table.Table, Model, Model)\r
        RecordSet = Table.Exec(SqlCommand)\r
        for Record in RecordSet:\r
            if not EccGlobalData.gException.IsException(ErrorID, Record[1]):\r
                EccGlobalData.gDb.TblReport.Insert(ErrorID, OtherMsg="The %s name [%s] is defined more than one time" % (Name.upper(), Record[1]), BelongsToTable=Table.Table, BelongsToItem=Record[0])\r
\r
    # Check whether these is duplicate Guid/Ppi/Protocol value\r
    def CheckGuidProtocolPpiValue(self, ErrorID, Model):\r
        Name = ''\r
        Table = EccGlobalData.gDb.TblDec\r
        if Model == MODEL_EFI_GUID:\r
            Name = 'guid'\r
        if Model == MODEL_EFI_PROTOCOL:\r
            Name = 'protocol'\r
        if Model == MODEL_EFI_PPI:\r
            Name = 'ppi'\r
        SqlCommand = """\r
                     select A.ID, A.Value2 from %s as A, %s as B\r
                     where A.Model = %s and B.Model = %s\r
                     and A.Value2 = B.Value2 and A.ID <> B.ID\r
                     and A.Arch = B.Arch\r
                     group by A.ID\r
                     """ % (Table.Table, Table.Table, Model, Model)\r
        RecordSet = Table.Exec(SqlCommand)\r
        for Record in RecordSet:\r
            if not EccGlobalData.gException.IsException(ErrorID, Record[1]):\r
                EccGlobalData.gDb.TblReport.Insert(ErrorID, OtherMsg="The %s value [%s] is used more than one time" % (Name.upper(), Record[1]), BelongsToTable=Table.Table, BelongsToItem=Record[0])\r
\r
    # Naming Convention Check\r
    def NamingConventionCheck(self):\r
        if EccGlobalData.gConfig.NamingConventionCheckDefineStatement == '1' \\r
        or EccGlobalData.gConfig.NamingConventionCheckTypedefStatement == '1' \\r
        or EccGlobalData.gConfig.NamingConventionCheckIfndefStatement == '1' \\r
        or EccGlobalData.gConfig.NamingConventionCheckVariableName == '1' \\r
        or EccGlobalData.gConfig.NamingConventionCheckSingleCharacterVariable == '1' \\r
        or EccGlobalData.gConfig.NamingConventionCheckAll == '1'\\r
        or EccGlobalData.gConfig.CheckAll == '1':\r
            for Dirpath, Dirnames, Filenames in self.WalkTree():\r
                for F in Filenames:\r
                    if os.path.splitext(F)[1] in ('.h', '.c'):\r
                        FullName = os.path.join(Dirpath, F)\r
                        Id = c.GetTableID(FullName)\r
                        if Id < 0:\r
                            continue\r
                        FileTable = 'Identifier' + str(Id)\r
                        self.NamingConventionCheckDefineStatement(FileTable)\r
                        self.NamingConventionCheckTypedefStatement(FileTable)\r
                        self.NamingConventionCheckIfndefStatement(FileTable)\r
                        self.NamingConventionCheckVariableName(FileTable)\r
                        self.NamingConventionCheckSingleCharacterVariable(FileTable)\r
\r
        self.NamingConventionCheckPathName()\r
        self.NamingConventionCheckFunctionName()\r
\r
    # Check whether only capital letters are used for #define declarations\r
    def NamingConventionCheckDefineStatement(self, FileTable):\r
        if EccGlobalData.gConfig.NamingConventionCheckDefineStatement == '1' or EccGlobalData.gConfig.NamingConventionCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
            EdkLogger.quiet("Checking naming covention of #define statement ...")\r
\r
            SqlCommand = """select ID, Value from %s where Model = %s""" % (FileTable, MODEL_IDENTIFIER_MACRO_DEFINE)\r
            RecordSet = EccGlobalData.gDb.TblFile.Exec(SqlCommand)\r
            for Record in RecordSet:\r
                Name = Record[1].strip().split()[1]\r
                if Name.find('(') != -1:\r
                    Name = Name[0:Name.find('(')]\r
                if Name.upper() != Name:\r
                    if not EccGlobalData.gException.IsException(ERROR_NAMING_CONVENTION_CHECK_DEFINE_STATEMENT, Name):\r
                        EccGlobalData.gDb.TblReport.Insert(ERROR_NAMING_CONVENTION_CHECK_DEFINE_STATEMENT, OtherMsg="The #define name [%s] does not follow the rules" % (Name), BelongsToTable=FileTable, BelongsToItem=Record[0])\r
\r
    # Check whether only capital letters are used for typedef declarations\r
    def NamingConventionCheckTypedefStatement(self, FileTable):\r
        if EccGlobalData.gConfig.NamingConventionCheckTypedefStatement == '1' or EccGlobalData.gConfig.NamingConventionCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
            EdkLogger.quiet("Checking naming covention of #typedef statement ...")\r
\r
            SqlCommand = """select ID, Name from %s where Model = %s""" % (FileTable, MODEL_IDENTIFIER_TYPEDEF)\r
            RecordSet = EccGlobalData.gDb.TblFile.Exec(SqlCommand)\r
            for Record in RecordSet:\r
                Name = Record[1].strip()\r
                if Name != '' and Name != None:\r
                    if Name[0] == '(':\r
                        Name = Name[1:Name.find(')')]\r
                    if Name.find('(') > -1:\r
                        Name = Name[Name.find('(') + 1 : Name.find(')')]\r
                    Name = Name.replace('WINAPI', '')\r
                    Name = Name.replace('*', '').strip()\r
                    if Name.upper() != Name:\r
                        if not EccGlobalData.gException.IsException(ERROR_NAMING_CONVENTION_CHECK_TYPEDEF_STATEMENT, Name):\r
                            EccGlobalData.gDb.TblReport.Insert(ERROR_NAMING_CONVENTION_CHECK_TYPEDEF_STATEMENT, OtherMsg="The #typedef name [%s] does not follow the rules" % (Name), BelongsToTable=FileTable, BelongsToItem=Record[0])\r
\r
    # Check whether the #ifndef at the start of an include file uses both prefix and postfix underscore characters, '_'.\r
    def NamingConventionCheckIfndefStatement(self, FileTable):\r
        if EccGlobalData.gConfig.NamingConventionCheckTypedefStatement == '1' or EccGlobalData.gConfig.NamingConventionCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
            EdkLogger.quiet("Checking naming covention of #ifndef statement ...")\r
\r
            SqlCommand = """select ID, Value from %s where Model = %s""" % (FileTable, MODEL_IDENTIFIER_MACRO_IFNDEF)\r
            RecordSet = EccGlobalData.gDb.TblFile.Exec(SqlCommand)\r
            for Record in RecordSet:\r
                Name = Record[1].replace('#ifndef', '').strip()\r
                if Name[0] != '_' or Name[-1] != '_':\r
                    if not EccGlobalData.gException.IsException(ERROR_NAMING_CONVENTION_CHECK_IFNDEF_STATEMENT, Name):\r
                        EccGlobalData.gDb.TblReport.Insert(ERROR_NAMING_CONVENTION_CHECK_IFNDEF_STATEMENT, OtherMsg="The #ifndef name [%s] does not follow the rules" % (Name), BelongsToTable=FileTable, BelongsToItem=Record[0])\r
\r
    # Rule for path name, variable name and function name\r
    # 1. First character should be upper case\r
    # 2. Existing lower case in a word\r
    # 3. No space existence\r
    # Check whether the path name followed the rule\r
    def NamingConventionCheckPathName(self):\r
        if EccGlobalData.gConfig.NamingConventionCheckPathName == '1' or EccGlobalData.gConfig.NamingConventionCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
            EdkLogger.quiet("Checking naming covention of file path name ...")\r
            Pattern = re.compile(r'^[A-Z]+\S*[a-z]\S*$')\r
            SqlCommand = """select ID, Name from File"""\r
            RecordSet = EccGlobalData.gDb.TblFile.Exec(SqlCommand)\r
            for Record in RecordSet:\r
                if not Pattern.match(Record[1]):\r
                    if not EccGlobalData.gException.IsException(ERROR_NAMING_CONVENTION_CHECK_PATH_NAME, Record[1]):\r
                        EccGlobalData.gDb.TblReport.Insert(ERROR_NAMING_CONVENTION_CHECK_PATH_NAME, OtherMsg="The file path [%s] does not follow the rules" % (Record[1]), BelongsToTable='File', BelongsToItem=Record[0])\r
\r
    # Rule for path name, variable name and function name\r
    # 1. First character should be upper case\r
    # 2. Existing lower case in a word\r
    # 3. No space existence\r
    # 4. Global variable name must start with a 'g'\r
    # Check whether the variable name followed the rule\r
    def NamingConventionCheckVariableName(self, FileTable):\r
        if EccGlobalData.gConfig.NamingConventionCheckVariableName == '1' or EccGlobalData.gConfig.NamingConventionCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
            EdkLogger.quiet("Checking naming covention of variable name ...")\r
            Pattern = re.compile(r'^[A-Zgm]+\S*[a-z]\S*$')\r
\r
            SqlCommand = """select ID, Name from %s where Model = %s""" % (FileTable, MODEL_IDENTIFIER_VARIABLE)\r
            RecordSet = EccGlobalData.gDb.TblFile.Exec(SqlCommand)\r
            for Record in RecordSet:\r
                if not Pattern.match(Record[1]):\r
                    if not EccGlobalData.gException.IsException(ERROR_NAMING_CONVENTION_CHECK_VARIABLE_NAME, Record[1]):\r
                        EccGlobalData.gDb.TblReport.Insert(ERROR_NAMING_CONVENTION_CHECK_VARIABLE_NAME, OtherMsg="The variable name [%s] does not follow the rules" % (Record[1]), BelongsToTable=FileTable, BelongsToItem=Record[0])\r
\r
    # Rule for path name, variable name and function name\r
    # 1. First character should be upper case\r
    # 2. Existing lower case in a word\r
    # 3. No space existence\r
    # Check whether the function name followed the rule\r
    def NamingConventionCheckFunctionName(self):\r
        if EccGlobalData.gConfig.NamingConventionCheckFunctionName == '1' or EccGlobalData.gConfig.NamingConventionCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
            EdkLogger.quiet("Checking naming covention of function name ...")\r
            Pattern = re.compile(r'^[A-Z]+\S*[a-z]\S*$')\r
            SqlCommand = """select ID, Name from Function"""\r
            RecordSet = EccGlobalData.gDb.TblFile.Exec(SqlCommand)\r
            for Record in RecordSet:\r
                if not Pattern.match(Record[1]):\r
                    if not EccGlobalData.gException.IsException(ERROR_NAMING_CONVENTION_CHECK_FUNCTION_NAME, Record[1]):\r
                        EccGlobalData.gDb.TblReport.Insert(ERROR_NAMING_CONVENTION_CHECK_FUNCTION_NAME, OtherMsg="The function name [%s] does not follow the rules" % (Record[1]), BelongsToTable='Function', BelongsToItem=Record[0])\r
\r
    # Check whether NO use short variable name with single character\r
    def NamingConventionCheckSingleCharacterVariable(self, FileTable):\r
        if EccGlobalData.gConfig.NamingConventionCheckSingleCharacterVariable == '1' or EccGlobalData.gConfig.NamingConventionCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
            EdkLogger.quiet("Checking naming covention of single character variable name ...")\r
\r
            SqlCommand = """select ID, Name from %s where Model = %s""" % (FileTable, MODEL_IDENTIFIER_VARIABLE)\r
            RecordSet = EccGlobalData.gDb.TblFile.Exec(SqlCommand)\r
            for Record in RecordSet:\r
                Variable = Record[1].replace('*', '')\r
                if len(Variable) == 1:\r
                    if not EccGlobalData.gException.IsException(ERROR_NAMING_CONVENTION_CHECK_SINGLE_CHARACTER_VARIABLE, Record[1]):\r
                        EccGlobalData.gDb.TblReport.Insert(ERROR_NAMING_CONVENTION_CHECK_SINGLE_CHARACTER_VARIABLE, OtherMsg="The variable name [%s] does not follow the rules" % (Record[1]), BelongsToTable=FileTable, BelongsToItem=Record[0])\r
\r
##\r
#\r
# This acts like the main() function for the script, unless it is 'import'ed into another\r
# script.\r
#\r
if __name__ == '__main__':\r
    Check = Check()\r
    Check.Check()\r