Use log_error_for_exception in the Python API to pass tracebacks in the stack trace associated with log messages, instead of creating large mutli-line messages for every exception

Author: D0ntPanic

python/architecture.py

@@ -24,7 +24,7 @@
 
 # Binary Ninja components
 from . import _binaryninjacore as core
-from .log import log_error
+from .log import log_error_for_exception
 from . import variable
 from . import function
 from . import architecture
@@ -232,7 +232,7 @@ def _get_caller_saved_regs(self, ctxt, count):
 			self._pending_reg_lists[result.value] = (result, reg_buf)
 			return result.value
 		except:
-			log_error(traceback.format_exc())
+			log_error_for_exception("Unhandled Python exception in CallingConvention._get_caller_saved_regs")
 			count[0] = 0
 			return None
 
@@ -247,7 +247,7 @@ def _get_callee_saved_regs(self, ctxt, count):
 			self._pending_reg_lists[result.value] = (result, reg_buf)
 			return result.value
 		except:
-			log_error(traceback.format_exc())
+			log_error_for_exception("Unhandled Python exception in CallingConvention._get_callee_saved_regs")
 			count[0] = 0
 			return None
 
@@ -262,7 +262,7 @@ def _get_int_arg_regs(self, ctxt, count):
 			self._pending_reg_lists[result.value] = (result, reg_buf)
 			return result.value
 		except:
-			log_error(traceback.format_exc())
+			log_error_for_exception("Unhandled Python exception in CallingConvention._get_int_arg_regs")
 			count[0] = 0
 			return None
 
@@ -277,7 +277,7 @@ def _get_float_arg_regs(self, ctxt, count):
 			self._pending_reg_lists[result.value] = (result, reg_buf)
 			return result.value
 		except:
-			log_error(traceback.format_exc())
+			log_error_for_exception("Unhandled Python exception in CallingConvention._get_float_arg_regs")
 			count[0] = 0
 			return None
 
@@ -288,41 +288,41 @@ def _free_register_list(self, ctxt, regs, count):
 				raise ValueError("freeing register list that wasn't allocated")
 			del self._pending_reg_lists[buf.value]
 		except:
-			log_error(traceback.format_exc())
+			log_error_for_exception("Unhandled Python exception in CallingConvention._free_register_list")
 
 	def _arg_regs_share_index(self, ctxt):
 		try:
 			return self.__class__.arg_regs_share_index
 		except:
-			log_error(traceback.format_exc())
+			log_error_for_exception("Unhandled Python exception in CallingConvention._arg_regs_share_index")
 			return False
 
 	def _arg_regs_used_for_varargs(self, ctxt):
 		try:
 			return self.__class__.arg_regs_for_varargs
 		except:
-			log_error(traceback.format_exc())
+			log_error_for_exception("Unhandled Python exception in CallingConvention._arg_regs_for_varargs")
 			return False
 
 	def _stack_reserved_for_arg_regs(self, ctxt):
 		try:
 			return self.__class__.stack_reserved_for_arg_regs
 		except:
-			log_error(traceback.format_exc())
+			log_error_for_exception("Unhandled Python exception in CallingConvention._stack_reserved_for_arg_regs")
 			return False
 
 	def _stack_adjusted_on_return(self, ctxt):
 		try:
 			return self.__class__.stack_adjusted_on_return
 		except:
-			log_error(traceback.format_exc())
+			log_error_for_exception("Unhandled Python exception in CallingConvention._stack_adjusted_on_return")
 			return False
 
 	def _eligible_for_heuristics(self, ctxt):
 		try:
 			return self.__class__.eligible_for_heuristics
 		except:
-			log_error(traceback.format_exc())
+			log_error_for_exception("Unhandled Python exception in CallingConvention._eligible_for_heuristics")
 			return False
 
 	def _get_int_return_reg(self, ctxt):
@@ -333,7 +333,7 @@ def _get_int_return_reg(self, ctxt):
 		try:
 			return self.arch.regs[self.__class__.int_return_reg].index
 		except:
-			log_error(traceback.format_exc())
+			log_error_for_exception("Unhandled Python exception in CallingConvention._get_int_return_reg")
 			return False
 
 	def _get_high_int_return_reg(self, ctxt):
@@ -342,7 +342,7 @@ def _get_high_int_return_reg(self, ctxt):
 				return 0xffffffff
 			return self.arch.regs[self.__class__.high_int_return_reg].index
 		except:
-			log_error(traceback.format_exc())
+			log_error_for_exception("Unhandled Python exception in CallingConvention._get_high_int_return_reg")
 			return False
 
 	def _get_float_return_reg(self, ctxt):
@@ -351,7 +351,7 @@ def _get_float_return_reg(self, ctxt):
 				return 0xffffffff
 			return self.arch.regs[self.__class__.float_return_reg].index
 		except:
-			log_error(traceback.format_exc())
+			log_error_for_exception("Unhandled Python exception in CallingConvention._get_float_return_reg")
 			return False
 
 	def _get_global_pointer_reg(self, ctxt):
@@ -360,7 +360,7 @@ def _get_global_pointer_reg(self, ctxt):
 				return 0xffffffff
 			return self.arch.regs[self.__class__.global_pointer_reg].index
 		except:
-			log_error(traceback.format_exc())
+			log_error_for_exception("Unhandled Python exception in CallingConvention._get_global_pointer_reg")
 			return False
 
 	def _get_implicitly_defined_regs(self, ctxt, count):
@@ -374,7 +374,7 @@ def _get_implicitly_defined_regs(self, ctxt, count):
 			self._pending_reg_lists[result.value] = (result, reg_buf)
 			return result.value
 		except:
-			log_error(traceback.format_exc())
+			log_error_for_exception("Unhandled Python exception in CallingConvention._get_implicitly_defined_regs")
 			count[0] = 0
 			return None
 
@@ -384,7 +384,7 @@ def _get_incoming_reg_value(self, ctxt, reg, func, result):
 			reg_name = self.arch.get_reg_name(reg)
 			api_obj = self.perform_get_incoming_reg_value(reg_name, func_obj)._to_core_struct()
 		except:
-			log_error(traceback.format_exc())
+			log_error_for_exception("Unhandled Python exception in CallingConvention._get_incoming_reg_value")
 			api_obj = variable.Undetermined()._to_core_struct()
 		result[0].state = api_obj.state
 		result[0].value = api_obj.value
@@ -395,7 +395,7 @@ def _get_incoming_flag_value(self, ctxt, reg, func, result):
 			reg_name = self.arch.get_reg_name(reg)
 			api_obj = self.perform_get_incoming_flag_value(reg_name, func_obj)._to_core_struct()
 		except:
-			log_error(traceback.format_exc())
+			log_error_for_exception("Unhandled Python exception in CallingConvention._get_incoming_flag_value")
 			api_obj = variable.Undetermined()._to_core_struct()
 		result[0].state = api_obj.state
 		result[0].value = api_obj.value
@@ -412,7 +412,7 @@ def _get_incoming_var_for_parameter_var(self, ctxt, in_var, func, result):
 			result[0].index = out_var.index
 			result[0].storage = out_var.storage
 		except:
-			log_error(traceback.format_exc())
+			log_error_for_exception("Unhandled Python exception in CallingConvention._get_incoming_var_for_parameter_var")
 			result[0].type = in_var[0].type
 			result[0].index = in_var[0].index
 			result[0].storage = in_var[0].storage
@@ -429,7 +429,7 @@ def _get_parameter_var_for_incoming_var(self, ctxt, in_var, func, result):
 			result[0].index = out_var.index
 			result[0].storage = out_var.storage
 		except:
-			log_error(traceback.format_exc())
+			log_error_for_exception("Unhandled Python exception in CallingConvention._get_parameter_var_for_incoming_var")
 			result[0].type = in_var[0].type
 			result[0].index = in_var[0].index
 			result[0].storage = in_var[0].storage

python/binaryview.py

@@ -27,7 +27,7 @@
 from . import binaryview
 from . import function
 from . import enums
-from .log import log_error
+from .log import log_error_for_exception
 from . import types
 from . import highlight
 from . import types
@@ -113,7 +113,7 @@ def _free_object(self, ctxt):
 		try:
 			self.perform_free_object(ctxt)
 		except:
-			log_error(traceback.format_exc())
+			log_error_for_exception("Unhandled Python exception while freeing DataRenderer")
 
 	def _is_valid_for_data(self, ctxt, view, addr, type, context, ctxCount):
 		try:
@@ -127,7 +127,7 @@ def _is_valid_for_data(self, ctxt, view, addr, type, context, ctxCount):
 				)
 			return self.perform_is_valid_for_data(ctxt, view, addr, type, pycontext)
 		except:
-			log_error(traceback.format_exc())
+			log_error_for_exception("Unhandled Python exception in DataRenderer._is_valid_for_data")
 			return False
 
 	def _get_lines_for_data(self, ctxt, view, addr, type, prefix, prefixCount, width, count, typeCtx, ctxCount, language):
@@ -175,7 +175,7 @@ def _get_lines_for_data(self, ctxt, view, addr, type, prefix, prefixCount, width
 
 			return ctypes.cast(self.line_buf, ctypes.c_void_p).value
 		except:
-			log_error(traceback.format_exc())
+			log_error_for_exception("Unhandled Python exception in DataRenderer._get_lines_for_data")
 			return None
 
 	def _free_lines(self, ctxt, lines, count):

python/callingconvention.py

@@ -28,7 +28,7 @@
 from . import _binaryninjacore as core
 from . import platform as _platform
 from . import types as _types
-from .log import log_error
+from .log import log_error_for_exception
 from . import binaryview
 from . import filemetadata
 from . import typecontainer
@@ -102,7 +102,7 @@ def _is_valid(view: core.BNBinaryView, callback: Callable[['binaryview.BinaryVie
 			view_obj = binaryview.BinaryView(file_metadata=file_metadata, handle=core.BNNewViewReference(view))
 			return callback(view_obj)
 		except:
-			log_error(traceback.format_exc())
+			log_error_for_exception("Unhandled Python exception in _DebugInfoParserMetaClass._is_valid")
 			return False
 
 	@staticmethod
@@ -119,7 +119,7 @@ def _parse_info(
 			assert parser_ref is not None, "core.BNNewDebugInfoReference returned None"
 			return callback(DebugInfo(parser_ref), view_obj, debug_view_obj, progress)
 		except:
-			log_error(traceback.format_exc())
+			log_error_for_exception("Unhandled Python exception in _DebugInfoParserMetaClass._parse_info")
 			return False
 
 	@classmethod

python/datarender.py

@@ -26,7 +26,7 @@
 from . import _binaryninjacore as core
 from . import binaryview
 from . import types
-from .log import log_error
+from .log import log_error_for_exception
 from .architecture import Architecture, CoreArchitecture
 from .platform import Platform
 from typing import Iterable, List, Optional, Union, Tuple
@@ -369,7 +369,7 @@ def _is_mangled_string(self, ctxt, name):
 		try:
 			return self.is_mangled_string(core.pyNativeStr(name))
 		except:
-			log_error(traceback.format_exc())
+			log_error_for_exception("Unhandled Python exception in Demangler._is_mangled_string")
 			return False
 
 	def _demangle(self, ctxt, arch, name, out_type, out_var_name, view):
@@ -395,14 +395,14 @@ def _demangle(self, ctxt, arch, name, out_type, out_var_name, view):
 			out_var_name[0] = Demangler._cached_name
 			return True
 		except:
-			log_error(traceback.format_exc())
+			log_error_for_exception("Unhandled Python exception in Demangler._demangle")
 			return False
 
 	def _free_var_name(self, ctxt, name):
 		try:
 			Demangler._cached_name = None
 		except:
-			log_error(traceback.format_exc())
+			log_error_for_exception("Unhandled Python exception in Demangler._free_var_name")
 
 	def is_mangled_string(self, name: str) -> bool:
 		"""

python/debuginfo.py

@@ -29,7 +29,7 @@
 import binaryninja
 import binaryninja._binaryninjacore as core
 from . import settings
-from .log import log_error
+from .log import log_error_for_exception
 
 
 def to_bytes(field):
@@ -75,13 +75,13 @@ def _destroy_instance(self, ctxt):
 				self.__class__._registered_instances.remove(self)
 			self.perform_destroy_instance()
 		except:
-			log_error(traceback.format_exc())
+			log_error_for_exception("Unhandled Python exception in DownloadInstance._destroy_instance")
 
 	def _perform_request(self, ctxt, url):
 		try:
 			return self.perform_request(url)
 		except:
-			log_error(traceback.format_exc())
+			log_error_for_exception("Unhandled Python exception in DownloadInstance._perform_request")
 			return -1
 
 	def _perform_custom_request(self, ctxt, method, url, header_count, header_keys, header_values, response):
@@ -117,7 +117,7 @@ def data_generator():
 			except Exception as e:
 				out_response[0] = None
 				core.BNSetErrorForDownloadInstance(self.handle, e.__class__.__name__)
-				log_error(traceback.format_exc())
+				log_error_for_exception("Unhandled Python exception in DownloadInstance._perform_custom_request")
 				return -1
 
 			if py_response is not None:
@@ -137,7 +137,7 @@ def data_generator():
 			return 0 if py_response is not None else -1
 		except:
 			out_response[0] = None
-			log_error(traceback.format_exc())
+			log_error_for_exception("Unhandled Python exception in DownloadInstance._perform_custom_request")
 			return -1
 
 	def _free_response(self, ctxt, response):
@@ -168,7 +168,7 @@ def _read_callback(self, data, len_, ctxt):
 
 			return bytes_len
 		except:
-			log_error(traceback.format_exc())
+			log_error_for_exception("Unhandled Python exception in DownloadInstance._read_callback")
 			return 0
 
 	def _write_callback(self, data, len, ctxt):
@@ -177,7 +177,7 @@ def _write_callback(self, data, len, ctxt):
 			self._response = self._response + str_bytes
 			return len
 		except:
-			log_error(traceback.format_exc())
+			log_error_for_exception("Unhandled Python exception in DownloadInstance._write_callback")
 			return 0
 
 	def get_response(self, url):
@@ -297,7 +297,7 @@ def _create_instance(self, ctxt):
 			assert download_instance is not None, "core.BNNewDownloadInstanceReference returned None"
 			return ctypes.cast(download_instance, ctypes.c_void_p).value
 		except:
-			log_error(traceback.format_exc())
+			log_error_for_exception("Unhandled Python exception in DownloadProvider._create_instance")
 			return None
 
 	def create_instance(self):
@@ -387,7 +387,7 @@ def perform_request(self, url):
 				return -1
 			except:
 				core.BNSetErrorForDownloadInstance(self.handle, "Unknown Exception!")
-				log_error(traceback.format_exc())
+				log_error_for_exception("Unhandled Python exception in PythonDownloadInstance.perform_request")
 				return -1
 
 			return 0
@@ -486,11 +486,11 @@ def perform_request(self, url):
 
 				except URLError as e:
 					core.BNSetErrorForDownloadInstance(self.handle, e.__class__.__name__)
-					log_error(str(e))
+					log_error_for_exception(str(e))
 					return -1
 				except:
 					core.BNSetErrorForDownloadInstance(self.handle, "Unknown Exception!")
-					log_error(traceback.format_exc())
+					log_error_for_exception("Unhandled Python exception in PythonDownloadInstance.perform_request")
 					return -1
 
 				return 0