X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;f=BaseTools%2FSource%2FPython%2FEcc%2FCheck.py;h=c2be1b01d31956017184feafe2436275024dea48;hb=00261e1dc62ec078391f0239683ba7a709d3122d;hp=73d7318de0dace245f214e5b8f0b0f6077c5970b;hpb=d0acc87a41d9aa25fe87eb096efa62afacd1f865;p=mirror_edk2.git
diff --git a/BaseTools/Source/Python/Ecc/Check.py b/BaseTools/Source/Python/Ecc/Check.py
index 73d7318de0..c2be1b01d3 100644
--- a/BaseTools/Source/Python/Ecc/Check.py
+++ b/BaseTools/Source/Python/Ecc/Check.py
@@ -1,7 +1,7 @@
## @file
# This file is used to define checkpoints used by ECC tool
#
-# Copyright (c) 2008 - 2010, Intel Corporation. All rights reserved.
+# Copyright (c) 2008 - 2015, Intel Corporation. All rights reserved.
# This program and the accompanying materials
# are licensed and made available under the terms and conditions of the BSD License
# which accompanies this distribution. The full text of the license may be found at
@@ -10,14 +10,15 @@
# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
#
-import os
+import Common.LongFilePathOs as os
import re
from CommonDataClass.DataClass import *
-from Common.DataType import SUP_MODULE_LIST_STRING, TAB_VALUE_SPLIT
+import Common.DataType as DT
from EccToolError import *
from MetaDataParser import ParseHeaderCommentSection
import EccGlobalData
import c
+from Common.LongFilePathSupport import OpenLongFilePath as open
## Check
#
@@ -40,15 +41,29 @@ class Check(object):
self.FunctionLayoutCheck()
self.NamingConventionCheck()
+ # Check UNI files
+ def UniCheck(self):
+ if EccGlobalData.gConfig.GeneralCheckUni == '1' or EccGlobalData.gConfig.GeneralCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':
+ EdkLogger.quiet("Checking whether UNI file is UTF-16 ...")
+ SqlCommand = """select ID, FullPath, ExtName from File where ExtName like 'uni'"""
+ RecordSet = EccGlobalData.gDb.TblFile.Exec(SqlCommand)
+ for Record in RecordSet:
+ File = Record[1]
+ FileIn = open(File, 'rb').read(2)
+ if FileIn != '\xff\xfe':
+ OtherMsg = "File %s is not a valid UTF-16 UNI file" % Record[1]
+ EccGlobalData.gDb.TblReport.Insert(ERROR_GENERAL_CHECK_UNI, OtherMsg=OtherMsg, BelongsToTable='File', BelongsToItem=Record[0])
+
# General Checking
def GeneralCheck(self):
self.GeneralCheckNonAcsii()
+ self.UniCheck()
# Check whether file has non ACSII char
def GeneralCheckNonAcsii(self):
if EccGlobalData.gConfig.GeneralCheckNonAcsii == '1' or EccGlobalData.gConfig.GeneralCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':
EdkLogger.quiet("Checking Non-ACSII char in file ...")
- SqlCommand = """select ID, FullPath, ExtName from File"""
+ SqlCommand = """select ID, FullPath, ExtName from File where ExtName in ('.dec', '.inf', '.dsc', 'c', 'h')"""
RecordSet = EccGlobalData.gDb.TblFile.Exec(SqlCommand)
for Record in RecordSet:
if Record[2].upper() not in EccGlobalData.gConfig.BinaryExtList:
@@ -85,6 +100,9 @@ class Check(object):
Dirnames.append(Dirname)
if IgnoredPattern.match(Dirpath.upper()):
continue
+ for f in Filenames[:]:
+ if f.lower() in EccGlobalData.gConfig.SkipFileList:
+ Filenames.remove(f)
yield (Dirpath, Dirnames, Filenames)
# Check whether return type exists and in the first line
@@ -546,6 +564,7 @@ class Check(object):
self.MetaDataFileCheckLibraryInstanceDependent()
self.MetaDataFileCheckLibraryInstanceOrder()
self.MetaDataFileCheckLibraryNoUse()
+ self.MetaDataFileCheckLibraryDefinedInDec()
self.MetaDataFileCheckBinaryInfInFdf()
self.MetaDataFileCheckPcdDuplicate()
self.MetaDataFileCheckPcdFlash()
@@ -554,6 +573,10 @@ class Check(object):
self.MetaDataFileCheckModuleFileNoUse()
self.MetaDataFileCheckPcdType()
self.MetaDataFileCheckModuleFileGuidDuplication()
+ self.MetaDataFileCheckModuleFileGuidFormat()
+ self.MetaDataFileCheckModuleFileProtocolFormat()
+ self.MetaDataFileCheckModuleFilePpiFormat()
+ self.MetaDataFileCheckModuleFilePcdFormat()
# Check whether each file defined in meta-data exists
def MetaDataFileCheckPathName(self):
@@ -583,7 +606,7 @@ class Check(object):
List = Record[1].split('|', 1)
SupModType = []
if len(List) == 1:
- SupModType = SUP_MODULE_LIST_STRING.split(TAB_VALUE_SPLIT)
+ SupModType = DT.SUP_MODULE_LIST_STRING.split(DT.TAB_VALUE_SPLIT)
elif len(List) == 2:
SupModType = List[1].split()
@@ -667,13 +690,30 @@ class Check(object):
% (MODEL_EFI_LIBRARY_CLASS, MODEL_EFI_LIBRARY_CLASS)
RecordSet = EccGlobalData.gDb.TblDsc.Exec(SqlCommand)
for Record in RecordSet:
- if Record[3] and Record[4] and Record[3] != Record[4]:
+ if Record[3] and Record[4] and Record[3] != Record[4] and Record[1] != 'NULL':
SqlCommand = """select FullPath from File where ID = %s""" % (Record[2])
FilePathList = EccGlobalData.gDb.TblFile.Exec(SqlCommand)
for FilePath in FilePathList:
if not EccGlobalData.gException.IsException(ERROR_META_DATA_FILE_CHECK_LIBRARY_NAME_DUPLICATE, Record[1]):
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])
-
+
+ # Check the header file in Include\Library directory whether be defined in the package DEC file.
+ def MetaDataFileCheckLibraryDefinedInDec(self):
+ if EccGlobalData.gConfig.MetaDataFileCheckLibraryDefinedInDec == '1' or EccGlobalData.gConfig.MetaDataFileCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':
+ EdkLogger.quiet("Checking for library instance whether be defined in the package dec file ...")
+ SqlCommand = """
+ select A.Value1, A.StartLine, A.ID, B.Value1 from Inf as A left join Dec as B
+ on A.Model = B.Model and A.Value1 = B.Value1 where A.Model=%s
+ """ % MODEL_EFI_LIBRARY_CLASS
+ RecordSet = EccGlobalData.gDb.TblDsc.Exec(SqlCommand)
+ for Record in RecordSet:
+ LibraryInInf, Line, ID, LibraryDec = Record
+ if not LibraryDec:
+ if not EccGlobalData.gException.IsException(ERROR_META_DATA_FILE_CHECK_LIBRARY_NOT_DEFINED, LibraryInInf):
+ EccGlobalData.gDb.TblReport.Insert(ERROR_META_DATA_FILE_CHECK_LIBRARY_NOT_DEFINED, \
+ OtherMsg="The Library Class [%s] in %s line is not defined in the associated package file." % (LibraryInInf, Line),
+ BelongsToTable='Inf', BelongsToItem=ID)
+
# 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
def MetaDataFileCheckBinaryInfInFdf(self):
if EccGlobalData.gConfig.MetaDataFileCheckBinaryInfInFdf == '1' or EccGlobalData.gConfig.MetaDataFileCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':
@@ -898,6 +938,142 @@ class Check(object):
EccGlobalData.gDb.TblReport.Insert(ERROR_META_DATA_FILE_CHECK_MODULE_FILE_GUID_DUPLICATION, OtherMsg=Msg, BelongsToTable=Table.Table, BelongsToItem=Record[0])
+ # Check Guid Format in module INF
+ def MetaDataFileCheckModuleFileGuidFormat(self):
+ if EccGlobalData.gConfig.MetaDataFileCheckModuleFileGuidFormat or EccGlobalData.gConfig.MetaDataFileCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':
+ EdkLogger.quiet("Check Guid Format in module INF ...")
+ Table = EccGlobalData.gDb.TblInf
+ SqlCommand = """
+ select ID, Value1, Usage, BelongsToFile from %s where Model = %s group by ID
+ """ % (Table.Table, MODEL_EFI_GUID)
+ RecordSet = Table.Exec(SqlCommand)
+ for Record in RecordSet:
+ Value1 = Record[1]
+ Value2 = Record[2]
+ GuidCommentList = []
+ InfPath = self.GetInfFilePathFromID(Record[3])
+ Msg = "The GUID format of %s in INF file [%s] does not follow rules" % (Value1, InfPath)
+ if Value2.startswith(DT.TAB_SPECIAL_COMMENT):
+ GuidCommentList = Value2[2:].split(DT.TAB_SPECIAL_COMMENT)
+ if GuidCommentList[0].strip().startswith(DT.TAB_INF_USAGE_UNDEFINED):
+ continue
+ elif len(GuidCommentList) > 1:
+ if not GuidCommentList[0].strip().startswith((DT.TAB_INF_USAGE_PRO,
+ DT.TAB_INF_USAGE_SOME_PRO,
+ DT.TAB_INF_USAGE_CON,
+ DT.TAB_INF_USAGE_SOME_CON)):
+ EccGlobalData.gDb.TblReport.Insert(ERROR_META_DATA_FILE_CHECK_FORMAT_GUID, OtherMsg=Msg, BelongsToTable=Table.Table, BelongsToItem=Record[0])
+ if not (GuidCommentList[1].strip()).startswith(DT.TAB_INF_GUIDTYPE_VAR) and \
+ not GuidCommentList[1].strip().startswith((DT.TAB_INF_GUIDTYPE_EVENT,
+ DT.TAB_INF_GUIDTYPE_HII,
+ DT.TAB_INF_GUIDTYPE_FILE,
+ DT.TAB_INF_GUIDTYPE_HOB,
+ DT.TAB_INF_GUIDTYPE_FV,
+ DT.TAB_INF_GUIDTYPE_ST,
+ DT.TAB_INF_GUIDTYPE_TSG,
+ DT.TAB_INF_GUIDTYPE_GUID,
+ DT.TAB_INF_GUIDTYPE_PROTOCOL,
+ DT.TAB_INF_GUIDTYPE_PPI,
+ DT.TAB_INF_USAGE_UNDEFINED)):
+ EccGlobalData.gDb.TblReport.Insert(ERROR_META_DATA_FILE_CHECK_FORMAT_GUID, OtherMsg=Msg, BelongsToTable=Table.Table, BelongsToItem=Record[0])
+ else:
+ EccGlobalData.gDb.TblReport.Insert(ERROR_META_DATA_FILE_CHECK_FORMAT_GUID, OtherMsg=Msg, BelongsToTable=Table.Table, BelongsToItem=Record[0])
+ else:
+ EccGlobalData.gDb.TblReport.Insert(ERROR_META_DATA_FILE_CHECK_FORMAT_GUID, OtherMsg=Msg, BelongsToTable=Table.Table, BelongsToItem=Record[0])
+
+ # Check Protocol Format in module INF
+ def MetaDataFileCheckModuleFileProtocolFormat(self):
+ if EccGlobalData.gConfig.MetaDataFileCheckModuleFileProtocolFormat or EccGlobalData.gConfig.MetaDataFileCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':
+ EdkLogger.quiet("Check Protocol Format in module INF ...")
+ Table = EccGlobalData.gDb.TblInf
+ SqlCommand = """
+ select ID, Value1, Usage, BelongsToFile from %s where Model = %s group by ID
+ """ % (Table.Table, MODEL_EFI_PROTOCOL)
+ RecordSet = Table.Exec(SqlCommand)
+ for Record in RecordSet:
+ Value1 = Record[1]
+ Value2 = Record[2]
+ GuidCommentList = []
+ InfPath = self.GetInfFilePathFromID(Record[3])
+ Msg = "The Protocol format of %s in INF file [%s] does not follow rules" % (Value1, InfPath)
+ if Value2.startswith(DT.TAB_SPECIAL_COMMENT):
+ GuidCommentList = Value2[2:].split(DT.TAB_SPECIAL_COMMENT)
+ if len(GuidCommentList) >= 1:
+ if not GuidCommentList[0].strip().startswith((DT.TAB_INF_USAGE_PRO,
+ DT.TAB_INF_USAGE_SOME_PRO,
+ DT.TAB_INF_USAGE_CON,
+ DT.TAB_INF_USAGE_SOME_CON,
+ DT.TAB_INF_USAGE_NOTIFY,
+ DT.TAB_INF_USAGE_TO_START,
+ DT.TAB_INF_USAGE_BY_START,
+ DT.TAB_INF_USAGE_UNDEFINED)):
+ EccGlobalData.gDb.TblReport.Insert(ERROR_META_DATA_FILE_CHECK_FORMAT_PROTOCOL, OtherMsg=Msg, BelongsToTable=Table.Table, BelongsToItem=Record[0])
+ else:
+ EccGlobalData.gDb.TblReport.Insert(ERROR_META_DATA_FILE_CHECK_FORMAT_PROTOCOL, OtherMsg=Msg, BelongsToTable=Table.Table, BelongsToItem=Record[0])
+
+
+ # Check Ppi Format in module INF
+ def MetaDataFileCheckModuleFilePpiFormat(self):
+ if EccGlobalData.gConfig.MetaDataFileCheckModuleFilePpiFormat or EccGlobalData.gConfig.MetaDataFileCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':
+ EdkLogger.quiet("Check Ppi Format in module INF ...")
+ Table = EccGlobalData.gDb.TblInf
+ SqlCommand = """
+ select ID, Value1, Usage, BelongsToFile from %s where Model = %s group by ID
+ """ % (Table.Table, MODEL_EFI_PPI)
+ RecordSet = Table.Exec(SqlCommand)
+ for Record in RecordSet:
+ Value1 = Record[1]
+ Value2 = Record[2]
+ GuidCommentList = []
+ InfPath = self.GetInfFilePathFromID(Record[3])
+ Msg = "The Ppi format of %s in INF file [%s] does not follow rules" % (Value1, InfPath)
+ if Value2.startswith(DT.TAB_SPECIAL_COMMENT):
+ GuidCommentList = Value2[2:].split(DT.TAB_SPECIAL_COMMENT)
+ if len(GuidCommentList) >= 1:
+ if not GuidCommentList[0].strip().startswith((DT.TAB_INF_USAGE_PRO,
+ DT.TAB_INF_USAGE_SOME_PRO,
+ DT.TAB_INF_USAGE_CON,
+ DT.TAB_INF_USAGE_SOME_CON,
+ DT.TAB_INF_USAGE_NOTIFY,
+ DT.TAB_INF_USAGE_UNDEFINED)):
+ EccGlobalData.gDb.TblReport.Insert(ERROR_META_DATA_FILE_CHECK_FORMAT_PPI, OtherMsg=Msg, BelongsToTable=Table.Table, BelongsToItem=Record[0])
+ else:
+ EccGlobalData.gDb.TblReport.Insert(ERROR_META_DATA_FILE_CHECK_FORMAT_PPI, OtherMsg=Msg, BelongsToTable=Table.Table, BelongsToItem=Record[0])
+
+ # Check Pcd Format in module INF
+ def MetaDataFileCheckModuleFilePcdFormat(self):
+ if EccGlobalData.gConfig.MetaDataFileCheckModuleFilePcdFormat or EccGlobalData.gConfig.MetaDataFileCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':
+ EdkLogger.quiet("Check Pcd Format in module INF ...")
+ Table = EccGlobalData.gDb.TblInf
+ SqlCommand = """
+ select ID, Model, Value1, Value2, Usage, BelongsToFile from %s where Model >= %s and Model < %s group by ID
+ """ % (Table.Table, MODEL_PCD, MODEL_META_DATA_HEADER)
+ RecordSet = Table.Exec(SqlCommand)
+ for Record in RecordSet:
+ Model = Record[1]
+ PcdName = Record[2] + '.' + Record[3]
+ Usage = Record[4]
+ PcdCommentList = []
+ InfPath = self.GetInfFilePathFromID(Record[5])
+ Msg = "The Pcd format of %s in INF file [%s] does not follow rules" % (PcdName, InfPath)
+ if Usage.startswith(DT.TAB_SPECIAL_COMMENT):
+ PcdCommentList = Usage[2:].split(DT.TAB_SPECIAL_COMMENT)
+ if len(PcdCommentList) >= 1:
+ if Model in [MODEL_PCD_FIXED_AT_BUILD, MODEL_PCD_FEATURE_FLAG] \
+ and not PcdCommentList[0].strip().startswith((DT.TAB_INF_USAGE_SOME_PRO,
+ DT.TAB_INF_USAGE_CON,
+ DT.TAB_INF_USAGE_UNDEFINED)):
+ EccGlobalData.gDb.TblReport.Insert(ERROR_META_DATA_FILE_CHECK_FORMAT_PCD, OtherMsg=Msg, BelongsToTable=Table.Table, BelongsToItem=Record[0])
+ if Model in [MODEL_PCD_PATCHABLE_IN_MODULE, MODEL_PCD_DYNAMIC, MODEL_PCD_DYNAMIC_EX] \
+ and not PcdCommentList[0].strip().startswith((DT.TAB_INF_USAGE_PRO,
+ DT.TAB_INF_USAGE_SOME_PRO,
+ DT.TAB_INF_USAGE_CON,
+ DT.TAB_INF_USAGE_SOME_CON,
+ DT.TAB_INF_USAGE_UNDEFINED)):
+ EccGlobalData.gDb.TblReport.Insert(ERROR_META_DATA_FILE_CHECK_FORMAT_PCD, OtherMsg=Msg, BelongsToTable=Table.Table, BelongsToItem=Record[0])
+ else:
+ EccGlobalData.gDb.TblReport.Insert(ERROR_META_DATA_FILE_CHECK_FORMAT_PCD, OtherMsg=Msg, BelongsToTable=Table.Table, BelongsToItem=Record[0])
+
# Check whether these is duplicate Guid/Ppi/Protocol name
def CheckGuidProtocolPpi(self, ErrorID, Model, Table):
Name = ''
@@ -940,7 +1116,7 @@ class Check(object):
""" % (Table.Table, Table.Table, Model, Model)
RecordSet = Table.Exec(SqlCommand)
for Record in RecordSet:
- if not EccGlobalData.gException.IsException(ErrorID, Record[1] + ':' + Record[2]):
+ if not EccGlobalData.gException.IsException(ErrorID, Record[2]):
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])
# Naming Convention Check
@@ -1047,7 +1223,10 @@ class Check(object):
SqlCommand = """select ID, Name from %s where Model = %s""" % (FileTable, MODEL_IDENTIFIER_VARIABLE)
RecordSet = EccGlobalData.gDb.TblFile.Exec(SqlCommand)
for Record in RecordSet:
- if not Pattern.match(Record[1]):
+ Var = Record[1]
+ if Var.startswith('CONST'):
+ Var = Var[5:].lstrip()
+ if not Pattern.match(Var):
if not EccGlobalData.gException.IsException(ERROR_NAMING_CONVENTION_CHECK_VARIABLE_NAME, Record[1]):
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])