Link stack frames of JNI stubs to JNI callbacks.

base/android/jni_android.h

 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #ifndef BASE_ANDROID_JNI_ANDROID_H_
 #define BASE_ANDROID_JNI_ANDROID_H_
 
 #include <jni.h>
 #include <sys/types.h>
 
 #include <string>
 
 #include "base/android/scoped_java_ref.h"
 #include "base/atomicops.h"
 #include "base/base_export.h"
 #include "base/compiler_specific.h"
+#include "base/debug/stack_trace.h"
+#include "base/macros.h"
+
+#if HAVE_TRACE_STACK_FRAME_POINTERS
+
+// When profiling is enabled (enable_profiling=true) this macro is added to
+// all generated JNI stubs so that it becomes the last thing that runs before
+// control goes into Java.
+//
+// This macro saves stack frame pointer of the current function. Saved value
+// used later by JNI_PROFILING_ENTERED_NATIVE.
+#define JNI_PROFILING_LEAVING_NATIVE \

[Primiano Tucci (use gerrit), 2016/10/13 20:03:21]

I'd just call these JNI_SAVE_FRAME_POINTER and JNI_LINK_SAVED_FRAME_POINTER to
remove this naming-layer-hopping you force readers to go to.
Concretely, right now when I look at the JNI generator and I see LEAVING_NATIVE
I have to remember that this is  the place where you save and the other is where
you restore.
In few words: don't generalize concepts unless you really need to. Direct names
are way easier to follow.

[Dmitry Skiba, 2016/10/17 22:09:11]

Done.

+  base::android::JNIStackFrameSaver jni_frame_saver( \
+      __builtin_frame_address(0))
+
+// When profiling is enabled (enable_profiling=true) this macro is added to
+// all generated JNI callbacks so that it becomes the first thing that runs
+// after control returns from Java.
+//
+// This macro links stack frame of the current function to the stack frame
+// saved by JNI_PROFILING_LEAVING_NATIVE, allowing frame-based unwinding
+// (used by the heap profiler) to produce complete traces.
+#define JNI_PROFILING_ENTERED_NATIVE \
+  base::debug::ScopedStackFrameLinker jni_frame_linker( \
+      __builtin_frame_address(0), \
+      base::android::JNIStackFrameSaver::SavedFrame())
+
+
+#else
+
+// Frame-based stack unwinding is not supported, do nothing.
+#define JNI_PROFILING_LEAVING_NATIVE
+#define JNI_PROFILING_ENTERED_NATIVE
+
+#endif  // HAVE_TRACE_STACK_FRAME_POINTERS
 
 namespace base {
 namespace android {
 
 // Used to mark symbols to be exported in a shared library's symbol table.
 #define JNI_EXPORT __attribute__ ((visibility("default")))
 
 // Used to disable manual JNI registration in binaries that prefer to use native
 // JNI exports for startup performance. This is not compatible with the crazy
 // linker and so defaults to off. Call DisableManualJniRegistration at the very
@@ skipping 88 matching lines @@
 // and returns true.
 BASE_EXPORT bool ClearException(JNIEnv* env);
 
 // This function will call CHECK() macro if there's any pending exception.
 BASE_EXPORT void CheckException(JNIEnv* env);
 
 // This returns a string representation of the java stack trace.
 BASE_EXPORT std::string GetJavaExceptionInfo(JNIEnv* env,
                                              jthrowable java_throwable);
 
+#if HAVE_TRACE_STACK_FRAME_POINTERS
+
+// Saves caller's PC and stack frame in a thread-local variable.
+// Implemented only when profiling is enabled (enable_profiling=true).
+class BASE_EXPORT JNIStackFrameSaver {
+ public:
+  JNIStackFrameSaver(void* current_fp);
+  ~JNIStackFrameSaver();
+  static void* SavedFrame();

[Primiano Tucci (use gerrit), 2016/10/13 20:03:21]

s/SavedFrame/GetLastFrameSavedForCurrentThread()/

[Dmitry Skiba, 2016/10/17 22:09:11]

This feels unnecessarily long. I think we should either rename the class to
something like ScopedJNIPerThreadStackFrameSaver and leave SavedFrame() as is,
or just leave all those details to the class comment, as they are now.

+ private:

[Primiano Tucci (use gerrit), 2016/10/13 20:03:21]

micro-nit: add \n after private:

[Dmitry Skiba, 2016/10/17 22:09:11]

Done.

+  void* previous_fp_;
+  DISALLOW_COPY_AND_ASSIGN(JNIStackFrameSaver);

[Primiano Tucci (use gerrit), 2016/10/13 20:03:21]

micro-nit: add extra \n before DISALLOW

[Dmitry Skiba, 2016/10/17 22:09:11]

Done.

+};
+
+#endif  // HAVE_TRACE_STACK_FRAME_POINTERS
+
 }  // namespace android
 }  // namespace base
 
 #endif  // BASE_ANDROID_JNI_ANDROID_H_