Remove excessive headers from JavaScriptCore
[WebKit-https.git] / Source / JavaScriptCore / jit / Snippet.h
1 /*
2  * Copyright (C) 2016 Apple Inc. All rights reserved.
3  * Copyright (C) 2017 Yusuke Suzuki <utatane.tea@gmail.com>.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
18  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
19  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
20  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
21  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
22  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25  */
26
27 #pragma once
28
29 #if ENABLE(JIT)
30
31 #include "CCallHelpers.h"
32
33 namespace JSC {
34
35 class SnippetParams;
36
37 typedef CCallHelpers::JumpList SnippetCompilerFunction(CCallHelpers&, SnippetParams&);
38 typedef SharedTask<SnippetCompilerFunction> SnippetCompiler;
39
40 // Snippet is the way to inject an opaque code generator into DFG and FTL.
41 // While B3::Patchpoint is self-contained about its compilation information,
42 // Snippet depends on which DFG Node invokes. For example, CheckDOM will
43 // link returned failureCases to BadType OSRExit, but this information is offered
44 // from CheckDOM DFG Node, not from this snippet. This snippet mainly focuses
45 // on injecting a snippet generator that can tell register usage and can be used
46 // in both DFG and FTL.
47 class Snippet : public ThreadSafeRefCounted<Snippet> {
48 public:
49     static Ref<Snippet> create()
50     {
51         return adoptRef(*new Snippet());
52     }
53
54     template<typename Functor>
55     void setGenerator(const Functor& functor)
56     {
57         m_generator = createSharedTask<SnippetCompilerFunction>(functor);
58     }
59
60     RefPtr<SnippetCompiler> generator() const { return m_generator; }
61
62     uint8_t numGPScratchRegisters { 0 };
63     uint8_t numFPScratchRegisters { 0 };
64
65 protected:
66     Snippet() = default;
67
68 private:
69     RefPtr<SnippetCompiler> m_generator;
70 };
71
72 }
73
74 #endif