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  explicit DebuggerAgent(const char* name, int port)
47      : name_(StrDup(name)), port_(port),
48        server_(OS::CreateSocket()), terminate_(false),
49        session_access_(OS::CreateMutex()), session_(NULL),
50        terminate_now_(OS::CreateSemaphore(0)),
51        listening_(OS::CreateSemaphore(0)) {
52    ASSERT(instance_ == NULL);
53    instance_ = this;
54  }
55  ~DebuggerAgent() {
56     instance_ = NULL;
57     delete server_;
58  }
59
60  void Shutdown();
61  void WaitUntilListening();
62
63 private:
64  void Run();
65  void CreateSession(Socket* socket);
66  void DebuggerMessage(const v8::Debug::Message& message);
67  void CloseSession();
68  void OnSessionClosed(DebuggerAgentSession* session);
69
70  SmartPointer<const char> name_;  // Name of the embedding application.
71  int port_;  // Port to use for the agent.
72  Socket* server_;  // Server socket for listen/accept.
73  bool terminate_;  // Termination flag.
74  Mutex* session_access_;  // Mutex guarging access to session_.
75  DebuggerAgentSession* session_;  // Current active session if any.
76  Semaphore* terminate_now_;  // Semaphore to signal termination.
77  Semaphore* listening_;
78
79  static DebuggerAgent* instance_;
80
81  friend class DebuggerAgentSession;
82  friend void DebuggerAgentMessageHandler(const v8::Debug::Message& message);
83
84  DISALLOW_COPY_AND_ASSIGN(DebuggerAgent);
85};
86
87
88// Debugger agent session. The session receives requests from the remote
89// debugger and sends debugger events/responses to the remote debugger.
90class DebuggerAgentSession: public Thread {
91 public:
92  DebuggerAgentSession(DebuggerAgent* agent, Socket* client)
93      : agent_(agent), client_(client) {}
94
95  void DebuggerMessage(Vector<uint16_t> message);
96  void Shutdown();
97
98 private:
99  void Run();
100
101  void DebuggerMessage(Vector<char> message);
102
103  DebuggerAgent* agent_;
104  Socket* client_;
105
106  DISALLOW_COPY_AND_ASSIGN(DebuggerAgentSession);
107};
108
109
110// Utility methods factored out to be used by the D8 shell as well.
111class DebuggerAgentUtil {
112 public:
113  static const char* kContentLength;
114  static int kContentLengthSize;
115
116  static SmartPointer<char> ReceiveMessage(const Socket* conn);
117  static bool SendConnectMessage(const Socket* conn,
118                                 const char* embedding_host);
119  static bool SendMessage(const Socket* conn, const Vector<uint16_t> message);
120  static bool SendMessage(const Socket* conn,
121                          const v8::Handle<v8::String> message);
122  static int ReceiveAll(const Socket* conn, char* data, int len);
123};
124
125} }  // namespace v8::internal
126
127#endif  // ENABLE_DEBUGGER_SUPPORT
128
129#endif  // V8_DEBUG_AGENT_H_
130