blob: 06b67b3e4db34d7e7d15aa2846eb162987d2b5a0 [file] [log] [blame]
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001/*
2 * Copyright (C) 2008 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
Elliott Hughes872d4ec2011-10-21 17:07:15 -070016
Elliott Hughes07ed66b2012-12-12 18:34:25 -080017#include "jdwp/jdwp_event.h"
18
19#include <stddef.h> /* for offsetof() */
Elliott Hughes872d4ec2011-10-21 17:07:15 -070020#include <stdlib.h>
21#include <string.h>
Elliott Hughes872d4ec2011-10-21 17:07:15 -070022#include <unistd.h>
23
Mathieu Chartierc7853442015-03-27 14:35:38 -070024#include "art_field-inl.h"
Mathieu Chartiere401d142015-04-22 13:56:20 -070025#include "art_method-inl.h"
Elliott Hughes07ed66b2012-12-12 18:34:25 -080026#include "base/logging.h"
Elliott Hughese222ee02012-12-13 14:41:43 -080027#include "base/stringprintf.h"
Elliott Hughes07ed66b2012-12-12 18:34:25 -080028#include "debugger.h"
29#include "jdwp/jdwp_constants.h"
30#include "jdwp/jdwp_expand_buf.h"
Elliott Hughes07ed66b2012-12-12 18:34:25 -080031#include "jdwp/jdwp_priv.h"
Sebastien Hertz6995c602014-09-09 12:10:13 +020032#include "jdwp/object_registry.h"
Sebastien Hertz6995c602014-09-09 12:10:13 +020033#include "scoped_thread_state_change.h"
Ian Rogers693ff612013-02-01 10:56:12 -080034#include "thread-inl.h"
Elliott Hughes07ed66b2012-12-12 18:34:25 -080035
Sebastien Hertz261bc042015-04-08 09:36:07 +020036#include "handle_scope-inl.h"
37
Elliott Hughes872d4ec2011-10-21 17:07:15 -070038/*
39General notes:
40
41The event add/remove stuff usually happens from the debugger thread,
42in response to requests from the debugger, but can also happen as the
43result of an event in an arbitrary thread (e.g. an event with a "count"
44mod expires). It's important to keep the event list locked when processing
45events.
46
47Event posting can happen from any thread. The JDWP thread will not usually
48post anything but VM start/death, but if a JDWP request causes a class
49to be loaded, the ClassPrepare event will come from the JDWP thread.
50
51
52We can have serialization issues when we post an event to the debugger.
53For example, a thread could send an "I hit a breakpoint and am suspending
54myself" message to the debugger. Before it manages to suspend itself, the
55debugger's response ("not interested, resume thread") arrives and is
56processed. We try to resume a thread that hasn't yet suspended.
57
58This means that, after posting an event to the debugger, we need to wait
59for the event thread to suspend itself (and, potentially, all other threads)
60before processing any additional requests from the debugger. While doing
61so we need to be aware that multiple threads may be hitting breakpoints
62or other events simultaneously, so we either need to wait for all of them
63or serialize the events with each other.
64
65The current mechanism works like this:
66 Event thread:
67 - If I'm going to suspend, grab the "I am posting an event" token. Wait
68 for it if it's not currently available.
69 - Post the event to the debugger.
70 - If appropriate, suspend others and then myself. As part of suspending
71 myself, release the "I am posting" token.
72 JDWP thread:
73 - When an event arrives, see if somebody is posting an event. If so,
74 sleep until we can acquire the "I am posting an event" token. Release
75 it immediately and continue processing -- the event we have already
76 received should not interfere with other events that haven't yet
77 been posted.
78
79Some care must be taken to avoid deadlock:
80
81 - thread A and thread B exit near-simultaneously, and post thread-death
82 events with a "suspend all" clause
83 - thread A gets the event token, thread B sits and waits for it
84 - thread A wants to suspend all other threads, but thread B is waiting
85 for the token and can't be suspended
86
87So we need to mark thread B in such a way that thread A doesn't wait for it.
88
89If we just bracket the "grab event token" call with a change to VMWAIT
90before sleeping, the switch back to RUNNING state when we get the token
91will cause thread B to suspend (remember, thread A's global suspend is
92still in force, even after it releases the token). Suspending while
93holding the event token is very bad, because it prevents the JDWP thread
94from processing incoming messages.
95
96We need to change to VMWAIT state at the *start* of posting an event,
97and stay there until we either finish posting the event or decide to
98put ourselves to sleep. That way we don't interfere with anyone else and
99don't allow anyone else to interfere with us.
100*/
101
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700102namespace art {
103
104namespace JDWP {
105
106/*
107 * Stuff to compare against when deciding if a mod matches. Only the
108 * values for mods valid for the event being evaluated will be filled in.
109 * The rest will be zeroed.
Sebastien Hertz261bc042015-04-08 09:36:07 +0200110 * Must be allocated on the stack only. This is enforced by removing the
111 * operator new.
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700112 */
113struct ModBasket {
Sebastien Hertz261bc042015-04-08 09:36:07 +0200114 explicit ModBasket(Thread* self)
115 : hs(self), pLoc(nullptr), thread(self),
116 locationClass(hs.NewHandle<mirror::Class>(nullptr)),
117 exceptionClass(hs.NewHandle<mirror::Class>(nullptr)),
118 caught(false),
119 field(nullptr),
120 thisPtr(hs.NewHandle<mirror::Object>(nullptr)) { }
jeffhao162fd332013-01-08 16:21:01 -0800121
Sebastien Hertz261bc042015-04-08 09:36:07 +0200122 StackHandleScope<3> hs;
123 const EventLocation* pLoc; /* LocationOnly */
124 std::string className; /* ClassMatch/ClassExclude */
125 Thread* const thread; /* ThreadOnly */
126 MutableHandle<mirror::Class> locationClass; /* ClassOnly */
127 MutableHandle<mirror::Class> exceptionClass; /* ExceptionOnly */
128 bool caught; /* ExceptionOnly */
129 ArtField* field; /* FieldOnly */
130 MutableHandle<mirror::Object> thisPtr; /* InstanceOnly */
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700131 /* nothing for StepOnly -- handled differently */
Sebastien Hertz261bc042015-04-08 09:36:07 +0200132
133 private:
134 DISALLOW_ALLOCATION(); // forbids allocation on the heap.
135 DISALLOW_IMPLICIT_CONSTRUCTORS(ModBasket);
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700136};
137
Sebastien Hertz138dbfc2013-12-04 18:15:25 +0100138static bool NeedsFullDeoptimization(JdwpEventKind eventKind) {
Sebastien Hertzf3928792014-11-17 19:00:37 +0100139 if (!Dbg::RequiresDeoptimization()) {
140 // We don't need deoptimization for debugging.
141 return false;
142 }
Sebastien Hertz138dbfc2013-12-04 18:15:25 +0100143 switch (eventKind) {
144 case EK_METHOD_ENTRY:
145 case EK_METHOD_EXIT:
146 case EK_METHOD_EXIT_WITH_RETURN_VALUE:
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +0200147 case EK_FIELD_ACCESS:
148 case EK_FIELD_MODIFICATION:
Sebastien Hertz138dbfc2013-12-04 18:15:25 +0100149 return true;
150 default:
151 return false;
152 }
153}
154
Sebastien Hertz9d6bf692015-04-10 12:12:33 +0200155// Returns the instrumentation event the DebugInstrumentationListener must
156// listen to in order to properly report the given JDWP event to the debugger.
Andreas Gampe277ccbd2014-11-03 21:36:10 -0800157static uint32_t GetInstrumentationEventFor(JdwpEventKind eventKind) {
Sebastien Hertz42cd43f2014-05-13 14:15:41 +0200158 switch (eventKind) {
159 case EK_BREAKPOINT:
160 case EK_SINGLE_STEP:
161 return instrumentation::Instrumentation::kDexPcMoved;
162 case EK_EXCEPTION:
163 case EK_EXCEPTION_CATCH:
164 return instrumentation::Instrumentation::kExceptionCaught;
165 case EK_METHOD_ENTRY:
166 return instrumentation::Instrumentation::kMethodEntered;
167 case EK_METHOD_EXIT:
168 case EK_METHOD_EXIT_WITH_RETURN_VALUE:
169 return instrumentation::Instrumentation::kMethodExited;
170 case EK_FIELD_ACCESS:
171 return instrumentation::Instrumentation::kFieldRead;
172 case EK_FIELD_MODIFICATION:
173 return instrumentation::Instrumentation::kFieldWritten;
174 default:
175 return 0;
176 }
177}
178
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700179/*
180 * Add an event to the list. Ordering is not important.
181 *
182 * If something prevents the event from being registered, e.g. it's a
183 * single-step request on a thread that doesn't exist, the event will
184 * not be added to the list, and an appropriate error will be returned.
185 */
Elliott Hughes761928d2011-11-16 18:33:03 -0800186JdwpError JdwpState::RegisterEvent(JdwpEvent* pEvent) {
Sebastien Hertz7d955652014-10-22 10:57:10 +0200187 CHECK(pEvent != nullptr);
188 CHECK(pEvent->prev == nullptr);
189 CHECK(pEvent->next == nullptr);
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700190
Sebastien Hertz42cd43f2014-05-13 14:15:41 +0200191 {
192 /*
193 * If one or more "break"-type mods are used, register them with
194 * the interpreter.
195 */
196 DeoptimizationRequest req;
197 for (int i = 0; i < pEvent->modCount; i++) {
198 const JdwpEventMod* pMod = &pEvent->mods[i];
199 if (pMod->modKind == MK_LOCATION_ONLY) {
Sebastien Hertz033aabf2014-10-08 13:54:55 +0200200 // Should only concern breakpoint, field access, field modification, step, and exception
201 // events.
202 // However breakpoint requires specific handling. Field access, field modification and step
203 // events need full deoptimization to be reported while exception event is reported during
204 // exception handling.
205 if (pEvent->eventKind == EK_BREAKPOINT) {
206 Dbg::WatchLocation(&pMod->locationOnly.loc, &req);
207 }
Sebastien Hertz42cd43f2014-05-13 14:15:41 +0200208 } else if (pMod->modKind == MK_STEP) {
209 /* should only be for EK_SINGLE_STEP; should only be one */
210 JdwpStepSize size = static_cast<JdwpStepSize>(pMod->step.size);
211 JdwpStepDepth depth = static_cast<JdwpStepDepth>(pMod->step.depth);
212 JdwpError status = Dbg::ConfigureStep(pMod->step.threadId, size, depth);
213 if (status != ERR_NONE) {
214 return status;
215 }
Elliott Hughes2435a572012-02-17 16:07:41 -0800216 }
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700217 }
Sebastien Hertz42cd43f2014-05-13 14:15:41 +0200218 if (NeedsFullDeoptimization(pEvent->eventKind)) {
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -0700219 CHECK_EQ(req.GetKind(), DeoptimizationRequest::kNothing);
220 CHECK(req.Method() == nullptr);
221 req.SetKind(DeoptimizationRequest::kFullDeoptimization);
Sebastien Hertz42cd43f2014-05-13 14:15:41 +0200222 }
223 Dbg::RequestDeoptimization(req);
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700224 }
Sebastien Hertz42cd43f2014-05-13 14:15:41 +0200225 uint32_t instrumentation_event = GetInstrumentationEventFor(pEvent->eventKind);
226 if (instrumentation_event != 0) {
227 DeoptimizationRequest req;
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -0700228 req.SetKind(DeoptimizationRequest::kRegisterForEvent);
229 req.SetInstrumentationEvent(instrumentation_event);
Sebastien Hertz42cd43f2014-05-13 14:15:41 +0200230 Dbg::RequestDeoptimization(req);
Sebastien Hertz4d25df32014-03-21 17:44:46 +0100231 }
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700232
Sebastien Hertz138dbfc2013-12-04 18:15:25 +0100233 {
234 /*
235 * Add to list.
236 */
237 MutexLock mu(Thread::Current(), event_list_lock_);
Sebastien Hertz7d955652014-10-22 10:57:10 +0200238 if (event_list_ != nullptr) {
Sebastien Hertz138dbfc2013-12-04 18:15:25 +0100239 pEvent->next = event_list_;
240 event_list_->prev = pEvent;
241 }
242 event_list_ = pEvent;
243 ++event_list_size_;
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700244 }
Sebastien Hertz138dbfc2013-12-04 18:15:25 +0100245
246 Dbg::ManageDeoptimization();
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700247
248 return ERR_NONE;
249}
250
251/*
252 * Remove an event from the list. This will also remove the event from
253 * any optimization tables, e.g. breakpoints.
254 *
255 * Does not free the JdwpEvent.
256 *
257 * Grab the eventLock before calling here.
258 */
Elliott Hughes761928d2011-11-16 18:33:03 -0800259void JdwpState::UnregisterEvent(JdwpEvent* pEvent) {
Sebastien Hertz7d955652014-10-22 10:57:10 +0200260 if (pEvent->prev == nullptr) {
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700261 /* head of the list */
Elliott Hughesf8349362012-06-18 15:00:06 -0700262 CHECK(event_list_ == pEvent);
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700263
Elliott Hughesf8349362012-06-18 15:00:06 -0700264 event_list_ = pEvent->next;
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700265 } else {
266 pEvent->prev->next = pEvent->next;
267 }
268
Sebastien Hertz7d955652014-10-22 10:57:10 +0200269 if (pEvent->next != nullptr) {
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700270 pEvent->next->prev = pEvent->prev;
Sebastien Hertz7d955652014-10-22 10:57:10 +0200271 pEvent->next = nullptr;
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700272 }
Sebastien Hertz7d955652014-10-22 10:57:10 +0200273 pEvent->prev = nullptr;
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700274
Sebastien Hertz42cd43f2014-05-13 14:15:41 +0200275 {
276 /*
277 * Unhook us from the interpreter, if necessary.
278 */
279 DeoptimizationRequest req;
280 for (int i = 0; i < pEvent->modCount; i++) {
281 JdwpEventMod* pMod = &pEvent->mods[i];
282 if (pMod->modKind == MK_LOCATION_ONLY) {
Sebastien Hertz033aabf2014-10-08 13:54:55 +0200283 // Like in RegisterEvent, we need specific handling for breakpoint only.
284 if (pEvent->eventKind == EK_BREAKPOINT) {
285 Dbg::UnwatchLocation(&pMod->locationOnly.loc, &req);
286 }
Sebastien Hertz42cd43f2014-05-13 14:15:41 +0200287 }
288 if (pMod->modKind == MK_STEP) {
289 /* should only be for EK_SINGLE_STEP; should only be one */
290 Dbg::UnconfigureStep(pMod->step.threadId);
291 }
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700292 }
Daniel Mihalyieb076692014-08-22 17:33:31 +0200293 if (NeedsFullDeoptimization(pEvent->eventKind)) {
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -0700294 CHECK_EQ(req.GetKind(), DeoptimizationRequest::kNothing);
295 CHECK(req.Method() == nullptr);
296 req.SetKind(DeoptimizationRequest::kFullUndeoptimization);
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700297 }
Sebastien Hertz42cd43f2014-05-13 14:15:41 +0200298 Dbg::RequestDeoptimization(req);
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700299 }
Sebastien Hertz42cd43f2014-05-13 14:15:41 +0200300 uint32_t instrumentation_event = GetInstrumentationEventFor(pEvent->eventKind);
301 if (instrumentation_event != 0) {
302 DeoptimizationRequest req;
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -0700303 req.SetKind(DeoptimizationRequest::kUnregisterForEvent);
304 req.SetInstrumentationEvent(instrumentation_event);
Sebastien Hertz42cd43f2014-05-13 14:15:41 +0200305 Dbg::RequestDeoptimization(req);
Sebastien Hertz4d25df32014-03-21 17:44:46 +0100306 }
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700307
Elliott Hughesf8349362012-06-18 15:00:06 -0700308 --event_list_size_;
Sebastien Hertz7d955652014-10-22 10:57:10 +0200309 CHECK(event_list_size_ != 0 || event_list_ == nullptr);
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700310}
311
312/*
313 * Remove the event with the given ID from the list.
314 *
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700315 */
Elliott Hughes761928d2011-11-16 18:33:03 -0800316void JdwpState::UnregisterEventById(uint32_t requestId) {
Sebastien Hertz138dbfc2013-12-04 18:15:25 +0100317 bool found = false;
318 {
319 MutexLock mu(Thread::Current(), event_list_lock_);
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700320
Sebastien Hertz138dbfc2013-12-04 18:15:25 +0100321 for (JdwpEvent* pEvent = event_list_; pEvent != nullptr; pEvent = pEvent->next) {
322 if (pEvent->requestId == requestId) {
323 found = true;
324 UnregisterEvent(pEvent);
325 EventFree(pEvent);
326 break; /* there can be only one with a given ID */
327 }
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700328 }
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700329 }
330
Sebastien Hertz138dbfc2013-12-04 18:15:25 +0100331 if (found) {
332 Dbg::ManageDeoptimization();
333 } else {
Sebastien Hertzf272af42014-09-18 10:20:42 +0200334 // Failure to find the event isn't really an error. For instance, it looks like Eclipse will
335 // try to be extra careful and will explicitly remove one-off single-step events (using a
336 // 'count' event modifier of 1). So the event may have already been removed as part of the
337 // event notification (see JdwpState::CleanupMatchList).
338 VLOG(jdwp) << StringPrintf("No match when removing event reqId=0x%04x", requestId);
Sebastien Hertz138dbfc2013-12-04 18:15:25 +0100339 }
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700340}
341
342/*
343 * Remove all entries from the event list.
344 */
Elliott Hughes761928d2011-11-16 18:33:03 -0800345void JdwpState::UnregisterAll() {
Ian Rogers50b35e22012-10-04 10:09:15 -0700346 MutexLock mu(Thread::Current(), event_list_lock_);
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700347
Elliott Hughesf8349362012-06-18 15:00:06 -0700348 JdwpEvent* pEvent = event_list_;
Sebastien Hertz7d955652014-10-22 10:57:10 +0200349 while (pEvent != nullptr) {
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700350 JdwpEvent* pNextEvent = pEvent->next;
351
Elliott Hughes761928d2011-11-16 18:33:03 -0800352 UnregisterEvent(pEvent);
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700353 EventFree(pEvent);
354 pEvent = pNextEvent;
355 }
356
Sebastien Hertz7d955652014-10-22 10:57:10 +0200357 event_list_ = nullptr;
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700358}
359
360/*
361 * Allocate a JdwpEvent struct with enough space to hold the specified
362 * number of mod records.
363 */
364JdwpEvent* EventAlloc(int numMods) {
365 JdwpEvent* newEvent;
366 int allocSize = offsetof(JdwpEvent, mods) + numMods * sizeof(newEvent->mods[0]);
367 newEvent = reinterpret_cast<JdwpEvent*>(malloc(allocSize));
368 memset(newEvent, 0, allocSize);
369 return newEvent;
370}
371
372/*
373 * Free a JdwpEvent.
374 *
375 * Do not call this until the event has been removed from the list.
376 */
377void EventFree(JdwpEvent* pEvent) {
Sebastien Hertz7d955652014-10-22 10:57:10 +0200378 if (pEvent == nullptr) {
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700379 return;
380 }
381
382 /* make sure it was removed from the list */
Sebastien Hertz7d955652014-10-22 10:57:10 +0200383 CHECK(pEvent->prev == nullptr);
384 CHECK(pEvent->next == nullptr);
Elliott Hughesf8349362012-06-18 15:00:06 -0700385 /* want to check state->event_list_ != pEvent */
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700386
387 /*
388 * Free any hairy bits in the mods.
389 */
390 for (int i = 0; i < pEvent->modCount; i++) {
391 if (pEvent->mods[i].modKind == MK_CLASS_MATCH) {
392 free(pEvent->mods[i].classMatch.classPattern);
Sebastien Hertz7d955652014-10-22 10:57:10 +0200393 pEvent->mods[i].classMatch.classPattern = nullptr;
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700394 }
395 if (pEvent->mods[i].modKind == MK_CLASS_EXCLUDE) {
396 free(pEvent->mods[i].classExclude.classPattern);
Sebastien Hertz7d955652014-10-22 10:57:10 +0200397 pEvent->mods[i].classExclude.classPattern = nullptr;
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700398 }
399 }
400
401 free(pEvent);
402}
403
404/*
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700405 * Run through the list and remove any entries with an expired "count" mod
Sebastien Hertz7d955652014-10-22 10:57:10 +0200406 * from the event list.
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700407 */
Sebastien Hertz7d955652014-10-22 10:57:10 +0200408void JdwpState::CleanupMatchList(const std::vector<JdwpEvent*>& match_list) {
409 for (JdwpEvent* pEvent : match_list) {
410 for (int i = 0; i < pEvent->modCount; ++i) {
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700411 if (pEvent->mods[i].modKind == MK_COUNT && pEvent->mods[i].count.count == 0) {
Sebastien Hertzbca0d3d2014-04-11 16:01:17 +0200412 VLOG(jdwp) << StringPrintf("##### Removing expired event (requestId=%#" PRIx32 ")",
413 pEvent->requestId);
Elliott Hughes761928d2011-11-16 18:33:03 -0800414 UnregisterEvent(pEvent);
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700415 EventFree(pEvent);
416 break;
417 }
418 }
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700419 }
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700420}
421
422/*
423 * Match a string against a "restricted regular expression", which is just
424 * a string that may start or end with '*' (e.g. "*.Foo" or "java.*").
425 *
426 * ("Restricted name globbing" might have been a better term.)
427 */
Elliott Hughes761928d2011-11-16 18:33:03 -0800428static bool PatternMatch(const char* pattern, const std::string& target) {
Elliott Hughesa2155262011-11-16 16:26:58 -0800429 size_t patLen = strlen(pattern);
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700430 if (pattern[0] == '*') {
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700431 patLen--;
Elliott Hughesa2155262011-11-16 16:26:58 -0800432 if (target.size() < patLen) {
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700433 return false;
434 }
Elliott Hughesa2155262011-11-16 16:26:58 -0800435 return strcmp(pattern+1, target.c_str() + (target.size()-patLen)) == 0;
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700436 } else if (pattern[patLen-1] == '*') {
Elliott Hughesa2155262011-11-16 16:26:58 -0800437 return strncmp(pattern, target.c_str(), patLen-1) == 0;
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700438 } else {
Elliott Hughesa2155262011-11-16 16:26:58 -0800439 return strcmp(pattern, target.c_str()) == 0;
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700440 }
441}
442
443/*
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700444 * See if the event's mods match up with the contents of "basket".
445 *
446 * If we find a Count mod before rejecting an event, we decrement it. We
447 * need to do this even if later mods cause us to ignore the event.
448 */
Sebastien Hertzbca0d3d2014-04-11 16:01:17 +0200449static bool ModsMatch(JdwpEvent* pEvent, const ModBasket& basket)
Mathieu Chartier90443472015-07-16 20:32:27 -0700450 SHARED_REQUIRES(Locks::mutator_lock_) {
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700451 JdwpEventMod* pMod = pEvent->mods;
452
453 for (int i = pEvent->modCount; i > 0; i--, pMod++) {
454 switch (pMod->modKind) {
455 case MK_COUNT:
456 CHECK_GT(pMod->count.count, 0);
457 pMod->count.count--;
Sebastien Hertz43207792014-04-15 16:03:27 +0200458 if (pMod->count.count > 0) {
459 return false;
460 }
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700461 break;
462 case MK_CONDITIONAL:
463 CHECK(false); // should not be getting these
464 break;
465 case MK_THREAD_ONLY:
Sebastien Hertz6995c602014-09-09 12:10:13 +0200466 if (!Dbg::MatchThread(pMod->threadOnly.threadId, basket.thread)) {
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700467 return false;
468 }
469 break;
470 case MK_CLASS_ONLY:
Sebastien Hertz261bc042015-04-08 09:36:07 +0200471 if (!Dbg::MatchType(basket.locationClass.Get(), pMod->classOnly.refTypeId)) {
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700472 return false;
473 }
474 break;
475 case MK_CLASS_MATCH:
Sebastien Hertzbca0d3d2014-04-11 16:01:17 +0200476 if (!PatternMatch(pMod->classMatch.classPattern, basket.className)) {
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700477 return false;
478 }
479 break;
480 case MK_CLASS_EXCLUDE:
Sebastien Hertzbca0d3d2014-04-11 16:01:17 +0200481 if (PatternMatch(pMod->classMatch.classPattern, basket.className)) {
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700482 return false;
483 }
484 break;
485 case MK_LOCATION_ONLY:
Sebastien Hertz6995c602014-09-09 12:10:13 +0200486 if (!Dbg::MatchLocation(pMod->locationOnly.loc, *basket.pLoc)) {
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700487 return false;
488 }
489 break;
490 case MK_EXCEPTION_ONLY:
Sebastien Hertz6995c602014-09-09 12:10:13 +0200491 if (pMod->exceptionOnly.refTypeId != 0 &&
Sebastien Hertz261bc042015-04-08 09:36:07 +0200492 !Dbg::MatchType(basket.exceptionClass.Get(), pMod->exceptionOnly.refTypeId)) {
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700493 return false;
494 }
Sebastien Hertz6995c602014-09-09 12:10:13 +0200495 if ((basket.caught && !pMod->exceptionOnly.caught) ||
496 (!basket.caught && !pMod->exceptionOnly.uncaught)) {
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700497 return false;
498 }
499 break;
500 case MK_FIELD_ONLY:
Sebastien Hertz6995c602014-09-09 12:10:13 +0200501 if (!Dbg::MatchField(pMod->fieldOnly.refTypeId, pMod->fieldOnly.fieldId, basket.field)) {
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700502 return false;
503 }
504 break;
505 case MK_STEP:
Sebastien Hertz6995c602014-09-09 12:10:13 +0200506 if (!Dbg::MatchThread(pMod->step.threadId, basket.thread)) {
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700507 return false;
508 }
509 break;
510 case MK_INSTANCE_ONLY:
Sebastien Hertz261bc042015-04-08 09:36:07 +0200511 if (!Dbg::MatchInstance(pMod->instanceOnly.objectId, basket.thisPtr.Get())) {
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700512 return false;
513 }
514 break;
515 default:
Elliott Hughes7b3cdfc2011-12-08 21:28:17 -0800516 LOG(FATAL) << "unknown mod kind " << pMod->modKind;
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700517 break;
518 }
519 }
520 return true;
521}
522
523/*
Sebastien Hertz7d955652014-10-22 10:57:10 +0200524 * Find all events of type "event_kind" with mods that match up with the
525 * rest of the arguments while holding the event list lock. This method
526 * is used by FindMatchingEvents below.
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700527 *
Sebastien Hertz7d955652014-10-22 10:57:10 +0200528 * Found events are appended to "match_list" so this may be called multiple times for grouped
529 * events.
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700530 *
531 * DO NOT call this multiple times for the same eventKind, as Count mods are
532 * decremented during the scan.
533 */
Sebastien Hertz7d955652014-10-22 10:57:10 +0200534void JdwpState::FindMatchingEventsLocked(JdwpEventKind event_kind, const ModBasket& basket,
535 std::vector<JdwpEvent*>* match_list) {
Sebastien Hertzbca0d3d2014-04-11 16:01:17 +0200536 for (JdwpEvent* pEvent = event_list_; pEvent != nullptr; pEvent = pEvent->next) {
Sebastien Hertz7d955652014-10-22 10:57:10 +0200537 if (pEvent->eventKind == event_kind && ModsMatch(pEvent, basket)) {
538 match_list->push_back(pEvent);
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700539 }
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700540 }
541}
542
543/*
Sebastien Hertz7d955652014-10-22 10:57:10 +0200544 * Find all events of type "event_kind" with mods that match up with the
545 * rest of the arguments and return true if at least one event matches,
546 * false otherwise.
547 *
548 * Found events are appended to "match_list" so this may be called multiple
549 * times for grouped events.
550 *
551 * DO NOT call this multiple times for the same eventKind, as Count mods are
552 * decremented during the scan.
553 */
554bool JdwpState::FindMatchingEvents(JdwpEventKind event_kind, const ModBasket& basket,
555 std::vector<JdwpEvent*>* match_list) {
556 MutexLock mu(Thread::Current(), event_list_lock_);
557 match_list->reserve(event_list_size_);
558 FindMatchingEventsLocked(event_kind, basket, match_list);
559 return !match_list->empty();
560}
561
562/*
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700563 * Scan through the list of matches and determine the most severe
564 * suspension policy.
565 */
Sebastien Hertz7d955652014-10-22 10:57:10 +0200566static JdwpSuspendPolicy ScanSuspendPolicy(const std::vector<JdwpEvent*>& match_list) {
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700567 JdwpSuspendPolicy policy = SP_NONE;
568
Sebastien Hertz7d955652014-10-22 10:57:10 +0200569 for (JdwpEvent* pEvent : match_list) {
570 if (pEvent->suspend_policy > policy) {
571 policy = pEvent->suspend_policy;
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700572 }
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700573 }
574
575 return policy;
576}
577
578/*
579 * Three possibilities:
580 * SP_NONE - do nothing
581 * SP_EVENT_THREAD - suspend ourselves
582 * SP_ALL - suspend everybody except JDWP support thread
583 */
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700584void JdwpState::SuspendByPolicy(JdwpSuspendPolicy suspend_policy, JDWP::ObjectId thread_self_id) {
Elliott Hughesf8349362012-06-18 15:00:06 -0700585 VLOG(jdwp) << "SuspendByPolicy(" << suspend_policy << ")";
586 if (suspend_policy == SP_NONE) {
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700587 return;
588 }
589
Elliott Hughesf8349362012-06-18 15:00:06 -0700590 if (suspend_policy == SP_ALL) {
Elliott Hughes475fc232011-10-25 15:00:35 -0700591 Dbg::SuspendVM();
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700592 } else {
Elliott Hughesf8349362012-06-18 15:00:06 -0700593 CHECK_EQ(suspend_policy, SP_EVENT_THREAD);
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700594 }
595
596 /* this is rare but possible -- see CLASS_PREPARE handling */
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700597 if (thread_self_id == debug_thread_id_) {
Elliott Hughes761928d2011-11-16 18:33:03 -0800598 LOG(INFO) << "NOTE: SuspendByPolicy not suspending JDWP thread";
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700599 return;
600 }
601
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700602 while (true) {
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700603 Dbg::SuspendSelf();
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700604
605 /*
606 * The JDWP thread has told us (and possibly all other threads) to
607 * resume. See if it has left anything in our DebugInvokeReq mailbox.
608 */
Sebastien Hertz1558b572015-02-25 15:05:59 +0100609 DebugInvokeReq* const pReq = Dbg::GetInvokeReq();
610 if (pReq == nullptr) {
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700611 break;
612 }
613
Sebastien Hertzcbc50642015-06-01 17:33:12 +0200614 // Execute method.
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700615 Dbg::ExecuteMethod(pReq);
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700616 }
617}
618
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700619void JdwpState::SendRequestAndPossiblySuspend(ExpandBuf* pReq, JdwpSuspendPolicy suspend_policy,
620 ObjectId threadId) {
Sebastien Hertz7d955652014-10-22 10:57:10 +0200621 Thread* const self = Thread::Current();
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700622 self->AssertThreadSuspensionIsAllowable();
Sebastien Hertz7d955652014-10-22 10:57:10 +0200623 CHECK(pReq != nullptr);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700624 /* send request and possibly suspend ourselves */
Sebastien Hertz7d955652014-10-22 10:57:10 +0200625 JDWP::ObjectId thread_self_id = Dbg::GetThreadSelfId();
Mathieu Chartierf1d666e2015-09-03 16:13:34 -0700626 ScopedThreadSuspension sts(self, kWaitingForDebuggerSend);
Sebastien Hertz7d955652014-10-22 10:57:10 +0200627 if (suspend_policy != SP_NONE) {
Sebastien Hertz2bf93f42015-01-09 18:44:05 +0100628 AcquireJdwpTokenForEvent(threadId);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700629 }
Sebastien Hertz7d955652014-10-22 10:57:10 +0200630 EventFinish(pReq);
Sebastien Hertz813b9602015-02-24 14:56:59 +0100631 {
632 // Before suspending, we change our state to kSuspended so the debugger sees us as RUNNING.
633 ScopedThreadStateChange stsc(self, kSuspended);
634 SuspendByPolicy(suspend_policy, thread_self_id);
635 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700636}
637
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700638/*
639 * Determine if there is a method invocation in progress in the current
640 * thread.
641 *
Elliott Hughes475fc232011-10-25 15:00:35 -0700642 * We look at the "invoke_needed" flag in the per-thread DebugInvokeReq
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700643 * state. If set, we're in the process of invoking a method.
644 */
Elliott Hughes761928d2011-11-16 18:33:03 -0800645bool JdwpState::InvokeInProgress() {
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700646 DebugInvokeReq* pReq = Dbg::GetInvokeReq();
Sebastien Hertz1558b572015-02-25 15:05:59 +0100647 return pReq != nullptr;
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700648}
649
Sebastien Hertz2bf93f42015-01-09 18:44:05 +0100650void JdwpState::AcquireJdwpTokenForCommand() {
651 CHECK_EQ(Thread::Current(), GetDebugThread()) << "Expected debugger thread";
652 SetWaitForJdwpToken(debug_thread_id_);
653}
654
655void JdwpState::ReleaseJdwpTokenForCommand() {
656 CHECK_EQ(Thread::Current(), GetDebugThread()) << "Expected debugger thread";
657 ClearWaitForJdwpToken();
658}
659
660void JdwpState::AcquireJdwpTokenForEvent(ObjectId threadId) {
661 CHECK_NE(Thread::Current(), GetDebugThread()) << "Expected event thread";
662 CHECK_NE(debug_thread_id_, threadId) << "Not expected debug thread";
663 SetWaitForJdwpToken(threadId);
664}
665
666void JdwpState::ReleaseJdwpTokenForEvent() {
667 CHECK_NE(Thread::Current(), GetDebugThread()) << "Expected event thread";
668 ClearWaitForJdwpToken();
669}
670
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700671/*
672 * We need the JDWP thread to hold off on doing stuff while we post an
673 * event and then suspend ourselves.
674 *
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700675 * This could go to sleep waiting for another thread, so it's important
676 * that the thread be marked as VMWAIT before calling here.
677 */
Sebastien Hertz2bf93f42015-01-09 18:44:05 +0100678void JdwpState::SetWaitForJdwpToken(ObjectId threadId) {
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700679 bool waited = false;
Sebastien Hertz2bf93f42015-01-09 18:44:05 +0100680 Thread* const self = Thread::Current();
681 CHECK_NE(threadId, 0u);
682 CHECK_NE(self->GetState(), kRunnable);
683 Locks::mutator_lock_->AssertNotHeld(self);
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700684
685 /* this is held for very brief periods; contention is unlikely */
Sebastien Hertz2bf93f42015-01-09 18:44:05 +0100686 MutexLock mu(self, jdwp_token_lock_);
687
688 CHECK_NE(jdwp_token_owner_thread_id_, threadId) << "Thread is already holding event thread lock";
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700689
690 /*
691 * If another thread is already doing stuff, wait for it. This can
692 * go to sleep indefinitely.
693 */
Sebastien Hertz2bf93f42015-01-09 18:44:05 +0100694 while (jdwp_token_owner_thread_id_ != 0) {
Ian Rogersd9e4e0c2014-01-23 20:11:40 -0800695 VLOG(jdwp) << StringPrintf("event in progress (%#" PRIx64 "), %#" PRIx64 " sleeping",
Sebastien Hertz2bf93f42015-01-09 18:44:05 +0100696 jdwp_token_owner_thread_id_, threadId);
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700697 waited = true;
Sebastien Hertz2bf93f42015-01-09 18:44:05 +0100698 jdwp_token_cond_.Wait(self);
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700699 }
700
Sebastien Hertz2bf93f42015-01-09 18:44:05 +0100701 if (waited || threadId != debug_thread_id_) {
Ian Rogersd9e4e0c2014-01-23 20:11:40 -0800702 VLOG(jdwp) << StringPrintf("event token grabbed (%#" PRIx64 ")", threadId);
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700703 }
Sebastien Hertz2bf93f42015-01-09 18:44:05 +0100704 jdwp_token_owner_thread_id_ = threadId;
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700705}
706
707/*
708 * Clear the threadId and signal anybody waiting.
709 */
Sebastien Hertz2bf93f42015-01-09 18:44:05 +0100710void JdwpState::ClearWaitForJdwpToken() {
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700711 /*
712 * Grab the mutex. Don't try to go in/out of VMWAIT mode, as this
Sebastien Hertz2bf93f42015-01-09 18:44:05 +0100713 * function is called by Dbg::SuspendSelf(), and the transition back
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700714 * to RUNNING would confuse it.
715 */
Sebastien Hertz2bf93f42015-01-09 18:44:05 +0100716 Thread* const self = Thread::Current();
717 MutexLock mu(self, jdwp_token_lock_);
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700718
Sebastien Hertz2bf93f42015-01-09 18:44:05 +0100719 CHECK_NE(jdwp_token_owner_thread_id_, 0U);
720 VLOG(jdwp) << StringPrintf("cleared event token (%#" PRIx64 ")", jdwp_token_owner_thread_id_);
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700721
Sebastien Hertz2bf93f42015-01-09 18:44:05 +0100722 jdwp_token_owner_thread_id_ = 0;
723 jdwp_token_cond_.Signal(self);
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700724}
725
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700726/*
727 * Prep an event. Allocates storage for the message and leaves space for
728 * the header.
729 */
730static ExpandBuf* eventPrep() {
731 ExpandBuf* pReq = expandBufAlloc();
732 expandBufAddSpace(pReq, kJDWPHeaderLen);
733 return pReq;
734}
735
736/*
737 * Write the header into the buffer and send the packet off to the debugger.
738 *
739 * Takes ownership of "pReq" (currently discards it).
740 */
Elliott Hughes761928d2011-11-16 18:33:03 -0800741void JdwpState::EventFinish(ExpandBuf* pReq) {
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700742 uint8_t* buf = expandBufGetBuffer(pReq);
743
Sebastien Hertzcbc50642015-06-01 17:33:12 +0200744 Set4BE(buf + kJDWPHeaderSizeOffset, expandBufGetLength(pReq));
745 Set4BE(buf + kJDWPHeaderIdOffset, NextRequestSerial());
746 Set1(buf + kJDWPHeaderFlagsOffset, 0); /* flags */
747 Set1(buf + kJDWPHeaderCmdSetOffset, kJDWPEventCmdSet);
748 Set1(buf + kJDWPHeaderCmdOffset, kJDWPEventCompositeCmd);
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700749
Elliott Hughes761928d2011-11-16 18:33:03 -0800750 SendRequest(pReq);
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700751
752 expandBufFree(pReq);
753}
754
755
756/*
757 * Tell the debugger that we have finished initializing. This is always
758 * sent, even if the debugger hasn't requested it.
759 *
760 * This should be sent "before the main thread is started and before
761 * any application code has been executed". The thread ID in the message
762 * must be for the main thread.
763 */
Sebastien Hertz7d955652014-10-22 10:57:10 +0200764void JdwpState::PostVMStart() {
765 JdwpSuspendPolicy suspend_policy = (options_->suspend) ? SP_ALL : SP_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700766 ObjectId threadId = Dbg::GetThreadSelfId();
767
Sebastien Hertz7d955652014-10-22 10:57:10 +0200768 VLOG(jdwp) << "EVENT: " << EK_VM_START;
769 VLOG(jdwp) << " suspend_policy=" << suspend_policy;
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700770
Elliott Hughes761928d2011-11-16 18:33:03 -0800771 ExpandBuf* pReq = eventPrep();
Sebastien Hertz7d955652014-10-22 10:57:10 +0200772 expandBufAdd1(pReq, suspend_policy);
773 expandBufAdd4BE(pReq, 1);
774 expandBufAdd1(pReq, EK_VM_START);
775 expandBufAdd4BE(pReq, 0); /* requestId */
776 expandBufAddObjectId(pReq, threadId);
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700777
Sebastien Hertz138dbfc2013-12-04 18:15:25 +0100778 Dbg::ManageDeoptimization();
779
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700780 /* send request and possibly suspend ourselves */
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700781 SendRequestAndPossiblySuspend(pReq, suspend_policy, threadId);
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700782}
783
Sebastien Hertz7d955652014-10-22 10:57:10 +0200784static void LogMatchingEventsAndThread(const std::vector<JdwpEvent*> match_list,
Sebastien Hertz6995c602014-09-09 12:10:13 +0200785 ObjectId thread_id)
Mathieu Chartier90443472015-07-16 20:32:27 -0700786 SHARED_REQUIRES(Locks::mutator_lock_) {
Sebastien Hertz7d955652014-10-22 10:57:10 +0200787 for (size_t i = 0, e = match_list.size(); i < e; ++i) {
Sebastien Hertzbca0d3d2014-04-11 16:01:17 +0200788 JdwpEvent* pEvent = match_list[i];
789 VLOG(jdwp) << "EVENT #" << i << ": " << pEvent->eventKind
790 << StringPrintf(" (requestId=%#" PRIx32 ")", pEvent->requestId);
791 }
792 std::string thread_name;
Sebastien Hertz6995c602014-09-09 12:10:13 +0200793 JdwpError error = Dbg::GetThreadName(thread_id, &thread_name);
Sebastien Hertzbca0d3d2014-04-11 16:01:17 +0200794 if (error != JDWP::ERR_NONE) {
795 thread_name = "<unknown>";
796 }
Sebastien Hertz6995c602014-09-09 12:10:13 +0200797 VLOG(jdwp) << StringPrintf(" thread=%#" PRIx64, thread_id) << " " << thread_name;
798}
799
800static void SetJdwpLocationFromEventLocation(const JDWP::EventLocation* event_location,
801 JDWP::JdwpLocation* jdwp_location)
Mathieu Chartier90443472015-07-16 20:32:27 -0700802 SHARED_REQUIRES(Locks::mutator_lock_) {
Sebastien Hertz6995c602014-09-09 12:10:13 +0200803 DCHECK(event_location != nullptr);
804 DCHECK(jdwp_location != nullptr);
805 Dbg::SetJdwpLocation(jdwp_location, event_location->method, event_location->dex_pc);
Sebastien Hertzbca0d3d2014-04-11 16:01:17 +0200806}
807
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700808/*
809 * A location of interest has been reached. This handles:
810 * Breakpoint
811 * SingleStep
812 * MethodEntry
813 * MethodExit
814 * These four types must be grouped together in a single response. The
815 * "eventFlags" indicates the type of event(s) that have happened.
816 *
817 * Valid mods:
818 * Count, ThreadOnly, ClassOnly, ClassMatch, ClassExclude, InstanceOnly
819 * LocationOnly (for breakpoint/step only)
820 * Step (for step only)
821 *
822 * Interesting test cases:
823 * - Put a breakpoint on a native method. Eclipse creates METHOD_ENTRY
824 * and METHOD_EXIT events with a ClassOnly mod on the method's class.
825 * - Use "run to line". Eclipse creates a BREAKPOINT with Count=1.
826 * - Single-step to a line with a breakpoint. Should get a single
827 * event message with both events in it.
828 */
Sebastien Hertz7d955652014-10-22 10:57:10 +0200829void JdwpState::PostLocationEvent(const EventLocation* pLoc, mirror::Object* thisPtr,
Sebastien Hertz6995c602014-09-09 12:10:13 +0200830 int eventFlags, const JValue* returnValue) {
831 DCHECK(pLoc != nullptr);
832 DCHECK(pLoc->method != nullptr);
833 DCHECK_EQ(pLoc->method->IsStatic(), thisPtr == nullptr);
834
Sebastien Hertz261bc042015-04-08 09:36:07 +0200835 ModBasket basket(Thread::Current());
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700836 basket.pLoc = pLoc;
Sebastien Hertz261bc042015-04-08 09:36:07 +0200837 basket.locationClass.Assign(pLoc->method->GetDeclaringClass());
838 basket.thisPtr.Assign(thisPtr);
839 basket.className = Dbg::GetClassName(basket.locationClass.Get());
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700840
841 /*
842 * On rare occasions we may need to execute interpreted code in the VM
843 * while handling a request from the debugger. Don't fire breakpoints
844 * while doing so. (I don't think we currently do this at all, so
845 * this is mostly paranoia.)
846 */
Sebastien Hertz6995c602014-09-09 12:10:13 +0200847 if (basket.thread == GetDebugThread()) {
Elliott Hughes4dd9b4d2011-12-12 18:29:24 -0800848 VLOG(jdwp) << "Ignoring location event in JDWP thread";
Sebastien Hertz7d955652014-10-22 10:57:10 +0200849 return;
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700850 }
851
852 /*
853 * The debugger variable display tab may invoke the interpreter to format
854 * complex objects. We want to ignore breakpoints and method entry/exit
855 * traps while working on behalf of the debugger.
856 *
857 * If we don't ignore them, the VM will get hung up, because we'll
858 * suspend on a breakpoint while the debugger is still waiting for its
859 * method invocation to complete.
860 */
Elliott Hughes761928d2011-11-16 18:33:03 -0800861 if (InvokeInProgress()) {
Elliott Hughes4dd9b4d2011-12-12 18:29:24 -0800862 VLOG(jdwp) << "Not checking breakpoints during invoke (" << basket.className << ")";
Sebastien Hertz7d955652014-10-22 10:57:10 +0200863 return;
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700864 }
865
Sebastien Hertz7d955652014-10-22 10:57:10 +0200866 std::vector<JdwpEvent*> match_list;
Elliott Hughes761928d2011-11-16 18:33:03 -0800867 {
Sebastien Hertz7d955652014-10-22 10:57:10 +0200868 // We use the locked version because we have multiple possible match events.
869 MutexLock mu(Thread::Current(), event_list_lock_);
870 match_list.reserve(event_list_size_);
871 if ((eventFlags & Dbg::kBreakpoint) != 0) {
872 FindMatchingEventsLocked(EK_BREAKPOINT, basket, &match_list);
Elliott Hughes761928d2011-11-16 18:33:03 -0800873 }
Sebastien Hertz7d955652014-10-22 10:57:10 +0200874 if ((eventFlags & Dbg::kSingleStep) != 0) {
875 FindMatchingEventsLocked(EK_SINGLE_STEP, basket, &match_list);
Elliott Hughes761928d2011-11-16 18:33:03 -0800876 }
Sebastien Hertz7d955652014-10-22 10:57:10 +0200877 if ((eventFlags & Dbg::kMethodEntry) != 0) {
878 FindMatchingEventsLocked(EK_METHOD_ENTRY, basket, &match_list);
Sebastien Hertz6995c602014-09-09 12:10:13 +0200879 }
Sebastien Hertz7d955652014-10-22 10:57:10 +0200880 if ((eventFlags & Dbg::kMethodExit) != 0) {
881 FindMatchingEventsLocked(EK_METHOD_EXIT, basket, &match_list);
882 FindMatchingEventsLocked(EK_METHOD_EXIT_WITH_RETURN_VALUE, basket, &match_list);
883 }
884 }
885 if (match_list.empty()) {
886 // No matching event.
887 return;
888 }
889 JdwpSuspendPolicy suspend_policy = ScanSuspendPolicy(match_list);
890
891 ObjectId thread_id = Dbg::GetThreadId(basket.thread);
892 JDWP::JdwpLocation jdwp_location;
893 SetJdwpLocationFromEventLocation(pLoc, &jdwp_location);
894
895 if (VLOG_IS_ON(jdwp)) {
896 LogMatchingEventsAndThread(match_list, thread_id);
897 VLOG(jdwp) << " location=" << jdwp_location;
898 VLOG(jdwp) << " suspend_policy=" << suspend_policy;
899 }
900
901 ExpandBuf* pReq = eventPrep();
902 expandBufAdd1(pReq, suspend_policy);
903 expandBufAdd4BE(pReq, match_list.size());
904
905 for (const JdwpEvent* pEvent : match_list) {
906 expandBufAdd1(pReq, pEvent->eventKind);
907 expandBufAdd4BE(pReq, pEvent->requestId);
908 expandBufAddObjectId(pReq, thread_id);
909 expandBufAddLocation(pReq, jdwp_location);
910 if (pEvent->eventKind == EK_METHOD_EXIT_WITH_RETURN_VALUE) {
911 Dbg::OutputMethodReturnValue(jdwp_location.method_id, returnValue, pReq);
912 }
913 }
914
915 {
916 MutexLock mu(Thread::Current(), event_list_lock_);
917 CleanupMatchList(match_list);
Elliott Hughes761928d2011-11-16 18:33:03 -0800918 }
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700919
Sebastien Hertz138dbfc2013-12-04 18:15:25 +0100920 Dbg::ManageDeoptimization();
921
Sebastien Hertz6995c602014-09-09 12:10:13 +0200922 SendRequestAndPossiblySuspend(pReq, suspend_policy, thread_id);
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700923}
924
Mathieu Chartierc7853442015-03-27 14:35:38 -0700925void JdwpState::PostFieldEvent(const EventLocation* pLoc, ArtField* field,
Sebastien Hertz6995c602014-09-09 12:10:13 +0200926 mirror::Object* this_object, const JValue* fieldValue,
927 bool is_modification) {
928 DCHECK(pLoc != nullptr);
929 DCHECK(field != nullptr);
930 DCHECK_EQ(fieldValue != nullptr, is_modification);
931 DCHECK_EQ(field->IsStatic(), this_object == nullptr);
932
Sebastien Hertz261bc042015-04-08 09:36:07 +0200933 ModBasket basket(Thread::Current());
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +0200934 basket.pLoc = pLoc;
Sebastien Hertz261bc042015-04-08 09:36:07 +0200935 basket.locationClass.Assign(pLoc->method->GetDeclaringClass());
936 basket.thisPtr.Assign(this_object);
937 basket.className = Dbg::GetClassName(basket.locationClass.Get());
Sebastien Hertz6995c602014-09-09 12:10:13 +0200938 basket.field = field;
Sebastien Hertzbca0d3d2014-04-11 16:01:17 +0200939
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +0200940 if (InvokeInProgress()) {
Sebastien Hertz261bc042015-04-08 09:36:07 +0200941 VLOG(jdwp) << "Not posting field event during invoke (" << basket.className << ")";
Sebastien Hertz7d955652014-10-22 10:57:10 +0200942 return;
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +0200943 }
944
Sebastien Hertz7d955652014-10-22 10:57:10 +0200945 std::vector<JdwpEvent*> match_list;
946 const JdwpEventKind match_kind = (is_modification) ? EK_FIELD_MODIFICATION : EK_FIELD_ACCESS;
947 if (!FindMatchingEvents(match_kind, basket, &match_list)) {
948 // No matching event.
949 return;
950 }
951
952 JdwpSuspendPolicy suspend_policy = ScanSuspendPolicy(match_list);
953 ObjectId thread_id = Dbg::GetThreadId(basket.thread);
954 ObjectRegistry* registry = Dbg::GetObjectRegistry();
955 ObjectId instance_id = registry->Add(basket.thisPtr);
956 RefTypeId field_type_id = registry->AddRefType(field->GetDeclaringClass());
957 FieldId field_id = Dbg::ToFieldId(field);
958 JDWP::JdwpLocation jdwp_location;
959 SetJdwpLocationFromEventLocation(pLoc, &jdwp_location);
960
961 if (VLOG_IS_ON(jdwp)) {
962 LogMatchingEventsAndThread(match_list, thread_id);
963 VLOG(jdwp) << " location=" << jdwp_location;
964 VLOG(jdwp) << StringPrintf(" this=%#" PRIx64, instance_id);
965 VLOG(jdwp) << StringPrintf(" type=%#" PRIx64, field_type_id) << " "
966 << Dbg::GetClassName(field_id);
Mathieu Chartierd3ed9a32015-04-10 14:23:35 -0700967 VLOG(jdwp) << StringPrintf(" field=%#" PRIx64, field_id) << " "
Sebastien Hertz7d955652014-10-22 10:57:10 +0200968 << Dbg::GetFieldName(field_id);
969 VLOG(jdwp) << " suspend_policy=" << suspend_policy;
970 }
971
972 ExpandBuf* pReq = eventPrep();
973 expandBufAdd1(pReq, suspend_policy);
974 expandBufAdd4BE(pReq, match_list.size());
975
976 // Get field's reference type tag.
977 JDWP::JdwpTypeTag type_tag = Dbg::GetTypeTag(field->GetDeclaringClass());
978
979 // Get instance type tag.
980 uint8_t tag;
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +0200981 {
Sebastien Hertz7d955652014-10-22 10:57:10 +0200982 ScopedObjectAccessUnchecked soa(Thread::Current());
Sebastien Hertz261bc042015-04-08 09:36:07 +0200983 tag = Dbg::TagFromObject(soa, basket.thisPtr.Get());
Sebastien Hertz7d955652014-10-22 10:57:10 +0200984 }
985
986 for (const JdwpEvent* pEvent : match_list) {
987 expandBufAdd1(pReq, pEvent->eventKind);
988 expandBufAdd4BE(pReq, pEvent->requestId);
989 expandBufAddObjectId(pReq, thread_id);
990 expandBufAddLocation(pReq, jdwp_location);
991 expandBufAdd1(pReq, type_tag);
992 expandBufAddRefTypeId(pReq, field_type_id);
993 expandBufAddFieldId(pReq, field_id);
994 expandBufAdd1(pReq, tag);
995 expandBufAddObjectId(pReq, instance_id);
996 if (is_modification) {
997 Dbg::OutputFieldValue(field_id, fieldValue, pReq);
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +0200998 }
Sebastien Hertz7d955652014-10-22 10:57:10 +0200999 }
Sebastien Hertzbca0d3d2014-04-11 16:01:17 +02001000
Sebastien Hertz7d955652014-10-22 10:57:10 +02001001 {
1002 MutexLock mu(Thread::Current(), event_list_lock_);
1003 CleanupMatchList(match_list);
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +02001004 }
1005
1006 Dbg::ManageDeoptimization();
1007
Sebastien Hertz6995c602014-09-09 12:10:13 +02001008 SendRequestAndPossiblySuspend(pReq, suspend_policy, thread_id);
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +02001009}
1010
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001011/*
1012 * A thread is starting or stopping.
1013 *
1014 * Valid mods:
1015 * Count, ThreadOnly
1016 */
Sebastien Hertz7d955652014-10-22 10:57:10 +02001017void JdwpState::PostThreadChange(Thread* thread, bool start) {
Sebastien Hertz6995c602014-09-09 12:10:13 +02001018 CHECK_EQ(thread, Thread::Current());
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001019
1020 /*
1021 * I don't think this can happen.
1022 */
Elliott Hughes761928d2011-11-16 18:33:03 -08001023 if (InvokeInProgress()) {
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001024 LOG(WARNING) << "Not posting thread change during invoke";
Sebastien Hertz7d955652014-10-22 10:57:10 +02001025 return;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001026 }
1027
Sebastien Hertz107e7572014-12-18 11:13:15 +01001028 // We need the java.lang.Thread object associated to the starting/ending
1029 // thread to get its JDWP id. Therefore we can't report event if there
1030 // is no Java peer. This happens when the runtime shuts down and re-attaches
1031 // the current thread without creating a Java peer.
1032 if (thread->GetPeer() == nullptr) {
1033 return;
1034 }
1035
Sebastien Hertz261bc042015-04-08 09:36:07 +02001036 ModBasket basket(thread);
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001037
Sebastien Hertz7d955652014-10-22 10:57:10 +02001038 std::vector<JdwpEvent*> match_list;
1039 const JdwpEventKind match_kind = (start) ? EK_THREAD_START : EK_THREAD_DEATH;
1040 if (!FindMatchingEvents(match_kind, basket, &match_list)) {
1041 // No matching event.
1042 return;
1043 }
1044
1045 JdwpSuspendPolicy suspend_policy = ScanSuspendPolicy(match_list);
1046 ObjectId thread_id = Dbg::GetThreadId(basket.thread);
1047
1048 if (VLOG_IS_ON(jdwp)) {
1049 LogMatchingEventsAndThread(match_list, thread_id);
1050 VLOG(jdwp) << " suspend_policy=" << suspend_policy;
1051 }
1052
1053 ExpandBuf* pReq = eventPrep();
1054 expandBufAdd1(pReq, suspend_policy);
1055 expandBufAdd4BE(pReq, match_list.size());
1056
1057 for (const JdwpEvent* pEvent : match_list) {
1058 expandBufAdd1(pReq, pEvent->eventKind);
1059 expandBufAdd4BE(pReq, pEvent->requestId);
1060 expandBufAdd8BE(pReq, thread_id);
1061 }
1062
Elliott Hughes234ab152011-10-26 14:02:26 -07001063 {
Sebastien Hertz7d955652014-10-22 10:57:10 +02001064 MutexLock mu(Thread::Current(), event_list_lock_);
1065 CleanupMatchList(match_list);
Elliott Hughes234ab152011-10-26 14:02:26 -07001066 }
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001067
Sebastien Hertz138dbfc2013-12-04 18:15:25 +01001068 Dbg::ManageDeoptimization();
1069
Sebastien Hertz6995c602014-09-09 12:10:13 +02001070 SendRequestAndPossiblySuspend(pReq, suspend_policy, thread_id);
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001071}
1072
1073/*
1074 * Send a polite "VM is dying" message to the debugger.
1075 *
1076 * Skips the usual "event token" stuff.
1077 */
Elliott Hughes376a7a02011-10-24 18:35:55 -07001078bool JdwpState::PostVMDeath() {
Elliott Hughes4dd9b4d2011-12-12 18:29:24 -08001079 VLOG(jdwp) << "EVENT: " << EK_VM_DEATH;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001080
1081 ExpandBuf* pReq = eventPrep();
1082 expandBufAdd1(pReq, SP_NONE);
1083 expandBufAdd4BE(pReq, 1);
1084
1085 expandBufAdd1(pReq, EK_VM_DEATH);
1086 expandBufAdd4BE(pReq, 0);
Elliott Hughes761928d2011-11-16 18:33:03 -08001087 EventFinish(pReq);
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001088 return true;
1089}
1090
1091/*
1092 * An exception has been thrown. It may or may not have been caught.
1093 *
1094 * Valid mods:
1095 * Count, ThreadOnly, ClassOnly, ClassMatch, ClassExclude, LocationOnly,
1096 * ExceptionOnly, InstanceOnly
1097 *
1098 * The "exceptionId" has not been added to the GC-visible object registry,
1099 * because there's a pretty good chance that we're not going to send it
1100 * up the debugger.
1101 */
Sebastien Hertz7d955652014-10-22 10:57:10 +02001102void JdwpState::PostException(const EventLocation* pThrowLoc, mirror::Throwable* exception_object,
Sebastien Hertz6995c602014-09-09 12:10:13 +02001103 const EventLocation* pCatchLoc, mirror::Object* thisPtr) {
1104 DCHECK(exception_object != nullptr);
1105 DCHECK(pThrowLoc != nullptr);
1106 DCHECK(pCatchLoc != nullptr);
Sebastien Hertza9aa0ff2014-09-19 12:07:51 +02001107 if (pThrowLoc->method != nullptr) {
1108 DCHECK_EQ(pThrowLoc->method->IsStatic(), thisPtr == nullptr);
1109 } else {
1110 VLOG(jdwp) << "Unexpected: exception event with empty throw location";
1111 }
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001112
Sebastien Hertz261bc042015-04-08 09:36:07 +02001113 ModBasket basket(Thread::Current());
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001114 basket.pLoc = pThrowLoc;
Sebastien Hertza9aa0ff2014-09-19 12:07:51 +02001115 if (pThrowLoc->method != nullptr) {
Sebastien Hertz261bc042015-04-08 09:36:07 +02001116 basket.locationClass.Assign(pThrowLoc->method->GetDeclaringClass());
Sebastien Hertza9aa0ff2014-09-19 12:07:51 +02001117 }
Sebastien Hertz261bc042015-04-08 09:36:07 +02001118 basket.className = Dbg::GetClassName(basket.locationClass.Get());
1119 basket.exceptionClass.Assign(exception_object->GetClass());
Sebastien Hertz6995c602014-09-09 12:10:13 +02001120 basket.caught = (pCatchLoc->method != 0);
Sebastien Hertz261bc042015-04-08 09:36:07 +02001121 basket.thisPtr.Assign(thisPtr);
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001122
1123 /* don't try to post an exception caused by the debugger */
Elliott Hughes761928d2011-11-16 18:33:03 -08001124 if (InvokeInProgress()) {
Elliott Hughes4dd9b4d2011-12-12 18:29:24 -08001125 VLOG(jdwp) << "Not posting exception hit during invoke (" << basket.className << ")";
Sebastien Hertz7d955652014-10-22 10:57:10 +02001126 return;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001127 }
1128
Sebastien Hertz7d955652014-10-22 10:57:10 +02001129 std::vector<JdwpEvent*> match_list;
1130 if (!FindMatchingEvents(EK_EXCEPTION, basket, &match_list)) {
1131 // No matching event.
1132 return;
1133 }
1134
1135 JdwpSuspendPolicy suspend_policy = ScanSuspendPolicy(match_list);
1136 ObjectId thread_id = Dbg::GetThreadId(basket.thread);
1137 ObjectRegistry* registry = Dbg::GetObjectRegistry();
1138 ObjectId exceptionId = registry->Add(exception_object);
1139 JDWP::JdwpLocation jdwp_throw_location;
1140 JDWP::JdwpLocation jdwp_catch_location;
1141 SetJdwpLocationFromEventLocation(pThrowLoc, &jdwp_throw_location);
1142 SetJdwpLocationFromEventLocation(pCatchLoc, &jdwp_catch_location);
1143
1144 if (VLOG_IS_ON(jdwp)) {
1145 std::string exceptionClassName(PrettyDescriptor(exception_object->GetClass()));
1146
1147 LogMatchingEventsAndThread(match_list, thread_id);
1148 VLOG(jdwp) << " throwLocation=" << jdwp_throw_location;
1149 if (jdwp_catch_location.class_id == 0) {
1150 VLOG(jdwp) << " catchLocation=uncaught";
1151 } else {
1152 VLOG(jdwp) << " catchLocation=" << jdwp_catch_location;
1153 }
1154 VLOG(jdwp) << StringPrintf(" exception=%#" PRIx64, exceptionId) << " "
1155 << exceptionClassName;
1156 VLOG(jdwp) << " suspend_policy=" << suspend_policy;
1157 }
1158
1159 ExpandBuf* pReq = eventPrep();
1160 expandBufAdd1(pReq, suspend_policy);
1161 expandBufAdd4BE(pReq, match_list.size());
1162
1163 for (const JdwpEvent* pEvent : match_list) {
1164 expandBufAdd1(pReq, pEvent->eventKind);
1165 expandBufAdd4BE(pReq, pEvent->requestId);
1166 expandBufAddObjectId(pReq, thread_id);
1167 expandBufAddLocation(pReq, jdwp_throw_location);
1168 expandBufAdd1(pReq, JT_OBJECT);
1169 expandBufAddObjectId(pReq, exceptionId);
1170 expandBufAddLocation(pReq, jdwp_catch_location);
1171 }
1172
Elliott Hughes761928d2011-11-16 18:33:03 -08001173 {
Sebastien Hertz7d955652014-10-22 10:57:10 +02001174 MutexLock mu(Thread::Current(), event_list_lock_);
1175 CleanupMatchList(match_list);
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001176 }
1177
Sebastien Hertz138dbfc2013-12-04 18:15:25 +01001178 Dbg::ManageDeoptimization();
1179
Sebastien Hertz6995c602014-09-09 12:10:13 +02001180 SendRequestAndPossiblySuspend(pReq, suspend_policy, thread_id);
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001181}
1182
1183/*
1184 * Announce that a class has been loaded.
1185 *
1186 * Valid mods:
1187 * Count, ThreadOnly, ClassOnly, ClassMatch, ClassExclude
1188 */
Sebastien Hertz7d955652014-10-22 10:57:10 +02001189void JdwpState::PostClassPrepare(mirror::Class* klass) {
Sebastien Hertz6995c602014-09-09 12:10:13 +02001190 DCHECK(klass != nullptr);
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001191
Sebastien Hertz261bc042015-04-08 09:36:07 +02001192 ModBasket basket(Thread::Current());
1193 basket.locationClass.Assign(klass);
1194 basket.className = Dbg::GetClassName(basket.locationClass.Get());
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001195
1196 /* suppress class prep caused by debugger */
Elliott Hughes761928d2011-11-16 18:33:03 -08001197 if (InvokeInProgress()) {
Elliott Hughes4dd9b4d2011-12-12 18:29:24 -08001198 VLOG(jdwp) << "Not posting class prep caused by invoke (" << basket.className << ")";
Sebastien Hertz7d955652014-10-22 10:57:10 +02001199 return;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001200 }
1201
Sebastien Hertz7d955652014-10-22 10:57:10 +02001202 std::vector<JdwpEvent*> match_list;
1203 if (!FindMatchingEvents(EK_CLASS_PREPARE, basket, &match_list)) {
1204 // No matching event.
1205 return;
1206 }
1207
1208 JdwpSuspendPolicy suspend_policy = ScanSuspendPolicy(match_list);
1209 ObjectId thread_id = Dbg::GetThreadId(basket.thread);
1210 ObjectRegistry* registry = Dbg::GetObjectRegistry();
1211 RefTypeId class_id = registry->AddRefType(basket.locationClass);
1212
1213 // OLD-TODO - we currently always send both "verified" and "prepared" since
1214 // debuggers seem to like that. There might be some advantage to honesty,
1215 // since the class may not yet be verified.
1216 int status = JDWP::CS_VERIFIED | JDWP::CS_PREPARED;
Sebastien Hertz261bc042015-04-08 09:36:07 +02001217 JDWP::JdwpTypeTag tag = Dbg::GetTypeTag(basket.locationClass.Get());
Sebastien Hertz7d955652014-10-22 10:57:10 +02001218 std::string temp;
1219 std::string signature(basket.locationClass->GetDescriptor(&temp));
1220
1221 if (VLOG_IS_ON(jdwp)) {
1222 LogMatchingEventsAndThread(match_list, thread_id);
1223 VLOG(jdwp) << StringPrintf(" type=%#" PRIx64, class_id) << " " << signature;
1224 VLOG(jdwp) << " suspend_policy=" << suspend_policy;
1225 }
1226
1227 if (thread_id == debug_thread_id_) {
1228 /*
1229 * JDWP says that, for a class prep in the debugger thread, we
1230 * should set thread to null and if any threads were supposed
1231 * to be suspended then we suspend all other threads.
1232 */
1233 VLOG(jdwp) << " NOTE: class prepare in debugger thread!";
1234 thread_id = 0;
1235 if (suspend_policy == SP_EVENT_THREAD) {
1236 suspend_policy = SP_ALL;
1237 }
1238 }
1239
1240 ExpandBuf* pReq = eventPrep();
1241 expandBufAdd1(pReq, suspend_policy);
1242 expandBufAdd4BE(pReq, match_list.size());
1243
1244 for (const JdwpEvent* pEvent : match_list) {
1245 expandBufAdd1(pReq, pEvent->eventKind);
1246 expandBufAdd4BE(pReq, pEvent->requestId);
1247 expandBufAddObjectId(pReq, thread_id);
1248 expandBufAdd1(pReq, tag);
1249 expandBufAddRefTypeId(pReq, class_id);
1250 expandBufAddUtf8String(pReq, signature);
1251 expandBufAdd4BE(pReq, status);
1252 }
1253
Elliott Hughes761928d2011-11-16 18:33:03 -08001254 {
Sebastien Hertz7d955652014-10-22 10:57:10 +02001255 MutexLock mu(Thread::Current(), event_list_lock_);
1256 CleanupMatchList(match_list);
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001257 }
1258
Sebastien Hertz138dbfc2013-12-04 18:15:25 +01001259 Dbg::ManageDeoptimization();
1260
Sebastien Hertz6995c602014-09-09 12:10:13 +02001261 SendRequestAndPossiblySuspend(pReq, suspend_policy, thread_id);
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001262}
1263
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001264/*
Mathieu Chartierad466ad2015-01-08 16:28:08 -08001265 * Setup the header for a chunk of DDM data.
1266 */
1267void JdwpState::SetupChunkHeader(uint32_t type, size_t data_len, size_t header_size,
1268 uint8_t* out_header) {
1269 CHECK_EQ(header_size, static_cast<size_t>(kJDWPHeaderLen + 8));
1270 /* form the header (JDWP plus DDMS) */
1271 Set4BE(out_header, header_size + data_len);
1272 Set4BE(out_header + 4, NextRequestSerial());
1273 Set1(out_header + 8, 0); /* flags */
1274 Set1(out_header + 9, kJDWPDdmCmdSet);
1275 Set1(out_header + 10, kJDWPDdmCmd);
1276 Set4BE(out_header + 11, type);
1277 Set4BE(out_header + 15, data_len);
1278}
1279
1280/*
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001281 * Send up a chunk of DDM data.
1282 *
1283 * While this takes the form of a JDWP "event", it doesn't interact with
1284 * other debugger traffic, and can't suspend the VM, so we skip all of
1285 * the fun event token gymnastics.
1286 */
Elliott Hughescccd84f2011-12-05 16:51:54 -08001287void JdwpState::DdmSendChunkV(uint32_t type, const iovec* iov, int iov_count) {
Mathieu Chartierad466ad2015-01-08 16:28:08 -08001288 uint8_t header[kJDWPHeaderLen + 8] = { 0 };
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001289 size_t dataLen = 0;
1290
Sebastien Hertz7d955652014-10-22 10:57:10 +02001291 CHECK(iov != nullptr);
Elliott Hughescccd84f2011-12-05 16:51:54 -08001292 CHECK_GT(iov_count, 0);
1293 CHECK_LT(iov_count, 10);
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001294
1295 /*
1296 * "Wrap" the contents of the iovec with a JDWP/DDMS header. We do
1297 * this by creating a new copy of the vector with space for the header.
1298 */
Brian Carlstromf5293522013-07-19 00:24:00 -07001299 std::vector<iovec> wrapiov;
1300 wrapiov.push_back(iovec());
Elliott Hughescccd84f2011-12-05 16:51:54 -08001301 for (int i = 0; i < iov_count; i++) {
Brian Carlstromf5293522013-07-19 00:24:00 -07001302 wrapiov.push_back(iov[i]);
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001303 dataLen += iov[i].iov_len;
1304 }
1305
Mathieu Chartierad466ad2015-01-08 16:28:08 -08001306 SetupChunkHeader(type, dataLen, sizeof(header), header);
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001307
1308 wrapiov[0].iov_base = header;
1309 wrapiov[0].iov_len = sizeof(header);
1310
Ian Rogers15bf2d32012-08-28 17:33:04 -07001311 // Try to avoid blocking GC during a send, but only safe when not using mutexes at a lower-level
1312 // than mutator for lock ordering reasons.
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001313 Thread* self = Thread::Current();
Ian Rogers62d6c772013-02-27 08:32:07 -08001314 bool safe_to_release_mutator_lock_over_send = !Locks::mutator_lock_->IsExclusiveHeld(self);
1315 if (safe_to_release_mutator_lock_over_send) {
Brian Carlstrom38f85e42013-07-18 14:45:22 -07001316 for (size_t i = 0; i < kMutatorLock; ++i) {
Sebastien Hertz7d955652014-10-22 10:57:10 +02001317 if (self->GetHeldMutex(static_cast<LockLevel>(i)) != nullptr) {
Ian Rogers62d6c772013-02-27 08:32:07 -08001318 safe_to_release_mutator_lock_over_send = false;
1319 break;
1320 }
Ian Rogers15bf2d32012-08-28 17:33:04 -07001321 }
1322 }
1323 if (safe_to_release_mutator_lock_over_send) {
1324 // Change state to waiting to allow GC, ... while we're sending.
Mathieu Chartierf1d666e2015-09-03 16:13:34 -07001325 ScopedThreadSuspension sts(self, kWaitingForDebuggerSend);
Brian Carlstromf5293522013-07-19 00:24:00 -07001326 SendBufferedRequest(type, wrapiov);
Ian Rogers15bf2d32012-08-28 17:33:04 -07001327 } else {
1328 // Send and possibly block GC...
Brian Carlstromf5293522013-07-19 00:24:00 -07001329 SendBufferedRequest(type, wrapiov);
Ian Rogers15bf2d32012-08-28 17:33:04 -07001330 }
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001331}
1332
1333} // namespace JDWP
1334
1335} // namespace art