8f446a5528bd9690951eb6a887a684850a027c82
[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/CurrentTime.h>
31 #include <wtf/RefPtr.h>
32
33 #if PLATFORM(IOS)
34 #include "WebCoreThread.h"
35 #endif
36
37 namespace WebCore {
38
39 class Document;
40 class HTMLDocumentParser;
41
42 class ActiveParserSession {
43 public:
44     explicit ActiveParserSession(Document*);
45     ~ActiveParserSession();
46
47 private:
48     RefPtr<Document> m_document;
49 };
50
51 class PumpSession : public NestingLevelIncrementer, public ActiveParserSession {
52 public:
53     PumpSession(unsigned& nestingLevel, Document*);
54     ~PumpSession();
55
56     unsigned processedTokens;
57     MonotonicTime startTime;
58     bool didSeeScript;
59 };
60
61 class HTMLParserScheduler {
62     WTF_MAKE_NONCOPYABLE(HTMLParserScheduler); WTF_MAKE_FAST_ALLOCATED;
63 public:
64     explicit HTMLParserScheduler(HTMLDocumentParser&);
65     ~HTMLParserScheduler();
66
67     bool shouldYieldBeforeToken(PumpSession& session)
68     {
69 #if PLATFORM(IOS)
70         if (WebThreadShouldYield())
71             return true;
72 #endif
73         if (UNLIKELY(session.processedTokens > numberOfTokensBeforeCheckingForYield || session.didSeeScript))
74             return checkForYield(session);
75
76         ++session.processedTokens;
77         return false;
78     }
79     bool shouldYieldBeforeExecutingScript(PumpSession&);
80
81     void scheduleForResume();
82     bool isScheduledForResume() const { return m_isSuspendedWithActiveTimer || m_continueNextChunkTimer.isActive(); }
83
84     void suspend();
85     void resume();
86
87 private:
88     static const unsigned numberOfTokensBeforeCheckingForYield = 4096; // Performance optimization
89
90     void continueNextChunkTimerFired();
91
92     bool checkForYield(PumpSession& session)
93     {
94         session.processedTokens = 1;
95         session.didSeeScript = false;
96
97         // MonotonicTime::now() can be expensive. By delaying, we avoided calling
98         // MonotonicTime::now() when constructing non-yielding PumpSessions.
99         if (!session.startTime) {
100             session.startTime = MonotonicTime::now();
101             return false;
102         }
103
104         Seconds elapsedTime = MonotonicTime::now() - session.startTime;
105         return elapsedTime > m_parserTimeLimit;
106     }
107
108     HTMLDocumentParser& m_parser;
109
110     Seconds m_parserTimeLimit;
111     Timer m_continueNextChunkTimer;
112     bool m_isSuspendedWithActiveTimer;
113 #if !ASSERT_DISABLED
114     bool m_suspended;
115 #endif
116 };
117
118 } // namespace WebCore