4c57419dece62801edea2d490437f0a3dbce6c96
[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 <wtf/FastMalloc.h>
31 #include <wtf/Function.h>
32 #include <wtf/MonotonicTime.h>
33 #include <wtf/Noncopyable.h>
34 #include <wtf/text/CString.h>
35
36 namespace JSC {
37
38 class MarkingConstraintSet;
39 class SlotVisitor;
40
41 class MarkingConstraint {
42     WTF_MAKE_NONCOPYABLE(MarkingConstraint);
43     WTF_MAKE_FAST_ALLOCATED;
44 public:
45     JS_EXPORT_PRIVATE MarkingConstraint(
46         CString abbreviatedName, CString name,
47         ::Function<void(SlotVisitor&, const VisitingTimeout&)>,
48         ConstraintVolatility);
49     
50     JS_EXPORT_PRIVATE MarkingConstraint(
51         CString abbreviatedName, CString name,
52         ::Function<void(SlotVisitor&, const VisitingTimeout&)>,
53         ::Function<double(SlotVisitor&)>,
54         ConstraintVolatility);
55     
56     JS_EXPORT_PRIVATE ~MarkingConstraint();
57     
58     unsigned index() const { return m_index; }
59     
60     const char* abbreviatedName() const { return m_abbreviatedName.data(); }
61     const char* name() const { return m_name.data(); }
62     
63     void resetStats();
64     
65     size_t lastVisitCount() const { return m_lastVisitCount; }
66     
67     void execute(SlotVisitor&, bool& didVisitSomething, MonotonicTime timeout);
68     
69     double quickWorkEstimate(SlotVisitor& visitor)
70     {
71         if (!m_quickWorkEstimateFunction)
72             return 0;
73         return m_quickWorkEstimateFunction(visitor);
74     }
75     
76     double workEstimate(SlotVisitor& visitor)
77     {
78         return lastVisitCount() + quickWorkEstimate(visitor);
79     }
80     
81     ConstraintVolatility volatility() const { return m_volatility; }
82     
83 private:
84     friend class MarkingConstraintSet; // So it can set m_index.
85     
86     unsigned m_index { UINT_MAX };
87     CString m_abbreviatedName;
88     CString m_name;
89     ::Function<void(SlotVisitor&, const VisitingTimeout& timeout)> m_executeFunction;
90     ::Function<double(SlotVisitor&)> m_quickWorkEstimateFunction;
91     ConstraintVolatility m_volatility;
92     size_t m_lastVisitCount { 0 };
93 };
94
95 } // namespace JSC
96