BaseTool: Enhance error handling.

Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Bob Feng <bob.c.feng@intel.com>
Cc: Liming Gao <liming.gao@intel.com>
Reviewed-by: Liming Gao <liming.gao@intel.com>

diff --git a/BaseTools/Source/Python/Workspace/DscBuildData.py b/BaseTools/Source/Python/Workspace/DscBuildData.py
index 214e4fd569b3e3c5b15636188a1d442c275c525c..8c5afb5bf488d701d42abb078305d081bf7aff81 100644 (file)
--- a/BaseTools/Source/Python/Workspace/DscBuildData.py
+++ b/BaseTools/Source/Python/Workspace/DscBuildData.py
@@ -854,7 +854,7 @@ class DscBuildData(PlatformBuildClassObject):
                                 ExtraData="%s.%s" % (TokenSpaceGuid, PcdCName))\r
             if PcdType in (MODEL_PCD_DYNAMIC_DEFAULT, MODEL_PCD_DYNAMIC_EX_DEFAULT):\r
                 if self._DecPcds[PcdCName, TokenSpaceGuid].DatumType.strip() != ValueList[1].strip():\r
-                    EdkLogger.error('build', FORMAT_INVALID, ErrStr , File=self.MetaFile, Line=LineNo,\r
+                    EdkLogger.error('build', FORMAT_INVALID, "Pcd datumtype used in DSC file is not the same as its declaration in DEC file." , File=self.MetaFile, Line=LineNo,\r
                                 ExtraData="%s.%s|%s" % (TokenSpaceGuid, PcdCName, Setting))\r
         if (TokenSpaceGuid + '.' + PcdCName) in GlobalData.gPlatformPcds:\r
             if GlobalData.gPlatformPcds[TokenSpaceGuid + '.' + PcdCName] != ValueList[Index]:\r
@@ -1010,13 +1010,16 @@ class DscBuildData(PlatformBuildClassObject):
         for str_pcd in StrPcdSet:\r
             str_pcd_obj = Pcds.get((str_pcd[1], str_pcd[0]), None)\r
             str_pcd_dec = self._DecPcds.get((str_pcd[1], str_pcd[0]), None)\r
+            if not isinstance (str_pcd_dec, StructurePcd):\r
+                EdkLogger.error('build', PARSER_ERROR,\r
+                            "Pcd (%s.%s) is not declared as Structure PCD in DEC files. Arch: ['%s']" % (str_pcd[0], str_pcd[1], self._Arch),\r
+                            File=self.MetaFile,Line = StrPcdSet[str_pcd][0][5])\r
             if str_pcd_dec:\r
                 str_pcd_obj_str = StructurePcd()\r
                 str_pcd_obj_str.copy(str_pcd_dec)\r
                 if str_pcd_obj:\r
                     str_pcd_obj_str.copy(str_pcd_obj)\r
-                    if str_pcd_obj.DefaultValue:\r
-                        str_pcd_obj_str.DefaultFromDSC = str_pcd_obj.DefaultValue\r
+                str_pcd_obj_str.DefaultFromDSC = str_pcd_obj_str.DefaultValue\r
                 for str_pcd_data in StrPcdSet[str_pcd]:\r
                     if str_pcd_data[3] in SkuIds:\r
                         str_pcd_obj_str.AddOverrideValue(str_pcd_data[2], str(str_pcd_data[6]), 'DEFAULT' if str_pcd_data[3] == 'COMMON' else str_pcd_data[3],'STANDARD' if str_pcd_data[4] == 'COMMON' else str_pcd_data[4], self.MetaFile.File,LineNo=str_pcd_data[5])\r
@@ -1154,7 +1157,7 @@ class DscBuildData(PlatformBuildClassObject):
                                             File=self.MetaFile, Line=Dummy5)\r
             if SkuName in (self.SkuIdMgr.SystemSkuId, 'DEFAULT', 'COMMON'):\r
                 if "." not in TokenSpaceGuid:\r
-                    PcdSet.add((PcdCName, TokenSpaceGuid, SkuName, Dummy4))\r
+                    PcdSet.add((PcdCName, TokenSpaceGuid, SkuName, Dummy5))\r
                 PcdDict[Arch, PcdCName, TokenSpaceGuid, SkuName] = Setting\r
 \r
         for PcdCName, TokenSpaceGuid, SkuName, Dummy4 in PcdSet:\r
@@ -1263,12 +1266,9 @@ class DscBuildData(PlatformBuildClassObject):
         try:\r
             Process = subprocess.Popen(Command, stdout=subprocess.PIPE, stderr=subprocess.PIPE, shell=True)\r
         except:\r
-            print 'ERROR: Can not execute command:', Command\r
-            sys.exit(1)\r
+            EdkLogger.error('Build', COMMAND_FAILURE, 'Can not execute command: %s' % Command)\r
         Result = Process.communicate()\r
-        if Process.returncode <> 0:\r
-            print 'ERROR: Can not collect output from command:', Command\r
-        return Result[0], Result[1]\r
+        return Process.returncode, Result[0], Result[1]\r
 \r
     def IntToCString(self, Value, ValueSize):\r
         Result = '"'\r
@@ -1389,7 +1389,7 @@ class DscBuildData(PlatformBuildClassObject):
                     try:\r
                         Value, ValueSize = ParseFieldValue (FieldList[FieldName][0])\r
                     except Exception:\r
-                        print FieldList[FieldName][0]\r
+                        EdkLogger.error('Build', FORMAT_INVALID, "Invalid value format for %s. From %s Line %d " % (".".join((Pcd.TokenSpaceGuidCName,Pcd.TokenCName,FieldName)),FieldList[FieldName][1], FieldList[FieldName][2]))\r
                     if isinstance(Value, str):\r
                         CApp = CApp + '  Pcd->%s = %s; // From %s Line %d Value %s\n' % (FieldName, Value, FieldList[FieldName][1], FieldList[FieldName][2], FieldList[FieldName][0])\r
                     elif IsArray:\r
@@ -1427,7 +1427,7 @@ class DscBuildData(PlatformBuildClassObject):
                         try:\r
                             Value, ValueSize = ParseFieldValue (FieldList[FieldName][0])\r
                         except Exception:\r
-                            print FieldList[FieldName][0]\r
+                            EdkLogger.error('Build', FORMAT_INVALID, "Invalid value format for %s. From %s Line %d " % (".".join((Pcd.TokenSpaceGuidCName,Pcd.TokenCName,FieldName)),FieldList[FieldName][1], FieldList[FieldName][2]))\r
                         if isinstance(Value, str):\r
                             CApp = CApp + '  Pcd->%s = %s; // From %s Line %d Value %s\n' % (FieldName, Value, FieldList[FieldName][1], FieldList[FieldName][2], FieldList[FieldName][0])\r
                         elif IsArray:\r
@@ -1603,50 +1603,68 @@ class DscBuildData(PlatformBuildClassObject):
 \r
         Messages = ''\r
         if sys.platform == "win32":\r
-            StdOut, StdErr = self.ExecuteCommand ('nmake clean & nmake -f %s' % (MakeFileName))\r
+            MakeCommand = 'nmake clean & nmake -f %s' % (MakeFileName)\r
+            returncode, StdOut, StdErr = self.ExecuteCommand (MakeCommand)\r
             Messages = StdOut\r
         else:\r
-            StdOut, StdErr = self.ExecuteCommand ('make clean & make -f %s' % (MakeFileName))\r
+            MakeCommand = 'make clean & make -f %s' % (MakeFileName)\r
+            returncode, StdOut, StdErr = self.ExecuteCommand (MakeCommand)\r
             Messages = StdErr\r
         Messages = Messages.split('\n')\r
-        for Message in Messages:\r
-            if " error" in Message:\r
-                FileInfo = Message.strip().split('(')\r
-                if len (FileInfo) > 1:\r
-                    FileName = FileInfo [0]\r
-                    FileLine = FileInfo [1].split (')')[0]\r
-                else:\r
-                    FileInfo = Message.strip().split(':')\r
-                    FileName = FileInfo [0]\r
-                    FileLine = FileInfo [1]\r
-\r
-                File = open (FileName, 'r')\r
-                FileData = File.readlines()\r
-                File.close()\r
-                error_line = FileData[int (FileLine) - 1]\r
-                if r"//" in error_line:\r
-                    c_line,dsc_line = error_line.split(r"//")\r
-                else:\r
-                    dsc_line = error_line\r
-\r
-                message_itmes = Message.split(":")\r
-                Index = 0\r
-                for item in message_itmes:\r
-                    if "PcdValueInit.c" in item:\r
-                        Index = message_itmes.index(item)\r
-                        message_itmes[Index] = dsc_line.strip()\r
-                        break\r
-\r
-                EdkLogger.error("build", PCD_STRUCTURE_PCD_ERROR, ":".join(message_itmes[Index:]))\r
+        MessageGroup = []\r
+        if returncode <>0:\r
+            CAppBaseFileName = os.path.join(self.OutputPath, PcdValueInitName)\r
+            File = open (CAppBaseFileName + '.c', 'r')\r
+            FileData = File.readlines()\r
+            File.close()\r
+            for Message in Messages:\r
+                if " error" in Message or "warning" in Message:\r
+                    FileInfo = Message.strip().split('(')\r
+                    if len (FileInfo) > 1:\r
+                        FileName = FileInfo [0]\r
+                        FileLine = FileInfo [1].split (')')[0]\r
+                    else:\r
+                        FileInfo = Message.strip().split(':')\r
+                        FileName = FileInfo [0]\r
+                        FileLine = FileInfo [1]\r
+                    if FileLine.isdigit():\r
+                        error_line = FileData[int (FileLine) - 1]\r
+                        if r"//" in error_line:\r
+                            c_line,dsc_line = error_line.split(r"//")\r
+                        else:\r
+                            dsc_line = error_line\r
+                        message_itmes = Message.split(":")\r
+                        Index = 0\r
+                        if "PcdValueInit.c" not in Message:\r
+                            break\r
+                        else:\r
+                            for item in message_itmes:\r
+                                if "PcdValueInit.c" in item:\r
+                                    Index = message_itmes.index(item)\r
+                                    message_itmes[Index] = dsc_line.strip()\r
+                                    break\r
+                            MessageGroup.append(":".join(message_itmes[Index:]).strip())\r
+                            continue\r
+                    else:\r
+                        MessageGroup.append(Message)\r
+            if MessageGroup:\r
+                EdkLogger.error("build", PCD_STRUCTURE_PCD_ERROR, "\n".join(MessageGroup) )\r
+            else:\r
+                EdkLogger.error('Build', COMMAND_FAILURE, 'Can not execute command: %s' % MakeCommand)\r
 \r
         PcdValueInitExe = PcdValueInitName\r
         if not sys.platform == "win32":\r
             PcdValueInitExe = os.path.join(os.getenv("EDK_TOOLS_PATH"), 'Source', 'C', 'bin', PcdValueInitName)\r
 \r
-        StdOut, StdErr = self.ExecuteCommand (PcdValueInitExe + ' -i %s -o %s' % (InputValueFile, OutputValueFile))\r
-        File = open (OutputValueFile, 'r')\r
-        FileBuffer = File.readlines()\r
-        File.close()\r
+        Command = PcdValueInitExe + ' -i %s -o %s' % (InputValueFile, OutputValueFile)\r
+        returncode, StdOut, StdErr = self.ExecuteCommand (Command)\r
+        if returncode <> 0:\r
+            EdkLogger.warn('Build', COMMAND_FAILURE, 'Can not collect output from command: %s' % Command)\r
+            FileBuffer = []\r
+        else:\r
+            File = open (OutputValueFile, 'r')\r
+            FileBuffer = File.readlines()\r
+            File.close()\r
 \r
         StructurePcdSet = []\r
         for Pcd in FileBuffer:\r
@@ -1683,7 +1701,7 @@ class DscBuildData(PlatformBuildClassObject):
                 EdkLogger.error('build', PARAMETER_INVALID, 'Sku %s is not defined in [SkuIds] section' % SkuName,\r
                                             File=self.MetaFile, Line=Dummy5)\r
             if "." not in TokenSpaceGuid:\r
-                PcdList.append((PcdCName, TokenSpaceGuid, SkuName, Dummy4))\r
+                PcdList.append((PcdCName, TokenSpaceGuid, SkuName, Dummy5))\r
             PcdDict[Arch, SkuName, PcdCName, TokenSpaceGuid] = Setting\r
 \r
         # Remove redundant PCD candidates, per the ARCH and SKU\r
@@ -1839,7 +1857,7 @@ class DscBuildData(PlatformBuildClassObject):
                 EdkLogger.error('build', PARAMETER_INVALID, 'DefaultStores %s is not defined in [DefaultStores] section' % DefaultStore,\r
                                             File=self.MetaFile, Line=Dummy5)\r
             if "." not in TokenSpaceGuid:\r
-                PcdSet.add((PcdCName, TokenSpaceGuid, SkuName,DefaultStore, Dummy4))\r
+                PcdSet.add((PcdCName, TokenSpaceGuid, SkuName,DefaultStore, Dummy5))\r
             PcdDict[Arch, SkuName, PcdCName, TokenSpaceGuid,DefaultStore] = Setting\r
 \r
 \r
@@ -1991,7 +2009,7 @@ class DscBuildData(PlatformBuildClassObject):
                 EdkLogger.error('build', PARAMETER_INVALID, 'Sku %s is not defined in [SkuIds] section' % SkuName,\r
                                             File=self.MetaFile, Line=Dummy5)\r
             if "." not in TokenSpaceGuid:\r
-                PcdList.append((PcdCName, TokenSpaceGuid, SkuName, Dummy4))\r
+                PcdList.append((PcdCName, TokenSpaceGuid, SkuName, Dummy5))\r
             PcdDict[Arch, SkuName, PcdCName, TokenSpaceGuid] = Setting\r
 \r
         # Remove redundant PCD candidates, per the ARCH and SKU\r