cros_dbus_service.cc revision 5821806d5e7f356e8fa4b058a389a808ea183019
15821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Copyright (c) 2012 The Chromium Authors. All rights reserved. 25821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Use of this source code is governed by a BSD-style license that can be 35821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// found in the LICENSE file. 45821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 55821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "chrome/browser/chromeos/dbus/cros_dbus_service.h" 65821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/bind.h" 85821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/chromeos/chromeos_version.h" 95821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/stl_util.h" 105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/threading/platform_thread.h" 115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "chrome/browser/chromeos/dbus/proxy_resolution_service_provider.h" 125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "chromeos/dbus/dbus_thread_manager.h" 135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "dbus/bus.h" 145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "dbus/exported_object.h" 155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "dbus/object_path.h" 165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "third_party/cros_system_api/dbus/service_constants.h" 175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace chromeos { 195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace { 215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)CrosDBusService* g_cros_dbus_service = NULL; 235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} // namespace 255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// The CrosDBusService implementation used in production, and unit tests. 275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class CrosDBusServiceImpl : public CrosDBusService { 285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) explicit CrosDBusServiceImpl(dbus::Bus* bus) 305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) : service_started_(false), 315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) origin_thread_id_(base::PlatformThread::CurrentId()), 325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bus_(bus) { 335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual ~CrosDBusServiceImpl() { 365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) STLDeleteElements(&service_providers_); 375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Starts the D-Bus service. 405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void Start() { 415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Make sure we're running on the origin thread (i.e. the UI thread in 425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // production). 435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DCHECK(OnOriginThread()); 445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Return if the service has been already started. 465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (service_started_) 475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return; 485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bus_->RequestOwnership(kLibCrosServiceName, 505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) base::Bind(&CrosDBusServiceImpl::OnOwnership, 515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) base::Unretained(this))); 525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) exported_object_ = bus_->GetExportedObject( 545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) dbus::ObjectPath(kLibCrosServicePath)); 555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) for (size_t i = 0; i < service_providers_.size(); ++i) 575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) service_providers_[i]->Start(exported_object_); 585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) service_started_ = true; 605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) VLOG(1) << "CrosDBusServiceImpl started."; 625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Registers a service provider. This must be done before Start(). 655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // |provider| will be owned by CrosDBusService. 665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void RegisterServiceProvider(ServiceProviderInterface* provider) { 675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) service_providers_.push_back(provider); 685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) private: 715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns true if the current thread is on the origin thread. 725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool OnOriginThread() { 735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return base::PlatformThread::CurrentId() == origin_thread_id_; 745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Called when an ownership request is completed. 775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void OnOwnership(const std::string& service_name, 785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool success) { 795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) LOG_IF(ERROR, !success) << "Failed to own: " << service_name; 805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool service_started_; 835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) base::PlatformThreadId origin_thread_id_; 845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) dbus::Bus* bus_; 855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) scoped_refptr<dbus::ExportedObject> exported_object_; 865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Service providers that form CrosDBusService. 885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) std::vector<ServiceProviderInterface*> service_providers_; 895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// The stub CrosDBusService implementation used on Linux desktop, 925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// which does nothing as of now. 935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class CrosDBusServiceStubImpl : public CrosDBusService { 945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) CrosDBusServiceStubImpl() { 965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual ~CrosDBusServiceStubImpl() { 995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 1005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 1015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// static 1035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)void CrosDBusService::Initialize() { 1045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (g_cros_dbus_service) { 1055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) LOG(WARNING) << "CrosDBusService was already initialized"; 1065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return; 1075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 1085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) dbus::Bus* bus = DBusThreadManager::Get()->GetSystemBus(); 1095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (base::chromeos::IsRunningOnChromeOS() && bus) { 1105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) CrosDBusServiceImpl* service = new CrosDBusServiceImpl(bus); 1115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) service->RegisterServiceProvider(ProxyResolutionServiceProvider::Create()); 1125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) g_cros_dbus_service = service; 1135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) service->Start(); 1145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } else { 1155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) g_cros_dbus_service = new CrosDBusServiceStubImpl; 1165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 1175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) VLOG(1) << "CrosDBusService initialized"; 1185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 1195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// static 1215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)void CrosDBusService::InitializeForTesting( 1225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) dbus::Bus* bus, 1235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ServiceProviderInterface* proxy_resolution_service) { 1245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (g_cros_dbus_service) { 1255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) LOG(WARNING) << "CrosDBusService was already initialized"; 1265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return; 1275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 1285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) CrosDBusServiceImpl* service = new CrosDBusServiceImpl(bus); 1295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) service->RegisterServiceProvider(proxy_resolution_service); 1305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) service->Start(); 1315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) g_cros_dbus_service = service; 1325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) VLOG(1) << "CrosDBusService initialized"; 1335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 1345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// static 1365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)void CrosDBusService::Shutdown() { 1375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) delete g_cros_dbus_service; 1385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) g_cros_dbus_service = NULL; 1395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) VLOG(1) << "CrosDBusService Shutdown completed"; 1405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 1415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)CrosDBusService::~CrosDBusService() { 1435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 1445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)CrosDBusService::ServiceProviderInterface::~ServiceProviderInterface() { 1465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 1475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} // namespace chromeos 149