* [PATCH v6 00/21] Add gdb python scripts as kernel debugging helpers
@ 2013-10-28 8:58 Jan Kiszka
2013-10-28 8:58 ` [PATCH v6 01/21] scripts/gdb: Add infrastructure Jan Kiszka
0 siblings, 1 reply; 4+ messages in thread
From: Jan Kiszka @ 2013-10-28 8:58 UTC (permalink / raw)
To: Andrew Morton, linux-kernel
Cc: Jason Wessel, kgdb-bugreport, Andi Kleen, Tom Tromey,
Ben Widawsky, Borislav Petkov, Tatiana Al-Chueyr Martins,
David S. Miller, Fenghua Yu, Kay Sievers, linux-doc, linux-ia64,
linux-kbuild, Michal Marek, Rob Landley, sparclinux, Tony Luck
It's been a while since my last update of these patches. This one is
mostly about cleaning up and making some details more convenient:
- proper registration of module data segments to access module
variables - this obsoletes lx_modvar again
- stable breakpoint target on do_init_module in order to track module
loading more reliably from the debugger
- internal refactoring with the aim to "pythonize" the scripts (credits
for all valuable suggestions belong to Tatiana, many thanks, for
improper implementations to me)
See http://lkml.indiana.edu/hypermail/linux/kernel/1210.0/01598.html for
the original description and
git://git.kiszka.org/linux.git queues/gdb-scripts
for the latest version.
Jan
CC: "David S. Miller" <davem@davemloft.net>
CC: Fenghua Yu <fenghua.yu@intel.com>
CC: Kay Sievers <kay@vrfy.org>
CC: linux-doc@vger.kernel.org
CC: linux-ia64@vger.kernel.org
CC: linux-kbuild@vger.kernel.org
CC: Michal Marek <mmarek@suse.cz>
CC: Rob Landley <rob@landley.net>
CC: sparclinux@vger.kernel.org
CC: Tony Luck <tony.luck@intel.com>
Jan Kiszka (21):
scripts/gdb: Add infrastructure
scripts/gdb: Add cache for type objects
scripts/gdb: Add container_of helper and convenience function
scripts/gdb: Add module iteration class
scripts/gdb: Add lx-symbols command
module: Do not inline do_init_module
scripts/gdb: Add automatic symbol reloading on module insertion
scripts/gdb: Add internal helper and convenience function to look up a
module
scripts/gdb: Add get_target_endianness helper
scripts/gdb: Add read_u16/32/64 helpers
scripts/gdb: Add lx-dmesg command
scripts/gdb: Add task iteration class
scripts/gdb: Add helper and convenience function to look up tasks
scripts/gdb: Add is_target_arch helper
scripts/gdb: Add internal helper and convenience function to retrieve
thread_info
scripts/gdb: Add get_gdbserver_type helper
scripts/gdb: Add internal helper and convenience function for per-cpu
lookup
scripts/gdb: Add lx_current convenience function
scripts/gdb: Add class to iterate over CPU masks
scripts/gdb: Add lx-lsmod command
scripts/gdb: Add basic documentation
Documentation/gdb-kernel-debugging.txt | 159 +++++++++++++++++++++++++++++++
Makefile | 5 +-
kernel/module.c | 9 +-
scripts/Makefile | 3 +-
scripts/gdb/Makefile | 11 +++
scripts/gdb/linux/Makefile | 9 ++
scripts/gdb/linux/__init__.py | 0
scripts/gdb/linux/cpus.py | 139 +++++++++++++++++++++++++++
scripts/gdb/linux/dmesg.py | 64 +++++++++++++
scripts/gdb/linux/modules.py | 111 ++++++++++++++++++++++
scripts/gdb/linux/symbols.py | 166 +++++++++++++++++++++++++++++++++
scripts/gdb/linux/tasks.py | 108 +++++++++++++++++++++
scripts/gdb/linux/utils.py | 156 +++++++++++++++++++++++++++++++
scripts/gdb/vmlinux-gdb.py | 30 ++++++
14 files changed, 966 insertions(+), 4 deletions(-)
create mode 100644 Documentation/gdb-kernel-debugging.txt
create mode 100644 scripts/gdb/Makefile
create mode 100644 scripts/gdb/linux/Makefile
create mode 100644 scripts/gdb/linux/__init__.py
create mode 100644 scripts/gdb/linux/cpus.py
create mode 100644 scripts/gdb/linux/dmesg.py
create mode 100644 scripts/gdb/linux/modules.py
create mode 100644 scripts/gdb/linux/symbols.py
create mode 100644 scripts/gdb/linux/tasks.py
create mode 100644 scripts/gdb/linux/utils.py
create mode 100644 scripts/gdb/vmlinux-gdb.py
--
1.8.1.1.298.ge7eed54
^ permalink raw reply [flat|nested] 4+ messages in thread* [PATCH v6 01/21] scripts/gdb: Add infrastructure 2013-10-28 8:58 [PATCH v6 00/21] Add gdb python scripts as kernel debugging helpers Jan Kiszka @ 2013-10-28 8:58 ` Jan Kiszka 2013-10-30 5:35 ` Andi Kleen 0 siblings, 1 reply; 4+ messages in thread From: Jan Kiszka @ 2013-10-28 8:58 UTC (permalink / raw) To: Andrew Morton, linux-kernel Cc: Jason Wessel, kgdb-bugreport, Andi Kleen, Tom Tromey, Ben Widawsky, Borislav Petkov, Tatiana Al-Chueyr Martins, Michal Marek, linux-kbuild This provides the basic infrastructure to load kernel-specific python helper scripts when debugging the kernel in gdb. The loading mechanism is based on gdb loading for <objfile>-gdb.py when opening <objfile>. Therefore, this places a corresponding link to the main helper script into the output directory that contains vmlinux. The main scripts will pull in submodules containing Linux specific gdb commands and functions. To avoid polluting the source directory with compiled python modules, we link to them from the object directory. Due to gdb.parse_and_eval and string redirection for gdb.execute, we depend on gdb >= 7.2. This feature depends on CONFIG_DEBUG_INFO. CC: Michal Marek <mmarek@suse.cz> CC: linux-kbuild@vger.kernel.org Signed-off-by: Jan Kiszka <jan.kiszka@siemens.com> --- Makefile | 5 ++++- scripts/Makefile | 3 ++- scripts/gdb/Makefile | 11 +++++++++++ scripts/gdb/linux/Makefile | 9 +++++++++ scripts/gdb/linux/__init__.py | 0 scripts/gdb/vmlinux-gdb.py | 23 +++++++++++++++++++++++ 6 files changed, 49 insertions(+), 2 deletions(-) create mode 100644 scripts/gdb/Makefile create mode 100644 scripts/gdb/linux/Makefile create mode 100644 scripts/gdb/linux/__init__.py create mode 100644 scripts/gdb/vmlinux-gdb.py diff --git a/Makefile b/Makefile index 868c0eb..0e222d7 100644 --- a/Makefile +++ b/Makefile @@ -778,6 +778,9 @@ endif ifdef CONFIG_BUILD_DOCSRC $(Q)$(MAKE) $(build)=Documentation endif +ifdef CONFIG_DEBUG_INFO + $(Q)ln -fsn $(srctree)/scripts/gdb/vmlinux-gdb.py +endif +$(call if_changed,link-vmlinux) # The actual objects are generated when descending, @@ -1026,7 +1029,7 @@ MRPROPER_FILES += .config .config.old .version .old_version $(version_h) \ Module.symvers tags TAGS cscope* GPATH GTAGS GRTAGS GSYMS \ signing_key.priv signing_key.x509 x509.genkey \ extra_certificates signing_key.x509.keyid \ - signing_key.x509.signer + signing_key.x509.signer vmlinux-gdb.py # clean - Delete most, but leave enough to build external modules # diff --git a/scripts/Makefile b/scripts/Makefile index 01e7adb..3204b91 100644 --- a/scripts/Makefile +++ b/scripts/Makefile @@ -37,6 +37,7 @@ subdir-$(CONFIG_MODVERSIONS) += genksyms subdir-y += mod subdir-$(CONFIG_SECURITY_SELINUX) += selinux subdir-$(CONFIG_DTC) += dtc +subdir-$(CONFIG_DEBUG_INFO) += gdb # Let clean descend into subdirs -subdir- += basic kconfig package selinux +subdir- += basic kconfig package selinux gdb diff --git a/scripts/gdb/Makefile b/scripts/gdb/Makefile new file mode 100644 index 0000000..c0e2fd3 --- /dev/null +++ b/scripts/gdb/Makefile @@ -0,0 +1,11 @@ +subdir-y := linux + +always := gdb-scripts + +$(obj)/gdb-scripts: +ifneq ($(KBUILD_SRC),) + $(Q)ln -fsn $(srctree)/$(obj)/*.py $(objtree)/$(obj) +endif + @: + +clean-files := *.pyc $(if $(KBUILD_SRC),*.py) diff --git a/scripts/gdb/linux/Makefile b/scripts/gdb/linux/Makefile new file mode 100644 index 0000000..34ccd06 --- /dev/null +++ b/scripts/gdb/linux/Makefile @@ -0,0 +1,9 @@ +always := gdb-scripts + +$(obj)/gdb-scripts: +ifneq ($(KBUILD_SRC),) + $(Q)ln -fsn $(srctree)/$(obj)/*.py $(objtree)/$(obj) +endif + @: + +clean-files := *.pyc $(if $(KBUILD_SRC),*.py) diff --git a/scripts/gdb/linux/__init__.py b/scripts/gdb/linux/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/scripts/gdb/vmlinux-gdb.py b/scripts/gdb/vmlinux-gdb.py new file mode 100644 index 0000000..c1d90ce --- /dev/null +++ b/scripts/gdb/vmlinux-gdb.py @@ -0,0 +1,23 @@ +# +# gdb helper commands and functions for Linux kernel debugging +# +# loader module +# +# Copyright (c) Siemens AG, 2012, 2013 +# +# Authors: +# Jan Kiszka <jan.kiszka@siemens.com> +# +# This work is licensed under the terms of the GNU GPL version 2. +# + +import os + +sys.path.insert(0, os.path.dirname(__file__) + "/scripts/gdb") + +try: + gdb.parse_and_eval("0") + gdb.execute("", to_string=True) +except: + gdb.write("NOTE: gdb 7.2 or later required for Linux helper scripts to " + "work.\n") -- 1.8.1.1.298.ge7eed54 ^ permalink raw reply related [flat|nested] 4+ messages in thread
* Re: [PATCH v6 01/21] scripts/gdb: Add infrastructure 2013-10-28 8:58 ` [PATCH v6 01/21] scripts/gdb: Add infrastructure Jan Kiszka @ 2013-10-30 5:35 ` Andi Kleen 2013-10-30 10:28 ` Jan Kiszka 0 siblings, 1 reply; 4+ messages in thread From: Andi Kleen @ 2013-10-30 5:35 UTC (permalink / raw) To: Jan Kiszka Cc: Andrew Morton, linux-kernel, Jason Wessel, kgdb-bugreport, Andi Kleen, Tom Tromey, Ben Widawsky, Borislav Petkov, Tatiana Al-Chueyr Martins, Michal Marek, linux-kbuild > The loading mechanism is based on gdb loading for <objfile>-gdb.py when > opening <objfile>. Therefore, this places a corresponding link to the > main helper script into the output directory that contains vmlinux. > This feature depends on CONFIG_DEBUG_INFO. Could you make this a separate config option? Having the links for people who don't use gdb would be ugly. -Andi ^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: [PATCH v6 01/21] scripts/gdb: Add infrastructure 2013-10-30 5:35 ` Andi Kleen @ 2013-10-30 10:28 ` Jan Kiszka 0 siblings, 0 replies; 4+ messages in thread From: Jan Kiszka @ 2013-10-30 10:28 UTC (permalink / raw) To: Andi Kleen Cc: Andrew Morton, linux-kernel, Jason Wessel, kgdb-bugreport, Tom Tromey, Ben Widawsky, Borislav Petkov, Tatiana Al-Chueyr Martins, Michal Marek, linux-kbuild On 2013-10-30 06:35, Andi Kleen wrote: >> The loading mechanism is based on gdb loading for <objfile>-gdb.py when >> opening <objfile>. Therefore, this places a corresponding link to the >> main helper script into the output directory that contains vmlinux. > >> This feature depends on CONFIG_DEBUG_INFO. > > Could you make this a separate config option? Having the links for > people who don't use gdb would be ugly. > Like this? diff --git a/lib/Kconfig.debug b/lib/Kconfig.debug index 06344d9..d66a8f8 100644 --- a/lib/Kconfig.debug +++ b/lib/Kconfig.debug @@ -143,6 +143,17 @@ config DEBUG_INFO_REDUCED DEBUG_INFO build and compile times are reduced too. Only works with newer gcc versions. +config GDB_SCRIPTS + bool "Provide GDB scripts for kernel debugging" + select DEBUG_INFO + help + This creates the required links to GDB helper scripts in the + build directory. If you load vmlinux into gdb, the helper + scripts will be automatically imported by gdb as well, and + additional functions are available to analyze a Linux kernel + instance. See Documentation/gdb-kernel-debugging.txt for further + details. + config ENABLE_WARN_DEPRECATED bool "Enable __deprecated logic" default y Will send an updated series soon, also adjusting the docs, just waiting for potential further comments. Jan -- Siemens AG, Corporate Technology, CT RTC ITP SES-DE Corporate Competence Center Embedded Linux ^ permalink raw reply related [flat|nested] 4+ messages in thread
end of thread, other threads:[~2013-10-30 10:28 UTC | newest] Thread overview: 4+ messages (download: mbox.gz follow: Atom feed -- links below jump to the message on this page -- 2013-10-28 8:58 [PATCH v6 00/21] Add gdb python scripts as kernel debugging helpers Jan Kiszka 2013-10-28 8:58 ` [PATCH v6 01/21] scripts/gdb: Add infrastructure Jan Kiszka 2013-10-30 5:35 ` Andi Kleen 2013-10-30 10:28 ` Jan Kiszka
This is a public inbox, see mirroring instructions for how to clone and mirror all data and code used for this inbox