dom/performance/Performance.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
   5  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   6
   7 #ifndef mozilla_dom_Performance_h
   8 #define mozilla_dom_Performance_h
   9
  10 #include "mozilla/Attributes.h"
  11 #include "mozilla/DOMEventTargetHelper.h"
  12 #include "nsCOMPtr.h"
  13 #include "nsContentUtils.h"
  14 #include "nsDOMNavigationTiming.h"
  15 #include "nsTObserverArray.h"
  16
  17 class nsITimedChannel;
  18
  19 namespace mozilla {
  20
  21 class ErrorResult;
  22
  23 namespace dom {
  24
  25 class OwningStringOrDouble;
  26 class StringOrPerformanceMeasureOptions;
  27 class PerformanceEntry;
  28 class PerformanceMark;
  29 struct PerformanceMarkOptions;
  30 struct PerformanceMeasureOptions;
  31 class PerformanceMeasure;
  32 class PerformanceNavigation;
  33 class PerformancePaintTiming;
  34 class PerformanceObserver;
  35 class PerformanceService;
  36 class PerformanceStorage;
  37 class PerformanceTiming;
  38 class PerformanceEventTiming;
  39 class WorkerGlobalScope;
  40 class EventCounts;
  41
  42 // Base class for main-thread and worker Performance API
  43 class Performance : public DOMEventTargetHelper {
  44  public:
  45   NS_DECL_ISUPPORTS_INHERITED
  46   NS_DECL_CYCLE_COLLECTION_CLASS_INHERITED(Performance, DOMEventTargetHelper)
  47
  48   static bool IsObserverEnabled(JSContext* aCx, JSObject* aGlobal);
  49
  50   static already_AddRefed<Performance> CreateForMainThread(
  51       nsPIDOMWindowInner* aWindow, nsIPrincipal* aPrincipal,
  52       nsDOMNavigationTiming* aDOMTiming, nsITimedChannel* aChannel);
  53
  54   static already_AddRefed<Performance> CreateForWorker(
  55       WorkerGlobalScope* aGlobalScope);
  56
  57   // This will return nullptr if called outside of a Window or Worker.
  58   static already_AddRefed<Performance> Get(JSContext* aCx,
  59                                            nsIGlobalObject* aGlobal);
  60
  61   JSObject* WrapObject(JSContext* cx,
  62                        JS::Handle<JSObject*> aGivenProto) override;
  63
  64   virtual void GetEntries(nsTArray<RefPtr<PerformanceEntry>>& aRetval);
  65
  66   virtual void GetEntriesByType(const nsAString& aEntryType,
  67                                 nsTArray<RefPtr<PerformanceEntry>>& aRetval);
  68
  69   virtual void GetEntriesByTypeForObserver(
  70       const nsAString& aEntryType, nsTArray<RefPtr<PerformanceEntry>>& aRetval);
  71
  72   virtual void GetEntriesByName(const nsAString& aName,
  73                                 const Optional<nsAString>& aEntryType,
  74                                 nsTArray<RefPtr<PerformanceEntry>>& aRetval);
  75
  76   virtual PerformanceStorage* AsPerformanceStorage() = 0;
  77
  78   void ClearResourceTimings();
  79
  80   DOMHighResTimeStamp Now();
  81
  82   DOMHighResTimeStamp NowUnclamped() const;
  83
  84   DOMHighResTimeStamp TimeOrigin();
  85
  86   already_AddRefed<PerformanceMark> Mark(
  87       JSContext* aCx, const nsAString& aName,
  88       const PerformanceMarkOptions& aMarkOptions, ErrorResult& aRv);
  89
  90   void ClearMarks(const Optional<nsAString>& aName);
  91
  92   already_AddRefed<PerformanceMeasure> Measure(
  93       JSContext* aCx, const nsAString& aName,
  94       const StringOrPerformanceMeasureOptions& aStartOrMeasureOptions,
  95       const Optional<nsAString>& aEndMark, ErrorResult& aRv);
  96
  97   void ClearMeasures(const Optional<nsAString>& aName);
  98
  99   void SetResourceTimingBufferSize(uint64_t aMaxSize);
 100
 101   void AddObserver(PerformanceObserver* aObserver);
 102   void RemoveObserver(PerformanceObserver* aObserver);
 103   MOZ_CAN_RUN_SCRIPT void NotifyObservers();
 104   void CancelNotificationObservers();
 105
 106   virtual PerformanceTiming* Timing() = 0;
 107
 108   virtual PerformanceNavigation* Navigation() = 0;
 109
 110   virtual void SetFCPTimingEntry(PerformancePaintTiming* aEntry) = 0;
 111
 112   IMPL_EVENT_HANDLER(resourcetimingbufferfull)
 113
 114   virtual void GetMozMemory(JSContext* aCx,
 115                             JS::MutableHandle<JSObject*> aObj) = 0;
 116
 117   virtual nsDOMNavigationTiming* GetDOMTiming() const = 0;
 118
 119   virtual nsITimedChannel* GetChannel() const = 0;
 120
 121   virtual TimeStamp CreationTimeStamp() const = 0;
 122
 123   RTPCallerType GetRTPCallerType() const { return mRTPCallerType; }
 124
 125   bool CrossOriginIsolated() const { return mCrossOriginIsolated; }
 126   bool ShouldResistFingerprinting() const {
 127     return mShouldResistFingerprinting;
 128   }
 129
 130   DOMHighResTimeStamp TimeStampToDOMHighResForRendering(TimeStamp) const;
 131
 132   virtual uint64_t GetRandomTimelineSeed() = 0;
 133
 134   void MemoryPressure();
 135
 136   size_t SizeOfUserEntries(mozilla::MallocSizeOf aMallocSizeOf) const;
 137   size_t SizeOfResourceEntries(mozilla::MallocSizeOf aMallocSizeOf) const;
 138   virtual size_t SizeOfEventEntries(mozilla::MallocSizeOf aMallocSizeOf) const {
 139     return 0;
 140   }
 141
 142   void InsertResourceEntry(PerformanceEntry* aEntry);
 143
 144   virtual void InsertEventTimingEntry(PerformanceEventTiming* aEntry) = 0;
 145
 146   virtual void BufferEventTimingEntryIfNeeded(
 147       PerformanceEventTiming* aEntry) = 0;
 148
 149   virtual class EventCounts* EventCounts() = 0;
 150
 151   virtual void QueueNavigationTimingEntry() = 0;
 152
 153   virtual void UpdateNavigationTimingEntry() = 0;
 154
 155   virtual void DispatchPendingEventTimingEntries() = 0;
 156
 157   void QueueNotificationObserversTask();
 158
 159   bool IsPerformanceTimingAttribute(const nsAString& aName) const;
 160
 161   virtual bool IsGlobalObjectWindow() const { return false; };
 162
 163  protected:
 164   Performance(nsIGlobalObject* aGlobal);
 165   Performance(nsPIDOMWindowInner* aWindow);
 166
 167   virtual ~Performance();
 168
 169   virtual void InsertUserEntry(PerformanceEntry* aEntry);
 170
 171   void ClearUserEntries(const Optional<nsAString>& aEntryName,
 172                         const nsAString& aEntryType);
 173
 174   virtual void DispatchBufferFullEvent() = 0;
 175
 176   virtual DOMHighResTimeStamp CreationTime() const = 0;
 177
 178   virtual DOMHighResTimeStamp GetPerformanceTimingFromString(
 179       const nsAString& aTimingName) {
 180     return 0;
 181   }
 182
 183   void LogEntry(PerformanceEntry* aEntry, const nsACString& aOwner) const;
 184   void TimingNotification(PerformanceEntry* aEntry, const nsACString& aOwner,
 185                           const double aEpoch);
 186
 187   void RunNotificationObserversTask();
 188   void QueueEntry(PerformanceEntry* aEntry);
 189
 190   nsTObserverArray<RefPtr<PerformanceObserver>> mObservers;
 191
 192  protected:
 193   static const uint64_t kDefaultResourceTimingBufferSize = 250;
 194
 195   // When kDefaultResourceTimingBufferSize is increased or removed, these should
 196   // be changed to use SegmentedVector
 197   AutoTArray<RefPtr<PerformanceEntry>, kDefaultResourceTimingBufferSize>
 198       mUserEntries;
 199   AutoTArray<RefPtr<PerformanceEntry>, kDefaultResourceTimingBufferSize>
 200       mResourceEntries;
 201   AutoTArray<RefPtr<PerformanceEntry>, kDefaultResourceTimingBufferSize>
 202       mSecondaryResourceEntries;
 203
 204   uint64_t mResourceTimingBufferSize;
 205   bool mPendingNotificationObserversTask;
 206
 207   bool mPendingResourceTimingBufferFullEvent;
 208
 209   RefPtr<PerformanceService> mPerformanceService;
 210
 211   const RTPCallerType mRTPCallerType;
 212   const bool mCrossOriginIsolated;
 213   const bool mShouldResistFingerprinting;
 214
 215  private:
 216   MOZ_ALWAYS_INLINE bool CanAddResourceTimingEntry();
 217   void BufferEvent();
 218   void MaybeEmitExternalProfilerMarker(
 219       const nsAString& aName, Maybe<const PerformanceMeasureOptions&> aOptions,
 220       Maybe<const nsAString&> aStartMark, const Optional<nsAString>& aEndMark);
 221
 222   // The attributes of a PerformanceMeasureOptions that we call
 223   // ResolveTimestamp* on.
 224   enum class ResolveTimestampAttribute;
 225
 226   DOMHighResTimeStamp ConvertMarkToTimestampWithString(const nsAString& aName,
 227                                                        ErrorResult& aRv,
 228                                                        bool aReturnUnclamped);
 229   DOMHighResTimeStamp ConvertMarkToTimestampWithDOMHighResTimeStamp(
 230       const ResolveTimestampAttribute aAttribute, const double aTimestamp,
 231       ErrorResult& aRv);
 232   DOMHighResTimeStamp ConvertMarkToTimestamp(
 233       const ResolveTimestampAttribute aAttribute,
 234       const OwningStringOrDouble& aMarkNameOrTimestamp, ErrorResult& aRv,
 235       bool aReturnUnclamped);
 236
 237   DOMHighResTimeStamp ConvertNameToTimestamp(const nsAString& aName,
 238                                              ErrorResult& aRv);
 239
 240   DOMHighResTimeStamp ResolveEndTimeForMeasure(
 241       const Optional<nsAString>& aEndMark,
 242       const Maybe<const PerformanceMeasureOptions&>& aOptions, ErrorResult& aRv,
 243       bool aReturnUnclamped);
 244   DOMHighResTimeStamp ResolveStartTimeForMeasure(
 245       const Maybe<const nsAString&>& aStartMark,
 246       const Maybe<const PerformanceMeasureOptions&>& aOptions, ErrorResult& aRv,
 247       bool aReturnUnclamped);
 248
 249   std::pair<TimeStamp, TimeStamp> GetTimeStampsForMarker(
 250       const Maybe<const nsAString&>& aStartMark,
 251       const Optional<nsAString>& aEndMark,
 252       const Maybe<const PerformanceMeasureOptions&>& aOptions,
 253       ErrorResult& aRv);
 254 };
 255
 256 }  // namespace dom
 257 }  // namespace mozilla
 258
 259 #endif  // mozilla_dom_Performance_h