opengauss/opengauss-dev

openGauss调试版镜像文档

镜像概述和主要用途

本镜像提供openGauss的调试版本，专为开发者设计。源代码及第三方二进制文件位于/home/opengauss目录，编译时已默认配置-O0 -g编译标志和--enable-debug选项，便于开发者进行代码调试、功能开发及快速验证。

核心功能和特性

• 调试环境就绪：预配置调试编译选项，无需手动设置-O0 -g和--enable-debug
• 完整开发环境：包含openGauss源代码及第三方依赖二进制文件，路径为/home/opengauss
• 调试工具支持：支持gdb、gstack等调试工具，需配合容器特权模式使用
• 快速验证：可直接在容器内重新编译代码并验证修改

使用场景和适用范围

• openGauss内核代码开发与调试
• 问题定位与故障排查
• 新功能开发及编译验证
• 学习openGauss内部实现机制

使用方法和配置说明

1. 拉取镜像

bash
docker pull opengauss/opengauss-dev:tagname

说明：将tagname替换为具体版本标签

2. 运行容器

需以特权模式运行容器，启用必要的调试功能：

bash
docker run --cap-add=SYS_PTRACE --security-opt seccomp=unconfined --security-opt apparmor=unconfined --privileged -it opengauss/opengauss-dev:tagname

3. 启用ptrace功能

进入容器后，执行以下命令启用ptrace：

bash
sudo bash -c "echo 0 > /proc/sys/kernel/yama/ptrace_scope"

4. 使用调试工具

查看进程并获取PID

bash
ps -ef | grep gaussdb

示例输出：

opengau+   201     1  4 15:51 ?        00:00:02 /home/opengauss/openGauss/install/bin/gaussdb -D /home/opengauss/openGauss/data
opengau+   315   244  0 15:52 pts/0    00:00:00 grep --color=auto gaussdb

使用gstack查看线程栈

bash
gstack 201  # 201为上述获取的gaussdb进程PID

示例输出：

Thread 36 (Thread 0xffff31f5eee0 (LWP 240) "undorecycler"):
#0  0x0000ffff976ec4c8 in poll () from /usr/lib64/libc.so.6
#1  0x0000000000d53abc in WaitLatchOrSocket (latch=0xffff7bb52d30, wakeEvents=25, sock=-1, timeout=2250) at pg_latch.cpp:309
......

使用gdb调试进程

bash
gdb /home/opengauss/openGauss/install/bin/gaussdb 201  # 201为进程PID

5. 调试注意事项

为获得更好的调试体验，建议在调试开始时禁用SIGUSR1和SIGUSR2信号：

gdb
(gdb) handle SIGUSR1 noprint nostop pass
Signal        Stop	Print	Pass to program	Description
SIGUSR1       No	No	Yes		User defined signal 1
(gdb) handle SIGUSR2 noprint nostop pass
Signal        Stop	Print	Pass to program	Description
SIGUSR2       No	No	Yes		User defined signal 2