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
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
|
/* Copyright 2015 The TensorFlow Authors. All Rights Reserved.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
==============================================================================*/
#include "tensorflow/stream_executor/plugin_registry.h"
#include "tensorflow/stream_executor/lib/error.h"
#include "tensorflow/stream_executor/lib/stringprintf.h"
#include "tensorflow/stream_executor/multi_platform_manager.h"
namespace stream_executor {
const PluginId kNullPlugin = nullptr;
// Returns the string representation of the specified PluginKind.
string PluginKindString(PluginKind plugin_kind) {
switch (plugin_kind) {
case PluginKind::kBlas:
return "BLAS";
case PluginKind::kDnn:
return "DNN";
case PluginKind::kFft:
return "FFT";
case PluginKind::kRng:
return "RNG";
case PluginKind::kInvalid:
default:
return "kInvalid";
}
}
PluginRegistry::DefaultFactories::DefaultFactories() :
blas(kNullPlugin), dnn(kNullPlugin), fft(kNullPlugin), rng(kNullPlugin) { }
static mutex& GetPluginRegistryMutex() {
static mutex* mu = new mutex;
return *mu;
}
/* static */ PluginRegistry* PluginRegistry::instance_ = nullptr;
PluginRegistry::PluginRegistry() {}
/* static */ PluginRegistry* PluginRegistry::Instance() {
mutex_lock lock{GetPluginRegistryMutex()};
if (instance_ == nullptr) {
instance_ = new PluginRegistry();
}
return instance_;
}
void PluginRegistry::MapPlatformKindToId(PlatformKind platform_kind,
Platform::Id platform_id) {
platform_id_by_kind_[platform_kind] = platform_id;
}
template <typename FACTORY_TYPE>
port::Status PluginRegistry::RegisterFactoryInternal(
PluginId plugin_id, const string& plugin_name, FACTORY_TYPE factory,
std::map<PluginId, FACTORY_TYPE>* factories) {
mutex_lock lock{GetPluginRegistryMutex()};
if (factories->find(plugin_id) != factories->end()) {
return port::Status(
port::error::ALREADY_EXISTS,
port::Printf("Attempting to register factory for plugin %s when "
"one has already been registered",
plugin_name.c_str()));
}
(*factories)[plugin_id] = factory;
plugin_names_[plugin_id] = plugin_name;
return port::Status::OK();
}
template <typename FACTORY_TYPE>
port::StatusOr<FACTORY_TYPE> PluginRegistry::GetFactoryInternal(
PluginId plugin_id, const std::map<PluginId, FACTORY_TYPE>& factories,
const std::map<PluginId, FACTORY_TYPE>& generic_factories) const {
auto iter = factories.find(plugin_id);
if (iter == factories.end()) {
iter = generic_factories.find(plugin_id);
if (iter == generic_factories.end()) {
return port::Status(
port::error::NOT_FOUND,
port::Printf("Plugin ID %p not registered.", plugin_id));
}
}
return iter->second;
}
bool PluginRegistry::SetDefaultFactory(Platform::Id platform_id,
PluginKind plugin_kind,
PluginId plugin_id) {
if (!HasFactory(platform_id, plugin_kind, plugin_id)) {
port::StatusOr<Platform*> status =
MultiPlatformManager::PlatformWithId(platform_id);
string platform_name = "<unregistered platform>";
if (status.ok()) {
platform_name = status.ValueOrDie()->Name();
}
LOG(ERROR) << "A factory must be registered for a platform before being "
<< "set as default! "
<< "Platform name: " << platform_name
<< ", PluginKind: " << PluginKindString(plugin_kind)
<< ", PluginId: " << plugin_id;
return false;
}
switch (plugin_kind) {
case PluginKind::kBlas:
default_factories_[platform_id].blas = plugin_id;
break;
case PluginKind::kDnn:
default_factories_[platform_id].dnn = plugin_id;
break;
case PluginKind::kFft:
default_factories_[platform_id].fft = plugin_id;
break;
case PluginKind::kRng:
default_factories_[platform_id].rng = plugin_id;
break;
default:
LOG(ERROR) << "Invalid plugin kind specified: "
<< static_cast<int>(plugin_kind);
return false;
}
return true;
}
bool PluginRegistry::HasFactory(const PluginFactories& factories,
PluginKind plugin_kind,
PluginId plugin_id) const {
switch (plugin_kind) {
case PluginKind::kBlas:
return factories.blas.find(plugin_id) != factories.blas.end();
case PluginKind::kDnn:
return factories.dnn.find(plugin_id) != factories.dnn.end();
case PluginKind::kFft:
return factories.fft.find(plugin_id) != factories.fft.end();
case PluginKind::kRng:
return factories.rng.find(plugin_id) != factories.rng.end();
default:
LOG(ERROR) << "Invalid plugin kind specified: "
<< PluginKindString(plugin_kind);
return false;
}
}
bool PluginRegistry::HasFactory(Platform::Id platform_id,
PluginKind plugin_kind,
PluginId plugin_id) const {
auto iter = factories_.find(platform_id);
if (iter != factories_.end()) {
if (HasFactory(iter->second, plugin_kind, plugin_id)) {
return true;
}
}
return HasFactory(generic_factories_, plugin_kind, plugin_id);
}
// Explicit instantiations to support types exposed in user/public API.
#define EMIT_PLUGIN_SPECIALIZATIONS(FACTORY_TYPE, FACTORY_VAR, PLUGIN_STRING) \
template port::StatusOr<PluginRegistry::FACTORY_TYPE> \
PluginRegistry::GetFactoryInternal<PluginRegistry::FACTORY_TYPE>( \
PluginId plugin_id, \
const std::map<PluginId, PluginRegistry::FACTORY_TYPE>& factories, \
const std::map<PluginId, PluginRegistry::FACTORY_TYPE>& \
generic_factories) const; \
\
template port::Status \
PluginRegistry::RegisterFactoryInternal<PluginRegistry::FACTORY_TYPE>( \
PluginId plugin_id, const string& plugin_name, \
PluginRegistry::FACTORY_TYPE factory, \
std::map<PluginId, PluginRegistry::FACTORY_TYPE>* factories); \
\
template <> \
port::Status PluginRegistry::RegisterFactory<PluginRegistry::FACTORY_TYPE>( \
Platform::Id platform_id, PluginId plugin_id, const string& name, \
PluginRegistry::FACTORY_TYPE factory) { \
return RegisterFactoryInternal(plugin_id, name, factory, \
&factories_[platform_id].FACTORY_VAR); \
} \
\
template <> \
port::Status PluginRegistry::RegisterFactoryForAllPlatforms< \
PluginRegistry::FACTORY_TYPE>(PluginId plugin_id, const string& name, \
PluginRegistry::FACTORY_TYPE factory) { \
return RegisterFactoryInternal(plugin_id, name, factory, \
&generic_factories_.FACTORY_VAR); \
} \
\
template <> \
port::StatusOr<PluginRegistry::FACTORY_TYPE> PluginRegistry::GetFactory( \
Platform::Id platform_id, PluginId plugin_id) { \
if (plugin_id == PluginConfig::kDefault) { \
plugin_id = default_factories_[platform_id].FACTORY_VAR; \
\
if (plugin_id == kNullPlugin) { \
return port::Status( \
port::error::FAILED_PRECONDITION, \
"No suitable " PLUGIN_STRING \
" plugin registered. Have you linked in a " PLUGIN_STRING \
"-providing plugin?"); \
} else { \
VLOG(2) << "Selecting default " PLUGIN_STRING " plugin, " \
<< plugin_names_[plugin_id]; \
} \
} \
return GetFactoryInternal(plugin_id, factories_[platform_id].FACTORY_VAR, \
generic_factories_.FACTORY_VAR); \
} \
\
/* TODO(b/22689637): Also temporary WRT MultiPlatformManager */ \
template <> \
port::StatusOr<PluginRegistry::FACTORY_TYPE> PluginRegistry::GetFactory( \
PlatformKind platform_kind, PluginId plugin_id) { \
auto iter = platform_id_by_kind_.find(platform_kind); \
if (iter == platform_id_by_kind_.end()) { \
return port::Status(port::error::FAILED_PRECONDITION, \
port::Printf("Platform kind %d not registered.", \
static_cast<int>(platform_kind))); \
} \
return GetFactory<PluginRegistry::FACTORY_TYPE>(iter->second, plugin_id); \
}
EMIT_PLUGIN_SPECIALIZATIONS(BlasFactory, blas, "BLAS");
EMIT_PLUGIN_SPECIALIZATIONS(DnnFactory, dnn, "DNN");
EMIT_PLUGIN_SPECIALIZATIONS(FftFactory, fft, "FFT");
EMIT_PLUGIN_SPECIALIZATIONS(RngFactory, rng, "RNG");
} // namespace stream_executor
|
