Add support for selective handling of VM traps.
[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     typedef uint8_t BitField;
37 public:
38     enum EventType {
39         // Sorted in servicing priority order from highest to lowest.
40         NeedDebuggerBreak,
41         NeedTermination,
42         NeedWatchdogCheck,
43         NumberOfEventTypes, // This entry must be last in this list.
44         Invalid
45     };
46
47     class Mask {
48     public:
49         enum AllEventTypes { AllEventTypesTag };
50         Mask(AllEventTypes)
51             : m_mask(std::numeric_limits<BitField>::max())
52         { }
53         static Mask allEventTypes() { return Mask(AllEventTypesTag); }
54
55         template<typename... Arguments>
56         Mask(Arguments... args)
57             : m_mask(0)
58         {
59             init(args...);
60         }
61
62         BitField bits() const { return m_mask; }
63
64     private:
65         template<typename... Arguments>
66         void init(EventType eventType, Arguments... args)
67         {
68             ASSERT(eventType < NumberOfEventTypes);
69             m_mask |= (1 << eventType);
70             init(args...);
71         }
72
73         void init() { }
74
75         BitField m_mask;
76     };
77
78     bool needTrapHandling(Mask mask) { return m_needTrapHandling & mask.bits(); }
79     void* needTrapHandlingAddress() { return &m_needTrapHandling; }
80
81     JS_EXPORT_PRIVATE void fireTrap(EventType);
82
83     EventType takeTopPriorityTrap(Mask);
84
85 private:
86     VM& vm() const;
87
88     bool hasTrapForEvent(Locker<Lock>&, EventType eventType, Mask mask)
89     {
90         ASSERT(eventType < NumberOfEventTypes);
91         return (m_trapsBitField & mask.bits() & (1 << eventType));
92     }
93     void setTrapForEvent(Locker<Lock>&, EventType eventType)
94     {
95         ASSERT(eventType < NumberOfEventTypes);
96         m_trapsBitField |= (1 << eventType);
97     }
98     void clearTrapForEvent(Locker<Lock>&, EventType eventType)
99     {
100         ASSERT(eventType < NumberOfEventTypes);
101         m_trapsBitField &= ~(1 << eventType);
102     }
103
104     Lock m_lock;
105     union {
106         BitField m_needTrapHandling { 0 };
107         BitField m_trapsBitField;
108     };
109
110     friend class LLIntOffsetsExtractor;
111 };
112
113 } // namespace JSC