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
182
183
184
185
186
187
188
189
190
191
192
193
194
195
|
// Copyright 2014 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.
#include "components/keyed_service/core/dependency_manager.h"
#include <ostream>
#include "base/bind.h"
#include "base/check.h"
#include "base/debug/dump_without_crashing.h"
#include "base/notreached.h"
#include "base/supports_user_data.h"
#include "components/keyed_service/core/keyed_service_base_factory.h"
#ifndef NDEBUG
#include "base/files/file_path.h"
#include "base/files/file_util.h"
#endif // NDEBUG
DependencyManager::DependencyManager() {
}
DependencyManager::~DependencyManager() {
}
void DependencyManager::AddComponent(KeyedServiceBaseFactory* component) {
#if DCHECK_IS_ON()
// TODO(crbug.com/1150733): Tighten this check to ensure that no factories are
// registered after CreateContextServices() is called.
DCHECK(!context_services_created_ ||
!(component->ServiceIsCreatedWithContext() ||
component->ServiceIsNULLWhileTesting()))
<< "Tried to construct " << component->name()
<< " after context.\n"
"Keyed Service Factories must be constructed before the context is "
"created. Typically this is done by calling FooFactory::GetInstance() "
"for all factories in a method called "
"Ensure.*KeyedServiceFactoriesBuilt().";
#endif // DCHECK_IS_ON()
dependency_graph_.AddNode(component);
}
void DependencyManager::RemoveComponent(KeyedServiceBaseFactory* component) {
dependency_graph_.RemoveNode(component);
}
void DependencyManager::AddEdge(KeyedServiceBaseFactory* depended,
KeyedServiceBaseFactory* dependee) {
dependency_graph_.AddEdge(depended, dependee);
}
void DependencyManager::RegisterPrefsForServices(
user_prefs::PrefRegistrySyncable* pref_registry) {
std::vector<DependencyNode*> construction_order;
if (!dependency_graph_.GetConstructionOrder(&construction_order)) {
NOTREACHED();
}
for (auto* dependency_node : construction_order) {
KeyedServiceBaseFactory* factory =
static_cast<KeyedServiceBaseFactory*>(dependency_node);
factory->RegisterPrefs(pref_registry);
}
}
void DependencyManager::CreateContextServices(void* context,
bool is_testing_context) {
#if DCHECK_IS_ON()
context_services_created_ = true;
#endif
MarkContextLive(context);
std::vector<DependencyNode*> construction_order;
if (!dependency_graph_.GetConstructionOrder(&construction_order)) {
NOTREACHED();
}
#ifndef NDEBUG
DumpContextDependencies(context);
#endif
for (auto* dependency_node : construction_order) {
KeyedServiceBaseFactory* factory =
static_cast<KeyedServiceBaseFactory*>(dependency_node);
if (is_testing_context && factory->ServiceIsNULLWhileTesting() &&
!factory->HasTestingFactory(context)) {
factory->SetEmptyTestingFactory(context);
} else if (factory->ServiceIsCreatedWithContext()) {
factory->CreateServiceNow(context);
}
}
}
void DependencyManager::DestroyContextServices(void* context) {
std::vector<DependencyNode*> destruction_order = GetDestructionOrder();
#ifndef NDEBUG
DumpContextDependencies(context);
#endif
ShutdownFactoriesInOrder(context, destruction_order);
MarkContextDead(context);
DestroyFactoriesInOrder(context, destruction_order);
}
// static
void DependencyManager::PerformInterlockedTwoPhaseShutdown(
DependencyManager* dependency_manager1,
void* context1,
DependencyManager* dependency_manager2,
void* context2) {
std::vector<DependencyNode*> destruction_order1 =
dependency_manager1->GetDestructionOrder();
std::vector<DependencyNode*> destruction_order2 =
dependency_manager2->GetDestructionOrder();
#ifndef NDEBUG
dependency_manager1->DumpContextDependencies(context1);
dependency_manager2->DumpContextDependencies(context2);
#endif
ShutdownFactoriesInOrder(context1, destruction_order1);
ShutdownFactoriesInOrder(context2, destruction_order2);
dependency_manager1->MarkContextDead(context1);
dependency_manager2->MarkContextDead(context2);
DestroyFactoriesInOrder(context1, destruction_order1);
DestroyFactoriesInOrder(context2, destruction_order2);
}
std::vector<DependencyNode*> DependencyManager::GetDestructionOrder() {
std::vector<DependencyNode*> destruction_order;
if (!dependency_graph_.GetDestructionOrder(&destruction_order))
NOTREACHED();
return destruction_order;
}
void DependencyManager::ShutdownFactoriesInOrder(
void* context,
std::vector<DependencyNode*>& order) {
for (auto* dependency_node : order) {
KeyedServiceBaseFactory* factory =
static_cast<KeyedServiceBaseFactory*>(dependency_node);
factory->ContextShutdown(context);
}
}
void DependencyManager::DestroyFactoriesInOrder(
void* context,
std::vector<DependencyNode*>& order) {
for (auto* dependency_node : order) {
KeyedServiceBaseFactory* factory =
static_cast<KeyedServiceBaseFactory*>(dependency_node);
factory->ContextDestroyed(context);
}
}
void DependencyManager::AssertContextWasntDestroyed(void* context) const {
if (dead_context_pointers_.find(context) != dead_context_pointers_.end()) {
// We want to see all possible use-after-destroy in production environment.
CHECK(false) << "Attempted to access a context that was ShutDown(). "
<< "This is most likely a heap smasher in progress. After "
<< "KeyedService::Shutdown() completes, your service MUST "
<< "NOT refer to depended services again.";
}
}
void DependencyManager::MarkContextLive(void* context) {
dead_context_pointers_.erase(context);
}
void DependencyManager::MarkContextDead(void* context) {
dead_context_pointers_.insert(context);
}
#ifndef NDEBUG
namespace {
std::string KeyedServiceBaseFactoryGetNodeName(DependencyNode* node) {
return static_cast<KeyedServiceBaseFactory*>(node)->name();
}
} // namespace
void DependencyManager::DumpDependenciesAsGraphviz(
const std::string& top_level_name,
const base::FilePath& dot_file) const {
DCHECK(!dot_file.empty());
std::string contents = dependency_graph_.DumpAsGraphviz(
top_level_name, base::BindRepeating(&KeyedServiceBaseFactoryGetNodeName));
base::WriteFile(dot_file, contents.c_str(), contents.size());
}
#endif // NDEBUG
|
