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/SharedTask.h>
36#include <wtf/text/CString.h>
37
38namespace JSC {
39
40class MarkingConstraintSet;
41class SlotVisitor;
42
43class MarkingConstraint {
44 WTF_MAKE_NONCOPYABLE(MarkingConstraint);
45 WTF_MAKE_FAST_ALLOCATED;
46public:
47 JS_EXPORT_PRIVATE MarkingConstraint(
48 CString abbreviatedName, CString name, ConstraintVolatility,
49 ConstraintConcurrency = ConstraintConcurrency::Concurrent,
50 ConstraintParallelism = ConstraintParallelism::Sequential);
51
52 JS_EXPORT_PRIVATE virtual ~MarkingConstraint();
53
54 unsigned index() const { return m_index; }
55
56 const char* abbreviatedName() const { return m_abbreviatedName.data(); }
57 const char* name() const { return m_name.data(); }
58
59 void resetStats();
60
61 size_t lastVisitCount() const { return m_lastVisitCount; }
62
63 void execute(SlotVisitor&);
64
65 JS_EXPORT_PRIVATE virtual double quickWorkEstimate(SlotVisitor& visitor);
66
67 double workEstimate(SlotVisitor& visitor);
68
69 void prepareToExecute(const AbstractLocker& constraintSolvingLocker, SlotVisitor&);
70
71 void doParallelWork(SlotVisitor&, SharedTask<void(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
78protected:
79 virtual void executeImpl(SlotVisitor&) = 0;
80 JS_EXPORT_PRIVATE virtual void prepareToExecuteImpl(const AbstractLocker& constraintSolvingLocker, SlotVisitor&);
81
82private:
83 friend class MarkingConstraintSet; // So it can set m_index.
84
85 CString m_abbreviatedName;
86 CString m_name;
87 size_t m_lastVisitCount { 0 };
88 unsigned m_index { UINT_MAX };
89 ConstraintVolatility m_volatility;
90 ConstraintConcurrency m_concurrency;
91 ConstraintParallelism m_parallelism;
92 Lock m_lock;
93};
94
95} // namespace JSC
96
97