July 19th, 2011 | Published in Google Android
[This post is by Elliott Hughes, a Software Engineer on the Dalvik team — Tim Bray]
Although most Android apps run entirely on top of Dalvik, some use the Android NDK to include native code using JNI. Native code is harder to get right than Dalvik code, and when you have a bug, it’s often a lot harder to find and fix it. Using JNI is inherently tricky (there’s precious little help from the type system, for example), and JNI functions provide almost no run-time checking. Bear in mind also that the developer console’s crash reporting doesn’t include native crashes, so you don’t even necessarily know how often your native code is crashing.
What CheckJNI can do
To help, there’s CheckJNI. It can catch a number of common errors, and the list is continually increasing. In Gingerbread, for example, CheckJNI can catch all of the following kinds of error:
Arrays: attempting to allocate a negative-sized array.
Bad pointers: passing a bad jarray/jclass/jobject/jstring to a JNI call, or passing a NULL pointer to a JNI call with a non-nullable argument.
Class names: passing anything but the “java/lang/String” style of class name to a JNI call.
Critical calls: making a JNI call between a GetCritical and the corresponding ReleaseCritical.
Direct ByteBuffers: passing bad arguments to NewDirectByteBuffer.
Exceptions: making a JNI call while there’s an exception pending.
JNIEnv*s: using a JNIEnv* from the wrong thread.
jfieldIDs: using a NULL jfieldID, or using a jfieldID to set a field to a value of the wrong type (trying to assign a StringBuilder to a String field, say), or using a jfieldID for a static field to set an instance field or vice versa, or using a jfieldID from one class with instances of another class.
jmethodIDs: using the wrong kind of jmethodID when making a Call*Method JNI call: incorrect return type, static/non-static mismatch, wrong type for ‘this’ (for non-static calls) or wrong class (for static calls).
References: using DeleteGlobalRef/DeleteLocalRef on the wrong kind of reference.
Release modes: passing a bad release mode to a release call (something other than 0, JNI_ABORT, or JNI_COMMIT).
Type safety: returning an incompatible type from your native method (returning a StringBuilder from a method declared to return a String, say).
UTF-8: passing an invalid Modified UTF-8 byte sequence to a JNI call.
If you’ve written any amount of native code without CheckJNI, you’re probably already wishing you’d known about it. There’s a performance cost to using CheckJNI (which is why it isn’t on all the time for everybody), but it shouldn’t change the behavior in any other way.
If you’re using the emulator, CheckJNI is on by default. If you’re working with an Android device, use the following adb command:
adb shell setprop debug.checkjni 1
This won’t affect already-running apps, but any app launched from that point on will have CheckJNI enabled. (Changing the property to any other value or simply rebooting will disable CheckJNI again.) In this case, you’ll see something like this in your logcat output the next time each app starts:
D Late-enabling CheckJNI
If you don’t see this, your app was probably already running; you just need to force stop it and start it again.
Here’s the output you get if you return a byte array from a native method declared to return a String:
W JNI WARNING: method declared to return 'Ljava/lang/String;' returned '[B' W failed in LJniTest;.exampleJniBug I "main" prio=5 tid=1 RUNNABLE I | group="main" sCount=0 dsCount=0 obj=0x40246f60 self=0x10538 I | sysTid=15295 nice=0 sched=0/0 cgrp=default handle=-2145061784 I | schedstat=( 398335000 1493000 253 ) utm=25 stm=14 core=0 I at JniTest.exampleJniBug(Native Method) I at JniTest.main(JniTest.java:11) I at dalvik.system.NativeStart.main(Native Method) I E VM aborting
Without CheckJNI, you’d just die via SIGSEGV, with none of this output to help you!
New JNI documentation
We’ve also recently added a page of JNI Tips that explains some of the finer points of JNI. If you write native methods, even if CheckJNI isn’t rejecting your code, you should still read that page. It covers everything from correct usage of the JavaVM and JNIEnv types, how to work with native threads, local and global references, dealing with Java exceptions in native code, and much more, including answers to frequently-asked JNI questions.
What CheckJNI can’t do
There are still classes of error that CheckJNI can’t find. Most important amongst these are misuses of local references. CheckJNI can spot if you stash a JNIEnv* somewhere and then reuse it on the wrong thread, but it can’t detect you stashing a local reference (rather than a global reference) and then reusing it in a later native method call. Doing so is invalid, but currently mostly works (at the cost of making life hard for the GC), and we’re still working on getting CheckJNI to spot these mistakes.
We’re hoping to have more checking, including for local reference misuse, in a future release of Android. Start using CheckJNI now, though, and you’ll be able to take advantage of our new checks as they’re added.