components/keyed_service/core/dependency_manager.cc

   1 // Copyright 2014 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #include "components/keyed_service/core/dependency_manager.h"
   6
   7 #include "base/bind.h"
   8 #include "base/logging.h"
   9 #include "base/supports_user_data.h"
  10 #include "components/keyed_service/core/keyed_service_base_factory.h"
  11
  12 #ifndef NDEBUG
  13 #include "base/files/file_path.h"
  14 #include "base/files/file_util.h"
  15 #endif  // NDEBUG
  16
  17 DependencyManager::DependencyManager() {
  18 }
  19
  20 DependencyManager::~DependencyManager() {
  21 }
  22
  23 void DependencyManager::AddComponent(KeyedServiceBaseFactory* component) {
  24   dependency_graph_.AddNode(component);
  25 }
  26
  27 void DependencyManager::RemoveComponent(KeyedServiceBaseFactory* component) {
  28   dependency_graph_.RemoveNode(component);
  29 }
  30
  31 void DependencyManager::AddEdge(KeyedServiceBaseFactory* depended,
  32                                 KeyedServiceBaseFactory* dependee) {
  33   dependency_graph_.AddEdge(depended, dependee);
  34 }
  35
  36 void DependencyManager::RegisterPrefsForServices(
  37     base::SupportsUserData* context,
  38     user_prefs::PrefRegistrySyncable* pref_registry) {
  39   std::vector<DependencyNode*> construction_order;
  40   if (!dependency_graph_.GetConstructionOrder(&construction_order)) {
  41     NOTREACHED();
  42   }
  43
  44   for (const auto& dependency_node : construction_order) {
  45     KeyedServiceBaseFactory* factory =
  46         static_cast<KeyedServiceBaseFactory*>(dependency_node);
  47     base::SupportsUserData* typed_context = factory->GetTypedContext(context);
  48     factory->RegisterPrefsIfNecessaryForContext(typed_context, pref_registry);
  49   }
  50 }
  51
  52 void DependencyManager::CreateContextServices(base::SupportsUserData* context,
  53                                               bool is_testing_context) {
  54 #ifndef NDEBUG
  55   MarkContextLiveForTesting(context);
  56 #endif
  57
  58   std::vector<DependencyNode*> construction_order;
  59   if (!dependency_graph_.GetConstructionOrder(&construction_order)) {
  60     NOTREACHED();
  61   }
  62
  63 #ifndef NDEBUG
  64   DumpContextDependencies(context);
  65 #endif
  66
  67   for (const auto& dependency_node : construction_order) {
  68     KeyedServiceBaseFactory* factory =
  69         static_cast<KeyedServiceBaseFactory*>(dependency_node);
  70     base::SupportsUserData* typed_context = factory->GetTypedContext(context);
  71     if (is_testing_context && factory->ServiceIsNULLWhileTesting() &&
  72         !factory->HasTestingFactory(typed_context)) {
  73       factory->SetEmptyTestingFactory(typed_context);
  74     } else if (factory->ServiceIsCreatedWithContext()) {
  75       factory->CreateServiceNow(typed_context);
  76     }
  77   }
  78 }
  79
  80 void DependencyManager::DestroyContextServices(
  81     base::SupportsUserData* context) {
  82   std::vector<DependencyNode*> destruction_order;
  83   if (!dependency_graph_.GetDestructionOrder(&destruction_order)) {
  84     NOTREACHED();
  85   }
  86
  87 #ifndef NDEBUG
  88   DumpContextDependencies(context);
  89 #endif
  90
  91   for (const auto& dependency_node : destruction_order) {
  92     KeyedServiceBaseFactory* factory =
  93         static_cast<KeyedServiceBaseFactory*>(dependency_node);
  94     base::SupportsUserData* typed_context = factory->GetTypedContext(context);
  95     factory->ContextShutdown(typed_context);
  96   }
  97
  98 #ifndef NDEBUG
  99   // The context is now dead to the rest of the program.
 100   dead_context_pointers_.insert(context);
 101 #endif
 102
 103   for (const auto& dependency_node : destruction_order) {
 104     KeyedServiceBaseFactory* factory =
 105         static_cast<KeyedServiceBaseFactory*>(dependency_node);
 106     base::SupportsUserData* typed_context = factory->GetTypedContext(context);
 107     factory->ContextDestroyed(typed_context);
 108   }
 109 }
 110
 111 #ifndef NDEBUG
 112 void DependencyManager::AssertContextWasntDestroyed(
 113     base::SupportsUserData* context) {
 114   if (dead_context_pointers_.find(context) != dead_context_pointers_.end()) {
 115     NOTREACHED() << "Attempted to access a context that was ShutDown(). "
 116                  << "This is most likely a heap smasher in progress. After "
 117                  << "KeyedService::Shutdown() completes, your service MUST "
 118                  << "NOT refer to depended services again.";
 119   }
 120 }
 121
 122 void DependencyManager::MarkContextLiveForTesting(
 123     base::SupportsUserData* context) {
 124   dead_context_pointers_.erase(context);
 125 }
 126
 127 namespace {
 128
 129 std::string KeyedServiceBaseFactoryGetNodeName(DependencyNode* node) {
 130   return static_cast<KeyedServiceBaseFactory*>(node)->name();
 131 }
 132
 133 }  // namespace
 134
 135 void DependencyManager::DumpDependenciesAsGraphviz(
 136     const std::string& top_level_name,
 137     const base::FilePath& dot_file) const {
 138   DCHECK(!dot_file.empty());
 139   std::string contents = dependency_graph_.DumpAsGraphviz(
 140       top_level_name, base::Bind(&KeyedServiceBaseFactoryGetNodeName));
 141   base::WriteFile(dot_file, contents.c_str(), contents.size());
 142 }
 143 #endif  // NDEBUG