db6a0c46a164af42fad8d14666fca3f9eeba47bb
[WebKit-https.git] / Source / JavaScriptCore / runtime / CompilationResult.h
1 /*
2  * Copyright (C) 2013 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 CompilationResult_h
27 #define CompilationResult_h
28
29 #include <wtf/PrintStream.h>
30
31 namespace JSC {
32
33 enum CompilationResult {
34     // We tried to compile the code, but we couldn't compile it. This could be
35     // because we ran out of memory, or because the compiler encountered an
36     // internal error and decided to bail out gracefully. Either way, this implies
37     // that we shouldn't try to compile this code block again.
38     CompilationFailed,
39     
40     // The profiling assumptions that were fed into the compiler were invalidated
41     // even before we finished compiling. This means we should try again: in such
42     // cases the profiling will now be updated and the next compilation won't
43     // encounter the same problem. But it does mean that we should exercise
44     // exponential back-off, to get even more profiling so that new profiling
45     // pathologies aren't encountered.
46     CompilationInvalidated,
47     
48     // The compilation succeeded and the code block now has JITCode for the newly
49     // compiled code. However, compilation success doesn't mean that the CodeBlock
50     // will execute yet; you typically have to install it first, unless you plan
51     // on invoking it manually (something that *could* be done for some kinds of
52     // OSR entry).
53     CompilationSuccessful,
54     
55     // We decided to do the compilation asynchronously. This means that we haven't
56     // yet compiled the code. This only happens when you pass a
57     // DeferredCompilationCallback. That callback will get called with some
58     // interesting result, once compilation completes.
59     CompilationDeferred
60 };
61
62 } // namespace JSC
63
64 namespace WTF {
65
66 void printInternal(PrintStream&, JSC::CompilationResult);
67
68 } // namespace WTF
69
70 #endif // CompilationResult_h
71