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
|
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#include "mozilla/mscom/AgileReference.h"
#include <utility>
#include "mozilla/Assertions.h"
#include "mozilla/DebugOnly.h"
#include "mozilla/DynamicallyLinkedFunctionPtr.h"
#include "mozilla/mscom/Utils.h"
#if defined(MOZILLA_INTERNAL_API)
# include "nsDebug.h"
# include "nsPrintfCString.h"
#endif // defined(MOZILLA_INTERNAL_API)
#if NTDDI_VERSION < NTDDI_WINBLUE
// Declarations from Windows SDK specific to Windows 8.1
enum AgileReferenceOptions {
AGILEREFERENCE_DEFAULT = 0,
AGILEREFERENCE_DELAYEDMARSHAL = 1,
};
HRESULT WINAPI RoGetAgileReference(AgileReferenceOptions options, REFIID riid,
IUnknown* pUnk,
IAgileReference** ppAgileReference);
#endif // NTDDI_VERSION < NTDDI_WINBLUE
namespace mozilla {
namespace mscom {
namespace detail {
GlobalInterfaceTableCookie::GlobalInterfaceTableCookie(IUnknown* aObject,
REFIID aIid,
HRESULT& aOutHResult)
: mCookie(0) {
IGlobalInterfaceTable* git = ObtainGit();
MOZ_ASSERT(git);
if (!git) {
aOutHResult = E_POINTER;
return;
}
aOutHResult = git->RegisterInterfaceInGlobal(aObject, aIid, &mCookie);
MOZ_ASSERT(SUCCEEDED(aOutHResult));
}
GlobalInterfaceTableCookie::~GlobalInterfaceTableCookie() {
IGlobalInterfaceTable* git = ObtainGit();
MOZ_ASSERT(git);
if (!git) {
return;
}
DebugOnly<HRESULT> hr = git->RevokeInterfaceFromGlobal(mCookie);
#if defined(MOZILLA_INTERNAL_API)
NS_WARNING_ASSERTION(
SUCCEEDED(hr),
nsPrintfCString("IGlobalInterfaceTable::RevokeInterfaceFromGlobal failed "
"with HRESULT 0x%08lX",
((HRESULT)hr))
.get());
#else
MOZ_ASSERT(SUCCEEDED(hr));
#endif // defined(MOZILLA_INTERNAL_API)
mCookie = 0;
}
HRESULT GlobalInterfaceTableCookie::GetInterface(REFIID aIid,
void** aOutInterface) const {
IGlobalInterfaceTable* git = ObtainGit();
MOZ_ASSERT(git);
if (!git) {
return E_UNEXPECTED;
}
MOZ_ASSERT(IsValid());
return git->GetInterfaceFromGlobal(mCookie, aIid, aOutInterface);
}
/* static */
IGlobalInterfaceTable* GlobalInterfaceTableCookie::ObtainGit() {
// Internally to COM, the Global Interface Table is a singleton, therefore we
// don't worry about holding onto this reference indefinitely.
static IGlobalInterfaceTable* sGit = []() -> IGlobalInterfaceTable* {
IGlobalInterfaceTable* result = nullptr;
DebugOnly<HRESULT> hr = ::CoCreateInstance(
CLSID_StdGlobalInterfaceTable, nullptr, CLSCTX_INPROC_SERVER,
IID_IGlobalInterfaceTable, reinterpret_cast<void**>(&result));
MOZ_ASSERT(SUCCEEDED(hr));
return result;
}();
return sGit;
}
} // namespace detail
AgileReference::AgileReference() : mIid(), mHResult(E_NOINTERFACE) {}
AgileReference::AgileReference(REFIID aIid, IUnknown* aObject)
: mIid(aIid), mHResult(E_UNEXPECTED) {
AssignInternal(aObject);
}
AgileReference::AgileReference(AgileReference&& aOther)
: mIid(aOther.mIid),
mAgileRef(std::move(aOther.mAgileRef)),
mGitCookie(std::move(aOther.mGitCookie)),
mHResult(aOther.mHResult) {
aOther.mHResult = CO_E_RELEASED;
}
void AgileReference::Assign(REFIID aIid, IUnknown* aObject) {
Clear();
mIid = aIid;
AssignInternal(aObject);
}
void AgileReference::AssignInternal(IUnknown* aObject) {
// We expect mIid to already be set
DebugOnly<IID> zeroIid = {};
MOZ_ASSERT(mIid != zeroIid);
/*
* There are two possible techniques for creating agile references. Starting
* with Windows 8.1, we may use the RoGetAgileReference API, which is faster.
* If that API is not available, we fall back to using the Global Interface
* Table.
*/
static const StaticDynamicallyLinkedFunctionPtr<
decltype(&::RoGetAgileReference)>
pRoGetAgileReference(L"ole32.dll", "RoGetAgileReference");
MOZ_ASSERT(aObject);
if (pRoGetAgileReference &&
SUCCEEDED(mHResult =
pRoGetAgileReference(AGILEREFERENCE_DEFAULT, mIid, aObject,
getter_AddRefs(mAgileRef)))) {
return;
}
mGitCookie = new detail::GlobalInterfaceTableCookie(aObject, mIid, mHResult);
MOZ_ASSERT(mGitCookie->IsValid());
}
AgileReference::~AgileReference() { Clear(); }
void AgileReference::Clear() {
mIid = {};
mAgileRef = nullptr;
mGitCookie = nullptr;
mHResult = E_NOINTERFACE;
}
AgileReference& AgileReference::operator=(const AgileReference& aOther) {
Clear();
mIid = aOther.mIid;
mAgileRef = aOther.mAgileRef;
mGitCookie = aOther.mGitCookie;
mHResult = aOther.mHResult;
return *this;
}
AgileReference& AgileReference::operator=(AgileReference&& aOther) {
Clear();
mIid = aOther.mIid;
mAgileRef = std::move(aOther.mAgileRef);
mGitCookie = std::move(aOther.mGitCookie);
mHResult = aOther.mHResult;
aOther.mHResult = CO_E_RELEASED;
return *this;
}
HRESULT
AgileReference::Resolve(REFIID aIid, void** aOutInterface) const {
MOZ_ASSERT(aOutInterface);
// This check is exclusive-OR; we should have one or the other, but not both
MOZ_ASSERT((mAgileRef || mGitCookie) && !(mAgileRef && mGitCookie));
MOZ_ASSERT(IsCOMInitializedOnCurrentThread());
if (!aOutInterface) {
return E_INVALIDARG;
}
*aOutInterface = nullptr;
if (mAgileRef) {
// IAgileReference lets you directly resolve the interface you want...
return mAgileRef->Resolve(aIid, aOutInterface);
}
if (!mGitCookie) {
return E_UNEXPECTED;
}
RefPtr<IUnknown> originalInterface;
HRESULT hr =
mGitCookie->GetInterface(mIid, getter_AddRefs(originalInterface));
if (FAILED(hr)) {
return hr;
}
if (aIid == mIid) {
originalInterface.forget(aOutInterface);
return S_OK;
}
// ...Whereas the GIT requires us to obtain the same interface that we
// requested and then QI for the desired interface afterward.
return originalInterface->QueryInterface(aIid, aOutInterface);
}
} // namespace mscom
} // namespace mozilla
|
