blob: a858962a4e715db93584ff435bb831c16a794e93 [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 */
16
17#include "debugger.h"
18
Elliott Hughes3bb81562011-10-21 18:52:59 -070019#include <sys/uio.h>
20
Elliott Hughes545a0642011-11-08 19:10:03 -080021#include <set>
22
23#include "class_linker.h"
Elliott Hughes1bba14f2011-12-01 18:00:36 -080024#include "class_loader.h"
Elliott Hughes68fdbd02011-11-29 19:22:47 -080025#include "context.h"
Elliott Hughes6a5bd492011-10-28 14:33:57 -070026#include "ScopedLocalRef.h"
Elliott Hughesf6a1e1e2011-10-25 16:28:04 -070027#include "ScopedPrimitiveArray.h"
Elliott Hughes47fce012011-10-25 18:37:19 -070028#include "stack_indirect_reference_table.h"
Elliott Hughes475fc232011-10-25 15:00:35 -070029#include "thread_list.h"
30
Elliott Hughes6a5bd492011-10-28 14:33:57 -070031extern "C" void dlmalloc_walk_heap(void(*)(const void*, size_t, const void*, size_t, void*), void*);
32#ifndef HAVE_ANDROID_OS
33void dlmalloc_walk_heap(void(*)(const void*, size_t, const void*, size_t, void*), void*) {
34 // No-op for glibc.
35}
36#endif
37
Elliott Hughes872d4ec2011-10-21 17:07:15 -070038namespace art {
39
Elliott Hughes545a0642011-11-08 19:10:03 -080040static const size_t kMaxAllocRecordStackDepth = 16; // Max 255.
41static const size_t kNumAllocRecords = 512; // Must be power of 2.
42
Elliott Hughes475fc232011-10-25 15:00:35 -070043class ObjectRegistry {
44 public:
45 ObjectRegistry() : lock_("ObjectRegistry lock") {
46 }
47
48 JDWP::ObjectId Add(Object* o) {
49 if (o == NULL) {
50 return 0;
51 }
52 JDWP::ObjectId id = static_cast<JDWP::ObjectId>(reinterpret_cast<uintptr_t>(o));
53 MutexLock mu(lock_);
54 map_[id] = o;
55 return id;
56 }
57
Elliott Hughes234ab152011-10-26 14:02:26 -070058 void Clear() {
59 MutexLock mu(lock_);
60 LOG(DEBUG) << "Debugger has detached; object registry had " << map_.size() << " entries";
61 map_.clear();
62 }
63
Elliott Hughes475fc232011-10-25 15:00:35 -070064 bool Contains(JDWP::ObjectId id) {
65 MutexLock mu(lock_);
66 return map_.find(id) != map_.end();
67 }
68
Elliott Hughesa2155262011-11-16 16:26:58 -080069 template<typename T> T Get(JDWP::ObjectId id) {
70 MutexLock mu(lock_);
71 typedef std::map<JDWP::ObjectId, Object*>::iterator It; // C++0x auto
72 It it = map_.find(id);
73 return (it != map_.end()) ? reinterpret_cast<T>(it->second) : NULL;
74 }
75
Elliott Hughesbfe487b2011-10-26 15:48:55 -070076 void VisitRoots(Heap::RootVisitor* visitor, void* arg) {
77 MutexLock mu(lock_);
78 typedef std::map<JDWP::ObjectId, Object*>::iterator It; // C++0x auto
79 for (It it = map_.begin(); it != map_.end(); ++it) {
80 visitor(it->second, arg);
81 }
82 }
83
Elliott Hughes475fc232011-10-25 15:00:35 -070084 private:
85 Mutex lock_;
86 std::map<JDWP::ObjectId, Object*> map_;
87};
88
Elliott Hughes545a0642011-11-08 19:10:03 -080089struct AllocRecordStackTraceElement {
90 const Method* method;
91 uintptr_t raw_pc;
92
93 int32_t LineNumber() const {
94 ClassLinker* class_linker = Runtime::Current()->GetClassLinker();
95 Class* c = method->GetDeclaringClass();
96 DexCache* dex_cache = c->GetDexCache();
97 const DexFile& dex_file = class_linker->FindDexFile(dex_cache);
98 return dex_file.GetLineNumFromPC(method, method->ToDexPC(raw_pc));
99 }
100};
101
102struct AllocRecord {
103 Class* type;
104 size_t byte_count;
105 uint16_t thin_lock_id;
106 AllocRecordStackTraceElement stack[kMaxAllocRecordStackDepth]; // Unused entries have NULL method.
107
108 size_t GetDepth() {
109 size_t depth = 0;
110 while (depth < kMaxAllocRecordStackDepth && stack[depth].method != NULL) {
111 ++depth;
112 }
113 return depth;
114 }
115};
116
Elliott Hughes4ffd3132011-10-24 12:06:42 -0700117// JDWP is allowed unless the Zygote forbids it.
118static bool gJdwpAllowed = true;
119
Elliott Hughes3bb81562011-10-21 18:52:59 -0700120// Was there a -Xrunjdwp or -agent argument on the command-line?
121static bool gJdwpConfigured = false;
122
123// Broken-down JDWP options. (Only valid if gJdwpConfigured is true.)
Elliott Hughes376a7a02011-10-24 18:35:55 -0700124static JDWP::JdwpOptions gJdwpOptions;
Elliott Hughes3bb81562011-10-21 18:52:59 -0700125
126// Runtime JDWP state.
127static JDWP::JdwpState* gJdwpState = NULL;
128static bool gDebuggerConnected; // debugger or DDMS is connected.
129static bool gDebuggerActive; // debugger is making requests.
130
Elliott Hughes47fce012011-10-25 18:37:19 -0700131static bool gDdmThreadNotification = false;
132
Elliott Hughes767a1472011-10-26 18:49:02 -0700133// DDMS GC-related settings.
134static Dbg::HpifWhen gDdmHpifWhen = Dbg::HPIF_WHEN_NEVER;
135static Dbg::HpsgWhen gDdmHpsgWhen = Dbg::HPSG_WHEN_NEVER;
136static Dbg::HpsgWhat gDdmHpsgWhat;
137static Dbg::HpsgWhen gDdmNhsgWhen = Dbg::HPSG_WHEN_NEVER;
138static Dbg::HpsgWhat gDdmNhsgWhat;
139
Elliott Hughes475fc232011-10-25 15:00:35 -0700140static ObjectRegistry* gRegistry = NULL;
141
Elliott Hughes545a0642011-11-08 19:10:03 -0800142// Recent allocation tracking.
143static Mutex gAllocTrackerLock("AllocTracker lock");
144AllocRecord* Dbg::recent_allocation_records_ = NULL; // TODO: CircularBuffer<AllocRecord>
145static size_t gAllocRecordHead = 0;
146static size_t gAllocRecordCount = 0;
147
Elliott Hughes24437992011-11-30 14:49:33 -0800148static JDWP::JdwpTag BasicTagFromDescriptor(const char* descriptor) {
149 // JDWP deliberately uses the descriptor characters' ASCII values for its enum.
150 // Note that by "basic" we mean that we don't get more specific than JT_OBJECT.
151 return static_cast<JDWP::JdwpTag>(descriptor[0]);
152}
153
154static JDWP::JdwpTag TagFromClass(Class* c) {
155 if (c->IsArrayClass()) {
156 return JDWP::JT_ARRAY;
157 }
158
159 if (c->IsStringClass()) {
160 return JDWP::JT_STRING;
161 } else if (c->IsClassClass()) {
162 return JDWP::JT_CLASS_OBJECT;
163#if 0 // TODO
164 } else if (dvmInstanceof(clazz, gDvm.classJavaLangThread)) {
165 return JDWP::JT_THREAD;
166 } else if (dvmInstanceof(clazz, gDvm.classJavaLangThreadGroup)) {
167 return JDWP::JT_THREAD_GROUP;
168 } else if (dvmInstanceof(clazz, gDvm.classJavaLangClassLoader)) {
169 return JDWP::JT_CLASS_LOADER;
170#endif
171 } else {
172 return JDWP::JT_OBJECT;
173 }
174}
175
176/*
177 * Objects declared to hold Object might actually hold a more specific
178 * type. The debugger may take a special interest in these (e.g. it
179 * wants to display the contents of Strings), so we want to return an
180 * appropriate tag.
181 *
182 * Null objects are tagged JT_OBJECT.
183 */
184static JDWP::JdwpTag TagFromObject(const Object* o) {
185 return (o == NULL) ? JDWP::JT_OBJECT : TagFromClass(o->GetClass());
186}
187
188static bool IsPrimitiveTag(JDWP::JdwpTag tag) {
189 switch (tag) {
190 case JDWP::JT_BOOLEAN:
191 case JDWP::JT_BYTE:
192 case JDWP::JT_CHAR:
193 case JDWP::JT_FLOAT:
194 case JDWP::JT_DOUBLE:
195 case JDWP::JT_INT:
196 case JDWP::JT_LONG:
197 case JDWP::JT_SHORT:
198 case JDWP::JT_VOID:
199 return true;
200 default:
201 return false;
202 }
203}
204
Elliott Hughes3bb81562011-10-21 18:52:59 -0700205/*
206 * Handle one of the JDWP name/value pairs.
207 *
208 * JDWP options are:
209 * help: if specified, show help message and bail
210 * transport: may be dt_socket or dt_shmem
211 * address: for dt_socket, "host:port", or just "port" when listening
212 * server: if "y", wait for debugger to attach; if "n", attach to debugger
213 * timeout: how long to wait for debugger to connect / listen
214 *
215 * Useful with server=n (these aren't supported yet):
216 * onthrow=<exception-name>: connect to debugger when exception thrown
217 * onuncaught=y|n: connect to debugger when uncaught exception thrown
218 * launch=<command-line>: launch the debugger itself
219 *
220 * The "transport" option is required, as is "address" if server=n.
221 */
222static bool ParseJdwpOption(const std::string& name, const std::string& value) {
223 if (name == "transport") {
224 if (value == "dt_socket") {
Elliott Hughes376a7a02011-10-24 18:35:55 -0700225 gJdwpOptions.transport = JDWP::kJdwpTransportSocket;
Elliott Hughes3bb81562011-10-21 18:52:59 -0700226 } else if (value == "dt_android_adb") {
Elliott Hughes376a7a02011-10-24 18:35:55 -0700227 gJdwpOptions.transport = JDWP::kJdwpTransportAndroidAdb;
Elliott Hughes3bb81562011-10-21 18:52:59 -0700228 } else {
229 LOG(ERROR) << "JDWP transport not supported: " << value;
230 return false;
231 }
232 } else if (name == "server") {
233 if (value == "n") {
Elliott Hughes376a7a02011-10-24 18:35:55 -0700234 gJdwpOptions.server = false;
Elliott Hughes3bb81562011-10-21 18:52:59 -0700235 } else if (value == "y") {
Elliott Hughes376a7a02011-10-24 18:35:55 -0700236 gJdwpOptions.server = true;
Elliott Hughes3bb81562011-10-21 18:52:59 -0700237 } else {
238 LOG(ERROR) << "JDWP option 'server' must be 'y' or 'n'";
239 return false;
240 }
241 } else if (name == "suspend") {
242 if (value == "n") {
Elliott Hughes376a7a02011-10-24 18:35:55 -0700243 gJdwpOptions.suspend = false;
Elliott Hughes3bb81562011-10-21 18:52:59 -0700244 } else if (value == "y") {
Elliott Hughes376a7a02011-10-24 18:35:55 -0700245 gJdwpOptions.suspend = true;
Elliott Hughes3bb81562011-10-21 18:52:59 -0700246 } else {
247 LOG(ERROR) << "JDWP option 'suspend' must be 'y' or 'n'";
248 return false;
249 }
250 } else if (name == "address") {
251 /* this is either <port> or <host>:<port> */
252 std::string port_string;
Elliott Hughes376a7a02011-10-24 18:35:55 -0700253 gJdwpOptions.host.clear();
Elliott Hughes3bb81562011-10-21 18:52:59 -0700254 std::string::size_type colon = value.find(':');
255 if (colon != std::string::npos) {
Elliott Hughes376a7a02011-10-24 18:35:55 -0700256 gJdwpOptions.host = value.substr(0, colon);
Elliott Hughes3bb81562011-10-21 18:52:59 -0700257 port_string = value.substr(colon + 1);
258 } else {
259 port_string = value;
260 }
261 if (port_string.empty()) {
262 LOG(ERROR) << "JDWP address missing port: " << value;
263 return false;
264 }
265 char* end;
266 long port = strtol(port_string.c_str(), &end, 10);
267 if (*end != '\0') {
268 LOG(ERROR) << "JDWP address has junk in port field: " << value;
269 return false;
270 }
Elliott Hughes376a7a02011-10-24 18:35:55 -0700271 gJdwpOptions.port = port;
Elliott Hughes3bb81562011-10-21 18:52:59 -0700272 } else if (name == "launch" || name == "onthrow" || name == "oncaught" || name == "timeout") {
273 /* valid but unsupported */
274 LOG(INFO) << "Ignoring JDWP option '" << name << "'='" << value << "'";
275 } else {
276 LOG(INFO) << "Ignoring unrecognized JDWP option '" << name << "'='" << value << "'";
277 }
278
279 return true;
280}
281
282/*
283 * Parse the latter half of a -Xrunjdwp/-agentlib:jdwp= string, e.g.:
284 * "transport=dt_socket,address=8000,server=y,suspend=n"
285 */
286bool Dbg::ParseJdwpOptions(const std::string& options) {
Elliott Hughes47fce012011-10-25 18:37:19 -0700287 LOG(VERBOSE) << "ParseJdwpOptions: " << options;
288
Elliott Hughes3bb81562011-10-21 18:52:59 -0700289 std::vector<std::string> pairs;
290 Split(options, ',', pairs);
291
292 for (size_t i = 0; i < pairs.size(); ++i) {
293 std::string::size_type equals = pairs[i].find('=');
294 if (equals == std::string::npos) {
295 LOG(ERROR) << "Can't parse JDWP option '" << pairs[i] << "' in '" << options << "'";
296 return false;
297 }
298 ParseJdwpOption(pairs[i].substr(0, equals), pairs[i].substr(equals + 1));
299 }
300
Elliott Hughes376a7a02011-10-24 18:35:55 -0700301 if (gJdwpOptions.transport == JDWP::kJdwpTransportUnknown) {
Elliott Hughes3bb81562011-10-21 18:52:59 -0700302 LOG(ERROR) << "Must specify JDWP transport: " << options;
303 }
Elliott Hughes376a7a02011-10-24 18:35:55 -0700304 if (!gJdwpOptions.server && (gJdwpOptions.host.empty() || gJdwpOptions.port == 0)) {
Elliott Hughes3bb81562011-10-21 18:52:59 -0700305 LOG(ERROR) << "Must specify JDWP host and port when server=n: " << options;
306 return false;
307 }
308
309 gJdwpConfigured = true;
310 return true;
311}
312
Elliott Hughesd1cc8362011-10-24 16:58:50 -0700313void Dbg::StartJdwp() {
Elliott Hughes376a7a02011-10-24 18:35:55 -0700314 if (!gJdwpAllowed || !gJdwpConfigured) {
315 // No JDWP for you!
316 return;
317 }
318
Elliott Hughes475fc232011-10-25 15:00:35 -0700319 CHECK(gRegistry == NULL);
320 gRegistry = new ObjectRegistry;
321
Elliott Hughesd1cc8362011-10-24 16:58:50 -0700322 // Init JDWP if the debugger is enabled. This may connect out to a
323 // debugger, passively listen for a debugger, or block waiting for a
324 // debugger.
Elliott Hughes376a7a02011-10-24 18:35:55 -0700325 gJdwpState = JDWP::JdwpState::Create(&gJdwpOptions);
326 if (gJdwpState == NULL) {
Elliott Hughesf8a2df72011-12-01 12:19:54 -0800327 // We probably failed because some other process has the port already, which means that
328 // if we don't abort the user is likely to think they're talking to us when they're actually
329 // talking to that other process.
330 LOG(FATAL) << "debugger thread failed to initialize";
Elliott Hughesd1cc8362011-10-24 16:58:50 -0700331 }
332
333 // If a debugger has already attached, send the "welcome" message.
334 // This may cause us to suspend all threads.
Elliott Hughes376a7a02011-10-24 18:35:55 -0700335 if (gJdwpState->IsActive()) {
Elliott Hughesa2155262011-11-16 16:26:58 -0800336 //ScopedThreadStateChange tsc(Thread::Current(), Thread::kRunnable);
Elliott Hughes376a7a02011-10-24 18:35:55 -0700337 if (!gJdwpState->PostVMStart()) {
Elliott Hughesd1cc8362011-10-24 16:58:50 -0700338 LOG(WARNING) << "failed to post 'start' message to debugger";
339 }
340 }
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700341}
342
Elliott Hughesd1cc8362011-10-24 16:58:50 -0700343void Dbg::StopJdwp() {
Elliott Hughes376a7a02011-10-24 18:35:55 -0700344 delete gJdwpState;
Elliott Hughes475fc232011-10-25 15:00:35 -0700345 delete gRegistry;
346 gRegistry = NULL;
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700347}
348
Elliott Hughes767a1472011-10-26 18:49:02 -0700349void Dbg::GcDidFinish() {
350 if (gDdmHpifWhen != HPIF_WHEN_NEVER) {
351 LOG(DEBUG) << "Sending VM heap info to DDM";
Elliott Hughes7162ad92011-10-27 14:08:42 -0700352 DdmSendHeapInfo(gDdmHpifWhen);
Elliott Hughes767a1472011-10-26 18:49:02 -0700353 }
354 if (gDdmHpsgWhen != HPSG_WHEN_NEVER) {
355 LOG(DEBUG) << "Dumping VM heap to DDM";
Elliott Hughes6a5bd492011-10-28 14:33:57 -0700356 DdmSendHeapSegments(false);
Elliott Hughes767a1472011-10-26 18:49:02 -0700357 }
358 if (gDdmNhsgWhen != HPSG_WHEN_NEVER) {
359 LOG(DEBUG) << "Dumping native heap to DDM";
Elliott Hughes6a5bd492011-10-28 14:33:57 -0700360 DdmSendHeapSegments(true);
Elliott Hughes767a1472011-10-26 18:49:02 -0700361 }
362}
363
Elliott Hughes4ffd3132011-10-24 12:06:42 -0700364void Dbg::SetJdwpAllowed(bool allowed) {
365 gJdwpAllowed = allowed;
366}
367
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700368DebugInvokeReq* Dbg::GetInvokeReq() {
Elliott Hughes475fc232011-10-25 15:00:35 -0700369 return Thread::Current()->GetInvokeReq();
370}
371
372Thread* Dbg::GetDebugThread() {
373 return (gJdwpState != NULL) ? gJdwpState->GetDebugThread() : NULL;
374}
375
376void Dbg::ClearWaitForEventThread() {
377 gJdwpState->ClearWaitForEventThread();
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700378}
379
380void Dbg::Connected() {
Elliott Hughes3bb81562011-10-21 18:52:59 -0700381 CHECK(!gDebuggerConnected);
382 LOG(VERBOSE) << "JDWP has attached";
383 gDebuggerConnected = true;
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700384}
385
Elliott Hughesa2155262011-11-16 16:26:58 -0800386void Dbg::GoActive() {
387 // Enable all debugging features, including scans for breakpoints.
388 // This is a no-op if we're already active.
389 // Only called from the JDWP handler thread.
390 if (gDebuggerActive) {
391 return;
392 }
393
394 LOG(INFO) << "Debugger is active";
395
396 // TODO: CHECK we don't have any outstanding breakpoints.
397
398 gDebuggerActive = true;
399
400 //dvmEnableAllSubMode(kSubModeDebuggerActive);
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700401}
402
403void Dbg::Disconnected() {
Elliott Hughes234ab152011-10-26 14:02:26 -0700404 CHECK(gDebuggerConnected);
405
406 gDebuggerActive = false;
407
408 //dvmDisableAllSubMode(kSubModeDebuggerActive);
409
410 gRegistry->Clear();
411 gDebuggerConnected = false;
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700412}
413
414bool Dbg::IsDebuggerConnected() {
Elliott Hughes3bb81562011-10-21 18:52:59 -0700415 return gDebuggerActive;
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700416}
417
418bool Dbg::IsDebuggingEnabled() {
Elliott Hughes3bb81562011-10-21 18:52:59 -0700419 return gJdwpConfigured;
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700420}
421
422int64_t Dbg::LastDebuggerActivity() {
Elliott Hughesca951522011-12-05 12:01:32 -0800423 return gJdwpState->LastDebuggerActivity();
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700424}
425
426int Dbg::ThreadRunning() {
Elliott Hughesd1cc8362011-10-24 16:58:50 -0700427 return static_cast<int>(Thread::Current()->SetState(Thread::kRunnable));
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700428}
429
430int Dbg::ThreadWaiting() {
Elliott Hughesd1cc8362011-10-24 16:58:50 -0700431 return static_cast<int>(Thread::Current()->SetState(Thread::kVmWait));
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700432}
433
Elliott Hughes6ba581a2011-10-25 11:45:35 -0700434int Dbg::ThreadContinuing(int new_state) {
435 return static_cast<int>(Thread::Current()->SetState(static_cast<Thread::State>(new_state)));
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700436}
437
438void Dbg::UndoDebuggerSuspensions() {
Elliott Hughes234ab152011-10-26 14:02:26 -0700439 Runtime::Current()->GetThreadList()->UndoDebuggerSuspensions();
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700440}
441
442void Dbg::Exit(int status) {
Elliott Hughes1bba14f2011-12-01 18:00:36 -0800443 exit(status); // This is all dalvik did.
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700444}
445
Elliott Hughesbfe487b2011-10-26 15:48:55 -0700446void Dbg::VisitRoots(Heap::RootVisitor* visitor, void* arg) {
447 if (gRegistry != NULL) {
448 gRegistry->VisitRoots(visitor, arg);
449 }
450}
451
Elliott Hughesa2155262011-11-16 16:26:58 -0800452std::string Dbg::GetClassDescriptor(JDWP::RefTypeId classId) {
453 Class* c = gRegistry->Get<Class*>(classId);
454 return c->GetDescriptor()->ToModifiedUtf8();
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700455}
456
457JDWP::ObjectId Dbg::GetClassObject(JDWP::RefTypeId id) {
458 UNIMPLEMENTED(FATAL);
459 return 0;
460}
461
462JDWP::RefTypeId Dbg::GetSuperclass(JDWP::RefTypeId id) {
Elliott Hughesa2e54f62011-11-17 13:01:30 -0800463 Class* c = gRegistry->Get<Class*>(id);
464 return gRegistry->Add(c->GetSuperClass());
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700465}
466
467JDWP::ObjectId Dbg::GetClassLoader(JDWP::RefTypeId id) {
Elliott Hughes1bba14f2011-12-01 18:00:36 -0800468 Object* o = gRegistry->Get<Object*>(id);
469 return gRegistry->Add(o->GetClass()->GetClassLoader());
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700470}
471
472uint32_t Dbg::GetAccessFlags(JDWP::RefTypeId id) {
Elliott Hughes6fa602d2011-12-02 17:54:25 -0800473 Class* c = gRegistry->Get<Class*>(id);
474 return c->GetAccessFlags() & kAccJavaFlagsMask;
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700475}
476
Elliott Hughesaed4be92011-12-02 16:16:23 -0800477bool Dbg::IsInterface(JDWP::RefTypeId classId) {
478 Class* c = gRegistry->Get<Class*>(classId);
479 return c->IsInterface();
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700480}
481
Elliott Hughesa2155262011-11-16 16:26:58 -0800482void Dbg::GetClassList(uint32_t* pClassCount, JDWP::RefTypeId** pClasses) {
483 // Get the complete list of reference classes (i.e. all classes except
484 // the primitive types).
485 // Returns a newly-allocated buffer full of RefTypeId values.
486 struct ClassListCreator {
487 static bool Visit(Class* c, void* arg) {
488 return reinterpret_cast<ClassListCreator*>(arg)->Visit(c);
489 }
490
491 bool Visit(Class* c) {
492 if (!c->IsPrimitive()) {
493 classes.push_back(static_cast<JDWP::RefTypeId>(gRegistry->Add(c)));
494 }
495 return true;
496 }
497
498 std::vector<JDWP::RefTypeId> classes;
499 };
500
501 ClassListCreator clc;
502 Runtime::Current()->GetClassLinker()->VisitClasses(ClassListCreator::Visit, &clc);
503 *pClassCount = clc.classes.size();
504 *pClasses = new JDWP::RefTypeId[clc.classes.size()];
505 for (size_t i = 0; i < clc.classes.size(); ++i) {
506 (*pClasses)[i] = clc.classes[i];
507 }
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700508}
509
510void Dbg::GetVisibleClassList(JDWP::ObjectId classLoaderId, uint32_t* pNumClasses, JDWP::RefTypeId** pClassRefBuf) {
511 UNIMPLEMENTED(FATAL);
512}
513
Elliott Hughes6fa602d2011-12-02 17:54:25 -0800514void Dbg::GetClassInfo(JDWP::RefTypeId classId, JDWP::JdwpTypeTag* pTypeTag, uint32_t* pStatus, std::string* pDescriptor) {
Elliott Hughesa2155262011-11-16 16:26:58 -0800515 Class* c = gRegistry->Get<Class*>(classId);
516 if (c->IsArrayClass()) {
517 *pStatus = JDWP::CS_VERIFIED | JDWP::CS_PREPARED;
518 *pTypeTag = JDWP::TT_ARRAY;
519 } else {
520 if (c->IsErroneous()) {
521 *pStatus = JDWP::CS_ERROR;
522 } else {
523 *pStatus = JDWP::CS_VERIFIED | JDWP::CS_PREPARED | JDWP::CS_INITIALIZED;
524 }
525 *pTypeTag = c->IsInterface() ? JDWP::TT_INTERFACE : JDWP::TT_CLASS;
526 }
527
528 if (pDescriptor != NULL) {
529 *pDescriptor = c->GetDescriptor()->ToModifiedUtf8();
530 }
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700531}
532
Elliott Hughes6fa602d2011-12-02 17:54:25 -0800533void Dbg::FindLoadedClassBySignature(const char* descriptor, std::vector<JDWP::RefTypeId>& ids) {
534 std::vector<Class*> classes;
535 Runtime::Current()->GetClassLinker()->LookupClasses(descriptor, classes);
536 ids.clear();
537 for (size_t i = 0; i < classes.size(); ++i) {
538 ids.push_back(gRegistry->Add(classes[i]));
539 }
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700540}
541
Elliott Hughes6fa602d2011-12-02 17:54:25 -0800542void Dbg::GetObjectType(JDWP::ObjectId objectId, JDWP::JdwpTypeTag* pRefTypeTag, JDWP::RefTypeId* pRefTypeId) {
Elliott Hughes499c5132011-11-17 14:55:11 -0800543 Object* o = gRegistry->Get<Object*>(objectId);
544 if (o->GetClass()->IsArrayClass()) {
545 *pRefTypeTag = JDWP::TT_ARRAY;
546 } else if (o->GetClass()->IsInterface()) {
547 *pRefTypeTag = JDWP::TT_INTERFACE;
548 } else {
549 *pRefTypeTag = JDWP::TT_CLASS;
550 }
551 *pRefTypeId = gRegistry->Add(o->GetClass());
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700552}
553
554uint8_t Dbg::GetClassObjectType(JDWP::RefTypeId refTypeId) {
555 UNIMPLEMENTED(FATAL);
556 return 0;
557}
558
Elliott Hughesa2e54f62011-11-17 13:01:30 -0800559std::string Dbg::GetSignature(JDWP::RefTypeId refTypeId) {
560 Class* c = gRegistry->Get<Class*>(refTypeId);
561 CHECK(c != NULL);
562 return c->GetDescriptor()->ToModifiedUtf8();
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700563}
564
Elliott Hughes03181a82011-11-17 17:22:21 -0800565bool Dbg::GetSourceFile(JDWP::RefTypeId refTypeId, std::string& result) {
566 Class* c = gRegistry->Get<Class*>(refTypeId);
567 CHECK(c != NULL);
568
569 String* source_file = c->GetSourceFile();
570 if (source_file == NULL) {
571 return false;
572 }
573 result = source_file->ToModifiedUtf8();
574 return true;
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700575}
576
577const char* Dbg::GetObjectTypeName(JDWP::ObjectId objectId) {
578 UNIMPLEMENTED(FATAL);
579 return NULL;
580}
581
582uint8_t Dbg::GetObjectTag(JDWP::ObjectId objectId) {
Elliott Hughes24437992011-11-30 14:49:33 -0800583 Object* o = gRegistry->Get<Object*>(objectId);
584 return TagFromObject(o);
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700585}
586
Elliott Hughesaed4be92011-12-02 16:16:23 -0800587size_t Dbg::GetTagWidth(JDWP::JdwpTag tag) {
Elliott Hughesdbb40792011-11-18 17:05:22 -0800588 switch (tag) {
589 case JDWP::JT_VOID:
590 return 0;
591 case JDWP::JT_BYTE:
592 case JDWP::JT_BOOLEAN:
593 return 1;
594 case JDWP::JT_CHAR:
595 case JDWP::JT_SHORT:
596 return 2;
597 case JDWP::JT_FLOAT:
598 case JDWP::JT_INT:
599 return 4;
600 case JDWP::JT_ARRAY:
601 case JDWP::JT_OBJECT:
602 case JDWP::JT_STRING:
603 case JDWP::JT_THREAD:
604 case JDWP::JT_THREAD_GROUP:
605 case JDWP::JT_CLASS_LOADER:
606 case JDWP::JT_CLASS_OBJECT:
607 return sizeof(JDWP::ObjectId);
608 case JDWP::JT_DOUBLE:
609 case JDWP::JT_LONG:
610 return 8;
611 default:
612 LOG(FATAL) << "unknown tag " << tag;
613 return -1;
614 }
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700615}
616
617int Dbg::GetArrayLength(JDWP::ObjectId arrayId) {
Elliott Hughes68fdbd02011-11-29 19:22:47 -0800618 Object* o = gRegistry->Get<Object*>(arrayId);
619 Array* a = o->AsArray();
620 return a->GetLength();
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700621}
622
623uint8_t Dbg::GetArrayElementTag(JDWP::ObjectId arrayId) {
Elliott Hughes24437992011-11-30 14:49:33 -0800624 Object* o = gRegistry->Get<Object*>(arrayId);
625 Array* a = o->AsArray();
626 std::string descriptor(a->GetClass()->GetDescriptor()->ToModifiedUtf8());
627 JDWP::JdwpTag tag = BasicTagFromDescriptor(descriptor.c_str() + 1);
628 if (!IsPrimitiveTag(tag)) {
629 tag = TagFromClass(a->GetClass()->GetComponentType());
630 }
631 return tag;
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700632}
633
Elliott Hughes24437992011-11-30 14:49:33 -0800634bool Dbg::OutputArray(JDWP::ObjectId arrayId, int offset, int count, JDWP::ExpandBuf* pReply) {
635 Object* o = gRegistry->Get<Object*>(arrayId);
636 Array* a = o->AsArray();
637
638 if (offset < 0 || count < 0 || offset > a->GetLength() || a->GetLength() - offset < count) {
639 LOG(WARNING) << __FUNCTION__ << " access out of bounds: offset=" << offset << "; count=" << count;
640 return false;
641 }
642
643 std::string descriptor(a->GetClass()->GetDescriptor()->ToModifiedUtf8());
644 JDWP::JdwpTag tag = BasicTagFromDescriptor(descriptor.c_str() + 1);
645
646 if (IsPrimitiveTag(tag)) {
647 size_t width = GetTagWidth(tag);
648 const uint8_t* src = reinterpret_cast<uint8_t*>(a->GetRawData());
649 uint8_t* dst = expandBufAddSpace(pReply, count * width);
650 if (width == 8) {
651 const uint64_t* src8 = reinterpret_cast<const uint64_t*>(src);
652 for (int i = 0; i < count; ++i) JDWP::Write8BE(&dst, src8[offset + i]);
653 } else if (width == 4) {
654 const uint32_t* src4 = reinterpret_cast<const uint32_t*>(src);
655 for (int i = 0; i < count; ++i) JDWP::Write4BE(&dst, src4[offset + i]);
656 } else if (width == 2) {
657 const uint16_t* src2 = reinterpret_cast<const uint16_t*>(src);
658 for (int i = 0; i < count; ++i) JDWP::Write2BE(&dst, src2[offset + i]);
659 } else {
660 memcpy(dst, &src[offset * width], count * width);
661 }
662 } else {
663 ObjectArray<Object>* oa = a->AsObjectArray<Object>();
664 for (int i = 0; i < count; ++i) {
Elliott Hughesf03b8f62011-12-02 14:26:25 -0800665 Object* element = oa->Get(offset + i);
Elliott Hughes24437992011-11-30 14:49:33 -0800666 JDWP::JdwpTag specific_tag = (element != NULL) ? TagFromObject(element) : tag;
667 expandBufAdd1(pReply, specific_tag);
668 expandBufAddObjectId(pReply, gRegistry->Add(element));
669 }
670 }
671
672 return true;
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700673}
674
Elliott Hughesf03b8f62011-12-02 14:26:25 -0800675bool Dbg::SetArrayElements(JDWP::ObjectId arrayId, int offset, int count, const uint8_t* src) {
676 Object* o = gRegistry->Get<Object*>(arrayId);
677 Array* a = o->AsArray();
678
679 if (offset < 0 || count < 0 || offset > a->GetLength() || a->GetLength() - offset < count) {
680 LOG(WARNING) << __FUNCTION__ << " access out of bounds: offset=" << offset << "; count=" << count;
681 return false;
682 }
683
684 std::string descriptor(a->GetClass()->GetDescriptor()->ToModifiedUtf8());
685 JDWP::JdwpTag tag = BasicTagFromDescriptor(descriptor.c_str() + 1);
686
687 if (IsPrimitiveTag(tag)) {
688 size_t width = GetTagWidth(tag);
689 uint8_t* dst = &(reinterpret_cast<uint8_t*>(a->GetRawData())[offset * width]);
690 if (width == 8) {
691 for (int i = 0; i < count; ++i) {
692 // Handle potentially non-aligned memory access one byte at a time for ARM's benefit.
693 uint64_t value;
694 for (size_t j = 0; j < sizeof(uint64_t); ++j) reinterpret_cast<uint8_t*>(&value)[j] = src[j];
695 src += sizeof(uint64_t);
696 JDWP::Write8BE(&dst, value);
697 }
698 } else if (width == 4) {
699 const uint32_t* src4 = reinterpret_cast<const uint32_t*>(src);
700 for (int i = 0; i < count; ++i) JDWP::Write4BE(&dst, src4[i]);
701 } else if (width == 2) {
702 const uint16_t* src2 = reinterpret_cast<const uint16_t*>(src);
703 for (int i = 0; i < count; ++i) JDWP::Write2BE(&dst, src2[i]);
704 } else {
705 memcpy(&dst[offset * width], src, count * width);
706 }
707 } else {
708 ObjectArray<Object>* oa = a->AsObjectArray<Object>();
709 for (int i = 0; i < count; ++i) {
710 JDWP::ObjectId id = JDWP::ReadObjectId(&src);
711 oa->Set(offset + i, gRegistry->Get<Object*>(id));
712 }
713 }
714
715 return true;
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700716}
717
718JDWP::ObjectId Dbg::CreateString(const char* str) {
719 UNIMPLEMENTED(FATAL);
720 return 0;
721}
722
723JDWP::ObjectId Dbg::CreateObject(JDWP::RefTypeId classId) {
724 UNIMPLEMENTED(FATAL);
725 return 0;
726}
727
728JDWP::ObjectId Dbg::CreateArrayObject(JDWP::RefTypeId arrayTypeId, uint32_t length) {
729 UNIMPLEMENTED(FATAL);
730 return 0;
731}
732
733bool Dbg::MatchType(JDWP::RefTypeId instClassId, JDWP::RefTypeId classId) {
734 UNIMPLEMENTED(FATAL);
735 return false;
736}
737
Elliott Hughes03181a82011-11-17 17:22:21 -0800738JDWP::FieldId ToFieldId(Field* f) {
739#ifdef MOVING_GARBAGE_COLLECTOR
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700740 UNIMPLEMENTED(FATAL);
Elliott Hughes03181a82011-11-17 17:22:21 -0800741#else
742 return static_cast<JDWP::FieldId>(reinterpret_cast<uintptr_t>(f));
743#endif
744}
745
746JDWP::MethodId ToMethodId(Method* m) {
747#ifdef MOVING_GARBAGE_COLLECTOR
748 UNIMPLEMENTED(FATAL);
749#else
750 return static_cast<JDWP::MethodId>(reinterpret_cast<uintptr_t>(m));
751#endif
752}
753
Elliott Hughesaed4be92011-12-02 16:16:23 -0800754Field* FromFieldId(JDWP::FieldId fid) {
755#ifdef MOVING_GARBAGE_COLLECTOR
756 UNIMPLEMENTED(FATAL);
757#else
758 return reinterpret_cast<Field*>(static_cast<uintptr_t>(fid));
759#endif
760}
761
Elliott Hughes03181a82011-11-17 17:22:21 -0800762Method* FromMethodId(JDWP::MethodId mid) {
763#ifdef MOVING_GARBAGE_COLLECTOR
764 UNIMPLEMENTED(FATAL);
765#else
766 return reinterpret_cast<Method*>(static_cast<uintptr_t>(mid));
767#endif
768}
769
770std::string Dbg::GetMethodName(JDWP::RefTypeId refTypeId, JDWP::MethodId methodId) {
771 return FromMethodId(methodId)->GetName()->ToModifiedUtf8();
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700772}
773
Elliott Hughesa2e54f62011-11-17 13:01:30 -0800774/*
775 * Augment the access flags for synthetic methods and fields by setting
776 * the (as described by the spec) "0xf0000000 bit". Also, strip out any
777 * flags not specified by the Java programming language.
778 */
779static uint32_t MangleAccessFlags(uint32_t accessFlags) {
780 accessFlags &= kAccJavaFlagsMask;
781 if ((accessFlags & kAccSynthetic) != 0) {
782 accessFlags |= 0xf0000000;
783 }
784 return accessFlags;
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700785}
786
Elliott Hughesdbb40792011-11-18 17:05:22 -0800787static const uint16_t kEclipseWorkaroundSlot = 1000;
788
789/*
790 * Eclipse appears to expect that the "this" reference is in slot zero.
791 * If it's not, the "variables" display will show two copies of "this",
792 * possibly because it gets "this" from SF.ThisObject and then displays
793 * all locals with nonzero slot numbers.
794 *
795 * So, we remap the item in slot 0 to 1000, and remap "this" to zero. On
796 * SF.GetValues / SF.SetValues we map them back.
Elliott Hughesc5b734a2011-12-01 17:20:58 -0800797 *
798 * TODO: jdb uses the value to determine whether a variable is a local or an argument,
799 * by checking whether it's less than the number of arguments. To make that work, we'd
800 * have to "mangle" all the arguments to come first, not just the implicit argument 'this'.
Elliott Hughesdbb40792011-11-18 17:05:22 -0800801 */
802static uint16_t MangleSlot(uint16_t slot, const char* name) {
803 uint16_t newSlot = slot;
804 if (strcmp(name, "this") == 0) {
805 newSlot = 0;
806 } else if (slot == 0) {
807 newSlot = kEclipseWorkaroundSlot;
808 }
809 return newSlot;
810}
811
Elliott Hughes68fdbd02011-11-29 19:22:47 -0800812static uint16_t DemangleSlot(uint16_t slot, Frame& f) {
Elliott Hughesdbb40792011-11-18 17:05:22 -0800813 if (slot == kEclipseWorkaroundSlot) {
Elliott Hughes68fdbd02011-11-29 19:22:47 -0800814 return 0;
Elliott Hughesdbb40792011-11-18 17:05:22 -0800815 } else if (slot == 0) {
Elliott Hughesdbb40792011-11-18 17:05:22 -0800816 Method* m = f.GetMethod();
Elliott Hughes68fdbd02011-11-29 19:22:47 -0800817 return m->NumRegisters() - m->NumIns();
Elliott Hughesdbb40792011-11-18 17:05:22 -0800818 }
Elliott Hughes68fdbd02011-11-29 19:22:47 -0800819 return slot;
Elliott Hughesdbb40792011-11-18 17:05:22 -0800820}
821
Elliott Hughesc5b734a2011-12-01 17:20:58 -0800822void Dbg::OutputDeclaredFields(JDWP::RefTypeId refTypeId, bool with_generic, JDWP::ExpandBuf* pReply) {
Elliott Hughesa2e54f62011-11-17 13:01:30 -0800823 Class* c = gRegistry->Get<Class*>(refTypeId);
824 CHECK(c != NULL);
825
826 size_t instance_field_count = c->NumInstanceFields();
827 size_t static_field_count = c->NumStaticFields();
828
829 expandBufAdd4BE(pReply, instance_field_count + static_field_count);
830
831 for (size_t i = 0; i < instance_field_count + static_field_count; ++i) {
832 Field* f = (i < instance_field_count) ? c->GetInstanceField(i) : c->GetStaticField(i - instance_field_count);
833
834 expandBufAddFieldId(pReply, ToFieldId(f));
835 expandBufAddUtf8String(pReply, f->GetName()->ToModifiedUtf8().c_str());
836 expandBufAddUtf8String(pReply, f->GetTypeDescriptor());
Elliott Hughesc5b734a2011-12-01 17:20:58 -0800837 if (with_generic) {
Elliott Hughesa2e54f62011-11-17 13:01:30 -0800838 static const char genericSignature[1] = "";
839 expandBufAddUtf8String(pReply, genericSignature);
840 }
841 expandBufAdd4BE(pReply, MangleAccessFlags(f->GetAccessFlags()));
842 }
843}
844
Elliott Hughesc5b734a2011-12-01 17:20:58 -0800845void Dbg::OutputDeclaredMethods(JDWP::RefTypeId refTypeId, bool with_generic, JDWP::ExpandBuf* pReply) {
Elliott Hughesa2e54f62011-11-17 13:01:30 -0800846 Class* c = gRegistry->Get<Class*>(refTypeId);
847 CHECK(c != NULL);
848
849 size_t direct_method_count = c->NumDirectMethods();
850 size_t virtual_method_count = c->NumVirtualMethods();
851
852 expandBufAdd4BE(pReply, direct_method_count + virtual_method_count);
853
854 for (size_t i = 0; i < direct_method_count + virtual_method_count; ++i) {
855 Method* m = (i < direct_method_count) ? c->GetDirectMethod(i) : c->GetVirtualMethod(i - direct_method_count);
856
857 expandBufAddMethodId(pReply, ToMethodId(m));
858 expandBufAddUtf8String(pReply, m->GetName()->ToModifiedUtf8().c_str());
859 expandBufAddUtf8String(pReply, m->GetSignature()->ToModifiedUtf8().c_str());
Elliott Hughesc5b734a2011-12-01 17:20:58 -0800860 if (with_generic) {
Elliott Hughesa2e54f62011-11-17 13:01:30 -0800861 static const char genericSignature[1] = "";
862 expandBufAddUtf8String(pReply, genericSignature);
863 }
864 expandBufAdd4BE(pReply, MangleAccessFlags(m->GetAccessFlags()));
865 }
866}
867
868void Dbg::OutputDeclaredInterfaces(JDWP::RefTypeId refTypeId, JDWP::ExpandBuf* pReply) {
869 Class* c = gRegistry->Get<Class*>(refTypeId);
870 CHECK(c != NULL);
871 size_t interface_count = c->NumInterfaces();
872 expandBufAdd4BE(pReply, interface_count);
873 for (size_t i = 0; i < interface_count; ++i) {
874 expandBufAddRefTypeId(pReply, gRegistry->Add(c->GetInterface(i)));
875 }
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700876}
877
878void Dbg::OutputLineTable(JDWP::RefTypeId refTypeId, JDWP::MethodId methodId, JDWP::ExpandBuf* pReply) {
Elliott Hughes03181a82011-11-17 17:22:21 -0800879 struct DebugCallbackContext {
880 int numItems;
881 JDWP::ExpandBuf* pReply;
882
883 static bool Callback(void* context, uint32_t address, uint32_t lineNum) {
884 DebugCallbackContext* pContext = reinterpret_cast<DebugCallbackContext*>(context);
885 expandBufAdd8BE(pContext->pReply, address);
886 expandBufAdd4BE(pContext->pReply, lineNum);
887 pContext->numItems++;
888 return true;
889 }
890 };
891
892 Method* m = FromMethodId(methodId);
893 ClassLinker* class_linker = Runtime::Current()->GetClassLinker();
894 const DexFile& dex_file = class_linker->FindDexFile(m->GetDeclaringClass()->GetDexCache());
895 const DexFile::CodeItem* code_item = dex_file.GetCodeItem(m->GetCodeItemOffset());
896
897 uint64_t start, end;
898 if (m->IsNative()) {
899 start = -1;
900 end = -1;
901 } else {
902 start = 0;
903 end = code_item->insns_size_in_code_units_; // TODO: what are the units supposed to be? *2?
904 }
905
906 expandBufAdd8BE(pReply, start);
907 expandBufAdd8BE(pReply, end);
908
909 // Add numLines later
910 size_t numLinesOffset = expandBufGetLength(pReply);
911 expandBufAdd4BE(pReply, 0);
912
913 DebugCallbackContext context;
914 context.numItems = 0;
915 context.pReply = pReply;
916
917 dex_file.DecodeDebugInfo(code_item, m, DebugCallbackContext::Callback, NULL, &context);
918
919 JDWP::Set4BE(expandBufGetBuffer(pReply) + numLinesOffset, context.numItems);
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700920}
921
Elliott Hughesc5b734a2011-12-01 17:20:58 -0800922void Dbg::OutputVariableTable(JDWP::RefTypeId refTypeId, JDWP::MethodId methodId, bool with_generic, JDWP::ExpandBuf* pReply) {
Elliott Hughesdbb40792011-11-18 17:05:22 -0800923 struct DebugCallbackContext {
Elliott Hughesdbb40792011-11-18 17:05:22 -0800924 JDWP::ExpandBuf* pReply;
Elliott Hughesc5b734a2011-12-01 17:20:58 -0800925 size_t variable_count;
926 bool with_generic;
Elliott Hughesdbb40792011-11-18 17:05:22 -0800927
Elliott Hughesc5b734a2011-12-01 17:20:58 -0800928 static void Callback(void* context, uint16_t slot, uint32_t startAddress, uint32_t endAddress, const char* name, const char* descriptor, const char* signature) {
Elliott Hughesdbb40792011-11-18 17:05:22 -0800929 DebugCallbackContext* pContext = reinterpret_cast<DebugCallbackContext*>(context);
930
Elliott Hughesc5b734a2011-12-01 17:20:58 -0800931 LOG(VERBOSE) << StringPrintf(" %2d: %d(%d) '%s' '%s' '%s' slot=%d", pContext->variable_count, startAddress, endAddress - startAddress, name, descriptor, signature, slot);
Elliott Hughesdbb40792011-11-18 17:05:22 -0800932
Elliott Hughes68fdbd02011-11-29 19:22:47 -0800933 slot = MangleSlot(slot, name);
934
Elliott Hughesdbb40792011-11-18 17:05:22 -0800935 expandBufAdd8BE(pContext->pReply, startAddress);
936 expandBufAddUtf8String(pContext->pReply, name);
937 expandBufAddUtf8String(pContext->pReply, descriptor);
Elliott Hughesc5b734a2011-12-01 17:20:58 -0800938 if (pContext->with_generic) {
Elliott Hughesdbb40792011-11-18 17:05:22 -0800939 expandBufAddUtf8String(pContext->pReply, signature);
940 }
941 expandBufAdd4BE(pContext->pReply, endAddress - startAddress);
942 expandBufAdd4BE(pContext->pReply, slot);
943
Elliott Hughesc5b734a2011-12-01 17:20:58 -0800944 ++pContext->variable_count;
Elliott Hughesdbb40792011-11-18 17:05:22 -0800945 }
946 };
947
948 Method* m = FromMethodId(methodId);
949 ClassLinker* class_linker = Runtime::Current()->GetClassLinker();
950 const DexFile& dex_file = class_linker->FindDexFile(m->GetDeclaringClass()->GetDexCache());
951 const DexFile::CodeItem* code_item = dex_file.GetCodeItem(m->GetCodeItemOffset());
952
Elliott Hughesc5b734a2011-12-01 17:20:58 -0800953 // arg_count considers doubles and longs to take 2 units.
954 // variable_count considers everything to take 1 unit.
955 std::string shorty(m->GetShorty()->ToModifiedUtf8());
956 expandBufAdd4BE(pReply, m->NumArgRegisters(shorty));
Elliott Hughesdbb40792011-11-18 17:05:22 -0800957
Elliott Hughesc5b734a2011-12-01 17:20:58 -0800958 // We don't know the total number of variables yet, so leave a blank and update it later.
959 size_t variable_count_offset = expandBufGetLength(pReply);
Elliott Hughesdbb40792011-11-18 17:05:22 -0800960 expandBufAdd4BE(pReply, 0);
961
962 DebugCallbackContext context;
Elliott Hughesdbb40792011-11-18 17:05:22 -0800963 context.pReply = pReply;
Elliott Hughesc5b734a2011-12-01 17:20:58 -0800964 context.variable_count = 0;
965 context.with_generic = with_generic;
Elliott Hughesdbb40792011-11-18 17:05:22 -0800966
967 dex_file.DecodeDebugInfo(code_item, m, NULL, DebugCallbackContext::Callback, &context);
968
Elliott Hughesc5b734a2011-12-01 17:20:58 -0800969 JDWP::Set4BE(expandBufGetBuffer(pReply) + variable_count_offset, context.variable_count);
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700970}
971
Elliott Hughesaed4be92011-12-02 16:16:23 -0800972JDWP::JdwpTag Dbg::GetFieldBasicTag(JDWP::FieldId fieldId) {
973 return BasicTagFromDescriptor(FromFieldId(fieldId)->GetTypeDescriptor());
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700974}
975
Elliott Hughesaed4be92011-12-02 16:16:23 -0800976JDWP::JdwpTag Dbg::GetStaticFieldBasicTag(JDWP::FieldId fieldId) {
977 return BasicTagFromDescriptor(FromFieldId(fieldId)->GetTypeDescriptor());
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700978}
979
980void Dbg::GetFieldValue(JDWP::ObjectId objectId, JDWP::FieldId fieldId, JDWP::ExpandBuf* pReply) {
Elliott Hughesaed4be92011-12-02 16:16:23 -0800981 Object* o = gRegistry->Get<Object*>(objectId);
982 Field* f = FromFieldId(fieldId);
983
984 JDWP::JdwpTag tag = BasicTagFromDescriptor(f->GetTypeDescriptor());
985
986 if (IsPrimitiveTag(tag)) {
987 expandBufAdd1(pReply, tag);
988 if (tag == JDWP::JT_BOOLEAN || tag == JDWP::JT_BYTE) {
989 expandBufAdd1(pReply, f->Get32(o));
990 } else if (tag == JDWP::JT_CHAR || tag == JDWP::JT_SHORT) {
991 expandBufAdd2BE(pReply, f->Get32(o));
992 } else if (tag == JDWP::JT_FLOAT || tag == JDWP::JT_INT) {
993 expandBufAdd4BE(pReply, f->Get32(o));
994 } else if (tag == JDWP::JT_DOUBLE || tag == JDWP::JT_LONG) {
995 expandBufAdd8BE(pReply, f->Get64(o));
996 } else {
997 LOG(FATAL) << "unknown tag: " << tag;
998 }
999 } else {
1000 Object* value = f->GetObject(o);
1001 expandBufAdd1(pReply, TagFromObject(value));
1002 expandBufAddObjectId(pReply, gRegistry->Add(value));
1003 }
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001004}
1005
1006void Dbg::SetFieldValue(JDWP::ObjectId objectId, JDWP::FieldId fieldId, uint64_t value, int width) {
Elliott Hughesaed4be92011-12-02 16:16:23 -08001007 Object* o = gRegistry->Get<Object*>(objectId);
1008 Field* f = FromFieldId(fieldId);
1009
1010 JDWP::JdwpTag tag = BasicTagFromDescriptor(f->GetTypeDescriptor());
1011
1012 if (IsPrimitiveTag(tag)) {
1013 if (tag == JDWP::JT_DOUBLE || tag == JDWP::JT_LONG) {
1014 f->Set64(o, value);
1015 } else {
1016 f->Set32(o, value);
1017 }
1018 } else {
1019 f->SetObject(o, gRegistry->Get<Object*>(value));
1020 }
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001021}
1022
Elliott Hughes6fa602d2011-12-02 17:54:25 -08001023void Dbg::GetStaticFieldValue(JDWP::FieldId fieldId, JDWP::ExpandBuf* pReply) {
1024 GetFieldValue(0, fieldId, pReply);
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001025}
1026
Elliott Hughes6fa602d2011-12-02 17:54:25 -08001027void Dbg::SetStaticFieldValue(JDWP::FieldId fieldId, uint64_t value, int width) {
1028 SetFieldValue(0, fieldId, value, width);
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001029}
1030
Elliott Hughes68fdbd02011-11-29 19:22:47 -08001031std::string Dbg::StringToUtf8(JDWP::ObjectId strId) {
1032 String* s = gRegistry->Get<String*>(strId);
1033 return s->ToModifiedUtf8();
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001034}
1035
Elliott Hughesa2e54f62011-11-17 13:01:30 -08001036Thread* DecodeThread(JDWP::ObjectId threadId) {
1037 Object* thread_peer = gRegistry->Get<Object*>(threadId);
1038 CHECK(thread_peer != NULL);
1039 return Thread::FromManagedThread(thread_peer);
1040}
1041
1042bool Dbg::GetThreadName(JDWP::ObjectId threadId, std::string& name) {
1043 ScopedThreadListLock thread_list_lock;
1044 Thread* thread = DecodeThread(threadId);
1045 if (thread == NULL) {
1046 return false;
1047 }
1048 StringAppendF(&name, "<%d> %s", thread->GetThinLockId(), thread->GetName()->ToModifiedUtf8().c_str());
1049 return true;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001050}
1051
1052JDWP::ObjectId Dbg::GetThreadGroup(JDWP::ObjectId threadId) {
Elliott Hughes499c5132011-11-17 14:55:11 -08001053 Object* thread = gRegistry->Get<Object*>(threadId);
1054 CHECK(thread != NULL);
1055
1056 Class* c = Runtime::Current()->GetClassLinker()->FindSystemClass("Ljava/lang/Thread;");
1057 CHECK(c != NULL);
1058 Field* f = c->FindInstanceField("group", "Ljava/lang/ThreadGroup;");
1059 CHECK(f != NULL);
1060 Object* group = f->GetObject(thread);
1061 CHECK(group != NULL);
1062 return gRegistry->Add(group);
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001063}
1064
Elliott Hughes499c5132011-11-17 14:55:11 -08001065std::string Dbg::GetThreadGroupName(JDWP::ObjectId threadGroupId) {
1066 Object* thread_group = gRegistry->Get<Object*>(threadGroupId);
1067 CHECK(thread_group != NULL);
1068
1069 Class* c = Runtime::Current()->GetClassLinker()->FindSystemClass("Ljava/lang/ThreadGroup;");
1070 CHECK(c != NULL);
1071 Field* f = c->FindInstanceField("name", "Ljava/lang/String;");
1072 CHECK(f != NULL);
1073 String* s = reinterpret_cast<String*>(f->GetObject(thread_group));
1074 return s->ToModifiedUtf8();
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001075}
1076
1077JDWP::ObjectId Dbg::GetThreadGroupParent(JDWP::ObjectId threadGroupId) {
Elliott Hughes4e235312011-12-02 11:34:15 -08001078 Object* thread_group = gRegistry->Get<Object*>(threadGroupId);
1079 CHECK(thread_group != NULL);
1080
1081 Class* c = Runtime::Current()->GetClassLinker()->FindSystemClass("Ljava/lang/ThreadGroup;");
1082 CHECK(c != NULL);
1083 Field* f = c->FindInstanceField("parent", "Ljava/lang/ThreadGroup;");
1084 CHECK(f != NULL);
1085 Object* parent = f->GetObject(thread_group);
1086 return gRegistry->Add(parent);
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001087}
1088
Elliott Hughes499c5132011-11-17 14:55:11 -08001089static Object* GetStaticThreadGroup(const char* field_name) {
1090 Class* c = Runtime::Current()->GetClassLinker()->FindSystemClass("Ljava/lang/ThreadGroup;");
1091 CHECK(c != NULL);
1092 Field* f = c->FindStaticField(field_name, "Ljava/lang/ThreadGroup;");
1093 CHECK(f != NULL);
1094 Object* group = f->GetObject(NULL);
1095 CHECK(group != NULL);
1096 return group;
1097}
1098
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001099JDWP::ObjectId Dbg::GetSystemThreadGroupId() {
Elliott Hughes499c5132011-11-17 14:55:11 -08001100 return gRegistry->Add(GetStaticThreadGroup("mSystem"));
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001101}
1102
1103JDWP::ObjectId Dbg::GetMainThreadGroupId() {
Elliott Hughes499c5132011-11-17 14:55:11 -08001104 return gRegistry->Add(GetStaticThreadGroup("mMain"));
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001105}
1106
Elliott Hughes499c5132011-11-17 14:55:11 -08001107bool Dbg::GetThreadStatus(JDWP::ObjectId threadId, uint32_t* pThreadStatus, uint32_t* pSuspendStatus) {
1108 ScopedThreadListLock thread_list_lock;
1109
1110 Thread* thread = DecodeThread(threadId);
1111 if (thread == NULL) {
1112 return false;
1113 }
1114
1115 switch (thread->GetState()) {
1116 case Thread::kTerminated: *pThreadStatus = JDWP::TS_ZOMBIE; break;
1117 case Thread::kRunnable: *pThreadStatus = JDWP::TS_RUNNING; break;
1118 case Thread::kTimedWaiting: *pThreadStatus = JDWP::TS_SLEEPING; break;
1119 case Thread::kBlocked: *pThreadStatus = JDWP::TS_MONITOR; break;
1120 case Thread::kWaiting: *pThreadStatus = JDWP::TS_WAIT; break;
1121 case Thread::kInitializing: *pThreadStatus = JDWP::TS_ZOMBIE; break;
1122 case Thread::kStarting: *pThreadStatus = JDWP::TS_ZOMBIE; break;
1123 case Thread::kNative: *pThreadStatus = JDWP::TS_RUNNING; break;
1124 case Thread::kVmWait: *pThreadStatus = JDWP::TS_WAIT; break;
1125 case Thread::kSuspended: *pThreadStatus = JDWP::TS_RUNNING; break;
1126 default:
1127 LOG(FATAL) << "unknown thread state " << thread->GetState();
1128 }
1129
1130 *pSuspendStatus = (thread->IsSuspended() ? JDWP::SUSPEND_STATUS_SUSPENDED : 0);
1131
1132 return true;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001133}
1134
1135uint32_t Dbg::GetThreadSuspendCount(JDWP::ObjectId threadId) {
1136 UNIMPLEMENTED(FATAL);
1137 return 0;
1138}
1139
1140bool Dbg::ThreadExists(JDWP::ObjectId threadId) {
Elliott Hughes761928d2011-11-16 18:33:03 -08001141 return DecodeThread(threadId) != NULL;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001142}
1143
1144bool Dbg::IsSuspended(JDWP::ObjectId threadId) {
Elliott Hughes761928d2011-11-16 18:33:03 -08001145 return DecodeThread(threadId)->IsSuspended();
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001146}
1147
1148//void Dbg::WaitForSuspend(JDWP::ObjectId threadId);
1149
Elliott Hughesa2155262011-11-16 16:26:58 -08001150void Dbg::GetThreadGroupThreadsImpl(Object* thread_group, JDWP::ObjectId** ppThreadIds, uint32_t* pThreadCount) {
1151 struct ThreadListVisitor {
1152 static void Visit(Thread* t, void* arg) {
1153 reinterpret_cast<ThreadListVisitor*>(arg)->Visit(t);
1154 }
1155
1156 void Visit(Thread* t) {
1157 if (t == Dbg::GetDebugThread()) {
1158 // Skip the JDWP thread. Some debuggers get bent out of shape when they can't suspend and
1159 // query all threads, so it's easier if we just don't tell them about this thread.
1160 return;
1161 }
1162 if (thread_group == NULL || t->GetThreadGroup() == thread_group) {
1163 threads.push_back(gRegistry->Add(t->GetPeer()));
1164 }
1165 }
1166
1167 Object* thread_group;
1168 std::vector<JDWP::ObjectId> threads;
1169 };
1170
1171 ThreadListVisitor tlv;
1172 tlv.thread_group = thread_group;
1173
1174 {
1175 ScopedThreadListLock thread_list_lock;
1176 Runtime::Current()->GetThreadList()->ForEach(ThreadListVisitor::Visit, &tlv);
1177 }
1178
1179 *pThreadCount = tlv.threads.size();
1180 if (*pThreadCount == 0) {
1181 *ppThreadIds = NULL;
1182 } else {
1183 *ppThreadIds = new JDWP::ObjectId[*pThreadCount];
1184 for (size_t i = 0; i < *pThreadCount; ++i) {
1185 (*ppThreadIds)[i] = tlv.threads[i];
1186 }
1187 }
1188}
1189
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001190void Dbg::GetThreadGroupThreads(JDWP::ObjectId threadGroupId, JDWP::ObjectId** ppThreadIds, uint32_t* pThreadCount) {
Elliott Hughesa2155262011-11-16 16:26:58 -08001191 GetThreadGroupThreadsImpl(gRegistry->Get<Object*>(threadGroupId), ppThreadIds, pThreadCount);
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001192}
1193
1194void Dbg::GetAllThreads(JDWP::ObjectId** ppThreadIds, uint32_t* pThreadCount) {
Elliott Hughesa2155262011-11-16 16:26:58 -08001195 GetThreadGroupThreadsImpl(NULL, ppThreadIds, pThreadCount);
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001196}
1197
1198int Dbg::GetThreadFrameCount(JDWP::ObjectId threadId) {
Elliott Hughes03181a82011-11-17 17:22:21 -08001199 ScopedThreadListLock thread_list_lock;
Elliott Hughesa2e54f62011-11-17 13:01:30 -08001200 struct CountStackDepthVisitor : public Thread::StackVisitor {
1201 CountStackDepthVisitor() : depth(0) {}
Elliott Hughesf8a2df72011-12-01 12:19:54 -08001202 virtual void VisitFrame(const Frame& f, uintptr_t) {
1203 // TODO: we'll need to skip callee-save frames too.
1204 if (f.HasMethod()) {
1205 ++depth;
1206 }
Elliott Hughesa2e54f62011-11-17 13:01:30 -08001207 }
1208 size_t depth;
1209 };
1210 CountStackDepthVisitor visitor;
1211 DecodeThread(threadId)->WalkStack(&visitor);
1212 return visitor.depth;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001213}
1214
Elliott Hughes03181a82011-11-17 17:22:21 -08001215bool Dbg::GetThreadFrame(JDWP::ObjectId threadId, int desired_frame_number, JDWP::FrameId* pFrameId, JDWP::JdwpLocation* pLoc) {
1216 ScopedThreadListLock thread_list_lock;
1217 struct GetFrameVisitor : public Thread::StackVisitor {
1218 GetFrameVisitor(int desired_frame_number, JDWP::FrameId* pFrameId, JDWP::JdwpLocation* pLoc)
1219 : found(false) ,depth(0), desired_frame_number(desired_frame_number), pFrameId(pFrameId), pLoc(pLoc) {
1220 }
1221 virtual void VisitFrame(const Frame& f, uintptr_t pc) {
Elliott Hughesf8a2df72011-12-01 12:19:54 -08001222 // TODO: we'll need to skip callee-save frames too.
Elliott Hughes03181a82011-11-17 17:22:21 -08001223 if (!f.HasMethod()) {
Elliott Hughesf8a2df72011-12-01 12:19:54 -08001224 return; // The debugger can't do anything useful with a frame that has no Method*.
Elliott Hughes03181a82011-11-17 17:22:21 -08001225 }
1226
1227 if (depth == desired_frame_number) {
1228 *pFrameId = reinterpret_cast<JDWP::FrameId>(f.GetSP());
1229
1230 Method* m = f.GetMethod();
1231 Class* c = m->GetDeclaringClass();
1232
1233 pLoc->typeTag = c->IsInterface() ? JDWP::TT_INTERFACE : JDWP::TT_CLASS;
1234 pLoc->classId = gRegistry->Add(c);
1235 pLoc->methodId = ToMethodId(m);
1236 pLoc->idx = m->IsNative() ? -1 : m->ToDexPC(pc);
1237
1238 found = true;
1239 }
1240 ++depth;
1241 }
1242 bool found;
1243 int depth;
1244 int desired_frame_number;
1245 JDWP::FrameId* pFrameId;
1246 JDWP::JdwpLocation* pLoc;
1247 };
1248 GetFrameVisitor visitor(desired_frame_number, pFrameId, pLoc);
1249 visitor.desired_frame_number = desired_frame_number;
1250 DecodeThread(threadId)->WalkStack(&visitor);
1251 return visitor.found;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001252}
1253
1254JDWP::ObjectId Dbg::GetThreadSelfId() {
Elliott Hughes475fc232011-10-25 15:00:35 -07001255 return gRegistry->Add(Thread::Current()->GetPeer());
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001256}
1257
Elliott Hughes475fc232011-10-25 15:00:35 -07001258void Dbg::SuspendVM() {
Elliott Hughesa2155262011-11-16 16:26:58 -08001259 ScopedThreadStateChange tsc(Thread::Current(), Thread::kRunnable); // TODO: do we really want to change back? should the JDWP thread be Runnable usually?
Elliott Hughes475fc232011-10-25 15:00:35 -07001260 Runtime::Current()->GetThreadList()->SuspendAll(true);
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001261}
1262
1263void Dbg::ResumeVM() {
Elliott Hughes475fc232011-10-25 15:00:35 -07001264 Runtime::Current()->GetThreadList()->ResumeAll(true);
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001265}
1266
1267void Dbg::SuspendThread(JDWP::ObjectId threadId) {
Elliott Hughes4e235312011-12-02 11:34:15 -08001268 Object* peer = gRegistry->Get<Object*>(threadId);
1269 ScopedThreadListLock thread_list_lock;
1270 Thread* thread = Thread::FromManagedThread(peer);
1271 if (thread == NULL) {
1272 LOG(WARNING) << "No such thread for suspend: " << peer;
1273 return;
1274 }
1275 Runtime::Current()->GetThreadList()->Suspend(thread, true);
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001276}
1277
1278void Dbg::ResumeThread(JDWP::ObjectId threadId) {
Elliott Hughes4e235312011-12-02 11:34:15 -08001279 Object* peer = gRegistry->Get<Object*>(threadId);
1280 ScopedThreadListLock thread_list_lock;
1281 Thread* thread = Thread::FromManagedThread(peer);
1282 if (thread == NULL) {
1283 LOG(WARNING) << "No such thread for resume: " << peer;
1284 return;
1285 }
1286 Runtime::Current()->GetThreadList()->Resume(thread, true);
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001287}
1288
1289void Dbg::SuspendSelf() {
Elliott Hughes475fc232011-10-25 15:00:35 -07001290 Runtime::Current()->GetThreadList()->SuspendSelfForDebugger();
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001291}
1292
1293bool Dbg::GetThisObject(JDWP::ObjectId threadId, JDWP::FrameId frameId, JDWP::ObjectId* pThisId) {
1294 UNIMPLEMENTED(FATAL);
1295 return false;
1296}
1297
Elliott Hughesdbb40792011-11-18 17:05:22 -08001298void Dbg::GetLocalValue(JDWP::ObjectId threadId, JDWP::FrameId frameId, int slot, JDWP::JdwpTag tag, uint8_t* buf, size_t expectedLen) {
1299 Method** sp = reinterpret_cast<Method**>(frameId);
Elliott Hughes68fdbd02011-11-29 19:22:47 -08001300 Frame f;
1301 f.SetSP(sp);
1302 uint16_t reg = DemangleSlot(slot, f);
1303 Method* m = f.GetMethod();
1304
1305 const VmapTable vmap_table(m->GetVmapTableRaw());
1306 uint32_t vmap_offset;
1307 if (vmap_table.IsInContext(reg, vmap_offset)) {
1308 UNIMPLEMENTED(FATAL) << "don't know how to pull locals from callee save frames: " << vmap_offset;
1309 }
Elliott Hughesdbb40792011-11-18 17:05:22 -08001310
1311 switch (tag) {
1312 case JDWP::JT_BOOLEAN:
1313 {
Elliott Hughesdbb40792011-11-18 17:05:22 -08001314 CHECK_EQ(expectedLen, 1U);
Elliott Hughes1bba14f2011-12-01 18:00:36 -08001315 uint32_t intVal = f.GetVReg(m, reg);
1316 LOG(VERBOSE) << "get boolean local " << reg << " = " << intVal;
Elliott Hughesdbb40792011-11-18 17:05:22 -08001317 JDWP::Set1(buf+1, intVal != 0);
1318 }
1319 break;
1320 case JDWP::JT_BYTE:
1321 {
Elliott Hughesdbb40792011-11-18 17:05:22 -08001322 CHECK_EQ(expectedLen, 1U);
Elliott Hughes1bba14f2011-12-01 18:00:36 -08001323 uint32_t intVal = f.GetVReg(m, reg);
1324 LOG(VERBOSE) << "get byte local " << reg << " = " << intVal;
Elliott Hughesdbb40792011-11-18 17:05:22 -08001325 JDWP::Set1(buf+1, intVal);
1326 }
1327 break;
1328 case JDWP::JT_SHORT:
1329 case JDWP::JT_CHAR:
1330 {
Elliott Hughesdbb40792011-11-18 17:05:22 -08001331 CHECK_EQ(expectedLen, 2U);
Elliott Hughes1bba14f2011-12-01 18:00:36 -08001332 uint32_t intVal = f.GetVReg(m, reg);
1333 LOG(VERBOSE) << "get short/char local " << reg << " = " << intVal;
Elliott Hughesdbb40792011-11-18 17:05:22 -08001334 JDWP::Set2BE(buf+1, intVal);
1335 }
1336 break;
1337 case JDWP::JT_INT:
1338 case JDWP::JT_FLOAT:
1339 {
Elliott Hughesdbb40792011-11-18 17:05:22 -08001340 CHECK_EQ(expectedLen, 4U);
Elliott Hughes1bba14f2011-12-01 18:00:36 -08001341 uint32_t intVal = f.GetVReg(m, reg);
1342 LOG(VERBOSE) << "get int/float local " << reg << " = " << intVal;
Elliott Hughesdbb40792011-11-18 17:05:22 -08001343 JDWP::Set4BE(buf+1, intVal);
1344 }
1345 break;
1346 case JDWP::JT_ARRAY:
1347 {
Elliott Hughesdbb40792011-11-18 17:05:22 -08001348 CHECK_EQ(expectedLen, sizeof(JDWP::ObjectId));
Elliott Hughes68fdbd02011-11-29 19:22:47 -08001349 Object* o = reinterpret_cast<Object*>(f.GetVReg(m, reg));
Elliott Hughes1bba14f2011-12-01 18:00:36 -08001350 LOG(VERBOSE) << "get array local " << reg << " = " << o;
Elliott Hughesdbb40792011-11-18 17:05:22 -08001351 if (o != NULL && !Heap::IsHeapAddress(o)) {
Elliott Hughes68fdbd02011-11-29 19:22:47 -08001352 LOG(FATAL) << "reg " << reg << " expected to hold array: " << o;
Elliott Hughesdbb40792011-11-18 17:05:22 -08001353 }
1354 JDWP::SetObjectId(buf+1, gRegistry->Add(o));
1355 }
1356 break;
1357 case JDWP::JT_OBJECT:
1358 {
Elliott Hughesdbb40792011-11-18 17:05:22 -08001359 CHECK_EQ(expectedLen, sizeof(JDWP::ObjectId));
Elliott Hughes68fdbd02011-11-29 19:22:47 -08001360 Object* o = reinterpret_cast<Object*>(f.GetVReg(m, reg));
Elliott Hughes1bba14f2011-12-01 18:00:36 -08001361 LOG(VERBOSE) << "get object local " << reg << " = " << o;
Elliott Hughesdbb40792011-11-18 17:05:22 -08001362 if (o != NULL && !Heap::IsHeapAddress(o)) {
Elliott Hughes68fdbd02011-11-29 19:22:47 -08001363 LOG(FATAL) << "reg " << reg << " expected to hold object: " << o;
Elliott Hughesdbb40792011-11-18 17:05:22 -08001364 }
1365 tag = TagFromObject(o);
1366 JDWP::SetObjectId(buf+1, gRegistry->Add(o));
1367 }
1368 break;
1369 case JDWP::JT_DOUBLE:
1370 case JDWP::JT_LONG:
1371 {
Elliott Hughesdbb40792011-11-18 17:05:22 -08001372 CHECK_EQ(expectedLen, 8U);
Elliott Hughes1bba14f2011-12-01 18:00:36 -08001373 uint32_t lo = f.GetVReg(m, reg);
1374 uint64_t hi = f.GetVReg(m, reg + 1);
1375 uint64_t longVal = (hi << 32) | lo;
1376 LOG(VERBOSE) << "get double/long local " << hi << ":" << lo << " = " << longVal;
Elliott Hughesdbb40792011-11-18 17:05:22 -08001377 JDWP::Set8BE(buf+1, longVal);
1378 }
1379 break;
1380 default:
1381 LOG(FATAL) << "unknown tag " << tag;
1382 break;
1383 }
1384
1385 // Prepend tag, which may have been updated.
1386 JDWP::Set1(buf, tag);
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001387}
1388
Elliott Hughesdbb40792011-11-18 17:05:22 -08001389void Dbg::SetLocalValue(JDWP::ObjectId threadId, JDWP::FrameId frameId, int slot, JDWP::JdwpTag tag, uint64_t value, size_t width) {
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001390 UNIMPLEMENTED(FATAL);
1391}
1392
1393void Dbg::PostLocationEvent(const Method* method, int pcOffset, Object* thisPtr, int eventFlags) {
1394 UNIMPLEMENTED(FATAL);
1395}
1396
1397void Dbg::PostException(void* throwFp, int throwRelPc, void* catchFp, int catchRelPc, Object* exception) {
1398 UNIMPLEMENTED(FATAL);
1399}
1400
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001401void Dbg::PostClassPrepare(Class* c) {
1402 UNIMPLEMENTED(FATAL);
1403}
1404
1405bool Dbg::WatchLocation(const JDWP::JdwpLocation* pLoc) {
1406 UNIMPLEMENTED(FATAL);
1407 return false;
1408}
1409
1410void Dbg::UnwatchLocation(const JDWP::JdwpLocation* pLoc) {
1411 UNIMPLEMENTED(FATAL);
1412}
1413
1414bool Dbg::ConfigureStep(JDWP::ObjectId threadId, JDWP::JdwpStepSize size, JDWP::JdwpStepDepth depth) {
1415 UNIMPLEMENTED(FATAL);
1416 return false;
1417}
1418
1419void Dbg::UnconfigureStep(JDWP::ObjectId threadId) {
1420 UNIMPLEMENTED(FATAL);
1421}
1422
Elliott Hughesaed4be92011-12-02 16:16:23 -08001423JDWP::JdwpError Dbg::InvokeMethod(JDWP::ObjectId threadId, JDWP::ObjectId objectId, JDWP::RefTypeId classId, JDWP::MethodId methodId, uint32_t numArgs, uint64_t* argArray, uint32_t options, JDWP::JdwpTag* pResultTag, uint64_t* pResultValue, JDWP::ObjectId* pExceptObj) {
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001424 UNIMPLEMENTED(FATAL);
1425 return JDWP::ERR_NONE;
1426}
1427
1428void Dbg::ExecuteMethod(DebugInvokeReq* pReq) {
1429 UNIMPLEMENTED(FATAL);
1430}
1431
1432void Dbg::RegisterObjectId(JDWP::ObjectId id) {
1433 UNIMPLEMENTED(FATAL);
1434}
1435
Elliott Hughesf6a1e1e2011-10-25 16:28:04 -07001436/*
1437 * "buf" contains a full JDWP packet, possibly with multiple chunks. We
1438 * need to process each, accumulate the replies, and ship the whole thing
1439 * back.
1440 *
1441 * Returns "true" if we have a reply. The reply buffer is newly allocated,
1442 * and includes the chunk type/length, followed by the data.
1443 *
1444 * TODO: we currently assume that the request and reply include a single
1445 * chunk. If this becomes inconvenient we will need to adapt.
1446 */
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001447bool Dbg::DdmHandlePacket(const uint8_t* buf, int dataLen, uint8_t** pReplyBuf, int* pReplyLen) {
Elliott Hughesf6a1e1e2011-10-25 16:28:04 -07001448 CHECK_GE(dataLen, 0);
1449
1450 Thread* self = Thread::Current();
1451 JNIEnv* env = self->GetJniEnv();
1452
1453 static jclass Chunk_class = env->FindClass("org/apache/harmony/dalvik/ddmc/Chunk");
1454 static jclass DdmServer_class = env->FindClass("org/apache/harmony/dalvik/ddmc/DdmServer");
1455 static jmethodID dispatch_mid = env->GetStaticMethodID(DdmServer_class, "dispatch",
1456 "(I[BII)Lorg/apache/harmony/dalvik/ddmc/Chunk;");
1457 static jfieldID data_fid = env->GetFieldID(Chunk_class, "data", "[B");
1458 static jfieldID length_fid = env->GetFieldID(Chunk_class, "length", "I");
1459 static jfieldID offset_fid = env->GetFieldID(Chunk_class, "offset", "I");
1460 static jfieldID type_fid = env->GetFieldID(Chunk_class, "type", "I");
1461
1462 // Create a byte[] corresponding to 'buf'.
Elliott Hughes6a5bd492011-10-28 14:33:57 -07001463 ScopedLocalRef<jbyteArray> dataArray(env, env->NewByteArray(dataLen));
1464 if (dataArray.get() == NULL) {
Elliott Hughesf6a1e1e2011-10-25 16:28:04 -07001465 LOG(WARNING) << "byte[] allocation failed: " << dataLen;
1466 env->ExceptionClear();
1467 return false;
1468 }
Elliott Hughes6a5bd492011-10-28 14:33:57 -07001469 env->SetByteArrayRegion(dataArray.get(), 0, dataLen, reinterpret_cast<const jbyte*>(buf));
Elliott Hughesf6a1e1e2011-10-25 16:28:04 -07001470
1471 const int kChunkHdrLen = 8;
1472
1473 // Run through and find all chunks. [Currently just find the first.]
Elliott Hughes6a5bd492011-10-28 14:33:57 -07001474 ScopedByteArrayRO contents(env, dataArray.get());
Elliott Hughesf7c3b662011-10-27 12:04:56 -07001475 jint type = JDWP::Get4BE(reinterpret_cast<const uint8_t*>(&contents[0]));
1476 jint length = JDWP::Get4BE(reinterpret_cast<const uint8_t*>(&contents[4]));
Elliott Hughesf6a1e1e2011-10-25 16:28:04 -07001477 jint offset = kChunkHdrLen;
1478 if (offset + length > dataLen) {
1479 LOG(WARNING) << StringPrintf("bad chunk found (len=%u pktLen=%d)", length, dataLen);
1480 return false;
1481 }
1482
1483 // Call "private static Chunk dispatch(int type, byte[] data, int offset, int length)".
Elliott Hughes6a5bd492011-10-28 14:33:57 -07001484 ScopedLocalRef<jobject> chunk(env, env->CallStaticObjectMethod(DdmServer_class, dispatch_mid, type, dataArray.get(), offset, length));
Elliott Hughesf6a1e1e2011-10-25 16:28:04 -07001485 if (env->ExceptionCheck()) {
1486 LOG(INFO) << StringPrintf("Exception thrown by dispatcher for 0x%08x", type);
1487 env->ExceptionDescribe();
1488 env->ExceptionClear();
1489 return false;
1490 }
1491
Elliott Hughes6a5bd492011-10-28 14:33:57 -07001492 if (chunk.get() == NULL) {
Elliott Hughesf6a1e1e2011-10-25 16:28:04 -07001493 return false;
1494 }
1495
1496 /*
1497 * Pull the pieces out of the chunk. We copy the results into a
1498 * newly-allocated buffer that the caller can free. We don't want to
1499 * continue using the Chunk object because nothing has a reference to it.
1500 *
1501 * We could avoid this by returning type/data/offset/length and having
1502 * the caller be aware of the object lifetime issues, but that
1503 * integrates the JDWP code more tightly into the VM, and doesn't work
1504 * if we have responses for multiple chunks.
1505 *
1506 * So we're pretty much stuck with copying data around multiple times.
1507 */
Elliott Hughes6a5bd492011-10-28 14:33:57 -07001508 ScopedLocalRef<jbyteArray> replyData(env, reinterpret_cast<jbyteArray>(env->GetObjectField(chunk.get(), data_fid)));
1509 length = env->GetIntField(chunk.get(), length_fid);
1510 offset = env->GetIntField(chunk.get(), offset_fid);
1511 type = env->GetIntField(chunk.get(), type_fid);
Elliott Hughesf6a1e1e2011-10-25 16:28:04 -07001512
Elliott Hughes6a5bd492011-10-28 14:33:57 -07001513 LOG(VERBOSE) << StringPrintf("DDM reply: type=0x%08x data=%p offset=%d length=%d", type, replyData.get(), offset, length);
1514 if (length == 0 || replyData.get() == NULL) {
Elliott Hughesf6a1e1e2011-10-25 16:28:04 -07001515 return false;
1516 }
1517
Elliott Hughes6a5bd492011-10-28 14:33:57 -07001518 jsize replyLength = env->GetArrayLength(replyData.get());
Elliott Hughesf6a1e1e2011-10-25 16:28:04 -07001519 if (offset + length > replyLength) {
1520 LOG(WARNING) << StringPrintf("chunk off=%d len=%d exceeds reply array len %d", offset, length, replyLength);
1521 return false;
1522 }
1523
1524 uint8_t* reply = new uint8_t[length + kChunkHdrLen];
1525 if (reply == NULL) {
1526 LOG(WARNING) << "malloc failed: " << (length + kChunkHdrLen);
1527 return false;
1528 }
Elliott Hughesf7c3b662011-10-27 12:04:56 -07001529 JDWP::Set4BE(reply + 0, type);
1530 JDWP::Set4BE(reply + 4, length);
Elliott Hughes6a5bd492011-10-28 14:33:57 -07001531 env->GetByteArrayRegion(replyData.get(), offset, length, reinterpret_cast<jbyte*>(reply + kChunkHdrLen));
Elliott Hughesf6a1e1e2011-10-25 16:28:04 -07001532
1533 *pReplyBuf = reply;
1534 *pReplyLen = length + kChunkHdrLen;
1535
1536 LOG(VERBOSE) << StringPrintf("dvmHandleDdm returning type=%.4s buf=%p len=%d", (char*) reply, reply, length);
1537 return true;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001538}
1539
Elliott Hughesa2155262011-11-16 16:26:58 -08001540void Dbg::DdmBroadcast(bool connect) {
Elliott Hughes47fce012011-10-25 18:37:19 -07001541 LOG(VERBOSE) << "Broadcasting DDM " << (connect ? "connect" : "disconnect") << "...";
1542
1543 Thread* self = Thread::Current();
1544 if (self->GetState() != Thread::kRunnable) {
1545 LOG(ERROR) << "DDM broadcast in thread state " << self->GetState();
1546 /* try anyway? */
1547 }
1548
1549 JNIEnv* env = self->GetJniEnv();
1550 static jclass DdmServer_class = env->FindClass("org/apache/harmony/dalvik/ddmc/DdmServer");
1551 static jmethodID broadcast_mid = env->GetStaticMethodID(DdmServer_class, "broadcast", "(I)V");
1552 jint event = connect ? 1 /*DdmServer.CONNECTED*/ : 2 /*DdmServer.DISCONNECTED*/;
1553 env->CallStaticVoidMethod(DdmServer_class, broadcast_mid, event);
1554 if (env->ExceptionCheck()) {
1555 LOG(ERROR) << "DdmServer.broadcast " << event << " failed";
1556 env->ExceptionDescribe();
1557 env->ExceptionClear();
1558 }
1559}
1560
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001561void Dbg::DdmConnected() {
Elliott Hughesa2155262011-11-16 16:26:58 -08001562 Dbg::DdmBroadcast(true);
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001563}
1564
1565void Dbg::DdmDisconnected() {
Elliott Hughesa2155262011-11-16 16:26:58 -08001566 Dbg::DdmBroadcast(false);
Elliott Hughes47fce012011-10-25 18:37:19 -07001567 gDdmThreadNotification = false;
1568}
1569
1570/*
Elliott Hughes82188472011-11-07 18:11:48 -08001571 * Send a notification when a thread starts, stops, or changes its name.
Elliott Hughes47fce012011-10-25 18:37:19 -07001572 *
1573 * Because we broadcast the full set of threads when the notifications are
1574 * first enabled, it's possible for "thread" to be actively executing.
1575 */
Elliott Hughes82188472011-11-07 18:11:48 -08001576void Dbg::DdmSendThreadNotification(Thread* t, uint32_t type) {
Elliott Hughes47fce012011-10-25 18:37:19 -07001577 if (!gDdmThreadNotification) {
1578 return;
1579 }
1580
Elliott Hughes82188472011-11-07 18:11:48 -08001581 if (type == CHUNK_TYPE("THDE")) {
Elliott Hughes47fce012011-10-25 18:37:19 -07001582 uint8_t buf[4];
Elliott Hughesf7c3b662011-10-27 12:04:56 -07001583 JDWP::Set4BE(&buf[0], t->GetThinLockId());
Elliott Hughes47fce012011-10-25 18:37:19 -07001584 Dbg::DdmSendChunk(CHUNK_TYPE("THDE"), 4, buf);
Elliott Hughes82188472011-11-07 18:11:48 -08001585 } else {
1586 CHECK(type == CHUNK_TYPE("THCR") || type == CHUNK_TYPE("THNM")) << type;
1587 SirtRef<String> name(t->GetName());
1588 size_t char_count = (name.get() != NULL) ? name->GetLength() : 0;
1589 const jchar* chars = name->GetCharArray()->GetData();
1590
Elliott Hughes21f32d72011-11-09 17:44:13 -08001591 std::vector<uint8_t> bytes;
Elliott Hughes545a0642011-11-08 19:10:03 -08001592 JDWP::Append4BE(bytes, t->GetThinLockId());
1593 JDWP::AppendUtf16BE(bytes, chars, char_count);
Elliott Hughes21f32d72011-11-09 17:44:13 -08001594 CHECK_EQ(bytes.size(), char_count*2 + sizeof(uint32_t)*2);
1595 Dbg::DdmSendChunk(type, bytes);
Elliott Hughes47fce012011-10-25 18:37:19 -07001596 }
1597}
1598
Elliott Hughesa2155262011-11-16 16:26:58 -08001599static void DdmSendThreadStartCallback(Thread* t, void*) {
Elliott Hughes82188472011-11-07 18:11:48 -08001600 Dbg::DdmSendThreadNotification(t, CHUNK_TYPE("THCR"));
Elliott Hughes47fce012011-10-25 18:37:19 -07001601}
1602
1603void Dbg::DdmSetThreadNotification(bool enable) {
1604 // We lock the thread list to avoid sending duplicate events or missing
1605 // a thread change. We should be okay holding this lock while sending
1606 // the messages out. (We have to hold it while accessing a live thread.)
Elliott Hughesbbd9d832011-11-07 14:40:00 -08001607 ScopedThreadListLock thread_list_lock;
Elliott Hughes47fce012011-10-25 18:37:19 -07001608
1609 gDdmThreadNotification = enable;
1610 if (enable) {
Elliott Hughesbfe487b2011-10-26 15:48:55 -07001611 Runtime::Current()->GetThreadList()->ForEach(DdmSendThreadStartCallback, NULL);
Elliott Hughes47fce012011-10-25 18:37:19 -07001612 }
1613}
1614
Elliott Hughesa2155262011-11-16 16:26:58 -08001615void Dbg::PostThreadStartOrStop(Thread* t, uint32_t type) {
Elliott Hughes47fce012011-10-25 18:37:19 -07001616 if (gDebuggerActive) {
1617 JDWP::ObjectId id = gRegistry->Add(t->GetPeer());
Elliott Hughes82188472011-11-07 18:11:48 -08001618 gJdwpState->PostThreadChange(id, type == CHUNK_TYPE("THCR"));
Elliott Hughes47fce012011-10-25 18:37:19 -07001619 }
Elliott Hughes82188472011-11-07 18:11:48 -08001620 Dbg::DdmSendThreadNotification(t, type);
Elliott Hughes47fce012011-10-25 18:37:19 -07001621}
1622
1623void Dbg::PostThreadStart(Thread* t) {
Elliott Hughesa2155262011-11-16 16:26:58 -08001624 Dbg::PostThreadStartOrStop(t, CHUNK_TYPE("THCR"));
Elliott Hughes47fce012011-10-25 18:37:19 -07001625}
1626
1627void Dbg::PostThreadDeath(Thread* t) {
Elliott Hughesa2155262011-11-16 16:26:58 -08001628 Dbg::PostThreadStartOrStop(t, CHUNK_TYPE("THDE"));
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001629}
1630
Elliott Hughes82188472011-11-07 18:11:48 -08001631void Dbg::DdmSendChunk(uint32_t type, size_t byte_count, const uint8_t* buf) {
Elliott Hughes3bb81562011-10-21 18:52:59 -07001632 CHECK(buf != NULL);
1633 iovec vec[1];
1634 vec[0].iov_base = reinterpret_cast<void*>(const_cast<uint8_t*>(buf));
1635 vec[0].iov_len = byte_count;
1636 Dbg::DdmSendChunkV(type, vec, 1);
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001637}
1638
Elliott Hughes21f32d72011-11-09 17:44:13 -08001639void Dbg::DdmSendChunk(uint32_t type, const std::vector<uint8_t>& bytes) {
1640 DdmSendChunk(type, bytes.size(), &bytes[0]);
1641}
1642
Elliott Hughes82188472011-11-07 18:11:48 -08001643void Dbg::DdmSendChunkV(uint32_t type, const struct iovec* iov, int iovcnt) {
Elliott Hughes3bb81562011-10-21 18:52:59 -07001644 if (gJdwpState == NULL) {
1645 LOG(VERBOSE) << "Debugger thread not active, ignoring DDM send: " << type;
1646 } else {
Elliott Hughes376a7a02011-10-24 18:35:55 -07001647 gJdwpState->DdmSendChunkV(type, iov, iovcnt);
Elliott Hughes3bb81562011-10-21 18:52:59 -07001648 }
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001649}
1650
Elliott Hughes767a1472011-10-26 18:49:02 -07001651int Dbg::DdmHandleHpifChunk(HpifWhen when) {
1652 if (when == HPIF_WHEN_NOW) {
Elliott Hughes7162ad92011-10-27 14:08:42 -07001653 DdmSendHeapInfo(when);
Elliott Hughes767a1472011-10-26 18:49:02 -07001654 return true;
1655 }
1656
1657 if (when != HPIF_WHEN_NEVER && when != HPIF_WHEN_NEXT_GC && when != HPIF_WHEN_EVERY_GC) {
1658 LOG(ERROR) << "invalid HpifWhen value: " << static_cast<int>(when);
1659 return false;
1660 }
1661
1662 gDdmHpifWhen = when;
1663 return true;
1664}
1665
1666bool Dbg::DdmHandleHpsgNhsgChunk(Dbg::HpsgWhen when, Dbg::HpsgWhat what, bool native) {
1667 if (when != HPSG_WHEN_NEVER && when != HPSG_WHEN_EVERY_GC) {
1668 LOG(ERROR) << "invalid HpsgWhen value: " << static_cast<int>(when);
1669 return false;
1670 }
1671
1672 if (what != HPSG_WHAT_MERGED_OBJECTS && what != HPSG_WHAT_DISTINCT_OBJECTS) {
1673 LOG(ERROR) << "invalid HpsgWhat value: " << static_cast<int>(what);
1674 return false;
1675 }
1676
1677 if (native) {
1678 gDdmNhsgWhen = when;
1679 gDdmNhsgWhat = what;
1680 } else {
1681 gDdmHpsgWhen = when;
1682 gDdmHpsgWhat = what;
1683 }
1684 return true;
1685}
1686
Elliott Hughes7162ad92011-10-27 14:08:42 -07001687void Dbg::DdmSendHeapInfo(HpifWhen reason) {
1688 // If there's a one-shot 'when', reset it.
1689 if (reason == gDdmHpifWhen) {
1690 if (gDdmHpifWhen == HPIF_WHEN_NEXT_GC) {
1691 gDdmHpifWhen = HPIF_WHEN_NEVER;
1692 }
1693 }
1694
1695 /*
1696 * Chunk HPIF (client --> server)
1697 *
1698 * Heap Info. General information about the heap,
1699 * suitable for a summary display.
1700 *
1701 * [u4]: number of heaps
1702 *
1703 * For each heap:
1704 * [u4]: heap ID
1705 * [u8]: timestamp in ms since Unix epoch
1706 * [u1]: capture reason (same as 'when' value from server)
1707 * [u4]: max heap size in bytes (-Xmx)
1708 * [u4]: current heap size in bytes
1709 * [u4]: current number of bytes allocated
1710 * [u4]: current number of objects allocated
1711 */
1712 uint8_t heap_count = 1;
Elliott Hughes21f32d72011-11-09 17:44:13 -08001713 std::vector<uint8_t> bytes;
Elliott Hughes545a0642011-11-08 19:10:03 -08001714 JDWP::Append4BE(bytes, heap_count);
1715 JDWP::Append4BE(bytes, 1); // Heap id (bogus; we only have one heap).
1716 JDWP::Append8BE(bytes, MilliTime());
1717 JDWP::Append1BE(bytes, reason);
1718 JDWP::Append4BE(bytes, Heap::GetMaxMemory()); // Max allowed heap size in bytes.
1719 JDWP::Append4BE(bytes, Heap::GetTotalMemory()); // Current heap size in bytes.
1720 JDWP::Append4BE(bytes, Heap::GetBytesAllocated());
1721 JDWP::Append4BE(bytes, Heap::GetObjectsAllocated());
Elliott Hughes21f32d72011-11-09 17:44:13 -08001722 CHECK_EQ(bytes.size(), 4U + (heap_count * (4 + 8 + 1 + 4 + 4 + 4 + 4)));
1723 Dbg::DdmSendChunk(CHUNK_TYPE("HPIF"), bytes);
Elliott Hughes767a1472011-10-26 18:49:02 -07001724}
1725
Elliott Hughes6a5bd492011-10-28 14:33:57 -07001726enum HpsgSolidity {
1727 SOLIDITY_FREE = 0,
1728 SOLIDITY_HARD = 1,
1729 SOLIDITY_SOFT = 2,
1730 SOLIDITY_WEAK = 3,
1731 SOLIDITY_PHANTOM = 4,
1732 SOLIDITY_FINALIZABLE = 5,
1733 SOLIDITY_SWEEP = 6,
1734};
1735
1736enum HpsgKind {
1737 KIND_OBJECT = 0,
1738 KIND_CLASS_OBJECT = 1,
1739 KIND_ARRAY_1 = 2,
1740 KIND_ARRAY_2 = 3,
1741 KIND_ARRAY_4 = 4,
1742 KIND_ARRAY_8 = 5,
1743 KIND_UNKNOWN = 6,
1744 KIND_NATIVE = 7,
1745};
1746
1747#define HPSG_PARTIAL (1<<7)
1748#define HPSG_STATE(solidity, kind) ((uint8_t)((((kind) & 0x7) << 3) | ((solidity) & 0x7)))
1749
1750struct HeapChunkContext {
1751 std::vector<uint8_t> buf;
1752 uint8_t* p;
1753 uint8_t* pieceLenField;
1754 size_t totalAllocationUnits;
Elliott Hughes82188472011-11-07 18:11:48 -08001755 uint32_t type;
Elliott Hughes6a5bd492011-10-28 14:33:57 -07001756 bool merge;
1757 bool needHeader;
1758
1759 // Maximum chunk size. Obtain this from the formula:
1760 // (((maximum_heap_size / ALLOCATION_UNIT_SIZE) + 255) / 256) * 2
1761 HeapChunkContext(bool merge, bool native)
1762 : buf(16384 - 16),
1763 type(0),
1764 merge(merge) {
1765 Reset();
1766 if (native) {
1767 type = CHUNK_TYPE("NHSG");
1768 } else {
1769 type = merge ? CHUNK_TYPE("HPSG") : CHUNK_TYPE("HPSO");
1770 }
1771 }
1772
1773 ~HeapChunkContext() {
1774 if (p > &buf[0]) {
1775 Flush();
1776 }
1777 }
1778
1779 void EnsureHeader(const void* chunk_ptr) {
1780 if (!needHeader) {
1781 return;
1782 }
1783
1784 // Start a new HPSx chunk.
1785 JDWP::Write4BE(&p, 1); // Heap id (bogus; we only have one heap).
1786 JDWP::Write1BE(&p, 8); // Size of allocation unit, in bytes.
1787
1788 JDWP::Write4BE(&p, reinterpret_cast<uintptr_t>(chunk_ptr)); // virtual address of segment start.
1789 JDWP::Write4BE(&p, 0); // offset of this piece (relative to the virtual address).
1790 // [u4]: length of piece, in allocation units
1791 // We won't know this until we're done, so save the offset and stuff in a dummy value.
1792 pieceLenField = p;
1793 JDWP::Write4BE(&p, 0x55555555);
1794 needHeader = false;
1795 }
1796
1797 void Flush() {
1798 // Patch the "length of piece" field.
1799 CHECK_LE(&buf[0], pieceLenField);
1800 CHECK_LE(pieceLenField, p);
1801 JDWP::Set4BE(pieceLenField, totalAllocationUnits);
1802
1803 Dbg::DdmSendChunk(type, p - &buf[0], &buf[0]);
1804 Reset();
1805 }
1806
Elliott Hughesa2155262011-11-16 16:26:58 -08001807 static void HeapChunkCallback(const void* chunk_ptr, size_t chunk_len, const void* user_ptr, size_t user_len, void* arg) {
1808 reinterpret_cast<HeapChunkContext*>(arg)->HeapChunkCallback(chunk_ptr, chunk_len, user_ptr, user_len);
1809 }
1810
Elliott Hughes6a5bd492011-10-28 14:33:57 -07001811 private:
Elliott Hughesa2155262011-11-16 16:26:58 -08001812 enum { ALLOCATION_UNIT_SIZE = 8 };
1813
Elliott Hughes6a5bd492011-10-28 14:33:57 -07001814 void Reset() {
1815 p = &buf[0];
1816 totalAllocationUnits = 0;
1817 needHeader = true;
1818 pieceLenField = NULL;
1819 }
1820
Elliott Hughesa2155262011-11-16 16:26:58 -08001821 void HeapChunkCallback(const void* chunk_ptr, size_t chunk_len, const void* user_ptr, size_t user_len) {
1822 CHECK_EQ((chunk_len & (ALLOCATION_UNIT_SIZE-1)), 0U);
Elliott Hughes6a5bd492011-10-28 14:33:57 -07001823
Elliott Hughesa2155262011-11-16 16:26:58 -08001824 /* Make sure there's enough room left in the buffer.
1825 * We need to use two bytes for every fractional 256
1826 * allocation units used by the chunk.
1827 */
1828 {
1829 size_t needed = (((chunk_len/ALLOCATION_UNIT_SIZE + 255) / 256) * 2);
1830 size_t bytesLeft = buf.size() - (size_t)(p - &buf[0]);
1831 if (bytesLeft < needed) {
1832 Flush();
1833 }
Elliott Hughes6a5bd492011-10-28 14:33:57 -07001834
Elliott Hughesa2155262011-11-16 16:26:58 -08001835 bytesLeft = buf.size() - (size_t)(p - &buf[0]);
1836 if (bytesLeft < needed) {
1837 LOG(WARNING) << "chunk is too big to transmit (chunk_len=" << chunk_len << ", " << needed << " bytes)";
1838 return;
1839 }
1840 }
1841
1842 // OLD-TODO: notice when there's a gap and start a new heap, or at least a new range.
1843 EnsureHeader(chunk_ptr);
1844
1845 // Determine the type of this chunk.
1846 // OLD-TODO: if context.merge, see if this chunk is different from the last chunk.
1847 // If it's the same, we should combine them.
1848 uint8_t state = ExamineObject(reinterpret_cast<const Object*>(user_ptr), (type == CHUNK_TYPE("NHSG")));
1849
1850 // Write out the chunk description.
1851 chunk_len /= ALLOCATION_UNIT_SIZE; // convert to allocation units
1852 totalAllocationUnits += chunk_len;
1853 while (chunk_len > 256) {
1854 *p++ = state | HPSG_PARTIAL;
1855 *p++ = 255; // length - 1
1856 chunk_len -= 256;
1857 }
1858 *p++ = state;
1859 *p++ = chunk_len - 1;
Elliott Hughes6a5bd492011-10-28 14:33:57 -07001860 }
1861
Elliott Hughesa2155262011-11-16 16:26:58 -08001862 uint8_t ExamineObject(const Object* o, bool is_native_heap) {
1863 if (o == NULL) {
1864 return HPSG_STATE(SOLIDITY_FREE, 0);
1865 }
Elliott Hughes6a5bd492011-10-28 14:33:57 -07001866
Elliott Hughesa2155262011-11-16 16:26:58 -08001867 // It's an allocated chunk. Figure out what it is.
Elliott Hughes6a5bd492011-10-28 14:33:57 -07001868
Elliott Hughesa2155262011-11-16 16:26:58 -08001869 // If we're looking at the native heap, we'll just return
1870 // (SOLIDITY_HARD, KIND_NATIVE) for all allocated chunks.
1871 if (is_native_heap || !Heap::IsLiveObjectLocked(o)) {
1872 return HPSG_STATE(SOLIDITY_HARD, KIND_NATIVE);
1873 }
1874
1875 Class* c = o->GetClass();
1876 if (c == NULL) {
1877 // The object was probably just created but hasn't been initialized yet.
1878 return HPSG_STATE(SOLIDITY_HARD, KIND_OBJECT);
1879 }
1880
1881 if (!Heap::IsHeapAddress(c)) {
1882 LOG(WARNING) << "invalid class for managed heap object: " << o << " " << c;
1883 return HPSG_STATE(SOLIDITY_HARD, KIND_UNKNOWN);
1884 }
1885
1886 if (c->IsClassClass()) {
1887 return HPSG_STATE(SOLIDITY_HARD, KIND_CLASS_OBJECT);
1888 }
1889
1890 if (c->IsArrayClass()) {
1891 if (o->IsObjectArray()) {
1892 return HPSG_STATE(SOLIDITY_HARD, KIND_ARRAY_4);
1893 }
1894 switch (c->GetComponentSize()) {
1895 case 1: return HPSG_STATE(SOLIDITY_HARD, KIND_ARRAY_1);
1896 case 2: return HPSG_STATE(SOLIDITY_HARD, KIND_ARRAY_2);
1897 case 4: return HPSG_STATE(SOLIDITY_HARD, KIND_ARRAY_4);
1898 case 8: return HPSG_STATE(SOLIDITY_HARD, KIND_ARRAY_8);
1899 }
1900 }
1901
Elliott Hughes6a5bd492011-10-28 14:33:57 -07001902 return HPSG_STATE(SOLIDITY_HARD, KIND_OBJECT);
1903 }
1904
Elliott Hughesa2155262011-11-16 16:26:58 -08001905 DISALLOW_COPY_AND_ASSIGN(HeapChunkContext);
1906};
Elliott Hughes6a5bd492011-10-28 14:33:57 -07001907
1908void Dbg::DdmSendHeapSegments(bool native) {
1909 Dbg::HpsgWhen when;
1910 Dbg::HpsgWhat what;
1911 if (!native) {
1912 when = gDdmHpsgWhen;
1913 what = gDdmHpsgWhat;
1914 } else {
1915 when = gDdmNhsgWhen;
1916 what = gDdmNhsgWhat;
1917 }
1918 if (when == HPSG_WHEN_NEVER) {
1919 return;
1920 }
1921
1922 // Figure out what kind of chunks we'll be sending.
1923 CHECK(what == HPSG_WHAT_MERGED_OBJECTS || what == HPSG_WHAT_DISTINCT_OBJECTS) << static_cast<int>(what);
1924
1925 // First, send a heap start chunk.
1926 uint8_t heap_id[4];
1927 JDWP::Set4BE(&heap_id[0], 1); // Heap id (bogus; we only have one heap).
1928 Dbg::DdmSendChunk(native ? CHUNK_TYPE("NHST") : CHUNK_TYPE("HPST"), sizeof(heap_id), heap_id);
1929
1930 // Send a series of heap segment chunks.
Elliott Hughesa2155262011-11-16 16:26:58 -08001931 HeapChunkContext context((what == HPSG_WHAT_MERGED_OBJECTS), native);
1932 if (native) {
1933 dlmalloc_walk_heap(HeapChunkContext::HeapChunkCallback, &context);
1934 } else {
1935 Heap::WalkHeap(HeapChunkContext::HeapChunkCallback, &context);
1936 }
Elliott Hughes6a5bd492011-10-28 14:33:57 -07001937
1938 // Finally, send a heap end chunk.
1939 Dbg::DdmSendChunk(native ? CHUNK_TYPE("NHEN") : CHUNK_TYPE("HPEN"), sizeof(heap_id), heap_id);
Elliott Hughes767a1472011-10-26 18:49:02 -07001940}
1941
Elliott Hughes545a0642011-11-08 19:10:03 -08001942void Dbg::SetAllocTrackingEnabled(bool enabled) {
1943 MutexLock mu(gAllocTrackerLock);
1944 if (enabled) {
1945 if (recent_allocation_records_ == NULL) {
1946 LOG(INFO) << "Enabling alloc tracker (" << kNumAllocRecords << " entries, "
1947 << kMaxAllocRecordStackDepth << " frames --> "
1948 << (sizeof(AllocRecord) * kNumAllocRecords) << " bytes)";
1949 gAllocRecordHead = gAllocRecordCount = 0;
1950 recent_allocation_records_ = new AllocRecord[kNumAllocRecords];
1951 CHECK(recent_allocation_records_ != NULL);
1952 }
1953 } else {
1954 delete[] recent_allocation_records_;
1955 recent_allocation_records_ = NULL;
1956 }
1957}
1958
1959struct AllocRecordStackVisitor : public Thread::StackVisitor {
1960 AllocRecordStackVisitor(AllocRecord* record) : record(record), depth(0) {
1961 }
1962
1963 virtual void VisitFrame(const Frame& f, uintptr_t pc) {
1964 if (depth >= kMaxAllocRecordStackDepth) {
1965 return;
1966 }
1967 Method* m = f.GetMethod();
1968 if (m == NULL || m->IsCalleeSaveMethod()) {
1969 return;
1970 }
1971 record->stack[depth].method = m;
1972 record->stack[depth].raw_pc = pc;
1973 ++depth;
1974 }
1975
1976 ~AllocRecordStackVisitor() {
1977 // Clear out any unused stack trace elements.
1978 for (; depth < kMaxAllocRecordStackDepth; ++depth) {
1979 record->stack[depth].method = NULL;
1980 record->stack[depth].raw_pc = 0;
1981 }
1982 }
1983
1984 AllocRecord* record;
1985 size_t depth;
1986};
1987
1988void Dbg::RecordAllocation(Class* type, size_t byte_count) {
1989 Thread* self = Thread::Current();
1990 CHECK(self != NULL);
1991
1992 MutexLock mu(gAllocTrackerLock);
1993 if (recent_allocation_records_ == NULL) {
1994 return;
1995 }
1996
1997 // Advance and clip.
1998 if (++gAllocRecordHead == kNumAllocRecords) {
1999 gAllocRecordHead = 0;
2000 }
2001
2002 // Fill in the basics.
2003 AllocRecord* record = &recent_allocation_records_[gAllocRecordHead];
2004 record->type = type;
2005 record->byte_count = byte_count;
2006 record->thin_lock_id = self->GetThinLockId();
2007
2008 // Fill in the stack trace.
2009 AllocRecordStackVisitor visitor(record);
2010 self->WalkStack(&visitor);
2011
2012 if (gAllocRecordCount < kNumAllocRecords) {
2013 ++gAllocRecordCount;
2014 }
2015}
2016
2017/*
2018 * Return the index of the head element.
2019 *
2020 * We point at the most-recently-written record, so if allocRecordCount is 1
2021 * we want to use the current element. Take "head+1" and subtract count
2022 * from it.
2023 *
2024 * We need to handle underflow in our circular buffer, so we add
2025 * kNumAllocRecords and then mask it back down.
2026 */
2027inline static int headIndex() {
2028 return (gAllocRecordHead+1 + kNumAllocRecords - gAllocRecordCount) & (kNumAllocRecords-1);
2029}
2030
2031void Dbg::DumpRecentAllocations() {
2032 MutexLock mu(gAllocTrackerLock);
2033 if (recent_allocation_records_ == NULL) {
2034 LOG(INFO) << "Not recording tracked allocations";
2035 return;
2036 }
2037
2038 // "i" is the head of the list. We want to start at the end of the
2039 // list and move forward to the tail.
2040 size_t i = headIndex();
2041 size_t count = gAllocRecordCount;
2042
2043 LOG(INFO) << "Tracked allocations, (head=" << gAllocRecordHead << " count=" << count << ")";
2044 while (count--) {
2045 AllocRecord* record = &recent_allocation_records_[i];
2046
2047 LOG(INFO) << StringPrintf(" T=%-2d %6d ", record->thin_lock_id, record->byte_count)
2048 << PrettyClass(record->type);
2049
2050 for (size_t stack_frame = 0; stack_frame < kMaxAllocRecordStackDepth; ++stack_frame) {
2051 const Method* m = record->stack[stack_frame].method;
2052 if (m == NULL) {
2053 break;
2054 }
2055 LOG(INFO) << " " << PrettyMethod(m) << " line " << record->stack[stack_frame].LineNumber();
2056 }
2057
2058 // pause periodically to help logcat catch up
2059 if ((count % 5) == 0) {
2060 usleep(40000);
2061 }
2062
2063 i = (i + 1) & (kNumAllocRecords-1);
2064 }
2065}
2066
2067class StringTable {
2068 public:
2069 StringTable() {
2070 }
2071
2072 void Add(const String* s) {
2073 table_.insert(s);
2074 }
2075
2076 size_t IndexOf(const String* s) {
2077 return std::distance(table_.begin(), table_.find(s));
2078 }
2079
2080 size_t Size() {
2081 return table_.size();
2082 }
2083
2084 void WriteTo(std::vector<uint8_t>& bytes) {
2085 typedef std::set<const String*>::const_iterator It; // TODO: C++0x auto
2086 for (It it = table_.begin(); it != table_.end(); ++it) {
2087 const String* s = *it;
2088 JDWP::AppendUtf16BE(bytes, s->GetCharArray()->GetData(), s->GetLength());
2089 }
2090 }
2091
2092 private:
2093 std::set<const String*> table_;
2094 DISALLOW_COPY_AND_ASSIGN(StringTable);
2095};
2096
2097/*
2098 * The data we send to DDMS contains everything we have recorded.
2099 *
2100 * Message header (all values big-endian):
2101 * (1b) message header len (to allow future expansion); includes itself
2102 * (1b) entry header len
2103 * (1b) stack frame len
2104 * (2b) number of entries
2105 * (4b) offset to string table from start of message
2106 * (2b) number of class name strings
2107 * (2b) number of method name strings
2108 * (2b) number of source file name strings
2109 * For each entry:
2110 * (4b) total allocation size
2111 * (2b) threadId
2112 * (2b) allocated object's class name index
2113 * (1b) stack depth
2114 * For each stack frame:
2115 * (2b) method's class name
2116 * (2b) method name
2117 * (2b) method source file
2118 * (2b) line number, clipped to 32767; -2 if native; -1 if no source
2119 * (xb) class name strings
2120 * (xb) method name strings
2121 * (xb) source file strings
2122 *
2123 * As with other DDM traffic, strings are sent as a 4-byte length
2124 * followed by UTF-16 data.
2125 *
2126 * We send up 16-bit unsigned indexes into string tables. In theory there
2127 * can be (kMaxAllocRecordStackDepth * kNumAllocRecords) unique strings in
2128 * each table, but in practice there should be far fewer.
2129 *
2130 * The chief reason for using a string table here is to keep the size of
2131 * the DDMS message to a minimum. This is partly to make the protocol
2132 * efficient, but also because we have to form the whole thing up all at
2133 * once in a memory buffer.
2134 *
2135 * We use separate string tables for class names, method names, and source
2136 * files to keep the indexes small. There will generally be no overlap
2137 * between the contents of these tables.
2138 */
2139jbyteArray Dbg::GetRecentAllocations() {
2140 if (false) {
2141 DumpRecentAllocations();
2142 }
2143
2144 MutexLock mu(gAllocTrackerLock);
2145
2146 /*
2147 * Part 1: generate string tables.
2148 */
2149 StringTable class_names;
2150 StringTable method_names;
2151 StringTable filenames;
2152
2153 int count = gAllocRecordCount;
2154 int idx = headIndex();
2155 while (count--) {
2156 AllocRecord* record = &recent_allocation_records_[idx];
2157
2158 class_names.Add(record->type->GetDescriptor());
2159
2160 for (size_t i = 0; i < kMaxAllocRecordStackDepth; i++) {
2161 const Method* m = record->stack[i].method;
2162 if (m != NULL) {
2163 class_names.Add(m->GetDeclaringClass()->GetDescriptor());
2164 method_names.Add(m->GetName());
2165 filenames.Add(m->GetDeclaringClass()->GetSourceFile());
2166 }
2167 }
2168
2169 idx = (idx + 1) & (kNumAllocRecords-1);
2170 }
2171
2172 LOG(INFO) << "allocation records: " << gAllocRecordCount;
2173
2174 /*
2175 * Part 2: allocate a buffer and generate the output.
2176 */
2177 std::vector<uint8_t> bytes;
2178
2179 // (1b) message header len (to allow future expansion); includes itself
2180 // (1b) entry header len
2181 // (1b) stack frame len
2182 const int kMessageHeaderLen = 15;
2183 const int kEntryHeaderLen = 9;
2184 const int kStackFrameLen = 8;
2185 JDWP::Append1BE(bytes, kMessageHeaderLen);
2186 JDWP::Append1BE(bytes, kEntryHeaderLen);
2187 JDWP::Append1BE(bytes, kStackFrameLen);
2188
2189 // (2b) number of entries
2190 // (4b) offset to string table from start of message
2191 // (2b) number of class name strings
2192 // (2b) number of method name strings
2193 // (2b) number of source file name strings
2194 JDWP::Append2BE(bytes, gAllocRecordCount);
2195 size_t string_table_offset = bytes.size();
2196 JDWP::Append4BE(bytes, 0); // We'll patch this later...
2197 JDWP::Append2BE(bytes, class_names.Size());
2198 JDWP::Append2BE(bytes, method_names.Size());
2199 JDWP::Append2BE(bytes, filenames.Size());
2200
2201 count = gAllocRecordCount;
2202 idx = headIndex();
2203 while (count--) {
2204 // For each entry:
2205 // (4b) total allocation size
2206 // (2b) thread id
2207 // (2b) allocated object's class name index
2208 // (1b) stack depth
2209 AllocRecord* record = &recent_allocation_records_[idx];
2210 size_t stack_depth = record->GetDepth();
2211 JDWP::Append4BE(bytes, record->byte_count);
2212 JDWP::Append2BE(bytes, record->thin_lock_id);
2213 JDWP::Append2BE(bytes, class_names.IndexOf(record->type->GetDescriptor()));
2214 JDWP::Append1BE(bytes, stack_depth);
2215
2216 for (size_t stack_frame = 0; stack_frame < stack_depth; ++stack_frame) {
2217 // For each stack frame:
2218 // (2b) method's class name
2219 // (2b) method name
2220 // (2b) method source file
2221 // (2b) line number, clipped to 32767; -2 if native; -1 if no source
2222 const Method* m = record->stack[stack_frame].method;
2223 JDWP::Append2BE(bytes, class_names.IndexOf(m->GetDeclaringClass()->GetDescriptor()));
2224 JDWP::Append2BE(bytes, method_names.IndexOf(m->GetName()));
2225 JDWP::Append2BE(bytes, filenames.IndexOf(m->GetDeclaringClass()->GetSourceFile()));
2226 JDWP::Append2BE(bytes, record->stack[stack_frame].LineNumber());
2227 }
2228
2229 idx = (idx + 1) & (kNumAllocRecords-1);
2230 }
2231
2232 // (xb) class name strings
2233 // (xb) method name strings
2234 // (xb) source file strings
2235 JDWP::Set4BE(&bytes[string_table_offset], bytes.size());
2236 class_names.WriteTo(bytes);
2237 method_names.WriteTo(bytes);
2238 filenames.WriteTo(bytes);
2239
2240 JNIEnv* env = Thread::Current()->GetJniEnv();
2241 jbyteArray result = env->NewByteArray(bytes.size());
2242 if (result != NULL) {
2243 env->SetByteArrayRegion(result, 0, bytes.size(), reinterpret_cast<const jbyte*>(&bytes[0]));
2244 }
2245 return result;
2246}
2247
Elliott Hughes872d4ec2011-10-21 17:07:15 -07002248} // namespace art