Add source and information to regenerate debuginfo-data

[babeltrace.git] / tests / debuginfo-data / README.md

diff --git a/tests/debuginfo-data/README.md b/tests/debuginfo-data/README.md
new file mode 100644 (file)
index 0000000..02d6bd3
--- /dev/null
+++ b/tests/debuginfo-data/README.md
@@ -0,0 +1,60 @@
+debuginfo-data
+==============
+
+This directory contains pre-generated ELF and DWARF files used to test
+the debuginfo analysis feature, including lookup of DWARF debugging
+information via build ID and debug link methods, as well as the source
+files used to generate them.
+
+The generated files are:
+
+* `libhello.so` (ELF and DWARF)
+* `libhello_elf.so` (ELF only)
+* `libhello_build_id.so` (ELF with separate DWARF via build ID)
+* `libhello_debug_link.so` (ELF with separate DWARF via debug link)
+* `libhello_debug_link.so.debug` (DWARF for debug link)
+* `.build-id/cd/d98cdd87f7fe64c13b6daad553987eafd40cbb.debug` (DWARF for build ID)
+
+All files are generated from the four (4) following source files:
+
+* libhello.c
+* libhello.h
+* tp.c
+* tp.h
+
+The generated executables were built using a GNU toolchain on an
+x86_64 machine.
+
+To regenerate them, you can use follow these steps:
+
+## ELF and DWARF
+
+    $ gcc -g -fPIC -c -I. tp.c libhello.c
+    $ gcc -shared -g -llttng-ust -ldl -Wl,-soname,libhello.so -o libhello.so tp.o libhello.o
+
+## ELF only
+
+    $ gcc -fPIC -c -I. tp.c libhello.c
+    $ gcc -shared -llttng-ust -ldl -Wl,-soname,libhello_elf.so -o libhello_elf.so tp.o libhello.o
+
+## ELF and DWARF with Build ID
+
+    $ gcc -g -fPIC -c -I. tp.c libhello.c
+    $ gcc -shared -g -llttng-ust -ldl -Wl,-soname,libhello_build_id.so -Wl,--build-id=sha1 -o libhello_build_id.so tp.o libhello.o
+    $ mkdir -p .build-id/cd/
+    $ objcopy --only-keep-debug libhello_build_id.so .build-id/cd/d98cdd87f7fe64c13b6daad553987eafd40cbb.debug
+    $ strip -g libhello_build_id.so
+
+The build ID might not be the same once the executable is regenerated
+on your system, so adjust the values in the directory and file names
+accordingly. Refer to the GDB documentation for more information:
+https://sourceware.org/gdb/onlinedocs/gdb/Separate-Debug-Files.html
+
+##  ELF and DWARF with Debug Link
+
+    $ gcc -g -fPIC -c -I. tp.c libhello.c
+    $ gcc -shared -g -llttng-ust -ldl -Wl,-soname,libhello_debug_link.so -o libhello_debug_link.so tp.o libhello.o
+
+    $ objcopy --only-keep-debug libhello_debug_link.so libhello_debug_link.so.debug
+    $ strip -g libhello_debug_link.so
+    $ objcopy --add-gnu-debuglink=libhello_debug_link.so.debug libhello_debug_link.so