PyPI CI Status Documentation Status https://img.shields.io/badge/code%20style-black-000000.svg

drgn (pronounced “dragon”) is a debugger with an emphasis on programmability. drgn exposes the types and variables in a program for easy, expressive scripting in Python. For example, you can debug the Linux kernel:

>>> from drgn.helpers.linux import list_for_each_entry
>>> for mod in list_for_each_entry('struct module',
...                                prog['modules'].address_of_(),
...                                'list'):
...    if mod.refcnt.counter > 10:
...        print(mod.name)
...
(char [56])"snd"
(char [56])"evdev"
(char [56])"i915"

Although other debuggers like GDB have scripting support, drgn aims to make scripting as natural as possible so that debugging feels like coding. This makes it well-suited for introspecting the complex, inter-connected state in large programs. It is also designed as a library that can be used to build debugging and introspection tools; see the official tools.

drgn was developed at Meta for debugging the Linux kernel (as an alternative to the crash utility), but it can also debug userspace programs written in C. C++ support is in progress.

Documentation can be found at drgn.readthedocs.io.

Installation

Package Manager

drgn can be installed using the package manager on some Linux distributions.

  • Fedora >= 32

    $ sudo dnf install drgn

  • RHEL/CentOS >= 8

    Enable EPEL. Then:

    $ sudo dnf install drgn

  • Arch Linux

    Install the drgn package from the AUR.

pip

If your Linux distribution doesn’t package the latest release of drgn, you can install it with pip.

First, install pip. Then, run:

$ sudo pip3 install drgn

This will install a binary wheel by default. If you get a build error, then pip wasn’t able to use the binary wheel. Install the dependencies listed below and try again.

Note that RHEL/CentOS 6, Debian Stretch, Ubuntu Trusty, and Ubuntu Xenial (and older) ship Python versions which are too old. Python 3.6 or newer must be installed.

From Source

To get the development version of drgn, you will need to build it from source. First, install dependencies:

  • Fedora/RHEL/CentOS

    $ sudo dnf install autoconf automake elfutils-devel gawk gcc git libtool make pkgconf python3 python3-devel python3-pip python3-setuptools

    Replace dnf with yum for RHEL/CentOS < 8.

  • Debian/Ubuntu

    $ sudo apt-get install autoconf automake gawk gcc git liblzma-dev libelf-dev libdw-dev libtool make pkgconf python3 python3-dev python3-pip python3-setuptools zlib1g-dev

  • Arch Linux

    $ sudo pacman -S --needed autoconf automake gawk gcc git libelf libtool make pkgconf python python-pip python-setuptools

Optionally, install libkdumpfile if you want support for the makedumpfile compressed kernel core dump format. libkdumpfile is currently only packaged on Fedora and EPEL. For other distributions, you must install it manually.

Then, run:

$ git clone https://github.com/osandov/drgn.git
$ cd drgn
$ python3 setup.py build
$ sudo python3 setup.py install

See the installation documentation for more options.

Quick Start

drgn debugs the running kernel by default; run sudo drgn. To debug a running program, run sudo drgn -p $PID. To debug a core dump (either a kernel vmcore or a userspace core dump), run drgn -c $PATH. Make sure to install debugging symbols for whatever you are debugging.

Then, you can access variables in the program with prog['name'] and access structure members with .:

$ sudo drgn
>>> prog['init_task'].comm
(char [16])"swapper/0"

You can use various predefined helpers:

>>> len(list(bpf_prog_for_each(prog)))
11
>>> task = find_task(prog, 115)
>>> cmdline(task)
[b'findmnt', b'-p']

You can get stack traces with prog.stack_trace() and access parameters or local variables with stack_trace['name']:

>>> trace = prog.stack_trace(task)
>>> trace[5]
#5 at 0xffffffff8a5a32d0 (do_sys_poll+0x400/0x578) in do_poll at ./fs/select.c:961:8 (inlined)
>>> poll_list = trace[5]['list']
>>> file = fget(task, poll_list.entries[0].fd)
>>> d_path(file.f_path.address_of_())
b'/proc/115/mountinfo'

See the user guide for more details and features.

License

Copyright (c) Meta Platforms, Inc. and affiliates.

drgn is licensed under the GPLv3 or later.

Project links

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (0.3.0)

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for osandov from gravatar.com osandov

Credits

Author: Omar Sandoval

License

GNU General Public License v3 or later (GPLv3+) (GPL-3.0-or-later)

Requires

Python >=3.6

Classifiers

Report project as malware

Metadata

Project links

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (0.3.0)

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for osandov from gravatar.com osandov

Credits

Author: Omar Sandoval

License

GNU General Public License v3 or later (GPLv3+) (GPL-3.0-or-later)

Requires

Python >=3.6

Classifiers

Report project as malware

Release files for drgn 0.0.16

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for drgn 0.0.16
File Size Uploaded
drgn-0.0.16.tar.gz 911.2 kB Details

Built distributions (wheels)

Table of built distributions (wheels) for drgn 0.0.16
File
drgn-0.0.16-cp310-cp310-manylinux_2_12_x86_64.manylinux2010_x86_64.whl 4.1 MB CPython 3.10 CPython 3.10 Linux glibc 2.12+ x86-64 Details
drgn-0.0.16-cp39-cp39-manylinux_2_12_x86_64.manylinux2010_x86_64.whl 4.1 MB CPython 3.9 CPython 3.9 Linux glibc 2.12+ x86-64 Details
drgn-0.0.16-cp38-cp38-manylinux_2_12_x86_64.manylinux2010_x86_64.whl 4.1 MB CPython 3.8 CPython 3.8 Linux glibc 2.12+ x86-64 Details
drgn-0.0.16-cp37-cp37m-manylinux_2_12_x86_64.manylinux2010_x86_64.whl 4.1 MB CPython 3.7 CPython 3.7 pymalloc Linux glibc 2.12+ x86-64 Details
drgn-0.0.16-cp36-cp36m-manylinux_2_12_x86_64.manylinux2010_x86_64.whl 4.1 MB CPython 3.6 CPython 3.6 pymalloc Linux glibc 2.12+ x86-64 Details

Total release size: 21.3 MB

Release files / drgn-0.0.16.tar.gz

Download URL drgn-0.0.16.tar.gz
Size 911.2 kB
Tags Source
SHA-256 checksum
How to use checksums 		a6b50233c8c415a1948736294f68a6bdf32dfe9e3752b28c0468f84043dcfd94
BLAKE2b-256 checksum
How to use checksums 		70cc7c15e737cc31871a77e472ef2f0cc17ad1463182ba4f30f9957c744ad6a6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing? 		No
Uploaded via twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.9

Release files / drgn-0.0.16-cp310-cp310-manylinux_2_12_x86_64.manylinux2010_x86_64.whl

Download URL drgn-0.0.16-cp310-cp310-manylinux_2_12_x86_64.manylinux2010_x86_64.whl
Size 4.1 MB
Tags CPython 3.10 Linux glibc 2.12+ x86-64
SHA-256 checksum
How to use checksums 		c99fc9ad4c74c347c159683d9854449479caac051051cef9d4b6e70a88738ac5
BLAKE2b-256 checksum
How to use checksums 		a88ea40e0bee25a1132a7c0140aa956e15b3dcffd3c8733e53a61e84789a9255
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing? 		No
Uploaded via twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.9

Release files / drgn-0.0.16-cp39-cp39-manylinux_2_12_x86_64.manylinux2010_x86_64.whl

Download URL drgn-0.0.16-cp39-cp39-manylinux_2_12_x86_64.manylinux2010_x86_64.whl
Size 4.1 MB
Tags CPython 3.9 Linux glibc 2.12+ x86-64
SHA-256 checksum
How to use checksums 		00e43a284d126125ceabd55246793fd893341e991dd9c60062dabfc1b29332e0
BLAKE2b-256 checksum
How to use checksums 		c8eaf5f2bd5dd4608829b7b2111d815029798ffb9958b71d37b0204cf2540816
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing? 		No
Uploaded via twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.9

Release files / drgn-0.0.16-cp38-cp38-manylinux_2_12_x86_64.manylinux2010_x86_64.whl

Download URL drgn-0.0.16-cp38-cp38-manylinux_2_12_x86_64.manylinux2010_x86_64.whl
Size 4.1 MB
Tags CPython 3.8 Linux glibc 2.12+ x86-64
SHA-256 checksum
How to use checksums 		fc03231e1f66d1402334800ac52f63fee9746ae13d0cea6af0d87bbc4b50b872
BLAKE2b-256 checksum
How to use checksums 		f3804d3f96de9bd6f8da14531b26894e90a09f525e230fedcd1b75356f09eb4c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing? 		No
Uploaded via twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.9

Release files / drgn-0.0.16-cp37-cp37m-manylinux_2_12_x86_64.manylinux2010_x86_64.whl

Download URL drgn-0.0.16-cp37-cp37m-manylinux_2_12_x86_64.manylinux2010_x86_64.whl
Size 4.1 MB
Tags CPython 3.7 CPython 3.7 pymalloc Linux glibc 2.12+ x86-64
SHA-256 checksum
How to use checksums 		9e1aaf38eee290dc1ffe927e1aa4e79e92948c2bb66a240e589d507d719d6b35
BLAKE2b-256 checksum
How to use checksums 		a75cb549946ae3f6bc4726a3181513ed77e0adb831c7cbcb1e5d99a0fe77a186
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing? 		No
Uploaded via twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.9

Release files / drgn-0.0.16-cp36-cp36m-manylinux_2_12_x86_64.manylinux2010_x86_64.whl

Download URL drgn-0.0.16-cp36-cp36m-manylinux_2_12_x86_64.manylinux2010_x86_64.whl
Size 4.1 MB
Tags CPython 3.6 CPython 3.6 pymalloc Linux glibc 2.12+ x86-64
SHA-256 checksum
How to use checksums 		1bd96848203fe0afde68c76e1b047833992c5b5189fc64ed7ff9cb484fa67970
BLAKE2b-256 checksum
How to use checksums 		71228495ab598758485c78e24832564e1c6d60c6b0a33d5e68050209dab2778c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing? 		No
Uploaded via twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.9
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page