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 "MarkingConstraint.h"
29#include <wtf/BitVector.h>
30#include <wtf/Vector.h>
31
32namespace JSC {
33
34class Heap;
35class MarkingConstraintSolver;
36
37class MarkingConstraintSet {
38 WTF_MAKE_FAST_ALLOCATED;
39 WTF_MAKE_NONCOPYABLE(MarkingConstraintSet);
40public:
41 MarkingConstraintSet(Heap&);
42 ~MarkingConstraintSet();
43
44 void didStartMarking();
45
46 void add(
47 CString abbreviatedName,
48 CString name,
49 ::Function<void(SlotVisitor&)>,
50 ConstraintVolatility,
51 ConstraintConcurrency = ConstraintConcurrency::Concurrent,
52 ConstraintParallelism = ConstraintParallelism::Sequential);
53
54 void add(
55 CString abbreviatedName, CString name,
56 ::Function<void(SlotVisitor&)> func,
57 ConstraintVolatility volatility,
58 ConstraintParallelism parallelism)
59 {
60 add(abbreviatedName, name, WTFMove(func), volatility, ConstraintConcurrency::Concurrent, parallelism);
61 }
62
63 void add(std::unique_ptr<MarkingConstraint>);
64
65 // Assuming that the mark stacks are all empty, this will give you a guess as to whether or
66 // not the wavefront is advancing.
67 bool isWavefrontAdvancing(SlotVisitor&);
68 bool isWavefrontRetreating(SlotVisitor& visitor) { return !isWavefrontAdvancing(visitor); }
69
70 // Returns true if this executed all constraints and none of them produced new work. This
71 // assumes that you've alraedy visited roots and drained from there.
72 bool executeConvergence(SlotVisitor&);
73
74 // Simply runs all constraints without any shenanigans.
75 void executeAll(SlotVisitor&);
76
77private:
78 friend class MarkingConstraintSolver;
79
80 bool executeConvergenceImpl(SlotVisitor&);
81
82 Heap& m_heap;
83 BitVector m_unexecutedRoots;
84 BitVector m_unexecutedOutgrowths;
85 Vector<std::unique_ptr<MarkingConstraint>> m_set;
86 Vector<MarkingConstraint*> m_ordered;
87 Vector<MarkingConstraint*> m_outgrowths;
88 unsigned m_iteration { 1 };
89};
90
91} // namespace JSC
92
93