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
248
249
250
251
252
253
254
255
256
|
// Copyright Epic Games, Inc. All Rights Reserved.
#include "dlltransport.h"
#include <zencore/except.h>
#include <zencore/fmtutils.h>
#include <zencore/logging.h>
#include <zencore/scopeguard.h>
#include <zencore/string.h>
#include <exception>
#include <thread>
#include <vector>
ZEN_THIRD_PARTY_INCLUDES_START
#include <fmt/format.h>
ZEN_THIRD_PARTY_INCLUDES_END
#if ZEN_WITH_PLUGINS
namespace zen {
//////////////////////////////////////////////////////////////////////////
class DllTransportLogger : public TransportLogger, public RefCounted
{
public:
DllTransportLogger(std::string_view PluginName);
virtual ~DllTransportLogger() = default;
void LogMessage(LogLevel Level, const char* Message) override;
private:
std::string m_PluginName;
};
struct LoadedDll
{
std::string Name;
std::filesystem::path LoadedFromPath;
DllTransportLogger* Logger = nullptr;
Ref<TransportPlugin> Plugin;
};
class DllTransportPluginImpl : public DllTransportPlugin, RefCounted
{
public:
DllTransportPluginImpl() = default;
~DllTransportPluginImpl() = default;
virtual uint32_t AddRef() const override;
virtual uint32_t Release() const override;
virtual void Configure(const char* OptionTag, const char* OptionValue) override;
virtual void Initialize(TransportServer* ServerInterface) override;
virtual void Shutdown() override;
virtual const char* GetDebugName() override;
virtual bool IsAvailable() override;
virtual bool LoadDll(std::string_view Name) override;
virtual void ConfigureDll(std::string_view Name, const char* OptionTag, const char* OptionValue) override;
private:
TransportServer* m_ServerInterface = nullptr;
RwLock m_Lock;
std::vector<LoadedDll> m_Transports;
};
DllTransportLogger::DllTransportLogger(std::string_view PluginName) : m_PluginName(PluginName)
{
}
void
DllTransportLogger::LogMessage(LogLevel PluginLogLevel, const char* Message)
{
logging::level::LogLevel Level;
// clang-format off
switch (PluginLogLevel)
{
case LogLevel::Trace: Level = logging::level::Trace; break;
case LogLevel::Debug: Level = logging::level::Debug; break;
case LogLevel::Info: Level = logging::level::Info; break;
case LogLevel::Warn: Level = logging::level::Warn; break;
case LogLevel::Err: Level = logging::level::Err; break;
case LogLevel::Critical: Level = logging::level::Critical; break;
default: Level = logging::level::Off; break;
}
// clang-format on
ZEN_LOG(Log(), Level, "[{}] {}", m_PluginName, Message)
}
uint32_t
DllTransportPluginImpl::AddRef() const
{
return RefCounted::AddRef();
}
uint32_t
DllTransportPluginImpl::Release() const
{
return RefCounted::Release();
}
void
DllTransportPluginImpl::Configure(const char* OptionTag, const char* OptionValue)
{
// No configuration options
ZEN_UNUSED(OptionTag, OptionValue);
}
void
DllTransportPluginImpl::Initialize(TransportServer* ServerIface)
{
m_ServerInterface = ServerIface;
RwLock::ExclusiveLockScope _(m_Lock);
for (LoadedDll& Transport : m_Transports)
{
try
{
Transport.Plugin->Initialize(ServerIface);
}
catch (const std::exception&)
{
// TODO: report
}
}
}
void
DllTransportPluginImpl::Shutdown()
{
RwLock::ExclusiveLockScope _(m_Lock);
for (LoadedDll& Transport : m_Transports)
{
try
{
Transport.Plugin->Shutdown();
Transport.Logger->Release();
}
catch (const std::exception&)
{
// TODO: report
}
}
}
const char*
DllTransportPluginImpl::GetDebugName()
{
return nullptr;
}
bool
DllTransportPluginImpl::IsAvailable()
{
return true;
}
void
DllTransportPluginImpl::ConfigureDll(std::string_view Name, const char* OptionTag, const char* OptionValue)
{
RwLock::ExclusiveLockScope _(m_Lock);
for (auto& Transport : m_Transports)
{
if (Transport.Name == Name)
{
Transport.Plugin->Configure(OptionTag, OptionValue);
}
}
}
bool
DllTransportPluginImpl::LoadDll(std::string_view Name)
{
RwLock::ExclusiveLockScope _(m_Lock);
WideStringBuilder<1024> DllPath;
DllPath << Name;
if (!Name.ends_with(".dll"))
{
DllPath << ".dll";
}
std::string FileName = std::filesystem::path(DllPath.c_str()).filename().replace_extension().string();
std::string Path = std::filesystem::path(DllPath.c_str()).parent_path().string();
SetDllDirectoryW(Utf8ToWide(Path).c_str());
HMODULE DllHandle = LoadLibraryW(DllPath.c_str());
if (!DllHandle)
{
ZEN_WARN("Failed to load transport DLL from '{}' due to '{}'", WideToUtf8(DllPath), GetLastErrorAsString())
return false;
}
PfnGetTransportPluginVersion GetVersion = (PfnGetTransportPluginVersion)GetProcAddress(DllHandle, "GetTransportPluginVersion");
PfnCreateTransportPlugin CreatePlugin = (PfnCreateTransportPlugin)GetProcAddress(DllHandle, "CreateTransportPlugin");
uint32_t APIVersion = 0;
uint32_t PluginVersion = 0;
if (GetVersion)
{
GetVersion(&APIVersion, &PluginVersion);
}
const bool bValidApiVersion = APIVersion == kTransportApiVersion;
if (!GetVersion || !CreatePlugin || !bValidApiVersion)
{
std::error_code Ec = MakeErrorCodeFromLastError();
FreeLibrary(DllHandle);
if (GetVersion && !bValidApiVersion)
{
ZEN_WARN("Failed to load transport DLL from '{}' due to invalid API version {}, supported API version is {}",
WideToUtf8(DllPath),
APIVersion,
kTransportApiVersion)
}
else
{
ZEN_WARN("Failed to load transport DLL from '{}' due to not finding GetTransportPluginVersion or CreateTransportPlugin",
WideToUtf8(DllPath))
}
return false;
}
LoadedDll NewDll;
NewDll.Name = Name;
NewDll.LoadedFromPath = DllPath.c_str();
NewDll.Logger = new DllTransportLogger(FileName);
NewDll.Logger->AddRef();
NewDll.Plugin = CreatePlugin(NewDll.Logger);
m_Transports.emplace_back(std::move(NewDll));
return true;
}
DllTransportPlugin*
CreateDllTransportPlugin()
{
return new DllTransportPluginImpl;
}
} // namespace zen
#endif
|