dom/base/DocGroup.h

   1 /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* vim: set ts=8 sts=2 et sw=2 tw=80: */
   3 /* This Source Code Form is subject to the terms of the Mozilla Public
   4  * License, v. 2.0. If a copy of the MPL was not distributed with this file,
   5  * You can obtain one at http://mozilla.org/MPL/2.0/. */
   6
   7 #ifndef DocGroup_h
   8 #define DocGroup_h
   9
  10 #include "nsISupportsImpl.h"
  11 #include "nsIPrincipal.h"
  12 #include "nsThreadUtils.h"
  13 #include "nsTHashSet.h"
  14 #include "nsString.h"
  15 #include "mozilla/RefPtr.h"
  16 #include "mozilla/dom/BrowsingContextGroup.h"
  17 #include "mozilla/dom/HTMLSlotElement.h"
  18 #include "mozilla/PerformanceCounter.h"
  19 #include "mozilla/PerformanceTypes.h"
  20
  21 namespace mozilla {
  22 class AbstractThread;
  23 namespace dom {
  24
  25 class CustomElementReactionsStack;
  26 class JSExecutionManager;
  27
  28 // Two browsing contexts are considered "related" if they are reachable from one
  29 // another through window.opener, window.parent, or window.frames. This is the
  30 // spec concept of a browsing context group.
  31 //
  32 // Two browsing contexts are considered "similar-origin" if they can be made to
  33 // have the same origin by setting document.domain. This is the spec concept of
  34 // a "unit of similar-origin related browsing contexts"
  35 //
  36 // A BrowsingContextGroup is a set of browsing contexts which are all
  37 // "related".  Within a BrowsingContextGroup, browsing contexts are
  38 // broken into "similar-origin" DocGroups.  A DocGroup is a member
  39 // of exactly one BrowsingContextGroup.
  40 class DocGroup final {
  41  public:
  42   typedef nsTArray<Document*>::iterator Iterator;
  43
  44   NS_INLINE_DECL_CYCLE_COLLECTING_NATIVE_REFCOUNTING(DocGroup)
  45   NS_DECL_CYCLE_COLLECTION_NATIVE_CLASS(DocGroup)
  46
  47   static already_AddRefed<DocGroup> Create(
  48       BrowsingContextGroup* aBrowsingContextGroup, const nsACString& aKey);
  49
  50   // Returns NS_ERROR_FAILURE and sets |aString| to an empty string if the TLD
  51   // service isn't available. Returns NS_OK on success, but may still set
  52   // |aString| may still be set to an empty string.
  53   [[nodiscard]] static nsresult GetKey(nsIPrincipal* aPrincipal,
  54                                        bool aCrossOriginIsolated,
  55                                        nsACString& aKey);
  56
  57   bool MatchesKey(const nsACString& aKey) { return aKey == mKey; }
  58
  59   const nsACString& GetKey() const { return mKey; }
  60
  61   PerformanceCounter* GetPerformanceCounter() { return mPerformanceCounter; }
  62
  63   JSExecutionManager* GetExecutionManager() const { return mExecutionManager; }
  64   void SetExecutionManager(JSExecutionManager*);
  65
  66   RefPtr<PerformanceInfoPromise> ReportPerformanceInfo();
  67
  68   BrowsingContextGroup* GetBrowsingContextGroup() const {
  69     return mBrowsingContextGroup;
  70   }
  71
  72   mozilla::dom::DOMArena* ArenaAllocator() { return mArena; }
  73
  74   mozilla::dom::CustomElementReactionsStack* CustomElementReactionsStack();
  75
  76   // Adding documents to a DocGroup should be done through
  77   // BrowsingContextGroup::AddDocument (which in turn calls
  78   // DocGroup::AddDocument).
  79   void AddDocument(Document* aDocument);
  80
  81   // Removing documents from a DocGroup should be done through
  82   // BrowsingContextGroup::RemoveDocument(which in turn calls
  83   // DocGroup::RemoveDocument).
  84   void RemoveDocument(Document* aDocument);
  85
  86   // Iterators for iterating over every document within the DocGroup
  87   Iterator begin() {
  88     MOZ_ASSERT(NS_IsMainThread());
  89     return mDocuments.begin();
  90   }
  91   Iterator end() {
  92     MOZ_ASSERT(NS_IsMainThread());
  93     return mDocuments.end();
  94   }
  95
  96   nsresult Dispatch(TaskCategory aCategory,
  97                     already_AddRefed<nsIRunnable>&& aRunnable);
  98
  99   nsISerialEventTarget* EventTargetFor(TaskCategory aCategory) const;
 100
 101   AbstractThread* AbstractMainThreadFor(TaskCategory aCategory);
 102
 103   // Return a pointer that can be continually checked to see if access to this
 104   // DocGroup is valid. This pointer should live at least as long as the
 105   // DocGroup.
 106   bool* GetValidAccessPtr();
 107
 108   // Append aSlot to the list of signal slot list, and queue a mutation observer
 109   // microtask.
 110   void SignalSlotChange(HTMLSlotElement& aSlot);
 111
 112   nsTArray<RefPtr<HTMLSlotElement>> MoveSignalSlotList();
 113
 114   // List of DocGroups that has non-empty signal slot list.
 115   static AutoTArray<RefPtr<DocGroup>, 2>* sPendingDocGroups;
 116
 117   // Returns true if any of its documents are active but not in the bfcache.
 118   bool IsActive() const;
 119
 120   nsresult QueueIframePostMessages(already_AddRefed<nsIRunnable>&& aRunnable,
 121                                    uint64_t aWindowId);
 122
 123   void TryFlushIframePostMessages(uint64_t aWindowId);
 124
 125   static bool TryToLoadIframesInBackground();
 126
 127   const nsID& AgentClusterId() const { return mAgentClusterId; }
 128
 129   bool IsEmpty() const { return mDocuments.IsEmpty(); }
 130
 131  private:
 132   DocGroup(BrowsingContextGroup* aBrowsingContextGroup, const nsACString& aKey);
 133
 134   ~DocGroup();
 135
 136   void FlushIframePostMessageQueue();
 137   nsCString mKey;
 138   nsTArray<Document*> mDocuments;
 139   RefPtr<mozilla::dom::CustomElementReactionsStack> mReactionsStack;
 140   nsTArray<RefPtr<HTMLSlotElement>> mSignalSlotList;
 141   RefPtr<mozilla::PerformanceCounter> mPerformanceCounter;
 142   RefPtr<BrowsingContextGroup> mBrowsingContextGroup;
 143   RefPtr<mozilla::ThrottledEventQueue> mIframePostMessageQueue;
 144   nsTHashSet<uint64_t> mIframesUsedPostMessageQueue;
 145   nsCOMPtr<nsISerialEventTarget> mEventTarget;
 146
 147   // non-null if the JS execution for this docgroup is regulated with regards
 148   // to worker threads. This should only be used when we are forcing serialized
 149   // SAB access.
 150   RefPtr<JSExecutionManager> mExecutionManager;
 151
 152   // Each DocGroup has a persisted agent cluster ID.
 153   const nsID mAgentClusterId;
 154
 155   RefPtr<mozilla::dom::DOMArena> mArena;
 156 };
 157
 158 }  // namespace dom
 159 }  // namespace mozilla
 160
 161 #endif  // defined(DocGroup_h)