1// Copyright 2006-2008 the V8 project authors. All rights reserved.
2// 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
28#ifndef V8_DEBUG_AGENT_H_
29#define V8_DEBUG_AGENT_H_
30
31#ifdef ENABLE_DEBUGGER_SUPPORT
32#include "../include/v8-debug.h"
33#include "platform.h"
34
35namespace v8 {
36namespace internal {
37
38// Forward decelrations.
39class DebuggerAgentSession;
40
41
42// Debugger agent which starts a socket listener on the debugger port and
43// handles connection from a remote debugger.
44class DebuggerAgent: public Thread {
45 public:
46  DebuggerAgent(const char* name, int port)
47      : Thread(name),
48        isolate_(Isolate::Current()),
49        name_(StrDup(name)), port_(port),
50        server_(OS::CreateSocket()), terminate_(false),
51        session_access_(OS::CreateMutex()), session_(NULL),
52        terminate_now_(OS::CreateSemaphore(0)),
53        listening_(OS::CreateSemaphore(0)) {
54    ASSERT(isolate_->debugger_agent_instance() == NULL);
55    isolate_->set_debugger_agent_instance(this);
56  }
57  ~DebuggerAgent() {
58     isolate_->set_debugger_agent_instance(NULL);
59     delete server_;
60  }
61
62  void Shutdown();
63  void WaitUntilListening();
64
65  Isolate* isolate() { return isolate_; }
66
67 private:
68  void Run();
69  void CreateSession(Socket* socket);
70  void DebuggerMessage(const v8::Debug::Message& message);
71  void CloseSession();
72  void OnSessionClosed(DebuggerAgentSession* session);
73
74  Isolate* isolate_;
75  SmartArrayPointer<const char> name_;  // Name of the embedding application.
76  int port_;  // Port to use for the agent.
77  Socket* server_;  // Server socket for listen/accept.
78  bool terminate_;  // Termination flag.
79  Mutex* session_access_;  // Mutex guarging access to session_.
80  DebuggerAgentSession* session_;  // Current active session if any.
81  Semaphore* terminate_now_;  // Semaphore to signal termination.
82  Semaphore* listening_;
83
84  friend class DebuggerAgentSession;
85  friend void DebuggerAgentMessageHandler(const v8::Debug::Message& message);
86
87  DISALLOW_COPY_AND_ASSIGN(DebuggerAgent);
88};
89
90
91// Debugger agent session. The session receives requests from the remote
92// debugger and sends debugger events/responses to the remote debugger.
93class DebuggerAgentSession: public Thread {
94 public:
95  DebuggerAgentSession(DebuggerAgent* agent, Socket* client)
96      : Thread("v8:DbgAgntSessn"),
97        agent_(agent), client_(client) {}
98
99  void DebuggerMessage(Vector<uint16_t> message);
100  void Shutdown();
101
102 private:
103  void Run();
104
105  void DebuggerMessage(Vector<char> message);
106
107  DebuggerAgent* agent_;
108  Socket* client_;
109
110  DISALLOW_COPY_AND_ASSIGN(DebuggerAgentSession);
111};
112
113
114// Utility methods factored out to be used by the D8 shell as well.
115class DebuggerAgentUtil {
116 public:
117  static const char* const kContentLength;
118
119  static SmartArrayPointer<char> ReceiveMessage(const Socket* conn);
120  static bool SendConnectMessage(const Socket* conn,
121                                 const char* embedding_host);
122  static bool SendMessage(const Socket* conn, const Vector<uint16_t> message);
123  static bool SendMessage(const Socket* conn,
124                          const v8::Handle<v8::String> message);
125  static int ReceiveAll(const Socket* conn, char* data, int len);
126};
127
128} }  // namespace v8::internal
129
130#endif  // ENABLE_DEBUGGER_SUPPORT
131
132#endif  // V8_DEBUG_AGENT_H_
133