gecko-dev/dom/worklet/WorkletImpl.h

/* -*- 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 https://mozilla.org/MPL/2.0/. */

#ifndef mozilla_dom_worklet_WorkletImpl_h
#define mozilla_dom_worklet_WorkletImpl_h

#include "MainThreadUtils.h"
#include "mozilla/OriginAttributes.h"

class nsPIDOMWindowInner;
class nsIPrincipal;
class nsIRunnable;

namespace mozilla {

namespace dom {

class Worklet;
class WorkletGlobalScope;
class WorkletThread;

} // namespace dom

class WorkletLoadInfo
{
public:
  WorkletLoadInfo(nsPIDOMWindowInner* aWindow, nsIPrincipal* aPrincipal);
  ~WorkletLoadInfo();

  uint64_t OuterWindowID() const { return mOuterWindowID; }
  uint64_t InnerWindowID() const { return mInnerWindowID; }
  bool DumpEnabled() const { return mDumpEnabled; }

  const OriginAttributes& OriginAttributesRef() const
  {
    return mOriginAttributes;
  }

  nsIPrincipal* Principal() const
  {
    MOZ_ASSERT(NS_IsMainThread());
    return mPrincipal;
  }

private:
  // Modified only in constructor.
  uint64_t mOuterWindowID;
  const uint64_t mInnerWindowID;
  const bool mDumpEnabled;
  const OriginAttributes mOriginAttributes;
  // Accessed on only worklet parent thread.
  nsCOMPtr<nsIPrincipal> mPrincipal;

  friend class WorkletImpl;
  friend class WorkletThread;
};

/**
 * WorkletImpl is accessed from both the worklet's parent thread (on which the
 * Worklet object lives) and the worklet's execution thread.  It is owned by
 * Worklet and WorkletGlobalScope.  No parent thread cycle collected objects
 * are owned indefinitely by WorkletImpl because WorkletImpl is not cycle
 * collected.
 */
class WorkletImpl
{
public:
  NS_INLINE_DECL_THREADSAFE_REFCOUNTING(WorkletImpl);

  enum WorkletType {
    eAudioWorklet,
    ePaintWorklet,
  };

  // Methods for parent thread only:

  static already_AddRefed<dom::Worklet>
  CreateWorklet(nsPIDOMWindowInner* aWindow, nsIPrincipal* aPrincipal,
                WorkletType aWorkletType);

  JSObject*
  WrapWorklet(JSContext* aCx, dom::Worklet* aWorklet,
              JS::Handle<JSObject*> aGivenProto);

  dom::WorkletThread* GetOrCreateThread();
  void TerminateThread();

  // Execution thread only.
  already_AddRefed<dom::WorkletGlobalScope> CreateGlobalScope(JSContext* aCx);

  // Any thread.

  const WorkletLoadInfo& LoadInfo() const { return mWorkletLoadInfo; }

  // Use DispatchRunnable only when the thread is known to already exist.
  nsresult DispatchRunnable(already_AddRefed<nsIRunnable> aRunnable);

private:
  WorkletImpl(nsPIDOMWindowInner* aWindow, nsIPrincipal* aPrincipal,
              WorkletType aWorkletType);
  ~WorkletImpl();

  // The only WorkletLoadInfo member modified is mPrincipal which is accessed
  // on only the parent thread.
  WorkletLoadInfo mWorkletLoadInfo;
  const WorkletType mWorkletType;

  // Parent thread only.
  RefPtr<dom::WorkletThread> mWorkletThread;
};

} // namespace mozilla

#endif // mozilla_dom_worklet_WorkletImpl_h