i#1850 Android, i#1726 ARM: update README and docs for new platforms

Updates the README files and documentation for the new Android/ARM and
Linux/ARM support.

Review-URL: https://codereview.appspot.com/285340043

Author: derekbruening

README

@@ -1,5 +1,5 @@
 # **********************************************************
-# Copyright (c) 2010-2015 Google, Inc.  All rights reserved.
+# Copyright (c) 2010-2016 Google, Inc.  All rights reserved.
 # Copyright (c) 2008-2009 VMware, Inc.  All rights reserved.
 # **********************************************************
 
@@ -34,8 +34,9 @@ memory leaks, and (on Windows) handle leaks, GDI API usage errors, and
 accesses to un-reserved thread local storage slots.
 
 Dr. Memory is based on the DynamoRIO binary translation engine.  Dr. Memory
-has full support for Windows (XP and higher) and Linux, with early
-Mac OSX support (32-bit only) available as a Beta release.
+has full support for Windows (XP and higher) and Linux, with preliminary
+Mac OSX, Linux/ARM, and Android/ARM support (32-bit only for those three)
+available as a Beta release.
 
 Dr. Memory also includes a system call tracing tool for Windows and a
 symbol query utility.

README.md

@@ -10,7 +10,7 @@ memory leaks, and (on Windows) handle leaks, GDI API usage errors, and
 accesses to un-reserved thread local storage slots.
 
 Dr. Memory operates on unmodified application binaries running on Windows,
-Linux, or Mac on commodity IA-32 and AMD64 hardware.
+Linux, Mac, or Android on commodity IA-32, AMD64, and ARM hardware.
 
 Dr. Memory is released under an LGPL license and binary packages are
 [available for

drmemory/docs/main.dox

@@ -1,5 +1,5 @@
 /* **********************************************************
- * Copyright (c) 2012-2015 Google, Inc.  All rights reserved.
+ * Copyright (c) 2012-2016 Google, Inc.  All rights reserved.
  * Copyright (c) 2009 VMware, Inc.  All rights reserved.
  * **********************************************************/
 
@@ -33,8 +33,7 @@ memory leaks, and (on Windows) handle leaks, GDI API usage errors, and
 accesses to un-reserved thread local storage slots.
 
 Dr. Memory operates on unmodified application binaries running on Windows,
-Mac, or Linux \if VMX86_SERVER or ESXi \endif on commodity IA-32 and AMD64
-hardware.
+Mac, Linux, or Android on commodity IA-32, AMD64, and ARM hardware.
 
 This document describes how to use Dr. Memory.  It is divided into the
 following sections:

drmemory/docs/release.dox

@@ -64,6 +64,8 @@ The changes between \TOOL_VERSION and version 1.9.0 include:
  - Added preliminary 64-bit Dr. Memory support for Windows and Linux (but
    not MacOS yet).  This does not yet include uninitialized read checking,
    so we still recommend compiling your application as 32-bit.
+ - Added preliminary Linux/ARM and Android/ARM 32-bit Dr. Memory support.
+   This does not yet include uninitialized read checking.
  - Fixed incremental error output to the console for graphical
    applications, which was missing in prior versions when using certain
    consoles such as cmd.
@@ -382,6 +384,8 @@ The changes between version 1.1.0 and 1.0.1 include:
 Dr. Memory is still under development.  It has some missing features and undoubtedly
 some bugs.  The missing features include:
 
+ - Uninitialized read checking is not yet supported for 64-bit applications
+   nor for ARM platforms.
  - Windows system call parameters are not all known, which can
    result in false positives and false negatives, especially on Vista or
    Windows 7+, or with code that interacts with the network.
@@ -414,8 +418,6 @@ some bugs.  The missing features include:
    - This release can produce false positives if multiple threads write
      to adjacent bytes simultaneously.  Future releases will provide
      options to trade off performance, memory usage, and accuracy.
- - On a 32-bit Windows 7 kernel, error reports are not visible in the \p cmd window.
-   Send stderr to a file to view them inlined with program output.
 
 \subsection sec_interop Interoperability
 

drmemory/docs/tools.dox

@@ -1,5 +1,5 @@
 /* **********************************************************
- * Copyright (c) 2013-2014 Google, Inc.  All rights reserved.
+ * Copyright (c) 2013-2016 Google, Inc.  All rights reserved.
  * **********************************************************/
 
 /* Dr. Memory: the memory debugger
@@ -137,19 +137,19 @@ The usage summary is as follows:
 % bin/symquery.exe
 Usage:
 Look up addresses for one module:
-  D:\derek\drmemory\git\build_x86_dbg\bin\symquery.exe -e <module> [-f] [-v] -a [<address relative to module base> ...]
+  D:\derek\drmemory\bin\symquery.exe -e <module> [-f] [-v] -a [<address relative to module base> ...]
 Look up addresses for multiple modules:
-  D:\derek\drmemory\git\build_x86_dbg\bin\symquery.exe [-f] [-v] -q <pairs of [module_path;address relative to module base] on stdin>
+  D:\derek\drmemory\bin\symquery.exe [-f] [-v] -q <pairs of [module_path;address relative to module base] on stdin>
 Look up exact symbols for one module:
-  D:\derek\drmemory\git\build_x86_dbg\bin\symquery.exe -e <module> [-v] [--enum] -s [<symbol1> <symbol2> ...]
+  D:\derek\drmemory\bin\symquery.exe -e <module> [-v] [--enum] -s [<symbol1> <symbol2> ...]
 Look up symbols matching wildcard patterns (glob-style: *,?) for one module:
-  D:\derek\drmemory\git\build_x86_dbg\bin\symquery.exe -e <module> [-v] --search -s [<symbol1> <symbol2> ...]
+  D:\derek\drmemory\bin\symquery.exe -e <module> [-v] --search -s [<symbol1> <symbol2> ...]
 Look up private symbols matching wildcard patterns (glob-style: *,?) for one module:
-  D:\derek\drmemory\git\build_x86_dbg\bin\symquery.exe -e <module> [-v] --searchall -s [<symbol1> <symbol2> ...]
+  D:\derek\drmemory\bin\symquery.exe -e <module> [-v] --searchall -s [<symbol1> <symbol2> ...]
 List all symbols in a module:
-  D:\derek\drmemory\git\build_x86_dbg\bin\symquery.exe -e <module> [-v] --list
+  D:\derek\drmemory\bin\symquery.exe -e <module> [-v] --list
 List all source lines in a module:
-  D:\derek\drmemory\git\build_x86_dbg\bin\symquery.exe -e <module> [-v] --lines
+  D:\derek\drmemory\bin\symquery.exe -e <module> [-v] --lines
 Optional parameters:
   -f = show function name
   -v = verbose

drmemory/docs/using.dox

@@ -1,5 +1,5 @@
 /* **********************************************************
- * Copyright (c) 2011-2015 Google, Inc.  All rights reserved.
+ * Copyright (c) 2011-2016 Google, Inc.  All rights reserved.
  * Copyright (c) 2009-2010 VMware, Inc.  All rights reserved.
  * **********************************************************/
 
@@ -40,6 +40,7 @@ your computer:
  - \subpage page_install_linux
  - \subpage page_install_macos
  - \subpage page_install_windows
+ - \subpage page_install_android
 
 ***************************************************************************
 \page page_install_linux Installing on Linux
@@ -155,6 +156,21 @@ with the version you installed, of course).  Note that the semicolon
 (;) is important!  After editing your PATH, you should restart your Cygwin
 or cmd shell.
 
+***************************************************************************
+\page page_install_android Installing on Android
+
+Download the \p .tar.gz version of Dr. Memory for Android.  Untar the
+package into a directory on your local machine:
+
+\verbatim
+tar xzf DrMemory-ARM-Android-EABI-X.X.X-X.tar.gz
+\endverbatim
+
+Now copy the entire unpacked directory to your Android device (typically
+using <tt>adb push</tt>.  The <tt>bin/drmemory</tt> front-end can be
+invoked directly from the <tt>adb shell</tt>.  Dr. Memory for Android is
+targeted toward native applications that use Android's NDK.
+
 ***************************************************************************
 \page page_prep Preparing Your Application
 
@@ -335,6 +351,13 @@ Currently there is no support for applications built with Cygwin gcc or g++.
 The regular Dr. Memory build can be executed just fine from a Cygwin
 shell when targeting non-Cygwin applications.
 
+********************
+\section sec_prep_android Android
+
+Build your application using the Android NDK and copy it over to your device.
+Be sure to compile with debugging information included and to disable FPO,
+as described in \ref sec_prep_general.
+
 ***************************************************************************
 \page page_running Running Dr. Memory
 
@@ -418,7 +441,7 @@ On Windows:
 drmemory.exe -- c:/path/to/my/app args to my app
 \endverbatim
 
-On Linux or Mac:
+On Linux, Mac, or Android:
 \verbatim
 drmemory -- /path/to/my/app args to my app
 \endverbatim