MetzNet
/
dfhack
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add --sizecheck option to Linux launcher script, update docs

develop
lethosor 2020-08-08 00:31:33 -04:00
parent cb1b751988
commit 6a1f046995
No known key found for this signature in database
GPG Key ID: 76A269552F4F58C1
2 changed files with 20 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
docs/Memory-research.rst
Unescape Escape View File

@ -86,10 +86,13 @@ You should not count on DF being stable when using this.
DFHack's implementation of sizecheck is currently only tested on Linux, although DFHack's implementation of sizecheck is currently only tested on Linux, although
it probably also works on macOS. It can be built with the ``BUILD_SIZECHECK`` it probably also works on macOS. It can be built with the ``BUILD_SIZECHECK``
`CMake option <compile-build-options>`, which produces a ``libsizecheck`` `CMake option <compile-build-options>`, which produces a ``libsizecheck``
library installed in the ``hack`` folder. You will need to preload this library library installed in the ``hack`` folder. On Linux, passing ``--sc`` as the
manually, by setting ``PRELOAD_LIB`` on Linux (or ``LD_PRELOAD`` if editing first argument to the ``dfhack`` launcher script will load this library on
the ``dfhack`` launcher script directly), or by editing the ``dfhack`` startup. On other platforms, or when passing a different argument to the
launcher script and adding the library to ``DYLD_INSERT_LIBRARIES`` on macOS. launcher (such as for `linux-gdb`), you will need to preload this library
manually, by setting ``PRELOAD_LIB`` on Linux (or ``LD_PRELOAD`` if editing the
``dfhack`` launcher script directly), or by editing the ``dfhack`` launcher
script and adding the library to ``DYLD_INSERT_LIBRARIES`` on macOS.
There is also an older sizecheck implementation by Mifki available on There is also an older sizecheck implementation by Mifki available on
`GitHub <https://github.com/mifki/df-sizecheck>`__ (``b.cpp`` is the main `GitHub <https://github.com/mifki/df-sizecheck>`__ (``b.cpp`` is the main
@ -129,6 +132,14 @@ Some basic GDB commands:
See the `official GDB documentation <https://www.gnu.org/software/gdb/documentation/>`_ See the `official GDB documentation <https://www.gnu.org/software/gdb/documentation/>`_
for more details. for more details.
Other analysis tools
--------------------
The ``dfhack`` launcher script on Linux has support for launching several other
tools alongside DFHack, including Valgrind (as well as Callgrind and Helgrind)
and strace. See the script for the exact command-line option to specify. Note
that currently only one tool at a time is supported, and must be specified
with the first argument to the script.
df-structures GUI df-structures GUI
----------------- -----------------

5
package/linux/dfhack
Unescape Escape View File

@ -146,6 +146,11 @@ case "$1" in
exec setarch "$setarch_arch" -R env LD_PRELOAD="$PRELOAD_LIB" ./libs/Dwarf_Fortress "$@" exec setarch "$setarch_arch" -R env LD_PRELOAD="$PRELOAD_LIB" ./libs/Dwarf_Fortress "$@"
# script does not resume # script does not resume
;; ;;
--sc | --sizecheck)
PRELOAD_LIB="${PRELOAD_LIB:+$PRELOAD_LIB:}./hack/libsizecheck.so"
MALLOC_PERTURB_=45 setarch "$setarch_arch" -R env LD_PRELOAD="$PRELOAD_LIB" ./libs/Dwarf_Fortress "$@"
ret=$?
;;
*) *)
setarch "$setarch_arch" -R env LD_PRELOAD="$PRELOAD_LIB" ./libs/Dwarf_Fortress "$@" setarch "$setarch_arch" -R env LD_PRELOAD="$PRELOAD_LIB" ./libs/Dwarf_Fortress "$@"
ret=$? ret=$?