[WTF] Move currentCPUTime and sleep(Seconds) to CPUTime.h and Seconds.h respectively
[WebKit-https.git] / Source / WebCore / html / parser / HTMLParserScheduler.h
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
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #pragma once
27
28 #include "NestingLevelIncrementer.h"
29 #include "Timer.h"
30 #include <wtf/RefPtr.h>
31
32 #if PLATFORM(IOS)
33 #include "WebCoreThread.h"
34 #endif
35
36 namespace WebCore {
37
38 class Document;
39 class HTMLDocumentParser;
40
41 class ActiveParserSession {
42 public:
43     explicit ActiveParserSession(Document*);
44     ~ActiveParserSession();
45
46 private:
47     RefPtr<Document> m_document;
48 };
49
50 class PumpSession : public NestingLevelIncrementer, public ActiveParserSession {
51 public:
52     PumpSession(unsigned& nestingLevel, Document*);
53     ~PumpSession();
54
55     unsigned processedTokens;
56     MonotonicTime startTime;
57     bool didSeeScript;
58 };
59
60 class HTMLParserScheduler {
61     WTF_MAKE_NONCOPYABLE(HTMLParserScheduler); WTF_MAKE_FAST_ALLOCATED;
62 public:
63     explicit HTMLParserScheduler(HTMLDocumentParser&);
64     ~HTMLParserScheduler();
65
66     bool shouldYieldBeforeToken(PumpSession& session)
67     {
68 #if PLATFORM(IOS)
69         if (WebThreadShouldYield())
70             return true;
71 #endif
72         if (UNLIKELY(session.processedTokens > numberOfTokensBeforeCheckingForYield || session.didSeeScript))
73             return checkForYield(session);
74
75         ++session.processedTokens;
76         return false;
77     }
78     bool shouldYieldBeforeExecutingScript(PumpSession&);
79
80     void scheduleForResume();
81     bool isScheduledForResume() const { return m_isSuspendedWithActiveTimer || m_continueNextChunkTimer.isActive(); }
82
83     void suspend();
84     void resume();
85
86 private:
87     static const unsigned numberOfTokensBeforeCheckingForYield = 4096; // Performance optimization
88
89     void continueNextChunkTimerFired();
90
91     bool checkForYield(PumpSession& session)
92     {
93         session.processedTokens = 1;
94         session.didSeeScript = false;
95
96         // MonotonicTime::now() can be expensive. By delaying, we avoided calling
97         // MonotonicTime::now() when constructing non-yielding PumpSessions.
98         if (!session.startTime) {
99             session.startTime = MonotonicTime::now();
100             return false;
101         }
102
103         Seconds elapsedTime = MonotonicTime::now() - session.startTime;
104         return elapsedTime > m_parserTimeLimit;
105     }
106
107     HTMLDocumentParser& m_parser;
108
109     Seconds m_parserTimeLimit;
110     Timer m_continueNextChunkTimer;
111     bool m_isSuspendedWithActiveTimer;
112 #if !ASSERT_DISABLED
113     bool m_suspended;
114 #endif
115 };
116
117 } // namespace WebCore