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#ifndef AirKind_h
27#define AirKind_h
28
29#if ENABLE(B3_JIT)
30
31#include "AirOpcode.h"
32#include <wtf/PrintStream.h>
33
34namespace JSC { namespace B3 { namespace Air {
35
36// Air opcodes are always carried around with some flags. These flags are understood as having no
37// meaning if they are set for an opcode to which they do not apply. This makes sense, since Air
38// is a complex instruction set and most of these flags can apply to basically any opcode. In
39// fact, it's recommended to only represent something as a flag if you believe that it is largely
40// opcode-agnostic.
41
42struct Kind {
43 Kind(Opcode opcode)
44 : opcode(opcode)
45 , effects(false)
46 {
47 }
48
49 Kind()
50 : Kind(Nop)
51 {
52 }
53
54 bool operator==(const Kind& other) const
55 {
56 return opcode == other.opcode
57 && effects == other.effects;
58 }
59
60 bool operator!=(const Kind& other) const
61 {
62 return !(*this == other);
63 }
64
65 unsigned hash() const
66 {
67 return static_cast<unsigned>(opcode) + (static_cast<unsigned>(effects) << 16);
68 }
69
70 explicit operator bool() const
71 {
72 return *this != Kind();
73 }
74
75 void dump(PrintStream&) const;
76
77 Opcode opcode;
78
79 // This is an opcode-agnostic flag that indicates that we expect that this instruction will do
80 // any of the following:
81 // - Trap.
82 // - Perform some non-arg non-control effect.
83 bool effects : 1;
84};
85
86} } } // namespace JSC::B3::Air
87
88#endif // ENABLE(B3_JIT)
89
90#endif // AirKind_h
91
92