Linux C:简单&结构的'漂亮'转储/打印输出(比如在gdb中) - 来自源代码?

时间:2010-07-22 16:38:28

标签: c linux printing struct gdb

我正在构建一个内核模块中的一些结构略有问题,所以我认为如果有一种简单的方法来打印结构及其值,那将会很好 - 以下是一个很小的用户态示例我的意思。

假设我们有如下的简单C示例(以bash命令的形式给出):

FN=mtest

cat > $FN.c <<EOF
#include <stdio.h> //printf
#include <stdlib.h> //calloc

struct person
{
 int age; 
 int height; 
};

static struct person *johndoe;

main ()
{

 johndoe = (struct person *)calloc(1, sizeof(struct person));
 johndoe->age = 6; 

 asm("int3"); //breakpoint for gdb

 printf("Hello World - age: %d\n", johndoe->age);

 free(johndoe);
}
EOF

gcc -g -O0 $FN.c -o $FN

# just a run command for gdb
cat > ./gdbcmds <<EOF
run
EOF

gdb --command=./gdbcmds ./$FN 

如果我们运行这个例子,程序将编译,gdb将运行它,并自动停在断点处。在这里,我们可以做到以下几点:

Program received signal SIGTRAP, Trace/breakpoint trap.
main () at mtest.c:20
20  printf("Hello World - age: %d\n", johndoe->age);
(gdb) p johndoe
$1 = (struct person *) 0x804b008
(gdb) p (struct person)*0x804b008
$2 = {age = 6, height = 0}
(gdb) c
Continuing.
Hello World - age: 6

Program exited with code 0300.
(gdb) q

如图所示,在gdb中我们可以打印输出(转储?)结构指针johndoe的值为{age = 6, height = 0} ...我想做同样的事情,但是直接来自C程序;如下例所示:

#include <stdio.h> //printf
#include <stdlib.h> //calloc
#include <whatever.h> //for imaginary printout_struct

struct person
{
 int age; 
 int height; 
};

static struct person *johndoe;
static char report[255]; 

main ()
{

 johndoe = (struct person *)calloc(1, sizeof(struct person));
 johndoe->age = 6; 

 printout_struct(johndoe, report); //imaginary command

 printf("Hello World - age: %d\nreport: %s", johndoe->age, report);

 free(johndoe);
}

会产生如下输出:

Hello World - age: 6
$2 = {age = 6, height = 0}

所以我的问题是 - 是否存在类似虚构的printout_struct的函数 - 或者是否有另一种方法可以使这样的打印输出成为可能?

提前感谢您的帮助,
干杯!

6 个答案:

答案 0 :(得分:15)

只是想说 - 感谢你所有的好和非常快速的答案,帮助我理解了这个问题(为什么在C中没有这样的'原生'功能)!

抱歉回答我自己的问题 - 这样做,以免乱丢原帖,并能够格式化代码

在进一步观察的同时,我设法找到了:

说明了使用进程本身的pid调用gdb的技巧,因此我修改了那里找到的dumpstack函数,以获取以下代码:

FN=mtest

cat > $FN.c <<EOF
#include <stdio.h> //printf
#include <stdlib.h> //calloc, system

extern const char *__progname;

struct person
{
    int age; 
    int height; 
};

static struct person *johndoe;
static char report[255]; 

static void printout_struct(void* invar, char* structname){
    /* dumpstack(void) Got this routine from http://www.whitefang.com/unix/faq_toc.html
    ** Section 6.5. Modified to redirect to file to prevent clutter
    */
    /* This needs to be changed... */
    char dbx[160];

    sprintf(dbx, "echo 'p (struct %s)*%p\n' > gdbcmds", structname, invar );
    system(dbx);

    sprintf(dbx, "echo 'where\ndetach' | gdb -batch --command=gdbcmds %s %d > struct.dump", __progname, getpid() );
    system(dbx);

    sprintf(dbx, "cat struct.dump");
    system(dbx);

    return;
}

main ()
{

    johndoe = (struct person *)calloc(1, sizeof(struct person));

    johndoe->age = 6; 
    printout_struct(johndoe, "person"); 

    johndoe->age = 8; 
    printout_struct(johndoe, "person"); 

    printf("Hello World - age: %d\n:", johndoe->age);

    free(johndoe);
}


EOF

gcc -g -O0 $FN.c -o $FN

./$FN

这基本上最终显示我想要的东西:

0x00740422 in __kernel_vsyscall ()
$1 = {age = 6, height = 0}
0x00740422 in __kernel_vsyscall ()
$1 = {age = 8, height = 0}
Hello World - age: 8

虽然,我不确定它是否适用于内核模块......

再次感谢您的帮助,
干杯!

编辑:我认为它不适用于内核模块的原因是,在这种情况下,我们有一个带有进程ID的用户程序;我们只需从这个程序中调用gdb,同时指示我们的PID - 所以gdb可以“附加”到我们的过程;然后,因为gdb也被指示用调试符号加载可执行文件(因此它将'知道'结构是什么),并指示给定结构变量所在的地址,gdb可以然后打印输出结构。

对于内核模块 - 首先我不认为它们是具有唯一PID的'进程',因此gdb将无需附加任何内容!实际上,有一个内核调试器,kgdb实际上可以进入正在运行的内核并逐步执行 module 源代码;但是,您需要通过串行连接连接第二台计算机 - 或虚拟机,请参阅Linux Hacks: Setting up kgdb using kvm/qemu

所以,无论如何,gdb似乎无法检查当前运行的主机内核gdb正在运行的内存 - 但我会尝试进行实验,如果实验表明,否则,我一定会发帖:)

答案 1 :(得分:2)

C语言没有编译时或运行时的元数据。可能有一些特定于供应商的扩展来执行此操作。例如,doxygen将生成一个XML文件,其中包含程序中每种结构类型的所有成员信息(名称和类型),编写程序来处理该XML文件并生成自动执行printout_person(const struct person *)函数的代码。

答案 2 :(得分:2)

有关解析结构的一些信息,请参阅this related question。特别是我在那里引用pstruct

在您的情况下,您希望从正在运行的程序中获取信息,您必须调用其中一个外部工具,或者从可执行文件中解析调试信息并正确显示它。

您也可以查看libgdb,但看起来可能有点过时了。

答案 3 :(得分:1)

您必须添加描述结构的元信息,以便printout_struct可以完成其工作。否则,它无法猜测任何事情。尝试使用gdb删除每个调试信息,你会发现它不能“说”关于“年龄”或其他什么。

答案 4 :(得分:0)

答案 5 :(得分:0)

这是针对用户模式而不是内核的更有效的解决方案,它准备了gdb脚本。然后,使用gdb通过脚本执行应用程序。该脚本包含带有命令的断点。在源代码中,需要将断点标记为空define:

#define gdb_print(v)

gdb_print(huge_struct);


gdb-print-prepare()
{
    # usage:
    # gdb-print-prepare $src > app.gdb
    # gdb --batch --quiet --command=app.gdb app
    cat  <<-EOF
    set auto-load safe-path /
    EOF
    grep --with-filename --line-number --recursive '^\s\+gdb_print(.*);' $1 | \
    while IFS=$'\t ;()' read line func var rest; do
        cat  <<-EOF
        break ${line%:}
        commands
        silent
        where 1
        echo \\n$var\\n
        print $var
        cont
        end
        EOF
    done
    cat  <<-EOF
    run
    bt
    echo ---\\n
    EOF
}

参考:https://gitlab.com/makelinux/lib/blob/master/snippets/gdb-print-prepare.md