forked from mirrors/gecko-dev
6ebcecc30e
We attach it to WorkerPrivate and DOMNavigationTiming so it will be re-used when it should. WorkerPrivate is used in the Performance APIs, Performance Storage Worker, and Event. DOMNavigationTiming is used only in the Performance APIs, but the crucial part is that when the individual DOMNavigationTiming object is re-used, so will the context seed. This in particular came up with the nav2_test_document_open.html Web Platform Test which illustrated the fact that even if you .open() a new document, the performance navigation data is not supposed to change. MozReview-Commit-ID: GIv6biEo2jY --HG-- extra : rebase_source : da2ad8d9d6e0172679c6af14dba72938e9d2012c
177 lines
5.1 KiB
C++
177 lines
5.1 KiB
C++
/* -*- 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_dom_Performance_h
|
|
#define mozilla_dom_Performance_h
|
|
|
|
#include "mozilla/Attributes.h"
|
|
#include "mozilla/DOMEventTargetHelper.h"
|
|
#include "mozilla/dom/DOMPrefs.h"
|
|
#include "nsCOMPtr.h"
|
|
#include "nsDOMNavigationTiming.h"
|
|
|
|
class nsITimedChannel;
|
|
|
|
namespace mozilla {
|
|
|
|
class ErrorResult;
|
|
|
|
namespace dom {
|
|
|
|
class PerformanceEntry;
|
|
class PerformanceNavigation;
|
|
class PerformanceObserver;
|
|
class PerformanceService;
|
|
class PerformanceStorage;
|
|
class PerformanceTiming;
|
|
class WorkerPrivate;
|
|
|
|
// Base class for main-thread and worker Performance API
|
|
class Performance : public DOMEventTargetHelper
|
|
{
|
|
public:
|
|
NS_DECL_ISUPPORTS_INHERITED
|
|
NS_DECL_CYCLE_COLLECTION_CLASS_INHERITED(Performance,
|
|
DOMEventTargetHelper)
|
|
|
|
static bool IsObserverEnabled(JSContext* aCx, JSObject* aGlobal);
|
|
|
|
static already_AddRefed<Performance>
|
|
CreateForMainThread(nsPIDOMWindowInner* aWindow,
|
|
nsIPrincipal* aPrincipal,
|
|
nsDOMNavigationTiming* aDOMTiming,
|
|
nsITimedChannel* aChannel);
|
|
|
|
static already_AddRefed<Performance>
|
|
CreateForWorker(WorkerPrivate* aWorkerPrivate);
|
|
|
|
JSObject* WrapObject(JSContext *cx,
|
|
JS::Handle<JSObject*> aGivenProto) override;
|
|
|
|
virtual void GetEntries(nsTArray<RefPtr<PerformanceEntry>>& aRetval);
|
|
|
|
virtual void GetEntriesByType(const nsAString& aEntryType,
|
|
nsTArray<RefPtr<PerformanceEntry>>& aRetval);
|
|
|
|
virtual void GetEntriesByName(const nsAString& aName,
|
|
const Optional<nsAString>& aEntryType,
|
|
nsTArray<RefPtr<PerformanceEntry>>& aRetval);
|
|
|
|
virtual PerformanceStorage* AsPerformanceStorage() = 0;
|
|
|
|
void ClearResourceTimings();
|
|
|
|
DOMHighResTimeStamp Now();
|
|
|
|
DOMHighResTimeStamp NowUnclamped() const;
|
|
|
|
DOMHighResTimeStamp TimeOrigin();
|
|
|
|
void Mark(const nsAString& aName, ErrorResult& aRv);
|
|
|
|
void ClearMarks(const Optional<nsAString>& aName);
|
|
|
|
void Measure(const nsAString& aName,
|
|
const Optional<nsAString>& aStartMark,
|
|
const Optional<nsAString>& aEndMark,
|
|
ErrorResult& aRv);
|
|
|
|
void ClearMeasures(const Optional<nsAString>& aName);
|
|
|
|
void SetResourceTimingBufferSize(uint64_t aMaxSize);
|
|
|
|
void AddObserver(PerformanceObserver* aObserver);
|
|
void RemoveObserver(PerformanceObserver* aObserver);
|
|
void NotifyObservers();
|
|
void CancelNotificationObservers();
|
|
|
|
virtual PerformanceTiming* Timing() = 0;
|
|
|
|
virtual PerformanceNavigation* Navigation() = 0;
|
|
|
|
IMPL_EVENT_HANDLER(resourcetimingbufferfull)
|
|
|
|
virtual void GetMozMemory(JSContext *aCx,
|
|
JS::MutableHandle<JSObject*> aObj) = 0;
|
|
|
|
virtual nsDOMNavigationTiming* GetDOMTiming() const = 0;
|
|
|
|
virtual nsITimedChannel* GetChannel() const = 0;
|
|
|
|
virtual TimeStamp CreationTimeStamp() const = 0;
|
|
|
|
uint64_t IsSystemPrincipal()
|
|
{
|
|
return mSystemPrincipal;
|
|
}
|
|
|
|
virtual uint64_t GetRandomTimelineSeed() = 0;
|
|
|
|
void MemoryPressure();
|
|
|
|
size_t SizeOfUserEntries(mozilla::MallocSizeOf aMallocSizeOf) const;
|
|
size_t SizeOfResourceEntries(mozilla::MallocSizeOf aMallocSizeOf) const;
|
|
|
|
void InsertResourceEntry(PerformanceEntry* aEntry);
|
|
|
|
protected:
|
|
Performance();
|
|
explicit Performance(nsPIDOMWindowInner* aWindow);
|
|
|
|
virtual ~Performance();
|
|
|
|
virtual void InsertUserEntry(PerformanceEntry* aEntry);
|
|
|
|
void ClearUserEntries(const Optional<nsAString>& aEntryName,
|
|
const nsAString& aEntryType);
|
|
|
|
DOMHighResTimeStamp ResolveTimestampFromName(const nsAString& aName,
|
|
ErrorResult& aRv);
|
|
|
|
virtual void DispatchBufferFullEvent() = 0;
|
|
|
|
virtual DOMHighResTimeStamp CreationTime() const = 0;
|
|
|
|
virtual bool IsPerformanceTimingAttribute(const nsAString& aName)
|
|
{
|
|
return false;
|
|
}
|
|
|
|
virtual DOMHighResTimeStamp
|
|
GetPerformanceTimingFromString(const nsAString& aTimingName)
|
|
{
|
|
return 0;
|
|
}
|
|
|
|
void LogEntry(PerformanceEntry* aEntry, const nsACString& aOwner) const;
|
|
void TimingNotification(PerformanceEntry* aEntry, const nsACString& aOwner,
|
|
uint64_t epoch);
|
|
|
|
void RunNotificationObserversTask();
|
|
void QueueEntry(PerformanceEntry* aEntry);
|
|
|
|
nsTObserverArray<PerformanceObserver*> mObservers;
|
|
|
|
protected:
|
|
static const uint64_t kDefaultResourceTimingBufferSize = 150;
|
|
|
|
// When kDefaultResourceTimingBufferSize is increased or removed, these should
|
|
// be changed to use SegmentedVector
|
|
AutoTArray<RefPtr<PerformanceEntry>, kDefaultResourceTimingBufferSize> mUserEntries;
|
|
AutoTArray<RefPtr<PerformanceEntry>, kDefaultResourceTimingBufferSize> mResourceEntries;
|
|
|
|
uint64_t mResourceTimingBufferSize;
|
|
bool mPendingNotificationObserversTask;
|
|
|
|
RefPtr<PerformanceService> mPerformanceService;
|
|
|
|
bool mSystemPrincipal;
|
|
};
|
|
|
|
} // namespace dom
|
|
} // namespace mozilla
|
|
|
|
#endif // mozilla_dom_Performance_h
|