Create a super rough prototype of B3
[WebKit-https.git] / Source / JavaScriptCore / b3 / B3Origin.h
1 /*
2  * Copyright (C) 2015 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 #ifndef B3Origin_h
27 #define B3Origin_h
28
29 #if ENABLE(B3_JIT)
30
31 #include <wtf/PrintStream.h>
32
33 namespace JSC { namespace B3 {
34
35 // Whoever generates B3IR can choose to put origins on values. When you do this, B3 will be able to
36 // account, down to the machine code, which instruction corresponds to which origin. B3
37 // transformations must preserve Origins carefully. It's an error to write a transformation that
38 // either drops Origins or lies about them.
39 class Origin {
40 public:
41     explicit Origin(const void* data = nullptr)
42         : m_data(data)
43     {
44     }
45
46     explicit operator bool() const { return !!m_data; }
47
48     const void* data() const { return m_data; }
49
50     void dump(PrintStream&) const;
51     
52 private:
53     const void* m_data;
54 };
55
56 } } // namespace JSC::B3
57
58 #endif // ENABLE(B3_JIT)
59
60 #endif // B3Origin_h
61