def main() -> None:
python_version = '.'.join(str(v) for v in sys.version_info[:3])
libkdumpfile = f'with{"" if drgn._with_libkdumpfile else "out"} libkdumpfile'
version = f'drgn {drgn.__version__} (using Python {python_version}, {libkdumpfile})'
parser = argparse.ArgumentParser(prog='drgn',
description='Scriptable debugger')
program_group = parser.add_argument_group(
title='program selection', ).add_mutually_exclusive_group()
program_group.add_argument('-k',
'--kernel',
action='store_true',
help='debug the running kernel (default)')
program_group.add_argument('-c',
'--core',
metavar='PATH',
type=str,
help='debug the given core dump')
program_group.add_argument(
'-p',
'--pid',
metavar='PID',
type=int,
help='debug the running process with the given PID')
symbol_group = parser.add_argument_group('debugging symbols')
symbol_group.add_argument(
'-s',
'--symbols',
metavar='PATH',
type=str,
action='append',
help=
'load additional debugging symbols from the given file; this may option may be given more than once'
)
symbol_group.add_argument(
'--no-default-symbols',
dest='default_symbols',
action='store_false',
help=
"don't load any debugging symbols that were not explicitly added with -s"
)
parser.add_argument(
'-q',
'--quiet',
action='store_true',
help=
"don't print non-fatal warnings (e.g., about missing debugging information)"
)
parser.add_argument(
'script',
metavar='ARG',
type=str,
nargs=argparse.REMAINDER,
help='script to execute instead of running in interactive mode')
parser.add_argument('--version', action='version', version=version)
args = parser.parse_args()
prog = drgn.Program()
if args.core is not None:
prog.set_core_dump(args.core)
elif args.pid is not None:
prog.set_pid(args.pid or os.getpid())
else:
prog.set_kernel()
try:
prog.load_debug_info(args.symbols or [], args.default_symbols)
except drgn.MissingDebugInfoError as e:
if not args.quiet:
print(str(e), file=sys.stderr)
init_globals: Dict[str, Any] = {'prog': prog}
if args.script:
sys.argv = args.script
runpy.run_path(args.script[0],
init_globals=init_globals,
run_name='__main__')
else:
import atexit
import readline
from drgn.internal.rlcompleter import Completer
init_globals['drgn'] = drgn
drgn_globals = [
'NULL',
'Object',
'cast',
'container_of',
'execscript',
'reinterpret',
'sizeof',
]
for attr in drgn_globals:
init_globals[attr] = getattr(drgn, attr)
init_globals['__name__'] = '__main__'
init_globals['__doc__'] = None
histfile = os.path.expanduser('~/.drgn_history')
try:
readline.read_history_file(histfile)
except FileNotFoundError:
pass
readline.parse_and_bind('tab: complete')
readline.set_history_length(1000)
atexit.register(readline.write_history_file, histfile)
readline.set_completer(Completer(init_globals).complete)
atexit.register(lambda: readline.set_completer(None))
sys.displayhook = displayhook
banner = version + """
For help, type help(drgn).
>>> import drgn
>>> from drgn import """ + ', '.join(drgn_globals)
if prog.flags & drgn.ProgramFlags.IS_LINUX_KERNEL:
banner += '\n>>> from drgn.helpers.linux import *'
module = importlib.import_module('drgn.helpers.linux')
for name in module.__dict__['__all__']:
init_globals[name] = getattr(module, name)
code.interact(banner=banner, exitmsg='', local=init_globals)
def main() -> None:
drgn_version = pkg_resources.get_distribution("drgn").version
python_version = ".".join(str(v) for v in sys.version_info[:3])
libkdumpfile = f'with{"" if drgn._with_libkdumpfile else "out"} libkdumpfile'
version = f"drgn {drgn_version} (using Python {python_version}, {libkdumpfile})"
parser = argparse.ArgumentParser(prog="drgn", description="Scriptable debugger")
program_group = parser.add_argument_group(
title="program selection",
).add_mutually_exclusive_group()
program_group.add_argument(
"-k", "--kernel", action="store_true", help="debug the running kernel (default)"
)
program_group.add_argument(
"-c", "--core", metavar="PATH", type=str, help="debug the given core dump"
)
program_group.add_argument(
"-p",
"--pid",
metavar="PID",
type=int,
help="debug the running process with the given PID",
)
symbol_group = parser.add_argument_group("debugging symbols")
symbol_group.add_argument(
"-s",
"--symbols",
metavar="PATH",
type=str,
action="append",
help="load additional debugging symbols from the given file; this option may be given more than once",
)
default_symbols_group = symbol_group.add_mutually_exclusive_group()
default_symbols_group.add_argument(
"--main-symbols",
dest="default_symbols",
action="store_const",
const={"main": True},
help="only load debugging symbols for the main executable and those added with -s; "
"for userspace programs, this is currently equivalent to --no-default-symbols",
)
default_symbols_group.add_argument(
"--no-default-symbols",
dest="default_symbols",
action="store_const",
const={},
help="don't load any debugging symbols that were not explicitly added with -s",
)
parser.add_argument(
"-q",
"--quiet",
action="store_true",
help="don't print non-fatal warnings (e.g., about missing debugging information)",
)
parser.add_argument(
"script",
metavar="ARG",
type=str,
nargs=argparse.REMAINDER,
help="script to execute instead of running in interactive mode",
)
parser.add_argument("--version", action="version", version=version)
args = parser.parse_args()
prog = drgn.Program()
if args.core is not None:
prog.set_core_dump(args.core)
elif args.pid is not None:
prog.set_pid(args.pid or os.getpid())
else:
prog.set_kernel()
if args.default_symbols is None:
args.default_symbols = {"default": True, "main": True}
try:
prog.load_debug_info(args.symbols, **args.default_symbols)
except drgn.MissingDebugInfoError as e:
if not args.quiet:
print(str(e), file=sys.stderr)
init_globals: Dict[str, Any] = {"prog": prog}
if args.script:
sys.argv = args.script
runpy.run_path(args.script[0], init_globals=init_globals, run_name="__main__")
else:
import atexit
import readline
from drgn.internal.rlcompleter import Completer
init_globals["drgn"] = drgn
drgn_globals = [
"NULL",
"Object",
"cast",
"container_of",
"execscript",
"reinterpret",
"sizeof",
]
for attr in drgn_globals:
init_globals[attr] = getattr(drgn, attr)
init_globals["__name__"] = "__main__"
init_globals["__doc__"] = None
histfile = os.path.expanduser("~/.drgn_history")
try:
readline.read_history_file(histfile)
except OSError as e:
if not isinstance(e, FileNotFoundError) and not args.quiet:
print("could not read history:", str(e), file=sys.stderr)
def write_history_file():
try:
readline.write_history_file(histfile)
except OSError as e:
if not args.quiet:
print("could not write history:", str(e), file=sys.stderr)
atexit.register(write_history_file)
readline.set_history_length(1000)
readline.parse_and_bind("tab: complete")
readline.set_completer(Completer(init_globals).complete)
atexit.register(lambda: readline.set_completer(None))
sys.displayhook = displayhook
banner = (
version
+ """
For help, type help(drgn).
>>> import drgn
>>> from drgn import """
+ ", ".join(drgn_globals)
)
if prog.flags & drgn.ProgramFlags.IS_LINUX_KERNEL:
banner += "\n>>> from drgn.helpers.linux import *"
module = importlib.import_module("drgn.helpers.linux")
for name in module.__dict__["__all__"]:
init_globals[name] = getattr(module, name)
code.interact(banner=banner, exitmsg="", local=init_globals)