05fcc6e08d5ed4a840c9954fb42349a8891e4b8e
[WebKit-https.git] / Source / WebCore / page / PerformanceTiming.cpp
1 /*
2  * Copyright (C) 2010 Google Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are
6  * met:
7  *
8  *     * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *     * Redistributions in binary form must reproduce the above
11  * copyright notice, this list of conditions and the following disclaimer
12  * in the documentation and/or other materials provided with the
13  * distribution.
14  *     * Neither the name of Google Inc. nor the names of its
15  * contributors may be used to endorse or promote products derived from
16  * this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30
31 #include "config.h"
32 #include "PerformanceTiming.h"
33
34 #include "Document.h"
35 #include "DocumentLoader.h"
36 #include "DocumentTiming.h"
37 #include "Frame.h"
38 #include "FrameLoader.h"
39 #include "LoadTiming.h"
40 #include "NetworkLoadMetrics.h"
41 #include "Performance.h"
42 #include "ResourceResponse.h"
43 #include <wtf/CurrentTime.h>
44
45 namespace WebCore {
46
47 PerformanceTiming::PerformanceTiming(Frame* frame)
48     : DOMWindowProperty(frame)
49 {
50 }
51
52 unsigned long long PerformanceTiming::navigationStart() const
53 {
54     LoadTiming* timing = loadTiming();
55     if (!timing)
56         return 0;
57
58     return monotonicTimeToIntegerMilliseconds(timing->startTime());
59 }
60
61 unsigned long long PerformanceTiming::unloadEventStart() const
62 {
63     LoadTiming* timing = loadTiming();
64     if (!timing)
65         return 0;
66
67     if (timing->hasCrossOriginRedirect() || !timing->hasSameOriginAsPreviousDocument())
68         return 0;
69
70     return monotonicTimeToIntegerMilliseconds(timing->unloadEventStart());
71 }
72
73 unsigned long long PerformanceTiming::unloadEventEnd() const
74 {
75     LoadTiming* timing = loadTiming();
76     if (!timing)
77         return 0;
78
79     if (timing->hasCrossOriginRedirect() || !timing->hasSameOriginAsPreviousDocument())
80         return 0;
81
82     return monotonicTimeToIntegerMilliseconds(timing->unloadEventEnd());
83 }
84
85 unsigned long long PerformanceTiming::redirectStart() const
86 {
87     LoadTiming* timing = loadTiming();
88     if (!timing)
89         return 0;
90
91     if (timing->hasCrossOriginRedirect())
92         return 0;
93
94     return monotonicTimeToIntegerMilliseconds(timing->redirectStart());
95 }
96
97 unsigned long long PerformanceTiming::redirectEnd() const
98 {
99     LoadTiming* timing = loadTiming();
100     if (!timing)
101         return 0;
102
103     if (timing->hasCrossOriginRedirect())
104         return 0;
105
106     return monotonicTimeToIntegerMilliseconds(timing->redirectEnd());
107 }
108
109 unsigned long long PerformanceTiming::fetchStart() const
110 {
111     LoadTiming* timing = loadTiming();
112     if (!timing)
113         return 0;
114
115     return monotonicTimeToIntegerMilliseconds(timing->fetchStart());
116 }
117
118 unsigned long long PerformanceTiming::domainLookupStart() const
119 {
120     DocumentLoader* loader = documentLoader();
121     if (!loader)
122         return fetchStart();
123     
124     const NetworkLoadMetrics& timing = loader->response().deprecatedNetworkLoadMetrics();
125     
126     // This will be -1 when a DNS request is not performed.
127     // Rather than exposing a special value that indicates no DNS, we "backfill" with fetchStart.
128     if (timing.domainLookupStart < 0_ms)
129         return fetchStart();
130
131     return resourceLoadTimeRelativeToFetchStart(timing.domainLookupStart);
132 }
133
134 unsigned long long PerformanceTiming::domainLookupEnd() const
135 {
136     DocumentLoader* loader = documentLoader();
137     if (!loader)
138         return domainLookupStart();
139     
140     const NetworkLoadMetrics& timing = loader->response().deprecatedNetworkLoadMetrics();
141     
142     // This will be -1 when a DNS request is not performed.
143     // Rather than exposing a special value that indicates no DNS, we "backfill" with domainLookupStart.
144     if (timing.domainLookupEnd < 0_ms)
145         return domainLookupStart();
146
147     return resourceLoadTimeRelativeToFetchStart(timing.domainLookupEnd);
148 }
149
150 unsigned long long PerformanceTiming::connectStart() const
151 {
152     DocumentLoader* loader = documentLoader();
153     if (!loader)
154         return domainLookupEnd();
155
156     const NetworkLoadMetrics& timing = loader->response().deprecatedNetworkLoadMetrics();
157     
158     // connectStart will be -1 when a network request is not made.
159     // Rather than exposing a special value that indicates no new connection, we "backfill" with domainLookupEnd.
160     Seconds connectStart = timing.connectStart;
161     if (connectStart < 0_ms)
162         return domainLookupEnd();
163
164     // NetworkLoadMetrics's connect phase includes DNS, however Navigation Timing's
165     // connect phase should not. So if there is DNS time, trim it from the start.
166     if (timing.domainLookupEnd >= 0_ms && timing.domainLookupEnd > connectStart)
167         connectStart = timing.domainLookupEnd;
168
169     return resourceLoadTimeRelativeToFetchStart(connectStart);
170 }
171
172 unsigned long long PerformanceTiming::connectEnd() const
173 {
174     DocumentLoader* loader = documentLoader();
175     if (!loader)
176         return connectStart();
177
178     const NetworkLoadMetrics& timing = loader->response().deprecatedNetworkLoadMetrics();
179     
180     // connectEnd will be -1 when a network request is not made.
181     // Rather than exposing a special value that indicates no new connection, we "backfill" with connectStart.
182     if (timing.connectEnd < 0_ms)
183         return connectStart();
184
185     return resourceLoadTimeRelativeToFetchStart(timing.connectEnd);
186 }
187
188 unsigned long long PerformanceTiming::secureConnectionStart() const
189 {
190     DocumentLoader* loader = documentLoader();
191     if (!loader)
192         return 0;
193
194     const NetworkLoadMetrics& timing = loader->response().deprecatedNetworkLoadMetrics();
195     
196     if (timing.secureConnectionStart < 0_ms)
197         return 0;
198
199     return resourceLoadTimeRelativeToFetchStart(timing.secureConnectionStart);
200 }
201
202 unsigned long long PerformanceTiming::requestStart() const
203 {
204     DocumentLoader* loader = documentLoader();
205     if (!loader)
206         return connectEnd();
207     
208     const NetworkLoadMetrics& timing = loader->response().deprecatedNetworkLoadMetrics();
209     
210     ASSERT(timing.requestStart >= 0_ms);
211     return resourceLoadTimeRelativeToFetchStart(timing.requestStart);
212 }
213
214 unsigned long long PerformanceTiming::responseStart() const
215 {
216     DocumentLoader* loader = documentLoader();
217     if (!loader)
218         return requestStart();
219
220     const NetworkLoadMetrics& timing = loader->response().deprecatedNetworkLoadMetrics();
221     
222     ASSERT(timing.responseStart >= 0_ms);
223     return resourceLoadTimeRelativeToFetchStart(timing.responseStart);
224 }
225
226 unsigned long long PerformanceTiming::responseEnd() const
227 {
228     LoadTiming* timing = loadTiming();
229     if (!timing)
230         return 0;
231
232     return monotonicTimeToIntegerMilliseconds(timing->responseEnd());
233 }
234
235 unsigned long long PerformanceTiming::domLoading() const
236 {
237     const DocumentTiming* timing = documentTiming();
238     if (!timing)
239         return fetchStart();
240
241     return monotonicTimeToIntegerMilliseconds(timing->domLoading);
242 }
243
244 unsigned long long PerformanceTiming::domInteractive() const
245 {
246     const DocumentTiming* timing = documentTiming();
247     if (!timing)
248         return 0;
249
250     return monotonicTimeToIntegerMilliseconds(timing->domInteractive);
251 }
252
253 unsigned long long PerformanceTiming::domContentLoadedEventStart() const
254 {
255     const DocumentTiming* timing = documentTiming();
256     if (!timing)
257         return 0;
258
259     return monotonicTimeToIntegerMilliseconds(timing->domContentLoadedEventStart);
260 }
261
262 unsigned long long PerformanceTiming::domContentLoadedEventEnd() const
263 {
264     const DocumentTiming* timing = documentTiming();
265     if (!timing)
266         return 0;
267
268     return monotonicTimeToIntegerMilliseconds(timing->domContentLoadedEventEnd);
269 }
270
271 unsigned long long PerformanceTiming::domComplete() const
272 {
273     const DocumentTiming* timing = documentTiming();
274     if (!timing)
275         return 0;
276
277     return monotonicTimeToIntegerMilliseconds(timing->domComplete);
278 }
279
280 unsigned long long PerformanceTiming::loadEventStart() const
281 {
282     LoadTiming* timing = loadTiming();
283     if (!timing)
284         return 0;
285
286     return monotonicTimeToIntegerMilliseconds(timing->loadEventStart());
287 }
288
289 unsigned long long PerformanceTiming::loadEventEnd() const
290 {
291     LoadTiming* timing = loadTiming();
292     if (!timing)
293         return 0;
294
295     return monotonicTimeToIntegerMilliseconds(timing->loadEventEnd());
296 }
297
298 DocumentLoader* PerformanceTiming::documentLoader() const
299 {
300     if (!m_frame)
301         return nullptr;
302
303     return m_frame->loader().documentLoader();
304 }
305
306 const DocumentTiming* PerformanceTiming::documentTiming() const
307 {
308     if (!m_frame)
309         return nullptr;
310
311     Document* document = m_frame->document();
312     if (!document)
313         return nullptr;
314
315     return &document->timing();
316 }
317
318 LoadTiming* PerformanceTiming::loadTiming() const
319 {
320     DocumentLoader* loader = documentLoader();
321     if (!loader)
322         return nullptr;
323
324     return &loader->timing();
325 }
326
327 unsigned long long PerformanceTiming::resourceLoadTimeRelativeToFetchStart(Seconds delta) const
328 {
329     ASSERT(delta >= 0_ms);
330
331     LoadTiming* timing = loadTiming();
332     if (!timing)
333         return 0;
334
335     WallTime fetchStart = timing->monotonicTimeToPseudoWallTime(timing->fetchStart());
336     WallTime combined = fetchStart + delta;
337     Seconds reduced = Performance::reduceTimeResolution(combined.secondsSinceEpoch());
338     return static_cast<unsigned long long>(reduced.milliseconds());
339 }
340
341 unsigned long long PerformanceTiming::monotonicTimeToIntegerMilliseconds(MonotonicTime timeStamp) const
342 {
343     ASSERT(timeStamp.secondsSinceEpoch().seconds() >= 0);
344
345     LoadTiming* timing = loadTiming();
346     if (!timing)
347         return 0;
348
349     WallTime wallTime = timing->monotonicTimeToPseudoWallTime(timeStamp);
350     Seconds reduced = Performance::reduceTimeResolution(wallTime.secondsSinceEpoch());
351     return static_cast<unsigned long long>(reduced.milliseconds());
352 }
353
354 } // namespace WebCore