blob: ffd3da9b4762aff9277c767cf73024cc12defe4f [file] [log] [blame]
ager@chromium.org9258b6b2008-09-11 09:11:10 +00001// Copyright 2006-2008 the V8 project authors. All rights reserved.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002// Redistribution and use in source and binary forms, with or without
3// modification, are permitted provided that the following conditions are
4// met:
5//
6// * Redistributions of source code must retain the above copyright
7// notice, this list of conditions and the following disclaimer.
8// * Redistributions in binary form must reproduce the above
9// copyright notice, this list of conditions and the following
10// disclaimer in the documentation and/or other materials provided
11// with the distribution.
12// * Neither the name of Google Inc. nor the names of its
13// contributors may be used to endorse or promote products derived
14// from this software without specific prior written permission.
15//
16// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
17// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
18// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
19// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
20// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
21// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
26// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27
ager@chromium.org9258b6b2008-09-11 09:11:10 +000028#ifndef V8_V8_DEBUG_H_
29#define V8_V8_DEBUG_H_
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +000030
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +000031#include "assembler.h"
32#include "code-stubs.h"
kasperl@chromium.org7be3c992009-03-12 07:19:55 +000033#include "debug-agent.h"
kasperl@chromium.org41044eb2008-10-06 08:24:46 +000034#include "execution.h"
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +000035#include "factory.h"
36#include "platform.h"
37#include "string-stream.h"
kasperl@chromium.org7be3c992009-03-12 07:19:55 +000038#include "v8threads.h"
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +000039
ager@chromium.org65dad4b2009-04-23 08:48:43 +000040#ifdef ENABLE_DEBUGGER_SUPPORT
41#include "../include/v8-debug.h"
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +000042
43namespace v8 { namespace internal {
44
kasperl@chromium.org7be3c992009-03-12 07:19:55 +000045
46// Forward declarations.
47class EnterDebugger;
48
49
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +000050// Step actions. NOTE: These values are in macros.py as well.
51enum StepAction {
52 StepNone = -1, // Stepping not prepared.
53 StepOut = 0, // Step out of the current function.
54 StepNext = 1, // Step to the next statement in the current function.
55 StepIn = 2, // Step into new functions invoked or the next statement
56 // in the current function.
57 StepMin = 3, // Perform a minimum step in the current function.
58 StepInMin = 4 // Step into new functions invoked or perform a minimum step
59 // in the current function.
60};
61
62
63// Type of exception break. NOTE: These values are in macros.py as well.
64enum ExceptionBreakType {
65 BreakException = 0,
66 BreakUncaughtException = 1
67};
68
69
70// Type of exception break. NOTE: These values are in macros.py as well.
71enum BreakLocatorType {
72 ALL_BREAK_LOCATIONS = 0,
73 SOURCE_BREAK_LOCATIONS = 1
74};
75
76
77// Class for iterating through the break points in a function and changing
78// them.
79class BreakLocationIterator {
80 public:
81 explicit BreakLocationIterator(Handle<DebugInfo> debug_info,
82 BreakLocatorType type);
83 virtual ~BreakLocationIterator();
84
85 void Next();
86 void Next(int count);
87 void FindBreakLocationFromAddress(Address pc);
88 void FindBreakLocationFromPosition(int position);
89 void Reset();
90 bool Done() const;
91 void SetBreakPoint(Handle<Object> break_point_object);
92 void ClearBreakPoint(Handle<Object> break_point_object);
93 void SetOneShot();
94 void ClearOneShot();
95 void PrepareStepIn();
96 bool IsExit() const;
97 bool HasBreakPoint();
98 bool IsDebugBreak();
99 Object* BreakPointObjects();
ager@chromium.org381abbb2009-02-25 13:23:22 +0000100 void ClearAllDebugBreak();
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000101
102
103 inline int code_position() { return pc() - debug_info_->code()->entry(); }
104 inline int break_point() { return break_point_; }
105 inline int position() { return position_; }
106 inline int statement_position() { return statement_position_; }
107 inline Address pc() { return reloc_iterator_->rinfo()->pc(); }
108 inline Code* code() { return debug_info_->code(); }
109 inline RelocInfo* rinfo() { return reloc_iterator_->rinfo(); }
ager@chromium.org236ad962008-09-25 09:45:57 +0000110 inline RelocInfo::Mode rmode() const {
111 return reloc_iterator_->rinfo()->rmode();
112 }
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000113 inline RelocInfo* original_rinfo() {
114 return reloc_iterator_original_->rinfo();
115 }
ager@chromium.org236ad962008-09-25 09:45:57 +0000116 inline RelocInfo::Mode original_rmode() const {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000117 return reloc_iterator_original_->rinfo()->rmode();
118 }
119
120 protected:
121 bool RinfoDone() const;
122 void RinfoNext();
123
124 BreakLocatorType type_;
125 int break_point_;
126 int position_;
127 int statement_position_;
128 Handle<DebugInfo> debug_info_;
129 RelocIterator* reloc_iterator_;
130 RelocIterator* reloc_iterator_original_;
131
132 private:
133 void SetDebugBreak();
134 void ClearDebugBreak();
ager@chromium.org65dad4b2009-04-23 08:48:43 +0000135
136 void SetDebugBreakAtIC();
137 void ClearDebugBreakAtIC();
138
iposva@chromium.org245aa852009-02-10 00:49:54 +0000139 bool IsDebugBreakAtReturn();
140 void SetDebugBreakAtReturn();
141 void ClearDebugBreakAtReturn();
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000142
mads.s.ager@gmail.com9a4089a2008-09-01 08:55:01 +0000143 DISALLOW_COPY_AND_ASSIGN(BreakLocationIterator);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000144};
145
146
147// Linked list holding debug info objects. The debug info objects are kept as
148// weak handles to avoid a debug info object to keep a function alive.
149class DebugInfoListNode {
150 public:
151 explicit DebugInfoListNode(DebugInfo* debug_info);
152 virtual ~DebugInfoListNode();
153
154 DebugInfoListNode* next() { return next_; }
155 void set_next(DebugInfoListNode* next) { next_ = next; }
156 Handle<DebugInfo> debug_info() { return debug_info_; }
157
158 private:
159 // Global (weak) handle to the debug info object.
160 Handle<DebugInfo> debug_info_;
161
162 // Next pointer for linked list.
163 DebugInfoListNode* next_;
164};
165
166
167// This class contains the debugger support. The main purpose is to handle
168// setting break points in the code.
169//
170// This class controls the debug info for all functions which currently have
171// active breakpoints in them. This debug info is held in the heap root object
172// debug_info which is a FixedArray. Each entry in this list is of class
173// DebugInfo.
174class Debug {
175 public:
176 static void Setup(bool create_heap_objects);
177 static bool Load();
178 static void Unload();
179 static bool IsLoaded() { return !debug_context_.is_null(); }
kasperl@chromium.org7be3c992009-03-12 07:19:55 +0000180 static bool InDebugger() { return thread_local_.debugger_entry_ != NULL; }
181 static void PreemptionWhileInDebugger();
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000182 static void Iterate(ObjectVisitor* v);
183
184 static Object* Break(Arguments args);
185 static void SetBreakPoint(Handle<SharedFunctionInfo> shared,
186 int source_position,
187 Handle<Object> break_point_object);
188 static void ClearBreakPoint(Handle<Object> break_point_object);
ager@chromium.org381abbb2009-02-25 13:23:22 +0000189 static void ClearAllBreakPoints();
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000190 static void FloodWithOneShot(Handle<SharedFunctionInfo> shared);
191 static void FloodHandlerWithOneShot();
192 static void ChangeBreakOnException(ExceptionBreakType type, bool enable);
193 static void PrepareStep(StepAction step_action, int step_count);
194 static void ClearStepping();
195 static bool StepNextContinue(BreakLocationIterator* break_location_iterator,
196 JavaScriptFrame* frame);
197 static Handle<DebugInfo> GetDebugInfo(Handle<SharedFunctionInfo> shared);
198 static bool HasDebugInfo(Handle<SharedFunctionInfo> shared);
kasper.lundbd3ec4e2008-07-09 11:06:54 +0000199
ager@chromium.org32912102009-01-16 10:38:43 +0000200 // Returns whether the operation succeeded.
kasper.lundbd3ec4e2008-07-09 11:06:54 +0000201 static bool EnsureDebugInfo(Handle<SharedFunctionInfo> shared);
202
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000203 static bool IsDebugBreak(Address addr);
ager@chromium.org381abbb2009-02-25 13:23:22 +0000204 static bool IsDebugBreakAtReturn(RelocInfo* rinfo);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000205
206 // Check whether a code stub with the specified major key is a possible break
207 // point location.
208 static bool IsSourceBreakStub(Code* code);
209 static bool IsBreakStub(Code* code);
210
211 // Find the builtin to use for invoking the debug break
ager@chromium.org65dad4b2009-04-23 08:48:43 +0000212 static Handle<Code> FindDebugBreak(Handle<Code> code, RelocInfo::Mode mode);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000213
214 static Handle<Object> GetSourceBreakLocations(
215 Handle<SharedFunctionInfo> shared);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000216
217 // Getter for the debug_context.
218 inline static Handle<Context> debug_context() { return debug_context_; }
219
220 // Check whether a global object is the debug global object.
221 static bool IsDebugGlobal(GlobalObject* global);
222
223 // Fast check to see if any break points are active.
224 inline static bool has_break_points() { return has_break_points_; }
225
kasperl@chromium.org7be3c992009-03-12 07:19:55 +0000226 static void NewBreak(StackFrame::Id break_frame_id);
227 static void SetBreak(StackFrame::Id break_frame_id, int break_id);
228 static StackFrame::Id break_frame_id() {
229 return thread_local_.break_frame_id_;
230 }
231 static int break_id() { return thread_local_.break_id_; }
232
233
234
235
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000236 static bool StepInActive() { return thread_local_.step_into_fp_ != 0; }
christian.plesner.hansen@gmail.com37abdec2009-01-06 14:43:28 +0000237 static void HandleStepIn(Handle<JSFunction> function,
238 Address fp,
239 bool is_constructor);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000240 static Address step_in_fp() { return thread_local_.step_into_fp_; }
241 static Address* step_in_fp_addr() { return &thread_local_.step_into_fp_; }
242
kasperl@chromium.org7be3c992009-03-12 07:19:55 +0000243 static EnterDebugger* debugger_entry() {
244 return thread_local_.debugger_entry_;
245 }
246 static void set_debugger_entry(EnterDebugger* entry) {
247 thread_local_.debugger_entry_ = entry;
248 }
249
250 static bool preemption_pending() {
251 return thread_local_.preemption_pending_;
252 }
253 static void set_preemption_pending(bool preemption_pending) {
254 thread_local_.preemption_pending_ = preemption_pending;
255 }
256
kasper.lundbd3ec4e2008-07-09 11:06:54 +0000257 // Getter and setter for the disable break state.
258 static bool disable_break() { return disable_break_; }
259 static void set_disable_break(bool disable_break) {
260 disable_break_ = disable_break;
261 }
262
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000263 // Getters for the current exception break state.
264 static bool break_on_exception() { return break_on_exception_; }
265 static bool break_on_uncaught_exception() {
266 return break_on_uncaught_exception_;
267 }
268
269 enum AddressId {
270 k_after_break_target_address,
271 k_debug_break_return_address,
272 k_register_address
273 };
274
275 // Support for setting the address to jump to when returning from break point.
276 static Address* after_break_target_address() {
277 return reinterpret_cast<Address*>(&thread_local_.after_break_target_);
278 }
279
280 // Support for saving/restoring registers when handling debug break calls.
kasperl@chromium.org41044eb2008-10-06 08:24:46 +0000281 static Object** register_address(int r) {
282 return &registers_[r];
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000283 }
284
kasper.lund7276f142008-07-30 08:49:36 +0000285 // Address of the debug break return entry code.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000286 static Code* debug_break_return_entry() { return debug_break_return_entry_; }
287
288 // Support for getting the address of the debug break on return code.
kasperl@chromium.org41044eb2008-10-06 08:24:46 +0000289 static Code** debug_break_return_address() {
290 return &debug_break_return_;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000291 }
292
293 static const int kEstimatedNofDebugInfoEntries = 16;
294 static const int kEstimatedNofBreakPointsInFunction = 16;
295
kasperl@chromium.org5a8ca6c2008-10-23 13:57:19 +0000296 static void HandleWeakDebugInfo(v8::Persistent<v8::Value> obj, void* data);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000297
298 friend class Debugger;
ager@chromium.org381abbb2009-02-25 13:23:22 +0000299 friend Handle<FixedArray> GetDebuggedFunctions(); // In test-debug.cc
300 friend void CheckDebuggerUnloaded(bool check_functions); // In test-debug.cc
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000301
302 // Threading support.
303 static char* ArchiveDebug(char* to);
304 static char* RestoreDebug(char* from);
305 static int ArchiveSpacePerThread();
306
ager@chromium.org32912102009-01-16 10:38:43 +0000307 // Mirror cache handling.
308 static void ClearMirrorCache();
309
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000310 // Code generation assumptions.
311 static const int kIa32CallInstructionLength = 5;
312 static const int kIa32JSReturnSequenceLength = 6;
313
ager@chromium.org8bb60582008-12-11 12:02:20 +0000314 // Code generator routines.
315 static void GenerateLoadICDebugBreak(MacroAssembler* masm);
316 static void GenerateStoreICDebugBreak(MacroAssembler* masm);
317 static void GenerateKeyedLoadICDebugBreak(MacroAssembler* masm);
318 static void GenerateKeyedStoreICDebugBreak(MacroAssembler* masm);
319 static void GenerateConstructCallDebugBreak(MacroAssembler* masm);
320 static void GenerateReturnDebugBreak(MacroAssembler* masm);
321 static void GenerateReturnDebugBreakEntry(MacroAssembler* masm);
322 static void GenerateStubNoRegistersDebugBreak(MacroAssembler* masm);
323
324 // Called from stub-cache.cc.
325 static void GenerateCallICDebugBreak(MacroAssembler* masm);
326
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000327 private:
328 static bool CompileDebuggerScript(int index);
329 static void ClearOneShot();
330 static void ActivateStepIn(StackFrame* frame);
331 static void ClearStepIn();
332 static void ClearStepNext();
ager@chromium.org32912102009-01-16 10:38:43 +0000333 // Returns whether the compile succeeded.
kasper.lundbd3ec4e2008-07-09 11:06:54 +0000334 static bool EnsureCompiled(Handle<SharedFunctionInfo> shared);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000335 static void RemoveDebugInfo(Handle<DebugInfo> debug_info);
336 static void SetAfterBreakTarget(JavaScriptFrame* frame);
337 static Handle<Object> CheckBreakPoints(Handle<Object> break_point);
338 static bool CheckBreakPoint(Handle<Object> break_point_object);
339
340 // Global handle to debug context where all the debugger JavaScript code is
341 // loaded.
342 static Handle<Context> debug_context_;
343
344 // Boolean state indicating whether any break points are set.
345 static bool has_break_points_;
346 static DebugInfoListNode* debug_info_list_;
347
kasper.lundbd3ec4e2008-07-09 11:06:54 +0000348 static bool disable_break_;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000349 static bool break_on_exception_;
350 static bool break_on_uncaught_exception_;
351
kasperl@chromium.org7be3c992009-03-12 07:19:55 +0000352 // Per-thread data.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000353 class ThreadLocal {
354 public:
kasperl@chromium.org7be3c992009-03-12 07:19:55 +0000355 // Counter for generating next break id.
356 int break_count_;
357
358 // Current break id.
359 int break_id_;
360
361 // Frame id for the frame of the current break.
362 StackFrame::Id break_frame_id_;
363
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000364 // Step action for last step performed.
365 StepAction last_step_action_;
366
367 // Source statement position from last step next action.
368 int last_statement_position_;
369
370 // Number of steps left to perform before debug event.
371 int step_count_;
372
373 // Frame pointer from last step next action.
374 Address last_fp_;
375
376 // Frame pointer for frame from which step in was performed.
377 Address step_into_fp_;
378
379 // Storage location for jump when exiting debug break calls.
380 Address after_break_target_;
kasperl@chromium.org7be3c992009-03-12 07:19:55 +0000381
382 // Top debugger entry.
383 EnterDebugger* debugger_entry_;
384
385 // Preemption happened while debugging.
386 bool preemption_pending_;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000387 };
388
389 // Storage location for registers when handling debug break calls
390 static JSCallerSavedBuffer registers_;
391 static ThreadLocal thread_local_;
392 static void ThreadInit();
393
394 // Code object for debug break return entry code.
395 static Code* debug_break_return_entry_;
396
397 // Code to call for handling debug break on return.
398 static Code* debug_break_return_;
399
mads.s.ager@gmail.com9a4089a2008-09-01 08:55:01 +0000400 DISALLOW_COPY_AND_ASSIGN(Debug);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000401};
402
403
ager@chromium.org65dad4b2009-04-23 08:48:43 +0000404// Message send by user to v8 debugger or debugger output message.
405// In addition to command text it may contain a pointer to some user data
406// which are expected to be passed along with the command reponse to message
407// handler.
408class Message {
409 public:
410 static Message NewCommand(const Vector<uint16_t>& command,
411 v8::Debug::ClientData* data);
412 static Message NewOutput(v8::Handle<v8::String> output,
413 v8::Debug::ClientData* data);
414 static Message NewEmptyMessage();
415 Message();
416 ~Message();
417
418 // Deletes user data and disposes of the text.
419 void Dispose();
420 Vector<uint16_t> text() const { return text_; }
421 v8::Debug::ClientData* client_data() const { return client_data_; }
422 private:
423 Message(const Vector<uint16_t>& text,
424 v8::Debug::ClientData* data);
425
426 Vector<uint16_t> text_;
427 v8::Debug::ClientData* client_data_;
428};
429
ager@chromium.org41826e72009-03-30 13:30:57 +0000430// A Queue of Vector<uint16_t> objects. A thread-safe version is
431// LockingMessageQueue, based on this class.
432class MessageQueue BASE_EMBEDDED {
433 public:
434 explicit MessageQueue(int size);
435 ~MessageQueue();
436 bool IsEmpty() const { return start_ == end_; }
ager@chromium.org65dad4b2009-04-23 08:48:43 +0000437 Message Get();
438 void Put(const Message& message);
ager@chromium.org41826e72009-03-30 13:30:57 +0000439 void Clear() { start_ = end_ = 0; } // Queue is empty after Clear().
440 private:
441 // Doubles the size of the message queue, and copies the messages.
442 void Expand();
443
ager@chromium.org65dad4b2009-04-23 08:48:43 +0000444 Message* messages_;
ager@chromium.org41826e72009-03-30 13:30:57 +0000445 int start_;
446 int end_;
447 int size_; // The size of the queue buffer. Queue can hold size-1 messages.
448};
449
450
451// LockingMessageQueue is a thread-safe circular buffer of Vector<uint16_t>
452// messages. The message data is not managed by LockingMessageQueue.
453// Pointers to the data are passed in and out. Implemented by adding a
454// Mutex to MessageQueue. Includes logging of all puts and gets.
455class LockingMessageQueue BASE_EMBEDDED {
456 public:
457 explicit LockingMessageQueue(int size);
458 ~LockingMessageQueue();
459 bool IsEmpty() const;
ager@chromium.org65dad4b2009-04-23 08:48:43 +0000460 Message Get();
461 void Put(const Message& message);
ager@chromium.org41826e72009-03-30 13:30:57 +0000462 void Clear();
463 private:
464 MessageQueue queue_;
465 Mutex* lock_;
466 DISALLOW_COPY_AND_ASSIGN(LockingMessageQueue);
467};
468
469
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000470class DebugMessageThread;
471
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000472class Debugger {
473 public:
474 static void DebugRequest(const uint16_t* json_request, int length);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000475
476 static Handle<Object> MakeJSObject(Vector<const char> constructor_name,
477 int argc, Object*** argv,
478 bool* caught_exception);
479 static Handle<Object> MakeExecutionState(bool* caught_exception);
480 static Handle<Object> MakeBreakEvent(Handle<Object> exec_state,
481 Handle<Object> break_points_hit,
482 bool* caught_exception);
483 static Handle<Object> MakeExceptionEvent(Handle<Object> exec_state,
484 Handle<Object> exception,
485 bool uncaught,
486 bool* caught_exception);
487 static Handle<Object> MakeNewFunctionEvent(Handle<Object> func,
488 bool* caught_exception);
489 static Handle<Object> MakeCompileEvent(Handle<Script> script,
iposva@chromium.org245aa852009-02-10 00:49:54 +0000490 bool before,
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000491 bool* caught_exception);
ager@chromium.orgbb29dc92009-03-24 13:25:23 +0000492 static void OnDebugBreak(Handle<Object> break_points_hit, bool auto_continue);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000493 static void OnException(Handle<Object> exception, bool uncaught);
494 static void OnBeforeCompile(Handle<Script> script);
495 static void OnAfterCompile(Handle<Script> script,
496 Handle<JSFunction> fun);
497 static void OnNewFunction(Handle<JSFunction> fun);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000498 static void ProcessDebugEvent(v8::DebugEvent event,
ager@chromium.orgbb29dc92009-03-24 13:25:23 +0000499 Handle<Object> event_data,
500 bool auto_continue);
ager@chromium.org41826e72009-03-30 13:30:57 +0000501 static void NotifyMessageHandler(v8::DebugEvent event,
502 Handle<Object> exec_state,
503 Handle<Object> event_data,
504 bool auto_continue);
iposva@chromium.org245aa852009-02-10 00:49:54 +0000505 static void SetEventListener(Handle<Object> callback, Handle<Object> data);
ager@chromium.org65dad4b2009-04-23 08:48:43 +0000506 static void SetMessageHandler(v8::Debug::MessageHandler handler,
ager@chromium.org41826e72009-03-30 13:30:57 +0000507 bool message_handler_thread);
508 static void TearDown();
ager@chromium.org65dad4b2009-04-23 08:48:43 +0000509 static void SetHostDispatchHandler(v8::Debug::HostDispatchHandler handler,
510 int period);
ager@chromium.org41826e72009-03-30 13:30:57 +0000511
512 // Invoke the message handler function.
ager@chromium.org65dad4b2009-04-23 08:48:43 +0000513 static void InvokeMessageHandler(Message message);
ager@chromium.org41826e72009-03-30 13:30:57 +0000514
515 // Send a message to the message handler eiher through the message thread or
516 // directly.
ager@chromium.org65dad4b2009-04-23 08:48:43 +0000517 static void SendMessage(Message message);
ager@chromium.org41826e72009-03-30 13:30:57 +0000518
519 // Send the JSON message for a debug event.
520 static bool SendEventMessage(Handle<Object> event_data);
521
522 // Add a debugger command to the command queue.
ager@chromium.org65dad4b2009-04-23 08:48:43 +0000523 static void ProcessCommand(Vector<const uint16_t> command,
524 v8::Debug::ClientData* client_data = NULL);
ager@chromium.org41826e72009-03-30 13:30:57 +0000525
526 // Check whether there are commands in the command queue.
ager@chromium.orgbb29dc92009-03-24 13:25:23 +0000527 static bool HasCommands();
ager@chromium.org41826e72009-03-30 13:30:57 +0000528
ager@chromium.orga74f0da2008-12-03 16:05:52 +0000529 static Handle<Object> Call(Handle<JSFunction> fun,
530 Handle<Object> data,
531 bool* pending_exception);
532
kasperl@chromium.org7be3c992009-03-12 07:19:55 +0000533 // Start the debugger agent listening on the provided port.
ager@chromium.orgbb29dc92009-03-24 13:25:23 +0000534 static bool StartAgent(const char* name, int port);
535
536 // Stop the debugger agent.
537 static void StopAgent();
kasperl@chromium.org7be3c992009-03-12 07:19:55 +0000538
ager@chromium.org71daaf62009-04-01 07:22:49 +0000539 // Unload the debugger if possible. Only called when no debugger is currently
540 // active.
541 static void UnloadDebugger();
542
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000543 inline static bool EventActive(v8::DebugEvent event) {
ager@chromium.org71daaf62009-04-01 07:22:49 +0000544 ScopedLock with(debugger_access_);
545
546 // Check whether the message handler was been cleared.
547 if (message_handler_cleared_) {
548 UnloadDebugger();
549 }
550
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000551 // Currently argument event is not used.
ager@chromium.org71daaf62009-04-01 07:22:49 +0000552 return !compiling_natives_ && Debugger::IsDebuggerActive();
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000553 }
554
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000555 static void set_compiling_natives(bool compiling_natives) {
556 Debugger::compiling_natives_ = compiling_natives;
557 }
558 static bool compiling_natives() { return Debugger::compiling_natives_; }
mads.s.agercbaa0602008-08-14 13:41:48 +0000559 static void set_loading_debugger(bool v) { is_loading_debugger_ = v; }
560 static bool is_loading_debugger() { return Debugger::is_loading_debugger_; }
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000561
562 private:
ager@chromium.org71daaf62009-04-01 07:22:49 +0000563 static bool IsDebuggerActive();
564
565 static Mutex* debugger_access_; // Mutex guarding debugger variables.
566 static Handle<Object> event_listener_; // Global handle to listener.
iposva@chromium.org245aa852009-02-10 00:49:54 +0000567 static Handle<Object> event_listener_data_;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000568 static bool compiling_natives_; // Are we compiling natives?
mads.s.agercbaa0602008-08-14 13:41:48 +0000569 static bool is_loading_debugger_; // Are we loading the debugger?
ager@chromium.org71daaf62009-04-01 07:22:49 +0000570 static bool never_unload_debugger_; // Can we unload the debugger?
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000571 static DebugMessageThread* message_thread_;
ager@chromium.org65dad4b2009-04-23 08:48:43 +0000572 static v8::Debug::MessageHandler message_handler_;
ager@chromium.org71daaf62009-04-01 07:22:49 +0000573 static bool message_handler_cleared_; // Was message handler cleared?
ager@chromium.org65dad4b2009-04-23 08:48:43 +0000574 static v8::Debug::HostDispatchHandler host_dispatch_handler_;
575 static int host_dispatch_micros_;
ager@chromium.org381abbb2009-02-25 13:23:22 +0000576
kasperl@chromium.org7be3c992009-03-12 07:19:55 +0000577 static DebuggerAgent* agent_;
578
ager@chromium.org41826e72009-03-30 13:30:57 +0000579 static const int kQueueInitialSize = 4;
580 static LockingMessageQueue command_queue_;
581 static LockingMessageQueue message_queue_;
582 static Semaphore* command_received_; // Signaled for each command received.
583 static Semaphore* message_received_; // Signalled for each message send.
584
ager@chromium.org71daaf62009-04-01 07:22:49 +0000585 friend class EnterDebugger;
ager@chromium.org381abbb2009-02-25 13:23:22 +0000586 friend class DebugMessageThread;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000587};
588
589
ager@chromium.org41826e72009-03-30 13:30:57 +0000590// Thread to read messages from the message queue and invoke the debug message
591// handler in another thread as the V8 thread. This thread is started if the
592// registration of the debug message handler requested to be called in a thread
593// seperate from the V8 thread.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000594class DebugMessageThread: public Thread {
595 public:
ager@chromium.org41826e72009-03-30 13:30:57 +0000596 DebugMessageThread() : keep_running_(true) {}
597 virtual ~DebugMessageThread() {}
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000598
kasper.lund7276f142008-07-30 08:49:36 +0000599 // Main function of DebugMessageThread thread.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000600 void Run();
ager@chromium.org41826e72009-03-30 13:30:57 +0000601 void Stop();
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000602
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000603 private:
ager@chromium.org41826e72009-03-30 13:30:57 +0000604 bool keep_running_;
mads.s.ager@gmail.com9a4089a2008-09-01 08:55:01 +0000605 DISALLOW_COPY_AND_ASSIGN(DebugMessageThread);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000606};
607
608
kasperl@chromium.org41044eb2008-10-06 08:24:46 +0000609// This class is used for entering the debugger. Create an instance in the stack
610// to enter the debugger. This will set the current break state, make sure the
611// debugger is loaded and switch to the debugger context. If the debugger for
612// some reason could not be entered FailedToEnter will return true.
613class EnterDebugger BASE_EMBEDDED {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000614 public:
kasperl@chromium.org7be3c992009-03-12 07:19:55 +0000615 EnterDebugger()
616 : prev_(Debug::debugger_entry()),
617 has_js_frames_(!it_.done()) {
ager@chromium.orgbb29dc92009-03-24 13:25:23 +0000618 ASSERT(prev_ == NULL ? !Debug::preemption_pending() : true);
kasperl@chromium.org7be3c992009-03-12 07:19:55 +0000619
620 // Link recursive debugger entry.
621 Debug::set_debugger_entry(this);
622
ager@chromium.org8bb60582008-12-11 12:02:20 +0000623 // Store the previous break id and frame id.
kasperl@chromium.org7be3c992009-03-12 07:19:55 +0000624 break_id_ = Debug::break_id();
625 break_frame_id_ = Debug::break_frame_id();
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000626
ager@chromium.org8bb60582008-12-11 12:02:20 +0000627 // Create the new break info. If there is no JavaScript frames there is no
628 // break frame id.
629 if (has_js_frames_) {
kasperl@chromium.org7be3c992009-03-12 07:19:55 +0000630 Debug::NewBreak(it_.frame()->id());
ager@chromium.org8bb60582008-12-11 12:02:20 +0000631 } else {
kasperl@chromium.org7be3c992009-03-12 07:19:55 +0000632 Debug::NewBreak(StackFrame::NO_ID);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000633 }
kasperl@chromium.org41044eb2008-10-06 08:24:46 +0000634
635 // Make sure that debugger is loaded and enter the debugger context.
636 load_failed_ = !Debug::Load();
637 if (!load_failed_) {
638 // NOTE the member variable save which saves the previous context before
639 // this change.
640 Top::set_context(*Debug::debug_context());
kasperl@chromium.org41044eb2008-10-06 08:24:46 +0000641 }
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000642 }
643
kasperl@chromium.org41044eb2008-10-06 08:24:46 +0000644 ~EnterDebugger() {
ager@chromium.org8bb60582008-12-11 12:02:20 +0000645 // Restore to the previous break state.
kasperl@chromium.org7be3c992009-03-12 07:19:55 +0000646 Debug::SetBreak(break_frame_id_, break_id_);
647
648 // Request preemption when leaving the last debugger entry and a preemption
649 // had been recorded while debugging. This is to avoid starvation in some
650 // debugging scenarios.
651 if (prev_ == NULL && Debug::preemption_pending()) {
652 StackGuard::Preempt();
653 Debug::set_preemption_pending(false);
654 }
655
ager@chromium.orgbb29dc92009-03-24 13:25:23 +0000656 // If there are commands in the queue when leaving the debugger request that
657 // these commands are processed.
658 if (prev_ == NULL && Debugger::HasCommands()) {
659 StackGuard::DebugCommand();
660 }
661
ager@chromium.org71daaf62009-04-01 07:22:49 +0000662 // If leaving the debugger with the debugger no longer active unload it.
663 if (prev_ == NULL) {
664 if (!Debugger::IsDebuggerActive()) {
665 Debugger::UnloadDebugger();
666 }
667 }
668
kasperl@chromium.org7be3c992009-03-12 07:19:55 +0000669 // Leaving this debugger entry.
670 Debug::set_debugger_entry(prev_);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000671 }
672
kasperl@chromium.org41044eb2008-10-06 08:24:46 +0000673 // Check whether the debugger could be entered.
674 inline bool FailedToEnter() { return load_failed_; }
675
ager@chromium.orga74f0da2008-12-03 16:05:52 +0000676 // Check whether there are any JavaScript frames on the stack.
ager@chromium.org8bb60582008-12-11 12:02:20 +0000677 inline bool HasJavaScriptFrames() { return has_js_frames_; }
ager@chromium.orga74f0da2008-12-03 16:05:52 +0000678
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000679 private:
kasperl@chromium.org7be3c992009-03-12 07:19:55 +0000680 EnterDebugger* prev_; // Previous debugger entry if entered recursively.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000681 JavaScriptFrameIterator it_;
ager@chromium.org8bb60582008-12-11 12:02:20 +0000682 const bool has_js_frames_; // Were there any JavaScript frames?
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000683 StackFrame::Id break_frame_id_; // Previous break frame id.
684 int break_id_; // Previous break id.
kasperl@chromium.org41044eb2008-10-06 08:24:46 +0000685 bool load_failed_; // Did the debugger fail to load?
686 SaveContext save_; // Saves previous context.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000687};
688
689
kasper.lundbd3ec4e2008-07-09 11:06:54 +0000690// Stack allocated class for disabling break.
691class DisableBreak BASE_EMBEDDED {
692 public:
693 // Enter the debugger by storing the previous top context and setting the
694 // current top context to the debugger context.
695 explicit DisableBreak(bool disable_break) {
696 prev_disable_break_ = Debug::disable_break();
697 Debug::set_disable_break(disable_break);
698 }
699 ~DisableBreak() {
700 Debug::set_disable_break(prev_disable_break_);
701 }
702
703 private:
704 // The previous state of the disable break used to restore the value when this
705 // object is destructed.
706 bool prev_disable_break_;
707};
708
709
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000710// Debug_Address encapsulates the Address pointers used in generating debug
711// code.
712class Debug_Address {
713 public:
714 Debug_Address(Debug::AddressId id, int reg = 0)
715 : id_(id), reg_(reg) {
716 ASSERT(reg == 0 || id == Debug::k_register_address);
717 }
718
719 static Debug_Address AfterBreakTarget() {
720 return Debug_Address(Debug::k_after_break_target_address);
721 }
722
723 static Debug_Address DebugBreakReturn() {
724 return Debug_Address(Debug::k_debug_break_return_address);
725 }
726
727 static Debug_Address Register(int reg) {
728 return Debug_Address(Debug::k_register_address, reg);
729 }
730
731 Address address() const {
732 switch (id_) {
733 case Debug::k_after_break_target_address:
734 return reinterpret_cast<Address>(Debug::after_break_target_address());
735 case Debug::k_debug_break_return_address:
736 return reinterpret_cast<Address>(Debug::debug_break_return_address());
737 case Debug::k_register_address:
738 return reinterpret_cast<Address>(Debug::register_address(reg_));
739 default:
740 UNREACHABLE();
741 return NULL;
742 }
743 }
744 private:
745 Debug::AddressId id_;
746 int reg_;
747};
748
749
750} } // namespace v8::internal
751
ager@chromium.org65dad4b2009-04-23 08:48:43 +0000752#endif // ENABLE_DEBUGGER_SUPPORT
753
ager@chromium.org9258b6b2008-09-11 09:11:10 +0000754#endif // V8_V8_DEBUG_H_