src/v8/src/debug-agent.h

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