blob: d297f6f9b105bf13baf0bb6b7458b87f93315c00 [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#ifndef ART_JDWP_JDWP_H_
18#define ART_JDWP_JDWP_H_
19
20#include "jdwp/jdwp_bits.h"
21#include "jdwp/jdwp_constants.h"
22#include "jdwp/jdwp_expand_buf.h"
Elliott Hughes376a7a02011-10-24 18:35:55 -070023#include "../mutex.h" // TODO: fix our include path!
Elliott Hughes872d4ec2011-10-21 17:07:15 -070024
25#include <pthread.h>
26#include <stddef.h>
27#include <stdint.h>
28#include <string.h>
29
30struct iovec;
31
32namespace art {
33
Elliott Hughesd07986f2011-12-06 18:27:45 -080034struct Method;
Elliott Hughes475fc232011-10-25 15:00:35 -070035struct Thread;
36
Elliott Hughes872d4ec2011-10-21 17:07:15 -070037namespace JDWP {
38
Elliott Hughes872d4ec2011-10-21 17:07:15 -070039/*
40 * Fundamental types.
41 *
42 * ObjectId and RefTypeId must be the same size.
43 */
44typedef uint32_t FieldId; /* static or instance field */
45typedef uint32_t MethodId; /* any kind of method, including constructors */
46typedef uint64_t ObjectId; /* any object (threadID, stringID, arrayID, etc) */
47typedef uint64_t RefTypeId; /* like ObjectID, but unique for Class objects */
48typedef uint64_t FrameId; /* short-lived stack frame ID */
49
50/*
51 * Match these with the type sizes. This way we don't have to pass
52 * a value and a length.
53 */
Elliott Hughesf7c3b662011-10-27 12:04:56 -070054static inline FieldId ReadFieldId(const uint8_t** pBuf) { return Read4BE(pBuf); }
55static inline MethodId ReadMethodId(const uint8_t** pBuf) { return Read4BE(pBuf); }
56static inline ObjectId ReadObjectId(const uint8_t** pBuf) { return Read8BE(pBuf); }
57static inline RefTypeId ReadRefTypeId(const uint8_t** pBuf) { return Read8BE(pBuf); }
58static inline FrameId ReadFrameId(const uint8_t** pBuf) { return Read8BE(pBuf); }
Elliott Hughesaed4be92011-12-02 16:16:23 -080059static inline JdwpTag ReadTag(const uint8_t** pBuf) { return static_cast<JdwpTag>(Read1(pBuf)); }
Elliott Hughesd07986f2011-12-06 18:27:45 -080060static inline JdwpTypeTag ReadTypeTag(const uint8_t** pBuf) { return static_cast<JdwpTypeTag>(Read1(pBuf)); }
Elliott Hughesf7c3b662011-10-27 12:04:56 -070061static inline void SetFieldId(uint8_t* buf, FieldId val) { return Set4BE(buf, val); }
62static inline void SetMethodId(uint8_t* buf, MethodId val) { return Set4BE(buf, val); }
63static inline void SetObjectId(uint8_t* buf, ObjectId val) { return Set8BE(buf, val); }
64static inline void SetRefTypeId(uint8_t* buf, RefTypeId val) { return Set8BE(buf, val); }
65static inline void SetFrameId(uint8_t* buf, FrameId val) { return Set8BE(buf, val); }
Elliott Hughes872d4ec2011-10-21 17:07:15 -070066static inline void expandBufAddFieldId(ExpandBuf* pReply, FieldId id) { expandBufAdd4BE(pReply, id); }
67static inline void expandBufAddMethodId(ExpandBuf* pReply, MethodId id) { expandBufAdd4BE(pReply, id); }
68static inline void expandBufAddObjectId(ExpandBuf* pReply, ObjectId id) { expandBufAdd8BE(pReply, id); }
69static inline void expandBufAddRefTypeId(ExpandBuf* pReply, RefTypeId id) { expandBufAdd8BE(pReply, id); }
70static inline void expandBufAddFrameId(ExpandBuf* pReply, FrameId id) { expandBufAdd8BE(pReply, id); }
71
Elliott Hughes872d4ec2011-10-21 17:07:15 -070072/*
73 * Holds a JDWP "location".
74 */
75struct JdwpLocation {
Elliott Hughesd07986f2011-12-06 18:27:45 -080076 JdwpTypeTag typeTag;
77 RefTypeId classId;
78 MethodId methodId;
Elliott Hughes972a47b2012-02-21 18:16:06 -080079 uint64_t dex_pc;
Elliott Hughes872d4ec2011-10-21 17:07:15 -070080};
Elliott Hughes03181a82011-11-17 17:22:21 -080081std::ostream& operator<<(std::ostream& os, const JdwpLocation& rhs);
Elliott Hughes2aa2e392012-02-17 17:15:43 -080082bool operator==(const JdwpLocation& lhs, const JdwpLocation& rhs);
83bool operator!=(const JdwpLocation& lhs, const JdwpLocation& rhs);
Elliott Hughes872d4ec2011-10-21 17:07:15 -070084
85/*
86 * How we talk to the debugger.
87 */
88enum JdwpTransportType {
89 kJdwpTransportUnknown = 0,
90 kJdwpTransportSocket, /* transport=dt_socket */
91 kJdwpTransportAndroidAdb, /* transport=dt_android_adb */
92};
93std::ostream& operator<<(std::ostream& os, const JdwpTransportType& rhs);
94
Elliott Hughes376a7a02011-10-24 18:35:55 -070095struct JdwpOptions {
Elliott Hughes872d4ec2011-10-21 17:07:15 -070096 JdwpTransportType transport;
97 bool server;
98 bool suspend;
Elliott Hughesd1cc8362011-10-24 16:58:50 -070099 std::string host;
Elliott Hughes6d8dd472012-01-17 18:27:41 -0800100 uint16_t port;
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700101};
102
Elliott Hughes376a7a02011-10-24 18:35:55 -0700103struct JdwpEvent;
104struct JdwpNetState;
105struct JdwpReqHeader;
106struct JdwpTransport;
Elliott Hughes761928d2011-11-16 18:33:03 -0800107struct ModBasket;
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700108
109/*
Elliott Hughes376a7a02011-10-24 18:35:55 -0700110 * State for JDWP functions.
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700111 */
Elliott Hughes376a7a02011-10-24 18:35:55 -0700112struct JdwpState {
113 /*
114 * Perform one-time initialization.
115 *
116 * Among other things, this binds to a port to listen for a connection from
117 * the debugger.
118 *
119 * Returns a newly-allocated JdwpState struct on success, or NULL on failure.
120 */
121 static JdwpState* Create(const JdwpOptions* options);
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700122
Elliott Hughes376a7a02011-10-24 18:35:55 -0700123 ~JdwpState();
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700124
Elliott Hughes376a7a02011-10-24 18:35:55 -0700125 /*
126 * Returns "true" if a debugger or DDM is connected.
127 */
128 bool IsActive();
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700129
Elliott Hughes475fc232011-10-25 15:00:35 -0700130 /**
131 * Returns the Thread* for the JDWP daemon thread.
Elliott Hughes376a7a02011-10-24 18:35:55 -0700132 */
Elliott Hughes475fc232011-10-25 15:00:35 -0700133 Thread* GetDebugThread();
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700134
Elliott Hughes376a7a02011-10-24 18:35:55 -0700135 /*
136 * Get time, in milliseconds, since the last debugger activity.
137 */
138 int64_t LastDebuggerActivity();
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700139
Elliott Hughes376a7a02011-10-24 18:35:55 -0700140 /*
141 * When we hit a debugger event that requires suspension, it's important
142 * that we wait for the thread to suspend itself before processing any
143 * additional requests. (Otherwise, if the debugger immediately sends a
144 * "resume thread" command, the resume might arrive before the thread has
145 * suspended itself.)
146 *
147 * The thread should call the "set" function before sending the event to
148 * the debugger. The main JDWP handler loop calls "get" before processing
149 * an event, and will wait for thread suspension if it's set. Once the
150 * thread has suspended itself, the JDWP handler calls "clear" and
151 * continues processing the current event. This works in the suspend-all
152 * case because the event thread doesn't suspend itself until everything
153 * else has suspended.
154 *
155 * It's possible that multiple threads could encounter thread-suspending
156 * events at the same time, so we grab a mutex in the "set" call, and
157 * release it in the "clear" call.
158 */
159 //ObjectId GetWaitForEventThread();
160 void SetWaitForEventThread(ObjectId threadId);
161 void ClearWaitForEventThread();
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700162
Elliott Hughes376a7a02011-10-24 18:35:55 -0700163 /*
164 * These notify the debug code that something interesting has happened. This
165 * could be a thread starting or ending, an exception, or an opportunity
166 * for a breakpoint. These calls do not mean that an event the debugger
167 * is interested has happened, just that something has happened that the
168 * debugger *might* be interested in.
169 *
170 * The item of interest may trigger multiple events, some or all of which
171 * are grouped together in a single response.
172 *
173 * The event may cause the current thread or all threads (except the
174 * JDWP support thread) to be suspended.
175 */
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700176
Elliott Hughes376a7a02011-10-24 18:35:55 -0700177 /*
178 * The VM has finished initializing. Only called when the debugger is
179 * connected at the time initialization completes.
180 */
181 bool PostVMStart();
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700182
Elliott Hughes376a7a02011-10-24 18:35:55 -0700183 /*
184 * A location of interest has been reached. This is used for breakpoints,
185 * single-stepping, and method entry/exit. (JDWP requires that these four
186 * events are grouped together in a single response.)
187 *
188 * In some cases "*pLoc" will just have a method and class name, e.g. when
189 * issuing a MethodEntry on a native method.
190 *
191 * "eventFlags" indicates the types of events that have occurred.
192 */
193 bool PostLocationEvent(const JdwpLocation* pLoc, ObjectId thisPtr, int eventFlags);
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700194
Elliott Hughes376a7a02011-10-24 18:35:55 -0700195 /*
196 * An exception has been thrown.
197 *
198 * Pass in a zeroed-out "*pCatchLoc" if the exception wasn't caught.
199 */
200 bool PostException(const JdwpLocation* pThrowLoc, ObjectId excepId, RefTypeId excepClassId, const JdwpLocation* pCatchLoc, ObjectId thisPtr);
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700201
Elliott Hughes376a7a02011-10-24 18:35:55 -0700202 /*
203 * A thread has started or stopped.
204 */
205 bool PostThreadChange(ObjectId threadId, bool start);
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700206
Elliott Hughes376a7a02011-10-24 18:35:55 -0700207 /*
208 * Class has been prepared.
209 */
Elliott Hughes4740cdf2011-12-07 14:07:12 -0800210 bool PostClassPrepare(JdwpTypeTag tag, RefTypeId refTypeId, const std::string& signature, int status);
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700211
Elliott Hughes376a7a02011-10-24 18:35:55 -0700212 /*
213 * The VM is about to stop.
214 */
215 bool PostVMDeath();
216
217 /*
218 * Send up a chunk of DDM data.
219 */
Elliott Hughescccd84f2011-12-05 16:51:54 -0800220 void DdmSendChunkV(uint32_t type, const iovec* iov, int iov_count);
Elliott Hughes376a7a02011-10-24 18:35:55 -0700221
222 /*
223 * Process a request from the debugger.
224 *
225 * "buf" points past the header, to the content of the message. "dataLen"
226 * can therefore be zero.
227 */
228 void ProcessRequest(const JdwpReqHeader* pHeader, const uint8_t* buf, int dataLen, ExpandBuf* pReply);
229
230 /*
231 * Send an event, formatted into "pReq", to the debugger.
232 *
233 * (Messages are sent asynchronously, and do not receive a reply.)
234 */
235 bool SendRequest(ExpandBuf* pReq);
236
237 void ResetState();
238
239 /* atomic ops to get next serial number */
240 uint32_t NextRequestSerial();
241 uint32_t NextEventSerial();
242
243 void Run();
244
Elliott Hughes761928d2011-11-16 18:33:03 -0800245 /*
246 * Register an event by adding it to the event list.
247 *
248 * "*pEvent" must be storage allocated with jdwpEventAlloc(). The caller
249 * may discard its pointer after calling this.
250 */
251 JdwpError RegisterEvent(JdwpEvent* pEvent);
252
253 /*
254 * Unregister an event, given the requestId.
255 */
256 void UnregisterEventById(uint32_t requestId);
257
258 /*
259 * Unregister all events.
260 */
261 void UnregisterAll();
262
Elliott Hughes376a7a02011-10-24 18:35:55 -0700263 private:
Elliott Hughesba8eee12012-01-24 20:25:24 -0800264 explicit JdwpState(const JdwpOptions* options);
Elliott Hughes761928d2011-11-16 18:33:03 -0800265 bool InvokeInProgress();
Elliott Hughes376a7a02011-10-24 18:35:55 -0700266 bool IsConnected();
Elliott Hughes761928d2011-11-16 18:33:03 -0800267 void SuspendByPolicy(JdwpSuspendPolicy suspendPolicy);
268 void CleanupMatchList(JdwpEvent** matchList, int matchCount);
269 void EventFinish(ExpandBuf* pReq);
270 void FindMatchingEvents(JdwpEventKind eventKind, ModBasket* basket, JdwpEvent** matchList, int* pMatchCount);
271 void UnregisterEvent(JdwpEvent* pEvent);
Elliott Hughes376a7a02011-10-24 18:35:55 -0700272
273public: // TODO: fix privacy
274 const JdwpOptions* options_;
275private:
276
277 /* wait for creation of the JDWP thread */
278 Mutex thread_start_lock_;
279 ConditionVariable thread_start_cond_;
280
281 volatile int32_t debug_thread_started_;
Elliott Hughes475fc232011-10-25 15:00:35 -0700282 pthread_t pthread_;
283 Thread* thread_;
Elliott Hughes376a7a02011-10-24 18:35:55 -0700284public: // TODO: fix privacy
285 ObjectId debugThreadId;
286private:
287 bool run;
288
289 const JdwpTransport* transport;
290public: // TODO: fix privacy
291 JdwpNetState* netState;
292private:
293
294 /* for wait-for-debugger */
295 Mutex attach_lock_;
296 ConditionVariable attach_cond_;
297
298 /* time of last debugger activity, in milliseconds */
299 int64_t lastActivityWhen;
300
301 /* global counters and a mutex to protect them */
302 uint32_t requestSerial;
303 uint32_t eventSerial;
304 Mutex serial_lock_;
305
306 /*
307 * Events requested by the debugger (breakpoints, class prep, etc).
308 */
309public: // TODO: fix privacy
310 int numEvents; /* #of elements in eventList */
311 JdwpEvent* eventList; /* linked list of events */
312 Mutex event_lock_; /* guards numEvents/eventList */
313private:
314
315 /*
316 * Synchronize suspension of event thread (to avoid receiving "resume"
317 * events before the thread has finished suspending itself).
318 */
319 Mutex event_thread_lock_;
320 ConditionVariable event_thread_cond_;
321 ObjectId eventThreadId;
322
323 /*
324 * DDM support.
325 */
326public: // TODO: fix privacy
327 bool ddmActive;
328private:
329};
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700330
331} // namespace JDWP
332
333} // namespace art
334
335#endif // ART_JDWP_JDWP_H_