GC constraint solving should be parallel
[WebKit-https.git] / Source / JavaScriptCore / heap / MarkingConstraintSolver.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 "VisitCounter.h"
29 #include <wtf/BitVector.h>
30 #include <wtf/Condition.h>
31 #include <wtf/Deque.h>
32 #include <wtf/FastMalloc.h>
33 #include <wtf/Lock.h>
34 #include <wtf/Noncopyable.h>
35 #include <wtf/ScopedLambda.h>
36 #include <wtf/Vector.h>
37
38 namespace JSC {
39
40 class Heap;
41 class MarkingConstraint;
42 class MarkingConstraintSet;
43
44 class MarkingConstraintSolver {
45     WTF_MAKE_NONCOPYABLE(MarkingConstraintSolver);
46     WTF_MAKE_FAST_ALLOCATED;
47     
48 public:
49     MarkingConstraintSolver(MarkingConstraintSet&);
50     ~MarkingConstraintSolver();
51     
52     bool didVisitSomething() const;
53     
54     enum SchedulerPreference {
55         ParallelWorkFirst,
56         NextConstraintFirst
57     };
58
59     void execute(SchedulerPreference, ScopedLambda<std::optional<unsigned>()> pickNext);
60     
61     void drain(BitVector& unexecuted);
62     
63     void converge(const Vector<MarkingConstraint*>& order);
64     
65     void execute(MarkingConstraint&);
66     
67 private:
68     void runExecutionThread(SlotVisitor&, SchedulerPreference, ScopedLambda<std::optional<unsigned>()> pickNext);
69     
70     void didExecute(ConstraintParallelism, unsigned index);
71
72     Heap& m_heap;
73     SlotVisitor& m_mainVisitor;
74     MarkingConstraintSet& m_set;
75     BitVector m_executed;
76     Deque<unsigned, 32> m_toExecuteInParallel;
77     BitVector m_toExecuteInParallelSet;
78     Vector<unsigned, 32> m_didExecuteInParallel;
79     Vector<unsigned, 32> m_toExecuteSequentially;
80     Lock m_lock;
81     Condition m_condition;
82     unsigned m_numThreadsThatMayProduceWork { 0 };
83     bool m_pickNextIsStillActive { true };
84     Vector<VisitCounter, 16> m_visitCounters;
85 };
86
87 } // namespace JSC
88