sdb-debugger 0.2.2__tar.gz → 0.3.2__tar.gz

{sdb_debugger-0.2.2 → sdb_debugger-0.3.2}/.gitignore

@@ -117,3 +117,10 @@ tests/integration/data/mods/
 
 # crash dump directory
 tests/integration/data/dumps/
+
+# Local development documentation (machine-specific)
+LOCAL_DEV.md
+LOCAL_DOCKER_DEV.md
+
+# Auto-generated version file (created by setuptools-scm)
+sdb/_version.py

{sdb_debugger-0.2.2 → sdb_debugger-0.3.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sdb-debugger
-Version: 0.2.2
+Version: 0.3.2
 Summary: The Slick/Simple Debugger
 Author-email: Serapheim Dimitropoulos <serapheimd@gmail.com>
 License-Expression: Apache-2.0
@@ -33,9 +33,9 @@ Dynamic: license-file
 
 <p align="center">
     <picture>
-        <source media="(prefers-color-scheme: dark)" srcset="assets/img/sdb-logo_white.png">
-        <source media="(prefers-color-scheme: light)" srcset="assets/img/sdb-logo.png">
-        <img src="assets/img/sdb-logo.png" alt="SDB" width="350" height="300">
+        <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/sdimitro/sdb/master/assets/img/sdb-logo_white.png">
+        <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/sdimitro/sdb/master/assets/img/sdb-logo.png">
+        <img src="https://raw.githubusercontent.com/sdimitro/sdb/master/assets/img/sdb-logo.png" alt="SDB" width="350" height="300">
     </picture>
 </p>
 

{sdb_debugger-0.2.2 → sdb_debugger-0.3.2}/README.md

@@ -1,8 +1,8 @@
 <p align="center">
     <picture>
-        <source media="(prefers-color-scheme: dark)" srcset="assets/img/sdb-logo_white.png">
-        <source media="(prefers-color-scheme: light)" srcset="assets/img/sdb-logo.png">
-        <img src="assets/img/sdb-logo.png" alt="SDB" width="350" height="300">
+        <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/sdimitro/sdb/master/assets/img/sdb-logo_white.png">
+        <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/sdimitro/sdb/master/assets/img/sdb-logo.png">
+        <img src="https://raw.githubusercontent.com/sdimitro/sdb/master/assets/img/sdb-logo.png" alt="SDB" width="350" height="300">
     </picture>
 </p>
 

{sdb_debugger-0.2.2 → sdb_debugger-0.3.2}/pyproject.toml

@@ -1,5 +1,5 @@
 [build-system]
-requires = ["setuptools>=61.0", "setuptools_scm[toml]>=6.2"]
+requires = ["setuptools>=64.0", "setuptools_scm[toml]>=6.2"]
 build-backend = "setuptools.build_meta"
 
 [project]

{sdb_debugger-0.2.2 → sdb_debugger-0.3.2}/sdb/__init__.py

@@ -34,19 +34,54 @@ except ImportError:
 # the modules are imported and attempt to have a cleaner
 # separation of concerns between modules.
 #
-from sdb.error import (Error, CommandNotFoundError, CommandError,
-                       CommandInvalidInputError, SymbolNotFoundError,
-                       CommandArgumentsError, CommandEvalSyntaxError,
-                       ParserError)
-from sdb.target import (create_object, get_object, get_prog, get_type,
-                        get_pointer_type, get_target_flags, get_symbol, is_null,
-                        type_canonical_name, type_canonicalize,
-                        type_canonicalize_name, type_canonicalize_size,
-                        type_equals, Runtime, All, Kernel, Userland, Module,
-                        Library)
-from sdb.command import (Address, Cast, Command, InputHandler, Locator,
-                         PrettyPrinter, Walk, Walker, SingleInputCommand,
-                         get_registered_commands, register_commands)
+from sdb.error import (
+    Error,
+    CommandNotFoundError,
+    CommandError,
+    CommandInvalidInputError,
+    SymbolNotFoundError,
+    CommandArgumentsError,
+    CommandEvalSyntaxError,
+    ParserError,
+)
+from sdb.target import (
+    create_object,
+    get_object,
+    get_prog,
+    get_type,
+    set_thread,
+    get_thread,
+    set_frame,
+    get_frame,
+    get_pointer_type,
+    get_target_flags,
+    get_symbol,
+    is_null,
+    type_canonical_name,
+    type_canonicalize,
+    type_canonicalize_name,
+    type_canonicalize_size,
+    type_equals,
+    Runtime,
+    All,
+    Kernel,
+    Userland,
+    Module,
+    Library,
+)
+from sdb.command import (
+    Address,
+    Cast,
+    Command,
+    InputHandler,
+    Locator,
+    PrettyPrinter,
+    Walk,
+    Walker,
+    SingleInputCommand,
+    get_registered_commands,
+    register_commands,
+)
 from sdb.pipeline import execute_pipeline, get_first_type, invoke
 
 __all__ = [
@@ -79,14 +114,18 @@ __all__ = [
     'invoke',
     'is_null',
     'get_first_type',
+    'get_frame',
     'get_object',
     'get_pointer_type',
     'get_prog',
     'get_registered_commands',
+    'get_thread',
     'get_symbol',
     'get_target_flags',
     'get_type',
     'register_commands',
+    'set_frame',
+    'set_thread',
     'type_canonical_name',
     'type_canonicalize',
     'type_canonicalize_name',

{sdb_debugger-0.2.2 → sdb_debugger-0.3.2}/sdb/_version.py

@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
 commit_id: COMMIT_ID
 __commit_id__: COMMIT_ID
 
-__version__ = version = '0.2.2'
-__version_tuple__ = version_tuple = (0, 2, 2)
+__version__ = version = '0.3.2'
+__version_tuple__ = version_tuple = (0, 3, 2)
 
-__commit_id__ = commit_id = 'gad5702e79'
+__commit_id__ = commit_id = 'gde5051e11'

{sdb_debugger-0.2.2 → sdb_debugger-0.3.2}/sdb/command.py

@@ -1,5 +1,6 @@
 #
 # Copyright 2019 Delphix
+# Copyright 2025 CoreWeave
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -23,13 +24,20 @@ registered commands during a session.
 
 import argparse
 import inspect
+import re
 import textwrap
 from typing import Any, Callable, Dict, Iterable, List, Optional, Set, Type, TypeVar
 
 import drgn
 
-from sdb.target import (type_canonicalize_name, type_canonical_name,
-                        type_canonicalize, get_prog, get_runtimes, Runtime)
+from sdb.target import (
+    type_canonicalize_name,
+    type_canonical_name,
+    type_canonicalize,
+    get_prog,
+    get_runtimes,
+    Runtime,
+)
 from sdb.error import CommandError, SymbolNotFoundError
 from sdb import target
 
@@ -50,11 +58,31 @@ def add_command(class_: Type["Command"]) -> None:
     all_commands.add(class_)
 
 
+# Regex pattern for valid C identifiers (used for command name validation)
+_VALID_COMMAND_NAME_PATTERN = re.compile(r'^[a-zA-Z_][a-zA-Z0-9_]*$')
+
+
+def is_valid_command_name(name: str) -> bool:
+    """
+    Validate that a command name follows C identifier rules.
+    Must start with a letter or underscore, followed by letters, digits,
+    or underscores. This prevents command names from starting with special
+    characters like ':', ';', ',', '.', '/', '%', etc. which could conflict
+    with mdb compatibility syntax or cause parsing issues.
+    """
+    return bool(_VALID_COMMAND_NAME_PATTERN.match(name))
+
+
 def register_command(name: str, class_: Type["Command"]) -> None:
     """
     Register the specified command name and command class, such that the
     command will be available from the SDB REPL.
     """
+    if not is_valid_command_name(name):
+        raise ValueError(
+            f"Invalid command name '{name}': must start with a letter or underscore "
+            f"and contain only letters, digits, and underscores (C identifier rules)"
+        )
     registered_commands[name] = class_
     if issubclass(class_, Walker):
         Walker.register_walker(class_)
@@ -144,58 +172,29 @@ class Command:
         #       may be calling splitlines() for None.
         #
         if cls.__doc__:
-            summary = inspect.getdoc(  # type: ignore[union-attr]
-                cls).splitlines()[0].strip()
+            summary = (
+                inspect.getdoc(  # type: ignore[union-attr]
+                    cls).splitlines()[0].strip())
         else:
             summary = None
         return argparse.ArgumentParser(prog=name, description=summary)
 
     @classmethod
-    def help(cls, name: str) -> None:
+    def help_text(cls) -> List[str]:
         """
-        This method will print a "help message" for the particular
-        command class that it's called on. The docstring and parser for
-        the class is used to populate the contents of the message.
+        This method auto-generates help text for the command based off of sub-classes.
         """
-        # pylint: disable=too-many-branches
-        parser = cls._init_parser(name)
-
-        print("SUMMARY")
-        for i, line in enumerate(parser.format_help().split('\n')):
-            #
-            # When printing the help message, the first line will have a
-            # "usage: " prefix string which looks awkward, so we strip
-            # that prefix prior to printing the first line.
-            #
-            if i == 0:
-                line = line.replace('usage: ', '')
-            print(f"    {line}")
-
-        if len(cls.names) > 1:
-            aliases = ", ".join(cls.names)
-            print("ALIASES")
-            print(f"    {aliases}")
-            print()
-
-        indent = "    "
+        paragraphs = []
         if issubclass(cls, PrettyPrinter):
-            print(
-                textwrap.fill(
-                    f"If this command is used to end a pipeline, it will print a"
-                    f" human-readable decoding of the '{cls.input_type}' objects."
-                    f" For the 'raw' object contents, pipe the output of this"
-                    f" command into 'echo'.",
-                    initial_indent=indent,
-                    subsequent_indent=indent))
-            print()
+            paragraphs.append(
+                f"If this command is used to end a pipeline, it will print a"
+                f" human-readable decoding of the '{cls.input_type}' objects."
+                f" For the 'raw' object contents, pipe the output of this"
+                f" command into 'echo'.")
 
         if issubclass(cls, Walker):
-            print(
-                textwrap.fill(
-                    f"This is a Walker for {cls.input_type}. See 'help walk'.",
-                    initial_indent=indent,
-                    subsequent_indent=indent))
-            print()
+            paragraphs.append(
+                f"This is a Walker for {cls.input_type}. See 'help walk'.")
 
         if cls.input_type is not None:
             #
@@ -208,15 +207,10 @@ class Command:
             #
             # pylint: disable=unsubscriptable-object
             it_text = "This command accepts inputs of type 'void *',"
-            if cls.input_type[-1] == '*':
+            if cls.input_type[-1] == "*":
                 it_text += f" and '{cls.input_type[:-1].strip()}',"
             it_text += f" which will be converted to '{cls.input_type}'."
-
-            print(
-                textwrap.fill(it_text,
-                              initial_indent=indent,
-                              subsequent_indent=indent))
-            print()
+            paragraphs.append(it_text)
 
         if issubclass(cls, Locator):
             # pylint: disable=no-member
@@ -231,7 +225,7 @@ class Command:
                     f" will locate all objects of type '{cls.output_type}',"
                     f" and emit them as output.")
             types = []
-            for (_, method) in inspect.getmembers(cls, inspect.isroutine):
+            for _, method in inspect.getmembers(cls, inspect.isroutine):
                 if hasattr(method, "input_typename_handled"):
                     types.append(method.input_typename_handled)
             if len(types) != 0:
@@ -239,12 +233,50 @@ class Command:
                     f" Input of the following types is also accepted,"
                     f" in which case the objects of type {cls.output_type}"
                     f" which are associated with them will be located:")
+            for type_name in types:
+                loc_text += f"{type_name}"
+                if type_name != types[-1]:
+                    loc_text += ", "
+                else:
+                    loc_text += "."
+            paragraphs.append(loc_text)
+
+        return paragraphs
+
+    @classmethod
+    def help(cls, name: str) -> None:
+        """
+        This method will print a "help message" for the particular
+        command class that it's called on. The docstring and parser for
+        the class is used to populate the contents of the message.
+        """
+        # pylint: disable=too-many-branches
+        parser = cls._init_parser(name)
+
+        print("SUMMARY")
+        for i, line in enumerate(parser.format_help().split("\n")):
+            #
+            # When printing the help message, the first line will have a
+            # "usage: " prefix string which looks awkward, so we strip
+            # that prefix prior to printing the first line.
+            #
+            if i == 0:
+                line = line.replace("usage: ", "")
+            print(f"    {line}")
+
+        if len(cls.names) > 1:
+            aliases = ", ".join(cls.names)
+            print("ALIASES")
+            print(f"    {aliases}")
+            print()
+
+        indent = "    "
+        paragraphs = cls.help_text()
+        for paragraph in paragraphs:
             print(
-                textwrap.fill(loc_text,
+                textwrap.fill(paragraph,
                               initial_indent=indent,
                               subsequent_indent=indent))
-            for type_name in types:
-                print(f"{indent}{indent}{type_name}")
             print()
 
         #
@@ -354,10 +386,16 @@ class Command:
         for obj in objs:
             try:
                 obj.read_()
+            except AttributeError:
+                #
+                # This object does not support the read_() method.
+                #
+                yield obj
+                continue
             except TypeError as err:
                 obj_type = type_canonicalize(obj.type_)
-                if obj_type.kind == drgn.TypeKind.ARRAY and not obj_type.is_complete(
-                ) and not obj.absent_:
+                if (obj_type.kind == drgn.TypeKind.ARRAY and
+                        not obj_type.is_complete() and not obj.absent_):
                     #
                     # This is a zero-length array, let it go through.
                     #
@@ -385,6 +423,12 @@ class Command:
                     raise err
                 print(err.text)
                 continue
+            except drgn.ObjectAbsentError as err:
+                # Note: maybe just go ahead and yield the object?
+                if fatal:
+                    raise CommandError(self.name, str(err)) from err
+                print(str(err))
+                continue
             yield obj
 
     def call(self, objs: Iterable[drgn.Object]) -> Iterable[drgn.Object]:
@@ -491,7 +535,7 @@ class Walker(Command):
             if canonical_type != expected_type:
                 raise CommandError(
                     self.name,
-                    f'expected input of type {expected_type}, but received {canonical_type}'
+                    f"expected input of type {expected_type}, but received {canonical_type}",
                 )
 
             yield from self.walk(obj)
@@ -530,8 +574,9 @@ class PrettyPrinter(Command):
             if type_canonical_name(obj.type_) != type_name:
                 raise CommandError(
                     self.name,
-                    f'expected input of type {self.input_type}, but received '
-                    f'type {obj.type_}')
+                    f"expected input of type {self.input_type}, but received "
+                    f"type {obj.type_}",
+                )
             yield obj
 
     def _call(  # type: ignore[return]
@@ -559,7 +604,7 @@ class Locator(Command):
 
     def no_input(self) -> Iterable[drgn.Object]:
         # pylint: disable=missing-docstring
-        raise CommandError(self.name, 'command requires an input')
+        raise CommandError(self.name, "command requires an input")
 
     def caller(self, objs: Iterable[drgn.Object]) -> Iterable[drgn.Object]:
         """
@@ -571,7 +616,7 @@ class Locator(Command):
         if self.output_type is not None:
             out_type = target.get_type(self.output_type)
         baked = {}
-        for (_, method) in inspect.getmembers(self, inspect.ismethod):
+        for _, method in inspect.getmembers(self, inspect.ismethod):
             if not hasattr(method, "input_typename_handled"):
                 continue
             baked[type_canonicalize_name(
@@ -583,7 +628,12 @@ class Locator(Command):
             return
 
         for i in objs:
-            obj_type_name = type_canonical_name(i.type_)
+            try:
+                obj_type_name = type_canonical_name(i.type_)
+            except AttributeError:
+                # This input is not a drgn.Object, so we can't check its type.
+                yield i
+                continue
 
             # try subclass-specified input types first, so that they can
             # override any other behavior
@@ -609,7 +659,7 @@ class Locator(Command):
 
             # error
             raise CommandError(self.name,
-                               f'no handler for input of type {i.type_}')
+                               f"no handler for input of type {i.type_}")
 
     def _call(self,
               objs: Iterable[drgn.Object]) -> Optional[Iterable[drgn.Object]]:
@@ -624,7 +674,7 @@ class Locator(Command):
         return None
 
 
-T = TypeVar("T", bound=Locator)
+T = TypeVar("T", bound=Locator)  # pylint: disable=invalid-name
 IH = Callable[[T, drgn.Object], Iterable[drgn.Object]]
 
 
@@ -702,7 +752,7 @@ class Dereference(Command):
                 raise CommandError(
                     self.name,
                     f"'{obj.type_.type_name()}' is not a valid pointer type")
-            if obj_type.type.type_name() == 'void':
+            if obj_type.type.type_name() == "void":
                 raise CommandError(self.name,
                                    "cannot dereference a void pointer")
             yield drgn.Object(get_prog(),
@@ -880,7 +930,7 @@ class Walk(Command):
             print(Walk._help_message())
 
 
-def InputHandler(typename: str) -> Callable[[IH[T]], IH[T]]:
+def InputHandler(typename: str) -> Callable[[IH[T]], IH[T]]:  # pylint: disable=invalid-name
     """
     This is a decorator which should be applied to methods of subclasses of
     Locator. The decorator causes this method to be called when the pipeline