summaryrefslogtreecommitdiffstats
path: root/chrome/renderer/devtools_agent.cc
blob: 449b250b81a833c22a0cba49dded9670d1fe9a8b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
// Copyright (c) 2009 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

// DevToolsAgent belongs to the inspectable renderer and provides Glue's
// agents with the communication capabilities. All messages from/to Glue's
// agents infrastructure are flowing through this comminucation agent.
//
// DevToolsAgent is registered as an IPC filter in order to be able to
// dispatch messages while on the IO thread. The reason for that is that while
// debugging, Render thread is being held by the v8 and hence no messages
// are being dispatched there. While holding the thread in a tight loop,
// v8 provides thread-safe Api for controlling debugger. In our case v8's Api
// is being used from this communication agent on the IO thread.

#include "chrome/renderer/devtools_agent.h"

#include "base/message_loop.h"
#include "chrome/common/render_messages.h"
#include "chrome/renderer/devtools_messages.h"
// TODO(yurys): remove this macros once plugins available on other platforms
#if defined(OS_WIN)
#include "chrome/renderer/plugin_channel_host.h"
#endif  // OS_WIN
#include "chrome/renderer/render_process.h"
#include "chrome/renderer/render_view.h"
#include "webkit/glue/webdevtoolsagent.h"

DevToolsAgent::DevToolsAgent(int routing_id,
                             RenderView* view,
                             MessageLoop* view_loop)
    : debugger_(NULL),
      routing_id_(routing_id),
      view_(view),
      view_loop_(view_loop),
      channel_(NULL),
      io_loop_(NULL) {
}

DevToolsAgent::~DevToolsAgent() {
}

// Called on render thread.
void DevToolsAgent::RenderViewDestroyed() {
  DCHECK(MessageLoop::current() == view_loop_);
  view_ = NULL;
}

void DevToolsAgent::Send(const IPC::Message& tools_client_message) {
  // It's possible that this will get cleared out from under us.
  MessageLoop* io_loop = io_loop_;
  if (!io_loop)
    return;

  IPC::Message* m = new ViewHostMsg_ForwardToDevToolsClient(
      routing_id_,
      tools_client_message);
  io_loop->PostTask(FROM_HERE, NewRunnableMethod(
      this, &DevToolsAgent::SendFromIOThread, m));
}

void DevToolsAgent::SendFromIOThread(IPC::Message* message) {
  if (channel_) {
    channel_->Send(message);
  } else {
    delete message;
  }
}

// Called on IO thread.
void DevToolsAgent::OnFilterAdded(IPC::Channel* channel) {
  io_loop_ = MessageLoop::current();
  channel_ = channel;
}

// Called on IO thread.
bool DevToolsAgent::OnMessageReceived(const IPC::Message& message) {
  DCHECK(MessageLoop::current() == io_loop_);

  if (message.routing_id() != routing_id_)
    return false;

  bool handled = true;
  IPC_BEGIN_MESSAGE_MAP(DevToolsAgent, message)
    IPC_MESSAGE_HANDLER(DevToolsAgentMsg_DebugAttach, OnDebugAttach)
    IPC_MESSAGE_HANDLER(DevToolsAgentMsg_DebugDetach, OnDebugDetach)
    IPC_MESSAGE_HANDLER(DevToolsAgentMsg_DebugBreak, OnDebugBreak)
    IPC_MESSAGE_HANDLER(DevToolsAgentMsg_DebugCommand, OnDebugCommand)
    IPC_MESSAGE_HANDLER(DevToolsAgentMsg_RpcMessage, OnRpcMessage)
    IPC_MESSAGE_UNHANDLED(handled = false)
  IPC_END_MESSAGE_MAP()
  return handled;
}

// Called on IO thread.
void DevToolsAgent::OnFilterRemoved() {
  io_loop_ = NULL;
  channel_ = NULL;
}

void DevToolsAgent::DebuggerOutput(const std::wstring& out) {
  Send(DevToolsClientMsg_DebuggerOutput(out));
}

void DevToolsAgent::EvaluateScript(const std::wstring& script) {
  DCHECK(MessageLoop::current() == view_loop_);
  // view_ may have been cleared after this method execution was scheduled.
  if (view_)
    view_->EvaluateScript(L"", script);
}

void DevToolsAgent::OnDebugAttach() {
  DCHECK(MessageLoop::current() == io_loop_);
  if (!debugger_) {
    debugger_ = new DebuggerBridge(this);
  }

  debugger_->Attach();

  Send(DevToolsClientMsg_DidDebugAttach());

  // TODO(yurys): remove this macros once plugins available on other platforms
#if defined(OS_WIN)
  // Tell the plugin host to stop accepting messages in order to avoid
  // hangs while the renderer is paused.
  // TODO(yurys): It might be an improvement to add more plumbing to do this
  // when the renderer is actually paused vs. just the debugger being attached.
  // http://code.google.com/p/chromium/issues/detail?id=7556
  PluginChannelHost::SetListening(false);
#endif  // OS_WIN
}

void DevToolsAgent::OnDebugDetach() {
  DCHECK(MessageLoop::current() == io_loop_);
  if (debugger_)
    debugger_->Detach();
  // TODO(yurys): remove this macros once plugins available on other platforms
#if defined(OS_WIN)
  PluginChannelHost::SetListening(true);
#endif  // OS_WIN
}

void DevToolsAgent::OnDebugBreak(bool force) {
  DCHECK(MessageLoop::current() == io_loop_);
  // Set the debug break flag in the V8 engine.
  debugger_->Break(force);

  // If a forced break has been requested make sure that it will occour by
  // running some JavaScript in the renderer.
  if (force && view_loop_) {
    view_loop_->PostTask(FROM_HERE, NewRunnableMethod(
        this, &DevToolsAgent::EvaluateScript,
        std::wstring(L"javascript:void(0)")));
  }
}

void DevToolsAgent::OnDebugCommand(const std::wstring& cmd) {
  DCHECK(MessageLoop::current() == io_loop_);
  if (!debugger_) {
    NOTREACHED();
    std::wstring msg =
        StringPrintf(L"before attach, ignored command (%S)", cmd.c_str());
    DebuggerOutput(msg);
  } else {
    debugger_->Command(cmd);
  }
}

void DevToolsAgent::SendMessageToClient(const std::string& raw_msg) {
  Send(DevToolsClientMsg_RpcMessage(raw_msg));
}

void DevToolsAgent::OnRpcMessage(const std::string& raw_msg) {
  view_loop_->PostTask(FROM_HERE, NewRunnableMethod(
      this, &DevToolsAgent::DispatchRpcMessage, raw_msg));
}

void DevToolsAgent::DispatchRpcMessage(const std::string& raw_msg) {
  WebDevToolsAgent* web_agent = view_->webview()->GetWebDevToolsAgent();
  web_agent->DispatchMessageFromClient(raw_msg);
}