Remove excessive headers from JavaScriptCore
[WebKit-https.git] / Source / JavaScriptCore / heap / MarkingConstraint.h
1 /*
2  * Copyright (C) 2017 Apple 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. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #pragma once
27
28 #include "ConstraintVolatility.h"
29 #include "VisitingTimeout.h"
30 #include <limits.h>
31 #include <wtf/FastMalloc.h>
32 #include <wtf/Function.h>
33 #include <wtf/MonotonicTime.h>
34 #include <wtf/Noncopyable.h>
35 #include <wtf/text/CString.h>
36
37 namespace JSC {
38
39 class MarkingConstraintSet;
40 class SlotVisitor;
41
42 class MarkingConstraint {
43     WTF_MAKE_NONCOPYABLE(MarkingConstraint);
44     WTF_MAKE_FAST_ALLOCATED;
45 public:
46     JS_EXPORT_PRIVATE MarkingConstraint(
47         CString abbreviatedName, CString name,
48         ::Function<void(SlotVisitor&, const VisitingTimeout&)>,
49         ConstraintVolatility);
50     
51     JS_EXPORT_PRIVATE MarkingConstraint(
52         CString abbreviatedName, CString name,
53         ::Function<void(SlotVisitor&, const VisitingTimeout&)>,
54         ::Function<double(SlotVisitor&)>,
55         ConstraintVolatility);
56     
57     JS_EXPORT_PRIVATE ~MarkingConstraint();
58     
59     unsigned index() const { return m_index; }
60     
61     const char* abbreviatedName() const { return m_abbreviatedName.data(); }
62     const char* name() const { return m_name.data(); }
63     
64     void resetStats();
65     
66     size_t lastVisitCount() const { return m_lastVisitCount; }
67     
68     void execute(SlotVisitor&, bool& didVisitSomething, MonotonicTime timeout);
69     
70     double quickWorkEstimate(SlotVisitor& visitor)
71     {
72         if (!m_quickWorkEstimateFunction)
73             return 0;
74         return m_quickWorkEstimateFunction(visitor);
75     }
76     
77     double workEstimate(SlotVisitor& visitor)
78     {
79         return lastVisitCount() + quickWorkEstimate(visitor);
80     }
81     
82     ConstraintVolatility volatility() const { return m_volatility; }
83     
84 private:
85     friend class MarkingConstraintSet; // So it can set m_index.
86     
87     unsigned m_index { UINT_MAX };
88     CString m_abbreviatedName;
89     CString m_name;
90     ::Function<void(SlotVisitor&, const VisitingTimeout& timeout)> m_executeFunction;
91     ::Function<double(SlotVisitor&)> m_quickWorkEstimateFunction;
92     ConstraintVolatility m_volatility;
93     size_t m_lastVisitCount { 0 };
94 };
95
96 } // namespace JSC
97