diff options
author | creis@google.com <creis@google.com@0039d316-1c4b-4281-b951-d872f2087c98> | 2010-10-13 21:19:31 +0000 |
---|---|---|
committer | creis@google.com <creis@google.com@0039d316-1c4b-4281-b951-d872f2087c98> | 2010-10-13 21:19:31 +0000 |
commit | 75e16bcd60ff7e60a375bbe0efd27f8ac919a756 (patch) | |
tree | 6a3aca93dc9e64ad58f1cef258bf3e9dc896af92 /chrome/browser/extensions | |
parent | eefb9b4e064b484a1490abbaddeb92dffbc5e1ff (diff) | |
download | chromium_src-75e16bcd60ff7e60a375bbe0efd27f8ac919a756.zip chromium_src-75e16bcd60ff7e60a375bbe0efd27f8ac919a756.tar.gz chromium_src-75e16bcd60ff7e60a375bbe0efd27f8ac919a756.tar.bz2 |
Expands the chrome.experimental.processes extension API.
Adds an onUpdated event that reports process metrics from the TaskManager,
and modifies the TaskManager to support multiple independent observers.
BUG=32302
TEST=ExtensionApiTest.Processes browsertest
TEST=process_monitor sample extension
Review URL: http://codereview.chromium.org/3597016
git-svn-id: svn://svn.chromium.org/chrome/trunk/src@62458 0039d316-1c4b-4281-b951-d872f2087c98
Diffstat (limited to 'chrome/browser/extensions')
7 files changed, 238 insertions, 8 deletions
diff --git a/chrome/browser/extensions/extension_message_service.cc b/chrome/browser/extensions/extension_message_service.cc index 7e675f5..a25b384 100644 --- a/chrome/browser/extensions/extension_message_service.cc +++ b/chrome/browser/extensions/extension_message_service.cc @@ -10,6 +10,8 @@ #include "base/values.h" #include "chrome/browser/child_process_security_policy.h" #include "chrome/browser/extensions/extension_process_manager.h" +#include "chrome/browser/extensions/extension_processes_api.h" +#include "chrome/browser/extensions/extension_processes_api_constants.h" #include "chrome/browser/extensions/extension_tabs_module.h" #include "chrome/browser/profile.h" #include "chrome/browser/renderer_host/render_process_host.h" @@ -168,10 +170,22 @@ void ExtensionMessageService::AddEventListener(const std::string& event_name, extension_devtools_manager_->AddEventListener(event_name, render_process_id); } + + // We lazily tell the TaskManager to start updating when listeners to the + // processes.onUpdated event arrive. + if (event_name.compare(extension_processes_api_constants::kOnUpdated) == 0) { + ExtensionProcessesEventRouter::GetInstance()->ListenerAdded(); + } } void ExtensionMessageService::RemoveEventListener(const std::string& event_name, int render_process_id) { + // If a processes.onUpdated event listener is removed (or a process with one + // exits), then we let the TaskManager know that it has one fewer listener. + if (event_name.compare(extension_processes_api_constants::kOnUpdated) == 0) { + ExtensionProcessesEventRouter::GetInstance()->ListenerRemoved(); + } + DCHECK_EQ(listeners_[event_name].count(render_process_id), 1u) << " PID=" << render_process_id << " event=" << event_name; listeners_[event_name].erase(render_process_id); diff --git a/chrome/browser/extensions/extension_processes_api.cc b/chrome/browser/extensions/extension_processes_api.cc index 1c6c8dc..e395950 100644 --- a/chrome/browser/extensions/extension_processes_api.cc +++ b/chrome/browser/extensions/extension_processes_api.cc @@ -4,22 +4,121 @@ #include "chrome/browser/extensions/extension_processes_api.h" +#include "base/callback.h" +#include "base/json/json_writer.h" +#include "base/message_loop.h" +#include "base/string_number_conversions.h" +#include "base/task.h" +#include "base/utf_string_conversions.h" #include "base/values.h" -#include "chrome/browser/extensions/extension_tabs_module.h" +#include "chrome/browser/extensions/extension_message_service.h" #include "chrome/browser/extensions/extension_processes_api_constants.h" +#include "chrome/browser/extensions/extension_tabs_module.h" +#include "chrome/browser/profile.h" #include "chrome/browser/renderer_host/render_process_host.h" #include "chrome/browser/tab_contents/tab_contents.h" +#include "chrome/browser/task_manager/task_manager.h" +#include "chrome/common/notification_service.h" +#include "chrome/common/notification_type.h" namespace keys = extension_processes_api_constants; -DictionaryValue* CreateProcessValue(int process_id) { +DictionaryValue* CreateProcessValue(int process_id, + std::string type, + double cpu, + int net, + int pr_mem, + int sh_mem) { DictionaryValue* result = new DictionaryValue(); result->SetInteger(keys::kIdKey, process_id); - + result->SetString(keys::kTypeKey, type); + result->SetReal(keys::kCpuKey, cpu); + result->SetInteger(keys::kNetworkKey, net); + result->SetInteger(keys::kPrivateMemoryKey, pr_mem); + result->SetInteger(keys::kSharedMemoryKey, sh_mem); return result; } +ExtensionProcessesEventRouter* ExtensionProcessesEventRouter::GetInstance() { + return Singleton<ExtensionProcessesEventRouter>::get(); +} + +ExtensionProcessesEventRouter::ExtensionProcessesEventRouter() { + model_ = TaskManager::GetInstance()->model(); + model_->AddObserver(this); +} + +ExtensionProcessesEventRouter::~ExtensionProcessesEventRouter() { + model_->RemoveObserver(this); +} + +void ExtensionProcessesEventRouter::ObserveProfile(Profile* profile) { + profiles_.insert(profile); +} + +void ExtensionProcessesEventRouter::ListenerAdded() { + model_->StartUpdating(); +} + +void ExtensionProcessesEventRouter::ListenerRemoved() { + model_->StopUpdating(); +} + +void ExtensionProcessesEventRouter::OnItemsChanged(int start, int length) { + if (model_) { + ListValue args; + DictionaryValue* processes = new DictionaryValue(); + for (int i = start; i < start + length; i++) { + if (model_->IsResourceFirstInGroup(i)) { + int id = model_->GetProcessId(i); + std::string type = keys::kProcessTypePlugin; + TabContents* contents = model_->GetResourceTabContents(i); + if (contents) { + type = keys::kProcessTypeRenderer; + } else if (model_->GetResourceExtension(i)) { + type = keys::kProcessTypeExtension; + } else if (TaskManager::GetInstance()->IsBrowserProcess(i)) { + type = keys::kProcessTypeBrowser; + } + + // Get process metrics as numbers + double cpu = model_->GetCPUUsage(i); + // TODO(creis): Network is actually reported per-resource (tab), + // not per-process. We should aggregate it here. + int net = (int) model_->GetNetworkUsage(i); + size_t mem; + int pr_mem = (model_->GetPrivateMemory(i, &mem) ? mem : -1); + int sh_mem = (model_->GetSharedMemory(i, &mem) ? mem : -1); + + // Store each process indexed by the string version of its id + processes->Set(base::IntToString(id), + CreateProcessValue(id, type, cpu, net, pr_mem, sh_mem)); + } + } + args.Append(processes); + + std::string json_args; + base::JSONWriter::Write(&args, false, &json_args); + + // Notify each profile that is interested. + for (ProfileSet::iterator it = profiles_.begin(); + it != profiles_.end(); it++) { + Profile* profile = *it; + DispatchEvent(profile, keys::kOnUpdated, json_args); + } + } +} + +void ExtensionProcessesEventRouter::DispatchEvent(Profile* profile, + const char* event_name, + const std::string& json_args) { + if (profile && profile->GetExtensionMessageService()) { + profile->GetExtensionMessageService()->DispatchEventToRenderers( + event_name, json_args, NULL, GURL()); + } +} + bool GetProcessForTabFunction::RunImpl() { int tab_id; EXTENSION_FUNCTION_VALIDATE(args_->GetInteger(0, &tab_id)); @@ -30,7 +129,8 @@ bool GetProcessForTabFunction::RunImpl() { NULL, NULL, &contents, &tab_index)) return false; - int process_id = contents->GetRenderProcessHost()->id(); - result_.reset(CreateProcessValue(process_id)); + // Return the process ID of the tab as an integer. + int id = base::GetProcId(contents->GetRenderProcessHost()->GetHandle()); + result_.reset(Value::CreateIntegerValue(id)); return true; } diff --git a/chrome/browser/extensions/extension_processes_api.h b/chrome/browser/extensions/extension_processes_api.h index b58cb56..497e0f6 100644 --- a/chrome/browser/extensions/extension_processes_api.h +++ b/chrome/browser/extensions/extension_processes_api.h @@ -6,14 +6,72 @@ #define CHROME_BROWSER_EXTENSIONS_EXTENSION_PROCESSES_API_H__ #pragma once +#include <set> +#include <string> + #include "chrome/browser/extensions/extension_function.h" +#include "chrome/browser/task_manager/task_manager.h" +#include "chrome/common/notification_observer.h" +#include "chrome/common/notification_registrar.h" + +// Observes the Task Manager and routes the notifications as events to the +// extension system. +class ExtensionProcessesEventRouter : public TaskManagerModelObserver { + public: + // Single instance of the event router. + static ExtensionProcessesEventRouter* GetInstance(); + + // Safe to call multiple times. + void ObserveProfile(Profile* profile); + + // Called when an extension process wants to listen to process events. + void ListenerAdded(); + + // Called when an extension process with a listener exits or removes it. + void ListenerRemoved(); + + private: + friend struct DefaultSingletonTraits<ExtensionProcessesEventRouter>; + + ExtensionProcessesEventRouter(); + virtual ~ExtensionProcessesEventRouter(); + + // TaskManagerModelObserver::OnModelChanged. + virtual void OnModelChanged() {} + + // TaskManagerModelObserver::OnItemsChanged. + virtual void OnItemsChanged(int start, int length); + + // TaskManagerModelObserver::OnItemsAdded. + virtual void OnItemsAdded(int start, int length) {} + + // TaskManagerModelObserver::OnItemsRemoved. + virtual void OnItemsRemoved(int start, int length) {} + + void DispatchEvent(Profile* profile, + const char* event_name, + const std::string& json_args); + + // Used for tracking registrations to process related notifications. + NotificationRegistrar registrar_; + + // Registered profiles. + typedef std::set<Profile*> ProfileSet; + ProfileSet profiles_; + + // TaskManager to observe for updates. + TaskManagerModel* model_; + + DISALLOW_COPY_AND_ASSIGN(ExtensionProcessesEventRouter); +}; + // This extension function returns the Process object for the renderer process // currently in use by the specified Tab. class GetProcessForTabFunction : public SyncExtensionFunction { virtual ~GetProcessForTabFunction() {} virtual bool RunImpl(); - DECLARE_EXTENSION_FUNCTION_NAME("experimental.processes.getProcessForTab") + DECLARE_EXTENSION_FUNCTION_NAME("experimental.processes.getProcessIdForTab") }; #endif // CHROME_BROWSER_EXTENSIONS_EXTENSION_PROCESSES_API_H__ diff --git a/chrome/browser/extensions/extension_processes_api_constants.cc b/chrome/browser/extensions/extension_processes_api_constants.cc index bb0cccb..a0e9406 100644 --- a/chrome/browser/extensions/extension_processes_api_constants.cc +++ b/chrome/browser/extensions/extension_processes_api_constants.cc @@ -6,6 +6,19 @@ namespace extension_processes_api_constants { +const char kCpuKey[] = "cpu"; const char kIdKey[] = "id"; +const char kNetworkKey[] = "network"; +const char kPrivateMemoryKey[] = "privateMemory"; +const char kProcessesKey[] = "processes"; +const char kSharedMemoryKey[] = "sharedMemory"; +const char kTypeKey[] = "type"; + +const char kProcessTypeBrowser[] = "browser"; +const char kProcessTypeExtension[] = "extension"; +const char kProcessTypePlugin[] = "plugin"; +const char kProcessTypeRenderer[] = "renderer"; + +const char kOnUpdated[] = "experimental.processes.onUpdated"; } // namespace extension_processes_api_constants diff --git a/chrome/browser/extensions/extension_processes_api_constants.h b/chrome/browser/extensions/extension_processes_api_constants.h index 7e6c844..fcf7f16 100644 --- a/chrome/browser/extensions/extension_processes_api_constants.h +++ b/chrome/browser/extensions/extension_processes_api_constants.h @@ -10,8 +10,21 @@ namespace extension_processes_api_constants { -// Keys used in serializing tab data & events. +// Keys used in serializing process data & events. +extern const char kCpuKey[]; extern const char kIdKey[]; +extern const char kNetworkKey[]; +extern const char kPrivateMemoryKey[]; +extern const char kProcessesKey[]; +extern const char kSharedMemoryKey[]; +extern const char kTypeKey[]; + +extern const char kProcessTypeBrowser[]; +extern const char kProcessTypeExtension[]; +extern const char kProcessTypePlugin[]; +extern const char kProcessTypeRenderer[]; + +extern const char kOnUpdated[]; }; // namespace extension_processes_api_constants diff --git a/chrome/browser/extensions/extension_processes_apitest.cc b/chrome/browser/extensions/extension_processes_apitest.cc index f5531d0..bc4d865 100644 --- a/chrome/browser/extensions/extension_processes_apitest.cc +++ b/chrome/browser/extensions/extension_processes_apitest.cc @@ -3,12 +3,42 @@ // found in the LICENSE file. #include "base/command_line.h" +#include "chrome/browser/browser.h" +#include "chrome/browser/browser_window.h" #include "chrome/browser/extensions/extension_apitest.h" +#include "chrome/browser/task_manager/task_manager.h" #include "chrome/common/chrome_switches.h" IN_PROC_BROWSER_TEST_F(ExtensionApiTest, Processes) { CommandLine::ForCurrentProcess()->AppendSwitch( switches::kEnableExperimentalExtensionApis); - ASSERT_TRUE(RunExtensionTest("processes")) << message_; + ASSERT_TRUE(RunExtensionTest("processes/api")) << message_; +} + +IN_PROC_BROWSER_TEST_F(ExtensionApiTest, ProcessesVsTaskManager) { + CommandLine::ForCurrentProcess()->AppendSwitch( + switches::kEnableExperimentalExtensionApis); + + // Ensure task manager is not yet updating + TaskManagerModel* model = TaskManager::GetInstance()->model(); + EXPECT_EQ(0, model->update_requests_); + EXPECT_EQ(TaskManagerModel::IDLE, model->update_state_); + + // Load extension that adds listener in background page + ASSERT_TRUE(LoadExtension( + test_data_dir_.AppendASCII("processes").AppendASCII("onupdated"))); + + // Ensure the task manager has started updating + EXPECT_EQ(1, model->update_requests_); + EXPECT_EQ(TaskManagerModel::TASK_PENDING, model->update_state_); + + // Now show the task manager + browser()->window()->ShowTaskManager(); + EXPECT_EQ(2, model->update_requests_); + EXPECT_EQ(TaskManagerModel::TASK_PENDING, model->update_state_); + + // Unload the extension and check that listener count decreases + UnloadExtension(last_loaded_extension_id_); + EXPECT_EQ(1, model->update_requests_); } diff --git a/chrome/browser/extensions/extensions_service.cc b/chrome/browser/extensions/extensions_service.cc index 693779b7..bada439 100644 --- a/chrome/browser/extensions/extensions_service.cc +++ b/chrome/browser/extensions/extensions_service.cc @@ -35,6 +35,7 @@ #include "chrome/browser/extensions/extension_host.h" #include "chrome/browser/extensions/extension_management_api.h" #include "chrome/browser/extensions/extension_process_manager.h" +#include "chrome/browser/extensions/extension_processes_api.h" #include "chrome/browser/extensions/extension_updater.h" #include "chrome/browser/extensions/extension_webnavigation_api.h" #include "chrome/browser/extensions/external_extension_provider.h" @@ -619,6 +620,7 @@ void ExtensionsService::InitEventRouters() { profile_->GetBookmarkModel()); ExtensionCookiesEventRouter::GetInstance()->Init(); ExtensionManagementEventRouter::GetInstance()->Init(); + ExtensionProcessesEventRouter::GetInstance()->ObserveProfile(profile_); ExtensionWebNavigationEventRouter::GetInstance()->Init(); } |