1 /* Copyright (C) 2016 The Android Open Source Project
2  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
3  *
4  * This file implements interfaces from the file jvmti.h. This implementation
5  * is licensed under the same terms as the file jvmti.h.  The
6  * copyright and license information for the file jvmti.h follows.
7  *
8  * Copyright (c) 2003, 2011, Oracle and/or its affiliates. All rights reserved.
9  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
10  *
11  * This code is free software; you can redistribute it and/or modify it
12  * under the terms of the GNU General Public License version 2 only, as
13  * published by the Free Software Foundation.  Oracle designates this
14  * particular file as subject to the "Classpath" exception as provided
15  * by Oracle in the LICENSE file that accompanied this code.
16  *
17  * This code is distributed in the hope that it will be useful, but WITHOUT
18  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
19  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
20  * version 2 for more details (a copy is included in the LICENSE file that
21  * accompanied this code).
22  *
23  * You should have received a copy of the GNU General Public License version
24  * 2 along with this work; if not, write to the Free Software Foundation,
25  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
26  *
27  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
28  * or visit www.oracle.com if you need additional information or have any
29  * questions.
30  */
31 
32 #ifndef ART_OPENJDKJVMTI_TI_STACK_H_
33 #define ART_OPENJDKJVMTI_TI_STACK_H_
34 
35 #include "jni.h"
36 #include "jvmti.h"
37 
38 #include "art_method.h"
39 #include "base/mutex.h"
40 #include "events.h"
41 #include "stack.h"
42 
43 namespace openjdkjvmti {
44 
45 class StackUtil {
46  public:
47   static jvmtiError GetAllStackTraces(jvmtiEnv* env,
48                                       jint max_frame_count,
49                                       jvmtiStackInfo** stack_info_ptr,
50                                       jint* thread_count_ptr)
51       REQUIRES(!art::Locks::thread_list_lock_);
52 
53   static jvmtiError GetFrameCount(jvmtiEnv* env, jthread thread, jint* count_ptr);
54 
55   static jvmtiError GetFrameLocation(jvmtiEnv* env,
56                                      jthread thread,
57                                      jint depth,
58                                      jmethodID* method_ptr,
59                                      jlocation* location_ptr);
60 
61   static jvmtiError GetStackTrace(jvmtiEnv* env,
62                                   jthread thread,
63                                   jint start_depth,
64                                   jint max_frame_count,
65                                   jvmtiFrameInfo* frame_buffer,
66                                   jint* count_ptr);
67 
68   static jvmtiError GetThreadListStackTraces(jvmtiEnv* env,
69                                              jint thread_count,
70                                              const jthread* thread_list,
71                                              jint max_frame_count,
72                                              jvmtiStackInfo** stack_info_ptr);
73 
74   static jvmtiError GetOwnedMonitorStackDepthInfo(jvmtiEnv* env,
75                                                   jthread thread,
76                                                   jint* info_cnt_ptr,
77                                                   jvmtiMonitorStackDepthInfo** info_ptr);
78 
79   static jvmtiError GetOwnedMonitorInfo(jvmtiEnv* env,
80                                         jthread thread,
81                                         jint* owned_monitor_count_ptr,
82                                         jobject** owned_monitors_ptr);
83 
84   static jvmtiError NotifyFramePop(jvmtiEnv* env, jthread thread, jint depth);
85 
86   static jvmtiError PopFrame(jvmtiEnv* env, jthread thread);
87 
88   template <typename T>
89   static jvmtiError ForceEarlyReturn(
90       jvmtiEnv* env, EventHandler* event_handler, jthread thread, T value);
91 };
92 
93 struct FindFrameAtDepthVisitor : art::StackVisitor {
94  public:
FindFrameAtDepthVisitorFindFrameAtDepthVisitor95   FindFrameAtDepthVisitor(art::Thread* target, art::Context* ctx, jint depth)
96       REQUIRES_SHARED(art::Locks::mutator_lock_)
97       : art::StackVisitor(target, ctx, art::StackVisitor::StackWalkKind::kIncludeInlinedFrames),
98         found_frame_(false),
99         cnt_(0),
100         depth_(static_cast<size_t>(depth)) { }
101 
FoundFrameFindFrameAtDepthVisitor102   bool FoundFrame() {
103     return found_frame_;
104   }
105 
VisitFrameFindFrameAtDepthVisitor106   bool VisitFrame() NO_THREAD_SAFETY_ANALYSIS {
107     if (GetMethod()->IsRuntimeMethod()) {
108       return true;
109     }
110     if (cnt_ == depth_) {
111       // We found our frame, exit.
112       found_frame_ = true;
113       return false;
114     } else {
115       cnt_++;
116       return true;
117     }
118   }
119 
120   art::ShadowFrame* GetOrCreateShadowFrame(/*out*/bool* created_frame)
121       REQUIRES_SHARED(art::Locks::mutator_lock_);
122 
123  private:
124   bool found_frame_;
125   size_t cnt_;
126   size_t depth_;
127 };
128 
129 }  // namespace openjdkjvmti
130 
131 #endif  // ART_OPENJDKJVMTI_TI_STACK_H_
132