523369ba3a5999a9b89e4f48ffc81e6432c0b08c
[WebKit-https.git] / Source / JavaScriptCore / ftl / FTLPatchpointExceptionHandle.h
1 /*
2  * Copyright (C) 2016 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 "DFGCommon.h"
29
30 #if ENABLE(FTL_JIT)
31
32 #include "DFGNodeOrigin.h"
33 #include "ExitKind.h"
34 #include "HandlerInfo.h"
35 #include <wtf/Ref.h>
36 #include <wtf/ThreadSafeRefCounted.h>
37
38 namespace JSC {
39
40 namespace B3 {
41 class StackmapGenerationParams;
42 } // namespace B3
43
44 namespace FTL {
45
46 class ExceptionTarget;
47 class State;
48 struct OSRExitDescriptor;
49 struct OSRExitHandle;
50
51 class PatchpointExceptionHandle : public ThreadSafeRefCounted<PatchpointExceptionHandle> {
52 public:
53     static RefPtr<PatchpointExceptionHandle> create(
54         State&, OSRExitDescriptor*, DFG::NodeOrigin, unsigned offset, const HandlerInfo&);
55
56     static RefPtr<PatchpointExceptionHandle> defaultHandle(State&);
57     
58     ~PatchpointExceptionHandle();
59
60     // Note that you can use this handle to schedule any number of exits. This capability is here for
61     // two reasons:
62     // 
63     // - B3 code duplication. B3 could take a patchpoint and turn it into multiple patchpoints if it
64     //   duplicates code. Duplicating code is legal since you can do it without changing the behavior
65     //   of the program. One example is tail duplication. Another is jump threading. Yet another is
66     //   path specialization. You will have one PatchpointExceptionHandle per patchpoint you create
67     //   during DFG->B3 lowering, and that patchpoint will have a generator that calls
68     //   handle->scheduleBlah(). That generator will be called multiple times if your patchpoint got
69     //   duplicated.
70     //
71     // - Combination of unwind and non-unwind exception handlers inside one patchpoint. A GetById may
72     //   need both an exception handler that serves as an unwind target and an exception handler that
73     //   is branched to directly for operation calls emitted inside the patchpoint. In that case,
74     //   you'll call both scheduleExitCreation() and scheduleExitCreationForUnwind() on the same
75     //   handle.
76
77     // Schedules the creation of an OSR exit jump destination. You don't know when this will be
78     // created, but it will happen before linking. You can link jumps to it during link time. That's
79     // why this returns an ExceptionTarget. That will contain the jump destination (target->label())
80     // at link time. This function should be used for exceptions from C calls.
81     RefPtr<ExceptionTarget> scheduleExitCreation(const B3::StackmapGenerationParams&);
82
83     // Schedules the creation of an OSR exit jump destination, and ensures that it gets associated
84     // with the handler for some callsite index. This function should be used for exceptions from JS.
85     void scheduleExitCreationForUnwind(const B3::StackmapGenerationParams&, CallSiteIndex);
86
87 private:
88     PatchpointExceptionHandle(
89         State&, OSRExitDescriptor*, DFG::NodeOrigin, unsigned offset, const HandlerInfo&);
90
91     RefPtr<OSRExitHandle> createHandle(ExitKind, const B3::StackmapGenerationParams&);
92
93     State& m_state;
94     OSRExitDescriptor* m_descriptor;
95     DFG::NodeOrigin m_origin;
96     unsigned m_offset;
97     HandlerInfo m_handler;
98 };
99
100 } } // namespace JSC::FTL
101
102 #endif // ENABLE(FTL_JIT)