summaryrefslogtreecommitdiffstats
path: root/docs/html/ndk/guides/ndk-stack.jd
diff options
context:
space:
mode:
Diffstat (limited to 'docs/html/ndk/guides/ndk-stack.jd')
-rw-r--r--docs/html/ndk/guides/ndk-stack.jd86
1 files changed, 86 insertions, 0 deletions
diff --git a/docs/html/ndk/guides/ndk-stack.jd b/docs/html/ndk/guides/ndk-stack.jd
new file mode 100644
index 0000000..46146cb
--- /dev/null
+++ b/docs/html/ndk/guides/ndk-stack.jd
@@ -0,0 +1,86 @@
+page.title=ndk-stack
+@jd:body
+
+<div id="qv-wrapper">
+ <div id="qv">
+ <h2>On this page</h2>
+
+ <ol>
+ <li><a href="#use">Usage</a></li>
+ </ol>
+ </div>
+ </div>
+
+<p>The {@code ndk-stack} tool allows you to filter stack traces as they appear in the
+output of <a href="{@docRoot}tools/help/logcat.html">{@code adb logcat}</a>. It also replaces any
+address inside a shared library with the corresponding
+{@code &lt;source-file&gt;:&lt;line-number&gt;} values from your source code, making issues easier
+to pinpoint.</p>
+
+<p>For example, it translates something like:</p>
+
+<pre>
+I/DEBUG ( 31): *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** ***
+I/DEBUG ( 31): Build fingerprint: 'generic/google_sdk/generic/:2.2/FRF91/43546:eng/test-keys'
+I/DEBUG ( 31): pid: 351, tid: 351 %gt;%gt;%gt; /data/local/ndk-tests/crasher &lt;&lt;&lt;
+I/DEBUG ( 31): signal 11 (SIGSEGV), fault addr 0d9f00d8
+I/DEBUG ( 31): r0 0000af88 r1 0000a008 r2 baadf00d r3 0d9f00d8
+I/DEBUG ( 31): r4 00000004 r5 0000a008 r6 0000af88 r7 00013c44
+I/DEBUG ( 31): r8 00000000 r9 00000000 10 00000000 fp 00000000
+I/DEBUG ( 31): ip 0000959c sp be956cc8 lr 00008403 pc 0000841e cpsr 60000030
+I/DEBUG ( 31): #00 pc 0000841e /data/local/ndk-tests/crasher
+I/DEBUG ( 31): #01 pc 000083fe /data/local/ndk-tests/crasher
+I/DEBUG ( 31): #02 pc 000083f6 /data/local/ndk-tests/crasher
+I/DEBUG ( 31): #03 pc 000191ac /system/lib/libc.so
+I/DEBUG ( 31): #04 pc 000083ea /data/local/ndk-tests/crasher
+I/DEBUG ( 31): #05 pc 00008458 /data/local/ndk-tests/crasher
+I/DEBUG ( 31): #06 pc 0000d362 /system/lib/libc.so
+I/DEBUG ( 31):
+</pre>
+
+<p>into the more readable output: </p>
+
+<pre>
+********** Crash dump: **********
+Build fingerprint: 'generic/google_sdk/generic/:2.2/FRF91/43546:eng/test-keys'
+pid: 351, tid: 351 &gt;&gt;&gt; /data/local/ndk-tests/crasher &lt;&lt;&lt;
+signal 11 (SIGSEGV), fault addr 0d9f00d8
+Stack frame #00 pc 0000841e /data/local/ndk-tests/crasher : Routine zoo in /tmp/foo/crasher/jni/zoo.c:13
+Stack frame #01 pc 000083fe /data/local/ndk-tests/crasher : Routine bar in /tmp/foo/crasher/jni/bar.c:5
+Stack frame #02 pc 000083f6 /data/local/ndk-tests/crasher : Routine my_comparison in /tmp/foo/crasher/jni/foo.c:9
+Stack frame #03 pc 000191ac /system/lib/libc.so
+Stack frame #04 pc 000083ea /data/local/ndk-tests/crasher : Routine foo in /tmp/foo/crasher/jni/foo.c:14
+Stack frame #05 pc 00008458 /data/local/ndk-tests/crasher : Routine main in /tmp/foo/crasher/jni/main.c:19
+Stack frame #06 pc 0000d362 /system/lib/libc.so
+</pre>
+
+<h2>Usage</h2>
+<p>To use {@code ndk-stack}, you first need a directory containing symbolic versions of your app's
+shared libraries. If you use the NDK build system ({@code ndk-build}), these shared-library
+files reside under {@code $PROJECT_PATH/obj/local/&lt;abi&gt;}, where {@code &lt;abi&gt;} represents
+your device's ABI. By default, the system uses the {@code armeabi} ABI.</p>
+
+<p>There are two ways to use the tool. You can feed the logcat text as direct input to the program.
+For example:</p>
+
+<pre class="no-pretty-print">
+adb logcat | $NDK/ndk-stack -sym $PROJECT_PATH/obj/local/armeabi
+</pre>
+
+<p>You can also use the {@code -dump} option to specify the logcat as an input file. For example:
+</p>
+
+<pre class="no-pretty-print">
+adb logcat &gt; /tmp/foo.txt
+$NDK/ndk-stack -sym $PROJECT_PATH/obj/local/armeabi -dump foo.txt
+</pre>
+
+<p>When it begins parsing the logcat output, the tool looks for an initial line of asterisks.
+For example:</p>
+
+<pre class="no-pretty-print">
+*** *** *** *** *** *** *** *** *** *** *** *** *** *** *** ***
+</pre>
+
+<p class="note"><strong>Note: </strong>When copy/pasting traces, don't forget this line, or
+{@code ndk-stack} won't work correctly.</p> \ No newline at end of file