openbmc-tools/ipkdbg/README.md

4 debugging and coredump analysis of split-debug binaries by exploiting bitbake's
9 Assuming the presence of the [appropriate integration](#theory-of-integration),
14     ipkdbg [-q] RELEASE FILE CORE [PACKAGE...]
17 It handles the following use-cases:
19 ### Core Dump Analysis
21 After extracting a core file from the BMC an interactive `gdb` session can be
25 $ ipkdbg 2.11.0 - my-application.core
34 3. `-` is the FILE parameter. `-` specifies it must be extracted from the core
35 4. `my-application.core` is a core dump generated by `/usr/bin/my-application`
38 once the core has been loaded to provide a backtrace.
41 the image package database is available. `ipkdbg` will perform a reverse-lookup
42 to map the absolute binary path extracted from the core to the package that
48 the necessary packages are listed on the command-line.
53 the `-q` option to quit `gdb` immediately after the backtrace is printed. The
57 ipkdbg -q 2.11.0 - my-application.core
63 running instance of `/usr/bin/my-application` on the BMC. `ipkdbg` is then used
67 $ ipkdbg 2.11.0 /usr/bin/my-application -
76 3. `/usr/bin/my-application` is the absolute path of the application to debug
77 4. `-` is the CORE parameter. `-` specifies that there is no core file
80 the image package database is available. `ipkdbg` will perform a reverse-lookup
81 to map the absolute binary path provided on the command-line to the package that
87 the necessary packages are listed on the command-line.
97 To save exiting the `gdb` session and re-invoking `ipkdbg` to add a package to
115 2. A multi-arch capable `gdb` is installed
121 binaries inside itself as a self-extracting shell-script. What you see in this
131 [`os-release(5)`][os-release]:
133 [os-release]:
134   https://www.man7.org/linux/man-pages/man5/os-release.5.html#OPTIONS
137 $(uname -m)/${ID}/${VERSION_ID}/opkg
143 To avoid licensing and distribution legal issues openbmc-tools does not provide
144 pre-built `opkg` binaries. You must build your own and integrate them into the
146 [the `build-opkg` script is provided](build-opkg). It probably won't work
165 environment. The `IPKDBG_CONF_*` variables help describe a `wget`-compatible URL
176 `tmp/deploy/ipk` once `bitbake obmc-phosphor-image && bitbake package-index` has
181 with [`INC_IPK_IMAGE_GEN = "1"`][incremental-builds] by archiving the directory
182 hierarchy under `./tmp/work/*/obmc-phosphor-image/1.0-r0/temp/saved` with the
186 tar -cJf opkg-database.tar.xz \
187     -C ./tmp/work/*/obmc-phosphor-image/1.0-r0/temp/saved/target/ \
191 `ipkdbg` assumes that the appropriate `opkg-database.tar.xz` can be fetched
195 [incremental-builds]:
196   https://git.openembedded.org/openembedded-core/commit/?id=adf587e55c0f9bc74f0bef415273c937401baebb