diff --git a/gdb-port/README.md b/gdb-port/README.md index d2b846509e4d8ca04b911b11bf6cd55e407c16e8..ca53cd09e341ccc27d324b05bd30a901aa436c23 100644 --- a/gdb-port/README.md +++ b/gdb-port/README.md @@ -1,14 +1,16 @@ -Requirements +# Requirements - Hammer and the target parser (pdf, for now) must be built with debug symbols for the tool to work - Specifically, both of them need to be compiled with the "-g" flag - Alternatively, if a symbol file is available, loading it with the `symbol-file` gdb command, or the `-s` command line switch before executing the scripts should also work - The GUI component uses Tkinter to draw a window -Invocation +# Invocation + +(Replace `/path/to` with the appropriate paths.) ``` -gdb -ex "source /home/corax/src/gitlab-repos/profiling/perf-instrumentation/gdb-port/utility-commands.py" -ex "source /home/corax/src/gitlab-repos/profiling/perf-instrumentation/gdb-port/commands.py" -ex "source /home/corax/src/gitlab-repos/profiling/perf-instrumentation/gdb-port/hammer-breakpoints.py" -ex "source /home/corax/src/gitlab-repos/profiling/perf-instrumentation/gdb-port/breakpoint-manager.py" -ex "source /home/corax/src/gitlab-repos/profiling/perf-instrumentation/gdb-port/top-level-parse.py" -ex "hammer-parse-stop-at-pos 50" -ex "source /path/to/parser-type-instrumentation-gdb.py" -ex "source /path/to/parser-name-instrumentation-gdb.py" --args /path/to/pdf /path/to/input.pdf +gdb -ex "source /path/to/profiling/perf-instrumentation/gdb-port/utility-commands.py" -ex "source /path/to/profiling/perf-instrumentation/gdb-port/commands.py" -ex "source /path/to/profiling/perf-instrumentation/gdb-port/hammer-breakpoints.py" -ex "source /path/to/profiling/perf-instrumentation/gdb-port/breakpoint-manager.py" -ex "source /path/to/gitlab-repos/profiling/perf-instrumentation/gdb-port/top-level-parse.py" -ex "hammer-parse-stop-at-pos 50" -ex "source /path/to/parser-type-instrumentation-gdb.py" -ex "source /path/to/parser-name-instrumentation-gdb.py" --args /path/to/pdf /path/to/input.pdf ``` Note that `-ex "hammer-parse-stop-at-pos 50"` is not strictly necessary, but by default the tool will print memory stats and exit.