]> git.proxmox.com Git - mirror_edk2.git/blobdiff - BaseTools/Source/Python/Ecc/Check.py
This patch is going to:
[mirror_edk2.git] / BaseTools / Source / Python / Ecc / Check.py
index 4e7ffe7aca979536bbc24e75e83ecd56dc0833f1..11a06ecc021454284ea1e2455a36dc64626980da 100644 (file)
 import Common.LongFilePathOs as os\r
 import re\r
 from CommonDataClass.DataClass import *\r
-from Common.DataType import SUP_MODULE_LIST_STRING, TAB_VALUE_SPLIT\r
+import Common.DataType as DT\r
 from EccToolError import *\r
 from MetaDataParser import ParseHeaderCommentSection\r
 import EccGlobalData\r
 import c\r
+from Common.LongFilePathSupport import OpenLongFilePath as open\r
 \r
 ## Check\r
 #\r
@@ -40,9 +41,23 @@ class Check(object):
         self.FunctionLayoutCheck()\r
         self.NamingConventionCheck()\r
 \r
+    # Check UNI files\r
+    def UniCheck(self):\r
+        if EccGlobalData.gConfig.GeneralCheckUni == '1' or EccGlobalData.gConfig.GeneralCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
+            EdkLogger.quiet("Checking whether UNI file is UTF-16 ...")\r
+            SqlCommand = """select ID, FullPath, ExtName from File where ExtName like 'uni'"""\r
+            RecordSet = EccGlobalData.gDb.TblFile.Exec(SqlCommand)\r
+            for Record in RecordSet:\r
+                File = Record[1]\r
+                FileIn = open(File, 'rb').read(2)\r
+                if FileIn != '\xff\xfe':\r
+                    OtherMsg = "File %s is not a valid UTF-16 UNI file" % Record[1]\r
+                    EccGlobalData.gDb.TblReport.Insert(ERROR_GENERAL_CHECK_UNI, OtherMsg=OtherMsg, BelongsToTable='File', BelongsToItem=Record[0])\r
+\r
     # General Checking\r
     def GeneralCheck(self):\r
         self.GeneralCheckNonAcsii()\r
+        self.UniCheck()\r
 \r
     # Check whether file has non ACSII char\r
     def GeneralCheckNonAcsii(self):\r
@@ -554,6 +569,10 @@ class Check(object):
         self.MetaDataFileCheckModuleFileNoUse()\r
         self.MetaDataFileCheckPcdType()\r
         self.MetaDataFileCheckModuleFileGuidDuplication()\r
+        self.MetaDataFileCheckModuleFileGuidFormat()\r
+        self.MetaDataFileCheckModuleFileProtocolFormat()\r
+        self.MetaDataFileCheckModuleFilePpiFormat()\r
+        self.MetaDataFileCheckModuleFilePcdFormat()\r
 \r
     # Check whether each file defined in meta-data exists\r
     def MetaDataFileCheckPathName(self):\r
@@ -583,7 +602,7 @@ class Check(object):
                 List = Record[1].split('|', 1)\r
                 SupModType = []\r
                 if len(List) == 1:\r
-                    SupModType = SUP_MODULE_LIST_STRING.split(TAB_VALUE_SPLIT)\r
+                    SupModType = DT.SUP_MODULE_LIST_STRING.split(DT.TAB_VALUE_SPLIT)\r
                 elif len(List) == 2:\r
                     SupModType = List[1].split()\r
 \r
@@ -821,7 +840,7 @@ class Check(object):
             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', '').replace('\AARCH64', '')\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
@@ -898,6 +917,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])\r
 \r
 \r
+    # Check Guid Format in module INF\r
+    def MetaDataFileCheckModuleFileGuidFormat(self):\r
+        if EccGlobalData.gConfig.MetaDataFileCheckModuleFileGuidFormat or EccGlobalData.gConfig.MetaDataFileCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
+            EdkLogger.quiet("Check Guid Format in module INF ...")\r
+            Table = EccGlobalData.gDb.TblInf\r
+            SqlCommand = """\r
+                         select ID, Value1, Usage, BelongsToFile from %s where Model = %s group by ID\r
+                         """ % (Table.Table, MODEL_EFI_GUID)\r
+            RecordSet = Table.Exec(SqlCommand)\r
+            for Record in RecordSet:\r
+                Value1 = Record[1]\r
+                Value2 = Record[2]\r
+                GuidCommentList = []\r
+                InfPath = self.GetInfFilePathFromID(Record[3])\r
+                Msg = "The GUID format of %s in INF file [%s] does not follow rules" % (Value1, InfPath)\r
+                if Value2.startswith(DT.TAB_SPECIAL_COMMENT):\r
+                    GuidCommentList = Value2[2:].split(DT.TAB_SPECIAL_COMMENT)\r
+                    if GuidCommentList[0].strip().startswith(DT.TAB_INF_USAGE_UNDEFINED):\r
+                        continue\r
+                    elif len(GuidCommentList) > 1:\r
+                        if not GuidCommentList[0].strip().startswith((DT.TAB_INF_USAGE_PRO,\r
+                                                                      DT.TAB_INF_USAGE_SOME_PRO,\r
+                                                                      DT.TAB_INF_USAGE_CON,\r
+                                                                      DT.TAB_INF_USAGE_SOME_CON)):\r
+                            EccGlobalData.gDb.TblReport.Insert(ERROR_META_DATA_FILE_CHECK_FORMAT_GUID, OtherMsg=Msg, BelongsToTable=Table.Table, BelongsToItem=Record[0])\r
+                        if not (GuidCommentList[1].strip()).startswith(DT.TAB_INF_GUIDTYPE_VAR) and \\r
+                            not GuidCommentList[1].strip().startswith((DT.TAB_INF_GUIDTYPE_EVENT,\r
+                                                                       DT.TAB_INF_GUIDTYPE_HII,\r
+                                                                       DT.TAB_INF_GUIDTYPE_FILE,\r
+                                                                       DT.TAB_INF_GUIDTYPE_HOB,\r
+                                                                       DT.TAB_INF_GUIDTYPE_FV,\r
+                                                                       DT.TAB_INF_GUIDTYPE_ST,\r
+                                                                       DT.TAB_INF_GUIDTYPE_TSG,\r
+                                                                       DT.TAB_INF_GUIDTYPE_GUID,\r
+                                                                       DT.TAB_INF_GUIDTYPE_PROTOCOL,\r
+                                                                       DT.TAB_INF_GUIDTYPE_PPI,\r
+                                                                       DT.TAB_INF_USAGE_UNDEFINED)):\r
+                                EccGlobalData.gDb.TblReport.Insert(ERROR_META_DATA_FILE_CHECK_FORMAT_GUID, OtherMsg=Msg, BelongsToTable=Table.Table, BelongsToItem=Record[0])\r
+                    else:\r
+                        EccGlobalData.gDb.TblReport.Insert(ERROR_META_DATA_FILE_CHECK_FORMAT_GUID, OtherMsg=Msg, BelongsToTable=Table.Table, BelongsToItem=Record[0])\r
+                else:\r
+                    EccGlobalData.gDb.TblReport.Insert(ERROR_META_DATA_FILE_CHECK_FORMAT_GUID, OtherMsg=Msg, BelongsToTable=Table.Table, BelongsToItem=Record[0])\r
+\r
+    # Check Protocol Format in module INF\r
+    def MetaDataFileCheckModuleFileProtocolFormat(self):\r
+        if EccGlobalData.gConfig.MetaDataFileCheckModuleFileProtocolFormat or EccGlobalData.gConfig.MetaDataFileCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
+            EdkLogger.quiet("Check Protocol Format in module INF ...")\r
+            Table = EccGlobalData.gDb.TblInf\r
+            SqlCommand = """\r
+                         select ID, Value1, Usage, BelongsToFile from %s where Model = %s group by ID\r
+                         """ % (Table.Table, MODEL_EFI_PROTOCOL)\r
+            RecordSet = Table.Exec(SqlCommand)\r
+            for Record in RecordSet:\r
+                Value1 = Record[1]\r
+                Value2 = Record[2]\r
+                GuidCommentList = []\r
+                InfPath = self.GetInfFilePathFromID(Record[3])\r
+                Msg = "The Protocol format of %s in INF file [%s] does not follow rules" % (Value1, InfPath)\r
+                if Value2.startswith(DT.TAB_SPECIAL_COMMENT):\r
+                    GuidCommentList = Value2[2:].split(DT.TAB_SPECIAL_COMMENT)\r
+                    if len(GuidCommentList) >= 1:\r
+                        if not GuidCommentList[0].strip().startswith((DT.TAB_INF_USAGE_PRO,\r
+                                                                      DT.TAB_INF_USAGE_SOME_PRO,\r
+                                                                      DT.TAB_INF_USAGE_CON,\r
+                                                                      DT.TAB_INF_USAGE_SOME_CON,\r
+                                                                      DT.TAB_INF_USAGE_NOTIFY,\r
+                                                                      DT.TAB_INF_USAGE_TO_START,\r
+                                                                      DT.TAB_INF_USAGE_BY_START,\r
+                                                                      DT.TAB_INF_USAGE_UNDEFINED)):\r
+                            EccGlobalData.gDb.TblReport.Insert(ERROR_META_DATA_FILE_CHECK_FORMAT_PROTOCOL, OtherMsg=Msg, BelongsToTable=Table.Table, BelongsToItem=Record[0])\r
+                else:\r
+                    EccGlobalData.gDb.TblReport.Insert(ERROR_META_DATA_FILE_CHECK_FORMAT_PROTOCOL, OtherMsg=Msg, BelongsToTable=Table.Table, BelongsToItem=Record[0])\r
+\r
+\r
+    # Check Ppi Format in module INF\r
+    def MetaDataFileCheckModuleFilePpiFormat(self):\r
+        if EccGlobalData.gConfig.MetaDataFileCheckModuleFilePpiFormat or EccGlobalData.gConfig.MetaDataFileCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
+            EdkLogger.quiet("Check Ppi Format in module INF ...")\r
+            Table = EccGlobalData.gDb.TblInf\r
+            SqlCommand = """\r
+                         select ID, Value1, Usage, BelongsToFile from %s where Model = %s group by ID\r
+                         """ % (Table.Table, MODEL_EFI_PPI)\r
+            RecordSet = Table.Exec(SqlCommand)\r
+            for Record in RecordSet:\r
+                Value1 = Record[1]\r
+                Value2 = Record[2]\r
+                GuidCommentList = []\r
+                InfPath = self.GetInfFilePathFromID(Record[3])\r
+                Msg = "The Ppi format of %s in INF file [%s] does not follow rules" % (Value1, InfPath)\r
+                if Value2.startswith(DT.TAB_SPECIAL_COMMENT):\r
+                    GuidCommentList = Value2[2:].split(DT.TAB_SPECIAL_COMMENT)\r
+                    if len(GuidCommentList) >= 1:\r
+                        if not GuidCommentList[0].strip().startswith((DT.TAB_INF_USAGE_PRO,\r
+                                                                      DT.TAB_INF_USAGE_SOME_PRO,\r
+                                                                      DT.TAB_INF_USAGE_CON,\r
+                                                                      DT.TAB_INF_USAGE_SOME_CON,\r
+                                                                      DT.TAB_INF_USAGE_NOTIFY,\r
+                                                                      DT.TAB_INF_USAGE_UNDEFINED)):\r
+                            EccGlobalData.gDb.TblReport.Insert(ERROR_META_DATA_FILE_CHECK_FORMAT_PPI, OtherMsg=Msg, BelongsToTable=Table.Table, BelongsToItem=Record[0])\r
+                else:\r
+                    EccGlobalData.gDb.TblReport.Insert(ERROR_META_DATA_FILE_CHECK_FORMAT_PPI, OtherMsg=Msg, BelongsToTable=Table.Table, BelongsToItem=Record[0])\r
+\r
+    # Check Pcd Format in module INF\r
+    def MetaDataFileCheckModuleFilePcdFormat(self):\r
+        if EccGlobalData.gConfig.MetaDataFileCheckModuleFilePcdFormat or EccGlobalData.gConfig.MetaDataFileCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
+            EdkLogger.quiet("Check Pcd Format in module INF ...")\r
+            Table = EccGlobalData.gDb.TblInf\r
+            SqlCommand = """\r
+                         select ID, Model, Value1, Value2, Usage, BelongsToFile from %s where Model >= %s and Model < %s group by ID\r
+                         """ % (Table.Table, MODEL_PCD, MODEL_META_DATA_HEADER)\r
+            RecordSet = Table.Exec(SqlCommand)\r
+            for Record in RecordSet:\r
+                Model = Record[1]\r
+                PcdName = Record[2] + '.' + Record[3]\r
+                Usage = Record[4]\r
+                PcdCommentList = []\r
+                InfPath = self.GetInfFilePathFromID(Record[5])\r
+                Msg = "The Pcd format of %s in INF file [%s] does not follow rules" % (PcdName, InfPath)\r
+                if Usage.startswith(DT.TAB_SPECIAL_COMMENT):\r
+                    PcdCommentList = Usage[2:].split(DT.TAB_SPECIAL_COMMENT)\r
+                    if len(PcdCommentList) >= 1:\r
+                        if Model in [MODEL_PCD_FIXED_AT_BUILD, MODEL_PCD_FEATURE_FLAG] \\r
+                            and not PcdCommentList[0].strip().startswith((DT.TAB_INF_USAGE_SOME_PRO,\r
+                                                                          DT.TAB_INF_USAGE_CON,\r
+                                                                          DT.TAB_INF_USAGE_UNDEFINED)):\r
+                            EccGlobalData.gDb.TblReport.Insert(ERROR_META_DATA_FILE_CHECK_FORMAT_PCD, OtherMsg=Msg, BelongsToTable=Table.Table, BelongsToItem=Record[0])\r
+                        if Model in [MODEL_PCD_PATCHABLE_IN_MODULE, MODEL_PCD_DYNAMIC, MODEL_PCD_DYNAMIC_EX] \\r
+                            and not PcdCommentList[0].strip().startswith((DT.TAB_INF_USAGE_PRO,\r
+                                                                          DT.TAB_INF_USAGE_SOME_PRO,\r
+                                                                          DT.TAB_INF_USAGE_CON,\r
+                                                                          DT.TAB_INF_USAGE_SOME_CON,\r
+                                                                          DT.TAB_INF_USAGE_UNDEFINED)):\r
+                            EccGlobalData.gDb.TblReport.Insert(ERROR_META_DATA_FILE_CHECK_FORMAT_PCD, OtherMsg=Msg, BelongsToTable=Table.Table, BelongsToItem=Record[0])\r
+                else:\r
+                    EccGlobalData.gDb.TblReport.Insert(ERROR_META_DATA_FILE_CHECK_FORMAT_PCD, OtherMsg=Msg, BelongsToTable=Table.Table, BelongsToItem=Record[0])\r
+\r
     # Check whether these is duplicate Guid/Ppi/Protocol name\r
     def CheckGuidProtocolPpi(self, ErrorID, Model, Table):\r
         Name = ''\r