summaryrefslogtreecommitdiffstats
path: root/chrome/plugin/plugin_process.cc
blob: ad8a57842631205b436841f22af2f328b2db02f0 (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
// Copyright 2008, Google Inc.
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//    * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//    * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
//    * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

#include <windows.h>
#include "chrome/plugin/plugin_process.h"

#include "base/basictypes.h"
#include "base/scoped_handle.h"
#include "chrome/common/ipc_channel.h"
#include "chrome/common/ipc_message_utils.h"
#include "chrome/common/plugin_messages.h"
#include "chrome/common/render_messages.h"
#include "webkit/glue/webkit_glue.h"

// Custom factory to allow us to pass additional ctor arguments.
class PluginProcessFactory : public ChildProcessFactoryInterface {
 public:
  explicit PluginProcessFactory(const std::wstring& plugin_path)
      : plugin_path_(plugin_path) {
  }

  virtual ChildProcess* Create(const std::wstring& channel_name) {
    return new PluginProcess(channel_name, plugin_path_);
  }

  const std::wstring& plugin_path_;
};

// How long to wait after there are no more plugin instances before killing the
// process.
static const int kProcessShutdownDelayMs = 10 * 1000;

// No AddRef required when using PluginProcess with RunnableMethod.  This is
// okay since the lifetime of the PluginProcess is always greater than the
// lifetime of PluginThread because it's a member variable.
template <> struct RunnableMethodTraits<PluginProcess> {
  static void RetainCallee(PluginProcess*) {}
  static void ReleaseCallee(PluginProcess*) {}
};

PluginProcess::PluginProcess(const std::wstring& channel_name,
                             const std::wstring& plugin_path) :
    plugin_path_(plugin_path),
#pragma warning(suppress: 4355)  // Okay to pass "this" here.
    plugin_thread_(this, channel_name) {
}

PluginProcess::~PluginProcess() {
}

bool PluginProcess::GlobalInit(const std::wstring &channel_name,
                               const std::wstring &plugin_path) {
  PluginProcessFactory factory(plugin_path);
  return ChildProcess::GlobalInit(channel_name, &factory);
}


// Note: may be called on any thread
void PluginProcess::OnFinalRelease() {
  // We override this to have the process linger for a few seconds to
  // better accomdate back/forth navigation. This avoids shutting down and
  // immediately starting a new plugin process. If a new channel is
  // opened in the interim, the current process will not be shutdown.
  main_thread_loop_->PostDelayedTask(FROM_HERE, NewRunnableMethod(
          this, &PluginProcess::OnProcessShutdownTimeout),
      kProcessShutdownDelayMs);
}

void PluginProcess::OnProcessShutdownTimeout() {
  if (ProcessRefCountIsZero()) {
    // The plugin process shutdown sequence is a request response based
    // mechanism, where we send out an initial feeler request to the plugin
    // process host instance in the browser to verify if it is ok to shutdown
    // the plugin process. The browser then sends back a response indicating
    // whether it is ok to shutdown.
    plugin_thread_.Send(new PluginProcessHostMsg_ShutdownRequest);
  }
}

// static
void PluginProcess::ShutdownProcessResponse(bool ok_to_shutdown) {
  if (ok_to_shutdown) {
    PluginProcess* plugin_process =
        static_cast<PluginProcess*>(child_process_);
    DCHECK(plugin_process);
    plugin_process->Shutdown();
  }
}

void PluginProcess::BrowserShutdown() {
  ShutdownProcessResponse(true);
}

void PluginProcess::Shutdown() {
  ChildProcess::OnFinalRelease();
}