Improvements for Android:

* All Linux targets: add minimal ioctl support for the ION_IOC family

* Android targets: change proprietary-ioctl support for GPUs from
  being a build-time #define kludge to being controlled by --kernel-variant,
  as it should be.  Update documentation accordingly.



git-svn-id: svn://svn.valgrind.org/valgrind/trunk@14440 a5019735-40e9-0310-863c-91ae7b9d1cf9

Author: sewardj

NEWS

@@ -27,6 +27,9 @@ significantly improved relative to the 3.9.0 release.
 
 * Both 32- and 64-bit executables are supported on MacOSX 10.8 and 10.9.
 
+* Configuration for and running on Android targets has changed.
+  See README.android in the source tree for details.
+
 * ================== DEPRECATED FEATURES =================
 
 * --db-attach is now deprecated and will be removed in the next

README.android

@@ -1,9 +1,15 @@
 
-How to cross-compile for Android.  These notes were last updated on 
-17 Feb 2012, for Valgrind SVN revision 12390/2257.
+How to cross-compile and run on Android.  Please read to the end,
+since there are important details further down regarding crash
+avoidance and GPU support.
 
-This is known to work at least for :
-ARM:
+These notes were last updated on 3 Sept 2014, for Valgrind SVN
+revision 14439/2941.
+
+These instructions are known to work, or have worked at some time in
+the past, for:
+
+arm:
   Android 4.0.3 running on a (rooted, AOSP build) Nexus S.
   Android 4.0.3 running on Motorola Xoom.
   Android 4.0.3 running on android arm emulator.
@@ -34,7 +40,7 @@ install them are described in README.android_emulator.
 
 You can get android-ndk-r6 from
 http://dl.google.com/android/ndk/android-ndk-r6-linux-x86.tar.bz2
-Install it somewhere.  Doesn't matter where.  Then do this:
+Install it somewhere.  Doesn't matter where.  Then:
 
 
 # Modify this (obviously).  Note, this "export" command is only done
@@ -44,25 +50,12 @@ Install it somewhere.  Doesn't matter where.  Then do this:
 export NDKROOT=/path/to/android-ndk-r6
 
 
-# Modify this too.  Tell the build system which Android hardware you
-# are building for.  It needs to know this so it can compile in
-# support for the right Android-hw-specific ioctls.  (sigh.)  As with
-# NDKROOT above, this is merely to avoid repeated typing; none of the
-# commands read it.
-#
-# Currently the supported values are:  nexus_s pandaboard
-# So choose one of the below:
-#
-export HWKIND=nexus_s         # Samsung Nexus S; also Xoom (for now)
-export HWKIND=generic         # A generic Android device. eg, Pandaboard
-export HWKIND=emulator        # Android emulator
-
 # Then cd to the root of your Valgrind source tree.
 #
 cd /path/to/valgrind/source/tree
 
 
-# After this point, you don't need to modify anything; just copy and
+# After this point, you don't need to modify anything.  Just copy and
 # paste the commands below.
 
 
@@ -83,6 +76,7 @@ export AR=$NDKROOT/toolchains/mipsel-linux-android-4.8/prebuilt/linux-x86_64/bin
 export LD=$NDKROOT/toolchains/mipsel-linux-android-4.8/prebuilt/linux-x86_64/bin/mipsel-linux-android-ld
 export CC=$NDKROOT/toolchains/mipsel-linux-android-4.8/prebuilt/linux-x86_64/bin/mipsel-linux-android-gcc
 
+
 # Do configuration stuff.  Don't mess with the --prefix in the
 # configure command below, even if you think it's wrong.
 # You may need to set the --with-tmpdir path to something
@@ -94,7 +88,7 @@ export CC=$NDKROOT/toolchains/mipsel-linux-android-4.8/prebuilt/linux-x86_64/bin
 ./autogen.sh
 
 # for ARM
-CPPFLAGS="--sysroot=$NDKROOT/platforms/android-3/arch-arm -DANDROID_HARDWARE_$HWKIND" \
+CPPFLAGS="--sysroot=$NDKROOT/platforms/android-3/arch-arm" \
    CFLAGS="--sysroot=$NDKROOT/platforms/android-3/arch-arm" \
    ./configure --prefix=/data/local/Inst \
    --host=armv7-unknown-linux --target=armv7-unknown-linux \
@@ -103,19 +97,20 @@ CPPFLAGS="--sysroot=$NDKROOT/platforms/android-3/arch-arm -DANDROID_HARDWARE_$HW
 # It is not clear what this platform nr really is.
 
 # for x86
-CPPFLAGS="--sysroot=$NDKROOT/platforms/android-9/arch-x86 -DANDROID_HARDWARE_$HWKIND" \
+CPPFLAGS="--sysroot=$NDKROOT/platforms/android-9/arch-x86" \
    CFLAGS="--sysroot=$NDKROOT/platforms/android-9/arch-x86 -fno-pic" \
    ./configure --prefix=/data/local/Inst \
    --host=i686-android-linux --target=i686-android-linux \
    --with-tmpdir=/sdcard
 
 # for MIPS32
-CPPFLAGS="--sysroot=$NDKROOT/platforms/android-18/arch-mips -DANDROID_HARDWARE_$HWKIND" \
+CPPFLAGS="--sysroot=$NDKROOT/platforms/android-18/arch-mips" \
    CFLAGS="--sysroot=$NDKROOT/platforms/android-18/arch-mips" \
    ./configure --prefix=/data/local/Inst \
    --host=mipsel-linux-android --target=mipsel-linux-android \
    --with-tmpdir=/sdcard
 
+
 # At the end of the configure run, a few lines of details
 # are printed.  Make sure that you see these two lines:
 #
@@ -148,8 +143,26 @@ make -j2 install DESTDIR=`pwd`/Inst
 #
 adb push Inst /
 
-# To run (on the device)
-/data/local/Inst/bin/valgrind [the usual args etc]
+
+# To run (on the device).  There are two things you need to consider:
+#
+# (1) if you are running on the Android emulator, Valgrind may crash
+#     at startup.  This is because the emulator (for ARM) may not be
+#     simulating a hardware TLS register.  To get around this, run
+#     Valgrind with:
+#       --kernel-variant=android-emulator-no-hw-tls
+# 
+# (2) if you are running a real device, you need to tell Valgrind
+#     what GPU it has, so Valgrind knows how to handle custom GPU
+#     ioctls.  You can choose one of the following:
+#       --kernel-variant=android-gpu-sgx5xx     # PowerVR SGX 5XX series
+#       --kernel-variant=android-gpu-adreno3xx  # Qualcomm Adreno 3XX series
+#     If you don't choose one, the program will still run, but Memcheck
+#     may report false errors after the program performs GPU-specific ioctls.
+#
+# Anyway: to run on the device:
+#
+/data/local/Inst/bin/valgrind [kernel variant args] [the usual args etc]
 
 
 # Once you're up and running, a handy modify-V-rebuild-reinstall

README.android_emulator

@@ -61,6 +61,14 @@ adb shell
 adb push Inst /
 
 
+# IMPORTANT: when running Valgrind, you may need give it the flag
+#
+#    --kernel-variant=android-emulator-no-hw-tls
+#
+# since otherwise it may crash at startup.
+# See README.android for details.
+
+
 # if you need to debug:
 # You have on the android side a gdbserver
 # on the device side:

coregrind/m_main.c

@@ -179,9 +179,11 @@ static void usage_NORETURN ( Bool debug_help )
 "         where hint is one of lax-ioctls fuse-compatible enable-outer\n"
 "           no-inner-prefix no-nptl-pthread-stackcache none\n"
 "    --fair-sched=no|yes|try   schedule threads fairly on multicore systems [no]\n"
-"    --kernel-variant=variant1,variant2,...  handle non-standard kernel"
-                                                               " variants [none]\n"
-"         where variant is one of bproc none\n"
+"    --kernel-variant=variant1,variant2,...\n"
+"         handle non-standard kernel variants [none]\n"
+"         where variant is one of:\n"
+"           bproc android-emulator-no-hw-tls\n"
+"           android-gpu-sgx5xx android-gpu-adreno3xx none\n"
 "    --merge-recursive-frames=<number>  merge frames between identical\n"
 "           program counters in max <number> frames) [0]\n"
 "    --num-transtab-sectors=<number> size of translated code cache [%d]\n"
@@ -627,7 +629,11 @@ void main_process_cmd_line_options ( /*OUT*/Bool* logging_to_fd,
                                                     VG_(clo_smc_check),
                                                     Vg_SmcAllNonFile);
 
-      else if VG_USETX_CLO (arg, "--kernel-variant", "bproc",
+      else if VG_USETX_CLO (arg, "--kernel-variant",
+                            "bproc,"
+                            "android-emulator-no-hw-tls,"
+                            "android-gpu-sgx5xx,"
+                            "android-gpu-adreno3xx",
                             VG_(clo_kernel_variant)) {}
 
       else if VG_BOOL_CLO(arg, "--dsymutil",        VG_(clo_dsymutil)) {}

coregrind/m_syswrap/syswrap-arm-linux.c

@@ -280,41 +280,43 @@ static void assign_guest_tls(ThreadId tid, Addr tlsptr)
 static SysRes sys_set_tls ( ThreadId tid, Addr tlsptr )
 {
    assign_guest_tls(tid, tlsptr);
-#if defined(ANDROID_HARDWARE_emulator)
-   /* Android emulator does not provide an hw tls register.
-      So, the tls register is emulated by the kernel.
-      This emulated value is set by the __NR_ARM_set_tls syscall.
-      The emulated value must be read by the kernel helper function
-      located at 0xffff0fe0.
+
+   if (KernelVariantiS(KernelVariant_android_emulator_no_hw_tls,
+                       VG_(clo_kernel_variant))) {
+      /* Android emulator does not provide an hw tls register.
+         So, the tls register is emulated by the kernel.
+         This emulated value is set by the __NR_ARM_set_tls syscall.
+         The emulated value must be read by the kernel helper function
+         located at 0xffff0fe0.
       
-      The emulated tlsptr is located at 0xffff0ff0
-      (so slightly after the kernel helper function).
-      Note that applications are not supposed to read this directly.
+         The emulated tlsptr is located at 0xffff0ff0
+         (so slightly after the kernel helper function).
+         Note that applications are not supposed to read this directly.
       
-      For compatibility : if there is a hw tls register, the kernel
-      will put at 0xffff0fe0 the instructions to read it, so
-      as to have old applications calling the kernel helper
-      working properly.
-
-      For having emulated guest TLS working correctly with
-      Valgrind, it is needed to execute the syscall to set
-      the emulated TLS value in addition to the assignment
-      of TPIDRURO.
-
-      Note: the below means that if we need thread local storage
-      for Valgrind host, then there will be a conflict between
-      the need of the guest tls and of the host tls.
-      If all the guest code would cleanly call 0xffff0fe0,
-      then we might maybe intercept this. However, at least
-      __libc_preinit reads directly 0xffff0ff0.
-   */
-   /* ??? might call the below if auxv->u.a_val & VKI_HWCAP_TLS ???
-      Unclear if real hardware having tls hw register sets
-      VKI_HWCAP_TLS. */
-   return VG_(do_syscall1) (__NR_ARM_set_tls, tlsptr);
-#else
-   return VG_(mk_SysRes_Success)( 0 );
-#endif
+         For compatibility : if there is a hw tls register, the kernel
+         will put at 0xffff0fe0 the instructions to read it, so
+         as to have old applications calling the kernel helper
+         working properly.
+
+         For having emulated guest TLS working correctly with
+         Valgrind, it is needed to execute the syscall to set
+         the emulated TLS value in addition to the assignment
+         of TPIDRURO.
+
+         Note: the below means that if we need thread local storage
+         for Valgrind host, then there will be a conflict between
+         the need of the guest tls and of the host tls.
+         If all the guest code would cleanly call 0xffff0fe0,
+         then we might maybe intercept this. However, at least
+         __libc_preinit reads directly 0xffff0ff0.
+      */
+      /* ??? might call the below if auxv->u.a_val & VKI_HWCAP_TLS ???
+         Unclear if real hardware having tls hw register sets
+         VKI_HWCAP_TLS. */
+      return VG_(do_syscall1) (__NR_ARM_set_tls, tlsptr);
+   } else {
+      return VG_(mk_SysRes_Success)( 0 );
+   }
 }
 
 /* ---------------------------------------------------------------------