32cbaaf2698d1fa2066ee1f491c6fa512db490f2
[WebKit-https.git] / Source / JavaScriptCore / runtime / VMTraps.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. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #pragma once
27
28 #include <wtf/Lock.h>
29 #include <wtf/Locker.h>
30
31 namespace JSC {
32
33 class VM;
34
35 class VMTraps {
36 public:
37     enum EventType {
38         // Sorted in servicing priority order from highest to lowest.
39         NeedTermination,
40         NeedWatchdogCheck,
41         NumberOfEventTypes, // This entry must be last in this list.
42         Invalid
43     };
44
45     bool needTrapHandling() { return m_needTrapHandling; }
46     void* needTrapHandlingAddress() { return &m_needTrapHandling; }
47
48     JS_EXPORT_PRIVATE void fireTrap(EventType);
49
50     bool takeTrap(EventType);
51     EventType takeTopPriorityTrap();
52
53 private:
54     VM& vm() const;
55
56     bool hasTrapForEvent(Locker<Lock>&, EventType eventType)
57     {
58         ASSERT(eventType < NumberOfEventTypes);
59         return (m_trapsBitField & (1 << eventType));
60     }
61     void setTrapForEvent(Locker<Lock>&, EventType eventType)
62     {
63         ASSERT(eventType < NumberOfEventTypes);
64         m_trapsBitField |= (1 << eventType);
65     }
66     void clearTrapForEvent(Locker<Lock>&, EventType eventType)
67     {
68         ASSERT(eventType < NumberOfEventTypes);
69         m_trapsBitField &= ~(1 << eventType);
70     }
71
72     Lock m_lock;
73     union {
74         uint8_t m_needTrapHandling { false };
75         uint8_t m_trapsBitField;
76     };
77
78     friend class LLIntOffsetsExtractor;
79 };
80
81 } // namespace JSC