88baed7e1430e50eae605e3b579bf2660885b366
[WebKit-https.git] / Source / JavaScriptCore / b3 / air / AirValidate.cpp
1 /*
2  * Copyright (C) 2015-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 #include "config.h"
27 #include "AirValidate.h"
28
29 #if ENABLE(B3_JIT)
30
31 #include "AirCode.h"
32 #include "AirInstInlines.h"
33
34 namespace JSC { namespace B3 { namespace Air {
35
36 namespace {
37
38 class Validater {
39 public:
40     Validater(Code& code, const char* dumpBefore)
41         : m_code(code)
42         , m_dumpBefore(dumpBefore)
43     {
44     }
45
46 #define VALIDATE(condition, message) do {                               \
47         if (condition)                                                  \
48             break;                                                      \
49         fail(__FILE__, __LINE__, WTF_PRETTY_FUNCTION, #condition, toCString message); \
50     } while (false)
51     
52     void run()
53     {
54         HashSet<StackSlot*> validSlots;
55         HashSet<BasicBlock*> validBlocks;
56         HashSet<Special*> validSpecials;
57
58         for (BasicBlock* block : m_code)
59             validBlocks.add(block);
60         for (StackSlot* slot : m_code.stackSlots())
61             validSlots.add(slot);
62         for (Special* special : m_code.specials())
63             validSpecials.add(special);
64
65         for (BasicBlock* block : m_code) {
66             for (unsigned instIndex = 0; instIndex < block->size(); ++instIndex) {
67                 Inst& inst = block->at(instIndex);
68                 for (Arg& arg : inst.args) {
69                     switch (arg.kind()) {
70                     case Arg::Stack:
71                         VALIDATE(validSlots.contains(arg.stackSlot()), ("At ", inst, " in ", *block));
72                         break;
73                     case Arg::Special:
74                         VALIDATE(validSpecials.contains(arg.special()), ("At ", inst, " in ", *block));
75                         break;
76                     default:
77                         break;
78                     }
79                 }
80                 VALIDATE(inst.isValidForm(), ("At ", inst, " in ", *block));
81                 if (instIndex == block->size() - 1)
82                     VALIDATE(inst.isTerminal(), ("At ", inst, " in ", *block));
83                 else
84                     VALIDATE(!inst.isTerminal(), ("At ", inst, " in ", *block));
85
86                 // forEachArg must return Arg&'s that point into the args array.
87                 inst.forEachArg(
88                     [&] (Arg& arg, Arg::Role, Arg::Type, Arg::Width) {
89                         VALIDATE(&arg >= &inst.args[0], ("At ", arg, " in ", inst, " in ", *block));
90                         VALIDATE(&arg <= &inst.args.last(), ("At ", arg, " in ", inst, " in ", *block));
91                     });
92             }
93             for (BasicBlock* successor : block->successorBlocks())
94                 VALIDATE(validBlocks.contains(successor), ("In ", *block));
95         }
96     }
97
98 private:
99     NO_RETURN_DUE_TO_CRASH void fail(
100         const char* filename, int lineNumber, const char* function, const char* condition,
101         CString message)
102     {
103         CString failureMessage;
104         {
105             StringPrintStream out;
106             out.print("AIR VALIDATION FAILURE\n");
107             out.print("    ", condition, " (", filename, ":", lineNumber, ")\n");
108             out.print("    ", message, "\n");
109             out.print("    After ", m_code.lastPhaseName(), "\n");
110             failureMessage = out.toCString();
111         }
112
113         dataLog(failureMessage);
114         if (m_dumpBefore) {
115             dataLog("Before ", m_code.lastPhaseName(), ":\n");
116             dataLog(m_dumpBefore);
117         }
118         dataLog("At time of failure:\n");
119         dataLog(m_code);
120
121         dataLog(failureMessage);
122         WTFReportAssertionFailure(filename, lineNumber, function, condition);
123         CRASH();
124     }
125     
126     Code& m_code;
127     const char* m_dumpBefore;
128 };
129
130 } // anonymous namespace
131
132 void validate(Code& code, const char* dumpBefore)
133 {
134     Validater validater(code, dumpBefore);
135     validater.run();
136 }
137
138 } } } // namespace JSC::B3::Air
139
140 #endif // ENABLE(B3_JIT)
141