drgn
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 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
Install dependencies:
Arch Linux:
$ sudo pacman -S --needed gcc libelf make pkgconf python python-pip python-setuptoolsDebian/Ubuntu:
$ sudo apt-get install gcc liblzma-dev libelf-dev libdw-dev make pkgconf python3 python3-dev python3-pip python3-setuptools zlib1g-devNote that Debian Stretch, Ubuntu Trusty, and Ubuntu Xenial (and older) ship Python versions which are too old. Python 3.6 or newer must be installed manually.
Fedora:
$ sudo dnf install elfutils-devel gcc make pkgconf python3 python3-devel python3-pip python3-setuptoolsOptionally, install:
libkdumpfile if you want support for kdump-compressed kernel core dumps
Then, run:
$ sudo pip3 install drgnSee 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. The program must have debugging symbols available.
Then, you can access variables in the program with prog['name'], access structure members with ., use various predefined helpers, and more:
$ sudo drgn
>>> prog['init_task'].comm
(char [16])"swapper/0"
>>> d_path(fget(find_task(prog, 1), 0).f_path.address_of_())
b'/dev/null'
>>> max(task.stime for task in for_each_task(prog))
(u64)4192109975952
>>> sum(disk.gendisk.part0.nr_sects for disk in for_each_disk(prog))
(sector_t)999705952See the user guide for more information.
License
Copyright (c) Facebook, Inc. and its affiliates.
drgn is licensed under the GPLv3 or later.
1 maintainer
Metadata
1 maintainer
Release files for drgn 0.0.12
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| drgn-0.0.12.tar.gz | 840.3 kB | Details |
Built distributions (wheels)
| File | Reset | |||
|---|---|---|---|---|
| drgn-0.0.12-cp310-cp310-manylinux_2_12_x86_64.manylinux2010_x86_64.whl | CPython 3.10 | CPython 3.10 | Linux glibc 2.12+ x86-64 | Details |
| drgn-0.0.12-cp39-cp39-manylinux_2_12_x86_64.manylinux2010_x86_64.whl | CPython 3.9 | CPython 3.9 | Linux glibc 2.12+ x86-64 | Details |
| drgn-0.0.12-cp38-cp38-manylinux_2_12_x86_64.manylinux2010_x86_64.whl | CPython 3.8 | CPython 3.8 | Linux glibc 2.12+ x86-64 | Details |
| drgn-0.0.12-cp37-cp37m-manylinux_2_12_x86_64.manylinux2010_x86_64.whl | CPython 3.7 | CPython 3.7 pymalloc | Linux glibc 2.12+ x86-64 | Details |
| drgn-0.0.12-cp36-cp36m-manylinux_2_12_x86_64.manylinux2010_x86_64.whl | CPython 3.6 | CPython 3.6 pymalloc | Linux glibc 2.12+ x86-64 | Details |
Total release size: 21.0 MB
Release files / drgn-0.0.12.tar.gz
| Download URL | drgn-0.0.12.tar.gz |
|---|---|
| Size | 840.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
2bb11a4144eea8ac957e666724359a5a426248e083944dd6bf52f3327b1f19fb
|
|
BLAKE2b-256 checksum How to use checksums |
3153d3a65306b2ef9094927c3c2bbf84ccf9d0053017a2510a7ed497d4e467f8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.9.5
|
Release files / drgn-0.0.12-cp310-cp310-manylinux_2_12_x86_64.manylinux2010_x86_64.whl
| Download URL | drgn-0.0.12-cp310-cp310-manylinux_2_12_x86_64.manylinux2010_x86_64.whl |
|---|---|
| Size | 4.0 MB |
| Tags | CPython 3.10 Linux glibc 2.12+ x86-64 |
|
SHA-256 checksum How to use checksums |
c968761d936af0483f28bd0b5750b0dbd4491c667718160ce58f9caf9908ba6a
|
|
BLAKE2b-256 checksum How to use checksums |
bf41c3a99d475d6e7293dc75eb3f0021e43a75b76836aea7fd7ab8b2c247535c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.9.5
|
Release files / drgn-0.0.12-cp39-cp39-manylinux_2_12_x86_64.manylinux2010_x86_64.whl
| Download URL | drgn-0.0.12-cp39-cp39-manylinux_2_12_x86_64.manylinux2010_x86_64.whl |
|---|---|
| Size | 4.0 MB |
| Tags | CPython 3.9 Linux glibc 2.12+ x86-64 |
|
SHA-256 checksum How to use checksums |
6d9d2bd06eb66220e097686fbf3248b388a9daa5f8b4a0c51c151377598cedf2
|
|
BLAKE2b-256 checksum How to use checksums |
b5ab959ffb251392bbcd8c2d3415ee52455109f09b2449e1868a6b88ea1ffba6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.9.5
|
Release files / drgn-0.0.12-cp38-cp38-manylinux_2_12_x86_64.manylinux2010_x86_64.whl
| Download URL | drgn-0.0.12-cp38-cp38-manylinux_2_12_x86_64.manylinux2010_x86_64.whl |
|---|---|
| Size | 4.0 MB |
| Tags | CPython 3.8 Linux glibc 2.12+ x86-64 |
|
SHA-256 checksum How to use checksums |
b66e6d5be5c3fec377f318a40c5d9131774817d7f7efdadbdbe08093a83c27f8
|
|
BLAKE2b-256 checksum How to use checksums |
ae6348689d8ab738eb1c71fcd27c6618ba8cc171f48c2a0b4eb69c3dcca95779
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.9.5
|
Release files / drgn-0.0.12-cp37-cp37m-manylinux_2_12_x86_64.manylinux2010_x86_64.whl
| Download URL | drgn-0.0.12-cp37-cp37m-manylinux_2_12_x86_64.manylinux2010_x86_64.whl |
|---|---|
| Size | 4.0 MB |
| Tags | CPython 3.7 CPython 3.7 pymalloc Linux glibc 2.12+ x86-64 |
|
SHA-256 checksum How to use checksums |
023b76f954a4b0a7b9f8f59ea71267bb4c0f8a6ace6db6792086b0da20173731
|
|
BLAKE2b-256 checksum How to use checksums |
706561bf75bbcf0faa40107d3fdaaafed6a616a313703d2af4fb7713f8ca6c62
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.9.5
|
Release files / drgn-0.0.12-cp36-cp36m-manylinux_2_12_x86_64.manylinux2010_x86_64.whl
| Download URL | drgn-0.0.12-cp36-cp36m-manylinux_2_12_x86_64.manylinux2010_x86_64.whl |
|---|---|
| Size | 4.0 MB |
| Tags | CPython 3.6 CPython 3.6 pymalloc Linux glibc 2.12+ x86-64 |
|
SHA-256 checksum How to use checksums |
3cc00e4879744d0e768781d6d72aa46089b0afa21da4728230c204d299b6ae06
|
|
BLAKE2b-256 checksum How to use checksums |
24f6c07781689f8d0f7cc1e8c1b6ce2ab6fc5960e36aba23427d157e26450db0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.9.5
|
