From 14239f66034c9fc5ab2e8ae283f9174c4f78f360 Mon Sep 17 00:00:00 2001 From: Hess Chen Date: Thu, 25 Jun 2015 08:01:59 +0000 Subject: BaseTools/Ecc: Add a checkpoint for invalid DEC file. Add a checkpoint to check whether a header file in 'include' directory is defined in DEC file Contributed-under: TianoCore Contribution Agreement 1.0 Signed-off-by: Hess Chen Reviewed-by: YangX Li git-svn-id: https://svn.code.sf.net/p/edk2/code/trunk/edk2@17708 6f19259b-4bc3-4df7-8a09-765794883524 --- BaseTools/Source/Python/Ecc/Check.py | 20 +++++++++++++++++++- BaseTools/Source/Python/Ecc/Configuration.py | 2 ++ BaseTools/Source/Python/Ecc/EccToolError.py | 2 ++ BaseTools/Source/Python/Ecc/config.ini | 2 ++ 4 files changed, 25 insertions(+), 1 deletion(-) (limited to 'BaseTools') diff --git a/BaseTools/Source/Python/Ecc/Check.py b/BaseTools/Source/Python/Ecc/Check.py index da3b0fb9ac..6c4c90ca78 100644 --- a/BaseTools/Source/Python/Ecc/Check.py +++ b/BaseTools/Source/Python/Ecc/Check.py @@ -564,6 +564,7 @@ class Check(object): self.MetaDataFileCheckLibraryInstanceDependent() self.MetaDataFileCheckLibraryInstanceOrder() self.MetaDataFileCheckLibraryNoUse() + self.MetaDataFileCheckLibraryDefinedInDec() self.MetaDataFileCheckBinaryInfInFdf() self.MetaDataFileCheckPcdDuplicate() self.MetaDataFileCheckPcdFlash() @@ -695,7 +696,24 @@ class Check(object): 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': diff --git a/BaseTools/Source/Python/Ecc/Configuration.py b/BaseTools/Source/Python/Ecc/Configuration.py index 5a06c4ee2e..da53f5f6f8 100644 --- a/BaseTools/Source/Python/Ecc/Configuration.py +++ b/BaseTools/Source/Python/Ecc/Configuration.py @@ -220,6 +220,8 @@ class Configuration(object): self.MetaDataFileCheckLibraryInstanceOrder = 1 # Check whether the unnecessary inclusion of library classes in the INF file self.MetaDataFileCheckLibraryNoUse = 1 + # Check the header file in Include\Library directory whether be defined in the package DEC file. + self.MetaDataFileCheckLibraryDefinedInDec = 1 # 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 self.MetaDataFileCheckBinaryInfInFdf = 1 # Not to report error and warning related OS include file such as "windows.h" and "stdio.h" diff --git a/BaseTools/Source/Python/Ecc/EccToolError.py b/BaseTools/Source/Python/Ecc/EccToolError.py index 900dcc17dd..5c45fdf904 100644 --- a/BaseTools/Source/Python/Ecc/EccToolError.py +++ b/BaseTools/Source/Python/Ecc/EccToolError.py @@ -101,6 +101,7 @@ ERROR_META_DATA_FILE_CHECK_FORMAT_GUID = 10018 ERROR_META_DATA_FILE_CHECK_FORMAT_PROTOCOL = 10019 ERROR_META_DATA_FILE_CHECK_FORMAT_PPI = 10020 ERROR_META_DATA_FILE_CHECK_FORMAT_PCD = 10021 +ERROR_META_DATA_FILE_CHECK_LIBRARY_NOT_DEFINED = 10022 ERROR_SPELLING_CHECK_ALL = 11000 @@ -195,6 +196,7 @@ gEccErrorMessage = { ERROR_META_DATA_FILE_CHECK_FORMAT_PROTOCOL : "Wrong Protocol Format used in Module file", ERROR_META_DATA_FILE_CHECK_FORMAT_PPI : "Wrong Ppi Format used in Module file", ERROR_META_DATA_FILE_CHECK_FORMAT_PCD : "Wrong Pcd Format used in Module file", + ERROR_META_DATA_FILE_CHECK_LIBRARY_NOT_DEFINED : "Not defined LibraryClass used in the Module file.", ERROR_SPELLING_CHECK_ALL : "", } diff --git a/BaseTools/Source/Python/Ecc/config.ini b/BaseTools/Source/Python/Ecc/config.ini index 89c17a5ef2..b3c1204aed 100644 --- a/BaseTools/Source/Python/Ecc/config.ini +++ b/BaseTools/Source/Python/Ecc/config.ini @@ -230,6 +230,8 @@ MetaDataFileCheckLibraryInstanceDependent = 1 MetaDataFileCheckLibraryInstanceOrder = 1 # Check whether the unnecessary inclusion of library classes in the INF file MetaDataFileCheckLibraryNoUse = 1 +# Check the header file in Include\Library directory whether be defined in the package DEC file. +MetaDataFileCheckLibraryDefinedInDec = 1 # 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 MetaDataFileCheckBinaryInfInFdf = 1 # Not to report error and warning related OS include file such as "windows.h" and "stdio.h". -- cgit v1.2.3