diff -r 000000000000 -r 6474c204b198 dom/base/nsPerformance.h --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/dom/base/nsPerformance.h Wed Dec 31 06:09:35 2014 +0100 @@ -0,0 +1,352 @@ +/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */ +/* 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 nsPerformance_h___ +#define nsPerformance_h___ + +#include "nsCOMPtr.h" +#include "nsAutoPtr.h" +#include "mozilla/Attributes.h" +#include "nsWrapperCache.h" +#include "nsDOMNavigationTiming.h" +#include "nsContentUtils.h" +#include "nsIDOMWindow.h" +#include "js/TypeDecls.h" +#include "mozilla/dom/BindingDeclarations.h" + +class nsITimedChannel; +class nsPerformance; +class nsIHttpChannel; + +namespace mozilla { +namespace dom { + class PerformanceEntry; +} +} + +// Script "performance.timing" object +class nsPerformanceTiming MOZ_FINAL : public nsWrapperCache +{ +public: + typedef mozilla::TimeStamp TimeStamp; + +/** + * @param aPerformance + * The performance object (the JS parent). + * This will allow access to "window.performance.timing" attribute for + * the navigation timing (can't be null). + * @param aChannel + * An nsITimedChannel used to gather all the networking timings by both + * the navigation timing and the resource timing (can't be null). + * @param aHttpChannel + * An nsIHttpChannel (the resource's http channel). + * This will be used by the resource timing cross-domain check + * algorithm. + * Argument is null for the navigation timing (navigation timing uses + * another algorithm for the cross-domain redirects). + * @param aZeroTime + * The offset that will be added to the timestamp of each event. This + * argument should be equal to performance.navigationStart for + * navigation timing and "0" for the resource timing. + */ + nsPerformanceTiming(nsPerformance* aPerformance, + nsITimedChannel* aChannel, + nsIHttpChannel* aHttpChannel, + DOMHighResTimeStamp aZeroTime); + NS_INLINE_DECL_CYCLE_COLLECTING_NATIVE_REFCOUNTING(nsPerformanceTiming) + NS_DECL_CYCLE_COLLECTION_SCRIPT_HOLDER_NATIVE_CLASS(nsPerformanceTiming) + + nsDOMNavigationTiming* GetDOMTiming() const; + + nsPerformance* GetParentObject() const + { + return mPerformance; + } + + /** + * @param aStamp + * The TimeStamp recorded for a specific event. This TimeStamp can + * be null. + * @return the duration of an event with a given TimeStamp, relative to the + * navigationStart TimeStamp (the moment the user landed on the + * page), if the given TimeStamp is valid. Otherwise, it will return + * the FetchStart timing value. + */ + inline DOMHighResTimeStamp TimeStampToDOMHighResOrFetchStart(TimeStamp aStamp) + { + return (!aStamp.IsNull()) + ? TimeStampToDOMHighRes(aStamp) + : FetchStartHighRes(); + } + + /** + * The nsITimedChannel records an absolute timestamp for each event. + * The nsDOMNavigationTiming will record the moment when the user landed on + * the page. This is a window.performance unique timestamp, so it can be used + * for all the events (navigation timing and resource timing events). + * + * The algorithm operates in 2 steps: + * 1. The first step is to subtract the two timestamps: the argument (the + * envet's timesramp) and the navigation start timestamp. This will result in + * a relative timestamp of the event (relative to the navigation start - + * window.performance.timing.navigationStart). + * 2. The second step is to add any required offset (the mZeroTime). For now, + * this offset value is either 0 (for the resource timing), or equal to + * "performance.navigationStart" (for navigation timing). + * For the resource timing, mZeroTime is set to 0, causing the result to be a + * relative time. + * For the navigation timing, mZeroTime is set to "performance.navigationStart" + * causing the result be an absolute time. + * + * @param aStamp + * The TimeStamp recorded for a specific event. This TimeStamp can't + * be null. + * @return number of milliseconds value as one of: + * - relative to the navigation start time, time the user has landed on the + * page + * - an absolute wall clock time since the unix epoch + */ + inline DOMHighResTimeStamp TimeStampToDOMHighRes(TimeStamp aStamp) const + { + MOZ_ASSERT(!aStamp.IsNull()); + mozilla::TimeDuration duration = + aStamp - GetDOMTiming()->GetNavigationStartTimeStamp(); + return duration.ToMilliseconds() + mZeroTime; + } + + virtual JSObject* WrapObject(JSContext *cx) MOZ_OVERRIDE; + + // PerformanceNavigation WebIDL methods + DOMTimeMilliSec NavigationStart() const { + if (!nsContentUtils::IsPerformanceTimingEnabled()) { + return 0; + } + return GetDOMTiming()->GetNavigationStart(); + } + DOMTimeMilliSec UnloadEventStart() { + if (!nsContentUtils::IsPerformanceTimingEnabled()) { + return 0; + } + return GetDOMTiming()->GetUnloadEventStart(); + } + DOMTimeMilliSec UnloadEventEnd() { + if (!nsContentUtils::IsPerformanceTimingEnabled()) { + return 0; + } + return GetDOMTiming()->GetUnloadEventEnd(); + } + + uint16_t GetRedirectCount() const; + bool IsSameOriginAsReferral() const; + void CheckRedirectCrossOrigin(nsIHttpChannel* aResourceChannel); + + // High resolution (used by resource timing) + DOMHighResTimeStamp FetchStartHighRes(); + DOMHighResTimeStamp RedirectStartHighRes(); + DOMHighResTimeStamp RedirectEndHighRes(); + DOMHighResTimeStamp DomainLookupStartHighRes(); + DOMHighResTimeStamp DomainLookupEndHighRes(); + DOMHighResTimeStamp ConnectStartHighRes(); + DOMHighResTimeStamp ConnectEndHighRes(); + DOMHighResTimeStamp RequestStartHighRes(); + DOMHighResTimeStamp ResponseStartHighRes(); + DOMHighResTimeStamp ResponseEndHighRes(); + + // Low resolution (used by navigation timing) + DOMTimeMilliSec FetchStart(); + DOMTimeMilliSec RedirectStart(); + DOMTimeMilliSec RedirectEnd(); + DOMTimeMilliSec DomainLookupStart(); + DOMTimeMilliSec DomainLookupEnd(); + DOMTimeMilliSec ConnectStart(); + DOMTimeMilliSec ConnectEnd(); + DOMTimeMilliSec RequestStart(); + DOMTimeMilliSec ResponseStart(); + DOMTimeMilliSec ResponseEnd(); + + DOMTimeMilliSec DomLoading() { + if (!nsContentUtils::IsPerformanceTimingEnabled()) { + return 0; + } + return GetDOMTiming()->GetDomLoading(); + } + DOMTimeMilliSec DomInteractive() const { + if (!nsContentUtils::IsPerformanceTimingEnabled()) { + return 0; + } + return GetDOMTiming()->GetDomInteractive(); + } + DOMTimeMilliSec DomContentLoadedEventStart() const { + if (!nsContentUtils::IsPerformanceTimingEnabled()) { + return 0; + } + return GetDOMTiming()->GetDomContentLoadedEventStart(); + } + DOMTimeMilliSec DomContentLoadedEventEnd() const { + if (!nsContentUtils::IsPerformanceTimingEnabled()) { + return 0; + } + return GetDOMTiming()->GetDomContentLoadedEventEnd(); + } + DOMTimeMilliSec DomComplete() const { + if (!nsContentUtils::IsPerformanceTimingEnabled()) { + return 0; + } + return GetDOMTiming()->GetDomComplete(); + } + DOMTimeMilliSec LoadEventStart() const { + if (!nsContentUtils::IsPerformanceTimingEnabled()) { + return 0; + } + return GetDOMTiming()->GetLoadEventStart(); + } + DOMTimeMilliSec LoadEventEnd() const { + if (!nsContentUtils::IsPerformanceTimingEnabled()) { + return 0; + } + return GetDOMTiming()->GetLoadEventEnd(); + } + +private: + ~nsPerformanceTiming(); + bool IsInitialized() const; + nsRefPtr mPerformance; + nsCOMPtr mChannel; + DOMHighResTimeStamp mFetchStart; + // This is an offset that will be added to each timing ([ms] resolution). + // There are only 2 possible values: (1) logicaly equal to navigationStart + // TimeStamp (results are absolute timstamps - wallclock); (2) "0" (results + // are relative to the navigation start). + DOMHighResTimeStamp mZeroTime; + bool mReportCrossOriginResources; +}; + +// Script "performance.navigation" object +class nsPerformanceNavigation MOZ_FINAL : public nsWrapperCache +{ +public: + explicit nsPerformanceNavigation(nsPerformance* aPerformance); + NS_INLINE_DECL_CYCLE_COLLECTING_NATIVE_REFCOUNTING(nsPerformanceNavigation) + NS_DECL_CYCLE_COLLECTION_SCRIPT_HOLDER_NATIVE_CLASS(nsPerformanceNavigation) + + nsDOMNavigationTiming* GetDOMTiming() const; + nsPerformanceTiming* GetPerformanceTiming() const; + + nsPerformance* GetParentObject() const + { + return mPerformance; + } + + virtual JSObject* WrapObject(JSContext *cx) MOZ_OVERRIDE; + + // PerformanceNavigation WebIDL methods + uint16_t Type() const { + return GetDOMTiming()->GetType(); + } + uint16_t RedirectCount() const { + return GetPerformanceTiming()->GetRedirectCount(); + } + +private: + ~nsPerformanceNavigation(); + nsRefPtr mPerformance; +}; + +// Script "performance" object +class nsPerformance MOZ_FINAL : public nsISupports, + public nsWrapperCache +{ +public: + typedef mozilla::dom::PerformanceEntry PerformanceEntry; + nsPerformance(nsIDOMWindow* aWindow, + nsDOMNavigationTiming* aDOMTiming, + nsITimedChannel* aChannel, + nsPerformance* aParentPerformance); + + NS_DECL_CYCLE_COLLECTING_ISUPPORTS + NS_DECL_CYCLE_COLLECTION_SCRIPT_HOLDER_CLASS(nsPerformance) + + nsDOMNavigationTiming* GetDOMTiming() const + { + return mDOMTiming; + } + + nsITimedChannel* GetChannel() const + { + return mChannel; + } + + nsPerformance* GetParentPerformance() const + { + return mParentPerformance; + } + + nsIDOMWindow* GetParentObject() const + { + return mWindow.get(); + } + + virtual JSObject* WrapObject(JSContext *cx) MOZ_OVERRIDE; + + // Performance WebIDL methods + DOMHighResTimeStamp Now(); + nsPerformanceTiming* Timing(); + nsPerformanceNavigation* Navigation(); + + void GetEntries(nsTArray >& retval); + void GetEntriesByType(const nsAString& entryType, + nsTArray >& retval); + void GetEntriesByName(const nsAString& name, + const mozilla::dom::Optional< nsAString >& entryType, + nsTArray >& retval); + void AddEntry(nsIHttpChannel* channel, + nsITimedChannel* timedChannel); + void ClearResourceTimings(); + void SetResourceTimingBufferSize(uint64_t maxSize); + +private: + ~nsPerformance(); + + nsCOMPtr mWindow; + nsRefPtr mDOMTiming; + nsCOMPtr mChannel; + nsRefPtr mTiming; + nsRefPtr mNavigation; + nsTArray > mEntries; + nsRefPtr mParentPerformance; + uint64_t mBufferSizeSet; + uint64_t mPrimaryBufferSize; + + static const uint64_t kDefaultBufferSize = 150; + + // Helper classes + class PerformanceEntryComparator { + public: + bool Equals(const PerformanceEntry* aElem1, + const PerformanceEntry* aElem2) const; + bool LessThan(const PerformanceEntry* aElem1, + const PerformanceEntry* aElem2) const; + }; +}; + +inline nsDOMNavigationTiming* +nsPerformanceNavigation::GetDOMTiming() const +{ + return mPerformance->GetDOMTiming(); +} + +inline nsPerformanceTiming* +nsPerformanceNavigation::GetPerformanceTiming() const +{ + return mPerformance->Timing(); +} + +inline nsDOMNavigationTiming* +nsPerformanceTiming::GetDOMTiming() const +{ + return mPerformance->GetDOMTiming(); +} + +#endif /* nsPerformance_h___ */ +