GC constraint solving should be parallel
[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 "ConstraintConcurrency.h"
29 #include "ConstraintParallelism.h"
30 #include "ConstraintVolatility.h"
31 #include <limits.h>
32 #include <wtf/FastMalloc.h>
33 #include <wtf/Lock.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, ConstraintVolatility,
48         ConstraintConcurrency = ConstraintConcurrency::Concurrent,
49         ConstraintParallelism = ConstraintParallelism::Sequential);
50     
51     JS_EXPORT_PRIVATE virtual ~MarkingConstraint();
52     
53     unsigned index() const { return m_index; }
54     
55     const char* abbreviatedName() const { return m_abbreviatedName.data(); }
56     const char* name() const { return m_name.data(); }
57     
58     void resetStats();
59     
60     size_t lastVisitCount() const { return m_lastVisitCount; }
61     
62     ConstraintParallelism execute(SlotVisitor&);
63     
64     JS_EXPORT_PRIVATE virtual double quickWorkEstimate(SlotVisitor& visitor);
65     
66     double workEstimate(SlotVisitor& visitor);
67     
68     void prepareToExecute(const AbstractLocker& constraintSolvingLocker, SlotVisitor&);
69     
70     void doParallelWork(SlotVisitor&);
71     void finishParallelWork(SlotVisitor&);
72     
73     ConstraintVolatility volatility() const { return m_volatility; }
74     
75     ConstraintConcurrency concurrency() const { return m_concurrency; }
76     ConstraintParallelism parallelism() const { return m_parallelism; }
77
78 protected:
79     virtual ConstraintParallelism executeImpl(SlotVisitor&) = 0;
80     JS_EXPORT_PRIVATE virtual void prepareToExecuteImpl(const AbstractLocker& constraintSolvingLocker, SlotVisitor&);
81     virtual void doParallelWorkImpl(SlotVisitor&);
82     virtual void finishParallelWorkImpl(SlotVisitor&);
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     ConstraintVolatility m_volatility;
91     ConstraintConcurrency m_concurrency;
92     ConstraintParallelism m_parallelism;
93     size_t m_lastVisitCount { 0 };
94     Lock m_lock;
95 };
96
97 } // namespace JSC
98