diff options
| author | Alexandru Croitor <alexandru.croitor@qt.io> | 2024-10-08 19:02:01 +0200 |
|---|---|---|
| committer | Alexandru Croitor <alexandru.croitor@qt.io> | 2024-10-10 14:23:31 +0200 |
| commit | 8b01ea5261fdb97c949dc4b3d9a4ea902858bd08 (patch) | |
| tree | f73564c05329edbb4209afe5d33e5949d4fcb6cb /src/corelib/debug_script.py | |
| parent | 4250ef921e5d15ba0ec5f1213a3d29df8bf75d09 (diff) | |
Add more debug messages to the lldb QtCore debug_script.py
So that it's easier to troubleshoot why a certain bridge might not be
loaded.
To enable verbose debug messages, set the
QT_LLDB_SUMMARY_PROVIDER_DEBUG environment variable to 1 when
launching Qt Creator or lldb.
The informational message to set the env var is also shown if no
bridge was loaded successfully.
Pick-to: 6.8
Task-number: QTCREATORBUG-31769
Change-Id: I53e7b26950fdd635e51d0458cb5fb90600b158a2
Reviewed-by: Tor Arne Vestbø <tor.arne.vestbo@qt.io>
Diffstat (limited to 'src/corelib/debug_script.py')
| -rw-r--r-- | src/corelib/debug_script.py | 20 |
1 files changed, 19 insertions, 1 deletions
diff --git a/src/corelib/debug_script.py b/src/corelib/debug_script.py index b4a58530dae..8087c6e2ee1 100644 --- a/src/corelib/debug_script.py +++ b/src/corelib/debug_script.py @@ -9,15 +9,20 @@ from distutils.version import LooseVersion MODULE_NAME = 'qt' +debug = print if 'QT_LLDB_SUMMARY_PROVIDER_DEBUG' in os.environ \ + else lambda *a, **k: None + def import_bridge(path, debugger, session_dict, reload_module=False): if not reload_module and MODULE_NAME in sys.modules: del sys.modules[MODULE_NAME] if sys.version_info[0] >= 3: sys.path.append(os.path.dirname(path)) + debug(f"Loading source of Qt Creator bridge from '{path}'") bridge = imp.load_source(MODULE_NAME, path) if not hasattr(bridge, '__lldb_init_module'): + print("Could not find '__lldb_init_module'. Ignoring.") return None # Make available for the current LLDB session, so that LLDB @@ -25,13 +30,16 @@ def import_bridge(path, debugger, session_dict, reload_module=False): session_dict[MODULE_NAME] = bridge # Initialize the module now that it's available globally + debug(f"Initializing Qt Creator bridge by calling __lldb_init_module(): {bridge}") bridge.__lldb_init_module(debugger, session_dict) if not debugger.GetCategory('Qt'): + debug("Could not find Qt debugger category. Qt Creator summary providers not loaded.") # Summary provider failed for some reason del session_dict[MODULE_NAME] return None + debug("Bridge loaded successfully") return bridge def __lldb_init_module(debugger, session_dict): @@ -40,11 +48,15 @@ def __lldb_init_module(debugger, session_dict): # LLDB process invocation, while still reloading for each session. if MODULE_NAME in sys.modules: module = sys.modules[MODULE_NAME] + debug(f"Module '{module.__file__}' already imported. Reloading for this session.") # Reload module for this sessions bridge = import_bridge(module.__file__, debugger, session_dict, reload_module = True) if bridge: + debug("Qt summary providers successfully reloaded.") return + else: + print("Bridge reload failed. Trying to find other Qt Creator bridges.") versions = {} for path in os.popen('mdfind kMDItemCFBundleIdentifier=org.qt-project.qtcreator'): @@ -72,8 +84,14 @@ def __lldb_init_module(debugger, session_dict): for version in sorted(versions, key=LooseVersion, reverse=True): path = versions[version] - print(f"Loading Qt summary providers from Creator {version} in '{path}'") + debug(f"Loading Qt summary providers from Creator Qt {version} in '{path}'") bridge_path = '{}/Contents/Resources/debugger/lldbbridge.py'.format(path) bridge = import_bridge(bridge_path, debugger, session_dict) if bridge: + debug(f"Qt summary providers successfully loaded.") return + + if 'QT_LLDB_SUMMARY_PROVIDER_DEBUG' not in os.environ: + print("Could not find any valid Qt Creator bridges with summary providers. " + "Launch lldb or Qt Creator with the QT_LLDB_SUMMARY_PROVIDER_DEBUG environment " + "variable to debug.") |