Move gdb-related utility functions into their own module.

The decorable_printer.py module will soon require gdb_lookup_value() and
moving the function into a separate module avoids a circular import.

Author: visemet

gdbmongo/abseil_printers.py

@@ -20,28 +20,10 @@
 import gdb
 
 from gdbmongo import stdlib_printers
+from gdbmongo.gdbutil import gdb_resolve_type
 from gdbmongo.printer_protocol import PrettyPrinterProtocol, SupportsDisplayHint
 
 
-def gdb_resolve_type(typ: gdb.Type, /) -> gdb.Type:
-    """Look up the name of a C++ type with any typedefs, pointers, and references stripped.
-
-    This function is useful in contexts where template arguments can be pointers because GDB may not
-    load the fields of the templated entity otherwise.
-    """
-    typ = typ.strip_typedefs()
-
-    while typ.code in (gdb.TYPE_CODE_PTR, gdb.TYPE_CODE_REF):
-        typ = typ.target().strip_typedefs()
-
-    if typ.code == gdb.TYPE_CODE_FUNC:
-        return typ
-
-    typename = typ.tag if typ.tag is not None else typ.name
-    assert typename is not None
-    return gdb.lookup_type(typename)
-
-
 # pylint: disable-next=invalid-name
 def AbslHashContainerIterator(container: gdb.Value, /) -> typing.Iterator[gdb.Value]:
     """Return a generator of every node in the given absl::container_internal::raw_hash_set or

gdbmongo/boost_printers.py

@@ -20,7 +20,7 @@
 
 import gdb
 
-from gdbmongo.abseil_printers import gdb_resolve_type
+from gdbmongo.gdbutil import gdb_resolve_type
 from gdbmongo.printer_protocol import PrettyPrinterProtocol, SupportsChildren, SupportsDisplayHint
 
 

gdbmongo/bsonobj_printer.py

@@ -27,7 +27,7 @@
 from gdbmongo.bsonmisc_printer import (MongoBSONBinData, MongoBSONCode, MongoBSONDBRef,
                                        MongoBSONRegEx, MongoBSONSymbol)
 from gdbmongo.date_printer import MongoDateT
-from gdbmongo.lock_manager_printer import gdb_lookup_value
+from gdbmongo.gdbutil import gdb_lookup_value
 from gdbmongo.objectid_printer import MongoOID
 from gdbmongo.printer_protocol import PrettyPrinterProtocol, SupportsDisplayHint
 from gdbmongo.string_data_printer import MongoStringData

gdbmongo/gdbutil.py

@@ -0,0 +1,47 @@
+###
+# Copyright 2022-present MongoDB, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+###
+"""Utility functions for gdb.Types and gdb.Values."""
+
+import typing
+
+import gdb
+
+
+def gdb_lookup_value(symbol_name: str, /) -> typing.Optional[gdb.Value]:
+    """Return the gdb.Value corresponding to the symbol name given."""
+    if (symbol := gdb.lookup_symbol(symbol_name)[0]) is not None:
+        return symbol.value()
+
+    return None
+
+
+def gdb_resolve_type(typ: gdb.Type, /) -> gdb.Type:
+    """Look up the name of a C++ type with any typedefs, pointers, and references stripped.
+
+    This function is useful in contexts where template arguments can be pointers because GDB may not
+    load the fields of the templated entity otherwise.
+    """
+    typ = typ.strip_typedefs()
+
+    while typ.code in (gdb.TYPE_CODE_PTR, gdb.TYPE_CODE_REF):
+        typ = typ.target().strip_typedefs()
+
+    if typ.code == gdb.TYPE_CODE_FUNC:
+        return typ
+
+    typename = typ.tag if typ.tag is not None else typ.name
+    assert typename is not None
+    return gdb.lookup_type(typename)

gdbmongo/lock_manager_printer.py

@@ -34,19 +34,12 @@
 from gdbmongo.abseil_printers import (AbslFlatHashMapPrinter, AbslNodeHashMapPrinter,
                                       AbslFlatHashSetPrinter)
 from gdbmongo.decorable_printer import DecorationContainerPrinter
+from gdbmongo.gdbutil import gdb_lookup_value
 from gdbmongo.printer_protocol import PrettyPrinterProtocol, SupportsDisplayHint, SupportsToString
 from gdbmongo.static_immortal_printer import StaticImmortalPrinter
 from gdbmongo.string_data_printer import StdStringPrinter
 
 
-def gdb_lookup_value(symbol_name: str, /) -> typing.Optional[gdb.Value]:
-    """Return the gdb.Value corresponding to the symbol name given."""
-    if (symbol := gdb.lookup_symbol(symbol_name)[0]) is not None:
-        return symbol.value()
-
-    return None
-
-
 class ServiceContextDecorationMixin(typing.Protocol):
     """Class to add support for constructing from the global ServiceContext if the subclass already
     supports constructing from a ServiceContext explicitly.

gdbmongo/static_immortal_printer.py

@@ -17,8 +17,8 @@
 
 import gdb
 
-from gdbmongo.abseil_printers import gdb_resolve_type
 from gdbmongo.boost_printers import SingletonPrinterBase
+from gdbmongo.gdbutil import gdb_resolve_type
 from gdbmongo.printer_protocol import PrettyPrinterProtocol