2016-07-18 22:49:28 +03:00
|
|
|
/* -*- 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/. */
|
|
|
|
|
|
|
|
#ifndef mozilla_mscom_EnsureMTA_h
|
|
|
|
#define mozilla_mscom_EnsureMTA_h
|
|
|
|
|
|
|
|
#include "MainThreadUtils.h"
|
|
|
|
#include "mozilla/Attributes.h"
|
|
|
|
#include "mozilla/DebugOnly.h"
|
2016-12-14 11:34:12 +03:00
|
|
|
#include "mozilla/Unused.h"
|
2016-07-18 22:49:28 +03:00
|
|
|
#include "mozilla/mscom/COMApartmentRegion.h"
|
2016-08-30 04:55:37 +03:00
|
|
|
#include "mozilla/mscom/Utils.h"
|
2016-07-18 22:49:28 +03:00
|
|
|
#include "nsCOMPtr.h"
|
|
|
|
#include "nsIThread.h"
|
|
|
|
#include "nsThreadUtils.h"
|
2017-06-09 00:55:55 +03:00
|
|
|
#include "nsWindowsHelpers.h"
|
2016-07-18 22:49:28 +03:00
|
|
|
|
|
|
|
#include <windows.h>
|
|
|
|
|
|
|
|
namespace mozilla {
|
|
|
|
namespace mscom {
|
2017-06-09 00:55:55 +03:00
|
|
|
namespace detail {
|
|
|
|
|
|
|
|
// Forward declarations
|
|
|
|
template <typename T>
|
|
|
|
struct MTADelete;
|
|
|
|
|
|
|
|
template <typename T>
|
|
|
|
struct MTARelease;
|
|
|
|
|
|
|
|
template <typename T>
|
|
|
|
struct MTAReleaseInChildProcess;
|
|
|
|
|
2017-07-19 21:07:45 +03:00
|
|
|
struct PreservedStreamDeleter;
|
|
|
|
|
2017-06-09 00:55:55 +03:00
|
|
|
}
|
2016-07-18 22:49:28 +03:00
|
|
|
|
|
|
|
// This class is OK to use as a temporary on the stack.
|
2017-06-09 00:55:55 +03:00
|
|
|
class MOZ_STACK_CLASS EnsureMTA final
|
2016-07-18 22:49:28 +03:00
|
|
|
{
|
|
|
|
public:
|
2016-11-15 21:33:57 +03:00
|
|
|
/**
|
|
|
|
* This constructor just ensures that the MTA thread is up and running.
|
|
|
|
*/
|
|
|
|
EnsureMTA()
|
|
|
|
{
|
|
|
|
MOZ_ASSERT(NS_IsMainThread());
|
|
|
|
nsCOMPtr<nsIThread> thread = GetMTAThread();
|
|
|
|
MOZ_ASSERT(thread);
|
2016-12-14 11:34:12 +03:00
|
|
|
Unused << thread;
|
2016-11-15 21:33:57 +03:00
|
|
|
}
|
|
|
|
|
2016-07-18 22:49:28 +03:00
|
|
|
template <typename FuncT>
|
2016-12-16 10:56:04 +03:00
|
|
|
explicit EnsureMTA(const FuncT& aClosure)
|
2016-07-18 22:49:28 +03:00
|
|
|
{
|
|
|
|
if (IsCurrentThreadMTA()) {
|
|
|
|
// We're already on the MTA, we can run aClosure directly
|
|
|
|
aClosure();
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
2017-06-09 00:55:55 +03:00
|
|
|
MOZ_ASSERT(NS_IsMainThread());
|
|
|
|
|
2016-07-18 22:49:28 +03:00
|
|
|
// In this case we need to run aClosure on a background thread in the MTA
|
|
|
|
nsCOMPtr<nsIThread> thread = GetMTAThread();
|
|
|
|
MOZ_ASSERT(thread);
|
2017-06-09 00:55:55 +03:00
|
|
|
if (!thread) {
|
|
|
|
return;
|
|
|
|
}
|
2016-07-18 22:49:28 +03:00
|
|
|
|
2017-07-07 01:44:21 +03:00
|
|
|
// Note that we might reenter the EnsureMTA constructor while we wait on
|
|
|
|
// this event due to APC dispatch, therefore we need a unique event object
|
|
|
|
// for each entry. If perf becomes an issue then we will want to maintain
|
|
|
|
// an array of events where the Nth event is unique to the Nth reentry.
|
|
|
|
nsAutoHandle event(::CreateEventW(nullptr, FALSE, FALSE, nullptr));
|
2016-07-18 22:49:28 +03:00
|
|
|
if (!event) {
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
2017-06-09 00:55:55 +03:00
|
|
|
HANDLE eventHandle = event.get();
|
|
|
|
|
|
|
|
auto eventSetter = [&aClosure, eventHandle]() -> void {
|
2016-07-18 22:49:28 +03:00
|
|
|
aClosure();
|
2017-06-09 00:55:55 +03:00
|
|
|
::SetEvent(eventHandle);
|
2016-07-18 22:49:28 +03:00
|
|
|
};
|
|
|
|
|
|
|
|
nsresult rv =
|
2017-06-12 22:34:10 +03:00
|
|
|
thread->Dispatch(NS_NewRunnableFunction("EnsureMTA", eventSetter), NS_DISPATCH_NORMAL);
|
2016-07-18 22:49:28 +03:00
|
|
|
MOZ_ASSERT(NS_SUCCEEDED(rv));
|
2017-06-09 00:55:55 +03:00
|
|
|
if (NS_FAILED(rv)) {
|
2016-07-18 22:49:28 +03:00
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
|
|
|
DWORD waitResult;
|
|
|
|
while ((waitResult = ::WaitForSingleObjectEx(event, INFINITE, TRUE)) ==
|
|
|
|
WAIT_IO_COMPLETION) {
|
|
|
|
}
|
|
|
|
MOZ_ASSERT(waitResult == WAIT_OBJECT_0);
|
|
|
|
}
|
|
|
|
|
|
|
|
private:
|
|
|
|
static nsCOMPtr<nsIThread> GetMTAThread();
|
2017-06-09 00:55:55 +03:00
|
|
|
|
|
|
|
// The following function is private in order to force any consumers to be
|
|
|
|
// declared as friends of EnsureMTA. The intention is to prevent
|
|
|
|
// AsyncOperation from becoming some kind of free-for-all mechanism for
|
|
|
|
// asynchronously executing work on a background thread.
|
|
|
|
template <typename FuncT>
|
|
|
|
static void AsyncOperation(const FuncT& aClosure)
|
|
|
|
{
|
|
|
|
if (IsCurrentThreadMTA()) {
|
|
|
|
aClosure();
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
|
|
|
nsCOMPtr<nsIThread> thread(GetMTAThread());
|
|
|
|
MOZ_ASSERT(thread);
|
|
|
|
if (!thread) {
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
|
|
|
DebugOnly<nsresult> rv = thread->Dispatch(
|
2017-06-12 22:34:10 +03:00
|
|
|
NS_NewRunnableFunction("mscom::EnsureMTA::AsyncOperation",
|
|
|
|
aClosure), NS_DISPATCH_NORMAL);
|
2017-06-09 00:55:55 +03:00
|
|
|
MOZ_ASSERT(NS_SUCCEEDED(rv));
|
|
|
|
}
|
|
|
|
|
|
|
|
template <typename T>
|
|
|
|
friend struct mozilla::mscom::detail::MTADelete;
|
|
|
|
|
|
|
|
template <typename T>
|
|
|
|
friend struct mozilla::mscom::detail::MTARelease;
|
|
|
|
|
|
|
|
template <typename T>
|
|
|
|
friend struct mozilla::mscom::detail::MTAReleaseInChildProcess;
|
2017-07-19 21:07:45 +03:00
|
|
|
|
|
|
|
friend struct mozilla::mscom::detail::PreservedStreamDeleter;
|
2016-07-18 22:49:28 +03:00
|
|
|
};
|
|
|
|
|
|
|
|
} // namespace mscom
|
|
|
|
} // namespace mozilla
|
|
|
|
|
|
|
|
#endif // mozilla_mscom_EnsureMTA_h
|
|
|
|
|