ArmPlatformPkg/Scripts: Added '--verbose' support to DS-5 scripts

Verbose mode can also be enabled by the shorter argument '-v'

Signed-off-by: Olivier Martin <olivier.martin@arm.com>
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@14100 6f19259b-4bc3-4df7-8a09-765794883524

diff --git a/ArmPlatformPkg/Scripts/Ds5/cmd_load_symbols.py b/ArmPlatformPkg/Scripts/Ds5/cmd_load_symbols.py
index 424eb63cbbe957a7c7ca09bfdee3a5b10f343c07..994a475cb987162631f3e8f46e3bf551c9fc1645 100644 (file)
--- a/ArmPlatformPkg/Scripts/Ds5/cmd_load_symbols.py
+++ b/ArmPlatformPkg/Scripts/Ds5/cmd_load_symbols.py
@@ -1,5 +1,5 @@
 #\r
-#  Copyright (c) 2011-2012, ARM Limited. All rights reserved.\r
+#  Copyright (c) 2011-2013, ARM Limited. All rights reserved.\r
 #  \r
 #  This program and the accompanying materials                          \r
 #  are licensed and made available under the terms and conditions of the BSD License         \r
@@ -21,16 +21,18 @@ import edk2_debugger
 reload(edk2_debugger)\r
 \r
 def usage():\r
+    print "-v,--verbose"\r
     print "-a,--all: Load all symbols"\r
     print "-l,--report=: Filename for the EDK2 report log"\r
     print "-m,--sysmem=(base,size): System Memory region"\r
     print "-f,--fv=(base,size): Firmware region"\r
     print "-r,--rom=(base,size): ROM region"\r
 \r
+verbose = False\r
 load_all = False\r
 report_file = None\r
 regions = []\r
-opts,args = getopt.getopt(sys.argv[1:], "har:vm:vr:vf:v", ["help","all","report=","sysmem=","rom=","fv="])\r
+opts,args = getopt.getopt(sys.argv[1:], "hvar:vm:vr:vf:v", ["help","verbose","all","report=","sysmem=","rom=","fv="])\r
 if (opts is None) or (not opts):\r
     report_file = '../../../report.log'\r
 else:\r
@@ -44,6 +46,8 @@ else:
         if o in ("-h","--help"):\r
             usage()\r
             sys.exit()\r
+        elif o in ("-v","--verbose"):\r
+            verbose = True\r
         elif o in ("-a","--all"):\r
             load_all = True\r
         elif o in ("-l","--report"):\r
@@ -58,7 +62,7 @@ else:
             region_type = edk2_debugger.ArmPlatformDebugger.REGION_TYPE_ROM\r
             regex = region_reg\r
         else:\r
-            assert False, "Unhandled option"\r
+            assert False, "Unhandled option (%s)" % o\r
             \r
         if region_type:\r
             m = regex.match(a)\r
@@ -83,10 +87,8 @@ ec.getExecutionService().waitForStop()
 # in case the execution context reference is out of date\r
 ec = debugger.getExecutionContext(0)\r
 \r
-armplatform_debugger = edk2_debugger.ArmPlatformDebugger(ec, report_file, regions)\r
-\r
 try:\r
-    armplatform_debugger = edk2_debugger.ArmPlatformDebugger(ec, report_file, regions)\r
+    armplatform_debugger = edk2_debugger.ArmPlatformDebugger(ec, report_file, regions, verbose)\r
     \r
     if load_all:\r
         armplatform_debugger.load_all_symbols()\r

diff --git a/ArmPlatformPkg/Scripts/Ds5/edk2_debugger.py b/ArmPlatformPkg/Scripts/Ds5/edk2_debugger.py
index 87e82b68d6c28470c6dacca6a7f2b96b93ca9420..4867af1938d703a1dfc5ff1c2931b0be07642cd5 100644 (file)
--- a/ArmPlatformPkg/Scripts/Ds5/edk2_debugger.py
+++ b/ArmPlatformPkg/Scripts/Ds5/edk2_debugger.py
@@ -1,5 +1,5 @@
 #\r
-#  Copyright (c) 2011-2012, ARM Limited. All rights reserved.\r
+#  Copyright (c) 2011-2013, ARM Limited. All rights reserved.\r
 #  \r
 #  This program and the accompanying materials                          \r
 #  are licensed and made available under the terms and conditions of the BSD License         \r
@@ -53,7 +53,10 @@ def dump_system_table(ec, mem_base, mem_size):
     debug_info_table = system_table.DebugInfoTable(ec, debug_info_table_base)\r
     debug_info_table.dump()\r
 \r
-def load_symbol_from_file(ec, filename, address):\r
+def load_symbol_from_file(ec, filename, address, verbose = False):\r
+    if verbose:\r
+        print "Add symbols of %s at 0x%x" % (filename, address)\r
+        \r
     try:\r
         ec.getImageService().addSymbols(filename, address)\r
     except:\r
@@ -62,7 +65,7 @@ def load_symbol_from_file(ec, filename, address):
             ec.getImageService().unloadSymbols(filename)\r
             ec.getImageService().addSymbols(filename, address)\r
         except:\r
-            print "Warning: not possible to load symbols from %s" % filename\r
+            print "Warning: not possible to load symbols from %s at 0x%x" % (filename, address)\r
             pass\r
 \r
 class ArmPlatform:\r
@@ -79,8 +82,9 @@ class ArmPlatformDebugger:
     REGION_TYPE_ROM    = 2\r
     REGION_TYPE_FV     = 3\r
     \r
-    def __init__(self, ec, report_log, regions):\r
+    def __init__(self, ec, report_log, regions, verbose = False):\r
         self.ec = ec\r
+        self.verbose = verbose\r
         fvs = []\r
         sysmem_base = None\r
         sysmem_size = None\r
@@ -89,7 +93,7 @@ class ArmPlatformDebugger:
             try:\r
                 self.build = build_report.BuildReport(report_log)\r
             except IOError:\r
-                raise IOError(2, 'Report \'%s\' isnot valid' % report_log)\r
+                raise IOError(2, 'Report \'%s\' is not valid' % report_log)\r
             \r
             # Generate list of supported Firmware Volumes\r
             if self.build.PCDs['gArmTokenSpaceGuid'].has_key('PcdFvSize') and int(self.build.PCDs['gArmTokenSpaceGuid']['PcdFvSize'][0],16) != 0:\r
@@ -141,7 +145,7 @@ class ArmPlatformDebugger:
                 self.firmware_volumes[fv_base] = firmware_volume.FirmwareVolume(self.ec, fv_base, fv_size)\r
                 \r
             stack_frame = self.ec.getTopLevelStackFrame()\r
-            info = self.firmware_volumes[fv_base].load_symbols_at(int(stack_frame.getRegisterService().getValue('PC')) & 0xFFFFFFFF)\r
+            info = self.firmware_volumes[fv_base].load_symbols_at(int(stack_frame.getRegisterService().getValue('PC')) & 0xFFFFFFFF, self.verbose)\r
             debug_infos.append(info)\r
             while stack_frame.next() is not None:\r
                 stack_frame = stack_frame.next()\r
@@ -171,7 +175,7 @@ class ArmPlatformDebugger:
                 self.debug_info_table = system_table.DebugInfoTable(self.ec, debug_info_table_base)\r
                 \r
             stack_frame = self.ec.getTopLevelStackFrame()\r
-            info = self.debug_info_table.load_symbols_at(int(stack_frame.getRegisterService().getValue('PC')) & 0xFFFFFFFF)\r
+            info = self.debug_info_table.load_symbols_at(int(stack_frame.getRegisterService().getValue('PC')) & 0xFFFFFFFF, self.verbose)\r
             debug_infos.append(info)\r
             while stack_frame.next() is not None:\r
                 stack_frame = stack_frame.next()\r
@@ -197,7 +201,7 @@ class ArmPlatformDebugger:
         for (fv_base, fv_size) in self.platform.fvs:\r
             if self.firmware_volumes.has_key(fv_base) == False:\r
                 self.firmware_volumes[fv_base] = firmware_volume.FirmwareVolume(self.ec, fv_base, fv_size)    \r
-            self.firmware_volumes[fv_base].load_all_symbols()\r
+            self.firmware_volumes[fv_base].load_all_symbols(self.verbose)\r
 \r
         try:\r
             # Load all symbols of module loaded into System Memory\r
@@ -210,7 +214,7 @@ class ArmPlatformDebugger:
                 debug_info_table_base = self.system_table.get_configuration_table(system_table.DebugInfoTable.CONST_DEBUG_INFO_TABLE_GUID)\r
                 self.debug_info_table = system_table.DebugInfoTable(self.ec, debug_info_table_base)\r
             \r
-            self.debug_info_table.load_all_symbols()\r
+            self.debug_info_table.load_all_symbols(self.verbose)\r
         except:\r
             # Debugger exception could be excepted if DRAM has not been initialized or if we have not started to run from DRAM yet\r
             print "Note: no symbols have been found in System Memory (possible cause: the UEFI permanent memory has been installed yet)"\r

diff --git a/ArmPlatformPkg/Scripts/Ds5/firmware_volume.py b/ArmPlatformPkg/Scripts/Ds5/firmware_volume.py
index a13d1433eb447823acb46d9d7dce37fcced238b4..651c748a10a18b9df8935f6adfa0dead38702dd2 100644 (file)
--- a/ArmPlatformPkg/Scripts/Ds5/firmware_volume.py
+++ b/ArmPlatformPkg/Scripts/Ds5/firmware_volume.py
@@ -1,5 +1,5 @@
 #\r
-#  Copyright (c) 2011-2012, ARM Limited. All rights reserved.\r
+#  Copyright (c) 2011-2013, ARM Limited. All rights reserved.\r
 #  \r
 #  This program and the accompanying materials                          \r
 #  are licensed and made available under the terms and conditions of the BSD License         \r
@@ -269,7 +269,7 @@ class FirmwareVolume:
                 section = ffs.get_next_section(section)\r
             ffs = self.get_next_ffs(ffs)\r
 \r
-    def load_symbols_at(self, addr):\r
+    def load_symbols_at(self, addr, verbose = False):\r
         if self.DebugInfos == []:\r
             self.get_debug_info()\r
         \r
@@ -282,11 +282,16 @@ class FirmwareVolume:
                 else:\r
                     raise Exception('FirmwareVolume','Section Type not supported')\r
                 \r
-                edk2_debugger.load_symbol_from_file(self.ec, section.get_debug_filepath(), section.get_debug_elfbase())\r
+                try:\r
+                    edk2_debugger.load_symbol_from_file(self.ec, section.get_debug_filepath(), section.get_debug_elfbase(), verbose)\r
+                except Exception, (ErrorClass, ErrorMessage):\r
+                    if verbose:\r
+                        print "Error while loading a symbol file (%s: %s)" % (ErrorClass, ErrorMessage)\r
+                    pass\r
 \r
                 return debug_info\r
 \r
-    def load_all_symbols(self):\r
+    def load_all_symbols(self, verbose = False):\r
         if self.DebugInfos == []:\r
             self.get_debug_info()\r
         \r
@@ -298,4 +303,10 @@ class FirmwareVolume:
             else:\r
                 continue\r
             \r
-            edk2_debugger.load_symbol_from_file(self.ec, section.get_debug_filepath(), section.get_debug_elfbase())\r
+            try:\r
+                edk2_debugger.load_symbol_from_file(self.ec, section.get_debug_filepath(), section.get_debug_elfbase(), verbose)\r
+            except Exception, (ErrorClass, ErrorMessage):\r
+                if verbose:\r
+                    print "Error while loading a symbol file (%s: %s)" % (ErrorClass, ErrorMessage)\r
+                pass\r
+\r

diff --git a/ArmPlatformPkg/Scripts/Ds5/system_table.py b/ArmPlatformPkg/Scripts/Ds5/system_table.py
index 8dec591e63cc7cd1ddf6a7bf1ad5389ebc30c5d1..3e7f6ab01584cfb9cded6cf2a77c796d21bce108 100644 (file)
--- a/ArmPlatformPkg/Scripts/Ds5/system_table.py
+++ b/ArmPlatformPkg/Scripts/Ds5/system_table.py
@@ -1,5 +1,5 @@
 #\r
-#  Copyright (c) 2011-2012, ARM Limited. All rights reserved.\r
+#  Copyright (c) 2011-2013, ARM Limited. All rights reserved.\r
 #  \r
 #  This program and the accompanying materials                          \r
 #  are licensed and made available under the terms and conditions of the BSD License         \r
@@ -48,7 +48,7 @@ class DebugInfoTable:
                     self.DebugInfos.append((image_base,image_size))\r
     \r
     # Return (base, size)\r
-    def load_symbols_at(self, addr):\r
+    def load_symbols_at(self, addr, verbose = False):\r
         if self.DebugInfos == []:\r
             self.get_debug_info()\r
         \r
@@ -57,7 +57,12 @@ class DebugInfoTable:
             if (addr >= debug_info[0]) and (addr < debug_info[0] + debug_info[1]):\r
                 section = firmware_volume.EfiSectionPE32(self.ec, debug_info[0])\r
                 \r
-                edk2_debugger.load_symbol_from_file(self.ec, section.get_debug_filepath(), section.get_debug_elfbase())\r
+                try:\r
+                    edk2_debugger.load_symbol_from_file(self.ec, section.get_debug_filepath(), section.get_debug_elfbase(), verbose)\r
+                except Exception, (ErrorClass, ErrorMessage):\r
+                    if verbose:\r
+                        print "Error while loading a symbol file (%s: %s)" % (ErrorClass, ErrorMessage)\r
+                    pass\r
 \r
                 found = True\r
                 return debug_info\r
@@ -65,14 +70,19 @@ class DebugInfoTable:
         if found == False:\r
             raise Exception('DebugInfoTable','No symbol found at 0x%x' % addr)\r
 \r
-    def load_all_symbols(self):\r
+    def load_all_symbols(self, verbose = False):\r
         if self.DebugInfos == []:\r
             self.get_debug_info()\r
         \r
         for debug_info in self.DebugInfos:\r
             section = firmware_volume.EfiSectionPE32(self.ec, debug_info[0])\r
            \r
-            edk2_debugger.load_symbol_from_file(self.ec, section.get_debug_filepath(), section.get_debug_elfbase())\r
+            try:\r
+                edk2_debugger.load_symbol_from_file(self.ec, section.get_debug_filepath(), section.get_debug_elfbase(), verbose)\r
+            except Exception, (ErrorClass, ErrorMessage):\r
+                if verbose:\r
+                    print "Error while loading a symbol file (%s: %s)" % (ErrorClass, ErrorMessage)\r
+                pass\r
 \r
     def dump(self):\r
         self.get_debug_info()\r